2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2014 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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.
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.
25 #include <sys/types.h>
38 #include <lttng/lttng.h>
39 #include <common/common.h>
40 #include <common/utils.h>
42 #define DEFAULT_VIEWER "babeltrace"
44 #define COPY_BUFLEN 4096
45 #define RB_CRASH_DUMP_ABI_LEN 32
47 #define RB_CRASH_DUMP_ABI_MAGIC_LEN 16
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,
56 #define RB_CRASH_DUMP_ABI_MAGIC_XOR \
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, \
65 * Non-static to ensure the compiler does not optimize away the xor.
67 uint8_t lttng_crash_expected_magic_xor
[] = RB_CRASH_DUMP_ABI_MAGIC_XOR
;
69 #define RB_CRASH_ENDIAN 0x1234
70 #define RB_CRASH_ENDIAN_REVERSE 0x3412
72 enum lttng_crash_type
{
73 LTTNG_CRASH_TYPE_UST
= 0,
74 LTTNG_CRASH_TYPE_KERNEL
= 1,
77 /* LTTng ring buffer defines (copied) */
79 #define HALF_ULONG_BITS(wl) (((wl) * CHAR_BIT) >> 1)
81 #define SB_ID_OFFSET_SHIFT(wl) (HALF_ULONG_BITS(wl) + 1)
82 #define SB_ID_OFFSET_COUNT(wl) (1UL << SB_ID_OFFSET_SHIFT(wl))
83 #define SB_ID_OFFSET_MASK(wl) (~(SB_ID_OFFSET_COUNT(wl) - 1))
85 * Lowest bit of top word half belongs to noref. Used only for overwrite mode.
87 #define SB_ID_NOREF_SHIFT(wl) (SB_ID_OFFSET_SHIFT(wl) - 1)
88 #define SB_ID_NOREF_COUNT(wl) (1UL << SB_ID_NOREF_SHIFT(wl))
89 #define SB_ID_NOREF_MASK(wl) SB_ID_NOREF_COUNT(wl)
91 * In overwrite mode: lowest half of word is used for index.
92 * Limit of 2^16 subbuffers per buffer on 32-bit, 2^32 on 64-bit.
93 * In producer-consumer mode: whole word used for index.
95 #define SB_ID_INDEX_SHIFT(wl) 0
96 #define SB_ID_INDEX_COUNT(wl) (1UL << SB_ID_INDEX_SHIFT(wl))
97 #define SB_ID_INDEX_MASK(wl) (SB_ID_NOREF_COUNT(wl) - 1)
100 RING_BUFFER_OVERWRITE
= 0, /* Overwrite when buffer full */
101 RING_BUFFER_DISCARD
= 1, /* Discard when buffer full */
104 struct crash_abi_unknown
{
105 uint8_t magic
[RB_CRASH_DUMP_ABI_MAGIC_LEN
];
106 uint64_t mmap_length
; /* Overall length of crash record */
108 * { 0x12, 0x34 }: big endian
109 * { 0x34, 0x12 }: little endian
111 uint16_t major
; /* Major number. */
112 uint16_t minor
; /* Minor number. */
113 uint8_t word_size
; /* Word size (bytes). */
114 uint8_t layout_type
; /* enum lttng_crash_layout */
115 } __attribute__((packed
));
117 struct crash_abi_0_0
{
118 struct crash_abi_unknown parent
;
121 uint32_t prod_offset
;
122 uint32_t consumed_offset
;
123 uint32_t commit_hot_array
;
124 uint32_t commit_hot_seq
;
125 uint32_t buf_wsb_array
;
128 uint32_t sb_array_shmp_offset
;
129 uint32_t sb_backend_p_offset
;
130 uint32_t content_size
;
131 uint32_t packet_size
;
132 } __attribute__((packed
)) offset
;
135 uint8_t consumed_offset
;
136 uint8_t commit_hot_seq
;
138 uint8_t sb_array_shmp_offset
;
139 uint8_t sb_backend_p_offset
;
140 uint8_t content_size
;
142 } __attribute__((packed
)) length
;
144 uint32_t commit_hot_array
;
145 uint32_t buf_wsb_array
;
147 } __attribute__((packed
)) stride
;
149 uint64_t buf_size
; /* Size of the buffer */
150 uint64_t subbuf_size
; /* Sub-buffer size */
151 uint64_t num_subbuf
; /* Number of sub-buffers for writer */
152 uint32_t mode
; /* Buffer mode: 0: overwrite, 1: discard */
153 } __attribute__((packed
));
155 struct lttng_crash_layout
{
157 int prod_offset
, consumed_offset
,
158 commit_hot_array
, commit_hot_seq
,
159 buf_wsb_array
, buf_wsb_id
,
160 sb_array
, sb_array_shmp_offset
,
161 sb_backend_p_offset
, content_size
,
165 int prod_offset
, consumed_offset
,
166 commit_hot_seq
, buf_wsb_id
,
167 sb_array_shmp_offset
, sb_backend_p_offset
,
168 content_size
, packet_size
;
171 int commit_hot_array
, buf_wsb_array
, sb_array
;
174 int reverse_byte_order
;
177 uint64_t mmap_length
; /* Length of crash record */
178 uint64_t buf_size
; /* Size of the buffer */
179 uint64_t subbuf_size
; /* Sub-buffer size */
180 uint64_t num_subbuf
; /* Number of sub-buffers for writer */
181 uint32_t mode
; /* Buffer mode: 0: overwrite, 1: discard */
185 static char *progname
,
186 *opt_viewer_path
= NULL
,
187 *opt_output_path
= NULL
;
189 static char *input_path
;
191 int lttng_opt_quiet
, lttng_opt_verbose
, lttng_opt_mi
;
197 /* Getopt options. No first level command. */
198 static struct option long_options
[] = {
199 { "version", 0, NULL
, 'V' },
200 { "help", 0, NULL
, 'h' },
201 { "verbose", 0, NULL
, 'v' },
202 { "viewer", 1, NULL
, 'e' },
203 { "extract", 1, NULL
, 'x' },
204 { "list-options", 0, NULL
, OPT_DUMP_OPTIONS
},
205 { NULL
, 0, NULL
, 0 },
208 static void usage(void)
210 int ret
= utils_show_man_page(1, "lttng-crash");
213 ERR("Cannot view man page lttng-crash(1)");
219 static void version(FILE *ofp
)
221 fprintf(ofp
, "%s (LTTng Crash Trace Viewer) " VERSION
" - " VERSION_NAME
224 GIT_VERSION
[0] == '\0' ? "" : " - " GIT_VERSION
);
230 * List options line by line. This is mostly for bash auto completion and to
231 * avoid difficult parsing.
233 static void list_options(FILE *ofp
)
236 struct option
*option
= NULL
;
238 option
= &long_options
[i
];
239 while (option
->name
!= NULL
) {
240 fprintf(ofp
, "--%s\n", option
->name
);
242 if (isprint(option
->val
)) {
243 fprintf(ofp
, "-%c\n", option
->val
);
247 option
= &long_options
[i
];
252 * Parse command line arguments.
254 * Return 0 if OK, else -1
256 static int parse_args(int argc
, char **argv
)
265 while ((opt
= getopt_long(argc
, argv
, "+Vhve:x:", long_options
, NULL
)) != -1) {
276 /* There is only 3 possible level of verbosity. (-vvv) */
277 if (lttng_opt_verbose
< 3) {
278 lttng_opt_verbose
+= 1;
282 free(opt_viewer_path
);
283 opt_viewer_path
= strdup(optarg
);
286 free(opt_output_path
);
287 opt_output_path
= strdup(optarg
);
289 case OPT_DUMP_OPTIONS
:
290 list_options(stdout
);
294 ERR("Unknown command-line option");
299 if (!opt_viewer_path
) {
300 opt_viewer_path
= DEFAULT_VIEWER
;
303 /* No leftovers, or more than one input path, print usage and quit */
304 if (argc
- optind
!= 1) {
305 ERR("Command-line error: Specify exactly one input path");
309 input_path
= argv
[optind
];
318 int copy_file(const char *file_dest
, const char *file_src
)
320 int fd_src
= -1, fd_dest
= -1;
321 ssize_t readlen
, writelen
;
322 char buf
[COPY_BUFLEN
];
325 DBG("Copy metadata file '%s' into '%s'", file_src
, file_dest
);
327 fd_src
= open(file_src
, O_RDONLY
);
329 PERROR("Error opening %s for reading", file_src
);
333 fd_dest
= open(file_dest
, O_RDWR
| O_CREAT
| O_EXCL
,
334 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
336 PERROR("Error opening %s for writing", file_dest
);
342 readlen
= lttng_read(fd_src
, buf
, COPY_BUFLEN
);
344 PERROR("Error reading input file");
351 writelen
= lttng_write(fd_dest
, buf
, readlen
);
352 if (writelen
< readlen
) {
353 PERROR("Error writing to output file");
362 if (close(fd_src
) < 0) {
363 PERROR("Error closing %s", file_src
);
368 if (close(fd_dest
) < 0) {
369 PERROR("Error closing %s", file_dest
);
376 uint64_t _crash_get_field(const struct lttng_crash_layout
*layout
,
377 const char *ptr
, size_t size
)
380 case 1: return *(uint8_t *) ptr
;
381 case 2: if (layout
->reverse_byte_order
) {
382 return __bswap_16(*(uint16_t *) ptr
);
384 return *(uint16_t *) ptr
;
387 case 4: if (layout
->reverse_byte_order
) {
388 return __bswap_32(*(uint32_t *) ptr
);
390 return *(uint32_t *) ptr
;
393 case 8: if (layout
->reverse_byte_order
) {
394 return __bswap_64(*(uint64_t *) ptr
);
396 return *(uint64_t *) ptr
;
405 #define crash_get_field(layout, map, name) \
406 _crash_get_field(layout, (map) + (layout)->offset.name, \
409 #define crash_get_array_field(layout, map, array_name, idx, field_name) \
410 _crash_get_field(layout, \
411 (map) + (layout)->offset.array_name \
412 + (idx * (layout)->stride.array_name) \
413 + (layout)->offset.field_name, \
414 (layout)->length.field_name)
416 #define crash_get_hdr_raw_field(layout, hdr, name) ((hdr)->name)
418 #define crash_get_hdr_field(layout, hdr, name) \
419 _crash_get_field(layout, (const char *) &(hdr)->name, \
422 #define crash_get_layout(layout, hdr, name) \
424 (layout)->name = crash_get_hdr_field(layout, hdr, \
426 DBG("layout.%s = %" PRIu64, #name, \
427 (uint64_t) (layout)->name); \
431 int get_crash_layout_0_0(struct lttng_crash_layout
*layout
,
434 const struct crash_abi_0_0
*abi
= (const struct crash_abi_0_0
*) map
;
436 crash_get_layout(layout
, abi
, offset
.prod_offset
);
437 crash_get_layout(layout
, abi
, offset
.consumed_offset
);
438 crash_get_layout(layout
, abi
, offset
.commit_hot_array
);
439 crash_get_layout(layout
, abi
, offset
.commit_hot_seq
);
440 crash_get_layout(layout
, abi
, offset
.buf_wsb_array
);
441 crash_get_layout(layout
, abi
, offset
.buf_wsb_id
);
442 crash_get_layout(layout
, abi
, offset
.sb_array
);
443 crash_get_layout(layout
, abi
, offset
.sb_array_shmp_offset
);
444 crash_get_layout(layout
, abi
, offset
.sb_backend_p_offset
);
445 crash_get_layout(layout
, abi
, offset
.content_size
);
446 crash_get_layout(layout
, abi
, offset
.packet_size
);
448 crash_get_layout(layout
, abi
, length
.prod_offset
);
449 crash_get_layout(layout
, abi
, length
.consumed_offset
);
450 crash_get_layout(layout
, abi
, length
.commit_hot_seq
);
451 crash_get_layout(layout
, abi
, length
.buf_wsb_id
);
452 crash_get_layout(layout
, abi
, length
.sb_array_shmp_offset
);
453 crash_get_layout(layout
, abi
, length
.sb_backend_p_offset
);
454 crash_get_layout(layout
, abi
, length
.content_size
);
455 crash_get_layout(layout
, abi
, length
.packet_size
);
457 crash_get_layout(layout
, abi
, stride
.commit_hot_array
);
458 crash_get_layout(layout
, abi
, stride
.buf_wsb_array
);
459 crash_get_layout(layout
, abi
, stride
.sb_array
);
461 crash_get_layout(layout
, abi
, buf_size
);
462 crash_get_layout(layout
, abi
, subbuf_size
);
463 crash_get_layout(layout
, abi
, num_subbuf
);
464 crash_get_layout(layout
, abi
, mode
);
470 void print_dbg_magic(const uint8_t *magic
)
472 DBG("magic: 0x%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X",
473 magic
[0], magic
[1], magic
[2], magic
[3],
474 magic
[4], magic
[5], magic
[6], magic
[7],
475 magic
[8], magic
[9], magic
[10], magic
[11],
476 magic
[12], magic
[13], magic
[14], magic
[15]);
480 int check_magic(const uint8_t *magic
)
484 for (i
= 0; i
< RB_CRASH_DUMP_ABI_MAGIC_LEN
; i
++) {
485 if ((magic
[i
] ^ 0xFF) != lttng_crash_expected_magic_xor
[i
]) {
493 int get_crash_layout(struct lttng_crash_layout
*layout
, int fd
,
494 const char *input_file
)
497 int ret
= 0, unmapret
;
498 const uint8_t *magic
;
499 uint64_t mmap_length
;
500 uint16_t major
, minor
;
502 const struct crash_abi_unknown
*abi
;
504 enum lttng_crash_type layout_type
;
507 ret
= fstat(fd
, &stat
);
509 PERROR("Failed to fstat '%s'", input_file
);
512 if (stat
.st_size
< RB_CRASH_DUMP_ABI_LEN
) {
513 ERR("File '%s' truncated: file length of %" PRIi64
514 " bytes does not meet the minimal expected "
515 "length of %d bytes",
516 input_file
, (int64_t) stat
.st_size
,
517 RB_CRASH_DUMP_ABI_LEN
);
520 map
= mmap(NULL
, RB_CRASH_DUMP_ABI_LEN
, PROT_READ
, MAP_PRIVATE
,
522 if (map
== MAP_FAILED
) {
523 PERROR("Mapping file");
526 abi
= (const struct crash_abi_unknown
*) map
;
527 magic
= crash_get_hdr_raw_field(layout
, abi
, magic
);
528 print_dbg_magic(magic
);
529 if (check_magic(magic
)) {
530 DBG("Unknown magic number");
531 ret
= 1; /* positive return value, skip */
534 endian
= crash_get_hdr_field(layout
, abi
, endian
);
536 case RB_CRASH_ENDIAN
:
538 case RB_CRASH_ENDIAN_REVERSE
:
539 layout
->reverse_byte_order
= 1;
542 DBG("Unknown endianness value: 0x%X", (unsigned int) endian
);
543 ret
= 1; /* positive return value, skip */
546 layout_type
= (enum lttng_crash_type
) crash_get_hdr_field(layout
, abi
, layout_type
);
547 switch (layout_type
) {
548 case LTTNG_CRASH_TYPE_UST
:
550 case LTTNG_CRASH_TYPE_KERNEL
:
551 ERR("lttng-modules buffer layout support not implemented");
552 ret
= 1; /* positive return value, skip */
555 ERR("Unknown layout type %u", (unsigned int) layout_type
);
556 ret
= 1; /* positive return value, skip */
559 mmap_length
= crash_get_hdr_field(layout
, abi
, mmap_length
);
560 DBG("mmap_length: %" PRIu64
, mmap_length
);
561 layout
->mmap_length
= mmap_length
;
562 major
= crash_get_hdr_field(layout
, abi
, major
);
563 DBG("major: %u", major
);
564 minor
= crash_get_hdr_field(layout
, abi
, minor
);
565 DBG("minor: %u", minor
);
566 word_size
= crash_get_hdr_field(layout
, abi
, word_size
);
567 DBG("word_size: %u", word_size
);
572 ret
= get_crash_layout_0_0(layout
, map
);
578 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
583 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
587 layout
->word_size
= word_size
;
589 unmapret
= munmap(map
, RB_CRASH_DUMP_ABI_LEN
);
596 /* buf_trunc mask selects only the buffer number. */
598 uint64_t buf_trunc(uint64_t offset
, uint64_t buf_size
)
600 return offset
& ~(buf_size
- 1);
603 /* subbuf_trunc mask selects the subbuffer number. */
605 uint64_t subbuf_trunc(uint64_t offset
, uint64_t subbuf_size
)
607 return offset
& ~(subbuf_size
- 1);
610 /* buf_offset mask selects only the offset within the current buffer. */
612 uint64_t buf_offset(uint64_t offset
, uint64_t buf_size
)
614 return offset
& (buf_size
- 1);
617 /* subbuf_offset mask selects the offset within the current subbuffer. */
619 uint64_t subbuf_offset(uint64_t offset
, uint64_t subbuf_size
)
621 return offset
& (subbuf_size
- 1);
624 /* subbuf_index returns the index of the current subbuffer within the buffer. */
626 uint64_t subbuf_index(uint64_t offset
, uint64_t buf_size
, uint64_t subbuf_size
)
628 return buf_offset(offset
, buf_size
) / subbuf_size
;
632 uint64_t subbuffer_id_get_index(uint32_t mode
, uint64_t id
,
635 if (mode
== RING_BUFFER_OVERWRITE
)
636 return id
& SB_ID_INDEX_MASK(wl
);
642 int copy_crash_subbuf(const struct lttng_crash_layout
*layout
,
643 int fd_dest
, char *buf
, uint64_t offset
)
645 uint64_t buf_size
, subbuf_size
, num_subbuf
, sbidx
, id
,
646 sb_bindex
, rpages_offset
, p_offset
, seq_cc
,
647 committed
, commit_count_mask
, consumed_cur
,
653 * Get the current subbuffer by applying the proper mask to
654 * "offset", and looking up the subbuf location within the
658 buf_size
= layout
->buf_size
;
659 subbuf_size
= layout
->subbuf_size
;
660 num_subbuf
= layout
->num_subbuf
;
662 switch (layout
->word_size
) {
663 case 4: commit_count_mask
= 0xFFFFFFFFULL
/ num_subbuf
;
665 case 8: commit_count_mask
= 0xFFFFFFFFFFFFFFFFULL
/ num_subbuf
;
668 ERR("Unsupported word size: %u",
669 (unsigned int) layout
->word_size
);
673 DBG("Copy crash subbuffer at offset %" PRIu64
, offset
);
674 sbidx
= subbuf_index(offset
, buf_size
, subbuf_size
);
677 * Find where the seq cc is located. Compute length of data to
680 seq_cc
= crash_get_array_field(layout
, buf
, commit_hot_array
,
681 sbidx
, commit_hot_seq
);
682 consumed_cur
= crash_get_field(layout
, buf
, consumed_offset
);
685 * Check that the buffer we are getting is after or at
686 * consumed_cur position.
688 if ((long) subbuf_trunc(offset
, subbuf_size
)
689 - (long) subbuf_trunc(consumed_cur
, subbuf_size
) < 0) {
690 DBG("No data: position is before consumed_cur");
695 * Check if subbuffer has been fully committed.
697 if (((seq_cc
- subbuf_size
) & commit_count_mask
)
698 - (buf_trunc(offset
, buf_size
) / num_subbuf
)
700 committed
= subbuf_size
;
702 committed
= subbuf_offset(seq_cc
, subbuf_size
);
704 DBG("No data committed, seq_cc: %" PRIu64
, seq_cc
);
709 /* Find actual physical offset in subbuffer table */
710 id
= crash_get_array_field(layout
, buf
, buf_wsb_array
,
712 sb_bindex
= subbuffer_id_get_index(layout
->mode
, id
,
714 rpages_offset
= crash_get_array_field(layout
, buf
, sb_array
,
715 sb_bindex
, sb_array_shmp_offset
);
716 p_offset
= crash_get_field(layout
, buf
+ rpages_offset
,
717 sb_backend_p_offset
);
718 subbuf_ptr
= buf
+ p_offset
;
720 if (committed
== subbuf_size
) {
722 * Packet header can be used.
724 if (layout
->length
.packet_size
) {
726 subbuf_ptr
+ layout
->offset
.packet_size
,
727 layout
->length
.packet_size
);
728 if (layout
->reverse_byte_order
) {
729 packet_size
= __bswap_64(packet_size
);
731 packet_size
/= CHAR_BIT
;
733 packet_size
= subbuf_size
;
739 * Find where to patch the sub-buffer header with actual
740 * readable data len and packet len, derived from seq
741 * cc. Patch it in our in-memory copy.
743 patch_size
= committed
* CHAR_BIT
;
744 if (layout
->reverse_byte_order
) {
745 patch_size
= __bswap_64(patch_size
);
747 if (layout
->length
.content_size
) {
748 memcpy(subbuf_ptr
+ layout
->offset
.content_size
,
749 &patch_size
, layout
->length
.content_size
);
751 if (layout
->length
.packet_size
) {
752 memcpy(subbuf_ptr
+ layout
->offset
.packet_size
,
753 &patch_size
, layout
->length
.packet_size
);
755 packet_size
= committed
;
759 * Copy packet into fd_dest.
761 writelen
= lttng_write(fd_dest
, subbuf_ptr
, packet_size
);
762 if (writelen
< packet_size
) {
763 PERROR("Error writing to output file");
766 DBG("Copied %" PRIu64
" bytes of data", packet_size
);
774 int copy_crash_data(const struct lttng_crash_layout
*layout
, int fd_dest
,
778 int ret
= 0, has_data
= 0;
781 uint64_t prod_offset
, consumed_offset
;
782 uint64_t offset
, subbuf_size
;
785 ret
= fstat(fd_src
, &statbuf
);
789 src_file_len
= layout
->mmap_length
;
790 buf
= zmalloc(src_file_len
);
794 readlen
= lttng_read(fd_src
, buf
, src_file_len
);
796 PERROR("Error reading input file");
801 prod_offset
= crash_get_field(layout
, buf
, prod_offset
);
802 DBG("prod_offset: 0x%" PRIx64
, prod_offset
);
803 consumed_offset
= crash_get_field(layout
, buf
, consumed_offset
);
804 DBG("consumed_offset: 0x%" PRIx64
, consumed_offset
);
805 subbuf_size
= layout
->subbuf_size
;
807 for (offset
= consumed_offset
; offset
< prod_offset
;
808 offset
+= subbuf_size
) {
809 ret
= copy_crash_subbuf(layout
, fd_dest
, buf
, offset
);
819 if (ret
&& ret
!= -ENODATA
) {
830 int extract_file(int output_dir_fd
, const char *output_file
,
831 int input_dir_fd
, const char *input_file
)
833 int fd_dest
, fd_src
, ret
= 0, closeret
;
834 struct lttng_crash_layout layout
;
836 layout
.reverse_byte_order
= 0; /* For reading magic number */
838 DBG("Extract file '%s'", input_file
);
839 fd_src
= openat(input_dir_fd
, input_file
, O_RDONLY
);
841 PERROR("Error opening '%s' for reading",
847 /* Query the crash ABI layout */
848 ret
= get_crash_layout(&layout
, fd_src
, input_file
);
853 fd_dest
= openat(output_dir_fd
, output_file
,
854 O_RDWR
| O_CREAT
| O_EXCL
,
855 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
857 PERROR("Error opening '%s' for writing",
863 ret
= copy_crash_data(&layout
, fd_dest
, fd_src
);
869 closeret
= close(fd_dest
);
873 if (ret
== -ENODATA
) {
874 closeret
= unlinkat(output_dir_fd
, output_file
, 0);
880 closeret
= close(fd_src
);
889 int extract_all_files(const char *output_path
,
890 const char *input_path
)
892 DIR *input_dir
, *output_dir
;
893 int input_dir_fd
, output_dir_fd
, ret
= 0, closeret
;
894 struct dirent
*entry
; /* input */
896 /* Open input directory */
897 input_dir
= opendir(input_path
);
899 PERROR("Cannot open '%s' path", input_path
);
902 input_dir_fd
= dirfd(input_dir
);
903 if (input_dir_fd
< 0) {
908 /* Open output directory */
909 output_dir
= opendir(output_path
);
911 PERROR("Cannot open '%s' path", output_path
);
914 output_dir_fd
= dirfd(output_dir
);
915 if (output_dir_fd
< 0) {
920 while ((entry
= readdir(input_dir
))) {
921 if (!strcmp(entry
->d_name
, ".")
922 || !strcmp(entry
->d_name
, ".."))
924 ret
= extract_file(output_dir_fd
, entry
->d_name
,
925 input_dir_fd
, entry
->d_name
);
926 if (ret
== -ENODATA
) {
927 DBG("No data in file '%s', skipping", entry
->d_name
);
930 } else if (ret
< 0) {
932 } else if (ret
> 0) {
933 DBG("Skipping file '%s'", entry
->d_name
);
938 closeret
= closedir(output_dir
);
942 closeret
= closedir(input_dir
);
950 int extract_one_trace(const char *output_path
,
951 const char *input_path
)
953 char dest
[PATH_MAX
], src
[PATH_MAX
];
956 DBG("Extract crash trace '%s' into '%s'", input_path
, output_path
);
959 strncpy(dest
, output_path
, PATH_MAX
);
960 dest
[PATH_MAX
- 1] = '\0';
961 strncat(dest
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
963 strncpy(src
, input_path
, PATH_MAX
);
964 src
[PATH_MAX
- 1] = '\0';
965 strncat(src
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
967 ret
= copy_file(dest
, src
);
972 /* Extract each other file that has expected header */
973 return extract_all_files(output_path
, input_path
);
977 int extract_trace_recursive(const char *output_path
,
978 const char *input_path
)
981 int dir_fd
, ret
= 0, closeret
;
982 struct dirent
*entry
;
987 dir
= opendir(input_path
);
989 PERROR("Cannot open '%s' path", input_path
);
993 path_len
= strlen(input_path
);
1001 while ((entry
= readdir(dir
))) {
1004 char filename
[PATH_MAX
];
1006 if (!strcmp(entry
->d_name
, ".")
1007 || !strcmp(entry
->d_name
, "..")) {
1011 name_len
= strlen(entry
->d_name
);
1012 if (path_len
+ name_len
+ 2 > sizeof(filename
)) {
1013 ERR("Failed to remove file: path name too long (%s/%s)",
1014 input_path
, entry
->d_name
);
1018 if (snprintf(filename
, sizeof(filename
), "%s/%s",
1019 input_path
, entry
->d_name
) < 0) {
1020 ERR("Failed to format path.");
1024 if (stat(filename
, &st
)) {
1029 if (S_ISDIR(st
.st_mode
)) {
1030 char output_subpath
[PATH_MAX
];
1031 char input_subpath
[PATH_MAX
];
1033 strncpy(output_subpath
, output_path
,
1034 sizeof(output_subpath
));
1035 output_subpath
[sizeof(output_subpath
) - 1] = '\0';
1036 strncat(output_subpath
, "/",
1037 sizeof(output_subpath
) - strlen(output_subpath
) - 1);
1038 strncat(output_subpath
, entry
->d_name
,
1039 sizeof(output_subpath
) - strlen(output_subpath
) - 1);
1041 ret
= mkdir(output_subpath
, S_IRWXU
| S_IRWXG
);
1048 strncpy(input_subpath
, input_path
,
1049 sizeof(input_subpath
));
1050 input_subpath
[sizeof(input_subpath
) - 1] = '\0';
1051 strncat(input_subpath
, "/",
1052 sizeof(input_subpath
) - strlen(input_subpath
) - 1);
1053 strncat(input_subpath
, entry
->d_name
,
1054 sizeof(input_subpath
) - strlen(input_subpath
) - 1);
1056 ret
= extract_trace_recursive(output_subpath
,
1061 } else if (S_ISREG(st
.st_mode
) || S_ISLNK(st
.st_mode
)) {
1062 if (!strcmp(entry
->d_name
, "metadata")) {
1063 ret
= extract_one_trace(output_path
,
1066 WARN("Error extracting trace '%s', continuing anyway.",
1077 closeret
= closedir(dir
);
1085 int delete_dir_recursive(const char *path
)
1088 int dir_fd
, ret
= 0, closeret
;
1090 struct dirent
*entry
;
1092 /* Open trace directory */
1093 dir
= opendir(path
);
1095 PERROR("Cannot open '%s' path", path
);
1097 goto end_no_closedir
;
1100 path_len
= strlen(path
);
1102 dir_fd
= dirfd(dir
);
1109 while ((entry
= readdir(dir
))) {
1112 char filename
[PATH_MAX
];
1114 if (!strcmp(entry
->d_name
, ".")
1115 || !strcmp(entry
->d_name
, "..")) {
1119 name_len
= strlen(entry
->d_name
);
1120 if (path_len
+ name_len
+ 2 > sizeof(filename
)) {
1121 ERR("Failed to remove file: path name too long (%s/%s)",
1122 path
, entry
->d_name
);
1126 if (snprintf(filename
, sizeof(filename
), "%s/%s",
1127 path
, entry
->d_name
) < 0) {
1128 ERR("Failed to format path.");
1132 if (stat(filename
, &st
)) {
1137 if (S_ISDIR(st
.st_mode
)) {
1138 char *subpath
= zmalloc(PATH_MAX
);
1141 PERROR("zmalloc path");
1145 strncpy(subpath
, path
, PATH_MAX
);
1146 subpath
[PATH_MAX
- 1] = '\0';
1147 strncat(subpath
, "/",
1148 PATH_MAX
- strlen(subpath
) - 1);
1149 strncat(subpath
, entry
->d_name
,
1150 PATH_MAX
- strlen(subpath
) - 1);
1152 ret
= delete_dir_recursive(subpath
);
1155 /* Error occurred, abort traversal. */
1158 } else if (S_ISREG(st
.st_mode
)) {
1159 ret
= unlinkat(dir_fd
, entry
->d_name
, 0);
1161 PERROR("Unlinking '%s'", entry
->d_name
);
1173 PERROR("rmdir '%s'", path
);
1176 closeret
= closedir(dir
);
1185 int view_trace(const char *viewer_path
, const char *trace_path
)
1194 } else if (pid
> 0) {
1198 pid
= waitpid(pid
, &status
, 0);
1199 if (pid
< 0 || !WIFEXITED(status
)) {
1206 ret
= execlp(viewer_path
, viewer_path
,
1207 trace_path
, (char *) NULL
);
1212 exit(EXIT_SUCCESS
); /* Never reached */
1220 int main(int argc
, char *argv
[])
1223 bool has_warning
= false;
1224 const char *output_path
= NULL
;
1225 char tmppath
[] = "/tmp/lttng-crash-XXXXXX";
1227 progname
= argv
[0] ? argv
[0] : "lttng-crash";
1229 ret
= parse_args(argc
, argv
);
1232 } else if (ret
< 0) {
1237 if (opt_output_path
) {
1238 output_path
= opt_output_path
;
1239 ret
= mkdir(output_path
, S_IRWXU
| S_IRWXG
);
1246 output_path
= mkdtemp(tmppath
);
1254 ret
= extract_trace_recursive(output_path
, input_path
);
1258 } else if (ret
> 0) {
1259 /* extract_trace_recursive reported a warning. */
1262 if (!opt_output_path
) {
1264 ret
= view_trace(opt_viewer_path
, output_path
);
1268 /* unlink temporary trace */
1269 ret
= delete_dir_recursive(output_path
);
1275 exit(has_warning
? EXIT_FAILURE
: EXIT_SUCCESS
);