2 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
3 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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
24 #define BT_LOG_TAG "PLUGIN-TEXT-DMESG-SRC"
31 #include <babeltrace/assert-internal.h>
32 #include <babeltrace/common-internal.h>
33 #include <babeltrace/babeltrace.h>
34 #include <babeltrace/value-internal.h>
35 #include <babeltrace/compat/utc-internal.h>
36 #include <babeltrace/compat/stdio-internal.h>
39 #define NSEC_PER_USEC 1000UL
40 #define NSEC_PER_MSEC 1000000UL
41 #define NSEC_PER_SEC 1000000000ULL
42 #define USEC_PER_SEC 1000000UL
44 struct dmesg_component
;
46 struct dmesg_msg_iter
{
47 struct dmesg_component
*dmesg_comp
;
48 bt_self_message_iterator
*pc_msg_iter
; /* Weak */
52 bt_message
*tmp_event_msg
;
55 STATE_EMIT_STREAM_BEGINNING
,
56 STATE_EMIT_PACKET_BEGINNING
,
58 STATE_EMIT_PACKET_END
,
59 STATE_EMIT_STREAM_END
,
64 struct dmesg_component
{
67 bt_bool read_from_stdin
;
71 bt_self_component_source
*self_comp
;
72 bt_trace_class
*trace_class
;
73 bt_stream_class
*stream_class
;
74 bt_event_class
*event_class
;
78 bt_clock_class
*clock_class
;
82 bt_field_class
*create_event_payload_fc(void)
84 bt_field_class
*root_fc
= NULL
;
85 bt_field_class
*fc
= NULL
;
88 root_fc
= bt_field_class_structure_create();
90 BT_LOGE_STR("Cannot create an empty structure field class object.");
94 fc
= bt_field_class_string_create();
96 BT_LOGE_STR("Cannot create a string field class object.");
100 ret
= bt_field_class_structure_append_member(root_fc
,
103 BT_LOGE("Cannot add `str` member to structure field class: "
111 BT_FIELD_CLASS_PUT_REF_AND_RESET(root_fc
);
114 bt_field_class_put_ref(fc
);
119 int create_meta(struct dmesg_component
*dmesg_comp
, bool has_ts
)
121 bt_field_class
*fc
= NULL
;
124 dmesg_comp
->trace_class
= bt_trace_class_create(
125 bt_self_component_source_as_self_component(
126 dmesg_comp
->self_comp
));
127 if (!dmesg_comp
->trace_class
) {
128 BT_LOGE_STR("Cannot create an empty trace class object.");
132 dmesg_comp
->stream_class
= bt_stream_class_create(
133 dmesg_comp
->trace_class
);
134 if (!dmesg_comp
->stream_class
) {
135 BT_LOGE_STR("Cannot create a stream class object.");
140 dmesg_comp
->clock_class
= bt_clock_class_create();
141 if (!dmesg_comp
->clock_class
) {
142 BT_LOGE_STR("Cannot create clock class.");
146 ret
= bt_stream_class_set_default_clock_class(
147 dmesg_comp
->stream_class
, dmesg_comp
->clock_class
);
149 BT_LOGE_STR("Cannot set stream class's default clock class.");
154 dmesg_comp
->event_class
= bt_event_class_create(
155 dmesg_comp
->stream_class
);
156 if (!dmesg_comp
->event_class
) {
157 BT_LOGE_STR("Cannot create an event class object.");
161 ret
= bt_event_class_set_name(dmesg_comp
->event_class
, "string");
163 BT_LOGE_STR("Cannot set event class's name.");
167 fc
= create_event_payload_fc();
169 BT_LOGE_STR("Cannot create event payload field class.");
173 ret
= bt_event_class_set_payload_field_class(dmesg_comp
->event_class
, fc
);
175 BT_LOGE_STR("Cannot set event class's event payload field class.");
185 bt_field_class_put_ref(fc
);
190 int handle_params(struct dmesg_component
*dmesg_comp
,
191 const bt_value
*params
)
193 const bt_value
*no_timestamp
= NULL
;
194 const bt_value
*path
= NULL
;
195 const char *path_str
;
198 no_timestamp
= bt_value_map_borrow_entry_value_const(params
,
199 "no-extract-timestamp");
201 if (!bt_value_is_bool(no_timestamp
)) {
202 BT_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: "
204 bt_common_value_type_string(
205 bt_value_get_type(no_timestamp
)));
209 dmesg_comp
->params
.no_timestamp
=
210 bt_value_bool_get(no_timestamp
);
213 path
= bt_value_map_borrow_entry_value_const(params
, "path");
215 if (dmesg_comp
->params
.read_from_stdin
) {
216 BT_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters.");
220 if (!bt_value_is_string(path
)) {
221 BT_LOGE("Expecting a string value for the `path` parameter: "
223 bt_common_value_type_string(
224 bt_value_get_type(path
)));
228 path_str
= bt_value_string_get(path
);
229 g_string_assign(dmesg_comp
->params
.path
, path_str
);
231 dmesg_comp
->params
.read_from_stdin
= true;
244 int create_packet_and_stream_and_trace(struct dmesg_component
*dmesg_comp
)
247 const char *trace_name
;
248 gchar
*basename
= NULL
;
250 dmesg_comp
->trace
= bt_trace_create(dmesg_comp
->trace_class
);
251 if (!dmesg_comp
->trace
) {
252 BT_LOGE_STR("Cannot create trace object.");
256 if (dmesg_comp
->params
.read_from_stdin
) {
257 trace_name
= "STDIN";
259 basename
= g_path_get_basename(dmesg_comp
->params
.path
->str
);
262 if (strcmp(basename
, G_DIR_SEPARATOR_S
) != 0 &&
263 strcmp(basename
, ".") != 0) {
264 trace_name
= basename
;
269 ret
= bt_trace_set_name(dmesg_comp
->trace
, trace_name
);
271 BT_LOGE("Cannot set trace's name: name=\"%s\"",
277 dmesg_comp
->stream
= bt_stream_create(dmesg_comp
->stream_class
,
279 if (!dmesg_comp
->stream
) {
280 BT_LOGE_STR("Cannot create stream object.");
284 dmesg_comp
->packet
= bt_packet_create(dmesg_comp
->stream
);
285 if (!dmesg_comp
->packet
) {
286 BT_LOGE_STR("Cannot create packet object.");
290 ret
= bt_trace_make_static(dmesg_comp
->trace
);
292 BT_LOGE_STR("Cannot make trace static.");
310 int try_create_meta_stream_packet(struct dmesg_component
*dmesg_comp
,
315 if (dmesg_comp
->trace
) {
316 /* Already created */
320 ret
= create_meta(dmesg_comp
, has_ts
);
322 BT_LOGE("Cannot create metadata objects: dmesg-comp-addr=%p",
327 ret
= create_packet_and_stream_and_trace(dmesg_comp
);
329 BT_LOGE("Cannot create packet and stream objects: "
330 "dmesg-comp-addr=%p", dmesg_comp
);
344 void destroy_dmesg_component(struct dmesg_component
*dmesg_comp
)
350 if (dmesg_comp
->params
.path
) {
351 g_string_free(dmesg_comp
->params
.path
, TRUE
);
354 bt_packet_put_ref(dmesg_comp
->packet
);
355 bt_trace_put_ref(dmesg_comp
->trace
);
356 bt_stream_class_put_ref(dmesg_comp
->stream_class
);
357 bt_event_class_put_ref(dmesg_comp
->event_class
);
358 bt_stream_put_ref(dmesg_comp
->stream
);
359 bt_clock_class_put_ref(dmesg_comp
->clock_class
);
364 bt_self_component_status
create_port(
365 bt_self_component_source
*self_comp
)
367 return bt_self_component_source_add_output_port(self_comp
,
372 bt_self_component_status
dmesg_init(
373 bt_self_component_source
*self_comp
,
374 bt_value
*params
, void *init_method_data
)
377 struct dmesg_component
*dmesg_comp
= g_new0(struct dmesg_component
, 1);
378 bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
381 BT_LOGE_STR("Failed to allocate one dmesg component structure.");
385 dmesg_comp
->self_comp
= self_comp
;
386 dmesg_comp
->params
.path
= g_string_new(NULL
);
387 if (!dmesg_comp
->params
.path
) {
388 BT_LOGE_STR("Failed to allocate a GString.");
392 ret
= handle_params(dmesg_comp
, params
);
394 BT_LOGE("Invalid parameters: comp-addr=%p", self_comp
);
398 if (!dmesg_comp
->params
.read_from_stdin
&&
399 !g_file_test(dmesg_comp
->params
.path
->str
,
400 G_FILE_TEST_IS_REGULAR
)) {
401 BT_LOGE("Input path is not a regular file: "
402 "comp-addr=%p, path=\"%s\"", self_comp
,
403 dmesg_comp
->params
.path
->str
);
407 status
= create_port(self_comp
);
408 if (status
!= BT_SELF_COMPONENT_STATUS_OK
) {
412 bt_self_component_set_data(
413 bt_self_component_source_as_self_component(self_comp
),
418 destroy_dmesg_component(dmesg_comp
);
419 bt_self_component_set_data(
420 bt_self_component_source_as_self_component(self_comp
),
424 status
= BT_SELF_COMPONENT_STATUS_ERROR
;
432 void dmesg_finalize(bt_self_component_source
*self_comp
)
434 destroy_dmesg_component(bt_self_component_get_data(
435 bt_self_component_source_as_self_component(self_comp
)));
439 bt_message
*create_init_event_msg_from_line(
440 struct dmesg_msg_iter
*msg_iter
,
441 const char *line
, const char **new_start
)
444 bt_message
*msg
= NULL
;
445 bool has_timestamp
= false;
446 unsigned long sec
, usec
, msec
;
447 unsigned int year
, mon
, mday
, hour
, min
;
450 struct dmesg_component
*dmesg_comp
= msg_iter
->dmesg_comp
;
454 if (dmesg_comp
->params
.no_timestamp
) {
458 /* Extract time from input line */
459 if (sscanf(line
, "[%lu.%lu] ", &sec
, &usec
) == 2) {
460 ts
= (uint64_t) sec
* USEC_PER_SEC
+ (uint64_t) usec
;
463 * The clock class we use has a 1 GHz frequency: convert
467 has_timestamp
= true;
468 } else if (sscanf(line
, "[%u-%u-%u %u:%u:%lu.%lu] ",
469 &year
, &mon
, &mday
, &hour
, &min
,
474 memset(&ti
, 0, sizeof(ti
));
475 ti
.tm_year
= year
- 1900; /* From 1900 */
476 ti
.tm_mon
= mon
- 1; /* 0 to 11 */
482 ep_sec
= bt_timegm(&ti
);
483 if (ep_sec
!= (time_t) -1) {
484 ts
= (uint64_t) ep_sec
* NSEC_PER_SEC
485 + (uint64_t) msec
* NSEC_PER_MSEC
;
488 has_timestamp
= true;
492 /* Set new start for the message portion of the line */
493 *new_start
= strchr(line
, ']');
494 BT_ASSERT(*new_start
);
497 if ((*new_start
)[0] == ' ') {
504 * At this point, we know if the stream class's event header
505 * field class should have a timestamp or not, so we can lazily
506 * create the metadata, stream, and packet objects.
508 ret
= try_create_meta_stream_packet(dmesg_comp
, has_timestamp
);
510 /* try_create_meta_stream_packet() logs errors */
514 msg
= bt_message_event_create(msg_iter
->pc_msg_iter
,
515 dmesg_comp
->event_class
, dmesg_comp
->packet
);
517 BT_LOGE_STR("Cannot create event message.");
521 event
= bt_message_event_borrow_event(msg
);
524 if (dmesg_comp
->clock_class
) {
525 bt_event_set_default_clock_snapshot(event
, ts
);
531 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
538 int fill_event_payload_from_line(const char *line
,
541 bt_field
*ep_field
= NULL
;
542 bt_field
*str_field
= NULL
;
546 ep_field
= bt_event_borrow_payload_field(event
);
548 str_field
= bt_field_structure_borrow_member_field_by_index(
551 BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field.");
556 if (line
[len
- 1] == '\n') {
557 /* Do not include the newline character in the payload */
561 ret
= bt_field_string_clear(str_field
);
563 BT_LOGE_STR("Cannot clear string field object.");
567 ret
= bt_field_string_append_with_length(str_field
, line
, len
);
569 BT_LOGE("Cannot append value to string field object: "
584 bt_message
*create_msg_from_line(
585 struct dmesg_msg_iter
*dmesg_msg_iter
, const char *line
)
587 bt_event
*event
= NULL
;
588 bt_message
*msg
= NULL
;
589 const char *new_start
;
592 msg
= create_init_event_msg_from_line(dmesg_msg_iter
,
595 BT_LOGE_STR("Cannot create and initialize event message from line.");
599 event
= bt_message_event_borrow_event(msg
);
601 ret
= fill_event_payload_from_line(new_start
, event
);
603 BT_LOGE("Cannot fill event payload field from line: "
611 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
618 void destroy_dmesg_msg_iter(struct dmesg_msg_iter
*dmesg_msg_iter
)
620 if (!dmesg_msg_iter
) {
624 if (dmesg_msg_iter
->fp
&& dmesg_msg_iter
->fp
!= stdin
) {
625 if (fclose(dmesg_msg_iter
->fp
)) {
626 BT_LOGE_ERRNO("Cannot close input file", ".");
630 bt_message_put_ref(dmesg_msg_iter
->tmp_event_msg
);
631 free(dmesg_msg_iter
->linebuf
);
632 g_free(dmesg_msg_iter
);
636 bt_self_message_iterator_status
dmesg_msg_iter_init(
637 bt_self_message_iterator
*self_msg_iter
,
638 bt_self_component_source
*self_comp
,
639 bt_self_component_port_output
*self_port
)
641 struct dmesg_component
*dmesg_comp
;
642 struct dmesg_msg_iter
*dmesg_msg_iter
=
643 g_new0(struct dmesg_msg_iter
, 1);
644 bt_self_message_iterator_status status
=
645 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
647 if (!dmesg_msg_iter
) {
648 BT_LOGE_STR("Failed to allocate on dmesg message iterator structure.");
652 dmesg_comp
= bt_self_component_get_data(
653 bt_self_component_source_as_self_component(self_comp
));
654 BT_ASSERT(dmesg_comp
);
655 dmesg_msg_iter
->dmesg_comp
= dmesg_comp
;
656 dmesg_msg_iter
->pc_msg_iter
= self_msg_iter
;
658 if (dmesg_comp
->params
.read_from_stdin
) {
659 dmesg_msg_iter
->fp
= stdin
;
661 dmesg_msg_iter
->fp
= fopen(dmesg_comp
->params
.path
->str
, "r");
662 if (!dmesg_msg_iter
->fp
) {
663 BT_LOGE_ERRNO("Cannot open input file in read mode", ": path=\"%s\"",
664 dmesg_comp
->params
.path
->str
);
669 bt_self_message_iterator_set_data(self_msg_iter
,
674 destroy_dmesg_msg_iter(dmesg_msg_iter
);
675 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
677 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
685 void dmesg_msg_iter_finalize(
686 bt_self_message_iterator
*priv_msg_iter
)
688 destroy_dmesg_msg_iter(bt_self_message_iterator_get_data(
693 bt_self_message_iterator_status
dmesg_msg_iter_next_one(
694 struct dmesg_msg_iter
*dmesg_msg_iter
,
698 struct dmesg_component
*dmesg_comp
;
699 bt_self_message_iterator_status status
=
700 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
702 BT_ASSERT(dmesg_msg_iter
);
703 dmesg_comp
= dmesg_msg_iter
->dmesg_comp
;
704 BT_ASSERT(dmesg_comp
);
706 if (dmesg_msg_iter
->state
== STATE_DONE
) {
707 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_END
;
711 if (dmesg_msg_iter
->tmp_event_msg
||
712 dmesg_msg_iter
->state
== STATE_EMIT_PACKET_END
||
713 dmesg_msg_iter
->state
== STATE_EMIT_STREAM_END
) {
719 bool only_spaces
= true;
721 len
= bt_getline(&dmesg_msg_iter
->linebuf
,
722 &dmesg_msg_iter
->linebuf_len
, dmesg_msg_iter
->fp
);
724 if (errno
== EINVAL
) {
725 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
726 } else if (errno
== ENOMEM
) {
728 BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM
;
730 if (dmesg_msg_iter
->state
== STATE_EMIT_STREAM_BEGINNING
) {
731 /* Stream did not even begin */
732 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_END
;
735 /* End current packet now */
736 dmesg_msg_iter
->state
=
737 STATE_EMIT_PACKET_END
;
745 BT_ASSERT(dmesg_msg_iter
->linebuf
);
747 /* Ignore empty lines, once trimmed */
748 for (ch
= dmesg_msg_iter
->linebuf
; *ch
!= '\0'; ch
++) {
760 dmesg_msg_iter
->tmp_event_msg
= create_msg_from_line(
761 dmesg_msg_iter
, dmesg_msg_iter
->linebuf
);
762 if (!dmesg_msg_iter
->tmp_event_msg
) {
763 BT_LOGE("Cannot create event message from line: "
764 "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp
,
765 dmesg_msg_iter
->linebuf
);
770 BT_ASSERT(dmesg_comp
->trace
);
772 switch (dmesg_msg_iter
->state
) {
773 case STATE_EMIT_STREAM_BEGINNING
:
774 BT_ASSERT(dmesg_msg_iter
->tmp_event_msg
);
775 *msg
= bt_message_stream_beginning_create(
776 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->stream
);
777 dmesg_msg_iter
->state
= STATE_EMIT_PACKET_BEGINNING
;
779 case STATE_EMIT_PACKET_BEGINNING
:
780 BT_ASSERT(dmesg_msg_iter
->tmp_event_msg
);
781 *msg
= bt_message_packet_beginning_create(
782 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->packet
);
783 dmesg_msg_iter
->state
= STATE_EMIT_EVENT
;
785 case STATE_EMIT_EVENT
:
786 BT_ASSERT(dmesg_msg_iter
->tmp_event_msg
);
787 *msg
= dmesg_msg_iter
->tmp_event_msg
;
788 dmesg_msg_iter
->tmp_event_msg
= NULL
;
790 case STATE_EMIT_PACKET_END
:
791 *msg
= bt_message_packet_end_create(
792 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->packet
);
793 dmesg_msg_iter
->state
= STATE_EMIT_STREAM_END
;
795 case STATE_EMIT_STREAM_END
:
796 *msg
= bt_message_stream_end_create(
797 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->stream
);
798 dmesg_msg_iter
->state
= STATE_DONE
;
805 BT_LOGE("Cannot create message: dmesg-comp-addr=%p",
807 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
815 bt_self_message_iterator_status
dmesg_msg_iter_next(
816 bt_self_message_iterator
*self_msg_iter
,
817 bt_message_array_const msgs
, uint64_t capacity
,
820 struct dmesg_msg_iter
*dmesg_msg_iter
=
821 bt_self_message_iterator_get_data(
823 bt_self_message_iterator_status status
=
824 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
827 while (i
< capacity
&&
828 status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
829 bt_message
*priv_msg
= NULL
;
831 status
= dmesg_msg_iter_next_one(dmesg_msg_iter
,
834 if (status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
841 * Even if dmesg_msg_iter_next_one() returned
842 * something else than
843 * BT_SELF_MESSAGE_ITERATOR_STATUS_OK, we
844 * accumulated message objects in the output
845 * message array, so we need to return
846 * BT_SELF_MESSAGE_ITERATOR_STATUS_OK so that they
847 * are transfered to downstream. This other status
848 * occurs again the next time muxer_msg_iter_do_next()
849 * is called, possibly without any accumulated
850 * message, in which case we'll return it.
853 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;