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         if (has_ts) {
 263                 dmesg_comp->clock_class = create_clock_class();
 264                 if (!dmesg_comp->clock_class) {
 265                         BT_LOGE_STR("Cannot create clock class.");
 266                         goto error;
 267                 }
 268
 269                 ret = bt_trace_add_clock_class(dmesg_comp->trace,
 270                         dmesg_comp->clock_class);
 271                 if (ret) {
 272                         BT_LOGE_STR("Cannot add clock class to trace.");
 273                         goto error;
 274                 }
 275
 276                 bt_put(ft);
 277                 ft = create_event_header_ft(dmesg_comp->clock_class);
 278                 if (!ft) {
 279                         BT_LOGE_STR("Cannot create event header field type.");
 280                         goto error;
 281                 }
 282
 283                 ret = bt_stream_class_set_event_header_field_type(
 284                         dmesg_comp->stream_class, ft);
 285                 if (ret) {
 286                         BT_LOGE_STR("Cannot set stream class's event header field type.");
 287                         goto error;
 288                 }
 289         }
 290
 291         dmesg_comp->event_class = bt_event_class_create("string");
 292         if (!dmesg_comp->event_class) {
 293                 BT_LOGE_STR("Cannot create an empty event class object.");
 294                 goto error;
 295         }
 296
 297         bt_put(ft);
 298         ft = create_event_payload_ft();
 299         if (!ft) {
 300                 BT_LOGE_STR("Cannot create event payload field type.");
 301                 goto error;
 302         }
 303
 304         ret = bt_event_class_set_payload_field_type(dmesg_comp->event_class, ft);
 305         if (ret) {
 306                 BT_LOGE_STR("Cannot set event class's event payload field type.");
 307                 goto error;
 308         }
 309
 310         ret = bt_stream_class_add_event_class(dmesg_comp->stream_class,
 311                 dmesg_comp->event_class);
 312         if (ret) {
 313                 BT_LOGE("Cannot add event class to stream class: ret=%d", ret);
 314                 goto error;
 315         }
 316
 317         ret = bt_trace_add_stream_class(dmesg_comp->trace,
 318                 dmesg_comp->stream_class);
 319         if (ret) {
 320                 BT_LOGE("Cannot add event class to stream class: ret=%d", ret);
 321                 goto error;
 322         }
 323
 324         goto end;
 325
 326 error:
 327         ret = -1;
 328
 329 end:
 330         bt_put(ft);
 331
 332         if (basename) {
 333                 g_free(basename);
 334         }
 335
 336         return ret;
 337 }
 338
 339 static
 340 int handle_params(struct dmesg_component *dmesg_comp, struct bt_value *params)
 341 {
 342         struct bt_value *read_from_stdin = NULL;
 343         struct bt_value *no_timestamp = NULL;
 344         struct bt_value *path = NULL;
 345         const char *path_str;
 346         int ret = 0;
 347
 348         no_timestamp = bt_value_map_get(params, "no-extract-timestamp");
 349         if (no_timestamp) {
 350                 if (!bt_value_is_bool(no_timestamp)) {
 351                         BT_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: "
 352                                 "type=%s",
 353                                 bt_value_type_string(
 354                                         bt_value_get_type(no_timestamp)));
 355                         goto error;
 356                 }
 357
 358                 ret = bt_value_bool_get(no_timestamp,
 359                         &dmesg_comp->params.no_timestamp);
 360                 BT_ASSERT(ret == 0);
 361         }
 362
 363         path = bt_value_map_get(params, "path");
 364         if (path) {
 365                 if (dmesg_comp->params.read_from_stdin) {
 366                         BT_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters.");
 367                         goto error;
 368                 }
 369
 370                 if (!bt_value_is_string(path)) {
 371                         BT_LOGE("Expecting a string value for the `path` parameter: "
 372                                 "type=%s",
 373                                 bt_value_type_string(
 374                                         bt_value_get_type(path)));
 375                         goto error;
 376                 }
 377
 378                 ret = bt_value_string_get(path, &path_str);
 379                 BT_ASSERT(ret == 0);
 380                 g_string_assign(dmesg_comp->params.path, path_str);
 381         } else {
 382                 dmesg_comp->params.read_from_stdin = true;
 383         }
 384
 385         goto end;
 386
 387 error:
 388         ret = -1;
 389
 390 end:
 391         bt_put(read_from_stdin);
 392         bt_put(path);
 393         bt_put(no_timestamp);
 394         return ret;
 395 }
 396
 397 static
 398 int fill_packet_header_field(struct bt_packet *packet)
 399 {
 400         struct bt_field *ph = NULL;
 401         struct bt_field *magic = NULL;
 402         int ret;
 403
 404         ph = bt_packet_borrow_header(packet);
 405         BT_ASSERT(ph);
 406         magic = bt_field_structure_borrow_field_by_name(ph, "magic");
 407         if (!magic) {
 408                 BT_LOGE_STR("Cannot borrow `magic` field from structure field.");
 409                 goto error;
 410         }
 411
 412         ret = bt_field_integer_unsigned_set_value(magic, 0xc1fc1fc1);
 413         BT_ASSERT(ret == 0);
 414         goto end;
 415
 416 error:
 417         ret = -1;
 418
 419 end:
 420         return ret;
 421 }
 422
 423 static
 424 int create_packet_and_stream(struct dmesg_component *dmesg_comp)
 425 {
 426         int ret = 0;
 427
 428         dmesg_comp->stream = bt_stream_create(dmesg_comp->stream_class,
 429                 NULL, 0);
 430         if (!dmesg_comp->stream) {
 431                 BT_LOGE_STR("Cannot create stream object.");
 432                 goto error;
 433         }
 434
 435         dmesg_comp->packet = bt_packet_create(dmesg_comp->stream);
 436         if (!dmesg_comp->packet) {
 437                 BT_LOGE_STR("Cannot create packet object.");
 438                 goto error;
 439         }
 440
 441         ret = fill_packet_header_field(dmesg_comp->packet);
 442         if (ret) {
 443                 BT_LOGE_STR("Cannot fill packet header field.");
 444                 goto error;
 445         }
 446
 447         ret = bt_trace_set_is_static(dmesg_comp->trace);
 448         if (ret) {
 449                 BT_LOGE_STR("Cannot make trace static.");
 450                 goto error;
 451         }
 452
 453         goto end;
 454
 455 error:
 456         ret = -1;
 457
 458 end:
 459         return ret;
 460 }
 461
 462 static
 463 int try_create_meta_stream_packet(struct dmesg_component *dmesg_comp,
 464                 bool has_ts)
 465 {
 466         int ret = 0;
 467
 468         if (dmesg_comp->trace) {
 469                 /* Already created */
 470                 goto end;
 471         }
 472
 473         ret = create_meta(dmesg_comp, has_ts);
 474         if (ret) {
 475                 BT_LOGE("Cannot create metadata objects: dmesg-comp-addr=%p",
 476                         dmesg_comp);
 477                 goto error;
 478         }
 479
 480         ret = create_packet_and_stream(dmesg_comp);
 481         if (ret) {
 482                 BT_LOGE("Cannot create packet and stream objects: "
 483                         "dmesg-comp-addr=%p", dmesg_comp);
 484                 goto error;
 485         }
 486
 487         goto end;
 488
 489 error:
 490         ret = -1;
 491
 492 end:
 493         return ret;
 494 }
 495
 496 static
 497 void destroy_dmesg_component(struct dmesg_component *dmesg_comp)
 498 {
 499         if (!dmesg_comp) {
 500                 return;
 501         }
 502
 503         if (dmesg_comp->params.path) {
 504                 g_string_free(dmesg_comp->params.path, TRUE);
 505         }
 506
 507         bt_put(dmesg_comp->packet);
 508         bt_put(dmesg_comp->trace);
 509         bt_put(dmesg_comp->stream_class);
 510         bt_put(dmesg_comp->event_class);
 511         bt_put(dmesg_comp->stream);
 512         bt_put(dmesg_comp->clock_class);
 513         bt_put(dmesg_comp->cc_prio_map);
 514         g_free(dmesg_comp);
 515 }
 516
 517 static
 518 enum bt_component_status create_port(struct bt_private_component *priv_comp)
 519 {
 520         return bt_private_component_source_add_output_private_port(priv_comp,
 521                 "out", NULL, NULL);
 522 }
 523
 524 BT_HIDDEN
 525 enum bt_component_status dmesg_init(struct bt_private_component *priv_comp,
 526                 struct bt_value *params, void *init_method_data)
 527 {
 528         int ret = 0;
 529         struct dmesg_component *dmesg_comp = g_new0(struct dmesg_component, 1);
 530         enum bt_component_status status = BT_COMPONENT_STATUS_OK;
 531
 532         if (!dmesg_comp) {
 533                 BT_LOGE_STR("Failed to allocate one dmesg component structure.");
 534                 goto error;
 535         }
 536
 537         dmesg_comp->graph = bt_component_borrow_graph(
 538                 bt_component_borrow_from_private(priv_comp));
 539         BT_ASSERT(dmesg_comp->graph);
 540         dmesg_comp->params.path = g_string_new(NULL);
 541         if (!dmesg_comp->params.path) {
 542                 BT_LOGE_STR("Failed to allocate a GString.");
 543                 goto error;
 544         }
 545
 546         ret = handle_params(dmesg_comp, params);
 547         if (ret) {
 548                 BT_LOGE("Invalid parameters: comp-addr=%p", priv_comp);
 549                 goto error;
 550         }
 551
 552         if (!dmesg_comp->params.read_from_stdin &&
 553                         !g_file_test(dmesg_comp->params.path->str,
 554                         G_FILE_TEST_IS_REGULAR)) {
 555                 BT_LOGE("Input path is not a regular file: "
 556                         "comp-addr=%p, path=\"%s\"", priv_comp,
 557                         dmesg_comp->params.path->str);
 558                 goto error;
 559         }
 560
 561         status = create_port(priv_comp);
 562         if (status != BT_COMPONENT_STATUS_OK) {
 563                 goto error;
 564         }
 565
 566         (void) bt_private_component_set_user_data(priv_comp, dmesg_comp);
 567         goto end;
 568
 569 error:
 570         destroy_dmesg_component(dmesg_comp);
 571         (void) bt_private_component_set_user_data(priv_comp, NULL);
 572
 573         if (status >= 0) {
 574                 status = BT_COMPONENT_STATUS_ERROR;
 575         }
 576
 577 end:
 578         return status;
 579 }
 580
 581 BT_HIDDEN
 582 void dmesg_finalize(struct bt_private_component *priv_comp)
 583 {
 584         void *data = bt_private_component_get_user_data(priv_comp);
 585
 586         destroy_dmesg_component(data);
 587 }
 588
 589 static
 590 struct bt_notification *create_init_event_notif_from_line(
 591                 struct dmesg_component *dmesg_comp,
 592                 const char *line, const char **new_start)
 593 {
 594         struct bt_event *event;
 595         struct bt_notification *notif = NULL;
 596         bool has_timestamp = false;
 597         unsigned long sec, usec, msec;
 598         unsigned int year, mon, mday, hour, min;
 599         uint64_t ts = 0;
 600         struct bt_field *eh_field = NULL;
 601         struct bt_field *ts_field = NULL;
 602         int ret = 0;
 603
 604         *new_start = line;
 605
 606         if (dmesg_comp->params.no_timestamp) {
 607                 goto skip_ts;
 608         }
 609
 610         /* Extract time from input line */
 611         if (sscanf(line, "[%lu.%lu] ", &sec, &usec) == 2) {
 612                 ts = (uint64_t) sec * USEC_PER_SEC + (uint64_t) usec;
 613
 614                 /*
 615                  * The clock class we use has a 1 GHz frequency: convert
 616                  * from µs to ns.
 617                  */
 618                 ts *= NSEC_PER_USEC;
 619                 has_timestamp = true;
 620         } else if (sscanf(line, "[%u-%u-%u %u:%u:%lu.%lu] ",
 621                         &year, &mon, &mday, &hour, &min,
 622                         &sec, &msec) == 7) {
 623                 time_t ep_sec;
 624                 struct tm ti;
 625
 626                 memset(&ti, 0, sizeof(ti));
 627                 ti.tm_year = year - 1900;       /* From 1900 */
 628                 ti.tm_mon = mon - 1;            /* 0 to 11 */
 629                 ti.tm_mday = mday;
 630                 ti.tm_hour = hour;
 631                 ti.tm_min = min;
 632                 ti.tm_sec = sec;
 633
 634                 ep_sec = bt_timegm(&ti);
 635                 if (ep_sec != (time_t) -1) {
 636                         ts = (uint64_t) ep_sec * NSEC_PER_SEC
 637                                 + (uint64_t) msec * NSEC_PER_MSEC;
 638                 }
 639
 640                 has_timestamp = true;
 641         }
 642
 643         if (has_timestamp) {
 644                 /* Set new start for the message portion of the line */
 645                 *new_start = strchr(line, ']');
 646                 BT_ASSERT(*new_start);
 647                 (*new_start)++;
 648
 649                 if ((*new_start)[0] == ' ') {
 650                         (*new_start)++;
 651                 }
 652         }
 653
 654 skip_ts:
 655         /*
 656          * At this point, we know if the stream class's event header
 657          * field type should have a timestamp or not, so we can lazily
 658          * create the metadata, stream, and packet objects.
 659          */
 660         ret = try_create_meta_stream_packet(dmesg_comp, has_timestamp);
 661         if (ret) {
 662                 /* try_create_meta_stream_packet() logs errors */
 663                 goto error;
 664         }
 665
 666         notif = bt_notification_event_create(dmesg_comp->graph,
 667                 dmesg_comp->event_class, dmesg_comp->packet);
 668         if (!notif) {
 669                 BT_LOGE_STR("Cannot create event notification.");
 670                 goto error;
 671         }
 672
 673         event = bt_notification_event_borrow_event(notif);
 674         BT_ASSERT(event);
 675
 676         if (dmesg_comp->clock_class) {
 677                 ret = bt_event_set_clock_value(event,
 678                         dmesg_comp->clock_class, ts, BT_TRUE);
 679                 BT_ASSERT(ret == 0);
 680                 eh_field = bt_event_borrow_header(event);
 681                 BT_ASSERT(eh_field);
 682                 ts_field = bt_field_structure_borrow_field_by_name(eh_field,
 683                         "timestamp");
 684                 if (!ts_field) {
 685                         BT_LOGE_STR("Cannot borrow `timestamp` field from event header structure field.");
 686                         goto error;
 687                 }
 688
 689                 ret = bt_field_integer_unsigned_set_value(ts_field, ts);
 690                 BT_ASSERT(ret == 0);
 691         }
 692
 693         goto end;
 694
 695 error:
 696         BT_PUT(notif);
 697
 698 end:
 699         return notif;
 700 }
 701
 702 static
 703 int fill_event_payload_from_line(struct dmesg_component *dmesg_comp,
 704                 const char *line, struct bt_event *event)
 705 {
 706         struct bt_field *ep_field = NULL;
 707         struct bt_field *str_field = NULL;
 708         size_t len;
 709         int ret;
 710
 711         ep_field = bt_event_borrow_payload(event);
 712         BT_ASSERT(ep_field);
 713         str_field = bt_field_structure_borrow_field_by_name(ep_field, "str");
 714         if (!str_field) {
 715                 BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field.");
 716                 goto error;
 717         }
 718
 719         len = strlen(line);
 720         if (line[len - 1] == '\n') {
 721                 /* Do not include the newline character in the payload */
 722                 len--;
 723         }
 724
 725         ret = bt_field_string_clear(str_field);
 726         if (ret) {
 727                 BT_LOGE_STR("Cannot clear string field object.");
 728                 goto error;
 729         }
 730
 731         ret = bt_field_string_append_len(str_field, line, len);
 732         if (ret) {
 733                 BT_LOGE("Cannot append value to string field object: "
 734                         "len=%zu", len);
 735                 goto error;
 736         }
 737
 738         goto end;
 739
 740 error:
 741         ret = -1;
 742
 743 end:
 744         return ret;
 745 }
 746
 747 static
 748 struct bt_notification *create_notif_from_line(
 749                 struct dmesg_component *dmesg_comp, const char *line)
 750 {
 751         struct bt_event *event = NULL;
 752         struct bt_notification *notif = NULL;
 753         const char *new_start;
 754         int ret;
 755
 756         notif = create_init_event_notif_from_line(dmesg_comp, line, &new_start);
 757         if (!notif) {
 758                 BT_LOGE_STR("Cannot create and initialize event notification from line.");
 759                 goto error;
 760         }
 761
 762         event = bt_notification_event_borrow_event(notif);
 763         BT_ASSERT(event);
 764         ret = fill_event_payload_from_line(dmesg_comp, new_start,
 765                 event);
 766         if (ret) {
 767                 BT_LOGE("Cannot fill event payload field from line: "
 768                         "ret=%d", ret);
 769                 goto error;
 770         }
 771
 772         goto end;
 773
 774 error:
 775         BT_PUT(notif);
 776
 777 end:
 778         return notif;
 779 }
 780
 781 static
 782 void destroy_dmesg_notif_iter(struct dmesg_notif_iter *dmesg_notif_iter)
 783 {
 784         if (!dmesg_notif_iter) {
 785                 return;
 786         }
 787
 788         if (dmesg_notif_iter->fp && dmesg_notif_iter->fp != stdin) {
 789                 if (fclose(dmesg_notif_iter->fp)) {
 790                         BT_LOGE_ERRNO("Cannot close input file", ".");
 791                 }
 792         }
 793
 794         bt_put(dmesg_notif_iter->tmp_event_notif);
 795         free(dmesg_notif_iter->linebuf);
 796         g_free(dmesg_notif_iter);
 797 }
 798
 799 BT_HIDDEN
 800 enum bt_notification_iterator_status dmesg_notif_iter_init(
 801                 struct bt_private_connection_private_notification_iterator *priv_notif_iter,
 802                 struct bt_private_port *priv_port)
 803 {
 804         struct bt_private_component *priv_comp = NULL;
 805         struct dmesg_component *dmesg_comp;
 806         struct dmesg_notif_iter *dmesg_notif_iter =
 807                 g_new0(struct dmesg_notif_iter, 1);
 808         enum bt_notification_iterator_status status =
 809                 BT_NOTIFICATION_ITERATOR_STATUS_OK;
 810
 811         if (!dmesg_notif_iter) {
 812                 BT_LOGE_STR("Failed to allocate on dmesg notification iterator structure.");
 813                 goto error;
 814         }
 815
 816         priv_comp = bt_private_connection_private_notification_iterator_get_private_component(
 817                 priv_notif_iter);
 818         BT_ASSERT(priv_comp);
 819         dmesg_comp = bt_private_component_get_user_data(priv_comp);
 820         BT_ASSERT(dmesg_comp);
 821         dmesg_notif_iter->dmesg_comp = dmesg_comp;
 822
 823         if (dmesg_comp->params.read_from_stdin) {
 824                 dmesg_notif_iter->fp = stdin;
 825         } else {
 826                 dmesg_notif_iter->fp = fopen(dmesg_comp->params.path->str, "r");
 827                 if (!dmesg_notif_iter->fp) {
 828                         BT_LOGE_ERRNO("Cannot open input file in read mode", ": path=\"%s\"",
 829                                 dmesg_comp->params.path->str);
 830                         goto error;
 831                 }
 832         }
 833
 834         (void) bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter,
 835                 dmesg_notif_iter);
 836         goto end;
 837
 838 error:
 839         destroy_dmesg_notif_iter(dmesg_notif_iter);
 840         (void) bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter,
 841                 NULL);
 842         if (status >= 0) {
 843                 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 844         }
 845
 846 end:
 847         bt_put(priv_comp);
 848         return status;
 849 }
 850
 851 BT_HIDDEN
 852 void dmesg_notif_iter_finalize(
 853                 struct bt_private_connection_private_notification_iterator *priv_notif_iter)
 854 {
 855         destroy_dmesg_notif_iter(bt_private_connection_private_notification_iterator_get_user_data(
 856                 priv_notif_iter));
 857 }
 858
 859 static
 860 enum bt_notification_iterator_status dmesg_notif_iter_next_one(
 861                 struct dmesg_notif_iter *dmesg_notif_iter,
 862                 struct bt_notification **notif)
 863 {
 864         ssize_t len;
 865         struct dmesg_component *dmesg_comp;
 866         enum bt_notification_iterator_status status =
 867                 BT_NOTIFICATION_ITERATOR_STATUS_OK;
 868
 869         BT_ASSERT(dmesg_notif_iter);
 870         dmesg_comp = dmesg_notif_iter->dmesg_comp;
 871         BT_ASSERT(dmesg_comp);
 872
 873         if (dmesg_notif_iter->state == STATE_DONE) {
 874                 status = BT_NOTIFICATION_ITERATOR_STATUS_END;
 875                 goto end;
 876         }
 877
 878         if (dmesg_notif_iter->tmp_event_notif ||
 879                         dmesg_notif_iter->state == STATE_EMIT_PACKET_END ||
 880                         dmesg_notif_iter->state == STATE_EMIT_STREAM_END) {
 881                 goto handle_state;
 882         }
 883
 884         while (true) {
 885                 const char *ch;
 886                 bool only_spaces = true;
 887
 888                 len = bt_getline(&dmesg_notif_iter->linebuf,
 889                         &dmesg_notif_iter->linebuf_len, dmesg_notif_iter->fp);
 890                 if (len < 0) {
 891                         if (errno == EINVAL) {
 892                                 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 893                         } else if (errno == ENOMEM) {
 894                                 status =
 895                                         BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
 896                         } else {
 897                                 if (dmesg_notif_iter->state == STATE_EMIT_STREAM_BEGINNING) {
 898                                         /* Stream did not even begin */
 899                                         status = BT_NOTIFICATION_ITERATOR_STATUS_END;
 900                                         goto end;
 901                                 } else {
 902                                         /* End current packet now */
 903                                         dmesg_notif_iter->state =
 904                                                 STATE_EMIT_PACKET_END;
 905                                         goto handle_state;
 906                                 }
 907                         }
 908
 909                         goto end;
 910                 }
 911
 912                 BT_ASSERT(dmesg_notif_iter->linebuf);
 913
 914                 /* Ignore empty lines, once trimmed */
 915                 for (ch = dmesg_notif_iter->linebuf; *ch != '\0'; ch++) {
 916                         if (!isspace(*ch)) {
 917                                 only_spaces = false;
 918                                 break;
 919                         }
 920                 }
 921
 922                 if (!only_spaces) {
 923                         break;
 924                 }
 925         }
 926
 927         dmesg_notif_iter->tmp_event_notif = create_notif_from_line(dmesg_comp,
 928                 dmesg_notif_iter->linebuf);
 929         if (!dmesg_notif_iter->tmp_event_notif) {
 930                 BT_LOGE("Cannot create event notification from line: "
 931                         "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp,
 932                         dmesg_notif_iter->linebuf);
 933                 goto end;
 934         }
 935
 936 handle_state:
 937         BT_ASSERT(dmesg_comp->trace);
 938
 939         switch (dmesg_notif_iter->state) {
 940         case STATE_EMIT_STREAM_BEGINNING:
 941                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 942                 *notif = bt_notification_stream_begin_create(
 943                         dmesg_comp->graph, dmesg_comp->stream);
 944                 dmesg_notif_iter->state = STATE_EMIT_PACKET_BEGINNING;
 945                 break;
 946         case STATE_EMIT_PACKET_BEGINNING:
 947                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 948                 *notif = bt_notification_packet_begin_create(
 949                         dmesg_comp->graph, dmesg_comp->packet);
 950                 dmesg_notif_iter->state = STATE_EMIT_EVENT;
 951                 break;
 952         case STATE_EMIT_EVENT:
 953                 BT_ASSERT(dmesg_notif_iter->tmp_event_notif);
 954                 *notif = dmesg_notif_iter->tmp_event_notif;
 955                 dmesg_notif_iter->tmp_event_notif = NULL;
 956                 break;
 957         case STATE_EMIT_PACKET_END:
 958                 *notif = bt_notification_packet_end_create(
 959                         dmesg_comp->graph, dmesg_comp->packet);
 960                 dmesg_notif_iter->state = STATE_EMIT_STREAM_END;
 961                 break;
 962         case STATE_EMIT_STREAM_END:
 963                 *notif = bt_notification_stream_end_create(
 964                         dmesg_comp->graph, dmesg_comp->stream);
 965                 dmesg_notif_iter->state = STATE_DONE;
 966                 break;
 967         default:
 968                 break;
 969         }
 970
 971         if (!*notif) {
 972                 BT_LOGE("Cannot create notification: dmesg-comp-addr=%p",
 973                         dmesg_comp);
 974                 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 975         }
 976
 977 end:
 978         return status;
 979 }
 980
 981 BT_HIDDEN
 982 enum bt_notification_iterator_status dmesg_notif_iter_next(
 983                 struct bt_private_connection_private_notification_iterator *priv_notif_iter,
 984                 bt_notification_array notifs, uint64_t capacity,
 985                 uint64_t *count)
 986 {
 987         struct dmesg_notif_iter *dmesg_notif_iter =
 988                 bt_private_connection_private_notification_iterator_get_user_data(
 989                         priv_notif_iter);
 990         enum bt_notification_iterator_status status =
 991                 BT_NOTIFICATION_ITERATOR_STATUS_OK;
 992         uint64_t i = 0;
 993
 994         while (i < capacity && status == BT_NOTIFICATION_ITERATOR_STATUS_OK) {
 995                 status = dmesg_notif_iter_next_one(dmesg_notif_iter, &notifs[i]);
 996                 if (status == BT_NOTIFICATION_ITERATOR_STATUS_OK) {
 997                         i++;
 998                 }
 999         }
1000
1001         if (i > 0) {
1002                 /*
1003                  * Even if dmesg_notif_iter_next_one() returned
1004                  * something else than
1005                  * BT_NOTIFICATION_ITERATOR_STATUS_OK, we accumulated
1006                  * notification objects in the output notification
1007                  * array, so we need to return
1008                  * BT_NOTIFICATION_ITERATOR_STATUS_OK so that they are
1009                  * transfered to downstream. This other status occurs
1010                  * again the next time muxer_notif_iter_do_next() is
1011                  * called, possibly without any accumulated
1012                  * notification, in which case we'll return it.
1013                  */
1014                 *count = i;
1015                 status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
1016         }
1017
1018         return status;
1019 }