OpenMPI 0.1.1

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

Files | Typedefs | Functions
Writer Interface

This interface should be used whenever a trace file is to be written as a whole. More...

## Files
file | OTF_Writer.h
| Transparently writes OTF traces which consist of multiple streams.

## Typedefs
typedef struct struct_OTF_Writer | OTF_Writer
| writer object

## Functions
OTF_Writer * | OTF_Writer_open (const char *fileNamePrefix, uint32_t numberOfStreams, OTF_FileManager *fileManager)
| Create a new OTF_Writer instance with a given number of automatic streams. More...
int | OTF_Writer_close (OTF_Writer *writer)
| Close an OTF_Writer instance and all its related files. More...
int | OTF_Writer_closeAllStreams (OTF_Writer *writer)
| Close all streams that are open in this writer instance. More...
int | OTF_Writer_setCompression (OTF_Writer *writer, OTF_FileCompression compression)
| Set the standard compression method for all buffers managed by this writer. More...
OTF_FileCompression | OTF_Writer_getCompression (OTF_Writer *writer)
| Return the standard compression method for all buffers managed by this writer. More...
void | OTF_Writer_setBufferSizes (OTF_Writer *writer, uint32_t size)
| Set the default buffer size for all buffers managed by this Writer. More...
uint32_t | OTF_Writer_getBufferSizes (OTF_Writer *writer)
| Get the default buffer size for all buffers managed by this Writer. More...
void | OTF_Writer_setZBufferSizes (OTF_Writer *writer, uint32_t size)
| Set the default zbuffer size for all buffers managed by this Reader. More...
uint32_t | OTF_Writer_getZBufferSizes (OTF_Writer *writer)
| Get the default zbuffer size. More...
void | OTF_Writer_setFormat (OTF_Writer *writer, uint32_t format)
| Set the default ouput format. More...
uint32_t | OTF_Writer_getFormat (OTF_Writer *writer)
| Get the default output format of all streams managed by this writer. More...
uint32_t | OTF_Writer_assignProcess (OTF_Writer *writer, uint32_t process, uint32_t stream)
| Explicitly assign a given process to a specific stream. More...
OTF_MasterControl * | OTF_Writer_getMasterControl (OTF_Writer *writer)
| Get a pointer to the master control object of the given writer instance. More...
void | OTF_Writer_setMasterControl (OTF_Writer *writer, OTF_MasterControl *mc)
| Set an alternative master control object. More...
uint32_t | OTF_Writer_mapProcess (OTF_Writer *writer, uint32_t processId)
| For a process with id 'processId' return a stream id of the stream the data is to be written to. More...
OTF_WStream * | OTF_Writer_getStream (OTF_Writer *writer, uint32_t stream)
| Return the stream with the given stream id. More...
int | OTF_Writer_writeDefinitionComment (OTF_Writer *writer, uint32_t stream, const char *comment)
| Write a comment record. More...
int | OTF_Writer_writeDefinitionCommentKV (OTF_Writer *writer, uint32_t stream, const char *comment, OTF_KeyValueList *list)
| Write a comment record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefTimerResolution (OTF_Writer *writer, uint32_t stream, uint64_t ticksPerSecond)
| Write the timer resolution definition record. More...
int | OTF_Writer_writeDefTimerResolutionKV (OTF_Writer *writer, uint32_t stream, uint64_t ticksPerSecond, OTF_KeyValueList *list)
| Write the timer resolution definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefProcess (OTF_Writer *writer, uint32_t stream, uint32_t process, const char *name, uint32_t parent)
| Write a process definition record. More...
int | OTF_Writer_writeDefProcessKV (OTF_Writer *writer, uint32_t stream, uint32_t process, const char *name, uint32_t parent, OTF_KeyValueList *list)
| Write a process definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefProcessGroup (OTF_Writer *writer, uint32_t stream, uint32_t procGroup, const char *name, uint32_t numberOfProcs, const uint32_t *procs)
| Write a process group definition record. More...
int | OTF_Writer_writeDefProcessGroupKV (OTF_Writer *writer, uint32_t stream, uint32_t procGroup, const char *name, uint32_t numberOfProcs, const uint32_t *procs, OTF_KeyValueList *list)
| Write a process group definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefAttributeList (OTF_Writer *writer, uint32_t stream, uint32_t attr_token, uint32_t num, OTF_ATTR_TYPE *array)
| Write an attribute list definition record. More...
int | OTF_Writer_writeDefAttributeListKV (OTF_Writer *writer, uint32_t stream, uint32_t attr_token, uint32_t num, OTF_ATTR_TYPE *array, OTF_KeyValueList *list)
| Write an attribute list definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefProcessOrGroupAttributes (OTF_Writer *writer, uint32_t stream, uint32_t proc_token, uint32_t attr_token)
| Write a process or group attributes definition record. More...
int | OTF_Writer_writeDefProcessOrGroupAttributesKV (OTF_Writer *writer, uint32_t stream, uint32_t proc_token, uint32_t attr_token, OTF_KeyValueList *list)
| Write a process or group attributes definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefFunction (OTF_Writer *writer, uint32_t stream, uint32_t func, const char *name, uint32_t funcGroup, uint32_t source)
| Write a function definition record. More...
int | OTF_Writer_writeDefFunctionKV (OTF_Writer *writer, uint32_t stream, uint32_t func, const char *name, uint32_t funcGroup, uint32_t source, OTF_KeyValueList *list)
| Write a function definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefFunctionGroup (OTF_Writer *writer, uint32_t stream, uint32_t funcGroup, const char *name)
| Write a function group definition record. More...
int | OTF_Writer_writeDefFunctionGroupKV (OTF_Writer *writer, uint32_t stream, uint32_t funcGroup, const char *name, OTF_KeyValueList *list)
| Write a function group definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefCollectiveOperation (OTF_Writer *writer, uint32_t stream, uint32_t collOp, const char *name, uint32_t type)
| Write a collective operation definition record. More...
int | OTF_Writer_writeDefCollectiveOperationKV (OTF_Writer *writer, uint32_t stream, uint32_t collOp, const char *name, uint32_t type, OTF_KeyValueList *list)
| Write a collective operation definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefCounter (OTF_Writer *writer, uint32_t stream, uint32_t counter, const char *name, uint32_t properties, uint32_t counterGroup, const char *unit)
| Write a counter definition record. More...
int | OTF_Writer_writeDefCounterKV (OTF_Writer *writer, uint32_t stream, uint32_t counter, const char *name, uint32_t properties, uint32_t counterGroup, const char *unit, OTF_KeyValueList *list)
| Write a counter definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefCounterGroup (OTF_Writer *writer, uint32_t stream, uint32_t counterGroup, const char *name)
| Write a counter group definition record. More...
int | OTF_Writer_writeDefCounterGroupKV (OTF_Writer *writer, uint32_t stream, uint32_t counterGroup, const char *name, OTF_KeyValueList *list)
| Write a counter group definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefScl (OTF_Writer *writer, uint32_t stream, uint32_t source, uint32_t sourceFile, uint32_t line)
| Write a source code location (SCL) record. More...
int | OTF_Writer_writeDefSclKV (OTF_Writer *writer, uint32_t stream, uint32_t source, uint32_t sourceFile, uint32_t line, OTF_KeyValueList *list)
| Write a source code location (SCL) record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefSclFile (OTF_Writer *writer, uint32_t stream, uint32_t sourceFile, const char *name)
| Write a source code location (SCL) file record. More...
int | OTF_Writer_writeDefSclFileKV (OTF_Writer *writer, uint32_t stream, uint32_t sourceFile, const char *name, OTF_KeyValueList *list)
| Write a source code location (SCL) file record including an OTF_KeyValueList. More...
int | OTF_Writer_writeOtfVersion (OTF_Writer *writer, uint32_t stream)
| depricated. More...
int | OTF_Writer_writeDefCreator (OTF_Writer *writer, uint32_t stream, const char *creator)
| Write a creator record. More...
int | OTF_Writer_writeDefCreatorKV (OTF_Writer *writer, uint32_t stream, const char *creator, OTF_KeyValueList *list)
| Write a creator record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefFile (OTF_Writer *writer, uint32_t stream, uint32_t token, const char *name, uint32_t group)
| Write a file definition record. More...
int | OTF_Writer_writeDefFileKV (OTF_Writer *writer, uint32_t stream, uint32_t token, const char *name, uint32_t group, OTF_KeyValueList *list)
| Write a file definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefFileGroup (OTF_Writer *writer, uint32_t stream, uint32_t token, const char *name)
| Write a file group definition record. More...
int | OTF_Writer_writeDefFileGroupKV (OTF_Writer *writer, uint32_t stream, uint32_t token, const char *name, OTF_KeyValueList *list)
| Write a file group definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefKeyValue (OTF_Writer *writer, uint32_t stream, uint32_t key, OTF_Type type, const char *name, const char *description)
| Write a key value definition record. More...
int | OTF_Writer_writeDefKeyValueKV (OTF_Writer *writer, uint32_t stream, uint32_t key, OTF_Type type, const char *name, const char *description, OTF_KeyValueList *list)
| Write a key value definition record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefTimeRange (OTF_Writer *writer, uint32_t streamid, uint64_t minTime, uint64_t maxTime, OTF_KeyValueList *list)
| Writes a TimeRange definition. More...
int | OTF_Writer_writeDefCounterAssignments (OTF_Writer *writer, uint32_t streamid, uint32_t counter_token, uint32_t number_of_members, const uint32_t *procs_or_groups, OTF_KeyValueList *list)
| Writes a CounterAssignments definition. More...
int | OTF_Writer_writeDefProcessSubstitutes (OTF_Writer *writer, uint32_t streamid, uint32_t representative, uint32_t numberOfProcs, const uint32_t *procs, OTF_KeyValueList *list)
| Writes a ProcessSubstitutes definition record. More...
int | OTF_Writer_writeNoOpKV (OTF_Writer *writer, uint64_t time, uint32_t process, OTF_KeyValueList *list)
| Write a no-operation record. More...
int | OTF_Writer_writeEnter (OTF_Writer *writer, uint64_t time, uint32_t function, uint32_t process, uint32_t source)
| Write a function entry record. More...
int | OTF_Writer_writeEnterKV (OTF_Writer *writer, uint64_t time, uint32_t function, uint32_t process, uint32_t source, OTF_KeyValueList *list)
| Write a function entry record including an OTF_KeyValueList. More...
int | OTF_Writer_writeLeave (OTF_Writer *writer, uint64_t time, uint32_t function, uint32_t process, uint32_t source)
| Write a function leave record. More...
int | OTF_Writer_writeLeaveKV (OTF_Writer *writer, uint64_t time, uint32_t function, uint32_t process, uint32_t source, OTF_KeyValueList *list)
| Write a function leave record including an OTF_KeyValueList. More...
int | OTF_Writer_writeRecvMsg (OTF_Writer *writer, uint64_t time, uint32_t receiver, uint32_t sender, uint32_t procGroup, uint32_t tag, uint32_t length, uint32_t source)
| Write a message retrieval record. More...
int | OTF_Writer_writeRecvMsgKV (OTF_Writer *writer, uint64_t time, uint32_t receiver, uint32_t sender, uint32_t procGroup, uint32_t tag, uint32_t length, uint32_t source, OTF_KeyValueList *list)
| Write a message retrieval record including an OTF_KeyValueList. More...
int | OTF_Writer_writeSendMsg (OTF_Writer *writer, uint64_t time, uint32_t sender, uint32_t receiver, uint32_t procGroup, uint32_t tag, uint32_t length, uint32_t source)
| Write a message send record. More...
int | OTF_Writer_writeSendMsgKV (OTF_Writer *writer, uint64_t time, uint32_t sender, uint32_t receiver, uint32_t procGroup, uint32_t tag, uint32_t length, uint32_t source, OTF_KeyValueList *list)
| Write a message send record including an OTF_KeyValueList. More...
int | OTF_Writer_writeCounter (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t counter, uint64_t value)
| Write a counter measurement record. More...
int | OTF_Writer_writeCounterKV (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t counter, uint64_t value, OTF_KeyValueList *list)
| Write a counter measurement record including an OTF_KeyValueList. More...
int | OTF_Writer_writeCollectiveOperation (OTF_Writer *writer, 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)
| Write a collective operation member record. More...
int | OTF_Writer_writeCollectiveOperationKV (OTF_Writer *writer, 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)
| Write a collective operation member record including an OTF_KeyValueList. More...
int | OTF_Writer_writeBeginCollectiveOperation (OTF_Writer *writer, 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)
| Write a begin collective operation member record. More...
int | OTF_Writer_writeBeginCollectiveOperationKV (OTF_Writer *writer, 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)
| Write a begin collective operation member record including an OTF_KeyValueList. More...
int | OTF_Writer_writeEndCollectiveOperation (OTF_Writer *writer, uint64_t time, uint32_t process, uint64_t matchingId)
| Write an end collective operation member record. More...
int | OTF_Writer_writeEndCollectiveOperationKV (OTF_Writer *writer, uint64_t time, uint32_t process, uint64_t matchingId, OTF_KeyValueList *list)
| Write an end collective operation member record including an OTF_KeyValueList. More...
int | OTF_Writer_writeEventComment (OTF_Writer *writer, uint64_t time, uint32_t process, const char *comment)
| Write a comment record. More...
int | OTF_Writer_writeEventCommentKV (OTF_Writer *writer, uint64_t time, uint32_t process, const char *comment, OTF_KeyValueList *list)
| Write a comment record including an OTF_KeyValueList. More...
int | OTF_Writer_writeBeginProcess (OTF_Writer *writer, uint64_t time, uint32_t process)
| Write a begin process record. More...
int | OTF_Writer_writeBeginProcessKV (OTF_Writer *writer, uint64_t time, uint32_t process, OTF_KeyValueList *list)
| Write a begin process record including an OTF_KeyValueList. More...
int | OTF_Writer_writeEndProcess (OTF_Writer *writer, uint64_t time, uint32_t process)
| Write a end process record. More...
int | OTF_Writer_writeEndProcessKV (OTF_Writer *writer, uint64_t time, uint32_t process, OTF_KeyValueList *list)
| Write a end process record including an OTF_KeyValueList. More...
int | OTF_Writer_writeFileOperation (OTF_Writer *writer, uint64_t time, uint32_t fileid, uint32_t process, uint64_t handleid, uint32_t operation, uint64_t bytes, uint64_t duration, uint32_t source)
| Write a file operation record. More...
int | OTF_Writer_writeFileOperationKV (OTF_Writer *writer, 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)
| Write a file operation record including an OTF_KeyValueList. More...
int | OTF_Writer_writeBeginFileOperation (OTF_Writer *writer, uint64_t time, uint32_t process, uint64_t matchingId, uint32_t scltoken)
| Write a begin file operation record. More...
int | OTF_Writer_writeBeginFileOperationKV (OTF_Writer *writer, uint64_t time, uint32_t process, uint64_t matchingId, uint32_t scltoken, OTF_KeyValueList *list)
| Write a begin file operation record including an OTF_KeyValueList. More...
int | OTF_Writer_writeEndFileOperation (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t fileid, uint64_t matchingId, uint64_t handleId, uint32_t operation, uint64_t bytes, uint32_t scltoken)
| Write an end file operation record. More...
int | OTF_Writer_writeEndFileOperationKV (OTF_Writer *writer, 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 including an OTF_KeyValueList. More...
int | OTF_Writer_writeRMAPut (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t origin, uint32_t target, uint32_t communicator, uint32_t tag, uint64_t bytes, uint32_t scltoken)
| Write a RMA put record - local end record. More...
int | OTF_Writer_writeRMAPutKV (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t origin, uint32_t target, uint32_t communicator, uint32_t tag, uint64_t bytes, uint32_t scltoken, OTF_KeyValueList *list)
| Write a RMA put record - local end record including an OTF_KeyValueList. More...
int | OTF_Writer_writeRMAPutRemoteEnd (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t origin, uint32_t target, uint32_t communicator, uint32_t tag, uint64_t bytes, uint32_t scltoken)
| Write a RMA put record - remote end record. More...
int | OTF_Writer_writeRMAPutRemoteEndKV (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t origin, uint32_t target, uint32_t communicator, uint32_t tag, uint64_t bytes, uint32_t scltoken, OTF_KeyValueList *list)
| Write a RMA put record - remote end record including an OTF_KeyValueList. More...
int | OTF_Writer_writeRMAGet (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t origin, uint32_t target, uint32_t communicator, uint32_t tag, uint64_t bytes, uint32_t scltoken)
| Write a RMA get record. More...
int | OTF_Writer_writeRMAGetKV (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t origin, uint32_t target, uint32_t communicator, uint32_t tag, uint64_t bytes, uint32_t scltoken, OTF_KeyValueList *list)
| Write a RMA get record including an OTF_KeyValueList. More...
int | OTF_Writer_writeRMAEnd (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t remote, uint32_t communicator, uint32_t tag, uint32_t scltoken)
| Write a RMA end record. More...
int | OTF_Writer_writeRMAEndKV (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t remote, uint32_t communicator, uint32_t tag, uint32_t scltoken, OTF_KeyValueList *list)
| Write a RMA end record including an OTF_KeyValueList. More...
int | OTF_Writer_writeSnapshotComment (OTF_Writer *writer, uint64_t time, uint32_t process, const char *comment)
| Write a snapshot comment record. More...
int | OTF_Writer_writeSnapshotCommentKV (OTF_Writer *writer, uint64_t time, uint32_t process, const char *comment, OTF_KeyValueList *list)
| Write a snapshot comment record including an OTF_KeyValueList. More...
int | OTF_Writer_writeEnterSnapshot (OTF_Writer *writer, uint64_t time, uint64_t originaltime, uint32_t function, uint32_t process, uint32_t source)
| Write an enter snapshot which provides information about a past function call. More...
int | OTF_Writer_writeEnterSnapshotKV (OTF_Writer *writer, uint64_t time, uint64_t originaltime, uint32_t function, uint32_t process, uint32_t source, OTF_KeyValueList *list)
| Write an enter snapshot including an OTF_KeyValueList. More...
int | OTF_Writer_writeSendSnapshot (OTF_Writer *writer, uint64_t time, uint64_t originaltime, uint32_t sender, uint32_t receiver, uint32_t procGroup, uint32_t tag, uint32_t length, uint32_t source)
| Write a send snapshot which provides information about a past message send operation that is still pending, i.e. More...
int | OTF_Writer_writeSendSnapshotKV (OTF_Writer *writer, 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)
| Write a send snapshot including an OTF_KeyValueList. More...
int | OTF_Writer_writeOpenFileSnapshot (OTF_Writer *writer, uint64_t time, uint64_t originaltime, uint32_t fileid, uint32_t process, uint64_t handleid, uint32_t source)
| Write a snapshot record for an open (and not yet closed) file. More...
int | OTF_Writer_writeOpenFileSnapshotKV (OTF_Writer *writer, uint64_t time, uint64_t originaltime, uint32_t fileid, uint32_t process, uint64_t handleid, uint32_t source, OTF_KeyValueList *list)
| Write a snapshot record including an OTF_KeyValueList. More...
int | OTF_Writer_writeBeginCollopSnapshot (OTF_Writer *writer, 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)
| Write a snapshot record for an unfinished collective operation. More...
int | OTF_Writer_writeBeginCollopSnapshotKV (OTF_Writer *writer, 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)
| Write a snapshot record for an unfinished collective operation including an OTF_KeyValueList. More...
int | OTF_Writer_writeBeginFileOpSnapshot (OTF_Writer *writer, uint64_t time, uint64_t originaltime, uint32_t process, uint64_t matchingId, uint32_t scltoken)
| Write a snapshot for an unfinished file operation. More...
int | OTF_Writer_writeBeginFileOpSnapshotKV (OTF_Writer *writer, uint64_t time, uint64_t originaltime, uint32_t process, uint64_t matchingId, uint32_t scltoken, OTF_KeyValueList *list)
| Write a snapshot for an unfinished file operation including an OTF_KeyValueList. More...
int | OTF_Writer_writeSummaryComment (OTF_Writer *writer, uint64_t time, uint32_t process, const char *comment)
| Write a summary comment record. More...
int | OTF_Writer_writeSummaryCommentKV (OTF_Writer *writer, uint64_t time, uint32_t process, const char *comment, OTF_KeyValueList *list)
| Write a summary comment record including an OTF_KeyValueList. More...
int | OTF_Writer_writeFunctionSummary (OTF_Writer *writer, uint64_t time, uint32_t function, uint32_t process, uint64_t count, uint64_t excltime, uint64_t incltime)
| Write a function summary record. More...
int | OTF_Writer_writeFunctionSummaryKV (OTF_Writer *writer, uint64_t time, uint32_t function, uint32_t process, uint64_t count, uint64_t excltime, uint64_t incltime, OTF_KeyValueList *list)
| Write a function summary record including an OTF_KeyValueList. More...
int | OTF_Writer_writeFunctionGroupSummary (OTF_Writer *writer, uint64_t time, uint32_t functiongroup, uint32_t process, uint64_t count, uint64_t excltime, uint64_t incltime)
| Write a functiongroup summary record. More...
int | OTF_Writer_writeFunctionGroupSummaryKV (OTF_Writer *writer, uint64_t time, uint32_t functiongroup, uint32_t process, uint64_t count, uint64_t excltime, uint64_t incltime, OTF_KeyValueList *list)
| Write a functiongroup summary record including an OTF_KeyValueList. More...
int | OTF_Writer_writeMessageSummary (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t peer, uint32_t comm, uint32_t tag, uint64_t number_sent, uint64_t number_recved, uint64_t bytes_sent, uint64_t bytes_recved)
| Write a message summary record. More...
int | OTF_Writer_writeMessageSummaryKV (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t peer, uint32_t comm, uint32_t tag, uint64_t number_sent, uint64_t number_recved, uint64_t bytes_sent, uint64_t bytes_recved, OTF_KeyValueList *list)
| Write a message summary record including an OTF_KeyValueList. More...
int | OTF_Writer_writeCollopSummary (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t comm, uint32_t collective, uint64_t number_sent, uint64_t number_recved, uint64_t bytes_sent, uint64_t bytes_recved)
| Write a summary record of collective operations. More...
int | OTF_Writer_writeCollopSummaryKV (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t comm, uint32_t collective, uint64_t number_sent, uint64_t number_recved, uint64_t bytes_sent, uint64_t bytes_recved, OTF_KeyValueList *list)
| Write a summary record of collective operations including an OTF_KeyValueList. More...
int | OTF_Writer_writeFileOperationSummary (OTF_Writer *writer, 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)
| Writes a file operation summary record. More...
int | OTF_Writer_writeFileOperationSummaryKV (OTF_Writer *writer, 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)
| Writes a file operation summary record including an OTF_KeyValueList. More...
int | OTF_Writer_writeFileGroupOperationSummary (OTF_Writer *writer, 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)
| Writes a file group operation summary record. More...
int | OTF_Writer_writeFileGroupOperationSummaryKV (OTF_Writer *writer, 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)
| Writes a file group operation summary record including an OTF_KeyValueList. More...
int | OTF_Writer_writeDefMarker (OTF_Writer *writer, uint32_t streamID, uint32_t token, const char *name, uint32_t type)
| Writes a def marker record. More...
int | OTF_Writer_writeDefMarkerKV (OTF_Writer *writer, uint32_t streamID, uint32_t token, const char *name, uint32_t type, OTF_KeyValueList *list)
| Writes a def marker record including an OTF_KeyValueList. More...
int | OTF_Writer_writeMarker (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t token, const char *text)
| Writes a marker record. More...
int | OTF_Writer_writeMarkerKV (OTF_Writer *writer, uint64_t time, uint32_t process, uint32_t token, const char *text, OTF_KeyValueList *list)
| Writes a marker record including an OTF_KeyValueList. More...

## Detailed Description

This interface should be used whenever a trace file is to be written as a whole.

Therefore, an initial call to the OTF_Writer_open() function allows to specify a number of streams which are going to be used to automatically partition the recorded event data. OTF than takes over the duty of distributing the data on multiple files.

# A simple Example

#include <assert.h>
#include "otf.h"
int main( int argc, char** argv ) {

    Declare a file manager and a writer.

OTF_FileManager* manager;
OTF_Writer* writer;

Initialize the file manager. Open at most 100 OS files.

manager= OTF_FileManager_open( 100 );
assert( manager );

Initialize the writer. Open file "test", writing one stream.

writer = OTF_Writer_open( "test", 1, manager );
assert( writer );

Write some important Definition Records. Have a look at the specific functions to see what the parameters mean.

OTF_Writer_writeDefTimerResolution( writer, 0, 1000 );
OTF_Writer_writeDefProcess( writer, 0, 1, "proc one", 0 );
OTF_Writer_writeDefFunctionGroup( writer, 0, 1000, "all functions" );
OTF_Writer_writeDefFunction( writer, 0, 1, "main", 1000, 0 );

     Write an enter and a leave record.
     time = 10000, 20000
     process = 1
     function = 1
     Sourcecode location doesn't matter, so it's zero.

OTF_Writer_writeEnter( writer, 10000, 1, 1, 0 );
OTF_Writer_writeLeave( writer, 20000, 1, 1, 0 );

Clean up before exiting the program.

OTF_Writer_close( writer );
OTF_FileManager_close( manager );
return 0;
}

Compile this using $ gcc -o test test.c `otfconfig --libs`.

## Function Documentation

uint32_t OTF_Writer_assignProcess | ( | OTF_Writer * | writer,
|  | uint32_t | process,
|  | uint32_t | stream
| ) |  |

Explicitly assign a given process to a specific stream.

Mind that 0 is not a valid stream or process identifier but a reserved value. By default, processes are automatically assigned to streams. Therefore, this call is optional.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  process | Process identifier. See also OTF_Writer_writeDefProcess().
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().

Returns
  1 on success, 0 if an error occurs.

References struct_OTF_Writer::mc, and OTF_MasterControl_append().

Referenced by OTF_Writer_mapProcess().

int OTF_Writer_close | ( | OTF_Writer * | writer | ) |

Close an OTF_Writer instance and all its related files.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().

Returns
  1 if instance was closed successfully and 0 otherwise.

int OTF_Writer_closeAllStreams | ( | OTF_Writer * | writer | ) |

Close all streams that are open in this writer instance.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().

Returns
  1 on success, 0 if an error occurs.

References struct_OTF_Writer::n, OTF_WStream_close(), and struct_OTF_Writer::streams.

uint32_t OTF_Writer_getBufferSizes | ( | OTF_Writer * | writer | ) |

Get the default buffer size for all buffers managed by this Writer.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().

Returns
  Default buffer size for all buffers managed by this Writer.

References struct_OTF_Writer::buffersizes.

OTF_FileCompression OTF_Writer_getCompression | ( | OTF_Writer * | writer | ) |

Return the standard compression method for all buffers managed by this writer.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().

Returns
  Standard compression level for all buffers managed by this writer.

uint32_t OTF_Writer_getFormat | ( | OTF_Writer * | writer | ) |

Get the default output format of all streams managed by this writer.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().

Returns
  Default output format.

References struct_OTF_Writer::format.

OTF_MasterControl* OTF_Writer_getMasterControl | ( | OTF_Writer * | writer | ) |

Get a pointer to the master control object of the given writer instance.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().

Returns
  Pointer to a master control object. See OTF_MasterControl.

References struct_OTF_Writer::mc.

OTF_WStream* OTF_Writer_getStream | ( | OTF_Writer * | writer,
|  | uint32_t | stream
| ) |  |

Return the stream with the given stream id.

If there is no such stream yet create one and append it to 'streams'.

References struct_OTF_Writer::buffersizes, struct_OTF_Writer::format, struct_OTF_WStream::id, struct_OTF_Writer::manager, struct_OTF_Writer::n, struct_OTF_Writer::namestub, OTF_WStream_open(), OTF_WStream_setBufferSizes(), OTF_WStream_setCompression(), OTF_WStream_setFormat(), OTF_WStream_setZBufferSizes(), struct_OTF_Writer::s, and struct_OTF_Writer::streams.

Referenced by OTF_Writer_writeBeginCollectiveOperation(), OTF_Writer_writeBeginCollectiveOperationKV(), OTF_Writer_writeBeginCollopSnapshot(), OTF_Writer_writeBeginCollopSnapshotKV(), OTF_Writer_writeBeginFileOperation(), OTF_Writer_writeBeginFileOperationKV(), OTF_Writer_writeBeginFileOpSnapshot(), OTF_Writer_writeBeginFileOpSnapshotKV(), OTF_Writer_writeBeginProcess(), OTF_Writer_writeBeginProcessKV(), OTF_Writer_writeCollectiveOperation(), OTF_Writer_writeCollectiveOperationKV(), OTF_Writer_writeCollopSummary(), OTF_Writer_writeCollopSummaryKV(), OTF_Writer_writeCounter(), OTF_Writer_writeCounterKV(), OTF_Writer_writeDefAttributeList(), OTF_Writer_writeDefAttributeListKV(), OTF_Writer_writeDefCollectiveOperation(), OTF_Writer_writeDefCollectiveOperationKV(), OTF_Writer_writeDefCounter(), OTF_Writer_writeDefCounterAssignments(), OTF_Writer_writeDefCounterGroup(), OTF_Writer_writeDefCounterGroupKV(), OTF_Writer_writeDefCounterKV(), OTF_Writer_writeDefCreator(), OTF_Writer_writeDefCreatorKV(), OTF_Writer_writeDefFile(), OTF_Writer_writeDefFileGroup(), OTF_Writer_writeDefFileGroupKV(), OTF_Writer_writeDefFileKV(), OTF_Writer_writeDefFunction(), OTF_Writer_writeDefFunctionGroup(), OTF_Writer_writeDefFunctionGroupKV(), OTF_Writer_writeDefFunctionKV(), OTF_Writer_writeDefinitionComment(), OTF_Writer_writeDefinitionCommentKV(), OTF_Writer_writeDefKeyValue(), OTF_Writer_writeDefKeyValueKV(), OTF_Writer_writeDefMarker(), OTF_Writer_writeDefMarkerKV(), OTF_Writer_writeDefProcess(), OTF_Writer_writeDefProcessGroup(), OTF_Writer_writeDefProcessGroupKV(), OTF_Writer_writeDefProcessKV(), OTF_Writer_writeDefProcessOrGroupAttributes(), OTF_Writer_writeDefProcessOrGroupAttributesKV(), OTF_Writer_writeDefProcessSubstitutes(), OTF_Writer_writeDefScl(), OTF_Writer_writeDefSclFile(), OTF_Writer_writeDefSclFileKV(), OTF_Writer_writeDefSclKV(), OTF_Writer_writeDefTimeRange(), OTF_Writer_writeDefTimerResolution(), OTF_Writer_writeDefTimerResolutionKV(), OTF_Writer_writeEndCollectiveOperation(), OTF_Writer_writeEndCollectiveOperationKV(), OTF_Writer_writeEndFileOperation(), OTF_Writer_writeEndFileOperationKV(), OTF_Writer_writeEndProcess(), OTF_Writer_writeEndProcessKV(), OTF_Writer_writeEnter(), OTF_Writer_writeEnterKV(), OTF_Writer_writeEnterSnapshot(), OTF_Writer_writeEnterSnapshotKV(), OTF_Writer_writeEventComment(), OTF_Writer_writeEventCommentKV(), OTF_Writer_writeFileGroupOperationSummary(), OTF_Writer_writeFileGroupOperationSummaryKV(), OTF_Writer_writeFileOperation(), OTF_Writer_writeFileOperationKV(), OTF_Writer_writeFileOperationSummary(), OTF_Writer_writeFileOperationSummaryKV(), OTF_Writer_writeFunctionGroupSummary(), OTF_Writer_writeFunctionGroupSummaryKV(), OTF_Writer_writeFunctionSummary(), OTF_Writer_writeFunctionSummaryKV(), OTF_Writer_writeLeave(), OTF_Writer_writeLeaveKV(), OTF_Writer_writeMarker(), OTF_Writer_writeMarkerKV(), OTF_Writer_writeMessageSummary(), OTF_Writer_writeMessageSummaryKV(), OTF_Writer_writeNoOpKV(), OTF_Writer_writeOpenFileSnapshot(), OTF_Writer_writeOpenFileSnapshotKV(), OTF_Writer_writeRecvMsg(), OTF_Writer_writeRecvMsgKV(), OTF_Writer_writeRMAEnd(), OTF_Writer_writeRMAEndKV(), OTF_Writer_writeRMAGet(), OTF_Writer_writeRMAGetKV(), OTF_Writer_writeRMAPut(), OTF_Writer_writeRMAPutKV(), OTF_Writer_writeRMAPutRemoteEnd(), OTF_Writer_writeRMAPutRemoteEndKV(), OTF_Writer_writeSendMsg(), OTF_Writer_writeSendMsgKV(), OTF_Writer_writeSendSnapshot(), OTF_Writer_writeSendSnapshotKV(), OTF_Writer_writeSnapshotComment(), OTF_Writer_writeSnapshotCommentKV(), OTF_Writer_writeSummaryComment(), and OTF_Writer_writeSummaryCommentKV().

uint32_t OTF_Writer_getZBufferSizes | ( | OTF_Writer * | writer | ) |

Get the default zbuffer size.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().

Returns
  zbuffer size.

uint32_t OTF_Writer_mapProcess | ( | OTF_Writer * | writer,
|  | uint32_t | processId
| ) |  |

For a process with id 'processId' return a stream id of the stream the data is to be written to.

If no mapping has been set so far it is defined in a way such that it is added to the stream with the least processes.

References struct_OTF_MapEntry::argument, struct_OTF_Writer::mc, struct_OTF_MapEntry::n, OTF_MasterControl_getCount(), OTF_MasterControl_getEntryByIndex(), OTF_MasterControl_getNewStreamId(), OTF_MasterControl_mapReverse(), and OTF_Writer_assignProcess().

Referenced by OTF_Writer_writeBeginCollectiveOperation(), OTF_Writer_writeBeginCollectiveOperationKV(), OTF_Writer_writeBeginCollopSnapshot(), OTF_Writer_writeBeginCollopSnapshotKV(), OTF_Writer_writeBeginFileOperation(), OTF_Writer_writeBeginFileOperationKV(), OTF_Writer_writeBeginFileOpSnapshot(), OTF_Writer_writeBeginFileOpSnapshotKV(), OTF_Writer_writeBeginProcess(), OTF_Writer_writeBeginProcessKV(), OTF_Writer_writeCollectiveOperation(), OTF_Writer_writeCollectiveOperationKV(), OTF_Writer_writeCollopSummary(), OTF_Writer_writeCollopSummaryKV(), OTF_Writer_writeCounter(), OTF_Writer_writeCounterKV(), OTF_Writer_writeEndCollectiveOperation(), OTF_Writer_writeEndCollectiveOperationKV(), OTF_Writer_writeEndFileOperation(), OTF_Writer_writeEndFileOperationKV(), OTF_Writer_writeEndProcess(), OTF_Writer_writeEndProcessKV(), OTF_Writer_writeEnter(), OTF_Writer_writeEnterKV(), OTF_Writer_writeEnterSnapshot(), OTF_Writer_writeEnterSnapshotKV(), OTF_Writer_writeEventComment(), OTF_Writer_writeEventCommentKV(), OTF_Writer_writeFileGroupOperationSummary(), OTF_Writer_writeFileGroupOperationSummaryKV(), OTF_Writer_writeFileOperation(), OTF_Writer_writeFileOperationKV(), OTF_Writer_writeFileOperationSummary(), OTF_Writer_writeFileOperationSummaryKV(), OTF_Writer_writeFunctionGroupSummary(), OTF_Writer_writeFunctionGroupSummaryKV(), OTF_Writer_writeFunctionSummary(), OTF_Writer_writeFunctionSummaryKV(), OTF_Writer_writeLeave(), OTF_Writer_writeLeaveKV(), OTF_Writer_writeMessageSummary(), OTF_Writer_writeMessageSummaryKV(), OTF_Writer_writeNoOpKV(), OTF_Writer_writeOpenFileSnapshot(), OTF_Writer_writeOpenFileSnapshotKV(), OTF_Writer_writeRecvMsg(), OTF_Writer_writeRecvMsgKV(), OTF_Writer_writeRMAEnd(), OTF_Writer_writeRMAEndKV(), OTF_Writer_writeRMAGet(), OTF_Writer_writeRMAGetKV(), OTF_Writer_writeRMAPut(), OTF_Writer_writeRMAPutKV(), OTF_Writer_writeRMAPutRemoteEnd(), OTF_Writer_writeRMAPutRemoteEndKV(), OTF_Writer_writeSendMsg(), OTF_Writer_writeSendMsgKV(), OTF_Writer_writeSendSnapshot(), OTF_Writer_writeSendSnapshotKV(), OTF_Writer_writeSnapshotComment(), OTF_Writer_writeSnapshotCommentKV(), OTF_Writer_writeSummaryComment(), and OTF_Writer_writeSummaryCommentKV().

OTF_Writer* OTF_Writer_open | ( | const char * | fileNamePrefix,
|  | uint32_t | numberOfStreams,
|  | OTF_FileManager * | fileManager
| ) |  |

Create a new OTF_Writer instance with a given number of automatic streams.

Setting the number of streams to 0 causes the OTF_Writer object to create a separate stream for each process. Important! Explicit calls to OTF_Writer_assignProcess() can lead to an overall number of streams which exceeds the initial number of streams in this call. OTF can reduce its file handle usage to a given number. Therefore, an initialized file manager instance is needed as parameter. See OTF_FileManager for further details.

Parameters

  fileNamePrefix | File name prefix which is going to be used by all sub-files which belong to the trace.
  numberOfStreams | Initial number of independent data streams to be generated.
  fileManager | File handle manager.

Returns
  Initialized OTF_Writer instance or 0 if a failure occurred.

References struct_OTF_Writer::m, struct_OTF_Writer::manager, struct_OTF_Writer::mc, struct_OTF_Writer::namestub, OTF_MasterControl_new(), and OTF_stripFilename().

void OTF_Writer_setBufferSizes | ( | OTF_Writer * | writer,
|  | uint32_t | size
| ) |  |

Set the default buffer size for all buffers managed by this Writer.

This is only effective for future buffers and will not change already allocated buffers. Those can be changed with the buffers directly.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  size | Intended buffer size.

References struct_OTF_Writer::buffersizes.

int OTF_Writer_setCompression | ( | OTF_Writer * | writer,
|  | OTF_FileCompression | compression
| ) |  |

Set the standard compression method for all buffers managed by this writer.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  compression | compression level to apply to all following streams 0-9, where 0 means no compression is applied, and 9 is the highest level of compression.

Returns
  1 on success, 0 if an error occurs.

void OTF_Writer_setFormat | ( | OTF_Writer * | writer,
|  | uint32_t | format
| ) |  |

Set the default ouput format.

The format is applied to all streams opened by the writer.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  format | Intended output format (OTF_WSTREAM_FORMAT_{LONG,SHORT}).

References struct_OTF_Writer::format.

void OTF_Writer_setMasterControl | ( | OTF_Writer * | writer,
|  | OTF_MasterControl * | mc
| ) |  |

Set an alternative master control object.

Use this only right after initialization but never after having written some records already!

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  mc | new master control object

References struct_OTF_Writer::mc, and OTF_MasterControl_close().

void OTF_Writer_setZBufferSizes | ( | OTF_Writer * | writer,
|  | uint32_t | size
| ) |  |

Set the default zbuffer size for all buffers managed by this Reader.

This is only effective for future files and will not change already allocated zbuffers. Those can be changed with the files directly.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  size | Intended zbuffer size.

int OTF_Writer_writeBeginCollectiveOperation | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Write a begin collective operation member record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when collective operation was entered by member.
  process | Process identifier i.e. collective member.
  collOp | Collective identifier to be defined with OTF_Writer_writeDefCollectiveOperation().
  matchingId | Identifier for finding the associated end collective event record. It must be unique within this procGroup.
  procGroup | Group of processes participating in this collective.
  rootProc | Root process if != 0.
  sent | Data volume sent by member or 0.
  received | Data volume received by member or 0.
  scltoken | Explicit source code location or 0.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeBeginCollectiveOperation().

int OTF_Writer_writeBeginCollectiveOperationKV | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Write a begin collective operation member record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeBeginCollectiveOperation()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeBeginCollectiveOperationKV().

int OTF_Writer_writeBeginCollopSnapshot | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Write a snapshot record for an unfinished collective operation.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when the snapshot was written(current time).
  originaltime | Time when the collective operation began.
  process | Process identifier i.e. collective member.
  collOp | Collective identifier to be defined with OTF_Writer_writeDefCollectiveOperation().
  matchingId | Identifier for finding the associated end collective event record. It must be unique within this procGroup.
  procGroup | Group of processes participating in this collective.
  rootProc | Root process if != 0.
  sent | Data volume sent by member or 0.
  received | Data volume received by member or 0.
  scltoken | Explicit source code location or 0.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeBeginCollopSnapshot().

int OTF_Writer_writeBeginCollopSnapshotKV | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Write a snapshot record for an unfinished collective operation including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeBeginCollopSnapshot()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeBeginCollopSnapshotKV().

int OTF_Writer_writeBeginFileOperation | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint64_t | matchingId,
|  | uint32_t | scltoken
| ) |  |

