feat: blockstore: GetMany blockstore method #492
+351
−624
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ | |
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "sync" | ||
| "sync/atomic" | ||
|
|
||
|
|
@@ -64,6 +65,13 @@ | |
| HashOnRead(enabled bool) | ||
| } | ||
|
|
||
| // TxnBlockstore is a blockstore interface that supports GetMany and PutMany methods using ds.TxnDatastore | ||
| type TxnBlockstore interface { | ||
| Blockstore | ||
| PutMany(ctx context.Context, blocks []blocks.Block) error | ||
| GetMany(context.Context, []cid.Cid) ([]blocks.Block, []cid.Cid, error) | ||
|
There was a problem hiding this comment. Two recommendations:
If returning an asynchronous object (e.g. channel or iterator) might be worth taking a look at ipfs/kubo#4592 to make sure you don't run into some common pitfalls. With Go generics now iterators may also make this easier than it used to be. |
||
| } | ||
|
|
||
| // Viewer can be implemented by blockstores that offer zero-copy access to | ||
| // values. | ||
| // | ||
|
|
@@ -310,6 +318,227 @@ | |
| return output, nil | ||
| } | ||
|
|
||
| // TxnBlockstoreOption is a txnBlockstore option implementation | ||
| type TxnBlockstoreOption struct { | ||
| f func(bs *txnBlockstore) | ||
| } | ||
|
|
||
| // NewTxnBlockstore returns a default TxnBlockstore implementation | ||
| // using the provided datastore.TxnDatastore backend. | ||
| func NewTxnBlockstore(d ds.TxnDatastore, opts ...TxnBlockstoreOption) TxnBlockstore { | ||
| bs := &txnBlockstore{ | ||
| datastore: d, | ||
| } | ||
|
|
||
| for _, o := range opts { | ||
| o.f(bs) | ||
| } | ||
|
|
||
| if !bs.noPrefix { | ||
| bs.datastore = dsns.WrapTxnDatastore(bs.datastore, BlockPrefix) | ||
| } | ||
| return bs | ||
| } | ||
|
|
||
| type txnBlockstore struct { | ||
| datastore ds.TxnDatastore | ||
|
|
||
| rehash atomic.Bool | ||
| writeThrough bool | ||
| noPrefix bool | ||
| } | ||
|
|
||
| func (bs *txnBlockstore) HashOnRead(enabled bool) { | ||
| bs.rehash.Store(enabled) | ||
| } | ||
|
|
||
| func (bs *txnBlockstore) Get(ctx context.Context, k cid.Cid) (blocks.Block, error) { | ||
| if !k.Defined() { | ||
| logger.Error("undefined cid in blockstore") | ||
| return nil, ipld.ErrNotFound{Cid: k} | ||
| } | ||
| bdata, err := bs.datastore.Get(ctx, dshelp.MultihashToDsKey(k.Hash())) | ||
| if err == ds.ErrNotFound { | ||
| return nil, ipld.ErrNotFound{Cid: k} | ||
| } | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if bs.rehash.Load() { | ||
| rbcid, err := k.Prefix().Sum(bdata) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if !rbcid.Equals(k) { | ||
| return nil, ErrHashMismatch | ||
| } | ||
|
|
||
| return blocks.NewBlockWithCid(bdata, rbcid) | ||
| } | ||
| return blocks.NewBlockWithCid(bdata, k) | ||
| } | ||
|
|
||
| func (bs *txnBlockstore) GetMany(ctx context.Context, cs []cid.Cid) ([]blocks.Block, []cid.Cid, error) { | ||
| if len(cs) == 1 { | ||
| // performance fast-path | ||
| block, err := bs.Get(ctx, cs[0]) | ||
| return []blocks.Block{block}, nil, err | ||
|
There was a problem hiding this comment. Doesn't make sense to not return the CID here given it's in the signature, but also it doesn't seem like |
||
| } | ||
|
|
||
| t, err := bs.datastore.NewTransaction(ctx, false) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
| blks := make([]blocks.Block, 0, len(cs)) | ||
| missingCIDs := make([]cid.Cid, 0, len(cs)) | ||
| for _, c := range cs { | ||
| if !c.Defined() { | ||
| logger.Error("undefined cid in blockstore") | ||
| return nil, nil, ipld.ErrNotFound{Cid: c} | ||
| } | ||
| bdata, err := t.Get(ctx, dshelp.MultihashToDsKey(c.Hash())) | ||
| if err != nil { | ||
| if err == ds.ErrNotFound { | ||
| missingCIDs = append(missingCIDs, c) | ||
| } else { | ||
| return nil, nil, err | ||
| } | ||
| } else { | ||
| if bs.rehash.Load() { | ||
| rbcid, err := c.Prefix().Sum(bdata) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| if !rbcid.Equals(c) { | ||
| return nil, nil, fmt.Errorf("block in storage has different hash (%x) than requested (%x)", rbcid.Hash(), c.Hash()) | ||
| } | ||
|
|
||
| blk, err := blocks.NewBlockWithCid(bdata, rbcid) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| blks = append(blks, blk) | ||
| } else { | ||
| blk, err := blocks.NewBlockWithCid(bdata, c) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| blks = append(blks, blk) | ||
| } | ||
| } | ||
| } | ||
| return blks, missingCIDs, t.Commit(ctx) | ||
| } | ||
|
|
||
| func (bs *txnBlockstore) Put(ctx context.Context, block blocks.Block) error { | ||
| k := dshelp.MultihashToDsKey(block.Cid().Hash()) | ||
|
|
||
| // Has is cheaper than Put, so see if we already have it | ||
| if !bs.writeThrough { | ||
| exists, err := bs.datastore.Has(ctx, k) | ||
| if err == nil && exists { | ||
| return nil // already stored. | ||
| } | ||
| } | ||
| return bs.datastore.Put(ctx, k, block.RawData()) | ||
| } | ||
|
|
||
| func (bs *txnBlockstore) PutMany(ctx context.Context, blocks []blocks.Block) error { | ||
| if len(blocks) == 1 { | ||
| // performance fast-path | ||
| return bs.Put(ctx, blocks[0]) | ||
| } | ||
|
|
||
| t, err := bs.datastore.NewTransaction(ctx, false) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| for _, b := range blocks { | ||
| k := dshelp.MultihashToDsKey(b.Cid().Hash()) | ||
|
|
||
| if !bs.writeThrough { | ||
| exists, err := bs.datastore.Has(ctx, k) | ||
| if err == nil && exists { | ||
| continue | ||
| } | ||
| } | ||
|
|
||
| err = t.Put(ctx, k, b.RawData()) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return t.Commit(ctx) | ||
| } | ||
|
|
||
| func (bs *txnBlockstore) Has(ctx context.Context, k cid.Cid) (bool, error) { | ||
| return bs.datastore.Has(ctx, dshelp.MultihashToDsKey(k.Hash())) | ||
| } | ||
|
|
||
| func (bs *txnBlockstore) GetSize(ctx context.Context, k cid.Cid) (int, error) { | ||
| size, err := bs.datastore.GetSize(ctx, dshelp.MultihashToDsKey(k.Hash())) | ||
| if err == ds.ErrNotFound { | ||
| return -1, ipld.ErrNotFound{Cid: k} | ||
| } | ||
| return size, err | ||
| } | ||
|
|
||
| func (bs *txnBlockstore) DeleteBlock(ctx context.Context, k cid.Cid) error { | ||
| return bs.datastore.Delete(ctx, dshelp.MultihashToDsKey(k.Hash())) | ||
| } | ||
|
|
||
| // AllKeysChan runs a query for keys from the blockstore. | ||
| // this is very simplistic, in the future, take dsq.Query as a param? | ||
| // | ||
| // AllKeysChan respects context. | ||
| func (bs *txnBlockstore) AllKeysChan(ctx context.Context) (<-chan cid.Cid, error) { | ||
|
|
||
| // KeysOnly, because that would be _a lot_ of data. | ||
| q := dsq.Query{KeysOnly: true} | ||
| res, err := bs.datastore.Query(ctx, q) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| output := make(chan cid.Cid, dsq.KeysOnlyBufSize) | ||
| go func() { | ||
| defer func() { | ||
| res.Close() // ensure exit (signals early exit, too) | ||
| close(output) | ||
| }() | ||
|
|
||
| for { | ||
| e, ok := res.NextSync() | ||
| if !ok { | ||
| return | ||
| } | ||
| if e.Error != nil { | ||
| logger.Errorf("blockstore.AllKeysChan got err: %s", e.Error) | ||
| return | ||
| } | ||
|
|
||
| // need to convert to key.Key using key.KeyFromDsKey. | ||
| bk, err := dshelp.BinaryFromDsKey(ds.RawKey(e.Key)) | ||
| if err != nil { | ||
| logger.Warnf("error parsing key from binary: %s", err) | ||
| continue | ||
| } | ||
| k := cid.NewCidV1(cid.Raw, bk) | ||
| select { | ||
| case <-ctx.Done(): | ||
| return | ||
| case output <- k: | ||
| } | ||
| } | ||
| }() | ||
|
|
||
| return output, nil | ||
| } | ||
|
|
||
| // NewGCLocker returns a default implementation of | ||
| // GCLocker using standard [RW] mutexes. | ||
| func NewGCLocker() GCLocker { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think
TxnBlockstoreis wrong because the blockstore does not provide transactions,GetManyBlockstorewas fine mb.