Spdk/examples/ioat/kperf
Daniel Verkamp c02b179490 Remove year from copyright headers.
Also add a space between Copyright and (c).

The copyright year can be determined using git metadata.

Also remove the duplicated "All rights reserved." - every instance of
this line already has a corresponding "All rights reserved" immediately
below it, except for examples/ioat/kperf/kmod/dma_perf.c, where I have
added it manually.

Performed using this command:

git ls-files | xargs sed -i -e 's/Copyright(c) \(.*\) Intel Corporation. All rights reserved./Copyright (c) Intel Corporation./'

Change-Id: I3779f404966800709024eb1eb66a50068af2716c
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2016-01-28 08:54:18 -07:00
..
kmod Remove year from copyright headers. 2016-01-28 08:54:18 -07:00
.gitignore ioat: add ioat kernel driver performance test harness 2016-01-15 10:53:19 +08:00
ioat_kperf.c Remove year from copyright headers. 2016-01-28 08:54:18 -07:00
Makefile Remove year from copyright headers. 2016-01-28 08:54:18 -07:00
README spdk: add the ioat_kperf test tool to autobuild system 2016-01-22 07:58:13 -07:00

IOAT Kernel Driver Test Tool
============================

For the purpose to make performance comparison with user space IOAT
driver, we developed the test tool based on IOAT kernel driver, the
test tool contains 2 components: kernel test module and user space
application. The kernel test module allocated one kernel thread for
each DMA channel, and the kernel thread did not pin to specified
CPU cores, but ensure all the thread run in the same NUMA socket
with DMA channel, and the user space application communicated
with kernel test module via sysfs interface.

Building & Usage
================

1. Compile and load the kernel test module first.

    modprobe -v ioatdma
    ./scripts/build_kmod.sh build && insmod dmaperf.ko

2. Run the test application.

    Parameters:
    [-h usage]
    [-n number of DMA channels]
    [-q queue depth, per DMA channel]
    [-s [n^2] transfer size, per descriptor]
    [-t total [n^2] data to tranfer, per DMA channel]

    For example: ./ioat_kperf -n 4 -q 128 -s 12 -t 32

    Total 4 Channels, Queue_Depth 128, Transfer Size 4096 Bytes, Total Transfer Size 4 GB
    Running I/O . . . .
    Channel 0 Performance Data 1414 MB/s
    Channel 1 Performance Data 1413 MB/s
    Channel 2 Performance Data 1413 MB/s
    Channel 3 Performance Data 1415 MB/s
    Total Channel Performance Data 5655 MB/s

3. Cleanup
    ./scripts/build_kmod.sh clean

OS Support
==========
We have tested several Linux distributions, currently Fedora 21/22 with kernel
version >= 3.17 are supported.