release/man3/pthread_getcpuclockid.3

   1 .\" Copyright (c) 2009 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-03, Akihiro MOTOKI <amotoki@gmail.com>
  35 .\"
  36 .TH PTHREAD_GETCPUCLOCKID 3 2009\-02\-08 Linux "Linux Programmer's Manual"
  37 .SH 名前
  38 pthread_getcpuclockid \- スレッドの CPU 時間時計の ID を取得する
  39 .SH 書式
  40 .nf
  41 \fB#include <pthread.h>\fP
  42 \fB#include <time.h>\fP
  43
  44 \fBint pthread_getcpuclockid(pthread_t \fP\fIthread\fP\fB, clockid_t *\fP\fIclock_id);\fP
  45 .sp
  46 \fI\-pthread\fP でコンパイルしてリンクする。
  47 .fi
  48 .SH 説明
  49 .\" The clockid is constructed as follows:
  50 .\" *clockid = CLOCK_THREAD_CPUTIME_ID | (pd->tid << CLOCK_IDFIELD_SIZE)
  51 .\" where CLOCK_IDFIELD_SIZE is 3.
  52 \fBpthread_getcpuclockid\fP() 関数は、
  53 スレッド \fIthread\fP の CPU 時間時計のクロック ID を返す。
  54 .SH 返り値
  55 成功すると、この関数は 0 を返す。
  56 エラーの場合、 0 以外のエラー番号を返す。
  57 .SH エラー
  58 .TP
  59 \fBENOENT\fP
  60 .\" CLOCK_THREAD_CPUTIME_ID not defined
  61 .\"
  62 .\" Looking at nptl/pthread_getcpuclockid.c an ERANGE error would
  63 .\" be possible if kernel thread IDs took more than 29 bits (which
  64 .\" they currently cannot).
  65 スレッド単位の CPU 時間時計はこのシステムではサポートされていない。
  66 .TP
  67 \fBESRCH\fP
  68 ID が \fIthread\fP のスレッドが見つからなかった。
  69 .SH バージョン
  70 この関数は glibc バージョン 2.2 以降で利用できる。
  71 .SH 準拠
  72 POSIX.1\-2001.
  73 .SH 注意
  74 \fIthread\fP が呼び出したスレッドを参照している場合、
  75 クロック ID \fBCLOCK_THREAD_CPUTIME_ID\fP が指定されていれば、
  76 \fBclock_gettime\fP(2) と \fBclock_settime\fP(2) が操作するのと同じ時計
  77 を参照する ID が返される。
  78 .SH 例
  79 以下のプログラムは、スレッドを作成し、それから
  80 \fBclock_gettime\fP(2) を使ってプロセス全体の CPU 時間を取得し、
  81 \fBpthread_getcpuclockid\fP(3) を使って 2 つのスレッドが消費した
  82 スレッド毎の CPU 時間を取得する。
  83 下記のシェルのセッションは実行例である。
  84
  85 .in +4n
  86 .nf
  87 $ \fB./a.out\fP
  88 Main thread sleeping
  89 Subthread starting infinite loop
  90 Main thread consuming some CPU time...
  91 Process total CPU time:    1.368
  92 Main thread CPU time:      0.376
  93 Subthread CPU time:        0.992
  94 .fi
  95 .in
  96 .SS プログラムのソース
  97 \&
  98 .nf
  99 /* "\-lrt" でリンクする */
 100
 101 #include <time.h>
 102 #include <stdio.h>
 103 #include <stdlib.h>
 104 #include <unistd.h>
 105 #include <pthread.h>
 106 #include <string.h>
 107 #include <errno.h>
 108
 109 #define handle_error(msg) \e
 110         do { perror(msg); exit(EXIT_FAILURE); } while (0)
 111
 112 #define handle_error_en(en, msg) \e
 113         do { errno = en; perror(msg); exit(EXIT_FAILURE); } while (0)
 114
 115 static void *
 116 thread_start(void *arg)
 117 {
 118     printf("Subthread starting infinite loop\en");
 119     for (;;)
 120         continue;
 121 }
 122
 123 static void
 124 pclock(char *msg, clockid_t cid)
 125 {
 126     struct timespec ts;
 127
 128     printf("%s", msg);
 129     if (clock_gettime(cid, &ts) == \-1)
 130         handle_error("clock_gettime");
 131     printf("%4ld.%03ld\en", ts.tv_sec, ts.tv_nsec / 1000000);
 132 }
 133
 134 int
 135 main(int argc, char *argv[])
 136 {
 137     pthread_t thread;
 138     clockid_t cid;
 139     int j, s;
 140
 141     s = pthread_create(&thread, NULL, thread_start, NULL);
 142     if (s != 0)
 143         handle_error_en(s, "pthread_create");
 144
 145     printf("Main thread sleeping\en");
 146     sleep(1);
 147
 148     printf("Main thread consuming some CPU time...\en");
 149     for (j = 0; j < 2000000; j++)
 150         getppid();
 151
 152     pclock("Process total CPU time: ", CLOCK_PROCESS_CPUTIME_ID);
 153
 154     s = pthread_getcpuclockid(pthread_self(), &cid);
 155     if (s != 0)
 156         handle_error_en(s, "pthread_getcpuclockid");
 157     pclock("Main thread CPU time:   ", cid);
 158
 159     /* The preceding 4 lines of code could have been replaced by:
 160        pclock("Main thread CPU time:   ", CLOCK_THREAD_CPUTIME_ID); */
 161
 162     s = pthread_getcpuclockid(thread, &cid);
 163     if (s != 0)
 164         handle_error_en(s, "pthread_getcpuclockid");
 165     pclock("Subthread CPU time: 1    ", cid);
 166
 167     exit(EXIT_SUCCESS);         /* Terminates both threads */
 168 }
 169 .fi
 170 .SH 関連項目
 171 \fBclock_gettime\fP(2), \fBclock_settime\fP(2), \fBtimer_create\fP(2),
 172 \fBclock_getcpuclockid\fP(3), \fBpthread_self\fP(3), \fBpthreads\fP(7), \fBtime\fP(7)
 173 .SH この文書について
 174 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.65 の一部
 175 である。プロジェクトの説明とバグ報告に関する情報は
 176 http://www.kernel.org/doc/man\-pages/ に書かれている。