1.\" $NetBSD: _lwp_create.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_CREATE 2 39.Os 40.Sh NAME 41.Nm _lwp_create 42.Nd create a new light-weight process 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.In lwp.h 47.Ft int 48.Fn _lwp_create "ucontext_t *context" "unsigned long flags" "lwpid_t *new_lwp" 49.Sh DESCRIPTION 50.Fn _lwp_create 51causes creation of a new light-weight process, or LWP, and adds it to the 52current process. 53The 54.Fa context 55argument specifies the initial execution context for the new LWP including 56signal mask, stack, and machine registers. 57.Pp 58The following flags affect the creation of the new LWP: 59.Bl -tag -width LWP_SUSPENDED 60.It LWP_DETACHED 61The LWP is created detached. 62The resources associated with a detached LWP will be automatically 63reclaimed by the system when the LWP exits. 64Otherwise, a terminated LWP's resources will not be reclaimed until 65its status is reported to another LWP via 66.Xr _lwp_wait 2 . 67.It LWP_SUSPENDED 68The LWP is created suspended, and will not begin execution until 69it is resumed by another LWP via 70.Xr _lwp_continue 2 . 71.\" __LWP_ASLWP is not yet implemented by the NetBSD kernel. 72.El 73.Pp 74The LWP ID of the new LWP is stored in the location pointed to by 75.Fa new_lwp . 76.Sh RETURN VALUES 77Upon successful completion, 78.Fn _lwp_create 79returns a value of 0. 80Otherwise, an error code is returned to indicate the error. 81.Sh ERRORS 82.Fn _lwp_create 83will fail and no LWP will be created if: 84.Bl -tag -width [EAGAIN] 85.It Bq Er EAGAIN 86The system-imposed limit on the total 87number of LWPs under execution would be exceeded. 88This limit is configuration-dependent. 89.It Bq Er ENOMEM 90There is insufficient swap space for the new LWP. 91.It Bq Er EFAULT 92The address pointed to by 93.Fa context 94or 95.Fa new_lwp 96is outside the process's allocated address space. 97.El 98.Sh SEE ALSO 99.Xr _lwp_continue 2 , 100.Xr _lwp_exit 2 , 101.Xr _lwp_wait 2 , 102.Xr _lwp_makecontext 3 103.Sh HISTORY 104The 105.Fn _lwp_create 106system call first appeared in 107.Nx 2.0 . 108