share/man/man3/pthread_create.3

   1 .\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by John Birrell.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd April 4, 1996
  34 .Dt PTHREAD_CREATE 3
  35 .Os
  36 .Sh NAME
  37 .Nm pthread_create
  38 .Nd create a new thread
  39 .Sh LIBRARY
  40 .Lb libc_r
  41 .Sh SYNOPSIS
  42 .In pthread.h
  43 .Ft int
  44 .Fn pthread_create "pthread_t *thread" "const pthread_attr_t *attr" "void *(*start_routine)(void *)" "void *arg"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn pthread_create
  48 function is used to create a new thread, with attributes specified by
  49 .Fa attr ,
  50 within a process.
  51 If
  52 .Fa attr
  53 is NULL, the default attributes are used.
  54 If the attributes specified by
  55 .Fa attr
  56 are modified later, the thread's attributes are not affected.
  57 Upon
  58 successful completion
  59 .Fn pthread_create
  60 will store the ID of the created thread in the location specified by
  61 .Fa thread .
  62 .Pp
  63 The thread is created executing
  64 .Fa start_routine
  65 with
  66 .Fa arg
  67 as its sole argument.
  68 If the
  69 .Fa start_routine
  70 returns, the effect is as if there was an implicit call to
  71 .Fn pthread_exit
  72 using the return value of
  73 .Fa start_routine
  74 as the exit status.
  75 Note that the thread in which
  76 .Fn main
  77 was originally invoked differs from this.
  78 When it returns from
  79 .Fn main ,
  80 the effect is as if there was an implicit call to
  81 .Fn exit
  82 using the return value of
  83 .Fn main
  84 as the exit status.
  85 .Pp
  86 The signal state of the new thread is initialized as:
  87 .Bl -bullet -offset indent
  88 .It
  89 The signal mask is inherited from the creating thread.
  90 .It
  91 The set of signals pending for the new thread is empty.
  92 .El
  93 .Sh RETURN VALUES
  94 If successful,  the
  95 .Fn pthread_create
  96 function will return zero.
  97 Otherwise an error number will be returned to
  98 indicate the error.
  99 .Sh ERRORS
 100 .Fn pthread_create
 101 will fail if:
 102 .Bl -tag -width Er
 103 .It Bq Er EAGAIN
 104 The system lacked the necessary resources to create another thread, or
 105 the system-imposed limit on the total number of threads in a process
 106 [PTHREAD_THREADS_MAX] would be exceeded.
 107 .It Bq Er EINVAL
 108 The value specified by
 109 .Fa attr
 110 is invalid.
 111 .El
 112 .Sh SEE ALSO
 113 .Xr fork 2 ,
 114 .Xr pthread_cleanup_pop 3 ,
 115 .Xr pthread_cleanup_push 3 ,
 116 .Xr pthread_exit 3 ,
 117 .Xr pthread_join 3
 118 .Sh STANDARDS
 119 .Fn pthread_create
 120 conforms to
 121 .St -p1003.1-96 .