リナックスコマンド

clock_getresのヘルプ・マニュアル

日本語 英語

• help
• man

clock_getres --help

man clock_getres

CLOCK_GETRES(2) Linux Programmer’s Manual CLOCK_GETRES(2) 名前 clock_getres, clock_gettime, clock_settime - クロックと時間の関数 書式 #include int clock_getres(clockid_t clk_id, struct timespec *res); int clock_gettime(clockid_t clk_id, struct timespec *tp); int clock_settime(clockid_t clk_id, const struct timespec *tp); -lrt とリンクする。 glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照): clock_getres(), clock_gettime(), clock_settime(): _POSIX_C_SOURCE >= 199309L 説明 関数 clock_getres() は指定されたクロック clk_id の分解能 (精度) を探 し 出す。 res が NULL でない場合、その分解能を res で指される struct time- spec に格納する。クロックの分解能は実装に依存し、特定のプロセスによって 設定することはできない。 clock_settime() の引き数 tp で指される時間の値 が res の倍数でない場合、 res の倍数に切り詰められる。 関数 clock_gettime() と clock_settime() は、指定されたクロッ ク clk_id の時間を取得または設定する。 res と tp 引き数は timespec 構造体であり、 で以下のように規定 されている: struct timespec { time_t tv_sec; /* seconds */ long tv_nsec; /* nanoseconds */ }; clk_id 引き数は特定のクロックの識別子であり、そのクロックで動作する。ク ロ ックはシステム全体に適用することもでき、その場合は全てのプロセスから 見ることができる。また 1 つのプロセス内でのみ時間を計測する場合は、プロ セス毎に適用することもできる。 全 て の 実装においてシステム全体のリアルタイムクロックがサポートされ、 CLOCK_REALTIME で識別される。時間は紀元 (the Epoch) からの秒とナノ秒 で 表 される。時間が変更された場合、相対的な時間間隔のタイマは影響を受けな いが、絶対的な時点のタイマは影響を受ける。 さらにいくつかのクロックが実装されているかもしれない。対応する時間の 値 を解釈する方法とタイマへの影響は、定められていない。 glibc と Linux カーネルの最新のバージョンでは、以下のような十分なクロッ クがサポートされている。 CLOCK_REALTIME システム全体のリアルタイムクロック。このクロックを設定するには適 切な特権が必要である。 CLOCK_MONOTONIC いくつかの開始点が指定されていないため、クロックがモノトニックタ イムを設定したり表現したりできない。 CLOCK_MONOTONIC_RAW (Linux 2.6.28 以降; Linux 特有) CLOCK_MONOTONIC と同様だが、NTP による調整の影響を受けない、ハー ドウェアによる生の時刻へのアクセスができる。 CLOCK_PROCESS_CPUTIME_ID CPU による高分解能のプロセス毎のタイマ。 CLOCK_THREAD_CPUTIME_ID スレッド固有の CPU タイムクロック。 返り値 clock_gettime(), clock_settime(), clock_getres() は成功した場合に 0 を 返し、失敗した場合に -1 を返す (失敗した場合、 errno が適切に設定 さ れ る)。 エラー EFAULT tp がアクセス可能なアドレス空間の外を指した。 EINVAL 指定された clk_id がこのシステムでサポートされていない。 EPERM 指示されたクロックを設定する権限が clock_settime() にない。 準拠 SUSv2, POSIX.1-2001. 可用性 こ れらの関数が利用可能な POSIX システムでは、 においてシンボ ル _POSIX_TIMERS が 0 より大きい値に定 義 さ れ て い る 。 シ ン ボ ル _POSIX_MONOTONIC_CLOCK, _POSIX_CPUTIME, _POSIX_THREAD_CPUTIME は CLOCK_MONOTONIC, CLOCK_PROCESS_CPUTIME_ID, CLOCK_THREAD_CPUTIME_ID が利 用可能なことを示す。 (sysconf(3) も参照すること。) 注意 SMP システムについての注意 CLOCK_PROCESS_CPUTIME_ID と CLOCK_THREAD_CPUTIME_ID クロックは、CPU か らのタイマ (i386 上の TSC、Itanium 上の AR.ITC) を用いて実現されてい る 。 これらのレジスタは CPU 間で異なる可能性があり、プロセスが他の CPU に 移動させられた場合、結果としてこれらのクロ ッ ク が 偽 の 結 果 (bogus results) を返すかもしれない。 SMP システムの各 CPU が別々のクロック源を持つ場合、タイマレジスタ間の相 互関係を管理する方法はない。これは各 CPU が微妙に異なる周波数で動作する た め である。これが真実の場合 (訳註: 各 CPU が別々のクロック源を持つ場 合)、 clock_getcpuclockid(0) は ENOENT を返して、その状況を表す。 2 つ のクロックは、プロセスが特定の CPU 上に留まっていることが保証できる場合 にのみ有効である。 SMP システムの各プロセッサは全く同じ時刻に起動する訳ではないので、各 タ イ マレジスタは通常はあるオフセットで動作している。オフセットをブート時 に制限するコードが含まれるアーキテクチャもある。しかし、このコードが オ フセットを正確に調整することは保証できない。 glibc は (Linux カーネルと は異なり) オフセットを扱うためのコードを提供しない。通常はこれらのオ フ セットが小さいので、多くの場合でその影響は無視できる。 バグ POSIX.1-2001 で は 、 ク ロ ッ ク CLOCK_PROCESS_CPUTIME_ID と CLOCK_THREAD_CPUTIME_ID は clock_settime() により設定可能にすべきとされ ている。しかし、これらのクロックは現在のところそうなっていない。 関連項目 date(1), adjtimex(2), gettimeofday(2), settimeofday(2), time(2), clock_getcpuclockid(3), ctime(3), ftime(3), pthread_getcpuclockid(3), sysconf(3), time(7) 2009-02-05 CLOCK_GETRES(2)

