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.
26 #include <sys/types.h>
40 #include <lttng/lttng.h>
41 #include <common/common.h>
43 #define DEFAULT_VIEWER "babeltrace"
45 #define COPY_BUFLEN 4096
46 #define RB_CRASH_DUMP_ABI_LEN 32
48 #define RB_CRASH_DUMP_ABI_MAGIC_LEN 16
51 * The 128-bit magic number is xor'd in the process data so it does not
52 * cause a false positive when searching for buffers by scanning memory.
53 * The actual magic number is:
54 * 0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17, 0x7B, 0xF1,
55 * 0x77, 0xBF, 0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17,
57 #define RB_CRASH_DUMP_ABI_MAGIC_XOR \
59 0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF, 0x77 ^ 0xFF, \
60 0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF, \
61 0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF, \
62 0xF1 ^ 0xFF, 0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF, \
66 * Non-static to ensure the compiler does not optimize away the xor.
68 uint8_t lttng_crash_expected_magic_xor
[] = RB_CRASH_DUMP_ABI_MAGIC_XOR
;
70 #define RB_CRASH_ENDIAN 0x1234
71 #define RB_CRASH_ENDIAN_REVERSE 0x3412
73 enum lttng_crash_type
{
74 LTTNG_CRASH_TYPE_UST
= 0,
75 LTTNG_CRASH_TYPE_KERNEL
= 1,
78 /* LTTng ring buffer defines (copied) */
80 #define HALF_ULONG_BITS(wl) (((wl) * CHAR_BIT) >> 1)
82 #define SB_ID_OFFSET_SHIFT(wl) (HALF_ULONG_BITS(wl) + 1)
83 #define SB_ID_OFFSET_COUNT(wl) (1UL << SB_ID_OFFSET_SHIFT(wl))
84 #define SB_ID_OFFSET_MASK(wl) (~(SB_ID_OFFSET_COUNT(wl) - 1))
86 * Lowest bit of top word half belongs to noref. Used only for overwrite mode.
88 #define SB_ID_NOREF_SHIFT(wl) (SB_ID_OFFSET_SHIFT(wl) - 1)
89 #define SB_ID_NOREF_COUNT(wl) (1UL << SB_ID_NOREF_SHIFT(wl))
90 #define SB_ID_NOREF_MASK(wl) SB_ID_NOREF_COUNT(wl)
92 * In overwrite mode: lowest half of word is used for index.
93 * Limit of 2^16 subbuffers per buffer on 32-bit, 2^32 on 64-bit.
94 * In producer-consumer mode: whole word used for index.
96 #define SB_ID_INDEX_SHIFT(wl) 0
97 #define SB_ID_INDEX_COUNT(wl) (1UL << SB_ID_INDEX_SHIFT(wl))
98 #define SB_ID_INDEX_MASK(wl) (SB_ID_NOREF_COUNT(wl) - 1)
101 RING_BUFFER_OVERWRITE
= 0, /* Overwrite when buffer full */
102 RING_BUFFER_DISCARD
= 1, /* Discard when buffer full */
105 struct crash_abi_unknown
{
106 uint8_t magic
[RB_CRASH_DUMP_ABI_MAGIC_LEN
];
107 uint64_t mmap_length
; /* Overall length of crash record */
109 * { 0x12, 0x34 }: big endian
110 * { 0x34, 0x12 }: little endian
112 uint16_t major
; /* Major number. */
113 uint16_t minor
; /* Minor number. */
114 uint8_t word_size
; /* Word size (bytes). */
115 uint8_t layout_type
; /* enum lttng_crash_layout */
116 } __attribute__((packed
));
118 struct crash_abi_0_0
{
119 struct crash_abi_unknown parent
;
122 uint32_t prod_offset
;
123 uint32_t consumed_offset
;
124 uint32_t commit_hot_array
;
125 uint32_t commit_hot_seq
;
126 uint32_t buf_wsb_array
;
129 uint32_t sb_array_shmp_offset
;
130 uint32_t sb_backend_p_offset
;
131 uint32_t content_size
;
132 uint32_t packet_size
;
133 } __attribute__((packed
)) offset
;
136 uint8_t consumed_offset
;
137 uint8_t commit_hot_seq
;
139 uint8_t sb_array_shmp_offset
;
140 uint8_t sb_backend_p_offset
;
141 uint8_t content_size
;
143 } __attribute__((packed
)) length
;
145 uint32_t commit_hot_array
;
146 uint32_t buf_wsb_array
;
148 } __attribute__((packed
)) stride
;
150 uint64_t buf_size
; /* Size of the buffer */
151 uint64_t subbuf_size
; /* Sub-buffer size */
152 uint64_t num_subbuf
; /* Number of sub-buffers for writer */
153 uint32_t mode
; /* Buffer mode: 0: overwrite, 1: discard */
154 } __attribute__((packed
));
156 struct lttng_crash_layout
{
158 int prod_offset
, consumed_offset
,
159 commit_hot_array
, commit_hot_seq
,
160 buf_wsb_array
, buf_wsb_id
,
161 sb_array
, sb_array_shmp_offset
,
162 sb_backend_p_offset
, content_size
,
166 int prod_offset
, consumed_offset
,
167 commit_hot_seq
, buf_wsb_id
,
168 sb_array_shmp_offset
, sb_backend_p_offset
,
169 content_size
, packet_size
;
172 int commit_hot_array
, buf_wsb_array
, sb_array
;
175 int reverse_byte_order
;
178 uint64_t mmap_length
; /* Length of crash record */
179 uint64_t buf_size
; /* Size of the buffer */
180 uint64_t subbuf_size
; /* Sub-buffer size */
181 uint64_t num_subbuf
; /* Number of sub-buffers for writer */
182 uint32_t mode
; /* Buffer mode: 0: overwrite, 1: discard */
186 static char *progname
,
187 *opt_viewer_path
= DEFAULT_VIEWER
,
190 static char *input_path
;
192 int lttng_opt_quiet
, lttng_opt_verbose
, lttng_opt_mi
;
198 /* Getopt options. No first level command. */
199 static struct option long_options
[] = {
200 { "version", 0, NULL
, 'V' },
201 { "help", 0, NULL
, 'h' },
202 { "verbose", 0, NULL
, 'v' },
203 { "viewer", 1, NULL
, 'e' },
204 { "extract", 1, NULL
, 'x' },
205 { "list-options", 0, NULL
, OPT_DUMP_OPTIONS
},
206 { NULL
, 0, NULL
, 0 },
209 static void usage(FILE *ofp
)
211 fprintf(ofp
, "LTTng Crash Trace Viewer " VERSION
" - " VERSION_NAME
"%s\n\n",
212 GIT_VERSION
[0] == '\0' ? "" : " - " GIT_VERSION
);
213 fprintf(ofp
, "usage: lttng-crash [OPTIONS] FILE\n");
215 fprintf(ofp
, "Options:\n");
216 fprintf(ofp
, " -V, --version Show version.\n");
217 fprintf(ofp
, " -h, --help Show this help.\n");
218 fprintf(ofp
, " --list-options Simple listing of lttng-crash options.\n");
219 fprintf(ofp
, " -v, --verbose Increase verbosity.\n");
220 fprintf(ofp
, " -e, --viewer Specify viewer and/or options to use. This will\n"
221 " completely override the default viewers so please\n"
222 " make sure to specify the full command. The trace\n"
223 " directory paths appended at the end to the\n"
225 fprintf(ofp
, " -x, --extract PATH Extract trace(s) to specified path. Don't view\n"
228 fprintf(ofp
, "Please see the lttng-crash(1) man page for full documentation.\n");
229 fprintf(ofp
, "See http://lttng.org for updates, bug reports and news.\n");
232 static void version(FILE *ofp
)
234 fprintf(ofp
, "%s (LTTng Crash Trace Viewer) " VERSION
" - " VERSION_NAME
237 GIT_VERSION
[0] == '\0' ? "" : " - " GIT_VERSION
);
243 * List options line by line. This is mostly for bash auto completion and to
244 * avoid difficult parsing.
246 static void list_options(FILE *ofp
)
249 struct option
*option
= NULL
;
251 option
= &long_options
[i
];
252 while (option
->name
!= NULL
) {
253 fprintf(ofp
, "--%s\n", option
->name
);
255 if (isprint(option
->val
)) {
256 fprintf(ofp
, "-%c\n", option
->val
);
260 option
= &long_options
[i
];
265 * Parse command line arguments.
267 * Return 0 if OK, else -1
269 static int parse_args(int argc
, char **argv
)
278 while ((opt
= getopt_long(argc
, argv
, "+Vhvex:", long_options
, NULL
)) != -1) {
289 /* There is only 3 possible level of verbosity. (-vvv) */
290 if (lttng_opt_verbose
< 3) {
291 lttng_opt_verbose
+= 1;
295 opt_viewer_path
= strdup(optarg
);
298 opt_output_path
= strdup(optarg
);
300 case OPT_DUMP_OPTIONS
:
301 list_options(stdout
);
310 /* No leftovers, or more than one input path, print usage and quit */
311 if ((argc
- optind
) == 0 || (argc
- optind
) > 1) {
316 input_path
= argv
[optind
];
325 int copy_file(const char *file_dest
, const char *file_src
)
327 int fd_src
= -1, fd_dest
= -1;
328 ssize_t readlen
, writelen
;
329 char buf
[COPY_BUFLEN
];
332 DBG("Copy metadata file '%s' into '%s'", file_src
, file_dest
);
334 fd_src
= open(file_src
, O_RDONLY
);
336 PERROR("Error opening %s for reading", file_src
);
340 fd_dest
= open(file_dest
, O_RDWR
| O_CREAT
| O_EXCL
,
341 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
343 PERROR("Error opening %s for writing", file_dest
);
349 readlen
= lttng_read(fd_src
, buf
, COPY_BUFLEN
);
351 PERROR("Error reading input file");
358 writelen
= lttng_write(fd_dest
, buf
, readlen
);
359 if (writelen
< readlen
) {
360 PERROR("Error writing to output file");
369 if (close(fd_src
) < 0) {
370 PERROR("Error closing %s", file_src
);
375 if (close(fd_dest
) < 0) {
376 PERROR("Error closing %s", file_dest
);
383 uint64_t _crash_get_field(const struct lttng_crash_layout
*layout
,
384 const char *ptr
, size_t size
)
387 case 1: return *(uint8_t *) ptr
;
388 case 2: if (layout
->reverse_byte_order
) {
389 return __bswap_16(*(uint16_t *) ptr
);
391 return *(uint16_t *) ptr
;
394 case 4: if (layout
->reverse_byte_order
) {
395 return __bswap_32(*(uint32_t *) ptr
);
397 return *(uint32_t *) ptr
;
400 case 8: if (layout
->reverse_byte_order
) {
401 return __bswap_64(*(uint64_t *) ptr
);
403 return *(uint64_t *) ptr
;
412 #define crash_get_field(layout, map, name) \
413 _crash_get_field(layout, (map) + (layout)->offset.name, \
416 #define crash_get_array_field(layout, map, array_name, idx, field_name) \
417 _crash_get_field(layout, \
418 (map) + (layout)->offset.array_name \
419 + (idx * (layout)->stride.array_name) \
420 + (layout)->offset.field_name, \
421 (layout)->length.field_name)
423 #define crash_get_hdr_raw_field(layout, hdr, name) ((hdr)->name)
425 #define crash_get_hdr_field(layout, hdr, name) \
426 _crash_get_field(layout, (const char *) &(hdr)->name, \
429 #define crash_get_layout(layout, hdr, name) \
431 (layout)->name = crash_get_hdr_field(layout, hdr, \
433 DBG("layout.%s = %" PRIu64, #name, \
434 (uint64_t) (layout)->name); \
438 int get_crash_layout_0_0(struct lttng_crash_layout
*layout
,
441 const struct crash_abi_0_0
*abi
= (const struct crash_abi_0_0
*) map
;
443 crash_get_layout(layout
, abi
, offset
.prod_offset
);
444 crash_get_layout(layout
, abi
, offset
.consumed_offset
);
445 crash_get_layout(layout
, abi
, offset
.commit_hot_array
);
446 crash_get_layout(layout
, abi
, offset
.commit_hot_seq
);
447 crash_get_layout(layout
, abi
, offset
.buf_wsb_array
);
448 crash_get_layout(layout
, abi
, offset
.buf_wsb_id
);
449 crash_get_layout(layout
, abi
, offset
.sb_array
);
450 crash_get_layout(layout
, abi
, offset
.sb_array_shmp_offset
);
451 crash_get_layout(layout
, abi
, offset
.sb_backend_p_offset
);
452 crash_get_layout(layout
, abi
, offset
.content_size
);
453 crash_get_layout(layout
, abi
, offset
.packet_size
);
455 crash_get_layout(layout
, abi
, length
.prod_offset
);
456 crash_get_layout(layout
, abi
, length
.consumed_offset
);
457 crash_get_layout(layout
, abi
, length
.commit_hot_seq
);
458 crash_get_layout(layout
, abi
, length
.buf_wsb_id
);
459 crash_get_layout(layout
, abi
, length
.sb_array_shmp_offset
);
460 crash_get_layout(layout
, abi
, length
.sb_backend_p_offset
);
461 crash_get_layout(layout
, abi
, length
.content_size
);
462 crash_get_layout(layout
, abi
, length
.packet_size
);
464 crash_get_layout(layout
, abi
, stride
.commit_hot_array
);
465 crash_get_layout(layout
, abi
, stride
.buf_wsb_array
);
466 crash_get_layout(layout
, abi
, stride
.sb_array
);
468 crash_get_layout(layout
, abi
, buf_size
);
469 crash_get_layout(layout
, abi
, subbuf_size
);
470 crash_get_layout(layout
, abi
, num_subbuf
);
471 crash_get_layout(layout
, abi
, mode
);
477 void print_dbg_magic(const uint8_t *magic
)
479 DBG("magic: 0x%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X",
480 magic
[0], magic
[1], magic
[2], magic
[3],
481 magic
[4], magic
[5], magic
[6], magic
[7],
482 magic
[8], magic
[9], magic
[10], magic
[11],
483 magic
[12], magic
[13], magic
[14], magic
[15]);
487 int check_magic(const uint8_t *magic
)
491 for (i
= 0; i
< RB_CRASH_DUMP_ABI_MAGIC_LEN
; i
++) {
492 if ((magic
[i
] ^ 0xFF) != lttng_crash_expected_magic_xor
[i
]) {
500 int get_crash_layout(struct lttng_crash_layout
*layout
, int fd
)
503 int ret
= 0, unmapret
;
504 const uint8_t *magic
;
505 uint64_t mmap_length
;
506 uint16_t major
, minor
;
508 const struct crash_abi_unknown
*abi
;
510 enum lttng_crash_type layout_type
;
512 map
= mmap(NULL
, RB_CRASH_DUMP_ABI_LEN
, PROT_READ
, MAP_PRIVATE
,
514 if (map
== MAP_FAILED
) {
515 PERROR("Mapping file");
518 abi
= (const struct crash_abi_unknown
*) map
;
519 magic
= crash_get_hdr_raw_field(layout
, abi
, magic
);
520 print_dbg_magic(magic
);
521 if (check_magic(magic
)) {
522 DBG("Unknown magic number");
523 ret
= 1; /* positive return value, skip */
526 endian
= crash_get_hdr_field(layout
, abi
, endian
);
528 case RB_CRASH_ENDIAN
:
530 case RB_CRASH_ENDIAN_REVERSE
:
531 layout
->reverse_byte_order
= 1;
534 DBG("Unknown endianness value: 0x%X", (unsigned int) endian
);
535 ret
= 1; /* positive return value, skip */
538 layout_type
= (enum lttng_crash_type
) crash_get_hdr_field(layout
, abi
, layout_type
);
539 switch (layout_type
) {
540 case LTTNG_CRASH_TYPE_UST
:
542 case LTTNG_CRASH_TYPE_KERNEL
:
543 ERR("lttng-modules buffer layout support not implemented");
544 ret
= 1; /* positive return value, skip */
547 ERR("Unknown layout type %u", (unsigned int) layout_type
);
548 ret
= 1; /* positive return value, skip */
551 mmap_length
= crash_get_hdr_field(layout
, abi
, mmap_length
);
552 DBG("mmap_length: %" PRIu64
, mmap_length
);
553 layout
->mmap_length
= mmap_length
;
554 major
= crash_get_hdr_field(layout
, abi
, major
);
555 DBG("major: %u", major
);
556 minor
= crash_get_hdr_field(layout
, abi
, minor
);
557 DBG("minor: %u", minor
);
558 word_size
= crash_get_hdr_field(layout
, abi
, word_size
);
559 DBG("word_size: %u", word_size
);
564 ret
= get_crash_layout_0_0(layout
, map
);
570 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
575 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
579 layout
->word_size
= word_size
;
581 unmapret
= munmap(map
, RB_CRASH_DUMP_ABI_LEN
);
588 /* buf_trunc mask selects only the buffer number. */
590 uint64_t buf_trunc(uint64_t offset
, uint64_t buf_size
)
592 return offset
& ~(buf_size
- 1);
595 /* subbuf_trunc mask selects the subbuffer number. */
597 uint64_t subbuf_trunc(uint64_t offset
, uint64_t subbuf_size
)
599 return offset
& ~(subbuf_size
- 1);
602 /* buf_offset mask selects only the offset within the current buffer. */
604 uint64_t buf_offset(uint64_t offset
, uint64_t buf_size
)
606 return offset
& (buf_size
- 1);
609 /* subbuf_offset mask selects the offset within the current subbuffer. */
611 uint64_t subbuf_offset(uint64_t offset
, uint64_t subbuf_size
)
613 return offset
& (subbuf_size
- 1);
616 /* subbuf_index returns the index of the current subbuffer within the buffer. */
618 uint64_t subbuf_index(uint64_t offset
, uint64_t buf_size
, uint64_t subbuf_size
)
620 return buf_offset(offset
, buf_size
) / subbuf_size
;
624 uint64_t subbuffer_id_get_index(uint32_t mode
, uint64_t id
,
627 if (mode
== RING_BUFFER_OVERWRITE
)
628 return id
& SB_ID_INDEX_MASK(wl
);
634 int copy_crash_subbuf(const struct lttng_crash_layout
*layout
,
635 int fd_dest
, char *buf
, uint64_t offset
)
637 uint64_t buf_size
, subbuf_size
, num_subbuf
, sbidx
, id
,
638 sb_bindex
, rpages_offset
, p_offset
, seq_cc
,
639 committed
, commit_count_mask
, consumed_cur
,
645 * Get the current subbuffer by applying the proper mask to
646 * "offset", and looking up the subbuf location within the
650 buf_size
= layout
->buf_size
;
651 subbuf_size
= layout
->subbuf_size
;
652 num_subbuf
= layout
->num_subbuf
;
654 switch (layout
->word_size
) {
655 case 4: commit_count_mask
= 0xFFFFFFFFULL
/ num_subbuf
;
657 case 8: commit_count_mask
= 0xFFFFFFFFFFFFFFFFULL
/ num_subbuf
;
660 ERR("Unsupported word size: %u",
661 (unsigned int) layout
->word_size
);
665 DBG("Copy crash subbuffer at offset %lu", offset
);
666 sbidx
= subbuf_index(offset
, buf_size
, subbuf_size
);
669 * Find where the seq cc is located. Compute length of data to
672 seq_cc
= crash_get_array_field(layout
, buf
, commit_hot_array
,
673 sbidx
, commit_hot_seq
);
674 consumed_cur
= crash_get_field(layout
, buf
, consumed_offset
);
677 * Check that the buffer we are getting is after or at
678 * consumed_cur position.
680 if ((long) subbuf_trunc(offset
, subbuf_size
)
681 - (long) subbuf_trunc(consumed_cur
, subbuf_size
) < 0) {
682 DBG("No data: position is before consumed_cur");
687 * Check if subbuffer has been fully committed.
689 if (((seq_cc
- subbuf_size
) & commit_count_mask
)
690 - (buf_trunc(offset
, buf_size
) / num_subbuf
)
692 committed
= subbuf_size
;
694 committed
= subbuf_offset(seq_cc
, subbuf_size
);
696 DBG("No data committed, seq_cc: %" PRIu64
, seq_cc
);
701 /* Find actual physical offset in subbuffer table */
702 id
= crash_get_array_field(layout
, buf
, buf_wsb_array
,
704 sb_bindex
= subbuffer_id_get_index(layout
->mode
, id
,
706 rpages_offset
= crash_get_array_field(layout
, buf
, sb_array
,
707 sb_bindex
, sb_array_shmp_offset
);
708 p_offset
= crash_get_field(layout
, buf
+ rpages_offset
,
709 sb_backend_p_offset
);
710 subbuf_ptr
= buf
+ p_offset
;
712 if (committed
== subbuf_size
) {
714 * Packet header can be used.
716 if (layout
->length
.packet_size
) {
718 subbuf_ptr
+ layout
->offset
.packet_size
,
719 layout
->length
.packet_size
);
720 if (layout
->reverse_byte_order
) {
721 packet_size
= __bswap_64(packet_size
);
723 packet_size
/= CHAR_BIT
;
725 packet_size
= subbuf_size
;
731 * Find where to patch the sub-buffer header with actual
732 * readable data len and packet len, derived from seq
733 * cc. Patch it in our in-memory copy.
735 patch_size
= committed
* CHAR_BIT
;
736 if (layout
->reverse_byte_order
) {
737 patch_size
= __bswap_64(patch_size
);
739 if (layout
->length
.content_size
) {
740 memcpy(subbuf_ptr
+ layout
->offset
.content_size
,
741 &patch_size
, layout
->length
.content_size
);
743 if (layout
->length
.packet_size
) {
744 memcpy(subbuf_ptr
+ layout
->offset
.packet_size
,
745 &patch_size
, layout
->length
.packet_size
);
747 packet_size
= committed
;
751 * Copy packet into fd_dest.
753 writelen
= lttng_write(fd_dest
, subbuf_ptr
, packet_size
);
754 if (writelen
< packet_size
) {
755 PERROR("Error writing to output file");
758 DBG("Copied %" PRIu64
" bytes of data", packet_size
);
766 int copy_crash_data(const struct lttng_crash_layout
*layout
, int fd_dest
,
770 int ret
= 0, has_data
= 0;
773 uint64_t prod_offset
, consumed_offset
;
774 uint64_t offset
, subbuf_size
;
777 ret
= fstat(fd_src
, &statbuf
);
781 src_file_len
= layout
->mmap_length
;
782 buf
= zmalloc(src_file_len
);
786 readlen
= lttng_read(fd_src
, buf
, src_file_len
);
788 PERROR("Error reading input file");
793 prod_offset
= crash_get_field(layout
, buf
, prod_offset
);
794 DBG("prod_offset: 0x%" PRIx64
, prod_offset
);
795 consumed_offset
= crash_get_field(layout
, buf
, consumed_offset
);
796 DBG("consumed_offset: 0x%" PRIx64
, consumed_offset
);
797 subbuf_size
= layout
->subbuf_size
;
799 for (offset
= consumed_offset
; offset
< prod_offset
;
800 offset
+= subbuf_size
) {
801 ret
= copy_crash_subbuf(layout
, fd_dest
, buf
, offset
);
811 if (ret
&& ret
!= -ENODATA
) {
822 int extract_file(int output_dir_fd
, const char *output_file
,
823 int input_dir_fd
, const char *input_file
)
825 int fd_dest
, fd_src
, ret
= 0, closeret
;
826 struct lttng_crash_layout layout
;
828 layout
.reverse_byte_order
= 0; /* For reading magic number */
830 DBG("Extract file '%s'", input_file
);
831 fd_src
= openat(input_dir_fd
, input_file
, O_RDONLY
);
833 PERROR("Error opening '%s' for reading",
839 /* Query the crash ABI layout */
840 ret
= get_crash_layout(&layout
, fd_src
);
845 fd_dest
= openat(output_dir_fd
, output_file
,
846 O_RDWR
| O_CREAT
| O_EXCL
,
847 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
849 PERROR("Error opening '%s' for writing",
855 ret
= copy_crash_data(&layout
, fd_dest
, fd_src
);
861 closeret
= close(fd_dest
);
865 if (ret
== -ENODATA
) {
866 closeret
= unlinkat(output_dir_fd
, output_file
, 0);
872 closeret
= close(fd_src
);
881 int extract_all_files(const char *output_path
,
882 const char *input_path
)
884 DIR *input_dir
, *output_dir
;
885 int input_dir_fd
, output_dir_fd
, ret
= 0, closeret
;
886 struct dirent
*entry
; /* input */
888 /* Open input directory */
889 input_dir
= opendir(input_path
);
891 PERROR("Cannot open '%s' path", input_path
);
894 input_dir_fd
= dirfd(input_dir
);
895 if (input_dir_fd
< 0) {
900 /* Open output directory */
901 output_dir
= opendir(output_path
);
903 PERROR("Cannot open '%s' path", output_path
);
906 output_dir_fd
= dirfd(output_dir
);
907 if (output_dir_fd
< 0) {
912 while ((entry
= readdir(input_dir
))) {
913 if (!strcmp(entry
->d_name
, ".")
914 || !strcmp(entry
->d_name
, ".."))
916 ret
= extract_file(output_dir_fd
, entry
->d_name
,
917 input_dir_fd
, entry
->d_name
);
918 if (ret
== -ENODATA
) {
919 DBG("No data in file '%s', skipping", entry
->d_name
);
922 } else if (ret
< 0) {
924 } else if (ret
> 0) {
925 DBG("Skipping file '%s'", entry
->d_name
);
930 closeret
= closedir(output_dir
);
934 closeret
= closedir(input_dir
);
942 int extract_one_trace(const char *output_path
,
943 const char *input_path
)
945 char dest
[PATH_MAX
], src
[PATH_MAX
];
948 DBG("Extract crash trace '%s' into '%s'", input_path
, output_path
);
951 strncpy(dest
, output_path
, PATH_MAX
);
952 dest
[PATH_MAX
- 1] = '\0';
953 strncat(dest
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
955 strncpy(src
, input_path
, PATH_MAX
);
956 src
[PATH_MAX
- 1] = '\0';
957 strncat(src
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
959 ret
= copy_file(dest
, src
);
964 /* Extract each other file that has expected header */
965 return extract_all_files(output_path
, input_path
);
969 int extract_trace_recursive(const char *output_path
,
970 const char *input_path
)
973 int dir_fd
, ret
= 0, closeret
;
974 struct dirent
*entry
;
978 dir
= opendir(input_path
);
980 PERROR("Cannot open '%s' path", input_path
);
989 while ((entry
= readdir(dir
))) {
990 if (!strcmp(entry
->d_name
, ".")
991 || !strcmp(entry
->d_name
, "..")) {
994 switch (entry
->d_type
) {
997 char output_subpath
[PATH_MAX
];
998 char input_subpath
[PATH_MAX
];
1000 strncpy(output_subpath
, output_path
,
1001 sizeof(output_subpath
));
1002 output_subpath
[sizeof(output_subpath
) - 1] = '\0';
1003 strncat(output_subpath
, "/",
1004 sizeof(output_subpath
) - strlen(output_subpath
) - 1);
1005 strncat(output_subpath
, entry
->d_name
,
1006 sizeof(output_subpath
) - strlen(output_subpath
) - 1);
1008 ret
= mkdir(output_subpath
, S_IRWXU
| S_IRWXG
);
1015 strncpy(input_subpath
, input_path
,
1016 sizeof(input_subpath
));
1017 input_subpath
[sizeof(input_subpath
) - 1] = '\0';
1018 strncat(input_subpath
, "/",
1019 sizeof(input_subpath
) - strlen(input_subpath
) - 1);
1020 strncat(input_subpath
, entry
->d_name
,
1021 sizeof(input_subpath
) - strlen(input_subpath
) - 1);
1023 ret
= extract_trace_recursive(output_subpath
,
1031 if (!strcmp(entry
->d_name
, "metadata")) {
1032 ret
= extract_one_trace(output_path
,
1035 WARN("Error extracting trace '%s', continuing anyway.",
1040 /* Ignore other files */
1048 closeret
= closedir(dir
);
1056 int delete_dir_recursive(const char *path
)
1059 int dir_fd
, ret
= 0, closeret
;
1060 struct dirent
*entry
;
1062 /* Open trace directory */
1063 dir
= opendir(path
);
1065 PERROR("Cannot open '%s' path", path
);
1069 dir_fd
= dirfd(dir
);
1076 while ((entry
= readdir(dir
))) {
1077 if (!strcmp(entry
->d_name
, ".")
1078 || !strcmp(entry
->d_name
, "..")) {
1081 switch (entry
->d_type
) {
1084 char *subpath
= zmalloc(PATH_MAX
);
1087 PERROR("zmalloc path");
1091 strncpy(subpath
, path
, PATH_MAX
);
1092 subpath
[PATH_MAX
- 1] = '\0';
1093 strncat(subpath
, "/",
1094 PATH_MAX
- strlen(subpath
) - 1);
1095 strncat(subpath
, entry
->d_name
,
1096 PATH_MAX
- strlen(subpath
) - 1);
1098 ret
= delete_dir_recursive(subpath
);
1101 /* Error occured, abort traversal. */
1107 ret
= unlinkat(dir_fd
, entry
->d_name
, 0);
1109 PERROR("Unlinking '%s'", entry
->d_name
);
1122 PERROR("rmdir '%s'", path
);
1125 closeret
= closedir(dir
);
1133 int view_trace(const char *viewer_path
, const char *trace_path
)
1142 } else if (pid
> 0) {
1146 pid
= waitpid(pid
, &status
, 0);
1147 if (pid
< 0 || !WIFEXITED(status
)) {
1154 ret
= execlp(viewer_path
, viewer_path
,
1155 trace_path
, (char *) NULL
);
1160 exit(EXIT_SUCCESS
); /* Never reached */
1168 int main(int argc
, char *argv
[])
1171 bool has_warning
= false;
1172 const char *output_path
= NULL
;
1173 char tmppath
[] = "/tmp/lttng-crash-XXXXXX";
1175 progname
= argv
[0] ? argv
[0] : "lttng-crash";
1177 ret
= parse_args(argc
, argv
);
1180 } else if (ret
< 0) {
1185 if (opt_output_path
) {
1186 output_path
= opt_output_path
;
1187 ret
= mkdir(output_path
, S_IRWXU
| S_IRWXG
);
1194 output_path
= mkdtemp(tmppath
);
1202 ret
= extract_trace_recursive(output_path
, input_path
);
1206 } else if (ret
> 0) {
1207 /* extract_trace_recursive reported a warning. */
1210 if (!opt_output_path
) {
1212 ret
= view_trace(opt_viewer_path
, output_path
);
1216 /* unlink temporary trace */
1217 ret
= delete_dir_recursive(output_path
);
1223 exit(has_warning
? EXIT_FAILURE
: EXIT_SUCCESS
);