OTF2_MarkerWriter.h File Reference

This file provides all routines that write marker records. More...

#include <stdint.h>
#include <otf2/OTF2_ErrorCodes.h>
#include <otf2/OTF2_Definitions.h>
#include <otf2/OTF2_Marker.h>

Go to the source code of this file.

Typedefs
typedef struct OTF2_MarkerWriter_struct	OTF2_MarkerWriter
	Handle definition for the external marker writer.

Functions
OTF2_ErrorCode	OTF2_MarkerWriter_WriteDefMarker (OTF2_MarkerWriter *writerHandle, OTF2_MarkerRef self, const char *markerGroup, const char *markerCategory, OTF2_MarkerSeverity severity)
	Write a marker definition. More...
OTF2_ErrorCode	OTF2_MarkerWriter_WriteMarker (OTF2_MarkerWriter *writerHandle, OTF2_TimeStamp timestamp, OTF2_TimeStamp duration, OTF2_MarkerRef marker, OTF2_MarkerScope scope, uint64_t scopeRef, const char *text)
	Write a marker record. More...

Detailed Description

This file provides all routines that write marker records.

Function Documentation

OTF2_ErrorCode OTF2_MarkerWriter_WriteDefMarker	(	OTF2_MarkerWriter *	writerHandle,
		OTF2_MarkerRef	self,
		const char *	markerGroup,
		const char *	markerCategory,
		OTF2_MarkerSeverity	severity
	)

Write a marker definition.

Parameters

writerHandle	Marker writer handle.
self	Reference to this marker definition.
markerGroup	Group name, e.g., "MUST", ...
markerCategory	Marker category, e.g., "Argument type error", ... The tuple (markerGroup, markerCategory) must be unique over all marker definitions.
severity	The severity for this marker category.

Since

Version 1.2

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_MarkerWriter_WriteMarker	(	OTF2_MarkerWriter *	writerHandle,
		OTF2_TimeStamp	timestamp,
		OTF2_TimeStamp	duration,
		OTF2_MarkerRef	marker,
		OTF2_MarkerScope	scope,
		uint64_t	scopeRef,
		const char *	text
	)

Write a marker record.

Parameters

writerHandle	Marker writer handle.
timestamp	Time of the marker.
duration	A possible duration of this marker. May be 0.
marker	Reference to a marker definition.
scope	The type of scope of this marker instance: OTF2_MARKER_SCOPE_GLOBAL, OTF2_MARKER_SCOPE_LOCATION, OTF2_MARKER_SCOPE_LOCATION_GROUP, OTF2_MARKER_SCOPE_SYSTEM_TREE_NODE, OTF2_MARKER_SCOPE_GROUP, or OTF2_MARKER_SCOPE_COMM.
scopeRef	The reference to an element of the scope of this marker. Depends on scope.
text	A textual description for this marker.

Since

Version 1.2

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.