DPDK patches and discussions
 help / color / mirror / Atom feed
From: Konstantin Ananyev <konstantin.ananyev@intel.com>
To: dev@dpdk.org
Cc: akhil.goyal@nxp.com, Konstantin Ananyev <konstantin.ananyev@intel.com>
Subject: [dpdk-dev] [PATCH v2 5/5] doc: update ipsec-secgw guide
Date: Thu,  6 Jun 2019 12:51:51 +0100	[thread overview]
Message-ID: <20190606115151.27805-6-konstantin.ananyev@intel.com> (raw)
In-Reply-To: <20190606115151.27805-1-konstantin.ananyev@intel.com>

Update ipsec-secgw guide to reflect latest changes:
support packets fragmentation/reassembly and related new
command-line options.

Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
---
 doc/guides/sample_app_ug/ipsec_secgw.rst | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

diff --git a/doc/guides/sample_app_ug/ipsec_secgw.rst b/doc/guides/sample_app_ug/ipsec_secgw.rst
index ac118c1a2..ad2d79e75 100644
--- a/doc/guides/sample_app_ug/ipsec_secgw.rst
+++ b/doc/guides/sample_app_ug/ipsec_secgw.rst
@@ -69,7 +69,6 @@ Constraints
 *  No AH mode.
 *  Supported algorithms: AES-CBC, AES-CTR, AES-GCM, 3DES-CBC, HMAC-SHA1 and NULL.
 *  Each SA must be handle by a unique lcore (*1 RX queue per port*).
-*  No chained mbufs.
 
 Compiling the Application
 -------------------------
@@ -98,6 +97,8 @@ The application has a number of command line options::
                         --single-sa SAIDX
                         --rxoffload MASK
                         --txoffload MASK
+                        --mtu MTU
+                        --reassemble NUM
                         -f CONFIG_FILE_PATH
 
 Where:
@@ -111,9 +112,13 @@ Where:
 
 *   ``-u PORTMASK``: hexadecimal bitmask of unprotected ports
 
-*   ``-j FRAMESIZE``: *optional*. Enables jumbo frames with the maximum size
-    specified as FRAMESIZE. If an invalid value is provided as FRAMESIZE
-    then the default value 9000 is used.
+*   ``-j FRAMESIZE``: *optional*. data buffer size (in bytes),
+    in other words maximum data size for one segment.
+    Packets with length bigger then FRAMESIZE still can be received,
+    but will be segmented.
+    Default value: RTE_MBUF_DEFAULT_BUF_SIZE (2176)
+    Minimum value: RTE_MBUF_DEFAULT_BUF_SIZE (2176)
+    Maximum value: UINT16_MAX (65535).
 
 *   ``-l``: enables code-path that uses librte_ipsec.
 
@@ -144,6 +149,15 @@ Where:
     allows user to disable some of the TX HW offload capabilities.
     By default all HW TX offloads are enabled.
 
+*   ``--mtu MTU``: MTU value (in bytes) on all attached ethernet ports.
+    Outgoing packets with length bigger then MTU will be fragmented.
+    Incoming packets with length bigger then MTU will be discarded.
+    Default value: 1500.
+
+*   ``--reassemble NUM``: max number of entries in reassemble fragment table.
+    Zero value disables reassembly functionality.
+    Default value: 0.
+
 *   ``-f CONFIG_FILE_PATH``: the full path of text-based file containing all
     configuration items for running the application (See Configuration file
     syntax section below). ``-f CONFIG_FILE_PATH`` **must** be specified.
-- 
2.17.1


  parent reply	other threads:[~2019-06-06 11:52 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-27 18:44 [dpdk-dev] [PATCH 0/3] examples/ipsec-secgw: support packet fragmentation Konstantin Ananyev
2019-05-27 18:44 ` [dpdk-dev] [PATCH 1/3] examples/ipsec-secgw: fix invalid packet length Konstantin Ananyev
2019-05-27 18:44 ` [dpdk-dev] [PATCH 2/3] examples/ipsec-secgw: support packet fragmentation and reassembly Konstantin Ananyev
2019-05-27 18:44 ` [dpdk-dev] [PATCH 3/3] examples/ipsec-secgw: add multi-segment test cases Konstantin Ananyev
2019-06-06 11:51 ` [dpdk-dev] [PATCH v2 0/5] examples/ipsec-secgw: support packet Konstantin Ananyev
2019-06-06 11:51   ` [dpdk-dev] [PATCH v2 1/5] examples/ipsec-secgw: fix invalid packet length Konstantin Ananyev
2019-06-25 13:04     ` Akhil Goyal
2019-06-25 13:07       ` Ananyev, Konstantin
2019-06-06 11:51   ` [dpdk-dev] [PATCH v2 2/5] examples/ipsec-secgw: support packet fragmentation and reassembly Konstantin Ananyev
2019-06-06 11:51   ` [dpdk-dev] [PATCH v2 3/5] examples/ipsec-secgw: add multi-segment test cases Konstantin Ananyev
2019-06-06 11:51   ` [dpdk-dev] [PATCH v2 4/5] examples/ipsec-secgw: add bypass test case Konstantin Ananyev
2019-06-06 11:51   ` Konstantin Ananyev [this message]
2019-06-25 23:16   ` [dpdk-dev] [PATCH v3 0/4] examples/ipsec-secgw: support packet Konstantin Ananyev
2019-06-25 23:16     ` [dpdk-dev] [PATCH v3 1/4] examples/ipsec-secgw: fix invalid packet length Konstantin Ananyev
2019-06-25 23:16     ` [dpdk-dev] [PATCH v3 2/4] examples/ipsec-secgw: support packet fragmentation and reassembly Konstantin Ananyev
2019-06-25 23:16     ` [dpdk-dev] [PATCH v3 3/4] examples/ipsec-secgw: add multi-segment test cases Konstantin Ananyev
2019-06-25 23:16     ` [dpdk-dev] [PATCH v3 4/4] examples/ipsec-secgw: add bypass test case Konstantin Ananyev
2019-07-01 11:43     ` [dpdk-dev] [PATCH v3 0/4] examples/ipsec-secgw: support packet Akhil Goyal

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=20190606115151.27805-6-konstantin.ananyev@intel.com \
    --to=konstantin.ananyev@intel.com \
    --cc=akhil.goyal@nxp.com \
    --cc=dev@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).