src/vppinfra/time.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16   Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
  17
  18   Permission is hereby granted, free of charge, to any person obtaining
  19   a copy of this software and associated documentation files (the
  20   "Software"), to deal in the Software without restriction, including
  21   without limitation the rights to use, copy, modify, merge, publish,
  22   distribute, sublicense, and/or sell copies of the Software, and to
  23   permit persons to whom the Software is furnished to do so, subject to
  24   the following conditions:
  25
  26   The above copyright notice and this permission notice shall be
  27   included in all copies or substantial portions of the Software.
  28
  29   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  30   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  31   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  32   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  33   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  34   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  35   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  36 */
  37
  38 #ifndef included_time_h
  39 #define included_time_h
  40
  41 #include <vppinfra/clib.h>
  42
  43 typedef struct
  44 {
  45   /* Total run time in clock cycles
  46      since clib_time_init call. */
  47   u64 total_cpu_time;
  48
  49   /* Last recorded time stamp. */
  50   u64 last_cpu_time;
  51
  52   /* CPU clock frequency. */
  53   f64 clocks_per_second;
  54
  55   /* 1 / cpu clock frequency: conversion factor
  56      from clock cycles into seconds. */
  57   f64 seconds_per_clock;
  58
  59   f64 round_to_units;
  60
  61   /* Time stamp of call to clib_time_init call. */
  62   u64 init_cpu_time;
  63
  64   u64 last_verify_cpu_time;
  65
  66   /* Same but for reference time (if present). */
  67   f64 last_verify_reference_time;
  68
  69   u32 log2_clocks_per_second, log2_clocks_per_frequency_verify;
  70 } clib_time_t;
  71
  72 /* Return CPU time stamp as 64bit number. */
  73 #if defined(__x86_64__) || defined(i386)
  74 always_inline u64
  75 clib_cpu_time_now (void)
  76 {
  77   u32 a, d;
  78   asm volatile ("rdtsc":"=a" (a), "=d" (d));
  79   return (u64) a + ((u64) d << (u64) 32);
  80 }
  81
  82 #elif defined (__powerpc64__)
  83
  84 always_inline u64
  85 clib_cpu_time_now (void)
  86 {
  87   u64 t;
  88   asm volatile ("mftb %0":"=r" (t));
  89   return t;
  90 }
  91
  92 #elif defined (__SPU__)
  93
  94 always_inline u64
  95 clib_cpu_time_now (void)
  96 {
  97 #ifdef _XLC
  98   return spu_rdch (0x8);
  99 #else
 100   return 0 /* __builtin_si_rdch (0x8) FIXME */ ;
 101 #endif
 102 }
 103
 104 #elif defined (__powerpc__)
 105
 106 always_inline u64
 107 clib_cpu_time_now (void)
 108 {
 109   u32 hi1, hi2, lo;
 110   asm volatile ("1:\n"
 111                 "mftbu %[hi1]\n"
 112                 "mftb  %[lo]\n"
 113                 "mftbu %[hi2]\n"
 114                 "cmpw %[hi1],%[hi2]\n"
 115                 "bne 1b\n":[hi1] "=r" (hi1),[hi2] "=r" (hi2),[lo] "=r" (lo));
 116   return (u64) lo + ((u64) hi2 << (u64) 32);
 117 }
 118
 119 #elif defined (__aarch64__)
 120 always_inline u64
 121 clib_cpu_time_now (void)
 122 {
 123   u64 vct;
 124   /* User access to cntvct_el0 is enabled in Linux kernel since 3.12. */
 125   asm volatile ("mrs %0, cntvct_el0":"=r" (vct));
 126   return vct;
 127 }
 128
 129 #elif defined (__arm__)
 130 #if defined(__ARM_ARCH_8A__)
 131 always_inline u64
 132 clib_cpu_time_now (void)        /* We may run arm64 in aarch32 mode, to leverage 64bit counter */
 133 {
 134   u64 tsc;
 135   asm volatile ("mrrc p15, 0, %Q0, %R0, c9":"=r" (tsc));
 136   return tsc;
 137 }
 138 #elif defined(__ARM_ARCH_7A__)
 139 always_inline u64
 140 clib_cpu_time_now (void)
 141 {
 142   u32 tsc;
 143   asm volatile ("mrc p15, 0, %0, c9, c13, 0":"=r" (tsc));
 144   return (u64) tsc;
 145 }
 146 #else
 147 always_inline u64
 148 clib_cpu_time_now (void)
 149 {
 150   u32 lo;
 151   asm volatile ("mrc p15, 0, %[lo], c15, c12, 1":[lo] "=r" (lo));
 152   return (u64) lo;
 153 }
 154 #endif
 155
 156 #elif defined (__xtensa__)
 157
 158 /* Stub for now. */
 159 always_inline u64
 160 clib_cpu_time_now (void)
 161 {
 162   return 0;
 163 }
 164
 165 #elif defined (__TMS320C6X__)
 166
 167 always_inline u64
 168 clib_cpu_time_now (void)
 169 {
 170   u32 l, h;
 171
 172   asm volatile (" dint\n"
 173                 " mvc .s2 TSCL,%0\n"
 174                 " mvc .s2 TSCH,%1\n" " rint\n":"=b" (l), "=b" (h));
 175
 176   return ((u64) h << 32) | l;
 177 }
 178
 179 #elif defined(_mips) && __mips == 64
 180
 181 always_inline u64
 182 clib_cpu_time_now (void)
 183 {
 184   u64 result;
 185   asm volatile ("rdhwr %0,$31\n":"=r" (result));
 186   return result;
 187 }
 188
 189 #else
 190 #error "don't know how to read CPU time stamp"
 191
 192 #endif
 193
 194 void clib_time_verify_frequency (clib_time_t * c);
 195
 196 /* Define it as the type returned by clib_time_now */
 197 typedef f64 clib_time_type_t;
 198 typedef u64 clib_us_time_t;
 199
 200 #define CLIB_US_TIME_PERIOD (1e-6)
 201 #define CLIB_US_TIME_FREQ (1.0/CLIB_US_TIME_PERIOD)
 202
 203 always_inline f64
 204 clib_time_now_internal (clib_time_t * c, u64 n)
 205 {
 206   u64 l = c->last_cpu_time;
 207   u64 t = c->total_cpu_time;
 208   t += n - l;
 209   c->total_cpu_time = t;
 210   c->last_cpu_time = n;
 211   if (PREDICT_FALSE
 212       ((c->last_cpu_time -
 213         c->last_verify_cpu_time) >> c->log2_clocks_per_frequency_verify))
 214     clib_time_verify_frequency (c);
 215   return t * c->seconds_per_clock;
 216 }
 217
 218 /* Maximum f64 value as max clib_time */
 219 #define CLIB_TIME_MAX (1.7976931348623157e+308)
 220
 221 always_inline f64
 222 clib_time_now (clib_time_t * c)
 223 {
 224   return clib_time_now_internal (c, clib_cpu_time_now ());
 225 }
 226
 227 always_inline void
 228 clib_cpu_time_wait (u64 dt)
 229 {
 230   u64 t_end = clib_cpu_time_now () + dt;
 231   while (clib_cpu_time_now () < t_end)
 232     ;
 233 }
 234
 235 void clib_time_init (clib_time_t * c);
 236
 237 #ifdef CLIB_UNIX
 238
 239 #include <time.h>
 240 #include <sys/time.h>
 241 #include <sys/resource.h>
 242 #include <unistd.h>
 243 #include <sys/syscall.h>
 244
 245 /* Use 64bit floating point to represent time offset from epoch. */
 246 always_inline f64
 247 unix_time_now (void)
 248 {
 249   struct timespec ts;
 250 #ifdef __MACH__
 251   clock_gettime (CLOCK_REALTIME, &ts);
 252 #else
 253   /* clock_gettime without indirect syscall uses GLIBC wrappers which
 254      we don't want.  Just the bare metal, please. */
 255   syscall (SYS_clock_gettime, CLOCK_REALTIME, &ts);
 256 #endif
 257   return ts.tv_sec + 1e-9 * ts.tv_nsec;
 258 }
 259
 260 /* As above but integer number of nano-seconds. */
 261 always_inline u64
 262 unix_time_now_nsec (void)
 263 {
 264   struct timespec ts;
 265 #ifdef __MACH__
 266   clock_gettime (CLOCK_REALTIME, &ts);
 267 #else
 268   syscall (SYS_clock_gettime, CLOCK_REALTIME, &ts);
 269 #endif
 270   return 1e9 * ts.tv_sec + ts.tv_nsec;
 271 }
 272
 273 always_inline void
 274 unix_time_now_nsec_fraction (u32 * sec, u32 * nsec)
 275 {
 276   struct timespec ts;
 277 #ifdef __MACH__
 278   clock_gettime (CLOCK_REALTIME, &ts);
 279 #else
 280   syscall (SYS_clock_gettime, CLOCK_REALTIME, &ts);
 281 #endif
 282   *sec = ts.tv_sec;
 283   *nsec = ts.tv_nsec;
 284 }
 285
 286 always_inline f64
 287 unix_usage_now (void)
 288 {
 289   struct rusage u;
 290   getrusage (RUSAGE_SELF, &u);
 291   return u.ru_utime.tv_sec + 1e-6 * u.ru_utime.tv_usec
 292     + u.ru_stime.tv_sec + 1e-6 * u.ru_stime.tv_usec;
 293 }
 294
 295 always_inline void
 296 unix_sleep (f64 dt)
 297 {
 298   struct timespec ts, tsrem;
 299   ts.tv_sec = dt;
 300   ts.tv_nsec = 1e9 * (dt - (f64) ts.tv_sec);
 301
 302   while (nanosleep (&ts, &tsrem) < 0)
 303     ts = tsrem;
 304 }
 305
 306 #else /* ! CLIB_UNIX */
 307
 308 always_inline f64
 309 unix_time_now (void)
 310 {
 311   return 0;
 312 }
 313
 314 always_inline u64
 315 unix_time_now_nsec (void)
 316 {
 317   return 0;
 318 }
 319
 320 always_inline void
 321 unix_time_now_nsec_fraction (u32 * sec, u32 * nsec)
 322 {
 323 }
 324
 325 always_inline f64
 326 unix_usage_now (void)
 327 {
 328   return 0;
 329 }
 330
 331 always_inline void
 332 unix_sleep (f64 dt)
 333 {
 334 }
 335
 336 #endif
 337
 338 #endif /* included_time_h */
 339
 340 /*
 341  * fd.io coding-style-patch-verification: ON
 342  *
 343  * Local Variables:
 344  * eval: (c-set-style "gnu")
 345  * End:
 346  */