2 * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
3 * Copyright (c) 2002-2006 Niels Provos <provos@citi.umich.edu>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #include "event2/event-config.h"
30 #include "evconfig-private.h"
32 #include <sys/types.h>
34 #ifdef EVENT__HAVE_SYS_TIME_H
42 #ifdef EVENT__HAVE_STDARG_H
45 #ifdef EVENT__HAVE_UNISTD_H
54 #ifdef EVENT__HAVE_SYS_SOCKET_H
55 #include <sys/socket.h>
57 #ifdef EVENT__HAVE_NETINET_IN_H
58 #include <netinet/in.h>
60 #ifdef EVENT__HAVE_NETINET_IN6_H
61 #include <netinet/in6.h>
64 #include "event2/util.h"
65 #include "event2/bufferevent.h"
66 #include "event2/buffer.h"
67 #include "event2/bufferevent_struct.h"
68 #include "event2/bufferevent_compat.h"
69 #include "event2/event.h"
70 #include "log-internal.h"
71 #include "mm-internal.h"
72 #include "bufferevent-internal.h"
73 #include "util-internal.h"
75 #include "iocp-internal.h"
79 static int be_socket_enable(struct bufferevent *, short);
80 static int be_socket_disable(struct bufferevent *, short);
81 static void be_socket_destruct(struct bufferevent *);
82 static int be_socket_adj_timeouts(struct bufferevent *);
83 static int be_socket_flush(struct bufferevent *, short, enum bufferevent_flush_mode);
84 static int be_socket_ctrl(struct bufferevent *, enum bufferevent_ctrl_op, union bufferevent_ctrl_data *);
86 static void be_socket_setfd(struct bufferevent *, evutil_socket_t);
88 const struct bufferevent_ops bufferevent_ops_socket = {
90 evutil_offsetof(struct bufferevent_private, bev),
95 be_socket_adj_timeouts,
100 #define be_socket_add(ev, t) \
101 bufferevent_add_event_((ev), (t))
104 bufferevent_socket_outbuf_cb(struct evbuffer *buf,
105 const struct evbuffer_cb_info *cbinfo,
108 struct bufferevent *bufev = arg;
109 struct bufferevent_private *bufev_p =
110 EVUTIL_UPCAST(bufev, struct bufferevent_private, bev);
112 if (cbinfo->n_added &&
113 (bufev->enabled & EV_WRITE) &&
114 !event_pending(&bufev->ev_write, EV_WRITE, NULL) &&
115 !bufev_p->write_suspended) {
116 /* Somebody added data to the buffer, and we would like to
117 * write, and we were not writing. So, start writing. */
118 if (be_socket_add(&bufev->ev_write, &bufev->timeout_write) == -1) {
119 /* Should we log this? */
125 bufferevent_readcb(evutil_socket_t fd, short event, void *arg)
127 struct bufferevent *bufev = arg;
128 struct bufferevent_private *bufev_p =
129 EVUTIL_UPCAST(bufev, struct bufferevent_private, bev);
130 struct evbuffer *input;
132 short what = BEV_EVENT_READING;
133 ev_ssize_t howmuch = -1, readmax=-1;
135 bufferevent_incref_and_lock_(bufev);
137 if (event == EV_TIMEOUT) {
138 /* Note that we only check for event==EV_TIMEOUT. If
139 * event==EV_TIMEOUT|EV_READ, we can safely ignore the
140 * timeout, since a read has occurred */
141 what |= BEV_EVENT_TIMEOUT;
145 input = bufev->input;
148 * If we have a high watermark configured then we don't want to
149 * read more data than would make us reach the watermark.
151 if (bufev->wm_read.high != 0) {
152 howmuch = bufev->wm_read.high - evbuffer_get_length(input);
153 /* we somehow lowered the watermark, stop reading */
155 bufferevent_wm_suspend_read(bufev);
159 readmax = bufferevent_get_read_max_(bufev_p);
160 if (howmuch < 0 || howmuch > readmax) /* The use of -1 for "unlimited"
161 * uglifies this code. XXXX */
163 if (bufev_p->read_suspended)
166 evbuffer_unfreeze(input, 0);
167 res = evbuffer_read(input, fd, (int)howmuch); /* XXXX evbuffer_read would do better to take and return ev_ssize_t */
168 evbuffer_freeze(input, 0);
171 int err = evutil_socket_geterror(fd);
172 if (EVUTIL_ERR_RW_RETRIABLE(err))
175 what |= BEV_EVENT_ERROR;
176 } else if (res == 0) {
178 what |= BEV_EVENT_EOF;
184 bufferevent_decrement_read_buckets_(bufev_p, res);
186 /* Invoke the user callback - must always be called last */
187 bufferevent_trigger_nolock_(bufev, EV_READ, 0);
195 bufferevent_disable(bufev, EV_READ);
196 bufferevent_run_eventcb_(bufev, what, 0);
199 bufferevent_decref_and_unlock_(bufev);
203 bufferevent_writecb(evutil_socket_t fd, short event, void *arg)
205 struct bufferevent *bufev = arg;
206 struct bufferevent_private *bufev_p =
207 EVUTIL_UPCAST(bufev, struct bufferevent_private, bev);
209 short what = BEV_EVENT_WRITING;
211 ev_ssize_t atmost = -1;
213 bufferevent_incref_and_lock_(bufev);
215 if (event == EV_TIMEOUT) {
216 /* Note that we only check for event==EV_TIMEOUT. If
217 * event==EV_TIMEOUT|EV_WRITE, we can safely ignore the
218 * timeout, since a read has occurred */
219 what |= BEV_EVENT_TIMEOUT;
222 if (bufev_p->connecting) {
223 int c = evutil_socket_finished_connecting_(fd);
224 /* we need to fake the error if the connection was refused
225 * immediately - usually connection to localhost on BSD */
226 if (bufev_p->connection_refused) {
227 bufev_p->connection_refused = 0;
234 bufev_p->connecting = 0;
236 event_del(&bufev->ev_write);
237 event_del(&bufev->ev_read);
238 bufferevent_run_eventcb_(bufev, BEV_EVENT_ERROR, 0);
243 if (BEV_IS_ASYNC(bufev)) {
244 event_del(&bufev->ev_write);
245 bufferevent_async_set_connected_(bufev);
246 bufferevent_run_eventcb_(bufev,
247 BEV_EVENT_CONNECTED, 0);
251 bufferevent_run_eventcb_(bufev,
252 BEV_EVENT_CONNECTED, 0);
253 if (!(bufev->enabled & EV_WRITE) ||
254 bufev_p->write_suspended) {
255 event_del(&bufev->ev_write);
261 atmost = bufferevent_get_write_max_(bufev_p);
263 if (bufev_p->write_suspended)
266 if (evbuffer_get_length(bufev->output)) {
267 evbuffer_unfreeze(bufev->output, 1);
268 res = evbuffer_write_atmost(bufev->output, fd, atmost);
269 evbuffer_freeze(bufev->output, 1);
271 int err = evutil_socket_geterror(fd);
272 if (EVUTIL_ERR_RW_RETRIABLE(err))
274 what |= BEV_EVENT_ERROR;
275 } else if (res == 0) {
277 XXXX Actually, a 0 on write doesn't indicate
278 an EOF. An ECONNRESET might be more typical.
280 what |= BEV_EVENT_EOF;
285 bufferevent_decrement_write_buckets_(bufev_p, res);
288 if (evbuffer_get_length(bufev->output) == 0) {
289 event_del(&bufev->ev_write);
293 * Invoke the user callback if our buffer is drained or below the
296 if (res || !connected) {
297 bufferevent_trigger_nolock_(bufev, EV_WRITE, 0);
303 if (evbuffer_get_length(bufev->output) == 0) {
304 event_del(&bufev->ev_write);
309 bufferevent_disable(bufev, EV_WRITE);
310 bufferevent_run_eventcb_(bufev, what, 0);
313 bufferevent_decref_and_unlock_(bufev);
317 bufferevent_socket_new(struct event_base *base, evutil_socket_t fd,
320 struct bufferevent_private *bufev_p;
321 struct bufferevent *bufev;
324 if (base && event_base_get_iocp_(base))
325 return bufferevent_async_new_(base, fd, options);
328 if ((bufev_p = mm_calloc(1, sizeof(struct bufferevent_private)))== NULL)
331 if (bufferevent_init_common_(bufev_p, base, &bufferevent_ops_socket,
336 bufev = &bufev_p->bev;
337 evbuffer_set_flags(bufev->output, EVBUFFER_FLAG_DRAINS_TO_FD);
339 event_assign(&bufev->ev_read, bufev->ev_base, fd,
340 EV_READ|EV_PERSIST|EV_FINALIZE, bufferevent_readcb, bufev);
341 event_assign(&bufev->ev_write, bufev->ev_base, fd,
342 EV_WRITE|EV_PERSIST|EV_FINALIZE, bufferevent_writecb, bufev);
344 evbuffer_add_cb(bufev->output, bufferevent_socket_outbuf_cb, bufev);
346 evbuffer_freeze(bufev->input, 0);
347 evbuffer_freeze(bufev->output, 1);
353 bufferevent_socket_connect(struct bufferevent *bev,
354 struct sockaddr *sa, int socklen)
356 struct bufferevent_private *bufev_p =
357 EVUTIL_UPCAST(bev, struct bufferevent_private, bev);
364 bufferevent_incref_and_lock_(bev);
369 fd = bufferevent_getfd(bev);
373 fd = evutil_socket_(sa->sa_family,
374 SOCK_STREAM|EVUTIL_SOCK_NONBLOCK, 0);
381 if (bufferevent_async_can_connect_(bev)) {
382 bufferevent_setfd(bev, fd);
383 r = bufferevent_async_connect_(bev, fd, sa, socklen);
386 bufev_p->connecting = 1;
391 r = evutil_socket_connect_(&fd, sa, socklen);
396 /* ConnectEx() isn't always around, even when IOCP is enabled.
397 * Here, we borrow the socket object's write handler to fall back
398 * on a non-blocking connect() when ConnectEx() is unavailable. */
399 if (BEV_IS_ASYNC(bev)) {
400 event_assign(&bev->ev_write, bev->ev_base, fd,
401 EV_WRITE|EV_PERSIST|EV_FINALIZE, bufferevent_writecb, bev);
404 bufferevent_setfd(bev, fd);
406 if (! be_socket_enable(bev, EV_WRITE)) {
407 bufev_p->connecting = 1;
412 /* The connect succeeded already. How very BSD of it. */
414 bufev_p->connecting = 1;
415 event_active(&bev->ev_write, EV_WRITE, 1);
417 /* The connect failed already. How very BSD of it. */
418 bufev_p->connection_refused = 1;
419 bufev_p->connecting = 1;
421 event_active(&bev->ev_write, EV_WRITE, 1);
427 bufferevent_run_eventcb_(bev, BEV_EVENT_ERROR, 0);
429 evutil_closesocket(fd);
430 /* do something about the error? */
432 bufferevent_decref_and_unlock_(bev);
437 bufferevent_connect_getaddrinfo_cb(int result, struct evutil_addrinfo *ai,
440 struct bufferevent *bev = arg;
441 struct bufferevent_private *bev_p =
442 EVUTIL_UPCAST(bev, struct bufferevent_private, bev);
446 bufferevent_unsuspend_write_(bev, BEV_SUSPEND_LOOKUP);
447 bufferevent_unsuspend_read_(bev, BEV_SUSPEND_LOOKUP);
450 bev_p->dns_error = result;
451 bufferevent_run_eventcb_(bev, BEV_EVENT_ERROR, 0);
452 bufferevent_decref_and_unlock_(bev);
454 evutil_freeaddrinfo(ai);
458 /* XXX use the other addrinfos? */
459 /* XXX use this return value */
460 r = bufferevent_socket_connect(bev, ai->ai_addr, (int)ai->ai_addrlen);
462 bufferevent_decref_and_unlock_(bev);
463 evutil_freeaddrinfo(ai);
467 bufferevent_socket_connect_hostname(struct bufferevent *bev,
468 struct evdns_base *evdns_base, int family, const char *hostname, int port)
471 struct evutil_addrinfo hint;
473 struct bufferevent_private *bev_p =
474 EVUTIL_UPCAST(bev, struct bufferevent_private, bev);
476 if (family != AF_INET && family != AF_INET6 && family != AF_UNSPEC)
478 if (port < 1 || port > 65535)
482 bev_p->dns_error = 0;
485 evutil_snprintf(portbuf, sizeof(portbuf), "%d", port);
487 memset(&hint, 0, sizeof(hint));
488 hint.ai_family = family;
489 hint.ai_protocol = IPPROTO_TCP;
490 hint.ai_socktype = SOCK_STREAM;
492 bufferevent_suspend_write_(bev, BEV_SUSPEND_LOOKUP);
493 bufferevent_suspend_read_(bev, BEV_SUSPEND_LOOKUP);
495 bufferevent_incref_(bev);
496 err = evutil_getaddrinfo_async_(evdns_base, hostname, portbuf,
497 &hint, bufferevent_connect_getaddrinfo_cb, bev);
502 bufferevent_unsuspend_write_(bev, BEV_SUSPEND_LOOKUP);
503 bufferevent_unsuspend_read_(bev, BEV_SUSPEND_LOOKUP);
504 bufferevent_decref_(bev);
510 bufferevent_socket_get_dns_error(struct bufferevent *bev)
513 struct bufferevent_private *bev_p =
514 EVUTIL_UPCAST(bev, struct bufferevent_private, bev);
517 rv = bev_p->dns_error;
524 * Create a new buffered event object.
526 * The read callback is invoked whenever we read new data.
527 * The write callback is invoked whenever the output buffer is drained.
528 * The error callback is invoked on a write/read error or on EOF.
530 * Both read and write callbacks maybe NULL. The error callback is not
531 * allowed to be NULL and have to be provided always.
535 bufferevent_new(evutil_socket_t fd,
536 bufferevent_data_cb readcb, bufferevent_data_cb writecb,
537 bufferevent_event_cb eventcb, void *cbarg)
539 struct bufferevent *bufev;
541 if (!(bufev = bufferevent_socket_new(NULL, fd, 0)))
544 bufferevent_setcb(bufev, readcb, writecb, eventcb, cbarg);
551 be_socket_enable(struct bufferevent *bufev, short event)
553 if (event & EV_READ) {
554 if (be_socket_add(&bufev->ev_read,&bufev->timeout_read) == -1)
557 if (event & EV_WRITE) {
558 if (be_socket_add(&bufev->ev_write,&bufev->timeout_write) == -1)
565 be_socket_disable(struct bufferevent *bufev, short event)
567 struct bufferevent_private *bufev_p =
568 EVUTIL_UPCAST(bufev, struct bufferevent_private, bev);
569 if (event & EV_READ) {
570 if (event_del(&bufev->ev_read) == -1)
573 /* Don't actually disable the write if we are trying to connect. */
574 if ((event & EV_WRITE) && ! bufev_p->connecting) {
575 if (event_del(&bufev->ev_write) == -1)
582 be_socket_destruct(struct bufferevent *bufev)
584 struct bufferevent_private *bufev_p =
585 EVUTIL_UPCAST(bufev, struct bufferevent_private, bev);
587 EVUTIL_ASSERT(bufev->be_ops == &bufferevent_ops_socket);
589 fd = event_get_fd(&bufev->ev_read);
591 if ((bufev_p->options & BEV_OPT_CLOSE_ON_FREE) && fd >= 0)
592 EVUTIL_CLOSESOCKET(fd);
596 be_socket_adj_timeouts(struct bufferevent *bufev)
599 if (event_pending(&bufev->ev_read, EV_READ, NULL)) {
600 if (evutil_timerisset(&bufev->timeout_read)) {
601 if (be_socket_add(&bufev->ev_read, &bufev->timeout_read) < 0)
604 event_remove_timer(&bufev->ev_read);
607 if (event_pending(&bufev->ev_write, EV_WRITE, NULL)) {
608 if (evutil_timerisset(&bufev->timeout_write)) {
609 if (be_socket_add(&bufev->ev_write, &bufev->timeout_write) < 0)
612 event_remove_timer(&bufev->ev_write);
619 be_socket_flush(struct bufferevent *bev, short iotype,
620 enum bufferevent_flush_mode mode)
627 be_socket_setfd(struct bufferevent *bufev, evutil_socket_t fd)
630 EVUTIL_ASSERT(bufev->be_ops == &bufferevent_ops_socket);
632 event_del(&bufev->ev_read);
633 event_del(&bufev->ev_write);
635 event_assign(&bufev->ev_read, bufev->ev_base, fd,
636 EV_READ|EV_PERSIST|EV_FINALIZE, bufferevent_readcb, bufev);
637 event_assign(&bufev->ev_write, bufev->ev_base, fd,
638 EV_WRITE|EV_PERSIST|EV_FINALIZE, bufferevent_writecb, bufev);
641 bufferevent_enable(bufev, bufev->enabled);
646 /* XXXX Should non-socket bufferevents support this? */
648 bufferevent_priority_set(struct bufferevent *bufev, int priority)
651 struct bufferevent_private *bufev_p =
652 EVUTIL_UPCAST(bufev, struct bufferevent_private, bev);
655 if (bufev->be_ops != &bufferevent_ops_socket)
658 if (event_priority_set(&bufev->ev_read, priority) == -1)
660 if (event_priority_set(&bufev->ev_write, priority) == -1)
663 event_deferred_cb_set_priority_(&bufev_p->deferred, priority);
671 /* XXXX Should non-socket bufferevents support this? */
673 bufferevent_base_set(struct event_base *base, struct bufferevent *bufev)
678 if (bufev->be_ops != &bufferevent_ops_socket)
681 bufev->ev_base = base;
683 res = event_base_set(base, &bufev->ev_read);
687 res = event_base_set(base, &bufev->ev_write);
694 be_socket_ctrl(struct bufferevent *bev, enum bufferevent_ctrl_op op,
695 union bufferevent_ctrl_data *data)
698 case BEV_CTRL_SET_FD:
699 be_socket_setfd(bev, data->fd);
701 case BEV_CTRL_GET_FD:
702 data->fd = event_get_fd(&bev->ev_read);
704 case BEV_CTRL_GET_UNDERLYING:
705 case BEV_CTRL_CANCEL_ALL: