original/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 .TH CLOCK_GETRES 2 2010-02-03 "" "Linux Programmer's Manual"
  33 .SH NAME
  34 clock_getres, clock_gettime, clock_settime \- clock and time functions
  35 .SH SYNOPSIS
  36 .B #include <time.h>
  37 .sp
  38 .BI "int clock_getres(clockid_t " clk_id ", struct timespec *" res );
  39
  40 .BI "int clock_gettime(clockid_t " clk_id ", struct timespec *" tp );
  41
  42 .BI "int clock_settime(clockid_t " clk_id ", const struct timespec *" tp );
  43 .sp
  44 Link with \fI\-lrt\fP.
  45 .sp
  46 .in -4n
  47 Feature Test Macro Requirements for glibc (see
  48 .BR feature_test_macros (7)):
  49 .in
  50 .sp
  51 .ad l
  52 .BR clock_getres (),
  53 .BR clock_gettime (),
  54 .BR clock_settime ():
  55 .RS
  56 _POSIX_C_SOURCE\ >=\ 199309L
  57 .RE
  58 .ad b
  59 .SH DESCRIPTION
  60 The function
  61 .BR clock_getres ()
  62 finds the resolution (precision) of the specified clock
  63 .IR clk_id ,
  64 and, if
  65 .I res
  66 is non-NULL, stores it in the \fIstruct timespec\fP pointed to by
  67 .IR res .
  68 The resolution of clocks depends on the implementation and cannot be
  69 configured by a particular process.
  70 If the time value pointed to by the argument
  71 .I tp
  72 of
  73 .BR clock_settime ()
  74 is not a multiple of
  75 .IR res ,
  76 then it is truncated to a multiple of
  77 .IR res .
  78 .PP
  79 The functions
  80 .BR clock_gettime ()
  81 and
  82 .BR clock_settime ()
  83 retrieve and set the time of the specified clock
  84 .IR clk_id .
  85 .PP
  86 The
  87 .I res
  88 and
  89 .I tp
  90 arguments are
  91 .I timespec
  92 structures, as specified  in
  93 .IR <time.h> :
  94 .sp
  95 .in +4n
  96 .nf
  97 struct timespec {
  98     time_t   tv_sec;        /* seconds */
  99     long     tv_nsec;       /* nanoseconds */
 100 };
 101 .fi
 102 .in
 103 .PP
 104 The
 105 .I clk_id
 106 argument is the identifier of the particular clock on which to act.
 107 A clock may be system-wide and hence visible for all processes, or
 108 per-process if it measures time only within a single process.
 109 .LP
 110 All implementations support the system-wide real-time clock,
 111 which is identified by
 112 .BR CLOCK_REALTIME .
 113 Its time represents seconds and nanoseconds since the Epoch.
 114 When its time is changed, timers for a relative interval are
 115 unaffected, but timers for an absolute point in time are affected.
 116 .LP
 117 More clocks may be implemented.
 118 The interpretation of the
 119 corresponding time values and the effect on timers is unspecified.
 120 .LP
 121 Sufficiently recent versions of glibc and the Linux kernel
 122 support the following clocks:
 123 .TP
 124 .B CLOCK_REALTIME
 125 System-wide real-time clock.
 126 Setting this clock requires appropriate privileges.
 127 .TP
 128 .B CLOCK_MONOTONIC
 129 Clock that cannot be set and represents monotonic time since
 130 some unspecified starting point.
 131 .TP
 132 .BR CLOCK_MONOTONIC_RAW " (since Linux 2.6.28; Linux-specific)"
 133 .\" Added in commit 2d42244ae71d6c7b0884b5664cf2eda30fb2ae68, John Stultz
 134 Similar to
 135 .BR CLOCK_MONOTONIC ,
 136 but provides access to a raw hardware-based time
 137 that is not subject to NTP adjustments.
 138 .TP
 139 .B CLOCK_PROCESS_CPUTIME_ID
 140 High-resolution per-process timer from the CPU.
 141 .TP
 142 .B CLOCK_THREAD_CPUTIME_ID
 143 Thread-specific CPU-time clock.
 144 .SH "RETURN VALUE"
 145 .BR clock_gettime (),
 146 .BR clock_settime ()
 147 and
 148 .BR clock_getres ()
 149 return 0 for success, or \-1 for failure (in which case
 150 .I errno
 151 is set appropriately).
 152 .SH ERRORS
 153 .TP
 154 .B EFAULT
 155 .I tp
 156 points outside the accessible address space.
 157 .TP
 158 .B EINVAL
 159 The
 160 .I clk_id
 161 specified is not supported on this system.
 162 .\" Linux also gives this error on attempts to set CLOCK_PROCESS_CPUTIME_ID
 163 .\" and CLOCK_THREAD_CPUTIME_ID, when probably the proper error should be
 164 .\" EPERM.
 165 .TP
 166 .B EPERM
 167 .BR clock_settime ()
 168 does not have permission to set the clock indicated.
 169 .SH "CONFORMING TO"
 170 SUSv2, POSIX.1-2001.
 171 .SH AVAILABILITY
 172 On POSIX systems on which these functions are available, the symbol
 173 .B _POSIX_TIMERS
 174 is defined in \fI<unistd.h>\fP to a value greater than 0.
 175 The symbols
 176 .BR _POSIX_MONOTONIC_CLOCK ,
 177 .BR _POSIX_CPUTIME ,
 178 .B _POSIX_THREAD_CPUTIME
 179 indicate that
 180 .BR CLOCK_MONOTONIC ,
 181 .BR CLOCK_PROCESS_CPUTIME_ID ,
 182 .B CLOCK_THREAD_CPUTIME_ID
 183 are available.
 184 (See also
 185 .BR sysconf (3).)
 186 .SH NOTES
 187 .SS Note for SMP systems
 188 The
 189 .B CLOCK_PROCESS_CPUTIME_ID
 190 and
 191 .B CLOCK_THREAD_CPUTIME_ID
 192 clocks are realized on many platforms using timers from the CPUs
 193 (TSC on i386, AR.ITC on Itanium).
 194 These registers may differ between CPUs and as a consequence
 195 these clocks may return
 196 .B bogus results
 197 if a process is migrated to another CPU.
 198 .PP
 199 If the CPUs in an SMP system have different clock sources then
 200 there is no way to maintain a correlation between the timer registers since
 201 each CPU will run at a slightly different frequency.
 202 If that is the case then
 203 .I clock_getcpuclockid(0)
 204 will return
 205 .B ENOENT
 206 to signify this condition.
 207 The two clocks will then only be useful if it
 208 can be ensured that a process stays on a certain CPU.
 209 .PP
 210 The processors in an SMP system do not start all at exactly the same
 211 time and therefore the timer registers are typically running at an offset.
 212 Some architectures include code that attempts to limit these offsets on bootup.
 213 However, the code cannot guarantee to accurately tune the offsets.
 214 Glibc contains no provisions to deal with these offsets (unlike the Linux
 215 Kernel).
 216 Typically these offsets are small and therefore the effects may be
 217 negligible in most cases.
 218 .SH BUGS
 219 According to POSIX.1-2001, a process with "appropriate privileges" may set the
 220 .B CLOCK_PROCESS_CPUTIME_ID
 221 and
 222 .B CLOCK_THREAD_CPUTIME_ID
 223 clocks using
 224 .BR clock_settime ().
 225 On Linux, these clocks are not settable
 226 (i.e., no process has "appropriate privileges").
 227 .\" See http://bugzilla.kernel.org/show_bug.cgi?id=11972
 228 .SH "SEE ALSO"
 229 .BR date (1),
 230 .BR adjtimex (2),
 231 .BR gettimeofday (2),
 232 .BR settimeofday (2),
 233 .BR time (2),
 234 .BR clock_getcpuclockid (3),
 235 .BR ctime (3),
 236 .BR ftime (3),
 237 .BR pthread_getcpuclockid (3),
 238 .BR sysconf (3),
 239 .BR time (7)