2 * SPDX-License-Identifier: MIT
4 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Babeltrace CTF file system Reader Component queries
10 #include <glib/gstdio.h>
11 #include <sys/types.h>
13 #include <babeltrace2/babeltrace.h>
15 #include "cpp-common/bt2/exc.hpp"
16 #include "cpp-common/bt2c/glib-up.hpp"
17 #include "cpp-common/bt2c/libc-up.hpp"
19 #include "plugins/common/param-validation/param-validation.h"
21 #include "../common/src/metadata/tsdl/decoder.hpp"
25 #define METADATA_TEXT_SIG "/* CTF 1.8"
34 static bt_param_validation_map_value_entry_descr metadataInfoQueryParamsDesc
[] = {
35 {"path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
36 bt_param_validation_value_descr::makeString()},
37 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
39 bt2::Value::Shared
metadata_info_query(const bt2::ConstMapValue params
, const bt2c::Logger
& logger
)
41 gchar
*validateError
= nullptr;
42 const auto validationStatus
= bt_param_validation_validate(
43 params
.libObjPtr(), metadataInfoQueryParamsDesc
, &validateError
);
45 if (validationStatus
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
46 throw bt2::MemoryError
{};
47 } else if (validationStatus
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
48 const bt2c::GCharUP deleter
{validateError
};
50 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "{}", validateError
);
53 const auto path
= params
["path"]->asString().value();
54 bt2c::FileUP metadataFp
{ctf_fs_metadata_open_file(path
, logger
)};
56 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
,
57 "Cannot open trace metadata: path=\"{}\".", path
);
62 int ret
= ctf_metadata_decoder_is_packetized(metadataFp
.get(), &is_packetized
, &bo
, logger
);
65 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
67 "Cannot check whether or not the metadata stream is packetized: path=\"{}\".", path
);
70 ctf_metadata_decoder_config decoder_cfg
{logger
};
71 decoder_cfg
.keep_plain_text
= true;
72 ctf_metadata_decoder_up decoder
= ctf_metadata_decoder_create(&decoder_cfg
);
74 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
75 logger
, bt2::Error
, "Cannot create metadata decoder: path=\"{}}\".", path
);
78 rewind(metadataFp
.get());
79 ctf_metadata_decoder_status decoder_status
=
80 ctf_metadata_decoder_append_content(decoder
.get(), metadataFp
.get());
82 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
83 logger
, bt2::Error
, "Cannot update metadata decoder's content: path=\"{}\".", path
);
86 const char *plain_text
= ctf_metadata_decoder_get_text(decoder
.get());
87 std::string metadata_text
;
89 if (strncmp(plain_text
, METADATA_TEXT_SIG
, sizeof(METADATA_TEXT_SIG
) - 1) != 0) {
90 metadata_text
= METADATA_TEXT_SIG
;
91 metadata_text
+= " */\n\n";
94 metadata_text
+= plain_text
;
96 const auto result
= bt2::MapValue::create();
97 result
->insert("text", metadata_text
);
98 result
->insert("is-packetized", is_packetized
);
103 static void add_range(const bt2::MapValue info
, struct range
*range
, const char *range_name
)
110 const auto rangeMap
= info
.insertEmptyMap(range_name
);
111 rangeMap
.insert("begin", range
->begin_ns
);
112 rangeMap
.insert("end", range
->end_ns
);
115 static void populate_stream_info(struct ctf_fs_ds_file_group
*group
, const bt2::MapValue groupInfo
,
116 struct range
*stream_range
, const bt2c::Logger
& logger
)
119 * Since each `struct ctf_fs_ds_file_group` has a sorted array of
120 * `struct ctf_fs_ds_index_entry`, we can compute the stream range from
121 * the timestamp_begin of the first index entry and the timestamp_end
122 * of the last index entry.
124 BT_ASSERT(group
->index
);
125 BT_ASSERT(group
->index
->entries
);
126 BT_ASSERT(group
->index
->entries
->len
> 0);
129 ctf_fs_ds_index_entry
*first_ds_index_entry
=
130 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(group
->index
->entries
, 0);
133 ctf_fs_ds_index_entry
*last_ds_index_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(
134 group
->index
->entries
, group
->index
->entries
->len
- 1);
136 stream_range
->begin_ns
= first_ds_index_entry
->timestamp_begin_ns
;
137 stream_range
->end_ns
= last_ds_index_entry
->timestamp_end_ns
;
140 * If any of the begin and end timestamps is not set it means that
141 * packets don't include `timestamp_begin` _and_ `timestamp_end` fields
142 * in their packet context so we can't set the range.
145 stream_range
->begin_ns
!= UINT64_C(-1) && stream_range
->end_ns
!= UINT64_C(-1);
147 add_range(groupInfo
, stream_range
, "range-ns");
149 bt2c::GCharUP portName
= ctf_fs_make_port_name(group
);
151 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "Failed to make port name");
154 groupInfo
.insert("port-name", portName
.get());
157 static void populate_trace_info(const struct ctf_fs_trace
*trace
, const bt2::MapValue traceInfo
,
158 const bt2c::Logger
& logger
)
160 BT_ASSERT(trace
->ds_file_groups
);
161 /* Add trace range info only if it contains streams. */
162 if (trace
->ds_file_groups
->len
== 0) {
163 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
164 logger
, bt2::Error
, "Trace has no streams: trace-path={}", trace
->path
->str
);
167 const auto fileGroups
= traceInfo
.insertEmptyArray("stream-infos");
169 /* Find range of all stream groups, and of the trace. */
170 for (size_t group_idx
= 0; group_idx
< trace
->ds_file_groups
->len
; group_idx
++) {
172 ctf_fs_ds_file_group
*group
=
173 (ctf_fs_ds_file_group
*) g_ptr_array_index(trace
->ds_file_groups
, group_idx
);
175 const auto groupInfo
= fileGroups
.appendEmptyMap();
176 populate_stream_info(group
, groupInfo
, &group_range
, logger
);
180 bt2::Value::Shared
trace_infos_query(const bt2::ConstMapValue params
, const bt2c::Logger
& logger
)
182 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(logger
);
184 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
,
185 "Cannot create ctf_fs_component");
188 const bt_value
*inputs_value
= NULL
;
189 const bt_value
*trace_name_value
;
191 if (!read_src_fs_parameters(params
.libObjPtr(), &inputs_value
, &trace_name_value
,
193 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "Failed to read parameters");
196 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
, NULL
)) {
197 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "Failed to create trace");
200 const auto result
= bt2::ArrayValue::create();
201 const auto traceInfo
= result
->appendEmptyMap();
202 populate_trace_info(ctf_fs
->trace
, traceInfo
, logger
);
207 static bt_param_validation_map_value_entry_descr supportInfoQueryParamsDesc
[] = {
208 {"type", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
209 bt_param_validation_value_descr::makeString()},
210 {"input", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
211 bt_param_validation_value_descr::makeString()},
212 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
214 bt2::Value::Shared
support_info_query(const bt2::ConstMapValue params
, const bt2c::Logger
& logger
)
216 gchar
*validateError
= NULL
;
217 const auto validationStatus
= bt_param_validation_validate(
218 params
.libObjPtr(), supportInfoQueryParamsDesc
, &validateError
);
220 if (validationStatus
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
221 throw bt2::MemoryError
{};
222 } else if (validationStatus
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
223 const bt2c::GCharUP deleter
{validateError
};
225 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "{}", validateError
);
228 const auto type
= params
["type"]->asString().value();
230 if (strcmp(type
, "directory") != 0) {
232 * The input type is not a directory so we are 100% sure it's not a CTF
233 * 1.8 trace as it would need a directory with at least 1 metadata file
234 * and 1 data stream file.
236 const auto result
= bt2::MapValue::create();
237 result
->insert("weight", 0.0f
);
241 const auto input
= params
["input"]->asString().value();
243 bt2c::GCharUP metadataPath
{g_build_filename(input
, CTF_FS_METADATA_FILENAME
, NULL
)};
245 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "Failed to read parameters");
249 char uuid_str
[BT_UUID_STR_LEN
+ 1];
250 bool has_uuid
= false;
251 bt2c::FileUP metadataFile
{g_fopen(metadataPath
.get(), "rb")};
253 enum ctf_metadata_decoder_status decoder_status
;
256 ctf_metadata_decoder_config metadata_decoder_config
{logger
};
258 ctf_metadata_decoder_up metadata_decoder
=
259 ctf_metadata_decoder_create(&metadata_decoder_config
);
260 if (!metadata_decoder
) {
261 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
,
262 "Failed to create metadata decoder");
266 ctf_metadata_decoder_append_content(metadata_decoder
.get(), metadataFile
.get());
267 if (decoder_status
!= CTF_METADATA_DECODER_STATUS_OK
) {
268 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
269 logger
, bt2::Error
, "Failed to append metadata content: metadata-decoder-status={}",
274 * We were able to parse the metadata file, so we are
275 * confident it's a CTF trace.
279 /* If the trace has a UUID, return the stringified UUID as the group. */
280 if (ctf_metadata_decoder_get_trace_class_uuid(metadata_decoder
.get(), uuid
) == 0) {
281 bt_uuid_to_str(uuid
, uuid_str
);
286 const auto result
= bt2::MapValue::create();
287 result
->insert("weight", weight
);
289 /* We are not supposed to have weight == 0 and a UUID. */
290 BT_ASSERT(weight
> 0 || !has_uuid
);
292 if (weight
> 0 && has_uuid
) {
293 result
->insert("group", uuid_str
);