1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
// Copyright (C) 2022-2023 Luke Shumaker <lukeshu@lukeshu.com>
//
// SPDX-License-Identifier: GPL-2.0-or-later
package btrfsutil
import (
"context"
"fmt"
"reflect"
"time"
"github.com/datawire/dlib/dlog"
"git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsitem"
"git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsprim"
"git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfstree"
"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/maps"
"git.lukeshu.com/btrfs-progs-ng/lib/slices"
"git.lukeshu.com/btrfs-progs-ng/lib/textui"
)
type GraphNode struct {
Level uint8
Generation btrfsprim.Generation
Owner btrfsprim.ObjID
NumItems uint32
MinItem btrfsprim.Key
MaxItem btrfsprim.Key
Items []btrfsprim.Key
}
func (n GraphNode) String() string {
if reflect.ValueOf(n).IsZero() {
return "{}"
}
return fmt.Sprintf(`{lvl:%v, gen:%v, tree:%v, cnt:%v, min:(%v,%v,%v), max:(%v,%v,%v)}`,
n.Level, n.Generation, n.Owner, n.NumItems,
n.MinItem.ObjectID, n.MinItem.ItemType, n.MinItem.Offset,
n.MaxItem.ObjectID, n.MaxItem.ItemType, n.MaxItem.Offset)
}
type GraphEdge struct {
// It is invalid for both 'FromRoot' and 'FromNode' to be
// non-zero. If both are zero, then the GraphEdge is from the
// superblock.
FromRoot btrfsvol.LogicalAddr
FromNode btrfsvol.LogicalAddr
FromItem int // only valid if one of FromRoot or FromNode is non-zero
FromTree btrfsprim.ObjID
ToNode btrfsvol.LogicalAddr
ToLevel uint8
ToKey btrfsprim.Key
ToGeneration btrfsprim.Generation
}
func (kp GraphEdge) String() string {
var from string
switch {
case kp.FromRoot != 0:
from = fmt.Sprintf("root@%v[%d]:%v",
kp.FromRoot, kp.FromItem, kp.FromTree)
case kp.FromNode != 0:
from = fmt.Sprintf("{node:%v, tree:%v}[%d]",
kp.FromNode, kp.FromTree, kp.FromItem)
default:
from = fmt.Sprintf("superblock:%v", kp.FromTree)
}
return fmt.Sprintf(`%s -> {n:%v,l:%v,g:%v,k:(%v,%v,%v)}`,
from,
kp.ToNode, kp.ToLevel, kp.ToGeneration,
kp.ToKey.ObjectID,
kp.ToKey.ItemType,
kp.ToKey.Offset)
}
type Graph struct {
Nodes map[btrfsvol.LogicalAddr]GraphNode
BadNodes map[btrfsvol.LogicalAddr]error
EdgesFrom map[btrfsvol.LogicalAddr][]*GraphEdge
EdgesTo map[btrfsvol.LogicalAddr][]*GraphEdge
}
func (g Graph) insertEdge(ptr *GraphEdge) {
if ptr.ToNode == 0 {
panic("kp.ToNode should not be zero")
}
if ptr.FromRoot != 0 && ptr.FromNode != 0 {
panic("kp.FromRoot and kp.FromNode should not both be set")
}
if (ptr.FromRoot == 0 && ptr.FromNode == 0) && ptr.FromItem != 0 {
panic("kp.FromItem should only be set if either kp.FromRoot or kp.FromItem is set")
}
g.EdgesFrom[ptr.FromNode] = append(g.EdgesFrom[ptr.FromNode], ptr)
g.EdgesTo[ptr.ToNode] = append(g.EdgesTo[ptr.ToNode], ptr)
}
func (g Graph) insertTreeRoot(sb btrfstree.Superblock, treeID btrfsprim.ObjID) {
treeInfo, err := btrfstree.LookupTreeRoot(nil, sb, treeID)
if err != nil {
// This shouldn't ever happen for treeIDs that are
// mentioned directly in the superblock; which are the
// only trees for which we should call
// .insertTreeRoot().
panic(fmt.Errorf("LookupTreeRoot(%v): %w", treeID, err))
}
if treeInfo.RootNode == 0 {
return
}
g.insertEdge(&GraphEdge{
FromTree: treeID,
ToNode: treeInfo.RootNode,
ToLevel: treeInfo.Level,
ToGeneration: treeInfo.Generation,
})
}
func NewGraph(sb btrfstree.Superblock) *Graph {
g := &Graph{
Nodes: make(map[btrfsvol.LogicalAddr]GraphNode),
BadNodes: make(map[btrfsvol.LogicalAddr]error),
EdgesFrom: make(map[btrfsvol.LogicalAddr][]*GraphEdge),
EdgesTo: make(map[btrfsvol.LogicalAddr][]*GraphEdge),
}
// These 4 trees are mentioned directly in the superblock, so
// they are always seen.
g.insertTreeRoot(sb, btrfsprim.ROOT_TREE_OBJECTID)
g.insertTreeRoot(sb, btrfsprim.CHUNK_TREE_OBJECTID)
g.insertTreeRoot(sb, btrfsprim.TREE_LOG_OBJECTID)
g.insertTreeRoot(sb, btrfsprim.BLOCK_GROUP_TREE_OBJECTID)
return g
}
func (g Graph) InsertNode(nodeRef *diskio.Ref[btrfsvol.LogicalAddr, btrfstree.Node]) {
nodeData := GraphNode{
Level: nodeRef.Data.Head.Level,
Generation: nodeRef.Data.Head.Generation,
Owner: nodeRef.Data.Head.Owner,
NumItems: nodeRef.Data.Head.NumItems,
MinItem: discardOK(nodeRef.Data.MinItem()),
MaxItem: discardOK(nodeRef.Data.MaxItem()),
}
if nodeRef.Data.Head.Level == 0 {
cnt := 0
for _, item := range nodeRef.Data.BodyLeaf {
if _, ok := item.Body.(*btrfsitem.Root); ok {
cnt++
}
}
kps := make([]GraphEdge, 0, cnt)
keys := make([]btrfsprim.Key, len(nodeRef.Data.BodyLeaf))
nodeData.Items = keys
g.Nodes[nodeRef.Addr] = nodeData
for i, item := range nodeRef.Data.BodyLeaf {
keys[i] = item.Key
if itemBody, ok := item.Body.(*btrfsitem.Root); ok {
kps = append(kps, GraphEdge{
FromRoot: nodeRef.Addr,
FromItem: i,
FromTree: item.Key.ObjectID,
ToNode: itemBody.ByteNr,
ToLevel: itemBody.Level,
ToGeneration: itemBody.Generation,
})
g.insertEdge(&kps[len(kps)-1])
}
}
} else {
g.Nodes[nodeRef.Addr] = nodeData
kps := make([]GraphEdge, len(nodeRef.Data.BodyInternal))
for i, kp := range nodeRef.Data.BodyInternal {
kps[i] = GraphEdge{
FromNode: nodeRef.Addr,
FromItem: i,
FromTree: nodeRef.Data.Head.Owner,
ToNode: kp.BlockPtr,
ToLevel: nodeRef.Data.Head.Level - 1,
ToKey: kp.Key,
ToGeneration: kp.Generation,
}
g.insertEdge(&kps[i])
}
}
}
func (g Graph) FinalCheck(ctx context.Context, fs diskio.File[btrfsvol.LogicalAddr], sb btrfstree.Superblock) error {
var stats textui.Portion[int]
dlog.Info(ctx, "Checking keypointers for dead-ends...")
progressWriter := textui.NewProgress[textui.Portion[int]](ctx, dlog.LogLevelInfo, textui.Tunable(1*time.Second))
stats.D = len(g.EdgesTo)
progressWriter.Set(stats)
for laddr := range g.EdgesTo {
if _, ok := g.Nodes[laddr]; !ok {
_, err := btrfstree.ReadNode[btrfsvol.LogicalAddr](fs, sb, laddr, btrfstree.NodeExpectations{
LAddr: containers.Optional[btrfsvol.LogicalAddr]{OK: true, Val: laddr},
})
if err == nil {
progressWriter.Done()
return fmt.Errorf("node@%v exists but was not in node scan results", laddr)
}
g.BadNodes[laddr] = err
}
stats.N++
progressWriter.Set(stats)
}
progressWriter.Done()
dlog.Info(ctx, "... done checking keypointers")
dlog.Info(ctx, "Checking for btree loops...")
stats.D = len(g.Nodes)
stats.N = 0
progressWriter = textui.NewProgress[textui.Portion[int]](ctx, dlog.LogLevelInfo, textui.Tunable(1*time.Second))
progressWriter.Set(stats)
visited := make(containers.Set[btrfsvol.LogicalAddr], len(g.Nodes))
numLoops := 0
var checkNode func(node btrfsvol.LogicalAddr, stack []btrfsvol.LogicalAddr)
checkNode = func(node btrfsvol.LogicalAddr, stack []btrfsvol.LogicalAddr) {
defer func() {
stats.N = len(visited)
progressWriter.Set(stats)
}()
if visited.Has(node) {
return
}
if slices.Contains(node, stack) {
numLoops++
dlog.Error(ctx, "loop:")
for _, line := range g.renderLoop(append(stack, node)) {
dlog.Errorf(ctx, " %s", line)
}
return
}
stack = append(stack, node)
for _, kp := range g.EdgesTo[node] {
checkNode(kp.FromNode, stack)
}
visited.Insert(node)
}
for _, node := range maps.SortedKeys(g.Nodes) {
checkNode(node, nil)
}
progressWriter.Done()
if numLoops > 0 {
return fmt.Errorf("%d btree loops", numLoops)
}
dlog.Info(ctx, "... done checking for loops")
return nil
}
func discardOK[T any](val T, _ bool) T {
return val
}
|
