multi: Introduce lru module. #1683
Merged
Conversation
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
jrick
approved these changes
Mar 18, 2019
This adds the go 1.11 directive to all of the modules in order to clearly mark they build and work with that version. Go 1.12 modified the tools such that tidy will automatically add the new version to modules that do not already have a directive and that would prevent builds on Go 1.11 through Go 1.11.3 which is not desirable.
dajohi
approved these changes
Mar 18, 2019
This implements a new module named lru which provides a concurrency safe least-recently-used cache with nearly early O(1) lookups, inserts, and deletions. The cache is limited to a maximum number of items with eviction for the oldest entry when the limit is exceeded. This will allow the various concrete implementations to be updated to make use of this shared module instead of duplicating code. There is no additional performance hit to making use of this generic version because the internal list already causes the item to be boxed anyway, so the addition of the interface for the type does not cause an additional alloc. This can be seen by comparing this generic implementation to the existing concrete nonce implementation in peer: BenchmarkCache 1 allocs/op BenchmarkLruNonceList 1 allocs/op It also includes comprehensive tests, a benchmark, full package documentation, and a basic usage example.
This updates the docs/README.md file, module hierarchy graphviz, and module hierarchy diagram to reflect the new lru module.
This updates the concrete peer known inventory LRU cache to make use of the new generic LRU cache provided by the lru module. It also removes the nor longer necessary specialized implementation.
This updates the concrete peer sent nonces LRU cache to make use of the new generic LRU cache provided by the lru module. It also removes the nor longer necessary specialized implementation.
This updates the server known address cache to make use of the new generic LRU cache provided by the lru module.
davecgh
force-pushed
the
multi_lru_module
branch
from
966e034 to
0173adf
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently, there are multiple places where either a LRU cache is already used or could be improved to make use of one. The cases that are already making use of an LRU cache have nearly identical specialized implementations which results in duplicated code.
Thus, this implements a new module named
lruwhich provides a concurrency safe least-recently-used cache with nearly early O(1) lookups, inserts, and deletions and updates both thepeerandserverto make use of it. The cache is limited to a maximum number of items with eviction for the oldest entry when the limit is exceeded.There is no additional performance hit to allocations by making use of this generic version because the internal list already causes the item to be boxed anyway, so the addition of the interface for the type does not cause an additional allocation.
This can be seen by comparing this generic implementation to the existing concrete nonce implementation in peer:
A series of individual commits have been used to make the review process easier. Each commit message more thoroughly describes its purpose, but primarily they consist of the following:
lrumodule with the generic LRU cachepeerto make use of the newlrumodule for known inventorypeerto make use of the newlrumodule for sent noncesserverto make use of the newlrumodule for known addresses