path: root/src/protocol/pipeline/push.c

//
// Copyright 2017 Garrett D'Amore <garrett@damore.org>
//
// This software is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt).  A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//

#include <stdlib.h>
#include <string.h>

#include "core/nng_impl.h"

// Push protocol.  The PUSH protocol is the "write" side of a pipeline.
// Push distributes fairly, or tries to, by giving messages in round-robin
// order.

typedef struct nni_push_pipe	nni_push_pipe;
typedef struct nni_push_sock	nni_push_sock;

static void nni_push_send_cb(void *);
static void nni_push_recv_cb(void *);
static void nni_push_getq_cb(void *);
static void nni_push_recv(nni_push_pipe *);
static void nni_push_send(nni_push_sock *);

// An nni_push_sock is our per-socket protocol private structure.
struct nni_push_sock {
	nni_msgq *	uwq;
	nni_msg *	msg;    // pending message
	int		raw;
	nni_list	pipes;
	nni_push_pipe * nextpipe;
	int		npipes;
	nni_sock *	sock;

	nni_aio		aio_getq;
};

// An nni_push_pipe is our per-pipe protocol private structure.
struct nni_push_pipe {
	nni_pipe *	pipe;
	nni_push_sock * push;
	int		wantr;
	nni_list_node	node;

	nni_aio		aio_recv;
	nni_aio		aio_send;
};

static int
nni_push_sock_init(void **pushp, nni_sock *sock)
{
	nni_push_sock *push;
	int rv;

	if ((push = NNI_ALLOC_STRUCT(push)) == NULL) {
		return (NNG_ENOMEM);
	}
	if ((rv = nni_aio_init(&push->aio_getq, nni_push_getq_cb, push)) != 0) {
		NNI_FREE_STRUCT(push);
		return (rv);
	}
	NNI_LIST_INIT(&push->pipes, nni_push_pipe, node);
	push->raw = 0;
	push->npipes = 0;
	push->nextpipe = NULL;
	push->sock = sock;
	push->uwq = nni_sock_sendq(sock);
	*pushp = push;
	nni_sock_recverr(sock, NNG_ENOTSUP);
	return (0);
}


static void
nni_push_sock_open(void *arg)
{
	nni_push_sock *push = arg;

	nni_msgq_aio_get(push->uwq, &push->aio_getq);
}


static void
nni_push_sock_close(void *arg)
{
	nni_push_sock *push = arg;

	nni_msgq_aio_cancel(push->uwq, &push->aio_getq);
}


static void
nni_push_sock_fini(void *arg)
{
	nni_push_sock *push = arg;

	if (push != NULL) {
		if (push->msg != NULL) {
			nni_msg_free(push->msg);
		}
		NNI_FREE_STRUCT(push);
	}
}


static int
nni_push_pipe_init(void **ppp, nni_pipe *pipe, void *psock)
{
	nni_push_pipe *pp;
	int rv;

	if ((pp = NNI_ALLOC_STRUCT(pp)) == NULL) {
		return (NNG_ENOMEM);
	}
	if ((rv = nni_aio_init(&pp->aio_recv, nni_push_recv_cb, pp)) != 0) {
		NNI_FREE_STRUCT(pp);
		return (rv);
	}
	if ((rv = nni_aio_init(&pp->aio_send, nni_push_send_cb, pp)) != 0) {
		nni_aio_fini(&pp->aio_recv);
		NNI_FREE_STRUCT(pp);
		return (rv);
	}
	NNI_LIST_NODE_INIT(&pp->node);
	pp->pipe = pipe;
	pp->push = psock;
	pp->wantr = 0;
	*ppp = pp;
	return (0);
}


static void
nni_push_pipe_fini(void *arg)
{
	nni_push_pipe *pp = arg;

	if (pp != NULL) {
		nni_aio_fini(&pp->aio_recv);
		nni_aio_fini(&pp->aio_send);
		NNI_FREE_STRUCT(pp);
	}
}


static int
nni_push_pipe_add(void *arg)
{
	nni_push_pipe *pp = arg;
	nni_push_sock *push = pp->push;

	if (nni_pipe_peer(pp->pipe) != NNG_PROTO_PULL) {
		return (NNG_EPROTO);
	}
	// Turns out it should not really matter where we stick this.
	// The end makes our test cases easier.
	nni_list_append(&push->pipes, pp);

	// We start out wanting data to read.
	pp->wantr = 1;

	// Wake the top sender, as we can accept a job.
	push->npipes++;

	// Schedule a receiver.  This is mostly so that we can detect
	// a closed transport pipe.
	nni_pipe_aio_recv(pp->pipe, &pp->aio_recv);

	// Possibly schedule the sender.
	nni_push_send(pp->push);

	return (0);
}


