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 lenght 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
= DEFAULT_VIEWER
,
189 static int nr_input_paths
;
190 static char **input_paths
;
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 [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, print usage and quit */
311 if ((argc
- optind
) == 0) {
316 input_paths
= &argv
[optind
];
317 nr_input_paths
= argc
- optind
;
326 int copy_file(const char *file_dest
, const char *file_src
)
329 ssize_t readlen
, writelen
;
330 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
);
339 fd_dest
= open(file_dest
, O_RDWR
| O_CREAT
| O_EXCL
,
340 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
342 PERROR("Error opening %s for writing", file_dest
);
347 readlen
= lttng_read(fd_src
, buf
, COPY_BUFLEN
);
349 PERROR("Error reading input file");
355 writelen
= lttng_write(fd_dest
, buf
, readlen
);
356 if (writelen
< readlen
) {
357 PERROR("Error writing to output file");
365 uint64_t _crash_get_field(const struct lttng_crash_layout
*layout
,
366 const char *ptr
, size_t size
)
369 case 1: return *(uint8_t *) ptr
;
370 case 2: if (layout
->reverse_byte_order
) {
371 return __bswap_16(*(uint16_t *) ptr
);
373 return *(uint16_t *) ptr
;
376 case 4: if (layout
->reverse_byte_order
) {
377 return __bswap_32(*(uint32_t *) ptr
);
379 return *(uint32_t *) ptr
;
382 case 8: if (layout
->reverse_byte_order
) {
383 return __bswap_64(*(uint64_t *) ptr
);
385 return *(uint64_t *) ptr
;
394 #define crash_get_field(layout, map, name) \
395 _crash_get_field(layout, (map) + (layout)->offset.name, \
398 #define crash_get_array_field(layout, map, array_name, idx, field_name) \
399 _crash_get_field(layout, \
400 (map) + (layout)->offset.array_name \
401 + (idx * (layout)->stride.array_name) \
402 + (layout)->offset.field_name, \
403 (layout)->length.field_name)
405 #define crash_get_hdr_raw_field(layout, hdr, name) ((hdr)->name)
407 #define crash_get_hdr_field(layout, hdr, name) \
408 _crash_get_field(layout, (const char *) &(hdr)->name, \
411 #define crash_get_layout(layout, hdr, name) \
413 (layout)->name = crash_get_hdr_field(layout, hdr, \
415 DBG("layout.%s = %" PRIu64, #name, \
416 (uint64_t) (layout)->name); \
420 int get_crash_layout_0_0(struct lttng_crash_layout
*layout
,
423 const struct crash_abi_0_0
*abi
= (const struct crash_abi_0_0
*) map
;
425 crash_get_layout(layout
, abi
, offset
.prod_offset
);
426 crash_get_layout(layout
, abi
, offset
.consumed_offset
);
427 crash_get_layout(layout
, abi
, offset
.commit_hot_array
);
428 crash_get_layout(layout
, abi
, offset
.commit_hot_seq
);
429 crash_get_layout(layout
, abi
, offset
.buf_wsb_array
);
430 crash_get_layout(layout
, abi
, offset
.buf_wsb_id
);
431 crash_get_layout(layout
, abi
, offset
.sb_array
);
432 crash_get_layout(layout
, abi
, offset
.sb_array_shmp_offset
);
433 crash_get_layout(layout
, abi
, offset
.sb_backend_p_offset
);
434 crash_get_layout(layout
, abi
, offset
.content_size
);
435 crash_get_layout(layout
, abi
, offset
.packet_size
);
437 crash_get_layout(layout
, abi
, length
.prod_offset
);
438 crash_get_layout(layout
, abi
, length
.consumed_offset
);
439 crash_get_layout(layout
, abi
, length
.commit_hot_seq
);
440 crash_get_layout(layout
, abi
, length
.buf_wsb_id
);
441 crash_get_layout(layout
, abi
, length
.sb_array_shmp_offset
);
442 crash_get_layout(layout
, abi
, length
.sb_backend_p_offset
);
443 crash_get_layout(layout
, abi
, length
.content_size
);
444 crash_get_layout(layout
, abi
, length
.packet_size
);
446 crash_get_layout(layout
, abi
, stride
.commit_hot_array
);
447 crash_get_layout(layout
, abi
, stride
.buf_wsb_array
);
448 crash_get_layout(layout
, abi
, stride
.sb_array
);
450 crash_get_layout(layout
, abi
, buf_size
);
451 crash_get_layout(layout
, abi
, subbuf_size
);
452 crash_get_layout(layout
, abi
, num_subbuf
);
453 crash_get_layout(layout
, abi
, mode
);
459 void print_dbg_magic(const uint8_t *magic
)
461 DBG("magic: 0x%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X%X",
462 magic
[0], magic
[1], magic
[2], magic
[3],
463 magic
[4], magic
[5], magic
[6], magic
[7],
464 magic
[8], magic
[9], magic
[10], magic
[11],
465 magic
[12], magic
[13], magic
[14], magic
[15]);
469 int check_magic(const uint8_t *magic
)
473 for (i
= 0; i
< RB_CRASH_DUMP_ABI_MAGIC_LEN
; i
++) {
474 if ((magic
[i
] ^ 0xFF) != lttng_crash_expected_magic_xor
[i
]) {
482 int get_crash_layout(struct lttng_crash_layout
*layout
, int fd
)
485 int ret
= 0, unmapret
;
486 const uint8_t *magic
;
487 uint64_t mmap_length
;
488 uint16_t major
, minor
;
490 const struct crash_abi_unknown
*abi
;
492 enum lttng_crash_type layout_type
;
494 map
= mmap(NULL
, RB_CRASH_DUMP_ABI_LEN
, PROT_READ
, MAP_PRIVATE
,
496 if (map
== MAP_FAILED
) {
497 PERROR("Mapping file");
500 abi
= (const struct crash_abi_unknown
*) map
;
501 magic
= crash_get_hdr_raw_field(layout
, abi
, magic
);
502 print_dbg_magic(magic
);
503 if (check_magic(magic
)) {
504 DBG("Unknown magic number");
505 ret
= 1; /* positive return value, skip */
508 endian
= crash_get_hdr_field(layout
, abi
, endian
);
510 case RB_CRASH_ENDIAN
:
512 case RB_CRASH_ENDIAN_REVERSE
:
513 layout
->reverse_byte_order
= 1;
516 DBG("Unknown endianness value: 0x%X", (unsigned int) endian
);
517 ret
= 1; /* positive return value, skip */
520 layout_type
= (enum lttng_crash_type
) crash_get_hdr_field(layout
, abi
, layout_type
);
521 switch (layout_type
) {
522 case LTTNG_CRASH_TYPE_UST
:
524 case LTTNG_CRASH_TYPE_KERNEL
:
525 ERR("lttng-modules buffer layout support not implemented");
526 ret
= 1; /* positive return value, skip */
529 ERR("Unknown layout type %u", (unsigned int) layout_type
);
530 ret
= 1; /* positive return value, skip */
533 mmap_length
= crash_get_hdr_field(layout
, abi
, mmap_length
);
534 DBG("mmap_length: %" PRIu64
, mmap_length
);
535 layout
->mmap_length
= mmap_length
;
536 major
= crash_get_hdr_field(layout
, abi
, major
);
537 DBG("major: %u", major
);
538 minor
= crash_get_hdr_field(layout
, abi
, minor
);
539 DBG("minor: %u", minor
);
540 word_size
= crash_get_hdr_field(layout
, abi
, word_size
);
541 DBG("word_size: %u", word_size
);
546 ret
= get_crash_layout_0_0(layout
, map
);
552 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
557 ERR("Unsupported crash ABI %u.%u\n", major
, minor
);
561 layout
->word_size
= word_size
;
563 unmapret
= munmap(map
, RB_CRASH_DUMP_ABI_LEN
);
570 /* buf_trunc mask selects only the buffer number. */
572 uint64_t buf_trunc(uint64_t offset
, uint64_t buf_size
)
574 return offset
& ~(buf_size
- 1);
577 /* subbuf_trunc mask selects the subbuffer number. */
579 uint64_t subbuf_trunc(uint64_t offset
, uint64_t subbuf_size
)
581 return offset
& ~(subbuf_size
- 1);
584 /* buf_offset mask selects only the offset within the current buffer. */
586 uint64_t buf_offset(uint64_t offset
, uint64_t buf_size
)
588 return offset
& (buf_size
- 1);
591 /* subbuf_offset mask selects the offset within the current subbuffer. */
593 uint64_t subbuf_offset(uint64_t offset
, uint64_t subbuf_size
)
595 return offset
& (subbuf_size
- 1);
598 /* subbuf_index returns the index of the current subbuffer within the buffer. */
600 uint64_t subbuf_index(uint64_t offset
, uint64_t buf_size
, uint64_t subbuf_size
)
602 return buf_offset(offset
, buf_size
) / subbuf_size
;
606 uint64_t subbuffer_id_get_index(uint32_t mode
, uint64_t id
,
609 if (mode
== RING_BUFFER_OVERWRITE
)
610 return id
& SB_ID_INDEX_MASK(wl
);
616 int copy_crash_subbuf(const struct lttng_crash_layout
*layout
,
617 int fd_dest
, char *buf
, uint64_t offset
)
619 uint64_t buf_size
, subbuf_size
, num_subbuf
, sbidx
, id
,
620 sb_bindex
, rpages_offset
, p_offset
, seq_cc
,
621 committed
, commit_count_mask
, consumed_cur
,
627 * Get the current subbuffer by applying the proper mask to
628 * "offset", and looking up the subbuf location within the
632 buf_size
= layout
->buf_size
;
633 subbuf_size
= layout
->subbuf_size
;
634 num_subbuf
= layout
->num_subbuf
;
636 switch (layout
->word_size
) {
637 case 4: commit_count_mask
= 0xFFFFFFFFULL
/ num_subbuf
;
639 case 8: commit_count_mask
= 0xFFFFFFFFFFFFFFFFULL
/ num_subbuf
;
642 ERR("Unsupported word size: %u",
643 (unsigned int) layout
->word_size
);
647 DBG("Copy crash subbuffer at offset %lu", offset
);
648 sbidx
= subbuf_index(offset
, buf_size
, subbuf_size
);
651 * Find where the seq cc is located. Compute length of data to
654 seq_cc
= crash_get_array_field(layout
, buf
, commit_hot_array
,
655 sbidx
, commit_hot_seq
);
656 consumed_cur
= crash_get_field(layout
, buf
, consumed_offset
);
659 * Check that the buffer we are getting is after or at
660 * consumed_cur position.
662 if ((long) subbuf_trunc(offset
, subbuf_size
)
663 - (long) subbuf_trunc(consumed_cur
, subbuf_size
) < 0) {
664 DBG("No data: position is before consumed_cur");
669 * Check if subbuffer has been fully committed.
671 if (((seq_cc
- subbuf_size
) & commit_count_mask
)
672 - (buf_trunc(offset
, buf_size
) / num_subbuf
)
674 committed
= subbuf_size
;
676 committed
= subbuf_offset(seq_cc
, subbuf_size
);
678 DBG("No data committed, seq_cc: %" PRIu64
, seq_cc
);
683 /* Find actual physical offset in subbuffer table */
684 id
= crash_get_array_field(layout
, buf
, buf_wsb_array
,
686 sb_bindex
= subbuffer_id_get_index(layout
->mode
, id
,
688 rpages_offset
= crash_get_array_field(layout
, buf
, sb_array
,
689 sb_bindex
, sb_array_shmp_offset
);
690 p_offset
= crash_get_field(layout
, buf
+ rpages_offset
,
691 sb_backend_p_offset
);
692 subbuf_ptr
= buf
+ p_offset
;
694 if (committed
== subbuf_size
) {
696 * Packet header can be used.
698 if (layout
->length
.packet_size
) {
700 subbuf_ptr
+ layout
->offset
.packet_size
,
701 layout
->length
.packet_size
);
702 if (layout
->reverse_byte_order
) {
703 packet_size
= __bswap_64(packet_size
);
705 packet_size
/= CHAR_BIT
;
707 packet_size
= subbuf_size
;
713 * Find where to patch the sub-buffer header with actual
714 * readable data len and packet len, derived from seq
715 * cc. Patch it in our in-memory copy.
717 patch_size
= committed
* CHAR_BIT
;
718 if (layout
->reverse_byte_order
) {
719 patch_size
= __bswap_64(patch_size
);
721 if (layout
->length
.content_size
) {
722 memcpy(subbuf_ptr
+ layout
->offset
.content_size
,
723 &patch_size
, layout
->length
.content_size
);
725 if (layout
->length
.packet_size
) {
726 memcpy(subbuf_ptr
+ layout
->offset
.packet_size
,
727 &patch_size
, layout
->length
.packet_size
);
729 packet_size
= committed
;
733 * Copy packet into fd_dest.
735 writelen
= lttng_write(fd_dest
, subbuf_ptr
, packet_size
);
736 if (writelen
< packet_size
) {
737 PERROR("Error writing to output file");
740 DBG("Copied %" PRIu64
" bytes of data", packet_size
);
748 int copy_crash_data(const struct lttng_crash_layout
*layout
, int fd_dest
,
752 int ret
= 0, has_data
= 0;
755 uint64_t prod_offset
, consumed_offset
;
756 uint64_t offset
, subbuf_size
;
759 ret
= fstat(fd_src
, &statbuf
);
763 src_file_len
= layout
->mmap_length
;
764 buf
= zmalloc(src_file_len
);
768 readlen
= lttng_read(fd_src
, buf
, src_file_len
);
770 PERROR("Error reading input file");
774 prod_offset
= crash_get_field(layout
, buf
, prod_offset
);
775 DBG("prod_offset: 0x%" PRIx64
, prod_offset
);
776 consumed_offset
= crash_get_field(layout
, buf
, consumed_offset
);
777 DBG("consumed_offset: 0x%" PRIx64
, consumed_offset
);
778 subbuf_size
= layout
->subbuf_size
;
780 for (offset
= consumed_offset
; offset
< prod_offset
;
781 offset
+= subbuf_size
) {
782 ret
= copy_crash_subbuf(layout
, fd_dest
, buf
, offset
);
792 if (ret
&& ret
!= -ENODATA
) {
803 int extract_file(int output_dir_fd
, const char *output_file
,
804 int input_dir_fd
, const char *input_file
)
806 int fd_dest
, fd_src
, ret
= 0, closeret
;
807 struct lttng_crash_layout layout
;
809 layout
.reverse_byte_order
= 0; /* For reading magic number */
811 DBG("Extract file '%s'", input_file
);
812 fd_src
= openat(input_dir_fd
, input_file
, O_RDONLY
);
814 PERROR("Error opening '%s' for reading",
820 /* Query the crash ABI layout */
821 ret
= get_crash_layout(&layout
, fd_src
);
826 fd_dest
= openat(output_dir_fd
, output_file
,
827 O_RDWR
| O_CREAT
| O_EXCL
,
828 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
830 PERROR("Error opening '%s' for writing",
836 ret
= copy_crash_data(&layout
, fd_dest
, fd_src
);
842 closeret
= close(fd_dest
);
846 if (ret
== -ENODATA
) {
847 closeret
= unlinkat(output_dir_fd
, output_file
, 0);
853 closeret
= close(fd_src
);
862 int extract_all_files(const char *output_path
,
863 const char *input_path
)
865 DIR *input_dir
, *output_dir
;
866 int input_dir_fd
, output_dir_fd
, ret
= 0, closeret
;
867 struct dirent
*entry
; /* input */
869 /* Open input directory */
870 input_dir
= opendir(input_path
);
872 PERROR("Cannot open '%s' path", input_path
);
875 input_dir_fd
= dirfd(input_dir
);
876 if (input_dir_fd
< 0) {
881 /* Open output directory */
882 output_dir
= opendir(output_path
);
884 PERROR("Cannot open '%s' path", output_path
);
887 output_dir_fd
= dirfd(output_dir
);
888 if (output_dir_fd
< 0) {
893 while ((entry
= readdir(input_dir
))) {
894 if (!strcmp(entry
->d_name
, ".")
895 || !strcmp(entry
->d_name
, ".."))
897 ret
= extract_file(output_dir_fd
, entry
->d_name
,
898 input_dir_fd
, entry
->d_name
);
899 if (ret
== -ENODATA
) {
900 DBG("No data in file '%s', skipping", entry
->d_name
);
903 } else if (ret
< 0) {
905 } else if (ret
> 0) {
906 DBG("Skipping file '%s'", entry
->d_name
);
911 closeret
= closedir(output_dir
);
915 closeret
= closedir(input_dir
);
923 int extract_one_trace(const char *output_path
,
924 const char *input_path
)
926 char dest
[PATH_MAX
], src
[PATH_MAX
];
929 DBG("Extract crash trace '%s' into '%s'", input_path
, output_path
);
932 strncpy(dest
, output_path
, PATH_MAX
);
933 dest
[PATH_MAX
- 1] = '\0';
934 strncat(dest
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
936 strncpy(src
, input_path
, PATH_MAX
);
937 src
[PATH_MAX
- 1] = '\0';
938 strncat(src
, "/metadata", PATH_MAX
- strlen(dest
) - 1);
940 ret
= copy_file(dest
, src
);
945 /* Extract each other file that has expected header */
946 return extract_all_files(output_path
, input_path
);
950 int extract_all_traces(const char *output_path
,
957 /* Only one input path is currently supported */
958 if (nr_input_paths
!= 1) {
959 ERR("Only a single input path is currently supported.\n");
963 for (i
= 0; i
< nr_input_paths
; i
++) {
964 ret
= extract_one_trace(output_path
,
967 WARN("Error extracting trace '%s', continuing anyway.",
976 int delete_trace(const char *trace_path
)
979 int trace_dir_fd
, ret
= 0, closeret
;
980 struct dirent
*entry
;
982 /* Open trace directory */
983 trace_dir
= opendir(trace_path
);
985 PERROR("Cannot open '%s' path", trace_path
);
988 trace_dir_fd
= dirfd(trace_dir
);
989 if (trace_dir_fd
< 0) {
994 while ((entry
= readdir(trace_dir
))) {
995 if (!strcmp(entry
->d_name
, ".")
996 || !strcmp(entry
->d_name
, ".."))
998 switch (entry
->d_type
) {
1000 unlinkat(trace_dir_fd
, entry
->d_name
, AT_REMOVEDIR
);
1003 unlinkat(trace_dir_fd
, entry
->d_name
, 0);
1011 closeret
= closedir(trace_dir
);
1016 ret
= rmdir(trace_path
);
1023 int view_trace(const char *viewer_path
, const char *trace_path
)
1032 } else if (pid
> 0) {
1036 pid
= waitpid(pid
, &status
, 0);
1037 if (pid
< 0 || !WIFEXITED(status
)) {
1044 ret
= execlp(viewer_path
, viewer_path
,
1045 trace_path
, (char *) NULL
);
1050 exit(EXIT_SUCCESS
); /* Never reached */
1058 int main(int argc
, char *argv
[])
1060 int ret
, has_warning
= 0;
1061 const char *output_path
= NULL
;
1062 char tmppath
[] = "/tmp/lttng-crash-XXXXXX";
1064 progname
= argv
[0] ? argv
[0] : "lttng-crash";
1066 ret
= parse_args(argc
, argv
);
1069 } else if (ret
< 0) {
1073 if (opt_output_path
) {
1074 output_path
= opt_output_path
;
1075 ret
= mkdir(output_path
, S_IRWXU
| S_IRWXG
);
1081 output_path
= mkdtemp(tmppath
);
1088 ret
= extract_all_traces(output_path
, input_paths
,
1092 } else if (ret
> 0) {
1095 if (!opt_output_path
) {
1097 ret
= view_trace(opt_viewer_path
, output_path
);
1101 /* unlink temporary trace */
1102 ret
= delete_trace(output_path
);