tests/lib/test_bt_notification_iterator.c

   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>
  21 #include <stdbool.h>
  22 #include <inttypes.h>
  23 #include <string.h>
  24 #include <babeltrace/assert-internal.h>
  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>
  41 #include <babeltrace/graph/connection.h>
  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>
  48 #include <babeltrace/graph/output-port-notification-iterator.h>
  49 #include <babeltrace/graph/port.h>
  50 #include <babeltrace/graph/private-component-source.h>
  51 #include <babeltrace/graph/private-component-sink.h>
  52 #include <babeltrace/graph/private-component.h>
  53 #include <babeltrace/graph/private-connection.h>
  54 #include <babeltrace/graph/private-connection-notification-iterator.h>
  55 #include <babeltrace/graph/private-connection-private-notification-iterator.h>
  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
  63 #define NR_TESTS        5
  64
  65 enum test {
  66         TEST_NO_AUTO_NOTIFS,
  67         TEST_OUTPUT_PORT_NOTIFICATION_ITERATOR,
  68 };
  69
  70 enum 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
  82 struct test_event {
  83         enum test_event_type type;
  84         struct bt_stream *stream;
  85         struct bt_packet *packet;
  86 };
  87
  88 static bool debug = false;
  89 static enum test current_test;
  90 static GArray *test_events;
  91 static struct bt_graph *graph;
  92 static struct bt_clock_class_priority_map *src_empty_cc_prio_map;
  93 static struct bt_stream_class *src_stream_class;
  94 static struct bt_event_class *src_event_class;
  95 static struct bt_stream *src_stream1;
  96 static struct bt_stream *src_stream2;
  97 static struct bt_packet *src_stream1_packet1;
  98 static struct bt_packet *src_stream1_packet2;
  99 static struct bt_packet *src_stream2_packet1;
 100 static struct bt_packet *src_stream2_packet2;
 101
 102 enum {
 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
 123 struct src_iter_user_data {
 124         int64_t *seq;
 125         size_t at;
 126 };
 127
 128 struct 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  */
 136 static 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
 156 static
 157 void clear_test_events(void)
 158 {
 159         g_array_set_size(test_events, 0);
 160 }
 161
 162 static
 163 void 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
 204 static
 205 void append_test_event(struct test_event *event)
 206 {
 207         g_array_append_val(test_events, *event);
 208 }
 209
 210 static
 211 bool 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
 244 static
 245 bool 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
 250         BT_ASSERT(expected_events);
 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
 280 static
 281 void init_static_data(void)
 282 {
 283         int ret;
 284         struct bt_trace *trace;
 285         struct bt_field_type *empty_struct_ft;
 286
 287         /* Test events */
 288         test_events = g_array_new(FALSE, TRUE, sizeof(struct test_event));
 289         BT_ASSERT(test_events);
 290
 291         /* Metadata */
 292         empty_struct_ft = bt_field_type_structure_create();
 293         BT_ASSERT(empty_struct_ft);
 294         trace = bt_trace_create();
 295         BT_ASSERT(trace);
 296         ret = bt_trace_set_packet_header_field_type(trace, empty_struct_ft);
 297         BT_ASSERT(ret == 0);
 298         src_empty_cc_prio_map = bt_clock_class_priority_map_create();
 299         BT_ASSERT(src_empty_cc_prio_map);
 300         src_stream_class = bt_stream_class_create("my-stream-class");
 301         BT_ASSERT(src_stream_class);
 302         ret = bt_stream_class_set_packet_context_field_type(src_stream_class,
 303                 empty_struct_ft);
 304         BT_ASSERT(ret == 0);
 305         ret = bt_stream_class_set_event_header_field_type(src_stream_class,
 306                 empty_struct_ft);
 307         BT_ASSERT(ret == 0);
 308         ret = bt_stream_class_set_event_context_field_type(src_stream_class,
 309                 empty_struct_ft);
 310         BT_ASSERT(ret == 0);
 311         src_event_class = bt_event_class_create("my-event-class");
 312         ret = bt_event_class_set_context_field_type(src_event_class,
 313                 empty_struct_ft);
 314         BT_ASSERT(ret == 0);
 315         ret = bt_event_class_set_payload_field_type(src_event_class,
 316                 empty_struct_ft);
 317         BT_ASSERT(ret == 0);
 318         ret = bt_stream_class_add_event_class(src_stream_class,
 319                 src_event_class);
 320         BT_ASSERT(ret == 0);
 321         ret = bt_trace_add_stream_class(trace, src_stream_class);
 322         BT_ASSERT(ret == 0);
 323         src_stream1 = bt_stream_create(src_stream_class, "stream-1", 0);
 324         BT_ASSERT(src_stream1);
 325         src_stream2 = bt_stream_create(src_stream_class, "stream-2", 1);
 326         BT_ASSERT(src_stream2);
 327         src_stream1_packet1 = bt_packet_create(src_stream1);
 328         BT_ASSERT(src_stream1_packet1);
 329         src_stream1_packet2 = bt_packet_create(src_stream1);
 330         BT_ASSERT(src_stream1_packet2);
 331         src_stream2_packet1 = bt_packet_create(src_stream2);
 332         BT_ASSERT(src_stream2_packet1);
 333         src_stream2_packet2 = bt_packet_create(src_stream2);
 334         BT_ASSERT(src_stream2_packet2);
 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
 349 static
 350 void 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
 367 static
 368 void src_iter_finalize(
 369                 struct bt_private_connection_private_notification_iterator *private_notification_iterator)
 370 {
 371         struct src_iter_user_data *user_data =
 372                 bt_private_connection_private_notification_iterator_get_user_data(
 373                         private_notification_iterator);
 374
 375         if (user_data) {
 376                 g_free(user_data);
 377         }
 378 }
 379
 380 static
 381 enum bt_notification_iterator_status src_iter_init(
 382                 struct bt_private_connection_private_notification_iterator *priv_notif_iter,
 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
 389         BT_ASSERT(user_data);
 390         ret = bt_private_connection_private_notification_iterator_set_user_data(
 391                 priv_notif_iter, user_data);
 392         BT_ASSERT(ret == 0);
 393
 394         switch (current_test) {
 395         case TEST_NO_AUTO_NOTIFS:
 396         case TEST_OUTPUT_PORT_NOTIFICATION_ITERATOR:
 397                 user_data->seq = seq_no_auto_notifs;
 398                 break;
 399         default:
 400                 abort();
 401         }
 402
 403         return BT_NOTIFICATION_ITERATOR_STATUS_OK;
 404 }
 405
 406 static
 407 void src_iter_next_seq_one(struct src_iter_user_data *user_data,
 408                 struct bt_notification **notif)
 409 {
 410         struct bt_packet *event_packet = NULL;
 411
 412         switch (user_data->seq[user_data->at]) {
 413         case SEQ_INACTIVITY:
 414                 *notif = bt_notification_inactivity_create(graph,
 415                                 src_empty_cc_prio_map);
 416                 break;
 417         case SEQ_STREAM1_BEGIN:
 418                 *notif = bt_notification_stream_begin_create(graph,
 419                         src_stream1);
 420                 break;
 421         case SEQ_STREAM2_BEGIN:
 422                 *notif = bt_notification_stream_begin_create(graph,
 423                         src_stream2);
 424                 break;
 425         case SEQ_STREAM1_END:
 426                 *notif = bt_notification_stream_end_create(graph, src_stream1);
 427                 break;
 428         case SEQ_STREAM2_END:
 429                 *notif = bt_notification_stream_end_create(graph, src_stream2);
 430                 break;
 431         case SEQ_STREAM1_PACKET1_BEGIN:
 432                 *notif = bt_notification_packet_begin_create(graph,
 433                         src_stream1_packet1);
 434                 break;
 435         case SEQ_STREAM1_PACKET2_BEGIN:
 436                 *notif = bt_notification_packet_begin_create(graph,
 437                         src_stream1_packet2);
 438                 break;
 439         case SEQ_STREAM2_PACKET1_BEGIN:
 440                 *notif = bt_notification_packet_begin_create(graph,
 441                         src_stream2_packet1);
 442                 break;
 443         case SEQ_STREAM2_PACKET2_BEGIN:
 444                 *notif = bt_notification_packet_begin_create(graph,
 445                         src_stream2_packet2);
 446                 break;
 447         case SEQ_STREAM1_PACKET1_END:
 448                 *notif = bt_notification_packet_end_create(graph,
 449                         src_stream1_packet1);
 450                 break;
 451         case SEQ_STREAM1_PACKET2_END:
 452                 *notif = bt_notification_packet_end_create(graph,
 453                         src_stream1_packet2);
 454                 break;
 455         case SEQ_STREAM2_PACKET1_END:
 456                 *notif = bt_notification_packet_end_create(graph,
 457                         src_stream2_packet1);
 458                 break;
 459         case SEQ_STREAM2_PACKET2_END:
 460                 *notif = bt_notification_packet_end_create(graph,
 461                         src_stream2_packet2);
 462                 break;
 463         case SEQ_EVENT_STREAM1_PACKET1:
 464                 event_packet = src_stream1_packet1;
 465                 break;
 466         case SEQ_EVENT_STREAM1_PACKET2:
 467                 event_packet = src_stream1_packet2;
 468                 break;
 469         case SEQ_EVENT_STREAM2_PACKET1:
 470                 event_packet = src_stream2_packet1;
 471                 break;
 472         case SEQ_EVENT_STREAM2_PACKET2:
 473                 event_packet = src_stream2_packet2;
 474                 break;
 475         default:
 476                 abort();
 477         }
 478
 479         if (event_packet) {
 480                 *notif = bt_notification_event_create(graph, src_event_class,
 481                         event_packet, src_empty_cc_prio_map);
 482         }
 483
 484         BT_ASSERT(*notif);
 485         user_data->at++;
 486 }
 487
 488 static
 489 enum bt_notification_iterator_status src_iter_next_seq(
 490                 struct src_iter_user_data *user_data,
 491                 bt_notification_array notifs, uint64_t capacity,
 492                 uint64_t *count)
 493 {
 494         enum bt_notification_iterator_status status =
 495                 BT_NOTIFICATION_ITERATOR_STATUS_OK;
 496         uint64_t i = 0;
 497
 498         BT_ASSERT(user_data->seq);
 499
 500         if (user_data->seq[user_data->at] == SEQ_END) {
 501                 status = BT_NOTIFICATION_ITERATOR_STATUS_END;
 502                 goto end;
 503         }
 504
 505         while (i < capacity && user_data->seq[user_data->at] != SEQ_END) {
 506                 src_iter_next_seq_one(user_data, &notifs[i]);
 507                 i++;
 508         }
 509
 510         BT_ASSERT(i > 0 && i <= capacity);
 511         *count = i;
 512
 513 end:
 514         return status;
 515 }
 516
 517 static
 518 enum bt_notification_iterator_status src_iter_next(
 519                 struct bt_private_connection_private_notification_iterator *priv_iterator,
 520                 bt_notification_array notifs, uint64_t capacity,
 521                 uint64_t *count)
 522 {
 523         struct src_iter_user_data *user_data =
 524                 bt_private_connection_private_notification_iterator_get_user_data(priv_iterator);
 525
 526         BT_ASSERT(user_data);
 527         return src_iter_next_seq(user_data, notifs, capacity, count);
 528 }
 529
 530 static
 531 enum bt_component_status src_init(
 532                 struct bt_private_component *private_component,
 533                 struct bt_value *params, void *init_method_data)
 534 {
 535         int ret;
 536
 537         ret = bt_private_component_source_add_output_private_port(
 538                 private_component, "out", NULL, NULL);
 539         BT_ASSERT(ret == 0);
 540         return BT_COMPONENT_STATUS_OK;
 541 }
 542
 543 static
 544 void src_finalize(struct bt_private_component *private_component)
 545 {
 546 }
 547
 548 static
 549 void append_test_events_from_notification(struct bt_notification *notification)
 550 {
 551         struct test_event test_event = { 0 };
 552
 553         switch (bt_notification_get_type(notification)) {
 554         case BT_NOTIFICATION_TYPE_EVENT:
 555         {
 556                 struct bt_event *event;
 557
 558                 test_event.type = TEST_EV_TYPE_NOTIF_EVENT;
 559                 event = bt_notification_event_borrow_event(notification);
 560                 BT_ASSERT(event);
 561                 test_event.packet = bt_event_borrow_packet(event);
 562                 BT_ASSERT(test_event.packet);
 563                 break;
 564         }
 565         case BT_NOTIFICATION_TYPE_INACTIVITY:
 566                 test_event.type = TEST_EV_TYPE_NOTIF_INACTIVITY;
 567                 break;
 568         case BT_NOTIFICATION_TYPE_STREAM_BEGIN:
 569                 test_event.type = TEST_EV_TYPE_NOTIF_STREAM_BEGIN;
 570                 test_event.stream =
 571                         bt_notification_stream_begin_borrow_stream(notification);
 572                 BT_ASSERT(test_event.stream);
 573                 break;
 574         case BT_NOTIFICATION_TYPE_STREAM_END:
 575                 test_event.type = TEST_EV_TYPE_NOTIF_STREAM_END;
 576                 test_event.stream =
 577                         bt_notification_stream_end_borrow_stream(notification);
 578                 BT_ASSERT(test_event.stream);
 579                 break;
 580         case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
 581                 test_event.type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN;
 582                 test_event.packet =
 583                         bt_notification_packet_begin_borrow_packet(notification);
 584                 BT_ASSERT(test_event.packet);
 585                 break;
 586         case BT_NOTIFICATION_TYPE_PACKET_END:
 587                 test_event.type = TEST_EV_TYPE_NOTIF_PACKET_END;
 588                 test_event.packet =
 589                         bt_notification_packet_end_borrow_packet(notification);
 590                 BT_ASSERT(test_event.packet);
 591                 break;
 592         default:
 593                 test_event.type = TEST_EV_TYPE_NOTIF_UNEXPECTED;
 594                 break;
 595         }
 596
 597         if (test_event.packet) {
 598                 test_event.stream = bt_packet_borrow_stream(test_event.packet);
 599                 BT_ASSERT(test_event.stream);
 600         }
 601
 602         append_test_event(&test_event);
 603 }
 604
 605 static
 606 enum bt_notification_iterator_status common_consume(
 607                 struct bt_notification_iterator *notif_iter,
 608                 bool is_output_port_notif_iter)
 609 {
 610         enum bt_notification_iterator_status ret;
 611         bt_notification_array notifications = NULL;
 612         uint64_t count = 0;
 613         struct test_event test_event = { 0 };
 614         uint64_t i;
 615
 616         BT_ASSERT(notif_iter);
 617
 618         if (is_output_port_notif_iter) {
 619                 ret = bt_output_port_notification_iterator_next(notif_iter,
 620                         &notifications, &count);
 621         } else {
 622                 ret = bt_private_connection_notification_iterator_next(
 623                         notif_iter, &notifications, &count);
 624         }
 625
 626         if (ret < 0) {
 627                 goto end;
 628         }
 629
 630         switch (ret) {
 631         case BT_NOTIFICATION_ITERATOR_STATUS_END:
 632                 test_event.type = TEST_EV_TYPE_END;
 633                 append_test_event(&test_event);
 634                 goto end;
 635         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 636                 abort();
 637         default:
 638                 break;
 639         }
 640
 641         BT_ASSERT(notifications);
 642         BT_ASSERT(count > 0);
 643
 644         for (i = 0; i < count; i++) {
 645                 append_test_events_from_notification(notifications[i]);
 646                 bt_put(notifications[i]);
 647         }
 648
 649 end:
 650         return ret;
 651 }
 652
 653 static
 654 enum bt_component_status sink_consume(
 655                 struct bt_private_component *priv_component)
 656 {
 657         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 658         struct sink_user_data *user_data =
 659                 bt_private_component_get_user_data(priv_component);
 660         enum bt_notification_iterator_status it_ret;
 661
 662         BT_ASSERT(user_data && user_data->notif_iter);
 663         it_ret = common_consume(user_data->notif_iter, false);
 664
 665         if (it_ret < 0) {
 666                 ret = BT_COMPONENT_STATUS_ERROR;
 667                 goto end;
 668         }
 669
 670         switch (it_ret) {
 671         case BT_NOTIFICATION_ITERATOR_STATUS_END:
 672                 ret = BT_COMPONENT_STATUS_END;
 673                 BT_PUT(user_data->notif_iter);
 674                 goto end;
 675         case BT_NOTIFICATION_ITERATOR_STATUS_AGAIN:
 676                 abort();
 677         default:
 678                 break;
 679         }
 680
 681 end:
 682         return ret;
 683 }
 684
 685 static
 686 enum bt_component_status sink_port_connected(
 687                 struct bt_private_component *private_component,
 688                 struct bt_private_port *self_private_port,
 689                 struct bt_port *other_port)
 690 {
 691         struct bt_private_connection *priv_conn =
 692                 bt_private_port_get_private_connection(self_private_port);
 693         struct sink_user_data *user_data = bt_private_component_get_user_data(
 694                 private_component);
 695         enum bt_connection_status conn_status;
 696
 697         BT_ASSERT(user_data);
 698         BT_ASSERT(priv_conn);
 699         conn_status = bt_private_connection_create_notification_iterator(
 700                 priv_conn, &user_data->notif_iter);
 701         BT_ASSERT(conn_status == 0);
 702         bt_put(priv_conn);
 703         return BT_COMPONENT_STATUS_OK;
 704 }
 705
 706 static
 707 enum bt_component_status sink_init(
 708                 struct bt_private_component *private_component,
 709                 struct bt_value *params, void *init_method_data)
 710 {
 711         struct sink_user_data *user_data = g_new0(struct sink_user_data, 1);
 712         int ret;
 713
 714         BT_ASSERT(user_data);
 715         ret = bt_private_component_set_user_data(private_component,
 716                 user_data);
 717         BT_ASSERT(ret == 0);
 718         ret = bt_private_component_sink_add_input_private_port(
 719                 private_component, "in", NULL, NULL);
 720         BT_ASSERT(ret == 0);
 721         return BT_COMPONENT_STATUS_OK;
 722 }
 723
 724 static
 725 void sink_finalize(struct bt_private_component *private_component)
 726 {
 727         struct sink_user_data *user_data = bt_private_component_get_user_data(
 728                 private_component);
 729
 730         if (user_data) {
 731                 bt_put(user_data->notif_iter);
 732                 g_free(user_data);
 733         }
 734 }
 735
 736 static
 737 void create_source_sink(struct bt_graph *graph, struct bt_component **source,
 738                 struct bt_component **sink)
 739 {
 740         struct bt_component_class *src_comp_class;
 741         struct bt_component_class *sink_comp_class;
 742         int ret;
 743
 744         /* Create source component */
 745         if (source) {
 746                 src_comp_class = bt_component_class_source_create("src",
 747                         src_iter_next);
 748                 BT_ASSERT(src_comp_class);
 749                 ret = bt_component_class_set_init_method(src_comp_class,
 750                         src_init);
 751                 BT_ASSERT(ret == 0);
 752                 ret = bt_component_class_set_finalize_method(src_comp_class,
 753                         src_finalize);
 754                 BT_ASSERT(ret == 0);
 755                 ret = bt_component_class_source_set_notification_iterator_init_method(
 756                         src_comp_class, src_iter_init);
 757                 BT_ASSERT(ret == 0);
 758                 ret = bt_component_class_source_set_notification_iterator_finalize_method(
 759                         src_comp_class, src_iter_finalize);
 760                 BT_ASSERT(ret == 0);
 761                 ret = bt_graph_add_component(graph, src_comp_class, "source",
 762                         NULL, source);
 763                 BT_ASSERT(ret == 0);
 764                 bt_put(src_comp_class);
 765         }
 766
 767         /* Create sink component */
 768         if (sink) {
 769                 sink_comp_class = bt_component_class_sink_create("sink",
 770                         sink_consume);
 771                 BT_ASSERT(sink_comp_class);
 772                 ret = bt_component_class_set_init_method(sink_comp_class,
 773                         sink_init);
 774                 BT_ASSERT(ret == 0);
 775                 ret = bt_component_class_set_finalize_method(sink_comp_class,
 776                         sink_finalize);
 777                 ret = bt_component_class_set_port_connected_method(
 778                         sink_comp_class, sink_port_connected);
 779                 BT_ASSERT(ret == 0);
 780                 ret = bt_graph_add_component(graph, sink_comp_class, "sink",
 781                         NULL, sink);
 782                 BT_ASSERT(ret == 0);
 783                 bt_put(sink_comp_class);
 784         }
 785 }
 786
 787 static
 788 void do_std_test(enum test test, const char *name,
 789                 const struct test_event *expected_test_events)
 790 {
 791         struct bt_component *src_comp;
 792         struct bt_component *sink_comp;
 793         struct bt_port *upstream_port;
 794         struct bt_port *downstream_port;
 795         enum bt_graph_status graph_status = BT_GRAPH_STATUS_OK;
 796
 797         clear_test_events();
 798         current_test = test;
 799         diag("test: %s", name);
 800         BT_ASSERT(!graph);
 801         graph = bt_graph_create();
 802         BT_ASSERT(graph);
 803         create_source_sink(graph, &src_comp, &sink_comp);
 804
 805         /* Connect source to sink */
 806         upstream_port = bt_component_source_get_output_port_by_name(src_comp, "out");
 807         BT_ASSERT(upstream_port);
 808         downstream_port = bt_component_sink_get_input_port_by_name(sink_comp, "in");
 809         BT_ASSERT(downstream_port);
 810         graph_status = bt_graph_connect_ports(graph, upstream_port,
 811                 downstream_port, NULL);
 812         bt_put(upstream_port);
 813         bt_put(downstream_port);
 814
 815         /* Run the graph until the end */
 816         while (graph_status == BT_GRAPH_STATUS_OK ||
 817                         graph_status == BT_GRAPH_STATUS_AGAIN) {
 818                 graph_status = bt_graph_run(graph);
 819         }
 820
 821         ok(graph_status == BT_GRAPH_STATUS_END, "graph finishes without any error");
 822
 823         /* Compare the resulting test events */
 824         if (expected_test_events) {
 825                 ok(compare_test_events(expected_test_events),
 826                         "the produced sequence of test events is the expected one");
 827         }
 828
 829         bt_put(src_comp);
 830         bt_put(sink_comp);
 831         BT_PUT(graph);
 832 }
 833
 834 static
 835 void test_no_auto_notifs(void)
 836 {
 837         const struct test_event expected_test_events[] = {
 838                 { .type = TEST_EV_TYPE_NOTIF_STREAM_BEGIN, .stream = src_stream1, .packet = NULL, },
 839                 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream1, .packet = src_stream1_packet1, },
 840                 { .type = TEST_EV_TYPE_NOTIF_EVENT, .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_STREAM_BEGIN, .stream = src_stream2, .packet = NULL, },
 843                 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
 844                 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream2, .packet = src_stream2_packet2, },
 845                 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream2, .packet = src_stream2_packet2, },
 846                 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
 847                 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream1, .packet = src_stream1_packet1, },
 848                 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream2, .packet = src_stream2_packet2, },
 849                 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream1, .packet = src_stream1_packet2, },
 850                 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet2, },
 851                 { .type = TEST_EV_TYPE_NOTIF_STREAM_END, .stream = src_stream2, .packet = NULL, },
 852                 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream1, .packet = src_stream1_packet2, },
 853                 { .type = TEST_EV_TYPE_NOTIF_STREAM_END, .stream = src_stream1, .packet = NULL, },
 854                 { .type = TEST_EV_TYPE_END, },
 855                 { .type = TEST_EV_TYPE_SENTINEL, },
 856         };
 857
 858         do_std_test(TEST_NO_AUTO_NOTIFS, "no automatic notifications",
 859                 expected_test_events);
 860 }
 861
 862 static
 863 void test_output_port_notification_iterator(void)
 864 {
 865         const struct test_event expected_test_events[] = {
 866                 { .type = TEST_EV_TYPE_NOTIF_STREAM_BEGIN, .stream = src_stream1, .packet = NULL, },
 867                 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream1, .packet = src_stream1_packet1, },
 868                 { .type = TEST_EV_TYPE_NOTIF_EVENT, .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_STREAM_BEGIN, .stream = src_stream2, .packet = NULL, },
 871                 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
 872                 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream2, .packet = src_stream2_packet2, },
 873                 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream2, .packet = src_stream2_packet2, },
 874                 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet1, },
 875                 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream1, .packet = src_stream1_packet1, },
 876                 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream2, .packet = src_stream2_packet2, },
 877                 { .type = TEST_EV_TYPE_NOTIF_PACKET_BEGIN, .stream = src_stream1, .packet = src_stream1_packet2, },
 878                 { .type = TEST_EV_TYPE_NOTIF_EVENT, .stream = src_stream1, .packet = src_stream1_packet2, },
 879                 { .type = TEST_EV_TYPE_NOTIF_STREAM_END, .stream = src_stream2, .packet = NULL, },
 880                 { .type = TEST_EV_TYPE_NOTIF_PACKET_END, .stream = src_stream1, .packet = src_stream1_packet2, },
 881                 { .type = TEST_EV_TYPE_NOTIF_STREAM_END, .stream = src_stream1, .packet = NULL, },
 882                 { .type = TEST_EV_TYPE_END, },
 883                 { .type = TEST_EV_TYPE_SENTINEL, },
 884         };
 885         struct bt_component *src_comp;
 886         struct bt_notification_iterator *notif_iter;
 887         enum bt_notification_iterator_status iter_status =
 888                 BT_NOTIFICATION_ITERATOR_STATUS_OK;
 889         struct bt_port *upstream_port;
 890
 891         clear_test_events();
 892         current_test = TEST_OUTPUT_PORT_NOTIFICATION_ITERATOR;
 893         diag("test: output port notification iterator");
 894         BT_ASSERT(!graph);
 895         graph = bt_graph_create();
 896         BT_ASSERT(graph);
 897         create_source_sink(graph, &src_comp, NULL);
 898
 899         /* Create notification iterator on source's output port */
 900         upstream_port = bt_component_source_get_output_port_by_name(src_comp, "out");
 901         notif_iter = bt_output_port_notification_iterator_create(upstream_port,
 902                 NULL);
 903         ok(notif_iter, "bt_output_port_notification_iterator_create() succeeds");
 904         bt_put(upstream_port);
 905
 906         /* Consume the notification iterator */
 907         while (iter_status == BT_NOTIFICATION_ITERATOR_STATUS_OK) {
 908                 iter_status = common_consume(notif_iter, true);
 909         }
 910
 911         ok(iter_status == BT_NOTIFICATION_ITERATOR_STATUS_END,
 912                 "output port notification iterator finishes without any error");
 913
 914         /* Compare the resulting test events */
 915         ok(compare_test_events(expected_test_events),
 916                 "the produced sequence of test events is the expected one");
 917
 918         bt_put(src_comp);
 919         BT_PUT(graph);
 920         bt_put(notif_iter);
 921 }
 922
 923 #define DEBUG_ENV_VAR   "TEST_BT_NOTIFICATION_ITERATOR_DEBUG"
 924
 925 int main(int argc, char **argv)
 926 {
 927         if (getenv(DEBUG_ENV_VAR) && strcmp(getenv(DEBUG_ENV_VAR), "1") == 0) {
 928                 debug = true;
 929         }
 930
 931         plan_tests(NR_TESTS);
 932         init_static_data();
 933         test_no_auto_notifs();
 934         test_output_port_notification_iterator();
 935         fini_static_data();
 936         return exit_status();
 937 }