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