On 21.11.2022 18:28, Stefano Garzarella wrote:

On Tue, Nov 15, 2022 at 08:54:05PM +0000, Arseniy Krasnov wrote:

quoted

This adds utility to check vsock receive performance.

A small example on how to use it here in the commit message would be nice.

quoted

Signed-off-by: Arseniy Krasnov <redacted>
---
tools/testing/vsock/Makefile     |   1 +

Please, can you also update tools/testing/vsock/README ?

quoted

tools/testing/vsock/vsock_perf.c | 386 +++++++++++++++++++++++++++++++
2 files changed, 387 insertions(+)
create mode 100644 tools/testing/vsock/vsock_perf.c

diff --git a/tools/testing/vsock/Makefile b/tools/testing/vsock/Makefile
index f8293c6910c9..d36fdd59fe2e 100644
--- a/tools/testing/vsock/Makefile
+++ b/tools/testing/vsock/Makefile

@@ -3,6 +3,7 @@ all: test

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/vsock_perf.c b/tools/testing/vsock/vsock_perf.c
new file mode 100644
index 000000000000..ca7af08dca46
--- /dev/null
+++ b/tools/testing/vsock/vsock_perf.c

@@ -0,0 +1,386 @@
+// 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 <sys/mman.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)

checkpatch suggests to put spaces around '*' (e.g. 128 * 1024)

quoted

