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