Blame libevent/bufferevent_pair.c

Packit e9ba0d
/*
Packit e9ba0d
 * Copyright (c) 2009-2012 Niels Provos, Nick Mathewson
Packit e9ba0d
 *
Packit e9ba0d
 * Redistribution and use in source and binary forms, with or without
Packit e9ba0d
 * modification, are permitted provided that the following conditions
Packit e9ba0d
 * are met:
Packit e9ba0d
 * 1. Redistributions of source code must retain the above copyright
Packit e9ba0d
 *    notice, this list of conditions and the following disclaimer.
Packit e9ba0d
 * 2. Redistributions in binary form must reproduce the above copyright
Packit e9ba0d
 *    notice, this list of conditions and the following disclaimer in the
Packit e9ba0d
 *    documentation and/or other materials provided with the distribution.
Packit e9ba0d
 * 3. The name of the author may not be used to endorse or promote products
Packit e9ba0d
 *    derived from this software without specific prior written permission.
Packit e9ba0d
 *
Packit e9ba0d
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
Packit e9ba0d
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
Packit e9ba0d
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
Packit e9ba0d
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
Packit e9ba0d
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
Packit e9ba0d
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Packit e9ba0d
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Packit e9ba0d
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Packit e9ba0d
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
Packit e9ba0d
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Packit e9ba0d
 */
Packit e9ba0d
Packit e9ba0d
#include <sys/types.h>
Packit e9ba0d
Packit e9ba0d
#ifdef WIN32
Packit e9ba0d
#include <winsock2.h>
Packit e9ba0d
#endif
Packit e9ba0d
Packit e9ba0d
#include "event2/event-config.h"
Packit e9ba0d
Packit e9ba0d
#include "event2/util.h"
Packit e9ba0d
#include "event2/buffer.h"
Packit e9ba0d
#include "event2/bufferevent.h"
Packit e9ba0d
#include "event2/bufferevent_struct.h"
Packit e9ba0d
#include "event2/event.h"
Packit e9ba0d
#include "defer-internal.h"
Packit e9ba0d
#include "bufferevent-internal.h"
Packit e9ba0d
#include "mm-internal.h"
Packit e9ba0d
#include "util-internal.h"
Packit e9ba0d
Packit e9ba0d
struct bufferevent_pair {
Packit e9ba0d
	struct bufferevent_private bev;
Packit e9ba0d
	struct bufferevent_pair *partner;
Packit e9ba0d
};
Packit e9ba0d
Packit e9ba0d
Packit e9ba0d
/* Given a bufferevent that's really a bev part of a bufferevent_pair,
Packit e9ba0d
 * return that bufferevent_filtered. Returns NULL otherwise.*/
