X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=src%2Fjournal%2Fcoredumpctl.c;h=34dcae87c0c48b8e2395c2bec3d40358735e8961;hp=541dda022d9849da579d2e6b6f194386eeb91a6f;hb=48d4c7468fb5003ae45ac834de1ca85624cdd56e;hpb=31a020ced371fcf2a30c795c0f8ed1361e70904d diff --git a/src/journal/coredumpctl.c b/src/journal/coredumpctl.c index 541dda022..34dcae87c 100644 --- a/src/journal/coredumpctl.c +++ b/src/journal/coredumpctl.c @@ -26,7 +26,7 @@ #include #include -#include +#include "systemd/sd-journal.h" #include "build.h" #include "set.h" @@ -37,6 +37,7 @@ #include "macro.h" #include "journal-internal.h" #include "copy.h" +#include "compress.h" static enum { ACTION_NONE, @@ -80,29 +81,6 @@ static Set *new_matches(void) { return set; } -static int 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); - - return 0; -} - static int add_match(Set *set, const char *match) { int r = -ENOMEM; unsigned pid; @@ -130,11 +108,9 @@ static int add_match(Set *set, const char *match) { 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); + log_error("Failed to add pattern: %s", strerror(-r)); goto fail; } @@ -144,6 +120,26 @@ 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, @@ -171,7 +167,8 @@ static int parse_argv(int argc, char *argv[], Set *matches) { case 'h': arg_action = ACTION_NONE; - return help(); + help(); + return 0; case ARG_VERSION: arg_action = ACTION_NONE; @@ -280,55 +277,6 @@ static int retrieve(const void *data, 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; @@ -349,12 +297,14 @@ static void print_field(FILE* file, sd_journal *j) { 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); @@ -367,9 +317,10 @@ static int print_list(FILE* file, sd_journal *j, int had_legend) { 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; } @@ -381,22 +332,25 @@ static int print_list(FILE* file, sd_journal *j, int had_legend) { } 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", + 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", + 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; @@ -408,10 +362,11 @@ static int print_info(FILE *file, sd_journal *j, bool need_space) { *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, *message = 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); @@ -430,6 +385,8 @@ static int print_info(FILE *file, sd_journal *j, bool need_space) { 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); @@ -439,9 +396,14 @@ static int print_info(FILE *file, sd_journal *j, bool need_space) { 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; @@ -486,12 +448,26 @@ static int print_info(FILE *file, sd_journal *j, bool need_space) { 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) @@ -525,9 +501,8 @@ static int print_info(FILE *file, sd_journal *j, bool need_space) { 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); if (message) { _cleanup_free_ char *m = NULL; @@ -598,66 +573,140 @@ static int dump_list(sd_journal *j) { return 0; } -static int dump_core(sd_journal* j) { - const void *data; - size_t len, ret; +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(j); - - /* We want full data, nothing truncated. */ - sd_journal_set_data_threshold(j, 0); + assert((fd >= 0) != !!path); + assert(!!path == !!unlink_temp); - r = focus(j); - if (r < 0) - return r; - - print_info(output ? stdout : stderr, j, false); + /* 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 (on_tty() && !output) { - log_error("Refusing to dump core to tty."); - return -ENOTTY; + 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; } - r = sd_journal_get_data(j, "COREDUMP", (const void**) &data, &len); - if (r == ENOENT) { - _cleanup_free_ char *fn = NULL; - _cleanup_close_ int fd = -1; + if (filename && !endswith(filename, ".xz") && !endswith(filename, ".lz4")) { + if (path) { + *path = filename; + filename = NULL; + } - r = make_coredump_path(j, &fn); - if (r < 0) - return r; + 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); @@ -668,12 +717,9 @@ static int dump_core(sd_journal* 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; @@ -681,8 +727,6 @@ static int run_gdb(sd_journal *j) { assert(j); - sd_journal_set_data_threshold(j, 0); - r = focus(j); if (r < 0) return r; @@ -696,9 +740,9 @@ static int run_gdb(sd_journal *j) { 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) @@ -714,57 +758,10 @@ static int run_gdb(sd_journal *j) { 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 file: %m"); - - 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(); @@ -789,8 +786,10 @@ static int run_gdb(sd_journal *j) { 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; } @@ -825,6 +824,9 @@ int main(int argc, char *argv[]) { 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) {