xref: /freebsd/share/man/man3/pthread_multi_np.3 (revision e716630d4cf89e69ec3f675ebfceee09f1a85e05)
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_MULTI_NP 3
27.Os
28.Sh NAME
29.Nm pthread_multi_np ,
30.Nm pthread_single_np
31.Nd "switch between multi- and single-threaded scheduling modes"
32.Sh LIBRARY
33.Lb libpthread
34.Sh SYNOPSIS
35.In pthread_np.h
36.Ft int
37.Fn pthread_multi_np void
38.Ft int
39.Fn pthread_single_np void
40.Sh DESCRIPTION
41The
42.Fn pthread_single_np
43function switches the process to a single-threaded mode, i.e.,
44suspends all threads except the current.
45The semantics of this function is similar to
46.Xr pthread_suspend_all_np 3 .
47.Pp
48The
49.Fn pthread_multi_np
50function switches the process to a multi-threaded mode.
51The semantics of this function is similar to
52.Xr pthread_resume_all_np 3 .
53.Sh RETURN VALUES
54The
55.Fn pthread_multi_np
56and
57.Nm pthread_single_np
58functions always return 0.
59.Sh SEE ALSO
60.Xr pthread_np 3 ,
61.Xr pthread_resume_all_np 3 ,
62.Xr pthread_suspend_all_np 3
63.Sh AUTHORS
64This manual page was written by
65.An Alexey Zelkin Aq Mt phantom@FreeBSD.org .
66