tests/lib/test_ctf_ir_ref.c

   1 /*
   2  * test_ctf_ir_ref.c
   3  *
   4  * CTF IR Reference Count test
   5  *
   6  * Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21
  22 #include "tap/tap.h"
  23 #include <babeltrace/ctf-writer/writer.h>
  24 #include <babeltrace/ctf-writer/stream.h>
  25 #include <babeltrace/ctf-writer/clock.h>
  26 #include <babeltrace/ctf-ir/trace.h>
  27 #include <babeltrace/ctf-writer/stream-class.h>
  28 #include <babeltrace/ctf-ir/stream.h>
  29 #include <babeltrace/ctf-ir/fields.h>
  30 #include <babeltrace/ctf-ir/event.h>
  31 #include <babeltrace/ctf-ir/event-class.h>
  32 #include <babeltrace/object-internal.h>
  33 #include <babeltrace/compat/stdlib-internal.h>
  34 #include <assert.h>
  35 #include "common.h"
  36
  37 #define NR_TESTS 41
  38
  39 struct user {
  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;
  46 };
  47
  48 const char *user_names[] = {
  49         "writer",
  50         "trace",
  51         "stream class",
  52         "event class",
  53         "stream",
  54         "event",
  55 };
  56
  57 static const size_t USER_NR_ELEMENTS = sizeof(struct user) / sizeof(void *);
  58
  59 /**
  60  * Returns a structure containing the following fields:
  61  *     - uint8_t payload_8;
  62  *     - uint16_t payload_16;
  63  *     - uint32_t payload_32;
  64  */
  65 static struct bt_ctf_field_type *create_integer_struct(void)
  66 {
  67         int ret;
  68         struct bt_ctf_field_type *structure = NULL;
  69         struct bt_ctf_field_type *ui8 = NULL, *ui16 = NULL, *ui32 = NULL;
  70
  71         structure = bt_ctf_field_type_structure_create();
  72         if (!structure) {
  73                 goto error;
  74         }
  75
  76         ui8 = bt_ctf_field_type_integer_create(8);
  77         if (!ui8) {
  78                 diag("Failed to create uint8_t type");
  79                 goto error;
  80         }
  81         ret = bt_ctf_field_type_structure_add_field(structure, ui8,
  82                         "payload_8");
  83         if (ret) {
  84                 diag("Failed to add uint8_t to structure");
  85                 goto error;
  86         }
  87         ui16 = bt_ctf_field_type_integer_create(16);
  88         if (!ui16) {
  89                 diag("Failed to create uint16_t type");
  90                 goto error;
  91         }
  92         ret = bt_ctf_field_type_structure_add_field(structure, ui16,
  93                         "payload_16");
  94         if (ret) {
  95                 diag("Failed to add uint16_t to structure");
  96                 goto error;
  97         }
  98         ui32 = bt_ctf_field_type_integer_create(32);
  99         if (!ui32) {
 100                 diag("Failed to create uint32_t type");
 101                 goto error;
 102         }
 103         ret = bt_ctf_field_type_structure_add_field(structure, ui32,
 104                         "payload_32");
 105         if (ret) {
 106                 diag("Failed to add uint32_t to structure");
 107                 goto error;
 108         }
 109 end:
 110         BT_PUT(ui8);
 111         BT_PUT(ui16);
 112         BT_PUT(ui32);
 113         return structure;
 114 error:
 115         BT_PUT(structure);
 116         goto end;
 117 }
 118
 119 /**
 120  * A simple event has the following payload:
 121  *     - uint8_t payload_8;
 122  *     - uint16_t payload_16;
 123  *     - uint32_t payload_32;
 124  */
 125 static struct bt_ctf_event_class *create_simple_event(const char *name)
 126 {
 127         int ret;
 128         struct bt_ctf_event_class *event = NULL;
 129         struct bt_ctf_field_type *payload = NULL;
 130
 131         assert(name);
 132         event = bt_ctf_event_class_create(name);
 133         if (!event) {
 134                 diag("Failed to create simple event");
 135                 goto error;
 136         }
 137
 138         payload = create_integer_struct();
 139         if (!payload) {
 140                 diag("Failed to initialize integer structure");
 141                 goto error;
 142         }
 143
 144         ret = bt_ctf_event_class_set_payload_type(event, payload);
 145         if (ret) {
 146                 diag("Failed to set simple event payload");
 147                 goto error;
 148         }
 149 end:
 150         BT_PUT(payload);
 151         return event;
 152 error:
 153         BT_PUT(event);
 154         goto end;;
 155 }
 156
 157 /**
 158  * A complex event has the following payload:
 159  *     - uint8_t payload_8;
 160  *     - uint16_t payload_16;
 161  *     - uint32_t payload_32;
 162  *     - struct payload_struct:
 163  *           - uint8_t payload_8;
 164  *           - uint16_t payload_16;
 165  *           - uint32_t payload_32;
 166  */
 167 static struct bt_ctf_event_class *create_complex_event(const char *name)
 168 {
 169         int ret;
 170         struct bt_ctf_event_class *event = NULL;
 171         struct bt_ctf_field_type *inner = NULL, *outer = NULL;
 172
 173         assert(name);
 174         event = bt_ctf_event_class_create(name);
 175         if (!event) {
 176                 diag("Failed to create complex event");
 177                 goto error;
 178         }
 179
 180         outer = create_integer_struct();
 181         if (!outer) {
 182                 diag("Failed to initialize integer structure");
 183                 goto error;
 184         }
 185
 186         inner = create_integer_struct();
 187         if (!inner) {
 188                 diag("Failed to initialize integer structure");
 189                 goto error;
 190         }
 191
 192         ret = bt_ctf_field_type_structure_add_field(outer, inner,
 193                         "payload_struct");
 194         if (ret) {
 195                 diag("Failed to add inner structure to outer structure");
 196                 goto error;
 197         }
 198
 199         ret = bt_ctf_event_class_set_payload_type(event, outer);
 200         if (ret) {
 201                 diag("Failed to set complex event payload");
 202                 goto error;
 203         }
 204 end:
 205         BT_PUT(inner);
 206         BT_PUT(outer);
 207         return event;
 208 error:
 209         BT_PUT(event);
 210         goto end;;
 211 }
 212
 213 static void set_stream_class_field_types(
 214                 struct bt_ctf_stream_class *stream_class)
 215 {
 216         struct bt_ctf_field_type *packet_context_type;
 217         struct bt_ctf_field_type *event_header_type;
 218         struct bt_ctf_field_type *ft;
 219         int ret;
 220
 221         packet_context_type = bt_ctf_field_type_structure_create();
 222         assert(packet_context_type);
 223         ft = bt_ctf_field_type_integer_create(32);
 224         assert(ft);
 225         ret = bt_ctf_field_type_structure_add_field(packet_context_type,
 226                 ft, "packet_size");
 227         assert(ret == 0);
 228         bt_put(ft);
 229         ft = bt_ctf_field_type_integer_create(32);
 230         assert(ft);
 231         ret = bt_ctf_field_type_structure_add_field(packet_context_type,
 232                 ft, "content_size");
 233         assert(ret == 0);
 234         bt_put(ft);
 235
 236         event_header_type = bt_ctf_field_type_structure_create();
 237         assert(event_header_type);
 238         ft = bt_ctf_field_type_integer_create(32);
 239         assert(ft);
 240         ret = bt_ctf_field_type_structure_add_field(event_header_type,
 241                 ft, "id");
 242         assert(ret == 0);
 243         bt_put(ft);
 244
 245         ret = bt_ctf_stream_class_set_packet_context_type(stream_class,
 246                 packet_context_type);
 247         assert(ret == 0);
 248         ret = bt_ctf_stream_class_set_event_header_type(stream_class,
 249                 event_header_type);
 250         assert(ret == 0);
 251
 252         bt_put(packet_context_type);
 253         bt_put(event_header_type);
 254 }
 255
 256 static struct bt_ctf_stream_class *create_sc1(void)
 257 {
 258         int ret;
 259         struct bt_ctf_event_class *ec1 = NULL, *ec2 = NULL;
 260         struct bt_ctf_stream_class *sc1 = NULL, *ret_stream = NULL;
 261
 262         sc1 = bt_ctf_stream_class_create_empty("sc1");
 263         if (!sc1) {
 264                 diag("Failed to create Stream Class");
 265                 goto error;
 266         }
 267
 268         set_stream_class_field_types(sc1);
 269         ec1 = create_complex_event("ec1");
 270         if (!ec1) {
 271                 diag("Failed to create complex event EC1");
 272                 goto error;
 273         }
 274         ret = bt_ctf_stream_class_add_event_class(sc1, ec1);
 275         if (ret) {
 276                 diag("Failed to add EC1 to SC1");
 277                 goto error;
 278         }
 279
 280         ec2 = create_simple_event("ec2");
 281         if (!ec2) {
 282                 diag("Failed to create simple event EC2");
 283                 goto error;
 284         }
 285         ret = bt_ctf_stream_class_add_event_class(sc1, ec2);
 286         if (ret) {
 287                 diag("Failed to add EC1 to SC1");
 288                 goto error;
 289         }
 290
 291         ret_stream = bt_ctf_event_class_get_stream_class(ec1);
 292         ok(ret_stream == sc1, "Get parent stream SC1 from EC1");
 293         BT_PUT(ret_stream);
 294
 295         ret_stream = bt_ctf_event_class_get_stream_class(ec2);
 296         ok(ret_stream == sc1, "Get parent stream SC1 from EC2");
 297 end:
 298         BT_PUT(ret_stream);
 299         BT_PUT(ec1);
 300         BT_PUT(ec2);
 301         return sc1;
 302 error:
 303         BT_PUT(sc1);
 304         goto end;
 305 }
 306
 307 static struct bt_ctf_stream_class *create_sc2(void)
 308 {
 309         int ret;
 310         struct bt_ctf_event_class *ec3 = NULL;
 311         struct bt_ctf_stream_class *sc2 = NULL, *ret_stream = NULL;
 312
 313         sc2 = bt_ctf_stream_class_create_empty("sc2");
 314         if (!sc2) {
 315                 diag("Failed to create Stream Class");
 316                 goto error;
 317         }
 318
 319         set_stream_class_field_types(sc2);
 320         ec3 = create_simple_event("ec3");
 321         if (!ec3) {
 322                 diag("Failed to create simple event EC3");
 323                 goto error;
 324         }
 325         ret = bt_ctf_stream_class_add_event_class(sc2, ec3);
 326         if (ret) {
 327                 diag("Failed to add EC3 to SC2");
 328                 goto error;
 329         }
 330
 331         ret_stream = bt_ctf_event_class_get_stream_class(ec3);
 332         ok(ret_stream == sc2, "Get parent stream SC2 from EC3");
 333 end:
 334         BT_PUT(ret_stream);
 335         BT_PUT(ec3);
 336         return sc2;
 337 error:
 338         BT_PUT(sc2);
 339         goto end;
 340 }
 341
 342 static void set_trace_packet_header(struct bt_ctf_trace *trace)
 343 {
 344         struct bt_ctf_field_type *packet_header_type;
 345         struct bt_ctf_field_type *ft;
 346         int ret;
 347
 348         packet_header_type = bt_ctf_field_type_structure_create();
 349         assert(packet_header_type);
 350         ft = bt_ctf_field_type_integer_create(32);
 351         assert(ft);
 352         ret = bt_ctf_field_type_structure_add_field(packet_header_type,
 353                 ft, "stream_id");
 354         assert(ret == 0);
 355         bt_put(ft);
 356
 357         ret = bt_ctf_trace_set_packet_header_type(trace,
 358                 packet_header_type);
 359         assert(ret == 0);
 360
 361         bt_put(packet_header_type);
 362 }
 363
 364 static struct bt_ctf_trace *create_tc1(void)
 365 {
 366         int ret;
 367         struct bt_ctf_trace *tc1 = NULL;
 368         struct bt_ctf_stream_class *sc1 = NULL, *sc2 = NULL;
 369
 370         tc1 = bt_ctf_trace_create();
 371         if (!tc1) {
 372                 diag("bt_ctf_trace_create returned NULL");
 373                 goto error;
 374         }
 375
 376         set_trace_packet_header(tc1);
 377         ret = bt_ctf_trace_set_native_byte_order(tc1,
 378                 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN);
 379         assert(ret == 0);
 380         sc1 = create_sc1();
 381         ok(sc1, "Create SC1");
 382         if (!sc1) {
 383                 goto error;
 384         }
 385         ret = bt_ctf_trace_add_stream_class(tc1, sc1);
 386         ok(!ret, "Add SC1 to TC1");
 387         if (ret) {
 388                 goto error;
 389         }
 390
 391         sc2 = create_sc2();
 392         ok(sc2, "Create SC2");
 393         if (!sc2) {
 394                 goto error;
 395         }
 396         ret = bt_ctf_trace_add_stream_class(tc1, sc2);
 397         ok(!ret, "Add SC2 to TC1");
 398         if (ret) {
 399                 goto error;
 400         }
 401 end:
 402         BT_PUT(sc1);
 403         BT_PUT(sc2);
 404         return tc1;
 405 error:
 406         BT_PUT(tc1);
 407         goto end;
 408 }
 409
 410 static void init_weak_refs(struct bt_ctf_trace *tc,
 411                 struct bt_ctf_trace **tc1,
 412                 struct bt_ctf_stream_class **sc1,
 413                 struct bt_ctf_stream_class **sc2,
 414                 struct bt_ctf_event_class **ec1,
 415                 struct bt_ctf_event_class **ec2,
 416                 struct bt_ctf_event_class **ec3)
 417 {
 418         *tc1 = tc;
 419         *sc1 = bt_ctf_trace_get_stream_class_by_index(tc, 0);
 420         *sc2 = bt_ctf_trace_get_stream_class_by_index(tc, 1);
 421         *ec1 = bt_ctf_stream_class_get_event_class_by_index(*sc1, 0);
 422         *ec2 = bt_ctf_stream_class_get_event_class_by_index(*sc1, 1);
 423         *ec3 = bt_ctf_stream_class_get_event_class_by_index(*sc2, 0);
 424         bt_put(*sc1);
 425         bt_put(*sc2);
 426         bt_put(*ec1);
 427         bt_put(*ec2);
 428         bt_put(*ec3);
 429 }
 430
 431 static void test_example_scenario(void)
 432 {
 433         /**
 434          * Weak pointers to CTF-IR objects are to be used very carefully.
 435          * This is NOT a good practice and is strongly discouraged; this
 436          * is only done to facilitate the validation of expected reference
 437          * counts without affecting them by taking "real" references to the
 438          * objects.
 439          */
 440         struct bt_ctf_trace *tc1 = NULL, *weak_tc1 = NULL;
 441         struct bt_ctf_stream_class *weak_sc1 = NULL, *weak_sc2 = NULL;
 442         struct bt_ctf_event_class *weak_ec1 = NULL, *weak_ec2 = NULL,
 443                         *weak_ec3 = NULL;
 444         struct user user_a = { 0 }, user_b = { 0 }, user_c = { 0 };
 445
 446         /* The only reference which exists at this point is on TC1. */
 447         tc1 = create_tc1();
 448         ok(tc1, "Initialize trace");
 449         if (!tc1) {
 450                 return;
 451         }
 452
 453         init_weak_refs(tc1, &weak_tc1, &weak_sc1, &weak_sc2, &weak_ec1,
 454                         &weak_ec2, &weak_ec3);
 455
 456         ok(bt_object_get_ref_count(weak_sc1) == 0,
 457                         "Initial SC1 reference count is 0");
 458         ok(bt_object_get_ref_count(weak_sc2) == 0,
 459                         "Initial SC2 reference count is 0");
 460         ok(bt_object_get_ref_count(weak_ec1) == 0,
 461                         "Initial EC1 reference count is 0");
 462         ok(bt_object_get_ref_count(weak_ec2) == 0,
 463                         "Initial EC2 reference count is 0");
 464         ok(bt_object_get_ref_count(weak_ec3) == 0,
 465                         "Initial EC3 reference count is 0");
 466
 467         /* User A has ownership of the trace. */
 468         BT_MOVE(user_a.tc, tc1);
 469         ok(bt_object_get_ref_count(user_a.tc) == 1,
 470                         "TC1 reference count is 1");
 471
 472         /* User A acquires a reference to SC2 from TC1. */
 473         user_a.sc = bt_ctf_trace_get_stream_class_by_index(user_a.tc, 1);
 474         ok(user_a.sc, "User A acquires SC2 from TC1");
 475         ok(bt_object_get_ref_count(weak_tc1) == 2,
 476                         "TC1 reference count is 2");
 477         ok(bt_object_get_ref_count(weak_sc2) == 1,
 478                         "SC2 reference count is 1");
 479
 480         /* User A acquires a reference to EC3 from SC2. */
 481         user_a.ec = bt_ctf_stream_class_get_event_class_by_index(user_a.sc, 0);
 482         ok(user_a.ec, "User A acquires EC3 from SC2");
 483         ok(bt_object_get_ref_count(weak_tc1) == 2,
 484                         "TC1 reference count is 2");
 485         ok(bt_object_get_ref_count(weak_sc2) == 2,
 486                         "SC2 reference count is 2");
 487         ok(bt_object_get_ref_count(weak_ec3) == 1,
 488                         "EC3 reference count is 1");
 489
 490         /* User A releases its reference to SC2. */
 491         diag("User A releases SC2");
 492         BT_PUT(user_a.sc);
 493         /*
 494          * We keep the pointer to SC2 around to validate its reference
 495          * count.
 496          */
 497         ok(bt_object_get_ref_count(weak_tc1) == 2,
 498                         "TC1 reference count is 2");
 499         ok(bt_object_get_ref_count(weak_sc2) == 1,
 500                         "SC2 reference count is 1");
 501         ok(bt_object_get_ref_count(weak_ec3) == 1,
 502                         "EC3 reference count is 1");
 503
 504         /* User A releases its reference to TC1. */
 505         diag("User A releases TC1");
 506         BT_PUT(user_a.tc);
 507         /*
 508          * We keep the pointer to TC1 around to validate its reference
 509          * count.
 510          */
 511         ok(bt_object_get_ref_count(weak_tc1) == 1,
 512                         "TC1 reference count is 1");
 513         ok(bt_object_get_ref_count(weak_sc2) == 1,
 514                         "SC2 reference count is 1");
 515         ok(bt_object_get_ref_count(weak_ec3) == 1,
 516                         "EC3 reference count is 1");
 517
 518         /* User B acquires a reference to SC1. */
 519         diag("User B acquires a reference to SC1");
 520         user_b.sc = bt_get(weak_sc1);
 521         ok(bt_object_get_ref_count(weak_tc1) == 2,
 522                         "TC1 reference count is 2");
 523         ok(bt_object_get_ref_count(weak_sc1) == 1,
 524                         "SC1 reference count is 1");
 525
 526         /* User C acquires a reference to EC1. */
 527         diag("User C acquires a reference to EC1");
 528         user_c.ec = bt_ctf_stream_class_get_event_class_by_index(user_b.sc, 0);
 529         ok(bt_object_get_ref_count(weak_ec1) == 1,
 530                         "EC1 reference count is 1");
 531         ok(bt_object_get_ref_count(weak_sc1) == 2,
 532                         "SC1 reference count is 2");
 533
 534         /* User A releases its reference on EC3. */
 535         diag("User A releases its reference on EC3");
 536         BT_PUT(user_a.ec);
 537         ok(bt_object_get_ref_count(weak_ec3) == 0,
 538                         "EC3 reference count is 1");
 539         ok(bt_object_get_ref_count(weak_sc2) == 0,
 540                         "SC2 reference count is 0");
 541         ok(bt_object_get_ref_count(weak_tc1) == 1,
 542                         "TC1 reference count is 1");
 543
 544         /* User B releases its reference on SC1. */
 545         diag("User B releases its reference on SC1");
 546         BT_PUT(user_b.sc);
 547         ok(bt_object_get_ref_count(weak_sc1) == 1,
 548                         "SC1 reference count is 1");
 549
 550         /*
 551          * User C is the sole owner of an object and is keeping the whole
 552          * trace hierarchy "alive" by holding a reference to EC1.
 553          */
 554         ok(bt_object_get_ref_count(weak_tc1) == 1,
 555                         "TC1 reference count is 1");
 556         ok(bt_object_get_ref_count(weak_sc1) == 1,
 557                         "SC1 reference count is 1");
 558         ok(bt_object_get_ref_count(weak_sc2) == 0,
 559                         "SC2 reference count is 0");
 560         ok(bt_object_get_ref_count(weak_ec1) == 1,
 561                         "EC1 reference count is 1");
 562         ok(bt_object_get_ref_count(weak_ec2) == 0,
 563                         "EC2 reference count is 0");
 564         ok(bt_object_get_ref_count(weak_ec3) == 0,
 565                         "EC3 reference count is 0");
 566
 567         /* Reclaim last reference held by User C. */
 568         BT_PUT(user_c.ec);
 569 }
 570
 571 static void create_user_full(struct user *user)
 572 {
 573         char trace_path[] = "/tmp/ctfwriter_XXXXXX";
 574         struct bt_ctf_field_type *ft;
 575         struct bt_ctf_field *field;
 576         struct bt_ctf_clock *clock;
 577         int ret;
 578
 579         if (!bt_mkdtemp(trace_path)) {
 580                 perror("# perror");
 581         }
 582
 583         user->writer = bt_ctf_writer_create(trace_path);
 584         assert(user->writer);
 585         ret = bt_ctf_writer_set_byte_order(user->writer,
 586                 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN);
 587         assert(ret == 0);
 588         user->tc = bt_ctf_writer_get_trace(user->writer);
 589         assert(user->tc);
 590         user->sc = bt_ctf_stream_class_create("sc");
 591         assert(user->sc);
 592         clock = bt_ctf_clock_create("the_clock");
 593         assert(clock);
 594         ret = bt_ctf_writer_add_clock(user->writer, clock);
 595         assert(!ret);
 596         ret = bt_ctf_stream_class_set_clock(user->sc, clock);
 597         assert(!ret);
 598         BT_PUT(clock);
 599         user->stream = bt_ctf_writer_create_stream(user->writer, user->sc);
 600         assert(user->stream);
 601         user->ec = bt_ctf_event_class_create("ec");
 602         assert(user->ec);
 603         ft = create_integer_struct();
 604         assert(ft);
 605         ret = bt_ctf_event_class_set_payload_type(user->ec, ft);
 606         BT_PUT(ft);
 607         assert(!ret);
 608         ret = bt_ctf_stream_class_add_event_class(user->sc, user->ec);
 609         assert(!ret);
 610         user->event = bt_ctf_event_create(user->ec);
 611         assert(user->event);
 612         field = bt_ctf_event_get_payload(user->event, "payload_8");
 613         assert(field);
 614         ret = bt_ctf_field_unsigned_integer_set_value(field, 10);
 615         assert(!ret);
 616         BT_PUT(field);
 617         field = bt_ctf_event_get_payload(user->event, "payload_16");
 618         assert(field);
 619         ret = bt_ctf_field_unsigned_integer_set_value(field, 20);
 620         assert(!ret);
 621         BT_PUT(field);
 622         field = bt_ctf_event_get_payload(user->event, "payload_32");
 623         assert(field);
 624         ret = bt_ctf_field_unsigned_integer_set_value(field, 30);
 625         assert(!ret);
 626         BT_PUT(field);
 627         ret = bt_ctf_stream_append_event(user->stream, user->event);
 628         assert(!ret);
 629         recursive_rmdir(trace_path);
 630 }
 631
 632 static void test_put_order_swap(size_t *array, size_t a, size_t b)
 633 {
 634         size_t temp = array[a];
 635
 636         array[a] = array[b];
 637         array[b] = temp;
 638 }
 639
 640 static void test_put_order_put_objects(size_t *array, size_t size)
 641 {
 642         size_t i;
 643         struct user user = { 0 };
 644         void **objects = (void *) &user;
 645
 646         create_user_full(&user);
 647         printf("# ");
 648
 649         for (i = 0; i < size; ++i) {
 650                 void *obj = objects[array[i]];
 651
 652                 printf("%s", user_names[array[i]]);
 653                 BT_PUT(obj);
 654
 655                 if (i < size - 1) {
 656                         printf(" -> ");
 657                 }
 658         }
 659
 660         puts("");
 661 }
 662
 663 static void test_put_order_permute(size_t *array, int k, size_t size)
 664 {
 665         if (k == 0) {
 666                 test_put_order_put_objects(array, size);
 667         } else {
 668                 int i;
 669
 670                 for (i = k - 1; i >= 0; i--) {
 671                         size_t next_k = k - 1;
 672
 673                         test_put_order_swap(array, i, next_k);
 674                         test_put_order_permute(array, next_k, size);
 675                         test_put_order_swap(array, i, next_k);
 676                 }
 677         }
 678 }
 679
 680 static void test_put_order(void)
 681 {
 682         size_t i;
 683         size_t array[USER_NR_ELEMENTS];
 684
 685         /* Initialize array of indexes */
 686         for (i = 0; i < USER_NR_ELEMENTS; ++i) {
 687                 array[i] = i;
 688         }
 689
 690         test_put_order_permute(array, USER_NR_ELEMENTS, USER_NR_ELEMENTS);
 691 }
 692
 693 /**
 694  * The objective of this test is to implement and expand upon the scenario
 695  * described in the reference counting documentation and ensure that any node of
 696  * the Trace, Stream Class, Event Class, Stream and Event hiearchy keeps all
 697  * other "alive" and reachable.
 698  *
 699  * External tools (e.g. valgrind) should be used to confirm that this
 700  * known-good test does not leak memory.
 701  */
 702 int main(int argc, char **argv)
 703 {
 704         /* Initialize tap harness before any tests */
 705         plan_tests(NR_TESTS);
 706
 707         test_example_scenario();
 708         test_put_order();
 709
 710         return exit_status();
 711 }