summaryrefslogtreecommitdiff
path: root/cmd/btrfs-dump-tree/main.go
blob: ca9d52701377af16f6a70bc282911c69018b8797 (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
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
263
264
265
266
267
268
package main

import (
	"fmt"
	"os"
	"strings"

	"lukeshu.com/btrfs-tools/pkg/binstruct"
	"lukeshu.com/btrfs-tools/pkg/btrfs"
)

func main() {
	if err := Main(os.Args[1]); err != nil {
		fmt.Fprintf(os.Stderr, "%s: error: %v\n", os.Args[0], err)
		os.Exit(1)
	}
}

const version = "5.17"

func Main(imgfilename string) (err error) {
	maybeSetErr := func(_err error) {
		if _err != nil && err == nil {
			err = _err
		}
	}

	fh, err := os.Open(imgfilename)
	if err != nil {
		return err
	}
	defer func() {
		maybeSetErr(fh.Close())
	}()
	fs := &btrfs.FS{
		Devices: []*btrfs.Device{
			{
				File: fh,
			},
		},
	}

	if err := fs.Init(); err != nil {
		return err
	}

	superblock, err := fs.Superblock()
	if err != nil {
		return err
	}

	fmt.Printf("btrfs-progs v%s \n", version)
	if superblock.Data.RootTree != 0 {
		fmt.Printf("root tree\n")
		printTree(fs, superblock.Data.RootTree)
	}
	if superblock.Data.ChunkTree != 0 {
		fmt.Printf("chunk tree\n")
		printTree(fs, superblock.Data.ChunkTree)
	}
	if superblock.Data.LogTree != 0 {
		fmt.Printf("log root tree\n")
		printTree(fs, superblock.Data.LogTree)
	}
	if superblock.Data.BlockGroupRoot != 0 {
		fmt.Printf("block group tree\n")
		printTree(fs, superblock.Data.BlockGroupRoot)
	}

	return nil
}

// printTree mimics btrfs-progs kernel-shared/print-tree.c:btrfs_print_tree() and  kernel-shared/print-tree.c:btrfs_print_leaf()
func printTree(fs *btrfs.FS, root btrfs.LogicalAddr) {
	node, err := fs.ReadNode(root)
	if err != nil {
		fmt.Printf("error: %v\n", err)
		return
	}
	printHeaderInfo(node)
	switch node := node.(type) {
	case *btrfs.InternalNode:
		for _, item := range node.Body {
			fmt.Printf("\t%s block %d gen %d\n",
				fmtKey(item.Data.Key),
				item.Data.BlockPtr,
				item.Data.Generation)
		}
		for _, item := range node.Body {
			printTree(fs, item.Data.BlockPtr)
		}
	case *btrfs.LeafNode:
		for i, item := range node.Body {
			fmt.Printf("\titem %d %s itemoff %d itemsize %d\n",
				i,
				fmtKey(item.Data.Key),
				item.Data.DataOffset,
				item.Data.DataSize)
			switch item.Data.Key.ItemType {
			case btrfs.BTRFS_UNTYPED_KEY:
				// TODO
			case btrfs.BTRFS_INODE_ITEM_KEY:
				// TODO(!)
			case btrfs.BTRFS_INODE_REF_KEY:
				dat := item.Data.Data.Data
				for len(dat) > 0 {
					var ref btrfs.InodeRefItem
					if err := binstruct.Unmarshal(dat, &ref); err != nil {
						fmt.Printf("error: %v\n", err)
						return
					}
					dat = dat[0xA:]
					ref.Name = dat[:ref.NameLen]
					dat = dat[ref.NameLen:]

					fmt.Printf("\t\tindex %d namelen %d name: %s\n",
						ref.Index, ref.NameLen, ref.Name)
				}
			case btrfs.BTRFS_INODE_EXTREF_KEY:
				// TODO
			case btrfs.BTRFS_DIR_ITEM_KEY, btrfs.BTRFS_DIR_INDEX_KEY, btrfs.BTRFS_XATTR_ITEM_KEY:
				// TODO
			case btrfs.BTRFS_DIR_LOG_INDEX_KEY, btrfs.BTRFS_DIR_LOG_ITEM_KEY:
				// TODO
			case btrfs.BTRFS_ORPHAN_ITEM_KEY:
				fmt.Printf("\t\torphan item\n")
			case btrfs.BTRFS_ROOT_ITEM_KEY:
				var obj btrfs.RootItem
				if err := binstruct.Unmarshal(item.Data.Data.Data, &obj); err != nil {
					fmt.Printf("error: %v\n", err)
					return
				}
				fmt.Printf("\t\tgeneration %d root_dirid %d bytenr %d byte_limit %d bytes_used %d\n",
					obj.Generation, obj.RootDirID, obj.ByteNr, obj.ByteLimit, obj.BytesUsed)
				fmt.Printf("\t\tlast_snapshot %d flags %s refs %d\n",
					obj.LastSnapshot, obj.Flags, obj.Refs)
				fmt.Printf("\t\tdrop_progress %s drop_level %d\n",
					fmtKey(obj.DropProgress), obj.DropLevel)
				fmt.Printf("\t\tlevel %d generation_v2 %d\n",
					obj.Level, obj.GenerationV2)
				if obj.Generation == obj.GenerationV2 {
					fmt.Printf("\t\tuuid %s\n", obj.UUID)
					fmt.Printf("\t\tparent_uuid %s\n", obj.ParentUUID)
					fmt.Printf("\t\treceived_uuid %s\n", obj.ReceivedUUID)
					fmt.Printf("\t\tctransid %d otransid %d stransid %d rtransid %d\n",
						obj.CTransID, obj.OTransID, obj.STransID, obj.RTransID)
					fmt.Printf("\t\tctime %s\n", fmtTime(obj.CTime))
					fmt.Printf("\t\totime %s\n", fmtTime(obj.OTime))
					fmt.Printf("\t\tstime %s\n", fmtTime(obj.STime))
					fmt.Printf("\t\trtime %s\n", fmtTime(obj.RTime))
				}
			case btrfs.BTRFS_ROOT_REF_KEY:
				// TODO
			case btrfs.BTRFS_ROOT_BACKREF_KEY:
				// TODO
			case btrfs.BTRFS_EXTENT_ITEM_KEY:
				// TODO
			case btrfs.BTRFS_METADATA_ITEM_KEY:
				// TODO
			case btrfs.BTRFS_TREE_BLOCK_REF_KEY:
				fmt.Printf("\t\ttree block backref\n")
			case btrfs.BTRFS_SHARED_BLOCK_REF_KEY:
				fmt.Printf("\t\tshared block backref\n")
			case btrfs.BTRFS_EXTENT_DATA_REF_KEY:
				// TODO
			case btrfs.BTRFS_SHARED_DATA_REF_KEY:
				// TODO
			case btrfs.BTRFS_EXTENT_REF_V0_KEY:
				fmt.Printf("\t\textent ref v0 (deprecated)\n")
			case btrfs.BTRFS_CSUM_ITEM_KEY:
				fmt.Printf("\t\tcsum item\n")
			case btrfs.BTRFS_EXTENT_CSUM_KEY:
				// TODO
			case btrfs.BTRFS_EXTENT_DATA_KEY:
				// TODO
			case btrfs.BTRFS_BLOCK_GROUP_ITEM_KEY:
				// TODO
			case btrfs.BTRFS_FREE_SPACE_INFO_KEY:
				// TODO
			case btrfs.BTRFS_FREE_SPACE_EXTENT_KEY:
				fmt.Printf("\t\tfree space extent\n")
			case btrfs.BTRFS_FREE_SPACE_BITMAP_KEY:
				fmt.Printf("\t\tfree space bitmap\n")
			case btrfs.BTRFS_CHUNK_ITEM_KEY:
				// TODO(!)
			case btrfs.BTRFS_DEV_ITEM_KEY:
				// TODO
			case btrfs.BTRFS_DEV_EXTENT_KEY:
				// TODO
			case btrfs.BTRFS_QGROUP_STATUS_KEY:
				// TODO
			case btrfs.BTRFS_QGROUP_RELATION_KEY, btrfs.BTRFS_QGROUP_INFO_KEY:
				// TODO
			case btrfs.BTRFS_QGROUP_LIMIT_KEY:
				// TODO
			case btrfs.BTRFS_UUID_KEY_SUBVOL, btrfs.BTRFS_UUID_KEY_RECEIVED_SUBVOL:
				// TODO
			case btrfs.BTRFS_STRING_ITEM_KEY:
				// TODO
			case btrfs.BTRFS_PERSISTENT_ITEM_KEY:
				// TODO
			case btrfs.BTRFS_TEMPORARY_ITEM_KEY:
				// TODO
			}
		}
	}
}

// printHeaderInfo mimics btrfs-progs kernel-shared/print-tree.c:print_header_info()
func printHeaderInfo(node btrfs.Node) {
	var typename string
	switch node := node.(type) {
	case *btrfs.InternalNode:
		typename = "node"
		fmt.Printf("node %d level %d items %d free space %d",
			node.Header.Addr,
			node.Header.Data.Level,
			node.Header.Data.NumItems,
			node.Header.Data.MaxItems-node.Header.Data.NumItems)
	case *btrfs.LeafNode:
		typename = "leaf"
		fmt.Printf("leaf %d items %d free space %d",
			node.Header.Addr,
			node.Header.Data.NumItems,
			node.FreeSpace())
	}
	fmt.Printf(" generation %d owner %v\n",
		node.GetNodeHeader().Data.Generation,
		node.GetNodeHeader().Data.Owner)

	fmt.Printf("%s %d flags %s backref revision %d\n",
		typename,
		node.GetNodeHeader().Addr,
		node.GetNodeHeader().Data.Flags,
		node.GetNodeHeader().Data.BackrefRev)

	fmt.Printf("checksum stored %x\n", node.GetNodeHeader().Data.Checksum)
	fmt.Printf("checksum calced %v\n", "TODO")

	fmt.Printf("fs uuid %s\n", node.GetNodeHeader().Data.MetadataUUID)
	fmt.Printf("chunk uuid %s\n", node.GetNodeHeader().Data.ChunkTreeUUID)
}

// mimics print-tree.c:btrfs_print_key()
func fmtKey(key btrfs.Key) string {
	var out strings.Builder
	fmt.Fprintf(&out, "key (%s %v", key.ObjectID.Format(key.ItemType), key.ItemType)
	switch key.ItemType {
	case btrfs.BTRFS_QGROUP_RELATION_KEY, btrfs.BTRFS_QGROUP_INFO_KEY, btrfs.BTRFS_QGROUP_LIMIT_KEY:
		panic("not implemented")
	case btrfs.BTRFS_UUID_KEY_SUBVOL, btrfs.BTRFS_UUID_KEY_RECEIVED_SUBVOL:
		fmt.Fprintf(&out, " 0x%016x)", key.Offset)
	case btrfs.BTRFS_ROOT_ITEM_KEY:
		fmt.Fprintf(&out, " %v)", btrfs.ObjID(key.Offset))
	default:
		if key.Offset == btrfs.MaxUint64pp-1 {
			fmt.Fprintf(&out, " -1)")
		} else {
			fmt.Fprintf(&out, " %d)", key.Offset)
		}
	}
	return out.String()
}

func fmtTime(t btrfs.Time) string {
	return fmt.Sprintf("%d.%d (%s)",
		t.Sec, t.NSec, t.ToStd().Format("2006-01-02 15:04:05"))
}