afs: Always define our own osi_timeval32_t
[openafs.git] / src / rx / rx_clock.h
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  *
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 /* Elapsed time package */
11 /* This package maintains a clock which is independent of the time of day.  It uses the 4.3BSD interval timer (getitimer/setitimer) in TIMER_REAL mode.  Any other use of the timer voids this package's warranty. */
12
13 #ifndef _CLOCK_
14 #define _CLOCK_
15
16 #ifdef  KERNEL
17 #if defined(AFS_AIX_ENV) || defined(AFS_AUX_ENV) || defined(AFS_SUN5_ENV)
18 #include "h/systm.h"
19 #include "h/time.h"
20 #endif /* System V */
21 #else /* KERNEL */
22 #ifndef AFS_NT40_ENV
23 #ifndef ITIMER_REAL
24 #include <sys/time.h>
25 #endif /* ITIMER_REAL */
26 #else
27 #include <time.h>
28 #include <afs/afsutil.h>
29 #endif
30 #endif /* KERNEL */
31
32 /* Some macros to make macros more reasonable (this allows a block to be used within a macro which does not cause if statements to screw up).   That is, you can use "if (...) macro_name(); else ...;" without having things blow up on the semi-colon. */
33
34 #ifndef BEGIN
35 #define BEGIN do {
36 #define END } while(0)
37 #endif
38
39 /* A clock value is the number of seconds and microseconds that have elapsed since calling clock_Init. */
40 struct clock {
41     afs_int32 sec;              /* Seconds since clock_Init */
42     afs_int32 usec;             /* Microseconds since clock_Init */
43 };
44
45 #if defined(KERNEL)
46 #include "afs/afs_osi.h"
47 #endif
48 #if !defined(KERNEL) || defined(UKERNEL)
49 #if defined(AFS_USE_GETTIMEOFDAY) || defined(AFS_PTHREAD_ENV) || defined(UKERNEL)
50 #define clock_Init()
51 #define clock_NewTime()
52 #define clock_UpdateTime()
53 #define clock_Sec() (time(NULL))
54 #define clock_haveCurrentTime 1
55
56 #define        clock_GetTime(cv)                               \
57     BEGIN                                              \
58        struct timeval tv;                              \
59        gettimeofday(&tv, NULL);                        \
60        (cv)->sec = (afs_int32)tv.tv_sec;               \
61        (cv)->usec = (afs_int32)tv.tv_usec;             \
62     END
63
64 #else /* AFS_USE_GETTIMEOFDAY || AFS_PTHREAD_ENV */
65
66 /* For internal use.  The last value returned from clock_GetTime() */
67 extern struct clock clock_now;
68
69 /* For internal use:  this flag, if set, indicates a new time should be read by clock_getTime() */
70 extern int clock_haveCurrentTime;
71
72 /* For external use: the number of times the clock value is actually updated */
73 extern int clock_nUpdates;
74
75 /* Initialize the clock package */
76
77 #define clock_NewTime() (clock_haveCurrentTime = 0)
78
79 /* Return the current clock time.  If the clock value has not been updated since the last call to clock_NewTime, it is updated now */
80 #define        clock_GetTime(cv)                               \
81     BEGIN                                              \
82        if (!clock_haveCurrentTime) clock_UpdateTime(); \
83        (cv)->sec = clock_now.sec;                      \
84        (cv)->usec = clock_now.usec;                    \
85     END
86
87 /* Current clock time, truncated to seconds */
88 #define clock_Sec() ((!clock_haveCurrentTime)? clock_UpdateTime(), clock_now.sec:clock_now.sec)
89
90 extern void clock_Init(void);
91 extern int clock_UnInit(void);
92 extern void clock_UpdateTime(void);
93
94 #endif /* AFS_USE_GETTIMEOFDAY || AFS_PTHREAD_ENV */
95 #else /* KERNEL */
96 #define clock_Init()
97 static_inline void
98 clock_GetTime(struct clock *cv)
99 {
100     osi_timeval32_t now;
101     osi_GetTime(&now);
102     cv->sec = now.tv_sec;
103     cv->usec = now.tv_usec;
104 }
105 #define clock_Sec() osi_Time()
106 #define clock_NewTime()         /* don't do anything; clock is fast enough in kernel */
107 #endif /* KERNEL */
108
109 /* Returns the elapsed time in milliseconds between clock values (*cv1) and (*cv2) */
110 #define clock_ElapsedTime(cv1, cv2) \
111     (((cv2)->sec - (cv1)->sec)*1000 + ((cv2)->usec - (cv1)->usec)/1000)
112
113 /* Some comparison operators for clock values */
114 #define clock_Gt(a, b)  ((a)->sec>(b)->sec || ((a)->sec==(b)->sec && (a)->usec>(b)->usec))
115 #define clock_Ge(a, b)  ((a)->sec>(b)->sec || ((a)->sec==(b)->sec && (a)->usec>=(b)->usec))
116 #define clock_Eq(a, b)  ((a)->sec==(b)->sec && (a)->usec==(b)->usec)
117 #define clock_Le(a, b)  ((a)->sec<(b)->sec || ((a)->sec==(b)->sec && (a)->usec<=(b)->usec))
118 #define clock_Lt(a, b)  ((a)->sec<(b)->sec || ((a)->sec==(b)->sec && (a)->usec<(b)->usec))
119
120 /* Is the clock value zero? */
121 #define clock_IsZero(c) ((c)->sec == 0 && (c)->usec == 0)
122
123 /* Set the clock value to zero */
124 #define clock_Zero(c)   ((c)->sec = (c)->usec = 0)
125
126 /* Add time c2 to time c1.  Both c2 and c1 must be positive times. */
127 #define clock_Add(c1, c2)                                       \
128     BEGIN                                                       \
129         (c1)->sec += (c2)->sec;                                 \
130         if (((c1)->usec += (c2)->usec) >= 1000000) {            \
131             (c1)->usec -= 1000000;                              \
132             (c1)->sec++;                                        \
133         }                                                       \
134     END
135
136 #define USEC(cp)        (((cp)->sec * 1000000) + (cp)->usec)
137 #define MSEC(cp)        (((cp)->sec * 1000) + ((cp)->usec / 1000))
138 #define _4THMSEC(cp)    (((cp)->sec * 4000) + ((cp)->usec / 250))
139 #define _8THMSEC(cp)    (((cp)->sec * 8000) + ((cp)->usec / 125))
140
141 /* Add ms milliseconds to time c1.  Both ms and c1 must be positive */
142 #define clock_Addmsec(c1, ms)                                    \
143     BEGIN                                                        \
144         if ((ms) >= 1000) {                                      \
145             (c1)->sec += (afs_int32)((ms) / 1000);                       \
146             (c1)->usec += (afs_int32)(((ms) % 1000) * 1000);     \
147         } else {                                                 \
148             (c1)->usec += (afs_int32)((ms) * 1000);                      \
149         }                                                        \
150         if ((c1)->usec >= 1000000) {                             \
151             (c1)->usec -= 1000000;                               \
152             (c1)->sec++;                                         \
153         }                                                        \
154     END
155
156 /* Subtract time c2 from time c1.  c2 should be less than c1 */
157 #define clock_Sub(c1, c2)                                       \
158     BEGIN                                                       \
159         if (((c1)->usec -= (c2)->usec) < 0) {                   \
160             (c1)->usec += 1000000;                              \
161             (c1)->sec--;                                        \
162         }                                                       \
163         (c1)->sec -= (c2)->sec;                                 \
164     END
165
166 #define clock_Float(c) ((c)->sec + (c)->usec/1e6)
167
168 /* Add square of time c2 to time c1.  Both c2 and c1 must be positive times. */
169 #define clock_AddSq(c1, c2)                                                   \
170     BEGIN                                                                     \
171    if((c2)->sec > 0 )                                                         \
172      {                                                                        \
173        (c1)->sec += (c2)->sec * (c2)->sec                                     \
174                     +  2 * (c2)->sec * (c2)->usec /1000000;                   \
175        (c1)->usec += (2 * (c2)->sec * (c2)->usec) % 1000000                   \
176                      + ((c2)->usec / 1000)*((c2)->usec / 1000)                \
177                      + 2 * ((c2)->usec / 1000) * ((c2)->usec % 1000) / 1000   \
178                      + ((((c2)->usec % 1000) > 707) ? 1 : 0);                 \
179      }                                                                        \
180    else                                                                       \
181      {                                                                        \
182        (c1)->usec += ((c2)->usec / 1000)*((c2)->usec / 1000)                  \
183                      + 2 * ((c2)->usec / 1000) * ((c2)->usec % 1000) / 1000   \
184                      + ((((c2)->usec % 1000) > 707) ? 1 : 0);                 \
185      }                                                                        \
186    if ((c1)->usec > 1000000) {                                                \
187         (c1)->usec -= 1000000;                                                \
188         (c1)->sec++;                                                          \
189    }                                                                          \
190     END
191
192 #endif /* _CLOCK_ */