xref: /minix3/lib/libc/gen/_lwp_makecontext.3 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1*2fe8fb19SBen Gras.\"	$NetBSD: _lwp_makecontext.3,v 1.4 2008/04/30 13:10:50 martin Exp $
2*2fe8fb19SBen Gras.\"
3*2fe8fb19SBen Gras.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
4*2fe8fb19SBen Gras.\" All rights reserved.
5*2fe8fb19SBen Gras.\"
6*2fe8fb19SBen Gras.\" This code is derived from software contributed to The NetBSD Foundation
7*2fe8fb19SBen Gras.\" by Jason R. Thorpe of Wasabi Systems, Inc.
8*2fe8fb19SBen Gras.\"
9*2fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
10*2fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
11*2fe8fb19SBen Gras.\" are met:
12*2fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
13*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
14*2fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
15*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
16*2fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
17*2fe8fb19SBen Gras.\"
18*2fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19*2fe8fb19SBen Gras.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20*2fe8fb19SBen Gras.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21*2fe8fb19SBen Gras.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22*2fe8fb19SBen Gras.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23*2fe8fb19SBen Gras.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24*2fe8fb19SBen Gras.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25*2fe8fb19SBen Gras.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26*2fe8fb19SBen Gras.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27*2fe8fb19SBen Gras.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28*2fe8fb19SBen Gras.\" POSSIBILITY OF SUCH DAMAGE.
29*2fe8fb19SBen Gras.\"
30*2fe8fb19SBen Gras.Dd January 16, 2003
31*2fe8fb19SBen Gras.Dt _LWP_MAKECONTEXT 3
32*2fe8fb19SBen Gras.Os
33*2fe8fb19SBen Gras.Sh NAME
34*2fe8fb19SBen Gras.Nm _lwp_makecontext
35*2fe8fb19SBen Gras.Nd create a new initial light-weight process execution context
36*2fe8fb19SBen Gras.Sh LIBRARY
37*2fe8fb19SBen Gras.Lb libc
38*2fe8fb19SBen Gras.Sh SYNOPSIS
39*2fe8fb19SBen Gras.In lwp.h
40*2fe8fb19SBen Gras.Ft void
41*2fe8fb19SBen Gras.Fn _lwp_makecontext "ucontext_t *context" "void (*start_routine)(void *)" \
42*2fe8fb19SBen Gras    "void *arg" "void *private" "caddr_t stack_base" "size_t stack_size"
43*2fe8fb19SBen Gras.Sh DESCRIPTION
44*2fe8fb19SBen Gras.Fn _lwp_makecontext
45*2fe8fb19SBen Grasinitializes the context structure pointed to by
46*2fe8fb19SBen Gras.Fa context
47*2fe8fb19SBen Grasin a manner suitable for using with
48*2fe8fb19SBen Gras.Xr _lwp_create 2 .
49*2fe8fb19SBen GrasThe LWP will begin execution at the function specified by
50*2fe8fb19SBen Gras.Fa start_routine
51*2fe8fb19SBen Graswhich will be passed a single argument
52*2fe8fb19SBen Gras.Fa arg .
53*2fe8fb19SBen GrasThe LWP private data pointer will be set to
54*2fe8fb19SBen Gras.Fa private .
55*2fe8fb19SBen GrasThe stack region for the new LWP is specified by the
56*2fe8fb19SBen Gras.Fa stack_base
57*2fe8fb19SBen Grasand
58*2fe8fb19SBen Gras.Fa stack_size
59*2fe8fb19SBen Grasarguments.
60*2fe8fb19SBen Gras.Pp
61*2fe8fb19SBen GrasThe signal mask in the context structure is not initialized by
62*2fe8fb19SBen Gras.Fn _lwp_makecontext .
63*2fe8fb19SBen Gras.Sh SEE ALSO
64*2fe8fb19SBen Gras.Xr _lwp_create 2 ,
65*2fe8fb19SBen Gras.Xr _lwp_getprivate 2
66*2fe8fb19SBen Gras.Sh HISTORY
67*2fe8fb19SBen GrasThe
68*2fe8fb19SBen Gras.Fn _lwp_create
69*2fe8fb19SBen Grassystem call first appeared in
70*2fe8fb19SBen Gras.Nx 2.0 .
71*2fe8fb19SBen Gras.Sh BUGS
72*2fe8fb19SBen GrasThe LWP private data pointer is not initialized by the current
73*2fe8fb19SBen Grasimplementation of
74*2fe8fb19SBen Gras.Fn _lwp_makecontext .
75