HPCToolkit
hpcrunflat-fmt.h
Go to the documentation of this file.
1 // -*-Mode: C++;-*- // technically C99
2 
3 // * BeginRiceCopyright *****************************************************
4 //
5 // $HeadURL$
6 // $Id$
7 //
8 // --------------------------------------------------------------------------
9 // Part of HPCToolkit (hpctoolkit.org)
10 //
11 // Information about sources of support for research and development of
12 // HPCToolkit is at 'hpctoolkit.org' and in 'README.Acknowledgments'.
13 // --------------------------------------------------------------------------
14 //
15 // Copyright ((c)) 2002-2019, Rice University
16 // All rights reserved.
17 //
18 // Redistribution and use in source and binary forms, with or without
19 // modification, are permitted provided that the following conditions are
20 // met:
21 //
22 // * Redistributions of source code must retain the above copyright
23 // notice, this list of conditions and the following disclaimer.
24 //
25 // * Redistributions in binary form must reproduce the above copyright
26 // notice, this list of conditions and the following disclaimer in the
27 // documentation and/or other materials provided with the distribution.
28 //
29 // * Neither the name of Rice University (RICE) nor the names of its
30 // contributors may be used to endorse or promote products derived from
31 // this software without specific prior written permission.
32 //
33 // This software is provided by RICE and contributors "as is" and any
34 // express or implied warranties, including, but not limited to, the
35 // implied warranties of merchantability and fitness for a particular
36 // purpose are disclaimed. In no event shall RICE or contributors be
37 // liable for any direct, indirect, incidental, special, exemplary, or
38 // consequential damages (including, but not limited to, procurement of
39 // substitute goods or services; loss of use, data, or profits; or
40 // business interruption) however caused and on any theory of liability,
41 // whether in contract, strict liability, or tort (including negligence
42 // or otherwise) arising in any way out of the use of this software, even
43 // if advised of the possibility of such damage.
44 //
45 // ******************************************************* EndRiceCopyright *
46 
47 /****************************************************************************
48 //
49 // File:
50 // $HeadURL$
51 //
52 // Purpose:
53 // General header.
54 //
55 // Description:
56 // [The set of functions, macros, etc. defined in the file]
57 //
58 // Author:
59 // Written by John Mellor-Crummey and Nathan Tallent, Rice University.
60 //
61 *****************************************************************************/
62 
63 #ifndef prof_lean_hpcfile_hpcrun_h
64 #define prof_lean_hpcfile_hpcrun_h
65 
66 /************************** System Include Files ****************************/
67 
68 /**************************** Forward Declarations **************************/
69 
70 /*
71  File format:
72 
73  <header>
74  <loadmodule_list>
75 
76  ---------------------------------------------------------
77 
78  <header> ::= <magic string><version><endian>
79  <loadmodule_list> ::=
80  <loadmodule_count>
81  <loadmodule_1_data>...<loadmodule_n_data>
82 
83  <loadmodule_x_data> ::=
84  <loadmodule_name>
85  <loadmodule_loadoffset>
86  <loadmodule_eventcount>
87  <event_1_name>
88  <event_1_description>
89  <event_1_period>
90  <event_1_data>
91  ...
92  <event_n_name>
93  <event_n_description>
94  <event_n_period>
95  <event_n_data>
96 
97  ! A sparse representation of the histogram (only non-zero entries)
98  <event_x_data> ::=
99  <histogram_non_zero_bucket_count>
100  <histogram_non_zero_bucket_1_value>
101  <histogram_non_zero_bucket_1_offset> ! in bytes, from load address
102  ...
103  <histogram_non_zero_bucket_n_value>
104  <histogram_non_zero_bucket_n_offset>
105 
106  Note: strings are written without null terminators:
107  <string_length>
108  <string_without_terminator>
109  */
110 
111 /* <header>
112  Because these are byte strings, they will not be affected by endianness */
113 
114 #define HPCRUNFLAT_FMT_Magic "HPCRUN-FLAT_______"
115 #define HPCRUNFLAT_FMT_MagicLen 18 /* exclude '\0' */
116 
117 #define HPCRUNFLAT_Version "01.00"
118 #define HPCRUNFLAT_VersionLen 5 /* exclude '\0' */
119 
120 #define HPCRUNFLAT_FMT_Endian 'l' /* l for little */
121 
122 /****************************************************************************/
123 
124 #endif /* prof_lean_hpcfile_hpcrun_h */