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(void)
69 bt_field_class
*structure
= NULL
;
70 bt_field_class
*ui8
= NULL
, *ui16
= NULL
, *ui32
= NULL
;
72 structure
= bt_field_class_structure_create();
74 ui8
= bt_field_class_unsigned_integer_create();
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();
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();
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();
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(
168 bt_event_class
*event
= NULL
;
169 bt_field_class
*inner
= NULL
, *outer
= NULL
;
172 event
= bt_event_class_create(sc
);
174 ret
= bt_event_class_set_name(event
, name
);
176 outer
= create_integer_struct();
178 inner
= create_integer_struct();
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_field_class
*packet_context_type
;
194 bt_field_class
*event_header_type
;
198 packet_context_type
= bt_field_class_structure_create();
199 BT_ASSERT(packet_context_type
);
200 fc
= bt_field_class_unsigned_integer_create();
202 bt_field_class_integer_set_field_value_range(fc
, 32);
203 ret
= bt_field_class_structure_append_member(packet_context_type
,
206 bt_field_class_put_ref(fc
);
207 fc
= bt_field_class_unsigned_integer_create();
209 bt_field_class_integer_set_field_value_range(fc
, 32);
210 ret
= bt_field_class_structure_append_member(packet_context_type
,
213 bt_field_class_put_ref(fc
);
214 event_header_type
= bt_field_class_structure_create();
215 BT_ASSERT(event_header_type
);
216 fc
= bt_field_class_unsigned_integer_create();
218 bt_field_class_integer_set_field_value_range(fc
, 32);
219 ret
= bt_field_class_structure_append_member(event_header_type
,
222 bt_field_class_put_ref(fc
);
223 ret
= bt_stream_class_set_packet_context_field_class(
224 stream_class
, packet_context_type
);
226 ret
= bt_stream_class_set_event_header_field_class(
227 stream_class
, event_header_type
);
229 bt_field_class_put_ref(packet_context_type
);
230 bt_field_class_put_ref(event_header_type
);
233 static void create_sc1(bt_trace_class
*trace_class
)
236 bt_event_class
*ec1
= NULL
, *ec2
= NULL
;
237 bt_stream_class
*sc1
= NULL
, *ret_stream
= NULL
;
239 sc1
= bt_stream_class_create(trace_class
);
241 ret
= bt_stream_class_set_name(sc1
, "sc1");
243 set_stream_class_field_classes(sc1
);
244 ec1
= create_complex_event(sc1
, "ec1");
246 ec2
= create_simple_event(sc1
, "ec2");
248 ret_stream
= bt_event_class_borrow_stream_class(ec1
);
249 ok(ret_stream
== sc1
, "Borrow parent stream SC1 from EC1");
250 ret_stream
= bt_event_class_borrow_stream_class(ec2
);
251 ok(ret_stream
== sc1
, "Borrow parent stream SC1 from EC2");
252 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec1
);
253 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec2
);
254 BT_STREAM_CLASS_PUT_REF_AND_RESET(sc1
);
257 static void create_sc2(bt_trace_class
*trace_class
)
260 bt_event_class
*ec3
= NULL
;
261 bt_stream_class
*sc2
= NULL
, *ret_stream
= NULL
;
263 sc2
= bt_stream_class_create(trace_class
);
265 ret
= bt_stream_class_set_name(sc2
, "sc2");
267 set_stream_class_field_classes(sc2
);
268 ec3
= create_simple_event(sc2
, "ec3");
269 ret_stream
= bt_event_class_borrow_stream_class(ec3
);
270 ok(ret_stream
== sc2
, "Borrow parent stream SC2 from EC3");
271 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec3
);
272 BT_STREAM_CLASS_PUT_REF_AND_RESET(sc2
);
275 static void set_trace_packet_header(bt_trace_class
*trace_class
)
277 bt_field_class
*packet_header_type
;
281 packet_header_type
= bt_field_class_structure_create();
282 BT_ASSERT(packet_header_type
);
283 fc
= bt_field_class_unsigned_integer_create();
285 bt_field_class_integer_set_field_value_range(fc
, 32);
286 ret
= bt_field_class_structure_append_member(packet_header_type
,
289 bt_field_class_put_ref(fc
);
290 ret
= bt_trace_class_set_packet_header_field_class(trace_class
,
294 bt_field_class_put_ref(packet_header_type
);
297 static bt_trace_class
*create_tc1(bt_self_component_source
*self_comp
)
299 bt_trace_class
*tc1
= NULL
;
301 tc1
= bt_trace_class_create(
302 bt_self_component_source_as_self_component(self_comp
));
304 set_trace_packet_header(tc1
);
310 static void init_weak_refs(bt_trace_class
*tc
,
311 bt_trace_class
**tc1
,
312 bt_stream_class
**sc1
,
313 bt_stream_class
**sc2
,
314 bt_event_class
**ec1
,
315 bt_event_class
**ec2
,
316 bt_event_class
**ec3
)
319 *sc1
= bt_trace_class_borrow_stream_class_by_index(tc
, 0);
320 *sc2
= bt_trace_class_borrow_stream_class_by_index(tc
, 1);
321 *ec1
= bt_stream_class_borrow_event_class_by_index(*sc1
, 0);
322 *ec2
= bt_stream_class_borrow_event_class_by_index(*sc1
, 1);
323 *ec3
= bt_stream_class_borrow_event_class_by_index(*sc2
, 0);
326 static void test_example_scenario(bt_self_component_source
*self_comp
)
329 * Weak pointers to trace IR objects are to be used very
330 * carefully. This is NOT a good practice and is strongly
331 * discouraged; this is only done to facilitate the validation
332 * of expected reference counts without affecting them by taking
333 * "real" references to the objects.
335 bt_trace_class
*tc1
= NULL
, *weak_tc1
= NULL
;
336 bt_stream_class
*weak_sc1
= NULL
, *weak_sc2
= NULL
;
337 bt_event_class
*weak_ec1
= NULL
, *weak_ec2
= NULL
,
339 struct user user_a
= { 0 }, user_b
= { 0 }, user_c
= { 0 };
341 /* The only reference which exists at this point is on TC1. */
342 tc1
= create_tc1(self_comp
);
343 ok(tc1
, "Initialize trace");
345 init_weak_refs(tc1
, &weak_tc1
, &weak_sc1
, &weak_sc2
, &weak_ec1
,
346 &weak_ec2
, &weak_ec3
);
347 ok(bt_object_get_ref_count((void *) weak_sc1
) == 0,
348 "Initial SC1 reference count is 0");
349 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
350 "Initial SC2 reference count is 0");
351 ok(bt_object_get_ref_count((void *) weak_ec1
) == 0,
352 "Initial EC1 reference count is 0");
353 ok(bt_object_get_ref_count((void *) weak_ec2
) == 0,
354 "Initial EC2 reference count is 0");
355 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
356 "Initial EC3 reference count is 0");
358 /* User A has ownership of the trace. */
359 BT_OBJECT_MOVE_REF(user_a
.tc
, tc1
);
360 ok(bt_object_get_ref_count((void *) user_a
.tc
) == 1,
361 "TC1 reference count is 1");
363 /* User A acquires a reference to SC2 from TC1. */
364 user_a
.sc
= bt_trace_class_borrow_stream_class_by_index(
366 bt_stream_class_get_ref(user_a
.sc
);
367 ok(user_a
.sc
, "User A acquires SC2 from TC1");
368 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
369 "TC1 reference count is 2");
370 ok(bt_object_get_ref_count((void *) weak_sc2
) == 1,
371 "SC2 reference count is 1");
373 /* User A acquires a reference to EC3 from SC2. */
374 user_a
.ec
= bt_stream_class_borrow_event_class_by_index(
376 bt_event_class_get_ref(user_a
.ec
);
377 ok(user_a
.ec
, "User A acquires EC3 from SC2");
378 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
379 "TC1 reference count is 2");
380 ok(bt_object_get_ref_count((void *) weak_sc2
) == 2,
381 "SC2 reference count is 2");
382 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
383 "EC3 reference count is 1");
385 /* User A releases its reference to SC2. */
386 diag("User A releases SC2");
387 BT_STREAM_CLASS_PUT_REF_AND_RESET(user_a
.sc
);
389 * We keep the pointer to SC2 around to validate its reference
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_sc2
) == 1,
395 "SC2 reference count is 1");
396 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
397 "EC3 reference count is 1");
399 /* User A releases its reference to TC1. */
400 diag("User A releases TC1");
401 BT_TRACE_CLASS_PUT_REF_AND_RESET(user_a
.tc
);
403 * We keep the pointer to TC1 around to validate its reference
406 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
407 "TC1 reference count is 1");
408 ok(bt_object_get_ref_count((void *) weak_sc2
) == 1,
409 "SC2 reference count is 1");
410 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
411 "EC3 reference count is 1");
413 /* User B acquires a reference to SC1. */
414 diag("User B acquires a reference to SC1");
415 user_b
.sc
= weak_sc1
;
416 bt_stream_class_get_ref(user_b
.sc
);
417 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
418 "TC1 reference count is 2");
419 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
420 "SC1 reference count is 1");
422 /* User C acquires a reference to EC1. */
423 diag("User C acquires a reference to EC1");
424 user_c
.ec
= bt_stream_class_borrow_event_class_by_index(
426 bt_event_class_get_ref(user_c
.ec
);
427 ok(bt_object_get_ref_count((void *) weak_ec1
) == 1,
428 "EC1 reference count is 1");
429 ok(bt_object_get_ref_count((void *) weak_sc1
) == 2,
430 "SC1 reference count is 2");
432 /* User A releases its reference on EC3. */
433 diag("User A releases its reference on EC3");
434 BT_EVENT_CLASS_PUT_REF_AND_RESET(user_a
.ec
);
435 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
436 "EC3 reference count is 1");
437 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
438 "SC2 reference count is 0");
439 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
440 "TC1 reference count is 1");
442 /* User B releases its reference on SC1. */
443 diag("User B releases its reference on SC1");
444 BT_STREAM_CLASS_PUT_REF_AND_RESET(user_b
.sc
);
445 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
446 "SC1 reference count is 1");
449 * User C is the sole owner of an object and is keeping the whole
450 * trace hierarchy "alive" by holding a reference to EC1.
452 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
453 "TC1 reference count is 1");
454 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
455 "SC1 reference count is 1");
456 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
457 "SC2 reference count is 0");
458 ok(bt_object_get_ref_count((void *) weak_ec1
) == 1,
459 "EC1 reference count is 1");
460 ok(bt_object_get_ref_count((void *) weak_ec2
) == 0,
461 "EC2 reference count is 0");
462 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
463 "EC3 reference count is 0");
465 /* Reclaim last reference held by User C. */
466 BT_EVENT_CLASS_PUT_REF_AND_RESET(user_c
.ec
);
470 bt_self_component_status
src_init(
471 bt_self_component_source
*self_comp
,
472 const bt_value
*params
, void *init_method_data
)
474 test_example_scenario(self_comp
);
475 return BT_SELF_COMPONENT_STATUS_OK
;
479 bt_self_message_iterator_status
src_iter_next(
480 bt_self_message_iterator
*self_iterator
,
481 bt_message_array_const msgs
, uint64_t capacity
,
484 return BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
487 static void test_example_scenario_in_graph(void)
489 bt_component_class_source
*comp_cls
;
493 comp_cls
= bt_component_class_source_create("src", src_iter_next
);
495 ret
= bt_component_class_source_set_init_method(comp_cls
, src_init
);
497 graph
= bt_graph_create();
498 ret
= bt_graph_add_source_component(graph
, comp_cls
, "src-comp",
501 bt_graph_put_ref(graph
);
502 bt_component_class_source_put_ref(comp_cls
);
505 static void create_writer_user_full(struct writer_user
*user
)
508 struct bt_ctf_field_type
*ft
;
509 struct bt_ctf_field
*field
;
510 struct bt_ctf_clock
*clock
;
513 trace_path
= g_build_filename(g_get_tmp_dir(), "ctfwriter_XXXXXX", NULL
);
514 if (!bt_mkdtemp(trace_path
)) {
518 user
->writer
= bt_ctf_writer_create(trace_path
);
519 BT_ASSERT(user
->writer
);
520 ret
= bt_ctf_writer_set_byte_order(user
->writer
,
521 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
);
523 user
->tc
= bt_ctf_writer_get_trace(user
->writer
);
525 user
->sc
= bt_ctf_stream_class_create("sc");
527 clock
= bt_ctf_clock_create("the_clock");
529 ret
= bt_ctf_writer_add_clock(user
->writer
, clock
);
531 ret
= bt_ctf_stream_class_set_clock(user
->sc
, clock
);
533 BT_OBJECT_PUT_REF_AND_RESET(clock
);
534 user
->stream
= bt_ctf_writer_create_stream(user
->writer
, user
->sc
);
535 BT_ASSERT(user
->stream
);
536 user
->ec
= bt_ctf_event_class_create("ec");
538 ft
= create_writer_integer_struct();
540 ret
= bt_ctf_event_class_set_payload_field_type(user
->ec
, ft
);
541 BT_OBJECT_PUT_REF_AND_RESET(ft
);
543 ret
= bt_ctf_stream_class_add_event_class(user
->sc
, user
->ec
);
545 user
->event
= bt_ctf_event_create(user
->ec
);
546 BT_ASSERT(user
->event
);
547 field
= bt_ctf_event_get_payload(user
->event
, "payload_8");
549 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 10);
551 BT_OBJECT_PUT_REF_AND_RESET(field
);
552 field
= bt_ctf_event_get_payload(user
->event
, "payload_16");
554 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 20);
556 BT_OBJECT_PUT_REF_AND_RESET(field
);
557 field
= bt_ctf_event_get_payload(user
->event
, "payload_32");
559 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 30);
561 BT_OBJECT_PUT_REF_AND_RESET(field
);
562 ret
= bt_ctf_stream_append_event(user
->stream
, user
->event
);
564 recursive_rmdir(trace_path
);
568 static void test_put_order_swap(size_t *array
, size_t a
, size_t b
)
570 size_t temp
= array
[a
];
576 static void test_put_order_put_objects(size_t *array
, size_t size
)
579 struct writer_user user
= { 0 };
580 void **objects
= (void *) &user
;
582 create_writer_user_full(&user
);
585 for (i
= 0; i
< size
; ++i
) {
586 void *obj
= objects
[array
[i
]];
588 printf("%s", writer_user_names
[array
[i
]]);
589 BT_OBJECT_PUT_REF_AND_RESET(obj
);
599 static void test_put_order_permute(size_t *array
, int k
, size_t size
)
602 test_put_order_put_objects(array
, size
);
606 for (i
= k
- 1; i
>= 0; i
--) {
607 size_t next_k
= k
- 1;
609 test_put_order_swap(array
, i
, next_k
);
610 test_put_order_permute(array
, next_k
, size
);
611 test_put_order_swap(array
, i
, next_k
);
616 static void test_put_order(void)
619 size_t array
[WRITER_USER_NR_ELEMENTS
];
621 /* Initialize array of indexes */
622 for (i
= 0; i
< WRITER_USER_NR_ELEMENTS
; ++i
) {
626 test_put_order_permute(array
, WRITER_USER_NR_ELEMENTS
,
627 WRITER_USER_NR_ELEMENTS
);
631 * The objective of this test is to implement and expand upon the scenario
632 * described in the reference counting documentation and ensure that any node of
633 * the Trace, Stream Class, Event Class, Stream and Event hiearchy keeps all
634 * other "alive" and reachable.
636 * External tools (e.g. valgrind) should be used to confirm that this
637 * known-good test does not leak memory.
639 int main(int argc
, char **argv
)
641 /* Initialize tap harness before any tests */
642 plan_tests(NR_TESTS
);
644 test_example_scenario_in_graph();
647 return exit_status();