man2/signalfd.2

   1 .\" Copyright (C) 2008 Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\" starting from a version by Davide Libenzi <davidel@xmailserver.org>
   3 .\"
   4 .\" %%%LICENSE_START(GPLv2+_SW_3_PARA)
   5 .\" This program is free software; you can redistribute it and/or modify
   6 .\" it under the terms of the GNU General Public License as published by
   7 .\" the Free Software Foundation; either version 2 of the License, or
   8 .\" (at your option) any later version.
   9 .\"
  10 .\" This program is distributed in the hope that it will be useful,
  11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 .\" GNU General Public License for more details.
  14 .\"
  15 .\" You should have received a copy of the GNU General Public
  16 .\" License along with this manual; if not, see
  17 .\" <http://www.gnu.org/licenses/>.
  18 .\" %%%LICENSE_END
  19 .\"
  20 .TH SIGNALFD 2 2019-03-06 Linux "Linux Programmer's Manual"
  21 .SH NAME
  22 signalfd \- create a file descriptor for accepting signals
  23 .SH SYNOPSIS
  24 .B #include <sys/signalfd.h>
  25 .PP
  26 .BI "int signalfd(int " fd ", const sigset_t *" mask ", int " flags );
  27 .SH DESCRIPTION
  28 .BR signalfd ()
  29 creates a file descriptor that can be used to accept signals
  30 targeted at the caller.
  31 This provides an alternative to the use of a signal handler or
  32 .BR sigwaitinfo (2),
  33 and has the advantage that the file descriptor may be monitored by
  34 .BR select (2),
  35 .BR poll (2),
  36 and
  37 .BR epoll (7).
  38 .PP
  39 The
  40 .I mask
  41 argument specifies the set of signals that the caller
  42 wishes to accept via the file descriptor.
  43 This argument is a signal set whose contents can be initialized
  44 using the macros described in
  45 .BR sigsetops (3).
  46 Normally, the set of signals to be received via the
  47 file descriptor should be blocked using
  48 .BR sigprocmask (2),
  49 to prevent the signals being handled according to their default
  50 dispositions.
  51 It is not possible to receive
  52 .B SIGKILL
  53 or
  54 .B SIGSTOP
  55 signals via a signalfd file descriptor;
  56 these signals are silently ignored if specified in
  57 .IR mask .
  58 .PP
  59 If the
  60 .I fd
  61 argument is \-1,
  62 then the call creates a new file descriptor and associates the
  63 signal set specified in
  64 .I mask
  65 with that file descriptor.
  66 If
  67 .I fd
  68 is not \-1,
  69 then it must specify a valid existing signalfd file descriptor, and
  70 .I mask
  71 is used to replace the signal set associated with that file descriptor.
  72 .PP
  73 Starting with Linux 2.6.27, the following values may be bitwise ORed in
  74 .IR flags
  75 to change the behavior of
  76 .BR signalfd ():
  77 .TP 14
  78 .B SFD_NONBLOCK
  79 Set the
  80 .BR O_NONBLOCK
  81 file status flag on the open file description (see
  82 .BR open (2))
  83 referred to by the new file descriptor.
  84 Using this flag saves extra calls to
  85 .BR fcntl (2)
  86 to achieve the same result.
  87 .TP
  88 .B SFD_CLOEXEC
  89 Set the close-on-exec
  90 .RB ( FD_CLOEXEC )
  91 flag on the new file descriptor.
  92 See the description of the
  93 .B O_CLOEXEC
  94 flag in
  95 .BR open (2)
  96 for reasons why this may be useful.
  97 .PP
  98 In Linux up to version 2.6.26, the
  99 .I flags
 100 argument is unused, and must be specified as zero.
 101 .PP
 102 .BR signalfd ()
 103 returns a file descriptor that supports the following operations:
 104 .TP
 105 .BR read (2)
 106 If one or more of the signals specified in
 107 .I mask
 108 is pending for the process, then the buffer supplied to
 109 .BR read (2)
 110 is used to return one or more
 111 .I signalfd_siginfo
 112 structures (see below) that describe the signals.
 113 The
 114 .BR read (2)
 115 returns information for as many signals as are pending and will
 116 fit in the supplied buffer.
 117 The buffer must be at least
 118 .I "sizeof(struct signalfd_siginfo)"
 119 bytes.
 120 The return value of the
 121 .BR read (2)
 122 is the total number of bytes read.
 123 .IP
 124 As a consequence of the
 125 .BR read (2),
 126 the signals are consumed,
 127 so that they are no longer pending for the process
 128 (i.e., will not be caught by signal handlers,
 129 and cannot be accepted using
 130 .BR sigwaitinfo (2)).
 131 .IP
 132 If none of the signals in
 133 .I mask
 134 is pending for the process, then the
 135 .BR read (2)
 136 either blocks until one of the signals in
 137 .I mask
 138 is generated for the process,
 139 or fails with the error
 140 .B EAGAIN
 141 if the file descriptor has been made nonblocking.
 142 .TP
 143 .BR poll "(2), " select "(2) (and similar)"
 144 The file descriptor is readable
 145 (the
 146 .BR select (2)
 147 .I readfds
 148 argument; the
 149 .BR poll (2)
 150 .B POLLIN
 151 flag)
 152 if one or more of the signals in
 153 .I mask
 154 is pending for the process.
 155 .IP
 156 The signalfd file descriptor also supports the other file-descriptor
 157 multiplexing APIs:
 158 .BR pselect (2),
 159 .BR ppoll (2),
 160 and
 161 .BR epoll (7).
 162 .TP
 163 .BR close (2)
 164 When the file descriptor is no longer required it should be closed.
 165 When all file descriptors associated with the same signalfd object
 166 have been closed, the resources for object are freed by the kernel.
 167 .SS The signalfd_siginfo structure
 168 The format of the
 169 .I signalfd_siginfo
 170 structure(s) returned by
 171 .BR read (2)s
 172 from a signalfd file descriptor is as follows:
 173 .PP
 174 .in +4n
 175 .EX
 176 struct signalfd_siginfo {
 177     uint32_t ssi_signo;    /* Signal number */
 178     int32_t  ssi_errno;    /* Error number (unused) */
 179     int32_t  ssi_code;     /* Signal code */
 180     uint32_t ssi_pid;      /* PID of sender */
 181     uint32_t ssi_uid;      /* Real UID of sender */
 182     int32_t  ssi_fd;       /* File descriptor (SIGIO) */
 183     uint32_t ssi_tid;      /* Kernel timer ID (POSIX timers)
 184     uint32_t ssi_band;     /* Band event (SIGIO) */
 185     uint32_t ssi_overrun;  /* POSIX timer overrun count */
 186     uint32_t ssi_trapno;   /* Trap number that caused signal */
 187 .\" ssi_trapno is unused on most arches
 188     int32_t  ssi_status;   /* Exit status or signal (SIGCHLD) */
 189     int32_t  ssi_int;      /* Integer sent by sigqueue(3) */
 190     uint64_t ssi_ptr;      /* Pointer sent by sigqueue(3) */
 191     uint64_t ssi_utime;    /* User CPU time consumed (SIGCHLD) */
 192     uint64_t ssi_stime;    /* System CPU time consumed
 193                               (SIGCHLD) */
 194     uint64_t ssi_addr;     /* Address that generated signal
 195                               (for hardware-generated signals) */
 196     uint16_t ssi_addr_lsb; /* Least significant bit of address
 197                               (SIGBUS; since Linux 2.6.37)
 198 .\" ssi_addr_lsb: commit b8aeec34175fc8fe8b0d40efea4846dfc1ba663e
 199     uint8_t  pad[\fIX\fP];       /* Pad size to 128 bytes (allow for
 200                               additional fields in the future) */
 201 };
 202 .EE
 203 .in
 204 .PP
 205 Each of the fields in this structure
 206 is analogous to the similarly named field in the
 207 .I siginfo_t
 208 structure.
 209 The
 210 .I siginfo_t
 211 structure is described in
 212 .BR sigaction (2).
 213 Not all fields in the returned
 214 .I signalfd_siginfo
 215 structure will be valid for a specific signal;
 216 the set of valid fields can be determined from the value returned in the
 217 .I ssi_code
 218 field.
 219 This field is the analog of the
 220 .I siginfo_t
 221 .I si_code
 222 field; see
 223 .BR sigaction (2)
 224 for details.
 225 .SS fork(2) semantics
 226 After a
 227 .BR fork (2),
 228 the child inherits a copy of the signalfd file descriptor.
 229 A
 230 .BR read (2)
 231 from the file descriptor in the child will return information
 232 about signals queued to the child.
 233 .SS Semantics of file descriptor passing
 234 As with other file descriptors,
 235 signalfd file descriptors can be passed to another process
 236 via a UNIX domain socket (see
 237 .BR unix (7)).
 238 In the receiving process, a
 239 .BR read (2)
 240 from the received file descriptor will return information
 241 about signals queued to that process.
 242 .SS execve(2) semantics
 243 Just like any other file descriptor,
 244 a signalfd file descriptor remains open across an
 245 .BR execve (2),
 246 unless it has been marked for close-on-exec (see
 247 .BR fcntl (2)).
 248 Any signals that were available for reading before the
 249 .BR execve (2)
 250 remain available to the newly loaded program.
 251 (This is analogous to traditional signal semantics,
 252 where a blocked signal that is pending remains pending across an
 253 .BR execve (2).)
 254 .SS Thread semantics
 255 The semantics of signalfd file descriptors in a multithreaded program
 256 mirror the standard semantics for signals.
 257 In other words,
 258 when a thread reads from a signalfd file descriptor,
 259 it will read the signals that are directed to the thread
 260 itself and the signals that are directed to the process
 261 (i.e., the entire thread group).
 262 (A thread will not be able to read signals that are directed
 263 to other threads in the process.)
 264 .SH RETURN VALUE
 265 On success,
 266 .BR signalfd ()
 267 returns a signalfd file descriptor;
 268 this is either a new file descriptor (if
 269 .I fd
 270 was \-1), or
 271 .I fd
 272 if
 273 .I fd
 274 was a valid signalfd file descriptor.
 275 On error, \-1 is returned and
 276 .I errno
 277 is set to indicate the error.
 278 .SH ERRORS
 279 .TP
 280 .B EBADF
 281 The
 282 .I fd
 283 file descriptor is not a valid file descriptor.
 284 .TP
 285 .B EINVAL
 286 .I fd
 287 is not a valid signalfd file descriptor.
 288 .\" or, the
 289 .\" .I sizemask
 290 .\" argument is not equal to
 291 .\" .IR sizeof(sigset_t) ;
 292 .TP
 293 .B EINVAL
 294 .I flags
 295 is invalid;
 296 or, in Linux 2.6.26 or earlier,
 297 .I flags
 298 is nonzero.
 299 .TP
 300 .B EMFILE
 301 The per-process limit on the number of open file descriptors has been reached.
 302 .TP
 303 .B ENFILE
 304 The system-wide limit on the total number of open files has been
 305 reached.
 306 .TP
 307 .B ENODEV
 308 Could not mount (internal) anonymous inode device.
 309 .TP
 310 .B ENOMEM
 311 There was insufficient memory to create a new signalfd file descriptor.
 312 .SH VERSIONS
 313 .BR signalfd ()
 314 is available on Linux since kernel 2.6.22.
 315 Working support is provided in glibc since version 2.8.
 316 .\" signalfd() is in glibc 2.7, but reportedly does not build
 317 The
 318 .BR signalfd4 ()
 319 system call (see NOTES) is available on Linux since kernel 2.6.27.
 320 .SH CONFORMING TO
 321 .BR signalfd ()
 322 and
 323 .BR signalfd4 ()
 324 are Linux-specific.
 325 .SH NOTES
 326 A process can create multiple signalfd file descriptors.
 327 This makes it possible to accept different signals
 328 on different file descriptors.
 329 (This may be useful if monitoring the file descriptors using
 330 .BR select (2),
 331 .BR poll (2),
 332 or
 333 .BR epoll (7):
 334 the arrival of different signals will make different file descriptors ready.)
 335 If a signal appears in the
 336 .I mask
 337 of more than one of the file descriptors, then occurrences
 338 of that signal can be read (once) from any one of the file descriptors.
 339 .PP
 340 Attempts to include
 341 .B SIGKILL
 342 and
 343 .B SIGSTOP
 344 in
 345 .I mask
 346 are silently ignored.
 347 .PP
 348 The signal mask employed by a signalfd file descriptor can be viewed
 349 via the entry for the corresponding file descriptor in the process's
 350 .IR /proc/[pid]/fdinfo
 351 directory.
 352 See
 353 .BR proc (5)
 354 for further details.
 355 .\"
 356 .SS Limitations
 357 The signalfd mechanism can't be used to receive signals that
 358 are synchronously generated, such as the
 359 .BR SIGSEGV
 360 signal that results from accessing an invalid memory address
 361 or the
 362 .BR SIGFPE
 363 signal that results from an arithmetic error.
 364 Such signals can be caught only via signal handler.
 365 .PP
 366 As described above,
 367 in normal usage one blocks the signals that will be accepted via
 368 .BR signalfd ().
 369 If spawning a child process to execute a helper program
 370 (that does not need the signalfd file descriptor),
 371 then, after the call to
 372 .BR fork (2),
 373 you will normally want to unblock those signals before calling
 374 .BR execve (2),
 375 so that the helper program can see any signals that it expects to see.
 376 Be aware, however,
 377 that this won't be possible in the case of a helper program spawned
 378 behind the scenes by any library function that the program may call.
 379 In such cases, one must fall back to using a traditional signal
 380 handler that writes to a file descriptor monitored by
 381 .BR select (2),
 382 .BR poll (2),
 383 or
 384 .BR epoll (7),
 385 .\"
 386 .SS C library/kernel differences
 387 The underlying Linux system call requires an additional argument,
 388 .IR "size_t sizemask" ,
 389 which specifies the size of the
 390 .I mask
 391 argument.
 392 The glibc
 393 .BR signalfd ()
 394 wrapper function does not include this argument,
 395 since it provides the required value for the underlying system call.
 396 .PP
 397 There are two underlying Linux system calls:
 398 .BR signalfd ()
 399 and the more recent
 400 .BR signalfd4 ().
 401 The former system call does not implement a
 402 .I flags
 403 argument.
 404 The latter system call implements the
 405 .I flags
 406 values described above.
 407 Starting with glibc 2.9, the
 408 .BR signalfd ()
 409 wrapper function will use
 410 .BR signalfd4 ()
 411 where it is available.
 412 .SH BUGS
 413 In kernels before 2.6.25, the
 414 .I ssi_ptr
 415 and
 416 .I ssi_int
 417 fields are not filled in with the data accompanying a signal sent by
 418 .BR sigqueue (3).
 419 .\" The fix also was put into 2.6.24.5
 420 .SH EXAMPLE
 421 The program below accepts the signals
 422 .B SIGINT
 423 and
 424 .B SIGQUIT
 425 via a signalfd file descriptor.
 426 The program terminates after accepting a
 427 .B SIGQUIT
 428 signal.
 429 The following shell session demonstrates the use of the program:
 430 .PP
 431 .in +4n
 432 .EX
 433 .RB "$" " ./signalfd_demo"
 434 .BR "^C" "                   # Control\-C generates SIGINT"
 435 Got SIGINT
 436 .B ^C
 437 Got SIGINT
 438 \fB^\e\fP                    # Control\-\e generates SIGQUIT
 439 Got SIGQUIT
 440 $
 441 .EE
 442 .in
 443 .SS Program source
 444 \&
 445 .EX
 446 #include <sys/signalfd.h>
 447 #include <signal.h>
 448 #include <unistd.h>
 449 #include <stdlib.h>
 450 #include <stdio.h>
 451
 452 #define handle_error(msg) \e
 453     do { perror(msg); exit(EXIT_FAILURE); } while (0)
 454
 455 int
 456 main(int argc, char *argv[])
 457 {
 458     sigset_t mask;
 459     int sfd;
 460     struct signalfd_siginfo fdsi;
 461     ssize_t s;
 462
 463     sigemptyset(&mask);
 464     sigaddset(&mask, SIGINT);
 465     sigaddset(&mask, SIGQUIT);
 466
 467     /* Block signals so that they aren\(aqt handled
 468        according to their default dispositions */
 469
 470     if (sigprocmask(SIG_BLOCK, &mask, NULL) == \-1)
 471         handle_error("sigprocmask");
 472
 473     sfd = signalfd(\-1, &mask, 0);
 474     if (sfd == \-1)
 475         handle_error("signalfd");
 476
 477     for (;;) {
 478         s = read(sfd, &fdsi, sizeof(struct signalfd_siginfo));
 479         if (s != sizeof(struct signalfd_siginfo))
 480             handle_error("read");
 481
 482         if (fdsi.ssi_signo == SIGINT) {
 483             printf("Got SIGINT\en");
 484         } else if (fdsi.ssi_signo == SIGQUIT) {
 485             printf("Got SIGQUIT\en");
 486             exit(EXIT_SUCCESS);
 487         } else {
 488             printf("Read unexpected signal\en");
 489         }
 490     }
 491 }
 492 .EE
 493 .SH SEE ALSO
 494 .BR eventfd (2),
 495 .BR poll (2),
 496 .BR read (2),
 497 .BR select (2),
 498 .BR sigaction (2),
 499 .BR sigprocmask (2),
 500 .BR sigwaitinfo (2),
 501 .BR timerfd_create (2),
 502 .BR sigsetops (3),
 503 .BR sigwait (3),
 504 .BR epoll (7),
 505 .BR signal (7)