Fix: passing null to closedir() on error
[lttng-tools.git] / src / bin / lttng-crash / lttng-crash.c
CommitLineData
d7ba1388
MD
1/*
2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2014 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17 */
18
d7ba1388
MD
19#include <getopt.h>
20#include <signal.h>
21#include <stdio.h>
22#include <stdlib.h>
23#include <string.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26#include <sys/stat.h>
27#include <sys/mman.h>
28#include <fcntl.h>
29#include <sys/wait.h>
30#include <unistd.h>
d7ba1388
MD
31#include <ctype.h>
32#include <dirent.h>
33#include <byteswap.h>
34#include <inttypes.h>
aa25d686 35#include <stdbool.h>
d7ba1388
MD
36
37#include <version.h>
38#include <lttng/lttng.h>
39#include <common/common.h>
6ef14df5 40#include <common/utils.h>
d7ba1388
MD
41
42#define DEFAULT_VIEWER "babeltrace"
43
44#define COPY_BUFLEN 4096
45#define RB_CRASH_DUMP_ABI_LEN 32
46
47#define RB_CRASH_DUMP_ABI_MAGIC_LEN 16
48
49/*
50 * The 128-bit magic number is xor'd in the process data so it does not
51 * cause a false positive when searching for buffers by scanning memory.
52 * The actual magic number is:
53 * 0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17, 0x7B, 0xF1,
54 * 0x77, 0xBF, 0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17,
55 */
56#define RB_CRASH_DUMP_ABI_MAGIC_XOR \
57 { \
58 0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF, 0x77 ^ 0xFF, \
59 0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF, \
60 0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF, \
61 0xF1 ^ 0xFF, 0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF, \
62 }
63
4fc83d94
PP
64static const char *help_msg =
65#ifdef LTTNG_EMBED_HELP
66#include <lttng-crash.1.h>
67#else
68NULL
69#endif
70;
71
d7ba1388
MD
72/*
73 * Non-static to ensure the compiler does not optimize away the xor.
74 */
75uint8_t lttng_crash_expected_magic_xor[] = RB_CRASH_DUMP_ABI_MAGIC_XOR;
76
77#define RB_CRASH_ENDIAN 0x1234
78#define RB_CRASH_ENDIAN_REVERSE 0x3412
79
80enum lttng_crash_type {
81 LTTNG_CRASH_TYPE_UST = 0,
82 LTTNG_CRASH_TYPE_KERNEL = 1,
83};
84
85/* LTTng ring buffer defines (copied) */
86
87#define HALF_ULONG_BITS(wl) (((wl) * CHAR_BIT) >> 1)
88
89#define SB_ID_OFFSET_SHIFT(wl) (HALF_ULONG_BITS(wl) + 1)
90#define SB_ID_OFFSET_COUNT(wl) (1UL << SB_ID_OFFSET_SHIFT(wl))
91#define SB_ID_OFFSET_MASK(wl) (~(SB_ID_OFFSET_COUNT(wl) - 1))
92/*
93 * Lowest bit of top word half belongs to noref. Used only for overwrite mode.
94 */
95#define SB_ID_NOREF_SHIFT(wl) (SB_ID_OFFSET_SHIFT(wl) - 1)
96#define SB_ID_NOREF_COUNT(wl) (1UL << SB_ID_NOREF_SHIFT(wl))
97#define SB_ID_NOREF_MASK(wl) SB_ID_NOREF_COUNT(wl)
98/*
99 * In overwrite mode: lowest half of word is used for index.
100 * Limit of 2^16 subbuffers per buffer on 32-bit, 2^32 on 64-bit.
101 * In producer-consumer mode: whole word used for index.
102 */
103#define SB_ID_INDEX_SHIFT(wl) 0
104#define SB_ID_INDEX_COUNT(wl) (1UL << SB_ID_INDEX_SHIFT(wl))
105#define SB_ID_INDEX_MASK(wl) (SB_ID_NOREF_COUNT(wl) - 1)
106
107enum rb_modes {
108 RING_BUFFER_OVERWRITE = 0, /* Overwrite when buffer full */
109 RING_BUFFER_DISCARD = 1, /* Discard when buffer full */
110};
111
112struct crash_abi_unknown {
113 uint8_t magic[RB_CRASH_DUMP_ABI_MAGIC_LEN];
8726a045 114 uint64_t mmap_length; /* Overall length of crash record */
d7ba1388
MD
115 uint16_t endian; /*
116 * { 0x12, 0x34 }: big endian
117 * { 0x34, 0x12 }: little endian
118 */
119 uint16_t major; /* Major number. */
120 uint16_t minor; /* Minor number. */
121 uint8_t word_size; /* Word size (bytes). */
122 uint8_t layout_type; /* enum lttng_crash_layout */
123} __attribute__((packed));
124
125struct crash_abi_0_0 {
126 struct crash_abi_unknown parent;
127
128 struct {
129 uint32_t prod_offset;
130 uint32_t consumed_offset;
131 uint32_t commit_hot_array;
132 uint32_t commit_hot_seq;
133 uint32_t buf_wsb_array;
134 uint32_t buf_wsb_id;
135 uint32_t sb_array;
136 uint32_t sb_array_shmp_offset;
137 uint32_t sb_backend_p_offset;
138 uint32_t content_size;
139 uint32_t packet_size;
140 } __attribute__((packed)) offset;
141 struct {
142 uint8_t prod_offset;
143 uint8_t consumed_offset;
144 uint8_t commit_hot_seq;
145 uint8_t buf_wsb_id;
146 uint8_t sb_array_shmp_offset;
147 uint8_t sb_backend_p_offset;
148 uint8_t content_size;
149 uint8_t packet_size;
150 } __attribute__((packed)) length;
151 struct {
152 uint32_t commit_hot_array;
153 uint32_t buf_wsb_array;
154 uint32_t sb_array;
155 } __attribute__((packed)) stride;
156
157 uint64_t buf_size; /* Size of the buffer */
158 uint64_t subbuf_size; /* Sub-buffer size */
159 uint64_t num_subbuf; /* Number of sub-buffers for writer */
160 uint32_t mode; /* Buffer mode: 0: overwrite, 1: discard */
161} __attribute__((packed));
162
163struct lttng_crash_layout {
164 struct {
165 int prod_offset, consumed_offset,
166 commit_hot_array, commit_hot_seq,
167 buf_wsb_array, buf_wsb_id,
168 sb_array, sb_array_shmp_offset,
169 sb_backend_p_offset, content_size,
170 packet_size;
171 } offset;
172 struct {
173 int prod_offset, consumed_offset,
174 commit_hot_seq, buf_wsb_id,
175 sb_array_shmp_offset, sb_backend_p_offset,
176 content_size, packet_size;
177 } length;
178 struct {
179 int commit_hot_array, buf_wsb_array, sb_array;
180 } stride;
181
182 int reverse_byte_order;
183 int word_size;
184
185 uint64_t mmap_length; /* Length of crash record */
186 uint64_t buf_size; /* Size of the buffer */
187 uint64_t subbuf_size; /* Sub-buffer size */
188 uint64_t num_subbuf; /* Number of sub-buffers for writer */
189 uint32_t mode; /* Buffer mode: 0: overwrite, 1: discard */
190};
191
192/* Variables */
193static char *progname,
9030e9a9
AB
194 *opt_viewer_path = NULL,
195 *opt_output_path = NULL;
d7ba1388 196
a424227e 197static char *input_path;
d7ba1388
MD
198
199int lttng_opt_quiet, lttng_opt_verbose, lttng_opt_mi;
200
201enum {
202 OPT_DUMP_OPTIONS,
203};
204
205/* Getopt options. No first level command. */
206static struct option long_options[] = {
207 { "version", 0, NULL, 'V' },
208 { "help", 0, NULL, 'h' },
209 { "verbose", 0, NULL, 'v' },
210 { "viewer", 1, NULL, 'e' },
211 { "extract", 1, NULL, 'x' },
212 { "list-options", 0, NULL, OPT_DUMP_OPTIONS },
213 { NULL, 0, NULL, 0 },
214};
215
6ef14df5 216static void usage(void)
d7ba1388 217{
4fc83d94 218 int ret = utils_show_help(1, "lttng-crash", help_msg);
6ef14df5
PP
219
220 if (ret) {
4fc83d94 221 ERR("Cannot show --help for `lttng-crash`");
6ef14df5
PP
222 perror("exec");
223 exit(EXIT_FAILURE);
224 }
d7ba1388
MD
225}
226
227static void version(FILE *ofp)
228{
229 fprintf(ofp, "%s (LTTng Crash Trace Viewer) " VERSION " - " VERSION_NAME
230"%s\n",
231 progname,
232 GIT_VERSION[0] == '\0' ? "" : " - " GIT_VERSION);
233}
234
235/*
236 * list_options
237 *
238 * List options line by line. This is mostly for bash auto completion and to
239 * avoid difficult parsing.
240 */
241static void list_options(FILE *ofp)
242{
243 int i = 0;
244 struct option *option = NULL;
245
246 option = &long_options[i];
247 while (option->name != NULL) {
248 fprintf(ofp, "--%s\n", option->name);
249
250 if (isprint(option->val)) {
251 fprintf(ofp, "-%c\n", option->val);
252 }
253
254 i++;
255 option = &long_options[i];
256 }
257}
258
259/*
260 * Parse command line arguments.
261 *
262 * Return 0 if OK, else -1
263 */
264static int parse_args(int argc, char **argv)
265{
266 int opt, ret = 0;
267
268 if (argc < 2) {
6ef14df5 269 usage();
d7ba1388
MD
270 exit(EXIT_FAILURE);
271 }
272
d07f3d99 273 while ((opt = getopt_long(argc, argv, "+Vhve:x:", long_options, NULL)) != -1) {
d7ba1388
MD
274 switch (opt) {
275 case 'V':
276 version(stdout);
277 ret = 1;
278 goto end;
279 case 'h':
6ef14df5 280 usage();
d7ba1388
MD
281 ret = 1;
282 goto end;
283 case 'v':
284 /* There is only 3 possible level of verbosity. (-vvv) */
285 if (lttng_opt_verbose < 3) {
286 lttng_opt_verbose += 1;
287 }
288 break;
289 case 'e':
9030e9a9 290 free(opt_viewer_path);
d7ba1388
MD
291 opt_viewer_path = strdup(optarg);
292 break;
293 case 'x':
9030e9a9 294 free(opt_output_path);
d7ba1388
MD
295 opt_output_path = strdup(optarg);
296 break;
297 case OPT_DUMP_OPTIONS:
298 list_options(stdout);
299 ret = 1;
300 goto end;
301 default:
6ef14df5 302 ERR("Unknown command-line option");
d7ba1388
MD
303 goto error;
304 }
305 }
306
9030e9a9
AB
307 if (!opt_viewer_path) {
308 opt_viewer_path = DEFAULT_VIEWER;
309 }
310
a424227e 311 /* No leftovers, or more than one input path, print usage and quit */
6ef14df5
PP
312 if (argc - optind != 1) {
313 ERR("Command-line error: Specify exactly one input path");
d7ba1388
MD
314 goto error;
315 }
316
a424227e 317 input_path = argv[optind];
d7ba1388
MD
318end:
319 return ret;
320
321error:
322 return -1;
323}
324
325static
326int copy_file(const char *file_dest, const char *file_src)
327{
8726a045 328 int fd_src = -1, fd_dest = -1;
d7ba1388
MD
329 ssize_t readlen, writelen;
330 char buf[COPY_BUFLEN];
8726a045 331 int ret;
d7ba1388
MD
332
333 DBG("Copy metadata file '%s' into '%s'", file_src, file_dest);
334
335 fd_src = open(file_src, O_RDONLY);
336 if (fd_src < 0) {
337 PERROR("Error opening %s for reading", file_src);
8726a045
JR
338 ret = -errno;
339 goto error;
d7ba1388
MD
340 }
341 fd_dest = open(file_dest, O_RDWR | O_CREAT | O_EXCL,
342 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
343 if (fd_dest < 0) {
344 PERROR("Error opening %s for writing", file_dest);
8726a045
JR
345 ret = -errno;
346 goto error;
d7ba1388
MD
347 }
348
349 for (;;) {
350 readlen = lttng_read(fd_src, buf, COPY_BUFLEN);
351 if (readlen < 0) {
352 PERROR("Error reading input file");
8726a045
JR
353 ret = -1;
354 goto error;
d7ba1388
MD
355 }
356 if (!readlen) {
357 break;
358 }
359 writelen = lttng_write(fd_dest, buf, readlen);
360 if (writelen < readlen) {
361 PERROR("Error writing to output file");
8726a045
JR
362 ret = -1;
363 goto error;
364 }
365 }
366
367 ret = 0;
368error:
369 if (fd_src >= 0) {
370 if (close(fd_src) < 0) {
371 PERROR("Error closing %s", file_src);
372 }
373 }
374
375 if (fd_dest >= 0) {
376 if (close(fd_dest) < 0) {
377 PERROR("Error closing %s", file_dest);
d7ba1388
MD
378 }
379 }
8726a045 380 return ret;
d7ba1388
MD
381}
382
383static
384uint64_t _crash_get_field(const struct lttng_crash_layout *layout,
385 const char *ptr, size_t size)
386{
387 switch (size) {
388 case 1: return *(uint8_t *) ptr;
389 case 2: if (layout->reverse_byte_order) {
390 return __bswap_16(*(uint16_t *) ptr);
391 } else {
392 return *(uint16_t *) ptr;
393
394 }
395 case 4: if (layout->reverse_byte_order) {
396 return __bswap_32(*(uint32_t *) ptr);
397 } else {
398 return *(uint32_t *) ptr;
399
400 }
401 case 8: if (layout->reverse_byte_order) {
402 return __bswap_64(*(uint64_t *) ptr);
403 } else {
404 return *(uint64_t *) ptr;
405 }
406 default:
407 abort();
408 return -1;
409 }
410
411}
412
413#define crash_get_field(layout, map, name) \
414 _crash_get_field(layout, (map) + (layout)->offset.name, \
415 layout->length.name)
416
417#define crash_get_array_field(layout, map, array_name, idx, field_name) \
418 _crash_get_field(layout, \
419 (map) + (layout)->offset.array_name \
420 + (idx * (layout)->stride.array_name) \
421 + (layout)->offset.field_name, \
422 (layout)->length.field_name)
423
424#define crash_get_hdr_raw_field(layout, hdr, name) ((hdr)->name)
425
426#define crash_get_hdr_field(layout, hdr, name) \
427 _crash_get_field(layout, (const char *) &(hdr)->name, \
428 sizeof((hdr)->name))
429
430#define crash_get_layout(layout, hdr, name) \
431 do { \
432 (layout)->name = crash_get_hdr_field(layout, hdr, \
433 name); \
434 DBG("layout.%s = %" PRIu64, #name, \
435 (uint64_t) (layout)->name); \
436 } while (0)
437
438static
439int get_crash_layout_0_0(struct lttng_crash_layout *layout,
440 char *map)
441{
442 const struct crash_abi_0_0 *abi = (const struct crash_abi_0_0 *) map;
443
444 crash_get_layout(layout, abi, offset.prod_offset);
445 crash_get_layout(layout, abi, offset.consumed_offset);
446 crash_get_layout(layout, abi, offset.commit_hot_array);
447 crash_get_layout(layout, abi, offset.commit_hot_seq);
448 crash_get_layout(layout, abi, offset.buf_wsb_array);
449 crash_get_layout(layout, abi, offset.buf_wsb_id);
450 crash_get_layout(layout, abi, offset.sb_array);
451 crash_get_layout(layout, abi, offset.sb_array_shmp_offset);
452 crash_get_layout(layout, abi, offset.sb_backend_p_offset);
453 crash_get_layout(layout, abi, offset.content_size);
454 crash_get_layout(layout, abi, offset.packet_size);
455
456 crash_get_layout(layout, abi, length.prod_offset);
457 crash_get_layout(layout, abi, length.consumed_offset);
458 crash_get_layout(layout, abi, length.commit_hot_seq);
459 crash_get_layout(layout, abi, length.buf_wsb_id);
460 crash_get_layout(layout, abi, length.sb_array_shmp_offset);
461 crash_get_layout(layout, abi, length.sb_backend_p_offset);
462 crash_get_layout(layout, abi, length.content_size);
463 crash_get_layout(layout, abi, length.packet_size);
464
465 crash_get_layout(layout, abi, stride.commit_hot_array);
466 crash_get_layout(layout, abi, stride.buf_wsb_array);
467 crash_get_layout(layout, abi, stride.sb_array);
468
469 crash_get_layout(layout, abi, buf_size);
470 crash_get_layout(layout, abi, subbuf_size);
471 crash_get_layout(layout, abi, num_subbuf);
472 crash_get_layout(layout, abi, mode);
473
474 return 0;
475}
476
477static
478void print_dbg_magic(const uint8_t *magic)
479{
480 DBG("magic: 0x%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X",
481 magic[0], magic[1], magic[2], magic[3],
482 magic[4], magic[5], magic[6], magic[7],
483 magic[8], magic[9], magic[10], magic[11],
484 magic[12], magic[13], magic[14], magic[15]);
485}
486
487static
488int check_magic(const uint8_t *magic)
489{
490 int i;
491
492 for (i = 0; i < RB_CRASH_DUMP_ABI_MAGIC_LEN; i++) {
493 if ((magic[i] ^ 0xFF) != lttng_crash_expected_magic_xor[i]) {
494 return -1;
495 }
496 }
497 return 0;
498}
499
500static
501int get_crash_layout(struct lttng_crash_layout *layout, int fd)
502{
503 char *map;
504 int ret = 0, unmapret;
505 const uint8_t *magic;
506 uint64_t mmap_length;
507 uint16_t major, minor;
508 uint8_t word_size;
509 const struct crash_abi_unknown *abi;
510 uint16_t endian;
511 enum lttng_crash_type layout_type;
512
513 map = mmap(NULL, RB_CRASH_DUMP_ABI_LEN, PROT_READ, MAP_PRIVATE,
514 fd, 0);
515 if (map == MAP_FAILED) {
516 PERROR("Mapping file");
517 return -1;
518 }
519 abi = (const struct crash_abi_unknown *) map;
520 magic = crash_get_hdr_raw_field(layout, abi, magic);
521 print_dbg_magic(magic);
522 if (check_magic(magic)) {
523 DBG("Unknown magic number");
524 ret = 1; /* positive return value, skip */
525 goto end;
526 }
527 endian = crash_get_hdr_field(layout, abi, endian);
528 switch (endian) {
529 case RB_CRASH_ENDIAN:
530 break;
531 case RB_CRASH_ENDIAN_REVERSE:
532 layout->reverse_byte_order = 1;
533 break;
534 default:
535 DBG("Unknown endianness value: 0x%X", (unsigned int) endian);
536 ret = 1; /* positive return value, skip */
537 goto end;
538 }
539 layout_type = (enum lttng_crash_type) crash_get_hdr_field(layout, abi, layout_type);
540 switch (layout_type) {
541 case LTTNG_CRASH_TYPE_UST:
542 break;
543 case LTTNG_CRASH_TYPE_KERNEL:
544 ERR("lttng-modules buffer layout support not implemented");
545 ret = 1; /* positive return value, skip */
546 goto end;
547 default:
548 ERR("Unknown layout type %u", (unsigned int) layout_type);
549 ret = 1; /* positive return value, skip */
550 goto end;
551 }
552 mmap_length = crash_get_hdr_field(layout, abi, mmap_length);
553 DBG("mmap_length: %" PRIu64, mmap_length);
554 layout->mmap_length = mmap_length;
555 major = crash_get_hdr_field(layout, abi, major);
556 DBG("major: %u", major);
557 minor = crash_get_hdr_field(layout, abi, minor);
558 DBG("minor: %u", minor);
559 word_size = crash_get_hdr_field(layout, abi, word_size);
560 DBG("word_size: %u", word_size);
561 switch (major) {
562 case 0:
563 switch (minor) {
564 case 0:
565 ret = get_crash_layout_0_0(layout, map);
566 if (ret)
567 goto end;
568 break;
569 default:
570 ret = -1;
571 ERR("Unsupported crash ABI %u.%u\n", major, minor);
572 goto end;
573 }
574 break;
575 default:
576 ERR("Unsupported crash ABI %u.%u\n", major, minor);
577 ret = -1;
578 goto end;
579 }
580 layout->word_size = word_size;
581end:
582 unmapret = munmap(map, RB_CRASH_DUMP_ABI_LEN);
583 if (unmapret) {
584 PERROR("munmap");
585 }
586 return ret;
587}
588
589/* buf_trunc mask selects only the buffer number. */
590static inline
591uint64_t buf_trunc(uint64_t offset, uint64_t buf_size)
592{
593 return offset & ~(buf_size - 1);
594}
595
596/* subbuf_trunc mask selects the subbuffer number. */
597static inline
598uint64_t subbuf_trunc(uint64_t offset, uint64_t subbuf_size)
599{
600 return offset & ~(subbuf_size - 1);
601}
602
603/* buf_offset mask selects only the offset within the current buffer. */
604static inline
605uint64_t buf_offset(uint64_t offset, uint64_t buf_size)
606{
607 return offset & (buf_size - 1);
608}
609
610/* subbuf_offset mask selects the offset within the current subbuffer. */
611static inline
612uint64_t subbuf_offset(uint64_t offset, uint64_t subbuf_size)
613{
614 return offset & (subbuf_size - 1);
615}
616
617/* subbuf_index returns the index of the current subbuffer within the buffer. */
618static inline
619uint64_t subbuf_index(uint64_t offset, uint64_t buf_size, uint64_t subbuf_size)
620{
621 return buf_offset(offset, buf_size) / subbuf_size;
622}
623
624static inline
625uint64_t subbuffer_id_get_index(uint32_t mode, uint64_t id,
626 unsigned int wl)
627{
628 if (mode == RING_BUFFER_OVERWRITE)
629 return id & SB_ID_INDEX_MASK(wl);
630 else
631 return id;
632}
633
634static
635int copy_crash_subbuf(const struct lttng_crash_layout *layout,
636 int fd_dest, char *buf, uint64_t offset)
637{
638 uint64_t buf_size, subbuf_size, num_subbuf, sbidx, id,
639 sb_bindex, rpages_offset, p_offset, seq_cc,
640 committed, commit_count_mask, consumed_cur,
641 packet_size;
642 char *subbuf_ptr;
643 ssize_t writelen;
644
645 /*
646 * Get the current subbuffer by applying the proper mask to
647 * "offset", and looking up the subbuf location within the
648 * source file buf.
649 */
650
651 buf_size = layout->buf_size;
652 subbuf_size = layout->subbuf_size;
653 num_subbuf = layout->num_subbuf;
654
655 switch (layout->word_size) {
656 case 4: commit_count_mask = 0xFFFFFFFFULL / num_subbuf;
657 break;
658 case 8: commit_count_mask = 0xFFFFFFFFFFFFFFFFULL / num_subbuf;
659 break;
660 default:
661 ERR("Unsupported word size: %u",
662 (unsigned int) layout->word_size);
663 return -EINVAL;
664 }
665
5f98d630 666 DBG("Copy crash subbuffer at offset %" PRIu64, offset);
d7ba1388
MD
667 sbidx = subbuf_index(offset, buf_size, subbuf_size);
668
669 /*
670 * Find where the seq cc is located. Compute length of data to
671 * copy.
672 */
673 seq_cc = crash_get_array_field(layout, buf, commit_hot_array,
674 sbidx, commit_hot_seq);
675 consumed_cur = crash_get_field(layout, buf, consumed_offset);
676
677 /*
678 * Check that the buffer we are getting is after or at
679 * consumed_cur position.
680 */
681 if ((long) subbuf_trunc(offset, subbuf_size)
682 - (long) subbuf_trunc(consumed_cur, subbuf_size) < 0) {
683 DBG("No data: position is before consumed_cur");
684 goto nodata;
685 }
686
687 /*
688 * Check if subbuffer has been fully committed.
689 */
690 if (((seq_cc - subbuf_size) & commit_count_mask)
691 - (buf_trunc(offset, buf_size) / num_subbuf)
692 == 0) {
693 committed = subbuf_size;
694 } else {
695 committed = subbuf_offset(seq_cc, subbuf_size);
696 if (!committed) {
697 DBG("No data committed, seq_cc: %" PRIu64, seq_cc);
698 goto nodata;
699 }
700 }
701
702 /* Find actual physical offset in subbuffer table */
703 id = crash_get_array_field(layout, buf, buf_wsb_array,
704 sbidx, buf_wsb_id);
705 sb_bindex = subbuffer_id_get_index(layout->mode, id,
706 layout->word_size);
707 rpages_offset = crash_get_array_field(layout, buf, sb_array,
708 sb_bindex, sb_array_shmp_offset);
709 p_offset = crash_get_field(layout, buf + rpages_offset,
710 sb_backend_p_offset);
711 subbuf_ptr = buf + p_offset;
712
713 if (committed == subbuf_size) {
714 /*
715 * Packet header can be used.
716 */
717 if (layout->length.packet_size) {
718 memcpy(&packet_size,
719 subbuf_ptr + layout->offset.packet_size,
720 layout->length.packet_size);
721 if (layout->reverse_byte_order) {
722 packet_size = __bswap_64(packet_size);
723 }
724 packet_size /= CHAR_BIT;
725 } else {
726 packet_size = subbuf_size;
727 }
728 } else {
729 uint64_t patch_size;
730
731 /*
732 * Find where to patch the sub-buffer header with actual
733 * readable data len and packet len, derived from seq
734 * cc. Patch it in our in-memory copy.
735 */
736 patch_size = committed * CHAR_BIT;
737 if (layout->reverse_byte_order) {
738 patch_size = __bswap_64(patch_size);
739 }
740 if (layout->length.content_size) {
741 memcpy(subbuf_ptr + layout->offset.content_size,
742 &patch_size, layout->length.content_size);
743 }
744 if (layout->length.packet_size) {
745 memcpy(subbuf_ptr + layout->offset.packet_size,
746 &patch_size, layout->length.packet_size);
747 }
748 packet_size = committed;
749 }
750
751 /*
752 * Copy packet into fd_dest.
753 */
754 writelen = lttng_write(fd_dest, subbuf_ptr, packet_size);
755 if (writelen < packet_size) {
756 PERROR("Error writing to output file");
757 return -1;
758 }
759 DBG("Copied %" PRIu64 " bytes of data", packet_size);
760 return 0;
761
762nodata:
763 return -ENODATA;
764}
765
766static
767int copy_crash_data(const struct lttng_crash_layout *layout, int fd_dest,
768 int fd_src)
769{
770 char *buf;
771 int ret = 0, has_data = 0;
772 struct stat statbuf;
773 size_t src_file_len;
774 uint64_t prod_offset, consumed_offset;
775 uint64_t offset, subbuf_size;
776 ssize_t readlen;
777
778 ret = fstat(fd_src, &statbuf);
779 if (ret) {
780 return ret;
781 }
782 src_file_len = layout->mmap_length;
783 buf = zmalloc(src_file_len);
784 if (!buf) {
785 return -1;
786 }
787 readlen = lttng_read(fd_src, buf, src_file_len);
788 if (readlen < 0) {
789 PERROR("Error reading input file");
309fc9bf
MD
790 ret = -1;
791 goto end;
d7ba1388
MD
792 }
793
794 prod_offset = crash_get_field(layout, buf, prod_offset);
795 DBG("prod_offset: 0x%" PRIx64, prod_offset);
796 consumed_offset = crash_get_field(layout, buf, consumed_offset);
797 DBG("consumed_offset: 0x%" PRIx64, consumed_offset);
798 subbuf_size = layout->subbuf_size;
799
800 for (offset = consumed_offset; offset < prod_offset;
801 offset += subbuf_size) {
802 ret = copy_crash_subbuf(layout, fd_dest, buf, offset);
803 if (!ret) {
804 has_data = 1;
805 }
806 if (ret) {
807 goto end;
808 }
809 }
810end:
811 free(buf);
812 if (ret && ret != -ENODATA) {
813 return ret;
814 }
815 if (has_data) {
816 return 0;
817 } else {
818 return -ENODATA;
819 }
820}
821
822static
823int extract_file(int output_dir_fd, const char *output_file,
824 int input_dir_fd, const char *input_file)
825{
826 int fd_dest, fd_src, ret = 0, closeret;
827 struct lttng_crash_layout layout;
828
829 layout.reverse_byte_order = 0; /* For reading magic number */
830
831 DBG("Extract file '%s'", input_file);
832 fd_src = openat(input_dir_fd, input_file, O_RDONLY);
833 if (fd_src < 0) {
834 PERROR("Error opening '%s' for reading",
835 input_file);
836 ret = -1;
837 goto end;
838 }
839
840 /* Query the crash ABI layout */
841 ret = get_crash_layout(&layout, fd_src);
842 if (ret) {
843 goto close_src;
844 }
845
846 fd_dest = openat(output_dir_fd, output_file,
847 O_RDWR | O_CREAT | O_EXCL,
848 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
849 if (fd_dest < 0) {
850 PERROR("Error opening '%s' for writing",
851 output_file);
852 ret = -1;
853 goto close_src;
854 }
855
856 ret = copy_crash_data(&layout, fd_dest, fd_src);
857 if (ret) {
858 goto close_dest;
859 }
860
861close_dest:
862 closeret = close(fd_dest);
863 if (closeret) {
864 PERROR("close");
865 }
866 if (ret == -ENODATA) {
867 closeret = unlinkat(output_dir_fd, output_file, 0);
868 if (closeret) {
869 PERROR("unlinkat");
870 }
871 }
872close_src:
873 closeret = close(fd_src);
874 if (closeret) {
875 PERROR("close");
876 }
877end:
878 return ret;
879}
880
881static
882int extract_all_files(const char *output_path,
883 const char *input_path)
884{
885 DIR *input_dir, *output_dir;
886 int input_dir_fd, output_dir_fd, ret = 0, closeret;
887 struct dirent *entry; /* input */
888
889 /* Open input directory */
890 input_dir = opendir(input_path);
891 if (!input_dir) {
892 PERROR("Cannot open '%s' path", input_path);
893 return -1;
894 }
895 input_dir_fd = dirfd(input_dir);
896 if (input_dir_fd < 0) {
897 PERROR("dirfd");
898 return -1;
899 }
900
901 /* Open output directory */
902 output_dir = opendir(output_path);
903 if (!output_dir) {
904 PERROR("Cannot open '%s' path", output_path);
905 return -1;
906 }
907 output_dir_fd = dirfd(output_dir);
908 if (output_dir_fd < 0) {
909 PERROR("dirfd");
910 return -1;
911 }
912
913 while ((entry = readdir(input_dir))) {
914 if (!strcmp(entry->d_name, ".")
915 || !strcmp(entry->d_name, ".."))
916 continue;
917 ret = extract_file(output_dir_fd, entry->d_name,
918 input_dir_fd, entry->d_name);
919 if (ret == -ENODATA) {
920 DBG("No data in file '%s', skipping", entry->d_name);
921 ret = 0;
922 continue;
923 } else if (ret < 0) {
924 break;
925 } else if (ret > 0) {
926 DBG("Skipping file '%s'", entry->d_name);
927 ret = 0;
928 continue;
929 }
930 }
931 closeret = closedir(output_dir);
932 if (closeret) {
933 PERROR("closedir");
934 }
935 closeret = closedir(input_dir);
936 if (closeret) {
937 PERROR("closedir");
938 }
939 return ret;
940}
941
942static
943int extract_one_trace(const char *output_path,
944 const char *input_path)
945{
946 char dest[PATH_MAX], src[PATH_MAX];
947 int ret;
948
949 DBG("Extract crash trace '%s' into '%s'", input_path, output_path);
950
951 /* Copy metadata */
952 strncpy(dest, output_path, PATH_MAX);
953 dest[PATH_MAX - 1] = '\0';
954 strncat(dest, "/metadata", PATH_MAX - strlen(dest) - 1);
955
956 strncpy(src, input_path, PATH_MAX);
957 src[PATH_MAX - 1] = '\0';
958 strncat(src, "/metadata", PATH_MAX - strlen(dest) - 1);
959
960 ret = copy_file(dest, src);
961 if (ret) {
962 return ret;
963 }
964
965 /* Extract each other file that has expected header */
966 return extract_all_files(output_path, input_path);
967}
968
969static
a424227e
MD
970int extract_trace_recursive(const char *output_path,
971 const char *input_path)
d7ba1388 972{
a424227e
MD
973 DIR *dir;
974 int dir_fd, ret = 0, closeret;
975 struct dirent *entry;
88ae485a 976 size_t path_len;
d7ba1388
MD
977 int has_warning = 0;
978
a424227e
MD
979 /* Open directory */
980 dir = opendir(input_path);
981 if (!dir) {
982 PERROR("Cannot open '%s' path", input_path);
983 return -1;
984 }
88ae485a
JR
985
986 path_len = strlen(input_path);
987
a424227e
MD
988 dir_fd = dirfd(dir);
989 if (dir_fd < 0) {
990 PERROR("dirfd");
d7ba1388
MD
991 return -1;
992 }
993
a424227e 994 while ((entry = readdir(dir))) {
88ae485a
JR
995 struct stat st;
996 size_t name_len;
997 char filename[PATH_MAX];
998
a424227e
MD
999 if (!strcmp(entry->d_name, ".")
1000 || !strcmp(entry->d_name, "..")) {
1001 continue;
1002 }
88ae485a
JR
1003
1004 name_len = strlen(entry->d_name);
1005 if (path_len + name_len + 2 > sizeof(filename)) {
1006 ERR("Failed to remove file: path name too long (%s/%s)",
1007 input_path, entry->d_name);
1008 continue;
1009 }
1010
1011 if (snprintf(filename, sizeof(filename), "%s/%s",
1012 input_path, entry->d_name) < 0) {
1013 ERR("Failed to format path.");
1014 continue;
1015 }
1016
1017 if (stat(filename, &st)) {
1018 PERROR("stat");
1019 continue;
1020 }
1021
1022 if (S_ISDIR(st.st_mode)) {
a424227e
MD
1023 char output_subpath[PATH_MAX];
1024 char input_subpath[PATH_MAX];
1025
1026 strncpy(output_subpath, output_path,
1027 sizeof(output_subpath));
1028 output_subpath[sizeof(output_subpath) - 1] = '\0';
1029 strncat(output_subpath, "/",
1030 sizeof(output_subpath) - strlen(output_subpath) - 1);
1031 strncat(output_subpath, entry->d_name,
1032 sizeof(output_subpath) - strlen(output_subpath) - 1);
1033
1034 ret = mkdir(output_subpath, S_IRWXU | S_IRWXG);
1035 if (ret) {
1036 PERROR("mkdir");
1037 has_warning = 1;
1038 goto end;
1039 }
1040
1041 strncpy(input_subpath, input_path,
1042 sizeof(input_subpath));
1043 input_subpath[sizeof(input_subpath) - 1] = '\0';
1044 strncat(input_subpath, "/",
1045 sizeof(input_subpath) - strlen(input_subpath) - 1);
1046 strncat(input_subpath, entry->d_name,
1047 sizeof(input_subpath) - strlen(input_subpath) - 1);
1048
1049 ret = extract_trace_recursive(output_subpath,
1050 input_subpath);
29786dfa
JG
1051 if (ret) {
1052 has_warning = 1;
1053 }
88ae485a 1054 } else if (S_ISREG(st.st_mode) || S_ISLNK(st.st_mode)) {
a424227e
MD
1055 if (!strcmp(entry->d_name, "metadata")) {
1056 ret = extract_one_trace(output_path,
1057 input_path);
1058 if (ret) {
1059 WARN("Error extracting trace '%s', continuing anyway.",
1060 input_path);
1061 has_warning = 1;
1062 }
1063 }
88ae485a 1064 } else {
d7ba1388 1065 has_warning = 1;
a424227e 1066 goto end;
d7ba1388
MD
1067 }
1068 }
a424227e
MD
1069end:
1070 closeret = closedir(dir);
1071 if (closeret) {
1072 PERROR("closedir");
1073 }
d7ba1388
MD
1074 return has_warning;
1075}
1076
1077static
afe4fd7c 1078int delete_dir_recursive(const char *path)
d7ba1388 1079{
afe4fd7c
JR
1080 DIR *dir;
1081 int dir_fd, ret = 0, closeret;
88ae485a 1082 size_t path_len;
d7ba1388
MD
1083 struct dirent *entry;
1084
1085 /* Open trace directory */
afe4fd7c
JR
1086 dir = opendir(path);
1087 if (!dir) {
1088 PERROR("Cannot open '%s' path", path);
920a187e 1089 ret = -errno;
ef6fc488 1090 goto end_no_closedir;
d7ba1388 1091 }
88ae485a
JR
1092
1093 path_len = strlen(path);
1094
afe4fd7c
JR
1095 dir_fd = dirfd(dir);
1096 if (dir_fd < 0) {
d7ba1388 1097 PERROR("dirfd");
920a187e
JG
1098 ret = -errno;
1099 goto end;
d7ba1388
MD
1100 }
1101
afe4fd7c 1102 while ((entry = readdir(dir))) {
88ae485a
JR
1103 struct stat st;
1104 size_t name_len;
1105 char filename[PATH_MAX];
1106
d7ba1388 1107 if (!strcmp(entry->d_name, ".")
a424227e 1108 || !strcmp(entry->d_name, "..")) {
d7ba1388 1109 continue;
a424227e 1110 }
88ae485a
JR
1111
1112 name_len = strlen(entry->d_name);
1113 if (path_len + name_len + 2 > sizeof(filename)) {
1114 ERR("Failed to remove file: path name too long (%s/%s)",
1115 path, entry->d_name);
1116 continue;
1117 }
1118
1119 if (snprintf(filename, sizeof(filename), "%s/%s",
1120 path, entry->d_name) < 0) {
1121 ERR("Failed to format path.");
1122 continue;
1123 }
1124
1125 if (stat(filename, &st)) {
1126 PERROR("stat");
1127 continue;
1128 }
1129
1130 if (S_ISDIR(st.st_mode)) {
afe4fd7c
JR
1131 char *subpath = zmalloc(PATH_MAX);
1132
1133 if (!subpath) {
1134 PERROR("zmalloc path");
1135 ret = -1;
1136 goto end;
1137 }
1138 strncpy(subpath, path, PATH_MAX);
1139 subpath[PATH_MAX - 1] = '\0';
1140 strncat(subpath, "/",
1141 PATH_MAX - strlen(subpath) - 1);
1142 strncat(subpath, entry->d_name,
1143 PATH_MAX - strlen(subpath) - 1);
1144
1145 ret = delete_dir_recursive(subpath);
1146 free(subpath);
1147 if (ret) {
83f4233d 1148 /* Error occurred, abort traversal. */
afe4fd7c
JR
1149 goto end;
1150 }
88ae485a 1151 } else if (S_ISREG(st.st_mode)) {
afe4fd7c
JR
1152 ret = unlinkat(dir_fd, entry->d_name, 0);
1153 if (ret) {
1154 PERROR("Unlinking '%s'", entry->d_name);
1155 goto end;
1156 }
88ae485a 1157 } else {
d7ba1388
MD
1158 ret = -EINVAL;
1159 goto end;
1160 }
1161 }
1162end:
afe4fd7c
JR
1163 if (!ret) {
1164 ret = rmdir(path);
1165 if (ret) {
1166 PERROR("rmdir '%s'", path);
1167 }
1168 }
1169 closeret = closedir(dir);
d7ba1388
MD
1170 if (closeret) {
1171 PERROR("closedir");
1172 }
ef6fc488 1173end_no_closedir:
d7ba1388
MD
1174 return ret;
1175}
1176
d7ba1388
MD
1177static
1178int view_trace(const char *viewer_path, const char *trace_path)
1179{
1180 pid_t pid;
1181
1182 pid = fork();
1183 if (pid < 0) {
1184 /* Error */
1185 PERROR("fork");
1186 return -1;
1187 } else if (pid > 0) {
1188 /* Parent */
1189 int status;
1190
1191 pid = waitpid(pid, &status, 0);
1192 if (pid < 0 || !WIFEXITED(status)) {
1193 return -1;
1194 }
1195 } else {
1196 /* Child */
1197 int ret;
1198
1199 ret = execlp(viewer_path, viewer_path,
1200 trace_path, (char *) NULL);
1201 if (ret) {
1202 PERROR("execlp");
1203 exit(EXIT_FAILURE);
1204 }
1205 exit(EXIT_SUCCESS); /* Never reached */
1206 }
1207 return 0;
1208}
1209
1210/*
1211 * main
1212 */
1213int main(int argc, char *argv[])
1214{
aa25d686
JG
1215 int ret;
1216 bool has_warning = false;
d7ba1388
MD
1217 const char *output_path = NULL;
1218 char tmppath[] = "/tmp/lttng-crash-XXXXXX";
1219
1220 progname = argv[0] ? argv[0] : "lttng-crash";
1221
1222 ret = parse_args(argc, argv);
1223 if (ret > 0) {
aa25d686 1224 goto end;
d7ba1388 1225 } else if (ret < 0) {
aa25d686
JG
1226 has_warning = true;
1227 goto end;
d7ba1388
MD
1228 }
1229
1230 if (opt_output_path) {
1231 output_path = opt_output_path;
1232 ret = mkdir(output_path, S_IRWXU | S_IRWXG);
1233 if (ret) {
1234 PERROR("mkdir");
aa25d686
JG
1235 has_warning = true;
1236 goto end;
d7ba1388
MD
1237 }
1238 } else {
1239 output_path = mkdtemp(tmppath);
1240 if (!output_path) {
1241 PERROR("mkdtemp");
aa25d686
JG
1242 has_warning = true;
1243 goto end;
d7ba1388
MD
1244 }
1245 }
1246
a424227e 1247 ret = extract_trace_recursive(output_path, input_path);
d7ba1388 1248 if (ret < 0) {
aa25d686
JG
1249 has_warning = true;
1250 goto end;
d7ba1388 1251 } else if (ret > 0) {
aa25d686
JG
1252 /* extract_trace_recursive reported a warning. */
1253 has_warning = true;
d7ba1388
MD
1254 }
1255 if (!opt_output_path) {
1256 /* View trace */
1257 ret = view_trace(opt_viewer_path, output_path);
aa25d686
JG
1258 if (ret) {
1259 has_warning = true;
1260 }
d7ba1388 1261 /* unlink temporary trace */
afe4fd7c 1262 ret = delete_dir_recursive(output_path);
aa25d686
JG
1263 if (ret) {
1264 has_warning = true;
1265 }
d7ba1388 1266 }
aa25d686
JG
1267end:
1268 exit(has_warning ? EXIT_FAILURE : EXIT_SUCCESS);
d7ba1388 1269}
This page took 0.145345 seconds and 4 git commands to generate.