Make API CTF-agnostic
[babeltrace.git] / tests / lib / test_ctf_ir_ref.c
index 01434d4c46ea45fdba614165bd7c007511d5270a..e618a2692b566557e2438597b022a79006187db7 100644 (file)
  */
 
 #include "tap/tap.h"
-#include <babeltrace/ctf-ir/trace.h>
+#include <babeltrace/ctf-writer/clock.h>
+#include <babeltrace/ctf-writer/event.h>
+#include <babeltrace/ctf-writer/fields.h>
+#include <babeltrace/ctf-writer/stream-class.h>
+#include <babeltrace/ctf-writer/stream.h>
+#include <babeltrace/ctf-writer/trace.h>
+#include <babeltrace/ctf-writer/writer.h>
+#include <babeltrace/ctf-ir/clock-class.h>
+#include <babeltrace/ctf-ir/event.h>
+#include <babeltrace/ctf-ir/event-class.h>
+#include <babeltrace/ctf-ir/fields.h>
 #include <babeltrace/ctf-ir/stream-class.h>
 #include <babeltrace/ctf-ir/stream.h>
-#include <babeltrace/ctf-ir/event.h>
+#include <babeltrace/ctf-ir/trace.h>
 #include <babeltrace/object-internal.h>
-#include <assert.h>
+#include <babeltrace/compat/stdlib-internal.h>
+#include <babeltrace/assert-internal.h>
+#include "common.h"
 
-#define NR_TESTS 41
+#define NR_TESTS 37
 
 struct user {
+       struct bt_trace *tc;
+       struct bt_stream_class *sc;
+       struct bt_event_class *ec;
+       struct bt_stream *stream;
+       struct bt_event *event;
+};
+
+struct writer_user {
+       struct bt_ctf_writer *writer;
        struct bt_ctf_trace *tc;
        struct bt_ctf_stream_class *sc;
        struct bt_ctf_event_class *ec;
+       struct bt_ctf_stream *stream;
+       struct bt_ctf_event *event;
+};
+
+const char *writer_user_names[] = {
+       "writer",
+       "trace",
+       "stream class",
+       "event class",
+       "stream",
+       "event",
 };
 
+static const size_t WRITER_USER_NR_ELEMENTS =
+       sizeof(struct writer_user) / sizeof(void *);
+
 /**
  * Returns a structure containing the following fields:
  *     - uint8_t payload_8;
  *     - uint16_t payload_16;
  *     - uint32_t payload_32;
  */
-static struct bt_ctf_field_type *create_integer_struct(void)
+static struct bt_field_type *create_integer_struct(void)
+{
+       int ret;
+       struct bt_field_type *structure = NULL;
+       struct bt_field_type *ui8 = NULL, *ui16 = NULL, *ui32 = NULL;
+
+       structure = bt_field_type_structure_create();
+       BT_ASSERT(structure);
+       ui8 = bt_field_type_unsigned_integer_create();
+       BT_ASSERT(ui8);
+       ret = bt_field_type_integer_set_field_value_range(ui8, 8);
+       BT_ASSERT(ret == 0);
+       ret = bt_field_type_structure_append_member(structure,
+               "payload_8", ui8);
+       BT_ASSERT(ret == 0);
+       ui16 = bt_field_type_unsigned_integer_create();
+       BT_ASSERT(ui16);
+       ret = bt_field_type_integer_set_field_value_range(ui16, 16);
+       BT_ASSERT(ret == 0);
+       ret = bt_field_type_structure_append_member(structure,
+               "payload_16", ui16);
+       BT_ASSERT(ret == 0);
+       ui32 = bt_field_type_unsigned_integer_create();
+       BT_ASSERT(ui32);
+       ret = bt_field_type_integer_set_field_value_range(ui32, 32);
+       BT_ASSERT(ret == 0);
+       ret = bt_field_type_structure_append_member(structure,
+               "payload_32", ui32);
+       BT_ASSERT(ret == 0);
+       BT_PUT(ui8);
+       BT_PUT(ui16);
+       BT_PUT(ui32);
+       return structure;
+}
+
+static struct bt_ctf_field_type *create_writer_integer_struct(void)
 {
        int ret;
        struct bt_ctf_field_type *structure = NULL;
        struct bt_ctf_field_type *ui8 = NULL, *ui16 = NULL, *ui32 = NULL;
 
        structure = bt_ctf_field_type_structure_create();
-       if (!structure) {
-               goto error;
-       }
-
+       BT_ASSERT(structure);
        ui8 = bt_ctf_field_type_integer_create(8);
-       if (!ui8) {
-               diag("Failed to create uint8_t type");
-               goto error;
-       }
+       BT_ASSERT(ui8);
        ret = bt_ctf_field_type_structure_add_field(structure, ui8,
                        "payload_8");
-       if (ret) {
-               diag("Failed to add uint8_t to structure");
-               goto error;
-       }
+       BT_ASSERT(ret == 0);
        ui16 = bt_ctf_field_type_integer_create(16);
-       if (!ui16) {
-               diag("Failed to create uint16_t type");
-               goto error;
-       }
+       BT_ASSERT(ui16);
        ret = bt_ctf_field_type_structure_add_field(structure, ui16,
                        "payload_16");
-       if (ret) {
-               diag("Failed to add uint16_t to structure");
-               goto error;
-       }
+       BT_ASSERT(ret == 0);
        ui32 = bt_ctf_field_type_integer_create(32);
-       if (!ui32) {
-               diag("Failed to create uint32_t type");
-               goto error;
-       }
+       BT_ASSERT(ui32);
        ret = bt_ctf_field_type_structure_add_field(structure, ui32,
                        "payload_32");
-       if (ret) {
-               diag("Failed to add uint32_t to structure");
-               goto error;
-       }
-end:
+       BT_ASSERT(ret == 0);
        BT_PUT(ui8);
        BT_PUT(ui16);
        BT_PUT(ui32);
        return structure;
-error:
-       BT_PUT(structure);
-       goto end;
 }
 
 /**
@@ -101,36 +146,24 @@ error:
  *     - uint16_t payload_16;
  *     - uint32_t payload_32;
  */
