cxl-tests is a test suite for the IBM Coherent Accelerator Processor
Interface.
cxl-tests provides tests for libcxl
and the CAPI memcpy AFU.
To compile, you'll need an appropriate GCC native or cross toolchain.
The version of libcxl to be tested must be in the libcxl directory. If the
directory is empty, the git submodule will be updated from GitHub.
To run the libcxl tests, you'll need a CAPI device. To run the memcpy AFU
tests, you'll need an appropriate CAPI FPGA with the memcpy AFU image flashed
on it.
To build, run make.
You can control the build of the tests through standard environment variables. Default is 64-bit binaries, dynamic linking and same endianness as the build machine.
If you're cross-compiling, set CROSS_COMPILE to the appropriate prefix.
For example, to cross-compile with powerpc64le-linux-gnu-gcc, statically
linked:
$ export CROSS_COMPILE=powerpc64le-linux-gnu-
$ export CFLAGS=-static
$ make
Usage
-----
$ export LD_LIBRARY_PATH=libcxl
$ ./libcxl_tests # Test libcxl
$ ./memcpy_afu_ctx # Test memcpy AFU memory copy
$ ./memcpy_afu_ctx -t # Test memcpy AFU timebase sync
$ ./cxl_eeh_tests.sh # Test device reset and recovery
$ ./cxl-threads # Test memcpy with one thread attaching
# and exiting, and other threads copying
Usage: memcpy_afu_ctx [options]
Options:
-c <card_num> Use this CAPI card (default 0).
-h Display this help text.
-I <irq_count> Define this number of interrupts (default 4).
-i <irq_num> Use this interrupt command source number (default 0).
-K Test CXL kernel API (with module cxl-memcpy.ko).
-k Use the Stop_on_Invalid_Command and Restart logic.
-l <loops> Run this number of memcpy loops (default 1).
-P Prefault destination buffer (with module cxl-memcpy.ko).
-p <procs> Fork this number of processes (default 1).
Use -p0 to fork as many processes as advertised by AFU.
-r Reallocate destination buffer at each iteration.
-s <bufsize> Copy this number of bytes (default 1024).
-t Do not memcpy. Test timebase sync instead.
-e <timeout> End timeout.
Seconds to wait for the AFU to signal completion.
Usage: cxl_eeh_tests.sh [options]
Options:
-c <card> Use this CAPI card (default 0).
-l <loops> Run the test this number of times (default 1).
Usage:./cxl-threads [options]
Options:
-n <num> Number of threads that execute memcpy.
-t Do the work element setup on the main thread.
-c <index> Card index to runs tests on.
-z Exit the main thread after spawing the child threads
(zombie-state)
-j Join the spawned thread to exit (default)
-d Detach from the child threads and die (dead-state)
-m Use malloced memory instead of static memory
for src/dst buffer
-s <size> Size of the copy buffer used.
The CXL kernel API can be tested through the cxl-memcpy.ko driver. It is not part of the automated script.
To build the kernel module cxl_memcpy:
$ [KERNELDIR=<linux build tree>] make cxl-memcpy.ko
To test (root only):
$ insmod ./cxl-memcpy.ko
$ ./memcpy_afu_ctx -K [-p <proc count>] [-l <loop count>]
The kernel API cxllib_handle_fault() can also be tested with cxl-memcpy.ko. It is not part of the automated script.
To build the kernel module cxl_memcpy:
$ [KERNELDIR=<linux build tree>] make cxl-memcpy.ko
To build the perf tool associated with the kernel:
$ KERNELDIR=<linux build tree> make perf
To test (root only):
$ ./cxllib_handle_fault.sh
Contributions are accepted via GitHub pull request.
All commit messages must include a Signed-off-by: line including your real
name, indicating that you have read and agree to the
Developer Certificate of Origin v1.1.
Copyright © 2017 International Business Machines Corporation
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this software except in compliance with the License. A copy of the License can
be found in the file LICENSE.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.