Commit | Line | Data |
---|---|---|
c054553d MD |
1 | #ifndef _BABELTRACE_CTF_METADATA_H |
2 | #define _BABELTRACE_CTF_METADATA_H | |
3 | ||
4 | /* | |
5 | * BabelTrace | |
6 | * | |
7 | * CTF Metadata Header | |
8 | * | |
9 | * Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
10 | * | |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | */ | |
21 | ||
22 | #include <babeltrace/types.h> | |
46322b33 | 23 | #include <babeltrace/format.h> |
dd2544fd | 24 | #include <babeltrace/ctf/types.h> |
bbefb8dd MD |
25 | #include <sys/types.h> |
26 | #include <dirent.h> | |
96513a7f MD |
27 | #include <uuid/uuid.h> |
28 | #include <assert.h> | |
c054553d MD |
29 | #include <glib.h> |
30 | ||
0f980a35 | 31 | #define CTF_MAGIC 0xC1FC1FC1 |
b4c19c1e | 32 | #define TSDL_MAGIC 0x75D11D57 |
0f980a35 | 33 | |
c054553d | 34 | struct ctf_trace; |
aa6bffae | 35 | struct ctf_stream_class; |
764af3f4 | 36 | struct ctf_stream; |
c054553d MD |
37 | struct ctf_event; |
38 | ||
764af3f4 MD |
39 | struct ctf_stream { |
40 | struct ctf_stream_class *stream_class; | |
41 | uint64_t timestamp; /* Current timestamp, in ns */ | |
42 | }; | |
43 | ||
0f980a35 MD |
44 | struct ctf_file_stream { |
45 | uint64_t stream_id; | |
764af3f4 | 46 | struct ctf_stream stream; |
aa6bffae | 47 | struct ctf_stream_pos pos; /* current stream position */ |
65102a8c MD |
48 | }; |
49 | ||
a0720417 | 50 | #define CTF_TRACE_SET_FIELD(ctf_trace, field) \ |
96513a7f | 51 | do { \ |
96513a7f MD |
52 | (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \ |
53 | } while (0) | |
54 | ||
55 | #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \ | |
56 | ((ctf_trace)->field_mask & CTF_TRACE_ ## field) | |
57 | ||
58 | #define CTF_TRACE_GET_FIELD(ctf_trace, field) \ | |
59 | ({ \ | |
60 | assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \ | |
61 | (ctf_trace)->(field); \ | |
62 | }) | |
63 | ||
05628561 | 64 | |
c054553d | 65 | struct ctf_trace { |
46322b33 | 66 | struct trace_descriptor parent; |
05628561 | 67 | /* root scope */ |
f6625916 | 68 | struct declaration_scope *root_declaration_scope; |
05628561 | 69 | |
f6625916 | 70 | struct declaration_scope *declaration_scope; |
0f980a35 MD |
71 | /* innermost definition scope. to be used as parent of stream. */ |
72 | struct definition_scope *definition_scope; | |
aa6bffae | 73 | GPtrArray *streams; /* Array of struct ctf_stream_class pointers */ |
0f980a35 MD |
74 | struct ctf_file_stream metadata; |
75 | ||
76 | /* Declarations only used when parsing */ | |
77 | struct declaration_struct *packet_header_decl; | |
78 | ||
79 | /* Definitions used afterward */ | |
80 | struct definition_struct *packet_header; | |
fe21b943 MD |
81 | |
82 | uint64_t major; | |
83 | uint64_t minor; | |
96513a7f | 84 | uuid_t uuid; |
0f980a35 | 85 | int byte_order; /* trace BYTE_ORDER. 0 if unset. */ |
96513a7f MD |
86 | |
87 | enum { /* Fields populated mask */ | |
0f980a35 MD |
88 | CTF_TRACE_major = (1U << 0), |
89 | CTF_TRACE_minor = (1U << 1), | |
90 | CTF_TRACE_uuid = (1U << 2), | |
91 | CTF_TRACE_byte_order = (1U << 3), | |
92 | CTF_TRACE_packet_header = (1U << 4), | |
96513a7f | 93 | } field_mask; |
bbefb8dd MD |
94 | |
95 | /* Information about trace backing directory and files */ | |
96 | DIR *dir; | |
65102a8c | 97 | int dirfd; |
bbefb8dd | 98 | int flags; /* open flags */ |
0d0f5149 MD |
99 | |
100 | /* Heap of streams, ordered to always get the lowest timestam */ | |
101 | struct ptr_heap *stream_heap; | |
c054553d MD |
102 | }; |
103 | ||
a0720417 | 104 | #define CTF_STREAM_SET_FIELD(ctf_stream, field) \ |
96513a7f | 105 | do { \ |
96513a7f MD |
106 | (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \ |
107 | } while (0) | |
108 | ||
109 | #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \ | |
110 | ((ctf_stream)->field_mask & CTF_STREAM_ ## field) | |
111 | ||
112 | #define CTF_STREAM_GET_FIELD(ctf_stream, field) \ | |
113 | ({ \ | |
114 | assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \ | |
115 | (ctf_stream)->(field); \ | |
116 | }) | |
117 | ||
aa6bffae | 118 | struct ctf_stream_class { |
96513a7f | 119 | struct ctf_trace *trace; |
05628561 | 120 | /* parent is lexical scope conaining the stream scope */ |
f6625916 | 121 | struct declaration_scope *declaration_scope; |
41253107 | 122 | /* innermost definition scope. to be used as parent of event. */ |
e1151715 | 123 | struct definition_scope *definition_scope; |
05628561 | 124 | GPtrArray *events_by_id; /* Array of struct ctf_event pointers indexed by id */ |
96513a7f | 125 | GHashTable *event_quark_to_id; /* GQuark to numeric id */ |
fe21b943 | 126 | |
9e29e16e MD |
127 | /* Declarations only used when parsing */ |
128 | struct declaration_struct *packet_context_decl; | |
129 | struct declaration_struct *event_header_decl; | |
130 | struct declaration_struct *event_context_decl; | |
131 | ||
132 | /* Definitions used afterward */ | |
133 | struct definition_struct *packet_context; | |
e1151715 MD |
134 | struct definition_struct *event_header; |
135 | struct definition_struct *event_context; | |
96513a7f MD |
136 | |
137 | uint64_t stream_id; | |
138 | ||
139 | enum { /* Fields populated mask */ | |
140 | CTF_STREAM_stream_id = (1 << 0), | |
141 | } field_mask; | |
bbefb8dd | 142 | |
0f980a35 | 143 | GPtrArray *files; /* Array of struct ctf_file_stream pointers */ |
c054553d MD |
144 | }; |
145 | ||
05628561 | 146 | #define CTF_EVENT_SET_FIELD(ctf_event, field) \ |
96513a7f | 147 | do { \ |
96513a7f MD |
148 | (ctf_event)->field_mask |= CTF_EVENT_ ## field; \ |
149 | } while (0) | |
150 | ||
151 | #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \ | |
152 | ((ctf_event)->field_mask & CTF_EVENT_ ## field) | |
153 | ||
154 | #define CTF_EVENT_GET_FIELD(ctf_event, field) \ | |
155 | ({ \ | |
156 | assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \ | |
157 | (ctf_event)->(field); \ | |
158 | }) | |
159 | ||
c054553d | 160 | struct ctf_event { |
05628561 | 161 | /* stream mapped by stream_id */ |
aa6bffae | 162 | struct ctf_stream_class *stream; |
05628561 | 163 | /* parent is lexical scope conaining the event scope */ |
f6625916 | 164 | struct declaration_scope *declaration_scope; |
9e29e16e MD |
165 | |
166 | /* Declarations only used when parsing */ | |
167 | struct declaration_struct *context_decl; | |
168 | struct declaration_struct *fields_decl; | |
169 | ||
170 | /* Definitions used afterward */ | |
e1151715 MD |
171 | struct definition_struct *context; |
172 | struct definition_struct *fields; | |
96513a7f MD |
173 | |
174 | GQuark name; | |
175 | uint64_t id; /* Numeric identifier within the stream */ | |
176 | uint64_t stream_id; | |
177 | ||
178 | enum { /* Fields populated mask */ | |
179 | CTF_EVENT_name = (1 << 0), | |
180 | CTF_EVENT_id = (1 << 1), | |
181 | CTF_EVENT_stream_id = (1 << 2), | |
182 | } field_mask; | |
c054553d MD |
183 | }; |
184 | ||
a91a962e MD |
185 | #define HEADER_END char end_field |
186 | #define header_sizeof(type) offsetof(typeof(type), end_field) | |
187 | ||
b4c19c1e MD |
188 | struct metadata_packet_header { |
189 | uint32_t magic; /* 0x75D11D57 */ | |
190 | uint8_t uuid[16]; /* Unique Universal Identifier */ | |
191 | uint32_t checksum; /* 0 if unused */ | |
192 | uint32_t content_size; /* in bits */ | |
193 | uint32_t packet_size; /* in bits */ | |
194 | uint8_t compression_scheme; /* 0 if unused */ | |
195 | uint8_t encryption_scheme; /* 0 if unused */ | |
196 | uint8_t checksum_scheme; /* 0 if unused */ | |
a91a962e MD |
197 | HEADER_END; |
198 | }; | |
199 | ||
c054553d | 200 | #endif /* _BABELTRACE_CTF_METADATA_H */ |