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