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