lib/librte_eal/linuxapp/eal/eal_timer.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   Copyright(c) 2012-2013 6WIND S.A.
   6  *   All rights reserved.
   7  *
   8  *   Redistribution and use in source and binary forms, with or without
   9  *   modification, are permitted provided that the following conditions
  10  *   are met:
  11  *
  12  *     * Redistributions of source code must retain the above copyright
  13  *       notice, this list of conditions and the following disclaimer.
  14  *     * Redistributions in binary form must reproduce the above copyright
  15  *       notice, this list of conditions and the following disclaimer in
  16  *       the documentation and/or other materials provided with the
  17  *       distribution.
  18  *     * Neither the name of Intel Corporation nor the names of its
  19  *       contributors may be used to endorse or promote products derived
  20  *       from this software without specific prior written permission.
  21  *
  22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #include <string.h>
  36 #include <stdlib.h>
  37 #include <stdio.h>
  38 #include <stdint.h>
  39 #include <unistd.h>
  40 #include <fcntl.h>
  41 #include <inttypes.h>
  42 #include <sys/mman.h>
  43 #include <sys/queue.h>
  44 #include <pthread.h>
  45 #include <errno.h>
  46
  47 #include <rte_common.h>
  48 #include <rte_log.h>
  49 #include <rte_cycles.h>
  50 #include <rte_tailq.h>
  51 #include <rte_memory.h>
  52 #include <rte_memzone.h>
  53 #include <rte_eal.h>
  54 #include <rte_debug.h>
  55
  56 #include "eal_private.h"
  57 #include "eal_internal_cfg.h"
  58
  59 enum timer_source eal_timer_source = EAL_TIMER_HPET;
  60
  61 /* The frequency of the RDTSC timer resolution */
  62 static uint64_t eal_tsc_resolution_hz = 0;
  63
  64 #ifdef RTE_LIBEAL_USE_HPET
  65
  66 #define DEV_HPET "/dev/hpet"
  67
  68 /* Maximum number of counters. */
  69 #define HPET_TIMER_NUM 3
  70
  71 /* General capabilities register */
  72 #define CLK_PERIOD_SHIFT     32 /* Clock period shift. */
  73 #define CLK_PERIOD_MASK      0xffffffff00000000ULL /* Clock period mask. */
  74
  75 /**
  76  * HPET timer registers. From the Intel IA-PC HPET (High Precision Event
  77  * Timers) Specification.
  78  */
  79 struct eal_hpet_regs {
  80         /* Memory-mapped, software visible registers */
  81         uint64_t capabilities;      /**< RO General Capabilities Register. */
  82         uint64_t reserved0;         /**< Reserved for future use. */
  83         uint64_t config;            /**< RW General Configuration Register. */
  84         uint64_t reserved1;         /**< Reserved for future use. */
  85         uint64_t isr;               /**< RW Clear General Interrupt Status. */
  86         uint64_t reserved2[25];     /**< Reserved for future use. */
  87         union {
  88                 uint64_t counter;   /**< RW Main Counter Value Register. */
  89                 struct {
  90                         uint32_t counter_l; /**< RW Main Counter Low. */
  91                         uint32_t counter_h; /**< RW Main Counter High. */
  92                 };
  93         };
  94         uint64_t reserved3;         /**< Reserved for future use. */
  95         struct {
  96                 uint64_t config;    /**< RW Timer Config and Capability Reg. */
  97                 uint64_t comp;      /**< RW Timer Comparator Value Register. */
  98                 uint64_t fsb;       /**< RW FSB Interrupt Route Register. */
  99                 uint64_t reserved4; /**< Reserved for future use. */
 100         } timers[HPET_TIMER_NUM]; /**< Set of HPET timers. */
 101 };
 102
 103 /* Mmap'd hpet registers */
 104 static volatile struct eal_hpet_regs *eal_hpet = NULL;
 105
 106 /* Period at which the HPET counter increments in
 107  * femtoseconds (10^-15 seconds). */
 108 static uint32_t eal_hpet_resolution_fs = 0;
 109
 110 /* Frequency of the HPET counter in Hz */
 111 static uint64_t eal_hpet_resolution_hz = 0;
 112
 113 /* Incremented 4 times during one 32bits hpet full count */
 114 static uint32_t eal_hpet_msb;
 115
 116 static pthread_t msb_inc_thread_id;
 117
 118 /*
 119  * This function runs on a specific thread to update a global variable
 120  * containing used to process MSB of the HPET (unfortunatelly, we need
 121  * this because hpet is 32 bits by default under linux).
 122  */
 123 static void
 124 hpet_msb_inc(__attribute__((unused)) void *arg)
 125 {
 126         uint32_t t;
 127
 128         while (1) {
 129                 t = (eal_hpet->counter_l >> 30);
 130                 if (t != (eal_hpet_msb & 3))
 131                         eal_hpet_msb ++;
 132                 sleep(10);
 133         }
 134 }
 135
 136 uint64_t
 137 rte_get_hpet_hz(void)
 138 {
 139         if(internal_config.no_hpet)
 140                 rte_panic("Error, HPET called, but no HPET present\n");
 141
 142         return eal_hpet_resolution_hz;
 143 }
 144
 145 uint64_t
 146 rte_get_hpet_cycles(void)
 147 {
 148         uint32_t t, msb;
 149         uint64_t ret;
 150
 151         if(internal_config.no_hpet)
 152                 rte_panic("Error, HPET called, but no HPET present\n");
 153
 154         t = eal_hpet->counter_l;
 155         msb = eal_hpet_msb;
 156         ret = (msb + 2 - (t >> 30)) / 4;
 157         ret <<= 32;
 158         ret += t;
 159         return ret;
 160 }
 161
 162 #endif
 163
 164
 165 void
 166 rte_delay_us(unsigned us)
 167 {
 168         const uint64_t start = rte_get_timer_cycles();
 169         const uint64_t ticks = (uint64_t)us * rte_get_timer_hz() / 1E6;
 170         while ((rte_get_timer_cycles() - start) < ticks)
 171                 rte_pause();
 172 }
 173
 174 uint64_t
 175 rte_get_tsc_hz(void)
 176 {
 177         return eal_tsc_resolution_hz;
 178 }
 179
 180
 181 #ifdef RTE_LIBEAL_USE_HPET
 182 /*
 183  * Open and mmap /dev/hpet (high precision event timer) that will
 184  * provide our time reference.
 185  */
 186 int
 187 rte_eal_hpet_init(int make_default)
 188 {
 189         int fd, ret;
 190
 191         if (internal_config.no_hpet) {
 192                 RTE_LOG(INFO, EAL, "HPET is disabled\n");
 193                 return -1;
 194         }
 195
 196         fd = open(DEV_HPET, O_RDONLY);
 197         if (fd < 0) {
 198                 RTE_LOG(ERR, EAL, "ERROR: Cannot open "DEV_HPET": %s!\n",
 199                         strerror(errno));
 200                 internal_config.no_hpet = 1;
 201                 return -1;
 202         }
 203         eal_hpet = mmap(NULL, 1024, PROT_READ, MAP_SHARED, fd, 0);
 204         if (eal_hpet == MAP_FAILED) {
 205                 RTE_LOG(ERR, EAL, "ERROR: Cannot mmap "DEV_HPET"!\n"
 206                                 "Please enable CONFIG_HPET_MMAP in your kernel configuration "
 207                                 "to allow HPET support.\n"
 208                                 "To run without using HPET, set CONFIG_RTE_LIBEAL_USE_HPET=n "
 209                                 "in your build configuration or use '--no-hpet' EAL flag.\n");
 210                 close(fd);
 211                 internal_config.no_hpet = 1;
 212                 return -1;
 213         }
 214         close(fd);
 215
 216         eal_hpet_resolution_fs = (uint32_t)((eal_hpet->capabilities &
 217                                         CLK_PERIOD_MASK) >>
 218                                         CLK_PERIOD_SHIFT);
 219
 220         eal_hpet_resolution_hz = (1000ULL*1000ULL*1000ULL*1000ULL*1000ULL) /
 221                 (uint64_t)eal_hpet_resolution_fs;
 222
 223         RTE_LOG(INFO, EAL, "HPET frequency is ~%"PRIu64" kHz\n",
 224                         eal_hpet_resolution_hz/1000);
 225
 226         eal_hpet_msb = (eal_hpet->counter_l >> 30);
 227
 228         /* create a thread that will increment a global variable for
 229          * msb (hpet is 32 bits by default under linux) */
 230         ret = pthread_create(&msb_inc_thread_id, NULL,
 231                         (void *(*)(void *))hpet_msb_inc, NULL);
 232         if (ret < 0) {
 233                 RTE_LOG(ERR, EAL, "ERROR: Cannot create HPET timer thread!\n");
 234                 internal_config.no_hpet = 1;
 235                 return -1;
 236         }
 237
 238         if (make_default)
 239                 eal_timer_source = EAL_TIMER_HPET;
 240         return 0;
 241 }
 242 #endif
 243
 244 static void
 245 check_tsc_flags(void)
 246 {
 247         char line[512];
 248         FILE *stream;
 249
 250         stream = fopen("/proc/cpuinfo", "r");
 251         if (!stream) {
 252                 RTE_LOG(WARNING, EAL, "WARNING: Unable to open /proc/cpuinfo\n");
 253                 return;
 254         }
 255
 256         while (fgets(line, sizeof line, stream)) {
 257                 char *constant_tsc;
 258                 char *nonstop_tsc;
 259
 260                 if (strncmp(line, "flags", 5) != 0)
 261                         continue;
 262
 263                 constant_tsc = strstr(line, "constant_tsc");
 264                 nonstop_tsc = strstr(line, "nonstop_tsc");
 265                 if (!constant_tsc || !nonstop_tsc)
 266                         RTE_LOG(WARNING, EAL,
 267                                 "WARNING: cpu flags "
 268                                 "constant_tsc=%s "
 269                                 "nonstop_tsc=%s "
 270                                 "-> using unreliable clock cycles !\n",
 271                                 constant_tsc ? "yes":"no",
 272                                 nonstop_tsc ? "yes":"no");
 273                 break;
 274         }
 275
 276         fclose(stream);
 277 }
 278
 279 static int
 280 set_tsc_freq_from_clock(void)
 281 {
 282 #ifdef CLOCK_MONOTONIC_RAW
 283 #define NS_PER_SEC 1E9
 284
 285         struct timespec sleeptime = {.tv_nsec = 5E8 }; /* 1/2 second */
 286
 287         struct timespec t_start, t_end;
 288
 289         if (clock_gettime(CLOCK_MONOTONIC_RAW, &t_start) == 0) {
 290                 uint64_t ns, end, start = rte_rdtsc();
 291                 nanosleep(&sleeptime,NULL);
 292                 clock_gettime(CLOCK_MONOTONIC_RAW, &t_end);
 293                 end = rte_rdtsc();
 294                 ns = ((t_end.tv_sec - t_start.tv_sec) * NS_PER_SEC);
 295                 ns += (t_end.tv_nsec - t_start.tv_nsec);
 296
 297                 double secs = (double)ns/NS_PER_SEC;
 298                 eal_tsc_resolution_hz = (uint64_t)((end - start)/secs);
 299                 return 0;
 300         }
 301 #endif
 302         return -1;
 303 }
 304
 305 static void
 306 set_tsc_freq_fallback(void)
 307 {
 308         RTE_LOG(WARNING, EAL, "WARNING: clock_gettime cannot use "
 309                         "CLOCK_MONOTONIC_RAW and HPET is not available"
 310                         " - clock timings may be less accurate.\n");
 311         /* assume that the sleep(1) will sleep for 1 second */
 312         uint64_t start = rte_rdtsc();
 313         sleep(1);
 314         eal_tsc_resolution_hz = rte_rdtsc() - start;
 315 }
 316 /*
 317  * This function measures the TSC frequency. It uses a variety of approaches.
 318  *
 319  * 1. If kernel provides CLOCK_MONOTONIC_RAW we use that to tune the TSC value
 320  * 2. If kernel does not provide that, and we have HPET support, tune using HPET
 321  * 3. Lastly, if neither of the above can be used, just sleep for 1 second and
 322  * tune off that, printing a warning about inaccuracy of timing
 323  */
 324 static void
 325 set_tsc_freq(void)
 326 {
 327         if (set_tsc_freq_from_clock() < 0)
 328                 set_tsc_freq_fallback();
 329
 330         RTE_LOG(INFO, EAL, "TSC frequency is ~%"PRIu64" KHz\n",
 331                         eal_tsc_resolution_hz/1000);
 332 }
 333
 334 int
 335 rte_eal_timer_init(void)
 336 {
 337
 338         eal_timer_source = EAL_TIMER_TSC;
 339
 340         set_tsc_freq();
 341         check_tsc_flags();
 342         return 0;
 343 }