vppinfra/vppinfra/time.c

   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) 2005 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 #include <vppinfra/os.h>
  39 #include <vppinfra/time.h>
  40 #include <vppinfra/format.h>
  41
  42 #ifdef CLIB_UNIX
  43
  44 #include <math.h>
  45 #include <sys/time.h>
  46 #include <fcntl.h>
  47
  48 /* Not very accurate way of determining cpu clock frequency
  49    for unix.  Better to use /proc/cpuinfo on linux. */
  50 static f64
  51 estimate_clock_frequency (f64 sample_time)
  52 {
  53   /* Round to nearest 100KHz. */
  54   const f64 round_to_units = 100e5;
  55
  56   f64 time_now, time_start, time_limit, freq;
  57   u64 ifreq, t[2];
  58
  59   time_start = time_now = unix_time_now ();
  60   time_limit = time_now + sample_time;
  61   t[0] = clib_cpu_time_now ();
  62   while (time_now < time_limit)
  63     time_now = unix_time_now ();
  64   t[1] = clib_cpu_time_now ();
  65
  66   freq = (t[1] - t[0]) / (time_now - time_start);
  67   ifreq = flt_round_nearest (freq / round_to_units);
  68   freq = ifreq * round_to_units;
  69
  70   return freq;
  71 }
  72
  73 /* Fetch cpu frequency via parseing /proc/cpuinfo.
  74    Only works for Linux. */
  75 static f64
  76 clock_frequency_from_proc_filesystem (void)
  77 {
  78   f64 cpu_freq = 1e9;           /* better than 40... */
  79   f64 ppc_timebase = 0;         /* warnings be gone */
  80   int fd;
  81   unformat_input_t input;
  82
  83 /* $$$$ aarch64 kernel doesn't report "cpu MHz" */
  84 #if defined(__aarch64__)
  85   return 0.0;
  86 #endif
  87
  88   cpu_freq = 0;
  89   fd = open ("/proc/cpuinfo", 0);
  90   if (fd < 0)
  91     return cpu_freq;
  92
  93   unformat_init_unix_file (&input, fd);
  94
  95   ppc_timebase = 0;
  96   while (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
  97     {
  98       if (unformat (&input, "cpu MHz : %f", &cpu_freq))
  99         cpu_freq *= 1e6;
 100       else if (unformat (&input, "timebase : %f", &ppc_timebase))
 101         ;
 102       else
 103         unformat_skip_line (&input);
 104     }
 105
 106   unformat_free (&input);
 107
 108   close (fd);
 109
 110   /* Override CPU frequency with time base for PPC. */
 111   if (ppc_timebase != 0)
 112     cpu_freq = ppc_timebase;
 113
 114   return cpu_freq;
 115 }
 116
 117 /* Fetch cpu frequency via reading /sys/devices/system/cpu/cpu0/cpufreq/cpuinfo_max_freq
 118    Only works for Linux. */
 119 static f64
 120 clock_frequency_from_sys_filesystem (void)
 121 {
 122   f64 cpu_freq;
 123   int fd;
 124   unformat_input_t input;
 125
 126   /* Time stamp always runs at max frequency. */
 127   cpu_freq = 0;
 128   fd = open ("/sys/devices/system/cpu/cpu0/cpufreq/cpuinfo_max_freq", 0);
 129   if (fd < 0)
 130     goto done;
 131
 132   unformat_init_unix_file (&input, fd);
 133   unformat (&input, "%f", &cpu_freq);
 134   cpu_freq *= 1e3;              /* measured in kHz */
 135   unformat_free (&input);
 136   close (fd);
 137 done:
 138   return cpu_freq;
 139 }
 140
 141 f64
 142 os_cpu_clock_frequency (void)
 143 {
 144   f64 cpu_freq;
 145
 146   /* First try /sys version. */
 147   cpu_freq = clock_frequency_from_sys_filesystem ();
 148   if (cpu_freq != 0)
 149     return cpu_freq;
 150
 151   /* Next try /proc version. */
 152   cpu_freq = clock_frequency_from_proc_filesystem ();
 153   if (cpu_freq != 0)
 154     return cpu_freq;
 155
 156   /* If /proc/cpuinfo fails (e.g. not running on Linux) fall back to
 157      gettimeofday based estimated clock frequency. */
 158   return estimate_clock_frequency (1e-3);
 159 }
 160
 161 #endif /* CLIB_UNIX */
 162
 163 /* Initialize time. */
 164 void
 165 clib_time_init (clib_time_t * c)
 166 {
 167   memset (c, 0, sizeof (c[0]));
 168   c->clocks_per_second = os_cpu_clock_frequency ();
 169   c->seconds_per_clock = 1 / c->clocks_per_second;
 170   c->log2_clocks_per_second = min_log2_u64 ((u64) c->clocks_per_second);
 171
 172   /* Initially verify frequency every sec */
 173   c->log2_clocks_per_frequency_verify = c->log2_clocks_per_second;
 174
 175   c->last_verify_reference_time = unix_time_now ();
 176   c->last_cpu_time = clib_cpu_time_now ();
 177   c->init_cpu_time = c->last_verify_cpu_time = c->last_cpu_time;
 178 }
 179
 180 void
 181 clib_time_verify_frequency (clib_time_t * c)
 182 {
 183   f64 now_reference = unix_time_now ();
 184   f64 dtr = now_reference - c->last_verify_reference_time;
 185   f64 dtr_max;
 186   u64 dtc = c->last_cpu_time - c->last_verify_cpu_time;
 187   f64 round_units = 100e5;
 188
 189   c->last_verify_cpu_time = c->last_cpu_time;
 190   c->last_verify_reference_time = now_reference;
 191
 192   /*
 193    * Is the reported reference interval non-positive,
 194    * or off by a factor of two - or 8 seconds - whichever is larger?
 195    * Someone reset the clock behind our back.
 196    */
 197   dtr_max = (f64) (2ULL << c->log2_clocks_per_frequency_verify) /
 198     (f64) (1ULL << c->log2_clocks_per_second);
 199   dtr_max = dtr_max > 8.0 ? dtr_max : 8.0;
 200
 201   if (dtr <= 0.0 || dtr > dtr_max)
 202     {
 203       c->log2_clocks_per_frequency_verify = c->log2_clocks_per_second;
 204       return;
 205     }
 206
 207   c->clocks_per_second =
 208     flt_round_nearest ((f64) dtc / (dtr * round_units)) * round_units;
 209   c->seconds_per_clock = 1 / c->clocks_per_second;
 210
 211   /* Double time between verifies; max at 64 secs ~ 1 minute. */
 212   if (c->log2_clocks_per_frequency_verify < c->log2_clocks_per_second + 6)
 213     c->log2_clocks_per_frequency_verify += 1;
 214 }
 215
 216 /*
 217  * fd.io coding-style-patch-verification: ON
 218  *
 219  * Local Variables:
 220  * eval: (c-set-style "gnu")
 221  * End:
 222  */