-static struct bt_ctf_event_class *create_simple_event(const char *name)
+static struct bt_event_class *create_simple_event(struct bt_stream_class *sc,
+               const char *name)
 {
        int ret;
-       struct bt_ctf_event_class *event = NULL;
-       struct bt_ctf_field_type *payload = NULL;
-
-        assert(name);
-       event = bt_ctf_event_class_create(name);
-       if (!event) {
-               diag("Failed to create simple event");
-               goto error;
-       }
-
+       struct bt_event_class *event = NULL;
+       struct bt_field_type *payload = NULL;
+
+       BT_ASSERT(name);
+       event = bt_event_class_create(sc);
+       BT_ASSERT(event);
+       ret = bt_event_class_set_name(event, name);
+       BT_ASSERT(ret == 0);
        payload = create_integer_struct();
-       if (!payload) {
-               diag("Failed to initialize integer structure");
-               goto error;
-       }
-
-       ret = bt_ctf_event_class_set_payload_type(event, payload);
-       if (ret) {
-               diag("Failed to set simple event payload");
-               goto error;
-       }
-end:
+       BT_ASSERT(payload);
+       ret = bt_event_class_set_payload_field_type(event, payload);
+       BT_ASSERT(ret == 0);
        BT_PUT(payload);
        return event;
-error:
-       BT_PUT(event);
-       goto end;;
 }
 
 /**
@@ -143,209 +176,172 @@ error:
  *           - uint16_t payload_16;
  *           - uint32_t payload_32;
  */
-static struct bt_ctf_event_class *create_complex_event(const char *name)
+static struct bt_event_class *create_complex_event(struct bt_stream_class *sc,
+               const char *name)
 {
        int ret;
-       struct bt_ctf_event_class *event = NULL;
-       struct bt_ctf_field_type *inner = NULL, *outer = NULL;
-
-        assert(name);
-       event = bt_ctf_event_class_create(name);
-       if (!event) {
-               diag("Failed to create complex event");
-               goto error;
-       }
-
-        outer = create_integer_struct();
-       if (!outer) {
-               diag("Failed to initialize integer structure");
-               goto error;
-       }
-
-        inner = create_integer_struct();
-       if (!inner) {
-               diag("Failed to initialize integer structure");
-               goto error;
-       }
-
-       ret = bt_ctf_field_type_structure_add_field(outer, inner,
-                       "payload_struct");
-       if (ret) {
-               diag("Failed to add inner structure to outer structure");
-               goto error;
-       }
-
-       ret = bt_ctf_event_class_set_payload_type(event, outer);
-       if (ret) {
-               diag("Failed to set complex event payload");
-               goto error;
-       }
-end:
+       struct bt_event_class *event = NULL;
+       struct bt_field_type *inner = NULL, *outer = NULL;
+
+       BT_ASSERT(name);
+       event = bt_event_class_create(sc);
+       BT_ASSERT(event);
+       ret = bt_event_class_set_name(event, name);
+       BT_ASSERT(ret == 0);
+       outer = create_integer_struct();
+       BT_ASSERT(outer);
+       inner = create_integer_struct();
+       BT_ASSERT(inner);
+       ret = bt_field_type_structure_append_member(outer,
+               "payload_struct", inner);
+       BT_ASSERT(ret == 0);
+       ret = bt_event_class_set_payload_field_type(event, outer);
+       BT_ASSERT(ret == 0);
        BT_PUT(inner);
        BT_PUT(outer);
        return event;
-error:
-       BT_PUT(event);
-       goto end;;
 }
 
