storiface

Documentation

Index

• Constants
• Variables
• func ParseSectorID(baseName string) (abi.SectorID, error)
• func PathByType(sps SectorPaths, fileType SectorFileType) string
• func SectorName(sid abi.SectorID) string
• func SetPathByType(sps *SectorPaths, fileType SectorFileType, p string)
• type AcquireMode
• type CallError
  • func Err(code ErrorCode, sub error) *CallError
  • func (c *CallError) Error() string
  • func (c *CallError) Unwrap() error
• type CallID
  • func (t *CallID) MarshalCBOR(w io.Writer) error
  • func (c CallID) String() string
  • func (t *CallID) UnmarshalCBOR(r io.Reader) error
• type ErrorCode
• type PaddedByteIndex
• type PathType
• type RGetter
• type SectorFileType
  • func (t SectorFileType) All() [FileTypes]bool
  • func (t SectorFileType) Has(singleType SectorFileType) bool
  • func (t SectorFileType) SealSpaceUse(ssize abi.SectorSize) (uint64, error)
  • func (t SectorFileType) String() string
• type SectorPaths
• type UnpaddedByteIndex
  • func (i UnpaddedByteIndex) Padded() PaddedByteIndex
• type WorkerCalls
• type WorkerInfo
• type WorkerJob
• type WorkerResources
• type WorkerReturn
• type WorkerStats

Constants

const (
	RWRetWait  = -1
	RWReturned = -2
	RWRetDone  = -3
)

const FSOverheadDen = 10

Variables

var ErrSectorNotFound = errors.New("sector not found")

var FSOverheadSeal = map[SectorFileType]int{
	FTUnsealed: FSOverheadDen,
	FTSealed:   FSOverheadDen,
	FTCache:    141,
}

var FsOverheadFinalized = map[SectorFileType]int{
	FTUnsealed: FSOverheadDen,
	FTSealed:   FSOverheadDen,
	FTCache:    2,
}

var PathTypes = []SectorFileType{FTUnsealed, FTSealed, FTCache}

Functions

func ParseSectorID

func ParseSectorID(baseName string) (abi.SectorID, error)

func PathByType

func PathByType(sps SectorPaths, fileType SectorFileType) string

func SectorName

func SectorName(sid abi.SectorID) string

func SetPathByType

func SetPathByType(sps *SectorPaths, fileType SectorFileType, p string)

Types

type AcquireMode

type AcquireMode string

const (
	AcquireMove AcquireMode = "move"
	AcquireCopy AcquireMode = "copy"
)

type CallError

type CallError struct {
	Code    ErrorCode
	Message string
	// contains filtered or unexported fields
}

func Err

func Err(code ErrorCode, sub error) *CallError

func (*CallError) Error

func (c *CallError) Error() string

func (*CallError) Unwrap

func (c *CallError) Unwrap() error

type CallID

type CallID struct {
	Sector abi.SectorID
	ID     uuid.UUID
}

var UndefCall CallID

func (*CallID) MarshalCBOR

func (t *CallID) MarshalCBOR(w io.Writer) error

func (CallID) String

func (c CallID) String() string

func (*CallID) UnmarshalCBOR

func (t *CallID) UnmarshalCBOR(r io.Reader) error

type ErrorCode

type ErrorCode int

const (
	// Temp Errors
	ErrTempUnknown ErrorCode = iota + 100
	ErrTempWorkerRestart
	ErrTempAllocateSpace
)

const (
	ErrUnknown ErrorCode = iota
)

type PaddedByteIndex

type PaddedByteIndex uint64

type PathType

type PathType string

const (
	PathStorage PathType = "storage"
	PathSealing PathType = "sealing"
)

type RGetter

type RGetter func(ctx context.Context, id abi.SectorID) (cid.Cid, error)

type SectorFileType

type SectorFileType int

const (
	FTUnsealed SectorFileType = 1 << iota
	FTSealed
	FTCache

	FileTypes = iota
)

const (
	FTNone SectorFileType = 0
)

func (SectorFileType) All

func (t SectorFileType) All() [FileTypes]bool

func (SectorFileType) Has

func (t SectorFileType) Has(singleType SectorFileType) bool

func (SectorFileType) SealSpaceUse

func (t SectorFileType) SealSpaceUse(ssize abi.SectorSize) (uint64, error)

