Add cache to stf context #19875

hieuvubk · 2024-03-26T19:14:26Z

Description

Closes: #19223

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

Add object cache to stf context
get, set, remove of items affects cache
add tests

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

coderabbitai · 2024-03-26T19:14:32Z

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

tac0turtle · 2024-03-26T19:18:23Z

server/v2/stf/stf.go

@@ -391,6 +391,7 @@ type executionContext struct {
 	meter  gas.Meter
 	events []event.Event
 	sender []transaction.Identity
+	Cache  ModuleContainer


will this be a source of concurrency issues, when parrallized txs become a thing?

do you mean by using the same ctx for many txs?

u right we use clone ctx through makeContext, need a way to update actual ctx after exec tx.
Let me adjust

server/v2/stf/cache.go

+	return kc
+}
+
+func unsafeString(b []byte) string { return *(*string)(unsafe.Pointer(&b)) }


server/v2/stf/cache.go

server/v2/stf/stf.go

@@ -349,6 +357,7 @@
 	if err != nil {
 		return nil, nil, err
 	}
+	applyContextCache(ctx, ebCtx)


server/v2/stf/stf.go

@@ -338,6 +345,7 @@
 			event.Attribute{Key: "mode", Value: "BeginBlock"},
 		)
 	}
+	applyContextCache(ctx, ebCtx)


server/v2/stf/stf.go

@@ -314,6 +320,7 @@
 			event.Attribute{Key: "mode", Value: "BeginBlock"},
 		)
 	}
+	applyContextCache(ctx, bbCtx)


server/v2/stf/stf.go

@@ -297,6 +302,7 @@
 			event.Attribute{Key: "mode", Value: "PreBlock"},
 		)
 	}
+	applyContextCache(ctx, pbCtx)


server/v2/stf/stf.go

@@ -281,6 +285,7 @@
 		}
 		msgResps[i] = resp
 	}
+	applyContextCache(ctx, execCtx)


server/v2/stf/stf.go

@@ -258,6 +261,7 @@
 	if applyErr != nil {
 		return nil, 0, nil, applyErr
 	}
+	applyContextCache(ctx, postTxCtx)


server/v2/stf/stf.go

@@ -240,6 +242,7 @@
 		if applyErr != nil {
 			return nil, 0, nil, applyErr
 		}
+		applyContextCache(ctx, postTxCtx)


server/v2/stf/stf.go

@@ -205,6 +206,7 @@
 	if err != nil {
 		return 0, nil, err
 	}
+	applyContextCache(ctx, validateCtx)


hieuvubk · 2024-03-27T11:42:54Z

I have initialized the empty cache for ctx with each DeliverBlock. ctx.Cache will be updated during block execution (via the applyCache function).

One problem I'm facing is that the cache is only written by item.Set. Imagine a block that only executes Get functions (cache is empty so optimization is meaningless).

What if we modified the item.Get() function a bit? If the item is present but not in the cache, save it to the cache for later use

wdut? @tac0turtle

tac0turtle · 2024-03-28T06:14:59Z

What if we modified the item.Get() function a bit? If the item is present but not in the cache, save it to the cache for later use

wdut? @tac0turtle

Yea this is needed!!

hieuvubk · 2024-03-28T08:03:35Z

What if we modified the item.Get() function a bit? If the item is present but not in the cache, save it to the cache for later use
wdut? @tac0turtle

Yea this is needed!!

Adjusted in 29eb7d2

server/v2/stf/cache.go

kocubinski · 2024-04-04T13:49:40Z

collections/item.go

