IOPS Fast Adapter (XRT Native API's)
====================================

This is simple test design to measure Input/Output Operations per second using Fast Adapter. In this design, a simple kernel is enqueued many times and overall IOPS is measured using XRT native api's.

**KEY CONCEPTS:** Input/Output Operations per second, Fast Adapter

**KEYWORDS:** nextDescriptorAddr


This is simple design to measure Input/Output Operations per second using Fast Adapter.
For measuring the IOPS we run kernel 1 Million times and capture the time it takes to complete -

We need to make sure Kernel Domain Scheduler(KDS) is enabled. Following are the steps to enable KDS :

.. code:: cpp

       sudo rmmod xocl
       sudo modprobe xocl kds_mode=1
     

Following is the real log reported while running the design on U50
platform:

::

   Open the device0
   Load the xclbin ./build_dir.hw.xilinx_u50_gen3x16_xdma_4_202020_1/hello.xclbin
   Allocated commands, expect 10000, created 10000
   Commands:      10 iops: 196078
   Commands:      50 iops: 467290
   Commands:     100 iops: 540541
   Commands:     200 iops: 638978
   Commands:     500 iops: 652742
   Commands:    1000 iops: 675676
   Commands:    1500 iops: 676590
   Commands:    2000 iops: 677736
   Commands:    3000 iops: 681973
   Commands:    5000 iops: 685683
   Commands:   10000 iops: 681663
   Commands:   50000 iops: 701784
   Commands:  100000 iops: 708175
   Commands:  500000 iops: 713502
   Commands: 1000000 iops: 714332
   TEST PASSED

EXCLUDED PLATFORMS
------------------

Platforms containing following strings in their names are not supported for this example :

::

   nodma
   zc
   vck
   u200
   u250
   2019

DESIGN FILES
------------

Application code is located in the src directory. Accelerator binary files will be compiled to the xclbin directory. The xclbin directory is required by the Makefile and its contents will be filled during compilation. A listing of all the files in this example is shown below

::

   src/hello.cpp
   src/host.cpp
   
Access these files in the github repo by `clicking here <https://github.com/Xilinx/Vitis_Accel_Examples/tree/master/host_xrt/iops_fast_adapter_xrt>`__.

COMMAND LINE ARGUMENTS
----------------------

Once the environment has been configured, the application can be executed by

::

   ./iops_fast_adapter_xrt -x <hello XCLBIN>