2.3 (revision 117c8d5b)
OTF2_SnapReader.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-2014,
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_READER_H
14 #define OTF2_SNAP_READER_H
15 
16 
25 #include <stdint.h>
26 
27 
28 #include <otf2/OTF2_ErrorCodes.h>
29 
30 
31 #include <otf2/OTF2_Events.h>
32 #include <otf2/OTF2_Definitions.h>
35 
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif /* __cplusplus */
40 
41 
54  OTF2_LocationRef* location );
55 
56 
78  const OTF2_SnapReaderCallbacks* callbacks,
79  void* userData );
80 
81 
96  uint64_t req_time,
97  bool* found );
98 
99 
116  uint64_t recordsToRead,
117  uint64_t* recordsRead );
118 
119 
120 #ifdef __cplusplus
121 }
122 #endif /* __cplusplus */
123 
124 
125 #endif /* !OTF2_SNAP_READER_H */
uint64_t OTF2_LocationRef
Type used to indicate a reference to a Location definition.
Definition: OTF2_GeneralDefinitions.h:139
Enums and types used in event records.
This layer enables dynamic appending of arbitrary attributes to any type of event record...
OTF2_ErrorCode OTF2_SnapReader_ReadSnapshots(OTF2_SnapReader *reader, uint64_t recordsToRead, uint64_t *recordsRead)
After callback registration, the local snapshot events could be read with the following function...
This defines the callbacks for the snap reader.
OTF2_ErrorCode
Definition: OTF2_ErrorCodes.h:54
Data types used in the definition records.
struct OTF2_SnapReader_struct OTF2_SnapReader
OTF2 local snap reader handle.
Definition: OTF2_GeneralDefinitions.h:260
OTF2_ErrorCode OTF2_SnapReader_Seek(OTF2_SnapReader *reader, uint64_t req_time, bool *found)
Seek jumps to start of latest snapshot that was made before a given time 'req_time'.
struct OTF2_SnapReaderCallbacks_struct OTF2_SnapReaderCallbacks
Opaque struct which holds all snap event record callbacks.
Definition: OTF2_SnapReaderCallbacks.h:45
OTF2_ErrorCode OTF2_SnapReader_GetLocationID(const OTF2_SnapReader *reader, OTF2_LocationRef *location)
Return the location ID of the reading related location.
Error codes and error handling.
OTF2_ErrorCode OTF2_SnapReader_SetCallbacks(OTF2_SnapReader *reader, const OTF2_SnapReaderCallbacks *callbacks, void *userData)
Sets the callback functions for the given reader object. Every time when OTF2 reads a record...