Commit | Line | Data |
---|---|---|
108b91d0 PP |
1 | #ifndef BABELTRACE_TRACE_IR_EVENT_INTERNAL_H |
2 | #define BABELTRACE_TRACE_IR_EVENT_INTERNAL_H | |
273b65be JG |
3 | |
4 | /* | |
f2b0325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
de9dd397 | 6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be | 7 | * |
273b65be JG |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | * SOFTWARE. | |
25 | */ | |
26 | ||
7b33a0e0 PP |
27 | /* Protection: this file uses BT_LIB_LOG*() macros directly */ |
28 | #ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H | |
29 | # error Please define include <babeltrace/lib-logging-internal.h> before including this file. | |
30 | #endif | |
31 | ||
8deee039 | 32 | #include <babeltrace/assert-pre-internal.h> |
273b65be | 33 | #include <babeltrace/babeltrace-internal.h> |
0f15f666 | 34 | #include <babeltrace/value.h> |
108b91d0 PP |
35 | #include <babeltrace/trace-ir/clock-value-internal.h> |
36 | #include <babeltrace/trace-ir/stream-class.h> | |
37 | #include <babeltrace/trace-ir/stream.h> | |
38 | #include <babeltrace/trace-ir/stream-internal.h> | |
39 | #include <babeltrace/trace-ir/packet.h> | |
40 | #include <babeltrace/trace-ir/packet-internal.h> | |
0f15f666 PP |
41 | #include <babeltrace/trace-ir/field.h> |
42 | #include <babeltrace/trace-ir/field-internal.h> | |
108b91d0 PP |
43 | #include <babeltrace/trace-ir/event-class-internal.h> |
44 | #include <babeltrace/trace-ir/field-wrapper-internal.h> | |
83509119 | 45 | #include <babeltrace/object-internal.h> |
8b45963b | 46 | #include <babeltrace/assert-internal.h> |
273b65be JG |
47 | #include <glib.h> |
48 | ||
7b33a0e0 | 49 | #define BT_ASSERT_PRE_EVENT_HOT(_event) \ |
78cf9df6 PP |
50 | BT_ASSERT_PRE_HOT(((const struct bt_event *) (_event)), \ |
51 | "Event", ": %!+e", (_event)) | |
dc3fffef | 52 | |
18acc6f8 | 53 | struct bt_event { |
83509119 | 54 | struct bt_object base; |
10b7a2e4 PP |
55 | |
56 | /* Owned by this */ | |
18acc6f8 | 57 | struct bt_event_class *class; |
10b7a2e4 PP |
58 | |
59 | /* Owned by this */ | |
7b33a0e0 | 60 | struct bt_packet *packet; |
10b7a2e4 | 61 | |
a6918753 | 62 | struct bt_field_wrapper *header_field; |
7b33a0e0 PP |
63 | struct bt_field *common_context_field; |
64 | struct bt_field *specific_context_field; | |
18acc6f8 | 65 | struct bt_field *payload_field; |
7b33a0e0 PP |
66 | struct bt_clock_value *default_cv; |
67 | bool frozen; | |
273b65be JG |
68 | }; |
69 | ||
273b65be | 70 | BT_HIDDEN |
18acc6f8 | 71 | void bt_event_destroy(struct bt_event *event); |
273b65be | 72 | |
4ce9f9d0 | 73 | BT_HIDDEN |
18acc6f8 | 74 | struct bt_event *bt_event_new(struct bt_event_class *event_class); |
4ce9f9d0 | 75 | |
8b45963b | 76 | BT_HIDDEN |
78cf9df6 | 77 | void _bt_event_set_is_frozen(const struct bt_event *event, bool is_frozen); |
8b45963b PP |
78 | |
79 | #ifdef BT_DEV_MODE | |
c5a24b0a | 80 | # define bt_event_set_is_frozen _bt_event_set_is_frozen |
8b45963b | 81 | #else |
c5a24b0a | 82 | # define bt_event_set_is_frozen(_event, _is_frozen) |
8b45963b PP |
83 | #endif |
84 | ||
18acc6f8 | 85 | BT_UNUSED |
8deee039 | 86 | static inline |
18acc6f8 | 87 | void _bt_event_reset_dev_mode(struct bt_event *event) |
8deee039 | 88 | { |
18acc6f8 | 89 | BT_ASSERT(event); |
a6918753 PP |
90 | |
91 | if (event->header_field) { | |
7b33a0e0 | 92 | bt_field_set_is_frozen( |
18acc6f8 | 93 | event->header_field->field, false); |
7b33a0e0 | 94 | bt_field_reset( |
18acc6f8 | 95 | event->header_field->field); |
a6918753 PP |
96 | } |
97 | ||
7b33a0e0 PP |
98 | if (event->common_context_field) { |
99 | bt_field_set_is_frozen( | |
100 | event->common_context_field, false); | |
101 | bt_field_reset( | |
102 | event->common_context_field); | |
a6918753 PP |
103 | } |
104 | ||
7b33a0e0 PP |
105 | if (event->specific_context_field) { |
106 | bt_field_set_is_frozen( | |
107 | event->specific_context_field, false); | |
108 | bt_field_reset(event->specific_context_field); | |
a6918753 PP |
109 | } |
110 | ||
111 | if (event->payload_field) { | |
7b33a0e0 | 112 | bt_field_set_is_frozen( |
18acc6f8 | 113 | event->payload_field, false); |
7b33a0e0 | 114 | bt_field_reset(event->payload_field); |
c5a24b0a | 115 | } |
c5a24b0a PP |
116 | } |
117 | ||
118 | #ifdef BT_DEV_MODE | |
119 | # define bt_event_reset_dev_mode _bt_event_reset_dev_mode | |
120 | #else | |
121 | # define bt_event_reset_dev_mode(_x) | |
122 | #endif | |
a6918753 | 123 | |
c5a24b0a PP |
124 | static inline |
125 | void bt_event_reset(struct bt_event *event) | |
126 | { | |
127 | BT_ASSERT(event); | |
7b33a0e0 | 128 | BT_LIB_LOGD("Resetting event: %!+e", event); |
c5a24b0a | 129 | bt_event_set_is_frozen(event, false); |
7b33a0e0 PP |
130 | |
131 | if (event->default_cv) { | |
132 | bt_clock_value_reset(event->default_cv); | |
133 | } | |
134 | ||
c5a24b0a PP |
135 | bt_object_put_no_null_check(&event->packet->base); |
136 | event->packet = NULL; | |
137 | } | |
138 | ||
139 | static inline | |
140 | void bt_event_recycle(struct bt_event *event) | |
141 | { | |
142 | struct bt_event_class *event_class; | |
143 | ||
144 | BT_ASSERT(event); | |
145 | BT_LIB_LOGD("Recycling event: %!+e", event); | |
146 | ||
147 | /* | |
148 | * Those are the important ordered steps: | |
149 | * | |
150 | * 1. Reset the event object (put any permanent reference it | |
151 | * has, unfreeze it and its fields in developer mode, etc.), | |
152 | * but do NOT put its class's reference. This event class | |
153 | * contains the pool to which we're about to recycle this | |
154 | * event object, so we must guarantee its existence thanks | |
155 | * to this existing reference. | |
156 | * | |
157 | * 2. Move the event class reference to our `event_class` | |
158 | * variable so that we can set the event's class member | |
159 | * to NULL before recycling it. We CANNOT do this after | |
8138bfe1 | 160 | * we put the event class reference because this bt_object_put_ref() |
c5a24b0a PP |
161 | * could destroy the event class, also destroying its |
162 | * event pool, thus also destroying our event object (this | |
163 | * would result in an invalid write access). | |
164 | * | |
165 | * 3. Recycle the event object. | |
166 | * | |
167 | * 4. Put our event class reference. | |
168 | */ | |
169 | bt_event_reset(event); | |
18acc6f8 | 170 | event_class = event->class; |
c5a24b0a | 171 | BT_ASSERT(event_class); |
18acc6f8 | 172 | event->class = NULL; |
c5a24b0a | 173 | bt_object_pool_recycle_object(&event_class->event_pool, event); |
18acc6f8 | 174 | bt_object_put_no_null_check(&event_class->base); |
c5a24b0a PP |
175 | } |
176 | ||
177 | static inline | |
178 | void bt_event_set_packet(struct bt_event *event, struct bt_packet *packet) | |
179 | { | |
180 | BT_ASSERT_PRE_NON_NULL(event, "Event"); | |
181 | BT_ASSERT_PRE_NON_NULL(packet, "Packet"); | |
7b33a0e0 | 182 | BT_ASSERT_PRE_EVENT_HOT(event); |
22e3b27d | 183 | BT_ASSERT_PRE(bt_event_class_borrow_stream_class( |
7b33a0e0 | 184 | event->class) == packet->stream->class, |
22e3b27d | 185 | "Packet's stream class and event's stream class differ: " |
7b33a0e0 | 186 | "%![event-]+e, %![packet-]+a", event, packet); |
22e3b27d | 187 | |
c5a24b0a PP |
188 | BT_ASSERT(!event->packet); |
189 | event->packet = packet; | |
190 | bt_object_get_no_null_check_no_parent_check(&event->packet->base); | |
7b33a0e0 PP |
191 | BT_LIB_LOGV("Set event's packet: %![event-]+e, %![packet-]+a", |
192 | event, packet); | |
c5a24b0a PP |
193 | } |
194 | ||
195 | static inline | |
196 | struct bt_event *bt_event_create(struct bt_event_class *event_class, | |
197 | struct bt_packet *packet) | |
198 | { | |
199 | struct bt_event *event = NULL; | |
200 | ||
201 | BT_ASSERT(event_class); | |
202 | event = bt_object_pool_create_object(&event_class->event_pool); | |
203 | if (unlikely(!event)) { | |
204 | BT_LIB_LOGE("Cannot allocate one event from event class's event pool: " | |
7b33a0e0 | 205 | "%![ec-]+E", event_class); |
c5a24b0a PP |
206 | goto end; |
207 | } | |
208 | ||
7b33a0e0 | 209 | if (likely(!event->class)) { |
18acc6f8 PP |
210 | event->class = event_class; |
211 | bt_object_get_no_null_check(&event_class->base); | |
c5a24b0a PP |
212 | } |
213 | ||
214 | BT_ASSERT(packet); | |
215 | bt_event_set_packet(event, packet); | |
216 | goto end; | |
217 | ||
218 | end: | |
219 | return event; | |
220 | } | |
221 | ||
108b91d0 | 222 | #endif /* BABELTRACE_TRACE_IR_EVENT_INTERNAL_H */ |