-static struct bt_ctf_stream_class *create_sc1(void)
+static void set_stream_class_field_types(
+               struct bt_stream_class *stream_class)
 {
+       struct bt_field_type *packet_context_type;
+       struct bt_field_type *event_header_type;
+       struct bt_field_type *ft;
        int ret;
-       struct bt_ctf_event_class *ec1 = NULL, *ec2 = NULL;
-       struct bt_ctf_stream_class *sc1 = NULL, *ret_stream = NULL;
-
-       sc1 = bt_ctf_stream_class_create("sc1");
-       if (!sc1) {
-               diag("Failed to create Stream Class");
-               goto error;
-       }
-
-       ec1 = create_complex_event("ec1");
-       if (!ec1) {
-               diag("Failed to create complex event EC1");
-               goto error;
-       }
-       ret = bt_ctf_stream_class_add_event_class(sc1, ec1);
-       if (ret) {
-               diag("Failed to add EC1 to SC1");
-               goto error;
-       }
 
-       ec2 = create_simple_event("ec2");
-       if (!ec2) {
-               diag("Failed to create simple event EC2");
-               goto error;
-       }
-       ret = bt_ctf_stream_class_add_event_class(sc1, ec2);
-       if (ret) {
-               diag("Failed to add EC1 to SC1");
-               goto error;
-       }
-
-       ret_stream = bt_ctf_event_class_get_stream_class(ec1);
-       ok(ret_stream == sc1, "Get parent stream SC1 from EC1");
-       BT_PUT(ret_stream);
+       packet_context_type = bt_field_type_structure_create();
+       BT_ASSERT(packet_context_type);
+       ft = bt_field_type_unsigned_integer_create();
+       BT_ASSERT(ft);
+       ret = bt_field_type_integer_set_field_value_range(ft, 32);
+       BT_ASSERT(ret == 0);
+       ret = bt_field_type_structure_append_member(packet_context_type,
+               "packet_size", ft);
+       BT_ASSERT(ret == 0);
+       bt_put(ft);
+       ft = bt_field_type_unsigned_integer_create();
+       BT_ASSERT(ft);
+       ret = bt_field_type_integer_set_field_value_range(ft, 32);
+       BT_ASSERT(ret == 0);
+       ret = bt_field_type_structure_append_member(packet_context_type,
+               "content_size", ft);
+       BT_ASSERT(ret == 0);
+       bt_put(ft);
+       event_header_type = bt_field_type_structure_create();
+       BT_ASSERT(event_header_type);
+       ft = bt_field_type_unsigned_integer_create();
+       BT_ASSERT(ft);
+       ret = bt_field_type_integer_set_field_value_range(ft, 32);
+       BT_ASSERT(ret == 0);
+       ret = bt_field_type_structure_append_member(event_header_type,
+               "id", ft);
+       BT_ASSERT(ret == 0);
+       bt_put(ft);
+       ret = bt_stream_class_set_packet_context_field_type(stream_class,
+               packet_context_type);
+       BT_ASSERT(ret == 0);
+       ret = bt_stream_class_set_event_header_field_type(stream_class,
+               event_header_type);
+       BT_ASSERT(ret == 0);
+       bt_put(packet_context_type);
+       bt_put(event_header_type);
+}
 
