From: Lijuan Tu <lijuan.tu@intel.com>
To: dts@dpdk.org
Cc: Lijuan Tu <lijuan.tu@intel.com>
Subject: [dts] [PATCH] doc/dts_gsg: fix doc format and description
Date: Fri, 3 Jan 2020 23:50:37 +0800 [thread overview]
Message-ID: <1578066637-123985-1-git-send-email-lijuan.tu@intel.com> (raw)
Signed-off-by: Lijuan Tu <lijuan.tu@intel.com>
---
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(-)
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
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| File Name | Description |
- +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ +=======================+==============================================================================================================================================================+
| 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 identifiers supported by the framework |
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | utils.py | Provide shared simple functions like IP address conversion and mask creation |
+ | utils.py | Provide shared simple functions like IP address conversion and mask creation |
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ssh_connection.py | Create session to host, implement send_expect 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 @@
-=================
-etgen replacement
-=================
-pktgen usage please refer to doc **pktgen_prog_guide.rst**.
+======================
+Etgen to Pktgen Guides
+======================
+
+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 <pktgen_prog_guide.html>`__.
import new class
----------------
-#. import a new module::
+#. import a new module:
.. code-block:: python
@@ -49,7 +54,10 @@ If no protocol layer field vary requirement, ignore this content.
field key definition
~~~~~~~~~~~~~~~~~~~~
-#. 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'},
}
-#. 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'},
}
-#. 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'},
+ }
usage example
~~~~~~~~~~~~~
@@ -125,13 +140,13 @@ etgen interface.
throughput
~~~~~~~~~~
-etgen::
+etgen:
.. code-block:: python
self.tester.traffic_generator_throughput(tgen_input)
-pktgen::
+pktgen:
.. code-block:: python
@@ -147,13 +162,13 @@ pktgen::
loss
~~~~
-etgen::
+etgen:
.. code-block:: python
self.tester.traffic_generator_loss(tgen_input)
-pktgen::
+pktgen:
.. code-block:: python
@@ -169,13 +184,13 @@ pktgen::
latency
~~~~~~~
-etgen::
+etgen:
.. code-block:: python
self.tester.traffic_generator_latency(tgen_input)
-pktgen::
+pktgen:
.. code-block:: python
@@ -191,13 +206,13 @@ pktgen::
rfc2544
~~~~~~~
-etgen::
+etgen:
.. code-block:: python
self.tester.run_rfc2544(tgen_input)
-pktgen::
+pktgen:
.. code-block:: python
@@ -211,4 +226,4 @@ pktgen::
# set traffic option
traffic_opt = {'pdr': 0.01, 'duration': 5}
zero_loss_rate, tx_pkts, rx_pkts = \
- self.tester.pktgen.measure_rfc2544(stream_ids=streams, options=traffic_opt)
\ No newline at end of file
+ self.tester.pktgen.measure_rfc2544(stream_ids=streams, options=traffic_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 @@
-=================
-how to use pktgen
-=================
+===================
+Pktgen How-to Guide
+===================
+
+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` and etgen
usage in dts. For trex(CISCO) rapid iterative development speed, we 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}
- 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
=====================================
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 usable
-by other tests in the future.
An example T-Rex configuration that accomplishes this is shown as follows:
@@ -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``.
To read more about T-Rex stateless mode, read the
-`T-Rex stateless support guide`_.
-
-:: _T-Rex stateless support guide: https://trex-tgn.cisco.com/trex/doc/trex_stateless.html
+`T-Rex stateless support guide <https://trex-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.
-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.
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.
-#. If using i40e driver, Trex v2.41 version need i40e nic firmware version newer than 5.02.
\ No newline at end of file
+#. If using i40e driver, Trex v2.41 version need i40e nic firmware version newer than 5.02.
--
1.8.3.1
next reply other threads:[~2020-01-03 7:41 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-03 15:50 Lijuan Tu [this message]
2020-01-06 8:56 ` Tu, Lijuan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1578066637-123985-1-git-send-email-lijuan.tu@intel.com \
--to=lijuan.tu@intel.com \
--cc=dts@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).