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
;
36 struct ctf_stream_definition
{
37 struct ctf_stream_declaration
*stream_class
;
38 uint64_t timestamp
; /* Current timestamp, in ns */
39 uint64_t event_id
; /* Current event ID */
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
;
47 GPtrArray
*events_by_id
; /* Array of struct ctf_event_definition pointers indexed by id */
48 struct definition_scope
*parent_def_scope
; /* for initialization */
49 int stream_definitions_created
;
51 struct ctf_clock
*current_clock
;
53 /* Event discarded information */
54 uint64_t events_discarded
;
55 uint64_t prev_timestamp
; /* Start-of-last-packet timestamp */
56 uint64_t prev_timestamp_end
; /* End-of-last-packet timestamp */
59 struct ctf_event_definition
{
60 struct ctf_stream_definition
*stream
;
61 struct definition_struct
*event_context
;
62 struct definition_struct
*event_fields
;
65 #define CTF_CLOCK_SET_FIELD(ctf_clock, field) \
67 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field; \
70 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \
71 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
73 #define CTF_CLOCK_GET_FIELD(ctf_clock, field) \
75 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \
76 (ctf_clock)->(field); \
83 uint64_t freq
; /* frequency, in HZ */
84 /* precision in seconds is: precision * (1/freq) */
87 * The offset from Epoch is: offset_s + (offset * (1/freq))
88 * Coarse clock offset from Epoch (in seconds).
91 /* Fine clock offset from Epoch, in (1/freq) units. */
95 enum { /* Fields populated mask */
96 CTF_CLOCK_name
= (1U << 0),
97 CTF_CLOCK_freq
= (1U << 1),
101 #define CTF_TRACE_SET_FIELD(ctf_trace, field) \
103 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
106 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
107 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
109 #define CTF_TRACE_GET_FIELD(ctf_trace, field) \
111 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
112 (ctf_trace)->(field); \
115 #define TRACER_ENV_LEN 128
117 /* tracer-specific environment */
118 struct ctf_tracer_env
{
119 int vpid
; /* negative if unset */
121 /* All strings below: "" if unset. */
122 char procname
[TRACER_ENV_LEN
];
123 char domain
[TRACER_ENV_LEN
];
124 char sysname
[TRACER_ENV_LEN
];
125 char release
[TRACER_ENV_LEN
];
126 char version
[TRACER_ENV_LEN
];
130 struct trace_descriptor parent
;
132 struct declaration_scope
*root_declaration_scope
;
134 struct declaration_scope
*declaration_scope
;
135 /* innermost definition scope. to be used as parent of stream. */
136 struct definition_scope
*definition_scope
;
137 GPtrArray
*streams
; /* Array of struct ctf_stream_declaration pointers */
138 struct ctf_stream_definition
*metadata
;
140 struct ctf_clock
*single_clock
; /* currently supports only one clock */
141 struct trace_collection
*collection
; /* Container of this trace */
142 GPtrArray
*event_declarations
; /* Array of all the struct bt_ctf_event_decl */
144 struct declaration_struct
*packet_header_decl
;
148 unsigned char uuid
[BABELTRACE_UUID_LEN
];
149 int byte_order
; /* trace BYTE_ORDER. 0 if unset. */
150 struct ctf_tracer_env env
;
152 enum { /* Fields populated mask */
153 CTF_TRACE_major
= (1U << 0),
154 CTF_TRACE_minor
= (1U << 1),
155 CTF_TRACE_uuid
= (1U << 2),
156 CTF_TRACE_byte_order
= (1U << 3),
157 CTF_TRACE_packet_header
= (1U << 4),
160 /* Information about trace backing directory and files */
163 int flags
; /* open flags */
165 /* Heap of streams, ordered to always get the lowest timestam */
166 struct ptr_heap
*stream_heap
;
169 struct bt_context
*ctx
;
170 struct bt_trace_handle
*handle
;
173 #define CTF_STREAM_SET_FIELD(ctf_stream, field) \
175 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
178 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
179 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
181 #define CTF_STREAM_GET_FIELD(ctf_stream, field) \
183 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
184 (ctf_stream)->(field); \
187 struct ctf_stream_declaration
{
188 struct ctf_trace
*trace
;
189 /* parent is lexical scope conaining the stream scope */
190 struct declaration_scope
*declaration_scope
;
191 /* innermost definition scope. to be used as parent of event. */
192 struct definition_scope
*definition_scope
;
193 GPtrArray
*events_by_id
; /* Array of struct ctf_event_declaration pointers indexed by id */
194 GHashTable
*event_quark_to_id
; /* GQuark to numeric id */
196 struct declaration_struct
*packet_context_decl
;
197 struct declaration_struct
*event_header_decl
;
198 struct declaration_struct
*event_context_decl
;
202 enum { /* Fields populated mask */
203 CTF_STREAM_stream_id
= (1 << 0),
206 GPtrArray
*streams
; /* Array of struct ctf_stream_definition pointers */
209 #define CTF_EVENT_SET_FIELD(ctf_event, field) \
211 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
214 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
215 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
217 #define CTF_EVENT_GET_FIELD(ctf_event, field) \
219 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
220 (ctf_event)->(field); \
223 struct ctf_event_declaration
{
224 /* stream mapped by stream_id */
225 struct ctf_stream_declaration
*stream
;
226 /* parent is lexical scope conaining the event scope */
227 struct declaration_scope
*declaration_scope
;
229 struct declaration_struct
*context_decl
;
230 struct declaration_struct
*fields_decl
;
233 uint64_t id
; /* Numeric identifier within the stream */
237 enum { /* Fields populated mask */
238 CTF_EVENT_name
= (1 << 0),
239 CTF_EVENT_id
= (1 << 1),
240 CTF_EVENT_stream_id
= (1 << 2),
241 CTF_EVENT_loglevel
= (1 << 4),
245 #endif /* _BABELTRACE_CTF_IR_METADATA_H */