1.0.7 (revision 953)
Typedefs | Functions

pomp2_lib.h File Reference

This file contains the declarations of all POMP2 functions. More...

#include <stddef.h>
#include <stdint.h>

Go to the source code of this file.

Typedefs

typedef void * POMP2_Region_handle

Functions

void POMP2_Assign_handle (POMP2_Region_handle *pomp2_handle, const char ctc_string[])
void POMP2_Begin (POMP2_Region_handle *pomp2_handle)
void POMP2_End (POMP2_Region_handle *pomp2_handle)
void POMP2_Finalize ()
POMP2_Task_handle POMP2_Get_new_task_handle ()
void POMP2_Init ()
void POMP2_Off ()
void POMP2_On ()
Functions generated by the instrumenter
size_t POMP2_Get_num_regions ()
void POMP2_Init_regions ()
const char * POMP2_Get_opari2_version ()

Detailed Description

This file contains the declarations of all POMP2 functions.

alpha

Authors:
Daniel Lorenz <d.lorenz@fz-juelich.de> Dirk Schmidl <schmidl@rz.rwth-aachen.de> Peter Philippen <p.philippen@fz-juelich.de>

Typedef Documentation

typedef void* POMP2_Region_handle

Handles to identify OpenMP regions.


Function Documentation

void POMP2_Assign_handle ( POMP2_Region_handle pomp2_handle,
const char  ctc_string[] 
)

Registers a POMP2 region and returns a region handle.

Parameters:
pomp2_handleReturns the handle for the newly registered region.
ctc_stringA string containing the region data.
void POMP2_Begin ( POMP2_Region_handle pomp2_handle)

Called at the begin of a user defined POMP2 region.

Parameters:
pomp2_handleThe handle of the started region.
void POMP2_End ( POMP2_Region_handle pomp2_handle)

Called at the begin of a user defined POMP2 region.

Parameters:
pomp2_handleThe handle of the started region.
void POMP2_Finalize ( )

Finalizes the POMP2 adapter. It is inserted at the #pragma pomp inst end.

POMP2_Task_handle POMP2_Get_new_task_handle ( )

Function that returns a new task handle.

Returns:
new task handle
size_t POMP2_Get_num_regions ( )

Returns the number of instrumented regions.
The instrumenter scans all opari-created include files with nm and greps the POMP2_INIT_uuid_numRegions() function calls. Here we return the sum of all numRegions.

Returns:
number of instrumented regions
const char* POMP2_Get_opari2_version ( )

Returns the opari version.

Returns:
version string
void POMP2_Init ( )

Initializes the POMP2 adapter. It is inserted at the #pragma pomp inst begin.

void POMP2_Init_regions ( )

Init all opari-created regions.
The instrumentor scans all opari-created include files with nm and greps the POMP2_INIT_uuid_numRegions() function calls. The instrumentor then defines these functions by calling all grepped functions.

void POMP2_Off ( )

Disables the POMP2 adapter.

void POMP2_On ( )

Enables the POMP2 adapter.