tap-driver.sh: flush stdout after each test result
[babeltrace.git] / lib / trace-ir / event-class.c
CommitLineData
272df73e 1/*
f2b0325d 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
f8b979f9 24#define BT_LOG_TAG "EVENT-CLASS"
71c5da58 25#include <babeltrace2/lib-logging-internal.h>
f8b979f9 26
71c5da58
MJ
27#include <babeltrace2/assert-pre-internal.h>
28#include <babeltrace2/trace-ir/clock-snapshot-internal.h>
29#include <babeltrace2/trace-ir/field-internal.h>
30#include <babeltrace2/trace-ir/field-class.h>
31#include <babeltrace2/trace-ir/field-class-internal.h>
32#include <babeltrace2/trace-ir/event-class.h>
33#include <babeltrace2/trace-ir/event-class-const.h>
34#include <babeltrace2/trace-ir/event-class-internal.h>
35#include <babeltrace2/trace-ir/event-internal.h>
36#include <babeltrace2/trace-ir/stream-class.h>
37#include <babeltrace2/trace-ir/stream-class-internal.h>
38#include <babeltrace2/trace-ir/trace-internal.h>
39#include <babeltrace2/trace-ir/utils-internal.h>
40#include <babeltrace2/trace-ir/resolve-field-path-internal.h>
41#include <babeltrace2/trace-ir/attributes-internal.h>
42#include <babeltrace2/compiler-internal.h>
43#include <babeltrace2/endian-internal.h>
44#include <babeltrace2/types.h>
45#include <babeltrace2/value-internal.h>
46#include <babeltrace2/assert-internal.h>
dc3fffef 47#include <inttypes.h>
0fbb9a9f 48#include <stdlib.h>
272df73e 49
7b33a0e0 50#define BT_ASSERT_PRE_EVENT_CLASS_HOT(_ec) \
78cf9df6 51 BT_ASSERT_PRE_HOT(((const struct bt_event_class *) (_ec)), \
9e550e5f 52 "Event class", ": %!+E", (_ec))
7b33a0e0
PP
53
54static
55void destroy_event_class(struct bt_object *obj)
272df73e 56{
7b33a0e0 57 struct bt_event_class *event_class = (void *) obj;
272df73e 58
7b33a0e0 59 BT_LIB_LOGD("Destroying event class: %!+E", event_class);
f8b979f9 60
7b33a0e0
PP
61 if (event_class->name.str) {
62 g_string_free(event_class->name.str, TRUE);
1248f5ea 63 event_class->name.str = NULL;
9cf5d083
PP
64 }
65
7b33a0e0
PP
66 if (event_class->emf_uri.str) {
67 g_string_free(event_class->emf_uri.str, TRUE);
1248f5ea 68 event_class->emf_uri.str = NULL;
272df73e
PP
69 }
70
66fd07a5 71 BT_LOGD_STR("Putting context field class.");
1248f5ea 72 BT_OBJECT_PUT_REF_AND_RESET(event_class->specific_context_fc);
66fd07a5 73 BT_LOGD_STR("Putting payload field class.");
1248f5ea 74 BT_OBJECT_PUT_REF_AND_RESET(event_class->payload_fc);
a6918753 75 bt_object_pool_finalize(&event_class->event_pool);
8deee039 76 g_free(obj);
272df73e
PP
77}
78
a6918753
PP
79static
80void free_event(struct bt_event *event,
81 struct bt_event_class *event_class)
82{
83 bt_event_destroy(event);
84}
85
7b33a0e0
PP
86BT_ASSERT_PRE_FUNC
87static
78cf9df6
PP
88bool event_class_id_is_unique(const struct bt_stream_class *stream_class,
89 uint64_t id)
272df73e 90{
7b33a0e0
PP
91 uint64_t i;
92 bool is_unique = true;
272df73e 93
7b33a0e0 94 for (i = 0; i < stream_class->event_classes->len; i++) {
78cf9df6 95 const struct bt_event_class *ec =
7b33a0e0
PP
96 stream_class->event_classes->pdata[i];
97
98 if (ec->id == id) {
99 is_unique = false;
100 goto end;
101 }
9cf5d083 102 }
272df73e 103
7b33a0e0
PP
104end:
105 return is_unique;
106}
107
108static
109struct bt_event_class *create_event_class_with_id(
110 struct bt_stream_class *stream_class, uint64_t id)
111{
112 int ret;
113 struct bt_event_class *event_class;
114
115 BT_ASSERT(stream_class);
116 BT_ASSERT_PRE(event_class_id_is_unique(stream_class, id),
117 "Duplicate event class ID: %![sc-]+S, id=%" PRIu64,
118 stream_class, id);
119 BT_LIB_LOGD("Creating event class object: %![sc-]+S, id=%" PRIu64,
120 stream_class, id);
8deee039 121 event_class = g_new0(struct bt_event_class, 1);
272df73e 122 if (!event_class) {
8deee039
PP
123 BT_LOGE_STR("Failed to allocate one event class.");
124 goto error;
272df73e
PP
125 }
126
7b33a0e0
PP
127 bt_object_init_shared_with_parent(&event_class->base,
128 destroy_event_class);
129 event_class->id = id;
130 bt_property_uint_init(&event_class->log_level,
131 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE, 0);
132 event_class->name.str = g_string_new(NULL);
133 if (!event_class->name.str) {
134 BT_LOGE_STR("Failed to allocate a GString.");
135 ret = -1;
136 goto end;
137 }
138
139 event_class->emf_uri.str = g_string_new(NULL);
140 if (!event_class->emf_uri.str) {
141 BT_LOGE_STR("Failed to allocate a GString.");
142 ret = -1;
143 goto end;
272df73e
PP
144 }
145
a6918753
PP
146 ret = bt_object_pool_initialize(&event_class->event_pool,
147 (bt_object_pool_new_object_func) bt_event_new,
148 (bt_object_pool_destroy_object_func) free_event,
149 event_class);
150 if (ret) {
151 BT_LOGE("Failed to initialize event pool: ret=%d",
152 ret);
153 goto error;
154 }
155
7b33a0e0
PP
156 bt_object_set_parent(&event_class->base, &stream_class->base);
157 g_ptr_array_add(stream_class->event_classes, event_class);
158 bt_stream_class_freeze(stream_class);
159 BT_LIB_LOGD("Created event class object: %!+E", event_class);
8deee039 160 goto end;
272df73e 161
8deee039 162error:
8138bfe1 163 BT_OBJECT_PUT_REF_AND_RESET(event_class);
272df73e
PP
164
165end:
8deee039 166 return event_class;
272df73e
PP
167}
168
78cf9df6
PP
169struct bt_event_class *bt_event_class_create(
170 struct bt_stream_class *stream_class)
7b33a0e0
PP
171{
172 BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
173 BT_ASSERT_PRE(stream_class->assigns_automatic_event_class_id,
174 "Stream class does not automatically assigns event class IDs: "
175 "%![sc-]+S", stream_class);
78cf9df6 176 return create_event_class_with_id(stream_class,
7b33a0e0
PP
177 (uint64_t) stream_class->event_classes->len);
178}
179
78cf9df6
PP
180struct bt_event_class *bt_event_class_create_with_id(
181 struct bt_stream_class *stream_class, uint64_t id)
7b33a0e0
PP
182{
183 BT_ASSERT_PRE(!stream_class->assigns_automatic_event_class_id,
184 "Stream class automatically assigns event class IDs: "
185 "%![sc-]+S", stream_class);
78cf9df6 186 return create_event_class_with_id(stream_class, id);
7b33a0e0
PP
187}
188
78cf9df6 189const char *bt_event_class_get_name(const struct bt_event_class *event_class)
272df73e 190{
18acc6f8 191 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
7b33a0e0 192 return event_class->name.value;
272df73e
PP
193}
194
4caa7d56
PP
195enum bt_event_class_status bt_event_class_set_name(
196 struct bt_event_class *event_class, const char *name)
272df73e 197{
18acc6f8 198 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
7b33a0e0
PP
199 BT_ASSERT_PRE_NON_NULL(name, "Name");
200 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
201 g_string_assign(event_class->name.str, name);
202 event_class->name.value = event_class->name.str->str;
203 BT_LIB_LOGV("Set event class's name: %!+E", event_class);
4caa7d56 204 return BT_EVENT_CLASS_STATUS_OK;
272df73e
PP
205}
206
78cf9df6 207uint64_t bt_event_class_get_id(const struct bt_event_class *event_class)
272df73e 208{
7b33a0e0
PP
209 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
210 return event_class->id;
272df73e
PP
211}
212
7b33a0e0 213enum bt_property_availability bt_event_class_get_log_level(
78cf9df6 214 const struct bt_event_class *event_class,
7b33a0e0 215 enum bt_event_class_log_level *log_level)
272df73e 216{
18acc6f8 217 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
7b33a0e0
PP
218 BT_ASSERT_PRE_NON_NULL(log_level, "Log level (output)");
219 *log_level = (enum bt_event_class_log_level)
220 event_class->log_level.value;
221 return event_class->log_level.base.avail;
272df73e
PP
222}
223
78cf9df6
PP
224void bt_event_class_set_log_level(
225 struct bt_event_class *event_class,
8deee039 226 enum bt_event_class_log_level log_level)
272df73e 227{
7b33a0e0
PP
228 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
229 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
230 bt_property_uint_set(&event_class->log_level,
231 (uint64_t) log_level);
232 BT_LIB_LOGV("Set event class's log level: %!+E", event_class);
272df73e
PP
233}
234
78cf9df6 235const char *bt_event_class_get_emf_uri(const struct bt_event_class *event_class)
272df73e 236{
18acc6f8 237 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
7b33a0e0 238 return event_class->emf_uri.value;
272df73e
PP
239}
240
4caa7d56 241enum bt_event_class_status bt_event_class_set_emf_uri(
78cf9df6 242 struct bt_event_class *event_class,
8deee039 243 const char *emf_uri)
272df73e 244{
7b33a0e0
PP
245 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
246 BT_ASSERT_PRE_NON_NULL(emf_uri, "EMF URI");
247 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
248 g_string_assign(event_class->emf_uri.str, emf_uri);
249 event_class->emf_uri.value = event_class->emf_uri.str->str;
250 BT_LIB_LOGV("Set event class's EMF URI: %!+E", event_class);
4caa7d56 251 return BT_EVENT_CLASS_STATUS_OK;
272df73e
PP
252}
253
5fe68922 254struct bt_stream_class *bt_event_class_borrow_stream_class(
839d52a5 255 struct bt_event_class *event_class)
272df73e 256{
44ea72c5 257 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
7b33a0e0 258 return bt_event_class_borrow_stream_class_inline(event_class);
272df73e
PP
259}
260
78cf9df6
PP
261const struct bt_stream_class *
262bt_event_class_borrow_stream_class_const(
263 const struct bt_event_class *event_class)
9e550e5f 264{
78cf9df6 265 return bt_event_class_borrow_stream_class((void *) event_class);
9e550e5f
PP
266}
267
78cf9df6
PP
268const struct bt_field_class *
269bt_event_class_borrow_specific_context_field_class_const(
270 const struct bt_event_class *event_class)
272df73e 271{
18acc6f8 272 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
939190b3 273 return event_class->specific_context_fc;
272df73e
PP
274}
275
909d0a89
PP
276struct bt_field_class *
277bt_event_class_borrow_specific_context_field_class(
278 struct bt_event_class *event_class)
279{
280 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
281 return event_class->specific_context_fc;
282}
283
4caa7d56 284enum bt_event_class_status bt_event_class_set_specific_context_field_class(
78cf9df6
PP
285 struct bt_event_class *event_class,
286 struct bt_field_class *field_class)
272df73e 287{
7b33a0e0
PP
288 int ret;
289 struct bt_stream_class *stream_class;
7b33a0e0 290 struct bt_resolve_field_path_context resolve_ctx = {
7b33a0e0 291 .packet_context = NULL,
7b33a0e0 292 .event_common_context = NULL,
939190b3 293 .event_specific_context = field_class,
7b33a0e0
PP
294 .event_payload = NULL,
295 };
18acc6f8 296
7b33a0e0 297 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
939190b3 298 BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
7b33a0e0 299 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
af0c18e3
PP
300 BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
301 BT_FIELD_CLASS_TYPE_STRUCTURE,
66fd07a5 302 "Specific context field class is not a structure field class: "
939190b3 303 "%!+F", field_class);
7b33a0e0
PP
304 stream_class = bt_event_class_borrow_stream_class_inline(
305 event_class);
939190b3 306 resolve_ctx.packet_context = stream_class->packet_context_fc;
7b33a0e0 307 resolve_ctx.event_common_context =
939190b3 308 stream_class->event_common_context_fc;
7b33a0e0 309
939190b3 310 ret = bt_resolve_field_paths(field_class, &resolve_ctx);
7b33a0e0 311 if (ret) {
4caa7d56
PP
312 /*
313 * This is the only reason for which
314 * bt_resolve_field_paths() can fail: anything else
315 * would be because a precondition is not satisfied.
316 */
317 ret = BT_EVENT_CLASS_STATUS_NOMEM;
18acc6f8
PP
318 goto end;
319 }
320
10b7a2e4 321 bt_field_class_make_part_of_trace_class(field_class);
8138bfe1 322 bt_object_put_ref(event_class->specific_context_fc);
4b70020d
PP
323 event_class->specific_context_fc = field_class;
324 bt_object_get_no_null_check(event_class->specific_context_fc);
939190b3 325 bt_field_class_freeze(field_class);
66fd07a5 326 BT_LIB_LOGV("Set event class's specific context field class: %!+E",
7b33a0e0 327 event_class);
18acc6f8 328
18acc6f8
PP
329end:
330 return ret;
272df73e
PP
331}
332
78cf9df6
PP
333const struct bt_field_class *bt_event_class_borrow_payload_field_class_const(
334 const struct bt_event_class *event_class)
272df73e 335{
18acc6f8 336 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
939190b3 337 return event_class->payload_fc;
272df73e
PP
338}
339
909d0a89
PP
340struct bt_field_class *bt_event_class_borrow_payload_field_class(
341 struct bt_event_class *event_class)
342{
343 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
344 return event_class->payload_fc;
345}
346
4caa7d56 347enum bt_event_class_status bt_event_class_set_payload_field_class(
78cf9df6
PP
348 struct bt_event_class *event_class,
349 struct bt_field_class *field_class)
272df73e 350{
7b33a0e0
PP
351 int ret;
352 struct bt_stream_class *stream_class;
7b33a0e0 353 struct bt_resolve_field_path_context resolve_ctx = {
7b33a0e0 354 .packet_context = NULL,
7b33a0e0
PP
355 .event_common_context = NULL,
356 .event_specific_context = NULL,
939190b3 357 .event_payload = field_class,
7b33a0e0 358 };
18acc6f8 359
7b33a0e0 360 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
939190b3 361 BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
7b33a0e0 362 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
af0c18e3
PP
363 BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
364 BT_FIELD_CLASS_TYPE_STRUCTURE,
66fd07a5 365 "Payload field class is not a structure field class: %!+F",
939190b3 366 field_class);
7b33a0e0
PP
367 stream_class = bt_event_class_borrow_stream_class_inline(
368 event_class);
939190b3 369 resolve_ctx.packet_context = stream_class->packet_context_fc;
7b33a0e0 370 resolve_ctx.event_common_context =
939190b3
PP
371 stream_class->event_common_context_fc;
372 resolve_ctx.event_specific_context = event_class->specific_context_fc;
7b33a0e0 373
939190b3 374 ret = bt_resolve_field_paths(field_class, &resolve_ctx);
7b33a0e0 375 if (ret) {
4caa7d56
PP
376 /*
377 * This is the only reason for which
378 * bt_resolve_field_paths() can fail: anything else
379 * would be because a precondition is not satisfied.
380 */
381 ret = BT_EVENT_CLASS_STATUS_NOMEM;
18acc6f8
PP
382 goto end;
383 }
384
10b7a2e4 385 bt_field_class_make_part_of_trace_class(field_class);
8138bfe1 386 bt_object_put_ref(event_class->payload_fc);
4b70020d
PP
387 event_class->payload_fc = field_class;
388 bt_object_get_no_null_check(event_class->payload_fc);
939190b3 389 bt_field_class_freeze(field_class);
66fd07a5 390 BT_LIB_LOGV("Set event class's payload field class: %!+E", event_class);
18acc6f8
PP
391
392end:
393 return ret;
272df73e
PP
394}
395
396BT_HIDDEN
78cf9df6 397void _bt_event_class_freeze(const struct bt_event_class *event_class)
8c4a29ba 398{
939190b3 399 /* The field classes are already frozen */
8b45963b 400 BT_ASSERT(event_class);
7b33a0e0 401 BT_LIB_LOGD("Freezing event class: %!+E", event_class);
78cf9df6 402 ((struct bt_event_class *) event_class)->frozen = true;
8c4a29ba 403}
8c6884d9
PP
404
405void bt_event_class_get_ref(const struct bt_event_class *event_class)
406{
407 bt_object_get_ref(event_class);
408}
409
410void bt_event_class_put_ref(const struct bt_event_class *event_class)
411{
412 bt_object_put_ref(event_class);
413}
This page took 0.066061 seconds and 4 git commands to generate.