From ed542ac45e00c9b2faa0b41f3c00de6e291e5678 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 1 Jan 2021 11:30:03 -0800 Subject: fixes #1345 Restructure the source tree This is not quite complete, but it sets the stage for other protocols (such as zmq or mqtt) to be added to the project. --- src/protocol/pair1/pair.c | 540 ---------------------------------------------- 1 file changed, 540 deletions(-) delete mode 100644 src/protocol/pair1/pair.c (limited to 'src/protocol/pair1/pair.c') diff --git a/src/protocol/pair1/pair.c b/src/protocol/pair1/pair.c deleted file mode 100644 index ba497c42..00000000 --- a/src/protocol/pair1/pair.c +++ /dev/null @@ -1,540 +0,0 @@ -// -// Copyright 2020 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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 - -#include "core/nng_impl.h" -#include "nng/protocol/pair1/pair.h" - -// Pair protocol. The PAIRv1 protocol is a simple 1:1 messaging pattern. - -#ifdef NNG_ENABLE_STATS -#define BUMP_STAT(x) nni_stat_inc(x, 1) -#else -#define BUMP_STAT(x) -#endif - -typedef struct pair1_pipe pair1_pipe; -typedef struct pair1_sock pair1_sock; - -static void pair1_pipe_send_cb(void *); -static void pair1_pipe_recv_cb(void *); -static void pair1_pipe_get_cb(void *); -static void pair1_pipe_put_cb(void *); -static void pair1_pipe_fini(void *); - -// pair1_sock is our per-socket protocol private structure. -struct pair1_sock { - nni_msgq * uwq; - nni_msgq * urq; - nni_sock * sock; - bool raw; - pair1_pipe * p; - nni_atomic_int ttl; - nni_mtx mtx; -#ifdef NNG_ENABLE_STATS - nni_stat_item stat_poly; - nni_stat_item stat_raw; - nni_stat_item stat_reject_mismatch; - nni_stat_item stat_reject_already; - nni_stat_item stat_ttl_drop; - nni_stat_item stat_rx_malformed; - nni_stat_item stat_tx_malformed; - nni_stat_item stat_tx_drop; -#endif -#ifdef NNG_TEST_LIB - bool inject_header; -#endif -}; - -// pair1_pipe is our per-pipe protocol private structure. -struct pair1_pipe { - nni_pipe * pipe; - pair1_sock *pair; - nni_aio aio_send; - nni_aio aio_recv; - nni_aio aio_get; - nni_aio aio_put; -}; - -static void -pair1_sock_fini(void *arg) -{ - pair1_sock *s = arg; - - nni_mtx_fini(&s->mtx); -} - -#ifdef NNG_ENABLE_STATS -static void -pair1_add_sock_stat( - pair1_sock *s, nni_stat_item *item, const nni_stat_info *info) -{ - nni_stat_init(item, info); - nni_sock_add_stat(s->sock, item); -} -#endif - -static int -pair1_sock_init_impl(void *arg, nni_sock *sock, bool raw) -{ - pair1_sock *s = arg; - - // Raw mode uses this. - nni_mtx_init(&s->mtx); - s->sock = sock; - -#ifdef NNG_ENABLE_STATS - static const nni_stat_info poly_info = { - .si_name = "poly", - .si_desc = "polyamorous mode?", - .si_type = NNG_STAT_BOOLEAN, - }; - static const nni_stat_info raw_info = { - .si_name = "raw", - .si_desc = "raw mode?", - .si_type = NNG_STAT_BOOLEAN, - }; - static const nni_stat_info mismatch_info = { - .si_name = "mismatch", - .si_desc = "pipes rejected (protocol mismatch)", - .si_type = NNG_STAT_COUNTER, - .si_atomic = true, - }; - static const nni_stat_info already_info = { - .si_name = "already", - .si_desc = "pipes rejected (already connected)", - .si_type = NNG_STAT_COUNTER, - .si_atomic = true, - }; - static const nni_stat_info ttl_drop_info = { - .si_name = "ttl_drop", - .si_desc = "messages dropped due to too many hops", - .si_type = NNG_STAT_COUNTER, - .si_unit = NNG_UNIT_MESSAGES, - .si_atomic = true, - }; - static const nni_stat_info tx_drop_info = { - .si_name = "tx_drop", - .si_desc = "messages dropped undeliverable", - .si_type = NNG_STAT_COUNTER, - .si_unit = NNG_UNIT_MESSAGES, - .si_atomic = true, - }; - static const nni_stat_info rx_malformed_info = { - .si_name = "rx_malformed", - .si_desc = "malformed messages received", - .si_type = NNG_STAT_COUNTER, - .si_unit = NNG_UNIT_MESSAGES, - .si_atomic = true, - }; - static const nni_stat_info tx_malformed_info = { - .si_name = "tx_malformed", - .si_desc = "malformed messages not sent", - .si_type = NNG_STAT_COUNTER, - .si_unit = NNG_UNIT_MESSAGES, - .si_atomic = true, - }; - - pair1_add_sock_stat(s, &s->stat_poly, &poly_info); - pair1_add_sock_stat(s, &s->stat_raw, &raw_info); - pair1_add_sock_stat(s, &s->stat_reject_mismatch, &mismatch_info); - pair1_add_sock_stat(s, &s->stat_reject_already, &already_info); - pair1_add_sock_stat(s, &s->stat_ttl_drop, &ttl_drop_info); - pair1_add_sock_stat(s, &s->stat_tx_drop, &tx_drop_info); - pair1_add_sock_stat(s, &s->stat_rx_malformed, &rx_malformed_info); - - if (raw) { - // This stat only makes sense in raw mode. - pair1_add_sock_stat( - s, &s->stat_tx_malformed, &tx_malformed_info); - } - - nni_stat_set_bool(&s->stat_raw, raw); - nni_stat_set_bool(&s->stat_poly, false); -#endif - - s->raw = raw; - s->uwq = nni_sock_sendq(sock); - s->urq = nni_sock_recvq(sock); - nni_atomic_init(&s->ttl); - nni_atomic_set(&s->ttl, 8); - - return (0); -} - -static int -pair1_sock_init(void *arg, nni_sock *sock) -{ - return (pair1_sock_init_impl(arg, sock, false)); -} - -static int -pair1_sock_init_raw(void *arg, nni_sock *sock) -{ - return (pair1_sock_init_impl(arg, sock, true)); -} - -static void -pair1_pipe_stop(void *arg) -{ - pair1_pipe *p = arg; - pair1_sock *s = p->pair; - - nni_mtx_lock(&s->mtx); - if (s->p == p) { - s->p = NULL; - } - nni_mtx_unlock(&s->mtx); - nni_aio_stop(&p->aio_send); - nni_aio_stop(&p->aio_recv); - nni_aio_stop(&p->aio_put); - nni_aio_stop(&p->aio_get); -} - -static void -pair1_pipe_fini(void *arg) -{ - pair1_pipe *p = arg; - - nni_aio_fini(&p->aio_send); - nni_aio_fini(&p->aio_recv); - nni_aio_fini(&p->aio_put); - nni_aio_fini(&p->aio_get); -} - -static int -pair1_pipe_init(void *arg, nni_pipe *pipe, void *pair) -{ - pair1_pipe *p = arg; - - nni_aio_init(&p->aio_send, pair1_pipe_send_cb, p); - nni_aio_init(&p->aio_recv, pair1_pipe_recv_cb, p); - nni_aio_init(&p->aio_get, pair1_pipe_get_cb, p); - nni_aio_init(&p->aio_put, pair1_pipe_put_cb, p); - - p->pipe = pipe; - p->pair = pair; - - return (0); -} - -static int -pair1_pipe_start(void *arg) -{ - pair1_pipe *p = arg; - pair1_sock *s = p->pair; - - if (nni_pipe_peer(p->pipe) != NNG_PAIR1_PEER) { - BUMP_STAT(&s->stat_reject_mismatch); - // Peer protocol mismatch. - return (NNG_EPROTO); - } - - nni_mtx_lock(&s->mtx); - if (s->p != NULL) { - nni_mtx_unlock(&s->mtx); - BUMP_STAT(&s->stat_reject_already); - return (NNG_EBUSY); - } - s->p = p; - nni_mtx_unlock(&s->mtx); - - // Schedule a get. - nni_msgq_aio_get(s->uwq, &p->aio_get); - - // And the pipe read of course. - nni_pipe_recv(p->pipe, &p->aio_recv); - - return (0); -} - -static void -pair1_pipe_close(void *arg) -{ - pair1_pipe *p = arg; - - nni_aio_close(&p->aio_send); - nni_aio_close(&p->aio_recv); - nni_aio_close(&p->aio_put); - nni_aio_close(&p->aio_get); -} - -static void -pair1_pipe_recv_cb(void *arg) -{ - pair1_pipe *p = arg; - pair1_sock *s = p->pair; - nni_msg * msg; - uint32_t hdr; - nni_pipe * pipe = p->pipe; - size_t len; - - if (nni_aio_result(&p->aio_recv) != 0) { - nni_pipe_close(p->pipe); - return; - } - - msg = nni_aio_get_msg(&p->aio_recv); - nni_aio_set_msg(&p->aio_recv, NULL); - - // Store the pipe ID. - nni_msg_set_pipe(msg, nni_pipe_id(p->pipe)); - - // If the message is missing the hop count header, scrap it. - if ((nni_msg_len(msg) < sizeof(uint32_t)) || - ((hdr = nni_msg_trim_u32(msg)) > 0xff)) { - BUMP_STAT(&s->stat_rx_malformed); - nni_msg_free(msg); - nni_pipe_close(pipe); - return; - } - - len = nni_msg_len(msg); - - // If we bounced too many times, discard the message, but - // keep getting more. - if ((int) hdr > nni_atomic_get(&s->ttl)) { - BUMP_STAT(&s->stat_ttl_drop); - nni_msg_free(msg); - nni_pipe_recv(pipe, &p->aio_recv); - return; - } - - // Store the hop count in the header. - nni_msg_header_append_u32(msg, hdr); - - // Send the message up. - nni_aio_set_msg(&p->aio_put, msg); - nni_sock_bump_rx(s->sock, len); - nni_msgq_aio_put(s->urq, &p->aio_put); -} - -static void -pair1_pipe_put_cb(void *arg) -{ - pair1_pipe *p = arg; - - if (nni_aio_result(&p->aio_put) != 0) { - nni_msg_free(nni_aio_get_msg(&p->aio_put)); - nni_aio_set_msg(&p->aio_put, NULL); - nni_pipe_close(p->pipe); - return; - } - nni_pipe_recv(p->pipe, &p->aio_recv); -} - -static void -pair1_pipe_get_cb(void *arg) -{ - pair1_pipe *p = arg; - pair1_sock *s = p->pair; - nni_msg * msg; - uint32_t hops; - - if (nni_aio_result(&p->aio_get) != 0) { - nni_pipe_close(p->pipe); - return; - } - - msg = nni_aio_get_msg(&p->aio_get); - nni_aio_set_msg(&p->aio_get, NULL); - - // Raw mode messages have the header already formed, with a hop count. - // Cooked mode messages have no header so we have to add one. - if (s->raw) { - if ((nni_msg_header_len(msg) != sizeof(uint32_t)) || - ((hops = nni_msg_header_trim_u32(msg)) > 254)) { - BUMP_STAT(&s->stat_tx_malformed); - nni_msg_free(msg); - nni_msgq_aio_get(s->uwq, &p->aio_get); - return; - } -#if NNG_TEST_LIB - } else if (s->inject_header) { - nni_aio_set_msg(&p->aio_send, msg); - nni_pipe_send(p->pipe, &p->aio_send); - return; -#endif - } else { - // Strip off any previously existing header, such as when - // replying to messages. - nni_msg_header_clear(msg); - hops = 0; - } - - hops++; - - // Insert the hops header. - nni_msg_header_append_u32(msg, hops); - - nni_aio_set_msg(&p->aio_send, msg); - nni_pipe_send(p->pipe, &p->aio_send); -} - -static void -pair1_pipe_send_cb(void *arg) -{ - pair1_pipe *p = arg; - pair1_sock *s = p->pair; - - if (nni_aio_result(&p->aio_send) != 0) { - nni_msg_free(nni_aio_get_msg(&p->aio_send)); - nni_aio_set_msg(&p->aio_send, NULL); - nni_pipe_close(p->pipe); - return; - } - - nni_msgq_aio_get(s->uwq, &p->aio_get); -} - -static void -pair1_sock_open(void *arg) -{ - NNI_ARG_UNUSED(arg); -} - -static void -pair1_sock_close(void *arg) -{ - NNI_ARG_UNUSED(arg); -} - -static int -pair1_sock_set_max_ttl(void *arg, const void *buf, size_t sz, nni_opt_type t) -{ - pair1_sock *s = arg; - int rv; - int ttl; - - if ((rv = nni_copyin_int(&ttl, buf, sz, 1, NNI_MAX_MAX_TTL, t)) == 0) { - nni_atomic_set(&s->ttl, ttl); - } - - return (rv); -} - -static int -pair1_sock_get_max_ttl(void *arg, void *buf, size_t *szp, nni_opt_type t) -{ - pair1_sock *s = arg; - return (nni_copyout_int(nni_atomic_get(&s->ttl), buf, szp, t)); -} - -#ifdef NNG_TEST_LIB -static int -pair1_set_test_inject_header(void *arg, const void *buf, size_t sz, nni_type t) -{ - pair1_sock *s = arg; - int rv; - nni_mtx_lock(&s->mtx); - rv = nni_copyin_bool(&s->inject_header, buf, sz, t); - nni_mtx_unlock(&s->mtx); - return (rv); -} -#endif - -static void -pair1_sock_send(void *arg, nni_aio *aio) -{ - pair1_sock *s = arg; - - nni_sock_bump_tx(s->sock, nni_msg_len(nni_aio_get_msg(aio))); - nni_msgq_aio_put(s->uwq, aio); -} - -static void -pair1_sock_recv(void *arg, nni_aio *aio) -{ - pair1_sock *s = arg; - - nni_msgq_aio_get(s->urq, aio); -} - -static nni_proto_pipe_ops pair1_pipe_ops = { - .pipe_size = sizeof(pair1_pipe), - .pipe_init = pair1_pipe_init, - .pipe_fini = pair1_pipe_fini, - .pipe_start = pair1_pipe_start, - .pipe_close = pair1_pipe_close, - .pipe_stop = pair1_pipe_stop, -}; - -static nni_option pair1_sock_options[] = { - { - .o_name = NNG_OPT_MAXTTL, - .o_get = pair1_sock_get_max_ttl, - .o_set = pair1_sock_set_max_ttl, - }, -#ifdef NNG_TEST_LIB - { - // Test only option to pass header unmolested. This allows - // us to inject bad header contents. - .o_name = "pair1_test_inject_header", - .o_set = pair1_set_test_inject_header, - }, -#endif - // terminate list - { - .o_name = NULL, - }, -}; - -static nni_proto_sock_ops pair1_sock_ops = { - .sock_size = sizeof(pair1_sock), - .sock_init = pair1_sock_init, - .sock_fini = pair1_sock_fini, - .sock_open = pair1_sock_open, - .sock_close = pair1_sock_close, - .sock_recv = pair1_sock_recv, - .sock_send = pair1_sock_send, - .sock_options = pair1_sock_options, -}; - -static nni_proto pair1_proto = { - .proto_version = NNI_PROTOCOL_VERSION, - .proto_self = { NNG_PAIR1_SELF, NNG_PAIR1_SELF_NAME }, - .proto_peer = { NNG_PAIR1_PEER, NNG_PAIR1_PEER_NAME }, - .proto_flags = NNI_PROTO_FLAG_SNDRCV, - .proto_sock_ops = &pair1_sock_ops, - .proto_pipe_ops = &pair1_pipe_ops, -}; - -int -nng_pair1_open(nng_socket *sock) -{ - return (nni_proto_open(sock, &pair1_proto)); -} - -static nni_proto_sock_ops pair1_sock_ops_raw = { - .sock_size = sizeof(pair1_sock), - .sock_init = pair1_sock_init_raw, - .sock_fini = pair1_sock_fini, - .sock_open = pair1_sock_open, - .sock_close = pair1_sock_close, - .sock_recv = pair1_sock_recv, - .sock_send = pair1_sock_send, - .sock_options = pair1_sock_options, -}; - -static nni_proto pair1_proto_raw = { - .proto_version = NNI_PROTOCOL_VERSION, - .proto_self = { NNG_PAIR1_SELF, NNG_PAIR1_SELF_NAME }, - .proto_peer = { NNG_PAIR1_PEER, NNG_PAIR1_PEER_NAME }, - .proto_flags = NNI_PROTO_FLAG_SNDRCV | NNI_PROTO_FLAG_RAW, - .proto_sock_ops = &pair1_sock_ops_raw, - .proto_pipe_ops = &pair1_pipe_ops, -}; - -int -nng_pair1_open_raw(nng_socket *sock) -{ - return (nni_proto_open(sock, &pair1_proto_raw)); -} -- cgit v1.2.3-70-g09d2