/* Copyright 2021 Erigon contributors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package remotedbserver import ( "bytes" "context" "errors" "fmt" "io" "reflect" "sync" "time" "github.com/ledgerwatch/erigon-lib/common" "github.com/ledgerwatch/erigon-lib/common/cmp" "github.com/ledgerwatch/erigon-lib/common/dbg" "github.com/ledgerwatch/erigon-lib/gointerfaces/remote" "github.com/ledgerwatch/erigon-lib/gointerfaces/types" "github.com/ledgerwatch/erigon-lib/kv" "github.com/ledgerwatch/log/v3" "go.uber.org/atomic" "golang.org/x/exp/slices" "google.golang.org/protobuf/types/known/emptypb" ) // MaxTxTTL - kv interface provide high-consistancy guaranties: Serializable Isolations Level https://en.wikipedia.org/wiki/Isolation_(database_systems) // But it comes with cost: DB will start grow if run too long read transactions (hours) // We decided limit TTL of transaction to `MaxTxTTL` // // It means you sill have `Serializable` if tx living < `MaxTxTTL` // You start have Read Committed Level if tx living > `MaxTxTTL` // // It's done by `renew` method: after `renew` call reader will see all changes committed after last `renew` call. // // Erigon has much Historical data - which is immutable: reading of historical data for hours still gives you consistant data. const MaxTxTTL = 60 * time.Second // KvServiceAPIVersion - use it to track changes in API // 1.1.0 - added pending transactions, add methods eth_getRawTransactionByHash, eth_retRawTransactionByBlockHashAndIndex, eth_retRawTransactionByBlockNumberAndIndex| Yes | | // 1.2.0 - Added separated services for mining and txpool methods // 2.0.0 - Rename all buckets // 3.0.0 - ?? // 4.0.0 - Server send tx.ViewID() after open tx // 5.0 - BlockTransaction table now has canonical ids (txs of non-canonical blocks moving to NonCanonicalTransaction table) // 5.1.0 - Added blockGasLimit to the StateChangeBatch // 6.0.0 - Blocks now have system-txs - in the begin/end of block var KvServiceAPIVersion = &types.VersionReply{Major: 6, Minor: 0, Patch: 0} type KvServer struct { remote.UnimplementedKVServer // must be embedded to have forward compatible implementations. kv kv.RoDB stateChangeStreams *StateChangePubSub blockSnapshots Snapsthots historySnapshots Snapsthots ctx context.Context //v3 fields txIdGen atomic.Uint64 txsMapLock *sync.RWMutex txs map[uint64]*threadSafeTx trace bool } type threadSafeTx struct { kv.Tx sync.Mutex } type Snapsthots interface { Files() []string } func NewKvServer(ctx context.Context, db kv.RoDB, snapshots Snapsthots, historySnapshots Snapsthots) *KvServer { return &KvServer{ trace: false, kv: db, stateChangeStreams: newStateChangeStreams(), ctx: ctx, blockSnapshots: snapshots, historySnapshots: historySnapshots, txs: map[uint64]*threadSafeTx{}, txsMapLock: &sync.RWMutex{}, } } // Version returns the service-side interface version number func (s *KvServer) Version(context.Context, *emptypb.Empty) (*types.VersionReply, error) { dbSchemaVersion := &kv.DBSchemaVersion if KvServiceAPIVersion.Major > dbSchemaVersion.Major { return KvServiceAPIVersion, nil } if dbSchemaVersion.Major > KvServiceAPIVersion.Major { return dbSchemaVersion, nil } if KvServiceAPIVersion.Minor > dbSchemaVersion.Minor { return KvServiceAPIVersion, nil } if dbSchemaVersion.Minor > KvServiceAPIVersion.Minor { return dbSchemaVersion, nil } return dbSchemaVersion, nil } func (s *KvServer) begin(ctx context.Context) (id uint64, err error) { if s.trace { log.Info(fmt.Sprintf("[kv_server] begin %d %s\n", id, dbg.Stack())) } s.txsMapLock.Lock() defer s.txsMapLock.Unlock() tx, errBegin := s.kv.BeginRo(ctx) if errBegin != nil { return 0, errBegin } id = s.txIdGen.Inc() s.txs[id] = &threadSafeTx{Tx: tx} return id, nil } // renew - rollback and begin tx without changing it's `id` func (s *KvServer) renew(ctx context.Context, id uint64) (err error) { if s.trace { log.Info(fmt.Sprintf("[kv_server] renew %d %s\n", id, dbg.Stack()[:2])) } s.txsMapLock.Lock() defer s.txsMapLock.Unlock() tx, ok := s.txs[id] if ok { tx.Lock() defer tx.Unlock() tx.Rollback() } newTx, errBegin := s.kv.BeginRo(ctx) if errBegin != nil { return err } s.txs[id] = &threadSafeTx{Tx: newTx} return nil } func (s *KvServer) rollback(id uint64) { if s.trace { log.Info(fmt.Sprintf("[kv_server] rollback %d %s\n", id, dbg.Stack()[:2])) } s.txsMapLock.Lock() defer s.txsMapLock.Unlock() tx, ok := s.txs[id] if ok { tx.Lock() defer tx.Unlock() tx.Rollback() delete(s.txs, id) } } // with - provides exclusive access to `tx` object. Use it if you need open Cursor or run another method of `tx` object. // it's ok to use same `kv.RoTx` from different goroutines, but such use must be guarded by `with` method. // // !Important: client may open multiple Cursors and multiple Streams on same `tx` in same time // it means server must do limited amount of work inside `with` method (periodically release `tx` for other streams) // long-living server-side streams must read limited-portion of data inside `with`, send this portion to // client, portion of data it to client, then read next portion in another `with` call. // It will allow cooperative access to `tx` object func (s *KvServer) with(id uint64, f func(kv.Tx) error) error { s.txsMapLock.RLock() tx, ok := s.txs[id] s.txsMapLock.RUnlock() if !ok { return fmt.Errorf("txn %d already rollback", id) } if s.trace { log.Info(fmt.Sprintf("[kv_server] with %d try lock %s\n", id, dbg.Stack()[:2])) } tx.Lock() if s.trace { log.Info(fmt.Sprintf("[kv_server] with %d can lock %s\n", id, dbg.Stack()[:2])) } defer func() { tx.Unlock() if s.trace { log.Info(fmt.Sprintf("[kv_server] with %d unlock %s\n", id, dbg.Stack()[:2])) } }() return f(tx.Tx) } func (s *KvServer) Tx(stream remote.KV_TxServer) error { id, errBegin := s.begin(stream.Context()) if errBegin != nil { return fmt.Errorf("server-side error: %w", errBegin) } defer s.rollback(id) var viewID uint64 if err := s.with(id, func(tx kv.Tx) error { viewID = tx.ViewID() return nil }); err != nil { return err } if err := stream.Send(&remote.Pair{ViewID: viewID, TxID: id}); err != nil { return fmt.Errorf("server-side error: %w", err) } var CursorID uint32 type CursorInfo struct { bucket string c kv.Cursor k, v []byte //fields to save current position of cursor - used when Tx reopen } cursors := map[uint32]*CursorInfo{} txTicker := time.NewTicker(MaxTxTTL) defer txTicker.Stop() // send all items to client, if k==nil - still send it to client and break loop for { in, recvErr := stream.Recv() if recvErr != nil { if errors.Is(recvErr, io.EOF) { // termination return nil } return fmt.Errorf("server-side error: %w", recvErr) } //TODO: protect against client - which doesn't send any requests select { default: case <-txTicker.C: for _, c := range cursors { // save positions of cursor, will restore after Tx reopening k, v, err := c.c.Current() if err != nil { return err } c.k = bytesCopy(k) c.v = bytesCopy(v) } if err := s.renew(stream.Context(), id); err != nil { return err } if err := s.with(id, func(tx kv.Tx) error { for _, c := range cursors { // restore all cursors position var err error c.c, err = tx.Cursor(c.bucket) if err != nil { return err } switch casted := c.c.(type) { case kv.CursorDupSort: v, err := casted.SeekBothRange(c.k, c.v) if err != nil { return fmt.Errorf("server-side error: %w", err) } if v == nil { // it may happen that key where we stopped disappeared after transaction reopen, then just move to next key _, _, err = casted.Next() if err != nil { return fmt.Errorf("server-side error: %w", err) } } case kv.Cursor: if _, _, err := c.c.Seek(c.k); err != nil { return fmt.Errorf("server-side error: %w", err) } } } return nil }); err != nil { return err } } var c kv.Cursor if in.BucketName == "" { cInfo, ok := cursors[in.Cursor] if !ok { return fmt.Errorf("server-side error: unknown Cursor=%d, Op=%s", in.Cursor, in.Op) } c = cInfo.c } switch in.Op { case remote.Op_OPEN: CursorID++ var err error if err := s.with(id, func(tx kv.Tx) error { c, err = tx.Cursor(in.BucketName) if err != nil { return err } return nil }); err != nil { return err } cursors[CursorID] = &CursorInfo{ bucket: in.BucketName, c: c, } if err := stream.Send(&remote.Pair{CursorID: CursorID}); err != nil { return fmt.Errorf("server-side error: %w", err) } continue case remote.Op_OPEN_DUP_SORT: CursorID++ var err error if err := s.with(id, func(tx kv.Tx) error { c, err = tx.CursorDupSort(in.BucketName) if err != nil { return err } return nil }); err != nil { return err } cursors[CursorID] = &CursorInfo{ bucket: in.BucketName, c: c, } if err := stream.Send(&remote.Pair{CursorID: CursorID}); err != nil { return fmt.Errorf("server-side error: %w", err) } continue case remote.Op_CLOSE: cInfo, ok := cursors[in.Cursor] if !ok { return fmt.Errorf("server-side error: unknown Cursor=%d, Op=%s", in.Cursor, in.Op) } cInfo.c.Close() delete(cursors, in.Cursor) if err := stream.Send(&remote.Pair{}); err != nil { return fmt.Errorf("server-side error: %w", err) } continue default: } if err := handleOp(c, stream, in); err != nil { return fmt.Errorf("server-side error: %w", err) } } } func handleOp(c kv.Cursor, stream remote.KV_TxServer, in *remote.Cursor) error { var k, v []byte var err error switch in.Op { case remote.Op_FIRST: k, v, err = c.First() case remote.Op_FIRST_DUP: v, err = c.(kv.CursorDupSort).FirstDup() case remote.Op_SEEK: k, v, err = c.Seek(in.K) case remote.Op_SEEK_BOTH: v, err = c.(kv.CursorDupSort).SeekBothRange(in.K, in.V) case remote.Op_CURRENT: k, v, err = c.Current() case remote.Op_LAST: k, v, err = c.Last() case remote.Op_LAST_DUP: v, err = c.(kv.CursorDupSort).LastDup() case remote.Op_NEXT: k, v, err = c.Next() case remote.Op_NEXT_DUP: k, v, err = c.(kv.CursorDupSort).NextDup() case remote.Op_NEXT_NO_DUP: k, v, err = c.(kv.CursorDupSort).NextNoDup() case remote.Op_PREV: k, v, err = c.Prev() //case remote.Op_PREV_DUP: // k, v, err = c.(ethdb.CursorDupSort).Prev() // if err != nil { // return err // } //case remote.Op_PREV_NO_DUP: // k, v, err = c.Prev() // if err != nil { // return err // } case remote.Op_SEEK_EXACT: k, v, err = c.SeekExact(in.K) case remote.Op_SEEK_BOTH_EXACT: k, v, err = c.(kv.CursorDupSort).SeekBothExact(in.K, in.V) case remote.Op_COUNT: cnt, err := c.Count() if err != nil { return err } v = common.EncodeTs(cnt) default: return fmt.Errorf("unknown operation: %s", in.Op) } if err != nil { return err } if err := stream.Send(&remote.Pair{K: k, V: v}); err != nil { return err } return nil } func bytesCopy(b []byte) []byte { if b == nil { return nil } copiedBytes := make([]byte, len(b)) copy(copiedBytes, b) return copiedBytes } func (s *KvServer) StateChanges(req *remote.StateChangeRequest, server remote.KV_StateChangesServer) error { ch, remove := s.stateChangeStreams.Sub() defer remove() for { select { case reply := <-ch: if err := server.Send(reply); err != nil { return err } case <-s.ctx.Done(): return nil case <-server.Context().Done(): return nil } } } func (s *KvServer) SendStateChanges(ctx context.Context, sc *remote.StateChangeBatch) { s.stateChangeStreams.Pub(sc) } func (s *KvServer) Snapshots(ctx context.Context, _ *remote.SnapshotsRequest) (*remote.SnapshotsReply, error) { if s.blockSnapshots == nil || reflect.ValueOf(s.blockSnapshots).IsNil() { // nolint return &remote.SnapshotsReply{Files: []string{}}, nil } return &remote.SnapshotsReply{Files: s.blockSnapshots.Files()}, nil } type StateChangePubSub struct { chans map[uint]chan *remote.StateChangeBatch id uint mu sync.RWMutex } func newStateChangeStreams() *StateChangePubSub { return &StateChangePubSub{} } func (s *StateChangePubSub) Sub() (ch chan *remote.StateChangeBatch, remove func()) { s.mu.Lock() defer s.mu.Unlock() if s.chans == nil { s.chans = make(map[uint]chan *remote.StateChangeBatch) } s.id++ id := s.id ch = make(chan *remote.StateChangeBatch, 8) s.chans[id] = ch return ch, func() { s.remove(id) } } func (s *StateChangePubSub) Pub(reply *remote.StateChangeBatch) { s.mu.RLock() defer s.mu.RUnlock() for _, ch := range s.chans { common.PrioritizedSend(ch, reply) } } func (s *StateChangePubSub) Len() int { s.mu.RLock() defer s.mu.RUnlock() return len(s.chans) } func (s *StateChangePubSub) remove(id uint) { s.mu.Lock() defer s.mu.Unlock() ch, ok := s.chans[id] if !ok { // double-unsubscribe support return } close(ch) delete(s.chans, id) } // Temporal methods func (s *KvServer) HistoryGet(ctx context.Context, req *remote.HistoryGetReq) (reply *remote.HistoryGetReply, err error) { reply = &remote.HistoryGetReply{} if err := s.with(req.TxID, func(tx kv.Tx) error { ttx, ok := tx.(kv.TemporalTx) if !ok { return fmt.Errorf("server DB doesn't implement kv.Temporal interface") } reply.V, reply.Ok, err = ttx.HistoryGet(kv.History(req.Table), req.K, req.Ts) if err != nil { return err } return nil }); err != nil { return nil, err } return reply, nil } func (s *KvServer) IndexRange(req *remote.IndexRangeReq, stream remote.KV_IndexRangeServer) error { const step = 4096 // make sure `s.with` has limited time for from := req.FromTs; from < req.ToTs; from += step { to := cmp.Min(req.ToTs, from+step) if err := s.with(req.TxID, func(tx kv.Tx) error { ttx, ok := tx.(kv.TemporalTx) if !ok { return fmt.Errorf("server DB doesn't implement kv.Temporal interface") } it, err := ttx.IndexRange(kv.InvertedIdx(req.Table), req.K, from, to) if err != nil { return err } for it.HasNext() { batch, err := it.NextBatch() if err != nil { return err } if err := stream.Send(&remote.IndexRangeReply{Timestamps: slices.Clone(batch)}); err != nil { return err } } return nil }); err != nil { return err } } return nil } func (s *KvServer) Range(req *remote.RangeReq, stream remote.KV_RangeServer) error { if req.ToPrefix != nil && bytes.Compare(req.FromPrefix, req.ToPrefix) >= 0 { return fmt.Errorf("tx.Range: %x must be lexicographicaly before %x", req.FromPrefix, req.ToPrefix) } var k, v []byte if req.FromPrefix == nil { req.FromPrefix = []byte{} } const step = 1024 // make sure `s.with` has limited time for from := req.FromPrefix; from != nil; from = k { if req.ToPrefix != nil && bytes.Compare(from, req.ToPrefix) >= 0 { break } resp := &remote.Pairs{} if err := s.with(req.TxID, func(tx kv.Tx) error { c, err := tx.Cursor(req.Table) if err != nil { return err } defer c.Close() i := 0 for k, v, err = c.Seek(from); k != nil; k, v, err = c.Next() { if err != nil { return err } if req.ToPrefix != nil && bytes.Compare(k, req.ToPrefix) >= 0 { break } resp.Keys = append(resp.Keys, k) resp.Values = append(resp.Values, v) i++ if i > step { break } } k = common.Copy(k) return nil }); err != nil { return err } if len(resp.Keys) > 0 { if err := stream.Send(resp); err != nil { return err } } } return nil }