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

Defer parser initialization to Start #1442

Merged
merged 5 commits into from
Apr 28, 2023
Merged

Defer parser initialization to Start #1442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
078e7fc
Defer parser initialization to Start
StephenButtolph Apr 28, 2023
ce6b56e
document invariant
StephenButtolph Apr 28, 2023
db565da
fix linting
StephenButtolph Apr 28, 2023
a32fcc9
add regression test
StephenButtolph Apr 28, 2023
d4cb3bf
cleanup
StephenButtolph Apr 28, 2023
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
3 changes: 0 additions & 3 deletions chains/manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -885,7 +885,6 @@ func (m *manager) createAvalancheChain(
VM: vmWrappingProposerVM,
}
snowmanBootstrapper, err := smbootstrap.New(
context.TODO(),
bootstrapCfg,
snowmanEngine.Start,
)
Expand Down Expand Up @@ -939,7 +938,6 @@ func (m *manager) createAvalancheChain(
}

avalancheBootstrapper, err := avbootstrap.New(
context.TODO(),
avalancheBootstrapperConfig,
snowmanBootstrapper.Start,
)
Expand Down Expand Up @@ -1223,7 +1221,6 @@ func (m *manager) createSnowmanChain(
Bootstrapped: bootstrapFunc,
}
bootstrapper, err := smbootstrap.New(
context.TODO(),
bootstrapCfg,
engine.Start,
)
Expand Down
39 changes: 20 additions & 19 deletions snow/engine/avalanche/bootstrap/bootstrapper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ const (
var _ common.BootstrapableEngine = (*bootstrapper)(nil)

func New(
ctx context.Context,
config Config,
onFinished func(ctx context.Context, lastReqID uint32) error,
) (common.BootstrapableEngine, error) {
Expand All @@ -57,29 +56,13 @@ func New(
return nil, err
}

if err := b.VtxBlocked.SetParser(ctx, &vtxParser{
log: config.Ctx.Log,
numAccepted: b.numAcceptedVts,
numDropped: b.numDroppedVts,
manager: b.Manager,
}); err != nil {
return nil, err
}

if err := b.TxBlocked.SetParser(&txParser{
log: config.Ctx.Log,
numAccepted: b.numAcceptedTxs,
numDropped: b.numDroppedTxs,
vm: b.VM,
}); err != nil {
return nil, err
}

config.Config.Bootstrapable = b
b.Bootstrapper = common.NewCommonBootstrapper(config.Config)
return b, nil
}

// Note: To align with the Snowman invariant, it should be guaranteed the VM is
// not used until after the bootstrapper has been Started.
type bootstrapper struct {
Config

Expand Down Expand Up @@ -315,6 +298,24 @@ func (b *bootstrapper) Start(ctx context.Context, startReqID uint32) error {
err)
}

if err := b.VtxBlocked.SetParser(ctx, &vtxParser{
log: b.Ctx.Log,
numAccepted: b.numAcceptedVts,
numDropped: b.numDroppedVts,
manager: b.Manager,
}); err != nil {
return err
}

if err := b.TxBlocked.SetParser(&txParser{
log: b.Ctx.Log,
numAccepted: b.numAcceptedTxs,
numDropped: b.numDroppedTxs,
vm: b.VM,
}); err != nil {
return err
}

b.Config.SharedCfg.RequestID = startReqID

// If the network was already linearized, don't attempt to linearize it
Expand Down
7 changes: 0 additions & 7 deletions snow/engine/avalanche/bootstrap/bootstrapper_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,6 @@ func TestBootstrapperSingleFrontier(t *testing.T) {
}

bs, err := New(
context.Background(),
config,
func(context.Context, uint32) error {
config.Ctx.State.Set(snow.EngineState{
Expand Down Expand Up @@ -253,7 +252,6 @@ func TestBootstrapperByzantineResponses(t *testing.T) {
}

bs, err := New(
context.Background(),
config,
func(context.Context, uint32) error {
config.Ctx.State.Set(snow.EngineState{
Expand Down Expand Up @@ -421,7 +419,6 @@ func TestBootstrapperTxDependencies(t *testing.T) {
}

bs, err := New(
context.Background(),
config,
func(context.Context, uint32) error {
config.Ctx.State.Set(snow.EngineState{
Expand Down Expand Up @@ -548,7 +545,6 @@ func TestBootstrapperIncompleteAncestors(t *testing.T) {
}

bs, err := New(
context.Background(),
config,
func(context.Context, uint32) error {
config.Ctx.State.Set(snow.EngineState{
Expand Down Expand Up @@ -660,7 +656,6 @@ func TestBootstrapperFinalized(t *testing.T) {
}

bs, err := New(
context.Background(),
config,
func(context.Context, uint32) error {
config.Ctx.State.Set(snow.EngineState{
Expand Down Expand Up @@ -788,7 +783,6 @@ func TestBootstrapperAcceptsAncestorsParents(t *testing.T) {
}

bs, err := New(
context.Background(),
config,
func(context.Context, uint32) error {
config.Ctx.State.Set(snow.EngineState{
Expand Down Expand Up @@ -953,7 +947,6 @@ func TestRestartBootstrapping(t *testing.T) {
}

bsIntf, err := New(
context.Background(),
config,
func(context.Context, uint32) error {
config.Ctx.State.Set(snow.EngineState{
Expand Down
2 changes: 0 additions & 2 deletions snow/engine/snowman/bootstrap/block_job.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ func (p *parser) Parse(ctx context.Context, blkBytes []byte) (queue.Job, error)
return nil, err
}
return &blockJob{
parser: p,
log: p.log,
numAccepted: p.numAccepted,
numDropped: p.numDropped,
Expand All @@ -45,7 +44,6 @@ func (p *parser) Parse(ctx context.Context, blkBytes []byte) (queue.Job, error)
}

type blockJob struct {
parser *parser
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This isn't really part of this PR... but this was dead code and having it here made the test harder to make... win win removing it

log logging.Logger
numAccepted, numDropped prometheus.Counter
blk snowman.Block
Expand Down
25 changes: 13 additions & 12 deletions snow/engine/snowman/bootstrap/bootstrapper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ var (
errUnexpectedTimeout = errors.New("unexpected timeout fired")
)

// Invariant: The VM is not guaranteed to be initialized until Start has been
// called, so it must be guaranteed the VM is not used until after Start.
type bootstrapper struct {
Config

Expand Down Expand Up @@ -81,7 +83,7 @@ type bootstrapper struct {
bootstrappedOnce sync.Once
}

func New(ctx context.Context, config Config, onFinished func(ctx context.Context, lastReqID uint32) error) (common.BootstrapableEngine, error) {
func New(config Config, onFinished func(ctx context.Context, lastReqID uint32) error) (common.BootstrapableEngine, error) {
metrics, err := newMetrics("bs", config.Ctx.Registerer)
if err != nil {
return nil, err
Expand All @@ -103,16 +105,6 @@ func New(ctx context.Context, config Config, onFinished func(ctx context.Context
executedStateTransitions: math.MaxInt32,
}

b.parser = &parser{
log: config.Ctx.Log,
numAccepted: b.numAccepted,
numDropped: b.numDropped,
vm: b.VM,
}
if err := b.Blocked.SetParser(ctx, b.parser); err != nil {
return nil, err
}

config.Bootstrapable = b
b.Bootstrapper = common.NewCommonBootstrapper(config.Config)

Expand All @@ -131,6 +123,16 @@ func (b *bootstrapper) Start(ctx context.Context, startReqID uint32) error {
err)
}

b.parser = &parser{
log: b.Ctx.Log,
numAccepted: b.numAccepted,
numDropped: b.numDropped,
vm: b.VM,
}
if err := b.Blocked.SetParser(ctx, b.parser); err != nil {
return err
}

// Set the starting height
lastAcceptedID, err := b.VM.LastAccepted(ctx)
if err != nil {
Expand Down Expand Up @@ -456,7 +458,6 @@ func (b *bootstrapper) process(ctx context.Context, blk snowman.Block, processin
}

pushed, err := b.Blocked.Push(ctx, &blockJob{
parser: b.parser,
log: b.Ctx.Log,
numAccepted: b.numAccepted,
numDropped: b.numDropped,
Expand Down
Loading