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