csubich / stopwatch

Stopwatch

API wrapper for PAPI

Dependencies

• PAPI (Building and installing instructions can be found here) or be installed with a package manager with the name libpapi-dev

Build Instructions

Core Dependency - PAPI

Since the PAPI installation does to provide any CMake targets, Stopwatch attempts to find PAPI and create a target for it to use in CMake builds.

The search order is:

1. Searches for PAPI using pkg-config if pkg-config exists on the system. This means on Cray systems, executing module load papi will allow PAPI to be found.

2. Searches for PAPI using find_path. This means it will look into default locations for papi.h and libpapi.a. An extra hint using the shell variable PAPI_DIR is provided to assist with finding PAPI if PAPI is not installed in a default location i.e., when building PAPI from source. PAPI_DIR is identical to the PAPI_DIR that is specified in the build from source instructions.

   Diagram of a typical PAPI installation when building from source

   └── install_folder          # Installation directory of PAPI, AKA what <PAPI_DIR> should be set to
       ├── include             # Folder containing the public header
       │   └──  papi.h    
       ├── lib                 # Folder containing the built static/shared libs
       │   ├── libpapi.a
       │   ├── libpapi.so
       │   └── ....
       └── ...

   More info on how find_path searches can be found here

Building Stopwatch

Running

cd stopwatch
cmake -Bbuild
cmake --build build

Will build Stopwatch using the folder build as the build folder with the default build configurations which are:

• Build type is debug
• Default install prefix
• Build tests
• Do not build C or Fortran example programs The build folder can be changed to any directory except the source directory by changing build to the custom path i.e, cmake -B<path_to_custom_location>

The build configurations can be changed by passing in extra flags when first running cmake to generate the build system

• Changing build type: -DCMAKE_BUILD_TYPE=<type> i.e, Release
• Changing install prefix: -DCMAKE_INSTALL_PREFIX=<path>, where <path> is where Stopwatch should be installed. More info on a custom install location can be found here
• Do not build tests: -DBUILD_TESTING=OFF
• Build C examples: -DBUILD_C_EXAMPLES=ON
• Build Fortran examples: -DBUILD_FORTRAN_EXAMPLES=ON

Installing Stopwatch

Running

cmake --build build -- install

will install in the path specified by CMAKE_INSTALL_PREFIX, assuming that the build directory is build. If built in a custom directory, simply change to cmake --build <path_to_custom_location> -- install

Custom Install Location:

The default location can be changed by setting the CMAKE_INSTALL_PREFIX cached variable to the path that Stopwatch should be installed. Note that when installing in a custom location, CMake must be pointed to the installation directory by setting theStopwatch_DIR cache variable to <install_path>/lib/cmake/Stopwatch.

Example:

If Stopwatch is installed in ~/stopwatch_installand project_foo depends on Stopwatch then the CMake cache for project_foo must be generated as so assuming that the build directory is build

cmake -Bbuild -DStopwatch_DIR=~/stopwatch_install/lib/cmake/Stopwatch

Running

cd Stopwatch
cmake -Bbuild -DCMAKE_INSTALL_PREFIX=~/stopwatch_install
cmake --build build -- install

Will create a directory structure that is similar to this

└── home_folder                     # What the shell expands ~ to
    ├── stopwatch_install           # Location that was specified to CMAKE_INSTALL_PREFIX when building Stopwatch
    │   ├── include
    │   │   └── stopwatch
    │   │       ├── stopwatch.h
    │   │       └── fstopwatch.F03
    │   └── lib                     # Might also be called lib64
    │       ├── cmake
    │       │   └── Stopwatch       # Folder containing all the cmake configuration files for this project. WHAT WE ARE INTRESTED IN
    │       │       └── ...
    │       └── libstopwatch.a
    ├── project_foo                 # Folder containing the project that wants to use the Stopwatch library. It is assumed that it is also located in ~
    │   └── ....                    # Project file structure omitted for this example
    └── ...                         # Other folders that might be in this directory .. omitted for this example

In order for CMake to generate the build system correctly for project_foo the location of Stopwatch's cmake configuration files must be provided. Hence,

cd project_foo
cmake -Bbuild -DStopwatch_DIR=~/stopwatch_install/lib/cmake/Stopwatch

Using Stopwatch

In the CMakeLists.txt add:

• find_package(Stopwatch REQUIRED) to make the library available. As mentioned before if Stopwatch is installed in a custom location, when running CMake for the first time, the cached variableStopwatchDIRmust be set to <stopwatch_install_prefix>/lib/cmake/Stopwatch or <stopwatch_install_prefix>/lib64/cmake/Stopwatch.
• target_link_libraries(target Stopwatch::Stopwatch) to link with the library. For C targets, add:

  #include <stopwatch/stopwatch.h>

  for the interface definitions For Fortran targets, add:

  #include <stopwatch/fstopwatch.F03>

  for the mod_stopwatch that contains the Fortran bindings

At the moment, the Stopwatch interface should be used like so:

initialize_stopwatch

start_measurement_of_region

    do some work                # Some code that does some meaningful work i.e, code that is to be instrumented

end_measurement_of_region

clean_up_resources

• initialize_stopwatch corresponds to the C function

enum StopwatchStatus stopwatch_init();

Initialize the appropriate structures and start the monotonic event timers. The events to be measured is specified via the STOPWATCH_EVENTS environment variable. Each event should be delimited with a comma ,. The events that can be added can be initially queried via the utility papi_avail that PAPI provides. If the STOPWATCH_EVENTS variable is unset, the default events of PAPI_TOT_CYC and PAPI_TOT_INS are used. More infomation about configurations can be found here

