Commit | Line | Data |
---|---|---|
145b8090 MD |
1 | #ifndef _BABELTRACE_CTF_IR_METADATA_H |
2 | #define _BABELTRACE_CTF_IR_METADATA_H | |
3 | ||
4 | /* | |
5 | * BabelTrace | |
6 | * | |
7 | * CTF Intermediate Representation 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> | |
23 | #include <babeltrace/format.h> | |
24 | #include <babeltrace/ctf/types.h> | |
25 | #include <sys/types.h> | |
26 | #include <dirent.h> | |
27 | #include <uuid/uuid.h> | |
28 | #include <assert.h> | |
29 | #include <glib.h> | |
30 | ||
31 | struct ctf_trace; | |
32 | struct ctf_stream_class; | |
33 | struct ctf_stream; | |
34 | struct ctf_event; | |
35 | ||
36 | struct ctf_stream { | |
37 | struct ctf_stream_class *stream_class; | |
38 | uint64_t timestamp; /* Current timestamp, in ns */ | |
c87a8eb2 | 39 | uint64_t event_id; /* Current event ID */ |
5e2eb0ae | 40 | int has_timestamp; |
661c4ce8 | 41 | uint64_t stream_id; |
145b8090 MD |
42 | |
43 | struct definition_struct *trace_packet_header; | |
44 | struct definition_struct *stream_packet_context; | |
45 | struct definition_struct *stream_event_header; | |
46 | struct definition_struct *stream_event_context; | |
42dc00b7 | 47 | GPtrArray *events_by_id; /* Array of struct ctf_stream_event pointers indexed by id */ |
145b8090 MD |
48 | struct definition_scope *parent_def_scope; /* for initialization */ |
49 | int stream_definitions_created; | |
fca04958 MD |
50 | |
51 | /* Event discarded information */ | |
52 | uint32_t events_discarded; | |
3217ac37 MD |
53 | uint64_t prev_timestamp; /* Last event */ |
54 | uint64_t prev_timestamp_end; /* End-of-packet timestamp */ | |
145b8090 MD |
55 | }; |
56 | ||
42dc00b7 | 57 | struct ctf_stream_event { |
145b8090 MD |
58 | struct definition_struct *event_context; |
59 | struct definition_struct *event_fields; | |
60 | }; | |
61 | ||
50cb9c56 MD |
62 | #define CTF_CLOCK_SET_FIELD(ctf_clock, field) \ |
63 | do { \ | |
64 | (ctf_clock)->field_mask |= CTF_CLOCK_ ## field; \ | |
65 | } while (0) | |
66 | ||
67 | #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \ | |
68 | ((ctf_clock)->field_mask & CTF_CLOCK_ ## field) | |
69 | ||
70 | #define CTF_CLOCK_GET_FIELD(ctf_clock, field) \ | |
71 | ({ \ | |
72 | assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \ | |
73 | (ctf_clock)->(field); \ | |
74 | }) | |
75 | ||
76 | struct ctf_clock { | |
77 | GQuark name; | |
78 | GQuark uuid; | |
79 | char *description; | |
80 | uint64_t freq; /* frequency, in HZ */ | |
81 | /* precision in seconds is: precision * (1/freq) */ | |
82 | uint64_t precision; | |
83 | /* | |
84 | * The offset from Epoch is: offset_s + (offset * (1/freq)) | |
85 | * Coarse clock offset from Epoch (in seconds). | |
86 | */ | |
87 | uint64_t offset_s; | |
88 | /* Fine clock offset from Epoch, in (1/freq) units. */ | |
89 | uint64_t offset; | |
11ac6674 | 90 | int absolute; |
50cb9c56 MD |
91 | |
92 | enum { /* Fields populated mask */ | |
93 | CTF_CLOCK_name = (1U << 0), | |
94 | } field_mask; | |
95 | }; | |
96 | ||
145b8090 MD |
97 | #define CTF_TRACE_SET_FIELD(ctf_trace, field) \ |
98 | do { \ | |
99 | (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \ | |
100 | } while (0) | |
101 | ||
102 | #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \ | |
103 | ((ctf_trace)->field_mask & CTF_TRACE_ ## field) | |
104 | ||
105 | #define CTF_TRACE_GET_FIELD(ctf_trace, field) \ | |
106 | ({ \ | |
107 | assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \ | |
108 | (ctf_trace)->(field); \ | |
109 | }) | |
110 | ||
145b8090 MD |
111 | struct ctf_trace { |
112 | struct trace_descriptor parent; | |
113 | /* root scope */ | |
114 | struct declaration_scope *root_declaration_scope; | |
115 | ||
116 | struct declaration_scope *declaration_scope; | |
117 | /* innermost definition scope. to be used as parent of stream. */ | |
118 | struct definition_scope *definition_scope; | |
119 | GPtrArray *streams; /* Array of struct ctf_stream_class pointers */ | |
2d0bea29 | 120 | struct ctf_stream *metadata; |
50cb9c56 | 121 | GHashTable *clocks; |
fa709ab2 | 122 | struct trace_collection *collection; /* Container of this trace */ |
145b8090 | 123 | |
145b8090 MD |
124 | struct declaration_struct *packet_header_decl; |
125 | ||
126 | uint64_t major; | |
127 | uint64_t minor; | |
128 | uuid_t uuid; | |
129 | int byte_order; /* trace BYTE_ORDER. 0 if unset. */ | |
130 | ||
131 | enum { /* Fields populated mask */ | |
132 | CTF_TRACE_major = (1U << 0), | |
133 | CTF_TRACE_minor = (1U << 1), | |
134 | CTF_TRACE_uuid = (1U << 2), | |
135 | CTF_TRACE_byte_order = (1U << 3), | |
136 | CTF_TRACE_packet_header = (1U << 4), | |
137 | } field_mask; | |
138 | ||
139 | /* Information about trace backing directory and files */ | |
140 | DIR *dir; | |
141 | int dirfd; | |
142 | int flags; /* open flags */ | |
143 | ||
144 | /* Heap of streams, ordered to always get the lowest timestam */ | |
145 | struct ptr_heap *stream_heap; | |
8c250d87 | 146 | char collection_path[PATH_MAX]; |
82662ad4 | 147 | char path[PATH_MAX]; |
8c250d87 MD |
148 | char domain[PATH_MAX]; |
149 | char procname[PATH_MAX]; | |
150 | char vpid[PATH_MAX]; | |
145b8090 MD |
151 | }; |
152 | ||
153 | #define CTF_STREAM_SET_FIELD(ctf_stream, field) \ | |
154 | do { \ | |
155 | (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \ | |
156 | } while (0) | |
157 | ||
158 | #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \ | |
159 | ((ctf_stream)->field_mask & CTF_STREAM_ ## field) | |
160 | ||
161 | #define CTF_STREAM_GET_FIELD(ctf_stream, field) \ | |
162 | ({ \ | |
163 | assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \ | |
164 | (ctf_stream)->(field); \ | |
165 | }) | |
166 | ||
167 | struct ctf_stream_class { | |
168 | struct ctf_trace *trace; | |
169 | /* parent is lexical scope conaining the stream scope */ | |
170 | struct declaration_scope *declaration_scope; | |
171 | /* innermost definition scope. to be used as parent of event. */ | |
172 | struct definition_scope *definition_scope; | |
173 | GPtrArray *events_by_id; /* Array of struct ctf_event pointers indexed by id */ | |
174 | GHashTable *event_quark_to_id; /* GQuark to numeric id */ | |
175 | ||
145b8090 MD |
176 | struct declaration_struct *packet_context_decl; |
177 | struct declaration_struct *event_header_decl; | |
178 | struct declaration_struct *event_context_decl; | |
179 | ||
180 | uint64_t stream_id; | |
181 | ||
182 | enum { /* Fields populated mask */ | |
183 | CTF_STREAM_stream_id = (1 << 0), | |
184 | } field_mask; | |
185 | ||
2d0bea29 | 186 | GPtrArray *streams; /* Array of struct ctf_stream pointers */ |
145b8090 MD |
187 | }; |
188 | ||
189 | #define CTF_EVENT_SET_FIELD(ctf_event, field) \ | |
190 | do { \ | |
191 | (ctf_event)->field_mask |= CTF_EVENT_ ## field; \ | |
192 | } while (0) | |
193 | ||
194 | #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \ | |
195 | ((ctf_event)->field_mask & CTF_EVENT_ ## field) | |
196 | ||
197 | #define CTF_EVENT_GET_FIELD(ctf_event, field) \ | |
198 | ({ \ | |
199 | assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \ | |
200 | (ctf_event)->(field); \ | |
201 | }) | |
202 | ||
203 | struct ctf_event { | |
204 | /* stream mapped by stream_id */ | |
205 | struct ctf_stream_class *stream; | |
206 | /* parent is lexical scope conaining the event scope */ | |
207 | struct declaration_scope *declaration_scope; | |
208 | ||
145b8090 MD |
209 | struct declaration_struct *context_decl; |
210 | struct declaration_struct *fields_decl; | |
211 | ||
212 | GQuark name; | |
213 | uint64_t id; /* Numeric identifier within the stream */ | |
214 | uint64_t stream_id; | |
306eeaa6 | 215 | int loglevel; |
145b8090 MD |
216 | |
217 | enum { /* Fields populated mask */ | |
d86d62f8 MD |
218 | CTF_EVENT_name = (1 << 0), |
219 | CTF_EVENT_id = (1 << 1), | |
220 | CTF_EVENT_stream_id = (1 << 2), | |
306eeaa6 | 221 | CTF_EVENT_loglevel = (1 << 4), |
145b8090 MD |
222 | } field_mask; |
223 | }; | |
224 | ||
225 | #endif /* _BABELTRACE_CTF_IR_METADATA_H */ |