2 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
3 * Copyright 2017 Philippe Proulx <jeremie.galarneau@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/values-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_notif_iter
{
47 struct dmesg_component
*dmesg_comp
;
48 struct bt_private_connection_private_notification_iterator
*pc_notif_iter
; /* Weak */
52 struct bt_notification
*tmp_event_notif
;
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 struct bt_trace
*trace
;
72 struct bt_stream_class
*stream_class
;
73 struct bt_event_class
*event_class
;
74 struct bt_stream
*stream
;
75 struct bt_packet
*packet
;
76 struct bt_clock_class
*clock_class
;
77 struct bt_clock_class_priority_map
*cc_prio_map
;
81 struct bt_field_class
*create_event_payload_fc(void)
83 struct bt_field_class
*root_fc
= NULL
;
84 struct bt_field_class
*fc
= NULL
;
87 root_fc
= bt_field_class_structure_create();
89 BT_LOGE_STR("Cannot create an empty structure field class object.");
93 fc
= bt_field_class_string_create();
95 BT_LOGE_STR("Cannot create a string field class object.");
99 ret
= bt_field_class_structure_append_member(root_fc
, "str", fc
);
101 BT_LOGE("Cannot add `str` member to structure field class: "
109 BT_OBJECT_PUT_REF_AND_RESET(root_fc
);
112 bt_object_put_ref(fc
);
117 int create_meta(struct dmesg_component
*dmesg_comp
, bool has_ts
)
119 struct bt_field_class
*fc
= NULL
;
120 const char *trace_name
= NULL
;
121 gchar
*basename
= NULL
;
124 dmesg_comp
->trace
= bt_trace_create();
125 if (!dmesg_comp
->trace
) {
126 BT_LOGE_STR("Cannot create an empty trace object.");
130 if (dmesg_comp
->params
.read_from_stdin
) {
131 trace_name
= "STDIN";
133 basename
= g_path_get_basename(dmesg_comp
->params
.path
->str
);
136 if (strcmp(basename
, G_DIR_SEPARATOR_S
) != 0 &&
137 strcmp(basename
, ".") != 0) {
138 trace_name
= basename
;
143 ret
= bt_trace_set_name(dmesg_comp
->trace
, trace_name
);
145 BT_LOGE("Cannot set trace's name: name=\"%s\"", trace_name
);
150 dmesg_comp
->stream_class
= bt_stream_class_create(dmesg_comp
->trace
);
151 if (!dmesg_comp
->stream_class
) {
152 BT_LOGE_STR("Cannot create a stream class object.");
157 dmesg_comp
->clock_class
= bt_clock_class_create();
158 if (!dmesg_comp
->clock_class
) {
159 BT_LOGE_STR("Cannot create clock class.");
163 ret
= bt_stream_class_set_default_clock_class(
164 dmesg_comp
->stream_class
, dmesg_comp
->clock_class
);
166 BT_LOGE_STR("Cannot set stream class's default clock class.");
171 dmesg_comp
->event_class
= bt_event_class_create(
172 dmesg_comp
->stream_class
);
173 if (!dmesg_comp
->event_class
) {
174 BT_LOGE_STR("Cannot create an event class object.");
178 ret
= bt_event_class_set_name(dmesg_comp
->event_class
, "string");
180 BT_LOGE_STR("Cannot set event class's name.");
184 fc
= create_event_payload_fc();
186 BT_LOGE_STR("Cannot create event payload field class.");
190 ret
= bt_event_class_set_payload_field_class(dmesg_comp
->event_class
, fc
);
192 BT_LOGE_STR("Cannot set event class's event payload field class.");
202 bt_object_put_ref(fc
);
212 int handle_params(struct dmesg_component
*dmesg_comp
, struct bt_value
*params
)
214 struct bt_value
*no_timestamp
= NULL
;
215 struct bt_value
*path
= NULL
;
216 const char *path_str
;
219 no_timestamp
= bt_value_map_borrow_entry_value(params
,
220 "no-extract-timestamp");
222 if (!bt_value_is_bool(no_timestamp
)) {
223 BT_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: "
225 bt_common_value_type_string(
226 bt_value_get_type(no_timestamp
)));
230 ret
= bt_value_bool_get(no_timestamp
,
231 &dmesg_comp
->params
.no_timestamp
);
235 path
= bt_value_map_borrow_entry_value(params
, "path");
237 if (dmesg_comp
->params
.read_from_stdin
) {
238 BT_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters.");
242 if (!bt_value_is_string(path
)) {
243 BT_LOGE("Expecting a string value for the `path` parameter: "
245 bt_common_value_type_string(
246 bt_value_get_type(path
)));
250 ret
= bt_value_string_get(path
, &path_str
);
252 g_string_assign(dmesg_comp
->params
.path
, path_str
);
254 dmesg_comp
->params
.read_from_stdin
= true;
267 int create_packet_and_stream(struct dmesg_component
*dmesg_comp
)
271 dmesg_comp
->stream
= bt_stream_create(dmesg_comp
->stream_class
);
272 if (!dmesg_comp
->stream
) {
273 BT_LOGE_STR("Cannot create stream object.");
277 dmesg_comp
->packet
= bt_packet_create(dmesg_comp
->stream
);
278 if (!dmesg_comp
->packet
) {
279 BT_LOGE_STR("Cannot create packet object.");
283 ret
= bt_trace_make_static(dmesg_comp
->trace
);
285 BT_LOGE_STR("Cannot make trace static.");
299 int try_create_meta_stream_packet(struct dmesg_component
*dmesg_comp
,
304 if (dmesg_comp
->trace
) {
305 /* Already created */
309 ret
= create_meta(dmesg_comp
, has_ts
);
311 BT_LOGE("Cannot create metadata objects: dmesg-comp-addr=%p",
316 ret
= create_packet_and_stream(dmesg_comp
);
318 BT_LOGE("Cannot create packet and stream objects: "
319 "dmesg-comp-addr=%p", dmesg_comp
);
333 void destroy_dmesg_component(struct dmesg_component
*dmesg_comp
)
339 if (dmesg_comp
->params
.path
) {
340 g_string_free(dmesg_comp
->params
.path
, TRUE
);
343 bt_object_put_ref(dmesg_comp
->packet
);
344 bt_object_put_ref(dmesg_comp
->trace
);
345 bt_object_put_ref(dmesg_comp
->stream_class
);
346 bt_object_put_ref(dmesg_comp
->event_class
);
347 bt_object_put_ref(dmesg_comp
->stream
);
348 bt_object_put_ref(dmesg_comp
->clock_class
);
349 bt_object_put_ref(dmesg_comp
->cc_prio_map
);
354 enum bt_component_status
create_port(struct bt_private_component
*priv_comp
)
356 return bt_private_component_source_add_output_private_port(priv_comp
,
361 enum bt_component_status
dmesg_init(struct bt_private_component
*priv_comp
,
362 struct bt_value
*params
, void *init_method_data
)
365 struct dmesg_component
*dmesg_comp
= g_new0(struct dmesg_component
, 1);
366 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
369 BT_LOGE_STR("Failed to allocate one dmesg component structure.");
373 dmesg_comp
->params
.path
= g_string_new(NULL
);
374 if (!dmesg_comp
->params
.path
) {
375 BT_LOGE_STR("Failed to allocate a GString.");
379 ret
= handle_params(dmesg_comp
, params
);
381 BT_LOGE("Invalid parameters: comp-addr=%p", priv_comp
);
385 if (!dmesg_comp
->params
.read_from_stdin
&&
386 !g_file_test(dmesg_comp
->params
.path
->str
,
387 G_FILE_TEST_IS_REGULAR
)) {
388 BT_LOGE("Input path is not a regular file: "
389 "comp-addr=%p, path=\"%s\"", priv_comp
,
390 dmesg_comp
->params
.path
->str
);
394 status
= create_port(priv_comp
);
395 if (status
!= BT_COMPONENT_STATUS_OK
) {
399 (void) bt_private_component_set_user_data(priv_comp
, dmesg_comp
);
403 destroy_dmesg_component(dmesg_comp
);
404 (void) bt_private_component_set_user_data(priv_comp
, NULL
);
407 status
= BT_COMPONENT_STATUS_ERROR
;
415 void dmesg_finalize(struct bt_private_component
*priv_comp
)
417 void *data
= bt_private_component_get_user_data(priv_comp
);
419 destroy_dmesg_component(data
);
423 struct bt_notification
*create_init_event_notif_from_line(
424 struct dmesg_notif_iter
*notif_iter
,
425 const char *line
, const char **new_start
)
427 struct bt_event
*event
;
428 struct bt_notification
*notif
= NULL
;
429 bool has_timestamp
= false;
430 unsigned long sec
, usec
, msec
;
431 unsigned int year
, mon
, mday
, hour
, min
;
434 struct dmesg_component
*dmesg_comp
= notif_iter
->dmesg_comp
;
438 if (dmesg_comp
->params
.no_timestamp
) {
442 /* Extract time from input line */
443 if (sscanf(line
, "[%lu.%lu] ", &sec
, &usec
) == 2) {
444 ts
= (uint64_t) sec
* USEC_PER_SEC
+ (uint64_t) usec
;
447 * The clock class we use has a 1 GHz frequency: convert
451 has_timestamp
= true;
452 } else if (sscanf(line
, "[%u-%u-%u %u:%u:%lu.%lu] ",
453 &year
, &mon
, &mday
, &hour
, &min
,
458 memset(&ti
, 0, sizeof(ti
));
459 ti
.tm_year
= year
- 1900; /* From 1900 */
460 ti
.tm_mon
= mon
- 1; /* 0 to 11 */
466 ep_sec
= bt_timegm(&ti
);
467 if (ep_sec
!= (time_t) -1) {
468 ts
= (uint64_t) ep_sec
* NSEC_PER_SEC
469 + (uint64_t) msec
* NSEC_PER_MSEC
;
472 has_timestamp
= true;
476 /* Set new start for the message portion of the line */
477 *new_start
= strchr(line
, ']');
478 BT_ASSERT(*new_start
);
481 if ((*new_start
)[0] == ' ') {
488 * At this point, we know if the stream class's event header
489 * field class should have a timestamp or not, so we can lazily
490 * create the metadata, stream, and packet objects.
492 ret
= try_create_meta_stream_packet(dmesg_comp
, has_timestamp
);
494 /* try_create_meta_stream_packet() logs errors */
498 notif
= bt_notification_event_create(notif_iter
->pc_notif_iter
,
499 dmesg_comp
->event_class
, dmesg_comp
->packet
);
501 BT_LOGE_STR("Cannot create event notification.");
505 event
= bt_notification_event_borrow_event(notif
);
508 if (dmesg_comp
->clock_class
) {
509 ret
= bt_event_set_default_clock_value(event
, ts
);
516 BT_OBJECT_PUT_REF_AND_RESET(notif
);
523 int fill_event_payload_from_line(const char *line
, struct bt_event
*event
)
525 struct bt_field
*ep_field
= NULL
;
526 struct bt_field
*str_field
= NULL
;
530 ep_field
= bt_event_borrow_payload_field(event
);
532 str_field
= bt_field_structure_borrow_member_field_by_index(ep_field
,
535 BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field.");
540 if (line
[len
- 1] == '\n') {
541 /* Do not include the newline character in the payload */
545 ret
= bt_field_string_clear(str_field
);
547 BT_LOGE_STR("Cannot clear string field object.");
551 ret
= bt_field_string_append_with_length(str_field
, line
, len
);
553 BT_LOGE("Cannot append value to string field object: "
568 struct bt_notification
*create_notif_from_line(
569 struct dmesg_notif_iter
*dmesg_notif_iter
, const char *line
)
571 struct bt_event
*event
= NULL
;
572 struct bt_notification
*notif
= NULL
;
573 const char *new_start
;
576 notif
= create_init_event_notif_from_line(dmesg_notif_iter
,
579 BT_LOGE_STR("Cannot create and initialize event notification from line.");
583 event
= bt_notification_event_borrow_event(notif
);
585 ret
= fill_event_payload_from_line(new_start
, event
);
587 BT_LOGE("Cannot fill event payload field from line: "
595 BT_OBJECT_PUT_REF_AND_RESET(notif
);
602 void destroy_dmesg_notif_iter(struct dmesg_notif_iter
*dmesg_notif_iter
)
604 if (!dmesg_notif_iter
) {
608 if (dmesg_notif_iter
->fp
&& dmesg_notif_iter
->fp
!= stdin
) {
609 if (fclose(dmesg_notif_iter
->fp
)) {
610 BT_LOGE_ERRNO("Cannot close input file", ".");
614 bt_object_put_ref(dmesg_notif_iter
->tmp_event_notif
);
615 free(dmesg_notif_iter
->linebuf
);
616 g_free(dmesg_notif_iter
);
620 enum bt_notification_iterator_status
dmesg_notif_iter_init(
621 struct bt_private_connection_private_notification_iterator
*priv_notif_iter
,
622 struct bt_private_port
*priv_port
)
624 struct bt_private_component
*priv_comp
= NULL
;
625 struct dmesg_component
*dmesg_comp
;
626 struct dmesg_notif_iter
*dmesg_notif_iter
=
627 g_new0(struct dmesg_notif_iter
, 1);
628 enum bt_notification_iterator_status status
=
629 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
631 if (!dmesg_notif_iter
) {
632 BT_LOGE_STR("Failed to allocate on dmesg notification iterator structure.");
636 priv_comp
= bt_private_connection_private_notification_iterator_get_private_component(
638 BT_ASSERT(priv_comp
);
639 dmesg_comp
= bt_private_component_get_user_data(priv_comp
);
640 BT_ASSERT(dmesg_comp
);
641 dmesg_notif_iter
->dmesg_comp
= dmesg_comp
;
642 dmesg_notif_iter
->pc_notif_iter
= priv_notif_iter
;
644 if (dmesg_comp
->params
.read_from_stdin
) {
645 dmesg_notif_iter
->fp
= stdin
;
647 dmesg_notif_iter
->fp
= fopen(dmesg_comp
->params
.path
->str
, "r");
648 if (!dmesg_notif_iter
->fp
) {
649 BT_LOGE_ERRNO("Cannot open input file in read mode", ": path=\"%s\"",
650 dmesg_comp
->params
.path
->str
);
655 (void) bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter
,
660 destroy_dmesg_notif_iter(dmesg_notif_iter
);
661 (void) bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter
,
664 status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
668 bt_object_put_ref(priv_comp
);
673 void dmesg_notif_iter_finalize(
674 struct bt_private_connection_private_notification_iterator
*priv_notif_iter
)
676 destroy_dmesg_notif_iter(bt_private_connection_private_notification_iterator_get_user_data(
681 enum bt_notification_iterator_status
dmesg_notif_iter_next_one(
682 struct dmesg_notif_iter
*dmesg_notif_iter
,
683 struct bt_notification
**notif
)
686 struct dmesg_component
*dmesg_comp
;
687 enum bt_notification_iterator_status status
=
688 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
690 BT_ASSERT(dmesg_notif_iter
);
691 dmesg_comp
= dmesg_notif_iter
->dmesg_comp
;
692 BT_ASSERT(dmesg_comp
);
694 if (dmesg_notif_iter
->state
== STATE_DONE
) {
695 status
= BT_NOTIFICATION_ITERATOR_STATUS_END
;
699 if (dmesg_notif_iter
->tmp_event_notif
||
700 dmesg_notif_iter
->state
== STATE_EMIT_PACKET_END
||
701 dmesg_notif_iter
->state
== STATE_EMIT_STREAM_END
) {
707 bool only_spaces
= true;
709 len
= bt_getline(&dmesg_notif_iter
->linebuf
,
710 &dmesg_notif_iter
->linebuf_len
, dmesg_notif_iter
->fp
);
712 if (errno
== EINVAL
) {
713 status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
714 } else if (errno
== ENOMEM
) {
716 BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
718 if (dmesg_notif_iter
->state
== STATE_EMIT_STREAM_BEGINNING
) {
719 /* Stream did not even begin */
720 status
= BT_NOTIFICATION_ITERATOR_STATUS_END
;
723 /* End current packet now */
724 dmesg_notif_iter
->state
=
725 STATE_EMIT_PACKET_END
;
733 BT_ASSERT(dmesg_notif_iter
->linebuf
);
735 /* Ignore empty lines, once trimmed */
736 for (ch
= dmesg_notif_iter
->linebuf
; *ch
!= '\0'; ch
++) {
748 dmesg_notif_iter
->tmp_event_notif
= create_notif_from_line(
749 dmesg_notif_iter
, dmesg_notif_iter
->linebuf
);
750 if (!dmesg_notif_iter
->tmp_event_notif
) {
751 BT_LOGE("Cannot create event notification from line: "
752 "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp
,
753 dmesg_notif_iter
->linebuf
);
758 BT_ASSERT(dmesg_comp
->trace
);
760 switch (dmesg_notif_iter
->state
) {
761 case STATE_EMIT_STREAM_BEGINNING
:
762 BT_ASSERT(dmesg_notif_iter
->tmp_event_notif
);
763 *notif
= bt_notification_stream_begin_create(
764 dmesg_notif_iter
->pc_notif_iter
, dmesg_comp
->stream
);
765 dmesg_notif_iter
->state
= STATE_EMIT_PACKET_BEGINNING
;
767 case STATE_EMIT_PACKET_BEGINNING
:
768 BT_ASSERT(dmesg_notif_iter
->tmp_event_notif
);
769 *notif
= bt_notification_packet_begin_create(
770 dmesg_notif_iter
->pc_notif_iter
, dmesg_comp
->packet
);
771 dmesg_notif_iter
->state
= STATE_EMIT_EVENT
;
773 case STATE_EMIT_EVENT
:
774 BT_ASSERT(dmesg_notif_iter
->tmp_event_notif
);
775 *notif
= dmesg_notif_iter
->tmp_event_notif
;
776 dmesg_notif_iter
->tmp_event_notif
= NULL
;
778 case STATE_EMIT_PACKET_END
:
779 *notif
= bt_notification_packet_end_create(
780 dmesg_notif_iter
->pc_notif_iter
, dmesg_comp
->packet
);
781 dmesg_notif_iter
->state
= STATE_EMIT_STREAM_END
;
783 case STATE_EMIT_STREAM_END
:
784 *notif
= bt_notification_stream_end_create(
785 dmesg_notif_iter
->pc_notif_iter
, dmesg_comp
->stream
);
786 dmesg_notif_iter
->state
= STATE_DONE
;
793 BT_LOGE("Cannot create notification: dmesg-comp-addr=%p",
795 status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
803 enum bt_notification_iterator_status
dmesg_notif_iter_next(
804 struct bt_private_connection_private_notification_iterator
*priv_notif_iter
,
805 bt_notification_array notifs
, uint64_t capacity
,
808 struct dmesg_notif_iter
*dmesg_notif_iter
=
809 bt_private_connection_private_notification_iterator_get_user_data(
811 enum bt_notification_iterator_status status
=
812 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
815 while (i
< capacity
&& status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
816 status
= dmesg_notif_iter_next_one(dmesg_notif_iter
, ¬ifs
[i
]);
817 if (status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
824 * Even if dmesg_notif_iter_next_one() returned
825 * something else than
826 * BT_NOTIFICATION_ITERATOR_STATUS_OK, we accumulated
827 * notification objects in the output notification
828 * array, so we need to return
829 * BT_NOTIFICATION_ITERATOR_STATUS_OK so that they are
830 * transfered to downstream. This other status occurs
831 * again the next time muxer_notif_iter_do_next() is
832 * called, possibly without any accumulated
833 * notification, in which case we'll return it.
836 status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
;