perf/vhost: Replace run_vhost_test.py with a simple bash wrapper

The wrapper glues execution of the perf/vhost tests in as simple form
as possible. The arguments are meant to be passed either via env or
the cmdline in a keyworded argument fashion. All defaults are
embedded inside the configuration which is built by the wrapper
itself.

https://trello.com/c/HSoRtQkO/401-deprecate-vhost-performance-python-helper-script

Signed-off-by: Michal Berger <michallinuxstuff@gmail.com>
Change-Id: Iad94bfdd65cb8871b819351ddae65e647621fb30
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12400
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Michal Berger 2022-04-27 22:06:14 +02:00 committed by Jim Harris
parent 6872c67e4f
commit 008f8a8617
3 changed files with 51 additions and 236 deletions

View File

@ -1,20 +0,0 @@
[global]
ioengine=libaio
thread=1
group_reporting=1
direct=1
verify=0
norandommap=1
[perf_test]
stonewall
description="Run NVMe driver performance test for a given workload"
bs={blksize}
rw={rw}
rwmixread={rwmixread}
iodepth={iodepth}
time_based=1
ramp_time={ramptime}
runtime={runtime}
numjobs={numjobs}
filename=

View File

@ -1,216 +0,0 @@
import os
import sys
import argparse
import multiprocessing
from subprocess import check_output
def range_incl(a, b):
return list(range(a, b + 1))
def list_spdk_used_cpus(cpus):
cpu_list = []
for chunk in cpus.split(","):
if "-" in chunk:
_ = chunk.split("-")
_ = list(map(int, _))
cpu_list.extend(list(range_incl(*_)))
else:
cpu_list.append(int(chunk))
return cpu_list
def gen_cpu_mask_config(output_dir, spdk_cpu_list, vm_count, vm_cpu_num):
spdk = gen_spdk_cpu_mask_config(spdk_cpu_list)
qemu = gen_qemu_cpu_mask_config(spdk_cpu_list, vm_count, vm_cpu_num)
file_path = os.path.join(output_dir, "mask_config")
with open(file_path, "w") as fh:
fh.write("".join([spdk, qemu]))
return file_path
def gen_spdk_cpu_mask_config(spdk_cpu_list):
cpus = "vhost_0_reactor_mask=[%s]" % (spdk_cpu_list)
# Go through assigned CPUs and use the lowest CPU index as
# default primary core
cpu_indexes = list_spdk_used_cpus(spdk_cpu_list)
cpu_indexes.sort()
print(cpu_indexes)
pr_core = "vhost_0_main_core=%s" % (cpu_indexes[0])
return "\n".join([cpus, pr_core, "\n"])
def get_host_cpus():
cpu_num = multiprocessing.cpu_count()
cpu_list = list(range(0, cpu_num))
output = check_output("lscpu | grep 'per core'", shell=True)
# Assuming 2-socket server
if "2" in str(output):
cpu_chunk = int(cpu_num/4)
numa0_cpus = cpu_list[0:cpu_chunk]
numa0_cpus.extend(cpu_list[2*cpu_chunk:3*cpu_chunk])
numa1_cpus = cpu_list[cpu_chunk:2*cpu_chunk]
numa1_cpus.extend(cpu_list[3*cpu_chunk:4*cpu_chunk])
else:
cpu_chunk = int(cpu_num/2)
numa0_cpus = cpu_list[:cpu_chunk]
numa1_cpus = cpu_list[cpu_chunk:]
return [numa0_cpus, numa1_cpus]
def gen_qemu_cpu_mask_config(spdk_cpu_list, vm_count, vm_cpu_num):
print("Creating masks for QEMU")
ret = ""
# Exclude SPDK cores from available CPU list
numa0_cpus, numa1_cpus = get_host_cpus()
spdk_cpus = list_spdk_used_cpus(spdk_cpu_list)
spdk_cpus.sort()
numa0_cpus = sorted(list(set(numa0_cpus) - set(spdk_cpus)))
numa1_cpus = sorted(list(set(numa1_cpus) - set(spdk_cpus)))
# Generate qemu cpu mask and numa param for VMs out of
# remaining free CPU cores.
# All CPUs assigned to a VM will come from the same NUMA node.
# Assuming 2 socket server.
used_numa = 0
available = numa0_cpus
for i in range(0, vm_count):
cpus = [str(x) for x in available[0:vm_cpu_num]]
# If there is not enough cores on first numa node for a VM
# then switch to next numa node
if len(cpus) < vm_cpu_num and used_numa == 0:
available = numa1_cpus
used_numa = 1
cpus = [str(x) for x in available[0:vm_cpu_num]]
# If not enough cores on second numa node - break and exit
if len(cpus) < vm_cpu_num and used_numa == 1:
print("There is not enough CPU Cores available on \
Numa node1 to create VM %s" % i)
break
cpus = ",".join(cpus)
cpus = "VM_%s_qemu_mask=%s" % (i, cpus)
numa = "VM_%s_qemu_numa_node=%s\n" % (i, used_numa)
# Remove used CPU cores from available list
available = available[vm_cpu_num:]
ret = "\n".join([ret, cpus, numa])
return ret
def create_fio_cfg(template_dir, output_dir, **kwargs):
fio_template = os.path.join(template_dir, "fio_test.conf")
with open(fio_template, "r") as fh:
cfg = fh.read()
cfg = cfg.format(**kwargs)
file_path = os.path.join(output_dir, "fio_job.cfg")
with open(file_path, "w") as fh:
fh.write(cfg)
return file_path
script_dir = os.path.dirname(os.path.abspath(sys.argv[0]))
parser = argparse.ArgumentParser()
parser.add_argument('blksize', default="4k", type=str,
help="Block size param for FIO. Default: 4k")
parser.add_argument('iodepth', default="128", type=str,
help="Iodepth param for FIO. Default: 128")
parser.add_argument('rw', default="randread", type=str,
help="RW param for FIO. Default: randread")
parser.add_argument('-m', '--rwmixread', default="70", type=str,
help="Percentage of reads in read-write mode. Default: 70")
parser.add_argument('-n', '--numjobs', default="1", type=str,
help="Numjobs value for FIO job. Default: 1")
parser.add_argument('-r', '--runtime', default="10", type=str,
help="Run time param for FIO (in seconds). Default: 10")
parser.add_argument('-R', '--ramptime', default="10", type=str,
help="Ramp time param for FIO (in seconds). Default: 10")
parser.add_argument('-c', '--ctrl-type', default="spdk_vhost_scsi", type=str,
help="Type of vhost controller to use in test.\
Possible options: spdk_vhost_scsi, spdk_vhost_blk\
Default: spdk_vhost_scsi")
parser.add_argument('-s', '--split', default=False, type=bool,
help="Use split vbdevs instead of logical volumes. Default: false")
parser.add_argument('-d', '--max-disks', default=0, type=int,
help="How many physical disks to use in test. Default: all disks.\
Depending on the number of --vm-count disks may be split into\
smaller logical bdevs (splits or logical volumes) so that\
each virtual machine gets it's own bdev to work on.")
parser.add_argument('-v', '--vm-count', default=1, type=int,
help="How many VMs to run in test. Default: 1")
parser.add_argument('-i', '--vm-image', default="$DEPENDENCY_DIR/spdk_test_image.qcow2",
type=str, help="VM image to use for running VMs.")
subparsers = parser.add_subparsers()
cpu_cfg_create = subparsers.add_parser('create_cpu_cfg',
help="Generate a CPU config file for test.\
This option will attempt to automatically\
generate config file with SPDK/QEMU cpu lists.\
CPU cores on NUMA Node 0 will be used first\
(including logical cores when HT is enabled)\
and NUMA Node 1 will be used last.")
cpu_cfg_create.add_argument('spdk_cpu_list', default=None,
help="List of CPU cores to be used by SPDK vhost app.\
Accepted format examples:\
single cpus: 0,2,4\
ranges (inclusive!): 0-2\
mixed: 0,2-5,9")
cpu_cfg_create.add_argument('vm_cpu_num', default=None, type=int)
cpu_cfg_load = subparsers.add_parser('load_cpu_cfg',
help="Load and use a CPU config file for test\
Example configuration files can be found in:\
test/vhost/common/autotest.config")
cpu_cfg_load.add_argument('custom_mask_file', default=None,
help="Path to file with custom values for vhost's\
reactor mask and main core, and each VM's qemu mask\
and qemu numa node")
args = parser.parse_args()
fio_cfg_path = create_fio_cfg(script_dir, script_dir, **vars(args))
cpu_cfg_arg = ""
disk_arg = ""
split_arg = ""
if "spdk_cpu_list" in args:
cfg_path = gen_cpu_mask_config(script_dir, args.spdk_cpu_list, args.vm_count, args.vm_cpu_num)
cpu_cfg_arg = "--custom-cpu-cfg=%s" % cfg_path
if "custom_mask_file" in args:
cpu_cfg_arg = "--custom-cpu-cfg=%s" % args.custom_mask_file
if args.split is True:
split_arg = "--use-split"
if args.max_disks > 0:
disk_arg = "--max-disks=%s" % args.max_disks
command = " ".join(["test/vhost/perf_bench/vhost_perf.sh",
"--vm-image=%s" % args.vm_image,
"--vm-count=%s" % args.vm_count,
"--ctrl-type=%s" % args.ctrl_type,
"%s" % split_arg,
"%s" % disk_arg,
"--fio-job=%s" % fio_cfg_path,
"%s" % cpu_cfg_arg])
# TODO: Disabled for now.
# Reason: initially this script was supposed to be a wrapper for .sh script and would
# - generate FIO config
# - generate SPDK/QEMU CPU mask configuration file
# - run test script
# Auto-generating CPU masks configuration needs some more work to be done
# and increasing number of params makes .py script hard to use.
# Will cleanup here soon.
# print("INFO: Running perf test with command:")
# print(command)
# pr = check_output(command, shell=True)

