bench: add the ability to set a load profile

Patch for benchmark tool with load profile and space pre-filling.

Added:
- Flag "insert" - percentage of insert operations to bench space.
- Flag "select" - percentage of select operations from bench space.
- Flag "update" - percentage of update operations in bench space.
- Flag "fill" - number of records to pre-fill the space.

```
user@cartridge-cli % ./cartridge bench --select=30 --update=30 --insert=40 --fill=100000
Tarantool 2.8.3 (Binary) f4897ffe-98dd-40fc-a6f2-21ca8bb52fe7

Parameters:
        URL: 127.0.0.1:3301
        user: guest
        connections: 10
        simultaneous requests: 10
        duration: 10 seconds
        key size: 10 bytes
        data size: 20 bytes
        insert: 40 percentages
        select: 30 percentages
        update: 30 percentages

Data schema
| key                            | value
| ------------------------------ | ------------------------------
| random(10)                     | random(20)

The pre-filling of the space has started,
because the insert operation is not specified
or there was an explicit instruction for pre-filling.
...
Pre-filling is finished. Number of records: 100000

Benchmark start.
...
Benchmark stop.

Results:
        Success operations: 1332979
        Failed  operations: 0
        Request count: 1334004
        Time (seconds): 10.000733
        Requests per second: 133390
```

Part of tarantool#645

Author: Kirill-Churkin

CHANGELOG.md

@@ -11,6 +11,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Updated `cartridge` to `2.7.4` and `metrics` to `0.13.0` in application template.
 
+### Added
+
+- Tarantool benchmark tool update (select and update operations):
+  * option --insert has been added - sets percentage of insert operations to bench space.
+  * option --select has been added - sets percentage of select operations from bench space.
+  * option --update has been added - sets percentage of update operations in bench space.
+  * option --fill" has been added - sets number of records to pre-fill the space.
+
 ## [2.12.1] - 2022-05-26
 
 ### Changed

cli/bench/bench.go

@@ -8,7 +8,6 @@ import (
 	"time"
 
 	"github.com/FZambia/tarantool"
-	"github.com/tarantool/cartridge-cli/cli/common"
 	"github.com/tarantool/cartridge-cli/cli/context"
 )
 
@@ -22,14 +21,25 @@ func printResults(results Results) {
 	fmt.Printf("\tRequests per second: %d\n\n", results.requestsPerSecond)
 }
 
+// verifyOperationsPercentage checks that the amount of operations percentage is 100.
+func verifyOperationsPercentage(ctx *context.BenchCtx) error {
+	entire_percentage := ctx.InsertCount + ctx.SelectCount + ctx.UpdateCount
+	if entire_percentage != 100 {
+		return fmt.Errorf(
+			"The number of operations as a percentage should be equal to 100, " +
+				"note that by default the percentage of inserts is 100")
+	}
+	return nil
+}
+
 // spacePreset prepares space for a benchmark.
 func spacePreset(ctx context.BenchCtx, tarantoolConnection *tarantool.Connection) error {
 	dropBenchmarkSpace(tarantoolConnection)
 	return createBenchmarkSpace(tarantoolConnection)
 }
 
 // incrementRequest increases the counter of successful/failed requests depending on the presence of an error.
