xref: /freebsd/share/man/man3/pthread_create.3 (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
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_routine
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
72using the return value of
73.Fn main
74as the exit status.
75.Pp
76The signal state of the new thread is initialized as:
77.Bl -bullet -offset indent
78.It
79The signal mask is inherited from the creating thread.
80.It
81The set of signals pending for the new thread is empty.
82.El
83.Sh RETURN VALUES
84If successful,  the
85.Fn pthread_create
86function will return zero. Otherwise an error number will be returned to
87indicate the error.
88.Sh ERRORS
89.Fn pthread_create
90will fail if:
91.Bl -tag -width Er
92.It Bq Er EAGAIN
93The system lacked the necessary resources to create another thread, or
94the system-imposed limit on the total number of threads in a process
95[PTHREAD_THREADS_MAX] would be exceeded.
96.It Bq Er EINVAL
97The value specified by
98.Fa attr
99is invalid.
100.El
101.Pp
102.Sh SEE ALSO
103.Xr fork 2 ,
104.Xr pthread_cleanup_pop 3 ,
105.Xr pthread_cleanup_push 3 ,
106.Xr pthread_exit 3 ,
107.Xr pthread_join 3
108.Sh STANDARDS
109.Fn pthread_create
110conforms to ISO/IEC 9945-1 ANSI/IEEE
111.Pq Dq Tn POSIX
112Std 1003.1 Second Edition 1996-07-12.
113