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
 117 always_inline u64 clib_cpu_time_now (void)
 118 {
 119   u32 lo;
 120   asm volatile ("mrc p15, 0, %[lo], c15, c12, 1"
 121                 : [lo] "=r" (lo));
 122   return (u64) lo;
 123 }
 124
 125 #elif defined (__xtensa__)
 126
 127 /* Stub for now. */
 128 always_inline u64 clib_cpu_time_now (void)
 129 { return 0; }
 130
 131 #elif defined (__TMS320C6X__)
 132
 133 always_inline u64 clib_cpu_time_now (void)
 134 {
 135   u32 l, h;
 136
 137   asm volatile (" dint\n"
 138                 " mvc .s2 TSCL,%0\n"
 139                 " mvc .s2 TSCH,%1\n"
 140                 " rint\n"
 141                 : "=b" (l), "=b" (h));
 142
 143   return ((u64)h << 32) | l;
 144 }
 145
 146 #elif defined (__aarch64__)
 147 always_inline u64 clib_cpu_time_now (void)
 148 {
 149   u64 tsc;
 150
 151   /* Works on Cavium ThunderX. Other platforms: YMMV */
 152   asm volatile("mrs %0, cntvct_el0" : "=r" (tsc));
 153
 154   return tsc;
 155 }
 156
 157 #else
 158 #error "don't know how to read CPU time stamp"
 159
 160 #endif
 161
 162 void clib_time_verify_frequency (clib_time_t * c);
 163
 164 always_inline f64 clib_time_now_internal (clib_time_t * c, u64 n)
 165 {
 166   u64 l = c->last_cpu_time;
 167   u64 t = c->total_cpu_time;
 168   t += n - l;
 169   c->total_cpu_time = t;
 170   c->last_cpu_time = n;
 171   if (PREDICT_FALSE ((c->last_cpu_time - c->last_verify_cpu_time) >> c->log2_clocks_per_frequency_verify))
 172     clib_time_verify_frequency (c);
 173   return t * c->seconds_per_clock;
 174 }
 175
 176 always_inline f64
 177 clib_time_now (clib_time_t * c)
 178 {
 179   return clib_time_now_internal (c, clib_cpu_time_now());
 180 }
 181
 182 always_inline void clib_cpu_time_wait (u64 dt)
 183 {
 184   u64 t_end = clib_cpu_time_now () + dt;
 185   while (clib_cpu_time_now () < t_end)
 186     ;
 187 }
 188
 189 void clib_time_init (clib_time_t * c);
 190
 191 #ifdef CLIB_UNIX
 192
 193 #include <time.h>
 194 #include <sys/time.h>
 195 #include <sys/resource.h>
 196 #include <unistd.h>
 197 #include <sys/syscall.h>
 198
 199 /* Use 64bit floating point to represent time offset from epoch. */
 200 always_inline f64 unix_time_now (void)
 201 {
 202   /* clock_gettime without indirect syscall uses GLIBC wrappers which
 203      we don't want.  Just the bare metal, please. */
 204   struct timespec ts;
 205   syscall (SYS_clock_gettime, CLOCK_REALTIME, &ts);
 206   return ts.tv_sec + 1e-9*ts.tv_nsec;
 207 }
 208
 209 /* As above but integer number of nano-seconds. */
 210 always_inline u64 unix_time_now_nsec (void)
 211 {
 212   struct timespec ts;
 213   syscall (SYS_clock_gettime, CLOCK_REALTIME, &ts);
 214   return 1e9*ts.tv_sec + ts.tv_nsec;
 215 }
 216
 217 always_inline f64 unix_usage_now (void)
 218 {
 219   struct rusage u;
 220   getrusage (RUSAGE_SELF, &u);
 221   return u.ru_utime.tv_sec + 1e-6*u.ru_utime.tv_usec
 222     + u.ru_stime.tv_sec + 1e-6*u.ru_stime.tv_usec;
 223 }
 224
 225 always_inline void unix_sleep (f64 dt)
 226 {
 227   struct timespec t;
 228   t.tv_sec = dt;
 229   t.tv_nsec = 1e9 * dt;
 230   nanosleep (&t, 0);
 231 }
 232
 233 #else  /* ! CLIB_UNIX */
 234
 235 always_inline f64 unix_time_now (void)
 236 { return 0; }
 237
 238 always_inline u64 unix_time_now_nsec (void)
 239 { return 0; }
 240
 241 always_inline f64 unix_usage_now (void)
 242 { return 0; }
 243
 244 always_inline void unix_sleep (f64 dt)
 245 { }
 246
 247 #endif
 248
 249 #endif /* included_time_h */