xref: /freebsd/share/man/man3/pthread_suspend_all_np.3 (revision a4e5e0106ac7145f56eb39a691e302cabb4635be)
1.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd October 12, 2021
26.Dt PTHREAD_SUSPEND_ALL_NP 3
27.Os
28.Sh NAME
29.Nm pthread_suspend_all_np
30.Nd suspend all active threads
31.Sh LIBRARY
32.Lb libpthread
33.Sh SYNOPSIS
34.In pthread_np.h
35.Ft void
36.Fn pthread_suspend_all_np void
37.Sh DESCRIPTION
38The
39.Fn pthread_suspend_all_np
40function causes all active threads to be suspended.
41The only exception is the current thread,
42the thread that called the
43.Fn pthread_suspend_all_np
44function.
45.Pp
46It is not safe for the caller of the
47.Fn pthread_suspend_all_np
48function to use any non-async signal safe functions, besides
49.Xr pthread_resume_all_np 3 ,
50until threads are resumed, unless measures are taken to ensure
51that all threads are suspended at safe points.
52.Sh SEE ALSO
53.Xr pthread_np 3 ,
54.Xr pthread_resume_all_np 3 ,
55.Xr pthread_resume_np 3 ,
56.Xr pthread_suspend_np 3
57.Sh AUTHORS
58This manual page was written by
59.An Alexey Zelkin Aq Mt phantom@FreeBSD.org .
60