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/ctf/types.h>
33 #include <sys/types.h>
35 #include <babeltrace/uuid.h>
40 struct ctf_stream_declaration
;
41 struct ctf_event_declaration
;
45 struct ctf_stream_definition
{
46 struct ctf_stream_declaration
*stream_class
;
47 uint64_t real_timestamp
; /* Current timestamp, in ns */
48 uint64_t cycles_timestamp
; /* Current timestamp, in cycles */
49 uint64_t event_id
; /* Current event ID */
53 struct definition_struct
*trace_packet_header
;
54 struct definition_struct
*stream_packet_context
;
55 struct definition_struct
*stream_event_header
;
56 struct definition_struct
*stream_event_context
;
57 GPtrArray
*events_by_id
; /* Array of struct ctf_event_definition pointers indexed by id */
58 struct definition_scope
*parent_def_scope
; /* for initialization */
59 int stream_definitions_created
;
61 struct ctf_clock
*current_clock
;
63 /* Event discarded information */
64 uint64_t events_discarded
;
65 uint64_t prev_real_timestamp
; /* Start-of-last-packet timestamp in ns */
66 uint64_t prev_real_timestamp_end
; /* End-of-last-packet timestamp in ns */
67 uint64_t prev_cycles_timestamp
; /* Start-of-last-packet timestamp in cycles */
68 uint64_t prev_cycles_timestamp_end
; /* End-of-last-packet timestamp in cycles */
69 char path
[PATH_MAX
]; /* Path to stream. '\0' for mmap traces */
72 struct ctf_event_definition
{
73 struct ctf_stream_definition
*stream
;
74 struct definition_struct
*event_context
;
75 struct definition_struct
*event_fields
;
78 #define CTF_CLOCK_SET_FIELD(ctf_clock, field) \
80 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field; \
83 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \
84 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
86 #define CTF_CLOCK_GET_FIELD(ctf_clock, field) \
88 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \
89 (ctf_clock)->(field); \
96 uint64_t freq
; /* frequency, in HZ */
97 /* precision in seconds is: precision * (1/freq) */
100 * The offset from Epoch is: offset_s + (offset * (1/freq))
101 * Coarse clock offset from Epoch (in seconds).
104 /* Fine clock offset from Epoch, in (1/freq) units. */
108 enum { /* Fields populated mask */
109 CTF_CLOCK_name
= (1U << 0),
110 CTF_CLOCK_freq
= (1U << 1),
114 #define CTF_CALLSITE_SET_FIELD(ctf_callsite, field) \
116 (ctf_callsite)->field_mask |= CTF_CALLSITE_ ## field; \
119 #define CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field) \
120 ((ctf_callsite)->field_mask & CTF_CALLSITE_ ## field)
122 #define CTF_CALLSITE_GET_FIELD(ctf_callsite, field) \
124 assert(CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field)); \
125 (ctf_callsite)->(field); \
128 struct ctf_callsite
{
129 GQuark name
; /* event name associated with callsite */
134 struct bt_list_head node
;
135 enum { /* Fields populated mask */
136 CTF_CALLSITE_name
= (1U << 0),
137 CTF_CALLSITE_func
= (1U << 1),
138 CTF_CALLSITE_file
= (1U << 2),
139 CTF_CALLSITE_line
= (1U << 3),
140 CTF_CALLSITE_ip
= (1U << 4),
144 struct ctf_callsite_dups
{
145 struct bt_list_head head
;
148 #define CTF_TRACE_SET_FIELD(ctf_trace, field) \
150 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
153 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
154 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
156 #define CTF_TRACE_GET_FIELD(ctf_trace, field) \
158 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
159 (ctf_trace)->(field); \
162 #define TRACER_ENV_LEN 128
164 /* tracer-specific environment */
165 struct ctf_tracer_env
{
166 int vpid
; /* negative if unset */
168 /* All strings below: "" if unset. */
169 char procname
[TRACER_ENV_LEN
];
170 char hostname
[TRACER_ENV_LEN
];
171 char domain
[TRACER_ENV_LEN
];
172 char sysname
[TRACER_ENV_LEN
];
173 char release
[TRACER_ENV_LEN
];
174 char version
[TRACER_ENV_LEN
];
178 struct bt_trace_descriptor parent
;
180 struct declaration_scope
*root_declaration_scope
;
182 struct declaration_scope
*declaration_scope
;
183 /* innermost definition scope. to be used as parent of stream. */
184 struct definition_scope
*definition_scope
;
185 GPtrArray
*streams
; /* Array of struct ctf_stream_declaration pointers */
186 struct ctf_stream_definition
*metadata
;
188 GHashTable
*callsites
;
189 struct ctf_clock
*single_clock
; /* currently supports only one clock */
190 struct trace_collection
*collection
; /* Container of this trace */
191 GPtrArray
*event_declarations
; /* Array of all the struct bt_ctf_event_decl */
193 struct declaration_struct
*packet_header_decl
;
197 unsigned char uuid
[BABELTRACE_UUID_LEN
];
198 int byte_order
; /* trace BYTE_ORDER. 0 if unset. */
199 struct ctf_tracer_env env
;
201 enum { /* Fields populated mask */
202 CTF_TRACE_major
= (1U << 0),
203 CTF_TRACE_minor
= (1U << 1),
204 CTF_TRACE_uuid
= (1U << 2),
205 CTF_TRACE_byte_order
= (1U << 3),
206 CTF_TRACE_packet_header
= (1U << 4),
209 /* Information about trace backing directory and files */
212 int flags
; /* open flags */
214 /* Heap of streams, ordered to always get the lowest timestamp */
215 struct ptr_heap
*stream_heap
;
218 struct bt_context
*ctx
;
219 struct bt_trace_handle
*handle
;
222 #define CTF_STREAM_SET_FIELD(ctf_stream, field) \
224 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
227 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
228 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
230 #define CTF_STREAM_GET_FIELD(ctf_stream, field) \
232 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
233 (ctf_stream)->(field); \
236 struct ctf_stream_declaration
{
237 struct ctf_trace
*trace
;
238 /* parent is lexical scope containing the stream scope */
239 struct declaration_scope
*declaration_scope
;
240 /* innermost definition scope. to be used as parent of event. */
241 struct definition_scope
*definition_scope
;
242 GPtrArray
*events_by_id
; /* Array of struct ctf_event_declaration pointers indexed by id */
243 GHashTable
*event_quark_to_id
; /* GQuark to numeric id */
245 struct declaration_struct
*packet_context_decl
;
246 struct declaration_struct
*event_header_decl
;
247 struct declaration_struct
*event_context_decl
;
251 enum { /* Fields populated mask */
252 CTF_STREAM_stream_id
= (1 << 0),
255 GPtrArray
*streams
; /* Array of struct ctf_stream_definition pointers */
258 #define CTF_EVENT_SET_FIELD(ctf_event, field) \
260 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
263 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
264 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
266 #define CTF_EVENT_GET_FIELD(ctf_event, field) \
268 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
269 (ctf_event)->(field); \
272 struct ctf_event_declaration
{
273 /* stream mapped by stream_id */
274 struct ctf_stream_declaration
*stream
;
275 /* parent is lexical scope containing the event scope */
276 struct declaration_scope
*declaration_scope
;
278 struct declaration_struct
*context_decl
;
279 struct declaration_struct
*fields_decl
;
282 uint64_t id
; /* Numeric identifier within the stream */
285 GQuark model_emf_uri
;
287 enum { /* Fields populated mask */
288 CTF_EVENT_name
= (1 << 0),
289 CTF_EVENT_id
= (1 << 1),
290 CTF_EVENT_stream_id
= (1 << 2),
291 CTF_EVENT_loglevel
= (1 << 4),
292 CTF_EVENT_model_emf_uri
= (1 << 5),
296 #endif /* _BABELTRACE_CTF_IR_METADATA_H */