-
Notifications
You must be signed in to change notification settings - Fork 129
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(dot/state): replace
sync.Map with map+mutex (#2286)
- Loading branch information
Showing
4 changed files
with
445 additions
and
64 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,91 @@ | ||
| // Copyright 2022 ChainSafe Systems (ON) | ||
| // SPDX-License-Identifier: LGPL-3.0-only | ||
|
|
||
| package state | ||
|
|
||
| import ( | ||
| "sync" | ||
|
|
||
| "github.com/ChainSafe/gossamer/dot/types" | ||
| "github.com/ChainSafe/gossamer/lib/common" | ||
| ) | ||
|
|
||
| // hashToBlockMap implements a thread safe map of block header hashes | ||
| // to block pointers. It has helper methods to fit the needs of callers | ||
| // in this package. | ||
| type hashToBlockMap struct { | ||
| mutex sync.RWMutex | ||
| mapping map[common.Hash]*types.Block | ||
| } | ||
|
|
||
| func newHashToBlockMap() *hashToBlockMap { | ||
| return &hashToBlockMap{ | ||
| mapping: make(map[common.Hash]*types.Block), | ||
| } | ||
| } | ||
|
|
||
| // getBlock returns a pointer to the block stored at the hash given, | ||
| // or nil if not found. | ||
| // Note this returns a pointer to the block so modifying the returned value | ||
| // will modify the block stored in the map, potentially leading to data races | ||
| // or unwanted changes, so be careful. | ||
| func (h *hashToBlockMap) getBlock(hash common.Hash) (block *types.Block) { | ||
| h.mutex.RLock() | ||
| defer h.mutex.RUnlock() | ||
| return h.mapping[hash] | ||
| } | ||
|
|
||
| // getBlockHeader returns a pointer to the header of the block stored at the | ||
| // hash given, or nil if not found. | ||
| // Note this returns a pointer to the header of the block so modifying the | ||
| // returned value will modify the header of the block stored in the map, | ||
| // potentially leading to data races or unwanted changes, so be careful. | ||
| func (h *hashToBlockMap) getBlockHeader(hash common.Hash) (header *types.Header) { | ||
| h.mutex.RLock() | ||
| defer h.mutex.RUnlock() | ||
| block := h.mapping[hash] | ||
| if block == nil { | ||
| return nil | ||
| } | ||
| return &block.Header | ||
| } | ||
|
|
||
| // getBlockBody returns a pointer to the body of the block stored at the | ||
| // hash given, or nil if not found. | ||
| // Note this returns a pointer to the body of the block so modifying the | ||
| // returned value will modify the body of the block stored in the map, | ||
| // potentially leading to data races or unwanted changes, so be careful. | ||
| func (h *hashToBlockMap) getBlockBody(hash common.Hash) (body *types.Body) { | ||
| h.mutex.RLock() | ||
| defer h.mutex.RUnlock() | ||
| block := h.mapping[hash] | ||
| if block == nil { | ||
| return nil | ||
| } | ||
| return &block.Body | ||
| } | ||
|
|
||
| // store stores a block and uses its header hash digest as key. | ||
| // Note the block is not deep copied so mutating the passed argument | ||
| // will lead to mutation for the block in the map and returned by this map. | ||
| // Also note this operation sets the hash field on the block header because of | ||
| // the call to block.Header.Hash(). | ||
| func (h *hashToBlockMap) store(block *types.Block) { | ||
| h.mutex.Lock() | ||
| defer h.mutex.Unlock() | ||
| h.mapping[block.Header.Hash()] = block | ||
| } | ||
|
|
||
| // delete deletes the block stored at the hash given, and returns | ||
| // a pointer to the header of the block deleted from the map, | ||
| // or nil if the block is not found. | ||
| func (h *hashToBlockMap) delete(hash common.Hash) (deletedHeader *types.Header) { | ||
| h.mutex.Lock() | ||
| defer h.mutex.Unlock() | ||
| block := h.mapping[hash] | ||
| delete(h.mapping, hash) | ||
| if block == nil { | ||
| return nil | ||
| } | ||
| return &block.Header | ||
| } |
Oops, something went wrong.