time.h 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. /* Copyright (C) 1991-2021 Free Software Foundation, Inc.
  2. This file is part of the GNU C Library.
  3. The GNU C Library is free software; you can redistribute it and/or
  4. modify it under the terms of the GNU Lesser General Public
  5. License as published by the Free Software Foundation; either
  6. version 2.1 of the License, or (at your option) any later version.
  7. The GNU C Library is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  10. Lesser General Public License for more details.
  11. You should have received a copy of the GNU Lesser General Public
  12. License along with the GNU C Library; if not, see
  13. <https://www.gnu.org/licenses/>. */
  14. #ifndef _SYS_TIME_H
  15. #define _SYS_TIME_H 1
  16. #include <features.h>
  17. #include <bits/types.h>
  18. #include <bits/types/time_t.h>
  19. #include <bits/types/struct_timeval.h>
  20. #ifndef __suseconds_t_defined
  21. typedef __suseconds_t suseconds_t;
  22. # define __suseconds_t_defined
  23. #endif
  24. #include <sys/select.h>
  25. __BEGIN_DECLS
  26. #ifdef __USE_GNU
  27. /* Macros for converting between `struct timeval' and `struct timespec'. */
  28. # define TIMEVAL_TO_TIMESPEC(tv, ts) { \
  29. (ts)->tv_sec = (tv)->tv_sec; \
  30. (ts)->tv_nsec = (tv)->tv_usec * 1000; \
  31. }
  32. # define TIMESPEC_TO_TIMEVAL(tv, ts) { \
  33. (tv)->tv_sec = (ts)->tv_sec; \
  34. (tv)->tv_usec = (ts)->tv_nsec / 1000; \
  35. }
  36. #endif
  37. #ifdef __USE_MISC
  38. /* Structure crudely representing a timezone.
  39. This is obsolete and should never be used. */
  40. struct timezone
  41. {
  42. int tz_minuteswest; /* Minutes west of GMT. */
  43. int tz_dsttime; /* Nonzero if DST is ever in effect. */
  44. };
  45. #endif
  46. /* Get the current time of day, putting it into *TV.
  47. If TZ is not null, *TZ must be a struct timezone, and both fields
  48. will be set to zero.
  49. Calling this function with a non-null TZ is obsolete;
  50. use localtime etc. instead.
  51. This function itself is semi-obsolete;
  52. most callers should use time or clock_gettime instead. */
  53. extern int gettimeofday (struct timeval *__restrict __tv,
  54. void *__restrict __tz) __THROW __nonnull ((1));
  55. #ifdef __USE_MISC
  56. /* Set the current time of day and timezone information.
  57. This call is restricted to the super-user.
  58. Setting the timezone in this way is obsolete, but we don't yet
  59. warn about it because it still has some uses for which there is
  60. no alternative. */
  61. extern int settimeofday (const struct timeval *__tv,
  62. const struct timezone *__tz)
  63. __THROW;
  64. /* Adjust the current time of day by the amount in DELTA.
  65. If OLDDELTA is not NULL, it is filled in with the amount
  66. of time adjustment remaining to be done from the last `adjtime' call.
  67. This call is restricted to the super-user. */
  68. extern int adjtime (const struct timeval *__delta,
  69. struct timeval *__olddelta) __THROW;
  70. #endif
  71. /* Values for the first argument to `getitimer' and `setitimer'. */
  72. enum __itimer_which
  73. {
  74. /* Timers run in real time. */
  75. ITIMER_REAL = 0,
  76. #define ITIMER_REAL ITIMER_REAL
  77. /* Timers run only when the process is executing. */
  78. ITIMER_VIRTUAL = 1,
  79. #define ITIMER_VIRTUAL ITIMER_VIRTUAL
  80. /* Timers run when the process is executing and when
  81. the system is executing on behalf of the process. */
  82. ITIMER_PROF = 2
  83. #define ITIMER_PROF ITIMER_PROF
  84. };
  85. /* Type of the second argument to `getitimer' and
  86. the second and third arguments `setitimer'. */
  87. struct itimerval
  88. {
  89. /* Value to put into `it_value' when the timer expires. */
  90. struct timeval it_interval;
  91. /* Time to the next timer expiration. */
  92. struct timeval it_value;
  93. };
  94. #if defined __USE_GNU && !defined __cplusplus
  95. /* Use the nicer parameter type only in GNU mode and not for C++ since the
  96. strict C++ rules prevent the automatic promotion. */
  97. typedef enum __itimer_which __itimer_which_t;
  98. #else
  99. typedef int __itimer_which_t;
  100. #endif
  101. /* Set *VALUE to the current setting of timer WHICH.
  102. Return 0 on success, -1 on errors. */
  103. extern int getitimer (__itimer_which_t __which,
  104. struct itimerval *__value) __THROW;
  105. /* Set the timer WHICH to *NEW. If OLD is not NULL,
  106. set *OLD to the old value of timer WHICH.
  107. Returns 0 on success, -1 on errors. */
  108. extern int setitimer (__itimer_which_t __which,
  109. const struct itimerval *__restrict __new,
  110. struct itimerval *__restrict __old) __THROW;
  111. /* Change the access time of FILE to TVP[0] and the modification time of
  112. FILE to TVP[1]. If TVP is a null pointer, use the current time instead.
  113. Returns 0 on success, -1 on errors. */
  114. extern int utimes (const char *__file, const struct timeval __tvp[2])
  115. __THROW __nonnull ((1));
  116. #ifdef __USE_MISC
  117. /* Same as `utimes', but does not follow symbolic links. */
  118. extern int lutimes (const char *__file, const struct timeval __tvp[2])
  119. __THROW __nonnull ((1));
  120. /* Same as `utimes', but takes an open file descriptor instead of a name. */
  121. extern int futimes (int __fd, const struct timeval __tvp[2]) __THROW;
  122. #endif
  123. #ifdef __USE_GNU
  124. /* Change the access time of FILE relative to FD to TVP[0] and the
  125. modification time of FILE to TVP[1]. If TVP is a null pointer, use
  126. the current time instead. Returns 0 on success, -1 on errors. */
  127. extern int futimesat (int __fd, const char *__file,
  128. const struct timeval __tvp[2]) __THROW;
  129. #endif
  130. #ifdef __USE_MISC
  131. /* Convenience macros for operations on timevals.
  132. NOTE: `timercmp' does not work for >= or <=. */
  133. # define timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
  134. # define timerclear(tvp) ((tvp)->tv_sec = (tvp)->tv_usec = 0)
  135. # define timercmp(a, b, CMP) \
  136. (((a)->tv_sec == (b)->tv_sec) \
  137. ? ((a)->tv_usec CMP (b)->tv_usec) \
  138. : ((a)->tv_sec CMP (b)->tv_sec))
  139. # define timeradd(a, b, result) \
  140. do { \
  141. (result)->tv_sec = (a)->tv_sec + (b)->tv_sec; \
  142. (result)->tv_usec = (a)->tv_usec + (b)->tv_usec; \
  143. if ((result)->tv_usec >= 1000000) \
  144. { \
  145. ++(result)->tv_sec; \
  146. (result)->tv_usec -= 1000000; \
  147. } \
  148. } while (0)
  149. # define timersub(a, b, result) \
  150. do { \
  151. (result)->tv_sec = (a)->tv_sec - (b)->tv_sec; \
  152. (result)->tv_usec = (a)->tv_usec - (b)->tv_usec; \
  153. if ((result)->tv_usec < 0) { \
  154. --(result)->tv_sec; \
  155. (result)->tv_usec += 1000000; \
  156. } \
  157. } while (0)
  158. #endif /* Misc. */
  159. __END_DECLS
  160. #endif /* sys/time.h */