diff options
Diffstat (limited to 'doc/dts_gsg/sys_reqs.rst')
| -rw-r--r-- | doc/dts_gsg/sys_reqs.rst | 186 |
1 files changed, 186 insertions, 0 deletions
diff --git a/doc/dts_gsg/sys_reqs.rst b/doc/dts_gsg/sys_reqs.rst new file mode 100644 index 0000000..fad5617 --- /dev/null +++ b/doc/dts_gsg/sys_reqs.rst @@ -0,0 +1,186 @@ +System Requirements +=================== + +The board assigned to be tester should be installed the latest Fedora distribution for easily installed DPDK Test Suite required python modules. Tester board needs plug at least 2 x Intel® 82599 (Niantic) NICs (2x 10GbE full duplex optical ports per NIC) in the PCI express slots, then connect these four Niantic ports to the DUT board and make sure the link has been started up and speed is 10000Mb/s. + +Beside the four Niantic ports, tester and DUT should also have one interface connected to the same intranet. So that they can be accessed by each other from local IP address. + +.. note:: + + Firewall should be disabled that all packets can be accepted by Niantic Interface. + +.. code-block:: console + + systemctl disable firewalld.service + +Setup Tester Environment +------------------------ + +.. note:: + + Please install the latest Fedora distribution on the tester before install DPDK Test Suite on tester. Currently we recommend Fedora 20 for tester. The setup instruction and required packages may be different on different operation systems. + +To enable tester environment, you need to install script language, tool chain and third party packet generator, etc. + +Please follow the guidance to finish install as the below section. + +SSH Service +~~~~~~~~~~~ +Since DPDK Test Suite Tester communicates with DUT via SSH, please install and start sshd service in your tester. + +.. code-block:: console + + yum install sshd # download / install ssh software + systemctl enable sshd.service # start ssh service + +For create authorized login session, user needs to generate RSA authentication keys to ssh connection. + +Please use the following commands: + +.. code-block:: console + + ssh-keygen -t rsa + +TCL Language Support modules +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Since some third party tools required TCL (Tool Command Language) supports, please install TCL package to control and connect third party package generator. (For example, third-party professional tester IXIA required TCL support) + +.. code-block:: console + + yum install tcl # download / install ssh software + +Install Third Party python modules +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +With third party module, DPDK Test Suite is able to export test result as MS Excel file or graphs. To support this feature, please install the following modules in the tester. +Python Module “xlwt”: this module is used to generate spreadsheet files which compatible with MS Excel 97/2000/XP/2003 XLS files. +Python Module “numpy”: this module provides method to deal with array-processing test results. +Python Module “matplotlib”: this module is used to produce quality 2D test result summary as graphics +Python Module “pexpect”: this module provides API to automate interactive SSH sessions. +Python Module “docutils”: Docutils is a modular system for processing documentation into useful formats, such as HTML, XML, and LaTeX. +Python Module “pcapy”: Pcapy is a Python extension module that interfaces with the libpcap packet capture library. Pcapy enables python scripts to capture packets on the network. + +Please see installation instruction as the following: + + +.. code-block:: console + + yum install python-xlwt + yum install python-pexpect + yum install numpy + yum install python-matplotlib + yum install python-docutils + yum install pcapy + + +Setup and configure Scapy +~~~~~~~~~~~~~~~~~~~~~~~~~ +Scapy is a powerful interactive packet manipulation program. It is able to forge or decode packets of a wide number of protocols, send them on the wire, capture them, match requests and replies, and much more. It can easily handle most classical tasks like scanning, tracerouting, probing, unit tests, attacks or network discovery. + +DTCS uses python module scapy to forge or decode packets of a wide number of protocols, send them over the wire, capture them, and analyse the packets. + +.. code-block:: console + + yum install scapy + +Fedora20 default kernel will strip vlan header automatically and thus it will cause that scapy can’t detect vlan packet normally. To solve this issue, we need to configure scapy use libpcap which is a low-level network traffic monitoring tool. + +.. code-block:: console + + vim /usr/lib/python2.7/site-packages/scapy/config.py # open configure python files + use_pcap = True # find use_pcap and set it to True + +Install DPDK Test Suite on tester +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +After configure environment, we need to install DPDK Test Suite into tester. First of all, download the latest DPDK Test Suite code from remote repo. + +.. code-block:: console + + [root@tester ~]# git clone http://dpdk.org/git/tools/dcts + [root@tester ~]# cd dcts + [root@tester dcts]# ls + [root@tester dcts]# dts execution.cfg framework output test_plans tests + +High Precision Timer (HPET) must be enabled in the platform BIOS if the HPET is to be used. Otherwise, the Time Stamp Counter (TSC) is used by default. The user can then navigate to the HPET option. On the Crystal Forest platform BIOS, the path is: +**Advanced -> PCH-IO Configuration -> High Precision Timer** + +The DPDK Test Suite is composed of several file and directories: + +* dts: Main module of DPDK Test Suite suite +* exectution.cfg: configuration file of DPDK Test Suite suite +* framework: folder with dts framework modules +* output: folder which contain running log files and result files +* test_plans: folder with rst files which contain the description of test case +* tests: folder with test case scripts + +Setup Target Environment +------------------------ + +This section describes how to deploy DPDK Test Suite packages into DUT target.So far, DPDK Test Suite supports the following OS on DUT: + +* Fedora18/19/20 +* Ubuntu12.04/14.04 +* WindRiver 6.0 +* FreeBSD 10 +* RedHat 6.5/7.0 +* SUSE 11 + +Before run DPDK Test Suite on target, we need to configure target environment, it includes BIOS setting, Network configure, compiler environment, etc. + +BIOS setting Prerequisite +~~~~~~~~~~~~~~~~~~~~~~~~~ + +In general, enter BIOS Menu by pressing F2 while the platform is starting up. + +.. note:: + strongly recommend to install DPDK on Intel latest platform and processor. + +The High Precision Timer (HPET) must be enabled in the platform BIOS if the HPET is to be used. Otherwise, the Time Stamp Counter (TSC) is used by default. The user can then navigate to the HPET option. On the Crystal Forest platform BIOS, the path is: + +**Advanced -> PCH-IO Configuration -> High Precision Timer** + +Enhanced Intel SpeedStep® Technology must be disabled in the platform BIOS. Thus we will disable dynamically adjust processor voltage and core frequency which may cause unstable performance data. On the Crystal Forest platform BIOS, the path is: + +**Advanced -> Processor Configuration -> Enhanced Intel SpeedStep** + +Processor sate C3 and C6 must be disabled for performance measure too. On the Crystal Forest platform BIOS, the path is: + +**Advanced -> Processor Configuration -> Processor C3 +Advanced -> Processor Configuration -> Processor C6** + +Hyper-Threading Technology must be enabled. On the Crystal Forest platform BIOS, the path is: + +**Advanced -> Processor Configuration -> Intel® Hyper-Threading Tech** + +If the platform BIOS has any particular performance option, select the settings for best performance. + +DPDK running Prerequisite +~~~~~~~~~~~~~~~~~~~~~~~~~ +Compilation of DPDK need GNU maker, gcc, libc-header, kernel header installed. For 32-bit compilation on 64-bit systems, there’re some additional packages required. For Intel® C++ Compiler (icc) additional libraries may be required. For more detail information of required packets, please refer to Data Plane Development Kit Getting Started Guide. + +The DPDK igb_uio kernel module depends on traditional Linux kernel uio support to operate. Linux traditional uio support may be compiled as a module, so this module should be loaded using the modprobe program. +Kernel must support the allocation of hugepages. Hugepage support is required for the large memory pool allocation used for packet buffers. By using hugepage allocations, performance will be improved since only fewer pages are needed, and therefore less Translation Lookaside Buffers (TLBs, high speed translation caches), which reduce the time it takes to translate a virtual page address to a physical page address. Without hugepages, high TLB miss rates would occur, slowing performance. + +The DPDK igb_uio kernel module depends on traditional Linux kernel ``uio`` support to operate. Linux traditional ``uio`` support may be compiled as a module, so this module should be loaded using the ``modprobe`` program. +Kernel must support the allocation of hugepages. Hugepage support is required for the large memory pool allocation used for packet buffers. By using hugepage allocations, performance will be improved since only fewer pages are needed, and therefore less Translation Lookaside Buffers (TLBs, high speed translation caches), which reduce the time it takes to translate a virtual page address to a physical page address. Without hugepages, high TLB miss rates would occur, slowing performance. + +For more detail information of system requirements, also refer to `Data Plane Development Kit Getting Started Guide <http://dpdk.org/doc/intel/dpdk-start-linux-1.7.0.pdf>`_. + +Authorized login session +------------------------ +In DPDK Test Suite, communication was established based on authorized ssh session. All ssh connection to each other will skip password interactive phase for remote server has been authorized. + +In tester, you can use tool ssh-copy-id to save local available keys on DUT, thus create authorise login session between tester and DUT. By the same way, you can create authorise login session between tester and itself. + +.. code-block:: console + + ssh-copy-id -i “IP of DUT” + ssh-copy-id -i “IP of tester” + +In DUT, You also can use tool ssh-copy-id to save local available keys in tester, thus create authorise login session between DUT and tester. + +.. code-block:: console + + ssh-copy-id –i “IP of Tester” + |