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
,
225 EXTRA_VERSION_NAME
[0] == '\0' ? "" : " - " EXTRA_VERSION_NAME
);
231 * List options line by line. This is mostly for bash auto completion and to
232 * avoid difficult parsing.
234 static void list_options(FILE *ofp
)
237 struct option
*option
= NULL
;
239 option
= &long_options
[i
];
240 while (option
->name
!= NULL
) {
241 fprintf(ofp
, "--%s\n", option
->name
);
243 if (isprint(option
->val
)) {
244 fprintf(ofp
, "-%c\n", option
->val
);
248 option
= &long_options
[i
];
253 * Parse command line arguments.
255 * Return 0 if OK, else -1
257 static int parse_args(int argc
, char **argv
)
266 while ((opt
= getopt_long(argc
, argv
, "+Vhve:x:", long_options
, NULL
)) != -1) {
277 /* There is only 3 possible level of verbosity. (-vvv) */
278 if (lttng_opt_verbose
< 3) {
279 lttng_opt_verbose
+= 1;
283 free(opt_viewer_path
);
284 opt_viewer_path
= strdup(optarg
);
287 free(opt_output_path
);
288 opt_output_path
= strdup(optarg
);
290 case OPT_DUMP_OPTIONS
:
291 list_options(stdout
);
295 ERR("Unknown command-line option");
300 if (!opt_viewer_path
) {
301 opt_viewer_path
= DEFAULT_VIEWER
;
304 /* No leftovers, or more than one input path, print usage and quit */
305 if (argc
- optind
!= 1) {
306 ERR("Command-line error: Specify exactly one input path");
310 input_path
= argv
[optind
];
319 int copy_file(const char *file_dest
, const char *file_src
)
321 int fd_src
= -1, fd_dest
= -1;
322 ssize_t readlen
, writelen
;
323 char buf
[COPY_BUFLEN
];
326 DBG("Copy metadata file '%s' into '%s'", file_src
, file_dest
);
328 fd_src
= open(file_src
, O_RDONLY
);
330 PERROR("Error opening %s for reading", file_src
);
334 fd_dest
= open(file_dest
, O_RDWR
| O_CREAT
| O_EXCL
,
335 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
337 PERROR("Error opening %s for writing", file_dest
);
343 readlen
= lttng_read(fd_src
, buf
, COPY_BUFLEN
);
345 PERROR("Error reading input file");
352 writelen
= lttng_write(fd_dest
, buf
, readlen
);
353 if (writelen
< readlen
) {
354 PERROR("Error writing to output file");
363 if (close(fd_src
) < 0) {
364 PERROR("Error closing %s", file_src
);
369 if (close(fd_dest
) < 0) {
370 PERROR("Error closing %s", file_dest
);
377 uint64_t _crash_get_field(const struct lttng_crash_layout
*layout
,
378 const char *ptr
, size_t size
)
381 case 1: return *(uint8_t *) ptr
;
382 case 2: if (layout
->reverse_byte_order
) {
383 return __bswap_16(*(uint16_t *) ptr
);
385 return *(uint16_t *) ptr
;
388 case 4: if (layout
->reverse_byte_order
) {
389 return __bswap_32(*(uint32_t *) ptr
);
391 return *(uint32_t *) ptr
;
394 case 8: if (layout
->reverse_byte_order
) {
395 return __bswap_64(*(uint64_t *) ptr
);
397 return *(uint64_t *) ptr
;
406 #define crash_get_field(layout, map, name) \
407 _crash_get_field(layout, (map) + (layout)->offset.name, \
410 #define crash_get_array_field(layout, map, array_name, idx, field_name) \
411 _crash_get_field(layout, \
412 (map) + (layout)->offset.array_name \
413 + (idx * (layout)->stride.array_name) \
414 + (layout)->offset.field_name, \
415 (layout)->length.field_name)
417 #define crash_get_hdr_raw_field(layout, hdr, name) ((hdr)->name)
419 #define crash_get_hdr_field(layout, hdr, name) \
420 _crash_get_field(layout, (const char *) &(hdr)->name, \
423 #define crash_get_layout(layout, hdr, name) \
425 (layout)->name = crash_get_hdr_field(layout, hdr, \
427 DBG("layout.%s = %" PRIu64, #name, \
428 (uint64_t) (layout)->name); \
432 int get_crash_layout_0_0(struct lttng_crash_layout
*layout
,
435 const struct crash_abi_0_0
*abi
= (const struct crash_abi_0_0
*) map
;
437 crash_get_layout(layout
, abi
, offset
.prod_offset
);
438 crash_get_layout(layout
, abi
, offset
.consumed_offset
);
439 crash_get_layout(layout
, abi
, offset
.commit_hot_array
);
440 crash_get_layout(layout
, abi
, offset
.commit_hot_seq
);
441 crash_get_layout(layout
, abi
, offset
.buf_wsb_array
);
442 crash_get_layout(layout
, abi
, offset
.buf_wsb_id
);
443 crash_get_layout(layout
, abi
, offset
.sb_array
);
444 crash_get_layout(layout
, abi
, offset
.sb_array_shmp_offset
);
445 crash_get_layout(layout
, abi
, offset
.sb_backend_p_offset
);
446 crash_get_layout(layout
, abi
, offset
.content_size
);
447 crash_get_layout(layout
, abi
, offset
.packet_size
);
449 crash_get_layout(layout
, abi
, length
.prod_offset
);
450 crash_get_layout(layout
, abi
, length
.consumed_offset
);
451 crash_get_layout(layout
, abi
, length
.commit_hot_seq
);
452 crash_get_layout(layout
, abi
, length
.buf_wsb_id
);
453 crash_get_layout(layout
, abi
, length
.sb_array_shmp_offset
);
454 crash_get_layout(layout
, abi
, length
.sb_backend_p_offset
);
455 crash_get_layout(layout
, abi
, length
.content_size
);
456 crash_get_layout(layout
, abi
, length
.packet_size
);
458 crash_get_layout(layout
, abi
, stride
.commit_hot_array
);
459 crash_get_layout(layout
, abi
, stride
.buf_wsb_array
);
460 crash_get_layout(layout
, abi
, stride
.sb_array
);
462 crash_get_layout(layout
, abi
, buf_size
);
463 crash_get_layout(layout
, abi
, subbuf_size
);
464 crash_get_layout(layout
, abi
, num_subbuf
);
465 crash_get_layout(layout
, abi
, mode
);
471 void print_dbg_magic(const uint8_t *magic
)
473 DBG("magic: 0x%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X",
474 magic
[0], magic
[1], magic
[2], magic
[3],
475 magic
[4], magic
[5], magic
[6], magic
[7],
476 magic
[8], magic
[9], magic
[10], magic
[11],
477 magic
[12], magic
[13], magic
[14], magic
[15]);
481 int check_magic(const uint8_t *magic
)
485 for (i
= 0; i
< RB_CRASH_DUMP_ABI_MAGIC_LEN
; i
++) {
486 if ((magic
[i
] ^ 0xFF) != lttng_crash_expected_magic_xor
[i
]) {
494 int get_crash_layout(struct lttng_crash_layout
*layout
, int fd
)
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
;
506 map
= mmap(NULL
, RB_CRASH_DUMP_ABI_LEN
, PROT_READ
, MAP_PRIVATE
,
508 if (map
== MAP_FAILED
) {
509 PERROR("Mapping file");
512 abi
= (const struct crash_abi_unknown
*) map
;
513 magic
= crash_get_hdr_raw_field(layout
, abi
, magic
);
514 print_dbg_magic(magic
);
515 if (check_magic(magic
)) {
516 DBG("Unknown magic number");
517 ret
= 1; /* positive return value, skip */
520 endian
= crash_get_hdr_field(layout
, abi
, endian
);
522 case RB_CRASH_ENDIAN
:
524 case RB_CRASH_ENDIAN_REVERSE
:
525 layout
->reverse_byte_order
= 1;
528 DBG("Unknown endianness value: 0x%X", (unsigned int) endian
);
529 ret
= 1; /* positive return value, skip */
532 layout_type
= (enum lttng_crash_type
) crash_get_hdr_field(layout
, abi
, layout_type
);
533 switch (layout_type
) {
534 case LTTNG_CRASH_TYPE_UST
:
536 case LTTNG_CRASH_TYPE_KERNEL
:
537 ERR("lttng-modules buffer layout support not implemented");
538 ret
= 1; /* positive return value, skip */
541 ERR("Unknown layout type %u", (unsigned int) layout_type
);
542 ret
= 1; /* positive return value, skip */
545 mmap_length
= crash_get_hdr_field(layout
, abi
, mmap_length
);
546 DBG("mmap_length: %" PRIu64
, mmap_length
);
547 layout
->mmap_length
= mmap_length
;
548 major
= crash_get_hdr_field(layout
, abi
, major
);
549 DBG("major: %u", major
);
550 minor
= crash_get_hdr_field(layout
, abi
, minor
);
551 DBG("minor: %u", minor
);
552 word_size
= crash_get_hdr_field(layout
, abi
, word_size
);
553 DBG("word_size: %u", word_size
);
558 ret
= get_crash_layout_0_0(layout
, map
);
564 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
569 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
573 layout
->word_size
= word_size
;
575 unmapret
= munmap(map
, RB_CRASH_DUMP_ABI_LEN
);
582 /* buf_trunc mask selects only the buffer number. */
584 uint64_t buf_trunc(uint64_t offset
, uint64_t buf_size
)
586 return offset
& ~(buf_size
- 1);
589 /* subbuf_trunc mask selects the subbuffer number. */
591 uint64_t subbuf_trunc(uint64_t offset
, uint64_t subbuf_size
)
593 return offset
& ~(subbuf_size
- 1);
596 /* buf_offset mask selects only the offset within the current buffer. */
598 uint64_t buf_offset(uint64_t offset
, uint64_t buf_size
)
600 return offset
& (buf_size
- 1);
603 /* subbuf_offset mask selects the offset within the current subbuffer. */
605 uint64_t subbuf_offset(uint64_t offset
, uint64_t subbuf_size
)
607 return offset
& (subbuf_size
- 1);
610 /* subbuf_index returns the index of the current subbuffer within the buffer. */
612 uint64_t subbuf_index(uint64_t offset
, uint64_t buf_size
, uint64_t subbuf_size
)
614 return buf_offset(offset
, buf_size
) / subbuf_size
;
618 uint64_t subbuffer_id_get_index(uint32_t mode
, uint64_t id
,
621 if (mode
== RING_BUFFER_OVERWRITE
)
622 return id
& SB_ID_INDEX_MASK(wl
);
628 int copy_crash_subbuf(const struct lttng_crash_layout
*layout
,
629 int fd_dest
, char *buf
, uint64_t offset
)
631 uint64_t buf_size
, subbuf_size
, num_subbuf
, sbidx
, id
,
632 sb_bindex
, rpages_offset
, p_offset
, seq_cc
,
633 committed
, commit_count_mask
, consumed_cur
,
639 * Get the current subbuffer by applying the proper mask to
640 * "offset", and looking up the subbuf location within the
644 buf_size
= layout
->buf_size
;
645 subbuf_size
= layout
->subbuf_size
;
646 num_subbuf
= layout
->num_subbuf
;
648 switch (layout
->word_size
) {
649 case 4: commit_count_mask
= 0xFFFFFFFFULL
/ num_subbuf
;
651 case 8: commit_count_mask
= 0xFFFFFFFFFFFFFFFFULL
/ num_subbuf
;
654 ERR("Unsupported word size: %u",
655 (unsigned int) layout
->word_size
);
659 DBG("Copy crash subbuffer at offset %" PRIu64
, offset
);
660 sbidx
= subbuf_index(offset
, buf_size
, subbuf_size
);
663 * Find where the seq cc is located. Compute length of data to
666 seq_cc
= crash_get_array_field(layout
, buf
, commit_hot_array
,
667 sbidx
, commit_hot_seq
);
668 consumed_cur
= crash_get_field(layout
, buf
, consumed_offset
);
671 * Check that the buffer we are getting is after or at
672 * consumed_cur position.
674 if ((long) subbuf_trunc(offset
, subbuf_size
)
675 - (long) subbuf_trunc(consumed_cur
, subbuf_size
) < 0) {
676 DBG("No data: position is before consumed_cur");
681 * Check if subbuffer has been fully committed.
683 if (((seq_cc
- subbuf_size
) & commit_count_mask
)
684 - (buf_trunc(offset
, buf_size
) / num_subbuf
)
686 committed
= subbuf_size
;
688 committed
= subbuf_offset(seq_cc
, subbuf_size
);
690 DBG("No data committed, seq_cc: %" PRIu64
, seq_cc
);
695 /* Find actual physical offset in subbuffer table */
696 id
= crash_get_array_field(layout
, buf
, buf_wsb_array
,
698 sb_bindex
= subbuffer_id_get_index(layout
->mode
, id
,
700 rpages_offset
= crash_get_array_field(layout
, buf
, sb_array
,
701 sb_bindex
, sb_array_shmp_offset
);
702 p_offset
= crash_get_field(layout
, buf
+ rpages_offset
,
703 sb_backend_p_offset
);
704 subbuf_ptr
= buf
+ p_offset
;
706 if (committed
== subbuf_size
) {
708 * Packet header can be used.
710 if (layout
->length
.packet_size
) {
712 subbuf_ptr
+ layout
->offset
.packet_size
,
713 layout
->length
.packet_size
);
714 if (layout
->reverse_byte_order
) {
715 packet_size
= __bswap_64(packet_size
);
717 packet_size
/= CHAR_BIT
;
719 packet_size
= subbuf_size
;
725 * Find where to patch the sub-buffer header with actual
726 * readable data len and packet len, derived from seq
727 * cc. Patch it in our in-memory copy.
729 patch_size
= committed
* CHAR_BIT
;
730 if (layout
->reverse_byte_order
) {
731 patch_size
= __bswap_64(patch_size
);
733 if (layout
->length
.content_size
) {
734 memcpy(subbuf_ptr
+ layout
->offset
.content_size
,
735 &patch_size
, layout
->length
.content_size
);
737 if (layout
->length
.packet_size
) {
738 memcpy(subbuf_ptr
+ layout
->offset
.packet_size
,
739 &patch_size
, layout
->length
.packet_size
);
741 packet_size
= committed
;
745 * Copy packet into fd_dest.
747 writelen
= lttng_write(fd_dest
, subbuf_ptr
, packet_size
);
748 if (writelen
< packet_size
) {
749 PERROR("Error writing to output file");
752 DBG("Copied %" PRIu64
" bytes of data", packet_size
);
760 int copy_crash_data(const struct lttng_crash_layout
*layout
, int fd_dest
,
764 int ret
= 0, has_data
= 0;
767 uint64_t prod_offset
, consumed_offset
;
768 uint64_t offset
, subbuf_size
;
771 ret
= fstat(fd_src
, &statbuf
);
775 src_file_len
= layout
->mmap_length
;
776 buf
= zmalloc(src_file_len
);
780 readlen
= lttng_read(fd_src
, buf
, src_file_len
);
782 PERROR("Error reading input file");
787 prod_offset
= crash_get_field(layout
, buf
, prod_offset
);
788 DBG("prod_offset: 0x%" PRIx64
, prod_offset
);
789 consumed_offset
= crash_get_field(layout
, buf
, consumed_offset
);
790 DBG("consumed_offset: 0x%" PRIx64
, consumed_offset
);
791 subbuf_size
= layout
->subbuf_size
;
793 for (offset
= consumed_offset
; offset
< prod_offset
;
794 offset
+= subbuf_size
) {
795 ret
= copy_crash_subbuf(layout
, fd_dest
, buf
, offset
);
805 if (ret
&& ret
!= -ENODATA
) {
816 int extract_file(int output_dir_fd
, const char *output_file
,
817 int input_dir_fd
, const char *input_file
)
819 int fd_dest
, fd_src
, ret
= 0, closeret
;
820 struct lttng_crash_layout layout
;
822 layout
.reverse_byte_order
= 0; /* For reading magic number */
824 DBG("Extract file '%s'", input_file
);
825 fd_src
= openat(input_dir_fd
, input_file
, O_RDONLY
);
827 PERROR("Error opening '%s' for reading",
833 /* Query the crash ABI layout */
834 ret
= get_crash_layout(&layout
, fd_src
);
839 fd_dest
= openat(output_dir_fd
, output_file
,
840 O_RDWR
| O_CREAT
| O_EXCL
,
841 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
843 PERROR("Error opening '%s' for writing",
849 ret
= copy_crash_data(&layout
, fd_dest
, fd_src
);
855 closeret
= close(fd_dest
);
859 if (ret
== -ENODATA
) {
860 closeret
= unlinkat(output_dir_fd
, output_file
, 0);
866 closeret
= close(fd_src
);
875 int extract_all_files(const char *output_path
,
876 const char *input_path
)
878 DIR *input_dir
, *output_dir
;
879 int input_dir_fd
, output_dir_fd
, ret
= 0, closeret
;
880 struct dirent
*entry
; /* input */
882 /* Open input directory */
883 input_dir
= opendir(input_path
);
885 PERROR("Cannot open '%s' path", input_path
);
888 input_dir_fd
= dirfd(input_dir
);
889 if (input_dir_fd
< 0) {
894 /* Open output directory */
895 output_dir
= opendir(output_path
);
897 PERROR("Cannot open '%s' path", output_path
);
900 output_dir_fd
= dirfd(output_dir
);
901 if (output_dir_fd
< 0) {
906 while ((entry
= readdir(input_dir
))) {
907 if (!strcmp(entry
->d_name
, ".")
908 || !strcmp(entry
->d_name
, ".."))
910 ret
= extract_file(output_dir_fd
, entry
->d_name
,
911 input_dir_fd
, entry
->d_name
);
912 if (ret
== -ENODATA
) {
913 DBG("No data in file '%s', skipping", entry
->d_name
);
916 } else if (ret
< 0) {
918 } else if (ret
> 0) {
919 DBG("Skipping file '%s'", entry
->d_name
);
924 closeret
= closedir(output_dir
);
928 closeret
= closedir(input_dir
);
936 int extract_one_trace(const char *output_path
,
937 const char *input_path
)
939 char dest
[PATH_MAX
], src
[PATH_MAX
];
942 DBG("Extract crash trace '%s' into '%s'", input_path
, output_path
);
945 strncpy(dest
, output_path
, PATH_MAX
);
946 dest
[PATH_MAX
- 1] = '\0';
947 strncat(dest
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
949 strncpy(src
, input_path
, PATH_MAX
);
950 src
[PATH_MAX
- 1] = '\0';
951 strncat(src
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
953 ret
= copy_file(dest
, src
);
958 /* Extract each other file that has expected header */
959 return extract_all_files(output_path
, input_path
);
963 int extract_trace_recursive(const char *output_path
,
964 const char *input_path
)
967 int dir_fd
, ret
= 0, closeret
;
968 struct dirent
*entry
;
973 dir
= opendir(input_path
);
975 PERROR("Cannot open '%s' path", input_path
);
979 path_len
= strlen(input_path
);
987 while ((entry
= readdir(dir
))) {
990 char filename
[PATH_MAX
];
992 if (!strcmp(entry
->d_name
, ".")
993 || !strcmp(entry
->d_name
, "..")) {
997 name_len
= strlen(entry
->d_name
);
998 if (path_len
+ name_len
+ 2 > sizeof(filename
)) {
999 ERR("Failed to remove file: path name too long (%s/%s)",
1000 input_path
, entry
->d_name
);
1004 if (snprintf(filename
, sizeof(filename
), "%s/%s",
1005 input_path
, entry
->d_name
) < 0) {
1006 ERR("Failed to format path.");
1010 if (stat(filename
, &st
)) {
1015 if (S_ISDIR(st
.st_mode
)) {
1016 char output_subpath
[PATH_MAX
];
1017 char input_subpath
[PATH_MAX
];
1019 strncpy(output_subpath
, output_path
,
1020 sizeof(output_subpath
));
1021 output_subpath
[sizeof(output_subpath
) - 1] = '\0';
1022 strncat(output_subpath
, "/",
1023 sizeof(output_subpath
) - strlen(output_subpath
) - 1);
1024 strncat(output_subpath
, entry
->d_name
,
1025 sizeof(output_subpath
) - strlen(output_subpath
) - 1);
1027 ret
= mkdir(output_subpath
, S_IRWXU
| S_IRWXG
);
1034 strncpy(input_subpath
, input_path
,
1035 sizeof(input_subpath
));
1036 input_subpath
[sizeof(input_subpath
) - 1] = '\0';
1037 strncat(input_subpath
, "/",
1038 sizeof(input_subpath
) - strlen(input_subpath
) - 1);
1039 strncat(input_subpath
, entry
->d_name
,
1040 sizeof(input_subpath
) - strlen(input_subpath
) - 1);
1042 ret
= extract_trace_recursive(output_subpath
,
1047 } else if (S_ISREG(st
.st_mode
) || S_ISLNK(st
.st_mode
)) {
1048 if (!strcmp(entry
->d_name
, "metadata")) {
1049 ret
= extract_one_trace(output_path
,
1052 WARN("Error extracting trace '%s', continuing anyway.",
1063 closeret
= closedir(dir
);
1071 int delete_dir_recursive(const char *path
)
1074 int dir_fd
, ret
= 0, closeret
;
1076 struct dirent
*entry
;
1078 /* Open trace directory */
1079 dir
= opendir(path
);
1081 PERROR("Cannot open '%s' path", path
);
1086 path_len
= strlen(path
);
1088 dir_fd
= dirfd(dir
);
1095 while ((entry
= readdir(dir
))) {
1098 char filename
[PATH_MAX
];
1100 if (!strcmp(entry
->d_name
, ".")
1101 || !strcmp(entry
->d_name
, "..")) {
1105 name_len
= strlen(entry
->d_name
);
1106 if (path_len
+ name_len
+ 2 > sizeof(filename
)) {
1107 ERR("Failed to remove file: path name too long (%s/%s)",
1108 path
, entry
->d_name
);
1112 if (snprintf(filename
, sizeof(filename
), "%s/%s",
1113 path
, entry
->d_name
) < 0) {
1114 ERR("Failed to format path.");
1118 if (stat(filename
, &st
)) {
1123 if (S_ISDIR(st
.st_mode
)) {
1124 char *subpath
= zmalloc(PATH_MAX
);
1127 PERROR("zmalloc path");
1131 strncpy(subpath
, path
, PATH_MAX
);
1132 subpath
[PATH_MAX
- 1] = '\0';
1133 strncat(subpath
, "/",
1134 PATH_MAX
- strlen(subpath
) - 1);
1135 strncat(subpath
, entry
->d_name
,
1136 PATH_MAX
- strlen(subpath
) - 1);
1138 ret
= delete_dir_recursive(subpath
);
1141 /* Error occurred, abort traversal. */
1144 } else if (S_ISREG(st
.st_mode
)) {
1145 ret
= unlinkat(dir_fd
, entry
->d_name
, 0);
1147 PERROR("Unlinking '%s'", entry
->d_name
);
1159 PERROR("rmdir '%s'", path
);
1162 closeret
= closedir(dir
);
1170 int view_trace(const char *viewer_path
, const char *trace_path
)
1179 } else if (pid
> 0) {
1183 pid
= waitpid(pid
, &status
, 0);
1184 if (pid
< 0 || !WIFEXITED(status
)) {
1191 ret
= execlp(viewer_path
, viewer_path
,
1192 trace_path
, (char *) NULL
);
1197 exit(EXIT_SUCCESS
); /* Never reached */
1205 int main(int argc
, char *argv
[])
1208 bool has_warning
= false;
1209 const char *output_path
= NULL
;
1210 char tmppath
[] = "/tmp/lttng-crash-XXXXXX";
1212 progname
= argv
[0] ? argv
[0] : "lttng-crash";
1214 ret
= parse_args(argc
, argv
);
1217 } else if (ret
< 0) {
1222 if (opt_output_path
) {
1223 output_path
= opt_output_path
;
1224 ret
= mkdir(output_path
, S_IRWXU
| S_IRWXG
);
1231 output_path
= mkdtemp(tmppath
);
1239 ret
= extract_trace_recursive(output_path
, input_path
);
1243 } else if (ret
> 0) {
1244 /* extract_trace_recursive reported a warning. */
1247 if (!opt_output_path
) {
1249 ret
= view_trace(opt_viewer_path
, output_path
);
1253 /* unlink temporary trace */
1254 ret
= delete_dir_recursive(output_path
);
1260 exit(has_warning
? EXIT_FAILURE
: EXIT_SUCCESS
);