Skip to content

Commit

Permalink
blocks: change Block to a value struct
Browse files Browse the repository at this point in the history
The goal is to stop doing two allocations for each block (now it will only allocate the `[]byte` buffer, and pass the `cid.Cid, []byte` pair by decomposed registers or stack).

This way of changing does not change the syntax for trivial uses of block.Block, so in theory we will have to update only producers of block.Block, not consumers.

Fixes #57
  • Loading branch information
Jorropo committed Mar 3, 2023
1 parent 36918f4 commit d8aae0d
Showing 1 changed file with 18 additions and 27 deletions.
45 changes: 18 additions & 27 deletions blocks/blocks.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,66 +16,57 @@ import (
// according to the contents. It is currently used only when debugging.
var ErrWrongHash = errors.New("data did not match given hash")

// Block provides abstraction for blocks implementations.
type Block interface {
RawData() []byte
Cid() cid.Cid
String() string
Loggable() map[string]interface{}
}

// A BasicBlock is a singular block of data in ipfs. It implements the Block
// interface.
type BasicBlock struct {
cid cid.Cid
data []byte
// A Block is a singular block of data in ipfs. This is some bytes addressed by a hash.
type Block struct {
CID cid.Cid
Data []byte
}

// NewBlock creates a Block object from opaque data. It will hash the data.
func NewBlock(data []byte) *BasicBlock {
func NewBlock(data []byte) Block {
// TODO: fix assumptions
return &BasicBlock{data: data, cid: cid.NewCidV0(u.Hash(data))}
return Block{Data: data, CID: cid.NewCidV0(u.Hash(data))}
}

// NewBlockWithCid creates a new block when the hash of the data
// is already known, this is used to save time in situations where
// we are able to be confident that the data is correct.
func NewBlockWithCid(data []byte, c cid.Cid) (*BasicBlock, error) {
func NewBlockWithCid(data []byte, c cid.Cid) (Block, error) {
if u.Debug {
chkc, err := c.Prefix().Sum(data)
if err != nil {
return nil, err
return Block{}, err
}

if !chkc.Equals(c) {
return nil, ErrWrongHash
return Block{}, ErrWrongHash
}
}
return &BasicBlock{data: data, cid: c}, nil
return Block{Data: data, CID: c}, nil
}

// Multihash returns the hash contained in the block CID.
func (b *BasicBlock) Multihash() mh.Multihash {
return b.cid.Hash()
func (b Block) Multihash() mh.Multihash {
return b.CID.Hash()
}

// RawData returns the block raw contents as a byte slice.
func (b *BasicBlock) RawData() []byte {
return b.data
func (b Block) RawData() []byte {
return b.Data
}

// Cid returns the content identifier of the block.
func (b *BasicBlock) Cid() cid.Cid {
return b.cid
func (b Block) Cid() cid.Cid {
return b.CID
}

// String provides a human-readable representation of the block CID.
func (b *BasicBlock) String() string {
func (b Block) String() string {
return fmt.Sprintf("[Block %s]", b.Cid())
}

// Loggable returns a go-log loggable item.
func (b *BasicBlock) Loggable() map[string]interface{} {
func (b Block) Loggable() map[string]interface{} {
return map[string]interface{}{
"block": b.Cid().String(),
}
Expand Down

0 comments on commit d8aae0d

Please sign in to comment.