Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 1.73 KB

README.md

File metadata and controls

52 lines (38 loc) · 1.73 KB
Raw

timemory-mpip library

Produces a libtimemory-mpip.so that uses GOTCHA wrappers around ~245 MPI functions.

Four functions are provided for C, C++, and Fortran:

  • uint64_t timemory_start_mpip()
    • Returns the number of initializations
  • uint64_t timemory_stop_mpip(uint64_t idx)
    • Removes the initialization request at idx
    • Returns the number of remaining initializations
  • void timemory_register_mpip()
    • Ensures a global initialization exists until it deregistration
  • void timemory_deregister_mpip()
    • Deactivates the global initialization

Usage

The environement variable ENABLE_TIMEMORY_MPIP (default: "ON") controls configuration of the instrumentation. This library configures the tim::user_mpip_bundle component with the components specified by the following environment variables in terms of priority:

  • TIMEMORY_MPIP_COMPONENTS
  • TIMEMORY_TRACE_COMPONENTS
  • TIMEMORY_PROFILER_COMPONENTS
  • TIMEMORY_GLOBAL_COMPONENTS

When one of the above environment variables are set to "none", then the priority search for component configurations is abandoned.

Examples

The following will result in MPI function instrumented with cpu_clock:

export TIMEMORY_MPIP_COMPONENTS="cpu_clock"
export TIMEMORY_PROFILER_COMPONENTS="peak_rss"
export TIMEMORY_GLOBAL_COMPONENTS="wall_clock"

The following will result in MPI functions containing no instrumentation:

export TIMEMORY_MPIP_COMPONENTS="none"
export TIMEMORY_PROFILER_COMPONENTS="peak_rss"
export TIMEMORY_GLOBAL_COMPONENTS="wall_clock"

The following will result in MPI function instrumented with wall_clock and page_rss:

export TIMEMORY_MPIP_COMPONENTS=""
export TIMEMORY_GLOBAL_COMPONENTS="wall_clock,page_rss"