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.
35 * Copyright(c) 2013 6WIND.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
41 * * Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * * Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in
45 * the documentation and/or other materials provided with the
47 * * Neither the name of 6WIND S.A. nor the names of its
48 * contributors may be used to endorse or promote products derived
49 * from this software without specific prior written permission.
51 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
57 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
61 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64 #ifndef _RTE_CYCLES_H_
65 #define _RTE_CYCLES_H_
70 * Simple Time Reference Functions (Cycles and HPET).
78 #include <rte_debug.h>
79 #include <rte_atomic.h>
81 #ifdef RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT
82 /** Global switch to use VMWARE mapping of TSC instead of RDTSC */
83 extern int rte_cycles_vmware_tsc_map;
84 #include <rte_branch_prediction.h>
88 #define US_PER_S 1000000
89 #define NS_PER_S 1000000000
95 extern enum timer_source eal_timer_source;
98 * Read the TSC register.
101 * The TSC for this lcore.
103 static inline uint64_t
114 #ifdef RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT
115 if (unlikely(rte_cycles_vmware_tsc_map)) {
116 /* ecx = 0x10000 corresponds to the physical TSC for VMware */
117 asm volatile("rdpmc" :
125 asm volatile("rdtsc" :
132 * Read the TSC register precisely where function is called.
135 * The TSC for this lcore.
137 static inline uint64_t
138 rte_rdtsc_precise(void)
145 * Get the measured frequency of the RDTSC counter
148 * The TSC frequency for this lcore
151 rte_get_tsc_hz(void);
154 * Return the number of TSC cycles since boot
157 * the number of cycles
159 static inline uint64_t
160 rte_get_tsc_cycles(void) { return rte_rdtsc(); }
162 #ifdef RTE_LIBEAL_USE_HPET
164 * Return the number of HPET cycles since boot
166 * This counter is global for all execution units. The number of
167 * cycles in one second can be retrieved using rte_get_hpet_hz().
170 * the number of cycles
173 rte_get_hpet_cycles(void);
176 * Get the number of HPET cycles in one second.
179 * The number of cycles in one second.
182 rte_get_hpet_hz(void);
185 * Initialise the HPET for use. This must be called before the rte_get_hpet_hz
186 * and rte_get_hpet_cycles APIs are called. If this function does not succeed,
187 * then the HPET functions are unavailable and should not be called.
189 * @param make_default
190 * If set, the hpet timer becomes the default timer whose values are
191 * returned by the rte_get_timer_hz/cycles API calls
195 * -1 on error, and the make_default parameter is ignored.
197 int rte_eal_hpet_init(int make_default);
202 * Get the number of cycles since boot from the default timer.
205 * The number of cycles
207 static inline uint64_t
208 rte_get_timer_cycles(void)
210 switch(eal_timer_source) {
214 #ifdef RTE_LIBEAL_USE_HPET
215 return rte_get_hpet_cycles();
217 default: rte_panic("Invalid timer source specified\n");
222 * Get the number of cycles in one second for the default timer.
225 * The number of cycles in one second.
227 static inline uint64_t
228 rte_get_timer_hz(void)
230 switch(eal_timer_source) {
232 return rte_get_tsc_hz();
234 #ifdef RTE_LIBEAL_USE_HPET
235 return rte_get_hpet_hz();
237 default: rte_panic("Invalid timer source specified\n");
242 * Wait at least us microseconds.
245 * The number of microseconds to wait.
248 rte_delay_us(unsigned us);
251 * Wait at least ms milliseconds.
254 * The number of milliseconds to wait.
257 rte_delay_ms(unsigned ms)
259 rte_delay_us(ms * 1000);
266 #endif /* _RTE_CYCLES_H_ */