Repository navigation
Expand file tree
/
Copy pathmsg.go
More file actions
281 lines (236 loc) · 7.16 KB
/
Copy pathmsg.go
File metadata and controls
281 lines (236 loc) · 7.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
// Copyright (c) 2015-2023 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package grid
import (
"encoding/binary"
"fmt"
"strings"
"github.com/tinylib/msgp/msgp"
"github.com/zeebo/xxh3"
)
// Op is operation type.
//
//go:generate msgp -unexported -file=$GOFILE
//go:generate stringer -type=Op -output=msg_string.go -trimprefix=Op $GOFILE
// Op is operation type messages.
type Op uint8
// HandlerID is the ID for the handler of a specific type.
type HandlerID uint8
const (
// OpConnect is a connect request.
OpConnect Op = iota + 1
// OpConnectResponse is a response to a connect request.
OpConnectResponse
// OpPing is a ping request.
// If a mux id is specified that mux is pinged.
// Clients sends ping requests.
OpPing
// OpPong is a OpPing response returned by the server.
OpPong
// OpConnectMux will connect a new mux with optional payload.
OpConnectMux
// OpMuxConnectError is an error while connecting a mux.
OpMuxConnectError
// OpDisconnectClientMux instructs a client to disconnect a mux
OpDisconnectClientMux
// OpDisconnectServerMux instructs a server to disconnect (cancel) a server mux
OpDisconnectServerMux
// OpMuxClientMsg contains a message to a client Mux
OpMuxClientMsg
// OpMuxServerMsg contains a message to a server Mux
OpMuxServerMsg
// OpUnblockSrvMux contains a message that a server mux is unblocked with one.
// Only Stateful streams has flow control.
OpUnblockSrvMux
// OpUnblockClMux contains a message that a client mux is unblocked with one.
// Only Stateful streams has flow control.
OpUnblockClMux
// OpAckMux acknowledges a mux was created.
OpAckMux
// OpRequest is a single request + response.
// MuxID is returned in response.
OpRequest
// OpResponse is a response to a single request.
// FlagPayloadIsErr is used to signify that the payload is a string error converted to byte slice.
// When a response is received, the mux is already removed from the remote.
OpResponse
// OpDisconnect instructs that remote wants to disconnect
OpDisconnect
// OpMerged is several operations merged into one.
OpMerged
)
const (
// FlagCRCxxh3 indicates that, the lower 32 bits of xxhash3 of the serialized
// message will be sent after the serialized message as little endian.
FlagCRCxxh3 Flags = 1 << iota
// FlagEOF the stream (either direction) is at EOF.
FlagEOF
// FlagStateless indicates the message is stateless.
// This will retain clients across reconnections or
// if sequence numbers are unexpected.
FlagStateless
// FlagPayloadIsErr can be used by individual ops to signify that
// The payload is a string error converted to byte slice.
FlagPayloadIsErr
// FlagPayloadIsZero means that payload is 0-length slice and not nil.
FlagPayloadIsZero
// FlagSubroute indicates that the message has subroute.
// Subroute will be 32 bytes long and added before any CRC.
FlagSubroute
)
// This struct cannot be changed and retain backwards compatibility.
// If changed, endpoint version must be bumped.
//
//msgp:tuple message
type message struct {
MuxID uint64 // Mux to receive message if any.
Seq uint32 // Sequence number.
DeadlineMS uint32 // If non-zero, milliseconds until deadline (max 1193h2m47.295s, ~49 days)
Handler HandlerID // ID of handler if invoking a remote handler.
Op Op // Operation. Other fields change based on this value.
Flags Flags // Optional flags.
Payload []byte // Optional payload.
}
// Flags is a set of flags set on a message.
type Flags uint8
func (m message) String() string {
var res []string
if m.MuxID != 0 {
res = append(res, fmt.Sprintf("MuxID: %v", m.MuxID))
}
if m.Seq != 0 {
res = append(res, fmt.Sprintf("Seq: %v", m.Seq))
}
if m.DeadlineMS != 0 {
res = append(res, fmt.Sprintf("Deadline: %vms", m.DeadlineMS))
}
if m.Handler != handlerInvalid {
res = append(res, fmt.Sprintf("Handler: %v", m.Handler))
}
if m.Op != 0 {
res = append(res, fmt.Sprintf("Op: %v", m.Op))
}
res = append(res, fmt.Sprintf("Flags: %s", m.Flags.String()))
if len(m.Payload) != 0 {
res = append(res, fmt.Sprintf("Payload: %v", bytesOrLength(m.Payload)))
}
return "{" + strings.Join(res, ", ") + "}"
}
func (f Flags) String() string {
var res []string
if f&FlagCRCxxh3 != 0 {
res = append(res, "CRC")
}
if f&FlagEOF != 0 {
res = append(res, "EOF")
}
if f&FlagStateless != 0 {
res = append(res, "SL")
}
if f&FlagPayloadIsErr != 0 {
res = append(res, "ERR")
}
if f&FlagPayloadIsZero != 0 {
res = append(res, "ZERO")
}
if f&FlagSubroute != 0 {
res = append(res, "SUB")
}
return "[" + strings.Join(res, ",") + "]"
}
// parse an handleIncoming message.
func (m *message) parse(b []byte) (*subHandlerID, []byte, error) {
var sub *subHandlerID
if m.Payload == nil {
m.Payload = GetByteBuffer()[:0]
}
h, err := m.UnmarshalMsg(b)
if err != nil {
return nil, nil, fmt.Errorf("read write: %v", err)
}
if len(m.Payload) == 0 && m.Flags&FlagPayloadIsZero == 0 {
PutByteBuffer(m.Payload)
m.Payload = nil
}
if m.Flags&FlagCRCxxh3 != 0 {
const hashLen = 4
if len(h) < hashLen {
return nil, nil, fmt.Errorf("want crc len 4, got %v", len(h))
}
got := uint32(xxh3.Hash(b[:len(b)-hashLen]))
want := binary.LittleEndian.Uint32(h[len(h)-hashLen:])
if got != want {
return nil, nil, fmt.Errorf("crc mismatch: 0x%08x (given) != 0x%08x (bytes)", want, got)
}
h = h[:len(h)-hashLen]
}
// Extract subroute if any.
if m.Flags&FlagSubroute != 0 {
if len(h) < 32 {
return nil, nil, fmt.Errorf("want subroute len 32, got %v", len(h))
}
subID := (*[32]byte)(h[len(h)-32:])
sub = (*subHandlerID)(subID)
// Add if more modifications to h is needed
h = h[:len(h)-32]
}
return sub, h, nil
}
// setZeroPayloadFlag will clear or set the FlagPayloadIsZero if
// m.Payload is length 0, but not nil.
func (m *message) setZeroPayloadFlag() {
m.Flags &^= FlagPayloadIsZero
if len(m.Payload) == 0 && m.Payload != nil {
m.Flags |= FlagPayloadIsZero
}
}
type receiver interface {
msgp.Unmarshaler
Op() Op
}
type sender interface {
msgp.MarshalSizer
Op() Op
}
type connectReq struct {
ID [16]byte
Host string
}
func (connectReq) Op() Op {
return OpConnect
}
type connectResp struct {
ID [16]byte
Accepted bool
RejectedReason string
}
func (connectResp) Op() Op {
return OpConnectResponse
}
type muxConnectError struct {
Error string
}
func (muxConnectError) Op() Op {
return OpMuxConnectError
}
type pongMsg struct {
NotFound bool `msg:"f"`
Err *string `msg:"e,allownil"`
}
func (pongMsg) Op() Op {
return OpPong
}