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>
39 #include <lttng/lttng.h>
40 #include <common/common.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(FILE *ofp
)
210 fprintf(ofp
, "LTTng Crash Trace Viewer " VERSION
" - " VERSION_NAME
"%s\n\n",
211 GIT_VERSION
[0] == '\0' ? "" : " - " GIT_VERSION
);
212 fprintf(ofp
, "usage: lttng-crash [OPTIONS] FILE\n");
214 fprintf(ofp
, "Options:\n");
215 fprintf(ofp
, " -V, --version Show version.\n");
216 fprintf(ofp
, " -h, --help Show this help.\n");
217 fprintf(ofp
, " --list-options Simple listing of lttng-crash options.\n");
218 fprintf(ofp
, " -v, --verbose Increase verbosity.\n");
219 fprintf(ofp
, " -e, --viewer Specify viewer and/or options to use. This will\n"
220 " completely override the default viewers so please\n"
221 " make sure to specify the full command. The trace\n"
222 " directory paths appended at the end to the\n"
224 fprintf(ofp
, " -x, --extract PATH Extract trace(s) to specified path. Don't view\n"
227 fprintf(ofp
, "Please see the lttng-crash(1) man page for full documentation.\n");
228 fprintf(ofp
, "See http://lttng.org for updates, bug reports and news.\n");
231 static void version(FILE *ofp
)
233 fprintf(ofp
, "%s (LTTng Crash Trace Viewer) " VERSION
" - " VERSION_NAME
236 GIT_VERSION
[0] == '\0' ? "" : " - " GIT_VERSION
);
242 * List options line by line. This is mostly for bash auto completion and to
243 * avoid difficult parsing.
245 static void list_options(FILE *ofp
)
248 struct option
*option
= NULL
;
250 option
= &long_options
[i
];
251 while (option
->name
!= NULL
) {
252 fprintf(ofp
, "--%s\n", option
->name
);
254 if (isprint(option
->val
)) {
255 fprintf(ofp
, "-%c\n", option
->val
);
259 option
= &long_options
[i
];
264 * Parse command line arguments.
266 * Return 0 if OK, else -1
268 static int parse_args(int argc
, char **argv
)
277 while ((opt
= getopt_long(argc
, argv
, "+Vhve:x:", long_options
, NULL
)) != -1) {
288 /* There is only 3 possible level of verbosity. (-vvv) */
289 if (lttng_opt_verbose
< 3) {
290 lttng_opt_verbose
+= 1;
294 free(opt_viewer_path
);
295 opt_viewer_path
= strdup(optarg
);
298 free(opt_output_path
);
299 opt_output_path
= strdup(optarg
);
301 case OPT_DUMP_OPTIONS
:
302 list_options(stdout
);
311 if (!opt_viewer_path
) {
312 opt_viewer_path
= DEFAULT_VIEWER
;
315 /* No leftovers, or more than one input path, print usage and quit */
316 if ((argc
- optind
) == 0 || (argc
- optind
) > 1) {
321 input_path
= argv
[optind
];
330 int copy_file(const char *file_dest
, const char *file_src
)
332 int fd_src
= -1, fd_dest
= -1;
333 ssize_t readlen
, writelen
;
334 char buf
[COPY_BUFLEN
];
337 DBG("Copy metadata file '%s' into '%s'", file_src
, file_dest
);
339 fd_src
= open(file_src
, O_RDONLY
);
341 PERROR("Error opening %s for reading", file_src
);
345 fd_dest
= open(file_dest
, O_RDWR
| O_CREAT
| O_EXCL
,
346 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
348 PERROR("Error opening %s for writing", file_dest
);
354 readlen
= lttng_read(fd_src
, buf
, COPY_BUFLEN
);
356 PERROR("Error reading input file");
363 writelen
= lttng_write(fd_dest
, buf
, readlen
);
364 if (writelen
< readlen
) {
365 PERROR("Error writing to output file");
374 if (close(fd_src
) < 0) {
375 PERROR("Error closing %s", file_src
);
380 if (close(fd_dest
) < 0) {
381 PERROR("Error closing %s", file_dest
);
388 uint64_t _crash_get_field(const struct lttng_crash_layout
*layout
,
389 const char *ptr
, size_t size
)
392 case 1: return *(uint8_t *) ptr
;
393 case 2: if (layout
->reverse_byte_order
) {
394 return __bswap_16(*(uint16_t *) ptr
);
396 return *(uint16_t *) ptr
;
399 case 4: if (layout
->reverse_byte_order
) {
400 return __bswap_32(*(uint32_t *) ptr
);
402 return *(uint32_t *) ptr
;
405 case 8: if (layout
->reverse_byte_order
) {
406 return __bswap_64(*(uint64_t *) ptr
);
408 return *(uint64_t *) ptr
;
417 #define crash_get_field(layout, map, name) \
418 _crash_get_field(layout, (map) + (layout)->offset.name, \
421 #define crash_get_array_field(layout, map, array_name, idx, field_name) \
422 _crash_get_field(layout, \
423 (map) + (layout)->offset.array_name \
424 + (idx * (layout)->stride.array_name) \
425 + (layout)->offset.field_name, \
426 (layout)->length.field_name)
428 #define crash_get_hdr_raw_field(layout, hdr, name) ((hdr)->name)
430 #define crash_get_hdr_field(layout, hdr, name) \
431 _crash_get_field(layout, (const char *) &(hdr)->name, \
434 #define crash_get_layout(layout, hdr, name) \
436 (layout)->name = crash_get_hdr_field(layout, hdr, \
438 DBG("layout.%s = %" PRIu64, #name, \
439 (uint64_t) (layout)->name); \
443 int get_crash_layout_0_0(struct lttng_crash_layout
*layout
,
446 const struct crash_abi_0_0
*abi
= (const struct crash_abi_0_0
*) map
;
448 crash_get_layout(layout
, abi
, offset
.prod_offset
);
449 crash_get_layout(layout
, abi
, offset
.consumed_offset
);
450 crash_get_layout(layout
, abi
, offset
.commit_hot_array
);
451 crash_get_layout(layout
, abi
, offset
.commit_hot_seq
);
452 crash_get_layout(layout
, abi
, offset
.buf_wsb_array
);
453 crash_get_layout(layout
, abi
, offset
.buf_wsb_id
);
454 crash_get_layout(layout
, abi
, offset
.sb_array
);
455 crash_get_layout(layout
, abi
, offset
.sb_array_shmp_offset
);
456 crash_get_layout(layout
, abi
, offset
.sb_backend_p_offset
);
457 crash_get_layout(layout
, abi
, offset
.content_size
);
458 crash_get_layout(layout
, abi
, offset
.packet_size
);
460 crash_get_layout(layout
, abi
, length
.prod_offset
);
461 crash_get_layout(layout
, abi
, length
.consumed_offset
);
462 crash_get_layout(layout
, abi
, length
.commit_hot_seq
);
463 crash_get_layout(layout
, abi
, length
.buf_wsb_id
);
464 crash_get_layout(layout
, abi
, length
.sb_array_shmp_offset
);
465 crash_get_layout(layout
, abi
, length
.sb_backend_p_offset
);
466 crash_get_layout(layout
, abi
, length
.content_size
);
467 crash_get_layout(layout
, abi
, length
.packet_size
);
469 crash_get_layout(layout
, abi
, stride
.commit_hot_array
);
470 crash_get_layout(layout
, abi
, stride
.buf_wsb_array
);
471 crash_get_layout(layout
, abi
, stride
.sb_array
);
473 crash_get_layout(layout
, abi
, buf_size
);
474 crash_get_layout(layout
, abi
, subbuf_size
);
475 crash_get_layout(layout
, abi
, num_subbuf
);
476 crash_get_layout(layout
, abi
, mode
);
482 void print_dbg_magic(const uint8_t *magic
)
484 DBG("magic: 0x%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X",
485 magic
[0], magic
[1], magic
[2], magic
[3],
486 magic
[4], magic
[5], magic
[6], magic
[7],
487 magic
[8], magic
[9], magic
[10], magic
[11],
488 magic
[12], magic
[13], magic
[14], magic
[15]);
492 int check_magic(const uint8_t *magic
)
496 for (i
= 0; i
< RB_CRASH_DUMP_ABI_MAGIC_LEN
; i
++) {
497 if ((magic
[i
] ^ 0xFF) != lttng_crash_expected_magic_xor
[i
]) {
505 int get_crash_layout(struct lttng_crash_layout
*layout
, int fd
)
508 int ret
= 0, unmapret
;
509 const uint8_t *magic
;
510 uint64_t mmap_length
;
511 uint16_t major
, minor
;
513 const struct crash_abi_unknown
*abi
;
515 enum lttng_crash_type layout_type
;
517 map
= mmap(NULL
, RB_CRASH_DUMP_ABI_LEN
, PROT_READ
, MAP_PRIVATE
,
519 if (map
== MAP_FAILED
) {
520 PERROR("Mapping file");
523 abi
= (const struct crash_abi_unknown
*) map
;
524 magic
= crash_get_hdr_raw_field(layout
, abi
, magic
);
525 print_dbg_magic(magic
);
526 if (check_magic(magic
)) {
527 DBG("Unknown magic number");
528 ret
= 1; /* positive return value, skip */
531 endian
= crash_get_hdr_field(layout
, abi
, endian
);
533 case RB_CRASH_ENDIAN
:
535 case RB_CRASH_ENDIAN_REVERSE
:
536 layout
->reverse_byte_order
= 1;
539 DBG("Unknown endianness value: 0x%X", (unsigned int) endian
);
540 ret
= 1; /* positive return value, skip */
543 layout_type
= (enum lttng_crash_type
) crash_get_hdr_field(layout
, abi
, layout_type
);
544 switch (layout_type
) {
545 case LTTNG_CRASH_TYPE_UST
:
547 case LTTNG_CRASH_TYPE_KERNEL
:
548 ERR("lttng-modules buffer layout support not implemented");
549 ret
= 1; /* positive return value, skip */
552 ERR("Unknown layout type %u", (unsigned int) layout_type
);
553 ret
= 1; /* positive return value, skip */
556 mmap_length
= crash_get_hdr_field(layout
, abi
, mmap_length
);
557 DBG("mmap_length: %" PRIu64
, mmap_length
);
558 layout
->mmap_length
= mmap_length
;
559 major
= crash_get_hdr_field(layout
, abi
, major
);
560 DBG("major: %u", major
);
561 minor
= crash_get_hdr_field(layout
, abi
, minor
);
562 DBG("minor: %u", minor
);
563 word_size
= crash_get_hdr_field(layout
, abi
, word_size
);
564 DBG("word_size: %u", word_size
);
569 ret
= get_crash_layout_0_0(layout
, map
);
575 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
580 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
584 layout
->word_size
= word_size
;
586 unmapret
= munmap(map
, RB_CRASH_DUMP_ABI_LEN
);
593 /* buf_trunc mask selects only the buffer number. */
595 uint64_t buf_trunc(uint64_t offset
, uint64_t buf_size
)
597 return offset
& ~(buf_size
- 1);
600 /* subbuf_trunc mask selects the subbuffer number. */
602 uint64_t subbuf_trunc(uint64_t offset
, uint64_t subbuf_size
)
604 return offset
& ~(subbuf_size
- 1);
607 /* buf_offset mask selects only the offset within the current buffer. */
609 uint64_t buf_offset(uint64_t offset
, uint64_t buf_size
)
611 return offset
& (buf_size
- 1);
614 /* subbuf_offset mask selects the offset within the current subbuffer. */
616 uint64_t subbuf_offset(uint64_t offset
, uint64_t subbuf_size
)
618 return offset
& (subbuf_size
- 1);
621 /* subbuf_index returns the index of the current subbuffer within the buffer. */
623 uint64_t subbuf_index(uint64_t offset
, uint64_t buf_size
, uint64_t subbuf_size
)
625 return buf_offset(offset
, buf_size
) / subbuf_size
;
629 uint64_t subbuffer_id_get_index(uint32_t mode
, uint64_t id
,
632 if (mode
== RING_BUFFER_OVERWRITE
)
633 return id
& SB_ID_INDEX_MASK(wl
);
639 int copy_crash_subbuf(const struct lttng_crash_layout
*layout
,
640 int fd_dest
, char *buf
, uint64_t offset
)
642 uint64_t buf_size
, subbuf_size
, num_subbuf
, sbidx
, id
,
643 sb_bindex
, rpages_offset
, p_offset
, seq_cc
,
644 committed
, commit_count_mask
, consumed_cur
,
650 * Get the current subbuffer by applying the proper mask to
651 * "offset", and looking up the subbuf location within the
655 buf_size
= layout
->buf_size
;
656 subbuf_size
= layout
->subbuf_size
;
657 num_subbuf
= layout
->num_subbuf
;
659 switch (layout
->word_size
) {
660 case 4: commit_count_mask
= 0xFFFFFFFFULL
/ num_subbuf
;
662 case 8: commit_count_mask
= 0xFFFFFFFFFFFFFFFFULL
/ num_subbuf
;
665 ERR("Unsupported word size: %u",
666 (unsigned int) layout
->word_size
);
670 DBG("Copy crash subbuffer at offset %" PRIu64
, offset
);
671 sbidx
= subbuf_index(offset
, buf_size
, subbuf_size
);
674 * Find where the seq cc is located. Compute length of data to
677 seq_cc
= crash_get_array_field(layout
, buf
, commit_hot_array
,
678 sbidx
, commit_hot_seq
);
679 consumed_cur
= crash_get_field(layout
, buf
, consumed_offset
);
682 * Check that the buffer we are getting is after or at
683 * consumed_cur position.
685 if ((long) subbuf_trunc(offset
, subbuf_size
)
686 - (long) subbuf_trunc(consumed_cur
, subbuf_size
) < 0) {
687 DBG("No data: position is before consumed_cur");
692 * Check if subbuffer has been fully committed.
694 if (((seq_cc
- subbuf_size
) & commit_count_mask
)
695 - (buf_trunc(offset
, buf_size
) / num_subbuf
)
697 committed
= subbuf_size
;
699 committed
= subbuf_offset(seq_cc
, subbuf_size
);
701 DBG("No data committed, seq_cc: %" PRIu64
, seq_cc
);
706 /* Find actual physical offset in subbuffer table */
707 id
= crash_get_array_field(layout
, buf
, buf_wsb_array
,
709 sb_bindex
= subbuffer_id_get_index(layout
->mode
, id
,
711 rpages_offset
= crash_get_array_field(layout
, buf
, sb_array
,
712 sb_bindex
, sb_array_shmp_offset
);
713 p_offset
= crash_get_field(layout
, buf
+ rpages_offset
,
714 sb_backend_p_offset
);
715 subbuf_ptr
= buf
+ p_offset
;
717 if (committed
== subbuf_size
) {
719 * Packet header can be used.
721 if (layout
->length
.packet_size
) {
723 subbuf_ptr
+ layout
->offset
.packet_size
,
724 layout
->length
.packet_size
);
725 if (layout
->reverse_byte_order
) {
726 packet_size
= __bswap_64(packet_size
);
728 packet_size
/= CHAR_BIT
;
730 packet_size
= subbuf_size
;
736 * Find where to patch the sub-buffer header with actual
737 * readable data len and packet len, derived from seq
738 * cc. Patch it in our in-memory copy.
740 patch_size
= committed
* CHAR_BIT
;
741 if (layout
->reverse_byte_order
) {
742 patch_size
= __bswap_64(patch_size
);
744 if (layout
->length
.content_size
) {
745 memcpy(subbuf_ptr
+ layout
->offset
.content_size
,
746 &patch_size
, layout
->length
.content_size
);
748 if (layout
->length
.packet_size
) {
749 memcpy(subbuf_ptr
+ layout
->offset
.packet_size
,
750 &patch_size
, layout
->length
.packet_size
);
752 packet_size
= committed
;
756 * Copy packet into fd_dest.
758 writelen
= lttng_write(fd_dest
, subbuf_ptr
, packet_size
);
759 if (writelen
< packet_size
) {
760 PERROR("Error writing to output file");
763 DBG("Copied %" PRIu64
" bytes of data", packet_size
);
771 int copy_crash_data(const struct lttng_crash_layout
*layout
, int fd_dest
,
775 int ret
= 0, has_data
= 0;
778 uint64_t prod_offset
, consumed_offset
;
779 uint64_t offset
, subbuf_size
;
782 ret
= fstat(fd_src
, &statbuf
);
786 src_file_len
= layout
->mmap_length
;
787 buf
= zmalloc(src_file_len
);
791 readlen
= lttng_read(fd_src
, buf
, src_file_len
);
793 PERROR("Error reading input file");
798 prod_offset
= crash_get_field(layout
, buf
, prod_offset
);
799 DBG("prod_offset: 0x%" PRIx64
, prod_offset
);
800 consumed_offset
= crash_get_field(layout
, buf
, consumed_offset
);
801 DBG("consumed_offset: 0x%" PRIx64
, consumed_offset
);
802 subbuf_size
= layout
->subbuf_size
;
804 for (offset
= consumed_offset
; offset
< prod_offset
;
805 offset
+= subbuf_size
) {
806 ret
= copy_crash_subbuf(layout
, fd_dest
, buf
, offset
);
816 if (ret
&& ret
!= -ENODATA
) {
827 int extract_file(int output_dir_fd
, const char *output_file
,
828 int input_dir_fd
, const char *input_file
)
830 int fd_dest
, fd_src
, ret
= 0, closeret
;
831 struct lttng_crash_layout layout
;
833 layout
.reverse_byte_order
= 0; /* For reading magic number */
835 DBG("Extract file '%s'", input_file
);
836 fd_src
= openat(input_dir_fd
, input_file
, O_RDONLY
);
838 PERROR("Error opening '%s' for reading",
844 /* Query the crash ABI layout */
845 ret
= get_crash_layout(&layout
, fd_src
);
850 fd_dest
= openat(output_dir_fd
, output_file
,
851 O_RDWR
| O_CREAT
| O_EXCL
,
852 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
854 PERROR("Error opening '%s' for writing",
860 ret
= copy_crash_data(&layout
, fd_dest
, fd_src
);
866 closeret
= close(fd_dest
);
870 if (ret
== -ENODATA
) {
871 closeret
= unlinkat(output_dir_fd
, output_file
, 0);
877 closeret
= close(fd_src
);
886 int extract_all_files(const char *output_path
,
887 const char *input_path
)
889 DIR *input_dir
, *output_dir
;
890 int input_dir_fd
, output_dir_fd
, ret
= 0, closeret
;
891 struct dirent
*entry
; /* input */
893 /* Open input directory */
894 input_dir
= opendir(input_path
);
896 PERROR("Cannot open '%s' path", input_path
);
899 input_dir_fd
= dirfd(input_dir
);
900 if (input_dir_fd
< 0) {
905 /* Open output directory */
906 output_dir
= opendir(output_path
);
908 PERROR("Cannot open '%s' path", output_path
);
911 output_dir_fd
= dirfd(output_dir
);
912 if (output_dir_fd
< 0) {
917 while ((entry
= readdir(input_dir
))) {
918 if (!strcmp(entry
->d_name
, ".")
919 || !strcmp(entry
->d_name
, ".."))
921 ret
= extract_file(output_dir_fd
, entry
->d_name
,
922 input_dir_fd
, entry
->d_name
);
923 if (ret
== -ENODATA
) {
924 DBG("No data in file '%s', skipping", entry
->d_name
);
927 } else if (ret
< 0) {
929 } else if (ret
> 0) {
930 DBG("Skipping file '%s'", entry
->d_name
);
935 closeret
= closedir(output_dir
);
939 closeret
= closedir(input_dir
);
947 int extract_one_trace(const char *output_path
,
948 const char *input_path
)
950 char dest
[PATH_MAX
], src
[PATH_MAX
];
953 DBG("Extract crash trace '%s' into '%s'", input_path
, output_path
);
956 strncpy(dest
, output_path
, PATH_MAX
);
957 dest
[PATH_MAX
- 1] = '\0';
958 strncat(dest
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
960 strncpy(src
, input_path
, PATH_MAX
);
961 src
[PATH_MAX
- 1] = '\0';
962 strncat(src
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
964 ret
= copy_file(dest
, src
);
969 /* Extract each other file that has expected header */
970 return extract_all_files(output_path
, input_path
);
974 int extract_trace_recursive(const char *output_path
,
975 const char *input_path
)
978 int dir_fd
, ret
= 0, closeret
;
979 struct dirent
*entry
;
984 dir
= opendir(input_path
);
986 PERROR("Cannot open '%s' path", input_path
);
990 path_len
= strlen(input_path
);
998 while ((entry
= readdir(dir
))) {
1001 char filename
[PATH_MAX
];
1003 if (!strcmp(entry
->d_name
, ".")
1004 || !strcmp(entry
->d_name
, "..")) {
1008 name_len
= strlen(entry
->d_name
);
1009 if (path_len
+ name_len
+ 2 > sizeof(filename
)) {
1010 ERR("Failed to remove file: path name too long (%s/%s)",
1011 input_path
, entry
->d_name
);
1015 if (snprintf(filename
, sizeof(filename
), "%s/%s",
1016 input_path
, entry
->d_name
) < 0) {
1017 ERR("Failed to format path.");
1021 if (stat(filename
, &st
)) {
1026 if (S_ISDIR(st
.st_mode
)) {
1027 char output_subpath
[PATH_MAX
];
1028 char input_subpath
[PATH_MAX
];
1030 strncpy(output_subpath
, output_path
,
1031 sizeof(output_subpath
));
1032 output_subpath
[sizeof(output_subpath
) - 1] = '\0';
1033 strncat(output_subpath
, "/",
1034 sizeof(output_subpath
) - strlen(output_subpath
) - 1);
1035 strncat(output_subpath
, entry
->d_name
,
1036 sizeof(output_subpath
) - strlen(output_subpath
) - 1);
1038 ret
= mkdir(output_subpath
, S_IRWXU
| S_IRWXG
);
1045 strncpy(input_subpath
, input_path
,
1046 sizeof(input_subpath
));
1047 input_subpath
[sizeof(input_subpath
) - 1] = '\0';
1048 strncat(input_subpath
, "/",
1049 sizeof(input_subpath
) - strlen(input_subpath
) - 1);
1050 strncat(input_subpath
, entry
->d_name
,
1051 sizeof(input_subpath
) - strlen(input_subpath
) - 1);
1053 ret
= extract_trace_recursive(output_subpath
,
1058 } else if (S_ISREG(st
.st_mode
) || S_ISLNK(st
.st_mode
)) {
1059 if (!strcmp(entry
->d_name
, "metadata")) {
1060 ret
= extract_one_trace(output_path
,
1063 WARN("Error extracting trace '%s', continuing anyway.",
1074 closeret
= closedir(dir
);
1082 int delete_dir_recursive(const char *path
)
1085 int dir_fd
, ret
= 0, closeret
;
1087 struct dirent
*entry
;
1089 /* Open trace directory */
1090 dir
= opendir(path
);
1092 PERROR("Cannot open '%s' path", path
);
1097 path_len
= strlen(path
);
1099 dir_fd
= dirfd(dir
);
1106 while ((entry
= readdir(dir
))) {
1109 char filename
[PATH_MAX
];
1111 if (!strcmp(entry
->d_name
, ".")
1112 || !strcmp(entry
->d_name
, "..")) {
1116 name_len
= strlen(entry
->d_name
);
1117 if (path_len
+ name_len
+ 2 > sizeof(filename
)) {
1118 ERR("Failed to remove file: path name too long (%s/%s)",
1119 path
, entry
->d_name
);
1123 if (snprintf(filename
, sizeof(filename
), "%s/%s",
1124 path
, entry
->d_name
) < 0) {
1125 ERR("Failed to format path.");
1129 if (stat(filename
, &st
)) {
1134 if (S_ISDIR(st
.st_mode
)) {
1135 char *subpath
= zmalloc(PATH_MAX
);
1138 PERROR("zmalloc path");
1142 strncpy(subpath
, path
, PATH_MAX
);
1143 subpath
[PATH_MAX
- 1] = '\0';
1144 strncat(subpath
, "/",
1145 PATH_MAX
- strlen(subpath
) - 1);
1146 strncat(subpath
, entry
->d_name
,
1147 PATH_MAX
- strlen(subpath
) - 1);
1149 ret
= delete_dir_recursive(subpath
);
1152 /* Error occured, abort traversal. */
1155 } else if (S_ISREG(st
.st_mode
)) {
1156 ret
= unlinkat(dir_fd
, entry
->d_name
, 0);
1158 PERROR("Unlinking '%s'", entry
->d_name
);
1170 PERROR("rmdir '%s'", path
);
1173 closeret
= closedir(dir
);
1181 int view_trace(const char *viewer_path
, const char *trace_path
)
1190 } else if (pid
> 0) {
1194 pid
= waitpid(pid
, &status
, 0);
1195 if (pid
< 0 || !WIFEXITED(status
)) {
1202 ret
= execlp(viewer_path
, viewer_path
,
1203 trace_path
, (char *) NULL
);
1208 exit(EXIT_SUCCESS
); /* Never reached */
1216 int main(int argc
, char *argv
[])
1218 int ret
, has_warning
= 0;
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) {
1231 if (opt_output_path
) {
1232 output_path
= opt_output_path
;
1233 ret
= mkdir(output_path
, S_IRWXU
| S_IRWXG
);
1239 output_path
= mkdtemp(tmppath
);
1246 ret
= extract_trace_recursive(output_path
, input_path
);
1249 } else if (ret
> 0) {
1252 if (!opt_output_path
) {
1254 ret
= view_trace(opt_viewer_path
, output_path
);
1258 /* unlink temporary trace */
1259 ret
= delete_dir_recursive(output_path
);