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
;
53 uint64_t last_clock_value
;
56 STATE_EMIT_STREAM_BEGINNING
,
57 STATE_EMIT_STREAM_ACTIVITY_BEGINNING
,
58 STATE_EMIT_PACKET_BEGINNING
,
60 STATE_EMIT_PACKET_END
,
61 STATE_EMIT_STREAM_ACTIVITY_END
,
62 STATE_EMIT_STREAM_END
,
67 struct dmesg_component
{
70 bt_bool read_from_stdin
;
74 bt_self_component_source
*self_comp
;
75 bt_trace_class
*trace_class
;
76 bt_stream_class
*stream_class
;
77 bt_event_class
*event_class
;
81 bt_clock_class
*clock_class
;
85 bt_field_class
*create_event_payload_fc(bt_trace_class
*trace_class
)
87 bt_field_class
*root_fc
= NULL
;
88 bt_field_class
*fc
= NULL
;
91 root_fc
= bt_field_class_structure_create(trace_class
);
93 BT_LOGE_STR("Cannot create an empty structure field class object.");
97 fc
= bt_field_class_string_create(trace_class
);
99 BT_LOGE_STR("Cannot create a string field class object.");
103 ret
= bt_field_class_structure_append_member(root_fc
,
106 BT_LOGE("Cannot add `str` member to structure field class: "
114 BT_FIELD_CLASS_PUT_REF_AND_RESET(root_fc
);
117 bt_field_class_put_ref(fc
);
122 int create_meta(struct dmesg_component
*dmesg_comp
, bool has_ts
)
124 bt_field_class
*fc
= NULL
;
127 dmesg_comp
->trace_class
= bt_trace_class_create(
128 bt_self_component_source_as_self_component(
129 dmesg_comp
->self_comp
));
130 if (!dmesg_comp
->trace_class
) {
131 BT_LOGE_STR("Cannot create an empty trace class object.");
135 dmesg_comp
->stream_class
= bt_stream_class_create(
136 dmesg_comp
->trace_class
);
137 if (!dmesg_comp
->stream_class
) {
138 BT_LOGE_STR("Cannot create a stream class object.");
143 dmesg_comp
->clock_class
= bt_clock_class_create(
144 dmesg_comp
->trace_class
);
145 if (!dmesg_comp
->clock_class
) {
146 BT_LOGE_STR("Cannot create clock class.");
150 ret
= bt_stream_class_set_default_clock_class(
151 dmesg_comp
->stream_class
, dmesg_comp
->clock_class
);
153 BT_LOGE_STR("Cannot set stream class's default clock class.");
158 dmesg_comp
->event_class
= bt_event_class_create(
159 dmesg_comp
->stream_class
);
160 if (!dmesg_comp
->event_class
) {
161 BT_LOGE_STR("Cannot create an event class object.");
165 ret
= bt_event_class_set_name(dmesg_comp
->event_class
, "string");
167 BT_LOGE_STR("Cannot set event class's name.");
171 fc
= create_event_payload_fc(dmesg_comp
->trace_class
);
173 BT_LOGE_STR("Cannot create event payload field class.");
177 ret
= bt_event_class_set_payload_field_class(dmesg_comp
->event_class
, fc
);
179 BT_LOGE_STR("Cannot set event class's event payload field class.");
189 bt_field_class_put_ref(fc
);
194 int handle_params(struct dmesg_component
*dmesg_comp
,
195 const bt_value
*params
)
197 const bt_value
*no_timestamp
= NULL
;
198 const bt_value
*path
= NULL
;
199 const char *path_str
;
202 no_timestamp
= bt_value_map_borrow_entry_value_const(params
,
203 "no-extract-timestamp");
205 if (!bt_value_is_bool(no_timestamp
)) {
206 BT_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: "
208 bt_common_value_type_string(
209 bt_value_get_type(no_timestamp
)));
213 dmesg_comp
->params
.no_timestamp
=
214 bt_value_bool_get(no_timestamp
);
217 path
= bt_value_map_borrow_entry_value_const(params
, "path");
219 if (dmesg_comp
->params
.read_from_stdin
) {
220 BT_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters.");
224 if (!bt_value_is_string(path
)) {
225 BT_LOGE("Expecting a string value for the `path` parameter: "
227 bt_common_value_type_string(
228 bt_value_get_type(path
)));
232 path_str
= bt_value_string_get(path
);
233 g_string_assign(dmesg_comp
->params
.path
, path_str
);
235 dmesg_comp
->params
.read_from_stdin
= true;
248 int create_packet_and_stream_and_trace(struct dmesg_component
*dmesg_comp
)
251 const char *trace_name
= NULL
;
252 gchar
*basename
= NULL
;
254 dmesg_comp
->trace
= bt_trace_create(dmesg_comp
->trace_class
);
255 if (!dmesg_comp
->trace
) {
256 BT_LOGE_STR("Cannot create trace object.");
260 if (dmesg_comp
->params
.read_from_stdin
) {
261 trace_name
= "STDIN";
263 basename
= g_path_get_basename(dmesg_comp
->params
.path
->str
);
266 if (strcmp(basename
, G_DIR_SEPARATOR_S
) != 0 &&
267 strcmp(basename
, ".") != 0) {
268 trace_name
= basename
;
273 ret
= bt_trace_set_name(dmesg_comp
->trace
, trace_name
);
275 BT_LOGE("Cannot set trace's name: name=\"%s\"",
281 dmesg_comp
->stream
= bt_stream_create(dmesg_comp
->stream_class
,
283 if (!dmesg_comp
->stream
) {
284 BT_LOGE_STR("Cannot create stream object.");
288 dmesg_comp
->packet
= bt_packet_create(dmesg_comp
->stream
);
289 if (!dmesg_comp
->packet
) {
290 BT_LOGE_STR("Cannot create packet object.");
294 ret
= bt_trace_make_static(dmesg_comp
->trace
);
296 BT_LOGE_STR("Cannot make trace static.");
314 int try_create_meta_stream_packet(struct dmesg_component
*dmesg_comp
,
319 if (dmesg_comp
->trace
) {
320 /* Already created */
324 ret
= create_meta(dmesg_comp
, has_ts
);
326 BT_LOGE("Cannot create metadata objects: dmesg-comp-addr=%p",
331 ret
= create_packet_and_stream_and_trace(dmesg_comp
);
333 BT_LOGE("Cannot create packet and stream objects: "
334 "dmesg-comp-addr=%p", dmesg_comp
);
348 void destroy_dmesg_component(struct dmesg_component
*dmesg_comp
)
354 if (dmesg_comp
->params
.path
) {
355 g_string_free(dmesg_comp
->params
.path
, TRUE
);
358 bt_packet_put_ref(dmesg_comp
->packet
);
359 bt_trace_put_ref(dmesg_comp
->trace
);
360 bt_stream_class_put_ref(dmesg_comp
->stream_class
);
361 bt_event_class_put_ref(dmesg_comp
->event_class
);
362 bt_stream_put_ref(dmesg_comp
->stream
);
363 bt_clock_class_put_ref(dmesg_comp
->clock_class
);
364 bt_trace_class_put_ref(dmesg_comp
->trace_class
);
369 bt_self_component_status
create_port(
370 bt_self_component_source
*self_comp
)
372 return bt_self_component_source_add_output_port(self_comp
,
377 bt_self_component_status
dmesg_init(
378 bt_self_component_source
*self_comp
,
379 bt_value
*params
, void *init_method_data
)
382 struct dmesg_component
*dmesg_comp
= g_new0(struct dmesg_component
, 1);
383 bt_self_component_status status
= BT_SELF_COMPONENT_STATUS_OK
;
386 BT_LOGE_STR("Failed to allocate one dmesg component structure.");
390 dmesg_comp
->self_comp
= self_comp
;
391 dmesg_comp
->params
.path
= g_string_new(NULL
);
392 if (!dmesg_comp
->params
.path
) {
393 BT_LOGE_STR("Failed to allocate a GString.");
397 ret
= handle_params(dmesg_comp
, params
);
399 BT_LOGE("Invalid parameters: comp-addr=%p", self_comp
);
403 if (!dmesg_comp
->params
.read_from_stdin
&&
404 !g_file_test(dmesg_comp
->params
.path
->str
,
405 G_FILE_TEST_IS_REGULAR
)) {
406 BT_LOGE("Input path is not a regular file: "
407 "comp-addr=%p, path=\"%s\"", self_comp
,
408 dmesg_comp
->params
.path
->str
);
412 status
= create_port(self_comp
);
413 if (status
!= BT_SELF_COMPONENT_STATUS_OK
) {
417 bt_self_component_set_data(
418 bt_self_component_source_as_self_component(self_comp
),
423 destroy_dmesg_component(dmesg_comp
);
424 bt_self_component_set_data(
425 bt_self_component_source_as_self_component(self_comp
),
429 status
= BT_SELF_COMPONENT_STATUS_ERROR
;
437 void dmesg_finalize(bt_self_component_source
*self_comp
)
439 destroy_dmesg_component(bt_self_component_get_data(
440 bt_self_component_source_as_self_component(self_comp
)));
444 bt_message
*create_init_event_msg_from_line(
445 struct dmesg_msg_iter
*msg_iter
,
446 const char *line
, const char **new_start
)
449 bt_message
*msg
= NULL
;
450 bool has_timestamp
= false;
451 unsigned long sec
, usec
, msec
;
452 unsigned int year
, mon
, mday
, hour
, min
;
455 struct dmesg_component
*dmesg_comp
= msg_iter
->dmesg_comp
;
459 if (dmesg_comp
->params
.no_timestamp
) {
463 /* Extract time from input line */
464 if (sscanf(line
, "[%lu.%lu] ", &sec
, &usec
) == 2) {
465 ts
= (uint64_t) sec
* USEC_PER_SEC
+ (uint64_t) usec
;
468 * The clock class we use has a 1 GHz frequency: convert
472 has_timestamp
= true;
473 } else if (sscanf(line
, "[%u-%u-%u %u:%u:%lu.%lu] ",
474 &year
, &mon
, &mday
, &hour
, &min
,
479 memset(&ti
, 0, sizeof(ti
));
480 ti
.tm_year
= year
- 1900; /* From 1900 */
481 ti
.tm_mon
= mon
- 1; /* 0 to 11 */
487 ep_sec
= bt_timegm(&ti
);
488 if (ep_sec
!= (time_t) -1) {
489 ts
= (uint64_t) ep_sec
* NSEC_PER_SEC
490 + (uint64_t) msec
* NSEC_PER_MSEC
;
493 has_timestamp
= true;
497 /* Set new start for the message portion of the line */
498 *new_start
= strchr(line
, ']');
499 BT_ASSERT(*new_start
);
502 if ((*new_start
)[0] == ' ') {
509 * At this point, we know if the stream class's event header
510 * field class should have a timestamp or not, so we can lazily
511 * create the metadata, stream, and packet objects.
513 ret
= try_create_meta_stream_packet(dmesg_comp
, has_timestamp
);
515 /* try_create_meta_stream_packet() logs errors */
519 msg
= bt_message_event_create(msg_iter
->pc_msg_iter
,
520 dmesg_comp
->event_class
, dmesg_comp
->packet
);
522 BT_LOGE_STR("Cannot create event message.");
526 event
= bt_message_event_borrow_event(msg
);
529 if (dmesg_comp
->clock_class
) {
530 bt_event_set_default_clock_snapshot(event
, ts
);
531 msg_iter
->last_clock_value
= ts
;
537 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
544 int fill_event_payload_from_line(const char *line
,
547 bt_field
*ep_field
= NULL
;
548 bt_field
*str_field
= NULL
;
552 ep_field
= bt_event_borrow_payload_field(event
);
554 str_field
= bt_field_structure_borrow_member_field_by_index(
557 BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field.");
562 if (line
[len
- 1] == '\n') {
563 /* Do not include the newline character in the payload */
567 ret
= bt_field_string_clear(str_field
);
569 BT_LOGE_STR("Cannot clear string field object.");
573 ret
= bt_field_string_append_with_length(str_field
, line
, len
);
575 BT_LOGE("Cannot append value to string field object: "
590 bt_message
*create_msg_from_line(
591 struct dmesg_msg_iter
*dmesg_msg_iter
, const char *line
)
593 bt_event
*event
= NULL
;
594 bt_message
*msg
= NULL
;
595 const char *new_start
;
598 msg
= create_init_event_msg_from_line(dmesg_msg_iter
,
601 BT_LOGE_STR("Cannot create and initialize event message from line.");
605 event
= bt_message_event_borrow_event(msg
);
607 ret
= fill_event_payload_from_line(new_start
, event
);
609 BT_LOGE("Cannot fill event payload field from line: "
617 BT_MESSAGE_PUT_REF_AND_RESET(msg
);
624 void destroy_dmesg_msg_iter(struct dmesg_msg_iter
*dmesg_msg_iter
)
626 if (!dmesg_msg_iter
) {
630 if (dmesg_msg_iter
->fp
&& dmesg_msg_iter
->fp
!= stdin
) {
631 if (fclose(dmesg_msg_iter
->fp
)) {
632 BT_LOGE_ERRNO("Cannot close input file", ".");
636 bt_message_put_ref(dmesg_msg_iter
->tmp_event_msg
);
637 free(dmesg_msg_iter
->linebuf
);
638 g_free(dmesg_msg_iter
);
642 bt_self_message_iterator_status
dmesg_msg_iter_init(
643 bt_self_message_iterator
*self_msg_iter
,
644 bt_self_component_source
*self_comp
,
645 bt_self_component_port_output
*self_port
)
647 struct dmesg_component
*dmesg_comp
;
648 struct dmesg_msg_iter
*dmesg_msg_iter
=
649 g_new0(struct dmesg_msg_iter
, 1);
650 bt_self_message_iterator_status status
=
651 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
653 if (!dmesg_msg_iter
) {
654 BT_LOGE_STR("Failed to allocate on dmesg message iterator structure.");
658 dmesg_comp
= bt_self_component_get_data(
659 bt_self_component_source_as_self_component(self_comp
));
660 BT_ASSERT(dmesg_comp
);
661 dmesg_msg_iter
->dmesg_comp
= dmesg_comp
;
662 dmesg_msg_iter
->pc_msg_iter
= self_msg_iter
;
664 if (dmesg_comp
->params
.read_from_stdin
) {
665 dmesg_msg_iter
->fp
= stdin
;
667 dmesg_msg_iter
->fp
= fopen(dmesg_comp
->params
.path
->str
, "r");
668 if (!dmesg_msg_iter
->fp
) {
669 BT_LOGE_ERRNO("Cannot open input file in read mode", ": path=\"%s\"",
670 dmesg_comp
->params
.path
->str
);
675 bt_self_message_iterator_set_data(self_msg_iter
,
680 destroy_dmesg_msg_iter(dmesg_msg_iter
);
681 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
683 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
691 void dmesg_msg_iter_finalize(
692 bt_self_message_iterator
*priv_msg_iter
)
694 destroy_dmesg_msg_iter(bt_self_message_iterator_get_data(
699 bt_self_message_iterator_status
dmesg_msg_iter_next_one(
700 struct dmesg_msg_iter
*dmesg_msg_iter
,
704 struct dmesg_component
*dmesg_comp
;
705 bt_self_message_iterator_status status
=
706 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
708 BT_ASSERT(dmesg_msg_iter
);
709 dmesg_comp
= dmesg_msg_iter
->dmesg_comp
;
710 BT_ASSERT(dmesg_comp
);
712 if (dmesg_msg_iter
->state
== STATE_DONE
) {
713 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_END
;
717 if (dmesg_msg_iter
->tmp_event_msg
||
718 dmesg_msg_iter
->state
== STATE_EMIT_PACKET_END
||
719 dmesg_msg_iter
->state
== STATE_EMIT_STREAM_ACTIVITY_END
||
720 dmesg_msg_iter
->state
== STATE_EMIT_STREAM_END
) {
726 bool only_spaces
= true;
728 len
= bt_getline(&dmesg_msg_iter
->linebuf
,
729 &dmesg_msg_iter
->linebuf_len
, dmesg_msg_iter
->fp
);
731 if (errno
== EINVAL
) {
732 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
733 } else if (errno
== ENOMEM
) {
735 BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM
;
737 if (dmesg_msg_iter
->state
== STATE_EMIT_STREAM_BEGINNING
) {
738 /* Stream did not even begin */
739 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_END
;
742 /* End current packet now */
743 dmesg_msg_iter
->state
=
744 STATE_EMIT_PACKET_END
;
752 BT_ASSERT(dmesg_msg_iter
->linebuf
);
754 /* Ignore empty lines, once trimmed */
755 for (ch
= dmesg_msg_iter
->linebuf
; *ch
!= '\0'; ch
++) {
767 dmesg_msg_iter
->tmp_event_msg
= create_msg_from_line(
768 dmesg_msg_iter
, dmesg_msg_iter
->linebuf
);
769 if (!dmesg_msg_iter
->tmp_event_msg
) {
770 BT_LOGE("Cannot create event message from line: "
771 "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp
,
772 dmesg_msg_iter
->linebuf
);
777 BT_ASSERT(dmesg_comp
->trace
);
779 switch (dmesg_msg_iter
->state
) {
780 case STATE_EMIT_STREAM_BEGINNING
:
781 BT_ASSERT(dmesg_msg_iter
->tmp_event_msg
);
782 *msg
= bt_message_stream_beginning_create(
783 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->stream
);
784 dmesg_msg_iter
->state
= STATE_EMIT_STREAM_ACTIVITY_BEGINNING
;
786 case STATE_EMIT_STREAM_ACTIVITY_BEGINNING
:
787 BT_ASSERT(dmesg_msg_iter
->tmp_event_msg
);
788 *msg
= bt_message_stream_activity_beginning_create(
789 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->stream
);
790 dmesg_msg_iter
->state
= STATE_EMIT_PACKET_BEGINNING
;
792 case STATE_EMIT_PACKET_BEGINNING
:
793 BT_ASSERT(dmesg_msg_iter
->tmp_event_msg
);
795 if (dmesg_comp
->clock_class
) {
796 *msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
797 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->packet
,
798 dmesg_msg_iter
->last_clock_value
);
800 *msg
= bt_message_packet_beginning_create(
801 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->packet
);
804 dmesg_msg_iter
->state
= STATE_EMIT_EVENT
;
806 case STATE_EMIT_EVENT
:
807 BT_ASSERT(dmesg_msg_iter
->tmp_event_msg
);
808 *msg
= dmesg_msg_iter
->tmp_event_msg
;
809 dmesg_msg_iter
->tmp_event_msg
= NULL
;
811 case STATE_EMIT_PACKET_END
:
812 if (dmesg_comp
->clock_class
) {
813 *msg
= bt_message_packet_end_create_with_default_clock_snapshot(
814 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->packet
,
815 dmesg_msg_iter
->last_clock_value
);
817 *msg
= bt_message_packet_end_create(
818 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->packet
);
821 dmesg_msg_iter
->state
= STATE_EMIT_STREAM_ACTIVITY_END
;
823 case STATE_EMIT_STREAM_ACTIVITY_END
:
824 *msg
= bt_message_stream_activity_end_create(
825 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->stream
);
826 dmesg_msg_iter
->state
= STATE_EMIT_STREAM_END
;
828 case STATE_EMIT_STREAM_END
:
829 *msg
= bt_message_stream_end_create(
830 dmesg_msg_iter
->pc_msg_iter
, dmesg_comp
->stream
);
831 dmesg_msg_iter
->state
= STATE_DONE
;
838 BT_LOGE("Cannot create message: dmesg-comp-addr=%p",
840 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
848 bt_self_message_iterator_status
dmesg_msg_iter_next(
849 bt_self_message_iterator
*self_msg_iter
,
850 bt_message_array_const msgs
, uint64_t capacity
,
853 struct dmesg_msg_iter
*dmesg_msg_iter
=
854 bt_self_message_iterator_get_data(
856 bt_self_message_iterator_status status
=
857 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
860 while (i
< capacity
&&
861 status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
862 bt_message
*priv_msg
= NULL
;
864 status
= dmesg_msg_iter_next_one(dmesg_msg_iter
,
867 if (status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
874 * Even if dmesg_msg_iter_next_one() returned
875 * something else than
876 * BT_SELF_MESSAGE_ITERATOR_STATUS_OK, we
877 * accumulated message objects in the output
878 * message array, so we need to return
879 * BT_SELF_MESSAGE_ITERATOR_STATUS_OK so that they
880 * are transfered to downstream. This other status
881 * occurs again the next time muxer_msg_iter_do_next()
882 * is called, possibly without any accumulated
883 * message, in which case we'll return it.
886 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;