path: root/src/core/options.c

//
// Copyright 2017 Garrett D'Amore <garrett@damore.org>
// Copyright 2017 Capitar IT Group BV <info@capitar.com>
//
// 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 "core/nng_impl.h"

#include <stdio.h>
#include <string.h>

// Dynamic options.

typedef struct nni_option nni_option;
struct nni_option {
	nni_list_node o_link;
	char *        o_name;
	int           o_id;
};

static nni_mtx  nni_option_lk;
static nni_list nni_options;
static int      nni_option_nextid;

int
nni_chkopt_usec(const void *v, size_t sz)
{
	nni_duration val;
	if (sz != sizeof(val)) {
		return (NNG_EINVAL);
	}
	memcpy(&val, v, sz);
	if (val < -1) {
		return (NNG_EINVAL);
	}
	return (0);
}

int
nni_chkopt_int(const void *v, size_t sz, int minv, int maxv)
{
	int val;
	if (sz != sizeof(val)) {
		return (NNG_EINVAL);
	}
	memcpy(&val, v, sz);
	if ((val < minv) || (val > maxv)) {
		return (NNG_EINVAL);
	}
	return (0);
}

int
nni_chkopt_size(const void *v, size_t sz, size_t minv, size_t maxv)
{
	size_t val;
	if (sz != sizeof(val)) {
		return (NNG_EINVAL);
	}
	memcpy(&val, v, sz);
	if ((val < minv) || (val > maxv)) {
		return (NNG_EINVAL);
	}
	return (0);
}

int
nni_setopt_usec(nni_duration *dp, const void *v, size_t sz)
{
	nni_duration dur;

	if (sz != sizeof(*dp)) {
		return (NNG_EINVAL);
	}
	memcpy(&dur, v, sizeof(dur));
	if (dur < -1) {
		return (NNG_EINVAL);
	}
	*dp = dur;
	return (0);
}

int
nni_setopt_int(int *ip, const void *v, size_t sz, int minv, int maxv)
{
	int i;

	if (sz != sizeof(i)) {
		return (NNG_EINVAL);
	}
	memcpy(&i, v, sizeof(i));
	if (i > maxv) {
		return (NNG_EINVAL);
	}
	if (i < minv) {
		return (NNG_EINVAL);
	}
	*ip = i;
	return (0);
}

int
nni_setopt_size(size_t *sp, const void *v, size_t sz, size_t minv, size_t maxv)
{
	size_t val;

	if (sz != sizeof(val)) {
		return (NNG_EINVAL);
	}
	memcpy(&val, v, sizeof(val));
	if (val > maxv) {
		return (NNG_EINVAL);
	}
	if (val < minv) {
		return (NNG_EINVAL);
	}
	*sp = val;
	return (0);
}

int
nni_getopt_usec(nni_duration *ptr, void *val, size_t *sizep)
{
	size_t sz = sizeof(*ptr);

	if (sz > *sizep) {
		sz = *sizep;
	}
	*sizep = sizeof(*ptr);
	memcpy(val, ptr, sz);
	return (0);
}

int
nni_getopt_int(int *ptr, void *val, size_t *sizep)
{
	size_t sz = sizeof(*ptr);

	if (sz > *sizep) {
		sz = *sizep;
	}
	*sizep = sizeof(*ptr);
	memcpy(val, ptr, sz);
	return (0);
}

int
nni_getopt_size(size_t *ptr, void *val, size_t *sizep)
{
	size_t sz = sizeof(*ptr);

	if (sz > *sizep) {
		sz = *sizep;
	}
	*sizep = sizeof(*ptr);
	memcpy(val, ptr, sz);
	return (0);
}

