vppinfra/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   /* Total run time in clock cycles
  45      since clib_time_init call. */
  46   u64 total_cpu_time;
  47
  48   /* Last recorded time stamp. */
  49   u64 last_cpu_time;
  50
  51   /* CPU clock frequency. */
  52   f64 clocks_per_second;
  53
  54   /* 1 / cpu clock frequency: conversion factor
  55      from clock cycles into seconds. */
  56   f64 seconds_per_clock;
  57
  58   /* Time stamp of call to clib_time_init call. */
  59   u64 init_cpu_time;
  60
  61   u64 last_verify_cpu_time;
  62
  63   /* Same but for reference time (if present). */
  64   f64 last_verify_reference_time;
  65
  66   u32 log2_clocks_per_second, log2_clocks_per_frequency_verify;
  67 } clib_time_t;
  68
  69 /* Return CPU time stamp as 64bit number. */
  70 #if defined(__x86_64__) || defined(i386)
  71 always_inline u64 clib_cpu_time_now (void)
  72 {
  73   u32 a, d;
  74   asm volatile ("rdtsc"
  75                 : "=a" (a), "=d" (d));
  76   return (u64) a + ((u64) d << (u64) 32);
  77 }
  78
  79 #elif defined (__powerpc64__)
  80
  81 always_inline u64 clib_cpu_time_now (void)
  82 {
  83   u64 t;
  84   asm volatile ("mftb %0" : "=r" (t));
  85   return t;
  86 }
  87
  88 #elif defined (__SPU__)
  89
  90 always_inline u64 clib_cpu_time_now (void)
  91 {
  92 #ifdef _XLC
  93   return spu_rdch (0x8);
  94 #else
  95   return 0 /* __builtin_si_rdch (0x8) FIXME */;
  96 #endif
  97 }
  98
  99 #elif defined (__powerpc__)
 100
 101 always_inline u64 clib_cpu_time_now (void)
 102 {
 103   u32 hi1, hi2, lo;
 104   asm volatile (
 105     "1:\n"
 106     "mftbu %[hi1]\n"
 107     "mftb  %[lo]\n"
 108     "mftbu %[hi2]\n"
 109     "cmpw %[hi1],%[hi2]\n"
 110     "bne 1b\n"
 111     : [hi1] "=r" (hi1), [hi2] "=r" (hi2), [lo] "=r" (lo));
 112   return (u64) lo + ((u64) hi2 << (u64) 32);
 113 }
 114
 115 #elif defined (__arm__)
 116 #if defined(__ARM_ARCH_8A__)
 117 always_inline u64 clib_cpu_time_now (void) /* We may run arm64 in aarch32 mode, to leverage 64bit counter */
 118 {
 119   u64 tsc;
 120   asm volatile("mrrc p15, 0, %Q0, %R0, c9" : "=r" (tsc));
 121   return tsc;
 122 }
 123 #elif defined(__ARM_ARCH_7A__)
 124 always_inline u64 clib_cpu_time_now (void)
 125 {
 126   u32 tsc;
 127   asm volatile("mrc p15, 0, %0, c9, c13, 0" : "=r" (tsc));
 128   return (u64)tsc;
 129 }
 130 #else
 131 always_inline u64 clib_cpu_time_now (void)
 132 {
 133   u32 lo;
 134   asm volatile ("mrc p15, 0, %[lo], c15, c12, 1"
 135                 : [lo] "=r" (lo));
 136   return (u64) lo;
 137 }
 138 #endif
 139
 140 #elif defined (__xtensa__)
 141
 142 /* Stub for now. */
 143 always_inline u64 clib_cpu_time_now (void)
 144 { return 0; }
 145
 146 #elif defined (__TMS320C6X__)
 147
 148 always_inline u64 clib_cpu_time_now (void)
 149 {
 150   u32 l, h;
 151
 152   asm volatile (" dint\n"
 153                 " mvc .s2 TSCL,%0\n"
 154                 " mvc .s2 TSCH,%1\n"
 155                 " rint\n"
 156                 : "=b" (l), "=b" (h));
 157
 158   return ((u64)h << 32) | l;
 159 }
 160
 161 #elif defined (__aarch64__)
 162 always_inline u64 clib_cpu_time_now (void)
 163 {
 164   u64 tsc;
 165
 166   /* Works on Cavium ThunderX. Other platforms: YMMV */
 167   asm volatile("mrs %0, cntvct_el0" : "=r" (tsc));
 168
 169   return tsc;
 170 }
 171
 172 #else
 173 #error "don't know how to read CPU time stamp"
 174
 175 #endif
 176
 177 void clib_time_verify_frequency (clib_time_t * c);
 178
 179 always_inline f64 clib_time_now_internal (clib_time_t * c, u64 n)
 180 {
 181   u64 l = c->last_cpu_time;
 182   u64 t = c->total_cpu_time;
 183   t += n - l;
 184   c->total_cpu_time = t;
 185   c->last_cpu_time = n;
 186   if (PREDICT_FALSE ((c->last_cpu_time - c->last_verify_cpu_time) >> c->log2_clocks_per_frequency_verify))
 187     clib_time_verify_frequency (c);
 188   return t * c->seconds_per_clock;
 189 }
 190
 191 always_inline f64
 192 clib_time_now (clib_time_t * c)
 193 {
 194   return clib_time_now_internal (c, clib_cpu_time_now());
 195 }
 196
 197 always_inline void clib_cpu_time_wait (u64 dt)
 198 {
 199   u64 t_end = clib_cpu_time_now () + dt;
 200   while (clib_cpu_time_now () < t_end)
 201     ;
 202 }
 203
 204 void clib_time_init (clib_time_t * c);
 205
 206 #ifdef CLIB_UNIX
 207
 208 #include <time.h>
 209 #include <sys/time.h>
 210 #include <sys/resource.h>
 211 #include <unistd.h>
 212 #include <sys/syscall.h>
 213
 214 /* Use 64bit floating point to represent time offset from epoch. */
 215 always_inline f64 unix_time_now (void)
 216 {
 217   /* clock_gettime without indirect syscall uses GLIBC wrappers which
 218      we don't want.  Just the bare metal, please. */
 219   struct timespec ts;
 220   syscall (SYS_clock_gettime, CLOCK_REALTIME, &ts);
 221   return ts.tv_sec + 1e-9*ts.tv_nsec;
 222 }
 223
 224 /* As above but integer number of nano-seconds. */
 225 always_inline u64 unix_time_now_nsec (void)
 226 {
 227   struct timespec ts;
 228   syscall (SYS_clock_gettime, CLOCK_REALTIME, &ts);
 229   return 1e9*ts.tv_sec + ts.tv_nsec;
 230 }
 231
 232 always_inline f64 unix_usage_now (void)
 233 {
 234   struct rusage u;
 235   getrusage (RUSAGE_SELF, &u);
 236   return u.ru_utime.tv_sec + 1e-6*u.ru_utime.tv_usec
 237     + u.ru_stime.tv_sec + 1e-6*u.ru_stime.tv_usec;
 238 }
 239
 240 always_inline void unix_sleep (f64 dt)
 241 {
 242   struct timespec t;
 243   t.tv_sec = dt;
 244   t.tv_nsec = 1e9 * dt;
 245   nanosleep (&t, 0);
 246 }
 247
 248 #else  /* ! CLIB_UNIX */
 249
 250 always_inline f64 unix_time_now (void)
 251 { return 0; }
 252
 253 always_inline u64 unix_time_now_nsec (void)
 254 { return 0; }
 255
 256 always_inline f64 unix_usage_now (void)
 257 { return 0; }
 258
 259 always_inline void unix_sleep (f64 dt)
 260 { }
 261
 262 #endif
 263
 264 #endif /* included_time_h */