xref: /netbsd-src/lib/libc/sys/_lwp_suspend.2 (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1.\"	$NetBSD: _lwp_suspend.2,v 1.3 2003/04/16 13:34:50 wiz Exp $
2.\"
3.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Jason R. Thorpe of Wasabi Systems, Inc.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd January 13, 2003
38.Dt _LWP_SUSPEND 2
39.Os
40.Sh NAME
41.Nm _lwp_suspend ,
42.Nm _lwp_continue
43.Nd suspend or continue a light-weight process
44.Sh LIBRARY
45.Lb libc
46.Sh SYNOPSIS
47.In lwp.h
48.Ft int
49.Fn _lwp_suspend "lwpid_t lwp"
50.Ft int
51.Fn _lwp_continue "lwpid_t lwp"
52.Sh DESCRIPTION
53.Fn _lwp_suspend
54suspends execution of the LWP specified by
55.Fa lwp .
56Once an LWP is suspended, subsequent calls to
57.Fn _lwp_suspend
58have no effect.
59The only way to resume execution of a suspended LWP is via
60.Fn _lwp_continue .
61.Pp
62.Fn _lwp_continue
63resumes execution of the LWP specified by
64.Fa lwp .
65Once an LWP is resumed, subsequent calls to
66.Fn _lwp_continue
67have no effect.
68.Sh RETURN VALUES
69Upon successful completion,
70.Fn _lwp_suspend
71and
72.Fn _lwp_continue
73return a value of 0.
74Otherwise, an error code is returned to indicate the error.
75.Sh ERRORS
76.Fn _lwp_suspend
77and
78.Fn _lwp_continue
79will fail if:
80.Bl -tag -width [EDEADLK]
81.It Bq Er ESRCH
82No LWP can be found in the current process corresponding to that
83specified by
84.Fa lwp .
85.El
86.Pp
87.Fn _lwp_suspend
88will fail if:
89.Bl -tag -width [EDEADLK]
90.It Bq Er EDEADLK
91The LWP specified by
92.Fa lwp
93is the only LWP in the process.
94.El
95.Sh SEE ALSO
96.Xr _lwp_create 2
97.Sh HISTORY
98The
99.Fn _lwp_create
100system call first appeared in
101.Nx 2.0 .
102