2 * This file is part of DisOrder.
3 * Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * @brief DisOrder event loop
27 #include <sys/types.h>
28 #include <sys/resource.h>
34 #include <sys/socket.h>
35 #include <netinet/in.h>
47 /** @brief A timeout */
51 ev_timeout_callback *callback;
56 /** @brief Comparison function for timeouts */
57 static int timeout_lt(const struct timeout *a,
58 const struct timeout *b) {
59 return tvlt(&a->when, &b->when);
62 HEAP_TYPE(timeout_heap, struct timeout *, timeout_lt);
63 HEAP_DEFINE(timeout_heap, struct timeout *, timeout_lt);
65 /** @brief A file descriptor in one mode */
68 ev_fd_callback *callback;
73 /** @brief All the file descriptors in a given mode */
75 /** @brief Mask of active file descriptors passed to @c select() */
78 /** @brief File descriptor mask returned from @c select() */
81 /** @brief Number of file descriptors in @p fds */
84 /** @brief Number of slots in @p fds */
87 /** @brief Array of all active file descriptors */
90 /** @brief Highest-numbered file descriptor or 0 */
94 /** @brief A signal handler */
96 struct sigaction oldsa;
97 ev_signal_callback *callback;
101 /** @brief A child process */
105 ev_child_callback *callback;
109 /** @brief An event loop */
111 /** @brief File descriptors, per mode */
112 struct fdmode mode[ev_nmodes];
114 /** @brief Heap of timeouts */
115 struct timeout_heap timeouts[1];
117 /** @brief Array of handled signals */
118 struct signal signals[NSIG];
120 /** @brief Mask of handled signals */
123 /** @brief Escape early from handling of @c select() results
125 * This is set if any of the file descriptor arrays are invalidated, since
126 * it's then not safe for processing of them to continue.
130 /** @brief Signal handling pipe
132 * The signal handle writes signal numbers down this pipe.
136 /** @brief Number of child processes in @p children */
139 /** @brief Number of slots in @p children */
142 /** @brief Array of child processes */
143 struct child *children;
146 /** @brief Names of file descriptor modes */
147 static const char *modenames[] = { "read", "write", "except" };
149 /* utilities ******************************************************************/
151 /* creation *******************************************************************/
153 /** @brief Create a new event loop */
154 ev_source *ev_new(void) {
155 ev_source *ev = xmalloc(sizeof *ev);
158 memset(ev, 0, sizeof *ev);
159 for(n = 0; n < ev_nmodes; ++n)
160 FD_ZERO(&ev->mode[n].enabled);
161 ev->sigpipe[0] = ev->sigpipe[1] = -1;
162 sigemptyset(&ev->sigmask);
163 timeout_heap_init(ev->timeouts);
167 /* event loop *****************************************************************/
169 /** @brief Run the event loop
170 * @return -1 on error, non-0 if any callback returned non-0
172 int ev_run(ev_source *ev) {
175 struct timeval delta;
179 struct timeout *timeouts, *t, **tt;
182 xgettimeofday(&now, 0);
183 /* Handle timeouts. We don't want to handle any timeouts that are added
184 * while we're handling them (otherwise we'd have to break out of infinite
185 * loops, preferrably without starving better-behaved subsystems). Hence
186 * the slightly complicated two-phase approach here. */
187 /* First we read those timeouts that have triggered out of the heap. We
188 * keep them in the same order they came out of the heap in. */
190 while(timeout_heap_count(ev->timeouts)
191 && tvle(&timeout_heap_first(ev->timeouts)->when, &now)) {
192 /* This timeout has reached its trigger time; provided it has not been
193 * cancelled we add it to the timeouts list. */
194 t = timeout_heap_remove(ev->timeouts);
201 /* Now we can run the callbacks for those timeouts. They might add further
202 * timeouts that are already in the past but they won't trigger until the
203 * next time round the event loop. */
204 for(t = timeouts; t; t = t->next) {
205 D(("calling timeout for %ld.%ld callback %p %p",
206 (long)t->when.tv_sec, (long)t->when.tv_usec,
207 (void *)t->callback, t->u));
208 ret = t->callback(ev, &now, t->u);
213 for(mode = 0; mode < ev_nmodes; ++mode) {
214 ev->mode[mode].tripped = ev->mode[mode].enabled;
215 if(ev->mode[mode].maxfd > maxfd)
216 maxfd = ev->mode[mode].maxfd;
218 xsigprocmask(SIG_UNBLOCK, &ev->sigmask, 0);
220 if(timeout_heap_count(ev->timeouts)) {
221 t = timeout_heap_first(ev->timeouts);
222 xgettimeofday(&now, 0);
223 delta.tv_sec = t->when.tv_sec - now.tv_sec;
224 delta.tv_usec = t->when.tv_usec - now.tv_usec;
225 if(delta.tv_usec < 0) {
226 delta.tv_usec += 1000000;
230 delta.tv_sec = delta.tv_usec = 0;
231 n = select(maxfd + 1,
232 &ev->mode[ev_read].tripped,
233 &ev->mode[ev_write].tripped,
234 &ev->mode[ev_except].tripped,
237 n = select(maxfd + 1,
238 &ev->mode[ev_read].tripped,
239 &ev->mode[ev_write].tripped,
240 &ev->mode[ev_except].tripped,
243 } while(n < 0 && errno == EINTR);
244 xsigprocmask(SIG_BLOCK, &ev->sigmask, 0);
246 error(errno, "error calling select");
248 /* If there's a bad FD in the mix then check them all and log what we
249 * find, to ease debugging */
250 for(mode = 0; mode < ev_nmodes; ++mode) {
251 for(n = 0; n < ev->mode[mode].nfds; ++n) {
252 const int fd = ev->mode[mode].fds[n].fd;
254 if(FD_ISSET(fd, &ev->mode[mode].enabled)
255 && fstat(fd, &sb) < 0)
256 error(errno, "mode %s fstat %d (%s)",
257 modenames[mode], fd, ev->mode[mode].fds[n].what);
259 for(n = 0; n <= maxfd; ++n)
260 if(FD_ISSET(n, &ev->mode[mode].enabled)
261 && fstat(n, &sb) < 0)
262 error(errno, "mode %s fstat %d", modenames[mode], n);
268 /* if anything deranges the meaning of an fd, or re-orders the
269 * fds[] tables, we'd better give up; such operations will
270 * therefore set @escape@. */
272 for(mode = 0; mode < ev_nmodes && !ev->escape; ++mode)
273 for(n = 0; n < ev->mode[mode].nfds && !ev->escape; ++n) {
274 int fd = ev->mode[mode].fds[n].fd;
275 if(FD_ISSET(fd, &ev->mode[mode].tripped)) {
276 D(("calling %s fd %d callback %p %p", modenames[mode], fd,
277 (void *)ev->mode[mode].fds[n].callback,
278 ev->mode[mode].fds[n].u));
279 ret = ev->mode[mode].fds[n].callback(ev, fd,
280 ev->mode[mode].fds[n].u);
286 /* we'll pick up timeouts back round the loop */
290 /* file descriptors ***********************************************************/
292 /** @brief Register a file descriptor
293 * @param ev Event loop
294 * @param mode @c ev_read or @c ev_write
295 * @param fd File descriptor
296 * @param callback Called when @p is readable/writable
297 * @param u Passed to @p callback
298 * @param what Text description
299 * @return 0 on success, non-0 on error
301 * Sets @ref ev_source::escape, so no further processing of file descriptors
302 * will occur this time round the event loop.
304 int ev_fd(ev_source *ev,
307 ev_fd_callback *callback,
312 D(("registering %s fd %d callback %p %p", modenames[mode], fd,
313 (void *)callback, u));
316 assert(mode < ev_nmodes);
317 if(ev->mode[mode].nfds >= ev->mode[mode].fdslots) {
318 ev->mode[mode].fdslots = (ev->mode[mode].fdslots
319 ? 2 * ev->mode[mode].fdslots : 16);
320 D(("expanding %s fd table to %d entries", modenames[mode],
321 ev->mode[mode].fdslots));
322 ev->mode[mode].fds = xrealloc(ev->mode[mode].fds,
323 ev->mode[mode].fdslots * sizeof (struct fd));
325 n = ev->mode[mode].nfds++;
326 FD_SET(fd, &ev->mode[mode].enabled);
327 ev->mode[mode].fds[n].fd = fd;
328 ev->mode[mode].fds[n].callback = callback;
329 ev->mode[mode].fds[n].u = u;
330 ev->mode[mode].fds[n].what = what;
331 if(fd > ev->mode[mode].maxfd)
332 ev->mode[mode].maxfd = fd;
337 /** @brief Cancel a file descriptor
338 * @param ev Event loop
339 * @param mode @c ev_read or @c ev_write
340 * @param fd File descriptor
341 * @return 0 on success, non-0 on error
343 * Sets @ref ev_source::escape, so no further processing of file descriptors
344 * will occur this time round the event loop.
346 int ev_fd_cancel(ev_source *ev, ev_fdmode mode, int fd) {
350 D(("cancelling mode %s fd %d", modenames[mode], fd));
351 /* find the right struct fd */
352 for(n = 0; n < ev->mode[mode].nfds && fd != ev->mode[mode].fds[n].fd; ++n)
354 assert(n < ev->mode[mode].nfds);
355 /* swap in the last fd and reduce the count */
356 if(n != ev->mode[mode].nfds - 1)
357 ev->mode[mode].fds[n] = ev->mode[mode].fds[ev->mode[mode].nfds - 1];
358 --ev->mode[mode].nfds;
359 /* if that was the biggest fd, find the new biggest one */
360 if(fd == ev->mode[mode].maxfd) {
362 for(n = 0; n < ev->mode[mode].nfds; ++n)
363 if(ev->mode[mode].fds[n].fd > maxfd)
364 maxfd = ev->mode[mode].fds[n].fd;
365 ev->mode[mode].maxfd = maxfd;
367 /* don't tell select about this fd any more */
368 FD_CLR(fd, &ev->mode[mode].enabled);
373 /** @brief Re-enable a file descriptor
374 * @param ev Event loop
375 * @param mode @c ev_read or @c ev_write
376 * @param fd File descriptor
377 * @return 0 on success, non-0 on error
379 * It is harmless if @p fd is currently disabled, but it must not have been
382 int ev_fd_enable(ev_source *ev, ev_fdmode mode, int fd) {
384 D(("enabling mode %s fd %d", modenames[mode], fd));
385 FD_SET(fd, &ev->mode[mode].enabled);
389 /** @brief Temporarily disable a file descriptor
390 * @param ev Event loop
391 * @param mode @c ev_read or @c ev_write
392 * @param fd File descriptor
393 * @return 0 on success, non-0 on error
395 * Re-enable with ev_fd_enable(). It is harmless if @p fd is already disabled,
396 * but it must not have been cancelled.
398 int ev_fd_disable(ev_source *ev, ev_fdmode mode, int fd) {
399 D(("disabling mode %s fd %d", modenames[mode], fd));
400 FD_CLR(fd, &ev->mode[mode].enabled);
401 FD_CLR(fd, &ev->mode[mode].tripped);
402 /* Suppress any pending callbacks */
407 /** @brief Log a report of file descriptor state */
408 void ev_report(ev_source *ev) {
417 for(mode = 0; mode < ev_nmodes; ++mode) {
418 D(("mode %s maxfd %d", modenames[mode], ev->mode[mode].maxfd));
419 for(n = 0; n < ev->mode[mode].nfds; ++n) {
420 fd = ev->mode[mode].fds[n].fd;
421 D(("fd %s %d%s%s (%s)", modenames[mode], fd,
422 FD_ISSET(fd, &ev->mode[mode].enabled) ? " enabled" : "",
423 FD_ISSET(fd, &ev->mode[mode].tripped) ? " tripped" : "",
424 ev->mode[mode].fds[n].what));
427 for(fd = 0; fd <= ev->mode[mode].maxfd; ++fd) {
428 if(!FD_ISSET(fd, &ev->mode[mode].enabled))
430 for(n = 0; n < ev->mode[mode].nfds; ++n) {
431 if(ev->mode[mode].fds[n].fd == fd)
434 if(n < ev->mode[mode].nfds)
435 snprintf(b, sizeof b, "%d(%s)", fd, ev->mode[mode].fds[n].what);
437 snprintf(b, sizeof b, "%d", fd);
438 dynstr_append(d, ' ');
439 dynstr_append_string(d, b);
442 D(("%s enabled:%s", modenames[mode], d->vec));
446 /* timeouts *******************************************************************/
448 /** @brief Register a timeout
449 * @param ev Event source
450 * @param handlep Where to store timeout handle, or @c NULL
451 * @param when Earliest time to call @p callback, or @c NULL
452 * @param callback Function to call at or after @p when
453 * @param u Passed to @p callback
454 * @return 0 on success, non-0 on error
456 * If @p when is a null pointer then a time of 0 is assumed. The effect is to
457 * call the timeout handler from ev_run() next time around the event loop.
458 * This is used internally to schedule various operations if it is not
459 * convenient to call them from the current place in the call stack, or
460 * externally to ensure that other clients of the event loop get a look in when
461 * performing some lengthy operation.
463 int ev_timeout(ev_source *ev,
464 ev_timeout_handle *handlep,
465 const struct timeval *when,
466 ev_timeout_callback *callback,
470 D(("registering timeout at %ld.%ld callback %p %p",
471 when ? (long)when->tv_sec : 0, when ? (long)when->tv_usec : 0,
472 (void *)callback, u));
473 t = xmalloc(sizeof *t);
476 t->callback = callback;
479 timeout_heap_insert(ev->timeouts, t);
485 /** @brief Cancel a timeout
486 * @param ev Event loop
487 * @param handle Handle returned from ev_timeout(), or 0
488 * @return 0 on success, non-0 on error
490 * If @p handle is 0 then this is a no-op.
492 int ev_timeout_cancel(ev_source attribute((unused)) *ev,
493 ev_timeout_handle handle) {
494 struct timeout *t = handle;
501 /* signals ********************************************************************/
503 /** @brief Mapping of signals to pipe write ends
505 * The pipes are per-event loop, it's possible in theory for there to be
506 * multiple event loops (e.g. in different threads), although in fact DisOrder
509 static int sigfd[NSIG];
511 /** @brief The signal handler
512 * @param s Signal number
514 * Writes to @c sigfd[s].
516 static void sighandler(int s) {
517 unsigned char sc = s;
518 static const char errmsg[] = "error writing to signal pipe";
520 /* probably the reader has stopped listening for some reason */
521 if(write(sigfd[s], &sc, 1) < 0) {
522 /* do the best we can as we're about to abort; shut _up_, gcc */
523 int _ignore = write(2, errmsg, sizeof errmsg - 1);
529 /** @brief Read callback for signals */
530 static int signal_read(ev_source *ev,
531 int attribute((unused)) fd,
532 void attribute((unused)) *u) {
537 if((n = read(ev->sigpipe[0], &s, 1)) == 1)
538 if((ret = ev->signals[s].callback(ev, s, ev->signals[s].u)))
541 if(n < 0 && (errno != EINTR && errno != EAGAIN)) {
542 error(errno, "error reading from signal pipe %d", ev->sigpipe[0]);
548 /** @brief Close the signal pipe */
549 static void close_sigpipe(ev_source *ev) {
550 int save_errno = errno;
552 xclose(ev->sigpipe[0]);
553 xclose(ev->sigpipe[1]);
554 ev->sigpipe[0] = ev->sigpipe[1] = -1;
558 /** @brief Register a signal handler
559 * @param ev Event loop
560 * @param sig Signal to handle
561 * @param callback Called when signal is delivered
562 * @param u Passed to @p callback
563 * @return 0 on success, non-0 on error
565 * Note that @p callback is called from inside ev_run(), not from inside the
566 * signal handler, so the usual restrictions on signal handlers do not apply.
568 int ev_signal(ev_source *ev,
570 ev_signal_callback *callback,
575 D(("registering signal %d handler callback %p %p", sig, (void *)callback, u));
578 assert(sig <= UCHAR_MAX);
579 if(ev->sigpipe[0] == -1) {
580 D(("creating signal pipe"));
582 D(("signal pipe is %d, %d", ev->sigpipe[0], ev->sigpipe[1]));
583 for(n = 0; n < 2; ++n) {
584 nonblock(ev->sigpipe[n]);
585 cloexec(ev->sigpipe[n]);
587 if(ev_fd(ev, ev_read, ev->sigpipe[0], signal_read, 0, "sigpipe read")) {
592 sigaddset(&ev->sigmask, sig);
593 xsigprocmask(SIG_BLOCK, &ev->sigmask, 0);
594 sigfd[sig] = ev->sigpipe[1];
595 ev->signals[sig].callback = callback;
596 ev->signals[sig].u = u;
597 sa.sa_handler = sighandler;
598 sigfillset(&sa.sa_mask);
599 sa.sa_flags = SA_RESTART;
600 xsigaction(sig, &sa, &ev->signals[sig].oldsa);
605 /** @brief Cancel a signal handler
606 * @param ev Event loop
607 * @param sig Signal to cancel
608 * @return 0 on success, non-0 on error
610 int ev_signal_cancel(ev_source *ev,
614 xsigaction(sig, &ev->signals[sig].oldsa, 0);
615 ev->signals[sig].callback = 0;
617 sigdelset(&ev->sigmask, sig);
620 xsigprocmask(SIG_UNBLOCK, &ss, 0);
624 /** @brief Clean up signal handling
625 * @param ev Event loop
627 * This function can be called from inside a fork. It restores signal
628 * handlers, unblocks the signals, and closes the signal pipe for @p ev.
630 void ev_signal_atfork(ev_source *ev) {
633 if(ev->sigpipe[0] != -1) {
634 /* revert any handled signals to their original state */
635 for(sig = 1; sig < NSIG; ++sig) {
636 if(ev->signals[sig].callback != 0)
637 xsigaction(sig, &ev->signals[sig].oldsa, 0);
639 /* and then unblock them */
640 xsigprocmask(SIG_UNBLOCK, &ev->sigmask, 0);
641 /* don't want a copy of the signal pipe open inside the fork */
642 xclose(ev->sigpipe[0]);
643 xclose(ev->sigpipe[1]);
647 /* child processes ************************************************************/
649 /** @brief Called on SIGCHLD */
650 static int sigchld_callback(ev_source *ev,
651 int attribute((unused)) sig,
652 void attribute((unused)) *u) {
655 int status, n, ret, revisit;
659 for(n = 0; n < ev->nchildren; ++n) {
660 r = wait4(ev->children[n].pid,
662 ev->children[n].options | WNOHANG,
665 ev_child_callback *c = ev->children[n].callback;
666 void *cu = ev->children[n].u;
668 if(WIFEXITED(status) || WIFSIGNALED(status))
669 ev_child_cancel(ev, r);
671 if((ret = c(ev, r, status, &ru, cu)))
674 /* We should "never" get an ECHILD but it can in fact happen. For
675 * instance on Linux 2.4.31, and probably other versions, if someone
676 * straces a child process and then a different child process
677 * terminates, when we wait4() the trace process we will get ECHILD
678 * because it has been reparented to strace. Obviously this is a
679 * hopeless design flaw in the tracing infrastructure, but we don't
680 * want the disorder server to bomb out because of it. So we just log
681 * the problem and ignore it.
683 error(errno, "error calling wait4 for PID %lu (broken ptrace?)",
684 (unsigned long)ev->children[n].pid);
693 /** @brief Configure event loop for child process handling
694 * @return 0 on success, non-0 on error
696 * Currently at most one event loop can handle child processes and it must be
697 * distinguished from others by calling this function on it. This could be
698 * fixed but since no process ever makes use of more than one event loop there
701 int ev_child_setup(ev_source *ev) {
702 D(("installing SIGCHLD handler"));
703 return ev_signal(ev, SIGCHLD, sigchld_callback, 0);
706 /** @brief Wait for a child process to terminate
707 * @param ev Event loop
708 * @param pid Process ID of child
709 * @param options Options to pass to @c wait4()
710 * @param callback Called when child terminates (or possibly when it stops)
711 * @param u Passed to @p callback
712 * @return 0 on success, non-0 on error
714 * You must have called ev_child_setup() on @p ev once first.
716 int ev_child(ev_source *ev,
719 ev_child_callback *callback,
723 D(("registering child handling %ld options %d callback %p %p",
724 (long)pid, options, (void *)callback, u));
725 assert(ev->signals[SIGCHLD].callback == sigchld_callback);
726 if(ev->nchildren >= ev->nchildslots) {
727 ev->nchildslots = ev->nchildslots ? 2 * ev->nchildslots : 16;
728 ev->children = xrealloc(ev->children,
729 ev->nchildslots * sizeof (struct child));
732 ev->children[n].pid = pid;
733 ev->children[n].options = options;
734 ev->children[n].callback = callback;
735 ev->children[n].u = u;
739 /** @brief Stop waiting for a child process
740 * @param ev Event loop
741 * @param pid Child process ID
742 * @return 0 on success, non-0 on error
744 int ev_child_cancel(ev_source *ev,
748 for(n = 0; n < ev->nchildren && ev->children[n].pid != pid; ++n)
750 assert(n < ev->nchildren);
751 if(n != ev->nchildren - 1)
752 ev->children[n] = ev->children[ev->nchildren - 1];
757 /** @brief Terminate and wait for all child processes
758 * @param ev Event loop
760 * Does *not* call the completion callbacks. Only used during teardown.
762 void ev_child_killall(ev_source *ev) {
765 for(n = 0; n < ev->nchildren; ++n) {
766 if(kill(ev->children[n].pid, SIGTERM) < 0) {
767 error(errno, "sending SIGTERM to pid %lu",
768 (unsigned long)ev->children[n].pid);
769 ev->children[n].pid = -1;
772 for(n = 0; n < ev->nchildren; ++n) {
773 if(ev->children[n].pid == -1)
776 rc = waitpid(ev->children[n].pid, &w, 0);
777 } while(rc < 0 && errno == EINTR);
779 error(errno, "waiting for pid %lu", (unsigned long)ev->children[n].pid);
786 /* socket listeners ***********************************************************/
788 /** @brief State for a socket listener */
789 struct listen_state {
790 ev_listen_callback *callback;
794 /** @brief Called when a listenign socket is readable */
795 static int listen_callback(ev_source *ev, int fd, void *u) {
796 const struct listen_state *l = u;
799 struct sockaddr_in in;
800 #if HAVE_STRUCT_SOCKADDR_IN6
801 struct sockaddr_in6 in6;
803 struct sockaddr_un un;
809 D(("callback for listener fd %d", fd));
810 while((addrlen = sizeof addr),
811 (newfd = accept(fd, &addr.sa, &addrlen)) >= 0) {
812 if((ret = l->callback(ev, newfd, &addr.sa, addrlen, l->u)))
821 error(errno, "error calling accept");
826 /* XXX on some systems EPROTO should be fatal, but we don't know if
827 * we're running on one of them */
828 error(errno, "error calling accept");
832 fatal(errno, "error calling accept");
835 if(errno != EINTR && errno != EAGAIN)
836 error(errno, "error calling accept");
840 /** @brief Listen on a socket for inbound stream connections
841 * @param ev Event source
842 * @param fd File descriptor of socket
843 * @param callback Called when a new connection arrives
844 * @param u Passed to @p callback
845 * @param what Text description of socket
846 * @return 0 on success, non-0 on error
848 int ev_listen(ev_source *ev,
850 ev_listen_callback *callback,
853 struct listen_state *l = xmalloc(sizeof *l);
855 D(("registering listener fd %d callback %p %p", fd, (void *)callback, u));
856 l->callback = callback;
858 return ev_fd(ev, ev_read, fd, listen_callback, l, what);
861 /** @brief Stop listening on a socket
862 * @param ev Event loop
863 * @param fd File descriptor of socket
864 * @return 0 on success, non-0 on error
866 int ev_listen_cancel(ev_source *ev, int fd) {
867 D(("cancelling listener fd %d", fd));
868 return ev_fd_cancel(ev, ev_read, fd);
871 /* buffer *********************************************************************/
873 /** @brief Buffer structure */
875 char *base, *start, *end, *top;
878 /* @brief Make sure there is @p bytes available at @c b->end */
879 static void buffer_space(struct buffer *b, size_t bytes) {
880 D(("buffer_space %p %p %p %p want %lu",
881 (void *)b->base, (void *)b->start, (void *)b->end, (void *)b->top,
882 (unsigned long)bytes));
883 if(b->start == b->end)
884 b->start = b->end = b->base;
885 if((size_t)(b->top - b->end) < bytes) {
886 if((size_t)((b->top - b->end) + (b->start - b->base)) < bytes) {
887 size_t newspace = b->end - b->start + bytes, n;
890 for(n = 16; n < newspace; n *= 2)
892 newbase = xmalloc_noptr(n);
893 memcpy(newbase, b->start, b->end - b->start);
895 b->end = newbase + (b->end - b->start);
896 b->top = newbase + n;
897 b->start = newbase; /* must be last */
899 memmove(b->base, b->start, b->end - b->start);
900 b->end = b->base + (b->end - b->start);
904 D(("result %p %p %p %p",
905 (void *)b->base, (void *)b->start, (void *)b->end, (void *)b->top));
908 /* readers and writers *******************************************************/
910 /** @brief State structure for a buffered writer */
912 /** @brief Sink used for writing to the buffer */
915 /** @brief Output buffer */
918 /** @brief File descriptor to write to */
921 /** @brief Set if there'll be no more output */
924 /** @brief Error/termination callback */
925 ev_error_callback *callback;
927 /** @brief Passed to @p callback */
930 /** @brief Parent event source */
933 /** @brief Maximum amount of time between succesful writes, 0 = don't care */
935 /** @brief Maximum amount of data to buffer, 0 = don't care */
937 /** @brief Error code to pass to @p callback (see writer_shutdown()) */
939 /** @brief Timeout handle for @p timebound (or 0) */
940 ev_timeout_handle timeout;
942 /** @brief Description of this writer */
945 /** @brief Tied reader or 0 */
948 /** @brief Set when abandoned */
952 /** @brief State structure for a buffered reader */
954 /** @brief Input buffer */
956 /** @brief File descriptor read from */
958 /** @brief Called when new data is available */
959 ev_reader_callback *callback;
960 /** @brief Called on error and shutdown */
961 ev_error_callback *error_callback;
962 /** @brief Passed to @p callback and @p error_callback */
964 /** @brief Parent event loop */
966 /** @brief Set when EOF is detected */
968 /** @brief Error code to pass to error callback */
970 /** @brief Tied writer or NULL */
974 /* buffered writer ************************************************************/
976 /** @brief Shut down the writer
978 * This is called to shut down a writer. The error callback is not called
979 * through any other path. Also we do not cancel @p fd from anywhere else,
980 * though we might disable it.
982 * It has the signature of a timeout callback so that it can be called from a
985 * Calls @p callback with @p w->syntherr as the error code (which might be 0).
987 static int writer_shutdown(ev_source *ev,
988 const attribute((unused)) struct timeval *now,
993 return 0; /* already shut down */
994 D(("writer_shutdown fd=%d error=%d", w->fd, w->error));
995 ev_timeout_cancel(ev, w->timeout);
996 ev_fd_cancel(ev, ev_write, w->fd);
999 D(("found a tied reader"));
1000 /* If there is a reader still around we just untie it */
1001 w->reader->writer = 0;
1002 shutdown(w->fd, SHUT_WR); /* there'll be no more writes */
1004 D(("no tied reader"));
1005 /* There's no reader so we are free to close the FD */
1009 return w->callback(ev, w->error, w->u);
1012 /** @brief Called when a writer's @p timebound expires */
1013 static int writer_timebound_exceeded(ev_source *ev,
1014 const struct timeval *now,
1016 ev_writer *const w = u;
1020 error(0, "abandoning writer '%s' because no writes within %ds",
1021 w->what, w->timebound);
1022 w->error = ETIMEDOUT;
1024 return writer_shutdown(ev, now, u);
1027 /** @brief Set the time bound callback (if not set already) */
1028 static void writer_set_timebound(ev_writer *w) {
1029 if(w->timebound && !w->timeout) {
1030 struct timeval when;
1031 ev_source *const ev = w->ev;
1033 xgettimeofday(&when, 0);
1034 when.tv_sec += w->timebound;
1035 ev_timeout(ev, &w->timeout, &when, writer_timebound_exceeded, w);
1039 /** @brief Called when a writer's file descriptor is writable */
1040 static int writer_callback(ev_source *ev, int fd, void *u) {
1041 ev_writer *const w = u;
1044 n = write(fd, w->b.start, w->b.end - w->b.start);
1045 D(("callback for writer fd %d, %ld bytes, n=%d, errno=%d",
1046 fd, (long)(w->b.end - w->b.start), n, errno));
1048 /* Consume bytes from the buffer */
1050 /* Suppress any outstanding timeout */
1051 ev_timeout_cancel(ev, w->timeout);
1053 if(w->b.start == w->b.end) {
1054 /* The buffer is empty */
1056 /* We're done, we can shut down this writer */
1058 return writer_shutdown(ev, 0, w);
1060 /* There might be more to come but we don't need writer_callback() to
1061 * be called for the time being */
1062 ev_fd_disable(ev, ev_write, fd);
1064 /* The buffer isn't empty, set a timeout so we give up if we don't manage
1065 * to write some more within a reasonable time */
1066 writer_set_timebound(w);
1074 return writer_shutdown(ev, 0, w);
1080 /** @brief Write bytes to a writer's buffer
1082 * This is the sink write callback.
1084 * Calls ev_fd_enable() if necessary (i.e. if the buffer was empty but
1087 static int ev_writer_write(struct sink *sk, const void *s, int n) {
1088 ev_writer *w = (ev_writer *)sk;
1091 return 0; /* avoid silliness */
1093 error(0, "ev_writer_write on %s after shutdown", w->what);
1094 if(w->spacebound && w->b.end - w->b.start + n > w->spacebound) {
1095 /* The new buffer contents will exceed the space bound. We assume that the
1096 * remote client has gone away and TCP hasn't noticed yet, or that it's got
1097 * hopelessly stuck. */
1100 error(0, "abandoning writer '%s' because buffer has reached %td bytes",
1101 w->what, w->b.end - w->b.start);
1102 ev_fd_disable(w->ev, ev_write, w->fd);
1104 return ev_timeout(w->ev, 0, 0, writer_shutdown, w);
1108 /* Make sure there is space */
1109 buffer_space(&w->b, n);
1110 /* If the buffer was formerly empty then we'll need to re-enable the FD */
1111 if(w->b.start == w->b.end)
1112 ev_fd_enable(w->ev, ev_write, w->fd);
1113 memcpy(w->b.end, s, n);
1115 /* Arrange a timeout if there wasn't one set already */
1116 writer_set_timebound(w);
1120 /** @brief Create a new buffered writer
1121 * @param ev Event loop
1122 * @param fd File descriptor to write to
1123 * @param callback Called if an error occurs and when finished
1124 * @param u Passed to @p callback
1125 * @param what Text description
1126 * @return New writer or @c NULL
1128 * Writers own their file descriptor and close it when they have finished with
1131 * If you pass the same fd to a reader and writer, you must tie them together
1134 ev_writer *ev_writer_new(ev_source *ev,
1136 ev_error_callback *callback,
1139 ev_writer *w = xmalloc(sizeof *w);
1141 D(("registering writer fd %d callback %p %p", fd, (void *)callback, u));
1142 w->s.write = ev_writer_write;
1144 w->callback = callback;
1147 w->timebound = 10 * 60;
1148 w->spacebound = 512 * 1024;
1150 if(ev_fd(ev, ev_write, fd, writer_callback, w, what))
1152 /* Buffer is initially empty so we don't want a callback */
1153 ev_fd_disable(ev, ev_write, fd);
1157 /** @brief Get/set the time bound
1159 * @param new_time_bound New bound or -1 for no change
1160 * @return Latest time bound
1162 * If @p new_time_bound is negative then the current time bound is returned.
1163 * Otherwise it is set and the new value returned.
1165 * The time bound is the number of seconds allowed between writes. If it takes
1166 * longer than this to flush a buffer then the peer will be assumed to be dead
1167 * and an error will be synthesized. 0 means "don't care". The default time
1168 * bound is 10 minutes.
1170 * Note that this value does not take into account kernel buffering and
1173 int ev_writer_time_bound(ev_writer *w,
1174 int new_time_bound) {
1175 if(new_time_bound >= 0)
1176 w->timebound = new_time_bound;
1177 return w->timebound;
1180 /** @brief Get/set the space bound
1182 * @param new_space_bound New bound or -1 for no change
1183 * @return Latest space bound
1185 * If @p new_space_bound is negative then the current space bound is returned.
1186 * Otherwise it is set and the new value returned.
1188 * The space bound is the number of bytes allowed between in the buffer. If
1189 * the buffer exceeds this size an error will be synthesized. 0 means "don't
1190 * care". The default space bound is 512Kbyte.
1192 * Note that this value does not take into account kernel buffering.
1194 int ev_writer_space_bound(ev_writer *w,
1195 int new_space_bound) {
1196 if(new_space_bound >= 0)
1197 w->spacebound = new_space_bound;
1198 return w->spacebound;
1201 /** @brief Return the sink associated with a writer
1203 * @return Pointer to sink
1205 * Writing to the sink will arrange for those bytes to be written to the file
1206 * descriptor as and when it is writable.
1208 struct sink *ev_writer_sink(ev_writer *w) {
1210 fatal(0, "ev_write_sink called with null writer");
1214 /** @brief Close a writer
1215 * @param w Writer to close
1216 * @return 0 on success, non-0 on error
1218 * Close a writer. No more bytes should be written to its sink.
1220 * When the last byte has been written the callback will be called with an
1221 * error code of 0. It is guaranteed that this will NOT happen before
1222 * ev_writer_close() returns (although the file descriptor for the writer might
1223 * be cancelled by the time it returns).
1225 int ev_writer_close(ev_writer *w) {
1226 D(("close writer fd %d", w->fd));
1228 return 0; /* already closed */
1230 if(w->b.start == w->b.end) {
1231 /* We're already finished */
1232 w->error = 0; /* no error */
1233 return ev_timeout(w->ev, 0, 0, writer_shutdown, w);
1238 /** @brief Attempt to flush a writer
1239 * @param w Writer to flush
1240 * @return 0 on success, non-0 on error
1242 * Does a speculative write of any buffered data. Does not block if it cannot
1245 int ev_writer_flush(ev_writer *w) {
1246 return writer_callback(w->ev, w->fd, w);
1249 /* buffered reader ************************************************************/
1251 /** @brief Shut down a reader
1253 * This is the only path through which we cancel and close the file descriptor.
1254 * As with the writer case it is given timeout signature to allow it be
1255 * deferred to the next iteration of the event loop.
1257 * We only call @p error_callback if @p error is nonzero (unlike the writer
1260 static int reader_shutdown(ev_source *ev,
1261 const attribute((unused)) struct timeval *now,
1263 ev_reader *const r = u;
1266 return 0; /* already shut down */
1267 D(("reader_shutdown fd=%d", r->fd));
1268 ev_fd_cancel(ev, ev_read, r->fd);
1271 D(("found a tied writer"));
1272 /* If there is a writer still around we just untie it */
1273 r->writer->reader = 0;
1274 shutdown(r->fd, SHUT_RD); /* there'll be no more reads */
1276 D(("no tied writer found"));
1277 /* There's no writer so we are free to close the FD */
1282 return r->error_callback(ev, r->error, r->u);
1287 /** @brief Called when a reader's @p fd is readable */
1288 static int reader_callback(ev_source *ev, int fd, void *u) {
1292 buffer_space(&r->b, 1);
1293 n = read(fd, r->b.end, r->b.top - r->b.end);
1294 D(("read fd %d buffer %d returned %d errno %d",
1295 fd, (int)(r->b.top - r->b.end), n, errno));
1298 return r->callback(ev, r, r->b.start, r->b.end - r->b.start, 0, r->u);
1300 /* No more read callbacks needed */
1301 ev_fd_disable(r->ev, ev_read, r->fd);
1302 ev_timeout(r->ev, 0, 0, reader_shutdown, r);
1303 /* Pass the remaining data and an eof indicator to the user */
1304 return r->callback(ev, r, r->b.start, r->b.end - r->b.start, 1, r->u);
1311 /* Fatal error, kill the reader now */
1313 return reader_shutdown(ev, 0, r);
1319 /** @brief Create a new buffered reader
1320 * @param ev Event loop
1321 * @param fd File descriptor to read from
1322 * @param callback Called when new data is available
1323 * @param error_callback Called if an error occurs
1324 * @param u Passed to callbacks
1325 * @param what Text description
1326 * @return New reader or @c NULL
1328 * Readers own their fd and close it when they are finished with it.
1330 * If you pass the same fd to a reader and writer, you must tie them together
1333 ev_reader *ev_reader_new(ev_source *ev,
1335 ev_reader_callback *callback,
1336 ev_error_callback *error_callback,
1339 ev_reader *r = xmalloc(sizeof *r);
1341 D(("registering reader fd %d callback %p %p %p",
1342 fd, (void *)callback, (void *)error_callback, u));
1344 r->callback = callback;
1345 r->error_callback = error_callback;
1348 if(ev_fd(ev, ev_read, fd, reader_callback, r, what))
1353 void ev_reader_buffer(ev_reader *r, size_t nbytes) {
1354 buffer_space(&r->b, nbytes - (r->b.end - r->b.start));
1357 /** @brief Consume @p n bytes from the reader's buffer
1359 * @param n Number of bytes to consume
1361 * Tells the reader than the next @p n bytes have been dealt with and can now
1364 void ev_reader_consume(ev_reader *r, size_t n) {
1368 /** @brief Cancel a reader
1370 * @return 0 on success, non-0 on error
1372 * No further callbacks will be made, and the FD will be closed (in a later
1373 * iteration of the event loop).
1375 int ev_reader_cancel(ev_reader *r) {
1376 D(("cancel reader fd %d", r->fd));
1378 return 0; /* already thoroughly cancelled */
1379 ev_fd_disable(r->ev, ev_read, r->fd);
1380 return ev_timeout(r->ev, 0, 0, reader_shutdown, r);
1383 /** @brief Temporarily disable a reader
1385 * @return 0 on success, non-0 on error
1387 * No further callbacks for this reader will be made. Re-enable with
1388 * ev_reader_enable().
1390 int ev_reader_disable(ev_reader *r) {
1391 D(("disable reader fd %d", r->fd));
1392 return ev_fd_disable(r->ev, ev_read, r->fd);
1395 /** @brief Called from ev_run() for ev_reader_incomplete() */
1396 static int reader_continuation(ev_source attribute((unused)) *ev,
1397 const attribute((unused)) struct timeval *now,
1401 D(("reader continuation callback fd %d", r->fd));
1402 /* If not at EOF turn the FD back on */
1404 if(ev_fd_enable(r->ev, ev_read, r->fd))
1406 /* We're already in a timeout callback so there's no reason we can't call the
1407 * user callback directly (compare ev_reader_enable()). */
1408 return r->callback(ev, r, r->b.start, r->b.end - r->b.start, r->eof, r->u);
1411 /** @brief Arrange another callback
1413 * @return 0 on success, non-0 on error
1415 * Indicates that the reader can process more input but would like to yield to
1416 * other clients of the event loop. Input will be disabled but it will be
1417 * re-enabled on the next iteration of the event loop and the read callback
1418 * will be called again (even if no further bytes are available).
1420 int ev_reader_incomplete(ev_reader *r) {
1421 if(ev_fd_disable(r->ev, ev_read, r->fd)) return -1;
1422 return ev_timeout(r->ev, 0, 0, reader_continuation, r);
1425 static int reader_enabled(ev_source *ev,
1426 const attribute((unused)) struct timeval *now,
1430 D(("reader enabled callback fd %d", r->fd));
1431 return r->callback(ev, r, r->b.start, r->b.end - r->b.start, r->eof, r->u);
1434 /** @brief Re-enable reading
1436 * @return 0 on success, non-0 on error
1438 * If there is unconsumed data then you get a callback next time round the
1439 * event loop even if nothing new has been read.
1441 * The idea is in your read callback you come across a line (or whatever) that
1442 * can't be processed immediately. So you set up processing and disable
1443 * reading with ev_reader_disable(). Later when you finish processing you
1444 * re-enable. You'll automatically get another callback directly from the
1445 * event loop (i.e. not from inside ev_reader_enable()) so you can handle the
1446 * next line (or whatever) if the whole thing has in fact already arrived.
1448 * The difference between this process and calling ev_reader_incomplete() is
1449 * ev_reader_incomplete() deals with the case where you can process now but
1450 * would rather yield to other clients of the event loop, while using
1451 * ev_reader_disable() and ev_reader_enable() deals with the case where you
1452 * cannot process input yet because some other process is actually not
1455 int ev_reader_enable(ev_reader *r) {
1456 D(("enable reader fd %d", r->fd));
1458 /* First if we're not at EOF then we re-enable reading */
1460 if(ev_fd_enable(r->ev, ev_read, r->fd))
1462 /* Arrange another callback next time round the event loop */
1463 return ev_timeout(r->ev, 0, 0, reader_enabled, r);
1466 /** @brief Tie a reader and a writer together
1469 * @return 0 on success, non-0 on error
1471 * This function must be called if @p r and @p w share a file descritptor.
1473 int ev_tie(ev_reader *r, ev_writer *w) {
1474 assert(r->writer == 0);
1475 assert(w->reader == 0);