OpenMPI 0.1.1

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

Functions
OTF_Handler.h File Reference

Provides read access to OTF traces which consist of multiple streams. More...

`#include "OTF_KeyValue.h"`

Go to the source code of this file.

## Functions
int | OTF_Handler_DefinitionComment (void *userData, uint32_t stream, const char *comment, OTF_KeyValueList *list)
| Provides a comment record. More...
int | OTF_Handler_DefTimerResolution (void *userData, uint32_t stream, uint64_t ticksPerSecond, OTF_KeyValueList *list)
| Provides the timer resolution. More...
int | OTF_Handler_DefProcess (void *userData, uint32_t stream, uint32_t process, const char *name, uint32_t parent, OTF_KeyValueList *list)
| Provides a process definition. More...
int | OTF_Handler_DefProcessGroup (void *userData, uint32_t stream, uint32_t procGroup, const char *name, uint32_t numberOfProcs, const uint32_t *procs, OTF_KeyValueList *list)
| Provides a process group definition. More...
int | OTF_Handler_DefAttributeList (void *userData, uint32_t stream, uint32_t attr_token, uint32_t num, OTF_ATTR_TYPE *array, OTF_KeyValueList *list)
| Provides a list of attributes that is assigned to a unique token. More...
int | OTF_Handler_DefProcessOrGroupAttributes (void *userData, uint32_t stream, uint32_t proc_token, uint32_t attr_token, OTF_KeyValueList *list)
| Provides a process or group attributes definition. More...
int | OTF_Handler_DefFunction (void *userData, uint32_t stream, uint32_t func, const char *name, uint32_t funcGroup, uint32_t source, OTF_KeyValueList *list)
| Provides a function definition. More...
int | OTF_Handler_DefFunctionGroup (void *userData, uint32_t stream, uint32_t funcGroup, const char *name, OTF_KeyValueList *list)
| Provides a function group definition. More...
int | OTF_Handler_DefCollectiveOperation (void *userData, uint32_t stream, uint32_t collOp, const char *name, uint32_t type, OTF_KeyValueList *list)
| Provides a collective operation definition. More...
int | OTF_Handler_DefCounter (void *userData, uint32_t stream, uint32_t counter, const char *name, uint32_t properties, uint32_t counterGroup, const char *unit, OTF_KeyValueList *list)
| Provides a counter definition. More...
int | OTF_Handler_DefCounterGroup (void *userData, uint32_t stream, uint32_t counterGroup, const char *name, OTF_KeyValueList *list)
| Provides a counter group definition. More...
int | OTF_Handler_DefScl (void *userData, uint32_t stream, uint32_t source, uint32_t sourceFile, uint32_t line, OTF_KeyValueList *list)
| Provides a source code location (SCL). More...
int | OTF_Handler_DefSclFile (void *userData, uint32_t stream, uint32_t sourceFile, const char *name, OTF_KeyValueList *list)
| Provides a source code location (SCL) file. More...
int | OTF_Handler_DefCreator (void *userData, uint32_t stream, const char *creator, OTF_KeyValueList *list)
| Provides file creator information. More...
int | OTF_Handler_DefVersion (void *userData, uint32_t stream, uint8_t major, uint8_t minor, uint8_t sub, const char *string, OTF_KeyValueList *list)
| Provides information on the trace´s otf-version. More...
int | OTF_Handler_DefFile (void *userData, uint32_t stream, uint32_t token, const char *name, uint32_t group, OTF_KeyValueList *list)
| Provides a file definition NOTE: this is experimental. More...
int | OTF_Handler_DefFileGroup (void *userData, uint32_t stream, uint32_t token, const char *name, OTF_KeyValueList *list)
| Provides a file group definition NOTE: this is experimental. More...
int | OTF_Handler_DefKeyValue (void *userData, uint32_t stream, uint32_t key, OTF_Type type, const char *name, const char *description, OTF_KeyValueList *list)
| Provides a KeyValue definition. More...
int | OTF_Handler_DefTimeRange (void *userData, uint32_t stream, uint64_t minTime, uint64_t maxTime, OTF_KeyValueList *list)
| Provides a TimeRange definition. More...
int | OTF_Handler_DefCounterAssignments (void *userData, uint32_t stream, uint32_t counter, uint32_t number_of_members, const uint32_t *procs_or_groups, OTF_KeyValueList *list)
| Provides a CounterAssignments definition. More...
int | OTF_Handler_NoOp (void *userData, uint64_t time, uint32_t process, OTF_KeyValueList *list)
| Provides a no-operation event. More...
int | OTF_Handler_Enter (void *userData, uint64_t time, uint32_t function, uint32_t process, uint32_t source, OTF_KeyValueList *list)
| Provides a function entry event. More...
int | OTF_Handler_Leave (void *userData, uint64_t time, uint32_t function, uint32_t process, uint32_t source, OTF_KeyValueList *list)
| Provides a function leave event. More...
int | OTF_Handler_SendMsg (void *userData, uint64_t time, uint32_t sender, uint32_t receiver, uint32_t group, uint32_t type, uint32_t length, uint32_t source, OTF_KeyValueList *list)
| Provides a message send event. More...
int | OTF_Handler_RecvMsg (void *userData, uint64_t time, uint32_t recvProc, uint32_t sendProc, uint32_t group, uint32_t type, uint32_t length, uint32_t source, OTF_KeyValueList *list)
| Provides a message retrieval event. More...
int | OTF_Handler_Counter (void *userData, uint64_t time, uint32_t process, uint32_t counter, uint64_t value, OTF_KeyValueList *list)
| Provides a counter measurement. More...
int | OTF_Handler_CollectiveOperation (void *userData, uint64_t time, uint32_t process, uint32_t collective, uint32_t procGroup, uint32_t rootProc, uint32_t sent, uint32_t received, uint64_t duration, uint32_t source, OTF_KeyValueList *list)
| Provides a collective operation member event. More...
int | OTF_Handler_BeginCollectiveOperation (void *userData, uint64_t time, uint32_t process, uint32_t collOp, uint64_t matchingId, uint32_t procGroup, uint32_t rootProc, uint64_t sent, uint64_t received, uint32_t scltoken, OTF_KeyValueList *list)
| Provides a begin collective operation member event. More...
int | OTF_Handler_EndCollectiveOperation (void *userData, uint64_t time, uint32_t process, uint64_t matchingId, OTF_KeyValueList *list)
| Provides an end collective operation member event. More...
int | OTF_Handler_EventComment (void *userData, uint64_t time, uint32_t process, const char *comment, OTF_KeyValueList *list)
| Provide a comment record. More...
int | OTF_Handler_BeginProcess (void *userData, uint64_t time, uint32_t process, OTF_KeyValueList *list)
| Provides a process creation event. More...
int | OTF_Handler_EndProcess (void *userData, uint64_t time, uint32_t process, OTF_KeyValueList *list)
| Provides a process destruction event. More...
int | OTF_Handler_FileOperation (void *userData, uint64_t time, uint32_t fileid, uint32_t process, uint64_t handleid, uint32_t operation, uint64_t bytes, uint64_t duration, uint32_t source, OTF_KeyValueList *list)
| Provides a file operation event NOTE: this is experimental. More...
int | OTF_Handler_BeginFileOperation (void *userData, uint64_t time, uint32_t process, uint64_t matchingId, uint32_t scltoken, OTF_KeyValueList *list)
| Write a begin file operation record. More...
int | OTF_Handler_EndFileOperation (void *userData, uint64_t time, uint32_t process, uint32_t fileid, uint64_t matchingId, uint64_t handleId, uint32_t operation, uint64_t bytes, uint32_t scltoken, OTF_KeyValueList *list)
| Write an end file operation record. More...
int | OTF_Handler_RMAPut (void *userData, uint64_t time, uint32_t process, uint32_t origin, uint32_t target, uint32_t communicator, uint32_t tag, uint64_t bytes, uint32_t source, OTF_KeyValueList *list)
| Provides a RMA put event - end marker is anticipated on initiating Process. More...
int | OTF_Handler_RMAPutRemoteEnd (void *userData, uint64_t time, uint32_t process, uint32_t origin, uint32_t target, uint32_t communicator, uint32_t tag, uint64_t bytes, uint32_t source, OTF_KeyValueList *list)
| Provides a RMA put event with remote finalization marker, i.e. More...
int | OTF_Handler_RMAGet (void *userData, uint64_t time, uint32_t process, uint32_t origin, uint32_t target, uint32_t communicator, uint32_t tag, uint64_t bytes, uint32_t source, OTF_KeyValueList *list)
| Provides a RMA get event - end marker is anticipated on initiating Process. More...
int | OTF_Handler_RMAEnd (void *userData, uint64_t time, uint32_t process, uint32_t remote, uint32_t communicator, uint32_t tag, uint32_t source, OTF_KeyValueList *list)
| Provide a RMA end event. More...
int | OTF_Handler_SnapshotComment (void *userData, uint64_t time, uint32_t process, const char *comment, OTF_KeyValueList *list)
| Provides a snapshot comment. More...
int | OTF_Handler_EnterSnapshot (void *userData, uint64_t time, uint64_t originaltime, uint32_t function, uint32_t process, uint32_t source, OTF_KeyValueList *list)
| provides information about a past function call at the time 'originaltime'. More...
int | OTF_Handler_SendSnapshot (void *userData, uint64_t time, uint64_t originaltime, uint32_t sender, uint32_t receiver, uint32_t procGroup, uint32_t tag, uint32_t length, uint32_t source, OTF_KeyValueList *list)
| provides information about a past message send operation at the time 'originaltime'. More...
int | OTF_Handler_OpenFileSnapshot (void *userData, uint64_t time, uint64_t originaltime, uint32_t fileid, uint32_t process, uint64_t handleid, uint32_t source, OTF_KeyValueList *list)
| Provides a snapshot record for opened(and not yet closed) files. More...
int | OTF_Handler_BeginCollopSnapshot (void *userData, uint64_t time, uint64_t originaltime, uint32_t process, uint32_t collOp, uint64_t matchingId, uint32_t procGroup, uint32_t rootProc, uint64_t sent, uint64_t received, uint32_t scltoken, OTF_KeyValueList *list)
| Provides a snapshot record for unfinished collective operations. More...
int | OTF_Handler_BeginFileOpSnapshot (void *userData, uint64_t time, uint64_t originaltime, uint32_t process, uint64_t matchingId, uint32_t scltoken, OTF_KeyValueList *list)
int | OTF_Handler_SummaryComment (void *userData, uint64_t time, uint32_t process, const char *comment, OTF_KeyValueList *list)
| Provides a summary comment. More...
int | OTF_Handler_FunctionSummary (void *userData, uint64_t time, uint32_t function, uint32_t process, uint64_t invocations, uint64_t exclTime, uint64_t inclTime, OTF_KeyValueList *list)
| Provides summarized information for a given function. More...
int | OTF_Handler_FunctionGroupSummary (void *userData, uint64_t time, uint32_t funcGroup, uint32_t process, uint64_t invocations, uint64_t exclTime, uint64_t inclTime, OTF_KeyValueList *list)
| Provides summarized information for a given group of functiongroups. More...
int | OTF_Handler_MessageSummary (void *userData, uint64_t time, uint32_t process, uint32_t peer, uint32_t comm, uint32_t type, uint64_t sentNumber, uint64_t receivedNumber, uint64_t sentBytes, uint64_t receivedBytes, OTF_KeyValueList *list)
| Provides summarized information for a given message type. More...
int | OTF_Handler_CollopSummary (void *userData, uint64_t time, uint32_t process, uint32_t comm, uint32_t collective, uint64_t sentNumber, uint64_t receivedNumber, uint64_t sentBytes, uint64_t receivedBytes, OTF_KeyValueList *list)
| Provides summarized information for collective operations. More...
int | OTF_Handler_FileOperationSummary (void *userData, uint64_t time, uint32_t fileid, uint32_t process, uint64_t nopen, uint64_t nclose, uint64_t nread, uint64_t nwrite, uint64_t nseek, uint64_t bytesread, uint64_t byteswrite, OTF_KeyValueList *list)
| Provides summarized information about file operations. More...
int | OTF_Handler_FileGroupOperationSummary (void *userData, uint64_t time, uint32_t groupid, uint32_t process, uint64_t nopen, uint64_t nclose, uint64_t nread, uint64_t nwrite, uint64_t nseek, uint64_t bytesread, uint64_t byteswrite, OTF_KeyValueList *list)
| Provides summarized information about file operations in a file group. More...
int | OTF_Handler_UnknownRecord (void *userData, uint64_t time, uint32_t process, const char *record)
| Can be used to handle records which cannot be read. More...
int | OTF_Handler_DefMarker (void *userData, uint32_t stream, uint32_t token, const char *name, uint32_t type, OTF_KeyValueList *list)
| Define a marker. More...
int | OTF_Handler_Marker (void *userData, uint64_t time, uint32_t process, uint32_t token, const char *text, OTF_KeyValueList *list)
| Define a marker. More...

## Detailed Description

Provides read access to OTF traces which consist of multiple streams.