Skip to content

fix(x/tx): concurrent map writes when calling GetSigners #21073

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

Merged
facundomedica merged 9 commits into from
Jul 31, 2024
Merged

fix(x/tx): concurrent map writes when calling GetSigners #21073

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
764d30f
fix: concurrent map writes when calling GetSigners
facundomedica Jul 25, 2024
33348e7
cl++
facundomedica Jul 25, 2024
168407a
another try
facundomedica Jul 29, 2024
8f8322d
progress
facundomedica Jul 29, 2024
4f31098
test
facundomedica Jul 29, 2024
848b15f
use sync.Map :(
facundomedica Jul 30, 2024
c077988
cl
facundomedica Jul 30, 2024
313f9eb
do not do validate on init
facundomedica Jul 31, 2024
a042f81
do not do validate on init
facundomedica Jul 31, 2024
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
5 changes: 5 additions & 0 deletions simapp/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,11 @@ func NewSimApp(
}
}

// validate SigningContext to pre-fill internal signers funcs map
if err = app.interfaceRegistry.SigningContext().Validate(); err != nil {
panic(err)
}

return app
}

Expand Down
4 changes: 4 additions & 0 deletions x/tx/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Since v0.13.0, x/tx follows Cosmos SDK semver: https://github.com/cosmos/cosmos-

## [Unreleased]

### Improvements

* [#21073](https://github.com/cosmos/cosmos-sdk/pull/21073) Add write-only mutex in Context to protect `getSignersFuncs` map from concurrent writes.

## [v0.13.3](https://github.com/cosmos/cosmos-sdk/releases/tag/x/tx/v0.13.3) - 2024-04-22

### Improvements
Expand Down
8 changes: 7 additions & 1 deletion x/tx/signing/context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package signing
import (
"errors"
"fmt"
"sync"

cosmos_proto "github.com/cosmos/cosmos-proto"
gogoproto "github.com/cosmos/gogoproto/proto"
Expand All @@ -29,9 +30,11 @@ type Context struct {
typeResolver protoregistry.MessageTypeResolver
addressCodec address.Codec
validatorAddressCodec address.Codec
getSignersFuncs map[protoreflect.FullName]GetSignersFunc
customGetSignerFuncs map[protoreflect.FullName]GetSignersFunc
maxRecursionDepth int

mtx sync.Mutex
getSignersFuncs map[protoreflect.FullName]GetSignersFunc
}

// Options are options for creating Context which will be used for signing operations.
Expand Down Expand Up @@ -110,6 +113,7 @@ func NewContext(options Options) (*Context, error) {
typeResolver: protoTypes,
addressCodec: options.AddressCodec,
validatorAddressCodec: options.ValidatorAddressCodec,
mtx: sync.Mutex{},
getSignersFuncs: map[protoreflect.FullName]GetSignersFunc{},
customGetSignerFuncs: customGetSignerFuncs,
maxRecursionDepth: options.MaxRecursionDepth,
Expand Down Expand Up @@ -336,6 +340,8 @@ func (c *Context) getGetSignersFn(messageDescriptor protoreflect.MessageDescript
}
f, ok = c.getSignersFuncs[messageDescriptor.FullName()]
if !ok {
c.mtx.Lock()
defer c.mtx.Unlock()
var err error
f, err = c.makeGetSignersFunc(messageDescriptor)

@kocubinski kocubinski Jul 25, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm because makeGetSignersFunc is stateless right? so worst case we get multiple blocked writes which will quickly resolve

@facundomedica facundomedica Jul 25, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yeap, before the worst case would bring the node down, now the worst case just creates some tiny delays

if err != nil {
Expand Down
⚡