-       ret_stream = bt_ctf_event_class_get_stream_class(ec2);
-       ok(ret_stream == sc1, "Get parent stream SC1 from EC2");
-end:
-       BT_PUT(ret_stream);
+static void create_sc1(struct bt_trace *trace)
+{
+       int ret;
+       struct bt_event_class *ec1 = NULL, *ec2 = NULL;
+       struct bt_stream_class *sc1 = NULL, *ret_stream = NULL;
+
+       sc1 = bt_stream_class_create(trace);
+       BT_ASSERT(sc1);
+       ret = bt_stream_class_set_name(sc1, "sc1");
+       BT_ASSERT(ret == 0);
+       set_stream_class_field_types(sc1);
+       ec1 = create_complex_event(sc1, "ec1");
+       BT_ASSERT(ec1);
+       ec2 = create_simple_event(sc1, "ec2");
+       BT_ASSERT(ec2);
+       ret_stream = bt_event_class_borrow_stream_class(ec1);
+       ok(ret_stream == sc1, "Borrow parent stream SC1 from EC1");
+       ret_stream = bt_event_class_borrow_stream_class(ec2);
+       ok(ret_stream == sc1, "Borrow parent stream SC1 from EC2");
        BT_PUT(ec1);
        BT_PUT(ec2);
-       return sc1;
-error:
        BT_PUT(sc1);
-        goto end;
 }
 
-static struct bt_ctf_stream_class *create_sc2(void)
+static void create_sc2(struct bt_trace *trace)
 {
        int ret;
-       struct bt_ctf_event_class *ec3 = NULL;
-       struct bt_ctf_stream_class *sc2 = NULL, *ret_stream = NULL;
-
-       sc2 = bt_ctf_stream_class_create("sc2");
-       if (!sc2) {
-               diag("Failed to create Stream Class");
-               goto error;
-       }
-
-       ec3 = create_simple_event("ec3");
-       if (!ec3) {
-               diag("Failed to create simple event EC3");
-               goto error;
-       }
-       ret = bt_ctf_stream_class_add_event_class(sc2, ec3);
-       if (ret) {
-               diag("Failed to add EC3 to SC2");
-               goto error;
-       }
-
-       ret_stream = bt_ctf_event_class_get_stream_class(ec3);
-       ok(ret_stream == sc2, "Get parent stream SC2 from EC3");
-end:
-       BT_PUT(ret_stream);
+       struct bt_event_class *ec3 = NULL;
+       struct bt_stream_class *sc2 = NULL, *ret_stream = NULL;
+
+       sc2 = bt_stream_class_create(trace);
+       BT_ASSERT(sc2);
+       ret = bt_stream_class_set_name(sc2, "sc2");
+       BT_ASSERT(ret == 0);
+       set_stream_class_field_types(sc2);
+       ec3 = create_simple_event(sc2, "ec3");
+       ret_stream = bt_event_class_borrow_stream_class(ec3);
+       ok(ret_stream == sc2, "Borrow parent stream SC2 from EC3");
        BT_PUT(ec3);
-       return sc2;
-error:
        BT_PUT(sc2);
-        goto end;
 }
 
-static struct bt_ctf_trace *create_tc1(void)
+static void set_trace_packet_header(struct bt_trace *trace)
 {
+       struct bt_field_type *packet_header_type;
+       struct bt_field_type *ft;
        int ret;
-       struct bt_ctf_trace *tc1 = NULL;
-       struct bt_ctf_stream_class *sc1 = NULL, *sc2 = NULL;
 
-        tc1 = bt_ctf_trace_create();
-       if (!tc1) {
-               diag("bt_ctf_trace_create returned NULL");
-               goto error;
-       }
+       packet_header_type = bt_field_type_structure_create();
+       BT_ASSERT(packet_header_type);
+       ft = bt_field_type_unsigned_integer_create();
+       BT_ASSERT(ft);
+       ret = bt_field_type_integer_set_field_value_range(ft, 32);
+       BT_ASSERT(ret == 0);
+       ret = bt_field_type_structure_append_member(packet_header_type,
+               "stream_id", ft);
+       BT_ASSERT(ret == 0);
+       bt_put(ft);
+       ret = bt_trace_set_packet_header_field_type(trace,
+               packet_header_type);
+       BT_ASSERT(ret == 0);
+
+       bt_put(packet_header_type);
+}
 
