4 * Trace IR Reference Count test
6 * Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; under version 2 of the License.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #include <babeltrace2/babeltrace.h>
25 #include "lib/object.h"
26 #include "compat/stdlib.h"
27 #include "common/assert.h"
28 #include <babeltrace2/ctf-writer/writer.h>
29 #include <babeltrace2/ctf-writer/clock.h>
30 #include <babeltrace2/ctf-writer/clock-class.h>
31 #include <babeltrace2/ctf-writer/stream.h>
32 #include <babeltrace2/ctf-writer/event.h>
33 #include <babeltrace2/ctf-writer/event-types.h>
34 #include <babeltrace2/ctf-writer/event-fields.h>
35 #include <babeltrace2/ctf-writer/stream-class.h>
36 #include <babeltrace2/ctf-writer/trace.h>
50 struct bt_ctf_writer
*writer
;
51 struct bt_ctf_trace
*tc
;
52 struct bt_ctf_stream_class
*sc
;
53 struct bt_ctf_event_class
*ec
;
54 struct bt_ctf_stream
*stream
;
55 struct bt_ctf_event
*event
;
58 const char *writer_user_names
[] = {
67 static const size_t WRITER_USER_NR_ELEMENTS
=
68 sizeof(struct writer_user
) / sizeof(void *);
71 * Returns a structure containing the following fields:
72 * - uint8_t payload_8;
73 * - uint16_t payload_16;
74 * - uint32_t payload_32;
76 static bt_field_class
*create_integer_struct(bt_trace_class
*trace_class
)
79 bt_field_class
*structure
= NULL
;
80 bt_field_class
*ui8
= NULL
, *ui16
= NULL
, *ui32
= NULL
;
82 structure
= bt_field_class_structure_create(trace_class
);
84 ui8
= bt_field_class_unsigned_integer_create(trace_class
);
86 bt_field_class_integer_set_field_value_range(ui8
, 8);
87 ret
= bt_field_class_structure_append_member(structure
,
90 ui16
= bt_field_class_unsigned_integer_create(trace_class
);
92 bt_field_class_integer_set_field_value_range(ui16
, 16);
93 ret
= bt_field_class_structure_append_member(structure
,
96 ui32
= bt_field_class_unsigned_integer_create(trace_class
);
98 bt_field_class_integer_set_field_value_range(ui32
, 32);
99 ret
= bt_field_class_structure_append_member(structure
,
102 BT_FIELD_CLASS_PUT_REF_AND_RESET(ui8
);
103 BT_FIELD_CLASS_PUT_REF_AND_RESET(ui16
);
104 BT_FIELD_CLASS_PUT_REF_AND_RESET(ui32
);
108 static struct bt_ctf_field_type
*create_writer_integer_struct(void)
111 struct bt_ctf_field_type
*structure
= NULL
;
112 struct bt_ctf_field_type
*ui8
= NULL
, *ui16
= NULL
, *ui32
= NULL
;
114 structure
= bt_ctf_field_type_structure_create();
115 BT_ASSERT(structure
);
116 ui8
= bt_ctf_field_type_integer_create(8);
118 ret
= bt_ctf_field_type_structure_add_field(structure
, ui8
,
121 ui16
= bt_ctf_field_type_integer_create(16);
123 ret
= bt_ctf_field_type_structure_add_field(structure
, ui16
,
126 ui32
= bt_ctf_field_type_integer_create(32);
128 ret
= bt_ctf_field_type_structure_add_field(structure
, ui32
,
131 BT_OBJECT_PUT_REF_AND_RESET(ui8
);
132 BT_OBJECT_PUT_REF_AND_RESET(ui16
);
133 BT_OBJECT_PUT_REF_AND_RESET(ui32
);
138 * A simple event has the following payload:
139 * - uint8_t payload_8;
140 * - uint16_t payload_16;
141 * - uint32_t payload_32;
143 static bt_event_class
*create_simple_event(
144 bt_stream_class
*sc
, const char *name
)
147 bt_event_class
*event
= NULL
;
148 bt_field_class
*payload
= NULL
;
151 event
= bt_event_class_create(sc
);
153 ret
= bt_event_class_set_name(event
, name
);
155 payload
= create_integer_struct(bt_stream_class_borrow_trace_class(sc
));
157 ret
= bt_event_class_set_payload_field_class(event
, payload
);
159 BT_FIELD_CLASS_PUT_REF_AND_RESET(payload
);
164 * A complex event has the following payload:
165 * - uint8_t payload_8;
166 * - uint16_t payload_16;
167 * - uint32_t payload_32;
168 * - struct payload_struct:
169 * - uint8_t payload_8;
170 * - uint16_t payload_16;
171 * - uint32_t payload_32;
173 static bt_event_class
*create_complex_event(bt_stream_class
*sc
,
177 bt_event_class
*event
= NULL
;
178 bt_field_class
*inner
= NULL
, *outer
= NULL
;
179 bt_trace_class
*trace_class
= bt_stream_class_borrow_trace_class(sc
);
182 event
= bt_event_class_create(sc
);
184 ret
= bt_event_class_set_name(event
, name
);
186 outer
= create_integer_struct(trace_class
);
188 inner
= create_integer_struct(trace_class
);
190 ret
= bt_field_class_structure_append_member(outer
,
191 "payload_struct", inner
);
193 ret
= bt_event_class_set_payload_field_class(event
, outer
);
195 BT_FIELD_CLASS_PUT_REF_AND_RESET(inner
);
196 BT_FIELD_CLASS_PUT_REF_AND_RESET(outer
);
200 static void set_stream_class_field_classes(
201 bt_stream_class
*stream_class
)
203 bt_trace_class
*trace_class
=
204 bt_stream_class_borrow_trace_class(stream_class
);
205 bt_field_class
*packet_context_type
;
209 packet_context_type
= bt_field_class_structure_create(trace_class
);
210 BT_ASSERT(packet_context_type
);
211 fc
= bt_field_class_unsigned_integer_create(trace_class
);
213 bt_field_class_integer_set_field_value_range(fc
, 32);
214 ret
= bt_field_class_structure_append_member(packet_context_type
,
217 bt_field_class_put_ref(fc
);
218 fc
= bt_field_class_unsigned_integer_create(trace_class
);
220 bt_field_class_integer_set_field_value_range(fc
, 32);
221 ret
= bt_field_class_structure_append_member(packet_context_type
,
224 bt_field_class_put_ref(fc
);
225 ret
= bt_stream_class_set_packet_context_field_class(
226 stream_class
, packet_context_type
);
228 bt_field_class_put_ref(packet_context_type
);
231 static void create_sc1(bt_trace_class
*trace_class
)
234 bt_event_class
*ec1
= NULL
, *ec2
= NULL
;
235 bt_stream_class
*sc1
= NULL
, *ret_stream
= NULL
;
237 sc1
= bt_stream_class_create(trace_class
);
239 ret
= bt_stream_class_set_name(sc1
, "sc1");
241 set_stream_class_field_classes(sc1
);
242 ec1
= create_complex_event(sc1
, "ec1");
244 ec2
= create_simple_event(sc1
, "ec2");
246 ret_stream
= bt_event_class_borrow_stream_class(ec1
);
247 ok(ret_stream
== sc1
, "Borrow parent stream SC1 from EC1");
248 ret_stream
= bt_event_class_borrow_stream_class(ec2
);
249 ok(ret_stream
== sc1
, "Borrow parent stream SC1 from EC2");
250 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec1
);
251 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec2
);
252 BT_STREAM_CLASS_PUT_REF_AND_RESET(sc1
);
255 static void create_sc2(bt_trace_class
*trace_class
)
258 bt_event_class
*ec3
= NULL
;
259 bt_stream_class
*sc2
= NULL
, *ret_stream
= NULL
;
261 sc2
= bt_stream_class_create(trace_class
);
263 ret
= bt_stream_class_set_name(sc2
, "sc2");
265 set_stream_class_field_classes(sc2
);
266 ec3
= create_simple_event(sc2
, "ec3");
267 ret_stream
= bt_event_class_borrow_stream_class(ec3
);
268 ok(ret_stream
== sc2
, "Borrow parent stream SC2 from EC3");
269 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec3
);
270 BT_STREAM_CLASS_PUT_REF_AND_RESET(sc2
);
273 static bt_trace_class
*create_tc1(bt_self_component_source
*self_comp
)
275 bt_trace_class
*tc1
= NULL
;
277 tc1
= bt_trace_class_create(
278 bt_self_component_source_as_self_component(self_comp
));
285 static void init_weak_refs(bt_trace_class
*tc
,
286 bt_trace_class
**tc1
,
287 bt_stream_class
**sc1
,
288 bt_stream_class
**sc2
,
289 bt_event_class
**ec1
,
290 bt_event_class
**ec2
,
291 bt_event_class
**ec3
)
294 *sc1
= bt_trace_class_borrow_stream_class_by_index(tc
, 0);
295 *sc2
= bt_trace_class_borrow_stream_class_by_index(tc
, 1);
296 *ec1
= bt_stream_class_borrow_event_class_by_index(*sc1
, 0);
297 *ec2
= bt_stream_class_borrow_event_class_by_index(*sc1
, 1);
298 *ec3
= bt_stream_class_borrow_event_class_by_index(*sc2
, 0);
301 static void test_example_scenario(bt_self_component_source
*self_comp
)
304 * Weak pointers to trace IR objects are to be used very
305 * carefully. This is NOT a good practice and is strongly
306 * discouraged; this is only done to facilitate the validation
307 * of expected reference counts without affecting them by taking
308 * "real" references to the objects.
310 bt_trace_class
*tc1
= NULL
, *weak_tc1
= NULL
;
311 bt_stream_class
*weak_sc1
= NULL
, *weak_sc2
= NULL
;
312 bt_event_class
*weak_ec1
= NULL
, *weak_ec2
= NULL
,
314 struct user user_a
= { 0 }, user_b
= { 0 }, user_c
= { 0 };
316 /* The only reference which exists at this point is on TC1. */
317 tc1
= create_tc1(self_comp
);
318 ok(tc1
, "Initialize trace");
320 init_weak_refs(tc1
, &weak_tc1
, &weak_sc1
, &weak_sc2
, &weak_ec1
,
321 &weak_ec2
, &weak_ec3
);
322 ok(bt_object_get_ref_count((void *) weak_sc1
) == 0,
323 "Initial SC1 reference count is 0");
324 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
325 "Initial SC2 reference count is 0");
326 ok(bt_object_get_ref_count((void *) weak_ec1
) == 0,
327 "Initial EC1 reference count is 0");
328 ok(bt_object_get_ref_count((void *) weak_ec2
) == 0,
329 "Initial EC2 reference count is 0");
330 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
331 "Initial EC3 reference count is 0");
333 /* User A has ownership of the trace. */
334 BT_OBJECT_MOVE_REF(user_a
.tc
, tc1
);
335 ok(bt_object_get_ref_count((void *) user_a
.tc
) == 1,
336 "TC1 reference count is 1");
338 /* User A acquires a reference to SC2 from TC1. */
339 user_a
.sc
= bt_trace_class_borrow_stream_class_by_index(
341 bt_stream_class_get_ref(user_a
.sc
);
342 ok(user_a
.sc
, "User A acquires SC2 from TC1");
343 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
344 "TC1 reference count is 2");
345 ok(bt_object_get_ref_count((void *) weak_sc2
) == 1,
346 "SC2 reference count is 1");
348 /* User A acquires a reference to EC3 from SC2. */
349 user_a
.ec
= bt_stream_class_borrow_event_class_by_index(
351 bt_event_class_get_ref(user_a
.ec
);
352 ok(user_a
.ec
, "User A acquires EC3 from SC2");
353 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
354 "TC1 reference count is 2");
355 ok(bt_object_get_ref_count((void *) weak_sc2
) == 2,
356 "SC2 reference count is 2");
357 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
358 "EC3 reference count is 1");
360 /* User A releases its reference to SC2. */
361 diag("User A releases SC2");
362 BT_STREAM_CLASS_PUT_REF_AND_RESET(user_a
.sc
);
364 * We keep the pointer to SC2 around to validate its reference
367 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
368 "TC1 reference count is 2");
369 ok(bt_object_get_ref_count((void *) weak_sc2
) == 1,
370 "SC2 reference count is 1");
371 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
372 "EC3 reference count is 1");
374 /* User A releases its reference to TC1. */
375 diag("User A releases TC1");
376 BT_TRACE_CLASS_PUT_REF_AND_RESET(user_a
.tc
);
378 * We keep the pointer to TC1 around to validate its reference
381 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
382 "TC1 reference count is 1");
383 ok(bt_object_get_ref_count((void *) weak_sc2
) == 1,
384 "SC2 reference count is 1");
385 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
386 "EC3 reference count is 1");
388 /* User B acquires a reference to SC1. */
389 diag("User B acquires a reference to SC1");
390 user_b
.sc
= weak_sc1
;
391 bt_stream_class_get_ref(user_b
.sc
);
392 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
393 "TC1 reference count is 2");
394 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
395 "SC1 reference count is 1");
397 /* User C acquires a reference to EC1. */
398 diag("User C acquires a reference to EC1");
399 user_c
.ec
= bt_stream_class_borrow_event_class_by_index(
401 bt_event_class_get_ref(user_c
.ec
);
402 ok(bt_object_get_ref_count((void *) weak_ec1
) == 1,
403 "EC1 reference count is 1");
404 ok(bt_object_get_ref_count((void *) weak_sc1
) == 2,
405 "SC1 reference count is 2");
407 /* User A releases its reference on EC3. */
408 diag("User A releases its reference on EC3");
409 BT_EVENT_CLASS_PUT_REF_AND_RESET(user_a
.ec
);
410 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
411 "EC3 reference count is 1");
412 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
413 "SC2 reference count is 0");
414 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
415 "TC1 reference count is 1");
417 /* User B releases its reference on SC1. */
418 diag("User B releases its reference on SC1");
419 BT_STREAM_CLASS_PUT_REF_AND_RESET(user_b
.sc
);
420 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
421 "SC1 reference count is 1");
424 * User C is the sole owner of an object and is keeping the whole
425 * trace hierarchy "alive" by holding a reference to EC1.
427 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
428 "TC1 reference count is 1");
429 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
430 "SC1 reference count is 1");
431 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
432 "SC2 reference count is 0");
433 ok(bt_object_get_ref_count((void *) weak_ec1
) == 1,
434 "EC1 reference count is 1");
435 ok(bt_object_get_ref_count((void *) weak_ec2
) == 0,
436 "EC2 reference count is 0");
437 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
438 "EC3 reference count is 0");
440 /* Reclaim last reference held by User C. */
441 BT_EVENT_CLASS_PUT_REF_AND_RESET(user_c
.ec
);
445 bt_self_component_status
src_init(
446 bt_self_component_source
*self_comp
,
447 const bt_value
*params
, void *init_method_data
)
449 test_example_scenario(self_comp
);
450 return BT_SELF_COMPONENT_STATUS_OK
;
454 bt_self_message_iterator_status
src_iter_next(
455 bt_self_message_iterator
*self_iterator
,
456 bt_message_array_const msgs
, uint64_t capacity
,
459 return BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
462 static void test_example_scenario_in_graph(void)
464 bt_component_class_source
*comp_cls
;
468 comp_cls
= bt_component_class_source_create("src", src_iter_next
);
470 ret
= bt_component_class_source_set_init_method(comp_cls
, src_init
);
472 graph
= bt_graph_create();
473 ret
= bt_graph_add_source_component(graph
, comp_cls
, "src-comp",
476 bt_graph_put_ref(graph
);
477 bt_component_class_source_put_ref(comp_cls
);
480 static void create_writer_user_full(struct writer_user
*user
)
483 struct bt_ctf_field_type
*ft
;
484 struct bt_ctf_field
*field
;
485 struct bt_ctf_clock
*clock
;
488 trace_path
= g_build_filename(g_get_tmp_dir(), "ctfwriter_XXXXXX", NULL
);
489 if (!bt_mkdtemp(trace_path
)) {
493 user
->writer
= bt_ctf_writer_create(trace_path
);
494 BT_ASSERT(user
->writer
);
495 ret
= bt_ctf_writer_set_byte_order(user
->writer
,
496 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
);
498 user
->tc
= bt_ctf_writer_get_trace(user
->writer
);
500 user
->sc
= bt_ctf_stream_class_create("sc");
502 clock
= bt_ctf_clock_create("the_clock");
504 ret
= bt_ctf_writer_add_clock(user
->writer
, clock
);
506 ret
= bt_ctf_stream_class_set_clock(user
->sc
, clock
);
508 BT_OBJECT_PUT_REF_AND_RESET(clock
);
509 user
->stream
= bt_ctf_writer_create_stream(user
->writer
, user
->sc
);
510 BT_ASSERT(user
->stream
);
511 user
->ec
= bt_ctf_event_class_create("ec");
513 ft
= create_writer_integer_struct();
515 ret
= bt_ctf_event_class_set_payload_field_type(user
->ec
, ft
);
516 BT_OBJECT_PUT_REF_AND_RESET(ft
);
518 ret
= bt_ctf_stream_class_add_event_class(user
->sc
, user
->ec
);
520 user
->event
= bt_ctf_event_create(user
->ec
);
521 BT_ASSERT(user
->event
);
522 field
= bt_ctf_event_get_payload(user
->event
, "payload_8");
524 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 10);
526 BT_OBJECT_PUT_REF_AND_RESET(field
);
527 field
= bt_ctf_event_get_payload(user
->event
, "payload_16");
529 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 20);
531 BT_OBJECT_PUT_REF_AND_RESET(field
);
532 field
= bt_ctf_event_get_payload(user
->event
, "payload_32");
534 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 30);
536 BT_OBJECT_PUT_REF_AND_RESET(field
);
537 ret
= bt_ctf_stream_append_event(user
->stream
, user
->event
);
539 recursive_rmdir(trace_path
);
543 static void test_put_order_swap(size_t *array
, size_t a
, size_t b
)
545 size_t temp
= array
[a
];
551 static void test_put_order_put_objects(size_t *array
, size_t size
)
554 struct writer_user user
= { 0 };
555 void **objects
= (void *) &user
;
557 create_writer_user_full(&user
);
560 for (i
= 0; i
< size
; ++i
) {
561 void *obj
= objects
[array
[i
]];
563 printf("%s", writer_user_names
[array
[i
]]);
564 BT_OBJECT_PUT_REF_AND_RESET(obj
);
574 static void test_put_order_permute(size_t *array
, int k
, size_t size
)
577 test_put_order_put_objects(array
, size
);
581 for (i
= k
- 1; i
>= 0; i
--) {
582 size_t next_k
= k
- 1;
584 test_put_order_swap(array
, i
, next_k
);
585 test_put_order_permute(array
, next_k
, size
);
586 test_put_order_swap(array
, i
, next_k
);
591 static void test_put_order(void)
594 size_t array
[WRITER_USER_NR_ELEMENTS
];
596 /* Initialize array of indexes */
597 for (i
= 0; i
< WRITER_USER_NR_ELEMENTS
; ++i
) {
601 test_put_order_permute(array
, WRITER_USER_NR_ELEMENTS
,
602 WRITER_USER_NR_ELEMENTS
);
606 * The objective of this test is to implement and expand upon the scenario
607 * described in the reference counting documentation and ensure that any node of
608 * the Trace, Stream Class, Event Class, Stream and Event hiearchy keeps all
609 * other "alive" and reachable.
611 * External tools (e.g. valgrind) should be used to confirm that this
612 * known-good test does not leak memory.
614 int main(int argc
, char **argv
)
616 /* Initialize tap harness before any tests */
617 plan_tests(NR_TESTS
);
619 test_example_scenario_in_graph();
622 return exit_status();