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_lcore.h>
  51 #include <rte_memory.h>
  52 #include <rte_eal.h>
  53 #include <rte_debug.h>
  54
  55 #include "eal_private.h"
  56 #include "eal_internal_cfg.h"
  57
  58 enum timer_source eal_timer_source = EAL_TIMER_HPET;
  59
  60 #ifdef RTE_LIBEAL_USE_HPET
  61
  62 #define DEV_HPET "/dev/hpet"
  63
  64 /* Maximum number of counters. */
  65 #define HPET_TIMER_NUM 3
  66
  67 /* General capabilities register */
  68 #define CLK_PERIOD_SHIFT     32 /* Clock period shift. */
  69 #define CLK_PERIOD_MASK      0xffffffff00000000ULL /* Clock period mask. */
  70
  71 /**
  72  * HPET timer registers. From the Intel IA-PC HPET (High Precision Event
  73  * Timers) Specification.
  74  */
  75 struct eal_hpet_regs {
  76         /* Memory-mapped, software visible registers */
  77         uint64_t capabilities;      /**< RO General Capabilities Register. */
  78         uint64_t reserved0;         /**< Reserved for future use. */
  79         uint64_t config;            /**< RW General Configuration Register. */
  80         uint64_t reserved1;         /**< Reserved for future use. */
  81         uint64_t isr;               /**< RW Clear General Interrupt Status. */
  82         uint64_t reserved2[25];     /**< Reserved for future use. */
  83         union {
  84                 uint64_t counter;   /**< RW Main Counter Value Register. */
  85                 struct {
  86                         uint32_t counter_l; /**< RW Main Counter Low. */
  87                         uint32_t counter_h; /**< RW Main Counter High. */
  88                 };
  89         };
  90         uint64_t reserved3;         /**< Reserved for future use. */
  91         struct {
  92                 uint64_t config;    /**< RW Timer Config and Capability Reg. */
  93                 uint64_t comp;      /**< RW Timer Comparator Value Register. */
  94                 uint64_t fsb;       /**< RW FSB Interrupt Route Register. */
  95                 uint64_t reserved4; /**< Reserved for future use. */
  96         } timers[HPET_TIMER_NUM]; /**< Set of HPET timers. */
  97 };
  98
  99 /* Mmap'd hpet registers */
 100 static volatile struct eal_hpet_regs *eal_hpet = NULL;
 101
 102 /* Period at which the HPET counter increments in
 103  * femtoseconds (10^-15 seconds). */
 104 static uint32_t eal_hpet_resolution_fs = 0;
 105
 106 /* Frequency of the HPET counter in Hz */
 107 static uint64_t eal_hpet_resolution_hz = 0;
 108
 109 /* Incremented 4 times during one 32bits hpet full count */
 110 static uint32_t eal_hpet_msb;
 111
 112 static pthread_t msb_inc_thread_id;
 113
 114 /*
 115  * This function runs on a specific thread to update a global variable
 116  * containing used to process MSB of the HPET (unfortunately, we need
 117  * this because hpet is 32 bits by default under linux).
 118  */
 119 static void
 120 hpet_msb_inc(__attribute__((unused)) void *arg)
 121 {
 122         uint32_t t;
 123
 124         while (1) {
 125                 t = (eal_hpet->counter_l >> 30);
 126                 if (t != (eal_hpet_msb & 3))
 127                         eal_hpet_msb ++;
 128                 sleep(10);
 129         }
 130 }
 131
 132 uint64_t
 133 rte_get_hpet_hz(void)
 134 {
 135         if(internal_config.no_hpet)
 136                 rte_panic("Error, HPET called, but no HPET present\n");
 137
 138         return eal_hpet_resolution_hz;
 139 }
 140
 141 uint64_t
 142 rte_get_hpet_cycles(void)
 143 {
 144         uint32_t t, msb;
 145         uint64_t ret;
 146
 147         if(internal_config.no_hpet)
 148                 rte_panic("Error, HPET called, but no HPET present\n");
 149
 150         t = eal_hpet->counter_l;
 151         msb = eal_hpet_msb;
 152         ret = (msb + 2 - (t >> 30)) / 4;
 153         ret <<= 32;
 154         ret += t;
 155         return ret;
 156 }
 157
 158 #endif
 159
 160 #ifdef RTE_LIBEAL_USE_HPET
 161 /*
 162  * Open and mmap /dev/hpet (high precision event timer) that will
 163  * provide our time reference.
 164  */
 165 int
 166 rte_eal_hpet_init(int make_default)
 167 {
 168         int fd, ret;
 169         char thread_name[RTE_MAX_THREAD_NAME_LEN];
 170
 171         if (internal_config.no_hpet) {
 172                 RTE_LOG(NOTICE, EAL, "HPET is disabled\n");
 173                 return -1;
 174         }
 175
 176         fd = open(DEV_HPET, O_RDONLY);
 177         if (fd < 0) {
 178                 RTE_LOG(ERR, EAL, "ERROR: Cannot open "DEV_HPET": %s!\n",
 179                         strerror(errno));
 180                 internal_config.no_hpet = 1;
 181                 return -1;
 182         }
 183         eal_hpet = mmap(NULL, 1024, PROT_READ, MAP_SHARED, fd, 0);
 184         if (eal_hpet == MAP_FAILED) {
 185                 RTE_LOG(ERR, EAL, "ERROR: Cannot mmap "DEV_HPET"!\n"
 186                                 "Please enable CONFIG_HPET_MMAP in your kernel configuration "
 187                                 "to allow HPET support.\n"
 188                                 "To run without using HPET, set CONFIG_RTE_LIBEAL_USE_HPET=n "
 189                                 "in your build configuration or use '--no-hpet' EAL flag.\n");
 190                 close(fd);
 191                 internal_config.no_hpet = 1;
 192                 return -1;
 193         }
 194         close(fd);
 195
 196         eal_hpet_resolution_fs = (uint32_t)((eal_hpet->capabilities &
 197                                         CLK_PERIOD_MASK) >>
 198                                         CLK_PERIOD_SHIFT);
 199
 200         eal_hpet_resolution_hz = (1000ULL*1000ULL*1000ULL*1000ULL*1000ULL) /
 201                 (uint64_t)eal_hpet_resolution_fs;
 202
 203         RTE_LOG(INFO, EAL, "HPET frequency is ~%"PRIu64" kHz\n",
 204                         eal_hpet_resolution_hz/1000);
 205
 206         eal_hpet_msb = (eal_hpet->counter_l >> 30);
 207
 208         /* create a thread that will increment a global variable for
 209          * msb (hpet is 32 bits by default under linux) */
 210         ret = pthread_create(&msb_inc_thread_id, NULL,
 211                         (void *(*)(void *))hpet_msb_inc, NULL);
 212         if (ret != 0) {
 213                 RTE_LOG(ERR, EAL, "ERROR: Cannot create HPET timer thread!\n");
 214                 internal_config.no_hpet = 1;
 215                 return -1;
 216         }
 217
 218         /*
 219          * Set thread_name for aid in debugging.
 220          */
 221         snprintf(thread_name, RTE_MAX_THREAD_NAME_LEN, "hpet-msb-inc");
 222         ret = rte_thread_setname(msb_inc_thread_id, thread_name);
 223         if (ret != 0)
 224                 RTE_LOG(DEBUG, EAL,
 225                         "Cannot set HPET timer thread name!\n");
 226
 227         if (make_default)
 228                 eal_timer_source = EAL_TIMER_HPET;
 229         return 0;
 230 }
 231 #endif
 232
 233 static void
 234 check_tsc_flags(void)
 235 {
 236         char line[512];
 237         FILE *stream;
 238
 239         stream = fopen("/proc/cpuinfo", "r");
 240         if (!stream) {
 241                 RTE_LOG(WARNING, EAL, "WARNING: Unable to open /proc/cpuinfo\n");
 242                 return;
 243         }
 244
 245         while (fgets(line, sizeof line, stream)) {
 246                 char *constant_tsc;
 247                 char *nonstop_tsc;
 248
 249                 if (strncmp(line, "flags", 5) != 0)
 250                         continue;
 251
 252                 constant_tsc = strstr(line, "constant_tsc");
 253                 nonstop_tsc = strstr(line, "nonstop_tsc");
 254                 if (!constant_tsc || !nonstop_tsc)
 255                         RTE_LOG(WARNING, EAL,
 256                                 "WARNING: cpu flags "
 257                                 "constant_tsc=%s "
 258                                 "nonstop_tsc=%s "
 259                                 "-> using unreliable clock cycles !\n",
 260                                 constant_tsc ? "yes":"no",
 261                                 nonstop_tsc ? "yes":"no");
 262                 break;
 263         }
 264
 265         fclose(stream);
 266 }
 267
 268 uint64_t
 269 get_tsc_freq(void)
 270 {
 271 #ifdef CLOCK_MONOTONIC_RAW
 272 #define NS_PER_SEC 1E9
 273
 274         struct timespec sleeptime = {.tv_nsec = NS_PER_SEC / 10 }; /* 1/10 second */
 275
 276         struct timespec t_start, t_end;
 277         uint64_t tsc_hz;
 278
 279         if (clock_gettime(CLOCK_MONOTONIC_RAW, &t_start) == 0) {
 280                 uint64_t ns, end, start = rte_rdtsc();
 281                 nanosleep(&sleeptime,NULL);
 282                 clock_gettime(CLOCK_MONOTONIC_RAW, &t_end);
 283                 end = rte_rdtsc();
 284                 ns = ((t_end.tv_sec - t_start.tv_sec) * NS_PER_SEC);
 285                 ns += (t_end.tv_nsec - t_start.tv_nsec);
 286
 287                 double secs = (double)ns/NS_PER_SEC;
 288                 tsc_hz = (uint64_t)((end - start)/secs);
 289                 return tsc_hz;
 290         }
 291 #endif
 292         return 0;
 293 }
 294
 295 int
 296 rte_eal_timer_init(void)
 297 {
 298
 299         eal_timer_source = EAL_TIMER_TSC;
 300
 301         set_tsc_freq();
 302         check_tsc_flags();
 303         return 0;
 304 }