All random numbers generated via one PRNG seeded in one place.

[invirt/third/libt4.git] / rpc / rpc.h

diff --git a/rpc/rpc.h b/rpc/rpc.h
index d81a5dd..f1eb3bc 100644 (file)
--- a/rpc/rpc.h
+++ b/rpc/rpc.h
@@ -1,268 +1,237 @@
 #ifndef rpc_h
 #define rpc_h
 
 #ifndef rpc_h
 #define rpc_h
 

+#include "types.h"

 #include <sys/socket.h>
 #include <netinet/in.h>
 #include <sys/socket.h>
 #include <netinet/in.h>

-#include <list>
-#include <map>
-#include <stdio.h>

 
 

+#include "rpc_protocol.h"

 #include "thr_pool.h"
 #include "marshall.h"
 #include "thr_pool.h"
 #include "marshall.h"

+#include "marshall_wrap.h"

 #include "connection.h"
 #include "connection.h"

-#include "lock.h"
+#include "threaded_log.h"

 
 

-using std::string;
-using std::map;
-using std::list;
+using std::chrono::milliseconds;

 
 

-class rpc_const {
-    public:
-        static const unsigned int bind = 1;   // handler number reserved for bind
-        static const int timeout_failure = -1;
-        static const int unmarshal_args_failure = -2;
-        static const int unmarshal_reply_failure = -3;
-        static const int atmostonce_failure = -4;
-        static const int oldsrv_failure = -5;
-        static const int bind_failure = -6;
-        static const int cancel_failure = -7;
-};
+namespace rpc {
+    static constexpr milliseconds to_max{12000};
+    static constexpr milliseconds to_min{100};
+}
+
+template<class P, class R, class ...Args>
+struct is_valid_call : false_type {};
+
+template<class S, class R, class ...Args>
+struct is_valid_call<S(R &, Args...), R, Args...> : true_type {};
+
+template<class P, class F>
+struct is_valid_registration : false_type {};
+
+template<class S, class R, class ...Args>
+struct is_valid_registration<
+    S(R &, typename std::decay<Args>::type...),
+    S(R &, Args...)> : true_type {};
+
+template<class P, class C, class S, class R, class ...Args>
+struct is_valid_registration<
+    P,
+    S(C::*)(R &, Args...)> : is_valid_registration<P, S(R &, Args...)> {};

 
 // rpc client endpoint.
 // manages a xid space per destination socket
 // threaded: multiple threads can be sending RPCs,
 
 // rpc client endpoint.
 // manages a xid space per destination socket
 // threaded: multiple threads can be sending RPCs,

