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/value-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_msg_iter {
  47         struct dmesg_component *dmesg_comp;
  48         bt_self_message_iterator *pc_msg_iter; /* Weak */
  49         char *linebuf;
  50         size_t linebuf_len;
  51         FILE *fp;
  52         bt_message *tmp_event_msg;
  53
  54         enum {
  55                 STATE_EMIT_STREAM_BEGINNING,
  56                 STATE_EMIT_STREAM_ACTIVITY_BEGINNING,
  57                 STATE_EMIT_PACKET_BEGINNING,
  58                 STATE_EMIT_EVENT,
  59                 STATE_EMIT_PACKET_END,
  60                 STATE_EMIT_STREAM_ACTIVITY_END,
  61                 STATE_EMIT_STREAM_END,
  62                 STATE_DONE,
  63         } state;
  64 };
  65
  66 struct dmesg_component {
  67         struct {
  68                 GString *path;
  69                 bt_bool read_from_stdin;
  70                 bt_bool no_timestamp;
  71         } params;
  72
  73         bt_self_component_source *self_comp;
  74         bt_trace_class *trace_class;
  75         bt_stream_class *stream_class;
  76         bt_event_class *event_class;
  77         bt_trace *trace;
  78         bt_stream *stream;
  79         bt_packet *packet;
  80         bt_clock_class *clock_class;
  81 };
  82
  83 static
  84 bt_field_class *create_event_payload_fc(bt_trace_class *trace_class)
  85 {
  86         bt_field_class *root_fc = NULL;
  87         bt_field_class *fc = NULL;
  88         int ret;
  89
  90         root_fc = bt_field_class_structure_create(trace_class);
  91         if (!root_fc) {
  92                 BT_LOGE_STR("Cannot create an empty structure field class object.");
  93                 goto error;
  94         }
  95
  96         fc = bt_field_class_string_create(trace_class);
  97         if (!fc) {
  98                 BT_LOGE_STR("Cannot create a string field class object.");
  99                 goto error;
 100         }
 101
 102         ret = bt_field_class_structure_append_member(root_fc,
 103                 "str", fc);
 104         if (ret) {
 105                 BT_LOGE("Cannot add `str` member to structure field class: "
 106                         "ret=%d", ret);
 107                 goto error;
 108         }
 109
 110         goto end;
 111
 112 error:
 113         BT_FIELD_CLASS_PUT_REF_AND_RESET(root_fc);
 114
 115 end:
 116         bt_field_class_put_ref(fc);
 117         return root_fc;
 118 }
 119
 120 static
 121 int create_meta(struct dmesg_component *dmesg_comp, bool has_ts)
 122 {
 123         bt_field_class *fc = NULL;
 124         int ret = 0;
 125
 126         dmesg_comp->trace_class = bt_trace_class_create(
 127                 bt_self_component_source_as_self_component(
 128                         dmesg_comp->self_comp));
 129         if (!dmesg_comp->trace_class) {
 130                 BT_LOGE_STR("Cannot create an empty trace class object.");
 131                 goto error;
 132         }
 133
 134         dmesg_comp->stream_class = bt_stream_class_create(
 135                 dmesg_comp->trace_class);
 136         if (!dmesg_comp->stream_class) {
 137                 BT_LOGE_STR("Cannot create a stream class object.");
 138                 goto error;
 139         }
 140
 141         if (has_ts) {
 142                 dmesg_comp->clock_class = bt_clock_class_create(
 143                         dmesg_comp->trace_class);
 144                 if (!dmesg_comp->clock_class) {
 145                         BT_LOGE_STR("Cannot create clock class.");
 146                         goto error;
 147                 }
 148
 149                 ret = bt_stream_class_set_default_clock_class(
 150                         dmesg_comp->stream_class, dmesg_comp->clock_class);
 151                 if (ret) {
 152                         BT_LOGE_STR("Cannot set stream class's default clock class.");
 153                         goto error;
 154                 }
 155         }
 156
 157         dmesg_comp->event_class = bt_event_class_create(
 158                 dmesg_comp->stream_class);
 159         if (!dmesg_comp->event_class) {
 160                 BT_LOGE_STR("Cannot create an event class object.");
 161                 goto error;
 162         }
 163
 164         ret = bt_event_class_set_name(dmesg_comp->event_class, "string");
 165         if (ret) {
 166                 BT_LOGE_STR("Cannot set event class's name.");
 167                 goto error;
 168         }
 169
 170         fc = create_event_payload_fc(dmesg_comp->trace_class);
 171         if (!fc) {
 172                 BT_LOGE_STR("Cannot create event payload field class.");
 173                 goto error;
 174         }
 175
 176         ret = bt_event_class_set_payload_field_class(dmesg_comp->event_class, fc);
 177         if (ret) {
 178                 BT_LOGE_STR("Cannot set event class's event payload field class.");
 179                 goto error;
 180         }
 181
 182         goto end;
 183
 184 error:
 185         ret = -1;
 186
 187 end:
 188         bt_field_class_put_ref(fc);
 189         return ret;
 190 }
 191
 192 static
 193 int handle_params(struct dmesg_component *dmesg_comp,
 194                 const bt_value *params)
 195 {
 196         const bt_value *no_timestamp = NULL;
 197         const bt_value *path = NULL;
 198         const char *path_str;
 199         int ret = 0;
 200
 201         no_timestamp = bt_value_map_borrow_entry_value_const(params,
 202                 "no-extract-timestamp");
 203         if (no_timestamp) {
 204                 if (!bt_value_is_bool(no_timestamp)) {
 205                         BT_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: "
 206                                 "type=%s",
 207                                 bt_common_value_type_string(
 208                                         bt_value_get_type(no_timestamp)));
 209                         goto error;
 210                 }
 211
 212                 dmesg_comp->params.no_timestamp =
 213                         bt_value_bool_get(no_timestamp);
 214         }
 215
 216         path = bt_value_map_borrow_entry_value_const(params, "path");
 217         if (path) {
 218                 if (dmesg_comp->params.read_from_stdin) {
 219                         BT_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters.");
 220                         goto error;
 221                 }
 222
 223                 if (!bt_value_is_string(path)) {
 224                         BT_LOGE("Expecting a string value for the `path` parameter: "
 225                                 "type=%s",
 226                                 bt_common_value_type_string(
 227                                         bt_value_get_type(path)));
 228                         goto error;
 229                 }
 230
 231                 path_str = bt_value_string_get(path);
 232                 g_string_assign(dmesg_comp->params.path, path_str);
 233         } else {
 234                 dmesg_comp->params.read_from_stdin = true;
 235         }
 236
 237         goto end;
 238
 239 error:
 240         ret = -1;
 241
 242 end:
 243         return ret;
 244 }
 245
 246 static
 247 int create_packet_and_stream_and_trace(struct dmesg_component *dmesg_comp)
 248 {
 249         int ret = 0;
 250         const char *trace_name = NULL;
 251         gchar *basename = NULL;
 252
 253         dmesg_comp->trace = bt_trace_create(dmesg_comp->trace_class);
 254         if (!dmesg_comp->trace) {
 255                 BT_LOGE_STR("Cannot create trace object.");
 256                 goto error;
 257         }
 258
 259         if (dmesg_comp->params.read_from_stdin) {
 260                 trace_name = "STDIN";
 261         } else {
 262                 basename = g_path_get_basename(dmesg_comp->params.path->str);
 263                 BT_ASSERT(basename);
 264
 265                 if (strcmp(basename, G_DIR_SEPARATOR_S) != 0 &&
 266                                 strcmp(basename, ".") != 0) {
 267                         trace_name = basename;
 268                 }
 269         }
 270
 271         if (trace_name) {
 272                 ret = bt_trace_set_name(dmesg_comp->trace, trace_name);
 273                 if (ret) {
 274                         BT_LOGE("Cannot set trace's name: name=\"%s\"",
 275                                 trace_name);
 276                         goto error;
 277                 }
 278         }
 279
 280         dmesg_comp->stream = bt_stream_create(dmesg_comp->stream_class,
 281                 dmesg_comp->trace);
 282         if (!dmesg_comp->stream) {
 283                 BT_LOGE_STR("Cannot create stream object.");
 284                 goto error;
 285         }
 286
 287         dmesg_comp->packet = bt_packet_create(dmesg_comp->stream);
 288         if (!dmesg_comp->packet) {
 289                 BT_LOGE_STR("Cannot create packet object.");
 290                 goto error;
 291         }
 292
 293         ret = bt_trace_make_static(dmesg_comp->trace);
 294         if (ret) {
 295                 BT_LOGE_STR("Cannot make trace static.");
 296                 goto error;
 297         }
 298
 299         goto end;
 300
 301 error:
 302         ret = -1;
 303
 304 end:
 305         if (basename) {
 306                 g_free(basename);
 307         }
 308
 309         return ret;
 310 }
 311
 312 static
 313 int try_create_meta_stream_packet(struct dmesg_component *dmesg_comp,
 314                 bool has_ts)
 315 {
 316         int ret = 0;
 317
 318         if (dmesg_comp->trace) {
 319                 /* Already created */
 320                 goto end;
 321         }
 322
 323         ret = create_meta(dmesg_comp, has_ts);
 324         if (ret) {
 325                 BT_LOGE("Cannot create metadata objects: dmesg-comp-addr=%p",
 326                         dmesg_comp);
 327                 goto error;
 328         }
 329
 330         ret = create_packet_and_stream_and_trace(dmesg_comp);
 331         if (ret) {
 332                 BT_LOGE("Cannot create packet and stream objects: "
 333                         "dmesg-comp-addr=%p", dmesg_comp);
 334                 goto error;
 335         }
 336
 337         goto end;
 338
 339 error:
 340         ret = -1;
 341
 342 end:
 343         return ret;
 344 }
 345
 346 static
 347 void destroy_dmesg_component(struct dmesg_component *dmesg_comp)
 348 {
 349         if (!dmesg_comp) {
 350                 return;
 351         }
 352
 353         if (dmesg_comp->params.path) {
 354                 g_string_free(dmesg_comp->params.path, TRUE);
 355         }
 356
 357         bt_packet_put_ref(dmesg_comp->packet);
 358         bt_trace_put_ref(dmesg_comp->trace);
 359         bt_stream_class_put_ref(dmesg_comp->stream_class);
 360         bt_event_class_put_ref(dmesg_comp->event_class);
 361         bt_stream_put_ref(dmesg_comp->stream);
 362         bt_clock_class_put_ref(dmesg_comp->clock_class);
 363         g_free(dmesg_comp);
 364 }
 365
 366 static
 367 bt_self_component_status create_port(
 368                 bt_self_component_source *self_comp)
 369 {
 370         return bt_self_component_source_add_output_port(self_comp,
 371                 "out", NULL, NULL);
 372 }
 373
 374 BT_HIDDEN
 375 bt_self_component_status dmesg_init(
 376                 bt_self_component_source *self_comp,
 377                 bt_value *params, void *init_method_data)
 378 {
 379         int ret = 0;
 380         struct dmesg_component *dmesg_comp = g_new0(struct dmesg_component, 1);
 381         bt_self_component_status status = BT_SELF_COMPONENT_STATUS_OK;
 382
 383         if (!dmesg_comp) {
 384                 BT_LOGE_STR("Failed to allocate one dmesg component structure.");
 385                 goto error;
 386         }
 387
 388         dmesg_comp->self_comp = self_comp;
 389         dmesg_comp->params.path = g_string_new(NULL);
 390         if (!dmesg_comp->params.path) {
 391                 BT_LOGE_STR("Failed to allocate a GString.");
 392                 goto error;
 393         }
 394
 395         ret = handle_params(dmesg_comp, params);
 396         if (ret) {
 397                 BT_LOGE("Invalid parameters: comp-addr=%p", self_comp);
 398                 goto error;
 399         }
 400
 401         if (!dmesg_comp->params.read_from_stdin &&
 402                         !g_file_test(dmesg_comp->params.path->str,
 403                         G_FILE_TEST_IS_REGULAR)) {
 404                 BT_LOGE("Input path is not a regular file: "
 405                         "comp-addr=%p, path=\"%s\"", self_comp,
 406                         dmesg_comp->params.path->str);
 407                 goto error;
 408         }
 409
 410         status = create_port(self_comp);
 411         if (status != BT_SELF_COMPONENT_STATUS_OK) {
 412                 goto error;
 413         }
 414
 415         bt_self_component_set_data(
 416                 bt_self_component_source_as_self_component(self_comp),
 417                 dmesg_comp);
 418         goto end;
 419
 420 error:
 421         destroy_dmesg_component(dmesg_comp);
 422         bt_self_component_set_data(
 423                 bt_self_component_source_as_self_component(self_comp),
 424                 NULL);
 425
 426         if (status >= 0) {
 427                 status = BT_SELF_COMPONENT_STATUS_ERROR;
 428         }
 429
 430 end:
 431         return status;
 432 }
 433
 434 BT_HIDDEN
 435 void dmesg_finalize(bt_self_component_source *self_comp)
 436 {
 437         destroy_dmesg_component(bt_self_component_get_data(
 438                 bt_self_component_source_as_self_component(self_comp)));
 439 }
 440
 441 static
 442 bt_message *create_init_event_msg_from_line(
 443                 struct dmesg_msg_iter *msg_iter,
 444                 const char *line, const char **new_start)
 445 {
 446         bt_event *event;
 447         bt_message *msg = NULL;
 448         bool has_timestamp = false;
 449         unsigned long sec, usec, msec;
 450         unsigned int year, mon, mday, hour, min;
 451         uint64_t ts = 0;
 452         int ret = 0;
 453         struct dmesg_component *dmesg_comp = msg_iter->dmesg_comp;
 454
 455         *new_start = line;
 456
 457         if (dmesg_comp->params.no_timestamp) {
 458                 goto skip_ts;
 459         }
 460
 461         /* Extract time from input line */
 462         if (sscanf(line, "[%lu.%lu] ", &sec, &usec) == 2) {
 463                 ts = (uint64_t) sec * USEC_PER_SEC + (uint64_t) usec;
 464
 465                 /*
 466                  * The clock class we use has a 1 GHz frequency: convert
 467                  * from µs to ns.
 468                  */
 469                 ts *= NSEC_PER_USEC;
 470                 has_timestamp = true;
 471         } else if (sscanf(line, "[%u-%u-%u %u:%u:%lu.%lu] ",
 472                         &year, &mon, &mday, &hour, &min,
 473                         &sec, &msec) == 7) {
 474                 time_t ep_sec;
 475                 struct tm ti;
 476
 477                 memset(&ti, 0, sizeof(ti));
 478                 ti.tm_year = year - 1900;       /* From 1900 */
 479                 ti.tm_mon = mon - 1;            /* 0 to 11 */
 480                 ti.tm_mday = mday;
 481                 ti.tm_hour = hour;
 482                 ti.tm_min = min;
 483                 ti.tm_sec = sec;
 484
 485                 ep_sec = bt_timegm(&ti);
 486                 if (ep_sec != (time_t) -1) {
 487                         ts = (uint64_t) ep_sec * NSEC_PER_SEC
 488                                 + (uint64_t) msec * NSEC_PER_MSEC;
 489                 }
 490
 491                 has_timestamp = true;
 492         }
 493
 494         if (has_timestamp) {
 495                 /* Set new start for the message portion of the line */
 496                 *new_start = strchr(line, ']');
 497                 BT_ASSERT(*new_start);
 498                 (*new_start)++;
 499
 500                 if ((*new_start)[0] == ' ') {
 501                         (*new_start)++;
 502                 }
 503         }
 504
 505 skip_ts:
 506         /*
 507          * At this point, we know if the stream class's event header
 508          * field class should have a timestamp or not, so we can lazily
 509          * create the metadata, stream, and packet objects.
 510          */
 511         ret = try_create_meta_stream_packet(dmesg_comp, has_timestamp);
 512         if (ret) {
 513                 /* try_create_meta_stream_packet() logs errors */
 514                 goto error;
 515         }
 516
 517         msg = bt_message_event_create(msg_iter->pc_msg_iter,
 518                 dmesg_comp->event_class, dmesg_comp->packet);
 519         if (!msg) {
 520                 BT_LOGE_STR("Cannot create event message.");
 521                 goto error;
 522         }
 523
 524         event = bt_message_event_borrow_event(msg);
 525         BT_ASSERT(event);
 526
 527         if (dmesg_comp->clock_class) {
 528                 bt_event_set_default_clock_snapshot(event, ts);
 529         }
 530
 531         goto end;
 532
 533 error:
 534         BT_MESSAGE_PUT_REF_AND_RESET(msg);
 535
 536 end:
 537         return msg;
 538 }
 539
 540 static
 541 int fill_event_payload_from_line(const char *line,
 542                 bt_event *event)
 543 {
 544         bt_field *ep_field = NULL;
 545         bt_field *str_field = NULL;
 546         size_t len;
 547         int ret;
 548
 549         ep_field = bt_event_borrow_payload_field(event);
 550         BT_ASSERT(ep_field);
 551         str_field = bt_field_structure_borrow_member_field_by_index(
 552                 ep_field, 0);
 553         if (!str_field) {
 554                 BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field.");
 555                 goto error;
 556         }
 557
 558         len = strlen(line);
 559         if (line[len - 1] == '\n') {
 560                 /* Do not include the newline character in the payload */
 561                 len--;
 562         }
 563
 564         ret = bt_field_string_clear(str_field);
 565         if (ret) {
 566                 BT_LOGE_STR("Cannot clear string field object.");
 567                 goto error;
 568         }
 569
 570         ret = bt_field_string_append_with_length(str_field, line, len);
 571         if (ret) {
 572                 BT_LOGE("Cannot append value to string field object: "
 573                         "len=%zu", len);
 574                 goto error;
 575         }
 576
 577         goto end;
 578
 579 error:
 580         ret = -1;
 581
 582 end:
 583         return ret;
 584 }
 585
 586 static
 587 bt_message *create_msg_from_line(
 588                 struct dmesg_msg_iter *dmesg_msg_iter, const char *line)
 589 {
 590         bt_event *event = NULL;
 591         bt_message *msg = NULL;
 592         const char *new_start;
 593         int ret;
 594
 595         msg = create_init_event_msg_from_line(dmesg_msg_iter,
 596                 line, &new_start);
 597         if (!msg) {
 598                 BT_LOGE_STR("Cannot create and initialize event message from line.");
 599                 goto error;
 600         }
 601
 602         event = bt_message_event_borrow_event(msg);
 603         BT_ASSERT(event);
 604         ret = fill_event_payload_from_line(new_start, event);
 605         if (ret) {
 606                 BT_LOGE("Cannot fill event payload field from line: "
 607                         "ret=%d", ret);
 608                 goto error;
 609         }
 610
 611         goto end;
 612
 613 error:
 614         BT_MESSAGE_PUT_REF_AND_RESET(msg);
 615
 616 end:
 617         return msg;
 618 }
 619
 620 static
 621 void destroy_dmesg_msg_iter(struct dmesg_msg_iter *dmesg_msg_iter)
 622 {
 623         if (!dmesg_msg_iter) {
 624                 return;
 625         }
 626
 627         if (dmesg_msg_iter->fp && dmesg_msg_iter->fp != stdin) {
 628                 if (fclose(dmesg_msg_iter->fp)) {
 629                         BT_LOGE_ERRNO("Cannot close input file", ".");
 630                 }
 631         }
 632
 633         bt_message_put_ref(dmesg_msg_iter->tmp_event_msg);
 634         free(dmesg_msg_iter->linebuf);
 635         g_free(dmesg_msg_iter);
 636 }
 637
 638 BT_HIDDEN
 639 bt_self_message_iterator_status dmesg_msg_iter_init(
 640                 bt_self_message_iterator *self_msg_iter,
 641                 bt_self_component_source *self_comp,
 642                 bt_self_component_port_output *self_port)
 643 {
 644         struct dmesg_component *dmesg_comp;
 645         struct dmesg_msg_iter *dmesg_msg_iter =
 646                 g_new0(struct dmesg_msg_iter, 1);
 647         bt_self_message_iterator_status status =
 648                 BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
 649
 650         if (!dmesg_msg_iter) {
 651                 BT_LOGE_STR("Failed to allocate on dmesg message iterator structure.");
 652                 goto error;
 653         }
 654
 655         dmesg_comp = bt_self_component_get_data(
 656                 bt_self_component_source_as_self_component(self_comp));
 657         BT_ASSERT(dmesg_comp);
 658         dmesg_msg_iter->dmesg_comp = dmesg_comp;
 659         dmesg_msg_iter->pc_msg_iter = self_msg_iter;
 660
 661         if (dmesg_comp->params.read_from_stdin) {
 662                 dmesg_msg_iter->fp = stdin;
 663         } else {
 664                 dmesg_msg_iter->fp = fopen(dmesg_comp->params.path->str, "r");
 665                 if (!dmesg_msg_iter->fp) {
 666                         BT_LOGE_ERRNO("Cannot open input file in read mode", ": path=\"%s\"",
 667                                 dmesg_comp->params.path->str);
 668                         goto error;
 669                 }
 670         }
 671
 672         bt_self_message_iterator_set_data(self_msg_iter,
 673                 dmesg_msg_iter);
 674         goto end;
 675
 676 error:
 677         destroy_dmesg_msg_iter(dmesg_msg_iter);
 678         bt_self_message_iterator_set_data(self_msg_iter, NULL);
 679         if (status >= 0) {
 680                 status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
 681         }
 682
 683 end:
 684         return status;
 685 }
 686
 687 BT_HIDDEN
 688 void dmesg_msg_iter_finalize(
 689                 bt_self_message_iterator *priv_msg_iter)
 690 {
 691         destroy_dmesg_msg_iter(bt_self_message_iterator_get_data(
 692                 priv_msg_iter));
 693 }
 694
 695 static
 696 bt_self_message_iterator_status dmesg_msg_iter_next_one(
 697                 struct dmesg_msg_iter *dmesg_msg_iter,
 698                 bt_message **msg)
 699 {
 700         ssize_t len;
 701         struct dmesg_component *dmesg_comp;
 702         bt_self_message_iterator_status status =
 703                 BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
 704
 705         BT_ASSERT(dmesg_msg_iter);
 706         dmesg_comp = dmesg_msg_iter->dmesg_comp;
 707         BT_ASSERT(dmesg_comp);
 708
 709         if (dmesg_msg_iter->state == STATE_DONE) {
 710                 status = BT_SELF_MESSAGE_ITERATOR_STATUS_END;
 711                 goto end;
 712         }
 713
 714         if (dmesg_msg_iter->tmp_event_msg ||
 715                         dmesg_msg_iter->state == STATE_EMIT_PACKET_END ||
 716                         dmesg_msg_iter->state == STATE_EMIT_STREAM_ACTIVITY_END ||
 717                         dmesg_msg_iter->state == STATE_EMIT_STREAM_END) {
 718                 goto handle_state;
 719         }
 720
 721         while (true) {
 722                 const char *ch;
 723                 bool only_spaces = true;
 724
 725                 len = bt_getline(&dmesg_msg_iter->linebuf,
 726                         &dmesg_msg_iter->linebuf_len, dmesg_msg_iter->fp);
 727                 if (len < 0) {
 728                         if (errno == EINVAL) {
 729                                 status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
 730                         } else if (errno == ENOMEM) {
 731                                 status =
 732                                         BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM;
 733                         } else {
 734                                 if (dmesg_msg_iter->state == STATE_EMIT_STREAM_BEGINNING) {
 735                                         /* Stream did not even begin */
 736                                         status = BT_SELF_MESSAGE_ITERATOR_STATUS_END;
 737                                         goto end;
 738                                 } else {
 739                                         /* End current packet now */
 740                                         dmesg_msg_iter->state =
 741                                                 STATE_EMIT_PACKET_END;
 742                                         goto handle_state;
 743                                 }
 744                         }
 745
 746                         goto end;
 747                 }
 748
 749                 BT_ASSERT(dmesg_msg_iter->linebuf);
 750
 751                 /* Ignore empty lines, once trimmed */
 752                 for (ch = dmesg_msg_iter->linebuf; *ch != '\0'; ch++) {
 753                         if (!isspace(*ch)) {
 754                                 only_spaces = false;
 755                                 break;
 756                         }
 757                 }
 758
 759                 if (!only_spaces) {
 760                         break;
 761                 }
 762         }
 763
 764         dmesg_msg_iter->tmp_event_msg = create_msg_from_line(
 765                 dmesg_msg_iter, dmesg_msg_iter->linebuf);
 766         if (!dmesg_msg_iter->tmp_event_msg) {
 767                 BT_LOGE("Cannot create event message from line: "
 768                         "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp,
 769                         dmesg_msg_iter->linebuf);
 770                 goto end;
 771         }
 772
 773 handle_state:
 774         BT_ASSERT(dmesg_comp->trace);
 775
 776         switch (dmesg_msg_iter->state) {
 777         case STATE_EMIT_STREAM_BEGINNING:
 778                 BT_ASSERT(dmesg_msg_iter->tmp_event_msg);
 779                 *msg = bt_message_stream_beginning_create(
 780                         dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream);
 781                 dmesg_msg_iter->state = STATE_EMIT_STREAM_ACTIVITY_BEGINNING;
 782                 break;
 783         case STATE_EMIT_STREAM_ACTIVITY_BEGINNING:
 784                 BT_ASSERT(dmesg_msg_iter->tmp_event_msg);
 785                 *msg = bt_message_stream_activity_beginning_create(
 786                         dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream);
 787                 dmesg_msg_iter->state = STATE_EMIT_PACKET_BEGINNING;
 788                 break;
 789         case STATE_EMIT_PACKET_BEGINNING:
 790                 BT_ASSERT(dmesg_msg_iter->tmp_event_msg);
 791                 *msg = bt_message_packet_beginning_create(
 792                         dmesg_msg_iter->pc_msg_iter, dmesg_comp->packet);
 793                 dmesg_msg_iter->state = STATE_EMIT_EVENT;
 794                 break;
 795         case STATE_EMIT_EVENT:
 796                 BT_ASSERT(dmesg_msg_iter->tmp_event_msg);
 797                 *msg = dmesg_msg_iter->tmp_event_msg;
 798                 dmesg_msg_iter->tmp_event_msg = NULL;
 799                 break;
 800         case STATE_EMIT_PACKET_END:
 801                 *msg = bt_message_packet_end_create(
 802                         dmesg_msg_iter->pc_msg_iter, dmesg_comp->packet);
 803                 dmesg_msg_iter->state = STATE_EMIT_STREAM_ACTIVITY_END;
 804                 break;
 805         case STATE_EMIT_STREAM_ACTIVITY_END:
 806                 *msg = bt_message_stream_activity_end_create(
 807                         dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream);
 808                 dmesg_msg_iter->state = STATE_EMIT_STREAM_END;
 809                 break;
 810         case STATE_EMIT_STREAM_END:
 811                 *msg = bt_message_stream_end_create(
 812                         dmesg_msg_iter->pc_msg_iter, dmesg_comp->stream);
 813                 dmesg_msg_iter->state = STATE_DONE;
 814                 break;
 815         default:
 816                 break;
 817         }
 818
 819         if (!*msg) {
 820                 BT_LOGE("Cannot create message: dmesg-comp-addr=%p",
 821                         dmesg_comp);
 822                 status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
 823         }
 824
 825 end:
 826         return status;
 827 }
 828
 829 BT_HIDDEN
 830 bt_self_message_iterator_status dmesg_msg_iter_next(
 831                 bt_self_message_iterator *self_msg_iter,
 832                 bt_message_array_const msgs, uint64_t capacity,
 833                 uint64_t *count)
 834 {
 835         struct dmesg_msg_iter *dmesg_msg_iter =
 836                 bt_self_message_iterator_get_data(
 837                         self_msg_iter);
 838         bt_self_message_iterator_status status =
 839                 BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
 840         uint64_t i = 0;
 841
 842         while (i < capacity &&
 843                         status == BT_SELF_MESSAGE_ITERATOR_STATUS_OK) {
 844                 bt_message *priv_msg = NULL;
 845
 846                 status = dmesg_msg_iter_next_one(dmesg_msg_iter,
 847                         &priv_msg);
 848                 msgs[i] = priv_msg;
 849                 if (status == BT_SELF_MESSAGE_ITERATOR_STATUS_OK) {
 850                         i++;
 851                 }
 852         }
 853
 854         if (i > 0) {
 855                 /*
 856                  * Even if dmesg_msg_iter_next_one() returned
 857                  * something else than
 858                  * BT_SELF_MESSAGE_ITERATOR_STATUS_OK, we
 859                  * accumulated message objects in the output
 860                  * message array, so we need to return
 861                  * BT_SELF_MESSAGE_ITERATOR_STATUS_OK so that they
 862                  * are transfered to downstream. This other status
 863                  * occurs again the next time muxer_msg_iter_do_next()
 864                  * is called, possibly without any accumulated
 865                  * message, in which case we'll return it.
 866                  */
 867                 *count = i;
 868                 status = BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
 869         }
 870
 871         return status;
 872 }