]>
Commit | Line | Data |
---|---|---|
1 | /* SPDX-License-Identifier: LGPL-2.1+ */ | |
2 | ||
3 | #include <fcntl.h> | |
4 | #include <getopt.h> | |
5 | #include <locale.h> | |
6 | #include <stdio.h> | |
7 | #include <string.h> | |
8 | #include <unistd.h> | |
9 | ||
10 | #include "sd-bus.h" | |
11 | #include "sd-journal.h" | |
12 | #include "sd-messages.h" | |
13 | ||
14 | #include "alloc-util.h" | |
15 | #include "bus-error.h" | |
16 | #include "bus-util.h" | |
17 | #include "compress.h" | |
18 | #include "def.h" | |
19 | #include "fd-util.h" | |
20 | #include "fs-util.h" | |
21 | #include "journal-internal.h" | |
22 | #include "journal-util.h" | |
23 | #include "log.h" | |
24 | #include "macro.h" | |
25 | #include "main-func.h" | |
26 | #include "pager.h" | |
27 | #include "parse-util.h" | |
28 | #include "path-util.h" | |
29 | #include "pretty-print.h" | |
30 | #include "process-util.h" | |
31 | #include "rlimit-util.h" | |
32 | #include "sigbus.h" | |
33 | #include "signal-util.h" | |
34 | #include "string-util.h" | |
35 | #include "strv.h" | |
36 | #include "terminal-util.h" | |
37 | #include "tmpfile-util.h" | |
38 | #include "user-util.h" | |
39 | #include "util.h" | |
40 | #include "verbs.h" | |
41 | ||
42 | #define SHORT_BUS_CALL_TIMEOUT_USEC (3 * USEC_PER_SEC) | |
43 | ||
44 | static usec_t arg_since = USEC_INFINITY, arg_until = USEC_INFINITY; | |
45 | static const char* arg_field = NULL; | |
46 | static const char *arg_debugger = NULL; | |
47 | static const char *arg_directory = NULL; | |
48 | static PagerFlags arg_pager_flags = 0; | |
49 | static int arg_no_legend = false; | |
50 | static int arg_one = false; | |
51 | static const char* arg_output = NULL; | |
52 | static bool arg_reverse = false; | |
53 | static bool arg_quiet = false; | |
54 | ||
55 | static int add_match(sd_journal *j, const char *match) { | |
56 | _cleanup_free_ char *p = NULL; | |
57 | const char* prefix, *pattern; | |
58 | pid_t pid; | |
59 | int r; | |
60 | ||
61 | if (strchr(match, '=')) | |
62 | prefix = ""; | |
63 | else if (strchr(match, '/')) { | |
64 | r = path_make_absolute_cwd(match, &p); | |
65 | if (r < 0) | |
66 | return log_error_errno(r, "path_make_absolute_cwd(\"%s\"): %m", match); | |
67 | ||
68 | match = p; | |
69 | prefix = "COREDUMP_EXE="; | |
70 | } else if (parse_pid(match, &pid) >= 0) | |
71 | prefix = "COREDUMP_PID="; | |
72 | else | |
73 | prefix = "COREDUMP_COMM="; | |
74 | ||
75 | pattern = strjoina(prefix, match); | |
76 | log_debug("Adding match: %s", pattern); | |
77 | r = sd_journal_add_match(j, pattern, 0); | |
78 | if (r < 0) | |
79 | return log_error_errno(r, "Failed to add match \"%s\": %m", match); | |
80 | ||
81 | return 0; | |
82 | } | |
83 | ||
84 | static int add_matches(sd_journal *j, char **matches) { | |
85 | char **match; | |
86 | int r; | |
87 | ||
88 | r = sd_journal_add_match(j, "MESSAGE_ID=" SD_MESSAGE_COREDUMP_STR, 0); | |
89 | if (r < 0) | |
90 | return log_error_errno(r, "Failed to add match \"%s\": %m", "MESSAGE_ID=" SD_MESSAGE_COREDUMP_STR); | |
91 | ||
92 | r = sd_journal_add_match(j, "MESSAGE_ID=" SD_MESSAGE_BACKTRACE_STR, 0); | |
93 | if (r < 0) | |
94 | return log_error_errno(r, "Failed to add match \"%s\": %m", "MESSAGE_ID=" SD_MESSAGE_BACKTRACE_STR); | |
95 | ||
96 | STRV_FOREACH(match, matches) { | |
97 | r = add_match(j, *match); | |
98 | if (r < 0) | |
99 | return r; | |
100 | } | |
101 | ||
102 | return 0; | |
103 | } | |
104 | ||
105 | static int acquire_journal(sd_journal **ret, char **matches) { | |
106 | _cleanup_(sd_journal_closep) sd_journal *j = NULL; | |
107 | int r; | |
108 | ||
109 | assert(ret); | |
110 | ||
111 | if (arg_directory) { | |
112 | r = sd_journal_open_directory(&j, arg_directory, 0); | |
113 | if (r < 0) | |
114 | return log_error_errno(r, "Failed to open journals in directory: %s: %m", arg_directory); | |
115 | } else { | |
116 | r = sd_journal_open(&j, SD_JOURNAL_LOCAL_ONLY); | |
117 | if (r < 0) | |
118 | return log_error_errno(r, "Failed to open journal: %m"); | |
119 | } | |
120 | ||
121 | r = journal_access_check_and_warn(j, arg_quiet, true); | |
122 | if (r < 0) | |
123 | return r; | |
124 | ||
125 | r = add_matches(j, matches); | |
126 | if (r < 0) | |
127 | return r; | |
128 | ||
129 | if (DEBUG_LOGGING) { | |
130 | _cleanup_free_ char *filter; | |
131 | ||
132 | filter = journal_make_match_string(j); | |
133 | log_debug("Journal filter: %s", filter); | |
134 | } | |
135 | ||
136 | *ret = TAKE_PTR(j); | |
137 | ||
138 | return 0; | |
139 | } | |
140 | ||
141 | static int help(void) { | |
142 | _cleanup_free_ char *link = NULL; | |
143 | int r; | |
144 | ||
145 | r = terminal_urlify_man("coredumpctl", "1", &link); | |
146 | if (r < 0) | |
147 | return log_oom(); | |
148 | ||
149 | printf("%s [OPTIONS...]\n\n" | |
150 | "List or retrieve coredumps from the journal.\n\n" | |
151 | "Flags:\n" | |
152 | " -h --help Show this help\n" | |
153 | " --version Print version string\n" | |
154 | " --no-pager Do not pipe output into a pager\n" | |
155 | " --no-legend Do not print the column headers\n" | |
156 | " --debugger=DEBUGGER Use the given debugger\n" | |
157 | " -1 Show information about most recent entry only\n" | |
158 | " -S --since=DATE Only print coredumps since the date\n" | |
159 | " -U --until=DATE Only print coredumps until the date\n" | |
160 | " -r --reverse Show the newest entries first\n" | |
161 | " -F --field=FIELD List all values a certain field takes\n" | |
162 | " -o --output=FILE Write output to FILE\n" | |
163 | " -D --directory=DIR Use journal files from directory\n\n" | |
164 | " -q --quiet Do not show info messages and privilege warning\n" | |
165 | "Commands:\n" | |
166 | " list [MATCHES...] List available coredumps (default)\n" | |
167 | " info [MATCHES...] Show detailed information about one or more coredumps\n" | |
168 | " dump [MATCHES...] Print first matching coredump to stdout\n" | |
169 | " debug [MATCHES...] Start a debugger for the first matching coredump\n" | |
170 | "\nSee the %s for details.\n" | |
171 | , program_invocation_short_name | |
172 | , link | |
173 | ); | |
174 | ||
175 | return 0; | |
176 | } | |
177 | ||
178 | static int parse_argv(int argc, char *argv[]) { | |
179 | enum { | |
180 | ARG_VERSION = 0x100, | |
181 | ARG_NO_PAGER, | |
182 | ARG_NO_LEGEND, | |
183 | ARG_DEBUGGER, | |
184 | }; | |
185 | ||
186 | int c, r; | |
187 | ||
188 | static const struct option options[] = { | |
189 | { "help", no_argument, NULL, 'h' }, | |
190 | { "version" , no_argument, NULL, ARG_VERSION }, | |
191 | { "no-pager", no_argument, NULL, ARG_NO_PAGER }, | |
192 | { "no-legend", no_argument, NULL, ARG_NO_LEGEND }, | |
193 | { "debugger", required_argument, NULL, ARG_DEBUGGER }, | |
194 | { "output", required_argument, NULL, 'o' }, | |
195 | { "field", required_argument, NULL, 'F' }, | |
196 | { "directory", required_argument, NULL, 'D' }, | |
197 | { "reverse", no_argument, NULL, 'r' }, | |
198 | { "since", required_argument, NULL, 'S' }, | |
199 | { "until", required_argument, NULL, 'U' }, | |
200 | { "quiet", no_argument, NULL, 'q' }, | |
201 | {} | |
202 | }; | |
203 | ||
204 | assert(argc >= 0); | |
205 | assert(argv); | |
206 | ||
207 | while ((c = getopt_long(argc, argv, "ho:F:1D:rS:U:q", options, NULL)) >= 0) | |
208 | switch(c) { | |
209 | case 'h': | |
210 | return help(); | |
211 | ||
212 | case ARG_VERSION: | |
213 | return version(); | |
214 | ||
215 | case ARG_NO_PAGER: | |
216 | arg_pager_flags |= PAGER_DISABLE; | |
217 | break; | |
218 | ||
219 | case ARG_NO_LEGEND: | |
220 | arg_no_legend = true; | |
221 | break; | |
222 | ||
223 | case ARG_DEBUGGER: | |
224 | arg_debugger = optarg; | |
225 | break; | |
226 | ||
227 | case 'o': | |
228 | if (arg_output) | |
229 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), | |
230 | "Cannot set output more than once."); | |
231 | ||
232 | arg_output = optarg; | |
233 | break; | |
234 | ||
235 | case 'S': | |
236 | r = parse_timestamp(optarg, &arg_since); | |
237 | if (r < 0) | |
238 | return log_error_errno(r, "Failed to parse timestamp '%s': %m", optarg); | |
239 | break; | |
240 | ||
241 | case 'U': | |
242 | r = parse_timestamp(optarg, &arg_until); | |
243 | if (r < 0) | |
244 | return log_error_errno(r, "Failed to parse timestamp '%s': %m", optarg); | |
245 | break; | |
246 | ||
247 | case 'F': | |
248 | if (arg_field) | |
249 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), | |
250 | "Cannot use --field/-F more than once."); | |
251 | arg_field = optarg; | |
252 | break; | |
253 | ||
254 | case '1': | |
255 | arg_one = true; | |
256 | break; | |
257 | ||
258 | case 'D': | |
259 | arg_directory = optarg; | |
260 | break; | |
261 | ||
262 | case 'r': | |
263 | arg_reverse = true; | |
264 | break; | |
265 | ||
266 | case 'q': | |
267 | arg_quiet = true; | |
268 | break; | |
269 | ||
270 | case '?': | |
271 | return -EINVAL; | |
272 | ||
273 | default: | |
274 | assert_not_reached("Unhandled option"); | |
275 | } | |
276 | ||
277 | if (arg_since != USEC_INFINITY && arg_until != USEC_INFINITY && | |
278 | arg_since > arg_until) | |
279 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), | |
280 | "--since= must be before --until=."); | |
281 | ||
282 | return 1; | |
283 | } | |
284 | ||
285 | static int retrieve(const void *data, | |
286 | size_t len, | |
287 | const char *name, | |
288 | char **var) { | |
289 | ||
290 | size_t ident; | |
291 | char *v; | |
292 | ||
293 | ident = strlen(name) + 1; /* name + "=" */ | |
294 | ||
295 | if (len < ident) | |
296 | return 0; | |
297 | ||
298 | if (memcmp(data, name, ident - 1) != 0) | |
299 | return 0; | |
300 | ||
301 | if (((const char*) data)[ident - 1] != '=') | |
302 | return 0; | |
303 | ||
304 | v = strndup((const char*)data + ident, len - ident); | |
305 | if (!v) | |
306 | return log_oom(); | |
307 | ||
308 | free(*var); | |
309 | *var = v; | |
310 | ||
311 | return 1; | |
312 | } | |
313 | ||
314 | static int print_field(FILE* file, sd_journal *j) { | |
315 | const void *d; | |
316 | size_t l; | |
317 | ||
318 | assert(file); | |
319 | assert(j); | |
320 | ||
321 | assert(arg_field); | |
322 | ||
323 | /* A (user-specified) field may appear more than once for a given entry. | |
324 | * We will print all of the occurrences. | |
325 | * This is different below for fields that systemd-coredump uses, | |
326 | * because they cannot meaningfully appear more than once. | |
327 | */ | |
328 | SD_JOURNAL_FOREACH_DATA(j, d, l) { | |
329 | _cleanup_free_ char *value = NULL; | |
330 | int r; | |
331 | ||
332 | r = retrieve(d, l, arg_field, &value); | |
333 | if (r < 0) | |
334 | return r; | |
335 | if (r > 0) | |
336 | fprintf(file, "%s\n", value); | |
337 | } | |
338 | ||
339 | return 0; | |
340 | } | |
341 | ||
342 | #define RETRIEVE(d, l, name, arg) \ | |
343 | { \ | |
344 | int _r = retrieve(d, l, name, &arg); \ | |
345 | if (_r < 0) \ | |
346 | return _r; \ | |
347 | if (_r > 0) \ | |
348 | continue; \ | |
349 | } | |
350 | ||
351 | static int print_list(FILE* file, sd_journal *j, int had_legend) { | |
352 | _cleanup_free_ char | |
353 | *mid = NULL, *pid = NULL, *uid = NULL, *gid = NULL, | |
354 | *sgnl = NULL, *exe = NULL, *comm = NULL, *cmdline = NULL, | |
355 | *filename = NULL, *truncated = NULL, *coredump = NULL; | |
356 | const void *d; | |
357 | size_t l; | |
358 | usec_t t; | |
359 | char buf[FORMAT_TIMESTAMP_MAX]; | |
360 | int r; | |
361 | const char *present; | |
362 | bool normal_coredump; | |
363 | ||
364 | assert(file); | |
365 | assert(j); | |
366 | ||
367 | SD_JOURNAL_FOREACH_DATA(j, d, l) { | |
368 | RETRIEVE(d, l, "MESSAGE_ID", mid); | |
369 | RETRIEVE(d, l, "COREDUMP_PID", pid); | |
370 | RETRIEVE(d, l, "COREDUMP_UID", uid); | |
371 | RETRIEVE(d, l, "COREDUMP_GID", gid); | |
372 | RETRIEVE(d, l, "COREDUMP_SIGNAL", sgnl); | |
373 | RETRIEVE(d, l, "COREDUMP_EXE", exe); | |
374 | RETRIEVE(d, l, "COREDUMP_COMM", comm); | |
375 | RETRIEVE(d, l, "COREDUMP_CMDLINE", cmdline); | |
376 | RETRIEVE(d, l, "COREDUMP_FILENAME", filename); | |
377 | RETRIEVE(d, l, "COREDUMP_TRUNCATED", truncated); | |
378 | RETRIEVE(d, l, "COREDUMP", coredump); | |
379 | } | |
380 | ||
381 | if (!pid && !uid && !gid && !sgnl && !exe && !comm && !cmdline && !filename) { | |
382 | log_warning("Empty coredump log entry"); | |
383 | return -EINVAL; | |
384 | } | |
385 | ||
386 | r = sd_journal_get_realtime_usec(j, &t); | |
387 | if (r < 0) | |
388 | return log_error_errno(r, "Failed to get realtime timestamp: %m"); | |
389 | ||
390 | format_timestamp(buf, sizeof(buf), t); | |
391 | ||
392 | if (!had_legend && !arg_no_legend) | |
393 | fprintf(file, "%-*s %*s %*s %*s %*s %-*s %s\n", | |
394 | FORMAT_TIMESTAMP_WIDTH, "TIME", | |
395 | 6, "PID", | |
396 | 5, "UID", | |
397 | 5, "GID", | |
398 | 3, "SIG", | |
399 | 9, "COREFILE", | |
400 | "EXE"); | |
401 | ||
402 | normal_coredump = streq_ptr(mid, SD_MESSAGE_COREDUMP_STR); | |
403 | ||
404 | if (filename) | |
405 | if (access(filename, R_OK) == 0) | |
406 | present = "present"; | |
407 | else if (errno == ENOENT) | |
408 | present = "missing"; | |
409 | else | |
410 | present = "error"; | |
411 | else if (coredump) | |
412 | present = "journal"; | |
413 | else if (normal_coredump) | |
414 | present = "none"; | |
415 | else | |
416 | present = "-"; | |
417 | ||
418 | if (STR_IN_SET(present, "present", "journal") && truncated && parse_boolean(truncated) > 0) | |
419 | present = "truncated"; | |
420 | ||
421 | fprintf(file, "%-*s %*s %*s %*s %*s %-*s %s\n", | |
422 | FORMAT_TIMESTAMP_WIDTH, buf, | |
423 | 6, strna(pid), | |
424 | 5, strna(uid), | |
425 | 5, strna(gid), | |
426 | 3, normal_coredump ? strna(sgnl) : "-", | |
427 | 9, present, | |
428 | strna(exe ?: (comm ?: cmdline))); | |
429 | ||
430 | return 0; | |
431 | } | |
432 | ||
433 | static int print_info(FILE *file, sd_journal *j, bool need_space) { | |
434 | _cleanup_free_ char | |
435 | *mid = NULL, *pid = NULL, *uid = NULL, *gid = NULL, | |
436 | *sgnl = NULL, *exe = NULL, *comm = NULL, *cmdline = NULL, | |
437 | *unit = NULL, *user_unit = NULL, *session = NULL, | |
438 | *boot_id = NULL, *machine_id = NULL, *hostname = NULL, | |
439 | *slice = NULL, *cgroup = NULL, *owner_uid = NULL, | |
440 | *message = NULL, *timestamp = NULL, *filename = NULL, | |
441 | *truncated = NULL, *coredump = NULL; | |
442 | const void *d; | |
443 | size_t l; | |
444 | bool normal_coredump; | |
445 | int r; | |
446 | ||
447 | assert(file); | |
448 | assert(j); | |
449 | ||
450 | SD_JOURNAL_FOREACH_DATA(j, d, l) { | |
451 | RETRIEVE(d, l, "MESSAGE_ID", mid); | |
452 | RETRIEVE(d, l, "COREDUMP_PID", pid); | |
453 | RETRIEVE(d, l, "COREDUMP_UID", uid); | |
454 | RETRIEVE(d, l, "COREDUMP_GID", gid); | |
455 | RETRIEVE(d, l, "COREDUMP_SIGNAL", sgnl); | |
456 | RETRIEVE(d, l, "COREDUMP_EXE", exe); | |
457 | RETRIEVE(d, l, "COREDUMP_COMM", comm); | |
458 | RETRIEVE(d, l, "COREDUMP_CMDLINE", cmdline); | |
459 | RETRIEVE(d, l, "COREDUMP_UNIT", unit); | |
460 | RETRIEVE(d, l, "COREDUMP_USER_UNIT", user_unit); | |
461 | RETRIEVE(d, l, "COREDUMP_SESSION", session); | |
462 | RETRIEVE(d, l, "COREDUMP_OWNER_UID", owner_uid); | |
463 | RETRIEVE(d, l, "COREDUMP_SLICE", slice); | |
464 | RETRIEVE(d, l, "COREDUMP_CGROUP", cgroup); | |
465 | RETRIEVE(d, l, "COREDUMP_TIMESTAMP", timestamp); | |
466 | RETRIEVE(d, l, "COREDUMP_FILENAME", filename); | |
467 | RETRIEVE(d, l, "COREDUMP_TRUNCATED", truncated); | |
468 | RETRIEVE(d, l, "COREDUMP", coredump); | |
469 | RETRIEVE(d, l, "_BOOT_ID", boot_id); | |
470 | RETRIEVE(d, l, "_MACHINE_ID", machine_id); | |
471 | RETRIEVE(d, l, "_HOSTNAME", hostname); | |
472 | RETRIEVE(d, l, "MESSAGE", message); | |
473 | } | |
474 | ||
475 | if (need_space) | |
476 | fputs("\n", file); | |
477 | ||
478 | normal_coredump = streq_ptr(mid, SD_MESSAGE_COREDUMP_STR); | |
479 | ||
480 | if (comm) | |
481 | fprintf(file, | |
482 | " PID: %s%s%s (%s)\n", | |
483 | ansi_highlight(), strna(pid), ansi_normal(), comm); | |
484 | else | |
485 | fprintf(file, | |
486 | " PID: %s%s%s\n", | |
487 | ansi_highlight(), strna(pid), ansi_normal()); | |
488 | ||
489 | if (uid) { | |
490 | uid_t n; | |
491 | ||
492 | if (parse_uid(uid, &n) >= 0) { | |
493 | _cleanup_free_ char *u = NULL; | |
494 | ||
495 | u = uid_to_name(n); | |
496 | fprintf(file, | |
497 | " UID: %s (%s)\n", | |
498 | uid, u); | |
499 | } else { | |
500 | fprintf(file, | |
501 | " UID: %s\n", | |
502 | uid); | |
503 | } | |
504 | } | |
505 | ||
506 | if (gid) { | |
507 | gid_t n; | |
508 | ||
509 | if (parse_gid(gid, &n) >= 0) { | |
510 | _cleanup_free_ char *g = NULL; | |
511 | ||
512 | g = gid_to_name(n); | |
513 | fprintf(file, | |
514 | " GID: %s (%s)\n", | |
515 | gid, g); | |
516 | } else { | |
517 | fprintf(file, | |
518 | " GID: %s\n", | |
519 | gid); | |
520 | } | |
521 | } | |
522 | ||
523 | if (sgnl) { | |
524 | int sig; | |
525 | const char *name = normal_coredump ? "Signal" : "Reason"; | |
526 | ||
527 | if (normal_coredump && safe_atoi(sgnl, &sig) >= 0) | |
528 | fprintf(file, " %s: %s (%s)\n", name, sgnl, signal_to_string(sig)); | |
529 | else | |
530 | fprintf(file, " %s: %s\n", name, sgnl); | |
531 | } | |
532 | ||
533 | if (timestamp) { | |
534 | usec_t u; | |
535 | ||
536 | r = safe_atou64(timestamp, &u); | |
537 | if (r >= 0) { | |
538 | char absolute[FORMAT_TIMESTAMP_MAX], relative[FORMAT_TIMESPAN_MAX]; | |
539 | ||
540 | fprintf(file, | |
541 | " Timestamp: %s (%s)\n", | |
542 | format_timestamp(absolute, sizeof(absolute), u), | |
543 | format_timestamp_relative(relative, sizeof(relative), u)); | |
544 | ||
545 | } else | |
546 | fprintf(file, " Timestamp: %s\n", timestamp); | |
547 | } | |
548 | ||
549 | if (cmdline) | |
550 | fprintf(file, " Command Line: %s\n", cmdline); | |
551 | if (exe) | |
552 | fprintf(file, " Executable: %s%s%s\n", ansi_highlight(), exe, ansi_normal()); | |
553 | if (cgroup) | |
554 | fprintf(file, " Control Group: %s\n", cgroup); | |
555 | if (unit) | |
556 | fprintf(file, " Unit: %s\n", unit); | |
557 | if (user_unit) | |
558 | fprintf(file, " User Unit: %s\n", user_unit); | |
559 | if (slice) | |
560 | fprintf(file, " Slice: %s\n", slice); | |
561 | if (session) | |
562 | fprintf(file, " Session: %s\n", session); | |
563 | if (owner_uid) { | |
564 | uid_t n; | |
565 | ||
566 | if (parse_uid(owner_uid, &n) >= 0) { | |
567 | _cleanup_free_ char *u = NULL; | |
568 | ||
569 | u = uid_to_name(n); | |
570 | fprintf(file, | |
571 | " Owner UID: %s (%s)\n", | |
572 | owner_uid, u); | |
573 | } else { | |
574 | fprintf(file, | |
575 | " Owner UID: %s\n", | |
576 | owner_uid); | |
577 | } | |
578 | } | |
579 | if (boot_id) | |
580 | fprintf(file, " Boot ID: %s\n", boot_id); | |
581 | if (machine_id) | |
582 | fprintf(file, " Machine ID: %s\n", machine_id); | |
583 | if (hostname) | |
584 | fprintf(file, " Hostname: %s\n", hostname); | |
585 | ||
586 | if (filename) { | |
587 | bool inacc, trunc; | |
588 | ||
589 | inacc = access(filename, R_OK) < 0; | |
590 | trunc = truncated && parse_boolean(truncated) > 0; | |
591 | ||
592 | if (inacc || trunc) | |
593 | fprintf(file, " Storage: %s%s (%s%s%s)%s\n", | |
594 | ansi_highlight_red(), | |
595 | filename, | |
596 | inacc ? "inaccessible" : "", | |
597 | inacc && trunc ? ", " : "", | |
598 | trunc ? "truncated" : "", | |
599 | ansi_normal()); | |
600 | else | |
601 | fprintf(file, " Storage: %s\n", filename); | |
602 | } | |
603 | ||
604 | else if (coredump) | |
605 | fprintf(file, " Storage: journal\n"); | |
606 | else | |
607 | fprintf(file, " Storage: none\n"); | |
608 | ||
609 | if (message) { | |
610 | _cleanup_free_ char *m = NULL; | |
611 | ||
612 | m = strreplace(message, "\n", "\n "); | |
613 | ||
614 | fprintf(file, " Message: %s\n", strstrip(m ?: message)); | |
615 | } | |
616 | ||
617 | return 0; | |
618 | } | |
619 | ||
620 | static int focus(sd_journal *j) { | |
621 | int r; | |
622 | ||
623 | r = sd_journal_seek_tail(j); | |
624 | if (r == 0) | |
625 | r = sd_journal_previous(j); | |
626 | if (r < 0) | |
627 | return log_error_errno(r, "Failed to search journal: %m"); | |
628 | if (r == 0) | |
629 | return log_error_errno(SYNTHETIC_ERRNO(ESRCH), | |
630 | "No match found."); | |
631 | return r; | |
632 | } | |
633 | ||
634 | static int print_entry(sd_journal *j, unsigned n_found, bool verb_is_info) { | |
635 | assert(j); | |
636 | ||
637 | if (verb_is_info) | |
638 | return print_info(stdout, j, n_found); | |
639 | else if (arg_field) | |
640 | return print_field(stdout, j); | |
641 | else | |
642 | return print_list(stdout, j, n_found); | |
643 | } | |
644 | ||
645 | static int dump_list(int argc, char **argv, void *userdata) { | |
646 | _cleanup_(sd_journal_closep) sd_journal *j = NULL; | |
647 | unsigned n_found = 0; | |
648 | bool verb_is_info; | |
649 | int r; | |
650 | ||
651 | verb_is_info = (argc >= 1 && streq(argv[0], "info")); | |
652 | ||
653 | r = acquire_journal(&j, argv + 1); | |
654 | if (r < 0) | |
655 | return r; | |
656 | ||
657 | (void) pager_open(arg_pager_flags); | |
658 | ||
659 | /* The coredumps are likely to compressed, and for just | |
660 | * listing them we don't need to decompress them, so let's | |
661 | * pick a fairly low data threshold here */ | |
662 | sd_journal_set_data_threshold(j, 4096); | |
663 | ||
664 | /* "info" without pattern implies "-1" */ | |
665 | if (arg_one || (verb_is_info && argc == 1)) { | |
666 | r = focus(j); | |
667 | if (r < 0) | |
668 | return r; | |
669 | ||
670 | return print_entry(j, 0, verb_is_info); | |
671 | } else { | |
672 | if (arg_since != USEC_INFINITY && !arg_reverse) | |
673 | r = sd_journal_seek_realtime_usec(j, arg_since); | |
674 | else if (arg_until != USEC_INFINITY && arg_reverse) | |
675 | r = sd_journal_seek_realtime_usec(j, arg_until); | |
676 | else if (arg_reverse) | |
677 | r = sd_journal_seek_tail(j); | |
678 | else | |
679 | r = sd_journal_seek_head(j); | |
680 | if (r < 0) | |
681 | return log_error_errno(r, "Failed to seek to date: %m"); | |
682 | ||
683 | for (;;) { | |
684 | if (!arg_reverse) | |
685 | r = sd_journal_next(j); | |
686 | else | |
687 | r = sd_journal_previous(j); | |
688 | ||
689 | if (r < 0) | |
690 | return log_error_errno(r, "Failed to iterate through journal: %m"); | |
691 | ||
692 | if (r == 0) | |
693 | break; | |
694 | ||
695 | if (arg_until != USEC_INFINITY && !arg_reverse) { | |
696 | usec_t usec; | |
697 | ||
698 | r = sd_journal_get_realtime_usec(j, &usec); | |
699 | if (r < 0) | |
700 | return log_error_errno(r, "Failed to determine timestamp: %m"); | |
701 | if (usec > arg_until) | |
702 | continue; | |
703 | } | |
704 | ||
705 | if (arg_since != USEC_INFINITY && arg_reverse) { | |
706 | usec_t usec; | |
707 | ||
708 | r = sd_journal_get_realtime_usec(j, &usec); | |
709 | if (r < 0) | |
710 | return log_error_errno(r, "Failed to determine timestamp: %m"); | |
711 | if (usec < arg_since) | |
712 | continue; | |
713 | } | |
714 | ||
715 | r = print_entry(j, n_found++, verb_is_info); | |
716 | if (r < 0) | |
717 | return r; | |
718 | } | |
719 | ||
720 | if (!arg_field && n_found <= 0) { | |
721 | if (!arg_quiet) | |
722 | log_notice("No coredumps found."); | |
723 | return -ESRCH; | |
724 | } | |
725 | } | |
726 | ||
727 | return 0; | |
728 | } | |
729 | ||
730 | static int save_core(sd_journal *j, FILE *file, char **path, bool *unlink_temp) { | |
731 | const char *data; | |
732 | _cleanup_free_ char *filename = NULL; | |
733 | size_t len; | |
734 | int r, fd; | |
735 | _cleanup_close_ int fdt = -1; | |
736 | char *temp = NULL; | |
737 | ||
738 | assert(!(file && path)); /* At most one can be specified */ | |
739 | assert(!!path == !!unlink_temp); /* Those must be specified together */ | |
740 | ||
741 | /* Look for a coredump on disk first. */ | |
742 | r = sd_journal_get_data(j, "COREDUMP_FILENAME", (const void**) &data, &len); | |
743 | if (r == 0) | |
744 | retrieve(data, len, "COREDUMP_FILENAME", &filename); | |
745 | else { | |
746 | if (r != -ENOENT) | |
747 | return log_error_errno(r, "Failed to retrieve COREDUMP_FILENAME field: %m"); | |
748 | /* Check that we can have a COREDUMP field. We still haven't set a high | |
749 | * data threshold, so we'll get a few kilobytes at most. | |
750 | */ | |
751 | ||
752 | r = sd_journal_get_data(j, "COREDUMP", (const void**) &data, &len); | |
753 | if (r == -ENOENT) | |
754 | return log_error_errno(r, "Coredump entry has no core attached (neither internally in the journal nor externally on disk)."); | |
755 | if (r < 0) | |
756 | return log_error_errno(r, "Failed to retrieve COREDUMP field: %m"); | |
757 | } | |
758 | ||
759 | if (filename) { | |
760 | if (access(filename, R_OK) < 0) | |
761 | return log_error_errno(errno, "File \"%s\" is not readable: %m", filename); | |
762 | ||
763 | if (path && !endswith(filename, ".xz") && !endswith(filename, ".lz4")) { | |
764 | *path = TAKE_PTR(filename); | |
765 | ||
766 | return 0; | |
767 | } | |
768 | } | |
769 | ||
770 | if (path) { | |
771 | const char *vt; | |
772 | ||
773 | /* Create a temporary file to write the uncompressed core to. */ | |
774 | ||
775 | r = var_tmp_dir(&vt); | |
776 | if (r < 0) | |
777 | return log_error_errno(r, "Failed to acquire temporary directory path: %m"); | |
778 | ||
779 | temp = strjoin(vt, "/coredump-XXXXXX"); | |
780 | if (!temp) | |
781 | return log_oom(); | |
782 | ||
783 | fdt = mkostemp_safe(temp); | |
784 | if (fdt < 0) | |
785 | return log_error_errno(fdt, "Failed to create temporary file: %m"); | |
786 | log_debug("Created temporary file %s", temp); | |
787 | ||
788 | fd = fdt; | |
789 | } else { | |
790 | /* If neither path or file are specified, we will write to stdout. Let's now check | |
791 | * if stdout is connected to a tty. We checked that the file exists, or that the | |
792 | * core might be stored in the journal. In this second case, if we found the entry, | |
793 | * in all likelihood we will be able to access the COREDUMP= field. In either case, | |
794 | * we stop before doing any "real" work, i.e. before starting decompression or | |
795 | * reading from the file or creating temporary files. | |
796 | */ | |
797 | if (!file) { | |
798 | if (on_tty()) | |
799 | return log_error_errno(SYNTHETIC_ERRNO(ENOTTY), | |
800 | "Refusing to dump core to tty" | |
801 | " (use shell redirection or specify --output)."); | |
802 | file = stdout; | |
803 | } | |
804 | ||
805 | fd = fileno(file); | |
806 | } | |
807 | ||
808 | if (filename) { | |
809 | #if HAVE_XZ || HAVE_LZ4 | |
810 | _cleanup_close_ int fdf; | |
811 | ||
812 | fdf = open(filename, O_RDONLY | O_CLOEXEC); | |
813 | if (fdf < 0) { | |
814 | r = log_error_errno(errno, "Failed to open %s: %m", filename); | |
815 | goto error; | |
816 | } | |
817 | ||
818 | r = decompress_stream(filename, fdf, fd, -1); | |
819 | if (r < 0) { | |
820 | log_error_errno(r, "Failed to decompress %s: %m", filename); | |
821 | goto error; | |
822 | } | |
823 | #else | |
824 | log_error("Cannot decompress file. Compiled without compression support."); | |
825 | r = -EOPNOTSUPP; | |
826 | goto error; | |
827 | #endif | |
828 | } else { | |
829 | ssize_t sz; | |
830 | ||
831 | /* We want full data, nothing truncated. */ | |
832 | sd_journal_set_data_threshold(j, 0); | |
833 | ||
834 | r = sd_journal_get_data(j, "COREDUMP", (const void**) &data, &len); | |
835 | if (r < 0) | |
836 | return log_error_errno(r, "Failed to retrieve COREDUMP field: %m"); | |
837 | ||
838 | assert(len >= 9); | |
839 | data += 9; | |
840 | len -= 9; | |
841 | ||
842 | sz = write(fd, data, len); | |
843 | if (sz < 0) { | |
844 | r = log_error_errno(errno, "Failed to write output: %m"); | |
845 | goto error; | |
846 | } | |
847 | if (sz != (ssize_t) len) { | |
848 | log_error("Short write to output."); | |
849 | r = -EIO; | |
850 | goto error; | |
851 | } | |
852 | } | |
853 | ||
854 | if (temp) { | |
855 | *path = temp; | |
856 | *unlink_temp = true; | |
857 | } | |
858 | return 0; | |
859 | ||
860 | error: | |
861 | if (temp) { | |
862 | (void) unlink(temp); | |
863 | log_debug("Removed temporary file %s", temp); | |
864 | } | |
865 | return r; | |
866 | } | |
867 | ||
868 | static int dump_core(int argc, char **argv, void *userdata) { | |
869 | _cleanup_(sd_journal_closep) sd_journal *j = NULL; | |
870 | _cleanup_fclose_ FILE *f = NULL; | |
871 | int r; | |
872 | ||
873 | if (arg_field) { | |
874 | log_error("Option --field/-F only makes sense with list"); | |
875 | return -EINVAL; | |
876 | } | |
877 | ||
878 | r = acquire_journal(&j, argv + 1); | |
879 | if (r < 0) | |
880 | return r; | |
881 | ||
882 | r = focus(j); | |
883 | if (r < 0) | |
884 | return r; | |
885 | ||
886 | if (arg_output) { | |
887 | f = fopen(arg_output, "we"); | |
888 | if (!f) | |
889 | return log_error_errno(errno, "Failed to open \"%s\" for writing: %m", arg_output); | |
890 | } | |
891 | ||
892 | print_info(f ? stdout : stderr, j, false); | |
893 | ||
894 | r = save_core(j, f, NULL, NULL); | |
895 | if (r < 0) | |
896 | return r; | |
897 | ||
898 | r = sd_journal_previous(j); | |
899 | if (r > 0 && !arg_quiet) | |
900 | log_notice("More than one entry matches, ignoring rest."); | |
901 | ||
902 | return 0; | |
903 | } | |
904 | ||
905 | static int run_debug(int argc, char **argv, void *userdata) { | |
906 | _cleanup_(sd_journal_closep) sd_journal *j = NULL; | |
907 | _cleanup_free_ char *exe = NULL, *path = NULL, *debugger = NULL; | |
908 | bool unlink_path = false; | |
909 | const char *data, *fork_name; | |
910 | size_t len; | |
911 | pid_t pid; | |
912 | int r; | |
913 | ||
914 | if (!arg_debugger) { | |
915 | char *env_debugger; | |
916 | ||
917 | env_debugger = getenv("SYSTEMD_DEBUGGER"); | |
918 | if (env_debugger) | |
919 | arg_debugger = env_debugger; | |
920 | else | |
921 | arg_debugger = "gdb"; | |
922 | } | |
923 | ||
924 | debugger = strdup(arg_debugger); | |
925 | if (!debugger) | |
926 | return -ENOMEM; | |
927 | ||
928 | if (arg_field) { | |
929 | log_error("Option --field/-F only makes sense with list"); | |
930 | return -EINVAL; | |
931 | } | |
932 | ||
933 | r = acquire_journal(&j, argv + 1); | |
934 | if (r < 0) | |
935 | return r; | |
936 | ||
937 | r = focus(j); | |
938 | if (r < 0) | |
939 | return r; | |
940 | ||
941 | print_info(stdout, j, false); | |
942 | fputs("\n", stdout); | |
943 | ||
944 | r = sd_journal_get_data(j, "COREDUMP_EXE", (const void**) &data, &len); | |
945 | if (r < 0) | |
946 | return log_error_errno(r, "Failed to retrieve COREDUMP_EXE field: %m"); | |
947 | ||
948 | assert(len > STRLEN("COREDUMP_EXE=")); | |
949 | data += STRLEN("COREDUMP_EXE="); | |
950 | len -= STRLEN("COREDUMP_EXE="); | |
951 | ||
952 | exe = strndup(data, len); | |
953 | if (!exe) | |
954 | return log_oom(); | |
955 | ||
956 | if (endswith(exe, " (deleted)")) { | |
957 | log_error("Binary already deleted."); | |
958 | return -ENOENT; | |
959 | } | |
960 | ||
961 | if (!path_is_absolute(exe)) { | |
962 | log_error("Binary is not an absolute path."); | |
963 | return -ENOENT; | |
964 | } | |
965 | ||
966 | r = save_core(j, NULL, &path, &unlink_path); | |
967 | if (r < 0) | |
968 | return r; | |
969 | ||
970 | /* Don't interfere with gdb and its handling of SIGINT. */ | |
971 | (void) ignore_signals(SIGINT, -1); | |
972 | ||
973 | fork_name = strjoina("(", debugger, ")"); | |
974 | ||
975 | r = safe_fork(fork_name, FORK_RESET_SIGNALS|FORK_DEATHSIG|FORK_CLOSE_ALL_FDS|FORK_RLIMIT_NOFILE_SAFE|FORK_LOG, &pid); | |
976 | if (r < 0) | |
977 | goto finish; | |
978 | if (r == 0) { | |
979 | execlp(debugger, debugger, exe, "-c", path, NULL); | |
980 | log_open(); | |
981 | log_error_errno(errno, "Failed to invoke %s: %m", debugger); | |
982 | _exit(EXIT_FAILURE); | |
983 | } | |
984 | ||
985 | r = wait_for_terminate_and_check(debugger, pid, WAIT_LOG_ABNORMAL); | |
986 | ||
987 | finish: | |
988 | (void) default_signals(SIGINT, -1); | |
989 | ||
990 | if (unlink_path) { | |
991 | log_debug("Removed temporary file %s", path); | |
992 | (void) unlink(path); | |
993 | } | |
994 | ||
995 | return r; | |
996 | } | |
997 | ||
998 | static int check_units_active(void) { | |
999 | _cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL; | |
1000 | _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL; | |
1001 | _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL; | |
1002 | _cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL; | |
1003 | int c = 0, r; | |
1004 | const char *id, *state, *substate; | |
1005 | ||
1006 | if (arg_quiet) | |
1007 | return false; | |
1008 | ||
1009 | r = sd_bus_default_system(&bus); | |
1010 | if (r < 0) | |
1011 | return log_error_errno(r, "Failed to acquire bus: %m"); | |
1012 | ||
1013 | r = sd_bus_message_new_method_call( | |
1014 | bus, | |
1015 | &m, | |
1016 | "org.freedesktop.systemd1", | |
1017 | "/org/freedesktop/systemd1", | |
1018 | "org.freedesktop.systemd1.Manager", | |
1019 | "ListUnitsByPatterns"); | |
1020 | if (r < 0) | |
1021 | return bus_log_create_error(r); | |
1022 | ||
1023 | r = sd_bus_message_append_strv(m, NULL); | |
1024 | if (r < 0) | |
1025 | return bus_log_create_error(r); | |
1026 | ||
1027 | r = sd_bus_message_append_strv(m, STRV_MAKE("systemd-coredump@*.service")); | |
1028 | if (r < 0) | |
1029 | return bus_log_create_error(r); | |
1030 | ||
1031 | r = sd_bus_call(bus, m, SHORT_BUS_CALL_TIMEOUT_USEC, &error, &reply); | |
1032 | if (r < 0) | |
1033 | return log_error_errno(r, "Failed to check if any systemd-coredump@.service units are running: %s", | |
1034 | bus_error_message(&error, r)); | |
1035 | ||
1036 | r = sd_bus_message_enter_container(reply, SD_BUS_TYPE_ARRAY, "(ssssssouso)"); | |
1037 | if (r < 0) | |
1038 | return bus_log_parse_error(r); | |
1039 | ||
1040 | while ((r = sd_bus_message_read( | |
1041 | reply, "(ssssssouso)", | |
1042 | &id, NULL, NULL, &state, &substate, | |
1043 | NULL, NULL, NULL, NULL, NULL)) > 0) { | |
1044 | bool found = !STR_IN_SET(state, "inactive", "dead", "failed"); | |
1045 | log_debug("Unit %s is %s/%s, %scounting it.", id, state, substate, found ? "" : "not "); | |
1046 | c += found; | |
1047 | } | |
1048 | if (r < 0) | |
1049 | return bus_log_parse_error(r); | |
1050 | ||
1051 | r = sd_bus_message_exit_container(reply); | |
1052 | if (r < 0) | |
1053 | return bus_log_parse_error(r); | |
1054 | ||
1055 | return c; | |
1056 | } | |
1057 | ||
1058 | static int coredumpctl_main(int argc, char *argv[]) { | |
1059 | ||
1060 | static const Verb verbs[] = { | |
1061 | { "list", VERB_ANY, VERB_ANY, VERB_DEFAULT, dump_list }, | |
1062 | { "info", VERB_ANY, VERB_ANY, 0, dump_list }, | |
1063 | { "dump", VERB_ANY, VERB_ANY, 0, dump_core }, | |
1064 | { "debug", VERB_ANY, VERB_ANY, 0, run_debug }, | |
1065 | { "gdb", VERB_ANY, VERB_ANY, 0, run_debug }, | |
1066 | {} | |
1067 | }; | |
1068 | ||
1069 | return dispatch_verb(argc, argv, verbs, NULL); | |
1070 | } | |
1071 | ||
1072 | static int run(int argc, char *argv[]) { | |
1073 | int r, units_active; | |
1074 | ||
1075 | setlocale(LC_ALL, ""); | |
1076 | log_show_color(true); | |
1077 | log_parse_environment(); | |
1078 | log_open(); | |
1079 | ||
1080 | /* The journal merging logic potentially needs a lot of fds. */ | |
1081 | (void) rlimit_nofile_bump(HIGH_RLIMIT_NOFILE); | |
1082 | ||
1083 | r = parse_argv(argc, argv); | |
1084 | if (r <= 0) | |
1085 | return r; | |
1086 | ||
1087 | sigbus_install(); | |
1088 | ||
1089 | units_active = check_units_active(); /* error is treated the same as 0 */ | |
1090 | ||
1091 | r = coredumpctl_main(argc, argv); | |
1092 | ||
1093 | if (units_active > 0) | |
1094 | printf("%s-- Notice: %d systemd-coredump@.service %s, output may be incomplete.%s\n", | |
1095 | ansi_highlight_red(), | |
1096 | units_active, units_active == 1 ? "unit is running" : "units are running", | |
1097 | ansi_normal()); | |
1098 | return r; | |
1099 | } | |
1100 | ||
1101 | DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run); |