From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D04BB43861; Mon, 8 Jan 2024 08:34:26 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7435B402B0; Mon, 8 Jan 2024 08:34:26 +0100 (CET) Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com [67.231.156.173]) by mails.dpdk.org (Postfix) with ESMTP id 21C1B40263 for ; Mon, 8 Jan 2024 08:34:25 +0100 (CET) Received: from pps.filterd (m0045851.ppops.net [127.0.0.1]) by mx0b-0016f401.pphosted.com (8.17.1.24/8.17.1.24) with ESMTP id 407MmvJH006262 for ; Sun, 7 Jan 2024 23:34:24 -0800 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h= from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding:content-type; s=pfpt0220; bh=6hMSgFcC PLaog6x9SdjuoLj6pgeWVeD1pJChp37VN84=; b=Rn7NdZMGCjtavXkanX2n57Zn SDCtjK5VsjnXvCcFKId47JGrfWDHwGlT2zzAog6J8KWyLQwsC5tzR6qQuXhxtw/+ TKemyNIToC52sQqwdoi4zT262y/c2YA0ZObdA2+MFb0lQxYqsBEgWkluscaUzP7X g5yasy22VEDf8IXLA4hGgBZe7QeQosGM8eqbS8LIPPpwmJJd2rkN37KpJu2gBRey 016ryuBCB4jQfB5oJx846XWpKBZOCkd20E8nRr+IRLKSiSCRLoTG1Lo0QxNi8SWo 1FKcHhC4oGJHcEhV/avNL+on3RJaJYf6f96hthKk4zThpOnUMjaM9AgvcnOgRw== Received: from dc5-exch01.marvell.com ([199.233.59.181]) by mx0b-0016f401.pphosted.com (PPS) with ESMTPS id 3vf78n3yv5-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT) for ; Sun, 07 Jan 2024 23:34:23 -0800 (PST) Received: from DC5-EXCH01.marvell.com (10.69.176.38) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server (TLS) id 15.0.1497.48; Sun, 7 Jan 2024 23:34:21 -0800 Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server id 15.0.1497.48 via Frontend Transport; Sun, 7 Jan 2024 23:34:21 -0800 Received: from localhost.localdomain (unknown [10.28.34.25]) by maili.marvell.com (Postfix) with ESMTP id 08B6F3F7072; Sun, 7 Jan 2024 23:34:19 -0800 (PST) From: To: Sunil Kumar Kori , Rakesh Kudurumalla CC: Subject: [PATCH] doc: update command scope information Date: Mon, 8 Jan 2024 13:04:15 +0530 Message-ID: <20240108073415.1987009-1-skori@marvell.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Proofpoint-ORIG-GUID: -z0xpLuTWuiiJP_gChxjNgISplIJY97E X-Proofpoint-GUID: -z0xpLuTWuiiJP_gChxjNgISplIJY97E X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.272,Aquarius:18.0.997,Hydra:6.0.619,FMLib:17.11.176.26 definitions=2023-12-09_02,2023-12-07_01,2023-05-22_02 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org From: Sunil Kumar Kori Set of CLI commands are classified into following types; - Commands which must be used in script only. - Commands which must be used via telnet session only. - Commands which can be used either in script or via telnet session. Rename "Dynamic" column to "Scope" to provide clear scope of commands. Signed-off-by: Sunil Kumar Kori --- doc/guides/tools/graph.rst | 211 +++++++++++++++++++------------------ 1 file changed, 108 insertions(+), 103 deletions(-) diff --git a/doc/guides/tools/graph.rst b/doc/guides/tools/graph.rst index 1855d12891..6c559afe35 100644 --- a/doc/guides/tools/graph.rst +++ b/doc/guides/tools/graph.rst @@ -154,109 +154,114 @@ file to express the requested use case configuration. .. table:: Exposed CLIs :widths: auto - +--------------------------------------+-----------------------------------+---------+----------+ - | Command | Description | Dynamic | Optional | - +======================================+===================================+=========+==========+ - | | graph [bsz ] | | Command to express the desired | No | No | - | | [tmo ] [coremask ] | | use case. Also enables/disable | | | - | | model pcap_enable| | pcap capturing. | | | - | | <0/1> num_pcap_pkts pcap_file| | | | - | | | | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | graph start | | Command to start the graph. | No | No | - | | | This command triggers that no | | | - | | | more commands are left to be | | | - | | | parsed and graph initialization | | | - | | | can be started now. It must be | | | - | | | the last command in usecase.cli | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | graph stats show | | Command to dump current graph | Yes | Yes | - | | | statistics. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | help graph | | Command to dump graph help | Yes | Yes | - | | | message. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | | mempool size | | Command to create mempool which | No | No | - | | buffers | | will be further associated to | | | - | | | | RxQ to dequeue the packets. | | | - | | cache numa | | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | help mempool | | Command to dump mempool help | Yes | Yes | - | | | message. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | | ethdev rxq | | Command to create DPDK port with| No | No | - | | txq | | given number of Rx and Tx queues| | | - | | | . Also attach RxQ with given | | | - | | | mempool. Each port can have | | | - | | | single mempool only i.e. all | | | - | | | RxQs will share the same mempool| | | - | | | . | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | ethdev mtu | | Command to configure MTU of DPDK| Yes | Yes | - | | | port. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | | ethdev promiscuous | | Command to enable/disable | Yes | Yes | - | | | | promiscuous mode on DPDK port. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | ethdev show | | Command to dump current ethdev | Yes | Yes | - | | | configuration. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | ethdev stats | | Command to dump current ethdev | Yes | Yes | - | | | statistics. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | | ethdev ip4 addr add | | Command to configure IPv4 | Yes | Yes | - | | netmask | | address on given PCI device. It | | | - | | | is needed if user wishes to use | | | - | | | ``ipv4_lookup`` node. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | | ethdev ip6 addr add | | Command to configure IPv6 | Yes | Yes | - | | netmask | | address on given PCI device. It | | | - | | | is needed if user wishes to use | | | - | | | ``ipv6_lookup`` node. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | help ethdev | | Command to dump ethdev help | Yes | Yes | - | | | message. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | | ipv4_lookup route add ipv4 | | Command to add a route into | Yes | Yes | - | | netmask via | | ``ipv4_lookup`` LPM table. It is| | | - | | | needed if user wishes to route | | | - | | | the packets based on LPM lookup | | | - | | | table. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | help ipv4_lookup | | Command to dump ``ipv4_lookup`` | Yes | Yes | - | | | help message. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | | ipv6_lookup route add ipv6 | | Command to add a route into | Yes | Yes | - | | netmask via | | ``ipv6_lookup`` LPM table. It is| | | - | | | needed if user wishes to route | | | - | | | the packets based on LPM6 lookup| | | - | | | table. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | help ipv6_lookup | | Command to dump ``ipv6_lookup`` | Yes | Yes | - | | | help message. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | neigh add ipv4 | | Command to add a neighbour | Yes | Yes | - | | | information into | | | - | | | ``ipv4_rewrite`` node. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | neigh add ipv6 | | Command to add a neighbour | Yes | Yes | - | | | information into | | | - | | | ``ipv6_rewrite`` node. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | help neigh | | Command to dump neigh help | Yes | Yes | - | | | message. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | | ethdev_rx map port | | Command to add port-queue-core | No | No | - | | queue core | | mapping to ``ethdev_rx`` node. | | | - | | | ``ethdev_rx`` node instance will| | | - | | | be pinned on given core and will| | | - | | | poll on requested port/queue | | | - | | | pair. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - | help ethdev_rx | | Command to dump ethdev_rx help | Yes | Yes | - | | | message. | | | - +--------------------------------------+-----------------------------------+---------+----------+ - + +--------------------------------------+-----------------------------------+-------------------+----------+ + | Command | Description | Scope | Optional | + +======================================+===================================+===================+==========+ + | | graph [bsz ] | | Command to express the desired | :ref:`1 ` | No | + | | [tmo ] [coremask ] | | use case. Also enables/disable | | | + | | model pcap_enable| | pcap capturing. | | | + | | <0/1> num_pcap_pkts pcap_file| | | | + | | | | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | graph start | | Command to start the graph. | :ref:`1 ` | No | + | | | This command triggers that no | | | + | | | more commands are left to be | | | + | | | parsed and graph initialization | | | + | | | can be started now. It must be | | | + | | | the last command in usecase.cli | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | graph stats show | | Command to dump current graph | :ref:`2 ` | Yes | + | | | statistics. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | help graph | | Command to dump graph help | :ref:`2 ` | Yes | + | | | message. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | | mempool size | | Command to create mempool which | :ref:`1 ` | No | + | | buffers | | will be further associated to | | | + | | | | RxQ to dequeue the packets. | | | + | | cache numa | | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | help mempool | | Command to dump mempool help | :ref:`2 ` | Yes | + | | | message. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | | ethdev rxq | | Command to create DPDK port with| :ref:`1 ` | No | + | | txq | | given number of Rx and Tx queues| | | + | | | . Also attach RxQ with given | | | + | | | mempool. Each port can have | | | + | | | single mempool only i.e. all | | | + | | | RxQs will share the same mempool| | | + | | | . | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | ethdev mtu | | Command to configure MTU of DPDK| :ref:`3 ` | Yes | + | | | port. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | | ethdev promiscuous | | Command to enable/disable | :ref:`3 ` | Yes | + | | | | promiscuous mode on DPDK port. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | ethdev show | | Command to dump current ethdev | :ref:`2 ` | Yes | + | | | configuration. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | ethdev stats | | Command to dump current ethdev | :ref:`2 ` | Yes | + | | | statistics. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | | ethdev ip4 addr add | | Command to configure IPv4 | :ref:`3 ` | Yes | + | | netmask | | address on given PCI device. It | | | + | | | is needed if user wishes to use | | | + | | | ``ipv4_lookup`` node. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | | ethdev ip6 addr add | | Command to configure IPv6 | :ref:`3 ` | Yes | + | | netmask | | address on given PCI device. It | | | + | | | is needed if user wishes to use | | | + | | | ``ipv6_lookup`` node. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | help ethdev | | Command to dump ethdev help | :ref:`2 ` | Yes | + | | | message. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | | ipv4_lookup route add ipv4 | | Command to add a route into | :ref:`3 ` | Yes | + | | netmask via | | ``ipv4_lookup`` LPM table. It is| | | + | | | needed if user wishes to route | | | + | | | the packets based on LPM lookup | | | + | | | table. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | help ipv4_lookup | | Command to dump ``ipv4_lookup`` | :ref:`2 ` | Yes | + | | | help message. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | | ipv6_lookup route add ipv6 | | Command to add a route into | :ref:`3 ` | Yes | + | | netmask via | | ``ipv6_lookup`` LPM table. It is| | | + | | | needed if user wishes to route | | | + | | | the packets based on LPM6 lookup| | | + | | | table. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | help ipv6_lookup | | Command to dump ``ipv6_lookup`` | :ref:`2 ` | Yes | + | | | help message. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | neigh add ipv4 | | Command to add a neighbour | :ref:`3 ` | Yes | + | | | information into | | | + | | | ``ipv4_rewrite`` node. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | neigh add ipv6 | | Command to add a neighbour | :ref:`3 ` | Yes | + | | | information into | | | + | | | ``ipv6_rewrite`` node. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | help neigh | | Command to dump neigh help | :ref:`2 ` | Yes | + | | | message. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | | ethdev_rx map port | | Command to add port-queue-core | :ref:`1 ` | No | + | | queue core | | mapping to ``ethdev_rx`` node. | | | + | | | ``ethdev_rx`` node instance will| | | + | | | be pinned on given core and will| | | + | | | poll on requested port/queue | | | + | | | pair. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + | help ethdev_rx | | Command to dump ethdev_rx help | :ref:`2 ` | Yes | + | | | message. | | | + +--------------------------------------+-----------------------------------+-------------------+----------+ + +.. _scopes: + +1. Script only +2. Telnet only +3. Script and telnet both Runtime configuration --------------------- -- 2.25.1