From patchwork Thu Jan 22 07:38:25 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jingjing Wu X-Patchwork-Id: 2466 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id F1D065AB1; Thu, 22 Jan 2015 08:38:58 +0100 (CET) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id C88825934 for ; Thu, 22 Jan 2015 08:38:46 +0100 (CET) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga101.fm.intel.com with ESMTP; 21 Jan 2015 23:38:45 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="4.97,862,1389772800"; d="scan'208";a="443542995" Received: from shvmail01.sh.intel.com ([10.239.29.42]) by FMSMGA003.fm.intel.com with ESMTP; 21 Jan 2015 23:25:23 -0800 Received: from shecgisg004.sh.intel.com (shecgisg004.sh.intel.com [10.239.29.89]) by shvmail01.sh.intel.com with ESMTP id t0M7cgK7012955; Thu, 22 Jan 2015 15:38:42 +0800 Received: from shecgisg004.sh.intel.com (localhost [127.0.0.1]) by shecgisg004.sh.intel.com (8.13.6/8.13.6/SuSE Linux 0.8) with ESMTP id t0M7ce5B002098; Thu, 22 Jan 2015 15:38:42 +0800 Received: (from wujingji@localhost) by shecgisg004.sh.intel.com (8.13.6/8.13.6/Submit) id t0M7ceDF002094; Thu, 22 Jan 2015 15:38:40 +0800 From: Jingjing Wu To: dev@dpdk.org Date: Thu, 22 Jan 2015 15:38:25 +0800 Message-Id: <1421912305-2022-7-git-send-email-jingjing.wu@intel.com> X-Mailer: git-send-email 1.7.4.1 In-Reply-To: <1421912305-2022-1-git-send-email-jingjing.wu@intel.com> References: <1421286361-11504-1-git-send-email-jingjing.wu@intel.com> <1421912305-2022-1-git-send-email-jingjing.wu@intel.com> Subject: [dpdk-dev] [PATCH v2 6/6] doc: commands changed in testpmd_funcs for 2tuple amd 5tuple filter X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" document of new commands: - 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) protocol (protocol_value) mask (mask_value) tcp_flags (tcp_flags_value) priority (prio_value) queue (queue_id) - 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip (src_address) dst_port (dst_port_value) src_port (src_port_value) protocol (protocol_value) mask (mask_value) tcp_flags (tcp_flags_value) priority (prio_value) queue (queue_id) Signed-off-by: Jingjing Wu --- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 99 ++++++----------------------- 1 file changed, 21 insertions(+), 78 deletions(-) diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst index be935c2..56d7c82 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -1448,76 +1448,48 @@ Example: priority: disable, 0 queue: 3 -add_2tuple_filter +2tuple_filter ~~~~~~~~~~~~~~~~~ -Add a 2-tuple filter, +Add or delete a 2-tuple filter, which identify packets by specific protocol and destination TCP/UDP port and forwards packets into one of the receive queues. -add_2tuple_filter (port_id) protocol (pro_value) (pro_mask) dst_port (port_value) (port_mask) -flags (flg_value) priority (prio_value) queue (queue_id) index (idx) +2tuple_filter (port_id) (add|del) dst_port (dst_port_value) protocol (protocol_value) +mask (mask_value) tcp_flags (tcp_flags_value) priority (prio_value) queue (queue_id) The available information parameters are: * port_id: the port which the 2-tuple filter assigned on. -* pro_value: IP L4 protocol +* dst_port_value: destination port in L4. -* pro_mask: protocol participates in the match or not, 1 means participate +* protocol_value: IP L4 protocol. -* port_value: destination port in L4. +* mask_value: participates in the match or not by bit for field above, 1b means participate. -* port_mask: destination port participates in the match or not, 1 means participate. +* tcp_flags_value: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP). -* flg_value: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP). +* prio_value: priority of this filter. -* prio_value: the priority of this filter. - -* queue_id: The receive queue associated with this 2-tuple filter +* queue_id: The receive queue associated with this 2-tuple filter. -* index: the index of this 2-tuple filter - -Example: +Example, to add/remove an 2tuple filter rule: .. code-block:: console - testpmd> add_2tuple_filter 0 protocol 0x06 1 dst_port 32 1 flags 0x02 priority 3 queue 3 index 0 - -remove_2tuple_filter -~~~~~~~~~~~~~~~~~~~~ - -Remove a 2-tuple filter - -remove_2tuple_filter (port_id) index (idx) + testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 tcp_flags 0x02 priority 3 queue 3 + testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 tcp_flags 0x02 priority 3 queue 3 -get_2tuple_filter +5tuple_filter ~~~~~~~~~~~~~~~~~ -Get and display a 2-tuple filter - -get_2tuple_filter (port_id) index (idx) - -Example: - -.. code-block:: console - - testpmd> get_2tuple_filter 0 index 0 - - filter[0]: - Destination Port: 0x0020 mask: 1 - protocol: 0x06 mask:1 tcp_flags: 0x02 - priority: 3 queue: 3 - -add_5tuple_filter -~~~~~~~~~~~~~~~~~ - -Add a 5-tuple filter, +Add or delete a 5-tuple filter, which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port) and routes packets into one of the receive queues. -add_5tuple_filter (port_id) dst_ip (dst_address) src_ip (src_address) dst_port (dst_port_value) src_port (src_port_value) -protocol (protocol_value) mask (mask_value) flags (flags_value) priority (prio_value) queue (queue_id) index (idx) +5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip (src_address) dst_port (dst_port_value) src_port (src_port_value) +protocol (protocol_value) mask (mask_value) tcp_flags (tcp_flags_value) priority (prio_value) queue (queue_id) The available information parameters are: @@ -1535,47 +1507,18 @@ The available information parameters are: * mask_value: participates in the match or not by bit for field above, 1b means participate -* flags_value: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP). +* tcp_flags_value: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP). * prio_value: the priority of this filter. * queue_id: The receive queue associated with this 5-tuple filter. -* index: the index of this 5-tuple filter - -Example: - -.. code-block:: console - - testpmd> add_5tuple_filter 1 dst_ip 2.2.2.5 src_ip 2.2.2.4 dst_port 64 src_port 32 protocol 0x06 mask 0x1F flags 0x0 priority 3 queue 3 index 0 - -remove_5tuple_filter -~~~~~~~~~~~~~~~~~~~~ - -Remove a 5-tuple filter - -remove_5tuple_filter (port_id) index (idx) - -get_5tuple_filter -~~~~~~~~~~~~~~~~~ - -Get and display a 5-tuple filter - -get_5tuple_filter (port_id) index (idx) - -Example: +Example, to add/remove an 5tuple filter rule: .. code-block:: console - testpmd> get_5tuple_filter 1 index 0 - - filter[0]: - Destination IP: 0x02020205 mask: 1 - Source IP: 0x02020204 mask: 1 - Destination Port: 0x0040 mask: 1 - Source Port: 0x0020 mask: 1 - protocol: 0x06 mask: 1 - priority: 3 flags: 0x00 queue: 3 + testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 dst_port 64 src_port 32 protocol 0x06 mask 0x1F flags 0x0 priority 3 queue 3 + testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 dst_port 64 src_port 32 protocol 0x06 mask 0x1F flags 0x0 priority 3 queue 3 add_syn_filter ~~~~~~~~~~~~~~