trace{-class}.c: BT_ASSERT_PRE() -> BT_ASSERT_POST() (ref. count check)
[babeltrace.git] / src / lib / trace-ir / trace-class.c
CommitLineData
10b7a2e4 1/*
f2b0325d 2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
10b7a2e4
PP
3 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 *
10b7a2e4
PP
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 */
23
d693f28a 24#define BT_LOG_TAG "LIB/TRACE-CLASS"
1633ef46 25#include "lib/logging.h"
10b7a2e4 26
57952005 27#include "lib/assert-pre.h"
727170fc 28#include "lib/assert-post.h"
71c5da58
MJ
29#include <babeltrace2/trace-ir/trace-class.h>
30#include <babeltrace2/trace-ir/trace-class-const.h>
71c5da58 31#include <babeltrace2/trace-ir/event-class.h>
57952005
MJ
32#include "ctf-writer/functor.h"
33#include "ctf-writer/clock.h"
34#include "compat/compiler.h"
71c5da58
MJ
35#include <babeltrace2/value.h>
36#include <babeltrace2/value-const.h>
57952005 37#include "lib/value.h"
71c5da58 38#include <babeltrace2/types.h>
57952005
MJ
39#include "compat/endian.h"
40#include "common/assert.h"
41#include "compat/glib.h"
10b7a2e4
PP
42#include <inttypes.h>
43#include <stdint.h>
44#include <string.h>
45#include <stdlib.h>
46
57952005
MJ
47#include "clock-class.h"
48#include "event-class.h"
49#include "event.h"
50#include "field-class.h"
51#include "field-wrapper.h"
52#include "resolve-field-path.h"
53#include "stream-class.h"
54#include "stream.h"
55#include "trace.h"
56#include "utils.h"
af90138b 57#include "lib/value.h"
fb25b9e3 58#include "lib/func-status.h"
57952005 59
1122415c
FD
60struct bt_trace_class_destruction_listener_elem {
61 bt_trace_class_destruction_listener_func func;
62 void *data;
63};
64
fa6cfec3
PP
65#define BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(_tc) \
66 BT_ASSERT_PRE_DEV_HOT((_tc), "Trace class", ": %!+T", (_tc))
10b7a2e4
PP
67
68static
69void destroy_trace_class(struct bt_object *obj)
70{
71 struct bt_trace_class *tc = (void *) obj;
72
73 BT_LIB_LOGD("Destroying trace class object: %!+T", tc);
af90138b
PP
74 BT_OBJECT_PUT_REF_AND_RESET(tc->user_attributes);
75
1122415c
FD
76 /*
77 * Call destruction listener functions so that everything else
78 * still exists in the trace class.
79 */
80 if (tc->destruction_listeners) {
81 uint64_t i;
a684a357 82 BT_LIB_LOGD("Calling trace class destruction listener(s): %!+T", tc);
69868f44
SM
83
84 /*
85 * The trace class' reference count is 0 if we're here. Increment
86 * it to avoid a double-destroy (possibly infinitely recursive).
87 * This could happen for example if a destruction listener did
88 * bt_object_get_ref() (or anything that causes
89 * bt_object_get_ref() to be called) on the trace class (ref.
90 * count goes from 0 to 1), and then bt_object_put_ref(): the
91 * reference count would go from 1 to 0 again and this function
92 * would be called again.
93 */
94 tc->base.ref_count++;
95
1122415c
FD
96 /* Call all the trace class destruction listeners */
97 for (i = 0; i < tc->destruction_listeners->len; i++) {
98 struct bt_trace_class_destruction_listener_elem elem =
99 g_array_index(tc->destruction_listeners,
100 struct bt_trace_class_destruction_listener_elem, i);
101
102 if (elem.func) {
103 elem.func(tc, elem.data);
104 }
69868f44
SM
105
106 /*
107 * The destruction listener should not have kept a
108 * reference to the trace class.
109 */
727170fc 110 BT_ASSERT_POST(tc->base.ref_count == 1, "Destruction listener kept a reference to the trace class being destroyed: %![tc-]+T", tc);
1122415c
FD
111 }
112 g_array_free(tc->destruction_listeners, TRUE);
113 tc->destruction_listeners = NULL;
114 }
10b7a2e4 115
10b7a2e4
PP
116 if (tc->stream_classes) {
117 BT_LOGD_STR("Destroying stream classes.");
118 g_ptr_array_free(tc->stream_classes, TRUE);
119 tc->stream_classes = NULL;
120 }
121
10b7a2e4
PP
122 g_free(tc);
123}
124
e5e71bf8 125struct bt_trace_class *bt_trace_class_create(bt_self_component *self_comp)
10b7a2e4
PP
126{
127 struct bt_trace_class *tc = NULL;
10b7a2e4 128
e5e71bf8 129 BT_ASSERT_PRE_NON_NULL(self_comp, "Self component");
10b7a2e4
PP
130 BT_LOGD_STR("Creating default trace class object.");
131 tc = g_new0(struct bt_trace_class, 1);
132 if (!tc) {
a8f90e5d 133 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one trace class.");
10b7a2e4
PP
134 goto error;
135 }
136
137 bt_object_init_shared_with_parent(&tc->base, destroy_trace_class);
af90138b
PP
138 tc->user_attributes = bt_value_map_create();
139 if (!tc->user_attributes) {
140 BT_LIB_LOGE_APPEND_CAUSE(
141 "Failed to create a map value object.");
142 goto error;
143 }
10b7a2e4
PP
144
145 tc->stream_classes = g_ptr_array_new_with_free_func(
146 (GDestroyNotify) bt_object_try_spec_release);
147 if (!tc->stream_classes) {
a8f90e5d 148 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
10b7a2e4
PP
149 goto error;
150 }
151
1122415c
FD
152 tc->destruction_listeners = g_array_new(FALSE, TRUE,
153 sizeof(struct bt_trace_class_destruction_listener_elem));
154 if (!tc->destruction_listeners) {
a8f90e5d 155 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
1122415c
FD
156 goto error;
157 }
158
10b7a2e4 159 tc->assigns_automatic_stream_class_id = true;
10b7a2e4
PP
160 BT_LIB_LOGD("Created trace class object: %!+T", tc);
161 goto end;
162
163error:
164 BT_OBJECT_PUT_REF_AND_RESET(tc);
165
166end:
167 return tc;
168}
169
fb25b9e3 170enum bt_trace_class_add_listener_status bt_trace_class_add_destruction_listener(
1122415c
FD
171 const struct bt_trace_class *_tc,
172 bt_trace_class_destruction_listener_func listener,
eba7ea21 173 void *data, bt_listener_id *listener_id)
1122415c
FD
174{
175 struct bt_trace_class *tc = (void *) _tc;
176 uint64_t i;
177 struct bt_trace_class_destruction_listener_elem new_elem = {
178 .func = listener,
179 .data = data,
180 };
181
182 BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
183 BT_ASSERT_PRE_NON_NULL(listener, "Listener");
184
185 /* Find the next available spot */
186 for (i = 0; i < tc->destruction_listeners->len; i++) {
187 struct bt_trace_class_destruction_listener_elem elem =
188 g_array_index(tc->destruction_listeners,
189 struct bt_trace_class_destruction_listener_elem, i);
190
191 if (!elem.func) {
192 break;
193 }
194 }
195
196 if (i == tc->destruction_listeners->len) {
197 g_array_append_val(tc->destruction_listeners, new_elem);
198 } else {
199 g_array_insert_val(tc->destruction_listeners, i, new_elem);
200 }
201
202 if (listener_id) {
203 *listener_id = i;
204 }
205
a684a357 206 BT_LIB_LOGD("Added trace class destruction listener: %![tc-]+T, "
1122415c 207 "listener-id=%" PRIu64, tc, i);
fb25b9e3 208 return BT_FUNC_STATUS_OK;
1122415c
FD
209}
210
1122415c
FD
211static
212bool has_listener_id(const struct bt_trace_class *tc, uint64_t listener_id)
213{
214 BT_ASSERT(listener_id < tc->destruction_listeners->len);
215 return (&g_array_index(tc->destruction_listeners,
216 struct bt_trace_class_destruction_listener_elem,
8e01f2d9 217 listener_id))->func;
1122415c
FD
218}
219
fb25b9e3 220enum bt_trace_class_remove_listener_status bt_trace_class_remove_destruction_listener(
eba7ea21 221 const struct bt_trace_class *_tc, bt_listener_id listener_id)
1122415c
FD
222{
223 struct bt_trace_class *tc = (void *) _tc;
224 struct bt_trace_class_destruction_listener_elem *elem;
225
226 BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
227 BT_ASSERT_PRE(has_listener_id(tc, listener_id),
228 "Trace class has no such trace class destruction listener ID: "
229 "%![tc-]+T, %" PRIu64, tc, listener_id);
230 elem = &g_array_index(tc->destruction_listeners,
231 struct bt_trace_class_destruction_listener_elem,
232 listener_id);
233 BT_ASSERT(elem->func);
234
235 elem->func = NULL;
236 elem->data = NULL;
a684a357 237 BT_LIB_LOGD("Removed trace class destruction listener: "
1122415c
FD
238 "%![tc-]+T, listener-id=%" PRIu64,
239 tc, listener_id);
fb25b9e3 240 return BT_FUNC_STATUS_OK;
1122415c
FD
241}
242
10b7a2e4
PP
243uint64_t bt_trace_class_get_stream_class_count(const struct bt_trace_class *tc)
244{
fa6cfec3 245 BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
10b7a2e4
PP
246 return (uint64_t) tc->stream_classes->len;
247}
248
249struct bt_stream_class *bt_trace_class_borrow_stream_class_by_index(
250 struct bt_trace_class *tc, uint64_t index)
251{
fa6cfec3
PP
252 BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
253 BT_ASSERT_PRE_DEV_VALID_INDEX(index, tc->stream_classes->len);
10b7a2e4
PP
254 return g_ptr_array_index(tc->stream_classes, index);
255}
256
257const struct bt_stream_class *
258bt_trace_class_borrow_stream_class_by_index_const(
259 const struct bt_trace_class *tc, uint64_t index)
260{
261 return bt_trace_class_borrow_stream_class_by_index(
262 (void *) tc, index);
263}
264
265struct bt_stream_class *bt_trace_class_borrow_stream_class_by_id(
266 struct bt_trace_class *tc, uint64_t id)
267{
268 struct bt_stream_class *stream_class = NULL;
269 uint64_t i;
270
fa6cfec3 271 BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
10b7a2e4
PP
272
273 for (i = 0; i < tc->stream_classes->len; i++) {
274 struct bt_stream_class *stream_class_candidate =
275 g_ptr_array_index(tc->stream_classes, i);
276
277 if (stream_class_candidate->id == id) {
278 stream_class = stream_class_candidate;
279 goto end;
280 }
281 }
282
283end:
284 return stream_class;
285}
286
287const struct bt_stream_class *
288bt_trace_class_borrow_stream_class_by_id_const(
289 const struct bt_trace_class *tc, uint64_t id)
290{
291 return bt_trace_class_borrow_stream_class_by_id((void *) tc, id);
292}
293
10b7a2e4
PP
294BT_HIDDEN
295void _bt_trace_class_freeze(const struct bt_trace_class *tc)
296{
10b7a2e4
PP
297 BT_ASSERT(tc);
298 BT_LIB_LOGD("Freezing trace class: %!+T", tc);
299 ((struct bt_trace_class *) tc)->frozen = true;
300}
301
302bt_bool bt_trace_class_assigns_automatic_stream_class_id(const struct bt_trace_class *tc)
303{
fa6cfec3 304 BT_ASSERT_PRE_DEV_NON_NULL(tc, "Trace class");
10b7a2e4
PP
305 return (bt_bool) tc->assigns_automatic_stream_class_id;
306}
307
308void bt_trace_class_set_assigns_automatic_stream_class_id(struct bt_trace_class *tc,
309 bt_bool value)
310{
311 BT_ASSERT_PRE_NON_NULL(tc, "Trace class");
fa6cfec3 312 BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(tc);
10b7a2e4 313 tc->assigns_automatic_stream_class_id = (bool) value;
a684a357 314 BT_LIB_LOGD("Set trace class's automatic stream class ID "
10b7a2e4
PP
315 "assignment property: %!+T", tc);
316}
8c6884d9 317
af90138b
PP
318const struct bt_value *bt_trace_class_borrow_user_attributes_const(
319 const struct bt_trace_class *trace_class)
320{
321 BT_ASSERT_PRE_DEV_NON_NULL(trace_class, "Trace class");
322 return trace_class->user_attributes;
323}
324
325struct bt_value *bt_trace_class_borrow_user_attributes(
326 struct bt_trace_class *trace_class)
327{
328 return (void *) bt_trace_class_borrow_user_attributes_const(
329 (void *) trace_class);
330}
331
332void bt_trace_class_set_user_attributes(struct bt_trace_class *trace_class,
333 const struct bt_value *user_attributes)
334{
335 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
336 BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
337 BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
338 "User attributes object is not a map value object.");
339 BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(trace_class);
864aa43f 340 bt_object_put_ref_no_null_check(trace_class->user_attributes);
af90138b 341 trace_class->user_attributes = (void *) user_attributes;
864aa43f 342 bt_object_get_ref_no_null_check(trace_class->user_attributes);
af90138b
PP
343}
344
8c6884d9
PP
345void bt_trace_class_get_ref(const struct bt_trace_class *trace_class)
346{
347 bt_object_get_ref(trace_class);
348}
349
350void bt_trace_class_put_ref(const struct bt_trace_class *trace_class)
351{
352 bt_object_put_ref(trace_class);
353}
This page took 0.052111 seconds and 4 git commands to generate.