]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/coredump/coredump.c
coredump: split out metadata gathering to a separate function
[thirdparty/systemd.git] / src / coredump / coredump.c
1 /***
2 This file is part of systemd.
3
4 Copyright 2012 Lennart Poettering
5
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.
10
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.
15
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/>.
18 ***/
19
20 #include <errno.h>
21 #include <stdio.h>
22 #include <sys/prctl.h>
23 #include <sys/xattr.h>
24 #include <unistd.h>
25
26 #ifdef HAVE_ELFUTILS
27 #include <dwarf.h>
28 #include <elfutils/libdwfl.h>
29 #endif
30
31 #include "sd-daemon.h"
32 #include "sd-journal.h"
33 #include "sd-login.h"
34 #include "sd-messages.h"
35
36 #include "acl-util.h"
37 #include "alloc-util.h"
38 #include "capability-util.h"
39 #include "cgroup-util.h"
40 #include "compress.h"
41 #include "conf-parser.h"
42 #include "copy.h"
43 #include "coredump-vacuum.h"
44 #include "dirent-util.h"
45 #include "escape.h"
46 #include "fd-util.h"
47 #include "fileio.h"
48 #include "fs-util.h"
49 #include "io-util.h"
50 #include "journald-native.h"
51 #include "log.h"
52 #include "macro.h"
53 #include "missing.h"
54 #include "mkdir.h"
55 #include "parse-util.h"
56 #include "process-util.h"
57 #include "socket-util.h"
58 #include "special.h"
59 #include "stacktrace.h"
60 #include "string-table.h"
61 #include "string-util.h"
62 #include "strv.h"
63 #include "user-util.h"
64 #include "util.h"
65
66 /* The maximum size up to which we process coredumps */
67 #define PROCESS_SIZE_MAX ((uint64_t) (2LLU*1024LLU*1024LLU*1024LLU))
68
69 /* The maximum size up to which we leave the coredump around on disk */
70 #define EXTERNAL_SIZE_MAX PROCESS_SIZE_MAX
71
72 /* The maximum size up to which we store the coredump in the journal */
73 #define JOURNAL_SIZE_MAX ((size_t) (767LU*1024LU*1024LU))
74
75 /* Make sure to not make this larger than the maximum journal entry
76 * size. See DATA_SIZE_MAX in journald-native.c. */
77 assert_cc(JOURNAL_SIZE_MAX <= DATA_SIZE_MAX);
78
79 enum {
80 /* We use this as array indexes for a couple of special fields we use for naming coredumping files, and
81 * attaching xattrs */
82 CONTEXT_PID,
83 CONTEXT_UID,
84 CONTEXT_GID,
85 CONTEXT_SIGNAL,
86 CONTEXT_TIMESTAMP,
87 CONTEXT_RLIMIT,
88 CONTEXT_COMM,
89 CONTEXT_EXE,
90 _CONTEXT_MAX
91 };
92
93 typedef enum CoredumpStorage {
94 COREDUMP_STORAGE_NONE,
95 COREDUMP_STORAGE_EXTERNAL,
96 COREDUMP_STORAGE_JOURNAL,
97 _COREDUMP_STORAGE_MAX,
98 _COREDUMP_STORAGE_INVALID = -1
99 } CoredumpStorage;
100
101 static const char* const coredump_storage_table[_COREDUMP_STORAGE_MAX] = {
102 [COREDUMP_STORAGE_NONE] = "none",
103 [COREDUMP_STORAGE_EXTERNAL] = "external",
104 [COREDUMP_STORAGE_JOURNAL] = "journal",
105 };
106
107 DEFINE_PRIVATE_STRING_TABLE_LOOKUP(coredump_storage, CoredumpStorage);
108 static DEFINE_CONFIG_PARSE_ENUM(config_parse_coredump_storage, coredump_storage, CoredumpStorage, "Failed to parse storage setting");
109
110 static CoredumpStorage arg_storage = COREDUMP_STORAGE_EXTERNAL;
111 static bool arg_compress = true;
112 static uint64_t arg_process_size_max = PROCESS_SIZE_MAX;
113 static uint64_t arg_external_size_max = EXTERNAL_SIZE_MAX;
114 static uint64_t arg_journal_size_max = JOURNAL_SIZE_MAX;
115 static uint64_t arg_keep_free = (uint64_t) -1;
116 static uint64_t arg_max_use = (uint64_t) -1;
117
118 static int parse_config(void) {
119 static const ConfigTableItem items[] = {
120 { "Coredump", "Storage", config_parse_coredump_storage, 0, &arg_storage },
121 { "Coredump", "Compress", config_parse_bool, 0, &arg_compress },
122 { "Coredump", "ProcessSizeMax", config_parse_iec_uint64, 0, &arg_process_size_max },
123 { "Coredump", "ExternalSizeMax", config_parse_iec_uint64, 0, &arg_external_size_max },
124 { "Coredump", "JournalSizeMax", config_parse_iec_size, 0, &arg_journal_size_max },
125 { "Coredump", "KeepFree", config_parse_iec_uint64, 0, &arg_keep_free },
126 { "Coredump", "MaxUse", config_parse_iec_uint64, 0, &arg_max_use },
127 {}
128 };
129
130 return config_parse_many_nulstr(PKGSYSCONFDIR "/coredump.conf",
131 CONF_PATHS_NULSTR("systemd/coredump.conf.d"),
132 "Coredump\0",
133 config_item_table_lookup, items,
134 false, NULL);
135 }
136
137 static inline uint64_t storage_size_max(void) {
138 return arg_storage == COREDUMP_STORAGE_EXTERNAL ? arg_external_size_max : arg_journal_size_max;
139 }
140
141 static int fix_acl(int fd, uid_t uid) {
142
143 #ifdef HAVE_ACL
144 _cleanup_(acl_freep) acl_t acl = NULL;
145 acl_entry_t entry;
146 acl_permset_t permset;
147 int r;
148
149 assert(fd >= 0);
150
151 if (uid <= SYSTEM_UID_MAX)
152 return 0;
153
154 /* Make sure normal users can read (but not write or delete)
155 * their own coredumps */
156
157 acl = acl_get_fd(fd);
158 if (!acl)
159 return log_error_errno(errno, "Failed to get ACL: %m");
160
161 if (acl_create_entry(&acl, &entry) < 0 ||
162 acl_set_tag_type(entry, ACL_USER) < 0 ||
163 acl_set_qualifier(entry, &uid) < 0)
164 return log_error_errno(errno, "Failed to patch ACL: %m");
165
166 if (acl_get_permset(entry, &permset) < 0 ||
167 acl_add_perm(permset, ACL_READ) < 0)
168 return log_warning_errno(errno, "Failed to patch ACL: %m");
169
170 r = calc_acl_mask_if_needed(&acl);
171 if (r < 0)
172 return log_warning_errno(r, "Failed to patch ACL: %m");
173
174 if (acl_set_fd(fd, acl) < 0)
175 return log_error_errno(errno, "Failed to apply ACL: %m");
176 #endif
177
178 return 0;
179 }
180
181 static int fix_xattr(int fd, const char *context[_CONTEXT_MAX]) {
182
183 static const char * const xattrs[_CONTEXT_MAX] = {
184 [CONTEXT_PID] = "user.coredump.pid",
185 [CONTEXT_UID] = "user.coredump.uid",
186 [CONTEXT_GID] = "user.coredump.gid",
187 [CONTEXT_SIGNAL] = "user.coredump.signal",
188 [CONTEXT_TIMESTAMP] = "user.coredump.timestamp",
189 [CONTEXT_COMM] = "user.coredump.comm",
190 [CONTEXT_EXE] = "user.coredump.exe",
191 };
192
193 int r = 0;
194 unsigned i;
195
196 assert(fd >= 0);
197
198 /* Attach some metadata to coredumps via extended
199 * attributes. Just because we can. */
200
201 for (i = 0; i < _CONTEXT_MAX; i++) {
202 int k;
203
204 if (isempty(context[i]) || !xattrs[i])
205 continue;
206
207 k = fsetxattr(fd, xattrs[i], context[i], strlen(context[i]), XATTR_CREATE);
208 if (k < 0 && r == 0)
209 r = -errno;
210 }
211
212 return r;
213 }
214
215 #define filename_escape(s) xescape((s), "./ ")
216
217 static inline const char *coredump_tmpfile_name(const char *s) {
218 return s ? s : "(unnamed temporary file)";
219 }
220
221 static int fix_permissions(
222 int fd,
223 const char *filename,
224 const char *target,
225 const char *context[_CONTEXT_MAX],
226 uid_t uid) {
227
228 int r;
229
230 assert(fd >= 0);
231 assert(target);
232 assert(context);
233
234 /* Ignore errors on these */
235 (void) fchmod(fd, 0640);
236 (void) fix_acl(fd, uid);
237 (void) fix_xattr(fd, context);
238
239 if (fsync(fd) < 0)
240 return log_error_errno(errno, "Failed to sync coredump %s: %m", coredump_tmpfile_name(filename));
241
242 r = link_tmpfile(fd, filename, target);
243 if (r < 0)
244 return log_error_errno(r, "Failed to move coredump %s into place: %m", target);
245
246 return 0;
247 }
248
249 static int maybe_remove_external_coredump(const char *filename, uint64_t size) {
250
251 /* Returns 1 if might remove, 0 if will not remove, < 0 on error. */
252
253 if (arg_storage == COREDUMP_STORAGE_EXTERNAL &&
254 size <= arg_external_size_max)
255 return 0;
256
257 if (!filename)
258 return 1;
259
260 if (unlink(filename) < 0 && errno != ENOENT)
261 return log_error_errno(errno, "Failed to unlink %s: %m", filename);
262
263 return 1;
264 }
265
266 static int make_filename(const char *context[_CONTEXT_MAX], char **ret) {
267 _cleanup_free_ char *c = NULL, *u = NULL, *p = NULL, *t = NULL;
268 sd_id128_t boot = {};
269 int r;
270
271 assert(context);
272
273 c = filename_escape(context[CONTEXT_COMM]);
274 if (!c)
275 return -ENOMEM;
276
277 u = filename_escape(context[CONTEXT_UID]);
278 if (!u)
279 return -ENOMEM;
280
281 r = sd_id128_get_boot(&boot);
282 if (r < 0)
283 return r;
284
285 p = filename_escape(context[CONTEXT_PID]);
286 if (!p)
287 return -ENOMEM;
288
289 t = filename_escape(context[CONTEXT_TIMESTAMP]);
290 if (!t)
291 return -ENOMEM;
292
293 if (asprintf(ret,
294 "/var/lib/systemd/coredump/core.%s.%s." SD_ID128_FORMAT_STR ".%s.%s000000",
295 c,
296 u,
297 SD_ID128_FORMAT_VAL(boot),
298 p,
299 t) < 0)
300 return -ENOMEM;
301
302 return 0;
303 }
304
305 static int save_external_coredump(
306 const char *context[_CONTEXT_MAX],
307 int input_fd,
308 char **ret_filename,
309 int *ret_node_fd,
310 int *ret_data_fd,
311 uint64_t *ret_size) {
312
313 _cleanup_free_ char *fn = NULL, *tmp = NULL;
314 _cleanup_close_ int fd = -1;
315 uint64_t rlimit, max_size;
316 struct stat st;
317 uid_t uid;
318 int r;
319
320 assert(context);
321 assert(ret_filename);
322 assert(ret_node_fd);
323 assert(ret_data_fd);
324 assert(ret_size);
325
326 r = parse_uid(context[CONTEXT_UID], &uid);
327 if (r < 0)
328 return log_error_errno(r, "Failed to parse UID: %m");
329
330 r = safe_atou64(context[CONTEXT_RLIMIT], &rlimit);
331 if (r < 0)
332 return log_error_errno(r, "Failed to parse resource limit: %s", context[CONTEXT_RLIMIT]);
333 if (rlimit < page_size()) {
334 /* Is coredumping disabled? Then don't bother saving/processing the coredump.
335 * Anything below PAGE_SIZE cannot give a readable coredump (the kernel uses
336 * ELF_EXEC_PAGESIZE which is not easily accessible, but is usually the same as PAGE_SIZE. */
337 log_info("Resource limits disable core dumping for process %s (%s).",
338 context[CONTEXT_PID], context[CONTEXT_COMM]);
339 return -EBADSLT;
340 }
341
342 /* Never store more than the process configured, or than we actually shall keep or process */
343 max_size = MIN(rlimit, MAX(arg_process_size_max, storage_size_max()));
344
345 r = make_filename(context, &fn);
346 if (r < 0)
347 return log_error_errno(r, "Failed to determine coredump file name: %m");
348
349 mkdir_p_label("/var/lib/systemd/coredump", 0755);
350
351 fd = open_tmpfile_linkable(fn, O_RDWR|O_CLOEXEC, &tmp);
352 if (fd < 0)
353 return log_error_errno(fd, "Failed to create temporary file for coredump %s: %m", fn);
354
355 r = copy_bytes(input_fd, fd, max_size, false);
356 if (r < 0) {
357 log_error_errno(r, "Cannot store coredump of %s (%s): %m", context[CONTEXT_PID], context[CONTEXT_COMM]);
358 goto fail;
359 } else if (r == 1)
360 log_struct(LOG_INFO,
361 LOG_MESSAGE("Core file was truncated to %zu bytes.", max_size),
362 "SIZE_LIMIT=%zu", max_size,
363 LOG_MESSAGE_ID(SD_MESSAGE_TRUNCATED_CORE),
364 NULL);
365
366 if (fstat(fd, &st) < 0) {
367 log_error_errno(errno, "Failed to fstat core file %s: %m", coredump_tmpfile_name(tmp));
368 goto fail;
369 }
370
371 if (lseek(fd, 0, SEEK_SET) == (off_t) -1) {
372 log_error_errno(errno, "Failed to seek on %s: %m", coredump_tmpfile_name(tmp));
373 goto fail;
374 }
375
376 #if defined(HAVE_XZ) || defined(HAVE_LZ4)
377 /* If we will remove the coredump anyway, do not compress. */
378 if (arg_compress && !maybe_remove_external_coredump(NULL, st.st_size)) {
379
380 _cleanup_free_ char *fn_compressed = NULL, *tmp_compressed = NULL;
381 _cleanup_close_ int fd_compressed = -1;
382
383 fn_compressed = strappend(fn, COMPRESSED_EXT);
384 if (!fn_compressed) {
385 log_oom();
386 goto uncompressed;
387 }
388
389 fd_compressed = open_tmpfile_linkable(fn_compressed, O_RDWR|O_CLOEXEC, &tmp_compressed);
390 if (fd_compressed < 0) {
391 log_error_errno(fd_compressed, "Failed to create temporary file for coredump %s: %m", fn_compressed);
392 goto uncompressed;
393 }
394
395 r = compress_stream(fd, fd_compressed, -1);
396 if (r < 0) {
397 log_error_errno(r, "Failed to compress %s: %m", coredump_tmpfile_name(tmp_compressed));
398 goto fail_compressed;
399 }
400
401 r = fix_permissions(fd_compressed, tmp_compressed, fn_compressed, context, uid);
402 if (r < 0)
403 goto fail_compressed;
404
405 /* OK, this worked, we can get rid of the uncompressed version now */
406 if (tmp)
407 unlink_noerrno(tmp);
408
409 *ret_filename = fn_compressed; /* compressed */
410 *ret_node_fd = fd_compressed; /* compressed */
411 *ret_data_fd = fd; /* uncompressed */
412 *ret_size = (uint64_t) st.st_size; /* uncompressed */
413
414 fn_compressed = NULL;
415 fd = fd_compressed = -1;
416
417 return 0;
418
419 fail_compressed:
420 if (tmp_compressed)
421 (void) unlink(tmp_compressed);
422 }
423
424 uncompressed:
425 #endif
426
427 r = fix_permissions(fd, tmp, fn, context, uid);
428 if (r < 0)
429 goto fail;
430
431 *ret_filename = fn;
432 *ret_data_fd = fd;
433 *ret_node_fd = -1;
434 *ret_size = (uint64_t) st.st_size;
435
436 fn = NULL;
437 fd = -1;
438
439 return 0;
440
441 fail:
442 if (tmp)
443 (void) unlink(tmp);
444 return r;
445 }
446
447 static int allocate_journal_field(int fd, size_t size, char **ret, size_t *ret_size) {
448 _cleanup_free_ char *field = NULL;
449 ssize_t n;
450
451 assert(fd >= 0);
452 assert(ret);
453 assert(ret_size);
454
455 if (lseek(fd, 0, SEEK_SET) == (off_t) -1)
456 return log_warning_errno(errno, "Failed to seek: %m");
457
458 field = malloc(9 + size);
459 if (!field) {
460 log_warning("Failed to allocate memory for coredump, coredump will not be stored.");
461 return -ENOMEM;
462 }
463
464 memcpy(field, "COREDUMP=", 9);
465
466 n = read(fd, field + 9, size);
467 if (n < 0)
468 return log_error_errno((int) n, "Failed to read core data: %m");
469 if ((size_t) n < size) {
470 log_error("Core data too short.");
471 return -EIO;
472 }
473
474 *ret = field;
475 *ret_size = size + 9;
476
477 field = NULL;
478
479 return 0;
480 }
481
482 /* Joins /proc/[pid]/fd/ and /proc/[pid]/fdinfo/ into the following lines:
483 * 0:/dev/pts/23
484 * pos: 0
485 * flags: 0100002
486 *
487 * 1:/dev/pts/23
488 * pos: 0
489 * flags: 0100002
490 *
491 * 2:/dev/pts/23
492 * pos: 0
493 * flags: 0100002
494 * EOF
495 */
496 static int compose_open_fds(pid_t pid, char **open_fds) {
497 _cleanup_closedir_ DIR *proc_fd_dir = NULL;
498 _cleanup_close_ int proc_fdinfo_fd = -1;
499 _cleanup_free_ char *buffer = NULL;
500 _cleanup_fclose_ FILE *stream = NULL;
501 const char *fddelim = "", *path;
502 struct dirent *dent = NULL;
503 size_t size = 0;
504 int r = 0;
505
506 assert(pid >= 0);
507 assert(open_fds != NULL);
508
509 path = procfs_file_alloca(pid, "fd");
510 proc_fd_dir = opendir(path);
511 if (!proc_fd_dir)
512 return -errno;
513
514 proc_fdinfo_fd = openat(dirfd(proc_fd_dir), "../fdinfo", O_DIRECTORY|O_NOFOLLOW|O_CLOEXEC|O_PATH);
515 if (proc_fdinfo_fd < 0)
516 return -errno;
517
518 stream = open_memstream(&buffer, &size);
519 if (!stream)
520 return -ENOMEM;
521
522 FOREACH_DIRENT(dent, proc_fd_dir, return -errno) {
523 _cleanup_fclose_ FILE *fdinfo = NULL;
524 _cleanup_free_ char *fdname = NULL;
525 char line[LINE_MAX];
526 int fd;
527
528 r = readlinkat_malloc(dirfd(proc_fd_dir), dent->d_name, &fdname);
529 if (r < 0)
530 return r;
531
532 fprintf(stream, "%s%s:%s\n", fddelim, dent->d_name, fdname);
533 fddelim = "\n";
534
535 /* Use the directory entry from /proc/[pid]/fd with /proc/[pid]/fdinfo */
536 fd = openat(proc_fdinfo_fd, dent->d_name, O_NOFOLLOW|O_CLOEXEC|O_RDONLY);
537 if (fd < 0)
538 continue;
539
540 fdinfo = fdopen(fd, "re");
541 if (fdinfo == NULL) {
542 close(fd);
543 continue;
544 }
545
546 FOREACH_LINE(line, fdinfo, break) {
547 fputs(line, stream);
548 if (!endswith(line, "\n"))
549 fputc('\n', stream);
550 }
551 }
552
553 errno = 0;
554 stream = safe_fclose(stream);
555
556 if (errno > 0)
557 return -errno;
558
559 *open_fds = buffer;
560 buffer = NULL;
561
562 return 0;
563 }
564
565 static int get_process_ns(pid_t pid, const char *namespace, ino_t *ns) {
566 const char *p;
567 struct stat stbuf;
568 _cleanup_close_ int proc_ns_dir_fd;
569
570 p = procfs_file_alloca(pid, "ns");
571
572 proc_ns_dir_fd = open(p, O_DIRECTORY | O_CLOEXEC | O_RDONLY);
573 if (proc_ns_dir_fd < 0)
574 return -errno;
575
576 if (fstatat(proc_ns_dir_fd, namespace, &stbuf, /* flags */0) < 0)
577 return -errno;
578
579 *ns = stbuf.st_ino;
580 return 0;
581 }
582
583 static int get_mount_namespace_leader(pid_t pid, pid_t *container_pid) {
584 pid_t cpid = pid, ppid = 0;
585 ino_t proc_mntns;
586 int r = 0;
587
588 r = get_process_ns(pid, "mnt", &proc_mntns);
589 if (r < 0)
590 return r;
591
592 for (;;) {
593 ino_t parent_mntns;
594
595 r = get_process_ppid(cpid, &ppid);
596 if (r < 0)
597 return r;
598
599 r = get_process_ns(ppid, "mnt", &parent_mntns);
600 if (r < 0)
601 return r;
602
603 if (proc_mntns != parent_mntns)
604 break;
605
606 if (ppid == 1)
607 return -ENOENT;
608
609 cpid = ppid;
610 }
611
612 *container_pid = ppid;
613 return 0;
614 }
615
616 /* Returns 1 if the parent was found.
617 * Returns 0 if there is not a process we can call the pid's
618 * container parent (the pid's process isn't 'containerized').
619 * Returns a negative number on errors.
620 */
621 static int get_process_container_parent_cmdline(pid_t pid, char** cmdline) {
622 int r = 0;
623 pid_t container_pid;
624 const char *proc_root_path;
625 struct stat root_stat, proc_root_stat;
626
627 /* To compare inodes of / and /proc/[pid]/root */
628 if (stat("/", &root_stat) < 0)
629 return -errno;
630
631 proc_root_path = procfs_file_alloca(pid, "root");
632 if (stat(proc_root_path, &proc_root_stat) < 0)
633 return -errno;
634
635 /* The process uses system root. */
636 if (proc_root_stat.st_ino == root_stat.st_ino) {
637 *cmdline = NULL;
638 return 0;
639 }
640
641 r = get_mount_namespace_leader(pid, &container_pid);
642 if (r < 0)
643 return r;
644
645 r = get_process_cmdline(container_pid, 0, false, cmdline);
646 if (r < 0)
647 return r;
648
649 return 1;
650 }
651
652 static int change_uid_gid(const char *context[]) {
653 uid_t uid;
654 gid_t gid;
655 int r;
656
657 r = parse_uid(context[CONTEXT_UID], &uid);
658 if (r < 0)
659 return r;
660
661 if (uid <= SYSTEM_UID_MAX) {
662 const char *user = "systemd-coredump";
663
664 r = get_user_creds(&user, &uid, &gid, NULL, NULL);
665 if (r < 0) {
666 log_warning_errno(r, "Cannot resolve %s user. Proceeding to dump core as root: %m", user);
667 uid = gid = 0;
668 }
669 } else {
670 r = parse_gid(context[CONTEXT_GID], &gid);
671 if (r < 0)
672 return r;
673 }
674
675 return drop_privileges(uid, gid, 0);
676 }
677
678 static int submit_coredump(
679 const char *context[_CONTEXT_MAX],
680 struct iovec *iovec,
681 size_t n_iovec_allocated,
682 size_t n_iovec,
683 int input_fd) {
684
685 _cleanup_close_ int coredump_fd = -1, coredump_node_fd = -1;
686 _cleanup_free_ char *core_message = NULL, *filename = NULL, *coredump_data = NULL;
687 uint64_t coredump_size = UINT64_MAX;
688 int r;
689
690 assert(context);
691 assert(iovec);
692 assert(n_iovec_allocated >= n_iovec + 3);
693 assert(input_fd >= 0);
694
695 /* Vacuum before we write anything again */
696 (void) coredump_vacuum(-1, arg_keep_free, arg_max_use);
697
698 /* Always stream the coredump to disk, if that's possible */
699 r = save_external_coredump(context, input_fd, &filename, &coredump_node_fd, &coredump_fd, &coredump_size);
700 if (r < 0)
701 /* Skip whole core dumping part */
702 goto log;
703
704 /* If we don't want to keep the coredump on disk, remove it now, as later on we will lack the privileges for
705 * it. However, we keep the fd to it, so that we can still process it and log it. */
706 r = maybe_remove_external_coredump(filename, coredump_size);
707 if (r < 0)
708 return r;
709 if (r == 0) {
710 const char *coredump_filename;
711
712 coredump_filename = strjoina("COREDUMP_FILENAME=", filename);
713 IOVEC_SET_STRING(iovec[n_iovec++], coredump_filename);
714 } else if (arg_storage == COREDUMP_STORAGE_EXTERNAL)
715 log_info("The core will not be stored: size %"PRIu64" is greater than %"PRIu64" (the configured maximum)",
716 coredump_size, arg_external_size_max);
717
718 /* Vacuum again, but exclude the coredump we just created */
719 (void) coredump_vacuum(coredump_node_fd >= 0 ? coredump_node_fd : coredump_fd, arg_keep_free, arg_max_use);
720
721 /* Now, let's drop privileges to become the user who owns the segfaulted process and allocate the coredump
722 * memory under the user's uid. This also ensures that the credentials journald will see are the ones of the
723 * coredumping user, thus making sure the user gets access to the core dump. Let's also get rid of all
724 * capabilities, if we run as root, we won't need them anymore. */
725 r = change_uid_gid(context);
726 if (r < 0)
727 return log_error_errno(r, "Failed to drop privileges: %m");
728
729 #ifdef HAVE_ELFUTILS
730 /* Try to get a strack trace if we can */
731 if (coredump_size <= arg_process_size_max) {
732 _cleanup_free_ char *stacktrace = NULL;
733
734 r = coredump_make_stack_trace(coredump_fd, context[CONTEXT_EXE], &stacktrace);
735 if (r >= 0)
736 core_message = strjoin("MESSAGE=Process ", context[CONTEXT_PID],
737 " (", context[CONTEXT_COMM], ") of user ",
738 context[CONTEXT_UID], " dumped core.\n\n",
739 stacktrace);
740 else if (r == -EINVAL)
741 log_warning("Failed to generate stack trace: %s", dwfl_errmsg(dwfl_errno()));
742 else
743 log_warning_errno(r, "Failed to generate stack trace: %m");
744 } else
745 log_debug("Not generating stack trace: core size %"PRIu64" is greater than %"PRIu64" (the configured maximum)",
746 coredump_size, arg_process_size_max);
747
748 if (!core_message)
749 #endif
750 log:
751 core_message = strjoin("MESSAGE=Process ", context[CONTEXT_PID], " (",
752 context[CONTEXT_COMM], ") of user ",
753 context[CONTEXT_UID], " dumped core.");
754 if (core_message)
755 IOVEC_SET_STRING(iovec[n_iovec++], core_message);
756
757 /* Optionally store the entire coredump in the journal */
758 if (arg_storage == COREDUMP_STORAGE_JOURNAL) {
759 if (coredump_size <= arg_journal_size_max) {
760 size_t sz = 0;
761
762 /* Store the coredump itself in the journal */
763
764 r = allocate_journal_field(coredump_fd, (size_t) coredump_size, &coredump_data, &sz);
765 if (r >= 0) {
766 iovec[n_iovec].iov_base = coredump_data;
767 iovec[n_iovec].iov_len = sz;
768 n_iovec++;
769 } else
770 log_warning_errno(r, "Failed to attach the core to the journal entry: %m");
771 } else
772 log_info("The core will not be stored: size %"PRIu64" is greater than %"PRIu64" (the configured maximum)",
773 coredump_size, arg_journal_size_max);
774 }
775
776 assert(n_iovec <= n_iovec_allocated);
777
778 r = sd_journal_sendv(iovec, n_iovec);
779 if (r < 0)
780 return log_error_errno(r, "Failed to log coredump: %m");
781
782 return 0;
783 }
784
785 static void map_context_fields(const struct iovec *iovec, const char *context[]) {
786
787 static const char * const context_field_names[_CONTEXT_MAX] = {
788 [CONTEXT_PID] = "COREDUMP_PID=",
789 [CONTEXT_UID] = "COREDUMP_UID=",
790 [CONTEXT_GID] = "COREDUMP_GID=",
791 [CONTEXT_SIGNAL] = "COREDUMP_SIGNAL=",
792 [CONTEXT_TIMESTAMP] = "COREDUMP_TIMESTAMP=",
793 [CONTEXT_COMM] = "COREDUMP_COMM=",
794 [CONTEXT_EXE] = "COREDUMP_EXE=",
795 [CONTEXT_RLIMIT] = "COREDUMP_RLIMIT=",
796 };
797
798 unsigned i;
799
800 assert(iovec);
801 assert(context);
802
803 for (i = 0; i < _CONTEXT_MAX; i++) {
804 size_t l;
805
806 l = strlen(context_field_names[i]);
807 if (iovec->iov_len < l)
808 continue;
809
810 if (memcmp(iovec->iov_base, context_field_names[i], l) != 0)
811 continue;
812
813 /* Note that these strings are NUL terminated, because we made sure that a trailing NUL byte is in the
814 * buffer, though not included in the iov_len count. (see below) */
815 context[i] = (char*) iovec->iov_base + l;
816 break;
817 }
818 }
819
820 static int process_socket(int fd) {
821 _cleanup_close_ int coredump_fd = -1;
822 struct iovec *iovec = NULL;
823 size_t n_iovec = 0, n_iovec_allocated = 0, i;
824 const char *context[_CONTEXT_MAX] = {};
825 int r;
826
827 assert(fd >= 0);
828
829 log_set_target(LOG_TARGET_AUTO);
830 log_parse_environment();
831 log_open();
832
833 for (;;) {
834 union {
835 struct cmsghdr cmsghdr;
836 uint8_t buf[CMSG_SPACE(sizeof(int))];
837 } control = {};
838 struct msghdr mh = {
839 .msg_control = &control,
840 .msg_controllen = sizeof(control),
841 .msg_iovlen = 1,
842 };
843 ssize_t n;
844 ssize_t l;
845
846 if (!GREEDY_REALLOC(iovec, n_iovec_allocated, n_iovec + 3)) {
847 r = log_oom();
848 goto finish;
849 }
850
851 l = next_datagram_size_fd(fd);
852 if (l < 0) {
853 r = log_error_errno(l, "Failed to determine datagram size to read: %m");
854 goto finish;
855 }
856
857 assert(l >= 0);
858
859 iovec[n_iovec].iov_len = l;
860 iovec[n_iovec].iov_base = malloc(l + 1);
861 if (!iovec[n_iovec].iov_base) {
862 r = log_oom();
863 goto finish;
864 }
865
866 mh.msg_iov = iovec + n_iovec;
867
868 n = recvmsg(fd, &mh, MSG_NOSIGNAL|MSG_CMSG_CLOEXEC);
869 if (n < 0) {
870 free(iovec[n_iovec].iov_base);
871 r = log_error_errno(errno, "Failed to receive datagram: %m");
872 goto finish;
873 }
874
875 if (n == 0) {
876 struct cmsghdr *cmsg, *found = NULL;
877 /* The final zero-length datagram carries the file descriptor and tells us that we're done. */
878
879 free(iovec[n_iovec].iov_base);
880
881 CMSG_FOREACH(cmsg, &mh) {
882 if (cmsg->cmsg_level == SOL_SOCKET &&
883 cmsg->cmsg_type == SCM_RIGHTS &&
884 cmsg->cmsg_len == CMSG_LEN(sizeof(int))) {
885 assert(!found);
886 found = cmsg;
887 }
888 }
889
890 if (!found) {
891 log_error("Coredump file descriptor missing.");
892 r = -EBADMSG;
893 goto finish;
894 }
895
896 assert(coredump_fd < 0);
897 coredump_fd = *(int*) CMSG_DATA(found);
898 break;
899 }
900
901 /* Add trailing NUL byte, in case these are strings */
902 ((char*) iovec[n_iovec].iov_base)[n] = 0;
903 iovec[n_iovec].iov_len = (size_t) n;
904
905 cmsg_close_all(&mh);
906 map_context_fields(iovec + n_iovec, context);
907 n_iovec++;
908 }
909
910 if (!GREEDY_REALLOC(iovec, n_iovec_allocated, n_iovec + 3)) {
911 r = log_oom();
912 goto finish;
913 }
914
915 /* Make sure we got all data we really need */
916 assert(context[CONTEXT_PID]);
917 assert(context[CONTEXT_UID]);
918 assert(context[CONTEXT_GID]);
919 assert(context[CONTEXT_SIGNAL]);
920 assert(context[CONTEXT_TIMESTAMP]);
921 assert(context[CONTEXT_RLIMIT]);
922 assert(context[CONTEXT_COMM]);
923 assert(coredump_fd >= 0);
924
925 r = submit_coredump(context, iovec, n_iovec_allocated, n_iovec, coredump_fd);
926
927 finish:
928 for (i = 0; i < n_iovec; i++)
929 free(iovec[i].iov_base);
930 free(iovec);
931
932 return r;
933 }
934
935 static int send_iovec(const struct iovec iovec[], size_t n_iovec, int input_fd) {
936
937 static const union sockaddr_union sa = {
938 .un.sun_family = AF_UNIX,
939 .un.sun_path = "/run/systemd/coredump",
940 };
941 _cleanup_close_ int fd = -1;
942 size_t i;
943 int r;
944
945 assert(iovec || n_iovec <= 0);
946 assert(input_fd >= 0);
947
948 fd = socket(AF_UNIX, SOCK_SEQPACKET|SOCK_CLOEXEC, 0);
949 if (fd < 0)
950 return log_error_errno(errno, "Failed to create coredump socket: %m");
951
952 if (connect(fd, &sa.sa, SOCKADDR_UN_LEN(sa.un)) < 0)
953 return log_error_errno(errno, "Failed to connect to coredump service: %m");
954
955 for (i = 0; i < n_iovec; i++) {
956 struct msghdr mh = {
957 .msg_iov = (struct iovec*) iovec + i,
958 .msg_iovlen = 1,
959 };
960 struct iovec copy[2];
961
962 for (;;) {
963 if (sendmsg(fd, &mh, MSG_NOSIGNAL) >= 0)
964 break;
965
966 if (errno == EMSGSIZE && mh.msg_iov[0].iov_len > 0) {
967 /* This field didn't fit? That's a pity. Given that this is just metadata,
968 * let's truncate the field at half, and try again. We append three dots, in
969 * order to show that this is truncated. */
970
971 if (mh.msg_iov != copy) {
972 /* We don't want to modify the caller's iovec, hence let's create our
973 * own array, consisting of two new iovecs, where the first is a
974 * (truncated) copy of what we want to send, and the second one
975 * contains the trailing dots. */
976 copy[0] = iovec[i];
977 copy[1] = (struct iovec) {
978 .iov_base = (char[]) { '.', '.', '.' },
979 .iov_len = 3,
980 };
981
982 mh.msg_iov = copy;
983 mh.msg_iovlen = 2;
984 }
985
986 copy[0].iov_len /= 2; /* halve it, and try again */
987 continue;
988 }
989
990 return log_error_errno(errno, "Failed to send coredump datagram: %m");
991 }
992 }
993
994 r = send_one_fd(fd, input_fd, 0);
995 if (r < 0)
996 return log_error_errno(r, "Failed to send coredump fd: %m");
997
998 return 0;
999 }
1000
1001 static int process_special_crash(const char *context[], int input_fd) {
1002 _cleanup_close_ int coredump_fd = -1, coredump_node_fd = -1;
1003 _cleanup_free_ char *filename = NULL;
1004 uint64_t coredump_size;
1005 int r;
1006
1007 assert(context);
1008 assert(input_fd >= 0);
1009
1010 /* If we are pid1 or journald, we cut things short, don't write to the journal, but still create a coredump. */
1011
1012 if (arg_storage != COREDUMP_STORAGE_NONE)
1013 arg_storage = COREDUMP_STORAGE_EXTERNAL;
1014
1015 r = save_external_coredump(context, input_fd, &filename, &coredump_node_fd, &coredump_fd, &coredump_size);
1016 if (r < 0)
1017 return r;
1018
1019 r = maybe_remove_external_coredump(filename, coredump_size);
1020 if (r < 0)
1021 return r;
1022
1023 log_notice("Detected coredump of the journal daemon or PID 1, diverted to %s.", filename);
1024
1025 return 0;
1026 }
1027
1028 static char* set_iovec_field(struct iovec iovec[27], size_t *n_iovec, const char *field, const char *value) {
1029 char *x;
1030
1031 x = strappend(field, value);
1032 if (x)
1033 IOVEC_SET_STRING(iovec[(*n_iovec)++], x);
1034 return x;
1035 }
1036
1037 static char* set_iovec_field_free(struct iovec iovec[27], size_t *n_iovec, const char *field, char *value) {
1038 char *x;
1039
1040 x = set_iovec_field(iovec, n_iovec, field, value);
1041 free(value);
1042 return x;
1043 }
1044
1045 static int gather_pid_metadata(
1046 const char *context[_CONTEXT_MAX],
1047 char **comm_fallback,
1048 struct iovec iovec[27], size_t *n_iovec) {
1049
1050 _cleanup_free_ char *exe = NULL, *comm = NULL;
1051 uid_t owner_uid;
1052 pid_t pid;
1053 char *t;
1054 const char *p;
1055 int r;
1056
1057 r = parse_pid(context[CONTEXT_PID], &pid);
1058 if (r < 0)
1059 return log_error_errno(r, "Failed to parse PID.");
1060
1061 r = get_process_comm(pid, &comm);
1062 if (r < 0) {
1063 log_warning_errno(r, "Failed to get COMM, falling back to the command line: %m");
1064 comm = strv_join(comm_fallback, " ");
1065 if (!comm)
1066 return log_oom();
1067 }
1068
1069 r = get_process_exe(pid, &exe);
1070 if (r < 0)
1071 log_warning_errno(r, "Failed to get EXE, ignoring: %m");
1072
1073 if (cg_pid_get_unit(pid, &t) >= 0) {
1074
1075 /* If this is PID 1 disable coredump collection, we'll unlikely be able to process it later on. */
1076 if (streq(t, SPECIAL_INIT_SCOPE)) {
1077 log_notice("Due to PID 1 having crashed coredump collection will now be turned off.");
1078 (void) write_string_file("/proc/sys/kernel/core_pattern", "|/bin/false", 0);
1079 }
1080
1081 /* Let's avoid dead-locks when processing journald and init crashes, as socket activation and logging
1082 * are unlikely to work then. */
1083 if (STR_IN_SET(t, SPECIAL_JOURNALD_SERVICE, SPECIAL_INIT_SCOPE)) {
1084 free(t);
1085 return process_special_crash(context, STDIN_FILENO);
1086 }
1087
1088 set_iovec_field_free(iovec, n_iovec, "COREDUMP_UNIT=", t);
1089 }
1090
1091 /* OK, now we know it's not the journal, hence we can make use of it now. */
1092 log_set_target(LOG_TARGET_JOURNAL_OR_KMSG);
1093 log_open();
1094
1095 if (cg_pid_get_user_unit(pid, &t) >= 0)
1096 set_iovec_field_free(iovec, n_iovec, "COREDUMP_USER_UNIT=", t);
1097
1098 /* The next few are mandatory */
1099 if (!set_iovec_field(iovec, n_iovec, "COREDUMP_PID=", context[CONTEXT_PID]))
1100 return log_oom();
1101
1102 if (!set_iovec_field(iovec, n_iovec, "COREDUMP_UID=", context[CONTEXT_UID]))
1103 return log_oom();
1104
1105 if (!set_iovec_field(iovec, n_iovec, "COREDUMP_GID=", context[CONTEXT_GID]))
1106 return log_oom();
1107
1108 if (!set_iovec_field(iovec, n_iovec, "COREDUMP_SIGNAL=", context[CONTEXT_SIGNAL]))
1109 return log_oom();
1110
1111 if (!set_iovec_field(iovec, n_iovec, "COREDUMP_RLIMIT=", context[CONTEXT_RLIMIT]))
1112 return log_oom();
1113
1114 if (!set_iovec_field(iovec, n_iovec, "COREDUMP_COMM=", comm))
1115 return log_oom();
1116
1117 if (exe &&
1118 !set_iovec_field(iovec, n_iovec, "COREDUMP_EXE=", exe))
1119 return log_oom();
1120
1121 if (sd_pid_get_session(pid, &t) >= 0)
1122 set_iovec_field_free(iovec, n_iovec, "COREDUMP_SESSION=", t);
1123
1124 if (sd_pid_get_owner_uid(pid, &owner_uid) >= 0) {
1125 r = asprintf(&t, "COREDUMP_OWNER_UID=" UID_FMT, owner_uid);
1126 if (r > 0)
1127 IOVEC_SET_STRING(iovec[(*n_iovec)++], t);
1128 }
1129
1130 if (sd_pid_get_slice(pid, &t) >= 0)
1131 set_iovec_field_free(iovec, n_iovec, "COREDUMP_SLICE=", t);
1132
1133 if (get_process_cmdline(pid, 0, false, &t) >= 0)
1134 set_iovec_field_free(iovec, n_iovec, "COREDUMP_CMDLINE=", t);
1135
1136 if (cg_pid_get_path_shifted(pid, NULL, &t) >= 0)
1137 set_iovec_field_free(iovec, n_iovec, "COREDUMP_CGROUP=", t);
1138
1139 if (compose_open_fds(pid, &t) >= 0)
1140 set_iovec_field_free(iovec, n_iovec, "COREDUMP_OPEN_FDS=", t);
1141
1142 p = procfs_file_alloca(pid, "status");
1143 if (read_full_file(p, &t, NULL) >= 0)
1144 set_iovec_field_free(iovec, n_iovec, "COREDUMP_PROC_STATUS=", t);
1145
1146 p = procfs_file_alloca(pid, "maps");
1147 if (read_full_file(p, &t, NULL) >= 0)
1148 set_iovec_field_free(iovec, n_iovec, "COREDUMP_PROC_MAPS=", t);
1149
1150 p = procfs_file_alloca(pid, "limits");
1151 if (read_full_file(p, &t, NULL) >= 0)
1152 set_iovec_field_free(iovec, n_iovec, "COREDUMP_PROC_LIMITS=", t);
1153
1154 p = procfs_file_alloca(pid, "cgroup");
1155 if (read_full_file(p, &t, NULL) >=0)
1156 set_iovec_field_free(iovec, n_iovec, "COREDUMP_PROC_CGROUP=", t);
1157
1158 p = procfs_file_alloca(pid, "mountinfo");
1159 if (read_full_file(p, &t, NULL) >=0)
1160 set_iovec_field_free(iovec, n_iovec, "COREDUMP_PROC_MOUNTINFO=", t);
1161
1162 if (get_process_cwd(pid, &t) >= 0)
1163 set_iovec_field_free(iovec, n_iovec, "COREDUMP_CWD=", t);
1164
1165 if (get_process_root(pid, &t) >= 0) {
1166 bool proc_self_root_is_slash;
1167
1168 proc_self_root_is_slash = strcmp(t, "/") == 0;
1169
1170 set_iovec_field_free(iovec, n_iovec, "COREDUMP_ROOT=", t);
1171
1172 /* If the process' root is "/", then there is a chance it has
1173 * mounted own root and hence being containerized. */
1174 if (proc_self_root_is_slash && get_process_container_parent_cmdline(pid, &t) > 0)
1175 set_iovec_field_free(iovec, n_iovec, "COREDUMP_CONTAINER_CMDLINE=", t);
1176 }
1177
1178 if (get_process_environ(pid, &t) >= 0)
1179 set_iovec_field_free(iovec, n_iovec, "COREDUMP_ENVIRON=", t);
1180
1181 t = strjoin("COREDUMP_TIMESTAMP=", context[CONTEXT_TIMESTAMP], "000000", NULL);
1182 if (t)
1183 IOVEC_SET_STRING(iovec[(*n_iovec)++], t);
1184
1185 return 0;
1186 }
1187
1188 static int process_kernel(int argc, char* argv[]) {
1189
1190 const char *context[_CONTEXT_MAX];
1191 struct iovec iovec[27];
1192 size_t n_iovec = 0, i, n_to_free;
1193 int r;
1194
1195 if (argc < CONTEXT_COMM + 1) {
1196 log_error("Not enough arguments passed from kernel (%i, expected %i).", argc - 1, CONTEXT_COMM + 1 - 1);
1197 return -EINVAL;
1198 }
1199
1200 context[CONTEXT_PID] = argv[CONTEXT_PID + 1];
1201 context[CONTEXT_UID] = argv[CONTEXT_UID + 1];
1202 context[CONTEXT_GID] = argv[CONTEXT_GID + 1];
1203 context[CONTEXT_SIGNAL] = argv[CONTEXT_SIGNAL + 1];
1204 context[CONTEXT_TIMESTAMP] = argv[CONTEXT_TIMESTAMP + 1];
1205 context[CONTEXT_RLIMIT] = argv[CONTEXT_RLIMIT + 1];
1206
1207 r = gather_pid_metadata(context, argv + CONTEXT_COMM + 1, iovec, &n_iovec);
1208 if (r < 0)
1209 goto finish;
1210 n_to_free = n_iovec;
1211
1212 IOVEC_SET_STRING(iovec[n_iovec++], "MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1");
1213
1214 assert_cc(2 == LOG_CRIT);
1215 IOVEC_SET_STRING(iovec[n_iovec++], "PRIORITY=2");
1216
1217 assert(n_iovec <= ELEMENTSOF(iovec));
1218
1219 r = send_iovec(iovec, n_iovec, STDIN_FILENO);
1220
1221 finish:
1222 for (i = 0; i < n_to_free; i++)
1223 free(iovec[i].iov_base);
1224
1225 return r;
1226 }
1227
1228 int main(int argc, char *argv[]) {
1229 int r;
1230
1231 /* First, log to a safe place, since we don't know what crashed and it might
1232 * be journald which we'd rather not log to then. */
1233
1234 log_set_target(LOG_TARGET_KMSG);
1235 log_open();
1236
1237 /* Make sure we never enter a loop */
1238 (void) prctl(PR_SET_DUMPABLE, 0);
1239
1240 /* Ignore all parse errors */
1241 (void) parse_config();
1242
1243 log_debug("Selected storage '%s'.", coredump_storage_to_string(arg_storage));
1244 log_debug("Selected compression %s.", yes_no(arg_compress));
1245
1246 r = sd_listen_fds(false);
1247 if (r < 0) {
1248 log_error_errno(r, "Failed to determine number of file descriptor: %m");
1249 goto finish;
1250 }
1251
1252 /* If we got an fd passed, we are running in coredumpd mode. Otherwise we
1253 * are invoked from the kernel as coredump handler. */
1254 if (r == 0)
1255 r = process_kernel(argc, argv);
1256 else if (r == 1)
1257 r = process_socket(SD_LISTEN_FDS_START);
1258 else {
1259 log_error("Received unexpected number of file descriptors.");
1260 r = -EINVAL;
1261 }
1262
1263 finish:
1264 return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;
1265 }