|
| 1 | +package raftstore |
| 2 | + |
| 3 | +import ( |
| 4 | + "bytes" |
| 5 | + "os" |
| 6 | + "path/filepath" |
| 7 | + |
| 8 | + "github.com/cockroachdb/errors" |
| 9 | + "github.com/hashicorp/go-msgpack/v2/codec" |
| 10 | + "github.com/hashicorp/raft" |
| 11 | + "go.etcd.io/bbolt" |
| 12 | +) |
| 13 | + |
| 14 | +const ( |
| 15 | + legacyLogsBucket = "logs" |
| 16 | + legacyStableBucket = "conf" |
| 17 | + legacyBatchSize = 1024 |
| 18 | + legacyBoltFileMode = 0o600 |
| 19 | + legacyMigrationSuffix = ".migrating" |
| 20 | +) |
| 21 | + |
| 22 | +type MigrationStats struct { |
| 23 | + Logs uint64 |
| 24 | + StableKeys uint64 |
| 25 | +} |
| 26 | + |
| 27 | +func MigrateLegacyBoltDB(logsPath, stablePath, destDir string) (*MigrationStats, error) { |
| 28 | + tempDir, err := prepareMigrationPaths(logsPath, stablePath, destDir) |
| 29 | + if err != nil { |
| 30 | + return nil, err |
| 31 | + } |
| 32 | + |
| 33 | + logsDB, stableDB, closeSources, err := openLegacySourceDBs(logsPath, stablePath) |
| 34 | + if err != nil { |
| 35 | + return nil, err |
| 36 | + } |
| 37 | + defer closeSources() |
| 38 | + |
| 39 | + stats, err := migrateLegacyBoltToTempDir(logsDB, stableDB, tempDir) |
| 40 | + if err != nil { |
| 41 | + return nil, err |
| 42 | + } |
| 43 | + if err := finalizeMigratedStore(tempDir, destDir); err != nil { |
| 44 | + return nil, err |
| 45 | + } |
| 46 | + return stats, nil |
| 47 | +} |
| 48 | + |
| 49 | +func prepareMigrationPaths(logsPath, stablePath, destDir string) (string, error) { |
| 50 | + if logsPath == "" { |
| 51 | + return "", errors.New("logs path is required") |
| 52 | + } |
| 53 | + if stablePath == "" { |
| 54 | + return "", errors.New("stable path is required") |
| 55 | + } |
| 56 | + if destDir == "" { |
| 57 | + return "", errors.New("destination dir is required") |
| 58 | + } |
| 59 | + |
| 60 | + destDir = filepath.Clean(destDir) |
| 61 | + |
| 62 | + if err := requireExistingFile(logsPath); err != nil { |
| 63 | + return "", err |
| 64 | + } |
| 65 | + if err := requireExistingFile(stablePath); err != nil { |
| 66 | + return "", err |
| 67 | + } |
| 68 | + if err := requireDestinationAbsent(destDir); err != nil { |
| 69 | + return "", err |
| 70 | + } |
| 71 | + |
| 72 | + tempDir := destDir + legacyMigrationSuffix |
| 73 | + if err := requireDestinationAbsent(tempDir); err != nil { |
| 74 | + return "", err |
| 75 | + } |
| 76 | + return tempDir, nil |
| 77 | +} |
| 78 | + |
| 79 | +func openLegacySourceDBs(logsPath, stablePath string) (logsDB *bbolt.DB, stableDB *bbolt.DB, closeFn func(), err error) { |
| 80 | + logsDB, err = openLegacyBoltReadOnly(logsPath) |
| 81 | + if err != nil { |
| 82 | + return nil, nil, nil, err |
| 83 | + } |
| 84 | + |
| 85 | + stableDB, err = openLegacyBoltReadOnly(stablePath) |
| 86 | + if err != nil { |
| 87 | + _ = logsDB.Close() |
| 88 | + return nil, nil, nil, err |
| 89 | + } |
| 90 | + |
| 91 | + closeFn = func() { |
| 92 | + _ = stableDB.Close() |
| 93 | + _ = logsDB.Close() |
| 94 | + } |
| 95 | + return logsDB, stableDB, closeFn, nil |
| 96 | +} |
| 97 | + |
| 98 | +func migrateLegacyBoltToTempDir(logsDB, stableDB *bbolt.DB, tempDir string) (*MigrationStats, error) { |
| 99 | + store, err := NewPebbleStore(tempDir) |
| 100 | + if err != nil { |
| 101 | + return nil, err |
| 102 | + } |
| 103 | + |
| 104 | + cleanupTemp := func() { |
| 105 | + _ = store.Close() |
| 106 | + _ = os.RemoveAll(tempDir) |
| 107 | + } |
| 108 | + |
| 109 | + stats, err := migrateLegacyBoltData(logsDB, stableDB, store) |
| 110 | + if err != nil { |
| 111 | + cleanupTemp() |
| 112 | + return nil, err |
| 113 | + } |
| 114 | + if err := store.Close(); err != nil { |
| 115 | + _ = os.RemoveAll(tempDir) |
| 116 | + return nil, err |
| 117 | + } |
| 118 | + return stats, nil |
| 119 | +} |
| 120 | + |
| 121 | +func finalizeMigratedStore(tempDir, destDir string) error { |
| 122 | + if err := os.MkdirAll(filepath.Dir(destDir), pebbleDirPerm); err != nil { |
| 123 | + _ = os.RemoveAll(tempDir) |
| 124 | + return errors.WithStack(err) |
| 125 | + } |
| 126 | + if err := os.Rename(tempDir, destDir); err != nil { |
| 127 | + _ = os.RemoveAll(tempDir) |
| 128 | + return errors.WithStack(err) |
| 129 | + } |
| 130 | + return nil |
| 131 | +} |
| 132 | + |
| 133 | +func migrateLegacyBoltData(logsDB, stableDB *bbolt.DB, dest *PebbleStore) (*MigrationStats, error) { |
| 134 | + stats := &MigrationStats{} |
| 135 | + |
| 136 | + if err := copyLegacyStable(stableDB, dest, stats); err != nil { |
| 137 | + return nil, err |
| 138 | + } |
| 139 | + if err := copyLegacyLogs(logsDB, dest, stats); err != nil { |
| 140 | + return nil, err |
| 141 | + } |
| 142 | + |
| 143 | + return stats, nil |
| 144 | +} |
| 145 | + |
| 146 | +func copyLegacyStable(stableDB *bbolt.DB, dest *PebbleStore, stats *MigrationStats) error { |
| 147 | + return errors.WithStack(stableDB.View(func(tx *bbolt.Tx) error { |
| 148 | + bucket := tx.Bucket([]byte(legacyStableBucket)) |
| 149 | + if bucket == nil { |
| 150 | + return errors.Newf("legacy stable bucket %q not found", legacyStableBucket) |
| 151 | + } |
| 152 | + return bucket.ForEach(func(k, v []byte) error { |
| 153 | + if err := dest.Set(k, append([]byte(nil), v...)); err != nil { |
| 154 | + return err |
| 155 | + } |
| 156 | + stats.StableKeys++ |
| 157 | + return nil |
| 158 | + }) |
| 159 | + })) |
| 160 | +} |
| 161 | + |
| 162 | +func copyLegacyLogs(logsDB *bbolt.DB, dest *PebbleStore, stats *MigrationStats) error { |
| 163 | + batch := make([]*raft.Log, 0, legacyBatchSize) |
| 164 | + |
| 165 | + flush := func() error { |
| 166 | + if len(batch) == 0 { |
| 167 | + return nil |
| 168 | + } |
| 169 | + if err := dest.StoreLogs(batch); err != nil { |
| 170 | + return err |
| 171 | + } |
| 172 | + stats.Logs += uint64(len(batch)) |
| 173 | + batch = batch[:0] |
| 174 | + return nil |
| 175 | + } |
| 176 | + |
| 177 | + err := logsDB.View(func(tx *bbolt.Tx) error { |
| 178 | + bucket := tx.Bucket([]byte(legacyLogsBucket)) |
| 179 | + if bucket == nil { |
| 180 | + return errors.Newf("legacy logs bucket %q not found", legacyLogsBucket) |
| 181 | + } |
| 182 | + return bucket.ForEach(func(_, v []byte) error { |
| 183 | + var entry raft.Log |
| 184 | + if err := decodeLegacyLog(v, &entry); err != nil { |
| 185 | + return err |
| 186 | + } |
| 187 | + batch = append(batch, &entry) |
| 188 | + if len(batch) < legacyBatchSize { |
| 189 | + return nil |
| 190 | + } |
| 191 | + return flush() |
| 192 | + }) |
| 193 | + }) |
| 194 | + if err != nil { |
| 195 | + return errors.WithStack(err) |
| 196 | + } |
| 197 | + |
| 198 | + return flush() |
| 199 | +} |
| 200 | + |
| 201 | +func openLegacyBoltReadOnly(path string) (*bbolt.DB, error) { |
| 202 | + db, err := bbolt.Open(path, legacyBoltFileMode, &bbolt.Options{ReadOnly: true}) |
| 203 | + if err != nil { |
| 204 | + return nil, errors.WithStack(err) |
| 205 | + } |
| 206 | + return db, nil |
| 207 | +} |
| 208 | + |
| 209 | +func requireExistingFile(path string) error { |
| 210 | + info, err := os.Stat(path) |
| 211 | + if err != nil { |
| 212 | + return errors.WithStack(err) |
| 213 | + } |
| 214 | + if info.IsDir() { |
| 215 | + return errors.WithStack(errors.Newf("%s is a directory, expected file", path)) |
| 216 | + } |
| 217 | + return nil |
| 218 | +} |
| 219 | + |
| 220 | +func requireDestinationAbsent(path string) error { |
| 221 | + if _, err := os.Stat(path); err == nil { |
| 222 | + return errors.WithStack(errors.Newf("destination already exists: %s", path)) |
| 223 | + } else if !os.IsNotExist(err) { |
| 224 | + return errors.WithStack(err) |
| 225 | + } |
| 226 | + return nil |
| 227 | +} |
| 228 | + |
| 229 | +func decodeLegacyLog(payload []byte, out *raft.Log) error { |
| 230 | + handle := codec.MsgpackHandle{} |
| 231 | + decoder := codec.NewDecoder(bytes.NewReader(payload), &handle) |
| 232 | + return errors.WithStack(decoder.Decode(out)) |
| 233 | +} |
0 commit comments