original/man2/clock_nanosleep.2

   1 .\" Copyright (c) 2008, Linux Foundation, written by Michael Kerrisk
   2 .\" <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   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.
  13 .\"
  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.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH CLOCK_NANOSLEEP 2 2014-12-31 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 clock_nanosleep \- high-resolution sleep with specifiable clock
  29 .SH SYNOPSIS
  30 .B #include <time.h>
  31 .nf
  32 .sp
  33 .BI "int clock_nanosleep(clockid_t " clock_id ", int " flags ,
  34 .BI "                    const struct timespec *" request ,
  35 .BI "                    struct timespec *" remain );
  36 .fi
  37 .sp
  38 Link with \fI\-lrt\fP (only for glibc versions before 2.17).
  39 .sp
  40 .ad l
  41 .in -4n
  42 Feature Test Macro Requirements for glibc (see
  43 .BR feature_test_macros (7)):
  44 .in
  45 .sp
  46 .BR clock_nanosleep ():
  47 .RS 4
  48 _XOPEN_SOURCE\ >=\ 600 || _POSIX_C_SOURCE\ >=\ 200112L
  49 .RE
  50 .ad
  51 .SH DESCRIPTION
  52 Like
  53 .BR nanosleep (2),
  54 .BR clock_nanosleep ()
  55 allows the calling thread to sleep for an interval specified
  56 with nanosecond precision.
  57 It differs in allowing the caller to select the clock against
  58 which the sleep interval is to be measured,
  59 and in allowing the sleep interval to be specified as
  60 either an absolute or a relative value.
  61
  62 The time values passed to and returned by this call are specified using
  63 .I timespec
  64 structures, defined as follows:
  65 .sp
  66 .in +4n
  67 .nf
  68 struct timespec {
  69     time_t tv_sec;        /* seconds */
  70     long   tv_nsec;       /* nanoseconds [0 .. 999999999] */
  71 };
  72 .fi
  73 .in
  74
  75 The
  76 .I clock_id
  77 argument specifies the clock against which the sleep interval
  78 is to be measured.
  79 This argument can have one of the following values:
  80 .TP 17
  81 .BR CLOCK_REALTIME
  82 A settable system-wide real-time clock.
  83 .TP
  84 .BR CLOCK_MONOTONIC
  85 A nonsettable, monotonically increasing clock that measures time
  86 since some unspecified point in the past that does not change after
  87 system startup.
  88 .\" On Linux this clock measures time since boot.
  89 .TP
  90 .BR CLOCK_PROCESS_CPUTIME_ID
  91 A settable per-process clock that measures CPU time consumed
  92 by all threads in the process.
  93 .\" There is some trickery between glibc and the kernel
  94 .\" to deal with the CLOCK_PROCESS_CPUTIME_ID case.
  95 .PP
  96 See
  97 .BR clock_getres (2)
  98 for further details on these clocks.
  99 In addition, the CPU clock IDs returned by
 100 .BR clock_getcpuclockid (3)
 101 and
 102 .BR pthread_getcpuclockid (3)
 103 can also be passed in
 104 .IR clock_id .
 105
 106 If
 107 .I flags
 108 is 0, then the value specified in
 109 .I request
 110 is interpreted as an interval relative to the current
 111 value of the clock specified by
 112 .IR clock_id .
 113
 114 If
 115 .I flags
 116 is
 117 .BR TIMER_ABSTIME ,
 118 then
 119 .I request
 120 is interpreted as an absolute time as measured by the clock,
 121 .IR clock_id .
 122 If
 123 .I request
 124 is less than or equal to the current value of the clock,
 125 then
 126 .BR clock_nanosleep ()
 127 returns immediately without suspending the calling thread.
 128
 129 .BR clock_nanosleep ()
 130 suspends the execution of the calling thread
 131 until either at least the time specified by
 132 .IR request
 133 has elapsed,
 134 or a signal is delivered that causes a signal handler to be called or
 135 that terminates the process.
 136
 137 If the call is interrupted by a signal handler,
 138 .BR clock_nanosleep ()
 139 fails with the error
 140 .BR EINTR .
 141 In addition, if
 142 .I remain
 143 is not NULL, and
 144 .I flags
 145 was not
 146 .BR TIMER_ABSTIME ,
 147 it returns the remaining unslept time in
 148 .IR remain .
 149 This value can then be used to call
 150 .BR clock_nanosleep ()
 151 again and complete a (relative) sleep.
 152 .SH RETURN VALUE
 153 On successfully sleeping for the requested interval,
 154 .BR clock_nanosleep ()
 155 returns 0.
 156 If the call is interrupted by a signal handler or encounters an error,
 157 then it returns one of the positive error number listed in ERRORS.
 158 .SH ERRORS
 159 .TP
 160 .B EFAULT
 161 .I request
 162 or
 163 .I remain
 164 specified an invalid address.
 165 .TP
 166 .B EINTR
 167 The sleep was interrupted by a signal handler.
 168 .TP
 169 .B EINVAL
 170 The value in the
 171 .I tv_nsec
 172 field was not in the range 0 to 999999999 or
 173 .I tv_sec
 174 was negative.
 175 .TP
 176 .B EINVAL
 177 .I clock_id
 178 was invalid.
 179 .RB ( CLOCK_THREAD_CPUTIME_ID
 180 is not a permitted value for
 181 .IR clock_id .)
 182 .SH VERSIONS
 183 The
 184 .BR clock_nanosleep ()
 185 system call first appeared in Linux 2.6.
 186 Support is available in glibc since version 2.1.
 187 .SH CONFORMING TO
 188 POSIX.1-2001.
 189 .SH NOTES
 190 If the interval specified in
 191 .I request
 192 is not an exact multiple of the granularity underlying clock (see
 193 .BR time (7)),
 194 then the interval will be rounded up to the next multiple.
 195 Furthermore, after the sleep completes, there may still be a delay before
 196 the CPU becomes free to once again execute the calling thread.
 197
 198 Using an absolute timer is useful for preventing
 199 timer drift problems of the type described in
 200 .BR nanosleep (2).
 201 (Such problems are exacerbated in programs that try to restart
 202 a relative sleep that is repeatedly interrupted by signals.)
 203 To perform a relative sleep that avoids these problems, call
 204 .BR clock_gettime (2)
 205 for the desired clock,
 206 add the desired interval to the returned time value,
 207 and then call
 208 .BR clock_nanosleep ()
 209 with the
 210 .B TIMER_ABSTIME
 211 flag.
 212
 213 .BR clock_nanosleep ()
 214 is never restarted after being interrupted by a signal handler,
 215 regardless of the use of the
 216 .BR sigaction (2)
 217 .B SA_RESTART
 218 flag.
 219
 220 The
 221 .I remain
 222 argument is unused, and unnecessary, when
 223 .I flags
 224 is
 225 .BR TIMER_ABSTIME .
 226 (An absolute sleep can be restarted using the same
 227 .I request
 228 argument.)
 229
 230 POSIX.1 specifies that
 231 .BR clock_nanosleep ()
 232 has no effect on signals dispositions or the signal mask.
 233
 234 POSIX.1 specifies that after changing the value of the
 235 .B CLOCK_REALTIME
 236 clock via
 237 .BR clock_settime (2),
 238 the new clock value shall be used to determine the time
 239 at which a thread blocked on an absolute
 240 .BR clock_nanosleep ()
 241 will wake up;
 242 if the new clock value falls past the end of the sleep interval, then the
 243 .BR clock_nanosleep ()
 244 call will return immediately.
 245
 246 POSIX.1 specifies that
 247 changing the value of the
 248 .B CLOCK_REALTIME
 249 clock via
 250 .BR clock_settime (2)
 251 shall have no effect on a thread that is blocked on a relative
 252 .BR clock_nanosleep ().
 253 .SH SEE ALSO
 254 .BR clock_getres (2),
 255 .BR nanosleep (2),
 256 .BR restart_syscall (2),
 257 .BR timer_create (2),
 258 .BR sleep (3),
 259 .BR usleep (3),
 260 .BR time (7)
 261 .SH COLOPHON
 262 This page is part of release 3.79 of the Linux
 263 .I man-pages
 264 project.
 265 A description of the project,
 266 information about reporting bugs,
 267 and the latest version of this page,
 268 can be found at
 269 \%http://www.kernel.org/doc/man\-pages/.