View File

@ -0,0 +1,51 @@
#!/usr/bin/env bash
curdir=$(readlink -f "$(dirname "$0")")
rootdir=$(readlink -f "$curdir/../../../")
source "$rootdir/test/vhost/common.sh"
fio_conf() {
cat <<- FIO
[global]
ioengine=libaio
thread=1
group_reporting=1
direct=1
verify=0
norandommap=1
[perf_test]
stonewall
description="Vhost performance test for a given workload"
bs=${blksize:-4k}
rw=${rw:-randread}
rwmixread=${rwmixread:-70}
iodepth=${iodepth:-128}
time_based=1
ramp_time=${ramptime:-10}
runtime=${runtime:-10}
numjobs=${numjobs:-1}
# This option is meant to be sed'ed by the vhost's run_fio()
filename=
FIO
}
(($#)) && eval "$@"
perf_args+=("--vm-image=${vm_image:-$VM_IMAGE}")
perf_args+=("--ctrl-type=${ctrl_type:-spdk_vhost_scsi}")
perf_args+=(${split:+--use-split})
perf_args+=(${disk_map:+--disk-map="$disk_map"})
perf_args+=(${cpu_cfg:+--custom-cpu-cfg="$cpu_cfg"})
if [[ -n $extra_params ]]; then
perf_args+=($extra_params)
fi
trap 'rm -f "$curdir/fio.conf"' EXIT
fio_conf > "$curdir/fio.conf"
"$rootdir/test/vhost/perf_bench/vhost_perf.sh" \
"${perf_args[@]}" --fio-jobs="$curdir/fio.conf"