This project is now archived and read-only

timemory

Timing + Memory + Hardware Counter Utilities for C / C++ / CUDA / Python

timemory on GitHub (Source code)

timemory General Documentation (ReadTheDocs)

timemory Source Code Documentation (Doxygen)

timemory Testing Dashboard (CDash)

timemory Tutorials

• ECP 2021 Tutorial Day 1 (YouTube)

• ECP 2021 Tutorial Day 2 (YouTube)

timemory Wiki

GitHub	git clone https://github.com/NERSC/timemory.git
PyPi	pip install timemory
Spack	spack install timemory
conda-forge	conda install -c conda-forge timemory

Purpose

The goal of timemory is to create an open-source performance measurement and analyis package with modular and reusable components which can be used to adapt to any existing C/C++ performance measurement and analysis API and is arbitrarily extendable by users within their application. Timemory is not just another profiling tool, it is a profling toolkit which streamlines building custom profiling tools through modularity and then utilizes the toolkit to provides several pre-built tools.

In other words, timemory provides many pre-built tools, libraries, and interfaces but, due to it's modularity, codes can re-use only individual pieces -- such as the classes for measuring different timing intervals, memory usage, and hardware counters -- without the timemory "runtime management".

Building and Installing

Timemory uses a standard CMake installation. Several installation examples can be found in the Wiki. See the installation documentation for detailed information on the CMake options.

Documentation

The full documentation is available at timemory.readthedocs.io. Detailed source documentation is provided in the doygen section of the full documentation. Tutorials are available in the github.com/NERSC/timemory-tutorials.

Overview

The primary objective of the timemory is the development of a common framework for binding together software monitoring code (i.e. performance analysis, debugging, logging) into a compact and highly-efficient interface.

Timemory arose out of the need for a universal adapator kit for the various APIs provided several existing tools and a straight-forward and intuitive method for creating new tools. Timemory makes it possible to bundle together deterministic performance measurements, statistical performance measurements (i.e. sampling), debug messages, data logging, and data validation into the same interface for custom application-specific software monitoring interfaces, easily building tools like time, netstat, instrumentation profilers, sampling profilers, and writing implementations for MPI-P, MPI-T, OMPT, KokkosP, etc. Furthermore, timemory can forward its markers to several third-party profilers such as LIKWID, Caliper, TAU, gperftools, Perfetto, VTune, Allinea-MAP, CrayPAT, Nsight-Systems, Nsight-Compute, and NVProf.

Timemory provides a front-end C/C++/Fortran API and Python API which allows arbitrary selection of 50+ different components from timers to hardware counters to interfaces with third-party tools. This is all built generically from the toolkit API with type-safe bundles of tools such as: component_tuple<wall_clock, papi_vector, nvtx_marker, user_bundle> where wall_clock is a wall-clock timer, papi_vector is a handle for hardware counters, nvxt_marker creates notations in the NVIDIA CUDA profilers, and user_bundle is a generic component which downstream users can insert more components into at runtime.

Performance measurement components written with timemory are arbitrarily scalable up to any number of threads and processes and fully support intermixing different measurements at different locations within the program -- this uniquely enables timemory to be deployed to collect performance data at scale in HPC because highly detailed collection can occur at specific locations within the program where ubiquitous collection would simulatenously degrade performance significantly and require a prohibitive amount of memory.

Timemory can be used as a backend to bundle instrumentation and sampling tools together, support serialization to JSON/XML, and provide statistics among other uses. It can also be utilized as a front-end to invoke custom instrumentation and sampling tools. Timemory uses the abstract term "component" for a structure which encapsulates some performance analysis operation. The structure might encapsulate function calls to another tool, record timestamps for timing, log values provided by the application, provide a operator for replacing a function in the code dynamically, audit the incoming arguments and/or outgoing return value from function, or just provide stubs which can be overloaded by the linker.

Visualization and Analysis

The native output format of timemory is JSON and text; other output formats such as XML are also supported. The text format is intended to be human readable. The JSON data is intended for analysis and comes in two flavors: hierarchical and flat. Basic plotting capabilities are available via timemory-plotting but users are highly encouraged to use hatchet for analyzing the heirarchical JSON data in pandas dataframes. Hatchet supports filtering, unions, addition, subtractions, output to dot and flamegraph formats, and an interactive Jupyter notebook. At present, timemory supports 45+ metric types for analysis in Hatchet.

Categories

There are 4 primary categories in timemory: components, operations, bundlers, and storage. Components provide the specifics of how to perform a particular behavior, operations provide the scaffold for requesting that a component perform an operation in complex scenarios, bundlers group components into a single generic handle, and storage manages data collection over the lifetime of the application. When all four categories are combined, timemory effectively resembles a standard performance analysis tool which passively collects data and provides reports and analysis at the termination of the application. Timemory, however, makes it very easy to subtract storage from the equation and, in doing so, transforms timemory into a toolkit for customized data collection.

1. Components
   • Individual classes which encapsulate one or more measurement, analysis, logging, or third-party library action(s)
   • Any data specific to one instance of performing the action is stored within the instance of the class
   • Any configuration data specific to that type is typically stored within static member functions which return a reference to the configuration data
   • These classes are designed to support direct usage within other tools, libraries, etc.
   • Examples include:
     • tim::component::wall_clock : a simple wall-clock timer
     • tim::component::vtune_profiler : a simple component which turns the VTune Profiler on and off (when VTune is actively profiling application)
     • tim::component::data_tracker_integer : associates an integer values with a label as the application executes (e.g. number of loop iterations used somewhere)
     • tim::component::papi_vector : uses the PAPI library to collect hardware-counters values
     • tim::component::user_bundle : encapsulates an array of components which the user can dynamically manipulate during runtime
2. Operations
   • Templated classes whose primary purpose is to provide the implementation for performing some action on a component, e.g. tim::operation::start<wall_clock> will attempt to call the start() member function on a wall_clock component instance
   • Default implementations generally have one or two public functions: a constructor and/or a function call operator
     • These generally accept any/all arguments and use SFINAE to determine whether the operation can be performed with or without the given arguments (i.e. does wall_clock have a store(int) function? store()?)
   • Operations are (generally) not directly utilized by the user and are typically optimized out of the binary
   • Examples include:
     • tim::operation::start : instruct a component to start collection
     • tim::operation::sample : instruct a component to take individual measurement
     • tim::operation::derive : extra data from other components if it is available
3. Bundlers
   • Provide a generic handle for multiple components
   • Member functions generally accept any/all arguments and use operations classes to correctly to handle differences between different capabilities of the components it is bundling

NOTE: tim::lightweight_tuple is the recommended bundle for those seeking to use timemory as a toolkit for implementing custom tools and interfaces

Features

• C++ Template API
  • Modular and fully-customizable
  • Adheres to C++ standard template library paradigm of "you don't pay for what you don't use"