2 * Copyright 2018 - Philippe Proulx <pproulx@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
15 #define BT_COMP_LOG_SELF_COMP (log_cfg->self_comp)
16 #define BT_LOG_OUTPUT_LEVEL (log_cfg->log_level)
17 #define BT_LOG_TAG "PLUGIN/CTF/META/WARN-MEANINGLESS-HEADER-FIELDS"
18 #include "logging/comp-logging.h"
20 #include <babeltrace2/babeltrace.h>
21 #include "common/macros.h"
22 #include "common/assert.h"
28 #include "ctf-meta-visitors.h"
32 void warn_meaningless_field(const char *name
, const char *scope_name
,
33 struct meta_log_config
*log_cfg
)
36 BT_COMP_LOGW("User field found in %s: ignoring: name=\"%s\"",
41 void warn_meaningless_fields(struct ctf_field_class
*fc
, const char *name
,
42 const char *scope_name
, struct meta_log_config
*log_cfg
)
51 * 'name' is guaranteed to be non-NULL whenever the field class is not a
52 * structure. In the case of a structure field class, its members' names
56 case CTF_FIELD_CLASS_TYPE_FLOAT
:
57 case CTF_FIELD_CLASS_TYPE_STRING
:
58 warn_meaningless_field(name
, scope_name
, log_cfg
);
60 case CTF_FIELD_CLASS_TYPE_INT
:
61 case CTF_FIELD_CLASS_TYPE_ENUM
:
63 struct ctf_field_class_int
*int_fc
= (void *) fc
;
65 if (int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
&&
66 !int_fc
->mapped_clock_class
) {
67 warn_meaningless_field(name
, scope_name
, log_cfg
);
72 case CTF_FIELD_CLASS_TYPE_STRUCT
:
74 struct ctf_field_class_struct
*struct_fc
= (void *) fc
;
76 for (i
= 0; i
< struct_fc
->members
->len
; i
++) {
77 struct ctf_named_field_class
*named_fc
=
78 ctf_field_class_struct_borrow_member_by_index(
81 warn_meaningless_fields(named_fc
->fc
,
82 named_fc
->name
->str
, scope_name
, log_cfg
);
87 case CTF_FIELD_CLASS_TYPE_VARIANT
:
89 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
91 for (i
= 0; i
< var_fc
->options
->len
; i
++) {
92 struct ctf_named_field_class
*named_fc
=
93 ctf_field_class_variant_borrow_option_by_index(
96 warn_meaningless_fields(named_fc
->fc
,
97 named_fc
->name
->str
, scope_name
, log_cfg
);
102 case CTF_FIELD_CLASS_TYPE_ARRAY
:
104 struct ctf_field_class_array
*array_fc
= (void *) fc
;
106 if (array_fc
->meaning
!= CTF_FIELD_CLASS_MEANING_NONE
) {
112 case CTF_FIELD_CLASS_TYPE_SEQUENCE
:
114 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
116 warn_meaningless_fields(array_fc
->elem_fc
, name
, scope_name
,
129 void ctf_trace_class_warn_meaningless_header_fields(
130 struct ctf_trace_class
*ctf_tc
,
131 struct meta_log_config
*log_cfg
)
135 if (!ctf_tc
->is_translated
) {
136 warn_meaningless_fields(
137 ctf_tc
->packet_header_fc
, NULL
, "packet header",
141 for (i
= 0; i
< ctf_tc
->stream_classes
->len
; i
++) {
142 struct ctf_stream_class
*sc
= ctf_tc
->stream_classes
->pdata
[i
];
144 if (!sc
->is_translated
) {
145 warn_meaningless_fields(sc
->event_header_fc
, NULL
,
146 "event header", log_cfg
);