1 #ifndef _BABELTRACE_CTF_IR_METADATA_H
2 #define _BABELTRACE_CTF_IR_METADATA_H
7 * CTF Intermediate Representation Metadata Header
9 * Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 #include <babeltrace/types.h>
31 #include <babeltrace/format.h>
32 #include <babeltrace/format-internal.h>
33 #include <babeltrace/ctf/types.h>
34 #include <sys/types.h>
36 #include <babeltrace/compat/uuid.h>
41 struct ctf_stream_declaration
;
42 struct ctf_event_declaration
;
47 struct ctf_stream_packet_limits
{
52 struct ctf_stream_packet_timestamp
{
53 struct ctf_stream_packet_limits cycles
;
54 struct ctf_stream_packet_limits real
;
57 struct ctf_stream_definition
{
58 struct ctf_stream_declaration
*stream_class
;
59 uint64_t real_timestamp
; /* Current timestamp, in ns */
60 uint64_t cycles_timestamp
; /* Current timestamp, in cycles */
61 uint64_t event_id
; /* Current event ID */
65 struct definition_struct
*trace_packet_header
;
66 struct definition_struct
*stream_packet_context
;
67 struct definition_struct
*stream_event_header
;
68 struct definition_struct
*stream_event_context
;
69 GPtrArray
*events_by_id
; /* Array of struct ctf_event_definition pointers indexed by id */
70 struct definition_scope
*parent_def_scope
; /* for initialization */
71 int stream_definitions_created
;
73 struct ctf_clock
*current_clock
;
75 /* Event discarded information */
76 uint64_t events_discarded
;
77 struct ctf_stream_packet_timestamp prev
;
78 struct ctf_stream_packet_timestamp current
;
79 char path
[PATH_MAX
]; /* Path to stream. '\0' for mmap traces */
82 struct ctf_event_definition
{
83 struct ctf_stream_definition
*stream
;
84 struct definition_struct
*event_context
;
85 struct definition_struct
*event_fields
;
88 #define CTF_CLOCK_SET_FIELD(ctf_clock, field) \
90 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field; \
93 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \
94 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
96 #define CTF_CLOCK_GET_FIELD(ctf_clock, field) \
98 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \
99 (ctf_clock)->(field); \
106 uint64_t freq
; /* frequency, in HZ */
107 /* precision in seconds is: precision * (1/freq) */
110 * The offset from Epoch is: offset_s + (offset * (1/freq))
111 * Coarse clock offset from Epoch (in seconds).
114 /* Fine clock offset from Epoch, in (1/freq) units. */
118 enum { /* Fields populated mask */
119 CTF_CLOCK_name
= (1U << 0),
120 CTF_CLOCK_freq
= (1U << 1),
124 #define CTF_CALLSITE_SET_FIELD(ctf_callsite, field) \
126 (ctf_callsite)->field_mask |= CTF_CALLSITE_ ## field; \
129 #define CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field) \
130 ((ctf_callsite)->field_mask & CTF_CALLSITE_ ## field)
132 #define CTF_CALLSITE_GET_FIELD(ctf_callsite, field) \
134 assert(CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field)); \
135 (ctf_callsite)->(field); \
138 struct ctf_callsite
{
139 GQuark name
; /* event name associated with callsite */
144 struct bt_list_head node
;
145 enum { /* Fields populated mask */
146 CTF_CALLSITE_name
= (1U << 0),
147 CTF_CALLSITE_func
= (1U << 1),
148 CTF_CALLSITE_file
= (1U << 2),
149 CTF_CALLSITE_line
= (1U << 3),
150 CTF_CALLSITE_ip
= (1U << 4),
154 struct ctf_callsite_dups
{
155 struct bt_list_head head
;
158 #define CTF_TRACE_SET_FIELD(ctf_trace, field) \
160 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
163 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
164 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
166 #define CTF_TRACE_GET_FIELD(ctf_trace, field) \
168 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
169 (ctf_trace)->(field); \
172 #define TRACER_ENV_LEN 128
174 /* tracer-specific environment */
175 struct ctf_tracer_env
{
176 int vpid
; /* negative if unset */
178 /* All strings below: "" if unset. */
179 char procname
[TRACER_ENV_LEN
];
180 char hostname
[TRACER_ENV_LEN
];
181 char domain
[TRACER_ENV_LEN
];
182 char sysname
[TRACER_ENV_LEN
];
183 char release
[TRACER_ENV_LEN
];
184 char version
[TRACER_ENV_LEN
];
188 struct bt_trace_descriptor parent
;
191 struct declaration_scope
*root_declaration_scope
;
193 struct declaration_scope
*declaration_scope
;
194 /* innermost definition scope. to be used as parent of stream. */
195 struct definition_scope
*definition_scope
;
196 GPtrArray
*streams
; /* Array of struct ctf_stream_declaration pointers */
197 struct ctf_stream_definition
*metadata
;
198 char *metadata_string
;
199 int metadata_packetized
;
200 GHashTable
*callsites
;
201 GPtrArray
*event_declarations
; /* Array of all the struct bt_ctf_event_decl */
203 struct declaration_struct
*packet_header_decl
;
204 struct ctf_scanner
*scanner
;
205 int restart_root_decl
;
209 unsigned char uuid
[BABELTRACE_UUID_LEN
];
210 int byte_order
; /* trace BYTE_ORDER. 0 if unset. */
211 struct ctf_tracer_env env
;
213 enum { /* Fields populated mask */
214 CTF_TRACE_major
= (1U << 0),
215 CTF_TRACE_minor
= (1U << 1),
216 CTF_TRACE_uuid
= (1U << 2),
217 CTF_TRACE_byte_order
= (1U << 3),
218 CTF_TRACE_packet_header
= (1U << 4),
221 /* Information about trace backing directory and files */
224 int flags
; /* open flags */
227 #define CTF_STREAM_SET_FIELD(ctf_stream, field) \
229 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
232 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
233 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
235 #define CTF_STREAM_GET_FIELD(ctf_stream, field) \
237 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
238 (ctf_stream)->(field); \
241 struct ctf_stream_declaration
{
242 struct ctf_trace
*trace
;
243 /* parent is lexical scope containing the stream scope */
244 struct declaration_scope
*declaration_scope
;
245 /* innermost definition scope. to be used as parent of event. */
246 struct definition_scope
*definition_scope
;
247 GPtrArray
*events_by_id
; /* Array of struct ctf_event_declaration pointers indexed by id */
248 GHashTable
*event_quark_to_id
; /* GQuark to numeric id */
250 struct declaration_struct
*packet_context_decl
;
251 struct declaration_struct
*event_header_decl
;
252 struct declaration_struct
*event_context_decl
;
256 enum { /* Fields populated mask */
257 CTF_STREAM_stream_id
= (1 << 0),
260 GPtrArray
*streams
; /* Array of struct ctf_stream_definition pointers */
263 #define CTF_EVENT_SET_FIELD(ctf_event, field) \
265 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
268 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
269 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
271 #define CTF_EVENT_GET_FIELD(ctf_event, field) \
273 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
274 (ctf_event)->(field); \
277 struct ctf_event_declaration
{
278 /* stream mapped by stream_id */
279 struct ctf_stream_declaration
*stream
;
280 /* parent is lexical scope containing the event scope */
281 struct declaration_scope
*declaration_scope
;
283 struct declaration_struct
*context_decl
;
284 struct declaration_struct
*fields_decl
;
287 uint64_t id
; /* Numeric identifier within the stream */
290 GQuark model_emf_uri
;
292 enum { /* Fields populated mask */
293 CTF_EVENT_name
= (1 << 0),
294 CTF_EVENT_id
= (1 << 1),
295 CTF_EVENT_stream_id
= (1 << 2),
296 CTF_EVENT_loglevel
= (1 << 4),
297 CTF_EVENT_model_emf_uri
= (1 << 5),
301 #endif /* _BABELTRACE_CTF_IR_METADATA_H */