CLOCK_GETRES(2) Linux Programmer’s Manual CLOCK_GETRES(2) NAME clock_getres, clock_gettime, clock_settime - clock and time functions SYNOPSIS #include int clock_getres(clockid_t clk_id, struct timespec *res); int clock_gettime(clockid_t clk_id, struct timespec *tp); int clock_settime(clockid_t clk_id, const struct timespec *tp); Link with -lrt. Feature Test Macro Requirements for glibc (see feature_test_macros(7)): clock_getres(), clock_gettime(), clock_settime(): _POSIX_C_SOURCE >= 199309L DESCRIPTION The function clock_getres() finds the resolution (precision) of the specified clock clk_id, and, if res is non-NULL, stores it in the struct timespec pointed to by res. The resolution of clocks depends on the implementation and cannot be configured by a particular process. If the time value pointed to by the argument tp of clock_settime() is not a multiple of res, then it is truncated to a multiple of res. The functions clock_gettime() and clock_settime() retrieve and set the time of the specified clock clk_id. The res and tp arguments are timespec structures, as specified in : struct timespec { time_t tv_sec; /* seconds */ long tv_nsec; /* nanoseconds */ }; The clk_id argument is the identifier of the particular clock on which to act. A clock may be system-wide and hence visible for all pro- cesses, or per-process if it measures time only within a single pro- cess. All implementations support the system-wide real-time clock, which is identified by CLOCK_REALTIME. Its time represents seconds and nanosec- onds since the Epoch. When its time is changed, timers for a relative interval are unaffected, but timers for an absolute point in time are affected. More clocks may be implemented. The interpretation of the correspond- ing time values and the effect on timers is unspecified. Sufficiently recent versions of glibc and the Linux kernel support the following clocks: CLOCK_REALTIME System-wide real-time clock. Setting this clock requires appro- priate privileges. CLOCK_REALTIME_COARSE (since Linux 2.6.32; Linux-specific) A faster but less precise version of CLOCK_REALTIME. Use when you need very fast, but not fine-grained timestamps. CLOCK_MONOTONIC Clock that cannot be set and represents monotonic time since some unspecified starting point. CLOCK_MONOTONIC_COARSE (since Linux 2.6.32; Linux-specific) A faster but less precise version of CLOCK_MONOTONIC. Use when you need very fast, but not fine-grained timestamps. CLOCK_MONOTONIC_RAW (since Linux 2.6.28; Linux-specific) Similar to CLOCK_MONOTONIC, but provides access to a raw hard- ware-based time that is not subject to NTP adjustments. CLOCK_PROCESS_CPUTIME_ID High-resolution per-process timer from the CPU. CLOCK_THREAD_CPUTIME_ID Thread-specific CPU-time clock. RETURN VALUE clock_gettime(), clock_settime() and clock_getres() return 0 for suc- cess, or -1 for failure (in which case errno is set appropriately). ERRORS EFAULT tp points outside the accessible address space. EINVAL The clk_id specified is not supported on this system. EPERM clock_settime() does not have permission to set the clock indi- cated. CONFORMING TO SUSv2, POSIX.1-2001. AVAILABILITY On POSIX systems on which these functions are available, the symbol _POSIX_TIMERS is defined in to a value greater than 0. The symbols _POSIX_MONOTONIC_CLOCK, _POSIX_CPUTIME, _POSIX_THREAD_CPUTIME indicate that CLOCK_MONOTONIC, CLOCK_PROCESS_CPUTIME_ID, CLOCK_THREAD_CPUTIME_ID are available. (See also sysconf(3).) NOTES Note for SMP systems The CLOCK_PROCESS_CPUTIME_ID and CLOCK_THREAD_CPUTIME_ID clocks are realized on many platforms using timers from the CPUs (TSC on i386, AR.ITC on Itanium). These registers may differ between CPUs and as a consequence these clocks may return bogus results if a process is migrated to another CPU. If the CPUs in an SMP system have different clock sources then there is no way to maintain a correlation between the timer registers since each CPU will run at a slightly different frequency. If that is the case then clock_getcpuclockid(0) will return ENOENT to signify this condi- tion. The two clocks will then only be useful if it can be ensured that a process stays on a certain CPU. The processors in an SMP system do not start all at exactly the same time and therefore the timer registers are typically running at an off- set. Some architectures include code that attempts to limit these off- sets on bootup. However, the code cannot guarantee to accurately tune the offsets. Glibc contains no provisions to deal with these offsets (unlike the Linux Kernel). Typically these offsets are small and therefore the effects may be negligible in most cases. BUGS According to POSIX.1-2001, the CLOCK_PROCESS_CPUTIME_ID and CLOCK_THREAD_CPUTIME_ID clocks should be settable using clock_settime(). However, the clocks currently are not settable. SEE ALSO date(1), adjtimex(2), gettimeofday(2), settimeofday(2), time(2), clock_getcpuclockid(3), ctime(3), ftime(3), pthread_getcpuclockid(3), sysconf(3), time(7) COLOPHON This page is part of release 3.22 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. 2009-02-05 CLOCK_GETRES(2)