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 <babeltrace2/babeltrace.h>
24 #include <babeltrace2/object-internal.h>
25 #include <babeltrace2/compat/stdlib-internal.h>
26 #include <babeltrace2/assert-internal.h>
27 #include <babeltrace2/ctf-writer/writer.h>
28 #include <babeltrace2/ctf-writer/clock.h>
29 #include <babeltrace2/ctf-writer/clock-class.h>
30 #include <babeltrace2/ctf-writer/stream.h>
31 #include <babeltrace2/ctf-writer/event.h>
32 #include <babeltrace2/ctf-writer/event-types.h>
33 #include <babeltrace2/ctf-writer/event-fields.h>
34 #include <babeltrace2/ctf-writer/stream-class.h>
35 #include <babeltrace2/ctf-writer/trace.h>
49 struct bt_ctf_writer
*writer
;
50 struct bt_ctf_trace
*tc
;
51 struct bt_ctf_stream_class
*sc
;
52 struct bt_ctf_event_class
*ec
;
53 struct bt_ctf_stream
*stream
;
54 struct bt_ctf_event
*event
;
57 const char *writer_user_names
[] = {
66 static const size_t WRITER_USER_NR_ELEMENTS
=
67 sizeof(struct writer_user
) / sizeof(void *);
70 * Returns a structure containing the following fields:
71 * - uint8_t payload_8;
72 * - uint16_t payload_16;
73 * - uint32_t payload_32;
75 static bt_field_class
*create_integer_struct(bt_trace_class
*trace_class
)
78 bt_field_class
*structure
= NULL
;
79 bt_field_class
*ui8
= NULL
, *ui16
= NULL
, *ui32
= NULL
;
81 structure
= bt_field_class_structure_create(trace_class
);
83 ui8
= bt_field_class_unsigned_integer_create(trace_class
);
85 bt_field_class_integer_set_field_value_range(ui8
, 8);
86 ret
= bt_field_class_structure_append_member(structure
,
89 ui16
= bt_field_class_unsigned_integer_create(trace_class
);
91 bt_field_class_integer_set_field_value_range(ui16
, 16);
92 ret
= bt_field_class_structure_append_member(structure
,
95 ui32
= bt_field_class_unsigned_integer_create(trace_class
);
97 bt_field_class_integer_set_field_value_range(ui32
, 32);
98 ret
= bt_field_class_structure_append_member(structure
,
101 BT_FIELD_CLASS_PUT_REF_AND_RESET(ui8
);
102 BT_FIELD_CLASS_PUT_REF_AND_RESET(ui16
);
103 BT_FIELD_CLASS_PUT_REF_AND_RESET(ui32
);
107 static struct bt_ctf_field_type
*create_writer_integer_struct(void)
110 struct bt_ctf_field_type
*structure
= NULL
;
111 struct bt_ctf_field_type
*ui8
= NULL
, *ui16
= NULL
, *ui32
= NULL
;
113 structure
= bt_ctf_field_type_structure_create();
114 BT_ASSERT(structure
);
115 ui8
= bt_ctf_field_type_integer_create(8);
117 ret
= bt_ctf_field_type_structure_add_field(structure
, ui8
,
120 ui16
= bt_ctf_field_type_integer_create(16);
122 ret
= bt_ctf_field_type_structure_add_field(structure
, ui16
,
125 ui32
= bt_ctf_field_type_integer_create(32);
127 ret
= bt_ctf_field_type_structure_add_field(structure
, ui32
,
130 BT_OBJECT_PUT_REF_AND_RESET(ui8
);
131 BT_OBJECT_PUT_REF_AND_RESET(ui16
);
132 BT_OBJECT_PUT_REF_AND_RESET(ui32
);
137 * A simple event has the following payload:
138 * - uint8_t payload_8;
139 * - uint16_t payload_16;
140 * - uint32_t payload_32;
142 static bt_event_class
*create_simple_event(
143 bt_stream_class
*sc
, const char *name
)
146 bt_event_class
*event
= NULL
;
147 bt_field_class
*payload
= NULL
;
150 event
= bt_event_class_create(sc
);
152 ret
= bt_event_class_set_name(event
, name
);
154 payload
= create_integer_struct(bt_stream_class_borrow_trace_class(sc
));
156 ret
= bt_event_class_set_payload_field_class(event
, payload
);
158 BT_FIELD_CLASS_PUT_REF_AND_RESET(payload
);
163 * A complex event has the following payload:
164 * - uint8_t payload_8;
165 * - uint16_t payload_16;
166 * - uint32_t payload_32;
167 * - struct payload_struct:
168 * - uint8_t payload_8;
169 * - uint16_t payload_16;
170 * - uint32_t payload_32;
172 static bt_event_class
*create_complex_event(bt_stream_class
*sc
,
176 bt_event_class
*event
= NULL
;
177 bt_field_class
*inner
= NULL
, *outer
= NULL
;
178 bt_trace_class
*trace_class
= bt_stream_class_borrow_trace_class(sc
);
181 event
= bt_event_class_create(sc
);
183 ret
= bt_event_class_set_name(event
, name
);
185 outer
= create_integer_struct(trace_class
);
187 inner
= create_integer_struct(trace_class
);
189 ret
= bt_field_class_structure_append_member(outer
,
190 "payload_struct", inner
);
192 ret
= bt_event_class_set_payload_field_class(event
, outer
);
194 BT_FIELD_CLASS_PUT_REF_AND_RESET(inner
);
195 BT_FIELD_CLASS_PUT_REF_AND_RESET(outer
);
199 static void set_stream_class_field_classes(
200 bt_stream_class
*stream_class
)
202 bt_trace_class
*trace_class
=
203 bt_stream_class_borrow_trace_class(stream_class
);
204 bt_field_class
*packet_context_type
;
208 packet_context_type
= bt_field_class_structure_create(trace_class
);
209 BT_ASSERT(packet_context_type
);
210 fc
= bt_field_class_unsigned_integer_create(trace_class
);
212 bt_field_class_integer_set_field_value_range(fc
, 32);
213 ret
= bt_field_class_structure_append_member(packet_context_type
,
216 bt_field_class_put_ref(fc
);
217 fc
= bt_field_class_unsigned_integer_create(trace_class
);
219 bt_field_class_integer_set_field_value_range(fc
, 32);
220 ret
= bt_field_class_structure_append_member(packet_context_type
,
223 bt_field_class_put_ref(fc
);
224 ret
= bt_stream_class_set_packet_context_field_class(
225 stream_class
, packet_context_type
);
227 bt_field_class_put_ref(packet_context_type
);
230 static void create_sc1(bt_trace_class
*trace_class
)
233 bt_event_class
*ec1
= NULL
, *ec2
= NULL
;
234 bt_stream_class
*sc1
= NULL
, *ret_stream
= NULL
;
236 sc1
= bt_stream_class_create(trace_class
);
238 ret
= bt_stream_class_set_name(sc1
, "sc1");
240 set_stream_class_field_classes(sc1
);
241 ec1
= create_complex_event(sc1
, "ec1");
243 ec2
= create_simple_event(sc1
, "ec2");
245 ret_stream
= bt_event_class_borrow_stream_class(ec1
);
246 ok(ret_stream
== sc1
, "Borrow parent stream SC1 from EC1");
247 ret_stream
= bt_event_class_borrow_stream_class(ec2
);
248 ok(ret_stream
== sc1
, "Borrow parent stream SC1 from EC2");
249 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec1
);
250 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec2
);
251 BT_STREAM_CLASS_PUT_REF_AND_RESET(sc1
);
254 static void create_sc2(bt_trace_class
*trace_class
)
257 bt_event_class
*ec3
= NULL
;
258 bt_stream_class
*sc2
= NULL
, *ret_stream
= NULL
;
260 sc2
= bt_stream_class_create(trace_class
);
262 ret
= bt_stream_class_set_name(sc2
, "sc2");
264 set_stream_class_field_classes(sc2
);
265 ec3
= create_simple_event(sc2
, "ec3");
266 ret_stream
= bt_event_class_borrow_stream_class(ec3
);
267 ok(ret_stream
== sc2
, "Borrow parent stream SC2 from EC3");
268 BT_EVENT_CLASS_PUT_REF_AND_RESET(ec3
);
269 BT_STREAM_CLASS_PUT_REF_AND_RESET(sc2
);
272 static bt_trace_class
*create_tc1(bt_self_component_source
*self_comp
)
274 bt_trace_class
*tc1
= NULL
;
276 tc1
= bt_trace_class_create(
277 bt_self_component_source_as_self_component(self_comp
));
284 static void init_weak_refs(bt_trace_class
*tc
,
285 bt_trace_class
**tc1
,
286 bt_stream_class
**sc1
,
287 bt_stream_class
**sc2
,
288 bt_event_class
**ec1
,
289 bt_event_class
**ec2
,
290 bt_event_class
**ec3
)
293 *sc1
= bt_trace_class_borrow_stream_class_by_index(tc
, 0);
294 *sc2
= bt_trace_class_borrow_stream_class_by_index(tc
, 1);
295 *ec1
= bt_stream_class_borrow_event_class_by_index(*sc1
, 0);
296 *ec2
= bt_stream_class_borrow_event_class_by_index(*sc1
, 1);
297 *ec3
= bt_stream_class_borrow_event_class_by_index(*sc2
, 0);
300 static void test_example_scenario(bt_self_component_source
*self_comp
)
303 * Weak pointers to trace IR objects are to be used very
304 * carefully. This is NOT a good practice and is strongly
305 * discouraged; this is only done to facilitate the validation
306 * of expected reference counts without affecting them by taking
307 * "real" references to the objects.
309 bt_trace_class
*tc1
= NULL
, *weak_tc1
= NULL
;
310 bt_stream_class
*weak_sc1
= NULL
, *weak_sc2
= NULL
;
311 bt_event_class
*weak_ec1
= NULL
, *weak_ec2
= NULL
,
313 struct user user_a
= { 0 }, user_b
= { 0 }, user_c
= { 0 };
315 /* The only reference which exists at this point is on TC1. */
316 tc1
= create_tc1(self_comp
);
317 ok(tc1
, "Initialize trace");
319 init_weak_refs(tc1
, &weak_tc1
, &weak_sc1
, &weak_sc2
, &weak_ec1
,
320 &weak_ec2
, &weak_ec3
);
321 ok(bt_object_get_ref_count((void *) weak_sc1
) == 0,
322 "Initial SC1 reference count is 0");
323 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
324 "Initial SC2 reference count is 0");
325 ok(bt_object_get_ref_count((void *) weak_ec1
) == 0,
326 "Initial EC1 reference count is 0");
327 ok(bt_object_get_ref_count((void *) weak_ec2
) == 0,
328 "Initial EC2 reference count is 0");
329 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
330 "Initial EC3 reference count is 0");
332 /* User A has ownership of the trace. */
333 BT_OBJECT_MOVE_REF(user_a
.tc
, tc1
);
334 ok(bt_object_get_ref_count((void *) user_a
.tc
) == 1,
335 "TC1 reference count is 1");
337 /* User A acquires a reference to SC2 from TC1. */
338 user_a
.sc
= bt_trace_class_borrow_stream_class_by_index(
340 bt_stream_class_get_ref(user_a
.sc
);
341 ok(user_a
.sc
, "User A acquires SC2 from TC1");
342 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
343 "TC1 reference count is 2");
344 ok(bt_object_get_ref_count((void *) weak_sc2
) == 1,
345 "SC2 reference count is 1");
347 /* User A acquires a reference to EC3 from SC2. */
348 user_a
.ec
= bt_stream_class_borrow_event_class_by_index(
350 bt_event_class_get_ref(user_a
.ec
);
351 ok(user_a
.ec
, "User A acquires EC3 from SC2");
352 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
353 "TC1 reference count is 2");
354 ok(bt_object_get_ref_count((void *) weak_sc2
) == 2,
355 "SC2 reference count is 2");
356 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
357 "EC3 reference count is 1");
359 /* User A releases its reference to SC2. */
360 diag("User A releases SC2");
361 BT_STREAM_CLASS_PUT_REF_AND_RESET(user_a
.sc
);
363 * We keep the pointer to SC2 around to validate its reference
366 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
367 "TC1 reference count is 2");
368 ok(bt_object_get_ref_count((void *) weak_sc2
) == 1,
369 "SC2 reference count is 1");
370 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
371 "EC3 reference count is 1");
373 /* User A releases its reference to TC1. */
374 diag("User A releases TC1");
375 BT_TRACE_CLASS_PUT_REF_AND_RESET(user_a
.tc
);
377 * We keep the pointer to TC1 around to validate its reference
380 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
381 "TC1 reference count is 1");
382 ok(bt_object_get_ref_count((void *) weak_sc2
) == 1,
383 "SC2 reference count is 1");
384 ok(bt_object_get_ref_count((void *) weak_ec3
) == 1,
385 "EC3 reference count is 1");
387 /* User B acquires a reference to SC1. */
388 diag("User B acquires a reference to SC1");
389 user_b
.sc
= weak_sc1
;
390 bt_stream_class_get_ref(user_b
.sc
);
391 ok(bt_object_get_ref_count((void *) weak_tc1
) == 2,
392 "TC1 reference count is 2");
393 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
394 "SC1 reference count is 1");
396 /* User C acquires a reference to EC1. */
397 diag("User C acquires a reference to EC1");
398 user_c
.ec
= bt_stream_class_borrow_event_class_by_index(
400 bt_event_class_get_ref(user_c
.ec
);
401 ok(bt_object_get_ref_count((void *) weak_ec1
) == 1,
402 "EC1 reference count is 1");
403 ok(bt_object_get_ref_count((void *) weak_sc1
) == 2,
404 "SC1 reference count is 2");
406 /* User A releases its reference on EC3. */
407 diag("User A releases its reference on EC3");
408 BT_EVENT_CLASS_PUT_REF_AND_RESET(user_a
.ec
);
409 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
410 "EC3 reference count is 1");
411 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
412 "SC2 reference count is 0");
413 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
414 "TC1 reference count is 1");
416 /* User B releases its reference on SC1. */
417 diag("User B releases its reference on SC1");
418 BT_STREAM_CLASS_PUT_REF_AND_RESET(user_b
.sc
);
419 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
420 "SC1 reference count is 1");
423 * User C is the sole owner of an object and is keeping the whole
424 * trace hierarchy "alive" by holding a reference to EC1.
426 ok(bt_object_get_ref_count((void *) weak_tc1
) == 1,
427 "TC1 reference count is 1");
428 ok(bt_object_get_ref_count((void *) weak_sc1
) == 1,
429 "SC1 reference count is 1");
430 ok(bt_object_get_ref_count((void *) weak_sc2
) == 0,
431 "SC2 reference count is 0");
432 ok(bt_object_get_ref_count((void *) weak_ec1
) == 1,
433 "EC1 reference count is 1");
434 ok(bt_object_get_ref_count((void *) weak_ec2
) == 0,
435 "EC2 reference count is 0");
436 ok(bt_object_get_ref_count((void *) weak_ec3
) == 0,
437 "EC3 reference count is 0");
439 /* Reclaim last reference held by User C. */
440 BT_EVENT_CLASS_PUT_REF_AND_RESET(user_c
.ec
);
444 bt_self_component_status
src_init(
445 bt_self_component_source
*self_comp
,
446 const bt_value
*params
, void *init_method_data
)
448 test_example_scenario(self_comp
);
449 return BT_SELF_COMPONENT_STATUS_OK
;
453 bt_self_message_iterator_status
src_iter_next(
454 bt_self_message_iterator
*self_iterator
,
455 bt_message_array_const msgs
, uint64_t capacity
,
458 return BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
461 static void test_example_scenario_in_graph(void)
463 bt_component_class_source
*comp_cls
;
467 comp_cls
= bt_component_class_source_create("src", src_iter_next
);
469 ret
= bt_component_class_source_set_init_method(comp_cls
, src_init
);
471 graph
= bt_graph_create();
472 ret
= bt_graph_add_source_component(graph
, comp_cls
, "src-comp",
475 bt_graph_put_ref(graph
);
476 bt_component_class_source_put_ref(comp_cls
);
479 static void create_writer_user_full(struct writer_user
*user
)
482 struct bt_ctf_field_type
*ft
;
483 struct bt_ctf_field
*field
;
484 struct bt_ctf_clock
*clock
;
487 trace_path
= g_build_filename(g_get_tmp_dir(), "ctfwriter_XXXXXX", NULL
);
488 if (!bt_mkdtemp(trace_path
)) {
492 user
->writer
= bt_ctf_writer_create(trace_path
);
493 BT_ASSERT(user
->writer
);
494 ret
= bt_ctf_writer_set_byte_order(user
->writer
,
495 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
);
497 user
->tc
= bt_ctf_writer_get_trace(user
->writer
);
499 user
->sc
= bt_ctf_stream_class_create("sc");
501 clock
= bt_ctf_clock_create("the_clock");
503 ret
= bt_ctf_writer_add_clock(user
->writer
, clock
);
505 ret
= bt_ctf_stream_class_set_clock(user
->sc
, clock
);
507 BT_OBJECT_PUT_REF_AND_RESET(clock
);
508 user
->stream
= bt_ctf_writer_create_stream(user
->writer
, user
->sc
);
509 BT_ASSERT(user
->stream
);
510 user
->ec
= bt_ctf_event_class_create("ec");
512 ft
= create_writer_integer_struct();
514 ret
= bt_ctf_event_class_set_payload_field_type(user
->ec
, ft
);
515 BT_OBJECT_PUT_REF_AND_RESET(ft
);
517 ret
= bt_ctf_stream_class_add_event_class(user
->sc
, user
->ec
);
519 user
->event
= bt_ctf_event_create(user
->ec
);
520 BT_ASSERT(user
->event
);
521 field
= bt_ctf_event_get_payload(user
->event
, "payload_8");
523 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 10);
525 BT_OBJECT_PUT_REF_AND_RESET(field
);
526 field
= bt_ctf_event_get_payload(user
->event
, "payload_16");
528 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 20);
530 BT_OBJECT_PUT_REF_AND_RESET(field
);
531 field
= bt_ctf_event_get_payload(user
->event
, "payload_32");
533 ret
= bt_ctf_field_integer_unsigned_set_value(field
, 30);
535 BT_OBJECT_PUT_REF_AND_RESET(field
);
536 ret
= bt_ctf_stream_append_event(user
->stream
, user
->event
);
538 recursive_rmdir(trace_path
);
542 static void test_put_order_swap(size_t *array
, size_t a
, size_t b
)
544 size_t temp
= array
[a
];
550 static void test_put_order_put_objects(size_t *array
, size_t size
)
553 struct writer_user user
= { 0 };
554 void **objects
= (void *) &user
;
556 create_writer_user_full(&user
);
559 for (i
= 0; i
< size
; ++i
) {
560 void *obj
= objects
[array
[i
]];
562 printf("%s", writer_user_names
[array
[i
]]);
563 BT_OBJECT_PUT_REF_AND_RESET(obj
);
573 static void test_put_order_permute(size_t *array
, int k
, size_t size
)
576 test_put_order_put_objects(array
, size
);
580 for (i
= k
- 1; i
>= 0; i
--) {
581 size_t next_k
= k
- 1;
583 test_put_order_swap(array
, i
, next_k
);
584 test_put_order_permute(array
, next_k
, size
);
585 test_put_order_swap(array
, i
, next_k
);
590 static void test_put_order(void)
593 size_t array
[WRITER_USER_NR_ELEMENTS
];
595 /* Initialize array of indexes */
596 for (i
= 0; i
< WRITER_USER_NR_ELEMENTS
; ++i
) {
600 test_put_order_permute(array
, WRITER_USER_NR_ELEMENTS
,
601 WRITER_USER_NR_ELEMENTS
);
605 * The objective of this test is to implement and expand upon the scenario
606 * described in the reference counting documentation and ensure that any node of
607 * the Trace, Stream Class, Event Class, Stream and Event hiearchy keeps all
608 * other "alive" and reachable.
610 * External tools (e.g. valgrind) should be used to confirm that this
611 * known-good test does not leak memory.
613 int main(int argc
, char **argv
)
615 /* Initialize tap harness before any tests */
616 plan_tests(NR_TESTS
);
618 test_example_scenario_in_graph();
621 return exit_status();