From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id CA4E9A04F1; Mon, 6 Jan 2020 09:56:39 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id BBA5B1D600; Mon, 6 Jan 2020 09:56:39 +0100 (CET) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id D31DA1D5FD for ; Mon, 6 Jan 2020 09:56:37 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 06 Jan 2020 00:56:37 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.69,401,1571727600"; d="scan'208";a="422065182" Received: from fmsmsx108.amr.corp.intel.com ([10.18.124.206]) by fmsmga006.fm.intel.com with ESMTP; 06 Jan 2020 00:56:36 -0800 Received: from fmsmsx605.amr.corp.intel.com (10.18.126.85) by FMSMSX108.amr.corp.intel.com (10.18.124.206) with Microsoft SMTP Server (TLS) id 14.3.439.0; Mon, 6 Jan 2020 00:56:36 -0800 Received: from fmsmsx605.amr.corp.intel.com (10.18.126.85) by fmsmsx605.amr.corp.intel.com (10.18.126.85) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5; Mon, 6 Jan 2020 00:56:36 -0800 Received: from shsmsx102.ccr.corp.intel.com (10.239.4.154) by fmsmsx605.amr.corp.intel.com (10.18.126.85) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.1.1713.5 via Frontend Transport; Mon, 6 Jan 2020 00:56:36 -0800 Received: from shsmsx101.ccr.corp.intel.com ([169.254.1.30]) by shsmsx102.ccr.corp.intel.com ([169.254.2.202]) with mapi id 14.03.0439.000; Mon, 6 Jan 2020 16:56:34 +0800 From: "Tu, Lijuan" To: "dts@dpdk.org" Thread-Topic: [dts][PATCH] doc/dts_gsg: fix doc format and description Thread-Index: AQHVwglLxoS59dCf0kqzH0V37GprpKfdWk0g Date: Mon, 6 Jan 2020 08:56:34 +0000 Message-ID: <8CE3E05A3F976642AAB0F4675D0AD20E0BBA249F@SHSMSX101.ccr.corp.intel.com> References: <1578066637-123985-1-git-send-email-lijuan.tu@intel.com> In-Reply-To: <1578066637-123985-1-git-send-email-lijuan.tu@intel.com> Accept-Language: zh-CN, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-version: 11.2.0.6 dlp-reaction: no-action x-originating-ip: [10.239.127.40] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dts] [PATCH] doc/dts_gsg: fix doc format and description X-BeenThere: dts@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: test suite reviews and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dts-bounces@dpdk.org Sender: "dts" applied > -----Original Message----- > From: Tu, Lijuan > Sent: Friday, January 3, 2020 11:51 PM > To: dts@dpdk.org > Cc: Tu, Lijuan > Subject: [dts][PATCH] doc/dts_gsg: fix doc format and description >=20 > Signed-off-by: Lijuan Tu > --- > doc/dts_gsg/index.rst | 3 ++ > doc/dts_gsg/intro.rst | 4 +-- > doc/dts_gsg/migrate_from_etgen_to_pktgen.rst | 51 ++++++++++++++++++-- > -------- > doc/dts_gsg/pktgen_prog_guide.rst | 14 +++++--- > doc/dts_gsg/trex.rst | 6 +--- > doc/dts_gsg/trex_known_issue.rst | 9 ++--- > 6 files changed, 54 insertions(+), 33 deletions(-) >=20 > diff --git a/doc/dts_gsg/index.rst b/doc/dts_gsg/index.rst index > 77818d5..89e4eef 100644 > --- a/doc/dts_gsg/index.rst > +++ b/doc/dts_gsg/index.rst > @@ -43,4 +43,7 @@ Getting Started Guide > virtualization > scenario > multiple_vm > + pktgen_prog_guide > + migrate_from_etgen_to_pktgen > trex > + trex_known_issue > diff --git a/doc/dts_gsg/intro.rst b/doc/dts_gsg/intro.rst index > 94fd9bf..7704cb5 100644 > --- a/doc/dts_gsg/intro.rst > +++ b/doc/dts_gsg/intro.rst > @@ -34,7 +34,7 @@ In the DPDK Test Suite Test Framework, it provides the > following modules to help >=20 > +-----------------------+-------------------------------------------= ---------------------------- > -------------------------------------------------------------------------= --------------+ > | File Name | Description > | > - +-----------------------+-------------------------------------------= --------------------------- > -------------------------------------------------------------------------= ---------------+ > + > + > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > =3D=3D=3D=3D=3D=3D > + > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > =3D=3D=3D=3D=3D=3D > + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+ > | dts.py | Main Application for DPDK Test Suite > | > +-----------------------+-------------------------------------------= ---------------------------- > -------------------------------------------------------------------------= --------------+ > | main.py | Test script to parse input parameter > | > @@ -55,7 +55,7 @@ In the DPDK Test Suite Test Framework, it provides the > following modules to help > +-----------------------+-------------------------------------------= ---------------------------- > -------------------------------------------------------------------------= --------------+ > | settings.py | Setting for default network card and its i= dentifiers > supported by the framework = | > +-----------------------+-------------------------------------------= ---------------------------- > -------------------------------------------------------------------------= --------------+ > - | utils.py | Provide shared simple functions like IP ad= dress > conversion and mask creation = | > + | utils.py | Provide shared simple functions like IP ad= dress > conversion and mask creation = | > +-----------------------+-------------------------------------------= ---------------------------- > -------------------------------------------------------------------------= --------------+ > | ssh_connection.py | Create session to host, implement send_exp= ect > and copy function = | > +-----------------------+-------------------------------------------= ---------------------------- > -------------------------------------------------------------------------= --------------+ > diff --git a/doc/dts_gsg/migrate_from_etgen_to_pktgen.rst > b/doc/dts_gsg/migrate_from_etgen_to_pktgen.rst > index bee7190..e08d00b 100644 > --- a/doc/dts_gsg/migrate_from_etgen_to_pktgen.rst > +++ b/doc/dts_gsg/migrate_from_etgen_to_pktgen.rst > @@ -1,13 +1,18 @@ >=20 > -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > -etgen replacement > -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > -pktgen usage please refer to doc **pktgen_prog_guide.rst**. > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > +Etgen to Pktgen Guides > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +If you are working on etgen, and this document can help you to update > +your test suites to pktgen rapidly. Etgen is not under maitenance, and > +it will be removed from DTS some days. > + > +pktgen usage please refer to doc `pktgen_prog_guide > `__. >=20 > import new class > ---------------- >=20 > -#. import a new module:: > +#. import a new module: >=20 > .. code-block:: python >=20 > @@ -49,7 +54,10 @@ If no protocol layer field vary requirement, ignore th= is > content. > field key definition > ~~~~~~~~~~~~~~~~~~~~ >=20 > -#. ip protocol layer:: > +#. ip protocol layer: > + > +.. code-block:: python > + > # protocol layer name > 'mac': { > # field name > @@ -63,7 +71,10 @@ field key definition > 'dst': {'range': 64, 'step': 1, 'action': 'inc'}, > } >=20 > -#. mac protocol layer:: > +#. mac protocol layer: > + > +.. code-block:: python > + > # protocol layer name > 'mac': { > # field name > @@ -77,7 +88,10 @@ field key definition > 'dst': {'range': 64, 'step': 1, 'action': 'inc'}, > } >=20 > -#. vlan protocol layer:: > +#. vlan protocol layer: > + > +.. code-block:: python > + > # protocol layer name > 'vlan': { > '0': { > @@ -86,7 +100,8 @@ field key definition > # field value vary step > 'step': 1, > # action: inc/dec/random > - 'action': 'inc'},} > + 'action': 'inc'}, > + } >=20 > usage example > ~~~~~~~~~~~~~ > @@ -125,13 +140,13 @@ etgen interface. > throughput > ~~~~~~~~~~ >=20 > -etgen:: > +etgen: >=20 > .. code-block:: python >=20 > self.tester.traffic_generator_throughput(tgen_input) >=20 > -pktgen:: > +pktgen: >=20 > .. code-block:: python >=20 > @@ -147,13 +162,13 @@ pktgen:: > loss > ~~~~ >=20 > -etgen:: > +etgen: >=20 > .. code-block:: python >=20 > self.tester.traffic_generator_loss(tgen_input) >=20 > -pktgen:: > +pktgen: >=20 > .. code-block:: python >=20 > @@ -169,13 +184,13 @@ pktgen:: > latency > ~~~~~~~ >=20 > -etgen:: > +etgen: >=20 > .. code-block:: python >=20 > self.tester.traffic_generator_latency(tgen_input) >=20 > -pktgen:: > +pktgen: >=20 > .. code-block:: python >=20 > @@ -191,13 +206,13 @@ pktgen:: > rfc2544 > ~~~~~~~ >=20 > -etgen:: > +etgen: >=20 > .. code-block:: python >=20 > self.tester.run_rfc2544(tgen_input) >=20 > -pktgen:: > +pktgen: >=20 > .. code-block:: python >=20 > @@ -211,4 +226,4 @@ pktgen:: > # set traffic option > traffic_opt =3D {'pdr': 0.01, 'duration': 5} > zero_loss_rate, tx_pkts, rx_pkts =3D \ > - self.tester.pktgen.measure_rfc2544(stream_ids=3Dstreams, > options=3Dtraffic_opt) > \ No newline at end of file > + self.tester.pktgen.measure_rfc2544(stream_ids=3Dstreams, > + options=3Dtraffic_opt) > diff --git a/doc/dts_gsg/pktgen_prog_guide.rst > b/doc/dts_gsg/pktgen_prog_guide.rst > index e0fdcf4..26ba56a 100644 > --- a/doc/dts_gsg/pktgen_prog_guide.rst > +++ b/doc/dts_gsg/pktgen_prog_guide.rst > @@ -1,7 +1,13 @@ >=20 > -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > -how to use pktgen > -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > +Pktgen How-to Guide > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +The old module *etgen* is only support hardward packet generator `Ixia > +Explorer` which is not friendly for users to get. So DTS community > +refined DTS framework to support another software packet generator > +`Trex` which is an open source project, and user can get it easily. > + > these definition and usage pattern come from doc `pktgen-API-1.1.docx` a= nd > etgen usage in dts. For trex(CISCO) rapid iterative development speed, w= e > lack of adequate manpower to keep up with it. Here we recommend to use > trex v2.41/v2.42/v2.43 @@ -575,4 +581,4 @@ testing scenario:: > 'pdr': 0.001, > 'drop_step': 1} >=20 > - hPktgen.measure(stream_ids, traffic_opt) > \ No newline at end of file > + hPktgen.measure(stream_ids, traffic_opt) > diff --git a/doc/dts_gsg/trex.rst b/doc/dts_gsg/trex.rst index > ab6dfa5..4676f96 100644 > --- a/doc/dts_gsg/trex.rst > +++ b/doc/dts_gsg/trex.rst > @@ -2,8 +2,6 @@ Configuring T-Rex for DPDK Test Suite > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D >=20 > DPDK can utilize T-Rex as a traffic generator in stateless Layer 2 mode. > -This is supported for the ``nic_single_core_perf`` test but may be usabl= e -by > other tests in the future. >=20 > An example T-Rex configuration that accomplishes this is shown as follow= s: >=20 > @@ -22,6 +20,4 @@ DTS may use a standalone T-Rex instance, or can be > configured to start T-Rex itself using the settings in ``pktgen.conf``. >=20 > To read more about T-Rex stateless mode, read the -`T-Rex stateless supp= ort > guide`_. > - > -:: _T-Rex stateless support guide: https://trex- > tgn.cisco.com/trex/doc/trex_stateless.html > +`T-Rex stateless support guide tgn.cisco.com/trex/doc/trex_stateless.html>`__. > diff --git a/doc/dts_gsg/trex_known_issue.rst > b/doc/dts_gsg/trex_known_issue.rst > index 53cbc1a..7807dd2 100644 > --- a/doc/dts_gsg/trex_known_issue.rst > +++ b/doc/dts_gsg/trex_known_issue.rst > @@ -7,9 +7,10 @@ dpdk hugepage management conflict issue trex use > older dpdk version than we release cycle source code. When dpdk change > the memory management merchanism, trex will meet the following issue. >=20 > -Trex should run on an independent platform. DUT/Trex should run on two > platforms -*. one is used as TESTER and trex server, another one is used = as > DUT.(dts/pktgen) -*. one is used as trex server, another one is used as > DUT/TESTER.(recommended scheme) > +Trex should run on an independent platform. DUT/Trex should run on two > platforms: > + > +* one is used as TESTER and trex server, another one is used as > +DUT.(dts/pktgen) > +* one is used as trex server, another one is used as > +DUT/TESTER.(recommended scheme) > This scheme can make sure that trex run on its full status capability= . >=20 > When trex run with dts on the same platform, trex server sometimes boot > up @@ -109,4 +110,4 @@ other issues #. If you have ran dpdk on the > platform which you want to deploy trex-server, > reboot the platform to make sure that trex-server can work fine. >=20 > -#. If using i40e driver, Trex v2.41 version need i40e nic firmware versi= on > newer than 5.02. > \ No newline at end of file > +#. If using i40e driver, Trex v2.41 version need i40e nic firmware versi= on > newer than 5.02. > -- > 1.8.3.1