|
Packit |
7cfc04 |
.\" Copyright (c) 2009 Linux Foundation, written by Michael Kerrisk
|
|
Packit |
7cfc04 |
.\" <mtk.manpages@gmail.com>
|
|
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 |
.TH PTHREAD_SIGMASK 3 2017-09-15 "Linux" "Linux Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
pthread_sigmask \- examine and change mask of blocked signals
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
.B #include <signal.h>
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
.BI "int pthread_sigmask(int " how ", const sigset_t *" set \
|
|
Packit |
7cfc04 |
", sigset_t *" oldset );
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
Compile and link with \fI\-pthread\fP.
|
|
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 |
.ad l
|
|
Packit |
7cfc04 |
.BR pthread_sigmask ():
|
|
Packit |
7cfc04 |
.RS 4
|
|
Packit |
7cfc04 |
_POSIX_C_SOURCE\ >=\ 199506L || _XOPEN_SOURCE\ >=\ 500
|
|
Packit |
7cfc04 |
.RE
|
|
Packit |
7cfc04 |
.ad b
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
.BR pthread_sigmask ()
|
|
Packit |
7cfc04 |
function is just like
|
|
Packit |
7cfc04 |
.BR sigprocmask (2),
|
|
Packit |
7cfc04 |
with the difference that its use in multithreaded programs
|
|
Packit |
7cfc04 |
is explicitly specified by POSIX.1.
|
|
Packit |
7cfc04 |
Other differences are noted in this page.
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
For a description of the arguments and operation of this function, see
|
|
Packit |
7cfc04 |
.BR sigprocmask (2).
|
|
Packit |
7cfc04 |
.SH RETURN VALUE
|
|
Packit |
7cfc04 |
On success,
|
|
Packit |
7cfc04 |
.BR pthread_sigmask ()
|
|
Packit |
7cfc04 |
returns 0;
|
|
Packit |
7cfc04 |
on error, it returns an error number.
|
|
Packit |
7cfc04 |
.SH ERRORS
|
|
Packit |
7cfc04 |
See
|
|
Packit |
7cfc04 |
.BR sigprocmask (2).
|
|
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 pthread_sigmask ()
|
|
Packit |
7cfc04 |
T} Thread safety MT-Safe
|
|
Packit |
7cfc04 |
.TE
|
|
Packit |
7cfc04 |
.SH CONFORMING TO
|
|
Packit |
7cfc04 |
POSIX.1-2001, POSIX.1-2008.
|
|
Packit |
7cfc04 |
.SH NOTES
|
|
Packit |
7cfc04 |
A new thread inherits a copy of its creator's signal mask.
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
The glibc
|
|
Packit |
7cfc04 |
.BR pthread_sigmask ()
|
|
Packit |
7cfc04 |
function silently ignores attempts to block the two real-time signals that
|
|
Packit |
7cfc04 |
are used internally by the NPTL threading implementation.
|
|
Packit |
7cfc04 |
See
|
|
Packit |
7cfc04 |
.BR nptl (7)
|
|
Packit |
7cfc04 |
for details.
|
|
Packit |
7cfc04 |
.SH EXAMPLE
|
|
Packit |
7cfc04 |
The program below blocks some signals in the main thread,
|
|
Packit |
7cfc04 |
and then creates a dedicated thread to fetch those signals via
|
|
Packit |
7cfc04 |
.BR sigwait (3).
|
|
Packit |
7cfc04 |
The following shell session demonstrates its use:
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
.in +4n
|
|
Packit |
7cfc04 |
.EX
|
|
Packit |
7cfc04 |
.RB "$" " ./a.out &"
|
|
Packit |
7cfc04 |
[1] 5423
|
|
Packit |
7cfc04 |
.RB "$" " kill \-QUIT %1"
|
|
Packit |
7cfc04 |
Signal handling thread got signal 3
|
|
Packit |
7cfc04 |
.RB "$" " kill \-USR1 %1"
|
|
Packit |
7cfc04 |
Signal handling thread got signal 10
|
|
Packit |
7cfc04 |
.RB "$" " kill \-TERM %1"
|
|
Packit |
7cfc04 |
[1]+ Terminated ./a.out
|
|
Packit |
7cfc04 |
.EE
|
|
Packit |
7cfc04 |
.in
|
|
Packit |
7cfc04 |
.SS Program source
|
|
Packit |
7cfc04 |
\&
|
|
Packit |
7cfc04 |
.EX
|
|
Packit |
7cfc04 |
#include <pthread.h>
|
|
Packit |
7cfc04 |
#include <stdio.h>
|
|
Packit |
7cfc04 |
#include <stdlib.h>
|
|
Packit |
7cfc04 |
#include <unistd.h>
|
|
Packit |
7cfc04 |
#include <signal.h>
|
|
Packit |
7cfc04 |
#include <errno.h>
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
/* Simple error handling functions */
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
#define handle_error_en(en, msg) \\
|
|
Packit |
7cfc04 |
do { errno = en; perror(msg); exit(EXIT_FAILURE); } while (0)
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
static void *
|
|
Packit |
7cfc04 |
sig_thread(void *arg)
|
|
Packit |
7cfc04 |
{
|
|
Packit |
7cfc04 |
sigset_t *set = arg;
|
|
Packit |
7cfc04 |
int s, sig;
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
for (;;) {
|
|
Packit |
7cfc04 |
s = sigwait(set, &sig);
|
|
Packit |
7cfc04 |
if (s != 0)
|
|
Packit |
7cfc04 |
handle_error_en(s, "sigwait");
|
|
Packit |
7cfc04 |
printf("Signal handling thread got signal %d\\n", sig);
|
|
Packit |
7cfc04 |
}
|
|
Packit |
7cfc04 |
}
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
int
|
|
Packit |
7cfc04 |
main(int argc, char *argv[])
|
|
Packit |
7cfc04 |
{
|
|
Packit |
7cfc04 |
pthread_t thread;
|
|
Packit |
7cfc04 |
sigset_t set;
|
|
Packit |
7cfc04 |
int s;
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
/* Block SIGQUIT and SIGUSR1; other threads created by main()
|
|
Packit |
7cfc04 |
will inherit a copy of the signal mask. */
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
sigemptyset(&set);
|
|
Packit |
7cfc04 |
sigaddset(&set, SIGQUIT);
|
|
Packit |
7cfc04 |
sigaddset(&set, SIGUSR1);
|
|
Packit |
7cfc04 |
s = pthread_sigmask(SIG_BLOCK, &set, NULL);
|
|
Packit |
7cfc04 |
if (s != 0)
|
|
Packit |
7cfc04 |
handle_error_en(s, "pthread_sigmask");
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
s = pthread_create(&thread, NULL, &sig_thread, (void *) &set);
|
|
Packit |
7cfc04 |
if (s != 0)
|
|
Packit |
7cfc04 |
handle_error_en(s, "pthread_create");
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
/* Main thread carries on to create other threads and/or do
|
|
Packit |
7cfc04 |
other work */
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
pause(); /* Dummy pause so we can test program */
|
|
Packit |
7cfc04 |
}
|
|
Packit |
7cfc04 |
.EE
|
|
Packit |
7cfc04 |
.SH SEE ALSO
|
|
Packit |
7cfc04 |
.BR sigaction (2),
|
|
Packit |
7cfc04 |
.BR sigpending (2),
|
|
Packit |
7cfc04 |
.BR sigprocmask (2),
|
|
Packit |
7cfc04 |
.BR pthread_create (3),
|
|
Packit |
7cfc04 |
.BR pthread_kill (3),
|
|
Packit |
7cfc04 |
.BR sigsetops (3),
|
|
Packit |
7cfc04 |
.BR pthreads (7),
|
|
Packit |
7cfc04 |
.BR signal (7)
|
|
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/.
|