plugins/text/dmesg/dmesg.c

   1 /*
   2  * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
   3  * Copyright 2017 Philippe Proulx <jeremie.galarneau@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "PLUGIN-TEXT-DMESG-SRC"
  25 #include "logging.h"
  26
  27 #include <stdbool.h>
  28 #include <string.h>
  29 #include <ctype.h>
  30 #include <stdio.h>
  31 #include <babeltrace/assert-internal.h>
  32 #include <babeltrace/babeltrace.h>
  33 #include <babeltrace/values-internal.h>
  34 #include <babeltrace/compat/utc-internal.h>
  35 #include <babeltrace/compat/stdio-internal.h>
  36 #include <glib.h>
  37
  38 #define NSEC_PER_USEC 1000UL
  39 #define NSEC_PER_MSEC 1000000UL
  40 #define NSEC_PER_SEC 1000000000ULL
  41 #define USEC_PER_SEC 1000000UL
  42
  43 struct dmesg_component;
  44
  45 struct dmesg_notif_iter {
  46         struct dmesg_component *dmesg_comp;
  47         char *linebuf;
  48         size_t linebuf_len;
  49         FILE *fp;
  50         struct bt_notification *tmp_event_notif;
  51
  52         enum {
  53                 STATE_EMIT_STREAM_BEGINNING,
  54                 STATE_EMIT_PACKET_BEGINNING,
  55                 STATE_EMIT_EVENT,
  56                 STATE_EMIT_PACKET_END,
  57                 STATE_EMIT_STREAM_END,
  58                 STATE_DONE,
  59         } state;
  60 };
  61
  62 struct dmesg_component {
  63         struct {
  64                 GString *path;
  65                 bt_bool read_from_stdin;
  66                 bt_bool no_timestamp;
  67         } params;
  68
  69         struct bt_graph *graph; /* Weak */
  70         struct bt_trace *trace;
  71         struct bt_stream_class *stream_class;
  72         struct bt_event_class *event_class;
  73         struct bt_stream *stream;
  74         struct bt_packet *packet;
  75         struct bt_clock_class *clock_class;
  76         struct bt_clock_class_priority_map *cc_prio_map;
  77 };
  78
  79 static
  80 struct bt_field_type *create_packet_header_ft(void)
  81 {
  82         struct bt_field_type *root_ft = NULL;
  83         struct bt_field_type *ft = NULL;
  84         int ret;
  85
  86         root_ft = bt_field_type_structure_create();
  87         if (!root_ft) {
  88                 BT_LOGE_STR("Cannot create an empty structure field type object.");
  89                 goto error;
  90         }
  91
  92         ft = bt_field_type_integer_create(32);
  93         if (!ft) {
  94                 BT_LOGE_STR("Cannot create an integer field type object.");
  95                 goto error;
  96         }
  97
  98         ret = bt_field_type_structure_add_field(root_ft, ft, "magic");
  99         if (ret) {
 100                 BT_LOGE("Cannot add `magic` field type to structure field type: "
 101                         "ret=%d", ret);
 102                 goto error;
 103         }
 104
 105         BT_PUT(ft);
 106         ft = bt_field_type_integer_create(8);
 107         if (!ft) {
 108                 BT_LOGE_STR("Cannot create an integer field type object.");
 109                 goto error;
 110         }
 111
 112         goto end;
 113
 114 error:
 115         BT_PUT(root_ft);
 116
 117 end:
 118         bt_put(ft);
 119         return root_ft;
 120 }
 121
 122 static
 123 struct bt_field_type *create_event_header_ft(
 124                 struct bt_clock_class *clock_class)
 125 {
 126         struct bt_field_type *root_ft = NULL;
 127         struct bt_field_type *ft = NULL;
 128         int ret;
 129
 130         root_ft = bt_field_type_structure_create();
 131         if (!root_ft) {
 132                 BT_LOGE_STR("Cannot create an empty structure field type object.");
 133                 goto error;
 134         }
 135
 136         ft = bt_field_type_integer_create(64);
 137         if (!ft) {
 138                 BT_LOGE_STR("Cannot create an integer field type object.");
 139                 goto error;
 140         }
 141
 142         ret = bt_field_type_integer_set_mapped_clock_class(ft, clock_class);
 143         if (ret) {
 144                 BT_LOGE("Cannot map integer field type to clock class: "
 145                         "ret=%d", ret);
 146                 goto error;
 147         }
 148
 149         ret = bt_field_type_structure_add_field(root_ft,
 150                 ft, "timestamp");
 151         if (ret) {
 152                 BT_LOGE("Cannot add `timestamp` field type to structure field type: "
 153                         "ret=%d", ret);
 154                 goto error;
 155         }
 156
 157         goto end;
 158
 159 error:
 160         BT_PUT(root_ft);
 161
 162 end:
 163         bt_put(ft);
 164         return root_ft;
 165 }
 166
 167 static
 168 struct bt_field_type *create_event_payload_ft(void)
 169 {
 170         struct bt_field_type *root_ft = NULL;
 171         struct bt_field_type *ft = NULL;
 172         int ret;
 173
 174         root_ft = bt_field_type_structure_create();
 175         if (!root_ft) {
 176                 BT_LOGE_STR("Cannot create an empty structure field type object.");
 177                 goto error;
 178         }
 179
 180         ft = bt_field_type_string_create();
 181         if (!ft) {
 182                 BT_LOGE_STR("Cannot create a string field type object.");
 183                 goto error;
 184         }
 185
 186         ret = bt_field_type_structure_add_field(root_ft,
 187                 ft, "str");
 188         if (ret) {
 189                 BT_LOGE("Cannot add `str` field type to structure field type: "
 190                         "ret=%d", ret);
 191                 goto error;
 192         }
 193
 194         goto end;
 195
 196 error:
 197         BT_PUT(root_ft);
 198
 199 end:
 200         bt_put(ft);
 201         return root_ft;
 202 }
 203
 204 static
 205 struct bt_clock_class *create_clock_class(void)
 206 {
 207         return bt_clock_class_create("the_clock", 1000000000);
 208 }
 209
 210 static
 211 int create_meta(struct dmesg_component *dmesg_comp, bool has_ts)
 212 {
 213         struct bt_field_type *ft = NULL;
 214         const char *trace_name = NULL;
 215         gchar *basename = NULL;
 216         int ret = 0;
 217
 218         dmesg_comp->trace = bt_trace_create();
 219         if (!dmesg_comp->trace) {
 220                 BT_LOGE_STR("Cannot create an empty trace object.");
 221                 goto error;
 222         }
 223
 224         ft = create_packet_header_ft();
 225         if (!ft) {
 226                 BT_LOGE_STR("Cannot create packet header field type.");
 227                 goto error;
 228         }
 229
 230         ret = bt_trace_set_packet_header_field_type(dmesg_comp->trace, ft);
 231         if (ret) {
 232                 BT_LOGE_STR("Cannot set trace's packet header field type.");
 233                 goto error;
 234         }
 235
 236         if (dmesg_comp->params.read_from_stdin) {
 237                 trace_name = "STDIN";
 238         } else {
 239                 basename = g_path_get_basename(dmesg_comp->params.path->str);
 240                 BT_ASSERT(basename);
 241
 242                 if (strcmp(basename, G_DIR_SEPARATOR_S) != 0 &&
 243                                 strcmp(basename, ".") != 0) {
 244                         trace_name = basename;
 245                 }
 246         }
 247
 248         if (trace_name) {
 249                 ret = bt_trace_set_name(dmesg_comp->trace, trace_name);
 250                 if (ret) {
 251                         BT_LOGE("Cannot set trace's name: name=\"%s\"", trace_name);
 252                         goto error;
 253                 }
 254         }
 255
 256         dmesg_comp->stream_class = bt_stream_class_create(NULL);
 257         if (!dmesg_comp->stream_class) {
 258                 BT_LOGE_STR("Cannot create an empty stream class object.");
 259                 goto error;
 260         }
 261
 262         dmesg_comp->cc_prio_map = bt_clock_class_priority_map_create();
 263         if (!dmesg_comp->cc_prio_map) {
 264                 BT_LOGE_STR("Cannot create empty clock class priority map.");
 265                 goto error;
 266         }
 267
 268         if (has_ts) {
 269                 dmesg_comp->clock_class = create_clock_class();
 270                 if (!dmesg_comp->clock_class) {
 271                         BT_LOGE_STR("Cannot create clock class.");
 272                         goto error;
 273                 }
 274
 275                 ret = bt_trace_add_clock_class(dmesg_comp->trace,
 276                         dmesg_comp->clock_class);
 277                 if (ret) {
 278                         BT_LOGE_STR("Cannot add clock class to trace.");
 279                         goto error;
 280                 }
 281
 282                 ret = bt_clock_class_priority_map_add_clock_class(
 283                         dmesg_comp->cc_prio_map, dmesg_comp->clock_class, 0);
 284                 if (ret) {
 285                         BT_LOGE_STR("Cannot add clock class to clock class priority map.");
 286                         goto error;
 287                 }
 288
 289                 bt_put(ft);
 290                 ft = create_event_header_ft(dmesg_comp->clock_class);
 291                 if (!ft) {
 292                         BT_LOGE_STR("Cannot create event header field type.");
 293                         goto error;
 294                 }
 295
 296                 ret = bt_stream_class_set_event_header_field_type(
 297                         dmesg_comp->stream_class, ft);
 298                 if (ret) {
 299                         BT_LOGE_STR("Cannot set stream class's event header field type.");
 300                         goto error;
 301                 }
 302         }
 303
 304         dmesg_comp->event_class = bt_event_class_create("string");
 305         if (!dmesg_comp->event_class) {
 306                 BT_LOGE_STR("Cannot create an empty event class object.");
 307                 goto error;
 308         }
 309
 310         bt_put(ft);
 311         ft = create_event_payload_ft();
 312         if (!ft) {
 313                 BT_LOGE_STR("Cannot create event payload field type.");
 314                 goto error;
 315         }
 316
 317         ret = bt_event_class_set_payload_field_type(dmesg_comp->event_class, ft);
 318         if (ret) {
 319                 BT_LOGE_STR("Cannot set event class's event payload field type.");
 320                 goto error;
 321         }
 322
 323         ret = bt_stream_class_add_event_class(dmesg_comp->stream_class,
 324                 dmesg_comp->event_class);
 325         if (ret) {
 326                 BT_LOGE("Cannot add event class to stream class: ret=%d", ret);
 327                 goto error;
 328         }
 329
 330         ret = bt_trace_add_stream_class(dmesg_comp->trace,
 331                 dmesg_comp->stream_class);
 332         if (ret) {
 333                 BT_LOGE("Cannot add event class to stream class: ret=%d", ret);
 334                 goto error;
 335         }
 336
 337         goto end;
 338
 339 error:
 340         ret = -1;
 341
 342 end:
 343         bt_put(ft);
 344
 345         if (basename) {
 346                 g_free(basename);
 347         }
 348
 349         return ret;
 350 }
 351
 352 static
 353 int handle_params(struct dmesg_component *dmesg_comp, struct bt_value *params)
 354 {
 355         struct bt_value *read_from_stdin = NULL;
 356         struct bt_value *no_timestamp = NULL;
 357         struct bt_value *path = NULL;
 358         const char *path_str;
 359         int ret = 0;
 360
 361         no_timestamp = bt_value_map_get(params, "no-extract-timestamp");
 362         if (no_timestamp) {
 363                 if (!bt_value_is_bool(no_timestamp)) {
 364                         BT_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: "
 365                                 "type=%s",
 366                                 bt_value_type_string(
 367                                         bt_value_get_type(no_timestamp)));
 368                         goto error;
 369                 }
 370
 371                 ret = bt_value_bool_get(no_timestamp,
 372                         &dmesg_comp->params.no_timestamp);
 373                 BT_ASSERT(ret == 0);
 374         }
 375
 376         path = bt_value_map_get(params, "path");
 377         if (path) {
 378                 if (dmesg_comp->params.read_from_stdin) {
 379                         BT_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters.");
 380                         goto error;
 381                 }
 382
 383                 if (!bt_value_is_string(path)) {
 384                         BT_LOGE("Expecting a string value for the `path` parameter: "
 385                                 "type=%s",
 386                                 bt_value_type_string(
 387                                         bt_value_get_type(path)));
 388                         goto error;
 389                 }
 390
 391                 ret = bt_value_string_get(path, &path_str);
 392                 BT_ASSERT(ret == 0);
 393                 g_string_assign(dmesg_comp->params.path, path_str);
 394         } else {
 395                 dmesg_comp->params.read_from_stdin = true;
 396         }
 397
 398         goto end;
 399
 400 error:
 401         ret = -1;
 402
 403 end:
 404         bt_put(read_from_stdin);
 405         bt_put(path);
 406         bt_put(no_timestamp);
 407         return ret;
 408 }
 409
 410 static
 411 int fill_packet_header_field(struct bt_packet *packet)
 412 {
 413         struct bt_field *ph = NULL;
 414         struct bt_field *magic = NULL;
 415         int ret;
 416
 417         ph = bt_packet_borrow_header(packet);
 418         BT_ASSERT(ph);
 419         magic = bt_field_structure_borrow_field_by_name(ph, "magic");
 420         if (!magic) {
 421                 BT_LOGE_STR("Cannot borrow `magic` field from structure field.");
 422                 goto error;
 423         }
 424
 425         ret = bt_field_integer_unsigned_set_value(magic, 0xc1fc1fc1);
 426         BT_ASSERT(ret == 0);
 427         goto end;
 428
 429 error:
 430         ret = -1;
 431
 432 end:
 433         return ret;
 434 }
 435
 436 static
 437 int create_packet_and_stream(struct dmesg_component *dmesg_comp)
 438 {
 439         int ret = 0;
 440
 441         dmesg_comp->stream = bt_stream_create(dmesg_comp->stream_class,
 442                 NULL, 0);
 443         if (!dmesg_comp->stream) {
 444                 BT_LOGE_STR("Cannot create stream object.");
 445                 goto error;
 446         }
 447
 448         dmesg_comp->packet = bt_packet_create(dmesg_comp->stream);
 449         if (!dmesg_comp->packet) {
 450                 BT_LOGE_STR("Cannot create packet object.");
 451                 goto error;
 452         }
 453
 454         ret = fill_packet_header_field(dmesg_comp->packet);
 455         if (ret) {
 456                 BT_LOGE_STR("Cannot fill packet header field.");
 457                 goto error;
 458         }
 459
 460         ret = bt_trace_set_is_static(dmesg_comp->trace);
 461         if (ret) {
 462                 BT_LOGE_STR("Cannot make trace static.");
 463                 goto error;
 464         }
 465
 466         goto end;
 467
 468 error:
 469         ret = -1;
 470
 471 end:
 472         return ret;
 473 }
 474
 475 static
 476 int try_create_meta_stream_packet(struct dmesg_component *dmesg_comp,
 477                 bool has_ts)
 478 {
 479         int ret = 0;
 480
 481         if (dmesg_comp->trace) {
 482                 /* Already created */
 483                 goto end;
 484         }
 485
 486         ret = create_meta(dmesg_comp, has_ts);
 487         if (ret) {
 488                 BT_LOGE("Cannot create metadata objects: dmesg-comp-addr=%p",
 489                         dmesg_comp);
 490                 goto error;
 491         }
 492
 493         ret = create_packet_and_stream(dmesg_comp);
 494         if (ret) {
 495                 BT_LOGE("Cannot create packet and stream objects: "
 496                         "dmesg-comp-addr=%p", dmesg_comp);
 497                 goto error;
 498         }
 499
 500         goto end;
 501
 502 error:
 503         ret = -1;
 504
 505 end:
 506         return ret;
 507 }
 508
 509 static
 510 void destroy_dmesg_component(struct dmesg_component *dmesg_comp)
 511 {
 512         if (!dmesg_comp) {
 513                 return;
 514         }
 515
 516         if (dmesg_comp->params.path) {
 517                 g_string_free(dmesg_comp->params.path, TRUE);
 518         }
 519
 520         bt_put(dmesg_comp->packet);
 521         bt_put(dmesg_comp->trace);
 522         bt_put(dmesg_comp->stream_class);
 523         bt_put(dmesg_comp->event_class);
 524         bt_put(dmesg_comp->stream);
 525         bt_put(dmesg_comp->clock_class);
 526         bt_put(dmesg_comp->cc_prio_map);
 527         g_free(dmesg_comp);
 528 }
 529
 530 static
 531 enum bt_component_status create_port(struct bt_private_component *priv_comp)
 532 {
 533         return bt_private_component_source_add_output_private_port(priv_comp,
 534                 "out", NULL, NULL);
 535 }
 536
 537 BT_HIDDEN
 538 enum bt_component_status dmesg_init(struct bt_private_component *priv_comp,
 539                 struct bt_value *params, void *init_method_data)
 540 {
 541         int ret = 0;
 542         struct dmesg_component *dmesg_comp = g_new0(struct dmesg_component, 1);
 543         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
 544
 545         if (!dmesg_comp) {
 546                 BT_LOGE_STR("Failed to allocate one dmesg component structure.");
 547                 goto error;
 548         }
 549
 550         dmesg_comp->graph = bt_component_borrow_graph(
 551                 bt_component_borrow_from_private(priv_comp));
 552         BT_ASSERT(dmesg_comp->graph);
 553         dmesg_comp->params.path = g_string_new(NULL);
 554         if (!dmesg_comp->params.path) {
 555                 BT_LOGE_STR("Failed to allocate a GString.");
 556                 goto error;
 557         }
 558
 559         ret = handle_params(dmesg_comp, params);
 560         if (ret) {
 561                 BT_LOGE("Invalid parameters: comp-addr=%p", priv_comp);
 562                 goto error;
 563         }
 564
 565         if (!dmesg_comp->params.read_from_stdin &&
 566                         !g_file_test(dmesg_comp->params.path->str,
 567                         G_FILE_TEST_IS_REGULAR)) {
 568                 BT_LOGE("Input path is not a regular file: "
 569                         "comp-addr=%p, path=\"%s\"", priv_comp,
 570                         dmesg_comp->params.path->str);
 571                 goto error;
 572         }
 573
 574         status = create_port(priv_comp);
 575         if (status != BT_COMPONENT_STATUS_OK) {
 576                 goto error;
 577         }
 578
 579         (void) bt_private_component_set_user_data(priv_comp, dmesg_comp);
 580         goto end;
 581
 582 error:
 583         destroy_dmesg_component(dmesg_comp);
 584         (void) bt_private_component_set_user_data(priv_comp, NULL);
 585
 586         if (status >= 0) {
 587                 status = BT_COMPONENT_STATUS_ERROR;
 588         }
 589
 590 end:
 591         return status;
 592 }
 593
 594 BT_HIDDEN
 595 void dmesg_finalize(struct bt_private_component *priv_comp)
 596 {
 597         void *data = bt_private_component_get_user_data(priv_comp);
 598
 599         destroy_dmesg_component(data);
 600 }
 601
 602 static
 603 struct bt_notification *create_init_event_notif_from_line(
 604                 struct dmesg_component *dmesg_comp,
 605                 const char *line, const char **new_start)
 606 {
 607         struct bt_event *event;
 608         struct bt_notification *notif = NULL;
 609         bool has_timestamp = false;
 610         unsigned long sec, usec, msec;
 611         unsigned int year, mon, mday, hour, min;
 612         uint64_t ts = 0;
 613         struct bt_field *eh_field = NULL;
 614         struct bt_field *ts_field = NULL;
 615         int ret = 0;
 616
 617         *new_start = line;
 618
 619         if (dmesg_comp->params.no_timestamp) {
 620                 goto skip_ts;
 621         }
 622
 623         /* Extract time from input line */
 624         if (sscanf(line, "[%lu.%lu] ", &sec, &usec) == 2) {
 625                 ts = (uint64_t) sec * USEC_PER_SEC + (uint64_t) usec;
 626
 627                 /*
 628                  * The clock class we use has a 1 GHz frequency: convert
 629                  * from µs to ns.
 630                  */
 631                 ts *= NSEC_PER_USEC;
 632                 has_timestamp = true;
 633         } else if (sscanf(line, "[%u-%u-%u %u:%u:%lu.%lu] ",
 634                         &year, &mon, &mday, &hour, &min,
 635                         &sec, &msec) == 7) {
 636                 time_t ep_sec;
 637                 struct tm ti;
 638
 639                 memset(&ti, 0, sizeof(ti));
 640                 ti.tm_year = year - 1900;       /* From 1900 */
 641                 ti.tm_mon = mon - 1;            /* 0 to 11 */
 642                 ti.tm_mday = mday;
 643                 ti.tm_hour = hour;
 644                 ti.tm_min = min;
 645                 ti.tm_sec = sec;
 646
 647                 ep_sec = bt_timegm(&ti);
 648                 if (ep_sec != (time_t) -1) {
 649                         ts = (uint64_t) ep_sec * NSEC_PER_SEC
 650                                 + (uint64_t) msec * NSEC_PER_MSEC;
 651                 }
 652
 653                 has_timestamp = true;
 654         }
 655
 656         if (has_timestamp) {
 657                 /* Set new start for the message portion of the line */
 658                 *new_start = strchr(line, ']');
 659                 BT_ASSERT(*new_start);
 660                 (*new_start)++;
 661
 662                 if ((*new_start)[0] == ' ') {
 663                         (*new_start)++;
 664                 }
 665         }
 666
 667 skip_ts:
 668         /*
 669          * At this point, we know if the stream class's event header
 670          * field type should have a timestamp or not, so we can lazily
 671          * create the metadata, stream, and packet objects.
 672          */
 673         ret = try_create_meta_stream_packet(dmesg_comp, has_timestamp);
 674         if (ret) {
 675                 /* try_create_meta_stream_packet() logs errors */
 676                 goto error;
 677         }
 678
 679         notif = bt_notification_event_create(dmesg_comp->graph,
 680                 dmesg_comp->event_class, dmesg_comp->packet,
 681                 dmesg_comp->cc_prio_map);
 682         if (!notif) {
 683                 BT_LOGE_STR("Cannot create event notification.");
 684                 goto error;
 685         }
 686
 687         event = bt_notification_event_borrow_event(notif);
 688         BT_ASSERT(event);
 689
 690         if (dmesg_comp->clock_class) {
 691                 struct bt_clock_value *cv = bt_event_borrow_clock_value(event,
 692                         dmesg_comp->clock_class);
 693
 694                 ret = bt_clock_value_set_value(cv, ts);
 695                 BT_ASSERT(ret == 0);
 696                 eh_field = bt_event_borrow_header(event);
 697                 BT_ASSERT(eh_field);
 698                 ts_field = bt_field_structure_borrow_field_by_name(eh_field,
 699                         "timestamp");
 700                 if (!ts_field) {
 701                         BT_LOGE_STR("Cannot borrow `timestamp` field from event header structure field.");
 702                         goto error;
 703                 }
 704
 705                 ret = bt_field_integer_unsigned_set_value(ts_field, ts);
 706                 BT_ASSERT(ret == 0);
 707         }
 708
 709         goto end;
 710
 711 error:
 712         BT_PUT(notif);
 713
 714 end:
 715         return notif;
 716 }
 717
 718 static
 719 int fill_event_payload_from_line(struct dmesg_component *dmesg_comp,
 720                 const char *line, struct bt_event *event)
 721 {
 722         struct bt_field *ep_field = NULL;
 723         struct bt_field *str_field = NULL;
 724         size_t len;
 725         int ret;
 726
 727         ep_field = bt_event_borrow_payload(event);
 728         BT_ASSERT(ep_field);
 729         str_field = bt_field_structure_borrow_field_by_name(ep_field, "str");
 730         if (!str_field) {
 731                 BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field.");
 732                 goto error;
 733         }
 734
 735         len = strlen(line);
 736         if (line[len - 1] == '\n') {
 737                 /* Do not include the newline character in the payload */
 738                 len--;
 739         }
 740
 741         ret = bt_field_string_clear(str_field);
 742         if (ret) {
 743                 BT_LOGE_STR("Cannot clear string field object.");
 744                 goto error;
 745         }
 746
 747         ret = bt_field_string_append_len(str_field, line, len);
 748         if (ret) {
 749                 BT_LOGE("Cannot append value to string field object: "
 750                         "len=%zu", len);
 751                 goto error;
 752         }
 753
 754         goto end;
 755
 756 error:
 757         ret = -1;
 758
 759 end:
 760         return ret;
 761 }
 762
 763 static
 764 struct bt_notification *create_notif_from_line(
 765                 struct dmesg_component *dmesg_comp, const char *line)
 766 {
 767         struct bt_event *event = NULL;
 768         struct bt_notification *notif = NULL;
 769         const char *new_start;
 770         int ret;
 771
 772         notif = create_init_event_notif_from_line(dmesg_comp, line, &new_start);
 773         if (!notif) {
 774                 BT_LOGE_STR("Cannot create and initialize event notification from line.");
 775                 goto error;
 776         }
 777
 778         event = bt_notification_event_borrow_event(notif);
 779         BT_ASSERT(event);
 780         ret = fill_event_payload_from_line(dmesg_comp, new_start,
 781                 event);
 782         if (ret) {
 783                 BT_LOGE("Cannot fill event payload field from line: "
 784                         "ret=%d", ret);
 785                 goto error;
 786         }
 787
 788         goto end;
 789
 790 error:
 791         BT_PUT(notif);
 792
 793 end:
 794         return notif;
 795 }
 796
 797 static
 798 void destroy_dmesg_notif_iter(struct dmesg_notif_iter *dmesg_notif_iter)
 799 {
 800         if (!dmesg_notif_iter) {
 801                 return;
 802         }
 803
 804         if (dmesg_notif_iter->fp && dmesg_notif_iter->fp != stdin) {
 805                 if (fclose(dmesg_notif_iter->fp)) {
 806                         BT_LOGE_ERRNO("Cannot close input file", ".");
 807                 }
 808         }
 809
 810         bt_put(dmesg_notif_iter->tmp_event_notif);
 811         free(dmesg_notif_iter->linebuf);
 812         g_free(dmesg_notif_iter);
 813 }
 814
 815 BT_HIDDEN
 816 enum bt_notification_iterator_status dmesg_notif_iter_init(
 817                 struct bt_private_connection_private_notification_iterator *priv_notif_iter,
 818                 struct bt_private_port *priv_port)
 819 {
 820         struct bt_private_component *priv_comp = NULL;
 821         struct dmesg_component *dmesg_comp;
 822         struct dmesg_notif_iter *dmesg_notif_iter =
 823                 g_new0(struct dmesg_notif_iter, 1);
 824         enum bt_notification_iterator_status status =
 825                 BT_NOTIFICATION_ITERATOR_STATUS_OK;
 826
 827         if (!dmesg_notif_iter) {
 828                 BT_LOGE_STR("Failed to allocate on dmesg notification iterator structure.");
 829                 goto error;
 830         }
 831
 832         priv_comp = bt_private_connection_private_notification_iterator_get_private_component(
 833                 priv_notif_iter);
 834         BT_ASSERT(priv_comp);
 835         dmesg_comp = bt_private_component_get_user_data(priv_comp);
 836         BT_ASSERT(dmesg_comp);
 837         dmesg_notif_iter->dmesg_comp = dmesg_comp;
 838
 839         if (dmesg_comp->params.read_from_stdin) {
 840                 dmesg_notif_iter->fp = stdin;
 841         } else {
 842                 dmesg_notif_iter->fp = fopen(dmesg_comp->params.path->str, "r");
 843                 if (!dmesg_notif_iter->fp) {
 844                         BT_LOGE_ERRNO("Cannot open input file in read mode", ": path=\"%s\"",
 845                                 dmesg_comp->params.path->str);
 846                         goto error;
 847                 }
 848         }
 849
 850         (void) bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter,
 851                 dmesg_notif_iter);
 852         goto end;
 853
 854 error:
 855         destroy_dmesg_notif_iter(dmesg_notif_iter);
 856         (void) bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter,
 857                 NULL);
 858         if (status >= 0) {
 859                 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 860         }
 861
 862 end:
 863         bt_put(priv_comp);
 864         return status;
 865 }
 866
 867 BT_HIDDEN
 868 void dmesg_notif_iter_finalize(
 869                 struct bt_private_connection_private_notification_iterator *priv_notif_iter)
 870 {
 871         destroy_dmesg_notif_iter(bt_private_connection_private_notification_iterator_get_user_data(
 872                 priv_notif_iter));
 873 }
 874
 875 BT_HIDDEN
 876 struct bt_notification_iterator_next_method_return dmesg_notif_iter_next(
 877                 struct bt_private_connection_private_notification_iterator *priv_notif_iter)
 878 {
 879         ssize_t len;
 880         struct dmesg_notif_iter *dmesg_notif_iter =
 881                 bt_private_connection_private_notification_iterator_get_user_data(
 882                         priv_notif_iter);
 883         struct dmesg_component *dmesg_comp;
 884         struct bt_notification_iterator_next_method_return next_ret = {
 885                 .status = BT_NOTIFICATION_ITERATOR_STATUS_OK,
 886                 .notification = NULL
 887         };
 888
 889         BT_ASSERT(dmesg_notif_iter);
 890         dmesg_comp = dmesg_notif_iter->dmesg_comp;
 891         BT_ASSERT(dmesg_comp);
 892
 893         if (dmesg_notif_iter->state == STATE_DONE) {
 894                 next_ret.status = BT_NOTIFICATION_ITERATOR_STATUS_END;
 895                 goto end;
 896         }
 897
 898         if (dmesg_notif_iter->tmp_event_notif ||
 899                         dmesg_notif_iter->state == STATE_EMIT_PACKET_END ||
 900                         dmesg_notif_iter->state == STATE_EMIT_STREAM_END) {
 901                 goto handle_state;
 902         }
 903
 904         while (true) {
 905                 const char *ch;
 906                 bool only_spaces = true;
 907
 908                 len = bt_getline(&dmesg_notif_iter->linebuf,
 909                         &dmesg_notif_iter->linebuf_len, dmesg_notif_iter->fp);
 910                 if (len < 0) {
 911                         if (errno == EINVAL) {
 912                                 next_ret.status =
 913                                         BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 914                         } else if (errno == ENOMEM) {
 915                                 next_ret.status =
 916                                         BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
 917                         } else {
 918                                 if (dmesg_notif_iter->state == STATE_EMIT_STREAM_BEGINNING) {
 919                                         /* Stream did not even begin */
 920                                         next_ret.status =
 921                                                 BT_NOTIFICATION_ITERATOR_STATUS_END;
 922                                         goto end;
 923                                 } else {
 924                                         /* End current packet now */
 925                                         dmesg_notif_iter->state =
 926                                                 STATE_EMIT_PACKET_END;
 927                                         goto handle_state;
 928                                 }
 929                         }
 930
 931                         goto end;
 932                 }
 933
 934                 BT_ASSERT(dmesg_notif_iter->linebuf);
 935
 936                 /* Ignore empty lines, once trimmed */
 937                 for (ch = dmesg_notif_iter->linebuf; *ch != '\0'; ch++) {
 938                         if (!isspace(*ch)) {
 939                                 only_spaces = false;
 940                                 break;
 941                         }
 942                 }
 943
 944                 if (!only_spaces) {
 945                         break;
 946                 }
 947         }
 948
 949         dmesg_notif_iter->tmp_event_notif = create_notif_from_line(dmesg_comp,
 950                 dmesg_notif_iter->linebuf);
 951         if (!dmesg_notif_iter->tmp_event_notif) {
 952                 BT_LOGE("Cannot create event notification from line: "
 953                         "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp,
 954                         dmesg_notif_iter->linebuf);
 955                 goto end;
 956         }
 957
 958 handle_state:
 959         BT_ASSERT(dmesg_comp->trace);
 960
 961         switch (dmesg_notif_iter->state) {
 962         case STATE_EMIT_STREAM_BEGINNING:
 963                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 964                 next_ret.notification = bt_notification_stream_begin_create(
 965                         dmesg_comp->graph, dmesg_comp->stream);
 966                 dmesg_notif_iter->state = STATE_EMIT_PACKET_BEGINNING;
 967                 break;
 968         case STATE_EMIT_PACKET_BEGINNING:
 969                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 970                 next_ret.notification = bt_notification_packet_begin_create(
 971                         dmesg_comp->graph, dmesg_comp->packet);
 972                 dmesg_notif_iter->state = STATE_EMIT_EVENT;
 973                 break;
 974         case STATE_EMIT_EVENT:
 975                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 976                 BT_MOVE(next_ret.notification,
 977                         dmesg_notif_iter->tmp_event_notif);
 978                 break;
 979         case STATE_EMIT_PACKET_END:
 980                 next_ret.notification = bt_notification_packet_end_create(
 981                         dmesg_comp->graph, dmesg_comp->packet);
 982                 dmesg_notif_iter->state = STATE_EMIT_STREAM_END;
 983                 break;
 984         case STATE_EMIT_STREAM_END:
 985                 next_ret.notification = bt_notification_stream_end_create(
 986                         dmesg_comp->graph, dmesg_comp->stream);
 987                 dmesg_notif_iter->state = STATE_DONE;
 988                 break;
 989         default:
 990                 break;
 991         }
 992
 993         if (!next_ret.notification) {
 994                 BT_LOGE("Cannot create notification: dmesg-comp-addr=%p",
 995                         dmesg_comp);
 996                 next_ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 997         }
 998
 999 end:
1000         return next_ret;
1001 }