int
nni_setopt_buf(nni_msgq *mq, const void *val, size_t sz)
{
	int len;

	if (sz < sizeof(len)) {
		return (NNG_EINVAL);
	}
	memcpy(&len, val, sizeof(len));
	if (len < 0) {
		return (NNG_EINVAL);
	}
	if (len > 8192) {
		// put a reasonable uppper limit on queue depth.
		// This is a count in messages, so the total queue
		// size could be quite large indeed in this case.
		return (NNG_EINVAL);
	}
	return (nni_msgq_resize(mq, len));
}

int
nni_getopt_buf(nni_msgq *mq, void *val, size_t *sizep)
{
	int len = nni_msgq_cap(mq);

	size_t sz = *sizep;

	if (sz > sizeof(len)) {
		sz = sizeof(len);
	}
	memcpy(val, &len, sz);
	*sizep = sizeof(len);
	return (0);
}

static void
nni_notifyfd_push(struct nng_event *ev, void *arg)
{
	nni_notifyfd *fd = arg;

	NNI_ARG_UNUSED(ev);

	nni_plat_pipe_raise(fd->sn_wfd);
}

int
nni_getopt_fd(nni_sock *s, nni_notifyfd *fd, int mask, void *val, size_t *szp)
{
	int      rv;
	uint32_t flags;

	if ((*szp < sizeof(int))) {
		return (NNG_EINVAL);
	}

	flags = nni_sock_flags(s);

	switch (mask) {
	case NNG_EV_CAN_SND:
		if ((flags & NNI_PROTO_FLAG_SND) == 0) {
			return (NNG_ENOTSUP);
		}
		break;
	case NNG_EV_CAN_RCV:
		if ((flags & NNI_PROTO_FLAG_RCV) == 0) {
			return (NNG_ENOTSUP);
		}
		break;
	default:
		return (NNG_ENOTSUP);
	}

	// If we already inited this, just give back the same file descriptor.
	if (fd->sn_init) {
		memcpy(val, &fd->sn_rfd, sizeof(int));
		*szp = sizeof(int);
		return (0);
	}

	if ((rv = nni_plat_pipe_open(&fd->sn_wfd, &fd->sn_rfd)) != 0) {
		return (rv);
	}

	if (nni_sock_notify(s, mask, nni_notifyfd_push, fd) == NULL) {
		nni_plat_pipe_close(fd->sn_wfd, fd->sn_rfd);
		return (NNG_ENOMEM);
	}

	fd->sn_init = 1;
	*szp        = sizeof(int);
	memcpy(val, &fd->sn_rfd, sizeof(int));
	return (0);
}

// nni_option_set_id sets the id for an option, if not already done so.
// (Some options have hard coded values that end-user may depend upon.)
// If the ID passed in is negative, then a new ID is allocated dynamically.
static int
nni_option_set_id(const char *name, int id)
{
	nni_option *opt;
	int         len;
	nni_mtx_lock(&nni_option_lk);
	NNI_LIST_FOREACH (&nni_options, opt) {
		if (strcmp(name, opt->o_name) == 0) {
			nni_mtx_unlock(&nni_option_lk);
			return (0);
		}
	}
	if ((opt = NNI_ALLOC_STRUCT(opt)) == NULL) {
		nni_mtx_unlock(&nni_option_lk);
		return (NNG_ENOMEM);
	}
	len = strlen(name) + 1;
	if ((opt->o_name = nni_alloc(len)) == NULL) {
		nni_mtx_unlock(&nni_option_lk);
		NNI_FREE_STRUCT(opt);
		return (NNG_ENOMEM);
	}
	(void) snprintf(opt->o_name, len, "%s", name);
	if (id < 0) {
		id = nni_option_nextid++;
	}
	opt->o_id = id;
	nni_list_append(&nni_options, opt);
	nni_mtx_unlock(&nni_option_lk);
	return (0);
}

int
nni_option_lookup(const char *name)
{
	nni_option *opt;
	int         id = -1;

	nni_mtx_lock(&nni_option_lk);
	NNI_LIST_FOREACH (&nni_options, opt) {
		if (strcmp(name, opt->o_name) == 0) {
			id = opt->o_id;
			break;
		}
	}
	nni_mtx_unlock(&nni_option_lk);
	return (id);
}

