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.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 struct bt_ctf_stream_class *create_sc1(void)
 214 {
 215         int ret;
 216         struct bt_ctf_event_class *ec1 = NULL, *ec2 = NULL;
 217         struct bt_ctf_stream_class *sc1 = NULL, *ret_stream = NULL;
 218
 219         sc1 = bt_ctf_stream_class_create("sc1");
 220         if (!sc1) {
 221                 diag("Failed to create Stream Class");
 222                 goto error;
 223         }
 224
 225         ec1 = create_complex_event("ec1");
 226         if (!ec1) {
 227                 diag("Failed to create complex event EC1");
 228                 goto error;
 229         }
 230         ret = bt_ctf_stream_class_add_event_class(sc1, ec1);
 231         if (ret) {
 232                 diag("Failed to add EC1 to SC1");
 233                 goto error;
 234         }
 235
 236         ec2 = create_simple_event("ec2");
 237         if (!ec2) {
 238                 diag("Failed to create simple event EC2");
 239                 goto error;
 240         }
 241         ret = bt_ctf_stream_class_add_event_class(sc1, ec2);
 242         if (ret) {
 243                 diag("Failed to add EC1 to SC1");
 244                 goto error;
 245         }
 246
 247         ret_stream = bt_ctf_event_class_get_stream_class(ec1);
 248         ok(ret_stream == sc1, "Get parent stream SC1 from EC1");
 249         BT_PUT(ret_stream);
 250
 251         ret_stream = bt_ctf_event_class_get_stream_class(ec2);
 252         ok(ret_stream == sc1, "Get parent stream SC1 from EC2");
 253 end:
 254         BT_PUT(ret_stream);
 255         BT_PUT(ec1);
 256         BT_PUT(ec2);
 257         return sc1;
 258 error:
 259         BT_PUT(sc1);
 260         goto end;
 261 }
 262
 263 static struct bt_ctf_stream_class *create_sc2(void)
 264 {
 265         int ret;
 266         struct bt_ctf_event_class *ec3 = NULL;
 267         struct bt_ctf_stream_class *sc2 = NULL, *ret_stream = NULL;
 268
 269         sc2 = bt_ctf_stream_class_create("sc2");
 270         if (!sc2) {
 271                 diag("Failed to create Stream Class");
 272                 goto error;
 273         }
 274
 275         ec3 = create_simple_event("ec3");
 276         if (!ec3) {
 277                 diag("Failed to create simple event EC3");
 278                 goto error;
 279         }
 280         ret = bt_ctf_stream_class_add_event_class(sc2, ec3);
 281         if (ret) {
 282                 diag("Failed to add EC3 to SC2");
 283                 goto error;
 284         }
 285
 286         ret_stream = bt_ctf_event_class_get_stream_class(ec3);
 287         ok(ret_stream == sc2, "Get parent stream SC2 from EC3");
 288 end:
 289         BT_PUT(ret_stream);
 290         BT_PUT(ec3);
 291         return sc2;
 292 error:
 293         BT_PUT(sc2);
 294         goto end;
 295 }
 296
 297 static struct bt_ctf_trace *create_tc1(void)
 298 {
 299         int ret;
 300         struct bt_ctf_trace *tc1 = NULL;
 301         struct bt_ctf_stream_class *sc1 = NULL, *sc2 = NULL;
 302
 303         tc1 = bt_ctf_trace_create();
 304         if (!tc1) {
 305                 diag("bt_ctf_trace_create returned NULL");
 306                 goto error;
 307         }
 308
 309         sc1 = create_sc1();
 310         ok(sc1, "Create SC1");
 311         if (!sc1) {
 312                 goto error;
 313         }
 314         ret = bt_ctf_trace_add_stream_class(tc1, sc1);
 315         ok(!ret, "Add SC1 to TC1");
 316         if (ret) {
 317                 goto error;
 318         }
 319
 320         sc2 = create_sc2();
 321         ok(sc2, "Create SC2");
 322         if (!sc2) {
 323                 goto error;
 324         }
 325         ret = bt_ctf_trace_add_stream_class(tc1, sc2);
 326         ok(!ret, "Add SC2 to TC1");
 327         if (ret) {
 328                 goto error;
 329         }
 330 end:
 331         BT_PUT(sc1);
 332         BT_PUT(sc2);
 333         return tc1;
 334 error:
 335         BT_PUT(tc1);
 336         goto end;
 337 }
 338
 339 static void init_weak_refs(struct bt_ctf_trace *tc,
 340                 struct bt_ctf_trace **tc1,
 341                 struct bt_ctf_stream_class **sc1,
 342                 struct bt_ctf_stream_class **sc2,
 343                 struct bt_ctf_event_class **ec1,
 344                 struct bt_ctf_event_class **ec2,
 345                 struct bt_ctf_event_class **ec3)
 346 {
 347         *tc1 = tc;
 348         *sc1 = bt_ctf_trace_get_stream_class(tc, 0);
 349         *sc2 = bt_ctf_trace_get_stream_class(tc, 1);
 350         *ec1 = bt_ctf_stream_class_get_event_class(*sc1, 0);
 351         *ec2 = bt_ctf_stream_class_get_event_class(*sc1, 1);
 352         *ec3 = bt_ctf_stream_class_get_event_class(*sc2, 0);
 353         bt_put(*sc1);
 354         bt_put(*sc2);
 355         bt_put(*ec1);
 356         bt_put(*ec2);
 357         bt_put(*ec3);
 358 }
 359
 360 static void test_example_scenario(void)
 361 {
 362         /**
 363          * Weak pointers to CTF-IR objects are to be used very carefully.
 364          * This is NOT a good practice and is strongly discouraged; this
 365          * is only done to facilitate the validation of expected reference
 366          * counts without affecting them by taking "real" references to the
 367          * objects.
 368          */
 369         struct bt_ctf_trace *tc1 = NULL, *weak_tc1 = NULL;
 370         struct bt_ctf_stream_class *weak_sc1 = NULL, *weak_sc2 = NULL;
 371         struct bt_ctf_event_class *weak_ec1 = NULL, *weak_ec2 = NULL,
 372                         *weak_ec3 = NULL;
 373         struct user user_a = { 0 }, user_b = { 0 }, user_c = { 0 };
 374
 375         /* The only reference which exists at this point is on TC1. */
 376         tc1 = create_tc1();
 377         ok(tc1, "Initialize trace");
 378         if (!tc1) {
 379                 return;
 380         }
 381
 382         init_weak_refs(tc1, &weak_tc1, &weak_sc1, &weak_sc2, &weak_ec1,
 383                         &weak_ec2, &weak_ec3);
 384
 385         ok(bt_object_get_ref_count(weak_sc1) == 0,
 386                         "Initial SC1 reference count is 0");
 387         ok(bt_object_get_ref_count(weak_sc2) == 0,
 388                         "Initial SC2 reference count is 0");
 389         ok(bt_object_get_ref_count(weak_ec1) == 0,
 390                         "Initial EC1 reference count is 0");
 391         ok(bt_object_get_ref_count(weak_ec2) == 0,
 392                         "Initial EC2 reference count is 0");
 393         ok(bt_object_get_ref_count(weak_ec3) == 0,
 394                         "Initial EC3 reference count is 0");
 395
 396         /* User A has ownership of the trace. */
 397         BT_MOVE(user_a.tc, tc1);
 398         ok(bt_object_get_ref_count(user_a.tc) == 1,
 399                         "TC1 reference count is 1");
 400
 401         /* User A acquires a reference to SC2 from TC1. */
 402         user_a.sc = bt_ctf_trace_get_stream_class(user_a.tc, 1);
 403         ok(user_a.sc, "User A acquires SC2 from TC1");
 404         ok(bt_object_get_ref_count(weak_tc1) == 2,
 405                         "TC1 reference count is 2");
 406         ok(bt_object_get_ref_count(weak_sc2) == 1,
 407                         "SC2 reference count is 1");
 408
 409         /* User A acquires a reference to EC3 from SC2. */
 410         user_a.ec = bt_ctf_stream_class_get_event_class(user_a.sc, 0);
 411         ok(user_a.ec, "User A acquires EC3 from SC2");
 412         ok(bt_object_get_ref_count(weak_tc1) == 2,
 413                         "TC1 reference count is 2");
 414         ok(bt_object_get_ref_count(weak_sc2) == 2,
 415                         "SC2 reference count is 2");
 416         ok(bt_object_get_ref_count(weak_ec3) == 1,
 417                         "EC3 reference count is 1");
 418
 419         /* User A releases its reference to SC2. */
 420         diag("User A releases SC2");
 421         BT_PUT(user_a.sc);
 422         /*
 423          * We keep the pointer to SC2 around to validate its reference
 424          * count.
 425          */
 426         ok(bt_object_get_ref_count(weak_tc1) == 2,
 427                         "TC1 reference count is 2");
 428         ok(bt_object_get_ref_count(weak_sc2) == 1,
 429                         "SC2 reference count is 1");
 430         ok(bt_object_get_ref_count(weak_ec3) == 1,
 431                         "EC3 reference count is 1");
 432
 433         /* User A releases its reference to TC1. */
 434         diag("User A releases TC1");
 435         BT_PUT(user_a.tc);
 436         /*
 437          * We keep the pointer to TC1 around to validate its reference
 438          * count.
 439          */
 440         ok(bt_object_get_ref_count(weak_tc1) == 1,
 441                         "TC1 reference count is 1");
 442         ok(bt_object_get_ref_count(weak_sc2) == 1,
 443                         "SC2 reference count is 1");
 444         ok(bt_object_get_ref_count(weak_ec3) == 1,
 445                         "EC3 reference count is 1");
 446
 447         /* User B acquires a reference to SC1. */
 448         diag("User B acquires a reference to SC1");
 449         user_b.sc = bt_get(weak_sc1);
 450         ok(bt_object_get_ref_count(weak_tc1) == 2,
 451                         "TC1 reference count is 2");
 452         ok(bt_object_get_ref_count(weak_sc1) == 1,
 453                         "SC1 reference count is 1");
 454
 455         /* User C acquires a reference to EC1. */
 456         diag("User C acquires a reference to EC1");
 457         user_c.ec = bt_ctf_stream_class_get_event_class(user_b.sc, 0);
 458         ok(bt_object_get_ref_count(weak_ec1) == 1,
 459                         "EC1 reference count is 1");
 460         ok(bt_object_get_ref_count(weak_sc1) == 2,
 461                         "SC1 reference count is 2");
 462
 463         /* User A releases its reference on EC3. */
 464         diag("User A releases its reference on EC3");
 465         BT_PUT(user_a.ec);
 466         ok(bt_object_get_ref_count(weak_ec3) == 0,
 467                         "EC3 reference count is 1");
 468         ok(bt_object_get_ref_count(weak_sc2) == 0,
 469                         "SC2 reference count is 0");
 470         ok(bt_object_get_ref_count(weak_tc1) == 1,
 471                         "TC1 reference count is 1");
 472
 473         /* User B releases its reference on SC1. */
 474         diag("User B releases its reference on SC1");
 475         BT_PUT(user_b.sc);
 476         ok(bt_object_get_ref_count(weak_sc1) == 1,
 477                         "SC1 reference count is 1");
 478
 479         /*
 480          * User C is the sole owner of an object and is keeping the whole
 481          * trace hierarchy "alive" by holding a reference to EC1.
 482          */
 483         ok(bt_object_get_ref_count(weak_tc1) == 1,
 484                         "TC1 reference count is 1");
 485         ok(bt_object_get_ref_count(weak_sc1) == 1,
 486                         "SC1 reference count is 1");
 487         ok(bt_object_get_ref_count(weak_sc2) == 0,
 488                         "SC2 reference count is 0");
 489         ok(bt_object_get_ref_count(weak_ec1) == 1,
 490                         "EC1 reference count is 1");
 491         ok(bt_object_get_ref_count(weak_ec2) == 0,
 492                         "EC2 reference count is 0");
 493         ok(bt_object_get_ref_count(weak_ec3) == 0,
 494                         "EC3 reference count is 0");
 495
 496         /* Reclaim last reference held by User C. */
 497         BT_PUT(user_c.ec);
 498 }
 499
 500 static void create_user_full(struct user *user)
 501 {
 502         char trace_path[] = "/tmp/ctfwriter_XXXXXX";
 503         struct bt_ctf_field_type *ft;
 504         struct bt_ctf_field *field;
 505         struct bt_ctf_clock *clock;
 506         int ret;
 507
 508         if (!bt_mkdtemp(trace_path)) {
 509                 perror("# perror");
 510         }
 511
 512         user->writer = bt_ctf_writer_create(trace_path);
 513         assert(user->writer);
 514         ret = bt_ctf_writer_set_byte_order(user->writer,
 515                 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN);
 516         assert(ret == 0);
 517         user->tc = bt_ctf_writer_get_trace(user->writer);
 518         assert(user->tc);
 519         user->sc = bt_ctf_stream_class_create("sc");
 520         assert(user->sc);
 521         clock = bt_ctf_clock_create("the_clock");
 522         assert(clock);
 523         ret = bt_ctf_writer_add_clock(user->writer, clock);
 524         assert(!ret);
 525         ret = bt_ctf_stream_class_set_clock(user->sc, clock);
 526         assert(!ret);
 527         BT_PUT(clock);
 528         user->stream = bt_ctf_writer_create_stream(user->writer, user->sc);
 529         assert(user->stream);
 530         user->ec = bt_ctf_event_class_create("ec");
 531         assert(user->ec);
 532         ft = create_integer_struct();
 533         assert(ft);
 534         ret = bt_ctf_event_class_set_payload_type(user->ec, ft);
 535         BT_PUT(ft);
 536         assert(!ret);
 537         ret = bt_ctf_stream_class_add_event_class(user->sc, user->ec);
 538         assert(!ret);
 539         user->event = bt_ctf_event_create(user->ec);
 540         assert(user->event);
 541         field = bt_ctf_event_get_payload(user->event, "payload_8");
 542         assert(field);
 543         ret = bt_ctf_field_unsigned_integer_set_value(field, 10);
 544         assert(!ret);
 545         BT_PUT(field);
 546         field = bt_ctf_event_get_payload(user->event, "payload_16");
 547         assert(field);
 548         ret = bt_ctf_field_unsigned_integer_set_value(field, 20);
 549         assert(!ret);
 550         BT_PUT(field);
 551         field = bt_ctf_event_get_payload(user->event, "payload_32");
 552         assert(field);
 553         ret = bt_ctf_field_unsigned_integer_set_value(field, 30);
 554         assert(!ret);
 555         BT_PUT(field);
 556         ret = bt_ctf_stream_append_event(user->stream, user->event);
 557         assert(!ret);
 558         recursive_rmdir(trace_path);
 559 }
 560
 561 static void test_put_order_swap(size_t *array, size_t a, size_t b)
 562 {
 563         size_t temp = array[a];
 564
 565         array[a] = array[b];
 566         array[b] = temp;
 567 }
 568
 569 static void test_put_order_put_objects(size_t *array, size_t size)
 570 {
 571         size_t i;
 572         struct user user = { 0 };
 573         void **objects = (void *) &user;
 574
 575         create_user_full(&user);
 576         printf("# ");
 577
 578         for (i = 0; i < size; ++i) {
 579                 void *obj = objects[array[i]];
 580
 581                 printf("%s", user_names[array[i]]);
 582                 BT_PUT(obj);
 583
 584                 if (i < size - 1) {
 585                         printf(" -> ");
 586                 }
 587         }
 588
 589         puts("");
 590 }
 591
 592 static void test_put_order_permute(size_t *array, int k, size_t size)
 593 {
 594         if (k == 0) {
 595                 test_put_order_put_objects(array, size);
 596         } else {
 597                 int i;
 598
 599                 for (i = k - 1; i >= 0; i--) {
 600                         size_t next_k = k - 1;
 601
 602                         test_put_order_swap(array, i, next_k);
 603                         test_put_order_permute(array, next_k, size);
 604                         test_put_order_swap(array, i, next_k);
 605                 }
 606         }
 607 }
 608
 609 static void test_put_order(void)
 610 {
 611         size_t i;
 612         size_t array[USER_NR_ELEMENTS];
 613
 614         /* Initialize array of indexes */
 615         for (i = 0; i < USER_NR_ELEMENTS; ++i) {
 616                 array[i] = i;
 617         }
 618
 619         test_put_order_permute(array, USER_NR_ELEMENTS, USER_NR_ELEMENTS);
 620 }
 621
 622 /**
 623  * The objective of this test is to implement and expand upon the scenario
 624  * described in the reference counting documentation and ensure that any node of
 625  * the Trace, Stream Class, Event Class, Stream and Event hiearchy keeps all
 626  * other "alive" and reachable.
 627  *
 628  * External tools (e.g. valgrind) should be used to confirm that this
 629  * known-good test does not leak memory.
 630  */
 631 int main(int argc, char **argv)
 632 {
 633         /* Initialize tap harness before any tests */
 634         plan_tests(NR_TESTS);
 635
 636         test_example_scenario();
 637         test_put_order();
 638
 639         return exit_status();
 640 }