This repository has been archived by the owner on Apr 15, 2024. It is now read-only.
forked from cockroachdb/pebble
-
Notifications
You must be signed in to change notification settings - Fork 0
/
manifest.go
575 lines (531 loc) · 16.2 KB
/
manifest.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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
// Copyright 2019 The LevelDB-Go and Pebble Authors. All rights reserved. Use
// of this source code is governed by a BSD-style license that can be found in
// the LICENSE file.
package tool
import (
"fmt"
"io"
"sort"
"time"
"github.com/patrick-ogrady/pebble"
"github.com/patrick-ogrady/pebble/internal/base"
"github.com/patrick-ogrady/pebble/internal/humanize"
"github.com/patrick-ogrady/pebble/internal/manifest"
"github.com/patrick-ogrady/pebble/record"
"github.com/patrick-ogrady/pebble/sstable"
"github.com/spf13/cobra"
)
// manifestT implements manifest-level tools, including both configuration
// state and the commands themselves.
type manifestT struct {
Root *cobra.Command
Dump *cobra.Command
Summarize *cobra.Command
Check *cobra.Command
opts *pebble.Options
comparers sstable.Comparers
fmtKey keyFormatter
verbose bool
filterStart key
filterEnd key
summarizeDur time.Duration
}
func newManifest(opts *pebble.Options, comparers sstable.Comparers) *manifestT {
m := &manifestT{
opts: opts,
comparers: comparers,
summarizeDur: time.Hour,
}
m.fmtKey.mustSet("quoted")
m.Root = &cobra.Command{
Use: "manifest",
Short: "manifest introspection tools",
}
// Add dump command
m.Dump = &cobra.Command{
Use: "dump <manifest-files>",
Short: "print manifest contents",
Long: `
Print the contents of the MANIFEST files.
`,
Args: cobra.MinimumNArgs(1),
Run: m.runDump,
}
m.Dump.Flags().Var(&m.fmtKey, "key", "key formatter")
m.Dump.Flags().Var(&m.filterStart, "filter-start", "start key filters out all version edits that only reference sstables containing keys strictly before the given key")
m.Dump.Flags().Var(&m.filterEnd, "filter-end", "end key filters out all version edits that only reference sstables containing keys at or strictly after the given key")
m.Root.AddCommand(m.Dump)
m.Root.PersistentFlags().BoolVarP(&m.verbose, "verbose", "v", false, "verbose output")
// Add summarize command
m.Summarize = &cobra.Command{
Use: "summarize <manifest-files>",
Short: "summarize manifest contents",
Long: `
Summarize the edits to the MANIFEST files over time.
`,
Args: cobra.MinimumNArgs(1),
Run: m.runSummarize,
}
m.Root.AddCommand(m.Summarize)
m.Summarize.Flags().DurationVar(
&m.summarizeDur, "dur", time.Hour, "bucket duration as a Go duration string (eg, '1h', '15m')")
// Add check command
m.Check = &cobra.Command{
Use: "check <manifest-files>",
Short: "check manifest contents",
Long: `
Check the contents of the MANIFEST files.
`,
Args: cobra.MinimumNArgs(1),
Run: m.runCheck,
}
m.Root.AddCommand(m.Check)
m.Check.Flags().Var(
&m.fmtKey, "key", "key formatter")
return m
}
func (m *manifestT) printLevels(cmp base.Compare, stdout io.Writer, v *manifest.Version) {
for level := range v.Levels {
if level == 0 && len(v.L0SublevelFiles) > 0 && !v.Levels[level].Empty() {
for sublevel := len(v.L0SublevelFiles) - 1; sublevel >= 0; sublevel-- {
fmt.Fprintf(stdout, "--- L0.%d ---\n", sublevel)
v.L0SublevelFiles[sublevel].Each(func(f *manifest.FileMetadata) {
if !anyOverlapFile(cmp, f, m.filterStart, m.filterEnd) {
return
}
fmt.Fprintf(stdout, " %s:%d", f.FileNum, f.Size)
formatSeqNumRange(stdout, f.SmallestSeqNum, f.LargestSeqNum)
formatKeyRange(stdout, m.fmtKey, &f.Smallest, &f.Largest)
fmt.Fprintf(stdout, "\n")
})
}
continue
}
fmt.Fprintf(stdout, "--- L%d ---\n", level)
iter := v.Levels[level].Iter()
for f := iter.First(); f != nil; f = iter.Next() {
if !anyOverlapFile(cmp, f, m.filterStart, m.filterEnd) {
continue
}
fmt.Fprintf(stdout, " %s:%d", f.FileNum, f.Size)
formatSeqNumRange(stdout, f.SmallestSeqNum, f.LargestSeqNum)
formatKeyRange(stdout, m.fmtKey, &f.Smallest, &f.Largest)
fmt.Fprintf(stdout, "\n")
}
}
}
func (m *manifestT) runDump(cmd *cobra.Command, args []string) {
stdout, stderr := cmd.OutOrStdout(), cmd.OutOrStderr()
for _, arg := range args {
func() {
f, err := m.opts.FS.Open(arg)
if err != nil {
fmt.Fprintf(stderr, "%s\n", err)
return
}
defer f.Close()
fmt.Fprintf(stdout, "%s\n", arg)
var bve manifest.BulkVersionEdit
bve.AddedByFileNum = make(map[base.FileNum]*manifest.FileMetadata)
var cmp *base.Comparer
var editIdx int
rr := record.NewReader(f, 0 /* logNum */)
for {
offset := rr.Offset()
r, err := rr.Next()
if err != nil {
fmt.Fprintf(stdout, "%s\n", err)
break
}
var ve manifest.VersionEdit
err = ve.Decode(r)
if err != nil {
fmt.Fprintf(stdout, "%s\n", err)
break
}
if err := bve.Accumulate(&ve); err != nil {
fmt.Fprintf(stdout, "%s\n", err)
break
}
if cmp != nil && !anyOverlap(cmp.Compare, &ve, m.filterStart, m.filterEnd) {
continue
}
empty := true
fmt.Fprintf(stdout, "%d/%d\n", offset, editIdx)
if ve.ComparerName != "" {
empty = false
fmt.Fprintf(stdout, " comparer: %s", ve.ComparerName)
cmp = m.comparers[ve.ComparerName]
if cmp == nil {
fmt.Fprintf(stdout, " (unknown)")
}
fmt.Fprintf(stdout, "\n")
m.fmtKey.setForComparer(ve.ComparerName, m.comparers)
}
if ve.MinUnflushedLogNum != 0 {
empty = false
fmt.Fprintf(stdout, " log-num: %d\n", ve.MinUnflushedLogNum)
}
if ve.ObsoletePrevLogNum != 0 {
empty = false
fmt.Fprintf(stdout, " prev-log-num: %d\n", ve.ObsoletePrevLogNum)
}
if ve.NextFileNum != 0 {
empty = false
fmt.Fprintf(stdout, " next-file-num: %d\n", ve.NextFileNum)
}
if ve.LastSeqNum != 0 {
empty = false
fmt.Fprintf(stdout, " last-seq-num: %d\n", ve.LastSeqNum)
}
entries := make([]manifest.DeletedFileEntry, 0, len(ve.DeletedFiles))
for df := range ve.DeletedFiles {
empty = false
entries = append(entries, df)
}
sort.Slice(entries, func(i, j int) bool {
if entries[i].Level != entries[j].Level {
return entries[i].Level < entries[j].Level
}
return entries[i].FileNum < entries[j].FileNum
})
for _, df := range entries {
fmt.Fprintf(stdout, " deleted: L%d %s\n", df.Level, df.FileNum)
}
for _, nf := range ve.NewFiles {
empty = false
fmt.Fprintf(stdout, " added: L%d %s:%d",
nf.Level, nf.Meta.FileNum, nf.Meta.Size)
formatSeqNumRange(stdout, nf.Meta.SmallestSeqNum, nf.Meta.LargestSeqNum)
formatKeyRange(stdout, m.fmtKey, &nf.Meta.Smallest, &nf.Meta.Largest)
if nf.Meta.CreationTime != 0 {
fmt.Fprintf(stdout, " (%s)",
time.Unix(nf.Meta.CreationTime, 0).UTC().Format(time.RFC3339))
}
fmt.Fprintf(stdout, "\n")
}
if empty {
// NB: An empty version edit can happen if we log a version edit with
// a zero field. RocksDB does this with a version edit that contains
// `LogNum == 0`.
fmt.Fprintf(stdout, " <empty>\n")
}
editIdx++
}
if cmp != nil {
v, err := bve.Apply(
nil /* version */, cmp.Compare, m.fmtKey.fn, 0,
m.opts.Experimental.ReadCompactionRate,
nil /* zombies */, manifest.AllowSplitUserKeys,
)
if err != nil {
fmt.Fprintf(stdout, "%s\n", err)
return
}
m.printLevels(cmp.Compare, stdout, v)
}
}()
}
}
func anyOverlap(cmp base.Compare, ve *manifest.VersionEdit, start, end key) bool {
if start == nil && end == nil {
return true
}
for _, df := range ve.DeletedFiles {
if anyOverlapFile(cmp, df, start, end) {
return true
}
}
for _, nf := range ve.NewFiles {
if anyOverlapFile(cmp, nf.Meta, start, end) {
return true
}
}
return false
}
func anyOverlapFile(cmp base.Compare, f *manifest.FileMetadata, start, end key) bool {
if f == nil {
return true
}
if start != nil {
if v := cmp(f.Largest.UserKey, start); v < 0 {
return false
} else if f.Largest.IsExclusiveSentinel() && v == 0 {
return false
}
}
if end != nil && cmp(f.Smallest.UserKey, end) >= 0 {
return false
}
return true
}
func (m *manifestT) runSummarize(cmd *cobra.Command, args []string) {
for _, arg := range args {
err := m.runSummarizeOne(cmd.OutOrStdout(), arg)
if err != nil {
fmt.Fprintf(cmd.OutOrStderr(), "%s\n", err)
}
}
}
func (m *manifestT) runSummarizeOne(stdout io.Writer, arg string) error {
f, err := m.opts.FS.Open(arg)
if err != nil {
return err
}
defer f.Close()
fmt.Fprintf(stdout, "%s\n", arg)
type summaryBucket struct {
bytesAdded [manifest.NumLevels]uint64
bytesCompactOut [manifest.NumLevels]uint64
}
var (
bve manifest.BulkVersionEdit
newestOverall time.Time
oldestOverall time.Time // oldest after initial version edit
buckets = map[time.Time]*summaryBucket{}
metadatas = map[base.FileNum]*manifest.FileMetadata{}
)
bve.AddedByFileNum = make(map[base.FileNum]*manifest.FileMetadata)
rr := record.NewReader(f, 0 /* logNum */)
for i := 0; ; i++ {
r, err := rr.Next()
if err == io.EOF {
break
} else if err != nil {
return err
}
var ve manifest.VersionEdit
err = ve.Decode(r)
if err != nil {
return err
}
if err := bve.Accumulate(&ve); err != nil {
return err
}
veNewest, veOldest := newestOverall, newestOverall
for _, nf := range ve.NewFiles {
_, seen := metadatas[nf.Meta.FileNum]
metadatas[nf.Meta.FileNum] = nf.Meta
if nf.Meta.CreationTime == 0 {
continue
}
t := time.Unix(nf.Meta.CreationTime, 0).UTC()
if veNewest.Before(t) {
veNewest = t
}
// Only update the oldest if we haven't already seen this
// file; it might've been moved in which case the sstable's
// creation time is from when it was originally created.
if veOldest.After(t) && !seen {
veOldest = t
}
}
// Ratchet up the most recent timestamp we've seen.
if newestOverall.Before(veNewest) {
newestOverall = veNewest
}
if i == 0 || newestOverall.IsZero() {
continue
}
// Update oldestOverall once, when we encounter the first version edit
// at index >= 1. It should be approximately the start time of the
// manifest.
if !newestOverall.IsZero() && oldestOverall.IsZero() {
oldestOverall = newestOverall
}
bucketKey := newestOverall.Truncate(m.summarizeDur)
b := buckets[bucketKey]
if b == nil {
b = &summaryBucket{}
buckets[bucketKey] = b
}
// Increase `bytesAdded` for any version edits that only add files.
// These are either flushes or ingests.
if len(ve.NewFiles) > 0 && len(ve.DeletedFiles) == 0 {
for _, nf := range ve.NewFiles {
b.bytesAdded[nf.Level] += nf.Meta.Size
}
continue
}
// Increase `bytesCompactOut` for the input level of any compactions
// that remove bytes from a level (excluding intra-L0 compactions).
// compactions.
destLevel := -1
if len(ve.NewFiles) > 0 {
destLevel = ve.NewFiles[0].Level
}
for dfe := range ve.DeletedFiles {
if dfe.Level != destLevel {
b.bytesCompactOut[dfe.Level] += metadatas[dfe.FileNum].Size
}
}
}
formatUint64 := func(v uint64, _ time.Duration) string {
if v == 0 {
return "."
}
return humanize.Bytes.Uint64(v).String()
}
formatRate := func(v uint64, dur time.Duration) string {
if v == 0 {
return "."
}
secs := dur.Seconds()
if secs == 0 {
secs = 1
}
return humanize.Bytes.Uint64(uint64(float64(v)/secs)).String() + "/s"
}
if newestOverall.IsZero() {
fmt.Fprintf(stdout, "(no timestamps)\n")
} else {
// NB: bt begins unaligned with the bucket duration (m.summarizeDur),
// but after the first bucket will always be aligned.
for bi, bt := 0, oldestOverall; !bt.After(newestOverall); bi, bt = bi+1, bt.Truncate(m.summarizeDur).Add(m.summarizeDur) {
// Truncate the start time to calculate the bucket key, and
// retrieve the appropriate bucket.
bk := bt.Truncate(m.summarizeDur)
var bucket summaryBucket
if buckets[bk] != nil {
bucket = *buckets[bk]
}
if bi%10 == 0 {
fmt.Fprintf(stdout, " ")
fmt.Fprintf(stdout, "_______L0_______L1_______L2_______L3_______L4_______L5_______L6_____TOTAL\n")
}
fmt.Fprintf(stdout, "%s\n", bt.Format(time.RFC3339))
// Compute the bucket duration. It may < `m.summarizeDur` if this is
// the first or last bucket.
bucketEnd := bt.Truncate(m.summarizeDur).Add(m.summarizeDur)
if bucketEnd.After(newestOverall) {
bucketEnd = newestOverall
}
dur := bucketEnd.Sub(bt)
stats := []struct {
label string
format func(uint64, time.Duration) string
vals [manifest.NumLevels]uint64
}{
{"Ingest+Flush", formatUint64, bucket.bytesAdded},
{"Ingest+Flush", formatRate, bucket.bytesAdded},
{"Compact (out)", formatUint64, bucket.bytesCompactOut},
{"Compact (out)", formatRate, bucket.bytesCompactOut},
}
for _, stat := range stats {
var sum uint64
for _, v := range stat.vals {
sum += v
}
fmt.Fprintf(stdout, "%20s %8s %8s %8s %8s %8s %8s %8s %8s\n",
stat.label,
stat.format(stat.vals[0], dur),
stat.format(stat.vals[1], dur),
stat.format(stat.vals[2], dur),
stat.format(stat.vals[3], dur),
stat.format(stat.vals[4], dur),
stat.format(stat.vals[5], dur),
stat.format(stat.vals[6], dur),
stat.format(sum, dur))
}
}
fmt.Fprintf(stdout, "%s\n", newestOverall.Format(time.RFC3339))
}
dur := newestOverall.Sub(oldestOverall)
fmt.Fprintf(stdout, "---\n")
fmt.Fprintf(stdout, "Estimated start time: %s\n", oldestOverall.Format(time.RFC3339))
fmt.Fprintf(stdout, "Estimated end time: %s\n", newestOverall.Format(time.RFC3339))
fmt.Fprintf(stdout, "Estimated duration: %s\n", dur.String())
return nil
}
func (m *manifestT) runCheck(cmd *cobra.Command, args []string) {
stdout, stderr := cmd.OutOrStdout(), cmd.OutOrStderr()
ok := true
for _, arg := range args {
func() {
f, err := m.opts.FS.Open(arg)
if err != nil {
fmt.Fprintf(stderr, "%s\n", err)
ok = false
return
}
defer f.Close()
var v *manifest.Version
var cmp *base.Comparer
rr := record.NewReader(f, 0 /* logNum */)
// Contains the FileMetadata needed by BulkVersionEdit.Apply.
// It accumulates the additions since later edits contain
// deletions of earlier added files.
addedByFileNum := make(map[base.FileNum]*manifest.FileMetadata)
for {
offset := rr.Offset()
r, err := rr.Next()
if err != nil {
if err == io.EOF {
break
}
fmt.Fprintf(stdout, "%s: offset: %d err: %s\n", arg, offset, err)
ok = false
break
}
var ve manifest.VersionEdit
err = ve.Decode(r)
if err != nil {
fmt.Fprintf(stdout, "%s: offset: %d err: %s\n", arg, offset, err)
ok = false
break
}
var bve manifest.BulkVersionEdit
bve.AddedByFileNum = addedByFileNum
if err := bve.Accumulate(&ve); err != nil {
fmt.Fprintf(stderr, "%s\n", err)
ok = false
return
}
empty := true
if ve.ComparerName != "" {
empty = false
cmp = m.comparers[ve.ComparerName]
if cmp == nil {
fmt.Fprintf(stdout, "%s: offset: %d comparer %s not found",
arg, offset, ve.ComparerName)
ok = false
break
}
m.fmtKey.setForComparer(ve.ComparerName, m.comparers)
}
empty = empty && ve.MinUnflushedLogNum == 0 && ve.ObsoletePrevLogNum == 0 &&
ve.LastSeqNum == 0 && len(ve.DeletedFiles) == 0 &&
len(ve.NewFiles) == 0
if empty {
continue
}
// TODO(sbhola): add option to Apply that reports all errors instead of
// one error.
newv, err := bve.Apply(v, cmp.Compare, m.fmtKey.fn, 0, m.opts.Experimental.ReadCompactionRate, nil /* zombies */, manifest.AllowSplitUserKeys)
if err != nil {
fmt.Fprintf(stdout, "%s: offset: %d err: %s\n",
arg, offset, err)
fmt.Fprintf(stdout, "Version state before failed Apply\n")
m.printLevels(cmp.Compare, stdout, v)
fmt.Fprintf(stdout, "Version edit that failed\n")
for df := range ve.DeletedFiles {
fmt.Fprintf(stdout, " deleted: L%d %s\n", df.Level, df.FileNum)
}
for _, nf := range ve.NewFiles {
fmt.Fprintf(stdout, " added: L%d %s:%d",
nf.Level, nf.Meta.FileNum, nf.Meta.Size)
formatSeqNumRange(stdout, nf.Meta.SmallestSeqNum, nf.Meta.LargestSeqNum)
formatKeyRange(stdout, m.fmtKey, &nf.Meta.Smallest, &nf.Meta.Largest)
fmt.Fprintf(stdout, "\n")
}
ok = false
break
}
v = newv
}
}()
}
if ok {
fmt.Fprintf(stdout, "OK\n")
}
}