Write a begin file operation record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Start time of file operation.
  process | Process identifier > 0.
  matchingId | Operation identifier, used for finding the associated end file operation event record.
  scltoken | Optional reference to source code.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeBeginFileOperation().

int OTF_Writer_writeBeginFileOperationKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint64_t | matchingId,
|  | uint32_t | scltoken,
|  | OTF_KeyValueList * | list
| ) |  |

Write a begin file operation record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeBeginFileOperation()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeBeginFileOperationKV().

int OTF_Writer_writeBeginFileOpSnapshot | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint64_t | originaltime,
|  | uint32_t | process,
|  | uint64_t | matchingId,
|  | uint32_t | scltoken
| ) |  |

Write a snapshot for an unfinished file operation.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when the snapshot was written(current time).
  originaltime | Time when the operation began.
  process | Process identifier > 0.
  matchingId | Operation identifier, used for finding the associated end file operation event record.
  scltoken | Optional reference to source code.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeBeginFileOpSnapshot().

int OTF_Writer_writeBeginFileOpSnapshotKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint64_t | originaltime,
|  | uint32_t | process,
|  | uint64_t | matchingId,
|  | uint32_t | scltoken,
|  | OTF_KeyValueList * | list
| ) |  |

Write a snapshot for an unfinished file operation including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeBeginFileOperation()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeBeginFileOpSnapshotKV().

