lib: make trace IR API const-correct
[babeltrace.git] / lib / trace-ir / event.c
CommitLineData
273b65be 1/*
de9dd397 2 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be
JG
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
7b010242
PP
25#define BT_LOG_TAG "EVENT"
26#include <babeltrace/lib-logging-internal.h>
27
3dca2276 28#include <babeltrace/assert-pre-internal.h>
56e18c4c 29#include <babeltrace/trace-ir/fields-internal.h>
5cd6d0e5 30#include <babeltrace/trace-ir/field-classes-internal.h>
56e18c4c 31#include <babeltrace/trace-ir/clock-class.h>
40f4ba76 32#include <babeltrace/trace-ir/clock-value-const.h>
56e18c4c
PP
33#include <babeltrace/trace-ir/clock-value-internal.h>
34#include <babeltrace/trace-ir/clock-class-internal.h>
40f4ba76 35#include <babeltrace/trace-ir/event-const.h>
56e18c4c
PP
36#include <babeltrace/trace-ir/event-internal.h>
37#include <babeltrace/trace-ir/event-class.h>
38#include <babeltrace/trace-ir/event-class-internal.h>
39#include <babeltrace/trace-ir/stream-class.h>
40f4ba76 40#include <babeltrace/trace-ir/stream-class-const.h>
56e18c4c
PP
41#include <babeltrace/trace-ir/stream-class-internal.h>
42#include <babeltrace/trace-ir/stream-internal.h>
43#include <babeltrace/trace-ir/packet.h>
44#include <babeltrace/trace-ir/packet-internal.h>
45#include <babeltrace/trace-ir/trace.h>
46#include <babeltrace/trace-ir/trace-internal.h>
47#include <babeltrace/trace-ir/packet-internal.h>
65300d60 48#include <babeltrace/object.h>
56e18c4c 49#include <babeltrace/trace-ir/attributes-internal.h>
3d9990ac 50#include <babeltrace/compiler-internal.h>
f6ccaed9 51#include <babeltrace/assert-internal.h>
7b010242 52#include <inttypes.h>
273b65be 53
3dca2276 54BT_HIDDEN
40f4ba76 55void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen)
3dca2276 56{
3dca2276 57 BT_ASSERT(event);
44c440bc
PP
58 BT_LIB_LOGD("Setting event's frozen state: %!+e, is-frozen=%d",
59 event, is_frozen);
312c056a
PP
60
61 if (event->header_field) {
44c440bc
PP
62 BT_LOGD_STR("Setting event's header field's frozen state.");
63 bt_field_set_is_frozen(
6c677fb5 64 event->header_field->field, is_frozen);
312c056a
PP
65 }
66
44c440bc
PP
67 if (event->common_context_field) {
68 BT_LOGD_STR("Setting event's common context field's frozen state.");
69 bt_field_set_is_frozen(
70 event->common_context_field, is_frozen);
312c056a
PP
71 }
72
44c440bc
PP
73 if (event->specific_context_field) {
74 BT_LOGD_STR("Setting event's specific context field's frozen state.");
75 bt_field_set_is_frozen(event->specific_context_field,
6c677fb5 76 is_frozen);
312c056a
PP
77 }
78
79 if (event->payload_field) {
44c440bc
PP
80 BT_LOGD_STR("Setting event's payload field's frozen state.");
81 bt_field_set_is_frozen(event->payload_field,
6c677fb5 82 is_frozen);
312c056a
PP
83 }
84
40f4ba76 85 ((struct bt_event *) event)->frozen = is_frozen;
44c440bc 86 BT_LOGD_STR("Setting event's packet's frozen state.");
cb6f1f7d 87 bt_packet_set_is_frozen(event->packet, is_frozen);
3dca2276
PP
88}
89
312c056a 90static
44c440bc 91void recycle_event_header_field(struct bt_field_wrapper *field_wrapper,
312c056a
PP
92 struct bt_stream_class *stream_class)
93{
94 BT_ASSERT(field_wrapper);
95 BT_LIB_LOGD("Recycling event header field: "
96 "addr=%p, %![sc-]+S, %![field-]+f", field_wrapper,
97 stream_class, field_wrapper->field);
98 bt_object_pool_recycle_object(
99 &stream_class->event_header_field_pool,
100 field_wrapper);
101}
102
44c440bc 103static inline
312c056a 104struct bt_field_wrapper *create_event_header_field(
44c440bc 105 struct bt_stream_class *stream_class)
312c056a
PP
106{
107 struct bt_field_wrapper *field_wrapper = NULL;
108
109 field_wrapper = bt_field_wrapper_create(
44c440bc 110 &stream_class->event_header_field_pool,
40f4ba76 111 stream_class->event_header_fc);
312c056a
PP
112 if (!field_wrapper) {
113 goto error;
114 }
115
116 goto end;
117
118error:
119 if (field_wrapper) {
44c440bc 120 recycle_event_header_field(field_wrapper, stream_class);
312c056a
PP
121 field_wrapper = NULL;
122 }
123
124end:
125 return field_wrapper;
126}
127
128BT_HIDDEN
129struct bt_event *bt_event_new(struct bt_event_class *event_class)
3dca2276 130{
3dca2276 131 struct bt_event *event = NULL;
312c056a 132 struct bt_stream_class *stream_class;
5cd6d0e5 133 struct bt_field_class *fc;
3dca2276 134
44c440bc 135 BT_ASSERT(event_class);
3dca2276
PP
136 event = g_new0(struct bt_event, 1);
137 if (!event) {
138 BT_LOGE_STR("Failed to allocate one event.");
139 goto error;
140 }
141
44c440bc 142 bt_object_init_unique(&event->base);
312c056a
PP
143 stream_class = bt_event_class_borrow_stream_class(event_class);
144 BT_ASSERT(stream_class);
44c440bc 145
40f4ba76 146 if (stream_class->event_header_fc) {
44c440bc
PP
147 event->header_field = create_event_header_field(stream_class);
148 if (!event->header_field) {
149 BT_LOGE_STR("Cannot create event header field.");
150 goto error;
151 }
152 }
153
40f4ba76 154 fc = stream_class->event_common_context_fc;
5cd6d0e5
PP
155 if (fc) {
156 event->common_context_field = bt_field_create(fc);
44c440bc
PP
157 if (!event->common_context_field) {
158 /* bt_field_create() logs errors */
159 goto error;
160 }
161 }
162
40f4ba76 163 fc = event_class->specific_context_fc;
5cd6d0e5
PP
164 if (fc) {
165 event->specific_context_field = bt_field_create(fc);
44c440bc
PP
166 if (!event->specific_context_field) {
167 /* bt_field_create() logs errors */
168 goto error;
169 }
170 }
171
40f4ba76 172 fc = event_class->payload_fc;
5cd6d0e5
PP
173 if (fc) {
174 event->payload_field = bt_field_create(fc);
44c440bc
PP
175 if (!event->payload_field) {
176 /* bt_field_create() logs errors */
177 goto error;
178 }
179 }
180
181 if (stream_class->default_clock_class) {
182 event->default_cv = bt_clock_value_create(
183 stream_class->default_clock_class);
184 if (!event->default_cv) {
185 /* bt_clock_value_create() logs errors */
186 goto error;
187 }
312c056a
PP
188 }
189
3dca2276
PP
190 goto end;
191
192error:
312c056a
PP
193 if (event) {
194 bt_event_destroy(event);
195 event = NULL;
196 }
197
198end:
199 return event;
200}
201
094ff7c0 202struct bt_event_class *bt_event_borrow_class(struct bt_event *event)
2f100782 203{
f6ccaed9 204 BT_ASSERT_PRE_NON_NULL(event, "Event");
cb6f1f7d 205 return event->class;
2f100782
JG
206}
207
40f4ba76
PP
208const struct bt_event_class *bt_event_borrow_class_const(
209 const struct bt_event *event)
210{
211 return bt_event_borrow_class((void *) event);
212}
213
f6ccaed9 214struct bt_stream *bt_event_borrow_stream(struct bt_event *event)
f6ccaed9
PP
215{
216 BT_ASSERT_PRE_NON_NULL(event, "Event");
094ff7c0 217 return event->packet ? event->packet->stream : NULL;
f6ccaed9
PP
218}
219
40f4ba76
PP
220const struct bt_stream *bt_event_borrow_stream_const(
221 const struct bt_event *event)
222{
223 return bt_event_borrow_stream((void *) event);
224}
225
44c440bc 226struct bt_field *bt_event_borrow_header_field(struct bt_event *event)
e5e6eb3a 227{
cb6f1f7d 228 BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc 229 return event->header_field ? event->header_field->field : NULL;
e5e6eb3a
JG
230}
231
40f4ba76
PP
232const struct bt_field *bt_event_borrow_header_field_const(
233 const struct bt_event *event)
e5be10ef 234{
40f4ba76
PP
235 BT_ASSERT_PRE_NON_NULL(event, "Event");
236 return event->header_field ? event->header_field->field : NULL;
e5be10ef
PP
237}
238
44c440bc 239struct bt_field *bt_event_borrow_common_context_field(struct bt_event *event)
662e778c 240{
cb6f1f7d 241 BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc 242 return event->common_context_field;
662e778c
JG
243}
244
40f4ba76
PP
245const struct bt_field *bt_event_borrow_common_context_field_const(
246 const struct bt_event *event)
e5be10ef 247{
40f4ba76
PP
248 BT_ASSERT_PRE_NON_NULL(event, "Event");
249 return event->common_context_field;
e5be10ef
PP
250}
251
44c440bc 252struct bt_field *bt_event_borrow_specific_context_field(struct bt_event *event)
f655a84d 253{
cb6f1f7d 254 BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc 255 return event->specific_context_field;
f655a84d
JG
256}
257
40f4ba76
PP
258const struct bt_field *bt_event_borrow_specific_context_field_const(
259 const struct bt_event *event)
e5be10ef 260{
40f4ba76
PP
261 BT_ASSERT_PRE_NON_NULL(event, "Event");
262 return event->specific_context_field;
e5be10ef
PP
263}
264
44c440bc 265struct bt_field *bt_event_borrow_payload_field(struct bt_event *event)
5fd2e9fd 266{
cb6f1f7d 267 BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc 268 return event->payload_field;
5fd2e9fd
PP
269}
270
40f4ba76
PP
271const struct bt_field *bt_event_borrow_payload_field_const(
272 const struct bt_event *event)
e5be10ef 273{
40f4ba76
PP
274 BT_ASSERT_PRE_NON_NULL(event, "Event");
275 return event->payload_field;
e5be10ef
PP
276}
277
312c056a
PP
278static
279void release_event_header_field(struct bt_field_wrapper *field_wrapper,
cb6f1f7d 280 struct bt_event *event)
273b65be 281{
44c440bc 282 if (!event->class) {
312c056a
PP
283 bt_field_wrapper_destroy(field_wrapper);
284 } else {
285 struct bt_stream_class *stream_class =
44c440bc 286 bt_event_class_borrow_stream_class(event->class);
312c056a
PP
287
288 BT_ASSERT(stream_class);
44c440bc 289 recycle_event_header_field(field_wrapper, stream_class);
312c056a 290 }
273b65be
JG
291}
292
44c440bc
PP
293BT_HIDDEN
294void bt_event_destroy(struct bt_event *event)
cb6f1f7d 295{
44c440bc
PP
296 BT_ASSERT(event);
297 BT_LIB_LOGD("Destroying event: %!+e", event);
cb6f1f7d
PP
298
299 if (event->header_field) {
300 BT_LOGD_STR("Releasing event's header field.");
44c440bc 301 release_event_header_field(event->header_field, event);
238b7404 302 event->header_field = NULL;
cb6f1f7d
PP
303 }
304
44c440bc
PP
305 if (event->common_context_field) {
306 BT_LOGD_STR("Destroying event's stream event context field.");
307 bt_field_destroy(event->common_context_field);
238b7404 308 event->common_context_field = NULL;
cb6f1f7d
PP
309 }
310
44c440bc
PP
311 if (event->specific_context_field) {
312 BT_LOGD_STR("Destroying event's context field.");
313 bt_field_destroy(event->specific_context_field);
238b7404 314 event->specific_context_field = NULL;
cb6f1f7d
PP
315 }
316
317 if (event->payload_field) {
44c440bc
PP
318 BT_LOGD_STR("Destroying event's payload field.");
319 bt_field_destroy(event->payload_field);
238b7404 320 event->payload_field = NULL;
cb6f1f7d
PP
321 }
322
44c440bc 323 BT_LOGD_STR("Putting event's class.");
65300d60 324 bt_object_put_ref(event->class);
44c440bc
PP
325
326 if (event->default_cv) {
327 bt_clock_value_recycle(event->default_cv);
238b7404 328 event->default_cv = NULL;
cb6f1f7d 329 }
cb6f1f7d 330
03039f21 331 BT_LOGD_STR("Putting event's packet.");
238b7404 332 BT_OBJECT_PUT_REF_AND_RESET(event->packet);
273b65be
JG
333 g_free(event);
334}
335
40f4ba76
PP
336void bt_event_set_default_clock_value(struct bt_event *event,
337 uint64_t value_cycles)
e22b45d0 338{
44c440bc
PP
339 struct bt_stream_class *sc;
340
e22b45d0 341 BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc
PP
342 BT_ASSERT_PRE_EVENT_HOT(event);
343 sc = bt_event_class_borrow_stream_class_inline(event->class);
344 BT_ASSERT(sc);
345 BT_ASSERT_PRE(sc->default_clock_class,
346 "Event's stream class has no default clock class: "
347 "%![ev-]+e, %![sc-]+S", event, sc);
348 BT_ASSERT(event->default_cv);
349 bt_clock_value_set_value_inline(event->default_cv, value_cycles);
350 BT_LIB_LOGV("Set event's default clock value: %![event-]+e, "
351 "value=%" PRIu64, event, value_cycles);
e22b45d0
PP
352}
353
40f4ba76
PP
354enum bt_clock_value_status bt_event_borrow_default_clock_value_const(
355 const struct bt_event *event,
356 const struct bt_clock_value **clock_value)
78586d8a 357{
f6ccaed9 358 BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc
PP
359 BT_ASSERT_PRE_NON_NULL(clock_value, "Clock value (output)");
360 *clock_value = event->default_cv;
361 return BT_CLOCK_VALUE_STATUS_KNOWN;
1556a1af
JG
362}
363
094ff7c0 364struct bt_packet *bt_event_borrow_packet(struct bt_event *event)
5c0f40f4 365{
f6ccaed9 366 BT_ASSERT_PRE_NON_NULL(event, "Event");
44c440bc 367 return event->packet;
5c0f40f4
JG
368}
369
40f4ba76
PP
370const struct bt_packet *bt_event_borrow_packet_const(
371 const struct bt_event *event)
e5be10ef 372{
40f4ba76 373 return bt_event_borrow_packet((void *) event);
e5be10ef
PP
374}
375
40f4ba76
PP
376int bt_event_move_header_field(struct bt_event *event,
377 struct bt_event_header_field *header_field)
312c056a
PP
378{
379 struct bt_stream_class *stream_class;
40f4ba76 380 struct bt_field_wrapper *field_wrapper = (void *) header_field;
312c056a
PP
381
382 BT_ASSERT_PRE_NON_NULL(event, "Event");
383 BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field");
44c440bc
PP
384 BT_ASSERT_PRE_EVENT_HOT(event);
385 stream_class = bt_event_class_borrow_stream_class_inline(event->class);
5cd6d0e5
PP
386 BT_ASSERT_PRE(stream_class->event_header_fc,
387 "Stream class has no event header field classe: %!+S",
312c056a
PP
388 stream_class);
389
390 /* Recycle current header field: always exists */
cb6f1f7d 391 BT_ASSERT(event->header_field);
44c440bc 392 recycle_event_header_field(event->header_field, stream_class);
312c056a
PP
393
394 /* Move new field */
44c440bc 395 event->header_field = field_wrapper;
312c056a
PP
396 return 0;
397}
This page took 0.073048 seconds and 4 git commands to generate.