Commit | Line | Data |
---|---|---|
c9b3f44b | 1 | /* |
108b91d0 | 2 | * test_trace_ir_ref.c |
c9b3f44b | 3 | * |
108b91d0 | 4 | * Trace IR Reference Count test |
c9b3f44b JG |
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" | |
9e550e5f | 23 | #include <babeltrace/babeltrace.h> |
c9b3f44b | 24 | #include <babeltrace/object-internal.h> |
3d9990ac | 25 | #include <babeltrace/compat/stdlib-internal.h> |
b8f13b8b | 26 | #include <babeltrace/assert-internal.h> |
851299b9 | 27 | #include "common.h" |
c9b3f44b | 28 | |
7b33a0e0 | 29 | #define NR_TESTS 37 |
8bbe269d | 30 | |
c9b3f44b | 31 | struct user { |
10b7a2e4 | 32 | struct bt_trace_class *tc; |
78cf9df6 PP |
33 | struct bt_stream_class *sc; |
34 | struct bt_event_class *ec; | |
35 | struct bt_stream *stream; | |
36 | struct bt_event *event; | |
c9b3f44b JG |
37 | }; |
38 | ||
8deee039 PP |
39 | struct writer_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 *writer_user_names[] = { | |
6271743c PP |
49 | "writer", |
50 | "trace", | |
51 | "stream class", | |
52 | "event class", | |
53 | "stream", | |
54 | "event", | |
55 | }; | |
56 | ||
8deee039 PP |
57 | static const size_t WRITER_USER_NR_ELEMENTS = |
58 | sizeof(struct writer_user) / sizeof(void *); | |
6271743c | 59 | |
c9b3f44b JG |
60 | /** |
61 | * Returns a structure containing the following fields: | |
62 | * - uint8_t payload_8; | |
63 | * - uint16_t payload_16; | |
64 | * - uint32_t payload_32; | |
65 | */ | |
78cf9df6 | 66 | static struct bt_field_class *create_integer_struct(void) |
c9b3f44b JG |
67 | { |
68 | int ret; | |
78cf9df6 PP |
69 | struct bt_field_class *structure = NULL; |
70 | struct bt_field_class *ui8 = NULL, *ui16 = NULL, *ui32 = NULL; | |
c9b3f44b | 71 | |
78cf9df6 | 72 | structure = bt_field_class_structure_create(); |
7b33a0e0 | 73 | BT_ASSERT(structure); |
78cf9df6 | 74 | ui8 = bt_field_class_unsigned_integer_create(); |
7b33a0e0 | 75 | BT_ASSERT(ui8); |
78cf9df6 PP |
76 | bt_field_class_integer_set_field_value_range(ui8, 8); |
77 | ret = bt_field_class_structure_append_member(structure, | |
7b33a0e0 PP |
78 | "payload_8", ui8); |
79 | BT_ASSERT(ret == 0); | |
78cf9df6 | 80 | ui16 = bt_field_class_unsigned_integer_create(); |
7b33a0e0 | 81 | BT_ASSERT(ui16); |
78cf9df6 PP |
82 | bt_field_class_integer_set_field_value_range(ui16, 16); |
83 | ret = bt_field_class_structure_append_member(structure, | |
7b33a0e0 PP |
84 | "payload_16", ui16); |
85 | BT_ASSERT(ret == 0); | |
78cf9df6 | 86 | ui32 = bt_field_class_unsigned_integer_create(); |
7b33a0e0 | 87 | BT_ASSERT(ui32); |
78cf9df6 PP |
88 | bt_field_class_integer_set_field_value_range(ui32, 32); |
89 | ret = bt_field_class_structure_append_member(structure, | |
7b33a0e0 PP |
90 | "payload_32", ui32); |
91 | BT_ASSERT(ret == 0); | |
8138bfe1 PP |
92 | BT_OBJECT_PUT_REF_AND_RESET(ui8); |
93 | BT_OBJECT_PUT_REF_AND_RESET(ui16); | |
94 | BT_OBJECT_PUT_REF_AND_RESET(ui32); | |
c9b3f44b | 95 | return structure; |
c9b3f44b JG |
96 | } |
97 | ||
8deee039 PP |
98 | static struct bt_ctf_field_type *create_writer_integer_struct(void) |
99 | { | |
100 | int ret; | |
101 | struct bt_ctf_field_type *structure = NULL; | |
102 | struct bt_ctf_field_type *ui8 = NULL, *ui16 = NULL, *ui32 = NULL; | |
103 | ||
104 | structure = bt_ctf_field_type_structure_create(); | |
7b33a0e0 | 105 | BT_ASSERT(structure); |
8deee039 | 106 | ui8 = bt_ctf_field_type_integer_create(8); |
7b33a0e0 | 107 | BT_ASSERT(ui8); |
8deee039 PP |
108 | ret = bt_ctf_field_type_structure_add_field(structure, ui8, |
109 | "payload_8"); | |
7b33a0e0 | 110 | BT_ASSERT(ret == 0); |
8deee039 | 111 | ui16 = bt_ctf_field_type_integer_create(16); |
7b33a0e0 | 112 | BT_ASSERT(ui16); |
8deee039 PP |
113 | ret = bt_ctf_field_type_structure_add_field(structure, ui16, |
114 | "payload_16"); | |
7b33a0e0 | 115 | BT_ASSERT(ret == 0); |
8deee039 | 116 | ui32 = bt_ctf_field_type_integer_create(32); |
7b33a0e0 | 117 | BT_ASSERT(ui32); |
8deee039 PP |
118 | ret = bt_ctf_field_type_structure_add_field(structure, ui32, |
119 | "payload_32"); | |
7b33a0e0 | 120 | BT_ASSERT(ret == 0); |
8138bfe1 PP |
121 | BT_OBJECT_PUT_REF_AND_RESET(ui8); |
122 | BT_OBJECT_PUT_REF_AND_RESET(ui16); | |
123 | BT_OBJECT_PUT_REF_AND_RESET(ui32); | |
8deee039 | 124 | return structure; |
8deee039 PP |
125 | } |
126 | ||
c9b3f44b JG |
127 | /** |
128 | * A simple event has the following payload: | |
129 | * - uint8_t payload_8; | |
130 | * - uint16_t payload_16; | |
131 | * - uint32_t payload_32; | |
132 | */ | |
78cf9df6 PP |
133 | static struct bt_event_class *create_simple_event( |
134 | struct bt_stream_class *sc, const char *name) | |
c9b3f44b JG |
135 | { |
136 | int ret; | |
78cf9df6 PP |
137 | struct bt_event_class *event = NULL; |
138 | struct bt_field_class *payload = NULL; | |
c9b3f44b | 139 | |
b8f13b8b | 140 | BT_ASSERT(name); |
78cf9df6 | 141 | event = bt_event_class_create(sc); |
7b33a0e0 | 142 | BT_ASSERT(event); |
78cf9df6 | 143 | ret = bt_event_class_set_name(event, name); |
7b33a0e0 | 144 | BT_ASSERT(ret == 0); |
c9b3f44b | 145 | payload = create_integer_struct(); |
7b33a0e0 | 146 | BT_ASSERT(payload); |
78cf9df6 | 147 | ret = bt_event_class_set_payload_field_class(event, payload); |
7b33a0e0 | 148 | BT_ASSERT(ret == 0); |
8138bfe1 | 149 | BT_OBJECT_PUT_REF_AND_RESET(payload); |
c9b3f44b | 150 | return event; |
c9b3f44b JG |
151 | } |
152 | ||
153 | /** | |
154 | * A complex event has the following payload: | |
155 | * - uint8_t payload_8; | |
156 | * - uint16_t payload_16; | |
157 | * - uint32_t payload_32; | |
158 | * - struct payload_struct: | |
159 | * - uint8_t payload_8; | |
160 | * - uint16_t payload_16; | |
161 | * - uint32_t payload_32; | |
162 | */ | |
78cf9df6 PP |
163 | static struct bt_event_class *create_complex_event( |
164 | struct bt_stream_class *sc, | |
7b33a0e0 | 165 | const char *name) |
c9b3f44b JG |
166 | { |
167 | int ret; | |
78cf9df6 PP |
168 | struct bt_event_class *event = NULL; |
169 | struct bt_field_class *inner = NULL, *outer = NULL; | |
c9b3f44b | 170 | |
b8f13b8b | 171 | BT_ASSERT(name); |
78cf9df6 | 172 | event = bt_event_class_create(sc); |
7b33a0e0 | 173 | BT_ASSERT(event); |
78cf9df6 | 174 | ret = bt_event_class_set_name(event, name); |
7b33a0e0 | 175 | BT_ASSERT(ret == 0); |
27f4d205 | 176 | outer = create_integer_struct(); |
7b33a0e0 | 177 | BT_ASSERT(outer); |
27f4d205 | 178 | inner = create_integer_struct(); |
7b33a0e0 | 179 | BT_ASSERT(inner); |
78cf9df6 | 180 | ret = bt_field_class_structure_append_member(outer, |
7b33a0e0 PP |
181 | "payload_struct", inner); |
182 | BT_ASSERT(ret == 0); | |
78cf9df6 | 183 | ret = bt_event_class_set_payload_field_class(event, outer); |
7b33a0e0 | 184 | BT_ASSERT(ret == 0); |
8138bfe1 PP |
185 | BT_OBJECT_PUT_REF_AND_RESET(inner); |
186 | BT_OBJECT_PUT_REF_AND_RESET(outer); | |
c9b3f44b | 187 | return event; |
c9b3f44b JG |
188 | } |
189 | ||
939190b3 | 190 | static void set_stream_class_field_classes( |
78cf9df6 | 191 | struct bt_stream_class *stream_class) |
da1cc671 | 192 | { |
78cf9df6 PP |
193 | struct bt_field_class *packet_context_type; |
194 | struct bt_field_class *event_header_type; | |
195 | struct bt_field_class *fc; | |
da1cc671 PP |
196 | int ret; |
197 | ||
78cf9df6 | 198 | packet_context_type = bt_field_class_structure_create(); |
b8f13b8b | 199 | BT_ASSERT(packet_context_type); |
78cf9df6 | 200 | fc = bt_field_class_unsigned_integer_create(); |
939190b3 | 201 | BT_ASSERT(fc); |
78cf9df6 PP |
202 | bt_field_class_integer_set_field_value_range(fc, 32); |
203 | ret = bt_field_class_structure_append_member(packet_context_type, | |
939190b3 | 204 | "packet_size", fc); |
b8f13b8b | 205 | BT_ASSERT(ret == 0); |
8138bfe1 | 206 | bt_object_put_ref(fc); |
78cf9df6 | 207 | fc = bt_field_class_unsigned_integer_create(); |
939190b3 | 208 | BT_ASSERT(fc); |
78cf9df6 PP |
209 | bt_field_class_integer_set_field_value_range(fc, 32); |
210 | ret = bt_field_class_structure_append_member(packet_context_type, | |
939190b3 | 211 | "content_size", fc); |
b8f13b8b | 212 | BT_ASSERT(ret == 0); |
8138bfe1 | 213 | bt_object_put_ref(fc); |
78cf9df6 | 214 | event_header_type = bt_field_class_structure_create(); |
b8f13b8b | 215 | BT_ASSERT(event_header_type); |
78cf9df6 | 216 | fc = bt_field_class_unsigned_integer_create(); |
939190b3 | 217 | BT_ASSERT(fc); |
78cf9df6 PP |
218 | bt_field_class_integer_set_field_value_range(fc, 32); |
219 | ret = bt_field_class_structure_append_member(event_header_type, | |
939190b3 | 220 | "id", fc); |
b8f13b8b | 221 | BT_ASSERT(ret == 0); |
8138bfe1 | 222 | bt_object_put_ref(fc); |
78cf9df6 | 223 | ret = bt_stream_class_set_packet_context_field_class( |
9e550e5f | 224 | stream_class, packet_context_type); |
b8f13b8b | 225 | BT_ASSERT(ret == 0); |
78cf9df6 | 226 | ret = bt_stream_class_set_event_header_field_class( |
9e550e5f | 227 | stream_class, event_header_type); |
b8f13b8b | 228 | BT_ASSERT(ret == 0); |
8138bfe1 PP |
229 | bt_object_put_ref(packet_context_type); |
230 | bt_object_put_ref(event_header_type); | |
da1cc671 PP |
231 | } |
232 | ||
10b7a2e4 | 233 | static void create_sc1(struct bt_trace_class *trace_class) |
c9b3f44b JG |
234 | { |
235 | int ret; | |
78cf9df6 PP |
236 | struct bt_event_class *ec1 = NULL, *ec2 = NULL; |
237 | struct bt_stream_class *sc1 = NULL, *ret_stream = NULL; | |
c9b3f44b | 238 | |
10b7a2e4 | 239 | sc1 = bt_stream_class_create(trace_class); |
7b33a0e0 | 240 | BT_ASSERT(sc1); |
78cf9df6 | 241 | ret = bt_stream_class_set_name(sc1, "sc1"); |
7b33a0e0 | 242 | BT_ASSERT(ret == 0); |
939190b3 | 243 | set_stream_class_field_classes(sc1); |
7b33a0e0 PP |
244 | ec1 = create_complex_event(sc1, "ec1"); |
245 | BT_ASSERT(ec1); | |
246 | ec2 = create_simple_event(sc1, "ec2"); | |
247 | BT_ASSERT(ec2); | |
78cf9df6 | 248 | ret_stream = bt_event_class_borrow_stream_class(ec1); |
7b33a0e0 | 249 | ok(ret_stream == sc1, "Borrow parent stream SC1 from EC1"); |
78cf9df6 | 250 | ret_stream = bt_event_class_borrow_stream_class(ec2); |
7b33a0e0 | 251 | ok(ret_stream == sc1, "Borrow parent stream SC1 from EC2"); |
8138bfe1 PP |
252 | BT_OBJECT_PUT_REF_AND_RESET(ec1); |
253 | BT_OBJECT_PUT_REF_AND_RESET(ec2); | |
254 | BT_OBJECT_PUT_REF_AND_RESET(sc1); | |
c9b3f44b JG |
255 | } |
256 | ||
10b7a2e4 | 257 | static void create_sc2(struct bt_trace_class *trace_class) |
c9b3f44b JG |
258 | { |
259 | int ret; | |
78cf9df6 PP |
260 | struct bt_event_class *ec3 = NULL; |
261 | struct bt_stream_class *sc2 = NULL, *ret_stream = NULL; | |
c9b3f44b | 262 | |
10b7a2e4 | 263 | sc2 = bt_stream_class_create(trace_class); |
7b33a0e0 | 264 | BT_ASSERT(sc2); |
78cf9df6 | 265 | ret = bt_stream_class_set_name(sc2, "sc2"); |
7b33a0e0 | 266 | BT_ASSERT(ret == 0); |
939190b3 | 267 | set_stream_class_field_classes(sc2); |
7b33a0e0 | 268 | ec3 = create_simple_event(sc2, "ec3"); |
78cf9df6 | 269 | ret_stream = bt_event_class_borrow_stream_class(ec3); |
7b33a0e0 | 270 | ok(ret_stream == sc2, "Borrow parent stream SC2 from EC3"); |
8138bfe1 PP |
271 | BT_OBJECT_PUT_REF_AND_RESET(ec3); |
272 | BT_OBJECT_PUT_REF_AND_RESET(sc2); | |
c9b3f44b JG |
273 | } |
274 | ||
10b7a2e4 | 275 | static void set_trace_packet_header(struct bt_trace_class *trace_class) |
da1cc671 | 276 | { |
78cf9df6 PP |
277 | struct bt_field_class *packet_header_type; |
278 | struct bt_field_class *fc; | |
da1cc671 PP |
279 | int ret; |
280 | ||
78cf9df6 | 281 | packet_header_type = bt_field_class_structure_create(); |
b8f13b8b | 282 | BT_ASSERT(packet_header_type); |
78cf9df6 | 283 | fc = bt_field_class_unsigned_integer_create(); |
939190b3 | 284 | BT_ASSERT(fc); |
78cf9df6 PP |
285 | bt_field_class_integer_set_field_value_range(fc, 32); |
286 | ret = bt_field_class_structure_append_member(packet_header_type, | |
939190b3 | 287 | "stream_id", fc); |
b8f13b8b | 288 | BT_ASSERT(ret == 0); |
8138bfe1 | 289 | bt_object_put_ref(fc); |
10b7a2e4 | 290 | ret = bt_trace_class_set_packet_header_field_class(trace_class, |
da1cc671 | 291 | packet_header_type); |
b8f13b8b | 292 | BT_ASSERT(ret == 0); |
da1cc671 | 293 | |
8138bfe1 | 294 | bt_object_put_ref(packet_header_type); |
da1cc671 PP |
295 | } |
296 | ||
10b7a2e4 | 297 | static struct bt_trace_class *create_tc1(void) |
c9b3f44b | 298 | { |
10b7a2e4 | 299 | struct bt_trace_class *tc1 = NULL; |
c9b3f44b | 300 | |
10b7a2e4 | 301 | tc1 = bt_trace_class_create(); |
7b33a0e0 | 302 | BT_ASSERT(tc1); |
da1cc671 | 303 | set_trace_packet_header(tc1); |
7b33a0e0 PP |
304 | create_sc1(tc1); |
305 | create_sc2(tc1); | |
c9b3f44b | 306 | return tc1; |
c9b3f44b JG |
307 | } |
308 | ||
10b7a2e4 PP |
309 | static void init_weak_refs(struct bt_trace_class *tc, |
310 | struct bt_trace_class **tc1, | |
78cf9df6 PP |
311 | struct bt_stream_class **sc1, |
312 | struct bt_stream_class **sc2, | |
313 | struct bt_event_class **ec1, | |
314 | struct bt_event_class **ec2, | |
315 | struct bt_event_class **ec3) | |
c9b3f44b JG |
316 | { |
317 | *tc1 = tc; | |
10b7a2e4 PP |
318 | *sc1 = bt_trace_class_borrow_stream_class_by_index(tc, 0); |
319 | *sc2 = bt_trace_class_borrow_stream_class_by_index(tc, 1); | |
78cf9df6 PP |
320 | *ec1 = bt_stream_class_borrow_event_class_by_index(*sc1, 0); |
321 | *ec2 = bt_stream_class_borrow_event_class_by_index(*sc1, 1); | |
322 | *ec3 = bt_stream_class_borrow_event_class_by_index(*sc2, 0); | |
c9b3f44b JG |
323 | } |
324 | ||
6271743c | 325 | static void test_example_scenario(void) |
c9b3f44b | 326 | { |
108b91d0 PP |
327 | /* |
328 | * Weak pointers to trace IR objects are to be used very | |
329 | * carefully. This is NOT a good practice and is strongly | |
330 | * discouraged; this is only done to facilitate the validation | |
331 | * of expected reference counts without affecting them by taking | |
332 | * "real" references to the objects. | |
c9b3f44b | 333 | */ |
10b7a2e4 | 334 | struct bt_trace_class *tc1 = NULL, *weak_tc1 = NULL; |
78cf9df6 PP |
335 | struct bt_stream_class *weak_sc1 = NULL, *weak_sc2 = NULL; |
336 | struct bt_event_class *weak_ec1 = NULL, *weak_ec2 = NULL, | |
c9b3f44b JG |
337 | *weak_ec3 = NULL; |
338 | struct user user_a = { 0 }, user_b = { 0 }, user_c = { 0 }; | |
339 | ||
340 | /* The only reference which exists at this point is on TC1. */ | |
341 | tc1 = create_tc1(); | |
27f4d205 | 342 | ok(tc1, "Initialize trace"); |
7b33a0e0 | 343 | BT_ASSERT(tc1); |
c9b3f44b JG |
344 | init_weak_refs(tc1, &weak_tc1, &weak_sc1, &weak_sc2, &weak_ec1, |
345 | &weak_ec2, &weak_ec3); | |
1d7bf349 | 346 | ok(bt_object_get_ref_count((void *) weak_sc1) == 0, |
c9b3f44b | 347 | "Initial SC1 reference count is 0"); |
1d7bf349 | 348 | ok(bt_object_get_ref_count((void *) weak_sc2) == 0, |
c9b3f44b | 349 | "Initial SC2 reference count is 0"); |
1d7bf349 | 350 | ok(bt_object_get_ref_count((void *) weak_ec1) == 0, |
c9b3f44b | 351 | "Initial EC1 reference count is 0"); |
1d7bf349 | 352 | ok(bt_object_get_ref_count((void *) weak_ec2) == 0, |
c9b3f44b | 353 | "Initial EC2 reference count is 0"); |
1d7bf349 | 354 | ok(bt_object_get_ref_count((void *) weak_ec3) == 0, |
c9b3f44b JG |
355 | "Initial EC3 reference count is 0"); |
356 | ||
357 | /* User A has ownership of the trace. */ | |
8138bfe1 | 358 | BT_OBJECT_MOVE_REF(user_a.tc, tc1); |
1d7bf349 | 359 | ok(bt_object_get_ref_count((void *) user_a.tc) == 1, |
c9b3f44b JG |
360 | "TC1 reference count is 1"); |
361 | ||
362 | /* User A acquires a reference to SC2 from TC1. */ | |
10b7a2e4 | 363 | user_a.sc = bt_trace_class_borrow_stream_class_by_index( |
4b70020d PP |
364 | user_a.tc, 1); |
365 | bt_object_get_ref(user_a.sc); | |
c9b3f44b | 366 | ok(user_a.sc, "User A acquires SC2 from TC1"); |
1d7bf349 | 367 | ok(bt_object_get_ref_count((void *) weak_tc1) == 2, |
c9b3f44b | 368 | "TC1 reference count is 2"); |
1d7bf349 | 369 | ok(bt_object_get_ref_count((void *) weak_sc2) == 1, |
c9b3f44b JG |
370 | "SC2 reference count is 1"); |
371 | ||
372 | /* User A acquires a reference to EC3 from SC2. */ | |
78cf9df6 | 373 | user_a.ec = bt_stream_class_borrow_event_class_by_index( |
4b70020d PP |
374 | user_a.sc, 0); |
375 | bt_object_get_ref(user_a.ec); | |
c9b3f44b | 376 | ok(user_a.ec, "User A acquires EC3 from SC2"); |
1d7bf349 | 377 | ok(bt_object_get_ref_count((void *) weak_tc1) == 2, |
c9b3f44b | 378 | "TC1 reference count is 2"); |
1d7bf349 | 379 | ok(bt_object_get_ref_count((void *) weak_sc2) == 2, |
c9b3f44b | 380 | "SC2 reference count is 2"); |
1d7bf349 | 381 | ok(bt_object_get_ref_count((void *) weak_ec3) == 1, |
c9b3f44b JG |
382 | "EC3 reference count is 1"); |
383 | ||
384 | /* User A releases its reference to SC2. */ | |
385 | diag("User A releases SC2"); | |
8138bfe1 | 386 | BT_OBJECT_PUT_REF_AND_RESET(user_a.sc); |
c9b3f44b JG |
387 | /* |
388 | * We keep the pointer to SC2 around to validate its reference | |
389 | * count. | |
390 | */ | |
1d7bf349 | 391 | ok(bt_object_get_ref_count((void *) weak_tc1) == 2, |
c9b3f44b | 392 | "TC1 reference count is 2"); |
1d7bf349 | 393 | ok(bt_object_get_ref_count((void *) weak_sc2) == 1, |
c9b3f44b | 394 | "SC2 reference count is 1"); |
1d7bf349 | 395 | ok(bt_object_get_ref_count((void *) weak_ec3) == 1, |
c9b3f44b JG |
396 | "EC3 reference count is 1"); |
397 | ||
398 | /* User A releases its reference to TC1. */ | |
399 | diag("User A releases TC1"); | |
8138bfe1 | 400 | BT_OBJECT_PUT_REF_AND_RESET(user_a.tc); |
c9b3f44b JG |
401 | /* |
402 | * We keep the pointer to TC1 around to validate its reference | |
403 | * count. | |
404 | */ | |
1d7bf349 | 405 | ok(bt_object_get_ref_count((void *) weak_tc1) == 1, |
c9b3f44b | 406 | "TC1 reference count is 1"); |
1d7bf349 | 407 | ok(bt_object_get_ref_count((void *) weak_sc2) == 1, |
c9b3f44b | 408 | "SC2 reference count is 1"); |
1d7bf349 | 409 | ok(bt_object_get_ref_count((void *) weak_ec3) == 1, |
c9b3f44b JG |
410 | "EC3 reference count is 1"); |
411 | ||
412 | /* User B acquires a reference to SC1. */ | |
413 | diag("User B acquires a reference to SC1"); | |
4b70020d PP |
414 | user_b.sc = weak_sc1; |
415 | bt_object_get_ref(user_b.sc); | |
1d7bf349 | 416 | ok(bt_object_get_ref_count((void *) weak_tc1) == 2, |
c9b3f44b | 417 | "TC1 reference count is 2"); |
1d7bf349 | 418 | ok(bt_object_get_ref_count((void *) weak_sc1) == 1, |
c9b3f44b JG |
419 | "SC1 reference count is 1"); |
420 | ||
421 | /* User C acquires a reference to EC1. */ | |
422 | diag("User C acquires a reference to EC1"); | |
78cf9df6 | 423 | user_c.ec = bt_stream_class_borrow_event_class_by_index( |
4b70020d PP |
424 | user_b.sc, 0); |
425 | bt_object_get_ref(user_c.ec); | |
1d7bf349 | 426 | ok(bt_object_get_ref_count((void *) weak_ec1) == 1, |
c9b3f44b | 427 | "EC1 reference count is 1"); |
1d7bf349 | 428 | ok(bt_object_get_ref_count((void *) weak_sc1) == 2, |
c9b3f44b JG |
429 | "SC1 reference count is 2"); |
430 | ||
431 | /* User A releases its reference on EC3. */ | |
432 | diag("User A releases its reference on EC3"); | |
8138bfe1 | 433 | BT_OBJECT_PUT_REF_AND_RESET(user_a.ec); |
1d7bf349 | 434 | ok(bt_object_get_ref_count((void *) weak_ec3) == 0, |
c9b3f44b | 435 | "EC3 reference count is 1"); |
1d7bf349 | 436 | ok(bt_object_get_ref_count((void *) weak_sc2) == 0, |
c9b3f44b | 437 | "SC2 reference count is 0"); |
1d7bf349 | 438 | ok(bt_object_get_ref_count((void *) weak_tc1) == 1, |
c9b3f44b JG |
439 | "TC1 reference count is 1"); |
440 | ||
441 | /* User B releases its reference on SC1. */ | |
442 | diag("User B releases its reference on SC1"); | |
8138bfe1 | 443 | BT_OBJECT_PUT_REF_AND_RESET(user_b.sc); |
1d7bf349 | 444 | ok(bt_object_get_ref_count((void *) weak_sc1) == 1, |
c9b3f44b JG |
445 | "SC1 reference count is 1"); |
446 | ||
447 | /* | |
448 | * User C is the sole owner of an object and is keeping the whole | |
449 | * trace hierarchy "alive" by holding a reference to EC1. | |
450 | */ | |
1d7bf349 | 451 | ok(bt_object_get_ref_count((void *) weak_tc1) == 1, |
c9b3f44b | 452 | "TC1 reference count is 1"); |
1d7bf349 | 453 | ok(bt_object_get_ref_count((void *) weak_sc1) == 1, |
c9b3f44b | 454 | "SC1 reference count is 1"); |
1d7bf349 | 455 | ok(bt_object_get_ref_count((void *) weak_sc2) == 0, |
c9b3f44b | 456 | "SC2 reference count is 0"); |
1d7bf349 | 457 | ok(bt_object_get_ref_count((void *) weak_ec1) == 1, |
c9b3f44b | 458 | "EC1 reference count is 1"); |
1d7bf349 | 459 | ok(bt_object_get_ref_count((void *) weak_ec2) == 0, |
c9b3f44b | 460 | "EC2 reference count is 0"); |
1d7bf349 | 461 | ok(bt_object_get_ref_count((void *) weak_ec3) == 0, |
c9b3f44b JG |
462 | "EC3 reference count is 0"); |
463 | ||
464 | /* Reclaim last reference held by User C. */ | |
8138bfe1 | 465 | BT_OBJECT_PUT_REF_AND_RESET(user_c.ec); |
6271743c PP |
466 | } |
467 | ||
8deee039 | 468 | static void create_writer_user_full(struct writer_user *user) |
6271743c | 469 | { |
9d6b510b | 470 | gchar *trace_path; |
8deee039 PP |
471 | struct bt_ctf_field_type *ft; |
472 | struct bt_ctf_field *field; | |
6271743c PP |
473 | struct bt_ctf_clock *clock; |
474 | int ret; | |
475 | ||
9d6b510b | 476 | trace_path = g_build_filename(g_get_tmp_dir(), "ctfwriter_XXXXXX", NULL); |
6271743c PP |
477 | if (!bt_mkdtemp(trace_path)) { |
478 | perror("# perror"); | |
479 | } | |
480 | ||
481 | user->writer = bt_ctf_writer_create(trace_path); | |
b8f13b8b | 482 | BT_ASSERT(user->writer); |
dc3fffef | 483 | ret = bt_ctf_writer_set_byte_order(user->writer, |
8deee039 | 484 | BT_CTF_BYTE_ORDER_LITTLE_ENDIAN); |
b8f13b8b | 485 | BT_ASSERT(ret == 0); |
6271743c | 486 | user->tc = bt_ctf_writer_get_trace(user->writer); |
b8f13b8b | 487 | BT_ASSERT(user->tc); |
8deee039 | 488 | user->sc = bt_ctf_stream_class_create("sc"); |
b8f13b8b | 489 | BT_ASSERT(user->sc); |
6271743c | 490 | clock = bt_ctf_clock_create("the_clock"); |
b8f13b8b | 491 | BT_ASSERT(clock); |
81582b6b | 492 | ret = bt_ctf_writer_add_clock(user->writer, clock); |
b8f13b8b | 493 | BT_ASSERT(!ret); |
8deee039 | 494 | ret = bt_ctf_stream_class_set_clock(user->sc, clock); |
b8f13b8b | 495 | BT_ASSERT(!ret); |
8138bfe1 | 496 | BT_OBJECT_PUT_REF_AND_RESET(clock); |
6271743c | 497 | user->stream = bt_ctf_writer_create_stream(user->writer, user->sc); |
b8f13b8b | 498 | BT_ASSERT(user->stream); |
8deee039 | 499 | user->ec = bt_ctf_event_class_create("ec"); |
b8f13b8b | 500 | BT_ASSERT(user->ec); |
8deee039 | 501 | ft = create_writer_integer_struct(); |
b8f13b8b | 502 | BT_ASSERT(ft); |
8deee039 | 503 | ret = bt_ctf_event_class_set_payload_field_type(user->ec, ft); |
8138bfe1 | 504 | BT_OBJECT_PUT_REF_AND_RESET(ft); |
b8f13b8b | 505 | BT_ASSERT(!ret); |
8deee039 | 506 | ret = bt_ctf_stream_class_add_event_class(user->sc, user->ec); |
b8f13b8b | 507 | BT_ASSERT(!ret); |
8deee039 | 508 | user->event = bt_ctf_event_create(user->ec); |
b8f13b8b | 509 | BT_ASSERT(user->event); |
8deee039 | 510 | field = bt_ctf_event_get_payload(user->event, "payload_8"); |
b8f13b8b | 511 | BT_ASSERT(field); |
8deee039 | 512 | ret = bt_ctf_field_integer_unsigned_set_value(field, 10); |
b8f13b8b | 513 | BT_ASSERT(!ret); |
8138bfe1 | 514 | BT_OBJECT_PUT_REF_AND_RESET(field); |
8deee039 | 515 | field = bt_ctf_event_get_payload(user->event, "payload_16"); |
b8f13b8b | 516 | BT_ASSERT(field); |
8deee039 | 517 | ret = bt_ctf_field_integer_unsigned_set_value(field, 20); |
b8f13b8b | 518 | BT_ASSERT(!ret); |
8138bfe1 | 519 | BT_OBJECT_PUT_REF_AND_RESET(field); |
8deee039 | 520 | field = bt_ctf_event_get_payload(user->event, "payload_32"); |
b8f13b8b | 521 | BT_ASSERT(field); |
8deee039 | 522 | ret = bt_ctf_field_integer_unsigned_set_value(field, 30); |
b8f13b8b | 523 | BT_ASSERT(!ret); |
8138bfe1 | 524 | BT_OBJECT_PUT_REF_AND_RESET(field); |
8deee039 | 525 | ret = bt_ctf_stream_append_event(user->stream, user->event); |
b8f13b8b | 526 | BT_ASSERT(!ret); |
851299b9 | 527 | recursive_rmdir(trace_path); |
9d6b510b | 528 | g_free(trace_path); |
6271743c PP |
529 | } |
530 | ||
531 | static void test_put_order_swap(size_t *array, size_t a, size_t b) | |
532 | { | |
533 | size_t temp = array[a]; | |
534 | ||
535 | array[a] = array[b]; | |
536 | array[b] = temp; | |
537 | } | |
538 | ||
539 | static void test_put_order_put_objects(size_t *array, size_t size) | |
540 | { | |
541 | size_t i; | |
8deee039 | 542 | struct writer_user user = { 0 }; |
6f2097e2 | 543 | void **objects = (void *) &user; |
6271743c | 544 | |
8deee039 | 545 | create_writer_user_full(&user); |
6271743c PP |
546 | printf("# "); |
547 | ||
548 | for (i = 0; i < size; ++i) { | |
6f2097e2 | 549 | void *obj = objects[array[i]]; |
6271743c | 550 | |
8deee039 | 551 | printf("%s", writer_user_names[array[i]]); |
8138bfe1 | 552 | BT_OBJECT_PUT_REF_AND_RESET(obj); |
6271743c PP |
553 | |
554 | if (i < size - 1) { | |
555 | printf(" -> "); | |
556 | } | |
557 | } | |
558 | ||
559 | puts(""); | |
560 | } | |
561 | ||
562 | static void test_put_order_permute(size_t *array, int k, size_t size) | |
563 | { | |
564 | if (k == 0) { | |
565 | test_put_order_put_objects(array, size); | |
566 | } else { | |
567 | int i; | |
568 | ||
569 | for (i = k - 1; i >= 0; i--) { | |
570 | size_t next_k = k - 1; | |
571 | ||
572 | test_put_order_swap(array, i, next_k); | |
573 | test_put_order_permute(array, next_k, size); | |
574 | test_put_order_swap(array, i, next_k); | |
575 | } | |
576 | } | |
577 | } | |
578 | ||
579 | static void test_put_order(void) | |
580 | { | |
581 | size_t i; | |
8deee039 | 582 | size_t array[WRITER_USER_NR_ELEMENTS]; |
6271743c PP |
583 | |
584 | /* Initialize array of indexes */ | |
8deee039 | 585 | for (i = 0; i < WRITER_USER_NR_ELEMENTS; ++i) { |
6271743c PP |
586 | array[i] = i; |
587 | } | |
588 | ||
8deee039 PP |
589 | test_put_order_permute(array, WRITER_USER_NR_ELEMENTS, |
590 | WRITER_USER_NR_ELEMENTS); | |
6271743c PP |
591 | } |
592 | ||
593 | /** | |
594 | * The objective of this test is to implement and expand upon the scenario | |
595 | * described in the reference counting documentation and ensure that any node of | |
596 | * the Trace, Stream Class, Event Class, Stream and Event hiearchy keeps all | |
597 | * other "alive" and reachable. | |
598 | * | |
599 | * External tools (e.g. valgrind) should be used to confirm that this | |
600 | * known-good test does not leak memory. | |
601 | */ | |
602 | int main(int argc, char **argv) | |
603 | { | |
27f4d205 | 604 | /* Initialize tap harness before any tests */ |
6271743c PP |
605 | plan_tests(NR_TESTS); |
606 | ||
607 | test_example_scenario(); | |
608 | test_put_order(); | |
609 | ||
c9b3f44b JG |
610 | return exit_status(); |
611 | } |