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$
  27 .\"
  28 .Dd February 6, 2011
  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 pid_t
  39 .Fn rfork_thread "int flags" "void *stack" "int (*func)(void *arg)" "void *arg"
  40 .Sh DESCRIPTION
  41 .Bf -symbolic
  42 The
  43 .Fn rfork_thread
  44 function has been deprecated in favor of
  45 .Xr pthread_create 3 .
  46 .Ef
  47 .Pp
  48 The
  49 .Fn rfork_thread
  50 function
  51 is a helper function for
  52 .Xr rfork 2 .
  53 It arranges for a new process to be created and the child process will
  54 call the specified function with the specified argument, while running on
  55 the supplied stack.
  56 .Pp
  57 Using this function should avoid the need to implement complex stack
  58 swap code.
  59 .Sh RETURN VALUES
  60 Upon successful completion,
  61 .Fn rfork_thread
  62 returns the process ID of the child process to the parent process.
  63 Otherwise, a value of -1 is returned
  64 to the parent process, no child process is created, and the global
  65 variable
  66 .Va errno
  67 is set to indicate the error.
  68 .Pp
  69 The child process context is not aware of a return from the
  70 .Fn rfork_thread
  71 function as it begins executing directly with the supplied function.
  72 .Sh ERRORS
  73 See
  74 .Xr rfork 2
  75 for error return codes.
  76 .Sh SEE ALSO
  77 .Xr fork 2 ,
  78 .Xr intro 2 ,
  79 .Xr minherit 2 ,
  80 .Xr rfork 2 ,
  81 .Xr vfork 2 ,
  82 .Xr pthread_create 3
  83 .Sh HISTORY
  84 The
  85 .Fn rfork_thread
  86 function first appeared in
  87 .Fx 4.3 .