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 #endif /* AFS_USE_GETTIMEOFDAY || AFS_PTHREAD_ENV */
  90 #else /* KERNEL */
  91 #define clock_Init()
  92 #if defined(AFS_SGI61_ENV) || defined(AFS_HPUX_ENV) || defined(AFS_LINUX_64BIT_KERNEL)
  93 #define clock_GetTime(cv) osi_GetTime((osi_timeval_t *)cv)
  94 #else
  95 #if (defined(AFS_AIX51_ENV) && defined(AFS_64BIT_KERNEL)) || (defined(AFS_DARWIN100_ENV) && defined(__amd64__)) || defined(AFS_NBSD_ENV)
  96 #define        clock_GetTime(cv)                               \
  97     BEGIN                                              \
  98        struct timeval tv;                              \
  99        osi_GetTime(&tv);                        \
 100        (cv)->sec = (afs_int32)tv.tv_sec;               \
 101        (cv)->usec = (afs_int32)tv.tv_usec;             \
 102     END
 103 #else /* defined(AFS_AIX51_ENV) && defined(AFS_64BIT_KERNEL) */
 104 #define clock_GetTime(cv) osi_GetTime((osi_timeval_t *)(cv))
 105 #endif /* defined(AFS_AIX51_ENV) && defined(AFS_64BIT_KERNEL) */
 106 #endif
 107 #define clock_Sec() osi_Time()
 108 #define clock_NewTime()         /* don't do anything; clock is fast enough in kernel */
 109 #endif /* KERNEL */
 110
 111 /* Returns the elapsed time in milliseconds between clock values (*cv1) and (*cv2) */
 112 #define clock_ElapsedTime(cv1, cv2) \
 113     (((cv2)->sec - (cv1)->sec)*1000 + ((cv2)->usec - (cv1)->usec)/1000)
 114
 115 /* Some comparison operators for clock values */
 116 #define clock_Gt(a, b)  ((a)->sec>(b)->sec || ((a)->sec==(b)->sec && (a)->usec>(b)->usec))
 117 #define clock_Ge(a, b)  ((a)->sec>(b)->sec || ((a)->sec==(b)->sec && (a)->usec>=(b)->usec))
 118 #define clock_Eq(a, b)  ((a)->sec==(b)->sec && (a)->usec==(b)->usec)
 119 #define clock_Le(a, b)  ((a)->sec<(b)->sec || ((a)->sec==(b)->sec && (a)->usec<=(b)->usec))
 120 #define clock_Lt(a, b)  ((a)->sec<(b)->sec || ((a)->sec==(b)->sec && (a)->usec<(b)->usec))
 121
 122 /* Is the clock value zero? */
 123 #define clock_IsZero(c) ((c)->sec == 0 && (c)->usec == 0)
 124
 125 /* Set the clock value to zero */
 126 #define clock_Zero(c)   ((c)->sec = (c)->usec = 0)
 127
 128 /* Add time c2 to time c1.  Both c2 and c1 must be positive times. */
 129 #define clock_Add(c1, c2)                                       \
 130     BEGIN                                                       \
 131         (c1)->sec += (c2)->sec;                                 \
 132         if (((c1)->usec += (c2)->usec) >= 1000000) {            \
 133             (c1)->usec -= 1000000;                              \
 134             (c1)->sec++;                                        \
 135         }                                                       \
 136     END
 137
 138 #define USEC(cp)        (((cp)->sec * 1000000) + (cp)->usec)
 139 #define MSEC(cp)        (((cp)->sec * 1000) + ((cp)->usec / 1000))
 140 #define _4THMSEC(cp)    (((cp)->sec * 4000) + ((cp)->usec / 250))
 141 #define _8THMSEC(cp)    (((cp)->sec * 8000) + ((cp)->usec / 125))
 142
 143 /* Add ms milliseconds to time c1.  Both ms and c1 must be positive */
 144 #define clock_Addmsec(c1, ms)                                    \
 145     BEGIN                                                        \
 146         if ((ms) >= 1000) {                                      \
 147             (c1)->sec += (afs_int32)((ms) / 1000);                       \
 148             (c1)->usec += (afs_int32)(((ms) % 1000) * 1000);     \
 149         } else {                                                 \
 150             (c1)->usec += (afs_int32)((ms) * 1000);                      \
 151         }                                                        \
 152         if ((c1)->usec >= 1000000) {                             \
 153             (c1)->usec -= 1000000;                               \
 154             (c1)->sec++;                                         \
 155         }                                                        \
 156     END
 157
 158 /* Subtract time c2 from time c1.  c2 should be less than c1 */
 159 #define clock_Sub(c1, c2)                                       \
 160     BEGIN                                                       \
 161         if (((c1)->usec -= (c2)->usec) < 0) {                   \
 162             (c1)->usec += 1000000;                              \
 163             (c1)->sec--;                                        \
 164         }                                                       \
 165         (c1)->sec -= (c2)->sec;                                 \
 166     END
 167
 168 #define clock_Float(c) ((c)->sec + (c)->usec/1e6)
 169
 170 /* Add square of time c2 to time c1.  Both c2 and c1 must be positive times. */
 171 #define clock_AddSq(c1, c2)                                                   \
 172     BEGIN                                                                     \
 173    if((c2)->sec > 0 )                                                         \
 174      {                                                                        \
 175        (c1)->sec += (c2)->sec * (c2)->sec                                     \
 176                     +  2 * (c2)->sec * (c2)->usec /1000000;                   \
 177        (c1)->usec += (2 * (c2)->sec * (c2)->usec) % 1000000                   \
 178                      + ((c2)->usec / 1000)*((c2)->usec / 1000)                \
 179                      + 2 * ((c2)->usec / 1000) * ((c2)->usec % 1000) / 1000   \
 180                      + ((((c2)->usec % 1000) > 707) ? 1 : 0);                 \
 181      }                                                                        \
 182    else                                                                       \
 183      {                                                                        \
 184        (c1)->usec += ((c2)->usec / 1000)*((c2)->usec / 1000)                  \
 185                      + 2 * ((c2)->usec / 1000) * ((c2)->usec % 1000) / 1000   \
 186                      + ((((c2)->usec % 1000) > 707) ? 1 : 0);                 \
 187      }                                                                        \
 188    if ((c1)->usec > 1000000) {                                                \
 189         (c1)->usec -= 1000000;                                                \
 190         (c1)->sec++;                                                          \
 191    }                                                                          \
 192     END
 193
 194 #endif /* _CLOCK_ */