int OTF_Writer_writeBeginProcess | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process
| ) |  |

Write a begin process record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when process was referenced for the first time.
  process | Process identifier > 0.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeBeginProcess().

int OTF_Writer_writeBeginProcessKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | OTF_KeyValueList * | list
| ) |  |

Write a begin process record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeBeginProcess()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeBeginProcessKV().

int OTF_Writer_writeCollectiveOperation | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Write a collective operation member record.

Deprecated:
  This event record has been deprecated due to usage constraints. Please use OTF_Writer_writeBeginCollectiveOperation() and OTF_Writer_writeEndCollectiveOperation(), repectively.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when collective operation was entered by member.
  process | Process identifier i.e. collective member.
  collective | Collective identifier to be defined with OTF_Writer_writeDefCollectiveOperation().
  procGroup | Group of processes participating in this collective.
  rootProc | Root process if != 0.
  sent | Data volume sent by member or 0.
  received | Data volumd received by member or 0.
  duration | Time spent in collective operation.
  source | Explicit source code location or 0.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeCollectiveOperation().

int OTF_Writer_writeCollectiveOperationKV | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Write a collective operation member record including an OTF_KeyValueList.

Deprecated:
  This event record has been deprecated due to usage constraints. Please use OTF_Writer_writeBeginCollectiveOperationEV() and OTF_Writer_writeEndCollectiveOperationEV(), repectively.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeCollectiveOperation()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeCollectiveOperationKV().

