Skip to content

Commit

Permalink
fix: check parents when adding tipsets to the "cache"
Browse files Browse the repository at this point in the history
  • Loading branch information
@Stebalien
Stebalien committed Aug 3, 2021
1 parent e4b374d commit a5fc9eb
Show file tree
Hide file tree
Showing 2 changed files with 122 additions and 94 deletions.
11 changes: 9 additions & 2 deletions chain/events/tscache.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type tipSetCache struct {
mu sync.RWMutex

cache []*types.TipSet
start int
start int // chain head (end)
len int

storage tsCacheAPI
Expand All @@ -42,9 +42,16 @@ func (tsc *tipSetCache) add(ts *types.TipSet) error {
defer tsc.mu.Unlock()

if tsc.len > 0 {
if tsc.cache[tsc.start].Height() >= ts.Height() {
best := tsc.cache[tsc.start]
if best.Height() >= ts.Height() {
return xerrors.Errorf("tipSetCache.add: expected new tipset height to be at least %d, was %d", tsc.cache[tsc.start].Height()+1, ts.Height())
}
if best.Key() != ts.Parents() {
return xerrors.Errorf(
"tipSetCache.add: expected new tipset %s (%d) to follow %s (%d), its parents are %s",
ts.Key(), ts.Height(), best.Key(), best.Height(), best.Parents(),
)
}
}

nextH := ts.Height()
Expand Down
205 changes: 113 additions & 92 deletions chain/events/tscache_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,57 +6,13 @@ import (

"github.com/filecoin-project/go-state-types/abi"
"github.com/filecoin-project/go-state-types/crypto"
"github.com/ipfs/go-cid"
"github.com/stretchr/testify/require"

"github.com/filecoin-project/go-address"
"github.com/filecoin-project/lotus/chain/types"
)

func TestTsCache(t *testing.T) {
tsc := newTSCache(50, &tsCacheAPIFailOnStorageCall{t: t})

h := abi.ChainEpoch(75)

a, _ := address.NewFromString("t00")

add := func() {
ts, err := types.NewTipSet([]*types.BlockHeader{{
Miner: a,
Height: h,
ParentStateRoot: dummyCid,
Messages: dummyCid,
ParentMessageReceipts: dummyCid,
BlockSig: &crypto.Signature{Type: crypto.SigTypeBLS},
BLSAggregate: &crypto.Signature{Type: crypto.SigTypeBLS},
}})
if err != nil {
t.Fatal(err)
}
if err := tsc.add(ts); err != nil {
t.Fatal(err)
}
h++
}

for i := 0; i < 9000; i++ {
if i%90 > 60 {
best, err := tsc.best()
if err != nil {
t.Fatal(err, "; i:", i)
return
}
if err := tsc.revert(best); err != nil {
t.Fatal(err, "; i:", i)
return
}
h--
} else {
add()
}
}

}

type tsCacheAPIFailOnStorageCall struct {
t *testing.T
}
Expand All @@ -70,77 +26,123 @@ func (tc *tsCacheAPIFailOnStorageCall) ChainHead(ctx context.Context) (*types.Ti
return &types.TipSet{}, nil
}

func TestTsCacheNulls(t *testing.T) {
tsc := newTSCache(50, &tsCacheAPIFailOnStorageCall{t: t})

h := abi.ChainEpoch(75)

a, _ := address.NewFromString("t00")
add := func() {
ts, err := types.NewTipSet([]*types.BlockHeader{{
Miner: a,
Height: h,
ParentStateRoot: dummyCid,
Messages: dummyCid,
ParentMessageReceipts: dummyCid,
BlockSig: &crypto.Signature{Type: crypto.SigTypeBLS},
BLSAggregate: &crypto.Signature{Type: crypto.SigTypeBLS},
}})
if err != nil {
t.Fatal(err)
}
if err := tsc.add(ts); err != nil {
t.Fatal(err)
type cacheHarness struct {
t *testing.T

miner address.Address
tsc *tipSetCache
height abi.ChainEpoch
}

func newCacheharness(t *testing.T) *cacheHarness {
a, err := address.NewFromString("t00")
require.NoError(t, err)

h := &cacheHarness{
t: t,
tsc: newTSCache(50, &tsCacheAPIFailOnStorageCall{t: t}),
height: 75,
miner: a,
}
h.addWithParents(nil)
return h
}

func (h *cacheHarness) addWithParents(parents []cid.Cid) {
ts, err := types.NewTipSet([]*types.BlockHeader{{
Miner: h.miner,
Height: h.height,
ParentStateRoot: dummyCid,
Messages: dummyCid,
ParentMessageReceipts: dummyCid,
BlockSig: &crypto.Signature{Type: crypto.SigTypeBLS},
BLSAggregate: &crypto.Signature{Type: crypto.SigTypeBLS},
Parents: parents,
}})
require.NoError(h.t, err)
require.NoError(h.t, h.tsc.add(ts))
h.height++
}

func (h *cacheHarness) add() {
last, err := h.tsc.best()
require.NoError(h.t, err)
h.addWithParents(last.Cids())
}

func (h *cacheHarness) revert() {
best, err := h.tsc.best()
require.NoError(h.t, err)
err = h.tsc.revert(best)
require.NoError(h.t, err)
h.height--
}

func (h *cacheHarness) skip(n abi.ChainEpoch) {
h.height += n
}

func TestTsCache(t *testing.T) {
h := newCacheharness(t)

for i := 0; i < 9000; i++ {
if i%90 > 60 {
h.revert()
} else {
h.add()
}
h++
}
}

func TestTsCacheNulls(t *testing.T) {
h := newCacheharness(t)

add()
add()
add()
h += 5
h.add()
h.add()
h.add()
h.skip(5)

add()
add()
h.add()
h.add()

best, err := tsc.best()
best, err := h.tsc.best()
require.NoError(t, err)
require.Equal(t, h-1, best.Height())
require.Equal(t, h.height-1, best.Height())

ts, err := tsc.get(h - 1)
ts, err := h.tsc.get(h.height - 1)
require.NoError(t, err)
require.Equal(t, h-1, ts.Height())
require.Equal(t, h.height-1, ts.Height())

ts, err = tsc.get(h - 2)
ts, err = h.tsc.get(h.height - 2)
require.NoError(t, err)
require.Equal(t, h-2, ts.Height())
require.Equal(t, h.height-2, ts.Height())

ts, err = tsc.get(h - 3)
ts, err = h.tsc.get(h.height - 3)
require.NoError(t, err)
require.Nil(t, ts)

ts, err = tsc.get(h - 8)
ts, err = h.tsc.get(h.height - 8)
require.NoError(t, err)
require.Equal(t, h-8, ts.Height())
require.Equal(t, h.height-8, ts.Height())

best, err = tsc.best()
best, err = h.tsc.best()
require.NoError(t, err)
require.NoError(t, tsc.revert(best))
require.NoError(t, h.tsc.revert(best))

best, err = tsc.best()
best, err = h.tsc.best()
require.NoError(t, err)
require.NoError(t, tsc.revert(best))
require.NoError(t, h.tsc.revert(best))

best, err = tsc.best()
best, err = h.tsc.best()
require.NoError(t, err)
require.Equal(t, h-8, best.Height())
require.Equal(t, h.height-8, best.Height())

h += 50
add()
h.skip(50)
h.add()

ts, err = tsc.get(h - 1)
ts, err = h.tsc.get(h.height - 1)
require.NoError(t, err)
require.Equal(t, h-1, ts.Height())
require.Equal(t, h.height-1, ts.Height())
}

type tsCacheAPIStorageCallCounter struct {
Expand All @@ -166,3 +168,22 @@ func TestTsCacheEmpty(t *testing.T) {
require.NoError(t, err)
require.Equal(t, 1, callCounter.chainHead)
}

func TestTsCacheSkip(t *testing.T) {
h := newCacheharness(t)

ts, err := types.NewTipSet([]*types.BlockHeader{{
Miner: h.miner,
Height: h.height,
ParentStateRoot: dummyCid,
Messages: dummyCid,
ParentMessageReceipts: dummyCid,
BlockSig: &crypto.Signature{Type: crypto.SigTypeBLS},
BLSAggregate: &crypto.Signature{Type: crypto.SigTypeBLS},
// With parents that don't match the last block.
Parents: nil,
}})
require.NoError(h.t, err)
err = h.tsc.add(ts)
require.Error(t, err)
}

0 comments on commit a5fc9eb

Please sign in to comment.