2 * Copyright 2019 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.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 #define BT_LOG_OUTPUT_LEVEL (trace->log_level)
24 #define BT_LOG_TAG "PLUGIN/SINK.CTF.FS/TRACE"
25 #include "logging/log.h"
27 #include <babeltrace2/babeltrace.h>
31 #include "common/assert.h"
32 #include "ctfser/ctfser.h"
34 #include "translate-trace-ir-to-ctf-ir.h"
35 #include "translate-ctf-ir-to-tsdl.h"
37 #include "fs-sink-trace.h"
38 #include "fs-sink-stream.h"
41 * Sanitizes `path` so as to:
43 * * Replace `.` subdirectories with `_`.
44 * * Replace `..` subdirectories with `__`.
45 * * Remove trailing slashes.
48 GString
*sanitize_trace_path(const char *path
)
50 GString
*san_path
= g_string_new(NULL
);
51 const char *ch
= path
;
52 bool dir_start
= true;
60 /* Start of directory */
62 g_string_append_c(san_path
, *ch
);
71 g_string_append_c(san_path
, '_');
79 g_string_append(san_path
, "__");
93 /* Not a special character */
94 g_string_append_c(san_path
, *ch
);
99 /* Remove trailing slashes */
100 while (san_path
->len
> 0 &&
101 san_path
->str
[san_path
->len
- 1] == '/') {
102 /* Remove trailing slash */
103 g_string_set_size(san_path
, san_path
->len
- 1);
106 if (san_path
->len
== 0) {
107 /* Looks like there's nothing left: just use `trace` */
108 g_string_assign(san_path
, "trace");
115 * Find a path based on `path` that doesn't exist yet. First, try `path`
116 * itself, then try with incrementing suffixes.
120 GString
*make_unique_trace_path(const char *path
)
122 GString
*unique_path
;
123 unsigned int suffix
= 0;
125 unique_path
= g_string_new(path
);
127 while (g_file_test(unique_path
->str
, G_FILE_TEST_EXISTS
)) {
128 g_string_printf(unique_path
, "%s-%u", path
, suffix
);
136 * Validate that the input string `datetime` is an ISO8601-compliant string (the
137 * format used by LTTng in the metadata).
141 int lttng_validate_datetime(const struct fs_sink_trace
*trace
,
142 const char *datetime
)
148 * We are using g_time_val_from_iso8601, as the safer/more modern
149 * alternative, g_date_time_new_from_iso8601, is only available in
150 * glib >= 2.56, and this is sufficient for our use case of validating
153 if (!g_time_val_from_iso8601(datetime
, &tv
)) {
154 BT_LOGI("Couldn't parse datetime as ISO 8601: date=\"%s\"", datetime
);
165 int append_lttng_trace_path_ust_uid(const struct fs_sink_trace
*trace
,
166 GString
*path
, const bt_trace_class
*tc
)
171 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "tracer_buffering_id");
172 if (!v
|| !bt_value_is_signed_integer(v
)) {
173 BT_LOGI_STR("Couldn't get environment value: name=\"tracer_buffering_id\"");
177 g_string_append_printf(path
, G_DIR_SEPARATOR_S
"%" PRId64
,
178 bt_value_signed_integer_get(v
));
180 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "isa_length");
181 if (!v
|| !bt_value_is_signed_integer(v
)) {
182 BT_LOGI_STR("Couldn't get environment value: name=\"isa_length\"");
186 g_string_append_printf(path
, G_DIR_SEPARATOR_S
"%" PRIu64
"-bit",
187 bt_value_signed_integer_get(v
));
200 int append_lttng_trace_path_ust_pid(const struct fs_sink_trace
*trace
,
201 GString
*path
, const bt_trace_class
*tc
)
204 const char *datetime
;
207 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "procname");
208 if (!v
|| !bt_value_is_string(v
)) {
209 BT_LOGI_STR("Couldn't get environment value: name=\"procname\"");
213 g_string_append_printf(path
, G_DIR_SEPARATOR_S
"%s", bt_value_string_get(v
));
215 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "vpid");
216 if (!v
|| !bt_value_is_signed_integer(v
)) {
217 BT_LOGI_STR("Couldn't get environment value: name=\"vpid\"");
221 g_string_append_printf(path
, "-%" PRId64
, bt_value_signed_integer_get(v
));
223 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "vpid_datetime");
224 if (!v
|| !bt_value_is_string(v
)) {
225 BT_LOGI_STR("Couldn't get environment value: name=\"vpid_datetime\"");
229 datetime
= bt_value_string_get(v
);
231 if (lttng_validate_datetime(trace
, datetime
)) {
235 g_string_append_printf(path
, "-%s", datetime
);
248 * Try to build a trace path based on environment values put in the trace
249 * environment by the LTTng tracer, starting with version 2.11.
252 GString
*make_lttng_trace_path_rel(const struct fs_sink_trace
*trace
)
254 const bt_trace_class
*tc
;
256 const char *tracer_name
, *domain
, *datetime
;
257 int64_t tracer_major
, tracer_minor
;
260 path
= g_string_new(NULL
);
265 tc
= bt_trace_borrow_class_const(trace
->ir_trace
);
267 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "tracer_name");
268 if (!v
|| !bt_value_is_string(v
)) {
269 BT_LOGI_STR("Couldn't get environment value: name=\"tracer_name\"");
273 tracer_name
= bt_value_string_get(v
);
275 if (!g_str_equal(tracer_name
, "lttng-ust")
276 && !g_str_equal(tracer_name
, "lttng-modules")) {
277 BT_LOGI("Unrecognized tracer name: name=\"%s\"", tracer_name
);
281 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "tracer_major");
282 if (!v
|| !bt_value_is_signed_integer(v
)) {
283 BT_LOGI_STR("Couldn't get environment value: name=\"tracer_major\"");
287 tracer_major
= bt_value_signed_integer_get(v
);
289 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "tracer_minor");
290 if (!v
|| !bt_value_is_signed_integer(v
)) {
291 BT_LOGI_STR("Couldn't get environment value: name=\"tracer_minor\"");
295 tracer_minor
= bt_value_signed_integer_get(v
);
297 if (!(tracer_major
>= 3 || (tracer_major
== 2 && tracer_minor
>= 11))) {
298 BT_LOGI("Unsupported LTTng version for automatic trace path: major=%" PRId64
", minor=%" PRId64
,
299 tracer_major
, tracer_minor
);
303 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "hostname");
304 if (!v
|| !bt_value_is_string(v
)) {
305 BT_LOGI_STR("Couldn't get environment value: name=\"tracer_hostname\"");
309 g_string_assign(path
, bt_value_string_get(v
));
311 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "trace_name");
312 if (!v
|| !bt_value_is_string(v
)) {
313 BT_LOGI_STR("Couldn't get environment value: name=\"trace_name\"");
317 g_string_append_printf(path
, G_DIR_SEPARATOR_S
"%s", bt_value_string_get(v
));
319 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "trace_creation_datetime");
320 if (!v
|| !bt_value_is_string(v
)) {
321 BT_LOGI_STR("Couldn't get environment value: name=\"trace_creation_datetime\"");
325 datetime
= bt_value_string_get(v
);
327 if (lttng_validate_datetime(trace
, datetime
)) {
331 g_string_append_printf(path
, "-%s", datetime
);
333 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "domain");
334 if (!v
|| !bt_value_is_string(v
)) {
335 BT_LOGI_STR("Couldn't get environment value: name=\"domain\"");
339 domain
= bt_value_string_get(v
);
340 g_string_append_printf(path
, G_DIR_SEPARATOR_S
"%s", domain
);
342 if (g_str_equal(domain
, "ust")) {
343 const char *tracer_buffering_scheme
;
345 v
= bt_trace_class_borrow_environment_entry_value_by_name_const(tc
, "tracer_buffering_scheme");
346 if (!v
|| !bt_value_is_string(v
)) {
347 BT_LOGI_STR("Couldn't get environment value: name=\"tracer_buffering_scheme\"");
351 tracer_buffering_scheme
= bt_value_string_get(v
);
352 g_string_append_printf(path
, G_DIR_SEPARATOR_S
"%s", tracer_buffering_scheme
);
354 if (g_str_equal(tracer_buffering_scheme
, "uid")) {
355 if (append_lttng_trace_path_ust_uid(trace
, path
, tc
)) {
358 } else if (g_str_equal(tracer_buffering_scheme
, "pid")){
359 if (append_lttng_trace_path_ust_pid(trace
, path
, tc
)) {
363 /* Unknown buffering scheme. */
364 BT_LOGI("Unknown buffering scheme: tracer_buffering_scheme=\"%s\"", tracer_buffering_scheme
);
367 } else if (!g_str_equal(domain
, "kernel")) {
368 /* Unknown domain. */
369 BT_LOGI("Unknown domain: domain=\"%s\"", domain
);
377 g_string_free(path
, TRUE
);
385 /* Build the relative output path for `trace`. */
388 GString
*make_trace_path_rel(const struct fs_sink_trace
*trace
)
390 GString
*path
= NULL
;
392 if (trace
->fs_sink
->assume_single_trace
) {
393 /* Use output directory directly */
394 path
= g_string_new("");
398 /* First, try to build a path using environment fields written by LTTng. */
399 path
= make_lttng_trace_path_rel(trace
);
404 /* Otherwise, use the trace name, if available. */
405 const char *trace_name
= bt_trace_get_name(trace
->ir_trace
);
407 path
= g_string_new(trace_name
);
411 /* Otherwise, use "trace". */
412 path
= g_string_new("trace");
419 * Compute the trace output path for `trace`, rooted at `output_base_directory`.
423 GString
*make_trace_path(const struct fs_sink_trace
*trace
, const char *output_base_directory
)
425 GString
*rel_path
= NULL
;
426 GString
*rel_path_san
= NULL
;
427 GString
*full_path
= NULL
;
428 GString
*unique_full_path
= NULL
;
430 rel_path
= make_trace_path_rel(trace
);
435 rel_path_san
= sanitize_trace_path(rel_path
->str
);
440 full_path
= g_string_new(NULL
);
445 g_string_printf(full_path
, "%s" G_DIR_SEPARATOR_S
"%s",
446 output_base_directory
, rel_path_san
->str
);
448 unique_full_path
= make_unique_trace_path(full_path
->str
);
452 g_string_free(rel_path
, TRUE
);
456 g_string_free(rel_path_san
, TRUE
);
460 g_string_free(full_path
, TRUE
);
463 return unique_full_path
;
467 void fs_sink_trace_destroy(struct fs_sink_trace
*trace
)
469 GString
*tsdl
= NULL
;
477 if (trace
->ir_trace_destruction_listener_id
!= UINT64_C(-1)) {
479 * Remove the destruction listener, otherwise it could
480 * be called in the future, and its private data is this
481 * CTF FS sink trace object which won't exist anymore.
483 (void) bt_trace_remove_destruction_listener(trace
->ir_trace
,
484 trace
->ir_trace_destruction_listener_id
);
485 trace
->ir_trace_destruction_listener_id
= UINT64_C(-1);
488 if (trace
->streams
) {
489 g_hash_table_destroy(trace
->streams
);
490 trace
->streams
= NULL
;
493 tsdl
= g_string_new(NULL
);
495 translate_trace_class_ctf_ir_to_tsdl(trace
->tc
, tsdl
);
497 BT_ASSERT(trace
->metadata_path
);
498 fh
= fopen(trace
->metadata_path
->str
, "wb");
500 BT_LOGF_ERRNO("In trace destruction listener: "
501 "cannot open metadata file for writing: ",
502 ": path=\"%s\"", trace
->metadata_path
->str
);
506 len
= fwrite(tsdl
->str
, sizeof(*tsdl
->str
), tsdl
->len
, fh
);
507 if (len
!= tsdl
->len
) {
508 BT_LOGF_ERRNO("In trace destruction listener: "
509 "cannot write metadata file: ",
510 ": path=\"%s\"", trace
->metadata_path
->str
);
514 if (!trace
->fs_sink
->quiet
) {
515 printf("Created CTF trace `%s`.\n", trace
->path
->str
);
519 g_string_free(trace
->path
, TRUE
);
523 g_string_free(trace
->metadata_path
, TRUE
);
524 trace
->metadata_path
= NULL
;
526 fs_sink_ctf_trace_class_destroy(trace
->tc
);
532 int ret
= fclose(fh
);
535 BT_LOGW_ERRNO("In trace destruction listener: "
536 "cannot close metadata file: ",
537 ": path=\"%s\"", trace
->metadata_path
->str
);
542 g_string_free(tsdl
, TRUE
);
549 void ir_trace_destruction_listener(const bt_trace
*ir_trace
, void *data
)
551 struct fs_sink_trace
*trace
= data
;
554 * Prevent bt_trace_remove_destruction_listener() from being
555 * called in fs_sink_trace_destroy(), which is called by
556 * g_hash_table_remove() below.
558 trace
->ir_trace_destruction_listener_id
= UINT64_C(-1);
559 g_hash_table_remove(trace
->fs_sink
->traces
, ir_trace
);
563 struct fs_sink_trace
*fs_sink_trace_create(struct fs_sink_comp
*fs_sink
,
564 const bt_trace
*ir_trace
)
567 struct fs_sink_trace
*trace
= g_new0(struct fs_sink_trace
, 1);
568 bt_trace_status trace_status
;
574 trace
->log_level
= fs_sink
->log_level
;
575 trace
->fs_sink
= fs_sink
;
576 trace
->ir_trace
= ir_trace
;
577 trace
->ir_trace_destruction_listener_id
= UINT64_C(-1);
578 trace
->tc
= translate_trace_class_trace_ir_to_ctf_ir(
579 bt_trace_borrow_class_const(ir_trace
),
585 trace
->path
= make_trace_path(trace
, fs_sink
->output_dir_path
->str
);
586 BT_ASSERT(trace
->path
);
587 ret
= g_mkdir_with_parents(trace
->path
->str
, 0755);
589 BT_LOGE_ERRNO("Cannot create directories for trace directory",
590 ": path=\"%s\"", trace
->path
->str
);
594 trace
->metadata_path
= g_string_new(trace
->path
->str
);
595 BT_ASSERT(trace
->metadata_path
);
596 g_string_append(trace
->metadata_path
, "/metadata");
597 trace
->streams
= g_hash_table_new_full(g_direct_hash
, g_direct_equal
,
598 NULL
, (GDestroyNotify
) fs_sink_stream_destroy
);
599 BT_ASSERT(trace
->streams
);
600 trace_status
= bt_trace_add_destruction_listener(ir_trace
,
601 ir_trace_destruction_listener
, trace
,
602 &trace
->ir_trace_destruction_listener_id
);
607 g_hash_table_insert(fs_sink
->traces
, (gpointer
) ir_trace
, trace
);
611 fs_sink_trace_destroy(trace
);