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