lib/timeval.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 <assert.h>
  20 #include <errno.h>
  21 #include <poll.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 "fatal-signal.h"
  31 #include "signals.h"
  32 #include "unixctl.h"
  33 #include "util.h"
  34 #include "vlog.h"
  35
  36 VLOG_DEFINE_THIS_MODULE(timeval);
  37
  38 /* The clock to use for measuring time intervals.  This is CLOCK_MONOTONIC by
  39  * preference, but on systems that don't have a monotonic clock we fall back
  40  * to CLOCK_REALTIME. */
  41 static clockid_t monotonic_clock;
  42
  43 /* Has a timer tick occurred? Only relevant if CACHE_TIME is true.
  44  *
  45  * We initialize these to true to force time_init() to get called on the first
  46  * call to time_msec() or another function that queries the current time. */
  47 static volatile sig_atomic_t wall_tick = true;
  48 static volatile sig_atomic_t monotonic_tick = true;
  49
  50 /* The current time, as of the last refresh. */
  51 static struct timespec wall_time;
  52 static struct timespec monotonic_time;
  53
  54 /* The monotonic time at which the time module was initialized. */
  55 static long long int boot_time;
  56
  57 /* features for use by unit tests. */
  58 static struct timespec warp_offset; /* Offset added to monotonic_time. */
  59 static bool time_stopped;           /* Disables real-time updates, if true. */
  60
  61 /* Time in milliseconds at which to die with SIGALRM (if not LLONG_MAX). */
  62 static long long int deadline = LLONG_MAX;
  63
  64 static void set_up_timer(void);
  65 static void set_up_signal(int flags);
  66 static void sigalrm_handler(int);
  67 static void refresh_wall_if_ticked(void);
  68 static void refresh_monotonic_if_ticked(void);
  69 static void block_sigalrm(sigset_t *);
  70 static void unblock_sigalrm(const sigset_t *);
  71 static void log_poll_interval(long long int last_wakeup);
  72 static struct rusage *get_recent_rusage(void);
  73 static void refresh_rusage(void);
  74 static void timespec_add(struct timespec *sum,
  75                          const struct timespec *a, const struct timespec *b);
  76
  77 /* Initializes the timetracking module, if not already initialized. */
  78 static void
  79 time_init(void)
  80 {
  81     static bool inited;
  82     if (inited) {
  83         return;
  84     }
  85     inited = true;
  86
  87     coverage_init();
  88
  89     if (!clock_gettime(CLOCK_MONOTONIC, &monotonic_time)) {
  90         monotonic_clock = CLOCK_MONOTONIC;
  91     } else {
  92         monotonic_clock = CLOCK_REALTIME;
  93         VLOG_DBG("monotonic timer not available");
  94     }
  95
  96     set_up_signal(SA_RESTART);
  97     set_up_timer();
  98
  99     boot_time = time_msec();
 100 }
 101
 102 static void
 103 set_up_signal(int flags)
 104 {
 105     struct sigaction sa;
 106
 107     memset(&sa, 0, sizeof sa);
 108     sa.sa_handler = sigalrm_handler;
 109     sigemptyset(&sa.sa_mask);
 110     sa.sa_flags = flags;
 111     xsigaction(SIGALRM, &sa, NULL);
 112 }
 113
 114 /* Remove SA_RESTART from the flags for SIGALRM, so that any system call that
 115  * is interrupted by the periodic timer interrupt will return EINTR instead of
 116  * continuing after the signal handler returns.
 117  *
 118  * time_disable_restart() and time_enable_restart() may be usefully wrapped
 119  * around function calls that might otherwise block forever unless interrupted
 120  * by a signal, e.g.:
 121  *
 122  *   time_disable_restart();
 123  *   fcntl(fd, F_SETLKW, &lock);
 124  *   time_enable_restart();
 125  */
 126 void
 127 time_disable_restart(void)
 128 {
 129     time_init();
 130     set_up_signal(0);
 131 }
 132
 133 /* Add SA_RESTART to the flags for SIGALRM, so that any system call that
 134  * is interrupted by the periodic timer interrupt will continue after the
 135  * signal handler returns instead of returning EINTR. */
 136 void
 137 time_enable_restart(void)
 138 {
 139     time_init();
 140     set_up_signal(SA_RESTART);
 141 }
 142
 143 static void
 144 set_up_timer(void)
 145 {
 146     static timer_t timer_id;    /* "static" to avoid apparent memory leak. */
 147     struct itimerspec itimer;
 148
 149     if (!CACHE_TIME) {
 150         return;
 151     }
 152
 153     if (timer_create(monotonic_clock, NULL, &timer_id)) {
 154         VLOG_FATAL("timer_create failed (%s)", strerror(errno));
 155     }
 156
 157     itimer.it_interval.tv_sec = 0;
 158     itimer.it_interval.tv_nsec = TIME_UPDATE_INTERVAL * 1000 * 1000;
 159     itimer.it_value = itimer.it_interval;
 160
 161     if (timer_settime(timer_id, 0, &itimer, NULL)) {
 162         VLOG_FATAL("timer_settime failed (%s)", strerror(errno));
 163     }
 164 }
 165
 166 /* Set up the interval timer, to ensure that time advances even without calling
 167  * time_refresh().
 168  *
 169  * A child created with fork() does not inherit the parent's interval timer, so
 170  * this function needs to be called from the child after fork(). */
 171 void
 172 time_postfork(void)
 173 {
 174     time_init();
 175     set_up_timer();
 176 }
 177
 178 static void
 179 refresh_wall(void)
 180 {
 181     time_init();
 182     clock_gettime(CLOCK_REALTIME, &wall_time);
 183     wall_tick = false;
 184 }
 185
 186 static void
 187 refresh_monotonic(void)
 188 {
 189     time_init();
 190
 191     if (!time_stopped) {
 192         if (monotonic_clock == CLOCK_MONOTONIC) {
 193             clock_gettime(monotonic_clock, &monotonic_time);
 194         } else {
 195             refresh_wall_if_ticked();
 196             monotonic_time = wall_time;
 197         }
 198         timespec_add(&monotonic_time, &monotonic_time, &warp_offset);
 199
 200         monotonic_tick = false;
 201     }
 202 }
 203
 204 /* Forces a refresh of the current time from the kernel.  It is not usually
 205  * necessary to call this function, since the time will be refreshed
 206  * automatically at least every TIME_UPDATE_INTERVAL milliseconds.  If
 207  * CACHE_TIME is false, we will always refresh the current time so this
 208  * function has no effect. */
 209 void
 210 time_refresh(void)
 211 {
 212     wall_tick = monotonic_tick = true;
 213 }
 214
 215 /* Returns a monotonic timer, in seconds. */
 216 time_t
 217 time_now(void)
 218 {
 219     refresh_monotonic_if_ticked();
 220     return monotonic_time.tv_sec;
 221 }
 222
 223 /* Returns the current time, in seconds. */
 224 time_t
 225 time_wall(void)
 226 {
 227     refresh_wall_if_ticked();
 228     return wall_time.tv_sec;
 229 }
 230
 231 /* Returns a monotonic timer, in ms (within TIME_UPDATE_INTERVAL ms). */
 232 long long int
 233 time_msec(void)
 234 {
 235     refresh_monotonic_if_ticked();
 236     return timespec_to_msec(&monotonic_time);
 237 }
 238
 239 /* Returns the current time, in ms (within TIME_UPDATE_INTERVAL ms). */
 240 long long int
 241 time_wall_msec(void)
 242 {
 243     refresh_wall_if_ticked();
 244     return timespec_to_msec(&wall_time);
 245 }
 246
 247 /* Stores a monotonic timer, accurate within TIME_UPDATE_INTERVAL ms, into
 248  * '*ts'. */
 249 void
 250 time_timespec(struct timespec *ts)
 251 {
 252     refresh_monotonic_if_ticked();
 253     *ts = monotonic_time;
 254 }
 255
 256 /* Stores the current time, accurate within TIME_UPDATE_INTERVAL ms, into
 257  * '*ts'. */
 258 void
 259 time_wall_timespec(struct timespec *ts)
 260 {
 261     refresh_wall_if_ticked();
 262     *ts = wall_time;
 263 }
 264
 265 /* Configures the program to die with SIGALRM 'secs' seconds from now, if
 266  * 'secs' is nonzero, or disables the feature if 'secs' is zero. */
 267 void
 268 time_alarm(unsigned int secs)
 269 {
 270     long long int now;
 271     long long int msecs;
 272
 273     sigset_t oldsigs;
 274
 275     time_init();
 276     time_refresh();
 277
 278     now = time_msec();
 279     msecs = secs * 1000;
 280
 281     block_sigalrm(&oldsigs);
 282     deadline = now < LLONG_MAX - msecs ? now + msecs : LLONG_MAX;
 283     unblock_sigalrm(&oldsigs);
 284 }
 285
 286 /* Like poll(), except:
 287  *
 288  *      - The timeout is specified as an absolute time, as defined by
 289  *        time_msec(), instead of a duration.
 290  *
 291  *      - On error, returns a negative error code (instead of setting errno).
 292  *
 293  *      - If interrupted by a signal, retries automatically until the original
 294  *        timeout is reached.  (Because of this property, this function will
 295  *        never return -EINTR.)
 296  *
 297  *      - As a side effect, refreshes the current time (like time_refresh()).
 298  *
 299  * Stores the number of milliseconds elapsed during poll in '*elapsed'. */
 300 int
 301 time_poll(struct pollfd *pollfds, int n_pollfds, long long int timeout_when,
 302           int *elapsed)
 303 {
 304     static long long int last_wakeup;
 305     long long int start;
 306     sigset_t oldsigs;
 307     bool blocked;
 308     int retval;
 309
 310     time_refresh();
 311     log_poll_interval(last_wakeup);
 312     coverage_clear();
 313     start = time_msec();
 314     blocked = false;
 315
 316     timeout_when = MIN(timeout_when, deadline);
 317
 318     for (;;) {
 319         long long int now = time_msec();
 320         int time_left;
 321
 322         if (now >= timeout_when) {
 323             time_left = 0;
 324         } else if ((unsigned long long int) timeout_when - now > INT_MAX) {
 325             time_left = INT_MAX;
 326         } else {
 327             time_left = timeout_when - now;
 328         }
 329
 330         retval = poll(pollfds, n_pollfds, time_left);
 331         if (retval < 0) {
 332             retval = -errno;
 333         }
 334
 335         time_refresh();
 336         if (deadline <= time_msec()) {
 337             fatal_signal_handler(SIGALRM);
 338             if (retval < 0) {
 339                 retval = 0;
 340             }
 341             break;
 342         }
 343
 344         if (retval != -EINTR) {
 345             break;
 346         }
 347
 348         if (!blocked && !CACHE_TIME) {
 349             block_sigalrm(&oldsigs);
 350             blocked = true;
 351         }
 352     }
 353     if (blocked) {
 354         unblock_sigalrm(&oldsigs);
 355     }
 356     last_wakeup = time_msec();
 357     refresh_rusage();
 358     *elapsed = last_wakeup - start;
 359     return retval;
 360 }
 361
 362 static void
 363 sigalrm_handler(int sig_nr OVS_UNUSED)
 364 {
 365     wall_tick = true;
 366     monotonic_tick = true;
 367 }
 368
 369 static void
 370 refresh_wall_if_ticked(void)
 371 {
 372     if (!CACHE_TIME || wall_tick) {
 373         refresh_wall();
 374     }
 375 }
 376
 377 static void
 378 refresh_monotonic_if_ticked(void)
 379 {
 380     if (!CACHE_TIME || monotonic_tick) {
 381         refresh_monotonic();
 382     }
 383 }
 384
 385 static void
 386 block_sigalrm(sigset_t *oldsigs)
 387 {
 388     sigset_t sigalrm;
 389     sigemptyset(&sigalrm);
 390     sigaddset(&sigalrm, SIGALRM);
 391     xsigprocmask(SIG_BLOCK, &sigalrm, oldsigs);
 392 }
 393
 394 static void
 395 unblock_sigalrm(const sigset_t *oldsigs)
 396 {
 397     xsigprocmask(SIG_SETMASK, oldsigs, NULL);
 398 }
 399
 400 long long int
 401 timespec_to_msec(const struct timespec *ts)
 402 {
 403     return (long long int) ts->tv_sec * 1000 + ts->tv_nsec / (1000 * 1000);
 404 }
 405
 406 long long int
 407 timeval_to_msec(const struct timeval *tv)
 408 {
 409     return (long long int) tv->tv_sec * 1000 + tv->tv_usec / 1000;
 410 }
 411
 412 /* Returns the monotonic time at which the "time" module was initialized, in
 413  * milliseconds(). */
 414 long long int
 415 time_boot_msec(void)
 416 {
 417     time_init();
 418     return boot_time;
 419 }
 420
 421 void
 422 xgettimeofday(struct timeval *tv)
 423 {
 424     if (gettimeofday(tv, NULL) == -1) {
 425         VLOG_FATAL("gettimeofday failed (%s)", strerror(errno));
 426     }
 427 }
 428
 429 static long long int
 430 timeval_diff_msec(const struct timeval *a, const struct timeval *b)
 431 {
 432     return timeval_to_msec(a) - timeval_to_msec(b);
 433 }
 434
 435 static void
 436 timespec_add(struct timespec *sum,
 437              const struct timespec *a,
 438              const struct timespec *b)
 439 {
 440     struct timespec tmp;
 441
 442     tmp.tv_sec = a->tv_sec + b->tv_sec;
 443     tmp.tv_nsec = a->tv_nsec + b->tv_nsec;
 444     if (tmp.tv_nsec >= 1000 * 1000 * 1000) {
 445         tmp.tv_nsec -= 1000 * 1000 * 1000;
 446         tmp.tv_sec++;
 447     }
 448
 449     *sum = tmp;
 450 }
 451
 452 static void
 453 log_poll_interval(long long int last_wakeup)
 454 {
 455     static unsigned int mean_interval; /* In 16ths of a millisecond. */
 456     static unsigned int n_samples;
 457
 458     long long int now;
 459     unsigned int interval;      /* In 16ths of a millisecond. */
 460
 461     /* Compute interval from last wakeup to now in 16ths of a millisecond,
 462      * capped at 10 seconds (16000 in this unit). */
 463     now = time_msec();
 464     interval = MIN(10000, now - last_wakeup) << 4;
 465
 466     /* Warn if we took too much time between polls: at least 50 ms and at least
 467      * 8X the mean interval. */
 468     if (n_samples > 10 && interval > mean_interval * 8 && interval > 50 * 16) {
 469         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 3);
 470
 471         if (!VLOG_DROP_WARN(&rl)) {
 472             const struct rusage *last_rusage = get_recent_rusage();
 473             struct rusage rusage;
 474
 475             getrusage(RUSAGE_SELF, &rusage);
 476             VLOG_WARN("%lld ms poll interval (%lld ms user, %lld ms system) "
 477                       "is over %u times the weighted mean interval %u ms "
 478                       "(%u samples)",
 479                       now - last_wakeup,
 480                       timeval_diff_msec(&rusage.ru_utime,
 481                                         &last_rusage->ru_utime),
 482                       timeval_diff_msec(&rusage.ru_stime,
 483                                         &last_rusage->ru_stime),
 484                       interval / mean_interval,
 485                       (mean_interval + 8) / 16, n_samples);
 486             if (rusage.ru_minflt > last_rusage->ru_minflt
 487                 || rusage.ru_majflt > last_rusage->ru_majflt) {
 488                 VLOG_WARN("faults: %ld minor, %ld major",
 489                           rusage.ru_minflt - last_rusage->ru_minflt,
 490                           rusage.ru_majflt - last_rusage->ru_majflt);
 491             }
 492             if (rusage.ru_inblock > last_rusage->ru_inblock
 493                 || rusage.ru_oublock > last_rusage->ru_oublock) {
 494                 VLOG_WARN("disk: %ld reads, %ld writes",
 495                           rusage.ru_inblock - last_rusage->ru_inblock,
 496                           rusage.ru_oublock - last_rusage->ru_oublock);
 497             }
 498             if (rusage.ru_nvcsw > last_rusage->ru_nvcsw
 499                 || rusage.ru_nivcsw > last_rusage->ru_nivcsw) {
 500                 VLOG_WARN("context switches: %ld voluntary, %ld involuntary",
 501                           rusage.ru_nvcsw - last_rusage->ru_nvcsw,
 502                           rusage.ru_nivcsw - last_rusage->ru_nivcsw);
 503             }
 504         }
 505         coverage_log();
 506     }
 507
 508     /* Update exponentially weighted moving average.  With these parameters, a
 509      * given value decays to 1% of its value in about 100 time steps.  */
 510     if (n_samples++) {
 511         mean_interval = (mean_interval * 122 + interval * 6 + 64) / 128;
 512     } else {
 513         mean_interval = interval;
 514     }
 515 }
 516 \f
 517 /* CPU usage tracking. */
 518
 519 struct cpu_usage {
 520     long long int when;         /* Time that this sample was taken. */
 521     unsigned long long int cpu; /* Total user+system CPU usage when sampled. */
 522 };
 523
 524 static struct rusage recent_rusage;
 525 static struct cpu_usage older = { LLONG_MIN, 0 };
 526 static struct cpu_usage newer = { LLONG_MIN, 0 };
 527 static int cpu_usage = -1;
 528
 529 static struct rusage *
 530 get_recent_rusage(void)
 531 {
 532     return &recent_rusage;
 533 }
 534
 535 static void
 536 refresh_rusage(void)
 537 {
 538     long long int now;
 539
 540     now = time_msec();
 541     getrusage(RUSAGE_SELF, &recent_rusage);
 542
 543     if (now >= newer.when + 3 * 1000) {
 544         older = newer;
 545         newer.when = now;
 546         newer.cpu = (timeval_to_msec(&recent_rusage.ru_utime) +
 547                      timeval_to_msec(&recent_rusage.ru_stime));
 548
 549         if (older.when != LLONG_MIN && newer.cpu > older.cpu) {
 550             unsigned int dividend = newer.cpu - older.cpu;
 551             unsigned int divisor = (newer.when - older.when) / 100;
 552             cpu_usage = divisor > 0 ? dividend / divisor : -1;
 553         } else {
 554             cpu_usage = -1;
 555         }
 556     }
 557 }
 558
 559 /* Returns an estimate of this process's CPU usage, as a percentage, over the
 560  * past few seconds of wall-clock time.  Returns -1 if no estimate is available
 561  * (which will happen if the process has not been running long enough to have
 562  * an estimate, and can happen for other reasons as well). */
 563 int
 564 get_cpu_usage(void)
 565 {
 566     return cpu_usage;
 567 }
 568 \f
 569 /* Unixctl interface. */
 570
 571 /* "time/stop" stops the monotonic time returned by e.g. time_msec() from
 572  * advancing, except due to later calls to "time/warp". */
 573 static void
 574 timeval_stop_cb(struct unixctl_conn *conn,
 575                  int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
 576                  void *aux OVS_UNUSED)
 577 {
 578     time_stopped = true;
 579     unixctl_command_reply(conn, NULL);
 580 }
 581
 582 /* "time/warp MSECS" advances the current monotonic time by the specified
 583  * number of milliseconds.  Unless "time/stop" has also been executed, the
 584  * monotonic clock continues to tick forward at the normal rate afterward.
 585  *
 586  * Does not affect wall clock readings. */
 587 static void
 588 timeval_warp_cb(struct unixctl_conn *conn,
 589                 int argc OVS_UNUSED, const char *argv[], void *aux OVS_UNUSED)
 590 {
 591     struct timespec ts;
 592     int msecs;
 593
 594     msecs = atoi(argv[1]);
 595     if (msecs <= 0) {
 596         unixctl_command_reply_error(conn, "invalid MSECS");
 597         return;
 598     }
 599
 600     ts.tv_sec = msecs / 1000;
 601     ts.tv_nsec = (msecs % 1000) * 1000 * 1000;
 602     timespec_add(&warp_offset, &warp_offset, &ts);
 603     timespec_add(&monotonic_time, &monotonic_time, &ts);
 604     unixctl_command_reply(conn, "warped");
 605 }
 606
 607 void
 608 timeval_dummy_register(void)
 609 {
 610     unixctl_command_register("time/stop", "", 0, 0, timeval_stop_cb, NULL);
 611     unixctl_command_register("time/warp", "MSECS", 1, 1,
 612                              timeval_warp_cb, NULL);
 613 }