X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=src%2Fjournal%2Fcoredumpctl.c;h=db0f3d67ccac47fa238dd9d12abaa34473849938;hb=a276ae74299fbdcf3321740c74fbf97501c63aad;hp=7cf6b4590be44110caf732db202a3724df4ba2c3;hpb=684341b073c4c5f7339e14ebc6a3e0df849e4eb7;p=elogind.git
diff --git a/src/journal/coredumpctl.c b/src/journal/coredumpctl.c
index 7cf6b4590..db0f3d67c 100644
--- a/src/journal/coredumpctl.c
+++ b/src/journal/coredumpctl.c
@@ -19,9 +19,12 @@
along with systemd; If not, see .
***/
+#include
#include
#include
#include
+#include
+#include
#include
@@ -31,17 +34,22 @@
#include "log.h"
#include "path-util.h"
#include "pager.h"
+#include "macro.h"
+#include "journal-internal.h"
+#include "copy.h"
static enum {
ACTION_NONE,
ACTION_LIST,
ACTION_DUMP,
+ ACTION_GDB,
} arg_action = ACTION_LIST;
-static Set *matches = NULL;
static FILE* output = NULL;
+static char* arg_field = NULL;
static int arg_no_pager = false;
+static int arg_no_legend = false;
static Set *new_matches(void) {
Set *set;
@@ -57,15 +65,14 @@ static Set *new_matches(void) {
tmp = strdup("MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1");
if (!tmp) {
log_oom();
- set_clear_free(set);
+ set_free(set);
return NULL;
}
- r = set_put(set, tmp);
+ r = set_consume(set, tmp);
if (r < 0) {
log_error("failed to add to set: %s", strerror(-r));
- free(tmp);
- set_clear_free(set);
+ set_free(set);
return NULL;
}
@@ -73,18 +80,21 @@ static Set *new_matches(void) {
}
static int help(void) {
- printf("%s [OPTIONS...] [MATCHES...]\n\n"
+
+ 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"
+ " -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"
- " list List available coredumps\n"
- " dump PID Print coredump to stdout\n"
- " dump PATH Print coredump to stdout\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"
+ " 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;
@@ -95,7 +105,7 @@ static int add_match(Set *set, const char *match) {
unsigned pid;
const char* prefix;
char *pattern = NULL;
- char _cleanup_free_ *p = NULL;
+ _cleanup_free_ char *p = NULL;
if (strchr(match, '='))
prefix = "";
@@ -116,57 +126,64 @@ static int add_match(Set *set, const char *match) {
if (!pattern)
goto fail;
+ log_debug("Adding pattern: %s", pattern);
r = set_put(set, pattern);
if (r < 0) {
- log_error("failed to add pattern '%s': %s",
+ log_error("Failed to add pattern '%s': %s",
pattern, strerror(-r));
+ free(pattern);
goto fail;
}
- log_debug("Added pattern: %s", pattern);
return 0;
fail:
- free(pattern);
- log_error("failed to add match: %s", strerror(-r));
+ log_error("Failed to add match: %s", strerror(-r));
return r;
}
-static int parse_argv(int argc, char *argv[]) {
+static int parse_argv(int argc, char *argv[], Set *matches) {
enum {
ARG_VERSION = 0x100,
ARG_NO_PAGER,
+ ARG_NO_LEGEND,
};
int r, c;
static const struct option options[] = {
- { "help", no_argument, NULL, 'h' },
- { "version" , no_argument, NULL, ARG_VERSION },
- { "no-pager", no_argument, NULL, ARG_NO_PAGER },
- { "output", required_argument, NULL, 'o' },
+ { "help", no_argument, NULL, 'h' },
+ { "version" , no_argument, NULL, ARG_VERSION },
+ { "no-pager", no_argument, NULL, ARG_NO_PAGER },
+ { "no-legend", no_argument, NULL, ARG_NO_LEGEND },
+ { "output", required_argument, NULL, 'o' },
+ { "field", required_argument, NULL, 'F' },
+ {}
};
assert(argc >= 0);
assert(argv);
- while ((c = getopt_long(argc, argv, "ho:", options, NULL)) >= 0)
+ while ((c = getopt_long(argc, argv, "ho:F:", options, NULL)) >= 0)
switch(c) {
+
case 'h':
- help();
arg_action = ACTION_NONE;
- return 0;
+ return help();
case ARG_VERSION:
+ arg_action = ACTION_NONE;
puts(PACKAGE_STRING);
- puts(DISTRIBUTION);
puts(SYSTEMD_FEATURES);
- arg_action = ACTION_NONE;
return 0;
case ARG_NO_PAGER:
arg_no_pager = true;
break;
+ case ARG_NO_LEGEND:
+ arg_no_legend = true;
+ break;
+
case 'o':
if (output) {
log_error("cannot set output more than once");
@@ -180,23 +197,42 @@ static int parse_argv(int argc, char *argv[]) {
}
break;
- default:
- log_error("Unknown option code %c", c);
+
+ case 'F':
+ if (arg_field) {
+ log_error("cannot use --field/-F more than once");
+ return -EINVAL;
+ }
+
+ arg_field = optarg;
+ break;
+
+ case '?':
return -EINVAL;
+
+ default:
+ assert_not_reached("Unhandled option");
}
if (optind < argc) {
const char *cmd = argv[optind++];
- if(streq(cmd, "list"))
+ if (streq(cmd, "list"))
arg_action = ACTION_LIST;
else if (streq(cmd, "dump"))
arg_action = ACTION_DUMP;
+ else if (streq(cmd, "gdb"))
+ arg_action = ACTION_GDB;
else {
log_error("Unknown action '%s'", cmd);
return -EINVAL;
}
}
+ if (arg_field && arg_action != ACTION_LIST) {
+ log_error("Option --field/-F only makes sense with list");
+ return -EINVAL;
+ }
+
while (optind < argc) {
r = add_match(matches, argv[optind]);
if (r != 0)
@@ -210,32 +246,50 @@ static int parse_argv(int argc, char *argv[]) {
static int retrieve(const void *data,
size_t len,
const char *name,
- const char **var) {
+ char **var) {
- size_t field;
+ size_t ident;
+ char *v;
- field = strlen(name) + 1; /* name + "=" */
+ ident = strlen(name) + 1; /* name + "=" */
- if (len < field)
+ if (len < ident)
return 0;
- if (memcmp(data, name, field - 1) != 0)
+ if (memcmp(data, name, ident - 1) != 0)
return 0;
- if (((const char*) data)[field - 1] != '=')
+ if (((const char*) data)[ident - 1] != '=')
return 0;
- *var = strndup((const char*)data + field, len - field);
- if (!var)
+ v = strndup((const char*)data + ident, len - ident);
+ if (!v)
return log_oom();
+ free(*var);
+ *var = v;
+
return 0;
}
-static int print_entry(FILE* file, sd_journal *j, int had_header) {
- const char _cleanup_free_
+static void print_field(FILE* file, sd_journal *j) {
+ _cleanup_free_ char *value = NULL;
+ const void *d;
+ size_t l;
+
+ assert(arg_field);
+
+ SD_JOURNAL_FOREACH_DATA(j, d, l)
+ retrieve(d, l, arg_field, &value);
+
+ if (value)
+ fprintf(file, "%s\n", value);
+}
+
+static int print_entry(FILE* file, sd_journal *j, int had_legend) {
+ _cleanup_free_ char
*pid = NULL, *uid = NULL, *gid = NULL,
- *sgnl = NULL, *exe = NULL;
+ *sgnl = NULL, *exe = NULL, *comm = NULL, *cmdline = NULL;
const void *d;
size_t l;
usec_t t;
@@ -243,19 +297,16 @@ static int print_entry(FILE* file, sd_journal *j, int had_header) {
int r;
SD_JOURNAL_FOREACH_DATA(j, d, l) {
- retrieve(d, l, "COREDUMP_PID", &pid);
retrieve(d, l, "COREDUMP_PID", &pid);
retrieve(d, l, "COREDUMP_UID", &uid);
retrieve(d, l, "COREDUMP_GID", &gid);
retrieve(d, l, "COREDUMP_SIGNAL", &sgnl);
retrieve(d, l, "COREDUMP_EXE", &exe);
- if (!exe)
- retrieve(d, l, "COREDUMP_COMM", &exe);
- if (!exe)
- retrieve(d, l, "COREDUMP_CMDLINE", &exe);
+ retrieve(d, l, "COREDUMP_COMM", &comm);
+ retrieve(d, l, "COREDUMP_CMDLINE", &cmdline);
}
- if (!pid && !uid && !gid && !sgnl && !exe) {
+ if (!pid && !uid && !gid && !sgnl && !exe && !comm && !cmdline) {
log_warning("Empty coredump log entry");
return -EINVAL;
}
@@ -268,7 +319,7 @@ static int print_entry(FILE* file, sd_journal *j, int had_header) {
format_timestamp(buf, sizeof(buf), t);
- if (!had_header)
+ if (!had_legend && !arg_no_legend)
fprintf(file, "%-*s %*s %*s %*s %*s %s\n",
FORMAT_TIMESTAMP_MAX-1, "TIME",
6, "PID",
@@ -279,11 +330,11 @@ static int print_entry(FILE* file, sd_journal *j, int had_header) {
fprintf(file, "%*s %*s %*s %*s %*s %s\n",
FORMAT_TIMESTAMP_MAX-1, buf,
- 6, pid,
- 5, uid,
- 5, gid,
- 3, sgnl,
- exe);
+ 6, strna(pid),
+ 5, strna(uid),
+ 5, strna(gid),
+ 3, strna(sgnl),
+ strna(exe ?: (comm ?: cmdline)));
return 0;
}
@@ -293,10 +344,19 @@ static int dump_list(sd_journal *j) {
assert(j);
- SD_JOURNAL_FOREACH(j)
- print_entry(stdout, j, found++);
+ /* 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);
- if (!found) {
+ SD_JOURNAL_FOREACH(j) {
+ if (arg_field)
+ print_field(stdout, j);
+ else
+ print_entry(stdout, j, found++);
+ }
+
+ if (!arg_field && !found) {
log_notice("No coredumps found");
return -ESRCH;
}
@@ -304,13 +364,9 @@ static int dump_list(sd_journal *j) {
return 0;
}
-static int dump_core(sd_journal* j) {
- const char *data;
- size_t len, ret;
+static int focus(sd_journal *j) {
int r;
- assert(j);
-
r = sd_journal_seek_tail(j);
if (r == 0)
r = sd_journal_previous(j);
@@ -318,18 +374,76 @@ static int dump_core(sd_journal* j) {
log_error("Failed to search journal: %s", strerror(-r));
return r;
}
-
if (r == 0) {
log_error("No match found");
return -ESRCH;
}
+ return r;
+}
+
+#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);
+ }
- r = sd_journal_get_data(j, "COREDUMP", (const void**) &data, &len);
- if (r != 0) {
- log_error("retrieve COREDUMP field: %s", strerror(-r));
- return r;
+ 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 int dump_core(sd_journal* j) {
+ const void *data;
+ size_t len, ret;
+ int r;
+
+ assert(j);
+
+ /* We want full data, nothing truncated. */
+ sd_journal_set_data_threshold(j, 0);
+
+ r = focus(j);
+ if (r < 0)
+ return r;
+
print_entry(output ? stdout : stderr, j, false);
if (on_tty() && !output) {
@@ -337,35 +451,200 @@ static int dump_core(sd_journal* j) {
return -ENOTTY;
}
- assert(len >= 9);
+ r = sd_journal_get_data(j, "COREDUMP", (const void**) &data, &len);
+ if (r == ENOENT) {
+ _cleanup_free_ char *fn = NULL;
+ _cleanup_close_ int fd = -1;
+
+ r = make_coredump_path(j, &fn);
+ if (r < 0)
+ return r;
- ret = fwrite(data+9, len-9, 1, output ? output : stdout);
- if (ret != 1) {
- log_error("dumping coredump: %m (%zu)", ret);
- return -errno;
+ 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.");
+ else
+ log_error("Failed to open coredump file: %s", strerror(-r));
+
+ return -errno;
+ }
+
+ r = copy_bytes(fd, output ? fileno(output) : STDOUT_FILENO);
+ if (r < 0) {
+ log_error("Failed to stream coredump: %s", strerror(-r));
+ return r;
+ }
+
+ } else if (r < 0) {
+ log_error("Failed to retrieve COREDUMP field: %s", strerror(-r));
+ 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;
+ }
}
r = sd_journal_previous(j);
if (r >= 0)
- log_warning("More than one entry matches, ignoring rest.\n");
+ log_warning("More than one entry matches, ignoring rest.");
return 0;
}
+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;
+ siginfo_t st;
+ size_t len;
+ pid_t pid;
+ int r;
+
+ assert(j);
+
+ sd_journal_set_data_threshold(j, 0);
+
+ r = focus(j);
+ if (r < 0)
+ return r;
+
+ print_entry(stdout, j, false);
+
+ r = sd_journal_get_data(j, "COREDUMP_EXE", (const void**) &data, &len);
+ if (r < 0) {
+ log_error("Failed to retrieve COREDUMP_EXE field: %s", strerror(-r));
+ return r;
+ }
+
+ assert(len >= 13);
+ data = (const uint8_t*) data + 13;
+ len -= 13;
+
+ exe = strndup(data, len);
+ if (!exe)
+ return log_oom();
+
+ if (endswith(exe, " (deleted)")) {
+ log_error("Binary already deleted.");
+ return -ENOENT;
+ }
+
+ if (!path_is_absolute(exe)) {
+ log_error("Binary is not an absolute path.");
+ 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));
+ 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();
+ if (pid < 0) {
+ log_error("Failed to fork(): %m");
+ r = -errno;
+ goto finish;
+ }
+ if (pid == 0) {
+ execlp("gdb", "gdb", exe, path, NULL);
+
+ log_error("Failed to invoke gdb: %m");
+ _exit(1);
+ }
+
+ r = wait_for_terminate(pid, &st);
+ if (r < 0) {
+ log_error("Failed to wait for gdb: %m");
+ goto finish;
+ }
+
+ r = st.si_code == CLD_EXITED ? st.si_status : 255;
+
+finish:
+ if (unlink_temp)
+ unlink(temp);
+
+ return r;
+}
+
int main(int argc, char *argv[]) {
- sd_journal *j = NULL;
+ _cleanup_journal_close_ sd_journal*j = NULL;
const char* match;
Iterator it;
int r = 0;
+ _cleanup_set_free_free_ Set *matches = NULL;
+ setlocale(LC_ALL, "");
log_parse_environment();
log_open();
matches = new_matches();
- if (!matches)
+ if (!matches) {
+ r = -ENOMEM;
goto end;
+ }
- if (parse_argv(argc, argv))
+ r = parse_argv(argc, argv, matches);
+ if (r < 0)
goto end;
if (arg_action == ACTION_NONE)
@@ -386,30 +665,39 @@ int main(int argc, char *argv[]) {
}
}
+ if (_unlikely_(log_get_max_level() >= LOG_PRI(LOG_DEBUG))) {
+ _cleanup_free_ char *filter;
+
+ filter = journal_make_match_string(j);
+ log_debug("Journal filter: %s", filter);
+ }
+
switch(arg_action) {
+
case ACTION_LIST:
if (!arg_no_pager)
- pager_open();
+ pager_open(false);
r = dump_list(j);
break;
+
case ACTION_DUMP:
r = dump_core(j);
break;
- case ACTION_NONE:
+
+ case ACTION_GDB:
+ r = run_gdb(j);
+ break;
+
+ default:
assert_not_reached("Shouldn't be here");
}
end:
- if (j)
- sd_journal_close(j);
-
- set_free_free(matches);
-
pager_close();
if (output)
fclose(output);
- return r == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
+ return r >= 0 ? r : EXIT_FAILURE;
}