// Copyright (C) 2022 Luke Shumaker // // SPDX-License-Identifier: GPL-2.0-or-later package btrfsinspect import ( "context" "errors" "fmt" "strings" "sync" "time" "github.com/datawire/dlib/dgroup" "github.com/datawire/dlib/dlog" "git.lukeshu.com/btrfs-progs-ng/lib/binstruct" "git.lukeshu.com/btrfs-progs-ng/lib/btrfs" "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/btrfssum" "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/textui" ) type ScanDevicesResult map[btrfsvol.DeviceID]ScanOneDeviceResult func ScanDevices(ctx context.Context, fs *btrfs.FS) (ScanDevicesResult, error) { grp := dgroup.NewGroup(ctx, dgroup.GroupConfig{}) var mu sync.Mutex result := make(map[btrfsvol.DeviceID]ScanOneDeviceResult) for id, dev := range fs.LV.PhysicalVolumes() { id := id dev := dev grp.Go(dev.Name(), func(ctx context.Context) error { sb, err := dev.Superblock() if err != nil { return err } devResult, err := ScanOneDevice(ctx, dev, *sb) if err != nil { return err } mu.Lock() result[id] = devResult mu.Unlock() return nil }) } if err := grp.Wait(); err != nil { return nil, err } return result, nil } type ScanOneDeviceResult struct { Checksums btrfssum.SumRun[btrfsvol.PhysicalAddr] FoundNodes map[btrfsvol.LogicalAddr][]btrfsvol.PhysicalAddr FoundChunks []btrfstree.SysChunk FoundBlockGroups []SysBlockGroup FoundDevExtents []SysDevExtent FoundExtentCSums []SysExtentCSum } type SysBlockGroup struct { Key btrfsprim.Key BG btrfsitem.BlockGroup } type SysDevExtent struct { Key btrfsprim.Key DevExt btrfsitem.DevExtent } type SysExtentCSum struct { Generation btrfsprim.Generation Sums btrfsitem.ExtentCSum } type scanStats struct { DevName string DevSize btrfsvol.PhysicalAddr Pos btrfsvol.PhysicalAddr NumFoundNodes int NumFoundChunks int NumFoundBlockGroups int NumFoundDevExtents int NumFoundExtentCSums int } func (s scanStats) String() string { return fmt.Sprintf("... dev[%q] scanned %v%% (%d/%d) (found: %v nodes, %v chunks, %v block groups, %v dev extents, %v sum items)", s.DevName, int(100*float64(s.Pos)/float64(s.DevSize)), s.Pos, s.DevSize, s.NumFoundNodes, s.NumFoundChunks, s.NumFoundBlockGroups, s.NumFoundDevExtents, s.NumFoundExtentCSums) } // ScanOneDevice mostly mimics btrfs-progs // cmds/rescue-chunk-recover.c:scan_one_device(). func ScanOneDevice(ctx context.Context, dev *btrfs.Device, sb btrfstree.Superblock) (ScanOneDeviceResult, error) { result := ScanOneDeviceResult{ FoundNodes: make(map[btrfsvol.LogicalAddr][]btrfsvol.PhysicalAddr), } sbSize := btrfsvol.PhysicalAddr(binstruct.StaticSize(btrfstree.Superblock{})) devSize := dev.Size() if sb.NodeSize < sb.SectorSize { return result, fmt.Errorf("node_size(%v) < sector_size(%v)", sb.NodeSize, sb.SectorSize) } if sb.SectorSize != btrfssum.BlockSize { // TODO: probably handle this? return result, fmt.Errorf("sector_size(%v) != btrfssum.BlockSize", sb.SectorSize) } alg := sb.ChecksumType csumSize := alg.Size() numSums := int(devSize / btrfssum.BlockSize) var sums strings.Builder sums.Grow(numSums * csumSize) progressWriter := textui.NewProgress[scanStats](ctx, dlog.LogLevelInfo, 1*time.Second) progress := func(pos btrfsvol.PhysicalAddr) { progressWriter.Set(scanStats{ DevName: dev.Name(), DevSize: devSize, Pos: pos, NumFoundNodes: len(result.FoundNodes), NumFoundChunks: len(result.FoundChunks), NumFoundBlockGroups: len(result.FoundBlockGroups), NumFoundDevExtents: len(result.FoundDevExtents), NumFoundExtentCSums: len(result.FoundExtentCSums), }) } var minNextNode btrfsvol.PhysicalAddr for i := 0; i < numSums; i++ { if ctx.Err() != nil { return result, ctx.Err() } pos := btrfsvol.PhysicalAddr(i * btrfssum.BlockSize) progress(pos) sum, err := btrfs.ChecksumPhysical(dev, alg, pos) if err != nil { return result, err } sums.Write(sum[:csumSize]) checkForNode := pos >= minNextNode && pos+btrfsvol.PhysicalAddr(sb.NodeSize) <= devSize if checkForNode { for _, sbAddr := range btrfs.SuperblockAddrs { if sbAddr <= pos && pos < sbAddr+sbSize { checkForNode = false break } } } if checkForNode { nodeRef, err := btrfstree.ReadNode[btrfsvol.PhysicalAddr](dev, sb, pos, btrfstree.NodeExpectations{}) if err != nil { if !errors.Is(err, btrfstree.ErrNotANode) { dlog.Errorf(ctx, "... dev[%q] error: %v", dev.Name(), err) } } else { result.FoundNodes[nodeRef.Data.Head.Addr] = append(result.FoundNodes[nodeRef.Data.Head.Addr], nodeRef.Addr) for i, item := range nodeRef.Data.BodyLeaf { switch item.Key.ItemType { case btrfsitem.CHUNK_ITEM_KEY: chunk, ok := item.Body.(btrfsitem.Chunk) if !ok { dlog.Errorf(ctx, "... dev[%q] node@%v: item %v: error: type is CHUNK_ITEM_KEY, but struct is %T", dev.Name(), nodeRef.Addr, i, item.Body) continue } //dlog.Tracef(ctx, "... dev[%q] node@%v: item %v: found chunk", // dev.Name(), nodeRef.Addr, i) result.FoundChunks = append(result.FoundChunks, btrfstree.SysChunk{ Key: item.Key, Chunk: chunk, }) case btrfsitem.BLOCK_GROUP_ITEM_KEY: bg, ok := item.Body.(btrfsitem.BlockGroup) if !ok { dlog.Errorf(ctx, "... dev[%q] node@%v: item %v: error: type is BLOCK_GROUP_ITEM_KEY, but struct is %T", dev.Name(), nodeRef.Addr, i, item.Body) continue } //dlog.Tracef(ctx, "... dev[%q] node@%v: item %v: found block group", // dev.Name(), nodeRef.Addr, i) result.FoundBlockGroups = append(result.FoundBlockGroups, SysBlockGroup{ Key: item.Key, BG: bg, }) case btrfsitem.DEV_EXTENT_KEY: devext, ok := item.Body.(btrfsitem.DevExtent) if !ok { dlog.Errorf(ctx, "... dev[%q] node@%v: item %v: error: type is DEV_EXTENT_KEY, but struct is %T", dev.Name(), nodeRef.Addr, i, item.Body) continue } //dlog.Tracef(ctx, "... dev[%q] node@%v: item %v: found dev extent", // dev.Name(), nodeRef.Addr, i) result.FoundDevExtents = append(result.FoundDevExtents, SysDevExtent{ Key: item.Key, DevExt: devext, }) case btrfsitem.EXTENT_CSUM_KEY: sums, ok := item.Body.(btrfsitem.ExtentCSum) if !ok { dlog.Errorf(ctx, "... dev[%q] node@%v: item %v: error: type is EXTENT_CSUM_OBJECTID, but struct is %T", dev.Name(), nodeRef.Addr, i, item.Body) continue } //dlog.Tracef(ctx, "... dev[%q] node@%v: item %v: found csums", // dev.Name(), nodeRef.Addr, i) result.FoundExtentCSums = append(result.FoundExtentCSums, SysExtentCSum{ Generation: nodeRef.Data.Head.Generation, Sums: sums, }) } } minNextNode = pos + btrfsvol.PhysicalAddr(sb.NodeSize) } } } progress(devSize) progressWriter.Done() result.Checksums = btrfssum.SumRun[btrfsvol.PhysicalAddr]{ ChecksumSize: csumSize, Sums: btrfssum.ShortSum(sums.String()), } return result, nil }