summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@lukeshu.com>2022-08-28 17:01:02 -0600
committerLuke Shumaker <lukeshu@lukeshu.com>2022-08-28 17:57:07 -0600
commita2743121bad8a390dd248e3ec5c8d6844876832a (patch)
tree4a86c183b5eca6158d05da552b53db35cac36215
parentd06965da119e09e1f5d60d0ed81061693f2e8be6 (diff)
btrfs: Split io3_btree.go in to multiple files
This isn't changing anything, just cut/paste. Some of these decisions will make more sense in a later commit.
-rw-r--r--lib/btrfs/btree_ops.go503
-rw-r--r--lib/btrfs/btree_path.go128
-rw-r--r--lib/btrfs/btree_util.go84
-rw-r--r--lib/btrfs/io3_btree.go677
4 files changed, 715 insertions, 677 deletions
diff --git a/lib/btrfs/btree_ops.go b/lib/btrfs/btree_ops.go
new file mode 100644
index 0000000..b590aa7
--- /dev/null
+++ b/lib/btrfs/btree_ops.go
@@ -0,0 +1,503 @@
+// Copyright (C) 2022 Luke Shumaker <lukeshu@lukeshu.com>
+//
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+package btrfs
+
+import (
+ "context"
+ "errors"
+ "fmt"
+ iofs "io/fs"
+ "math"
+
+ "github.com/datawire/dlib/derror"
+
+ "git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsitem"
+ "git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsvol"
+ "git.lukeshu.com/btrfs-progs-ng/lib/diskio"
+ "git.lukeshu.com/btrfs-progs-ng/lib/slices"
+)
+
+type Trees interface {
+ // TreeWalk walks a tree, triggering callbacks for every node,
+ // key-pointer, and item; as well as for any errors encountered.
+ //
+ // If the tree is valid, then everything is walked in key-order; but if
+ // the tree is broken, then ordering is not guaranteed.
+ //
+ // Canceling the Context causes TreeWalk to return early; no
+ // values from the Context are used.
+ //
+ // The lifecycle of callbacks is:
+ //
+ // 001 .PreNode()
+ // 002 (read node)
+ // 003 .Node() (or .BadNode())
+ // for item in node.items:
+ // if internal:
+ // 004 .PreKeyPointer()
+ // 005 (recurse)
+ // 006 .PostKeyPointer()
+ // else:
+ // 004 .Item() (or .BadItem())
+ // 007 .PostNode()
+ TreeWalk(ctx context.Context, treeID ObjID, errHandle func(*TreeError), cbs TreeWalkHandler)
+
+ TreeLookup(treeID ObjID, key Key) (Item, error)
+ TreeSearch(treeID ObjID, fn func(key Key, size uint32) int) (Item, error) // size is math.MaxUint32 for key-pointers
+
+ // If some items are able to be read, but there is an error reading the
+ // full set, then it might return *both* a list of items and an error.
+ //
+ // If no such item is found, an error that is io/fs.ErrNotExist is
+ // returned.
+ TreeSearchAll(treeID ObjID, fn func(key Key, size uint32) int) ([]Item, error) // size is math.MaxUint32 for key-pointers
+
+ // For bootstrapping purposes.
+ Superblock() (*Superblock, error)
+
+ // For reading raw data extants pointed at by tree items.
+ ReadAt(p []byte, off btrfsvol.LogicalAddr) (int, error)
+}
+
+type TreeWalkHandler struct {
+ // Callbacks for entire nodes.
+ //
+ // If any of these return an error that is io/fs.SkipDir, the
+ // node immediately stops getting processed; if PreNode, Node,
+ // or BadNode return io/fs.SkipDir then key pointers and items
+ // within the node are not processed.
+ PreNode func(TreePath) error
+ Node func(TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node]) error
+ BadNode func(TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node], error) error
+ PostNode func(TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node]) error
+ // Callbacks for items on internal nodes
+ PreKeyPointer func(TreePath, KeyPointer) error
+ PostKeyPointer func(TreePath, KeyPointer) error
+ // Callbacks for items on leaf nodes
+ Item func(TreePath, Item) error
+ BadItem func(TreePath, Item) error
+}
+
+type TreeError struct {
+ Path TreePath
+ Err error
+}
+
+func (e *TreeError) Unwrap() error { return e.Err }
+
+func (e *TreeError) Error() string {
+ return fmt.Sprintf("%v: %v", e.Path, e.Err)
+}
+
+// TreeWalk implements the 'Trees' interface.
+func (fs *FS) TreeWalk(ctx context.Context, treeID ObjID, errHandle func(*TreeError), cbs TreeWalkHandler) {
+ rootInfo, err := LookupTreeRoot(fs, treeID)
+ if err != nil {
+ errHandle(&TreeError{Path: TreePath{{FromTree: treeID}}, Err: err})
+ return
+ }
+ fs.RawTreeWalk(ctx, *rootInfo, errHandle, cbs)
+}
+
+// TreeWalk is a utility function to help with implementing the 'Trees'
+// interface.
+func (fs *FS) RawTreeWalk(ctx context.Context, rootInfo TreeRoot, errHandle func(*TreeError), cbs TreeWalkHandler) {
+ path := TreePath{{
+ FromTree: rootInfo.TreeID,
+ FromGeneration: rootInfo.Generation,
+ FromItemIdx: -1,
+ ToNodeAddr: rootInfo.RootNode,
+ ToNodeLevel: rootInfo.Level,
+ }}
+ fs.treeWalk(ctx, path, errHandle, cbs)
+}
+
+func (fs *FS) treeWalk(ctx context.Context, path TreePath, errHandle func(*TreeError), cbs TreeWalkHandler) {
+ if ctx.Err() != nil {
+ return
+ }
+ if path.Node(-1).ToNodeAddr == 0 {
+ return
+ }
+
+ if cbs.PreNode != nil {
+ if err := cbs.PreNode(path); err != nil {
+ if errors.Is(err, iofs.SkipDir) {
+ return
+ }
+ errHandle(&TreeError{Path: path, Err: err})
+ }
+ if ctx.Err() != nil {
+ return
+ }
+ }
+ node, err := fs.ReadNode(path)
+ if ctx.Err() != nil {
+ return
+ }
+ if err != nil && node != nil && cbs.BadNode != nil {
+ // opportunity to fix the node
+ err = cbs.BadNode(path, node, err)
+ if errors.Is(err, iofs.SkipDir) {
+ return
+ }
+ }
+ if err != nil {
+ errHandle(&TreeError{Path: path, Err: err})
+ } else {
+ if cbs.Node != nil {
+ if err := cbs.Node(path, node); err != nil {
+ if errors.Is(err, iofs.SkipDir) {
+ return
+ }
+ errHandle(&TreeError{Path: path, Err: err})
+ }
+ }
+ }
+ if ctx.Err() != nil {
+ return
+ }
+ if node != nil {
+ for i, item := range node.Data.BodyInternal {
+ itemPath := append(path, TreePathElem{
+ FromTree: node.Data.Head.Owner,
+ FromGeneration: node.Data.Head.Generation,
+ FromItemIdx: i,
+ ToNodeAddr: item.BlockPtr,
+ ToNodeLevel: node.Data.Head.Level - 1,
+ })
+ if cbs.PreKeyPointer != nil {
+ if err := cbs.PreKeyPointer(itemPath, item); err != nil {
+ errHandle(&TreeError{Path: itemPath, Err: err})
+ }
+ if ctx.Err() != nil {
+ return
+ }
+ }
+ fs.treeWalk(ctx, itemPath, errHandle, cbs)
+ if cbs.PostKeyPointer != nil {
+ if err := cbs.PostKeyPointer(itemPath, item); err != nil {
+ errHandle(&TreeError{Path: itemPath, Err: err})
+ }
+ if ctx.Err() != nil {
+ return
+ }
+ }
+ }
+ for i, item := range node.Data.BodyLeaf {
+ itemPath := append(path, TreePathElem{
+ FromTree: node.Data.Head.Owner,
+ FromGeneration: node.Data.Head.Generation,
+ FromItemIdx: i,
+ })
+ if errBody, isErr := item.Body.(btrfsitem.Error); isErr {
+ if cbs.BadItem == nil {
+ errHandle(&TreeError{Path: itemPath, Err: errBody.Err})
+ } else {
+ if err := cbs.BadItem(itemPath, item); err != nil {
+ errHandle(&TreeError{Path: itemPath, Err: err})
+ }
+ if ctx.Err() != nil {
+ return
+ }
+ }
+ } else {
+ if cbs.Item != nil {
+ if err := cbs.Item(itemPath, item); err != nil {
+ errHandle(&TreeError{Path: itemPath, Err: err})
+ }
+ if ctx.Err() != nil {
+ return
+ }
+ }
+ }
+ }
+ }
+ if cbs.PostNode != nil {
+ if err := cbs.PostNode(path, node); err != nil {
+ if errors.Is(err, iofs.SkipDir) {
+ return
+ }
+ errHandle(&TreeError{Path: path, Err: err})
+ }
+ }
+}
+
+func (fs *FS) treeSearch(treeRoot TreeRoot, fn func(Key, uint32) int) (TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node], error) {
+ path := TreePath{{
+ FromTree: treeRoot.TreeID,
+ FromGeneration: treeRoot.Generation,
+ FromItemIdx: -1,
+ ToNodeAddr: treeRoot.RootNode,
+ ToNodeLevel: treeRoot.Level,
+ }}
+ for {
+ if path.Node(-1).ToNodeAddr == 0 {
+ return TreePath{}, nil, iofs.ErrNotExist
+ }
+ node, err := fs.ReadNode(path)
+ if err != nil {
+ return TreePath{}, nil, err
+ }
+
+ if node.Data.Head.Level > 0 {
+ // internal node
+
+ // Search for the right-most node.Data.BodyInternal item for which
+ // `fn(item.Key) >= 0`.
+ //
+ // + + + + 0 - - - -
+ //
+ // There may or may not be a value that returns '0'.
+ //
+ // i.e. find the highest value that isn't too high.
+ lastGood, ok := slices.SearchHighest(node.Data.BodyInternal, func(kp KeyPointer) int {
+ return slices.Min(fn(kp.Key, math.MaxUint32), 0) // don't return >0; a key can't be "too low"
+ })
+ if !ok {
+ return TreePath{}, nil, iofs.ErrNotExist
+ }
+ path = append(path, TreePathElem{
+ FromTree: node.Data.Head.Owner,
+ FromGeneration: node.Data.Head.Generation,
+ FromItemIdx: lastGood,
+ ToNodeAddr: node.Data.BodyInternal[lastGood].BlockPtr,
+ ToNodeLevel: node.Data.Head.Level - 1,
+ })
+ } else {
+ // leaf node
+
+ // Search for a member of node.Data.BodyLeaf for which
+ // `fn(item.Head.Key) == 0`.
+ //
+ // + + + + 0 - - - -
+ //
+ // Such an item might not exist; in this case, return nil/ErrNotExist.
+ // Multiple such items might exist; in this case, it does not matter which
+ // is returned.
+ //
+ // Implement this search as a binary search.
+ idx, ok := slices.Search(node.Data.BodyLeaf, func(item Item) int {
+ return fn(item.Key, item.BodySize)
+ })
+ if !ok {
+ return TreePath{}, nil, iofs.ErrNotExist
+ }
+ path = append(path, TreePathElem{
+ FromTree: node.Data.Head.Owner,
+ FromGeneration: node.Data.Head.Generation,
+ FromItemIdx: idx,
+ })
+ return path, node, nil
+ }
+ }
+}
+
+func (fs *FS) prev(path TreePath, node *diskio.Ref[btrfsvol.LogicalAddr, Node]) (TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node], error) {
+ var err error
+ path = path.DeepCopy()
+
+ // go up
+ for path.Node(-1).FromItemIdx < 1 {
+ path = path.Parent()
+ if len(path) == 0 {
+ return TreePath{}, nil, nil
+ }
+ }
+ // go left
+ path.Node(-1).FromItemIdx--
+ if path.Node(-1).ToNodeAddr != 0 {
+ if node.Addr != path.Node(-2).ToNodeAddr {
+ node, err = fs.ReadNode(path.Parent())
+ if err != nil {
+ return TreePath{}, nil, err
+ }
+ path.Node(-1).ToNodeAddr = node.Data.BodyInternal[path.Node(-1).FromItemIdx].BlockPtr
+ }
+ }
+ // go down
+ for path.Node(-1).ToNodeAddr != 0 {
+ if node.Addr != path.Node(-1).ToNodeAddr {
+ node, err = fs.ReadNode(path)
+ if err != nil {
+ return TreePath{}, nil, err
+ }
+ }
+ if node.Data.Head.Level > 0 {
+ path = append(path, TreePathElem{
+ FromTree: node.Data.Head.Owner,
+ FromGeneration: node.Data.Head.Generation,
+ FromItemIdx: len(node.Data.BodyInternal) - 1,
+ ToNodeAddr: node.Data.BodyInternal[len(node.Data.BodyInternal)-1].BlockPtr,
+ ToNodeLevel: node.Data.Head.Level - 1,
+ })
+ } else {
+ path = append(path, TreePathElem{
+ FromTree: node.Data.Head.Owner,
+ FromGeneration: node.Data.Head.Generation,
+ FromItemIdx: len(node.Data.BodyLeaf) - 1,
+ })
+ }
+ }
+ // return
+ if node.Addr != path.Node(-2).ToNodeAddr {
+ node, err = fs.ReadNode(path.Parent())
+ if err != nil {
+ return TreePath{}, nil, err
+ }
+ }
+ return path, node, nil
+}
+
+func (fs *FS) next(path TreePath, node *diskio.Ref[btrfsvol.LogicalAddr, Node]) (TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node], error) {
+ var err error
+ path = path.DeepCopy()
+
+ // go up
+ if node.Addr != path.Node(-2).ToNodeAddr {
+ node, err = fs.ReadNode(path.Parent())
+ if err != nil {
+ return TreePath{}, nil, err
+ }
+ path.Node(-2).ToNodeLevel = node.Data.Head.Level
+ }
+ for path.Node(-1).FromItemIdx+1 >= int(node.Data.Head.NumItems) {
+ path = path.Parent()
+ if len(path) == 1 {
+ return TreePath{}, nil, nil
+ }
+ if node.Addr != path.Node(-2).ToNodeAddr {
+ node, err = fs.ReadNode(path.Parent())
+ if err != nil {
+ return TreePath{}, nil, err
+ }
+ path.Node(-2).ToNodeLevel = node.Data.Head.Level
+ }
+ }
+ // go right
+ path.Node(-1).FromItemIdx++
+ if path.Node(-1).ToNodeAddr != 0 {
+ if node.Addr != path.Node(-2).ToNodeAddr {
+ node, err = fs.ReadNode(path.Parent())
+ if err != nil {
+ return TreePath{}, nil, err
+ }
+ path.Node(-1).ToNodeAddr = node.Data.BodyInternal[path.Node(-1).FromItemIdx].BlockPtr
+ }
+ }
+ // go down
+ for path.Node(-1).ToNodeAddr != 0 {
+ if node.Addr != path.Node(-1).ToNodeAddr {
+ node, err = fs.ReadNode(path)
+ if err != nil {
+ return TreePath{}, nil, err
+ }
+ path.Node(-1).ToNodeLevel = node.Data.Head.Level
+ }
+ if node.Data.Head.Level > 0 {
+ path = append(path, TreePathElem{
+ FromTree: node.Data.Head.Owner,
+ FromGeneration: node.Data.Head.Generation,
+ FromItemIdx: 0,
+ ToNodeAddr: node.Data.BodyInternal[len(node.Data.BodyInternal)-1].BlockPtr,
+ ToNodeLevel: node.Data.Head.Level - 1,
+ })
+ } else {
+ path = append(path, TreePathElem{
+ FromTree: node.Data.Head.Owner,
+ FromGeneration: node.Data.Head.Generation,
+ FromItemIdx: 0,
+ })
+ }
+ }
+ // return
+ if node.Addr != path.Node(-2).ToNodeAddr {
+ node, err = fs.ReadNode(path.Parent())
+ if err != nil {
+ return TreePath{}, nil, err
+ }
+ }
+ return path, node, nil
+}
+
+// TreeSearch implements the 'Trees' interface.
+func (fs *FS) TreeSearch(treeID ObjID, fn func(Key, uint32) int) (Item, error) {
+ rootInfo, err := LookupTreeRoot(fs, treeID)
+ if err != nil {
+ return Item{}, err
+ }
+ path, node, err := fs.treeSearch(*rootInfo, fn)
+ if err != nil {
+ return Item{}, err
+ }
+ return node.Data.BodyLeaf[path.Node(-1).FromItemIdx], nil
+}
+
+// KeySearch returns a comparator suitable to be passed to TreeSearch.
+func KeySearch(fn func(Key) int) func(Key, uint32) int {
+ return func(key Key, _ uint32) int {
+ return fn(key)
+ }
+}
+
+// TreeLookup implements the 'Trees' interface.
+func (fs *FS) TreeLookup(treeID ObjID, key Key) (Item, error) {
+ item, err := fs.TreeSearch(treeID, KeySearch(key.Cmp))
+ if err != nil {
+ err = fmt.Errorf("item with key=%v: %w", key, err)
+ }
+ return item, err
+}
+
+// TreeSearchAll implements the 'Trees' interface.
+func (fs *FS) TreeSearchAll(treeID ObjID, fn func(Key, uint32) int) ([]Item, error) {
+ rootInfo, err := LookupTreeRoot(fs, treeID)
+ if err != nil {
+ return nil, err
+ }
+ middlePath, middleNode, err := fs.treeSearch(*rootInfo, fn)
+ if err != nil {
+ return nil, err
+ }
+ middleItem := middleNode.Data.BodyLeaf[middlePath.Node(-1).FromItemIdx]
+
+ var ret = []Item{middleItem}
+ var errs derror.MultiError
+ for prevPath, prevNode := middlePath, middleNode; true; {
+ prevPath, prevNode, err = fs.prev(prevPath, prevNode)
+ if err != nil {
+ errs = append(errs, err)
+ break
+ }
+ if len(prevPath) == 0 {
+ break
+ }
+ prevItem := prevNode.Data.BodyLeaf[prevPath.Node(-1).FromItemIdx]
+ if fn(prevItem.Key, prevItem.BodySize) != 0 {
+ break
+ }
+ ret = append(ret, prevItem)
+ }
+ slices.Reverse(ret)
+ for nextPath, nextNode := middlePath, middleNode; true; {
+ nextPath, nextNode, err = fs.next(nextPath, nextNode)
+ if err != nil {
+ errs = append(errs, err)
+ break
+ }
+ if len(nextPath) == 0 {
+ break
+ }
+ nextItem := nextNode.Data.BodyLeaf[nextPath.Node(-1).FromItemIdx]
+ if fn(nextItem.Key, nextItem.BodySize) != 0 {
+ break
+ }
+ ret = append(ret, nextItem)
+ }
+ if errs != nil {
+ err = errs
+ }
+ return ret, err
+}
diff --git a/lib/btrfs/btree_path.go b/lib/btrfs/btree_path.go
new file mode 100644
index 0000000..0124aea
--- /dev/null
+++ b/lib/btrfs/btree_path.go
@@ -0,0 +1,128 @@
+// Copyright (C) 2022 Luke Shumaker <lukeshu@lukeshu.com>
+//
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+package btrfs
+
+import (
+ "fmt"
+ "io"
+ "strings"
+
+ "git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsitem"
+ "git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsvol"
+)
+
+// - The first element will always have an ItemIdx of -1.
+//
+// - For .Item() callbacks, the last element will always have a
+// NodeAddr of 0.
+//
+// For example, a path through a tree, with the associated PathElems:
+//
+// [superblock: tree=B, lvl=3, gen=6]
+// |
+// | <------------------------------------------ pathElem={from_tree:B, from_gen=6, from_idx=-1,
+// | to_addr:0x01, to_lvl=3}
+// +[0x01]-------------+
+// | lvl=3 gen=6 own=B |
+// +-+-+-+-+-+-+-+-+-+-+
+// |0|1|2|3|4|5|6|7|8|9|
+// +-+-+-+-+-+-+-+-+-+-+
+// |
+// | <------------------------------ pathElem:{from_tree:B, from_gen:6, from_idx:7,
+// | to_addr:0x02, to_lvl:2}
+// +[0x02]--------------+
+// | lvl=2 gen=5 own=B |
+// +-+-+-+-+-+-+-+-+-+-+
+// |0|1|2|3|4|5|6|7|8|9|
+// +-+-+-+-+-+-+-+-+-+-+
+// |
+// | <-------------------- pathElem={from_tree:B, from_gen:5, from_idx:6,
+// | to_addr:0x03, to_lvl:1}
+// +[0x03]-------------+
+// | lvl=1 gen=5 own=A |
+// +-+-+-+-+-+-+-+-+-+-+
+// |0|1|2|3|4|5|6|7|8|9|
+// +-+-+-+-+-+-+-+-+-+-+
+// |
+// | <---------------- pathElem={from_tree:A, from_gen:5, from_idx:3,
+// | to_addr:0x04, to_lvl:0}
+// +[0x04]-------------+
+// | lvl=0 gen=2 own=A |
+// +-+-+-+-+-+-+-+-+-+-+
+// |0|1|2|3|4|5|6|7|8|9|
+// +-+-+-+-+-+-+-+-+-+-+
+// |
+// | <--------------- pathElem={from_tree:A, from_gen:2, from_idx:1,
+// | to_addr:0, to_lvl:0}
+// [item]
+type TreePath []TreePathElem
+
+// A TreePathElem essentially represents a KeyPointer. If there is an
+// error looking up the tree root, everything but FromTree is zero.
+type TreePathElem struct {
+ // FromTree is the owning tree ID of the parent node; or the
+ // well-known tree ID if this is the root.
+ FromTree ObjID
+ // FromGeneration is the generation of the parent node the
+ // parent node; or generation stored in the superblock if this
+ // is the root.
+ FromGeneration Generation
+ // FromItemIdx is the index of this KeyPointer in the parent
+ // Node; or -1 if this is the root and there is no KeyPointer.
+ FromItemIdx int
+
+ // ToNodeAddr is the address of the node that the KeyPointer
+ // points at, or 0 if this is a leaf item and nothing is being
+ // pointed at.
+ ToNodeAddr btrfsvol.LogicalAddr
+ // ToNodeLevel is the expected or actual level of the node at
+ // ToNodeAddr, or 0 if this is a leaf item and nothing is
+ // being pointed at.
+ ToNodeLevel uint8
+}
+
+func (elem TreePathElem) writeNodeTo(w io.Writer) {
+ fmt.Fprintf(w, "node:%d@%v", elem.ToNodeLevel, elem.ToNodeAddr)
+}
+
+func (path TreePath) String() string {
+ if len(path) == 0 {
+ return "(empty-path)"
+ } else {
+ var ret strings.Builder
+ fmt.Fprintf(&ret, "%s->", path[0].FromTree.Format(btrfsitem.ROOT_ITEM_KEY))
+ if len(path) == 1 && path[0] == (TreePathElem{FromTree: path[0].FromTree}) {
+ ret.WriteString("(empty-path)")
+ } else {
+ path[0].writeNodeTo(&ret)
+ }
+ for _, elem := range path[1:] {
+ fmt.Fprintf(&ret, "[%v]", elem.FromItemIdx)
+ if elem.ToNodeAddr != 0 {
+ ret.WriteString("->")
+ elem.writeNodeTo(&ret)
+ }
+ }
+ return ret.String()
+ }
+}
+
+func (path TreePath) DeepCopy() TreePath {
+ return append(TreePath(nil), path...)
+}
+
+func (path TreePath) Parent() TreePath {
+ return path[:len(path)-1]
+}
+
+// path.Node(x) is like &path[x], but negative values of x move down
+// from the end of path (similar to how lists work in many other
+// languages, such as Python).
+func (path TreePath) Node(x int) *TreePathElem {
+ if x < 0 {
+ x += len(path)
+ }
+ return &path[x]
+}
diff --git a/lib/btrfs/btree_util.go b/lib/btrfs/btree_util.go
new file mode 100644
index 0000000..2076114
--- /dev/null
+++ b/lib/btrfs/btree_util.go
@@ -0,0 +1,84 @@
+// Copyright (C) 2022 Luke Shumaker <lukeshu@lukeshu.com>
+//
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+package btrfs
+
+import (
+ "fmt"
+
+ "git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsitem"
+ "git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsvol"
+)
+
+// A TreeRoot is more-or-less a btrfsitem.Root, but simpler; returned by
+// LookupTreeRoot.
+type TreeRoot struct {
+ TreeID ObjID
+ RootNode btrfsvol.LogicalAddr
+ Level uint8
+ Generation Generation
+}
+
+// LookupTreeRoot is a utility function to help with implementing the 'Trees'
+// interface.
+func LookupTreeRoot(fs Trees, treeID ObjID) (*TreeRoot, error) {
+ sb, err := fs.Superblock()
+ if err != nil {
+ return nil, err
+ }
+ switch treeID {
+ case ROOT_TREE_OBJECTID:
+ return &TreeRoot{
+ TreeID: treeID,
+ RootNode: sb.RootTree,
+ Level: sb.RootLevel,
+ Generation: sb.Generation, // XXX: same generation as LOG_TREE?
+ }, nil
+ case CHUNK_TREE_OBJECTID:
+ return &TreeRoot{
+ TreeID: treeID,
+ RootNode: sb.ChunkTree,
+ Level: sb.ChunkLevel,
+ Generation: sb.ChunkRootGeneration,
+ }, nil
+ case TREE_LOG_OBJECTID:
+ return &TreeRoot{
+ TreeID: treeID,
+ RootNode: sb.LogTree,
+ Level: sb.LogLevel,
+ Generation: sb.Generation, // XXX: same generation as ROOT_TREE?
+ }, nil
+ case BLOCK_GROUP_TREE_OBJECTID:
+ return &TreeRoot{
+ TreeID: treeID,
+ RootNode: sb.BlockGroupRoot,
+ Level: sb.BlockGroupRootLevel,
+ Generation: sb.BlockGroupRootGeneration,
+ }, nil
+ default:
+ rootItem, err := fs.TreeSearch(ROOT_TREE_OBJECTID, func(key Key, _ uint32) int {
+ if key.ObjectID == treeID && key.ItemType == btrfsitem.ROOT_ITEM_KEY {
+ return 0
+ }
+ return Key{
+ ObjectID: treeID,
+ ItemType: btrfsitem.ROOT_ITEM_KEY,
+ Offset: 0,
+ }.Cmp(key)
+ })
+ if err != nil {
+ return nil, err
+ }
+ rootItemBody, ok := rootItem.Body.(btrfsitem.Root)
+ if !ok {
+ return nil, fmt.Errorf("malformed ROOT_ITEM for tree %v", treeID)
+ }
+ return &TreeRoot{
+ TreeID: treeID,
+ RootNode: rootItemBody.ByteNr,
+ Level: rootItemBody.Level,
+ Generation: rootItemBody.Generation,
+ }, nil
+ }
+}
diff --git a/lib/btrfs/io3_btree.go b/lib/btrfs/io3_btree.go
index 97670c0..1851508 100644
--- a/lib/btrfs/io3_btree.go
+++ b/lib/btrfs/io3_btree.go
@@ -6,180 +6,16 @@ package btrfs
import (
"context"
- "errors"
"fmt"
- "io"
- iofs "io/fs"
- "math"
- "strings"
-
- "github.com/datawire/dlib/derror"
"git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsitem"
"git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsvol"
"git.lukeshu.com/btrfs-progs-ng/lib/containers"
"git.lukeshu.com/btrfs-progs-ng/lib/diskio"
- "git.lukeshu.com/btrfs-progs-ng/lib/slices"
)
-type Trees interface {
- // TreeWalk walks a tree, triggering callbacks for every node,
- // key-pointer, and item; as well as for any errors encountered.
- //
- // If the tree is valid, then everything is walked in key-order; but if
- // the tree is broken, then ordering is not guaranteed.
- //
- // Canceling the Context causes TreeWalk to return early; no
- // values from the Context are used.
- //
- // The lifecycle of callbacks is:
- //
- // 001 .PreNode()
- // 002 (read node)
- // 003 .Node() (or .BadNode())
- // for item in node.items:
- // if internal:
- // 004 .PreKeyPointer()
- // 005 (recurse)
- // 006 .PostKeyPointer()
- // else:
- // 004 .Item() (or .BadItem())
- // 007 .PostNode()
- TreeWalk(ctx context.Context, treeID ObjID, errHandle func(*TreeError), cbs TreeWalkHandler)
-
- TreeLookup(treeID ObjID, key Key) (Item, error)
- TreeSearch(treeID ObjID, fn func(key Key, size uint32) int) (Item, error) // size is math.MaxUint32 for key-pointers
-
- // If some items are able to be read, but there is an error reading the
- // full set, then it might return *both* a list of items and an error.
- //
- // If no such item is found, an error that is io/fs.ErrNotExist is
- // returned.
- TreeSearchAll(treeID ObjID, fn func(key Key, size uint32) int) ([]Item, error) // size is math.MaxUint32 for key-pointers
-
- // For bootstrapping purposes.
- Superblock() (*Superblock, error)
-
- // For reading raw data extants pointed at by tree items.
- ReadAt(p []byte, off btrfsvol.LogicalAddr) (int, error)
-}
-
var _ Trees = (*FS)(nil)
-// - The first element will always have an ItemIdx of -1.
-//
-// - For .Item() callbacks, the last element will always have a
-// NodeAddr of 0.
-//
-// For example, a path through a tree, with the associated PathElems:
-//
-// [superblock: tree=B, lvl=3, gen=6]
-// |
-// | <------------------------------------------ pathElem={from_tree:B, from_gen=6, from_idx=-1,
-// | to_addr:0x01, to_lvl=3}
-// +[0x01]-------------+
-// | lvl=3 gen=6 own=B |
-// +-+-+-+-+-+-+-+-+-+-+
-// |0|1|2|3|4|5|6|7|8|9|
-// +-+-+-+-+-+-+-+-+-+-+
-// |
-// | <------------------------------ pathElem:{from_tree:B, from_gen:6, from_idx:7,
-// | to_addr:0x02, to_lvl:2}
-// +[0x02]--------------+
-// | lvl=2 gen=5 own=B |
-// +-+-+-+-+-+-+-+-+-+-+
-// |0|1|2|3|4|5|6|7|8|9|
-// +-+-+-+-+-+-+-+-+-+-+
-// |
-// | <-------------------- pathElem={from_tree:B, from_gen:5, from_idx:6,
-// | to_addr:0x03, to_lvl:1}
-// +[0x03]-------------+
-// | lvl=1 gen=5 own=A |
-// +-+-+-+-+-+-+-+-+-+-+
-// |0|1|2|3|4|5|6|7|8|9|
-// +-+-+-+-+-+-+-+-+-+-+
-// |
-// | <---------------- pathElem={from_tree:A, from_gen:5, from_idx:3,
-// | to_addr:0x04, to_lvl:0}
-// +[0x04]-------------+
-// | lvl=0 gen=2 own=A |
-// +-+-+-+-+-+-+-+-+-+-+
-// |0|1|2|3|4|5|6|7|8|9|
-// +-+-+-+-+-+-+-+-+-+-+
-// |
-// | <--------------- pathElem={from_tree:A, from_gen:2, from_idx:1,
-// | to_addr:0, to_lvl:0}
-// [item]
-type TreePath []TreePathElem
-
-// A TreePathElem essentially represents a KeyPointer. If there is an
-// error looking up the tree root, everything but FromTree is zero.
-type TreePathElem struct {
- // FromTree is the owning tree ID of the parent node; or the
- // well-known tree ID if this is the root.
- FromTree ObjID
- // FromGeneration is the generation of the parent node the
- // parent node; or generation stored in the superblock if this
- // is the root.
- FromGeneration Generation
- // FromItemIdx is the index of this KeyPointer in the parent
- // Node; or -1 if this is the root and there is no KeyPointer.
- FromItemIdx int
-
- // ToNodeAddr is the address of the node that the KeyPointer
- // points at, or 0 if this is a leaf item and nothing is being
- // pointed at.
- ToNodeAddr btrfsvol.LogicalAddr
- // ToNodeLevel is the expected or actual level of the node at
- // ToNodeAddr, or 0 if this is a leaf item and nothing is
- // being pointed at.
- ToNodeLevel uint8
-}
-
-func (elem TreePathElem) writeNodeTo(w io.Writer) {
- fmt.Fprintf(w, "node:%d@%v", elem.ToNodeLevel, elem.ToNodeAddr)
-}
-
-func (path TreePath) String() string {
- if len(path) == 0 {
- return "(empty-path)"
- } else {
- var ret strings.Builder
- fmt.Fprintf(&ret, "%s->", path[0].FromTree.Format(btrfsitem.ROOT_ITEM_KEY))
- if len(path) == 1 && path[0] == (TreePathElem{FromTree: path[0].FromTree}) {
- ret.WriteString("(empty-path)")
- } else {
- path[0].writeNodeTo(&ret)
- }
- for _, elem := range path[1:] {
- fmt.Fprintf(&ret, "[%v]", elem.FromItemIdx)
- if elem.ToNodeAddr != 0 {
- ret.WriteString("->")
- elem.writeNodeTo(&ret)
- }
- }
- return ret.String()
- }
-}
-
-func (path TreePath) DeepCopy() TreePath {
- return append(TreePath(nil), path...)
-}
-
-func (path TreePath) Parent() TreePath {
- return path[:len(path)-1]
-}
-
-// path.Node(x) is like &path[x], but negative values of x move down
-// from the end of path (similar to how lists work in many other
-// languages, such as Python).
-func (path TreePath) Node(x int) *TreePathElem {
- if x < 0 {
- x += len(path)
- }
- return &path[x]
-}
-
func (fs *FS) populateTreeUUIDs(ctx context.Context) {
if fs.cacheObjID2UUID == nil || fs.cacheUUID2ObjID == nil || fs.cacheTreeParent == nil {
fs.cacheObjID2UUID = make(map[ObjID]UUID)
@@ -238,516 +74,3 @@ func (fs *FS) ReadNode(path TreePath) (*diskio.Ref[btrfsvol.LogicalAddr, Node],
Owner: potentialOwners,
})
}
-
-type TreeError struct {
- Path TreePath
- Err error
-}
-
-func (e *TreeError) Unwrap() error { return e.Err }
-
-func (e *TreeError) Error() string {
- return fmt.Sprintf("%v: %v", e.Path, e.Err)
-}
-
-// A TreeRoot is more-or-less a btrfsitem.Root, but simpler; returned by
-// LookupTreeRoot.
-type TreeRoot struct {
- TreeID ObjID
- RootNode btrfsvol.LogicalAddr
- Level uint8
- Generation Generation
-}
-
-// LookupTreeRoot is a utility function to help with implementing the 'Trees'
-// interface.
-func LookupTreeRoot(fs Trees, treeID ObjID) (*TreeRoot, error) {
- sb, err := fs.Superblock()
- if err != nil {
- return nil, err
- }
- switch treeID {
- case ROOT_TREE_OBJECTID:
- return &TreeRoot{
- TreeID: treeID,
- RootNode: sb.RootTree,
- Level: sb.RootLevel,
- Generation: sb.Generation, // XXX: same generation as LOG_TREE?
- }, nil
- case CHUNK_TREE_OBJECTID:
- return &TreeRoot{
- TreeID: treeID,
- RootNode: sb.ChunkTree,
- Level: sb.ChunkLevel,
- Generation: sb.ChunkRootGeneration,
- }, nil
- case TREE_LOG_OBJECTID:
- return &TreeRoot{
- TreeID: treeID,
- RootNode: sb.LogTree,
- Level: sb.LogLevel,
- Generation: sb.Generation, // XXX: same generation as ROOT_TREE?
- }, nil
- case BLOCK_GROUP_TREE_OBJECTID:
- return &TreeRoot{
- TreeID: treeID,
- RootNode: sb.BlockGroupRoot,
- Level: sb.BlockGroupRootLevel,
- Generation: sb.BlockGroupRootGeneration,
- }, nil
- default:
- rootItem, err := fs.TreeSearch(ROOT_TREE_OBJECTID, func(key Key, _ uint32) int {
- if key.ObjectID == treeID && key.ItemType == btrfsitem.ROOT_ITEM_KEY {
- return 0
- }
- return Key{
- ObjectID: treeID,
- ItemType: btrfsitem.ROOT_ITEM_KEY,
- Offset: 0,
- }.Cmp(key)
- })
- if err != nil {
- return nil, err
- }
- rootItemBody, ok := rootItem.Body.(btrfsitem.Root)
- if !ok {
- return nil, fmt.Errorf("malformed ROOT_ITEM for tree %v", treeID)
- }
- return &TreeRoot{
- TreeID: treeID,
- RootNode: rootItemBody.ByteNr,
- Level: rootItemBody.Level,
- Generation: rootItemBody.Generation,
- }, nil
- }
-}
-
-type TreeWalkHandler struct {
- // Callbacks for entire nodes.
- //
- // If any of these return an error that is io/fs.SkipDir, the
- // node immediately stops getting processed; if PreNode, Node,
- // or BadNode return io/fs.SkipDir then key pointers and items
- // within the node are not processed.
- PreNode func(TreePath) error
- Node func(TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node]) error
- BadNode func(TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node], error) error
- PostNode func(TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node]) error
- // Callbacks for items on internal nodes
- PreKeyPointer func(TreePath, KeyPointer) error
- PostKeyPointer func(TreePath, KeyPointer) error
- // Callbacks for items on leaf nodes
- Item func(TreePath, Item) error
- BadItem func(TreePath, Item) error
-}
-
-// TreeWalk implements the 'Trees' interface.
-func (fs *FS) TreeWalk(ctx context.Context, treeID ObjID, errHandle func(*TreeError), cbs TreeWalkHandler) {
- rootInfo, err := LookupTreeRoot(fs, treeID)
- if err != nil {
- errHandle(&TreeError{Path: TreePath{{FromTree: treeID}}, Err: err})
- return
- }
- fs.RawTreeWalk(ctx, *rootInfo, errHandle, cbs)
-}
-
-// TreeWalk is a utility function to help with implementing the 'Trees'
-// interface.
-func (fs *FS) RawTreeWalk(ctx context.Context, rootInfo TreeRoot, errHandle func(*TreeError), cbs TreeWalkHandler) {
- path := TreePath{{
- FromTree: rootInfo.TreeID,
- FromGeneration: rootInfo.Generation,
- FromItemIdx: -1,
- ToNodeAddr: rootInfo.RootNode,
- ToNodeLevel: rootInfo.Level,
- }}
- fs.treeWalk(ctx, path, errHandle, cbs)
-}
-
-func (fs *FS) treeWalk(ctx context.Context, path TreePath, errHandle func(*TreeError), cbs TreeWalkHandler) {
- if ctx.Err() != nil {
- return
- }
- if path.Node(-1).ToNodeAddr == 0 {
- return
- }
-
- if cbs.PreNode != nil {
- if err := cbs.PreNode(path); err != nil {
- if errors.Is(err, iofs.SkipDir) {
- return
- }
- errHandle(&TreeError{Path: path, Err: err})
- }
- if ctx.Err() != nil {
- return
- }
- }
- node, err := fs.ReadNode(path)
- if ctx.Err() != nil {
- return
- }
- if err != nil && node != nil && cbs.BadNode != nil {
- // opportunity to fix the node
- err = cbs.BadNode(path, node, err)
- if errors.Is(err, iofs.SkipDir) {
- return
- }
- }
- if err != nil {
- errHandle(&TreeError{Path: path, Err: err})
- } else {
- if cbs.Node != nil {
- if err := cbs.Node(path, node); err != nil {
- if errors.Is(err, iofs.SkipDir) {
- return
- }
- errHandle(&TreeError{Path: path, Err: err})
- }
- }
- }
- if ctx.Err() != nil {
- return
- }
- if node != nil {
- for i, item := range node.Data.BodyInternal {
- itemPath := append(path, TreePathElem{
- FromTree: node.Data.Head.Owner,
- FromGeneration: node.Data.Head.Generation,
- FromItemIdx: i,
- ToNodeAddr: item.BlockPtr,
- ToNodeLevel: node.Data.Head.Level - 1,
- })
- if cbs.PreKeyPointer != nil {
- if err := cbs.PreKeyPointer(itemPath, item); err != nil {
- errHandle(&TreeError{Path: itemPath, Err: err})
- }
- if ctx.Err() != nil {
- return
- }
- }
- fs.treeWalk(ctx, itemPath, errHandle, cbs)
- if cbs.PostKeyPointer != nil {
- if err := cbs.PostKeyPointer(itemPath, item); err != nil {
- errHandle(&TreeError{Path: itemPath, Err: err})
- }
- if ctx.Err() != nil {
- return
- }
- }
- }
- for i, item := range node.Data.BodyLeaf {
- itemPath := append(path, TreePathElem{
- FromTree: node.Data.Head.Owner,
- FromGeneration: node.Data.Head.Generation,
- FromItemIdx: i,
- })
- if errBody, isErr := item.Body.(btrfsitem.Error); isErr {
- if cbs.BadItem == nil {
- errHandle(&TreeError{Path: itemPath, Err: errBody.Err})
- } else {
- if err := cbs.BadItem(itemPath, item); err != nil {
- errHandle(&TreeError{Path: itemPath, Err: err})
- }
- if ctx.Err() != nil {
- return
- }
- }
- } else {
- if cbs.Item != nil {
- if err := cbs.Item(itemPath, item); err != nil {
- errHandle(&TreeError{Path: itemPath, Err: err})
- }
- if ctx.Err() != nil {
- return
- }
- }
- }
- }
- }
- if cbs.PostNode != nil {
- if err := cbs.PostNode(path, node); err != nil {
- if errors.Is(err, iofs.SkipDir) {
- return
- }
- errHandle(&TreeError{Path: path, Err: err})
- }
- }
-}
-
-func (fs *FS) treeSearch(treeRoot TreeRoot, fn func(Key, uint32) int) (TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node], error) {
- path := TreePath{{
- FromTree: treeRoot.TreeID,
- FromGeneration: treeRoot.Generation,
- FromItemIdx: -1,
- ToNodeAddr: treeRoot.RootNode,
- ToNodeLevel: treeRoot.Level,
- }}
- for {
- if path.Node(-1).ToNodeAddr == 0 {
- return TreePath{}, nil, iofs.ErrNotExist
- }
- node, err := fs.ReadNode(path)
- if err != nil {
- return TreePath{}, nil, err
- }
-
- if node.Data.Head.Level > 0 {
- // internal node
-
- // Search for the right-most node.Data.BodyInternal item for which
- // `fn(item.Key) >= 0`.
- //
- // + + + + 0 - - - -
- //
- // There may or may not be a value that returns '0'.
- //
- // i.e. find the highest value that isn't too high.
- lastGood, ok := slices.SearchHighest(node.Data.BodyInternal, func(kp KeyPointer) int {
- return slices.Min(fn(kp.Key, math.MaxUint32), 0) // don't return >0; a key can't be "too low"
- })
- if !ok {
- return TreePath{}, nil, iofs.ErrNotExist
- }
- path = append(path, TreePathElem{
- FromTree: node.Data.Head.Owner,
- FromGeneration: node.Data.Head.Generation,
- FromItemIdx: lastGood,
- ToNodeAddr: node.Data.BodyInternal[lastGood].BlockPtr,
- ToNodeLevel: node.Data.Head.Level - 1,
- })
- } else {
- // leaf node
-
- // Search for a member of node.Data.BodyLeaf for which
- // `fn(item.Head.Key) == 0`.
- //
- // + + + + 0 - - - -
- //
- // Such an item might not exist; in this case, return nil/ErrNotExist.
- // Multiple such items might exist; in this case, it does not matter which
- // is returned.
- //
- // Implement this search as a binary search.
- idx, ok := slices.Search(node.Data.BodyLeaf, func(item Item) int {
- return fn(item.Key, item.BodySize)
- })
- if !ok {
- return TreePath{}, nil, iofs.ErrNotExist
- }
- path = append(path, TreePathElem{
- FromTree: node.Data.Head.Owner,
- FromGeneration: node.Data.Head.Generation,
- FromItemIdx: idx,
- })
- return path, node, nil
- }
- }
-}
-
-func (fs *FS) prev(path TreePath, node *diskio.Ref[btrfsvol.LogicalAddr, Node]) (TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node], error) {
- var err error
- path = path.DeepCopy()
-
- // go up
- for path.Node(-1).FromItemIdx < 1 {
- path = path.Parent()
- if len(path) == 0 {
- return TreePath{}, nil, nil
- }
- }
- // go left
- path.Node(-1).FromItemIdx--
- if path.Node(-1).ToNodeAddr != 0 {
- if node.Addr != path.Node(-2).ToNodeAddr {
- node, err = fs.ReadNode(path.Parent())
- if err != nil {
- return TreePath{}, nil, err
- }
- path.Node(-1).ToNodeAddr = node.Data.BodyInternal[path.Node(-1).FromItemIdx].BlockPtr
- }
- }
- // go down
- for path.Node(-1).ToNodeAddr != 0 {
- if node.Addr != path.Node(-1).ToNodeAddr {
- node, err = fs.ReadNode(path)
- if err != nil {
- return TreePath{}, nil, err
- }
- }
- if node.Data.Head.Level > 0 {
- path = append(path, TreePathElem{
- FromTree: node.Data.Head.Owner,
- FromGeneration: node.Data.Head.Generation,
- FromItemIdx: len(node.Data.BodyInternal) - 1,
- ToNodeAddr: node.Data.BodyInternal[len(node.Data.BodyInternal)-1].BlockPtr,
- ToNodeLevel: node.Data.Head.Level - 1,
- })
- } else {
- path = append(path, TreePathElem{
- FromTree: node.Data.Head.Owner,
- FromGeneration: node.Data.Head.Generation,
- FromItemIdx: len(node.Data.BodyLeaf) - 1,
- })
- }
- }
- // return
- if node.Addr != path.Node(-2).ToNodeAddr {
- node, err = fs.ReadNode(path.Parent())
- if err != nil {
- return TreePath{}, nil, err
- }
- }
- return path, node, nil
-}
-
-func (fs *FS) next(path TreePath, node *diskio.Ref[btrfsvol.LogicalAddr, Node]) (TreePath, *diskio.Ref[btrfsvol.LogicalAddr, Node], error) {
- var err error
- path = path.DeepCopy()
-
- // go up
- if node.Addr != path.Node(-2).ToNodeAddr {
- node, err = fs.ReadNode(path.Parent())
- if err != nil {
- return TreePath{}, nil, err
- }
- path.Node(-2).ToNodeLevel = node.Data.Head.Level
- }
- for path.Node(-1).FromItemIdx+1 >= int(node.Data.Head.NumItems) {
- path = path.Parent()
- if len(path) == 1 {
- return TreePath{}, nil, nil
- }
- if node.Addr != path.Node(-2).ToNodeAddr {
- node, err = fs.ReadNode(path.Parent())
- if err != nil {
- return TreePath{}, nil, err
- }
- path.Node(-2).ToNodeLevel = node.Data.Head.Level
- }
- }
- // go right
- path.Node(-1).FromItemIdx++
- if path.Node(-1).ToNodeAddr != 0 {
- if node.Addr != path.Node(-2).ToNodeAddr {
- node, err = fs.ReadNode(path.Parent())
- if err != nil {
- return TreePath{}, nil, err
- }
- path.Node(-1).ToNodeAddr = node.Data.BodyInternal[path.Node(-1).FromItemIdx].BlockPtr
- }
- }
- // go down
- for path.Node(-1).ToNodeAddr != 0 {
- if node.Addr != path.Node(-1).ToNodeAddr {
- node, err = fs.ReadNode(path)
- if err != nil {
- return TreePath{}, nil, err
- }
- path.Node(-1).ToNodeLevel = node.Data.Head.Level
- }
- if node.Data.Head.Level > 0 {
- path = append(path, TreePathElem{
- FromTree: node.Data.Head.Owner,
- FromGeneration: node.Data.Head.Generation,
- FromItemIdx: 0,
- ToNodeAddr: node.Data.BodyInternal[len(node.Data.BodyInternal)-1].BlockPtr,
- ToNodeLevel: node.Data.Head.Level - 1,
- })
- } else {
- path = append(path, TreePathElem{
- FromTree: node.Data.Head.Owner,
- FromGeneration: node.Data.Head.Generation,
- FromItemIdx: 0,
- })
- }
- }
- // return
- if node.Addr != path.Node(-2).ToNodeAddr {
- node, err = fs.ReadNode(path.Parent())
- if err != nil {
- return TreePath{}, nil, err
- }
- }
- return path, node, nil
-}
-
-// TreeSearch implements the 'Trees' interface.
-func (fs *FS) TreeSearch(treeID ObjID, fn func(Key, uint32) int) (Item, error) {
- rootInfo, err := LookupTreeRoot(fs, treeID)
- if err != nil {
- return Item{}, err
- }
- path, node, err := fs.treeSearch(*rootInfo, fn)
- if err != nil {
- return Item{}, err
- }
- return node.Data.BodyLeaf[path.Node(-1).FromItemIdx], nil
-}
-
-// KeySearch returns a comparator suitable to be passed to TreeSearch.
-func KeySearch(fn func(Key) int) func(Key, uint32) int {
- return func(key Key, _ uint32) int {
- return fn(key)
- }
-}
-
-// TreeLookup implements the 'Trees' interface.
-func (fs *FS) TreeLookup(treeID ObjID, key Key) (Item, error) {
- item, err := fs.TreeSearch(treeID, KeySearch(key.Cmp))
- if err != nil {
- err = fmt.Errorf("item with key=%v: %w", key, err)
- }
- return item, err
-}
-
-// TreeSearchAll implements the 'Trees' interface.
-func (fs *FS) TreeSearchAll(treeID ObjID, fn func(Key, uint32) int) ([]Item, error) {
- rootInfo, err := LookupTreeRoot(fs, treeID)
- if err != nil {
- return nil, err
- }
- middlePath, middleNode, err := fs.treeSearch(*rootInfo, fn)
- if err != nil {
- return nil, err
- }
- middleItem := middleNode.Data.BodyLeaf[middlePath.Node(-1).FromItemIdx]
-
- var ret = []Item{middleItem}
- var errs derror.MultiError
- for prevPath, prevNode := middlePath, middleNode; true; {
- prevPath, prevNode, err = fs.prev(prevPath, prevNode)
- if err != nil {
- errs = append(errs, err)
- break
- }
- if len(prevPath) == 0 {
- break
- }
- prevItem := prevNode.Data.BodyLeaf[prevPath.Node(-1).FromItemIdx]
- if fn(prevItem.Key, prevItem.BodySize) != 0 {
- break
- }
- ret = append(ret, prevItem)
- }
- slices.Reverse(ret)
- for nextPath, nextNode := middlePath, middleNode; true; {
- nextPath, nextNode, err = fs.next(nextPath, nextNode)
- if err != nil {
- errs = append(errs, err)
- break
- }
- if len(nextPath) == 0 {
- break
- }
- nextItem := nextNode.Data.BodyLeaf[nextPath.Node(-1).FromItemIdx]
- if fn(nextItem.Key, nextItem.BodySize) != 0 {
- break
- }
- ret = append(ret, nextItem)
- }
- if errs != nil {
- err = errs
- }
- return ret, err
-}