-       sc1 = create_sc1();
-       ok(sc1, "Create SC1");
-       if (!sc1) {
-               goto error;
-       }
-       ret = bt_ctf_trace_add_stream_class(tc1, sc1);
-       ok(!ret, "Add SC1 to TC1");
-       if (ret) {
-               goto error;
-       }
+static struct bt_trace *create_tc1(void)
+{
+       struct bt_trace *tc1 = NULL;
 
-       sc2 = create_sc2();
-       ok(sc2, "Create SC2");
-       if (!sc2) {
-               goto error;
-       }
-       ret = bt_ctf_trace_add_stream_class(tc1, sc2);
-       ok(!ret, "Add SC2 to TC1");
-       if (ret) {
-               goto error;
-       }
-end:
-       BT_PUT(sc1);
-       BT_PUT(sc2);
+       tc1 = bt_trace_create();
+       BT_ASSERT(tc1);
+       set_trace_packet_header(tc1);
+       create_sc1(tc1);
+       create_sc2(tc1);
        return tc1;
-error:
-       BT_PUT(tc1);
-        goto end;
 }
 
-static void init_weak_refs(struct bt_ctf_trace *tc,
-               struct bt_ctf_trace **tc1,
-               struct bt_ctf_stream_class **sc1,
-               struct bt_ctf_stream_class **sc2,
-               struct bt_ctf_event_class **ec1,
-               struct bt_ctf_event_class **ec2,
-               struct bt_ctf_event_class **ec3)
+static void init_weak_refs(struct bt_trace *tc,
+               struct bt_trace **tc1,
+               struct bt_stream_class **sc1,
+               struct bt_stream_class **sc2,
+               struct bt_event_class **ec1,
+               struct bt_event_class **ec2,
+               struct bt_event_class **ec3)
 {
        *tc1 = tc;
-       *sc1 = bt_ctf_trace_get_stream_class(tc, 0);
-       *sc2 = bt_ctf_trace_get_stream_class(tc, 1);
-       *ec1 = bt_ctf_stream_class_get_event_class(*sc1, 0);
-       *ec2 = bt_ctf_stream_class_get_event_class(*sc1, 1);
-       *ec3 = bt_ctf_stream_class_get_event_class(*sc2, 0);
-       bt_put(*sc1);
-       bt_put(*sc2);
-       bt_put(*ec1);
-       bt_put(*ec2);
-       bt_put(*ec3);
+       *sc1 = bt_trace_borrow_stream_class_by_index(tc, 0);
+       *sc2 = bt_trace_borrow_stream_class_by_index(tc, 1);
+       *ec1 = bt_stream_class_borrow_event_class_by_index(*sc1, 0);
+       *ec2 = bt_stream_class_borrow_event_class_by_index(*sc1, 1);
+       *ec3 = bt_stream_class_borrow_event_class_by_index(*sc2, 0);
 }
 
