src/plugins/text/dmesg/dmesg.c

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
   5  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   6  */
   7
   8 #define BT_COMP_LOG_SELF_COMP (dmesg_comp->self_comp)
   9 #define BT_LOG_OUTPUT_LEVEL (dmesg_comp->log_level)
  10 #define BT_LOG_TAG "PLUGIN/SRC.TEXT.DMESG"
  11 #include "logging/comp-logging.h"
  12
  13 #include "dmesg.h"
  14
  15 #include <stdbool.h>
  16 #include <string.h>
  17 #include <ctype.h>
  18 #include <stdio.h>
  19 #include "common/common.h"
  20 #include "common/assert.h"
  21 #include <babeltrace2/babeltrace.h>
  22 #include "compat/utc.h"
  23 #include "compat/stdio.h"
  24 #include <glib.h>
  25 #include "plugins/common/param-validation/param-validation.h"
  26
  27 #define NSEC_PER_USEC 1000UL
  28 #define NSEC_PER_MSEC 1000000UL
  29 #define NSEC_PER_SEC 1000000000ULL
  30 #define USEC_PER_SEC 1000000UL
  31
  32 struct dmesg_component;
  33
  34 struct dmesg_msg_iter {
  35         struct dmesg_component *dmesg_comp;
  36
  37         /* Weak */
  38         bt_self_message_iterator *self_msg_iter;
  39
  40         char *linebuf;
  41         size_t linebuf_len;
  42         FILE *fp;
  43         bt_message *tmp_event_msg;
  44         uint64_t last_clock_value;
  45
  46         enum {
  47                 STATE_EMIT_STREAM_BEGINNING,
  48                 STATE_EMIT_EVENT,
  49                 STATE_EMIT_STREAM_END,
  50                 STATE_DONE,
  51         } state;
  52 };
  53
  54 struct dmesg_component {
  55         bt_logging_level log_level;
  56
  57         struct {
  58                 GString *path;
  59                 bt_bool read_from_stdin;
  60                 bt_bool no_timestamp;
  61         } params;
  62
  63         bt_self_component_source *self_comp_src;
  64         bt_self_component *self_comp;
  65         bt_trace_class *trace_class;
  66         bt_stream_class *stream_class;
  67         bt_event_class *event_class;
  68         bt_trace *trace;
  69         bt_stream *stream;
  70         bt_clock_class *clock_class;
  71 };
  72
  73 static
  74 bt_field_class *create_event_payload_fc(struct dmesg_component *dmesg_comp,
  75                 bt_trace_class *trace_class)
  76 {
  77         bt_field_class *root_fc = NULL;
  78         bt_field_class *fc = NULL;
  79         bt_field_class_structure_append_member_status append_member_status;
  80
  81         root_fc = bt_field_class_structure_create(trace_class);
  82         if (!root_fc) {
  83                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
  84                         "Cannot create an empty structure field class object.");
  85                 goto error;
  86         }
  87
  88         fc = bt_field_class_string_create(trace_class);
  89         if (!fc) {
  90                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
  91                         "Cannot create a string field class object.");
  92                 goto error;
  93         }
  94
  95         append_member_status = bt_field_class_structure_append_member(root_fc,
  96                 "str", fc);
  97         if (append_member_status != BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK) {
  98                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
  99                         "Cannot add `str` member to structure field class: ret=%d",
 100                         append_member_status);
 101                 goto error;
 102         }
 103
 104         goto end;
 105
 106 error:
 107         BT_FIELD_CLASS_PUT_REF_AND_RESET(root_fc);
 108
 109 end:
 110         bt_field_class_put_ref(fc);
 111         return root_fc;
 112 }
 113
 114 static
 115 int create_meta(struct dmesg_component *dmesg_comp, bool has_ts)
 116 {
 117         bt_field_class *fc = NULL;
 118         int ret = 0;
 119
 120         dmesg_comp->trace_class = bt_trace_class_create(dmesg_comp->self_comp);
 121         if (!dmesg_comp->trace_class) {
 122                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 123                         "Cannot create an empty trace class object.");
 124                 goto error;
 125         }
 126
 127         dmesg_comp->stream_class = bt_stream_class_create(
 128                 dmesg_comp->trace_class);
 129         if (!dmesg_comp->stream_class) {
 130                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 131                         "Cannot create a stream class object.");
 132                 goto error;
 133         }
 134
 135         if (has_ts) {
 136                 dmesg_comp->clock_class = bt_clock_class_create(
 137                         dmesg_comp->self_comp);
 138                 if (!dmesg_comp->clock_class) {
 139                         BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 140                                 "Cannot create clock class.");
 141                         goto error;
 142                 }
 143
 144                 /*
 145                  * The `dmesg` timestamp's origin is not the Unix epoch,
 146                  * it's the boot time.
 147                  */
 148                 bt_clock_class_set_origin_is_unix_epoch(dmesg_comp->clock_class,
 149                         BT_FALSE);
 150
 151                 ret = bt_stream_class_set_default_clock_class(
 152                         dmesg_comp->stream_class, dmesg_comp->clock_class);
 153                 if (ret) {
 154                         BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 155                                 "Cannot set stream class's default clock class.");
 156                         goto error;
 157                 }
 158         }
 159
 160         dmesg_comp->event_class = bt_event_class_create(
 161                 dmesg_comp->stream_class);
 162         if (!dmesg_comp->event_class) {
 163                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 164                         "Cannot create an event class object.");
 165                 goto error;
 166         }
 167
 168         ret = bt_event_class_set_name(dmesg_comp->event_class, "string");
 169         if (ret) {
 170                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 171                         "Cannot set event class's name.");
 172                 goto error;
 173         }
 174
 175         fc = create_event_payload_fc(dmesg_comp, dmesg_comp->trace_class);
 176         if (!fc) {
 177                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 178                         "Cannot create event payload field class.");
 179                 goto error;
 180         }
 181
 182         ret = bt_event_class_set_payload_field_class(dmesg_comp->event_class, fc);
 183         if (ret) {
 184                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 185                         "Cannot set event class's event payload field class.");
 186                 goto error;
 187         }
 188
 189         goto end;
 190
 191 error:
 192         ret = -1;
 193
 194 end:
 195         bt_field_class_put_ref(fc);
 196         return ret;
 197 }
 198
 199 static
 200 struct bt_param_validation_map_value_entry_descr dmesg_params[] = {
 201         { "no-extract-timestamp", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
 202         { "path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_STRING } },
 203         BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
 204 };
 205
 206 static
 207 bt_component_class_initialize_method_status handle_params(
 208                 struct dmesg_component *dmesg_comp,
 209                 const bt_value *params)
 210 {
 211         const bt_value *no_timestamp = NULL;
 212         const bt_value *path = NULL;
 213         bt_component_class_initialize_method_status status;
 214         enum bt_param_validation_status validation_status;
 215         gchar *validate_error = NULL;
 216
 217         validation_status = bt_param_validation_validate(params,
 218                 dmesg_params, &validate_error);
 219         if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
 220                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
 221                 goto end;
 222         } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
 223                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
 224                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 225                         "%s", validate_error);
 226                 goto end;
 227         }
 228
 229         no_timestamp = bt_value_map_borrow_entry_value_const(params,
 230                 "no-extract-timestamp");
 231         if (no_timestamp) {
 232                 dmesg_comp->params.no_timestamp =
 233                         bt_value_bool_get(no_timestamp);
 234         }
 235
 236         path = bt_value_map_borrow_entry_value_const(params, "path");
 237         if (path) {
 238                 const char *path_str = bt_value_string_get(path);
 239
 240                 g_string_assign(dmesg_comp->params.path, path_str);
 241         } else {
 242                 dmesg_comp->params.read_from_stdin = true;
 243         }
 244
 245         status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
 246 end:
 247         g_free(validate_error);
 248
 249         return status;
 250 }
 251
 252 static
 253 int create_stream_and_trace(struct dmesg_component *dmesg_comp)
 254 {
 255         int ret = 0;
 256         const char *trace_name = NULL;
 257         gchar *basename = NULL;
 258
 259         dmesg_comp->trace = bt_trace_create(dmesg_comp->trace_class);
 260         if (!dmesg_comp->trace) {
 261                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 262                         "Cannot create trace object.");
 263                 goto error;
 264         }
 265
 266         if (dmesg_comp->params.read_from_stdin) {
 267                 trace_name = "STDIN";
 268         } else {
 269                 basename = g_path_get_basename(dmesg_comp->params.path->str);
 270                 BT_ASSERT(basename);
 271
 272                 if (strcmp(basename, G_DIR_SEPARATOR_S) != 0 &&
 273                                 strcmp(basename, ".") != 0) {
 274                         trace_name = basename;
 275                 }
 276         }
 277
 278         if (trace_name) {
 279                 ret = bt_trace_set_name(dmesg_comp->trace, trace_name);
 280                 if (ret) {
 281                         BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 282                                 "Cannot set trace's name: name=\"%s\"",
 283                                 trace_name);
 284                         goto error;
 285                 }
 286         }
 287
 288         dmesg_comp->stream = bt_stream_create(dmesg_comp->stream_class,
 289                 dmesg_comp->trace);
 290         if (!dmesg_comp->stream) {
 291                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 292                         "Cannot create stream object.");
 293                 goto error;
 294         }
 295
 296         goto end;
 297
 298 error:
 299         ret = -1;
 300
 301 end:
 302         g_free(basename);
 303
 304         return ret;
 305 }
 306
 307 static
 308 int try_create_meta_stream(struct dmesg_component *dmesg_comp, bool has_ts)
 309 {
 310         int ret = 0;
 311
 312         if (dmesg_comp->trace) {
 313                 /* Already created */
 314                 goto end;
 315         }
 316
 317         ret = create_meta(dmesg_comp, has_ts);
 318         if (ret) {
 319                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 320                         "Cannot create metadata objects: dmesg-comp-addr=%p",
 321                         dmesg_comp);
 322                 goto error;
 323         }
 324
 325         ret = create_stream_and_trace(dmesg_comp);
 326         if (ret) {
 327                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 328                         "Cannot create stream object: dmesg-comp-addr=%p",
 329                         dmesg_comp);
 330                 goto error;
 331         }
 332
 333         goto end;
 334
 335 error:
 336         ret = -1;
 337
 338 end:
 339         return ret;
 340 }
 341
 342 static
 343 void destroy_dmesg_component(struct dmesg_component *dmesg_comp)
 344 {
 345         if (!dmesg_comp) {
 346                 return;
 347         }
 348
 349         if (dmesg_comp->params.path) {
 350                 g_string_free(dmesg_comp->params.path, TRUE);
 351         }
 352
 353         bt_trace_put_ref(dmesg_comp->trace);
 354         bt_stream_class_put_ref(dmesg_comp->stream_class);
 355         bt_event_class_put_ref(dmesg_comp->event_class);
 356         bt_stream_put_ref(dmesg_comp->stream);
 357         bt_clock_class_put_ref(dmesg_comp->clock_class);
 358         bt_trace_class_put_ref(dmesg_comp->trace_class);
 359         g_free(dmesg_comp);
 360 }
 361
 362 bt_component_class_initialize_method_status dmesg_init(
 363                 bt_self_component_source *self_comp_src,
 364                 bt_self_component_source_configuration *config,
 365                 const bt_value *params, void *init_method_data)
 366 {
 367         struct dmesg_component *dmesg_comp = g_new0(struct dmesg_component, 1);
 368         bt_component_class_initialize_method_status status;
 369         bt_self_component *self_comp =
 370                 bt_self_component_source_as_self_component(self_comp_src);
 371         const bt_component *comp = bt_self_component_as_component(self_comp);
 372         bt_logging_level log_level = bt_component_get_logging_level(comp);
 373         bt_self_component_add_port_status add_port_status;
 374
 375         if (!dmesg_comp) {
 376                 /*
 377                  * Don't use BT_COMP_LOGE_APPEND_CAUSE, as `dmesg_comp` is not
 378                  * initialized.
 379                  */
 380                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
 381                         "Failed to allocate one dmesg component structure.");
 382                 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(self_comp,
 383                         "Failed to allocate one dmesg component structure.");
 384                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
 385                 goto error;
 386         }
 387
 388         dmesg_comp->log_level = log_level;
 389         dmesg_comp->self_comp = self_comp;
 390         dmesg_comp->self_comp_src = self_comp_src;
 391         dmesg_comp->params.path = g_string_new(NULL);
 392         if (!dmesg_comp->params.path) {
 393                 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to allocate a GString.");
 394                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
 395                 goto error;
 396         }
 397
 398         status = handle_params(dmesg_comp, params);
 399         if (status != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) {
 400                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 401                         "Invalid parameters: comp-addr=%p", self_comp);
 402                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
 403                 goto error;
 404         }
 405
 406         if (!dmesg_comp->params.read_from_stdin &&
 407                         !g_file_test(dmesg_comp->params.path->str,
 408                         G_FILE_TEST_IS_REGULAR)) {
 409                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 410                         "Input path is not a regular file: "
 411                         "comp-addr=%p, path=\"%s\"", self_comp,
 412                         dmesg_comp->params.path->str);
 413                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
 414                 goto error;
 415         }
 416
 417         add_port_status = bt_self_component_source_add_output_port(
 418                 self_comp_src, "out", NULL, NULL);
 419         if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
 420                 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to add output port.");
 421                 status = (int) add_port_status;
 422                 goto error;
 423         }
 424
 425         bt_self_component_set_data(self_comp, dmesg_comp);
 426         BT_COMP_LOGI_STR("Component initialized.");
 427
 428         status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
 429         goto end;
 430
 431 error:
 432         destroy_dmesg_component(dmesg_comp);
 433         bt_self_component_set_data(self_comp, NULL);
 434
 435 end:
 436         return status;
 437 }
 438
 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_DBG(*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 and stream objects.
 514          */
 515         ret = try_create_meta_stream(dmesg_comp, has_timestamp);
 516         if (ret) {
 517                 /* try_create_meta_stream() 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->self_msg_iter,
 524                         dmesg_comp->event_class, dmesg_comp->stream, ts);
 525                 msg_iter->last_clock_value = ts;
 526         } else {
 527                 msg = bt_message_event_create(msg_iter->self_msg_iter,
 528                         dmesg_comp->event_class, dmesg_comp->stream);
 529         }
 530
 531         if (!msg) {
 532                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 533                         "Cannot create event message.");
 534                 goto error;
 535         }
 536
 537         event = bt_message_event_borrow_event(msg);
 538         BT_ASSERT_DBG(event);
 539         goto end;
 540
 541 error:
 542         BT_MESSAGE_PUT_REF_AND_RESET(msg);
 543
 544 end:
 545         return msg;
 546 }
 547
 548 static
 549 int fill_event_payload_from_line(struct dmesg_component *dmesg_comp,
 550                 const char *line, bt_event *event)
 551 {
 552         bt_field *ep_field = NULL;
 553         bt_field *str_field = NULL;
 554         size_t len;
 555         int ret;
 556
 557         ep_field = bt_event_borrow_payload_field(event);
 558         BT_ASSERT_DBG(ep_field);
 559         str_field = bt_field_structure_borrow_member_field_by_index(
 560                 ep_field, 0);
 561         if (!str_field) {
 562                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 563                         "Cannot borrow `timestamp` field from event payload structure field.");
 564                 goto error;
 565         }
 566
 567         len = strlen(line);
 568         if (line[len - 1] == '\n') {
 569                 /* Do not include the newline character in the payload */
 570                 len--;
 571         }
 572
 573         bt_field_string_clear(str_field);
 574         ret = bt_field_string_append_with_length(str_field, line, len);
 575         if (ret) {
 576                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 577                         "Cannot append value to string field object: len=%zu", len);
 578                 goto error;
 579         }
 580
 581         goto end;
 582
 583 error:
 584         ret = -1;
 585
 586 end:
 587         return ret;
 588 }
 589
 590 static
 591 bt_message *create_msg_from_line(
 592                 struct dmesg_msg_iter *dmesg_msg_iter, const char *line)
 593 {
 594         struct dmesg_component *dmesg_comp = dmesg_msg_iter->dmesg_comp;
 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_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 604                         "Cannot create and initialize event message from line.");
 605                 goto error;
 606         }
 607
 608         event = bt_message_event_borrow_event(msg);
 609         BT_ASSERT_DBG(event);
 610         ret = fill_event_payload_from_line(dmesg_comp, new_start, event);
 611         if (ret) {
 612                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 613                         "Cannot fill event payload field from line: ret=%d", ret);
 614                 goto error;
 615         }
 616
 617         goto end;
 618
 619 error:
 620         BT_MESSAGE_PUT_REF_AND_RESET(msg);
 621
 622 end:
 623         return msg;
 624 }
 625
 626 static
 627 void destroy_dmesg_msg_iter(struct dmesg_msg_iter *dmesg_msg_iter)
 628 {
 629         struct dmesg_component *dmesg_comp;
 630
 631         if (!dmesg_msg_iter) {
 632                 return;
 633         }
 634
 635         dmesg_comp = dmesg_msg_iter->dmesg_comp;
 636
 637         if (dmesg_msg_iter->fp && dmesg_msg_iter->fp != stdin) {
 638                 if (fclose(dmesg_msg_iter->fp)) {
 639                         BT_COMP_LOGE_APPEND_CAUSE_ERRNO(dmesg_comp->self_comp,
 640                                 "Cannot close input file", ".");
 641                 }
 642         }
 643
 644         bt_message_put_ref(dmesg_msg_iter->tmp_event_msg);
 645         free(dmesg_msg_iter->linebuf);
 646         g_free(dmesg_msg_iter);
 647 }
 648
 649
 650
 651 bt_message_iterator_class_initialize_method_status dmesg_msg_iter_init(
 652                 bt_self_message_iterator *self_msg_iter,
 653                 bt_self_message_iterator_configuration *config,
 654                 bt_self_component_port_output *self_port)
 655 {
 656         bt_self_component *self_comp =
 657                 bt_self_message_iterator_borrow_component(self_msg_iter);
 658         struct dmesg_component *dmesg_comp = bt_self_component_get_data(self_comp);
 659         struct dmesg_msg_iter *dmesg_msg_iter =
 660                 g_new0(struct dmesg_msg_iter, 1);
 661         bt_message_iterator_class_initialize_method_status status;
 662
 663         if (!dmesg_msg_iter) {
 664                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 665                         "Failed to allocate on dmesg message iterator structure.");
 666                 status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
 667                 goto error;
 668         }
 669
 670         BT_ASSERT(dmesg_comp);
 671         dmesg_msg_iter->dmesg_comp = dmesg_comp;
 672         dmesg_msg_iter->self_msg_iter = self_msg_iter;
 673
 674         if (dmesg_comp->params.read_from_stdin) {
 675                 dmesg_msg_iter->fp = stdin;
 676         } else {
 677                 dmesg_msg_iter->fp = fopen(dmesg_comp->params.path->str, "r");
 678                 if (!dmesg_msg_iter->fp) {
 679                         BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
 680                                 "Cannot open input file in read mode", ": path=\"%s\"",
 681                                 dmesg_comp->params.path->str);
 682                         status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
 683                         goto error;
 684                 }
 685         }
 686
 687         bt_self_message_iterator_set_data(self_msg_iter,
 688                 dmesg_msg_iter);
 689
 690         status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK;
 691         goto end;
 692
 693 error:
 694         destroy_dmesg_msg_iter(dmesg_msg_iter);
 695         bt_self_message_iterator_set_data(self_msg_iter, NULL);
 696
 697 end:
 698         return status;
 699 }
 700
 701 void dmesg_msg_iter_finalize(
 702                 bt_self_message_iterator *priv_msg_iter)
 703 {
 704         destroy_dmesg_msg_iter(bt_self_message_iterator_get_data(
 705                 priv_msg_iter));
 706 }
 707
 708 static
 709 bt_message_iterator_class_next_method_status dmesg_msg_iter_next_one(
 710                 struct dmesg_msg_iter *dmesg_msg_iter,
 711                 bt_message **msg)
 712 {
 713         ssize_t len;
 714         struct dmesg_component *dmesg_comp;
 715         bt_message_iterator_class_next_method_status status;
 716
 717         BT_ASSERT_DBG(dmesg_msg_iter);
 718         dmesg_comp = dmesg_msg_iter->dmesg_comp;
 719         BT_ASSERT_DBG(dmesg_comp);
 720
 721         if (dmesg_msg_iter->state == STATE_DONE) {
 722                 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END;
 723                 goto end;
 724         }
 725
 726         if (dmesg_msg_iter->tmp_event_msg ||
 727                         dmesg_msg_iter->state == STATE_EMIT_STREAM_END) {
 728                 goto handle_state;
 729         }
 730
 731         while (true) {
 732                 const char *ch;
 733                 bool only_spaces = true;
 734
 735                 len = bt_getline(&dmesg_msg_iter->linebuf,
 736                         &dmesg_msg_iter->linebuf_len, dmesg_msg_iter->fp);
 737                 if (len < 0) {
 738                         if (errno == EINVAL) {
 739                                 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
 740                                 goto end;
 741                         } else if (errno == ENOMEM) {
 742                                 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR;
 743                                 goto end;
 744                         } else {
 745                                 if (dmesg_msg_iter->state == STATE_EMIT_STREAM_BEGINNING) {
 746                                         /* Stream did not even begin */
 747                                         status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END;
 748                                         goto end;
 749                                 } else {
 750                                         /* End stream now */
 751                                         dmesg_msg_iter->state =
 752                                                 STATE_EMIT_STREAM_END;
 753                                         goto handle_state;
 754                                 }
 755                         }
 756                 }
 757
 758                 BT_ASSERT_DBG(dmesg_msg_iter->linebuf);
 759
 760                 /* Ignore empty lines, once trimmed */
 761                 for (ch = dmesg_msg_iter->linebuf; *ch != '\0'; ch++) {
 762                         if (!isspace((unsigned char) *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_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 777                         "Cannot create event message from line: "
 778                         "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp,
 779                         dmesg_msg_iter->linebuf);
 780                 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
 781                 goto end;
 782         }
 783
 784 handle_state:
 785         BT_ASSERT_DBG(dmesg_comp->trace);
 786
 787         switch (dmesg_msg_iter->state) {
 788         case STATE_EMIT_STREAM_BEGINNING:
 789                 BT_ASSERT_DBG(dmesg_msg_iter->tmp_event_msg);
 790                 *msg = bt_message_stream_beginning_create(
 791                         dmesg_msg_iter->self_msg_iter, dmesg_comp->stream);
 792                 dmesg_msg_iter->state = STATE_EMIT_EVENT;
 793                 break;
 794         case STATE_EMIT_EVENT:
 795                 BT_ASSERT_DBG(dmesg_msg_iter->tmp_event_msg);
 796                 *msg = dmesg_msg_iter->tmp_event_msg;
 797                 dmesg_msg_iter->tmp_event_msg = NULL;
 798                 break;
 799         case STATE_EMIT_STREAM_END:
 800                 *msg = bt_message_stream_end_create(
 801                         dmesg_msg_iter->self_msg_iter, dmesg_comp->stream);
 802                 dmesg_msg_iter->state = STATE_DONE;
 803                 break;
 804         default:
 805                 break;
 806         }
 807
 808         if (!*msg) {
 809                 BT_COMP_LOGE_APPEND_CAUSE(dmesg_comp->self_comp,
 810                         "Cannot create message: dmesg-comp-addr=%p",
 811                         dmesg_comp);
 812                 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR;
 813                 goto end;
 814         }
 815
 816         status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
 817
 818 end:
 819         return status;
 820 }
 821
 822 bt_message_iterator_class_next_method_status dmesg_msg_iter_next(
 823                 bt_self_message_iterator *self_msg_iter,
 824                 bt_message_array_const msgs, uint64_t capacity,
 825                 uint64_t *count)
 826 {
 827         struct dmesg_msg_iter *dmesg_msg_iter =
 828                 bt_self_message_iterator_get_data(
 829                         self_msg_iter);
 830         bt_message_iterator_class_next_method_status status =
 831                 BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
 832         uint64_t i = 0;
 833
 834         while (i < capacity &&
 835                         status == BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK) {
 836                 bt_message *priv_msg = NULL;
 837
 838                 status = dmesg_msg_iter_next_one(dmesg_msg_iter,
 839                         &priv_msg);
 840                 msgs[i] = priv_msg;
 841                 if (status == BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK) {
 842                         i++;
 843                 }
 844         }
 845
 846         if (i > 0) {
 847                 /*
 848                  * Even if dmesg_msg_iter_next_one() returned
 849                  * something else than
 850                  * BT_SELF_MESSAGE_ITERATOR_STATUS_OK, we
 851                  * accumulated message objects in the output
 852                  * message array, so we need to return
 853                  * BT_SELF_MESSAGE_ITERATOR_STATUS_OK so that they
 854                  * are transfered to downstream. This other status
 855                  * occurs again the next time muxer_msg_iter_do_next()
 856                  * is called, possibly without any accumulated
 857                  * message, in which case we'll return it.
 858                  */
 859                 *count = i;
 860                 status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK;
 861         }
 862
 863         return status;
 864 }
 865
 866 bt_message_iterator_class_can_seek_beginning_method_status
 867 dmesg_msg_iter_can_seek_beginning(
 868                 bt_self_message_iterator *self_msg_iter, bt_bool *can_seek)
 869 {
 870         struct dmesg_msg_iter *dmesg_msg_iter =
 871                 bt_self_message_iterator_get_data(self_msg_iter);
 872
 873         /* Can't seek the beginning of the standard input stream */
 874         *can_seek = !dmesg_msg_iter->dmesg_comp->params.read_from_stdin;
 875
 876         return BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_BEGINNING_METHOD_STATUS_OK;
 877 }
 878
 879 bt_message_iterator_class_seek_beginning_method_status
 880 dmesg_msg_iter_seek_beginning(
 881                 bt_self_message_iterator *self_msg_iter)
 882 {
 883         struct dmesg_msg_iter *dmesg_msg_iter =
 884                 bt_self_message_iterator_get_data(self_msg_iter);
 885
 886         BT_ASSERT(!dmesg_msg_iter->dmesg_comp->params.read_from_stdin);
 887
 888         BT_MESSAGE_PUT_REF_AND_RESET(dmesg_msg_iter->tmp_event_msg);
 889         dmesg_msg_iter->last_clock_value = 0;
 890         dmesg_msg_iter->state = STATE_EMIT_STREAM_BEGINNING;
 891         return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK;
 892 }