@@ -6,11 +6,15 @@ import (
 	"fmt"

 	"cosmossdk.io/collections/codec"
+	"cosmossdk.io/server/v2/stf"


This seems problematic, collections should not depend on server v2 and STF.

Ty, Wrapped in a container.Service. Now collections is not depended on stf.

kocubinski

collections should not depend on server/v2

server/v2/stf/cache.go

tac0turtle · 2024-05-03T13:22:06Z

server/v2/stf/go.mod


 require (
-	cosmossdk.io/core v0.11.0
+	cosmossdk.io/collections v0.4.0


can this be removed?

hmm it's using for the test

alpe

I have very limited context on the new stf but I am bit worried about dirty reads in the caching approach. I could not find where state is reverted when a CacheMultiStore is discarded. Also the cache seems to be reused via applyContextCache by different methods. But I may got that wrong.

I found caching very hard to get right in the past. Especially on the app level. There should be caching on the store level already. It would be good to see some bechmarks how much another cache adds on the app level to this.
Ideally, caches come with configuration options so that people can trade memory for cpu and some metrics that show internals like usage size and hit rate.

server/v2/stf/cache.go

alpe · 2024-05-06T07:16:08Z

core/container/service.go

+// Package branch contains the core branch service interface.
+package container
+
+type Service interface {


personal preference: Service is a very overused name. Naming is hard but In this context, I assume it is just an abstract cache?
Would it make sense to move the interface to collections package?

alpe · 2024-05-06T07:18:34Z

collections/item.go

-type Item[V any] Map[noKey, V]
+type Item[V any] struct {
+	m            Map[noKey, V]
+	getContainer func(ctx context.Context) container.Service


q: why is it called container and not cache?

alpe · 2024-05-06T07:30:04Z

server/v2/stf/cache.go

+
+func NewModuleContainer() ModuleContainer {
+	return ModuleContainer{
+		m: make(map[string]Container),


note: this cache is not limited. In address package for example simplelru.NewLRU is used. Would it make sense here, too?
The cache is not safe for concurrent access. Looking into the future, would it make sense to support parallel execution?

alpe · 2024-05-06T07:38:11Z

server/v2/stf/stf.go

+func applyContextCache(dst, src context.Context) error {
+	srcExecutionCtx, ok := src.(*executionContext)
+	if !ok {
+		return fmt.Errorf("Can not convert ctx to executionContext")


Looks like the errors are not handled by the callers. Would it make sense to drop them here already?

tac0turtle · 2024-05-06T09:23:08Z

I have very limited context on the new stf but I am bit worried about dirty reads in the caching approach. I could not find where state is reverted when a CacheMultiStore is discarded. Also the cache seems to be reused via applyContextCache by different methods. But I may got that wrong.

I found caching very hard to get right in the past. Especially on the app level. There should be caching on the store level already. It would be good to see some bechmarks how much another cache adds on the app level to this. Ideally, caches come with configuration options so that people can trade memory for cpu and some metrics that show internals like usage size and hit rate.

Thanks for reviewing. I agree this is hard. The idea here is to cache decoded values. You are right there are caches at the store level and within the database. We have found for certain items decoding is a large overhead and done many times during a block. This is meant to reduce this

collections/go.mod

tac0turtle

We should make sure this works in the parallel execution case as well.

testinginprod · 2024-05-16T08:46:54Z

server/v2/stf/export.go

+	return ctx.(*executionContext)
+}
+
+func NewExecutionContext() *executionContext {


these things should not be exported

testinginprod · 2024-05-16T08:47:18Z

collections/schema.go

-	return NewSchemaBuilderFromAccessor(service.OpenKVStore)
+	sb := NewSchemaBuilderFromAccessor(service.OpenKVStore)
+	kl, ok := service.(interface {
+		OpenContainer(ctx context.Context) container.Service


this interface should be in core

Co-authored-by: Marko <[email protected]>

testinginprod · 2024-05-16T08:48:07Z

collections/item.go

 	return item
 }

 // Get gets the item, if it is not set it returns an ErrNotFound error.
 // If value decoding fails then an ErrEncoding is returned.
 func (i Item[V]) Get(ctx context.Context) (V, error) {
-	return (Map[noKey, V])(i).Get(ctx, noKey{})
+	var toCache bool


is this boolean really needed?

Its used for case cache is empty when we get value from Item. So we will cache value of 1st get.

…smos-sdk into decentrio/stf_cache

tac0turtle · 2024-06-12T20:28:50Z

closing this as we are upstreaming server modular to main and should add a quick adr on the design

hieuvubk added 3 commits March 27, 2024 02:09

add cache to ctx

7866480

schema & item handle

882d54a

set up test

f015840

hieuvubk requested a review from a team as a code owner March 26, 2024 19:14

github-actions bot added the C:collections label Mar 26, 2024

tac0turtle reviewed Mar 26, 2024

View reviewed changes

github-advanced-security bot found potential problems Mar 26, 2024

View reviewed changes

server/v2/stf/cache.go

return kc

}

func unsafeString(b []byte) string { return *(*string)(unsafe.Pointer(&b)) }

Check warning

Code scanning / gosec

Use of unsafe calls should be audited

Use of unsafe calls should be audited

hieuvubk marked this pull request as draft March 26, 2024 19:37

github-advanced-security bot found potential problems Mar 26, 2024

View reviewed changes

server/v2/stf/cache.go Fixed Show fixed Hide fixed

hieuvubk added 3 commits March 27, 2024 18:21

apply cache from makeContext to origin context

c90e704

basic test

19a2f82

merge upstream

3486c2b

github-advanced-security bot found potential problems Mar 27, 2024

View reviewed changes

go mod tidy

b8f2f94

item.Get() add item to cache if not cached

29eb7d2

go mod tidy

118bf9e

hieuvubk marked this pull request as ready for review March 30, 2024 08:41

tac0turtle assigned yihuang, kocubinski, facundomedica and testinginprod Apr 2, 2024

tac0turtle reviewed Apr 2, 2024

View reviewed changes

server/v2/stf/cache.go Show resolved Hide resolved

kocubinski reviewed Apr 4, 2024

View reviewed changes

kocubinski requested changes Apr 4, 2024

View reviewed changes

hieuvubk added 2 commits April 5, 2024 15:10

container service

5406a34

replace

7ea4c61

hieuvubk added 3 commits April 5, 2024 15:11

use interface

78f4305

test

d0f8b7c

lint

109f4ce

hieuvubk requested review from tac0turtle and kocubinski April 5, 2024 08:20

github-advanced-security bot found potential problems Apr 5, 2024

View reviewed changes

server/v2/stf/cache.go Dismissed Show dismissed Hide dismissed

tac0turtle reviewed May 3, 2024

View reviewed changes

hieuvubk added 2 commits May 4, 2024 23:44

mock item & remove collection depend

db62014

fix cmt

e0f507c

alpe reviewed May 6, 2024

View reviewed changes

hieuvubk added 2 commits May 7, 2024 13:19

merge server_modular

c5c7280

go mod tidy

48bba43

tac0turtle reviewed May 16, 2024

View reviewed changes

collections/go.mod Outdated Show resolved Hide resolved

tac0turtle reviewed May 16, 2024

View reviewed changes

unused

75797d8

testinginprod reviewed May 16, 2024

View reviewed changes

Update collections/go.mod

044fe2d

Co-authored-by: Marko <[email protected]>

testinginprod reviewed May 16, 2024

View reviewed changes

hieuvubk added 4 commits May 16, 2024 17:49

GetContainer as service

a6f0955

refactor

54cb1f5

Merge branch 'decentrio/stf_cache' of https://github.com/decentrio/co…

db9d5dd

…smos-sdk into decentrio/stf_cache

fix build

7a4f436

tac0turtle requested review from testinginprod and alpe June 6, 2024 10:01

tac0turtle closed this Jun 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add cache to stf context #19875

Add cache to stf context #19875

hieuvubk commented Mar 26, 2024

coderabbitai bot commented Mar 26, 2024 •

edited

Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

tac0turtle Mar 26, 2024

hieuvubk Mar 26, 2024

hieuvubk Mar 26, 2024

hieuvubk commented Mar 27, 2024

tac0turtle commented Mar 28, 2024

hieuvubk commented Mar 28, 2024

kocubinski Apr 4, 2024

hieuvubk Apr 5, 2024

kocubinski left a comment

tac0turtle May 3, 2024

hieuvubk May 3, 2024

alpe left a comment

alpe May 6, 2024

alpe May 6, 2024

alpe May 6, 2024

alpe May 6, 2024

tac0turtle commented May 6, 2024

tac0turtle left a comment •

edited

Loading

testinginprod May 16, 2024

testinginprod May 16, 2024

hieuvubk May 16, 2024

testinginprod May 16, 2024

hieuvubk May 16, 2024

tac0turtle commented Jun 12, 2024

Add cache to stf context #19875

Add cache to stf context #19875

Conversation

hieuvubk commented Mar 26, 2024

Description

Author Checklist

Reviewers Checklist

coderabbitai bot commented Mar 26, 2024 • edited Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hieuvubk commented Mar 27, 2024

tac0turtle commented Mar 28, 2024

hieuvubk commented Mar 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kocubinski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alpe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tac0turtle commented May 6, 2024

tac0turtle left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tac0turtle commented Jun 12, 2024

coderabbitai bot commented Mar 26, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

tac0turtle left a comment •

edited

Loading