rpc/rpc.h

   1 #ifndef rpc_h
   2 #define rpc_h
   3
   4 #include "types.h"
   5 #include <sys/socket.h>
   6 #include <netinet/in.h>
   7
   8 #include "rpc_protocol.h"
   9 #include "thr_pool.h"
  10 #include "marshall.h"
  11 #include "marshall_wrap.h"
  12 #include "connection.h"
  13
  14 namespace rpc {
  15     static constexpr milliseconds to_max{12000};
  16     static constexpr milliseconds to_min{100};
  17 }
  18
  19 template<class P, class R, class ...Args> struct is_valid_call : false_type {};
  20
  21 template<class S, class R, class ...Args>
  22 struct is_valid_call<S(R &, Args...), R, Args...> : true_type {};
  23
  24 template<class P, class F> struct is_valid_registration : false_type {};
  25
  26 template<class S, class R, class ...Args>
  27 struct is_valid_registration<S(R &, typename decay<Args>::type...), S(R &, Args...)> : true_type {};
  28
  29 template<class P, class C, class S, class R, class ...Args>
  30 struct is_valid_registration<P, S(C::*)(R &, Args...)> : is_valid_registration<P, S(R &, Args...)> {};
  31
  32 // rpc client endpoint.
  33 // manages a xid space per destination socket
  34 // threaded: multiple threads can be sending RPCs,
  35 class rpcc : private connection_delegate {
  36     private:
  37         using proc_id_t = rpc_protocol::proc_id_t;
  38         template <class S>
  39         using proc_t = rpc_protocol::proc_t<S>;
  40         using nonce_t = rpc_protocol::nonce_t;
  41         using xid_t = rpc_protocol::xid_t;
  42
  43         // manages per rpc info
  44         struct caller {
  45             caller(xid_t _xid, string *_rep) : xid(_xid), rep(_rep) {}
  46
  47             int xid;
  48             string *rep;
  49             int intret;
  50             bool done = false;
  51             mutex m;
  52             cond c;
  53         };
  54
  55         void get_refconn(shared_ptr<connection> & ch);
  56         void update_xid_rep(xid_t xid);
  57
  58
  59         sockaddr_in dst_;
  60         nonce_t clt_nonce_;
  61         nonce_t srv_nonce_;
  62         bool bind_done_;
  63         xid_t xid_;
  64         int lossytest_;
  65         bool retrans_;
  66         bool reachable_;
  67
  68         shared_ptr<connection> chan_;
  69
  70         mutex m_; // protect insert/delete to calls[]
  71         mutex chan_m_;
  72
  73         bool destroy_wait_;
  74         cond destroy_wait_c_;
  75
  76         map<int, caller *> calls_;
  77         list<xid_t> xid_rep_window_;
  78
  79         struct request {
  80             void clear() { buf.clear(); xid = -1; }
  81             bool isvalid() { return xid != -1; }
  82             string buf;
  83             xid_t xid = -1;
  84         };
  85         request dup_req_;
  86         int xid_rep_done_;
  87
  88         int call1(proc_id_t proc, marshall &req, string &rep, milliseconds to);
  89
  90         template<class R>
  91         int call_m(proc_id_t proc, marshall &req, R & r, milliseconds to) {
  92             string rep;
  93             int intret = call1(proc, req, rep, to);
  94             unmarshall u(rep, true);
  95             if (intret < 0) return intret;
  96             u >> r;
  97             if (u.okdone() != true) {
  98                 LOG("rpcc::call_m: failed to unmarshall the reply.  You are probably " <<
  99                     "calling RPC 0x" << hex << proc << " with the wrong return type.");
 100                 VERIFY(0);
 101                 return rpc_protocol::unmarshal_reply_failure;
 102             }
 103             return intret;
 104         }
 105
 106         bool got_pdu(const shared_ptr<connection> & c, const string & b);
 107
 108     public:
 109
 110         rpcc(const string & d, bool retrans=true);
 111         ~rpcc();
 112
 113         nonce_t id() { return clt_nonce_; }
 114
 115         int bind(milliseconds to = rpc::to_max);
 116
 117         void set_reachable(bool r) { reachable_ = r; }
 118
 119         void cancel();
 120
 121         template<class P, class R, typename ...Args>
 122         inline int call(proc_t<P> proc, R & r, const Args&... args) {
 123             return call_timeout(proc, rpc::to_max, r, args...);
 124         }
 125
 126         template<class P, class R, typename ...Args>
 127         inline int call_timeout(proc_t<P> proc, milliseconds to, R & r, const Args&... args) {
 128             static_assert(is_valid_call<P, R, Args...>::value, "RPC called with incorrect argument types");
 129             marshall m{args...};
 130             return call_m(proc.id, m, r, to);
 131         }
 132 };
 133
 134 // rpc server endpoint.
 135 class rpcs : private connection_delegate {
 136     private:
 137         using proc_id_t = rpc_protocol::proc_id_t;
 138         template <class S>
 139         using proc_t = rpc_protocol::proc_t<S>;
 140         using nonce_t = rpc_protocol::nonce_t;
 141         using xid_t = rpc_protocol::xid_t;
 142
 143         typedef enum {
 144             NEW,  // new RPC, not a duplicate
 145             INPROGRESS, // duplicate of an RPC we're still processing
 146             DONE, // duplicate of an RPC we already replied to (have reply)
 147             FORGOTTEN,  // duplicate of an old RPC whose reply we've forgotten
 148         } rpcstate_t;
 149
 150         // state about an in-progress or completed RPC, for at-most-once.
 151         // if cb_present is true, then the RPC is complete and a reply
 152         // has been sent; in that case buf points to a copy of the reply,
 153         // and sz holds the size of the reply.
 154         struct reply_t {
 155             reply_t (xid_t _xid) : xid(_xid), cb_present(false) {}
 156             reply_t (xid_t _xid, const string & _buf) : xid(_xid), cb_present(true), buf(_buf) {}
 157             xid_t xid;
 158             bool cb_present; // whether the reply buffer is valid
 159             string buf;      // the reply buffer
 160         };
 161
 162         in_port_t port_;
 163         nonce_t nonce_;
 164
 165         // provide at most once semantics by maintaining a window of replies
 166         // per client that that client hasn't acknowledged receiving yet.
 167         // indexed by client nonce.
 168         map<nonce_t, list<reply_t>> reply_window_;
 169
 170         void free_reply_window(void);
 171         void add_reply(nonce_t clt_nonce, xid_t xid, const string & b);
 172
 173         rpcstate_t checkduplicate_and_update(nonce_t clt_nonce, xid_t xid,
 174                 xid_t rep_xid, string & b);
 175
 176         // latest connection to the client
 177         map<nonce_t, shared_ptr<connection>> conns_;
 178
 179         bool reachable_;
 180
 181         // map proc # to function
 182         map<proc_id_t, handler *> procs_;
 183
 184         mutex procs_m_; // protect insert/delete to procs[]
 185         mutex reply_window_m_; // protect reply window et al
 186         mutex conns_m_; // protect conns_
 187
 188         void dispatch(shared_ptr<connection> c, const string & buf);
 189
 190         // internal handler registration
 191         void reg1(proc_id_t proc, handler *);
 192
 193         unique_ptr<thread_pool> dispatchpool_;
 194         unique_ptr<connection_listener> listener_;
 195
 196         // RPC handler for clients binding
 197         rpc_protocol::status rpcbind(nonce_t &r);
 198
 199         bool got_pdu(const shared_ptr<connection> & c, const string & b);
 200
 201     public:
 202
 203         rpcs(in_port_t port);
 204         ~rpcs();
 205
 206         void set_reachable(bool r) { reachable_ = r; }
 207
 208         template<class P, class F, class C=void> inline void reg(proc_t<P> proc, F f, C *c=nullptr) {
 209             static_assert(is_valid_registration<P, F>::value, "RPC handler registered with incorrect argument types");
 210             struct ReturnOnFailure {
 211                 static inline int unmarshall_args_failure() {
 212                     return rpc_protocol::unmarshal_args_failure;
 213                 }
 214             };
 215             reg1(proc.id, marshalled_func<F, ReturnOnFailure>::wrap(f, c));
 216         }
 217
 218         void start();
 219 };
 220
 221 #endif