• start_measurement_of_region corresponds to the C function

enum StopwatchStatus stopwatch_record_start_measurements(size_t routine_id, const char *function_name, size_t caller_routine_id);

The first argument is the unique ID for the routine that is to be measured. It is up to the user to ensure that this ID does not collide with another ID of another routine that is measured. Note that ID 0 is reserved for the main function. The second argument is the string representation of the routine name. The third argument is the ID of the caller of the current routine. Note that for routines that are called by the main function, the caller ID would be 0.

• end_measurement_of_region corresponds to the C function

enum StopwatchStatus stopwatch_record_end_measurements(size_t routine_id);

The argument is the ID of the routine to complete the measurement for.

• clean_up_resources corresponds to the C function

void stopwatch_destroy();

This will clean up all resources used. A bit of a misnomer as PAPI itself seems to have a slight memory leak.

Note that the pair start measurement region and end measurement region define a region of code to collect measurements from. Regions can be nested inside of regions. enum StopwatchStatus reflects the return code of function execution. A detailed explaination can be found here

C Fortran Mappings

For Fortran usage, append the letter F to the start of each routine name to get the appropriate routine.

C Function	Fortran Function / Subroutine
stopwatch_init	Fstopwatch_init
stopwatch_destroy	Fstopwatch_destroy
stopwatch_record_start_measurements	Fstopwatch_record_start_measurements
stopwatch_record_end_measurements	Fstopwatch_record_end_measurements
stopwatch_print_measurement_results	Fstopwatch_print_measurement_results
stopwatch_print_result_table	Fstopwatch_print_result_table
stopwatch_result_to_csv	Fstopwatch_result_to_csv

Note that for the C routines that take a char* their equivalent Fortran routines must pass in an array of characters where the last character is a c_null_char from the module iso_c_binding as C strings are null terminated

The C enum StopwatchStatus values are defined as parameters in the Fortran equivalent.

Error Codes

Some functions will return enum StopwatchStatus indicating the status of the function execution. List of possible status codes and their respective meanings

• STOPWATCH_OK : Function executed successfully.
• STOPWATCH_TOO_MANY_EVENTS : Function executed unsuccessfully. Too many events were selected to be added.
• STOPWATCH_INVALID_EVENT: Function executed unsuccessfully. Event given is not a valid event.
• STOPWATCH_INVALID_EVENT_COMB : Function executed unsuccessfully. The specific combination of events could not be added. Either event(s) are not supported by the hardware, or the hardware cannot simultaneously measure all the selected events.
• STOPWATCH_INVALID_FILE : Function executed unsuccessfully. Path given is not valid.
• STOPWATCH_ERR : Function executed unsuccessfully. Error unrelated to selected events.

Configurations

The environment variable STOPWATCH_EVENTS are used to configure which events are measured. Each event should be delimited via a comma.

Example

export STOPWATCH_EVENTS=PAPI_SP_OPS,PAPI_TOT_INS

If the events specified in STOPWATCH_EVENTS are not valid PAPI events or if the hardware cannot support measuring the event combination, then stopwatch_init WILL NOT return the enum StopwatchStatus STOPWATCH_OK meaning execution beyond stopwatch_init is undefined. Make sure to always check the return status of stopwatch_init.

If STOPWATCH_EVENTS is not set, the default events used are PAPI_TOT_CYC and PAPI_TOT_INS

Example

Example of measuring the performance of a loop of matrix multiplication where the number of cycles stalled waiting for resources, and the number of L1 cache misses are the selected events:

#include <stopwatch/stopwatch.h>
int main() {
  stopwatch_init(); // Initialize stopwatch

  int N = 500; // Size of matrix
  int itercount = 10; // Number of iterations

  float (*A)[N] = initialize_mat(N);
  float (*B)[N] = initialize_mat(N);
  float (*C)[N] = initialize_mat(N);

  // Matrix multiply loop
  // Called by main routine so the caller ID argument is 0
  stopwatch_record_start_measurements(1, "total-loop", 0); // Record start time of the entire loop
  for (int iter = 0; iter < itercount; iter++) {
    memset(C, 0, sizeof(float) * N * N); // clear C array
    // Called by routine with ID zero so the caller ID argument is 1
    stopwatch_record_start_measurements(2, "single-cycle", 1); // read start time of a single cycle
    mat_mul(N, A, B, C); // Perform the multiplication C = A * B
    stopwatch_record_end_measurements(2); // read end time of a single cycle
  }
  stopwatch_record_end_measurements(1); // Record end measurements of the entire loop
  stopwatch_print_result_table(); // Prints the results in a table format
  stopwatch_destroy(); // Clean up resources used
}

Note that the function initialize_mat creates a NxN matrix and the function mat_mul multiplies two matrices A B that are both NxN matricies into a third matrix C that is also NxN. Both function's definitions are ommitted for this example.

Before running the binary, the environment variable STOPWATCH_EVENTS must be set. In this case it should be set to PAPI_RES_STL,PAPI_L1_TCM.

export STOPWATCH_EVENTS=PAPI_RES_STL,PAPI_L1_TCM

The result should look similar to this:

|---------------------------------------------------------------------------------------------|
| ID | NAME             | TIMES CALLED | TOTAL REAL MICROSECONDS | PAPI_RES_STL | PAPI_L1_TCM |
|---------------------------------------------------------------------------------------------|
| 1  | total-loop       | 1            | 4455471                 | 5911716339   | 951256697   |
| 2  |     single-cycle | 10           | 4454818                 | 5910669863   | 951113873   |
|---------------------------------------------------------------------------------------------|

More examples can be found in the examples folder.