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/uuid.h>
41 struct ctf_stream_declaration
;
42 struct ctf_event_declaration
;
46 struct ctf_stream_definition
{
47 struct ctf_stream_declaration
*stream_class
;
48 uint64_t real_timestamp
; /* Current timestamp, in ns */
49 uint64_t cycles_timestamp
; /* Current timestamp, in cycles */
50 uint64_t event_id
; /* Current event ID */
54 struct definition_struct
*trace_packet_header
;
55 struct definition_struct
*stream_packet_context
;
56 struct definition_struct
*stream_event_header
;
57 struct definition_struct
*stream_event_context
;
58 GPtrArray
*events_by_id
; /* Array of struct ctf_event_definition pointers indexed by id */
59 struct definition_scope
*parent_def_scope
; /* for initialization */
60 int stream_definitions_created
;
62 struct ctf_clock
*current_clock
;
64 /* Event discarded information */
65 uint64_t events_discarded
;
66 uint64_t prev_real_timestamp
; /* Start-of-last-packet timestamp in ns */
67 uint64_t prev_real_timestamp_end
; /* End-of-last-packet timestamp in ns */
68 uint64_t prev_cycles_timestamp
; /* Start-of-last-packet timestamp in cycles */
69 uint64_t prev_cycles_timestamp_end
; /* End-of-last-packet timestamp in cycles */
70 char path
[PATH_MAX
]; /* Path to stream. '\0' for mmap traces */
73 struct ctf_event_definition
{
74 struct ctf_stream_definition
*stream
;
75 struct definition_struct
*event_context
;
76 struct definition_struct
*event_fields
;
79 #define CTF_CLOCK_SET_FIELD(ctf_clock, field) \
81 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field; \
84 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \
85 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
87 #define CTF_CLOCK_GET_FIELD(ctf_clock, field) \
89 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \
90 (ctf_clock)->(field); \
97 uint64_t freq
; /* frequency, in HZ */
98 /* precision in seconds is: precision * (1/freq) */
101 * The offset from Epoch is: offset_s + (offset * (1/freq))
102 * Coarse clock offset from Epoch (in seconds).
105 /* Fine clock offset from Epoch, in (1/freq) units. */
109 enum { /* Fields populated mask */
110 CTF_CLOCK_name
= (1U << 0),
111 CTF_CLOCK_freq
= (1U << 1),
115 #define CTF_CALLSITE_SET_FIELD(ctf_callsite, field) \
117 (ctf_callsite)->field_mask |= CTF_CALLSITE_ ## field; \
120 #define CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field) \
121 ((ctf_callsite)->field_mask & CTF_CALLSITE_ ## field)
123 #define CTF_CALLSITE_GET_FIELD(ctf_callsite, field) \
125 assert(CTF_CALLSITE_FIELD_IS_SET(ctf_callsite, field)); \
126 (ctf_callsite)->(field); \
129 struct ctf_callsite
{
130 GQuark name
; /* event name associated with callsite */
135 struct bt_list_head node
;
136 enum { /* Fields populated mask */
137 CTF_CALLSITE_name
= (1U << 0),
138 CTF_CALLSITE_func
= (1U << 1),
139 CTF_CALLSITE_file
= (1U << 2),
140 CTF_CALLSITE_line
= (1U << 3),
141 CTF_CALLSITE_ip
= (1U << 4),
145 struct ctf_callsite_dups
{
146 struct bt_list_head head
;
149 #define CTF_TRACE_SET_FIELD(ctf_trace, field) \
151 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
154 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
155 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
157 #define CTF_TRACE_GET_FIELD(ctf_trace, field) \
159 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
160 (ctf_trace)->(field); \
163 #define TRACER_ENV_LEN 128
165 /* tracer-specific environment */
166 struct ctf_tracer_env
{
167 int vpid
; /* negative if unset */
169 /* All strings below: "" if unset. */
170 char procname
[TRACER_ENV_LEN
];
171 char hostname
[TRACER_ENV_LEN
];
172 char domain
[TRACER_ENV_LEN
];
173 char sysname
[TRACER_ENV_LEN
];
174 char release
[TRACER_ENV_LEN
];
175 char version
[TRACER_ENV_LEN
];
179 struct bt_trace_descriptor parent
;
182 struct declaration_scope
*root_declaration_scope
;
184 struct declaration_scope
*declaration_scope
;
185 /* innermost definition scope. to be used as parent of stream. */
186 struct definition_scope
*definition_scope
;
187 GPtrArray
*streams
; /* Array of struct ctf_stream_declaration pointers */
188 struct ctf_stream_definition
*metadata
;
189 char *metadata_string
;
190 int metadata_packetized
;
192 GHashTable
*callsites
;
193 struct ctf_clock
*single_clock
; /* currently supports only one clock */
194 struct trace_collection
*collection
; /* Container of this trace */
195 GPtrArray
*event_declarations
; /* Array of all the struct bt_ctf_event_decl */
197 struct declaration_struct
*packet_header_decl
;
201 unsigned char uuid
[BABELTRACE_UUID_LEN
];
202 int byte_order
; /* trace BYTE_ORDER. 0 if unset. */
203 struct ctf_tracer_env env
;
205 enum { /* Fields populated mask */
206 CTF_TRACE_major
= (1U << 0),
207 CTF_TRACE_minor
= (1U << 1),
208 CTF_TRACE_uuid
= (1U << 2),
209 CTF_TRACE_byte_order
= (1U << 3),
210 CTF_TRACE_packet_header
= (1U << 4),
213 /* Information about trace backing directory and files */
216 int flags
; /* open flags */
218 /* Heap of streams, ordered to always get the lowest timestamp */
219 struct ptr_heap
*stream_heap
;
221 struct bt_context
*ctx
;
222 struct bt_trace_handle
*handle
;
225 #define CTF_STREAM_SET_FIELD(ctf_stream, field) \
227 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
230 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
231 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
233 #define CTF_STREAM_GET_FIELD(ctf_stream, field) \
235 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
236 (ctf_stream)->(field); \
239 struct ctf_stream_declaration
{
240 struct ctf_trace
*trace
;
241 /* parent is lexical scope containing the stream scope */
242 struct declaration_scope
*declaration_scope
;
243 /* innermost definition scope. to be used as parent of event. */
244 struct definition_scope
*definition_scope
;
245 GPtrArray
*events_by_id
; /* Array of struct ctf_event_declaration pointers indexed by id */
246 GHashTable
*event_quark_to_id
; /* GQuark to numeric id */
248 struct declaration_struct
*packet_context_decl
;
249 struct declaration_struct
*event_header_decl
;
250 struct declaration_struct
*event_context_decl
;
254 enum { /* Fields populated mask */
255 CTF_STREAM_stream_id
= (1 << 0),
258 GPtrArray
*streams
; /* Array of struct ctf_stream_definition pointers */
261 #define CTF_EVENT_SET_FIELD(ctf_event, field) \
263 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
266 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
267 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
269 #define CTF_EVENT_GET_FIELD(ctf_event, field) \
271 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
272 (ctf_event)->(field); \
275 struct ctf_event_declaration
{
276 /* stream mapped by stream_id */
277 struct ctf_stream_declaration
*stream
;
278 /* parent is lexical scope containing the event scope */
279 struct declaration_scope
*declaration_scope
;
281 struct declaration_struct
*context_decl
;
282 struct declaration_struct
*fields_decl
;
285 uint64_t id
; /* Numeric identifier within the stream */
288 GQuark model_emf_uri
;
290 enum { /* Fields populated mask */
291 CTF_EVENT_name
= (1 << 0),
292 CTF_EVENT_id
= (1 << 1),
293 CTF_EVENT_stream_id
= (1 << 2),
294 CTF_EVENT_loglevel
= (1 << 4),
295 CTF_EVENT_model_emf_uri
= (1 << 5),
299 #endif /* _BABELTRACE_CTF_IR_METADATA_H */