Commit | Line | Data |
---|---|---|
145b8090 MD |
1 | #ifndef _BABELTRACE_CTF_IR_METADATA_H |
2 | #define _BABELTRACE_CTF_IR_METADATA_H | |
3 | ||
4 | /* | |
5 | * BabelTrace | |
6 | * | |
7 | * CTF Intermediate Representation Metadata Header | |
8 | * | |
9 | * Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
10 | * | |
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: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | */ | |
21 | ||
22 | #include <babeltrace/types.h> | |
23 | #include <babeltrace/format.h> | |
24 | #include <babeltrace/ctf/types.h> | |
25 | #include <sys/types.h> | |
26 | #include <dirent.h> | |
27 | #include <uuid/uuid.h> | |
28 | #include <assert.h> | |
29 | #include <glib.h> | |
30 | ||
31 | struct ctf_trace; | |
32 | struct ctf_stream_class; | |
33 | struct ctf_stream; | |
34 | struct ctf_event; | |
35 | ||
36 | struct ctf_stream { | |
37 | struct ctf_stream_class *stream_class; | |
38 | uint64_t timestamp; /* Current timestamp, in ns */ | |
661c4ce8 | 39 | uint64_t stream_id; |
145b8090 MD |
40 | |
41 | struct definition_struct *trace_packet_header; | |
42 | struct definition_struct *stream_packet_context; | |
43 | struct definition_struct *stream_event_header; | |
44 | struct definition_struct *stream_event_context; | |
42dc00b7 | 45 | GPtrArray *events_by_id; /* Array of struct ctf_stream_event pointers indexed by id */ |
145b8090 MD |
46 | struct definition_scope *parent_def_scope; /* for initialization */ |
47 | int stream_definitions_created; | |
48 | }; | |
49 | ||
42dc00b7 | 50 | struct ctf_stream_event { |
145b8090 MD |
51 | struct definition_struct *event_context; |
52 | struct definition_struct *event_fields; | |
53 | }; | |
54 | ||
145b8090 MD |
55 | #define CTF_TRACE_SET_FIELD(ctf_trace, field) \ |
56 | do { \ | |
57 | (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \ | |
58 | } while (0) | |
59 | ||
60 | #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \ | |
61 | ((ctf_trace)->field_mask & CTF_TRACE_ ## field) | |
62 | ||
63 | #define CTF_TRACE_GET_FIELD(ctf_trace, field) \ | |
64 | ({ \ | |
65 | assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \ | |
66 | (ctf_trace)->(field); \ | |
67 | }) | |
68 | ||
69 | ||
70 | struct ctf_trace { | |
71 | struct trace_descriptor parent; | |
72 | /* root scope */ | |
73 | struct declaration_scope *root_declaration_scope; | |
74 | ||
75 | struct declaration_scope *declaration_scope; | |
76 | /* innermost definition scope. to be used as parent of stream. */ | |
77 | struct definition_scope *definition_scope; | |
78 | GPtrArray *streams; /* Array of struct ctf_stream_class pointers */ | |
2d0bea29 | 79 | struct ctf_stream *metadata; |
145b8090 MD |
80 | |
81 | /* Declarations only used when parsing */ | |
82 | struct declaration_struct *packet_header_decl; | |
83 | ||
84 | uint64_t major; | |
85 | uint64_t minor; | |
86 | uuid_t uuid; | |
87 | int byte_order; /* trace BYTE_ORDER. 0 if unset. */ | |
88 | ||
89 | enum { /* Fields populated mask */ | |
90 | CTF_TRACE_major = (1U << 0), | |
91 | CTF_TRACE_minor = (1U << 1), | |
92 | CTF_TRACE_uuid = (1U << 2), | |
93 | CTF_TRACE_byte_order = (1U << 3), | |
94 | CTF_TRACE_packet_header = (1U << 4), | |
95 | } field_mask; | |
96 | ||
97 | /* Information about trace backing directory and files */ | |
98 | DIR *dir; | |
99 | int dirfd; | |
100 | int flags; /* open flags */ | |
101 | ||
102 | /* Heap of streams, ordered to always get the lowest timestam */ | |
103 | struct ptr_heap *stream_heap; | |
104 | }; | |
105 | ||
106 | #define CTF_STREAM_SET_FIELD(ctf_stream, field) \ | |
107 | do { \ | |
108 | (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \ | |
109 | } while (0) | |
110 | ||
111 | #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \ | |
112 | ((ctf_stream)->field_mask & CTF_STREAM_ ## field) | |
113 | ||
114 | #define CTF_STREAM_GET_FIELD(ctf_stream, field) \ | |
115 | ({ \ | |
116 | assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \ | |
117 | (ctf_stream)->(field); \ | |
118 | }) | |
119 | ||
120 | struct ctf_stream_class { | |
121 | struct ctf_trace *trace; | |
122 | /* parent is lexical scope conaining the stream scope */ | |
123 | struct declaration_scope *declaration_scope; | |
124 | /* innermost definition scope. to be used as parent of event. */ | |
125 | struct definition_scope *definition_scope; | |
126 | GPtrArray *events_by_id; /* Array of struct ctf_event pointers indexed by id */ | |
127 | GHashTable *event_quark_to_id; /* GQuark to numeric id */ | |
128 | ||
129 | /* Declarations only used when parsing */ | |
130 | struct declaration_struct *packet_context_decl; | |
131 | struct declaration_struct *event_header_decl; | |
132 | struct declaration_struct *event_context_decl; | |
133 | ||
134 | uint64_t stream_id; | |
135 | ||
136 | enum { /* Fields populated mask */ | |
137 | CTF_STREAM_stream_id = (1 << 0), | |
138 | } field_mask; | |
139 | ||
2d0bea29 | 140 | GPtrArray *streams; /* Array of struct ctf_stream pointers */ |
145b8090 MD |
141 | }; |
142 | ||
143 | #define CTF_EVENT_SET_FIELD(ctf_event, field) \ | |
144 | do { \ | |
145 | (ctf_event)->field_mask |= CTF_EVENT_ ## field; \ | |
146 | } while (0) | |
147 | ||
148 | #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \ | |
149 | ((ctf_event)->field_mask & CTF_EVENT_ ## field) | |
150 | ||
151 | #define CTF_EVENT_GET_FIELD(ctf_event, field) \ | |
152 | ({ \ | |
153 | assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \ | |
154 | (ctf_event)->(field); \ | |
155 | }) | |
156 | ||
157 | struct ctf_event { | |
158 | /* stream mapped by stream_id */ | |
159 | struct ctf_stream_class *stream; | |
160 | /* parent is lexical scope conaining the event scope */ | |
161 | struct declaration_scope *declaration_scope; | |
162 | ||
163 | /* Declarations only used when parsing */ | |
164 | struct declaration_struct *context_decl; | |
165 | struct declaration_struct *fields_decl; | |
166 | ||
167 | GQuark name; | |
168 | uint64_t id; /* Numeric identifier within the stream */ | |
169 | uint64_t stream_id; | |
170 | ||
171 | enum { /* Fields populated mask */ | |
172 | CTF_EVENT_name = (1 << 0), | |
173 | CTF_EVENT_id = (1 << 1), | |
174 | CTF_EVENT_stream_id = (1 << 2), | |
175 | } field_mask; | |
176 | }; | |
177 | ||
178 | #endif /* _BABELTRACE_CTF_IR_METADATA_H */ |