File size: 68,541 Bytes
f4a7cbe |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 |
(*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*)
-------------------------------- MODULE Zab ---------------------------------
(* This is the formal specification for the Zab consensus algorithm,
in DSN'2011, which represents protocol specification in our work.*)
EXTENDS Integers, FiniteSets, Sequences, Naturals, TLC
-----------------------------------------------------------------------------
\* The set of servers
CONSTANT Server
\* States of server
CONSTANTS LOOKING, FOLLOWING, LEADING
\* Zab states of server
CONSTANTS ELECTION, DISCOVERY, SYNCHRONIZATION, BROADCAST
\* Message types
CONSTANTS CEPOCH, NEWEPOCH, ACKEPOCH, NEWLEADER, ACKLD, COMMITLD, PROPOSE, ACK, COMMIT
\* [MaxTimeoutFailures, MaxTransactionNum, MaxEpoch, MaxRestarts]
CONSTANT Parameters
MAXEPOCH == 10
NullPoint == CHOOSE p: p \notin Server
Quorums == {Q \in SUBSET Server: Cardinality(Q)*2 > Cardinality(Server)}
-----------------------------------------------------------------------------
\* Variables that all servers use.
VARIABLES state, \* State of server, in {LOOKING, FOLLOWING, LEADING}.
zabState, \* Current phase of server, in
\* {ELECTION, DISCOVERY, SYNCHRONIZATION, BROADCAST}.
acceptedEpoch, \* Epoch of the last LEADERINFO packet accepted,
\* namely f.p in paper.
currentEpoch, \* Epoch of the last NEWLEADER packet accepted,
\* namely f.a in paper.
history, \* History of servers: sequence of transactions,
\* containing: [zxid, value, ackSid, epoch].
lastCommitted \* Maximum index and zxid known to be committed,
\* namely 'lastCommitted' in Leader. Starts from 0,
\* and increases monotonically before restarting.
\* Variables only used for leader.
VARIABLES learners, \* Set of servers leader connects.
cepochRecv, \* Set of learners leader has received CEPOCH from.
\* Set of record [sid, connected, epoch],
\* where epoch means f.p from followers.
ackeRecv, \* Set of learners leader has received ACKEPOCH from.
\* Set of record
\* [sid, connected, peerLastEpoch, peerHistory],
\* to record f.a and h(f) from followers.
ackldRecv, \* Set of learners leader has received ACKLD from.
\* Set of record [sid, connected].
sendCounter \* Count of txns leader has broadcast.
\* Variables only used for follower.
VARIABLES connectInfo \* If follower has connected with leader.
\* If follower lost connection, then null.
\* Variable representing oracle of leader.
VARIABLE leaderOracle \* Current oracle.
\* Variables about network channel.
VARIABLE msgs \* Simulates network channel.
\* msgs[i][j] means the input buffer of server j
\* from server i.
\* Variables only used in verifying properties.
VARIABLES epochLeader, \* Set of leaders in every epoch.
proposalMsgsLog, \* Set of all broadcast messages.
violatedInvariants \* Check whether there are conditions
\* contrary to the facts.
\* Variable used for recording critical data,
\* to constrain state space or update values.
VARIABLE recorder \* Consists: members of Parameters and pc, values.
\* Form is record:
\* [pc, nTransaction, maxEpoch, nTimeout, nRestart, nClientRequest]
serverVars == <<state, zabState, acceptedEpoch, currentEpoch,
history, lastCommitted>>
leaderVars == <<learners, cepochRecv, ackeRecv, ackldRecv,
sendCounter>>
followerVars == connectInfo
electionVars == leaderOracle
msgVars == msgs
verifyVars == <<proposalMsgsLog, epochLeader, violatedInvariants>>
vars == <<serverVars, leaderVars, followerVars, electionVars,
msgVars, verifyVars, recorder>>
-----------------------------------------------------------------------------
\* Return the maximum value from the set S
Maximum(S) == IF S = {} THEN -1
ELSE CHOOSE n \in S: \A m \in S: n >= m
\* Return the minimum value from the set S
Minimum(S) == IF S = {} THEN -1
ELSE CHOOSE n \in S: \A m \in S: n <= m
\* Check server state
IsLeader(s) == state[s] = LEADING
IsFollower(s) == state[s] = FOLLOWING
IsLooking(s) == state[s] = LOOKING
\* Check if s is a quorum
IsQuorum(s) == s \in Quorums
IsMyLearner(i, j) == j \in learners[i]
IsMyLeader(i, j) == connectInfo[i] = j
HasNoLeader(i) == connectInfo[i] = NullPoint
HasLeader(i) == connectInfo[i] /= NullPoint
-----------------------------------------------------------------------------
\* FALSE: zxid1 <= zxid2; TRUE: zxid1 > zxid2
ZxidCompare(zxid1, zxid2) == \/ zxid1[1] > zxid2[1]
\/ /\ zxid1[1] = zxid2[1]
/\ zxid1[2] > zxid2[2]
ZxidEqual(zxid1, zxid2) == zxid1[1] = zxid2[1] /\ zxid1[2] = zxid2[2]
TxnZxidEqual(txn, z) == txn.zxid[1] = z[1] /\ txn.zxid[2] = z[2]
TxnEqual(txn1, txn2) == /\ ZxidEqual(txn1.zxid, txn2.zxid)
/\ txn1.value = txn2.value
EpochPrecedeInTxn(txn1, txn2) == txn1.zxid[1] < txn2.zxid[1]
-----------------------------------------------------------------------------
\* Actions about recorder
GetParameter(p) == IF p \in DOMAIN Parameters THEN Parameters[p] ELSE 0
GetRecorder(p) == IF p \in DOMAIN recorder THEN recorder[p] ELSE 0
RecorderGetHelper(m) == (m :> recorder[m])
RecorderIncHelper(m) == (m :> recorder[m] + 1)
RecorderIncTimeout == RecorderIncHelper("nTimeout")
RecorderGetTimeout == RecorderGetHelper("nTimeout")
RecorderIncRestart == RecorderIncHelper("nRestart")
RecorderGetRestart == RecorderGetHelper("nRestart")
RecorderSetTransactionNum(pc) == ("nTransaction" :>
IF pc[1] = "LeaderProcessRequest" THEN
LET s == CHOOSE i \in Server:
\A j \in Server: Len(history'[i]) >= Len(history'[j])
IN Len(history'[s])
ELSE recorder["nTransaction"])
RecorderSetMaxEpoch(pc) == ("maxEpoch" :>
IF pc[1] = "LeaderProcessCEPOCH" THEN
LET s == CHOOSE i \in Server:
\A j \in Server: acceptedEpoch'[i] >= acceptedEpoch'[j]
IN acceptedEpoch'[s]
ELSE recorder["maxEpoch"])
RecorderSetRequests(pc) == ("nClientRequest" :>
IF pc[1] = "LeaderProcessRequest" THEN
recorder["nClientRequest"] + 1
ELSE recorder["nClientRequest"] )
RecorderSetPc(pc) == ("pc" :> pc)
RecorderSetFailure(pc) == CASE pc[1] = "Timeout" -> RecorderIncTimeout @@ RecorderGetRestart
[] pc[1] = "LeaderTimeout" -> RecorderIncTimeout @@ RecorderGetRestart
[] pc[1] = "FollowerTimeout" -> RecorderIncTimeout @@ RecorderGetRestart
[] pc[1] = "Restart" -> RecorderIncTimeout @@ RecorderIncRestart
[] OTHER -> RecorderGetTimeout @@ RecorderGetRestart
UpdateRecorder(pc) == recorder' = RecorderSetFailure(pc) @@ RecorderSetTransactionNum(pc)
@@ RecorderSetMaxEpoch(pc) @@ RecorderSetPc(pc)
@@ RecorderSetRequests(pc) @@ recorder
UnchangeRecorder == UNCHANGED recorder
CheckParameterHelper(n, p, Comp(_,_)) == IF p \in DOMAIN Parameters
THEN Comp(n, Parameters[p])
ELSE TRUE
CheckParameterLimit(n, p) == CheckParameterHelper(n, p, LAMBDA i, j: i < j)
CheckTimeout == CheckParameterLimit(recorder.nTimeout, "MaxTimeoutFailures")
CheckTransactionNum == CheckParameterLimit(recorder.nTransaction, "MaxTransactionNum")
CheckEpoch == CheckParameterLimit(recorder.maxEpoch, "MaxEpoch")
CheckRestart == /\ CheckTimeout
/\ CheckParameterLimit(recorder.nRestart, "MaxRestarts")
CheckStateConstraints == CheckTimeout /\ CheckTransactionNum /\ CheckEpoch /\ CheckRestart
-----------------------------------------------------------------------------
\* Actions about network
PendingCEPOCH(i, j) == /\ msgs[j][i] /= << >>
/\ msgs[j][i][1].mtype = CEPOCH
PendingNEWEPOCH(i, j) == /\ msgs[j][i] /= << >>
/\ msgs[j][i][1].mtype = NEWEPOCH
PendingACKEPOCH(i, j) == /\ msgs[j][i] /= << >>
/\ msgs[j][i][1].mtype = ACKEPOCH
PendingNEWLEADER(i, j) == /\ msgs[j][i] /= << >>
/\ msgs[j][i][1].mtype = NEWLEADER
PendingACKLD(i, j) == /\ msgs[j][i] /= << >>
/\ msgs[j][i][1].mtype = ACKLD
PendingCOMMITLD(i, j) == /\ msgs[j][i] /= << >>
/\ msgs[j][i][1].mtype = COMMITLD
PendingPROPOSE(i, j) == /\ msgs[j][i] /= << >>
/\ msgs[j][i][1].mtype = PROPOSE
PendingACK(i, j) == /\ msgs[j][i] /= << >>
/\ msgs[j][i][1].mtype = ACK
PendingCOMMIT(i, j) == /\ msgs[j][i] /= << >>
/\ msgs[j][i][1].mtype = COMMIT
\* Add a message to msgs - add a message m to msgs.
Send(i, j, m) == msgs' = [msgs EXCEPT ![i][j] = Append(msgs[i][j], m)]
\* Remove a message from msgs - discard head of msgs.
Discard(i, j) == msgs' = IF msgs[i][j] /= << >> THEN [msgs EXCEPT ![i][j] = Tail(msgs[i][j])]
ELSE msgs
\* Combination of Send and Discard - discard head of msgs[j][i] and add m into msgs.
Reply(i, j, m) == msgs' = [msgs EXCEPT ![j][i] = Tail(msgs[j][i]),
![i][j] = Append(msgs[i][j], m)]
\* Shuffle input buffer.
Clean(i, j) == msgs' = [msgs EXCEPT ![j][i] = << >>, ![i][j] = << >>]
CleanInputBuffer(S) == msgs' = [s \in Server |->
[v \in Server |-> IF v \in S THEN << >>
ELSE msgs[s][v] ] ]
\* Leader broadcasts a message PROPOSE to all other servers in Q.
\* Note: In paper, Q is fuzzy. We think servers who leader broadcasts NEWLEADER to
\* should receive every PROPOSE. So we consider ackeRecv as Q.
\* Since we let ackeRecv = Q, there may exist some follower receiving COMMIT before
\* COMMITLD, and zxid in COMMIT later than zxid in COMMITLD. To avoid this situation,
\* if f \in ackeRecv but \notin ackldRecv, f should not receive COMMIT until
\* f \in ackldRecv and receives COMMITLD.
Broadcast(i, m) ==
LET ackeRecv_quorum == {a \in ackeRecv[i]: a.connected = TRUE }
sid_ackeRecv == { a.sid: a \in ackeRecv_quorum }
IN msgs' = [msgs EXCEPT ![i] = [v \in Server |-> IF /\ v \in sid_ackeRecv
/\ v \in learners[i]
/\ v /= i
THEN Append(msgs[i][v], m)
ELSE msgs[i][v] ] ]
\* Since leader decides to broadcasts message COMMIT when processing ACK, so
\* we need to discard ACK and broadcast COMMIT.
\* Here Q is ackldRecv, because we assume that f should not receive COMMIT until
\* f receives COMMITLD.
DiscardAndBroadcast(i, j, m) ==
LET ackldRecv_quorum == {a \in ackldRecv[i]: a.connected = TRUE }
sid_ackldRecv == { a.sid: a \in ackldRecv_quorum }
IN msgs' = [msgs EXCEPT ![j][i] = Tail(msgs[j][i]),
![i] = [v \in Server |-> IF /\ v \in sid_ackldRecv
/\ v \in learners[i]
/\ v /= i
THEN Append(msgs[i][v], m)
ELSE msgs[i][v] ] ]
\* Leader broadcasts LEADERINFO to all other servers in cepochRecv.
DiscardAndBroadcastNEWEPOCH(i, j, m) ==
LET new_cepochRecv_quorum == {c \in cepochRecv'[i]: c.connected = TRUE }
new_sid_cepochRecv == { c.sid: c \in new_cepochRecv_quorum }
IN msgs' = [msgs EXCEPT ![j][i] = Tail(msgs[j][i]),
![i] = [v \in Server |-> IF /\ v \in new_sid_cepochRecv
/\ v \in learners[i]
/\ v /= i
THEN Append(msgs[i][v], m)
ELSE msgs[i][v] ] ]
\* Leader broadcasts NEWLEADER to all other servers in ackeRecv.
DiscardAndBroadcastNEWLEADER(i, j, m) ==
LET new_ackeRecv_quorum == {a \in ackeRecv'[i]: a.connected = TRUE }
new_sid_ackeRecv == { a.sid: a \in new_ackeRecv_quorum }
IN msgs' = [msgs EXCEPT ![j][i] = Tail(msgs[j][i]),
![i] = [v \in Server |-> IF /\ v \in new_sid_ackeRecv
/\ v \in learners[i]
/\ v /= i
THEN Append(msgs[i][v], m)
ELSE msgs[i][v] ] ]
\* Leader broadcasts COMMITLD to all other servers in ackldRecv.
DiscardAndBroadcastCOMMITLD(i, j, m) ==
LET new_ackldRecv_quorum == {a \in ackldRecv'[i]: a.connected = TRUE }
new_sid_ackldRecv == { a.sid: a \in new_ackldRecv_quorum }
IN msgs' = [msgs EXCEPT ![j][i] = Tail(msgs[j][i]),
![i] = [v \in Server |-> IF /\ v \in new_sid_ackldRecv
/\ v \in learners[i]
/\ v /= i
THEN Append(msgs[i][v], m)
ELSE msgs[i][v] ] ]
-----------------------------------------------------------------------------
\* Define initial values for all variables
InitServerVars == /\ state = [s \in Server |-> LOOKING]
/\ zabState = [s \in Server |-> ELECTION]
/\ acceptedEpoch = [s \in Server |-> 0]
/\ currentEpoch = [s \in Server |-> 0]
/\ history = [s \in Server |-> << >>]
/\ lastCommitted = [s \in Server |-> [ index |-> 0,
zxid |-> <<0, 0>> ] ]
InitLeaderVars == /\ learners = [s \in Server |-> {}]
/\ cepochRecv = [s \in Server |-> {}]
/\ ackeRecv = [s \in Server |-> {}]
/\ ackldRecv = [s \in Server |-> {}]
/\ sendCounter = [s \in Server |-> 0]
InitFollowerVars == connectInfo = [s \in Server |-> NullPoint]
InitElectionVars == leaderOracle = NullPoint
InitMsgVars == msgs = [s \in Server |-> [v \in Server |-> << >>] ]
InitVerifyVars == /\ proposalMsgsLog = {}
/\ epochLeader = [i \in 1..MAXEPOCH |-> {} ]
/\ violatedInvariants = [stateInconsistent |-> FALSE,
proposalInconsistent |-> FALSE,
commitInconsistent |-> FALSE,
ackInconsistent |-> FALSE,
messageIllegal |-> FALSE ]
InitRecorder == recorder = [nTimeout |-> 0,
nTransaction |-> 0,
maxEpoch |-> 0,
nRestart |-> 0,
pc |-> <<"Init">>,
nClientRequest |-> 0]
Init == /\ InitServerVars
/\ InitLeaderVars
/\ InitFollowerVars
/\ InitElectionVars
/\ InitVerifyVars
/\ InitMsgVars
/\ InitRecorder
-----------------------------------------------------------------------------
\* Utils in state switching
FollowerShutdown(i) ==
/\ state' = [state EXCEPT ![i] = LOOKING]
/\ zabState' = [zabState EXCEPT ![i] = ELECTION]
/\ connectInfo' = [connectInfo EXCEPT ![i] = NullPoint]
LeaderShutdown(i) ==
/\ LET S == learners[i]
IN /\ state' = [s \in Server |-> IF s \in S THEN LOOKING ELSE state[s] ]
/\ zabState' = [s \in Server |-> IF s \in S THEN ELECTION ELSE zabState[s] ]
/\ connectInfo' = [s \in Server |-> IF s \in S THEN NullPoint ELSE connectInfo[s] ]
/\ CleanInputBuffer(S)
/\ learners' = [learners EXCEPT ![i] = {}]
SwitchToFollower(i) ==
/\ state' = [state EXCEPT ![i] = FOLLOWING]
/\ zabState' = [zabState EXCEPT ![i] = DISCOVERY]
SwitchToLeader(i) ==
/\ state' = [state EXCEPT ![i] = LEADING]
/\ zabState' = [zabState EXCEPT ![i] = DISCOVERY]
/\ learners' = [learners EXCEPT ![i] = {i}]
/\ cepochRecv' = [cepochRecv EXCEPT ![i] = { [ sid |-> i,
connected |-> TRUE,
epoch |-> acceptedEpoch[i] ] }]
/\ ackeRecv' = [ackeRecv EXCEPT ![i] = { [ sid |-> i,
connected |-> TRUE,
peerLastEpoch |-> currentEpoch[i],
peerHistory |-> history[i] ] }]
/\ ackldRecv' = [ackldRecv EXCEPT ![i] = { [ sid |-> i,
connected |-> TRUE ] }]
/\ sendCounter' = [sendCounter EXCEPT ![i] = 0]
RemoveCepochRecv(set, sid) ==
LET sid_cepochRecv == {s.sid: s \in set}
IN IF sid \notin sid_cepochRecv THEN set
ELSE LET info == CHOOSE s \in set: s.sid = sid
new_info == [ sid |-> sid,
connected |-> FALSE,
epoch |-> info.epoch ]
IN (set \ {info}) \union {new_info}
RemoveAckeRecv(set, sid) ==
LET sid_ackeRecv == {s.sid: s \in set}
IN IF sid \notin sid_ackeRecv THEN set
ELSE LET info == CHOOSE s \in set: s.sid = sid
new_info == [ sid |-> sid,
connected |-> FALSE,
peerLastEpoch |-> info.peerLastEpoch,
peerHistory |-> info.peerHistory ]
IN (set \ {info}) \union {new_info}
RemoveAckldRecv(set, sid) ==
LET sid_ackldRecv == {s.sid: s \in set}
IN IF sid \notin sid_ackldRecv THEN set
ELSE LET info == CHOOSE s \in set: s.sid = sid
new_info == [ sid |-> sid,
connected |-> FALSE ]
IN (set \ {info}) \union {new_info}
RemoveLearner(i, j) ==
/\ learners' = [learners EXCEPT ![i] = @ \ {j}]
/\ cepochRecv' = [cepochRecv EXCEPT ![i] = RemoveCepochRecv(@, j) ]
/\ ackeRecv' = [ackeRecv EXCEPT ![i] = RemoveAckeRecv(@, j) ]
/\ ackldRecv' = [ackldRecv EXCEPT ![i] = RemoveAckldRecv(@, j) ]
-----------------------------------------------------------------------------
\* Actions of election
UpdateLeader(i) ==
/\ IsLooking(i)
/\ leaderOracle /= i
/\ leaderOracle' = i
/\ SwitchToLeader(i)
/\ UNCHANGED <<acceptedEpoch, currentEpoch, history, lastCommitted,
followerVars, verifyVars, msgVars>>
/\ UpdateRecorder(<<"UpdateLeader", i>>)
FollowLeader(i) ==
/\ IsLooking(i)
/\ leaderOracle /= NullPoint
/\ \/ /\ leaderOracle = i
/\ SwitchToLeader(i)
\/ /\ leaderOracle /= i
/\ SwitchToFollower(i)
/\ UNCHANGED leaderVars
/\ UNCHANGED <<acceptedEpoch, currentEpoch, history, lastCommitted,
electionVars, followerVars, verifyVars, msgVars>>
/\ UpdateRecorder(<<"FollowLeader", i>>)
-----------------------------------------------------------------------------
(* Actions of situation error. Situation error in protocol spec is different
from latter specs. This is for compressing state space, we focus on results
from external events (e.g. network partition, node failure, etc.), so we do
not need to add variables and actions about network conditions and node
conditions. It is reasonable that we have action 'Restart' but no 'Crash',
because when a node does not execute any internal events after restarting,
this is equivalent to executing a crash.
*)
\* Timeout between leader and follower.
Timeout(i, j) ==
/\ CheckTimeout \* test restrictions of timeout
/\ IsLeader(i) /\ IsMyLearner(i, j)
/\ IsFollower(j) /\ IsMyLeader(j, i)
/\ LET newLearners == learners[i] \ {j}
IN \/ /\ IsQuorum(newLearners) \* just remove this learner
/\ RemoveLearner(i, j)
/\ FollowerShutdown(j)
/\ Clean(i, j)
\/ /\ ~IsQuorum(newLearners) \* leader switches to looking
/\ LeaderShutdown(i)
/\ UNCHANGED <<cepochRecv, ackeRecv, ackldRecv>>
/\ UNCHANGED <<acceptedEpoch, currentEpoch, history, lastCommitted,
sendCounter, electionVars, verifyVars>>
/\ UpdateRecorder(<<"Timeout", i, j>>)
Restart(i) ==
/\ CheckRestart \* test restrictions of restart
/\ \/ /\ IsLooking(i)
/\ UNCHANGED <<state, zabState, learners, followerVars, msgVars,
cepochRecv, ackeRecv, ackldRecv>>
\/ /\ IsFollower(i)
/\ LET connectedWithLeader == HasLeader(i)
IN \/ /\ connectedWithLeader
/\ LET leader == connectInfo[i]
newLearners == learners[leader] \ {i}
IN
\/ /\ IsQuorum(newLearners) \* leader remove learner i
/\ RemoveLearner(leader, i)
/\ FollowerShutdown(i)
/\ Clean(leader, i)
\/ /\ ~IsQuorum(newLearners) \* leader switches to looking
/\ LeaderShutdown(leader)
/\ UNCHANGED <<cepochRecv, ackeRecv, ackldRecv>>
\/ /\ ~connectedWithLeader
/\ FollowerShutdown(i)
/\ CleanInputBuffer({i})
/\ UNCHANGED <<learners, cepochRecv, ackeRecv, ackldRecv>>
\/ /\ IsLeader(i)
/\ LeaderShutdown(i)
/\ UNCHANGED <<cepochRecv, ackeRecv, ackldRecv>>
/\ lastCommitted' = [lastCommitted EXCEPT ![i] = [ index |-> 0,
zxid |-> <<0, 0>> ] ]
/\ UNCHANGED <<acceptedEpoch, currentEpoch, history,
sendCounter, leaderOracle, verifyVars>>
/\ UpdateRecorder(<<"Restart", i>>)
-----------------------------------------------------------------------------
(* Establish connection between leader and follower. *)
ConnectAndFollowerSendCEPOCH(i, j) ==
/\ IsLeader(i) /\ \lnot IsMyLearner(i, j)
/\ IsFollower(j) /\ HasNoLeader(j) /\ leaderOracle = i
/\ learners' = [learners EXCEPT ![i] = @ \union {j}]
/\ connectInfo' = [connectInfo EXCEPT ![j] = i]
/\ Send(j, i, [ mtype |-> CEPOCH,
mepoch |-> acceptedEpoch[j] ]) \* contains f.p
/\ UNCHANGED <<serverVars, electionVars, verifyVars, cepochRecv,
ackeRecv, ackldRecv, sendCounter>>
/\ UpdateRecorder(<<"ConnectAndFollowerSendCEPOCH", i, j>>)
CepochRecvQuorumFormed(i) == LET sid_cepochRecv == {c.sid: c \in cepochRecv[i]}
IN IsQuorum(sid_cepochRecv)
CepochRecvBecomeQuorum(i) == LET sid_cepochRecv == {c.sid: c \in cepochRecv'[i]}
IN IsQuorum(sid_cepochRecv)
UpdateCepochRecv(oldSet, sid, peerEpoch) ==
LET sid_set == {s.sid: s \in oldSet}
IN IF sid \in sid_set
THEN LET old_info == CHOOSE info \in oldSet: info.sid = sid
new_info == [ sid |-> sid,
connected |-> TRUE,
epoch |-> peerEpoch ]
IN ( oldSet \ {old_info} ) \union {new_info}
ELSE LET follower_info == [ sid |-> sid,
connected |-> TRUE,
epoch |-> peerEpoch ]
IN oldSet \union {follower_info}
\* Determine new e' in this round from a quorum of CEPOCH.
DetermineNewEpoch(i) ==
LET epoch_cepochRecv == {c.epoch: c \in cepochRecv'[i]}
IN Maximum(epoch_cepochRecv) + 1
(* Leader waits for receiving FOLLOWERINFO from a quorum including itself,
and chooses a new epoch e' as its own epoch and broadcasts NEWEPOCH. *)
LeaderProcessCEPOCH(i, j) ==
/\ CheckEpoch \* test restrictions of max epoch
/\ IsLeader(i)
/\ PendingCEPOCH(i, j)
/\ LET msg == msgs[j][i][1]
infoOk == IsMyLearner(i, j)
IN /\ infoOk
/\ \/ \* 1. has not broadcast NEWEPOCH
/\ ~CepochRecvQuorumFormed(i)
/\ \/ /\ zabState[i] = DISCOVERY
/\ UNCHANGED violatedInvariants
\/ /\ zabState[i] /= DISCOVERY
/\ PrintT("Exception: CepochRecvQuorumFormed false," \o
" while zabState not DISCOVERY.")
/\ violatedInvariants' = [violatedInvariants
EXCEPT !.stateInconsistent = TRUE]
/\ cepochRecv' = [cepochRecv EXCEPT ![i] = UpdateCepochRecv(@, j, msg.mepoch) ]
/\ \/ \* 1.1. cepochRecv becomes quorum,
\* then determine e' and broadcasts NEWEPOCH in Q.
/\ CepochRecvBecomeQuorum(i)
/\ acceptedEpoch' = [acceptedEpoch EXCEPT ![i] = DetermineNewEpoch(i)]
/\ LET m == [ mtype |-> NEWEPOCH,
mepoch |-> acceptedEpoch'[i] ]
IN DiscardAndBroadcastNEWEPOCH(i, j, m)
\/ \* 1.2. cepochRecv still not quorum.
/\ ~CepochRecvBecomeQuorum(i)
/\ Discard(j, i)
/\ UNCHANGED acceptedEpoch
\/ \* 2. has broadcast NEWEPOCH
/\ CepochRecvQuorumFormed(i)
/\ cepochRecv' = [cepochRecv EXCEPT ![i] = UpdateCepochRecv(@, j, msg.mepoch) ]
/\ Reply(i, j, [ mtype |-> NEWEPOCH,
mepoch |-> acceptedEpoch[i] ])
/\ UNCHANGED <<violatedInvariants, acceptedEpoch>>
/\ UNCHANGED <<state, zabState, currentEpoch, history, lastCommitted, learners,
ackeRecv, ackldRecv, sendCounter, followerVars,
electionVars, proposalMsgsLog, epochLeader>>
/\ UpdateRecorder(<<"LeaderProcessCEPOCH", i, j>>)
(* Follower receives LEADERINFO. If newEpoch >= acceptedEpoch, then follower
updates acceptedEpoch and sends ACKEPOCH back, containing currentEpoch and
history. After this, zabState turns to SYNC. *)
FollowerProcessNEWEPOCH(i, j) ==
/\ IsFollower(i)
/\ PendingNEWEPOCH(i, j)
/\ LET msg == msgs[j][i][1]
infoOk == IsMyLeader(i, j)
stateOk == zabState[i] = DISCOVERY
epochOk == msg.mepoch >= acceptedEpoch[i]
IN /\ infoOk
/\ \/ \* 1. Normal case
/\ epochOk
/\ \/ /\ stateOk
/\ acceptedEpoch' = [acceptedEpoch EXCEPT ![i] = msg.mepoch]
/\ LET m == [ mtype |-> ACKEPOCH,
mepoch |-> currentEpoch[i],
mhistory |-> history[i] ]
IN Reply(i, j, m)
/\ zabState' = [zabState EXCEPT ![i] = SYNCHRONIZATION]
/\ UNCHANGED violatedInvariants
\/ /\ ~stateOk
/\ PrintT("Exception: Follower receives NEWEPOCH," \o
" whileZabState not DISCOVERY.")
/\ violatedInvariants' = [violatedInvariants
EXCEPT !.stateInconsistent = TRUE]
/\ Discard(j, i)
/\ UNCHANGED <<acceptedEpoch, zabState>>
/\ UNCHANGED <<followerVars, learners, cepochRecv, ackeRecv,
ackldRecv, state>>
\/ \* 2. Abnormal case - go back to election
/\ ~epochOk
/\ FollowerShutdown(i)
/\ LET leader == connectInfo[i]
IN /\ Clean(i, leader)
/\ RemoveLearner(leader, i)
/\ UNCHANGED <<acceptedEpoch, violatedInvariants>>
/\ UNCHANGED <<currentEpoch, history, lastCommitted, sendCounter,
electionVars, proposalMsgsLog, epochLeader>>
/\ UpdateRecorder(<<"FollowerProcessNEWEPOCH", i, j>>)
AckeRecvQuorumFormed(i) == LET sid_ackeRecv == {a.sid: a \in ackeRecv[i]}
IN IsQuorum(sid_ackeRecv)
AckeRecvBecomeQuorum(i) == LET sid_ackeRecv == {a.sid: a \in ackeRecv'[i]}
IN IsQuorum(sid_ackeRecv)
UpdateAckeRecv(oldSet, sid, peerEpoch, peerHistory) ==
LET sid_set == {s.sid: s \in oldSet}
follower_info == [ sid |-> sid,
connected |-> TRUE,
peerLastEpoch |-> peerEpoch,
peerHistory |-> peerHistory ]
IN IF sid \in sid_set
THEN LET old_info == CHOOSE info \in oldSet: info.sid = sid
IN (oldSet \ {old_info}) \union {follower_info}
ELSE oldSet \union {follower_info}
\* for checking invariants
RECURSIVE SetPacketsForChecking(_,_,_,_,_,_)
SetPacketsForChecking(set, src, ep, his, cur, end) ==
IF cur > end THEN set
ELSE LET m_proposal == [ source |-> src,
epoch |-> ep,
zxid |-> his[cur].zxid,
data |-> his[cur].value ]
IN SetPacketsForChecking((set \union {m_proposal}), src, ep, his, cur + 1, end)
LastZxidOfHistory(his) == IF Len(his) = 0 THEN <<0, 0>>
ELSE his[Len(his)].zxid
\* TRUE: f1.a > f2.a or (f1.a = fa.a and f1.zxid >= f2.zxid)
MoreResentOrEqual(ss1, ss2) == \/ ss1.currentEpoch > ss2.currentEpoch
\/ /\ ss1.currentEpoch = ss2.currentEpoch
/\ ~ZxidCompare(ss2.lastZxid, ss1.lastZxid)
\* Determine initial history Ie' in this round from a quorum of ACKEPOCH.
DetermineInitialHistory(i) ==
LET set == ackeRecv'[i]
ss_set == { [ sid |-> a.sid,
currentEpoch |-> a.peerLastEpoch,
lastZxid |-> LastZxidOfHistory(a.peerHistory) ]
: a \in set }
selected == CHOOSE ss \in ss_set:
\A ss1 \in (ss_set \ {ss}): MoreResentOrEqual(ss, ss1)
info == CHOOSE f \in set: f.sid = selected.sid
IN info.peerHistory
RECURSIVE InitAcksidHelper(_,_)
InitAcksidHelper(txns, src) == IF Len(txns) = 0 THEN << >>
ELSE LET oldTxn == txns[1]
newTxn == [ zxid |-> oldTxn.zxid,
value |-> oldTxn.value,
ackSid |-> {src},
epoch |-> oldTxn.epoch ]
IN <<newTxn>> \o InitAcksidHelper( Tail(txns), src)
\* Atomically let all txns in initial history contain self's acks.
InitAcksid(i, his) == InitAcksidHelper(his, i)
(* Leader waits for receiving ACKEPOPCH from a quorum, and determines initialHistory
according to history of whom has most recent state summary from them. After this,
leader's zabState turns to SYNCHRONIZATION. *)
LeaderProcessACKEPOCH(i, j) ==
/\ IsLeader(i)
/\ PendingACKEPOCH(i, j)
/\ LET msg == msgs[j][i][1]
infoOk == IsMyLearner(i, j)
IN /\ infoOk
/\ \/ \* 1. has broadcast NEWLEADER
/\ AckeRecvQuorumFormed(i)
/\ ackeRecv' = [ackeRecv EXCEPT ![i] = UpdateAckeRecv(@, j,
msg.mepoch, msg.mhistory) ]
/\ LET toSend == history[i] \* contains (Ie', Be')
m == [ mtype |-> NEWLEADER,
mepoch |-> acceptedEpoch[i],
mhistory |-> toSend ]
set_forChecking == SetPacketsForChecking({ }, i,
acceptedEpoch[i], toSend, 1, Len(toSend))
IN
/\ Reply(i, j, m)
/\ proposalMsgsLog' = proposalMsgsLog \union set_forChecking
/\ UNCHANGED <<violatedInvariants, currentEpoch, history,
zabState, epochLeader>>
\/ \* 2. has not broadcast NEWLEADER
/\ ~AckeRecvQuorumFormed(i)
/\ \/ /\ zabState[i] = DISCOVERY
/\ UNCHANGED violatedInvariants
\/ /\ zabState[i] /= DISCOVERY
/\ PrintT("Exception: AckeRecvQuorumFormed false," \o
" while zabState not DISCOVERY.")
/\ violatedInvariants' = [violatedInvariants EXCEPT
!.stateInconsistent = TRUE]
/\ ackeRecv' = [ackeRecv EXCEPT ![i] = UpdateAckeRecv(@, j,
msg.mepoch, msg.mhistory) ]
/\ \/ \* 2.1. ackeRecv becomes quorum, determine Ie'
\* and broadcasts NEWLEADER in Q. (l.1.2 + l.2.1)
/\ AckeRecvBecomeQuorum(i)
/\ \* Update f.a
LET newLeaderEpoch == acceptedEpoch[i] IN
/\ currentEpoch' = [currentEpoch EXCEPT ![i] = newLeaderEpoch]
/\ epochLeader' = [epochLeader EXCEPT ![newLeaderEpoch]
= @ \union {i} ] \* for checking invariants
/\ \* Determine initial history Ie'
LET initialHistory == DetermineInitialHistory(i) IN
history' = [history EXCEPT ![i] = InitAcksid(i, initialHistory) ]
/\ \* Update zabState
zabState' = [zabState EXCEPT ![i] = SYNCHRONIZATION]
/\ \* Broadcast NEWLEADER with (e', Ie')
LET toSend == history'[i]
m == [ mtype |-> NEWLEADER,
mepoch |-> acceptedEpoch[i],
mhistory |-> toSend ]
set_forChecking == SetPacketsForChecking({ }, i,
acceptedEpoch[i], toSend, 1, Len(toSend))
IN
/\ DiscardAndBroadcastNEWLEADER(i, j, m)
/\ proposalMsgsLog' = proposalMsgsLog \union set_forChecking
\/ \* 2.2. ackeRecv still not quorum.
/\ ~AckeRecvBecomeQuorum(i)
/\ Discard(j, i)
/\ UNCHANGED <<currentEpoch, history, zabState,
proposalMsgsLog, epochLeader>>
/\ UNCHANGED <<state, acceptedEpoch, lastCommitted, learners, cepochRecv, ackldRecv,
sendCounter, followerVars, electionVars>>
/\ UpdateRecorder(<<"LeaderProcessACKEPOCH", i, j>>)
-----------------------------------------------------------------------------
(* Follower receives NEWLEADER. Update f.a and history. *)
FollowerProcessNEWLEADER(i, j) ==
/\ IsFollower(i)
/\ PendingNEWLEADER(i, j)
/\ LET msg == msgs[j][i][1]
infoOk == IsMyLeader(i, j)
epochOk == acceptedEpoch[i] = msg.mepoch
stateOk == zabState[i] = SYNCHRONIZATION
IN /\ infoOk
/\ \/ \* 1. f.p not equals e', starts a new iteration.
/\ ~epochOk
/\ FollowerShutdown(i)
/\ LET leader == connectInfo[i]
IN /\ Clean(i, leader)
/\ RemoveLearner(leader, i)
/\ UNCHANGED <<violatedInvariants, currentEpoch, history>>
\/ \* 2. f.p equals e'.
/\ epochOk
/\ \/ /\ stateOk
/\ UNCHANGED violatedInvariants
\/ /\ ~stateOk
/\ PrintT("Exception: Follower receives NEWLEADER," \o
" whileZabState not SYNCHRONIZATION.")
/\ violatedInvariants' = [violatedInvariants
EXCEPT !.stateInconsistent = TRUE]
/\ currentEpoch' = [currentEpoch EXCEPT ![i] = acceptedEpoch[i]]
/\ history' = [history EXCEPT ![i] = msg.mhistory] \* no need to care ackSid
/\ LET m == [ mtype |-> ACKLD,
mzxid |-> LastZxidOfHistory(history'[i]) ]
IN Reply(i, j, m)
/\ UNCHANGED <<followerVars, state, zabState, learners, cepochRecv,
ackeRecv, ackldRecv>>
/\ UNCHANGED <<acceptedEpoch, lastCommitted, sendCounter, electionVars,
proposalMsgsLog, epochLeader>>
/\ UpdateRecorder(<<"FollowerProcessNEWLEADER", i, j>>)
AckldRecvQuorumFormed(i) == LET sid_ackldRecv == {a.sid: a \in ackldRecv[i]}
IN IsQuorum(sid_ackldRecv)
AckldRecvBecomeQuorum(i) == LET sid_ackldRecv == {a.sid: a \in ackldRecv'[i]}
IN IsQuorum(sid_ackldRecv)
UpdateAckldRecv(oldSet, sid) ==
LET sid_set == {s.sid: s \in oldSet}
follower_info == [ sid |-> sid,
connected |-> TRUE ]
IN IF sid \in sid_set
THEN LET old_info == CHOOSE info \in oldSet: info.sid = sid
IN (oldSet \ {old_info}) \union {follower_info}
ELSE oldSet \union {follower_info}
LastZxid(i) == LastZxidOfHistory(history[i])
RECURSIVE UpdateAcksidHelper(_,_,_)
UpdateAcksidHelper(txns, target, endZxid) ==
IF Len(txns) = 0 THEN << >>
ELSE LET oldTxn == txns[1]
IN IF ZxidCompare(oldTxn.zxid, endZxid) THEN txns
ELSE LET newTxn == [ zxid |-> oldTxn.zxid,
value |-> oldTxn.value,
ackSid |-> IF target \in oldTxn.ackSid
THEN oldTxn.ackSid
ELSE oldTxn.ackSid \union {target},
epoch |-> oldTxn.epoch ]
IN <<newTxn>> \o UpdateAcksidHelper( Tail(txns), target, endZxid)
\* Atomically add ackSid of one learner according to zxid in ACKLD.
UpdateAcksid(his, target, endZxid) == UpdateAcksidHelper(his, target, endZxid)
(* Leader waits for receiving ACKLD from a quorum including itself,
and broadcasts COMMITLD and turns to BROADCAST. *)
LeaderProcessACKLD(i, j) ==
/\ IsLeader(i)
/\ PendingACKLD(i, j)
/\ LET msg == msgs[j][i][1]
infoOk == IsMyLearner(i, j)
IN /\ infoOk
/\ \/ \* 1. has not broadcast COMMITLD
/\ ~AckldRecvQuorumFormed(i)
/\ \/ /\ zabState[i] = SYNCHRONIZATION
/\ UNCHANGED violatedInvariants
\/ /\ zabState[i] /= SYNCHRONIZATION
/\ PrintT("Exception: AckldRecvQuorumFormed false," \o
" while zabState not SYNCHRONIZATION.")
/\ violatedInvariants' = [violatedInvariants
EXCEPT !.stateInconsistent = TRUE]
/\ ackldRecv' = [ackldRecv EXCEPT ![i] = UpdateAckldRecv(@, j) ]
/\ history' = [history EXCEPT ![i] = UpdateAcksid(@, j, msg.mzxid)]
/\ \/ \* 1.1. ackldRecv becomes quorum,
\* then broadcasts COMMITLD and turns to BROADCAST.
/\ AckldRecvBecomeQuorum(i)
/\ lastCommitted' = [lastCommitted EXCEPT
![i] = [ index |-> Len(history[i]),
zxid |-> LastZxid(i) ] ]
/\ zabState' = [zabState EXCEPT ![i] = BROADCAST]
/\ LET m == [ mtype |-> COMMITLD,
mzxid |-> LastZxid(i) ]
IN DiscardAndBroadcastCOMMITLD(i, j, m)
\/ \* 1.2. ackldRecv still not quorum.
/\ ~AckldRecvBecomeQuorum(i)
/\ Discard(j, i)
/\ UNCHANGED <<zabState, lastCommitted>>
\/ \* 2. has broadcast COMMITLD
/\ AckldRecvQuorumFormed(i)
/\ \/ /\ zabState[i] = BROADCAST
/\ UNCHANGED violatedInvariants
\/ /\ zabState[i] /= BROADCAST
/\ PrintT("Exception: AckldRecvQuorumFormed true," \o
" while zabState not BROADCAST.")
/\ violatedInvariants' = [violatedInvariants
EXCEPT !.stateInconsistent = TRUE]
/\ ackldRecv' = [ackldRecv EXCEPT ![i] = UpdateAckldRecv(@, j) ]
/\ history' = [history EXCEPT ![i] = UpdateAcksid(@, j, msg.mzxid)]
/\ Reply(i, j, [ mtype |-> COMMITLD,
mzxid |-> lastCommitted[i].zxid ])
/\ UNCHANGED <<zabState, lastCommitted>>
/\ UNCHANGED <<state, acceptedEpoch, currentEpoch, learners, cepochRecv, ackeRecv,
sendCounter, followerVars, electionVars, proposalMsgsLog, epochLeader>>
/\ UpdateRecorder(<<"LeaderProcessACKLD", i, j>>)
RECURSIVE ZxidToIndexHelper(_,_,_,_)
ZxidToIndexHelper(his, zxid, cur, appeared) ==
IF cur > Len(his) THEN cur
ELSE IF TxnZxidEqual(his[cur], zxid)
THEN CASE appeared = TRUE -> -1
[] OTHER -> Minimum( { cur,
ZxidToIndexHelper(his, zxid, cur + 1, TRUE) } )
ELSE ZxidToIndexHelper(his, zxid, cur + 1, appeared)
\* return -1: this zxid appears at least twice. Len(his) + 1: does not exist.
\* 1 - Len(his): exists and appears just once.
ZxidToIndex(his, zxid) == IF ZxidEqual( zxid, <<0, 0>> ) THEN 0
ELSE IF Len(his) = 0 THEN 1
ELSE LET len == Len(his) IN
IF \E idx \in 1..len: TxnZxidEqual(his[idx], zxid)
THEN ZxidToIndexHelper(his, zxid, 1, FALSE)
ELSE len + 1
(* Follower receives COMMITLD. Commit all txns. *)
FollowerProcessCOMMITLD(i, j) ==
/\ IsFollower(i)
/\ PendingCOMMITLD(i, j)
/\ LET msg == msgs[j][i][1]
infoOk == IsMyLeader(i, j)
index == IF ZxidEqual(msg.mzxid, <<0, 0>>) THEN 0
ELSE ZxidToIndex(history[i], msg.mzxid)
logOk == index >= 0 /\ index <= Len(history[i])
IN /\ infoOk
/\ \/ /\ logOk
/\ UNCHANGED violatedInvariants
\/ /\ ~logOk
/\ PrintT("Exception: zxid in COMMITLD not exists in history.")
/\ violatedInvariants' = [violatedInvariants
EXCEPT !.proposalInconsistent = TRUE]
/\ lastCommitted' = [lastCommitted EXCEPT ![i] = [ index |-> index,
zxid |-> msg.mzxid ] ]
/\ zabState' = [zabState EXCEPT ![i] = BROADCAST]
/\ Discard(j, i)
/\ UNCHANGED <<state, acceptedEpoch, currentEpoch, history, leaderVars,
followerVars, electionVars, proposalMsgsLog, epochLeader>>
/\ UpdateRecorder(<<"FollowerProcessCOMMITLD", i, j>>)
----------------------------------------------------------------------------
IncZxid(s, zxid) == IF currentEpoch[s] = zxid[1] THEN <<zxid[1], zxid[2] + 1>>
ELSE <<currentEpoch[s], 1>>
(* Leader receives client request.
Note: In production, any server in traffic can receive requests and
forward it to leader if necessary. We choose to let leader be
the sole one who can receive write requests, to simplify spec
and keep correctness at the same time. *)
LeaderProcessRequest(i) ==
/\ CheckTransactionNum \* test restrictions of transaction num
/\ IsLeader(i)
/\ zabState[i] = BROADCAST
/\ LET request_value == GetRecorder("nClientRequest") \* unique value
newTxn == [ zxid |-> IncZxid(i, LastZxid(i)),
value |-> request_value,
ackSid |-> {i},
epoch |-> currentEpoch[i] ]
IN history' = [history EXCEPT ![i] = Append(@, newTxn) ]
/\ UNCHANGED <<state, zabState, acceptedEpoch, currentEpoch, lastCommitted,
leaderVars, followerVars, electionVars, msgVars, verifyVars>>
/\ UpdateRecorder(<<"LeaderProcessRequest", i>>)
\* Latest counter existing in history.
CurrentCounter(i) == IF LastZxid(i)[1] = currentEpoch[i] THEN LastZxid(i)[2]
ELSE 0
(* Leader broadcasts PROPOSE when sendCounter < currentCounter. *)
LeaderBroadcastPROPOSE(i) ==
/\ IsLeader(i)
/\ zabState[i] = BROADCAST
/\ sendCounter[i] < CurrentCounter(i) \* there exists proposal to be sent
/\ LET toSendCounter == sendCounter[i] + 1
toSendZxid == <<currentEpoch[i], toSendCounter>>
toSendIndex == ZxidToIndex(history[i], toSendZxid)
toSendTxn == history[i][toSendIndex]
m_proposal == [ mtype |-> PROPOSE,
mzxid |-> toSendTxn.zxid,
mdata |-> toSendTxn.value ]
m_proposal_forChecking == [ source |-> i,
epoch |-> currentEpoch[i],
zxid |-> toSendTxn.zxid,
data |-> toSendTxn.value ]
IN /\ sendCounter' = [sendCounter EXCEPT ![i] = toSendCounter]
/\ Broadcast(i, m_proposal)
/\ proposalMsgsLog' = proposalMsgsLog \union {m_proposal_forChecking}
/\ UNCHANGED <<serverVars, learners, cepochRecv, ackeRecv, ackldRecv,
followerVars, electionVars, epochLeader, violatedInvariants>>
/\ UpdateRecorder(<<"LeaderBroadcastPROPOSE", i>>)
IsNextZxid(curZxid, nextZxid) ==
\/ \* first PROPOSAL in this epoch
/\ nextZxid[2] = 1
/\ curZxid[1] < nextZxid[1]
\/ \* not first PROPOSAL in this epoch
/\ nextZxid[2] > 1
/\ curZxid[1] = nextZxid[1]
/\ curZxid[2] + 1 = nextZxid[2]
(* Follower processes PROPOSE, saves it in history and replies ACK. *)
FollowerProcessPROPOSE(i, j) ==
/\ IsFollower(i)
/\ PendingPROPOSE(i, j)
/\ LET msg == msgs[j][i][1]
infoOk == IsMyLeader(i, j)
isNext == IsNextZxid(LastZxid(i), msg.mzxid)
newTxn == [ zxid |-> msg.mzxid,
value |-> msg.mdata,
ackSid |-> {},
epoch |-> currentEpoch[i] ]
m_ack == [ mtype |-> ACK,
mzxid |-> msg.mzxid ]
IN /\ infoOk
/\ \/ /\ isNext
/\ history' = [history EXCEPT ![i] = Append(@, newTxn)]
/\ Reply(i, j, m_ack)
/\ UNCHANGED violatedInvariants
\/ /\ ~isNext
/\ LET index == ZxidToIndex(history[i], msg.mzxid)
exist == index > 0 /\ index <= Len(history[i])
IN \/ /\ exist
/\ UNCHANGED violatedInvariants
\/ /\ ~exist
/\ PrintT("Exception: Follower receives PROPOSE, while" \o
" txn is neither the next nor exists in history.")
/\ violatedInvariants' = [violatedInvariants EXCEPT
!.proposalInconsistent = TRUE]
/\ Discard(j, i)
/\ UNCHANGED history
/\ UNCHANGED <<state, zabState, acceptedEpoch, currentEpoch, lastCommitted,
leaderVars, followerVars, electionVars, proposalMsgsLog, epochLeader>>
/\ UpdateRecorder(<<"FollowerProcessPROPOSE", i, j>>)
LeaderTryToCommit(s, index, zxid, newTxn, follower) ==
LET allTxnsBeforeCommitted == lastCommitted[s].index >= index - 1
\* Only when all proposals before zxid has been committed,
\* this proposal can be permitted to be committed.
hasAllQuorums == IsQuorum(newTxn.ackSid)
\* In order to be committed, a proposal must be accepted
\* by a quorum.
ordered == lastCommitted[s].index + 1 = index
\* Commit proposals in order.
IN \/ /\ \* Current conditions do not satisfy committing the proposal.
\/ ~allTxnsBeforeCommitted
\/ ~hasAllQuorums
/\ Discard(follower, s)
/\ UNCHANGED <<violatedInvariants, lastCommitted>>
\/ /\ allTxnsBeforeCommitted
/\ hasAllQuorums
/\ \/ /\ ~ordered
/\ PrintT("Warn: Committing zxid " \o ToString(zxid) \o " not first.")
/\ violatedInvariants' = [violatedInvariants EXCEPT
!.commitInconsistent = TRUE]
\/ /\ ordered
/\ UNCHANGED violatedInvariants
/\ lastCommitted' = [lastCommitted EXCEPT ![s] = [ index |-> index,
zxid |-> zxid ] ]
/\ LET m_commit == [ mtype |-> COMMIT,
mzxid |-> zxid ]
IN DiscardAndBroadcast(s, follower, m_commit)
LastAckIndexFromFollower(i, j) ==
LET set_index == {idx \in 1..Len(history[i]): j \in history[i][idx].ackSid }
IN Maximum(set_index)
(* Leader Keeps a count of acks for a particular proposal, and try to
commit the proposal. If committed, COMMIT of proposal will be broadcast. *)
LeaderProcessACK(i, j) ==
/\ IsLeader(i)
/\ PendingACK(i, j)
/\ LET msg == msgs[j][i][1]
infoOk == IsMyLearner(i, j)
index == ZxidToIndex(history[i], msg.mzxid)
exist == index >= 1 /\ index <= Len(history[i]) \* proposal exists in history
outstanding == lastCommitted[i].index < Len(history[i]) \* outstanding not null
hasCommitted == ~ZxidCompare(msg.mzxid, lastCommitted[i].zxid)
ackIndex == LastAckIndexFromFollower(i, j)
monotonicallyInc == \/ ackIndex = -1
\/ ackIndex + 1 = index
IN /\ infoOk
/\ \/ /\ exist
/\ monotonicallyInc
/\ LET txn == history[i][index]
txnAfterAddAck == [ zxid |-> txn.zxid,
value |-> txn.value,
ackSid |-> txn.ackSid \union {j} ,
epoch |-> txn.epoch ]
IN
/\ history' = [history EXCEPT ![i][index] = txnAfterAddAck ]
/\ \/ /\ \* Note: outstanding is 0.
\* / proposal has already been committed.
\/ ~outstanding
\/ hasCommitted
/\ Discard(j, i)
/\ UNCHANGED <<violatedInvariants, lastCommitted>>
\/ /\ outstanding
/\ ~hasCommitted
/\ LeaderTryToCommit(i, index, msg.mzxid, txnAfterAddAck, j)
\/ /\ \/ ~exist
\/ ~monotonicallyInc
/\ PrintT("Exception: No such zxid. " \o
" / ackIndex doesn't inc monotonically.")
/\ violatedInvariants' = [violatedInvariants
EXCEPT !.ackInconsistent = TRUE]
/\ Discard(j, i)
/\ UNCHANGED <<history, lastCommitted>>
/\ UNCHANGED <<state, zabState, acceptedEpoch, currentEpoch, leaderVars,
followerVars, electionVars, proposalMsgsLog, epochLeader>>
/\ UpdateRecorder(<<"LeaderProcessACK", i, j>>)
(* Follower processes COMMIT. *)
FollowerProcessCOMMIT(i, j) ==
/\ IsFollower(i)
/\ PendingCOMMIT(i, j)
/\ LET msg == msgs[j][i][1]
infoOk == IsMyLeader(i, j)
pending == lastCommitted[i].index < Len(history[i])
IN /\ infoOk
/\ \/ /\ ~pending
/\ PrintT("Warn: Committing zxid without seeing txn.")
/\ UNCHANGED <<lastCommitted, violatedInvariants>>
\/ /\ pending
/\ LET firstElement == history[i][lastCommitted[i].index + 1]
match == ZxidEqual(firstElement.zxid, msg.mzxid)
IN
\/ /\ ~match
/\ PrintT("Exception: Committing zxid not equals" \o
" next pending txn zxid.")
/\ violatedInvariants' = [violatedInvariants EXCEPT
!.commitInconsistent = TRUE]
/\ UNCHANGED lastCommitted
\/ /\ match
/\ lastCommitted' = [lastCommitted EXCEPT ![i] =
[ index |-> lastCommitted[i].index + 1,
zxid |-> firstElement.zxid ] ]
/\ UNCHANGED violatedInvariants
/\ Discard(j, i)
/\ UNCHANGED <<state, zabState, acceptedEpoch, currentEpoch, history,
leaderVars, followerVars, electionVars, proposalMsgsLog, epochLeader>>
/\ UpdateRecorder(<<"FollowerProcessCOMMIT", i, j>>)
----------------------------------------------------------------------------
(* Used to discard some messages which should not exist in network channel.
This action should not be triggered. *)
FilterNonexistentMessage(i) ==
/\ \E j \in Server \ {i}: /\ msgs[j][i] /= << >>
/\ LET msg == msgs[j][i][1]
IN
\/ /\ IsLeader(i)
/\ LET infoOk == IsMyLearner(i, j)
IN
\/ msg.mtype = NEWEPOCH
\/ msg.mtype = NEWLEADER
\/ msg.mtype = COMMITLD
\/ msg.mtype = PROPOSE
\/ msg.mtype = COMMIT
\/ /\ ~infoOk
/\ \/ msg.mtype = CEPOCH
\/ msg.mtype = ACKEPOCH
\/ msg.mtype = ACKLD
\/ msg.mtype = ACK
\/ /\ IsFollower(i)
/\ LET infoOk == IsMyLeader(i, j)
IN
\/ msg.mtype = CEPOCH
\/ msg.mtype = ACKEPOCH
\/ msg.mtype = ACKLD
\/ msg.mtype = ACK
\/ /\ ~infoOk
/\ \/ msg.mtype = NEWEPOCH
\/ msg.mtype = NEWLEADER
\/ msg.mtype = COMMITLD
\/ msg.mtype = PROPOSE
\/ msg.mtype = COMMIT
\/ IsLooking(i)
/\ Discard(j, i)
/\ violatedInvariants' = [violatedInvariants EXCEPT !.messageIllegal = TRUE]
/\ UNCHANGED <<serverVars, leaderVars, followerVars, electionVars,
proposalMsgsLog, epochLeader>>
/\ UnchangeRecorder
----------------------------------------------------------------------------
\* Defines how the variables may transition.
Next ==
(* Election *)
\/ \E i \in Server: UpdateLeader(i)
\/ \E i \in Server: FollowLeader(i)
(* Abnormal situations like failure, network disconnection *)
\/ \E i, j \in Server: Timeout(i, j)
\/ \E i \in Server: Restart(i)
(* Zab module - Discovery and Synchronization part *)
\/ \E i, j \in Server: ConnectAndFollowerSendCEPOCH(i, j)
\/ \E i, j \in Server: LeaderProcessCEPOCH(i, j)
\/ \E i, j \in Server: FollowerProcessNEWEPOCH(i, j)
\/ \E i, j \in Server: LeaderProcessACKEPOCH(i, j)
\/ \E i, j \in Server: FollowerProcessNEWLEADER(i, j)
\/ \E i, j \in Server: LeaderProcessACKLD(i, j)
\/ \E i, j \in Server: FollowerProcessCOMMITLD(i, j)
(* Zab module - Broadcast part *)
\/ \E i \in Server: LeaderProcessRequest(i)
\/ \E i \in Server: LeaderBroadcastPROPOSE(i)
\/ \E i, j \in Server: FollowerProcessPROPOSE(i, j)
\/ \E i, j \in Server: LeaderProcessACK(i, j)
\/ \E i, j \in Server: FollowerProcessCOMMIT(i, j)
(* An action used to judge whether there are redundant messages in network *)
\/ \E i \in Server: FilterNonexistentMessage(i)
Spec == Init /\ [][Next]_vars
----------------------------------------------------------------------------
\* Define safety properties of Zab.
ShouldNotBeTriggered == \A p \in DOMAIN violatedInvariants: violatedInvariants[p] = FALSE
\* There is most one established leader for a certain epoch.
Leadership1 == \A i, j \in Server:
/\ IsLeader(i) /\ zabState[i] \in {SYNCHRONIZATION, BROADCAST}
/\ IsLeader(j) /\ zabState[j] \in {SYNCHRONIZATION, BROADCAST}
/\ currentEpoch[i] = currentEpoch[j]
=> i = j
Leadership2 == \A epoch \in 1..MAXEPOCH: Cardinality(epochLeader[epoch]) <= 1
\* PrefixConsistency: The prefix that have been committed
\* in history in any process is the same.
PrefixConsistency == \A i, j \in Server:
LET smaller == Minimum({lastCommitted[i].index, lastCommitted[j].index})
IN \/ smaller = 0
\/ /\ smaller > 0
/\ \A index \in 1..smaller:
TxnEqual(history[i][index], history[j][index])
\* Integrity: If some follower delivers one transaction, then some primary has broadcast it.
Integrity == \A i \in Server:
/\ IsFollower(i)
/\ lastCommitted[i].index > 0
=> \A idx \in 1..lastCommitted[i].index: \E proposal \in proposalMsgsLog:
LET txn_proposal == [ zxid |-> proposal.zxid,
value |-> proposal.data ]
IN TxnEqual(history[i][idx], txn_proposal)
\* Agreement: If some follower f delivers transaction a and some follower f' delivers transaction b,
\* then f' delivers a or f delivers b.
Agreement == \A i, j \in Server:
/\ IsFollower(i) /\ lastCommitted[i].index > 0
/\ IsFollower(j) /\ lastCommitted[j].index > 0
=>
\A idx1 \in 1..lastCommitted[i].index, idx2 \in 1..lastCommitted[j].index :
\/ \E idx_j \in 1..lastCommitted[j].index:
TxnEqual(history[j][idx_j], history[i][idx1])
\/ \E idx_i \in 1..lastCommitted[i].index:
TxnEqual(history[i][idx_i], history[j][idx2])
\* Total order: If some follower delivers a before b, then any process that delivers b
\* must also deliver a and deliver a before b.
TotalOrder == \A i, j \in Server:
LET committed1 == lastCommitted[i].index
committed2 == lastCommitted[j].index
IN committed1 >= 2 /\ committed2 >= 2
=> \A idx_i1 \in 1..(committed1 - 1) : \A idx_i2 \in (idx_i1 + 1)..committed1 :
LET logOk == \E idx \in 1..committed2 :
TxnEqual(history[i][idx_i2], history[j][idx])
IN \/ ~logOk
\/ /\ logOk
/\ \E idx_j2 \in 1..committed2 :
/\ TxnEqual(history[i][idx_i2], history[j][idx_j2])
/\ \E idx_j1 \in 1..(idx_j2 - 1):
TxnEqual(history[i][idx_i1], history[j][idx_j1])
\* Local primary order: If a primary broadcasts a before it broadcasts b, then a follower that
\* delivers b must also deliver a before b.
LocalPrimaryOrder == LET p_set(i, e) == {p \in proposalMsgsLog: /\ p.source = i
/\ p.epoch = e }
txn_set(i, e) == { [ zxid |-> p.zxid,
value |-> p.data ] : p \in p_set(i, e) }
IN \A i \in Server: \A e \in 1..currentEpoch[i]:
\/ Cardinality(txn_set(i, e)) < 2
\/ /\ Cardinality(txn_set(i, e)) >= 2
/\ \E txn1, txn2 \in txn_set(i, e):
\/ TxnEqual(txn1, txn2)
\/ /\ ~TxnEqual(txn1, txn2)
/\ LET TxnPre == IF ZxidCompare(txn1.zxid, txn2.zxid) THEN txn2 ELSE txn1
TxnNext == IF ZxidCompare(txn1.zxid, txn2.zxid) THEN txn1 ELSE txn2
IN \A j \in Server: /\ lastCommitted[j].index >= 2
/\ \E idx \in 1..lastCommitted[j].index:
TxnEqual(history[j][idx], TxnNext)
=> \E idx2 \in 1..lastCommitted[j].index:
/\ TxnEqual(history[j][idx2], TxnNext)
/\ idx2 > 1
/\ \E idx1 \in 1..(idx2 - 1):
TxnEqual(history[j][idx1], TxnPre)
\* Global primary order: A follower f delivers both a with epoch e and b with epoch e', and e < e',
\* then f must deliver a before b.
GlobalPrimaryOrder == \A i \in Server: lastCommitted[i].index >= 2
=> \A idx1, idx2 \in 1..lastCommitted[i].index:
\/ ~EpochPrecedeInTxn(history[i][idx1], history[i][idx2])
\/ /\ EpochPrecedeInTxn(history[i][idx1], history[i][idx2])
/\ idx1 < idx2
\* Primary integrity: If primary p broadcasts a and some follower f delivers b such that b has epoch
\* smaller than epoch of p, then p must deliver b before it broadcasts a.
PrimaryIntegrity == \A i, j \in Server: /\ IsLeader(i) /\ IsMyLearner(i, j)
/\ IsFollower(j) /\ IsMyLeader(j, i)
/\ zabState[i] = BROADCAST
/\ zabState[j] = BROADCAST
/\ lastCommitted[j].index >= 1
=> \A idx_j \in 1..lastCommitted[j].index:
\/ history[j][idx_j].zxid[1] >= currentEpoch[i]
\/ /\ history[j][idx_j].zxid[1] < currentEpoch[i]
/\ \E idx_i \in 1..lastCommitted[i].index:
TxnEqual(history[i][idx_i], history[j][idx_j])
=============================================================================
\* Modification History
\* Last modified Tue Jan 31 20:40:11 CST 2023 by huangbinyu
\* Last modified Sat Dec 11 22:31:08 CST 2021 by Dell
\* Created Thu Dec 02 20:49:23 CST 2021 by Dell
|