Skip to content

Commit

Permalink
update architecture
Browse files Browse the repository at this point in the history
  • Loading branch information
@ainghazal
ainghazal committed Jan 23, 2024
1 parent 51e473a commit d2fe46c
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions ARCHITECTURE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
* Finally, the [workers.Manager](https://github.com/ainghazal/minivpn/blob/main/internal/workers/workers.go) component deals with coordination among all the components.


## Implementation
## Services

* Each layer is implemented as a service, that can be found under its own package under the [internal](https://github.com/ainghazal/minivpn/blob/main/internal) path.
* Each service initializes and starts a number of workers (typicall two: one for moving data up the stack, and another one for moving data down). Some services implement only one worker, some do three.
Expand All @@ -21,6 +21,7 @@
* The channels leaving and arriving each module can be seen in the diagram below:


```
```
startShtdwn
┌───────────────────────────────────────────┬────────────►┌──────────────┐
Expand All @@ -29,60 +30,60 @@
│ │ Ready │ Manager │
└────▲───────┬──────────────────────────────┘◄────────────┤ │
│ │ │ │
[10] │tunUp │tunDown │ │
│tunUp │tunDown │ │
┌────┴───────▼──────────────────────────────┐ │ │
│ │ shtdwn! │ │
│ datachannel │◄────────────┤ │
│ │ │ │
└───▲────────┬────────────────────────▲─────┘ │ │
│ │ [1] keyUp │ shtdwn! │ │
│ │ keyUp │ shtdwn! │ │
│ │ ┌────────────────┴─────┐◄────────────┤ │
│ │ │ │ │ │
│ │ │ tlssession [1] ◄──┐ │ │
│ │ │ tlssession ◄──┐ │ │
│ │ └───────▲──────────▲───┘ │ │ │
│ │ tlsRec │ │ *notifyTLS │ │
│ │ tlsRec │ │ notifyTLS │ │
muxerTo │ Down│ tlsRecUp notifyTLS │ │ │
Data │ │ │ │ │ │ │
│ │ ┌─▼─────┴──────────┴───┐ │ │ │
│ │ │ │ │ │ │
│ │ │ controlchannel │ │ │ │
│ │ └─┬─────▲──────────────┘ │ ◄────────┤ │
│ │ ctrl │ │ notifyTLS │ shtdwn!│ │
│ │ 2Rel │ rel2Ctrl │ │ │ │
│ │ ┌─▼────────────────▼───┐ │ │ │
│ │ ctrl │ │ │ shtdwn!│ │
│ │ 2Rel │ rel2Ctrl │ │ │
│ │ ┌─▼────────────────────┐ │ │ │
│ │ │ │ │ ◄────────┤ │
│ │ │ reliabletransport │ │ shtdwn!│ │
│ │ └───────▲──────────────┘ │ │ │
│ *dataOrCtrlToMuxer │ muxerToReliable │ │ │
│ dataOrCtrlToMuxer │ muxerToReliable │ │ │
│ │ │ │ │ │ │
┌───┴────────▼─────────▼─────┴──────────────┐ │ │ │
hardReset│ │ │ │ │
[1]────► packetkmuxer & HRESET ├──┘ │ │
────► packetkmuxer & HRESET ├──┘ │ │
│ │ │ │
└───────────────────┬────────▲──────────────┘◄────────────┤ │
*muxerToNetwork│ │networkToMuxer shtdwn! │ │
┌─────[32]──────────▼────────┴──────────────┐ │ │
muxerToNetwork│ │networkToMuxer shtdwn! │ │
┌───────────────────▼────────┴──────────────┐ │ │
│ │ │ │
│ network I/O │◄────────────┤ │
│ │ shtdwn! │ │
└───────────────────────────────────────────┘ └──────────────┘
```


# Implementation and liveness analysis
In the layered architecture detailed above, there are 12 different goroutines
that deal with moving data across the stack, in 7 services:
tasked with moving data across the stack, in 6 services:
* 1. networkio: 2 workers (up/down).
* 2. packetmuxer: 2 workers (up/down).
* 3. reliabletransport: 2 workers (up/down).
* 4. controlchannel: 2 workers (up/down).
* 5. tlssession: 1 worker
* 6. datachannel: 3 workers (up/down/key).
* networkio: 2 workers (up/down).
* packetmuxer: 2 workers (up/down).
* reliabletransport: 2 workers (up/down).
* controlchannel: 2 workers (up/down).
* tlssession: 1 worker
* datachannel: 3 workers (up/down/key).
The `TUN` abstraction reads and writes to the `tunUp` and `tunDown` channels; TUN user is responsible for dialing the connection and passing a `networkio.FramingConn` to the `tun.StartTUN()` constructor. The TUN constructor will own the conn, and will also start an internal session.Manager and workers.Manager to deal with service coordination.
The channel communication is designed to be blocking, with unbuffered channels.
The channel communication between services is designed to be blocking, with unbuffered channels.
```mermaid
stateDiagram-v2
Expand Down

0 comments on commit d2fe46c

Please sign in to comment.