int OTF_Writer_writeCollopSummary | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | comm,
|  | uint32_t | collective,
|  | uint64_t | number_sent,
|  | uint64_t | number_recved,
|  | uint64_t | bytes_sent,
|  | uint64_t | bytes_recved
| ) |  |

Write a summary record of collective operations.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when summary was computed.
  process | Process identifier i.e. collective member.
  comm | Communicator of collective operation summary.
  collective | Collective identifier to be defined with OTF_Writer_writeDefCollectiveOperation().
  number_sent | The number of messages sent by member or 0.
  number_recved | The number of messages received by member or 0.
  bytes_sent | The number of bytes sent by member or 0.
  bytes_recved | The number of bytes received by member or 0.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeCollopSummary().

int OTF_Writer_writeCollopSummaryKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | comm,
|  | uint32_t | collective,
|  | uint64_t | number_sent,
|  | uint64_t | number_recved,
|  | uint64_t | bytes_sent,
|  | uint64_t | bytes_recved,
|  | OTF_KeyValueList * | list
| ) |  |

Write a summary record of collective operations including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeCollopSummary()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeCollopSummaryKV().

int OTF_Writer_writeCounter | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | counter,
|  | uint64_t | value
| ) |  |

Write a counter measurement record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when counter was measured.
  process | Process where counter measurment took place.
  counter | Counter which was measured.
  value | Counter value.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeCounter().