-/**
- * The objective of this test is to implement and expand upon the scenario
- * described in the reference counting documentation and ensure that any node of
- * the Trace, Stream Class, Event Class, Stream and Event hiearchy keeps all
- * other "alive" and reachable.
- *
- * External tools (e.g. valgrind) should be used to confirm that this
- * known-good test does not leak memory.
- */
-int main(int argc, char **argv)
+static void test_example_scenario(void)
 {
        /**
         * Weak pointers to CTF-IR objects are to be used very carefully.
@@ -354,57 +350,51 @@ int main(int argc, char **argv)
         * counts without affecting them by taking "real" references to the
         * objects.
         */
-       struct bt_ctf_trace *tc1 = NULL, *weak_tc1 = NULL;
-       struct bt_ctf_stream_class *weak_sc1 = NULL, *weak_sc2 = NULL;
-       struct bt_ctf_event_class *weak_ec1 = NULL, *weak_ec2 = NULL,
+       struct bt_trace *tc1 = NULL, *weak_tc1 = NULL;
+       struct bt_stream_class *weak_sc1 = NULL, *weak_sc2 = NULL;
+       struct bt_event_class *weak_ec1 = NULL, *weak_ec2 = NULL,
                        *weak_ec3 = NULL;
        struct user user_a = { 0 }, user_b = { 0 }, user_c = { 0 };
 
-        /* Initialize tap harness before any tests */
-       plan_tests(NR_TESTS);
-
        /* The only reference which exists at this point is on TC1. */
        tc1 = create_tc1();
-        ok(tc1, "Initialize trace");
-       if (!tc1) {
-               goto end;
-       }
-
+       ok(tc1, "Initialize trace");
+       BT_ASSERT(tc1);
        init_weak_refs(tc1, &weak_tc1, &weak_sc1, &weak_sc2, &weak_ec1,
                        &weak_ec2, &weak_ec3);
-
-       ok(bt_object_get_ref_count(weak_sc1) == 0,
+       ok(bt_object_get_ref_count((void *) weak_sc1) == 0,
                        "Initial SC1 reference count is 0");
-       ok(bt_object_get_ref_count(weak_sc2) == 0,
+       ok(bt_object_get_ref_count((void *) weak_sc2) == 0,
                        "Initial SC2 reference count is 0");
-       ok(bt_object_get_ref_count(weak_ec1) == 0,
+       ok(bt_object_get_ref_count((void *) weak_ec1) == 0,
                        "Initial EC1 reference count is 0");
-       ok(bt_object_get_ref_count(weak_ec2) == 0,
+       ok(bt_object_get_ref_count((void *) weak_ec2) == 0,
                        "Initial EC2 reference count is 0");
-       ok(bt_object_get_ref_count(weak_ec3) == 0,
+       ok(bt_object_get_ref_count((void *) weak_ec3) == 0,
                        "Initial EC3 reference count is 0");
 
        /* User A has ownership of the trace. */
        BT_MOVE(user_a.tc, tc1);
-       ok(bt_object_get_ref_count(user_a.tc) == 1,
+       ok(bt_object_get_ref_count((void *) user_a.tc) == 1,
                        "TC1 reference count is 1");
 
        /* User A acquires a reference to SC2 from TC1. */
-       user_a.sc = bt_ctf_trace_get_stream_class(user_a.tc, 1);
+       user_a.sc = bt_get(bt_trace_borrow_stream_class_by_index(user_a.tc, 1));
        ok(user_a.sc, "User A acquires SC2 from TC1");
-       ok(bt_object_get_ref_count(weak_tc1) == 2,
+       ok(bt_object_get_ref_count((void *) weak_tc1) == 2,
                        "TC1 reference count is 2");
-       ok(bt_object_get_ref_count(weak_sc2) == 1,
+       ok(bt_object_get_ref_count((void *) weak_sc2) == 1,
                        "SC2 reference count is 1");
 
        /* User A acquires a reference to EC3 from SC2. */
-       user_a.ec = bt_ctf_stream_class_get_event_class(user_a.sc, 0);
+       user_a.ec = bt_get(
+               bt_stream_class_borrow_event_class_by_index(user_a.sc, 0));
        ok(user_a.ec, "User A acquires EC3 from SC2");
-       ok(bt_object_get_ref_count(weak_tc1) == 2,
+       ok(bt_object_get_ref_count((void *) weak_tc1) == 2,
                        "TC1 reference count is 2");
-       ok(bt_object_get_ref_count(weak_sc2) == 2,
+       ok(bt_object_get_ref_count((void *) weak_sc2) == 2,
                        "SC2 reference count is 2");
-       ok(bt_object_get_ref_count(weak_ec3) == 1,
+       ok(bt_object_get_ref_count((void *) weak_ec3) == 1,
                        "EC3 reference count is 1");
 
        /* User A releases its reference to SC2. */
@@ -414,78 +404,222 @@ int main(int argc, char **argv)
         * We keep the pointer to SC2 around to validate its reference
         * count.
         */
-       ok(bt_object_get_ref_count(weak_tc1) == 2,
+       ok(bt_object_get_ref_count((void *) weak_tc1) == 2,
                        "TC1 reference count is 2");
-       ok(bt_object_get_ref_count(weak_sc2) == 1,
+       ok(bt_object_get_ref_count((void *) weak_sc2) == 1,
                        "SC2 reference count is 1");
-       ok(bt_object_get_ref_count(weak_ec3) == 1,
+       ok(bt_object_get_ref_count((void *) weak_ec3) == 1,
                        "EC3 reference count is 1");
 
        /* User A releases its reference to TC1. */
        diag("User A releases TC1");
-        BT_PUT(user_a.tc);
+       BT_PUT(user_a.tc);
        /*
         * We keep the pointer to TC1 around to validate its reference
         * count.
         */
-       ok(bt_object_get_ref_count(weak_tc1) == 1,
+       ok(bt_object_get_ref_count((void *) weak_tc1) == 1,
                        "TC1 reference count is 1");
-       ok(bt_object_get_ref_count(weak_sc2) == 1,
+       ok(bt_object_get_ref_count((void *) weak_sc2) == 1,
                        "SC2 reference count is 1");
-       ok(bt_object_get_ref_count(weak_ec3) == 1,
+       ok(bt_object_get_ref_count((void *) weak_ec3) == 1,
                        "EC3 reference count is 1");
 
        /* User B acquires a reference to SC1. */
        diag("User B acquires a reference to SC1");
        user_b.sc = bt_get(weak_sc1);
-       ok(bt_object_get_ref_count(weak_tc1) == 2,
+       ok(bt_object_get_ref_count((void *) weak_tc1) == 2,
                        "TC1 reference count is 2");
-       ok(bt_object_get_ref_count(weak_sc1) == 1,
+       ok(bt_object_get_ref_count((void *) weak_sc1) == 1,
                        "SC1 reference count is 1");
 
        /* User C acquires a reference to EC1. */
        diag("User C acquires a reference to EC1");
-       user_c.ec = bt_ctf_stream_class_get_event_class(user_b.sc, 0);
-       ok(bt_object_get_ref_count(weak_ec1) == 1,
+       user_c.ec = bt_get(
+               bt_stream_class_borrow_event_class_by_index(user_b.sc, 0));
+       ok(bt_object_get_ref_count((void *) weak_ec1) == 1,
                        "EC1 reference count is 1");
-       ok(bt_object_get_ref_count(weak_sc1) == 2,
+       ok(bt_object_get_ref_count((void *) weak_sc1) == 2,
                        "SC1 reference count is 2");
 
        /* User A releases its reference on EC3. */
        diag("User A releases its reference on EC3");
        BT_PUT(user_a.ec);
-       ok(bt_object_get_ref_count(weak_ec3) == 0,
+       ok(bt_object_get_ref_count((void *) weak_ec3) == 0,
                        "EC3 reference count is 1");
-       ok(bt_object_get_ref_count(weak_sc2) == 0,
+       ok(bt_object_get_ref_count((void *) weak_sc2) == 0,
                        "SC2 reference count is 0");
-       ok(bt_object_get_ref_count(weak_tc1) == 1,
+       ok(bt_object_get_ref_count((void *) weak_tc1) == 1,
                        "TC1 reference count is 1");
 
        /* User B releases its reference on SC1. */
        diag("User B releases its reference on SC1");
        BT_PUT(user_b.sc);
-       ok(bt_object_get_ref_count(weak_sc1) == 1,
+       ok(bt_object_get_ref_count((void *) weak_sc1) == 1,
                        "SC1 reference count is 1");
 
        /*
         * User C is the sole owner of an object and is keeping the whole
         * trace hierarchy "alive" by holding a reference to EC1.
         */
-       ok(bt_object_get_ref_count(weak_tc1) == 1,
+       ok(bt_object_get_ref_count((void *) weak_tc1) == 1,
                        "TC1 reference count is 1");
-       ok(bt_object_get_ref_count(weak_sc1) == 1,
+       ok(bt_object_get_ref_count((void *) weak_sc1) == 1,
                        "SC1 reference count is 1");
-       ok(bt_object_get_ref_count(weak_sc2) == 0,
+       ok(bt_object_get_ref_count((void *) weak_sc2) == 0,
                        "SC2 reference count is 0");
-       ok(bt_object_get_ref_count(weak_ec1) == 1,
+       ok(bt_object_get_ref_count((void *) weak_ec1) == 1,
                        "EC1 reference count is 1");
-       ok(bt_object_get_ref_count(weak_ec2) == 0,
+       ok(bt_object_get_ref_count((void *) weak_ec2) == 0,
                        "EC2 reference count is 0");
-       ok(bt_object_get_ref_count(weak_ec3) == 0,
+       ok(bt_object_get_ref_count((void *) weak_ec3) == 0,
                        "EC3 reference count is 0");
 
        /* Reclaim last reference held by User C. */
        BT_PUT(user_c.ec);
-end:
+}
+
+static void create_writer_user_full(struct writer_user *user)
+{
+       gchar *trace_path;
+       struct bt_ctf_field_type *ft;
+       struct bt_ctf_field *field;
+       struct bt_ctf_clock *clock;
+       int ret;
+
+       trace_path = g_build_filename(g_get_tmp_dir(), "ctfwriter_XXXXXX", NULL);
+       if (!bt_mkdtemp(trace_path)) {
+               perror("# perror");
+       }
+
+       user->writer = bt_ctf_writer_create(trace_path);
+       BT_ASSERT(user->writer);
+       ret = bt_ctf_writer_set_byte_order(user->writer,
+               BT_CTF_BYTE_ORDER_LITTLE_ENDIAN);
+       BT_ASSERT(ret == 0);
+       user->tc = bt_ctf_writer_get_trace(user->writer);
+       BT_ASSERT(user->tc);
+       user->sc = bt_ctf_stream_class_create("sc");
+       BT_ASSERT(user->sc);
+       clock = bt_ctf_clock_create("the_clock");
+       BT_ASSERT(clock);
+       ret = bt_ctf_writer_add_clock(user->writer, clock);
+       BT_ASSERT(!ret);
+       ret = bt_ctf_stream_class_set_clock(user->sc, clock);
+       BT_ASSERT(!ret);
+       BT_PUT(clock);
+       user->stream = bt_ctf_writer_create_stream(user->writer, user->sc);
+       BT_ASSERT(user->stream);
+       user->ec = bt_ctf_event_class_create("ec");
+       BT_ASSERT(user->ec);
+       ft = create_writer_integer_struct();
+       BT_ASSERT(ft);
+       ret = bt_ctf_event_class_set_payload_field_type(user->ec, ft);
+       BT_PUT(ft);
+       BT_ASSERT(!ret);
+       ret = bt_ctf_stream_class_add_event_class(user->sc, user->ec);
+       BT_ASSERT(!ret);
+       user->event = bt_ctf_event_create(user->ec);
+       BT_ASSERT(user->event);
+       field = bt_ctf_event_get_payload(user->event, "payload_8");
+       BT_ASSERT(field);
+       ret = bt_ctf_field_integer_unsigned_set_value(field, 10);
+       BT_ASSERT(!ret);
+       BT_PUT(field);
+       field = bt_ctf_event_get_payload(user->event, "payload_16");
+       BT_ASSERT(field);
+       ret = bt_ctf_field_integer_unsigned_set_value(field, 20);
+       BT_ASSERT(!ret);
+       BT_PUT(field);
+       field = bt_ctf_event_get_payload(user->event, "payload_32");
+       BT_ASSERT(field);
+       ret = bt_ctf_field_integer_unsigned_set_value(field, 30);
+       BT_ASSERT(!ret);
+       BT_PUT(field);
+       ret = bt_ctf_stream_append_event(user->stream, user->event);
+       BT_ASSERT(!ret);
+       recursive_rmdir(trace_path);
+       g_free(trace_path);
+}
+
+static void test_put_order_swap(size_t *array, size_t a, size_t b)
+{
+       size_t temp = array[a];
+
+       array[a] = array[b];
+       array[b] = temp;
+}
+
+static void test_put_order_put_objects(size_t *array, size_t size)
+{
+       size_t i;
+       struct writer_user user = { 0 };
+       void **objects = (void *) &user;
+
+       create_writer_user_full(&user);
+       printf("# ");
+
+       for (i = 0; i < size; ++i) {
+               void *obj = objects[array[i]];
+
+               printf("%s", writer_user_names[array[i]]);
+               BT_PUT(obj);
+
+               if (i < size - 1) {
+                       printf(" -> ");
+               }
+       }
+
+       puts("");
+}
+
+static void test_put_order_permute(size_t *array, int k, size_t size)
+{
+       if (k == 0) {
+               test_put_order_put_objects(array, size);
+       } else {
+               int i;
+
+               for (i = k - 1; i >= 0; i--) {
+                       size_t next_k = k - 1;
+
+                       test_put_order_swap(array, i, next_k);
+                       test_put_order_permute(array, next_k, size);
+                       test_put_order_swap(array, i, next_k);
+               }
+       }
+}
+
+static void test_put_order(void)
+{
+       size_t i;
+       size_t array[WRITER_USER_NR_ELEMENTS];
+
+       /* Initialize array of indexes */
+       for (i = 0; i < WRITER_USER_NR_ELEMENTS; ++i) {
+               array[i] = i;
+       }
+
+       test_put_order_permute(array, WRITER_USER_NR_ELEMENTS,
+               WRITER_USER_NR_ELEMENTS);
+}
+
+/**
+ * The objective of this test is to implement and expand upon the scenario
+ * described in the reference counting documentation and ensure that any node of
+ * the Trace, Stream Class, Event Class, Stream and Event hiearchy keeps all
+ * other "alive" and reachable.
+ *
+ * External tools (e.g. valgrind) should be used to confirm that this
+ * known-good test does not leak memory.
+ */
+int main(int argc, char **argv)
+{
+       /* Initialize tap harness before any tests */
+       plan_tests(NR_TESTS);
+
+       test_example_scenario();
+       test_put_order();
+
        return exit_status();
 }
This page took 0.035149 seconds and 4 git commands to generate.