+#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 inline time_t current_nsec(void)
+{
+    struct timespec ts;
+
+    if (clock_gettime(CLOCK_REALTIME, &ts)) {
+        perror("clock_gettime");
+        exit(EXIT_FAILURE);
+    }
+
+    return (ts.tv_sec * NSEC_PER_SEC) + ts.tv_nsec;
+}
+
+/* From lib/cmdline.c. */
+static unsigned long memparse(const char *ptr)
+{
+    char *endptr;
+
+    unsigned long long ret = strtoull(ptr, &endptr, 0);
+
+    switch (*endptr) {
+    case 'E':
+    case 'e':
+        ret <<= 10;
+    case 'P':
+    case 'p':
+        ret <<= 10;
+    case 'T':
+    case 't':
+        ret <<= 10;
+    case 'G':
+    case 'g':
+        ret <<= 10;
+    case 'M':
+    case 'm':
+        ret <<= 10;
+    case 'K':
+    case 'k':
+        ret <<= 10;
+        endptr++;
+    default:
+        break;
+    }
+
+    return ret;
+}
+
+static void vsock_increase_buf_size(int fd)
+{
+    if (setsockopt(fd, AF_VSOCK, SO_VM_SOCKETS_BUFFER_MAX_SIZE,
+               &vsock_buf_bytes, sizeof(vsock_buf_bytes))) {
+        perror("setsockopt");
+        exit(EXIT_FAILURE);
+    }
+
+    if (setsockopt(fd, AF_VSOCK, SO_VM_SOCKETS_BUFFER_SIZE,
+               &vsock_buf_bytes, sizeof(vsock_buf_bytes))) {
+        perror("setsockopt");
+        exit(EXIT_FAILURE);
+    }
+}
+
+static int vsock_connect(unsigned int cid, unsigned int port)
+{
+    union {
+        struct sockaddr sa;
+        struct sockaddr_vm svm;
+    } addr = {
+        .svm = {
+            .svm_family = AF_VSOCK,
+            .svm_port = port,
+            .svm_cid = cid,
+        },
+    };
+    int fd;
+
+    fd = socket(AF_VSOCK, SOCK_STREAM, 0);
+
+    if (fd < 0)
+        return -1;
+
+    vsock_increase_buf_size(fd);
+
+    if (connect(fd, &addr.sa, sizeof(addr.svm)) < 0) {
+        close(fd);
+        return -1;
+    }
+
+    return fd;
+}
+
+static float get_gbps(unsigned long bytes, time_t ns_delta)
+{
+    return ((float)bytes / BYTES_PER_GB) /
+           ((float)ns_delta / NSEC_PER_SEC);
+}
+
+static void run_sender(unsigned long to_send_bytes)
+{
+    time_t tx_begin_ns;
+    size_t total_send;
+    int client_fd;
+    char *data;
+    int fd;
+    union {
+        struct sockaddr sa;
+        struct sockaddr_vm svm;
+    } addr = {
+        .svm = {
+            .svm_family = AF_VSOCK,
+            .svm_port = port,
+            .svm_cid = VMADDR_CID_ANY,
+        },
+    };
+    union {
+        struct sockaddr sa;
+        struct sockaddr_vm svm;
+    } clientaddr;
+
+    socklen_t clientaddr_len = sizeof(clientaddr.svm);
+
+    fprintf(stderr, "Run as sender\n");
+    fprintf(stderr, "Listen port %u\n", port);
+    fprintf(stderr, "Send %lu bytes\n", to_send_bytes);
+    fprintf(stderr, "TX buffer %lu bytes\n", buf_size_bytes);
+    fprintf(stderr, "Peer buffer %lu bytes\n", vsock_buf_bytes);

Why using stderr for this prints?

Also in other places, I think we can use stdout for this kind on prints.

quoted

+
+    fd = socket(AF_VSOCK, SOCK_STREAM, 0);
+
+    if (fd < 0) {
+        perror("socket");
+        exit(EXIT_FAILURE);
+    }
+
+    if (bind(fd, &addr.sa, sizeof(addr.svm)) < 0) {
+        perror("bind");
+        exit(EXIT_FAILURE);
+    }
+
+    if (listen(fd, 1) < 0) {
+        perror("listen");
+        exit(EXIT_FAILURE);
+    }
+
+    client_fd = accept(fd, &clientaddr.sa, &clientaddr_len);
+
+    if (client_fd < 0) {
+        perror("accept");
+        exit(EXIT_FAILURE);
+    }
+
+    vsock_increase_buf_size(client_fd);
+
+    data = malloc(buf_size_bytes);
+
+    if (!data) {
+        fprintf(stderr, "malloc failed\n");
+        exit(EXIT_FAILURE);
+    }
+
+    memset(data, 0, buf_size_bytes);
+    total_send = 0;
+    tx_begin_ns = current_nsec();
+
+    while (total_send < to_send_bytes) {
+        ssize_t sent;
+
+        sent = write(client_fd, data, buf_size_bytes);
+
+        if (sent <= 0) {
+            perror("write");
+            exit(EXIT_FAILURE);
+        }
+
+        total_send += sent;
+    }
+
+    fprintf(stderr, "tx performance: %f Gb/s\n",
+            get_gbps(total_send, current_nsec() - tx_begin_ns));

checkpatch suggests to align get_gbps with the open parenthesis.

quoted

+
+    close(client_fd);
+    close(fd);
+
+    free(data);
+}
+
+static void run_receiver(int peer_cid, unsigned long rcvlowat_bytes)
+{
+    unsigned int read_cnt;
+    time_t rx_begin_ns;
+    time_t in_read_ns;
+    size_t total_recv;
+    void *data;
+    int fd;
+
+    fprintf(stderr, "Run as receiver\n");
+    fprintf(stderr, "Connect to %i:%u\n", peer_cid, port);
+    fprintf(stderr, "RX buffer %lu bytes\n", buf_size_bytes);
+    fprintf(stderr, "Peer buffer %lu bytes\n", vsock_buf_bytes);
+    fprintf(stderr, "SO_RCVLOWAT %lu bytes\n", rcvlowat_bytes);
+
+    fd = vsock_connect(peer_cid, port);
+
+    if (fd < 0) {
+        perror("socket");
+        exit(EXIT_FAILURE);
+    }
+
+    if (setsockopt(fd, SOL_SOCKET, SO_RCVLOWAT,
+               &rcvlowat_bytes,
+               sizeof(rcvlowat_bytes))) {
+        perror("setsockopt");
+        exit(EXIT_FAILURE);
+    }
+
+    data = mmap(NULL, buf_size_bytes, PROT_READ | PROT_WRITE,
+            MAP_ANONYMOUS | MAP_PRIVATE | MAP_POPULATE, -1, 0);
+
+    if (data == MAP_FAILED) {
+        perror("mmap");
+        exit(EXIT_FAILURE);
+    }
+
+    read_cnt = 0;
+    in_read_ns = 0;
+    total_recv = 0;
+    rx_begin_ns = current_nsec();
+
+    while (1) {
+        struct pollfd fds = { 0 };
+
+        fds.fd = fd;
+        fds.events = POLLIN | POLLERR | POLLHUP |
+                 POLLRDHUP | POLLNVAL;
+
+        if (poll(&fds, 1, -1) < 0) {
+            perror("poll");
+            exit(EXIT_FAILURE);
+        }
+
+        if (fds.revents & POLLERR) {
+            fprintf(stderr, "'poll()' error\n");
+            exit(EXIT_FAILURE);
+        }
+
+        if (fds.revents & POLLIN) {
+            ssize_t bytes_read;
+            time_t t;
+
+            t = current_nsec();
+            bytes_read = read(fd, data, buf_size_bytes);
+            in_read_ns += (current_nsec() - t);
+            read_cnt++;
+
+            if (!bytes_read)
+                break;
+
+            if (bytes_read < 0) {
+                perror("recv");
+                exit(EXIT_FAILURE);
+            }
+
+            total_recv += bytes_read;
+        }
+
+        if (fds.revents & (POLLHUP | POLLRDHUP))
+            break;
+    }
+
+    fprintf(stderr, "rx performance %f Gb/s\n",
+            get_gbps(total_recv, current_nsec() - rx_begin_ns));

checkpatch suggests to align get_gbps with the open parenthesis.

quoted

+    fprintf(stderr, "total in 'read()' %f sec\n", (float)in_read_ns / NSEC_PER_SEC);
+    fprintf(stderr, "POLLIN wakeups: %i\n", read_cnt);
+    fprintf(stderr, "average in 'read()' %f ns\n", (float)in_read_ns / read_cnt);
+
+    munmap(data, buf_size_bytes);
+    close(fd);
+}
+
+static void usage(void)
+{
+    fprintf(stderr, "Help:\n"
+            "\n"
+            "This is benchmarking utility, to test vsock performance.\n"
+            "It runs in two modes: sender or receiver. In sender mode, it waits\n"
+            "connection from receiver, and when established, sender starts data\n"

quoted

+            "transmission. Total size of data to send is set by '-m' option.\n"
+            "\n"
+            "Meaning of '-b' depends of sender or receiver mode. In sender\n"
+            "mode, it is size of buffer, passed to 'write()'. In receiver mode,\n"
+            "it is size of rx buffer passed to 'read()'.\n"

This part is better to put near -b description.

quoted

+            "\n"
+            "Options:\n"
+            "  -h                This help message\n"
+            "  -s                Sender mode(receiver default)\n"
+            "  -p <port>            Port\n"
+            "  -c <cid>            CID of the peer\n"
+            "  -m <bytes to send>        Megabytes to send\n"
+            "  -b <buffer size>        Depends on sender/receiver mode\n"
+            "  -v <peer buffer size>    Peer buffer size\n"
+            "  -r <SO_RCVLOWAT>        SO_RCVLOWAT\n"

Can you print also the default values?
(e.g. "-p <port>  Port (%d)\n" ..., DEFAULT_PORT)

quoted

+            "\n");
+    exit(EXIT_FAILURE);
+}
+
+int main(int argc, char **argv)
+{
+    unsigned long to_send_bytes = DEFAULT_TO_SEND_BYTES;
+    unsigned long rcvlowat_bytes = DEFAULT_RCVLOWAT_BYTES;
+    bool receiver_mode = true;
+    int peer_cid = -1;
+    int c;
+
+    while ((c = getopt(argc, argv, "v:r:c:p:m:b:sh")) != -1) {
+        switch (c) {
+        case 'v': /* Peer buffer size. */
+            vsock_buf_bytes = memparse(optarg);
+            break;
+        case 'r': /* SO_RCVLOWAT value. */
+            rcvlowat_bytes = memparse(optarg);
+            break;
+        case 'c': /* CID to connect to. */
+            peer_cid = atoi(optarg);

Maybe better to use strtol() to check errors.

quoted

+            break;
+        case 'p': /* Port to connect to. */
+            port = atoi(optarg);
+            break;
+        case 'm': /* Bytes to send. */
+            to_send_bytes = memparse(optarg);
+            break;
+        case 'b': /* Size of rx/tx buffer. */
+            buf_size_bytes = memparse(optarg);
+            break;
+        case 's': /* Sender mode. */
+            receiver_mode = false;
+            break;
+        case 'h': /* Help. */
+            usage();
+            break;
+        default:
+            usage();
+

checkpatch: Blank lines aren't necessary before a close brace '}

Ack this and all comments above

quoted

+        }
+    }
+
+    if (receiver_mode)
+        run_receiver(peer_cid, rcvlowat_bytes);
+    else
+        run_sender(to_send_bytes);
+
+    return 0;
+}
-- 
2.25.1