]>
Commit | Line | Data |
---|---|---|
fea681da MK |
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 | .\" | |
93015253 | 4 | .\" %%%LICENSE_START(VERBATIM) |
fea681da MK |
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. | |
c13182ef | 13 | .\" |
fea681da MK |
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. | |
c13182ef | 21 | .\" |
fea681da MK |
22 | .\" Formatted or processed versions of this manual, if unaccompanied by |
23 | .\" the source, must acknowledge the copyright and authors of this work. | |
4b72fb64 | 24 | .\" %%%LICENSE_END |
fea681da MK |
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 | .\" | |
2fd2c35c | 30 | .TH CLOCK_GETRES 2 2013-12-28 "" "Linux Programmer's Manual" |
fea681da MK |
31 | .SH NAME |
32 | clock_getres, clock_gettime, clock_settime \- clock and time functions | |
33 | .SH SYNOPSIS | |
34 | .B #include <time.h> | |
35 | .sp | |
36 | .BI "int clock_getres(clockid_t " clk_id ", struct timespec *" res ); | |
5895e7eb | 37 | |
fea681da | 38 | .BI "int clock_gettime(clockid_t " clk_id ", struct timespec *" tp ); |
5895e7eb | 39 | |
fea681da | 40 | .BI "int clock_settime(clockid_t " clk_id ", const struct timespec *" tp ); |
cc4615cc | 41 | .sp |
02959991 | 42 | Link with \fI\-lrt\fP (only for glibc versions before 2.17). |
b905d225 | 43 | .sp |
cc4615cc MK |
44 | .in -4n |
45 | Feature Test Macro Requirements for glibc (see | |
46 | .BR feature_test_macros (7)): | |
47 | .in | |
48 | .sp | |
49 | .ad l | |
50 | .BR clock_getres (), | |
51 | .BR clock_gettime (), | |
52 | .BR clock_settime (): | |
8260c01f | 53 | .RS |
cc4615cc | 54 | _POSIX_C_SOURCE\ >=\ 199309L |
8260c01f | 55 | .RE |
cc4615cc | 56 | .ad b |
fea681da MK |
57 | .SH DESCRIPTION |
58 | The function | |
59 | .BR clock_getres () | |
60 | finds the resolution (precision) of the specified clock | |
61 | .IR clk_id , | |
62 | and, if | |
63 | .I res | |
0c2ec4f1 | 64 | is non-NULL, stores it in the \fIstruct timespec\fP pointed to by |
fea681da MK |
65 | .IR res . |
66 | The resolution of clocks depends on the implementation and cannot be | |
67 | configured by a particular process. | |
68 | If the time value pointed to by the argument | |
69 | .I tp | |
70 | of | |
71 | .BR clock_settime () | |
72 | is not a multiple of | |
73 | .IR res , | |
74 | then it is truncated to a multiple of | |
75 | .IR res . | |
76 | .PP | |
77 | The functions | |
78 | .BR clock_gettime () | |
79 | and | |
80 | .BR clock_settime () | |
81 | retrieve and set the time of the specified clock | |
82 | .IR clk_id . | |
83 | .PP | |
84 | The | |
85 | .I res | |
86 | and | |
87 | .I tp | |
88 | arguments are | |
f19a0f03 | 89 | .I timespec |
4e836144 | 90 | structures, as specified in |
c13182ef | 91 | .IR <time.h> : |
fea681da | 92 | .sp |
3ad4ddcd | 93 | .in +4n |
fea681da MK |
94 | .nf |
95 | struct timespec { | |
cc4615cc MK |
96 | time_t tv_sec; /* seconds */ |
97 | long tv_nsec; /* nanoseconds */ | |
fea681da MK |
98 | }; |
99 | .fi | |
3ad4ddcd | 100 | .in |
fea681da | 101 | .PP |
c13182ef | 102 | The |
fea681da MK |
103 | .I clk_id |
104 | argument is the identifier of the particular clock on which to act. | |
105 | A clock may be system-wide and hence visible for all processes, or | |
106 | per-process if it measures time only within a single process. | |
107 | .LP | |
6f36deb4 | 108 | All implementations support the system-wide real-time clock, |
fea681da MK |
109 | which is identified by |
110 | .BR CLOCK_REALTIME . | |
111 | Its time represents seconds and nanoseconds since the Epoch. | |
112 | When its time is changed, timers for a relative interval are | |
113 | unaffected, but timers for an absolute point in time are affected. | |
114 | .LP | |
c13182ef MK |
115 | More clocks may be implemented. |
116 | The interpretation of the | |
fea681da MK |
117 | corresponding time values and the effect on timers is unspecified. |
118 | .LP | |
5260fe08 | 119 | Sufficiently recent versions of glibc and the Linux kernel |
fea681da MK |
120 | support the following clocks: |
121 | .TP | |
122 | .B CLOCK_REALTIME | |
22594a3c | 123 | System-wide clock that measures real (i.e., wall-clock) time. |
fea681da | 124 | Setting this clock requires appropriate privileges. |
22594a3c MK |
125 | This clock is affected by discontinuous jumps in the system time |
126 | (e.g., if the system administrator manually changes the clock), | |
127 | and by the incremental adjustments performed by | |
65a0c012 | 128 | .BR adjtime (3) |
22594a3c | 129 | and NTP. |
f5546fcd | 130 | .TP |
55f749ae CH |
131 | .BR CLOCK_REALTIME_COARSE " (since Linux 2.6.32; Linux-specific)" |
132 | .\" Added in commit da15cfdae03351c689736f8d142618592e3cebc3 | |
1d33f7d7 MK |
133 | A faster but less precise version of |
134 | .BR CLOCK_REALTIME . | |
55f749ae CH |
135 | Use when you need very fast, but not fine-grained timestamps. |
136 | .TP | |
fea681da MK |
137 | .TP |
138 | .B CLOCK_MONOTONIC | |
139 | Clock that cannot be set and represents monotonic time since | |
140 | some unspecified starting point. | |
63f0f3d9 MK |
141 | This clock is not affected by discontinuous jumps in the system time |
142 | (e.g., if the system administrator manually changes the clock), | |
143 | but is affected by the incremental adjustments performed by | |
65a0c012 | 144 | .BR adjtime (3) |
63f0f3d9 | 145 | and NTP. |
f5546fcd | 146 | .TP |
55f749ae CH |
147 | .BR CLOCK_MONOTONIC_COARSE " (since Linux 2.6.32; Linux-specific)" |
148 | .\" Added in commit da15cfdae03351c689736f8d142618592e3cebc3 | |
1d33f7d7 MK |
149 | A faster but less precise version of |
150 | .BR CLOCK_MONOTONIC . | |
55f749ae | 151 | Use when you need very fast, but not fine-grained timestamps. |
fea681da | 152 | .TP |
1ba3fba8 MK |
153 | .BR CLOCK_MONOTONIC_RAW " (since Linux 2.6.28; Linux-specific)" |
154 | .\" Added in commit 2d42244ae71d6c7b0884b5664cf2eda30fb2ae68, John Stultz | |
155 | Similar to | |
156 | .BR CLOCK_MONOTONIC , | |
157 | but provides access to a raw hardware-based time | |
63f0f3d9 MK |
158 | that is not subject to NTP adjustments or |
159 | the incremental adjustments performed by | |
65a0c012 | 160 | .BR adjtime (3). |
1ba3fba8 | 161 | .TP |
b28712e1 | 162 | .BR CLOCK_BOOTTIME " (since Linux 2.6.39; Linux-specific)" |
a5d9ce65 MK |
163 | .\" commit 7fdd7f89006dd5a4c702fa0ce0c272345fa44ae0 |
164 | .\" commit 70a08cca1227dc31c784ec930099a4417a06e7d0 | |
b28712e1 CH |
165 | Identical to |
166 | .BR CLOCK_MONOTONIC , | |
a5d9ce65 MK |
167 | except it also includes any time that the system is suspended. |
168 | This allows applications to get a suspend-aware monotonic clock | |
169 | without having to deal with the complications of | |
170 | .BR CLOCK_REALTIME , | |
171 | which may have discontinuities if the time is changed using | |
172 | .BR settimeofday (2). | |
b28712e1 | 173 | .TP |
783d6cb4 | 174 | .BR CLOCK_PROCESS_CPUTIME_ID " (since Linux 2.6.12)" |
2fd2c35c MK |
175 | Per-process CPU-time clock |
176 | (measures CPU time consumed by all threads in the process). | |
fea681da | 177 | .TP |
783d6cb4 | 178 | .BR CLOCK_THREAD_CPUTIME_ID " (since Linux 2.6.12)" |
fea681da | 179 | Thread-specific CPU-time clock. |
47297adb | 180 | .SH RETURN VALUE |
e1d6264d MK |
181 | .BR clock_gettime (), |
182 | .BR clock_settime () | |
fea681da MK |
183 | and |
184 | .BR clock_getres () | |
185 | return 0 for success, or \-1 for failure (in which case | |
186 | .I errno | |
187 | is set appropriately). | |
188 | .SH ERRORS | |
189 | .TP | |
190 | .B EFAULT | |
191 | .I tp | |
192 | points outside the accessible address space. | |
193 | .TP | |
194 | .B EINVAL | |
c13182ef | 195 | The |
fea681da MK |
196 | .I clk_id |
197 | specified is not supported on this system. | |
a113440c MK |
198 | .\" Linux also gives this error on attempts to set CLOCK_PROCESS_CPUTIME_ID |
199 | .\" and CLOCK_THREAD_CPUTIME_ID, when probably the proper error should be | |
200 | .\" EPERM. | |
fea681da MK |
201 | .TP |
202 | .B EPERM | |
203 | .BR clock_settime () | |
204 | does not have permission to set the clock indicated. | |
e272bb60 | 205 | .SH VERSIONS |
50b25c38 | 206 | These system calls first appeared in Linux 2.6. |
47297adb | 207 | .SH CONFORMING TO |
2b2581ee MK |
208 | SUSv2, POSIX.1-2001. |
209 | .SH AVAILABILITY | |
210 | On POSIX systems on which these functions are available, the symbol | |
211 | .B _POSIX_TIMERS | |
c84371c6 | 212 | is defined in \fI<unistd.h>\fP to a value greater than 0. |
2b2581ee MK |
213 | The symbols |
214 | .BR _POSIX_MONOTONIC_CLOCK , | |
215 | .BR _POSIX_CPUTIME , | |
216 | .B _POSIX_THREAD_CPUTIME | |
217 | indicate that | |
218 | .BR CLOCK_MONOTONIC , | |
219 | .BR CLOCK_PROCESS_CPUTIME_ID , | |
220 | .B CLOCK_THREAD_CPUTIME_ID | |
221 | are available. | |
222 | (See also | |
223 | .BR sysconf (3).) | |
19c98696 | 224 | .SH NOTES |
78638aae MK |
225 | .SS Historical note for SMP systems |
226 | Before Linux added kernel support for | |
fea681da MK |
227 | .B CLOCK_PROCESS_CPUTIME_ID |
228 | and | |
78638aae MK |
229 | .BR CLOCK_THREAD_CPUTIME_ID , |
230 | glibc implemented these clocks on many platforms using timer | |
231 | registers from the CPUs | |
fea681da MK |
232 | (TSC on i386, AR.ITC on Itanium). |
233 | These registers may differ between CPUs and as a consequence | |
234 | these clocks may return | |
235 | .B bogus results | |
236 | if a process is migrated to another CPU. | |
237 | .PP | |
238 | If the CPUs in an SMP system have different clock sources then | |
239 | there is no way to maintain a correlation between the timer registers since | |
c13182ef MK |
240 | each CPU will run at a slightly different frequency. |
241 | If that is the case then | |
fea681da MK |
242 | .I clock_getcpuclockid(0) |
243 | will return | |
244 | .B ENOENT | |
c13182ef | 245 | to signify this condition. |
33a0ccb2 | 246 | The two clocks will then be useful only if it |
fea681da MK |
247 | can be ensured that a process stays on a certain CPU. |
248 | .PP | |
249 | The processors in an SMP system do not start all at exactly the same | |
250 | time and therefore the timer registers are typically running at an offset. | |
251 | Some architectures include code that attempts to limit these offsets on bootup. | |
252 | However, the code cannot guarantee to accurately tune the offsets. | |
253 | Glibc contains no provisions to deal with these offsets (unlike the Linux | |
c13182ef MK |
254 | Kernel). |
255 | Typically these offsets are small and therefore the effects may be | |
fea681da | 256 | negligible in most cases. |
78638aae MK |
257 | |
258 | Since glibc 2.4, | |
259 | the wrapper functions for the system calls described in this page avoid | |
260 | the abovementioned problems by employing the kernel implementation of | |
261 | .B CLOCK_PROCESS_CPUTIME_ID | |
262 | and | |
263 | .BR CLOCK_THREAD_CPUTIME_ID , | |
264 | on systems that provide such an implementation | |
265 | (i.e., Linux 2.6.12 and later). | |
3847be78 | 266 | .SH BUGS |
a113440c | 267 | According to POSIX.1-2001, a process with "appropriate privileges" may set the |
3847be78 MK |
268 | .B CLOCK_PROCESS_CPUTIME_ID |
269 | and | |
270 | .B CLOCK_THREAD_CPUTIME_ID | |
a113440c | 271 | clocks using |
3847be78 | 272 | .BR clock_settime (). |
a113440c MK |
273 | On Linux, these clocks are not settable |
274 | (i.e., no process has "appropriate privileges"). | |
275 | .\" See http://bugzilla.kernel.org/show_bug.cgi?id=11972 | |
47297adb | 276 | .SH SEE ALSO |
fea681da | 277 | .BR date (1), |
fea681da MK |
278 | .BR gettimeofday (2), |
279 | .BR settimeofday (2), | |
280 | .BR time (2), | |
65a0c012 | 281 | .BR adjtime (3), |
edf60acb | 282 | .BR clock_getcpuclockid (3), |
fea681da MK |
283 | .BR ctime (3), |
284 | .BR ftime (3), | |
24ad017d | 285 | .BR pthread_getcpuclockid (3), |
1d7c4d16 | 286 | .BR sysconf (3), |
b3682895 | 287 | .BR time (7) |