1 .\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
2 .\" <mtk.manpages@gmail.com>
4 .\" %%%LICENSE_START(VERBATIM)
5 .\" Permission is granted to make and distribute verbatim copies of this
6 .\" manual provided the copyright notice and this permission notice are
7 .\" preserved on all copies.
9 .\" Permission is granted to copy and distribute modified versions of this
10 .\" manual under the conditions for verbatim copying, provided that the
11 .\" entire resulting derived work is distributed under the terms of a
12 .\" permission notice identical to this one.
14 .\" Since the Linux kernel and libraries are constantly changing, this
15 .\" manual page may be incorrect or out-of-date. The author(s) assume no
16 .\" responsibility for errors or omissions, or for damages resulting from
17 .\" the use of the information contained herein. The author(s) may not
18 .\" have taken the same level of care in the production of this manual,
19 .\" which is licensed free of charge, as they might when working
22 .\" Formatted or processed versions of this manual, if unaccompanied by
23 .\" the source, must acknowledge the copyright and authors of this work.
26 .\"*******************************************************************
28 .\" This file was generated with po4a. Translate the source file.
30 .\"*******************************************************************
31 .TH PTHREAD_CREATE 3 2012\-08\-03 Linux "Linux Programmer's Manual"
33 pthread_create \- 新しいスレッドを作成する
36 \fB#include <pthread.h>\fP
38 \fBint pthread_create(pthread_t *\fP\fIthread\fP\fB, const pthread_attr_t *\fP\fIattr\fP\fB,\fP
39 \fB void *(*\fP\fIstart_routine\fP\fB) (void *), void *\fP\fIarg\fP\fB);\fP
42 \fI\-pthread\fP を付けてコンパイルとリンクを行う。
44 \fBpthread_create\fP() 関数は、呼び出したプロセス内に新しいスレッドを作成する。
45 新しいスレッドの実行は、 \fIstart_routine\fP() を起動することで開始される。
46 \fIstart_routine\fP() は引き数を一つだけ取り、
47 \fIarg\fP が \fIstart_routine\fP() の引き数として渡される。
49 新しく作成されたスレッドは、以下のいずれかで終了する。
51 スレッドが \fBpthread_exit\fP(3) を呼び出す。
52 \fBpthread_exit\fP(3) を呼び出す際には終了ステータス値を指定する。
53 この値は \fBpthread_join\fP(3) を呼び出した同じプロセス内の
56 スレッドが \fIstart_routine\fP() から返る。これは、
57 \fIreturn\fP 文に渡した値で \fBpthread_exit\fP(3) を呼び出すのと等価である。
59 スレッドがキャンセルされる (\fBpthread_cancel\fP(3) 参照)。
61 プロセス内のいずれかのスレッドで \fBexit\fP(3) が呼ばれるか、
62 メインスレッドで \fImain\fP() 内で return が実行される。
63 この場合は、プロセス内の全てのスレッドが終了される。
65 \fIattr\fP 引き数は \fIpthread_attr_t\fP 構造体へのポインタであり、
66 \fIpthread_attr_t\fP 構造体の内容を使用して、スレッド作成時に
68 この構造体は \fBpthread_attr_init\fP(3) や関連の関数を使って初期化される。
69 \fIattr\fP が NULL の場合、新しいスレッドはデフォルトの属性で作成される。
71 成功した場合は、 \fBpthread_create\fP() は返る前に新しいスレッドの ID を
72 \fIthread\fP が指すバッファに格納する。この ID は、これ以降に他の
73 pthreads 関数の呼び出しでスレッドを参照するのに使用される。
75 新しいスレッドは、スレッドを作成したスレッドのシグナルマスク
76 (\fBpthread_sigmask\fP(3) 参照) のコピーを継承する。
77 新しいスレッドの処理待ちシグナル (\fBsigpending\fP(2)) の集合は空となる。
78 新しいスレッドはスレッドを作成したスレッドの代替シグナルスタック
79 (\fBsigaltstack\fP(2)) を継承しない。
81 新しいスレッドは呼び出したスレッドの浮動小数点環境 (\fBfenv\fP(3))
84 .\" CLOCK_THREAD_CPUTIME_ID in clock_gettime(2)
85 新しいスレッドの CPU 時間時計の初期値は 0 である
86 (\fBpthread_getcpuclockid\fP(3) 参照)。
89 ケーパビリティセット (\fBcapabilities\fP(7) 参照) と
90 CPU affinity マスク (\fBsched_setaffinity\fP(2) 参照) の
93 成功すると、 \fBpthread_create\fP() は 0 を返す。
94 エラーの場合は、エラー番号が返され、 \fI*thread\fP の内容は不定である。
98 別のスレッドを作成するのに十分なリソースがないか、システムで設定された
99 スレッド数の上限に達していた。後者が起こるのは 2 つの場合がある。
100 一つは、実ユーザ ID 当たりのプロセス数の上限である、\fBRLIMIT_NPROC\fP
101 ソフトリソース上限 (\fBsetrlimit\fP(2) で設定できる) に達していた場合
102 である。もう一つはカーネルのシステム全体のスレッド数の上限である
103 \fI/proc/sys/kernel/threads\-max\fP が達していた場合である。
106 \fIattr\fP で指定された設定が不正である。
108 .\" FIXME . Test the following
110 \fIattr\fP に指定されたスケジューリングポリシーとパラメータを
115 \fBpthread_create\fP() が \fI*thread\fP で返すスレッド ID についての
116 詳しい情報は \fBpthread_self\fP(3) を参照のこと。
117 リアルタイムスケジューリングポリシーが使用されない限り、
118 \fBpthread_create\fP() の呼び出し後に、
119 どのスレッドが\(em呼び出したスレッドか新しいスレッドか\(em
122 スレッドは \fIjoin 可能\fPか \fIdetached (切り離された状態)\fP のどちらかに
123 することができる。スレッドが join 可能な場合、別のスレッドが
124 \fBpthread_join\fP(3) を使って終了したスレッドを待ち、終了ステータスを取得
125 することができる。終了した join 可能なスレッドは join された場合にのみ、
126 そのスレッドの最後に残ったリソースが解放されシステムに戻される。
127 detached 状態のスレッドが終了すると、そのスレッドのリソースは自動的に
128 システムに戻される。detached 状態のスレッドを join して、その終了
129 ステータスを取得することはできない。スレッドを detached 状態にするのは、
130 その終了ステータスをアプリケーションが気にする必要がないある種の
131 デーモン (daemon) スレッドでは有用である。
132 デフォルトでは、新しいスレッドは join 可能な状態で作成される。
133 (\fBpthread_attr_setdetachstate\fP(3) を使って) \fIattr\fP でスレッドが
134 detached 状態で作成されるように設定されていない限り、join 可能な状態で
137 .\" FIXME . Perhaps some of the following detail should be in
138 .\" a future pthread_attr_setstacksize(3) page.
139 Linux/x86\-32 では、新しいスレッドのデフォルトのスタックサイズは 2MB で
140 ある。NPTL スレッド実装の下では、\fIプログラム開始時の\fP \fBRLIMIT_STACK\fP
141 ソフトリソース上限が"unlimited" 以外の場合、その値が新しいスレッドのデ
143 \fBpthread_attr_setstacksize\fP(3) を使って、スレッドを作成する際の
144 \fIattr\fP 引き数に明示的にスタックサイズ属性を設定することで、
145 デフォルト値以外のスタックサイズを得ることができる。
147 廃止予定の LinuxThreads 実装では、プロセス内の各スレッドは異なる
148 プロセス ID を持つ。これは POSIX スレッドの規格に違反しており、
149 他の多くの標準非準拠の点の原因になっている。
150 \fBpthreads\fP(7) を参照のこと。
152 以下のプログラムは、 \fBpthread_create\fP() や
153 pthreads API の他のいろいろな関数の使用例を示している。
155 以下の実行例は、 NPTL スレッド実装が提供されているシステムでのもので、
156 スタックサイズがデフォルト値の "stack size" リソース上限で指定される値
162 8192 # The stack size limit is 8 MB (0x800000 bytes)
163 $\fB ./a.out hola salut servus\fP
164 Thread 1: top of stack near 0xb7dd03b8; argv_string=hola
165 Thread 2: top of stack near 0xb75cf3b8; argv_string=salut
166 Thread 3: top of stack near 0xb6dce3b8; argv_string=servus
167 Joined with thread 1; returned value was HOLA
168 Joined with thread 2; returned value was SALUT
169 Joined with thread 3; returned value was SERVUS
173 次の実行例では、プログラム内で、作成されるスレッドに対して
174 (\fBpthread_attr_setstacksize\fP(3) を使って1MB のスタックサイズを
179 $\fB ./a.out \-s 0x100000 hola salut servus\fP
180 Thread 1: top of stack near 0xb7d723b8; argv_string=hola
181 Thread 2: top of stack near 0xb7c713b8; argv_string=salut
182 Thread 3: top of stack near 0xb7b703b8; argv_string=servus
183 Joined with thread 1; returned value was HOLA
184 Joined with thread 2; returned value was SALUT
185 Joined with thread 3; returned value was SERVUS
199 #define handle_error_en(en, msg) \e
200 do { errno = en; perror(msg); exit(EXIT_FAILURE); } while (0)
202 #define handle_error(msg) \e
203 do { perror(msg); exit(EXIT_FAILURE); } while (0)
205 struct thread_info { /* Used as argument to thread_start() */
206 pthread_t thread_id; /* ID returned by pthread_create() */
207 int thread_num; /* Application\-defined thread # */
208 char *argv_string; /* From command\-line argument */
211 /* Thread start function: display address near top of our stack,
212 and return upper\-cased copy of argv_string */
215 thread_start(void *arg)
217 struct thread_info *tinfo = arg;
220 printf("Thread %d: top of stack near %p; argv_string=%s\en",
221 tinfo\->thread_num, &p, tinfo\->argv_string);
223 uargv = strdup(tinfo\->argv_string);
225 handle_error("strdup");
227 for (p = uargv; *p != \(aq\e0\(aq; p++)
234 main(int argc, char *argv[])
236 int s, tnum, opt, num_threads;
237 struct thread_info *tinfo;
242 /* The "\-s" option specifies a stack size for our threads */
245 while ((opt = getopt(argc, argv, "s:")) != \-1) {
248 stack_size = strtoul(optarg, NULL, 0);
252 fprintf(stderr, "Usage: %s [\-s stack\-size] arg...\en",
258 num_threads = argc \- optind;
260 /* Initialize thread creation attributes */
262 s = pthread_attr_init(&attr);
264 handle_error_en(s, "pthread_attr_init");
266 if (stack_size > 0) {
267 s = pthread_attr_setstacksize(&attr, stack_size);
269 handle_error_en(s, "pthread_attr_setstacksize");
272 /* Allocate memory for pthread_create() arguments */
274 tinfo = calloc(num_threads, sizeof(struct thread_info));
276 handle_error("calloc");
278 /* Create one thread for each command\-line argument */
280 for (tnum = 0; tnum < num_threads; tnum++) {
281 tinfo[tnum].thread_num = tnum + 1;
282 tinfo[tnum].argv_string = argv[optind + tnum];
284 /* The pthread_create() call stores the thread ID into
285 corresponding element of tinfo[] */
287 s = pthread_create(&tinfo[tnum].thread_id, &attr,
288 &thread_start, &tinfo[tnum]);
290 handle_error_en(s, "pthread_create");
293 /* Destroy the thread attributes object, since it is no
296 s = pthread_attr_destroy(&attr);
298 handle_error_en(s, "pthread_attr_destroy");
300 /* Now join with each thread, and display its returned value */
302 for (tnum = 0; tnum < num_threads; tnum++) {
303 s = pthread_join(tinfo[tnum].thread_id, &res);
305 handle_error_en(s, "pthread_join");
307 printf("Joined with thread %d; returned value was %s\en",
308 tinfo[tnum].thread_num, (char *) res);
309 free(res); /* Free memory allocated by thread */
319 \fBgetrlimit\fP(2), \fBpthread_attr_init\fP(3), \fBpthread_cancel\fP(3),
320 \fBpthread_detach\fP(3), \fBpthread_equal\fP(3), \fBpthread_exit\fP(3),
321 \fBpthread_getattr_np\fP(3), \fBpthread_join\fP(3), \fBpthread_self\fP(3),
324 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
325 である。プロジェクトの説明とバグ報告に関する情報は
326 http://www.kernel.org/doc/man\-pages/ に書かれている。