453c9f7085276de0b4ba5eb6798b475f5d6d7363
[babeltrace.git] / include / babeltrace / ctf / metadata.h
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>
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 #define CTF_MAGIC 0xC1FC1FC1
32 #define TSDL_MAGIC 0x75D11D57
33
34 struct ctf_trace;
35 struct ctf_stream_class;
36 struct ctf_stream;
37 struct ctf_event;
38
39 struct ctf_stream {
40 struct ctf_stream_class *stream_class;
41 uint64_t timestamp; /* Current timestamp, in ns */
42 };
43
44 struct ctf_file_stream {
45 uint64_t stream_id;
46 struct ctf_stream stream;
47 struct ctf_stream_pos pos; /* current stream position */
48 };
49
50 #define CTF_TRACE_SET_FIELD(ctf_trace, field) \
51 do { \
52 (ctf_trace)->field_mask |= CTF_TRACE_ ## field; \
53 } while (0)
54
55 #define CTF_TRACE_FIELD_IS_SET(ctf_trace, field) \
56 ((ctf_trace)->field_mask & CTF_TRACE_ ## field)
57
58 #define CTF_TRACE_GET_FIELD(ctf_trace, field) \
59 ({ \
60 assert(CTF_TRACE_FIELD_IS_SET(ctf_trace, field)); \
61 (ctf_trace)->(field); \
62 })
63
64
65 struct ctf_trace {
66 struct trace_descriptor parent;
67 /* root scope */
68 struct declaration_scope *root_declaration_scope;
69
70 struct declaration_scope *declaration_scope;
71 /* innermost definition scope. to be used as parent of stream. */
72 struct definition_scope *definition_scope;
73 GPtrArray *streams; /* Array of struct ctf_stream_class pointers */
74 struct ctf_file_stream metadata;
75
76 /* Declarations only used when parsing */
77 struct declaration_struct *packet_header_decl;
78
79 /* Definitions used afterward */
80 struct definition_struct *packet_header;
81
82 uint64_t major;
83 uint64_t minor;
84 uuid_t uuid;
85 int byte_order; /* trace BYTE_ORDER. 0 if unset. */
86
87 enum { /* Fields populated mask */
88 CTF_TRACE_major = (1U << 0),
89 CTF_TRACE_minor = (1U << 1),
90 CTF_TRACE_uuid = (1U << 2),
91 CTF_TRACE_byte_order = (1U << 3),
92 CTF_TRACE_packet_header = (1U << 4),
93 } field_mask;
94
95 /* Information about trace backing directory and files */
96 DIR *dir;
97 int dirfd;
98 int flags; /* open flags */
99
100 /* Heap of streams, ordered to always get the lowest timestam */
101 struct ptr_heap *stream_heap;
102 };
103
104 #define CTF_STREAM_SET_FIELD(ctf_stream, field) \
105 do { \
106 (ctf_stream)->field_mask |= CTF_STREAM_ ## field; \
107 } while (0)
108
109 #define CTF_STREAM_FIELD_IS_SET(ctf_stream, field) \
110 ((ctf_stream)->field_mask & CTF_STREAM_ ## field)
111
112 #define CTF_STREAM_GET_FIELD(ctf_stream, field) \
113 ({ \
114 assert(CTF_STREAM_FIELD_IS_SET(ctf_stream, field)); \
115 (ctf_stream)->(field); \
116 })
117
118 struct ctf_stream_class {
119 struct ctf_trace *trace;
120 /* parent is lexical scope conaining the stream scope */
121 struct declaration_scope *declaration_scope;
122 /* innermost definition scope. to be used as parent of event. */
123 struct definition_scope *definition_scope;
124 GPtrArray *events_by_id; /* Array of struct ctf_event pointers indexed by id */
125 GHashTable *event_quark_to_id; /* GQuark to numeric id */
126
127 /* Declarations only used when parsing */
128 struct declaration_struct *packet_context_decl;
129 struct declaration_struct *event_header_decl;
130 struct declaration_struct *event_context_decl;
131
132 /* Definitions used afterward */
133 struct definition_struct *packet_context;
134 struct definition_struct *event_header;
135 struct definition_struct *event_context;
136
137 uint64_t stream_id;
138
139 enum { /* Fields populated mask */
140 CTF_STREAM_stream_id = (1 << 0),
141 } field_mask;
142
143 GPtrArray *files; /* Array of struct ctf_file_stream pointers */
144 };
145
146 #define CTF_EVENT_SET_FIELD(ctf_event, field) \
147 do { \
148 (ctf_event)->field_mask |= CTF_EVENT_ ## field; \
149 } while (0)
150
151 #define CTF_EVENT_FIELD_IS_SET(ctf_event, field) \
152 ((ctf_event)->field_mask & CTF_EVENT_ ## field)
153
154 #define CTF_EVENT_GET_FIELD(ctf_event, field) \
155 ({ \
156 assert(CTF_EVENT_FIELD_IS_SET(ctf_event, field)); \
157 (ctf_event)->(field); \
158 })
159
160 struct ctf_event {
161 /* stream mapped by stream_id */
162 struct ctf_stream_class *stream;
163 /* parent is lexical scope conaining the event scope */
164 struct declaration_scope *declaration_scope;
165
166 /* Declarations only used when parsing */
167 struct declaration_struct *context_decl;
168 struct declaration_struct *fields_decl;
169
170 /* Definitions used afterward */
171 struct definition_struct *context;
172 struct definition_struct *fields;
173
174 GQuark name;
175 uint64_t id; /* Numeric identifier within the stream */
176 uint64_t stream_id;
177
178 enum { /* Fields populated mask */
179 CTF_EVENT_name = (1 << 0),
180 CTF_EVENT_id = (1 << 1),
181 CTF_EVENT_stream_id = (1 << 2),
182 } field_mask;
183 };
184
185 #define HEADER_END char end_field
186 #define header_sizeof(type) offsetof(typeof(type), end_field)
187
188 struct metadata_packet_header {
189 uint32_t magic; /* 0x75D11D57 */
190 uint8_t uuid[16]; /* Unique Universal Identifier */
191 uint32_t checksum; /* 0 if unused */
192 uint32_t content_size; /* in bits */
193 uint32_t packet_size; /* in bits */
194 uint8_t compression_scheme; /* 0 if unused */
195 uint8_t encryption_scheme; /* 0 if unused */
196 uint8_t checksum_scheme; /* 0 if unused */
197 HEADER_END;
198 };
199
200 #endif /* _BABELTRACE_CTF_METADATA_H */
This page took 0.046399 seconds and 3 git commands to generate.