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