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