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
;
37 struct ctf_stream_class
*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_stream_event pointers indexed by id */
48 struct definition_scope
*parent_def_scope
; /* for initialization */
49 int stream_definitions_created
;
51 /* Event discarded information */
52 uint32_t events_discarded
;
53 uint64_t prev_timestamp
; /* Last event */
54 uint64_t prev_timestamp_end
; /* End-of-packet timestamp */
58 struct ctf_stream_event
{
59 struct definition_struct
*event_context
;
60 struct definition_struct
*event_fields
;
63 #define CTF_CLOCK_SET_FIELD(ctf_clock, field) \
65 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field; \
68 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \
69 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
71 #define CTF_CLOCK_GET_FIELD(ctf_clock, field) \
73 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \
74 (ctf_clock)->(field); \
81 uint64_t freq
; /* frequency, in HZ */
82 /* precision in seconds is: precision * (1/freq) */
85 * The offset from Epoch is: offset_s + (offset * (1/freq))
86 * Coarse clock offset from Epoch (in seconds).
89 /* Fine clock offset from Epoch, in (1/freq) units. */
93 enum { /* Fields populated mask */
94 CTF_CLOCK_name
= (1U << 0),
98 #define CTF_TRACE_SET_FIELD(ctf_trace, field) \
100 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
103 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
104 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
106 #define CTF_TRACE_GET_FIELD(ctf_trace, field) \
108 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
109 (ctf_trace)->(field); \
113 struct trace_descriptor parent
;
115 struct declaration_scope
*root_declaration_scope
;
117 struct declaration_scope
*declaration_scope
;
118 /* innermost definition scope. to be used as parent of stream. */
119 struct definition_scope
*definition_scope
;
120 GPtrArray
*streams
; /* Array of struct ctf_stream_class pointers */
121 struct ctf_stream
*metadata
;
123 struct trace_collection
*collection
; /* Container of this trace */
125 struct declaration_struct
*packet_header_decl
;
130 int byte_order
; /* trace BYTE_ORDER. 0 if unset. */
132 enum { /* Fields populated mask */
133 CTF_TRACE_major
= (1U << 0),
134 CTF_TRACE_minor
= (1U << 1),
135 CTF_TRACE_uuid
= (1U << 2),
136 CTF_TRACE_byte_order
= (1U << 3),
137 CTF_TRACE_packet_header
= (1U << 4),
140 /* Information about trace backing directory and files */
143 int flags
; /* open flags */
145 /* Heap of streams, ordered to always get the lowest timestam */
146 struct ptr_heap
*stream_heap
;
147 char collection_path
[PATH_MAX
];
149 char domain
[PATH_MAX
];
150 char procname
[PATH_MAX
];
154 #define CTF_STREAM_SET_FIELD(ctf_stream, field) \
156 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
159 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
160 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
162 #define CTF_STREAM_GET_FIELD(ctf_stream, field) \
164 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
165 (ctf_stream)->(field); \
168 struct ctf_stream_class
{
169 struct ctf_trace
*trace
;
170 /* parent is lexical scope conaining the stream scope */
171 struct declaration_scope
*declaration_scope
;
172 /* innermost definition scope. to be used as parent of event. */
173 struct definition_scope
*definition_scope
;
174 GPtrArray
*events_by_id
; /* Array of struct ctf_event pointers indexed by id */
175 GHashTable
*event_quark_to_id
; /* GQuark to numeric id */
177 struct declaration_struct
*packet_context_decl
;
178 struct declaration_struct
*event_header_decl
;
179 struct declaration_struct
*event_context_decl
;
183 enum { /* Fields populated mask */
184 CTF_STREAM_stream_id
= (1 << 0),
187 GPtrArray
*streams
; /* Array of struct ctf_stream pointers */
190 #define CTF_EVENT_SET_FIELD(ctf_event, field) \
192 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
195 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
196 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
198 #define CTF_EVENT_GET_FIELD(ctf_event, field) \
200 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
201 (ctf_event)->(field); \
205 /* stream mapped by stream_id */
206 struct ctf_stream_class
*stream
;
207 /* parent is lexical scope conaining the event scope */
208 struct declaration_scope
*declaration_scope
;
210 struct declaration_struct
*context_decl
;
211 struct declaration_struct
*fields_decl
;
214 uint64_t id
; /* Numeric identifier within the stream */
216 GQuark loglevel_identifier
;
217 int64_t loglevel_value
;
219 enum { /* Fields populated mask */
220 CTF_EVENT_name
= (1 << 0),
221 CTF_EVENT_id
= (1 << 1),
222 CTF_EVENT_stream_id
= (1 << 2),
223 CTF_EVENT_loglevel_identifier
= (1 << 3),
224 CTF_EVENT_loglevel_value
= (1 << 4),
228 #endif /* _BABELTRACE_CTF_IR_METADATA_H */