FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
time.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
17 
18  Permission is hereby granted, free of charge, to any person obtaining
19  a copy of this software and associated documentation files (the
20  "Software"), to deal in the Software without restriction, including
21  without limitation the rights to use, copy, modify, merge, publish,
22  distribute, sublicense, and/or sell copies of the Software, and to
23  permit persons to whom the Software is furnished to do so, subject to
24  the following conditions:
25 
26  The above copyright notice and this permission notice shall be
27  included in all copies or substantial portions of the Software.
28 
29  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 */
37 
38 #ifndef included_time_h
39 #define included_time_h
40 
41 #include <vppinfra/clib.h>
42 
43 typedef struct
44 {
45  /* Total run time in clock cycles
46  since clib_time_init call. */
48 
49  /* Last recorded time stamp. */
51 
52  /* CPU clock frequency. */
54 
55  /* 1 / cpu clock frequency: conversion factor
56  from clock cycles into seconds. */
58 
60 
61  /* Time stamp of call to clib_time_init call. */
63 
65 
66  /* Same but for reference time (if present). */
68 
69  u32 log2_clocks_per_second, log2_clocks_per_frequency_verify;
70 } clib_time_t;
71 
72 /* Return CPU time stamp as 64bit number. */
73 #if defined(__x86_64__) || defined(i386)
76 {
77  u32 a, d;
78  asm volatile ("rdtsc":"=a" (a), "=d" (d));
79  return (u64) a + ((u64) d << (u64) 32);
80 }
81 
82 #elif defined (__powerpc64__)
83 
85 clib_cpu_time_now (void)
86 {
87  u64 t;
88  asm volatile ("mftb %0":"=r" (t));
89  return t;
90 }
91 
92 #elif defined (__SPU__)
93 
95 clib_cpu_time_now (void)
96 {
97 #ifdef _XLC
98  return spu_rdch (0x8);
99 #else
100  return 0 /* __builtin_si_rdch (0x8) FIXME */ ;
101 #endif
102 }
103 
104 #elif defined (__powerpc__)
105 
107 clib_cpu_time_now (void)
108 {
109  u32 hi1, hi2, lo;
110  asm volatile ("1:\n"
111  "mftbu %[hi1]\n"
112  "mftb %[lo]\n"
113  "mftbu %[hi2]\n"
114  "cmpw %[hi1],%[hi2]\n"
115  "bne 1b\n":[hi1] "=r" (hi1),[hi2] "=r" (hi2),[lo] "=r" (lo));
116  return (u64) lo + ((u64) hi2 << (u64) 32);
117 }
118 
119 #elif defined (__aarch64__)
121 clib_cpu_time_now (void)
122 {
123  u64 vct;
124  /* User access to cntvct_el0 is enabled in Linux kernel since 3.12. */
125  asm volatile ("mrs %0, cntvct_el0":"=r" (vct));
126  return vct;
127 }
128 
129 #elif defined (__arm__)
130 #if defined(__ARM_ARCH_8A__)
132 clib_cpu_time_now (void) /* We may run arm64 in aarch32 mode, to leverage 64bit counter */
133 {
134  u64 tsc;
135  asm volatile ("mrrc p15, 0, %Q0, %R0, c9":"=r" (tsc));
136  return tsc;
137 }
138 #elif defined(__ARM_ARCH_7A__)
140 clib_cpu_time_now (void)
141 {
142  u32 tsc;
143  asm volatile ("mrc p15, 0, %0, c9, c13, 0":"=r" (tsc));
144  return (u64) tsc;
145 }
146 #else
148 clib_cpu_time_now (void)
149 {
150  u32 lo;
151  asm volatile ("mrc p15, 0, %[lo], c15, c12, 1":[lo] "=r" (lo));
152  return (u64) lo;
153 }
154 #endif
155 
156 #elif defined (__xtensa__)
157 
158 /* Stub for now. */
160 clib_cpu_time_now (void)
161 {
162  return 0;
163 }
164 
165 #elif defined (__TMS320C6X__)
166 
168 clib_cpu_time_now (void)
169 {
170  u32 l, h;
171 
172  asm volatile (" dint\n"
173  " mvc .s2 TSCL,%0\n"
174  " mvc .s2 TSCH,%1\n" " rint\n":"=b" (l), "=b" (h));
175 
176  return ((u64) h << 32) | l;
177 }
178 
179 #elif defined(_mips) && __mips == 64
180 
182 clib_cpu_time_now (void)
183 {
184  u64 result;
185  asm volatile ("rdhwr %0,$31\n":"=r" (result));
186  return result;
187 }
188 
189 #else
190 #error "don't know how to read CPU time stamp"
191 
192 #endif
193 
195 
196 /* Define it as the type returned by clib_time_now */
199 
200 #define CLIB_US_TIME_PERIOD (1e-6)
201 #define CLIB_US_TIME_FREQ (1.0/CLIB_US_TIME_PERIOD)
202 
205 {
206  u64 l = c->last_cpu_time;
207  u64 t = c->total_cpu_time;
208  f64 rv;
209  t += n - l;
210  c->total_cpu_time = t;
211  c->last_cpu_time = n;
212  rv = t * c->seconds_per_clock;
213  if (PREDICT_FALSE
214  ((c->last_cpu_time -
217  return rv;
218 }
219 
220 /* Maximum f64 value as max clib_time */
221 #define CLIB_TIME_MAX (1.7976931348623157e+308)
222 
225 {
227 }
228 
229 always_inline void
231 {
232  u64 t_end = clib_cpu_time_now () + dt;
233  while (clib_cpu_time_now () < t_end)
234  ;
235 }
236 
237 void clib_time_init (clib_time_t * c);
238 
239 #ifdef CLIB_UNIX
240 
241 #include <time.h>
242 #include <sys/time.h>
243 #include <sys/resource.h>
244 #include <unistd.h>
245 #include <sys/syscall.h>
246 
247 /* Use 64bit floating point to represent time offset from epoch. */
250 {
251  struct timespec ts;
252 #ifdef __MACH__
253  clock_gettime (CLOCK_REALTIME, &ts);
254 #else
255  /* clock_gettime without indirect syscall uses GLIBC wrappers which
256  we don't want. Just the bare metal, please. */
257  syscall (SYS_clock_gettime, CLOCK_REALTIME, &ts);
258 #endif
259  return ts.tv_sec + 1e-9 * ts.tv_nsec;
260 }
261 
262 /* As above but integer number of nano-seconds. */
265 {
266  struct timespec ts;
267 #ifdef __MACH__
268  clock_gettime (CLOCK_REALTIME, &ts);
269 #else
270  syscall (SYS_clock_gettime, CLOCK_REALTIME, &ts);
271 #endif
272  return 1e9 * ts.tv_sec + ts.tv_nsec;
273 }
274 
275 always_inline void
277 {
278  struct timespec ts;
279 #ifdef __MACH__
280  clock_gettime (CLOCK_REALTIME, &ts);
281 #else
282  syscall (SYS_clock_gettime, CLOCK_REALTIME, &ts);
283 #endif
284  *sec = ts.tv_sec;
285  *nsec = ts.tv_nsec;
286 }
287 
290 {
291  struct rusage u;
292  getrusage (RUSAGE_SELF, &u);
293  return u.ru_utime.tv_sec + 1e-6 * u.ru_utime.tv_usec
294  + u.ru_stime.tv_sec + 1e-6 * u.ru_stime.tv_usec;
295 }
296 
297 always_inline void
299 {
300  struct timespec ts, tsrem;
301  ts.tv_sec = dt;
302  ts.tv_nsec = 1e9 * (dt - (f64) ts.tv_sec);
303 
304  while (nanosleep (&ts, &tsrem) < 0)
305  ts = tsrem;
306 }
307 
308 #else /* ! CLIB_UNIX */
309 
311 unix_time_now (void)
312 {
313  return 0;
314 }
315 
317 unix_time_now_nsec (void)
318 {
319  return 0;
320 }
321 
322 always_inline void
323 unix_time_now_nsec_fraction (u32 * sec, u32 * nsec)
324 {
325 }
326 
328 unix_usage_now (void)
329 {
330  return 0;
331 }
332 
333 always_inline void
334 unix_sleep (f64 dt)
335 {
336 }
337 
338 #endif
339 
340 #endif /* included_time_h */
341 
342 /*
343  * fd.io coding-style-patch-verification: ON
344  *
345  * Local Variables:
346  * eval: (c-set-style "gnu")
347  * End:
348  */
f64 clib_time_type_t
Definition: time.h:197
a
Definition: bitmap.h:538
static void clib_cpu_time_wait(u64 dt)
Definition: time.h:230
unsigned long u64
Definition: types.h:89
void clib_time_verify_frequency(clib_time_t *c)
Definition: time.c:194
f64 clocks_per_second
Definition: time.h:53
static f64 clib_time_now(clib_time_t *c)
Definition: time.h:224
static u64 clib_cpu_time_now(void)
Definition: time.h:75
u32 log2_clocks_per_second
Definition: time.h:69
u64 last_verify_cpu_time
Definition: time.h:64
double f64
Definition: types.h:142
static void unix_sleep(f64 dt)
Definition: time.h:298
static f64 unix_time_now(void)
Definition: time.h:249
unsigned int u32
Definition: types.h:88
static void unix_time_now_nsec_fraction(u32 *sec, u32 *nsec)
Definition: time.h:276
lo
u32 log2_clocks_per_frequency_verify
Definition: time.h:69
#define PREDICT_FALSE(x)
Definition: clib.h:111
#define always_inline
Definition: ipsec.h:28
f64 seconds_per_clock
Definition: time.h:57
u64 total_cpu_time
Definition: time.h:47
static u64 unix_time_now_nsec(void)
Definition: time.h:264
static f64 unix_usage_now(void)
Definition: time.h:289
u64 last_cpu_time
Definition: time.h:50
f64 last_verify_reference_time
Definition: time.h:67
static f64 clib_time_now_internal(clib_time_t *c, u64 n)
Definition: time.h:204
u64 init_cpu_time
Definition: time.h:62
#define SYS_clock_gettime
void clib_time_init(clib_time_t *c)
Definition: time.c:178
u64 clib_us_time_t
Definition: time.h:198
f64 round_to_units
Definition: time.h:59