OpenMPI 0.1.1

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

otf.h
Go to the documentation of this file.
1 /*
2 This is part of the OTF library. Copyright by ZIH, TU Dresden 2005-2012.
3 Authors: Andreas Knuepfer, Holger Brunst, Ronny Brendel, Thomas Kriebitzsch
4 */
5
6 /**
7 * \mainpage Open Trace Format API Documentation
8 *
9 * \section introduction Introduction
10 *
11 * This library supports efficient parallel and distributed access to trace
12 * data and offers selective reading access regarding arbitrary time
13 * intervals, process selection and record types. Optional auxiliary
14 * information can assist this selective access.
15 *
16 * The Open Trace Format makes use of a portable ASCII encoding.
17 * It distributes single traces to multiple so called streams
18 * with one or more files each. Merging of records from multiple files is done
19 * transparently by the OTF library. The number of possible streams is not
20 * limited by the number of available file handles.
21 *
22 *
23 * For more information read the specification (docu/api/specification.pdf)
24 *
25 * OTF is available under the BSD open source license that allows free usage
26 * for academic and commercial applications.
27 *
28 *
29 * \section quicklinks Quick Links
30 *
31 * \subsection interfaces Interfaces
32 * - \ref reader "Global Reader" - \ref rstream "Stream Reader"
33 * - \ref writer "Global Writer" - \ref wstream "Stream Writer "
34 * - \ref handler "Handlers" - \ref ha "Handler Array"
35 *
36 * - \ref fm "File Manager"
37 * - \ref mc "Master Control"
38 *
39 * - \ref keyvalue "KeyValueList"
40 *
41 * - \ref misc "Miscellaneous"
42 *
43 * \subsection examples Examples
44 * - \ref reader_example1 "Reader"
45 * - \ref reader_example2 "Reader 2"
46 * - \ref rstream_example "Stream Reader"
47 * - \ref writer_example "Writer"
48 * - \ref wstream_example "Stream Writer"
49 * - \ref mc_example "Master Control"
50 * - \ref keyvalue_read_example "KeyValueList - Read"
51 * - \ref keyvalue_write_example "KeyValueList - Write"
52 *
53 * \subsection Contact
54 * - report bugs to andreas.knuepfer@tu-dresden.de
55 * - <a href="http://www.tu-dresden.de/zih/otf">OTF-Home</a>
56 *
57 */
58
59 /**
60 * @file otf.h
61 *
62 * @brief Main include file for applications using OTF.
63 */
64
65
66 /**
67 * \defgroup misc Miscellaneous
68 */
69
70 /**
71 * \defgroup internal Internal Interfaces
72 *
73 * All files in this module contain Interfaces that are not meant to be accessed directly.
74 */
75
76 #ifndef OTF_H
77 #define OTF_H
78
79
80 #include "OTF_Definitions.h"
81 #include "OTF_KeyValue.h"
82 #include "OTF_FileManager.h"
83 #include "OTF_Filenames.h"
84 #include "OTF_HandlerArray.h"
85 #include "OTF_MasterControl.h"
86 #include "OTF_RStream.h"
87 #include "OTF_Reader.h"
88 #include "OTF_WStream.h"
89 #include "OTF_Writer.h"
90
91
92 #endif /* OTF_H */
93
OTF_MasterControl.h
Provides access to process-stream-mapping, which are located in .otf files.
OTF_Reader.h
Transparently reads OTF traces which consist of multiple streams.
OTF_FileManager.h
Manages file handles.
OTF_WStream.h
Provides write access to trace streams, which consist of multiple buffers.
OTF_KeyValue.h
Provides an additional list of key value pairs that can be added to records.
OTF_RStream.h
Provides read access to trace streams, which consist of multiple buffers.
OTF_Definitions.h
Provides many many macros for different purposes.
OTF_Writer.h
Transparently writes OTF traces which consist of multiple streams.
OTF_HandlerArray.h
Provides read access to OTF traces which consist of multiple streams.
OTF_Filenames.h
Handles file naming issues.