draft/man3/pthread_create.3

   1 .\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   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.
   8 .\"
   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.
  13 .\"
  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
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\"*******************************************************************
  27 .\"
  28 .\" This file was generated with po4a. Translate the source file.
  29 .\"
  30 .\"*******************************************************************
  31 .\"
  32 .\" Japanese Version Copyright (c) 2012  Akihiro MOTOKI
  33 .\"         all rights reserved.
  34 .\" Translated 2012-05-04, Akihiro MOTOKI <amotoki@gmail.com>
  35 .\"
  36 .TH PTHREAD_CREATE 3 2012\-08\-03 Linux "Linux Programmer's Manual"
  37 .SH 名前
  38 pthread_create \- 新しいスレッドを作成する
  39 .SH 書式
  40 .nf
  41 \fB#include <pthread.h>\fP
  42
  43 \fBint pthread_create(pthread_t *\fP\fIthread\fP\fB, const pthread_attr_t *\fP\fIattr\fP\fB,\fP
  44 \fB                   void *(*\fP\fIstart_routine\fP\fB) (void *), void *\fP\fIarg\fP\fB);\fP
  45 .fi
  46 .sp
  47 \fI\-pthread\fP を付けてコンパイルとリンクを行う。
  48 .SH 説明
  49 \fBpthread_create\fP() 関数は、呼び出したプロセス内に新しいスレッドを作成する。
  50 新しいスレッドの実行は、 \fIstart_routine\fP() を起動することで開始される。
  51 \fIstart_routine\fP() は引き数を一つだけ取り、
  52 \fIarg\fP が \fIstart_routine\fP() の引き数として渡される。
  53
  54 新しく作成されたスレッドは、以下のいずれかで終了する。
  55 .IP * 2
  56 スレッドが \fBpthread_exit\fP(3) を呼び出す。
  57 \fBpthread_exit\fP(3) を呼び出す際には終了ステータス値を指定する。
  58 この値は \fBpthread_join\fP(3) を呼び出した同じプロセス内の
  59 別のスレッドで参照できる。
  60 .IP *
  61 スレッドが \fIstart_routine\fP() から返る。これは、
  62 \fIreturn\fP 文に渡した値で \fBpthread_exit\fP(3) を呼び出すのと等価である。
  63 .IP *
  64 スレッドがキャンセルされる (\fBpthread_cancel\fP(3) 参照)。
  65 .IP *
  66 プロセス内のいずれかのスレッドで \fBexit\fP(3) が呼ばれるか、
  67 メインスレッドで \fImain\fP() 内で return が実行される。
  68 この場合は、プロセス内の全てのスレッドが終了される。
  69 .PP
  70 \fIattr\fP 引き数は \fIpthread_attr_t\fP 構造体へのポインタであり、
  71 \fIpthread_attr_t\fP 構造体の内容を使用して、スレッド作成時に
  72 新しいスレッドの属性が決定される。
  73 この構造体は \fBpthread_attr_init\fP(3) や関連の関数を使って初期化される。
  74 \fIattr\fP が NULL の場合、新しいスレッドはデフォルトの属性で作成される。
  75
  76 成功した場合は、 \fBpthread_create\fP() は返る前に新しいスレッドの ID を
  77 \fIthread\fP が指すバッファに格納する。この ID は、これ以降に他の
  78 pthreads 関数の呼び出しでスレッドを参照するのに使用される。
  79
  80 新しいスレッドは、スレッドを作成したスレッドのシグナルマスク
  81 (\fBpthread_sigmask\fP(3) 参照) のコピーを継承する。
  82 新しいスレッドの処理待ちシグナル (\fBsigpending\fP(2)) の集合は空となる。
  83 新しいスレッドはスレッドを作成したスレッドの代替シグナルスタック
  84 (\fBsigaltstack\fP(2)) を継承しない。
  85
  86 新しいスレッドは呼び出したスレッドの浮動小数点環境 (\fBfenv\fP(3))
  87 を継承する。
  88
  89 .\" CLOCK_THREAD_CPUTIME_ID in clock_gettime(2)
  90 新しいスレッドの CPU 時間時計の初期値は 0 である
  91 (\fBpthread_getcpuclockid\fP(3) 参照)。
  92 .SS "Linux 固有の詳細"
  93 新しいスレッドは、呼び出したスレッドの
  94 ケーパビリティセット (\fBcapabilities\fP(7) 参照) と
  95 CPU affinity マスク (\fBsched_setaffinity\fP(2) 参照) の
  96 コピーをを継承しない。
  97 .SH 返り値
  98 成功すると、 \fBpthread_create\fP() は 0 を返す。
  99 エラーの場合は、エラー番号が返され、 \fI*thread\fP の内容は不定である。
 100 .SH エラー
 101 .TP
 102 \fBEAGAIN\fP
 103 別のスレッドを作成するのに十分なリソースがないか、システムで設定された
 104 スレッド数の上限に達していた。後者が起こるのは 2 つの場合がある。
 105 一つは、実ユーザ ID 当たりのプロセス数の上限である、\fBRLIMIT_NPROC\fP
 106 ソフトリソース上限 (\fBsetrlimit\fP(2) で設定できる) に達していた場合
 107 である。もう一つはカーネルのシステム全体のスレッド数の上限である
 108 \fI/proc/sys/kernel/threads\-max\fP が達していた場合である。
 109 .TP
 110 \fBEINVAL\fP
 111 \fIattr\fP で指定された設定が不正である。
 112 .TP
 113 .\" FIXME . Test the following
 114 \fBEPERM\fP
 115 \fIattr\fP に指定されたスケジューリングポリシーとパラメータを
 116 設定する許可がない。
 117 .SH 準拠
 118 POSIX.1\-2001.
 119 .SH 注意
 120 \fBpthread_create\fP() が \fI*thread\fP で返すスレッド ID についての
 121 詳しい情報は \fBpthread_self\fP(3) を参照のこと。
 122 リアルタイムスケジューリングポリシーが使用されない限り、
 123 \fBpthread_create\fP() の呼び出し後に、
 124 どのスレッドが\(em呼び出したスレッドか新しいスレッドか\(em
 125 次に実行されるかは決まっていない。
 126
 127 スレッドは \fIjoin 可能\fPか \fIdetached (切り離された状態)\fP のどちらかに
 128 することができる。スレッドが join 可能な場合、別のスレッドが
 129 \fBpthread_join\fP(3) を使って終了したスレッドを待ち、終了ステータスを取得
 130 することができる。終了した join 可能なスレッドは join された場合にのみ、
 131 そのスレッドの最後に残ったリソースが解放されシステムに戻される。
 132 detached 状態のスレッドが終了すると、そのスレッドのリソースは自動的に
 133 システムに戻される。detached 状態のスレッドを join して、その終了
 134 ステータスを取得することはできない。スレッドを detached 状態にするのは、
 135 その終了ステータスをアプリケーションが気にする必要がないある種の
 136 デーモン (daemon) スレッドでは有用である。
 137 デフォルトでは、新しいスレッドは join 可能な状態で作成される。
 138 (\fBpthread_attr_setdetachstate\fP(3) を使って) \fIattr\fP でスレッドが
 139 detached 状態で作成されるように設定されていない限り、join 可能な状態で
 140 作成される。
 141
 142 .\" FIXME . Perhaps some of the following detail should be in
 143 .\" a future pthread_attr_setstacksize(3) page.
 144 Linux/x86\-32 では、新しいスレッドのデフォルトのスタックサイズは 2MB で
 145 ある。NPTL スレッド実装の下では、\fIプログラム開始時の\fP \fBRLIMIT_STACK\fP
 146 ソフトリソース上限が"unlimited" 以外の場合、その値が新しいスレッドのデ
 147 フォルトのスタックサイズとなる。
 148 \fBpthread_attr_setstacksize\fP(3) を使って、スレッドを作成する際の
 149 \fIattr\fP 引き数に明示的にスタックサイズ属性を設定することで、
 150 デフォルト値以外のスタックサイズを得ることができる。
 151 .SH バグ
 152 廃止予定の LinuxThreads 実装では、プロセス内の各スレッドは異なる
 153 プロセス ID を持つ。これは POSIX スレッドの規格に違反しており、
 154 他の多くの標準非準拠の点の原因になっている。
 155 \fBpthreads\fP(7) を参照のこと。
 156 .SH 例
 157 以下のプログラムは、 \fBpthread_create\fP() や
 158 pthreads API の他のいろいろな関数の使用例を示している。
 159
 160 以下の実行例は、 NPTL スレッド実装が提供されているシステムでのもので、
 161 スタックサイズがデフォルト値の "stack size" リソース上限で指定される値
 162 になる。
 163
 164 .in +4n
 165 .nf
 166 $\fB ulimit \-s\fP
 167 8192            # The stack size limit is 8 MB (0x800000 bytes)
 168 $\fB ./a.out hola salut servus\fP
 169 Thread 1: top of stack near 0xb7dd03b8; argv_string=hola
 170 Thread 2: top of stack near 0xb75cf3b8; argv_string=salut
 171 Thread 3: top of stack near 0xb6dce3b8; argv_string=servus
 172 Joined with thread 1; returned value was HOLA
 173 Joined with thread 2; returned value was SALUT
 174 Joined with thread 3; returned value was SERVUS
 175 .fi
 176 .in
 177
 178 次の実行例では、プログラム内で、作成されるスレッドに対して
 179 (\fBpthread_attr_setstacksize\fP(3) を使って1MB のスタックサイズを
 180 明示的に設定している。
 181
 182 .in +4n
 183 .nf
 184 $\fB ./a.out \-s 0x100000 hola salut servus\fP
 185 Thread 1: top of stack near 0xb7d723b8; argv_string=hola
 186 Thread 2: top of stack near 0xb7c713b8; argv_string=salut
 187 Thread 3: top of stack near 0xb7b703b8; argv_string=servus
 188 Joined with thread 1; returned value was HOLA
 189 Joined with thread 2; returned value was SALUT
 190 Joined with thread 3; returned value was SERVUS
 191 .fi
 192 .in
 193 .SS プログラムのソース
 194 \&
 195 .nf
 196 #include <pthread.h>
 197 #include <string.h>
 198 #include <stdio.h>
 199 #include <stdlib.h>
 200 #include <unistd.h>
 201 #include <errno.h>
 202 #include <ctype.h>
 203
 204 #define handle_error_en(en, msg) \e
 205         do { errno = en; perror(msg); exit(EXIT_FAILURE); } while (0)
 206
 207 #define handle_error(msg) \e
 208         do { perror(msg); exit(EXIT_FAILURE); } while (0)
 209
 210 struct thread_info {    /* Used as argument to thread_start() */
 211     pthread_t thread_id;        /* ID returned by pthread_create() */
 212     int       thread_num;       /* Application\-defined thread # */
 213     char     *argv_string;      /* From command\-line argument */
 214 };
 215
 216 /* Thread start function: display address near top of our stack,
 217    and return upper\-cased copy of argv_string */
 218
 219 static void *
 220 thread_start(void *arg)
 221 {
 222     struct thread_info *tinfo = arg;
 223     char *uargv, *p;
 224
 225     printf("Thread %d: top of stack near %p; argv_string=%s\en",
 226             tinfo\->thread_num, &p, tinfo\->argv_string);
 227
 228     uargv = strdup(tinfo\->argv_string);
 229     if (uargv == NULL)
 230         handle_error("strdup");
 231
 232     for (p = uargv; *p != \(aq\e0\(aq; p++)
 233         *p = toupper(*p);
 234
 235     return uargv;
 236 }
 237
 238 int
 239 main(int argc, char *argv[])
 240 {
 241     int s, tnum, opt, num_threads;
 242     struct thread_info *tinfo;
 243     pthread_attr_t attr;
 244     int stack_size;
 245     void *res;
 246
 247     /* The "\-s" option specifies a stack size for our threads */
 248
 249     stack_size = \-1;
 250     while ((opt = getopt(argc, argv, "s:")) != \-1) {
 251         switch (opt) {
 252         case \(aqs\(aq:
 253             stack_size = strtoul(optarg, NULL, 0);
 254             break;
 255
 256         default:
 257             fprintf(stderr, "Usage: %s [\-s stack\-size] arg...\en",
 258                     argv[0]);
 259             exit(EXIT_FAILURE);
 260         }
 261     }
 262
 263     num_threads = argc \- optind;
 264
 265     /* Initialize thread creation attributes */
 266
 267     s = pthread_attr_init(&attr);
 268     if (s != 0)
 269         handle_error_en(s, "pthread_attr_init");
 270
 271     if (stack_size > 0) {
 272         s = pthread_attr_setstacksize(&attr, stack_size);
 273         if (s != 0)
 274             handle_error_en(s, "pthread_attr_setstacksize");
 275     }
 276
 277     /* Allocate memory for pthread_create() arguments */
 278
 279     tinfo = calloc(num_threads, sizeof(struct thread_info));
 280     if (tinfo == NULL)
 281         handle_error("calloc");
 282
 283     /* Create one thread for each command\-line argument */
 284
 285     for (tnum = 0; tnum < num_threads; tnum++) {
 286         tinfo[tnum].thread_num = tnum + 1;
 287         tinfo[tnum].argv_string = argv[optind + tnum];
 288
 289         /* The pthread_create() call stores the thread ID into
 290            corresponding element of tinfo[] */
 291
 292         s = pthread_create(&tinfo[tnum].thread_id, &attr,
 293                            &thread_start, &tinfo[tnum]);
 294         if (s != 0)
 295             handle_error_en(s, "pthread_create");
 296     }
 297
 298     /* Destroy the thread attributes object, since it is no
 299        longer needed */
 300
 301     s = pthread_attr_destroy(&attr);
 302     if (s != 0)
 303         handle_error_en(s, "pthread_attr_destroy");
 304
 305     /* Now join with each thread, and display its returned value */
 306
 307     for (tnum = 0; tnum < num_threads; tnum++) {
 308         s = pthread_join(tinfo[tnum].thread_id, &res);
 309         if (s != 0)
 310             handle_error_en(s, "pthread_join");
 311
 312         printf("Joined with thread %d; returned value was %s\en",
 313                 tinfo[tnum].thread_num, (char *) res);
 314         free(res);      /* Free memory allocated by thread */
 315     }
 316
 317     free(tinfo);
 318     exit(EXIT_SUCCESS);
 319 }
 320 .fi
 321 .SH 関連項目
 322 .ad l
 323 .nh
 324 \fBgetrlimit\fP(2), \fBpthread_attr_init\fP(3), \fBpthread_cancel\fP(3),
 325 \fBpthread_detach\fP(3), \fBpthread_equal\fP(3), \fBpthread_exit\fP(3),
 326 \fBpthread_getattr_np\fP(3), \fBpthread_join\fP(3), \fBpthread_self\fP(3),
 327 \fBpthreads\fP(7)
 328 .SH この文書について
 329 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 330 である。プロジェクトの説明とバグ報告に関する情報は
 331 http://www.kernel.org/doc/man\-pages/ に書かれている。