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.

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

[STAB-31] Allow AnteHandler to control locking semantics. #37

Merged
merged 1 commit into from
Feb 6, 2024

Conversation

lcwik
Copy link

@lcwik lcwik commented Jan 31, 2024

Description

[STAB-31] Allow AnteHandler to control locking semantics.

Updated existing usages of AnteHandler in cosmos to use the instance which always locks restoring the existing contract.


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...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

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 ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Copy link

linear bot commented Jan 31, 2024

STAB-31

Copy link

@lcwik your pull request is missing a changelog!

Comment on lines 653 to +659
WithTxBytes(txBytes)
// WithVoteInfos(app.voteInfos) // TODO: identify if this is needed

// Use a new gas meter since loading the consensus params below consumes gas and causes a race condition.
//
// TODO(STAB-35): See if this can be removed.
ctx = ctx.WithGasMeter(storetypes.NewInfiniteGasMeter())

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/baseapp.BaseApp).getContextForTx (baseapp/baseapp.go:647)
(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).runTx (baseapp/baseapp.go:943)
(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).deliverTx (baseapp/baseapp.go:734)
(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).internalFinalizeBlock (baseapp/baseapp.go:725)
(*github.com/cosmos/cosmos-sdk/baseapp.BaseApp).FinalizeBlock (baseapp/baseapp.go:886)

Updated existing usages of AnteHandler in cosmos to use the instance which always locks restoring the existing contract.
// We also guarantee that the passed in context is held with a read lock allowing for concurrent
// execution.
anteCtx := ctx.WithEventManager(sdk.NewEventManager())
newCtx, err = app.anteHandler(anteCtx, tx, false /* mode == execModeSimulate */)
Copy link

Choose a reason for hiding this comment

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

Understand that all callsites never make this end up as execModeSimulate, but why did you make this explicitly false?

Copy link
Author

Choose a reason for hiding this comment

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

super minor perf optimization to reduce branch complexity

@@ -842,8 +847,8 @@ func (app *BaseApp) runCheckTxConcurrently(mode execMode, txBytes []byte) (gInfo
// embedded here to ensure that the lifetime of the mutex is limited to only this function allowing
// for the return values to be computed without holding the lock.
func() {
app.mtx.Lock()
defer app.mtx.Unlock()
app.mtx.RLock()
Copy link

Choose a reason for hiding this comment

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

Why are we confident that mutation after cacheTxContext is either safe or not done?

Copy link
Author

@lcwik lcwik Feb 6, 2024

Choose a reason for hiding this comment

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

We are not. This PR changes the contract so that the AnteHandler must ensure concurrency correctness and why I added a mutex lock AnteDecorator as the first one so that the existing concurrency model was enforced (i.e. a single global lock).

@lcwik lcwik merged commit ffeae51 into dydx-fork-v0.50.3 Feb 6, 2024
36 of 40 checks passed
@lcwik lcwik deleted the lukestab31 branch February 6, 2024 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants