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

more thoughts

Browse Source
This commit is contained in:
Brian Warner 2017-01-26 17:22:28 -08:00
parent cf981222c5
commit f6930a9bfc
2 changed files with 132 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
docs/w2a.dot Normal file
View File

@ -0,0 +1,80 @@
digraph {
/* new idea */
M_title [label="Message\nMachine" style="dotted"]
M_S1 [label="S1:\nknow nothing" color="orange"]
M_S1 -> M_P2_claim [label="M_set_nameplate()" color="orange" fontcolor="orange"]
M_S2 [label="S2:\nmaybe claimed" color="orange"]
/*M_S2 -> M_SrB [label="M_close()" style="dashed"]
M_SrB [label="SrB" style="dashed"]*/
M_P2_claim [shape="box" label="qtx claim" color="orange"]
M_P2_claim -> M_S2 [color="orange"]
M_S2 -> M_P2_queue [label="M_send(msg)" style="dotted"]
M_P2_queue [shape="box" label="queue" style="dotted"]
M_P2_queue -> M_S2 [style="dotted"]
M_S2 -> M_P_open [label="rx claimed" color="orange" fontcolor="orange"]
M_P_open [shape="box" label="store mailbox\nqtx open\nqtx add(queued)" color="orange"]
M_P_open -> M_S3 [color="orange"]
M_S3 [label="S3:\nclaimed\nmaybe open" color="orange"]
M_S3 -> M_S3 [label="rx claimed"]
M_S3 -> M_P3_send [label="M_send(msg)"]
M_P3_send [shape="box" label="queue\nqtx add(msg)"]
M_P3_send -> M_S3
M_S3 -> M_P3_process_ours [label="rx message(side=me)"]
M_P3_process_ours [shape="box" label="dequeue"]
M_P3_process_ours -> M_S3
M_S3 -> M_P3_process_theirs1 [label="rx message(side!=me)" color="orange" fontcolor="orange"]
M_P3_process_theirs1 [shape="box" label="qtx release" color="orange"]
M_P3_process_theirs1 -> M_P3_process_theirs2 [color="orange"]
M_P3_process_theirs2 [shape="octagon" label="process message" color="orange"]
/* pay attention to the race here: this process_message() will
deliver msg_pake to the WormholeMachine, which will compute_key() and
M_send(version), and we're in between M_S2A (where M_send gets
queued) and M_S3A (where M_send gets sent and queued), and we're no
longer passing through the M_P3_open phase (which drains the queue).
So there's a real possibility of the outbound msg_version getting
dropped on the floor, or put in a queue but never delivered. */
M_P3_process_theirs2 -> M_S4 [color="orange"]
/*{rank=same; M_S4A M_P4_release M_S4 M_P4_process M_P4_send M_P4_queue}*/
M_S4 [label="S4:\nmaybe released\nmaybe open" color="orange"]
M_S4 -> M_P4_send [label="M_send(msg)"]
M_P4_send [shape="box" label="queue\nqtx add(msg)"]
M_P4_send -> M_S4
M_S4 -> M_P4_process [label="rx message"]
M_P4_process [shape="octagon" label="process message"]
M_P4_process -> M_S4
M_S4 -> M_S5 [label="rx released" color="orange" fontcolor="orange"]
seed [label="from Seed?"]
seed -> M_S5
M_S5 [label="S5:\nreleased\nmaybe open" color="green"]
M_S5 -> M_process [label="rx message" color="green" fontcolor="green"]
M_process [shape="octagon" label="process message" color="green"]
M_process -> M_S5 [color="green"]
M_S5 -> M_P5_send [label="M_send(msg)" color="green" fontcolor="green"]
M_P5_send [shape="box" label="queue\nqtx add(msg)" color="green"]
M_P5_send -> M_S5 [color="green"]
/*M_S5 -> M_CcB_P_close [label="M_close()" style="dashed" color="orange" fontcolor="orange"]
M_CcB_P_close [label="qtx close" style="dashed" color="orange"] */
M_process [shape="octagon" label="process message"]
M_process_me [shape="box" label="dequeue"]
M_process -> M_process_me [label="side == me"]
M_process_them [shape="box" label="" style="dotted"]
M_process -> M_process_them [label="side != me"]
M_process_them -> M_process_pake [label="phase == pake"]
M_process_pake [shape="box" label="WM_rx_pake()"]
M_process_them -> M_process_other [label="phase in (version,numbered)"]
M_process_other [shape="box" label="WM_rx_msg()"]
}

52
docs/w3a.dot Normal file
View File

@ -0,0 +1,52 @@
digraph {
/* M_close pathways */
MC_title [label="Mailbox\nClose\nMachine" style="dotted"]
MC_title -> MC_S2 [style="invis"]
/* All dashed states are from the main Mailbox Machine diagram, and
all dashed lines indicate M_close() pathways in from those states.
Within this graph, all M_close() events leave the state unchanged. */
MC_Pr [shape="box" label="qtx release" color="orange"]
MC_Pr -> MC_Sr [color="orange"]
MC_Sr [label="SrB:\nwaiting for:\nrelease" color="orange"]
MC_Sr -> MC_P_stop [label="rx released" color="orange" fontcolor="orange"]
MC_Pc [shape="box" label="qtx close" color="orange"]
MC_Pc -> MC_Sc [color="orange"]
MC_Sc [label="ScB:\nwaiting for:\nclosed" color="orange"]
MC_Sc -> MC_P_stop [label="rx closed" color="orange" fontcolor="orange"]
MC_Prc [shape="box" label="qtx release\nqtx close" color="orange"]
MC_Prc -> MC_Src [color="orange"]
MC_Src [label="SrcB:\nwaiting for:\nrelease\nclosed" color="orange"]
MC_Src -> MC_Sc [label="rx released" color="orange" fontcolor="orange"]
MC_Src -> MC_Sr [label="rx closed" color="orange" fontcolor="orange"]
MC_P_stop [shape="box" label="C_stop()"]
MC_P_stop -> MC_Ss
MC_Ss -> MC_Ss [label="M_stopped()"]
MC_Ss [label="SsB: closed\nstopping"]
MC_Ss [label="Ss: closed" color="green"]
{rank=same; MC_S2 MC_S1 MC_S3 MC_S4 MC_S5}
MC_S1 [label="S1" color="orange" style="dashed"]
MC_S1 -> MC_P_stop [style="dashed" color="orange"]
MC_S2 [label="S2" color="orange" style="dashed"]
MC_S2 -> MC_Pr [color="orange" style="dashed"]
MC_S3 [label="S3" color="orange" style="dashed"]
MC_S3 -> MC_Prc [color="orange" style="dashed"]
MC_S4 [label="S4" color="orange" style="dashed"]
MC_S4 -> MC_Prc [color="orange" style="dashed"]
MC_S5 [label="S5" color="green" style="dashed"]
MC_S5 -> MC_Pc [style="dashed" color="green"]
}