open.source/magic-wormhole
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

make mailbox/mailbox_close/machines consistent

Browse Source 
finally get mailbox.png layout good enough
This commit is contained in:
Brian Warner 2017-02-15 16:11:26 -08:00
parent 7cc50e9701
commit 44cc1399c4
3 changed files with 211 additions and 195 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/machines.dot
View File

@ -1,34 +1,40 @@
digraph { digraph {
Wormhole [shape="box" label="Wormhole\n(manager)"] Wormhole [shape="box" label="Wormhole\n(manager)"
Wormhole -> Mailbox [style="dashed" color="blue" fontcolor="blue"]
label="M_set_nameplate()\nM_send()\nM_close()" Mailbox [shape="box" color="blue" fontcolor="blue"]
] Connection [shape="oval" color="blue" fontcolor="blue"]
Wormhole -> Mailbox websocket [shape="oval" color="blue" fontcolor="blue"]
Mailbox -> Wormhole [style="dashed" Nameplates [shape="box" label="Nameplate\nLister"
label="W_rx_pake()\nW_rx_msg()\nW_closed()" color="blue" fontcolor="blue"]
]
Mailbox [shape="box"] Connection -> websocket [color="blue"]
Mailbox -> Connection [style="dashed"
label="C_tx_add()\nC_stop()" Wormhole -> Mailbox [style="dashed"
] label="set_nameplate\nadd_message\nclose"
Mailbox -> Connection ]
Connection -> Mailbox [style="dashed" Wormhole -> Mailbox [color="blue"]
label="M_connected()\nM_lost()\nM_rx_claimed()\nM_rx_message()\nM_rx_released()\nM_stopped()"] Mailbox -> Wormhole [style="dashed"
label="got_message\nclosed"
Connection -> websocket ]
Mailbox -> Connection [style="dashed"
label="tx_claim\ntx_open\ntx_add\ntx_release\ntx_close\nstop"
]
Mailbox -> Connection [color="blue"]
Connection -> Mailbox [style="dashed"
label="connected\nlost\nrx_claimed\nrx_message\nrx_released\nrx_closed\nstopped"]
Nameplates [shape="box" label="Nameplate\nLister"]
Wormhole -> Nameplates [style="dashed" Wormhole -> Nameplates [style="dashed"
label="NL_refresh_nameplates()" label="refresh_nameplates"
] ]
Wormhole -> Nameplates [color="blue"]
Nameplates -> Wormhole [style="dashed" Nameplates -> Wormhole [style="dashed"
label="W_got_nameplates()" label="got_nameplates"
] ]
Connection -> Nameplates [style="dashed" Connection -> Nameplates [style="dashed"
label="NL_connected()\nNL_lost()\nNL_rx_nameplates()" label="connected\nlost\nrx_nameplates"
] ]
Nameplates -> Connection [style="dashed" Nameplates -> Connection [style="dashed"
label="C_tx_list()" label="tx_list"
] ]

252
docs/mailbox.dot
View File

@ -1,147 +1,157 @@
digraph { digraph {
/* new idea */ /* new idea */
{rank=same; M_title M_entry_whole_code M_entry_allocation M_entry_interactive} {rank=same; title entry_whole_code entry_allocation entry_interactive}
M_entry_whole_code [label="whole\ncode"] entry_whole_code [label="whole\ncode"]
M_entry_whole_code -> M_S0A entry_whole_code -> S0A
M_title [label="Message\nMachine" style="dotted"] title [label="Message\nMachine" style="dotted"]
M_entry_allocation [label="allocation" color="orange"] entry_allocation [label="allocation" color="orange"]
M_entry_allocation -> M_S0B [label="already\nconnected" color="orange" fontcolor="orange"] entry_allocation -> S0B [label="(already\nconnected)"
M_entry_interactive [label="interactive" color="orange"] color="orange" fontcolor="orange"]
M_entry_interactive -> M_S0B [color="orange"] entry_interactive [label="interactive" color="orange"]
entry_interactive -> S0B [color="orange"]
{rank=same; M_S0A M_S0B} {rank=same; S0A P0_connected S0B}
M_S0A [label="S0A:\nknow nothing"] S0A [label="S0A:\nknow nothing"]
M_S0B [label="S0B:\nknow nothing\n(bound)" color="orange"] S0B [label="S0B:\nknow nothing\n(bound)" color="orange"]
M_S0A -> M_S0B [label="M_connected()"] S0A -> P0_connected [label="connected"]
M_S0B -> M_S0A [label="M_lost()"] P0_connected [label="(nothing)" shape="box" style="dashed"]
P0_connected -> S0B
S0B -> S0A [label="lost"]
M_S0A -> M_S1A [label="M_set_nameplate()"] S0A -> S1A [label="set_nameplate"]
M_S0B -> M_P2_claim [label="M_set_nameplate()" color="orange" fontcolor="orange"] S0B -> P2_connected [label="set_nameplate" color="orange" fontcolor="orange"]
P0A_queue [shape="box" label="queue" style="dotted"]
S0A -> P0A_queue [label="add_message" style="dotted"]
P0A_queue -> S0A [style="dotted"]
{rank=same; M_S1A M_P1A_queue} {rank=same; S1A P1A_queue}
M_S0B -> M_S2B [style="invis"] S1A [label="S1A:\nnot claimed"]
M_S1A -> M_S2A [style="invis"] S1A -> P2_connected [label="connected"]
M_S1A [label="S1A:\nnot claimed"] S1A -> P1A_queue [label="add_message" style="dotted"]
M_S1A -> M_P2_claim [label="M_connected()"] P1A_queue [shape="box" label="queue" style="dotted"]
M_S1A -> M_P1A_queue [label="M_send(msg)" style="dotted"] P1A_queue -> S1A [style="dotted"]
M_P1A_queue [shape="box" label="queue" style="dotted"]
M_P1A_queue -> M_S1A [style="dotted"]
{rank=same; M_S2B M_S2A M_P2_claim} {rank=same; S2A P2_connected S2B}
M_S2A [label="S2A:\nmaybe claimed"] S2A [label="S2A:\nmaybe claimed"]
M_S2B [label="S2B:\nmaybe claimed\n(bound)" color="orange"] S2A -> P2_connected [label="connected"]
#M_S2B -> M_SrB [label="M_close()" style="dashed"] P2_connected [shape="box" label="C.tx_claim" color="orange"]
#M_SrB [label="SrB" style="dashed"] P2_connected -> S2B [color="orange"]
#M_S2A -> M_SrA [label="M_close()" style="dashed"] S2B [label="S2B:\nmaybe claimed\n(bound)" color="orange"]
#M_SrA [label="SrA" style="dashed"] #S2B -> SrB [label="close()" style="dashed"]
#SrB [label="SrB" style="dashed"]
#S2A -> SrA [label="close()" style="dashed"]
#SrA [label="SrA" style="dashed"]
M_S2A -> M_P2_claim [label="M_connected()"] #S2B -> S2A [label="lost"] # causes bad layout
#M_S2B -> M_S2A [label="M_lost()"] # causes bad layout S2B -> foo [label="lost"]
M_S2B -> foo [label="M_lost()"]
foo [label="" style="dashed"] foo [label="" style="dashed"]
foo -> M_S2A foo -> S2A
M_P2_claim [shape="box" label="tx claim" color="orange"] S2A -> P2C_queue [label="add_message" style="dotted"]
M_P2_claim -> M_S2B [color="orange"] P2C_queue [shape="box" label="queue" style="dotted"]
M_S2A -> M_P2C_queue [label="M_send(msg)" style="dotted"] P2C_queue -> S2A [style="dotted"]
M_P2C_queue [shape="box" label="queue" style="dotted"] S2B -> P2B_queue [label="add_message" style="dotted"]
M_P2C_queue -> M_S2A [style="dotted"] P2B_queue [shape="box" label="queue" style="dotted"]
M_S2B -> M_P2B_queue [label="M_send(msg)" style="dotted"] P2B_queue -> S2B [style="dotted"]
M_P2B_queue [shape="box" label="queue" style="dotted"]
M_P2B_queue -> M_S2B [style="dotted"]
M_S1A -> M_S3A [label="(none)" style="invis"] S1A -> S3A [label="(none)" style="invis"]
M_S2B -> M_P_open [label="rx claimed" color="orange" fontcolor="orange"] S2B -> P_open [label="rx_claimed" color="orange" fontcolor="orange"]
M_P_open [shape="box" label="store mailbox\ntx open\ntx add(queued)" color="orange"] P_open [shape="box" label="store mailbox\nC.tx_open\nC.tx_add(queued)" color="orange"]
M_P_open -> M_S3B [color="orange"] P_open -> S3B [color="orange"]
{rank=same; M_S3A M_S3B M_P3_open M_P3_send} subgraph {rank=same; S3A S3B P3_connected}
M_S3A [label="S3A:\nclaimed\nopened >=once"] S3A [label="S3A:\nclaimed\nopened >=once"]
M_S3B [label="S3B:\nclaimed\nmaybe open now\n(bound)" color="orange"] S3B [label="S3B:\nclaimed\nmaybe open now\n(bound)" color="orange"]
M_S3A -> M_P3_open [label="M_connected()"] S3A -> P3_connected [label="connected"]
M_S3B -> M_S3A [label="M_lost()"] S3B -> S3A [label="lost"]
M_P3_open [shape="box" label="tx open\ntx add(queued)"]
M_P3_open -> M_S3B
M_S3B -> M_S3B [label="rx claimed"]
M_S3B -> M_P3_send [label="M_send(msg)"]
M_P3_send [shape="box" label="queue\ntx add(msg)"]
M_P3_send -> M_S3B
M_S3A -> M_P3_queue [label="M_send(msg)" style="dotted"]
M_P3_queue [shape="box" label="queue" style="dotted"]
M_P3_queue -> M_S3A [style="dotted"]
M_S3A -> M_S4A [label="(none)" style="invis"] P3_connected [shape="box" label="C.tx_open\nC.tx_add(queued)"]
M_S3B -> M_P3_process_ours [label="rx message(side=me)"] P3_connected -> S3B
M_P3_process_ours [shape="box" label="dequeue"]
M_P3_process_ours -> M_S3B S3A -> P3_queue [label="add_message" style="dotted"]
M_S3B -> M_P3_process_theirs1 [label="rx message(side!=me)" color="orange" fontcolor="orange"] P3_queue [shape="box" label="queue" style="dotted"]
M_P3_process_theirs1 [shape="box" label="tx release" color="orange"] P3_queue -> S3A [style="dotted"]
M_P3_process_theirs1 -> M_P3_process_theirs2 [color="orange"]
M_P3_process_theirs2 [shape="octagon" label="process message" color="orange"] S3B -> S3B [label="rx_claimed"]
S3B -> P3_send [label="add_message"]
P3_send [shape="box" label="queue\nC.tx_add(msg)"]
P3_send -> S3B
S3A -> S4A [label="(none)" style="invis"]
S3B -> P3_process_ours [label="rx_message\n(ours)"]
P3_process_ours [shape="box" label="dequeue"]
P3_process_ours -> S3B
S3B -> P3_process_theirs [label="rx_message\n(theirs)"
color="orange" fontcolor="orange"]
P3_process_theirs [shape="box" label="C.tx_release\nW.got_message"
color="orange"]
/* pay attention to the race here: this process_message() will /* pay attention to the race here: this process_message() will
deliver msg_pake to the WormholeMachine, which will compute_key() and deliver msg_pake to the WormholeMachine, which will compute_key() and
M_send(version), and we're in between M_S1A (where M_send gets send(version), and we're in between S1A (where send gets
queued) and M_S3A (where M_send gets sent and queued), and we're no queued) and S3A (where send gets sent and queued), and we're no
longer passing through the M_P3_open phase (which drains the queue). longer passing through the P3_connected phase (which drains the queue).
So there's a real possibility of the outbound msg_version getting So there's a real possibility of the outbound msg_version getting
dropped on the floor, or put in a queue but never delivered. */ dropped on the floor, or put in a queue but never delivered. */
M_P3_process_theirs2 -> M_S4B [color="orange"] P3_process_theirs -> S4B [color="orange"]
{rank=same; M_S4A M_P4_release M_S4B M_P4_process M_P4_send M_P4_queue} subgraph {rank=same; S4A P4_connected S4B}
M_S4A [label="S4A:\nmaybe released\nopened >=once\n"] S4A [label="S4A:\nmaybe released\nopened >=once\n"]
M_S4B [label="S4B:\nmaybe released\nmaybe open now\n(bound)" color="orange"] S4B [label="S4B:\nmaybe released\nmaybe open now\n(bound)" color="orange"]
M_S4A -> M_P4_release [label="M_connected()"] S4A -> P4_connected [label="connected"]
M_P4_release [shape="box" label="tx open\ntx add(queued)\ntx release"] P4_connected [shape="box" label="C.tx_open\nC.tx_add(queued)\nC.tx_release"]
M_S4B -> M_P4_send [label="M_send(msg)"] S4B -> P4_send [label="add_message"]
M_P4_send [shape="box" label="queue\ntx add(msg)"] P4_send [shape="box" label="queue\nC.tx_add(msg)"]
M_P4_send -> M_S4B P4_send -> S4B
M_S4A -> M_P4_queue [label="M_send(msg)" style="dotted"] S4A -> P4_queue [label="add_message" style="dotted"]
M_P4_queue [shape="box" label="queue" style="dotted"] P4_queue [shape="box" label="queue" style="dotted"]
M_P4_queue -> M_S4A [style="dotted"] P4_queue -> S4A [style="dotted"]
M_P4_release -> M_S4B P4_connected -> S4B
M_S4B -> M_S4A [label="M_lost()"] S4B -> S4A [label="lost"]
M_S4B -> M_P4_process [label="rx message"] S4B -> P4_process_ours [label="rx_message\n(ours)"]
M_P4_process [shape="octagon" label="process message"] P4_process_ours [shape="box" label="dequeue"]
M_P4_process -> M_S4B P4_process_ours -> S4B
S4B -> P4_process_theirs [label="rx_message\n(theirs)"]
P4_process_theirs [shape="box" label="W.got_message"]
P4_process_theirs -> S4B
M_S4A -> M_S5A [label="(none)" style="invis"] S4A -> S5A [label="(none)" style="invis"]
M_S4B -> M_S5B [label="rx released" color="orange" fontcolor="orange"] S4B -> S5B [label="rx released" color="orange" fontcolor="orange"]
seed [label="from Seed?"] P4_queue -> S5A [style="invis"]
M_S3A -> seed [style="invis"] subgraph {S5A P5_connected S5B}
M_S4A -> seed [style="invis"] {rank=same; S5A P5_connected S5B}
seed -> M_S5A
{rank=same; seed M_S5A M_S5B M_P5_open M_process}
M_S5A [label="S5A:\nreleased\nopened >=once"]
M_S5B [label="S5B:\nreleased\nmaybe open now\n(bound)" color="green"]
M_S5A -> M_P5_open [label="M_connected()"]
M_P5_open [shape="box" label="tx open\ntx add(queued)"]
M_P5_open -> M_S5B
M_S5B -> M_S5A [label="M_lost()"]
M_S5B -> M_process [label="rx message" color="green" fontcolor="green"]
M_process [shape="octagon" label="process message" color="green"]
M_process -> M_S5B [color="green"]
M_S5B -> M_P5_send [label="M_send(msg)" color="green" fontcolor="green"]
M_P5_send [shape="box" label="queue\ntx add(msg)" color="green"]
M_P5_send -> M_S5B [color="green"]
M_S5A -> M_P5_queue [label="M_send(msg)" style="dotted"]
M_P5_queue [shape="box" label="queue" style="dotted"]
M_P5_queue -> M_S5A [style="dotted"]
M_S5B -> M_CcB_P_close [label="M_close()" style="dashed" color="orange" fontcolor="orange"]
M_CcB_P_close [label="tx close" style="dashed" color="orange"]
M_process [shape="octagon" label="process message"] S5A [label="S5A:\nreleased\nopened >=once"]
M_process_me [shape="box" label="dequeue"] S5A -> P5_connected [label="connected"]
M_process -> M_process_me [label="side == me"] P5_connected [shape="box" label="C.tx_open\nC.tx_add(queued)"]
M_process_them [shape="box" label="" style="dotted"]
M_process -> M_process_them [label="side != me"] S5B -> P5_send [label="add_message" color="green" fontcolor="green"]
M_process_them -> M_process_pake [label="phase == pake"] P5_send [shape="box" label="queue\nC.tx_add(msg)" color="green"]
M_process_pake [shape="box" label="WM_rx_pake()"] P5_send -> S5B [color="green"]
M_process_them -> M_process_other [label="phase in (version,numbered)"] S5A -> P5_queue [label="add_message" style="dotted"]
M_process_other [shape="box" label="WM_rx_msg()"] P5_queue [shape="box" label="queue" style="dotted"]
P5_queue -> S5A [style="dotted"]
P5_connected -> S5B
S5B [label="S5B:\nreleased\nmaybe open now\n(bound)" color="green"]
S5B -> S5A [label="lost"]
S5B -> P5_process_ours [label="rx_message\n(ours)"]
P5_process_ours [shape="box" label="dequeue"]
P5_process_ours -> S5B
S5B -> P5_process_theirs [label="rx_message\n(theirs)"]
P5_process_theirs [shape="box" label="W.got_message"]
P5_process_theirs -> S5B
foo5 [label="" style="invis"]
S5A -> foo5 [style="invis"]
foo5 -> P5_close [style="invis"]
S5B -> P5_close [label="close" style="dashed" color="orange" fontcolor="orange"]
P5_close [shape="box" label="tx_close" style="dashed" color="orange"]
} }

104
docs/mailbox_close.dot
View File

@ -1,73 +1,73 @@
digraph { digraph {
/* M_close pathways */ /* M_close pathways */
MC_title [label="Mailbox\nClose\nMachine" style="dotted"] title [label="Mailbox\nClose\nMachine" style="dotted"]
MC_title -> MC_S2B [style="invis"] title -> S2B [style="invis"]
/* All dashed states are from the main Mailbox Machine diagram, and /* All dashed states are from the main Mailbox Machine diagram, and
all dashed lines indicate M_close() pathways in from those states. all dashed lines indicate M_close() pathways in from those states.
Within this graph, all M_close() events leave the state unchanged. */ Within this graph, all M_close() events leave the state unchanged. */
MC_SrA [label="SrA:\nwaiting for:\nrelease"] SrA [label="SrA:\nwaiting for:\nrelease"]
MC_SrA -> MC_Pr [label="M_connected()"] SrA -> Pr [label="connected"]
MC_Pr [shape="box" label="tx release" color="orange"] Pr [shape="box" label="C.tx_release" color="orange"]
MC_Pr -> MC_SrB [color="orange"] Pr -> SrB [color="orange"]
MC_SrB [label="SrB:\nwaiting for:\nrelease" color="orange"] SrB [label="SrB:\nwaiting for:\nrelease" color="orange"]
MC_SrB -> MC_SrA [label="M_lost()"] SrB -> SrA [label="lost"]
MC_SrB -> MC_P_stop [label="rx released" color="orange" fontcolor="orange"] SrB -> P_stop [label="rx_released" color="orange" fontcolor="orange"]
MC_ScA [label="ScA:\nwaiting for:\nclosed"] ScA [label="ScA:\nwaiting for:\nclosed"]
MC_ScA -> MC_Pc [label="M_connected()"] ScA -> Pc [label="connected"]
MC_Pc [shape="box" label="tx close" color="orange"] Pc [shape="box" label="C.tx_close" color="orange"]
MC_Pc -> MC_ScB [color="orange"] Pc -> ScB [color="orange"]
MC_ScB [label="ScB:\nwaiting for:\nclosed" color="orange"] ScB [label="ScB:\nwaiting for:\nclosed" color="orange"]
MC_ScB -> MC_ScA [label="M_lost()"] ScB -> ScA [label="lost"]
MC_ScB -> MC_P_stop [label="rx closed" color="orange" fontcolor="orange"] ScB -> P_stop [label="rx_closed" color="orange" fontcolor="orange"]
MC_SrcA [label="SrcA:\nwaiting for:\nrelease\nclose"] SrcA [label="SrcA:\nwaiting for:\nrelease\nclose"]
MC_SrcA -> MC_Prc [label="M_connected()"] SrcA -> Prc [label="connected"]
MC_Prc [shape="box" label="tx release\ntx close" color="orange"] Prc [shape="box" label="C.tx_release\nC.tx_close" color="orange"]
MC_Prc -> MC_SrcB [color="orange"] Prc -> SrcB [color="orange"]
MC_SrcB [label="SrcB:\nwaiting for:\nrelease\nclosed" color="orange"] SrcB [label="SrcB:\nwaiting for:\nrelease\nclosed" color="orange"]
MC_SrcB -> MC_SrcA [label="M_lost()"] SrcB -> SrcA [label="lost"]
MC_SrcB -> MC_ScB [label="rx released" color="orange" fontcolor="orange"] SrcB -> ScB [label="rx_released" color="orange" fontcolor="orange"]
MC_SrcB -> MC_SrB [label="rx closed" color="orange" fontcolor="orange"] SrcB -> SrB [label="rx_closed" color="orange" fontcolor="orange"]
MC_P_stop [shape="box" label="C_stop()"] P_stop [shape="box" label="C.stop"]
MC_P_stop -> MC_SsB P_stop -> SsB
MC_SsB -> MC_Ss [label="M_stopped()"] SsB -> Ss [label="stopped"]
MC_SsB [label="SsB: closed\nstopping"] SsB [label="SsB: closed\nstopping"]
MC_Ss [label="Ss: closed" color="green"] Ss [label="Ss: closed" color="green"]
MC_S0A [label="S0A" style="dashed"] S0A [label="S0A" style="dashed"]
MC_S0A -> MC_P_stop [style="dashed"] S0A -> P_stop [style="dashed"]
MC_S0B [label="S0B" style="dashed" color="orange"] S0B [label="S0B" style="dashed" color="orange"]
MC_S0B -> MC_P_stop [style="dashed" color="orange"] S0B -> P_stop [style="dashed" color="orange"]
{rank=same; MC_S2A MC_S2B MC_S3A MC_S3B MC_S4A MC_S4B MC_S5A MC_S5B} {rank=same; S2A S2B S3A S3B S4A S4B S5A S5B}
MC_S1A [label="S1A" style="dashed"] S1A [label="S1A" style="dashed"]
MC_S1A -> MC_P_stop [style="dashed"] S1A -> P_stop [style="dashed"]
MC_S2A [label="S2A" style="dashed"] S2A [label="S2A" style="dashed"]
MC_S2A -> MC_SrA [style="dashed"] S2A -> SrA [label="stop" style="dashed"]
MC_S2B [label="S2B" color="orange" style="dashed"] S2B [label="S2B" color="orange" style="dashed"]
MC_S2B -> MC_Pr [color="orange" style="dashed"] S2B -> Pr [color="orange" style="dashed"]
MC_S3A [label="S3A" style="dashed"] S3A [label="S3A" style="dashed"]
MC_S3B [label="S3B" color="orange" style="dashed"] S3B [label="S3B" color="orange" style="dashed"]
MC_S3A -> MC_SrcA [style="dashed"] S3A -> SrcA [style="dashed"]
MC_S3B -> MC_Prc [color="orange" style="dashed"] S3B -> Prc [color="orange" style="dashed"]
MC_S4A [label="S4A" style="dashed"] S4A [label="S4A" style="dashed"]
MC_S4B [label="S4B" color="orange" style="dashed"] S4B [label="S4B" color="orange" style="dashed"]
MC_S4A -> MC_SrcA [style="dashed"] S4A -> SrcA [style="dashed"]
MC_S4B -> MC_Prc [color="orange" style="dashed"] S4B -> Prc [color="orange" style="dashed"]
MC_S5A [label="S5A" style="dashed"] S5A [label="S5A" style="dashed"]
MC_S5B [label="S5B" color="green" style="dashed"] S5B [label="S5B" color="green" style="dashed"]
MC_S5A -> MC_ScA [style="dashed"] S5A -> ScA [style="dashed"]
MC_S5B -> MC_Pc [style="dashed" color="green"] S5B -> Pc [style="dashed" color="green"]
} }