xref: /dflybsd-src/lib/libc/gen/rfork_thread.3 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\"
286d7f5d3SJohn Marino.\" Copyright (c) 2000 Peter Wemm <peter@FreeBSD.org>
386d7f5d3SJohn Marino.\" All rights reserved.
486d7f5d3SJohn Marino.\"
586d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
686d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
786d7f5d3SJohn Marino.\" are met:
886d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
986d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
1086d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
1186d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
1286d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
1386d7f5d3SJohn Marino.\"
1486d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1586d7f5d3SJohn Marino.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1686d7f5d3SJohn Marino.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1786d7f5d3SJohn Marino.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1886d7f5d3SJohn Marino.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1986d7f5d3SJohn Marino.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2086d7f5d3SJohn Marino.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2186d7f5d3SJohn Marino.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2286d7f5d3SJohn Marino.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2386d7f5d3SJohn Marino.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2486d7f5d3SJohn Marino.\" SUCH DAMAGE.
2586d7f5d3SJohn Marino.\"
2686d7f5d3SJohn Marino.\" $FreeBSD: src/lib/libc/gen/rfork_thread.3,v 1.2.2.5 2003/03/15 15:11:05 trhodes Exp $
2786d7f5d3SJohn Marino.\" $DragonFly: src/lib/libc/gen/rfork_thread.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
2886d7f5d3SJohn Marino.\"
2986d7f5d3SJohn Marino.Dd July 29, 2000
3086d7f5d3SJohn Marino.Dt RFORK_THREAD 3
3186d7f5d3SJohn Marino.Os
3286d7f5d3SJohn Marino.Sh NAME
3386d7f5d3SJohn Marino.Nm rfork_thread
3486d7f5d3SJohn Marino.Nd create a rfork-based process thread
3586d7f5d3SJohn Marino.Sh LIBRARY
3686d7f5d3SJohn Marino.Lb libc
3786d7f5d3SJohn Marino.Sh SYNOPSIS
3886d7f5d3SJohn Marino.In unistd.h
3986d7f5d3SJohn Marino.Ft int
4086d7f5d3SJohn Marino.Fn rfork_thread "int flags" "void *stack" "int (*func)(void *arg)" "void *arg"
4186d7f5d3SJohn Marino.Sh DESCRIPTION
4286d7f5d3SJohn MarinoThe
4386d7f5d3SJohn Marino.Fn rfork_thread
4486d7f5d3SJohn Marinofunction
4586d7f5d3SJohn Marinois a helper function for
4686d7f5d3SJohn Marino.Xr rfork 2 .
4786d7f5d3SJohn MarinoIt arranges for a new process to be created and the child process will
4886d7f5d3SJohn Marinocall the specified function with the specified argument, while running on
4986d7f5d3SJohn Marinothe supplied stack.
5086d7f5d3SJohn Marino.Pp
5186d7f5d3SJohn MarinoUsing this function should avoid the need to implement complex stack
5286d7f5d3SJohn Marinoswap code.
5386d7f5d3SJohn Marino.Sh RETURN VALUES
5486d7f5d3SJohn MarinoUpon successful completion,
5586d7f5d3SJohn Marino.Fn rfork_thread
5686d7f5d3SJohn Marinoreturns the process ID of the child process to the parent process.
5786d7f5d3SJohn MarinoOtherwise, a value of -1 is returned
5886d7f5d3SJohn Marinoto the parent process, no child process is created, and the global
5986d7f5d3SJohn Marinovariable
6086d7f5d3SJohn Marino.Va errno
6186d7f5d3SJohn Marinois set to indicate the error.
6286d7f5d3SJohn Marino.Pp
6386d7f5d3SJohn MarinoThe child process context is not aware of a return from the
6486d7f5d3SJohn Marino.Fn rfork_thread
6586d7f5d3SJohn Marinofunction as it begins executing directly with the supplied function.
6686d7f5d3SJohn Marino.Sh ERRORS
6786d7f5d3SJohn MarinoSee
6886d7f5d3SJohn Marino.Xr rfork 2
6986d7f5d3SJohn Marinofor error return codes.
7086d7f5d3SJohn Marino.Sh SEE ALSO
7186d7f5d3SJohn Marino.Xr fork 2 ,
7286d7f5d3SJohn Marino.Xr intro 2 ,
7386d7f5d3SJohn Marino.Xr minherit 2 ,
7486d7f5d3SJohn Marino.Xr rfork 2 ,
7586d7f5d3SJohn Marino.Xr vfork 2
7686d7f5d3SJohn Marino.Sh HISTORY
7786d7f5d3SJohn MarinoThe
7886d7f5d3SJohn Marino.Fn rfork_thread
7986d7f5d3SJohn Marinofunction first appeared in
8086d7f5d3SJohn Marino.Fx 4.3 .
81