2 * Copyright (c) 2008, 2009 Nicira Networks.
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.
18 #include "poll-loop.h"
25 #include "backtrace.h"
27 #include "dynamic-string.h"
28 #include "fatal-signal.h"
32 #define THIS_MODULE VLM_poll_loop
35 /* An event that will wake the following call to poll_block(). */
37 /* Set when the waiter is created. */
38 struct list node; /* Element in global waiters list. */
39 int fd; /* File descriptor. */
40 short int events; /* Events to wait for (POLLIN, POLLOUT). */
41 poll_fd_func *function; /* Callback function, if any, or null. */
42 void *aux; /* Argument to callback function. */
43 struct backtrace *backtrace; /* Optionally, event that created waiter. */
45 /* Set only when poll_block() is called. */
46 struct pollfd *pollfd; /* Pointer to element of the pollfds array
47 (null if added from a callback). */
50 /* All active poll waiters. */
51 static struct list waiters = LIST_INITIALIZER(&waiters);
53 /* Number of elements in the waiters list. */
54 static size_t n_waiters;
56 /* Max time to wait in next call to poll_block(), in milliseconds, or -1 to
58 static int timeout = -1;
60 /* Backtrace of 'timeout''s registration, if debugging is enabled. */
61 static struct backtrace timeout_backtrace;
63 /* Callback currently running, to allow verifying that poll_cancel() is not
64 * being called on a running callback. */
66 static struct poll_waiter *running_cb;
69 static struct poll_waiter *new_waiter(int fd, short int events);
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.
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. */
79 poll_fd_wait(int fd, short int events)
81 COVERAGE_INC(poll_fd_wait);
82 return new_waiter(fd, events);
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.
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. */
93 poll_timer_wait(int msec)
95 if (timeout < 0 || msec < timeout) {
96 timeout = MAX(0, msec);
97 if (VLOG_IS_DBG_ENABLED()) {
98 backtrace_capture(&timeout_backtrace);
103 /* Causes the following call to poll_block() to wake up immediately, without
106 poll_immediate_wake(void)
111 static void PRINTF_FORMAT(2, 3)
112 log_wakeup(const struct backtrace *backtrace, const char *format, ...)
118 va_start(args, format);
119 ds_put_format_valist(&ds, format, args);
125 ds_put_char(&ds, ':');
126 for (i = 0; i < backtrace->n_frames; i++) {
127 ds_put_format(&ds, " 0x%"PRIxPTR, backtrace->frames[i]);
130 VLOG_DBG("%s", ds_cstr(&ds));
134 /* Blocks until one or more of the events registered with poll_fd_wait()
135 * occurs, or until the minimum duration registered with poll_timer_wait()
136 * elapses, or not at all if poll_immediate_wake() has been called.
138 * Also executes any autonomous subroutines registered with poll_fd_callback(),
139 * if their file descriptors have become ready. */
143 static struct pollfd *pollfds;
144 static size_t max_pollfds;
146 struct poll_waiter *pw;
151 /* Register fatal signal events before actually doing any real work for
156 if (max_pollfds < n_waiters) {
157 max_pollfds = n_waiters;
158 pollfds = xrealloc(pollfds, max_pollfds * sizeof *pollfds);
162 LIST_FOR_EACH (pw, struct poll_waiter, node, &waiters) {
163 pw->pollfd = &pollfds[n_pollfds];
164 pollfds[n_pollfds].fd = pw->fd;
165 pollfds[n_pollfds].events = pw->events;
166 pollfds[n_pollfds].revents = 0;
171 COVERAGE_INC(poll_zero_timeout);
173 retval = time_poll(pollfds, n_pollfds, timeout);
175 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
176 VLOG_ERR_RL(&rl, "poll: %s", strerror(-retval));
177 } else if (!retval && VLOG_IS_DBG_ENABLED()) {
178 log_wakeup(&timeout_backtrace, "%d-ms timeout", timeout);
181 for (node = waiters.next; node != &waiters; ) {
182 pw = CONTAINER_OF(node, struct poll_waiter, node);
183 if (!pw->pollfd || !pw->pollfd->revents) {
189 if (VLOG_IS_DBG_ENABLED()) {
190 log_wakeup(pw->backtrace, "%s%s%s%s%s on fd %d",
191 pw->pollfd->revents & POLLIN ? "[POLLIN]" : "",
192 pw->pollfd->revents & POLLOUT ? "[POLLOUT]" : "",
193 pw->pollfd->revents & POLLERR ? "[POLLERR]" : "",
194 pw->pollfd->revents & POLLHUP ? "[POLLHUP]" : "",
195 pw->pollfd->revents & POLLNVAL ? "[POLLNVAL]" : "",
203 pw->function(pw->fd, pw->pollfd->revents, pw->aux);
214 timeout_backtrace.n_frames = 0;
216 /* Handle any pending signals before doing anything else. */
220 /* Registers 'function' to be called with argument 'aux' by poll_block() when
221 * 'fd' becomes ready for one of the events in 'events', which should be POLLIN
222 * or POLLOUT or POLLIN | POLLOUT.
224 * The callback registration persists until the event actually occurs. At that
225 * point, it is automatically de-registered. The callback function must
226 * re-register the event by calling poll_fd_callback() again within the
227 * callback, if it wants to be called back again later. */
229 poll_fd_callback(int fd, short int events, poll_fd_func *function, void *aux)
231 struct poll_waiter *pw = new_waiter(fd, events);
232 pw->function = function;
237 /* Cancels the file descriptor event registered with poll_fd_wait() or
238 * poll_fd_callback(). 'pw' must be the struct poll_waiter returned by one of
241 * An event registered with poll_fd_wait() may be canceled from its time of
242 * registration until the next call to poll_block(). At that point, the event
243 * is automatically canceled by the system and its poll_waiter is freed.
245 * An event registered with poll_fd_callback() may be canceled from its time of
246 * registration until its callback is actually called. At that point, the
247 * event is automatically canceled by the system and its poll_waiter is
250 poll_cancel(struct poll_waiter *pw)
253 assert(pw != running_cb);
254 list_remove(&pw->node);
261 /* Creates and returns a new poll_waiter for 'fd' and 'events'. */
262 static struct poll_waiter *
263 new_waiter(int fd, short int events)
265 struct poll_waiter *waiter = xzalloc(sizeof *waiter);
268 waiter->events = events;
269 if (VLOG_IS_DBG_ENABLED()) {
270 waiter->backtrace = xmalloc(sizeof *waiter->backtrace);
271 backtrace_capture(waiter->backtrace);
273 list_push_back(&waiters, &waiter->node);