revalidator: Fix ukey stats cache updating.
[sliver-openvswitch.git] / lib / timeval.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #include "timeval.h"
19 #include <errno.h>
20 #include <poll.h>
21 #include <pthread.h>
22 #include <signal.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <sys/time.h>
26 #include <sys/resource.h>
27 #include <unistd.h>
28 #include "coverage.h"
29 #include "dummy.h"
30 #include "dynamic-string.h"
31 #include "fatal-signal.h"
32 #include "hash.h"
33 #include "hmap.h"
34 #include "ovs-rcu.h"
35 #include "ovs-thread.h"
36 #include "signals.h"
37 #include "seq.h"
38 #include "unixctl.h"
39 #include "util.h"
40 #include "vlog.h"
41
42 VLOG_DEFINE_THIS_MODULE(timeval);
43
44 #ifdef _WIN32
45 typedef unsigned int clockid_t;
46
47 #ifndef CLOCK_MONOTONIC
48 #define CLOCK_MONOTONIC 1
49 #endif
50
51 #ifndef CLOCK_REALTIME
52 #define CLOCK_REALTIME 2
53 #endif
54
55 /* Number of 100 ns intervals from January 1, 1601 till January 1, 1970. */
56 static ULARGE_INTEGER unix_epoch;
57 #endif /* _WIN32 */
58
59 struct clock {
60     clockid_t id;               /* CLOCK_MONOTONIC or CLOCK_REALTIME. */
61
62     /* Features for use by unit tests.  Protected by 'mutex'. */
63     struct ovs_mutex mutex;
64     atomic_bool slow_path;             /* True if warped or stopped. */
65     struct timespec warp OVS_GUARDED;  /* Offset added for unit tests. */
66     bool stopped OVS_GUARDED;          /* Disable real-time updates if true. */
67     struct timespec cache OVS_GUARDED; /* Last time read from kernel. */
68 };
69
70 /* Our clocks. */
71 static struct clock monotonic_clock; /* CLOCK_MONOTONIC, if available. */
72 static struct clock wall_clock;      /* CLOCK_REALTIME. */
73
74 /* The monotonic time at which the time module was initialized. */
75 static long long int boot_time;
76
77 /* True only when timeval_dummy_register() is called. */
78 static bool timewarp_enabled;
79 /* Reference to the seq struct.  Threads other than main thread can
80  * wait on timewarp_seq and be waken up when time is warped. */
81 static struct seq *timewarp_seq;
82 /* Last value of 'timewarp_seq'. */
83 DEFINE_STATIC_PER_THREAD_DATA(uint64_t, last_seq, 0);
84
85 /* Monotonic time in milliseconds at which to die with SIGALRM (if not
86  * LLONG_MAX). */
87 static long long int deadline = LLONG_MAX;
88
89 /* Monotonic time, in milliseconds, at which the last call to time_poll() woke
90  * up. */
91 DEFINE_STATIC_PER_THREAD_DATA(long long int, last_wakeup, 0);
92
93 static void log_poll_interval(long long int last_wakeup);
94 static struct rusage *get_recent_rusage(void);
95 static void refresh_rusage(void);
96 static void timespec_add(struct timespec *sum,
97                          const struct timespec *a, const struct timespec *b);
98
99 static void
100 init_clock(struct clock *c, clockid_t id)
101 {
102     memset(c, 0, sizeof *c);
103     c->id = id;
104     ovs_mutex_init(&c->mutex);
105     atomic_init(&c->slow_path, false);
106     xclock_gettime(c->id, &c->cache);
107     timewarp_seq = seq_create();
108 }
109
110 static void
111 do_init_time(void)
112 {
113     struct timespec ts;
114
115 #ifdef _WIN32
116     /* Calculate number of 100-nanosecond intervals till 01/01/1970. */
117     SYSTEMTIME unix_epoch_st = { 1970, 1, 0, 1, 0, 0, 0, 0};
118     FILETIME unix_epoch_ft;
119
120     SystemTimeToFileTime(&unix_epoch_st, &unix_epoch_ft);
121     unix_epoch.LowPart = unix_epoch_ft.dwLowDateTime;
122     unix_epoch.HighPart = unix_epoch_ft.dwHighDateTime;
123 #endif
124
125     coverage_init();
126
127     init_clock(&monotonic_clock, (!clock_gettime(CLOCK_MONOTONIC, &ts)
128                                   ? CLOCK_MONOTONIC
129                                   : CLOCK_REALTIME));
130     init_clock(&wall_clock, CLOCK_REALTIME);
131     boot_time = timespec_to_msec(&monotonic_clock.cache);
132 }
133
134 /* Initializes the timetracking module, if not already initialized. */
135 static void
136 time_init(void)
137 {
138     static pthread_once_t once = PTHREAD_ONCE_INIT;
139     pthread_once(&once, do_init_time);
140 }
141
142 static void
143 time_timespec__(struct clock *c, struct timespec *ts)
144 {
145     bool slow_path;
146
147     time_init();
148
149     atomic_read_explicit(&c->slow_path, &slow_path, memory_order_relaxed);
150     if (!slow_path) {
151         xclock_gettime(c->id, ts);
152     } else {
153         struct timespec warp;
154         struct timespec cache;
155         bool stopped;
156
157         ovs_mutex_lock(&c->mutex);
158         stopped = c->stopped;
159         warp = c->warp;
160         cache = c->cache;
161         ovs_mutex_unlock(&c->mutex);
162
163         if (!stopped) {
164             xclock_gettime(c->id, &cache);
165         }
166         timespec_add(ts, &cache, &warp);
167     }
168 }
169
170 /* Stores a monotonic timer, accurate within TIME_UPDATE_INTERVAL ms, into
171  * '*ts'. */
172 void
173 time_timespec(struct timespec *ts)
174 {
175     time_timespec__(&monotonic_clock, ts);
176 }
177
178 /* Stores the current time, accurate within TIME_UPDATE_INTERVAL ms, into
179  * '*ts'. */
180 void
181 time_wall_timespec(struct timespec *ts)
182 {
183     time_timespec__(&wall_clock, ts);
184 }
185
186 static time_t
187 time_sec__(struct clock *c)
188 {
189     struct timespec ts;
190
191     time_timespec__(c, &ts);
192     return ts.tv_sec;
193 }
194
195 /* Returns a monotonic timer, in seconds. */
196 time_t
197 time_now(void)
198 {
199     return time_sec__(&monotonic_clock);
200 }
201
202 /* Returns the current time, in seconds. */
203 time_t
204 time_wall(void)
205 {
206     return time_sec__(&wall_clock);
207 }
208
209 static long long int
210 time_msec__(struct clock *c)
211 {
212     struct timespec ts;
213
214     time_timespec__(c, &ts);
215     return timespec_to_msec(&ts);
216 }
217
218 /* Returns a monotonic timer, in ms (within TIME_UPDATE_INTERVAL ms). */
219 long long int
220 time_msec(void)
221 {
222     return time_msec__(&monotonic_clock);
223 }
224
225 /* Returns the current time, in ms (within TIME_UPDATE_INTERVAL ms). */
226 long long int
227 time_wall_msec(void)
228 {
229     return time_msec__(&wall_clock);
230 }
231
232 /* Configures the program to die with SIGALRM 'secs' seconds from now, if
233  * 'secs' is nonzero, or disables the feature if 'secs' is zero. */
234 void
235 time_alarm(unsigned int secs)
236 {
237     long long int now;
238     long long int msecs;
239
240     assert_single_threaded();
241     time_init();
242
243     now = time_msec();
244     msecs = secs * 1000LL;
245     deadline = now < LLONG_MAX - msecs ? now + msecs : LLONG_MAX;
246 }
247
248 /* Like poll(), except:
249  *
250  *      - The timeout is specified as an absolute time, as defined by
251  *        time_msec(), instead of a duration.
252  *
253  *      - On error, returns a negative error code (instead of setting errno).
254  *
255  *      - If interrupted by a signal, retries automatically until the original
256  *        timeout is reached.  (Because of this property, this function will
257  *        never return -EINTR.)
258  *
259  * Stores the number of milliseconds elapsed during poll in '*elapsed'. */
260 int
261 time_poll(struct pollfd *pollfds, int n_pollfds, HANDLE *handles OVS_UNUSED,
262           long long int timeout_when, int *elapsed)
263 {
264     long long int *last_wakeup = last_wakeup_get();
265     long long int start;
266     int retval = 0;
267
268     time_init();
269     coverage_clear();
270     coverage_run();
271     if (*last_wakeup) {
272         log_poll_interval(*last_wakeup);
273     }
274     start = time_msec();
275
276     timeout_when = MIN(timeout_when, deadline);
277
278     for (;;) {
279         long long int now = time_msec();
280         int time_left;
281
282         if (now >= timeout_when) {
283             time_left = 0;
284         } else if ((unsigned long long int) timeout_when - now > INT_MAX) {
285             time_left = INT_MAX;
286         } else {
287             time_left = timeout_when - now;
288         }
289
290         if (!time_left) {
291             ovsrcu_quiesce();
292         } else {
293             ovsrcu_quiesce_start();
294         }
295
296 #ifndef _WIN32
297         retval = poll(pollfds, n_pollfds, time_left);
298         if (retval < 0) {
299             retval = -errno;
300         }
301 #else
302         if (n_pollfds > MAXIMUM_WAIT_OBJECTS) {
303             VLOG_ERR("Cannot handle more than maximum wait objects\n");
304         } else if (n_pollfds != 0) {
305             retval = WaitForMultipleObjects(n_pollfds, handles, FALSE,
306                                             time_left);
307         }
308         if (retval < 0) {
309             /* XXX This will be replace by a win error to errno
310                conversion function */
311             retval = -WSAGetLastError();
312             retval = -EINVAL;
313         }
314 #endif
315
316         if (time_left) {
317             ovsrcu_quiesce_end();
318         }
319
320         if (deadline <= time_msec()) {
321 #ifndef _WIN32
322             fatal_signal_handler(SIGALRM);
323 #else
324             VLOG_ERR("wake up from WaitForMultipleObjects after deadline");
325             fatal_signal_handler(SIGTERM);
326 #endif
327             if (retval < 0) {
328                 retval = 0;
329             }
330             break;
331         }
332
333         if (retval != -EINTR) {
334             break;
335         }
336     }
337     *last_wakeup = time_msec();
338     refresh_rusage();
339     *elapsed = *last_wakeup - start;
340     return retval;
341 }
342
343 long long int
344 timespec_to_msec(const struct timespec *ts)
345 {
346     return (long long int) ts->tv_sec * 1000 + ts->tv_nsec / (1000 * 1000);
347 }
348
349 long long int
350 timeval_to_msec(const struct timeval *tv)
351 {
352     return (long long int) tv->tv_sec * 1000 + tv->tv_usec / 1000;
353 }
354
355 /* Returns the monotonic time at which the "time" module was initialized, in
356  * milliseconds. */
357 long long int
358 time_boot_msec(void)
359 {
360     time_init();
361     return boot_time;
362 }
363
364 #ifdef _WIN32
365 static ULARGE_INTEGER
366 xgetfiletime(void)
367 {
368     ULARGE_INTEGER current_time;
369     FILETIME current_time_ft;
370
371     /* Returns current time in UTC as a 64-bit value representing the number
372      * of 100-nanosecond intervals since January 1, 1601 . */
373     GetSystemTimePreciseAsFileTime(&current_time_ft);
374     current_time.LowPart = current_time_ft.dwLowDateTime;
375     current_time.HighPart = current_time_ft.dwHighDateTime;
376
377     return current_time;
378 }
379
380 static int
381 clock_gettime(clock_t id, struct timespec *ts)
382 {
383     if (id == CLOCK_MONOTONIC) {
384         static LARGE_INTEGER freq;
385         LARGE_INTEGER count;
386         long long int ns;
387
388         if (!freq.QuadPart) {
389             /* Number of counts per second. */
390             QueryPerformanceFrequency(&freq);
391         }
392         /* Total number of counts from a starting point. */
393         QueryPerformanceCounter(&count);
394
395         /* Total nano seconds from a starting point. */
396         ns = (double) count.QuadPart / freq.QuadPart * 1000000000;
397
398         ts->tv_sec = count.QuadPart / freq.QuadPart;
399         ts->tv_nsec = ns % 1000000000;
400     } else if (id == CLOCK_REALTIME) {
401         ULARGE_INTEGER current_time = xgetfiletime();
402
403         /* Time from Epoch to now. */
404         ts->tv_sec = (current_time.QuadPart - unix_epoch.QuadPart) / 10000000;
405         ts->tv_nsec = ((current_time.QuadPart - unix_epoch.QuadPart) %
406                        10000000) * 100;
407     } else {
408         return -1;
409     }
410 }
411 #endif /* _WIN32 */
412
413 void
414 xgettimeofday(struct timeval *tv)
415 {
416 #ifndef _WIN32
417     if (gettimeofday(tv, NULL) == -1) {
418         VLOG_FATAL("gettimeofday failed (%s)", ovs_strerror(errno));
419     }
420 #else
421     ULARGE_INTEGER current_time = xgetfiletime();
422
423     tv->tv_sec = (current_time.QuadPart - unix_epoch.QuadPart) / 10000000;
424     tv->tv_usec = ((current_time.QuadPart - unix_epoch.QuadPart) %
425                    10000000) / 10;
426 #endif
427 }
428
429 void
430 xclock_gettime(clock_t id, struct timespec *ts)
431 {
432     if (clock_gettime(id, ts) == -1) {
433         /* It seems like a bad idea to try to use vlog here because it is
434          * likely to try to check the current time. */
435         ovs_abort(errno, "xclock_gettime() failed");
436     }
437 }
438
439 /* Makes threads wait on timewarp_seq and be waken up when time is warped.
440  * This function will be no-op unless timeval_dummy_register() is called. */
441 void
442 timewarp_wait(void)
443 {
444     if (timewarp_enabled) {
445         uint64_t *last_seq = last_seq_get();
446
447         *last_seq = seq_read(timewarp_seq);
448         seq_wait(timewarp_seq, *last_seq);
449     }
450 }
451
452 static long long int
453 timeval_diff_msec(const struct timeval *a, const struct timeval *b)
454 {
455     return timeval_to_msec(a) - timeval_to_msec(b);
456 }
457
458 static void
459 timespec_add(struct timespec *sum,
460              const struct timespec *a,
461              const struct timespec *b)
462 {
463     struct timespec tmp;
464
465     tmp.tv_sec = a->tv_sec + b->tv_sec;
466     tmp.tv_nsec = a->tv_nsec + b->tv_nsec;
467     if (tmp.tv_nsec >= 1000 * 1000 * 1000) {
468         tmp.tv_nsec -= 1000 * 1000 * 1000;
469         tmp.tv_sec++;
470     }
471
472     *sum = tmp;
473 }
474
475 static bool
476 is_warped(const struct clock *c)
477 {
478     bool warped;
479
480     ovs_mutex_lock(&c->mutex);
481     warped = monotonic_clock.warp.tv_sec || monotonic_clock.warp.tv_nsec;
482     ovs_mutex_unlock(&c->mutex);
483
484     return warped;
485 }
486
487 static void
488 log_poll_interval(long long int last_wakeup)
489 {
490     long long int interval = time_msec() - last_wakeup;
491
492     if (interval >= 1000 && !is_warped(&monotonic_clock)) {
493         const struct rusage *last_rusage = get_recent_rusage();
494         struct rusage rusage;
495
496         getrusage(RUSAGE_SELF, &rusage);
497         VLOG_WARN("Unreasonably long %lldms poll interval"
498                   " (%lldms user, %lldms system)",
499                   interval,
500                   timeval_diff_msec(&rusage.ru_utime,
501                                     &last_rusage->ru_utime),
502                   timeval_diff_msec(&rusage.ru_stime,
503                                     &last_rusage->ru_stime));
504         if (rusage.ru_minflt > last_rusage->ru_minflt
505             || rusage.ru_majflt > last_rusage->ru_majflt) {
506             VLOG_WARN("faults: %ld minor, %ld major",
507                       rusage.ru_minflt - last_rusage->ru_minflt,
508                       rusage.ru_majflt - last_rusage->ru_majflt);
509         }
510         if (rusage.ru_inblock > last_rusage->ru_inblock
511             || rusage.ru_oublock > last_rusage->ru_oublock) {
512             VLOG_WARN("disk: %ld reads, %ld writes",
513                       rusage.ru_inblock - last_rusage->ru_inblock,
514                       rusage.ru_oublock - last_rusage->ru_oublock);
515         }
516         if (rusage.ru_nvcsw > last_rusage->ru_nvcsw
517             || rusage.ru_nivcsw > last_rusage->ru_nivcsw) {
518             VLOG_WARN("context switches: %ld voluntary, %ld involuntary",
519                       rusage.ru_nvcsw - last_rusage->ru_nvcsw,
520                       rusage.ru_nivcsw - last_rusage->ru_nivcsw);
521         }
522         coverage_log();
523     }
524 }
525 \f
526 /* CPU usage tracking. */
527
528 struct cpu_usage {
529     long long int when;         /* Time that this sample was taken. */
530     unsigned long long int cpu; /* Total user+system CPU usage when sampled. */
531 };
532
533 struct cpu_tracker {
534     struct cpu_usage older;
535     struct cpu_usage newer;
536     int cpu_usage;
537
538     struct rusage recent_rusage;
539 };
540 DEFINE_PER_THREAD_MALLOCED_DATA(struct cpu_tracker *, cpu_tracker_var);
541
542 static struct cpu_tracker *
543 get_cpu_tracker(void)
544 {
545     struct cpu_tracker *t = cpu_tracker_var_get();
546     if (!t) {
547         t = xzalloc(sizeof *t);
548         t->older.when = LLONG_MIN;
549         t->newer.when = LLONG_MIN;
550         cpu_tracker_var_set_unsafe(t);
551     }
552     return t;
553 }
554
555 static struct rusage *
556 get_recent_rusage(void)
557 {
558     return &get_cpu_tracker()->recent_rusage;
559 }
560
561 static int
562 getrusage_thread(struct rusage *rusage OVS_UNUSED)
563 {
564 #ifdef RUSAGE_THREAD
565     return getrusage(RUSAGE_THREAD, rusage);
566 #else
567     errno = EINVAL;
568     return -1;
569 #endif
570 }
571
572 static void
573 refresh_rusage(void)
574 {
575     struct cpu_tracker *t = get_cpu_tracker();
576     struct rusage *recent_rusage = &t->recent_rusage;
577
578     if (!getrusage_thread(recent_rusage)) {
579         long long int now = time_msec();
580         if (now >= t->newer.when + 3 * 1000) {
581             t->older = t->newer;
582             t->newer.when = now;
583             t->newer.cpu = (timeval_to_msec(&recent_rusage->ru_utime) +
584                             timeval_to_msec(&recent_rusage->ru_stime));
585
586             if (t->older.when != LLONG_MIN && t->newer.cpu > t->older.cpu) {
587                 unsigned int dividend = t->newer.cpu - t->older.cpu;
588                 unsigned int divisor = (t->newer.when - t->older.when) / 100;
589                 t->cpu_usage = divisor > 0 ? dividend / divisor : -1;
590             } else {
591                 t->cpu_usage = -1;
592             }
593         }
594     }
595 }
596
597 /* Returns an estimate of this process's CPU usage, as a percentage, over the
598  * past few seconds of wall-clock time.  Returns -1 if no estimate is available
599  * (which will happen if the process has not been running long enough to have
600  * an estimate, and can happen for other reasons as well). */
601 int
602 get_cpu_usage(void)
603 {
604     return get_cpu_tracker()->cpu_usage;
605 }
606 \f
607 /* Unixctl interface. */
608
609 /* "time/stop" stops the monotonic time returned by e.g. time_msec() from
610  * advancing, except due to later calls to "time/warp". */
611 static void
612 timeval_stop_cb(struct unixctl_conn *conn,
613                  int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
614                  void *aux OVS_UNUSED)
615 {
616     ovs_mutex_lock(&monotonic_clock.mutex);
617     atomic_store(&monotonic_clock.slow_path, true);
618     monotonic_clock.stopped = true;
619     xclock_gettime(monotonic_clock.id, &monotonic_clock.cache);
620     ovs_mutex_unlock(&monotonic_clock.mutex);
621
622     unixctl_command_reply(conn, NULL);
623 }
624
625 /* "time/warp MSECS" advances the current monotonic time by the specified
626  * number of milliseconds.  Unless "time/stop" has also been executed, the
627  * monotonic clock continues to tick forward at the normal rate afterward.
628  *
629  * Does not affect wall clock readings. */
630 static void
631 timeval_warp_cb(struct unixctl_conn *conn,
632                 int argc OVS_UNUSED, const char *argv[], void *aux OVS_UNUSED)
633 {
634     struct timespec ts;
635     int msecs;
636
637     msecs = atoi(argv[1]);
638     if (msecs <= 0) {
639         unixctl_command_reply_error(conn, "invalid MSECS");
640         return;
641     }
642
643     ts.tv_sec = msecs / 1000;
644     ts.tv_nsec = (msecs % 1000) * 1000 * 1000;
645
646     ovs_mutex_lock(&monotonic_clock.mutex);
647     atomic_store(&monotonic_clock.slow_path, true);
648     timespec_add(&monotonic_clock.warp, &monotonic_clock.warp, &ts);
649     ovs_mutex_unlock(&monotonic_clock.mutex);
650     seq_change(timewarp_seq);
651     /* give threads (eg. monitor) some chances to run */
652 #ifndef _WIN32
653     poll(NULL, 0, 10);
654 #else
655     Sleep(10);
656 #endif
657     unixctl_command_reply(conn, "warped");
658 }
659
660 void
661 timeval_dummy_register(void)
662 {
663     timewarp_enabled = true;
664     unixctl_command_register("time/stop", "", 0, 0, timeval_stop_cb, NULL);
665     unixctl_command_register("time/warp", "MSECS", 1, 1,
666                              timeval_warp_cb, NULL);
667 }
668
669
670
671 /* strftime() with an extension for high-resolution timestamps.  Any '#'s in
672  * 'format' will be replaced by subseconds, e.g. use "%S.###" to obtain results
673  * like "01.123".  */
674 size_t
675 strftime_msec(char *s, size_t max, const char *format,
676               const struct tm_msec *tm)
677 {
678     size_t n;
679
680     n = strftime(s, max, format, &tm->tm);
681     if (n) {
682         char decimals[4];
683         char *p;
684
685         sprintf(decimals, "%03d", tm->msec);
686         for (p = strchr(s, '#'); p; p = strchr(p, '#')) {
687             char *d = decimals;
688             while (*p == '#')  {
689                 *p++ = *d ? *d++ : '0';
690             }
691         }
692     }
693
694     return n;
695 }
696
697 struct tm_msec *
698 localtime_msec(long long int now, struct tm_msec *result)
699 {
700   time_t now_sec = now / 1000;
701   localtime_r(&now_sec, &result->tm);
702   result->msec = now % 1000;
703   return result;
704 }
705
706 struct tm_msec *
707 gmtime_msec(long long int now, struct tm_msec *result)
708 {
709   time_t now_sec = now / 1000;
710   gmtime_r(&now_sec, &result->tm);
711   result->msec = now % 1000;
712   return result;
713 }