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.Dd April 4, 1996 32.Dt PTHREAD_CREATE 3 33.Os BSD 4 34.Sh NAME 35.Nm pthread_create 36.Nd create a new thread 37.Sh SYNOPSIS 38.Fd #include <pthread.h> 39.Ft int 40.Fn pthread_create "pthread_t *thread" "const pthread_attr_t *attr" "void *(*start_routine)(void *)" "void *arg" 41.Sh DESCRIPTION 42The 43.Fn pthread_create 44function is used to create a new thread, with attributes specified by 45.Fa attr , 46within a process. If 47.Fa attr 48is NULL, the default attributes are used. If the attributes specified by 49.Fa attr 50are modified later, the thread's attributes are not affected. Upon 51successful completion 52.Fn pthread_create 53will store the ID of the created thread in the location specified by 54.Fa thread . 55.Pp 56The thread is created executing 57.Fa start_routine 58with 59.Fa arg 60as its sole argument. If the 61.Fa start_routine 62returns, the effect is as if there was an implicit call to 63.Fn pthread_exit 64using the return value of 65.Fa start_toutine 66as the exit status. Note that the thread in which 67.Fn main 68was originally invoked differs from this. When it returns from 69.Fn main , 70the effect is as if there was an implicit call to 71.Fn exit using the return value of 72.Fn main 73as the exit status. 74.Pp 75The signal state of the new thread is initialized as: 76.Bl -bullet -offset indent 77.It 78The signal mask is inherited from the creating thread. 79.It 80The set of signals pending for the new thread is empty. 81.El 82.Sh RETURN VALUES 83If successful, the 84.Fn pthread_create 85function will return zero. Otherwise an error number will be returned to 86indicate the error. 87.Sh ERRORS 88.Fn pthread_create 89will fail if: 90.Bl -tag -width Er 91.It Bq Er EAGAIN 92The system lacked the necessary resources to create another thread, or 93the system-imposed limit on the total number of threads in a process 94[PTHREAD_THREADS_MAX] would be exceeded. 95.It Bq Er EINVAL 96The value specified by 97.Fa attr 98is invalid. 99.El 100.Pp 101.Sh SEE ALSO 102.Xr fork 2 , 103.Xr pthread_exit 3 , 104.Xr pthread_join 3 105.Sh STANDARDS 106.Fn pthread_create 107is expected to conform to IEEE 108.Pq Dq Tn POSIX 109Std 1003.1c when it is published. 110