plugins/text/dmesg/dmesg.c

   1 /*
   2  * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
   3  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "PLUGIN-TEXT-DMESG-SRC"
  25 #include "logging.h"
  26
  27 #include <stdbool.h>
  28 #include <string.h>
  29 #include <ctype.h>
  30 #include <stdio.h>
  31 #include <babeltrace/assert-internal.h>
  32 #include <babeltrace/common-internal.h>
  33 #include <babeltrace/babeltrace.h>
  34 #include <babeltrace/values-internal.h>
  35 #include <babeltrace/compat/utc-internal.h>
  36 #include <babeltrace/compat/stdio-internal.h>
  37 #include <glib.h>
  38
  39 #define NSEC_PER_USEC 1000UL
  40 #define NSEC_PER_MSEC 1000000UL
  41 #define NSEC_PER_SEC 1000000000ULL
  42 #define USEC_PER_SEC 1000000UL
  43
  44 struct dmesg_component;
  45
  46 struct dmesg_notif_iter {
  47         struct dmesg_component *dmesg_comp;
  48         struct bt_self_notification_iterator *pc_notif_iter; /* Weak */
  49         char *linebuf;
  50         size_t linebuf_len;
  51         FILE *fp;
  52         struct bt_private_notification *tmp_event_notif;
  53
  54         enum {
  55                 STATE_EMIT_STREAM_BEGINNING,
  56                 STATE_EMIT_PACKET_BEGINNING,
  57                 STATE_EMIT_EVENT,
  58                 STATE_EMIT_PACKET_END,
  59                 STATE_EMIT_STREAM_END,
  60                 STATE_DONE,
  61         } state;
  62 };
  63
  64 struct dmesg_component {
  65         struct {
  66                 GString *path;
  67                 bt_bool read_from_stdin;
  68                 bt_bool no_timestamp;
  69         } params;
  70
  71         struct bt_private_trace *trace;
  72         struct bt_private_stream_class *stream_class;
  73         struct bt_private_event_class *event_class;
  74         struct bt_private_stream *stream;
  75         struct bt_private_packet *packet;
  76         struct bt_private_clock_class *clock_class;
  77 };
  78
  79 static
  80 struct bt_private_field_class *create_event_payload_fc(void)
  81 {
  82         struct bt_private_field_class *root_fc = NULL;
  83         struct bt_private_field_class *fc = NULL;
  84         int ret;
  85
  86         root_fc = bt_private_field_class_structure_create();
  87         if (!root_fc) {
  88                 BT_LOGE_STR("Cannot create an empty structure field class object.");
  89                 goto error;
  90         }
  91
  92         fc = bt_private_field_class_string_create();
  93         if (!fc) {
  94                 BT_LOGE_STR("Cannot create a string field class object.");
  95                 goto error;
  96         }
  97
  98         ret = bt_private_field_class_structure_append_member(root_fc,
  99                 "str", fc);
 100         if (ret) {
 101                 BT_LOGE("Cannot add `str` member to structure field class: "
 102                         "ret=%d", ret);
 103                 goto error;
 104         }
 105
 106         goto end;
 107
 108 error:
 109         BT_OBJECT_PUT_REF_AND_RESET(root_fc);
 110
 111 end:
 112         bt_object_put_ref(fc);
 113         return root_fc;
 114 }
 115
 116 static
 117 int create_meta(struct dmesg_component *dmesg_comp, bool has_ts)
 118 {
 119         struct bt_private_field_class *fc = NULL;
 120         const char *trace_name = NULL;
 121         gchar *basename = NULL;
 122         int ret = 0;
 123
 124         dmesg_comp->trace = bt_private_trace_create();
 125         if (!dmesg_comp->trace) {
 126                 BT_LOGE_STR("Cannot create an empty trace object.");
 127                 goto error;
 128         }
 129
 130         if (dmesg_comp->params.read_from_stdin) {
 131                 trace_name = "STDIN";
 132         } else {
 133                 basename = g_path_get_basename(dmesg_comp->params.path->str);
 134                 BT_ASSERT(basename);
 135
 136                 if (strcmp(basename, G_DIR_SEPARATOR_S) != 0 &&
 137                                 strcmp(basename, ".") != 0) {
 138                         trace_name = basename;
 139                 }
 140         }
 141
 142         if (trace_name) {
 143                 ret = bt_private_trace_set_name(dmesg_comp->trace, trace_name);
 144                 if (ret) {
 145                         BT_LOGE("Cannot set trace's name: name=\"%s\"", trace_name);
 146                         goto error;
 147                 }
 148         }
 149
 150         dmesg_comp->stream_class = bt_private_stream_class_create(
 151                 dmesg_comp->trace);
 152         if (!dmesg_comp->stream_class) {
 153                 BT_LOGE_STR("Cannot create a stream class object.");
 154                 goto error;
 155         }
 156
 157         if (has_ts) {
 158                 dmesg_comp->clock_class = bt_private_clock_class_create();
 159                 if (!dmesg_comp->clock_class) {
 160                         BT_LOGE_STR("Cannot create clock class.");
 161                         goto error;
 162                 }
 163
 164                 ret = bt_private_stream_class_set_default_clock_class(
 165                         dmesg_comp->stream_class,
 166                         bt_private_clock_class_borrow_clock_class(
 167                                 dmesg_comp->clock_class));
 168                 if (ret) {
 169                         BT_LOGE_STR("Cannot set stream class's default clock class.");
 170                         goto error;
 171                 }
 172         }
 173
 174         dmesg_comp->event_class = bt_private_event_class_create(
 175                 dmesg_comp->stream_class);
 176         if (!dmesg_comp->event_class) {
 177                 BT_LOGE_STR("Cannot create an event class object.");
 178                 goto error;
 179         }
 180
 181         ret = bt_private_event_class_set_name(dmesg_comp->event_class, "string");
 182         if (ret) {
 183                 BT_LOGE_STR("Cannot set event class's name.");
 184                 goto error;
 185         }
 186
 187         fc = create_event_payload_fc();
 188         if (!fc) {
 189                 BT_LOGE_STR("Cannot create event payload field class.");
 190                 goto error;
 191         }
 192
 193         ret = bt_private_event_class_set_payload_field_class(dmesg_comp->event_class, fc);
 194         if (ret) {
 195                 BT_LOGE_STR("Cannot set event class's event payload field class.");
 196                 goto error;
 197         }
 198
 199         goto end;
 200
 201 error:
 202         ret = -1;
 203
 204 end:
 205         bt_object_put_ref(fc);
 206
 207         if (basename) {
 208                 g_free(basename);
 209         }
 210
 211         return ret;
 212 }
 213
 214 static
 215 int handle_params(struct dmesg_component *dmesg_comp, struct bt_value *params)
 216 {
 217         struct bt_value *no_timestamp = NULL;
 218         struct bt_value *path = NULL;
 219         const char *path_str;
 220         int ret = 0;
 221
 222         no_timestamp = bt_value_map_borrow_entry_value(params,
 223                 "no-extract-timestamp");
 224         if (no_timestamp) {
 225                 if (!bt_value_is_bool(no_timestamp)) {
 226                         BT_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: "
 227                                 "type=%s",
 228                                 bt_common_value_type_string(
 229                                         bt_value_get_type(no_timestamp)));
 230                         goto error;
 231                 }
 232
 233                 dmesg_comp->params.no_timestamp =
 234                         bt_value_bool_get(no_timestamp);
 235         }
 236
 237         path = bt_value_map_borrow_entry_value(params, "path");
 238         if (path) {
 239                 if (dmesg_comp->params.read_from_stdin) {
 240                         BT_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters.");
 241                         goto error;
 242                 }
 243
 244                 if (!bt_value_is_string(path)) {
 245                         BT_LOGE("Expecting a string value for the `path` parameter: "
 246                                 "type=%s",
 247                                 bt_common_value_type_string(
 248                                         bt_value_get_type(path)));
 249                         goto error;
 250                 }
 251
 252                 path_str = bt_value_string_get(path);
 253                 g_string_assign(dmesg_comp->params.path, path_str);
 254         } else {
 255                 dmesg_comp->params.read_from_stdin = true;
 256         }
 257
 258         goto end;
 259
 260 error:
 261         ret = -1;
 262
 263 end:
 264         return ret;
 265 }
 266
 267 static
 268 int create_packet_and_stream(struct dmesg_component *dmesg_comp)
 269 {
 270         int ret = 0;
 271
 272         dmesg_comp->stream = bt_private_stream_create(dmesg_comp->stream_class);
 273         if (!dmesg_comp->stream) {
 274                 BT_LOGE_STR("Cannot create stream object.");
 275                 goto error;
 276         }
 277
 278         dmesg_comp->packet = bt_private_packet_create(dmesg_comp->stream);
 279         if (!dmesg_comp->packet) {
 280                 BT_LOGE_STR("Cannot create packet object.");
 281                 goto error;
 282         }
 283
 284         ret = bt_private_trace_make_static(dmesg_comp->trace);
 285         if (ret) {
 286                 BT_LOGE_STR("Cannot make trace static.");
 287                 goto error;
 288         }
 289
 290         goto end;
 291
 292 error:
 293         ret = -1;
 294
 295 end:
 296         return ret;
 297 }
 298
 299 static
 300 int try_create_meta_stream_packet(struct dmesg_component *dmesg_comp,
 301                 bool has_ts)
 302 {
 303         int ret = 0;
 304
 305         if (dmesg_comp->trace) {
 306                 /* Already created */
 307                 goto end;
 308         }
 309
 310         ret = create_meta(dmesg_comp, has_ts);
 311         if (ret) {
 312                 BT_LOGE("Cannot create metadata objects: dmesg-comp-addr=%p",
 313                         dmesg_comp);
 314                 goto error;
 315         }
 316
 317         ret = create_packet_and_stream(dmesg_comp);
 318         if (ret) {
 319                 BT_LOGE("Cannot create packet and stream objects: "
 320                         "dmesg-comp-addr=%p", dmesg_comp);
 321                 goto error;
 322         }
 323
 324         goto end;
 325
 326 error:
 327         ret = -1;
 328
 329 end:
 330         return ret;
 331 }
 332
 333 static
 334 void destroy_dmesg_component(struct dmesg_component *dmesg_comp)
 335 {
 336         if (!dmesg_comp) {
 337                 return;
 338         }
 339
 340         if (dmesg_comp->params.path) {
 341                 g_string_free(dmesg_comp->params.path, TRUE);
 342         }
 343
 344         bt_object_put_ref(dmesg_comp->packet);
 345         bt_object_put_ref(dmesg_comp->trace);
 346         bt_object_put_ref(dmesg_comp->stream_class);
 347         bt_object_put_ref(dmesg_comp->event_class);
 348         bt_object_put_ref(dmesg_comp->stream);
 349         bt_object_put_ref(dmesg_comp->clock_class);
 350         g_free(dmesg_comp);
 351 }
 352
 353 static
 354 enum bt_self_component_status create_port(
 355                 struct bt_self_component_source *self_comp)
 356 {
 357         return bt_self_component_source_add_output_port(self_comp,
 358                 "out", NULL, NULL);
 359 }
 360
 361 BT_HIDDEN
 362 enum bt_self_component_status dmesg_init(
 363                 struct bt_self_component_source *self_comp,
 364                 struct bt_value *params, void *init_method_data)
 365 {
 366         int ret = 0;
 367         struct dmesg_component *dmesg_comp = g_new0(struct dmesg_component, 1);
 368         enum bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
 369
 370         if (!dmesg_comp) {
 371                 BT_LOGE_STR("Failed to allocate one dmesg component structure.");
 372                 goto error;
 373         }
 374
 375         dmesg_comp->params.path = g_string_new(NULL);
 376         if (!dmesg_comp->params.path) {
 377                 BT_LOGE_STR("Failed to allocate a GString.");
 378                 goto error;
 379         }
 380
 381         ret = handle_params(dmesg_comp, params);
 382         if (ret) {
 383                 BT_LOGE("Invalid parameters: comp-addr=%p", self_comp);
 384                 goto error;
 385         }
 386
 387         if (!dmesg_comp->params.read_from_stdin &&
 388                         !g_file_test(dmesg_comp->params.path->str,
 389                         G_FILE_TEST_IS_REGULAR)) {
 390                 BT_LOGE("Input path is not a regular file: "
 391                         "comp-addr=%p, path=\"%s\"", self_comp,
 392                         dmesg_comp->params.path->str);
 393                 goto error;
 394         }
 395
 396         status = create_port(self_comp);
 397         if (status != BT_SELF_COMPONENT_STATUS_OK) {
 398                 goto error;
 399         }
 400
 401         bt_self_component_set_data(
 402                 bt_self_component_source_borrow_self_component(self_comp),
 403                 dmesg_comp);
 404         goto end;
 405
 406 error:
 407         destroy_dmesg_component(dmesg_comp);
 408         bt_self_component_set_data(
 409                 bt_self_component_source_borrow_self_component(self_comp),
 410                 NULL);
 411
 412         if (status >= 0) {
 413                 status = BT_SELF_COMPONENT_STATUS_ERROR;
 414         }
 415
 416 end:
 417         return status;
 418 }
 419
 420 BT_HIDDEN
 421 void dmesg_finalize(struct bt_self_component_source *self_comp)
 422 {
 423         destroy_dmesg_component(bt_self_component_get_data(
 424                 bt_self_component_source_borrow_self_component(self_comp)));
 425 }
 426
 427 static
 428 struct bt_private_notification *create_init_event_notif_from_line(
 429                 struct dmesg_notif_iter *notif_iter,
 430                 const char *line, const char **new_start)
 431 {
 432         struct bt_private_event *event;
 433         struct bt_private_notification *notif = NULL;
 434         bool has_timestamp = false;
 435         unsigned long sec, usec, msec;
 436         unsigned int year, mon, mday, hour, min;
 437         uint64_t ts = 0;
 438         int ret = 0;
 439         struct dmesg_component *dmesg_comp = notif_iter->dmesg_comp;
 440
 441         *new_start = line;
 442
 443         if (dmesg_comp->params.no_timestamp) {
 444                 goto skip_ts;
 445         }
 446
 447         /* Extract time from input line */
 448         if (sscanf(line, "[%lu.%lu] ", &sec, &usec) == 2) {
 449                 ts = (uint64_t) sec * USEC_PER_SEC + (uint64_t) usec;
 450
 451                 /*
 452                  * The clock class we use has a 1 GHz frequency: convert
 453                  * from µs to ns.
 454                  */
 455                 ts *= NSEC_PER_USEC;
 456                 has_timestamp = true;
 457         } else if (sscanf(line, "[%u-%u-%u %u:%u:%lu.%lu] ",
 458                         &year, &mon, &mday, &hour, &min,
 459                         &sec, &msec) == 7) {
 460                 time_t ep_sec;
 461                 struct tm ti;
 462
 463                 memset(&ti, 0, sizeof(ti));
 464                 ti.tm_year = year - 1900;       /* From 1900 */
 465                 ti.tm_mon = mon - 1;            /* 0 to 11 */
 466                 ti.tm_mday = mday;
 467                 ti.tm_hour = hour;
 468                 ti.tm_min = min;
 469                 ti.tm_sec = sec;
 470
 471                 ep_sec = bt_timegm(&ti);
 472                 if (ep_sec != (time_t) -1) {
 473                         ts = (uint64_t) ep_sec * NSEC_PER_SEC
 474                                 + (uint64_t) msec * NSEC_PER_MSEC;
 475                 }
 476
 477                 has_timestamp = true;
 478         }
 479
 480         if (has_timestamp) {
 481                 /* Set new start for the message portion of the line */
 482                 *new_start = strchr(line, ']');
 483                 BT_ASSERT(*new_start);
 484                 (*new_start)++;
 485
 486                 if ((*new_start)[0] == ' ') {
 487                         (*new_start)++;
 488                 }
 489         }
 490
 491 skip_ts:
 492         /*
 493          * At this point, we know if the stream class's event header
 494          * field class should have a timestamp or not, so we can lazily
 495          * create the metadata, stream, and packet objects.
 496          */
 497         ret = try_create_meta_stream_packet(dmesg_comp, has_timestamp);
 498         if (ret) {
 499                 /* try_create_meta_stream_packet() logs errors */
 500                 goto error;
 501         }
 502
 503         notif = bt_private_notification_event_create(notif_iter->pc_notif_iter,
 504                 dmesg_comp->event_class, dmesg_comp->packet);
 505         if (!notif) {
 506                 BT_LOGE_STR("Cannot create event notification.");
 507                 goto error;
 508         }
 509
 510         event = bt_private_notification_event_borrow_event(notif);
 511         BT_ASSERT(event);
 512
 513         if (dmesg_comp->clock_class) {
 514                 ret = bt_private_event_set_default_clock_value(event, ts);
 515                 BT_ASSERT(ret == 0);
 516         }
 517
 518         goto end;
 519
 520 error:
 521         BT_OBJECT_PUT_REF_AND_RESET(notif);
 522
 523 end:
 524         return notif;
 525 }
 526
 527 static
 528 int fill_event_payload_from_line(const char *line,
 529                 struct bt_private_event *event)
 530 {
 531         struct bt_private_field *ep_field = NULL;
 532         struct bt_private_field *str_field = NULL;
 533         size_t len;
 534         int ret;
 535
 536         ep_field = bt_private_event_borrow_payload_field(event);
 537         BT_ASSERT(ep_field);
 538         str_field = bt_private_field_structure_borrow_member_field_by_index(
 539                 ep_field, 0);
 540         if (!str_field) {
 541                 BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field.");
 542                 goto error;
 543         }
 544
 545         len = strlen(line);
 546         if (line[len - 1] == '\n') {
 547                 /* Do not include the newline character in the payload */
 548                 len--;
 549         }
 550
 551         ret = bt_private_field_string_clear(str_field);
 552         if (ret) {
 553                 BT_LOGE_STR("Cannot clear string field object.");
 554                 goto error;
 555         }
 556
 557         ret = bt_private_field_string_append_with_length(str_field, line, len);
 558         if (ret) {
 559                 BT_LOGE("Cannot append value to string field object: "
 560                         "len=%zu", len);
 561                 goto error;
 562         }
 563
 564         goto end;
 565
 566 error:
 567         ret = -1;
 568
 569 end:
 570         return ret;
 571 }
 572
 573 static
 574 struct bt_private_notification *create_notif_from_line(
 575                 struct dmesg_notif_iter *dmesg_notif_iter, const char *line)
 576 {
 577         struct bt_private_event *event = NULL;
 578         struct bt_private_notification *notif = NULL;
 579         const char *new_start;
 580         int ret;
 581
 582         notif = create_init_event_notif_from_line(dmesg_notif_iter,
 583                 line, &new_start);
 584         if (!notif) {
 585                 BT_LOGE_STR("Cannot create and initialize event notification from line.");
 586                 goto error;
 587         }
 588
 589         event = bt_private_notification_event_borrow_event(notif);
 590         BT_ASSERT(event);
 591         ret = fill_event_payload_from_line(new_start, event);
 592         if (ret) {
 593                 BT_LOGE("Cannot fill event payload field from line: "
 594                         "ret=%d", ret);
 595                 goto error;
 596         }
 597
 598         goto end;
 599
 600 error:
 601         BT_OBJECT_PUT_REF_AND_RESET(notif);
 602
 603 end:
 604         return notif;
 605 }
 606
 607 static
 608 void destroy_dmesg_notif_iter(struct dmesg_notif_iter *dmesg_notif_iter)
 609 {
 610         if (!dmesg_notif_iter) {
 611                 return;
 612         }
 613
 614         if (dmesg_notif_iter->fp && dmesg_notif_iter->fp != stdin) {
 615                 if (fclose(dmesg_notif_iter->fp)) {
 616                         BT_LOGE_ERRNO("Cannot close input file", ".");
 617                 }
 618         }
 619
 620         bt_object_put_ref(dmesg_notif_iter->tmp_event_notif);
 621         free(dmesg_notif_iter->linebuf);
 622         g_free(dmesg_notif_iter);
 623 }
 624
 625 BT_HIDDEN
 626 enum bt_self_notification_iterator_status dmesg_notif_iter_init(
 627                 struct bt_self_notification_iterator *self_notif_iter,
 628                 struct bt_self_component_source *self_comp,
 629                 struct bt_self_component_port_output *self_port)
 630 {
 631         struct dmesg_component *dmesg_comp;
 632         struct dmesg_notif_iter *dmesg_notif_iter =
 633                 g_new0(struct dmesg_notif_iter, 1);
 634         enum bt_self_notification_iterator_status status =
 635                 BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK;
 636
 637         if (!dmesg_notif_iter) {
 638                 BT_LOGE_STR("Failed to allocate on dmesg notification iterator structure.");
 639                 goto error;
 640         }
 641
 642         dmesg_comp = bt_self_component_get_data(
 643                 bt_self_component_source_borrow_self_component(self_comp));
 644         BT_ASSERT(dmesg_comp);
 645         dmesg_notif_iter->dmesg_comp = dmesg_comp;
 646         dmesg_notif_iter->pc_notif_iter = self_notif_iter;
 647
 648         if (dmesg_comp->params.read_from_stdin) {
 649                 dmesg_notif_iter->fp = stdin;
 650         } else {
 651                 dmesg_notif_iter->fp = fopen(dmesg_comp->params.path->str, "r");
 652                 if (!dmesg_notif_iter->fp) {
 653                         BT_LOGE_ERRNO("Cannot open input file in read mode", ": path=\"%s\"",
 654                                 dmesg_comp->params.path->str);
 655                         goto error;
 656                 }
 657         }
 658
 659         bt_self_notification_iterator_set_data(self_notif_iter,
 660                 dmesg_notif_iter);
 661         goto end;
 662
 663 error:
 664         destroy_dmesg_notif_iter(dmesg_notif_iter);
 665         bt_self_notification_iterator_set_data(self_notif_iter, NULL);
 666         if (status >= 0) {
 667                 status = BT_SELF_NOTIFICATION_ITERATOR_STATUS_ERROR;
 668         }
 669
 670 end:
 671         return status;
 672 }
 673
 674 BT_HIDDEN
 675 void dmesg_notif_iter_finalize(
 676                 struct bt_self_notification_iterator *priv_notif_iter)
 677 {
 678         destroy_dmesg_notif_iter(bt_self_notification_iterator_get_data(
 679                 priv_notif_iter));
 680 }
 681
 682 static
 683 enum bt_self_notification_iterator_status dmesg_notif_iter_next_one(
 684                 struct dmesg_notif_iter *dmesg_notif_iter,
 685                 struct bt_private_notification **notif)
 686 {
 687         ssize_t len;
 688         struct dmesg_component *dmesg_comp;
 689         enum bt_self_notification_iterator_status status =
 690                 BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK;
 691
 692         BT_ASSERT(dmesg_notif_iter);
 693         dmesg_comp = dmesg_notif_iter->dmesg_comp;
 694         BT_ASSERT(dmesg_comp);
 695
 696         if (dmesg_notif_iter->state == STATE_DONE) {
 697                 status = BT_SELF_NOTIFICATION_ITERATOR_STATUS_END;
 698                 goto end;
 699         }
 700
 701         if (dmesg_notif_iter->tmp_event_notif ||
 702                         dmesg_notif_iter->state == STATE_EMIT_PACKET_END ||
 703                         dmesg_notif_iter->state == STATE_EMIT_STREAM_END) {
 704                 goto handle_state;
 705         }
 706
 707         while (true) {
 708                 const char *ch;
 709                 bool only_spaces = true;
 710
 711                 len = bt_getline(&dmesg_notif_iter->linebuf,
 712                         &dmesg_notif_iter->linebuf_len, dmesg_notif_iter->fp);
 713                 if (len < 0) {
 714                         if (errno == EINVAL) {
 715                                 status = BT_SELF_NOTIFICATION_ITERATOR_STATUS_ERROR;
 716                         } else if (errno == ENOMEM) {
 717                                 status =
 718                                         BT_SELF_NOTIFICATION_ITERATOR_STATUS_NOMEM;
 719                         } else {
 720                                 if (dmesg_notif_iter->state == STATE_EMIT_STREAM_BEGINNING) {
 721                                         /* Stream did not even begin */
 722                                         status = BT_SELF_NOTIFICATION_ITERATOR_STATUS_END;
 723                                         goto end;
 724                                 } else {
 725                                         /* End current packet now */
 726                                         dmesg_notif_iter->state =
 727                                                 STATE_EMIT_PACKET_END;
 728                                         goto handle_state;
 729                                 }
 730                         }
 731
 732                         goto end;
 733                 }
 734
 735                 BT_ASSERT(dmesg_notif_iter->linebuf);
 736
 737                 /* Ignore empty lines, once trimmed */
 738                 for (ch = dmesg_notif_iter->linebuf; *ch != '\0'; ch++) {
 739                         if (!isspace(*ch)) {
 740                                 only_spaces = false;
 741                                 break;
 742                         }
 743                 }
 744
 745                 if (!only_spaces) {
 746                         break;
 747                 }
 748         }
 749
 750         dmesg_notif_iter->tmp_event_notif = create_notif_from_line(
 751                 dmesg_notif_iter, dmesg_notif_iter->linebuf);
 752         if (!dmesg_notif_iter->tmp_event_notif) {
 753                 BT_LOGE("Cannot create event notification from line: "
 754                         "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp,
 755                         dmesg_notif_iter->linebuf);
 756                 goto end;
 757         }
 758
 759 handle_state:
 760         BT_ASSERT(dmesg_comp->trace);
 761
 762         switch (dmesg_notif_iter->state) {
 763         case STATE_EMIT_STREAM_BEGINNING:
 764                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 765                 *notif = bt_private_notification_stream_begin_create(
 766                         dmesg_notif_iter->pc_notif_iter, dmesg_comp->stream);
 767                 dmesg_notif_iter->state = STATE_EMIT_PACKET_BEGINNING;
 768                 break;
 769         case STATE_EMIT_PACKET_BEGINNING:
 770                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 771                 *notif = bt_private_notification_packet_begin_create(
 772                         dmesg_notif_iter->pc_notif_iter, dmesg_comp->packet);
 773                 dmesg_notif_iter->state = STATE_EMIT_EVENT;
 774                 break;
 775         case STATE_EMIT_EVENT:
 776                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 777                 *notif = dmesg_notif_iter->tmp_event_notif;
 778                 dmesg_notif_iter->tmp_event_notif = NULL;
 779                 break;
 780         case STATE_EMIT_PACKET_END:
 781                 *notif = bt_private_notification_packet_end_create(
 782                         dmesg_notif_iter->pc_notif_iter, dmesg_comp->packet);
 783                 dmesg_notif_iter->state = STATE_EMIT_STREAM_END;
 784                 break;
 785         case STATE_EMIT_STREAM_END:
 786                 *notif = bt_private_notification_stream_end_create(
 787                         dmesg_notif_iter->pc_notif_iter, dmesg_comp->stream);
 788                 dmesg_notif_iter->state = STATE_DONE;
 789                 break;
 790         default:
 791                 break;
 792         }
 793
 794         if (!*notif) {
 795                 BT_LOGE("Cannot create notification: dmesg-comp-addr=%p",
 796                         dmesg_comp);
 797                 status = BT_SELF_NOTIFICATION_ITERATOR_STATUS_ERROR;
 798         }
 799
 800 end:
 801         return status;
 802 }
 803
 804 BT_HIDDEN
 805 enum bt_self_notification_iterator_status dmesg_notif_iter_next(
 806                 struct bt_self_notification_iterator *self_notif_iter,
 807                 bt_notification_array notifs, uint64_t capacity,
 808                 uint64_t *count)
 809 {
 810         struct dmesg_notif_iter *dmesg_notif_iter =
 811                 bt_self_notification_iterator_get_data(
 812                         self_notif_iter);
 813         enum bt_self_notification_iterator_status status =
 814                 BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK;
 815         uint64_t i = 0;
 816
 817         while (i < capacity &&
 818                         status == BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK) {
 819                 struct bt_private_notification *priv_notif = NULL;
 820
 821                 status = dmesg_notif_iter_next_one(dmesg_notif_iter,
 822                         &priv_notif);
 823                 notifs[i] = bt_private_notification_borrow_notification(
 824                         priv_notif);
 825                 if (status == BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK) {
 826                         i++;
 827                 }
 828         }
 829
 830         if (i > 0) {
 831                 /*
 832                  * Even if dmesg_notif_iter_next_one() returned
 833                  * something else than
 834                  * BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK, we
 835                  * accumulated notification objects in the output
 836                  * notification array, so we need to return
 837                  * BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK so that they
 838                  * are transfered to downstream. This other status
 839                  * occurs again the next time muxer_notif_iter_do_next()
 840                  * is called, possibly without any accumulated
 841                  * notification, in which case we'll return it.
 842                  */
 843                 *count = i;
 844                 status = BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK;
 845         }
 846
 847         return status;
 848 }