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