xref: /netbsd/lib/libc/gen/_lwp_makecontext.3 (revision 6550d01e)
1.\"	$NetBSD: _lwp_makecontext.3,v 1.4 2008/04/30 13:10:50 martin 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.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd January 16, 2003
31.Dt _LWP_MAKECONTEXT 3
32.Os
33.Sh NAME
34.Nm _lwp_makecontext
35.Nd create a new initial light-weight process execution context
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In lwp.h
40.Ft void
41.Fn _lwp_makecontext "ucontext_t *context" "void (*start_routine)(void *)" \
42    "void *arg" "void *private" "caddr_t stack_base" "size_t stack_size"
43.Sh DESCRIPTION
44.Fn _lwp_makecontext
45initializes the context structure pointed to by
46.Fa context
47in a manner suitable for using with
48.Xr _lwp_create 2 .
49The LWP will begin execution at the function specified by
50.Fa start_routine
51which will be passed a single argument
52.Fa arg .
53The LWP private data pointer will be set to
54.Fa private .
55The stack region for the new LWP is specified by the
56.Fa stack_base
57and
58.Fa stack_size
59arguments.
60.Pp
61The signal mask in the context structure is not initialized by
62.Fn _lwp_makecontext .
63.Sh SEE ALSO
64.Xr _lwp_create 2 ,
65.Xr _lwp_getprivate 2
66.Sh HISTORY
67The
68.Fn _lwp_create
69system call first appeared in
70.Nx 2.0 .
71.Sh BUGS
72The LWP private data pointer is not initialized by the current
73implementation of
74.Fn _lwp_makecontext .
75