lib/librte_eal/common/include/generic/rte_cycles.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  */
  33 /*   BSD LICENSE
  34  *
  35  *   Copyright(c) 2013 6WIND.
  36  *
  37  *   Redistribution and use in source and binary forms, with or without
  38  *   modification, are permitted provided that the following conditions
  39  *   are met:
  40  *
  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
  46  *       distribution.
  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.
  50  *
  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.
  62  */
  63
  64 #ifndef _RTE_CYCLES_H_
  65 #define _RTE_CYCLES_H_
  66
  67 /**
  68  * @file
  69  *
  70  * Simple Time Reference Functions (Cycles and HPET).
  71  */
  72
  73 #include <stdint.h>
  74 #include <rte_debug.h>
  75 #include <rte_atomic.h>
  76
  77 #define MS_PER_S 1000
  78 #define US_PER_S 1000000
  79 #define NS_PER_S 1000000000
  80
  81 enum timer_source {
  82         EAL_TIMER_TSC = 0,
  83         EAL_TIMER_HPET
  84 };
  85 extern enum timer_source eal_timer_source;
  86
  87 /**
  88  * Get the measured frequency of the RDTSC counter
  89  *
  90  * @return
  91  *   The TSC frequency for this lcore
  92  */
  93 uint64_t
  94 rte_get_tsc_hz(void);
  95
  96 /**
  97  * Return the number of TSC cycles since boot
  98  *
  99   * @return
 100  *   the number of cycles
 101  */
 102 static inline uint64_t
 103 rte_get_tsc_cycles(void);
 104
 105 #ifdef RTE_LIBEAL_USE_HPET
 106 /**
 107  * Return the number of HPET cycles since boot
 108  *
 109  * This counter is global for all execution units. The number of
 110  * cycles in one second can be retrieved using rte_get_hpet_hz().
 111  *
 112  * @return
 113  *   the number of cycles
 114  */
 115 uint64_t
 116 rte_get_hpet_cycles(void);
 117
 118 /**
 119  * Get the number of HPET cycles in one second.
 120  *
 121  * @return
 122  *   The number of cycles in one second.
 123  */
 124 uint64_t
 125 rte_get_hpet_hz(void);
 126
 127 /**
 128  * Initialise the HPET for use. This must be called before the rte_get_hpet_hz
 129  * and rte_get_hpet_cycles APIs are called. If this function does not succeed,
 130  * then the HPET functions are unavailable and should not be called.
 131  *
 132  * @param make_default
 133  *      If set, the hpet timer becomes the default timer whose values are
 134  *      returned by the rte_get_timer_hz/cycles API calls
 135  *
 136  * @return
 137  *      0 on success,
 138  *      -1 on error, and the make_default parameter is ignored.
 139  */
 140 int rte_eal_hpet_init(int make_default);
 141
 142 #endif
 143
 144 /**
 145  * Get the number of cycles since boot from the default timer.
 146  *
 147  * @return
 148  *   The number of cycles
 149  */
 150 static inline uint64_t
 151 rte_get_timer_cycles(void)
 152 {
 153         switch(eal_timer_source) {
 154         case EAL_TIMER_TSC:
 155                 return rte_get_tsc_cycles();
 156         case EAL_TIMER_HPET:
 157 #ifdef RTE_LIBEAL_USE_HPET
 158                 return rte_get_hpet_cycles();
 159 #endif
 160         default: rte_panic("Invalid timer source specified\n");
 161         }
 162 }
 163
 164 /**
 165  * Get the number of cycles in one second for the default timer.
 166  *
 167  * @return
 168  *   The number of cycles in one second.
 169  */
 170 static inline uint64_t
 171 rte_get_timer_hz(void)
 172 {
 173         switch(eal_timer_source) {
 174         case EAL_TIMER_TSC:
 175                 return rte_get_tsc_hz();
 176         case EAL_TIMER_HPET:
 177 #ifdef RTE_LIBEAL_USE_HPET
 178                 return rte_get_hpet_hz();
 179 #endif
 180         default: rte_panic("Invalid timer source specified\n");
 181         }
 182 }
 183
 184 /**
 185  * Wait at least us microseconds.
 186  *
 187  * @param us
 188  *   The number of microseconds to wait.
 189  */
 190 void
 191 rte_delay_us(unsigned us);
 192
 193 /**
 194  * Wait at least ms milliseconds.
 195  *
 196  * @param ms
 197  *   The number of milliseconds to wait.
 198  */
 199 static inline void
 200 rte_delay_ms(unsigned ms)
 201 {
 202         rte_delay_us(ms * 1000);
 203 }
 204
 205 #endif /* _RTE_CYCLES_H_ */