int OTF_Writer_writeCounterKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | counter,
|  | uint64_t | value,
|  | OTF_KeyValueList * | list
| ) |  |

Write a counter measurement record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeCounter()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeCounterKV().

int OTF_Writer_writeDefAttributeList | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | attr_token,
|  | uint32_t | num,
|  | OTF_ATTR_TYPE * | array
| ) |  |

Write an attribute list definition record.

Defines a list of attributes that is assigned to a unique token.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  attr_token | Arbitrary but unique attribute list identifier > 0.
  num | Number of elements in the attribute list array.
  array | An array of different attributes with type of OTF_ATTR_TYPE().

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefAttributeList(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefAttributeListKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | attr_token,
|  | uint32_t | num,
|  | OTF_ATTR_TYPE * | array,
|  | OTF_KeyValueList * | list
| ) |  |

Write an attribute list definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefAttributeList()

References OTF_Writer_getStream(), OTF_WStream_writeDefAttributeListKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefCollectiveOperation | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | collOp,
|  | const char * | name,
|  | uint32_t | type
| ) |  |

Write a collective operation definition record.

Parameters

  writer | Initialized OTF_Writer instance.
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  collOp | An arbitrary but unique collective op. identifier > 0.
  name | Name of the collective operation e.g. "MPI_Bcast".
  type | One of the five supported collective classes: OTF_COLLECTIVE_TYPE_UNKNOWN (default), OTF_COLLECTIVE_TYPE_BARRIER, OTF_COLLECTIVE_TYPE_ONE2ALL, OTF_COLLECTIVE_TYPE_ALL2ONE, OTF_COLLECTIVE_TYPE_ALL2ALL.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefCollectiveOperation(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefCollectiveOperationKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | collOp,
|  | const char * | name,
|  | uint32_t | type,
|  | OTF_KeyValueList * | list
| ) |  |

Write a collective operation definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefCollectiveOperation()

References OTF_Writer_getStream(), OTF_WStream_writeDefCollectiveOperationKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefCounter | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | counter,
|  | const char * | name,
|  | uint32_t | properties,
|  | uint32_t | counterGroup,
|  | const char * | unit
| ) |  |

Write a counter definition record.

Parameters

  writer | Initialized OTF_Writer instance.
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  counter | An arbitrary but unique counter identifier.
  name | Name of the counter e.g. "Cache Misses".
  properties | A combination of a type and scope counter property. OTF_COUNTER_TYPE_ACC (default) represents a counter with monotonously increasing values e.g. a FLOP counter. OTF_COUNTER_TYPE_ABS on the other hand defines a counter with alternating absolute values e.g. the memory usage of a process. The following counter measurement scopes are supported: OTF_COUNTER_SCOPE_START (default) always refers to the start of the process, OTF_COUNTER_SCOPE_POINT refers to exactly this moment in time, OTF_COUNTER_SCOPE_LAST relates to the previous measurement, and OTF_COUNTER_SCOPE_NEXT to the next measurement. Examples: OTF_COUNTER_TYPE_ACC + OTF_COUNTER_SCOPE_START should be used for most standard hardware (PAPI) counters. OTF_COUNTER_TYPE_ABS + OTF_COUNTER_SCOPE_POINT could be used to record information 'spikes'. OTF_COUNTER_TYPE_ABS + OTF_COUNTER_SCOPE_NEXT works for memory allocation recording.
  counterGroup | A previously defined counter group identifier or 0 for no group.
  unit | Unit of the counter e.g. "#" for "number of..." or 0 for no unit.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefCounter(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefCounterAssignments | ( | OTF_Writer * | writer,
|  | uint32_t | streamid,
|  | uint32_t | counter_token,
|  | uint32_t | number_of_members,
|  | const uint32_t * | procs_or_groups,
|  | OTF_KeyValueList * | list
| ) |  |

Writes a CounterAssignments definition.

Parameters

  userData | Pointer to user data which can be set with OTF_HandlerArray_setFirstHandlerArg().
  streamid | Identifies the stream to which this definition belongs to. stream = 0 represents a global definition.
  counter_token | Counter id.
  number_of_members | Number of entries in array.
  procs_or_groups | The processes or process groups which have recorded counter data for counter .
  list | Pointer to an OTF_KeyValueList() that contains individual data.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefCounterAssignments(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefCounterGroup | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | counterGroup,
|  | const char * | name
| ) |  |

Write a counter group definition record.

Parameters

  writer | Initialized OTF_Writer instance.
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  counterGroup | An arbitrary but unique counter group identifier.
  name | Counter group name.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefCounterGroup(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefCounterGroupKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | counterGroup,
|  | const char * | name,
|  | OTF_KeyValueList * | list
| ) |  |

Write a counter group definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefCounterGroup()

References OTF_Writer_getStream(), OTF_WStream_writeDefCounterGroupKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefCounterKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | counter,
|  | const char * | name,
|  | uint32_t | properties,
|  | uint32_t | counterGroup,
|  | const char * | unit,
|  | OTF_KeyValueList * | list
| ) |  |

Write a counter definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefCounter()

References OTF_Writer_getStream(), OTF_WStream_writeDefCounterKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefCreator | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | const char * | creator
| ) |  |

Write a creator record.

Parameters

  writer | Initialized OTF_Writer instance.
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  creator | String which identifies the creator of the file e.g. "TAU Version x.y.z".

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefCreator(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefCreatorKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | const char * | creator,
|  | OTF_KeyValueList * | list
| ) |  |

