-
Notifications
You must be signed in to change notification settings - Fork 670
/
acceptor.go
280 lines (231 loc) · 7.05 KB
/
acceptor.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package executor
import (
"errors"
"fmt"
"go.uber.org/zap"
"github.com/ava-labs/avalanchego/utils"
"github.com/ava-labs/avalanchego/vms/platformvm/block"
"github.com/ava-labs/avalanchego/vms/platformvm/metrics"
"github.com/ava-labs/avalanchego/vms/platformvm/state"
"github.com/ava-labs/avalanchego/vms/platformvm/validators"
)
var (
_ block.Visitor = (*acceptor)(nil)
errMissingBlockState = errors.New("missing state of block")
)
// acceptor handles the logic for accepting a block.
// All errors returned by this struct are fatal and should result in the chain
// being shutdown.
type acceptor struct {
*backend
metrics metrics.Metrics
validators validators.Manager
bootstrapped *utils.Atomic[bool]
}
func (a *acceptor) BanffAbortBlock(b *block.BanffAbortBlock) error {
return a.optionBlock(b, "banff abort")
}
func (a *acceptor) BanffCommitBlock(b *block.BanffCommitBlock) error {
return a.optionBlock(b, "banff commit")
}
func (a *acceptor) BanffProposalBlock(b *block.BanffProposalBlock) error {
a.proposalBlock(b, "banff proposal")
return nil
}
func (a *acceptor) BanffStandardBlock(b *block.BanffStandardBlock) error {
return a.standardBlock(b, "banff standard")
}
func (a *acceptor) ApricotAbortBlock(b *block.ApricotAbortBlock) error {
return a.optionBlock(b, "apricot abort")
}
func (a *acceptor) ApricotCommitBlock(b *block.ApricotCommitBlock) error {
return a.optionBlock(b, "apricot commit")
}
func (a *acceptor) ApricotProposalBlock(b *block.ApricotProposalBlock) error {
a.proposalBlock(b, "apricot proposal")
return nil
}
func (a *acceptor) ApricotStandardBlock(b *block.ApricotStandardBlock) error {
return a.standardBlock(b, "apricot standard")
}
func (a *acceptor) ApricotAtomicBlock(b *block.ApricotAtomicBlock) error {
blkID := b.ID()
defer a.free(blkID)
if err := a.commonAccept(b); err != nil {
return err
}
blkState, ok := a.blkIDToState[blkID]
if !ok {
return fmt.Errorf("%w %s", errMissingBlockState, blkID)
}
// Update the state to reflect the changes made in [onAcceptState].
if err := blkState.onAcceptState.Apply(a.state); err != nil {
return err
}
defer a.state.Abort()
batch, err := a.state.CommitBatch()
if err != nil {
return fmt.Errorf(
"failed to commit VM's database for block %s: %w",
blkID,
err,
)
}
// Note that this method writes [batch] to the database.
if err := a.ctx.SharedMemory.Apply(blkState.atomicRequests, batch); err != nil {
return fmt.Errorf(
"failed to atomically accept tx %s in block %s: %w",
b.Tx.ID(),
blkID,
err,
)
}
a.ctx.Log.Trace(
"accepted block",
zap.String("blockType", "apricot atomic"),
zap.Stringer("blkID", blkID),
zap.Uint64("height", b.Height()),
zap.Stringer("parentID", b.Parent()),
zap.Stringer("utxoChecksum", a.state.Checksum()),
)
return nil
}
func (a *acceptor) optionBlock(b block.Block, blockType string) error {
parentID := b.Parent()
parentState, ok := a.blkIDToState[parentID]
if !ok {
return fmt.Errorf("%w: %s", state.ErrMissingParentState, parentID)
}
blkID := b.ID()
defer func() {
// Note: we assume this block's sibling doesn't
// need the parent's state when it's rejected.
a.free(parentID)
a.free(blkID)
}()
// Note that the parent must be accepted first.
if err := a.commonAccept(parentState.statelessBlock); err != nil {
return err
}
if err := a.commonAccept(b); err != nil {
return err
}
if parentState.onDecisionState != nil {
if err := parentState.onDecisionState.Apply(a.state); err != nil {
return err
}
}
blkState, ok := a.blkIDToState[blkID]
if !ok {
return fmt.Errorf("%w %s", errMissingBlockState, blkID)
}
if err := blkState.onAcceptState.Apply(a.state); err != nil {
return err
}
defer a.state.Abort()
batch, err := a.state.CommitBatch()
if err != nil {
return fmt.Errorf(
"failed to commit VM's database for block %s: %w",
blkID,
err,
)
}
// Note that this method writes [batch] to the database.
if err := a.ctx.SharedMemory.Apply(parentState.atomicRequests, batch); err != nil {
return fmt.Errorf("failed to apply vm's state to shared memory: %w", err)
}
if onAcceptFunc := parentState.onAcceptFunc; onAcceptFunc != nil {
onAcceptFunc()
}
a.ctx.Log.Trace(
"accepted block",
zap.String("blockType", blockType),
zap.Stringer("blkID", blkID),
zap.Uint64("height", b.Height()),
zap.Stringer("parentID", parentID),
zap.Stringer("utxoChecksum", a.state.Checksum()),
)
return nil
}
func (a *acceptor) proposalBlock(b block.Block, blockType string) {
// Note that:
//
// * We don't free the proposal block in this method.
// It is freed when its child is accepted.
// We need to keep this block's state in memory for its child to use.
//
// * We only update the metrics to reflect this block's
// acceptance when its child is accepted.
//
// * We don't write this block to state here.
// That is done when this block's child (a CommitBlock or AbortBlock) is accepted.
// We do this so that in the event that the node shuts down, the proposal block
// is not written to disk unless its child is.
// (The VM's Shutdown method commits the database.)
// The snowman.Engine requires that the last committed block is a decision block
blkID := b.ID()
a.backend.lastAccepted = blkID
a.ctx.Log.Trace(
"accepted block",
zap.String("blockType", blockType),
zap.Stringer("blkID", blkID),
zap.Uint64("height", b.Height()),
zap.Stringer("parentID", b.Parent()),
zap.Stringer("utxoChecksum", a.state.Checksum()),
)
}
func (a *acceptor) standardBlock(b block.Block, blockType string) error {
blkID := b.ID()
defer a.free(blkID)
if err := a.commonAccept(b); err != nil {
return err
}
blkState, ok := a.blkIDToState[blkID]
if !ok {
return fmt.Errorf("%w %s", errMissingBlockState, blkID)
}
// Update the state to reflect the changes made in [onAcceptState].
if err := blkState.onAcceptState.Apply(a.state); err != nil {
return err
}
defer a.state.Abort()
batch, err := a.state.CommitBatch()
if err != nil {
return fmt.Errorf(
"failed to commit VM's database for block %s: %w",
blkID,
err,
)
}
// Note that this method writes [batch] to the database.
if err := a.ctx.SharedMemory.Apply(blkState.atomicRequests, batch); err != nil {
return fmt.Errorf("failed to apply vm's state to shared memory: %w", err)
}
if onAcceptFunc := blkState.onAcceptFunc; onAcceptFunc != nil {
onAcceptFunc()
}
a.ctx.Log.Trace(
"accepted block",
zap.String("blockType", blockType),
zap.Stringer("blkID", blkID),
zap.Uint64("height", b.Height()),
zap.Stringer("parentID", b.Parent()),
zap.Stringer("utxoChecksum", a.state.Checksum()),
)
return nil
}
func (a *acceptor) commonAccept(b block.Block) error {
blkID := b.ID()
if err := a.metrics.MarkAccepted(b); err != nil {
return fmt.Errorf("failed to accept block %s: %w", blkID, err)
}
a.backend.lastAccepted = blkID
a.state.SetLastAccepted(blkID)
a.state.SetHeight(b.Height())
a.state.AddStatelessBlock(b)
a.validators.OnAcceptedBlockID(blkID)
return nil
}