Blame man3/siginterrupt.3

Packit 7cfc04
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.\" References consulted:
Packit 7cfc04
.\"     Linux libc source code
Packit 7cfc04
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
Packit 7cfc04
.\"     386BSD man pages
Packit 7cfc04
.\" Modified Sun Jul 25 10:40:51 1993 by Rik Faith (faith@cs.unc.edu)
Packit 7cfc04
.\" Modified Sun Apr 14 16:20:34 1996 by Andries Brouwer (aeb@cwi.nl)
Packit 7cfc04
.TH SIGINTERRUPT 3 2016-03-15 "" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
siginterrupt \- allow signals to interrupt system calls
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <signal.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "int siginterrupt(int " sig ", int " flag );
Packit 7cfc04
.fi
Packit 7cfc04
.PP
Packit 7cfc04
.in -4n
Packit 7cfc04
Feature Test Macro Requirements for glibc (see
Packit 7cfc04
.BR feature_test_macros (7)):
Packit 7cfc04
.in
Packit 7cfc04
.PP
Packit 7cfc04
.BR siginterrupt ():
Packit 7cfc04
.ad l
Packit 7cfc04
.RS 4
Packit 7cfc04
_XOPEN_SOURCE\ >=\ 500
Packit 7cfc04
.\"    || _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
Packit 7cfc04
    || /* Since glibc 2.12: */ _POSIX_C_SOURCE\ >=\ 200809L
Packit 7cfc04
    || /* Glibc versions <= 2.19: */ _BSD_SOURCE
Packit 7cfc04
.RE
Packit 7cfc04
.ad
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
.BR siginterrupt ()
Packit 7cfc04
function changes the restart behavior when
Packit 7cfc04
a system call is interrupted by the signal \fIsig\fP.
Packit 7cfc04
If the \fIflag\fP
Packit 7cfc04
argument is false (0), then system calls will be restarted if interrupted
Packit 7cfc04
by the specified signal \fIsig\fP.
Packit 7cfc04
This is the default behavior in Linux.
Packit 7cfc04
.PP
Packit 7cfc04
If the \fIflag\fP argument is true (1) and no data has been transferred,
Packit 7cfc04
then a system call interrupted by the signal \fIsig\fP will return \-1
Packit 7cfc04
and \fIerrno\fP will be set to
Packit 7cfc04
.BR EINTR .
Packit 7cfc04
.PP
Packit 7cfc04
If the \fIflag\fP argument is true (1) and data transfer has started,
Packit 7cfc04
then the system call will be interrupted and will return the actual
Packit 7cfc04
amount of data transferred.
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
The
Packit 7cfc04
.BR siginterrupt ()
Packit 7cfc04
function returns 0 on success.
Packit 7cfc04
It returns \-1 if the
Packit 7cfc04
signal number
Packit 7cfc04
.I sig
Packit 7cfc04
is invalid, with
Packit 7cfc04
.I errno
Packit 7cfc04
set to indicate the cause of the error.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
.TP
Packit 7cfc04
.B EINVAL
Packit 7cfc04
The specified signal number is invalid.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lb lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR siginterrupt ()
Packit 7cfc04
T}	Thread safety	MT-Unsafe const:sigintr
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
4.3BSD, POSIX.1-2001.
Packit 7cfc04
POSIX.1-2008 marks
Packit 7cfc04
.BR siginterrupt ()
Packit 7cfc04
as obsolete, recommending the use of
Packit 7cfc04
.BR sigaction (2)
Packit 7cfc04
with the
Packit 7cfc04
.B SA_RESTART
Packit 7cfc04
flag instead.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR signal (2)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.