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 | ||
cadd09e9 MD |
111 | #define TRACER_ENV_LEN 128 |
112 | ||
113 | /* tracer-specific environment */ | |
114 | struct ctf_tracer_env { | |
115 | int vpid; /* negative if unset */ | |
116 | ||
117 | /* All strings below: "" if unset. */ | |
118 | char procname[TRACER_ENV_LEN]; | |
119 | char domain[TRACER_ENV_LEN]; | |
120 | char sysname[TRACER_ENV_LEN]; | |
121 | char release[TRACER_ENV_LEN]; | |
122 | char version[TRACER_ENV_LEN]; | |
123 | }; | |
124 | ||
145b8090 MD |
125 | struct ctf_trace { |
126 | struct trace_descriptor parent; | |
127 | /* root scope */ | |
128 | struct declaration_scope *root_declaration_scope; | |
129 | ||
130 | struct declaration_scope *declaration_scope; | |
131 | /* innermost definition scope. to be used as parent of stream. */ | |
132 | struct definition_scope *definition_scope; | |
133 | GPtrArray *streams; /* Array of struct ctf_stream_class pointers */ | |
2d0bea29 | 134 | struct ctf_stream *metadata; |
50cb9c56 | 135 | GHashTable *clocks; |
fa709ab2 | 136 | struct trace_collection *collection; /* Container of this trace */ |
145b8090 | 137 | |
145b8090 MD |
138 | struct declaration_struct *packet_header_decl; |
139 | ||
140 | uint64_t major; | |
141 | uint64_t minor; | |
142 | uuid_t uuid; | |
143 | int byte_order; /* trace BYTE_ORDER. 0 if unset. */ | |
cadd09e9 | 144 | struct ctf_tracer_env env; |
145b8090 MD |
145 | |
146 | enum { /* Fields populated mask */ | |
147 | CTF_TRACE_major = (1U << 0), | |
148 | CTF_TRACE_minor = (1U << 1), | |
149 | CTF_TRACE_uuid = (1U << 2), | |
150 | CTF_TRACE_byte_order = (1U << 3), | |
151 | CTF_TRACE_packet_header = (1U << 4), | |
152 | } field_mask; | |
153 | ||
154 | /* Information about trace backing directory and files */ | |
155 | DIR *dir; | |
156 | int dirfd; | |
157 | int flags; /* open flags */ | |
158 | ||
159 | /* Heap of streams, ordered to always get the lowest timestam */ | |
160 | struct ptr_heap *stream_heap; | |
82662ad4 | 161 | char path[PATH_MAX]; |
145b8090 MD |
162 | }; |
163 | ||
164 | #define CTF_STREAM_SET_FIELD(ctf_stream, field) \ | |
165 | do { \ | |
166 | (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \ | |
167 | } while (0) | |
168 | ||
169 | #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \ | |
170 | ((ctf_stream)->field_mask & CTF_STREAM_ ## field) | |
171 | ||
172 | #define CTF_STREAM_GET_FIELD(ctf_stream, field) \ | |
173 | ({ \ | |
174 | assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \ | |
175 | (ctf_stream)->(field); \ | |
176 | }) | |
177 | ||
178 | struct ctf_stream_class { | |
179 | struct ctf_trace *trace; | |
180 | /* parent is lexical scope conaining the stream scope */ | |
181 | struct declaration_scope *declaration_scope; | |
182 | /* innermost definition scope. to be used as parent of event. */ | |
183 | struct definition_scope *definition_scope; | |
184 | GPtrArray *events_by_id; /* Array of struct ctf_event pointers indexed by id */ | |
185 | GHashTable *event_quark_to_id; /* GQuark to numeric id */ | |
186 | ||
145b8090 MD |
187 | struct declaration_struct *packet_context_decl; |
188 | struct declaration_struct *event_header_decl; | |
189 | struct declaration_struct *event_context_decl; | |
190 | ||
191 | uint64_t stream_id; | |
192 | ||
193 | enum { /* Fields populated mask */ | |
194 | CTF_STREAM_stream_id = (1 << 0), | |
195 | } field_mask; | |
196 | ||
2d0bea29 | 197 | GPtrArray *streams; /* Array of struct ctf_stream pointers */ |
145b8090 MD |
198 | }; |
199 | ||
200 | #define CTF_EVENT_SET_FIELD(ctf_event, field) \ | |
201 | do { \ | |
202 | (ctf_event)->field_mask |= CTF_EVENT_ ## field; \ | |
203 | } while (0) | |
204 | ||
205 | #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \ | |
206 | ((ctf_event)->field_mask & CTF_EVENT_ ## field) | |
207 | ||
208 | #define CTF_EVENT_GET_FIELD(ctf_event, field) \ | |
209 | ({ \ | |
210 | assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \ | |
211 | (ctf_event)->(field); \ | |
212 | }) | |
213 | ||
214 | struct ctf_event { | |
215 | /* stream mapped by stream_id */ | |
216 | struct ctf_stream_class *stream; | |
217 | /* parent is lexical scope conaining the event scope */ | |
218 | struct declaration_scope *declaration_scope; | |
219 | ||
145b8090 MD |
220 | struct declaration_struct *context_decl; |
221 | struct declaration_struct *fields_decl; | |
222 | ||
223 | GQuark name; | |
224 | uint64_t id; /* Numeric identifier within the stream */ | |
225 | uint64_t stream_id; | |
306eeaa6 | 226 | int loglevel; |
145b8090 MD |
227 | |
228 | enum { /* Fields populated mask */ | |
d86d62f8 MD |
229 | CTF_EVENT_name = (1 << 0), |
230 | CTF_EVENT_id = (1 << 1), | |
231 | CTF_EVENT_stream_id = (1 << 2), | |
306eeaa6 | 232 | CTF_EVENT_loglevel = (1 << 4), |
145b8090 MD |
233 | } field_mask; |
234 | }; | |
235 | ||
236 | #endif /* _BABELTRACE_CTF_IR_METADATA_H */ |