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