1.. BSD LICENSE 2 Copyright(c) 2010-2016 Intel Corporation. All rights reserved. 3 All rights reserved. 4 5 Redistribution and use in source and binary forms, with or without 6 modification, are permitted provided that the following conditions 7 are met: 8 9 * Redistributions of source code must retain the above copyright 10 notice, this list of conditions and the following disclaimer. 11 * Redistributions in binary form must reproduce the above copyright 12 notice, this list of conditions and the following disclaimer in 13 the documentation and/or other materials provided with the 14 distribution. 15 * Neither the name of Intel Corporation nor the names of its 16 contributors may be used to endorse or promote products derived 17 from this software without specific prior written permission. 18 19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31.. _testpmd_runtime: 32 33Testpmd Runtime Functions 34========================= 35 36Where the testpmd application is started in interactive mode, (``-i|--interactive``), 37it displays a prompt that can be used to start and stop forwarding, 38configure the application, display statistics (including the extended NIC 39statistics aka xstats) , set the Flow Director and other tasks:: 40 41 testpmd> 42 43The testpmd prompt has some, limited, readline support. 44Common bash command-line functions such as ``Ctrl+a`` and ``Ctrl+e`` to go to the start and end of the prompt line are supported 45as well as access to the command history via the up-arrow. 46 47There is also support for tab completion. 48If you type a partial command and hit ``<TAB>`` you get a list of the available completions: 49 50.. code-block:: console 51 52 testpmd> show port <TAB> 53 54 info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap X 55 info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all 56 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap X 57 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all 58 ... 59 60 61.. note:: 62 63 Some examples in this document are too long to fit on one line are are shown wrapped at `"\\"` for display purposes:: 64 65 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 66 (pause_time) (send_xon) (port_id) 67 68In the real ``testpmd>`` prompt these commands should be on a single line. 69 70Help Functions 71-------------- 72 73The testpmd has on-line help for the functions that are available at runtime. 74These are divided into sections and can be accessed using help, help section or help all: 75 76.. code-block:: console 77 78 testpmd> help 79 80 help control : Start and stop forwarding. 81 help display : Displaying port, stats and config information. 82 help config : Configuration information. 83 help ports : Configuring ports. 84 help registers : Reading and setting port registers. 85 help filters : Filters configuration help. 86 help all : All of the above sections. 87 88 89Control Functions 90----------------- 91 92start 93~~~~~ 94 95Start packet forwarding with current configuration:: 96 97 testpmd> start 98 99start tx_first 100~~~~~~~~~~~~~~ 101 102Start packet forwarding with current configuration after sending specified number of bursts of packets:: 103 104 testpmd> start tx_first (""|burst_num) 105 106The default burst number is 1 when ``burst_num`` not presented. 107 108stop 109~~~~ 110 111Stop packet forwarding, and display accumulated statistics:: 112 113 testpmd> stop 114 115quit 116~~~~ 117 118Quit to prompt:: 119 120 testpmd> quit 121 122 123Display Functions 124----------------- 125 126The functions in the following sections are used to display information about the 127testpmd configuration or the NIC status. 128 129show port 130~~~~~~~~~ 131 132Display information for a given port or all ports:: 133 134 testpmd> show port (info|stats|xstats|fdir|stat_qmap|dcb_tc|cap) (port_id|all) 135 136The available information categories are: 137 138* ``info``: General port information such as MAC address. 139 140* ``stats``: RX/TX statistics. 141 142* ``xstats``: RX/TX extended NIC statistics. 143 144* ``fdir``: Flow Director information and statistics. 145 146* ``stat_qmap``: Queue statistics mapping. 147 148* ``dcb_tc``: DCB information such as TC mapping. 149 150* ``cap``: Supported offload capabilities. 151 152For example: 153 154.. code-block:: console 155 156 testpmd> show port info 0 157 158 ********************* Infos for port 0 ********************* 159 160 MAC address: XX:XX:XX:XX:XX:XX 161 Connect to socket: 0 162 memory allocation on the socket: 0 163 Link status: up 164 Link speed: 40000 Mbps 165 Link duplex: full-duplex 166 Promiscuous mode: enabled 167 Allmulticast mode: disabled 168 Maximum number of MAC addresses: 64 169 Maximum number of MAC addresses of hash filtering: 0 170 VLAN offload: 171 strip on 172 filter on 173 qinq(extend) off 174 Redirection table size: 512 175 Supported flow types: 176 ipv4-frag 177 ipv4-tcp 178 ipv4-udp 179 ipv4-sctp 180 ipv4-other 181 ipv6-frag 182 ipv6-tcp 183 ipv6-udp 184 ipv6-sctp 185 ipv6-other 186 l2_payload 187 port 188 vxlan 189 geneve 190 nvgre 191 192show port rss reta 193~~~~~~~~~~~~~~~~~~ 194 195Display the rss redirection table entry indicated by masks on port X:: 196 197 testpmd> show port (port_id) rss reta (size) (mask0, mask1...) 198 199size is used to indicate the hardware supported reta size 200 201show port rss-hash 202~~~~~~~~~~~~~~~~~~ 203 204Display the RSS hash functions and RSS hash key of a port:: 205 206 testpmd> show port (port_id) rss-hash ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|ipv6-udp-ex [key] 207 208clear port 209~~~~~~~~~~ 210 211Clear the port statistics for a given port or for all ports:: 212 213 testpmd> clear port (info|stats|xstats|fdir|stat_qmap) (port_id|all) 214 215For example:: 216 217 testpmd> clear port stats all 218 219show (rxq|txq) 220~~~~~~~~~~~~~~ 221 222Display information for a given port's RX/TX queue:: 223 224 testpmd> show (rxq|txq) info (port_id) (queue_id) 225 226show config 227~~~~~~~~~~~ 228 229Displays the configuration of the application. 230The configuration comes from the command-line, the runtime or the application defaults:: 231 232 testpmd> show config (rxtx|cores|fwd|txpkts) 233 234The available information categories are: 235 236* ``rxtx``: RX/TX configuration items. 237 238* ``cores``: List of forwarding cores. 239 240* ``fwd``: Packet forwarding configuration. 241 242* ``txpkts``: Packets to TX configuration. 243 244For example: 245 246.. code-block:: console 247 248 testpmd> show config rxtx 249 250 io packet forwarding - CRC stripping disabled - packets/burst=16 251 nb forwarding cores=2 - nb forwarding ports=1 252 RX queues=1 - RX desc=128 - RX free threshold=0 253 RX threshold registers: pthresh=8 hthresh=8 wthresh=4 254 TX queues=1 - TX desc=512 - TX free threshold=0 255 TX threshold registers: pthresh=36 hthresh=0 wthresh=0 256 TX RS bit threshold=0 - TXQ flags=0x0 257 258set fwd 259~~~~~~~ 260 261Set the packet forwarding mode:: 262 263 testpmd> set fwd (io|mac|macswap|flowgen| \ 264 rxonly|txonly|csum|icmpecho) (""|retry) 265 266``retry`` can be specified for forwarding engines except ``rx_only``. 267 268The available information categories are: 269 270* ``io``: Forwards packets "as-is" in I/O mode. 271 This is the fastest possible forwarding operation as it does not access packets data. 272 This is the default mode. 273 274* ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them. 275 Default application behaviour is to set source Ethernet address to that of the transmitting interface, and destination 276 address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or 277 'eth-peer-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address. 278 279* ``macswap``: MAC swap forwarding mode. 280 Swaps the source and the destination Ethernet addresses of packets before forwarding them. 281 282* ``flowgen``: Multi-flow generation mode. 283 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic. 284 285* ``rxonly``: Receives packets but doesn't transmit them. 286 287* ``txonly``: Generates and transmits packets without receiving any. 288 289* ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet. 290 291* ``icmpecho``: Receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies. 292 293* ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``. 294 295Note: TX timestamping is only available in the "Full Featured" TX path. To force ``testpmd`` into this mode set ``--txqflags=0``. 296 297Example:: 298 299 testpmd> set fwd rxonly 300 301 Set rxonly packet forwarding mode 302 303 304read rxd 305~~~~~~~~ 306 307Display an RX descriptor for a port RX queue:: 308 309 testpmd> read rxd (port_id) (queue_id) (rxd_id) 310 311For example:: 312 313 testpmd> read rxd 0 0 4 314 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180 315 316read txd 317~~~~~~~~ 318 319Display a TX descriptor for a port TX queue:: 320 321 testpmd> read txd (port_id) (queue_id) (txd_id) 322 323For example:: 324 325 testpmd> read txd 0 0 4 326 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C 327 328show vf stats 329~~~~~~~~~~~~~ 330 331Display VF statistics:: 332 333 testpmd> show vf stats (port_id) (vf_id) 334 335clear vf stats 336~~~~~~~~~~~~~~ 337 338Reset VF statistics:: 339 340 testpmd> clear vf stats (port_id) (vf_id) 341 342Configuration Functions 343----------------------- 344 345The testpmd application can be configured from the runtime as well as from the command-line. 346 347This section details the available configuration functions that are available. 348 349.. note:: 350 351 Configuration changes only become active when forwarding is started/restarted. 352 353set default 354~~~~~~~~~~~ 355 356Reset forwarding to the default configuration:: 357 358 testpmd> set default 359 360set verbose 361~~~~~~~~~~~ 362 363Set the debug verbosity level:: 364 365 testpmd> set verbose (level) 366 367Currently the only available levels are 0 (silent except for error) and 1 (fully verbose). 368 369set nbport 370~~~~~~~~~~ 371 372Set the number of ports used by the application: 373 374set nbport (num) 375 376This is equivalent to the ``--nb-ports`` command-line option. 377 378set nbcore 379~~~~~~~~~~ 380 381Set the number of cores used by the application:: 382 383 testpmd> set nbcore (num) 384 385This is equivalent to the ``--nb-cores`` command-line option. 386 387.. note:: 388 389 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port. 390 391set coremask 392~~~~~~~~~~~~ 393 394Set the forwarding cores hexadecimal mask:: 395 396 testpmd> set coremask (mask) 397 398This is equivalent to the ``--coremask`` command-line option. 399 400.. note:: 401 402 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding. 403 404set portmask 405~~~~~~~~~~~~ 406 407Set the forwarding ports hexadecimal mask:: 408 409 testpmd> set portmask (mask) 410 411This is equivalent to the ``--portmask`` command-line option. 412 413set burst 414~~~~~~~~~ 415 416Set number of packets per burst:: 417 418 testpmd> set burst (num) 419 420This is equivalent to the ``--burst command-line`` option. 421 422When retry is enabled, the transmit delay time and number of retries can also be set:: 423 424 testpmd> set burst tx delay (microseconds) retry (num) 425 426set txpkts 427~~~~~~~~~~ 428 429Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode:: 430 431 testpmd> set txpkts (x[,y]*) 432 433Where x[,y]* represents a CSV list of values, without white space. 434 435set txsplit 436~~~~~~~~~~~ 437 438Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes:: 439 440 testpmd> set txsplit (off|on|rand) 441 442Where: 443 444* ``off`` disable packet copy & split for CSUM mode. 445 446* ``on`` split outgoing packet into multiple segments. Size of each segment 447 and number of segments per packet is determined by ``set txpkts`` command 448 (see above). 449 450* ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments. 451 452set corelist 453~~~~~~~~~~~~ 454 455Set the list of forwarding cores:: 456 457 testpmd> set corelist (x[,y]*) 458 459For example, to change the forwarding cores: 460 461.. code-block:: console 462 463 testpmd> set corelist 3,1 464 testpmd> show config fwd 465 466 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled 467 Logical Core 3 (socket 0) forwards packets on 1 streams: 468 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01 469 Logical Core 1 (socket 0) forwards packets on 1 streams: 470 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00 471 472.. note:: 473 474 The cores are used in the same order as specified on the command line. 475 476set portlist 477~~~~~~~~~~~~ 478 479Set the list of forwarding ports:: 480 481 testpmd> set portlist (x[,y]*) 482 483For example, to change the port forwarding: 484 485.. code-block:: console 486 487 testpmd> set portlist 0,2,1,3 488 testpmd> show config fwd 489 490 io packet forwarding - ports=4 - cores=1 - streams=4 491 Logical Core 3 (socket 0) forwards packets on 4 streams: 492 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01 493 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00 494 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03 495 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02 496 497set tx loopback 498~~~~~~~~~~~~~~~ 499 500Enable/disable tx loopback:: 501 502 testpmd> set tx loopback (port_id) (on|off) 503 504set drop enable 505~~~~~~~~~~~~~~~ 506 507set drop enable bit for all queues:: 508 509 testpmd> set all queues drop (port_id) (on|off) 510 511set split drop enable (for VF) 512~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 513 514set split drop enable bit for VF from PF:: 515 516 testpmd> set vf split drop (port_id) (vf_id) (on|off) 517 518set mac antispoof (for VF) 519~~~~~~~~~~~~~~~~~~~~~~~~~~ 520 521Set mac antispoof for a VF from the PF:: 522 523 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off) 524 525set macsec offload 526~~~~~~~~~~~~~~~~~~ 527 528Enable/disable MACsec offload:: 529 530 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off) 531 testpmd> set macsec offload (port_id) off 532 533set macsec sc 534~~~~~~~~~~~~~ 535 536Configure MACsec secure connection (SC):: 537 538 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi) 539 540.. note:: 541 542 The pi argument is ignored for tx. 543 Check the NIC Datasheet for hardware limits. 544 545set macsec sa 546~~~~~~~~~~~~~ 547 548Configure MACsec secure association (SA):: 549 550 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key) 551 552.. note:: 553 554 The IDX value must be 0 or 1. 555 Check the NIC Datasheet for hardware limits. 556 557set broadcast mode (for VF) 558~~~~~~~~~~~~~~~~~~~~~~~~~~~ 559 560Set broadcast mode for a VF from the PF:: 561 562 testpmd> set vf broadcast (port_id) (vf_id) (on|off) 563 564vlan set strip 565~~~~~~~~~~~~~~ 566 567Set the VLAN strip on a port:: 568 569 testpmd> vlan set strip (on|off) (port_id) 570 571vlan set stripq 572~~~~~~~~~~~~~~~ 573 574Set the VLAN strip for a queue on a port:: 575 576 testpmd> vlan set stripq (on|off) (port_id,queue_id) 577 578vlan set stripq (for VF) 579~~~~~~~~~~~~~~~~~~~~~~~~ 580 581Set VLAN strip for all queues in a pool for a VF from the PF:: 582 583 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off) 584 585vlan set insert (for VF) 586~~~~~~~~~~~~~~~~~~~~~~~~ 587 588Set VLAN insert for a VF from the PF:: 589 590 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id) 591 592vlan set tag (for VF) 593~~~~~~~~~~~~~~~~~~~~~ 594 595Set VLAN tag for a VF from the PF:: 596 597 testpmd> set vf vlan tag (port_id) (vf_id) (on|off) 598 599vlan set antispoof (for VF) 600~~~~~~~~~~~~~~~~~~~~~~~~~~~ 601 602Set VLAN antispoof for a VF from the PF:: 603 604 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off) 605 606vlan set filter 607~~~~~~~~~~~~~~~ 608 609Set the VLAN filter on a port:: 610 611 testpmd> vlan set filter (on|off) (port_id) 612 613vlan set qinq 614~~~~~~~~~~~~~ 615 616Set the VLAN QinQ (extended queue in queue) on for a port:: 617 618 testpmd> vlan set qinq (on|off) (port_id) 619 620vlan set tpid 621~~~~~~~~~~~~~ 622 623Set the inner or outer VLAN TPID for packet filtering on a port:: 624 625 testpmd> vlan set (inner|outer) tpid (value) (port_id) 626 627.. note:: 628 629 TPID value must be a 16-bit number (value <= 65536). 630 631rx_vlan add 632~~~~~~~~~~~ 633 634Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID:: 635 636 testpmd> rx_vlan add (vlan_id|all) (port_id) 637 638.. note:: 639 640 VLAN filter must be set on that port. VLAN ID < 4096. 641 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries 642 in VFTA table. This is important if enabling all vlan_ids. 643 644rx_vlan rm 645~~~~~~~~~~ 646 647Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID:: 648 649 testpmd> rx_vlan rm (vlan_id|all) (port_id) 650 651rx_vlan add (for VF) 652~~~~~~~~~~~~~~~~~~~~ 653 654Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID:: 655 656 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask) 657 658rx_vlan rm (for VF) 659~~~~~~~~~~~~~~~~~~~ 660 661Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID:: 662 663 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask) 664 665tunnel_filter add 666~~~~~~~~~~~~~~~~~ 667 668Add a tunnel filter on a port:: 669 670 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \ 671 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\ 672 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id) 673 674The available information categories are: 675 676* ``vxlan``: Set tunnel type as VXLAN. 677 678* ``nvgre``: Set tunnel type as NVGRE. 679 680* ``ipingre``: Set tunnel type as IP-in-GRE. 681 682* ``imac-ivlan``: Set filter type as Inner MAC and VLAN. 683 684* ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID. 685 686* ``imac-tenid``: Set filter type as Inner MAC and tenant ID. 687 688* ``imac``: Set filter type as Inner MAC. 689 690* ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID. 691 692* ``oip``: Set filter type as Outer IP. 693 694* ``iip``: Set filter type as Inner IP. 695 696Example:: 697 698 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \ 699 192.168.2.2 0 ipingre oip 1 1 700 701 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP. 702 703tunnel_filter remove 704~~~~~~~~~~~~~~~~~~~~ 705 706Remove a tunnel filter on a port:: 707 708 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \ 709 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\ 710 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id) 711 712rx_vxlan_port add 713~~~~~~~~~~~~~~~~~ 714 715Add an UDP port for VXLAN packet filter on a port:: 716 717 testpmd> rx_vxlan_port add (udp_port) (port_id) 718 719rx_vxlan_port remove 720~~~~~~~~~~~~~~~~~~~~ 721 722Remove an UDP port for VXLAN packet filter on a port:: 723 724 testpmd> rx_vxlan_port rm (udp_port) (port_id) 725 726tx_vlan set 727~~~~~~~~~~~ 728 729Set hardware insertion of VLAN IDs in packets sent on a port:: 730 731 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer] 732 733For example, set a single VLAN ID (5) insertion on port 0:: 734 735 tx_vlan set 0 5 736 737Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1:: 738 739 tx_vlan set 1 2 3 740 741 742tx_vlan set pvid 743~~~~~~~~~~~~~~~~ 744 745Set port based hardware insertion of VLAN ID in packets sent on a port:: 746 747 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off) 748 749tx_vlan reset 750~~~~~~~~~~~~~ 751 752Disable hardware insertion of a VLAN header in packets sent on a port:: 753 754 testpmd> tx_vlan reset (port_id) 755 756csum set 757~~~~~~~~ 758 759Select hardware or software calculation of the checksum when 760transmitting a packet using the ``csum`` forwarding engine:: 761 762 testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id) 763 764Where: 765 766* ``ip|udp|tcp|sctp`` always relate to the inner layer. 767 768* ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized 769 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are 770 supported). See also the ``csum parse-tunnel`` command. 771 772.. note:: 773 774 Check the NIC Datasheet for hardware limits. 775 776csum parse-tunnel 777~~~~~~~~~~~~~~~~~ 778 779Define how tunneled packets should be handled by the csum forward 780engine:: 781 782 testpmd> csum parse-tunnel (on|off) (tx_port_id) 783 784If enabled, the csum forward engine will try to recognize supported 785tunnel headers (vxlan, gre, ipip). 786 787If disabled, treat tunnel packets as non-tunneled packets (a inner 788header is handled as a packet payload). 789 790.. note:: 791 792 The port argument is the TX port like in the ``csum set`` command. 793 794Example: 795 796Consider a packet in packet like the following:: 797 798 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in 799 800* If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set`` 801 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the 802 ``outer-ip parameter`` relates to the outer headers (here ``ipv4_out``). 803 804* If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set`` 805 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``. 806 807csum show 808~~~~~~~~~ 809 810Display tx checksum offload configuration:: 811 812 testpmd> csum show (port_id) 813 814tso set 815~~~~~~~ 816 817Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine:: 818 819 testpmd> tso set (segsize) (port_id) 820 821.. note:: 822 823 Check the NIC datasheet for hardware limits. 824 825tso show 826~~~~~~~~ 827 828Display the status of TCP Segmentation Offload:: 829 830 testpmd> tso show (port_id) 831 832mac_addr add 833~~~~~~~~~~~~ 834 835Add an alternative MAC address to a port:: 836 837 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX) 838 839mac_addr remove 840~~~~~~~~~~~~~~~ 841 842Remove a MAC address from a port:: 843 844 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX) 845 846mac_addr add (for VF) 847~~~~~~~~~~~~~~~~~~~~~ 848 849Add an alternative MAC address for a VF to a port:: 850 851 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX) 852 853mac_addr set 854~~~~~~~~~~~~ 855 856Set the default MAC address for a port:: 857 858 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX) 859 860mac_addr set (for VF) 861~~~~~~~~~~~~~~~~~~~~~ 862 863Set the MAC address for a VF from the PF:: 864 865 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX) 866 867set port-uta 868~~~~~~~~~~~~ 869 870Set the unicast hash filter(s) on/off for a port:: 871 872 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off) 873 874set promisc 875~~~~~~~~~~~ 876 877Set the promiscuous mode on for a port or for all ports. 878In promiscuous mode packets are not dropped if they aren't for the specified MAC address:: 879 880 testpmd> set promisc (port_id|all) (on|off) 881 882set allmulti 883~~~~~~~~~~~~ 884 885Set the allmulti mode for a port or for all ports:: 886 887 testpmd> set allmulti (port_id|all) (on|off) 888 889Same as the ifconfig (8) option. Controls how multicast packets are handled. 890 891set promisc (for VF) 892~~~~~~~~~~~~~~~~~~~~ 893 894Set the unicast promiscuous mode for a VF from PF. 895It's supported by Intel i40e NICs now. 896In promiscuous mode packets are not dropped if they aren't for the specified MAC address:: 897 898 testpmd> set vf promisc (port_id) (vf_id) (on|off) 899 900set allmulticast (for VF) 901~~~~~~~~~~~~~~~~~~~~~~~~~ 902 903Set the multicast promiscuous mode for a VF from PF. 904It's supported by Intel i40e NICs now. 905In promiscuous mode packets are not dropped if they aren't for the specified MAC address:: 906 907 testpmd> set vf allmulti (port_id) (vf_id) (on|off) 908 909set tx max bandwidth (for VF) 910~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 911 912Set TX max absolute bandwidth (Mbps) for a VF from PF:: 913 914 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth) 915 916set tc tx min bandwidth (for VF) 917~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 918 919Set all TCs' TX min relative bandwidth (%) for a VF from PF:: 920 921 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...) 922 923set tc tx max bandwidth (for VF) 924~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 925 926Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF:: 927 928 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth) 929 930set tc strict link priority mode 931~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 932 933Set some TCs' strict link priority mode on a physical port:: 934 935 testpmd> set tx strict-link-priority (port_id) (tc_bitmap) 936 937set tc tx min bandwidth 938~~~~~~~~~~~~~~~~~~~~~~~ 939 940Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs:: 941 942 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...) 943 944set flow_ctrl rx 945~~~~~~~~~~~~~~~~ 946 947Set the link flow control parameter on a port:: 948 949 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 950 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \ 951 autoneg (on|off) (port_id) 952 953Where: 954 955* ``high_water`` (integer): High threshold value to trigger XOFF. 956 957* ``low_water`` (integer): Low threshold value to trigger XON. 958 959* ``pause_time`` (integer): Pause quota in the Pause frame. 960 961* ``send_xon`` (0/1): Send XON frame. 962 963* ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames. 964 965* ``autoneg``: Change the auto-negotiation parameter. 966 967set pfc_ctrl rx 968~~~~~~~~~~~~~~~ 969 970Set the priority flow control parameter on a port:: 971 972 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 973 (pause_time) (priority) (port_id) 974 975Where: 976 977* ``high_water`` (integer): High threshold value. 978 979* ``low_water`` (integer): Low threshold value. 980 981* ``pause_time`` (integer): Pause quota in the Pause frame. 982 983* ``priority`` (0-7): VLAN User Priority. 984 985set stat_qmap 986~~~~~~~~~~~~~ 987 988Set statistics mapping (qmapping 0..15) for RX/TX queue on port:: 989 990 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping) 991 992For example, to set rx queue 2 on port 0 to mapping 5:: 993 994 testpmd>set stat_qmap rx 0 2 5 995 996set port - rx/tx (for VF) 997~~~~~~~~~~~~~~~~~~~~~~~~~ 998 999Set VF receive/transmit from a port:: 1000 1001 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off) 1002 1003set port - mac address filter (for VF) 1004~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1005 1006Add/Remove unicast or multicast MAC addr filter for a VF:: 1007 1008 testpmd> set port (port_id) vf (vf_id) (mac_addr) \ 1009 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off) 1010 1011set port - rx mode(for VF) 1012~~~~~~~~~~~~~~~~~~~~~~~~~~ 1013 1014Set the VF receive mode of a port:: 1015 1016 testpmd> set port (port_id) vf (vf_id) \ 1017 rxmode (AUPE|ROPE|BAM|MPE) (on|off) 1018 1019The available receive modes are: 1020 1021* ``AUPE``: Accepts untagged VLAN. 1022 1023* ``ROPE``: Accepts unicast hash. 1024 1025* ``BAM``: Accepts broadcast packets. 1026 1027* ``MPE``: Accepts all multicast packets. 1028 1029set port - tx_rate (for Queue) 1030~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1031 1032Set TX rate limitation for a queue on a port:: 1033 1034 testpmd> set port (port_id) queue (queue_id) rate (rate_value) 1035 1036set port - tx_rate (for VF) 1037~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1038 1039Set TX rate limitation for queues in VF on a port:: 1040 1041 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask) 1042 1043set port - mirror rule 1044~~~~~~~~~~~~~~~~~~~~~~ 1045 1046Set pool or vlan type mirror rule for a port:: 1047 1048 testpmd> set port (port_id) mirror-rule (rule_id) \ 1049 (pool-mirror-up|pool-mirror-down|vlan-mirror) \ 1050 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off) 1051 1052Set link mirror rule for a port:: 1053 1054 testpmd> set port (port_id) mirror-rule (rule_id) \ 1055 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off) 1056 1057For example to enable mirror traffic with vlan 0,1 to pool 0:: 1058 1059 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on 1060 1061reset port - mirror rule 1062~~~~~~~~~~~~~~~~~~~~~~~~ 1063 1064Reset a mirror rule for a port:: 1065 1066 testpmd> reset port (port_id) mirror-rule (rule_id) 1067 1068set flush_rx 1069~~~~~~~~~~~~ 1070 1071Set the flush on RX streams before forwarding. 1072The default is flush ``on``. 1073Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams:: 1074 1075 testpmd> set flush_rx off 1076 1077set bypass mode 1078~~~~~~~~~~~~~~~ 1079 1080Set the bypass mode for the lowest port on bypass enabled NIC:: 1081 1082 testpmd> set bypass mode (normal|bypass|isolate) (port_id) 1083 1084set bypass event 1085~~~~~~~~~~~~~~~~ 1086 1087Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled:: 1088 1089 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \ 1090 mode (normal|bypass|isolate) (port_id) 1091 1092Where: 1093 1094* ``timeout``: Enable bypass after watchdog timeout. 1095 1096* ``os_on``: Enable bypass when OS/board is powered on. 1097 1098* ``os_off``: Enable bypass when OS/board is powered off. 1099 1100* ``power_on``: Enable bypass when power supply is turned on. 1101 1102* ``power_off``: Enable bypass when power supply is turned off. 1103 1104 1105set bypass timeout 1106~~~~~~~~~~~~~~~~~~ 1107 1108Set the bypass watchdog timeout to ``n`` seconds where 0 = instant:: 1109 1110 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32) 1111 1112show bypass config 1113~~~~~~~~~~~~~~~~~~ 1114 1115Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC:: 1116 1117 testpmd> show bypass config (port_id) 1118 1119set link up 1120~~~~~~~~~~~ 1121 1122Set link up for a port:: 1123 1124 testpmd> set link-up port (port id) 1125 1126set link down 1127~~~~~~~~~~~~~ 1128 1129Set link down for a port:: 1130 1131 testpmd> set link-down port (port id) 1132 1133E-tag set 1134~~~~~~~~~ 1135 1136Enable E-tag insertion for a VF on a port:: 1137 1138 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id) 1139 1140Disable E-tag insertion for a VF on a port:: 1141 1142 testpmd> E-tag set insertion off port (port_id) vf (vf_id) 1143 1144Enable/disable E-tag stripping on a port:: 1145 1146 testpmd> E-tag set stripping (on|off) port (port_id) 1147 1148Enable/disable E-tag based forwarding on a port:: 1149 1150 testpmd> E-tag set forwarding (on|off) port (port_id) 1151 1152Add an E-tag forwarding filter on a port:: 1153 1154 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id) 1155 1156Delete an E-tag forwarding filter on a port:: 1157 testpmd> E-tag set filter del e-tag-id (value) port (port_id) 1158 1159ptype mapping 1160~~~~~~~~~~~~~ 1161 1162List all items from the ptype mapping table:: 1163 1164 testpmd> ptype mapping get (port_id) (valid_only) 1165 1166Where: 1167 1168* ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0). 1169 1170Replace a specific or a group of software defined ptype with a new one:: 1171 1172 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type) 1173 1174where: 1175 1176* ``target``: A specific software ptype or a mask to represent a group of software ptypes. 1177 1178* ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1). 1179 1180* ``pkt_type``: The new software ptype to replace the old ones. 1181 1182Update hardware defined ptype to software defined packet type mapping table:: 1183 1184 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype) 1185 1186where: 1187 1188* ``hw_ptype``: hardware ptype as the index of the ptype mapping table. 1189 1190* ``sw_ptype``: software ptype as the value of the ptype mapping table. 1191 1192Reset ptype mapping table:: 1193 1194 testpmd> ptype mapping reset (port_id) 1195 1196Port Functions 1197-------------- 1198 1199The following sections show functions for configuring ports. 1200 1201.. note:: 1202 1203 Port configuration changes only become active when forwarding is started/restarted. 1204 1205port attach 1206~~~~~~~~~~~ 1207 1208Attach a port specified by pci address or virtual device args:: 1209 1210 testpmd> port attach (identifier) 1211 1212To attach a new pci device, the device should be recognized by kernel first. 1213Then it should be moved under DPDK management. 1214Finally the port can be attached to testpmd. 1215 1216For example, to move a pci device using ixgbe under DPDK management: 1217 1218.. code-block:: console 1219 1220 # Check the status of the available devices. 1221 ./usertools/dpdk-devbind.py --status 1222 1223 Network devices using DPDK-compatible driver 1224 ============================================ 1225 <none> 1226 1227 Network devices using kernel driver 1228 =================================== 1229 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused= 1230 1231 1232 # Bind the device to igb_uio. 1233 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0 1234 1235 1236 # Recheck the status of the devices. 1237 ./usertools/dpdk-devbind.py --status 1238 Network devices using DPDK-compatible driver 1239 ============================================ 1240 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused= 1241 1242To attach a port created by virtual device, above steps are not needed. 1243 1244For example, to attach a port whose pci address is 0000:0a:00.0. 1245 1246.. code-block:: console 1247 1248 testpmd> port attach 0000:0a:00.0 1249 Attaching a new port... 1250 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 1251 EAL: probe driver: 8086:10fb rte_ixgbe_pmd 1252 EAL: PCI memory mapped at 0x7f83bfa00000 1253 EAL: PCI memory mapped at 0x7f83bfa80000 1254 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5 1255 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb 1256 Port 0 is attached. Now total ports is 1 1257 Done 1258 1259For example, to attach a port created by pcap PMD. 1260 1261.. code-block:: console 1262 1263 testpmd> port attach net_pcap0 1264 Attaching a new port... 1265 PMD: Initializing pmd_pcap for net_pcap0 1266 PMD: Creating pcap-backed ethdev on numa socket 0 1267 Port 0 is attached. Now total ports is 1 1268 Done 1269 1270In this case, identifier is ``net_pcap0``. 1271This identifier format is the same as ``--vdev`` format of DPDK applications. 1272 1273For example, to re-attach a bonded port which has been previously detached, 1274the mode and slave parameters must be given. 1275 1276.. code-block:: console 1277 1278 testpmd> port attach net_bond_0,mode=0,slave=1 1279 Attaching a new port... 1280 EAL: Initializing pmd_bond for net_bond_0 1281 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0. 1282 Port 0 is attached. Now total ports is 1 1283 Done 1284 1285 1286port detach 1287~~~~~~~~~~~ 1288 1289Detach a specific port:: 1290 1291 testpmd> port detach (port_id) 1292 1293Before detaching a port, the port should be stopped and closed. 1294 1295For example, to detach a pci device port 0. 1296 1297.. code-block:: console 1298 1299 testpmd> port stop 0 1300 Stopping ports... 1301 Done 1302 testpmd> port close 0 1303 Closing ports... 1304 Done 1305 1306 testpmd> port detach 0 1307 Detaching a port... 1308 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 1309 EAL: remove driver: 8086:10fb rte_ixgbe_pmd 1310 EAL: PCI memory unmapped at 0x7f83bfa00000 1311 EAL: PCI memory unmapped at 0x7f83bfa80000 1312 Done 1313 1314 1315For example, to detach a virtual device port 0. 1316 1317.. code-block:: console 1318 1319 testpmd> port stop 0 1320 Stopping ports... 1321 Done 1322 testpmd> port close 0 1323 Closing ports... 1324 Done 1325 1326 testpmd> port detach 0 1327 Detaching a port... 1328 PMD: Closing pcap ethdev on numa socket 0 1329 Port 'net_pcap0' is detached. Now total ports is 0 1330 Done 1331 1332To remove a pci device completely from the system, first detach the port from testpmd. 1333Then the device should be moved under kernel management. 1334Finally the device can be removed using kernel pci hotplug functionality. 1335 1336For example, to move a pci device under kernel management: 1337 1338.. code-block:: console 1339 1340 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0 1341 1342 ./usertools/dpdk-devbind.py --status 1343 1344 Network devices using DPDK-compatible driver 1345 ============================================ 1346 <none> 1347 1348 Network devices using kernel driver 1349 =================================== 1350 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio 1351 1352To remove a port created by a virtual device, above steps are not needed. 1353 1354port start 1355~~~~~~~~~~ 1356 1357Start all ports or a specific port:: 1358 1359 testpmd> port start (port_id|all) 1360 1361port stop 1362~~~~~~~~~ 1363 1364Stop all ports or a specific port:: 1365 1366 testpmd> port stop (port_id|all) 1367 1368port close 1369~~~~~~~~~~ 1370 1371Close all ports or a specific port:: 1372 1373 testpmd> port close (port_id|all) 1374 1375port start/stop queue 1376~~~~~~~~~~~~~~~~~~~~~ 1377 1378Start/stop a rx/tx queue on a specific port:: 1379 1380 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop) 1381 1382Only take effect when port is started. 1383 1384port config - speed 1385~~~~~~~~~~~~~~~~~~~ 1386 1387Set the speed and duplex mode for all ports or a specific port:: 1388 1389 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \ 1390 duplex (half|full|auto) 1391 1392port config - queues/descriptors 1393~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1394 1395Set number of queues/descriptors for rxq, txq, rxd and txd:: 1396 1397 testpmd> port config all (rxq|txq|rxd|txd) (value) 1398 1399This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options. 1400 1401port config - max-pkt-len 1402~~~~~~~~~~~~~~~~~~~~~~~~~ 1403 1404Set the maximum packet length:: 1405 1406 testpmd> port config all max-pkt-len (value) 1407 1408This is equivalent to the ``--max-pkt-len`` command-line option. 1409 1410port config - CRC Strip 1411~~~~~~~~~~~~~~~~~~~~~~~ 1412 1413Set hardware CRC stripping on or off for all ports:: 1414 1415 testpmd> port config all crc-strip (on|off) 1416 1417CRC stripping is on by default. 1418 1419The ``off`` option is equivalent to the ``--disable-crc-strip`` command-line option. 1420 1421port config - scatter 1422~~~~~~~~~~~~~~~~~~~~~~~ 1423 1424Set RX scatter mode on or off for all ports:: 1425 1426 testpmd> port config all scatter (on|off) 1427 1428RX scatter mode is off by default. 1429 1430The ``on`` option is equivalent to the ``--enable-scatter`` command-line option. 1431 1432port config - TX queue flags 1433~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1434 1435Set a hexadecimal bitmap of TX queue flags for all ports:: 1436 1437 testpmd> port config all txqflags value 1438 1439This command is equivalent to the ``--txqflags`` command-line option. 1440 1441port config - RX Checksum 1442~~~~~~~~~~~~~~~~~~~~~~~~~ 1443 1444Set hardware RX checksum offload to on or off for all ports:: 1445 1446 testpmd> port config all rx-cksum (on|off) 1447 1448Checksum offload is off by default. 1449 1450The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option. 1451 1452port config - VLAN 1453~~~~~~~~~~~~~~~~~~ 1454 1455Set hardware VLAN on or off for all ports:: 1456 1457 testpmd> port config all hw-vlan (on|off) 1458 1459Hardware VLAN is on by default. 1460 1461The ``off`` option is equivalent to the ``--disable-hw-vlan`` command-line option. 1462 1463port config - VLAN filter 1464~~~~~~~~~~~~~~~~~~~~~~~~~ 1465 1466Set hardware VLAN filter on or off for all ports:: 1467 1468 testpmd> port config all hw-vlan-filter (on|off) 1469 1470Hardware VLAN filter is on by default. 1471 1472The ``off`` option is equivalent to the ``--disable-hw-vlan-filter`` command-line option. 1473 1474port config - VLAN strip 1475~~~~~~~~~~~~~~~~~~~~~~~~ 1476 1477Set hardware VLAN strip on or off for all ports:: 1478 1479 testpmd> port config all hw-vlan-strip (on|off) 1480 1481Hardware VLAN strip is on by default. 1482 1483The ``off`` option is equivalent to the ``--disable-hw-vlan-strip`` command-line option. 1484 1485port config - VLAN extend 1486~~~~~~~~~~~~~~~~~~~~~~~~~ 1487 1488Set hardware VLAN extend on or off for all ports:: 1489 1490 testpmd> port config all hw-vlan-extend (on|off) 1491 1492Hardware VLAN extend is off by default. 1493 1494The ``off`` option is equivalent to the ``--disable-hw-vlan-extend`` command-line option. 1495 1496port config - Drop Packets 1497~~~~~~~~~~~~~~~~~~~~~~~~~~ 1498 1499Set packet drop for packets with no descriptors on or off for all ports:: 1500 1501 testpmd> port config all drop-en (on|off) 1502 1503Packet dropping for packets with no descriptors is off by default. 1504 1505The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option. 1506 1507port config - RSS 1508~~~~~~~~~~~~~~~~~ 1509 1510Set the RSS (Receive Side Scaling) mode on or off:: 1511 1512 testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|none) 1513 1514RSS is on by default. 1515 1516The ``none`` option is equivalent to the ``--disable-rss`` command-line option. 1517 1518port config - RSS Reta 1519~~~~~~~~~~~~~~~~~~~~~~ 1520 1521Set the RSS (Receive Side Scaling) redirection table:: 1522 1523 testpmd> port config all rss reta (hash,queue)[,(hash,queue)] 1524 1525port config - DCB 1526~~~~~~~~~~~~~~~~~ 1527 1528Set the DCB mode for an individual port:: 1529 1530 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off) 1531 1532The traffic class should be 4 or 8. 1533 1534port config - Burst 1535~~~~~~~~~~~~~~~~~~~ 1536 1537Set the number of packets per burst:: 1538 1539 testpmd> port config all burst (value) 1540 1541This is equivalent to the ``--burst`` command-line option. 1542 1543port config - Threshold 1544~~~~~~~~~~~~~~~~~~~~~~~ 1545 1546Set thresholds for TX/RX queues:: 1547 1548 testpmd> port config all (threshold) (value) 1549 1550Where the threshold type can be: 1551 1552* ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255. 1553 1554* ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255. 1555 1556* ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255. 1557 1558* ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255. 1559 1560* ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255. 1561 1562* ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255. 1563 1564* ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd. 1565 1566* ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd. 1567 1568* ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd. 1569 1570These threshold options are also available from the command-line. 1571 1572port config - E-tag 1573~~~~~~~~~~~~~~~~~~~ 1574 1575Set the value of ether-type for E-tag:: 1576 1577 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value) 1578 1579Enable/disable the E-tag support:: 1580 1581 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable) 1582 1583 1584Link Bonding Functions 1585---------------------- 1586 1587The Link Bonding functions make it possible to dynamically create and 1588manage link bonding devices from within testpmd interactive prompt. 1589 1590create bonded device 1591~~~~~~~~~~~~~~~~~~~~ 1592 1593Create a new bonding device:: 1594 1595 testpmd> create bonded device (mode) (socket) 1596 1597For example, to create a bonded device in mode 1 on socket 0:: 1598 1599 testpmd> create bonded 1 0 1600 created new bonded device (port X) 1601 1602add bonding slave 1603~~~~~~~~~~~~~~~~~ 1604 1605Adds Ethernet device to a Link Bonding device:: 1606 1607 testpmd> add bonding slave (slave id) (port id) 1608 1609For example, to add Ethernet device (port 6) to a Link Bonding device (port 10):: 1610 1611 testpmd> add bonding slave 6 10 1612 1613 1614remove bonding slave 1615~~~~~~~~~~~~~~~~~~~~ 1616 1617Removes an Ethernet slave device from a Link Bonding device:: 1618 1619 testpmd> remove bonding slave (slave id) (port id) 1620 1621For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10):: 1622 1623 testpmd> remove bonding slave 6 10 1624 1625set bonding mode 1626~~~~~~~~~~~~~~~~ 1627 1628Set the Link Bonding mode of a Link Bonding device:: 1629 1630 testpmd> set bonding mode (value) (port id) 1631 1632For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3):: 1633 1634 testpmd> set bonding mode 3 10 1635 1636set bonding primary 1637~~~~~~~~~~~~~~~~~~~ 1638 1639Set an Ethernet slave device as the primary device on a Link Bonding device:: 1640 1641 testpmd> set bonding primary (slave id) (port id) 1642 1643For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10):: 1644 1645 testpmd> set bonding primary 6 10 1646 1647set bonding mac 1648~~~~~~~~~~~~~~~ 1649 1650Set the MAC address of a Link Bonding device:: 1651 1652 testpmd> set bonding mac (port id) (mac) 1653 1654For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01:: 1655 1656 testpmd> set bonding mac 10 00:00:00:00:00:01 1657 1658set bonding xmit_balance_policy 1659~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1660 1661Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:: 1662 1663 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34) 1664 1665For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports):: 1666 1667 testpmd> set bonding xmit_balance_policy 10 l34 1668 1669 1670set bonding mon_period 1671~~~~~~~~~~~~~~~~~~~~~~ 1672 1673Set the link status monitoring polling period in milliseconds for a bonding device. 1674 1675This adds support for PMD slave devices which do not support link status interrupts. 1676When the mon_period is set to a value greater than 0 then all PMD's which do not support 1677link status ISR will be queried every polling interval to check if their link status has changed:: 1678 1679 testpmd> set bonding mon_period (port_id) (value) 1680 1681For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms:: 1682 1683 testpmd> set bonding mon_period 5 150 1684 1685 1686show bonding config 1687~~~~~~~~~~~~~~~~~~~ 1688 1689Show the current configuration of a Link Bonding device:: 1690 1691 testpmd> show bonding config (port id) 1692 1693For example, 1694to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4) 1695in balance mode with a transmission policy of layer 2+3:: 1696 1697 testpmd> show bonding config 9 1698 Bonding mode: 2 1699 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23 1700 Slaves (3): [1 3 4] 1701 Active Slaves (3): [1 3 4] 1702 Primary: [3] 1703 1704 1705Register Functions 1706------------------ 1707 1708The Register Functions can be used to read from and write to registers on the network card referenced by a port number. 1709This is mainly useful for debugging purposes. 1710Reference should be made to the appropriate datasheet for the network card for details on the register addresses 1711and fields that can be accessed. 1712 1713read reg 1714~~~~~~~~ 1715 1716Display the value of a port register:: 1717 1718 testpmd> read reg (port_id) (address) 1719 1720For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller:: 1721 1722 testpmd> read reg 0 0xEE00 1723 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241) 1724 1725read regfield 1726~~~~~~~~~~~~~ 1727 1728Display a port register bit field:: 1729 1730 testpmd> read regfield (port_id) (address) (bit_x) (bit_y) 1731 1732For example, reading the lowest two bits from the register in the example above:: 1733 1734 testpmd> read regfield 0 0xEE00 0 1 1735 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1) 1736 1737read regbit 1738~~~~~~~~~~~ 1739 1740Display a single port register bit:: 1741 1742 testpmd> read regbit (port_id) (address) (bit_x) 1743 1744For example, reading the lowest bit from the register in the example above:: 1745 1746 testpmd> read regbit 0 0xEE00 0 1747 port 0 PCI register at offset 0xEE00: bit 0=1 1748 1749write reg 1750~~~~~~~~~ 1751 1752Set the value of a port register:: 1753 1754 testpmd> write reg (port_id) (address) (value) 1755 1756For example, to clear a register:: 1757 1758 testpmd> write reg 0 0xEE00 0x0 1759 port 0 PCI register at offset 0xEE00: 0x00000000 (0) 1760 1761write regfield 1762~~~~~~~~~~~~~~ 1763 1764Set bit field of a port register:: 1765 1766 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value) 1767 1768For example, writing to the register cleared in the example above:: 1769 1770 testpmd> write regfield 0 0xEE00 0 1 2 1771 port 0 PCI register at offset 0xEE00: 0x00000002 (2) 1772 1773write regbit 1774~~~~~~~~~~~~ 1775 1776Set single bit value of a port register:: 1777 1778 testpmd> write regbit (port_id) (address) (bit_x) (value) 1779 1780For example, to set the high bit in the register from the example above:: 1781 1782 testpmd> write regbit 0 0xEE00 31 1 1783 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658) 1784 1785 1786Filter Functions 1787---------------- 1788 1789This section details the available filter functions that are available. 1790 1791Note these functions interface the deprecated legacy filtering framework, 1792superseded by *rte_flow*. See `Flow rules management`_. 1793 1794ethertype_filter 1795~~~~~~~~~~~~~~~~~~~~ 1796 1797Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue:: 1798 1799 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \ 1800 ethertype (ether_type) (drop|fwd) queue (queue_id) 1801 1802The available information parameters are: 1803 1804* ``port_id``: The port which the Ethertype filter assigned on. 1805 1806* ``mac_addr``: Compare destination mac address. 1807 1808* ``mac_ignr``: Ignore destination mac address match. 1809 1810* ``mac_address``: Destination mac address to match. 1811 1812* ``ether_type``: The EtherType value want to match, 1813 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid. 1814 1815* ``queue_id``: The receive queue associated with this EtherType filter. 1816 It is meaningless when deleting or dropping. 1817 1818Example, to add/remove an ethertype filter rule:: 1819 1820 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \ 1821 ethertype 0x0806 fwd queue 3 1822 1823 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \ 1824 ethertype 0x0806 fwd queue 3 1825 18262tuple_filter 1827~~~~~~~~~~~~~~~~~ 1828 1829Add or delete a 2-tuple filter, 1830which identifies packets by specific protocol and destination TCP/UDP port 1831and forwards packets into one of the receive queues:: 1832 1833 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \ 1834 protocol (protocol_value) mask (mask_value) \ 1835 tcp_flags (tcp_flags_value) priority (prio_value) \ 1836 queue (queue_id) 1837 1838The available information parameters are: 1839 1840* ``port_id``: The port which the 2-tuple filter assigned on. 1841 1842* ``dst_port_value``: Destination port in L4. 1843 1844* ``protocol_value``: IP L4 protocol. 1845 1846* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate. 1847 1848* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP). 1849 1850* ``prio_value``: Priority of this filter. 1851 1852* ``queue_id``: The receive queue associated with this 2-tuple filter. 1853 1854Example, to add/remove an 2tuple filter rule:: 1855 1856 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \ 1857 tcp_flags 0x02 priority 3 queue 3 1858 1859 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \ 1860 tcp_flags 0x02 priority 3 queue 3 1861 18625tuple_filter 1863~~~~~~~~~~~~~~~~~ 1864 1865Add or delete a 5-tuple filter, 1866which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port) 1867and routes packets into one of the receive queues:: 1868 1869 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \ 1870 (src_address) dst_port (dst_port_value) \ 1871 src_port (src_port_value) protocol (protocol_value) \ 1872 mask (mask_value) tcp_flags (tcp_flags_value) \ 1873 priority (prio_value) queue (queue_id) 1874 1875The available information parameters are: 1876 1877* ``port_id``: The port which the 5-tuple filter assigned on. 1878 1879* ``dst_address``: Destination IP address. 1880 1881* ``src_address``: Source IP address. 1882 1883* ``dst_port_value``: TCP/UDP destination port. 1884 1885* ``src_port_value``: TCP/UDP source port. 1886 1887* ``protocol_value``: L4 protocol. 1888 1889* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate 1890 1891* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP). 1892 1893* ``prio_value``: The priority of this filter. 1894 1895* ``queue_id``: The receive queue associated with this 5-tuple filter. 1896 1897Example, to add/remove an 5tuple filter rule:: 1898 1899 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \ 1900 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \ 1901 flags 0x0 priority 3 queue 3 1902 1903 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \ 1904 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \ 1905 flags 0x0 priority 3 queue 3 1906 1907syn_filter 1908~~~~~~~~~~ 1909 1910Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue:: 1911 1912 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id) 1913 1914The available information parameters are: 1915 1916* ``port_id``: The port which the SYN filter assigned on. 1917 1918* ``high``: This SYN filter has higher priority than other filters. 1919 1920* ``low``: This SYN filter has lower priority than other filters. 1921 1922* ``queue_id``: The receive queue associated with this SYN filter 1923 1924Example:: 1925 1926 testpmd> syn_filter 0 add priority high queue 3 1927 1928flex_filter 1929~~~~~~~~~~~ 1930 1931With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet 1932and routed into one of the receive queues:: 1933 1934 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \ 1935 mask (mask_value) priority (prio_value) queue (queue_id) 1936 1937The available information parameters are: 1938 1939* ``port_id``: The port which the Flex filter is assigned on. 1940 1941* ``len_value``: Filter length in bytes, no greater than 128. 1942 1943* ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match. 1944 1945* ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match. 1946 1947* ``prio_value``: The priority of this filter. 1948 1949* ``queue_id``: The receive queue associated with this Flex filter. 1950 1951Example:: 1952 1953 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \ 1954 mask 000C priority 3 queue 3 1955 1956 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \ 1957 mask 000C priority 3 queue 3 1958 1959 1960.. _testpmd_flow_director: 1961 1962flow_director_filter 1963~~~~~~~~~~~~~~~~~~~~ 1964 1965The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues. 1966 1967Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and 1968Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter: 1969 1970* Perfect match filters. 1971 The hardware checks a match between the masked fields of the received packets and the programmed filters. 1972 The masked fields are for IP flow. 1973 1974* Signature filters. 1975 The hardware checks a match between a hash-based signature of the masked fields of the received packet. 1976 1977* Perfect-mac-vlan match filters. 1978 The hardware checks a match between the masked fields of the received packets and the programmed filters. 1979 The masked fields are for MAC VLAN flow. 1980 1981* Perfect-tunnel match filters. 1982 The hardware checks a match between the masked fields of the received packets and the programmed filters. 1983 The masked fields are for tunnel flow. 1984 1985The Flow Director filters can match the different fields for different type of packet: flow type, specific input set 1986per flow type and the flexible payload. 1987 1988The Flow Director can also mask out parts of all of these fields so that filters 1989are only applied to certain fields or parts of the fields. 1990 1991Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information. 1992 1993# Commands to add flow director filters of different flow types:: 1994 1995 flow_director_filter (port_id) mode IP (add|del|update) \ 1996 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \ 1997 src (src_ip_address) dst (dst_ip_address) \ 1998 tos (tos_value) proto (proto_value) ttl (ttl_value) \ 1999 vlan (vlan_value) flexbytes (flexbytes_value) \ 2000 (drop|fwd) pf|vf(vf_id) queue (queue_id) \ 2001 fd_id (fd_id_value) 2002 2003 flow_director_filter (port_id) mode IP (add|del|update) \ 2004 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \ 2005 src (src_ip_address) (src_port) \ 2006 dst (dst_ip_address) (dst_port) \ 2007 tos (tos_value) ttl (ttl_value) \ 2008 vlan (vlan_value) flexbytes (flexbytes_value) \ 2009 (drop|fwd) queue pf|vf(vf_id) (queue_id) \ 2010 fd_id (fd_id_value) 2011 2012 flow_director_filter (port_id) mode IP (add|del|update) \ 2013 flow (ipv4-sctp|ipv6-sctp) \ 2014 src (src_ip_address) (src_port) \ 2015 dst (dst_ip_address) (dst_port) \ 2016 tos (tos_value) ttl (ttl_value) \ 2017 tag (verification_tag) vlan (vlan_value) \ 2018 flexbytes (flexbytes_value) (drop|fwd) \ 2019 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value) 2020 2021 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \ 2022 ether (ethertype) flexbytes (flexbytes_value) \ 2023 (drop|fwd) pf|vf(vf_id) queue (queue_id) 2024 fd_id (fd_id_value) 2025 2026 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \ 2027 mac (mac_address) vlan (vlan_value) \ 2028 flexbytes (flexbytes_value) (drop|fwd) \ 2029 queue (queue_id) fd_id (fd_id_value) 2030 2031 flow_director_filter (port_id) mode Tunnel (add|del|update) \ 2032 mac (mac_address) vlan (vlan_value) \ 2033 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \ 2034 flexbytes (flexbytes_value) (drop|fwd) \ 2035 queue (queue_id) fd_id (fd_id_value) 2036 2037For example, to add an ipv4-udp flow type filter:: 2038 2039 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \ 2040 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \ 2041 fwd pf queue 1 fd_id 1 2042 2043For example, add an ipv4-other flow type filter:: 2044 2045 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \ 2046 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \ 2047 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1 2048 2049flush_flow_director 2050~~~~~~~~~~~~~~~~~~~ 2051 2052Flush all flow director filters on a device:: 2053 2054 testpmd> flush_flow_director (port_id) 2055 2056Example, to flush all flow director filter on port 0:: 2057 2058 testpmd> flush_flow_director 0 2059 2060flow_director_mask 2061~~~~~~~~~~~~~~~~~~ 2062 2063Set flow director's input masks:: 2064 2065 flow_director_mask (port_id) mode IP vlan (vlan_value) \ 2066 src_mask (ipv4_src) (ipv6_src) (src_port) \ 2067 dst_mask (ipv4_dst) (ipv6_dst) (dst_port) 2068 2069 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) 2070 2071 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \ 2072 mac (mac_value) tunnel-type (tunnel_type_value) \ 2073 tunnel-id (tunnel_id_value) 2074 2075Example, to set flow director mask on port 0:: 2076 2077 testpmd> flow_director_mask 0 mode IP vlan 0xefff \ 2078 src_mask 255.255.255.255 \ 2079 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \ 2080 dst_mask 255.255.255.255 \ 2081 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF 2082 2083flow_director_flex_mask 2084~~~~~~~~~~~~~~~~~~~~~~~ 2085 2086set masks of flow director's flexible payload based on certain flow type:: 2087 2088 testpmd> flow_director_flex_mask (port_id) \ 2089 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 2090 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \ 2091 l2_payload|all) (mask) 2092 2093Example, to set flow director's flex mask for all flow type on port 0:: 2094 2095 testpmd> flow_director_flex_mask 0 flow all \ 2096 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0) 2097 2098 2099flow_director_flex_payload 2100~~~~~~~~~~~~~~~~~~~~~~~~~~ 2101 2102Configure flexible payload selection:: 2103 2104 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config) 2105 2106For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload:: 2107 2108 testpmd> flow_director_flex_payload 0 l4 \ 2109 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19) 2110 2111get_sym_hash_ena_per_port 2112~~~~~~~~~~~~~~~~~~~~~~~~~ 2113 2114Get symmetric hash enable configuration per port:: 2115 2116 get_sym_hash_ena_per_port (port_id) 2117 2118For example, to get symmetric hash enable configuration of port 1:: 2119 2120 testpmd> get_sym_hash_ena_per_port 1 2121 2122set_sym_hash_ena_per_port 2123~~~~~~~~~~~~~~~~~~~~~~~~~ 2124 2125Set symmetric hash enable configuration per port to enable or disable:: 2126 2127 set_sym_hash_ena_per_port (port_id) (enable|disable) 2128 2129For example, to set symmetric hash enable configuration of port 1 to enable:: 2130 2131 testpmd> set_sym_hash_ena_per_port 1 enable 2132 2133get_hash_global_config 2134~~~~~~~~~~~~~~~~~~~~~~ 2135 2136Get the global configurations of hash filters:: 2137 2138 get_hash_global_config (port_id) 2139 2140For example, to get the global configurations of hash filters of port 1:: 2141 2142 testpmd> get_hash_global_config 1 2143 2144set_hash_global_config 2145~~~~~~~~~~~~~~~~~~~~~~ 2146 2147Set the global configurations of hash filters:: 2148 2149 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \ 2150 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \ 2151 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) \ 2152 (enable|disable) 2153 2154For example, to enable simple_xor for flow type of ipv6 on port 2:: 2155 2156 testpmd> set_hash_global_config 2 simple_xor ipv6 enable 2157 2158set_hash_input_set 2159~~~~~~~~~~~~~~~~~~ 2160 2161Set the input set for hash:: 2162 2163 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 2164 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \ 2165 l2_payload) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \ 2166 ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \ 2167 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \ 2168 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \ 2169 fld-8th|none) (select|add) 2170 2171For example, to add source IP to hash input set for flow type of ipv4-udp on port 0:: 2172 2173 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add 2174 2175set_fdir_input_set 2176~~~~~~~~~~~~~~~~~~ 2177 2178The Flow Director filters can match the different fields for different type of packet, i.e. specific input set 2179on per flow type and the flexible payload. This command can be used to change input set for each flow type. 2180 2181Set the input set for flow director:: 2182 2183 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 2184 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \ 2185 l2_payload) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \ 2186 ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \ 2187 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \ 2188 sctp-dst-port|sctp-veri-tag|none) (select|add) 2189 2190For example to add source IP to FD input set for flow type of ipv4-udp on port 0:: 2191 2192 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add 2193 2194global_config 2195~~~~~~~~~~~~~ 2196 2197Set different GRE key length for input set:: 2198 2199 global_config (port_id) gre-key-len (number in bytes) 2200 2201For example to set GRE key length for input set to 4 bytes on port 0:: 2202 2203 testpmd> global_config 0 gre-key-len 4 2204 2205 2206.. _testpmd_rte_flow: 2207 2208Flow rules management 2209--------------------- 2210 2211Control of the generic flow API (*rte_flow*) is fully exposed through the 2212``flow`` command (validation, creation, destruction and queries). 2213 2214Considering *rte_flow* overlaps with all `Filter Functions`_, using both 2215features simultaneously may cause undefined side-effects and is therefore 2216not recommended. 2217 2218``flow`` syntax 2219~~~~~~~~~~~~~~~ 2220 2221Because the ``flow`` command uses dynamic tokens to handle the large number 2222of possible flow rules combinations, its behavior differs slightly from 2223other commands, in particular: 2224 2225- Pressing *?* or the *<tab>* key displays contextual help for the current 2226 token, not that of the entire command. 2227 2228- Optional and repeated parameters are supported (provided they are listed 2229 in the contextual help). 2230 2231The first parameter stands for the operation mode. Possible operations and 2232their general syntax are described below. They are covered in detail in the 2233following sections. 2234 2235- Check whether a flow rule can be created:: 2236 2237 flow validate {port_id} 2238 [group {group_id}] [priority {level}] [ingress] [egress] 2239 pattern {item} [/ {item} [...]] / end 2240 actions {action} [/ {action} [...]] / end 2241 2242- Create a flow rule:: 2243 2244 flow create {port_id} 2245 [group {group_id}] [priority {level}] [ingress] [egress] 2246 pattern {item} [/ {item} [...]] / end 2247 actions {action} [/ {action} [...]] / end 2248 2249- Destroy specific flow rules:: 2250 2251 flow destroy {port_id} rule {rule_id} [...] 2252 2253- Destroy all flow rules:: 2254 2255 flow flush {port_id} 2256 2257- Query an existing flow rule:: 2258 2259 flow query {port_id} {rule_id} {action} 2260 2261- List existing flow rules sorted by priority, filtered by group 2262 identifiers:: 2263 2264 flow list {port_id} [group {group_id}] [...] 2265 2266Validating flow rules 2267~~~~~~~~~~~~~~~~~~~~~ 2268 2269``flow validate`` reports whether a flow rule would be accepted by the 2270underlying device in its current state but stops short of creating it. It is 2271bound to ``rte_flow_validate()``:: 2272 2273 flow validate {port_id} 2274 [group {group_id}] [priority {level}] [ingress] [egress] 2275 pattern {item} [/ {item} [...]] / end 2276 actions {action} [/ {action} [...]] / end 2277 2278If successful, it will show:: 2279 2280 Flow rule validated 2281 2282Otherwise it will show an error message of the form:: 2283 2284 Caught error type [...] ([...]): [...] 2285 2286This command uses the same parameters as ``flow create``, their format is 2287described in `Creating flow rules`_. 2288 2289Check whether redirecting any Ethernet packet received on port 0 to RX queue 2290index 6 is supported:: 2291 2292 testpmd> flow validate 0 ingress pattern eth / end 2293 actions queue index 6 / end 2294 Flow rule validated 2295 testpmd> 2296 2297Port 0 does not support TCPv6 rules:: 2298 2299 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end 2300 actions drop / end 2301 Caught error type 9 (specific pattern item): Invalid argument 2302 testpmd> 2303 2304Creating flow rules 2305~~~~~~~~~~~~~~~~~~~ 2306 2307``flow create`` validates and creates the specified flow rule. It is bound 2308to ``rte_flow_create()``:: 2309 2310 flow create {port_id} 2311 [group {group_id}] [priority {level}] [ingress] [egress] 2312 pattern {item} [/ {item} [...]] / end 2313 actions {action} [/ {action} [...]] / end 2314 2315If successful, it will return a flow rule ID usable with other commands:: 2316 2317 Flow rule #[...] created 2318 2319Otherwise it will show an error message of the form:: 2320 2321 Caught error type [...] ([...]): [...] 2322 2323Parameters describe in the following order: 2324 2325- Attributes (*group*, *priority*, *ingress*, *egress* tokens). 2326- A matching pattern, starting with the *pattern* token and terminated by an 2327 *end* pattern item. 2328- Actions, starting with the *actions* token and terminated by an *end* 2329 action. 2330 2331These translate directly to *rte_flow* objects provided as-is to the 2332underlying functions. 2333 2334The shortest valid definition only comprises mandatory tokens:: 2335 2336 testpmd> flow create 0 pattern end actions end 2337 2338Note that PMDs may refuse rules that essentially do nothing such as this 2339one. 2340 2341**All unspecified object values are automatically initialized to 0.** 2342 2343Attributes 2344^^^^^^^^^^ 2345 2346These tokens affect flow rule attributes (``struct rte_flow_attr``) and are 2347specified before the ``pattern`` token. 2348 2349- ``group {group id}``: priority group. 2350- ``priority {level}``: priority level within group. 2351- ``ingress``: rule applies to ingress traffic. 2352- ``egress``: rule applies to egress traffic. 2353 2354Each instance of an attribute specified several times overrides the previous 2355value as shown below (group 4 is used):: 2356 2357 testpmd> flow create 0 group 42 group 24 group 4 [...] 2358 2359Note that once enabled, ``ingress`` and ``egress`` cannot be disabled. 2360 2361While not specifying a direction is an error, some rules may allow both 2362simultaneously. 2363 2364Most rules affect RX therefore contain the ``ingress`` token:: 2365 2366 testpmd> flow create 0 ingress pattern [...] 2367 2368Matching pattern 2369^^^^^^^^^^^^^^^^ 2370 2371A matching pattern starts after the ``pattern`` token. It is made of pattern 2372items and is terminated by a mandatory ``end`` item. 2373 2374Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum 2375rte_flow_item_type``). 2376 2377The ``/`` token is used as a separator between pattern items as shown 2378below:: 2379 2380 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...] 2381 2382Note that protocol items like these must be stacked from lowest to highest 2383layer to make sense. For instance, the following rule is either invalid or 2384unlikely to match any packet:: 2385 2386 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...] 2387 2388More information on these restrictions can be found in the *rte_flow* 2389documentation. 2390 2391Several items support additional specification structures, for example 2392``ipv4`` allows specifying source and destination addresses as follows:: 2393 2394 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1 2395 dst is 10.2.0.0 / end [...] 2396 2397This rule matches all IPv4 traffic with the specified properties. 2398 2399In this example, ``src`` and ``dst`` are field names of the underlying 2400``struct rte_flow_item_ipv4`` object. All item properties can be specified 2401in a similar fashion. 2402 2403The ``is`` token means that the subsequent value must be matched exactly, 2404and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item`` 2405accordingly. Possible assignment tokens are: 2406 2407- ``is``: match value perfectly (with full bit-mask). 2408- ``spec``: match value according to configured bit-mask. 2409- ``last``: specify upper bound to establish a range. 2410- ``mask``: specify bit-mask with relevant bits set to one. 2411- ``prefix``: generate bit-mask from a prefix length. 2412 2413These yield identical results:: 2414 2415 ipv4 src is 10.1.1.1 2416 2417:: 2418 2419 ipv4 src spec 10.1.1.1 src mask 255.255.255.255 2420 2421:: 2422 2423 ipv4 src spec 10.1.1.1 src prefix 32 2424 2425:: 2426 2427 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value 2428 2429:: 2430 2431 ipv4 src is 10.1.1.1 src last 0 # 0 disables range 2432 2433Inclusive ranges can be defined with ``last``:: 2434 2435 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4 2436 2437Note that ``mask`` affects both ``spec`` and ``last``:: 2438 2439 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0 2440 # matches 10.1.0.0 to 10.2.255.255 2441 2442Properties can be modified multiple times:: 2443 2444 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4 2445 2446:: 2447 2448 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16 2449 2450Pattern items 2451^^^^^^^^^^^^^ 2452 2453This section lists supported pattern items and their attributes, if any. 2454 2455- ``end``: end list of pattern items. 2456 2457- ``void``: no-op pattern item. 2458 2459- ``invert``: perform actions when pattern does not match. 2460 2461- ``any``: match any protocol for the current layer. 2462 2463 - ``num {unsigned}``: number of layers covered. 2464 2465- ``pf``: match packets addressed to the physical function. 2466 2467- ``vf``: match packets addressed to a virtual function ID. 2468 2469 - ``id {unsigned}``: destination VF ID. 2470 2471- ``port``: device-specific physical port index to use. 2472 2473 - ``index {unsigned}``: physical port index. 2474 2475- ``raw``: match an arbitrary byte string. 2476 2477 - ``relative {boolean}``: look for pattern after the previous item. 2478 - ``search {boolean}``: search pattern from offset (see also limit). 2479 - ``offset {integer}``: absolute or relative offset for pattern. 2480 - ``limit {unsigned}``: search area limit for start of pattern. 2481 - ``pattern {string}``: byte string to look for. 2482 2483- ``eth``: match Ethernet header. 2484 2485 - ``dst {MAC-48}``: destination MAC. 2486 - ``src {MAC-48}``: source MAC. 2487 - ``type {unsigned}``: EtherType. 2488 2489- ``vlan``: match 802.1Q/ad VLAN tag. 2490 2491 - ``tpid {unsigned}``: tag protocol identifier. 2492 - ``tci {unsigned}``: tag control information. 2493 - ``pcp {unsigned}``: priority code point. 2494 - ``dei {unsigned}``: drop eligible indicator. 2495 - ``vid {unsigned}``: VLAN identifier. 2496 2497- ``ipv4``: match IPv4 header. 2498 2499 - ``tos {unsigned}``: type of service. 2500 - ``ttl {unsigned}``: time to live. 2501 - ``proto {unsigned}``: next protocol ID. 2502 - ``src {ipv4 address}``: source address. 2503 - ``dst {ipv4 address}``: destination address. 2504 2505- ``ipv6``: match IPv6 header. 2506 2507 - ``tc {unsigned}``: traffic class. 2508 - ``flow {unsigned}``: flow label. 2509 - ``proto {unsigned}``: protocol (next header). 2510 - ``hop {unsigned}``: hop limit. 2511 - ``src {ipv6 address}``: source address. 2512 - ``dst {ipv6 address}``: destination address. 2513 2514- ``icmp``: match ICMP header. 2515 2516 - ``type {unsigned}``: ICMP packet type. 2517 - ``code {unsigned}``: ICMP packet code. 2518 2519- ``udp``: match UDP header. 2520 2521 - ``src {unsigned}``: UDP source port. 2522 - ``dst {unsigned}``: UDP destination port. 2523 2524- ``tcp``: match TCP header. 2525 2526 - ``src {unsigned}``: TCP source port. 2527 - ``dst {unsigned}``: TCP destination port. 2528 2529- ``sctp``: match SCTP header. 2530 2531 - ``src {unsigned}``: SCTP source port. 2532 - ``dst {unsigned}``: SCTP destination port. 2533 - ``tag {unsigned}``: validation tag. 2534 - ``cksum {unsigned}``: checksum. 2535 2536- ``vxlan``: match VXLAN header. 2537 2538 - ``vni {unsigned}``: VXLAN identifier. 2539 2540- ``mpls``: match MPLS header. 2541 2542 - ``label {unsigned}``: MPLS label. 2543 2544- ``gre``: match GRE header. 2545 2546 - ``protocol {unsigned}``: protocol type. 2547 2548Actions list 2549^^^^^^^^^^^^ 2550 2551A list of actions starts after the ``actions`` token in the same fashion as 2552`Matching pattern`_; actions are separated by ``/`` tokens and the list is 2553terminated by a mandatory ``end`` action. 2554 2555Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum 2556rte_flow_action_type``). 2557 2558Dropping all incoming UDPv4 packets can be expressed as follows:: 2559 2560 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 2561 actions drop / end 2562 2563Several actions have configurable properties which must be specified when 2564there is no valid default value. For example, ``queue`` requires a target 2565queue index. 2566 2567This rule redirects incoming UDPv4 traffic to queue index 6:: 2568 2569 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 2570 actions queue index 6 / end 2571 2572While this one could be rejected by PMDs (unspecified queue index):: 2573 2574 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 2575 actions queue / end 2576 2577As defined by *rte_flow*, the list is not ordered, all actions of a given 2578rule are performed simultaneously. These are equivalent:: 2579 2580 queue index 6 / void / mark id 42 / end 2581 2582:: 2583 2584 void / mark id 42 / queue index 6 / end 2585 2586All actions in a list should have different types, otherwise only the last 2587action of a given type is taken into account:: 2588 2589 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6 2590 2591:: 2592 2593 drop / drop / drop / end # drop is performed only once 2594 2595:: 2596 2597 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24 2598 2599Considering they are performed simultaneously, opposite and overlapping 2600actions can sometimes be combined when the end result is unambiguous:: 2601 2602 drop / queue index 6 / end # drop has no effect 2603 2604:: 2605 2606 drop / dup index 6 / end # same as above 2607 2608:: 2609 2610 queue index 6 / rss queues 6 7 8 / end # queue has no effect 2611 2612:: 2613 2614 drop / passthru / end # drop has no effect 2615 2616Note that PMDs may still refuse such combinations. 2617 2618Actions 2619^^^^^^^ 2620 2621This section lists supported actions and their attributes, if any. 2622 2623- ``end``: end list of actions. 2624 2625- ``void``: no-op action. 2626 2627- ``passthru``: let subsequent rule process matched packets. 2628 2629- ``mark``: attach 32 bit value to packets. 2630 2631 - ``id {unsigned}``: 32 bit value to return with packets. 2632 2633- ``flag``: flag packets. 2634 2635- ``queue``: assign packets to a given queue index. 2636 2637 - ``index {unsigned}``: queue index to use. 2638 2639- ``drop``: drop packets (note: passthru has priority). 2640 2641- ``count``: enable counters for this rule. 2642 2643- ``dup``: duplicate packets to a given queue index. 2644 2645 - ``index {unsigned}``: queue index to duplicate packets to. 2646 2647- ``rss``: spread packets among several queues. 2648 2649 - ``queues [{unsigned} [...]] end``: queue indices to use. 2650 2651- ``pf``: redirect packets to physical device function. 2652 2653- ``vf``: redirect packets to virtual device function. 2654 2655 - ``original {boolean}``: use original VF ID if possible. 2656 - ``id {unsigned}``: VF ID to redirect packets to. 2657 2658Destroying flow rules 2659~~~~~~~~~~~~~~~~~~~~~ 2660 2661``flow destroy`` destroys one or more rules from their rule ID (as returned 2662by ``flow create``), this command calls ``rte_flow_destroy()`` as many 2663times as necessary:: 2664 2665 flow destroy {port_id} rule {rule_id} [...] 2666 2667If successful, it will show:: 2668 2669 Flow rule #[...] destroyed 2670 2671It does not report anything for rule IDs that do not exist. The usual error 2672message is shown when a rule cannot be destroyed:: 2673 2674 Caught error type [...] ([...]): [...] 2675 2676``flow flush`` destroys all rules on a device and does not take extra 2677arguments. It is bound to ``rte_flow_flush()``:: 2678 2679 flow flush {port_id} 2680 2681Any errors are reported as above. 2682 2683Creating several rules and destroying them:: 2684 2685 testpmd> flow create 0 ingress pattern eth / ipv6 / end 2686 actions queue index 2 / end 2687 Flow rule #0 created 2688 testpmd> flow create 0 ingress pattern eth / ipv4 / end 2689 actions queue index 3 / end 2690 Flow rule #1 created 2691 testpmd> flow destroy 0 rule 0 rule 1 2692 Flow rule #1 destroyed 2693 Flow rule #0 destroyed 2694 testpmd> 2695 2696The same result can be achieved using ``flow flush``:: 2697 2698 testpmd> flow create 0 ingress pattern eth / ipv6 / end 2699 actions queue index 2 / end 2700 Flow rule #0 created 2701 testpmd> flow create 0 ingress pattern eth / ipv4 / end 2702 actions queue index 3 / end 2703 Flow rule #1 created 2704 testpmd> flow flush 0 2705 testpmd> 2706 2707Non-existent rule IDs are ignored:: 2708 2709 testpmd> flow create 0 ingress pattern eth / ipv6 / end 2710 actions queue index 2 / end 2711 Flow rule #0 created 2712 testpmd> flow create 0 ingress pattern eth / ipv4 / end 2713 actions queue index 3 / end 2714 Flow rule #1 created 2715 testpmd> flow destroy 0 rule 42 rule 10 rule 2 2716 testpmd> 2717 testpmd> flow destroy 0 rule 0 2718 Flow rule #0 destroyed 2719 testpmd> 2720 2721Querying flow rules 2722~~~~~~~~~~~~~~~~~~~ 2723 2724``flow query`` queries a specific action of a flow rule having that 2725ability. Such actions collect information that can be reported using this 2726command. It is bound to ``rte_flow_query()``:: 2727 2728 flow query {port_id} {rule_id} {action} 2729 2730If successful, it will display either the retrieved data for known actions 2731or the following message:: 2732 2733 Cannot display result for action type [...] ([...]) 2734 2735Otherwise, it will complain either that the rule does not exist or that some 2736error occurred:: 2737 2738 Flow rule #[...] not found 2739 2740:: 2741 2742 Caught error type [...] ([...]): [...] 2743 2744Currently only the ``count`` action is supported. This action reports the 2745number of packets that hit the flow rule and the total number of bytes. Its 2746output has the following format:: 2747 2748 count: 2749 hits_set: [...] # whether "hits" contains a valid value 2750 bytes_set: [...] # whether "bytes" contains a valid value 2751 hits: [...] # number of packets 2752 bytes: [...] # number of bytes 2753 2754Querying counters for TCPv6 packets redirected to queue 6:: 2755 2756 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end 2757 actions queue index 6 / count / end 2758 Flow rule #4 created 2759 testpmd> flow query 0 4 count 2760 count: 2761 hits_set: 1 2762 bytes_set: 0 2763 hits: 386446 2764 bytes: 0 2765 testpmd> 2766 2767Listing flow rules 2768~~~~~~~~~~~~~~~~~~ 2769 2770``flow list`` lists existing flow rules sorted by priority and optionally 2771filtered by group identifiers:: 2772 2773 flow list {port_id} [group {group_id}] [...] 2774 2775This command only fails with the following message if the device does not 2776exist:: 2777 2778 Invalid port [...] 2779 2780Output consists of a header line followed by a short description of each 2781flow rule, one per line. There is no output at all when no flow rules are 2782configured on the device:: 2783 2784 ID Group Prio Attr Rule 2785 [...] [...] [...] [...] [...] 2786 2787``Attr`` column flags: 2788 2789- ``i`` for ``ingress``. 2790- ``e`` for ``egress``. 2791 2792Creating several flow rules and listing them:: 2793 2794 testpmd> flow create 0 ingress pattern eth / ipv4 / end 2795 actions queue index 6 / end 2796 Flow rule #0 created 2797 testpmd> flow create 0 ingress pattern eth / ipv6 / end 2798 actions queue index 2 / end 2799 Flow rule #1 created 2800 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end 2801 actions rss queues 6 7 8 end / end 2802 Flow rule #2 created 2803 testpmd> flow list 0 2804 ID Group Prio Attr Rule 2805 0 0 0 i- ETH IPV4 => QUEUE 2806 1 0 0 i- ETH IPV6 => QUEUE 2807 2 0 5 i- ETH IPV4 UDP => RSS 2808 testpmd> 2809 2810Rules are sorted by priority (i.e. group ID first, then priority level):: 2811 2812 testpmd> flow list 1 2813 ID Group Prio Attr Rule 2814 0 0 0 i- ETH => COUNT 2815 6 0 500 i- ETH IPV6 TCP => DROP COUNT 2816 5 0 1000 i- ETH IPV6 ICMP => QUEUE 2817 1 24 0 i- ETH IPV4 UDP => QUEUE 2818 4 24 10 i- ETH IPV4 TCP => DROP 2819 3 24 20 i- ETH IPV4 => DROP 2820 2 24 42 i- ETH IPV4 UDP => QUEUE 2821 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE 2822 testpmd> 2823 2824Output can be limited to specific groups:: 2825 2826 testpmd> flow list 1 group 0 group 63 2827 ID Group Prio Attr Rule 2828 0 0 0 i- ETH => COUNT 2829 6 0 500 i- ETH IPV6 TCP => DROP COUNT 2830 5 0 1000 i- ETH IPV6 ICMP => QUEUE 2831 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE 2832 testpmd> 2833 2834Sample QinQ flow rules 2835~~~~~~~~~~~~~~~~~~~~~~ 2836 2837Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM. 2838 2839:: 2840 2841 testpmd> flow validate 0 ingress pattern eth / vlan tpid is 0x8100 tci is 4 / 2842 vlan tpid is 0x8100 tci is 5 / end actions vf id 1 / queue index 0 / end 2843 Flow rule #0 validated 2844 2845 testpmd> flow create 0 ingress pattern eth / vlan tpid is 0x8100 tci is 4 / 2846 vlan tpid is 0x8100 tci is 5 / end actions vf id 1 / queue index 0 / end 2847 Flow rule #0 created 2848 2849 testpmd> flow list 0 2850 ID Group Prio Attr Rule 2851 0 0 0 i- ETH VLAN VLAN=>VF QUEUE 2852 2853Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host. 2854 2855:: 2856 2857 testpmd> flow validate 0 ingress pattern eth / vlan tpid is 0x8100 tci is 6 / 2858 vlan tpid is 0x8100 tci is 7 / end actions pf / queue index 0 / end 2859 Flow rule #1 validated 2860 2861 testpmd> flow create 0 ingress pattern eth / vlan tpid is 0x8100 tci is 6 / 2862 vlan tpid is 0x8100 tci is 7 / end actions pf / queue index 1 / end 2863 Flow rule #1 created 2864 2865 testpmd> flow list 0 2866 ID Group Prio Attr Rule 2867 0 0 0 i- ETH VLAN VLAN=>VF QUEUE 2868 1 0 0 i- ETH VLAN VLAN=>PF QUEUE 2869 2870After creating QinQ rule(s) the following command should be issued to enable QinQ:: 2871 2872 testpmd> vlan set qinq on 0 2873 2874