fs/signalfd.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  fs/signalfd.c
   4  *
   5  *  Copyright (C) 2003  Linus Torvalds
   6  *
   7  *  Mon Mar 5, 2007: Davide Libenzi <davidel@xmailserver.org>
   8  *      Changed ->read() to return a siginfo strcture instead of signal number.
   9  *      Fixed locking in ->poll().
  10  *      Added sighand-detach notification.
  11  *      Added fd re-use in sys_signalfd() syscall.
  12  *      Now using anonymous inode source.
  13  *      Thanks to Oleg Nesterov for useful code review and suggestions.
  14  *      More comments and suggestions from Arnd Bergmann.
  15  *  Sat May 19, 2007: Davi E. M. Arnaut <davi@haxent.com.br>
  16  *      Retrieve multiple signals with one read() call
  17  *  Sun Jul 15, 2007: Davide Libenzi <davidel@xmailserver.org>
  18  *      Attach to the sighand only during read() and poll().
  19  */
  20
  21 #include <linux/file.h>
  22 #include <linux/poll.h>
  23 #include <linux/init.h>
  24 #include <linux/fs.h>
  25 #include <linux/sched.h>
  26 #include <linux/slab.h>
  27 #include <linux/kernel.h>
  28 #include <linux/signal.h>
  29 #include <linux/list.h>
  30 #include <linux/anon_inodes.h>
  31 #include <linux/signalfd.h>
  32 #include <linux/syscalls.h>
  33 #include <linux/proc_fs.h>
  34 #include <linux/compat.h>
  35
  36 void signalfd_cleanup(struct sighand_struct *sighand)
  37 {
  38         wait_queue_head_t *wqh = &sighand->signalfd_wqh;
  39         /*
  40          * The lockless check can race with remove_wait_queue() in progress,
  41          * but in this case its caller should run under rcu_read_lock() and
  42          * sighand_cachep is SLAB_TYPESAFE_BY_RCU, we can safely return.
  43          */
  44         if (likely(!waitqueue_active(wqh)))
  45                 return;
  46
  47         /* wait_queue_entry_t->func(POLLFREE) should do remove_wait_queue() */
  48         wake_up_poll(wqh, EPOLLHUP | POLLFREE);
  49 }
  50
  51 struct signalfd_ctx {
  52         sigset_t sigmask;
  53 };
  54
  55 static int signalfd_release(struct inode *inode, struct file *file)
  56 {
  57         kfree(file->private_data);
  58         return 0;
  59 }
  60
  61 static __poll_t signalfd_poll(struct file *file, poll_table *wait)
  62 {
  63         struct signalfd_ctx *ctx = file->private_data;
  64         __poll_t events = 0;
  65
  66         poll_wait(file, &current->sighand->signalfd_wqh, wait);
  67
  68         spin_lock_irq(&current->sighand->siglock);
  69         if (next_signal(&current->pending, &ctx->sigmask) ||
  70             next_signal(&current->signal->shared_pending,
  71                         &ctx->sigmask))
  72                 events |= EPOLLIN;
  73         spin_unlock_irq(&current->sighand->siglock);
  74
  75         return events;
  76 }
  77
  78 /*
  79  * Copied from copy_siginfo_to_user() in kernel/signal.c
  80  */
  81 static int signalfd_copyinfo(struct signalfd_siginfo __user *uinfo,
  82                              siginfo_t const *kinfo)
  83 {
  84         long err;
  85
  86         BUILD_BUG_ON(sizeof(struct signalfd_siginfo) != 128);
  87
  88         /*
  89          * Unused members should be zero ...
  90          */
  91         err = __clear_user(uinfo, sizeof(*uinfo));
  92
  93         /*
  94          * If you change siginfo_t structure, please be sure
  95          * this code is fixed accordingly.
  96          */
  97         err |= __put_user(kinfo->si_signo, &uinfo->ssi_signo);
  98         err |= __put_user(kinfo->si_errno, &uinfo->ssi_errno);
  99         err |= __put_user(kinfo->si_code, &uinfo->ssi_code);
 100         switch (siginfo_layout(kinfo->si_signo, kinfo->si_code)) {
 101         case SIL_KILL:
 102                 err |= __put_user(kinfo->si_pid, &uinfo->ssi_pid);
 103                 err |= __put_user(kinfo->si_uid, &uinfo->ssi_uid);
 104                 break;
 105         case SIL_TIMER:
 106                  err |= __put_user(kinfo->si_tid, &uinfo->ssi_tid);
 107                  err |= __put_user(kinfo->si_overrun, &uinfo->ssi_overrun);
 108                  err |= __put_user((long) kinfo->si_ptr, &uinfo->ssi_ptr);
 109                  err |= __put_user(kinfo->si_int, &uinfo->ssi_int);
 110                 break;
 111         case SIL_POLL:
 112                 err |= __put_user(kinfo->si_band, &uinfo->ssi_band);
 113                 err |= __put_user(kinfo->si_fd, &uinfo->ssi_fd);
 114                 break;
 115         case SIL_FAULT:
 116                 err |= __put_user((long) kinfo->si_addr, &uinfo->ssi_addr);
 117 #ifdef __ARCH_SI_TRAPNO
 118                 err |= __put_user(kinfo->si_trapno, &uinfo->ssi_trapno);
 119 #endif
 120                 /*
 121                  * Other callers might not initialize the si_lsb field,
 122                  * so check explicitly for the right codes here.
 123                  */
 124                 if (kinfo->si_signo == SIGBUS &&
 125                     ((kinfo->si_code == BUS_MCEERR_AR) ||
 126                      (kinfo->si_code == BUS_MCEERR_AO)))
 127                         err |= __put_user((short) kinfo->si_addr_lsb,
 128                                           &uinfo->ssi_addr_lsb);
 129                 break;
 130         case SIL_CHLD:
 131                 err |= __put_user(kinfo->si_pid, &uinfo->ssi_pid);
 132                 err |= __put_user(kinfo->si_uid, &uinfo->ssi_uid);
 133                 err |= __put_user(kinfo->si_status, &uinfo->ssi_status);
 134                 err |= __put_user(kinfo->si_utime, &uinfo->ssi_utime);
 135                 err |= __put_user(kinfo->si_stime, &uinfo->ssi_stime);
 136                 break;
 137         case SIL_RT:
 138         default:
 139                 /*
 140                  * This case catches also the signals queued by sigqueue().
 141                  */
 142                 err |= __put_user(kinfo->si_pid, &uinfo->ssi_pid);
 143                 err |= __put_user(kinfo->si_uid, &uinfo->ssi_uid);
 144                 err |= __put_user((long) kinfo->si_ptr, &uinfo->ssi_ptr);
 145                 err |= __put_user(kinfo->si_int, &uinfo->ssi_int);
 146                 break;
 147         }
 148
 149         return err ? -EFAULT: sizeof(*uinfo);
 150 }
 151
 152 static ssize_t signalfd_dequeue(struct signalfd_ctx *ctx, siginfo_t *info,
 153                                 int nonblock)
 154 {
 155         ssize_t ret;
 156         DECLARE_WAITQUEUE(wait, current);
 157
 158         spin_lock_irq(&current->sighand->siglock);
 159         ret = dequeue_signal(current, &ctx->sigmask, info);
 160         switch (ret) {
 161         case 0:
 162                 if (!nonblock)
 163                         break;
 164                 ret = -EAGAIN;
 165         default:
 166                 spin_unlock_irq(&current->sighand->siglock);
 167                 return ret;
 168         }
 169
 170         add_wait_queue(&current->sighand->signalfd_wqh, &wait);
 171         for (;;) {
 172                 set_current_state(TASK_INTERRUPTIBLE);
 173                 ret = dequeue_signal(current, &ctx->sigmask, info);
 174                 if (ret != 0)
 175                         break;
 176                 if (signal_pending(current)) {
 177                         ret = -ERESTARTSYS;
 178                         break;
 179                 }
 180                 spin_unlock_irq(&current->sighand->siglock);
 181                 schedule();
 182                 spin_lock_irq(&current->sighand->siglock);
 183         }
 184         spin_unlock_irq(&current->sighand->siglock);
 185
 186         remove_wait_queue(&current->sighand->signalfd_wqh, &wait);
 187         __set_current_state(TASK_RUNNING);
 188
 189         return ret;
 190 }
 191
 192 /*
 193  * Returns a multiple of the size of a "struct signalfd_siginfo", or a negative
 194  * error code. The "count" parameter must be at least the size of a
 195  * "struct signalfd_siginfo".
 196  */
 197 static ssize_t signalfd_read(struct file *file, char __user *buf, size_t count,
 198                              loff_t *ppos)
 199 {
 200         struct signalfd_ctx *ctx = file->private_data;
 201         struct signalfd_siginfo __user *siginfo;
 202         int nonblock = file->f_flags & O_NONBLOCK;
 203         ssize_t ret, total = 0;
 204         siginfo_t info;
 205
 206         count /= sizeof(struct signalfd_siginfo);
 207         if (!count)
 208                 return -EINVAL;
 209
 210         siginfo = (struct signalfd_siginfo __user *) buf;
 211         do {
 212                 ret = signalfd_dequeue(ctx, &info, nonblock);
 213                 if (unlikely(ret <= 0))
 214                         break;
 215                 ret = signalfd_copyinfo(siginfo, &info);
 216                 if (ret < 0)
 217                         break;
 218                 siginfo++;
 219                 total += ret;
 220                 nonblock = 1;
 221         } while (--count);
 222
 223         return total ? total: ret;
 224 }
 225
 226 #ifdef CONFIG_PROC_FS
 227 static void signalfd_show_fdinfo(struct seq_file *m, struct file *f)
 228 {
 229         struct signalfd_ctx *ctx = f->private_data;
 230         sigset_t sigmask;
 231
 232         sigmask = ctx->sigmask;
 233         signotset(&sigmask);
 234         render_sigset_t(m, "sigmask:\t", &sigmask);
 235 }
 236 #endif
 237
 238 static const struct file_operations signalfd_fops = {
 239 #ifdef CONFIG_PROC_FS
 240         .show_fdinfo    = signalfd_show_fdinfo,
 241 #endif
 242         .release        = signalfd_release,
 243         .poll           = signalfd_poll,
 244         .read           = signalfd_read,
 245         .llseek         = noop_llseek,
 246 };
 247
 248 static int do_signalfd4(int ufd, sigset_t __user *user_mask, size_t sizemask,
 249                         int flags)
 250 {
 251         sigset_t sigmask;
 252         struct signalfd_ctx *ctx;
 253
 254         /* Check the SFD_* constants for consistency.  */
 255         BUILD_BUG_ON(SFD_CLOEXEC != O_CLOEXEC);
 256         BUILD_BUG_ON(SFD_NONBLOCK != O_NONBLOCK);
 257
 258         if (flags & ~(SFD_CLOEXEC | SFD_NONBLOCK))
 259                 return -EINVAL;
 260
 261         if (sizemask != sizeof(sigset_t) ||
 262             copy_from_user(&sigmask, user_mask, sizeof(sigmask)))
 263                 return -EINVAL;
 264         sigdelsetmask(&sigmask, sigmask(SIGKILL) | sigmask(SIGSTOP));
 265         signotset(&sigmask);
 266
 267         if (ufd == -1) {
 268                 ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
 269                 if (!ctx)
 270                         return -ENOMEM;
 271
 272                 ctx->sigmask = sigmask;
 273
 274                 /*
 275                  * When we call this, the initialization must be complete, since
 276                  * anon_inode_getfd() will install the fd.
 277                  */
 278                 ufd = anon_inode_getfd("[signalfd]", &signalfd_fops, ctx,
 279                                        O_RDWR | (flags & (O_CLOEXEC | O_NONBLOCK)));
 280                 if (ufd < 0)
 281                         kfree(ctx);
 282         } else {
 283                 struct fd f = fdget(ufd);
 284                 if (!f.file)
 285                         return -EBADF;
 286                 ctx = f.file->private_data;
 287                 if (f.file->f_op != &signalfd_fops) {
 288                         fdput(f);
 289                         return -EINVAL;
 290                 }
 291                 spin_lock_irq(&current->sighand->siglock);
 292                 ctx->sigmask = sigmask;
 293                 spin_unlock_irq(&current->sighand->siglock);
 294
 295                 wake_up(&current->sighand->signalfd_wqh);
 296                 fdput(f);
 297         }
 298
 299         return ufd;
 300 }
 301
 302 SYSCALL_DEFINE4(signalfd4, int, ufd, sigset_t __user *, user_mask,
 303                 size_t, sizemask, int, flags)
 304 {
 305         return do_signalfd4(ufd, user_mask, sizemask, flags);
 306 }
 307
 308 SYSCALL_DEFINE3(signalfd, int, ufd, sigset_t __user *, user_mask,
 309                 size_t, sizemask)
 310 {
 311         return do_signalfd4(ufd, user_mask, sizemask, 0);
 312 }
 313
 314 #ifdef CONFIG_COMPAT
 315 static long do_compat_signalfd4(int ufd,
 316                         const compat_sigset_t __user *sigmask,
 317                         compat_size_t sigsetsize, int flags)
 318 {
 319         sigset_t tmp;
 320         sigset_t __user *ksigmask;
 321
 322         if (sigsetsize != sizeof(compat_sigset_t))
 323                 return -EINVAL;
 324         if (get_compat_sigset(&tmp, sigmask))
 325                 return -EFAULT;
 326         ksigmask = compat_alloc_user_space(sizeof(sigset_t));
 327         if (copy_to_user(ksigmask, &tmp, sizeof(sigset_t)))
 328                 return -EFAULT;
 329
 330         return do_signalfd4(ufd, ksigmask, sizeof(sigset_t), flags);
 331 }
 332
 333 COMPAT_SYSCALL_DEFINE4(signalfd4, int, ufd,
 334                      const compat_sigset_t __user *, sigmask,
 335                      compat_size_t, sigsetsize,
 336                      int, flags)
 337 {
 338         return do_compat_signalfd4(ufd, sigmask, sigsetsize, flags);
 339 }
 340
 341 COMPAT_SYSCALL_DEFINE3(signalfd, int, ufd,
 342                      const compat_sigset_t __user *,sigmask,
 343                      compat_size_t, sigsetsize)
 344 {
 345         return do_compat_signalfd4(ufd, sigmask, sigsetsize, 0);
 346 }
 347 #endif