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 prev_timestamp
;
40 uint64_t event_id
; /* Current event ID */
44 struct definition_struct
*trace_packet_header
;
45 struct definition_struct
*stream_packet_context
;
46 struct definition_struct
*stream_event_header
;
47 struct definition_struct
*stream_event_context
;
48 GPtrArray
*events_by_id
; /* Array of struct ctf_stream_event pointers indexed by id */
49 struct definition_scope
*parent_def_scope
; /* for initialization */
50 int stream_definitions_created
;
52 /* Event discarded information */
53 uint32_t events_discarded
;
57 struct ctf_stream_event
{
58 struct definition_struct
*event_context
;
59 struct definition_struct
*event_fields
;
62 #define CTF_CLOCK_SET_FIELD(ctf_clock, field) \
64 (ctf_clock)->field_mask |= CTF_CLOCK_ ## field; \
67 #define CTF_CLOCK_FIELD_IS_SET(ctf_clock, field) \
68 ((ctf_clock)->field_mask & CTF_CLOCK_ ## field)
70 #define CTF_CLOCK_GET_FIELD(ctf_clock, field) \
72 assert(CTF_CLOCK_FIELD_IS_SET(ctf_clock, field)); \
73 (ctf_clock)->(field); \
80 uint64_t freq
; /* frequency, in HZ */
81 /* precision in seconds is: precision * (1/freq) */
84 * The offset from Epoch is: offset_s + (offset * (1/freq))
85 * Coarse clock offset from Epoch (in seconds).
88 /* Fine clock offset from Epoch, in (1/freq) units. */
92 enum { /* Fields populated mask */
93 CTF_CLOCK_name
= (1U << 0),
97 #define CTF_TRACE_SET_FIELD(ctf_trace, field) \
99 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
102 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
103 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
105 #define CTF_TRACE_GET_FIELD(ctf_trace, field) \
107 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
108 (ctf_trace)->(field); \
112 struct trace_descriptor parent
;
114 struct declaration_scope
*root_declaration_scope
;
116 struct declaration_scope
*declaration_scope
;
117 /* innermost definition scope. to be used as parent of stream. */
118 struct definition_scope
*definition_scope
;
119 GPtrArray
*streams
; /* Array of struct ctf_stream_class pointers */
120 struct ctf_stream
*metadata
;
122 struct trace_collection
*collection
; /* Container of this trace */
124 struct declaration_struct
*packet_header_decl
;
129 int byte_order
; /* trace BYTE_ORDER. 0 if unset. */
131 enum { /* Fields populated mask */
132 CTF_TRACE_major
= (1U << 0),
133 CTF_TRACE_minor
= (1U << 1),
134 CTF_TRACE_uuid
= (1U << 2),
135 CTF_TRACE_byte_order
= (1U << 3),
136 CTF_TRACE_packet_header
= (1U << 4),
139 /* Information about trace backing directory and files */
142 int flags
; /* open flags */
144 /* Heap of streams, ordered to always get the lowest timestam */
145 struct ptr_heap
*stream_heap
;
146 char collection_path
[PATH_MAX
];
148 char domain
[PATH_MAX
];
149 char procname
[PATH_MAX
];
153 #define CTF_STREAM_SET_FIELD(ctf_stream, field) \
155 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
158 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
159 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
161 #define CTF_STREAM_GET_FIELD(ctf_stream, field) \
163 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
164 (ctf_stream)->(field); \
167 struct ctf_stream_class
{
168 struct ctf_trace
*trace
;
169 /* parent is lexical scope conaining the stream scope */
170 struct declaration_scope
*declaration_scope
;
171 /* innermost definition scope. to be used as parent of event. */
172 struct definition_scope
*definition_scope
;
173 GPtrArray
*events_by_id
; /* Array of struct ctf_event pointers indexed by id */
174 GHashTable
*event_quark_to_id
; /* GQuark to numeric id */
176 struct declaration_struct
*packet_context_decl
;
177 struct declaration_struct
*event_header_decl
;
178 struct declaration_struct
*event_context_decl
;
182 enum { /* Fields populated mask */
183 CTF_STREAM_stream_id
= (1 << 0),
186 GPtrArray
*streams
; /* Array of struct ctf_stream pointers */
189 #define CTF_EVENT_SET_FIELD(ctf_event, field) \
191 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
194 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
195 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
197 #define CTF_EVENT_GET_FIELD(ctf_event, field) \
199 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
200 (ctf_event)->(field); \
204 /* stream mapped by stream_id */
205 struct ctf_stream_class
*stream
;
206 /* parent is lexical scope conaining the event scope */
207 struct declaration_scope
*declaration_scope
;
209 struct declaration_struct
*context_decl
;
210 struct declaration_struct
*fields_decl
;
213 uint64_t id
; /* Numeric identifier within the stream */
215 GQuark loglevel_identifier
;
216 int64_t loglevel_value
;
218 enum { /* Fields populated mask */
219 CTF_EVENT_name
= (1 << 0),
220 CTF_EVENT_id
= (1 << 1),
221 CTF_EVENT_stream_id
= (1 << 2),
222 CTF_EVENT_loglevel_identifier
= (1 << 3),
223 CTF_EVENT_loglevel_value
= (1 << 4),
227 #endif /* _BABELTRACE_CTF_IR_METADATA_H */