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
, " (payload active by default)\n");
107 static int get_names_args(poptContext
*pc
)
109 char *str
, *strlist
, *strctx
;
111 opt_payload_field_names
= 0;
112 strlist
= (char *) poptGetOptArg(*pc
);
116 str
= strtok_r(strlist
, ",", &strctx
);
118 if (!strcmp(str
, "all"))
119 opt_all_field_names
= 1;
120 else if (!strcmp(str
, "scope"))
121 opt_scope_field_names
= 1;
122 else if (!strcmp(str
, "context") || !strcmp(str
, "ctx"))
123 opt_context_field_names
= 1;
124 else if (!strcmp(str
, "header"))
125 opt_header_field_names
= 1;
126 else if (!strcmp(str
, "payload") || !strcmp(str
, "args") || !strcmp(str
, "arg"))
127 opt_payload_field_names
= 1;
129 fprintf(stdout
, "[error] unknown field name type %s\n", str
);
132 } while ((str
= strtok_r(NULL
, ",", &strctx
)));
137 * Return 0 if caller should continue, < 0 if caller should return
138 * error, > 0 if caller should exit without reporting error.
140 static int parse_options(int argc
, char **argv
)
147 return 1; /* exit cleanly */
150 pc
= poptGetContext(NULL
, argc
, (const char **) argv
, long_options
, 0);
151 poptReadDefaultConfig(pc
, 0);
154 opt_payload_field_names
= 1;
156 while ((opt
= poptGetNextOpt(pc
)) != -1) {
160 ret
= 1; /* exit cleanly */
163 list_formats(stdout
);
167 babeltrace_verbose
= 1;
170 if (get_names_args(&pc
)) {
176 babeltrace_debug
= 1;
184 opt_input_path
= poptGetArg(pc
);
185 if (!opt_input_path
) {
189 opt_output_path
= poptGetArg(pc
);
198 static void init_trace_collection(struct trace_collection
*tc
)
200 tc
->array
= g_ptr_array_sized_new(DEFAULT_FILE_ARRAY_SIZE
);
204 * finalize_trace_collection() closes the opened traces for read
205 * and free the memory allocated for trace collection
207 static void finalize_trace_collection(struct trace_collection
*tc
)
211 for (i
= 0; i
< tc
->array
->len
; i
++) {
212 struct trace_descriptor
*temp
=
213 g_ptr_array_index(tc
->array
, i
);
214 fmt_read
->close_trace(temp
);
216 g_ptr_array_free(tc
->array
, TRUE
);
219 static void trace_collection_add(struct trace_collection
*tc
,
220 struct trace_descriptor
*td
)
222 g_ptr_array_add(tc
->array
, td
);
226 * traverse_dir() is the callback functiion for File Tree Walk (nftw).
227 * it receives the path of the current entry (file, dir, link..etc) with
228 * a flag to indicate the type of the entry.
229 * if the entry being visited is a directory and contains a metadata file,
230 * then open it for reading and save a trace_descriptor to that directory
231 * in the read trace collection.
233 static int traverse_dir(const char *fpath
, const struct stat
*sb
,
234 int tflag
, struct FTW
*ftwbuf
)
238 struct trace_descriptor
*td_read
;
242 dirfd
= open(fpath
, 0);
244 fprintf(stdout
, "[error] unable to open trace "
245 "directory file descriptor.\n");
248 fd
= openat(dirfd
, "metadata", O_RDONLY
);
254 td_read
= fmt_read
->open_trace(fpath
, O_RDONLY
, ctf_move_pos_slow
,
257 fprintf(stdout
, "Error opening trace \"%s\" "
258 "for reading.\n\n", fpath
);
259 return -1; /* error */
261 trace_collection_add(&trace_collection_read
, td_read
);
263 return 0; /* success */
266 int main(int argc
, char **argv
)
269 struct format
*fmt_write
;
270 struct trace_descriptor
*td_write
;
272 ret
= parse_options(argc
, argv
);
274 fprintf(stdout
, "Error parsing options.\n\n");
277 } else if (ret
> 0) {
280 printf_verbose("Verbose mode active.\n");
281 printf_debug("Debug mode active.\n");
283 if (opt_input_format
)
284 strlower(opt_input_format
);
285 if (opt_output_format
)
286 strlower(opt_output_format
);
288 printf_verbose("Converting from directory: %s\n", opt_input_path
);
289 printf_verbose("Converting from format: %s\n",
290 opt_input_format
? : "ctf <default>");
291 printf_verbose("Converting to directory: %s\n",
292 opt_output_path
? : "<stdout>");
293 printf_verbose("Converting to format: %s\n",
294 opt_output_format
? : "text <default>");
296 if (!opt_input_format
)
297 opt_input_format
= "ctf";
298 if (!opt_output_format
)
299 opt_output_format
= "text";
300 fmt_read
= bt_lookup_format(g_quark_from_static_string(opt_input_format
));
302 fprintf(stdout
, "[error] Format \"%s\" is not supported.\n\n",
306 fmt_write
= bt_lookup_format(g_quark_from_static_string(opt_output_format
));
308 fprintf(stdout
, "[error] format \"%s\" is not supported.\n\n",
314 * pass the input path to nftw() .
315 * specify traverse_dir() as the callback function.
316 * depth = 10 which is the max number of file descriptors
317 * that nftw() can open at a given time.
318 * flags = 0 check nftw documentation for more info .
320 init_trace_collection(&trace_collection_read
);
321 ret
= nftw(opt_input_path
, traverse_dir
, 10, 0);
323 fprintf(stdout
, "[error] opening trace \"%s\" for reading.\n\n",
327 if (trace_collection_read
.array
->len
== 0) {
328 fprintf(stdout
, "[warning] no metadata file was found."
329 " no output was generated\n");
333 td_write
= fmt_write
->open_trace(opt_output_path
, O_RDWR
, NULL
, NULL
);
335 fprintf(stdout
, "Error opening trace \"%s\" for writing.\n\n",
336 opt_output_path
? : "<none>");
340 ret
= convert_trace(td_write
, &trace_collection_read
);
342 fprintf(stdout
, "Error printing trace.\n\n");
343 goto error_copy_trace
;
346 fmt_write
->close_trace(td_write
);
347 finalize_trace_collection(&trace_collection_read
);
348 printf_verbose("finished converting. Output written to:\n%s\n",
349 opt_output_path
? : "<stdout>");
354 fmt_write
->close_trace(td_write
);
356 finalize_trace_collection(&trace_collection_read
);