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 June 2, 2016 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 libpthread 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 46The 47.Fn pthread_create 48function is used to create a new thread, with attributes specified by 49.Fa attr , 50within a process. 51If 52.Fa attr 53is 54.Dv NULL , 55the default attributes are used. 56If the attributes specified by 57.Fa attr 58are modified later, the thread's attributes are not affected. 59Upon 60successful completion 61.Fn pthread_create 62will store the ID of the created thread in the location specified by 63.Fa thread . 64.Pp 65The thread is created executing 66.Fa start_routine 67with 68.Fa arg 69as its sole argument. 70If the 71.Fa start_routine 72returns, the effect is as if there was an implicit call to 73.Fn pthread_exit 74using the return value of 75.Fa start_routine 76as the exit status. 77Note that the thread in which 78.Fn main 79was originally invoked differs from this. 80When it returns from 81.Fn main , 82the effect is as if there was an implicit call to 83.Fn exit 84using the return value of 85.Fn main 86as the exit status. 87.Pp 88The signal state of the new thread is initialized as: 89.Bl -bullet -offset indent 90.It 91The signal mask is inherited from the creating thread. 92.It 93The set of signals pending for the new thread is empty. 94.El 95.Sh RETURN VALUES 96If successful, the 97.Fn pthread_create 98function will return zero. 99Otherwise an error number will be returned to 100indicate the error. 101.Sh ERRORS 102The 103.Fn pthread_create 104function can return any of the following errors: 105.Bl -tag -width Er 106.It Bq Er ENOMEM 107The system lacked the necessary resources to create another thread. 108.It Bq Er EAGAIN 109The system-imposed limit on the total number of threads in a process 110.Dv [PTHREAD_THREADS_MAX] 111would be exceeded. 112.It Bq Er EAGAIN 113The 114.Dv RACCT_NTHR 115limit would be exceeded; see 116.Xr racct 2 . 117.It Bq Er EPERM 118The caller does not have permission to set the scheduling parameters or 119scheduling policy. 120.It Bq Er EINVAL 121A value specified by 122.Fa attr 123is invalid. 124.It Bq Er EDEADLK 125The CPU set specified by 126.Fa attr 127would prevent the thread from running on any CPU. 128.It Bq Er EFAULT 129The stack base specified by 130.Fa attr 131is invalid, or the kernel was unable to put required 132initial data on the stack. 133.El 134.Sh SEE ALSO 135.Xr cpuset_setaffinity 2 , 136.Xr fork 2 , 137.Xr racct 2 , 138.Xr thr_new 2 , 139.Xr pthread_attr 3 , 140.Xr pthread_cancel 3 , 141.Xr pthread_cleanup_pop 3 , 142.Xr pthread_cleanup_push 3 , 143.Xr pthread_exit 3 , 144.Xr pthread_join 3 145.Sh STANDARDS 146The 147.Fn pthread_create 148function conforms to 149.St -p1003.1-96 . 150