1 #include <linux/slab.h>
2 #include <linux/file.h>
3 #include <linux/fdtable.h>
4 #include <linux/freezer.h>
6 #include <linux/stat.h>
7 #include <linux/fcntl.h>
8 #include <linux/swap.h>
9 #include <linux/string.h>
10 #include <linux/init.h>
11 #include <linux/pagemap.h>
12 #include <linux/perf_event.h>
13 #include <linux/highmem.h>
14 #include <linux/spinlock.h>
15 #include <linux/key.h>
16 #include <linux/personality.h>
17 #include <linux/binfmts.h>
18 #include <linux/coredump.h>
19 #include <linux/utsname.h>
20 #include <linux/pid_namespace.h>
21 #include <linux/module.h>
22 #include <linux/namei.h>
23 #include <linux/mount.h>
24 #include <linux/security.h>
25 #include <linux/syscalls.h>
26 #include <linux/tsacct_kern.h>
27 #include <linux/cn_proc.h>
28 #include <linux/audit.h>
29 #include <linux/tracehook.h>
30 #include <linux/kmod.h>
31 #include <linux/fsnotify.h>
32 #include <linux/fs_struct.h>
33 #include <linux/pipe_fs_i.h>
34 #include <linux/oom.h>
35 #include <linux/compat.h>
36 #include <linux/sched.h>
38 #include <linux/path.h>
39 #include <linux/timekeeping.h>
41 #include <linux/uaccess.h>
42 #include <asm/mmu_context.h>
46 #include <trace/events/task.h>
49 #include <trace/events/sched.h>
52 unsigned int core_pipe_limit;
53 char core_pattern[CORENAME_MAX_SIZE] = "core";
54 static int core_name_size = CORENAME_MAX_SIZE;
61 /* The maximal length of core_pattern is also specified in sysctl.c */
63 static int expand_corename(struct core_name *cn, int size)
65 char *corename = krealloc(cn->corename, size, GFP_KERNEL);
70 if (size > core_name_size) /* racy but harmless */
71 core_name_size = size;
73 cn->size = ksize(corename);
74 cn->corename = corename;
78 static __printf(2, 0) int cn_vprintf(struct core_name *cn, const char *fmt,
85 free = cn->size - cn->used;
87 va_copy(arg_copy, arg);
88 need = vsnprintf(cn->corename + cn->used, free, fmt, arg_copy);
96 if (!expand_corename(cn, cn->size + need - free + 1))
102 static __printf(2, 3) int cn_printf(struct core_name *cn, const char *fmt, ...)
108 ret = cn_vprintf(cn, fmt, arg);
114 static __printf(2, 3)
115 int cn_esc_printf(struct core_name *cn, const char *fmt, ...)
122 ret = cn_vprintf(cn, fmt, arg);
127 * Ensure that this coredump name component can't cause the
128 * resulting corefile path to consist of a ".." or ".".
130 if ((cn->used - cur == 1 && cn->corename[cur] == '.') ||
131 (cn->used - cur == 2 && cn->corename[cur] == '.'
132 && cn->corename[cur+1] == '.'))
133 cn->corename[cur] = '!';
136 * Empty names are fishy and could be used to create a "//" in a
137 * corefile name, causing the coredump to happen one directory
138 * level too high. Enforce that all components of the core
139 * pattern are at least one character long.
142 ret = cn_printf(cn, "!");
145 for (; cur < cn->used; ++cur) {
146 if (cn->corename[cur] == '/')
147 cn->corename[cur] = '!';
152 static int cn_print_exe_file(struct core_name *cn)
154 struct file *exe_file;
155 char *pathbuf, *path;
158 exe_file = get_mm_exe_file(current->mm);
160 return cn_esc_printf(cn, "%s (path unknown)", current->comm);
162 pathbuf = kmalloc(PATH_MAX, GFP_TEMPORARY);
168 path = file_path(exe_file, pathbuf, PATH_MAX);
174 ret = cn_esc_printf(cn, "%s", path);
183 /* format_corename will inspect the pattern parameter, and output a
184 * name into corename, which must have space for at least
185 * CORENAME_MAX_SIZE bytes plus one byte for the zero terminator.
187 static int format_corename(struct core_name *cn, struct coredump_params *cprm)
189 const struct cred *cred = current_cred();
190 const char *pat_ptr = core_pattern;
191 int ispipe = (*pat_ptr == '|');
192 int pid_in_pattern = 0;
197 if (expand_corename(cn, core_name_size))
199 cn->corename[0] = '\0';
204 /* Repeat as long as we have more pattern to process and more output
207 if (*pat_ptr != '%') {
208 err = cn_printf(cn, "%c", *pat_ptr++);
210 switch (*++pat_ptr) {
211 /* single % at the end, drop that */
214 /* Double percent, output one percent */
216 err = cn_printf(cn, "%c", '%');
221 err = cn_printf(cn, "%d",
222 task_tgid_vnr(current));
226 err = cn_printf(cn, "%d",
227 task_tgid_nr(current));
230 err = cn_printf(cn, "%d",
231 task_pid_vnr(current));
234 err = cn_printf(cn, "%d",
235 task_pid_nr(current));
239 err = cn_printf(cn, "%u",
240 from_kuid(&init_user_ns,
245 err = cn_printf(cn, "%u",
246 from_kgid(&init_user_ns,
250 err = cn_printf(cn, "%d",
251 __get_dumpable(cprm->mm_flags));
253 /* signal that caused the coredump */
255 err = cn_printf(cn, "%d",
256 cprm->siginfo->si_signo);
258 /* UNIX time of coredump */
262 time = ktime_get_real_seconds();
263 err = cn_printf(cn, "%lld", time);
269 err = cn_esc_printf(cn, "%s",
270 utsname()->nodename);
275 err = cn_esc_printf(cn, "%s", current->comm);
278 err = cn_print_exe_file(cn);
280 /* core limit size */
282 err = cn_printf(cn, "%lu",
283 rlimit(RLIMIT_CORE));
296 /* Backward compatibility with core_uses_pid:
298 * If core_pattern does not include a %p (as is the default)
299 * and core_uses_pid is set, then .%pid will be appended to
300 * the filename. Do not do this for piped commands. */
301 if (!ispipe && !pid_in_pattern && core_uses_pid) {
302 err = cn_printf(cn, ".%d", task_tgid_vnr(current));
309 static int zap_process(struct task_struct *start, int exit_code, int flags)
311 struct task_struct *t;
314 /* ignore all signals except SIGKILL, see prepare_signal() */
315 start->signal->flags = SIGNAL_GROUP_COREDUMP | flags;
316 start->signal->group_exit_code = exit_code;
317 start->signal->group_stop_count = 0;
319 for_each_thread(start, t) {
320 task_clear_jobctl_pending(t, JOBCTL_PENDING_MASK);
321 if (t != current && t->mm) {
322 sigaddset(&t->pending.signal, SIGKILL);
323 signal_wake_up(t, 1);
331 static int zap_threads(struct task_struct *tsk, struct mm_struct *mm,
332 struct core_state *core_state, int exit_code)
334 struct task_struct *g, *p;
338 spin_lock_irq(&tsk->sighand->siglock);
339 if (!signal_group_exit(tsk->signal)) {
340 mm->core_state = core_state;
341 tsk->signal->group_exit_task = tsk;
342 nr = zap_process(tsk, exit_code, 0);
343 clear_tsk_thread_flag(tsk, TIF_SIGPENDING);
345 spin_unlock_irq(&tsk->sighand->siglock);
346 if (unlikely(nr < 0))
349 tsk->flags |= PF_DUMPCORE;
350 if (atomic_read(&mm->mm_users) == nr + 1)
353 * We should find and kill all tasks which use this mm, and we should
354 * count them correctly into ->nr_threads. We don't take tasklist
355 * lock, but this is safe wrt:
358 * None of sub-threads can fork after zap_process(leader). All
359 * processes which were created before this point should be
360 * visible to zap_threads() because copy_process() adds the new
361 * process to the tail of init_task.tasks list, and lock/unlock
362 * of ->siglock provides a memory barrier.
365 * The caller holds mm->mmap_sem. This means that the task which
366 * uses this mm can't pass exit_mm(), so it can't exit or clear
370 * It does list_replace_rcu(&leader->tasks, ¤t->tasks),
371 * we must see either old or new leader, this does not matter.
372 * However, it can change p->sighand, so lock_task_sighand(p)
373 * must be used. Since p->mm != NULL and we hold ->mmap_sem
376 * Note also that "g" can be the old leader with ->mm == NULL
377 * and already unhashed and thus removed from ->thread_group.
378 * This is OK, __unhash_process()->list_del_rcu() does not
379 * clear the ->next pointer, we will find the new leader via
383 for_each_process(g) {
384 if (g == tsk->group_leader)
386 if (g->flags & PF_KTHREAD)
389 for_each_thread(g, p) {
390 if (unlikely(!p->mm))
392 if (unlikely(p->mm == mm)) {
393 lock_task_sighand(p, &flags);
394 nr += zap_process(p, exit_code,
396 unlock_task_sighand(p, &flags);
403 atomic_set(&core_state->nr_threads, nr);
407 static int coredump_wait(int exit_code, struct core_state *core_state)
409 struct task_struct *tsk = current;
410 struct mm_struct *mm = tsk->mm;
411 int core_waiters = -EBUSY;
413 init_completion(&core_state->startup);
414 core_state->dumper.task = tsk;
415 core_state->dumper.next = NULL;
417 if (down_write_killable(&mm->mmap_sem))
421 core_waiters = zap_threads(tsk, mm, core_state, exit_code);
422 up_write(&mm->mmap_sem);
424 if (core_waiters > 0) {
425 struct core_thread *ptr;
427 freezer_do_not_count();
428 wait_for_completion(&core_state->startup);
431 * Wait for all the threads to become inactive, so that
432 * all the thread context (extended register state, like
433 * fpu etc) gets copied to the memory.
435 ptr = core_state->dumper.next;
436 while (ptr != NULL) {
437 wait_task_inactive(ptr->task, 0);
445 static void coredump_finish(struct mm_struct *mm, bool core_dumped)
447 struct core_thread *curr, *next;
448 struct task_struct *task;
450 spin_lock_irq(¤t->sighand->siglock);
451 if (core_dumped && !__fatal_signal_pending(current))
452 current->signal->group_exit_code |= 0x80;
453 current->signal->group_exit_task = NULL;
454 current->signal->flags = SIGNAL_GROUP_EXIT;
455 spin_unlock_irq(¤t->sighand->siglock);
457 next = mm->core_state->dumper.next;
458 while ((curr = next) != NULL) {
462 * see exit_mm(), curr->task must not see
463 * ->task == NULL before we read ->next.
467 wake_up_process(task);
470 mm->core_state = NULL;
473 static bool dump_interrupted(void)
476 * SIGKILL or freezing() interrupt the coredumping. Perhaps we
477 * can do try_to_freeze() and check __fatal_signal_pending(),
478 * but then we need to teach dump_write() to restart and clear
481 return signal_pending(current);
484 static void wait_for_dump_helpers(struct file *file)
486 struct pipe_inode_info *pipe = file->private_data;
491 wake_up_interruptible_sync(&pipe->wait);
492 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
496 * We actually want wait_event_freezable() but then we need
497 * to clear TIF_SIGPENDING and improve dump_interrupted().
499 wait_event_interruptible(pipe->wait, pipe->readers == 1);
509 * helper function to customize the process used
510 * to collect the core in userspace. Specifically
511 * it sets up a pipe and installs it as fd 0 (stdin)
512 * for the process. Returns 0 on success, or
513 * PTR_ERR on failure.
514 * Note that it also sets the core limit to 1. This
515 * is a special value that we use to trap recursive
518 static int umh_pipe_setup(struct subprocess_info *info, struct cred *new)
520 struct file *files[2];
521 struct coredump_params *cp = (struct coredump_params *)info->data;
522 int err = create_pipe_files(files, 0);
528 err = replace_fd(0, files[0], 0);
530 /* and disallow core files too */
531 current->signal->rlim[RLIMIT_CORE] = (struct rlimit){1, 1};
536 void do_coredump(const siginfo_t *siginfo)
538 struct core_state core_state;
540 struct mm_struct *mm = current->mm;
541 struct linux_binfmt * binfmt;
542 const struct cred *old_cred;
546 struct files_struct *displaced;
547 /* require nonrelative corefile path and be extra careful */
548 bool need_suid_safe = false;
549 bool core_dumped = false;
550 static atomic_t core_dump_count = ATOMIC_INIT(0);
551 struct coredump_params cprm = {
553 .regs = signal_pt_regs(),
554 .limit = rlimit(RLIMIT_CORE),
556 * We must use the same mm->flags while dumping core to avoid
557 * inconsistency of bit flags, since this flag is not protected
560 .mm_flags = mm->flags,
563 audit_core_dumps(siginfo->si_signo);
566 if (!binfmt || !binfmt->core_dump)
568 if (!__get_dumpable(cprm.mm_flags))
571 cred = prepare_creds();
575 * We cannot trust fsuid as being the "true" uid of the process
576 * nor do we know its entire history. We only know it was tainted
577 * so we dump it as root in mode 2, and only into a controlled
578 * environment (pipe handler or fully qualified path).
580 if (__get_dumpable(cprm.mm_flags) == SUID_DUMP_ROOT) {
581 /* Setuid core dump mode */
582 cred->fsuid = GLOBAL_ROOT_UID; /* Dump root private */
583 need_suid_safe = true;
586 retval = coredump_wait(siginfo->si_signo, &core_state);
590 old_cred = override_creds(cred);
592 ispipe = format_corename(&cn, &cprm);
597 struct subprocess_info *sub_info;
600 printk(KERN_WARNING "format_corename failed\n");
601 printk(KERN_WARNING "Aborting core\n");
605 if (cprm.limit == 1) {
606 /* See umh_pipe_setup() which sets RLIMIT_CORE = 1.
608 * Normally core limits are irrelevant to pipes, since
609 * we're not writing to the file system, but we use
610 * cprm.limit of 1 here as a special value, this is a
611 * consistent way to catch recursive crashes.
612 * We can still crash if the core_pattern binary sets
613 * RLIM_CORE = !1, but it runs as root, and can do
614 * lots of stupid things.
616 * Note that we use task_tgid_vnr here to grab the pid
617 * of the process group leader. That way we get the
618 * right pid if a thread in a multi-threaded
619 * core_pattern process dies.
622 "Process %d(%s) has RLIMIT_CORE set to 1\n",
623 task_tgid_vnr(current), current->comm);
624 printk(KERN_WARNING "Aborting core\n");
627 cprm.limit = RLIM_INFINITY;
629 dump_count = atomic_inc_return(&core_dump_count);
630 if (core_pipe_limit && (core_pipe_limit < dump_count)) {
631 printk(KERN_WARNING "Pid %d(%s) over core_pipe_limit\n",
632 task_tgid_vnr(current), current->comm);
633 printk(KERN_WARNING "Skipping core dump\n");
637 helper_argv = argv_split(GFP_KERNEL, cn.corename, NULL);
639 printk(KERN_WARNING "%s failed to allocate memory\n",
645 sub_info = call_usermodehelper_setup(helper_argv[0],
646 helper_argv, NULL, GFP_KERNEL,
647 umh_pipe_setup, NULL, &cprm);
649 retval = call_usermodehelper_exec(sub_info,
652 argv_free(helper_argv);
654 printk(KERN_INFO "Core dump to |%s pipe failed\n",
660 int open_flags = O_CREAT | O_RDWR | O_NOFOLLOW |
661 O_LARGEFILE | O_EXCL;
663 if (cprm.limit < binfmt->min_coredump)
666 if (need_suid_safe && cn.corename[0] != '/') {
667 printk(KERN_WARNING "Pid %d(%s) can only dump core "\
668 "to fully qualified path!\n",
669 task_tgid_vnr(current), current->comm);
670 printk(KERN_WARNING "Skipping core dump\n");
675 * Unlink the file if it exists unless this is a SUID
676 * binary - in that case, we're running around with root
677 * privs and don't want to unlink another user's coredump.
679 if (!need_suid_safe) {
685 * If it doesn't exist, that's fine. If there's some
686 * other problem, we'll catch it at the filp_open().
688 (void) sys_unlink((const char __user *)cn.corename);
693 * There is a race between unlinking and creating the
694 * file, but if that causes an EEXIST here, that's
695 * fine - another process raced with us while creating
696 * the corefile, and the other process won. To userspace,
697 * what matters is that at least one of the two processes
698 * writes its coredump successfully, not which one.
700 if (need_suid_safe) {
702 * Using user namespaces, normal user tasks can change
703 * their current->fs->root to point to arbitrary
704 * directories. Since the intention of the "only dump
705 * with a fully qualified path" rule is to control where
706 * coredumps may be placed using root privileges,
707 * current->fs->root must not be used. Instead, use the
708 * root directory of init_task.
712 task_lock(&init_task);
713 get_fs_root(init_task.fs, &root);
714 task_unlock(&init_task);
715 cprm.file = file_open_root(root.dentry, root.mnt,
716 cn.corename, open_flags, 0600);
719 cprm.file = filp_open(cn.corename, open_flags, 0600);
721 if (IS_ERR(cprm.file))
724 inode = file_inode(cprm.file);
725 if (inode->i_nlink > 1)
727 if (d_unhashed(cprm.file->f_path.dentry))
730 * AK: actually i see no reason to not allow this for named
731 * pipes etc, but keep the previous behaviour for now.
733 if (!S_ISREG(inode->i_mode))
736 * Don't dump core if the filesystem changed owner or mode
737 * of the file during file creation. This is an issue when
738 * a process dumps core while its cwd is e.g. on a vfat
741 if (!uid_eq(inode->i_uid, current_fsuid()))
743 if ((inode->i_mode & 0677) != 0600)
745 if (!(cprm.file->f_mode & FMODE_CAN_WRITE))
747 if (do_truncate(cprm.file->f_path.dentry, 0, 0, cprm.file))
751 /* get us an unshared descriptor table; almost always a no-op */
752 retval = unshare_files(&displaced);
756 put_files_struct(displaced);
757 if (!dump_interrupted()) {
758 file_start_write(cprm.file);
759 core_dumped = binfmt->core_dump(&cprm);
760 file_end_write(cprm.file);
762 if (ispipe && core_pipe_limit)
763 wait_for_dump_helpers(cprm.file);
766 filp_close(cprm.file, NULL);
769 atomic_dec(&core_dump_count);
772 coredump_finish(mm, core_dumped);
773 revert_creds(old_cred);
781 * Core dumping helper functions. These are the only things you should
782 * do on a core-file: use only these functions to write out all the
785 int dump_emit(struct coredump_params *cprm, const void *addr, int nr)
787 struct file *file = cprm->file;
788 loff_t pos = file->f_pos;
790 if (cprm->written + nr > cprm->limit)
793 if (dump_interrupted())
795 n = __kernel_write(file, addr, nr, &pos);
805 EXPORT_SYMBOL(dump_emit);
807 int dump_skip(struct coredump_params *cprm, size_t nr)
809 static char zeroes[PAGE_SIZE];
810 struct file *file = cprm->file;
811 if (file->f_op->llseek && file->f_op->llseek != no_llseek) {
812 if (dump_interrupted() ||
813 file->f_op->llseek(file, nr, SEEK_CUR) < 0)
818 while (nr > PAGE_SIZE) {
819 if (!dump_emit(cprm, zeroes, PAGE_SIZE))
823 return dump_emit(cprm, zeroes, nr);
826 EXPORT_SYMBOL(dump_skip);
828 int dump_align(struct coredump_params *cprm, int align)
830 unsigned mod = cprm->pos & (align - 1);
831 if (align & (align - 1))
833 return mod ? dump_skip(cprm, align - mod) : 1;
835 EXPORT_SYMBOL(dump_align);
838 * Ensures that file size is big enough to contain the current file
839 * postion. This prevents gdb from complaining about a truncated file
840 * if the last "write" to the file was dump_skip.
842 void dump_truncate(struct coredump_params *cprm)
844 struct file *file = cprm->file;
847 if (file->f_op->llseek && file->f_op->llseek != no_llseek) {
848 offset = file->f_op->llseek(file, 0, SEEK_CUR);
849 if (i_size_read(file->f_mapping->host) < offset)
850 do_truncate(file->f_path.dentry, offset, 0, file);
853 EXPORT_SYMBOL(dump_truncate);