nv14

Documentation

Index

• func ActorHeadKey(addr address.Address, head cid.Cid) string
• func MigrateStateTree(ctx context.Context, store cbor.IpldStore, actorsRootIn cid.Cid, ...) (cid.Cid, error)
• type Config
• type Logger
• type MemMigrationCache
  • func NewMemMigrationCache() *MemMigrationCache
  • func (m *MemMigrationCache) Clone() *MemMigrationCache
  • func (m *MemMigrationCache) Load(key string, loadFunc func() (cid.Cid, error)) (cid.Cid, error)
  • func (m *MemMigrationCache) Read(key string) (bool, cid.Cid, error)
  • func (m *MemMigrationCache) Update(other *MemMigrationCache)
  • func (m *MemMigrationCache) Write(key string, c cid.Cid) error
• type MigrationCache
• type TestLogger
  • func (t TestLogger) Log(_ rt.LogLevel, msg string, args ...interface{})

Functions

func ActorHeadKey

func ActorHeadKey(addr address.Address, head cid.Cid) string

func MigrateStateTree

func MigrateStateTree(ctx context.Context, store cbor.IpldStore, actorsRootIn cid.Cid, priorEpoch abi.ChainEpoch, cfg Config, log Logger, cache MigrationCache) (cid.Cid, error)

Migrates the filecoin state tree starting from the global state tree and upgrading all actor state. The store must support concurrent writes (even if the configured worker count is 1).

Types

type Config

type Config struct {
	// Number of migration worker goroutines to run.
	// More workers enables higher CPU utilization doing migration computations (including state encoding)
	MaxWorkers uint
	// Capacity of the queue of jobs available to workers (zero for unbuffered).
	// A queue length of hundreds to thousands improves throughput at the cost of memory.
	JobQueueSize uint
	// Capacity of the queue receiving migration results from workers, for persisting (zero for unbuffered).
	// A queue length of tens to hundreds improves throughput at the cost of memory.
	ResultQueueSize uint
	// Time between progress logs to emit.
	// Zero (the default) results in no progress logs.
	ProgressLogPeriod time.Duration
}

Config parameterizes a state tree migration

type Logger

type Logger interface {
	// This is the same logging interface provided by the Runtime
	Log(level rt.LogLevel, msg string, args ...interface{})
}

type MemMigrationCache

type MemMigrationCache struct {
	MigrationMap sync.Map
}

func NewMemMigrationCache

func NewMemMigrationCache() *MemMigrationCache

func (*MemMigrationCache) Clone

func (m *MemMigrationCache) Clone() *MemMigrationCache

func (*MemMigrationCache) Load

func (m *MemMigrationCache) Load(key string, loadFunc func() (cid.Cid, error)) (cid.Cid, error)

func (*MemMigrationCache) Read

func (m *MemMigrationCache) Read(key string) (bool, cid.Cid, error)

func (*MemMigrationCache) Update

func (m *MemMigrationCache) Update(other *MemMigrationCache)

func (*MemMigrationCache) Write

func (m *MemMigrationCache) Write(key string, c cid.Cid) error

type MigrationCache

type MigrationCache interface {
	Write(key string, newCid cid.Cid) error
	Read(key string) (bool, cid.Cid, error)
	Load(key string, loadFunc func() (cid.Cid, error)) (cid.Cid, error)
}

Migrates from v13 to v14

This migration only updates the actor code CIDs in the state tree. MigrationCache stores and loads cached data. Its implementation must be threadsafe

type TestLogger

type TestLogger struct {
	TB testing.TB
}

func (TestLogger) Log

func (t TestLogger) Log(_ rt.LogLevel, msg string, args ...interface{})