|
CoreNEURON
|
Instrumentation infrastructure for benchmarking and profiling. More...
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.
Definition at line 46 of file profiler_interface.h.
#include <profiler_interface.h>
Static Public Member Functions | |
| static void | phase_begin (const char *name) |
| Activate the collection of profiling data within a code region. More... | |
| static void | phase_end (const char *name) |
| Deactivate the collection of profiling data within a code region. More... | |
| static void | start_profile () |
| Globally activate the collection of profiling data. More... | |
| static void | stop_profile () |
| Globally deactivate the collection of profiling data. More... | |
| static void | init_profile () |
| Initialize the profiler. More... | |
| static void | finalize_profile () |
| Finalize the profiler. More... | |
|
inlinestatic |
Finalize the profiler.
Finalize a profiler's internal structure, without activating yet any data collection, similar in concept to MPI_Finalize. Loops through all enabled profilers and calls the relevant finalize_profile function. This function should have a non-empty implementation only for profilers that require special finalization.
Definition at line 138 of file profiler_interface.h.
|
inlinestatic |
Initialize the profiler.
Initialize a profiler's internal structure, without activating yet any data collection, similar in concept to MPI_Init. Loops through all enabled profilers and calls the relevant init_profile function. This function should have a non-empty implementation only for profilers that require special initialization, typically before any memory allocation is done.
Definition at line 124 of file profiler_interface.h.
|
inlinestatic |
Activate the collection of profiling data within a code region.
This function semantically defines the beginning of a region of code that the user wishes to profile. Loops through all enabled profilers and calls the relevant phase_begin function. This function should have a non-empty implementation only for profilers that allow multiple code regions with different names to be profiled concurrently.
| name | the (unique) identifier of the code region to be profiled |
Definition at line 62 of file profiler_interface.h.
|
inlinestatic |
Deactivate the collection of profiling data within a code region.
This function semantically defines the end of a region of code that the user wishes to profile. Loops through all enabled profilers and calls the relevant phase_end function. This function should have a non-empty implementation only for profilers that allow multiple code regions with different names to be profiled concurrently.
| name | the (unique) identifier of the code region to be profiled |
Definition at line 79 of file profiler_interface.h.
|
inlinestatic |
Globally activate the collection of profiling data.
Activate the collection of profiler data without defining a region of interest with a given name, as opposed to phase_begin. Loops through all enabled profilers and calls the relevant start_profile function. This function should have a non-empty implementation only for profilers that expose simply a global begin/end interface, without named regions.
Definition at line 94 of file profiler_interface.h.
|
inlinestatic |
Globally deactivate the collection of profiling data.
Deactivate the collection of profiler data without defining a region of interest with a given name, as opposed to phase_end. Loops through all enabled profilers and calls the relevant stop_profile function. This function should have a non-empty implementation only for profilers that expose simply a global begin/end interface, without named regions.
Definition at line 109 of file profiler_interface.h.