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 <uuid/uuid.h>
32 struct ctf_stream_class
;
39 struct ctf_stream_class
*stream_class
;
40 uint64_t timestamp
; /* Current timestamp, in ns */
41 uint64_t event_id
; /* Current event ID */
44 int consumed
; /* Last packet used by caller */
46 struct definition_struct
*trace_packet_header
;
47 struct definition_struct
*stream_packet_context
;
48 struct definition_struct
*stream_event_header
;
49 struct definition_struct
*stream_event_context
;
50 GPtrArray
*events_by_id
; /* Array of struct ctf_stream_event pointers indexed by id */
51 struct definition_scope
*parent_def_scope
; /* for initialization */
52 int stream_definitions_created
;
54 struct ctf_clock
*current_clock
;
56 /* Event discarded information */
57 uint32_t events_discarded
;
58 uint64_t prev_timestamp
; /* Last event */
59 uint64_t prev_timestamp_end
; /* End-of-packet timestamp */
62 struct ctf_stream_event
{
63 struct definition_struct
*event_context
;
64 struct definition_struct
*event_fields
;
67 #define CTF_CLOCK_SET_FIELD(ctf_clock, field) \
69 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field; \
72 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \
73 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
75 #define CTF_CLOCK_GET_FIELD(ctf_clock, field) \
77 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \
78 (ctf_clock)->(field); \
85 uint64_t freq
; /* frequency, in HZ */
86 /* precision in seconds is: precision * (1/freq) */
89 * The offset from Epoch is: offset_s + (offset * (1/freq))
90 * Coarse clock offset from Epoch (in seconds).
93 /* Fine clock offset from Epoch, in (1/freq) units. */
97 enum { /* Fields populated mask */
98 CTF_CLOCK_name
= (1U << 0),
99 CTF_CLOCK_freq
= (1U << 1),
103 #define CTF_TRACE_SET_FIELD(ctf_trace, field) \
105 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
108 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
109 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
111 #define CTF_TRACE_GET_FIELD(ctf_trace, field) \
113 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
114 (ctf_trace)->(field); \
117 #define TRACER_ENV_LEN 128
119 /* tracer-specific environment */
120 struct ctf_tracer_env
{
121 int vpid
; /* negative if unset */
123 /* All strings below: "" if unset. */
124 char procname
[TRACER_ENV_LEN
];
125 char domain
[TRACER_ENV_LEN
];
126 char sysname
[TRACER_ENV_LEN
];
127 char release
[TRACER_ENV_LEN
];
128 char version
[TRACER_ENV_LEN
];
132 struct trace_descriptor parent
;
134 struct declaration_scope
*root_declaration_scope
;
136 struct declaration_scope
*declaration_scope
;
137 /* innermost definition scope. to be used as parent of stream. */
138 struct definition_scope
*definition_scope
;
139 GPtrArray
*streams
; /* Array of struct ctf_stream_class pointers */
140 struct ctf_stream
*metadata
;
142 struct ctf_clock
*single_clock
; /* currently supports only one clock */
143 struct trace_collection
*collection
; /* Container of this trace */
145 struct declaration_struct
*packet_header_decl
;
150 int byte_order
; /* trace BYTE_ORDER. 0 if unset. */
151 struct ctf_tracer_env env
;
153 enum { /* Fields populated mask */
154 CTF_TRACE_major
= (1U << 0),
155 CTF_TRACE_minor
= (1U << 1),
156 CTF_TRACE_uuid
= (1U << 2),
157 CTF_TRACE_byte_order
= (1U << 3),
158 CTF_TRACE_packet_header
= (1U << 4),
161 /* Information about trace backing directory and files */
164 int flags
; /* open flags */
166 /* Heap of streams, ordered to always get the lowest timestam */
167 struct ptr_heap
*stream_heap
;
171 #define CTF_STREAM_SET_FIELD(ctf_stream, field) \
173 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
176 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
177 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
179 #define CTF_STREAM_GET_FIELD(ctf_stream, field) \
181 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
182 (ctf_stream)->(field); \
185 struct ctf_stream_class
{
186 struct ctf_trace
*trace
;
187 /* parent is lexical scope conaining the stream scope */
188 struct declaration_scope
*declaration_scope
;
189 /* innermost definition scope. to be used as parent of event. */
190 struct definition_scope
*definition_scope
;
191 GPtrArray
*events_by_id
; /* Array of struct ctf_event pointers indexed by id */
192 GHashTable
*event_quark_to_id
; /* GQuark to numeric id */
194 struct declaration_struct
*packet_context_decl
;
195 struct declaration_struct
*event_header_decl
;
196 struct declaration_struct
*event_context_decl
;
200 enum { /* Fields populated mask */
201 CTF_STREAM_stream_id
= (1 << 0),
204 GPtrArray
*streams
; /* Array of struct ctf_stream pointers */
207 #define CTF_EVENT_SET_FIELD(ctf_event, field) \
209 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
212 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
213 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
215 #define CTF_EVENT_GET_FIELD(ctf_event, field) \
217 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
218 (ctf_event)->(field); \
222 /* stream mapped by stream_id */
223 struct ctf_stream_class
*stream
;
224 /* parent is lexical scope conaining the event scope */
225 struct declaration_scope
*declaration_scope
;
227 struct declaration_struct
*context_decl
;
228 struct declaration_struct
*fields_decl
;
231 uint64_t id
; /* Numeric identifier within the stream */
235 enum { /* Fields populated mask */
236 CTF_EVENT_name
= (1 << 0),
237 CTF_EVENT_id
= (1 << 1),
238 CTF_EVENT_stream_id
= (1 << 2),
239 CTF_EVENT_loglevel
= (1 << 4),
243 #endif /* _BABELTRACE_CTF_IR_METADATA_H */