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