Merge pull request #3 from SidoShiro/doc-README

Add README Node cycle drafts

Author: itectori

README.md

@@ -82,4 +82,17 @@ mpirun --hostfile hostfile dmalloc [DOTFILE]
 | kill `id`                         | kill node refered by `id`                               |
 | revive `id`                       | revive `id`                                             |
 
+## Node Life Cycles
+
+### Node Leader Elections
+
+![Graph leader election](doc/node_election.png)
+
+### Node Leader Cycle
+
+![Graph leader cycle](doc/node_leader_proc.png)
+
+### Node Cycle
+
+![Graph leader election](doc/node_proc.png)
 

doc/node_election.png

@@ -0,0 +1,15 @@
+digraph Leader {
+  is_now_leader -> Send_LEADER_to_USER -> Idle;
+  Idle -> Idle;
+  Idle -> USER_WRITE;
+  Idle -> USER_READ;
+  Idle -> USER_SNAP;
+  Idle -> USER_MALLOC;
+  Idle -> USER_FREE;
+  Idle -> USER_DUMP;
+  USER_DUMP -> USER_READ;
+  Idle -> USER_KILL;
+  Idle -> USER_REVIVE;
+  USER_WRITE -> Send_WRITE -> Recv_OK_write -> Send_WRITE_DATA;
+  USER_READ -> Send_READ -> Recv_OK_read -> Recv_READ_DATA;
+}

doc/node_leader.dot

@@ -0,0 +1,51 @@
+digraph NodeProcess {
+  Idle -> Idle;
+  Idle -> Recv_WRITE;
+  Recv_WRITE -> id_op_is_id_op_write;
+  id_op_is_id_op_write -> Send_OK_write;
+  Send_OK_write -> Recv_WRITE_DATA;
+  Recv_WRITE_DATA -> id_op_is_id_op_write;
+  id_op_is_id_op_write -> Idle;
+  Recv_WRITE -> id_op_is_not_id_op_write;
+  id_op_is_not_id_op_write -> Send_WRITE;
+  Send_WRITE -> Recv_OK_write;
+  Recv_OK_write -> Send_OK_write;
+  Recv_WRITE_DATA -> id_op_is_not_id_op_write;
+  id_op_is_not_id_op_write -> Send_WRITE_DATA;
+  Send_WRITE_DATA -> Idle;
+  Idle -> Recv_READ;
+  Recv_READ -> id_op_is_id_op_read;
+  id_op_is_id_op_read -> Send_OK_read;
+  Send_OK_read -> Send_READ_DATA;
+  Send_READ_DATA -> Idle;
+  Recv_READ -> id_op_is_not_id_op_read;
+  id_op_is_not_id_op_read -> Send_READ;
+  Send_READ -> Recv_OK_read;
+  Recv_OK_read -> Recv_READ_DATA;
+  Recv_READ_DATA -> Send_OK_read;
+  Idle -> Recv_DIE;
+  Recv_DIE -> id_op_is_id_op_die;
+  id_op_is_id_op_die -> DIE;
+  Recv_DIE -> id_op_is_not_id_op_die;
+  id_op_is_not_id_op_die -> Send_DIE;
+  Send_DIE -> Idle;
+  Idle -> Recv_REVIVE;
+  Recv_REVIVE -> id_op_is_id_op_revive;
+  id_op_is_id_op_revive -> Send_WARNING;
+  Send_WARNING -> Idle;
+  Recv_REVIVE -> id_op_is_not_id_op_revive;
+  id_op_is_not_id_op_revive -> Send_REVIVE;
+  Send_REVIVE -> Idle;
+  DIE -> Recv_REVIVE_on_dead;
+  Recv_REVIVE_on_dead -> Idle;
+  Idle -> Recv_SNAP;
+  Recv_SNAP -> id_op_is_id_op_snap;
+  id_op_is_id_op_snap -> Send_OK_snap;
+  Recv_SNAP -> id_op_is_not_id_op_snap;
+  id_op_is_not_id_op_snap -> Send_SNAP;
+  Send_SNAP -> Recv_OK_snap;
+  Recv_OK_snap -> Recv_SNAP_DATA;
+  Recv_SNAP_DATA -> Send_OK_snap;
+  Send_OK_snap -> Send_SNAP_DATA;
+  Send_SNAP_DATA -> Idle;
+}

doc/node_leader_proc.png

@@ -0,0 +1,4 @@
+digraph NodeStart {
+  NodeInit -> Send_LEADER;
+  Send_LEADER -> Recv_LEADER;
+}