Commit | Line | Data |
---|---|---|
f79cf0f0 | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
f79cf0f0 | 3 | * |
0235b0db | 4 | * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com> |
f79cf0f0 PP |
5 | */ |
6 | ||
350ad6c1 | 7 | #define BT_LOG_TAG "LIB/PACKET" |
c2d9d9cf | 8 | #include "lib/logging.h" |
8ea705f0 | 9 | |
d98421f2 | 10 | #include "lib/assert-cond.h" |
3fadfbc0 | 11 | #include <babeltrace2/trace-ir/packet.h> |
3fadfbc0 | 12 | #include <babeltrace2/trace-ir/trace.h> |
3fadfbc0 MJ |
13 | #include <babeltrace2/trace-ir/stream-class.h> |
14 | #include <babeltrace2/trace-ir/stream.h> | |
578e048b MJ |
15 | #include "lib/object.h" |
16 | #include "common/assert.h" | |
be514b0c | 17 | #include <inttypes.h> |
c4f23e30 | 18 | #include <stdbool.h> |
f79cf0f0 | 19 | |
578e048b MJ |
20 | #include "field.h" |
21 | #include "field-wrapper.h" | |
22 | #include "packet.h" | |
23 | #include "stream-class.h" | |
24 | #include "stream.h" | |
25 | #include "trace.h" | |
d24d5663 | 26 | #include "lib/func-status.h" |
578e048b | 27 | |
1353b066 | 28 | BT_EXPORT |
094ff7c0 | 29 | struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet) |
f79cf0f0 | 30 | { |
d5b13b9b | 31 | BT_ASSERT_PRE_DEV_PACKET_NON_NULL(packet); |
094ff7c0 | 32 | return packet->stream; |
f79cf0f0 PP |
33 | } |
34 | ||
1353b066 | 35 | BT_EXPORT |
40f4ba76 PP |
36 | const struct bt_stream *bt_packet_borrow_stream_const( |
37 | const struct bt_packet *packet) | |
e5be10ef | 38 | { |
40f4ba76 | 39 | return bt_packet_borrow_stream((void *) packet); |
e5be10ef PP |
40 | } |
41 | ||
1353b066 | 42 | BT_EXPORT |
44c440bc | 43 | struct bt_field *bt_packet_borrow_context_field(struct bt_packet *packet) |
f79cf0f0 | 44 | { |
d5b13b9b | 45 | BT_ASSERT_PRE_DEV_PACKET_NON_NULL(packet); |
44c440bc | 46 | return packet->context_field ? packet->context_field->field : NULL; |
312c056a | 47 | } |
c5c82c6e | 48 | |
1353b066 | 49 | BT_EXPORT |
40f4ba76 PP |
50 | const struct bt_field *bt_packet_borrow_context_field_const( |
51 | const struct bt_packet *packet) | |
e5be10ef | 52 | { |
40f4ba76 | 53 | return bt_packet_borrow_context_field((void *) packet); |
e5be10ef PP |
54 | } |
55 | ||
40f4ba76 | 56 | void _bt_packet_set_is_frozen(const struct bt_packet *packet, bool is_frozen) |
312c056a | 57 | { |
59e3c4db | 58 | if (!packet) { |
312c056a | 59 | return; |
c5c82c6e PP |
60 | } |
61 | ||
44c440bc PP |
62 | BT_LIB_LOGD("Setting packet's frozen state: %![packet-]+a, " |
63 | "is-frozen=%d", packet, is_frozen); | |
312c056a | 64 | |
44c440bc PP |
65 | if (packet->context_field) { |
66 | BT_LOGD_STR("Setting packet's context field's frozen state."); | |
67 | bt_field_set_is_frozen(packet->context_field->field, | |
6c677fb5 | 68 | is_frozen); |
312c056a PP |
69 | } |
70 | ||
40f4ba76 | 71 | ((struct bt_packet *) packet)->frozen = is_frozen; |
f6ccaed9 PP |
72 | } |
73 | ||
312c056a | 74 | static inline |
44c440bc | 75 | void reset_packet(struct bt_packet *packet) |
f6ccaed9 | 76 | { |
312c056a | 77 | BT_ASSERT(packet); |
44c440bc | 78 | BT_LIB_LOGD("Resetting packet: %!+a", packet); |
6c677fb5 | 79 | bt_packet_set_is_frozen(packet, false); |
312c056a | 80 | |
44c440bc PP |
81 | if (packet->context_field) { |
82 | bt_field_set_is_frozen(packet->context_field->field, false); | |
83 | bt_field_reset(packet->context_field->field); | |
312c056a | 84 | } |
f79cf0f0 PP |
85 | } |
86 | ||
312c056a | 87 | static |
44c440bc | 88 | void recycle_context_field(struct bt_field_wrapper *context_field, |
312c056a | 89 | struct bt_stream_class *stream_class) |
f79cf0f0 | 90 | { |
312c056a PP |
91 | BT_ASSERT(context_field); |
92 | BT_LIB_LOGD("Recycling packet context field: " | |
93 | "addr=%p, %![sc-]+S, %![field-]+f", context_field, | |
94 | stream_class, context_field->field); | |
95 | bt_object_pool_recycle_object(&stream_class->packet_context_field_pool, | |
96 | context_field); | |
f79cf0f0 PP |
97 | } |
98 | ||
312c056a | 99 | void bt_packet_recycle(struct bt_packet *packet) |
f79cf0f0 | 100 | { |
312c056a | 101 | struct bt_stream *stream; |
f79cf0f0 | 102 | |
312c056a PP |
103 | BT_ASSERT(packet); |
104 | BT_LIB_LOGD("Recycling packet: %!+a", packet); | |
105 | ||
106 | /* | |
107 | * Those are the important ordered steps: | |
108 | * | |
109 | * 1. Reset the packet object (put any permanent reference it | |
110 | * has, unfreeze it and its fields in developer mode, etc.), | |
111 | * but do NOT put its stream's reference. This stream | |
112 | * contains the pool to which we're about to recycle this | |
113 | * packet object, so we must guarantee its existence thanks | |
114 | * to this existing reference. | |
115 | * | |
116 | * 2. Move the stream reference to our `stream` | |
117 | * variable so that we can set the packet's stream member | |
118 | * to NULL before recycling it. We CANNOT do this after | |
65300d60 | 119 | * we put the stream reference because this bt_object_put_ref() |
312c056a PP |
120 | * could destroy the stream, also destroying its |
121 | * packet pool, thus also destroying our packet object (this | |
122 | * would result in an invalid write access). | |
123 | * | |
124 | * 3. Recycle the packet object. | |
125 | * | |
126 | * 4. Put our stream reference. | |
127 | */ | |
44c440bc | 128 | reset_packet(packet); |
312c056a PP |
129 | stream = packet->stream; |
130 | BT_ASSERT(stream); | |
131 | packet->stream = NULL; | |
132 | bt_object_pool_recycle_object(&stream->packet_pool, packet); | |
6871026b | 133 | bt_object_put_ref_no_null_check(&stream->base); |
f79cf0f0 PP |
134 | } |
135 | ||
312c056a | 136 | void bt_packet_destroy(struct bt_packet *packet) |
f79cf0f0 | 137 | { |
44c440bc | 138 | BT_LIB_LOGD("Destroying packet: %!+a", packet); |
312c056a | 139 | |
44c440bc | 140 | if (packet->context_field) { |
312c056a PP |
141 | if (packet->stream) { |
142 | BT_LOGD_STR("Recycling packet's context field."); | |
44c440bc PP |
143 | recycle_context_field(packet->context_field, |
144 | packet->stream->class); | |
312c056a | 145 | } else { |
44c440bc | 146 | bt_field_wrapper_destroy(packet->context_field); |
312c056a | 147 | } |
238b7404 PP |
148 | |
149 | packet->context_field = NULL; | |
312c056a PP |
150 | } |
151 | ||
d409daba | 152 | BT_LOGD_STR("Putting packet's stream."); |
238b7404 | 153 | BT_OBJECT_PUT_REF_AND_RESET(packet->stream); |
f79cf0f0 PP |
154 | g_free(packet); |
155 | } | |
156 | ||
312c056a | 157 | struct bt_packet *bt_packet_new(struct bt_stream *stream) |
f79cf0f0 | 158 | { |
50842bdc | 159 | struct bt_packet *packet = NULL; |
862ca4ed | 160 | struct bt_trace_class *trace_class = NULL; |
f79cf0f0 | 161 | |
312c056a | 162 | BT_ASSERT(stream); |
44c440bc | 163 | BT_LIB_LOGD("Creating packet object: %![stream-]+s", stream); |
50842bdc | 164 | packet = g_new0(struct bt_packet, 1); |
f79cf0f0 | 165 | if (!packet) { |
870631a2 PP |
166 | BT_LIB_LOGE_APPEND_CAUSE( |
167 | "Failed to allocate one packet object."); | |
44c440bc | 168 | goto error; |
f79cf0f0 PP |
169 | } |
170 | ||
3fea54f6 PP |
171 | bt_object_init_shared(&packet->base, |
172 | (bt_object_release_func) bt_packet_recycle); | |
398454ed | 173 | packet->stream = stream; |
6871026b | 174 | bt_object_get_ref_no_null_check(stream); |
862ca4ed PP |
175 | trace_class = bt_stream_class_borrow_trace_class_inline(stream->class); |
176 | BT_ASSERT(trace_class); | |
be514b0c | 177 | |
5cd6d0e5 | 178 | if (stream->class->packet_context_fc) { |
44c440bc PP |
179 | BT_LOGD_STR("Creating initial packet context field."); |
180 | packet->context_field = bt_field_wrapper_create( | |
181 | &stream->class->packet_context_field_pool, | |
5cd6d0e5 | 182 | stream->class->packet_context_fc); |
44c440bc | 183 | if (!packet->context_field) { |
870631a2 PP |
184 | BT_LIB_LOGE_APPEND_CAUSE( |
185 | "Cannot create packet context field wrapper."); | |
44c440bc | 186 | goto error; |
be514b0c | 187 | } |
f79cf0f0 PP |
188 | } |
189 | ||
44c440bc PP |
190 | BT_LIB_LOGD("Created packet object: %!+a", packet); |
191 | goto end; | |
ccf82993 | 192 | |
44c440bc | 193 | error: |
65300d60 | 194 | BT_OBJECT_PUT_REF_AND_RESET(packet); |
ccf82993 PP |
195 | |
196 | end: | |
44c440bc | 197 | return packet; |
ccf82993 PP |
198 | } |
199 | ||
1353b066 | 200 | BT_EXPORT |
58085ca4 | 201 | struct bt_packet *bt_packet_create(const struct bt_stream *c_stream) |
312c056a PP |
202 | { |
203 | struct bt_packet *packet = NULL; | |
58085ca4 | 204 | struct bt_stream *stream = (void *) c_stream; |
312c056a | 205 | |
17f3083a | 206 | BT_ASSERT_PRE_NO_ERROR(); |
d5b13b9b | 207 | BT_ASSERT_PRE_STREAM_NON_NULL(stream); |
1778c2a4 PP |
208 | BT_ASSERT_PRE("stream-class-supports-packets", |
209 | stream->class->supports_packets, | |
26fc5aed PP |
210 | "Stream class does not support packets: %![sc-]+S", |
211 | stream->class); | |
312c056a | 212 | packet = bt_object_pool_create_object(&stream->packet_pool); |
91d81473 | 213 | if (G_UNLIKELY(!packet)) { |
870631a2 PP |
214 | BT_LIB_LOGE_APPEND_CAUSE( |
215 | "Cannot allocate one packet from stream's packet pool: " | |
312c056a | 216 | "%![stream-]+s", stream); |
6c677fb5 | 217 | goto end; |
312c056a PP |
218 | } |
219 | ||
91d81473 | 220 | if (G_LIKELY(!packet->stream)) { |
6c677fb5 | 221 | packet->stream = stream; |
6871026b | 222 | bt_object_get_ref_no_null_check_no_parent_check( |
cb6f1f7d | 223 | &packet->stream->base); |
312c056a PP |
224 | } |
225 | ||
312c056a | 226 | end: |
e5be10ef | 227 | return (void *) packet; |
312c056a PP |
228 | } |
229 | ||
1353b066 | 230 | BT_EXPORT |
c5b9b441 PP |
231 | void bt_packet_get_ref(const struct bt_packet *packet) |
232 | { | |
233 | bt_object_get_ref(packet); | |
234 | } | |
235 | ||
1353b066 | 236 | BT_EXPORT |
c5b9b441 PP |
237 | void bt_packet_put_ref(const struct bt_packet *packet) |
238 | { | |
239 | bt_object_put_ref(packet); | |
240 | } |