-class rpcc : public chanmgr {
-
+class rpcc : private connection_delegate {

     private:
     private:

+        using proc_id_t = rpc_protocol::proc_id_t;
+        template <class S>
+        using proc_t = rpc_protocol::proc_t<S>;
+        using nonce_t = rpc_protocol::nonce_t;
+        using xid_t = rpc_protocol::xid_t;

 
 

-        //manages per rpc info
+        // manages per rpc info

         struct caller {
         struct caller {

-            caller(int xxid, unmarshall *un);
-            ~caller();
+            caller(xid_t _xid, string *_rep) : xid(_xid), rep(_rep) {}

 
             int xid;
 
             int xid;

-            unmarshall *un;
+            string *rep;

             int intret;
             int intret;

-            bool done;
-            mutex m;
+            bool done = false;
+            std::mutex m;

             cond c;
         };
 
             cond c;
         };
 

-        void get_refconn(connection **ch);
-        void update_xid_rep(int xid);
+        void get_latest_connection(shared_ptr<connection> & ch);
+        void update_xid_rep(xid_t xid, lock & m_lock);

 
 
         sockaddr_in dst_;
 
 
         sockaddr_in dst_;

-        unsigned int clt_nonce_;
-        unsigned int srv_nonce_;
-        bool bind_done_;
-        int xid_;
-        int lossytest_;
-        bool retrans_;
-        bool reachable_;
+        nonce_t clt_nonce_;
+        nonce_t srv_nonce_ = 0;
+        bool bind_done_ = false;
+        int lossytest_ = 0;
+        bool reachable_ = true;

 
 

-        connection *chan_;
+        shared_ptr<connection> chan_;

 
 

-        mutex m_; // protect insert/delete to calls[]
-        mutex chan_m_;
+        std::mutex m_; // protect insert/delete to calls[]
+        std::mutex chan_m_;
+        std::mutex bind_m_; // protect bind operations

 
 

-        bool destroy_wait_;
+        bool destroy_wait_ = false;

         cond destroy_wait_c_;
 
         cond destroy_wait_c_;
 

-        map<int, caller *> calls_;
-        list<int> xid_rep_window_;
+        std::map<int, caller *> calls_;
+
+        // xid starts with 1 and latest received reply starts with 0
+        xid_t xid_ = 1;
+        std::list<xid_t> xid_rep_window_ = {0};

 
         struct request {
 
         struct request {

-            request() { clear(); }

             void clear() { buf.clear(); xid = -1; }
             bool isvalid() { return xid != -1; }
             string buf;
             void clear() { buf.clear(); xid = -1; }
             bool isvalid() { return xid != -1; }
             string buf;

-            int xid;
+            xid_t xid = -1;

         };
         };

-        struct request dup_req_;
-        int xid_rep_done_;
-    public:
+        request dup_req_;
+        int xid_rep_done_ = -1;

 
 

-        rpcc(const string & d, bool retrans=true);
-        ~rpcc();
+        int call1(proc_id_t proc, milliseconds to, string & rep, marshall & req);

 
 

-        struct TO {
-            int to;
-        };
-        static const TO to_max;
-        static const TO to_min;
-        static TO to(int x) { TO t; t.to = x; return t;}
+        template<class R>
+        inline int call_m(proc_id_t proc, milliseconds to, R & r, marshall && req) {
+            string rep;
+            int intret = call1(proc, to, rep, req);
+            if (intret < 0) return intret;
+            unmarshall u(rep, true, r);
+            if (u.okdone() != true) {
+                LOG << "rpcc::call_m: failed to unmarshall the reply.  You are probably "
+                    << "calling RPC 0x" << std::hex << proc << " with the wrong return type.";
+                VERIFY(0);
+                return rpc_protocol::unmarshall_reply_failure;
+            }
+            return intret;
+        }

 
 

-        unsigned int id() { return clt_nonce_; }
+        bool got_pdu(const shared_ptr<connection> & c, const string & b);

 
 

-        int bind(TO to = to_max);
+    public:

 
 

-        void set_reachable(bool r) { reachable_ = r; }
+        rpcc(const string & d);
+        ~rpcc();

 
 

-        void cancel();
+        nonce_t id() { return clt_nonce_; }

 
 

-        int islossy() { return lossytest_ > 0; }
+        int bind(milliseconds to = rpc::to_max);

 
 

-        int call1(proc_t proc, 
-                marshall &req, unmarshall &rep, TO to);
+        // Manages a cache of RPC connections.  Usage:
+        //     if (auto cl = rpcc::bind_cached(dst))
+        //         ret = cl->call(...);
+        // where the string dst has the form "host:port".  Because bind_cached()
+        // may block, callers should probably not hold mutexes.
+        static shared_ptr<rpcc> bind_cached(const string & destination);
+        static void unbind_cached(const string & destination);

 
 

-        bool got_pdu(connection *c, char *b, size_t sz);
+        void set_reachable(bool r) { reachable_ = r; }

 
 

-        template<class R>
-            int call_m(proc_t proc, marshall &req, R & r, TO to);
+        void cancel(lock & m_lock);

 
 

-        template<class R, typename ...Args>
-            inline int call(proc_t proc, R & r, const Args&... args);
+        template<class P, class R, typename ...Args>
+        inline int call(proc_t<P> proc, R & r, const Args & ... args) {
+            return call_timeout(proc, rpc::to_max, r, args...);
+        }

 
 

-        template<class R, typename ...Args>
-            inline int call_timeout(proc_t proc, TO to, R & r, const Args&... args);
+        template<class P, class R, typename ...Args>
+        inline int call_timeout(proc_t<P> proc, milliseconds to, R & r, const Args & ... args) {
+            static_assert(is_valid_call<P, R, Args...>::value, "RPC called with incorrect argument types");
+            return call_m(proc.id, to, r, std::forward<marshall>(marshall(args...)));
+        }

 };
 
 };
 

