4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 #include <sys/queue.h>
46 #include <rte_common.h>
48 #include <rte_cycles.h>
49 #include <rte_tailq.h>
50 #include <rte_memory.h>
51 #include <rte_memzone.h>
53 #include <rte_debug.h>
55 #include "eal_private.h"
56 #include "eal_internal_cfg.h"
58 enum timer_source eal_timer_source = EAL_TIMER_HPET;
60 /* The frequency of the RDTSC timer resolution */
61 static uint64_t eal_tsc_resolution_hz = 0;
63 #ifdef RTE_LIBEAL_USE_HPET
65 #define DEV_HPET "/dev/hpet"
67 /* Maximum number of counters. */
68 #define HPET_TIMER_NUM 3
70 /* General capabilities register */
71 #define CLK_PERIOD_SHIFT 32 /* Clock period shift. */
72 #define CLK_PERIOD_MASK 0xffffffff00000000ULL /* Clock period mask. */
75 * HPET timer registers. From the Intel IA-PC HPET (High Precision Event
76 * Timers) Specification.
78 struct eal_hpet_regs {
79 /* Memory-mapped, software visible registers */
80 uint64_t capabilities; /**< RO General Capabilities Register. */
81 uint64_t reserved0; /**< Reserved for future use. */
82 uint64_t config; /**< RW General Configuration Register. */
83 uint64_t reserved1; /**< Reserved for future use. */
84 uint64_t isr; /**< RW Clear General Interrupt Status. */
85 uint64_t reserved2[25]; /**< Reserved for future use. */
87 uint64_t counter; /**< RW Main Counter Value Register. */
89 uint32_t counter_l; /**< RW Main Counter Low. */
90 uint32_t counter_h; /**< RW Main Counter High. */
93 uint64_t reserved3; /**< Reserved for future use. */
95 uint64_t config; /**< RW Timer Config and Capability Reg. */
96 uint64_t comp; /**< RW Timer Comparator Value Register. */
97 uint64_t fsb; /**< RW FSB Interrupt Route Register. */
98 uint64_t reserved4; /**< Reserved for future use. */
99 } timers[HPET_TIMER_NUM]; /**< Set of HPET timers. */
102 /* Mmap'd hpet registers */
103 static volatile struct eal_hpet_regs *eal_hpet = NULL;
105 /* Period at which the HPET counter increments in
106 * femtoseconds (10^-15 seconds). */
107 static uint32_t eal_hpet_resolution_fs = 0;
109 /* Frequency of the HPET counter in Hz */
110 static uint64_t eal_hpet_resolution_hz = 0;
112 /* Incremented 4 times during one 32bits hpet full count */
113 static uint32_t eal_hpet_msb;
115 static pthread_t msb_inc_thread_id;
118 * This function runs on a specific thread to update a global variable
119 * containing used to process MSB of the HPET (unfortunatelly, we need
120 * this because hpet is 32 bits by default under linux).
123 hpet_msb_inc(__attribute__((unused)) void *arg)
128 t = (eal_hpet->counter_l >> 30);
129 if (t != (eal_hpet_msb & 3))
136 rte_get_hpet_hz(void)
138 if(internal_config.no_hpet)
139 rte_panic("Error, HPET called, but no HPET present\n");
141 return eal_hpet_resolution_hz;
145 rte_get_hpet_cycles(void)
150 if(internal_config.no_hpet)
151 rte_panic("Error, HPET called, but no HPET present\n");
153 t = eal_hpet->counter_l;
155 ret = (msb + 2 - (t >> 30)) / 4;
165 rte_delay_us(unsigned us)
167 const uint64_t start = rte_get_timer_cycles();
168 const uint64_t ticks = (uint64_t)us * rte_get_timer_hz() / 1E6;
169 while ((rte_get_timer_cycles() - start) < ticks)
176 return eal_tsc_resolution_hz;
180 #ifdef RTE_LIBEAL_USE_HPET
182 * Open and mmap /dev/hpet (high precision event timer) that will
183 * provide our time reference.
186 rte_eal_hpet_init(int make_default)
190 if (internal_config.no_hpet) {
191 RTE_LOG(INFO, EAL, "HPET is disabled\n");
195 fd = open(DEV_HPET, O_RDONLY);
197 RTE_LOG(ERR, EAL, "ERROR: Cannot open "DEV_HPET": %s!\n",
199 internal_config.no_hpet = 1;
202 eal_hpet = mmap(NULL, 1024, PROT_READ, MAP_SHARED, fd, 0);
203 if (eal_hpet == MAP_FAILED) {
204 RTE_LOG(ERR, EAL, "ERROR: Cannot mmap "DEV_HPET"!\n"
205 "Please enable CONFIG_HPET_MMAP in your kernel configuration "
206 "to allow HPET support.\n"
207 "To run without using HPET, set CONFIG_RTE_LIBEAL_USE_HPET=n "
208 "in your build configuration or use '--no-hpet' EAL flag.\n");
210 internal_config.no_hpet = 1;
215 eal_hpet_resolution_fs = (uint32_t)((eal_hpet->capabilities &
219 eal_hpet_resolution_hz = (1000ULL*1000ULL*1000ULL*1000ULL*1000ULL) /
220 (uint64_t)eal_hpet_resolution_fs;
222 RTE_LOG(INFO, EAL, "HPET frequency is ~%"PRIu64" kHz\n",
223 eal_hpet_resolution_hz/1000);
225 eal_hpet_msb = (eal_hpet->counter_l >> 30);
227 /* create a thread that will increment a global variable for
228 * msb (hpet is 32 bits by default under linux) */
229 ret = pthread_create(&msb_inc_thread_id, NULL,
230 (void *(*)(void *))hpet_msb_inc, NULL);
232 RTE_LOG(ERR, EAL, "ERROR: Cannot create HPET timer thread!\n");
233 internal_config.no_hpet = 1;
238 eal_timer_source = EAL_TIMER_HPET;
244 set_tsc_freq_from_clock(void)
246 #ifdef CLOCK_MONOTONIC_RAW
247 #define NS_PER_SEC 1E9
249 struct timespec sleeptime = {.tv_nsec = 5E8 }; /* 1/2 second */
251 struct timespec t_start, t_end;
253 if (clock_gettime(CLOCK_MONOTONIC_RAW, &t_start) == 0) {
254 uint64_t ns, end, start = rte_rdtsc();
255 nanosleep(&sleeptime,NULL);
256 clock_gettime(CLOCK_MONOTONIC_RAW, &t_end);
258 ns = ((t_end.tv_sec - t_start.tv_sec) * NS_PER_SEC);
259 ns += (t_end.tv_nsec - t_start.tv_nsec);
261 double secs = (double)ns/NS_PER_SEC;
262 eal_tsc_resolution_hz = (uint64_t)((end - start)/secs);
270 set_tsc_freq_fallback(void)
272 RTE_LOG(WARNING, EAL, "WARNING: clock_gettime cannot use "
273 "CLOCK_MONOTONIC_RAW and HPET is not available"
274 " - clock timings may be less accurate.\n");
275 /* assume that the sleep(1) will sleep for 1 second */
276 uint64_t start = rte_rdtsc();
278 eal_tsc_resolution_hz = rte_rdtsc() - start;
281 * This function measures the TSC frequency. It uses a variety of approaches.
283 * 1. If kernel provides CLOCK_MONOTONIC_RAW we use that to tune the TSC value
284 * 2. If kernel does not provide that, and we have HPET support, tune using HPET
285 * 3. Lastly, if neither of the above can be used, just sleep for 1 second and
286 * tune off that, printing a warning about inaccuracy of timing
291 if (set_tsc_freq_from_clock() < 0)
292 set_tsc_freq_fallback();
294 RTE_LOG(INFO, EAL, "TSC frequency is ~%"PRIu64" KHz\n",
295 eal_tsc_resolution_hz/1000);
299 rte_eal_timer_init(void)
302 eal_timer_source = EAL_TIMER_TSC;