gc

Documentation

Index

• Variables
• func ColoredSet(ctx context.Context, pn pin.Pinner, ls dag.LinkService, ...) (*cid.Set, error)
• func Descendants(ctx context.Context, getLinks dag.GetLinks, set *cid.Set, roots []*cid.Cid) error
• func GC(ctx context.Context, bs bstore.GCBlockstore, ls dag.LinkService, pn pin.Pinner, ...) <-chan Result
• type CannotDeleteBlockError
  • func (e *CannotDeleteBlockError) Error() string
• type CannotFetchLinksError
  • func (e *CannotFetchLinksError) Error() string
• type Result

Variables

var ErrCannotDeleteSomeBlocks = errors.New("garbage collection incomplete: could not delete some blocks")

var ErrCannotFetchAllLinks = errors.New("garbage collection aborted: could not retrieve some links")

Functions

func ColoredSet

func ColoredSet(ctx context.Context, pn pin.Pinner, ls dag.LinkService, bestEffortRoots []*cid.Cid, output chan<- Result) (*cid.Set, error)

ColoredSet computes the set of nodes in the graph that are pinned by the pins in the given pinner.

func Descendants

func Descendants(ctx context.Context, getLinks dag.GetLinks, set *cid.Set, roots []*cid.Cid) error

func GC

func GC(ctx context.Context, bs bstore.GCBlockstore, ls dag.LinkService, pn pin.Pinner, bestEffortRoots []*cid.Cid) <-chan Result

GC performs a mark and sweep garbage collection of the blocks in the blockstore first, it creates a 'marked' set and adds to it the following: - all recursively pinned blocks, plus all of their descendants (recursively) - bestEffortRoots, plus all of its descendants (recursively) - all directly pinned blocks - all blocks utilized internally by the pinner

The routine then iterates over every block in the blockstore and deletes any block that is not found in the marked set.

Types

type CannotDeleteBlockError

type CannotDeleteBlockError struct {
	Key *cid.Cid
	Err error
}

func (*CannotDeleteBlockError) Error

func (e *CannotDeleteBlockError) Error() string

type CannotFetchLinksError

type CannotFetchLinksError struct {
	Key *cid.Cid
	Err error
}

func (*CannotFetchLinksError) Error

func (e *CannotFetchLinksError) Error() string

type Result

type Result struct {
	KeyRemoved *cid.Cid
	Error      error
}

Result represents an incremental output from a garbage collection run. It contains either an error, or the cid of a removed object.