Commit | Line | Data |
---|---|---|
273b65be | 1 | /* |
0235b0db MJ |
2 | * SPDX-License-Identifier: MIT |
3 | * | |
e2f7325d | 4 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
de9dd397 | 5 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be JG |
6 | */ |
7 | ||
0235b0db MJ |
8 | #ifndef BABELTRACE_TRACE_IR_EVENT_INTERNAL_H |
9 | #define BABELTRACE_TRACE_IR_EVENT_INTERNAL_H | |
10 | ||
44c440bc | 11 | /* Protection: this file uses BT_LIB_LOG*() macros directly */ |
7151fb67 | 12 | #ifndef BT_LIB_LOG_SUPPORTED |
c2d9d9cf | 13 | # error Please include "lib/logging.h" before including this file. |
44c440bc PP |
14 | #endif |
15 | ||
d98421f2 | 16 | #include "lib/assert-cond.h" |
3fadfbc0 MJ |
17 | #include <babeltrace2/value.h> |
18 | #include <babeltrace2/trace-ir/stream-class.h> | |
19 | #include <babeltrace2/trace-ir/stream.h> | |
3fadfbc0 | 20 | #include <babeltrace2/trace-ir/packet.h> |
3fadfbc0 | 21 | #include <babeltrace2/trace-ir/field.h> |
578e048b MJ |
22 | #include "lib/object.h" |
23 | #include "common/assert.h" | |
273b65be | 24 | #include <glib.h> |
c4f23e30 | 25 | #include <stdbool.h> |
273b65be | 26 | |
578e048b MJ |
27 | #include "event-class.h" |
28 | #include "field.h" | |
578e048b MJ |
29 | #include "packet.h" |
30 | #include "stream.h" | |
31 | ||
bdb288b3 PP |
32 | #define BT_ASSERT_PRE_DEV_EVENT_HOT(_event) \ |
33 | BT_ASSERT_PRE_DEV_HOT(((const struct bt_event *) (_event)), \ | |
40f4ba76 | 34 | "Event", ": %!+e", (_event)) |
dc3fffef | 35 | |
cb6f1f7d | 36 | struct bt_event { |
83509119 | 37 | struct bt_object base; |
862ca4ed PP |
38 | |
39 | /* Owned by this */ | |
cb6f1f7d | 40 | struct bt_event_class *class; |
862ca4ed | 41 | |
26fc5aed | 42 | /* Owned by this (can be `NULL`) */ |
44c440bc | 43 | struct bt_packet *packet; |
862ca4ed | 44 | |
26fc5aed PP |
45 | /* Owned by this */ |
46 | struct bt_stream *stream; | |
47 | ||
44c440bc PP |
48 | struct bt_field *common_context_field; |
49 | struct bt_field *specific_context_field; | |
cb6f1f7d | 50 | struct bt_field *payload_field; |
44c440bc | 51 | bool frozen; |
273b65be JG |
52 | }; |
53 | ||
cb6f1f7d | 54 | void bt_event_destroy(struct bt_event *event); |
273b65be | 55 | |
cb6f1f7d | 56 | struct bt_event *bt_event_new(struct bt_event_class *event_class); |
4ce9f9d0 | 57 | |
40f4ba76 | 58 | void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen); |
f6ccaed9 PP |
59 | |
60 | #ifdef BT_DEV_MODE | |
6c677fb5 | 61 | # define bt_event_set_is_frozen _bt_event_set_is_frozen |
f6ccaed9 | 62 | #else |
6c677fb5 | 63 | # define bt_event_set_is_frozen(_event, _is_frozen) |
f6ccaed9 PP |
64 | #endif |
65 | ||
91d81473 | 66 | __attribute__((unused)) |
3dca2276 | 67 | static inline |
cb6f1f7d | 68 | void _bt_event_reset_dev_mode(struct bt_event *event) |
3dca2276 | 69 | { |
98b15851 | 70 | BT_ASSERT_DBG(event); |
312c056a | 71 | |
44c440bc PP |
72 | if (event->common_context_field) { |
73 | bt_field_set_is_frozen( | |
74 | event->common_context_field, false); | |
75 | bt_field_reset( | |
76 | event->common_context_field); | |
312c056a PP |
77 | } |
78 | ||
44c440bc PP |
79 | if (event->specific_context_field) { |
80 | bt_field_set_is_frozen( | |
81 | event->specific_context_field, false); | |
82 | bt_field_reset(event->specific_context_field); | |
312c056a PP |
83 | } |
84 | ||
85 | if (event->payload_field) { | |
44c440bc | 86 | bt_field_set_is_frozen( |
cb6f1f7d | 87 | event->payload_field, false); |
44c440bc | 88 | bt_field_reset(event->payload_field); |
6c677fb5 | 89 | } |
6c677fb5 PP |
90 | } |
91 | ||
92 | #ifdef BT_DEV_MODE | |
93 | # define bt_event_reset_dev_mode _bt_event_reset_dev_mode | |
94 | #else | |
95 | # define bt_event_reset_dev_mode(_x) | |
96 | #endif | |
312c056a | 97 | |
6c677fb5 PP |
98 | static inline |
99 | void bt_event_reset(struct bt_event *event) | |
100 | { | |
98b15851 | 101 | BT_ASSERT_DBG(event); |
44c440bc | 102 | BT_LIB_LOGD("Resetting event: %!+e", event); |
6c677fb5 | 103 | bt_event_set_is_frozen(event, false); |
6871026b | 104 | bt_object_put_ref_no_null_check(&event->stream->base); |
26fc5aed PP |
105 | event->stream = NULL; |
106 | ||
107 | if (event->packet) { | |
6871026b | 108 | bt_object_put_ref_no_null_check(&event->packet->base); |
26fc5aed PP |
109 | event->packet = NULL; |
110 | } | |
6c677fb5 PP |
111 | } |
112 | ||
113 | static inline | |
114 | void bt_event_recycle(struct bt_event *event) | |
115 | { | |
116 | struct bt_event_class *event_class; | |
117 | ||
98b15851 | 118 | BT_ASSERT_DBG(event); |
6c677fb5 PP |
119 | BT_LIB_LOGD("Recycling event: %!+e", event); |
120 | ||
121 | /* | |
122 | * Those are the important ordered steps: | |
123 | * | |
124 | * 1. Reset the event object (put any permanent reference it | |
125 | * has, unfreeze it and its fields in developer mode, etc.), | |
126 | * but do NOT put its class's reference. This event class | |
127 | * contains the pool to which we're about to recycle this | |
128 | * event object, so we must guarantee its existence thanks | |
129 | * to this existing reference. | |
130 | * | |
131 | * 2. Move the event class reference to our `event_class` | |
132 | * variable so that we can set the event's class member | |
133 | * to NULL before recycling it. We CANNOT do this after | |
65300d60 | 134 | * we put the event class reference because this bt_object_put_ref() |
6c677fb5 PP |
135 | * could destroy the event class, also destroying its |
136 | * event pool, thus also destroying our event object (this | |
137 | * would result in an invalid write access). | |
138 | * | |
139 | * 3. Recycle the event object. | |
140 | * | |
141 | * 4. Put our event class reference. | |
142 | */ | |
143 | bt_event_reset(event); | |
cb6f1f7d | 144 | event_class = event->class; |
98b15851 | 145 | BT_ASSERT_DBG(event_class); |
cb6f1f7d | 146 | event->class = NULL; |
6c677fb5 | 147 | bt_object_pool_recycle_object(&event_class->event_pool, event); |
6871026b | 148 | bt_object_put_ref_no_null_check(&event_class->base); |
6c677fb5 PP |
149 | } |
150 | ||
56e18c4c | 151 | #endif /* BABELTRACE_TRACE_IR_EVENT_INTERNAL_H */ |