xref: /netbsd-src/lib/libc/gen/_lwp_makecontext.3 (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1.\"	$NetBSD: _lwp_makecontext.3,v 1.3 2003/04/16 13:34:35 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 16, 2003
38.Dt _LWP_MAKECONTEXT 3
39.Os
40.Sh NAME
41.Nm _lwp_makecontext
42.Nd create a new initial light-weight process execution context
43.Sh LIBRARY
44.Lb libc
45.Sh SYNOPSIS
46.In lwp.h
47.Ft void
48.Fn _lwp_makecontext "ucontext_t *context" "void (*start_routine)(void *)" \
49    "void *arg" "void *private" "caddr_t stack_base" "size_t stack_size"
50.Sh DESCRIPTION
51.Fn _lwp_makecontext
52initializes the context structure pointed to by
53.Fa context
54in a manner suitable for using with
55.Xr _lwp_create 2 .
56The LWP will begin execution at the function specified by
57.Fa start_routine
58which will be passed a single argument
59.Fa arg .
60The LWP private data pointer will be set to
61.Fa private .
62The stack region for the new LWP is specified by the
63.Fa stack_base
64and
65.Fa stack_size
66arguments.
67.Pp
68The signal mask in the context structure is not initialized by
69.Fn _lwp_makecontext .
70.Sh SEE ALSO
71.Xr _lwp_create 2 ,
72.Xr _lwp_getprivate 2
73.Sh HISTORY
74The
75.Fn _lwp_create
76system call first appeared in
77.Nx 2.0 .
78.Sh BUGS
79The LWP private data pointer is not initialized by the current
80implementation of
81.Fn _lwp_makecontext .
82