-template<class R> int 
-rpcc::call_m(proc_t proc, marshall &req, R & r, TO to) 
-{
-    unmarshall u;
-    int intret = call1(proc, req, u, to);
-    if (intret < 0) return intret;
-    u >> r;
-    if (u.okdone() != true) {
-        fprintf(stderr, "rpcc::call_m: failed to unmarshall the reply."
-                "You are probably calling RPC 0x%x with wrong return "
-                "type.\n", proc);
-        VERIFY(0);
-        return rpc_const::unmarshal_reply_failure;
-    }
-    return intret;
-}
-
-template<class R, typename... Args> inline int
-rpcc::call(proc_t proc, R & r, const Args&... args)
-{
-    return call_timeout(proc, rpcc::to_max, r, args...);
-}
-
-template<class R, typename... Args> inline int
-rpcc::call_timeout(proc_t proc, const rpcc::TO to, R & r, const Args&... args)
-{
-    marshall m{args...};
-    return call_m(proc, m, r, to);
-}
-
-bool operator<(const sockaddr_in &a, const sockaddr_in &b);
-

 // rpc server endpoint.
 // rpc server endpoint.

-class rpcs : public chanmgr {
-
-    typedef enum {
-        NEW,  // new RPC, not a duplicate
-        INPROGRESS, // duplicate of an RPC we're still processing
-        DONE, // duplicate of an RPC we already replied to (have reply)
-        FORGOTTEN,  // duplicate of an old RPC whose reply we've forgotten
-    } rpcstate_t;
-
+class rpcs : private connection_delegate {

     private:
     private:

+        using proc_id_t = rpc_protocol::proc_id_t;
+        template <class S>
+        using proc_t = rpc_protocol::proc_t<S>;
+        using nonce_t = rpc_protocol::nonce_t;
+        using xid_t = rpc_protocol::xid_t;
+
+        typedef enum {
+            NEW,  // new RPC, not a duplicate
+            INPROGRESS, // duplicate of an RPC we're still processing
+            DONE, // duplicate of an RPC we already replied to (have reply)
+            FORGOTTEN,  // duplicate of an old RPC whose reply we've forgotten
+        } rpcstate_t;

 
         // state about an in-progress or completed RPC, for at-most-once.
         // if cb_present is true, then the RPC is complete and a reply
         // has been sent; in that case buf points to a copy of the reply,
         // and sz holds the size of the reply.
 
         // state about an in-progress or completed RPC, for at-most-once.
         // if cb_present is true, then the RPC is complete and a reply
         // has been sent; in that case buf points to a copy of the reply,
         // and sz holds the size of the reply.

-    struct reply_t {
-        reply_t (int _xid) {
-            xid = _xid;
-            cb_present = false;
-            buf = NULL;
-            sz = 0;
-        }
-        reply_t (int _xid, char *_buf, size_t _sz) {
-            xid = _xid;
-            cb_present = true;
-            buf = _buf;
-            sz = _sz;
-        }
-        int xid;
-        bool cb_present; // whether the reply buffer is valid
-        char *buf;      // the reply buffer
-        size_t sz;         // the size of reply buffer
-    };
+        struct reply_t {
+            reply_t (xid_t _xid) : xid(_xid), cb_present(false) {}
+            reply_t (xid_t _xid, const string & _buf) : xid(_xid), cb_present(true), buf(_buf) {}
+            xid_t xid;
+            bool cb_present; // whether the reply buffer is valid
+            string buf;      // the reply buffer
+        };

 
 

-    unsigned int port_;
-    unsigned int nonce_;
+        in_port_t port_;
+        nonce_t nonce_;

 
 

-    // provide at most once semantics by maintaining a window of replies
-    // per client that that client hasn't acknowledged receiving yet.
+        // provide at most once semantics by maintaining a window of replies
+        // per client that that client hasn't acknowledged receiving yet.

         // indexed by client nonce.
         // indexed by client nonce.

-    map<unsigned int, list<reply_t> > reply_window_;
-
-    void free_reply_window(void);
-    void add_reply(unsigned int clt_nonce, int xid, char *b, size_t sz);
+        std::map<nonce_t, std::list<reply_t>> reply_window_;

 
 

-    rpcstate_t checkduplicate_and_update(unsigned int clt_nonce, 
-            int xid, int rep_xid,
-            char **b, size_t *sz);
+        void add_reply(nonce_t clt_nonce, xid_t xid, const string & b);

 
 

-    void updatestat(proc_t proc);
+        rpcstate_t check_duplicate_and_update(nonce_t clt_nonce, xid_t xid,
+                xid_t rep_xid, string & b);

 
 

-    // latest connection to the client
-    map<unsigned int, connection *> conns_;
+        // latest connection to the client
+        std::map<nonce_t, shared_ptr<connection>> conns_;

 
 

-    // counting
-    const size_t counting_;
-    size_t curr_counts_;
-    map<proc_t, size_t> counts_;
+        bool reachable_ = true;

 
 

-    int lossytest_; 
-    bool reachable_;
+        // map proc # to function
+        std::map<proc_id_t, handler *> procs_;

 
 

-    // map proc # to function
-    map<proc_t, handler *> procs_;
+        std::mutex procs_m_; // protect insert/delete to procs[]
+        std::mutex reply_window_m_; // protect reply window et al
+        std::mutex conns_m_; // protect conns_

 
 

-    mutex procs_m_; // protect insert/delete to procs[]
-    mutex count_m_;  //protect modification of counts
-    mutex reply_window_m_; // protect reply window et al
-    mutex conss_m_; // protect conns_
+        void dispatch(shared_ptr<connection> c, const string & buf);

 
 

+        unique_ptr<thread_pool> dispatchpool_{new thread_pool(6, false)};
+        unique_ptr<connection_listener> listener_;

 
 

-    protected:
+        // RPC handler for clients binding
+        rpc_protocol::status rpcbind(nonce_t & r);

 
 

-    struct djob_t {
-        djob_t (connection *c, char *b, size_t bsz):buf(b),sz(bsz),conn(c) {}
-        char *buf;
-        size_t sz;
-        connection *conn;
-    };
-    void dispatch(djob_t *);
-
-    // internal handler registration
-    void reg1(proc_t proc, handler *);
-
-    ThrPool* dispatchpool_;
-    tcpsconn* listener_;
+        bool got_pdu(const shared_ptr<connection> & c, const string & b);

 
     public:
 
     public:

-    rpcs(unsigned int port, size_t counts=0);
-    ~rpcs();
-    inline unsigned int port() { return listener_->port(); }
-    //RPC handler for clients binding
-    int rpcbind(unsigned int &r, int a);

 
 

-    void set_reachable(bool r) { reachable_ = r; }
+        rpcs(in_port_t port);
+        ~rpcs();

 
 

-    bool got_pdu(connection *c, char *b, size_t sz);
+        void set_reachable(bool r) { reachable_ = r; }

 
 

-    template<class F, class C=void> void reg(proc_t proc, F f, C *c=nullptr);
-};
+        template<class P, class F, class C=void> inline void reg(proc_t<P> proc, F f, C *c=nullptr) {
+            static_assert(is_valid_registration<P, F>::value, "RPC handler registered with incorrect argument types");
+            struct ReturnOnFailure {
+                static inline int unmarshall_args_failure() {
+                    return rpc_protocol::unmarshall_args_failure;
+                }
+            };
+            lock pl(procs_m_);
+            VERIFY(procs_.count(proc.id) == 0);
+            procs_[proc.id] = marshalled_func<F, ReturnOnFailure>::wrap(f, c);
+            VERIFY(procs_.count(proc.id) >= 1);
+        }

 
 

-struct ReturnOnFailure {
-    static inline int unmarshall_args_failure() {
-        return rpc_const::unmarshal_args_failure;
-    }
+        void start();

 };
 
 };
 

-template<class F, class C> void rpcs::reg(proc_t proc, F f, C *c) {
-    reg1(proc, marshalled_func<F, ReturnOnFailure>::wrap(f, c));
-}
-
-sockaddr_in make_sockaddr(const string &hostandport);
-sockaddr_in make_sockaddr(const string &host, const string &port);
-

 #endif
 #endif