Commit | Line | Data |
---|---|---|
f79cf0f0 | 1 | /* |
f2b0325d | 2 | * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com> |
f79cf0f0 PP |
3 | * |
4 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
5 | * of this software and associated documentation files (the "Software"), to deal | |
6 | * in the Software without restriction, including without limitation the rights | |
7 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
8 | * copies of the Software, and to permit persons to whom the Software is | |
9 | * furnished to do so, subject to the following conditions: | |
10 | * | |
11 | * The above copyright notice and this permission notice shall be included in | |
12 | * all copies or substantial portions of the Software. | |
13 | * | |
14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
15 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
16 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
17 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
18 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
19 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
20 | * SOFTWARE. | |
21 | */ | |
22 | ||
b03487ab | 23 | #define BT_LOG_TAG "LIB/PACKET" |
1633ef46 | 24 | #include "lib/logging.h" |
8ea705f0 | 25 | |
57952005 | 26 | #include "lib/assert-pre.h" |
71c5da58 MJ |
27 | #include <babeltrace2/trace-ir/packet-const.h> |
28 | #include <babeltrace2/trace-ir/packet.h> | |
71c5da58 | 29 | #include <babeltrace2/trace-ir/trace.h> |
71c5da58 MJ |
30 | #include <babeltrace2/trace-ir/stream-class.h> |
31 | #include <babeltrace2/trace-ir/stream.h> | |
57952005 MJ |
32 | #include "lib/object.h" |
33 | #include "common/assert.h" | |
be514b0c | 34 | #include <inttypes.h> |
f79cf0f0 | 35 | |
57952005 MJ |
36 | #include "field.h" |
37 | #include "field-wrapper.h" | |
38 | #include "packet.h" | |
39 | #include "stream-class.h" | |
40 | #include "stream.h" | |
41 | #include "trace.h" | |
fb25b9e3 | 42 | #include "lib/func-status.h" |
57952005 | 43 | |
5fe68922 | 44 | struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet) |
f79cf0f0 | 45 | { |
fa6cfec3 | 46 | BT_ASSERT_PRE_DEV_NON_NULL(packet, "Packet"); |
5fe68922 | 47 | return packet->stream; |
f79cf0f0 PP |
48 | } |
49 | ||
78cf9df6 PP |
50 | const struct bt_stream *bt_packet_borrow_stream_const( |
51 | const struct bt_packet *packet) | |
9e550e5f | 52 | { |
78cf9df6 | 53 | return bt_packet_borrow_stream((void *) packet); |
9e550e5f PP |
54 | } |
55 | ||
7b33a0e0 | 56 | struct bt_field *bt_packet_borrow_context_field(struct bt_packet *packet) |
f79cf0f0 | 57 | { |
fa6cfec3 | 58 | BT_ASSERT_PRE_DEV_NON_NULL(packet, "Packet"); |
7b33a0e0 | 59 | return packet->context_field ? packet->context_field->field : NULL; |
a6918753 | 60 | } |
c5c82c6e | 61 | |
78cf9df6 PP |
62 | const struct bt_field *bt_packet_borrow_context_field_const( |
63 | const struct bt_packet *packet) | |
9e550e5f | 64 | { |
78cf9df6 | 65 | return bt_packet_borrow_context_field((void *) packet); |
9e550e5f PP |
66 | } |
67 | ||
a6918753 | 68 | BT_HIDDEN |
78cf9df6 | 69 | void _bt_packet_set_is_frozen(const struct bt_packet *packet, bool is_frozen) |
a6918753 | 70 | { |
435ec8af | 71 | if (!packet) { |
a6918753 | 72 | return; |
c5c82c6e PP |
73 | } |
74 | ||
7b33a0e0 PP |
75 | BT_LIB_LOGD("Setting packet's frozen state: %![packet-]+a, " |
76 | "is-frozen=%d", packet, is_frozen); | |
a6918753 | 77 | |
7b33a0e0 PP |
78 | if (packet->context_field) { |
79 | BT_LOGD_STR("Setting packet's context field's frozen state."); | |
80 | bt_field_set_is_frozen(packet->context_field->field, | |
c5a24b0a | 81 | is_frozen); |
a6918753 PP |
82 | } |
83 | ||
78cf9df6 | 84 | ((struct bt_packet *) packet)->frozen = is_frozen; |
8b45963b PP |
85 | } |
86 | ||
a6918753 | 87 | static inline |
7b33a0e0 | 88 | void reset_packet(struct bt_packet *packet) |
8b45963b | 89 | { |
a6918753 | 90 | BT_ASSERT(packet); |
7b33a0e0 | 91 | BT_LIB_LOGD("Resetting packet: %!+a", packet); |
c5a24b0a | 92 | bt_packet_set_is_frozen(packet, false); |
a6918753 | 93 | |
7b33a0e0 PP |
94 | if (packet->context_field) { |
95 | bt_field_set_is_frozen(packet->context_field->field, false); | |
96 | bt_field_reset(packet->context_field->field); | |
a6918753 | 97 | } |
f79cf0f0 PP |
98 | } |
99 | ||
a6918753 | 100 | static |
7b33a0e0 | 101 | void recycle_context_field(struct bt_field_wrapper *context_field, |
a6918753 | 102 | struct bt_stream_class *stream_class) |
f79cf0f0 | 103 | { |
a6918753 PP |
104 | BT_ASSERT(context_field); |
105 | BT_LIB_LOGD("Recycling packet context field: " | |
106 | "addr=%p, %![sc-]+S, %![field-]+f", context_field, | |
107 | stream_class, context_field->field); | |
108 | bt_object_pool_recycle_object(&stream_class->packet_context_field_pool, | |
109 | context_field); | |
f79cf0f0 PP |
110 | } |
111 | ||
112 | BT_HIDDEN | |
a6918753 | 113 | void bt_packet_recycle(struct bt_packet *packet) |
f79cf0f0 | 114 | { |
a6918753 | 115 | struct bt_stream *stream; |
f79cf0f0 | 116 | |
a6918753 PP |
117 | BT_ASSERT(packet); |
118 | BT_LIB_LOGD("Recycling packet: %!+a", packet); | |
119 | ||
120 | /* | |
121 | * Those are the important ordered steps: | |
122 | * | |
123 | * 1. Reset the packet object (put any permanent reference it | |
124 | * has, unfreeze it and its fields in developer mode, etc.), | |
125 | * but do NOT put its stream's reference. This stream | |
126 | * contains the pool to which we're about to recycle this | |
127 | * packet object, so we must guarantee its existence thanks | |
128 | * to this existing reference. | |
129 | * | |
130 | * 2. Move the stream reference to our `stream` | |
131 | * variable so that we can set the packet's stream member | |
132 | * to NULL before recycling it. We CANNOT do this after | |
8138bfe1 | 133 | * we put the stream reference because this bt_object_put_ref() |
a6918753 PP |
134 | * could destroy the stream, also destroying its |
135 | * packet pool, thus also destroying our packet object (this | |
136 | * would result in an invalid write access). | |
137 | * | |
138 | * 3. Recycle the packet object. | |
139 | * | |
140 | * 4. Put our stream reference. | |
141 | */ | |
7b33a0e0 | 142 | reset_packet(packet); |
a6918753 PP |
143 | stream = packet->stream; |
144 | BT_ASSERT(stream); | |
145 | packet->stream = NULL; | |
146 | bt_object_pool_recycle_object(&stream->packet_pool, packet); | |
864aa43f | 147 | bt_object_put_ref_no_null_check(&stream->base); |
f79cf0f0 PP |
148 | } |
149 | ||
a6918753 PP |
150 | BT_HIDDEN |
151 | void bt_packet_destroy(struct bt_packet *packet) | |
f79cf0f0 | 152 | { |
7b33a0e0 | 153 | BT_LIB_LOGD("Destroying packet: %!+a", packet); |
a6918753 | 154 | |
7b33a0e0 | 155 | if (packet->context_field) { |
a6918753 PP |
156 | if (packet->stream) { |
157 | BT_LOGD_STR("Recycling packet's context field."); | |
7b33a0e0 PP |
158 | recycle_context_field(packet->context_field, |
159 | packet->stream->class); | |
a6918753 | 160 | } else { |
7b33a0e0 | 161 | bt_field_wrapper_destroy(packet->context_field); |
a6918753 | 162 | } |
1248f5ea PP |
163 | |
164 | packet->context_field = NULL; | |
a6918753 PP |
165 | } |
166 | ||
d409daba | 167 | BT_LOGD_STR("Putting packet's stream."); |
1248f5ea | 168 | BT_OBJECT_PUT_REF_AND_RESET(packet->stream); |
f79cf0f0 PP |
169 | g_free(packet); |
170 | } | |
171 | ||
a6918753 PP |
172 | BT_HIDDEN |
173 | struct bt_packet *bt_packet_new(struct bt_stream *stream) | |
f79cf0f0 | 174 | { |
839d52a5 | 175 | struct bt_packet *packet = NULL; |
10b7a2e4 | 176 | struct bt_trace_class *trace_class = NULL; |
f79cf0f0 | 177 | |
a6918753 | 178 | BT_ASSERT(stream); |
7b33a0e0 | 179 | BT_LIB_LOGD("Creating packet object: %![stream-]+s", stream); |
839d52a5 | 180 | packet = g_new0(struct bt_packet, 1); |
f79cf0f0 | 181 | if (!packet) { |
a8f90e5d PP |
182 | BT_LIB_LOGE_APPEND_CAUSE( |
183 | "Failed to allocate one packet object."); | |
7b33a0e0 | 184 | goto error; |
f79cf0f0 PP |
185 | } |
186 | ||
1d7bf349 PP |
187 | bt_object_init_shared(&packet->base, |
188 | (bt_object_release_func) bt_packet_recycle); | |
4b70020d | 189 | packet->stream = stream; |
864aa43f | 190 | bt_object_get_ref_no_null_check(stream); |
10b7a2e4 PP |
191 | trace_class = bt_stream_class_borrow_trace_class_inline(stream->class); |
192 | BT_ASSERT(trace_class); | |
be514b0c | 193 | |
939190b3 | 194 | if (stream->class->packet_context_fc) { |
7b33a0e0 PP |
195 | BT_LOGD_STR("Creating initial packet context field."); |
196 | packet->context_field = bt_field_wrapper_create( | |
197 | &stream->class->packet_context_field_pool, | |
939190b3 | 198 | stream->class->packet_context_fc); |
7b33a0e0 | 199 | if (!packet->context_field) { |
a8f90e5d PP |
200 | BT_LIB_LOGE_APPEND_CAUSE( |
201 | "Cannot create packet context field wrapper."); | |
7b33a0e0 | 202 | goto error; |
be514b0c | 203 | } |
f79cf0f0 PP |
204 | } |
205 | ||
7b33a0e0 PP |
206 | BT_LIB_LOGD("Created packet object: %!+a", packet); |
207 | goto end; | |
e5815ba2 | 208 | |
7b33a0e0 | 209 | error: |
8138bfe1 | 210 | BT_OBJECT_PUT_REF_AND_RESET(packet); |
e5815ba2 PP |
211 | |
212 | end: | |
7b33a0e0 | 213 | return packet; |
e5815ba2 PP |
214 | } |
215 | ||
6a6975d2 | 216 | struct bt_packet *bt_packet_create(const struct bt_stream *c_stream) |
a6918753 PP |
217 | { |
218 | struct bt_packet *packet = NULL; | |
6a6975d2 | 219 | struct bt_stream *stream = (void *) c_stream; |
a6918753 PP |
220 | |
221 | BT_ASSERT_PRE_NON_NULL(stream, "Stream"); | |
37a93d41 PP |
222 | BT_ASSERT_PRE(stream->class->supports_packets, |
223 | "Stream class does not support packets: %![sc-]+S", | |
224 | stream->class); | |
a6918753 | 225 | packet = bt_object_pool_create_object(&stream->packet_pool); |
85e7137b | 226 | if (G_UNLIKELY(!packet)) { |
a8f90e5d PP |
227 | BT_LIB_LOGE_APPEND_CAUSE( |
228 | "Cannot allocate one packet from stream's packet pool: " | |
a6918753 | 229 | "%![stream-]+s", stream); |
c5a24b0a | 230 | goto end; |
a6918753 PP |
231 | } |
232 | ||
85e7137b | 233 | if (G_LIKELY(!packet->stream)) { |
c5a24b0a | 234 | packet->stream = stream; |
864aa43f | 235 | bt_object_get_ref_no_null_check_no_parent_check( |
18acc6f8 | 236 | &packet->stream->base); |
a6918753 PP |
237 | } |
238 | ||
a6918753 | 239 | end: |
9e550e5f | 240 | return (void *) packet; |
a6918753 PP |
241 | } |
242 | ||
fb25b9e3 PP |
243 | enum bt_packet_move_context_field_status bt_packet_move_context_field( |
244 | struct bt_packet *packet, | |
78cf9df6 | 245 | struct bt_packet_context_field *context_field) |
a6918753 PP |
246 | { |
247 | struct bt_stream_class *stream_class; | |
248 | struct bt_field_wrapper *field_wrapper = (void *) context_field; | |
249 | ||
fa6cfec3 PP |
250 | BT_ASSERT_PRE_DEV_NON_NULL(packet, "Packet"); |
251 | BT_ASSERT_PRE_DEV_NON_NULL(field_wrapper, "Context field"); | |
252 | BT_ASSERT_PRE_DEV_HOT(packet, "Packet", ": %!+a", packet); | |
7b33a0e0 | 253 | stream_class = packet->stream->class; |
fa6cfec3 | 254 | BT_ASSERT_PRE_DEV(stream_class->packet_context_fc, |
66fd07a5 | 255 | "Stream class has no packet context field class: %!+S", |
a6918753 | 256 | stream_class); |
fa6cfec3 | 257 | BT_ASSERT_PRE_DEV(field_wrapper->field->class == |
939190b3 | 258 | stream_class->packet_context_fc, |
0476f6f7 | 259 | "Unexpected packet context field's class: " |
939190b3 PP |
260 | "%![fc-]+F, %![expected-fc-]+F", field_wrapper->field->class, |
261 | stream_class->packet_context_fc); | |
a6918753 PP |
262 | |
263 | /* Recycle current context field: always exists */ | |
7b33a0e0 PP |
264 | BT_ASSERT(packet->context_field); |
265 | recycle_context_field(packet->context_field, stream_class); | |
a6918753 PP |
266 | |
267 | /* Move new field */ | |
7b33a0e0 | 268 | packet->context_field = field_wrapper; |
fb25b9e3 | 269 | return BT_FUNC_STATUS_OK; |
a6918753 | 270 | } |
8fc063a2 | 271 | |
8c6884d9 PP |
272 | void bt_packet_get_ref(const struct bt_packet *packet) |
273 | { | |
274 | bt_object_get_ref(packet); | |
275 | } | |
276 | ||
277 | void bt_packet_put_ref(const struct bt_packet *packet) | |
278 | { | |
279 | bt_object_put_ref(packet); | |
280 | } |