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"
42 #include "signal-util.h"
43 #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
;
62 static bool arg_reverse
= false;
63 static char** arg_matches
= NULL
;
65 static int add_match(sd_journal
*j
, const char *match
) {
66 _cleanup_free_
char *p
= NULL
;
72 if (strchr(match
, '='))
74 else if (strchr(match
, '/')) {
75 r
= path_make_absolute_cwd(match
, &p
);
77 return log_error_errno(r
, "path_make_absolute_cwd(\"%s\"): %m", match
);
80 prefix
= "COREDUMP_EXE=";
81 } else if (parse_pid(match
, &pid
) >= 0)
82 prefix
= "COREDUMP_PID=";
84 prefix
= "COREDUMP_COMM=";
86 pattern
= strjoin(prefix
, match
);
90 log_debug("Adding match: %s", pattern
);
91 r
= sd_journal_add_match(j
, pattern
, 0);
93 return log_error_errno(r
, "Failed to add match \"%s\": %m", match
);
97 static int add_matches(sd_journal
*j
) {
101 r
= sd_journal_add_match(j
, "MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1", 0);
103 return log_error_errno(r
, "Failed to add match \"%s\": %m",
104 "MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1");
106 STRV_FOREACH(match
, arg_matches
) {
107 r
= add_match(j
, *match
);
115 static void help(void) {
116 printf("%s [OPTIONS...]\n\n"
117 "List or retrieve coredumps from the journal.\n\n"
119 " -h --help Show this help\n"
120 " --version Print version string\n"
121 " --no-pager Do not pipe output into a pager\n"
122 " --no-legend Do not print the column headers.\n"
123 " -1 Show information about most recent entry only\n"
124 " -r --reverse Show the newest entries first\n"
125 " -F --field=FIELD List all values a certain field takes\n"
126 " -o --output=FILE Write output to FILE\n"
127 " -D --directory=DIR Use journal files from directory\n\n"
130 " list [MATCHES...] List available coredumps (default)\n"
131 " info [MATCHES...] Show detailed information about one or more coredumps\n"
132 " dump [MATCHES...] Print first matching coredump to stdout\n"
133 " gdb [MATCHES...] Start gdb for the first matching coredump\n"
134 , program_invocation_short_name
);
137 static int parse_argv(int argc
, char *argv
[]) {
146 static const struct option options
[] = {
147 { "help", no_argument
, NULL
, 'h' },
148 { "version" , no_argument
, NULL
, ARG_VERSION
},
149 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
150 { "no-legend", no_argument
, NULL
, ARG_NO_LEGEND
},
151 { "output", required_argument
, NULL
, 'o' },
152 { "field", required_argument
, NULL
, 'F' },
153 { "directory", required_argument
, NULL
, 'D' },
154 { "reverse", no_argument
, NULL
, 'r' },
161 while ((c
= getopt_long(argc
, argv
, "ho:F:1D:r", options
, NULL
)) >= 0)
165 arg_action
= ACTION_NONE
;
170 arg_action
= ACTION_NONE
;
178 arg_no_legend
= true;
183 log_error("cannot set output more than once");
187 arg_output
= fopen(optarg
, "we");
189 return log_error_errno(errno
, "writing to '%s': %m", optarg
);
195 log_error("cannot use --field/-F more than once");
206 arg_directory
= optarg
;
217 assert_not_reached("Unhandled option");
221 const char *cmd
= argv
[optind
++];
222 if (streq(cmd
, "list"))
223 arg_action
= ACTION_LIST
;
224 else if (streq(cmd
, "dump"))
225 arg_action
= ACTION_DUMP
;
226 else if (streq(cmd
, "gdb"))
227 arg_action
= ACTION_GDB
;
228 else if (streq(cmd
, "info"))
229 arg_action
= ACTION_INFO
;
231 log_error("Unknown action '%s'", cmd
);
236 if (arg_field
&& arg_action
!= ACTION_LIST
) {
237 log_error("Option --field/-F only makes sense with list");
242 arg_matches
= argv
+ optind
;
247 static int retrieve(const void *data
,
255 ident
= strlen(name
) + 1; /* name + "=" */
260 if (memcmp(data
, name
, ident
- 1) != 0)
263 if (((const char*) data
)[ident
- 1] != '=')
266 v
= strndup((const char*)data
+ ident
, len
- ident
);
276 static int print_field(FILE* file
, sd_journal
*j
) {
285 /* A (user-specified) field may appear more than once for a given entry.
286 * We will print all of the occurences.
287 * This is different below for fields that systemd-coredump uses,
288 * because they cannot meaningfully appear more than once.
290 SD_JOURNAL_FOREACH_DATA(j
, d
, l
) {
291 _cleanup_free_
char *value
= NULL
;
294 r
= retrieve(d
, l
, arg_field
, &value
);
298 fprintf(file
, "%s\n", value
);
304 #define RETRIEVE(d, l, name, arg) \
306 int _r = retrieve(d, l, name, &arg); \
313 static int print_list(FILE* file
, sd_journal
*j
, int had_legend
) {
315 *pid
= NULL
, *uid
= NULL
, *gid
= NULL
,
316 *sgnl
= NULL
, *exe
= NULL
, *comm
= NULL
, *cmdline
= NULL
,
317 *filename
= NULL
, *coredump
= NULL
;
321 char buf
[FORMAT_TIMESTAMP_MAX
];
328 SD_JOURNAL_FOREACH_DATA(j
, d
, l
) {
329 RETRIEVE(d
, l
, "COREDUMP_PID", pid
);
330 RETRIEVE(d
, l
, "COREDUMP_UID", uid
);
331 RETRIEVE(d
, l
, "COREDUMP_GID", gid
);
332 RETRIEVE(d
, l
, "COREDUMP_SIGNAL", sgnl
);
333 RETRIEVE(d
, l
, "COREDUMP_EXE", exe
);
334 RETRIEVE(d
, l
, "COREDUMP_COMM", comm
);
335 RETRIEVE(d
, l
, "COREDUMP_CMDLINE", cmdline
);
336 RETRIEVE(d
, l
, "COREDUMP_FILENAME", filename
);
337 RETRIEVE(d
, l
, "COREDUMP", coredump
);
340 if (!pid
&& !uid
&& !gid
&& !sgnl
&& !exe
&& !comm
&& !cmdline
&& !filename
) {
341 log_warning("Empty coredump log entry");
345 r
= sd_journal_get_realtime_usec(j
, &t
);
347 return log_error_errno(r
, "Failed to get realtime timestamp: %m");
349 format_timestamp(buf
, sizeof(buf
), t
);
351 if (!had_legend
&& !arg_no_legend
)
352 fprintf(file
, "%-*s %*s %*s %*s %*s %*s %s\n",
353 FORMAT_TIMESTAMP_WIDTH
, "TIME",
362 if (access(filename
, R_OK
) == 0)
364 else if (errno
== ENOENT
)
373 fprintf(file
, "%-*s %*s %*s %*s %*s %-*s %s\n",
374 FORMAT_TIMESTAMP_WIDTH
, buf
,
380 strna(exe
?: (comm
?: cmdline
)));
385 static int print_info(FILE *file
, sd_journal
*j
, bool need_space
) {
387 *pid
= NULL
, *uid
= NULL
, *gid
= NULL
,
388 *sgnl
= NULL
, *exe
= NULL
, *comm
= NULL
, *cmdline
= NULL
,
389 *unit
= NULL
, *user_unit
= NULL
, *session
= NULL
,
390 *boot_id
= NULL
, *machine_id
= NULL
, *hostname
= NULL
,
391 *slice
= NULL
, *cgroup
= NULL
, *owner_uid
= NULL
,
392 *message
= NULL
, *timestamp
= NULL
, *filename
= NULL
,
401 SD_JOURNAL_FOREACH_DATA(j
, d
, l
) {
402 RETRIEVE(d
, l
, "COREDUMP_PID", pid
);
403 RETRIEVE(d
, l
, "COREDUMP_UID", uid
);
404 RETRIEVE(d
, l
, "COREDUMP_GID", gid
);
405 RETRIEVE(d
, l
, "COREDUMP_SIGNAL", sgnl
);
406 RETRIEVE(d
, l
, "COREDUMP_EXE", exe
);
407 RETRIEVE(d
, l
, "COREDUMP_COMM", comm
);
408 RETRIEVE(d
, l
, "COREDUMP_CMDLINE", cmdline
);
409 RETRIEVE(d
, l
, "COREDUMP_UNIT", unit
);
410 RETRIEVE(d
, l
, "COREDUMP_USER_UNIT", user_unit
);
411 RETRIEVE(d
, l
, "COREDUMP_SESSION", session
);
412 RETRIEVE(d
, l
, "COREDUMP_OWNER_UID", owner_uid
);
413 RETRIEVE(d
, l
, "COREDUMP_SLICE", slice
);
414 RETRIEVE(d
, l
, "COREDUMP_CGROUP", cgroup
);
415 RETRIEVE(d
, l
, "COREDUMP_TIMESTAMP", timestamp
);
416 RETRIEVE(d
, l
, "COREDUMP_FILENAME", filename
);
417 RETRIEVE(d
, l
, "COREDUMP", coredump
);
418 RETRIEVE(d
, l
, "_BOOT_ID", boot_id
);
419 RETRIEVE(d
, l
, "_MACHINE_ID", machine_id
);
420 RETRIEVE(d
, l
, "_HOSTNAME", hostname
);
421 RETRIEVE(d
, l
, "MESSAGE", message
);
429 " PID: %s%s%s (%s)\n",
430 ansi_highlight(), strna(pid
), ansi_normal(), comm
);
434 ansi_highlight(), strna(pid
), ansi_normal());
439 if (parse_uid(uid
, &n
) >= 0) {
440 _cleanup_free_
char *u
= NULL
;
456 if (parse_gid(gid
, &n
) >= 0) {
457 _cleanup_free_
char *g
= NULL
;
473 if (safe_atoi(sgnl
, &sig
) >= 0)
474 fprintf(file
, " Signal: %s (%s)\n", sgnl
, signal_to_string(sig
));
476 fprintf(file
, " Signal: %s\n", sgnl
);
482 r
= safe_atou64(timestamp
, &u
);
484 char absolute
[FORMAT_TIMESTAMP_MAX
], relative
[FORMAT_TIMESPAN_MAX
];
487 " Timestamp: %s (%s)\n",
488 format_timestamp(absolute
, sizeof(absolute
), u
),
489 format_timestamp_relative(relative
, sizeof(relative
), u
));
492 fprintf(file
, " Timestamp: %s\n", timestamp
);
496 fprintf(file
, " Command Line: %s\n", cmdline
);
498 fprintf(file
, " Executable: %s%s%s\n", ansi_highlight(), exe
, ansi_normal());
500 fprintf(file
, " Control Group: %s\n", cgroup
);
502 fprintf(file
, " Unit: %s\n", unit
);
504 fprintf(file
, " User Unit: %s\n", user_unit
);
506 fprintf(file
, " Slice: %s\n", slice
);
508 fprintf(file
, " Session: %s\n", session
);
512 if (parse_uid(owner_uid
, &n
) >= 0) {
513 _cleanup_free_
char *u
= NULL
;
517 " Owner UID: %s (%s)\n",
526 fprintf(file
, " Boot ID: %s\n", boot_id
);
528 fprintf(file
, " Machine ID: %s\n", machine_id
);
530 fprintf(file
, " Hostname: %s\n", hostname
);
533 fprintf(file
, " Storage: %s%s\n", filename
,
534 access(filename
, R_OK
) < 0 ? " (inaccessible)" : "");
536 fprintf(file
, " Storage: journal\n");
538 fprintf(file
, " Storage: none\n");
541 _cleanup_free_
char *m
= NULL
;
543 m
= strreplace(message
, "\n", "\n ");
545 fprintf(file
, " Message: %s\n", strstrip(m
?: message
));
551 static int focus(sd_journal
*j
) {
554 r
= sd_journal_seek_tail(j
);
556 r
= sd_journal_previous(j
);
558 return log_error_errno(r
, "Failed to search journal: %m");
560 log_error("No match found.");
566 static int print_entry(sd_journal
*j
, unsigned n_found
) {
569 if (arg_action
== ACTION_INFO
)
570 return print_info(stdout
, j
, n_found
);
572 return print_field(stdout
, j
);
574 return print_list(stdout
, j
, n_found
);
577 static int dump_list(sd_journal
*j
) {
578 unsigned n_found
= 0;
583 /* The coredumps are likely to compressed, and for just
584 * listing them we don't need to decompress them, so let's
585 * pick a fairly low data threshold here */
586 sd_journal_set_data_threshold(j
, 4096);
593 return print_entry(j
, 0);
596 SD_JOURNAL_FOREACH(j
) {
597 r
= print_entry(j
, n_found
++);
602 SD_JOURNAL_FOREACH_BACKWARDS(j
) {
603 r
= print_entry(j
, n_found
++);
609 if (!arg_field
&& n_found
<= 0) {
610 log_notice("No coredumps found.");
618 static int save_core(sd_journal
*j
, FILE *file
, char **path
, bool *unlink_temp
) {
620 _cleanup_free_
char *filename
= NULL
;
623 _cleanup_close_
int fdt
= -1;
626 assert(!(file
&& path
)); /* At most one can be specified */
627 assert(!!path
== !!unlink_temp
); /* Those must be specified together */
629 /* Look for a coredump on disk first. */
630 r
= sd_journal_get_data(j
, "COREDUMP_FILENAME", (const void**) &data
, &len
);
632 retrieve(data
, len
, "COREDUMP_FILENAME", &filename
);
635 return log_error_errno(r
, "Failed to retrieve COREDUMP_FILENAME field: %m");
636 /* Check that we can have a COREDUMP field. We still haven't set a high
637 * data threshold, so we'll get a few kilobytes at most.
640 r
= sd_journal_get_data(j
, "COREDUMP", (const void**) &data
, &len
);
642 return log_error_errno(r
, "Coredump entry has no core attached (neither internally in the journal nor externally on disk).");
644 return log_error_errno(r
, "Failed to retrieve COREDUMP field: %m");
648 if (access(filename
, R_OK
) < 0)
649 return log_error_errno(errno
, "File \"%s\" is not readable: %m", filename
);
651 if (path
&& !endswith(filename
, ".xz") && !endswith(filename
, ".lz4")) {
662 /* Create a temporary file to write the uncompressed core to. */
664 r
= var_tmp_dir(&vt
);
666 return log_error_errno(r
, "Failed to acquire temporary directory path: %m");
668 temp
= strjoin(vt
, "/coredump-XXXXXX");
672 fdt
= mkostemp_safe(temp
);
674 return log_error_errno(fdt
, "Failed to create temporary file: %m");
675 log_debug("Created temporary file %s", temp
);
679 /* If neither path or file are specified, we will write to stdout. Let's now check
680 * if stdout is connected to a tty. We checked that the file exists, or that the
681 * core might be stored in the journal. In this second case, if we found the entry,
682 * in all likelyhood we will be able to access the COREDUMP= field. In either case,
683 * we stop before doing any "real" work, i.e. before starting decompression or
684 * reading from the file or creating temporary files.
688 return log_error_errno(ENOTTY
, "Refusing to dump core to tty"
689 " (use shell redirection or specify --output).");
697 #if defined(HAVE_XZ) || defined(HAVE_LZ4)
698 _cleanup_close_
int fdf
;
700 fdf
= open(filename
, O_RDONLY
| O_CLOEXEC
);
702 r
= log_error_errno(errno
, "Failed to open %s: %m", filename
);
706 r
= decompress_stream(filename
, fdf
, fd
, -1);
708 log_error_errno(r
, "Failed to decompress %s: %m", filename
);
712 log_error("Cannot decompress file. Compiled without compression support.");
719 /* We want full data, nothing truncated. */
720 sd_journal_set_data_threshold(j
, 0);
722 r
= sd_journal_get_data(j
, "COREDUMP", (const void**) &data
, &len
);
724 return log_error_errno(r
, "Failed to retrieve COREDUMP field: %m");
730 sz
= write(fd
, data
, len
);
732 r
= log_error_errno(errno
, "Failed to write output: %m");
735 if (sz
!= (ssize_t
) len
) {
736 log_error("Short write to output.");
751 log_debug("Removed temporary file %s", temp
);
756 static int dump_core(sd_journal
* j
) {
765 print_info(arg_output
? stdout
: stderr
, j
, false);
767 r
= save_core(j
, arg_output
, NULL
, NULL
);
771 r
= sd_journal_previous(j
);
773 log_warning("More than one entry matches, ignoring rest.");
778 static int run_gdb(sd_journal
*j
) {
779 _cleanup_free_
char *exe
= NULL
, *path
= NULL
;
780 bool unlink_path
= false;
793 print_info(stdout
, j
, false);
796 r
= sd_journal_get_data(j
, "COREDUMP_EXE", (const void**) &data
, &len
);
798 return log_error_errno(r
, "Failed to retrieve COREDUMP_EXE field: %m");
800 assert(len
> strlen("COREDUMP_EXE="));
801 data
+= strlen("COREDUMP_EXE=");
802 len
-= strlen("COREDUMP_EXE=");
804 exe
= strndup(data
, len
);
808 if (endswith(exe
, " (deleted)")) {
809 log_error("Binary already deleted.");
813 if (!path_is_absolute(exe
)) {
814 log_error("Binary is not an absolute path.");
818 r
= save_core(j
, NULL
, &path
, &unlink_path
);
822 /* Don't interfere with gdb and its handling of SIGINT. */
823 (void) ignore_signals(SIGINT
, -1);
827 r
= log_error_errno(errno
, "Failed to fork(): %m");
831 (void) reset_all_signal_handlers();
832 (void) reset_signal_mask();
834 execlp("gdb", "gdb", exe
, path
, NULL
);
836 log_error_errno(errno
, "Failed to invoke gdb: %m");
840 r
= wait_for_terminate(pid
, &st
);
842 log_error_errno(r
, "Failed to wait for gdb: %m");
846 r
= st
.si_code
== CLD_EXITED
? st
.si_status
: 255;
849 (void) default_signals(SIGINT
, -1);
852 log_debug("Removed temporary file %s", path
);
859 int main(int argc
, char *argv
[]) {
860 _cleanup_(sd_journal_closep
) sd_journal
*j
= NULL
;
863 setlocale(LC_ALL
, "");
864 log_parse_environment();
867 r
= parse_argv(argc
, argv
);
871 if (arg_action
== ACTION_NONE
)
877 r
= sd_journal_open_directory(&j
, arg_directory
, 0);
879 log_error_errno(r
, "Failed to open journals in directory: %s: %m", arg_directory
);
883 r
= sd_journal_open(&j
, SD_JOURNAL_LOCAL_ONLY
);
885 log_error_errno(r
, "Failed to open journal: %m");
894 if (_unlikely_(log_get_max_level() >= LOG_DEBUG
)) {
895 _cleanup_free_
char *filter
;
897 filter
= journal_make_match_string(j
);
898 log_debug("Journal filter: %s", filter
);
905 pager_open(arg_no_pager
, false);
918 assert_not_reached("Shouldn't be here");
927 return r
>= 0 ? r
: EXIT_FAILURE
;