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