CLOCK_GETRES
NAMESYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
VERSIONS
CONFORMING TO
AVAILABILITY
NOTES
BUGS
SEE ALSO
COLOPHON
NAME
clock_getres, clock_gettime, clock_settime − clock and time functions
SYNOPSIS
#include <time.h>
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 (only for glibc versions before 2.17).
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 <time.h>:
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 processes, or per-process if it measures time only within a single process.
All implementations support the system-wide real-time clock, which is identified by CLOCK_REALTIME. Its time represents seconds and nanoseconds 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 corresponding 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 clock that measures real (i.e., wall-clock) time. Setting this clock requires appropriate privileges. This clock is affected by discontinuous jumps in the system time (e.g., if the system administrator manually changes the clock), and by the incremental adjustments performed by adjtime(3) and NTP.
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. This clock is not affected by discontinuous jumps in the system time (e.g., if the system administrator manually changes the clock), but is affected by the incremental adjustments performed by adjtime(3) and NTP.
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 hardware-based time that is not subject to NTP adjustments or the incremental adjustments performed by adjtime(3).
CLOCK_BOOTTIME (since Linux 2.6.39; Linux-specific)
Identical to CLOCK_MONOTONIC, except it also includes any time that the system is suspended. This allows applications to get a suspend-aware monotonic clock without having to deal with the complications of CLOCK_REALTIME, which may have discontinuities if the time is changed using settimeofday(2).
CLOCK_PROCESS_CPUTIME_ID (since Linux 2.6.12)
Per-process CPU-time clock (measures CPU time consumed by all threads in the process).
CLOCK_THREAD_CPUTIME_ID (since Linux 2.6.12)
Thread-specific CPU-time clock.
RETURN VALUE
clock_gettime(), clock_settime() and clock_getres() return 0 for success, 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 indicated. |
VERSIONS
These system calls first appeared in Linux 2.6.
CONFORMING TO
SUSv2, POSIX.1-2001.
AVAILABILITY
On POSIX systems on which these functions are available, the symbol _POSIX_TIMERS is defined in <unistd.h> 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
Historical
note for SMP systems
Before Linux added kernel support for
CLOCK_PROCESS_CPUTIME_ID and
CLOCK_THREAD_CPUTIME_ID, glibc implemented these
clocks on many platforms using timer registers 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 condition. The two clocks will then be useful only 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 offset. Some architectures include code that attempts to limit these offsets 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.
Since glibc 2.4, the wrapper functions for the system calls described in this page avoid the abovementioned problems by employing the kernel implementation of CLOCK_PROCESS_CPUTIME_ID and CLOCK_THREAD_CPUTIME_ID, on systems that provide such an implementation (i.e., Linux 2.6.12 and later).
BUGS
According to POSIX.1-2001, a process with "appropriate privileges" may set the CLOCK_PROCESS_CPUTIME_ID and CLOCK_THREAD_CPUTIME_ID clocks using clock_settime(). On Linux, these clocks are not settable (i.e., no process has "appropriate privileges").
SEE ALSO
date(1), gettimeofday(2), settimeofday(2), time(2), adjtime(3), clock_getcpuclockid(3), ctime(3), ftime(3), pthread_getcpuclockid(3), sysconf(3), time(7)
COLOPHON
This page is part of release 3.69 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at http://www.kernel.org/doc/man−pages/.
More Linux Commands
manpages/join.n.html
join(n) - Create a string by joining together list elements
The list argument must be a valid Tcl list. This command returns the string formed by joining all of the elements of list together with joinString separating ea
manpages/Tcl_CreateInterp.3.html
Tcl_CreateInterp(3) - create and delete Tcl command interpre
Tcl_CreateInterp creates a new interpreter structure and returns a token for it. The token is required in calls to most other Tcl procedures, such as Tcl_Create
manpages/tcdrain.3.html
tcdrain(3) - get and set terminal attributes, line control,
The termios functions describe a general terminal interface that is provided to control asynchronous communications ports. The termios structure Many of the fun
manpages/XkbGetAutoResetControls.3.html
XkbGetAutoResetControls(3) - Gets the current values of the
You can configure the boolean controls to automatically be enabled or disabled when a program exits. This capability is controlled via two masks maintained in t
manpages/MIME::Body.3pm.html
MIME::Body(3pm) - the body of a MIME message (Man Page).....
MIME messages can be very long (e.g., tar files, MPEGs, etc.) or very short (short textual notes, as in ordinary mail). Long messages are best stored in files,
manpages/git-remote-helpers.1.html
git-remote-helpers(1) - Helper programs to interact with rem
Remote helper programs are normally not used directly by end users, but they are invoked by git when it needs to interact with remote repositories git does not
manpages/roff2ps.1.html
roff2ps(1) - transform roff code into ps mode (Man Page)....
roff2ps transforms roff code into ps mode. Print the result to standard output. There are more of these programs for generating other formats of roff input. rof
manpages/smbcquotas.1.html
smbcquotas(1) - Set or get QUOTAs of NTFS 5 shares (ManPage)
This tool is part of the samba(7) suite. The smbcquotas program manipulates NT Quotas on SMB file shares. OPTIONS The following options are available to the smb
manpages/mvwinnwstr.3ncurses.html
mvwinnwstr(3ncurses) - get a string of wchar_t characters fr
These routines return a string of wchar_t characters in wstr, extracted starting at the current cursor position in the named window. Attributes are stripped fro
manpages/machinectl.1.html
machinectl(1) Control the systemd machine manager (ManPage)
machinectl may be used to introspect and control the state of the systemd(1) virtual machine and container registration manager systemd-machined.service(8). OPT
manpages/write.2.html
write(2) - write to a file descriptor - Linux manual page...
write() writes up to count bytes from the buffer pointed buf to the file referred to by the file descriptor fd. The number of bytes written may be less than cou
manpages/Tk_CreateImageType.3.html
Tk_CreateImageType(3) - define new kind of image (Man Page)
Tk_CreateImageType is invoked to define a new kind of image. An image type corresponds to a particular value of the type argument for the image create command.
