ssapi(3)

NAME
     ssrt_caliper_point, ssrt_interface_routine, ssrt_buffer_clear - SpeedShop
     runtime library

SYNOPSIS
     #include <SpeedShop/api.h>
     int ssrt_caliper_point(int flags, char *label);
     long ssrt_interface_routine(int op, void *context);
     void ssrt_buffer_clear(void);
     void ssrt_experiment_stop(void);

DESCRIPTION
     The SpeedShop Performance Tools work by invoking functions in the
     SpeedShop runtime library.  This library may be explicitly linked with a
     user program, in which case the following named routines above may be
     invoked explicitly.  To explicitly link with the SpeedShop runtime, add
     the option -lss to the link line used to build the program.  Doing so
     will load the two SpeedShop libraries, libss.so and libssrt.so into the
     executable.

     ssrt_caliper_point is used to record a caliper point in the experiment.
     It may be called from anywhere in the code.  The first parameter
     specifies the caliper point flags, but is not supported yet, so it's
     ignored.  The second argument specifies a string label for the caliper
     point.

     An implicit caliper point is always recorded at the start of execution of
     the process. A final caliper point is recorded when the process exits
     normally. The implicit caliper point at the beginning of the program is
     numbered 0, the first caliper point after that is numbered 1, and any
     additional caliper points are numbered sequentially.  In addition,
     caliper points are automatically recorded under the following
     circumstances to ensure that at least one valid set of data is recorded.

     - When a fatal or exit signal is received.

     - When the program calls an exec function.

     - When a program closes a DSO by calling dlclose().

     ssrt_interface_routine is used to invoke the capture-module interface
     routine.  The definitions for op and the structure of context for each
     value of op will be documented in future releases.

     ssrt_buffer_clear is used to clear all currently accumulated data,
     resetting all values to zero.  It is used to exclude data from an
     initialization phase of the program.  With caliper support available in
     prof(1), this routine will normally not be used.

     ssrt_experiment_stop is used to disable performance data collection for
     the calling process.  No experiment file will get generated for the
     process either.
SEE ALSO
     speedshop(1), ssrun(1), prof(1), ssdump(1), ssapi(3F)

DIAGNOSTICS
     As ouput from the library routines.