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.
23 #include <babeltrace/babeltrace.h>
24 #include <babeltrace/object-internal.h>
25 #include <babeltrace/compat/stdlib-internal.h>
26 #include <babeltrace/assert-internal.h>
40 struct bt_ctf_writer
*writer
;
41 struct bt_ctf_trace
*tc
;
42 struct bt_ctf_stream_class
*sc
;
43 struct bt_ctf_event_class
*ec
;
44 struct bt_ctf_stream
*stream
;
45 struct bt_ctf_event
*event
;
48 const char *writer_user_names
[] = {
57 static const size_t WRITER_USER_NR_ELEMENTS
=
58 sizeof(struct writer_user
) / sizeof(void *);
61 * Returns a structure containing the following fields:
62 * - uint8_t payload_8;
63 * - uint16_t payload_16;
64 * - uint32_t payload_32;
66 static bt_field_class
*create_integer_struct(bt_trace_class
*trace_class
)
69 bt_field_class
*structure
= NULL
;
70 bt_field_class
*ui8
= NULL
, *ui16
= NULL
, *ui32
= NULL
;
72 structure
= bt_field_class_structure_create(trace_class
);
74 ui8
= bt_field_class_unsigned_integer_create(trace_class
);
76 bt_field_class_integer_set_field_value_range(ui8
, 8);
77 ret
= bt_field_class_structure_append_member(structure
,
80 ui16
= bt_field_class_unsigned_integer_create(trace_class
);
82 bt_field_class_integer_set_field_value_range(ui16
, 16);
83 ret
= bt_field_class_structure_append_member(structure
,
86 ui32
= bt_field_class_unsigned_integer_create(trace_class
);
88 bt_field_class_integer_set_field_value_range(ui32
, 32);
89 ret
= bt_field_class_structure_append_member(structure
,
92 BT_FIELD_CLASS_PUT_REF_AND_RESET(ui8
);
93 BT_FIELD_CLASS_PUT_REF_AND_RESET(ui16
);
94 BT_FIELD_CLASS_PUT_REF_AND_RESET(ui32
);
98 static struct bt_ctf_field_type
*create_writer_integer_struct(void)
101 struct bt_ctf_field_type
*structure
= NULL
;
102 struct bt_ctf_field_type
*ui8
= NULL
, *ui16
= NULL
, *ui32
= NULL
;
104 structure
= bt_ctf_field_type_structure_create();
105 BT_ASSERT(structure
);
106 ui8
= bt_ctf_field_type_integer_create(8);
108 ret
= bt_ctf_field_type_structure_add_field(structure
, ui8
,
111 ui16
= bt_ctf_field_type_integer_create(16);
113 ret
= bt_ctf_field_type_structure_add_field(structure
, ui16
,
116 ui32
= bt_ctf_field_type_integer_create(32);
118 ret
= bt_ctf_field_type_structure_add_field(structure
, ui32
,
121 BT_OBJECT_PUT_REF_AND_RESET(ui8
);
122 BT_OBJECT_PUT_REF_AND_RESET(ui16
);
123 BT_OBJECT_PUT_REF_AND_RESET(ui32
);
128 * A simple event has the following payload:
129 * - uint8_t payload_8;
130 * - uint16_t payload_16;
131 * - uint32_t payload_32;
133 static bt_event_class
*create_simple_event(
134 bt_stream_class
*sc
, const char *name
)
137 bt_event_class
*event
= NULL
;
138 bt_field_class
*payload
= NULL
;
141 event
= bt_event_class_create(sc
);
143 ret
= bt_event_class_set_name(event
, name
);
145 payload
= create_integer_struct(bt_stream_class_borrow_trace_class(sc
));
147 ret
= bt_event_class_set_payload_field_class(event
, payload
);
149 BT_FIELD_CLASS_PUT_REF_AND_RESET(payload
);
154 * A complex event has the following payload:
155 * - uint8_t payload_8;
156 * - uint16_t payload_16;
157 * - uint32_t payload_32;
158 * - struct payload_struct:
159 * - uint8_t payload_8;
160 * - uint16_t payload_16;
161 * - uint32_t payload_32;
163 static bt_event_class
*create_complex_event(bt_stream_class
*sc
,
167 bt_event_class
*event
= NULL
;
168 bt_field_class
*inner
= NULL
, *outer
= NULL
;
169 bt_trace_class
*trace_class
= bt_stream_class_borrow_trace_class(sc
);
172 event
= bt_event_class_create(sc
);
174 ret
= bt_event_class_set_name(event
, name
);
176 outer
= create_integer_struct(trace_class
);
178 inner
= create_integer_struct(trace_class
);
180 ret
= bt_field_class_structure_append_member(outer
,
181 "payload_struct", inner
);
183 ret
= bt_event_class_set_payload_field_class(event
, outer
);
185 BT_FIELD_CLASS_PUT_REF_AND_RESET(inner
);
186 BT_FIELD_CLASS_PUT_REF_AND_RESET(outer
);
190 static void set_stream_class_field_classes(
191 bt_stream_class
*stream_class
)
193 bt_trace_class
*trace_class
=
194 bt_stream_class_borrow_trace_class(stream_class
);
195 bt_field_class
*packet_context_type
;
196 bt_field_class
*event_header_type
;
200 packet_context_type
= bt_field_class_structure_create(trace_class
);
201 BT_ASSERT(packet_context_type
);
202 fc
= bt_field_class_unsigned_integer_create(trace_class
);
204 bt_field_class_integer_set_field_value_range(fc
, 32);
205 ret
= bt_field_class_structure_append_member(packet_context_type
,
208 bt_field_class_put_ref(fc
);
209 fc
= bt_field_class_unsigned_integer_create(trace_class
);
211 bt_field_class_integer_set_field_value_range(fc
, 32);
212 ret
= bt_field_class_structure_append_member(packet_context_type
,
215 bt_field_class_put_ref(fc
);
216 event_header_type
= bt_field_class_structure_create(trace_class
);
217 BT_ASSERT(event_header_type
);
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(event_header_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 ret
= bt_stream_class_set_event_header_field_class(
229 stream_class
, event_header_type
);
231 bt_field_class_put_ref(packet_context_type
);
232 bt_field_class_put_ref(event_header_type
);
235 static void create_sc1(bt_trace_class
*trace_class
)
238 bt_event_class
*ec1
= NULL
, *ec2
= NULL
;
239 bt_stream_class
*sc1
= NULL
, *ret_stream
= NULL
;
241 sc1
= bt_stream_class_create(trace_class
);
243 ret
= bt_stream_class_set_name(sc1
, "sc1");
245 set_stream_class_field_classes(sc1
);
246 ec1
= create_complex_event(sc1
, "ec1");
248 ec2
= create_simple_event(sc1
, "ec2");
250 ret_stream
= bt_event_class_borrow_stream_class(ec1
);
251 ok(ret_stream
== sc1
, "Borrow parent stream SC1 from EC1");
252 ret_stream
= bt_event_class_borrow_stream_class(ec2
);
253 ok(ret_stream
== sc1
, "Borrow parent stream SC1 from EC2");
254 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec1
);
255 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec2
);
256 BT_STREAM_CLASS_PUT_REF_AND_RESET(sc1
);
259 static void create_sc2(bt_trace_class
*trace_class
)
262 bt_event_class
*ec3
= NULL
;
263 bt_stream_class
*sc2
= NULL
, *ret_stream
= NULL
;
265 sc2
= bt_stream_class_create(trace_class
);
267 ret
= bt_stream_class_set_name(sc2
, "sc2");
269 set_stream_class_field_classes(sc2
);
270 ec3
= create_simple_event(sc2
, "ec3");
271 ret_stream
= bt_event_class_borrow_stream_class(ec3
);
272 ok(ret_stream
== sc2
, "Borrow parent stream SC2 from EC3");
273 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec3
);
274 BT_STREAM_CLASS_PUT_REF_AND_RESET(sc2
);
277 static void set_trace_packet_header(bt_trace_class
*trace_class
)
279 bt_field_class
*packet_header_type
;
283 packet_header_type
= bt_field_class_structure_create(trace_class
);
284 BT_ASSERT(packet_header_type
);
285 fc
= bt_field_class_unsigned_integer_create(trace_class
);
287 bt_field_class_integer_set_field_value_range(fc
, 32);
288 ret
= bt_field_class_structure_append_member(packet_header_type
,
291 bt_field_class_put_ref(fc
);
292 ret
= bt_trace_class_set_packet_header_field_class(trace_class
,
296 bt_field_class_put_ref(packet_header_type
);
299 static bt_trace_class
*create_tc1(bt_self_component_source
*self_comp
)
301 bt_trace_class
*tc1
= NULL
;
303 tc1
= bt_trace_class_create(
304 bt_self_component_source_as_self_component(self_comp
));
306 set_trace_packet_header(tc1
);
312 static void init_weak_refs(bt_trace_class
*tc
,
313 bt_trace_class
**tc1
,
314 bt_stream_class
**sc1
,
315 bt_stream_class
**sc2
,
316 bt_event_class
**ec1
,
317 bt_event_class
**ec2
,
318 bt_event_class
**ec3
)
321 *sc1
= bt_trace_class_borrow_stream_class_by_index(tc
, 0);
322 *sc2
= bt_trace_class_borrow_stream_class_by_index(tc
, 1);
323 *ec1
= bt_stream_class_borrow_event_class_by_index(*sc1
, 0);
324 *ec2
= bt_stream_class_borrow_event_class_by_index(*sc1
, 1);
325 *ec3
= bt_stream_class_borrow_event_class_by_index(*sc2
, 0);
328 static void test_example_scenario(bt_self_component_source
*self_comp
)
331 * Weak pointers to trace IR objects are to be used very
332 * carefully. This is NOT a good practice and is strongly
333 * discouraged; this is only done to facilitate the validation
334 * of expected reference counts without affecting them by taking
335 * "real" references to the objects.
337 bt_trace_class
*tc1
= NULL
, *weak_tc1
= NULL
;
338 bt_stream_class
*weak_sc1
= NULL
, *weak_sc2
= NULL
;
339 bt_event_class
*weak_ec1
= NULL
, *weak_ec2
= NULL
,
341 struct user user_a
= { 0 }, user_b
= { 0 }, user_c
= { 0 };
343 /* The only reference which exists at this point is on TC1. */
344 tc1
= create_tc1(self_comp
);
345 ok(tc1
, "Initialize trace");
347 init_weak_refs(tc1
, &weak_tc1
, &weak_sc1
, &weak_sc2
, &weak_ec1
,
348 &weak_ec2
, &weak_ec3
);
349 ok(bt_object_get_ref_count((void *) weak_sc1
) == 0,
350 "Initial SC1 reference count is 0");
351 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
352 "Initial SC2 reference count is 0");
353 ok(bt_object_get_ref_count((void *) weak_ec1
) == 0,
354 "Initial EC1 reference count is 0");
355 ok(bt_object_get_ref_count((void *) weak_ec2
) == 0,
356 "Initial EC2 reference count is 0");
357 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
358 "Initial EC3 reference count is 0");
360 /* User A has ownership of the trace. */
361 BT_OBJECT_MOVE_REF(user_a
.tc
, tc1
);
362 ok(bt_object_get_ref_count((void *) user_a
.tc
) == 1,
363 "TC1 reference count is 1");
365 /* User A acquires a reference to SC2 from TC1. */
366 user_a
.sc
= bt_trace_class_borrow_stream_class_by_index(
368 bt_stream_class_get_ref(user_a
.sc
);
369 ok(user_a
.sc
, "User A acquires SC2 from TC1");
370 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
371 "TC1 reference count is 2");
372 ok(bt_object_get_ref_count((void *) weak_sc2
) == 1,
373 "SC2 reference count is 1");
375 /* User A acquires a reference to EC3 from SC2. */
376 user_a
.ec
= bt_stream_class_borrow_event_class_by_index(
378 bt_event_class_get_ref(user_a
.ec
);
379 ok(user_a
.ec
, "User A acquires EC3 from SC2");
380 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
381 "TC1 reference count is 2");
382 ok(bt_object_get_ref_count((void *) weak_sc2
) == 2,
383 "SC2 reference count is 2");
384 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
385 "EC3 reference count is 1");
387 /* User A releases its reference to SC2. */
388 diag("User A releases SC2");
389 BT_STREAM_CLASS_PUT_REF_AND_RESET(user_a
.sc
);
391 * We keep the pointer to SC2 around to validate its reference
394 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
395 "TC1 reference count is 2");
396 ok(bt_object_get_ref_count((void *) weak_sc2
) == 1,
397 "SC2 reference count is 1");
398 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
399 "EC3 reference count is 1");
401 /* User A releases its reference to TC1. */
402 diag("User A releases TC1");
403 BT_TRACE_CLASS_PUT_REF_AND_RESET(user_a
.tc
);
405 * We keep the pointer to TC1 around to validate its reference
408 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
409 "TC1 reference count is 1");
410 ok(bt_object_get_ref_count((void *) weak_sc2
) == 1,
411 "SC2 reference count is 1");
412 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
413 "EC3 reference count is 1");
415 /* User B acquires a reference to SC1. */
416 diag("User B acquires a reference to SC1");
417 user_b
.sc
= weak_sc1
;
418 bt_stream_class_get_ref(user_b
.sc
);
419 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
420 "TC1 reference count is 2");
421 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
422 "SC1 reference count is 1");
424 /* User C acquires a reference to EC1. */
425 diag("User C acquires a reference to EC1");
426 user_c
.ec
= bt_stream_class_borrow_event_class_by_index(
428 bt_event_class_get_ref(user_c
.ec
);
429 ok(bt_object_get_ref_count((void *) weak_ec1
) == 1,
430 "EC1 reference count is 1");
431 ok(bt_object_get_ref_count((void *) weak_sc1
) == 2,
432 "SC1 reference count is 2");
434 /* User A releases its reference on EC3. */
435 diag("User A releases its reference on EC3");
436 BT_EVENT_CLASS_PUT_REF_AND_RESET(user_a
.ec
);
437 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
438 "EC3 reference count is 1");
439 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
440 "SC2 reference count is 0");
441 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
442 "TC1 reference count is 1");
444 /* User B releases its reference on SC1. */
445 diag("User B releases its reference on SC1");
446 BT_STREAM_CLASS_PUT_REF_AND_RESET(user_b
.sc
);
447 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
448 "SC1 reference count is 1");
451 * User C is the sole owner of an object and is keeping the whole
452 * trace hierarchy "alive" by holding a reference to EC1.
454 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
455 "TC1 reference count is 1");
456 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
457 "SC1 reference count is 1");
458 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
459 "SC2 reference count is 0");
460 ok(bt_object_get_ref_count((void *) weak_ec1
) == 1,
461 "EC1 reference count is 1");
462 ok(bt_object_get_ref_count((void *) weak_ec2
) == 0,
463 "EC2 reference count is 0");
464 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
465 "EC3 reference count is 0");
467 /* Reclaim last reference held by User C. */
468 BT_EVENT_CLASS_PUT_REF_AND_RESET(user_c
.ec
);
472 bt_self_component_status
src_init(
473 bt_self_component_source
*self_comp
,
474 const bt_value
*params
, void *init_method_data
)
476 test_example_scenario(self_comp
);
477 return BT_SELF_COMPONENT_STATUS_OK
;
481 bt_self_message_iterator_status
src_iter_next(
482 bt_self_message_iterator
*self_iterator
,
483 bt_message_array_const msgs
, uint64_t capacity
,
486 return BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
489 static void test_example_scenario_in_graph(void)
491 bt_component_class_source
*comp_cls
;
495 comp_cls
= bt_component_class_source_create("src", src_iter_next
);
497 ret
= bt_component_class_source_set_init_method(comp_cls
, src_init
);
499 graph
= bt_graph_create();
500 ret
= bt_graph_add_source_component(graph
, comp_cls
, "src-comp",
503 bt_graph_put_ref(graph
);
504 bt_component_class_source_put_ref(comp_cls
);
507 static void create_writer_user_full(struct writer_user
*user
)
510 struct bt_ctf_field_type
*ft
;
511 struct bt_ctf_field
*field
;
512 struct bt_ctf_clock
*clock
;
515 trace_path
= g_build_filename(g_get_tmp_dir(), "ctfwriter_XXXXXX", NULL
);
516 if (!bt_mkdtemp(trace_path
)) {
520 user
->writer
= bt_ctf_writer_create(trace_path
);
521 BT_ASSERT(user
->writer
);
522 ret
= bt_ctf_writer_set_byte_order(user
->writer
,
523 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
);
525 user
->tc
= bt_ctf_writer_get_trace(user
->writer
);
527 user
->sc
= bt_ctf_stream_class_create("sc");
529 clock
= bt_ctf_clock_create("the_clock");
531 ret
= bt_ctf_writer_add_clock(user
->writer
, clock
);
533 ret
= bt_ctf_stream_class_set_clock(user
->sc
, clock
);
535 BT_OBJECT_PUT_REF_AND_RESET(clock
);
536 user
->stream
= bt_ctf_writer_create_stream(user
->writer
, user
->sc
);
537 BT_ASSERT(user
->stream
);
538 user
->ec
= bt_ctf_event_class_create("ec");
540 ft
= create_writer_integer_struct();
542 ret
= bt_ctf_event_class_set_payload_field_type(user
->ec
, ft
);
543 BT_OBJECT_PUT_REF_AND_RESET(ft
);
545 ret
= bt_ctf_stream_class_add_event_class(user
->sc
, user
->ec
);
547 user
->event
= bt_ctf_event_create(user
->ec
);
548 BT_ASSERT(user
->event
);
549 field
= bt_ctf_event_get_payload(user
->event
, "payload_8");
551 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 10);
553 BT_OBJECT_PUT_REF_AND_RESET(field
);
554 field
= bt_ctf_event_get_payload(user
->event
, "payload_16");
556 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 20);
558 BT_OBJECT_PUT_REF_AND_RESET(field
);
559 field
= bt_ctf_event_get_payload(user
->event
, "payload_32");
561 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 30);
563 BT_OBJECT_PUT_REF_AND_RESET(field
);
564 ret
= bt_ctf_stream_append_event(user
->stream
, user
->event
);
566 recursive_rmdir(trace_path
);
570 static void test_put_order_swap(size_t *array
, size_t a
, size_t b
)
572 size_t temp
= array
[a
];
578 static void test_put_order_put_objects(size_t *array
, size_t size
)
581 struct writer_user user
= { 0 };
582 void **objects
= (void *) &user
;
584 create_writer_user_full(&user
);
587 for (i
= 0; i
< size
; ++i
) {
588 void *obj
= objects
[array
[i
]];
590 printf("%s", writer_user_names
[array
[i
]]);
591 BT_OBJECT_PUT_REF_AND_RESET(obj
);
601 static void test_put_order_permute(size_t *array
, int k
, size_t size
)
604 test_put_order_put_objects(array
, size
);
608 for (i
= k
- 1; i
>= 0; i
--) {
609 size_t next_k
= k
- 1;
611 test_put_order_swap(array
, i
, next_k
);
612 test_put_order_permute(array
, next_k
, size
);
613 test_put_order_swap(array
, i
, next_k
);
618 static void test_put_order(void)
621 size_t array
[WRITER_USER_NR_ELEMENTS
];
623 /* Initialize array of indexes */
624 for (i
= 0; i
< WRITER_USER_NR_ELEMENTS
; ++i
) {
628 test_put_order_permute(array
, WRITER_USER_NR_ELEMENTS
,
629 WRITER_USER_NR_ELEMENTS
);
633 * The objective of this test is to implement and expand upon the scenario
634 * described in the reference counting documentation and ensure that any node of
635 * the Trace, Stream Class, Event Class, Stream and Event hiearchy keeps all
636 * other "alive" and reachable.
638 * External tools (e.g. valgrind) should be used to confirm that this
639 * known-good test does not leak memory.
641 int main(int argc
, char **argv
)
643 /* Initialize tap harness before any tests */
644 plan_tests(NR_TESTS
);
646 test_example_scenario_in_graph();
649 return exit_status();