forked from Layr-Labs/optimism-archived
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat(op-program): Use `PebbleDB` for `DiskKV` * close db * fix `testFaultProofProgramScenario` tests * switch to snappy compression cockroachdb/pebble#3434 * fix tempdir * update compat release * defer k/v until preimage server and hinter have both exited
- Loading branch information
Showing
6 changed files
with
52 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,93 +1,68 @@ | ||
| package kvstore | ||
|
|
||
| import ( | ||
| "encoding/hex" | ||
| "errors" | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
| "path" | ||
| "runtime" | ||
| "sync" | ||
|
|
||
| "github.com/cockroachdb/pebble" | ||
| "github.com/ethereum/go-ethereum/common" | ||
| ) | ||
|
|
||
| // read/write mode for user/group/other, not executable. | ||
| const diskPermission = 0666 | ||
|
|
||
| // DiskKV is a disk-backed key-value store, every key-value pair is a hex-encoded .txt file, with the value as content. | ||
| // DiskKV is a disk-backed key-value store, with PebbleDB as the underlying DBMS. | ||
| // DiskKV is safe for concurrent use with a single DiskKV instance. | ||
| // DiskKV is safe for concurrent use between different DiskKV instances of the same disk directory as long as the | ||
| // file system supports atomic renames. | ||
| type DiskKV struct { | ||
| sync.RWMutex | ||
| path string | ||
| db *pebble.DB | ||
| } | ||
|
|
||
| // NewDiskKV creates a DiskKV that puts/gets pre-images as files in the given directory path. | ||
| // The path must exist, or subsequent Put/Get calls will error when it does not. | ||
| func NewDiskKV(path string) *DiskKV { | ||
| return &DiskKV{path: path} | ||
| } | ||
| opts := &pebble.Options{ | ||
| Cache: pebble.NewCache(int64(32 * 1024 * 1024)), | ||
| MaxConcurrentCompactions: runtime.NumCPU, | ||
| Levels: []pebble.LevelOptions{ | ||
| {Compression: pebble.SnappyCompression}, | ||
| }, | ||
| } | ||
| db, err := pebble.Open(path, opts) | ||
| if err != nil { | ||
| panic(fmt.Errorf("failed to open pebbledb at %s: %w", path, err)) | ||
| } | ||
|
|
||
| func (d *DiskKV) pathKey(k common.Hash) string { | ||
| return path.Join(d.path, k.String()+".txt") | ||
| return &DiskKV{db: db} | ||
| } | ||
|
|
||
| func (d *DiskKV) Put(k common.Hash, v []byte) error { | ||
| d.Lock() | ||
| defer d.Unlock() | ||
| f, err := openTempFile(d.path, k.String()+".txt.*") | ||
| if err != nil { | ||
| return fmt.Errorf("failed to open temp file for pre-image %s: %w", k, err) | ||
| } | ||
| defer os.Remove(f.Name()) // Clean up the temp file if it doesn't actually get moved into place | ||
| if _, err := f.Write([]byte(hex.EncodeToString(v))); err != nil { | ||
| _ = f.Close() | ||
| return fmt.Errorf("failed to write pre-image %s to disk: %w", k, err) | ||
| } | ||
| if err := f.Close(); err != nil { | ||
| return fmt.Errorf("failed to close temp pre-image %s file: %w", k, err) | ||
| } | ||
|
|
||
| targetFile := d.pathKey(k) | ||
| if err := os.Rename(f.Name(), targetFile); err != nil { | ||
| return fmt.Errorf("failed to move temp dir %v to final destination %v: %w", f.Name(), targetFile, err) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func openTempFile(dir string, nameTemplate string) (*os.File, error) { | ||
| f, err := os.CreateTemp(dir, nameTemplate) | ||
| // Directory has been deleted out from underneath us. Recreate it. | ||
| if errors.Is(err, os.ErrNotExist) { | ||
| if mkdirErr := os.MkdirAll(dir, 0777); mkdirErr != nil { | ||
| return nil, errors.Join(fmt.Errorf("failed to create directory %v: %w", dir, mkdirErr), err) | ||
| } | ||
| f, err = os.CreateTemp(dir, nameTemplate) | ||
| } | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return f, nil | ||
| return d.db.Set(k.Bytes(), v, pebble.NoSync) | ||
| } | ||
|
|
||
| func (d *DiskKV) Get(k common.Hash) ([]byte, error) { | ||
| d.RLock() | ||
| defer d.RUnlock() | ||
| f, err := os.OpenFile(d.pathKey(k), os.O_RDONLY, diskPermission) | ||
|
|
||
| dat, closer, err := d.db.Get(k.Bytes()) | ||
| if err != nil { | ||
| if errors.Is(err, os.ErrNotExist) { | ||
| if errors.Is(err, pebble.ErrNotFound) { | ||
| return nil, ErrNotFound | ||
| } | ||
| return nil, fmt.Errorf("failed to open pre-image file %s: %w", k, err) | ||
| } | ||
| defer f.Close() // fine to ignore closing error here | ||
| dat, err := io.ReadAll(f) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to read pre-image from file %s: %w", k, err) | ||
| return nil, err | ||
| } | ||
| return hex.DecodeString(string(dat)) | ||
| ret := make([]byte, len(dat)) | ||
| copy(ret, dat) | ||
| closer.Close() | ||
| return ret, nil | ||
| } | ||
|
|
||
| func (d *DiskKV) Close() error { | ||
| d.Lock() | ||
| defer d.Unlock() | ||
|
|
||
| return d.db.Close() | ||
| } | ||
|
|
||
| var _ KV = (*DiskKV)(nil) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters