vgmgr

Documentation

Index

• type ExcludeFilter
  • func NewExcludeIDFilter(ids IDSet) ExcludeFilter
• type ExcludeIDFilter
  • func (f *ExcludeIDFilter) Apply(id uint32) bool
• type GVGPickFilter
• type GenerateGVGSecondarySPsPolicy
• type GlobalVirtualGroupMeta
• type IDSet
• type NewVirtualGroupManager
• type PickVGFFilter
  • func NewPickVGFFilter(availableVgfIDs []uint32) *PickVGFFilter
  • func (p *PickVGFFilter) Check(vgfID uint32) bool
• type SPPickFilter
• type VGFPickFilter
• type VirtualGroupFamilyMeta
• type VirtualGroupManager

Types

type ExcludeFilter

type ExcludeFilter interface {
	Apply(id uint32) bool
}

ExcludeFilter applies on an ID to check if it should be excluded

func NewExcludeIDFilter

func NewExcludeIDFilter(ids IDSet) ExcludeFilter

type ExcludeIDFilter

type ExcludeIDFilter struct {
	ExcludeIDs map[uint32]struct{}
}

ExcludeIDFilter The sp freeze pool decides excludeIDFilter ExcludeIDs. When this filter is applied on a sp's id, meeting the condition means it is one of freeze sp should be excluded.

func (*ExcludeIDFilter) Apply

func (f *ExcludeIDFilter) Apply(id uint32) bool

type GVGPickFilter

type GVGPickFilter interface {
	// CheckFamily returns true when match pick request condition.
	CheckFamily(familyID uint32) bool
	// CheckGVG returns true when match pick request condition.
	CheckGVG(gvgMeta *GlobalVirtualGroupMeta) bool
}

GVGPickFilter is used to check sp pick condition.

type GenerateGVGSecondarySPsPolicy

type GenerateGVGSecondarySPsPolicy interface {
	// AddCandidateSP is used to add candidate sp.
	AddCandidateSP(spID uint32)
	// GenerateGVGSecondarySPs returns gvg secondary sp list.
	GenerateGVGSecondarySPs() ([]uint32, error)
}

GenerateGVGSecondarySPsPolicy is used to generate gvg secondary sp list.

type GlobalVirtualGroupMeta

type GlobalVirtualGroupMeta struct {
	ID             uint32
	FamilyID       uint32
	PrimarySPID    uint32
	SecondarySPIDs []uint32
	// TODO: refine it, current proto is not compatible
	// SecondarySPs       []*sptypes.StorageProvider
	SecondarySPEndpoints []string
	UsedStorageSize      uint64
	StakingStorageSize   uint64 // init by staking deposit / staking price
}

GlobalVirtualGroupMeta defines global virtual group meta which is used by sp.

type IDSet

type IDSet = map[uint32]struct{}

type NewVirtualGroupManager

type NewVirtualGroupManager = func(selfOperatorAddress string, chainClient consensus.Consensus) (VirtualGroupManager, error)

NewVirtualGroupManager is the virtual group manager init api.

type PickVGFFilter

type PickVGFFilter struct {
	AvailableVgfIDSet map[uint32]struct{}
}

func NewPickVGFFilter

func NewPickVGFFilter(availableVgfIDs []uint32) *PickVGFFilter

func (*PickVGFFilter) Check

func (p *PickVGFFilter) Check(vgfID uint32) bool

type SPPickFilter

type SPPickFilter interface {
	// Check returns true when match pick request condition.
	Check(spID uint32) bool
}

SPPickFilter is used to check sp pick condition.

type VGFPickFilter

type VGFPickFilter interface {
	Check(vgfID uint32) bool
}

VGFPickFilter is used to check virtual group families qualification

type VirtualGroupFamilyMeta

type VirtualGroupFamilyMeta struct {
	ID                       uint32
	PrimarySPID              uint32
	FamilyUsedStorageSize    uint64 // init by gvgMap
	FamilyStakingStorageSize uint64 // init by gvgMap
	GVGMap                   map[uint32]*GlobalVirtualGroupMeta
}

VirtualGroupFamilyMeta defines virtual group family meta which is used by sp.

type VirtualGroupManager

type VirtualGroupManager interface {
	// PickVirtualGroupFamily pick a virtual group family(If failed to pick,
	// new VGF will be automatically created on the chain) in get create bucket approval workflow.
	PickVirtualGroupFamily() (*VirtualGroupFamilyMeta, error)
	// PickGlobalVirtualGroup picks a global virtual group(If failed to pick,
	// new GVG will be created by primary SP) in replicate/seal object workflow.
	PickGlobalVirtualGroup(vgfID uint32) (*GlobalVirtualGroupMeta, error)
	// PickGlobalVirtualGroupForBucketMigrate picks a global virtual group(If failed to pick,
	// new GVG will be created by primary SP) in replicate/seal object workflow.
	PickGlobalVirtualGroupForBucketMigrate(filter GVGPickFilter) (*GlobalVirtualGroupMeta, error)
	// ForceRefreshMeta is used to query metadata service and refresh the virtual group manager meta.
	// if pick func returns ErrStaledMetadata, the caller need force refresh from metadata and retry pick.
	ForceRefreshMeta() error
	// GenerateGlobalVirtualGroupMeta is used to generate a new global virtual group meta, the caller need send a tx to chain.
	GenerateGlobalVirtualGroupMeta(genPolicy GenerateGVGSecondarySPsPolicy) (*GlobalVirtualGroupMeta, error)
	// PickSPByFilter picks sp which is match pick filter condition.
	PickSPByFilter(filter SPPickFilter) (*sptypes.StorageProvider, error)
	// QuerySPByID returns sp proto.
	QuerySPByID(spID uint32) (*sptypes.StorageProvider, error)
	// FreezeSPAndGVGs puts the secondary SP and its joining Global virtual groups into the freeze pool for a specific period,
	// For those SPs which are in the pool will be skipped when creating a GVG, GVGs in the pool will not be chosen to seal Object
	// until released
	FreezeSPAndGVGs(spID uint32, gvgs []*virtualgrouptypes.GlobalVirtualGroup)
}

VirtualGroupManager is used to provide virtual group api.