update from main archive 961016
[kopensolaris-gnu/glibc.git] / time / sys / time.h
1 /* Copyright (C) 1991, 92, 93, 94, 96 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
8
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB.  If
16 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
17 Cambridge, MA 02139, USA.  */
18
19 #ifndef _SYS_TIME_H
20
21 #define _SYS_TIME_H     1
22 #include <features.h>
23
24 #include <time.h>
25
26 __BEGIN_DECLS
27
28 /* A time value that is accurate to the nearest
29    microsecond but also has a range of years.  */
30 struct timeval
31   {
32     int tv_sec;                 /* Seconds.  */
33     int tv_usec;                /* Microseconds.  */
34   };
35
36 /* Macros for converting between `struct timeval' and `struct timespec'.  */
37 #define TIMEVAL_TO_TIMESPEC(tv, ts) {                                   \
38         (ts)->tv_sec = (tv)->tv_sec;                                    \
39         (ts)->tv_nsec = (tv)->tv_usec * 1000;                           \
40 }
41 #define TIMESPEC_TO_TIMEVAL(tv, ts) {                                   \
42         (tv)->tv_sec = (ts)->tv_sec;                                    \
43         (tv)->tv_usec = (ts)->tv_nsec / 1000;                           \
44 }
45
46
47 /* Structure crudely representing a timezone.
48    This is obsolete and should never be used.  */
49 struct timezone
50   {
51     int tz_minuteswest;         /* Minutes west of GMT.  */
52     int tz_dsttime;             /* Nonzero if DST is ever in effect.  */
53   };
54
55 /* Get the current time of day and timezone information,
56    putting it into *TV and *TZ.  If TZ is NULL, *TZ is not filled.
57    Returns 0 on success, -1 on errors.
58    NOTE: This form of timezone information is obsolete.
59    Use the functions and variables declared in <time.h> instead.  */
60 extern int __gettimeofday __P ((struct timeval *__tv,
61                                 struct timezone *__tz));
62 extern int gettimeofday __P ((struct timeval *__tv,
63                               struct timezone *__tz));
64
65 /* Set the current time of day and timezone information.
66    This call is restricted to the super-user.  */
67 extern int __settimeofday __P ((__const struct timeval *__tv,
68                                 __const struct timezone *__tz));
69 extern int settimeofday __P ((__const struct timeval *__tv,
70                               __const struct timezone *__tz));
71
72 /* Adjust the current time of day by the amount in DELTA.
73    If OLDDELTA is not NULL, it is filled in with the amount
74    of time adjustment remaining to be done from the last `adjtime' call.
75    This call is restricted to the super-user.  */
76 extern int __adjtime __P ((__const struct timeval *__delta,
77                            struct timeval *__olddelta));
78 extern int adjtime __P ((__const struct timeval *__delta,
79                          struct timeval *__olddelta));
80
81
82 /* Values for the first argument to `getitimer' and `setitimer'.  */
83 enum __itimer_which
84   {
85     /* Timers run in real time.  */
86     ITIMER_REAL = 0,
87     /* Timers run only when the process is executing.  */
88     ITIMER_VIRTUAL = 1,
89     /* Timers run when the process is executing and when
90        the system is executing on behalf of the process.  */
91     ITIMER_PROF = 2
92   };
93
94 /* Type of the second argument to `getitimer' and
95    the second and third arguments `setitimer'.  */
96 struct itimerval
97   {
98     /* Value to put into `it_value' when the timer expires.  */
99     struct timeval it_interval;
100     /* Time to the next timer expiration.  */
101     struct timeval it_value;
102   };
103
104 /* Set *VALUE to the current setting of timer WHICH.
105    Return 0 on success, -1 on errors.  */
106 extern int __getitimer __P ((enum __itimer_which __which,
107                              struct itimerval *__value));
108 extern int getitimer __P ((enum __itimer_which __which,
109                            struct itimerval *__value));
110
111 /* Set the timer WHICH to *NEW.  If OLD is not NULL,
112    set *OLD to the old value of timer WHICH.
113    Returns 0 on success, -1 on errors.  */
114 extern int __setitimer __P ((enum __itimer_which __which,
115                              struct itimerval *__new,
116                              struct itimerval *__old));
117 extern int setitimer __P ((enum __itimer_which __which,
118                            struct itimerval *__new,
119                            struct itimerval *__old));
120
121 /* Change the access time of FILE to TVP[0] and
122    the modification time of FILE to TVP[1].  */
123 extern int __utimes __P ((__const char *__file, struct timeval __tvp[2]));
124 extern int utimes __P ((__const char *__file, struct timeval __tvp[2]));
125
126
127 /* Convenience macros for operations on timevals.
128    NOTE: `timercmp' does not work for >= or <=.  */
129 #define timerisset(tvp)         ((tvp)->tv_sec || (tvp)->tv_usec)
130 #define timerclear(tvp)         ((tvp)->tv_sec = (tvp)->tv_usec = 0)
131 #define timercmp(a, b, CMP)                                                   \
132   (((a)->tv_sec == (b)->tv_sec) ?                                             \
133    ((a)->tv_usec CMP (b)->tv_usec) :                                          \
134    ((a)->tv_sec CMP (b)->tv_sec))
135 #define timeradd(a, b, result)                                                \
136   do {                                                                        \
137     (result)->tv_sec = (a)->tv_sec + (b)->tv_sec;                             \
138     (result)->tv_usec = (a)->tv_usec + (b)->tv_usec;                          \
139     if ((result)->tv_usec >= 1000000)                                         \
140       {                                                                       \
141         ++(result)->tv_sec;                                                   \
142         (result)->tv_usec -= 1000000;                                         \
143       }                                                                       \
144   } while (0)
145 #define timersub(a, b, result)                                                \
146   do {                                                                        \
147     (result)->tv_sec = (a)->tv_sec - (b)->tv_sec;                             \
148     (result)->tv_usec = (a)->tv_usec - (b)->tv_usec;                          \
149     if ((result)->tv_usec < 0) {                                              \
150       --(result)->tv_sec;                                                     \
151       (result)->tv_usec += 1000000;                                           \
152     }                                                                         \
153   } while (0)
154
155
156 __END_DECLS
157
158 #ifdef __USE_BSD
159 /* Set an alarm to go off (generating a SIGALRM signal) in VALUE
160    microseconds.  If INTERVAL is nonzero, when the alarm goes off, the
161    timer is reset to go off every INTERVAL microseconds thereafter.
162    Returns the number of microseconds remaining before the alarm.  */
163 extern unsigned int ualarm __P ((unsigned int __value,
164                                  unsigned int __interval));
165 #endif
166
167 #endif /* sys/time.h */