test suite reviews and discussions
 help / color / Atom feed
From: yufengmx <yufengx.mo@intel.com>
To: dts@dpdk.org, yinan.wang@intel.com
Cc: yufengmx <yufengx.mo@intel.com>
Subject: [dts] [PATCH V2 2/5] doc/dts_gsg/pktgen_prog_guide: update description
Date: Fri, 22 Nov 2019 16:58:40 +0800
Message-ID: <20191122085843.97671-3-yufengx.mo@intel.com> (raw)
In-Reply-To: <20191122085843.97671-1-yufengx.mo@intel.com>


update test methods(latency/loss/throughput/rfc2544) input parameters description.

Signed-off-by: yufengmx <yufengx.mo@intel.com>
---
 doc/dts_gsg/pktgen_prog_guide.rst | 49 +++++++++++++++++++++++--------
 1 file changed, 37 insertions(+), 12 deletions(-)

diff --git a/doc/dts_gsg/pktgen_prog_guide.rst b/doc/dts_gsg/pktgen_prog_guide.rst
index 32d2082..f9cd2f3 100644
--- a/doc/dts_gsg/pktgen_prog_guide.rst
+++ b/doc/dts_gsg/pktgen_prog_guide.rst
@@ -145,7 +145,7 @@ define a stream transmit behavior.
 
 basic content including::
 
-   'rate':  0 ~ 100 int type
+   'rate':  0 ~ 100 int type, port line rate should set it.
    'transmit_mode': TRANSMIT_CONT/TRANSMIT_S_BURST
        TRANSMIT_CONT define a continuous transmit.
        TRANSMIT_S_BURST define a burst transmit with custom number of packets.
@@ -332,9 +332,22 @@ option
    traffic_option = {
       # test method name, if use `measure_throughput`, ignore this key
       'method': 'throughput',
-      # port rate percent
+      # port rate percent, float(0--100), default value is 100.(reserved)
       'rate': 100,
-      # transmit lasting time second
+      # warm up time before start main transmission. If it is set, it will start
+      # a custom time transmission to make sure packet generator under good
+      # status. It is an optional key.
+      'delay': 5,
+      # the interval time of get throughput statistic (second).
+      # If set this key value, pktgen will return several throughput statistic
+      # data in a duration. If not set this key value, only return one statistic
+      # data. It is used coupled with `duration` option.
+      'interval': 1,
+      # this key works with ``interval`` key. If it is set, the callback
+      # of suite level will be executed after getting throughput statistic.
+      # callback method should define as below, don't add sleep in this method.
+      'callback' : callback_method,
+      # transmission lasting time(second), default value is 10 second.
       'duration': 5}
 
 return value
@@ -358,9 +371,13 @@ option
    traffic_option = {
       # test method name, if use `measure_loss`, ignore this key
       'method': 'loss',
-      # port rate percent
+      # port rate percent, float(0--100), default value is 100.(reserved)
       'rate': 100,
-      # transmit lasting time second
+      # warm up time before start main transmission. If it is set, it will start
+      # a custom time transmission to make sure packet generator under good
+      # status. It is an optional key.
+      'delay': 5,
+      # transmission lasting time(second), default value is 10 second.
       'duration': 5}
 
 return value
@@ -382,9 +399,13 @@ option
    traffic_option = {
       # test method name, if use `measure_latency`, ignore this key
       'method': 'latency',
-      # port rate percent
+      # port rate percent, float(0--100), default value is 100.(reserved)
       'rate': 100,
-      # transmit lasting time second
+      # warm up time before start main transmission. If it is set, it will start
+      # a custom time transmission to make sure packet generator under ready
+      # status. It is an optional key.
+      'delay': 5,
+      # transmission lasting time(second), default value is 10 second.
       'duration': 5}
 
 return value
@@ -406,15 +427,19 @@ option
 .. code-block:: python
 
    traffic_option = {
-      # test method name, if use `measure_rfc2544`, ignore this key
+      # test method name, if use `measure_rfc2544`, ignore this key.
       'method': 'rfc2544',
-      # port rate percent at first round testing, 0 ~ 100, default is 100
+      # port rate percent at first round testing, 0 ~ 100, default is 100.
       'rate': 100,
-      # permit packet drop rate
+      # permit packet drop rate, default is 0.001.
       'pdr': 0.001,
-      # port rate percent drop step, 0 ~ 100 , default is 1
+      # port rate percent drop step, 0 ~ 100 , default is 1.
       'drop_step': 1,
-      # transmit lasting time second
+      # warm up time before start main transmission. If it is set, it will start
+      # a custom time transmission to make sure packet generator under ready
+      # status. It is an optional key.
+      'delay': 5,
+      # transmission lasting time(second), default value is 10 second.
       'duration': 5}
 
 return value
-- 
2.21.0


  parent reply index

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-22  8:58 [dts] [PATCH V2 0/5] dts/pktgen: measure throughput supports multiple return values and callback yufengmx
2019-11-22  8:58 ` [dts] [PATCH V2 1/5] conf/pktgen: remove un-used optons yufengmx
2019-11-22  8:58 ` yufengmx [this message]
2019-11-22  8:58 ` [dts] [PATCH V2 3/5] framework/pktgen_base: measure throughput supports multiple yufengmx
2019-11-22  8:58 ` [dts] [PATCH V2 4/5] framework/pktgen_ixia: " yufengmx
2019-11-22  8:58 ` [dts] [PATCH V2 5/5] framework/pktgen_trex: " yufengmx

Reply instructions:

You may reply publically 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=20191122085843.97671-3-yufengx.mo@intel.com \
    --to=yufengx.mo@intel.com \
    --cc=dts@dpdk.org \
    --cc=yinan.wang@intel.com \
    /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

test suite reviews and discussions

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/dts/0 dts/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dts dts/ http://inbox.dpdk.org/dts \
		dts@dpdk.org
	public-inbox-index dts


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dts


AGPL code for this site: git clone https://public-inbox.org/ public-inbox