-
Notifications
You must be signed in to change notification settings - Fork 28
/
binary_util.go
568 lines (534 loc) · 13.1 KB
/
binary_util.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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
// Copyright 2015 The Vanadium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package vom
import (
"errors"
"fmt"
"math"
"reflect"
"unsafe"
"v.io/v23/vdl"
)
// Binary encoding and decoding routines.
var errInvalid = errors.New("vom: invalid encoding")
func errEndedBeforeVersionByte(err error) error {
return fmt.Errorf("ended before version byte received: %v", err)
}
func errBadVersionByte(v Version) error {
return fmt.Errorf("bad version byte: %02x", v)
}
func errMsgLen(l int) error {
return fmt.Errorf("vom: message larger than %v bytes", l)
}
func errInvalidLenOrControl(first byte) error {
return fmt.Errorf("vom: invalid len or control byte %02x", first)
}
func errBadControlCode(code byte) error {
return fmt.Errorf("invalid control code: %02x", code)
}
const (
uint64Size = 8
maxEncodedUintBytes = uint64Size + 1 // +1 for length byte
maxBinaryMsgLen = 1 << 30 // 1GiB limit to each message
)
// lenUint returns the number of bytes used to represent the provided
// uint value
func lenUint(v uint64) int {
switch {
case v <= 0x7f:
return 1
case v <= 0xff:
return 2
case v <= 0xffff:
return 3
case v <= 0xffffff:
return 4
case v <= 0xffffffff:
return 5
case v <= 0xffffffffff:
return 6
case v <= 0xffffffffffff:
return 7
case v <= 0xffffffffffffff:
return 8
default:
return 9
}
}
func binaryEncodeControl(buf *encbuf, v byte) {
if v < 0x80 || v > 0xef {
panic(errBadControlCode(v))
}
buf.WriteOneByte(v)
}
// binaryDecodeControlOnly only decodes and advances the read position if the
// next byte is a control byte. Returns an error if the control byte doesn't
// match want.
func binaryDecodeControlOnly(buf *decbuf, want byte) (bool, error) {
if !buf.IsAvailable(1) {
if err := buf.Fill(1); err != nil {
return false, err
}
}
ctrl := buf.PeekAvailableByte()
if ctrl < 0x80 || ctrl > 0xef {
return false, nil // not a control byte
}
if ctrl != want {
return false, errBadControlCode(ctrl)
}
buf.SkipAvailable(1)
return true, nil
}
// binaryPeekControl returns the next byte as a control byte, or 0 if it is not
// a control byte. Doesn't advance the read position.
func binaryPeekControl(buf *decbuf) (byte, error) {
if !buf.IsAvailable(1) {
if err := buf.Fill(1); err != nil {
return 0, err
}
}
ctrl := buf.PeekAvailableByte()
if ctrl < 0x80 || ctrl > 0xef {
return 0, nil
}
return ctrl, nil
}
// Bools are encoded as a byte where 0 = false and anything else is true.
func binaryEncodeBool(buf *encbuf, v bool) {
if v {
buf.WriteOneByte(1)
} else {
buf.WriteOneByte(0)
}
}
func binaryDecodeBool(buf *decbuf) (bool, error) {
if !buf.IsAvailable(1) {
if err := buf.Fill(1); err != nil {
return false, err
}
}
value := buf.ReadAvailableByte()
if value > 1 {
return false, errInvalid // TODO: better error
}
return value != 0, nil
}
// Unsigned integers are the basis for all other primitive values. This is a
// two-state encoding. If the number is less than 128 (0 through 0x7f), its
// value is written directly. Otherwise the value is written in big-endian byte
// order preceded by the negated byte length.
func binaryEncodeUint(buf *encbuf, v uint64) {
switch {
case v <= 0x7f:
buf.Grow(1)[0] = byte(v)
case v <= 0xff:
buf := buf.Grow(2)
buf[0] = 0xff
buf[1] = byte(v)
case v <= 0xffff:
buf := buf.Grow(3)
buf[0] = 0xfe
buf[1] = byte(v >> 8)
buf[2] = byte(v)
case v <= 0xffffff:
buf := buf.Grow(4)
buf[0] = 0xfd
buf[1] = byte(v >> 16)
buf[2] = byte(v >> 8)
buf[3] = byte(v)
case v <= 0xffffffff:
buf := buf.Grow(5)
buf[0] = 0xfc
buf[1] = byte(v >> 24)
buf[2] = byte(v >> 16)
buf[3] = byte(v >> 8)
buf[4] = byte(v)
case v <= 0xffffffffff:
buf := buf.Grow(6)
buf[0] = 0xfb
buf[1] = byte(v >> 32)
buf[2] = byte(v >> 24)
buf[3] = byte(v >> 16)
buf[4] = byte(v >> 8)
buf[5] = byte(v)
case v <= 0xffffffffffff:
buf := buf.Grow(7)
buf[0] = 0xfa
buf[1] = byte(v >> 40)
buf[2] = byte(v >> 32)
buf[3] = byte(v >> 24)
buf[4] = byte(v >> 16)
buf[5] = byte(v >> 8)
buf[6] = byte(v)
case v <= 0xffffffffffffff:
buf := buf.Grow(8)
buf[0] = 0xf9
buf[1] = byte(v >> 48)
buf[2] = byte(v >> 40)
buf[3] = byte(v >> 32)
buf[4] = byte(v >> 24)
buf[5] = byte(v >> 16)
buf[6] = byte(v >> 8)
buf[7] = byte(v)
default:
buf := buf.Grow(9)
buf[0] = 0xf8
buf[1] = byte(v >> 56)
buf[2] = byte(v >> 48)
buf[3] = byte(v >> 40)
buf[4] = byte(v >> 32)
buf[5] = byte(v >> 24)
buf[6] = byte(v >> 16)
buf[7] = byte(v >> 8)
buf[8] = byte(v)
}
}
func binaryDecodeUint(buf *decbuf) (uint64, error) {
if !buf.IsAvailable(1) {
if err := buf.Fill(1); err != nil {
return 0, err
}
}
firstByte := buf.ReadAvailableByte()
// Handle single-byte encoding.
if firstByte <= 0x7f {
return uint64(firstByte), nil
}
// Handle multi-byte encoding.
byteLen := int(-int8(firstByte))
if byteLen < 1 || byteLen > uint64Size {
return 0, errInvalidLenOrControl(firstByte)
}
if !buf.IsAvailable(byteLen) {
if err := buf.Fill(byteLen); err != nil {
return 0, err
}
}
bytes := buf.ReadAvailable(byteLen)
var uvalue uint64
for _, b := range bytes {
uvalue = uvalue<<8 | uint64(b)
}
return uvalue, nil
}
func binaryPeekUint(buf *decbuf) (uint64, int, error) {
if !buf.IsAvailable(1) {
if err := buf.Fill(1); err != nil {
return 0, 0, err
}
}
firstByte := buf.PeekAvailableByte()
// Handle single-byte encoding.
if firstByte <= 0x7f {
return uint64(firstByte), 1, nil
}
// Handle multi-byte encoding.
byteLen := int(-int8(firstByte))
if byteLen < 1 || byteLen > uint64Size {
return 0, 0, errInvalidLenOrControl(firstByte)
}
byteLen++ // account for initial len byte
if !buf.IsAvailable(byteLen) {
if err := buf.Fill(byteLen); err != nil {
return 0, 0, err
}
}
bytes := buf.PeekAvailable(byteLen)
var uvalue uint64
for _, b := range bytes[1:] {
uvalue = uvalue<<8 | uint64(b)
}
return uvalue, byteLen, nil
}
func binarySkipUint(buf *decbuf) error {
if !buf.IsAvailable(1) {
if err := buf.Fill(1); err != nil {
return err
}
}
firstByte := buf.PeekAvailableByte()
// Handle single-byte encoding.
if firstByte <= 0x7f {
buf.SkipAvailable(1)
return nil
}
// Handle multi-byte encoding.
byteLen := int(-int8(firstByte))
if byteLen < 1 || byteLen > uint64Size {
return errInvalidLenOrControl(firstByte)
}
byteLen++ // account for initial len byte
if !buf.IsAvailable(byteLen) {
if err := buf.Fill(byteLen); err != nil {
return err
}
}
buf.SkipAvailable(byteLen)
return nil
}
func binaryPeekUintByteLen(buf *decbuf) (int, error) {
if !buf.IsAvailable(1) {
if err := buf.Fill(1); err != nil {
return 0, err
}
}
firstByte := buf.PeekAvailableByte()
// Handle single-byte encoding.
if firstByte <= 0x7f {
return 1, nil
}
// Handle multi-byte encoding.
byteLen := int(-int8(firstByte))
if byteLen < 1 || byteLen > uint64Size {
return 0, errInvalidLenOrControl(firstByte)
}
return 1 + byteLen, nil
}
func binaryDecodeLen(buf *decbuf) (int, error) {
ulen, err := binaryDecodeUint(buf)
switch {
case err != nil:
return 0, err
case ulen > maxBinaryMsgLen:
return 0, errMsgLen(maxBinaryMsgLen)
}
return int(ulen), nil
}
func binaryDecodeLenOrArrayLen(buf *decbuf, t *vdl.Type) (int, error) {
len, err := binaryDecodeLen(buf)
if err != nil {
return 0, err
}
if t.Kind() == vdl.Array {
if len != 0 {
return 0, errInvalid // TODO(toddw): better error
}
return t.Len(), nil
}
return len, nil
}
// Signed integers are encoded as unsigned integers, where the low bit says
// whether to complement the other bits to recover the int.
func binaryEncodeInt(buf *encbuf, v int64) {
var uvalue uint64
if v < 0 {
uvalue = uint64(^v<<1) | 1
} else {
uvalue = uint64(v << 1)
}
binaryEncodeUint(buf, uvalue)
}
func binaryDecodeInt(buf *decbuf) (int64, error) {
if !buf.IsAvailable(1) {
if err := buf.Fill(1); err != nil {
return 0, err
}
}
firstByte := buf.ReadAvailableByte()
// Handle single-byte encoding.
if firstByte <= 0x7f {
if firstByte&1 == 1 {
return ^int64(firstByte >> 1), nil
}
return int64(firstByte >> 1), nil
}
// Handle multi-byte encoding.
byteLen := int(-int8(firstByte))
if byteLen < 1 || byteLen > uint64Size {
return 0, errInvalidLenOrControl(firstByte)
}
if !buf.IsAvailable(byteLen) {
if err := buf.Fill(byteLen); err != nil {
return 0, err
}
}
bytes := buf.ReadAvailable(byteLen)
var uvalue uint64
for _, b := range bytes {
uvalue = uvalue<<8 | uint64(b)
}
if uvalue&1 == 1 {
return ^int64(uvalue >> 1), nil
}
return int64(uvalue >> 1), nil
}
func binaryPeekInt(buf *decbuf) (int64, int, error) {
if !buf.IsAvailable(1) {
if err := buf.Fill(1); err != nil {
return 0, 0, err
}
}
firstByte := buf.PeekAvailableByte()
// Handle single-byte encoding.
if firstByte <= 0x7f {
if firstByte&1 == 1 {
return ^int64(firstByte >> 1), 1, nil
}
return int64(firstByte >> 1), 1, nil
}
// Handle multi-byte encoding.
byteLen := int(-int8(firstByte))
if byteLen < 1 || byteLen > uint64Size {
return 0, 0, errInvalidLenOrControl(firstByte)
}
byteLen++ // account for initial len byte
if !buf.IsAvailable(byteLen) {
if err := buf.Fill(byteLen); err != nil {
return 0, 0, err
}
}
bytes := buf.PeekAvailable(byteLen)
var uvalue uint64
for _, b := range bytes[1:] {
uvalue = uvalue<<8 | uint64(b)
}
if uvalue&1 == 1 {
return ^int64(uvalue >> 1), byteLen, nil
}
return int64(uvalue >> 1), byteLen, nil
}
// Floating point numbers are encoded as byte-reversed ieee754.
func binaryEncodeFloat(buf *encbuf, v float64) {
ieee := math.Float64bits(v)
// Manually-unrolled byte-reversing.
uvalue := (ieee&0xff)<<56 |
(ieee&0xff00)<<40 |
(ieee&0xff0000)<<24 |
(ieee&0xff000000)<<8 |
(ieee&0xff00000000)>>8 |
(ieee&0xff0000000000)>>24 |
(ieee&0xff000000000000)>>40 |
(ieee&0xff00000000000000)>>56
binaryEncodeUint(buf, uvalue)
}
func binaryDecodeFloat(buf *decbuf) (float64, error) {
uvalue, err := binaryDecodeUint(buf)
if err != nil {
return 0, err
}
// Manually-unrolled byte-reversing.
ieee := (uvalue&0xff)<<56 |
(uvalue&0xff00)<<40 |
(uvalue&0xff0000)<<24 |
(uvalue&0xff000000)<<8 |
(uvalue&0xff00000000)>>8 |
(uvalue&0xff0000000000)>>24 |
(uvalue&0xff000000000000)>>40 |
(uvalue&0xff00000000000000)>>56
return math.Float64frombits(ieee), nil
}
// Strings are encoded as the byte count followed by uninterpreted bytes.
func binaryEncodeString(buf *encbuf, s string) {
binaryEncodeUint(buf, uint64(len(s)))
buf.WriteString(s)
}
func binaryDecodeString(buf *decbuf) (s string, err error) {
len, err := binaryDecodeLen(buf)
if len == 0 || err != nil {
return
}
data := make([]byte, len)
if err = buf.ReadIntoBuf(data); err != nil {
return
}
// Go makes an extra copy if we simply perform the conversion string(data), so
// we use unsafe to transfer the contents from data into s without a copy.
p := (*reflect.StringHeader)(unsafe.Pointer(&s))
p.Data = uintptr(unsafe.Pointer(&data[0]))
p.Len = len
return
}
func binarySkipString(buf *decbuf) error {
len, err := binaryDecodeLen(buf)
if err != nil {
return err
}
return buf.Skip(len)
}
// binaryEncodeUintEnd writes into the trailing part of buf and returns the start
// index of the encoded data.
//
// REQUIRES: buf is big enough to hold the encoded value.
func binaryEncodeUintEnd(buf []byte, v uint64) int {
end := len(buf) - 1
switch {
case v <= 0x7f:
buf[end] = byte(v)
return end
case v <= 0xff:
buf[end-1] = 0xff
buf[end] = byte(v)
return end - 1
case v <= 0xffff:
buf[end-2] = 0xfe
buf[end-1] = byte(v >> 8)
buf[end] = byte(v)
return end - 2
case v <= 0xffffff:
buf[end-3] = 0xfd
buf[end-2] = byte(v >> 16)
buf[end-1] = byte(v >> 8)
buf[end] = byte(v)
return end - 3
case v <= 0xffffffff:
buf[end-4] = 0xfc
buf[end-3] = byte(v >> 24)
buf[end-2] = byte(v >> 16)
buf[end-1] = byte(v >> 8)
buf[end] = byte(v)
return end - 4
case v <= 0xffffffffff:
buf[end-5] = 0xfb
buf[end-4] = byte(v >> 32)
buf[end-3] = byte(v >> 24)
buf[end-2] = byte(v >> 16)
buf[end-1] = byte(v >> 8)
buf[end] = byte(v)
return end - 5
case v <= 0xffffffffffff:
buf[end-6] = 0xfa
buf[end-5] = byte(v >> 40)
buf[end-4] = byte(v >> 32)
buf[end-3] = byte(v >> 24)
buf[end-2] = byte(v >> 16)
buf[end-1] = byte(v >> 8)
buf[end] = byte(v)
return end - 6
case v <= 0xffffffffffffff:
buf[end-7] = 0xf9
buf[end-6] = byte(v >> 48)
buf[end-5] = byte(v >> 40)
buf[end-4] = byte(v >> 32)
buf[end-3] = byte(v >> 24)
buf[end-2] = byte(v >> 16)
buf[end-1] = byte(v >> 8)
buf[end] = byte(v)
return end - 7
default:
buf[end-8] = 0xf8
buf[end-7] = byte(v >> 56)
buf[end-6] = byte(v >> 48)
buf[end-5] = byte(v >> 40)
buf[end-4] = byte(v >> 32)
buf[end-3] = byte(v >> 24)
buf[end-2] = byte(v >> 16)
buf[end-1] = byte(v >> 8)
buf[end] = byte(v)
return end - 8
}
}
// binaryEncodeIntEnd writes into the trailing part of buf and returns the start
// index of the encoded data.
//
// REQUIRES: buf is big enough to hold the encoded value.
func binaryEncodeIntEnd(buf []byte, v int64) int {
var uvalue uint64
if v < 0 {
uvalue = uint64(^v<<1) | 1
} else {
uvalue = uint64(v << 1)
}
return binaryEncodeUintEnd(buf, uvalue)
}