opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-05-21 08:56:37 +08:00
Code Issues Projects Releases Wiki Activity

gc: address CR comments

Browse Source 
License: MIT
Signed-off-by: Kevin Atkinson <k@kevina.org>
This commit is contained in:
Kevin Atkinson
2017-03-20 14:46:02 -04:00
parent f66ca2ff24
commit d39d9ed60b
3 changed files with 23 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
core/commands/repo.go
View File

@ -40,6 +40,7 @@ var RepoCmd = &cmds.Command{
}, },
} }
// GcResult is the result returned by "repo gc" command.
type GcResult struct { type GcResult struct {
Key *cid.Cid Key *cid.Cid
Error string `json:",omitempty"` Error string `json:",omitempty"`

5
core/corerepo/gc.go
View File

@ -91,6 +91,9 @@ func GarbageCollect(n *core.IpfsNode, ctx context.Context) error {
return CollectResult(ctx, rmed, nil) return CollectResult(ctx, rmed, nil)
} }
// CollectResult collects the output of a garbage collection run and calls the
// given callback for each object removed. It also collects all errors into a
// MultiError which is returned after the gc is completed.
func CollectResult(ctx context.Context, gcOut <-chan gc.Result, cb func(*cid.Cid)) error { func CollectResult(ctx context.Context, gcOut <-chan gc.Result, cb func(*cid.Cid)) error {
var errors []error var errors []error
loop: loop:
@ -121,10 +124,12 @@ loop:
} }
} }
// NewMultiError creates a new MultiError object from a given slice of errors.
func NewMultiError(errs ...error) *MultiError { func NewMultiError(errs ...error) *MultiError {
return &MultiError{errs[:len(errs)-1], errs[len(errs)-1]} return &MultiError{errs[:len(errs)-1], errs[len(errs)-1]}
} }
// MultiError contains the results of multiple errors.
type MultiError struct { type MultiError struct {
Errors []error Errors []error
Summary error Summary error

30
pin/gc/gc.go
View File

@ -16,6 +16,8 @@ import (
var log = logging.Logger("gc") var log = logging.Logger("gc")
// Result represents an incremental output from a garbage collection
// run. It contains either an error, or the cid of a removed object.
type Result struct { type Result struct {
KeyRemoved *cid.Cid KeyRemoved *cid.Cid
Error error Error error
@ -66,7 +68,7 @@ func GC(ctx context.Context, bs bstore.GCBlockstore, ls dag.LinkService, pn pin.
err := bs.DeleteBlock(k) err := bs.DeleteBlock(k)
if err != nil { if err != nil {
errors = true errors = true
output <- Result{Error: &CouldNotDeleteBlockError{k, err}} output <- Result{Error: &CannotDeleteBlockError{k, err}}
//log.Errorf("Error removing key from blockstore: %s", err) //log.Errorf("Error removing key from blockstore: %s", err)
// continue as error is non-fatal // continue as error is non-fatal
continue loop continue loop
@ -82,7 +84,7 @@ func GC(ctx context.Context, bs bstore.GCBlockstore, ls dag.LinkService, pn pin.
} }
} }
if errors { if errors {
output <- Result{Error: ErrCouldNotDeleteSomeBlocks} output <- Result{Error: ErrCannotDeleteSomeBlocks}
} }
}() }()
@ -103,6 +105,8 @@ func Descendants(ctx context.Context, getLinks dag.GetLinks, set *cid.Set, roots
return nil return nil
} }
// ColoredSet computes the set of nodes in the graph that are pinned by the
// pins in the given pinner.
func ColoredSet(ctx context.Context, pn pin.Pinner, ls dag.LinkService, bestEffortRoots []*cid.Cid, output chan<- Result) (*cid.Set, error) { func ColoredSet(ctx context.Context, pn pin.Pinner, ls dag.LinkService, bestEffortRoots []*cid.Cid, output chan<- Result) (*cid.Set, error) {
// KeySet currently implemented in memory, in the future, may be bloom filter or // KeySet currently implemented in memory, in the future, may be bloom filter or
// disk backed to conserve memory. // disk backed to conserve memory.
@ -112,7 +116,7 @@ func ColoredSet(ctx context.Context, pn pin.Pinner, ls dag.LinkService, bestEffo
links, err := ls.GetLinks(ctx, cid) links, err := ls.GetLinks(ctx, cid)
if err != nil { if err != nil {
errors = true errors = true
output <- Result{Error: &CouldNotFetchLinksError{cid, err}} output <- Result{Error: &CannotFetchLinksError{cid, err}}
} }
return links, nil return links, nil
} }
@ -126,7 +130,7 @@ func ColoredSet(ctx context.Context, pn pin.Pinner, ls dag.LinkService, bestEffo
links, err := ls.GetLinks(ctx, cid) links, err := ls.GetLinks(ctx, cid)
if err != nil && err != dag.ErrNotFound { if err != nil && err != dag.ErrNotFound {
errors = true errors = true
output <- Result{Error: &CouldNotFetchLinksError{cid, err}} output <- Result{Error: &CannotFetchLinksError{cid, err}}
} }
return links, nil return links, nil
} }
@ -147,30 +151,30 @@ func ColoredSet(ctx context.Context, pn pin.Pinner, ls dag.LinkService, bestEffo
} }
if errors { if errors {
return nil, ErrCouldNotFetchAllLinks return nil, ErrCannotFetchAllLinks
} else {
return gcs, nil
} }
return gcs, nil
} }
var ErrCouldNotFetchAllLinks = errors.New("garbage collection aborted: could not retrieve some links") var ErrCannotFetchAllLinks = errors.New("garbage collection aborted: could not retrieve some links")
var ErrCouldNotDeleteSomeBlocks = errors.New("garbage collection incomplete: could not delete some blocks") var ErrCannotDeleteSomeBlocks = errors.New("garbage collection incomplete: could not delete some blocks")
type CouldNotFetchLinksError struct { type CannotFetchLinksError struct {
Key *cid.Cid Key *cid.Cid
Err error Err error
} }
func (e *CouldNotFetchLinksError) Error() string { func (e *CannotFetchLinksError) Error() string {
return fmt.Sprintf("could not retrieve links for %s: %s", e.Key, e.Err) return fmt.Sprintf("could not retrieve links for %s: %s", e.Key, e.Err)
} }
type CouldNotDeleteBlockError struct { type CannotDeleteBlockError struct {
Key *cid.Cid Key *cid.Cid
Err error Err error
} }
func (e *CouldNotDeleteBlockError) Error() string { func (e *CannotDeleteBlockError) Error() string {
return fmt.Sprintf("could not remove %s: %s", e.Key, e.Err) return fmt.Sprintf("could not remove %s: %s", e.Key, e.Err)
} }