2 This file is part of systemd.
4 Copyright 2012 Zbigniew Jędrzejewski-Szmek
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
27 #include "sd-journal.h"
29 #include "alloc-util.h"
34 #include "journal-internal.h"
38 #include "parse-util.h"
39 #include "path-util.h"
40 #include "process-util.h"
43 #include "signal-util.h"
44 #include "string-util.h"
45 #include "terminal-util.h"
46 #include "user-util.h"
55 } arg_action
= ACTION_LIST
;
56 static const char* arg_field
= NULL
;
57 static const char *arg_directory
= NULL
;
58 static bool arg_no_pager
= false;
59 static int arg_no_legend
= false;
60 static int arg_one
= false;
61 static FILE* arg_output
= NULL
;
63 static Set
*new_matches(void) {
74 tmp
= strdup("MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1");
81 r
= set_consume(set
, tmp
);
83 log_error_errno(r
, "failed to add to set: %m");
91 static int add_match(Set
*set
, const char *match
) {
92 _cleanup_free_
char *p
= NULL
;
98 if (strchr(match
, '='))
100 else if (strchr(match
, '/')) {
101 r
= path_make_absolute_cwd(match
, &p
);
105 prefix
= "COREDUMP_EXE=";
106 } else if (parse_pid(match
, &pid
) >= 0)
107 prefix
= "COREDUMP_PID=";
109 prefix
= "COREDUMP_COMM=";
111 pattern
= strjoin(prefix
, match
);
117 log_debug("Adding pattern: %s", pattern
);
118 r
= set_consume(set
, pattern
);
124 return log_error_errno(r
, "Failed to add match: %m");
127 static void help(void) {
128 printf("%s [OPTIONS...]\n\n"
129 "List or retrieve coredumps from the journal.\n\n"
131 " -h --help Show this help\n"
132 " --version Print version string\n"
133 " --no-pager Do not pipe output into a pager\n"
134 " --no-legend Do not print the column headers.\n"
135 " -1 Show information about most recent entry only\n"
136 " -F --field=FIELD List all values a certain field takes\n"
137 " -o --output=FILE Write output to FILE\n\n"
138 " -D --directory=DIR Use journal files from directory\n\n"
141 " list [MATCHES...] List available coredumps (default)\n"
142 " info [MATCHES...] Show detailed information about one or more coredumps\n"
143 " dump [MATCHES...] Print first matching coredump to stdout\n"
144 " gdb [MATCHES...] Start gdb for the first matching coredump\n"
145 , program_invocation_short_name
);
148 static int parse_argv(int argc
, char *argv
[], Set
*matches
) {
157 static const struct option options
[] = {
158 { "help", no_argument
, NULL
, 'h' },
159 { "version" , no_argument
, NULL
, ARG_VERSION
},
160 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
161 { "no-legend", no_argument
, NULL
, ARG_NO_LEGEND
},
162 { "output", required_argument
, NULL
, 'o' },
163 { "field", required_argument
, NULL
, 'F' },
164 { "directory", required_argument
, NULL
, 'D' },
171 while ((c
= getopt_long(argc
, argv
, "ho:F:1D:", options
, NULL
)) >= 0)
175 arg_action
= ACTION_NONE
;
180 arg_action
= ACTION_NONE
;
188 arg_no_legend
= true;
193 log_error("cannot set output more than once");
197 arg_output
= fopen(optarg
, "we");
199 return log_error_errno(errno
, "writing to '%s': %m", optarg
);
205 log_error("cannot use --field/-F more than once");
216 arg_directory
= optarg
;
223 assert_not_reached("Unhandled option");
227 const char *cmd
= argv
[optind
++];
228 if (streq(cmd
, "list"))
229 arg_action
= ACTION_LIST
;
230 else if (streq(cmd
, "dump"))
231 arg_action
= ACTION_DUMP
;
232 else if (streq(cmd
, "gdb"))
233 arg_action
= ACTION_GDB
;
234 else if (streq(cmd
, "info"))
235 arg_action
= ACTION_INFO
;
237 log_error("Unknown action '%s'", cmd
);
242 if (arg_field
&& arg_action
!= ACTION_LIST
) {
243 log_error("Option --field/-F only makes sense with list");
247 while (optind
< argc
) {
248 r
= add_match(matches
, argv
[optind
]);
257 static int retrieve(const void *data
,
265 ident
= strlen(name
) + 1; /* name + "=" */
270 if (memcmp(data
, name
, ident
- 1) != 0)
273 if (((const char*) data
)[ident
- 1] != '=')
276 v
= strndup((const char*)data
+ ident
, len
- ident
);
286 static int print_field(FILE* file
, sd_journal
*j
) {
295 /* A (user-specified) field may appear more than once for a given entry.
296 * We will print all of the occurences.
297 * This is different below for fields that systemd-coredump uses,
298 * because they cannot meaningfully appear more than once.
300 SD_JOURNAL_FOREACH_DATA(j
, d
, l
) {
301 _cleanup_free_
char *value
= NULL
;
304 r
= retrieve(d
, l
, arg_field
, &value
);
308 fprintf(file
, "%s\n", value
);
314 #define RETRIEVE(d, l, name, arg) \
316 int _r = retrieve(d, l, name, &arg); \
323 static int print_list(FILE* file
, sd_journal
*j
, int had_legend
) {
325 *pid
= NULL
, *uid
= NULL
, *gid
= NULL
,
326 *sgnl
= NULL
, *exe
= NULL
, *comm
= NULL
, *cmdline
= NULL
,
327 *filename
= NULL
, *coredump
= NULL
;
331 char buf
[FORMAT_TIMESTAMP_MAX
];
338 SD_JOURNAL_FOREACH_DATA(j
, d
, l
) {
339 RETRIEVE(d
, l
, "COREDUMP_PID", pid
);
340 RETRIEVE(d
, l
, "COREDUMP_UID", uid
);
341 RETRIEVE(d
, l
, "COREDUMP_GID", gid
);
342 RETRIEVE(d
, l
, "COREDUMP_SIGNAL", sgnl
);
343 RETRIEVE(d
, l
, "COREDUMP_EXE", exe
);
344 RETRIEVE(d
, l
, "COREDUMP_COMM", comm
);
345 RETRIEVE(d
, l
, "COREDUMP_CMDLINE", cmdline
);
346 RETRIEVE(d
, l
, "COREDUMP_FILENAME", filename
);
347 RETRIEVE(d
, l
, "COREDUMP", coredump
);
350 if (!pid
&& !uid
&& !gid
&& !sgnl
&& !exe
&& !comm
&& !cmdline
&& !filename
) {
351 log_warning("Empty coredump log entry");
355 r
= sd_journal_get_realtime_usec(j
, &t
);
357 return log_error_errno(r
, "Failed to get realtime timestamp: %m");
359 format_timestamp(buf
, sizeof(buf
), t
);
361 if (!had_legend
&& !arg_no_legend
)
362 fprintf(file
, "%-*s %*s %*s %*s %*s %*s %s\n",
363 FORMAT_TIMESTAMP_WIDTH
, "TIME",
372 if (access(filename
, R_OK
) == 0)
374 else if (errno
== ENOENT
)
383 fprintf(file
, "%-*s %*s %*s %*s %*s %-*s %s\n",
384 FORMAT_TIMESTAMP_WIDTH
, buf
,
390 strna(exe
?: (comm
?: cmdline
)));
395 static int print_info(FILE *file
, sd_journal
*j
, bool need_space
) {
397 *pid
= NULL
, *uid
= NULL
, *gid
= NULL
,
398 *sgnl
= NULL
, *exe
= NULL
, *comm
= NULL
, *cmdline
= NULL
,
399 *unit
= NULL
, *user_unit
= NULL
, *session
= NULL
,
400 *boot_id
= NULL
, *machine_id
= NULL
, *hostname
= NULL
,
401 *slice
= NULL
, *cgroup
= NULL
, *owner_uid
= NULL
,
402 *message
= NULL
, *timestamp
= NULL
, *filename
= NULL
,
411 SD_JOURNAL_FOREACH_DATA(j
, d
, l
) {
412 RETRIEVE(d
, l
, "COREDUMP_PID", pid
);
413 RETRIEVE(d
, l
, "COREDUMP_UID", uid
);
414 RETRIEVE(d
, l
, "COREDUMP_GID", gid
);
415 RETRIEVE(d
, l
, "COREDUMP_SIGNAL", sgnl
);
416 RETRIEVE(d
, l
, "COREDUMP_EXE", exe
);
417 RETRIEVE(d
, l
, "COREDUMP_COMM", comm
);
418 RETRIEVE(d
, l
, "COREDUMP_CMDLINE", cmdline
);
419 RETRIEVE(d
, l
, "COREDUMP_UNIT", unit
);
420 RETRIEVE(d
, l
, "COREDUMP_USER_UNIT", user_unit
);
421 RETRIEVE(d
, l
, "COREDUMP_SESSION", session
);
422 RETRIEVE(d
, l
, "COREDUMP_OWNER_UID", owner_uid
);
423 RETRIEVE(d
, l
, "COREDUMP_SLICE", slice
);
424 RETRIEVE(d
, l
, "COREDUMP_CGROUP", cgroup
);
425 RETRIEVE(d
, l
, "COREDUMP_TIMESTAMP", timestamp
);
426 RETRIEVE(d
, l
, "COREDUMP_FILENAME", filename
);
427 RETRIEVE(d
, l
, "COREDUMP", coredump
);
428 RETRIEVE(d
, l
, "_BOOT_ID", boot_id
);
429 RETRIEVE(d
, l
, "_MACHINE_ID", machine_id
);
430 RETRIEVE(d
, l
, "_HOSTNAME", hostname
);
431 RETRIEVE(d
, l
, "MESSAGE", message
);
439 " PID: %s%s%s (%s)\n",
440 ansi_highlight(), strna(pid
), ansi_normal(), comm
);
444 ansi_highlight(), strna(pid
), ansi_normal());
449 if (parse_uid(uid
, &n
) >= 0) {
450 _cleanup_free_
char *u
= NULL
;
466 if (parse_gid(gid
, &n
) >= 0) {
467 _cleanup_free_
char *g
= NULL
;
483 if (safe_atoi(sgnl
, &sig
) >= 0)
484 fprintf(file
, " Signal: %s (%s)\n", sgnl
, signal_to_string(sig
));
486 fprintf(file
, " Signal: %s\n", sgnl
);
492 r
= safe_atou64(timestamp
, &u
);
494 char absolute
[FORMAT_TIMESTAMP_MAX
], relative
[FORMAT_TIMESPAN_MAX
];
497 " Timestamp: %s (%s)\n",
498 format_timestamp(absolute
, sizeof(absolute
), u
),
499 format_timestamp_relative(relative
, sizeof(relative
), u
));
502 fprintf(file
, " Timestamp: %s\n", timestamp
);
506 fprintf(file
, " Command Line: %s\n", cmdline
);
508 fprintf(file
, " Executable: %s%s%s\n", ansi_highlight(), exe
, ansi_normal());
510 fprintf(file
, " Control Group: %s\n", cgroup
);
512 fprintf(file
, " Unit: %s\n", unit
);
514 fprintf(file
, " User Unit: %s\n", user_unit
);
516 fprintf(file
, " Slice: %s\n", slice
);
518 fprintf(file
, " Session: %s\n", session
);
522 if (parse_uid(owner_uid
, &n
) >= 0) {
523 _cleanup_free_
char *u
= NULL
;
527 " Owner UID: %s (%s)\n",
536 fprintf(file
, " Boot ID: %s\n", boot_id
);
538 fprintf(file
, " Machine ID: %s\n", machine_id
);
540 fprintf(file
, " Hostname: %s\n", hostname
);
543 fprintf(file
, " Storage: %s%s\n", filename
,
544 access(filename
, R_OK
) < 0 ? " (inaccessible)" : "");
546 fprintf(file
, " Storage: journal\n");
548 fprintf(file
, " Storage: none\n");
551 _cleanup_free_
char *m
= NULL
;
553 m
= strreplace(message
, "\n", "\n ");
555 fprintf(file
, " Message: %s\n", strstrip(m
?: message
));
561 static int focus(sd_journal
*j
) {
564 r
= sd_journal_seek_tail(j
);
566 r
= sd_journal_previous(j
);
568 return log_error_errno(r
, "Failed to search journal: %m");
570 log_error("No match found.");
576 static int print_entry(sd_journal
*j
, unsigned n_found
) {
579 if (arg_action
== ACTION_INFO
)
580 return print_info(stdout
, j
, n_found
);
582 return print_field(stdout
, j
);
584 return print_list(stdout
, j
, n_found
);
587 static int dump_list(sd_journal
*j
) {
588 unsigned n_found
= 0;
593 /* The coredumps are likely to compressed, and for just
594 * listing them we don't need to decompress them, so let's
595 * pick a fairly low data threshold here */
596 sd_journal_set_data_threshold(j
, 4096);
603 return print_entry(j
, 0);
605 SD_JOURNAL_FOREACH(j
) {
606 r
= print_entry(j
, n_found
++);
611 if (!arg_field
&& n_found
<= 0) {
612 log_notice("No coredumps found.");
620 static int save_core(sd_journal
*j
, FILE *file
, char **path
, bool *unlink_temp
) {
622 _cleanup_free_
char *filename
= NULL
;
625 _cleanup_close_
int fdt
= -1;
628 assert(!(file
&& path
)); /* At most one can be specified */
629 assert(!!path
== !!unlink_temp
); /* Those must be specified together */
631 /* Look for a coredump on disk first. */
632 r
= sd_journal_get_data(j
, "COREDUMP_FILENAME", (const void**) &data
, &len
);
634 retrieve(data
, len
, "COREDUMP_FILENAME", &filename
);
637 return log_error_errno(r
, "Failed to retrieve COREDUMP_FILENAME field: %m");
638 /* Check that we can have a COREDUMP field. We still haven't set a high
639 * data threshold, so we'll get a few kilobytes at most.
642 r
= sd_journal_get_data(j
, "COREDUMP", (const void**) &data
, &len
);
644 return log_error_errno(r
, "Coredump entry has no core attached (neither internally in the journal nor externally on disk).");
646 return log_error_errno(r
, "Failed to retrieve COREDUMP field: %m");
650 if (access(filename
, R_OK
) < 0)
651 return log_error_errno(errno
, "File \"%s\" is not readable: %m", filename
);
653 if (path
&& !endswith(filename
, ".xz") && !endswith(filename
, ".lz4")) {
664 /* Create a temporary file to write the uncompressed core to. */
666 r
= var_tmp_dir(&vt
);
668 return log_error_errno(r
, "Failed to acquire temporary directory path: %m");
670 temp
= strjoin(vt
, "/coredump-XXXXXX");
674 fdt
= mkostemp_safe(temp
);
676 return log_error_errno(fdt
, "Failed to create temporary file: %m");
677 log_debug("Created temporary file %s", temp
);
681 /* If neither path or file are specified, we will write to stdout. Let's now check
682 * if stdout is connected to a tty. We checked that the file exists, or that the
683 * core might be stored in the journal. In this second case, if we found the entry,
684 * in all likelyhood we will be able to access the COREDUMP= field. In either case,
685 * we stop before doing any "real" work, i.e. before starting decompression or
686 * reading from the file or creating temporary files.
690 return log_error_errno(ENOTTY
, "Refusing to dump core to tty"
691 " (use shell redirection or specify --output).");
699 #if defined(HAVE_XZ) || defined(HAVE_LZ4)
700 _cleanup_close_
int fdf
;
702 fdf
= open(filename
, O_RDONLY
| O_CLOEXEC
);
704 r
= log_error_errno(errno
, "Failed to open %s: %m", filename
);
708 r
= decompress_stream(filename
, fdf
, fd
, -1);
710 log_error_errno(r
, "Failed to decompress %s: %m", filename
);
714 log_error("Cannot decompress file. Compiled without compression support.");
721 /* We want full data, nothing truncated. */
722 sd_journal_set_data_threshold(j
, 0);
724 r
= sd_journal_get_data(j
, "COREDUMP", (const void**) &data
, &len
);
726 return log_error_errno(r
, "Failed to retrieve COREDUMP field: %m");
732 sz
= write(fd
, data
, len
);
734 r
= log_error_errno(errno
, "Failed to write output: %m");
737 if (sz
!= (ssize_t
) len
) {
738 log_error("Short write to output.");
753 log_debug("Removed temporary file %s", temp
);
758 static int dump_core(sd_journal
* j
) {
767 print_info(arg_output
? stdout
: stderr
, j
, false);
769 r
= save_core(j
, arg_output
, NULL
, NULL
);
773 r
= sd_journal_previous(j
);
775 log_warning("More than one entry matches, ignoring rest.");
780 static int run_gdb(sd_journal
*j
) {
781 _cleanup_free_
char *exe
= NULL
, *path
= NULL
;
782 bool unlink_path
= false;
795 print_info(stdout
, j
, false);
798 r
= sd_journal_get_data(j
, "COREDUMP_EXE", (const void**) &data
, &len
);
800 return log_error_errno(r
, "Failed to retrieve COREDUMP_EXE field: %m");
802 assert(len
> strlen("COREDUMP_EXE="));
803 data
+= strlen("COREDUMP_EXE=");
804 len
-= strlen("COREDUMP_EXE=");
806 exe
= strndup(data
, len
);
810 if (endswith(exe
, " (deleted)")) {
811 log_error("Binary already deleted.");
815 if (!path_is_absolute(exe
)) {
816 log_error("Binary is not an absolute path.");
820 r
= save_core(j
, NULL
, &path
, &unlink_path
);
824 /* Don't interfere with gdb and its handling of SIGINT. */
825 (void) ignore_signals(SIGINT
, -1);
829 r
= log_error_errno(errno
, "Failed to fork(): %m");
833 (void) reset_all_signal_handlers();
834 (void) reset_signal_mask();
836 execlp("gdb", "gdb", exe
, path
, NULL
);
838 log_error_errno(errno
, "Failed to invoke gdb: %m");
842 r
= wait_for_terminate(pid
, &st
);
844 log_error_errno(r
, "Failed to wait for gdb: %m");
848 r
= st
.si_code
== CLD_EXITED
? st
.si_status
: 255;
851 (void) default_signals(SIGINT
, -1);
854 log_debug("Removed temporary file %s", path
);
861 int main(int argc
, char *argv
[]) {
862 _cleanup_(sd_journal_closep
) sd_journal
*j
= NULL
;
866 _cleanup_set_free_free_ Set
*matches
= NULL
;
868 setlocale(LC_ALL
, "");
869 log_parse_environment();
872 matches
= new_matches();
878 r
= parse_argv(argc
, argv
, matches
);
882 if (arg_action
== ACTION_NONE
)
888 r
= sd_journal_open_directory(&j
, arg_directory
, 0);
890 log_error_errno(r
, "Failed to open journals in directory: %s: %m", arg_directory
);
894 r
= sd_journal_open(&j
, SD_JOURNAL_LOCAL_ONLY
);
896 log_error_errno(r
, "Failed to open journal: %m");
901 SET_FOREACH(match
, matches
, it
) {
902 r
= sd_journal_add_match(j
, match
, strlen(match
));
904 log_error_errno(r
, "Failed to add match '%s': %m",
910 if (_unlikely_(log_get_max_level() >= LOG_DEBUG
)) {
911 _cleanup_free_
char *filter
;
913 filter
= journal_make_match_string(j
);
914 log_debug("Journal filter: %s", filter
);
921 pager_open(arg_no_pager
, false);
934 assert_not_reached("Shouldn't be here");
943 return r
>= 0 ? r
: EXIT_FAILURE
;