2.2 (revision 4737)
OTF2_EvtWriter.h
Go to the documentation of this file.
1 /*
2  * This file is part of the Score-P software (http://www.score-p.org)
3  *
4  * Copyright (c) 2009-2013,
5  * RWTH Aachen University, Germany
6  *
7  * Copyright (c) 2009-2013,
8  * Gesellschaft fuer numerische Simulation mbH Braunschweig, Germany
9  *
10  * Copyright (c) 2009-2013,
11  * Technische Universitaet Dresden, Germany
12  *
13  * Copyright (c) 2009-2013,
14  * University of Oregon, Eugene, USA
15  *
16  * Copyright (c) 2009-2013,
17  * Forschungszentrum Juelich GmbH, Germany
18  *
19  * Copyright (c) 2009-2013,
20  * German Research School for Simulation Sciences GmbH, Juelich/Aachen, Germany
21  *
22  * Copyright (c) 2009-2013,
23  * Technische Universitaet Muenchen, Germany
24  *
25  * This software may be modified and distributed under the terms of
26  * a BSD-style license. See the COPYING file in the package base
27  * directory for details.
28  *
29  */
30 
31 
32 #ifndef OTF2_EVT_WRITER_H
33 #define OTF2_EVT_WRITER_H
34 
35 
46 #include <stdint.h>
47 
48 
49 #include <otf2/OTF2_ErrorCodes.h>
50 
51 
52 #include <otf2/OTF2_Events.h>
54 
55 
56 #ifdef __cplusplus
57 extern "C" {
58 #endif /* __cplusplus */
59 
60 
63 typedef struct OTF2_EvtWriter_struct OTF2_EvtWriter;
64 
65 
76  OTF2_LocationRef* locationID );
77 
78 
90  void* userData );
91 
92 
103  void** userData );
104 
105 
118  OTF2_LocationRef location );
119 
120 
134  uint64_t* numberOfEvents );
135 
136 
153  OTF2_AttributeList* attributeList,
154  OTF2_TimeStamp time,
155  OTF2_TimeStamp stopTime );
156 
157 
176  OTF2_AttributeList* attributeList,
177  OTF2_TimeStamp time,
178  OTF2_MeasurementMode measurementMode );
179 
180 
199  OTF2_AttributeList* attributeList,
200  OTF2_TimeStamp time,
201  OTF2_RegionRef region );
202 
203 
222  OTF2_AttributeList* attributeList,
223  OTF2_TimeStamp time,
224  OTF2_RegionRef region );
225 
226 
251  OTF2_AttributeList* attributeList,
252  OTF2_TimeStamp time,
253  uint32_t receiver,
254  OTF2_CommRef communicator,
255  uint32_t msgTag,
256  uint64_t msgLength );
257 
258 
284  OTF2_AttributeList* attributeList,
285  OTF2_TimeStamp time,
286  uint32_t receiver,
287  OTF2_CommRef communicator,
288  uint32_t msgTag,
289  uint64_t msgLength,
290  uint64_t requestID );
291 
292 
308  OTF2_AttributeList* attributeList,
309  OTF2_TimeStamp time,
310  uint64_t requestID );
311 
312 
328  OTF2_AttributeList* attributeList,
329  OTF2_TimeStamp time,
330  uint64_t requestID );
331 
332 
357  OTF2_AttributeList* attributeList,
358  OTF2_TimeStamp time,
359  uint32_t sender,
360  OTF2_CommRef communicator,
361  uint32_t msgTag,
362  uint64_t msgLength );
363 
364 
390  OTF2_AttributeList* attributeList,
391  OTF2_TimeStamp time,
392  uint32_t sender,
393  OTF2_CommRef communicator,
394  uint32_t msgTag,
395  uint64_t msgLength,
396  uint64_t requestID );
397 
398 
415  OTF2_AttributeList* attributeList,
416  OTF2_TimeStamp time,
417  uint64_t requestID );
418 
419 
435  OTF2_AttributeList* attributeList,
436  OTF2_TimeStamp time,
437  uint64_t requestID );
438 
439 
455  OTF2_AttributeList* attributeList,
456  OTF2_TimeStamp time );
457 
458 
486  OTF2_AttributeList* attributeList,
487  OTF2_TimeStamp time,
488  OTF2_CollectiveOp collectiveOp,
489  OTF2_CommRef communicator,
490  uint32_t root,
491  uint64_t sizeSent,
492  uint64_t sizeReceived );
493 
494 
516  OTF2_AttributeList* attributeList,
517  OTF2_TimeStamp time,
518  uint32_t numberOfRequestedThreads );
519 
520 
542  OTF2_AttributeList* attributeList,
543  OTF2_TimeStamp time );
544 
545 
572  OTF2_AttributeList* attributeList,
573  OTF2_TimeStamp time,
574  uint32_t lockID,
575  uint32_t acquisitionOrder );
576 
577 
604  OTF2_AttributeList* attributeList,
605  OTF2_TimeStamp time,
606  uint32_t lockID,
607  uint32_t acquisitionOrder );
608 
609 
632  OTF2_AttributeList* attributeList,
633  OTF2_TimeStamp time,
634  uint64_t taskID );
635 
636 
661  OTF2_AttributeList* attributeList,
662  OTF2_TimeStamp time,
663  uint64_t taskID );
664 
665 
688  OTF2_AttributeList* attributeList,
689  OTF2_TimeStamp time,
690  uint64_t taskID );
691 
692 
720  OTF2_AttributeList* attributeList,
721  OTF2_TimeStamp time,
722  OTF2_MetricRef metric,
723  uint8_t numberOfMetrics,
724  const OTF2_Type* typeIDs,
725  const OTF2_MetricValue* metricValues );
726 
727 
751  OTF2_AttributeList* attributeList,
752  OTF2_TimeStamp time,
753  OTF2_ParameterRef parameter,
754  OTF2_StringRef string );
755 
756 
777  OTF2_AttributeList* attributeList,
778  OTF2_TimeStamp time,
779  OTF2_ParameterRef parameter,
780  int64_t value );
781 
782 
803  OTF2_AttributeList* attributeList,
804  OTF2_TimeStamp time,
805  OTF2_ParameterRef parameter,
806  uint64_t value );
807 
808 
827  OTF2_AttributeList* attributeList,
828  OTF2_TimeStamp time,
829  OTF2_RmaWinRef win );
830 
831 
850  OTF2_AttributeList* attributeList,
851  OTF2_TimeStamp time,
852  OTF2_RmaWinRef win );
853 
854 
870  OTF2_AttributeList* attributeList,
871  OTF2_TimeStamp time );
872 
873 
900  OTF2_AttributeList* attributeList,
901  OTF2_TimeStamp time,
902  OTF2_CollectiveOp collectiveOp,
903  OTF2_RmaSyncLevel syncLevel,
904  OTF2_RmaWinRef win,
905  uint32_t root,
906  uint64_t bytesSent,
907  uint64_t bytesReceived );
908 
909 
934  OTF2_AttributeList* attributeList,
935  OTF2_TimeStamp time,
936  OTF2_RmaSyncLevel syncLevel,
937  OTF2_RmaWinRef win,
938  OTF2_GroupRef group );
939 
940 
968  OTF2_AttributeList* attributeList,
969  OTF2_TimeStamp time,
970  OTF2_RmaWinRef win,
971  uint32_t remote,
972  uint64_t lockId,
973  OTF2_LockType lockType );
974 
975 
1001  OTF2_AttributeList* attributeList,
1002  OTF2_TimeStamp time,
1003  OTF2_RmaWinRef win,
1004  uint32_t remote,
1005  uint64_t lockId,
1006  OTF2_LockType lockType );
1007 
1008 
1034  OTF2_AttributeList* attributeList,
1035  OTF2_TimeStamp time,
1036  OTF2_RmaWinRef win,
1037  uint32_t remote,
1038  uint64_t lockId,
1039  OTF2_LockType lockType );
1040 
1041 
1065  OTF2_AttributeList* attributeList,
1066  OTF2_TimeStamp time,
1067  OTF2_RmaWinRef win,
1068  uint32_t remote,
1069  uint64_t lockId );
1070 
1071 
1093  OTF2_AttributeList* attributeList,
1094  OTF2_TimeStamp time,
1095  OTF2_RmaWinRef win,
1096  uint32_t remote,
1097  OTF2_RmaSyncType syncType );
1098 
1099 
1119  OTF2_AttributeList* attributeList,
1120  OTF2_TimeStamp time,
1121  OTF2_RmaWinRef win );
1122 
1123 
1146  OTF2_AttributeList* attributeList,
1147  OTF2_TimeStamp time,
1148  OTF2_RmaWinRef win,
1149  uint32_t remote,
1150  uint64_t bytes,
1151  uint64_t matchingId );
1152 
1153 
1176  OTF2_AttributeList* attributeList,
1177  OTF2_TimeStamp time,
1178  OTF2_RmaWinRef win,
1179  uint32_t remote,
1180  uint64_t bytes,
1181  uint64_t matchingId );
1182 
1183 
1208  OTF2_AttributeList* attributeList,
1209  OTF2_TimeStamp time,
1210  OTF2_RmaWinRef win,
1211  uint32_t remote,
1212  OTF2_RmaAtomicType type,
1213  uint64_t bytesSent,
1214  uint64_t bytesReceived,
1215  uint64_t matchingId );
1216 
1217 
1239  OTF2_AttributeList* attributeList,
1240  OTF2_TimeStamp time,
1241  OTF2_RmaWinRef win,
1242  uint64_t matchingId );
1243 
1244 
1266  OTF2_AttributeList* attributeList,
1267  OTF2_TimeStamp time,
1268  OTF2_RmaWinRef win,
1269  uint64_t matchingId );
1270 
1271 
1293  OTF2_AttributeList* attributeList,
1294  OTF2_TimeStamp time,
1295  OTF2_RmaWinRef win,
1296  uint64_t matchingId );
1297 
1298 
1320  OTF2_AttributeList* attributeList,
1321  OTF2_TimeStamp time,
1322  OTF2_RmaWinRef win,
1323  uint64_t matchingId );
1324 
1325 
1342  OTF2_AttributeList* attributeList,
1343  OTF2_TimeStamp time,
1344  OTF2_Paradigm model,
1345  uint32_t numberOfRequestedThreads );
1346 
1347 
1364  OTF2_AttributeList* attributeList,
1365  OTF2_TimeStamp time,
1366  OTF2_Paradigm model );
1367 
1368 
1386  OTF2_AttributeList* attributeList,
1387  OTF2_TimeStamp time,
1388  OTF2_CommRef threadTeam );
1389 
1390 
1408  OTF2_AttributeList* attributeList,
1409  OTF2_TimeStamp time,
1410  OTF2_CommRef threadTeam );
1411 
1412 
1434  OTF2_AttributeList* attributeList,
1435  OTF2_TimeStamp time,
1436  OTF2_Paradigm model,
1437  uint32_t lockID,
1438  uint32_t acquisitionOrder );
1439 
1440 
1462  OTF2_AttributeList* attributeList,
1463  OTF2_TimeStamp time,
1464  OTF2_Paradigm model,
1465  uint32_t lockID,
1466  uint32_t acquisitionOrder );
1467 
1468 
1491  OTF2_AttributeList* attributeList,
1492  OTF2_TimeStamp time,
1493  OTF2_CommRef threadTeam,
1494  uint32_t creatingThread,
1495  uint32_t generationNumber );
1496 
1497 
1522  OTF2_AttributeList* attributeList,
1523  OTF2_TimeStamp time,
1524  OTF2_CommRef threadTeam,
1525  uint32_t creatingThread,
1526  uint32_t generationNumber );
1527 
1528 
1551  OTF2_AttributeList* attributeList,
1552  OTF2_TimeStamp time,
1553  OTF2_CommRef threadTeam,
1554  uint32_t creatingThread,
1555  uint32_t generationNumber );
1556 
1557 
1579  OTF2_AttributeList* attributeList,
1580  OTF2_TimeStamp time,
1581  OTF2_CommRef threadContingent,
1582  uint64_t sequenceCount );
1583 
1584 
1606  OTF2_AttributeList* attributeList,
1607  OTF2_TimeStamp time,
1608  OTF2_CommRef threadContingent,
1609  uint64_t sequenceCount );
1610 
1611 
1633  OTF2_AttributeList* attributeList,
1634  OTF2_TimeStamp time,
1635  OTF2_CommRef threadContingent,
1636  uint64_t sequenceCount );
1637 
1638 
1662  OTF2_AttributeList* attributeList,
1663  OTF2_TimeStamp time,
1664  OTF2_CommRef threadContingent,
1665  uint64_t sequenceCount );
1666 
1667 
1702  OTF2_AttributeList* attributeList,
1703  OTF2_TimeStamp time,
1704  OTF2_CallingContextRef callingContext,
1705  uint32_t unwindDistance );
1706 
1707 
1747  OTF2_AttributeList* attributeList,
1748  OTF2_TimeStamp time,
1749  OTF2_CallingContextRef callingContext );
1750 
1751 
1784  OTF2_AttributeList* attributeList,
1785  OTF2_TimeStamp time,
1786  OTF2_CallingContextRef callingContext,
1787  uint32_t unwindDistance,
1788  OTF2_InterruptGeneratorRef interruptGenerator );
1789 
1790 
1828  OTF2_AttributeList* attributeList,
1829  OTF2_TimeStamp time,
1830  OTF2_IoHandleRef handle,
1831  OTF2_IoAccessMode mode,
1832  OTF2_IoCreationFlag creationFlags,
1833  OTF2_IoStatusFlag statusFlags );
1834 
1835 
1865  OTF2_AttributeList* attributeList,
1866  OTF2_TimeStamp time,
1867  OTF2_IoHandleRef handle );
1868 
1869 
1904  OTF2_AttributeList* attributeList,
1905  OTF2_TimeStamp time,
1906  OTF2_IoHandleRef oldHandle,
1907  OTF2_IoHandleRef newHandle,
1908  OTF2_IoStatusFlag statusFlags );
1909 
1910 
1935  OTF2_AttributeList* attributeList,
1936  OTF2_TimeStamp time,
1937  OTF2_IoHandleRef handle,
1938  int64_t offsetRequest,
1939  OTF2_IoSeekOption whence,
1940  uint64_t offsetResult );
1941 
1942 
1963  OTF2_AttributeList* attributeList,
1964  OTF2_TimeStamp time,
1965  OTF2_IoHandleRef handle,
1966  OTF2_IoStatusFlag statusFlags );
1967 
1968 
1989  OTF2_AttributeList* attributeList,
1990  OTF2_TimeStamp time,
1991  OTF2_IoParadigmRef ioParadigm,
1992  OTF2_IoFileRef file );
1993 
1994 
2022  OTF2_AttributeList* attributeList,
2023  OTF2_TimeStamp time,
2024  OTF2_IoHandleRef handle,
2025  OTF2_IoOperationMode mode,
2026  OTF2_IoOperationFlag operationFlags,
2027  uint64_t bytesRequest,
2028  uint64_t matchingId );
2029 
2030 
2055  OTF2_AttributeList* attributeList,
2056  OTF2_TimeStamp time,
2057  OTF2_IoHandleRef handle,
2058  uint64_t matchingId );
2059 
2060 
2086  OTF2_AttributeList* attributeList,
2087  OTF2_TimeStamp time,
2088  OTF2_IoHandleRef handle,
2089  uint64_t matchingId );
2090 
2091 
2117  OTF2_AttributeList* attributeList,
2118  OTF2_TimeStamp time,
2119  OTF2_IoHandleRef handle,
2120  uint64_t bytesResult,
2121  uint64_t matchingId );
2122 
2123 
2149  OTF2_AttributeList* attributeList,
2150  OTF2_TimeStamp time,
2151  OTF2_IoHandleRef handle,
2152  uint64_t matchingId );
2153 
2154 
2174  OTF2_AttributeList* attributeList,
2175  OTF2_TimeStamp time,
2176  OTF2_IoHandleRef handle,
2177  OTF2_LockType lockType );
2178 
2179 
2199  OTF2_AttributeList* attributeList,
2200  OTF2_TimeStamp time,
2201  OTF2_IoHandleRef handle,
2202  OTF2_LockType lockType );
2203 
2204 
2225  OTF2_AttributeList* attributeList,
2226  OTF2_TimeStamp time,
2227  OTF2_IoHandleRef handle,
2228  OTF2_LockType lockType );
2229 
2230 
2262  OTF2_AttributeList* attributeList,
2263  OTF2_TimeStamp time,
2264  OTF2_StringRef programName,
2265  uint32_t numberOfArguments,
2266  const OTF2_StringRef* programArguments );
2267 
2268 
2299  OTF2_AttributeList* attributeList,
2300  OTF2_TimeStamp time,
2301  int64_t exitStatus );
2302 
2303 
2315  uint32_t rewindId );
2316 
2317 
2329  uint32_t rewindId );
2330 
2331 
2343  uint32_t rewindId );
2344 
2345 
2346 #ifdef __cplusplus
2347 }
2348 #endif /* __cplusplus */
2349 
2350 
2351 #endif /* !OTF2_EVT_WRITER_H */
uint8_t OTF2_RmaSyncType
Wrapper for enum OTF2_RmaSyncType_enum.
Definition: OTF2_Events.h:164
OTF2_ErrorCode OTF2_EvtWriter_RmaOpTest(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
Records a RmaOpTest event.
uint8_t OTF2_IoSeekOption
Wrapper for enum OTF2_IoSeekOption_enum.
Definition: OTF2_Events.h:361
OTF2_ErrorCode OTF2_EvtWriter_ThreadCreate(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
Records a ThreadCreate event.
OTF2_ErrorCode OTF2_EvtWriter_StoreRewindPoint(OTF2_EvtWriter *writer, uint32_t rewindId)
Please give me a documentation.
OTF2_ErrorCode OTF2_EvtWriter_GetNumberOfEvents(OTF2_EvtWriter *writer, uint64_t *numberOfEvents)
Get the number of events.
uint64_t OTF2_LocationRef
Type used to indicate a reference to a Location definition.
Definition: OTF2_GeneralDefinitions.h:139
OTF2_ErrorCode OTF2_EvtWriter_RmaGet(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)
Records a RmaGet event.
OTF2_ErrorCode OTF2_EvtWriter_SetLocationID(OTF2_EvtWriter *writer, OTF2_LocationRef location)
The location ID is not always known on measurement start, and only needed on the first buffer flush t...
uint8_t OTF2_Type
Wrapper for enum OTF2_Type_enum.
Definition: OTF2_GeneralDefinitions.h:561
OTF2_ErrorCode OTF2_EvtWriter_ThreadTaskSwitch(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
Records a ThreadTaskSwitch event.
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteRemote(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
Records a RmaOpCompleteRemote event.
OTF2_ErrorCode OTF2_EvtWriter_IoReleaseLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle, OTF2_LockType lockType)
Records a IoReleaseLock event.
uint8_t OTF2_Paradigm
Wrapper for enum OTF2_Paradigm_enum.
Definition: OTF2_GeneralDefinitions.h:711
OTF2_ErrorCode OTF2_EvtWriter_RmaCollectiveEnd(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CollectiveOp collectiveOp, OTF2_RmaSyncLevel syncLevel, OTF2_RmaWinRef win, uint32_t root, uint64_t bytesSent, uint64_t bytesReceived)
Records a RmaCollectiveEnd event.
uint32_t OTF2_StringRef
Type used to indicate a reference to a String definition.
Definition: OTF2_GeneralDefinitions.h:115
uint8_t OTF2_IoParadigmRef
Type used to indicate a reference to a IoParadigm definition.
Definition: OTF2_GeneralDefinitions.h:109
OTF2_ErrorCode OTF2_EvtWriter_RmaTryLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
Records a RmaTryLock event.
OTF2_ErrorCode OTF2_EvtWriter_MpiIrecvRequest(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
Records a MpiIrecvRequest event.
OTF2_ErrorCode OTF2_EvtWriter_RmaAtomic(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaAtomicType type, uint64_t bytesSent, uint64_t bytesReceived, uint64_t matchingId)
Records a RmaAtomic event.
OTF2_ErrorCode OTF2_EvtWriter_IoSeek(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle, int64_t offsetRequest, OTF2_IoSeekOption whence, uint64_t offsetResult)
Records a IoSeek event.
Enums and types used in event records.
uint8_t OTF2_MeasurementMode
Wrapper for enum OTF2_MeasurementMode_enum.
Definition: OTF2_Events.h:56
Metric value.
Definition: OTF2_Events.h:453
uint32_t OTF2_ParameterRef
Type used to indicate a reference to a Parameter definition.
Definition: OTF2_GeneralDefinitions.h:187
This layer enables dynamic appending of arbitrary attributes to any type of event record...
OTF2_ErrorCode OTF2_EvtWriter_IoCreateHandle(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle, OTF2_IoAccessMode mode, OTF2_IoCreationFlag creationFlags, OTF2_IoStatusFlag statusFlags)
Records a IoCreateHandle event.
uint8_t OTF2_RmaAtomicType
Wrapper for enum OTF2_RmaAtomicType_enum.
Definition: OTF2_Events.h:229
uint32_t OTF2_RmaSyncLevel
Wrapper for enum OTF2_RmaSyncLevel_enum.
Definition: OTF2_Events.h:186
OTF2_ErrorCode OTF2_EvtWriter_ParameterString(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_ParameterRef parameter, OTF2_StringRef string)
Records a ParameterString event.
OTF2_ErrorCode OTF2_EvtWriter_MpiCollectiveBegin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time)
Records a MpiCollectiveBegin event.
struct OTF2_AttributeList_struct OTF2_AttributeList
Attribute list handle.
Definition: OTF2_AttributeList.h:104
uint32_t OTF2_IoStatusFlag
Wrapper for enum OTF2_IoStatusFlag_enum.
Definition: OTF2_Definitions.h:829
OTF2_ErrorCode
Definition: OTF2_ErrorCodes.h:54
OTF2_ErrorCode OTF2_EvtWriter_ThreadTaskComplete(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
Records a ThreadTaskComplete event.
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskComplete(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t taskID)
Records a OmpTaskComplete event.
uint32_t OTF2_IoOperationFlag
Wrapper for enum OTF2_IoOperationFlag_enum.
Definition: OTF2_Events.h:429
OTF2_ErrorCode OTF2_EvtWriter_RmaGroupSync(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaSyncLevel syncLevel, OTF2_RmaWinRef win, OTF2_GroupRef group)
Records a RmaGroupSync event.
OTF2_ErrorCode OTF2_EvtWriter_GetLocationID(const OTF2_EvtWriter *writer, OTF2_LocationRef *locationID)
Function to get the location ID of a writer object.
OTF2_ErrorCode OTF2_EvtWriter_OmpReleaseLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t lockID, uint32_t acquisitionOrder)
Records a OmpReleaseLock event.
uint32_t OTF2_InterruptGeneratorRef
Type used to indicate a reference to a InterruptGenerator definition.
Definition: OTF2_GeneralDefinitions.h:223
uint8_t OTF2_LockType
Wrapper for enum OTF2_LockType_enum.
Definition: OTF2_Events.h:209
OTF2_ErrorCode OTF2_EvtWriter_ThreadTeamBegin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam)
Records a ThreadTeamBegin event.
OTF2_ErrorCode OTF2_EvtWriter_ThreadTaskCreate(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
Records a ThreadTaskCreate event.
OTF2_ErrorCode OTF2_EvtWriter_MpiIsendComplete(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
Records a MpiIsendComplete event.
OTF2_ErrorCode OTF2_EvtWriter_RmaRequestLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
Records a RmaRequestLock event.
OTF2_ErrorCode OTF2_EvtWriter_IoOperationTest(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle, uint64_t matchingId)
Records a IoOperationTest event.
uint64_t OTF2_TimeStamp
OTF2 time stamp.
Definition: OTF2_GeneralDefinitions.h:103
OTF2_ErrorCode OTF2_EvtWriter_RmaWaitChange(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win)
Records a RmaWaitChange event.
OTF2_ErrorCode OTF2_EvtWriter_ParameterUnsignedInt(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_ParameterRef parameter, uint64_t value)
Records a ParameterUnsignedInt event.
uint32_t OTF2_IoHandleRef
Type used to indicate a reference to a IoHandle definition.
Definition: OTF2_GeneralDefinitions.h:235
OTF2_ErrorCode OTF2_EvtWriter_Leave(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RegionRef region)
Records a Leave event.
OTF2_ErrorCode OTF2_EvtWriter_MpiIsend(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
Records a MpiIsend event.
OTF2_ErrorCode OTF2_EvtWriter_RmaAcquireLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
Records a RmaAcquireLock event.
uint32_t OTF2_MetricRef
Type used to indicate a reference to a MetricClass, or a MetricInstance definition.
Definition: OTF2_GeneralDefinitions.h:175
OTF2_ErrorCode OTF2_EvtWriter_OmpAcquireLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t lockID, uint32_t acquisitionOrder)
Records a OmpAcquireLock event.
OTF2_ErrorCode OTF2_EvtWriter_MpiRequestCancelled(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
Records a MpiRequestCancelled event.
OTF2_ErrorCode OTF2_EvtWriter_IoOperationComplete(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle, uint64_t bytesResult, uint64_t matchingId)
Records a IoOperationComplete event.
OTF2_ErrorCode OTF2_EvtWriter_IoDuplicateHandle(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef oldHandle, OTF2_IoHandleRef newHandle, OTF2_IoStatusFlag statusFlags)
Records a IoDuplicateHandle event.
OTF2_ErrorCode OTF2_EvtWriter_RmaReleaseLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId)
Records a RmaReleaseLock event.
OTF2_ErrorCode OTF2_EvtWriter_OmpJoin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time)
Records a OmpJoin event.
OTF2_ErrorCode OTF2_EvtWriter_IoOperationCancelled(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle, uint64_t matchingId)
Records a IoOperationCancelled event.
OTF2_ErrorCode OTF2_EvtWriter_OmpFork(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t numberOfRequestedThreads)
Records a OmpFork event.
uint32_t OTF2_CallingContextRef
Type used to indicate a reference to a CallingContext definition.
Definition: OTF2_GeneralDefinitions.h:217
OTF2_ErrorCode OTF2_EvtWriter_SetUserData(OTF2_EvtWriter *writer, void *userData)
Function to set user defined data to a writer object.
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteNonBlocking(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
Records a RmaOpCompleteNonBlocking event.
OTF2_ErrorCode OTF2_EvtWriter_IoDestroyHandle(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle)
Records a IoDestroyHandle event.
OTF2_ErrorCode OTF2_EvtWriter_MpiCollectiveEnd(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CollectiveOp collectiveOp, OTF2_CommRef communicator, uint32_t root, uint64_t sizeSent, uint64_t sizeReceived)
Records a MpiCollectiveEnd event.
OTF2_ErrorCode OTF2_EvtWriter_IoOperationBegin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle, OTF2_IoOperationMode mode, OTF2_IoOperationFlag operationFlags, uint64_t bytesRequest, uint64_t matchingId)
Records a IoOperationBegin event.
uint8_t OTF2_CollectiveOp
Wrapper for enum OTF2_CollectiveOp_enum.
Definition: OTF2_Events.h:75
OTF2_ErrorCode OTF2_EvtWriter_MpiRequestTest(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
Records a MpiRequestTest event.
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskSwitch(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t taskID)
Records a OmpTaskSwitch event.
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskCreate(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t taskID)
Records a OmpTaskCreate event.
OTF2_ErrorCode OTF2_EvtWriter_ThreadEnd(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
Records a ThreadEnd event.
OTF2_ErrorCode OTF2_EvtWriter_Metric(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_MetricRef metric, uint8_t numberOfMetrics, const OTF2_Type *typeIDs, const OTF2_MetricValue *metricValues)
Records a Metric event.
OTF2_ErrorCode OTF2_EvtWriter_IoOperationIssued(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle, uint64_t matchingId)
Records a IoOperationIssued event.
OTF2_ErrorCode OTF2_EvtWriter_RmaWinCreate(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win)
Records a RmaWinCreate event.
OTF2_ErrorCode OTF2_EvtWriter_Enter(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RegionRef region)
Records a Enter event.
OTF2_ErrorCode OTF2_EvtWriter_MpiSend(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
Records a MpiSend event.
uint32_t OTF2_IoFileRef
Type used to indicate a reference to a IoRegularFile, or a IoDirectory definition.
Definition: OTF2_GeneralDefinitions.h:229
OTF2_ErrorCode OTF2_EvtWriter_GetUserData(const OTF2_EvtWriter *writer, void **userData)
Function to get the location of a writer object.
OTF2_ErrorCode OTF2_EvtWriter_IoAcquireLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle, OTF2_LockType lockType)
Records a IoAcquireLock event.
OTF2_ErrorCode OTF2_EvtWriter_ThreadWait(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
Records a ThreadWait event.
OTF2_ErrorCode OTF2_EvtWriter_MpiIrecv(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
Records a MpiIrecv event.
OTF2_ErrorCode OTF2_EvtWriter_CallingContextEnter(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CallingContextRef callingContext, uint32_t unwindDistance)
Records a CallingContextEnter event.
OTF2_ErrorCode OTF2_EvtWriter_CallingContextLeave(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CallingContextRef callingContext)
Records a CallingContextLeave event.
OTF2_ErrorCode OTF2_EvtWriter_ThreadJoin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model)
Records a ThreadJoin event.
OTF2_ErrorCode OTF2_EvtWriter_RmaCollectiveBegin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time)
Records a RmaCollectiveBegin event.
OTF2_ErrorCode OTF2_EvtWriter_RmaWinDestroy(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win)
Records a RmaWinDestroy event.
OTF2_ErrorCode OTF2_EvtWriter_ClearRewindPoint(OTF2_EvtWriter *writer, uint32_t rewindId)
Please give me a documentation.
struct OTF2_EvtWriter_struct OTF2_EvtWriter
Keeps all necessary information about the event writer. See OTF2_EvtWriter_struct for detailed inform...
Definition: OTF2_EvtWriter.h:63
OTF2_ErrorCode OTF2_EvtWriter_ThreadAcquireLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)
Records a ThreadAcquireLock event.
uint32_t OTF2_CommRef
Type used to indicate a reference to a Comm definition.
Definition: OTF2_GeneralDefinitions.h:181
OTF2_ErrorCode OTF2_EvtWriter_BufferFlush(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_TimeStamp stopTime)
Records a BufferFlush event.
uint32_t OTF2_RegionRef
Type used to indicate a reference to a Region definition.
Definition: OTF2_GeneralDefinitions.h:145
OTF2_ErrorCode OTF2_EvtWriter_ThreadReleaseLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)
Records a ThreadReleaseLock event.
OTF2_ErrorCode OTF2_EvtWriter_ThreadFork(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model, uint32_t numberOfRequestedThreads)
Records a ThreadFork event.
OTF2_ErrorCode OTF2_EvtWriter_ProgramEnd(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, int64_t exitStatus)
Records a ProgramEnd event.
OTF2_ErrorCode OTF2_EvtWriter_Rewind(OTF2_EvtWriter *writer, uint32_t rewindId)
Please give me a documentation.
OTF2_ErrorCode OTF2_EvtWriter_IoDeleteFile(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoParadigmRef ioParadigm, OTF2_IoFileRef file)
Records a IoDeleteFile event.
OTF2_ErrorCode OTF2_EvtWriter_RmaPut(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)
Records a RmaPut event.
uint32_t OTF2_GroupRef
Type used to indicate a reference to a Group definition.
Definition: OTF2_GeneralDefinitions.h:163
OTF2_ErrorCode OTF2_EvtWriter_ThreadTeamEnd(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam)
Records a ThreadTeamEnd event.
OTF2_ErrorCode OTF2_EvtWriter_ProgramBegin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_StringRef programName, uint32_t numberOfArguments, const OTF2_StringRef *programArguments)
Records a ProgramBegin event.
uint32_t OTF2_IoCreationFlag
Wrapper for enum OTF2_IoCreationFlag_enum.
Definition: OTF2_Events.h:274
uint8_t OTF2_IoAccessMode
Wrapper for enum OTF2_IoAccessMode_enum.
Definition: OTF2_Definitions.h:784
OTF2_ErrorCode OTF2_EvtWriter_MpiRecv(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
Records a MpiRecv event.
OTF2_ErrorCode OTF2_EvtWriter_RmaSync(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaSyncType syncType)
Records a RmaSync event.
OTF2_ErrorCode OTF2_EvtWriter_IoChangeStatusFlags(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle, OTF2_IoStatusFlag statusFlags)
Records a IoChangeStatusFlags event.
OTF2_ErrorCode OTF2_EvtWriter_CallingContextSample(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CallingContextRef callingContext, uint32_t unwindDistance, OTF2_InterruptGeneratorRef interruptGenerator)
Records a CallingContextSample event.
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteBlocking(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
Records a RmaOpCompleteBlocking event.
Error codes and error handling.
uint32_t OTF2_RmaWinRef
Type used to indicate a reference to a RmaWin definition.
Definition: OTF2_GeneralDefinitions.h:193
OTF2_ErrorCode OTF2_EvtWriter_IoTryLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_IoHandleRef handle, OTF2_LockType lockType)
Records a IoTryLock event.
OTF2_ErrorCode OTF2_EvtWriter_ParameterInt(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_ParameterRef parameter, int64_t value)
Records a ParameterInt event.
uint8_t OTF2_IoOperationMode
Wrapper for enum OTF2_IoOperationMode_enum.
Definition: OTF2_Events.h:407
OTF2_ErrorCode OTF2_EvtWriter_ThreadBegin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
Records a ThreadBegin event.
OTF2_ErrorCode OTF2_EvtWriter_MeasurementOnOff(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_MeasurementMode measurementMode)
Records a MeasurementOnOff event.