lib/libc/gen/rfork_thread.3

   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 .\"
  28 .Dd July 29, 2000
  29 .Dt RFORK_THREAD 3
  30 .Os
  31 .Sh NAME
  32 .Nm rfork_thread
  33 .Nd create a rfork-based process thread
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In unistd.h
  38 .Ft int
  39 .Fn rfork_thread "int flags" "void *stack" "int (*func)(void *arg)" "void *arg"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn rfork_thread
  43 function
  44 is a helper function for
  45 .Xr rfork 2 .
  46 It arranges for a new process to be created and the child process will
  47 call the specified function with the specified argument, while running on
  48 the supplied stack.
  49 .Pp
  50 Using this function should avoid the need to implement complex stack
  51 swap code.
  52 .Sh RETURN VALUES
  53 Upon successful completion,
  54 .Fn rfork_thread
  55 returns the process ID of the child process to the parent process.
  56 Otherwise, a value of -1 is returned
  57 to the parent process, no child process is created, and the global
  58 variable
  59 .Va errno
  60 is set to indicate the error.
  61 .Pp
  62 The child process context is not aware of a return from the
  63 .Fn rfork_thread
  64 function as it begins executing directly with the supplied function.
  65 .Sh ERRORS
  66 See
  67 .Xr rfork 2
  68 for error return codes.
  69 .Sh SEE ALSO
  70 .Xr fork 2 ,
  71 .Xr intro 2 ,
  72 .Xr minherit 2 ,
  73 .Xr rfork 2 ,
  74 .Xr vfork 2
  75 .Sh HISTORY
  76 The
  77 .Fn rfork_thread
  78 function first appeared in
  79 .Fx 4.3 .