2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #include <sys/resource.h>
29 #include "dynamic-string.h"
30 #include "fatal-signal.h"
38 /* backtrace() from <execinfo.h> is really useful, but it is not signal safe
39 * everywhere, such as on x86-64. */
40 #if HAVE_BACKTRACE && !defined __x86_64__
41 # define USE_BACKTRACE 1
42 # include <execinfo.h>
44 # define USE_BACKTRACE 0
47 VLOG_DEFINE_THIS_MODULE(timeval);
49 /* The clock to use for measuring time intervals. This is CLOCK_MONOTONIC by
50 * preference, but on systems that don't have a monotonic clock we fall back
51 * to CLOCK_REALTIME. */
52 static clockid_t monotonic_clock;
54 /* Has a timer tick occurred? Only relevant if CACHE_TIME is true.
56 * We initialize these to true to force time_init() to get called on the first
57 * call to time_msec() or another function that queries the current time. */
58 static volatile sig_atomic_t wall_tick = true;
59 static volatile sig_atomic_t monotonic_tick = true;
61 /* The current time, as of the last refresh. */
62 static struct timespec wall_time;
63 static struct timespec monotonic_time;
65 /* The monotonic time at which the time module was initialized. */
66 static long long int boot_time;
68 /* features for use by unit tests. */
69 static struct timespec warp_offset; /* Offset added to monotonic_time. */
70 static bool time_stopped; /* Disables real-time updates, if true. */
72 /* Time in milliseconds at which to die with SIGALRM (if not LLONG_MAX). */
73 static long long int deadline = LLONG_MAX;
76 void *backtrace[32]; /* Populated by backtrace(). */
77 size_t n_frames; /* Number of frames in 'backtrace'. */
79 /* format_backtraces() helper data. */
80 struct hmap_node node;
85 static struct trace traces[MAX_TRACES];
86 static size_t trace_head = 0;
88 static void set_up_timer(void);
89 static void set_up_signal(int flags);
90 static void sigalrm_handler(int);
91 static void refresh_wall_if_ticked(void);
92 static void refresh_monotonic_if_ticked(void);
93 static void block_sigalrm(sigset_t *);
94 static void unblock_sigalrm(const sigset_t *);
95 static void log_poll_interval(long long int last_wakeup);
96 static struct rusage *get_recent_rusage(void);
97 static void refresh_rusage(void);
98 static void timespec_add(struct timespec *sum,
99 const struct timespec *a, const struct timespec *b);
100 static unixctl_cb_func backtrace_cb;
104 backtrace(void **buffer OVS_UNUSED, int size OVS_UNUSED)
110 backtrace_symbols(void *const *buffer OVS_UNUSED, int size OVS_UNUSED)
114 #endif /* !USE_BACKTRACE */
116 /* Initializes the timetracking module, if not already initialized. */
127 /* The implementation of backtrace() in glibc does some one time
128 * initialization which is not signal safe. This can cause deadlocks if
129 * run from the signal handler. As a workaround, force the initialization
134 backtrace(bt, ARRAY_SIZE(bt));
137 memset(traces, 0, sizeof traces);
139 if (USE_BACKTRACE && CACHE_TIME) {
140 unixctl_command_register("backtrace", "", 0, 0, backtrace_cb, NULL);
145 if (!clock_gettime(CLOCK_MONOTONIC, &monotonic_time)) {
146 monotonic_clock = CLOCK_MONOTONIC;
148 monotonic_clock = CLOCK_REALTIME;
149 VLOG_DBG("monotonic timer not available");
152 set_up_signal(SA_RESTART);
155 boot_time = time_msec();
159 set_up_signal(int flags)
163 memset(&sa, 0, sizeof sa);
164 sa.sa_handler = sigalrm_handler;
165 sigemptyset(&sa.sa_mask);
167 xsigaction(SIGALRM, &sa, NULL);
170 /* Remove SA_RESTART from the flags for SIGALRM, so that any system call that
171 * is interrupted by the periodic timer interrupt will return EINTR instead of
172 * continuing after the signal handler returns.
174 * time_disable_restart() and time_enable_restart() may be usefully wrapped
175 * around function calls that might otherwise block forever unless interrupted
178 * time_disable_restart();
179 * fcntl(fd, F_SETLKW, &lock);
180 * time_enable_restart();
183 time_disable_restart(void)
189 /* Add SA_RESTART to the flags for SIGALRM, so that any system call that
190 * is interrupted by the periodic timer interrupt will continue after the
191 * signal handler returns instead of returning EINTR. */
193 time_enable_restart(void)
196 set_up_signal(SA_RESTART);
202 static timer_t timer_id; /* "static" to avoid apparent memory leak. */
203 struct itimerspec itimer;
209 if (timer_create(monotonic_clock, NULL, &timer_id)) {
210 VLOG_FATAL("timer_create failed (%s)", strerror(errno));
213 itimer.it_interval.tv_sec = 0;
214 itimer.it_interval.tv_nsec = TIME_UPDATE_INTERVAL * 1000 * 1000;
215 itimer.it_value = itimer.it_interval;
217 if (timer_settime(timer_id, 0, &itimer, NULL)) {
218 VLOG_FATAL("timer_settime failed (%s)", strerror(errno));
222 /* Set up the interval timer, to ensure that time advances even without calling
225 * A child created with fork() does not inherit the parent's interval timer, so
226 * this function needs to be called from the child after fork(). */
238 clock_gettime(CLOCK_REALTIME, &wall_time);
243 refresh_monotonic(void)
248 if (monotonic_clock == CLOCK_MONOTONIC) {
249 clock_gettime(monotonic_clock, &monotonic_time);
251 refresh_wall_if_ticked();
252 monotonic_time = wall_time;
254 timespec_add(&monotonic_time, &monotonic_time, &warp_offset);
256 monotonic_tick = false;
260 /* Forces a refresh of the current time from the kernel. It is not usually
261 * necessary to call this function, since the time will be refreshed
262 * automatically at least every TIME_UPDATE_INTERVAL milliseconds. If
263 * CACHE_TIME is false, we will always refresh the current time so this
264 * function has no effect. */
268 wall_tick = monotonic_tick = true;
271 /* Returns a monotonic timer, in seconds. */
275 refresh_monotonic_if_ticked();
276 return monotonic_time.tv_sec;
279 /* Returns the current time, in seconds. */
283 refresh_wall_if_ticked();
284 return wall_time.tv_sec;
287 /* Returns a monotonic timer, in ms (within TIME_UPDATE_INTERVAL ms). */
291 refresh_monotonic_if_ticked();
292 return timespec_to_msec(&monotonic_time);
295 /* Returns the current time, in ms (within TIME_UPDATE_INTERVAL ms). */
299 refresh_wall_if_ticked();
300 return timespec_to_msec(&wall_time);
303 /* Stores a monotonic timer, accurate within TIME_UPDATE_INTERVAL ms, into
306 time_timespec(struct timespec *ts)
308 refresh_monotonic_if_ticked();
309 *ts = monotonic_time;
312 /* Stores the current time, accurate within TIME_UPDATE_INTERVAL ms, into
315 time_wall_timespec(struct timespec *ts)
317 refresh_wall_if_ticked();
321 /* Configures the program to die with SIGALRM 'secs' seconds from now, if
322 * 'secs' is nonzero, or disables the feature if 'secs' is zero. */
324 time_alarm(unsigned int secs)
335 msecs = secs * 1000LL;
337 block_sigalrm(&oldsigs);
338 deadline = now < LLONG_MAX - msecs ? now + msecs : LLONG_MAX;
339 unblock_sigalrm(&oldsigs);
342 /* Like poll(), except:
344 * - The timeout is specified as an absolute time, as defined by
345 * time_msec(), instead of a duration.
347 * - On error, returns a negative error code (instead of setting errno).
349 * - If interrupted by a signal, retries automatically until the original
350 * timeout is reached. (Because of this property, this function will
351 * never return -EINTR.)
353 * - As a side effect, refreshes the current time (like time_refresh()).
355 * Stores the number of milliseconds elapsed during poll in '*elapsed'. */
357 time_poll(struct pollfd *pollfds, int n_pollfds, long long int timeout_when,
360 static long long int last_wakeup = 0;
368 log_poll_interval(last_wakeup);
374 timeout_when = MIN(timeout_when, deadline);
377 long long int now = time_msec();
380 if (now >= timeout_when) {
382 } else if ((unsigned long long int) timeout_when - now > INT_MAX) {
385 time_left = timeout_when - now;
388 retval = poll(pollfds, n_pollfds, time_left);
394 if (deadline <= time_msec()) {
395 fatal_signal_handler(SIGALRM);
402 if (retval != -EINTR) {
406 if (!blocked && CACHE_TIME) {
407 block_sigalrm(&oldsigs);
412 unblock_sigalrm(&oldsigs);
414 last_wakeup = time_msec();
416 *elapsed = last_wakeup - start;
421 sigalrm_handler(int sig_nr OVS_UNUSED)
424 monotonic_tick = true;
426 if (USE_BACKTRACE && CACHE_TIME) {
427 struct trace *trace = &traces[trace_head];
429 trace->n_frames = backtrace(trace->backtrace,
430 ARRAY_SIZE(trace->backtrace));
431 trace_head = (trace_head + 1) % MAX_TRACES;
436 refresh_wall_if_ticked(void)
438 if (!CACHE_TIME || wall_tick) {
444 refresh_monotonic_if_ticked(void)
446 if (!CACHE_TIME || monotonic_tick) {
452 block_sigalrm(sigset_t *oldsigs)
455 sigemptyset(&sigalrm);
456 sigaddset(&sigalrm, SIGALRM);
457 xpthread_sigmask(SIG_BLOCK, &sigalrm, oldsigs);
461 unblock_sigalrm(const sigset_t *oldsigs)
463 xpthread_sigmask(SIG_SETMASK, oldsigs, NULL);
467 timespec_to_msec(const struct timespec *ts)
469 return (long long int) ts->tv_sec * 1000 + ts->tv_nsec / (1000 * 1000);
473 timeval_to_msec(const struct timeval *tv)
475 return (long long int) tv->tv_sec * 1000 + tv->tv_usec / 1000;
478 /* Returns the monotonic time at which the "time" module was initialized, in
488 xgettimeofday(struct timeval *tv)
490 if (gettimeofday(tv, NULL) == -1) {
491 VLOG_FATAL("gettimeofday failed (%s)", strerror(errno));
496 timeval_diff_msec(const struct timeval *a, const struct timeval *b)
498 return timeval_to_msec(a) - timeval_to_msec(b);
502 timespec_add(struct timespec *sum,
503 const struct timespec *a,
504 const struct timespec *b)
508 tmp.tv_sec = a->tv_sec + b->tv_sec;
509 tmp.tv_nsec = a->tv_nsec + b->tv_nsec;
510 if (tmp.tv_nsec >= 1000 * 1000 * 1000) {
511 tmp.tv_nsec -= 1000 * 1000 * 1000;
519 log_poll_interval(long long int last_wakeup)
521 long long int interval = time_msec() - last_wakeup;
523 if (interval >= 1000 && !warp_offset.tv_sec && !warp_offset.tv_nsec) {
524 const struct rusage *last_rusage = get_recent_rusage();
525 struct rusage rusage;
527 getrusage(RUSAGE_SELF, &rusage);
528 VLOG_WARN("Unreasonably long %lldms poll interval"
529 " (%lldms user, %lldms system)",
531 timeval_diff_msec(&rusage.ru_utime,
532 &last_rusage->ru_utime),
533 timeval_diff_msec(&rusage.ru_stime,
534 &last_rusage->ru_stime));
535 if (rusage.ru_minflt > last_rusage->ru_minflt
536 || rusage.ru_majflt > last_rusage->ru_majflt) {
537 VLOG_WARN("faults: %ld minor, %ld major",
538 rusage.ru_minflt - last_rusage->ru_minflt,
539 rusage.ru_majflt - last_rusage->ru_majflt);
541 if (rusage.ru_inblock > last_rusage->ru_inblock
542 || rusage.ru_oublock > last_rusage->ru_oublock) {
543 VLOG_WARN("disk: %ld reads, %ld writes",
544 rusage.ru_inblock - last_rusage->ru_inblock,
545 rusage.ru_oublock - last_rusage->ru_oublock);
547 if (rusage.ru_nvcsw > last_rusage->ru_nvcsw
548 || rusage.ru_nivcsw > last_rusage->ru_nivcsw) {
549 VLOG_WARN("context switches: %ld voluntary, %ld involuntary",
550 rusage.ru_nvcsw - last_rusage->ru_nvcsw,
551 rusage.ru_nivcsw - last_rusage->ru_nivcsw);
557 /* CPU usage tracking. */
560 long long int when; /* Time that this sample was taken. */
561 unsigned long long int cpu; /* Total user+system CPU usage when sampled. */
564 static struct rusage recent_rusage;
565 static struct cpu_usage older = { LLONG_MIN, 0 };
566 static struct cpu_usage newer = { LLONG_MIN, 0 };
567 static int cpu_usage = -1;
569 static struct rusage *
570 get_recent_rusage(void)
572 return &recent_rusage;
581 getrusage(RUSAGE_SELF, &recent_rusage);
583 if (now >= newer.when + 3 * 1000) {
586 newer.cpu = (timeval_to_msec(&recent_rusage.ru_utime) +
587 timeval_to_msec(&recent_rusage.ru_stime));
589 if (older.when != LLONG_MIN && newer.cpu > older.cpu) {
590 unsigned int dividend = newer.cpu - older.cpu;
591 unsigned int divisor = (newer.when - older.when) / 100;
592 cpu_usage = divisor > 0 ? dividend / divisor : -1;
599 /* Returns an estimate of this process's CPU usage, as a percentage, over the
600 * past few seconds of wall-clock time. Returns -1 if no estimate is available
601 * (which will happen if the process has not been running long enough to have
602 * an estimate, and can happen for other reasons as well). */
610 hash_trace(struct trace *trace)
612 return hash_bytes(trace->backtrace,
613 trace->n_frames * sizeof *trace->backtrace, 0);
616 static struct trace *
617 trace_map_lookup(struct hmap *trace_map, struct trace *key)
621 HMAP_FOR_EACH_WITH_HASH (value, node, hash_trace(key), trace_map) {
622 if (key->n_frames == value->n_frames
623 && !memcmp(key->backtrace, value->backtrace,
624 key->n_frames * sizeof *key->backtrace)) {
631 /* Appends a string to 'ds' representing backtraces recorded at regular
632 * intervals in the recent past. This information can be used to get a sense
633 * of what the process has been spending the majority of time doing. Will
634 * ommit any backtraces which have not occurred at least 'min_count' times. */
636 format_backtraces(struct ds *ds, size_t min_count)
640 if (USE_BACKTRACE && CACHE_TIME) {
641 struct hmap trace_map = HMAP_INITIALIZER(&trace_map);
642 struct trace *trace, *next;
646 block_sigalrm(&oldsigs);
648 for (i = 0; i < MAX_TRACES; i++) {
649 struct trace *trace = &traces[i];
650 struct trace *map_trace;
652 if (!trace->n_frames) {
656 map_trace = trace_map_lookup(&trace_map, trace);
660 hmap_insert(&trace_map, &trace->node, hash_trace(trace));
665 HMAP_FOR_EACH_SAFE (trace, next, node, &trace_map) {
669 hmap_remove(&trace_map, &trace->node);
671 if (trace->count < min_count) {
675 frame_strs = backtrace_symbols(trace->backtrace, trace->n_frames);
677 ds_put_format(ds, "Count %zu\n", trace->count);
678 for (j = 0; j < trace->n_frames; j++) {
679 ds_put_format(ds, "%s\n", frame_strs[j]);
681 ds_put_cstr(ds, "\n");
685 hmap_destroy(&trace_map);
688 unblock_sigalrm(&oldsigs);
692 /* Unixctl interface. */
694 /* "time/stop" stops the monotonic time returned by e.g. time_msec() from
695 * advancing, except due to later calls to "time/warp". */
697 timeval_stop_cb(struct unixctl_conn *conn,
698 int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
699 void *aux OVS_UNUSED)
702 unixctl_command_reply(conn, NULL);
705 /* "time/warp MSECS" advances the current monotonic time by the specified
706 * number of milliseconds. Unless "time/stop" has also been executed, the
707 * monotonic clock continues to tick forward at the normal rate afterward.
709 * Does not affect wall clock readings. */
711 timeval_warp_cb(struct unixctl_conn *conn,
712 int argc OVS_UNUSED, const char *argv[], void *aux OVS_UNUSED)
717 msecs = atoi(argv[1]);
719 unixctl_command_reply_error(conn, "invalid MSECS");
723 ts.tv_sec = msecs / 1000;
724 ts.tv_nsec = (msecs % 1000) * 1000 * 1000;
725 timespec_add(&warp_offset, &warp_offset, &ts);
726 timespec_add(&monotonic_time, &monotonic_time, &ts);
727 unixctl_command_reply(conn, "warped");
731 backtrace_cb(struct unixctl_conn *conn,
732 int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
733 void *aux OVS_UNUSED)
735 struct ds ds = DS_EMPTY_INITIALIZER;
737 ovs_assert(USE_BACKTRACE && CACHE_TIME);
738 format_backtraces(&ds, 0);
739 unixctl_command_reply(conn, ds_cstr(&ds));
744 timeval_dummy_register(void)
746 unixctl_command_register("time/stop", "", 0, 0, timeval_stop_cb, NULL);
747 unixctl_command_register("time/warp", "MSECS", 1, 1,
748 timeval_warp_cb, NULL);