plugins/text/dmesg/dmesg.c

   1 /*
   2  * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
   3  * Copyright 2017 Philippe Proulx <jeremie.galarneau@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_private_connection_private_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_private_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_clock_class_borrow_from_private(
 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_private_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_component_status create_port(struct bt_private_component *priv_comp)
 355 {
 356         return bt_private_component_source_add_output_private_port(priv_comp,
 357                 "out", NULL, NULL);
 358 }
 359
 360 BT_HIDDEN
 361 enum bt_component_status dmesg_init(struct bt_private_component *priv_comp,
 362                 struct bt_value *params, void *init_method_data)
 363 {
 364         int ret = 0;
 365         struct dmesg_component *dmesg_comp = g_new0(struct dmesg_component, 1);
 366         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
 367
 368         if (!dmesg_comp) {
 369                 BT_LOGE_STR("Failed to allocate one dmesg component structure.");
 370                 goto error;
 371         }
 372
 373         dmesg_comp->params.path = g_string_new(NULL);
 374         if (!dmesg_comp->params.path) {
 375                 BT_LOGE_STR("Failed to allocate a GString.");
 376                 goto error;
 377         }
 378
 379         ret = handle_params(dmesg_comp, params);
 380         if (ret) {
 381                 BT_LOGE("Invalid parameters: comp-addr=%p", priv_comp);
 382                 goto error;
 383         }
 384
 385         if (!dmesg_comp->params.read_from_stdin &&
 386                         !g_file_test(dmesg_comp->params.path->str,
 387                         G_FILE_TEST_IS_REGULAR)) {
 388                 BT_LOGE("Input path is not a regular file: "
 389                         "comp-addr=%p, path=\"%s\"", priv_comp,
 390                         dmesg_comp->params.path->str);
 391                 goto error;
 392         }
 393
 394         status = create_port(priv_comp);
 395         if (status != BT_COMPONENT_STATUS_OK) {
 396                 goto error;
 397         }
 398
 399         (void) bt_private_component_set_user_data(priv_comp, dmesg_comp);
 400         goto end;
 401
 402 error:
 403         destroy_dmesg_component(dmesg_comp);
 404         (void) bt_private_component_set_user_data(priv_comp, NULL);
 405
 406         if (status >= 0) {
 407                 status = BT_COMPONENT_STATUS_ERROR;
 408         }
 409
 410 end:
 411         return status;
 412 }
 413
 414 BT_HIDDEN
 415 void dmesg_finalize(struct bt_private_component *priv_comp)
 416 {
 417         void *data = bt_private_component_get_user_data(priv_comp);
 418
 419         destroy_dmesg_component(data);
 420 }
 421
 422 static
 423 struct bt_private_notification *create_init_event_notif_from_line(
 424                 struct dmesg_notif_iter *notif_iter,
 425                 const char *line, const char **new_start)
 426 {
 427         struct bt_private_event *event;
 428         struct bt_private_notification *notif = NULL;
 429         bool has_timestamp = false;
 430         unsigned long sec, usec, msec;
 431         unsigned int year, mon, mday, hour, min;
 432         uint64_t ts = 0;
 433         int ret = 0;
 434         struct dmesg_component *dmesg_comp = notif_iter->dmesg_comp;
 435
 436         *new_start = line;
 437
 438         if (dmesg_comp->params.no_timestamp) {
 439                 goto skip_ts;
 440         }
 441
 442         /* Extract time from input line */
 443         if (sscanf(line, "[%lu.%lu] ", &sec, &usec) == 2) {
 444                 ts = (uint64_t) sec * USEC_PER_SEC + (uint64_t) usec;
 445
 446                 /*
 447                  * The clock class we use has a 1 GHz frequency: convert
 448                  * from µs to ns.
 449                  */
 450                 ts *= NSEC_PER_USEC;
 451                 has_timestamp = true;
 452         } else if (sscanf(line, "[%u-%u-%u %u:%u:%lu.%lu] ",
 453                         &year, &mon, &mday, &hour, &min,
 454                         &sec, &msec) == 7) {
 455                 time_t ep_sec;
 456                 struct tm ti;
 457
 458                 memset(&ti, 0, sizeof(ti));
 459                 ti.tm_year = year - 1900;       /* From 1900 */
 460                 ti.tm_mon = mon - 1;            /* 0 to 11 */
 461                 ti.tm_mday = mday;
 462                 ti.tm_hour = hour;
 463                 ti.tm_min = min;
 464                 ti.tm_sec = sec;
 465
 466                 ep_sec = bt_timegm(&ti);
 467                 if (ep_sec != (time_t) -1) {
 468                         ts = (uint64_t) ep_sec * NSEC_PER_SEC
 469                                 + (uint64_t) msec * NSEC_PER_MSEC;
 470                 }
 471
 472                 has_timestamp = true;
 473         }
 474
 475         if (has_timestamp) {
 476                 /* Set new start for the message portion of the line */
 477                 *new_start = strchr(line, ']');
 478                 BT_ASSERT(*new_start);
 479                 (*new_start)++;
 480
 481                 if ((*new_start)[0] == ' ') {
 482                         (*new_start)++;
 483                 }
 484         }
 485
 486 skip_ts:
 487         /*
 488          * At this point, we know if the stream class's event header
 489          * field class should have a timestamp or not, so we can lazily
 490          * create the metadata, stream, and packet objects.
 491          */
 492         ret = try_create_meta_stream_packet(dmesg_comp, has_timestamp);
 493         if (ret) {
 494                 /* try_create_meta_stream_packet() logs errors */
 495                 goto error;
 496         }
 497
 498         notif = bt_private_notification_event_create(notif_iter->pc_notif_iter,
 499                 dmesg_comp->event_class, dmesg_comp->packet);
 500         if (!notif) {
 501                 BT_LOGE_STR("Cannot create event notification.");
 502                 goto error;
 503         }
 504
 505         event = bt_private_notification_event_borrow_private_event(notif);
 506         BT_ASSERT(event);
 507
 508         if (dmesg_comp->clock_class) {
 509                 ret = bt_private_event_set_default_clock_value(event, ts);
 510                 BT_ASSERT(ret == 0);
 511         }
 512
 513         goto end;
 514
 515 error:
 516         BT_OBJECT_PUT_REF_AND_RESET(notif);
 517
 518 end:
 519         return notif;
 520 }
 521
 522 static
 523 int fill_event_payload_from_line(const char *line,
 524                 struct bt_private_event *event)
 525 {
 526         struct bt_private_field *ep_field = NULL;
 527         struct bt_private_field *str_field = NULL;
 528         size_t len;
 529         int ret;
 530
 531         ep_field = bt_private_event_borrow_payload_private_field(event);
 532         BT_ASSERT(ep_field);
 533         str_field = bt_private_field_structure_borrow_member_private_field_by_index(
 534                 ep_field, 0);
 535         if (!str_field) {
 536                 BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field.");
 537                 goto error;
 538         }
 539
 540         len = strlen(line);
 541         if (line[len - 1] == '\n') {
 542                 /* Do not include the newline character in the payload */
 543                 len--;
 544         }
 545
 546         ret = bt_private_field_string_clear(str_field);
 547         if (ret) {
 548                 BT_LOGE_STR("Cannot clear string field object.");
 549                 goto error;
 550         }
 551
 552         ret = bt_private_field_string_append_with_length(str_field, line, len);
 553         if (ret) {
 554                 BT_LOGE("Cannot append value to string field object: "
 555                         "len=%zu", len);
 556                 goto error;
 557         }
 558
 559         goto end;
 560
 561 error:
 562         ret = -1;
 563
 564 end:
 565         return ret;
 566 }
 567
 568 static
 569 struct bt_private_notification *create_notif_from_line(
 570                 struct dmesg_notif_iter *dmesg_notif_iter, const char *line)
 571 {
 572         struct bt_private_event *event = NULL;
 573         struct bt_private_notification *notif = NULL;
 574         const char *new_start;
 575         int ret;
 576
 577         notif = create_init_event_notif_from_line(dmesg_notif_iter,
 578                 line, &new_start);
 579         if (!notif) {
 580                 BT_LOGE_STR("Cannot create and initialize event notification from line.");
 581                 goto error;
 582         }
 583
 584         event = bt_private_notification_event_borrow_private_event(notif);
 585         BT_ASSERT(event);
 586         ret = fill_event_payload_from_line(new_start, event);
 587         if (ret) {
 588                 BT_LOGE("Cannot fill event payload field from line: "
 589                         "ret=%d", ret);
 590                 goto error;
 591         }
 592
 593         goto end;
 594
 595 error:
 596         BT_OBJECT_PUT_REF_AND_RESET(notif);
 597
 598 end:
 599         return notif;
 600 }
 601
 602 static
 603 void destroy_dmesg_notif_iter(struct dmesg_notif_iter *dmesg_notif_iter)
 604 {
 605         if (!dmesg_notif_iter) {
 606                 return;
 607         }
 608
 609         if (dmesg_notif_iter->fp && dmesg_notif_iter->fp != stdin) {
 610                 if (fclose(dmesg_notif_iter->fp)) {
 611                         BT_LOGE_ERRNO("Cannot close input file", ".");
 612                 }
 613         }
 614
 615         bt_object_put_ref(dmesg_notif_iter->tmp_event_notif);
 616         free(dmesg_notif_iter->linebuf);
 617         g_free(dmesg_notif_iter);
 618 }
 619
 620 BT_HIDDEN
 621 enum bt_notification_iterator_status dmesg_notif_iter_init(
 622                 struct bt_private_connection_private_notification_iterator *priv_notif_iter,
 623                 struct bt_private_port *priv_port)
 624 {
 625         struct bt_private_component *priv_comp = NULL;
 626         struct dmesg_component *dmesg_comp;
 627         struct dmesg_notif_iter *dmesg_notif_iter =
 628                 g_new0(struct dmesg_notif_iter, 1);
 629         enum bt_notification_iterator_status status =
 630                 BT_NOTIFICATION_ITERATOR_STATUS_OK;
 631
 632         if (!dmesg_notif_iter) {
 633                 BT_LOGE_STR("Failed to allocate on dmesg notification iterator structure.");
 634                 goto error;
 635         }
 636
 637         priv_comp = bt_private_connection_private_notification_iterator_get_private_component(
 638                 priv_notif_iter);
 639         BT_ASSERT(priv_comp);
 640         dmesg_comp = bt_private_component_get_user_data(priv_comp);
 641         BT_ASSERT(dmesg_comp);
 642         dmesg_notif_iter->dmesg_comp = dmesg_comp;
 643         dmesg_notif_iter->pc_notif_iter = priv_notif_iter;
 644
 645         if (dmesg_comp->params.read_from_stdin) {
 646                 dmesg_notif_iter->fp = stdin;
 647         } else {
 648                 dmesg_notif_iter->fp = fopen(dmesg_comp->params.path->str, "r");
 649                 if (!dmesg_notif_iter->fp) {
 650                         BT_LOGE_ERRNO("Cannot open input file in read mode", ": path=\"%s\"",
 651                                 dmesg_comp->params.path->str);
 652                         goto error;
 653                 }
 654         }
 655
 656         (void) bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter,
 657                 dmesg_notif_iter);
 658         goto end;
 659
 660 error:
 661         destroy_dmesg_notif_iter(dmesg_notif_iter);
 662         (void) bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter,
 663                 NULL);
 664         if (status >= 0) {
 665                 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 666         }
 667
 668 end:
 669         bt_object_put_ref(priv_comp);
 670         return status;
 671 }
 672
 673 BT_HIDDEN
 674 void dmesg_notif_iter_finalize(
 675                 struct bt_private_connection_private_notification_iterator *priv_notif_iter)
 676 {
 677         destroy_dmesg_notif_iter(bt_private_connection_private_notification_iterator_get_user_data(
 678                 priv_notif_iter));
 679 }
 680
 681 static
 682 enum bt_notification_iterator_status dmesg_notif_iter_next_one(
 683                 struct dmesg_notif_iter *dmesg_notif_iter,
 684                 struct bt_private_notification **notif)
 685 {
 686         ssize_t len;
 687         struct dmesg_component *dmesg_comp;
 688         enum bt_notification_iterator_status status =
 689                 BT_NOTIFICATION_ITERATOR_STATUS_OK;
 690
 691         BT_ASSERT(dmesg_notif_iter);
 692         dmesg_comp = dmesg_notif_iter->dmesg_comp;
 693         BT_ASSERT(dmesg_comp);
 694
 695         if (dmesg_notif_iter->state == STATE_DONE) {
 696                 status = BT_NOTIFICATION_ITERATOR_STATUS_END;
 697                 goto end;
 698         }
 699
 700         if (dmesg_notif_iter->tmp_event_notif ||
 701                         dmesg_notif_iter->state == STATE_EMIT_PACKET_END ||
 702                         dmesg_notif_iter->state == STATE_EMIT_STREAM_END) {
 703                 goto handle_state;
 704         }
 705
 706         while (true) {
 707                 const char *ch;
 708                 bool only_spaces = true;
 709
 710                 len = bt_getline(&dmesg_notif_iter->linebuf,
 711                         &dmesg_notif_iter->linebuf_len, dmesg_notif_iter->fp);
 712                 if (len < 0) {
 713                         if (errno == EINVAL) {
 714                                 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 715                         } else if (errno == ENOMEM) {
 716                                 status =
 717                                         BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
 718                         } else {
 719                                 if (dmesg_notif_iter->state == STATE_EMIT_STREAM_BEGINNING) {
 720                                         /* Stream did not even begin */
 721                                         status = BT_NOTIFICATION_ITERATOR_STATUS_END;
 722                                         goto end;
 723                                 } else {
 724                                         /* End current packet now */
 725                                         dmesg_notif_iter->state =
 726                                                 STATE_EMIT_PACKET_END;
 727                                         goto handle_state;
 728                                 }
 729                         }
 730
 731                         goto end;
 732                 }
 733
 734                 BT_ASSERT(dmesg_notif_iter->linebuf);
 735
 736                 /* Ignore empty lines, once trimmed */
 737                 for (ch = dmesg_notif_iter->linebuf; *ch != '\0'; ch++) {
 738                         if (!isspace(*ch)) {
 739                                 only_spaces = false;
 740                                 break;
 741                         }
 742                 }
 743
 744                 if (!only_spaces) {
 745                         break;
 746                 }
 747         }
 748
 749         dmesg_notif_iter->tmp_event_notif = create_notif_from_line(
 750                 dmesg_notif_iter, dmesg_notif_iter->linebuf);
 751         if (!dmesg_notif_iter->tmp_event_notif) {
 752                 BT_LOGE("Cannot create event notification from line: "
 753                         "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp,
 754                         dmesg_notif_iter->linebuf);
 755                 goto end;
 756         }
 757
 758 handle_state:
 759         BT_ASSERT(dmesg_comp->trace);
 760
 761         switch (dmesg_notif_iter->state) {
 762         case STATE_EMIT_STREAM_BEGINNING:
 763                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 764                 *notif = bt_private_notification_stream_begin_create(
 765                         dmesg_notif_iter->pc_notif_iter, dmesg_comp->stream);
 766                 dmesg_notif_iter->state = STATE_EMIT_PACKET_BEGINNING;
 767                 break;
 768         case STATE_EMIT_PACKET_BEGINNING:
 769                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 770                 *notif = bt_private_notification_packet_begin_create(
 771                         dmesg_notif_iter->pc_notif_iter, dmesg_comp->packet);
 772                 dmesg_notif_iter->state = STATE_EMIT_EVENT;
 773                 break;
 774         case STATE_EMIT_EVENT:
 775                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 776                 *notif = dmesg_notif_iter->tmp_event_notif;
 777                 dmesg_notif_iter->tmp_event_notif = NULL;
 778                 break;
 779         case STATE_EMIT_PACKET_END:
 780                 *notif = bt_private_notification_packet_end_create(
 781                         dmesg_notif_iter->pc_notif_iter, dmesg_comp->packet);
 782                 dmesg_notif_iter->state = STATE_EMIT_STREAM_END;
 783                 break;
 784         case STATE_EMIT_STREAM_END:
 785                 *notif = bt_private_notification_stream_end_create(
 786                         dmesg_notif_iter->pc_notif_iter, dmesg_comp->stream);
 787                 dmesg_notif_iter->state = STATE_DONE;
 788                 break;
 789         default:
 790                 break;
 791         }
 792
 793         if (!*notif) {
 794                 BT_LOGE("Cannot create notification: dmesg-comp-addr=%p",
 795                         dmesg_comp);
 796                 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 797         }
 798
 799 end:
 800         return status;
 801 }
 802
 803 BT_HIDDEN
 804 enum bt_notification_iterator_status dmesg_notif_iter_next(
 805                 struct bt_private_connection_private_notification_iterator *priv_notif_iter,
 806                 bt_notification_array notifs, uint64_t capacity,
 807                 uint64_t *count)
 808 {
 809         struct dmesg_notif_iter *dmesg_notif_iter =
 810                 bt_private_connection_private_notification_iterator_get_user_data(
 811                         priv_notif_iter);
 812         enum bt_notification_iterator_status status =
 813                 BT_NOTIFICATION_ITERATOR_STATUS_OK;
 814         uint64_t i = 0;
 815
 816         while (i < capacity && status == BT_NOTIFICATION_ITERATOR_STATUS_OK) {
 817                 struct bt_private_notification *priv_notif;
 818
 819                 status = dmesg_notif_iter_next_one(dmesg_notif_iter,
 820                         &priv_notif);
 821                 notifs[i] = bt_notification_borrow_from_private(priv_notif);
 822                 if (status == BT_NOTIFICATION_ITERATOR_STATUS_OK) {
 823                         i++;
 824                 }
 825         }
 826
 827         if (i > 0) {
 828                 /*
 829                  * Even if dmesg_notif_iter_next_one() returned
 830                  * something else than
 831                  * BT_NOTIFICATION_ITERATOR_STATUS_OK, we accumulated
 832                  * notification objects in the output notification
 833                  * array, so we need to return
 834                  * BT_NOTIFICATION_ITERATOR_STATUS_OK so that they are
 835                  * transfered to downstream. This other status occurs
 836                  * again the next time muxer_notif_iter_do_next() is
 837                  * called, possibly without any accumulated
 838                  * notification, in which case we'll return it.
 839                  */
 840                 *count = i;
 841                 status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
 842         }
 843
 844         return status;
 845 }