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/babeltrace.h>
33 #include <babeltrace/values-internal.h>
34 #include <babeltrace/compat/utc-internal.h>
35 #include <babeltrace/compat/stdio-internal.h>
38 #define NSEC_PER_USEC 1000UL
39 #define NSEC_PER_MSEC 1000000UL
40 #define NSEC_PER_SEC 1000000000ULL
41 #define USEC_PER_SEC 1000000UL
43 struct dmesg_component
;
45 struct dmesg_notif_iter
{
46 struct dmesg_component
*dmesg_comp
;
50 struct bt_notification
*tmp_event_notif
;
53 STATE_EMIT_STREAM_BEGINNING
,
54 STATE_EMIT_PACKET_BEGINNING
,
56 STATE_EMIT_PACKET_END
,
57 STATE_EMIT_STREAM_END
,
62 struct dmesg_component
{
65 bt_bool read_from_stdin
;
69 struct bt_trace
*trace
;
70 struct bt_stream_class
*stream_class
;
71 struct bt_event_class
*event_class
;
72 struct bt_stream
*stream
;
73 struct bt_packet
*packet
;
74 struct bt_clock_class
*clock_class
;
75 struct bt_clock_class_priority_map
*cc_prio_map
;
79 struct bt_field_type
*create_packet_header_ft(void)
81 struct bt_field_type
*root_ft
= NULL
;
82 struct bt_field_type
*ft
= NULL
;
85 root_ft
= bt_field_type_structure_create();
87 BT_LOGE_STR("Cannot create an empty structure field type object.");
91 ft
= bt_field_type_integer_create(32);
93 BT_LOGE_STR("Cannot create an integer field type object.");
97 ret
= bt_field_type_structure_add_field(root_ft
, ft
, "magic");
99 BT_LOGE("Cannot add `magic` field type to structure field type: "
105 ft
= bt_field_type_integer_create(8);
107 BT_LOGE_STR("Cannot create an integer field type object.");
122 struct bt_field_type
*create_event_header_ft(
123 struct bt_clock_class
*clock_class
)
125 struct bt_field_type
*root_ft
= NULL
;
126 struct bt_field_type
*ft
= NULL
;
129 root_ft
= bt_field_type_structure_create();
131 BT_LOGE_STR("Cannot create an empty structure field type object.");
135 ft
= bt_field_type_integer_create(64);
137 BT_LOGE_STR("Cannot create an integer field type object.");
141 ret
= bt_field_type_integer_set_mapped_clock_class(ft
, clock_class
);
143 BT_LOGE("Cannot map integer field type to clock class: "
148 ret
= bt_field_type_structure_add_field(root_ft
,
151 BT_LOGE("Cannot add `timestamp` field type to structure field type: "
167 struct bt_field_type
*create_event_payload_ft(void)
169 struct bt_field_type
*root_ft
= NULL
;
170 struct bt_field_type
*ft
= NULL
;
173 root_ft
= bt_field_type_structure_create();
175 BT_LOGE_STR("Cannot create an empty structure field type object.");
179 ft
= bt_field_type_string_create();
181 BT_LOGE_STR("Cannot create a string field type object.");
185 ret
= bt_field_type_structure_add_field(root_ft
,
188 BT_LOGE("Cannot add `str` field type to structure field type: "
204 struct bt_clock_class
*create_clock_class(void)
206 return bt_clock_class_create("the_clock", 1000000000);
210 int create_meta(struct dmesg_component
*dmesg_comp
, bool has_ts
)
212 struct bt_field_type
*ft
= NULL
;
213 const char *trace_name
= NULL
;
214 gchar
*basename
= NULL
;
217 dmesg_comp
->trace
= bt_trace_create();
218 if (!dmesg_comp
->trace
) {
219 BT_LOGE_STR("Cannot create an empty trace object.");
223 ft
= create_packet_header_ft();
225 BT_LOGE_STR("Cannot create packet header field type.");
229 ret
= bt_trace_set_packet_header_field_type(dmesg_comp
->trace
, ft
);
231 BT_LOGE_STR("Cannot set trace's packet header field type.");
235 if (dmesg_comp
->params
.read_from_stdin
) {
236 trace_name
= "STDIN";
238 basename
= g_path_get_basename(dmesg_comp
->params
.path
->str
);
241 if (strcmp(basename
, G_DIR_SEPARATOR_S
) != 0 &&
242 strcmp(basename
, ".") != 0) {
243 trace_name
= basename
;
248 ret
= bt_trace_set_name(dmesg_comp
->trace
, trace_name
);
250 BT_LOGE("Cannot set trace's name: name=\"%s\"", trace_name
);
255 dmesg_comp
->stream_class
= bt_stream_class_create(NULL
);
256 if (!dmesg_comp
->stream_class
) {
257 BT_LOGE_STR("Cannot create an empty stream class object.");
261 dmesg_comp
->cc_prio_map
= bt_clock_class_priority_map_create();
262 if (!dmesg_comp
->cc_prio_map
) {
263 BT_LOGE_STR("Cannot create empty clock class priority map.");
268 dmesg_comp
->clock_class
= create_clock_class();
269 if (!dmesg_comp
->clock_class
) {
270 BT_LOGE_STR("Cannot create clock class.");
274 ret
= bt_trace_add_clock_class(dmesg_comp
->trace
,
275 dmesg_comp
->clock_class
);
277 BT_LOGE_STR("Cannot add clock class to trace.");
281 ret
= bt_clock_class_priority_map_add_clock_class(
282 dmesg_comp
->cc_prio_map
, dmesg_comp
->clock_class
, 0);
284 BT_LOGE_STR("Cannot add clock class to clock class priority map.");
289 ft
= create_event_header_ft(dmesg_comp
->clock_class
);
291 BT_LOGE_STR("Cannot create event header field type.");
295 ret
= bt_stream_class_set_event_header_field_type(
296 dmesg_comp
->stream_class
, ft
);
298 BT_LOGE_STR("Cannot set stream class's event header field type.");
303 dmesg_comp
->event_class
= bt_event_class_create("string");
304 if (!dmesg_comp
->event_class
) {
305 BT_LOGE_STR("Cannot create an empty event class object.");
310 ft
= create_event_payload_ft();
312 BT_LOGE_STR("Cannot create event payload field type.");
316 ret
= bt_event_class_set_payload_field_type(dmesg_comp
->event_class
, ft
);
318 BT_LOGE_STR("Cannot set event class's event payload field type.");
322 ret
= bt_stream_class_add_event_class(dmesg_comp
->stream_class
,
323 dmesg_comp
->event_class
);
325 BT_LOGE("Cannot add event class to stream class: ret=%d", ret
);
329 ret
= bt_trace_add_stream_class(dmesg_comp
->trace
,
330 dmesg_comp
->stream_class
);
332 BT_LOGE("Cannot add event class to stream class: ret=%d", ret
);
352 int handle_params(struct dmesg_component
*dmesg_comp
, struct bt_value
*params
)
354 struct bt_value
*read_from_stdin
= NULL
;
355 struct bt_value
*no_timestamp
= NULL
;
356 struct bt_value
*path
= NULL
;
357 const char *path_str
;
360 no_timestamp
= bt_value_map_get(params
, "no-extract-timestamp");
362 if (!bt_value_is_bool(no_timestamp
)) {
363 BT_LOGE("Expecting a boolean value for the `no-extract-timestamp` parameter: "
365 bt_value_type_string(
366 bt_value_get_type(no_timestamp
)));
370 ret
= bt_value_bool_get(no_timestamp
,
371 &dmesg_comp
->params
.no_timestamp
);
375 path
= bt_value_map_get(params
, "path");
377 if (dmesg_comp
->params
.read_from_stdin
) {
378 BT_LOGE_STR("Cannot specify both `read-from-stdin` and `path` parameters.");
382 if (!bt_value_is_string(path
)) {
383 BT_LOGE("Expecting a string value for the `path` parameter: "
385 bt_value_type_string(
386 bt_value_get_type(path
)));
390 ret
= bt_value_string_get(path
, &path_str
);
392 g_string_assign(dmesg_comp
->params
.path
, path_str
);
394 dmesg_comp
->params
.read_from_stdin
= true;
403 bt_put(read_from_stdin
);
405 bt_put(no_timestamp
);
410 int fill_packet_header_field(struct bt_packet
*packet
)
412 struct bt_field
*ph
= NULL
;
413 struct bt_field
*magic
= NULL
;
416 ph
= bt_packet_borrow_header(packet
);
418 magic
= bt_field_structure_borrow_field_by_name(ph
, "magic");
420 BT_LOGE_STR("Cannot borrow `magic` field from structure field.");
424 ret
= bt_field_integer_unsigned_set_value(magic
, 0xc1fc1fc1);
436 int create_packet_and_stream(struct dmesg_component
*dmesg_comp
)
440 dmesg_comp
->stream
= bt_stream_create(dmesg_comp
->stream_class
,
442 if (!dmesg_comp
->stream
) {
443 BT_LOGE_STR("Cannot create stream object.");
447 dmesg_comp
->packet
= bt_packet_create(dmesg_comp
->stream
);
448 if (!dmesg_comp
->packet
) {
449 BT_LOGE_STR("Cannot create packet object.");
453 ret
= fill_packet_header_field(dmesg_comp
->packet
);
455 BT_LOGE_STR("Cannot fill packet header field.");
459 ret
= bt_trace_set_is_static(dmesg_comp
->trace
);
461 BT_LOGE_STR("Cannot make trace static.");
475 int try_create_meta_stream_packet(struct dmesg_component
*dmesg_comp
,
480 if (dmesg_comp
->trace
) {
481 /* Already created */
485 ret
= create_meta(dmesg_comp
, has_ts
);
487 BT_LOGE("Cannot create metadata objects: dmesg-comp-addr=%p",
492 ret
= create_packet_and_stream(dmesg_comp
);
494 BT_LOGE("Cannot create packet and stream objects: "
495 "dmesg-comp-addr=%p", dmesg_comp
);
509 void destroy_dmesg_component(struct dmesg_component
*dmesg_comp
)
515 if (dmesg_comp
->params
.path
) {
516 g_string_free(dmesg_comp
->params
.path
, TRUE
);
519 bt_put(dmesg_comp
->packet
);
520 bt_put(dmesg_comp
->trace
);
521 bt_put(dmesg_comp
->stream_class
);
522 bt_put(dmesg_comp
->event_class
);
523 bt_put(dmesg_comp
->stream
);
524 bt_put(dmesg_comp
->clock_class
);
525 bt_put(dmesg_comp
->cc_prio_map
);
530 enum bt_component_status
create_port(struct bt_private_component
*priv_comp
)
532 return bt_private_component_source_add_output_private_port(priv_comp
,
537 enum bt_component_status
dmesg_init(struct bt_private_component
*priv_comp
,
538 struct bt_value
*params
, void *init_method_data
)
541 struct dmesg_component
*dmesg_comp
= g_new0(struct dmesg_component
, 1);
542 enum bt_component_status status
= BT_COMPONENT_STATUS_OK
;
545 BT_LOGE_STR("Failed to allocate one dmesg component structure.");
549 dmesg_comp
->params
.path
= g_string_new(NULL
);
550 if (!dmesg_comp
->params
.path
) {
551 BT_LOGE_STR("Failed to allocate a GString.");
555 ret
= handle_params(dmesg_comp
, params
);
557 BT_LOGE("Invalid parameters: comp-addr=%p", priv_comp
);
561 if (!dmesg_comp
->params
.read_from_stdin
&&
562 !g_file_test(dmesg_comp
->params
.path
->str
,
563 G_FILE_TEST_IS_REGULAR
)) {
564 BT_LOGE("Input path is not a regular file: "
565 "comp-addr=%p, path=\"%s\"", priv_comp
,
566 dmesg_comp
->params
.path
->str
);
570 status
= create_port(priv_comp
);
571 if (status
!= BT_COMPONENT_STATUS_OK
) {
575 (void) bt_private_component_set_user_data(priv_comp
, dmesg_comp
);
579 destroy_dmesg_component(dmesg_comp
);
580 (void) bt_private_component_set_user_data(priv_comp
, NULL
);
583 status
= BT_COMPONENT_STATUS_ERROR
;
591 void dmesg_finalize(struct bt_private_component
*priv_comp
)
593 void *data
= bt_private_component_get_user_data(priv_comp
);
595 destroy_dmesg_component(data
);
599 struct bt_notification
*create_init_event_notif_from_line(
600 struct dmesg_component
*dmesg_comp
,
601 const char *line
, const char **new_start
)
603 struct bt_event
*event
;
604 struct bt_notification
*notif
= NULL
;
605 bool has_timestamp
= false;
606 unsigned long sec
, usec
, msec
;
607 unsigned int year
, mon
, mday
, hour
, min
;
609 struct bt_field
*eh_field
= NULL
;
610 struct bt_field
*ts_field
= NULL
;
615 if (dmesg_comp
->params
.no_timestamp
) {
619 /* Extract time from input line */
620 if (sscanf(line
, "[%lu.%lu] ", &sec
, &usec
) == 2) {
621 ts
= (uint64_t) sec
* USEC_PER_SEC
+ (uint64_t) usec
;
624 * The clock class we use has a 1 GHz frequency: convert
628 has_timestamp
= true;
629 } else if (sscanf(line
, "[%u-%u-%u %u:%u:%lu.%lu] ",
630 &year
, &mon
, &mday
, &hour
, &min
,
635 memset(&ti
, 0, sizeof(ti
));
636 ti
.tm_year
= year
- 1900; /* From 1900 */
637 ti
.tm_mon
= mon
- 1; /* 0 to 11 */
643 ep_sec
= bt_timegm(&ti
);
644 if (ep_sec
!= (time_t) -1) {
645 ts
= (uint64_t) ep_sec
* NSEC_PER_SEC
646 + (uint64_t) msec
* NSEC_PER_MSEC
;
649 has_timestamp
= true;
653 /* Set new start for the message portion of the line */
654 *new_start
= strchr(line
, ']');
655 BT_ASSERT(*new_start
);
658 if ((*new_start
)[0] == ' ') {
665 * At this point, we know if the stream class's event header
666 * field type should have a timestamp or not, so we can lazily
667 * create the metadata, stream, and packet objects.
669 ret
= try_create_meta_stream_packet(dmesg_comp
, has_timestamp
);
671 /* try_create_meta_stream_packet() logs errors */
675 notif
= bt_notification_event_create(dmesg_comp
->event_class
,
676 dmesg_comp
->packet
, dmesg_comp
->cc_prio_map
);
678 BT_LOGE_STR("Cannot create event notification.");
682 event
= bt_notification_event_borrow_event(notif
);
685 if (dmesg_comp
->clock_class
) {
686 struct bt_clock_value
*cv
= bt_event_borrow_clock_value(event
,
687 dmesg_comp
->clock_class
);
689 ret
= bt_clock_value_set_value(cv
, ts
);
691 eh_field
= bt_event_borrow_header(event
);
693 ts_field
= bt_field_structure_borrow_field_by_name(eh_field
,
696 BT_LOGE_STR("Cannot borrow `timestamp` field from event header structure field.");
700 ret
= bt_field_integer_unsigned_set_value(ts_field
, ts
);
714 int fill_event_payload_from_line(struct dmesg_component
*dmesg_comp
,
715 const char *line
, struct bt_event
*event
)
717 struct bt_field
*ep_field
= NULL
;
718 struct bt_field
*str_field
= NULL
;
722 ep_field
= bt_event_borrow_payload(event
);
724 str_field
= bt_field_structure_borrow_field_by_name(ep_field
, "str");
726 BT_LOGE_STR("Cannot borrow `timestamp` field from event payload structure field.");
731 if (line
[len
- 1] == '\n') {
732 /* Do not include the newline character in the payload */
736 ret
= bt_field_string_clear(str_field
);
738 BT_LOGE_STR("Cannot clear string field object.");
742 ret
= bt_field_string_append_len(str_field
, line
, len
);
744 BT_LOGE("Cannot append value to string field object: "
759 struct bt_notification
*create_notif_from_line(
760 struct dmesg_component
*dmesg_comp
, const char *line
)
762 struct bt_event
*event
= NULL
;
763 struct bt_notification
*notif
= NULL
;
764 const char *new_start
;
767 notif
= create_init_event_notif_from_line(dmesg_comp
, line
, &new_start
);
769 BT_LOGE_STR("Cannot create and initialize event notification from line.");
773 event
= bt_notification_event_borrow_event(notif
);
775 ret
= fill_event_payload_from_line(dmesg_comp
, new_start
,
778 BT_LOGE("Cannot fill event payload field from line: "
793 void destroy_dmesg_notif_iter(struct dmesg_notif_iter
*dmesg_notif_iter
)
795 if (!dmesg_notif_iter
) {
799 if (dmesg_notif_iter
->fp
&& dmesg_notif_iter
->fp
!= stdin
) {
800 if (fclose(dmesg_notif_iter
->fp
)) {
801 BT_LOGE_ERRNO("Cannot close input file", ".");
805 bt_put(dmesg_notif_iter
->tmp_event_notif
);
806 free(dmesg_notif_iter
->linebuf
);
807 g_free(dmesg_notif_iter
);
811 enum bt_notification_iterator_status
dmesg_notif_iter_init(
812 struct bt_private_connection_private_notification_iterator
*priv_notif_iter
,
813 struct bt_private_port
*priv_port
)
815 struct bt_private_component
*priv_comp
= NULL
;
816 struct dmesg_component
*dmesg_comp
;
817 struct dmesg_notif_iter
*dmesg_notif_iter
=
818 g_new0(struct dmesg_notif_iter
, 1);
819 enum bt_notification_iterator_status status
=
820 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
822 if (!dmesg_notif_iter
) {
823 BT_LOGE_STR("Failed to allocate on dmesg notification iterator structure.");
827 priv_comp
= bt_private_connection_private_notification_iterator_get_private_component(
829 BT_ASSERT(priv_comp
);
830 dmesg_comp
= bt_private_component_get_user_data(priv_comp
);
831 BT_ASSERT(dmesg_comp
);
832 dmesg_notif_iter
->dmesg_comp
= dmesg_comp
;
834 if (dmesg_comp
->params
.read_from_stdin
) {
835 dmesg_notif_iter
->fp
= stdin
;
837 dmesg_notif_iter
->fp
= fopen(dmesg_comp
->params
.path
->str
, "r");
838 if (!dmesg_notif_iter
->fp
) {
839 BT_LOGE_ERRNO("Cannot open input file in read mode", ": path=\"%s\"",
840 dmesg_comp
->params
.path
->str
);
845 (void) bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter
,
850 destroy_dmesg_notif_iter(dmesg_notif_iter
);
851 (void) bt_private_connection_private_notification_iterator_set_user_data(priv_notif_iter
,
854 status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
863 void dmesg_notif_iter_finalize(
864 struct bt_private_connection_private_notification_iterator
*priv_notif_iter
)
866 destroy_dmesg_notif_iter(bt_private_connection_private_notification_iterator_get_user_data(
871 struct bt_notification_iterator_next_method_return
dmesg_notif_iter_next(
872 struct bt_private_connection_private_notification_iterator
*priv_notif_iter
)
875 struct dmesg_notif_iter
*dmesg_notif_iter
=
876 bt_private_connection_private_notification_iterator_get_user_data(
878 struct dmesg_component
*dmesg_comp
;
879 struct bt_notification_iterator_next_method_return next_ret
= {
880 .status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
,
884 BT_ASSERT(dmesg_notif_iter
);
885 dmesg_comp
= dmesg_notif_iter
->dmesg_comp
;
886 BT_ASSERT(dmesg_comp
);
888 if (dmesg_notif_iter
->state
== STATE_DONE
) {
889 next_ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_END
;
893 if (dmesg_notif_iter
->tmp_event_notif
||
894 dmesg_notif_iter
->state
== STATE_EMIT_PACKET_END
||
895 dmesg_notif_iter
->state
== STATE_EMIT_STREAM_END
) {
901 bool only_spaces
= true;
903 len
= bt_getline(&dmesg_notif_iter
->linebuf
,
904 &dmesg_notif_iter
->linebuf_len
, dmesg_notif_iter
->fp
);
906 if (errno
== EINVAL
) {
908 BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
909 } else if (errno
== ENOMEM
) {
911 BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
913 if (dmesg_notif_iter
->state
== STATE_EMIT_STREAM_BEGINNING
) {
914 /* Stream did not even begin */
916 BT_NOTIFICATION_ITERATOR_STATUS_END
;
919 /* End current packet now */
920 dmesg_notif_iter
->state
=
921 STATE_EMIT_PACKET_END
;
929 BT_ASSERT(dmesg_notif_iter
->linebuf
);
931 /* Ignore empty lines, once trimmed */
932 for (ch
= dmesg_notif_iter
->linebuf
; *ch
!= '\0'; ch
++) {
944 dmesg_notif_iter
->tmp_event_notif
= create_notif_from_line(dmesg_comp
,
945 dmesg_notif_iter
->linebuf
);
946 if (!dmesg_notif_iter
->tmp_event_notif
) {
947 BT_LOGE("Cannot create event notification from line: "
948 "dmesg-comp-addr=%p, line=\"%s\"", dmesg_comp
,
949 dmesg_notif_iter
->linebuf
);
954 BT_ASSERT(dmesg_comp
->trace
);
956 switch (dmesg_notif_iter
->state
) {
957 case STATE_EMIT_STREAM_BEGINNING
:
958 BT_ASSERT(dmesg_notif_iter
->tmp_event_notif
);
959 next_ret
.notification
= bt_notification_stream_begin_create(
961 dmesg_notif_iter
->state
= STATE_EMIT_PACKET_BEGINNING
;
963 case STATE_EMIT_PACKET_BEGINNING
:
964 BT_ASSERT(dmesg_notif_iter
->tmp_event_notif
);
965 next_ret
.notification
= bt_notification_packet_begin_create(
967 dmesg_notif_iter
->state
= STATE_EMIT_EVENT
;
969 case STATE_EMIT_EVENT
:
970 BT_ASSERT(dmesg_notif_iter
->tmp_event_notif
);
971 BT_MOVE(next_ret
.notification
,
972 dmesg_notif_iter
->tmp_event_notif
);
974 case STATE_EMIT_PACKET_END
:
975 next_ret
.notification
= bt_notification_packet_end_create(
977 dmesg_notif_iter
->state
= STATE_EMIT_STREAM_END
;
979 case STATE_EMIT_STREAM_END
:
980 next_ret
.notification
= bt_notification_stream_end_create(
982 dmesg_notif_iter
->state
= STATE_DONE
;
988 if (!next_ret
.notification
) {
989 BT_LOGE("Cannot create notification: dmesg-comp-addr=%p",
991 next_ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;