lib: make trace IR API const-correct
[babeltrace.git] / lib / trace-ir / event-class.c
CommitLineData
272df73e 1/*
272df73e
PP
2 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 *
4 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24
f8b979f9
PP
25#define BT_LOG_TAG "EVENT-CLASS"
26#include <babeltrace/lib-logging-internal.h>
27
3dca2276 28#include <babeltrace/assert-pre-internal.h>
56e18c4c
PP
29#include <babeltrace/trace-ir/clock-value-internal.h>
30#include <babeltrace/trace-ir/fields-internal.h>
5cd6d0e5
PP
31#include <babeltrace/trace-ir/field-classes.h>
32#include <babeltrace/trace-ir/field-classes-internal.h>
56e18c4c 33#include <babeltrace/trace-ir/event-class.h>
40f4ba76 34#include <babeltrace/trace-ir/event-class-const.h>
56e18c4c
PP
35#include <babeltrace/trace-ir/event-class-internal.h>
36#include <babeltrace/trace-ir/event-internal.h>
37#include <babeltrace/trace-ir/stream-class.h>
38#include <babeltrace/trace-ir/stream-class-internal.h>
39#include <babeltrace/trace-ir/trace-internal.h>
40#include <babeltrace/trace-ir/utils-internal.h>
41#include <babeltrace/trace-ir/resolve-field-path-internal.h>
65300d60 42#include <babeltrace/object.h>
56e18c4c 43#include <babeltrace/trace-ir/attributes-internal.h>
3d9990ac
PP
44#include <babeltrace/compiler-internal.h>
45#include <babeltrace/endian-internal.h>
c55a9f58 46#include <babeltrace/types.h>
f8b979f9 47#include <babeltrace/values-internal.h>
f6ccaed9 48#include <babeltrace/assert-internal.h>
dc3fffef 49#include <inttypes.h>
0fbb9a9f 50#include <stdlib.h>
272df73e 51
44c440bc 52#define BT_ASSERT_PRE_EVENT_CLASS_HOT(_ec) \
40f4ba76 53 BT_ASSERT_PRE_HOT(((const struct bt_event_class *) (_ec)), \
e5be10ef 54 "Event class", ": %!+E", (_ec))
44c440bc
PP
55
56static
57void 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
5cd6d0e5 73 BT_LOGD_STR("Putting context field classe.");
238b7404 74 BT_OBJECT_PUT_REF_AND_RESET(event_class->specific_context_fc);
5cd6d0e5 75 BT_LOGD_STR("Putting payload field classe.");
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
81static
82void free_event(struct bt_event *event,
83 struct bt_event_class *event_class)
84{
85 bt_event_destroy(event);
86}
87
44c440bc
PP
88BT_ASSERT_PRE_FUNC
89static
40f4ba76
PP
90bool event_class_id_is_unique(const struct bt_stream_class *stream_class,
91 uint64_t id)
272df73e 92{
44c440bc
PP
93 uint64_t i;
94 bool is_unique = true;
272df73e 95
44c440bc 96 for (i = 0; i < stream_class->event_classes->len; i++) {
40f4ba76 97 const struct bt_event_class *ec =
44c440bc
PP
98 stream_class->event_classes->pdata[i];
99
100 if (ec->id == id) {
101 is_unique = false;
102 goto end;
103 }
cf76ce92 104 }
272df73e 105
44c440bc
PP
106end:
107 return is_unique;
108}
109
110static
111struct bt_event_class *create_event_class_with_id(
112 struct bt_stream_class *stream_class, uint64_t id)
113{
114 int ret;
115 struct bt_event_class *event_class;
116
117 BT_ASSERT(stream_class);
118 BT_ASSERT_PRE(event_class_id_is_unique(stream_class, id),
119 "Duplicate event class ID: %![sc-]+S, id=%" PRIu64,
120 stream_class, id);
121 BT_LIB_LOGD("Creating event class object: %![sc-]+S, id=%" PRIu64,
122 stream_class, id);
3dca2276 123 event_class = g_new0(struct bt_event_class, 1);
272df73e 124 if (!event_class) {
3dca2276
PP
125 BT_LOGE_STR("Failed to allocate one event class.");
126 goto error;
272df73e
PP
127 }
128
44c440bc
PP
129 bt_object_init_shared_with_parent(&event_class->base,
130 destroy_event_class);
131 event_class->id = id;
132 bt_property_uint_init(&event_class->log_level,
133 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE, 0);
134 event_class->name.str = g_string_new(NULL);
135 if (!event_class->name.str) {
136 BT_LOGE_STR("Failed to allocate a GString.");
137 ret = -1;
138 goto end;
139 }
140
141 event_class->emf_uri.str = g_string_new(NULL);
142 if (!event_class->emf_uri.str) {
143 BT_LOGE_STR("Failed to allocate a GString.");
144 ret = -1;
145 goto end;
272df73e
PP
146 }
147
312c056a
PP
148 ret = bt_object_pool_initialize(&event_class->event_pool,
149 (bt_object_pool_new_object_func) bt_event_new,
150 (bt_object_pool_destroy_object_func) free_event,
151 event_class);
152 if (ret) {
153 BT_LOGE("Failed to initialize event pool: ret=%d",
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 164error:
65300d60 165 BT_OBJECT_PUT_REF_AND_RESET(event_class);
272df73e
PP
166
167end:
3dca2276 168 return event_class;
272df73e
PP
169}
170
40f4ba76
PP
171struct 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
182struct 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 191const char *bt_event_class_get_name(const struct bt_event_class *event_class)
272df73e 192{
cb6f1f7d 193 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
44c440bc 194 return event_class->name.value;
272df73e
PP
195}
196
40f4ba76 197int bt_event_class_set_name(struct bt_event_class *event_class,
44c440bc 198 const char *name)
272df73e 199{
cb6f1f7d 200 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
44c440bc
PP
201 BT_ASSERT_PRE_NON_NULL(name, "Name");
202 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
203 g_string_assign(event_class->name.str, name);
204 event_class->name.value = event_class->name.str->str;
205 BT_LIB_LOGV("Set event class's name: %!+E", event_class);
206 return 0;
272df73e
PP
207}
208
40f4ba76 209uint64_t bt_event_class_get_id(const struct bt_event_class *event_class)
272df73e 210{
44c440bc
PP
211 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
212 return event_class->id;
272df73e
PP
213}
214
44c440bc 215enum 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{
cb6f1f7d 219 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
44c440bc
PP
220 BT_ASSERT_PRE_NON_NULL(log_level, "Log level (output)");
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
226void 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
PP
230 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
231 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
232 bt_property_uint_set(&event_class->log_level,
233 (uint64_t) log_level);
234 BT_LIB_LOGV("Set event class's log level: %!+E", event_class);
272df73e
PP
235}
236
40f4ba76 237const char *bt_event_class_get_emf_uri(const struct bt_event_class *event_class)
272df73e 238{
cb6f1f7d 239 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
44c440bc 240 return event_class->emf_uri.value;
272df73e
PP
241}
242
40f4ba76
PP
243int bt_event_class_set_emf_uri(
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");
249 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
250 g_string_assign(event_class->emf_uri.str, emf_uri);
251 event_class->emf_uri.value = event_class->emf_uri.str->str;
252 BT_LIB_LOGV("Set event class's EMF URI: %!+E", event_class);
253 return 0;
272df73e
PP
254}
255
094ff7c0 256struct bt_stream_class *bt_event_class_borrow_stream_class(
50842bdc 257 struct bt_event_class *event_class)
272df73e 258{
d975f66c 259 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
44c440bc 260 return bt_event_class_borrow_stream_class_inline(event_class);
272df73e
PP
261}
262
40f4ba76
PP
263const struct bt_stream_class *
264bt_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
270const struct bt_field_class *
271bt_event_class_borrow_specific_context_field_class_const(
272 const struct bt_event_class *event_class)
272df73e 273{
cb6f1f7d 274 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
5cd6d0e5 275 return event_class->specific_context_fc;
272df73e
PP
276}
277
40f4ba76
PP
278int bt_event_class_set_specific_context_field_class(
279 struct bt_event_class *event_class,
280 struct bt_field_class *field_class)
272df73e 281{
44c440bc
PP
282 int ret;
283 struct bt_stream_class *stream_class;
284 struct bt_trace *trace;
285 struct bt_resolve_field_path_context resolve_ctx = {
286 .packet_header = NULL,
287 .packet_context = NULL,
288 .event_header = NULL,
289 .event_common_context = NULL,
5cd6d0e5 290 .event_specific_context = field_class,
44c440bc
PP
291 .event_payload = NULL,
292 };
cb6f1f7d 293
44c440bc 294 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
5cd6d0e5 295 BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
44c440bc 296 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
864cad70
PP
297 BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
298 BT_FIELD_CLASS_TYPE_STRUCTURE,
5cd6d0e5
PP
299 "Specific context field classe is not a structure field classe: "
300 "%!+F", field_class);
44c440bc
PP
301 stream_class = bt_event_class_borrow_stream_class_inline(
302 event_class);
303 trace = bt_stream_class_borrow_trace_inline(stream_class);
5cd6d0e5
PP
304 resolve_ctx.packet_header = trace->packet_header_fc;
305 resolve_ctx.packet_context = stream_class->packet_context_fc;
306 resolve_ctx.event_header = stream_class->event_header_fc;
44c440bc 307 resolve_ctx.event_common_context =
5cd6d0e5 308 stream_class->event_common_context_fc;
44c440bc 309
5cd6d0e5 310 ret = bt_resolve_field_paths(field_class, &resolve_ctx);
44c440bc 311 if (ret) {
cb6f1f7d
PP
312 goto end;
313 }
314
5cd6d0e5 315 bt_field_class_make_part_of_trace(field_class);
65300d60 316 bt_object_put_ref(event_class->specific_context_fc);
398454ed
PP
317 event_class->specific_context_fc = field_class;
318 bt_object_get_no_null_check(event_class->specific_context_fc);
5cd6d0e5
PP
319 bt_field_class_freeze(field_class);
320 BT_LIB_LOGV("Set event class's specific context field classe: %!+E",
44c440bc 321 event_class);
cb6f1f7d 322
cb6f1f7d
PP
323end:
324 return ret;
272df73e
PP
325}
326
40f4ba76
PP
327const struct bt_field_class *bt_event_class_borrow_payload_field_class_const(
328 const struct bt_event_class *event_class)
272df73e 329{
cb6f1f7d 330 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
5cd6d0e5 331 return event_class->payload_fc;
272df73e
PP
332}
333
40f4ba76
PP
334int bt_event_class_set_payload_field_class(
335 struct bt_event_class *event_class,
336 struct bt_field_class *field_class)
272df73e 337{
44c440bc
PP
338 int ret;
339 struct bt_stream_class *stream_class;
340 struct bt_trace *trace;
341 struct bt_resolve_field_path_context resolve_ctx = {
342 .packet_header = NULL,
343 .packet_context = NULL,
344 .event_header = NULL,
345 .event_common_context = NULL,
346 .event_specific_context = NULL,
5cd6d0e5 347 .event_payload = field_class,
44c440bc 348 };
cb6f1f7d 349
44c440bc 350 BT_ASSERT_PRE_NON_NULL(event_class, "Event class");
5cd6d0e5 351 BT_ASSERT_PRE_NON_NULL(field_class, "Field class");
44c440bc 352 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class);
864cad70
PP
353 BT_ASSERT_PRE(bt_field_class_get_type(field_class) ==
354 BT_FIELD_CLASS_TYPE_STRUCTURE,
5cd6d0e5
PP
355 "Payload field classe is not a structure field classe: %!+F",
356 field_class);
44c440bc
PP
357 stream_class = bt_event_class_borrow_stream_class_inline(
358 event_class);
359 trace = bt_stream_class_borrow_trace_inline(stream_class);
5cd6d0e5
PP
360 resolve_ctx.packet_header = trace->packet_header_fc;
361 resolve_ctx.packet_context = stream_class->packet_context_fc;
362 resolve_ctx.event_header = stream_class->event_header_fc;
44c440bc 363 resolve_ctx.event_common_context =
5cd6d0e5
PP
364 stream_class->event_common_context_fc;
365 resolve_ctx.event_specific_context = event_class->specific_context_fc;
44c440bc 366
5cd6d0e5 367 ret = bt_resolve_field_paths(field_class, &resolve_ctx);
44c440bc 368 if (ret) {
cb6f1f7d
PP
369 goto end;
370 }
371
5cd6d0e5 372 bt_field_class_make_part_of_trace(field_class);
65300d60 373 bt_object_put_ref(event_class->payload_fc);
398454ed
PP
374 event_class->payload_fc = field_class;
375 bt_object_get_no_null_check(event_class->payload_fc);
5cd6d0e5
PP
376 bt_field_class_freeze(field_class);
377 BT_LIB_LOGV("Set event class's payload field classe: %!+E", event_class);
cb6f1f7d
PP
378
379end:
380 return ret;
272df73e
PP
381}
382
383BT_HIDDEN
40f4ba76 384void _bt_event_class_freeze(const struct bt_event_class *event_class)
2a3ced3c 385{
5cd6d0e5 386 /* The field classes are already frozen */
f6ccaed9 387 BT_ASSERT(event_class);
44c440bc 388 BT_LIB_LOGD("Freezing event class: %!+E", event_class);
40f4ba76 389 ((struct bt_event_class *) event_class)->frozen = true;
2a3ced3c 390}
This page took 0.061942 seconds and 4 git commands to generate.