Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

perf(context): avoid unnecessary copies in KVStore, TransientStore and CacheContext methods #14354

Merged
merged 15 commits into from
Dec 19, 2022
Merged

perf(context): avoid unnecessary copies in KVStore, TransientStore and CacheContext methods #14354

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
08d67a0
feat: Context.KVStore uses local ms field instead of calling MultiStore
Dec 7, 2022
6046a50
feat: sdk.Context KVStore and TransientStore to use pointer receiver
Dec 7, 2022
68a1523
feat: sdk.Context KVStore and TransientStore to gasMeter field
Dec 7, 2022
940980d
feat: gaskv config as pointer
Dec 7, 2022
8a9565f
chore: code cleanup
Dec 8, 2022
5b25cd0
Merge branch 'main' into tip/improve-context-KVStore
Dec 19, 2022
0b5e022
revert: behavioural changes
Dec 19, 2022
f1fd7fb
revert: docs
Dec 19, 2022
0ae513f
revert: tests
Dec 19, 2022
cd7c27f
add: transient tests
Dec 19, 2022
d2ffbb4
revert: oneline instantiation
Dec 19, 2022
6f09435
add: cache context bench
Dec 19, 2022
2052646
chore: lint
Dec 19, 2022
869e3d5
Merge branch 'main' into tip/improve-context-KVStore
alexanderbez Dec 19, 2022
6f89bcd
Update CHANGELOG.md
testinginprod Dec 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions types/context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,20 +278,20 @@ func (c Context) Value(key interface{}) interface{} {

// KVStore fetches a KVStore from the MultiStore.
func (c Context) KVStore(key storetypes.StoreKey) KVStore {
testinginprod marked this conversation as resolved.
Show resolved Hide resolved
return gaskv.NewStore(c.MultiStore().GetKVStore(key), c.GasMeter(), c.kvGasConfig)
return gaskv.NewStore(c.ms.GetKVStore(key), c.gasMeter, c.kvGasConfig)
}

// TransientStore fetches a TransientStore from the MultiStore.
func (c Context) TransientStore(key storetypes.StoreKey) KVStore {
return gaskv.NewStore(c.MultiStore().GetKVStore(key), c.GasMeter(), c.transientKVGasConfig)
return gaskv.NewStore(c.ms.GetKVStore(key), c.gasMeter, c.transientKVGasConfig)
}

// CacheContext returns a new Context with the multi-store cached and a new
// EventManager. The cached context is written to the context when writeCache
// is called. Note, events are automatically emitted on the parent context's
// EventManager when the caller executes the write.
func (c Context) CacheContext() (cc Context, writeCache func()) {
cms := c.MultiStore().CacheMultiStore()
cms := c.ms.CacheMultiStore()
cc = c.WithMultiStore(cms).WithEventManager(NewEventManager())

writeCache = func() {
Comment on lines 290 to 297
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change potentially affects state.

Call sequence:

(github.com/cosmos/cosmos-sdk/types.Context).CacheContext (types/context.go:293)
(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).getContextForTx (types/context.go:570)
(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).runTx (types/context.go:618)
(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).DeliverTx (types/context.go:326)

Expand Down
41 changes: 41 additions & 0 deletions types/context_bench_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
package types_test

import (
"testing"

"github.com/cosmos/cosmos-sdk/store/types"
"github.com/cosmos/cosmos-sdk/testutil"
)

func BenchmarkContext_KVStore(b *testing.B) {
key := types.NewKVStoreKey(b.Name() + "_TestCacheContext")

ctx := testutil.DefaultContext(key, types.NewTransientStoreKey("transient_"+b.Name()))

b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = ctx.KVStore(key)
}
}

func BenchmarkContext_TransientStore(b *testing.B) {
key := types.NewKVStoreKey(b.Name() + "_TestCacheContext")

ctx := testutil.DefaultContext(key, types.NewTransientStoreKey("transient_"+b.Name()))

b.ResetTimer()
for i := 0; i < b.N; i++ {
_ = ctx.TransientStore(key)
}
}

func BenchmarkContext_CacheContext(b *testing.B) {
key := types.NewKVStoreKey(b.Name() + "_TestCacheContext")

ctx := testutil.DefaultContext(key, types.NewTransientStoreKey("transient_"+b.Name()))

b.ResetTimer()
for i := 0; i < b.N; i++ {
_, _ = ctx.CacheContext()
}
}