#include <fcntl.h>
#include <unistd.h>
-#include <systemd/sd-journal.h>
+#include "systemd/sd-journal.h"
#include "build.h"
#include "set.h"
#include "macro.h"
#include "journal-internal.h"
#include "copy.h"
+#include "compress.h"
static enum {
ACTION_NONE,
ACTION_DUMP,
ACTION_GDB,
} arg_action = ACTION_LIST;
-
-static FILE* output = NULL;
static const char* arg_field = NULL;
-
static int arg_no_pager = false;
static int arg_no_legend = false;
+static int arg_one = false;
+
+static FILE* output = NULL;
static Set *new_matches(void) {
Set *set;
return set;
}
-static int help(void) {
-
- printf("%s [OPTIONS...]\n\n"
- "List or retrieve coredumps from the journal.\n\n"
- "Flags:\n"
- " -o --output=FILE Write output to FILE\n"
- " --no-pager Do not pipe output into a pager\n"
- " --no-legend Do not print the column headers.\n\n"
-
- "Commands:\n"
- " -h --help Show this help\n"
- " --version Print version string\n"
- " -F --field=FIELD List all values a certain field takes\n"
- " list [MATCHES...] List available coredumps\n"
- " info [MATCHES...] Show detailed information about one or more coredumps\n"
- " dump [MATCHES...] Print first matching coredump to stdout\n"
- " gdb [MATCHES...] Start gdb for the first matching coredump\n"
- , program_invocation_short_name);
-
- return 0;
-}
-
static int add_match(Set *set, const char *match) {
int r = -ENOMEM;
unsigned pid;
goto fail;
log_debug("Adding pattern: %s", pattern);
- r = set_put(set, pattern);
+ r = set_consume(set, pattern);
if (r < 0) {
log_error("Failed to add pattern '%s': %s",
pattern, strerror(-r));
- free(pattern);
goto fail;
}
return r;
}
+static void help(void) {
+ printf("%s [OPTIONS...]\n\n"
+ "List or retrieve coredumps from the journal.\n\n"
+ "Flags:\n"
+ " -h --help Show this help\n"
+ " --version Print version string\n"
+ " --no-pager Do not pipe output into a pager\n"
+ " --no-legend Do not print the column headers.\n"
+ " -1 Show information about most recent entry only\n"
+ " -F --field=FIELD List all values a certain field takes\n"
+ " -o --output=FILE Write output to FILE\n\n"
+
+ "Commands:\n"
+ " list [MATCHES...] List available coredumps (default)\n"
+ " info [MATCHES...] Show detailed information about one or more coredumps\n"
+ " dump [MATCHES...] Print first matching coredump to stdout\n"
+ " gdb [MATCHES...] Start gdb for the first matching coredump\n"
+ , program_invocation_short_name);
+}
+
static int parse_argv(int argc, char *argv[], Set *matches) {
enum {
ARG_VERSION = 0x100,
assert(argc >= 0);
assert(argv);
- while ((c = getopt_long(argc, argv, "ho:F:", options, NULL)) >= 0)
+ while ((c = getopt_long(argc, argv, "ho:F:1", options, NULL)) >= 0)
switch(c) {
case 'h':
arg_action = ACTION_NONE;
- return help();
+ help();
+ return 0;
case ARG_VERSION:
arg_action = ACTION_NONE;
arg_field = optarg;
break;
+ case '1':
+ arg_one = true;
+ break;
+
case '?':
return -EINVAL;
return 0;
}
-#define filename_escape(s) xescape((s), "./")
-
-static int make_coredump_path(sd_journal *j, char **ret) {
- _cleanup_free_ char
- *pid = NULL, *boot_id = NULL, *tstamp = NULL, *comm = NULL,
- *p = NULL, *b = NULL, *t = NULL, *c = NULL;
- const void *d;
- size_t l;
- char *fn;
-
- assert(j);
- assert(ret);
-
- SD_JOURNAL_FOREACH_DATA(j, d, l) {
- retrieve(d, l, "COREDUMP_COMM", &comm);
- retrieve(d, l, "COREDUMP_PID", &pid);
- retrieve(d, l, "COREDUMP_TIMESTAMP", &tstamp);
- retrieve(d, l, "_BOOT_ID", &boot_id);
- }
-
- if (!pid || !comm || !tstamp || !boot_id) {
- log_error("Failed to retrieve necessary fields to find coredump on disk.");
- return -ENOENT;
- }
-
- p = filename_escape(pid);
- if (!p)
- return log_oom();
-
- t = filename_escape(tstamp);
- if (!t)
- return log_oom();
-
- c = filename_escape(comm);
- if (!t)
- return log_oom();
-
- b = filename_escape(boot_id);
- if (!b)
- return log_oom();
-
- fn = strjoin("/var/lib/systemd/coredump/core.", c, ".", b, ".", p, ".", t, NULL);
- if (!fn)
- return log_oom();
-
- *ret = fn;
- return 0;
-}
-
static void print_field(FILE* file, sd_journal *j) {
_cleanup_free_ char *value = NULL;
const void *d;
static int print_list(FILE* file, sd_journal *j, int had_legend) {
_cleanup_free_ char
*pid = NULL, *uid = NULL, *gid = NULL,
- *sgnl = NULL, *exe = NULL, *comm = NULL, *cmdline = NULL;
+ *sgnl = NULL, *exe = NULL, *comm = NULL, *cmdline = NULL,
+ *filename = NULL;
const void *d;
size_t l;
usec_t t;
char buf[FORMAT_TIMESTAMP_MAX];
int r;
+ bool present;
assert(file);
assert(j);
retrieve(d, l, "COREDUMP_EXE", &exe);
retrieve(d, l, "COREDUMP_COMM", &comm);
retrieve(d, l, "COREDUMP_CMDLINE", &cmdline);
+ retrieve(d, l, "COREDUMP_FILENAME", &filename);
}
- if (!pid && !uid && !gid && !sgnl && !exe && !comm && !cmdline) {
+ if (!pid && !uid && !gid && !sgnl && !exe && !comm && !cmdline && !filename) {
log_warning("Empty coredump log entry");
return -EINVAL;
}
}
format_timestamp(buf, sizeof(buf), t);
+ present = filename && access(filename, F_OK) == 0;
if (!had_legend && !arg_no_legend)
- fprintf(file, "%-*s %*s %*s %*s %*s %s\n",
- FORMAT_TIMESTAMP_MAX-1, "TIME",
+ fprintf(file, "%-*s %*s %*s %*s %*s %*s %s\n",
+ FORMAT_TIMESTAMP_WIDTH, "TIME",
6, "PID",
5, "UID",
5, "GID",
3, "SIG",
+ 1, "PRESENT",
"EXE");
- fprintf(file, "%*s %*s %*s %*s %*s %s\n",
- FORMAT_TIMESTAMP_MAX-1, buf,
+ fprintf(file, "%-*s %*s %*s %*s %*s %*s %s\n",
+ FORMAT_TIMESTAMP_WIDTH, buf,
6, strna(pid),
5, strna(uid),
5, strna(gid),
3, strna(sgnl),
+ 1, present ? "*" : "",
strna(exe ?: (comm ?: cmdline)));
return 0;
*sgnl = NULL, *exe = NULL, *comm = NULL, *cmdline = NULL,
*unit = NULL, *user_unit = NULL, *session = NULL,
*boot_id = NULL, *machine_id = NULL, *hostname = NULL,
- *coredump = NULL, *slice = NULL, *cgroup = NULL, *owner_uid = NULL;
+ *slice = NULL, *cgroup = NULL, *owner_uid = NULL,
+ *message = NULL, *timestamp = NULL, *filename = NULL;
const void *d;
size_t l;
+ int r;
assert(file);
assert(j);
retrieve(d, l, "COREDUMP_OWNER_UID", &owner_uid);
retrieve(d, l, "COREDUMP_SLICE", &slice);
retrieve(d, l, "COREDUMP_CGROUP", &cgroup);
+ retrieve(d, l, "COREDUMP_TIMESTAMP", ×tamp);
+ retrieve(d, l, "COREDUMP_FILENAME", &filename);
retrieve(d, l, "_BOOT_ID", &boot_id);
retrieve(d, l, "_MACHINE_ID", &machine_id);
retrieve(d, l, "_HOSTNAME", &hostname);
+ retrieve(d, l, "MESSAGE", &message);
}
if (need_space)
fputs("\n", file);
- fprintf(file,
- " PID: %s%s%s\n",
- ansi_highlight(), strna(pid), ansi_highlight_off());
+ if (comm)
+ fprintf(file,
+ " PID: %s%s%s (%s)\n",
+ ansi_highlight(), strna(pid), ansi_highlight_off(), comm);
+ else
+ fprintf(file,
+ " PID: %s%s%s\n",
+ ansi_highlight(), strna(pid), ansi_highlight_off());
if (uid) {
uid_t n;
fprintf(file, " Signal: %s\n", sgnl);
}
- if (exe)
- fprintf(file, " Executable: %s%s%s\n", ansi_highlight(), exe, ansi_highlight_off());
- if (comm)
- fprintf(file, " Comm: %s\n", comm);
+ if (timestamp) {
+ usec_t u;
+
+ r = safe_atou64(timestamp, &u);
+ if (r >= 0) {
+ char absolute[FORMAT_TIMESTAMP_MAX], relative[FORMAT_TIMESPAN_MAX];
+
+ fprintf(file,
+ " Timestamp: %s (%s)\n",
+ format_timestamp(absolute, sizeof(absolute), u),
+ format_timestamp_relative(relative, sizeof(relative), u));
+
+ } else
+ fprintf(file, " Timestamp: %s\n", timestamp);
+ }
+
if (cmdline)
fprintf(file, " Command Line: %s\n", cmdline);
+ if (exe)
+ fprintf(file, " Executable: %s%s%s\n", ansi_highlight(), exe, ansi_highlight_off());
if (cgroup)
fprintf(file, " Control Group: %s\n", cgroup);
if (unit)
if (hostname)
fprintf(file, " Hostname: %s\n", hostname);
- if (make_coredump_path(j, &coredump) >= 0)
- if (access(coredump, F_OK) >= 0)
- fprintf(file, " Coredump: %s\n", coredump);
+ if (filename && access(filename, F_OK) == 0)
+ fprintf(file, " Coredump: %s\n", filename);
- return 0;
-}
-
-static int dump_list(sd_journal *j) {
- int found = 0;
+ if (message) {
+ _cleanup_free_ char *m = NULL;
- assert(j);
+ m = strreplace(message, "\n", "\n ");
- /* The coredumps are likely to compressed, and for just
- * listing them we don't need to decompress them, so let's
- * pick a fairly low data threshold here */
- sd_journal_set_data_threshold(j, 4096);
-
- SD_JOURNAL_FOREACH(j) {
- if (arg_action == ACTION_INFO)
- print_info(stdout, j, found++);
- else if (arg_field)
- print_field(stdout, j);
- else
- print_list(stdout, j, found++);
- }
-
- if (!arg_field && !found) {
- log_notice("No coredumps found");
- return -ESRCH;
+ fprintf(file, " Message: %s\n", strstrip(m ?: message));
}
return 0;
return r;
}
if (r == 0) {
- log_error("No match found");
+ log_error("No match found.");
return -ESRCH;
}
return r;
}
-static int dump_core(sd_journal* j) {
- const void *data;
- size_t len, ret;
+static void print_entry(sd_journal *j, unsigned n_found) {
+ assert(j);
+
+ if (arg_action == ACTION_INFO)
+ print_info(stdout, j, n_found);
+ else if (arg_field)
+ print_field(stdout, j);
+ else
+ print_list(stdout, j, n_found);
+}
+
+static int dump_list(sd_journal *j) {
+ unsigned n_found = 0;
int r;
assert(j);
- /* We want full data, nothing truncated. */
- sd_journal_set_data_threshold(j, 0);
+ /* The coredumps are likely to compressed, and for just
+ * listing them we don't need to decompress them, so let's
+ * pick a fairly low data threshold here */
+ sd_journal_set_data_threshold(j, 4096);
- r = focus(j);
- if (r < 0)
- return r;
+ if (arg_one) {
+ r = focus(j);
+ if (r < 0)
+ return r;
- print_info(output ? stdout : stderr, j, false);
+ print_entry(j, 0);
+ } else {
+ SD_JOURNAL_FOREACH(j)
+ print_entry(j, n_found++);
- if (on_tty() && !output) {
- log_error("Refusing to dump core to tty.");
- return -ENOTTY;
+ if (!arg_field && n_found <= 0) {
+ log_notice("No coredumps found.");
+ return -ESRCH;
+ }
}
- r = sd_journal_get_data(j, "COREDUMP", (const void**) &data, &len);
- if (r == ENOENT) {
- _cleanup_free_ char *fn = NULL;
- _cleanup_close_ int fd = -1;
+ return 0;
+}
- r = make_coredump_path(j, &fn);
- if (r < 0)
- return r;
+static int save_core(sd_journal *j, int fd, char **path, bool *unlink_temp) {
+ const char *data;
+ _cleanup_free_ char *filename = NULL;
+ size_t len;
+ int r;
+
+ assert((fd >= 0) != !!path);
+ assert(!!path == !!unlink_temp);
+
+ /* Prefer uncompressed file to journal (probably cached) to
+ * compressed file (probably uncached). */
+ r = sd_journal_get_data(j, "COREDUMP_FILENAME", (const void**) &data, &len);
+ if (r < 0 && r != -ENOENT)
+ log_warning("Failed to retrieve COREDUMP_FILENAME: %s", strerror(-r));
+ else if (r == 0)
+ retrieve(data, len, "COREDUMP_FILENAME", &filename);
+
+ if (filename && access(filename, R_OK) < 0) {
+ log_full(errno == ENOENT ? LOG_DEBUG : LOG_WARNING,
+ "File %s is not readable: %m", filename);
+ free(filename);
+ filename = NULL;
+ }
+
+ if (filename && !endswith(filename, ".xz") && !endswith(filename, ".lz4")) {
+ if (path) {
+ *path = filename;
+ filename = NULL;
+ }
+
+ return 0;
+ } else {
+ _cleanup_close_ int fdt = -1;
+ char *temp = NULL;
- fd = open(fn, O_RDONLY|O_CLOEXEC|O_NOCTTY);
if (fd < 0) {
- if (errno == ENOENT)
- log_error("Coredump neither in journal file nor stored externally on disk.");
+ temp = strdup("/var/tmp/coredump-XXXXXX");
+ if (!temp)
+ return log_oom();
+
+ fdt = mkostemp_safe(temp, O_WRONLY|O_CLOEXEC);
+ if (fdt < 0) {
+ log_error("Failed to create temporary file: %m");
+ return -errno;
+ }
+ log_debug("Created temporary file %s", temp);
+
+ fd = fdt;
+ }
+
+ r = sd_journal_get_data(j, "COREDUMP", (const void**) &data, &len);
+ if (r == 0) {
+ ssize_t sz;
+
+ assert(len >= 9);
+ data += 9;
+ len -= 9;
+
+ sz = write(fdt, data, len);
+ if (sz < 0) {
+ log_error("Failed to write temporary file: %m");
+ r = -errno;
+ goto error;
+ }
+ if (sz != (ssize_t) len) {
+ log_error("Short write to temporary file.");
+ r = -EIO;
+ goto error;
+ }
+ } else if (filename) {
+#if defined(HAVE_XZ) || defined(HAVE_LZ4)
+ _cleanup_close_ int fdf;
+
+ fdf = open(filename, O_RDONLY | O_CLOEXEC);
+ if (fdf < 0) {
+ log_error("Failed to open %s: %m", filename);
+ r = -errno;
+ goto error;
+ }
+
+ r = decompress_stream(filename, fdf, fd, -1);
+ if (r < 0) {
+ log_error("Failed to decompress %s: %s", filename, strerror(-r));
+ goto error;
+ }
+#else
+ log_error("Cannot decompress file. Compiled without compression support.");
+ r = -ENOTSUP;
+ goto error;
+#endif
+ } else {
+ if (r == -ENOENT)
+ log_error("Cannot retrieve coredump from journal nor disk.");
else
- log_error("Failed to open coredump file: %s", strerror(-r));
+ log_error("Failed to retrieve COREDUMP field: %s", strerror(-r));
+ goto error;
+ }
- return -errno;
+ if (temp) {
+ *path = temp;
+ *unlink_temp = true;
}
- r = copy_bytes(fd, output ? fileno(output) : STDOUT_FILENO);
- if (r < 0) {
- log_error("Failed to stream coredump: %s", strerror(-r));
- return r;
+ return 0;
+
+error:
+ if (temp) {
+ unlink(temp);
+ log_debug("Removed temporary file %s", temp);
}
+ return r;
+ }
+}
+
+static int dump_core(sd_journal* j) {
+ int r;
- } else if (r < 0) {
- log_error("Failed to retrieve COREDUMP field: %s", strerror(-r));
+ assert(j);
+
+ r = focus(j);
+ if (r < 0)
return r;
- } else {
- assert(len >= 9);
- data = (const uint8_t*) data + 9;
- len -= 9;
-
- ret = fwrite(data, len, 1, output ?: stdout);
- if (ret != 1) {
- log_error("Dumping coredump failed: %m (%zu)", ret);
- return -errno;
- }
+ print_info(output ? stdout : stderr, j, false);
+
+ if (on_tty() && !output) {
+ log_error("Refusing to dump core to tty.");
+ return -ENOTTY;
+ }
+
+ r = save_core(j, output ? fileno(output) : STDOUT_FILENO, NULL, NULL);
+ if (r < 0) {
+ log_error("Coredump retrieval failed: %s", strerror(-r));
+ return r;
}
r = sd_journal_previous(j);
}
static int run_gdb(sd_journal *j) {
-
- _cleanup_free_ char *exe = NULL, *coredump = NULL;
- char temp[] = "/var/tmp/coredump-XXXXXX";
- bool unlink_temp = false;
- const char *path;
- const void *data;
+ _cleanup_free_ char *exe = NULL, *path = NULL;
+ bool unlink_path = false;
+ const char *data;
siginfo_t st;
size_t len;
pid_t pid;
assert(j);
- sd_journal_set_data_threshold(j, 0);
-
r = focus(j);
if (r < 0)
return r;
return r;
}
- assert(len >= 13);
- data = (const uint8_t*) data + 13;
- len -= 13;
+ assert(len > strlen("COREDUMP_EXE="));
+ data += strlen("COREDUMP_EXE=");
+ len -= strlen("COREDUMP_EXE=");
exe = strndup(data, len);
if (!exe)
return -ENOENT;
}
- r = sd_journal_get_data(j, "COREDUMP", (const void**) &data, &len);
- if (r == -ENOENT) {
-
- r = make_coredump_path(j, &coredump);
- if (r < 0)
- return r;
-
- if (access(coredump, R_OK) < 0) {
- if (errno == ENOENT)
- log_error("Coredump neither in journal file nor stored externally on disk.");
- else
- log_error("Failed to access coredump fiile: %s", strerror(-r));
-
- return -errno;
- }
-
- path = coredump;
-
- } else if (r < 0) {
- log_error("Failed to retrieve COREDUMP field: %s", strerror(-r));
+ r = save_core(j, -1, &path, &unlink_path);
+ if (r < 0) {
+ log_error("Failed to retrieve core: %s", strerror(-r));
return r;
-
- } else {
- _cleanup_close_ int fd = -1;
- ssize_t sz;
-
- assert(len >= 9);
- data = (const uint8_t*) data + 9;
- len -= 9;
-
- fd = mkostemp_safe(temp, O_WRONLY|O_CLOEXEC);
- if (fd < 0) {
- log_error("Failed to create temporary file: %m");
- return -errno;
- }
-
- unlink_temp = true;
-
- sz = write(fd, data, len);
- if (sz < 0) {
- log_error("Failed to write temporary file: %m");
- r = -errno;
- goto finish;
- }
- if (sz != (ssize_t) len) {
- log_error("Short write to temporary file.");
- r = -EIO;
- goto finish;
- }
-
- path = temp;
}
pid = fork();
r = st.si_code == CLD_EXITED ? st.si_status : 255;
finish:
- if (unlink_temp)
- unlink(temp);
+ if (unlink_path) {
+ log_debug("Removed temporary file %s", path);
+ unlink(path);
+ }
return r;
}
goto end;
}
+ /* We want full data, nothing truncated. */
+ sd_journal_set_data_threshold(j, 0);
+
SET_FOREACH(match, matches, it) {
r = sd_journal_add_match(j, match, strlen(match));
if (r != 0) {