-
Notifications
You must be signed in to change notification settings - Fork 106
/
message.go
513 lines (454 loc) · 13.5 KB
/
message.go
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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
package nsqd
import (
"encoding/binary"
"errors"
"fmt"
"io"
"sync/atomic"
"time"
"github.com/youzan/nsq/internal/ext"
)
const (
MsgIDLength = 16
MsgTraceIDLength = 8
MsgJsonHeaderLength = 2
minValidMsgLength = MsgIDLength + 8 + 2 // Timestamp + Attempts
MaxAttempts = 4000
extMsgHighBits = 0xa000
)
// the new message total id will be ID+TraceID, the length is same with old id
// slice, the traceid only used for trace for business, the ID is used for internal.
// In order to be compatible with old format, we keep the attempts field.
type FullMessageID [MsgIDLength]byte
type MessageID uint64
func GetMessageIDFromFullMsgID(id FullMessageID) MessageID {
return MessageID(binary.BigEndian.Uint64(id[:8]))
}
func GetTraceIDFromFullMsgID(id FullMessageID) uint64 {
return binary.BigEndian.Uint64(id[8 : 8+MsgTraceIDLength])
}
func PrintMessage(m *Message) string {
return fmt.Sprintf("%v %v %s %v %v %v %v %v %v %v %v %v",
m.ID, m.TraceID, string(m.Body), m.Timestamp, m.Attempts, m.deliveryTS,
m.pri, m.index, m.deferredCnt, m.Offset, m.RawMoveSize, m.queueCntIndex)
}
func PrintMessageNoBody(m *Message) string {
return fmt.Sprintf("%v %v %v %v %v %v %v %v %v %v %v",
m.ID, m.TraceID, m.Timestamp, m.Attempts, m.deliveryTS,
m.pri, m.index, m.deferredCnt, m.Offset, m.RawMoveSize, m.queueCntIndex)
}
type Message struct {
ID MessageID
TraceID uint64
Body []byte
Timestamp int64
Attempts uint16
ExtBytes []byte
ExtVer ext.ExtVer
// for in-flight handling
deliveryTS time.Time
//clientID int64
belongedConsumer Consumer
pri int64
index int
deferredCnt int32
//for backend queue
Offset BackendOffset
RawMoveSize BackendOffset
queueCntIndex int64
// for delayed queue message
// 1 - delayed message by channel
// 2 - delayed pub
//
DelayedType int32
DelayedTs int64
DelayedOrigID MessageID
DelayedChannel string
// will be used for delayed pub. (json data to tell different type of delay)
DelayedData []byte
}
func MessageHeaderBytes() int {
return MsgIDLength + 8 + 2
}
func NewMessageWithExt(id MessageID, body []byte, extVer ext.ExtVer, extBytes []byte) *Message {
return &Message{
ID: id,
TraceID: 0,
ExtVer: extVer,
ExtBytes: extBytes,
Body: body,
Timestamp: time.Now().UnixNano(),
}
}
func NewMessage(id MessageID, body []byte) *Message {
return &Message{
ID: id,
TraceID: 0,
Body: body,
Timestamp: time.Now().UnixNano(),
}
}
func NewMessageWithTs(id MessageID, body []byte, ts int64) *Message {
return &Message{
ID: id,
TraceID: 0,
Body: body,
Timestamp: ts,
}
}
func (m *Message) GetFullMsgID() FullMessageID {
var buf FullMessageID
binary.BigEndian.PutUint64(buf[:8], uint64(m.ID))
binary.BigEndian.PutUint64(buf[8:8+MsgTraceIDLength], uint64(m.TraceID))
return buf
}
func (m *Message) IsDeferred() bool {
return atomic.LoadInt32(&m.deferredCnt) > 0
}
func (m *Message) GetCopy() *Message {
newMsg := *m
newMsg.Body = make([]byte, len(m.Body))
copy(newMsg.Body, m.Body)
if m.ExtBytes != nil {
newMsg.ExtBytes = make([]byte, len(m.ExtBytes))
copy(newMsg.ExtBytes, m.ExtBytes)
}
if m.DelayedData != nil {
newMsg.DelayedData = make([]byte, len(m.DelayedData))
copy(newMsg.DelayedData, m.DelayedData)
}
return &newMsg
}
func (m *Message) GetClientID() int64 {
if m.belongedConsumer != nil {
return m.belongedConsumer.GetID()
}
return 0
}
func (m *Message) WriteToClient(w io.Writer, writeExt bool, writeDetail bool) (int64, error) {
// for client, we no need write the compatible version info to message
return m.internalWriteTo(w, writeExt, false, writeDetail)
}
func (m *Message) WriteTo(w io.Writer, writeExt bool) (int64, error) {
return m.internalWriteTo(w, writeExt, true, false)
}
func (m *Message) internalWriteTo(w io.Writer, writeExt bool, writeCompatible bool, writeDetail bool) (int64, error) {
var buf [16]byte
var total int64
binary.BigEndian.PutUint64(buf[:8], uint64(m.Timestamp))
if m.Attempts > MaxAttempts {
m.Attempts = MaxAttempts
}
combined := m.Attempts
if writeExt && writeCompatible {
combined += uint16(extMsgHighBits)
}
binary.BigEndian.PutUint16(buf[8:10], combined)
n, err := w.Write(buf[:10])
total += int64(n)
if err != nil {
return total, err
}
binary.BigEndian.PutUint64(buf[:8], uint64(m.ID))
binary.BigEndian.PutUint64(buf[8:8+MsgTraceIDLength], uint64(m.TraceID))
n, err = w.Write(buf[:MsgIDLength])
total += int64(n)
if err != nil {
return total, err
}
//write ext content
if writeExt {
//write ext version
buf[0] = byte(m.ExtVer)
n, err = w.Write(buf[:1])
total += int64(n)
if err != nil {
return total, err
}
if m.ExtVer != ext.NO_EXT_VER {
if len(m.ExtBytes) >= ext.MaxExtLen {
return total, errors.New("extend data exceed the limit")
}
binary.BigEndian.PutUint16(buf[1:1+2], uint16(len(m.ExtBytes)))
n, err = w.Write(buf[1 : 1+2])
total += int64(n)
if err != nil {
return total, err
}
n, err = w.Write(m.ExtBytes)
total += int64(n)
if err != nil {
return total, err
}
}
}
if writeDetail {
binary.BigEndian.PutUint64(buf[:8], uint64(m.Offset))
binary.BigEndian.PutUint32(buf[8:8+4], uint32(m.RawMoveSize))
n, err = w.Write(buf[:8+4])
total += int64(n)
if err != nil {
return total, err
}
}
n, err = w.Write(m.Body)
total += int64(n)
if err != nil {
return total, err
}
return total, nil
}
func (m *Message) WriteDelayedTo(w io.Writer, writeExt bool) (int64, error) {
if m.Attempts > MaxAttempts {
m.Attempts = MaxAttempts
}
combined := m.Attempts
if writeExt {
combined += uint16(extMsgHighBits)
}
var buf [32]byte
var total int64
binary.BigEndian.PutUint64(buf[:8], uint64(m.Timestamp))
binary.BigEndian.PutUint16(buf[8:10], combined)
n, err := w.Write(buf[:10])
total += int64(n)
if err != nil {
return total, err
}
binary.BigEndian.PutUint64(buf[:8], uint64(m.ID))
binary.BigEndian.PutUint64(buf[8:8+MsgTraceIDLength], uint64(m.TraceID))
n, err = w.Write(buf[:MsgIDLength])
total += int64(n)
if err != nil {
return total, err
}
pos := 0
binary.BigEndian.PutUint32(buf[pos:pos+4], uint32(m.DelayedType))
pos += 4
binary.BigEndian.PutUint64(buf[pos:pos+8], uint64(m.DelayedTs))
pos += 8
binary.BigEndian.PutUint64(buf[pos:pos+8], uint64(m.DelayedOrigID))
pos += 8
binary.BigEndian.PutUint32(buf[pos:pos+4], uint32(len(m.DelayedChannel)))
pos += 4
n, err = w.Write(buf[:pos])
total += int64(n)
if err != nil {
return total, err
}
n, err = w.Write([]byte(m.DelayedChannel))
total += int64(n)
if err != nil {
return total, err
}
if m.DelayedType == PubDelayed {
binary.BigEndian.PutUint32(buf[:4], uint32(len(m.DelayedData)))
n, err = w.Write(buf[:4])
total += int64(n)
if err != nil {
return total, err
}
n, err = w.Write(m.DelayedData)
total += int64(n)
if err != nil {
return total, err
}
}
//write ext content
if writeExt {
//write ext version
buf[0] = byte(m.ExtVer)
n, err = w.Write(buf[:1])
total += int64(n)
if err != nil {
return total, err
}
if m.ExtVer != ext.NO_EXT_VER {
if len(m.ExtBytes) >= ext.MaxExtLen {
return total, errors.New("extend data exceed the limit")
}
binary.BigEndian.PutUint16(buf[:2], uint16(len(m.ExtBytes)))
n, err = w.Write(buf[:2])
total += int64(n)
if err != nil {
return total, err
}
n, err = w.Write(m.ExtBytes)
total += int64(n)
if err != nil {
return total, err
}
}
}
if m.DelayedType == ChannelDelayed {
// some data with original queue info
binary.BigEndian.PutUint64(buf[:8], uint64(m.Offset))
binary.BigEndian.PutUint32(buf[8:8+4], uint32(m.RawMoveSize))
n, err = w.Write(buf[:8+4])
total += int64(n)
if err != nil {
return total, err
}
}
n, err = w.Write(m.Body)
total += int64(n)
if err != nil {
return total, err
}
return total, nil
}
func DecodeMessage(b []byte, ext bool) (*Message, error) {
return decodeMessage(b, ext)
}
// note: the message body is using the origin buffer, so never modify the buffer after decode.
// decodeMessage deserializes data (as []byte) and creates a new Message
// message format:
// [x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x][x]...
// | (int64) || || (hex string encoded in ASCII) || (binary)
// | 8-byte || || 16-byte || N-byte
// ------------------------------------------------------------------------------------------...
// nanosecond timestamp ^^ message ID message body
// (uint16)
// 2-byte
// attempts
func decodeMessage(b []byte, isExt bool) (*Message, error) {
var msg Message
if len(b) < minValidMsgLength {
return nil, fmt.Errorf("invalid message buffer size (%d)", len(b))
}
msg.Timestamp = int64(binary.BigEndian.Uint64(b[:8]))
combined := binary.BigEndian.Uint16(b[8:10])
msg.ID = MessageID(binary.BigEndian.Uint64(b[10:18]))
msg.TraceID = binary.BigEndian.Uint64(b[18:26])
// we reused high 4-bits of attempts for message version to make it compatible with ext message and any other future change.
// there some cases
// 1. no ext topic, all high 4-bits should be 0
// 2. ext topic, during update some old message has all high 4-bits with 0, and new message should equal 0xa for ext.
// 3. do we need handle new message with ext but have all high 4-bits with 0?
// 4. do we need handle some old attempts which maybe exceed the MaxAttempts? (very small possible)
// 5. if any future change, hight 4-bits can be 0xb, 0xc, 0xd, 0xe (0x1~0x9 should be reserved for future)
var highBits uint16
if combined > MaxAttempts {
highBits = combined & uint16(0xF000)
msg.Attempts = combined & uint16(0x0FFF)
} else {
msg.Attempts = combined
}
bodyStart := 26
if highBits == extMsgHighBits && !isExt {
// may happened while upgrading and the channel read the new data while ext flag not setting
return nil, fmt.Errorf("invalid message, has the ext high bits but not decode as ext data: %v", b)
}
if isExt && highBits == extMsgHighBits {
if len(b) < 27 {
return nil, fmt.Errorf("invalid message buffer size (%d)", len(b))
}
extVer := ext.ExtVer(uint8(b[bodyStart]))
msg.ExtVer = extVer
switch extVer {
case ext.NO_EXT_VER:
msg.ExtVer = ext.NO_EXT_VER
bodyStart = 27
default:
if len(b) < 27+2 {
return nil, fmt.Errorf("invalid message buffer size (%d)", len(b))
}
extLen := binary.BigEndian.Uint16(b[27 : 27+2])
if len(b) < 27+2+int(extLen) {
return nil, fmt.Errorf("invalid message buffer size (%d)", len(b))
}
msg.ExtBytes = b[29 : 29+extLen]
bodyStart = 29 + int(extLen)
}
}
msg.Body = b[bodyStart:]
return &msg, nil
}
func DecodeDelayedMessage(b []byte, isExt bool) (*Message, error) {
var msg Message
if len(b) < minValidMsgLength {
return nil, fmt.Errorf("invalid message buffer size (%d)", len(b))
}
pos := 0
msg.Timestamp = int64(binary.BigEndian.Uint64(b[pos:8]))
pos += 8
combined := binary.BigEndian.Uint16(b[pos : pos+2])
pos += 2
msg.ID = MessageID(binary.BigEndian.Uint64(b[pos : pos+8]))
pos += 8
msg.TraceID = binary.BigEndian.Uint64(b[pos : pos+8])
pos += 8
if len(b) < minValidMsgLength+4+8+8+4 {
return nil, fmt.Errorf("invalid delayed message buffer size (%d)", len(b))
}
msg.DelayedType = int32(binary.BigEndian.Uint32(b[pos : pos+4]))
pos += 4
msg.DelayedTs = int64(binary.BigEndian.Uint64(b[pos : pos+8]))
pos += 8
msg.DelayedOrigID = MessageID(binary.BigEndian.Uint64(b[pos : pos+8]))
pos += 8
nameLen := binary.BigEndian.Uint32(b[pos : pos+4])
pos += 4
if len(b) < pos+int(nameLen) {
return nil, fmt.Errorf("invalid delayed message buffer size (%d)", len(b))
}
msg.DelayedChannel = string(b[pos : pos+int(nameLen)])
pos += int(nameLen)
if msg.DelayedType == PubDelayed {
if len(b) < pos+4 {
return nil, fmt.Errorf("invalid delayed message buffer size (%d)", len(b))
}
dlen := binary.BigEndian.Uint32(b[pos : pos+4])
pos += 4
if len(b) < pos+int(dlen) {
return nil, fmt.Errorf("invalid delayed message buffer size (%d)", len(b))
}
msg.DelayedData = b[pos : pos+int(dlen)]
pos += int(dlen)
}
var highBits uint16
if combined > MaxAttempts {
highBits = combined & uint16(0xF000)
msg.Attempts = combined & uint16(0x0FFF)
} else {
msg.Attempts = combined
}
if highBits == extMsgHighBits && !isExt {
return nil, fmt.Errorf("invalid message, has the ext high bits but not decode as ext data: %v", b)
}
if isExt && highBits == extMsgHighBits {
if len(b) < pos+1 {
return nil, fmt.Errorf("invalid delayed message buffer size (%d)", len(b))
}
extVer := ext.ExtVer(uint8(b[pos]))
msg.ExtVer = extVer
pos++
switch extVer {
case ext.NO_EXT_VER:
msg.ExtVer = ext.NO_EXT_VER
default:
if len(b) < pos+2 {
return nil, fmt.Errorf("invalid delayed message buffer size (%d)", len(b))
}
extLen := binary.BigEndian.Uint16(b[pos : pos+2])
pos += 2
if len(b) < pos+int(extLen) {
return nil, fmt.Errorf("invalid delayed message buffer size (%d)", len(b))
}
msg.ExtBytes = b[pos : pos+int(extLen)]
pos += int(extLen)
}
}
if msg.DelayedType == ChannelDelayed {
if len(b) < pos+8+4 {
return nil, fmt.Errorf("invalid delayed message buffer size (%d)", len(b))
}
// some data with original queue info
msg.Offset = BackendOffset(binary.BigEndian.Uint64(b[pos : pos+8]))
pos += 8
msg.RawMoveSize = BackendOffset(binary.BigEndian.Uint32(b[pos : pos+4]))
pos += 4
}
msg.Body = b[pos:]
return &msg, nil
}