package storage import ( "errors" "io" "log" "math" "math/rand" "sync" "time" "github.com/coreos/etcd/storage/backend" "github.com/coreos/etcd/storage/storagepb" ) var ( batchLimit = 10000 batchInterval = 100 * time.Millisecond keyBucketName = []byte("key") metaBucketName = []byte("meta") scheduledCompactKeyName = []byte("scheduledCompactRev") finishedCompactKeyName = []byte("finishedCompactRev") ErrTxnIDMismatch = errors.New("storage: txn id mismatch") ErrCompacted = errors.New("storage: required reversion has been compacted") ErrFutureRev = errors.New("storage: required reversion is a future reversion") ) type store struct { mu sync.RWMutex b backend.Backend kvindex index currentRev reversion // the main reversion of the last compaction compactMainRev int64 tmu sync.Mutex // protect the txnID field txnID int64 // tracks the current txnID to verify txn operations wg sync.WaitGroup stopc chan struct{} } func New(path string) KV { return newStore(path) } func newStore(path string) *store { s := &store{ b: backend.New(path, batchInterval, batchLimit), kvindex: newTreeIndex(), currentRev: reversion{}, compactMainRev: -1, stopc: make(chan struct{}), } tx := s.b.BatchTx() tx.Lock() tx.UnsafeCreateBucket(keyBucketName) tx.UnsafeCreateBucket(metaBucketName) tx.Unlock() s.b.ForceCommit() return s } func (s *store) Put(key, value []byte) int64 { id := s.TxnBegin() s.put(key, value, s.currentRev.main+1) s.TxnEnd(id) return int64(s.currentRev.main) } func (s *store) Range(key, end []byte, limit, rangeRev int64) (kvs []storagepb.KeyValue, rev int64, err error) { id := s.TxnBegin() kvs, rev, err = s.rangeKeys(key, end, limit, rangeRev) s.TxnEnd(id) return kvs, rev, err } func (s *store) DeleteRange(key, end []byte) (n, rev int64) { id := s.TxnBegin() n = s.deleteRange(key, end, s.currentRev.main+1) s.TxnEnd(id) return n, int64(s.currentRev.main) } func (s *store) TxnBegin() int64 { s.mu.Lock() s.currentRev.sub = 0 s.tmu.Lock() defer s.tmu.Unlock() s.txnID = rand.Int63() return s.txnID } func (s *store) TxnEnd(txnID int64) error { s.tmu.Lock() defer s.tmu.Unlock() if txnID != s.txnID { return ErrTxnIDMismatch } if s.currentRev.sub != 0 { s.currentRev.main += 1 } s.currentRev.sub = 0 s.mu.Unlock() return nil } func (s *store) TxnRange(txnID int64, key, end []byte, limit, rangeRev int64) (kvs []storagepb.KeyValue, rev int64, err error) { s.tmu.Lock() defer s.tmu.Unlock() if txnID != s.txnID { return nil, 0, ErrTxnIDMismatch } return s.rangeKeys(key, end, limit, rangeRev) } func (s *store) TxnPut(txnID int64, key, value []byte) (rev int64, err error) { s.tmu.Lock() defer s.tmu.Unlock() if txnID != s.txnID { return 0, ErrTxnIDMismatch } s.put(key, value, s.currentRev.main+1) return int64(s.currentRev.main + 1), nil } func (s *store) TxnDeleteRange(txnID int64, key, end []byte) (n, rev int64, err error) { s.tmu.Lock() defer s.tmu.Unlock() if txnID != s.txnID { return 0, 0, ErrTxnIDMismatch } n = s.deleteRange(key, end, s.currentRev.main+1) if n != 0 || s.currentRev.sub != 0 { rev = int64(s.currentRev.main + 1) } return n, rev, nil } func (s *store) Compact(rev int64) error { s.mu.Lock() defer s.mu.Unlock() if rev <= s.compactMainRev { return ErrCompacted } s.compactMainRev = rev rbytes := newRevBytes() revToBytes(reversion{main: rev}, rbytes) tx := s.b.BatchTx() tx.Lock() tx.UnsafePut(metaBucketName, scheduledCompactKeyName, rbytes) tx.Unlock() keep := s.kvindex.Compact(rev) s.wg.Add(1) go s.scheduleCompaction(rev, keep) return nil } func (s *store) Snapshot(w io.Writer) (int64, error) { s.b.ForceCommit() return s.b.Snapshot(w) } func (s *store) Restore() error { s.mu.Lock() defer s.mu.Unlock() min, max := newRevBytes(), newRevBytes() revToBytes(reversion{}, min) revToBytes(reversion{main: math.MaxInt64, sub: math.MaxInt64}, max) // restore index tx := s.b.BatchTx() tx.Lock() _, finishedCompactBytes := tx.UnsafeRange(metaBucketName, finishedCompactKeyName, nil, 0) if len(finishedCompactBytes) != 0 { s.compactMainRev = bytesToRev(finishedCompactBytes[0]).main log.Printf("storage: restore compact to %d", s.compactMainRev) } // TODO: limit N to reduce max memory usage keys, vals := tx.UnsafeRange(keyBucketName, min, max, 0) for i, key := range keys { e := &storagepb.Event{} if err := e.Unmarshal(vals[i]); err != nil { log.Fatalf("storage: cannot unmarshal event: %v", err) } rev := bytesToRev(key) // restore index switch e.Type { case storagepb.PUT: s.kvindex.Restore(e.Kv.Key, reversion{e.Kv.CreateIndex, 0}, rev, e.Kv.Version) case storagepb.DELETE: s.kvindex.Tombstone(e.Kv.Key, rev) default: log.Panicf("storage: unexpected event type %s", e.Type) } // update reversion s.currentRev = rev } _, scheduledCompactBytes := tx.UnsafeRange(metaBucketName, scheduledCompactKeyName, nil, 0) if len(scheduledCompactBytes) != 0 { scheduledCompact := bytesToRev(scheduledCompactBytes[0]).main if scheduledCompact > s.compactMainRev { log.Printf("storage: resume scheduled compaction at %d", scheduledCompact) go s.Compact(scheduledCompact) } } tx.Unlock() return nil } func (s *store) Close() error { close(s.stopc) s.wg.Wait() return s.b.Close() } func (a *store) Equal(b *store) bool { if a.currentRev != b.currentRev { return false } if a.compactMainRev != b.compactMainRev { return false } return a.kvindex.Equal(b.kvindex) } // range is a keyword in Go, add Keys suffix. func (s *store) rangeKeys(key, end []byte, limit, rangeRev int64) (kvs []storagepb.KeyValue, rev int64, err error) { if rangeRev > s.currentRev.main { return nil, s.currentRev.main, ErrFutureRev } if rangeRev <= 0 { rev = int64(s.currentRev.main) if s.currentRev.sub > 0 { rev += 1 } } else { rev = rangeRev } if rev <= s.compactMainRev { return nil, 0, ErrCompacted } _, revpairs := s.kvindex.Range(key, end, int64(rev)) if len(revpairs) == 0 { return nil, rev, nil } tx := s.b.BatchTx() tx.Lock() defer tx.Unlock() for _, revpair := range revpairs { revbytes := newRevBytes() revToBytes(revpair, revbytes) _, vs := tx.UnsafeRange(keyBucketName, revbytes, nil, 0) if len(vs) != 1 { log.Fatalf("storage: range cannot find rev (%d,%d)", revpair.main, revpair.sub) } e := &storagepb.Event{} if err := e.Unmarshal(vs[0]); err != nil { log.Fatalf("storage: cannot unmarshal event: %v", err) } if e.Type == storagepb.PUT { kvs = append(kvs, *e.Kv) } if limit > 0 && len(kvs) >= int(limit) { break } } return kvs, rev, nil } func (s *store) put(key, value []byte, rev int64) { c := rev // if the key exists before, use its previous created _, created, ver, err := s.kvindex.Get(key, rev) if err == nil { c = created.main } ibytes := newRevBytes() revToBytes(reversion{main: rev, sub: s.currentRev.sub}, ibytes) ver = ver + 1 event := storagepb.Event{ Type: storagepb.PUT, Kv: &storagepb.KeyValue{ Key: key, Value: value, CreateIndex: c, ModIndex: rev, Version: ver, }, } d, err := event.Marshal() if err != nil { log.Fatalf("storage: cannot marshal event: %v", err) } tx := s.b.BatchTx() tx.Lock() defer tx.Unlock() tx.UnsafePut(keyBucketName, ibytes, d) s.kvindex.Put(key, reversion{main: rev, sub: s.currentRev.sub}) s.currentRev.sub += 1 } func (s *store) deleteRange(key, end []byte, rev int64) int64 { var n int64 rrev := rev if s.currentRev.sub > 0 { rrev += 1 } keys, _ := s.kvindex.Range(key, end, rrev) if len(keys) == 0 { return 0 } for _, key := range keys { ok := s.delete(key, rev) if ok { n++ } } return n } func (s *store) delete(key []byte, mainrev int64) bool { grev := mainrev if s.currentRev.sub > 0 { grev += 1 } rev, _, _, err := s.kvindex.Get(key, grev) if err != nil { // key not exist return false } tx := s.b.BatchTx() tx.Lock() defer tx.Unlock() revbytes := newRevBytes() revToBytes(rev, revbytes) _, vs := tx.UnsafeRange(keyBucketName, revbytes, nil, 0) if len(vs) != 1 { log.Fatalf("storage: delete cannot find rev (%d,%d)", rev.main, rev.sub) } e := &storagepb.Event{} if err := e.Unmarshal(vs[0]); err != nil { log.Fatalf("storage: cannot unmarshal event: %v", err) } if e.Type == storagepb.DELETE { return false } ibytes := newRevBytes() revToBytes(reversion{main: mainrev, sub: s.currentRev.sub}, ibytes) event := storagepb.Event{ Type: storagepb.DELETE, Kv: &storagepb.KeyValue{ Key: key, }, } d, err := event.Marshal() if err != nil { log.Fatalf("storage: cannot marshal event: %v", err) } tx.UnsafePut(keyBucketName, ibytes, d) err = s.kvindex.Tombstone(key, reversion{main: mainrev, sub: s.currentRev.sub}) if err != nil { log.Fatalf("storage: cannot tombstone an existing key (%s): %v", string(key), err) } s.currentRev.sub += 1 return true }