3.1-rc3 (revision d9ca08bb)
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, 2021,
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_compiler.h"
50 
51 
52 #include <otf2/OTF2_ErrorCodes.h>
53 
54 
55 #include <otf2/OTF2_Events.h>
57 
58 
59 #ifdef __cplusplus
60 extern "C" {
61 #endif /* __cplusplus */
62 
63 
66 typedef struct OTF2_EvtWriter_struct OTF2_EvtWriter;
67 
68 
79  OTF2_LocationRef* locationID );
80 
81 
93  void* userData );
94 
95 
106  void** userData );
107 
108 
121  OTF2_LocationRef location );
122 
123 
137  uint64_t* numberOfEvents );
138 
139 
156  OTF2_AttributeList* attributeList,
157  OTF2_TimeStamp time,
158  OTF2_TimeStamp stopTime );
159 
160 
179  OTF2_AttributeList* attributeList,
180  OTF2_TimeStamp time,
181  OTF2_MeasurementMode measurementMode );
182 
183 
202  OTF2_AttributeList* attributeList,
203  OTF2_TimeStamp time,
204  OTF2_RegionRef region );
205 
206 
225  OTF2_AttributeList* attributeList,
226  OTF2_TimeStamp time,
227  OTF2_RegionRef region );
228 
229 
255  OTF2_AttributeList* attributeList,
256  OTF2_TimeStamp time,
257  uint32_t receiver,
258  OTF2_CommRef communicator,
259  uint32_t msgTag,
260  uint64_t msgLength );
261 
262 
289  OTF2_AttributeList* attributeList,
290  OTF2_TimeStamp time,
291  uint32_t receiver,
292  OTF2_CommRef communicator,
293  uint32_t msgTag,
294  uint64_t msgLength,
295  uint64_t requestID );
296 
297 
318  OTF2_AttributeList* attributeList,
319  OTF2_TimeStamp time,
320  uint64_t requestID );
321 
322 
339  OTF2_AttributeList* attributeList,
340  OTF2_TimeStamp time,
341  uint64_t requestID );
342 
343 
369  OTF2_AttributeList* attributeList,
370  OTF2_TimeStamp time,
371  uint32_t sender,
372  OTF2_CommRef communicator,
373  uint32_t msgTag,
374  uint64_t msgLength );
375 
376 
403  OTF2_AttributeList* attributeList,
404  OTF2_TimeStamp time,
405  uint32_t sender,
406  OTF2_CommRef communicator,
407  uint32_t msgTag,
408  uint64_t msgLength,
409  uint64_t requestID );
410 
411 
428  OTF2_AttributeList* attributeList,
429  OTF2_TimeStamp time,
430  uint64_t requestID );
431 
432 
448  OTF2_AttributeList* attributeList,
449  OTF2_TimeStamp time,
450  uint64_t requestID );
451 
452 
468  OTF2_AttributeList* attributeList,
469  OTF2_TimeStamp time );
470 
471 
499  OTF2_AttributeList* attributeList,
500  OTF2_TimeStamp time,
501  OTF2_CollectiveOp collectiveOp,
502  OTF2_CommRef communicator,
503  uint32_t root,
504  uint64_t sizeSent,
505  uint64_t sizeReceived );
506 
507 
529  OTF2_AttributeList* attributeList,
530  OTF2_TimeStamp time,
531  uint32_t numberOfRequestedThreads ) __otf2_deprecated__;
532 
533 
555  OTF2_AttributeList* attributeList,
556  OTF2_TimeStamp time ) __otf2_deprecated__;
557 
558 
586  OTF2_AttributeList* attributeList,
587  OTF2_TimeStamp time,
588  uint32_t lockID,
589  uint32_t acquisitionOrder ) __otf2_deprecated__;
590 
591 
619  OTF2_AttributeList* attributeList,
620  OTF2_TimeStamp time,
621  uint32_t lockID,
622  uint32_t acquisitionOrder ) __otf2_deprecated__;
623 
624 
647  OTF2_AttributeList* attributeList,
648  OTF2_TimeStamp time,
649  uint64_t taskID ) __otf2_deprecated__;
650 
651 
676  OTF2_AttributeList* attributeList,
677  OTF2_TimeStamp time,
678  uint64_t taskID ) __otf2_deprecated__;
679 
680 
703  OTF2_AttributeList* attributeList,
704  OTF2_TimeStamp time,
705  uint64_t taskID ) __otf2_deprecated__;
706 
707 
735  OTF2_AttributeList* attributeList,
736  OTF2_TimeStamp time,
737  OTF2_MetricRef metric,
738  uint8_t numberOfMetrics,
739  const OTF2_Type* typeIDs,
740  const OTF2_MetricValue* metricValues );
741 
742 
766  OTF2_AttributeList* attributeList,
767  OTF2_TimeStamp time,
768  OTF2_ParameterRef parameter,
769  OTF2_StringRef string );
770 
771 
792  OTF2_AttributeList* attributeList,
793  OTF2_TimeStamp time,
794  OTF2_ParameterRef parameter,
795  int64_t value );
796 
797 
818  OTF2_AttributeList* attributeList,
819  OTF2_TimeStamp time,
820  OTF2_ParameterRef parameter,
821  uint64_t value );
822 
823 
849  OTF2_AttributeList* attributeList,
850  OTF2_TimeStamp time,
851  OTF2_RmaWinRef win );
852 
853 
881  OTF2_AttributeList* attributeList,
882  OTF2_TimeStamp time,
883  OTF2_RmaWinRef win );
884 
885 
901  OTF2_AttributeList* attributeList,
902  OTF2_TimeStamp time );
903 
904 
930  OTF2_AttributeList* attributeList,
931  OTF2_TimeStamp time,
932  OTF2_CollectiveOp collectiveOp,
933  OTF2_RmaSyncLevel syncLevel,
934  OTF2_RmaWinRef win,
935  uint32_t root,
936  uint64_t bytesSent,
937  uint64_t bytesReceived );
938 
939 
964  OTF2_AttributeList* attributeList,
965  OTF2_TimeStamp time,
966  OTF2_RmaSyncLevel syncLevel,
967  OTF2_RmaWinRef win,
968  OTF2_GroupRef group );
969 
970 
998  OTF2_AttributeList* attributeList,
999  OTF2_TimeStamp time,
1000  OTF2_RmaWinRef win,
1001  uint32_t remote,
1002  uint64_t lockId,
1003  OTF2_LockType lockType );
1004 
1005 
1031  OTF2_AttributeList* attributeList,
1032  OTF2_TimeStamp time,
1033  OTF2_RmaWinRef win,
1034  uint32_t remote,
1035  uint64_t lockId,
1036  OTF2_LockType lockType );
1037 
1038 
1064  OTF2_AttributeList* attributeList,
1065  OTF2_TimeStamp time,
1066  OTF2_RmaWinRef win,
1067  uint32_t remote,
1068  uint64_t lockId,
1069  OTF2_LockType lockType );
1070 
1071 
1095  OTF2_AttributeList* attributeList,
1096  OTF2_TimeStamp time,
1097  OTF2_RmaWinRef win,
1098  uint32_t remote,
1099  uint64_t lockId );
1100 
1101 
1123  OTF2_AttributeList* attributeList,
1124  OTF2_TimeStamp time,
1125  OTF2_RmaWinRef win,
1126  uint32_t remote,
1127  OTF2_RmaSyncType syncType );
1128 
1129 
1149  OTF2_AttributeList* attributeList,
1150  OTF2_TimeStamp time,
1151  OTF2_RmaWinRef win );
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 
1206  OTF2_AttributeList* attributeList,
1207  OTF2_TimeStamp time,
1208  OTF2_RmaWinRef win,
1209  uint32_t remote,
1210  uint64_t bytes,
1211  uint64_t matchingId );
1212 
1213 
1239  OTF2_AttributeList* attributeList,
1240  OTF2_TimeStamp time,
1241  OTF2_RmaWinRef win,
1242  uint32_t remote,
1243  OTF2_RmaAtomicType type,
1244  uint64_t bytesSent,
1245  uint64_t bytesReceived,
1246  uint64_t matchingId );
1247 
1248 
1270  OTF2_AttributeList* attributeList,
1271  OTF2_TimeStamp time,
1272  OTF2_RmaWinRef win,
1273  uint64_t matchingId );
1274 
1275 
1297  OTF2_AttributeList* attributeList,
1298  OTF2_TimeStamp time,
1299  OTF2_RmaWinRef win,
1300  uint64_t matchingId );
1301 
1302 
1324  OTF2_AttributeList* attributeList,
1325  OTF2_TimeStamp time,
1326  OTF2_RmaWinRef win,
1327  uint64_t matchingId );
1328 
1329 
1351  OTF2_AttributeList* attributeList,
1352  OTF2_TimeStamp time,
1353  OTF2_RmaWinRef win,
1354  uint64_t matchingId );
1355 
1356 
1373  OTF2_AttributeList* attributeList,
1374  OTF2_TimeStamp time,
1375  OTF2_Paradigm model,
1376  uint32_t numberOfRequestedThreads );
1377 
1378 
1395  OTF2_AttributeList* attributeList,
1396  OTF2_TimeStamp time,
1397  OTF2_Paradigm model );
1398 
1399 
1418  OTF2_AttributeList* attributeList,
1419  OTF2_TimeStamp time,
1420  OTF2_CommRef threadTeam );
1421 
1422 
1441  OTF2_AttributeList* attributeList,
1442  OTF2_TimeStamp time,
1443  OTF2_CommRef threadTeam );
1444 
1445 
1467  OTF2_AttributeList* attributeList,
1468  OTF2_TimeStamp time,
1469  OTF2_Paradigm model,
1470  uint32_t lockID,
1471  uint32_t acquisitionOrder );
1472 
1473 
1495  OTF2_AttributeList* attributeList,
1496  OTF2_TimeStamp time,
1497  OTF2_Paradigm model,
1498  uint32_t lockID,
1499  uint32_t acquisitionOrder );
1500 
1501 
1524  OTF2_AttributeList* attributeList,
1525  OTF2_TimeStamp time,
1526  OTF2_CommRef threadTeam,
1527  uint32_t creatingThread,
1528  uint32_t generationNumber );
1529 
1530 
1555  OTF2_AttributeList* attributeList,
1556  OTF2_TimeStamp time,
1557  OTF2_CommRef threadTeam,
1558  uint32_t creatingThread,
1559  uint32_t generationNumber );
1560 
1561 
1584  OTF2_AttributeList* attributeList,
1585  OTF2_TimeStamp time,
1586  OTF2_CommRef threadTeam,
1587  uint32_t creatingThread,
1588  uint32_t generationNumber );
1589 
1590 
1612  OTF2_AttributeList* attributeList,
1613  OTF2_TimeStamp time,
1614  OTF2_CommRef threadContingent,
1615  uint64_t sequenceCount );
1616 
1617 
1639  OTF2_AttributeList* attributeList,
1640  OTF2_TimeStamp time,
1641  OTF2_CommRef threadContingent,
1642  uint64_t sequenceCount );
1643 
1644 
1666  OTF2_AttributeList* attributeList,
1667  OTF2_TimeStamp time,
1668  OTF2_CommRef threadContingent,
1669  uint64_t sequenceCount );
1670 
1671 
1695  OTF2_AttributeList* attributeList,
1696  OTF2_TimeStamp time,
1697  OTF2_CommRef threadContingent,
1698  uint64_t sequenceCount );
1699 
1700 
1735  OTF2_AttributeList* attributeList,
1736  OTF2_TimeStamp time,
1737  OTF2_CallingContextRef callingContext,
1738  uint32_t unwindDistance );
1739 
1740 
1780  OTF2_AttributeList* attributeList,
1781  OTF2_TimeStamp time,
1782  OTF2_CallingContextRef callingContext );
1783 
1784 
1817  OTF2_AttributeList* attributeList,
1818  OTF2_TimeStamp time,
1819  OTF2_CallingContextRef callingContext,
1820  uint32_t unwindDistance,
1821  OTF2_InterruptGeneratorRef interruptGenerator );
1822 
1823 
1861  OTF2_AttributeList* attributeList,
1862  OTF2_TimeStamp time,
1863  OTF2_IoHandleRef handle,
1864  OTF2_IoAccessMode mode,
1865  OTF2_IoCreationFlag creationFlags,
1866  OTF2_IoStatusFlag statusFlags );
1867 
1868 
1898  OTF2_AttributeList* attributeList,
1899  OTF2_TimeStamp time,
1900  OTF2_IoHandleRef handle );
1901 
1902 
1937  OTF2_AttributeList* attributeList,
1938  OTF2_TimeStamp time,
1939  OTF2_IoHandleRef oldHandle,
1940  OTF2_IoHandleRef newHandle,
1941  OTF2_IoStatusFlag statusFlags );
1942 
1943 
1969  OTF2_AttributeList* attributeList,
1970  OTF2_TimeStamp time,
1971  OTF2_IoHandleRef handle,
1972  int64_t offsetRequest,
1973  OTF2_IoSeekOption whence,
1974  uint64_t offsetResult );
1975 
1976 
1997  OTF2_AttributeList* attributeList,
1998  OTF2_TimeStamp time,
1999  OTF2_IoHandleRef handle,
2000  OTF2_IoStatusFlag statusFlags );
2001 
2002 
2023  OTF2_AttributeList* attributeList,
2024  OTF2_TimeStamp time,
2025  OTF2_IoParadigmRef ioParadigm,
2026  OTF2_IoFileRef file );
2027 
2028 
2056  OTF2_AttributeList* attributeList,
2057  OTF2_TimeStamp time,
2058  OTF2_IoHandleRef handle,
2059  OTF2_IoOperationMode mode,
2060  OTF2_IoOperationFlag operationFlags,
2061  uint64_t bytesRequest,
2062  uint64_t matchingId );
2063 
2064 
2089  OTF2_AttributeList* attributeList,
2090  OTF2_TimeStamp time,
2091  OTF2_IoHandleRef handle,
2092  uint64_t matchingId );
2093 
2094 
2120  OTF2_AttributeList* attributeList,
2121  OTF2_TimeStamp time,
2122  OTF2_IoHandleRef handle,
2123  uint64_t matchingId );
2124 
2125 
2151  OTF2_AttributeList* attributeList,
2152  OTF2_TimeStamp time,
2153  OTF2_IoHandleRef handle,
2154  uint64_t bytesResult,
2155  uint64_t matchingId );
2156 
2157 
2183  OTF2_AttributeList* attributeList,
2184  OTF2_TimeStamp time,
2185  OTF2_IoHandleRef handle,
2186  uint64_t matchingId );
2187 
2188 
2208  OTF2_AttributeList* attributeList,
2209  OTF2_TimeStamp time,
2210  OTF2_IoHandleRef handle,
2211  OTF2_LockType lockType );
2212 
2213 
2233  OTF2_AttributeList* attributeList,
2234  OTF2_TimeStamp time,
2235  OTF2_IoHandleRef handle,
2236  OTF2_LockType lockType );
2237 
2238 
2259  OTF2_AttributeList* attributeList,
2260  OTF2_TimeStamp time,
2261  OTF2_IoHandleRef handle,
2262  OTF2_LockType lockType );
2263 
2264 
2296  OTF2_AttributeList* attributeList,
2297  OTF2_TimeStamp time,
2298  OTF2_StringRef programName,
2299  uint32_t numberOfArguments,
2300  const OTF2_StringRef* programArguments );
2301 
2302 
2333  OTF2_AttributeList* attributeList,
2334  OTF2_TimeStamp time,
2335  int64_t exitStatus );
2336 
2337 
2354  OTF2_AttributeList* attributeList,
2355  OTF2_TimeStamp time,
2356  uint64_t requestID );
2357 
2358 
2384  OTF2_AttributeList* attributeList,
2385  OTF2_TimeStamp time,
2386  OTF2_CollectiveOp collectiveOp,
2387  OTF2_CommRef communicator,
2388  uint32_t root,
2389  uint64_t sizeSent,
2390  uint64_t sizeReceived,
2391  uint64_t requestID );
2392 
2393 
2418  OTF2_AttributeList* attributeList,
2419  OTF2_TimeStamp time,
2420  OTF2_CommRef communicator );
2421 
2422 
2448  OTF2_AttributeList* attributeList,
2449  OTF2_TimeStamp time,
2450  OTF2_CommRef communicator );
2451 
2452 
2464  uint32_t rewindId );
2465 
2466 
2478  uint32_t rewindId );
2479 
2480 
2492  uint32_t rewindId );
2493 
2494 
2495 #ifdef __cplusplus
2496 }
2497 #endif /* __cplusplus */
2498 
2499 
2500 #endif /* !OTF2_EVT_WRITER_H */
uint8_t OTF2_RmaSyncType
Wrapper for enum OTF2_RmaSyncType_enum.
Definition: OTF2_Events.h:190
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:414
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:142
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:596
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:778
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:118
uint8_t OTF2_IoParadigmRef
Type used to indicate a reference to a IoParadigm definition.
Definition: OTF2_GeneralDefinitions.h:112
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:59
Metric value.
Definition: OTF2_Events.h:547
uint32_t OTF2_ParameterRef
Type used to indicate a reference to a Parameter definition.
Definition: OTF2_GeneralDefinitions.h:190
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.
OTF2_ErrorCode OTF2_EvtWriter_CommDestroy(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef communicator)
Records a CommDestroy event.
uint8_t OTF2_RmaAtomicType
Wrapper for enum OTF2_RmaAtomicType_enum.
Definition: OTF2_Events.h:262
uint32_t OTF2_RmaSyncLevel
Wrapper for enum OTF2_RmaSyncLevel_enum.
Definition: OTF2_Events.h:214
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:988
OTF2_ErrorCode
Definition: OTF2_ErrorCodes.h:53
OTF2_ErrorCode OTF2_EvtWriter_NonBlockingCollectiveRequest(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
Records a NonBlockingCollectiveRequest event.
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:488
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:226
uint8_t OTF2_LockType
Wrapper for enum OTF2_LockType_enum.
Definition: OTF2_Events.h:241
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_NonBlockingCollectiveComplete(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CollectiveOp collectiveOp, OTF2_CommRef communicator, uint32_t root, uint64_t sizeSent, uint64_t sizeReceived, uint64_t requestID)
Records a NonBlockingCollectiveComplete 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:106
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:238
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:178
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:220
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:79
Compiler feature test macros.
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:232
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_CommCreate(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef communicator)
Records a CommCreate 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:66
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, or a InterComm definition.
Definition: OTF2_GeneralDefinitions.h:184
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:148
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:166
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:314
uint8_t OTF2_IoAccessMode
Wrapper for enum OTF2_IoAccessMode_enum.
Definition: OTF2_Definitions.h:939
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:196
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:464
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.