generated from ipfs/ipfs-repository-template
-
Notifications
You must be signed in to change notification settings - Fork 88
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
gateway: import cached DNS, blockstore cache, and proxy blockstore
- Loading branch information
Showing
7 changed files
with
418 additions
and
21 deletions.
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
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 |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| package gateway | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
|
|
||
| "github.com/ipfs/go-cid" | ||
| format "github.com/ipfs/go-ipld-format" | ||
|
|
||
| blockstore "github.com/ipfs/boxo/blockstore" | ||
| blocks "github.com/ipfs/go-block-format" | ||
|
|
||
| lru "github.com/hashicorp/golang-lru/v2" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| uatomic "go.uber.org/atomic" | ||
| "go.uber.org/zap/zapcore" | ||
| ) | ||
|
|
||
| type cacheBlockStore struct { | ||
| cache *lru.TwoQueueCache[string, []byte] | ||
| rehash *uatomic.Bool | ||
| cacheHitsMetric prometheus.Counter | ||
| cacheRequestsMetric prometheus.Counter | ||
| } | ||
|
|
||
| var _ blockstore.Blockstore = (*cacheBlockStore)(nil) | ||
|
|
||
| // NewCacheBlockStore creates a new [blockstore.Blockstore] that caches blocks | ||
| // in memory using a two queue cache. It can be useful, for example, when paired | ||
| // with a proxy blockstore (see [NewProxyBlockstore]). | ||
| func NewCacheBlockStore(size int) (blockstore.Blockstore, error) { | ||
| c, err := lru.New2Q[string, []byte](size) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| cacheHitsMetric := prometheus.NewCounter(prometheus.CounterOpts{ | ||
| Namespace: "ipfs", | ||
| Subsystem: "http", | ||
| Name: "blockstore_cache_hit", | ||
| Help: "The number of global block cache hits.", | ||
| }) | ||
|
|
||
| cacheRequestsMetric := prometheus.NewCounter(prometheus.CounterOpts{ | ||
| Namespace: "ipfs", | ||
| Subsystem: "http", | ||
| Name: "blockstore_cache_requests", | ||
| Help: "The number of global block cache requests.", | ||
| }) | ||
|
|
||
| err = prometheus.Register(cacheHitsMetric) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| err = prometheus.Register(cacheRequestsMetric) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &cacheBlockStore{ | ||
| cache: c, | ||
| rehash: uatomic.NewBool(false), | ||
| cacheHitsMetric: cacheHitsMetric, | ||
| cacheRequestsMetric: cacheRequestsMetric, | ||
| }, nil | ||
| } | ||
|
|
||
| func (l *cacheBlockStore) DeleteBlock(ctx context.Context, c cid.Cid) error { | ||
| l.cache.Remove(string(c.Hash())) | ||
| return nil | ||
| } | ||
|
|
||
| func (l *cacheBlockStore) Has(ctx context.Context, c cid.Cid) (bool, error) { | ||
| return l.cache.Contains(string(c.Hash())), nil | ||
| } | ||
|
|
||
| func (l *cacheBlockStore) Get(ctx context.Context, c cid.Cid) (blocks.Block, error) { | ||
| l.cacheRequestsMetric.Add(1) | ||
|
|
||
| blkData, found := l.cache.Get(string(c.Hash())) | ||
| if !found { | ||
| if log.Level().Enabled(zapcore.DebugLevel) { | ||
| log.Debugw("block not found in cache", "cid", c.String()) | ||
| } | ||
| return nil, format.ErrNotFound{Cid: c} | ||
| } | ||
|
|
||
| // It's a HIT! | ||
| l.cacheHitsMetric.Add(1) | ||
| if log.Level().Enabled(zapcore.DebugLevel) { | ||
| log.Debugw("block found in cache", "cid", c.String()) | ||
| } | ||
|
|
||
| if l.rehash.Load() { | ||
| rbcid, err := c.Prefix().Sum(blkData) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if !rbcid.Equals(c) { | ||
| return nil, blockstore.ErrHashMismatch | ||
| } | ||
| } | ||
|
|
||
| return blocks.NewBlockWithCid(blkData, c) | ||
| } | ||
|
|
||
| func (l *cacheBlockStore) GetSize(ctx context.Context, c cid.Cid) (int, error) { | ||
| blkData, found := l.cache.Get(string(c.Hash())) | ||
| if !found { | ||
| return -1, format.ErrNotFound{Cid: c} | ||
| } | ||
|
|
||
| return len(blkData), nil | ||
| } | ||
|
|
||
| func (l *cacheBlockStore) Put(ctx context.Context, blk blocks.Block) error { | ||
| l.cache.Add(string(blk.Cid().Hash()), blk.RawData()) | ||
| return nil | ||
| } | ||
|
|
||
| func (l *cacheBlockStore) PutMany(ctx context.Context, blks []blocks.Block) error { | ||
| for _, b := range blks { | ||
| if err := l.Put(ctx, b); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (l *cacheBlockStore) AllKeysChan(ctx context.Context) (<-chan cid.Cid, error) { | ||
| return nil, errors.New("not implemented") | ||
| } | ||
|
|
||
| func (l *cacheBlockStore) HashOnRead(enabled bool) { | ||
| l.rehash.Store(enabled) | ||
| } |
Oops, something went wrong.