Write a creator record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefCreator()

References OTF_Writer_getStream(), OTF_WStream_writeDefCreatorKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefFile | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | token,
|  | const char * | name,
|  | uint32_t | group
| ) |  |

Write a file definition record.

Parameters

  writer | Initialized OTF_Writer instance.
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  token | Arbitrary, unique identifier for the file. Has to be > 0.
  name | Name of the file.
  group | File group identifier or 0 for no group.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), and OTF_WStream_writeDefFile().

int OTF_Writer_writeDefFileGroup | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | token,
|  | const char * | name
| ) |  |

Write a file group definition record.

Parameters

  writer | Initialized OTF_Writer instance.
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  token | Arbitrary, unique identifier for the file group. Has to be > 0.
  name | Name of the file group.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), and OTF_WStream_writeDefFileGroup().

int OTF_Writer_writeDefFileGroupKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | token,
|  | const char * | name,
|  | OTF_KeyValueList * | list
| ) |  |

Write a file group definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefFileGroup()

References OTF_Writer_getStream(), and OTF_WStream_writeDefFileGroupKV().

int OTF_Writer_writeDefFileKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | token,
|  | const char * | name,
|  | uint32_t | group,
|  | OTF_KeyValueList * | list
| ) |  |

Write a file definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefFile()

References OTF_Writer_getStream(), and OTF_WStream_writeDefFileKV().

int OTF_Writer_writeDefFunction | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | func,
|  | const char * | name,
|  | uint32_t | funcGroup,
|  | uint32_t | source
| ) |  |

Write a function definition record.

Defines a function of the given name. Functions can optionally belong to a certain function group to be defined with the OTF_Writer_writeDefFunctionGroup() call. A source code reference can be added to the definition aswell.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  func | Arbitrary but unique function identifier > 0.
  name | Name of the function e.g. "DoSomething".
  funcGroup | A function group identifier preliminary defined with OTF_Writer_writeDefFunctionGroup() or 0 for no function group assignment.
  source | Reference to the function's source code location preliminary defined with OTF_Writer_writeDefScl() or 0 for no source code location assignment.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefFunction(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefFunctionGroup | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | funcGroup,
|  | const char * | name
| ) |  |

Write a function group definition record.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  funcGroup | An arbitrary but unique function group identifier > 0.
  name | Name of the function group e.g. "Computation".

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefFunctionGroup(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefFunctionGroupKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | funcGroup,
|  | const char * | name,
|  | OTF_KeyValueList * | list
| ) |  |

Write a function group definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefFunctionGroup()

References OTF_Writer_getStream(), OTF_WStream_writeDefFunctionGroupKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefFunctionKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | func,
|  | const char * | name,
|  | uint32_t | funcGroup,
|  | uint32_t | source,
|  | OTF_KeyValueList * | list
| ) |  |

Write a function definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefFunction()

References OTF_Writer_getStream(), OTF_WStream_writeDefFunctionKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefinitionComment | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | const char * | comment
| ) |  |

Write a comment record.

Parameters

  writer | Initialized OTF_Writer instance.
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  comment | Arbitrary comment string.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefinitionComment(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefinitionCommentKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | const char * | comment,
|  | OTF_KeyValueList * | list
| ) |  |

Write a comment record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefinitionComment()

References OTF_Writer_getStream(), OTF_WStream_writeDefinitionCommentKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefKeyValue | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | key,
|  | OTF_Type | type,
|  | const char * | name,
|  | const char * | description
| ) |  |

Write a key value definition record.

Parameters

  writer | Initialized OTF_Writer instance.
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  key | Arbitrary, unique identifier for the key value pair.
  type | Type of the key.
  name | Name of the key value pair.
  description | Description of the key value pair.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefKeyValue(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefKeyValueKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | key,
|  | OTF_Type | type,
|  | const char * | name,
|  | const char * | description,
|  | OTF_KeyValueList * | list
| ) |  |

Write a key value definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefKeyValue()

References OTF_Writer_getStream(), OTF_WStream_writeDefKeyValueKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefMarker | ( | OTF_Writer * | writer,
|  | uint32_t | streamID,
|  | uint32_t | token,
|  | const char * | name,
|  | uint32_t | type
| ) |  |

Writes a def marker record.

Parameters

  writer | Initialized OTF_Writer instance. qparam streamID stream identifier that must be 0, any other value is ignored
  token | The newly defined marker token.
  name | Its name
  type | Marker type, one of OTF_MARKER_TYPE_xxx

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), and OTF_WStream_writeDefMarker().

int OTF_Writer_writeDefMarkerKV | ( | OTF_Writer * | writer,
|  | uint32_t | streamID,
|  | uint32_t | token,
|  | const char * | name,
|  | uint32_t | type,
|  | OTF_KeyValueList * | list
| ) |  |

Writes a def marker record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefMarker()

References OTF_Writer_getStream(), and OTF_WStream_writeDefMarkerKV().

int OTF_Writer_writeDefProcess | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | process,
|  | const char * | name,
|  | uint32_t | parent
| ) |  |

Write a process definition record.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  process | Arbitrary but unique process identifier > 0.
  name | Name of the process e.g. "Process X".
  parent | Previously declared parent process identifier or 0 if process has no parent.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefProcess(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefProcessGroup | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | procGroup,
|  | const char * | name,
|  | uint32_t | numberOfProcs,
|  | const uint32_t * | procs
| ) |  |

Write a process group definition record.

OTF supports groups of processes. Their main objective is to classify processes depending on arbitrary characteristics. Processes can reside in multiple groups. This record type is optional.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  procGroup | Arbitrary but unique process group identifier > 0.
  name | Name of the process group e.g. "Well Balanced".
  numberOfProcs | The number of processes in the process group.
  procs | Vector of process identifiers or previously defined process group identifiers as defined with OTF_Writer_writeDefProcess() resp. OTF_Writer_writeDefProcessGroup.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefProcessGroup(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefProcessGroupKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | procGroup,
|  | const char * | name,
|  | uint32_t | numberOfProcs,
|  | const uint32_t * | procs,
|  | OTF_KeyValueList * | list
| ) |  |

Write a process group definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefProcessGroup()

References OTF_Writer_getStream(), OTF_WStream_writeDefProcessGroupKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefProcessKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | process,
|  | const char * | name,
|  | uint32_t | parent,
|  | OTF_KeyValueList * | list
| ) |  |

Write a process definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefProcess()

References OTF_Writer_getStream(), OTF_WStream_writeDefProcessKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefProcessOrGroupAttributes | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | proc_token,
|  | uint32_t | attr_token
| ) |  |

Write a process or group attributes definition record.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  proc_token | Arbitrary but unique process or process group identifier > 0.
  attr_token | A unique token that was defined with OTF_Writer_writeDefAttributeList().

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefProcessOrGroupAttributes(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefProcessOrGroupAttributesKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | proc_token,
|  | uint32_t | attr_token,
|  | OTF_KeyValueList * | list
| ) |  |

Write a process or group attributes definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefProcessOrGroupAttributes()

References OTF_Writer_getStream(), OTF_WStream_writeDefProcessOrGroupAttributesKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefProcessSubstitutes | ( | OTF_Writer * | writer,
|  | uint32_t | streamid,
|  | uint32_t | representative,
|  | uint32_t | numberOfProcs,
|  | const uint32_t * | procs,
|  | OTF_KeyValueList * | list
| ) |  |

Writes a ProcessSubstitutes definition record.

Parameters

  userData | Pointer to user data which can be set with OTF_HandlerArray_setFirstHandlerArg().
  streamid | Identifies the stream to which this definition belongs to. stream = 0 represents a global definition.
  representative | Process ID of the process that represents several others.
  numberOfProcs | Number of entries in array.
  procs | The processes which are represented by . It may or may not include itself.
  list | Pointer to an OTF_KeyValueList() that contains individual data.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefProcessSubstitutes(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefScl | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | source,
|  | uint32_t | sourceFile,
|  | uint32_t | line
| ) |  |

Write a source code location (SCL) record.

Parameters

  writer | Initialized OTF_Writer instance.
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  source | Arbitrary but unique source code location identifier > 0.
  sourceFile | Previously defined source file identifier. See OTF_Writer_writeDefSclFile().
  line | Line number.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefScl(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefSclFile | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | sourceFile,
|  | const char * | name
| ) |  |

Write a source code location (SCL) file record.

Parameters

  writer | Initialized OTF_Writer instance.
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  sourceFile | Arbitrary but unique source code location identifier != 0.
  name | File name.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefSclFile(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefSclFileKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | sourceFile,
|  | const char * | name,
|  | OTF_KeyValueList * | list
| ) |  |

Write a source code location (SCL) file record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefSclFile()

References OTF_Writer_getStream(), OTF_WStream_writeDefSclFileKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefSclKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint32_t | source,
|  | uint32_t | sourceFile,
|  | uint32_t | line,
|  | OTF_KeyValueList * | list
| ) |  |

Write a source code location (SCL) record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeDefScl()

References OTF_Writer_getStream(), OTF_WStream_writeDefSclKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefTimeRange | ( | OTF_Writer * | writer,
|  | uint32_t | streamid,
|  | uint64_t | minTime,
|  | uint64_t | maxTime,
|  | OTF_KeyValueList * | list
| ) |  |

Writes a TimeRange definition.

Parameters

  userData | Pointer to user data which can be set with OTF_HandlerArray_setFirstHandlerArg().
  streamid | Identifies the stream to which this definition belongs to. stream = 0 represents a global definition.
  minTime | The smallest timestamp of the events in this streamid.
  maxTime | The greates timestamp of the events in this streamid (inclusive).
  list | Pointer to an OTF_KeyValueList() that contains individual data.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefTimeRange(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefTimerResolution | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint64_t | ticksPerSecond
| ) |  |

Write the timer resolution definition record.

All timed event records will be interpreted according to this definition. By default, a timer resultion of 1 us i.e. 1,000,000 clock ticks is assumed.

