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 */ | |
39 | ||
40 | struct definition_struct *trace_packet_header; | |
41 | struct definition_struct *stream_packet_context; | |
42 | struct definition_struct *stream_event_header; | |
43 | struct definition_struct *stream_event_context; | |
42dc00b7 | 44 | GPtrArray *events_by_id; /* Array of struct ctf_stream_event pointers indexed by id */ |
145b8090 MD |
45 | struct definition_scope *parent_def_scope; /* for initialization */ |
46 | int stream_definitions_created; | |
47 | }; | |
48 | ||
42dc00b7 | 49 | struct ctf_stream_event { |
145b8090 MD |
50 | struct definition_struct *event_context; |
51 | struct definition_struct *event_fields; | |
52 | }; | |
53 | ||
54 | struct ctf_file_stream { | |
55 | uint64_t stream_id; | |
56 | struct ctf_stream stream; | |
57 | struct ctf_stream_pos pos; /* current stream position */ | |
58 | }; | |
59 | ||
60 | #define CTF_TRACE_SET_FIELD(ctf_trace, field) \ | |
61 | do { \ | |
62 | (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \ | |
63 | } while (0) | |
64 | ||
65 | #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \ | |
66 | ((ctf_trace)->field_mask & CTF_TRACE_ ## field) | |
67 | ||
68 | #define CTF_TRACE_GET_FIELD(ctf_trace, field) \ | |
69 | ({ \ | |
70 | assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \ | |
71 | (ctf_trace)->(field); \ | |
72 | }) | |
73 | ||
74 | ||
75 | struct ctf_trace { | |
76 | struct trace_descriptor parent; | |
77 | /* root scope */ | |
78 | struct declaration_scope *root_declaration_scope; | |
79 | ||
80 | struct declaration_scope *declaration_scope; | |
81 | /* innermost definition scope. to be used as parent of stream. */ | |
82 | struct definition_scope *definition_scope; | |
83 | GPtrArray *streams; /* Array of struct ctf_stream_class pointers */ | |
84 | struct ctf_file_stream metadata; | |
85 | ||
86 | /* Declarations only used when parsing */ | |
87 | struct declaration_struct *packet_header_decl; | |
88 | ||
89 | uint64_t major; | |
90 | uint64_t minor; | |
91 | uuid_t uuid; | |
92 | int byte_order; /* trace BYTE_ORDER. 0 if unset. */ | |
93 | ||
94 | enum { /* Fields populated mask */ | |
95 | CTF_TRACE_major = (1U << 0), | |
96 | CTF_TRACE_minor = (1U << 1), | |
97 | CTF_TRACE_uuid = (1U << 2), | |
98 | CTF_TRACE_byte_order = (1U << 3), | |
99 | CTF_TRACE_packet_header = (1U << 4), | |
100 | } field_mask; | |
101 | ||
102 | /* Information about trace backing directory and files */ | |
103 | DIR *dir; | |
104 | int dirfd; | |
105 | int flags; /* open flags */ | |
106 | ||
107 | /* Heap of streams, ordered to always get the lowest timestam */ | |
108 | struct ptr_heap *stream_heap; | |
109 | }; | |
110 | ||
111 | #define CTF_STREAM_SET_FIELD(ctf_stream, field) \ | |
112 | do { \ | |
113 | (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \ | |
114 | } while (0) | |
115 | ||
116 | #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \ | |
117 | ((ctf_stream)->field_mask & CTF_STREAM_ ## field) | |
118 | ||
119 | #define CTF_STREAM_GET_FIELD(ctf_stream, field) \ | |
120 | ({ \ | |
121 | assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \ | |
122 | (ctf_stream)->(field); \ | |
123 | }) | |
124 | ||
125 | struct ctf_stream_class { | |
126 | struct ctf_trace *trace; | |
127 | /* parent is lexical scope conaining the stream scope */ | |
128 | struct declaration_scope *declaration_scope; | |
129 | /* innermost definition scope. to be used as parent of event. */ | |
130 | struct definition_scope *definition_scope; | |
131 | GPtrArray *events_by_id; /* Array of struct ctf_event pointers indexed by id */ | |
132 | GHashTable *event_quark_to_id; /* GQuark to numeric id */ | |
133 | ||
134 | /* Declarations only used when parsing */ | |
135 | struct declaration_struct *packet_context_decl; | |
136 | struct declaration_struct *event_header_decl; | |
137 | struct declaration_struct *event_context_decl; | |
138 | ||
139 | uint64_t stream_id; | |
140 | ||
141 | enum { /* Fields populated mask */ | |
142 | CTF_STREAM_stream_id = (1 << 0), | |
143 | } field_mask; | |
144 | ||
145 | GPtrArray *files; /* Array of struct ctf_file_stream pointers */ | |
146 | }; | |
147 | ||
148 | #define CTF_EVENT_SET_FIELD(ctf_event, field) \ | |
149 | do { \ | |
150 | (ctf_event)->field_mask |= CTF_EVENT_ ## field; \ | |
151 | } while (0) | |
152 | ||
153 | #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \ | |
154 | ((ctf_event)->field_mask & CTF_EVENT_ ## field) | |
155 | ||
156 | #define CTF_EVENT_GET_FIELD(ctf_event, field) \ | |
157 | ({ \ | |
158 | assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \ | |
159 | (ctf_event)->(field); \ | |
160 | }) | |
161 | ||
162 | struct ctf_event { | |
163 | /* stream mapped by stream_id */ | |
164 | struct ctf_stream_class *stream; | |
165 | /* parent is lexical scope conaining the event scope */ | |
166 | struct declaration_scope *declaration_scope; | |
167 | ||
168 | /* Declarations only used when parsing */ | |
169 | struct declaration_struct *context_decl; | |
170 | struct declaration_struct *fields_decl; | |
171 | ||
172 | GQuark name; | |
173 | uint64_t id; /* Numeric identifier within the stream */ | |
174 | uint64_t stream_id; | |
175 | ||
176 | enum { /* Fields populated mask */ | |
177 | CTF_EVENT_name = (1 << 0), | |
178 | CTF_EVENT_id = (1 << 1), | |
179 | CTF_EVENT_stream_id = (1 << 2), | |
180 | } field_mask; | |
181 | }; | |
182 | ||
183 | #endif /* _BABELTRACE_CTF_IR_METADATA_H */ |