Pileus Git - ~andy/linux/blob - include/linux/jiffies.h

   1 #ifndef _LINUX_JIFFIES_H
   2 #define _LINUX_JIFFIES_H
   3
   4 #include <linux/math64.h>
   5 #include <linux/kernel.h>
   6 #include <linux/types.h>
   7 #include <linux/time.h>
   8 #include <linux/timex.h>
   9 #include <asm/param.h>                  /* for HZ */
  10
  11 /*
  12  * The following defines establish the engineering parameters of the PLL
  13  * model. The HZ variable establishes the timer interrupt frequency, 100 Hz
  14  * for the SunOS kernel, 256 Hz for the Ultrix kernel and 1024 Hz for the
  15  * OSF/1 kernel. The SHIFT_HZ define expresses the same value as the
  16  * nearest power of two in order to avoid hardware multiply operations.
  17  */
  18 #if HZ >= 12 && HZ < 24
  19 # define SHIFT_HZ       4
  20 #elif HZ >= 24 && HZ < 48
  21 # define SHIFT_HZ       5
  22 #elif HZ >= 48 && HZ < 96
  23 # define SHIFT_HZ       6
  24 #elif HZ >= 96 && HZ < 192
  25 # define SHIFT_HZ       7
  26 #elif HZ >= 192 && HZ < 384
  27 # define SHIFT_HZ       8
  28 #elif HZ >= 384 && HZ < 768
  29 # define SHIFT_HZ       9
  30 #elif HZ >= 768 && HZ < 1536
  31 # define SHIFT_HZ       10
  32 #elif HZ >= 1536 && HZ < 3072
  33 # define SHIFT_HZ       11
  34 #elif HZ >= 3072 && HZ < 6144
  35 # define SHIFT_HZ       12
  36 #elif HZ >= 6144 && HZ < 12288
  37 # define SHIFT_HZ       13
  38 #else
  39 # error Invalid value of HZ.
  40 #endif
  41
  42 /* Suppose we want to divide two numbers NOM and DEN: NOM/DEN, then we can
  43  * improve accuracy by shifting LSH bits, hence calculating:
  44  *     (NOM << LSH) / DEN
  45  * This however means trouble for large NOM, because (NOM << LSH) may no
  46  * longer fit in 32 bits. The following way of calculating this gives us
  47  * some slack, under the following conditions:
  48  *   - (NOM / DEN) fits in (32 - LSH) bits.
  49  *   - (NOM % DEN) fits in (32 - LSH) bits.
  50  */
  51 #define SH_DIV(NOM,DEN,LSH) (   (((NOM) / (DEN)) << (LSH))              \
  52                              + ((((NOM) % (DEN)) << (LSH)) + (DEN) / 2) / (DEN))
  53
  54 extern int register_refined_jiffies(long clock_tick_rate);
  55
  56 /* TICK_NSEC is the time between ticks in nsec assuming SHIFTED_HZ */
  57 #define TICK_NSEC ((NSEC_PER_SEC+HZ/2)/HZ)
  58
  59 /* TICK_USEC is the time between ticks in usec assuming fake USER_HZ */
  60 #define TICK_USEC ((1000000UL + USER_HZ/2) / USER_HZ)
  61
  62 /* some arch's have a small-data section that can be accessed register-relative
  63  * but that can only take up to, say, 4-byte variables. jiffies being part of
  64  * an 8-byte variable may not be correctly accessed unless we force the issue
  65  */
  66 #define __jiffy_data  __attribute__((section(".data")))
  67
  68 /*
  69  * The 64-bit value is not atomic - you MUST NOT read it
  70  * without sampling the sequence number in xtime_lock.
  71  * get_jiffies_64() will do this for you as appropriate.
  72  */
  73 extern u64 __jiffy_data jiffies_64;
  74 extern unsigned long volatile __jiffy_data jiffies;
  75
  76 #if (BITS_PER_LONG < 64)
  77 u64 get_jiffies_64(void);
  78 #else
  79 static inline u64 get_jiffies_64(void)
  80 {
  81         return (u64)jiffies;
  82 }
  83 #endif
  84
  85 /*
  86  *      These inlines deal with timer wrapping correctly. You are
  87  *      strongly encouraged to use them
  88  *      1. Because people otherwise forget
  89  *      2. Because if the timer wrap changes in future you won't have to
  90  *         alter your driver code.
  91  *
  92  * time_after(a,b) returns true if the time a is after time b.
  93  *
  94  * Do this with "<0" and ">=0" to only test the sign of the result. A
  95  * good compiler would generate better code (and a really good compiler
  96  * wouldn't care). Gcc is currently neither.
  97  */
  98 #define time_after(a,b)         \
  99         (typecheck(unsigned long, a) && \
 100          typecheck(unsigned long, b) && \
 101          ((long)(b) - (long)(a) < 0))
 102 #define time_before(a,b)        time_after(b,a)
 103
 104 #define time_after_eq(a,b)      \
 105         (typecheck(unsigned long, a) && \
 106          typecheck(unsigned long, b) && \
 107          ((long)(a) - (long)(b) >= 0))
 108 #define time_before_eq(a,b)     time_after_eq(b,a)
 109
 110 /*
 111  * Calculate whether a is in the range of [b, c].
 112  */
 113 #define time_in_range(a,b,c) \
 114         (time_after_eq(a,b) && \
 115          time_before_eq(a,c))
 116
 117 /*
 118  * Calculate whether a is in the range of [b, c).
 119  */
 120 #define time_in_range_open(a,b,c) \
 121         (time_after_eq(a,b) && \
 122          time_before(a,c))
 123
 124 /* Same as above, but does so with platform independent 64bit types.
 125  * These must be used when utilizing jiffies_64 (i.e. return value of
 126  * get_jiffies_64() */
 127 #define time_after64(a,b)       \
 128         (typecheck(__u64, a) && \
 129          typecheck(__u64, b) && \
 130          ((__s64)(b) - (__s64)(a) < 0))
 131 #define time_before64(a,b)      time_after64(b,a)
 132
 133 #define time_after_eq64(a,b)    \
 134         (typecheck(__u64, a) && \
 135          typecheck(__u64, b) && \
 136          ((__s64)(a) - (__s64)(b) >= 0))
 137 #define time_before_eq64(a,b)   time_after_eq64(b,a)
 138
 139 /*
 140  * These four macros compare jiffies and 'a' for convenience.
 141  */
 142
 143 /* time_is_before_jiffies(a) return true if a is before jiffies */
 144 #define time_is_before_jiffies(a) time_after(jiffies, a)
 145
 146 /* time_is_after_jiffies(a) return true if a is after jiffies */
 147 #define time_is_after_jiffies(a) time_before(jiffies, a)
 148
 149 /* time_is_before_eq_jiffies(a) return true if a is before or equal to jiffies*/
 150 #define time_is_before_eq_jiffies(a) time_after_eq(jiffies, a)
 151
 152 /* time_is_after_eq_jiffies(a) return true if a is after or equal to jiffies*/
 153 #define time_is_after_eq_jiffies(a) time_before_eq(jiffies, a)
 154
 155 /*
 156  * Have the 32 bit jiffies value wrap 5 minutes after boot
 157  * so jiffies wrap bugs show up earlier.
 158  */
 159 #define INITIAL_JIFFIES ((unsigned long)(unsigned int) (-300*HZ))
 160
 161 /*
 162  * Change timeval to jiffies, trying to avoid the
 163  * most obvious overflows..
 164  *
 165  * And some not so obvious.
 166  *
 167  * Note that we don't want to return LONG_MAX, because
 168  * for various timeout reasons we often end up having
 169  * to wait "jiffies+1" in order to guarantee that we wait
 170  * at _least_ "jiffies" - so "jiffies+1" had better still
 171  * be positive.
 172  */
 173 #define MAX_JIFFY_OFFSET ((LONG_MAX >> 1)-1)
 174
 175 extern unsigned long preset_lpj;
 176
 177 /*
 178  * We want to do realistic conversions of time so we need to use the same
 179  * values the update wall clock code uses as the jiffies size.  This value
 180  * is: TICK_NSEC (which is defined in timex.h).  This
 181  * is a constant and is in nanoseconds.  We will use scaled math
 182  * with a set of scales defined here as SEC_JIFFIE_SC,  USEC_JIFFIE_SC and
 183  * NSEC_JIFFIE_SC.  Note that these defines contain nothing but
 184  * constants and so are computed at compile time.  SHIFT_HZ (computed in
 185  * timex.h) adjusts the scaling for different HZ values.
 186
 187  * Scaled math???  What is that?
 188  *
 189  * Scaled math is a way to do integer math on values that would,
 190  * otherwise, either overflow, underflow, or cause undesired div
 191  * instructions to appear in the execution path.  In short, we "scale"
 192  * up the operands so they take more bits (more precision, less
 193  * underflow), do the desired operation and then "scale" the result back
 194  * by the same amount.  If we do the scaling by shifting we avoid the
 195  * costly mpy and the dastardly div instructions.
 196
 197  * Suppose, for example, we want to convert from seconds to jiffies
 198  * where jiffies is defined in nanoseconds as NSEC_PER_JIFFIE.  The
 199  * simple math is: jiff = (sec * NSEC_PER_SEC) / NSEC_PER_JIFFIE; We
 200  * observe that (NSEC_PER_SEC / NSEC_PER_JIFFIE) is a constant which we
 201  * might calculate at compile time, however, the result will only have
 202  * about 3-4 bits of precision (less for smaller values of HZ).
 203  *
 204  * So, we scale as follows:
 205  * jiff = (sec) * (NSEC_PER_SEC / NSEC_PER_JIFFIE);
 206  * jiff = ((sec) * ((NSEC_PER_SEC * SCALE)/ NSEC_PER_JIFFIE)) / SCALE;
 207  * Then we make SCALE a power of two so:
 208  * jiff = ((sec) * ((NSEC_PER_SEC << SCALE)/ NSEC_PER_JIFFIE)) >> SCALE;
 209  * Now we define:
 210  * #define SEC_CONV = ((NSEC_PER_SEC << SCALE)/ NSEC_PER_JIFFIE))
 211  * jiff = (sec * SEC_CONV) >> SCALE;
 212  *
 213  * Often the math we use will expand beyond 32-bits so we tell C how to
 214  * do this and pass the 64-bit result of the mpy through the ">> SCALE"
 215  * which should take the result back to 32-bits.  We want this expansion
 216  * to capture as much precision as possible.  At the same time we don't
 217  * want to overflow so we pick the SCALE to avoid this.  In this file,
 218  * that means using a different scale for each range of HZ values (as
 219  * defined in timex.h).
 220  *
 221  * For those who want to know, gcc will give a 64-bit result from a "*"
 222  * operator if the result is a long long AND at least one of the
 223  * operands is cast to long long (usually just prior to the "*" so as
 224  * not to confuse it into thinking it really has a 64-bit operand,
 225  * which, buy the way, it can do, but it takes more code and at least 2
 226  * mpys).
 227
 228  * We also need to be aware that one second in nanoseconds is only a
 229  * couple of bits away from overflowing a 32-bit word, so we MUST use
 230  * 64-bits to get the full range time in nanoseconds.
 231
 232  */
 233
 234 /*
 235  * Here are the scales we will use.  One for seconds, nanoseconds and
 236  * microseconds.
 237  *
 238  * Within the limits of cpp we do a rough cut at the SEC_JIFFIE_SC and
 239  * check if the sign bit is set.  If not, we bump the shift count by 1.
 240  * (Gets an extra bit of precision where we can use it.)
 241  * We know it is set for HZ = 1024 and HZ = 100 not for 1000.
 242  * Haven't tested others.
 243
 244  * Limits of cpp (for #if expressions) only long (no long long), but
 245  * then we only need the most signicant bit.
 246  */
 247
 248 #define SEC_JIFFIE_SC (31 - SHIFT_HZ)
 249 #if !((((NSEC_PER_SEC << 2) / TICK_NSEC) << (SEC_JIFFIE_SC - 2)) & 0x80000000)
 250 #undef SEC_JIFFIE_SC
 251 #define SEC_JIFFIE_SC (32 - SHIFT_HZ)
 252 #endif
 253 #define NSEC_JIFFIE_SC (SEC_JIFFIE_SC + 29)
 254 #define USEC_JIFFIE_SC (SEC_JIFFIE_SC + 19)
 255 #define SEC_CONVERSION ((unsigned long)((((u64)NSEC_PER_SEC << SEC_JIFFIE_SC) +\
 256                                 TICK_NSEC -1) / (u64)TICK_NSEC))
 257
 258 #define NSEC_CONVERSION ((unsigned long)((((u64)1 << NSEC_JIFFIE_SC) +\
 259                                         TICK_NSEC -1) / (u64)TICK_NSEC))
 260 #define USEC_CONVERSION  \
 261                     ((unsigned long)((((u64)NSEC_PER_USEC << USEC_JIFFIE_SC) +\
 262                                         TICK_NSEC -1) / (u64)TICK_NSEC))
 263 /*
 264  * USEC_ROUND is used in the timeval to jiffie conversion.  See there
 265  * for more details.  It is the scaled resolution rounding value.  Note
 266  * that it is a 64-bit value.  Since, when it is applied, we are already
 267  * in jiffies (albit scaled), it is nothing but the bits we will shift
 268  * off.
 269  */
 270 #define USEC_ROUND (u64)(((u64)1 << USEC_JIFFIE_SC) - 1)
 271 /*
 272  * The maximum jiffie value is (MAX_INT >> 1).  Here we translate that
 273  * into seconds.  The 64-bit case will overflow if we are not careful,
 274  * so use the messy SH_DIV macro to do it.  Still all constants.
 275  */
 276 #if BITS_PER_LONG < 64
 277 # define MAX_SEC_IN_JIFFIES \
 278         (long)((u64)((u64)MAX_JIFFY_OFFSET * TICK_NSEC) / NSEC_PER_SEC)
 279 #else   /* take care of overflow on 64 bits machines */
 280 # define MAX_SEC_IN_JIFFIES \
 281         (SH_DIV((MAX_JIFFY_OFFSET >> SEC_JIFFIE_SC) * TICK_NSEC, NSEC_PER_SEC, 1) - 1)
 282
 283 #endif
 284
 285 /*
 286  * Convert various time units to each other:
 287  */
 288 extern unsigned int jiffies_to_msecs(const unsigned long j);
 289 extern unsigned int jiffies_to_usecs(const unsigned long j);
 290 extern unsigned long msecs_to_jiffies(const unsigned int m);
 291 extern unsigned long usecs_to_jiffies(const unsigned int u);
 292 extern unsigned long timespec_to_jiffies(const struct timespec *value);
 293 extern void jiffies_to_timespec(const unsigned long jiffies,
 294                                 struct timespec *value);
 295 extern unsigned long timeval_to_jiffies(const struct timeval *value);
 296 extern void jiffies_to_timeval(const unsigned long jiffies,
 297                                struct timeval *value);
 298 extern clock_t jiffies_to_clock_t(unsigned long x);
 299 extern unsigned long clock_t_to_jiffies(unsigned long x);
 300 extern u64 jiffies_64_to_clock_t(u64 x);
 301 extern u64 nsec_to_clock_t(u64 x);
 302 extern u64 nsecs_to_jiffies64(u64 n);
 303 extern unsigned long nsecs_to_jiffies(u64 n);
 304
 305 #define TIMESTAMP_SIZE  30
 306
 307 #endif