Parameters

  writer | Pointer to an initialized OTF_Writer object. See also OTF_Writer_open().
  stream | Target stream identifier with 0 < stream <= number of streams as defined in OTF_Writer_open().
  ticksPerSecond | Clock ticks per second of the timer.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_WStream_writeDefTimerResolution(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeDefTimerResolutionKV | ( | OTF_Writer * | writer,
|  | uint32_t | stream,
|  | uint64_t | ticksPerSecond,
|  | OTF_KeyValueList * | list
| ) |  |

Write the timer resolution definition record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeTimerResolution()

References OTF_Writer_getStream(), OTF_WStream_writeDefTimerResolutionKV(), OTF_WStream_writeOtfVersion(), and struct_OTF_Writer::versionWritten.

int OTF_Writer_writeEndCollectiveOperation | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint64_t | matchingId
| ) |  |

Write an end collective operation member record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when collective operation was entered by member.
  process | Process identifier i.e. collective member.
  matchingId | Matching identifier, must match a previous start collective operation.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEndCollectiveOperation().

int OTF_Writer_writeEndCollectiveOperationKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint64_t | matchingId,
|  | OTF_KeyValueList * | list
| ) |  |

Write an end collective operation member record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeEndCollectiveOperation()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEndCollectiveOperationKV().

int OTF_Writer_writeEndFileOperation | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | fileid,
|  | uint64_t | matchingId,
|  | uint64_t | handleId,
|  | uint32_t | operation,
|  | uint64_t | bytes,
|  | uint32_t | scltoken
| ) |  |

Write an end file operation record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | End time of file operation.
  process | Process identifier > 0.
  fileid | File identifier > 0.
  matchingId | Operation identifier, must match a previous start file operation event record.
  handleId | Unique file open identifier.
  operation | Type of file operation

See also
  OTF_Handler_FileOperation()

Parameters

  bytes | Depends on operation

See also
  OTF_Handler_FileOperation()

Parameters

  scltoken | Optional reference to source code.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEndFileOperation().

int OTF_Writer_writeEndFileOperationKV | ( | OTF_Writer * | writer,
|  | 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 including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeEndFileOperation()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEndFileOperationKV().

int OTF_Writer_writeEndProcess | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process
| ) |  |

Write a end process record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when process was referenced for the last time.
  process | Process identifier > 0.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEndProcess().

int OTF_Writer_writeEndProcessKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | OTF_KeyValueList * | list
| ) |  |

Write a end process record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeEndProcess()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEndProcessKV().

int OTF_Writer_writeEnter | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | function,
|  | uint32_t | process,
|  | uint32_t | source
| ) |  |

Write a function entry record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | The time when the function entry took place.
  function | Function to be entered as defined with OTF_Writer_defFunction.
  process | Process where action took place.
  source | Optional reference to source code.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEnter().

int OTF_Writer_writeEnterKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | function,
|  | uint32_t | process,
|  | uint32_t | source,
|  | OTF_KeyValueList * | list
| ) |  |

Write a function entry record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeEnter()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEnterKV().

int OTF_Writer_writeEnterSnapshot | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint64_t | originaltime,
|  | uint32_t | function,
|  | uint32_t | process,
|  | uint32_t | source
| ) |  |

Write an enter snapshot which provides information about a past function call.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when the snapshot was written(current time).
  originaltime | Time when the according enter record was entered. This call is still on the stack.(It has not been left yet)
  function | Function that the has been entered OTF_Writer_defFunction.
  process | Process where action took place.
  source | Optional reference to source code.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEnterSnapshot().

int OTF_Writer_writeEnterSnapshotKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint64_t | originaltime,
|  | uint32_t | function,
|  | uint32_t | process,
|  | uint32_t | source,
|  | OTF_KeyValueList * | list
| ) |  |

Write an enter snapshot including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeEnterSnapshot()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEnterSnapshotKV().

int OTF_Writer_writeEventComment | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | const char * | comment
| ) |  |

Write a comment record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Comments need a timestamp for a proper positioning in the trace.
  process | Comments also need a process identifier for a proper positioning in the trace.
  comment | Arbitrary comment string.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEventComment().

int OTF_Writer_writeEventCommentKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | const char * | comment,
|  | OTF_KeyValueList * | list
| ) |  |

Write a comment record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeEventComment()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeEventCommentKV().

int OTF_Writer_writeFileGroupOperationSummary | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Writes a file group operation summary record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when summary was computed.
  groupid | File group identifier or 0 for all files/groups.
  process | Process where file operations occured.
  nopen | Number of files opened.
  nclose | Number of files closed.
  nread | Number of read events.
  nwrite | Number of write events.
  nseek | Number of seek events.
  bytesread | Number of bytes read.
  byteswrite | Number of bytes written.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeFileGroupOperationSummary().

int OTF_Writer_writeFileGroupOperationSummaryKV | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Writes a file group operation summary record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeFileGroupOperationSummary()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeFileGroupOperationSummaryKV().

int OTF_Writer_writeFileOperation | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | fileid,
|  | uint32_t | process,
|  | uint64_t | handleid,
|  | uint32_t | operation,
|  | uint64_t | bytes,
|  | uint64_t | duration,
|  | uint32_t | source
| ) |  |

Write a file operation record.

Deprecated:
  This event record has been deprecated due to usage constraints. Please use OTF_Writer_writeBeginFileOperation() and OTF_Writer_writeEndFileOperation(), respectively.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Start time of the file operation.
  fileid | File identifier > 0.
  handleid | File open identifier.
  process | Process identifier > 0.
  operation | Type of file operation

See also
  OTF_Handler_FileOperation()

Parameters

  bytes | Depends on operation

See also
  OTF_Handler_FileOperation()

Parameters

  duration | time spent in the file operation

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeFileOperation().

int OTF_Writer_writeFileOperationKV | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Write a file operation record including an OTF_KeyValueList.

Deprecated:
  This event record has been deprecated due to usage constraints. Please use OTF_Writer_writeBeginFileOperationKV() and OTF_Writer_writeEndFileOperationKV(), respectively.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeFileOperation()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeFileOperationKV().

int OTF_Writer_writeFileOperationSummary | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Writes a file operation summary record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when summary was computed.
  fileid | File identifier or 0 for all files.
  process | Process where file operations occured.
  nopen | Number of files opened.
  nclose | Number of files closed.
  nread | Number of read events.
  nwrite | Number of write events.
  nseek | Number of seek events.
  bytesread | Number of bytes read.
  byteswrite | Number of bytes written.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeFileOperationSummary().

int OTF_Writer_writeFileOperationSummaryKV | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Writes a file operation summary record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeFileOperationSummary()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeFileOperationSummaryKV().

int OTF_Writer_writeFunctionGroupSummary | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | functiongroup,
|  | uint32_t | process,
|  | uint64_t | count,
|  | uint64_t | excltime,
|  | uint64_t | incltime
| ) |  |

Write a functiongroup summary record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when summary was computed.
  functiongroup | Function group as defined with OTF_Handler_DefFunctionGroup.
  process | Process of the given function group.
  count | Number of invocations.
  excltime | Time spent exclusively in the given function group.
  incltime | Time spent in the given function group including all sub-routine calls.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeFunctionGroupSummary().

int OTF_Writer_writeFunctionGroupSummaryKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | functiongroup,
|  | uint32_t | process,
|  | uint64_t | count,
|  | uint64_t | excltime,
|  | uint64_t | incltime,
|  | OTF_KeyValueList * | list
| ) |  |

Write a functiongroup summary record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeFunctionGroupSummary()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeFunctionGroupSummaryKV().

int OTF_Writer_writeFunctionSummary | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | function,
|  | uint32_t | process,
|  | uint64_t | count,
|  | uint64_t | excltime,
|  | uint64_t | incltime
| ) |  |

Write a function summary record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when summary was computed.
  function | Function as defined with OTF_Handler_DefFunction.
  process | Process of the given function.
  count | Number of invocations.
  excltime | Time spent exclusively in the given function.
  incltime | Time spent in the given function including all sub-routine calls.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeFunctionSummary().

int OTF_Writer_writeFunctionSummaryKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | function,
|  | uint32_t | process,
|  | uint64_t | count,
|  | uint64_t | excltime,
|  | uint64_t | incltime,
|  | OTF_KeyValueList * | list
| ) |  |

Write a function summary record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeFunctionSummary()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeFunctionSummaryKV().

int OTF_Writer_writeLeave | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | function,
|  | uint32_t | process,
|  | uint32_t | source
| ) |  |

Write a function leave record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | The time when the function leave took place.
  function | Function which was left or 0 if stack integrety checking is not needed.
  process | Process where action took place.
  source | Explicit source code location or 0.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeLeave().

int OTF_Writer_writeLeaveKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | function,
|  | uint32_t | process,
|  | uint32_t | source,
|  | OTF_KeyValueList * | list
| ) |  |

Write a function leave record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeLeave()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeLeaveKV().

int OTF_Writer_writeMarker | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | token,
|  | const char * | text
| ) |  |

Writes a marker record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time stamp of the marker record. Note that marker records are not sorted according to time stamps!
  process | The process or process group of the marker.
  token | A marker token defined by 'DefMarker' before.
  text | Descriptive text. *

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), and OTF_WStream_writeMarker().

int OTF_Writer_writeMarkerKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | token,
|  | const char * | text,
|  | OTF_KeyValueList * | list
| ) |  |

Writes a marker record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeMarker()

References OTF_Writer_getStream(), and OTF_WStream_writeMarkerKV().

int OTF_Writer_writeMessageSummary | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | peer,
|  | uint32_t | comm,
|  | uint32_t | tag,
|  | uint64_t | number_sent,
|  | uint64_t | number_recved,
|  | uint64_t | bytes_sent,
|  | uint64_t | bytes_recved
| ) |  |

Write a message summary record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when summary was computed.
  process | Process where messages originated.
  peer | Process where the message is sent to
  comm | Communicator of message summary
  tag | Message type/tag.
  number_sent | The number of messages sent.
  number_recved | The number of messages received.
  bytes_sent | The number of bytes sent via messages of the given type.
  bytes_recved | The number of bytes received through messages of the given type.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeMessageSummary().

int OTF_Writer_writeMessageSummaryKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | peer,
|  | uint32_t | comm,
|  | uint32_t | tag,
|  | uint64_t | number_sent,
|  | uint64_t | number_recved,
|  | uint64_t | bytes_sent,
|  | uint64_t | bytes_recved,
|  | OTF_KeyValueList * | list
| ) |  |

Write a message summary record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeMessageSummary()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeMessageSummaryKV().

