xref: /freebsd/share/man/man3/pthread_suspend_np.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1318d8cfdSAlexey Zelkin.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
2318d8cfdSAlexey Zelkin.\" All rights reserved.
3318d8cfdSAlexey Zelkin.\"
4318d8cfdSAlexey Zelkin.\" Redistribution and use in source and binary forms, with or without
5318d8cfdSAlexey Zelkin.\" modification, are permitted provided that the following conditions
6318d8cfdSAlexey Zelkin.\" are met:
7318d8cfdSAlexey Zelkin.\" 1. Redistributions of source code must retain the above copyright
8318d8cfdSAlexey Zelkin.\"    notice, this list of conditions and the following disclaimer.
9318d8cfdSAlexey Zelkin.\" 2. Redistributions in binary form must reproduce the above copyright
10318d8cfdSAlexey Zelkin.\"    notice, this list of conditions and the following disclaimer in the
11318d8cfdSAlexey Zelkin.\"    documentation and/or other materials provided with the distribution.
12318d8cfdSAlexey Zelkin.\"
13318d8cfdSAlexey Zelkin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14318d8cfdSAlexey Zelkin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15318d8cfdSAlexey Zelkin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16318d8cfdSAlexey Zelkin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17318d8cfdSAlexey Zelkin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18318d8cfdSAlexey Zelkin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19318d8cfdSAlexey Zelkin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20318d8cfdSAlexey Zelkin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21318d8cfdSAlexey Zelkin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22318d8cfdSAlexey Zelkin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23318d8cfdSAlexey Zelkin.\" SUCH DAMAGE.
24318d8cfdSAlexey Zelkin.\"
25*df7d7638SFelix Johnson.Dd October 12, 2021
26318d8cfdSAlexey Zelkin.Dt PTHREAD_SUSPEND_NP 3
27318d8cfdSAlexey Zelkin.Os
28318d8cfdSAlexey Zelkin.Sh NAME
29318d8cfdSAlexey Zelkin.Nm pthread_suspend_np
30318d8cfdSAlexey Zelkin.Nd suspend a thread
31318d8cfdSAlexey Zelkin.Sh LIBRARY
32ec7452f1SRuslan Ermilov.Lb libpthread
33318d8cfdSAlexey Zelkin.Sh SYNOPSIS
34318d8cfdSAlexey Zelkin.In pthread_np.h
35318d8cfdSAlexey Zelkin.Ft int
36318d8cfdSAlexey Zelkin.Fn pthread_suspend_np "pthread_t tid"
37318d8cfdSAlexey Zelkin.Sh DESCRIPTION
38318d8cfdSAlexey ZelkinThe
39318d8cfdSAlexey Zelkin.Fn pthread_suspend_np
40ace5be68SRuslan Ermilovfunction, called on an active thread, causes it to suspend.
419c671dbdSKonstantin Belousov.Pp
429c671dbdSKonstantin BelousovIt is not safe for the caller of the
439c671dbdSKonstantin Belousov.Fn pthread_suspend_np
449c671dbdSKonstantin Belousovfunction to use any non-async signal safe functions, except
459c671dbdSKonstantin Belousov.Xr pthread_resume_np 3 ,
469c671dbdSKonstantin Belousovuntil suspended thread is resumed, unless measures are taken to ensure
479c671dbdSKonstantin Belousovthat the thread is suspended at a safe point.
48318d8cfdSAlexey Zelkin.Sh RETURN VALUES
49318d8cfdSAlexey ZelkinIf successful,
50318d8cfdSAlexey Zelkin.Fn pthread_suspend_np
51318d8cfdSAlexey Zelkinfunction returns 0.
52318d8cfdSAlexey ZelkinOtherwise, an error number is returned to indicate the error.
53318d8cfdSAlexey Zelkin.Sh ERRORS
54318d8cfdSAlexey ZelkinThe
55318d8cfdSAlexey Zelkin.Fn pthread_suspend_np
56318d8cfdSAlexey Zelkinfunction will fail if:
57ace5be68SRuslan Ermilov.Bl -tag -width Er
58318d8cfdSAlexey Zelkin.It Bq Er EDEADLK
59ace5be68SRuslan ErmilovAn attempt was made to suspend the current thread.
60318d8cfdSAlexey Zelkin.It Bq Er EINVAL
61ace5be68SRuslan ErmilovThe value specified by the
62318d8cfdSAlexey Zelkin.Fa tid
63ace5be68SRuslan Ermilovargument is invalid.
64a8aad864SJilles Tjoelker.It Bq Er ESRCH
65ace5be68SRuslan ErmilovNo thread could be found corresponding to the thread ID specified by the
66318d8cfdSAlexey Zelkin.Fa tid
67318d8cfdSAlexey Zelkinargument.
68318d8cfdSAlexey Zelkin.El
69318d8cfdSAlexey Zelkin.Sh SEE ALSO
70*df7d7638SFelix Johnson.Xr pthread_np 3 ,
71318d8cfdSAlexey Zelkin.Xr pthread_resume_all_np 3 ,
72318d8cfdSAlexey Zelkin.Xr pthread_resume_np 3 ,
73318d8cfdSAlexey Zelkin.Xr pthread_suspend_all_np 3
74318d8cfdSAlexey Zelkin.Sh AUTHORS
75ace5be68SRuslan ErmilovThis manual page was written by
76a63d6c94SBaptiste Daroussin.An Alexey Zelkin Aq Mt phantom@FreeBSD.org .
77