Commit 11ee44e0 authored by Kirill Smelkov's avatar Kirill Smelkov

go/zodb/fs1tools: Reindex, Verify-index

Add commands for FileStorage index maintainance: manually rebuild the
index and to performe index verification.
parent 9de107fe
// Copyright (C) 2017 Nexedi SA and Contributors.
// Kirill Smelkov <kirr@nexedi.com>
//
// This program is free software: you can Use, Study, Modify and Redistribute
// it under the terms of the GNU General Public License version 3, or (at your
// option) any later version, as published by the Free Software Foundation.
//
// You can also Link and Combine this program with other software covered by
// the terms of any of the Free Software licenses or any of the Open Source
// Initiative approved licenses and Convey the resulting work. Corresponding
// source of such a combination shall include the source code for all other
// software used.
//
// This program is distributed WITHOUT ANY WARRANTY; without even the implied
// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//
// See COPYING file for full licensing terms.
// See https://www.nexedi.com/licensing for rationale and options.
package fs1tools
import (
"context"
"flag"
"fmt"
"io"
"os"
"time"
"lab.nexedi.com/kirr/go123/prog"
"lab.nexedi.com/kirr/neo/go/zodb/storage/fs1"
)
// Reindex rebuilds index for FileStorage file @ path
func Reindex(ctx context.Context, path string, progress func(*fs1.IndexUpdateProgress)) error {
// XXX lock path.lock ?
index, err := fs1.BuildIndexForFile(ctx, path, progress)
if err != nil {
return err
}
err = index.SaveFile(path + ".index") // XXX show progress during SaveFile?
if err != nil {
return err
}
return nil
}
const reindexSummary = "rebuild database index"
func reindexUsage(w io.Writer) {
fmt.Fprintf(w,
`Usage: fs1 reindex [options] <storage>
Rebuild FileStorage index
<storage> is a path to FileStorage
options:
-quiet do not show intermediate progress.
-h --help this help text.
`)
}
func reindexMain(argv []string) {
quiet := false
flags := flag.FlagSet{Usage: func() { reindexUsage(os.Stderr) }}
flags.Init("", flag.ExitOnError)
flags.BoolVar(&quiet, "quiet", quiet, "do not show intermediate progress")
flags.Parse(argv[1:])
argv = flags.Args()
if len(argv) < 1 {
flags.Usage()
prog.Exit(2)
}
storPath := argv[0]
fi, err := os.Stat(storPath)
if err != nil {
prog.Fatal(err)
}
// progress display
display := func(p *fs1.IndexUpdateProgress) {
topPos := p.TopPos
if topPos == -1 {
topPos = fi.Size()
}
fmt.Printf("\rIndexed data bytes: %.1f%% (%d/%d); #txn: %d, #oid: %d",
100 * float64(p.Index.TopPos) / float64(topPos),
p.Index.TopPos, topPos,
p.TxnIndexed, p.Index.Len())
}
// display updates once per tick
tick := time.NewTicker(time.Second / 4)
defer tick.Stop()
var lastp *fs1.IndexUpdateProgress
progress := func(p *fs1.IndexUpdateProgress) {
lastp = p
select {
case <- tick.C:
default:
return
}
display(p)
}
if quiet {
progress = nil
}
err = Reindex(context.Background(), storPath, progress)
if !quiet && lastp != nil {
// (re-)display last update in case no progress was displayed so far
display(lastp)
fmt.Println()
}
if err != nil {
prog.Fatal(err)
}
if !quiet {
fmt.Println("done")
}
}
// ----------------------------------------
// VerifyIndexFor verifies that on-disk index for FileStorage file @ path is correct
func VerifyIndexFor(ctx context.Context, path string, ntxn int, progress func(*fs1.IndexVerifyProgress)) (err error) {
// XXX lock path.lock ?
index, err := fs1.LoadIndexFile(path + ".index")
if err != nil {
return err
}
_, err = index.VerifyForFile(context.Background(), path, ntxn, progress)
return err
}
const verifyIdxSummary = "verify database index"
func verifyIdxUsage(w io.Writer) {
fmt.Fprintf(w,
`Usage: fs1 verify-index [options] <storage>
Verify FileStorage index
<storage> is a path to FileStorage
options:
-checkonly <n> only check consistency by verifying against <n>
last transactions.
-quiet do not show intermediate progress.
-h --help this help text.
`)
}
func verifyIdxMain(argv []string) {
ntxn := -1
quiet := false
flags := flag.FlagSet{Usage: func() { verifyIdxUsage(os.Stderr) }}
flags.Init("", flag.ExitOnError)
flags.IntVar(&ntxn, "checkonly", ntxn, "check consistency only wrt last <n> transactions")
flags.BoolVar(&quiet, "quiet", quiet, "do not show intermediate progress")
flags.Parse(argv[1:])
argv = flags.Args()
if len(argv) < 1 {
flags.Usage()
prog.Exit(2)
}
storPath := argv[0]
// progress display
display := func(p *fs1.IndexVerifyProgress) {
if p.TxnTotal == -1 {
bytesChecked := p.Index.TopPos - p.Iter.Txnh.Pos
bytesAll := p.Index.TopPos
fmt.Printf("\rChecked data bytes: %.1f%% (%d/%d); #txn: %d, #oid: %d",
100 * float64(bytesChecked) / float64(bytesAll),
bytesChecked, bytesAll,
p.TxnChecked, len(p.OidChecked))
} else {
fmt.Printf("\rChecked data transactions: %.1f%% (%d/%d); #oid: %d",
100 * float64(p.TxnChecked) / float64(p.TxnTotal),
p.TxnChecked, p.TxnTotal, len(p.OidChecked))
}
}
// display updates once per tick
tick := time.NewTicker(time.Second / 4)
defer tick.Stop()
var lastp *fs1.IndexVerifyProgress
progress := func(p *fs1.IndexVerifyProgress) {
lastp = p
select {
case <- tick.C:
default:
return
}
display(p)
}
if quiet {
progress = nil
}
err := VerifyIndexFor(context.Background(), storPath, ntxn, progress)
if !quiet && lastp != nil {
// (re-)display last update in case no progress was displayed so far
display(lastp)
fmt.Println()
}
if err != nil {
prog.Fatal(err)
}
if !quiet {
fmt.Println("OK")
}
}
......@@ -25,6 +25,9 @@ import "lab.nexedi.com/kirr/go123/prog"
var commands = prog.CommandRegistry{
{"dump", dumpSummary, dumpUsage, dumpMain},
{"tail", tailSummary, tailUsage, tailMain},
{"reindex", reindexSummary, reindexUsage, reindexMain},
{"verify-index", verifyIdxSummary, verifyIdxUsage, verifyIdxMain},
}
var helpTopics = prog.HelpRegistry{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment