2 * Copyright (c) 2009-2012 Niels Provos, Nick Mathewson
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. The name of the author may not be used to endorse or promote products
13 * derived from this software without specific prior written permission.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include "event2/event-config.h"
28 #include "evconfig-private.h"
30 #include <sys/types.h>
34 /* Minimum required for InitializeCriticalSectionAndSpinCount */
35 #define _WIN32_WINNT 0x0403
42 #ifdef EVENT__HAVE_SYS_SOCKET_H
43 #include <sys/socket.h>
45 #ifdef EVENT__HAVE_FCNTL_H
48 #ifdef EVENT__HAVE_UNISTD_H
52 #include "event2/listener.h"
53 #include "event2/util.h"
54 #include "event2/event.h"
55 #include "event2/event_struct.h"
56 #include "mm-internal.h"
57 #include "util-internal.h"
58 #include "log-internal.h"
59 #include "evthread-internal.h"
61 #include "iocp-internal.h"
62 #include "defer-internal.h"
63 #include "event-internal.h"
66 struct evconnlistener_ops {
67 int (*enable)(struct evconnlistener *);
68 int (*disable)(struct evconnlistener *);
69 void (*destroy)(struct evconnlistener *);
70 void (*shutdown)(struct evconnlistener *);
71 evutil_socket_t (*getfd)(struct evconnlistener *);
72 struct event_base *(*getbase)(struct evconnlistener *);
75 struct evconnlistener {
76 const struct evconnlistener_ops *ops;
79 evconnlistener_errorcb errorcb;
87 struct evconnlistener_event {
88 struct evconnlistener base;
89 struct event listener;
93 struct evconnlistener_iocp {
94 struct evconnlistener base;
96 struct event_base *event_base;
97 struct event_iocp_port *port;
99 unsigned shutting_down : 1;
100 unsigned event_added : 1;
101 struct accepting_socket **accepting;
105 #define LOCK(listener) EVLOCK_LOCK((listener)->lock, 0)
106 #define UNLOCK(listener) EVLOCK_UNLOCK((listener)->lock, 0)
108 struct evconnlistener *
109 evconnlistener_new_async(struct event_base *base,
110 evconnlistener_cb cb, void *ptr, unsigned flags, int backlog,
111 evutil_socket_t fd); /* XXXX export this? */
113 static int event_listener_enable(struct evconnlistener *);
114 static int event_listener_disable(struct evconnlistener *);
115 static void event_listener_destroy(struct evconnlistener *);
116 static evutil_socket_t event_listener_getfd(struct evconnlistener *);
117 static struct event_base *event_listener_getbase(struct evconnlistener *);
121 listener_incref_and_lock(struct evconnlistener *listener)
129 listener_decref_and_unlock(struct evconnlistener *listener)
131 int refcnt = --listener->refcnt;
133 listener->ops->destroy(listener);
135 EVTHREAD_FREE_LOCK(listener->lock, EVTHREAD_LOCKTYPE_RECURSIVE);
144 static const struct evconnlistener_ops evconnlistener_event_ops = {
145 event_listener_enable,
146 event_listener_disable,
147 event_listener_destroy,
149 event_listener_getfd,
150 event_listener_getbase
153 static void listener_read_cb(evutil_socket_t, short, void *);
155 struct evconnlistener *
156 evconnlistener_new(struct event_base *base,
157 evconnlistener_cb cb, void *ptr, unsigned flags, int backlog,
160 struct evconnlistener_event *lev;
163 if (base && event_base_get_iocp_(base)) {
164 const struct win32_extension_fns *ext =
165 event_get_win32_extension_fns_();
166 if (ext->AcceptEx && ext->GetAcceptExSockaddrs)
167 return evconnlistener_new_async(base, cb, ptr, flags,
173 if (listen(fd, backlog) < 0)
175 } else if (backlog < 0) {
176 if (listen(fd, 128) < 0)
180 lev = mm_calloc(1, sizeof(struct evconnlistener_event));
184 lev->base.ops = &evconnlistener_event_ops;
186 lev->base.user_data = ptr;
187 lev->base.flags = flags;
188 lev->base.refcnt = 1;
190 lev->base.accept4_flags = 0;
191 if (!(flags & LEV_OPT_LEAVE_SOCKETS_BLOCKING))
192 lev->base.accept4_flags |= EVUTIL_SOCK_NONBLOCK;
193 if (flags & LEV_OPT_CLOSE_ON_EXEC)
194 lev->base.accept4_flags |= EVUTIL_SOCK_CLOEXEC;
196 if (flags & LEV_OPT_THREADSAFE) {
197 EVTHREAD_ALLOC_LOCK(lev->base.lock, EVTHREAD_LOCKTYPE_RECURSIVE);
200 event_assign(&lev->listener, base, fd, EV_READ|EV_PERSIST,
201 listener_read_cb, lev);
203 if (!(flags & LEV_OPT_DISABLED))
204 evconnlistener_enable(&lev->base);
209 struct evconnlistener *
210 evconnlistener_new_bind(struct event_base *base, evconnlistener_cb cb,
211 void *ptr, unsigned flags, int backlog, const struct sockaddr *sa,
214 struct evconnlistener *listener;
217 int family = sa ? sa->sa_family : AF_UNSPEC;
218 int socktype = SOCK_STREAM | EVUTIL_SOCK_NONBLOCK;
223 if (flags & LEV_OPT_CLOSE_ON_EXEC)
224 socktype |= EVUTIL_SOCK_CLOEXEC;
226 fd = evutil_socket_(family, socktype, 0);
230 if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, (void*)&on, sizeof(on))<0)
233 if (flags & LEV_OPT_REUSEABLE) {
234 if (evutil_make_listen_socket_reuseable(fd) < 0)
238 if (flags & LEV_OPT_REUSEABLE_PORT) {
239 if (evutil_make_listen_socket_reuseable_port(fd) < 0)
243 if (flags & LEV_OPT_DEFERRED_ACCEPT) {
244 if (evutil_make_tcp_listen_socket_deferred(fd) < 0)
249 if (bind(fd, sa, socklen)<0)
253 listener = evconnlistener_new(base, cb, ptr, flags, backlog, fd);
259 evutil_closesocket(fd);
264 evconnlistener_free(struct evconnlistener *lev)
269 if (lev->ops->shutdown)
270 lev->ops->shutdown(lev);
271 listener_decref_and_unlock(lev);
275 event_listener_destroy(struct evconnlistener *lev)
277 struct evconnlistener_event *lev_e =
278 EVUTIL_UPCAST(lev, struct evconnlistener_event, base);
280 event_del(&lev_e->listener);
281 if (lev->flags & LEV_OPT_CLOSE_ON_FREE)
282 evutil_closesocket(event_get_fd(&lev_e->listener));
283 event_debug_unassign(&lev_e->listener);
287 evconnlistener_enable(struct evconnlistener *lev)
293 r = lev->ops->enable(lev);
301 evconnlistener_disable(struct evconnlistener *lev)
306 r = lev->ops->disable(lev);
312 event_listener_enable(struct evconnlistener *lev)
314 struct evconnlistener_event *lev_e =
315 EVUTIL_UPCAST(lev, struct evconnlistener_event, base);
316 return event_add(&lev_e->listener, NULL);
320 event_listener_disable(struct evconnlistener *lev)
322 struct evconnlistener_event *lev_e =
323 EVUTIL_UPCAST(lev, struct evconnlistener_event, base);
324 return event_del(&lev_e->listener);
328 evconnlistener_get_fd(struct evconnlistener *lev)
332 fd = lev->ops->getfd(lev);
337 static evutil_socket_t
338 event_listener_getfd(struct evconnlistener *lev)
340 struct evconnlistener_event *lev_e =
341 EVUTIL_UPCAST(lev, struct evconnlistener_event, base);
342 return event_get_fd(&lev_e->listener);
346 evconnlistener_get_base(struct evconnlistener *lev)
348 struct event_base *base;
350 base = lev->ops->getbase(lev);
355 static struct event_base *
356 event_listener_getbase(struct evconnlistener *lev)
358 struct evconnlistener_event *lev_e =
359 EVUTIL_UPCAST(lev, struct evconnlistener_event, base);
360 return event_get_base(&lev_e->listener);
364 evconnlistener_set_cb(struct evconnlistener *lev,
365 evconnlistener_cb cb, void *arg)
369 if (lev->enabled && !lev->cb)
372 lev->user_data = arg;
374 evconnlistener_enable(lev);
379 evconnlistener_set_error_cb(struct evconnlistener *lev,
380 evconnlistener_errorcb errorcb)
383 lev->errorcb = errorcb;
388 listener_read_cb(evutil_socket_t fd, short what, void *p)
390 struct evconnlistener *lev = p;
392 evconnlistener_cb cb;
393 evconnlistener_errorcb errorcb;
397 struct sockaddr_storage ss;
398 ev_socklen_t socklen = sizeof(ss);
399 evutil_socket_t new_fd = evutil_accept4_(fd, (struct sockaddr*)&ss, &socklen, lev->accept4_flags);
403 /* This can happen with some older linux kernels in
404 * response to nmap. */
405 evutil_closesocket(new_fd);
409 if (lev->cb == NULL) {
410 evutil_closesocket(new_fd);
416 user_data = lev->user_data;
418 cb(lev, new_fd, (struct sockaddr*)&ss, (int)socklen,
421 if (lev->refcnt == 1) {
422 int freed = listener_decref_and_unlock(lev);
423 EVUTIL_ASSERT(freed);
425 evutil_closesocket(new_fd);
430 err = evutil_socket_geterror(fd);
431 if (EVUTIL_ERR_ACCEPT_RETRIABLE(err)) {
435 if (lev->errorcb != NULL) {
437 errorcb = lev->errorcb;
438 user_data = lev->user_data;
440 errorcb(lev, user_data);
442 listener_decref_and_unlock(lev);
444 event_sock_warn(fd, "Error from accept() call");
450 struct accepting_socket {
451 CRITICAL_SECTION lock;
452 struct event_overlapped overlapped;
455 struct event_callback deferred;
456 struct evconnlistener_iocp *lev;
459 unsigned free_on_cb:1;
463 static void accepted_socket_cb(struct event_overlapped *o, ev_uintptr_t key,
464 ev_ssize_t n, int ok);
465 static void accepted_socket_invoke_user_cb(struct event_callback *cb, void *arg);
468 iocp_listener_event_add(struct evconnlistener_iocp *lev)
470 if (lev->event_added)
473 lev->event_added = 1;
474 event_base_add_virtual_(lev->event_base);
478 iocp_listener_event_del(struct evconnlistener_iocp *lev)
480 if (!lev->event_added)
483 lev->event_added = 0;
484 event_base_del_virtual_(lev->event_base);
487 static struct accepting_socket *
488 new_accepting_socket(struct evconnlistener_iocp *lev, int family)
490 struct accepting_socket *res;
494 if (family == AF_INET)
495 addrlen = sizeof(struct sockaddr_in);
496 else if (family == AF_INET6)
497 addrlen = sizeof(struct sockaddr_in6);
500 buflen = (addrlen+16)*2;
502 res = mm_calloc(1,sizeof(struct accepting_socket)-1+buflen);
506 event_overlapped_init_(&res->overlapped, accepted_socket_cb);
507 res->s = INVALID_SOCKET;
509 res->buflen = buflen;
510 res->family = family;
512 event_deferred_cb_init_(&res->deferred,
513 event_base_get_npriorities(lev->event_base) / 2,
514 accepted_socket_invoke_user_cb, res);
516 InitializeCriticalSectionAndSpinCount(&res->lock, 1000);
522 free_and_unlock_accepting_socket(struct accepting_socket *as)
525 if (as->s != INVALID_SOCKET)
528 LeaveCriticalSection(&as->lock);
529 DeleteCriticalSection(&as->lock);
534 start_accepting(struct accepting_socket *as)
537 const struct win32_extension_fns *ext = event_get_win32_extension_fns_();
539 SOCKET s = socket(as->family, SOCK_STREAM, 0);
542 if (!as->lev->base.enabled)
545 if (s == INVALID_SOCKET) {
546 error = WSAGetLastError();
550 /* XXXX It turns out we need to do this again later. Does this call
551 * have any effect? */
552 setsockopt(s, SOL_SOCKET, SO_UPDATE_ACCEPT_CONTEXT,
553 (char *)&as->lev->fd, sizeof(&as->lev->fd));
555 if (!(as->lev->base.flags & LEV_OPT_LEAVE_SOCKETS_BLOCKING))
556 evutil_make_socket_nonblocking(s);
558 if (event_iocp_port_associate_(as->lev->port, s, 1) < 0) {
565 if (ext->AcceptEx(as->lev->fd, s, as->addrbuf, 0,
566 as->buflen/2, as->buflen/2, &pending, &as->overlapped.overlapped))
568 /* Immediate success! */
569 accepted_socket_cb(&as->overlapped, 1, 0, 1);
571 error = WSAGetLastError();
572 if (error != ERROR_IO_PENDING) {
581 event_deferred_cb_schedule_(
588 stop_accepting(struct accepting_socket *as)
592 as->s = INVALID_SOCKET;
597 accepted_socket_invoke_user_cb(struct event_callback *dcb, void *arg)
599 struct accepting_socket *as = arg;
601 struct sockaddr *sa_local=NULL, *sa_remote=NULL;
602 int socklen_local=0, socklen_remote=0;
603 const struct win32_extension_fns *ext = event_get_win32_extension_fns_();
604 struct evconnlistener *lev = &as->lev->base;
605 evutil_socket_t sock=-1;
607 evconnlistener_cb cb=NULL;
608 evconnlistener_errorcb errorcb=NULL;
611 EVUTIL_ASSERT(ext->GetAcceptExSockaddrs);
614 EnterCriticalSection(&as->lock);
615 if (as->free_on_cb) {
616 free_and_unlock_accepting_socket(as);
617 listener_decref_and_unlock(lev);
626 errorcb = lev->errorcb;
628 ext->GetAcceptExSockaddrs(
629 as->addrbuf, 0, as->buflen/2, as->buflen/2,
630 &sa_local, &socklen_local, &sa_remote,
634 as->s = INVALID_SOCKET;
636 /* We need to call this so getsockname, getpeername, and
637 * shutdown work correctly on the accepted socket. */
638 /* XXXX handle error? */
639 setsockopt(sock, SOL_SOCKET, SO_UPDATE_ACCEPT_CONTEXT,
640 (char *)&as->lev->fd, sizeof(&as->lev->fd));
642 data = lev->user_data;
644 LeaveCriticalSection(&as->lock);
648 WSASetLastError(error);
651 cb(lev, sock, sa_remote, socklen_remote, data);
655 if (listener_decref_and_unlock(lev))
658 EnterCriticalSection(&as->lock);
660 LeaveCriticalSection(&as->lock);
664 accepted_socket_cb(struct event_overlapped *o, ev_uintptr_t key, ev_ssize_t n, int ok)
666 struct accepting_socket *as =
667 EVUTIL_UPCAST(o, struct accepting_socket, overlapped);
669 LOCK(&as->lev->base);
670 EnterCriticalSection(&as->lock);
672 /* XXXX Don't do this if some EV_MT flag is set. */
673 event_deferred_cb_schedule_(
676 LeaveCriticalSection(&as->lock);
677 } else if (as->free_on_cb) {
678 struct evconnlistener *lev = &as->lev->base;
679 free_and_unlock_accepting_socket(as);
680 listener_decref_and_unlock(lev);
682 } else if (as->s == INVALID_SOCKET) {
683 /* This is okay; we were disabled by iocp_listener_disable. */
684 LeaveCriticalSection(&as->lock);
686 /* Some error on accept that we couldn't actually handle. */
688 DWORD transfer = 0, flags=0;
689 event_sock_warn(as->s, "Unexpected error on AcceptEx");
690 ok = WSAGetOverlappedResult(as->s, &o->overlapped,
691 &transfer, FALSE, &flags);
693 /* well, that was confusing! */
696 as->error = WSAGetLastError();
698 event_deferred_cb_schedule_(
701 LeaveCriticalSection(&as->lock);
703 UNLOCK(&as->lev->base);
707 iocp_listener_enable(struct evconnlistener *lev)
710 struct evconnlistener_iocp *lev_iocp =
711 EVUTIL_UPCAST(lev, struct evconnlistener_iocp, base);
714 iocp_listener_event_add(lev_iocp);
715 for (i = 0; i < lev_iocp->n_accepting; ++i) {
716 struct accepting_socket *as = lev_iocp->accepting[i];
719 EnterCriticalSection(&as->lock);
720 if (!as->free_on_cb && as->s == INVALID_SOCKET)
722 LeaveCriticalSection(&as->lock);
729 iocp_listener_disable_impl(struct evconnlistener *lev, int shutdown)
732 struct evconnlistener_iocp *lev_iocp =
733 EVUTIL_UPCAST(lev, struct evconnlistener_iocp, base);
736 iocp_listener_event_del(lev_iocp);
737 for (i = 0; i < lev_iocp->n_accepting; ++i) {
738 struct accepting_socket *as = lev_iocp->accepting[i];
741 EnterCriticalSection(&as->lock);
742 if (!as->free_on_cb && as->s != INVALID_SOCKET) {
747 LeaveCriticalSection(&as->lock);
750 if (shutdown && lev->flags & LEV_OPT_CLOSE_ON_FREE)
751 evutil_closesocket(lev_iocp->fd);
758 iocp_listener_disable(struct evconnlistener *lev)
760 return iocp_listener_disable_impl(lev,0);
764 iocp_listener_destroy(struct evconnlistener *lev)
766 struct evconnlistener_iocp *lev_iocp =
767 EVUTIL_UPCAST(lev, struct evconnlistener_iocp, base);
769 if (! lev_iocp->shutting_down) {
770 lev_iocp->shutting_down = 1;
771 iocp_listener_disable_impl(lev,1);
776 static evutil_socket_t
777 iocp_listener_getfd(struct evconnlistener *lev)
779 struct evconnlistener_iocp *lev_iocp =
780 EVUTIL_UPCAST(lev, struct evconnlistener_iocp, base);
783 static struct event_base *
784 iocp_listener_getbase(struct evconnlistener *lev)
786 struct evconnlistener_iocp *lev_iocp =
787 EVUTIL_UPCAST(lev, struct evconnlistener_iocp, base);
788 return lev_iocp->event_base;
791 static const struct evconnlistener_ops evconnlistener_iocp_ops = {
792 iocp_listener_enable,
793 iocp_listener_disable,
794 iocp_listener_destroy,
795 iocp_listener_destroy, /* shutdown */
797 iocp_listener_getbase
800 /* XXX define some way to override this. */
801 #define N_SOCKETS_PER_LISTENER 4
803 struct evconnlistener *
804 evconnlistener_new_async(struct event_base *base,
805 evconnlistener_cb cb, void *ptr, unsigned flags, int backlog,
808 struct sockaddr_storage ss;
809 int socklen = sizeof(ss);
810 struct evconnlistener_iocp *lev;
813 flags |= LEV_OPT_THREADSAFE;
815 if (!base || !event_base_get_iocp_(base))
818 /* XXXX duplicate code */
820 if (listen(fd, backlog) < 0)
822 } else if (backlog < 0) {
823 if (listen(fd, 128) < 0)
826 if (getsockname(fd, (struct sockaddr*)&ss, &socklen)) {
827 event_sock_warn(fd, "getsockname");
830 lev = mm_calloc(1, sizeof(struct evconnlistener_iocp));
832 event_warn("calloc");
835 lev->base.ops = &evconnlistener_iocp_ops;
837 lev->base.user_data = ptr;
838 lev->base.flags = flags;
839 lev->base.refcnt = 1;
840 lev->base.enabled = 1;
842 lev->port = event_base_get_iocp_(base);
844 lev->event_base = base;
847 if (event_iocp_port_associate_(lev->port, fd, 1) < 0)
850 EVTHREAD_ALLOC_LOCK(lev->base.lock, EVTHREAD_LOCKTYPE_RECURSIVE);
852 lev->n_accepting = N_SOCKETS_PER_LISTENER;
853 lev->accepting = mm_calloc(lev->n_accepting,
854 sizeof(struct accepting_socket *));
855 if (!lev->accepting) {
856 event_warn("calloc");
857 goto err_delete_lock;
859 for (i = 0; i < lev->n_accepting; ++i) {
860 lev->accepting[i] = new_accepting_socket(lev, ss.ss_family);
861 if (!lev->accepting[i]) {
862 event_warnx("Couldn't create accepting socket");
863 goto err_free_accepting;
865 if (cb && start_accepting(lev->accepting[i]) < 0) {
866 event_warnx("Couldn't start accepting on socket");
867 EnterCriticalSection(&lev->accepting[i]->lock);
868 free_and_unlock_accepting_socket(lev->accepting[i]);
869 goto err_free_accepting;
874 iocp_listener_event_add(lev);
879 mm_free(lev->accepting);
880 /* XXXX free the other elements. */
882 EVTHREAD_FREE_LOCK(lev->base.lock, EVTHREAD_LOCKTYPE_RECURSIVE);
886 /* Don't close the fd, it is caller's responsibility. */