2 This file is part of systemd.
4 Copyright 2012 Lennart Poettering
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.
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.
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/>.
22 #include <sys/prctl.h>
23 #include <sys/xattr.h>
28 #include <elfutils/libdwfl.h>
31 #include "sd-daemon.h"
32 #include "sd-journal.h"
34 #include "sd-messages.h"
37 #include "alloc-util.h"
38 #include "capability-util.h"
39 #include "cgroup-util.h"
41 #include "conf-parser.h"
43 #include "coredump-vacuum.h"
44 #include "dirent-util.h"
50 #include "journal-importer.h"
55 #include "parse-util.h"
56 #include "process-util.h"
57 #include "socket-util.h"
59 #include "stacktrace.h"
60 #include "string-table.h"
61 #include "string-util.h"
63 #include "user-util.h"
66 /* The maximum size up to which we process coredumps */
67 #define PROCESS_SIZE_MAX ((uint64_t) (2LLU*1024LLU*1024LLU*1024LLU))
69 /* The maximum size up to which we leave the coredump around on disk */
70 #define EXTERNAL_SIZE_MAX PROCESS_SIZE_MAX
72 /* The maximum size up to which we store the coredump in the journal */
73 #define JOURNAL_SIZE_MAX ((size_t) (767LU*1024LU*1024LU))
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
);
80 /* We use this as array indexes for a couple of special fields we use for naming coredumping files, and
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
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",
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");
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;
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
},
130 return config_parse_many_nulstr(PKGSYSCONFDIR
"/coredump.conf",
131 CONF_PATHS_NULSTR("systemd/coredump.conf.d"),
133 config_item_table_lookup
, items
,
137 static inline uint64_t storage_size_max(void) {
138 return arg_storage
== COREDUMP_STORAGE_EXTERNAL
? arg_external_size_max
: arg_journal_size_max
;
141 static int fix_acl(int fd
, uid_t uid
) {
144 _cleanup_(acl_freep
) acl_t acl
= NULL
;
146 acl_permset_t permset
;
151 if (uid
<= SYSTEM_UID_MAX
)
154 /* Make sure normal users can read (but not write or delete)
155 * their own coredumps */
157 acl
= acl_get_fd(fd
);
159 return log_error_errno(errno
, "Failed to get ACL: %m");
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");
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");
170 r
= calc_acl_mask_if_needed(&acl
);
172 return log_warning_errno(r
, "Failed to patch ACL: %m");
174 if (acl_set_fd(fd
, acl
) < 0)
175 return log_error_errno(errno
, "Failed to apply ACL: %m");
181 static int fix_xattr(int fd
, const char *context
[_CONTEXT_MAX
]) {
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",
198 /* Attach some metadata to coredumps via extended
199 * attributes. Just because we can. */
201 for (i
= 0; i
< _CONTEXT_MAX
; i
++) {
204 if (isempty(context
[i
]) || !xattrs
[i
])
207 k
= fsetxattr(fd
, xattrs
[i
], context
[i
], strlen(context
[i
]), XATTR_CREATE
);
215 #define filename_escape(s) xescape((s), "./ ")
217 static inline const char *coredump_tmpfile_name(const char *s
) {
218 return s
? s
: "(unnamed temporary file)";
221 static int fix_permissions(
223 const char *filename
,
225 const char *context
[_CONTEXT_MAX
],
234 /* Ignore errors on these */
235 (void) fchmod(fd
, 0640);
236 (void) fix_acl(fd
, uid
);
237 (void) fix_xattr(fd
, context
);
240 return log_error_errno(errno
, "Failed to sync coredump %s: %m", coredump_tmpfile_name(filename
));
242 r
= link_tmpfile(fd
, filename
, target
);
244 return log_error_errno(r
, "Failed to move coredump %s into place: %m", target
);
249 static int maybe_remove_external_coredump(const char *filename
, uint64_t size
) {
251 /* Returns 1 if might remove, 0 if will not remove, < 0 on error. */
253 if (arg_storage
== COREDUMP_STORAGE_EXTERNAL
&&
254 size
<= arg_external_size_max
)
260 if (unlink(filename
) < 0 && errno
!= ENOENT
)
261 return log_error_errno(errno
, "Failed to unlink %s: %m", filename
);
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
= {};
273 c
= filename_escape(context
[CONTEXT_COMM
]);
277 u
= filename_escape(context
[CONTEXT_UID
]);
281 r
= sd_id128_get_boot(&boot
);
285 p
= filename_escape(context
[CONTEXT_PID
]);
289 t
= filename_escape(context
[CONTEXT_TIMESTAMP
]);
294 "/var/lib/systemd/coredump/core.%s.%s." SD_ID128_FORMAT_STR
".%s.%s000000",
297 SD_ID128_FORMAT_VAL(boot
),
305 static int save_external_coredump(
306 const char *context
[_CONTEXT_MAX
],
311 uint64_t *ret_size
) {
313 _cleanup_free_
char *fn
= NULL
, *tmp
= NULL
;
314 _cleanup_close_
int fd
= -1;
315 uint64_t rlimit
, max_size
;
321 assert(ret_filename
);
326 r
= parse_uid(context
[CONTEXT_UID
], &uid
);
328 return log_error_errno(r
, "Failed to parse UID: %m");
330 r
= safe_atou64(context
[CONTEXT_RLIMIT
], &rlimit
);
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
]);
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()));
345 r
= make_filename(context
, &fn
);
347 return log_error_errno(r
, "Failed to determine coredump file name: %m");
349 mkdir_p_label("/var/lib/systemd/coredump", 0755);
351 fd
= open_tmpfile_linkable(fn
, O_RDWR
|O_CLOEXEC
, &tmp
);
353 return log_error_errno(fd
, "Failed to create temporary file for coredump %s: %m", fn
);
355 r
= copy_bytes(input_fd
, fd
, max_size
, false);
357 log_error_errno(r
, "Cannot store coredump of %s (%s): %m", context
[CONTEXT_PID
], context
[CONTEXT_COMM
]);
361 LOG_MESSAGE("Core file was truncated to %zu bytes.", max_size
),
362 "SIZE_LIMIT=%zu", max_size
,
363 "MESSAGE_ID=" SD_MESSAGE_TRUNCATED_CORE_STR
,
366 if (fstat(fd
, &st
) < 0) {
367 log_error_errno(errno
, "Failed to fstat core file %s: %m", coredump_tmpfile_name(tmp
));
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
));
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
)) {
380 _cleanup_free_
char *fn_compressed
= NULL
, *tmp_compressed
= NULL
;
381 _cleanup_close_
int fd_compressed
= -1;
383 fn_compressed
= strappend(fn
, COMPRESSED_EXT
);
384 if (!fn_compressed
) {
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
);
395 r
= compress_stream(fd
, fd_compressed
, -1);
397 log_error_errno(r
, "Failed to compress %s: %m", coredump_tmpfile_name(tmp_compressed
));
398 goto fail_compressed
;
401 r
= fix_permissions(fd_compressed
, tmp_compressed
, fn_compressed
, context
, uid
);
403 goto fail_compressed
;
405 /* OK, this worked, we can get rid of the uncompressed version now */
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 */
414 fn_compressed
= NULL
;
415 fd
= fd_compressed
= -1;
421 (void) unlink(tmp_compressed
);
427 r
= fix_permissions(fd
, tmp
, fn
, context
, uid
);
434 *ret_size
= (uint64_t) st
.st_size
;
447 static int allocate_journal_field(int fd
, size_t size
, char **ret
, size_t *ret_size
) {
448 _cleanup_free_
char *field
= NULL
;
455 if (lseek(fd
, 0, SEEK_SET
) == (off_t
) -1)
456 return log_warning_errno(errno
, "Failed to seek: %m");
458 field
= malloc(9 + size
);
460 log_warning("Failed to allocate memory for coredump, coredump will not be stored.");
464 memcpy(field
, "COREDUMP=", 9);
466 n
= read(fd
, field
+ 9, size
);
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.");
475 *ret_size
= size
+ 9;
482 /* Joins /proc/[pid]/fd/ and /proc/[pid]/fdinfo/ into the following lines:
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
;
507 assert(open_fds
!= NULL
);
509 path
= procfs_file_alloca(pid
, "fd");
510 proc_fd_dir
= opendir(path
);
514 proc_fdinfo_fd
= openat(dirfd(proc_fd_dir
), "../fdinfo", O_DIRECTORY
|O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
515 if (proc_fdinfo_fd
< 0)
518 stream
= open_memstream(&buffer
, &size
);
522 FOREACH_DIRENT(dent
, proc_fd_dir
, return -errno
) {
523 _cleanup_fclose_
FILE *fdinfo
= NULL
;
524 _cleanup_free_
char *fdname
= NULL
;
528 r
= readlinkat_malloc(dirfd(proc_fd_dir
), dent
->d_name
, &fdname
);
532 fprintf(stream
, "%s%s:%s\n", fddelim
, dent
->d_name
, fdname
);
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
);
540 fdinfo
= fdopen(fd
, "re");
541 if (fdinfo
== NULL
) {
546 FOREACH_LINE(line
, fdinfo
, break) {
548 if (!endswith(line
, "\n"))
554 stream
= safe_fclose(stream
);
565 static int get_process_ns(pid_t pid
, const char *namespace, ino_t
*ns
) {
568 _cleanup_close_
int proc_ns_dir_fd
;
570 p
= procfs_file_alloca(pid
, "ns");
572 proc_ns_dir_fd
= open(p
, O_DIRECTORY
| O_CLOEXEC
| O_RDONLY
);
573 if (proc_ns_dir_fd
< 0)
576 if (fstatat(proc_ns_dir_fd
, namespace, &stbuf
, /* flags */0) < 0)
583 static int get_mount_namespace_leader(pid_t pid
, pid_t
*container_pid
) {
584 pid_t cpid
= pid
, ppid
= 0;
588 r
= get_process_ns(pid
, "mnt", &proc_mntns
);
595 r
= get_process_ppid(cpid
, &ppid
);
599 r
= get_process_ns(ppid
, "mnt", &parent_mntns
);
603 if (proc_mntns
!= parent_mntns
)
612 *container_pid
= ppid
;
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.
621 static int get_process_container_parent_cmdline(pid_t pid
, char** cmdline
) {
624 const char *proc_root_path
;
625 struct stat root_stat
, proc_root_stat
;
627 /* To compare inodes of / and /proc/[pid]/root */
628 if (stat("/", &root_stat
) < 0)
631 proc_root_path
= procfs_file_alloca(pid
, "root");
632 if (stat(proc_root_path
, &proc_root_stat
) < 0)
635 /* The process uses system root. */
636 if (proc_root_stat
.st_ino
== root_stat
.st_ino
) {
641 r
= get_mount_namespace_leader(pid
, &container_pid
);
645 r
= get_process_cmdline(container_pid
, 0, false, cmdline
);
652 static int change_uid_gid(const char *context
[]) {
657 r
= parse_uid(context
[CONTEXT_UID
], &uid
);
661 if (uid
<= SYSTEM_UID_MAX
) {
662 const char *user
= "systemd-coredump";
664 r
= get_user_creds(&user
, &uid
, &gid
, NULL
, NULL
);
666 log_warning_errno(r
, "Cannot resolve %s user. Proceeding to dump core as root: %m", user
);
670 r
= parse_gid(context
[CONTEXT_GID
], &gid
);
675 return drop_privileges(uid
, gid
, 0);
678 static int submit_coredump(
679 const char *context
[_CONTEXT_MAX
],
681 size_t n_iovec_allocated
,
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
;
692 assert(n_iovec_allocated
>= n_iovec
+ 3);
693 assert(input_fd
>= 0);
695 /* Vacuum before we write anything again */
696 (void) coredump_vacuum(-1, arg_keep_free
, arg_max_use
);
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
);
701 /* Skip whole core dumping part */
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
);
710 const char *coredump_filename
;
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
);
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
);
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
);
727 return log_error_errno(r
, "Failed to drop privileges: %m");
730 /* Try to get a strack trace if we can */
731 if (coredump_size
<= arg_process_size_max
) {
732 _cleanup_free_
char *stacktrace
= NULL
;
734 r
= coredump_make_stack_trace(coredump_fd
, context
[CONTEXT_EXE
], &stacktrace
);
736 core_message
= strjoin("MESSAGE=Process ", context
[CONTEXT_PID
],
737 " (", context
[CONTEXT_COMM
], ") of user ",
738 context
[CONTEXT_UID
], " dumped core.\n\n",
740 else if (r
== -EINVAL
)
741 log_warning("Failed to generate stack trace: %s", dwfl_errmsg(dwfl_errno()));
743 log_warning_errno(r
, "Failed to generate stack trace: %m");
745 log_debug("Not generating stack trace: core size %"PRIu64
" is greater than %"PRIu64
" (the configured maximum)",
746 coredump_size
, arg_process_size_max
);
751 core_message
= strjoin("MESSAGE=Process ", context
[CONTEXT_PID
], " (",
752 context
[CONTEXT_COMM
], ") of user ",
753 context
[CONTEXT_UID
], " dumped core.");
755 IOVEC_SET_STRING(iovec
[n_iovec
++], core_message
);
757 /* Optionally store the entire coredump in the journal */
758 if (arg_storage
== COREDUMP_STORAGE_JOURNAL
) {
759 if (coredump_size
<= arg_journal_size_max
) {
762 /* Store the coredump itself in the journal */
764 r
= allocate_journal_field(coredump_fd
, (size_t) coredump_size
, &coredump_data
, &sz
);
766 iovec
[n_iovec
].iov_base
= coredump_data
;
767 iovec
[n_iovec
].iov_len
= sz
;
770 log_warning_errno(r
, "Failed to attach the core to the journal entry: %m");
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
);
776 assert(n_iovec
<= n_iovec_allocated
);
778 r
= sd_journal_sendv(iovec
, n_iovec
);
780 return log_error_errno(r
, "Failed to log coredump: %m");
785 static void map_context_fields(const struct iovec
*iovec
, const char *context
[]) {
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=",
803 for (i
= 0; i
< _CONTEXT_MAX
; i
++) {
806 l
= strlen(context_field_names
[i
]);
807 if (iovec
->iov_len
< l
)
810 if (memcmp(iovec
->iov_base
, context_field_names
[i
], l
) != 0)
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
;
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_allocated
= 0, i
;
824 const char *context
[_CONTEXT_MAX
] = {};
829 log_set_target(LOG_TARGET_AUTO
);
830 log_parse_environment();
833 log_debug("Processing coredump received on stdin...");
837 struct cmsghdr cmsghdr
;
838 uint8_t buf
[CMSG_SPACE(sizeof(int))];
841 .msg_control
= &control
,
842 .msg_controllen
= sizeof(control
),
848 if (!GREEDY_REALLOC(iovec
, n_allocated
, n_iovec
+ 3)) {
853 l
= next_datagram_size_fd(fd
);
855 r
= log_error_errno(l
, "Failed to determine datagram size to read: %m");
861 iovec
[n_iovec
].iov_len
= l
;
862 iovec
[n_iovec
].iov_base
= malloc(l
+ 1);
863 if (!iovec
[n_iovec
].iov_base
) {
868 mh
.msg_iov
= iovec
+ n_iovec
;
870 n
= recvmsg(fd
, &mh
, MSG_NOSIGNAL
|MSG_CMSG_CLOEXEC
);
872 free(iovec
[n_iovec
].iov_base
);
873 r
= log_error_errno(errno
, "Failed to receive datagram: %m");
878 struct cmsghdr
*cmsg
, *found
= NULL
;
879 /* The final zero-length datagram carries the file descriptor and tells us that we're done. */
881 free(iovec
[n_iovec
].iov_base
);
883 CMSG_FOREACH(cmsg
, &mh
) {
884 if (cmsg
->cmsg_level
== SOL_SOCKET
&&
885 cmsg
->cmsg_type
== SCM_RIGHTS
&&
886 cmsg
->cmsg_len
== CMSG_LEN(sizeof(int))) {
893 log_error("Coredump file descriptor missing.");
898 assert(coredump_fd
< 0);
899 coredump_fd
= *(int*) CMSG_DATA(found
);
903 /* Add trailing NUL byte, in case these are strings */
904 ((char*) iovec
[n_iovec
].iov_base
)[n
] = 0;
905 iovec
[n_iovec
].iov_len
= (size_t) n
;
908 map_context_fields(iovec
+ n_iovec
, context
);
912 if (!GREEDY_REALLOC(iovec
, n_allocated
, n_iovec
+ 3)) {
917 /* Make sure we got all data we really need */
918 assert(context
[CONTEXT_PID
]);
919 assert(context
[CONTEXT_UID
]);
920 assert(context
[CONTEXT_GID
]);
921 assert(context
[CONTEXT_SIGNAL
]);
922 assert(context
[CONTEXT_TIMESTAMP
]);
923 assert(context
[CONTEXT_RLIMIT
]);
924 assert(context
[CONTEXT_COMM
]);
925 assert(coredump_fd
>= 0);
927 r
= submit_coredump(context
, iovec
, n_allocated
, n_iovec
, coredump_fd
);
930 for (i
= 0; i
< n_iovec
; i
++)
931 free(iovec
[i
].iov_base
);
937 static int send_iovec(const struct iovec iovec
[], size_t n_iovec
, int input_fd
) {
939 static const union sockaddr_union sa
= {
940 .un
.sun_family
= AF_UNIX
,
941 .un
.sun_path
= "/run/systemd/coredump",
943 _cleanup_close_
int fd
= -1;
947 assert(iovec
|| n_iovec
<= 0);
948 assert(input_fd
>= 0);
950 fd
= socket(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0);
952 return log_error_errno(errno
, "Failed to create coredump socket: %m");
954 if (connect(fd
, &sa
.sa
, SOCKADDR_UN_LEN(sa
.un
)) < 0)
955 return log_error_errno(errno
, "Failed to connect to coredump service: %m");
957 for (i
= 0; i
< n_iovec
; i
++) {
959 .msg_iov
= (struct iovec
*) iovec
+ i
,
962 struct iovec copy
[2];
965 if (sendmsg(fd
, &mh
, MSG_NOSIGNAL
) >= 0)
968 if (errno
== EMSGSIZE
&& mh
.msg_iov
[0].iov_len
> 0) {
969 /* This field didn't fit? That's a pity. Given that this is just metadata,
970 * let's truncate the field at half, and try again. We append three dots, in
971 * order to show that this is truncated. */
973 if (mh
.msg_iov
!= copy
) {
974 /* We don't want to modify the caller's iovec, hence let's create our
975 * own array, consisting of two new iovecs, where the first is a
976 * (truncated) copy of what we want to send, and the second one
977 * contains the trailing dots. */
979 copy
[1] = (struct iovec
) {
980 .iov_base
= (char[]) { '.', '.', '.' },
988 copy
[0].iov_len
/= 2; /* halve it, and try again */
992 return log_error_errno(errno
, "Failed to send coredump datagram: %m");
996 r
= send_one_fd(fd
, input_fd
, 0);
998 return log_error_errno(r
, "Failed to send coredump fd: %m");
1003 static int process_special_crash(const char *context
[], int input_fd
) {
1004 _cleanup_close_
int coredump_fd
= -1, coredump_node_fd
= -1;
1005 _cleanup_free_
char *filename
= NULL
;
1006 uint64_t coredump_size
;
1010 assert(input_fd
>= 0);
1012 /* If we are pid1 or journald, we cut things short, don't write to the journal, but still create a coredump. */
1014 if (arg_storage
!= COREDUMP_STORAGE_NONE
)
1015 arg_storage
= COREDUMP_STORAGE_EXTERNAL
;
1017 r
= save_external_coredump(context
, input_fd
, &filename
, &coredump_node_fd
, &coredump_fd
, &coredump_size
);
1021 r
= maybe_remove_external_coredump(filename
, coredump_size
);
1025 log_notice("Detected coredump of the journal daemon or PID 1, diverted to %s.", filename
);
1030 static char* set_iovec_field(struct iovec iovec
[27], size_t *n_iovec
, const char *field
, const char *value
) {
1033 x
= strappend(field
, value
);
1035 IOVEC_SET_STRING(iovec
[(*n_iovec
)++], x
);
1039 static char* set_iovec_field_free(struct iovec iovec
[27], size_t *n_iovec
, const char *field
, char *value
) {
1042 x
= set_iovec_field(iovec
, n_iovec
, field
, value
);
1047 static int gather_pid_metadata(
1048 const char *context
[_CONTEXT_MAX
],
1049 char **comm_fallback
,
1051 struct iovec
*iovec
, size_t *n_iovec
) {
1052 /* We need 25 empty slots in iovec!
1053 * Note that if we fail on oom later on, we do not roll-back changes to the iovec
1054 * structure. (It remains valid, with the first n_iovec fields initialized.) */
1056 _cleanup_free_
char *exe
= NULL
, *comm
= NULL
;
1063 r
= parse_pid(context
[CONTEXT_PID
], &pid
);
1065 return log_error_errno(r
, "Failed to parse PID \"%s\": %m", context
[CONTEXT_PID
]);
1067 r
= get_process_comm(pid
, &comm
);
1069 log_warning_errno(r
, "Failed to get COMM, falling back to the command line: %m");
1070 comm
= strv_join(comm_fallback
, " ");
1075 r
= get_process_exe(pid
, &exe
);
1077 log_warning_errno(r
, "Failed to get EXE, ignoring: %m");
1079 if (cg_pid_get_unit(pid
, &t
) >= 0) {
1081 /* If this is PID 1 disable coredump collection, we'll unlikely be able to process it later on. */
1082 if (streq(t
, SPECIAL_INIT_SCOPE
)) {
1083 log_notice("Due to PID 1 having crashed coredump collection will now be turned off.");
1084 (void) write_string_file("/proc/sys/kernel/core_pattern", "|/bin/false", 0);
1087 /* Let's avoid dead-locks when processing journald and init crashes, as socket activation and logging
1088 * are unlikely to work then. */
1089 if (STR_IN_SET(t
, SPECIAL_JOURNALD_SERVICE
, SPECIAL_INIT_SCOPE
)) {
1091 return process_special_crash(context
, STDIN_FILENO
);
1094 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_UNIT=", t
);
1097 /* OK, now we know it's not the journal, hence we can make use of it now. */
1098 log_set_target(LOG_TARGET_JOURNAL_OR_KMSG
);
1101 if (cg_pid_get_user_unit(pid
, &t
) >= 0)
1102 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_USER_UNIT=", t
);
1104 /* The next few are mandatory */
1105 if (!set_iovec_field(iovec
, n_iovec
, "COREDUMP_PID=", context
[CONTEXT_PID
]))
1108 if (!set_iovec_field(iovec
, n_iovec
, "COREDUMP_UID=", context
[CONTEXT_UID
]))
1111 if (!set_iovec_field(iovec
, n_iovec
, "COREDUMP_GID=", context
[CONTEXT_GID
]))
1114 if (!set_iovec_field(iovec
, n_iovec
, "COREDUMP_SIGNAL=", context
[CONTEXT_SIGNAL
]))
1117 if (!set_iovec_field(iovec
, n_iovec
, "COREDUMP_RLIMIT=", context
[CONTEXT_RLIMIT
]))
1120 if (!set_iovec_field(iovec
, n_iovec
, "COREDUMP_COMM=", comm
))
1124 !set_iovec_field(iovec
, n_iovec
, "COREDUMP_EXE=", exe
))
1127 if (sd_pid_get_session(pid
, &t
) >= 0)
1128 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_SESSION=", t
);
1130 if (sd_pid_get_owner_uid(pid
, &owner_uid
) >= 0) {
1131 r
= asprintf(&t
, "COREDUMP_OWNER_UID=" UID_FMT
, owner_uid
);
1133 IOVEC_SET_STRING(iovec
[(*n_iovec
)++], t
);
1136 if (sd_pid_get_slice(pid
, &t
) >= 0)
1137 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_SLICE=", t
);
1139 if (get_process_cmdline(pid
, 0, false, &t
) >= 0)
1140 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_CMDLINE=", t
);
1142 if (cg_pid_get_path_shifted(pid
, NULL
, &t
) >= 0)
1143 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_CGROUP=", t
);
1145 if (compose_open_fds(pid
, &t
) >= 0)
1146 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_OPEN_FDS=", t
);
1148 p
= procfs_file_alloca(pid
, "status");
1149 if (read_full_file(p
, &t
, NULL
) >= 0)
1150 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_PROC_STATUS=", t
);
1152 p
= procfs_file_alloca(pid
, "maps");
1153 if (read_full_file(p
, &t
, NULL
) >= 0)
1154 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_PROC_MAPS=", t
);
1156 p
= procfs_file_alloca(pid
, "limits");
1157 if (read_full_file(p
, &t
, NULL
) >= 0)
1158 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_PROC_LIMITS=", t
);
1160 p
= procfs_file_alloca(pid
, "cgroup");
1161 if (read_full_file(p
, &t
, NULL
) >=0)
1162 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_PROC_CGROUP=", t
);
1164 p
= procfs_file_alloca(pid
, "mountinfo");
1165 if (read_full_file(p
, &t
, NULL
) >=0)
1166 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_PROC_MOUNTINFO=", t
);
1168 if (get_process_cwd(pid
, &t
) >= 0)
1169 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_CWD=", t
);
1171 if (get_process_root(pid
, &t
) >= 0) {
1172 bool proc_self_root_is_slash
;
1174 proc_self_root_is_slash
= strcmp(t
, "/") == 0;
1176 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_ROOT=", t
);
1178 /* If the process' root is "/", then there is a chance it has
1179 * mounted own root and hence being containerized. */
1180 if (proc_self_root_is_slash
&& get_process_container_parent_cmdline(pid
, &t
) > 0)
1181 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_CONTAINER_CMDLINE=", t
);
1184 if (get_process_environ(pid
, &t
) >= 0)
1185 set_iovec_field_free(iovec
, n_iovec
, "COREDUMP_ENVIRON=", t
);
1187 t
= strjoin("COREDUMP_TIMESTAMP=", context
[CONTEXT_TIMESTAMP
], "000000", NULL
);
1189 IOVEC_SET_STRING(iovec
[(*n_iovec
)++], t
);
1199 static int process_kernel(int argc
, char* argv
[]) {
1201 const char *context
[_CONTEXT_MAX
];
1202 struct iovec iovec
[27];
1203 size_t i
, n_iovec
, n_to_free
= 0;
1206 log_debug("Processing coredump received from the kernel...");
1208 if (argc
< CONTEXT_COMM
+ 1) {
1209 log_error("Not enough arguments passed by the kernel (%i, expected %i).", argc
- 1, CONTEXT_COMM
+ 1 - 1);
1213 context
[CONTEXT_PID
] = argv
[CONTEXT_PID
+ 1];
1214 context
[CONTEXT_UID
] = argv
[CONTEXT_UID
+ 1];
1215 context
[CONTEXT_GID
] = argv
[CONTEXT_GID
+ 1];
1216 context
[CONTEXT_SIGNAL
] = argv
[CONTEXT_SIGNAL
+ 1];
1217 context
[CONTEXT_TIMESTAMP
] = argv
[CONTEXT_TIMESTAMP
+ 1];
1218 context
[CONTEXT_RLIMIT
] = argv
[CONTEXT_RLIMIT
+ 1];
1220 r
= gather_pid_metadata(context
, argv
+ CONTEXT_COMM
+ 1, NULL
, iovec
, &n_to_free
);
1223 n_iovec
= n_to_free
;
1225 IOVEC_SET_STRING(iovec
[n_iovec
++], "MESSAGE_ID=" SD_MESSAGE_COREDUMP_STR
);
1227 assert_cc(2 == LOG_CRIT
);
1228 IOVEC_SET_STRING(iovec
[n_iovec
++], "PRIORITY=2");
1230 assert(n_iovec
<= ELEMENTSOF(iovec
));
1232 r
= send_iovec(iovec
, n_iovec
, STDIN_FILENO
);
1235 for (i
= 0; i
< n_to_free
; i
++)
1236 free(iovec
[i
].iov_base
);
1241 static int process_backtrace(int argc
, char *argv
[]) {
1242 const char *context
[_CONTEXT_MAX
];
1243 _cleanup_free_
char *comm
= NULL
, *message
= NULL
;
1244 _cleanup_free_
struct iovec
*iovec
= NULL
;
1245 size_t n_iovec
, n_allocated
, n_to_free
= 0, i
;
1247 JournalImporter importer
= {
1251 log_debug("Processing backtrace on stdin...");
1253 if (argc
< CONTEXT_COMM
+ 1) {
1254 log_error("Not enough arguments passed (%i, expected %i).", argc
- 1, CONTEXT_COMM
+ 1 - 1);
1258 context
[CONTEXT_PID
] = argv
[CONTEXT_PID
+ 2];
1259 context
[CONTEXT_UID
] = argv
[CONTEXT_UID
+ 2];
1260 context
[CONTEXT_GID
] = argv
[CONTEXT_GID
+ 2];
1261 context
[CONTEXT_SIGNAL
] = argv
[CONTEXT_SIGNAL
+ 2];
1262 context
[CONTEXT_TIMESTAMP
] = argv
[CONTEXT_TIMESTAMP
+ 2];
1263 context
[CONTEXT_RLIMIT
] = argv
[CONTEXT_RLIMIT
+ 2];
1265 n_allocated
= 32; /* 25 metadata, 2 static, +unknown input, rounded up */
1266 iovec
= new(struct iovec
, n_allocated
);
1270 r
= gather_pid_metadata(context
, argv
+ CONTEXT_COMM
+ 2, &comm
, iovec
, &n_to_free
);
1273 n_iovec
= n_to_free
;
1276 r
= journal_importer_process_data(&importer
);
1278 log_error_errno(r
, "Failed to parse journal entry on stdin: %m");
1285 if (!GREEDY_REALLOC(iovec
, n_allocated
, n_iovec
+ importer
.iovw
.count
+ 2))
1288 if (journal_importer_eof(&importer
)) {
1289 log_warning("Did not receive a full journal entry on stdin, ignoring message sent by reporter");
1291 message
= strjoin("MESSAGE=Process ", context
[CONTEXT_PID
], " (", comm
, ")"
1292 " of user ", context
[CONTEXT_UID
],
1293 " failed with ", context
[CONTEXT_SIGNAL
]);
1298 IOVEC_SET_STRING(iovec
[n_iovec
++], message
);
1300 for (i
= 0; i
< importer
.iovw
.count
; i
++)
1301 iovec
[n_iovec
++] = importer
.iovw
.iovec
[i
];
1304 IOVEC_SET_STRING(iovec
[n_iovec
++], "MESSAGE_ID=" SD_MESSAGE_BACKTRACE_STR
);
1305 assert_cc(2 == LOG_CRIT
);
1306 IOVEC_SET_STRING(iovec
[n_iovec
++], "PRIORITY=2");
1308 assert(n_iovec
<= n_allocated
);
1310 r
= sd_journal_sendv(iovec
, n_iovec
);
1312 log_error_errno(r
, "Failed to log backtrace: %m");
1315 for (i
= 0; i
< n_to_free
; i
++)
1316 free(iovec
[i
].iov_base
);
1321 int main(int argc
, char *argv
[]) {
1324 /* First, log to a safe place, since we don't know what crashed and it might
1325 * be journald which we'd rather not log to then. */
1327 log_set_target(LOG_TARGET_KMSG
);
1330 /* Make sure we never enter a loop */
1331 (void) prctl(PR_SET_DUMPABLE
, 0);
1333 /* Ignore all parse errors */
1334 (void) parse_config();
1336 log_debug("Selected storage '%s'.", coredump_storage_to_string(arg_storage
));
1337 log_debug("Selected compression %s.", yes_no(arg_compress
));
1339 r
= sd_listen_fds(false);
1341 log_error_errno(r
, "Failed to determine number of file descriptor: %m");
1345 /* If we got an fd passed, we are running in coredumpd mode. Otherwise we
1346 * are invoked from the kernel as coredump handler. */
1348 if (streq_ptr(argv
[1], "--backtrace"))
1349 r
= process_backtrace(argc
, argv
);
1351 r
= process_kernel(argc
, argv
);
1353 r
= process_socket(SD_LISTEN_FDS_START
);
1355 log_error("Received unexpected number of file descriptors.");
1360 return r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
;