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