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

Remove ContainerStorable.EncodeAsElement #354

Merged
merged 3 commits into from
Oct 24, 2023
Merged

Remove ContainerStorable.EncodeAsElement #354

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d718306
Remove ContainerStorable.EncodeAsElement
fxamacker Oct 22, 2023
d88bd12
Create Encoder.inlinedExtraData lazily
fxamacker Oct 24, 2023
acdb685
Fail StorableSlab.Encode() with inlined array/map
fxamacker Oct 24, 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
29 changes: 13 additions & 16 deletions array.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,14 +698,14 @@ func DecodeInlinedArrayStorable(
}, nil
}

// EncodeAsElement encodes inlined array data slab. Encoding is
// encodeAsInlined encodes inlined array data slab. Encoding is
// version 1 with CBOR tag having tag number CBORTagInlinedArray,
// and tag contant as 3-element array:
//
// +------------------+----------------+----------+
// | extra data index | value ID index | elements |
// +------------------+----------------+----------+
func (a *ArrayDataSlab) EncodeAsElement(enc *Encoder, inlinedTypeInfo *InlinedExtraData) error {
func (a *ArrayDataSlab) encodeAsInlined(enc *Encoder) error {
if a.extraData == nil {
return NewEncodingError(
fmt.Errorf("failed to encode non-root array data slab as inlined"))
Expand All @@ -716,7 +716,7 @@ func (a *ArrayDataSlab) EncodeAsElement(enc *Encoder, inlinedTypeInfo *InlinedEx
fmt.Errorf("failed to encode standalone array data slab as inlined"))
}

extraDataIndex := inlinedTypeInfo.addArrayExtraData(a.extraData)
extraDataIndex := enc.inlinedExtraData.addArrayExtraData(a.extraData)

if extraDataIndex > maxInlinedExtraDataIndex {
return NewEncodingError(
Expand Down Expand Up @@ -753,7 +753,7 @@ func (a *ArrayDataSlab) EncodeAsElement(enc *Encoder, inlinedTypeInfo *InlinedEx
}

// element 2: array elements
err = a.encodeElements(enc, inlinedTypeInfo)
err = a.encodeElements(enc)
if err != nil {
// err is already categorized by ArrayDataSlab.encodeElements().
return err
Expand Down Expand Up @@ -784,24 +784,21 @@ func (a *ArrayDataSlab) EncodeAsElement(enc *Encoder, inlinedTypeInfo *InlinedEx
func (a *ArrayDataSlab) Encode(enc *Encoder) error {

if a.inlined {
return NewEncodingError(
fmt.Errorf("failed to encode inlined array data slab as standalone slab"))
return a.encodeAsInlined(enc)
}

// Encoding is done in two steps:
//
// 1. Encode array elements using a new buffer while collecting inlined extra data from inlined elements.
// 2. Encode slab with deduplicated inlined extra data and copy encoded elements from previous buffer.

inlinedTypes := newInlinedExtraData()

// Get a buffer from a pool to encode elements.
elementBuf := getBuffer()
defer putBuffer(elementBuf)

elementEnc := NewEncoder(elementBuf, enc.encMode)

err := a.encodeElements(elementEnc, inlinedTypes)
err := a.encodeElements(elementEnc)
if err != nil {
// err is already categorized by Array.encodeElements().
return err
Expand Down Expand Up @@ -831,7 +828,7 @@ func (a *ArrayDataSlab) Encode(enc *Encoder) error {
h.setRoot()
}

if !inlinedTypes.empty() {
if !elementEnc.inlinedExtraData.empty() {
h.setHasInlinedSlabs()
}

Expand All @@ -851,8 +848,8 @@ func (a *ArrayDataSlab) Encode(enc *Encoder) error {
}

// Encode inlined extra data
if !inlinedTypes.empty() {
err = inlinedTypes.Encode(enc)
if !elementEnc.inlinedExtraData.empty() {
err = elementEnc.inlinedExtraData.Encode(enc)
if err != nil {
// err is already categorized by inlinedExtraData.Encode().
return err
Expand Down Expand Up @@ -887,7 +884,7 @@ func (a *ArrayDataSlab) Encode(enc *Encoder) error {
return nil
}

func (a *ArrayDataSlab) encodeElements(enc *Encoder, inlinedTypeInfo *InlinedExtraData) error {
func (a *ArrayDataSlab) encodeElements(enc *Encoder) error {
// Encode CBOR array size manually for fix-sized encoding

enc.Scratch[0] = 0x80 | 25
Expand All @@ -908,10 +905,10 @@ func (a *ArrayDataSlab) encodeElements(enc *Encoder, inlinedTypeInfo *InlinedExt

// Encode data slab content (array of elements)
for _, e := range a.elements {
err = EncodeStorableAsElement(enc, e, inlinedTypeInfo)
err = e.Encode(enc)
if err != nil {
// err is already categorized by encodeStorableAsElement().
return err
// Wrap err as external error (if needed) because err is returned by Storable interface.
return wrapErrorfAsExternalErrorIfNeeded(err, "failed to encode array element")
}
}

Expand Down
38 changes: 8 additions & 30 deletions encode.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,44 +28,22 @@ import (
// Encoder writes atree slabs to io.Writer.
type Encoder struct {
io.Writer
CBOR *cbor.StreamEncoder
Scratch [64]byte
encMode cbor.EncMode
CBOR *cbor.StreamEncoder
Scratch [64]byte
encMode cbor.EncMode
inlinedExtraData *InlinedExtraData
}

func NewEncoder(w io.Writer, encMode cbor.EncMode) *Encoder {
streamEncoder := encMode.NewStreamEncoder(w)
return &Encoder{
Writer: w,
CBOR: streamEncoder,
encMode: encMode,
Writer: w,
CBOR: streamEncoder,
encMode: encMode,
inlinedExtraData: newInlinedExtraData(),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be created lazily, if needed?

}
}

// EncodeStorableAsElement encodes storable as Array or OrderedMap element.
// Storable is encode as an inlined ArrayDataSlab or MapDataSlab if it is ArrayDataSlab or MapDataSlab.
func EncodeStorableAsElement(enc *Encoder, storable Storable, inlinedTypeInfo *InlinedExtraData) error {

switch storable := storable.(type) {

case ContainerStorable:
err := storable.EncodeAsElement(enc, inlinedTypeInfo)
if err != nil {
// Wrap err as external error (if needed) because err is returned by ContainerStorable interface.
return wrapErrorfAsExternalErrorIfNeeded(err, "failed to encode container storable as element")
}

default:
err := storable.Encode(enc)
if err != nil {
// Wrap err as external error (if needed) because err is returned by Storable interface.
return wrapErrorfAsExternalErrorIfNeeded(err, "failed to encode storable as element")
}
}

return nil
}

type StorableDecoder func(
decoder *cbor.StreamDecoder,
storableSlabID SlabID,
Expand Down
Loading
Loading