cxl-test-tool: a tool to make cxl test with kernel and qemu setup easier

• For feedback, please email [email protected].
• If you like the tool, please star it to attract more people's interests.

Recent important changes.

** Now you can test bare metal with simple configuration, see commit 87697211e3a96aaec946baa57e9b18f6d31401f8 **

** Done: recently I started to move the code to python so it is easier to support more complicated use workflow. cxl-tool.py is the new main file.**

1. Updated DCD test workflow;
2. Add mctp setup;
3. Add ras related test support;
4. ...

NOTE:

• the tool needs python3 and some other packages. Before starting to use it.
• Make sure you have git, ssh, python3, python-is-python3, gdb, gcc installed.
• Also, before creating the qemu image, generate ssh key first with ssh-keygen on the host if not already exist.
• The created image uses the public key to enable passwordless access.

Instruction for first time users (Debian based release)

1. download cxl-test-tool from github;
2. Install packages needed (python3, python-is-python3, ssh);
3. Generate ssh key if not already (for keyless access to the VM);
4. cp run_vars.example .vars.config;
5. Configure .vars.config as needed;
6. setup QEMU: ./cxl-tool.py --setup-qemu (If ninja not found, check the right location is pointed for ninja)
7. Create Qemu image for VM: ./cxl-tool.py --create-image
8. setup Kernel: ./cxl-tool.py --setup-kernel
9. Start a VM with basic CXL topology: ./cxl-tool.py --run
10. login to the VM by: ./cxl-tool.py --login
11. Enjoy and explore more with the tool ...

run configuration file

All the run configuration options are defined in .vars.config. This options will control where the directory of qemu, kernel, and which qemu image we want to use. Also, all the URLs related to git clone operation is defined there. The easiest way to generate the file is to copy run_vars.example and make the change as needed.

• qemu launch command string is stored: /tmp/cmd
• qemu topology used: /tmp/topo
• qemu run output: /tmp/qemu.log

create qemu image

bash cxl-tool.sh --create-image --image /tmp/qemu.img

This will generate qcow2 image under /tmp/ that can be used by the following steps.

git clone, configure and compile qemu

bash cxl-tool.sh --setup-qemu

build qemu

bash cxl-tool.sh --build-qemu

git clone, configure and compile linux kernel

bash cxl-tool.sh --setup-kernel

compile linux kernel and install kernel modules

bash cxl-tool.sh --deploy-kernel

run qemu

bash cxl-tool.sh --run -A kvm -T m2

run qemu with cxl topology generated from .cxl-topology.xml file

bash cxl-tool.sh --run -A kvm --create-topo

Install ndctl to the VM

bash cxl-tool.sh --install-ndctl

Install ndctl, install cxl modules, setup cxl memory

bash cxl-tool.sh --cxl

debug qemu

bash cxl-tool.sh --qdb

debug kernel

bash cxl-tool.sh --kdb

debug ndctl

bash cxl-tool.sh --ndb "cxl list"

send commands to VM

bash cxl-tool.sh --C "commands to execute in vm"

VM management

bash cxl-tool.sh --reset/run/poweroff/shutdown

create dc region

bash cxl-tool.sh --create-dcR

Issue qmp commands through qmp file

bash cxl-tool.sh --issue-qmp qmp_file

This command can be used for poison injection, dc extent add/release

print out help information to show all available options

bash cxl-tool.sh --help

Instructions for DCD related test

1. Apply the patch test-workflows/0001-qapi-cxl.json-Add-QMP-interfaces-to-print-out-accept.patch on top of qemu source code which have DCD emulation support;
2. Create a cxl topology that has DCD support (only single dcd device tested) in .cxl-topology.xml;
3. run test

bash test-workflows/dcd-test.sh
or
bash test-workflows/dcd-test.sh -r (Generate add/release dc extent sequence randomly)