Commit | Line | Data |
---|---|---|
c054553d MD |
1 | #ifndef _BABELTRACE_CTF_METADATA_H |
2 | #define _BABELTRACE_CTF_METADATA_H | |
3 | ||
4 | /* | |
5 | * BabelTrace | |
6 | * | |
7 | * CTF 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> | |
46322b33 | 23 | #include <babeltrace/format.h> |
dd2544fd | 24 | #include <babeltrace/ctf/types.h> |
bbefb8dd MD |
25 | #include <sys/types.h> |
26 | #include <dirent.h> | |
96513a7f MD |
27 | #include <uuid/uuid.h> |
28 | #include <assert.h> | |
c054553d MD |
29 | #include <glib.h> |
30 | ||
0f980a35 MD |
31 | #define CTF_MAGIC 0xC1FC1FC1 |
32 | ||
c054553d | 33 | struct ctf_trace; |
aa6bffae | 34 | struct ctf_stream_class; |
764af3f4 | 35 | struct ctf_stream; |
c054553d MD |
36 | struct ctf_event; |
37 | ||
764af3f4 MD |
38 | struct ctf_stream { |
39 | struct ctf_stream_class *stream_class; | |
40 | uint64_t timestamp; /* Current timestamp, in ns */ | |
41 | }; | |
42 | ||
0f980a35 MD |
43 | struct ctf_file_stream { |
44 | uint64_t stream_id; | |
764af3f4 | 45 | struct ctf_stream stream; |
aa6bffae | 46 | struct ctf_stream_pos pos; /* current stream position */ |
65102a8c MD |
47 | }; |
48 | ||
a0720417 | 49 | #define CTF_TRACE_SET_FIELD(ctf_trace, field) \ |
96513a7f | 50 | do { \ |
96513a7f MD |
51 | (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \ |
52 | } while (0) | |
53 | ||
54 | #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \ | |
55 | ((ctf_trace)->field_mask & CTF_TRACE_ ## field) | |
56 | ||
57 | #define CTF_TRACE_GET_FIELD(ctf_trace, field) \ | |
58 | ({ \ | |
59 | assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \ | |
60 | (ctf_trace)->(field); \ | |
61 | }) | |
62 | ||
05628561 | 63 | |
c054553d | 64 | struct ctf_trace { |
46322b33 | 65 | struct trace_descriptor parent; |
05628561 | 66 | /* root scope */ |
f6625916 | 67 | struct declaration_scope *root_declaration_scope; |
05628561 | 68 | |
f6625916 | 69 | struct declaration_scope *declaration_scope; |
0f980a35 MD |
70 | /* innermost definition scope. to be used as parent of stream. */ |
71 | struct definition_scope *definition_scope; | |
aa6bffae | 72 | GPtrArray *streams; /* Array of struct ctf_stream_class pointers */ |
0f980a35 MD |
73 | struct ctf_file_stream metadata; |
74 | ||
75 | /* Declarations only used when parsing */ | |
76 | struct declaration_struct *packet_header_decl; | |
77 | ||
78 | /* Definitions used afterward */ | |
79 | struct definition_struct *packet_header; | |
fe21b943 MD |
80 | |
81 | uint64_t major; | |
82 | uint64_t minor; | |
96513a7f | 83 | uuid_t uuid; |
0f980a35 | 84 | int byte_order; /* trace BYTE_ORDER. 0 if unset. */ |
96513a7f MD |
85 | |
86 | enum { /* Fields populated mask */ | |
0f980a35 MD |
87 | CTF_TRACE_major = (1U << 0), |
88 | CTF_TRACE_minor = (1U << 1), | |
89 | CTF_TRACE_uuid = (1U << 2), | |
90 | CTF_TRACE_byte_order = (1U << 3), | |
91 | CTF_TRACE_packet_header = (1U << 4), | |
96513a7f | 92 | } field_mask; |
bbefb8dd MD |
93 | |
94 | /* Information about trace backing directory and files */ | |
95 | DIR *dir; | |
65102a8c | 96 | int dirfd; |
bbefb8dd | 97 | int flags; /* open flags */ |
c054553d MD |
98 | }; |
99 | ||
a0720417 | 100 | #define CTF_STREAM_SET_FIELD(ctf_stream, field) \ |
96513a7f | 101 | do { \ |
96513a7f MD |
102 | (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \ |
103 | } while (0) | |
104 | ||
105 | #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \ | |
106 | ((ctf_stream)->field_mask & CTF_STREAM_ ## field) | |
107 | ||
108 | #define CTF_STREAM_GET_FIELD(ctf_stream, field) \ | |
109 | ({ \ | |
110 | assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \ | |
111 | (ctf_stream)->(field); \ | |
112 | }) | |
113 | ||
aa6bffae | 114 | struct ctf_stream_class { |
96513a7f | 115 | struct ctf_trace *trace; |
05628561 | 116 | /* parent is lexical scope conaining the stream scope */ |
f6625916 | 117 | struct declaration_scope *declaration_scope; |
41253107 | 118 | /* innermost definition scope. to be used as parent of event. */ |
e1151715 | 119 | struct definition_scope *definition_scope; |
05628561 | 120 | GPtrArray *events_by_id; /* Array of struct ctf_event pointers indexed by id */ |
96513a7f | 121 | GHashTable *event_quark_to_id; /* GQuark to numeric id */ |
fe21b943 | 122 | |
9e29e16e MD |
123 | /* Declarations only used when parsing */ |
124 | struct declaration_struct *packet_context_decl; | |
125 | struct declaration_struct *event_header_decl; | |
126 | struct declaration_struct *event_context_decl; | |
127 | ||
128 | /* Definitions used afterward */ | |
129 | struct definition_struct *packet_context; | |
e1151715 MD |
130 | struct definition_struct *event_header; |
131 | struct definition_struct *event_context; | |
96513a7f MD |
132 | |
133 | uint64_t stream_id; | |
134 | ||
135 | enum { /* Fields populated mask */ | |
136 | CTF_STREAM_stream_id = (1 << 0), | |
137 | } field_mask; | |
bbefb8dd | 138 | |
0f980a35 | 139 | GPtrArray *files; /* Array of struct ctf_file_stream pointers */ |
c054553d MD |
140 | }; |
141 | ||
05628561 | 142 | #define CTF_EVENT_SET_FIELD(ctf_event, field) \ |
96513a7f | 143 | do { \ |
96513a7f MD |
144 | (ctf_event)->field_mask |= CTF_EVENT_ ## field; \ |
145 | } while (0) | |
146 | ||
147 | #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \ | |
148 | ((ctf_event)->field_mask & CTF_EVENT_ ## field) | |
149 | ||
150 | #define CTF_EVENT_GET_FIELD(ctf_event, field) \ | |
151 | ({ \ | |
152 | assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \ | |
153 | (ctf_event)->(field); \ | |
154 | }) | |
155 | ||
c054553d | 156 | struct ctf_event { |
05628561 | 157 | /* stream mapped by stream_id */ |
aa6bffae | 158 | struct ctf_stream_class *stream; |
05628561 | 159 | /* parent is lexical scope conaining the event scope */ |
f6625916 | 160 | struct declaration_scope *declaration_scope; |
9e29e16e MD |
161 | |
162 | /* Declarations only used when parsing */ | |
163 | struct declaration_struct *context_decl; | |
164 | struct declaration_struct *fields_decl; | |
165 | ||
166 | /* Definitions used afterward */ | |
e1151715 MD |
167 | struct definition_struct *context; |
168 | struct definition_struct *fields; | |
96513a7f MD |
169 | |
170 | GQuark name; | |
171 | uint64_t id; /* Numeric identifier within the stream */ | |
172 | uint64_t stream_id; | |
173 | ||
174 | enum { /* Fields populated mask */ | |
175 | CTF_EVENT_name = (1 << 0), | |
176 | CTF_EVENT_id = (1 << 1), | |
177 | CTF_EVENT_stream_id = (1 << 2), | |
178 | } field_mask; | |
c054553d MD |
179 | }; |
180 | ||
181 | #endif /* _BABELTRACE_CTF_METADATA_H */ |