lib/librte_eal/common/include/rte_cycles.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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  *  version: DPDK.L.1.2.3-3
  34  */
  35
  36 #ifndef _RTE_CYCLES_H_
  37 #define _RTE_CYCLES_H_
  38
  39 /**
  40  * @file
  41  *
  42  * Simple Time Reference Functions (Cycles and HPET).
  43  */
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 #include <stdint.h>
  50
  51 /**
  52  * Read the TSC register.
  53  *
  54  * @return
  55  *   The TSC for this lcore.
  56  */
  57 static inline uint64_t
  58 rte_rdtsc(void)
  59 {
  60         union {
  61                 uint64_t tsc_64;
  62                 struct {
  63                         uint32_t lo_32;
  64                         uint32_t hi_32;
  65                 };
  66         } tsc;
  67
  68         asm volatile("rdtsc" :
  69                      "=a" (tsc.lo_32),
  70                      "=d" (tsc.hi_32));
  71         return tsc.tsc_64;
  72 }
  73
  74 /**
  75  * Return the number of HPET cycles since boot
  76  *
  77  * This counter is global for all execution units. The number of
  78  * cycles in one second can be retrived using rte_get_hpet_hz().
  79  *
  80  * @return
  81  *   the number of cycles
  82  */
  83 uint64_t
  84 rte_get_hpet_cycles(void);
  85
  86 /**
  87  * Get the number of cycles in one second.
  88  *
  89  * @return
  90  *   The number of cycles in one second.
  91  */
  92 uint64_t
  93 rte_get_hpet_hz(void);
  94
  95 /**
  96  * Wait at least us microseconds.
  97  *
  98  * @param us
  99  *   The number of microseconds to wait.
 100  */
 101 void
 102 rte_delay_us(unsigned us);
 103
 104 /**
 105  * Wait at least ms milliseconds.
 106  *
 107  * @param ms
 108  *   The number of milliseconds to wait.
 109  */
 110 static inline void
 111 rte_delay_ms(unsigned ms)
 112 {
 113         rte_delay_us(ms * 1000);
 114 }
 115
 116 #ifdef __cplusplus
 117 }
 118 #endif
 119
 120 #endif /* _RTE_CYCLES_H_ */