lib/poll-loop.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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 "poll-loop.h"
  19 #include <errno.h>
  20 #include <inttypes.h>
  21 #include <poll.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include "coverage.h"
  25 #include "dynamic-string.h"
  26 #include "fatal-signal.h"
  27 #include "list.h"
  28 #include "ovs-thread.h"
  29 #include "seq.h"
  30 #include "socket-util.h"
  31 #include "timeval.h"
  32 #include "vlog.h"
  33
  34 VLOG_DEFINE_THIS_MODULE(poll_loop);
  35
  36 COVERAGE_DEFINE(poll_fd_wait);
  37 COVERAGE_DEFINE(poll_zero_timeout);
  38
  39 struct poll_loop {
  40     /* All active poll waiters. */
  41     struct pollfd *pollfds;     /* Events to pass to poll(). */
  42     const char **where;         /* Where each pollfd was created. */
  43     size_t n_waiters;           /* Number of elems in 'where' and 'pollfds'. */
  44     size_t allocated_waiters;   /* Allocated elems in 'where' and 'pollfds'. */
  45
  46     /* Time at which to wake up the next call to poll_block(), LLONG_MIN to
  47      * wake up immediately, or LLONG_MAX to wait forever. */
  48     long long int timeout_when; /* In msecs as returned by time_msec(). */
  49     const char *timeout_where;  /* Where 'timeout_when' was set. */
  50 };
  51
  52 static struct poll_loop *poll_loop(void);
  53
  54 /* Registers 'fd' as waiting for the specified 'events' (which should be POLLIN
  55  * or POLLOUT or POLLIN | POLLOUT).  The following call to poll_block() will
  56  * wake up when 'fd' becomes ready for one or more of the requested events.
  57  *
  58  * The event registration is one-shot: only the following call to poll_block()
  59  * is affected.  The event will need to be re-registered after poll_block() is
  60  * called if it is to persist.
  61  *
  62  * ('where' is used in debug logging.  Commonly one would use poll_fd_wait() to
  63  * automatically provide the caller's source file and line number for
  64  * 'where'.) */
  65 void
  66 poll_fd_wait_at(int fd, short int events, const char *where)
  67 {
  68     struct poll_loop *loop = poll_loop();
  69
  70     COVERAGE_INC(poll_fd_wait);
  71     if (loop->n_waiters >= loop->allocated_waiters) {
  72         loop->where = x2nrealloc(loop->where, &loop->allocated_waiters,
  73                                  sizeof *loop->where);
  74         loop->pollfds = xrealloc(loop->pollfds,
  75                                  (loop->allocated_waiters
  76                                   * sizeof *loop->pollfds));
  77     }
  78
  79     loop->where[loop->n_waiters] = where;
  80     loop->pollfds[loop->n_waiters].fd = fd;
  81     loop->pollfds[loop->n_waiters].events = events;
  82     loop->n_waiters++;
  83 }
  84
  85 /* Causes the following call to poll_block() to block for no more than 'msec'
  86  * milliseconds.  If 'msec' is nonpositive, the following call to poll_block()
  87  * will not block at all.
  88  *
  89  * The timer registration is one-shot: only the following call to poll_block()
  90  * is affected.  The timer will need to be re-registered after poll_block() is
  91  * called if it is to persist.
  92  *
  93  * ('where' is used in debug logging.  Commonly one would use poll_timer_wait()
  94  * to automatically provide the caller's source file and line number for
  95  * 'where'.) */
  96 void
  97 poll_timer_wait_at(long long int msec, const char *where)
  98 {
  99     long long int now = time_msec();
 100     long long int when;
 101
 102     if (msec <= 0) {
 103         /* Wake up immediately. */
 104         when = LLONG_MIN;
 105     } else if ((unsigned long long int) now + msec <= LLONG_MAX) {
 106         /* Normal case. */
 107         when = now + msec;
 108     } else {
 109         /* now + msec would overflow. */
 110         when = LLONG_MAX;
 111     }
 112
 113     poll_timer_wait_until_at(when, where);
 114 }
 115
 116 /* Causes the following call to poll_block() to wake up when the current time,
 117  * as returned by time_msec(), reaches 'when' or later.  If 'when' is earlier
 118  * than the current time, the following call to poll_block() will not block at
 119  * all.
 120  *
 121  * The timer registration is one-shot: only the following call to poll_block()
 122  * is affected.  The timer will need to be re-registered after poll_block() is
 123  * called if it is to persist.
 124  *
 125  * ('where' is used in debug logging.  Commonly one would use
 126  * poll_timer_wait_until() to automatically provide the caller's source file
 127  * and line number for 'where'.) */
 128 void
 129 poll_timer_wait_until_at(long long int when, const char *where)
 130 {
 131     struct poll_loop *loop = poll_loop();
 132     if (when < loop->timeout_when) {
 133         loop->timeout_when = when;
 134         loop->timeout_where = where;
 135     }
 136 }
 137
 138 /* Causes the following call to poll_block() to wake up immediately, without
 139  * blocking.
 140  *
 141  * ('where' is used in debug logging.  Commonly one would use
 142  * poll_immediate_wake() to automatically provide the caller's source file and
 143  * line number for 'where'.) */
 144 void
 145 poll_immediate_wake_at(const char *where)
 146 {
 147     poll_timer_wait_at(0, where);
 148 }
 149
 150 /* Logs, if appropriate, that the poll loop was awakened by an event
 151  * registered at 'where' (typically a source file and line number).  The other
 152  * arguments have two possible interpretations:
 153  *
 154  *   - If 'pollfd' is nonnull then it should be the "struct pollfd" that caused
 155  *     the wakeup.  'timeout' is ignored.
 156  *
 157  *   - If 'pollfd' is NULL then 'timeout' is the number of milliseconds after
 158  *     which the poll loop woke up.
 159  */
 160 static void
 161 log_wakeup(const char *where, const struct pollfd *pollfd, int timeout)
 162 {
 163     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
 164     enum vlog_level level;
 165     int cpu_usage;
 166     struct ds s;
 167
 168     cpu_usage = get_cpu_usage();
 169     if (VLOG_IS_DBG_ENABLED()) {
 170         level = VLL_DBG;
 171     } else if (cpu_usage > 50 && !VLOG_DROP_INFO(&rl)) {
 172         level = VLL_INFO;
 173     } else {
 174         return;
 175     }
 176
 177     ds_init(&s);
 178     ds_put_cstr(&s, "wakeup due to ");
 179     if (pollfd) {
 180         char *description = describe_fd(pollfd->fd);
 181         if (pollfd->revents & POLLIN) {
 182             ds_put_cstr(&s, "[POLLIN]");
 183         }
 184         if (pollfd->revents & POLLOUT) {
 185             ds_put_cstr(&s, "[POLLOUT]");
 186         }
 187         if (pollfd->revents & POLLERR) {
 188             ds_put_cstr(&s, "[POLLERR]");
 189         }
 190         if (pollfd->revents & POLLHUP) {
 191             ds_put_cstr(&s, "[POLLHUP]");
 192         }
 193         if (pollfd->revents & POLLNVAL) {
 194             ds_put_cstr(&s, "[POLLNVAL]");
 195         }
 196         ds_put_format(&s, " on fd %d (%s)", pollfd->fd, description);
 197         free(description);
 198     } else {
 199         ds_put_format(&s, "%d-ms timeout", timeout);
 200     }
 201     if (where) {
 202         ds_put_format(&s, " at %s", where);
 203     }
 204     if (cpu_usage >= 0) {
 205         ds_put_format(&s, " (%d%% CPU usage)", cpu_usage);
 206     }
 207     VLOG(level, "%s", ds_cstr(&s));
 208     ds_destroy(&s);
 209 }
 210
 211 /* Blocks until one or more of the events registered with poll_fd_wait()
 212  * occurs, or until the minimum duration registered with poll_timer_wait()
 213  * elapses, or not at all if poll_immediate_wake() has been called. */
 214 void
 215 poll_block(void)
 216 {
 217     struct poll_loop *loop = poll_loop();
 218     int elapsed;
 219     int retval;
 220
 221     /* Register fatal signal events before actually doing any real work for
 222      * poll_block. */
 223     fatal_signal_wait();
 224
 225     if (loop->timeout_when == LLONG_MIN) {
 226         COVERAGE_INC(poll_zero_timeout);
 227     }
 228
 229     retval = time_poll(loop->pollfds, loop->n_waiters,
 230                        loop->timeout_when, &elapsed);
 231     if (retval < 0) {
 232         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 233         VLOG_ERR_RL(&rl, "poll: %s", ovs_strerror(-retval));
 234     } else if (!retval) {
 235         log_wakeup(loop->timeout_where, NULL, elapsed);
 236     } else if (get_cpu_usage() > 50 || VLOG_IS_DBG_ENABLED()) {
 237         size_t i;
 238
 239         for (i = 0; i < loop->n_waiters; i++) {
 240             if (loop->pollfds[i].revents) {
 241                 log_wakeup(loop->where[i], &loop->pollfds[i], 0);
 242             }
 243         }
 244     }
 245
 246     loop->timeout_when = LLONG_MAX;
 247     loop->timeout_where = NULL;
 248     loop->n_waiters = 0;
 249
 250     /* Handle any pending signals before doing anything else. */
 251     fatal_signal_run();
 252
 253     seq_woke();
 254 }
 255 \f
 256 static void
 257 free_poll_loop(void *loop_)
 258 {
 259     struct poll_loop *loop = loop_;
 260
 261     free(loop->pollfds);
 262     free(loop->where);
 263     free(loop);
 264 }
 265
 266 static struct poll_loop *
 267 poll_loop(void)
 268 {
 269     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 270     static pthread_key_t key;
 271     struct poll_loop *loop;
 272
 273     if (ovsthread_once_start(&once)) {
 274         xpthread_key_create(&key, free_poll_loop);
 275         ovsthread_once_done(&once);
 276     }
 277
 278     loop = pthread_getspecific(key);
 279     if (!loop) {
 280         loop = xzalloc(sizeof *loop);
 281         xpthread_setspecific(key, loop);
 282     }
 283     return loop;
 284 }
 285