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"
22 #include "data-stream-file.hpp"
26 #define METADATA_TEXT_SIG "/* CTF 1.8"
35 static bt_param_validation_map_value_entry_descr metadataInfoQueryParamsDesc
[] = {
36 {"path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
37 bt_param_validation_value_descr::makeString()},
38 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
40 bt2::Value::Shared
metadata_info_query(const bt2::ConstMapValue params
, const bt2c::Logger
& logger
)
42 gchar
*validateError
= nullptr;
43 const auto validationStatus
= bt_param_validation_validate(
44 params
.libObjPtr(), metadataInfoQueryParamsDesc
, &validateError
);
46 if (validationStatus
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
47 throw bt2::MemoryError
{};
48 } else if (validationStatus
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
49 const bt2c::GCharUP deleter
{validateError
};
51 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "{}", validateError
);
54 const auto path
= params
["path"]->asString().value();
55 bt2c::FileUP metadataFp
{ctf_fs_metadata_open_file(path
, logger
)};
57 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
,
58 "Cannot open trace metadata: path=\"{}\".", path
);
63 int ret
= ctf_metadata_decoder_is_packetized(metadataFp
.get(), &is_packetized
, &bo
, logger
);
66 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
68 "Cannot check whether or not the metadata stream is packetized: path=\"{}\".", path
);
71 ctf_metadata_decoder_config decoder_cfg
{logger
};
72 decoder_cfg
.keep_plain_text
= true;
73 ctf_metadata_decoder_up decoder
= ctf_metadata_decoder_create(&decoder_cfg
);
75 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
76 logger
, bt2::Error
, "Cannot create metadata decoder: path=\"{}}\".", path
);
79 rewind(metadataFp
.get());
80 ctf_metadata_decoder_status decoder_status
=
81 ctf_metadata_decoder_append_content(decoder
.get(), metadataFp
.get());
83 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
84 logger
, bt2::Error
, "Cannot update metadata decoder's content: path=\"{}\".", path
);
87 const char *plain_text
= ctf_metadata_decoder_get_text(decoder
.get());
88 std::string metadata_text
;
90 if (strncmp(plain_text
, METADATA_TEXT_SIG
, sizeof(METADATA_TEXT_SIG
) - 1) != 0) {
91 metadata_text
= METADATA_TEXT_SIG
;
92 metadata_text
+= " */\n\n";
95 metadata_text
+= plain_text
;
97 const auto result
= bt2::MapValue::create();
98 result
->insert("text", metadata_text
);
99 result
->insert("is-packetized", is_packetized
);
104 static void add_range(const bt2::MapValue info
, struct range
*range
, const char *range_name
)
111 const auto rangeMap
= info
.insertEmptyMap(range_name
);
112 rangeMap
.insert("begin", range
->begin_ns
);
113 rangeMap
.insert("end", range
->end_ns
);
116 static void populate_stream_info(struct ctf_fs_ds_file_group
*group
, const bt2::MapValue groupInfo
,
117 struct range
*stream_range
, const bt2c::Logger
& logger
)
120 * Since each `struct ctf_fs_ds_file_group` has a sorted array of
121 * `struct ctf_fs_ds_index_entry`, we can compute the stream range from
122 * the timestamp_begin of the first index entry and the timestamp_end
123 * of the last index entry.
125 BT_ASSERT(group
->index
);
126 BT_ASSERT(group
->index
->entries
);
127 BT_ASSERT(group
->index
->entries
->len
> 0);
130 ctf_fs_ds_index_entry
*first_ds_index_entry
=
131 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(group
->index
->entries
, 0);
134 ctf_fs_ds_index_entry
*last_ds_index_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(
135 group
->index
->entries
, group
->index
->entries
->len
- 1);
137 stream_range
->begin_ns
= first_ds_index_entry
->timestamp_begin_ns
;
138 stream_range
->end_ns
= last_ds_index_entry
->timestamp_end_ns
;
141 * If any of the begin and end timestamps is not set it means that
142 * packets don't include `timestamp_begin` _and_ `timestamp_end` fields
143 * in their packet context so we can't set the range.
146 stream_range
->begin_ns
!= UINT64_C(-1) && stream_range
->end_ns
!= UINT64_C(-1);
148 add_range(groupInfo
, stream_range
, "range-ns");
150 bt2c::GCharUP portName
= ctf_fs_make_port_name(group
);
152 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "Failed to make port name");
155 groupInfo
.insert("port-name", portName
.get());
158 static void populate_trace_info(const struct ctf_fs_trace
*trace
, const bt2::MapValue traceInfo
,
159 const bt2c::Logger
& logger
)
161 BT_ASSERT(trace
->ds_file_groups
);
162 /* Add trace range info only if it contains streams. */
163 if (trace
->ds_file_groups
->len
== 0) {
164 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
165 logger
, bt2::Error
, "Trace has no streams: trace-path={}", trace
->path
->str
);
168 const auto fileGroups
= traceInfo
.insertEmptyArray("stream-infos");
170 /* Find range of all stream groups, and of the trace. */
171 for (size_t group_idx
= 0; group_idx
< trace
->ds_file_groups
->len
; group_idx
++) {
173 ctf_fs_ds_file_group
*group
=
174 (ctf_fs_ds_file_group
*) g_ptr_array_index(trace
->ds_file_groups
, group_idx
);
176 const auto groupInfo
= fileGroups
.appendEmptyMap();
177 populate_stream_info(group
, groupInfo
, &group_range
, logger
);
181 bt2::Value::Shared
trace_infos_query(const bt2::ConstMapValue params
, const bt2c::Logger
& logger
)
183 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(logger
);
185 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
,
186 "Cannot create ctf_fs_component");
189 const bt_value
*inputs_value
= NULL
;
190 const bt_value
*trace_name_value
;
192 if (!read_src_fs_parameters(params
.libObjPtr(), &inputs_value
, &trace_name_value
,
194 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "Failed to read parameters");
197 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
, NULL
)) {
198 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "Failed to create trace");
201 const auto result
= bt2::ArrayValue::create();
202 const auto traceInfo
= result
->appendEmptyMap();
203 populate_trace_info(ctf_fs
->trace
.get(), traceInfo
, logger
);
208 static bt_param_validation_map_value_entry_descr supportInfoQueryParamsDesc
[] = {
209 {"type", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
210 bt_param_validation_value_descr::makeString()},
211 {"input", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
212 bt_param_validation_value_descr::makeString()},
213 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
215 bt2::Value::Shared
support_info_query(const bt2::ConstMapValue params
, const bt2c::Logger
& logger
)
217 gchar
*validateError
= NULL
;
218 const auto validationStatus
= bt_param_validation_validate(
219 params
.libObjPtr(), supportInfoQueryParamsDesc
, &validateError
);
221 if (validationStatus
== BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
) {
222 throw bt2::MemoryError
{};
223 } else if (validationStatus
== BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
) {
224 const bt2c::GCharUP deleter
{validateError
};
226 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "{}", validateError
);
229 const auto type
= params
["type"]->asString().value();
231 if (strcmp(type
, "directory") != 0) {
233 * The input type is not a directory so we are 100% sure it's not a CTF
234 * 1.8 trace as it would need a directory with at least 1 metadata file
235 * and 1 data stream file.
237 const auto result
= bt2::MapValue::create();
238 result
->insert("weight", 0.0f
);
242 const auto input
= params
["input"]->asString().value();
244 bt2c::GCharUP metadataPath
{g_build_filename(input
, CTF_FS_METADATA_FILENAME
, NULL
)};
246 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
, "Failed to read parameters");
250 char uuid_str
[BT_UUID_STR_LEN
+ 1];
251 bool has_uuid
= false;
252 bt2c::FileUP metadataFile
{g_fopen(metadataPath
.get(), "rb")};
254 enum ctf_metadata_decoder_status decoder_status
;
257 ctf_metadata_decoder_config metadata_decoder_config
{logger
};
259 ctf_metadata_decoder_up metadata_decoder
=
260 ctf_metadata_decoder_create(&metadata_decoder_config
);
261 if (!metadata_decoder
) {
262 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger
, bt2::Error
,
263 "Failed to create metadata decoder");
267 ctf_metadata_decoder_append_content(metadata_decoder
.get(), metadataFile
.get());
268 if (decoder_status
!= CTF_METADATA_DECODER_STATUS_OK
) {
269 BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
270 logger
, bt2::Error
, "Failed to append metadata content: metadata-decoder-status={}",
275 * We were able to parse the metadata file, so we are
276 * confident it's a CTF trace.
280 /* If the trace has a UUID, return the stringified UUID as the group. */
281 if (ctf_metadata_decoder_get_trace_class_uuid(metadata_decoder
.get(), uuid
) == 0) {
282 bt_uuid_to_str(uuid
, uuid_str
);
287 const auto result
= bt2::MapValue::create();
288 result
->insert("weight", weight
);
290 /* We are not supposed to have weight == 0 and a UUID. */
291 BT_ASSERT(weight
> 0 || !has_uuid
);
293 if (weight
> 0 && has_uuid
) {
294 result
->insert("group", uuid_str
);