2.2 (revision 4737)
OTF2_SnapWriter.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) 2013,
5  * Technische Universitaet Dresden, Germany
6  *
7  * This software may be modified and distributed under the terms of
8  * a BSD-style license. See the COPYING file in the package base
9  * directory for details.
10  */
11 
12 
13 #ifndef OTF2_SNAP_WRITER_H
14 #define OTF2_SNAP_WRITER_H
15 
16 
27 #include <stdint.h>
28 
29 
30 #include <otf2/OTF2_ErrorCodes.h>
31 
32 
33 #include <otf2/OTF2_Events.h>
34 #include <otf2/OTF2_AttributeList.h>
35 
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif /* __cplusplus */
40 
41 
47 typedef struct OTF2_SnapWriter_struct OTF2_SnapWriter;
48 
49 
60 OTF2_ErrorCode
61 OTF2_SnapWriter_GetLocationID( const OTF2_SnapWriter* writer,
62  OTF2_LocationRef* locationID );
63 
64 
65 
88 OTF2_ErrorCode
89 OTF2_SnapWriter_SnapshotStart( OTF2_SnapWriter* writer,
90  OTF2_AttributeList* attributeList,
91  OTF2_TimeStamp snapTime,
92  uint64_t numberOfRecords );
93 
94 
110 OTF2_ErrorCode
111 OTF2_SnapWriter_SnapshotEnd( OTF2_SnapWriter* writer,
112  OTF2_AttributeList* attributeList,
113  OTF2_TimeStamp snapTime,
114  uint64_t contReadPos );
115 
116 
134 OTF2_ErrorCode
135 OTF2_SnapWriter_MeasurementOnOff( OTF2_SnapWriter* writer,
136  OTF2_AttributeList* attributeList,
137  OTF2_TimeStamp snapTime,
138  OTF2_TimeStamp origEventTime,
139  OTF2_MeasurementMode measurementMode );
140 
141 
160 OTF2_ErrorCode
161 OTF2_SnapWriter_Enter( OTF2_SnapWriter* writer,
162  OTF2_AttributeList* attributeList,
163  OTF2_TimeStamp snapTime,
164  OTF2_TimeStamp origEventTime,
165  OTF2_RegionRef region );
166 
167 
193 OTF2_ErrorCode
194 OTF2_SnapWriter_MpiSend( OTF2_SnapWriter* writer,
195  OTF2_AttributeList* attributeList,
196  OTF2_TimeStamp snapTime,
197  OTF2_TimeStamp origEventTime,
198  uint32_t receiver,
199  OTF2_CommRef communicator,
200  uint32_t msgTag,
201  uint64_t msgLength );
202 
203 
231 OTF2_ErrorCode
232 OTF2_SnapWriter_MpiIsend( OTF2_SnapWriter* writer,
233  OTF2_AttributeList* attributeList,
234  OTF2_TimeStamp snapTime,
235  OTF2_TimeStamp origEventTime,
236  uint32_t receiver,
237  OTF2_CommRef communicator,
238  uint32_t msgTag,
239  uint64_t msgLength,
240  uint64_t requestID );
241 
242 
261 OTF2_ErrorCode
262 OTF2_SnapWriter_MpiIsendComplete( OTF2_SnapWriter* writer,
263  OTF2_AttributeList* attributeList,
264  OTF2_TimeStamp snapTime,
265  OTF2_TimeStamp origEventTime,
266  uint64_t requestID );
267 
268 
295 OTF2_ErrorCode
296 OTF2_SnapWriter_MpiRecv( OTF2_SnapWriter* writer,
297  OTF2_AttributeList* attributeList,
298  OTF2_TimeStamp snapTime,
299  OTF2_TimeStamp origEventTime,
300  uint32_t sender,
301  OTF2_CommRef communicator,
302  uint32_t msgTag,
303  uint64_t msgLength );
304 
305 
327 OTF2_ErrorCode
328 OTF2_SnapWriter_MpiIrecvRequest( OTF2_SnapWriter* writer,
329  OTF2_AttributeList* attributeList,
330  OTF2_TimeStamp snapTime,
331  OTF2_TimeStamp origEventTime,
332  uint64_t requestID );
333 
334 
362 OTF2_ErrorCode
363 OTF2_SnapWriter_MpiIrecv( OTF2_SnapWriter* writer,
364  OTF2_AttributeList* attributeList,
365  OTF2_TimeStamp snapTime,
366  OTF2_TimeStamp origEventTime,
367  uint32_t sender,
368  OTF2_CommRef communicator,
369  uint32_t msgTag,
370  uint64_t msgLength,
371  uint64_t requestID );
372 
373 
389 OTF2_ErrorCode
390 OTF2_SnapWriter_MpiCollectiveBegin( OTF2_SnapWriter* writer,
391  OTF2_AttributeList* attributeList,
392  OTF2_TimeStamp snapTime,
393  OTF2_TimeStamp origEventTime );
394 
395 
421 OTF2_ErrorCode
422 OTF2_SnapWriter_MpiCollectiveEnd( OTF2_SnapWriter* writer,
423  OTF2_AttributeList* attributeList,
424  OTF2_TimeStamp snapTime,
425  OTF2_TimeStamp origEventTime,
426  OTF2_CollectiveOp collectiveOp,
427  OTF2_CommRef communicator,
428  uint32_t root,
429  uint64_t sizeSent,
430  uint64_t sizeReceived );
431 
432 
449 OTF2_ErrorCode
450 OTF2_SnapWriter_OmpFork( OTF2_SnapWriter* writer,
451  OTF2_AttributeList* attributeList,
452  OTF2_TimeStamp snapTime,
453  OTF2_TimeStamp origEventTime,
454  uint32_t numberOfRequestedThreads );
455 
456 
478 OTF2_ErrorCode
479 OTF2_SnapWriter_OmpAcquireLock( OTF2_SnapWriter* writer,
480  OTF2_AttributeList* attributeList,
481  OTF2_TimeStamp snapTime,
482  OTF2_TimeStamp origEventTime,
483  uint32_t lockID,
484  uint32_t acquisitionOrder );
485 
486 
504 OTF2_ErrorCode
505 OTF2_SnapWriter_OmpTaskCreate( OTF2_SnapWriter* writer,
506  OTF2_AttributeList* attributeList,
507  OTF2_TimeStamp snapTime,
508  OTF2_TimeStamp origEventTime,
509  uint64_t taskID );
510 
511 
529 OTF2_ErrorCode
530 OTF2_SnapWriter_OmpTaskSwitch( OTF2_SnapWriter* writer,
531  OTF2_AttributeList* attributeList,
532  OTF2_TimeStamp snapTime,
533  OTF2_TimeStamp origEventTime,
534  uint64_t taskID );
535 
536 
565 OTF2_ErrorCode
566 OTF2_SnapWriter_Metric( OTF2_SnapWriter* writer,
567  OTF2_AttributeList* attributeList,
568  OTF2_TimeStamp snapTime,
569  OTF2_TimeStamp origEventTime,
570  OTF2_MetricRef metric,
571  uint8_t numberOfMetrics,
572  const OTF2_Type* typeIDs,
573  const OTF2_MetricValue* metricValues );
574 
575 
599 OTF2_ErrorCode
600 OTF2_SnapWriter_ParameterString( OTF2_SnapWriter* writer,
601  OTF2_AttributeList* attributeList,
602  OTF2_TimeStamp snapTime,
603  OTF2_TimeStamp origEventTime,
604  OTF2_ParameterRef parameter,
605  OTF2_StringRef string );
606 
607 
628 OTF2_ErrorCode
629 OTF2_SnapWriter_ParameterInt( OTF2_SnapWriter* writer,
630  OTF2_AttributeList* attributeList,
631  OTF2_TimeStamp snapTime,
632  OTF2_TimeStamp origEventTime,
633  OTF2_ParameterRef parameter,
634  int64_t value );
635 
636 
657 OTF2_ErrorCode
658 OTF2_SnapWriter_ParameterUnsignedInt( OTF2_SnapWriter* writer,
659  OTF2_AttributeList* attributeList,
660  OTF2_TimeStamp snapTime,
661  OTF2_TimeStamp origEventTime,
662  OTF2_ParameterRef parameter,
663  uint64_t value );
664 
665 
666 
667 #ifdef __cplusplus
668 }
669 #endif /* __cplusplus */
670 
671 
672 #endif /* !OTF2_SNAP_WRITER_H */
OTF2_SnapWriter_ParameterUnsignedInt
OTF2_ErrorCode OTF2_SnapWriter_ParameterUnsignedInt(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, uint64_t value)
Records a ParameterUnsignedInt snapshot record.
OTF2_SnapWriter_MpiIrecvRequest
OTF2_ErrorCode OTF2_SnapWriter_MpiIrecvRequest(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint64_t requestID)
Records a MpiIrecvRequest snapshot record.
OTF2_LocationRef
uint64_t OTF2_LocationRef
Type used to indicate a reference to a Location definition.
Definition: OTF2_GeneralDefinitions.h:139
OTF2_SnapWriter_MeasurementOnOff
OTF2_ErrorCode OTF2_SnapWriter_MeasurementOnOff(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_MeasurementMode measurementMode)
Records a MeasurementOnOff snapshot record.
OTF2_SnapWriter_GetLocationID
OTF2_ErrorCode OTF2_SnapWriter_GetLocationID(const OTF2_SnapWriter *writer, OTF2_LocationRef *locationID)
Function to get the location ID of a snap writer object.
OTF2_Type
uint8_t OTF2_Type
Wrapper for enum OTF2_Type_enum.
Definition: OTF2_GeneralDefinitions.h:561
OTF2_SnapWriter_OmpTaskSwitch
OTF2_ErrorCode OTF2_SnapWriter_OmpTaskSwitch(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint64_t taskID)
Records a OmpTaskSwitch snapshot record.
OTF2_StringRef
uint32_t OTF2_StringRef
Type used to indicate a reference to a String definition.
Definition: OTF2_GeneralDefinitions.h:115
OTF2_SnapWriter_Enter
OTF2_ErrorCode OTF2_SnapWriter_Enter(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_RegionRef region)
Records a Enter snapshot record.
OTF2_Events.h
Enums and types used in event records.
OTF2_MeasurementMode
uint8_t OTF2_MeasurementMode
Wrapper for enum OTF2_MeasurementMode_enum.
Definition: OTF2_Events.h:56
OTF2_MetricValue
Metric value.
Definition: OTF2_Events.h:453
OTF2_ParameterRef
uint32_t OTF2_ParameterRef
Type used to indicate a reference to a Parameter definition.
Definition: OTF2_GeneralDefinitions.h:187
OTF2_AttributeList.h
This layer enables dynamic appending of arbitrary attributes to any type of event record...
OTF2_AttributeList
struct OTF2_AttributeList_struct OTF2_AttributeList
Attribute list handle.
Definition: OTF2_AttributeList.h:104
OTF2_ErrorCode
OTF2_ErrorCode
Definition: OTF2_ErrorCodes.h:54
OTF2_SnapWriter_ParameterString
OTF2_ErrorCode OTF2_SnapWriter_ParameterString(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, OTF2_StringRef string)
Records a ParameterString snapshot record.
OTF2_SnapWriter_MpiSend
OTF2_ErrorCode OTF2_SnapWriter_MpiSend(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
Records a MpiSend snapshot record.
OTF2_SnapWriter_SnapshotStart
OTF2_ErrorCode OTF2_SnapWriter_SnapshotStart(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, uint64_t numberOfRecords)
Records a SnapshotStart snapshot record.
OTF2_SnapWriter_SnapshotEnd
OTF2_ErrorCode OTF2_SnapWriter_SnapshotEnd(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, uint64_t contReadPos)
Records a SnapshotEnd snapshot record.
OTF2_TimeStamp
uint64_t OTF2_TimeStamp
OTF2 time stamp.
Definition: OTF2_GeneralDefinitions.h:103
OTF2_SnapWriter_OmpFork
OTF2_ErrorCode OTF2_SnapWriter_OmpFork(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t numberOfRequestedThreads)
Records a OmpFork snapshot record.
OTF2_MetricRef
uint32_t OTF2_MetricRef
Type used to indicate a reference to a MetricClass, or a MetricInstance definition.
Definition: OTF2_GeneralDefinitions.h:175
OTF2_SnapWriter_MpiCollectiveEnd
OTF2_ErrorCode OTF2_SnapWriter_MpiCollectiveEnd(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_CollectiveOp collectiveOp, OTF2_CommRef communicator, uint32_t root, uint64_t sizeSent, uint64_t sizeReceived)
Records a MpiCollectiveEnd snapshot record.
OTF2_SnapWriter_MpiRecv
OTF2_ErrorCode OTF2_SnapWriter_MpiRecv(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
Records a MpiRecv snapshot record.
OTF2_SnapWriter_MpiCollectiveBegin
OTF2_ErrorCode OTF2_SnapWriter_MpiCollectiveBegin(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime)
Records a MpiCollectiveBegin snapshot record.
OTF2_CollectiveOp
uint8_t OTF2_CollectiveOp
Wrapper for enum OTF2_CollectiveOp_enum.
Definition: OTF2_Events.h:75
OTF2_SnapWriter_OmpTaskCreate
OTF2_ErrorCode OTF2_SnapWriter_OmpTaskCreate(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint64_t taskID)
Records a OmpTaskCreate snapshot record.
OTF2_SnapWriter_ParameterInt
OTF2_ErrorCode OTF2_SnapWriter_ParameterInt(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, int64_t value)
Records a ParameterInt snapshot record.
OTF2_SnapWriter_MpiIsendComplete
OTF2_ErrorCode OTF2_SnapWriter_MpiIsendComplete(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint64_t requestID)
Records a MpiIsendComplete snapshot record.
OTF2_CommRef
uint32_t OTF2_CommRef
Type used to indicate a reference to a Comm definition.
Definition: OTF2_GeneralDefinitions.h:181
OTF2_SnapWriter
struct OTF2_SnapWriter_struct OTF2_SnapWriter
Keeps all necessary information about the snap writer. See OTF2_SnapWriter_struct for detailed inform...
Definition: OTF2_SnapWriter.h:47
OTF2_RegionRef
uint32_t OTF2_RegionRef
Type used to indicate a reference to a Region definition.
Definition: OTF2_GeneralDefinitions.h:145
OTF2_SnapWriter_MpiIsend
OTF2_ErrorCode OTF2_SnapWriter_MpiIsend(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
Records a MpiIsend snapshot record.
OTF2_SnapWriter_Metric
OTF2_ErrorCode OTF2_SnapWriter_Metric(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_MetricRef metric, uint8_t numberOfMetrics, const OTF2_Type *typeIDs, const OTF2_MetricValue *metricValues)
Records a Metric snapshot record.
OTF2_ErrorCodes.h
Error codes and error handling.
OTF2_SnapWriter_OmpAcquireLock
OTF2_ErrorCode OTF2_SnapWriter_OmpAcquireLock(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t lockID, uint32_t acquisitionOrder)
Records a OmpAcquireLock snapshot record.
OTF2_SnapWriter_MpiIrecv
OTF2_ErrorCode OTF2_SnapWriter_MpiIrecv(OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
Records a MpiIrecv snapshot record.
Report bugs to support@score-p.org