xref: /freebsd/share/man/man3/pthread_suspend_all_np.3 (revision e6bfd18d21b225af6a0ed67ceeaf1293b7b9eba5)
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.\" $FreeBSD$
26.\"
27.Dd October 12, 2021
28.Dt PTHREAD_SUSPEND_ALL_NP 3
29.Os
30.Sh NAME
31.Nm pthread_suspend_all_np
32.Nd suspend all active threads
33.Sh LIBRARY
34.Lb libpthread
35.Sh SYNOPSIS
36.In pthread_np.h
37.Ft void
38.Fn pthread_suspend_all_np void
39.Sh DESCRIPTION
40The
41.Fn pthread_suspend_all_np
42function causes all active threads to be suspended.
43The only exception is the current thread,
44the thread that called the
45.Fn pthread_suspend_all_np
46function.
47.Pp
48It is not safe for the caller of the
49.Fn pthread_suspend_all_np
50function to use any non-async signal safe functions, besides
51.Xr pthread_resume_all_np 3 ,
52until threads are resumed, unless measures are taken to ensure
53that all threads are suspended at safe points.
54.Sh SEE ALSO
55.Xr pthread_np 3 ,
56.Xr pthread_resume_all_np 3 ,
57.Xr pthread_resume_np 3 ,
58.Xr pthread_suspend_np 3
59.Sh AUTHORS
60This manual page was written by
61.An Alexey Zelkin Aq Mt phantom@FreeBSD.org .
62