This repository has been archived by the owner on Jun 13, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 42
/
vhdInspectCmdHandler.go
473 lines (413 loc) · 12.1 KB
/
vhdInspectCmdHandler.go
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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
package main
import (
"bytes"
"encoding/hex"
"errors"
"fmt"
"os"
"strconv"
"text/template"
"github.com/Microsoft/azure-vhd-utils/vhdcore"
"github.com/Microsoft/azure-vhd-utils/vhdcore/block/bitmap"
"github.com/Microsoft/azure-vhd-utils/vhdcore/footer"
"github.com/Microsoft/azure-vhd-utils/vhdcore/vhdfile"
"gopkg.in/urfave/cli.v1"
)
// FixedDiskBlocksInfo type describes general block information of a fixed disk
//
type FixedDiskBlocksInfo struct {
BlockSize int64
BlockCount int64
}
// ExpandableDiskBlocksInfo type describes general block information of a expandable disk
//
type ExpandableDiskBlocksInfo struct {
BlockDataSize int64
BlockBitmapSize int32
BlockBitmapPaddedSize int32
BlockCount int64
UsedBlockCount int64
EmptyBlockCount int64
}
func vhdInspectCmdHandler() cli.Command {
return cli.Command{
Name: "inspect",
Usage: "Commands to inspect local VHD",
Subcommands: []cli.Command{
{
Name: "header",
Usage: "Show VHD header",
Flags: []cli.Flag{
cli.StringFlag{
Name: "path",
Usage: "Path to VHD.",
},
},
Action: showVhdHeader,
},
{
Name: "footer",
Usage: "Show VHD footer",
Flags: []cli.Flag{
cli.StringFlag{
Name: "path",
Usage: "Path to VHD.",
},
},
Action: showVhdFooter,
},
{
Name: "bat",
Usage: "Show a range of VHD Block allocation table (BAT) entries",
Flags: []cli.Flag{
cli.StringFlag{
Name: "path",
Usage: "Path to VHD.",
},
cli.StringFlag{
Name: "start-range",
Usage: "Start range.",
},
cli.StringFlag{
Name: "end-range",
Usage: "End range.",
},
cli.BoolFlag{
Name: "skip-empty",
Usage: "Do not show BAT entries pointing to empty blocks.",
},
},
Action: showVhdBAT,
},
{
Name: "block",
Usage: "Inspect VHD blocks",
Subcommands: []cli.Command{
{
Name: "info",
Usage: "Show blocks general information",
Flags: []cli.Flag{
cli.StringFlag{
Name: "path",
Usage: "Path to VHD.",
},
},
Action: showVhdBlocksInfo,
},
{
Name: "bitmap",
Usage: "Show sector bitmap of a expandable disk's block",
Flags: []cli.Flag{
cli.StringFlag{
Name: "path",
Usage: "Path to VHD.",
},
cli.StringFlag{
Name: "block-index",
Usage: "Index of the block.",
},
},
Action: showVhdBlockBitmap,
},
},
},
},
}
}
const headerTempl = `Cookie : {{.Cookie }}
DataOffset : {{.DataOffset}}
TableOffset : {{.TableOffset}}
HeaderVersion : {{.HeaderVersion}}
MaxTableEntries : {{.MaxTableEntries}}
BlockSize : {{.BlockSize}} bytes
CheckSum : {{.CheckSum}}
ParentUniqueID : {{.ParentUniqueID}}
ParentTimeStamp : {{.ParentTimeStamp | printf "%v"}}
Reserved : {{.Reserved}}
ParentPath : {{.ParentPath}}
{{range .ParentLocators}}
PlatformCode : {{.PlatformCode}}
PlatformDataSpace : {{.PlatformDataSpace}}
PlatformDataLength : {{.PlatformDataLength}}
Reserved : {{.Reserved}}
PlatformDataOffset : {{.PlatformDataOffset}}
PlatformSpecificFileLocator: {{.PlatformSpecificFileLocator}}
{{end}}
-- Hex dump --
{{.RawData | dump }}`
func showVhdHeader(c *cli.Context) error {
vhdPath := c.String("path")
if vhdPath == "" {
return errors.New("Missing required argument --path")
}
vFileFactory := &vhdfile.FileFactory{}
vFile, err := vFileFactory.Create(vhdPath)
if err != nil {
return err
}
defer vFileFactory.Dispose(nil)
if vFile.GetDiskType() == footer.DiskTypeFixed {
return errors.New("Warn: Only expandable VHDs has header structure, this is a fixed VHD")
}
t, err := template.New("root").
Funcs(template.FuncMap{"dump": hex.Dump}).
Parse(headerTempl)
t.Execute(os.Stdout, vFile.Header)
return nil
}
const footerTempl = `Cookie : {{.Cookie }}
Features : {{.Features}}
FileFormatVersion : {{.FileFormatVersion}}
HeaderOffset : {{.HeaderOffset}}
TimeStamp : {{.TimeStamp | printf "%v" }}
CreatorApplication: {{.CreatorApplication}}
CreatorVersion : {{.CreatorVersion}}
CreatorHostOsType : {{.CreatorHostOsType}}
PhysicalSize : {{.PhysicalSize}} bytes
VirtualSize : {{.VirtualSize}} bytes
DiskGeometry : {{.DiskGeometry}}
DiskType : {{.DiskType}}
CheckSum : {{.CheckSum}}
UniqueID : {{.UniqueID}}
SavedState : {{.SavedState | printf "%v" }}
-- Hex dump --
{{.RawData | dump }}`
func showVhdFooter(c *cli.Context) error {
vhdPath := c.String("path")
if vhdPath == "" {
return errors.New("Missing required argument --path")
}
vFileFactory := &vhdfile.FileFactory{}
vFile, err := vFileFactory.Create(vhdPath)
if err != nil {
return err
}
defer vFileFactory.Dispose(nil)
t, err := template.New("root").
Funcs(template.FuncMap{"dump": hex.Dump}).
Parse(footerTempl)
t.Execute(os.Stdout, vFile.Footer)
return nil
}
const batTempl = `{{range $index, $value := .}} BAT[{{adj $index}}] : {{$value | printf "0x%X"}}
{{end}}`
func showVhdBAT(c *cli.Context) error {
vhdPath := c.String("path")
if vhdPath == "" {
return errors.New("Missing required argument --path")
}
startRange := uint32(0)
var err error
if c.IsSet("start-range") {
r, err := strconv.ParseUint(c.String("start-range"), 10, 32)
if err != nil {
return fmt.Errorf("invalid index value --start-range: %s", err)
}
startRange = uint32(r)
}
endRange := uint32(0)
if c.IsSet("end-range") {
r, err := strconv.ParseUint(c.String("end-range"), 10, 32)
if err != nil {
return fmt.Errorf("invalid index value --end-range: %s", err)
}
endRange = uint32(r)
}
vFileFactory := &vhdfile.FileFactory{}
vFile, err := vFileFactory.Create(vhdPath)
if err != nil {
return err
}
defer vFileFactory.Dispose(nil)
if vFile.GetDiskType() == footer.DiskTypeFixed {
return errors.New("Warn: Only expandable VHDs has Block Allocation Table, this is a fixed VHD")
}
maxEntries := vFile.BlockAllocationTable.BATEntriesCount
if !c.IsSet("end-range") {
endRange = maxEntries - 1
}
if startRange > maxEntries || endRange > maxEntries {
return fmt.Errorf("index out of boundary, this vhd BAT index range is [0, %d]", maxEntries)
}
if startRange > endRange {
return errors.New("invalid range --start-range > --end-range")
}
fMap := template.FuncMap{
"adj": func(i int) int {
return i + int(startRange)
},
}
t, _ := template.New("root").
Funcs(fMap).
Parse(batTempl)
if !c.IsSet("skip-empty") {
t.Execute(os.Stdout, vFile.BlockAllocationTable.BAT[startRange:endRange+1])
} else {
nonEmptyBATEntries := make(map[int]uint32)
for blockIndex := startRange; blockIndex <= endRange; blockIndex++ {
if vFile.BlockAllocationTable.HasData(blockIndex) {
nonEmptyBATEntries[int(blockIndex-startRange)] = vFile.BlockAllocationTable.BAT[blockIndex]
}
}
t.Execute(os.Stdout, nonEmptyBATEntries)
}
return nil
}
const fixedDiskBlockInfoTempl = `Block sector size : 512 bytes
Block size : {{.BlockSize}} bytes
Total blocks : {{.BlockCount}}
`
const expandableDiskBlockInfoTempl = `Block sector size : 512 bytes
Block data section size : {{.BlockDataSize}} bytes
Block bitmap section size : {{.BlockBitmapSize}} bytes
Block bitmap section size (padded) : {{.BlockBitmapPaddedSize}} bytes
Total blocks : {{.BlockCount}} (Used: {{.UsedBlockCount}} Empty: {{.EmptyBlockCount}})
`
func showVhdBlocksInfo(c *cli.Context) error {
vhdPath := c.String("path")
if vhdPath == "" {
return errors.New("Missing required argument --path")
}
vFileFactory := &vhdfile.FileFactory{}
vFile, err := vFileFactory.Create(vhdPath)
if err != nil {
panic(err)
}
defer vFileFactory.Dispose(nil)
vBlockFactory, err := vFile.GetBlockFactory()
if err != nil {
return err
}
if vFile.GetDiskType() == footer.DiskTypeFixed {
info := &FixedDiskBlocksInfo{
BlockSize: vBlockFactory.GetBlockSize(),
BlockCount: vBlockFactory.GetBlockCount(),
}
// Note: Identifying empty and used blocks of a FixedDisk requires reading each
// block and checking it contains all zeros, which is time consuming so we don't
// show those information.
t, err := template.New("root").
Parse(fixedDiskBlockInfoTempl)
if err != nil {
return err
}
t.Execute(os.Stdout, info)
} else {
info := &ExpandableDiskBlocksInfo{
BlockDataSize: vBlockFactory.GetBlockSize(),
BlockBitmapSize: vFile.BlockAllocationTable.GetBitmapSizeInBytes(),
BlockBitmapPaddedSize: vFile.BlockAllocationTable.GetSectorPaddedBitmapSizeInBytes(),
BlockCount: vBlockFactory.GetBlockCount(),
}
for _, v := range vFile.BlockAllocationTable.BAT {
if v == vhdcore.VhdNoDataInt {
info.EmptyBlockCount++
} else {
info.UsedBlockCount++
}
}
t, err := template.New("root").
Parse(expandableDiskBlockInfoTempl)
if err != nil {
return err
}
t.Execute(os.Stdout, info)
}
return nil
}
func showVhdBlockBitmap(c *cli.Context) error {
const bytesPerLine int32 = 8
const bitsPerLine int32 = 8 * bytesPerLine
vhdPath := c.String("path")
if vhdPath == "" {
return errors.New("missing required argument --path")
}
if !c.IsSet("block-index") {
return errors.New("missing required argument --block-index")
}
blockIndex := uint32(0)
id, err := strconv.ParseUint(c.String("block-index"), 10, 32)
if err != nil {
return fmt.Errorf("invalid index value --block-index: %s", err)
}
blockIndex = uint32(id)
vFileFactory := &vhdfile.FileFactory{}
vFile, err := vFileFactory.Create(vhdPath)
if err != nil {
return err
}
defer vFileFactory.Dispose(nil)
if vFile.GetDiskType() == footer.DiskTypeFixed {
return errors.New("warn: only expandable VHDs has bitmap associated with blocks, this is a fixed VHD")
}
vBlockFactory, err := vFile.GetBlockFactory()
if err != nil {
return err
}
if int64(blockIndex) > vBlockFactory.GetBlockCount()-1 {
return fmt.Errorf("warn: given block index %d is out of boundary, block index range is [0 : %d]", blockIndex, vBlockFactory.GetBlockCount()-1)
}
vBlock, err := vBlockFactory.Create(blockIndex)
if err != nil {
return err
}
if vBlock.IsEmpty {
fmt.Print("The block that this bitmap belongs to is marked as empty\n\n")
fmt.Print(createEmptyBitmapString(bytesPerLine, bitsPerLine, vFile.BlockAllocationTable.GetBitmapSizeInBytes()))
return nil
}
fmt.Print(createBitmapString(bitsPerLine, vBlock.BitMap))
return nil
}
func createEmptyBitmapString(bytesPerLine, bitsPerLine, bitmapSizeInBytes int32) string {
var buffer bytes.Buffer
line := ""
for i := int32(0); i < bytesPerLine; i++ {
line = line + " " + "00000000"
}
count := bitmapSizeInBytes / bytesPerLine
pad := len(strconv.FormatInt(int64(bitmapSizeInBytes*8), 10))
fmtLine := fmt.Sprintf("[%%-%dd - %%%dd]", pad, pad)
for i := int32(0); i < count; i++ {
buffer.WriteString(fmt.Sprintf(fmtLine, i*bitsPerLine, i*bitsPerLine+bitsPerLine-1))
buffer.WriteString(line)
buffer.WriteString("\n")
}
remaining := bitmapSizeInBytes % bytesPerLine
if remaining != 0 {
buffer.WriteString(fmt.Sprintf(fmtLine, count*bitsPerLine, count*bitsPerLine+8*remaining-1))
for i := int32(0); i < remaining; i++ {
buffer.WriteString(" 00000000")
}
}
buffer.WriteString("\n")
return buffer.String()
}
func createBitmapString(bitsPerLine int32, vBlockBitmap *bitmap.BitMap) string {
var buffer bytes.Buffer
pad := len(strconv.FormatInt(int64(vBlockBitmap.Length), 10))
fmtLine := fmt.Sprintf("[%%-%dd - %%%dd]", pad, pad)
for i := int32(0); i < vBlockBitmap.Length; {
if i%bitsPerLine == 0 {
if i < vBlockBitmap.Length-bitsPerLine {
buffer.WriteString(fmt.Sprintf(fmtLine, i, i+bitsPerLine-1))
} else {
buffer.WriteString(fmt.Sprintf(fmtLine, i, vBlockBitmap.Length-1))
}
}
b := byte(0)
for j := uint32(0); j < 8; j++ {
if dirty, _ := vBlockBitmap.Get(i); dirty {
b |= byte(1 << (7 - j))
}
i++
}
buffer.WriteByte(' ')
buffer.WriteString(fmt.Sprintf("%08b", b))
if i%bitsPerLine == 0 {
buffer.WriteString("\n")
}
}
buffer.WriteString("\n")
return buffer.String()
}