You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
And there's a special version for windows to support Tap devices: `-Dvfd=windows`, however the normal fds and event loop are stll based on jdk selector channel.
119
+
And there's a special version for windows to support Tap devices: `-Dvfd=windows`, however the normal fds and event loop are still based on jdk selector channel.
122
120
123
121
```
124
122
make vfdwindows
@@ -199,7 +197,7 @@ Current available ui tools:
199
197
200
198
## Aim
201
199
202
-
* Zero dependency: no dependency other than java and kotlin standard library.
200
+
* Zero dependency: all dependencies are implemented in vproxy subprojects.
203
201
* Simple: keep code simple and clear.
204
202
* Modifiable when running: no need to reload for configuration update.
205
203
* Fast: performance is one of our main priorities.
@@ -329,9 +327,7 @@ See [command.md](https://github.com/wkgcass/vproxy/blob/master/doc/command.md) a
329
327
330
328
*[how-to-use.md](https://github.com/wkgcass/vproxy/blob/master/doc/how-to-use.md): How to use config file and controllers.
331
329
*[api.yaml](https://github.com/wkgcass/vproxy/blob/dev/doc/api.yaml): api doc for http-controller in swagger format.
Copy file name to clipboardexpand all lines: doc/architecture.md
+51-13
Original file line number
Diff line number
Diff line change
@@ -10,34 +10,39 @@ Everything is based on `FD` and `Selector`.
10
10
11
11
#### FD
12
12
13
-
FD is an abstraction for jdk channel or os fds. With the help of FDs, we can easily change the whole network stack without touching the upper level code. For example you can use (almost) all functionalities when you switch to the `F-Stack` fd implementation.
13
+
FD is an abstraction for jdk channel or os fds. With the help of FDs, we can easily change the whole network stack without touching the upper level code. For example you can use all functionalities when you switch to the `vfdposix` fd implementation.
14
14
15
15
Also it makes it easy to write ARQ protocols based on UDP, and wrap them into `TCP-like` API, and plug into the vproxy system. For example you can use the KCP FDs impl just like using a normal TCP channel.
16
16
17
+
#### FDSelector
18
+
19
+
A wrapper for selector, epoll, kqueue etc. It encapsulates core functionality related to the low level API.
20
+
Also provides a general `virtual` fd implementation, the upper level code don't have to care whether it's a real fd or virtual fd.
21
+
17
22
#### SelectorEventLoop
18
23
19
-
We first built the `SelectorEventLoop`. It provides a common callback handler wrapper for `Channel` events. Also the loop can handle time events, which is based on `selector.select(timeout)`.
24
+
It provides a common callback handler wrapper for `Channel` events. Also the loop can handle time events, which is based on `selector.select(timeout)`.
20
25
You may consider it in the same position as libae in redis.
21
26
22
27
#### NetEventLoop
23
28
24
-
Then we built `NetEventLoop` based on `SelectorEventLoop`, and provided a few wrappers for `SocketChannel`s, as you can see from the architecture figure. This makes network related coding easy and simple.
29
+
The `NetEventLoop` is based on `SelectorEventLoop`, and provided a few wrappers for `SocketChannel`s, as you can see from the architecture figure. This makes network related coding easy and simple.
25
30
Also, vproxy provides a `RingBuffer` (in util package, used in almost every component), which can write and read at the same time. The network handling is simple: you write into output buffer, then the lib writes that data to channel; when reading is possible, the lib calls your readable callback and you can read data from the input buffer.
26
31
27
-
We start to build the lb part after having these two event loops.
32
+
We start to build the lb part after having these event loops.
28
33
29
34
#### Proxy
30
35
31
36
The `Proxy` can accept connections, dispatch the connections on different loops, create connections to some remote endpoints, and then proxy the network data.
32
-
The accept eventloop, handle eventloop (for handling connections), which backend to use, are all configurable and can be changed when running.
37
+
The acceptor eventloop, worker eventloop (for handling connections), which backend to use, are all configurable and can be changed when running.
33
38
34
39
#### EventLoopWrapper
35
40
36
41
`EventLoopWrapper` is nothing more than a wrapper for NetEventLoop. It keeps registered channel data for statistics and management. Also it can bind resources, which will be alerted on removal or when event loop ends.
37
42
38
43
#### EventLoopGroup
39
44
40
-
`EventLoopGroup` contains multiple `EventLoopWrapper`. Also it can bind resources, just like `EventLoopWrapper`. It provides a `next()` method to retrive the next running event loop. The method of selecting event loop is always RR.
45
+
`EventLoopGroup` contains multiple `EventLoopWrapper`. Also it can bind resources, just like `EventLoopWrapper`. It provides a `next()` method to retrieve the next running event loop. The method of selecting event loop is always RR.
41
46
42
47
#### ConnectClient
43
48
@@ -61,6 +66,42 @@ These are the main functionalities that vproxy main program provides.
61
66
62
67
`TcpLB` listens on a port and does loadbalancing for TCP based protocols (e.g. HTTP). You can create multiple `TcpLB`s if you want to listen on multiple ports. `Socks5Server` is almost the same as `TcpLB` but it runs socks5 protocol and proxies netflow to client specified backend.
63
68
69
+
#### DNSServer
70
+
71
+
It provides basic DNS server functionalities: resolving `A|AAAA|SRV` records, based on information recorded in the `upstream`, or recursively request other DNS servers if configured.
72
+
73
+
### SDN
74
+
75
+
The project provides a SDN virtual switch with a complete TCP/IP stack. It allows you to forward, route, nat and handle packets.
76
+
77
+
#### Switch
78
+
79
+
The SDN virtual switch is provided with the `switch` resource.
80
+
81
+
#### VirtualNetwork
82
+
83
+
A virtual network inside the switch. The name of the VPC is a number which usually represents the VLan or VNI of the network.
84
+
85
+
Inside the network, you can configure ips, route tables. You can also handle packets programmatically or with the flow generator.
86
+
87
+
#### IFace
88
+
89
+
The network interface encapsulation. The base class makes it very easy to implement new netif for the switch.
90
+
There are a bunch of `IFace` implementations, e.g. `tap, tun, xdp, vxlan, vlan, ...`
91
+
92
+
The `iface` belongs to `switch`, but should be attached to a virtual network.
93
+
94
+
#### Node
95
+
96
+
The concept comes from VPP. Each node is one step inside the network stack, and each node decides which node should the packet be sent to.
97
+
A inspecting command is provided to observe the packet traveling routine, in case of debugging.
98
+
99
+
#### PacketFilter
100
+
101
+
A packet filter hook on `iface` ingress/egress. It can pass, drop, modify packets, and can even re-inject the packet to a specific node.
102
+
103
+
The flow generator is implemented with `PacketFilter`.
104
+
64
105
### Control Plane
65
106
66
107
VProxy will create a event loop named `ControlEventLoop` for controlling operations. All quick operations will be operated on this event loop, some operations that might take a very long time will be operated on new threads.
@@ -79,15 +120,12 @@ VProxy provides you with multiple ways of configuring the vproxy instance.
79
120
80
121
`HTTPController` creates an HTTP server that exposes RESTful json api to manage the vproxy instance.
81
122
82
-
### Service Mesh
83
-
84
-
VProxy provides the ability of service discovery and can act as a sidecar.
85
-
You may use the combination of `TcpLB`, `Socks5Server`, `SmartGroupDelegate` and `SmartNodeDelegate` to build any role inside a mesh.
86
-
87
123
### Library
88
124
89
-
With all above functionalities, vproxy wraps some of them and provides libraries with light weight API.
125
+
With all above functionalities, vproxy wraps some of them and provides libraries with lightweight API.
126
+
127
+
A netty and vertx eventloop and socket implementation is provided, makes it much easier to reuse netty features.
90
128
91
129
### Application
92
130
93
-
Besides acting as a loadbalancer, vproxy provides some other network related tools, for example you may use the WebSocksProxyAgent/Server to build a tunnel through fireware.
131
+
Besides core functionalities, vproxy provides some other network related tools, for example you may use the WebSocksProxyAgent/Server to build a tunnel through firewalls.
0 commit comments