perf: websocket grid connectivity for all internode communication (#18461)
This PR adds a WebSocket grid feature that allows servers to communicate via
a single two-way connection.
There are two request types:
* Single requests, which are `[]byte => ([]byte, error)`. This is for efficient small
roundtrips with small payloads.
* Streaming requests which are `[]byte, chan []byte => chan []byte (and error)`,
which allows for different combinations of full two-way streams with an initial payload.
Only a single stream is created between two machines - and there is, as such, no
server/client relation since both sides can initiate and handle requests. Which server
initiates the request is decided deterministically on the server names.
Requests are made through a mux client and server, which handles message
passing, congestion, cancelation, timeouts, etc.
If a connection is lost, all requests are canceled, and the calling server will try
to reconnect. Registered handlers can operate directly on byte
slices or use a higher-level generics abstraction.
There is no versioning of handlers/clients, and incompatible changes should
be handled by adding new handlers.
The request path can be changed to a new one for any protocol changes.
First, all servers create a "Manager." The manager must know its address
as well as all remote addresses. This will manage all connections.
To get a connection to any remote, ask the manager to provide it given
the remote address using.
```
func (m *Manager) Connection(host string) *Connection
```
All serverside handlers must also be registered on the manager. This will
make sure that all incoming requests are served. The number of in-flight
requests and responses must also be given for streaming requests.
The "Connection" returned manages the mux-clients. Requests issued
to the connection will be sent to the remote.
* `func (c *Connection) Request(ctx context.Context, h HandlerID, req []byte) ([]byte, error)`
performs a single request and returns the result. Any deadline provided on the request is
forwarded to the server, and canceling the context will make the function return at once.
* `func (c *Connection) NewStream(ctx context.Context, h HandlerID, payload []byte) (st *Stream, err error)`
will initiate a remote call and send the initial payload.
```Go
// A Stream is a two-way stream.
// All responses *must* be read by the caller.
// If the call is canceled through the context,
//The appropriate error will be returned.
type Stream struct {
// Responses from the remote server.
// Channel will be closed after an error or when the remote closes.
// All responses *must* be read by the caller until either an error is returned or the channel is closed.
// Canceling the context will cause the context cancellation error to be returned.
Responses <-chan Response
// Requests sent to the server.
// If the handler is defined with 0 incoming capacity this will be nil.
// Channel *must* be closed to signal the end of the stream.
// If the request context is canceled, the stream will no longer process requests.
Requests chan<- []byte
}
type Response struct {
Msg []byte
Err error
}
```
There are generic versions of the server/client handlers that allow the use of type
safe implementations for data types that support msgpack marshal/unmarshal.
2023-11-21 09:09:35 +08:00
|
|
|
// Code generated by github.com/tinylib/msgp DO NOT EDIT.
|
|
|
|
|
|
2025-09-29 04:59:21 +08:00
|
|
|
package cmd
|
|
|
|
|
|
perf: websocket grid connectivity for all internode communication (#18461)
This PR adds a WebSocket grid feature that allows servers to communicate via
a single two-way connection.
There are two request types:
* Single requests, which are `[]byte => ([]byte, error)`. This is for efficient small
roundtrips with small payloads.
* Streaming requests which are `[]byte, chan []byte => chan []byte (and error)`,
which allows for different combinations of full two-way streams with an initial payload.
Only a single stream is created between two machines - and there is, as such, no
server/client relation since both sides can initiate and handle requests. Which server
initiates the request is decided deterministically on the server names.
Requests are made through a mux client and server, which handles message
passing, congestion, cancelation, timeouts, etc.
If a connection is lost, all requests are canceled, and the calling server will try
to reconnect. Registered handlers can operate directly on byte
slices or use a higher-level generics abstraction.
There is no versioning of handlers/clients, and incompatible changes should
be handled by adding new handlers.
The request path can be changed to a new one for any protocol changes.
First, all servers create a "Manager." The manager must know its address
as well as all remote addresses. This will manage all connections.
To get a connection to any remote, ask the manager to provide it given
the remote address using.
```
func (m *Manager) Connection(host string) *Connection
```
All serverside handlers must also be registered on the manager. This will
make sure that all incoming requests are served. The number of in-flight
requests and responses must also be given for streaming requests.
The "Connection" returned manages the mux-clients. Requests issued
to the connection will be sent to the remote.
* `func (c *Connection) Request(ctx context.Context, h HandlerID, req []byte) ([]byte, error)`
performs a single request and returns the result. Any deadline provided on the request is
forwarded to the server, and canceling the context will make the function return at once.
* `func (c *Connection) NewStream(ctx context.Context, h HandlerID, payload []byte) (st *Stream, err error)`
will initiate a remote call and send the initial payload.
```Go
// A Stream is a two-way stream.
// All responses *must* be read by the caller.
// If the call is canceled through the context,
//The appropriate error will be returned.
type Stream struct {
// Responses from the remote server.
// Channel will be closed after an error or when the remote closes.
// All responses *must* be read by the caller until either an error is returned or the channel is closed.
// Canceling the context will cause the context cancellation error to be returned.
Responses <-chan Response
// Requests sent to the server.
// If the handler is defined with 0 incoming capacity this will be nil.
// Channel *must* be closed to signal the end of the stream.
// If the request context is canceled, the stream will no longer process requests.
Requests chan<- []byte
}
type Response struct {
Msg []byte
Err error
}
```
There are generic versions of the server/client handlers that allow the use of type
safe implementations for data types that support msgpack marshal/unmarshal.
2023-11-21 09:09:35 +08:00
|
|
|
import (
|
|
|
|
|
"github.com/tinylib/msgp/msgp"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// DecodeMsg implements msgp.Decodable
|
|
|
|
|
func (z *nsScannerOptions) DecodeMsg(dc *msgp.Reader) (err error) {
|
|
|
|
|
var field []byte
|
|
|
|
|
_ = field
|
|
|
|
|
var zb0001 uint32
|
|
|
|
|
zb0001, err = dc.ReadMapHeader()
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
for zb0001 > 0 {
|
|
|
|
|
zb0001--
|
|
|
|
|
field, err = dc.ReadMapKeyPtr()
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
switch msgp.UnsafeString(field) {
|
|
|
|
|
case "id":
|
|
|
|
|
z.DiskID, err = dc.ReadString()
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "DiskID")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
case "m":
|
|
|
|
|
z.ScanMode, err = dc.ReadInt()
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "ScanMode")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
case "c":
|
|
|
|
|
if dc.IsNil() {
|
|
|
|
|
err = dc.ReadNil()
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Cache")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
z.Cache = nil
|
|
|
|
|
} else {
|
|
|
|
|
if z.Cache == nil {
|
|
|
|
|
z.Cache = new(dataUsageCache)
|
|
|
|
|
}
|
|
|
|
|
err = z.Cache.DecodeMsg(dc)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Cache")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
default:
|
|
|
|
|
err = dc.Skip()
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// EncodeMsg implements msgp.Encodable
|
|
|
|
|
func (z *nsScannerOptions) EncodeMsg(en *msgp.Writer) (err error) {
|
|
|
|
|
// map header, size 3
|
|
|
|
|
// write "id"
|
|
|
|
|
err = en.Append(0x83, 0xa2, 0x69, 0x64)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
err = en.WriteString(z.DiskID)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "DiskID")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
// write "m"
|
|
|
|
|
err = en.Append(0xa1, 0x6d)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
err = en.WriteInt(z.ScanMode)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "ScanMode")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
// write "c"
|
|
|
|
|
err = en.Append(0xa1, 0x63)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
if z.Cache == nil {
|
|
|
|
|
err = en.WriteNil()
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
err = z.Cache.EncodeMsg(en)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Cache")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// MarshalMsg implements msgp.Marshaler
|
|
|
|
|
func (z *nsScannerOptions) MarshalMsg(b []byte) (o []byte, err error) {
|
|
|
|
|
o = msgp.Require(b, z.Msgsize())
|
|
|
|
|
// map header, size 3
|
|
|
|
|
// string "id"
|
|
|
|
|
o = append(o, 0x83, 0xa2, 0x69, 0x64)
|
|
|
|
|
o = msgp.AppendString(o, z.DiskID)
|
|
|
|
|
// string "m"
|
|
|
|
|
o = append(o, 0xa1, 0x6d)
|
|
|
|
|
o = msgp.AppendInt(o, z.ScanMode)
|
|
|
|
|
// string "c"
|
|
|
|
|
o = append(o, 0xa1, 0x63)
|
|
|
|
|
if z.Cache == nil {
|
|
|
|
|
o = msgp.AppendNil(o)
|
|
|
|
|
} else {
|
|
|
|
|
o, err = z.Cache.MarshalMsg(o)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Cache")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// UnmarshalMsg implements msgp.Unmarshaler
|
|
|
|
|
func (z *nsScannerOptions) UnmarshalMsg(bts []byte) (o []byte, err error) {
|
|
|
|
|
var field []byte
|
|
|
|
|
_ = field
|
|
|
|
|
var zb0001 uint32
|
|
|
|
|
zb0001, bts, err = msgp.ReadMapHeaderBytes(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
for zb0001 > 0 {
|
|
|
|
|
zb0001--
|
|
|
|
|
field, bts, err = msgp.ReadMapKeyZC(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
switch msgp.UnsafeString(field) {
|
|
|
|
|
case "id":
|
|
|
|
|
z.DiskID, bts, err = msgp.ReadStringBytes(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "DiskID")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
case "m":
|
|
|
|
|
z.ScanMode, bts, err = msgp.ReadIntBytes(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "ScanMode")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
case "c":
|
|
|
|
|
if msgp.IsNil(bts) {
|
|
|
|
|
bts, err = msgp.ReadNilBytes(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
z.Cache = nil
|
|
|
|
|
} else {
|
|
|
|
|
if z.Cache == nil {
|
|
|
|
|
z.Cache = new(dataUsageCache)
|
|
|
|
|
}
|
|
|
|
|
bts, err = z.Cache.UnmarshalMsg(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Cache")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
default:
|
|
|
|
|
bts, err = msgp.Skip(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
o = bts
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message
|
|
|
|
|
func (z *nsScannerOptions) Msgsize() (s int) {
|
|
|
|
|
s = 1 + 3 + msgp.StringPrefixSize + len(z.DiskID) + 2 + msgp.IntSize + 2
|
|
|
|
|
if z.Cache == nil {
|
|
|
|
|
s += msgp.NilSize
|
|
|
|
|
} else {
|
|
|
|
|
s += z.Cache.Msgsize()
|
|
|
|
|
}
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// DecodeMsg implements msgp.Decodable
|
|
|
|
|
func (z *nsScannerResp) DecodeMsg(dc *msgp.Reader) (err error) {
|
|
|
|
|
var field []byte
|
|
|
|
|
_ = field
|
|
|
|
|
var zb0001 uint32
|
|
|
|
|
zb0001, err = dc.ReadMapHeader()
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
for zb0001 > 0 {
|
|
|
|
|
zb0001--
|
|
|
|
|
field, err = dc.ReadMapKeyPtr()
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
switch msgp.UnsafeString(field) {
|
|
|
|
|
case "u":
|
|
|
|
|
if dc.IsNil() {
|
|
|
|
|
err = dc.ReadNil()
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Update")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
z.Update = nil
|
|
|
|
|
} else {
|
|
|
|
|
if z.Update == nil {
|
|
|
|
|
z.Update = new(dataUsageEntry)
|
|
|
|
|
}
|
|
|
|
|
err = z.Update.DecodeMsg(dc)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Update")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
case "f":
|
|
|
|
|
if dc.IsNil() {
|
|
|
|
|
err = dc.ReadNil()
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Final")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
z.Final = nil
|
|
|
|
|
} else {
|
|
|
|
|
if z.Final == nil {
|
|
|
|
|
z.Final = new(dataUsageCache)
|
|
|
|
|
}
|
|
|
|
|
err = z.Final.DecodeMsg(dc)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Final")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
default:
|
|
|
|
|
err = dc.Skip()
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// EncodeMsg implements msgp.Encodable
|
|
|
|
|
func (z *nsScannerResp) EncodeMsg(en *msgp.Writer) (err error) {
|
|
|
|
|
// map header, size 2
|
|
|
|
|
// write "u"
|
|
|
|
|
err = en.Append(0x82, 0xa1, 0x75)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
if z.Update == nil {
|
|
|
|
|
err = en.WriteNil()
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
err = z.Update.EncodeMsg(en)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Update")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
// write "f"
|
|
|
|
|
err = en.Append(0xa1, 0x66)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
if z.Final == nil {
|
|
|
|
|
err = en.WriteNil()
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
err = z.Final.EncodeMsg(en)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Final")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// MarshalMsg implements msgp.Marshaler
|
|
|
|
|
func (z *nsScannerResp) MarshalMsg(b []byte) (o []byte, err error) {
|
|
|
|
|
o = msgp.Require(b, z.Msgsize())
|
|
|
|
|
// map header, size 2
|
|
|
|
|
// string "u"
|
|
|
|
|
o = append(o, 0x82, 0xa1, 0x75)
|
|
|
|
|
if z.Update == nil {
|
|
|
|
|
o = msgp.AppendNil(o)
|
|
|
|
|
} else {
|
|
|
|
|
o, err = z.Update.MarshalMsg(o)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Update")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
// string "f"
|
|
|
|
|
o = append(o, 0xa1, 0x66)
|
|
|
|
|
if z.Final == nil {
|
|
|
|
|
o = msgp.AppendNil(o)
|
|
|
|
|
} else {
|
|
|
|
|
o, err = z.Final.MarshalMsg(o)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Final")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// UnmarshalMsg implements msgp.Unmarshaler
|
|
|
|
|
func (z *nsScannerResp) UnmarshalMsg(bts []byte) (o []byte, err error) {
|
|
|
|
|
var field []byte
|
|
|
|
|
_ = field
|
|
|
|
|
var zb0001 uint32
|
|
|
|
|
zb0001, bts, err = msgp.ReadMapHeaderBytes(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
for zb0001 > 0 {
|
|
|
|
|
zb0001--
|
|
|
|
|
field, bts, err = msgp.ReadMapKeyZC(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
switch msgp.UnsafeString(field) {
|
|
|
|
|
case "u":
|
|
|
|
|
if msgp.IsNil(bts) {
|
|
|
|
|
bts, err = msgp.ReadNilBytes(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
z.Update = nil
|
|
|
|
|
} else {
|
|
|
|
|
if z.Update == nil {
|
|
|
|
|
z.Update = new(dataUsageEntry)
|
|
|
|
|
}
|
|
|
|
|
bts, err = z.Update.UnmarshalMsg(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Update")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
case "f":
|
|
|
|
|
if msgp.IsNil(bts) {
|
|
|
|
|
bts, err = msgp.ReadNilBytes(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
z.Final = nil
|
|
|
|
|
} else {
|
|
|
|
|
if z.Final == nil {
|
|
|
|
|
z.Final = new(dataUsageCache)
|
|
|
|
|
}
|
|
|
|
|
bts, err = z.Final.UnmarshalMsg(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err, "Final")
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
default:
|
|
|
|
|
bts, err = msgp.Skip(bts)
|
|
|
|
|
if err != nil {
|
|
|
|
|
err = msgp.WrapError(err)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
o = bts
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message
|
|
|
|
|
func (z *nsScannerResp) Msgsize() (s int) {
|
|
|
|
|
s = 1 + 2
|
|
|
|
|
if z.Update == nil {
|
|
|
|
|
s += msgp.NilSize
|
|
|
|
|
} else {
|
|
|
|
|
s += z.Update.Msgsize()
|
|
|
|
|
}
|
|
|
|
|
s += 2
|
|
|
|
|
if z.Final == nil {
|
|
|
|
|
s += msgp.NilSize
|
|
|
|
|
} else {
|
|
|
|
|
s += z.Final.Msgsize()
|
|
|
|
|
}
|
|
|
|
|
return
|
|
|
|
|
}
|