Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor encoding version and flag to add more flags #338

Merged
merged 5 commits into from
Sep 12, 2023
Merged

Refactor encoding version and flag to add more flags #338

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a5c7323
Refactor encoding version and flag to add 4 more flags
fxamacker Sep 5, 2023
2329549
Omit empty next slab ID in encoded array data slab
fxamacker Sep 5, 2023
cbc8204
Omit empty next slab ID in encoded map data slab
fxamacker Sep 5, 2023
cf56a4c
Merge pull request #340 from onflow/fxamacker/remove-empty-next-slab-…
fxamacker Sep 12, 2023
79e86d9
Merge pull request #339 from onflow/fxamacker/remove-empty-next-slab-…
fxamacker Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 91 additions & 105 deletions array.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,25 +246,29 @@ func newArrayDataSlabFromData(
return nil, NewDecodingErrorf("data is too short for array data slab")
}

version, flag := data[0], data[1]
h, err := newHeadFromData(data[:versionAndFlagSize])
if err != nil {
return nil, NewDecodingError(err)
}

if getSlabArrayType(flag) != slabArrayData {
if h.getSlabArrayType() != slabArrayData {
return nil, NewDecodingErrorf(
"data has invalid flag 0x%x, want 0x%x",
flag,
maskArrayData,
"data has invalid head 0x%x, want array data slab flag",
h[:],
)
}

switch version {
data = data[versionAndFlagSize:]

switch h.version() {
case 0:
return newArrayDataSlabFromDataV0(id, data, decMode, decodeStorable, decodeTypeInfo)
return newArrayDataSlabFromDataV0(id, h, data, decMode, decodeStorable, decodeTypeInfo)

case 1:
return newArrayDataSlabFromDataV1(id, data, decMode, decodeStorable, decodeTypeInfo)
return newArrayDataSlabFromDataV1(id, h, data, decMode, decodeStorable, decodeTypeInfo)

default:
return nil, NewDecodingErrorf("unexpected version %d for array data slab", version)
return nil, NewDecodingErrorf("unexpected version %d for array data slab", h.version())
}
}

Expand All @@ -289,6 +293,7 @@ func newArrayDataSlabFromData(
// See ArrayExtraData.Encode() for extra data section format.
func newArrayDataSlabFromDataV0(
id SlabID,
h head,
data []byte,
decMode cbor.DecMode,
decodeStorable StorableDecoder,
Expand All @@ -297,59 +302,51 @@ func newArrayDataSlabFromDataV0(
*ArrayDataSlab,
error,
) {
// Check minimum data length
if len(data) < versionAndFlagSize {
return nil, NewDecodingErrorf("data is too short for array data slab")
}

isRootSlab := isRoot(data[1])

var err error
var extraData *ArrayExtraData

// Check flag for extra data
if isRootSlab {
if h.isRoot() {
// Decode extra data
var err error
extraData, data, err = newArrayExtraDataFromData(data[versionAndFlagSize:], decMode, decodeTypeInfo)
extraData, data, err = newArrayExtraDataFromData(data, decMode, decodeTypeInfo)
if err != nil {
// err is categorized already by newArrayExtraDataFromData.
return nil, err
}
}

minDataLength := arrayDataSlabPrefixSize
if isRootSlab {
minDataLength = arrayRootDataSlabPrefixSize
}
// Skip second head (version + flag) here because it is only present in root slab in version 0.
if len(data) < versionAndFlagSize {
return nil, NewDecodingErrorf("data is too short for array data slab")
}

// Check data length (after decoding extra data if present)
if len(data) < minDataLength {
return nil, NewDecodingErrorf("data is too short for array data slab")
data = data[versionAndFlagSize:]
}

var next SlabID

var contentOffset int

if !isRootSlab {
if !h.isRoot() {
// Check data length for next slab ID
if len(data) < slabIDSize {
return nil, NewDecodingErrorf("data is too short for array data slab")
}

// Decode next slab ID
const nextSlabIDOffset = versionAndFlagSize
var err error
next, err = NewSlabIDFromRawBytes(data[nextSlabIDOffset:])
next, err = NewSlabIDFromRawBytes(data)
if err != nil {
// error returned from NewSlabIDFromRawBytes is categorized already.
return nil, err
}

contentOffset = nextSlabIDOffset + slabIDSize
data = data[slabIDSize:]
}

} else {
contentOffset = versionAndFlagSize
// Check data length for array element head
if len(data) < arrayDataSlabElementHeadSize {
return nil, NewDecodingErrorf("data is too short for array data slab")
}

// Decode content (CBOR array)
cborDec := decMode.NewByteStreamDecoder(data[contentOffset:])
cborDec := decMode.NewByteStreamDecoder(data)

elemCount, err := cborDec.DecodeArrayHead()
if err != nil {
Expand All @@ -368,7 +365,7 @@ func newArrayDataSlabFromDataV0(

// Compute slab size for version 1.
slabSize := versionAndFlagSize + cborDec.NumBytesDecoded()
if !isRootSlab {
if !h.isRoot() {
slabSize += slabIDSize
}

Expand Down Expand Up @@ -407,29 +404,21 @@ func newArrayDataSlabFromDataV0(
// See ArrayExtraData.Encode() for extra data section format.
func newArrayDataSlabFromDataV1(
id SlabID,
data []byte,
h head,
data []byte, // data doesn't include head (first two bytes)
decMode cbor.DecMode,
decodeStorable StorableDecoder,
decodeTypeInfo TypeInfoDecoder,
) (
*ArrayDataSlab,
error,
) {
// Check minimum data length
if len(data) < versionAndFlagSize {
return nil, NewDecodingErrorf("data is too short for array data slab")
}

isRootSlab := isRoot(data[1])

data = data[versionAndFlagSize:]

var err error
var extraData *ArrayExtraData
var next SlabID

// Decode header
if isRootSlab {
if h.isRoot() {
// Decode extra data
extraData, data, err = newArrayExtraDataFromData(data, decMode, decodeTypeInfo)
if err != nil {
Expand Down Expand Up @@ -477,7 +466,7 @@ func newArrayDataSlabFromDataV1(

// Compute slab size for version 1.
slabSize := versionAndFlagSize + cborDec.NumBytesDecoded()
if !isRootSlab {
if !h.isRoot() {
slabSize += slabIDSize
}

Expand Down Expand Up @@ -516,23 +505,23 @@ func newArrayDataSlabFromDataV1(
// See ArrayExtraData.Encode() for extra data section format.
func (a *ArrayDataSlab) Encode(enc *Encoder) error {

flag := maskArrayData
const version = 1

h, err := newArraySlabHead(version, slabArrayData)
if err != nil {
return NewEncodingError(err)
}

if a.hasPointer() {
flag = setHasPointers(flag)
h.setHasPointers()
}

if a.extraData != nil {
flag = setRoot(flag)
h.setRoot()
}

// Encode version
enc.Scratch[0] = 1

// Encode flag
enc.Scratch[1] = flag

_, err := enc.Write(enc.Scratch[:versionAndFlagSize])
// Encode head (version + flag)
_, err = enc.Write(h[:])
if err != nil {
return NewEncodingError(err)
}
Expand Down Expand Up @@ -1006,25 +995,29 @@ func newArrayMetaDataSlabFromData(
return nil, NewDecodingErrorf("data is too short for array metadata slab")
}

version, flag := data[0], data[1]
h, err := newHeadFromData(data[:versionAndFlagSize])
if err != nil {
return nil, NewDecodingError(err)
}

if getSlabArrayType(flag) != slabArrayMeta {
if h.getSlabArrayType() != slabArrayMeta {
return nil, NewDecodingErrorf(
"data has invalid flag 0x%x, want 0x%x",
flag,
maskArrayMeta,
"data has invalid head 0x%x, want array metadata slab flag",
h[:],
)
}

switch version {
data = data[versionAndFlagSize:]

switch h.version() {
case 0:
return newArrayMetaDataSlabFromDataV0(id, data, decMode, decodeTypeInfo)
return newArrayMetaDataSlabFromDataV0(id, h, data, decMode, decodeTypeInfo)

case 1:
return newArrayMetaDataSlabFromDataV1(id, data, decMode, decodeTypeInfo)
return newArrayMetaDataSlabFromDataV1(id, h, data, decMode, decodeTypeInfo)

default:
return nil, NewDecodingErrorf("unexpected version %d for array metadata slab", version)
return nil, NewDecodingErrorf("unexpected version %d for array metadata slab", h.version())
}
}

Expand All @@ -1049,6 +1042,7 @@ func newArrayMetaDataSlabFromData(
// See ArrayExtraData.Encode() for extra data section format.
func newArrayMetaDataSlabFromDataV0(
id SlabID,
h head,
data []byte,
decMode cbor.DecMode,
decodeTypeInfo TypeInfoDecoder,
Expand All @@ -1058,41 +1052,42 @@ func newArrayMetaDataSlabFromDataV0(
) {
// NOTE: the following encoded sizes are for version 0 only (changed in later version).
const (
// meta data slab prefix size: version (1 byte) + flag (1 byte) + child header count (2 bytes)
arrayMetaDataSlabPrefixSizeV0 = versionAndFlagSize + 2
// meta data children array head size: 2 bytes
arrayMetaDataArrayHeadSizeV0 = 2

// slab header size: slab id (16 bytes) + count (4 bytes) + size (4 bytes)
arraySlabHeaderSizeV0 = slabIDSize + 4 + 4
)

// Check minimum data length
if len(data) < versionAndFlagSize {
return nil, NewDecodingErrorf("data is too short for array metadata slab")
}

flag := data[1]

var err error
var extraData *ArrayExtraData

if isRoot(flag) {
extraData, data, err = newArrayExtraDataFromData(data[versionAndFlagSize:], decMode, decodeTypeInfo)
if h.isRoot() {
extraData, data, err = newArrayExtraDataFromData(data, decMode, decodeTypeInfo)
if err != nil {
// Don't need to wrap because err is already categorized by newArrayExtraDataFromData().
return nil, err
}

// Skip second head (version + flag) here because it is only present in root slab in version 0.
if len(data) < versionAndFlagSize {
return nil, NewDecodingErrorf("data is too short for array data slab")
}

data = data[versionAndFlagSize:]
}

// Check data length (after decoding extra data if present)
if len(data) < arrayMetaDataSlabPrefixSizeV0 {
if len(data) < arrayMetaDataArrayHeadSizeV0 {
return nil, NewDecodingErrorf("data is too short for array metadata slab")
}

// Decode number of child headers
const childHeaderCountOffset = versionAndFlagSize
childHeaderCount := binary.BigEndian.Uint16(data[childHeaderCountOffset:])
childHeaderCount := binary.BigEndian.Uint16(data)

data = data[arrayMetaDataArrayHeadSizeV0:]

expectedDataLength := arrayMetaDataSlabPrefixSizeV0 + arraySlabHeaderSizeV0*int(childHeaderCount)
expectedDataLength := arraySlabHeaderSizeV0 * int(childHeaderCount)
if len(data) != expectedDataLength {
return nil, NewDecodingErrorf(
"data has unexpected length %d, want %d",
Expand All @@ -1105,7 +1100,7 @@ func newArrayMetaDataSlabFromDataV0(
childrenHeaders := make([]ArraySlabHeader, childHeaderCount)
childrenCountSum := make([]uint32, childHeaderCount)
totalCount := uint32(0)
offset := childHeaderCountOffset + 2
offset := 0

for i := 0; i < int(childHeaderCount); i++ {
slabID, err := NewSlabIDFromRawBytes(data[offset:])
Expand Down Expand Up @@ -1170,26 +1165,18 @@ func newArrayMetaDataSlabFromDataV0(
// See ArrayExtraData.Encode() for extra data section format.
func newArrayMetaDataSlabFromDataV1(
id SlabID,
h head,
data []byte,
decMode cbor.DecMode,
decodeTypeInfo TypeInfoDecoder,
) (
*ArrayMetaDataSlab,
error,
) {
// Check minimum data length
if len(data) < versionAndFlagSize {
return nil, NewDecodingErrorf("data is too short for array metadata slab")
}

isRoot := isRoot(data[1])

data = data[versionAndFlagSize:]

var err error
var extraData *ArrayExtraData

if isRoot {
if h.isRoot() {
extraData, data, err = newArrayExtraDataFromData(data, decMode, decodeTypeInfo)
if err != nil {
// Don't need to wrap because err is already categorized by newArrayExtraDataFromData().
Expand Down Expand Up @@ -1292,20 +1279,19 @@ func newArrayMetaDataSlabFromDataV1(
// See ArrayExtraData.Encode() for extra data section format.
func (a *ArrayMetaDataSlab) Encode(enc *Encoder) error {

flag := maskArrayMeta
const version = 1

if a.extraData != nil {
flag = setRoot(flag)
h, err := newArraySlabHead(version, slabArrayMeta)
if err != nil {
return NewEncodingError(err)
}

// Encode version
enc.Scratch[0] = 1

// Encode flag
enc.Scratch[1] = flag
if a.extraData != nil {
h.setRoot()
}

// Write version and flag
_, err := enc.Write(enc.Scratch[:versionAndFlagSize])
// Write head (version + flag)
_, err = enc.Write(h[:])
if err != nil {
return NewEncodingError(err)
}
Expand Down
Loading