*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
-#define _GNU_SOURCE
-#include <config.h>
#include <babeltrace/babeltrace.h>
#include <babeltrace/format.h>
#include <babeltrace/context.h>
+#include <babeltrace/context-internal.h>
#include <babeltrace/ctf/types.h>
#include <babeltrace/ctf/events.h>
/* TODO: fix object model for format-agnostic callbacks */
#include <babeltrace/ctf-ir/metadata.h> /* for clocks */
+#define PARTIAL_ERROR_SLEEP 3 /* 3 seconds */
+
#define DEFAULT_FILE_ARRAY_SIZE 1
+
+#define NET_URL_PREFIX "net://"
+#define NET4_URL_PREFIX "net4://"
+#define NET6_URL_PREFIX "net6://"
+
static char *opt_input_format, *opt_output_format;
-/* Pointer into const argv */
-static const char *opt_input_format_arg, *opt_output_format_arg;
-static const char *opt_input_path;
-static const char *opt_output_path;
+/*
+ * We are not freeing opt_input_paths ipath elements when exiting from
+ * main() for backward compatibility with libpop 0.13, which does not
+ * allocate copies for arguments returned by poptGetArg(), and for
+ * general compatibility with the documented behavior. This is known to
+ * cause a small memory leak with libpop 0.16.
+ */
+static GPtrArray *opt_input_paths;
+static char *opt_output_path;
-static struct format *fmt_read;
+static struct bt_format *fmt_read;
static
void strlower(char *str)
enum {
OPT_NONE = 0,
+ OPT_OUTPUT_PATH,
+ OPT_INPUT_FORMAT,
+ OPT_OUTPUT_FORMAT,
OPT_HELP,
OPT_LIST,
OPT_VERBOSE,
OPT_FIELDS,
OPT_NO_DELTA,
OPT_CLOCK_OFFSET,
+ OPT_CLOCK_OFFSET_NS,
OPT_CLOCK_CYCLES,
OPT_CLOCK_SECONDS,
OPT_CLOCK_DATE,
OPT_CLOCK_FORCE_CORRELATE,
};
+/*
+ * We are _not_ using POPT_ARG_STRING ability to store directly into
+ * variables, because we want to cast the return to non-const, which is
+ * not possible without using poptGetOptArg explicitly. This helps us
+ * controlling memory allocation correctly without making assumptions
+ * about undocumented behaviors. poptGetOptArg is documented as
+ * requiring the returned const char * to be freed by the caller.
+ */
static struct poptOption long_options[] = {
/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
- { "input-format", 'i', POPT_ARG_STRING, &opt_input_format_arg, OPT_NONE, NULL, NULL },
- { "output-format", 'o', POPT_ARG_STRING, &opt_output_format_arg, OPT_NONE, NULL, NULL },
+ { "output", 'w', POPT_ARG_STRING, NULL, OPT_OUTPUT_PATH, NULL, NULL },
+ { "input-format", 'i', POPT_ARG_STRING, NULL, OPT_INPUT_FORMAT, NULL, NULL },
+ { "output-format", 'o', POPT_ARG_STRING, NULL, OPT_OUTPUT_FORMAT, NULL, NULL },
{ "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
{ "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
{ "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
{ "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL },
{ "no-delta", 0, POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL },
{ "clock-offset", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL },
+ { "clock-offset-ns", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET_NS, NULL, NULL },
{ "clock-cycles", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_CYCLES, NULL, NULL },
{ "clock-seconds", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL },
{ "clock-date", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL },
static void usage(FILE *fp)
{
fprintf(fp, "BabelTrace Trace Viewer and Converter %s\n\n", VERSION);
- fprintf(fp, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
+ fprintf(fp, "usage : babeltrace [OPTIONS] FILE...\n");
fprintf(fp, "\n");
- fprintf(fp, " INPUT Input trace path\n");
- fprintf(fp, " OUTPUT Output trace path (default: stdout)\n");
+ fprintf(fp, " FILE Input trace file(s) and/or directory(ies)\n");
+ fprintf(fp, " (space-separated)\n");
+ fprintf(fp, " -w, --output OUTPUT Output trace path (default: stdout)\n");
fprintf(fp, "\n");
fprintf(fp, " -i, --input-format FORMAT Input trace format (default: ctf)\n");
fprintf(fp, " -o, --output-format FORMAT Output trace format (default: text)\n");
fprintf(fp, " none, all, scope, header, (context OR ctx)\n");
fprintf(fp, " (default: payload,context)\n");
fprintf(fp, " -f, --fields name1<,name2,...> Print additional fields:\n");
- fprintf(fp, " all, trace, trace:domain, trace:procname,\n");
- fprintf(fp, " trace:vpid, loglevel.\n");
+ fprintf(fp, " all, trace, trace:hostname, trace:domain,\n");
+ fprintf(fp, " trace:procname, trace:vpid, loglevel, emf, callsite.\n");
+ fprintf(fp, " (default: trace:hostname,trace:procname,trace:vpid)\n");
fprintf(fp, " --clock-cycles Timestamp in cycles\n");
fprintf(fp, " --clock-offset seconds Clock offset in seconds\n");
+ fprintf(fp, " --clock-offset-ns ns Clock offset in nanoseconds\n");
fprintf(fp, " --clock-seconds Print the timestamps as [sec.ns]\n");
fprintf(fp, " (default is: [hh:mm:ss.ns])\n");
fprintf(fp, " --clock-date Print clock date\n");
static int get_names_args(poptContext *pc)
{
char *str, *strlist, *strctx;
+ int ret = 0;
opt_payload_field_names = 0;
opt_context_field_names = 0;
opt_payload_field_names = 0;
} else {
fprintf(stderr, "[error] unknown field name type %s\n", str);
- return -EINVAL;
+ ret = -EINVAL;
+ goto end;
}
} while ((str = strtok_r(NULL, ",", &strctx)));
- return 0;
+end:
+ free(strlist);
+ return ret;
}
static int get_fields_args(poptContext *pc)
{
char *str, *strlist, *strctx;
+ int ret = 0;
strlist = (char *) poptGetOptArg(*pc);
if (!strlist) {
}
str = strtok_r(strlist, ",", &strctx);
do {
+ opt_trace_default_fields = 0;
if (!strcmp(str, "all"))
opt_all_fields = 1;
else if (!strcmp(str, "trace"))
opt_trace_field = 1;
+ else if (!strcmp(str, "trace:hostname"))
+ opt_trace_hostname_field = 1;
else if (!strcmp(str, "trace:domain"))
opt_trace_domain_field = 1;
else if (!strcmp(str, "trace:procname"))
opt_trace_vpid_field = 1;
else if (!strcmp(str, "loglevel"))
opt_loglevel_field = 1;
+ else if (!strcmp(str, "emf"))
+ opt_emf_field = 1;
+ else if (!strcmp(str, "callsite"))
+ opt_callsite_field = 1;
else {
fprintf(stderr, "[error] unknown field type %s\n", str);
- return -EINVAL;
+ ret = -EINVAL;
+ goto end;
}
} while ((str = strtok_r(NULL, ",", &strctx)));
- return 0;
+end:
+ free(strlist);
+ return ret;
}
/*
{
poptContext pc;
int opt, ret = 0;
+ const char *ipath;
if (argc == 1) {
usage(stdout);
while ((opt = poptGetNextOpt(pc)) != -1) {
switch (opt) {
+ case OPT_OUTPUT_PATH:
+ opt_output_path = (char *) poptGetOptArg(pc);
+ if (!opt_output_path) {
+ ret = -EINVAL;
+ goto end;
+ }
+ break;
+ case OPT_INPUT_FORMAT:
+ opt_input_format = (char *) poptGetOptArg(pc);
+ if (!opt_input_format) {
+ ret = -EINVAL;
+ goto end;
+ }
+ break;
+ case OPT_OUTPUT_FORMAT:
+ opt_output_format = (char *) poptGetOptArg(pc);
+ if (!opt_output_format) {
+ ret = -EINVAL;
+ goto end;
+ }
+ break;
case OPT_HELP:
usage(stdout);
ret = 1; /* exit cleanly */
break;
case OPT_CLOCK_OFFSET:
{
- const char *str;
+ char *str;
char *endptr;
- str = poptGetOptArg(pc);
+ str = (char *) poptGetOptArg(pc);
if (!str) {
fprintf(stderr, "[error] Missing --clock-offset argument\n");
ret = -EINVAL;
if (*endptr != '\0' || str == endptr || errno != 0) {
fprintf(stderr, "[error] Incorrect --clock-offset argument: %s\n", str);
ret = -EINVAL;
+ free(str);
goto end;
}
+ free(str);
break;
}
case OPT_CLOCK_SECONDS:
opt_clock_seconds = 1;
break;
+ case OPT_CLOCK_OFFSET_NS:
+ {
+ char *str;
+ char *endptr;
+
+ str = (char *) poptGetOptArg(pc);
+ if (!str) {
+ fprintf(stderr, "[error] Missing --clock-offset-ns argument\n");
+ ret = -EINVAL;
+ goto end;
+ }
+ errno = 0;
+ opt_clock_offset_ns = strtoull(str, &endptr, 0);
+ if (*endptr != '\0' || str == endptr || errno != 0) {
+ fprintf(stderr, "[error] Incorrect --clock-offset-ns argument: %s\n", str);
+ ret = -EINVAL;
+ free(str);
+ goto end;
+ }
+ free(str);
+ break;
+ }
+
case OPT_CLOCK_DATE:
opt_clock_date = 1;
break;
}
}
- opt_input_path = poptGetArg(pc);
- if (!opt_input_path) {
+ do {
+ ipath = poptGetArg(pc);
+ if (ipath)
+ g_ptr_array_add(opt_input_paths, (gpointer) ipath);
+ } while (ipath);
+ if (opt_input_paths->len == 0) {
ret = -EINVAL;
goto end;
}
- opt_output_path = poptGetArg(pc);
end:
if (pc) {
/* No meta data, just return */
return 0;
} else {
+ int err_close = 0;
+
closeret = close(metafd);
if (closeret < 0) {
perror("close");
- return -1; /* failure */
+ err_close = 1;
}
closeret = close(dirfd);
if (closeret < 0) {
perror("close");
- return -1; /* failure */
+ err_close = 1;
+ }
+ if (err_close) {
+ return -1;
}
/* Add path to the global list */
return 0;
}
+
/*
* bt_context_add_traces_recursive: Open a trace recursively
*
*/
int bt_context_add_traces_recursive(struct bt_context *ctx, const char *path,
const char *format_str,
- void (*packet_seek)(struct stream_pos *pos,
+ void (*packet_seek)(struct bt_stream_pos *pos,
size_t offset, int whence))
{
-
- GArray *trace_ids;
- int ret = 0;
- int i;
-
+ int ret = 0, trace_ids = 0;
+
+ if ((strncmp(path, NET4_URL_PREFIX, sizeof(NET4_URL_PREFIX) - 1)) == 0 ||
+ (strncmp(path, NET6_URL_PREFIX, sizeof(NET6_URL_PREFIX) - 1)) == 0 ||
+ (strncmp(path, NET_URL_PREFIX, sizeof(NET_URL_PREFIX) - 1)) == 0) {
+ ret = bt_context_add_trace(ctx,
+ path, format_str, packet_seek, NULL, NULL);
+ if (ret < 0) {
+ fprintf(stderr, "[warning] [Context] cannot open trace \"%s\" "
+ "for reading.\n", path);
+ }
+ return ret;
+ }
/* Should lock traversed_paths mutex here if used in multithread */
traversed_paths = g_ptr_array_new();
- trace_ids = g_array_new(FALSE, TRUE, sizeof(int));
-
ret = nftw(path, traverse_trace_dir, 10, 0);
/* Process the array if ntfw did not return a fatal error */
if (ret >= 0) {
+ int i;
+
for (i = 0; i < traversed_paths->len; i++) {
GString *trace_path = g_ptr_array_index(traversed_paths,
i);
/* Allow to skip erroneous traces. */
ret = 1; /* partial error */
} else {
- g_array_append_val(trace_ids, trace_id);
+ trace_ids++;
}
g_string_free(trace_path, TRUE);
}
}
+
g_ptr_array_free(traversed_paths, TRUE);
traversed_paths = NULL;
/*
* Return an error if no trace can be opened.
*/
- if (trace_ids->len == 0) {
+ if (trace_ids == 0) {
fprintf(stderr, "[error] Cannot open any trace for reading.\n\n");
ret = -ENOENT; /* failure */
}
- g_array_free(trace_ids, TRUE);
return ret;
}
-int convert_trace(struct trace_descriptor *td_write,
+static
+int trace_pre_handler(struct bt_trace_descriptor *td_write,
+ struct bt_context *ctx)
+{
+ struct ctf_text_stream_pos *sout;
+ struct trace_collection *tc;
+ int ret, i;
+
+ sout = container_of(td_write, struct ctf_text_stream_pos,
+ trace_descriptor);
+
+ if (!sout->parent.pre_trace_cb)
+ return 0;
+
+ tc = ctx->tc;
+ for (i = 0; i < tc->array->len; i++) {
+ struct bt_trace_descriptor *td =
+ g_ptr_array_index(tc->array, i);
+
+ ret = sout->parent.pre_trace_cb(&sout->parent, td);
+ if (ret) {
+ fprintf(stderr, "[error] Writing to trace pre handler failed.\n");
+ goto end;
+ }
+ }
+ ret = 0;
+end:
+ return ret;
+}
+
+static
+int trace_post_handler(struct bt_trace_descriptor *td_write,
+ struct bt_context *ctx)
+{
+ struct ctf_text_stream_pos *sout;
+ struct trace_collection *tc;
+ int ret, i;
+
+ sout = container_of(td_write, struct ctf_text_stream_pos,
+ trace_descriptor);
+
+ if (!sout->parent.post_trace_cb)
+ return 0;
+
+ tc = ctx->tc;
+ for (i = 0; i < tc->array->len; i++) {
+ struct bt_trace_descriptor *td =
+ g_ptr_array_index(tc->array, i);
+
+ ret = sout->parent.post_trace_cb(&sout->parent, td);
+ if (ret) {
+ fprintf(stderr, "[error] Writing to trace post handler failed.\n");
+ goto end;
+ }
+ }
+ ret = 0;
+end:
+ return ret;
+}
+
+static
+int convert_trace(struct bt_trace_descriptor *td_write,
struct bt_context *ctx)
{
struct bt_ctf_iter *iter;
sout = container_of(td_write, struct ctf_text_stream_pos,
trace_descriptor);
+ if (!sout->parent.event_cb)
+ return 0;
+
begin_pos.type = BT_SEEK_BEGIN;
iter = bt_ctf_iter_create(ctx, &begin_pos, NULL);
if (!iter) {
int main(int argc, char **argv)
{
- int ret, partial_error = 0;
- struct format *fmt_write;
- struct trace_descriptor *td_write;
+ int ret, partial_error = 0, open_success = 0;
+ struct bt_format *fmt_write;
+ struct bt_trace_descriptor *td_write;
struct bt_context *ctx;
+ int i;
+
+ opt_input_paths = g_ptr_array_new();
ret = parse_options(argc, argv);
if (ret < 0) {
fprintf(stderr, "Error parsing options.\n\n");
usage(stderr);
+ g_ptr_array_free(opt_input_paths, TRUE);
exit(EXIT_FAILURE);
} else if (ret > 0) {
+ g_ptr_array_free(opt_input_paths, TRUE);
exit(EXIT_SUCCESS);
}
printf_verbose("Verbose mode active.\n");
printf_debug("Debug mode active.\n");
- if (opt_input_format_arg) {
- opt_input_format = strdup(opt_input_format_arg);
- if (!opt_input_format) {
- partial_error = 1;
- goto end;
- }
+ if (opt_input_format)
strlower(opt_input_format);
- }
- if (opt_output_format_arg) {
- opt_output_format = strdup(opt_output_format_arg);
- if (!opt_output_format) {
- partial_error = 1;
- goto end;
- }
+ if (opt_output_format)
strlower(opt_output_format);
- }
- printf_verbose("Converting from directory: %s\n", opt_input_path);
+ printf_verbose("Converting from directory(ies):\n");
+ for (i = 0; i < opt_input_paths->len; i++) {
+ const char *ipath = g_ptr_array_index(opt_input_paths, i);
+ printf_verbose(" %s\n", ipath);
+ }
printf_verbose("Converting from format: %s\n",
opt_input_format ? : "ctf <default>");
- printf_verbose("Converting to directory: %s\n",
+ printf_verbose("Converting to target: %s\n",
opt_output_path ? : "<stdout>");
printf_verbose("Converting to format: %s\n",
opt_output_format ? : "text <default>");
}
ctx = bt_context_create();
+ if (!ctx) {
+ goto error_td_read;
+ }
- ret = bt_context_add_traces_recursive(ctx, opt_input_path,
- opt_input_format, NULL);
- if (ret < 0) {
- fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n",
- opt_input_path);
+ for (i = 0; i < opt_input_paths->len; i++) {
+ const char *ipath = g_ptr_array_index(opt_input_paths, i);
+ ret = bt_context_add_traces_recursive(ctx, ipath,
+ opt_input_format, NULL);
+ if (ret < 0) {
+ fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n",
+ ipath);
+ } else if (ret > 0) {
+ fprintf(stderr, "[warning] errors occurred when opening trace \"%s\" for reading, continuing anyway.\n\n",
+ ipath);
+ open_success = 1; /* some traces were OK */
+ partial_error = 1;
+ } else {
+ open_success = 1; /* all traces were OK */
+ }
+ }
+ if (!open_success) {
+ fprintf(stderr, "[error] none of the specified trace paths could be opened.\n\n");
goto error_td_read;
- } else if (ret > 0) {
- fprintf(stderr, "[warning] errors occurred when opening trace \"%s\" for reading, continuing anyway.\n\n",
- opt_input_path);
- partial_error = 1;
}
td_write = fmt_write->open_trace(opt_output_path, O_RDWR, NULL, NULL);
goto error_td_write;
}
- ret = convert_trace(td_write, ctx);
+ /*
+ * Errors happened when opening traces, but we continue anyway.
+ * sleep to let user see the stderr output before stdout.
+ */
+ if (partial_error)
+ sleep(PARTIAL_ERROR_SLEEP);
+
+ ret = trace_pre_handler(td_write, ctx);
+ if (ret) {
+ fprintf(stderr, "Error in trace pre handle.\n\n");
+ goto error_copy_trace;
+ }
+
+ /* For now, we support only CTF iterators */
+ if (fmt_read->name == g_quark_from_static_string("ctf")) {
+ ret = convert_trace(td_write, ctx);
+ if (ret) {
+ fprintf(stderr, "Error printing trace.\n\n");
+ goto error_copy_trace;
+ }
+ }
+
+ ret = trace_post_handler(td_write, ctx);
if (ret) {
- fprintf(stderr, "Error printing trace.\n\n");
+ fprintf(stderr, "Error in trace post handle.\n\n");
goto error_copy_trace;
}
end:
free(opt_input_format);
free(opt_output_format);
+ free(opt_output_path);
+ g_ptr_array_free(opt_input_paths, TRUE);
if (partial_error)
exit(EXIT_FAILURE);
else