static void
nni_push_pipe_rem(void *arg)
{
	nni_push_pipe *pp = arg;
	nni_push_sock *push = pp->push;

	if (pp == push->nextpipe) {
		push->nextpipe = nni_list_next(&push->pipes, pp);
	}
	push->npipes--;
	nni_list_remove(&push->pipes, pp);
}


static void
nni_push_recv(nni_push_pipe *pp)
{
	nni_pipe_aio_recv(pp->pipe, &pp->aio_recv);
}


static void
nni_push_recv_cb(void *arg)
{
	nni_push_pipe *pp = arg;

	// We normally expect to receive an error.  If a pipe actually
	// sends us data, we just discard it.
	if (nni_aio_result(&pp->aio_recv) != 0) {
		nni_pipe_close(pp->pipe);
		return;
	}
	nni_push_recv(pp);
}


static void
nni_push_send_cb(void *arg)
{
	nni_push_pipe *pp = arg;
	nni_push_sock *push = pp->push;
	nni_mtx *mx = nni_sock_mtx(push->sock);

	if (nni_aio_result(&pp->aio_send) != 0) {
		nni_pipe_close(pp->pipe);
		return;
	}

	nni_mtx_lock(mx);
	pp->wantr = 1;

	// This effectively kicks off a pull down.
	nni_push_send(pp->push);
	nni_mtx_unlock(mx);
}


static void
nni_push_getq_cb(void *arg)
{
	nni_push_sock *push = arg;
	nni_mtx *mx = nni_sock_mtx(push->sock);
	nni_aio *aio = &push->aio_getq;

	if (nni_aio_result(aio) != 0) {
		// If the socket is closing, nothing else we can do.
		return;
	}

	nni_mtx_lock(mx);
	push->msg = aio->a_msg;
	aio->a_msg = NULL;

	nni_push_send(push);
	nni_mtx_unlock(mx);
}


static int
nni_push_sock_setopt(void *arg, int opt, const void *buf, size_t sz)
{
	nni_push_sock *push = arg;
	int rv;

	switch (opt) {
	case NNG_OPT_RAW:
		rv = nni_setopt_int(&push->raw, buf, sz, 0, 1);
		break;
	default:
		rv = NNG_ENOTSUP;
	}
	return (rv);
}


static int
nni_push_sock_getopt(void *arg, int opt, void *buf, size_t *szp)
{
	nni_push_sock *push = arg;
	int rv;

	switch (opt) {
	case NNG_OPT_RAW:
		rv = nni_getopt_int(&push->raw, buf, szp);
		break;
	default:
		rv = NNG_ENOTSUP;
	}
	return (rv);
}


static void
nni_push_send(nni_push_sock *push)
{
	nni_push_pipe *pp;
	nni_msg *msg = NULL;
	int i;

	if ((msg = push->msg) == NULL) {
		// Nothing to send... bail...
		return;
	}

	// Let's try to send it.
	for (i = 0; i < push->npipes; i++) {
		pp = push->nextpipe;
		if (pp == NULL) {
			pp = nni_list_first(&push->pipes);
		}
		push->nextpipe = nni_list_next(&push->pipes, pp);
		if (pp->wantr) {
			pp->aio_send.a_msg = msg;
			push->msg = NULL;

			// Schedule outbound pipe delivery...
			nni_pipe_aio_send(pp->pipe, &pp->aio_send);

			// And schedule getting another message for send.
			nni_msgq_aio_get(push->uwq, &push->aio_getq);
			break;
		}
	}
}


// This is the global protocol structure -- our linkage to the core.
// This should be the only global non-static symbol in this file.
static nni_proto_pipe_ops nni_push_pipe_ops = {
	.pipe_init	= nni_push_pipe_init,
	.pipe_fini	= nni_push_pipe_fini,
	.pipe_add	= nni_push_pipe_add,
	.pipe_rem	= nni_push_pipe_rem,
};

static nni_proto_sock_ops nni_push_sock_ops = {
	.sock_init	= nni_push_sock_init,
	.sock_fini	= nni_push_sock_fini,
	.sock_open	= nni_push_sock_open,
	.sock_close	= nni_push_sock_close,
	.sock_setopt	= nni_push_sock_setopt,
	.sock_getopt	= nni_push_sock_getopt,
};

nni_proto nni_push_proto = {
	.proto_self	= NNG_PROTO_PUSH,
	.proto_peer	= NNG_PROTO_PULL,
	.proto_name	= "push",
	.proto_flags	= NNI_PROTO_FLAG_SND,
	.proto_pipe_ops = &nni_push_pipe_ops,
	.proto_sock_ops = &nni_push_sock_ops,
};