Added instrumentor::phase struct API implementation (#168)

 - This has implementation of instrumentor::phase struct and
    replaces use of existing implementation.
  - Clang-format source and suppress warning with clang for unused value

Author: tapaswenipathak

coreneuron/nrniv/main1.cpp

@@ -453,9 +453,10 @@ extern "C" int run_solve_core(int argc, char** argv) {
     }
 
     // initializationa and loading functions moved to separate
-    Instrumentor::phase_begin("load-model");
-    nrn_init_and_load_data(argc, argv, !configs.empty());
-    Instrumentor::phase_end("load-model");
+    {
+        Instrumentor::phase p("load-model");
+        nrn_init_and_load_data(argc, argv, !configs.empty());
+    }
 
     std::string checkpoint_path = nrnopt_get_str("--checkpoint");
     if (strlen(checkpoint_path.c_str())) {
@@ -543,19 +544,20 @@ extern "C" int run_solve_core(int argc, char** argv) {
         // Report global cell statistics
         report_cell_stats();
 
-
         // prcellstate after end of solver
         call_prcellstate_for_prcellgid(nrnopt_get_int("--prcellgid"), compute_gpu, 0);
     }
 
     // write spike information to outpath
-    Instrumentor::phase_begin("output-spike");
-    output_spikes(output_dir.c_str());
-    Instrumentor::phase_end("output-spike");
+    {
+        Instrumentor::phase p("output-spike");
+        output_spikes(output_dir.c_str());
+    }
 
-    Instrumentor::phase_begin("checkpoint");
-    write_checkpoint(nrn_threads, nrn_nthread, checkpoint_path.c_str(), nrn_need_byteswap);
-    Instrumentor::phase_end("checkpoint");
+    {
+        Instrumentor::phase p("checkpoint");
+        write_checkpoint(nrn_threads, nrn_nthread, checkpoint_path.c_str(), nrn_need_byteswap);
+    }
 
     // must be done after checkpoint (to avoid deleting events)
     if (reports_needs_finalize) {

coreneuron/nrniv/profiler_interface.h

@@ -27,15 +27,17 @@ namespace coreneuron {
 
 namespace detail {
 
-    /*! \class Instrumentor
-     *  \brief Instrumentation infrastructure for benchmarking and profiling.
-     *
-     *  The Instrumentor class exposes static methods that can be used to
-     *  toggle with fine-grained resolution the profiling of specific
-     *  areas within the code.
-     */
+/*! \class Instrumentor
+ *  \brief Instrumentation infrastructure for benchmarking and profiling.
+ *
+ *  The Instrumentor class exposes static methods that can be used to
+ *  toggle with fine-grained resolution the profiling of specific
+ *  areas within the code.
+ */
 template <class... TProfilerImpl>
 struct Instrumentor {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wunused-value"
     /*! \fn phase_begin
      *  \brief Activate the collection of profiling data within a code region.
      *
@@ -128,6 +130,7 @@ struct Instrumentor {
     inline static void finalize_profile() {
         std::initializer_list<int>{(TProfilerImpl::finalize_profile(), 0)...};
     }
+#pragma clang diagnostic pop
 };
 
 #if defined(CORENEURON_CALIPER)
@@ -220,29 +223,26 @@ struct Tau {
 #if defined(LIKWID_PERFMON)
 
 struct Likwid {
-    inline static void phase_begin(const char* name){
+    inline static void phase_begin(const char* name) {
         LIKWID_MARKER_START(name);
     };
 
-    inline static void phase_end(const char* name){
+    inline static void phase_end(const char* name) {
         LIKWID_MARKER_STOP(name);
     };
 
-    inline static void start_profile() {};
+    inline static void start_profile(){};
 
-    inline static void stop_profile() {};
+    inline static void stop_profile(){};
 
-    inline static void init_profile(){
+    inline static void init_profile() {
         LIKWID_MARKER_INIT;
 
 #pragma omp parallel
-        {
-            LIKWID_MARKER_THREADINIT;
-        }
-
+        { LIKWID_MARKER_THREADINIT; }
     };
 
-    inline static void finalize_profile(){
+    inline static void finalize_profile() {
         LIKWID_MARKER_CLOSE;
     };
 };
@@ -258,9 +258,7 @@ struct NullInstrumentor {
     inline static void finalize_profile(){};
 };
 
-}  // namespace detail
-
-using Instrumentor = detail::Instrumentor<
+using InstrumentorImpl = detail::Instrumentor<
 #if defined CORENEURON_CALIPER
     detail::Caliper,
 #endif
@@ -277,5 +275,41 @@ using Instrumentor = detail::Instrumentor<
     detail::Likwid,
 #endif
     detail::NullInstrumentor>;
+}  // namespace detail
+
+namespace Instrumentor {
+struct phase {
+    phase(const char* name) {
+        detail::InstrumentorImpl::phase_begin(name);
+    }
+    ~phase() {
+        detail::InstrumentorImpl::phase_end("");
+    }
+};
+
+inline static void start_profile() {
+    detail::InstrumentorImpl::start_profile();
+}
+
+inline static void stop_profile() {
+    detail::InstrumentorImpl::stop_profile();
+}
+
+inline static void phase_begin(const char* name) {
+    detail::InstrumentorImpl::phase_begin(name);
+}
+
+inline static void phase_end(const char* name) {
+    detail::InstrumentorImpl::phase_end(name);
+}
+
+inline static void init_profile() {
+    detail::InstrumentorImpl::init_profile();
+}
+
+inline static void finalize_profile() {
+    detail::InstrumentorImpl::finalize_profile();
+}
+}
 
 }  // namespace coreneuron

coreneuron/nrnmpi/mpispike.cpp

@@ -116,9 +116,11 @@ void wait_before_spike_exchange() {
 int nrnmpi_spike_exchange() {
     int i, n;
     Instrumentor::phase_begin("spike-exchange");
-    Instrumentor::phase_begin("imbalance");
-    wait_before_spike_exchange();
-    Instrumentor::phase_end("imbalance");
+
+    {
+        Instrumentor::phase p("imbalance");
+        wait_before_spike_exchange();
+    }
 
     Instrumentor::phase_begin("communication");
 #if nrn_spikebuf_size > 0

coreneuron/nrnoc/fadvance_core.cpp

@@ -192,13 +192,11 @@ void update(NrnThread* _nt) {
     }
 }
 
-
 void nonvint(NrnThread* _nt) {
     NrnThreadMembList* tml;
     if (nrn_have_gaps) {
-        Instrumentor::phase_begin("gap-v-transfer");
+        Instrumentor::phase p("gap-v-transfer");
         nrnthread_v_transfer(_nt);
-        Instrumentor::phase_end("gap-v-transfer");
     }
     errno = 0;
 
@@ -208,9 +206,10 @@ void nonvint(NrnThread* _nt) {
             mod_f_t s = memb_func[tml->index].state;
             std::string ss("state-");
             ss += nrn_get_mechname(tml->index);
-            Instrumentor::phase_begin(ss.c_str());
-            (*s)(_nt, tml->ml, tml->index);
-            Instrumentor::phase_end(ss.c_str());
+            {
+                Instrumentor::phase p(ss.c_str());
+                (*s)(_nt, tml->ml, tml->index);
+            }
 #ifdef DEBUG
             if (errno) {
                 hoc_warning("errno set during calculation of states", (char*)0);
@@ -277,9 +276,10 @@ static void* nrn_fixed_step_thread(NrnThread* nth) {
        events up to t+dt/2 */
     Instrumentor::phase_begin("timestep");
 
-    Instrumentor::phase_begin("deliver_events");
-    deliver_net_events(nth);
-    Instrumentor::phase_end("deliver_events");
+    {
+        Instrumentor::phase p("deliver_events");
+        deliver_net_events(nth);
+    }
 
     nth->_t += .5 * nth->_dt;
 
@@ -294,21 +294,25 @@ static void* nrn_fixed_step_thread(NrnThread* nth) {
 #endif
         fixed_play_continuous(nth);
 
-        Instrumentor::phase_begin("setup_tree_matrix");
-        setup_tree_matrix_minimal(nth);
-        Instrumentor::phase_end("setup_tree_matrix");
+        {
+            Instrumentor::phase p("setup_tree_matrix");
+            setup_tree_matrix_minimal(nth);
+        }
 
-        Instrumentor::phase_begin("matrix-solver");
-        nrn_solve_minimal(nth);
-        Instrumentor::phase_end("matrix-solver");
+        {
+            Instrumentor::phase p("matrix-solver");
+            nrn_solve_minimal(nth);
+        }
 
-        Instrumentor::phase_begin("second_order_cur");
-        second_order_cur(nth, secondorder);
-        Instrumentor::phase_end("second_order_cur");
+        {
+            Instrumentor::phase p("second_order_cur");
+            second_order_cur(nth, secondorder);
+        }
 
-        Instrumentor::phase_begin("update");
-        update(nth);
-        Instrumentor::phase_end("update");
+        {
+            Instrumentor::phase p("update");
+            update(nth);
+        }
     }
     if (!nrn_have_gaps) {
         nrn_fixed_step_lastpart(nth);
@@ -339,9 +343,11 @@ void* nrn_fixed_step_lastpart(NrnThread* nth) {
         nrncore2nrn_send_values(nth);
     }
 
-    Instrumentor::phase_begin("deliver_events");
-    nrn_deliver_events(nth); /* up to but not past texit */
-    Instrumentor::phase_end("deliver_events");
+    {
+        Instrumentor::phase p("deliver_events");
+        nrn_deliver_events(nth); /* up to but not past texit */
+    }
+
     return (void*)0;
 }
 }  // namespace coreneuron

coreneuron/nrnoc/treeset_core.cpp

@@ -74,9 +74,8 @@ static void nrn_rhs(NrnThread* _nt) {
             mod_f_t s = memb_func[tml->index].current;
             std::string ss("cur-");
             ss += nrn_get_mechname(tml->index);
-            Instrumentor::phase_begin(ss.c_str());
+            Instrumentor::phase p(ss.c_str());
             (*s)(_nt, tml->ml, tml->index);
-            Instrumentor::phase_end(ss.c_str());
 #ifdef DEBUG
             if (errno) {
                 hoc_warning("errno set during calculation of currents", (char*)0);
@@ -130,9 +129,8 @@ static void nrn_lhs(NrnThread* _nt) {
             mod_f_t s = memb_func[tml->index].jacob;
             std::string ss("cur-");
             ss += nrn_get_mechname(tml->index);
-            Instrumentor::phase_begin(ss.c_str());
+            Instrumentor::phase p(ss.c_str());
             (*s)(_nt, tml->ml, tml->index);
-            Instrumentor::phase_end(ss.c_str());
 #ifdef DEBUG
             if (errno) {
                 hoc_warning("errno set during calculation of jacobian", (char*)0);

coreneuron/utils/ispc/globals.cpp

@@ -6,5 +6,5 @@
  */
 
 extern "C" {
-    double ispc_celsius;
+double ispc_celsius;
 }