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