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