4 * Babeltrace Trace Converter
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
21 #define _XOPEN_SOURCE 700
23 #include <babeltrace/babeltrace-internal.h>
24 #include <babeltrace/format.h>
30 #include <sys/types.h>
36 #define DEFAULT_FILE_ARRAY_SIZE 1
37 static char *opt_input_format
;
38 static char *opt_output_format
;
40 static const char *opt_input_path
;
41 static const char *opt_output_path
;
43 static struct trace_collection trace_collection_read
;
44 static struct format
*fmt_read
;
46 void strlower(char *str
)
63 static struct poptOption long_options
[] = {
64 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
65 { "input-format", 'i', POPT_ARG_STRING
, &opt_input_format
, OPT_NONE
, NULL
, NULL
},
66 { "output-format", 'o', POPT_ARG_STRING
, &opt_output_format
, OPT_NONE
, NULL
, NULL
},
67 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
68 { "list", 'l', POPT_ARG_NONE
, NULL
, OPT_LIST
, NULL
, NULL
},
69 { "verbose", 'v', POPT_ARG_NONE
, NULL
, OPT_VERBOSE
, NULL
, NULL
},
70 { "debug", 'd', POPT_ARG_NONE
, NULL
, OPT_DEBUG
, NULL
, NULL
},
71 { "names", 'n', POPT_ARG_STRING
, NULL
, OPT_NAMES
, NULL
, NULL
},
72 { NULL
, 0, 0, NULL
, 0, NULL
, NULL
},
75 static void list_formats(FILE *fp
)
78 bt_fprintf_format_list(fp
);
81 static void usage(FILE *fp
)
83 fprintf(fp
, "BabelTrace Trace Converter %s\n\n", VERSION
);
84 fprintf(fp
, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
86 fprintf(fp
, " INPUT Input trace path\n");
87 fprintf(fp
, " OUTPUT Output trace path (default: stdout)\n");
89 fprintf(fp
, " -i, --input-format FORMAT Input trace format (default: ctf)\n");
90 fprintf(fp
, " -o, --output-format FORMAT Output trace format (default: text)\n");
92 fprintf(fp
, " -h, --help This help message\n");
93 fprintf(fp
, " -l, --list List available formats\n");
94 fprintf(fp
, " -v, --verbose Verbose mode\n");
95 fprintf(fp
, " (or set BABELTRACE_VERBOSE environment variable)\n");
96 fprintf(fp
, " -d, --debug Debug mode\n");
97 fprintf(fp
, " (or set BABELTRACE_DEBUG environment variable)\n");
98 fprintf(fp
, " -n, --names name1<,name2,...> Print field names.\n");
99 fprintf(fp
, " Available field names:\n");
100 fprintf(fp
, " (payload OR args OR arg)\n");
101 fprintf(fp
, " all, scope, header, (context OR ctx)\n");
102 fprintf(fp
, " trace, trace:domain, trace:procname, trace:vpid,\n");
103 fprintf(fp
, " loglevel.\n");
104 fprintf(fp
, " (payload active by default)\n");
109 static int get_names_args(poptContext
*pc
)
111 char *str
, *strlist
, *strctx
;
113 opt_payload_field_names
= 0;
114 strlist
= (char *) poptGetOptArg(*pc
);
118 str
= strtok_r(strlist
, ",", &strctx
);
120 if (!strcmp(str
, "all"))
121 opt_all_field_names
= 1;
122 else if (!strcmp(str
, "scope"))
123 opt_scope_field_names
= 1;
124 else if (!strcmp(str
, "context") || !strcmp(str
, "ctx"))
125 opt_context_field_names
= 1;
126 else if (!strcmp(str
, "header"))
127 opt_header_field_names
= 1;
128 else if (!strcmp(str
, "payload") || !strcmp(str
, "args") || !strcmp(str
, "arg"))
129 opt_payload_field_names
= 1;
130 else if (!strcmp(str
, "trace"))
132 else if (!strcmp(str
, "trace:domain"))
133 opt_trace_domain
= 1;
134 else if (!strcmp(str
, "trace:procname"))
135 opt_trace_procname
= 1;
136 else if (!strcmp(str
, "trace:vpid"))
138 else if (!strcmp(str
, "loglevel"))
141 fprintf(stdout
, "[error] unknown field name type %s\n", str
);
144 } while ((str
= strtok_r(NULL
, ",", &strctx
)));
149 * Return 0 if caller should continue, < 0 if caller should return
150 * error, > 0 if caller should exit without reporting error.
152 static int parse_options(int argc
, char **argv
)
159 return 1; /* exit cleanly */
162 pc
= poptGetContext(NULL
, argc
, (const char **) argv
, long_options
, 0);
163 poptReadDefaultConfig(pc
, 0);
166 opt_payload_field_names
= 1;
168 while ((opt
= poptGetNextOpt(pc
)) != -1) {
172 ret
= 1; /* exit cleanly */
175 list_formats(stdout
);
179 babeltrace_verbose
= 1;
182 if (get_names_args(&pc
)) {
188 babeltrace_debug
= 1;
196 opt_input_path
= poptGetArg(pc
);
197 if (!opt_input_path
) {
201 opt_output_path
= poptGetArg(pc
);
210 static void init_trace_collection(struct trace_collection
*tc
)
212 tc
->array
= g_ptr_array_sized_new(DEFAULT_FILE_ARRAY_SIZE
);
216 * finalize_trace_collection() closes the opened traces for read
217 * and free the memory allocated for trace collection
219 static void finalize_trace_collection(struct trace_collection
*tc
)
223 for (i
= 0; i
< tc
->array
->len
; i
++) {
224 struct trace_descriptor
*temp
=
225 g_ptr_array_index(tc
->array
, i
);
226 fmt_read
->close_trace(temp
);
228 g_ptr_array_free(tc
->array
, TRUE
);
231 static void trace_collection_add(struct trace_collection
*tc
,
232 struct trace_descriptor
*td
)
234 g_ptr_array_add(tc
->array
, td
);
238 * traverse_dir() is the callback functiion for File Tree Walk (nftw).
239 * it receives the path of the current entry (file, dir, link..etc) with
240 * a flag to indicate the type of the entry.
241 * if the entry being visited is a directory and contains a metadata file,
242 * then open it for reading and save a trace_descriptor to that directory
243 * in the read trace collection.
245 static int traverse_dir(const char *fpath
, const struct stat
*sb
,
246 int tflag
, struct FTW
*ftwbuf
)
250 struct trace_descriptor
*td_read
;
254 dirfd
= open(fpath
, 0);
256 fprintf(stdout
, "[error] unable to open trace "
257 "directory file descriptor.\n");
260 fd
= openat(dirfd
, "metadata", O_RDONLY
);
266 td_read
= fmt_read
->open_trace(opt_input_path
,
267 fpath
, O_RDONLY
, ctf_move_pos_slow
,
270 fprintf(stdout
, "Error opening trace \"%s\" "
271 "for reading.\n\n", fpath
);
272 return -1; /* error */
274 trace_collection_add(&trace_collection_read
, td_read
);
276 return 0; /* success */
279 int main(int argc
, char **argv
)
282 struct format
*fmt_write
;
283 struct trace_descriptor
*td_write
;
285 ret
= parse_options(argc
, argv
);
287 fprintf(stdout
, "Error parsing options.\n\n");
290 } else if (ret
> 0) {
293 printf_verbose("Verbose mode active.\n");
294 printf_debug("Debug mode active.\n");
296 if (opt_input_format
)
297 strlower(opt_input_format
);
298 if (opt_output_format
)
299 strlower(opt_output_format
);
301 printf_verbose("Converting from directory: %s\n", opt_input_path
);
302 printf_verbose("Converting from format: %s\n",
303 opt_input_format
? : "ctf <default>");
304 printf_verbose("Converting to directory: %s\n",
305 opt_output_path
? : "<stdout>");
306 printf_verbose("Converting to format: %s\n",
307 opt_output_format
? : "text <default>");
309 if (!opt_input_format
)
310 opt_input_format
= "ctf";
311 if (!opt_output_format
)
312 opt_output_format
= "text";
313 fmt_read
= bt_lookup_format(g_quark_from_static_string(opt_input_format
));
315 fprintf(stdout
, "[error] Format \"%s\" is not supported.\n\n",
319 fmt_write
= bt_lookup_format(g_quark_from_static_string(opt_output_format
));
321 fprintf(stdout
, "[error] format \"%s\" is not supported.\n\n",
327 * pass the input path to nftw() .
328 * specify traverse_dir() as the callback function.
329 * depth = 10 which is the max number of file descriptors
330 * that nftw() can open at a given time.
331 * flags = 0 check nftw documentation for more info .
333 init_trace_collection(&trace_collection_read
);
334 ret
= nftw(opt_input_path
, traverse_dir
, 10, 0);
336 fprintf(stdout
, "[error] opening trace \"%s\" for reading.\n\n",
340 if (trace_collection_read
.array
->len
== 0) {
341 fprintf(stdout
, "[warning] no metadata file was found."
342 " no output was generated\n");
346 td_write
= fmt_write
->open_trace(NULL
, opt_output_path
, O_RDWR
, NULL
, NULL
);
348 fprintf(stdout
, "Error opening trace \"%s\" for writing.\n\n",
349 opt_output_path
? : "<none>");
353 ret
= convert_trace(td_write
, &trace_collection_read
);
355 fprintf(stdout
, "Error printing trace.\n\n");
356 goto error_copy_trace
;
359 fmt_write
->close_trace(td_write
);
360 finalize_trace_collection(&trace_collection_read
);
361 printf_verbose("finished converting. Output written to:\n%s\n",
362 opt_output_path
? : "<stdout>");
367 fmt_write
->close_trace(td_write
);
369 finalize_trace_collection(&trace_collection_read
);