Acked-by: Rakesh Kudurumalla > -----Original Message----- > From: skori@marvell.com > Sent: Monday, January 8, 2024 1:04 PM > To: Sunil Kumar Kori ; Rakesh Kudurumalla > > Cc: dev@dpdk.org > Subject: [PATCH] doc: update command scope information > > 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