Re: [PATCH net-next v7 4/4] test/vsock: vsock_perf utility

[Arseniy Krasnov <AVKrasnov@sberdevices.ru>]

On 12.01.2023 14:53, Paolo Abeni wrote:
> On Tue, 2023-01-10 at 10:18 +0000, Arseniy Krasnov wrote:
>> This adds utility to check vsock rx/tx performance.
>>
>> Usage as sender:
>> ./vsock_perf --sender <cid> --port <port> --bytes <bytes to send>
>> Usage as receiver:
>> ./vsock_perf --port <port> --rcvlowat <SO_RCVLOWAT>
>>
>> Signed-off-by: Arseniy Krasnov <AVKrasnov@sberdevices.ru>
>> ---
>>  tools/testing/vsock/Makefile     |   3 +-
>>  tools/testing/vsock/README       |  34 +++
>>  tools/testing/vsock/vsock_perf.c | 427 +++++++++++++++++++++++++++++++
>>  3 files changed, 463 insertions(+), 1 deletion(-)
>>  create mode 100644 tools/testing/vsock/vsock_perf.c
>>
>> diff --git a/tools/testing/vsock/Makefile b/tools/testing/vsock/Makefile
>> index f8293c6910c9..43a254f0e14d 100644
>> --- a/tools/testing/vsock/Makefile
>> +++ b/tools/testing/vsock/Makefile
>> @@ -1,8 +1,9 @@
>>  # SPDX-License-Identifier: GPL-2.0-only
>> -all: test
>> +all: test vsock_perf
>>  test: vsock_test vsock_diag_test
>>  vsock_test: vsock_test.o timeout.o control.o util.o
>>  vsock_diag_test: vsock_diag_test.o timeout.o control.o util.o
>> +vsock_perf: vsock_perf.o
>>  
>>  CFLAGS += -g -O2 -Werror -Wall -I. -I../../include -I../../../usr/include -Wno-pointer-sign -fno-strict-overflow -fno-strict-aliasing -fno-common -MMD -U_FORTIFY_SOURCE -D_GNU_SOURCE
>>  .PHONY: all test clean
>> diff --git a/tools/testing/vsock/README b/tools/testing/vsock/README
>> index 4d5045e7d2c3..84ee217ba8ee 100644
>> --- a/tools/testing/vsock/README
>> +++ b/tools/testing/vsock/README
>> @@ -35,3 +35,37 @@ Invoke test binaries in both directions as follows:
>>                         --control-port=$GUEST_IP \
>>                         --control-port=1234 \
>>                         --peer-cid=3
>> +
>> +vsock_perf utility
>> +-------------------
>> +'vsock_perf' is a simple tool to measure vsock performance. It works in
>> +sender/receiver modes: sender connect to peer at the specified port and
>> +starts data transmission to the receiver. After data processing is done,
>> +it prints several metrics(see below).
>> +
>> +Usage:
>> +# run as sender
>> +# connect to CID 2, port 1234, send 1G of data, tx buf size is 1M
>> +./vsock_perf --sender 2 --port 1234 --bytes 1G --buf-size 1M
>> +
>> +Output:
>> +tx performance: A Gbits/s
>> +
>> +Output explanation:
>> +A is calculated as "number of bits to send" / "time in tx loop"
>> +
>> +# run as receiver
>> +# listen port 1234, rx buf size is 1M, socket buf size is 1G, SO_RCVLOWAT is 64K
>> +./vsock_perf --port 1234 --buf-size 1M --vsk-size 1G --rcvlowat 64K
>> +
>> +Output:
>> +rx performance: A Gbits/s
>> +total in 'read()': B sec
>> +POLLIN wakeups: C
>> +average in 'read()': D ns
>> +
>> +Output explanation:
>> +A is calculated as "number of received bits" / "time in rx loop".
>> +B is time, spent in 'read()' system call(excluding 'poll()')
>> +C is number of 'poll()' wake ups with POLLIN bit set.
>> +D is B / C, e.g. average amount of time, spent in single 'read()'.
>> diff --git a/tools/testing/vsock/vsock_perf.c b/tools/testing/vsock/vsock_perf.c
>> new file mode 100644
>> index 000000000000..a72520338f84
>> --- /dev/null
>> +++ b/tools/testing/vsock/vsock_perf.c
>> @@ -0,0 +1,427 @@
>> +// SPDX-License-Identifier: GPL-2.0-only
>> +/*
>> + * vsock_perf - benchmark utility for vsock.
>> + *
>> + * Copyright (C) 2022 SberDevices.
>> + *
>> + * Author: Arseniy Krasnov <AVKrasnov@sberdevices.ru>
>> + */
>> +#include <getopt.h>
>> +#include <stdio.h>
>> +#include <stdlib.h>
>> +#include <stdbool.h>
>> +#include <string.h>
>> +#include <errno.h>
>> +#include <unistd.h>
>> +#include <time.h>
>> +#include <stdint.h>
>> +#include <poll.h>
>> +#include <sys/socket.h>
>> +#include <linux/vm_sockets.h>
>> +
>> +#define DEFAULT_BUF_SIZE_BYTES	(128 * 1024)
>> +#define DEFAULT_TO_SEND_BYTES	(64 * 1024)
>> +#define DEFAULT_VSOCK_BUF_BYTES (256 * 1024)
>> +#define DEFAULT_RCVLOWAT_BYTES	1
>> +#define DEFAULT_PORT		1234
>> +
>> +#define BYTES_PER_GB		(1024 * 1024 * 1024ULL)
>> +#define NSEC_PER_SEC		(1000000000ULL)
>> +
>> +static unsigned int port = DEFAULT_PORT;
>> +static unsigned long buf_size_bytes = DEFAULT_BUF_SIZE_BYTES;
>> +static unsigned long vsock_buf_bytes = DEFAULT_VSOCK_BUF_BYTES;
>> +
>> +static void error(const char *s)
>> +{
>> +	perror(s);
>> +	exit(EXIT_FAILURE);
>> +}
> 
> For the records, I suggested to use the existing error() libcall, see
> man 3 error.
> 
> Not a big deal. This can be merged as-is, and you can follow-up, it you
> find it useful.

Ahhhhh, I see, thanks!

Thanks, Arseniy

> 
> Cheers,
> 
> Paolo
>