-func incrementRequest(err error, results *Results) {
+func (results *Results) incrementRequestsCounters(err error) {
 	if err == nil {
 		results.successResultCount++
 	} else {
@@ -39,39 +49,62 @@ func incrementRequest(err error, results *Results) {
 }
 
 // requestsLoop continuously executes the insert query until the benchmark time runs out.
-func requestsLoop(ctx context.BenchCtx, tarantoolConnection *tarantool.Connection, results *Results, backgroundCtx bctx.Context) {
+func requestsLoop(requestsSequence *RequestsSequence, backgroundCtx bctx.Context) {
 	for {
 		select {
 		case <-backgroundCtx.Done():
 			return
 		default:
-			_, err := tarantoolConnection.Exec(
-				tarantool.Insert(
-					benchSpaceName,
-					[]interface{}{common.RandomString(ctx.KeySize), common.RandomString(ctx.DataSize)}))
-			incrementRequest(err, results)
+			request := requestsSequence.getNext()
+			request.operation(&request)
 		}
 	}
 }
 
-// connectionLoop runs "ctx.SimultaneousRequests" requests execution threads through the same connection.
-func connectionLoop(ctx context.BenchCtx, tarantoolConnection *tarantool.Connection, results *Results, backgroundCtx bctx.Context) {
+// connectionLoop runs "ctx.SimultaneousRequests" requests execution goroutines
+// through the same connection.
+func connectionLoop(
+	ctx *context.BenchCtx,
+	requestsSequence *RequestsSequence,
+	backgroundCtx bctx.Context,
+) {
 	var connectionWait sync.WaitGroup
 	for i := 0; i < ctx.SimultaneousRequests; i++ {
 		connectionWait.Add(1)
 		go func() {
 			defer connectionWait.Done()
-			requestsLoop(ctx, tarantoolConnection, results, backgroundCtx)
+			requestsLoop(requestsSequence, backgroundCtx)
 		}()
 	}
 
 	connectionWait.Wait()
 }
 
+// preFillBenchmarkSpaceIfRequired fills benchmark space
+// if insert count = 0 or PreFillingCount flag is explicitly specified.
+func preFillBenchmarkSpaceIfRequired(ctx context.BenchCtx, connectionPool []*tarantool.Connection) error {
+	if ctx.InsertCount == 0 || ctx.PreFillingCount != PreFillingCount {
+		fmt.Println("\nThe pre-filling of the space has started,\n" +
+			"because the insert operation is not specified\n" +
+			"or there was an explicit instruction for pre-filling.")
+		fmt.Println("...")
+		filledCount, err := fillBenchmarkSpace(ctx, connectionPool)
+		if err != nil {
+			return err
+		}
+		fmt.Printf("Pre-filling is finished. Number of records: %d\n\n", filledCount)
+	}
+	return nil
+}
+
 // Main benchmark function.
 func Run(ctx context.BenchCtx) error {
 	rand.Seed(time.Now().UnixNano())
 
+	if err := verifyOperationsPercentage(&ctx); err != nil {
+		return err
+	}
+
 	// Connect to tarantool and preset space for benchmark.
 	tarantoolConnection, err := tarantool.Connect(ctx.URL, tarantool.Opts{
 		User:     ctx.User,
@@ -103,6 +136,10 @@ func Run(ctx context.BenchCtx) error {
 		defer connectionPool[i].Close()
 	}
 
+	if err := preFillBenchmarkSpaceIfRequired(ctx, connectionPool); err != nil {
+		return err
+	}
+
 	fmt.Println("Benchmark start")
 	fmt.Println("...")
 
@@ -119,7 +156,41 @@ func Run(ctx context.BenchCtx) error {
 		waitGroup.Add(1)
 		go func(connection *tarantool.Connection) {
 			defer waitGroup.Done()
-			connectionLoop(ctx, connection, &results, backgroundCtx)
+			requestsSequence := RequestsSequence{
+				[]RequestsGenerator{
+					{
+						Request{
+							insertOperation,
+							ctx,
+							connection,
+							&results,
+						},
+						ctx.InsertCount,
+					},
+					{
+						Request{
+							selectOperation,
+							ctx,
+							connection,
+							&results,
+						},
+						ctx.SelectCount,
+					},
+					{
+						Request{
+							updateOperation,
+							ctx,
+							connection,
+							&results,
+						},
+						ctx.UpdateCount,
+					},
+				},
+				0,
+				ctx.InsertCount,
+				sync.Mutex{},
+			}
+			connectionLoop(&ctx, &requestsSequence, backgroundCtx)
 		}(connectionPool[i])
 	}
 	// Sends "signal" to all "connectionLoop" and waits for them to complete.

cli/bench/config.go

@@ -12,6 +12,12 @@ import (
 var (
 	benchSpaceName             = "__benchmark_space__"
 	benchSpacePrimaryIndexName = "__bench_primary_key__"
+	PreFillingCount            = 1000000
+	getRandomTupleCommand      = fmt.Sprintf(
+		"box.space.%s.index.%s:random",
+		benchSpaceName,
+		benchSpacePrimaryIndexName,
+	)
 )
 
 // printConfig output formatted config parameters.
@@ -25,6 +31,10 @@ func printConfig(ctx context.BenchCtx, tarantoolConnection *tarantool.Connection
 	fmt.Printf("\tduration: %d seconds\n", ctx.Duration)
 	fmt.Printf("\tkey size: %d bytes\n", ctx.KeySize)
 	fmt.Printf("\tdata size: %d bytes\n", ctx.DataSize)
+	fmt.Printf("\tinsert: %d percentages\n", ctx.InsertCount)
+	fmt.Printf("\tselect: %d percentages\n", ctx.SelectCount)
+	fmt.Printf("\tupdate: %d percentages\n\n", ctx.UpdateCount)
+
 	fmt.Printf("Data schema\n")
 	w := tabwriter.NewWriter(os.Stdout, 1, 1, 1, ' ', 0)
 	fmt.Fprintf(w, "|\tkey\t|\tvalue\n")

cli/bench/requests.go

@@ -0,0 +1,73 @@
+package bench
+
+import (
+	"math/rand"
+	"reflect"
+
+	"github.com/FZambia/tarantool"
+	"github.com/tarantool/cartridge-cli/cli/common"
+)
+
+// insertOperation execute insert operation.
+func insertOperation(request *Request) {
+	_, err := request.tarantoolConnection.Exec(
+		tarantool.Insert(
+			benchSpaceName,
+			[]interface{}{
+				common.RandomString(request.ctx.KeySize),
+				common.RandomString(request.ctx.DataSize),
+			}))
+	request.results.incrementRequestsCounters(err)
+}
+
+// selectOperation execute select operation.
+func selectOperation(request *Request) {
+	_, err := request.tarantoolConnection.Exec(tarantool.Call(
+		getRandomTupleCommand,
+		[]interface{}{rand.Int()}))
+	request.results.incrementRequestsCounters(err)
+}
+
+// updateOperation execute update operation.
+func updateOperation(request *Request) {
+	getRandomTupleResponse, err := request.tarantoolConnection.Exec(
+		tarantool.Call(getRandomTupleCommand,
+			[]interface{}{rand.Int()}))
+	if err == nil {
+		data := getRandomTupleResponse.Data
+		if len(data) > 0 {
+			key := reflect.ValueOf(data[0]).Index(0).Elem().String()
+			_, err := request.tarantoolConnection.Exec(
+				tarantool.Update(
+					benchSpaceName,
+					benchSpacePrimaryIndexName,
+					[]interface{}{key},
+					[]tarantool.Op{tarantool.Op(
+						tarantool.OpAssign(
+							2,
+							common.RandomString(request.ctx.DataSize)))}))
+			request.results.incrementRequestsCounters(err)
+		}
+	}
+}
+
+// getNext return next operation in operations sequence.
+func (requestsSequence *RequestsSequence) getNext() Request {
+	// If at the moment the number of remaining requests = 0,
+	// then find a new generator, which requests count > 0.
+	// If new generator has requests count = 0, then repeat.
+	requestsSequence.findNewRequestsGeneratorMutex.Lock()
+	defer requestsSequence.findNewRequestsGeneratorMutex.Unlock()
+	for requestsSequence.currentCounter == 0 {
+		// Increase the index, which means logical switching to a new generator.
+		requestsSequence.currentRequestIndex++
+		requestsSequence.currentRequestIndex %= len(requestsSequence.requests)
+		// Get new generator by index.
+		nextRequestsGenerator := requestsSequence.requests[requestsSequence.currentRequestIndex]
+		// Get requests count for new operation.
+		requestsSequence.currentCounter = nextRequestsGenerator.count
+	}
+	// Logical taking of a single request.
+	requestsSequence.currentCounter--
+	return requestsSequence.requests[requestsSequence.currentRequestIndex].request
+}

cli/bench/space.go

@@ -1,10 +1,14 @@
 package bench
 
 import (
+	bctx "context"
 	"fmt"
 	"reflect"
+	"sync"
 
 	"github.com/FZambia/tarantool"
+	"github.com/tarantool/cartridge-cli/cli/common"
+	"github.com/tarantool/cartridge-cli/cli/context"
 )
 
 // createBenchmarkSpace creates benchmark space with formatting and primary index.
@@ -54,3 +58,81 @@ func dropBenchmarkSpace(tarantoolConnection *tarantool.Connection) error {
 	}
 	return nil
 }
+
+// fillBenchmarkSpace fills benchmark space with a PreFillingCount number of records
+// using connectionPool for fast filling.
+func fillBenchmarkSpace(ctx context.BenchCtx, connectionPool []*tarantool.Connection) (int, error) {
+	var insertMutex sync.Mutex
+	var waitGroup sync.WaitGroup
+	filledCount := 0
+	errorChan := make(chan error, ctx.Connections)
+	backgroundCtx, cancel := bctx.WithCancel(bctx.Background())
+
+	for i := 0; i < ctx.Connections; i++ {
+		waitGroup.Add(1)
+		go func(tarantoolConnection *tarantool.Connection) {
+			defer waitGroup.Done()
+			for filledCount < ctx.PreFillingCount && len(errorChan) == 0 {
+				select {
+				case <-backgroundCtx.Done():
+					return
+				default:
+					// Lock mutex for checking extra iteration and increment counter.
+					insertMutex.Lock()
+					if filledCount == ctx.PreFillingCount {
+						insertMutex.Unlock()
+						return
+					}
+					filledCount++
+					insertMutex.Unlock()
+					_, err := tarantoolConnection.Exec(tarantool.Insert(
+						benchSpaceName,
+						[]interface{}{
+							common.RandomString(ctx.KeySize),
+							common.RandomString(ctx.DataSize),
+						},
+					))
+					if err != nil {
+						fmt.Println(err)
+						errorChan <- err
+						return
+					}
+				}
+			}
+		}(connectionPool[i])
+	}
+
+	// Goroutine for checking error in channel.
+	go func() {
+		for {
+			select {
+			case <-backgroundCtx.Done():
+				return
+			default:
+				if len(errorChan) > 0 {
+					// Stop "insert" goroutines.
+					cancel()
+					return
+				}
+			}
+		}
+	}()
+
+	waitGroup.Wait()
+	// Stop all goroutines.
+	// If "error" goroutine stopped others "insert" goroutines, "error" goroutine stops itself.
+	// If "insert" goroutine successfully completed, then need to stop "error" goroutine.
+	cancel()
+
+	// Check if we have an error.
+	if len(errorChan) > 0 {
+		err := <-errorChan
+		close(errorChan)
+		return filledCount, fmt.Errorf(
+			"Error during space pre-filling: %s.",
+			err.Error())
+	}
+	close(errorChan)
+
+	return filledCount, nil
+}