rsm.cc

   1 //
   2 // Replicated state machine implementation with a primary and several
   3 // backups. The primary receives requests, assigns each a view stamp (a
   4 // vid, and a sequence number) in the order of reception, and forwards
   5 // them to all backups. A backup executes requests in the order that
   6 // the primary stamps them and replies with an OK to the primary. The
   7 // primary executes the request after it receives OKs from all backups,
   8 // and sends the reply back to the client.
   9 //
  10 // The config module will tell the RSM about a new view. If the
  11 // primary in the previous view is a member of the new view, then it
  12 // will stay the primary.  Otherwise, the smallest numbered node of
  13 // the previous view will be the new primary.  In either case, the new
  14 // primary will be a node from the previous view.  The configuration
  15 // module constructs the sequence of views for the RSM and the RSM
  16 // ensures there will be always one primary, who was a member of the
  17 // last view.
  18 //
  19 // When a new node starts, the recovery thread is in charge of joining
  20 // the RSM.  It will collect the internal RSM state from the primary;
  21 // the primary asks the config module to add the new node and returns
  22 // to the joining the internal RSM state (e.g., paxos log). Since
  23 // there is only one primary, all joins happen in well-defined total
  24 // order.
  25 //
  26 // The recovery thread also runs during a view change (e.g, when a node
  27 // has failed).  After a failure some of the backups could have
  28 // processed a request that the primary has not, but those results are
  29 // not visible to clients (since the primary responds).  If the
  30 // primary of the previous view is in the current view, then it will
  31 // be the primary and its state is authoritive: the backups download
  32 // from the primary the current state.  A primary waits until all
  33 // backups have downloaded the state.  Once the RSM is in sync, the
  34 // primary accepts requests again from clients.  If one of the backups
  35 // is the new primary, then its state is authoritative.  In either
  36 // scenario, the next view uses a node as primary that has the state
  37 // resulting from processing all acknowledged client requests.
  38 // Therefore, if the nodes sync up before processing the next request,
  39 // the next view will have the correct state.
  40 //
  41 // While the RSM in a view change (i.e., a node has failed, a new view
  42 // has been formed, but the sync hasn't completed), another failure
  43 // could happen, which complicates a view change.  During syncing the
  44 // primary or backups can timeout, and initiate another Paxos round.
  45 // There are 2 variables that RSM uses to keep track in what state it
  46 // is:
  47 //    - inviewchange: a node has failed and the RSM is performing a view change
  48 //    - insync: this node is syncing its state
  49 //
  50 // If inviewchange is false and a node is the primary, then it can
  51 // process client requests. If it is true, clients are told to retry
  52 // later again.  While inviewchange is true, the RSM may go through several
  53 // member list changes, one by one.   After a member list
  54 // change completes, the nodes tries to sync. If the sync complets,
  55 // the view change completes (and inviewchange is set to false).  If
  56 // the sync fails, the node may start another member list change
  57 // (inviewchange = true and insync = false).
  58 //
  59 // The implementation should be used only with servers that run all
  60 // requests run to completion; in particular, a request shouldn't
  61 // block.  If a request blocks, the backup won't respond to the
  62 // primary, and the primary won't execute the request.  A request may
  63 // send an RPC to another host, but the RPC should be a one-way
  64 // message to that host; the backup shouldn't do anything based on the
  65 // response or execute after the response, because it is not
  66 // guaranteed that all backup will receive the same response and
  67 // execute in the same order.
  68 //
  69 // The implementation can be viewed as a layered system:
  70 //       RSM module     ---- in charge of replication
  71 //       config module  ---- in charge of view management
  72 //       Paxos module   ---- in charge of running Paxos to agree on a value
  73 //
  74 // Each module has threads and internal locks. Furthermore, a thread
  75 // may call down through the layers (e.g., to run Paxos's proposer).
  76 // When Paxos's acceptor accepts a new value for an instance, a thread
  77 // will invoke an upcall to inform higher layers of the new value.
  78 // The rule is that a module releases its internal locks before it
  79 // upcalls, but can keep its locks when calling down.
  80
  81 #include <sys/types.h>
  82 #include <unistd.h>
  83
  84 #include "types.h"
  85 #include "handle.h"
  86 #include "rsm.h"
  87 #include "rsm_client.h"
  88
  89 rsm::rsm(const string & _first, const string & _me) :
  90     stf(0), primary(_first), insync (false), inviewchange (true), vid_commit(0),
  91     partitioned (false), dopartition(false), break1(false), break2(false)
  92 {
  93     cfg = unique_ptr<config>(new config(_first, _me, this));
  94
  95     if (_first == _me) {
  96         // Commit the first view here. We can not have acceptor::acceptor
  97         // do the commit, since at that time this->cfg is not initialized
  98         commit_change(1);
  99     }
 100     rsmrpc = cfg->get_rpcs();
 101     rsmrpc->reg(rsm_client_protocol::invoke, &rsm::client_invoke, this);
 102     rsmrpc->reg(rsm_client_protocol::members, &rsm::client_members, this);
 103     rsmrpc->reg(rsm_protocol::invoke, &rsm::invoke, this);
 104     rsmrpc->reg(rsm_protocol::transferreq, &rsm::transferreq, this);
 105     rsmrpc->reg(rsm_protocol::transferdonereq, &rsm::transferdonereq, this);
 106     rsmrpc->reg(rsm_protocol::joinreq, &rsm::joinreq, this);
 107
 108     // tester must be on different port, otherwise it may partition itself
 109     testsvr = unique_ptr<rpcs>(new rpcs((in_port_t)stoi(_me) + 1));
 110     testsvr->reg(rsm_test_protocol::net_repair, &rsm::test_net_repairreq, this);
 111     testsvr->reg(rsm_test_protocol::breakpoint, &rsm::breakpointreq, this);
 112 }
 113
 114 void rsm::start() {
 115     lock ml(rsm_mutex);
 116     rsmrpc->start();
 117     testsvr->start();
 118     thread(&rsm::recovery, this).detach();
 119 }
 120
 121 void rsm::reg1(int proc, handler *h) {
 122     lock ml(rsm_mutex);
 123     procs[proc] = h;
 124 }
 125
 126 // The recovery thread runs this function
 127 void rsm::recovery() [[noreturn]] {
 128     bool r = true;
 129     lock ml(rsm_mutex);
 130
 131     while (1) {
 132         while (!cfg->ismember(cfg->myaddr(), vid_commit)) {
 133             // XXX iannucci 2013/09/15 -- I don't understand whether accessing
 134             // cfg->view_id in this manner involves a race.  I suspect not.
 135             if (join(primary, ml)) {
 136                 LOG("recovery: joined");
 137                 commit_change(cfg->view_id(), ml);
 138             } else {
 139                 ml.unlock();
 140                 this_thread::sleep_for(seconds(3)); // XXX make another node in cfg primary?
 141                 ml.lock();
 142             }
 143         }
 144         vid_insync = vid_commit;
 145         LOG("recovery: sync vid_insync " << vid_insync);
 146         if (primary == cfg->myaddr()) {
 147             r = sync_with_backups(ml);
 148         } else {
 149             r = sync_with_primary(ml);
 150         }
 151         LOG("recovery: sync done");
 152
 153         // If there was a commited viewchange during the synchronization, restart
 154         // the recovery
 155         if (vid_insync != vid_commit)
 156             continue;
 157
 158         if (r) {
 159             myvs.vid = vid_commit;
 160             myvs.seqno = 1;
 161             inviewchange = false;
 162         }
 163         LOG("recovery: go to sleep " << insync << " " << inviewchange);
 164         recovery_cond.wait(ml);
 165     }
 166 }
 167
 168 bool rsm::sync_with_backups(lock & rsm_mutex_lock) {
 169     rsm_mutex_lock.unlock();
 170     {
 171         // Make sure that the state of lock_server is stable during
 172         // synchronization; otherwise, the primary's state may be more recent
 173         // than replicas after the synchronization.
 174         lock invoke_mutex_lock(invoke_mutex);
 175         // By acquiring and releasing the invoke_mutex once, we make sure that
 176         // the state of lock_server will not be changed until all
 177         // replicas are synchronized. The reason is that client_invoke arrives
 178         // after this point of time will see inviewchange == true, and returns
 179         // BUSY.
 180     }
 181     rsm_mutex_lock.lock();
 182     // Start accepting synchronization request (statetransferreq) now!
 183     insync = true;
 184     cfg->get_view(vid_insync, backups);
 185     backups.erase(find(backups.begin(), backups.end(), cfg->myaddr()));
 186     LOG("backups " << backups);
 187     sync_cond.wait(rsm_mutex_lock);
 188     insync = false;
 189     return true;
 190 }
 191
 192
 193 bool rsm::sync_with_primary(lock & rsm_mutex_lock) {
 194     // Remember the primary of vid_insync
 195     string m = primary;
 196     while (vid_insync == vid_commit) {
 197         if (statetransfer(m, rsm_mutex_lock))
 198             break;
 199     }
 200     return statetransferdone(m, rsm_mutex_lock);
 201 }
 202
 203
 204 //
 205 // Call to transfer state from m to the local node.
 206 // Assumes that rsm_mutex is already held.
 207 //
 208 bool rsm::statetransfer(const string & m, lock & rsm_mutex_lock)
 209 {
 210     rsm_protocol::transferres r;
 211     handle h(m);
 212     int ret = 0;
 213     LOG("contact " << m << " w. my last_myvs(" << last_myvs.vid << "," << last_myvs.seqno << ")");
 214     rpcc *cl;
 215     {
 216         rsm_mutex_lock.unlock();
 217         cl = h.safebind();
 218         if (cl) {
 219             ret = cl->call_timeout(rsm_protocol::transferreq, milliseconds(100),
 220                     r, cfg->myaddr(), last_myvs, vid_insync);
 221         }
 222         rsm_mutex_lock.lock();
 223     }
 224     if (cl == 0 || ret != rsm_protocol::OK) {
 225         LOG("couldn't reach " << m << " " << hex << cl << " " << dec << ret);
 226         return false;
 227     }
 228     if (stf && last_myvs != r.last) {
 229         stf->unmarshal_state(r.state);
 230     }
 231     last_myvs = r.last;
 232     LOG("transfer from " << m << " success, vs(" << last_myvs.vid << "," << last_myvs.seqno << ")");
 233     return true;
 234 }
 235
 236 bool rsm::statetransferdone(const string & m, lock & rsm_mutex_lock) {
 237     rsm_mutex_lock.unlock();
 238     handle h(m);
 239     rpcc *cl = h.safebind();
 240     bool done = false;
 241     if (cl) {
 242         int r;
 243         auto ret = (rsm_protocol::status)cl->call(rsm_protocol::transferdonereq, r, cfg->myaddr(), vid_insync);
 244         done = (ret == rsm_protocol::OK);
 245     }
 246     rsm_mutex_lock.lock();
 247     return done;
 248 }
 249
 250
 251 bool rsm::join(const string & m, lock & rsm_mutex_lock) {
 252     handle h(m);
 253     int ret = 0;
 254     string log;
 255
 256     LOG("contacting " << m << " mylast (" << last_myvs.vid << "," << last_myvs.seqno << ")");
 257     rpcc *cl;
 258     {
 259         rsm_mutex_lock.unlock();
 260         cl = h.safebind();
 261         if (cl != 0) {
 262             ret = cl->call_timeout(rsm_protocol::joinreq, milliseconds(12000), log,
 263                     cfg->myaddr(), last_myvs);
 264         }
 265         rsm_mutex_lock.lock();
 266     }
 267
 268     if (cl == 0 || ret != rsm_protocol::OK) {
 269         LOG("couldn't reach " << m << " " << hex << cl << " " << dec << ret);
 270         return false;
 271     }
 272     LOG("succeeded " << log);
 273     cfg->restore(log);
 274     return true;
 275 }
 276
 277 //
 278 // Config informs rsm whenever it has successfully
 279 // completed a view change
 280 //
 281 void rsm::commit_change(unsigned vid) {
 282     lock ml(rsm_mutex);
 283     commit_change(vid, ml);
 284     if (cfg->ismember(cfg->myaddr(), vid_commit))
 285         breakpoint2();
 286 }
 287
 288 void rsm::commit_change(unsigned vid, lock &) {
 289     if (vid <= vid_commit)
 290         return;
 291     LOG("commit_change: new view (" << vid << ") last vs (" << last_myvs.vid << "," <<
 292             last_myvs.seqno << ") " << primary << " insync " << insync);
 293     vid_commit = vid;
 294     inviewchange = true;
 295     set_primary(vid);
 296     recovery_cond.notify_one();
 297     sync_cond.notify_one();
 298     if (cfg->ismember(cfg->myaddr(), vid_commit))
 299         breakpoint2();
 300 }
 301
 302
 303 void rsm::execute(int procno, const string & req, string & r) {
 304     LOG("execute");
 305     handler *h = procs[procno];
 306     VERIFY(h);
 307     unmarshall args(req, false);
 308     marshall rep;
 309     auto ret = (rsm_protocol::status)(*h)(args, rep);
 310     r = marshall{ret, rep.content()}.content();
 311 }
 312
 313 //
 314 // Clients call client_invoke to invoke a procedure on the replicated state
 315 // machine: the primary receives the request, assigns it a sequence
 316 // number, and invokes it on all members of the replicated state
 317 // machine.
 318 //
 319 rsm_client_protocol::status rsm::client_invoke(string & r, int procno, const string & req) {
 320     LOG("invoke procno 0x" << hex << procno);
 321     lock ml(invoke_mutex);
 322     vector<string> m;
 323     string myaddr;
 324     viewstamp vs;
 325     {
 326         lock ml2(rsm_mutex);
 327         LOG("Checking for inviewchange");
 328         if (inviewchange)
 329             return rsm_client_protocol::BUSY;
 330         LOG("Checking for primacy");
 331         myaddr = cfg->myaddr();
 332         if (primary != myaddr)
 333             return rsm_client_protocol::NOTPRIMARY;
 334         LOG("Assigning a viewstamp");
 335         cfg->get_view(vid_commit, m);
 336         // assign the RPC the next viewstamp number
 337         vs = myvs;
 338         myvs++;
 339     }
 340
 341     // send an invoke RPC to all slaves in the current view with a timeout of 1 second
 342     LOG("Invoking slaves");
 343     for (unsigned i  = 0; i < m.size(); i++) {
 344         if (m[i] != myaddr) {
 345             // if invoke on slave fails, return rsm_client_protocol::BUSY
 346             handle h(m[i]);
 347             LOG("Sending invoke to " << m[i]);
 348             rpcc *cl = h.safebind();
 349             if (!cl)
 350                 return rsm_client_protocol::BUSY;
 351             int ignored_rval;
 352             auto ret = (rsm_protocol::status)cl->call_timeout(rsm_protocol::invoke, milliseconds(100), ignored_rval, procno, vs, req);
 353             LOG("Invoke returned " << ret);
 354             if (ret != rsm_protocol::OK)
 355                 return rsm_client_protocol::BUSY;
 356             breakpoint1();
 357             lock rsm_mutex_lock(rsm_mutex);
 358             partition1(rsm_mutex_lock);
 359         }
 360     }
 361     execute(procno, req, r);
 362     last_myvs = vs;
 363     return rsm_client_protocol::OK;
 364 }
 365
 366 //
 367 // The primary calls the internal invoke at each member of the
 368 // replicated state machine
 369 //
 370 // the replica must execute requests in order (with no gaps)
 371 // according to requests' seqno
 372
 373 rsm_protocol::status rsm::invoke(int &, int proc, viewstamp vs, const string & req) {
 374     LOG("invoke procno 0x" << hex << proc);
 375     lock ml(invoke_mutex);
 376     vector<string> m;
 377     string myaddr;
 378     {
 379         lock ml2(rsm_mutex);
 380         // check if !inviewchange
 381         LOG("Checking for view change");
 382         if (inviewchange)
 383             return rsm_protocol::ERR;
 384         // check if slave
 385         LOG("Checking for slave status");
 386         myaddr = cfg->myaddr();
 387         if (primary == myaddr)
 388             return rsm_protocol::ERR;
 389         cfg->get_view(vid_commit, m);
 390         if (find(m.begin(), m.end(), myaddr) == m.end())
 391             return rsm_protocol::ERR;
 392         // check sequence number
 393         LOG("Checking sequence number");
 394         if (vs != myvs)
 395             return rsm_protocol::ERR;
 396         myvs++;
 397     }
 398     string r;
 399     execute(proc, req, r);
 400     last_myvs = vs;
 401     breakpoint1();
 402     return rsm_protocol::OK;
 403 }
 404
 405 //
 406 // RPC handler: Send back the local node's state to the caller
 407 //
 408 rsm_protocol::status rsm::transferreq(rsm_protocol::transferres &r, const string & src,
 409         viewstamp last, unsigned vid) {
 410     lock ml(rsm_mutex);
 411     LOG("transferreq from " << src << " (" << last.vid << "," << last.seqno << ") vs (" <<
 412             last_myvs.vid << "," << last_myvs.seqno << ")");
 413     if (!insync || vid != vid_insync)
 414         return rsm_protocol::BUSY;
 415     if (stf && last != last_myvs)
 416         r.state = stf->marshal_state();
 417     r.last = last_myvs;
 418     return rsm_protocol::OK;
 419 }
 420
 421 //
 422 // RPC handler: Inform the local node (the primary) that node m has synchronized
 423 // for view vid
 424 //
 425 rsm_protocol::status rsm::transferdonereq(int &, const string & m, unsigned vid) {
 426     lock ml(rsm_mutex);
 427     if (!insync || vid != vid_insync)
 428         return rsm_protocol::BUSY;
 429     backups.erase(find(backups.begin(), backups.end(), m));
 430     if (backups.empty())
 431         sync_cond.notify_one();
 432     return rsm_protocol::OK;
 433 }
 434
 435 // a node that wants to join an RSM as a server sends a
 436 // joinreq to the RSM's current primary; this is the
 437 // handler for that RPC.
 438 rsm_protocol::status rsm::joinreq(string & log, const string & m, viewstamp last) {
 439     auto ret = rsm_protocol::OK;
 440
 441     lock ml(rsm_mutex);
 442     LOG("join request from " << m << "; last=(" << last.vid << "," << last.seqno << "), mylast=(" <<
 443             last_myvs.vid << "," << last_myvs.seqno << ")");
 444     if (cfg->ismember(m, vid_commit)) {
 445         LOG(m << " is still a member -- nothing to do");
 446         log = cfg->dump();
 447     } else if (cfg->myaddr() != primary) {
 448         LOG("but I, " << cfg->myaddr() << ", am not the primary, " << primary << "!");
 449         ret = rsm_protocol::BUSY;
 450     } else {
 451         // We cache vid_commit to avoid adding m to a view which already contains
 452         // m due to race condition
 453         LOG("calling down to config layer");
 454         unsigned vid_cache = vid_commit;
 455         bool succ;
 456         {
 457             ml.unlock();
 458             succ = cfg->add(m, vid_cache);
 459             ml.lock();
 460         }
 461         if (cfg->ismember(m, cfg->view_id())) {
 462             log = cfg->dump();
 463             LOG("ret " << ret << " log " << log);
 464         } else {
 465             LOG("failed; proposer couldn't add " << succ);
 466             ret = rsm_protocol::BUSY;
 467         }
 468     }
 469     return ret;
 470 }
 471
 472 //
 473 // RPC handler: Send back all the nodes this local knows about to client
 474 // so the client can switch to a different primary
 475 // when it existing primary fails
 476 //
 477 rsm_client_protocol::status rsm::client_members(vector<string> &r, int) {
 478     vector<string> m;
 479     lock ml(rsm_mutex);
 480     cfg->get_view(vid_commit, m);
 481     m.push_back(primary);
 482     r = m;
 483     LOG("return " << m << " m " << primary);
 484     return rsm_client_protocol::OK;
 485 }
 486
 487 // if primary is member of new view, that node is primary
 488 // otherwise, the lowest number node of the previous view.
 489 // caller should hold rsm_mutex
 490 void rsm::set_primary(unsigned vid) {
 491     vector<string> c, p;
 492     cfg->get_view(vid, c);
 493     cfg->get_view(vid - 1, p);
 494     VERIFY (c.size() > 0);
 495
 496     if (isamember(primary,c)) {
 497         LOG("set_primary: primary stays " << primary);
 498         return;
 499     }
 500
 501     VERIFY(p.size() > 0);
 502     for (unsigned i = 0; i < p.size(); i++) {
 503         if (isamember(p[i], c)) {
 504             primary = p[i];
 505             LOG("set_primary: primary is " << primary);
 506             return;
 507         }
 508     }
 509     VERIFY(0);
 510 }
 511
 512 bool rsm::amiprimary() {
 513     lock ml(rsm_mutex);
 514     return primary == cfg->myaddr() && !inviewchange;
 515 }
 516
 517
 518 // Testing server
 519
 520 // Simulate partitions
 521
 522 // assumes caller holds rsm_mutex
 523 void rsm::net_repair(bool heal, lock &) {
 524     vector<string> m;
 525     cfg->get_view(vid_commit, m);
 526     for (unsigned i  = 0; i < m.size(); i++) {
 527         if (m[i] != cfg->myaddr()) {
 528             handle h(m[i]);
 529             LOG("member " << m[i] << " " << heal);
 530             if (h.safebind()) h.safebind()->set_reachable(heal);
 531         }
 532     }
 533     rsmrpc->set_reachable(heal);
 534 }
 535
 536 rsm_test_protocol::status rsm::test_net_repairreq(rsm_test_protocol::status &r, int heal) {
 537     lock ml(rsm_mutex);
 538     LOG("heal " << heal << " (dopartition " <<
 539             dopartition << ", partitioned " << partitioned << ")");
 540     if (heal) {
 541         net_repair(heal, ml);
 542         partitioned = false;
 543     } else {
 544         dopartition = true;
 545         partitioned = false;
 546     }
 547     r = rsm_test_protocol::OK;
 548     return r;
 549 }
 550
 551 // simulate failure at breakpoint 1 and 2
 552
 553 void rsm::breakpoint1() {
 554     if (break1) {
 555         LOG("Dying at breakpoint 1 in rsm!");
 556         exit(1);
 557     }
 558 }
 559
 560 void rsm::breakpoint2() {
 561     if (break2) {
 562         LOG("Dying at breakpoint 2 in rsm!");
 563         exit(1);
 564     }
 565 }
 566
 567 void rsm::partition1(lock & rsm_mutex_lock) {
 568     if (dopartition) {
 569         net_repair(false, rsm_mutex_lock);
 570         dopartition = false;
 571         partitioned = true;
 572     }
 573 }
 574
 575 rsm_test_protocol::status rsm::breakpointreq(rsm_test_protocol::status &r, int b) {
 576     r = rsm_test_protocol::OK;
 577     lock ml(rsm_mutex);
 578     LOG("breakpoint " << b);
 579     if (b == 1) break1 = true;
 580     else if (b == 2) break2 = true;
 581     else if (b == 3 || b == 4) cfg->breakpoint(b);
 582     else r = rsm_test_protocol::ERR;
 583     return r;
 584 }