release/man3/pthread_setname_np.3

   1 .\" Copyright (C) 2012 Chandan Apsangi <chandan.jc@gmail.com>
   2 .\" and Copyright (C) 2013 Michael Kerrisk <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 .TH PTHREAD_SETNAME_NP 3 2013\-06\-21 Linux "Linux Programmer's Manual"
  32 .SH 名前
  33 pthread_setname_np, pthread_getname_np \- スレッド名の設定/取得を行う
  34 .SH 書式
  35 .nf
  36 \fB#define _GNU_SOURCE\fP             /* feature_test_macros(7) 参照 */
  37 \fB#include <pthread.h>\fP
  38 \fBint pthread_setname_np(pthread_t \fP\fIthread\fP\fB, const char *\fP\fIname\fP\fB);\fP
  39 \fBint pthread_getname_np(pthread_t \fP\fIthread\fP\fB,\fP
  40 \fB                       const char *\fP\fIname\fP\fB, size_t \fP\fIlen\fP\fB);\fP
  41 .fi
  42 .sp
  43 \fI\-pthread\fP を付けてコンパイルとリンクを行う。
  44 .SH 説明
  45 デフォルトでは、 \fBpthread_create\fP() で作成されたすべてのスレッドはプログラム名を継承する。
  46 \fBpthread_setname_np\fP() 関数を使うとスレッドに固有の名前を設定することができる。
  47 スレッド固有の名前はマルチスレッド・アプリケーションのデバッグに便利である。 スレッド名は意味のある C 言語の文字列である。 その長さは 16
  48 文字に限定されており、 終端の NULL バイト (\(aq\e0\(aq) も 16 文字に含まれる。 \fIthread\fP
  49 引き数で名前を変更するスレッドを指定する。 \fIname\fP には新しい名前を指定する。
  50
  51 \fBpthread_getname_np\fP() 関数を使うと、 スレッド名を取得することができる。 \fIthread\fP
  52 引き数は名前を取得するスレッドを指定する。 バッファ \fIname\fP はスレッド名を返すのに使用される。 \fIlen\fP には \fIname\fP
  53 の大きさをバイトで指定する。 \fIname\fP で指定されたバッファの大きさは最低でも 16 文字とすべきである。 出力バッファに返されたスレッド名は
  54 NULL 終端される。
  55 .SH 返り値
  56 成功すると、これらの関数は 0 を返す。
  57 エラーの場合、0 以外のエラー番号を返す。
  58 .SH エラー
  59 \fBpthread_setname_np\fP() は以下のエラーで失敗する場合がある。
  60 .TP
  61 \fBERANGE\fP
  62 \fIname\fP で指定された文字列の長さが、許可されている上限を超えている。
  63 .PP
  64 \fBpthread_getname_np\fP() は以下のエラーで失敗する場合がある。
  65 .TP
  66 \fBERANGE\fP
  67 \fIname\fP と \fIlen\fP で指定されたバッファが、 スレッド名を格納するには短かすぎる。
  68 .PP
  69 \fI/proc/self/task/[tid]/comm\fP のオープンに失敗した場合、 これらの関数は \fBopen\fP(2)
  70 で説明されているエラーのいずれかで失敗する。
  71 .SH バージョン
  72 これらの関数は glibc バージョン 2.12 で初めて登場した。
  73 .SH 準拠
  74 これらの関数は非標準の GNU による拡張である。
  75 .SH 注意
  76 \fBpthread_setname_np\fP() は内部で \fI/proc\fP ファイルシステムのスレッド固有の comm ファイル
  77 (\fI/proc/self/task/[tid]/comm\fP) に書き込みを行う。 \fBpthread_getname_np\fP()
  78 はこのファイルから読み出しを行う。
  79 .SH 例
  80 .PP
  81 以下のプログラムは、 \fBpthread_setname_np\fP() と \fBpthread_getname_np\fP()
  82 の使用例を示している。
  83
  84 以下のシェルセッションは、このプログラムの実行例である。
  85 .in +4n
  86 .nf
  87
  88 $\fB ./a.out\fP
  89 Created a thread. Default name is: a.out
  90 The thread name after setting it is THREADFOO.
  91 \fB^Z\fP                           # Suspend the program
  92 [1]+  Stopped           ./a.out
  93 $ \fBps H \-C a.out \-o 'pid tid cmd comm'\fP
  94   PID   TID CMD                         COMMAND
  95  5990  5990 ./a.out                     a.out
  96  5990  5991 ./a.out                     THREADFOO
  97 $ \fBcat /proc/5990/task/5990/comm\fP
  98 a.out
  99 $ \fBcat /proc/5990/task/5991/comm\fP
 100 THREADFOO
 101 .fi
 102 .in
 103 .SS プログラムのソース
 104 \&
 105 .nf
 106 #define _GNU_SOURCE
 107 #include <pthread.h>
 108 #include <stdio.h>
 109 #include <string.h>
 110 #include <unistd.h>
 111 #include <errno.h>
 112 #include <stdlib.h>
 113
 114 #define NAMELEN 16
 115
 116 #define errExitEN(en, msg) \e
 117             do { errno = en; perror(msg); exit(EXIT_FAILURE); \e
 118         } while (0)
 119
 120 static void *
 121 threadfunc(void *parm)
 122 {
 123     sleep(5);          // allow main program to set the thread name
 124     return NULL;
 125 }
 126
 127 int
 128 main(int argc, char **argv)
 129 {
 130     pthread_t thread;
 131     int rc;
 132     char thread_name[NAMELEN];
 133
 134     rc = pthread_create(&thread, NULL, threadfunc, NULL);
 135     if (rc != 0)
 136         errExitEN(rc, "pthread_create");
 137
 138     rc = pthread_getname_np(thread, thread_name, NAMELEN);
 139     if (rc != 0)
 140         errExitEN(rc, "pthread_getname_np");
 141
 142     printf("Created a thread. Default name is: %s\en", thread_name);
 143     rc = pthread_setname_np(thread, (argc > 1) ? argv[1] : "THREADFOO");
 144     if (rc != 0)
 145         errExitEN(rc, "pthread_setname_np");
 146
 147     sleep(2);
 148
 149     rc = pthread_getname_np(thread, thread_name,
 150                             (argc > 2) ? atoi(argv[1]) : NAMELEN);
 151     if (rc != 0)
 152         errExitEN(rc, "pthread_getname_np");
 153     printf("The thread name after setting it is %s.\en", thread_name);
 154
 155     rc = pthread_join(thread, NULL);
 156     if (rc != 0)
 157         errExitEN(rc, "pthread_join");
 158
 159     printf("Done\en");
 160     exit(EXIT_SUCCESS);
 161 }
 162 .fi
 163 .SH 関連項目
 164 .ad l
 165 .nh
 166 \fBprctl\fP(2), \fBpthread_create\fP(3), \fBpthreads\fP(7)
 167 .SH この文書について
 168 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 169 である。プロジェクトの説明とバグ報告に関する情報は
 170 http://www.kernel.org/doc/man\-pages/ に書かれている。