draft/man2/clock_getres.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (c) 2003 Nick Clifford (zaf@nrc.co.nz), Jan 25, 2003
   4 .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl), Aug 24, 2003
   5 .\"
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  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 .\" FIXME: Linux 2.6.39 adds CLOCK_BOOTTIME
  31 .\"
  32 .\"*******************************************************************
  33 .\"
  34 .\" This file was generated with po4a. Translate the source file.
  35 .\"
  36 .\"*******************************************************************
  37 .TH CLOCK_GETRES 2 2010\-02\-03 "" "Linux Programmer's Manual"
  38 .SH 名前
  39 clock_getres, clock_gettime, clock_settime \- クロックと時間の関数
  40 .SH 書式
  41 \fB#include <time.h>\fP
  42 .sp
  43 \fBint clock_getres(clockid_t \fP\fIclk_id\fP\fB, struct timespec *\fP\fIres\fP\fB);\fP
  44
  45 \fBint clock_gettime(clockid_t \fP\fIclk_id\fP\fB, struct timespec *\fP\fItp\fP\fB);\fP
  46
  47 \fBint clock_settime(clockid_t \fP\fIclk_id\fP\fB, const struct timespec
  48 *\fP\fItp\fP\fB);\fP
  49 .sp
  50 \fI\-lrt\fP でリンクする。
  51 .sp
  52 .in -4n
  53 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  54 .in
  55 .sp
  56 .ad l
  57 \fBclock_getres\fP(), \fBclock_gettime\fP(), \fBclock_settime\fP():
  58 .RS
  59 _POSIX_C_SOURCE\ >=\ 199309L
  60 .RE
  61 .ad b
  62 .SH 説明
  63 関数 \fBclock_getres\fP()  は 指定されたクロック \fIclk_id\fP の分解能 (精度) を探し出す。 \fIres\fP が NULL
  64 でない場合、その分解能を \fIres\fP で指される \fIstruct timespec\fP に格納する。 クロックの分解能は実装に依存し、
  65 特定のプロセスによって設定することはできない。 \fBclock_settime\fP()  の引き数 \fItp\fP で指される時間の値が \fIres\fP
  66 の倍数でない場合、 \fIres\fP の倍数に切り詰められる。
  67 .PP
  68 関数 \fBclock_gettime\fP()  と \fBclock_settime\fP()  は、指定されたクロック \fIclk_id\fP
  69 の時間を取得または設定する。
  70 .PP
  71 \fIres\fP と \fItp\fP 引き数は \fItimespec\fP 構造体であり、 \fI<time.h>\fP で以下のように規定されている:
  72 .sp
  73 .in +4n
  74 .nf
  75 struct timespec {
  76     time_t   tv_sec;        /* seconds */
  77     long     tv_nsec;       /* nanoseconds */
  78 };
  79 .fi
  80 .in
  81 .PP
  82 \fIclk_id\fP 引き数は特定のクロックの識別子であり、そのクロックで動作する。 クロックはシステム全体に適用することもでき、
  83 その場合は全てのプロセスから見ることができる。 また 1 つのプロセス内でのみ時間を計測する場合は、 プロセス毎に適用することもできる。
  84 .LP
  85 全ての実装においてシステム全体のリアルタイムクロックがサポートされ、 \fBCLOCK_REALTIME\fP で識別される。 時間は紀元 (the
  86 Epoch) からの秒とナノ秒で表される。 時間が変更された場合、相対的な時間間隔のタイマは影響を受けないが、 絶対的な時点のタイマは影響を受ける。
  87 .LP
  88 さらにいくつかのクロックが実装されているかもしれない。 対応する時間の値を解釈する方法とタイマへの影響は、定められていない。
  89 .LP
  90 glibc と Linux カーネルの最新のバージョンでは、 以下のような十分なクロックがサポートされている。
  91 .TP
  92 \fBCLOCK_REALTIME\fP
  93 システム全体のリアルタイムクロック。 このクロックを設定するには適切な特権が必要である。
  94 .TP
  95 \fBCLOCK_MONOTONIC\fP
  96 いくつかの開始点が指定されていないため、 クロックがモノトニックタイムを設定したり表現したりできない。
  97 .TP
  98 \fBCLOCK_MONOTONIC_RAW\fP (Linux 2.6.28 以降; Linux 特有)
  99 .\" Added in commit 2d42244ae71d6c7b0884b5664cf2eda30fb2ae68, John Stultz
 100 \fBCLOCK_MONOTONIC\fP と同様だが、NTP による調整の影響を受けない、ハードウェアによる 生の時刻へのアクセスができる。
 101 .TP
 102 \fBCLOCK_PROCESS_CPUTIME_ID\fP
 103 CPU による高分解能のプロセス毎のタイマ。
 104 .TP
 105 \fBCLOCK_THREAD_CPUTIME_ID\fP
 106 スレッド固有の CPU タイムクロック。
 107 .SH 返り値
 108 \fBclock_gettime\fP(), \fBclock_settime\fP(), \fBclock_getres\fP()  は成功した場合に 0
 109 を返し、失敗した場合に \-1 を返す (失敗した場合、 \fIerrno\fP が適切に設定される)。
 110 .SH エラー
 111 .TP
 112 \fBEFAULT\fP
 113 \fItp\fP がアクセス可能なアドレス空間の外を指した。
 114 .TP
 115 \fBEINVAL\fP
 116 .\" Linux also gives this error on attempts to set CLOCK_PROCESS_CPUTIME_ID
 117 .\" and CLOCK_THREAD_CPUTIME_ID, when probably the proper error should be
 118 .\" EPERM.
 119 指定された \fIclk_id\fP がこのシステムでサポートされていない。
 120 .TP
 121 \fBEPERM\fP
 122 指示されたクロックを設定する権限が \fBclock_settime\fP()  にない。
 123 .SH 準拠
 124 SUSv2, POSIX.1\-2001.
 125 .SH 可用性
 126 これらの関数が利用可能な POSIX システムでは、\fI<unistd.h>\fP においてシンボル \fB_POSIX_TIMERS\fP が
 127 0 より大きい値に定義されている。 シンボル \fB_POSIX_MONOTONIC_CLOCK\fP, \fB_POSIX_CPUTIME\fP,
 128 \fB_POSIX_THREAD_CPUTIME\fP は \fBCLOCK_MONOTONIC\fP, \fBCLOCK_PROCESS_CPUTIME_ID\fP,
 129 \fBCLOCK_THREAD_CPUTIME_ID\fP が利用可能なことを示す。 (\fBsysconf\fP(3)  も参照すること。)
 130 .SH 注意
 131 .SS "SMP システムについての注意"
 132 \fBCLOCK_PROCESS_CPUTIME_ID\fP と \fBCLOCK_THREAD_CPUTIME_ID\fP クロックは、CPU からのタイマ
 133 (i386 上の TSC、Itanium 上の AR.ITC) を用いて実現されている。 これらのレジスタは CPU 間で異なる可能性があり、
 134 プロセスが他の CPU に移動させられた場合、 結果としてこれらのクロックが\fB偽の結果\fP (bogus results) を返すかもしれない。
 135 .PP
 136 SMP システムの各 CPU が別々のクロック源を持つ場合、 タイマレジスタ間の相互関係を管理する方法はない。 これは各 CPU
 137 が微妙に異なる周波数で動作するためである。 これが真実の場合 (訳註: 各 CPU が別々のクロック源を持つ場合)、
 138 \fIclock_getcpuclockid(0)\fP は \fBENOENT\fP を返して、その状況を表す。 2 つのクロックは、プロセスが特定の CPU
 139 上に留まっていることが 保証できる場合にのみ有効である。
 140 .PP
 141 SMP システムの各プロセッサは全く同じ時刻に起動する訳ではないので、 各タイマレジスタは通常はあるオフセットで動作している。
 142 オフセットをブート時に制限するコードが含まれるアーキテクチャもある。 しかし、このコードがオフセットを正確に調整することは保証できない。 glibc は
 143 (Linux カーネルとは異なり) オフセットを扱うためのコードを提供しない。 通常はこれらのオフセットが小さいので、多くの場合でその影響は無視できる。
 144 .SH バグ
 145 .\" See http://bugzilla.kernel.org/show_bug.cgi?id=11972
 146 POSIX.1\-2001 では、 「適切な特権 (appropriate privileges)」を持ったプロセスは、
 147 \fBclock_settime\fP()  を使って、クロック \fBCLOCK_PROCESS_CPUTIME_ID\fP と
 148 \fBCLOCK_THREAD_CPUTIME_ID\fP を設定することができるとされている。 Linux では、これらのクロックは設定可能ではない
 149 (すなわち、どのプロセスも「適切な特権」を持たない)。
 150 .SH 関連項目
 151 \fBdate\fP(1), \fBadjtimex\fP(2), \fBgettimeofday\fP(2), \fBsettimeofday\fP(2),
 152 \fBtime\fP(2), \fBclock_getcpuclockid\fP(3), \fBctime\fP(3), \fBftime\fP(3),
 153 \fBpthread_getcpuclockid\fP(3), \fBsysconf\fP(3), \fBtime\fP(7)