Packit e9ba0d
static inline struct bufferevent_pair *
Packit e9ba0d
upcast(struct bufferevent *bev)
Packit e9ba0d
{
Packit e9ba0d
	struct bufferevent_pair *bev_p;
Packit e9ba0d
	if (bev->be_ops != &bufferevent_ops_pair)
Packit e9ba0d
		return NULL;
Packit e9ba0d
	bev_p = EVUTIL_UPCAST(bev, struct bufferevent_pair, bev.bev);
Packit e9ba0d
	EVUTIL_ASSERT(bev_p->bev.bev.be_ops == &bufferevent_ops_pair);
Packit e9ba0d
	return bev_p;
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
#define downcast(bev_pair) (&(bev_pair)->bev.bev)
Packit e9ba0d
Packit e9ba0d
static inline void
Packit e9ba0d
incref_and_lock(struct bufferevent *b)
Packit e9ba0d
{
Packit e9ba0d
	struct bufferevent_pair *bevp;
Packit e9ba0d
	_bufferevent_incref_and_lock(b);
Packit e9ba0d
	bevp = upcast(b);
Packit e9ba0d
	if (bevp->partner)
Packit e9ba0d
		_bufferevent_incref_and_lock(downcast(bevp->partner));
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
static inline void
Packit e9ba0d
decref_and_unlock(struct bufferevent *b)
Packit e9ba0d
{
Packit e9ba0d
	struct bufferevent_pair *bevp = upcast(b);
Packit e9ba0d
	if (bevp->partner)
Packit e9ba0d
		_bufferevent_decref_and_unlock(downcast(bevp->partner));
Packit e9ba0d
	_bufferevent_decref_and_unlock(b);
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
/* XXX Handle close */
Packit e9ba0d
Packit e9ba0d
static void be_pair_outbuf_cb(struct evbuffer *,
Packit e9ba0d
    const struct evbuffer_cb_info *, void *);
Packit e9ba0d
Packit e9ba0d
static struct bufferevent_pair *
Packit e9ba0d
bufferevent_pair_elt_new(struct event_base *base,
Packit e9ba0d
    int options)
Packit e9ba0d
{
Packit e9ba0d
	struct bufferevent_pair *bufev;
Packit e9ba0d
	if (! (bufev = mm_calloc(1, sizeof(struct bufferevent_pair))))
Packit e9ba0d
		return NULL;
Packit e9ba0d
	if (bufferevent_init_common(&bufev->bev, base, &bufferevent_ops_pair,
Packit e9ba0d
		options)) {
Packit e9ba0d
		mm_free(bufev);
Packit e9ba0d
		return NULL;
Packit e9ba0d
	}
Packit e9ba0d
	if (!evbuffer_add_cb(bufev->bev.bev.output, be_pair_outbuf_cb, bufev)) {
Packit e9ba0d
		bufferevent_free(downcast(bufev));
Packit e9ba0d
		return NULL;
Packit e9ba0d
	}
Packit e9ba0d
Packit e9ba0d
	_bufferevent_init_generic_timeout_cbs(&bufev->bev.bev);
Packit e9ba0d
Packit e9ba0d
	return bufev;
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
int
Packit e9ba0d
bufferevent_pair_new(struct event_base *base, int options,
Packit e9ba0d
    struct bufferevent *pair[2])
Packit e9ba0d
{
Packit e9ba0d
	struct bufferevent_pair *bufev1 = NULL, *bufev2 = NULL;
Packit e9ba0d
	int tmp_options;
Packit e9ba0d
Packit e9ba0d
	options |= BEV_OPT_DEFER_CALLBACKS;
Packit e9ba0d
	tmp_options = options & ~BEV_OPT_THREADSAFE;
Packit e9ba0d
Packit e9ba0d
	bufev1 = bufferevent_pair_elt_new(base, options);
Packit e9ba0d
	if (!bufev1)
Packit e9ba0d
		return -1;
Packit e9ba0d
	bufev2 = bufferevent_pair_elt_new(base, tmp_options);
Packit e9ba0d
	if (!bufev2) {
Packit e9ba0d
		bufferevent_free(downcast(bufev1));
Packit e9ba0d
		return -1;
Packit e9ba0d
	}
Packit e9ba0d
Packit e9ba0d
	if (options & BEV_OPT_THREADSAFE) {
Packit e9ba0d
		/*XXXX check return */
Packit e9ba0d
		bufferevent_enable_locking(downcast(bufev2), bufev1->bev.lock);
Packit e9ba0d
	}
Packit e9ba0d
Packit e9ba0d
	bufev1->partner = bufev2;
Packit e9ba0d
	bufev2->partner = bufev1;
Packit e9ba0d
Packit e9ba0d
	evbuffer_freeze(downcast(bufev1)->input, 0);
Packit e9ba0d
	evbuffer_freeze(downcast(bufev1)->output, 1);
Packit e9ba0d
	evbuffer_freeze(downcast(bufev2)->input, 0);
Packit e9ba0d
	evbuffer_freeze(downcast(bufev2)->output, 1);
Packit e9ba0d
Packit e9ba0d
	pair[0] = downcast(bufev1);
Packit e9ba0d
	pair[1] = downcast(bufev2);
Packit e9ba0d
Packit e9ba0d
	return 0;
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
static void
Packit e9ba0d
be_pair_transfer(struct bufferevent *src, struct bufferevent *dst,
Packit e9ba0d
    int ignore_wm)
Packit e9ba0d
{
Packit e9ba0d
	size_t src_size, dst_size;
Packit e9ba0d
	size_t n;
Packit e9ba0d
Packit e9ba0d
	evbuffer_unfreeze(src->output, 1);
Packit e9ba0d
	evbuffer_unfreeze(dst->input, 0);
Packit e9ba0d
Packit e9ba0d
	if (dst->wm_read.high) {
Packit e9ba0d
		dst_size = evbuffer_get_length(dst->input);
Packit e9ba0d
		if (dst_size < dst->wm_read.high) {
Packit e9ba0d
			n = dst->wm_read.high - dst_size;
Packit e9ba0d
			evbuffer_remove_buffer(src->output, dst->input, n);
Packit e9ba0d
		} else {
Packit e9ba0d
			if (!ignore_wm)
Packit e9ba0d
				goto done;
Packit e9ba0d
			n = evbuffer_get_length(src->output);
Packit e9ba0d
			evbuffer_add_buffer(dst->input, src->output);
Packit e9ba0d
		}
Packit e9ba0d
	} else {
Packit e9ba0d
		n = evbuffer_get_length(src->output);
Packit e9ba0d
		evbuffer_add_buffer(dst->input, src->output);
Packit e9ba0d
	}
Packit e9ba0d
Packit e9ba0d
	if (n) {
Packit e9ba0d
		BEV_RESET_GENERIC_READ_TIMEOUT(dst);
Packit e9ba0d
Packit e9ba0d
		if (evbuffer_get_length(dst->output))
Packit e9ba0d
			BEV_RESET_GENERIC_WRITE_TIMEOUT(dst);
Packit e9ba0d
		else
Packit e9ba0d
			BEV_DEL_GENERIC_WRITE_TIMEOUT(dst);
Packit e9ba0d
	}
Packit e9ba0d
Packit e9ba0d
	src_size = evbuffer_get_length(src->output);
Packit e9ba0d
	dst_size = evbuffer_get_length(dst->input);
Packit e9ba0d
Packit e9ba0d
	if (dst_size >= dst->wm_read.low) {
Packit e9ba0d
		_bufferevent_run_readcb(dst);
Packit e9ba0d
	}
Packit e9ba0d
	if (src_size <= src->wm_write.low) {
Packit e9ba0d
		_bufferevent_run_writecb(src);
Packit e9ba0d
	}
Packit e9ba0d
done:
Packit e9ba0d
	evbuffer_freeze(src->output, 1);
Packit e9ba0d
	evbuffer_freeze(dst->input, 0);
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
static inline int
Packit e9ba0d
be_pair_wants_to_talk(struct bufferevent_pair *src,
Packit e9ba0d
    struct bufferevent_pair *dst)
Packit e9ba0d
{
Packit e9ba0d
	return (downcast(src)->enabled & EV_WRITE) &&
Packit e9ba0d
	    (downcast(dst)->enabled & EV_READ) &&
Packit e9ba0d
	    !dst->bev.read_suspended &&
Packit e9ba0d
	    evbuffer_get_length(downcast(src)->output);
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
static void
Packit e9ba0d
be_pair_outbuf_cb(struct evbuffer *outbuf,
Packit e9ba0d
    const struct evbuffer_cb_info *info, void *arg)
Packit e9ba0d
{
Packit e9ba0d
	struct bufferevent_pair *bev_pair = arg;
Packit e9ba0d
	struct bufferevent_pair *partner = bev_pair->partner;
Packit e9ba0d
Packit e9ba0d
	incref_and_lock(downcast(bev_pair));
Packit e9ba0d
Packit e9ba0d
	if (info->n_added > info->n_deleted && partner) {
Packit e9ba0d
		/* We got more data.  If the other side's reading, then
Packit e9ba0d
		   hand it over. */
Packit e9ba0d
		if (be_pair_wants_to_talk(bev_pair, partner)) {
Packit e9ba0d
			be_pair_transfer(downcast(bev_pair), downcast(partner), 0);
Packit e9ba0d
		}
Packit e9ba0d
	}
Packit e9ba0d
Packit e9ba0d
	decref_and_unlock(downcast(bev_pair));
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
static int
Packit e9ba0d
be_pair_enable(struct bufferevent *bufev, short events)
Packit e9ba0d
{
Packit e9ba0d
	struct bufferevent_pair *bev_p = upcast(bufev);
Packit e9ba0d
	struct bufferevent_pair *partner = bev_p->partner;
Packit e9ba0d
Packit e9ba0d
	incref_and_lock(bufev);
Packit e9ba0d
Packit e9ba0d
	if (events & EV_READ) {
Packit e9ba0d
		BEV_RESET_GENERIC_READ_TIMEOUT(bufev);
Packit e9ba0d
	}
Packit e9ba0d
	if ((events & EV_WRITE) && evbuffer_get_length(bufev->output))
Packit e9ba0d
		BEV_RESET_GENERIC_WRITE_TIMEOUT(bufev);
Packit e9ba0d
Packit e9ba0d
	/* We're starting to read! Does the other side have anything to write?*/
Packit e9ba0d
	if ((events & EV_READ) && partner &&
Packit e9ba0d
	    be_pair_wants_to_talk(partner, bev_p)) {
Packit e9ba0d
		be_pair_transfer(downcast(partner), bufev, 0);
Packit e9ba0d
	}
Packit e9ba0d
	/* We're starting to write! Does the other side want to read? */
Packit e9ba0d
	if ((events & EV_WRITE) && partner &&
Packit e9ba0d
	    be_pair_wants_to_talk(bev_p, partner)) {
Packit e9ba0d
		be_pair_transfer(bufev, downcast(partner), 0);
Packit e9ba0d
	}
Packit e9ba0d
	decref_and_unlock(bufev);
Packit e9ba0d
	return 0;
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
static int
Packit e9ba0d
be_pair_disable(struct bufferevent *bev, short events)
Packit e9ba0d
{
Packit e9ba0d
	if (events & EV_READ) {
Packit e9ba0d
		BEV_DEL_GENERIC_READ_TIMEOUT(bev);
Packit e9ba0d
	}
Packit e9ba0d
	if (events & EV_WRITE)
Packit e9ba0d
		BEV_DEL_GENERIC_WRITE_TIMEOUT(bev);
Packit e9ba0d
	return 0;
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
static void
Packit e9ba0d
be_pair_destruct(struct bufferevent *bev)
Packit e9ba0d
{
Packit e9ba0d
	struct bufferevent_pair *bev_p = upcast(bev);
Packit e9ba0d
Packit e9ba0d
	if (bev_p->partner) {
Packit e9ba0d
		bev_p->partner->partner = NULL;
Packit e9ba0d
		bev_p->partner = NULL;
Packit e9ba0d
	}
Packit e9ba0d
Packit e9ba0d
	_bufferevent_del_generic_timeout_cbs(bev);
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
static int
Packit e9ba0d
be_pair_flush(struct bufferevent *bev, short iotype,
Packit e9ba0d
    enum bufferevent_flush_mode mode)
Packit e9ba0d
{
Packit e9ba0d
	struct bufferevent_pair *bev_p = upcast(bev);
Packit e9ba0d
	struct bufferevent *partner;
Packit e9ba0d
	incref_and_lock(bev);
Packit e9ba0d
	if (!bev_p->partner)
Packit e9ba0d
		return -1;
Packit e9ba0d
Packit e9ba0d
	partner = downcast(bev_p->partner);
Packit e9ba0d
Packit e9ba0d
	if (mode == BEV_NORMAL)
Packit e9ba0d
		return 0;
Packit e9ba0d
Packit e9ba0d
	if ((iotype & EV_READ) != 0)
Packit e9ba0d
		be_pair_transfer(partner, bev, 1);
Packit e9ba0d
Packit e9ba0d
	if ((iotype & EV_WRITE) != 0)
Packit e9ba0d
		be_pair_transfer(bev, partner, 1);
Packit e9ba0d
Packit e9ba0d
	if (mode == BEV_FINISHED) {
Packit e9ba0d
		_bufferevent_run_eventcb(partner, iotype|BEV_EVENT_EOF);
Packit e9ba0d
	}
Packit e9ba0d
	decref_and_unlock(bev);
Packit e9ba0d
	return 0;
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
struct bufferevent *
Packit e9ba0d
bufferevent_pair_get_partner(struct bufferevent *bev)
Packit e9ba0d
{
Packit e9ba0d
	struct bufferevent_pair *bev_p;
Packit e9ba0d
	struct bufferevent *partner = NULL;
Packit e9ba0d
	bev_p = upcast(bev);
Packit e9ba0d
	if (! bev_p)
Packit e9ba0d
		return NULL;
Packit e9ba0d
Packit e9ba0d
	incref_and_lock(bev);
Packit e9ba0d
	if (bev_p->partner)
Packit e9ba0d
		partner = downcast(bev_p->partner);
Packit e9ba0d
	decref_and_unlock(bev);
Packit e9ba0d
	return partner;
Packit e9ba0d
}
Packit e9ba0d
Packit e9ba0d
const struct bufferevent_ops bufferevent_ops_pair = {
Packit e9ba0d
	"pair_elt",
Packit e9ba0d
	evutil_offsetof(struct bufferevent_pair, bev.bev),
Packit e9ba0d
	be_pair_enable,
Packit e9ba0d
	be_pair_disable,
Packit e9ba0d
	be_pair_destruct,
Packit e9ba0d
	_bufferevent_generic_adj_timeouts,
Packit e9ba0d
	be_pair_flush,
Packit e9ba0d
	NULL, /* ctrl */
Packit e9ba0d
};