3163496d65edf8a9d80fe6fc92ce9dc013cb4e6f
[dpdk.git] / lib / librte_eal / bsdapp / eal / eal_timer.c
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 #include <string.h>
34 #include <stdio.h>
35 #include <unistd.h>
36 #include <inttypes.h>
37 #include <sys/types.h>
38 #include <sys/sysctl.h>
39 #include <errno.h>
40
41 #include <rte_common.h>
42 #include <rte_log.h>
43 #include <rte_cycles.h>
44 #include <rte_tailq.h>
45 #include <rte_memory.h>
46 #include <rte_memzone.h>
47 #include <rte_eal.h>
48 #include <rte_debug.h>
49
50 #include "eal_private.h"
51 #include "eal_internal_cfg.h"
52
53 #ifdef RTE_LIBEAL_USE_HPET
54 #warning HPET is not supported in FreeBSD
55 #endif
56
57 enum timer_source eal_timer_source = EAL_TIMER_TSC;
58
59 /* The frequency of the RDTSC timer resolution */
60 static uint64_t eal_tsc_resolution_hz = 0;
61
62 void
63 rte_delay_us(unsigned us)
64 {
65         const uint64_t start = rte_get_timer_cycles();
66         const uint64_t ticks = (uint64_t)us * rte_get_timer_hz() / 1E6;
67         while ((rte_get_timer_cycles() - start) < ticks)
68                 rte_pause();
69 }
70
71 uint64_t
72 rte_get_tsc_hz(void)
73 {
74         return eal_tsc_resolution_hz;
75 }
76
77 static int
78 set_tsc_freq_from_sysctl(void)
79 {
80         size_t sz;
81         int tmp;
82
83         sz = sizeof(tmp);
84         tmp = 0;
85
86         if (sysctlbyname("kern.timecounter.smp_tsc", &tmp, &sz, NULL, 0))
87                 RTE_LOG(WARNING, EAL, "%s\n", strerror(errno));
88         else if (tmp != 1)
89                 RTE_LOG(WARNING, EAL, "TSC is not safe to use in SMP mode\n");
90
91         tmp = 0;
92
93         if (sysctlbyname("kern.timecounter.invariant_tsc", &tmp, &sz, NULL, 0))
94                 RTE_LOG(WARNING, EAL, "%s\n", strerror(errno));
95         else if (tmp != 1)
96                 RTE_LOG(WARNING, EAL, "TSC is not invariant\n");
97
98         sz = sizeof(eal_tsc_resolution_hz);
99         if (sysctlbyname("machdep.tsc_freq", &eal_tsc_resolution_hz, &sz, NULL, 0)) {
100                 RTE_LOG(WARNING, EAL, "%s\n", strerror(errno));
101                 return -1;
102         }
103
104         return 0;
105 }
106
107 static void
108 set_tsc_freq_fallback(void)
109 {
110         RTE_LOG(WARNING, EAL, "WARNING: clock_gettime cannot use "
111                         "CLOCK_MONOTONIC_RAW and HPET is not available"
112                         " - clock timings may be less accurate.\n");
113         /* assume that the sleep(1) will sleep for 1 second */
114         uint64_t start = rte_rdtsc();
115         sleep(1);
116         eal_tsc_resolution_hz = rte_rdtsc() - start;
117 }
118
119 /*
120  * This function measures the TSC frequency. It uses a variety of approaches.
121  *
122  * 1. Read the TSC frequency value provided by the kernel
123  * 2. If above does not work, just sleep for 1 second and tune off that,
124  *    printing a warning about inaccuracy of timing
125  */
126 static void
127 set_tsc_freq(void)
128 {
129         if (set_tsc_freq_from_sysctl() < 0)
130                 set_tsc_freq_fallback();
131
132         RTE_LOG(INFO, EAL, "TSC frequency is ~%"PRIu64" KHz\n",
133                         eal_tsc_resolution_hz/1000);
134 }
135
136 int
137 rte_eal_timer_init(void)
138 {
139         set_tsc_freq();
140         return 0;
141 }