[thirdparty/man-pages.git] / man2 / sgetmask.2

'\" t
.\" Copyright (c) 2007 by Michael Kerrisk <mtk.manpages@gmail.com>
.\"
.\" %%%LICENSE_START(VERBATIM)
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" %%%LICENSE_END
.\"
.TH SGETMASK 2  2017-09-15 "Linux" "Linux Programmer's Manual"
.SH NAME
sgetmask, ssetmask \- manipulation of signal mask (obsolete)
.SH SYNOPSIS
.B "long sgetmask(void);"
.PP
.BI "long ssetmask(long " newmask );
.PP
.IR Note :
There are no glibc wrappers for these system calls; see NOTES.
.SH DESCRIPTION
These system calls are obsolete.
.IR "Do not use them" ;
use
.BR sigprocmask (2)
instead.
.PP
.BR sgetmask ()
returns the signal mask of the calling process.
.PP
.BR ssetmask ()
sets the signal mask of the calling process to the value given in
.IR newmask .
The previous signal mask is returned.
.PP
The signal masks dealt with by these two system calls
are plain bit masks (unlike the
.I sigset_t
used by
.BR sigprocmask (2));
use
.BR sigmask (3)
to create and inspect these masks.
.SH RETURN VALUE
.BR sgetmask ()
always successfully returns the signal mask.
.BR ssetmask ()
always succeeds, and returns the previous signal mask.
.SH ERRORS
These system calls always succeed.
.SH VERSIONS
Since Linux 3.16,
.\" f6187769dae48234f3877df3c4d99294cc2254fa
support for these system calls is optional,
depending on whether the kernel was built with the
.B CONFIG_SGETMASK_SYSCALL
option.
.SH CONFORMING TO
These system calls are Linux-specific.
.SH NOTES
Glibc does not provide wrappers for these obsolete system calls;
in the unlikely event that you want to call them, use
.BR syscall (2).
.PP
These system calls are unaware of signal numbers greater than 31
(i.e., real-time signals).
.PP
These system calls do not exist on x86-64.
.PP
It is not possible to block
.B SIGSTOP
or
.BR SIGKILL .
.SH SEE ALSO
.BR sigprocmask (2),
.BR signal (7)
Commit	Line	Data
c48ef83f	1	'\" t
c11b1abf	2	.\" Copyright (c) 2007 by Michael Kerrisk <mtk.manpages@gmail.com>
c48ef83f	3	.\"
93015253	4	.\" %%%LICENSE_START(VERBATIM)
c48ef83f MK	5	.\" Permission is granted to make and distribute verbatim copies of this
	6	.\" manual provided the copyright notice and this permission notice are
	7	.\" preserved on all copies.
	8	.\"
	9	.\" Permission is granted to copy and distribute modified versions of this
	10	.\" manual under the conditions for verbatim copying, provided that the
	11	.\" entire resulting derived work is distributed under the terms of a
	12	.\" permission notice identical to this one.
	13	.\"
	14	.\" Since the Linux kernel and libraries are constantly changing, this
	15	.\" manual page may be incorrect or out-of-date. The author(s) assume no
	16	.\" responsibility for errors or omissions, or for damages resulting from
10d76543 MK	17	.\" the use of the information contained herein. The author(s) may not
	18	.\" have taken the same level of care in the production of this manual,
	19	.\" which is licensed free of charge, as they might when working
	20	.\" professionally.
c48ef83f MK	21	.\"
	22	.\" Formatted or processed versions of this manual, if unaccompanied by
	23	.\" the source, must acknowledge the copyright and authors of this work.
4b72fb64	24	.\" %%%LICENSE_END
c48ef83f	25	.\"
4b8c67d9	26	.TH SGETMASK 2 2017-09-15 "Linux" "Linux Programmer's Manual"
c48ef83f MK	27	.SH NAME
	28	sgetmask, ssetmask \- manipulation of signal mask (obsolete)
	29	.SH SYNOPSIS
0daa9e92	30	.B "long sgetmask(void);"
68e4db0a	31	.PP
c48ef83f	32	.BI "long ssetmask(long " newmask );
dbfe9c70	33	.PP
45c99e3e MK	34	.IR Note :
45c99e3e MK	35	There are no glibc wrappers for these system calls; see NOTES.
c48ef83f MK	36	.SH DESCRIPTION
	37	These system calls are obsolete.
	38	.IR "Do not use them" ;
	39	use
	40	.BR sigprocmask (2)
	41	instead.
efeece04	42	.PP
c48ef83f MK	43	.BR sgetmask ()
c48ef83f MK	44	returns the signal mask of the calling process.
efeece04	45	.PP
c48ef83f	46	.BR ssetmask ()
0fa2491f	47	sets the signal mask of the calling process to the value given in
c48ef83f MK	48	.IR newmask .
c48ef83f MK	49	The previous signal mask is returned.
efeece04	50	.PP
c48ef83f MK	51	The signal masks dealt with by these two system calls
	52	are plain bit masks (unlike the
	53	.I sigset_t
	54	used by
	55	.BR sigprocmask (2));
0fa2491f	56	use
c48ef83f	57	.BR sigmask (3)
0fa2491f	58	to create and inspect these masks.
c48ef83f MK	59	.SH RETURN VALUE
	60	.BR sgetmask ()
	61	always successfully returns the signal mask.
	62	.BR ssetmask ()
	63	always succeeds, and returns the previous signal mask.
	64	.SH ERRORS
	65	These system calls always succeed.
a9adf515 MK	66	.SH VERSIONS
	67	Since Linux 3.16,
	68	.\" f6187769dae48234f3877df3c4d99294cc2254fa
	69	support for these system calls is optional,
	70	depending on whether the kernel was built with the
	71	.B CONFIG_SGETMASK_SYSCALL
	72	option.
c48ef83f	73	.SH CONFORMING TO
8382f16d	74	These system calls are Linux-specific.
c48ef83f	75	.SH NOTES
45c99e3e MK	76	Glibc does not provide wrappers for these obsolete system calls;
45c99e3e MK	77	in the unlikely event that you want to call them, use
c48ef83f	78	.BR syscall (2).
efeece04	79	.PP
c48ef83f MK	80	These system calls are unaware of signal numbers greater than 31
c48ef83f MK	81	(i.e., real-time signals).
efeece04	82	.PP
cb012d1d	83	These system calls do not exist on x86-64.
efeece04	84	.PP
c48ef83f MK	85	It is not possible to block
	86	.B SIGSTOP
	87	or
	88	.BR SIGKILL .
	89	.SH SEE ALSO
0fa2491f	90	.BR sigprocmask (2),
c48ef83f	91	.BR signal (7)