optimize catalog last param

Signed-off-by: eyjhb <eyjhbb@gmail.com>
Signed-off-by: David van der Spek <vanderspek.david@gmail.com>
This commit is contained in:
eyjhbb@gmail.com 2023-06-27 12:26:51 +02:00 committed by David van der Spek
parent 22725209e3
commit 65f4ce4d93
Failed to extract signature
2 changed files with 95 additions and 78 deletions

View file

@ -5,12 +5,17 @@ import (
"errors" "errors"
"io" "io"
"path" "path"
"sort"
"strings" "strings"
"github.com/distribution/distribution/v3/reference" "github.com/distribution/distribution/v3/reference"
"github.com/distribution/distribution/v3/registry/storage/driver" "github.com/distribution/distribution/v3/registry/storage/driver"
) )
var (
ErrStopRec = errors.New("Stopped the recursion for getting repositories")
)
// Returns a list, or partial list, of repositories in the registry. // Returns a list, or partial list, of repositories in the registry.
// Because it's a quite expensive operation, it should only be used when building up // Because it's a quite expensive operation, it should only be used when building up
// an initial set of repositories. // an initial set of repositories.
@ -27,21 +32,18 @@ func (reg *registry) Repositories(ctx context.Context, repos []string, last stri
return 0, err return 0, err
} }
err = reg.blobStore.driver.Walk(ctx, root, func(fileInfo driver.FileInfo) error { err = reg.getRepositories(ctx, root, last, func(repoPath string) error {
err := handleRepository(fileInfo, root, last, func(repoPath string) error { // this is placed before the append,
foundRepos = append(foundRepos, repoPath) // so that we will get a extra repo if
return nil // any. This assures that we do not return
}) // io.EOF without it being the last record.
if err != nil {
return err
}
// if we've filled our array, no need to walk any further
if len(foundRepos) == len(repos) { if len(foundRepos) == len(repos) {
finishedWalk = true finishedWalk = true
return driver.ErrSkipDir return ErrStopRec
} }
foundRepos = append(foundRepos, repoPath)
return nil return nil
}) })
@ -64,11 +66,7 @@ func (reg *registry) Enumerate(ctx context.Context, ingester func(string) error)
return err return err
} }
err = reg.blobStore.driver.Walk(ctx, root, func(fileInfo driver.FileInfo) error { return reg.getRepositories(ctx, root, "", ingester)
return handleRepository(fileInfo, root, "", ingester)
})
return err
} }
// Remove removes a repository from storage // Remove removes a repository from storage
@ -81,78 +79,95 @@ func (reg *registry) Remove(ctx context.Context, name reference.Named) error {
return reg.driver.Delete(ctx, repoDir) return reg.driver.Delete(ctx, repoDir)
} }
// lessPath returns true if one path a is less than path b. // getRepositories is a helper function for getRepositoriesRec calls
// // the function fn with a repository path, if the current path looked
// A component-wise comparison is done, rather than the lexical comparison of // at is a repository and is lexicographically after last. It is possible
// strings. // to return driver.ErrSkipDir, if there is no interest in any repositories
func lessPath(a, b string) bool { // under the given `repoPath`, or call ErrStopRec if the recursion should stop.
// we provide this behavior by making separator always sort first. func (reg *registry) getRepositories(ctx context.Context, root, last string, fn func(repoPath string) error) error {
return compareReplaceInline(a, b, '/', '\x00') < 0 midFn := fn
// middleware func to exclude the `last` repo
// only use it, if there is set a last.
if last != "" {
midFn = func(repoPath string) error {
if repoPath != last {
return fn(repoPath)
}
return nil
}
}
// call our recursive func, with the midFn and the start path
// of where we want to find repositories.
err := reg.getRepositoriesRec(ctx, root, root, last, midFn)
if err == ErrStopRec {
return nil
}
return err
} }
// compareReplaceInline modifies runtime.cmpstring to replace old with new // getRepositoriesRec recurse through all folders it the `lookPath`,
// during a byte-wise comparison. // there it will try to find repositories. See getRepositories for more.
func compareReplaceInline(s1, s2 string, old, new byte) int { func (reg *registry) getRepositoriesRec(ctx context.Context, root, lookPath, last string, fn func(repoPath string) error) error {
// TODO(stevvooe): We are missing an optimization when the s1 and s2 have // ensure that the current path is a dir, otherwise we just return
// the exact same slice header. It will make the code unsafe but can if f, err := reg.blobStore.driver.Stat(ctx, lookPath); err != nil || !f.IsDir() {
// provide some extra performance. if err != nil {
return err
l := len(s1) }
if len(s2) < l { return nil
l = len(s2)
} }
for i := 0; i < l; i++ { // get children in the current path
c1, c2 := s1[i], s2[i] children, err := reg.blobStore.driver.List(ctx, lookPath)
if c1 == old { if err != nil {
c1 = new return err
}
if c2 == old {
c2 = new
}
if c1 < c2 {
return -1
}
if c1 > c2 {
return +1
}
} }
if len(s1) < len(s2) { // sort this, so that it will be added in the correct order
return -1 sort.Strings(children)
}
if len(s1) > len(s2) { if last != "" {
return +1 splitLasts := strings.Split(last, "/")
}
return 0 // call the next iteration of getRepositoriesRec if any, but
} // exclude the current one.
if len(splitLasts) > 1 {
// handleRepository calls function fn with a repository path if fileInfo if err := reg.getRepositoriesRec(ctx, root, lookPath+"/"+splitLasts[0], strings.Join(splitLasts[1:], "/"), fn); err != nil {
// has a path of a repository under root and that it is lexographically return err
// after last. Otherwise, it will return ErrSkipDir. This should be used }
// with Walk to do handling with repositories in a storage. }
func handleRepository(fileInfo driver.FileInfo, root, last string, fn func(repoPath string) error) error {
filePath := fileInfo.Path() // find current last path in our children
n := sort.SearchStrings(children, lookPath+"/"+splitLasts[0])
// lop the base path off if n == len(children) || children[n] != lookPath+"/"+splitLasts[0] {
repo := filePath[len(root)+1:] return errors.New("the provided 'last' repositories does not exists")
}
_, file := path.Split(repo)
if file == "_manifests" { // if this is not a final `last` (there are more `/` left)
repo = strings.TrimSuffix(repo, "/_manifests") // then exclude the current index, else include it
if lessPath(last, repo) { if len(splitLasts) > 1 {
if err := fn(repo); err != nil { children = children[n+1:]
} else {
children = children[n:]
}
}
for _, child := range children {
_, file := path.Split(child)
if file == "_manifest" {
if err := fn(strings.TrimPrefix(lookPath, root+"/")); err != nil {
if err == driver.ErrSkipDir {
break
}
return err
}
} else if file[0] != '_' {
if err := reg.getRepositoriesRec(ctx, root, child, "", fn); err != nil {
return err return err
} }
} }
return driver.ErrSkipDir
} else if strings.HasPrefix(file, "_") {
return driver.ErrSkipDir
} }
return nil return nil

View file

@ -4,7 +4,6 @@ import (
"context" "context"
"fmt" "fmt"
"io" "io"
"math/rand"
"testing" "testing"
"github.com/distribution/distribution/v3" "github.com/distribution/distribution/v3"
@ -241,6 +240,7 @@ func TestCatalogWalkError(t *testing.T) {
t.Errorf("Expected catalog driver list error") t.Errorf("Expected catalog driver list error")
} }
} }
<<<<<<< HEAD
func BenchmarkPathCompareEqual(B *testing.B) { func BenchmarkPathCompareEqual(B *testing.B) {
B.StopTimer() B.StopTimer()
@ -323,3 +323,5 @@ func randomFilename(length int64) string {
} }
return string(b) return string(b)
} }
=======
>>>>>>> 27bd92bd (fix bug in catalog last param and optimized it)