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.
22 #include <babeltrace/types.h>
23 #include <babeltrace/format.h>
24 #include <babeltrace/ctf/types.h>
25 #include <sys/types.h>
27 #include <babeltrace/uuid.h>
32 struct ctf_stream_declaration
;
33 struct ctf_event_declaration
;
37 struct ctf_stream_definition
{
38 struct ctf_stream_declaration
*stream_class
;
39 uint64_t real_timestamp
; /* Current timestamp, in ns */
40 uint64_t cycles_timestamp
; /* Current timestamp, in cycles */
41 uint64_t event_id
; /* Current event ID */
45 struct definition_struct
*trace_packet_header
;
46 struct definition_struct
*stream_packet_context
;
47 struct definition_struct
*stream_event_header
;
48 struct definition_struct
*stream_event_context
;
49 GPtrArray
*events_by_id
; /* Array of struct ctf_event_definition pointers indexed by id */
50 struct definition_scope
*parent_def_scope
; /* for initialization */
51 int stream_definitions_created
;
53 struct ctf_clock
*current_clock
;
55 /* Event discarded information */
56 uint64_t events_discarded
;
57 uint64_t prev_real_timestamp
; /* Start-of-last-packet timestamp in ns */
58 uint64_t prev_real_timestamp_end
; /* End-of-last-packet timestamp in ns */
59 uint64_t prev_cycles_timestamp
; /* Start-of-last-packet timestamp in cycles */
60 uint64_t prev_cycles_timestamp_end
; /* End-of-last-packet timestamp in cycles */
63 struct ctf_event_definition
{
64 struct ctf_stream_definition
*stream
;
65 struct definition_struct
*event_context
;
66 struct definition_struct
*event_fields
;
69 #define CTF_CLOCK_SET_FIELD(ctf_clock, field) \
71 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field; \
74 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \
75 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
77 #define CTF_CLOCK_GET_FIELD(ctf_clock, field) \
79 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \
80 (ctf_clock)->(field); \
87 uint64_t freq
; /* frequency, in HZ */
88 /* precision in seconds is: precision * (1/freq) */
91 * The offset from Epoch is: offset_s + (offset * (1/freq))
92 * Coarse clock offset from Epoch (in seconds).
95 /* Fine clock offset from Epoch, in (1/freq) units. */
99 enum { /* Fields populated mask */
100 CTF_CLOCK_name
= (1U << 0),
101 CTF_CLOCK_freq
= (1U << 1),
105 #define CTF_CALLSITE_SET_FIELD(ctf_callsite, field) \
107 (ctf_callsite)->field_mask |= CTF_CALLSITE_ ## field; \
110 #define CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field) \
111 ((ctf_callsite)->field_mask & CTF_CALLSITE_ ## field)
113 #define CTF_CALLSITE_GET_FIELD(ctf_callsite, field) \
115 assert(CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field)); \
116 (ctf_callsite)->(field); \
119 struct ctf_callsite
{
120 GQuark name
; /* event name associated with callsite */
125 struct bt_list_head node
;
126 enum { /* Fields populated mask */
127 CTF_CALLSITE_name
= (1U << 0),
128 CTF_CALLSITE_func
= (1U << 1),
129 CTF_CALLSITE_file
= (1U << 2),
130 CTF_CALLSITE_line
= (1U << 3),
131 CTF_CALLSITE_ip
= (1U << 4),
135 struct ctf_callsite_dups
{
136 struct bt_list_head head
;
139 #define CTF_TRACE_SET_FIELD(ctf_trace, field) \
141 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
144 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
145 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
147 #define CTF_TRACE_GET_FIELD(ctf_trace, field) \
149 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
150 (ctf_trace)->(field); \
153 #define TRACER_ENV_LEN 128
155 /* tracer-specific environment */
156 struct ctf_tracer_env
{
157 int vpid
; /* negative if unset */
159 /* All strings below: "" if unset. */
160 char procname
[TRACER_ENV_LEN
];
161 char hostname
[TRACER_ENV_LEN
];
162 char domain
[TRACER_ENV_LEN
];
163 char sysname
[TRACER_ENV_LEN
];
164 char release
[TRACER_ENV_LEN
];
165 char version
[TRACER_ENV_LEN
];
169 struct trace_descriptor parent
;
171 struct declaration_scope
*root_declaration_scope
;
173 struct declaration_scope
*declaration_scope
;
174 /* innermost definition scope. to be used as parent of stream. */
175 struct definition_scope
*definition_scope
;
176 GPtrArray
*streams
; /* Array of struct ctf_stream_declaration pointers */
177 struct ctf_stream_definition
*metadata
;
179 GHashTable
*callsites
;
180 struct ctf_clock
*single_clock
; /* currently supports only one clock */
181 struct trace_collection
*collection
; /* Container of this trace */
182 GPtrArray
*event_declarations
; /* Array of all the struct bt_ctf_event_decl */
184 struct declaration_struct
*packet_header_decl
;
188 unsigned char uuid
[BABELTRACE_UUID_LEN
];
189 int byte_order
; /* trace BYTE_ORDER. 0 if unset. */
190 struct ctf_tracer_env env
;
192 enum { /* Fields populated mask */
193 CTF_TRACE_major
= (1U << 0),
194 CTF_TRACE_minor
= (1U << 1),
195 CTF_TRACE_uuid
= (1U << 2),
196 CTF_TRACE_byte_order
= (1U << 3),
197 CTF_TRACE_packet_header
= (1U << 4),
200 /* Information about trace backing directory and files */
203 int flags
; /* open flags */
205 /* Heap of streams, ordered to always get the lowest timestam */
206 struct ptr_heap
*stream_heap
;
209 struct bt_context
*ctx
;
210 struct bt_trace_handle
*handle
;
213 #define CTF_STREAM_SET_FIELD(ctf_stream, field) \
215 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
218 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
219 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
221 #define CTF_STREAM_GET_FIELD(ctf_stream, field) \
223 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
224 (ctf_stream)->(field); \
227 struct ctf_stream_declaration
{
228 struct ctf_trace
*trace
;
229 /* parent is lexical scope conaining the stream scope */
230 struct declaration_scope
*declaration_scope
;
231 /* innermost definition scope. to be used as parent of event. */
232 struct definition_scope
*definition_scope
;
233 GPtrArray
*events_by_id
; /* Array of struct ctf_event_declaration pointers indexed by id */
234 GHashTable
*event_quark_to_id
; /* GQuark to numeric id */
236 struct declaration_struct
*packet_context_decl
;
237 struct declaration_struct
*event_header_decl
;
238 struct declaration_struct
*event_context_decl
;
242 enum { /* Fields populated mask */
243 CTF_STREAM_stream_id
= (1 << 0),
246 GPtrArray
*streams
; /* Array of struct ctf_stream_definition pointers */
249 #define CTF_EVENT_SET_FIELD(ctf_event, field) \
251 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
254 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
255 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
257 #define CTF_EVENT_GET_FIELD(ctf_event, field) \
259 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
260 (ctf_event)->(field); \
263 struct ctf_event_declaration
{
264 /* stream mapped by stream_id */
265 struct ctf_stream_declaration
*stream
;
266 /* parent is lexical scope conaining the event scope */
267 struct declaration_scope
*declaration_scope
;
269 struct declaration_struct
*context_decl
;
270 struct declaration_struct
*fields_decl
;
273 uint64_t id
; /* Numeric identifier within the stream */
276 GQuark model_emf_uri
;
278 enum { /* Fields populated mask */
279 CTF_EVENT_name
= (1 << 0),
280 CTF_EVENT_id
= (1 << 1),
281 CTF_EVENT_stream_id
= (1 << 2),
282 CTF_EVENT_loglevel
= (1 << 4),
283 CTF_EVENT_model_emf_uri
= (1 << 5),
287 #endif /* _BABELTRACE_CTF_IR_METADATA_H */