Commit | Line | Data |
---|---|---|
34ac0e6c MD |
1 | /* |
2 | * babeltrace.c | |
3 | * | |
4 | * Babeltrace Trace Converter | |
5 | * | |
64fa3fec MD |
6 | * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation |
7 | * | |
8 | * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
34ac0e6c MD |
9 | * |
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: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
c462e188 MD |
19 | * |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
34ac0e6c | 27 | */ |
4c8bfb7e | 28 | |
95d36295 | 29 | #include <babeltrace/babeltrace.h> |
7fb21036 | 30 | #include <babeltrace/format.h> |
95d36295 | 31 | #include <babeltrace/context.h> |
7237592a | 32 | #include <babeltrace/context-internal.h> |
95d36295 | 33 | #include <babeltrace/ctf/types.h> |
9843982d | 34 | #include <babeltrace/ctf/events.h> |
04ae3991 MD |
35 | /* TODO: fix object model for format-agnostic callbacks */ |
36 | #include <babeltrace/ctf/events-internal.h> | |
9efd5d76 | 37 | #include <babeltrace/ctf/iterator.h> |
31bdef5c | 38 | #include <babeltrace/ctf-text/types.h> |
b5a8598f AB |
39 | #include <babeltrace/debuginfo.h> |
40 | ||
6204d33c | 41 | #include <babeltrace/iterator.h> |
34ac0e6c MD |
42 | #include <popt.h> |
43 | #include <errno.h> | |
44 | #include <stdlib.h> | |
bbefb8dd MD |
45 | #include <ctype.h> |
46 | #include <sys/stat.h> | |
47 | #include <sys/types.h> | |
48 | #include <fcntl.h> | |
afb48eae | 49 | #include <unistd.h> |
70accc14 | 50 | #include <inttypes.h> |
a99343cf | 51 | #include <ftw.h> |
11e1d048 | 52 | #include <string.h> |
4c8bfb7e | 53 | |
a44bc4c9 MD |
54 | #include <babeltrace/ctf-ir/metadata.h> /* for clocks */ |
55 | ||
24d5af5b MD |
56 | #define PARTIAL_ERROR_SLEEP 3 /* 3 seconds */ |
57 | ||
afb48eae | 58 | #define DEFAULT_FILE_ARRAY_SIZE 1 |
9fe26ec7 | 59 | |
34d99418 JD |
60 | #define NET_URL_PREFIX "net://" |
61 | #define NET4_URL_PREFIX "net4://" | |
62 | #define NET6_URL_PREFIX "net6://" | |
63 | ||
11e1d048 | 64 | static char *opt_input_format, *opt_output_format; |
34ac0e6c | 65 | |
41075e78 MD |
66 | /* |
67 | * We are not freeing opt_input_paths ipath elements when exiting from | |
68 | * main() for backward compatibility with libpop 0.13, which does not | |
69 | * allocate copies for arguments returned by poptGetArg(), and for | |
70 | * general compatibility with the documented behavior. This is known to | |
71 | * cause a small memory leak with libpop 0.16. | |
72 | */ | |
4e85cbfd | 73 | static GPtrArray *opt_input_paths; |
9fe26ec7 | 74 | static char *opt_output_path; |
b5a8598f | 75 | static int opt_stream_intersection; |
34ac0e6c | 76 | |
37b99bdb | 77 | static struct bt_format *fmt_read; |
afb48eae | 78 | |
11e1d048 | 79 | static |
bbefb8dd MD |
80 | void strlower(char *str) |
81 | { | |
82 | while (*str) { | |
34224260 | 83 | *str = tolower((int) *str); |
bbefb8dd MD |
84 | str++; |
85 | } | |
86 | } | |
87 | ||
34ac0e6c MD |
88 | enum { |
89 | OPT_NONE = 0, | |
9fe26ec7 MD |
90 | OPT_OUTPUT_PATH, |
91 | OPT_INPUT_FORMAT, | |
92 | OPT_OUTPUT_FORMAT, | |
34ac0e6c | 93 | OPT_HELP, |
7fb21036 | 94 | OPT_LIST, |
34ac0e6c MD |
95 | OPT_VERBOSE, |
96 | OPT_DEBUG, | |
d63ca2cd | 97 | OPT_NAMES, |
359d7456 | 98 | OPT_FIELDS, |
8d8ed9af | 99 | OPT_NO_DELTA, |
11ac6674 | 100 | OPT_CLOCK_OFFSET, |
65923160 | 101 | OPT_CLOCK_OFFSET_NS, |
03798a93 | 102 | OPT_CLOCK_CYCLES, |
11ac6674 MD |
103 | OPT_CLOCK_SECONDS, |
104 | OPT_CLOCK_DATE, | |
105 | OPT_CLOCK_GMT, | |
82ace6d6 | 106 | OPT_CLOCK_FORCE_CORRELATE, |
37ea109a | 107 | OPT_STREAM_INTERSECTION, |
3be1e3c9 | 108 | OPT_DEBUG_INFO_DIR, |
458af89d | 109 | OPT_DEBUG_INFO_FULL_PATH, |
b7b61ced | 110 | OPT_DEBUG_INFO_TARGET_PREFIX, |
34ac0e6c MD |
111 | }; |
112 | ||
9fe26ec7 MD |
113 | /* |
114 | * We are _not_ using POPT_ARG_STRING ability to store directly into | |
115 | * variables, because we want to cast the return to non-const, which is | |
41075e78 MD |
116 | * not possible without using poptGetOptArg explicitly. This helps us |
117 | * controlling memory allocation correctly without making assumptions | |
118 | * about undocumented behaviors. poptGetOptArg is documented as | |
119 | * requiring the returned const char * to be freed by the caller. | |
9fe26ec7 | 120 | */ |
34ac0e6c MD |
121 | static struct poptOption long_options[] = { |
122 | /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ | |
c790c052 | 123 | { "output", 'w', POPT_ARG_STRING, NULL, OPT_OUTPUT_PATH, NULL, NULL }, |
9fe26ec7 MD |
124 | { "input-format", 'i', POPT_ARG_STRING, NULL, OPT_INPUT_FORMAT, NULL, NULL }, |
125 | { "output-format", 'o', POPT_ARG_STRING, NULL, OPT_OUTPUT_FORMAT, NULL, NULL }, | |
34ac0e6c | 126 | { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL }, |
7fb21036 | 127 | { "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL }, |
34ac0e6c MD |
128 | { "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL }, |
129 | { "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL }, | |
cba1661c | 130 | { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL }, |
359d7456 | 131 | { "fields", 'f', POPT_ARG_STRING, NULL, OPT_FIELDS, NULL, NULL }, |
8d8ed9af | 132 | { "no-delta", 0, POPT_ARG_NONE, NULL, OPT_NO_DELTA, NULL, NULL }, |
11ac6674 | 133 | { "clock-offset", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET, NULL, NULL }, |
65923160 | 134 | { "clock-offset-ns", 0, POPT_ARG_STRING, NULL, OPT_CLOCK_OFFSET_NS, NULL, NULL }, |
03798a93 | 135 | { "clock-cycles", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_CYCLES, NULL, NULL }, |
11ac6674 MD |
136 | { "clock-seconds", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_SECONDS, NULL, NULL }, |
137 | { "clock-date", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_DATE, NULL, NULL }, | |
138 | { "clock-gmt", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_GMT, NULL, NULL }, | |
82ace6d6 | 139 | { "clock-force-correlate", 0, POPT_ARG_NONE, NULL, OPT_CLOCK_FORCE_CORRELATE, NULL, NULL }, |
37ea109a | 140 | { "stream-intersection", 0, POPT_ARG_NONE, NULL, OPT_STREAM_INTERSECTION, NULL, NULL }, |
b5a8598f | 141 | #ifdef ENABLE_DEBUGINFO |
3be1e3c9 | 142 | { "debug-info-dir", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_DIR, NULL, NULL }, |
458af89d | 143 | { "debug-info-full-path", 0, POPT_ARG_NONE, NULL, OPT_DEBUG_INFO_FULL_PATH, NULL, NULL }, |
b7b61ced | 144 | { "debug-info-target-prefix", 0, POPT_ARG_STRING, NULL, OPT_DEBUG_INFO_TARGET_PREFIX, NULL, NULL }, |
b5a8598f | 145 | #endif |
34ac0e6c MD |
146 | { NULL, 0, 0, NULL, 0, NULL, NULL }, |
147 | }; | |
148 | ||
7fb21036 MD |
149 | static void list_formats(FILE *fp) |
150 | { | |
151 | fprintf(fp, "\n"); | |
152 | bt_fprintf_format_list(fp); | |
153 | } | |
154 | ||
34ac0e6c | 155 | static void usage(FILE *fp) |
4c8bfb7e | 156 | { |
4c15b06b | 157 | fprintf(fp, "BabelTrace Trace Viewer and Converter %s\n\n", VERSION); |
4e85cbfd | 158 | fprintf(fp, "usage : babeltrace [OPTIONS] FILE...\n"); |
34ac0e6c | 159 | fprintf(fp, "\n"); |
4e85cbfd MD |
160 | fprintf(fp, " FILE Input trace file(s) and/or directory(ies)\n"); |
161 | fprintf(fp, " (space-separated)\n"); | |
162 | fprintf(fp, " -w, --output OUTPUT Output trace path (default: stdout)\n"); | |
34ac0e6c | 163 | fprintf(fp, "\n"); |
d2b8ea6b MD |
164 | fprintf(fp, " -i, --input-format FORMAT Input trace format (default: ctf)\n"); |
165 | fprintf(fp, " -o, --output-format FORMAT Output trace format (default: text)\n"); | |
34ac0e6c | 166 | fprintf(fp, "\n"); |
4d5678b9 MD |
167 | fprintf(fp, " -h, --help This help message\n"); |
168 | fprintf(fp, " -l, --list List available formats\n"); | |
169 | fprintf(fp, " -v, --verbose Verbose mode\n"); | |
cba1661c | 170 | fprintf(fp, " (or set BABELTRACE_VERBOSE environment variable)\n"); |
4d5678b9 | 171 | fprintf(fp, " -d, --debug Debug mode\n"); |
cba1661c | 172 | fprintf(fp, " (or set BABELTRACE_DEBUG environment variable)\n"); |
8d8ed9af | 173 | fprintf(fp, " --no-delta Do not print time delta between consecutive events\n"); |
359d7456 | 174 | fprintf(fp, " -n, --names name1<,name2,...> Print field names:\n"); |
82662ad4 | 175 | fprintf(fp, " (payload OR args OR arg)\n"); |
12c9c3bc MD |
176 | fprintf(fp, " none, all, scope, header, (context OR ctx)\n"); |
177 | fprintf(fp, " (default: payload,context)\n"); | |
359d7456 | 178 | fprintf(fp, " -f, --fields name1<,name2,...> Print additional fields:\n"); |
32cfb8ad | 179 | fprintf(fp, " all, trace, trace:hostname, trace:domain,\n"); |
f133896d | 180 | fprintf(fp, " trace:procname, trace:vpid, loglevel, emf, callsite.\n"); |
c3815874 | 181 | fprintf(fp, " (default: trace:hostname,trace:procname,trace:vpid)\n"); |
03798a93 | 182 | fprintf(fp, " --clock-cycles Timestamp in cycles\n"); |
11ac6674 | 183 | fprintf(fp, " --clock-offset seconds Clock offset in seconds\n"); |
65923160 | 184 | fprintf(fp, " --clock-offset-ns ns Clock offset in nanoseconds\n"); |
11ac6674 MD |
185 | fprintf(fp, " --clock-seconds Print the timestamps as [sec.ns]\n"); |
186 | fprintf(fp, " (default is: [hh:mm:ss.ns])\n"); | |
187 | fprintf(fp, " --clock-date Print clock date\n"); | |
188 | fprintf(fp, " --clock-gmt Print clock in GMT time zone (default: local time zone)\n"); | |
82ace6d6 MD |
189 | fprintf(fp, " --clock-force-correlate Assume that clocks are inherently correlated\n"); |
190 | fprintf(fp, " across traces.\n"); | |
37ea109a | 191 | fprintf(fp, " --stream-intersection Only print events when all streams are active.\n"); |
b5a8598f AB |
192 | #ifdef ENABLE_DEBUGINFO |
193 | fprintf(fp, " --debug-info-dir Directory in which to look for debugging information\n"); | |
194 | fprintf(fp, " files. (default: /usr/lib/debug/)\n"); | |
b7b61ced | 195 | fprintf(fp, " --debug-info-target-prefix Directory to use as a prefix for executable lookup\n"); |
af3d7ced | 196 | fprintf(fp, " --debug-info-full-path Show full debug info source and binary paths (if available)\n"); |
b5a8598f | 197 | #endif |
7fb21036 | 198 | list_formats(fp); |
34ac0e6c MD |
199 | fprintf(fp, "\n"); |
200 | } | |
201 | ||
cba1661c MD |
202 | static int get_names_args(poptContext *pc) |
203 | { | |
204 | char *str, *strlist, *strctx; | |
9f2c779c | 205 | int ret = 0; |
cba1661c MD |
206 | |
207 | opt_payload_field_names = 0; | |
12c9c3bc | 208 | opt_context_field_names = 0; |
cba1661c MD |
209 | strlist = (char *) poptGetOptArg(*pc); |
210 | if (!strlist) { | |
211 | return -EINVAL; | |
212 | } | |
213 | str = strtok_r(strlist, ",", &strctx); | |
214 | do { | |
215 | if (!strcmp(str, "all")) | |
216 | opt_all_field_names = 1; | |
217 | else if (!strcmp(str, "scope")) | |
218 | opt_scope_field_names = 1; | |
219 | else if (!strcmp(str, "context") || !strcmp(str, "ctx")) | |
220 | opt_context_field_names = 1; | |
221 | else if (!strcmp(str, "header")) | |
222 | opt_header_field_names = 1; | |
223 | else if (!strcmp(str, "payload") || !strcmp(str, "args") || !strcmp(str, "arg")) | |
224 | opt_payload_field_names = 1; | |
12c9c3bc MD |
225 | else if (!strcmp(str, "none")) { |
226 | opt_all_field_names = 0; | |
227 | opt_scope_field_names = 0; | |
228 | opt_context_field_names = 0; | |
229 | opt_header_field_names = 0; | |
230 | opt_payload_field_names = 0; | |
231 | } else { | |
359d7456 | 232 | fprintf(stderr, "[error] unknown field name type %s\n", str); |
9f2c779c MD |
233 | ret = -EINVAL; |
234 | goto end; | |
359d7456 MD |
235 | } |
236 | } while ((str = strtok_r(NULL, ",", &strctx))); | |
9f2c779c MD |
237 | end: |
238 | free(strlist); | |
239 | return ret; | |
359d7456 MD |
240 | } |
241 | ||
242 | static int get_fields_args(poptContext *pc) | |
243 | { | |
244 | char *str, *strlist, *strctx; | |
9f2c779c | 245 | int ret = 0; |
359d7456 | 246 | |
359d7456 MD |
247 | strlist = (char *) poptGetOptArg(*pc); |
248 | if (!strlist) { | |
249 | return -EINVAL; | |
250 | } | |
251 | str = strtok_r(strlist, ",", &strctx); | |
252 | do { | |
c3815874 | 253 | opt_trace_default_fields = 0; |
359d7456 MD |
254 | if (!strcmp(str, "all")) |
255 | opt_all_fields = 1; | |
82662ad4 | 256 | else if (!strcmp(str, "trace")) |
359d7456 | 257 | opt_trace_field = 1; |
c3815874 MD |
258 | else if (!strcmp(str, "trace:hostname")) |
259 | opt_trace_hostname_field = 1; | |
8c250d87 | 260 | else if (!strcmp(str, "trace:domain")) |
359d7456 | 261 | opt_trace_domain_field = 1; |
8c250d87 | 262 | else if (!strcmp(str, "trace:procname")) |
359d7456 | 263 | opt_trace_procname_field = 1; |
8c250d87 | 264 | else if (!strcmp(str, "trace:vpid")) |
359d7456 | 265 | opt_trace_vpid_field = 1; |
d86d62f8 | 266 | else if (!strcmp(str, "loglevel")) |
359d7456 | 267 | opt_loglevel_field = 1; |
f6714e20 MD |
268 | else if (!strcmp(str, "emf")) |
269 | opt_emf_field = 1; | |
f133896d MD |
270 | else if (!strcmp(str, "callsite")) |
271 | opt_callsite_field = 1; | |
cba1661c | 272 | else { |
359d7456 | 273 | fprintf(stderr, "[error] unknown field type %s\n", str); |
9f2c779c MD |
274 | ret = -EINVAL; |
275 | goto end; | |
cba1661c MD |
276 | } |
277 | } while ((str = strtok_r(NULL, ",", &strctx))); | |
9f2c779c MD |
278 | end: |
279 | free(strlist); | |
280 | return ret; | |
cba1661c MD |
281 | } |
282 | ||
34ac0e6c MD |
283 | /* |
284 | * Return 0 if caller should continue, < 0 if caller should return | |
285 | * error, > 0 if caller should exit without reporting error. | |
286 | */ | |
bbefb8dd | 287 | static int parse_options(int argc, char **argv) |
34ac0e6c MD |
288 | { |
289 | poptContext pc; | |
290 | int opt, ret = 0; | |
41075e78 | 291 | const char *ipath; |
34ac0e6c | 292 | |
0f980a35 MD |
293 | if (argc == 1) { |
294 | usage(stdout); | |
295 | return 1; /* exit cleanly */ | |
296 | } | |
297 | ||
bbefb8dd | 298 | pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0); |
34ac0e6c MD |
299 | poptReadDefaultConfig(pc, 0); |
300 | ||
cba1661c | 301 | /* set default */ |
e505794f | 302 | opt_context_field_names = 1; |
cba1661c MD |
303 | opt_payload_field_names = 1; |
304 | ||
34ac0e6c MD |
305 | while ((opt = poptGetNextOpt(pc)) != -1) { |
306 | switch (opt) { | |
9fe26ec7 MD |
307 | case OPT_OUTPUT_PATH: |
308 | opt_output_path = (char *) poptGetOptArg(pc); | |
309 | if (!opt_output_path) { | |
310 | ret = -EINVAL; | |
311 | goto end; | |
312 | } | |
313 | break; | |
314 | case OPT_INPUT_FORMAT: | |
315 | opt_input_format = (char *) poptGetOptArg(pc); | |
316 | if (!opt_input_format) { | |
317 | ret = -EINVAL; | |
318 | goto end; | |
319 | } | |
320 | break; | |
321 | case OPT_OUTPUT_FORMAT: | |
322 | opt_output_format = (char *) poptGetOptArg(pc); | |
323 | if (!opt_output_format) { | |
324 | ret = -EINVAL; | |
325 | goto end; | |
326 | } | |
327 | break; | |
34ac0e6c | 328 | case OPT_HELP: |
7fb21036 | 329 | usage(stdout); |
34ac0e6c MD |
330 | ret = 1; /* exit cleanly */ |
331 | goto end; | |
7fb21036 MD |
332 | case OPT_LIST: |
333 | list_formats(stdout); | |
334 | ret = 1; | |
335 | goto end; | |
34ac0e6c MD |
336 | case OPT_VERBOSE: |
337 | babeltrace_verbose = 1; | |
338 | break; | |
cba1661c MD |
339 | case OPT_NAMES: |
340 | if (get_names_args(&pc)) { | |
341 | ret = -EINVAL; | |
342 | goto end; | |
343 | } | |
344 | break; | |
359d7456 MD |
345 | case OPT_FIELDS: |
346 | if (get_fields_args(&pc)) { | |
347 | ret = -EINVAL; | |
348 | goto end; | |
349 | } | |
350 | break; | |
34ac0e6c MD |
351 | case OPT_DEBUG: |
352 | babeltrace_debug = 1; | |
353 | break; | |
8d8ed9af | 354 | case OPT_NO_DELTA: |
359d7456 | 355 | opt_delta_field = 0; |
8d8ed9af | 356 | break; |
03798a93 JD |
357 | case OPT_CLOCK_CYCLES: |
358 | opt_clock_cycles = 1; | |
11ac6674 MD |
359 | break; |
360 | case OPT_CLOCK_OFFSET: | |
361 | { | |
9f2c779c | 362 | char *str; |
34224260 | 363 | char *endptr; |
11ac6674 | 364 | |
9f2c779c | 365 | str = (char *) poptGetOptArg(pc); |
11ac6674 MD |
366 | if (!str) { |
367 | fprintf(stderr, "[error] Missing --clock-offset argument\n"); | |
368 | ret = -EINVAL; | |
369 | goto end; | |
370 | } | |
371 | errno = 0; | |
372 | opt_clock_offset = strtoull(str, &endptr, 0); | |
373 | if (*endptr != '\0' || str == endptr || errno != 0) { | |
374 | fprintf(stderr, "[error] Incorrect --clock-offset argument: %s\n", str); | |
375 | ret = -EINVAL; | |
9f2c779c | 376 | free(str); |
11ac6674 MD |
377 | goto end; |
378 | } | |
9f2c779c | 379 | free(str); |
11ac6674 MD |
380 | break; |
381 | } | |
382 | case OPT_CLOCK_SECONDS: | |
383 | opt_clock_seconds = 1; | |
384 | break; | |
65923160 IJ |
385 | case OPT_CLOCK_OFFSET_NS: |
386 | { | |
387 | char *str; | |
388 | char *endptr; | |
389 | ||
390 | str = (char *) poptGetOptArg(pc); | |
391 | if (!str) { | |
392 | fprintf(stderr, "[error] Missing --clock-offset-ns argument\n"); | |
393 | ret = -EINVAL; | |
394 | goto end; | |
395 | } | |
396 | errno = 0; | |
397 | opt_clock_offset_ns = strtoull(str, &endptr, 0); | |
398 | if (*endptr != '\0' || str == endptr || errno != 0) { | |
399 | fprintf(stderr, "[error] Incorrect --clock-offset-ns argument: %s\n", str); | |
400 | ret = -EINVAL; | |
401 | free(str); | |
402 | goto end; | |
403 | } | |
404 | free(str); | |
405 | break; | |
406 | } | |
407 | ||
11ac6674 MD |
408 | case OPT_CLOCK_DATE: |
409 | opt_clock_date = 1; | |
410 | break; | |
411 | case OPT_CLOCK_GMT: | |
412 | opt_clock_gmt = 1; | |
413 | break; | |
82ace6d6 MD |
414 | case OPT_CLOCK_FORCE_CORRELATE: |
415 | opt_clock_force_correlate = 1; | |
416 | break; | |
37ea109a JD |
417 | case OPT_STREAM_INTERSECTION: |
418 | opt_stream_intersection = 1; | |
419 | break; | |
3be1e3c9 JG |
420 | case OPT_DEBUG_INFO_DIR: |
421 | opt_debug_info_dir = (char *) poptGetOptArg(pc); | |
422 | if (!opt_debug_info_dir) { | |
b5a8598f AB |
423 | ret = -EINVAL; |
424 | goto end; | |
425 | } | |
426 | break; | |
458af89d JG |
427 | case OPT_DEBUG_INFO_FULL_PATH: |
428 | opt_debug_info_full_path = 1; | |
429 | break; | |
b7b61ced AB |
430 | case OPT_DEBUG_INFO_TARGET_PREFIX: |
431 | opt_debug_info_target_prefix = (char *) poptGetOptArg(pc); | |
432 | if (!opt_debug_info_target_prefix) { | |
433 | ret = -EINVAL; | |
434 | goto end; | |
435 | } | |
436 | break; | |
34ac0e6c MD |
437 | default: |
438 | ret = -EINVAL; | |
439 | goto end; | |
440 | } | |
441 | } | |
442 | ||
4e85cbfd | 443 | do { |
41075e78 | 444 | ipath = poptGetArg(pc); |
4e85cbfd MD |
445 | if (ipath) |
446 | g_ptr_array_add(opt_input_paths, (gpointer) ipath); | |
447 | } while (ipath); | |
448 | if (opt_input_paths->len == 0) { | |
34ac0e6c MD |
449 | ret = -EINVAL; |
450 | goto end; | |
451 | } | |
cba1661c | 452 | |
34ac0e6c MD |
453 | end: |
454 | if (pc) { | |
455 | poptFreeContext(pc); | |
456 | } | |
457 | return ret; | |
458 | } | |
459 | ||
a99343cf | 460 | static GPtrArray *traversed_paths = 0; |
afb48eae | 461 | |
a99343cf YB |
462 | /* |
463 | * traverse_trace_dir() is the callback function for File Tree Walk (nftw). | |
464 | * it receives the path of the current entry (file, dir, link..etc) with | |
465 | * a flag to indicate the type of the entry. | |
466 | * if the entry being visited is a directory and contains a metadata file, | |
467 | * then add the path to a global list to be processed later in | |
468 | * add_traces_recursive. | |
469 | */ | |
470 | static int traverse_trace_dir(const char *fpath, const struct stat *sb, | |
471 | int tflag, struct FTW *ftwbuf) | |
472 | { | |
473 | int dirfd, metafd; | |
474 | int closeret; | |
475 | ||
476 | if (tflag != FTW_D) | |
477 | return 0; | |
478 | ||
479 | dirfd = open(fpath, 0); | |
480 | if (dirfd < 0) { | |
481 | fprintf(stderr, "[error] [Context] Unable to open trace " | |
482 | "directory file descriptor.\n"); | |
483 | return 0; /* partial error */ | |
484 | } | |
485 | metafd = openat(dirfd, "metadata", O_RDONLY); | |
486 | if (metafd < 0) { | |
487 | closeret = close(dirfd); | |
488 | if (closeret < 0) { | |
489 | perror("close"); | |
490 | return -1; | |
491 | } | |
492 | /* No meta data, just return */ | |
493 | return 0; | |
494 | } else { | |
9544a40b MD |
495 | int err_close = 0; |
496 | ||
a99343cf YB |
497 | closeret = close(metafd); |
498 | if (closeret < 0) { | |
499 | perror("close"); | |
9544a40b | 500 | err_close = 1; |
a99343cf YB |
501 | } |
502 | closeret = close(dirfd); | |
503 | if (closeret < 0) { | |
504 | perror("close"); | |
9544a40b MD |
505 | err_close = 1; |
506 | } | |
507 | if (err_close) { | |
508 | return -1; | |
a99343cf YB |
509 | } |
510 | ||
511 | /* Add path to the global list */ | |
512 | if (traversed_paths == NULL) { | |
513 | fprintf(stderr, "[error] [Context] Invalid open path array.\n"); | |
514 | return -1; | |
515 | } | |
516 | g_ptr_array_add(traversed_paths, g_string_new(fpath)); | |
517 | } | |
518 | ||
519 | return 0; | |
520 | } | |
d0d82191 | 521 | |
20d24215 YB |
522 | /* |
523 | * bt_context_add_traces_recursive: Open a trace recursively | |
524 | * | |
525 | * Find each trace present in the subdirectory starting from the given | |
613f532b MD |
526 | * path, and add them to the context. The packet_seek parameter can be |
527 | * NULL: this specify to use the default format packet_seek. | |
20d24215 | 528 | * |
b945d4a5 | 529 | * Return: 0 on success, < 0 on failure, > 0 on partial failure. |
20d24215 | 530 | * Unable to open toplevel: failure. |
b945d4a5 MD |
531 | * Unable to open some subdirectory or file: warn and continue (partial |
532 | * failure); | |
20d24215 YB |
533 | */ |
534 | int bt_context_add_traces_recursive(struct bt_context *ctx, const char *path, | |
613f532b | 535 | const char *format_str, |
1cf393f6 | 536 | void (*packet_seek)(struct bt_stream_pos *pos, |
613f532b | 537 | size_t offset, int whence)) |
20d24215 | 538 | { |
fd94f11c | 539 | int ret = 0, trace_ids = 0; |
20d24215 | 540 | |
34d99418 JD |
541 | if ((strncmp(path, NET4_URL_PREFIX, sizeof(NET4_URL_PREFIX) - 1)) == 0 || |
542 | (strncmp(path, NET6_URL_PREFIX, sizeof(NET6_URL_PREFIX) - 1)) == 0 || | |
543 | (strncmp(path, NET_URL_PREFIX, sizeof(NET_URL_PREFIX) - 1)) == 0) { | |
544 | ret = bt_context_add_trace(ctx, | |
545 | path, format_str, packet_seek, NULL, NULL); | |
546 | if (ret < 0) { | |
547 | fprintf(stderr, "[warning] [Context] cannot open trace \"%s\" " | |
548 | "for reading.\n", path); | |
34d99418 JD |
549 | } |
550 | return ret; | |
551 | } | |
a99343cf | 552 | /* Should lock traversed_paths mutex here if used in multithread */ |
20d24215 | 553 | |
a99343cf | 554 | traversed_paths = g_ptr_array_new(); |
a99343cf YB |
555 | ret = nftw(path, traverse_trace_dir, 10, 0); |
556 | ||
557 | /* Process the array if ntfw did not return a fatal error */ | |
558 | if (ret >= 0) { | |
08c82b90 MD |
559 | int i; |
560 | ||
a99343cf YB |
561 | for (i = 0; i < traversed_paths->len; i++) { |
562 | GString *trace_path = g_ptr_array_index(traversed_paths, | |
563 | i); | |
564 | int trace_id = bt_context_add_trace(ctx, | |
565 | trace_path->str, | |
566 | format_str, | |
567 | packet_seek, | |
568 | NULL, | |
569 | NULL); | |
20d24215 | 570 | if (trace_id < 0) { |
7f89ddce | 571 | fprintf(stderr, "[warning] [Context] cannot open trace \"%s\" from %s " |
a99343cf | 572 | "for reading.\n", trace_path->str, path); |
ca718275 | 573 | /* Allow to skip erroneous traces. */ |
b945d4a5 | 574 | ret = 1; /* partial error */ |
a99343cf | 575 | } else { |
fd94f11c | 576 | trace_ids++; |
20d24215 | 577 | } |
a99343cf | 578 | g_string_free(trace_path, TRUE); |
20d24215 YB |
579 | } |
580 | } | |
d0d82191 | 581 | |
a99343cf YB |
582 | g_ptr_array_free(traversed_paths, TRUE); |
583 | traversed_paths = NULL; | |
584 | ||
585 | /* Should unlock traversed paths mutex here if used in multithread */ | |
20d24215 | 586 | |
27cd3890 MD |
587 | /* |
588 | * Return an error if no trace can be opened. | |
589 | */ | |
fd94f11c | 590 | if (trace_ids == 0) { |
27cd3890 | 591 | fprintf(stderr, "[error] Cannot open any trace for reading.\n\n"); |
b945d4a5 | 592 | ret = -ENOENT; /* failure */ |
27cd3890 | 593 | } |
20d24215 YB |
594 | return ret; |
595 | } | |
a44bc4c9 | 596 | |
7237592a MD |
597 | static |
598 | int trace_pre_handler(struct bt_trace_descriptor *td_write, | |
599 | struct bt_context *ctx) | |
600 | { | |
601 | struct ctf_text_stream_pos *sout; | |
602 | struct trace_collection *tc; | |
603 | int ret, i; | |
604 | ||
605 | sout = container_of(td_write, struct ctf_text_stream_pos, | |
606 | trace_descriptor); | |
607 | ||
608 | if (!sout->parent.pre_trace_cb) | |
609 | return 0; | |
610 | ||
611 | tc = ctx->tc; | |
612 | for (i = 0; i < tc->array->len; i++) { | |
613 | struct bt_trace_descriptor *td = | |
614 | g_ptr_array_index(tc->array, i); | |
615 | ||
616 | ret = sout->parent.pre_trace_cb(&sout->parent, td); | |
617 | if (ret) { | |
618 | fprintf(stderr, "[error] Writing to trace pre handler failed.\n"); | |
619 | goto end; | |
620 | } | |
621 | } | |
622 | ret = 0; | |
623 | end: | |
624 | return ret; | |
625 | } | |
626 | ||
627 | static | |
628 | int trace_post_handler(struct bt_trace_descriptor *td_write, | |
629 | struct bt_context *ctx) | |
630 | { | |
631 | struct ctf_text_stream_pos *sout; | |
632 | struct trace_collection *tc; | |
633 | int ret, i; | |
634 | ||
635 | sout = container_of(td_write, struct ctf_text_stream_pos, | |
636 | trace_descriptor); | |
637 | ||
638 | if (!sout->parent.post_trace_cb) | |
639 | return 0; | |
640 | ||
641 | tc = ctx->tc; | |
642 | for (i = 0; i < tc->array->len; i++) { | |
643 | struct bt_trace_descriptor *td = | |
644 | g_ptr_array_index(tc->array, i); | |
645 | ||
646 | ret = sout->parent.post_trace_cb(&sout->parent, td); | |
647 | if (ret) { | |
648 | fprintf(stderr, "[error] Writing to trace post handler failed.\n"); | |
649 | goto end; | |
650 | } | |
651 | } | |
652 | ret = 0; | |
653 | end: | |
654 | return ret; | |
655 | } | |
656 | ||
657 | static | |
1b8455b7 | 658 | int convert_trace(struct bt_trace_descriptor *td_write, |
95d36295 JD |
659 | struct bt_context *ctx) |
660 | { | |
e4195791 | 661 | struct bt_ctf_iter *iter; |
95d36295 | 662 | struct ctf_text_stream_pos *sout; |
c67280bf | 663 | struct bt_iter_pos *begin_pos = NULL, *end_pos = NULL; |
c50d2a7a | 664 | struct bt_ctf_event *ctf_event; |
95d36295 JD |
665 | int ret; |
666 | ||
667 | sout = container_of(td_write, struct ctf_text_stream_pos, | |
668 | trace_descriptor); | |
669 | ||
37ea109a | 670 | if (!sout->parent.event_cb) { |
7237592a | 671 | return 0; |
37ea109a | 672 | } |
7237592a | 673 | |
37ea109a | 674 | if (opt_stream_intersection) { |
61739b39 | 675 | iter = bt_ctf_iter_create_intersect(ctx, &begin_pos, &end_pos); |
37ea109a | 676 | } else { |
c67280bf JG |
677 | begin_pos = bt_iter_create_time_pos(NULL, 0); |
678 | begin_pos->type = BT_SEEK_BEGIN; | |
679 | iter = bt_ctf_iter_create(ctx, begin_pos, NULL); | |
37ea109a | 680 | } |
95d36295 JD |
681 | if (!iter) { |
682 | ret = -1; | |
683 | goto error_iter; | |
684 | } | |
e4195791 | 685 | while ((ctf_event = bt_ctf_iter_read_event(iter))) { |
c50d2a7a | 686 | ret = sout->parent.event_cb(&sout->parent, ctf_event->parent->stream); |
95d36295 | 687 | if (ret) { |
3394d22e | 688 | fprintf(stderr, "[error] Writing event failed.\n"); |
95d36295 JD |
689 | goto end; |
690 | } | |
e4195791 | 691 | ret = bt_iter_next(bt_ctf_get_iter(iter)); |
37ea109a | 692 | if (ret < 0) { |
95d36295 | 693 | goto end; |
37ea109a | 694 | } |
95d36295 JD |
695 | } |
696 | ret = 0; | |
697 | ||
698 | end: | |
e4195791 | 699 | bt_ctf_iter_destroy(iter); |
95d36295 | 700 | error_iter: |
c67280bf JG |
701 | bt_iter_free_pos(begin_pos); |
702 | bt_iter_free_pos(end_pos); | |
95d36295 JD |
703 | return ret; |
704 | } | |
705 | ||
bbefb8dd | 706 | int main(int argc, char **argv) |
34ac0e6c | 707 | { |
4e85cbfd | 708 | int ret, partial_error = 0, open_success = 0; |
37b99bdb | 709 | struct bt_format *fmt_write; |
1b8455b7 | 710 | struct bt_trace_descriptor *td_write; |
95d36295 | 711 | struct bt_context *ctx; |
4e85cbfd MD |
712 | int i; |
713 | ||
714 | opt_input_paths = g_ptr_array_new(); | |
34ac0e6c MD |
715 | |
716 | ret = parse_options(argc, argv); | |
717 | if (ret < 0) { | |
3394d22e MD |
718 | fprintf(stderr, "Error parsing options.\n\n"); |
719 | usage(stderr); | |
4e85cbfd | 720 | g_ptr_array_free(opt_input_paths, TRUE); |
34ac0e6c MD |
721 | exit(EXIT_FAILURE); |
722 | } else if (ret > 0) { | |
4e85cbfd | 723 | g_ptr_array_free(opt_input_paths, TRUE); |
34ac0e6c MD |
724 | exit(EXIT_SUCCESS); |
725 | } | |
726 | printf_verbose("Verbose mode active.\n"); | |
727 | printf_debug("Debug mode active.\n"); | |
728 | ||
9fe26ec7 | 729 | if (opt_input_format) |
bbefb8dd | 730 | strlower(opt_input_format); |
9fe26ec7 | 731 | if (opt_output_format) |
bbefb8dd MD |
732 | strlower(opt_output_format); |
733 | ||
4e85cbfd MD |
734 | printf_verbose("Converting from directory(ies):\n"); |
735 | for (i = 0; i < opt_input_paths->len; i++) { | |
736 | const char *ipath = g_ptr_array_index(opt_input_paths, i); | |
737 | printf_verbose(" %s\n", ipath); | |
738 | } | |
34ac0e6c | 739 | printf_verbose("Converting from format: %s\n", |
b61922b5 | 740 | opt_input_format ? : "ctf <default>"); |
c3e4d5dc | 741 | printf_verbose("Converting to target: %s\n", |
478b6389 | 742 | opt_output_path ? : "<stdout>"); |
34ac0e6c | 743 | printf_verbose("Converting to format: %s\n", |
b61922b5 | 744 | opt_output_format ? : "text <default>"); |
bbefb8dd | 745 | |
11e1d048 MD |
746 | if (!opt_input_format) { |
747 | opt_input_format = strdup("ctf"); | |
748 | if (!opt_input_format) { | |
749 | partial_error = 1; | |
750 | goto end; | |
751 | } | |
752 | } | |
753 | if (!opt_output_format) { | |
754 | opt_output_format = strdup("text"); | |
755 | if (!opt_output_format) { | |
756 | partial_error = 1; | |
757 | goto end; | |
758 | } | |
759 | } | |
bbefb8dd | 760 | fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format)); |
34d99418 | 761 | if (!fmt_read) { |
3394d22e | 762 | fprintf(stderr, "[error] Format \"%s\" is not supported.\n\n", |
bbefb8dd | 763 | opt_input_format); |
11e1d048 MD |
764 | partial_error = 1; |
765 | goto end; | |
bbefb8dd | 766 | } |
bbefb8dd MD |
767 | fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format)); |
768 | if (!fmt_write) { | |
3394d22e | 769 | fprintf(stderr, "[error] format \"%s\" is not supported.\n\n", |
bbefb8dd | 770 | opt_output_format); |
11e1d048 MD |
771 | partial_error = 1; |
772 | goto end; | |
bbefb8dd MD |
773 | } |
774 | ||
6cba487f | 775 | ctx = bt_context_create(); |
d63c2d51 JD |
776 | if (!ctx) { |
777 | goto error_td_read; | |
778 | } | |
6cba487f | 779 | |
4e85cbfd MD |
780 | for (i = 0; i < opt_input_paths->len; i++) { |
781 | const char *ipath = g_ptr_array_index(opt_input_paths, i); | |
782 | ret = bt_context_add_traces_recursive(ctx, ipath, | |
783 | opt_input_format, NULL); | |
784 | if (ret < 0) { | |
785 | fprintf(stderr, "[error] opening trace \"%s\" for reading.\n\n", | |
786 | ipath); | |
787 | } else if (ret > 0) { | |
788 | fprintf(stderr, "[warning] errors occurred when opening trace \"%s\" for reading, continuing anyway.\n\n", | |
789 | ipath); | |
790 | open_success = 1; /* some traces were OK */ | |
791 | partial_error = 1; | |
792 | } else { | |
793 | open_success = 1; /* all traces were OK */ | |
794 | } | |
795 | } | |
796 | if (!open_success) { | |
797 | fprintf(stderr, "[error] none of the specified trace paths could be opened.\n\n"); | |
bbefb8dd MD |
798 | goto error_td_read; |
799 | } | |
6cba487f | 800 | |
5b80ddfb | 801 | td_write = fmt_write->open_trace(opt_output_path, O_RDWR, NULL, NULL); |
bbefb8dd | 802 | if (!td_write) { |
3394d22e | 803 | fprintf(stderr, "Error opening trace \"%s\" for writing.\n\n", |
b61922b5 | 804 | opt_output_path ? : "<none>"); |
bbefb8dd MD |
805 | goto error_td_write; |
806 | } | |
847bf71a | 807 | |
24d5af5b MD |
808 | /* |
809 | * Errors happened when opening traces, but we continue anyway. | |
810 | * sleep to let user see the stderr output before stdout. | |
811 | */ | |
4e85cbfd | 812 | if (partial_error) |
24d5af5b | 813 | sleep(PARTIAL_ERROR_SLEEP); |
24d5af5b | 814 | |
7237592a MD |
815 | ret = trace_pre_handler(td_write, ctx); |
816 | if (ret) { | |
817 | fprintf(stderr, "Error in trace pre handle.\n\n"); | |
818 | goto error_copy_trace; | |
819 | } | |
820 | ||
34d99418 JD |
821 | /* For now, we support only CTF iterators */ |
822 | if (fmt_read->name == g_quark_from_static_string("ctf")) { | |
823 | ret = convert_trace(td_write, ctx); | |
824 | if (ret) { | |
825 | fprintf(stderr, "Error printing trace.\n\n"); | |
826 | goto error_copy_trace; | |
827 | } | |
46322b33 | 828 | } |
847bf71a | 829 | |
7237592a MD |
830 | ret = trace_post_handler(td_write, ctx); |
831 | if (ret) { | |
832 | fprintf(stderr, "Error in trace post handle.\n\n"); | |
833 | goto error_copy_trace; | |
834 | } | |
835 | ||
bbefb8dd | 836 | fmt_write->close_trace(td_write); |
6cba487f MD |
837 | |
838 | bt_context_put(ctx); | |
afb48eae AA |
839 | printf_verbose("finished converting. Output written to:\n%s\n", |
840 | opt_output_path ? : "<stdout>"); | |
11e1d048 | 841 | goto end; |
34ac0e6c | 842 | |
bbefb8dd | 843 | /* Error handling */ |
46322b33 | 844 | error_copy_trace: |
bbefb8dd MD |
845 | fmt_write->close_trace(td_write); |
846 | error_td_write: | |
6cba487f | 847 | bt_context_put(ctx); |
bbefb8dd | 848 | error_td_read: |
11e1d048 MD |
849 | partial_error = 1; |
850 | ||
851 | /* teardown and exit */ | |
852 | end: | |
853 | free(opt_input_format); | |
854 | free(opt_output_format); | |
9fe26ec7 | 855 | free(opt_output_path); |
3be1e3c9 | 856 | free(opt_debug_info_dir); |
b7b61ced | 857 | free(opt_debug_info_target_prefix); |
4e85cbfd | 858 | g_ptr_array_free(opt_input_paths, TRUE); |
11e1d048 MD |
859 | if (partial_error) |
860 | exit(EXIT_FAILURE); | |
861 | else | |
862 | exit(EXIT_SUCCESS); | |
4c8bfb7e | 863 | } |