summaryrefslogtreecommitdiff
path: root/cmd/btrfs-rec/inspect_rebuildmappings.go
blob: e883b93313c2ddfe772af98988bd6280de86ad02 (plain)
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
// Copyright (C) 2022-2023  Luke Shumaker <lukeshu@lukeshu.com>
//
// SPDX-License-Identifier: GPL-2.0-or-later

package main

import (
	"os"

	"git.lukeshu.com/go/lowmemjson"
	"github.com/datawire/dlib/dlog"
	"github.com/datawire/ocibuild/pkg/cliutil"
	"github.com/spf13/cobra"

	"git.lukeshu.com/btrfs-progs-ng/cmd/btrfs-rec/inspect/rebuildmappings"
	"git.lukeshu.com/btrfs-progs-ng/lib/btrfs"
	"git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsvol"
	"git.lukeshu.com/btrfs-progs-ng/lib/containers"
	"git.lukeshu.com/btrfs-progs-ng/lib/maps"
)

func init() {
	cmd := &cobra.Command{
		Use:   "rebuild-mappings",
		Short: "Rebuild broken chunk/dev/blockgroup trees",
		Long: "" +
			"The rebuilt information is printed as JSON on stdout, and can " +
			"be loaded by the --mappings flag.\n" +
			"\n" +
			"This is very similar to `btrfs rescue chunk-recover`, but (1) " +
			"does a better job, (2) is less buggy, and (3) doesn't actually " +
			"write the info back to the filesystem; instead writing it " +
			"out-of-band to stdout.\n" +
			"\n" +
			"The I/O and the CPU parts of this can be split up as:\n" +
			"\n" +
			"\tbtrfs-rec inspect rebuild-mappings scan > SCAN.json   # read\n" +
			"\tbtrfs-rec inspect rebuild-mappings process SCAN.json  # CPU\n",
		Args: cliutil.WrapPositionalArgs(cobra.NoArgs),
		RunE: runWithRawFS(func(fs *btrfs.FS, cmd *cobra.Command, args []string) error {
			ctx := cmd.Context()

			scanResults, err := rebuildmappings.ScanDevices(ctx, fs)
			if err != nil {
				return err
			}

			if err := rebuildmappings.RebuildMappings(ctx, fs, scanResults); err != nil {
				return err
			}

			dlog.Infof(ctx, "Writing reconstructed mappings to stdout...")
			if err := writeJSONFile(os.Stdout, fs.LV.Mappings(), lowmemjson.ReEncoderConfig{
				Indent:                "\t",
				ForceTrailingNewlines: true,
				CompactIfUnder:        120, //nolint:gomnd // This is what looks nice.
			}); err != nil {
				return err
			}
			dlog.Info(ctx, "... done writing")

			return nil
		}),
	}

	cmd.AddCommand(&cobra.Command{
		Use:   "scan",
		Short: "Read from the filesystem all data nescessary to rebuild the mappings",
		Args:  cliutil.WrapPositionalArgs(cobra.NoArgs),
		RunE: runWithRawFS(func(fs *btrfs.FS, cmd *cobra.Command, _ []string) (err error) {
			ctx := cmd.Context()

			devResults, err := rebuildmappings.ScanDevices(ctx, fs)
			if err != nil {
				return err
			}

			scanResults := rebuildmappings.ScanResult{
				Mappings: fs.LV.Mappings(),
				Devices:  devResults,
			}

			dlog.Info(ctx, "Writing scan results to stdout...")
			if err := writeJSONFile(os.Stdout, scanResults, lowmemjson.ReEncoderConfig{
				Indent:                "\t",
				ForceTrailingNewlines: true,
				CompactIfUnder:        16, //nolint:gomnd // This is what looks nice.
			}); err != nil {
				return err
			}
			dlog.Info(ctx, "... done writing")

			return nil
		}),
	})

	cmd.AddCommand(&cobra.Command{
		Use:   "process",
		Short: "Rebuild the mappings based on previously read data",
		Args:  cliutil.WrapPositionalArgs(cobra.ExactArgs(1)),
		RunE: runWithRawFS(func(fs *btrfs.FS, cmd *cobra.Command, args []string) error {
			ctx := cmd.Context()

			dlog.Infof(ctx, "Reading %q...", args[0])
			scanResults, err := readJSONFile[rebuildmappings.ScanResult](ctx, args[0])
			if err != nil {
				return err
			}
			dlog.Infof(ctx, "... done reading %q", args[0])

			if err := rebuildmappings.RebuildMappings(ctx, fs, scanResults.Devices); err != nil {
				return err
			}

			dlog.Infof(ctx, "Writing reconstructed mappings to stdout...")
			if err := writeJSONFile(os.Stdout, fs.LV.Mappings(), lowmemjson.ReEncoderConfig{
				Indent:                "\t",
				ForceTrailingNewlines: true,
				CompactIfUnder:        120, //nolint:gomnd // This is what looks nice.
			}); err != nil {
				return err
			}
			dlog.Info(ctx, "... done writing")

			return nil
		}),
	})

	cmd.AddCommand(&cobra.Command{
		Use:   "list-nodes",
		Short: "Produce a listing of btree nodes from previously read data",
		Long: "" +
			"This is a variant of `btrfs-rec inspect list-nodes` that takes " +
			"advantage of using previously read data from " +
			"`btrfs-rec inspect rebuild-nodes scan`.",
		Args: cliutil.WrapPositionalArgs(cobra.ExactArgs(1)),
		RunE: run(func(cmd *cobra.Command, args []string) error {
			ctx := cmd.Context()

			scanResults, err := readJSONFile[rebuildmappings.ScanResult](ctx, args[0])
			if err != nil {
				return err
			}

			var cnt int
			for _, devResults := range scanResults.Devices {
				cnt += len(devResults.FoundNodes)
			}
			set := make(containers.Set[btrfsvol.LogicalAddr], cnt)
			for _, devResults := range scanResults.Devices {
				for laddr := range devResults.FoundNodes {
					set.Insert(laddr)
				}
			}
			nodeList := maps.SortedKeys(set)

			dlog.Infof(ctx, "Writing nodes to stdout...")
			if err := writeJSONFile(os.Stdout, nodeList, lowmemjson.ReEncoderConfig{
				Indent:                "\t",
				ForceTrailingNewlines: true,
			}); err != nil {
				return err
			}
			dlog.Info(ctx, "... done writing")

			return nil
		}),
	})

	inspectors.AddCommand(cmd)
}