const char *
nni_option_name(int id)
{
	nni_option *opt;
	const char *name = NULL;

	nni_mtx_lock(&nni_option_lk);
	NNI_LIST_FOREACH (&nni_options, opt) {
		if (id == opt->o_id) {
			name = opt->o_name;
			break;
		}
	}
	nni_mtx_unlock(&nni_option_lk);
	return (name);
}

int
nni_option_register(const char *name, int *idp)
{
	int rv;

	// Note that if the id was already in use, we will
	// wind up leaving a gap in the ID space.  That should
	// be inconsequential.
	if ((rv = nni_option_set_id(name, -1)) != 0) {
		return (rv);
	}
	*idp = nni_option_lookup(name);
	return (0);
}

int
nni_option_sys_init(void)
{
	nni_mtx_init(&nni_option_lk);
	NNI_LIST_INIT(&nni_options, nni_option, o_link);
	nni_option_nextid = 0x10000;
	int rv;

	// Register our well-known options.
	if (((rv = nni_option_set_id("raw", NNG_OPT_RAW)) != 0) ||
	    ((rv = nni_option_set_id("linger", NNG_OPT_LINGER)) != 0) ||
	    ((rv = nni_option_set_id("recv-buf", NNG_OPT_RCVBUF)) != 0) ||
	    ((rv = nni_option_set_id("send-buf", NNG_OPT_SNDBUF)) != 0) ||
	    ((rv = nni_option_set_id("recv-timeout", NNG_OPT_RCVTIMEO)) !=
	        0) ||
	    ((rv = nni_option_set_id("send-timeout", NNG_OPT_SNDTIMEO)) !=
	        0) ||
	    ((rv = nni_option_set_id("reconnect-time", NNG_OPT_RECONN_TIME)) !=
	        0) ||
	    ((rv = nni_option_set_id(
	          "reconnect-max-time", NNG_OPT_RECONN_MAXTIME)) != 0) ||
	    ((rv = nni_option_set_id("recv-max-size", NNG_OPT_RCVMAXSZ)) !=
	        0) ||
	    ((rv = nni_option_set_id("max-ttl", NNG_OPT_MAXTTL)) != 0) ||
	    ((rv = nni_option_set_id("protocol", NNG_OPT_PROTOCOL)) != 0) ||
	    ((rv = nni_option_set_id("subscribe", NNG_OPT_SUBSCRIBE)) != 0) ||
	    ((rv = nni_option_set_id("unsubscribe", NNG_OPT_UNSUBSCRIBE)) !=
	        0) ||
	    ((rv = nni_option_set_id("survey-time", NNG_OPT_SURVEYTIME)) !=
	        0) ||
	    ((rv = nni_option_set_id("resend-time", NNG_OPT_RESENDTIME)) !=
	        0) ||
	    ((rv = nni_option_set_id("transport", NNG_OPT_TRANSPORT)) != 0) ||
	    ((rv = nni_option_set_id("local-addr", NNG_OPT_LOCALADDR)) != 0) ||
	    ((rv = nni_option_set_id("remote-addr", NNG_OPT_REMOTEADDR)) !=
	        0) ||
	    ((rv = nni_option_set_id("recv-fd", NNG_OPT_RCVFD)) != 0) ||
	    ((rv = nni_option_set_id("send-fd", NNG_OPT_SNDFD)) != 0)) {
		nni_option_sys_fini();
		return (rv);
	}
	return (0);
}

void
nni_option_sys_fini(void)
{
	if (nni_option_nextid != 0) {
		nni_option *opt;
		while ((opt = nni_list_first(&nni_options)) != NULL) {
			nni_list_remove(&nni_options, opt);
			nni_free(opt->o_name, strlen(opt->o_name) + 1);
			NNI_FREE_STRUCT(opt);
		}
	}
	nni_option_nextid = 0;
}