func (SectorFileType) String

func (t SectorFileType) String() string

type SectorPaths

type SectorPaths struct {
	ID abi.SectorID

	Unsealed string
	Sealed   string
	Cache    string
}

type UnpaddedByteIndex

type UnpaddedByteIndex uint64

func (UnpaddedByteIndex) Padded

func (i UnpaddedByteIndex) Padded() PaddedByteIndex

type WorkerCalls

type WorkerCalls interface {
	AddPiece(ctx context.Context, sector storage.SectorRef, pieceSizes []abi.UnpaddedPieceSize, newPieceSize abi.UnpaddedPieceSize, pieceData storage.Data) (CallID, error)
	SealPreCommit1(ctx context.Context, sector storage.SectorRef, ticket abi.SealRandomness, pieces []abi.PieceInfo) (CallID, error)
	SealPreCommit2(ctx context.Context, sector storage.SectorRef, pc1o storage.PreCommit1Out) (CallID, error)
	SealCommit1(ctx context.Context, sector storage.SectorRef, ticket abi.SealRandomness, seed abi.InteractiveSealRandomness, pieces []abi.PieceInfo, cids storage.SectorCids) (CallID, error)
	SealCommit2(ctx context.Context, sector storage.SectorRef, c1o storage.Commit1Out) (CallID, error)
	FinalizeSector(ctx context.Context, sector storage.SectorRef, keepUnsealed []storage.Range) (CallID, error)
	ReleaseUnsealed(ctx context.Context, sector storage.SectorRef, safeToFree []storage.Range) (CallID, error)
	MoveStorage(ctx context.Context, sector storage.SectorRef, types SectorFileType) (CallID, error)
	UnsealPiece(context.Context, storage.SectorRef, UnpaddedByteIndex, abi.UnpaddedPieceSize, abi.SealRandomness, cid.Cid) (CallID, error)
	ReadPiece(context.Context, io.Writer, storage.SectorRef, UnpaddedByteIndex, abi.UnpaddedPieceSize) (CallID, error)
	Fetch(context.Context, storage.SectorRef, SectorFileType, PathType, AcquireMode) (CallID, error)
}

type WorkerInfo

type WorkerInfo struct {
	Hostname string

	Resources WorkerResources
}

type WorkerJob

type WorkerJob struct {
	ID     CallID
	Sector abi.SectorID
	Task   sealtasks.TaskType

	// 1+ - assigned
	// 0  - running
	// -1 - ret-wait
	// -2 - returned
	// -3 - ret-done
	RunWait int
	Start   time.Time

	Hostname string `json:",omitempty"` // optional, set for ret-wait jobs
}

type WorkerResources

type WorkerResources struct {
	MemPhysical uint64
	MemSwap     uint64

	MemReserved uint64 // Used by system / other processes

	CPUs uint64 // Logical cores
	GPUs []string
}

type WorkerReturn

type WorkerReturn interface {
	ReturnAddPiece(ctx context.Context, callID CallID, pi abi.PieceInfo, err *CallError) error
	ReturnSealPreCommit1(ctx context.Context, callID CallID, p1o storage.PreCommit1Out, err *CallError) error
	ReturnSealPreCommit2(ctx context.Context, callID CallID, sealed storage.SectorCids, err *CallError) error
	ReturnSealCommit1(ctx context.Context, callID CallID, out storage.Commit1Out, err *CallError) error
	ReturnSealCommit2(ctx context.Context, callID CallID, proof storage.Proof, err *CallError) error
	ReturnFinalizeSector(ctx context.Context, callID CallID, err *CallError) error
	ReturnReleaseUnsealed(ctx context.Context, callID CallID, err *CallError) error
	ReturnMoveStorage(ctx context.Context, callID CallID, err *CallError) error
	ReturnUnsealPiece(ctx context.Context, callID CallID, err *CallError) error
	ReturnReadPiece(ctx context.Context, callID CallID, ok bool, err *CallError) error
	ReturnFetch(ctx context.Context, callID CallID, err *CallError) error
}

type WorkerStats

type WorkerStats struct {
	Info    WorkerInfo
	Enabled bool

	MemUsedMin uint64
	MemUsedMax uint64
	GpuUsed    bool   // nolint
	CpuUse     uint64 // nolint
}