Skip to content

Commit ac5c9e8

Browse files
authored
Normalize naming prevStep -> step (#17726)
Small rename refactoring to clarify meaning in the code: - The concept of "prev step" is only used in SharedDomains as GetLatest() is used as prev value of next mutation - Inside GetLatest() chain of calls it is actually just the step whose that latest mutation occurred, "prev step" sounds strange and confusing when reading the code - Most of GetLatest() chain of calls are already using only "step" as the named variable, so this PR just completes the standardization of naming.
1 parent 386b0f8 commit ac5c9e8

4 files changed

Lines changed: 26 additions & 26 deletions

File tree

db/kv/kv_interface.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ type TemporalDebugDB interface {
468468
type TemporalMemBatch interface {
469469
DomainPut(domain Domain, k string, v []byte, txNum uint64, preval []byte, prevStep Step) error
470470
DomainDel(domain Domain, k string, txNum uint64, preval []byte, prevStep Step) error
471-
GetLatest(table Domain, key []byte) (v []byte, prevStep Step, ok bool)
471+
GetLatest(domain Domain, key []byte) (v []byte, step Step, ok bool)
472472
GetDiffset(tx RwTx, blockHash common.Hash, blockNumber uint64) ([DomainLen][]DomainEntryDiff, bool, error)
473473
ClearRam()
474474
IndexAdd(table InvertedIdx, key []byte, txNum uint64) (err error)

db/state/domain_stream.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ type CursorItem struct {
4949
cDup kv.CursorDupSort
5050
cNonDup kv.Cursor
5151

52-
iter btree2.MapIter[string, dataWithPrevStep]
52+
iter btree2.MapIter[string, dataWithStep]
5353
idx *seg.Reader
5454
hist *seg.PagedReader
5555
btCursor *Cursor
@@ -313,7 +313,7 @@ func (hi *DomainLatestIterFile) Next() ([]byte, []byte, error) {
313313
// debugIteratePrefix iterates over key-value pairs of the storage domain that start with given prefix
314314
//
315315
// k and v lifetime is bounded by the lifetime of the iterator
316-
func (dt *DomainRoTx) debugIteratePrefixLatest(prefix []byte, ramIter btree2.MapIter[string, dataWithPrevStep], it func(k []byte, v []byte, step kv.Step) (cont bool, err error), roTx kv.Tx) error {
316+
func (dt *DomainRoTx) debugIteratePrefixLatest(prefix []byte, ramIter btree2.MapIter[string, dataWithStep], it func(k []byte, v []byte, step kv.Step) (cont bool, err error), roTx kv.Tx) error {
317317
// Implementation:
318318
// File endTxNum = last txNum of file step
319319
// DB endTxNum = first txNum of step in db

db/state/execctx/domain_shared.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,9 +274,9 @@ func (sd *SharedDomains) GetLatest(domain kv.Domain, tx kv.TemporalTx, k []byte)
274274
return nil, 0, errors.New("sd.GetLatest: unexpected nil tx")
275275
}
276276
start := time.Now()
277-
if v, prevStep, ok := sd.mem.GetLatest(domain, k); ok {
277+
if v, _step, ok := sd.mem.GetLatest(domain, k); ok {
278278
sd.metrics.UpdateCacheReads(domain, start)
279-
return v, prevStep, nil
279+
return v, _step, nil
280280
}
281281
//if aggTx, ok := tx.AggTx().(*state.AggregatorRoTx); ok {
282282
// v, step, _, err = aggTx.getLatest(domain, k, tx, &sd.metrics, start)

db/state/temporal_mem_batch.go

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ const (
3737
put
3838
)
3939

40-
type dataWithPrevStep struct {
41-
data []byte
42-
prevStep kv.Step
43-
dir iodir
40+
type dataWithStep struct {
41+
data []byte
42+
step kv.Step
43+
dir iodir
4444
}
4545

4646
// TemporalMemBatch - temporal read-write interface - which storing updates in RAM. Don't forget to call `.Flush()`
@@ -50,8 +50,8 @@ type TemporalMemBatch struct {
5050
getCacheSize int
5151

5252
latestStateLock sync.RWMutex
53-
domains [kv.DomainLen]map[string]dataWithPrevStep
54-
storage *btree2.Map[string, dataWithPrevStep] // TODO: replace hardcoded domain name to per-config configuration of available Guarantees/AccessMethods (range vs get)
53+
domains [kv.DomainLen]map[string]dataWithStep
54+
storage *btree2.Map[string, dataWithStep] // TODO: replace hardcoded domain name to per-config configuration of available Guarantees/AccessMethods (range vs get)
5555

5656
domainWriters [kv.DomainLen]*DomainBufferedWriter
5757
iiWriters []*InvertedIndexBufferedWriter
@@ -64,7 +64,7 @@ type TemporalMemBatch struct {
6464

6565
func NewTemporalMemBatch(tx kv.TemporalTx, ioMetrics interface{}) *TemporalMemBatch {
6666
sd := &TemporalMemBatch{
67-
storage: btree2.NewMap[string, dataWithPrevStep](128),
67+
storage: btree2.NewMap[string, dataWithStep](128),
6868
metrics: ioMetrics.(*changeset.DomainMetrics),
6969
}
7070
aggTx := AggTx(tx)
@@ -77,7 +77,7 @@ func NewTemporalMemBatch(tx kv.TemporalTx, ioMetrics interface{}) *TemporalMemBa
7777
}
7878

7979
for id, d := range aggTx.d {
80-
sd.domains[id] = map[string]dataWithPrevStep{}
80+
sd.domains[id] = map[string]dataWithStep{}
8181
sd.domainWriters[id] = d.NewWriter()
8282
}
8383

@@ -109,10 +109,10 @@ func (sd *TemporalMemBatch) putHistory(domain kv.Domain, k, v []byte, txNum uint
109109
func (sd *TemporalMemBatch) putLatest(domain kv.Domain, key string, val []byte, txNum uint64) {
110110
sd.latestStateLock.Lock()
111111
defer sd.latestStateLock.Unlock()
112-
valWithPrevStep := dataWithPrevStep{data: val, prevStep: kv.Step(txNum / sd.stepSize)}
112+
valWithStep := dataWithStep{data: val, step: kv.Step(txNum / sd.stepSize)}
113113
putSize := 0
114114
if domain == kv.StorageDomain {
115-
if old, ok := sd.storage.Set(key, valWithPrevStep); ok {
115+
if old, ok := sd.storage.Set(key, valWithStep); ok {
116116
putSize += len(val) - len(old.data)
117117
} else {
118118
putSize += len(key) + len(val)
@@ -139,7 +139,7 @@ func (sd *TemporalMemBatch) putLatest(domain kv.Domain, key string, val []byte,
139139
} else {
140140
putSize += len(key) + len(val)
141141
}
142-
sd.domains[domain][key] = valWithPrevStep
142+
sd.domains[domain][key] = valWithStep
143143

144144
if dm, ok := sd.metrics.Domains[domain]; ok {
145145
dm.CachePutCount++
@@ -156,20 +156,20 @@ func (sd *TemporalMemBatch) putLatest(domain kv.Domain, key string, val []byte,
156156
sd.metrics.Unlock()
157157
}
158158

159-
func (sd *TemporalMemBatch) GetLatest(table kv.Domain, key []byte) (v []byte, prevStep kv.Step, ok bool) {
159+
func (sd *TemporalMemBatch) GetLatest(domain kv.Domain, key []byte) (v []byte, step kv.Step, ok bool) {
160160
sd.latestStateLock.RLock()
161161
defer sd.latestStateLock.RUnlock()
162162

163163
keyS := toStringZeroCopy(key)
164-
var dataWithPrevStep dataWithPrevStep
165-
if table == kv.StorageDomain {
166-
dataWithPrevStep, ok = sd.storage.Get(keyS)
167-
return dataWithPrevStep.data, dataWithPrevStep.prevStep, ok
164+
var dataWithStep dataWithStep
165+
if domain == kv.StorageDomain {
166+
dataWithStep, ok = sd.storage.Get(keyS)
167+
return dataWithStep.data, dataWithStep.step, ok
168168

169169
}
170170

171-
dataWithPrevStep, ok = sd.domains[table][keyS]
172-
return dataWithPrevStep.data, dataWithPrevStep.prevStep, ok
171+
dataWithStep, ok = sd.domains[domain][keyS]
172+
return dataWithStep.data, dataWithStep.step, ok
173173
}
174174

175175
func (sd *TemporalMemBatch) SizeEstimate() uint64 {
@@ -185,10 +185,10 @@ func (sd *TemporalMemBatch) ClearRam() {
185185
sd.latestStateLock.Lock()
186186
defer sd.latestStateLock.Unlock()
187187
for i := range sd.domains {
188-
sd.domains[i] = map[string]dataWithPrevStep{}
188+
sd.domains[i] = map[string]dataWithStep{}
189189
}
190190

191-
sd.storage = btree2.NewMap[string, dataWithPrevStep](128)
191+
sd.storage = btree2.NewMap[string, dataWithStep](128)
192192
sd.metrics.Lock()
193193
defer sd.metrics.Unlock()
194194
sd.metrics.CachePutSize = 0
@@ -202,7 +202,7 @@ func (sd *TemporalMemBatch) ClearRam() {
202202
func (sd *TemporalMemBatch) IteratePrefix(domain kv.Domain, prefix []byte, roTx kv.Tx, it func(k []byte, v []byte, step kv.Step) (cont bool, err error)) error {
203203
sd.latestStateLock.RLock()
204204
defer sd.latestStateLock.RUnlock()
205-
var ramIter btree2.MapIter[string, dataWithPrevStep]
205+
var ramIter btree2.MapIter[string, dataWithStep]
206206
if domain == kv.StorageDomain {
207207
ramIter = sd.storage.Iter()
208208
}

0 commit comments

Comments
 (0)