Commit | Line | Data |
---|---|---|
272df73e | 1 | /* |
e2f7325d | 2 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
272df73e PP |
3 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
4 | * | |
272df73e PP |
5 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
6 | * of this software and associated documentation files (the "Software"), to deal | |
7 | * in the Software without restriction, including without limitation the rights | |
8 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
9 | * copies of the Software, and to permit persons to whom the Software is | |
10 | * furnished to do so, subject to the following conditions: | |
11 | * | |
12 | * The above copyright notice and this permission notice shall be included in | |
13 | * all copies or substantial portions of the Software. | |
14 | * | |
15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
18 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
19 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
20 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
21 | * SOFTWARE. | |
22 | */ | |
23 | ||
350ad6c1 | 24 | #define BT_LOG_TAG "LIB/EVENT-CLASS" |
c2d9d9cf | 25 | #include "lib/logging.h" |
f8b979f9 | 26 | |
578e048b | 27 | #include "lib/assert-pre.h" |
3fadfbc0 | 28 | #include <babeltrace2/trace-ir/field-class.h> |
3fadfbc0 MJ |
29 | #include <babeltrace2/trace-ir/event-class.h> |
30 | #include <babeltrace2/trace-ir/event-class-const.h> | |
3fadfbc0 | 31 | #include <babeltrace2/trace-ir/stream-class.h> |
578e048b MJ |
32 | #include "compat/compiler.h" |
33 | #include "compat/endian.h" | |
3fadfbc0 | 34 | #include <babeltrace2/types.h> |
578e048b MJ |
35 | #include "lib/value.h" |
36 | #include "common/assert.h" | |
dc3fffef | 37 | #include <inttypes.h> |
0fbb9a9f | 38 | #include <stdlib.h> |
272df73e | 39 | |
578e048b MJ |
40 | #include "attributes.h" |
41 | #include "clock-snapshot.h" | |
42 | #include "event-class.h" | |
43 | #include "event.h" | |
44 | #include "field-class.h" | |
45 | #include "field.h" | |
46 | #include "resolve-field-path.h" | |
47 | #include "stream-class.h" | |
48 | #include "trace.h" | |
49 | #include "utils.h" | |
d24d5663 | 50 | #include "lib/func-status.h" |
578e048b | 51 | |
bdb288b3 PP |
52 | #define BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(_ec) \ |
53 | BT_ASSERT_PRE_DEV_HOT(((const struct bt_event_class *) (_ec)), \ | |
e5be10ef | 54 | "Event class", ": %!+E", (_ec)) |
44c440bc PP |
55 | |
56 | static | |
57 | void destroy_event_class(struct bt_object *obj) | |
272df73e | 58 | { |
44c440bc | 59 | struct bt_event_class *event_class = (void *) obj; |
272df73e | 60 | |
44c440bc | 61 | BT_LIB_LOGD("Destroying event class: %!+E", event_class); |
f8b979f9 | 62 | |
44c440bc PP |
63 | if (event_class->name.str) { |
64 | g_string_free(event_class->name.str, TRUE); | |
238b7404 | 65 | event_class->name.str = NULL; |
cf76ce92 PP |
66 | } |
67 | ||
44c440bc PP |
68 | if (event_class->emf_uri.str) { |
69 | g_string_free(event_class->emf_uri.str, TRUE); | |
238b7404 | 70 | event_class->emf_uri.str = NULL; |
272df73e PP |
71 | } |
72 | ||
e6276565 | 73 | BT_LOGD_STR("Putting context field class."); |
238b7404 | 74 | BT_OBJECT_PUT_REF_AND_RESET(event_class->specific_context_fc); |
e6276565 | 75 | BT_LOGD_STR("Putting payload field class."); |
238b7404 | 76 | BT_OBJECT_PUT_REF_AND_RESET(event_class->payload_fc); |
312c056a | 77 | bt_object_pool_finalize(&event_class->event_pool); |
3dca2276 | 78 | g_free(obj); |
272df73e PP |
79 | } |
80 | ||
312c056a PP |
81 | static |
82 | void free_event(struct bt_event *event, | |
83 | struct bt_event_class *event_class) | |
84 | { | |
85 | bt_event_destroy(event); | |
86 | } | |
87 | ||
44c440bc | 88 | static |
40f4ba76 PP |
89 | bool event_class_id_is_unique(const struct bt_stream_class *stream_class, |
90 | uint64_t id) | |
272df73e | 91 | { |
44c440bc PP |
92 | uint64_t i; |
93 | bool is_unique = true; | |
272df73e | 94 | |
44c440bc | 95 | for (i = 0; i < stream_class->event_classes->len; i++) { |
40f4ba76 | 96 | const struct bt_event_class *ec = |
44c440bc PP |
97 | stream_class->event_classes->pdata[i]; |
98 | ||
99 | if (ec->id == id) { | |
100 | is_unique = false; | |
101 | goto end; | |
102 | } | |
cf76ce92 | 103 | } |
272df73e | 104 | |
44c440bc PP |
105 | end: |
106 | return is_unique; | |
107 | } | |
108 | ||
109 | static | |
110 | struct bt_event_class *create_event_class_with_id( | |
111 | struct bt_stream_class *stream_class, uint64_t id) | |
112 | { | |
113 | int ret; | |
114 | struct bt_event_class *event_class; | |
115 | ||
116 | BT_ASSERT(stream_class); | |
117 | BT_ASSERT_PRE(event_class_id_is_unique(stream_class, id), | |
118 | "Duplicate event class ID: %![sc-]+S, id=%" PRIu64, | |
119 | stream_class, id); | |
120 | BT_LIB_LOGD("Creating event class object: %![sc-]+S, id=%" PRIu64, | |
121 | stream_class, id); | |
3dca2276 | 122 | event_class = g_new0(struct bt_event_class, 1); |
272df73e | 123 | if (!event_class) { |
870631a2 | 124 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one event class."); |
3dca2276 | 125 | goto error; |
272df73e PP |
126 | } |
127 | ||
44c440bc PP |
128 | bt_object_init_shared_with_parent(&event_class->base, |
129 | destroy_event_class); | |
130 | event_class->id = id; | |
131 | bt_property_uint_init(&event_class->log_level, | |
132 | BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE, 0); | |
133 | event_class->name.str = g_string_new(NULL); | |
134 | if (!event_class->name.str) { | |
870631a2 | 135 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); |
44c440bc PP |
136 | ret = -1; |
137 | goto end; | |
138 | } | |
139 | ||
140 | event_class->emf_uri.str = g_string_new(NULL); | |
141 | if (!event_class->emf_uri.str) { | |
870631a2 | 142 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); |
44c440bc PP |
143 | ret = -1; |
144 | goto end; | |
272df73e PP |
145 | } |
146 | ||
312c056a PP |
147 | ret = bt_object_pool_initialize(&event_class->event_pool, |
148 | (bt_object_pool_new_object_func) bt_event_new, | |
149 | (bt_object_pool_destroy_object_func) free_event, | |
150 | event_class); | |
151 | if (ret) { | |
870631a2 PP |
152 | BT_LIB_LOGE_APPEND_CAUSE( |
153 | "Failed to initialize event pool: ret=%d", | |
312c056a PP |
154 | ret); |
155 | goto error; | |
156 | } | |
157 | ||
44c440bc PP |
158 | bt_object_set_parent(&event_class->base, &stream_class->base); |
159 | g_ptr_array_add(stream_class->event_classes, event_class); | |
160 | bt_stream_class_freeze(stream_class); | |
161 | BT_LIB_LOGD("Created event class object: %!+E", event_class); | |
3dca2276 | 162 | goto end; |
272df73e | 163 | |
3dca2276 | 164 | error: |
65300d60 | 165 | BT_OBJECT_PUT_REF_AND_RESET(event_class); |
272df73e PP |
166 | |
167 | end: | |
3dca2276 | 168 | return event_class; |
272df73e PP |
169 | } |
170 | ||
40f4ba76 PP |
171 | struct bt_event_class *bt_event_class_create( |
172 | struct bt_stream_class *stream_class) | |
44c440bc PP |
173 | { |
174 | BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class"); | |
175 | BT_ASSERT_PRE(stream_class->assigns_automatic_event_class_id, | |
176 | "Stream class does not automatically assigns event class IDs: " | |
177 | "%![sc-]+S", stream_class); | |
40f4ba76 | 178 | return create_event_class_with_id(stream_class, |
44c440bc PP |
179 | (uint64_t) stream_class->event_classes->len); |
180 | } | |
181 | ||
40f4ba76 PP |
182 | struct bt_event_class *bt_event_class_create_with_id( |
183 | struct bt_stream_class *stream_class, uint64_t id) | |
44c440bc PP |
184 | { |
185 | BT_ASSERT_PRE(!stream_class->assigns_automatic_event_class_id, | |
186 | "Stream class automatically assigns event class IDs: " | |
187 | "%![sc-]+S", stream_class); | |
40f4ba76 | 188 | return create_event_class_with_id(stream_class, id); |
44c440bc PP |
189 | } |
190 | ||
40f4ba76 | 191 | const char *bt_event_class_get_name(const struct bt_event_class *event_class) |
272df73e | 192 | { |
bdb288b3 | 193 | BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class"); |
44c440bc | 194 | return event_class->name.value; |
272df73e PP |
195 | } |
196 | ||
d24d5663 | 197 | enum bt_event_class_set_name_status bt_event_class_set_name( |
d08300f5 | 198 | struct bt_event_class *event_class, const char *name) |
272df73e | 199 | { |
cb6f1f7d | 200 | BT_ASSERT_PRE_NON_NULL(event_class, "Event class"); |
44c440bc | 201 | BT_ASSERT_PRE_NON_NULL(name, "Name"); |
bdb288b3 | 202 | BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class); |
44c440bc PP |
203 | g_string_assign(event_class->name.str, name); |
204 | event_class->name.value = event_class->name.str->str; | |
3f7d4d90 | 205 | BT_LIB_LOGD("Set event class's name: %!+E", event_class); |
d24d5663 | 206 | return BT_FUNC_STATUS_OK; |
272df73e PP |
207 | } |
208 | ||
40f4ba76 | 209 | uint64_t bt_event_class_get_id(const struct bt_event_class *event_class) |
272df73e | 210 | { |
bdb288b3 | 211 | BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class"); |
44c440bc | 212 | return event_class->id; |
272df73e PP |
213 | } |
214 | ||
44c440bc | 215 | enum bt_property_availability bt_event_class_get_log_level( |
40f4ba76 | 216 | const struct bt_event_class *event_class, |
44c440bc | 217 | enum bt_event_class_log_level *log_level) |
272df73e | 218 | { |
bdb288b3 PP |
219 | BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class"); |
220 | BT_ASSERT_PRE_DEV_NON_NULL(log_level, "Log level (output)"); | |
44c440bc PP |
221 | *log_level = (enum bt_event_class_log_level) |
222 | event_class->log_level.value; | |
223 | return event_class->log_level.base.avail; | |
272df73e PP |
224 | } |
225 | ||
40f4ba76 PP |
226 | void bt_event_class_set_log_level( |
227 | struct bt_event_class *event_class, | |
3dca2276 | 228 | enum bt_event_class_log_level log_level) |
272df73e | 229 | { |
44c440bc | 230 | BT_ASSERT_PRE_NON_NULL(event_class, "Event class"); |
bdb288b3 | 231 | BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class); |
44c440bc PP |
232 | bt_property_uint_set(&event_class->log_level, |
233 | (uint64_t) log_level); | |
3f7d4d90 | 234 | BT_LIB_LOGD("Set event class's log level: %!+E", event_class); |
272df73e PP |
235 | } |
236 | ||
40f4ba76 | 237 | const char *bt_event_class_get_emf_uri(const struct bt_event_class *event_class) |
272df73e | 238 | { |
bdb288b3 | 239 | BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class"); |
44c440bc | 240 | return event_class->emf_uri.value; |
272df73e PP |
241 | } |
242 | ||
d24d5663 | 243 | enum bt_event_class_set_emf_uri_status bt_event_class_set_emf_uri( |
40f4ba76 | 244 | struct bt_event_class *event_class, |
3dca2276 | 245 | const char *emf_uri) |
272df73e | 246 | { |
44c440bc PP |
247 | BT_ASSERT_PRE_NON_NULL(event_class, "Event class"); |
248 | BT_ASSERT_PRE_NON_NULL(emf_uri, "EMF URI"); | |
bdb288b3 | 249 | BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class); |
44c440bc PP |
250 | g_string_assign(event_class->emf_uri.str, emf_uri); |
251 | event_class->emf_uri.value = event_class->emf_uri.str->str; | |
3f7d4d90 | 252 | BT_LIB_LOGD("Set event class's EMF URI: %!+E", event_class); |
d24d5663 | 253 | return BT_FUNC_STATUS_OK; |
272df73e PP |
254 | } |
255 | ||
094ff7c0 | 256 | struct bt_stream_class *bt_event_class_borrow_stream_class( |
50842bdc | 257 | struct bt_event_class *event_class) |
272df73e | 258 | { |
bdb288b3 | 259 | BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class"); |
44c440bc | 260 | return bt_event_class_borrow_stream_class_inline(event_class); |
272df73e PP |
261 | } |
262 | ||
40f4ba76 PP |
263 | const struct bt_stream_class * |
264 | bt_event_class_borrow_stream_class_const( | |
265 | const struct bt_event_class *event_class) | |
e5be10ef | 266 | { |
40f4ba76 | 267 | return bt_event_class_borrow_stream_class((void *) event_class); |
e5be10ef PP |
268 | } |
269 | ||
40f4ba76 PP |
270 | const struct bt_field_class * |
271 | bt_event_class_borrow_specific_context_field_class_const( | |
272 | const struct bt_event_class *event_class) | |
272df73e | 273 | { |
bdb288b3 | 274 | BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class"); |
5cd6d0e5 | 275 | return event_class->specific_context_fc; |
272df73e PP |
276 | } |
277 | ||
740faaf4 PP |
278 | struct bt_field_class * |
279 | bt_event_class_borrow_specific_context_field_class( | |
280 | struct bt_event_class *event_class) | |
281 | { | |
bdb288b3 | 282 | BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class"); |
740faaf4 PP |
283 | return event_class->specific_context_fc; |
284 | } | |
285 | ||
d24d5663 PP |
286 | enum bt_event_class_set_field_class_status |
287 | bt_event_class_set_specific_context_field_class( | |
40f4ba76 PP |
288 | struct bt_event_class *event_class, |
289 | struct bt_field_class *field_class) | |
272df73e | 290 | { |
44c440bc PP |
291 | int ret; |
292 | struct bt_stream_class *stream_class; | |
44c440bc | 293 | struct bt_resolve_field_path_context resolve_ctx = { |
44c440bc | 294 | .packet_context = NULL, |
44c440bc | 295 | .event_common_context = NULL, |
5cd6d0e5 | 296 | .event_specific_context = field_class, |
44c440bc PP |
297 | .event_payload = NULL, |
298 | }; | |
cb6f1f7d | 299 | |
44c440bc | 300 | BT_ASSERT_PRE_NON_NULL(event_class, "Event class"); |
5cd6d0e5 | 301 | BT_ASSERT_PRE_NON_NULL(field_class, "Field class"); |
bdb288b3 | 302 | BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class); |
864cad70 PP |
303 | BT_ASSERT_PRE(bt_field_class_get_type(field_class) == |
304 | BT_FIELD_CLASS_TYPE_STRUCTURE, | |
e6276565 | 305 | "Specific context field class is not a structure field class: " |
5cd6d0e5 | 306 | "%!+F", field_class); |
44c440bc PP |
307 | stream_class = bt_event_class_borrow_stream_class_inline( |
308 | event_class); | |
5cd6d0e5 | 309 | resolve_ctx.packet_context = stream_class->packet_context_fc; |
44c440bc | 310 | resolve_ctx.event_common_context = |
5cd6d0e5 | 311 | stream_class->event_common_context_fc; |
44c440bc | 312 | |
5cd6d0e5 | 313 | ret = bt_resolve_field_paths(field_class, &resolve_ctx); |
44c440bc | 314 | if (ret) { |
d08300f5 PP |
315 | /* |
316 | * This is the only reason for which | |
317 | * bt_resolve_field_paths() can fail: anything else | |
318 | * would be because a precondition is not satisfied. | |
319 | */ | |
d24d5663 | 320 | ret = BT_FUNC_STATUS_MEMORY_ERROR; |
cb6f1f7d PP |
321 | goto end; |
322 | } | |
323 | ||
862ca4ed | 324 | bt_field_class_make_part_of_trace_class(field_class); |
65300d60 | 325 | bt_object_put_ref(event_class->specific_context_fc); |
398454ed PP |
326 | event_class->specific_context_fc = field_class; |
327 | bt_object_get_no_null_check(event_class->specific_context_fc); | |
5cd6d0e5 | 328 | bt_field_class_freeze(field_class); |
3f7d4d90 | 329 | BT_LIB_LOGD("Set event class's specific context field class: %!+E", |
44c440bc | 330 | event_class); |
cb6f1f7d | 331 | |
cb6f1f7d PP |
332 | end: |
333 | return ret; | |
272df73e PP |
334 | } |
335 | ||
40f4ba76 PP |
336 | const struct bt_field_class *bt_event_class_borrow_payload_field_class_const( |
337 | const struct bt_event_class *event_class) | |
272df73e | 338 | { |
bdb288b3 | 339 | BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class"); |
5cd6d0e5 | 340 | return event_class->payload_fc; |
272df73e PP |
341 | } |
342 | ||
740faaf4 PP |
343 | struct bt_field_class *bt_event_class_borrow_payload_field_class( |
344 | struct bt_event_class *event_class) | |
345 | { | |
bdb288b3 | 346 | BT_ASSERT_PRE_DEV_NON_NULL(event_class, "Event class"); |
740faaf4 PP |
347 | return event_class->payload_fc; |
348 | } | |
349 | ||
d24d5663 PP |
350 | enum bt_event_class_set_field_class_status |
351 | bt_event_class_set_payload_field_class( | |
40f4ba76 PP |
352 | struct bt_event_class *event_class, |
353 | struct bt_field_class *field_class) | |
272df73e | 354 | { |
44c440bc PP |
355 | int ret; |
356 | struct bt_stream_class *stream_class; | |
44c440bc | 357 | struct bt_resolve_field_path_context resolve_ctx = { |
44c440bc | 358 | .packet_context = NULL, |
44c440bc PP |
359 | .event_common_context = NULL, |
360 | .event_specific_context = NULL, | |
5cd6d0e5 | 361 | .event_payload = field_class, |
44c440bc | 362 | }; |
cb6f1f7d | 363 | |
44c440bc | 364 | BT_ASSERT_PRE_NON_NULL(event_class, "Event class"); |
5cd6d0e5 | 365 | BT_ASSERT_PRE_NON_NULL(field_class, "Field class"); |
bdb288b3 | 366 | BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class); |
864cad70 PP |
367 | BT_ASSERT_PRE(bt_field_class_get_type(field_class) == |
368 | BT_FIELD_CLASS_TYPE_STRUCTURE, | |
e6276565 | 369 | "Payload field class is not a structure field class: %!+F", |
5cd6d0e5 | 370 | field_class); |
44c440bc PP |
371 | stream_class = bt_event_class_borrow_stream_class_inline( |
372 | event_class); | |
5cd6d0e5 | 373 | resolve_ctx.packet_context = stream_class->packet_context_fc; |
44c440bc | 374 | resolve_ctx.event_common_context = |
5cd6d0e5 PP |
375 | stream_class->event_common_context_fc; |
376 | resolve_ctx.event_specific_context = event_class->specific_context_fc; | |
44c440bc | 377 | |
5cd6d0e5 | 378 | ret = bt_resolve_field_paths(field_class, &resolve_ctx); |
44c440bc | 379 | if (ret) { |
d08300f5 PP |
380 | /* |
381 | * This is the only reason for which | |
382 | * bt_resolve_field_paths() can fail: anything else | |
383 | * would be because a precondition is not satisfied. | |
384 | */ | |
d24d5663 | 385 | ret = BT_FUNC_STATUS_MEMORY_ERROR; |
cb6f1f7d PP |
386 | goto end; |
387 | } | |
388 | ||
862ca4ed | 389 | bt_field_class_make_part_of_trace_class(field_class); |
65300d60 | 390 | bt_object_put_ref(event_class->payload_fc); |
398454ed PP |
391 | event_class->payload_fc = field_class; |
392 | bt_object_get_no_null_check(event_class->payload_fc); | |
5cd6d0e5 | 393 | bt_field_class_freeze(field_class); |
3f7d4d90 | 394 | BT_LIB_LOGD("Set event class's payload field class: %!+E", event_class); |
cb6f1f7d PP |
395 | |
396 | end: | |
397 | return ret; | |
272df73e PP |
398 | } |
399 | ||
400 | BT_HIDDEN | |
40f4ba76 | 401 | void _bt_event_class_freeze(const struct bt_event_class *event_class) |
2a3ced3c | 402 | { |
5cd6d0e5 | 403 | /* The field classes are already frozen */ |
f6ccaed9 | 404 | BT_ASSERT(event_class); |
44c440bc | 405 | BT_LIB_LOGD("Freezing event class: %!+E", event_class); |
40f4ba76 | 406 | ((struct bt_event_class *) event_class)->frozen = true; |
2a3ced3c | 407 | } |
c5b9b441 PP |
408 | |
409 | void bt_event_class_get_ref(const struct bt_event_class *event_class) | |
410 | { | |
411 | bt_object_get_ref(event_class); | |
412 | } | |
413 | ||
414 | void bt_event_class_put_ref(const struct bt_event_class *event_class) | |
415 | { | |
416 | bt_object_put_ref(event_class); | |
417 | } |