Perform mvcc read validation in parallel

Signed-off-by: Liran Funaro <liran.funaro@gmail.com>

Author: liran-funaro

internal/txvalidation/data_tx_validator.go

@@ -113,7 +113,7 @@ func (v *dataTxValidator) parallelValidation(txsEnv []*types.DataTxEnvelope, use
 }
 
 func (v *dataTxValidator) validateSignatures(txEnv *types.DataTxEnvelope) ([]string, *types.ValidationInfo, error) {
-	var userIDsWithValidSign []string
+	userIDsWithValidSign := make([]string, 0, len(txEnv.Signatures))
 	for userID, signature := range txEnv.Signatures {
 		valRes, err := v.sigValidator.validate(userID, signature, txEnv.Payload)
 		if err != nil {
@@ -484,6 +484,108 @@ func (v *dataTxValidator) validateACLForWriteOrDelete(userIDs []string, dbName,
 	}, nil
 }
 
+type readCache struct {
+	dbName string
+	key    string
+	ver    *types.Version
+	err    error
+	wg     sync.WaitGroup
+}
+
+func (v *dataTxValidator) parallelReadMvccValidation(
+	valInfoArray []*types.ValidationInfo, dataTxEnvs []*types.DataTxEnvelope,
+) error {
+	reads := make(map[string]map[string]*readCache)
+	errorChan := make(chan error)
+
+	// Submit a "get-version" Go routine for each key in the envelope.
+	// We avoid reading the same key twice.
+	for txNum, txEnv := range dataTxEnvs {
+		if valInfoArray[txNum].Flag != types.Flag_VALID {
+			continue
+		}
+		for _, txOps := range txEnv.Payload.DbOperations {
+			dbName := txOps.DbName
+			dbReads, ok := reads[dbName]
+			if !ok {
+				dbReads = make(map[string]*readCache)
+				reads[dbName] = dbReads
+			}
+
+			for _, r := range txOps.DataReads {
+				key := r.Key
+				if _, ok := dbReads[key]; ok {
+					continue
+				}
+
+				c := &readCache{
+					dbName: dbName,
+					key:    key,
+				}
+				c.wg.Add(1)
+				dbReads[key] = c
+				go func(txNum int, c *readCache) {
+					defer c.wg.Done()
+					c.ver, c.err = v.db.GetVersion(c.dbName, c.key)
+					if c.err != nil {
+						v.logger.Errorf("error validating signatures in tx number %d, error: %s", txNum, c.err)
+						defer func() {
+							// Ignore panic when errorChan is closed
+							recover()
+						}()
+						errorChan <- c.err
+					}
+				}(txNum, c)
+			}
+		}
+	}
+
+	// Submit a "validation" Go routine for read operation in the envelope.
+	wg := sync.WaitGroup{}
+	for txNum, txEnv := range dataTxEnvs {
+		for _, txOps := range txEnv.Payload.DbOperations {
+			for _, r := range txOps.DataReads {
+				if valInfoArray[txNum].Flag != types.Flag_VALID {
+					continue
+				}
+
+				wg.Add(1)
+				go func(txNum int, c *readCache, expectedVer *types.Version) {
+					defer wg.Done()
+					if c == nil {
+						panic("all reads keys should be in the map")
+					}
+
+					c.wg.Wait()
+					if valInfoArray[txNum].Flag != types.Flag_VALID || c.err != nil {
+						return
+					}
+					if proto.Equal(expectedVer, c.ver) {
+						return
+					}
+					valInfoArray[txNum] = &types.ValidationInfo{
+						Flag:            types.Flag_INVALID_MVCC_CONFLICT_WITH_COMMITTED_STATE,
+						ReasonIfInvalid: "mvcc conflict has occurred as the committed state for the key [" + c.key + "] in database [" + c.dbName + "] changed",
+					}
+				}(txNum, reads[txOps.DbName][r.Key], r.Version)
+			}
+		}
+	}
+
+	// Wait for all the validation routines to end.
+	go func() {
+		wg.Wait()
+		// Inject nil to make sure we have data to read from the channel if no error occurred.
+		errorChan <- nil
+	}()
+
+	select {
+	case err := <-errorChan:
+		close(errorChan)
+		return err
+	}
+}
+
 func (v *dataTxValidator) mvccValidation(dbName string, txOps *types.DBOperation, pendingOps *pendingOperations) (*types.ValidationInfo, error) {
 	for _, r := range txOps.DataReads {
 		if pendingOps.exist(dbName, r.Key) {
@@ -532,3 +634,38 @@ func (v *dataTxValidator) mvccValidation(dbName string, txOps *types.DBOperation
 		Flag: types.Flag_VALID,
 	}, nil
 }
+
+func (v *dataTxValidator) mvccValidationPending(dbName string, txOps *types.DBOperation, pendingOps *pendingOperations) (*types.ValidationInfo, error) {
+	for _, r := range txOps.DataReads {
+		if pendingOps.exist(dbName, r.Key) {
+			return &types.ValidationInfo{
+				Flag:            types.Flag_INVALID_MVCC_CONFLICT_WITHIN_BLOCK,
+				ReasonIfInvalid: "mvcc conflict has occurred within the block for the key [" + r.Key + "] in database [" + dbName + "]",
+			}, nil
+		}
+	}
+	// as state trie generation work at the boundary of block, we cannot allow more than one write per key. This is because, the state trie
+	// generation considers only the final updates and not intermediate updates within a block boundary. As a result, we would have intermediate
+	// entries in the provenance store but cannot generate proof of existence for the same using the state trie. As blind writes/deletes are quite
+	// rare, we allow only one write per key within a block. In general, user reads the key before writing to it.
+	for _, w := range txOps.DataWrites {
+		if pendingOps.exist(dbName, w.Key) {
+			return &types.ValidationInfo{
+				Flag:            types.Flag_INVALID_MVCC_CONFLICT_WITHIN_BLOCK,
+				ReasonIfInvalid: "mvcc conflict has occurred within the block for the key [" + w.Key + "] in database [" + dbName + "]. Within a block, a key can be modified only once",
+			}, nil
+		}
+	}
+	for _, d := range txOps.DataDeletes {
+		if pendingOps.exist(dbName, d.Key) {
+			return &types.ValidationInfo{
+				Flag:            types.Flag_INVALID_MVCC_CONFLICT_WITHIN_BLOCK,
+				ReasonIfInvalid: "mvcc conflict has occurred within the block for the key [" + d.Key + "] in database [" + dbName + "]. Within a block, a key can be modified only once",
+			}, nil
+		}
+	}
+
+	return &types.ValidationInfo{
+		Flag: types.Flag_VALID,
+	}, nil
+}

internal/txvalidation/validator.go

@@ -91,8 +91,26 @@ func (v *Validator) ValidateBlock(block *types.Block) ([]*types.ValidationInfo,
 			return nil, err
 		}
 
-		if err = v.dataTxValidator.parallelValidation(dataTxEnvs, usersWithValidSigPerTX, valInfoArray); err != nil {
-			return nil, errors.WithMessage(err, "error while validating data transaction")
+		var wg sync.WaitGroup
+		var parallelValidErr error
+		var parallelMvccReadErr error
+		wg.Add(2)
+		go func() {
+			defer wg.Done()
+			parallelValidErr = v.dataTxValidator.parallelValidation(dataTxEnvs, usersWithValidSigPerTX, valInfoArray)
+		}()
+		go func() {
+			defer wg.Done()
+			parallelMvccReadErr = v.dataTxValidator.parallelReadMvccValidation(valInfoArray, dataTxEnvs)
+		}()
+		wg.Wait()
+
+		if parallelValidErr != nil {
+			return nil, errors.WithMessage(parallelValidErr, "error while validating data transaction")
+		}
+
+		if parallelMvccReadErr != nil {
+			return nil, errors.WithMessage(parallelMvccReadErr, "error while validating data transaction's read set")
 		}
 
 		pendingOps := newPendingOperations()
@@ -116,7 +134,7 @@ func (v *Validator) ValidateBlock(block *types.Block) ([]*types.ValidationInfo,
 
 				go func() {
 					defer wg.Done()
-					mvccValResult, mvccValError = v.dataTxValidator.mvccValidation(txOps.DbName, txOps, pendingOps)
+					mvccValResult, mvccValError = v.dataTxValidator.mvccValidationPending(txOps.DbName, txOps, pendingOps)
 				}()
 
 				wg.Wait()

internal/txvalidation/validator_test.go

@@ -15,6 +15,7 @@ import (
 	"github.com/hyperledger-labs/orion-server/pkg/logger"
 	"github.com/hyperledger-labs/orion-server/pkg/server/testutils"
 	"github.com/hyperledger-labs/orion-server/pkg/types"
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
@@ -657,7 +658,9 @@ func TestValidateDataBlock(t *testing.T) {
 
 			results, err := env.validator.ValidateBlock(tt.block)
 			require.NoError(t, err)
-			require.Equal(t, tt.expectedResults, results)
+			for i := range tt.expectedResults {
+				assert.Equal(t, tt.expectedResults[i], results[i], "index: %d", i)
+			}
 		})
 	}
 }