draft/man2/clock_getres.2

   1 .\" Copyright (c) 2003 Nick Clifford (zaf@nrc.co.nz), Jan 25, 2003
   2 .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl), Aug 24, 2003
   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 .\" 2003-08-23 Martin Schulze <joey@infodrom.org> improvements
  27 .\" 2003-08-24 aeb, large parts rewritten
  28 .\" 2004-08-06 Christoph Lameter <clameter@sgi.com>, SMP note
  29 .\"
  30 .\"*******************************************************************
  31 .\"
  32 .\" This file was generated with po4a. Translate the source file.
  33 .\"
  34 .\"*******************************************************************
  35 .\"
  36 .\" Japanese Version Copyright (c) 2004-2005 Yuichi SATO
  37 .\"         all rights reserved.
  38 .\" Translated 2004-07-19, Yuichi SATO <ysato444@yahoo.co.jp>
  39 .\" Updated & Modified 2005-01-10, Yuichi SATO
  40 .\" Updated 2010-04-11, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  41 .\" Updated 2012-04-27, Akihiro MOTOKI <amotoki@gmail.com>
  42 .\" Updated 2012-05-08, Akihiro MOTOKI <amotoki@gmail.com>
  43 .\" Updated 2012-05-29, Akihiro MOTOKI <amotoki@gmail.com>
  44 .\" Updated 2013-05-06, Akihiro MOTOKI <amotoki@gmail.com>
  45 .\"
  46 .TH CLOCK_GETRES 2 2013\-02\-25 "" "Linux Programmer's Manual"
  47 .SH 名前
  48 clock_getres, clock_gettime, clock_settime \- クロックと時間の関数
  49 .SH 書式
  50 \fB#include <time.h>\fP
  51 .sp
  52 \fBint clock_getres(clockid_t \fP\fIclk_id\fP\fB, struct timespec *\fP\fIres\fP\fB);\fP
  53
  54 \fBint clock_gettime(clockid_t \fP\fIclk_id\fP\fB, struct timespec *\fP\fItp\fP\fB);\fP
  55
  56 \fBint clock_settime(clockid_t \fP\fIclk_id\fP\fB, const struct timespec
  57 *\fP\fItp\fP\fB);\fP
  58 .sp
  59 \fI\-lrt\fP とリンクする (バージョン 2.17 より前の glibc のみ)
  60 .sp
  61 .in -4n
  62 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  63 .in
  64 .sp
  65 .ad l
  66 \fBclock_getres\fP(), \fBclock_gettime\fP(), \fBclock_settime\fP():
  67 .RS
  68 _POSIX_C_SOURCE\ >=\ 199309L
  69 .RE
  70 .ad b
  71 .SH 説明
  72 関数 \fBclock_getres\fP()  は 指定されたクロック \fIclk_id\fP の分解能 (精度) を探し出す。 \fIres\fP が NULL
  73 でない場合、その分解能を \fIres\fP で指される \fIstruct timespec\fP に格納する。 クロックの分解能は実装に依存し、
  74 特定のプロセスによって設定することはできない。 \fBclock_settime\fP()  の引き数 \fItp\fP で指される時間の値が \fIres\fP
  75 の倍数でない場合、 \fIres\fP の倍数に切り詰められる。
  76 .PP
  77 関数 \fBclock_gettime\fP()  と \fBclock_settime\fP()  は、指定されたクロック \fIclk_id\fP
  78 の時間を取得または設定する。
  79 .PP
  80 \fIres\fP と \fItp\fP 引き数は \fItimespec\fP 構造体であり、 \fI<time.h>\fP で以下のように規定されている:
  81 .sp
  82 .in +4n
  83 .nf
  84 struct timespec {
  85     time_t   tv_sec;        /* seconds */
  86     long     tv_nsec;       /* nanoseconds */
  87 };
  88 .fi
  89 .in
  90 .PP
  91 \fIclk_id\fP 引き数は特定のクロックの識別子であり、そのクロックで動作する。 クロックはシステム全体に適用することもでき、
  92 その場合は全てのプロセスから見ることができる。 また 1 つのプロセス内でのみ時間を計測する場合は、 プロセス毎に適用することもできる。
  93 .LP
  94 全ての実装においてシステム全体のリアルタイムクロックがサポートされ、 \fBCLOCK_REALTIME\fP で識別される。 時間は紀元 (the
  95 Epoch) からの秒とナノ秒で表される。 時間が変更された場合、相対的な時間間隔のタイマーは影響を受けないが、 絶対的な時点のタイマーは影響を受ける。
  96 .LP
  97 さらにいくつかのクロックが実装されているかもしれない。 対応する時間の値を解釈する方法とタイマーへの影響は、定められていない。
  98 .LP
  99 glibc と Linux カーネルの最新のバージョンでは、
 100 以下のクロックがサポートされている。
 101 .TP
 102 \fBCLOCK_REALTIME\fP
 103 実時間を計測するシステム全体で一意な時間。
 104 このクロックを設定するには適切な特権が必要である。
 105 このクロックは、システム時間の不連続な変化 (例えば、システム管理者が
 106 システム時間を手動で変更した場合など) や \fBadjtime\fP や NTP が行う
 107 段階的な調整の影響を受ける。
 108 .TP
 109 \fBCLOCK_REALTIME_COARSE\fP (Linux 2.6.32 以降; Linux 特有)
 110 .\" Added in commit da15cfdae03351c689736f8d142618592e3cebc3
 111 高速だが精度が低い \fBCLOCK_REALTIME\fP。速度が非常に必要で、かつ高精度のタイムスタンプが不要な場合に使用するとよい。
 112 .TP
 113 .TP
 114 \fBCLOCK_MONOTONIC\fP
 115 設定することができないクロックで、ある開始時点からの単調増加の時間で
 116 表現されるクロック (開始時点がどの時点となるかは規定されていない)。
 117 この時計は、システム時間の不連続な変化 (例えば、システム管理者がシステ
 118 ム時間を手動で変更した場合など) の影響を受けないが、
 119 \fBadjtime\fP(3) や NTP が行う段階的な調整の影響を受ける。
 120 .TP
 121 \fBCLOCK_MONOTONIC_COARSE\fP (Linux 2.6.32 以降; Linux 特有)
 122 .\" Added in commit da15cfdae03351c689736f8d142618592e3cebc3
 123 高速だが精度が低い \fBCLOCK_MONOTONIC\fP。速度が非常に必要で、かつ高精度のタイムスタンプが不要な場合に使用するとよい。
 124 .TP
 125 \fBCLOCK_MONOTONIC_RAW\fP (Linux 2.6.28 以降; Linux 特有)
 126 .\" Added in commit 2d42244ae71d6c7b0884b5664cf2eda30fb2ae68, John Stultz
 127 \fBCLOCK_MONOTONIC\fP と同様だが、NTP による調整や \fBadjtime\fP(3) が行う
 128 段階的な調整の影響を受けない、ハードウェアによる生の時刻へのアクセス
 129 ができる。
 130 .TP
 131 \fBCLOCK_BOOTTIME\fP (Linux 2.6.39 以降; Linux 固有)
 132 .\" commit 7fdd7f89006dd5a4c702fa0ce0c272345fa44ae0
 133 .\" commit 70a08cca1227dc31c784ec930099a4417a06e7d0
 134 \fBCLOCK_MONOTONIC\fP と同じだが、システムがサスペンドされている時間も含まれる点が異なる。
 135 これを使うと、アプリケーションはサスペンド状態も扱える "monotonic" なクロックを得ることができる。 しかも、
 136 \fBCLOCK_REALTIME\fP における複雑な処理を行う必要もなくなる。 \fBCLOCK_REALTIME\fP では、
 137 \fBsettimeofday\fP(2) を使って時刻を変更した場合、時刻に不連続な変化が発生するからだ。
 138 .TP
 139 \fBCLOCK_PROCESS_CPUTIME_ID\fP
 140 CPU による高分解能のプロセス毎のタイマー。
 141 .TP
 142 \fBCLOCK_THREAD_CPUTIME_ID\fP
 143 スレッド固有の CPU タイムクロック。
 144 .SH 返り値
 145 \fBclock_gettime\fP(), \fBclock_settime\fP(), \fBclock_getres\fP()  は成功した場合に 0
 146 を返し、失敗した場合に \-1 を返す (失敗した場合、 \fIerrno\fP が適切に設定される)。
 147 .SH エラー
 148 .TP
 149 \fBEFAULT\fP
 150 \fItp\fP がアクセス可能なアドレス空間の外を指した。
 151 .TP
 152 \fBEINVAL\fP
 153 .\" Linux also gives this error on attempts to set CLOCK_PROCESS_CPUTIME_ID
 154 .\" and CLOCK_THREAD_CPUTIME_ID, when probably the proper error should be
 155 .\" EPERM.
 156 指定された \fIclk_id\fP がこのシステムでサポートされていない。
 157 .TP
 158 \fBEPERM\fP
 159 指示されたクロックを設定する権限が \fBclock_settime\fP()  にない。
 160 .SH 準拠
 161 SUSv2, POSIX.1\-2001.
 162 .SH 可用性
 163 これらの関数が利用可能な POSIX システムでは、\fI<unistd.h>\fP においてシンボル \fB_POSIX_TIMERS\fP が
 164 0 より大きい値に定義されている。 シンボル \fB_POSIX_MONOTONIC_CLOCK\fP, \fB_POSIX_CPUTIME\fP,
 165 \fB_POSIX_THREAD_CPUTIME\fP は \fBCLOCK_MONOTONIC\fP, \fBCLOCK_PROCESS_CPUTIME_ID\fP,
 166 \fBCLOCK_THREAD_CPUTIME_ID\fP が利用可能なことを示す。 (\fBsysconf\fP(3)  も参照すること。)
 167 .SH 注意
 168 .SS "SMP システムについての注意"
 169 \fBCLOCK_PROCESS_CPUTIME_ID\fP と \fBCLOCK_THREAD_CPUTIME_ID\fP クロックは、CPU からのタイマー
 170 (i386 上の TSC、Itanium 上の AR.ITC) を用いて実現されている。 これらのレジスタは CPU 間で異なる可能性があり、
 171 プロセスが他の CPU に移動させられた場合、 結果としてこれらのクロックが\fB偽の結果\fP (bogus results) を返すかもしれない。
 172 .PP
 173 SMP システムの各 CPU が別々のクロック源を持つ場合、 タイマーレジスタ間の相互関係を管理する方法はない。 これは各 CPU
 174 が微妙に異なる周波数で動作するためである。 これが真実の場合 (訳註: 各 CPU が別々のクロック源を持つ場合)、
 175 \fIclock_getcpuclockid(0)\fP は \fBENOENT\fP を返して、その状況を表す。 2 つのクロックは、プロセスが特定の CPU
 176 上に留まっていることが 保証できる場合にのみ有効である。
 177 .PP
 178 SMP システムの各プロセッサは全く同じ時刻に起動する訳ではないので、 各タイマーレジスタは通常はあるオフセットで動作している。
 179 オフセットをブート時に制限するコードが含まれるアーキテクチャもある。 しかし、このコードがオフセットを正確に調整することは保証できない。 glibc は
 180 (Linux カーネルとは異なり) オフセットを扱うためのコードを提供しない。 通常はこれらのオフセットが小さいので、多くの場合でその影響は無視できる。
 181 .SH バグ
 182 .\" See http://bugzilla.kernel.org/show_bug.cgi?id=11972
 183 POSIX.1\-2001 では、 「適切な特権 (appropriate privileges)」を持ったプロセスは、
 184 \fBclock_settime\fP()  を使って、クロック \fBCLOCK_PROCESS_CPUTIME_ID\fP と
 185 \fBCLOCK_THREAD_CPUTIME_ID\fP を設定することができるとされている。 Linux では、これらのクロックは設定可能ではない
 186 (すなわち、どのプロセスも「適切な特権」を持たない)。
 187 .SH 関連項目
 188 \fBdate\fP(1), \fBgettimeofday\fP(2), \fBsettimeofday\fP(2), \fBtime\fP(2),
 189 \fBadjtime\fP(3), \fBclock_getcpuclockid\fP(3), \fBctime\fP(3), \fBftime\fP(3),
 190 \fBpthread_getcpuclockid\fP(3), \fBsysconf\fP(3), \fBtime\fP(7)
 191 .SH この文書について
 192 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 193 である。プロジェクトの説明とバグ報告に関する情報は
 194 http://www.kernel.org/doc/man\-pages/ に書かれている。