mirror of https://github.com/etcd-io/bbolt.git
Move page command to a separate file. It's already a huge file of tools.
Signed-off-by: Piotr Tabor <ptab@google.com>pull/359/head
Piotr Tabor
parent
bad964e850
commit
cc771afa1e
|
|
@ -604,252 +604,6 @@ page-item prints a page item key and value.
|
|||
`, "\n")
|
||||
}
|
||||
|
||||
// PageCommand represents the "page" command execution.
|
||||
type PageCommand struct {
|
||||
Stdin io.Reader
|
||||
Stdout io.Writer
|
||||
Stderr io.Writer
|
||||
}
|
||||
|
||||
// newPageCommand returns a PageCommand.
|
||||
func newPageCommand(m *Main) *PageCommand {
|
||||
return &PageCommand{
|
||||
Stdin: m.Stdin,
|
||||
Stdout: m.Stdout,
|
||||
Stderr: m.Stderr,
|
||||
}
|
||||
}
|
||||
|
||||
// Run executes the command.
|
||||
func (cmd *PageCommand) Run(args ...string) error {
|
||||
// Parse flags.
|
||||
fs := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
help := fs.Bool("h", false, "")
|
||||
if err := fs.Parse(args); err != nil {
|
||||
return err
|
||||
} else if *help {
|
||||
fmt.Fprintln(cmd.Stderr, cmd.Usage())
|
||||
return ErrUsage
|
||||
}
|
||||
|
||||
// Require database path and page id.
|
||||
path := fs.Arg(0)
|
||||
if path == "" {
|
||||
return ErrPathRequired
|
||||
} else if _, err := os.Stat(path); os.IsNotExist(err) {
|
||||
return ErrFileNotFound
|
||||
}
|
||||
|
||||
// Read page ids.
|
||||
pageIDs, err := stringToPages(fs.Args()[1:])
|
||||
if err != nil {
|
||||
return err
|
||||
} else if len(pageIDs) == 0 {
|
||||
return ErrPageIDRequired
|
||||
}
|
||||
|
||||
// Open database file handler.
|
||||
f, err := os.Open(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer func() { _ = f.Close() }()
|
||||
|
||||
// Print each page listed.
|
||||
for i, pageID := range pageIDs {
|
||||
// Print a separator.
|
||||
if i > 0 {
|
||||
fmt.Fprintln(cmd.Stdout, "===============================================")
|
||||
}
|
||||
|
||||
// Retrieve page info and page size.
|
||||
p, buf, err := ReadPage(path, pageID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Print basic page info.
|
||||
fmt.Fprintf(cmd.Stdout, "Page ID: %d\n", p.id)
|
||||
fmt.Fprintf(cmd.Stdout, "Page Type: %s\n", p.Type())
|
||||
fmt.Fprintf(cmd.Stdout, "Total Size: %d bytes\n", len(buf))
|
||||
|
||||
// Print type-specific data.
|
||||
switch p.Type() {
|
||||
case "meta":
|
||||
err = cmd.PrintMeta(cmd.Stdout, buf)
|
||||
case "leaf":
|
||||
err = cmd.PrintLeaf(cmd.Stdout, buf)
|
||||
case "branch":
|
||||
err = cmd.PrintBranch(cmd.Stdout, buf)
|
||||
case "freelist":
|
||||
err = cmd.PrintFreelist(cmd.Stdout, buf)
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrintMeta prints the data from the meta page.
|
||||
func (cmd *PageCommand) PrintMeta(w io.Writer, buf []byte) error {
|
||||
m := (*meta)(unsafe.Pointer(&buf[PageHeaderSize]))
|
||||
fmt.Fprintf(w, "Version: %d\n", m.version)
|
||||
fmt.Fprintf(w, "Page Size: %d bytes\n", m.pageSize)
|
||||
fmt.Fprintf(w, "Flags: %08x\n", m.flags)
|
||||
fmt.Fprintf(w, "Root: <pgid=%d>\n", m.root.root)
|
||||
fmt.Fprintf(w, "Freelist: <pgid=%d>\n", m.freelist)
|
||||
fmt.Fprintf(w, "HWM: <pgid=%d>\n", m.pgid)
|
||||
fmt.Fprintf(w, "Txn ID: %d\n", m.txid)
|
||||
fmt.Fprintf(w, "Checksum: %016x\n", m.checksum)
|
||||
fmt.Fprintf(w, "\n")
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrintLeaf prints the data for a leaf page.
|
||||
func (cmd *PageCommand) PrintLeaf(w io.Writer, buf []byte) error {
|
||||
p := (*page)(unsafe.Pointer(&buf[0]))
|
||||
|
||||
// Print number of items.
|
||||
fmt.Fprintf(w, "Item Count: %d\n", p.count)
|
||||
fmt.Fprintf(w, "\n")
|
||||
|
||||
// Print each key/value.
|
||||
for i := uint16(0); i < p.count; i++ {
|
||||
e := p.leafPageElement(i)
|
||||
|
||||
// Format key as string.
|
||||
var k string
|
||||
if isPrintable(string(e.key())) {
|
||||
k = fmt.Sprintf("%q", string(e.key()))
|
||||
} else {
|
||||
k = fmt.Sprintf("%x", string(e.key()))
|
||||
}
|
||||
|
||||
// Format value as string.
|
||||
var v string
|
||||
if (e.flags & uint32(bucketLeafFlag)) != 0 {
|
||||
b := (*bucket)(unsafe.Pointer(&e.value()[0]))
|
||||
v = fmt.Sprintf("<pgid=%d,seq=%d>", b.root, b.sequence)
|
||||
} else if isPrintable(string(e.value())) {
|
||||
v = fmt.Sprintf("%q", string(e.value()))
|
||||
} else {
|
||||
v = fmt.Sprintf("%x", string(e.value()))
|
||||
}
|
||||
|
||||
fmt.Fprintf(w, "%s: %s\n", k, v)
|
||||
}
|
||||
fmt.Fprintf(w, "\n")
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrintBranch prints the data for a leaf page.
|
||||
func (cmd *PageCommand) PrintBranch(w io.Writer, buf []byte) error {
|
||||
p := (*page)(unsafe.Pointer(&buf[0]))
|
||||
|
||||
// Print number of items.
|
||||
fmt.Fprintf(w, "Item Count: %d\n", p.count)
|
||||
fmt.Fprintf(w, "\n")
|
||||
|
||||
// Print each key/value.
|
||||
for i := uint16(0); i < p.count; i++ {
|
||||
e := p.branchPageElement(i)
|
||||
|
||||
// Format key as string.
|
||||
var k string
|
||||
if isPrintable(string(e.key())) {
|
||||
k = fmt.Sprintf("%q", string(e.key()))
|
||||
} else {
|
||||
k = fmt.Sprintf("%x", string(e.key()))
|
||||
}
|
||||
|
||||
fmt.Fprintf(w, "%s: <pgid=%d>\n", k, e.pgid)
|
||||
}
|
||||
fmt.Fprintf(w, "\n")
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrintFreelist prints the data for a freelist page.
|
||||
func (cmd *PageCommand) PrintFreelist(w io.Writer, buf []byte) error {
|
||||
p := (*page)(unsafe.Pointer(&buf[0]))
|
||||
|
||||
// Check for overflow and, if present, adjust starting index and actual element count.
|
||||
idx, count := 0, int(p.count)
|
||||
if p.count == 0xFFFF {
|
||||
idx = 1
|
||||
count = int(((*[maxAllocSize]pgid)(unsafe.Pointer(&p.ptr)))[0])
|
||||
}
|
||||
|
||||
// Print number of items.
|
||||
fmt.Fprintf(w, "Item Count: %d\n", count)
|
||||
fmt.Fprintf(w, "Overflow: %d\n", p.overflow)
|
||||
|
||||
fmt.Fprintf(w, "\n")
|
||||
|
||||
// Print each page in the freelist.
|
||||
ids := (*[maxAllocSize]pgid)(unsafe.Pointer(&p.ptr))
|
||||
for i := idx; i < count; i++ {
|
||||
fmt.Fprintf(w, "%d\n", ids[i])
|
||||
}
|
||||
fmt.Fprintf(w, "\n")
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrintPage prints a given page as hexadecimal.
|
||||
func (cmd *PageCommand) PrintPage(w io.Writer, r io.ReaderAt, pageID int, pageSize int) error {
|
||||
const bytesPerLineN = 16
|
||||
|
||||
// Read page into buffer.
|
||||
buf := make([]byte, pageSize)
|
||||
addr := pageID * pageSize
|
||||
if n, err := r.ReadAt(buf, int64(addr)); err != nil {
|
||||
return err
|
||||
} else if n != pageSize {
|
||||
return io.ErrUnexpectedEOF
|
||||
}
|
||||
|
||||
// Write out to writer in 16-byte lines.
|
||||
var prev []byte
|
||||
var skipped bool
|
||||
for offset := 0; offset < pageSize; offset += bytesPerLineN {
|
||||
// Retrieve current 16-byte line.
|
||||
line := buf[offset : offset+bytesPerLineN]
|
||||
isLastLine := (offset == (pageSize - bytesPerLineN))
|
||||
|
||||
// If it's the same as the previous line then print a skip.
|
||||
if bytes.Equal(line, prev) && !isLastLine {
|
||||
if !skipped {
|
||||
fmt.Fprintf(w, "%07x *\n", addr+offset)
|
||||
skipped = true
|
||||
}
|
||||
} else {
|
||||
// Print line as hexadecimal in 2-byte groups.
|
||||
fmt.Fprintf(w, "%07x %04x %04x %04x %04x %04x %04x %04x %04x\n", addr+offset,
|
||||
line[0:2], line[2:4], line[4:6], line[6:8],
|
||||
line[8:10], line[10:12], line[12:14], line[14:16],
|
||||
)
|
||||
|
||||
skipped = false
|
||||
}
|
||||
|
||||
// Save the previous line.
|
||||
prev = line
|
||||
}
|
||||
fmt.Fprint(w, "\n")
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Usage returns the help message.
|
||||
func (cmd *PageCommand) Usage() string {
|
||||
return strings.TrimLeft(`
|
||||
usage: bolt page PATH pageid [pageid...]
|
||||
|
||||
Page prints one or more pages in human readable format.
|
||||
`, "\n")
|
||||
}
|
||||
|
||||
// PagesCommand represents the "pages" command execution.
|
||||
type PagesCommand struct {
|
||||
Stdin io.Reader
|
||||
|
|
|
|||
|
|
@ -0,0 +1,257 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"flag"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"strings"
|
||||
"unsafe"
|
||||
)
|
||||
|
||||
// PageCommand represents the "page" command execution.
|
||||
type PageCommand struct {
|
||||
Stdin io.Reader
|
||||
Stdout io.Writer
|
||||
Stderr io.Writer
|
||||
}
|
||||
|
||||
// newPageCommand returns a PageCommand.
|
||||
func newPageCommand(m *Main) *PageCommand {
|
||||
return &PageCommand{
|
||||
Stdin: m.Stdin,
|
||||
Stdout: m.Stdout,
|
||||
Stderr: m.Stderr,
|
||||
}
|
||||
}
|
||||
|
||||
// Run executes the command.
|
||||
func (cmd *PageCommand) Run(args ...string) error {
|
||||
// Parse flags.
|
||||
fs := flag.NewFlagSet("", flag.ContinueOnError)
|
||||
help := fs.Bool("h", false, "")
|
||||
if err := fs.Parse(args); err != nil {
|
||||
return err
|
||||
} else if *help {
|
||||
fmt.Fprintln(cmd.Stderr, cmd.Usage())
|
||||
return ErrUsage
|
||||
}
|
||||
|
||||
// Require database path and page id.
|
||||
path := fs.Arg(0)
|
||||
if path == "" {
|
||||
return ErrPathRequired
|
||||
} else if _, err := os.Stat(path); os.IsNotExist(err) {
|
||||
return ErrFileNotFound
|
||||
}
|
||||
|
||||
// Read page ids.
|
||||
pageIDs, err := stringToPages(fs.Args()[1:])
|
||||
if err != nil {
|
||||
return err
|
||||
} else if len(pageIDs) == 0 {
|
||||
return ErrPageIDRequired
|
||||
}
|
||||
|
||||
// Open database file handler.
|
||||
f, err := os.Open(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer func() { _ = f.Close() }()
|
||||
|
||||
// Print each page listed.
|
||||
for i, pageID := range pageIDs {
|
||||
// Print a separator.
|
||||
if i > 0 {
|
||||
fmt.Fprintln(cmd.Stdout, "===============================================")
|
||||
}
|
||||
|
||||
// Retrieve page info and page size.
|
||||
p, buf, err := ReadPage(path, pageID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Print basic page info.
|
||||
fmt.Fprintf(cmd.Stdout, "Page ID: %d\n", p.id)
|
||||
fmt.Fprintf(cmd.Stdout, "Page Type: %s\n", p.Type())
|
||||
fmt.Fprintf(cmd.Stdout, "Total Size: %d bytes\n", len(buf))
|
||||
|
||||
// Print type-specific data.
|
||||
switch p.Type() {
|
||||
case "meta":
|
||||
err = cmd.PrintMeta(cmd.Stdout, buf)
|
||||
case "leaf":
|
||||
err = cmd.PrintLeaf(cmd.Stdout, buf)
|
||||
case "branch":
|
||||
err = cmd.PrintBranch(cmd.Stdout, buf)
|
||||
case "freelist":
|
||||
err = cmd.PrintFreelist(cmd.Stdout, buf)
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrintMeta prints the data from the meta page.
|
||||
func (cmd *PageCommand) PrintMeta(w io.Writer, buf []byte) error {
|
||||
m := (*meta)(unsafe.Pointer(&buf[PageHeaderSize]))
|
||||
fmt.Fprintf(w, "Version: %d\n", m.version)
|
||||
fmt.Fprintf(w, "Page Size: %d bytes\n", m.pageSize)
|
||||
fmt.Fprintf(w, "Flags: %08x\n", m.flags)
|
||||
fmt.Fprintf(w, "Root: <pgid=%d>\n", m.root.root)
|
||||
fmt.Fprintf(w, "Freelist: <pgid=%d>\n", m.freelist)
|
||||
fmt.Fprintf(w, "HWM: <pgid=%d>\n", m.pgid)
|
||||
fmt.Fprintf(w, "Txn ID: %d\n", m.txid)
|
||||
fmt.Fprintf(w, "Checksum: %016x\n", m.checksum)
|
||||
fmt.Fprintf(w, "\n")
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrintLeaf prints the data for a leaf page.
|
||||
func (cmd *PageCommand) PrintLeaf(w io.Writer, buf []byte) error {
|
||||
p := (*page)(unsafe.Pointer(&buf[0]))
|
||||
|
||||
// Print number of items.
|
||||
fmt.Fprintf(w, "Item Count: %d\n", p.count)
|
||||
fmt.Fprintf(w, "\n")
|
||||
|
||||
// Print each key/value.
|
||||
for i := uint16(0); i < p.count; i++ {
|
||||
e := p.leafPageElement(i)
|
||||
|
||||
// Format key as string.
|
||||
var k string
|
||||
if isPrintable(string(e.key())) {
|
||||
k = fmt.Sprintf("%q", string(e.key()))
|
||||
} else {
|
||||
k = fmt.Sprintf("%x", string(e.key()))
|
||||
}
|
||||
|
||||
// Format value as string.
|
||||
var v string
|
||||
if (e.flags & uint32(bucketLeafFlag)) != 0 {
|
||||
b := (*bucket)(unsafe.Pointer(&e.value()[0]))
|
||||
v = fmt.Sprintf("<pgid=%d,seq=%d>", b.root, b.sequence)
|
||||
} else if isPrintable(string(e.value())) {
|
||||
v = fmt.Sprintf("%q", string(e.value()))
|
||||
} else {
|
||||
v = fmt.Sprintf("%x", string(e.value()))
|
||||
}
|
||||
|
||||
fmt.Fprintf(w, "%s: %s\n", k, v)
|
||||
}
|
||||
fmt.Fprintf(w, "\n")
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrintBranch prints the data for a leaf page.
|
||||
func (cmd *PageCommand) PrintBranch(w io.Writer, buf []byte) error {
|
||||
p := (*page)(unsafe.Pointer(&buf[0]))
|
||||
|
||||
// Print number of items.
|
||||
fmt.Fprintf(w, "Item Count: %d\n", p.count)
|
||||
fmt.Fprintf(w, "\n")
|
||||
|
||||
// Print each key/value.
|
||||
for i := uint16(0); i < p.count; i++ {
|
||||
e := p.branchPageElement(i)
|
||||
|
||||
// Format key as string.
|
||||
var k string
|
||||
if isPrintable(string(e.key())) {
|
||||
k = fmt.Sprintf("%q", string(e.key()))
|
||||
} else {
|
||||
k = fmt.Sprintf("%x", string(e.key()))
|
||||
}
|
||||
|
||||
fmt.Fprintf(w, "%s: <pgid=%d>\n", k, e.pgid)
|
||||
}
|
||||
fmt.Fprintf(w, "\n")
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrintFreelist prints the data for a freelist page.
|
||||
func (cmd *PageCommand) PrintFreelist(w io.Writer, buf []byte) error {
|
||||
p := (*page)(unsafe.Pointer(&buf[0]))
|
||||
|
||||
// Check for overflow and, if present, adjust starting index and actual element count.
|
||||
idx, count := 0, int(p.count)
|
||||
if p.count == 0xFFFF {
|
||||
idx = 1
|
||||
count = int(((*[maxAllocSize]pgid)(unsafe.Pointer(&p.ptr)))[0])
|
||||
}
|
||||
|
||||
// Print number of items.
|
||||
fmt.Fprintf(w, "Item Count: %d\n", count)
|
||||
fmt.Fprintf(w, "Overflow: %d\n", p.overflow)
|
||||
|
||||
fmt.Fprintf(w, "\n")
|
||||
|
||||
// Print each page in the freelist.
|
||||
ids := (*[maxAllocSize]pgid)(unsafe.Pointer(&p.ptr))
|
||||
for i := idx; i < count; i++ {
|
||||
fmt.Fprintf(w, "%d\n", ids[i])
|
||||
}
|
||||
fmt.Fprintf(w, "\n")
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrintPage prints a given page as hexadecimal.
|
||||
func (cmd *PageCommand) PrintPage(w io.Writer, r io.ReaderAt, pageID int, pageSize int) error {
|
||||
const bytesPerLineN = 16
|
||||
|
||||
// Read page into buffer.
|
||||
buf := make([]byte, pageSize)
|
||||
addr := pageID * pageSize
|
||||
if n, err := r.ReadAt(buf, int64(addr)); err != nil {
|
||||
return err
|
||||
} else if n != pageSize {
|
||||
return io.ErrUnexpectedEOF
|
||||
}
|
||||
|
||||
// Write out to writer in 16-byte lines.
|
||||
var prev []byte
|
||||
var skipped bool
|
||||
for offset := 0; offset < pageSize; offset += bytesPerLineN {
|
||||
// Retrieve current 16-byte line.
|
||||
line := buf[offset : offset+bytesPerLineN]
|
||||
isLastLine := (offset == (pageSize - bytesPerLineN))
|
||||
|
||||
// If it's the same as the previous line then print a skip.
|
||||
if bytes.Equal(line, prev) && !isLastLine {
|
||||
if !skipped {
|
||||
fmt.Fprintf(w, "%07x *\n", addr+offset)
|
||||
skipped = true
|
||||
}
|
||||
} else {
|
||||
// Print line as hexadecimal in 2-byte groups.
|
||||
fmt.Fprintf(w, "%07x %04x %04x %04x %04x %04x %04x %04x %04x\n", addr+offset,
|
||||
line[0:2], line[2:4], line[4:6], line[6:8],
|
||||
line[8:10], line[10:12], line[12:14], line[14:16],
|
||||
)
|
||||
|
||||
skipped = false
|
||||
}
|
||||
|
||||
// Save the previous line.
|
||||
prev = line
|
||||
}
|
||||
fmt.Fprint(w, "\n")
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Usage returns the help message.
|
||||
func (cmd *PageCommand) Usage() string {
|
||||
return strings.TrimLeft(`
|
||||
usage: bolt page PATH pageid [pageid...]
|
||||
|
||||
Page prints one or more pages in human readable format.
|
||||
`, "\n")
|
||||
}
|
||||
Loading…
Reference in New Issue