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.
--- 14 unchanged lines hidden (view full) ---
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: head/share/man/man3/pthread_create.3 57686 2000-03-02 09:14:21Z sheldonh $
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.
49If
50.Fa attr
51is NULL, the default attributes are used.
52If the attributes specified by
53.Fa attr
54are modified later, the thread's attributes are not affected.
55Upon
56successful completion
57.Fn pthread_create
58will store the ID of the created thread in the location specified by
59.Fa thread .
60.Pp
61The thread is created executing
62.Fa start_routine
63with
64.Fa arg
65as its sole argument.
66If the
67.Fa start_routine
68returns, the effect is as if there was an implicit call to
69.Fn pthread_exit
70using the return value of
71.Fa start_routine
72as the exit status.
73Note that the thread in which
74.Fn main
75was originally invoked differs from this.
76When it returns from
77.Fn main ,
78the effect is as if there was an implicit call to
79.Fn exit
80using the return value of
81.Fn main
82as the exit status.
83.Pp
84The signal state of the new thread is initialized as:
85.Bl -bullet -offset indent
86.It
87The signal mask is inherited from the creating thread.
88.It
89The set of signals pending for the new thread is empty.
90.El
91.Sh RETURN VALUES
92If successful, the
93.Fn pthread_create
94function will return zero.
95Otherwise an error number will be returned to
96indicate the error.
97.Sh ERRORS
98.Fn pthread_create
99will fail if:
100.Bl -tag -width Er
101.It Bq Er EAGAIN
102The system lacked the necessary resources to create another thread, or
103the system-imposed limit on the total number of threads in a process
--- 18 unchanged lines hidden ---
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.
--- 14 unchanged lines hidden (view full) ---
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: head/share/man/man3/pthread_create.3 57686 2000-03-02 09:14:21Z sheldonh $
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.
49If
50.Fa attr
51is NULL, the default attributes are used.
52If the attributes specified by
53.Fa attr
54are modified later, the thread's attributes are not affected.
55Upon
56successful completion
57.Fn pthread_create
58will store the ID of the created thread in the location specified by
59.Fa thread .
60.Pp
61The thread is created executing
62.Fa start_routine
63with
64.Fa arg
65as its sole argument.
66If the
67.Fa start_routine
68returns, the effect is as if there was an implicit call to
69.Fn pthread_exit
70using the return value of
71.Fa start_routine
72as the exit status.
73Note that the thread in which
74.Fn main
75was originally invoked differs from this.
76When it returns from
77.Fn main ,
78the effect is as if there was an implicit call to
79.Fn exit
80using the return value of
81.Fn main
82as the exit status.
83.Pp
84The signal state of the new thread is initialized as:
85.Bl -bullet -offset indent
86.It
87The signal mask is inherited from the creating thread.
88.It
89The set of signals pending for the new thread is empty.
90.El
91.Sh RETURN VALUES
92If successful, the
93.Fn pthread_create
94function will return zero.
95Otherwise an error number will be returned to
96indicate the error.
97.Sh ERRORS
98.Fn pthread_create
99will fail if:
100.Bl -tag -width Er
101.It Bq Er EAGAIN
102The system lacked the necessary resources to create another thread, or
103the system-imposed limit on the total number of threads in a process
--- 18 unchanged lines hidden ---