Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/109278/?format=api
{ "id": 109278, "url": "http://patches.dpdk.org/api/patches/109278/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20220406151106.2915304-11-juraj.linkes@pantheon.tech/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20220406151106.2915304-11-juraj.linkes@pantheon.tech>", "list_archive_url": "https://inbox.dpdk.org/dev/20220406151106.2915304-11-juraj.linkes@pantheon.tech", "date": "2022-04-06T15:10:52", "name": "[RFC,v1,10/24] dts: merge DTS doc/dts_gsg/quick_start.rst to DPDK", "commit_ref": null, "pull_url": null, "state": "rfc", "archived": true, "hash": "d062821a044383d841614c46c7f8685c95b70595", "submitter": { "id": 1626, "url": "http://patches.dpdk.org/api/people/1626/?format=api", "name": "Juraj Linkeš", "email": "juraj.linkes@pantheon.tech" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20220406151106.2915304-11-juraj.linkes@pantheon.tech/mbox/", "series": [ { "id": 22379, "url": "http://patches.dpdk.org/api/series/22379/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=22379", "date": "2022-04-06T15:10:42", "name": "merge DTS documentation files to DPDK", "version": 1, "mbox": "http://patches.dpdk.org/series/22379/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/109278/comments/", "check": "warning", "checks": "http://patches.dpdk.org/api/patches/109278/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 3FDF4A0508;\n\tWed, 6 Apr 2022 17:12:45 +0200 (CEST)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 7C13D428E0;\n\tWed, 6 Apr 2022 17:11:29 +0200 (CEST)", "from lb.pantheon.sk (lb.pantheon.sk [46.229.239.20])\n by mails.dpdk.org (Postfix) with ESMTP id 71089428AE\n for <dev@dpdk.org>; Wed, 6 Apr 2022 17:11:25 +0200 (CEST)", "from localhost (localhost [127.0.0.1])\n by lb.pantheon.sk (Postfix) with ESMTP id 5E6A1184FE8;\n Wed, 6 Apr 2022 17:11:24 +0200 (CEST)", "from lb.pantheon.sk ([127.0.0.1])\n by localhost (lb.pantheon.sk [127.0.0.1]) (amavisd-new, port 10024)\n with ESMTP id nVZZ6263htCw; Wed, 6 Apr 2022 17:11:22 +0200 (CEST)", "from entguard.lab.pantheon.local (unknown [46.229.239.141])\n by lb.pantheon.sk (Postfix) with ESMTP id EF944184FE9;\n Wed, 6 Apr 2022 17:11:11 +0200 (CEST)" ], "X-Virus-Scanned": "amavisd-new at siecit.sk", "From": "=?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "To": "thomas@monjalon.net, david.marchand@redhat.com,\n Honnappa.Nagarahalli@arm.com, ohilyard@iol.unh.edu, lijuan.tu@intel.com", "Cc": "dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "Subject": "[RFC PATCH v1 10/24] dts: merge DTS doc/dts_gsg/quick_start.rst to\n DPDK", "Date": "Wed, 6 Apr 2022 15:10:52 +0000", "Message-Id": "<20220406151106.2915304-11-juraj.linkes@pantheon.tech>", "X-Mailer": "git-send-email 2.25.1", "In-Reply-To": "<20220406151106.2915304-1-juraj.linkes@pantheon.tech>", "References": "<20220406151106.2915304-1-juraj.linkes@pantheon.tech>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "---\n dts/doc/dts_gsg/quick_start.rst | 310 ++++++++++++++++++++++++++++++++\n 1 file changed, 310 insertions(+)\n create mode 100644 dts/doc/dts_gsg/quick_start.rst", "diff": "diff --git a/dts/doc/dts_gsg/quick_start.rst b/dts/doc/dts_gsg/quick_start.rst\nnew file mode 100644\nindex 0000000000..e6ef9b95d5\n--- /dev/null\n+++ b/dts/doc/dts_gsg/quick_start.rst\n@@ -0,0 +1,310 @@\n+=================\n+Quick start guide\n+=================\n+\n+Introduction\n+============\n+\n+This document describes how to install and configure the Data Plane Development Kit Test Suite (DTS) in a Linux environment.\n+It is designed to get user to set up DTS quickly in their environment without going deeply into detail.\n+\n+DTS can run on a tester machine or a DUT machine or the third machine to communicate/manage tester/DUT by SSH connection.\n+DTS supports different kinds of traffic generators, including Scapy, TRex, IXIA.\n+The example set up DTS on as tester machine, and use Scapy as traffic generator to run functional testing.\n+\n+System Requirements\n+===================\n+\n+This chapter describes the packages required to set up DTS.\n+For the DPDK requirements, please consult `Data Plane Development Kit Getting Started Guide <http://dpdk.org/doc/guides>`_.\n+\n+Hardware Recommendation\n+-----------------------\n+\n+Our regression setups uses Intel x86 platforms with mainstream Intel ethernet cards.\n+The following platforms have been tested and are recommended.\n+\n+.. |reg| unicode:: U+000AE .. REGISTERED SIGN\n+.. |trade| unicode:: U+2122 .. TRADE MARK SIGN\n+\n+* DTS and Tester system\n+\n+\t* CPU\n+\t\t* Intel\\ |reg| Xeon\\ |reg| Platinum 8280M CPU @ 2.70GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| Platinum 8180 CPU @ 2.50GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| Gold 6252N CPU @ 2.30GHz\n+\n+\t* OS\n+\t\t* Ubuntu 20.04\n+\t\t* Ubuntu 18.04\n+\n+* DUT system\n+\n+\t* CPU\n+\n+\t\t* Intel\\ |reg| Atom\\ |trade| CPU C3758 @ 2.20GHz\n+\t\t* Intel\\ |reg| Atom\\ |trade| CPU C3858 @ 2.00GHz\n+\t\t* Intel\\ |reg| Atom\\ |trade| CPU C3958 @ 2.00GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| CPU D-1541 @ 2.10GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| CPU D-1553N @ 2.30GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| CPU E5-2680 0 @ 2.70GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| CPU E5-2680 v2 @ 2.80GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| CPU E5-2699 v3 @ 2.30GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| CPU E5-2699 v4 @ 2.20GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| Gold 5218N CPU @ 2.30GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| Gold 6139 CPU @ 2.30GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| Gold 6252N CPU @ 2.30GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| Platinum 8180 CPU @ 2.50GHz\n+\t\t* Intel\\ |reg| Xeon\\ |reg| Platinum 8280M CPU @ 2.70GHz\n+\n+\t* OS\n+\n+\t\t* CentOS 8.3\n+\t\t* CentOS Stream 8\n+\t\t* Fedora 33\n+\t\t* Red Hat Enterprise Linux Server release 8.3\n+\t\t* Suse 15 SP2\n+\t\t* Ubuntu 20.04\n+\t\t* Ubuntu 20.10\n+\n+\t* NICs\n+\n+\t * Intel\\ |reg| Ethernet Controller E810-C for SFP (4x25G)\n+\t * Intel\\ |reg| Ethernet Controller E810-C for QSFP (2x100G)\n+\t * Intel\\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)\n+\t * Intel\\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)\n+\t * Intel\\ |reg| 82599ES 10 Gigabit Ethernet Controller\n+\n+Topology Example\n+----------------\n+\n+2 Teseter interfaces connect to 2 DUT interfaces back to back.\n+\n+Dependencies\n+------------\n+\n+SSH Service\n+~~~~~~~~~~~\n+\n+Tester and DUT should have one interface connected to the same internet, so that they can be accessed by each other from local IP address\n+\n+.. code-block:: console\n+\n+ apt-get install openssh-server # download / install ssh software\n+ service ssh start # start ssh service\n+\n+.. note::\n+\n+ Firewall should be disabled that all packets can be accepted by NIC interfaces.\n+\n+.. code-block:: console\n+\n+ systemctl disable firewalld.service\n+\n+Python modules for DTS & Tester\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+The python dependences are recorded in requirements.txt.\n+Please install them as the following:\n+\n+.. code-block:: console\n+\n+ apt-get install python3\n+ python3 -m pip install -r requirements.txt\n+\n+BIOS setting for DUT\n+~~~~~~~~~~~~~~~~~~~~\n+\n+DPDK prefer devices bound to ``vfio-pci`` kernel module, therefore, please enable VT-d and VT-x:\n+\n+.. code-block:: console\n+\n+ Advanced -> Integrated IO Configuration -> Intel(R) VT for Directed I/O <Enabled>\n+ Advanced -> Processor Configuration -> Intel(R) Virtualization Technology <Enabled>\n+\n+DPDK running Prerequisite\n+~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+Recommend to use 1G Hugepage for DPDK running, add ``hugepagesz=1G hugepages=40 default_hugepagesz=1G`` in Linux cmdline.\n+For more details, please refer to `Data Plane Development Kit Getting Started Guide <http://dpdk.org/doc/guides>`_.\n+\n+Running DTS\n+===========\n+\n+Getting DTS Code\n+----------------\n+\n+Get DTS code from remote repo.\n+\n+.. code-block:: console\n+\n+ [root@tester ~]# git clone http://dpdk.org/git/tools/dts\n+ [root@tester ~]# ls dts\n+ [root@tester dts]# conf CONTRIBUTING.TXT dep doc dts execution.cfg executions framework nics output requirements.txt test_plans tests tools version.py\n+\n+Preparing DPDK tarball\n+----------------------\n+\n+DPDK source code should be packed as \"dpdk.tar.gz\" and moved into dts/dep:\n+\n+.. code-block:: console\n+\n+ tar -czvf dpdk.tar.gz dpdk\n+ cp dpdk.tar.gz ~/dts/dep\n+\n+Configuring DTS\n+---------------\n+\n+A few of files should be configured, including execution.cfg, $DTS_CFG_FOLDER/crbs, $DTS_CFG_FOLDER/ports.cfg.\n+\n+execution.cfg\n+~~~~~~~~~~~~~\n+\n+.. code-block:: console\n+\n+ [Execution1]\n+ crbs=192.168.1.1\n+ drivername=vfio-pci\n+ build_type=meson\n+ test_suites=\n+ hello_world,\n+ targets=\n+ x86_64-default-linuxapp-gcc,\n+ parameters=nic_type=cfg:func=true\n+\n+* crbs: IP address of the DUT system\n+* test_suites: a list of test suites to be executed\n+\n+$DTS_CFG_FOLDER/crbs.cfg\n+~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+.. code-block:: console\n+\n+ [192.168.1.1]\n+ dut_ip=192.168.1.1\n+ dut_user=root\n+ dut_passwd=dutpasswd\n+ os=linux\n+ tester_ip=192.168.1.2\n+ tester_passwd=testerpasswd\n+ channels=4\n+ bypass_core0=True\n+\n+* dut_ip: IP address of the DUT system, same as crbs in execution.cfg\n+* dut_user: User name of DUT linux account\n+* dut_passwd: Password of DUT linux account\n+* tester_ip: IP address of tester\n+* tester_passwd: Password of Tester linux account, user name should same as dut_user\n+\n+$DTS_CFG_FOLDER/ports.cfg\n+~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+.. code-block:: console\n+\n+ [192.168.1.1]\n+ ports =\n+ pci=0000:06:00.0,peer=0000:81:00.0;\n+ pci=0000:06:00.1,peer=0000:81:00.1;\n+\n+* [192.168.1.1]: same as crbs in execution.cfg and dut_ip in $DTS_CFG_FOLDER/crbs.cfg\n+* pci: pci address of DUT port\n+* peer: pci address of Tester port which connected to the DUT port whose pci is `pci`.\n+\n+The topology for the configuration is:\n+\n+.. code-block:: console\n+\n+ DUT port0 (0000:06:00.0) --- Tester port0 (0000:81:00.0)\n+ DUT port0 (0000:06:00.1) --- Tester port0 (0000:81:00.1)\n+\n+Launch DTS\n+----------\n+\n+As we have prepared the zipped dpdk file and configuration file, just type the followed command “./dts”, it will start the validation process.\n+\n+.. code-block:: console\n+\n+ [root@tester ~]# ./dts\n+\n+ dts:\n+ DUT 192.168.1.1\n+ tester: ssh root@192.168.1.2\n+ tester: ssh root@192.168.1.2\n+ tester: python3 -V\n+ tester_scapy: ssh root@192.168.1.2\n+ ...\n+ dut.192.168.1.1: ssh root@192.168.1.1\n+ dut.192.168.1.1: ssh root@192.168.1.1\n+ ...\n+ dut.192.168.1.1: scp -v dep/dpdk.tar.gz root@192.168.1.1:/tmp/\n+ ...\n+ dut.192.168.1.1: DUT PORT MAP: [0, 1]\n+ ...\n+ dut.192.168.1.1: export RTE_TARGET=x86_64-native-linuxapp-gcc\n+ dut.192.168.1.1: export RTE_SDK=`pwd`\n+ dut.192.168.1.1: rm -rf x86_64-native-linuxapp-gcc\n+ dut.192.168.1.1: CC=gcc meson -Denable_kmods=True -Dlibdir=lib --default-library=static x86_64-native-linuxapp-gcc\n+ ...\n+ dut.192.168.1.1: usertools/dpdk-devbind.py --force --bind=vfio-pci 0000:af:00.0 0000:af:00.1\n+ dts: NIC : fortville_25g\n+ dut.192.168.1.1: meson configure -Dexamples=helloworld x86_64-native-linuxapp-gcc\n+ dut.192.168.1.1: ninja -C x86_64-native-linuxapp-gcc\n+ dut.192.168.1.1: ls x86_64-native-linuxapp-gcc/examples/dpdk-helloworld\n+ TestHelloWorld: Test Case test_hello_world_all_cores Begin\n+ dut.192.168.1.1: cat config/defconfig_x86_64-native-linuxapp-gcc | sed '/^#/d' | sed '/^\\s*$/d'\n+ dut.192.168.1.1: ./x86_64-native-linuxapp-gcc/examples/dpdk-helloworld -l 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71 -n 4 --file-prefix=dpdk_25703_20210311003827\n+ TestHelloWorld: Test Case test_hello_world_all_cores Result PASSED:\n+ TestHelloWorld: Test Case test_hello_world_single_core Begin\n+ dut.192.168.1.1: ./x86_64-native-linuxapp-gcc/examples/dpdk-helloworld -l 1 -n 4 --file-prefix=dpdk_25703_20210311003827\n+ TestHelloWorld: Test Case test_hello_world_single_core Result PASSED:\n+ dts:\n+ TEST SUITE ENDED: TestHelloWorld\n+ ...\n+ dts: DTS ended\n+ [root@tester ~]#\n+\n+Check Test Result\n+==================\n+\n+The result files are generated in dts/output.\n+\n+.. code-block:: console\n+\n+ [root@tester output]# ls\n+ rst_report dts.log statistics.txt TestHelloWorld.log test_results.json test_results.xls\n+\n+* statstics.txt: summary statistics\n+\n+.. code-block:: console\n+\n+ [root@tester output]# cat statistics.txt\n+ dpdk_version = 21.02.0\n+ Passed = 2\n+ Failed = 0\n+ Blocked = 0\n+ Pass rate = 100.0\n+\n+* test_result.json: json format result file\n+\n+.. code-block:: console\n+\n+ [root@tester output]# cat result.json\n+ {\n+ \"192.168.1.1\": {\n+ \"dpdk_version\": \"21.02.0\",\n+ \"nic\": {\n+ \"driver\": \"vfio-pci\",\n+ \"firmware\": \"8.00 0x80008c1a 1.2766.0\",\n+ \"kdriver\": \"i40e-2.13.10\",\n+ \"name\": \"fortville_25g\"\n+ },\n+ \"x86_64-native-linuxapp-gcc\": {\n+ \"hello_world/test_hello_world_all_core\": \"passed\"\n+ \"hello_world/test_hello_world_single_core\": \"passed\"\n+ }\n+ }\n+ }\n+\n+* test_result.xls: excel format result file\n+\n+.. figure:: image/dts_result.png\n", "prefixes": [ "RFC", "v1", "10/24" ] }