int OTF_Writer_writeNoOpKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | OTF_KeyValueList * | list
| ) |  |

Write a no-operation record.

This can be used to write an OTF_KeyValueList that is not attached to a special event record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | The time when the NoOp event took place.
  process | Process where action took place.
  list | Initialized OTF_KeyValueList() instance or NULL.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeNoOpKV().

int OTF_Writer_writeOpenFileSnapshot | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint64_t | originaltime,
|  | uint32_t | fileid,
|  | uint32_t | process,
|  | uint64_t | handleid,
|  | uint32_t | source
| ) |  |

Write a snapshot record for an open (and not yet closed) file.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when the snapshot was written(current time).
  originaltime | Time when the message was sent.
  fileid | File identifier.
  process | Process where the file was opened.
  handleid | Unique file open identifier.

See also
  OTF_Handler_FileOperation()

Parameters

  source | Optional reference to source code.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeOpenFileSnapshot().

int OTF_Writer_writeOpenFileSnapshotKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint64_t | originaltime,
|  | uint32_t | fileid,
|  | uint32_t | process,
|  | uint64_t | handleid,
|  | uint32_t | source,
|  | OTF_KeyValueList * | list
| ) |  |

Write a snapshot record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeOpenFileSnapshot()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeOpenFileSnapshotKV().

int OTF_Writer_writeOtfVersion | ( | OTF_Writer * | writer,
|  | uint32_t | stream
| ) |  |

depricated.

The Otf-Version-record is generated automatically at beginning of tracing in the global definiton stream.

int OTF_Writer_writeRecvMsg | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | receiver,
|  | uint32_t | sender,
|  | uint32_t | procGroup,
|  | uint32_t | tag,
|  | uint32_t | length,
|  | uint32_t | source
| ) |  |

Write a message retrieval record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | The time when the message was received.
  receiver | Identifier of receiving process.
  sender | Identifier of sending process.
  procGroup | Optional process-group sender and receiver belong to, '0' for no group.
  tag | Optional message type information.
  length | Optional message length information.
  source | Optional reference to source code.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeRecvMsg().

int OTF_Writer_writeRecvMsgKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | receiver,
|  | uint32_t | sender,
|  | uint32_t | procGroup,
|  | uint32_t | tag,
|  | uint32_t | length,
|  | uint32_t | source,
|  | OTF_KeyValueList * | list
| ) |  |

Write a message retrieval record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeRecvMsg()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeRecvMsgKV().

int OTF_Writer_writeRMAEnd | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | remote,
|  | uint32_t | communicator,
|  | uint32_t | tag,
|  | uint32_t | scltoken
| ) |  |

Write a RMA end record.

The end record marks the finalization of all put and get operations with the same communicator/tag pair that occured so far for this <process>.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when process was referenced for the last time.
  process | Process identifier > 0.
  remote | If >0, ends RMA transfers on Process <remote>, instead of this <process>. [remote!=0 is really weird crap and would never be used by sane programmers ;-) – nevertheless, the IBM Cell could be programmed like this.]
  communicator | Together with tag, it is used to identify the related RMA put/get records.
  tag | Together with communicator, it is used to identify the related RMA put/get records.
  source | Explicit source code location or 0.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeRMAEnd().

int OTF_Writer_writeRMAEndKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | remote,
|  | uint32_t | communicator,
|  | uint32_t | tag,
|  | uint32_t | scltoken,
|  | OTF_KeyValueList * | list
| ) |  |

Write a RMA end record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeRMAEnd()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeRMAEndKV().

int OTF_Writer_writeRMAGet | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | origin,
|  | uint32_t | target,
|  | uint32_t | communicator,
|  | uint32_t | tag,
|  | uint64_t | bytes,
|  | uint32_t | scltoken
| ) |  |

Write a RMA get record.

The end of this transfer is marked by the NEXT end record on this <process> with the same communicator/tag pair.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when process was referenced for the last time.
  process | Process initiating the transfer.
  origin | If >0, Process where data will be transferred to (instead of this <process>).
  target | Process whose memory will be read.
  communicator | Together with tag, it is used to identify the corresponding RMA end record.
  tag | Together with communicator, it is used to identify the corresponding RMA end record.
  bytes | How many bytes have been transfered by this call.
  source | Explicit source code location or 0.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeRMAGet().

int OTF_Writer_writeRMAGetKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | origin,
|  | uint32_t | target,
|  | uint32_t | communicator,
|  | uint32_t | tag,
|  | uint64_t | bytes,
|  | uint32_t | scltoken,
|  | OTF_KeyValueList * | list
| ) |  |

Write a RMA get record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeRMAGet()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeRMAGetKV().

int OTF_Writer_writeRMAPut | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | origin,
|  | uint32_t | target,
|  | uint32_t | communicator,
|  | uint32_t | tag,
|  | uint64_t | bytes,
|  | uint32_t | scltoken
| ) |  |

Write a RMA put record - local end record.

The end of this transfer is marked by the NEXT end record on this <process> with the same communicator/tag pair.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when process was referenced for the last time.
  process | Process initiating the transfer.
  origin | If >0, Process whose memory will be transferred, instead of this <process>.
  target | Process whose memory will be written.
  communicator | Together with tag, it is used to identify the corresponding RMA end record.
  tag | Together with communicator, it is used to identify the corresponding RMA end record.
  bytes | How many bytes have been transfered by this call.
  source | Explicit source code location or 0.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeRMAPut().

int OTF_Writer_writeRMAPutKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | origin,
|  | uint32_t | target,
|  | uint32_t | communicator,
|  | uint32_t | tag,
|  | uint64_t | bytes,
|  | uint32_t | scltoken,
|  | OTF_KeyValueList * | list
| ) |  |

Write a RMA put record - local end record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeRMAPut()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeRMAPutKV().

int OTF_Writer_writeRMAPutRemoteEnd | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | origin,
|  | uint32_t | target,
|  | uint32_t | communicator,
|  | uint32_t | tag,
|  | uint64_t | bytes,
|  | uint32_t | scltoken
| ) |  |

Write a RMA put record - remote end record.

The end of this transfer is marked by the NEXT end record on process <target> with the same communicator/tag pair.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when process was referenced for the last time.
  process | Process initiating the transfer.
  origin | If >0, Process whose memory will be transferred, instead of this <process>.
  target | Process whose memory will be written and where the end record is located.
  communicator | Together with tag, it is used to identify the corresponding RMA end record.
  tag | Together with communicator, it is used to identify the corresponding RMA end record.
  bytes | How many bytes have been transfered by this call.
  source | Explicit source code location or 0.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeRMAPutRemoteEnd().

int OTF_Writer_writeRMAPutRemoteEndKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | uint32_t | origin,
|  | uint32_t | target,
|  | uint32_t | communicator,
|  | uint32_t | tag,
|  | uint64_t | bytes,
|  | uint32_t | scltoken,
|  | OTF_KeyValueList * | list
| ) |  |

Write a RMA put record - remote end record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeRMAPutRemoteEnd()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeRMAPutRemoteEndKV().

int OTF_Writer_writeSendMsg | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | sender,
|  | uint32_t | receiver,
|  | uint32_t | procGroup,
|  | uint32_t | tag,
|  | uint32_t | length,
|  | uint32_t | source
| ) |  |

Write a message send record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | The time when the message was send.
  sender | Sender of the message.
  receiver | Receiver of the message.
  procGroup | Optional process-group sender and receiver belong to, '0' for no group.
  tag | Optional message type information.
  length | Optional message length information.
  source | Optional reference to source code.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeSendMsg().

int OTF_Writer_writeSendMsgKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | sender,
|  | uint32_t | receiver,
|  | uint32_t | procGroup,
|  | uint32_t | tag,
|  | uint32_t | length,
|  | uint32_t | source,
|  | OTF_KeyValueList * | list
| ) |  |

Write a message send record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeSendMsg()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeSendMsgKV().

int OTF_Writer_writeSendSnapshot | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint64_t | originaltime,
|  | uint32_t | sender,
|  | uint32_t | receiver,
|  | uint32_t | procGroup,
|  | uint32_t | tag,
|  | uint32_t | length,
|  | uint32_t | source
| ) |  |

Write a send snapshot which provides information about a past message send operation that is still pending, i.e.

not yet received

Parameters

  writer | Initialized OTF_Writer instance.
  time | Time when the snapshot was written(current time).
  originaltime | Time when the message was sent
  sender | Sender of the message.
  receiver | Receiver of the message.
  procGroup | Optional process-group sender and receiver belong to, '0' for no group.
  tag | Optional message type information.
  length | Optional message length information.
  source | Optional reference to source code.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeSendSnapshot().

int OTF_Writer_writeSendSnapshotKV | ( | OTF_Writer * | writer,
|  | 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
| ) |  |

Write a send snapshot including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeSendSnapshot()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeSendSnapshotKV().

int OTF_Writer_writeSnapshotComment | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | const char * | comment
| ) |  |

Write a snapshot comment record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Comments need a timestamp for a proper positioning in the trace.
  process | Comments also need a process identifier for a proper positioning in the trace.
  comment | Arbitrary comment string.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeSnapshotComment().

int OTF_Writer_writeSnapshotCommentKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | const char * | comment,
|  | OTF_KeyValueList * | list
| ) |  |

Write a snapshot comment record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeSnapshotComment()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeSnapshotCommentKV().

int OTF_Writer_writeSummaryComment | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | const char * | comment
| ) |  |

Write a summary comment record.

Parameters

  writer | Initialized OTF_Writer instance.
  time | Comments need a timestamp for a proper positioning in the trace.
  process | Comments also need a process identifier for a proper positioning in the trace.
  comment | Arbitrary comment string.

Returns
  1 on success, 0 if an error occurs.

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeSummaryComment().

int OTF_Writer_writeSummaryCommentKV | ( | OTF_Writer * | writer,
|  | uint64_t | time,
|  | uint32_t | process,
|  | const char * | comment,
|  | OTF_KeyValueList * | list
| ) |  |

Write a summary comment record including an OTF_KeyValueList.

Parameters

  list | Initialized OTF_KeyValueList() instance or NULL.

See also
  OTF_Writer_writeSummaryComment()

References OTF_Writer_getStream(), OTF_Writer_mapProcess(), and OTF_WStream_writeSummaryCommentKV().