lib: simplify the public notification iterator interfaces
[babeltrace.git] / tests / lib / test_bt_notification_iterator.c
CommitLineData
223c70b2
PP
1/*
2 * Copyright 2017 - Philippe Proulx <pproulx@efficios.com>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; under version 2 of the License.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16 */
17
18#include <stdio.h>
19#include <stdlib.h>
20#include <stdint.h>
c55a9f58 21#include <stdbool.h>
223c70b2
PP
22#include <inttypes.h>
23#include <string.h>
25583cd0 24#include <babeltrace/assert-internal.h>
223c70b2
PP
25#include <babeltrace/ctf-ir/event-class.h>
26#include <babeltrace/ctf-ir/event.h>
27#include <babeltrace/ctf-ir/field-types.h>
28#include <babeltrace/ctf-ir/fields.h>
29#include <babeltrace/ctf-ir/packet.h>
30#include <babeltrace/ctf-ir/stream-class.h>
31#include <babeltrace/ctf-ir/stream.h>
32#include <babeltrace/ctf-ir/trace.h>
33#include <babeltrace/graph/clock-class-priority-map.h>
34#include <babeltrace/graph/component-class-filter.h>
35#include <babeltrace/graph/component-class-sink.h>
36#include <babeltrace/graph/component-class-source.h>
37#include <babeltrace/graph/component-class.h>
38#include <babeltrace/graph/component-sink.h>
39#include <babeltrace/graph/component-source.h>
40#include <babeltrace/graph/component.h>
73d5c1ad 41#include <babeltrace/graph/connection.h>
223c70b2
PP
42#include <babeltrace/graph/graph.h>
43#include <babeltrace/graph/notification-event.h>
44#include <babeltrace/graph/notification-inactivity.h>
45#include <babeltrace/graph/notification-iterator.h>
46#include <babeltrace/graph/notification-packet.h>
47#include <babeltrace/graph/notification-stream.h>
e893886e 48#include <babeltrace/graph/output-port-notification-iterator.h>
223c70b2
PP
49#include <babeltrace/graph/port.h>
50#include <babeltrace/graph/private-component-source.h>
b9d103be 51#include <babeltrace/graph/private-component-sink.h>
223c70b2
PP
52#include <babeltrace/graph/private-component.h>
53#include <babeltrace/graph/private-connection.h>
07245ac2 54#include <babeltrace/graph/private-connection-notification-iterator.h>
90157d89 55#include <babeltrace/graph/private-connection-private-notification-iterator.h>
223c70b2
PP
56#include <babeltrace/graph/private-port.h>
57#include <babeltrace/plugin/plugin.h>
58#include <babeltrace/ref.h>
59#include <glib.h>
60
61#include "tap/tap.h"
62
f42867e2 63#define NR_TESTS 6
223c70b2
PP
64
65enum test {
66 TEST_NO_AUTO_NOTIFS,
e893886e 67 TEST_OUTPUT_PORT_NOTIFICATION_ITERATOR,
223c70b2
PP
68};
69
70enum test_event_type {
71 TEST_EV_TYPE_NOTIF_UNEXPECTED,
72 TEST_EV_TYPE_NOTIF_EVENT,
73 TEST_EV_TYPE_NOTIF_INACTIVITY,
74 TEST_EV_TYPE_NOTIF_STREAM_BEGIN,
75 TEST_EV_TYPE_NOTIF_PACKET_BEGIN,
76 TEST_EV_TYPE_NOTIF_PACKET_END,
77 TEST_EV_TYPE_NOTIF_STREAM_END,
78 TEST_EV_TYPE_END,
79 TEST_EV_TYPE_SENTINEL,
80};
81
82struct test_event {
83 enum test_event_type type;
50842bdc
PP
84 struct bt_stream *stream;
85 struct bt_packet *packet;
223c70b2
PP
86};
87
223c70b2
PP
88static bool debug = false;
89static enum test current_test;
90static GArray *test_events;
5c563278 91static struct bt_graph *graph;
223c70b2 92static struct bt_clock_class_priority_map *src_empty_cc_prio_map;
50842bdc
PP
93static struct bt_stream_class *src_stream_class;
94static struct bt_event_class *src_event_class;
95static struct bt_stream *src_stream1;
96static struct bt_stream *src_stream2;
97static struct bt_packet *src_stream1_packet1;
98static struct bt_packet *src_stream1_packet2;
99static struct bt_packet *src_stream2_packet1;
100static struct bt_packet *src_stream2_packet2;
223c70b2
PP
101
102enum {
103 SEQ_END = -1,
104 SEQ_STREAM1_BEGIN = -2,
105 SEQ_STREAM2_BEGIN = -3,
106 SEQ_STREAM1_END = -4,
107 SEQ_STREAM2_END = -5,
108 SEQ_STREAM1_PACKET1_BEGIN = -6,
109 SEQ_STREAM1_PACKET2_BEGIN = -7,
110 SEQ_STREAM2_PACKET1_BEGIN = -8,
111 SEQ_STREAM2_PACKET2_BEGIN = -9,
112 SEQ_STREAM1_PACKET1_END = -10,
113 SEQ_STREAM1_PACKET2_END = -11,
114 SEQ_STREAM2_PACKET1_END = -12,
115 SEQ_STREAM2_PACKET2_END = -13,
116 SEQ_EVENT_STREAM1_PACKET1 = -14,
117 SEQ_EVENT_STREAM1_PACKET2 = -15,
118 SEQ_EVENT_STREAM2_PACKET1 = -16,
119 SEQ_EVENT_STREAM2_PACKET2 = -17,
120 SEQ_INACTIVITY = -18,
121};
122
123struct src_iter_user_data {
124 int64_t *seq;
125 size_t at;
126};
127
128struct sink_user_data {
129 struct bt_notification_iterator *notif_iter;
130};
131
132/*
133 * No automatic notifications generated in this block.
134 * Stream 2 notifications are more indented.
135 */
136static int64_t seq_no_auto_notifs[] = {
137 SEQ_STREAM1_BEGIN,
138 SEQ_STREAM1_PACKET1_BEGIN,
139 SEQ_EVENT_STREAM1_PACKET1,
140 SEQ_EVENT_STREAM1_PACKET1,
141 SEQ_STREAM2_BEGIN,
142 SEQ_EVENT_STREAM1_PACKET1,
143 SEQ_STREAM2_PACKET2_BEGIN,
144 SEQ_EVENT_STREAM2_PACKET2,
145 SEQ_EVENT_STREAM1_PACKET1,
146 SEQ_STREAM1_PACKET1_END,
147 SEQ_STREAM2_PACKET2_END,
148 SEQ_STREAM1_PACKET2_BEGIN,
149 SEQ_EVENT_STREAM1_PACKET2,
150 SEQ_STREAM2_END,
151 SEQ_STREAM1_PACKET2_END,
152 SEQ_STREAM1_END,
153 SEQ_END,
154};
155
223c70b2
PP
156static
157void clear_test_events(void)
158{
159 g_array_set_size(test_events, 0);
160}
161
162static
163void print_test_event(FILE *fp, const struct test_event *event)
164{
165 fprintf(fp, "{ type = ");
166
167 switch (event->type) {
168 case TEST_EV_TYPE_NOTIF_UNEXPECTED:
169 fprintf(fp, "TEST_EV_TYPE_NOTIF_UNEXPECTED");
170 break;
171 case TEST_EV_TYPE_NOTIF_EVENT:
172 fprintf(fp, "TEST_EV_TYPE_NOTIF_EVENT");
173 break;
174 case TEST_EV_TYPE_NOTIF_INACTIVITY:
175 fprintf(fp, "TEST_EV_TYPE_NOTIF_INACTIVITY");
176 break;
177 case TEST_EV_TYPE_NOTIF_STREAM_BEGIN:
178 fprintf(fp, "TEST_EV_TYPE_NOTIF_STREAM_BEGIN");
179 break;
180 case TEST_EV_TYPE_NOTIF_STREAM_END:
181 fprintf(fp, "TEST_EV_TYPE_NOTIF_STREAM_END");
182 break;
183 case TEST_EV_TYPE_NOTIF_PACKET_BEGIN:
184 fprintf(fp, "TEST_EV_TYPE_NOTIF_PACKET_BEGIN");
185 break;
186 case TEST_EV_TYPE_NOTIF_PACKET_END:
187 fprintf(fp, "TEST_EV_TYPE_NOTIF_PACKET_END");
188 break;
189 case TEST_EV_TYPE_END:
190 fprintf(fp, "TEST_EV_TYPE_END");
191 break;
192 case TEST_EV_TYPE_SENTINEL:
193 fprintf(fp, "TEST_EV_TYPE_SENTINEL");
194 break;
195 default:
196 fprintf(fp, "(UNKNOWN)");
197 break;
198 }
199
200 fprintf(fp, ", stream = %p, packet = %p }", event->stream,
201 event->packet);
202}
203
204static
205void append_test_event(struct test_event *event)
206{
207 g_array_append_val(test_events, *event);
208}
209
210static
211bool compare_single_test_events(const struct test_event *ev_a,
212 const struct test_event *ev_b)
213{
214 if (debug) {
215 fprintf(stderr, ":: Comparing test events: ");
216 print_test_event(stderr, ev_a);
217 fprintf(stderr, " vs. ");
218 print_test_event(stderr, ev_b);
219 fprintf(stderr, "\n");
220 }
221
222 if (ev_a->type != ev_b->type) {
223 return false;
224 }
225
226 switch (ev_a->type) {
227 case TEST_EV_TYPE_END:
228 case TEST_EV_TYPE_SENTINEL:
229 break;
230 default:
231 if (ev_a->stream != ev_b->stream) {
232 return false;
233 }
234
235 if (ev_a->packet != ev_b->packet) {
236 return false;
237 }
238 break;
239 }
240
241 return true;
242}
243
244static
245bool compare_test_events(const struct test_event *expected_events)
246{
247 const struct test_event *expected_event = expected_events;
248 size_t i = 0;
249
25583cd0 250 BT_ASSERT(expected_events);
223c70b2
PP
251
252 while (true) {
253 const struct test_event *event;
254
255 if (expected_event->type == TEST_EV_TYPE_SENTINEL) {
256 break;
257 }
258
259 if (i >= test_events->len) {
260 return false;
261 }
262
263 event = &g_array_index(test_events, struct test_event, i);
264
265 if (!compare_single_test_events(event, expected_event)) {
266 return false;
267 }
268
269 i++;
270 expected_event++;
271 }
272
273 if (i != test_events->len) {
274 return false;
275 }
276
277 return true;
278}
279
280static
281void init_static_data(void)
282{
283 int ret;
50842bdc
PP
284 struct bt_trace *trace;
285 struct bt_field_type *empty_struct_ft;
223c70b2
PP
286
287 /* Test events */
288 test_events = g_array_new(FALSE, TRUE, sizeof(struct test_event));
25583cd0 289 BT_ASSERT(test_events);
223c70b2
PP
290
291 /* Metadata */
50842bdc 292 empty_struct_ft = bt_field_type_structure_create();
25583cd0 293 BT_ASSERT(empty_struct_ft);
50842bdc 294 trace = bt_trace_create();
25583cd0 295 BT_ASSERT(trace);
3dca2276 296 ret = bt_trace_set_packet_header_field_type(trace, empty_struct_ft);
25583cd0 297 BT_ASSERT(ret == 0);
223c70b2 298 src_empty_cc_prio_map = bt_clock_class_priority_map_create();
25583cd0 299 BT_ASSERT(src_empty_cc_prio_map);
50842bdc 300 src_stream_class = bt_stream_class_create("my-stream-class");
25583cd0 301 BT_ASSERT(src_stream_class);
3dca2276 302 ret = bt_stream_class_set_packet_context_field_type(src_stream_class,
223c70b2 303 empty_struct_ft);
25583cd0 304 BT_ASSERT(ret == 0);
3dca2276 305 ret = bt_stream_class_set_event_header_field_type(src_stream_class,
223c70b2 306 empty_struct_ft);
25583cd0 307 BT_ASSERT(ret == 0);
3dca2276 308 ret = bt_stream_class_set_event_context_field_type(src_stream_class,
223c70b2 309 empty_struct_ft);
25583cd0 310 BT_ASSERT(ret == 0);
50842bdc 311 src_event_class = bt_event_class_create("my-event-class");
3dca2276 312 ret = bt_event_class_set_context_field_type(src_event_class,
223c70b2 313 empty_struct_ft);
25583cd0 314 BT_ASSERT(ret == 0);
3dca2276 315 ret = bt_event_class_set_payload_field_type(src_event_class,
223c70b2 316 empty_struct_ft);
25583cd0 317 BT_ASSERT(ret == 0);
50842bdc 318 ret = bt_stream_class_add_event_class(src_stream_class,
223c70b2 319 src_event_class);
25583cd0 320 BT_ASSERT(ret == 0);
50842bdc 321 ret = bt_trace_add_stream_class(trace, src_stream_class);
25583cd0 322 BT_ASSERT(ret == 0);
3dca2276 323 src_stream1 = bt_stream_create(src_stream_class, "stream-1", 0);
25583cd0 324 BT_ASSERT(src_stream1);
3dca2276 325 src_stream2 = bt_stream_create(src_stream_class, "stream-2", 1);
25583cd0 326 BT_ASSERT(src_stream2);
50842bdc 327 src_stream1_packet1 = bt_packet_create(src_stream1);
25583cd0 328 BT_ASSERT(src_stream1_packet1);
50842bdc 329 src_stream1_packet2 = bt_packet_create(src_stream1);
25583cd0 330 BT_ASSERT(src_stream1_packet2);
50842bdc 331 src_stream2_packet1 = bt_packet_create(src_stream2);
25583cd0 332 BT_ASSERT(src_stream2_packet1);
50842bdc 333 src_stream2_packet2 = bt_packet_create(src_stream2);
25583cd0 334 BT_ASSERT(src_stream2_packet2);
223c70b2
PP
335
336 if (debug) {
337 fprintf(stderr, ":: stream 1: %p\n", src_stream1);
338 fprintf(stderr, ":: stream 2: %p\n", src_stream2);
339 fprintf(stderr, ":: stream 1, packet 1: %p\n", src_stream1_packet1);
340 fprintf(stderr, ":: stream 1, packet 2: %p\n", src_stream1_packet2);
341 fprintf(stderr, ":: stream 2, packet 1: %p\n", src_stream2_packet1);
342 fprintf(stderr, ":: stream 2, packet 2: %p\n", src_stream2_packet2);
343 }
344
345 bt_put(trace);
346 bt_put(empty_struct_ft);
347}
348
349static
350void fini_static_data(void)
351{
352 /* Test events */
353 g_array_free(test_events, TRUE);
354
355 /* Metadata */
356 bt_put(src_empty_cc_prio_map);
357 bt_put(src_stream_class);
358 bt_put(src_event_class);
359 bt_put(src_stream1);
360 bt_put(src_stream2);
361 bt_put(src_stream1_packet1);
362 bt_put(src_stream1_packet2);
363 bt_put(src_stream2_packet1);
364 bt_put(src_stream2_packet2);
365}
366
367static
368void src_iter_finalize(
90157d89 369 struct bt_private_connection_private_notification_iterator *private_notification_iterator)
223c70b2
PP
370{
371 struct src_iter_user_data *user_data =
90157d89 372 bt_private_connection_private_notification_iterator_get_user_data(
223c70b2
PP
373 private_notification_iterator);
374
375 if (user_data) {
376 g_free(user_data);
377 }
378}
379
380static
381enum bt_notification_iterator_status src_iter_init(
90157d89 382 struct bt_private_connection_private_notification_iterator *priv_notif_iter,
223c70b2
PP
383 struct bt_private_port *private_port)
384{
385 struct src_iter_user_data *user_data =
386 g_new0(struct src_iter_user_data, 1);
387 int ret;
388
25583cd0 389 BT_ASSERT(user_data);
e893886e
PP
390 ret = bt_private_connection_private_notification_iterator_set_user_data(
391 priv_notif_iter, user_data);
25583cd0 392 BT_ASSERT(ret == 0);
223c70b2
PP
393
394 switch (current_test) {
395 case TEST_NO_AUTO_NOTIFS:
e893886e 396 case TEST_OUTPUT_PORT_NOTIFICATION_ITERATOR:
223c70b2
PP
397 user_data->seq = seq_no_auto_notifs;
398 break;
223c70b2 399 default:
0fbb9a9f 400 abort();
223c70b2
PP
401 }
402
403 return BT_NOTIFICATION_ITERATOR_STATUS_OK;
404}
405
223c70b2 406static
90157d89 407struct bt_notification_iterator_next_method_return src_iter_next_seq(
223c70b2
PP
408 struct src_iter_user_data *user_data)
409{
90157d89 410 struct bt_notification_iterator_next_method_return next_return = {
223c70b2
PP
411 .status = BT_NOTIFICATION_ITERATOR_STATUS_OK,
412 };
413 int64_t cur_ts_ns;
50842bdc 414 struct bt_packet *event_packet = NULL;
223c70b2 415
25583cd0 416 BT_ASSERT(user_data->seq);
223c70b2
PP
417 cur_ts_ns = user_data->seq[user_data->at];
418
419 switch (cur_ts_ns) {
420 case SEQ_END:
421 next_return.status =
422 BT_NOTIFICATION_ITERATOR_STATUS_END;
423 break;
424 case SEQ_INACTIVITY:
425 next_return.notification =
5c563278
PP
426 bt_notification_inactivity_create(graph,
427 src_empty_cc_prio_map);
25583cd0 428 BT_ASSERT(next_return.notification);
223c70b2
PP
429 break;
430 case SEQ_STREAM1_BEGIN:
431 next_return.notification =
5c563278 432 bt_notification_stream_begin_create(graph, src_stream1);
25583cd0 433 BT_ASSERT(next_return.notification);
223c70b2
PP
434 break;
435 case SEQ_STREAM2_BEGIN:
436 next_return.notification =
5c563278 437 bt_notification_stream_begin_create(graph, src_stream2);
25583cd0 438 BT_ASSERT(next_return.notification);
223c70b2
PP
439 break;
440 case SEQ_STREAM1_END:
441 next_return.notification =
5c563278 442 bt_notification_stream_end_create(graph, src_stream1);
25583cd0 443 BT_ASSERT(next_return.notification);
223c70b2
PP
444 break;
445 case SEQ_STREAM2_END:
446 next_return.notification =
5c563278 447 bt_notification_stream_end_create(graph, src_stream2);
25583cd0 448 BT_ASSERT(next_return.notification);
223c70b2
PP
449 break;
450 case SEQ_STREAM1_PACKET1_BEGIN:
451 next_return.notification =
5c563278
PP
452 bt_notification_packet_begin_create(graph,
453 src_stream1_packet1);
25583cd0 454 BT_ASSERT(next_return.notification);
223c70b2
PP
455 break;
456 case SEQ_STREAM1_PACKET2_BEGIN:
457 next_return.notification =
5c563278
PP
458 bt_notification_packet_begin_create(graph,
459 src_stream1_packet2);
25583cd0 460 BT_ASSERT(next_return.notification);
223c70b2
PP
461 break;
462 case SEQ_STREAM2_PACKET1_BEGIN:
463 next_return.notification =
5c563278
PP
464 bt_notification_packet_begin_create(graph,
465 src_stream2_packet1);
25583cd0 466 BT_ASSERT(next_return.notification);
223c70b2
PP
467 break;
468 case SEQ_STREAM2_PACKET2_BEGIN:
469 next_return.notification =
5c563278
PP
470 bt_notification_packet_begin_create(graph,
471 src_stream2_packet2);
25583cd0 472 BT_ASSERT(next_return.notification);
223c70b2
PP
473 break;
474 case SEQ_STREAM1_PACKET1_END:
475 next_return.notification =
5c563278
PP
476 bt_notification_packet_end_create(graph,
477 src_stream1_packet1);
25583cd0 478 BT_ASSERT(next_return.notification);
223c70b2
PP
479 break;
480 case SEQ_STREAM1_PACKET2_END:
481 next_return.notification =
5c563278
PP
482 bt_notification_packet_end_create(graph,
483 src_stream1_packet2);
25583cd0 484 BT_ASSERT(next_return.notification);
223c70b2
PP
485 break;
486 case SEQ_STREAM2_PACKET1_END:
487 next_return.notification =
5c563278
PP
488 bt_notification_packet_end_create(graph,
489 src_stream2_packet1);
25583cd0 490 BT_ASSERT(next_return.notification);
223c70b2
PP
491 break;
492 case SEQ_STREAM2_PACKET2_END:
493 next_return.notification =
5c563278
PP
494 bt_notification_packet_end_create(graph,
495 src_stream2_packet2);
25583cd0 496 BT_ASSERT(next_return.notification);
223c70b2
PP
497 break;
498 case SEQ_EVENT_STREAM1_PACKET1:
499 event_packet = src_stream1_packet1;
500 break;
501 case SEQ_EVENT_STREAM1_PACKET2:
502 event_packet = src_stream1_packet2;
503 break;
504 case SEQ_EVENT_STREAM2_PACKET1:
505 event_packet = src_stream2_packet1;
506 break;
507 case SEQ_EVENT_STREAM2_PACKET2:
508 event_packet = src_stream2_packet2;
509 break;
510 default:
0fbb9a9f 511 abort();
223c70b2
PP
512 }
513
514 if (event_packet) {
312c056a 515 next_return.notification =
5c563278 516 bt_notification_event_create(graph, src_event_class,
25583cd0
PP
517 event_packet, src_empty_cc_prio_map);
518 BT_ASSERT(next_return.notification);
223c70b2
PP
519 }
520
521 if (next_return.status != BT_NOTIFICATION_ITERATOR_STATUS_END) {
522 user_data->at++;
523 }
524
525 return next_return;
526}
527
528static
90157d89
PP
529struct bt_notification_iterator_next_method_return src_iter_next(
530 struct bt_private_connection_private_notification_iterator *priv_iterator)
223c70b2 531{
90157d89 532 struct bt_notification_iterator_next_method_return next_return = {
223c70b2
PP
533 .status = BT_NOTIFICATION_ITERATOR_STATUS_OK,
534 .notification = NULL,
535 };
536 struct src_iter_user_data *user_data =
90157d89 537 bt_private_connection_private_notification_iterator_get_user_data(priv_iterator);
223c70b2 538
25583cd0 539 BT_ASSERT(user_data);
223c70b2
PP
540 next_return = src_iter_next_seq(user_data);
541 return next_return;
542}
543
544static
545enum bt_component_status src_init(
546 struct bt_private_component *private_component,
547 struct bt_value *params, void *init_method_data)
548{
147337a3 549 int ret;
b9d103be 550
147337a3
PP
551 ret = bt_private_component_source_add_output_private_port(
552 private_component, "out", NULL, NULL);
25583cd0 553 BT_ASSERT(ret == 0);
223c70b2
PP
554 return BT_COMPONENT_STATUS_OK;
555}
556
557static
558void src_finalize(struct bt_private_component *private_component)
559{
560}
561
562static
e893886e 563enum bt_notification_iterator_status common_consume(
07245ac2
PP
564 struct bt_notification_iterator *notif_iter,
565 bool is_output_port_notif_iter)
223c70b2 566{
e893886e 567 enum bt_notification_iterator_status ret;
223c70b2 568 struct bt_notification *notification = NULL;
223c70b2
PP
569 struct test_event test_event = { 0 };
570 bool do_append_test_event = true;
25583cd0 571 BT_ASSERT(notif_iter);
223c70b2 572
07245ac2
PP
573 if (is_output_port_notif_iter) {
574 ret = bt_output_port_notification_iterator_next(notif_iter,
575 &notification);
576 } else {
577 ret = bt_private_connection_notification_iterator_next(
578 notif_iter, &notification);
579 }
580
e893886e 581 if (ret < 0) {
223c70b2
PP
582 do_append_test_event = false;
583 goto end;
584 }
585
e893886e 586 switch (ret) {
223c70b2
PP
587 case BT_NOTIFICATION_ITERATOR_STATUS_END:
588 test_event.type = TEST_EV_TYPE_END;
223c70b2
PP
589 goto end;
590 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
0fbb9a9f 591 abort();
223c70b2
PP
592 default:
593 break;
594 }
595
25583cd0 596 BT_ASSERT(notification);
223c70b2
PP
597
598 switch (bt_notification_get_type(notification)) {
599 case BT_NOTIFICATION_TYPE_EVENT:
600 {
50842bdc 601 struct bt_event *event;
223c70b2
PP
602
603 test_event.type = TEST_EV_TYPE_NOTIF_EVENT;
312c056a 604 event = bt_notification_event_borrow_event(notification);
25583cd0 605 BT_ASSERT(event);
312c056a 606 test_event.packet = bt_event_borrow_packet(event);
25583cd0 607 BT_ASSERT(test_event.packet);
223c70b2
PP
608 break;
609 }
610 case BT_NOTIFICATION_TYPE_INACTIVITY:
611 test_event.type = TEST_EV_TYPE_NOTIF_INACTIVITY;
612 break;
613 case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
614 test_event.type = TEST_EV_TYPE_NOTIF_STREAM_BEGIN;
615 test_event.stream =
312c056a 616 bt_notification_stream_begin_borrow_stream(notification);
25583cd0 617 BT_ASSERT(test_event.stream);
223c70b2
PP
618 break;
619 case BT_NOTIFICATION_TYPE_STREAM_END:
620 test_event.type = TEST_EV_TYPE_NOTIF_STREAM_END;
621 test_event.stream =
312c056a 622 bt_notification_stream_end_borrow_stream(notification);
25583cd0 623 BT_ASSERT(test_event.stream);
223c70b2
PP
624 break;
625 case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
626 test_event.type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN;
627 test_event.packet =
312c056a 628 bt_notification_packet_begin_borrow_packet(notification);
25583cd0 629 BT_ASSERT(test_event.packet);
223c70b2
PP
630 break;
631 case BT_NOTIFICATION_TYPE_PACKET_END:
632 test_event.type = TEST_EV_TYPE_NOTIF_PACKET_END;
633 test_event.packet =
312c056a 634 bt_notification_packet_end_borrow_packet(notification);
25583cd0 635 BT_ASSERT(test_event.packet);
223c70b2
PP
636 break;
637 default:
638 test_event.type = TEST_EV_TYPE_NOTIF_UNEXPECTED;
639 break;
640 }
641
642 if (test_event.packet) {
312c056a 643 test_event.stream = bt_packet_borrow_stream(test_event.packet);
25583cd0 644 BT_ASSERT(test_event.stream);
223c70b2
PP
645 }
646
647end:
648 if (do_append_test_event) {
649 append_test_event(&test_event);
650 }
651
652 bt_put(notification);
653 return ret;
654}
655
e893886e
PP
656static
657enum bt_component_status sink_consume(
658 struct bt_private_component *priv_component)
659{
660 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
661 struct sink_user_data *user_data =
662 bt_private_component_get_user_data(priv_component);
663 enum bt_notification_iterator_status it_ret;
664
25583cd0 665 BT_ASSERT(user_data && user_data->notif_iter);
07245ac2 666 it_ret = common_consume(user_data->notif_iter, false);
e893886e
PP
667
668 if (it_ret < 0) {
669 ret = BT_COMPONENT_STATUS_ERROR;
670 goto end;
671 }
672
673 switch (it_ret) {
674 case BT_NOTIFICATION_ITERATOR_STATUS_END:
675 ret = BT_COMPONENT_STATUS_END;
676 BT_PUT(user_data->notif_iter);
677 goto end;
678 case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
679 abort();
680 default:
681 break;
682 }
683
684end:
685 return ret;
686}
687
223c70b2
PP
688static
689void sink_port_connected(struct bt_private_component *private_component,
690 struct bt_private_port *self_private_port,
691 struct bt_port *other_port)
692{
693 struct bt_private_connection *priv_conn =
694 bt_private_port_get_private_connection(self_private_port);
695 struct sink_user_data *user_data = bt_private_component_get_user_data(
696 private_component);
73d5c1ad 697 enum bt_connection_status conn_status;
223c70b2 698
25583cd0
PP
699 BT_ASSERT(user_data);
700 BT_ASSERT(priv_conn);
73d5c1ad 701 conn_status = bt_private_connection_create_notification_iterator(
f42867e2 702 priv_conn, &user_data->notif_iter);
25583cd0 703 BT_ASSERT(conn_status == 0);
223c70b2
PP
704 bt_put(priv_conn);
705}
706
707static
708enum bt_component_status sink_init(
709 struct bt_private_component *private_component,
710 struct bt_value *params, void *init_method_data)
711{
712 struct sink_user_data *user_data = g_new0(struct sink_user_data, 1);
713 int ret;
714
25583cd0 715 BT_ASSERT(user_data);
223c70b2
PP
716 ret = bt_private_component_set_user_data(private_component,
717 user_data);
25583cd0 718 BT_ASSERT(ret == 0);
147337a3
PP
719 ret = bt_private_component_sink_add_input_private_port(
720 private_component, "in", NULL, NULL);
25583cd0 721 BT_ASSERT(ret == 0);
223c70b2
PP
722 return BT_COMPONENT_STATUS_OK;
723}
724
725static
726void sink_finalize(struct bt_private_component *private_component)
727{
728 struct sink_user_data *user_data = bt_private_component_get_user_data(
729 private_component);
730
731 if (user_data) {
732 bt_put(user_data->notif_iter);
733 g_free(user_data);
734 }
735}
736
737static
36712f1d 738void create_source_sink(struct bt_graph *graph, struct bt_component **source,
223c70b2
PP
739 struct bt_component **sink)
740{
741 struct bt_component_class *src_comp_class;
742 struct bt_component_class *sink_comp_class;
743 int ret;
744
745 /* Create source component */
e893886e
PP
746 if (source) {
747 src_comp_class = bt_component_class_source_create("src",
748 src_iter_next);
25583cd0 749 BT_ASSERT(src_comp_class);
e893886e
PP
750 ret = bt_component_class_set_init_method(src_comp_class,
751 src_init);
25583cd0 752 BT_ASSERT(ret == 0);
e893886e
PP
753 ret = bt_component_class_set_finalize_method(src_comp_class,
754 src_finalize);
25583cd0 755 BT_ASSERT(ret == 0);
e893886e
PP
756 ret = bt_component_class_source_set_notification_iterator_init_method(
757 src_comp_class, src_iter_init);
25583cd0 758 BT_ASSERT(ret == 0);
e893886e
PP
759 ret = bt_component_class_source_set_notification_iterator_finalize_method(
760 src_comp_class, src_iter_finalize);
25583cd0 761 BT_ASSERT(ret == 0);
e893886e
PP
762 ret = bt_graph_add_component(graph, src_comp_class, "source",
763 NULL, source);
25583cd0 764 BT_ASSERT(ret == 0);
e893886e
PP
765 bt_put(src_comp_class);
766 }
223c70b2
PP
767
768 /* Create sink component */
e893886e
PP
769 if (sink) {
770 sink_comp_class = bt_component_class_sink_create("sink",
771 sink_consume);
25583cd0 772 BT_ASSERT(sink_comp_class);
e893886e
PP
773 ret = bt_component_class_set_init_method(sink_comp_class,
774 sink_init);
25583cd0 775 BT_ASSERT(ret == 0);
e893886e
PP
776 ret = bt_component_class_set_finalize_method(sink_comp_class,
777 sink_finalize);
778 ret = bt_component_class_set_port_connected_method(
779 sink_comp_class, sink_port_connected);
25583cd0 780 BT_ASSERT(ret == 0);
e893886e
PP
781 ret = bt_graph_add_component(graph, sink_comp_class, "sink",
782 NULL, sink);
25583cd0 783 BT_ASSERT(ret == 0);
e893886e
PP
784 bt_put(sink_comp_class);
785 }
223c70b2
PP
786}
787
788static
789void do_std_test(enum test test, const char *name,
790 const struct test_event *expected_test_events)
791{
792 struct bt_component *src_comp;
793 struct bt_component *sink_comp;
794 struct bt_port *upstream_port;
795 struct bt_port *downstream_port;
223c70b2
PP
796 enum bt_graph_status graph_status = BT_GRAPH_STATUS_OK;
797
798 clear_test_events();
799 current_test = test;
800 diag("test: %s", name);
25583cd0 801 BT_ASSERT(!graph);
223c70b2 802 graph = bt_graph_create();
25583cd0 803 BT_ASSERT(graph);
36712f1d 804 create_source_sink(graph, &src_comp, &sink_comp);
223c70b2
PP
805
806 /* Connect source to sink */
b9d103be 807 upstream_port = bt_component_source_get_output_port_by_name(src_comp, "out");
25583cd0 808 BT_ASSERT(upstream_port);
b9d103be 809 downstream_port = bt_component_sink_get_input_port_by_name(sink_comp, "in");
25583cd0 810 BT_ASSERT(downstream_port);
a256a42d
PP
811 graph_status = bt_graph_connect_ports(graph, upstream_port,
812 downstream_port, NULL);
223c70b2
PP
813 bt_put(upstream_port);
814 bt_put(downstream_port);
815
816 /* Run the graph until the end */
817 while (graph_status == BT_GRAPH_STATUS_OK ||
818 graph_status == BT_GRAPH_STATUS_AGAIN) {
819 graph_status = bt_graph_run(graph);
820 }
821
822 ok(graph_status == BT_GRAPH_STATUS_END, "graph finishes without any error");
823
824 /* Compare the resulting test events */
825 if (expected_test_events) {
826 ok(compare_test_events(expected_test_events),
827 "the produced sequence of test events is the expected one");
828 }
829
830 bt_put(src_comp);
831 bt_put(sink_comp);
5c563278 832 BT_PUT(graph);
223c70b2
PP
833}
834
835static
836void test_no_auto_notifs(void)
837{
838 const struct test_event expected_test_events[] = {
839 { .type = TEST_EV_TYPE_NOTIF_STREAM_BEGIN, .stream = src_stream1, .packet = NULL, },
840 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream1, .packet = src_stream1_packet1, },
841 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
842 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
843 { .type = TEST_EV_TYPE_NOTIF_STREAM_BEGIN, .stream = src_stream2, .packet = NULL, },
844 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
845 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream2, .packet = src_stream2_packet2, },
846 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream2, .packet = src_stream2_packet2, },
847 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
848 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream1, .packet = src_stream1_packet1, },
849 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream2, .packet = src_stream2_packet2, },
850 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream1, .packet = src_stream1_packet2, },
851 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet2, },
852 { .type = TEST_EV_TYPE_NOTIF_STREAM_END, .stream = src_stream2, .packet = NULL, },
853 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream1, .packet = src_stream1_packet2, },
854 { .type = TEST_EV_TYPE_NOTIF_STREAM_END, .stream = src_stream1, .packet = NULL, },
855 { .type = TEST_EV_TYPE_END, },
856 { .type = TEST_EV_TYPE_SENTINEL, },
857 };
858
859 do_std_test(TEST_NO_AUTO_NOTIFS, "no automatic notifications",
860 expected_test_events);
861}
862
e893886e
PP
863static
864void test_output_port_notification_iterator(void)
865{
866 const struct test_event expected_test_events[] = {
867 { .type = TEST_EV_TYPE_NOTIF_STREAM_BEGIN, .stream = src_stream1, .packet = NULL, },
868 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream1, .packet = src_stream1_packet1, },
869 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
870 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
871 { .type = TEST_EV_TYPE_NOTIF_STREAM_BEGIN, .stream = src_stream2, .packet = NULL, },
872 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
873 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream2, .packet = src_stream2_packet2, },
874 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream2, .packet = src_stream2_packet2, },
875 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
876 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream1, .packet = src_stream1_packet1, },
877 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream2, .packet = src_stream2_packet2, },
878 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream1, .packet = src_stream1_packet2, },
879 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet2, },
880 { .type = TEST_EV_TYPE_NOTIF_STREAM_END, .stream = src_stream2, .packet = NULL, },
881 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream1, .packet = src_stream1_packet2, },
882 { .type = TEST_EV_TYPE_NOTIF_STREAM_END, .stream = src_stream1, .packet = NULL, },
883 { .type = TEST_EV_TYPE_END, },
884 { .type = TEST_EV_TYPE_SENTINEL, },
885 };
886 struct bt_component *src_comp;
887 struct bt_notification_iterator *notif_iter;
888 enum bt_notification_iterator_status iter_status =
889 BT_NOTIFICATION_ITERATOR_STATUS_OK;
890 struct bt_port *upstream_port;
e893886e
PP
891
892 clear_test_events();
893 current_test = TEST_OUTPUT_PORT_NOTIFICATION_ITERATOR;
894 diag("test: output port notification iterator");
25583cd0 895 BT_ASSERT(!graph);
e893886e 896 graph = bt_graph_create();
25583cd0 897 BT_ASSERT(graph);
e893886e
PP
898 create_source_sink(graph, &src_comp, NULL);
899
900 /* Create notification iterator on source's output port */
901 upstream_port = bt_component_source_get_output_port_by_name(src_comp, "out");
902 notif_iter = bt_output_port_notification_iterator_create(upstream_port,
f42867e2 903 NULL);
e893886e
PP
904 ok(notif_iter, "bt_output_port_notification_iterator_create() succeeds");
905 bt_put(upstream_port);
906
907 /* Consume the notification iterator */
908 while (iter_status == BT_NOTIFICATION_ITERATOR_STATUS_OK) {
07245ac2 909 iter_status = common_consume(notif_iter, true);
e893886e
PP
910 }
911
912 ok(iter_status == BT_NOTIFICATION_ITERATOR_STATUS_END,
913 "output port notification iterator finishes without any error");
914
915 /* Compare the resulting test events */
916 ok(compare_test_events(expected_test_events),
917 "the produced sequence of test events is the expected one");
918
919 bt_put(src_comp);
5c563278 920 BT_PUT(graph);
e893886e
PP
921 bt_put(notif_iter);
922}
923
924static
925void test_output_port_notification_iterator_cannot_consume(void)
926{
927 struct bt_component *src_comp;
928 struct bt_notification_iterator *notif_iter;
929 struct bt_port *upstream_port;
e893886e
PP
930
931 clear_test_events();
932 current_test = TEST_OUTPUT_PORT_NOTIFICATION_ITERATOR;
933 diag("test: cannot consume graph with existing output port notification iterator");
25583cd0 934 BT_ASSERT(!graph);
e893886e 935 graph = bt_graph_create();
25583cd0 936 BT_ASSERT(graph);
e893886e
PP
937 create_source_sink(graph, &src_comp, NULL);
938
939 /* Create notification iterator on source's output port */
940 upstream_port = bt_component_source_get_output_port_by_name(src_comp, "out");
941 notif_iter = bt_output_port_notification_iterator_create(upstream_port,
f42867e2 942 NULL);
25583cd0 943 BT_ASSERT(notif_iter);
e893886e
PP
944 bt_put(upstream_port);
945
946 /*
947 * This should fail because the graph is now managed by the
948 * notification iterator.
949 */
950 ok(bt_graph_run(graph) == BT_GRAPH_STATUS_CANNOT_CONSUME,
951 "bt_graph_run() returns BT_GRAPH_STATUS_CANNOT_CONSUME when there's an output port notification iterator");
952
953 bt_put(src_comp);
5c563278 954 BT_PUT(graph);
e893886e
PP
955 bt_put(notif_iter);
956}
957
223c70b2
PP
958#define DEBUG_ENV_VAR "TEST_BT_NOTIFICATION_ITERATOR_DEBUG"
959
960int main(int argc, char **argv)
961{
962 if (getenv(DEBUG_ENV_VAR) && strcmp(getenv(DEBUG_ENV_VAR), "1") == 0) {
963 debug = true;
964 }
965
966 plan_tests(NR_TESTS);
967 init_static_data();
968 test_no_auto_notifs();
e893886e 969 test_output_port_notification_iterator();
e893886e 970 test_output_port_notification_iterator_cannot_consume();
223c70b2
PP
971 fini_static_data();
972 return exit_status();
973}
This page took 0.074541 seconds and 4 git commands to generate.