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
;
52 struct ctf_stream_event
{
53 struct definition_struct
*event_context
;
54 struct definition_struct
*event_fields
;
57 #define CTF_TRACE_SET_FIELD(ctf_trace, field) \
59 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
62 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
63 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
65 #define CTF_TRACE_GET_FIELD(ctf_trace, field) \
67 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
68 (ctf_trace)->(field); \
73 struct trace_descriptor parent
;
75 struct declaration_scope
*root_declaration_scope
;
77 struct declaration_scope
*declaration_scope
;
78 /* innermost definition scope. to be used as parent of stream. */
79 struct definition_scope
*definition_scope
;
80 GPtrArray
*streams
; /* Array of struct ctf_stream_class pointers */
81 struct ctf_stream
*metadata
;
83 struct declaration_struct
*packet_header_decl
;
88 int byte_order
; /* trace BYTE_ORDER. 0 if unset. */
90 enum { /* Fields populated mask */
91 CTF_TRACE_major
= (1U << 0),
92 CTF_TRACE_minor
= (1U << 1),
93 CTF_TRACE_uuid
= (1U << 2),
94 CTF_TRACE_byte_order
= (1U << 3),
95 CTF_TRACE_packet_header
= (1U << 4),
98 /* Information about trace backing directory and files */
101 int flags
; /* open flags */
103 /* Heap of streams, ordered to always get the lowest timestam */
104 struct ptr_heap
*stream_heap
;
108 #define CTF_STREAM_SET_FIELD(ctf_stream, field) \
110 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
113 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
114 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
116 #define CTF_STREAM_GET_FIELD(ctf_stream, field) \
118 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
119 (ctf_stream)->(field); \
122 struct ctf_stream_class
{
123 struct ctf_trace
*trace
;
124 /* parent is lexical scope conaining the stream scope */
125 struct declaration_scope
*declaration_scope
;
126 /* innermost definition scope. to be used as parent of event. */
127 struct definition_scope
*definition_scope
;
128 GPtrArray
*events_by_id
; /* Array of struct ctf_event pointers indexed by id */
129 GHashTable
*event_quark_to_id
; /* GQuark to numeric id */
131 struct declaration_struct
*packet_context_decl
;
132 struct declaration_struct
*event_header_decl
;
133 struct declaration_struct
*event_context_decl
;
137 enum { /* Fields populated mask */
138 CTF_STREAM_stream_id
= (1 << 0),
141 GPtrArray
*streams
; /* Array of struct ctf_stream pointers */
144 #define CTF_EVENT_SET_FIELD(ctf_event, field) \
146 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
149 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
150 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
152 #define CTF_EVENT_GET_FIELD(ctf_event, field) \
154 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
155 (ctf_event)->(field); \
159 /* stream mapped by stream_id */
160 struct ctf_stream_class
*stream
;
161 /* parent is lexical scope conaining the event scope */
162 struct declaration_scope
*declaration_scope
;
164 struct declaration_struct
*context_decl
;
165 struct declaration_struct
*fields_decl
;
168 uint64_t id
; /* Numeric identifier within the stream */
171 enum { /* Fields populated mask */
172 CTF_EVENT_name
= (1 << 0),
173 CTF_EVENT_id
= (1 << 1),
174 CTF_EVENT_stream_id
= (1 << 2),
178 #endif /* _BABELTRACE_CTF_IR_METADATA_H */