1*86d7f5d3SJohn Marino.\" 2*86d7f5d3SJohn Marino.\" Copyright (c) 2000 Peter Wemm <peter@FreeBSD.org> 3*86d7f5d3SJohn Marino.\" All rights reserved. 4*86d7f5d3SJohn Marino.\" 5*86d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without 6*86d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions 7*86d7f5d3SJohn Marino.\" are met: 8*86d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright 9*86d7f5d3SJohn Marino.\" notice, this list of conditions and the following disclaimer. 10*86d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright 11*86d7f5d3SJohn Marino.\" notice, this list of conditions and the following disclaimer in the 12*86d7f5d3SJohn Marino.\" documentation and/or other materials provided with the distribution. 13*86d7f5d3SJohn Marino.\" 14*86d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15*86d7f5d3SJohn Marino.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16*86d7f5d3SJohn Marino.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17*86d7f5d3SJohn Marino.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18*86d7f5d3SJohn Marino.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19*86d7f5d3SJohn Marino.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20*86d7f5d3SJohn Marino.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21*86d7f5d3SJohn Marino.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22*86d7f5d3SJohn Marino.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23*86d7f5d3SJohn Marino.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24*86d7f5d3SJohn Marino.\" SUCH DAMAGE. 25*86d7f5d3SJohn Marino.\" 26*86d7f5d3SJohn Marino.\" $FreeBSD: src/lib/libc/gen/rfork_thread.3,v 1.2.2.5 2003/03/15 15:11:05 trhodes Exp $ 27*86d7f5d3SJohn Marino.\" $DragonFly: src/lib/libc/gen/rfork_thread.3,v 1.2 2003/06/17 04:26:42 dillon Exp $ 28*86d7f5d3SJohn Marino.\" 29*86d7f5d3SJohn Marino.Dd July 29, 2000 30*86d7f5d3SJohn Marino.Dt RFORK_THREAD 3 31*86d7f5d3SJohn Marino.Os 32*86d7f5d3SJohn Marino.Sh NAME 33*86d7f5d3SJohn Marino.Nm rfork_thread 34*86d7f5d3SJohn Marino.Nd create a rfork-based process thread 35*86d7f5d3SJohn Marino.Sh LIBRARY 36*86d7f5d3SJohn Marino.Lb libc 37*86d7f5d3SJohn Marino.Sh SYNOPSIS 38*86d7f5d3SJohn Marino.In unistd.h 39*86d7f5d3SJohn Marino.Ft int 40*86d7f5d3SJohn Marino.Fn rfork_thread "int flags" "void *stack" "int (*func)(void *arg)" "void *arg" 41*86d7f5d3SJohn Marino.Sh DESCRIPTION 42*86d7f5d3SJohn MarinoThe 43*86d7f5d3SJohn Marino.Fn rfork_thread 44*86d7f5d3SJohn Marinofunction 45*86d7f5d3SJohn Marinois a helper function for 46*86d7f5d3SJohn Marino.Xr rfork 2 . 47*86d7f5d3SJohn MarinoIt arranges for a new process to be created and the child process will 48*86d7f5d3SJohn Marinocall the specified function with the specified argument, while running on 49*86d7f5d3SJohn Marinothe supplied stack. 50*86d7f5d3SJohn Marino.Pp 51*86d7f5d3SJohn MarinoUsing this function should avoid the need to implement complex stack 52*86d7f5d3SJohn Marinoswap code. 53*86d7f5d3SJohn Marino.Sh RETURN VALUES 54*86d7f5d3SJohn MarinoUpon successful completion, 55*86d7f5d3SJohn Marino.Fn rfork_thread 56*86d7f5d3SJohn Marinoreturns the process ID of the child process to the parent process. 57*86d7f5d3SJohn MarinoOtherwise, a value of -1 is returned 58*86d7f5d3SJohn Marinoto the parent process, no child process is created, and the global 59*86d7f5d3SJohn Marinovariable 60*86d7f5d3SJohn Marino.Va errno 61*86d7f5d3SJohn Marinois set to indicate the error. 62*86d7f5d3SJohn Marino.Pp 63*86d7f5d3SJohn MarinoThe child process context is not aware of a return from the 64*86d7f5d3SJohn Marino.Fn rfork_thread 65*86d7f5d3SJohn Marinofunction as it begins executing directly with the supplied function. 66*86d7f5d3SJohn Marino.Sh ERRORS 67*86d7f5d3SJohn MarinoSee 68*86d7f5d3SJohn Marino.Xr rfork 2 69*86d7f5d3SJohn Marinofor error return codes. 70*86d7f5d3SJohn Marino.Sh SEE ALSO 71*86d7f5d3SJohn Marino.Xr fork 2 , 72*86d7f5d3SJohn Marino.Xr intro 2 , 73*86d7f5d3SJohn Marino.Xr minherit 2 , 74*86d7f5d3SJohn Marino.Xr rfork 2 , 75*86d7f5d3SJohn Marino.Xr vfork 2 76*86d7f5d3SJohn Marino.Sh HISTORY 77*86d7f5d3SJohn MarinoThe 78*86d7f5d3SJohn Marino.Fn rfork_thread 79*86d7f5d3SJohn Marinofunction first appeared in 80*86d7f5d3SJohn Marino.Fx 4.3 . 81