2 * Copyright (C) 2011 EfficiOS Inc.
3 * Copyright (C) 2014 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
15 #include <sys/types.h>
23 #include <common/compat/endian.hpp>
27 #include <version.hpp>
28 #include <lttng/lttng.h>
29 #include <common/common.hpp>
30 #include <common/spawn-viewer.hpp>
31 #include <common/utils.hpp>
33 #define COPY_BUFLEN 4096
34 #define RB_CRASH_DUMP_ABI_LEN 32
36 #define RB_CRASH_DUMP_ABI_MAGIC_LEN 16
39 * The 128-bit magic number is xor'd in the process data so it does not
40 * cause a false positive when searching for buffers by scanning memory.
41 * The actual magic number is:
42 * 0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17, 0x7B, 0xF1,
43 * 0x77, 0xBF, 0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17,
45 #define RB_CRASH_DUMP_ABI_MAGIC_XOR \
47 0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF, 0x77 ^ 0xFF, \
48 0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF, \
49 0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF, \
50 0xF1 ^ 0xFF, 0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF, \
53 static const char *help_msg
=
54 #ifdef LTTNG_EMBED_HELP
55 #include <lttng-crash.1.h>
62 * Non-static to ensure the compiler does not optimize away the xor.
64 uint8_t lttng_crash_expected_magic_xor
[] = RB_CRASH_DUMP_ABI_MAGIC_XOR
;
66 #define RB_CRASH_ENDIAN 0x1234
67 #define RB_CRASH_ENDIAN_REVERSE 0x3412
69 enum lttng_crash_type
{
70 LTTNG_CRASH_TYPE_UST
= 0,
71 LTTNG_CRASH_TYPE_KERNEL
= 1,
74 /* LTTng ring buffer defines (copied) */
76 #define HALF_ULONG_BITS(wl) (((wl) * CHAR_BIT) >> 1)
78 #define SB_ID_OFFSET_SHIFT(wl) (HALF_ULONG_BITS(wl) + 1)
79 #define SB_ID_OFFSET_COUNT(wl) (1UL << SB_ID_OFFSET_SHIFT(wl))
80 #define SB_ID_OFFSET_MASK(wl) (~(SB_ID_OFFSET_COUNT(wl) - 1))
82 * Lowest bit of top word half belongs to noref. Used only for overwrite mode.
84 #define SB_ID_NOREF_SHIFT(wl) (SB_ID_OFFSET_SHIFT(wl) - 1)
85 #define SB_ID_NOREF_COUNT(wl) (1UL << SB_ID_NOREF_SHIFT(wl))
86 #define SB_ID_NOREF_MASK(wl) SB_ID_NOREF_COUNT(wl)
88 * In overwrite mode: lowest half of word is used for index.
89 * Limit of 2^16 subbuffers per buffer on 32-bit, 2^32 on 64-bit.
90 * In producer-consumer mode: whole word used for index.
92 #define SB_ID_INDEX_SHIFT(wl) 0
93 #define SB_ID_INDEX_COUNT(wl) (1UL << SB_ID_INDEX_SHIFT(wl))
94 #define SB_ID_INDEX_MASK(wl) (SB_ID_NOREF_COUNT(wl) - 1)
97 RING_BUFFER_OVERWRITE
= 0, /* Overwrite when buffer full */
98 RING_BUFFER_DISCARD
= 1, /* Discard when buffer full */
102 struct crash_abi_unknown
{
103 uint8_t magic
[RB_CRASH_DUMP_ABI_MAGIC_LEN
];
104 uint64_t mmap_length
; /* Overall length of crash record */
106 * { 0x12, 0x34 }: big endian
107 * { 0x34, 0x12 }: little endian
109 uint16_t major
; /* Major number. */
110 uint16_t minor
; /* Minor number. */
111 uint8_t word_size
; /* Word size (bytes). */
112 uint8_t layout_type
; /* enum lttng_crash_layout */
113 } __attribute__((packed
));
115 struct crash_abi_0_0
{
116 struct crash_abi_unknown parent
;
119 uint32_t prod_offset
;
120 uint32_t consumed_offset
;
121 uint32_t commit_hot_array
;
122 uint32_t commit_hot_seq
;
123 uint32_t buf_wsb_array
;
126 uint32_t sb_array_shmp_offset
;
127 uint32_t sb_backend_p_offset
;
128 uint32_t content_size
;
129 uint32_t packet_size
;
130 } __attribute__((packed
)) offset
;
133 uint8_t consumed_offset
;
134 uint8_t commit_hot_seq
;
136 uint8_t sb_array_shmp_offset
;
137 uint8_t sb_backend_p_offset
;
138 uint8_t content_size
;
140 } __attribute__((packed
)) length
;
142 uint32_t commit_hot_array
;
143 uint32_t buf_wsb_array
;
145 } __attribute__((packed
)) stride
;
147 uint64_t buf_size
; /* Size of the buffer */
148 uint64_t subbuf_size
; /* Sub-buffer size */
149 uint64_t num_subbuf
; /* Number of sub-buffers for writer */
150 uint32_t mode
; /* Buffer mode: 0: overwrite, 1: discard */
151 } __attribute__((packed
));
153 struct lttng_crash_layout
{
155 int prod_offset
, consumed_offset
,
156 commit_hot_array
, commit_hot_seq
,
157 buf_wsb_array
, buf_wsb_id
,
158 sb_array
, sb_array_shmp_offset
,
159 sb_backend_p_offset
, content_size
,
163 int prod_offset
, consumed_offset
,
164 commit_hot_seq
, buf_wsb_id
,
165 sb_array_shmp_offset
, sb_backend_p_offset
,
166 content_size
, packet_size
;
169 int commit_hot_array
, buf_wsb_array
, sb_array
;
172 int reverse_byte_order
;
175 uint64_t mmap_length
; /* Length of crash record */
176 uint64_t buf_size
; /* Size of the buffer */
177 uint64_t subbuf_size
; /* Sub-buffer size */
178 uint64_t num_subbuf
; /* Number of sub-buffers for writer */
179 uint32_t mode
; /* Buffer mode: 0: overwrite, 1: discard */
184 static const char *progname
;
185 static char *opt_viewer_path
= NULL
;
186 static char *opt_output_path
= NULL
;
188 static char *the_input_path
;
190 int lttng_opt_quiet
, lttng_opt_verbose
, lttng_opt_mi
;
196 /* Getopt options. No first level command. */
197 static struct option long_options
[] = {
198 { "version", 0, NULL
, 'V' },
199 { "help", 0, NULL
, 'h' },
200 { "verbose", 0, NULL
, 'v' },
201 { "viewer", 1, NULL
, 'e' },
202 { "extract", 1, NULL
, 'x' },
203 { "list-options", 0, NULL
, OPT_DUMP_OPTIONS
},
204 { NULL
, 0, NULL
, 0 },
207 static void usage(void)
209 int ret
= utils_show_help(1, "lttng-crash", help_msg
);
212 ERR("Cannot show --help for `lttng-crash`");
218 static void version(FILE *ofp
)
220 fprintf(ofp
, "%s (LTTng Crash Trace Viewer) " VERSION
" - " VERSION_NAME
223 GIT_VERSION
[0] == '\0' ? "" : " - " GIT_VERSION
,
224 EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " EXTRA_VERSION_NAME
);
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 /* No leftovers, or more than one input path, print usage and quit */
300 if (argc
- optind
!= 1) {
301 ERR("Command-line error: Specify exactly one input path");
305 the_input_path
= argv
[optind
];
314 int copy_file(const char *file_dest
, const char *file_src
)
316 int fd_src
= -1, fd_dest
= -1;
317 ssize_t readlen
, writelen
;
318 char buf
[COPY_BUFLEN
];
321 DBG("Copy metadata file '%s' into '%s'", file_src
, file_dest
);
323 fd_src
= open(file_src
, O_RDONLY
);
325 PERROR("Error opening %s for reading", file_src
);
329 fd_dest
= open(file_dest
, O_RDWR
| O_CREAT
| O_EXCL
,
330 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
332 PERROR("Error opening %s for writing", file_dest
);
338 readlen
= lttng_read(fd_src
, buf
, COPY_BUFLEN
);
340 PERROR("Error reading input file");
347 writelen
= lttng_write(fd_dest
, buf
, readlen
);
348 if (writelen
< readlen
) {
349 PERROR("Error writing to output file");
358 if (close(fd_src
) < 0) {
359 PERROR("Error closing %s", file_src
);
364 if (close(fd_dest
) < 0) {
365 PERROR("Error closing %s", file_dest
);
372 uint64_t _crash_get_field(const struct lttng_crash_layout
*layout
,
373 const char *ptr
, size_t size
)
376 case 1: return *(uint8_t *) ptr
;
377 case 2: if (layout
->reverse_byte_order
) {
378 return bswap_16(*(uint16_t *) ptr
);
380 return *(uint16_t *) ptr
;
383 case 4: if (layout
->reverse_byte_order
) {
384 return bswap_32(*(uint32_t *) ptr
);
386 return *(uint32_t *) ptr
;
389 case 8: if (layout
->reverse_byte_order
) {
390 return bswap_64(*(uint64_t *) ptr
);
392 return *(uint64_t *) ptr
;
401 #define crash_get_field(layout, map, name) \
402 _crash_get_field(layout, (map) + (layout)->offset.name, \
405 #define crash_get_array_field(layout, map, array_name, idx, field_name) \
406 _crash_get_field(layout, \
407 (map) + (layout)->offset.array_name \
408 + (idx * (layout)->stride.array_name) \
409 + (layout)->offset.field_name, \
410 (layout)->length.field_name)
412 #define crash_get_hdr_raw_field(layout, hdr, name) ((hdr)->name)
414 #define crash_get_hdr_field(layout, hdr, name) \
415 _crash_get_field(layout, (const char *) &(hdr)->name, \
418 #define crash_get_layout(layout, hdr, name) \
420 (layout)->name = crash_get_hdr_field(layout, hdr, \
422 DBG("layout.%s = %" PRIu64, #name, \
423 (uint64_t) (layout)->name); \
427 int get_crash_layout_0_0(struct lttng_crash_layout
*layout
,
430 const struct crash_abi_0_0
*abi
= (const struct crash_abi_0_0
*) map
;
432 crash_get_layout(layout
, abi
, offset
.prod_offset
);
433 crash_get_layout(layout
, abi
, offset
.consumed_offset
);
434 crash_get_layout(layout
, abi
, offset
.commit_hot_array
);
435 crash_get_layout(layout
, abi
, offset
.commit_hot_seq
);
436 crash_get_layout(layout
, abi
, offset
.buf_wsb_array
);
437 crash_get_layout(layout
, abi
, offset
.buf_wsb_id
);
438 crash_get_layout(layout
, abi
, offset
.sb_array
);
439 crash_get_layout(layout
, abi
, offset
.sb_array_shmp_offset
);
440 crash_get_layout(layout
, abi
, offset
.sb_backend_p_offset
);
441 crash_get_layout(layout
, abi
, offset
.content_size
);
442 crash_get_layout(layout
, abi
, offset
.packet_size
);
444 crash_get_layout(layout
, abi
, length
.prod_offset
);
445 crash_get_layout(layout
, abi
, length
.consumed_offset
);
446 crash_get_layout(layout
, abi
, length
.commit_hot_seq
);
447 crash_get_layout(layout
, abi
, length
.buf_wsb_id
);
448 crash_get_layout(layout
, abi
, length
.sb_array_shmp_offset
);
449 crash_get_layout(layout
, abi
, length
.sb_backend_p_offset
);
450 crash_get_layout(layout
, abi
, length
.content_size
);
451 crash_get_layout(layout
, abi
, length
.packet_size
);
453 crash_get_layout(layout
, abi
, stride
.commit_hot_array
);
454 crash_get_layout(layout
, abi
, stride
.buf_wsb_array
);
455 crash_get_layout(layout
, abi
, stride
.sb_array
);
457 crash_get_layout(layout
, abi
, buf_size
);
458 crash_get_layout(layout
, abi
, subbuf_size
);
459 crash_get_layout(layout
, abi
, num_subbuf
);
460 crash_get_layout(layout
, abi
, mode
);
466 void print_dbg_magic(const uint8_t *magic
)
468 DBG("magic: 0x%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X",
469 magic
[0], magic
[1], magic
[2], magic
[3],
470 magic
[4], magic
[5], magic
[6], magic
[7],
471 magic
[8], magic
[9], magic
[10], magic
[11],
472 magic
[12], magic
[13], magic
[14], magic
[15]);
476 int check_magic(const uint8_t *magic
)
480 for (i
= 0; i
< RB_CRASH_DUMP_ABI_MAGIC_LEN
; i
++) {
481 if ((magic
[i
] ^ 0xFF) != lttng_crash_expected_magic_xor
[i
]) {
489 int get_crash_layout(struct lttng_crash_layout
*layout
, int fd
,
490 const char *input_file
)
493 int ret
= 0, unmapret
;
494 const uint8_t *magic
;
495 uint64_t mmap_length
;
496 uint16_t major
, minor
;
498 const struct crash_abi_unknown
*abi
;
500 enum lttng_crash_type layout_type
;
503 ret
= fstat(fd
, &stat
);
505 PERROR("Failed to fstat '%s'", input_file
);
508 if (stat
.st_size
< RB_CRASH_DUMP_ABI_LEN
) {
509 ERR("File '%s' truncated: file length of %" PRIi64
510 " bytes does not meet the minimal expected "
511 "length of %d bytes",
512 input_file
, (int64_t) stat
.st_size
,
513 RB_CRASH_DUMP_ABI_LEN
);
516 map
= (char *) mmap(NULL
, RB_CRASH_DUMP_ABI_LEN
, PROT_READ
, MAP_PRIVATE
,
518 if (map
== MAP_FAILED
) {
519 PERROR("Mapping file");
522 abi
= (const struct crash_abi_unknown
*) map
;
523 magic
= crash_get_hdr_raw_field(layout
, abi
, magic
);
524 print_dbg_magic(magic
);
525 if (check_magic(magic
)) {
526 DBG("Unknown magic number");
527 ret
= 1; /* positive return value, skip */
530 endian
= crash_get_hdr_field(layout
, abi
, endian
);
532 case RB_CRASH_ENDIAN
:
534 case RB_CRASH_ENDIAN_REVERSE
:
535 layout
->reverse_byte_order
= 1;
538 DBG("Unknown endianness value: 0x%X", (unsigned int) endian
);
539 ret
= 1; /* positive return value, skip */
542 layout_type
= (enum lttng_crash_type
) crash_get_hdr_field(layout
, abi
, layout_type
);
543 switch (layout_type
) {
544 case LTTNG_CRASH_TYPE_UST
:
546 case LTTNG_CRASH_TYPE_KERNEL
:
547 ERR("lttng-modules buffer layout support not implemented");
548 ret
= 1; /* positive return value, skip */
551 ERR("Unknown layout type %u", (unsigned int) layout_type
);
552 ret
= 1; /* positive return value, skip */
555 mmap_length
= crash_get_hdr_field(layout
, abi
, mmap_length
);
556 DBG("mmap_length: %" PRIu64
, mmap_length
);
557 layout
->mmap_length
= mmap_length
;
558 major
= crash_get_hdr_field(layout
, abi
, major
);
559 DBG("major: %u", major
);
560 minor
= crash_get_hdr_field(layout
, abi
, minor
);
561 DBG("minor: %u", minor
);
562 word_size
= crash_get_hdr_field(layout
, abi
, word_size
);
563 DBG("word_size: %u", word_size
);
568 ret
= get_crash_layout_0_0(layout
, map
);
574 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
579 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
583 layout
->word_size
= word_size
;
585 unmapret
= munmap(map
, RB_CRASH_DUMP_ABI_LEN
);
592 /* buf_trunc mask selects only the buffer number. */
594 uint64_t buf_trunc(uint64_t offset
, uint64_t buf_size
)
596 return offset
& ~(buf_size
- 1);
599 /* subbuf_trunc mask selects the subbuffer number. */
601 uint64_t subbuf_trunc(uint64_t offset
, uint64_t subbuf_size
)
603 return offset
& ~(subbuf_size
- 1);
606 /* buf_offset mask selects only the offset within the current buffer. */
608 uint64_t buf_offset(uint64_t offset
, uint64_t buf_size
)
610 return offset
& (buf_size
- 1);
613 /* subbuf_offset mask selects the offset within the current subbuffer. */
615 uint64_t subbuf_offset(uint64_t offset
, uint64_t subbuf_size
)
617 return offset
& (subbuf_size
- 1);
620 /* subbuf_index returns the index of the current subbuffer within the buffer. */
622 uint64_t subbuf_index(uint64_t offset
, uint64_t buf_size
, uint64_t subbuf_size
)
624 return buf_offset(offset
, buf_size
) / subbuf_size
;
628 uint64_t subbuffer_id_get_index(uint32_t mode
, uint64_t id
,
631 if (mode
== RING_BUFFER_OVERWRITE
)
632 return id
& SB_ID_INDEX_MASK(wl
);
638 int copy_crash_subbuf(const struct lttng_crash_layout
*layout
,
639 int fd_dest
, char *buf
, uint64_t offset
)
641 uint64_t buf_size
, subbuf_size
, num_subbuf
, sbidx
, id
,
642 sb_bindex
, rpages_offset
, p_offset
, seq_cc
,
643 committed
, commit_count_mask
, consumed_cur
,
649 * Get the current subbuffer by applying the proper mask to
650 * "offset", and looking up the subbuf location within the
654 buf_size
= layout
->buf_size
;
655 subbuf_size
= layout
->subbuf_size
;
656 num_subbuf
= layout
->num_subbuf
;
658 switch (layout
->word_size
) {
659 case 4: commit_count_mask
= 0xFFFFFFFFULL
/ num_subbuf
;
661 case 8: commit_count_mask
= 0xFFFFFFFFFFFFFFFFULL
/ num_subbuf
;
664 ERR("Unsupported word size: %u",
665 (unsigned int) layout
->word_size
);
669 DBG("Copy crash subbuffer at offset %" PRIu64
, offset
);
670 sbidx
= subbuf_index(offset
, buf_size
, subbuf_size
);
673 * Find where the seq cc is located. Compute length of data to
676 seq_cc
= crash_get_array_field(layout
, buf
, commit_hot_array
,
677 sbidx
, commit_hot_seq
);
678 consumed_cur
= crash_get_field(layout
, buf
, consumed_offset
);
681 * Check that the buffer we are getting is after or at
682 * consumed_cur position.
684 if ((long) subbuf_trunc(offset
, subbuf_size
)
685 - (long) subbuf_trunc(consumed_cur
, subbuf_size
) < 0) {
686 DBG("No data: position is before consumed_cur");
691 * Check if subbuffer has been fully committed.
693 if (((seq_cc
- subbuf_size
) & commit_count_mask
)
694 - (buf_trunc(offset
, buf_size
) / num_subbuf
)
696 committed
= subbuf_size
;
698 committed
= subbuf_offset(seq_cc
, subbuf_size
);
700 DBG("No data committed, seq_cc: %" PRIu64
, seq_cc
);
705 /* Find actual physical offset in subbuffer table */
706 id
= crash_get_array_field(layout
, buf
, buf_wsb_array
,
708 sb_bindex
= subbuffer_id_get_index(layout
->mode
, id
,
710 rpages_offset
= crash_get_array_field(layout
, buf
, sb_array
,
711 sb_bindex
, sb_array_shmp_offset
);
712 p_offset
= crash_get_field(layout
, buf
+ rpages_offset
,
713 sb_backend_p_offset
);
714 subbuf_ptr
= buf
+ p_offset
;
716 if (committed
== subbuf_size
) {
718 * Packet header can be used.
720 if (layout
->length
.packet_size
) {
722 subbuf_ptr
+ layout
->offset
.packet_size
,
723 layout
->length
.packet_size
);
724 if (layout
->reverse_byte_order
) {
725 packet_size
= bswap_64(packet_size
);
727 packet_size
/= CHAR_BIT
;
729 packet_size
= subbuf_size
;
735 * Find where to patch the sub-buffer header with actual
736 * readable data len and packet len, derived from seq
737 * cc. Patch it in our in-memory copy.
739 patch_size
= committed
* CHAR_BIT
;
740 if (layout
->reverse_byte_order
) {
741 patch_size
= bswap_64(patch_size
);
743 if (layout
->length
.content_size
) {
744 memcpy(subbuf_ptr
+ layout
->offset
.content_size
,
745 &patch_size
, layout
->length
.content_size
);
747 if (layout
->length
.packet_size
) {
748 memcpy(subbuf_ptr
+ layout
->offset
.packet_size
,
749 &patch_size
, layout
->length
.packet_size
);
751 packet_size
= committed
;
755 * Copy packet into fd_dest.
757 writelen
= lttng_write(fd_dest
, subbuf_ptr
, packet_size
);
758 if (writelen
< packet_size
) {
759 PERROR("Error writing to output file");
762 DBG("Copied %" PRIu64
" bytes of data", packet_size
);
770 int copy_crash_data(const struct lttng_crash_layout
*layout
, int fd_dest
,
774 int ret
= 0, has_data
= 0;
777 uint64_t prod_offset
, consumed_offset
;
778 uint64_t offset
, subbuf_size
;
781 ret
= fstat(fd_src
, &statbuf
);
785 src_file_len
= layout
->mmap_length
;
786 buf
= calloc
<char>(src_file_len
);
790 readlen
= lttng_read(fd_src
, buf
, src_file_len
);
792 PERROR("Error reading input file");
797 prod_offset
= crash_get_field(layout
, buf
, prod_offset
);
798 DBG("prod_offset: 0x%" PRIx64
, prod_offset
);
799 consumed_offset
= crash_get_field(layout
, buf
, consumed_offset
);
800 DBG("consumed_offset: 0x%" PRIx64
, consumed_offset
);
801 subbuf_size
= layout
->subbuf_size
;
803 for (offset
= consumed_offset
; offset
< prod_offset
;
804 offset
+= subbuf_size
) {
805 ret
= copy_crash_subbuf(layout
, fd_dest
, buf
, offset
);
815 if (ret
&& ret
!= -ENODATA
) {
826 int extract_file(int output_dir_fd
, const char *output_file
,
827 int input_dir_fd
, const char *input_file
)
829 int fd_dest
, fd_src
, ret
= 0, closeret
;
830 struct lttng_crash_layout layout
;
832 layout
.reverse_byte_order
= 0; /* For reading magic number */
834 DBG("Extract file '%s'", input_file
);
835 fd_src
= openat(input_dir_fd
, input_file
, O_RDONLY
);
837 PERROR("Error opening '%s' for reading",
843 /* Query the crash ABI layout */
844 ret
= get_crash_layout(&layout
, fd_src
, input_file
);
849 fd_dest
= openat(output_dir_fd
, output_file
,
850 O_RDWR
| O_CREAT
| O_EXCL
,
851 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
853 PERROR("Error opening '%s' for writing",
859 ret
= copy_crash_data(&layout
, fd_dest
, fd_src
);
865 closeret
= close(fd_dest
);
869 if (ret
== -ENODATA
) {
870 closeret
= unlinkat(output_dir_fd
, output_file
, 0);
876 closeret
= close(fd_src
);
885 int extract_all_files(const char *output_path
,
886 const char *input_path
)
888 DIR *input_dir
, *output_dir
;
889 int input_dir_fd
, output_dir_fd
, ret
= 0, closeret
;
890 struct dirent
*entry
; /* input */
892 /* Open input directory */
893 input_dir
= opendir(input_path
);
895 PERROR("Cannot open '%s' path", input_path
);
898 input_dir_fd
= dirfd(input_dir
);
899 if (input_dir_fd
< 0) {
904 /* Open output directory */
905 output_dir
= opendir(output_path
);
907 PERROR("Cannot open '%s' path", output_path
);
910 output_dir_fd
= dirfd(output_dir
);
911 if (output_dir_fd
< 0) {
916 while ((entry
= readdir(input_dir
))) {
917 if (!strcmp(entry
->d_name
, ".")
918 || !strcmp(entry
->d_name
, ".."))
920 ret
= extract_file(output_dir_fd
, entry
->d_name
,
921 input_dir_fd
, entry
->d_name
);
922 if (ret
== -ENODATA
) {
923 DBG("No data in file '%s', skipping", entry
->d_name
);
926 } else if (ret
< 0) {
928 } else if (ret
> 0) {
929 DBG("Skipping file '%s'", entry
->d_name
);
934 closeret
= closedir(output_dir
);
938 closeret
= closedir(input_dir
);
946 int extract_one_trace(const char *output_path
,
947 const char *input_path
)
949 char dest
[PATH_MAX
], src
[PATH_MAX
];
952 DBG("Extract crash trace '%s' into '%s'", input_path
, output_path
);
955 strncpy(dest
, output_path
, PATH_MAX
);
956 dest
[PATH_MAX
- 1] = '\0';
957 strncat(dest
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
959 strncpy(src
, input_path
, PATH_MAX
);
960 src
[PATH_MAX
- 1] = '\0';
961 strncat(src
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
963 ret
= copy_file(dest
, src
);
968 /* Extract each other file that has expected header */
969 return extract_all_files(output_path
, input_path
);
973 int extract_trace_recursive(const char *output_path
,
974 const char *input_path
)
977 int dir_fd
, ret
= 0, closeret
;
978 struct dirent
*entry
;
983 dir
= opendir(input_path
);
985 PERROR("Cannot open '%s' path", input_path
);
989 path_len
= strlen(input_path
);
997 while ((entry
= readdir(dir
))) {
1000 char filename
[PATH_MAX
];
1002 if (!strcmp(entry
->d_name
, ".")
1003 || !strcmp(entry
->d_name
, "..")) {
1007 name_len
= strlen(entry
->d_name
);
1008 if (path_len
+ name_len
+ 2 > sizeof(filename
)) {
1009 ERR("Failed to remove file: path name too long (%s/%s)",
1010 input_path
, entry
->d_name
);
1014 if (snprintf(filename
, sizeof(filename
), "%s/%s",
1015 input_path
, entry
->d_name
) < 0) {
1016 ERR("Failed to format path.");
1020 if (stat(filename
, &st
)) {
1025 if (S_ISDIR(st
.st_mode
)) {
1026 char output_subpath
[PATH_MAX
];
1027 char input_subpath
[PATH_MAX
];
1029 strncpy(output_subpath
, output_path
,
1030 sizeof(output_subpath
));
1031 output_subpath
[sizeof(output_subpath
) - 1] = '\0';
1032 strncat(output_subpath
, "/",
1033 sizeof(output_subpath
) - strlen(output_subpath
) - 1);
1034 strncat(output_subpath
, entry
->d_name
,
1035 sizeof(output_subpath
) - strlen(output_subpath
) - 1);
1037 ret
= mkdir(output_subpath
, S_IRWXU
| S_IRWXG
);
1044 strncpy(input_subpath
, input_path
,
1045 sizeof(input_subpath
));
1046 input_subpath
[sizeof(input_subpath
) - 1] = '\0';
1047 strncat(input_subpath
, "/",
1048 sizeof(input_subpath
) - strlen(input_subpath
) - 1);
1049 strncat(input_subpath
, entry
->d_name
,
1050 sizeof(input_subpath
) - strlen(input_subpath
) - 1);
1052 ret
= extract_trace_recursive(output_subpath
,
1057 } else if (S_ISREG(st
.st_mode
) || S_ISLNK(st
.st_mode
)) {
1058 if (!strcmp(entry
->d_name
, "metadata")) {
1059 ret
= extract_one_trace(output_path
,
1062 WARN("Error extracting trace '%s', continuing anyway.",
1073 closeret
= closedir(dir
);
1081 int delete_dir_recursive(const char *path
)
1084 int dir_fd
, ret
= 0, closeret
;
1086 struct dirent
*entry
;
1088 /* Open trace directory */
1089 dir
= opendir(path
);
1091 PERROR("Cannot open '%s' path", path
);
1093 goto end_no_closedir
;
1096 path_len
= strlen(path
);
1098 dir_fd
= dirfd(dir
);
1105 while ((entry
= readdir(dir
))) {
1108 char filename
[PATH_MAX
];
1110 if (!strcmp(entry
->d_name
, ".")
1111 || !strcmp(entry
->d_name
, "..")) {
1115 name_len
= strlen(entry
->d_name
);
1116 if (path_len
+ name_len
+ 2 > sizeof(filename
)) {
1117 ERR("Failed to remove file: path name too long (%s/%s)",
1118 path
, entry
->d_name
);
1122 if (snprintf(filename
, sizeof(filename
), "%s/%s",
1123 path
, entry
->d_name
) < 0) {
1124 ERR("Failed to format path.");
1128 if (stat(filename
, &st
)) {
1133 if (S_ISDIR(st
.st_mode
)) {
1134 char *subpath
= calloc
<char>(PATH_MAX
);
1137 PERROR("zmalloc path");
1141 strncpy(subpath
, path
, PATH_MAX
);
1142 subpath
[PATH_MAX
- 1] = '\0';
1143 strncat(subpath
, "/",
1144 PATH_MAX
- strlen(subpath
) - 1);
1145 strncat(subpath
, entry
->d_name
,
1146 PATH_MAX
- strlen(subpath
) - 1);
1148 ret
= delete_dir_recursive(subpath
);
1151 /* Error occurred, abort traversal. */
1154 } else if (S_ISREG(st
.st_mode
)) {
1155 ret
= unlinkat(dir_fd
, entry
->d_name
, 0);
1157 PERROR("Unlinking '%s'", entry
->d_name
);
1169 PERROR("rmdir '%s'", path
);
1172 closeret
= closedir(dir
);
1181 int view_trace(const char *trace_path
, char *viewer_path
)
1190 } else if (pid
> 0) {
1194 pid
= waitpid(pid
, &status
, 0);
1195 if (pid
< 0 || !WIFEXITED(status
)) {
1202 ret
= spawn_viewer(trace_path
, viewer_path
, false);
1215 int main(int argc
, char *argv
[])
1218 bool has_warning
= false;
1219 const char *output_path
= NULL
;
1220 char tmppath
[] = "/tmp/lttng-crash-XXXXXX";
1222 progname
= argv
[0] ? argv
[0] : "lttng-crash";
1224 ret
= parse_args(argc
, argv
);
1227 } else if (ret
< 0) {
1232 if (opt_output_path
) {
1233 output_path
= opt_output_path
;
1234 ret
= mkdir(output_path
, S_IRWXU
| S_IRWXG
);
1241 output_path
= mkdtemp(tmppath
);
1249 ret
= extract_trace_recursive(output_path
, the_input_path
);
1253 } else if (ret
> 0) {
1254 /* extract_trace_recursive reported a warning. */
1257 if (!opt_output_path
) {
1259 ret
= view_trace(output_path
, opt_viewer_path
);
1263 /* unlink temporary trace */
1264 ret
= delete_dir_recursive(output_path
);
1270 exit(has_warning
? EXIT_FAILURE
: EXIT_SUCCESS
);