1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2010-2016 Intel Corporation. 3 4.. _testpmd_runtime: 5 6Testpmd Runtime Functions 7========================= 8 9Where the testpmd application is started in interactive mode, (``-i|--interactive``), 10it displays a prompt that can be used to start and stop forwarding, 11configure the application, display statistics (including the extended NIC 12statistics aka xstats) , set the Flow Director and other tasks:: 13 14 testpmd> 15 16The testpmd prompt has some, limited, readline support. 17Common bash command-line functions such as ``Ctrl+a`` and ``Ctrl+e`` to go to the start and end of the prompt line are supported 18as well as access to the command history via the up-arrow. 19 20There is also support for tab completion. 21If you type a partial command and hit ``<TAB>`` you get a list of the available completions: 22 23.. code-block:: console 24 25 testpmd> show port <TAB> 26 27 info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap X 28 info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all 29 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap X 30 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all 31 ... 32 33 34.. note:: 35 36 Some examples in this document are too long to fit on one line are are shown wrapped at `"\\"` for display purposes:: 37 38 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 39 (pause_time) (send_xon) (port_id) 40 41In the real ``testpmd>`` prompt these commands should be on a single line. 42 43Help Functions 44-------------- 45 46The testpmd has on-line help for the functions that are available at runtime. 47These are divided into sections and can be accessed using help, help section or help all: 48 49.. code-block:: console 50 51 testpmd> help 52 53 help control : Start and stop forwarding. 54 help display : Displaying port, stats and config information. 55 help config : Configuration information. 56 help ports : Configuring ports. 57 help registers : Reading and setting port registers. 58 help filters : Filters configuration help. 59 help all : All of the above sections. 60 61 62Command File Functions 63---------------------- 64 65To facilitate loading large number of commands or to avoid cutting and pasting where not 66practical or possible testpmd supports alternative methods for executing commands. 67 68* If started with the ``--cmdline-file=FILENAME`` command line argument testpmd 69 will execute all CLI commands contained within the file immediately before 70 starting packet forwarding or entering interactive mode. 71 72.. code-block:: console 73 74 ./testpmd -n4 -r2 ... -- -i --cmdline-file=/home/ubuntu/flow-create-commands.txt 75 Interactive-mode selected 76 CLI commands to be read from /home/ubuntu/flow-create-commands.txt 77 Configuring Port 0 (socket 0) 78 Port 0: 7C:FE:90:CB:74:CE 79 Configuring Port 1 (socket 0) 80 Port 1: 7C:FE:90:CB:74:CA 81 Checking link statuses... 82 Port 0 Link Up - speed 10000 Mbps - full-duplex 83 Port 1 Link Up - speed 10000 Mbps - full-duplex 84 Done 85 Flow rule #0 created 86 Flow rule #1 created 87 ... 88 ... 89 Flow rule #498 created 90 Flow rule #499 created 91 Read all CLI commands from /home/ubuntu/flow-create-commands.txt 92 testpmd> 93 94 95* At run-time additional commands can be loaded in bulk by invoking the ``load FILENAME`` 96 command. 97 98.. code-block:: console 99 100 testpmd> load /home/ubuntu/flow-create-commands.txt 101 Flow rule #0 created 102 Flow rule #1 created 103 ... 104 ... 105 Flow rule #498 created 106 Flow rule #499 created 107 Read all CLI commands from /home/ubuntu/flow-create-commands.txt 108 testpmd> 109 110 111In all cases output from any included command will be displayed as standard output. 112Execution will continue until the end of the file is reached regardless of 113whether any errors occur. The end user must examine the output to determine if 114any failures occurred. 115 116 117Control Functions 118----------------- 119 120start 121~~~~~ 122 123Start packet forwarding with current configuration:: 124 125 testpmd> start 126 127start tx_first 128~~~~~~~~~~~~~~ 129 130Start packet forwarding with current configuration after sending specified number of bursts of packets:: 131 132 testpmd> start tx_first (""|burst_num) 133 134The default burst number is 1 when ``burst_num`` not presented. 135 136stop 137~~~~ 138 139Stop packet forwarding, and display accumulated statistics:: 140 141 testpmd> stop 142 143quit 144~~~~ 145 146Quit to prompt:: 147 148 testpmd> quit 149 150 151Display Functions 152----------------- 153 154The functions in the following sections are used to display information about the 155testpmd configuration or the NIC status. 156 157show port 158~~~~~~~~~ 159 160Display information for a given port or all ports:: 161 162 testpmd> show port (info|summary|stats|xstats|fdir|stat_qmap|dcb_tc|cap) (port_id|all) 163 164The available information categories are: 165 166* ``info``: General port information such as MAC address. 167 168* ``summary``: Brief port summary such as Device Name, Driver Name etc. 169 170* ``stats``: RX/TX statistics. 171 172* ``xstats``: RX/TX extended NIC statistics. 173 174* ``fdir``: Flow Director information and statistics. 175 176* ``stat_qmap``: Queue statistics mapping. 177 178* ``dcb_tc``: DCB information such as TC mapping. 179 180* ``cap``: Supported offload capabilities. 181 182For example: 183 184.. code-block:: console 185 186 testpmd> show port info 0 187 188 ********************* Infos for port 0 ********************* 189 190 MAC address: XX:XX:XX:XX:XX:XX 191 Connect to socket: 0 192 memory allocation on the socket: 0 193 Link status: up 194 Link speed: 40000 Mbps 195 Link duplex: full-duplex 196 Promiscuous mode: enabled 197 Allmulticast mode: disabled 198 Maximum number of MAC addresses: 64 199 Maximum number of MAC addresses of hash filtering: 0 200 VLAN offload: 201 strip on 202 filter on 203 qinq(extend) off 204 Redirection table size: 512 205 Supported flow types: 206 ipv4-frag 207 ipv4-tcp 208 ipv4-udp 209 ipv4-sctp 210 ipv4-other 211 ipv6-frag 212 ipv6-tcp 213 ipv6-udp 214 ipv6-sctp 215 ipv6-other 216 l2_payload 217 port 218 vxlan 219 geneve 220 nvgre 221 222show port rss reta 223~~~~~~~~~~~~~~~~~~ 224 225Display the rss redirection table entry indicated by masks on port X:: 226 227 testpmd> show port (port_id) rss reta (size) (mask0, mask1...) 228 229size is used to indicate the hardware supported reta size 230 231show port rss-hash 232~~~~~~~~~~~~~~~~~~ 233 234Display the RSS hash functions and RSS hash key of a port:: 235 236 testpmd> show port (port_id) rss-hash [key] 237 238clear port 239~~~~~~~~~~ 240 241Clear the port statistics for a given port or for all ports:: 242 243 testpmd> clear port (info|stats|xstats|fdir|stat_qmap) (port_id|all) 244 245For example:: 246 247 testpmd> clear port stats all 248 249show (rxq|txq) 250~~~~~~~~~~~~~~ 251 252Display information for a given port's RX/TX queue:: 253 254 testpmd> show (rxq|txq) info (port_id) (queue_id) 255 256show config 257~~~~~~~~~~~ 258 259Displays the configuration of the application. 260The configuration comes from the command-line, the runtime or the application defaults:: 261 262 testpmd> show config (rxtx|cores|fwd|txpkts) 263 264The available information categories are: 265 266* ``rxtx``: RX/TX configuration items. 267 268* ``cores``: List of forwarding cores. 269 270* ``fwd``: Packet forwarding configuration. 271 272* ``txpkts``: Packets to TX configuration. 273 274For example: 275 276.. code-block:: console 277 278 testpmd> show config rxtx 279 280 io packet forwarding - CRC stripping disabled - packets/burst=16 281 nb forwarding cores=2 - nb forwarding ports=1 282 RX queues=1 - RX desc=128 - RX free threshold=0 283 RX threshold registers: pthresh=8 hthresh=8 wthresh=4 284 TX queues=1 - TX desc=512 - TX free threshold=0 285 TX threshold registers: pthresh=36 hthresh=0 wthresh=0 286 TX RS bit threshold=0 - TXQ flags=0x0 287 288set fwd 289~~~~~~~ 290 291Set the packet forwarding mode:: 292 293 testpmd> set fwd (io|mac|macswap|flowgen| \ 294 rxonly|txonly|csum|icmpecho|noisy) (""|retry) 295 296``retry`` can be specified for forwarding engines except ``rx_only``. 297 298The available information categories are: 299 300* ``io``: Forwards packets "as-is" in I/O mode. 301 This is the fastest possible forwarding operation as it does not access packets data. 302 This is the default mode. 303 304* ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them. 305 Default application behaviour is to set source Ethernet address to that of the transmitting interface, and destination 306 address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or 307 'eth-peer-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address. 308 309* ``macswap``: MAC swap forwarding mode. 310 Swaps the source and the destination Ethernet addresses of packets before forwarding them. 311 312* ``flowgen``: Multi-flow generation mode. 313 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic. 314 315* ``rxonly``: Receives packets but doesn't transmit them. 316 317* ``txonly``: Generates and transmits packets without receiving any. 318 319* ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet. 320 321* ``icmpecho``: Receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies. 322 323* ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``. 324 325* ``softnic``: Demonstrates the softnic forwarding operation. In this mode, packet forwarding is 326 similar to I/O mode except for the fact that packets are loopback to the softnic ports only. Therefore, portmask parameter should be set to softnic port only. The various software based custom NIC pipelines specified through the softnic firmware (DPDK packet framework script) can be tested in this mode. Furthermore, it allows to build 5-level hierarchical QoS scheduler as a default option that can be enabled through CLI once testpmd application is initialised. The user can modify the default scheduler hierarchy or can specify the new QoS Scheduler hierarchy through CLI. Requires ``CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y``. 327 328* ``noisy``: Noisy neighbour simulation. 329 Simulate more realistic behavior of a guest machine engaged in receiving 330 and sending packets performing Virtual Network Function (VNF). 331 332Example:: 333 334 testpmd> set fwd rxonly 335 336 Set rxonly packet forwarding mode 337 338 339read rxd 340~~~~~~~~ 341 342Display an RX descriptor for a port RX queue:: 343 344 testpmd> read rxd (port_id) (queue_id) (rxd_id) 345 346For example:: 347 348 testpmd> read rxd 0 0 4 349 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180 350 351read txd 352~~~~~~~~ 353 354Display a TX descriptor for a port TX queue:: 355 356 testpmd> read txd (port_id) (queue_id) (txd_id) 357 358For example:: 359 360 testpmd> read txd 0 0 4 361 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C 362 363ddp get list 364~~~~~~~~~~~~ 365 366Get loaded dynamic device personalization (DDP) package info list:: 367 368 testpmd> ddp get list (port_id) 369 370ddp get info 371~~~~~~~~~~~~ 372 373Display information about dynamic device personalization (DDP) profile:: 374 375 testpmd> ddp get info (profile_path) 376 377show vf stats 378~~~~~~~~~~~~~ 379 380Display VF statistics:: 381 382 testpmd> show vf stats (port_id) (vf_id) 383 384clear vf stats 385~~~~~~~~~~~~~~ 386 387Reset VF statistics:: 388 389 testpmd> clear vf stats (port_id) (vf_id) 390 391show port pctype mapping 392~~~~~~~~~~~~~~~~~~~~~~~~ 393 394List all items from the pctype mapping table:: 395 396 testpmd> show port (port_id) pctype mapping 397 398show rx offloading capabilities 399~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 400 401List all per queue and per port Rx offloading capabilities of a port:: 402 403 testpmd> show port (port_id) rx_offload capabilities 404 405show rx offloading configuration 406~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 407 408List port level and all queue level Rx offloading configuration:: 409 410 testpmd> show port (port_id) rx_offload configuration 411 412show tx offloading capabilities 413~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 414 415List all per queue and per port Tx offloading capabilities of a port:: 416 417 testpmd> show port (port_id) tx_offload capabilities 418 419show tx offloading configuration 420~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 421 422List port level and all queue level Tx offloading configuration:: 423 424 testpmd> show port (port_id) tx_offload configuration 425 426show tx metadata setting 427~~~~~~~~~~~~~~~~~~~~~~~~ 428 429Show Tx metadata value set for a specific port:: 430 431 testpmd> show port (port_id) tx_metadata 432 433Configuration Functions 434----------------------- 435 436The testpmd application can be configured from the runtime as well as from the command-line. 437 438This section details the available configuration functions that are available. 439 440.. note:: 441 442 Configuration changes only become active when forwarding is started/restarted. 443 444set default 445~~~~~~~~~~~ 446 447Reset forwarding to the default configuration:: 448 449 testpmd> set default 450 451set verbose 452~~~~~~~~~~~ 453 454Set the debug verbosity level:: 455 456 testpmd> set verbose (level) 457 458Available levels are as following: 459 460* ``0`` silent except for error. 461* ``1`` fully verbose except for Tx packets. 462* ``2`` fully verbose except for Rx packets. 463* ``> 2`` fully verbose. 464 465set log 466~~~~~~~ 467 468Set the log level for a log type:: 469 470 testpmd> set log global|(type) (level) 471 472Where: 473 474* ``type`` is the log name. 475 476* ``level`` is the log level. 477 478For example, to change the global log level:: 479 testpmd> set log global (level) 480 481Regexes can also be used for type. To change log level of user1, user2 and user3:: 482 testpmd> set log user[1-3] (level) 483 484set nbport 485~~~~~~~~~~ 486 487Set the number of ports used by the application: 488 489set nbport (num) 490 491This is equivalent to the ``--nb-ports`` command-line option. 492 493set nbcore 494~~~~~~~~~~ 495 496Set the number of cores used by the application:: 497 498 testpmd> set nbcore (num) 499 500This is equivalent to the ``--nb-cores`` command-line option. 501 502.. note:: 503 504 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port. 505 506set coremask 507~~~~~~~~~~~~ 508 509Set the forwarding cores hexadecimal mask:: 510 511 testpmd> set coremask (mask) 512 513This is equivalent to the ``--coremask`` command-line option. 514 515.. note:: 516 517 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding. 518 519set portmask 520~~~~~~~~~~~~ 521 522Set the forwarding ports hexadecimal mask:: 523 524 testpmd> set portmask (mask) 525 526This is equivalent to the ``--portmask`` command-line option. 527 528set burst 529~~~~~~~~~ 530 531Set number of packets per burst:: 532 533 testpmd> set burst (num) 534 535This is equivalent to the ``--burst command-line`` option. 536 537When retry is enabled, the transmit delay time and number of retries can also be set:: 538 539 testpmd> set burst tx delay (microseconds) retry (num) 540 541set txpkts 542~~~~~~~~~~ 543 544Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode:: 545 546 testpmd> set txpkts (x[,y]*) 547 548Where x[,y]* represents a CSV list of values, without white space. 549 550set txsplit 551~~~~~~~~~~~ 552 553Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes:: 554 555 testpmd> set txsplit (off|on|rand) 556 557Where: 558 559* ``off`` disable packet copy & split for CSUM mode. 560 561* ``on`` split outgoing packet into multiple segments. Size of each segment 562 and number of segments per packet is determined by ``set txpkts`` command 563 (see above). 564 565* ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments. 566 567set corelist 568~~~~~~~~~~~~ 569 570Set the list of forwarding cores:: 571 572 testpmd> set corelist (x[,y]*) 573 574For example, to change the forwarding cores: 575 576.. code-block:: console 577 578 testpmd> set corelist 3,1 579 testpmd> show config fwd 580 581 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled 582 Logical Core 3 (socket 0) forwards packets on 1 streams: 583 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01 584 Logical Core 1 (socket 0) forwards packets on 1 streams: 585 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00 586 587.. note:: 588 589 The cores are used in the same order as specified on the command line. 590 591set portlist 592~~~~~~~~~~~~ 593 594Set the list of forwarding ports:: 595 596 testpmd> set portlist (x[,y]*) 597 598For example, to change the port forwarding: 599 600.. code-block:: console 601 602 testpmd> set portlist 0,2,1,3 603 testpmd> show config fwd 604 605 io packet forwarding - ports=4 - cores=1 - streams=4 606 Logical Core 3 (socket 0) forwards packets on 4 streams: 607 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01 608 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00 609 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03 610 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02 611 612set port setup on 613~~~~~~~~~~~~~~~~~ 614 615Select how to retrieve new ports created after "port attach" command:: 616 617 testpmd> set port setup on (iterator|event) 618 619For each new port, a setup is done. 620It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop 621in iterator mode, or via RTE_ETH_EVENT_NEW in event mode. 622 623set tx loopback 624~~~~~~~~~~~~~~~ 625 626Enable/disable tx loopback:: 627 628 testpmd> set tx loopback (port_id) (on|off) 629 630set drop enable 631~~~~~~~~~~~~~~~ 632 633set drop enable bit for all queues:: 634 635 testpmd> set all queues drop (port_id) (on|off) 636 637set split drop enable (for VF) 638~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 639 640set split drop enable bit for VF from PF:: 641 642 testpmd> set vf split drop (port_id) (vf_id) (on|off) 643 644set mac antispoof (for VF) 645~~~~~~~~~~~~~~~~~~~~~~~~~~ 646 647Set mac antispoof for a VF from the PF:: 648 649 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off) 650 651set macsec offload 652~~~~~~~~~~~~~~~~~~ 653 654Enable/disable MACsec offload:: 655 656 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off) 657 testpmd> set macsec offload (port_id) off 658 659set macsec sc 660~~~~~~~~~~~~~ 661 662Configure MACsec secure connection (SC):: 663 664 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi) 665 666.. note:: 667 668 The pi argument is ignored for tx. 669 Check the NIC Datasheet for hardware limits. 670 671set macsec sa 672~~~~~~~~~~~~~ 673 674Configure MACsec secure association (SA):: 675 676 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key) 677 678.. note:: 679 680 The IDX value must be 0 or 1. 681 Check the NIC Datasheet for hardware limits. 682 683set broadcast mode (for VF) 684~~~~~~~~~~~~~~~~~~~~~~~~~~~ 685 686Set broadcast mode for a VF from the PF:: 687 688 testpmd> set vf broadcast (port_id) (vf_id) (on|off) 689 690vlan set strip 691~~~~~~~~~~~~~~ 692 693Set the VLAN strip on a port:: 694 695 testpmd> vlan set strip (on|off) (port_id) 696 697vlan set stripq 698~~~~~~~~~~~~~~~ 699 700Set the VLAN strip for a queue on a port:: 701 702 testpmd> vlan set stripq (on|off) (port_id,queue_id) 703 704vlan set stripq (for VF) 705~~~~~~~~~~~~~~~~~~~~~~~~ 706 707Set VLAN strip for all queues in a pool for a VF from the PF:: 708 709 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off) 710 711vlan set insert (for VF) 712~~~~~~~~~~~~~~~~~~~~~~~~ 713 714Set VLAN insert for a VF from the PF:: 715 716 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id) 717 718vlan set tag (for VF) 719~~~~~~~~~~~~~~~~~~~~~ 720 721Set VLAN tag for a VF from the PF:: 722 723 testpmd> set vf vlan tag (port_id) (vf_id) (on|off) 724 725vlan set antispoof (for VF) 726~~~~~~~~~~~~~~~~~~~~~~~~~~~ 727 728Set VLAN antispoof for a VF from the PF:: 729 730 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off) 731 732vlan set filter 733~~~~~~~~~~~~~~~ 734 735Set the VLAN filter on a port:: 736 737 testpmd> vlan set filter (on|off) (port_id) 738 739vlan set qinq 740~~~~~~~~~~~~~ 741 742Set the VLAN QinQ (extended queue in queue) on for a port:: 743 744 testpmd> vlan set qinq (on|off) (port_id) 745 746vlan set tpid 747~~~~~~~~~~~~~ 748 749Set the inner or outer VLAN TPID for packet filtering on a port:: 750 751 testpmd> vlan set (inner|outer) tpid (value) (port_id) 752 753.. note:: 754 755 TPID value must be a 16-bit number (value <= 65536). 756 757rx_vlan add 758~~~~~~~~~~~ 759 760Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID:: 761 762 testpmd> rx_vlan add (vlan_id|all) (port_id) 763 764.. note:: 765 766 VLAN filter must be set on that port. VLAN ID < 4096. 767 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries 768 in VFTA table. This is important if enabling all vlan_ids. 769 770rx_vlan rm 771~~~~~~~~~~ 772 773Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID:: 774 775 testpmd> rx_vlan rm (vlan_id|all) (port_id) 776 777rx_vlan add (for VF) 778~~~~~~~~~~~~~~~~~~~~ 779 780Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID:: 781 782 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask) 783 784rx_vlan rm (for VF) 785~~~~~~~~~~~~~~~~~~~ 786 787Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID:: 788 789 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask) 790 791tunnel_filter add 792~~~~~~~~~~~~~~~~~ 793 794Add a tunnel filter on a port:: 795 796 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \ 797 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\ 798 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id) 799 800The available information categories are: 801 802* ``vxlan``: Set tunnel type as VXLAN. 803 804* ``nvgre``: Set tunnel type as NVGRE. 805 806* ``ipingre``: Set tunnel type as IP-in-GRE. 807 808* ``imac-ivlan``: Set filter type as Inner MAC and VLAN. 809 810* ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID. 811 812* ``imac-tenid``: Set filter type as Inner MAC and tenant ID. 813 814* ``imac``: Set filter type as Inner MAC. 815 816* ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID. 817 818* ``oip``: Set filter type as Outer IP. 819 820* ``iip``: Set filter type as Inner IP. 821 822Example:: 823 824 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \ 825 192.168.2.2 0 ipingre oip 1 1 826 827 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP. 828 829tunnel_filter remove 830~~~~~~~~~~~~~~~~~~~~ 831 832Remove a tunnel filter on a port:: 833 834 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \ 835 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\ 836 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id) 837 838rx_vxlan_port add 839~~~~~~~~~~~~~~~~~ 840 841Add an UDP port for VXLAN packet filter on a port:: 842 843 testpmd> rx_vxlan_port add (udp_port) (port_id) 844 845rx_vxlan_port remove 846~~~~~~~~~~~~~~~~~~~~ 847 848Remove an UDP port for VXLAN packet filter on a port:: 849 850 testpmd> rx_vxlan_port rm (udp_port) (port_id) 851 852tx_vlan set 853~~~~~~~~~~~ 854 855Set hardware insertion of VLAN IDs in packets sent on a port:: 856 857 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer] 858 859For example, set a single VLAN ID (5) insertion on port 0:: 860 861 tx_vlan set 0 5 862 863Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1:: 864 865 tx_vlan set 1 2 3 866 867 868tx_vlan set pvid 869~~~~~~~~~~~~~~~~ 870 871Set port based hardware insertion of VLAN ID in packets sent on a port:: 872 873 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off) 874 875tx_vlan reset 876~~~~~~~~~~~~~ 877 878Disable hardware insertion of a VLAN header in packets sent on a port:: 879 880 testpmd> tx_vlan reset (port_id) 881 882csum set 883~~~~~~~~ 884 885Select hardware or software calculation of the checksum when 886transmitting a packet using the ``csum`` forwarding engine:: 887 888 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id) 889 890Where: 891 892* ``ip|udp|tcp|sctp`` always relate to the inner layer. 893 894* ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized 895 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are 896 supported). See also the ``csum parse-tunnel`` command. 897 898* ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized 899 as a tunnel packet by the forwarding engine (vxlan, vxlan-gpe are 900 supported). See also the ``csum parse-tunnel`` command. 901 902.. note:: 903 904 Check the NIC Datasheet for hardware limits. 905 906RSS queue region 907~~~~~~~~~~~~~~~~ 908 909Set RSS queue region span on a port:: 910 911 testpmd> set port (port_id) queue-region region_id (value) \ 912 queue_start_index (value) queue_num (value) 913 914Set flowtype mapping on a RSS queue region on a port:: 915 916 testpmd> set port (port_id) queue-region region_id (value) flowtype (value) 917 918where: 919 920* For the flowtype(pctype) of packet,the specific index for each type has 921 been defined in file i40e_type.h as enum i40e_filter_pctype. 922 923Set user priority mapping on a RSS queue region on a port:: 924 925 testpmd> set port (port_id) queue-region UP (value) region_id (value) 926 927Flush all queue region related configuration on a port:: 928 929 testpmd> set port (port_id) queue-region flush (on|off) 930 931where: 932 933* "on"is just an enable function which server for other configuration, 934 it is for all configuration about queue region from up layer, 935 at first will only keep in DPDK softwarestored in driver, 936 only after "flush on", it commit all configuration to HW. 937 "off" is just clean all configuration about queue region just now, 938 and restore all to DPDK i40e driver default config when start up. 939 940Show all queue region related configuration info on a port:: 941 942 testpmd> show port (port_id) queue-region 943 944.. note:: 945 946 Queue region only support on PF by now, so these command is 947 only for configuration of queue region on PF port. 948 949csum parse-tunnel 950~~~~~~~~~~~~~~~~~ 951 952Define how tunneled packets should be handled by the csum forward 953engine:: 954 955 testpmd> csum parse-tunnel (on|off) (tx_port_id) 956 957If enabled, the csum forward engine will try to recognize supported 958tunnel headers (vxlan, gre, ipip). 959 960If disabled, treat tunnel packets as non-tunneled packets (a inner 961header is handled as a packet payload). 962 963.. note:: 964 965 The port argument is the TX port like in the ``csum set`` command. 966 967Example: 968 969Consider a packet in packet like the following:: 970 971 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in 972 973* If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set`` 974 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the 975 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``). 976 977* If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set`` 978 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``. 979 980csum show 981~~~~~~~~~ 982 983Display tx checksum offload configuration:: 984 985 testpmd> csum show (port_id) 986 987tso set 988~~~~~~~ 989 990Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine:: 991 992 testpmd> tso set (segsize) (port_id) 993 994.. note:: 995 996 Check the NIC datasheet for hardware limits. 997 998tso show 999~~~~~~~~ 1000 1001Display the status of TCP Segmentation Offload:: 1002 1003 testpmd> tso show (port_id) 1004 1005set port - gro 1006~~~~~~~~~~~~~~ 1007 1008Enable or disable GRO in ``csum`` forwarding engine:: 1009 1010 testpmd> set port <port_id> gro on|off 1011 1012If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4 1013packets received from the given port. 1014 1015If disabled, packets received from the given port won't be performed 1016GRO. By default, GRO is disabled for all ports. 1017 1018.. note:: 1019 1020 When enable GRO for a port, TCP/IPv4 packets received from the port 1021 will be performed GRO. After GRO, all merged packets have bad 1022 checksums, since the GRO library doesn't re-calculate checksums for 1023 the merged packets. Therefore, if users want the merged packets to 1024 have correct checksums, please select HW IP checksum calculation and 1025 HW TCP checksum calculation for the port which the merged packets are 1026 transmitted to. 1027 1028show port - gro 1029~~~~~~~~~~~~~~~ 1030 1031Display GRO configuration for a given port:: 1032 1033 testpmd> show port <port_id> gro 1034 1035set gro flush 1036~~~~~~~~~~~~~ 1037 1038Set the cycle to flush the GROed packets from reassembly tables:: 1039 1040 testpmd> set gro flush <cycles> 1041 1042When enable GRO, the csum forwarding engine performs GRO on received 1043packets, and the GROed packets are stored in reassembly tables. Users 1044can use this command to determine when the GROed packets are flushed 1045from the reassembly tables. 1046 1047The ``cycles`` is measured in GRO operation times. The csum forwarding 1048engine flushes the GROed packets from the tables every ``cycles`` GRO 1049operations. 1050 1051By default, the value of ``cycles`` is 1, which means flush GROed packets 1052from the reassembly tables as soon as one GRO operation finishes. The value 1053of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``. 1054 1055Please note that the large value of ``cycles`` may cause the poor TCP/IP 1056stack performance. Because the GROed packets are delayed to arrive the 1057stack, thus causing more duplicated ACKs and TCP retransmissions. 1058 1059set port - gso 1060~~~~~~~~~~~~~~ 1061 1062Toggle per-port GSO support in ``csum`` forwarding engine:: 1063 1064 testpmd> set port <port_id> gso on|off 1065 1066If enabled, the csum forwarding engine will perform GSO on supported IPv4 1067packets, transmitted on the given port. 1068 1069If disabled, packets transmitted on the given port will not undergo GSO. 1070By default, GSO is disabled for all ports. 1071 1072.. note:: 1073 1074 When GSO is enabled on a port, supported IPv4 packets transmitted on that 1075 port undergo GSO. Afterwards, the segmented packets are represented by 1076 multi-segment mbufs; however, the csum forwarding engine doesn't calculation 1077 of checksums for GSO'd segments in SW. As a result, if users want correct 1078 checksums in GSO segments, they should enable HW checksum calculation for 1079 GSO-enabled ports. 1080 1081 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled 1082 by setting the following options in the csum forwarding engine: 1083 1084 testpmd> csum set outer_ip hw <port_id> 1085 1086 testpmd> csum set ip hw <port_id> 1087 1088 testpmd> csum set tcp hw <port_id> 1089 1090 UDP GSO is the same as IP fragmentation, which treats the UDP header 1091 as the payload and does not modify it during segmentation. That is, 1092 after UDP GSO, only the first output fragment has the original UDP 1093 header. Therefore, users need to enable HW IP checksum calculation 1094 and SW UDP checksum calculation for GSO-enabled ports, if they want 1095 correct checksums for UDP/IPv4 packets. 1096 1097set gso segsz 1098~~~~~~~~~~~~~ 1099 1100Set the maximum GSO segment size (measured in bytes), which includes the 1101packet header and the packet payload for GSO-enabled ports (global):: 1102 1103 testpmd> set gso segsz <length> 1104 1105show port - gso 1106~~~~~~~~~~~~~~~ 1107 1108Display the status of Generic Segmentation Offload for a given port:: 1109 1110 testpmd> show port <port_id> gso 1111 1112mac_addr add 1113~~~~~~~~~~~~ 1114 1115Add an alternative MAC address to a port:: 1116 1117 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX) 1118 1119mac_addr remove 1120~~~~~~~~~~~~~~~ 1121 1122Remove a MAC address from a port:: 1123 1124 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX) 1125 1126mac_addr add (for VF) 1127~~~~~~~~~~~~~~~~~~~~~ 1128 1129Add an alternative MAC address for a VF to a port:: 1130 1131 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX) 1132 1133mac_addr set 1134~~~~~~~~~~~~ 1135 1136Set the default MAC address for a port:: 1137 1138 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX) 1139 1140mac_addr set (for VF) 1141~~~~~~~~~~~~~~~~~~~~~ 1142 1143Set the MAC address for a VF from the PF:: 1144 1145 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX) 1146 1147set eth-peer 1148~~~~~~~~~~~~ 1149 1150Set the forwarding peer address for certain port:: 1151 1152 testpmd> set eth-peer (port_id) (perr_addr) 1153 1154This is equivalent to the ``--eth-peer`` command-line option. 1155 1156set port-uta 1157~~~~~~~~~~~~ 1158 1159Set the unicast hash filter(s) on/off for a port:: 1160 1161 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off) 1162 1163set promisc 1164~~~~~~~~~~~ 1165 1166Set the promiscuous mode on for a port or for all ports. 1167In promiscuous mode packets are not dropped if they aren't for the specified MAC address:: 1168 1169 testpmd> set promisc (port_id|all) (on|off) 1170 1171set allmulti 1172~~~~~~~~~~~~ 1173 1174Set the allmulti mode for a port or for all ports:: 1175 1176 testpmd> set allmulti (port_id|all) (on|off) 1177 1178Same as the ifconfig (8) option. Controls how multicast packets are handled. 1179 1180set promisc (for VF) 1181~~~~~~~~~~~~~~~~~~~~ 1182 1183Set the unicast promiscuous mode for a VF from PF. 1184It's supported by Intel i40e NICs now. 1185In promiscuous mode packets are not dropped if they aren't for the specified MAC address:: 1186 1187 testpmd> set vf promisc (port_id) (vf_id) (on|off) 1188 1189set allmulticast (for VF) 1190~~~~~~~~~~~~~~~~~~~~~~~~~ 1191 1192Set the multicast promiscuous mode for a VF from PF. 1193It's supported by Intel i40e NICs now. 1194In promiscuous mode packets are not dropped if they aren't for the specified MAC address:: 1195 1196 testpmd> set vf allmulti (port_id) (vf_id) (on|off) 1197 1198set tx max bandwidth (for VF) 1199~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1200 1201Set TX max absolute bandwidth (Mbps) for a VF from PF:: 1202 1203 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth) 1204 1205set tc tx min bandwidth (for VF) 1206~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1207 1208Set all TCs' TX min relative bandwidth (%) for a VF from PF:: 1209 1210 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...) 1211 1212set tc tx max bandwidth (for VF) 1213~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1214 1215Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF:: 1216 1217 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth) 1218 1219set tc strict link priority mode 1220~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1221 1222Set some TCs' strict link priority mode on a physical port:: 1223 1224 testpmd> set tx strict-link-priority (port_id) (tc_bitmap) 1225 1226set tc tx min bandwidth 1227~~~~~~~~~~~~~~~~~~~~~~~ 1228 1229Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs:: 1230 1231 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...) 1232 1233set flow_ctrl rx 1234~~~~~~~~~~~~~~~~ 1235 1236Set the link flow control parameter on a port:: 1237 1238 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 1239 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \ 1240 autoneg (on|off) (port_id) 1241 1242Where: 1243 1244* ``high_water`` (integer): High threshold value to trigger XOFF. 1245 1246* ``low_water`` (integer): Low threshold value to trigger XON. 1247 1248* ``pause_time`` (integer): Pause quota in the Pause frame. 1249 1250* ``send_xon`` (0/1): Send XON frame. 1251 1252* ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames. 1253 1254* ``autoneg``: Change the auto-negotiation parameter. 1255 1256set pfc_ctrl rx 1257~~~~~~~~~~~~~~~ 1258 1259Set the priority flow control parameter on a port:: 1260 1261 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 1262 (pause_time) (priority) (port_id) 1263 1264Where: 1265 1266* ``high_water`` (integer): High threshold value. 1267 1268* ``low_water`` (integer): Low threshold value. 1269 1270* ``pause_time`` (integer): Pause quota in the Pause frame. 1271 1272* ``priority`` (0-7): VLAN User Priority. 1273 1274set stat_qmap 1275~~~~~~~~~~~~~ 1276 1277Set statistics mapping (qmapping 0..15) for RX/TX queue on port:: 1278 1279 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping) 1280 1281For example, to set rx queue 2 on port 0 to mapping 5:: 1282 1283 testpmd>set stat_qmap rx 0 2 5 1284 1285set xstats-hide-zero 1286~~~~~~~~~~~~~~~~~~~~ 1287 1288Set the option to hide zero values for xstats display:: 1289 1290 testpmd> set xstats-hide-zero on|off 1291 1292.. note:: 1293 1294 By default, the zero values are displayed for xstats. 1295 1296set port - rx/tx (for VF) 1297~~~~~~~~~~~~~~~~~~~~~~~~~ 1298 1299Set VF receive/transmit from a port:: 1300 1301 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off) 1302 1303set port - mac address filter (for VF) 1304~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1305 1306Add/Remove unicast or multicast MAC addr filter for a VF:: 1307 1308 testpmd> set port (port_id) vf (vf_id) (mac_addr) \ 1309 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off) 1310 1311set port - rx mode(for VF) 1312~~~~~~~~~~~~~~~~~~~~~~~~~~ 1313 1314Set the VF receive mode of a port:: 1315 1316 testpmd> set port (port_id) vf (vf_id) \ 1317 rxmode (AUPE|ROPE|BAM|MPE) (on|off) 1318 1319The available receive modes are: 1320 1321* ``AUPE``: Accepts untagged VLAN. 1322 1323* ``ROPE``: Accepts unicast hash. 1324 1325* ``BAM``: Accepts broadcast packets. 1326 1327* ``MPE``: Accepts all multicast packets. 1328 1329set port - tx_rate (for Queue) 1330~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1331 1332Set TX rate limitation for a queue on a port:: 1333 1334 testpmd> set port (port_id) queue (queue_id) rate (rate_value) 1335 1336set port - tx_rate (for VF) 1337~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1338 1339Set TX rate limitation for queues in VF on a port:: 1340 1341 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask) 1342 1343set port - mirror rule 1344~~~~~~~~~~~~~~~~~~~~~~ 1345 1346Set pool or vlan type mirror rule for a port:: 1347 1348 testpmd> set port (port_id) mirror-rule (rule_id) \ 1349 (pool-mirror-up|pool-mirror-down|vlan-mirror) \ 1350 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off) 1351 1352Set link mirror rule for a port:: 1353 1354 testpmd> set port (port_id) mirror-rule (rule_id) \ 1355 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off) 1356 1357For example to enable mirror traffic with vlan 0,1 to pool 0:: 1358 1359 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on 1360 1361reset port - mirror rule 1362~~~~~~~~~~~~~~~~~~~~~~~~ 1363 1364Reset a mirror rule for a port:: 1365 1366 testpmd> reset port (port_id) mirror-rule (rule_id) 1367 1368set flush_rx 1369~~~~~~~~~~~~ 1370 1371Set the flush on RX streams before forwarding. 1372The default is flush ``on``. 1373Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams:: 1374 1375 testpmd> set flush_rx off 1376 1377set bypass mode 1378~~~~~~~~~~~~~~~ 1379 1380Set the bypass mode for the lowest port on bypass enabled NIC:: 1381 1382 testpmd> set bypass mode (normal|bypass|isolate) (port_id) 1383 1384set bypass event 1385~~~~~~~~~~~~~~~~ 1386 1387Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled:: 1388 1389 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \ 1390 mode (normal|bypass|isolate) (port_id) 1391 1392Where: 1393 1394* ``timeout``: Enable bypass after watchdog timeout. 1395 1396* ``os_on``: Enable bypass when OS/board is powered on. 1397 1398* ``os_off``: Enable bypass when OS/board is powered off. 1399 1400* ``power_on``: Enable bypass when power supply is turned on. 1401 1402* ``power_off``: Enable bypass when power supply is turned off. 1403 1404 1405set bypass timeout 1406~~~~~~~~~~~~~~~~~~ 1407 1408Set the bypass watchdog timeout to ``n`` seconds where 0 = instant:: 1409 1410 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32) 1411 1412show bypass config 1413~~~~~~~~~~~~~~~~~~ 1414 1415Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC:: 1416 1417 testpmd> show bypass config (port_id) 1418 1419set link up 1420~~~~~~~~~~~ 1421 1422Set link up for a port:: 1423 1424 testpmd> set link-up port (port id) 1425 1426set link down 1427~~~~~~~~~~~~~ 1428 1429Set link down for a port:: 1430 1431 testpmd> set link-down port (port id) 1432 1433E-tag set 1434~~~~~~~~~ 1435 1436Enable E-tag insertion for a VF on a port:: 1437 1438 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id) 1439 1440Disable E-tag insertion for a VF on a port:: 1441 1442 testpmd> E-tag set insertion off port (port_id) vf (vf_id) 1443 1444Enable/disable E-tag stripping on a port:: 1445 1446 testpmd> E-tag set stripping (on|off) port (port_id) 1447 1448Enable/disable E-tag based forwarding on a port:: 1449 1450 testpmd> E-tag set forwarding (on|off) port (port_id) 1451 1452Add an E-tag forwarding filter on a port:: 1453 1454 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id) 1455 1456Delete an E-tag forwarding filter on a port:: 1457 testpmd> E-tag set filter del e-tag-id (value) port (port_id) 1458 1459ddp add 1460~~~~~~~ 1461 1462Load a dynamic device personalization (DDP) profile and store backup profile:: 1463 1464 testpmd> ddp add (port_id) (profile_path[,backup_profile_path]) 1465 1466ddp del 1467~~~~~~~ 1468 1469Delete a dynamic device personalization profile and restore backup profile:: 1470 1471 testpmd> ddp del (port_id) (backup_profile_path) 1472 1473ptype mapping 1474~~~~~~~~~~~~~ 1475 1476List all items from the ptype mapping table:: 1477 1478 testpmd> ptype mapping get (port_id) (valid_only) 1479 1480Where: 1481 1482* ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0). 1483 1484Replace a specific or a group of software defined ptype with a new one:: 1485 1486 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type) 1487 1488where: 1489 1490* ``target``: A specific software ptype or a mask to represent a group of software ptypes. 1491 1492* ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1). 1493 1494* ``pkt_type``: The new software ptype to replace the old ones. 1495 1496Update hardware defined ptype to software defined packet type mapping table:: 1497 1498 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype) 1499 1500where: 1501 1502* ``hw_ptype``: hardware ptype as the index of the ptype mapping table. 1503 1504* ``sw_ptype``: software ptype as the value of the ptype mapping table. 1505 1506Reset ptype mapping table:: 1507 1508 testpmd> ptype mapping reset (port_id) 1509 1510config per port Rx offloading 1511~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1512 1513Enable or disable a per port Rx offloading on all Rx queues of a port:: 1514 1515 testpmd> port config (port_id) rx_offload (offloading) on|off 1516 1517* ``offloading``: can be any of these offloading capability: 1518 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro, 1519 qinq_strip, outer_ipv4_cksum, macsec_strip, 1520 header_split, vlan_filter, vlan_extend, jumbo_frame, 1521 crc_strip, scatter, timestamp, security, keep_crc 1522 1523This command should be run when the port is stopped, or else it will fail. 1524 1525config per queue Rx offloading 1526~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1527 1528Enable or disable a per queue Rx offloading only on a specific Rx queue:: 1529 1530 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off 1531 1532* ``offloading``: can be any of these offloading capability: 1533 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro, 1534 qinq_strip, outer_ipv4_cksum, macsec_strip, 1535 header_split, vlan_filter, vlan_extend, jumbo_frame, 1536 crc_strip, scatter, timestamp, security, keep_crc 1537 1538This command should be run when the port is stopped, or else it will fail. 1539 1540config per port Tx offloading 1541~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1542 1543Enable or disable a per port Tx offloading on all Tx queues of a port:: 1544 1545 testpmd> port config (port_id) tx_offload (offloading) on|off 1546 1547* ``offloading``: can be any of these offloading capability: 1548 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum, 1549 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum, 1550 qinq_insert, vxlan_tnl_tso, gre_tnl_tso, 1551 ipip_tnl_tso, geneve_tnl_tso, macsec_insert, 1552 mt_lockfree, multi_segs, mbuf_fast_free, security, 1553 match_metadata 1554 1555This command should be run when the port is stopped, or else it will fail. 1556 1557config per queue Tx offloading 1558~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1559 1560Enable or disable a per queue Tx offloading only on a specific Tx queue:: 1561 1562 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off 1563 1564* ``offloading``: can be any of these offloading capability: 1565 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum, 1566 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum, 1567 qinq_insert, vxlan_tnl_tso, gre_tnl_tso, 1568 ipip_tnl_tso, geneve_tnl_tso, macsec_insert, 1569 mt_lockfree, multi_segs, mbuf_fast_free, security 1570 1571This command should be run when the port is stopped, or else it will fail. 1572 1573Config VXLAN Encap outer layers 1574~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1575 1576Configure the outer layer to encapsulate a packet inside a VXLAN tunnel:: 1577 1578 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \ 1579 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \ 1580 eth-dst (eth-dst) 1581 1582 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \ 1583 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \ 1584 eth-src (eth-src) eth-dst (eth-dst) 1585 1586Those command will set an internal configuration inside testpmd, any following 1587flow rule using the action vxlan_encap will use the last configuration set. 1588To have a different encapsulation header, one of those commands must be called 1589before the flow rule creation. 1590 1591Config NVGRE Encap outer layers 1592~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1593 1594Configure the outer layer to encapsulate a packet inside a NVGRE tunnel:: 1595 1596 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \ 1597 eth-src (eth-src) eth-dst (eth-dst) 1598 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \ 1599 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst) 1600 1601Those command will set an internal configuration inside testpmd, any following 1602flow rule using the action nvgre_encap will use the last configuration set. 1603To have a different encapsulation header, one of those commands must be called 1604before the flow rule creation. 1605 1606Config L2 Encap 1607~~~~~~~~~~~~~~~ 1608 1609Configure the l2 to be used when encapsulating a packet with L2:: 1610 1611 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst) 1612 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \ 1613 eth-src (eth-src) eth-dst (eth-dst) 1614 1615Those commands will set an internal configuration inside testpmd, any following 1616flow rule using the action l2_encap will use the last configuration set. 1617To have a different encapsulation header, one of those commands must be called 1618before the flow rule creation. 1619 1620Config L2 Decap 1621~~~~~~~~~~~~~~~ 1622 1623Configure the l2 to be removed when decapsulating a packet with L2:: 1624 1625 set l2_decap ip-version (ipv4|ipv6) 1626 set l2_decap-with-vlan ip-version (ipv4|ipv6) 1627 1628Those commands will set an internal configuration inside testpmd, any following 1629flow rule using the action l2_decap will use the last configuration set. 1630To have a different encapsulation header, one of those commands must be called 1631before the flow rule creation. 1632 1633Config MPLSoGRE Encap outer layers 1634~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1635 1636Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel:: 1637 1638 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \ 1639 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst) 1640 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \ 1641 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \ 1642 eth-src (eth-src) eth-dst (eth-dst) 1643 1644Those command will set an internal configuration inside testpmd, any following 1645flow rule using the action mplsogre_encap will use the last configuration set. 1646To have a different encapsulation header, one of those commands must be called 1647before the flow rule creation. 1648 1649Config MPLSoGRE Decap outer layers 1650~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1651 1652Configure the outer layer to decapsulate MPLSoGRE packet:: 1653 1654 set mplsogre_decap ip-version (ipv4|ipv6) 1655 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6) 1656 1657Those command will set an internal configuration inside testpmd, any following 1658flow rule using the action mplsogre_decap will use the last configuration set. 1659To have a different decapsulation header, one of those commands must be called 1660before the flow rule creation. 1661 1662Config MPLSoUDP Encap outer layers 1663~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1664 1665Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel:: 1666 1667 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \ 1668 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \ 1669 eth-src (eth-src) eth-dst (eth-dst) 1670 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \ 1671 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \ 1672 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst) 1673 1674Those command will set an internal configuration inside testpmd, any following 1675flow rule using the action mplsoudp_encap will use the last configuration set. 1676To have a different encapsulation header, one of those commands must be called 1677before the flow rule creation. 1678 1679Config MPLSoUDP Decap outer layers 1680~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1681 1682Configure the outer layer to decapsulate MPLSoUDP packet:: 1683 1684 set mplsoudp_decap ip-version (ipv4|ipv6) 1685 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6) 1686 1687Those command will set an internal configuration inside testpmd, any following 1688flow rule using the action mplsoudp_decap will use the last configuration set. 1689To have a different decapsulation header, one of those commands must be called 1690before the flow rule creation. 1691 1692Port Functions 1693-------------- 1694 1695The following sections show functions for configuring ports. 1696 1697.. note:: 1698 1699 Port configuration changes only become active when forwarding is started/restarted. 1700 1701port attach 1702~~~~~~~~~~~ 1703 1704Attach a port specified by pci address or virtual device args:: 1705 1706 testpmd> port attach (identifier) 1707 1708To attach a new pci device, the device should be recognized by kernel first. 1709Then it should be moved under DPDK management. 1710Finally the port can be attached to testpmd. 1711 1712For example, to move a pci device using ixgbe under DPDK management: 1713 1714.. code-block:: console 1715 1716 # Check the status of the available devices. 1717 ./usertools/dpdk-devbind.py --status 1718 1719 Network devices using DPDK-compatible driver 1720 ============================================ 1721 <none> 1722 1723 Network devices using kernel driver 1724 =================================== 1725 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused= 1726 1727 1728 # Bind the device to igb_uio. 1729 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0 1730 1731 1732 # Recheck the status of the devices. 1733 ./usertools/dpdk-devbind.py --status 1734 Network devices using DPDK-compatible driver 1735 ============================================ 1736 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused= 1737 1738To attach a port created by virtual device, above steps are not needed. 1739 1740For example, to attach a port whose pci address is 0000:0a:00.0. 1741 1742.. code-block:: console 1743 1744 testpmd> port attach 0000:0a:00.0 1745 Attaching a new port... 1746 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 1747 EAL: probe driver: 8086:10fb rte_ixgbe_pmd 1748 EAL: PCI memory mapped at 0x7f83bfa00000 1749 EAL: PCI memory mapped at 0x7f83bfa80000 1750 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5 1751 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb 1752 Port 0 is attached. Now total ports is 1 1753 Done 1754 1755For example, to attach a port created by pcap PMD. 1756 1757.. code-block:: console 1758 1759 testpmd> port attach net_pcap0 1760 Attaching a new port... 1761 PMD: Initializing pmd_pcap for net_pcap0 1762 PMD: Creating pcap-backed ethdev on numa socket 0 1763 Port 0 is attached. Now total ports is 1 1764 Done 1765 1766In this case, identifier is ``net_pcap0``. 1767This identifier format is the same as ``--vdev`` format of DPDK applications. 1768 1769For example, to re-attach a bonded port which has been previously detached, 1770the mode and slave parameters must be given. 1771 1772.. code-block:: console 1773 1774 testpmd> port attach net_bond_0,mode=0,slave=1 1775 Attaching a new port... 1776 EAL: Initializing pmd_bond for net_bond_0 1777 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0. 1778 Port 0 is attached. Now total ports is 1 1779 Done 1780 1781 1782port detach 1783~~~~~~~~~~~ 1784 1785Detach a specific port:: 1786 1787 testpmd> port detach (port_id) 1788 1789Before detaching a port, the port should be stopped and closed. 1790 1791For example, to detach a pci device port 0. 1792 1793.. code-block:: console 1794 1795 testpmd> port stop 0 1796 Stopping ports... 1797 Done 1798 testpmd> port close 0 1799 Closing ports... 1800 Done 1801 1802 testpmd> port detach 0 1803 Detaching a port... 1804 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 1805 EAL: remove driver: 8086:10fb rte_ixgbe_pmd 1806 EAL: PCI memory unmapped at 0x7f83bfa00000 1807 EAL: PCI memory unmapped at 0x7f83bfa80000 1808 Done 1809 1810 1811For example, to detach a virtual device port 0. 1812 1813.. code-block:: console 1814 1815 testpmd> port stop 0 1816 Stopping ports... 1817 Done 1818 testpmd> port close 0 1819 Closing ports... 1820 Done 1821 1822 testpmd> port detach 0 1823 Detaching a port... 1824 PMD: Closing pcap ethdev on numa socket 0 1825 Port 'net_pcap0' is detached. Now total ports is 0 1826 Done 1827 1828To remove a pci device completely from the system, first detach the port from testpmd. 1829Then the device should be moved under kernel management. 1830Finally the device can be removed using kernel pci hotplug functionality. 1831 1832For example, to move a pci device under kernel management: 1833 1834.. code-block:: console 1835 1836 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0 1837 1838 ./usertools/dpdk-devbind.py --status 1839 1840 Network devices using DPDK-compatible driver 1841 ============================================ 1842 <none> 1843 1844 Network devices using kernel driver 1845 =================================== 1846 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio 1847 1848To remove a port created by a virtual device, above steps are not needed. 1849 1850port start 1851~~~~~~~~~~ 1852 1853Start all ports or a specific port:: 1854 1855 testpmd> port start (port_id|all) 1856 1857port stop 1858~~~~~~~~~ 1859 1860Stop all ports or a specific port:: 1861 1862 testpmd> port stop (port_id|all) 1863 1864port close 1865~~~~~~~~~~ 1866 1867Close all ports or a specific port:: 1868 1869 testpmd> port close (port_id|all) 1870 1871port config - queue ring size 1872~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1873 1874Configure a rx/tx queue ring size:: 1875 1876 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value) 1877 1878Only take effect after command that (re-)start the port or command that setup specific queue. 1879 1880port start/stop queue 1881~~~~~~~~~~~~~~~~~~~~~ 1882 1883Start/stop a rx/tx queue on a specific port:: 1884 1885 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop) 1886 1887port config - queue deferred start 1888~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1889 1890Switch on/off deferred start of a specific port queue:: 1891 1892 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off) 1893 1894port setup queue 1895~~~~~~~~~~~~~~~~~~~~~ 1896 1897Setup a rx/tx queue on a specific port:: 1898 1899 testpmd> port (port_id) (rxq|txq) (queue_id) setup 1900 1901Only take effect when port is started. 1902 1903port config - speed 1904~~~~~~~~~~~~~~~~~~~ 1905 1906Set the speed and duplex mode for all ports or a specific port:: 1907 1908 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \ 1909 duplex (half|full|auto) 1910 1911port config - queues/descriptors 1912~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1913 1914Set number of queues/descriptors for rxq, txq, rxd and txd:: 1915 1916 testpmd> port config all (rxq|txq|rxd|txd) (value) 1917 1918This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options. 1919 1920port config - max-pkt-len 1921~~~~~~~~~~~~~~~~~~~~~~~~~ 1922 1923Set the maximum packet length:: 1924 1925 testpmd> port config all max-pkt-len (value) 1926 1927This is equivalent to the ``--max-pkt-len`` command-line option. 1928 1929port config - CRC Strip 1930~~~~~~~~~~~~~~~~~~~~~~~ 1931 1932Set hardware CRC stripping on or off for all ports:: 1933 1934 testpmd> port config all crc-strip (on|off) 1935 1936CRC stripping is on by default. 1937 1938The ``off`` option is equivalent to the ``--disable-crc-strip`` command-line option. 1939 1940port config - scatter 1941~~~~~~~~~~~~~~~~~~~~~~~ 1942 1943Set RX scatter mode on or off for all ports:: 1944 1945 testpmd> port config all scatter (on|off) 1946 1947RX scatter mode is off by default. 1948 1949The ``on`` option is equivalent to the ``--enable-scatter`` command-line option. 1950 1951port config - RX Checksum 1952~~~~~~~~~~~~~~~~~~~~~~~~~ 1953 1954Set hardware RX checksum offload to on or off for all ports:: 1955 1956 testpmd> port config all rx-cksum (on|off) 1957 1958Checksum offload is off by default. 1959 1960The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option. 1961 1962port config - VLAN 1963~~~~~~~~~~~~~~~~~~ 1964 1965Set hardware VLAN on or off for all ports:: 1966 1967 testpmd> port config all hw-vlan (on|off) 1968 1969Hardware VLAN is off by default. 1970 1971The ``on`` option is equivalent to the ``--enable-hw-vlan`` command-line option. 1972 1973port config - VLAN filter 1974~~~~~~~~~~~~~~~~~~~~~~~~~ 1975 1976Set hardware VLAN filter on or off for all ports:: 1977 1978 testpmd> port config all hw-vlan-filter (on|off) 1979 1980Hardware VLAN filter is off by default. 1981 1982The ``on`` option is equivalent to the ``--enable-hw-vlan-filter`` command-line option. 1983 1984port config - VLAN strip 1985~~~~~~~~~~~~~~~~~~~~~~~~ 1986 1987Set hardware VLAN strip on or off for all ports:: 1988 1989 testpmd> port config all hw-vlan-strip (on|off) 1990 1991Hardware VLAN strip is off by default. 1992 1993The ``on`` option is equivalent to the ``--enable-hw-vlan-strip`` command-line option. 1994 1995port config - VLAN extend 1996~~~~~~~~~~~~~~~~~~~~~~~~~ 1997 1998Set hardware VLAN extend on or off for all ports:: 1999 2000 testpmd> port config all hw-vlan-extend (on|off) 2001 2002Hardware VLAN extend is off by default. 2003 2004The ``on`` option is equivalent to the ``--enable-hw-vlan-extend`` command-line option. 2005 2006port config - Drop Packets 2007~~~~~~~~~~~~~~~~~~~~~~~~~~ 2008 2009Set packet drop for packets with no descriptors on or off for all ports:: 2010 2011 testpmd> port config all drop-en (on|off) 2012 2013Packet dropping for packets with no descriptors is off by default. 2014 2015The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option. 2016 2017port config - RSS 2018~~~~~~~~~~~~~~~~~ 2019 2020Set the RSS (Receive Side Scaling) mode on or off:: 2021 2022 testpmd> port config all rss (all|default|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|none) 2023 2024RSS is on by default. 2025 2026The ``all`` option is equivalent to ip|tcp|udp|sctp|ether. 2027The ``default`` option enables all supported RSS types reported by device info. 2028The ``none`` option is equivalent to the ``--disable-rss`` command-line option. 2029 2030port config - RSS Reta 2031~~~~~~~~~~~~~~~~~~~~~~ 2032 2033Set the RSS (Receive Side Scaling) redirection table:: 2034 2035 testpmd> port config all rss reta (hash,queue)[,(hash,queue)] 2036 2037port config - DCB 2038~~~~~~~~~~~~~~~~~ 2039 2040Set the DCB mode for an individual port:: 2041 2042 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off) 2043 2044The traffic class should be 4 or 8. 2045 2046port config - Burst 2047~~~~~~~~~~~~~~~~~~~ 2048 2049Set the number of packets per burst:: 2050 2051 testpmd> port config all burst (value) 2052 2053This is equivalent to the ``--burst`` command-line option. 2054 2055port config - Threshold 2056~~~~~~~~~~~~~~~~~~~~~~~ 2057 2058Set thresholds for TX/RX queues:: 2059 2060 testpmd> port config all (threshold) (value) 2061 2062Where the threshold type can be: 2063 2064* ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255. 2065 2066* ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255. 2067 2068* ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255. 2069 2070* ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255. 2071 2072* ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255. 2073 2074* ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255. 2075 2076* ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd. 2077 2078* ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd. 2079 2080* ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd. 2081 2082These threshold options are also available from the command-line. 2083 2084port config - E-tag 2085~~~~~~~~~~~~~~~~~~~ 2086 2087Set the value of ether-type for E-tag:: 2088 2089 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value) 2090 2091Enable/disable the E-tag support:: 2092 2093 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable) 2094 2095port config pctype mapping 2096~~~~~~~~~~~~~~~~~~~~~~~~~~ 2097 2098Reset pctype mapping table:: 2099 2100 testpmd> port config (port_id) pctype mapping reset 2101 2102Update hardware defined pctype to software defined flow type mapping table:: 2103 2104 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id) 2105 2106where: 2107 2108* ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table. 2109 2110* ``flow_type_id``: software flow type id as the index of the pctype mapping table. 2111 2112port config input set 2113~~~~~~~~~~~~~~~~~~~~~ 2114 2115Config RSS/FDIR/FDIR flexible payload input set for some pctype:: 2116 testpmd> port config (port_id) pctype (pctype_id) \ 2117 (hash_inset|fdir_inset|fdir_flx_inset) \ 2118 (get|set|clear) field (field_idx) 2119 2120Clear RSS/FDIR/FDIR flexible payload input set for some pctype:: 2121 testpmd> port config (port_id) pctype (pctype_id) \ 2122 (hash_inset|fdir_inset|fdir_flx_inset) clear all 2123 2124where: 2125 2126* ``pctype_id``: hardware packet classification types. 2127* ``field_idx``: hardware field index. 2128 2129port config udp_tunnel_port 2130~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2131 2132Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols:: 2133 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve (udp_port) 2134 2135port config tx_metadata 2136~~~~~~~~~~~~~~~~~~~~~~~ 2137 2138Set Tx metadata value per port. 2139testpmd will add this value to any Tx packet sent from this port:: 2140 2141 testpmd> port config (port_id) tx_metadata (value) 2142 2143Link Bonding Functions 2144---------------------- 2145 2146The Link Bonding functions make it possible to dynamically create and 2147manage link bonding devices from within testpmd interactive prompt. 2148 2149create bonded device 2150~~~~~~~~~~~~~~~~~~~~ 2151 2152Create a new bonding device:: 2153 2154 testpmd> create bonded device (mode) (socket) 2155 2156For example, to create a bonded device in mode 1 on socket 0:: 2157 2158 testpmd> create bonded device 1 0 2159 created new bonded device (port X) 2160 2161add bonding slave 2162~~~~~~~~~~~~~~~~~ 2163 2164Adds Ethernet device to a Link Bonding device:: 2165 2166 testpmd> add bonding slave (slave id) (port id) 2167 2168For example, to add Ethernet device (port 6) to a Link Bonding device (port 10):: 2169 2170 testpmd> add bonding slave 6 10 2171 2172 2173remove bonding slave 2174~~~~~~~~~~~~~~~~~~~~ 2175 2176Removes an Ethernet slave device from a Link Bonding device:: 2177 2178 testpmd> remove bonding slave (slave id) (port id) 2179 2180For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10):: 2181 2182 testpmd> remove bonding slave 6 10 2183 2184set bonding mode 2185~~~~~~~~~~~~~~~~ 2186 2187Set the Link Bonding mode of a Link Bonding device:: 2188 2189 testpmd> set bonding mode (value) (port id) 2190 2191For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3):: 2192 2193 testpmd> set bonding mode 3 10 2194 2195set bonding primary 2196~~~~~~~~~~~~~~~~~~~ 2197 2198Set an Ethernet slave device as the primary device on a Link Bonding device:: 2199 2200 testpmd> set bonding primary (slave id) (port id) 2201 2202For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10):: 2203 2204 testpmd> set bonding primary 6 10 2205 2206set bonding mac 2207~~~~~~~~~~~~~~~ 2208 2209Set the MAC address of a Link Bonding device:: 2210 2211 testpmd> set bonding mac (port id) (mac) 2212 2213For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01:: 2214 2215 testpmd> set bonding mac 10 00:00:00:00:00:01 2216 2217set bonding xmit_balance_policy 2218~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2219 2220Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:: 2221 2222 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34) 2223 2224For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports):: 2225 2226 testpmd> set bonding xmit_balance_policy 10 l34 2227 2228 2229set bonding mon_period 2230~~~~~~~~~~~~~~~~~~~~~~ 2231 2232Set the link status monitoring polling period in milliseconds for a bonding device. 2233 2234This adds support for PMD slave devices which do not support link status interrupts. 2235When the mon_period is set to a value greater than 0 then all PMD's which do not support 2236link status ISR will be queried every polling interval to check if their link status has changed:: 2237 2238 testpmd> set bonding mon_period (port_id) (value) 2239 2240For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms:: 2241 2242 testpmd> set bonding mon_period 5 150 2243 2244 2245set bonding lacp dedicated_queue 2246~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2247 2248Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic 2249when in mode 4 (link-aggregration-802.3ad):: 2250 2251 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable) 2252 2253 2254set bonding agg_mode 2255~~~~~~~~~~~~~~~~~~~~ 2256 2257Enable one of the specific aggregators mode when in mode 4 (link-aggregration-802.3ad):: 2258 2259 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable) 2260 2261 2262show bonding config 2263~~~~~~~~~~~~~~~~~~~ 2264 2265Show the current configuration of a Link Bonding device:: 2266 2267 testpmd> show bonding config (port id) 2268 2269For example, 2270to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4) 2271in balance mode with a transmission policy of layer 2+3:: 2272 2273 testpmd> show bonding config 9 2274 Bonding mode: 2 2275 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23 2276 Slaves (3): [1 3 4] 2277 Active Slaves (3): [1 3 4] 2278 Primary: [3] 2279 2280 2281Register Functions 2282------------------ 2283 2284The Register Functions can be used to read from and write to registers on the network card referenced by a port number. 2285This is mainly useful for debugging purposes. 2286Reference should be made to the appropriate datasheet for the network card for details on the register addresses 2287and fields that can be accessed. 2288 2289read reg 2290~~~~~~~~ 2291 2292Display the value of a port register:: 2293 2294 testpmd> read reg (port_id) (address) 2295 2296For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller:: 2297 2298 testpmd> read reg 0 0xEE00 2299 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241) 2300 2301read regfield 2302~~~~~~~~~~~~~ 2303 2304Display a port register bit field:: 2305 2306 testpmd> read regfield (port_id) (address) (bit_x) (bit_y) 2307 2308For example, reading the lowest two bits from the register in the example above:: 2309 2310 testpmd> read regfield 0 0xEE00 0 1 2311 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1) 2312 2313read regbit 2314~~~~~~~~~~~ 2315 2316Display a single port register bit:: 2317 2318 testpmd> read regbit (port_id) (address) (bit_x) 2319 2320For example, reading the lowest bit from the register in the example above:: 2321 2322 testpmd> read regbit 0 0xEE00 0 2323 port 0 PCI register at offset 0xEE00: bit 0=1 2324 2325write reg 2326~~~~~~~~~ 2327 2328Set the value of a port register:: 2329 2330 testpmd> write reg (port_id) (address) (value) 2331 2332For example, to clear a register:: 2333 2334 testpmd> write reg 0 0xEE00 0x0 2335 port 0 PCI register at offset 0xEE00: 0x00000000 (0) 2336 2337write regfield 2338~~~~~~~~~~~~~~ 2339 2340Set bit field of a port register:: 2341 2342 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value) 2343 2344For example, writing to the register cleared in the example above:: 2345 2346 testpmd> write regfield 0 0xEE00 0 1 2 2347 port 0 PCI register at offset 0xEE00: 0x00000002 (2) 2348 2349write regbit 2350~~~~~~~~~~~~ 2351 2352Set single bit value of a port register:: 2353 2354 testpmd> write regbit (port_id) (address) (bit_x) (value) 2355 2356For example, to set the high bit in the register from the example above:: 2357 2358 testpmd> write regbit 0 0xEE00 31 1 2359 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658) 2360 2361Traffic Metering and Policing 2362----------------------------- 2363 2364The following section shows functions for configuring traffic metering and 2365policing on the ethernet device through the use of generic ethdev API. 2366 2367show port traffic management capability 2368~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2369 2370Show traffic metering and policing capability of the port:: 2371 2372 testpmd> show port meter cap (port_id) 2373 2374add port meter profile (srTCM rfc2967) 2375~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2376 2377Add meter profile (srTCM rfc2697) to the ethernet device:: 2378 2379 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \ 2380 (cir) (cbs) (ebs) 2381 2382where: 2383 2384* ``profile_id``: ID for the meter profile. 2385* ``cir``: Committed Information Rate (CIR) (bytes/second). 2386* ``cbs``: Committed Burst Size (CBS) (bytes). 2387* ``ebs``: Excess Burst Size (EBS) (bytes). 2388 2389add port meter profile (trTCM rfc2968) 2390~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2391 2392Add meter profile (srTCM rfc2698) to the ethernet device:: 2393 2394 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \ 2395 (cir) (pir) (cbs) (pbs) 2396 2397where: 2398 2399* ``profile_id``: ID for the meter profile. 2400* ``cir``: Committed information rate (bytes/second). 2401* ``pir``: Peak information rate (bytes/second). 2402* ``cbs``: Committed burst size (bytes). 2403* ``pbs``: Peak burst size (bytes). 2404 2405add port meter profile (trTCM rfc4115) 2406~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2407 2408Add meter profile (trTCM rfc4115) to the ethernet device:: 2409 2410 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \ 2411 (cir) (eir) (cbs) (ebs) 2412 2413where: 2414 2415* ``profile_id``: ID for the meter profile. 2416* ``cir``: Committed information rate (bytes/second). 2417* ``eir``: Excess information rate (bytes/second). 2418* ``cbs``: Committed burst size (bytes). 2419* ``ebs``: Excess burst size (bytes). 2420 2421delete port meter profile 2422~~~~~~~~~~~~~~~~~~~~~~~~~ 2423 2424Delete meter profile from the ethernet device:: 2425 2426 testpmd> del port meter profile (port_id) (profile_id) 2427 2428create port meter 2429~~~~~~~~~~~~~~~~~ 2430 2431Create new meter object for the ethernet device:: 2432 2433 testpmd> create port meter (port_id) (mtr_id) (profile_id) \ 2434 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \ 2435 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\ 2436 (dscp_tbl_entry63)] 2437 2438where: 2439 2440* ``mtr_id``: meter object ID. 2441* ``profile_id``: ID for the meter profile. 2442* ``meter_enable``: When this parameter has a non-zero value, the meter object 2443 gets enabled at the time of creation, otherwise remains disabled. 2444* ``g_action``: Policer action for the packet with green color. 2445* ``y_action``: Policer action for the packet with yellow color. 2446* ``r_action``: Policer action for the packet with red color. 2447* ``stats_mask``: Mask of statistics counter types to be enabled for the 2448 meter object. 2449* ``shared``: When this parameter has a non-zero value, the meter object is 2450 shared by multiple flows. Otherwise, meter object is used by single flow. 2451* ``use_pre_meter_color``: When this parameter has a non-zero value, the 2452 input color for the current meter object is determined by the latest meter 2453 object in the same flow. Otherwise, the current meter object uses the 2454 *dscp_table* to determine the input color. 2455* ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input 2456 color, 0 <= x <= 63. 2457 2458enable port meter 2459~~~~~~~~~~~~~~~~~ 2460 2461Enable meter for the ethernet device:: 2462 2463 testpmd> enable port meter (port_id) (mtr_id) 2464 2465disable port meter 2466~~~~~~~~~~~~~~~~~~ 2467 2468Disable meter for the ethernet device:: 2469 2470 testpmd> disable port meter (port_id) (mtr_id) 2471 2472delete port meter 2473~~~~~~~~~~~~~~~~~ 2474 2475Delete meter for the ethernet device:: 2476 2477 testpmd> del port meter (port_id) (mtr_id) 2478 2479Set port meter profile 2480~~~~~~~~~~~~~~~~~~~~~~ 2481 2482Set meter profile for the ethernet device:: 2483 2484 testpmd> set port meter profile (port_id) (mtr_id) (profile_id) 2485 2486set port meter dscp table 2487~~~~~~~~~~~~~~~~~~~~~~~~~ 2488 2489Set meter dscp table for the ethernet device:: 2490 2491 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \ 2492 (dscp_tbl_entry1)...(dscp_tbl_entry63)] 2493 2494set port meter policer action 2495~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2496 2497Set meter policer action for the ethernet device:: 2498 2499 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \ 2500 (action0) [(action1) (action1)] 2501 2502where: 2503 2504* ``action_mask``: Bit mask indicating which policer actions need to be 2505 updated. One or more policer actions can be updated in a single function 2506 invocation. To update the policer action associated with color C, bit 2507 (1 << C) needs to be set in *action_mask* and element at position C 2508 in the *actions* array needs to be valid. 2509* ``actionx``: Policer action for the color x, 2510 RTE_MTR_GREEN <= x < RTE_MTR_COLORS 2511 2512set port meter stats mask 2513~~~~~~~~~~~~~~~~~~~~~~~~~ 2514 2515Set meter stats mask for the ethernet device:: 2516 2517 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask) 2518 2519where: 2520 2521* ``stats_mask``: Bit mask indicating statistics counter types to be enabled. 2522 2523show port meter stats 2524~~~~~~~~~~~~~~~~~~~~~ 2525 2526Show meter stats of the ethernet device:: 2527 2528 testpmd> show port meter stats (port_id) (mtr_id) (clear) 2529 2530where: 2531 2532* ``clear``: Flag that indicates whether the statistics counters should 2533 be cleared (i.e. set to zero) immediately after they have been read or not. 2534 2535Traffic Management 2536------------------ 2537 2538The following section shows functions for configuring traffic management on 2539on the ethernet device through the use of generic TM API. 2540 2541show port traffic management capability 2542~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2543 2544Show traffic management capability of the port:: 2545 2546 testpmd> show port tm cap (port_id) 2547 2548show port traffic management capability (hierarchy level) 2549~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2550 2551Show traffic management hierarchy level capability of the port:: 2552 2553 testpmd> show port tm level cap (port_id) (level_id) 2554 2555show port traffic management capability (hierarchy node level) 2556~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2557 2558Show the traffic management hierarchy node capability of the port:: 2559 2560 testpmd> show port tm node cap (port_id) (node_id) 2561 2562show port traffic management hierarchy node type 2563~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2564 2565Show the port traffic management hierarchy node type:: 2566 2567 testpmd> show port tm node type (port_id) (node_id) 2568 2569show port traffic management hierarchy node stats 2570~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2571 2572Show the port traffic management hierarchy node statistics:: 2573 2574 testpmd> show port tm node stats (port_id) (node_id) (clear) 2575 2576where: 2577 2578* ``clear``: When this parameter has a non-zero value, the statistics counters 2579 are cleared (i.e. set to zero) immediately after they have been read, 2580 otherwise the statistics counters are left untouched. 2581 2582Add port traffic management private shaper profile 2583~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2584 2585Add the port traffic management private shaper profile:: 2586 2587 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \ 2588 (tb_rate) (tb_size) (packet_length_adjust) 2589 2590where: 2591 2592* ``shaper_profile id``: Shaper profile ID for the new profile. 2593* ``tb_rate``: Token bucket rate (bytes per second). 2594* ``tb_size``: Token bucket size (bytes). 2595* ``packet_length_adjust``: The value (bytes) to be added to the length of 2596 each packet for the purpose of shaping. This parameter value can be used to 2597 correct the packet length with the framing overhead bytes that are consumed 2598 on the wire. 2599 2600Delete port traffic management private shaper profile 2601~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2602 2603Delete the port traffic management private shaper:: 2604 2605 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id) 2606 2607where: 2608 2609* ``shaper_profile id``: Shaper profile ID that needs to be deleted. 2610 2611Add port traffic management shared shaper 2612~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2613 2614Create the port traffic management shared shaper:: 2615 2616 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \ 2617 (shaper_profile_id) 2618 2619where: 2620 2621* ``shared_shaper_id``: Shared shaper ID to be created. 2622* ``shaper_profile id``: Shaper profile ID for shared shaper. 2623 2624Set port traffic management shared shaper 2625~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2626 2627Update the port traffic management shared shaper:: 2628 2629 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \ 2630 (shaper_profile_id) 2631 2632where: 2633 2634* ``shared_shaper_id``: Shared shaper ID to be update. 2635* ``shaper_profile id``: Shaper profile ID for shared shaper. 2636 2637Delete port traffic management shared shaper 2638~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2639 2640Delete the port traffic management shared shaper:: 2641 2642 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id) 2643 2644where: 2645 2646* ``shared_shaper_id``: Shared shaper ID to be deleted. 2647 2648Set port traffic management hiearchy node private shaper 2649~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2650 2651set the port traffic management hierarchy node private shaper:: 2652 2653 testpmd> set port tm node shaper profile (port_id) (node_id) \ 2654 (shaper_profile_id) 2655 2656where: 2657 2658* ``shaper_profile id``: Private shaper profile ID to be enabled on the 2659 hierarchy node. 2660 2661Add port traffic management WRED profile 2662~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2663 2664Create a new WRED profile:: 2665 2666 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \ 2667 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \ 2668 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \ 2669 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r) 2670 2671where: 2672 2673* ``wred_profile id``: Identifier for the newly create WRED profile 2674* ``color_g``: Packet color (green) 2675* ``min_th_g``: Minimum queue threshold for packet with green color 2676* ``max_th_g``: Minimum queue threshold for packet with green color 2677* ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp) 2678* ``wq_log2_g``: Negated log2 of queue weight (wq) 2679* ``color_y``: Packet color (yellow) 2680* ``min_th_y``: Minimum queue threshold for packet with yellow color 2681* ``max_th_y``: Minimum queue threshold for packet with yellow color 2682* ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp) 2683* ``wq_log2_y``: Negated log2 of queue weight (wq) 2684* ``color_r``: Packet color (red) 2685* ``min_th_r``: Minimum queue threshold for packet with yellow color 2686* ``max_th_r``: Minimum queue threshold for packet with yellow color 2687* ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp) 2688* ``wq_log2_r``: Negated log2 of queue weight (wq) 2689 2690Delete port traffic management WRED profile 2691~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2692 2693Delete the WRED profile:: 2694 2695 testpmd> del port tm node wred profile (port_id) (wred_profile_id) 2696 2697Add port traffic management hierarchy nonleaf node 2698~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2699 2700Add nonleaf node to port traffic management hiearchy:: 2701 2702 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \ 2703 (priority) (weight) (level_id) (shaper_profile_id) \ 2704 (n_sp_priorities) (stats_mask) (n_shared_shapers) \ 2705 [(shared_shaper_0) (shared_shaper_1) ...] \ 2706 2707where: 2708 2709* ``parent_node_id``: Node ID of the parent. 2710* ``priority``: Node priority (highest node priority is zero). This is used by 2711 the SP algorithm running on the parent node for scheduling this node. 2712* ``weight``: Node weight (lowest weight is one). The node weight is relative 2713 to the weight sum of all siblings that have the same priority. It is used by 2714 the WFQ algorithm running on the parent node for scheduling this node. 2715* ``level_id``: Hiearchy level of the node. 2716* ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by 2717 the node. 2718* ``n_sp_priorities``: Number of strict priorities. 2719* ``stats_mask``: Mask of statistics counter types to be enabled for this node. 2720* ``n_shared_shapers``: Number of shared shapers. 2721* ``shared_shaper_id``: Shared shaper id. 2722 2723Add port traffic management hierarchy leaf node 2724~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2725 2726Add leaf node to port traffic management hiearchy:: 2727 2728 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \ 2729 (priority) (weight) (level_id) (shaper_profile_id) \ 2730 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \ 2731 [(shared_shaper_id) (shared_shaper_id) ...] \ 2732 2733where: 2734 2735* ``parent_node_id``: Node ID of the parent. 2736* ``priority``: Node priority (highest node priority is zero). This is used by 2737 the SP algorithm running on the parent node for scheduling this node. 2738* ``weight``: Node weight (lowest weight is one). The node weight is relative 2739 to the weight sum of all siblings that have the same priority. It is used by 2740 the WFQ algorithm running on the parent node for scheduling this node. 2741* ``level_id``: Hiearchy level of the node. 2742* ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by 2743 the node. 2744* ``cman_mode``: Congestion management mode to be enabled for this node. 2745* ``wred_profile_id``: WRED profile id to be enabled for this node. 2746* ``stats_mask``: Mask of statistics counter types to be enabled for this node. 2747* ``n_shared_shapers``: Number of shared shapers. 2748* ``shared_shaper_id``: Shared shaper id. 2749 2750Delete port traffic management hierarchy node 2751~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2752 2753Delete node from port traffic management hiearchy:: 2754 2755 testpmd> del port tm node (port_id) (node_id) 2756 2757Update port traffic management hierarchy parent node 2758~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2759 2760Update port traffic management hierarchy parent node:: 2761 2762 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \ 2763 (priority) (weight) 2764 2765This function can only be called after the hierarchy commit invocation. Its 2766success depends on the port support for this operation, as advertised through 2767the port capability set. This function is valid for all nodes of the traffic 2768management hierarchy except root node. 2769 2770Suspend port traffic management hierarchy node 2771~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2772 2773 testpmd> suspend port tm node (port_id) (node_id) 2774 2775Resume port traffic management hierarchy node 2776~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2777 2778 testpmd> resume port tm node (port_id) (node_id) 2779 2780Commit port traffic management hierarchy 2781~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2782 2783Commit the traffic management hierarchy on the port:: 2784 2785 testpmd> port tm hierarchy commit (port_id) (clean_on_fail) 2786 2787where: 2788 2789* ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function 2790 call failure. On the other hand, hierarchy is preserved when this parameter 2791 is equal to zero. 2792 2793Set port traffic management mark VLAN dei 2794~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2795 2796Enables/Disables the traffic management marking on the port for VLAN packets:: 2797 2798 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red> 2799 2800where: 2801 2802* ``port_id``: The port which on which VLAN packets marked as ``green`` or 2803 ``yellow`` or ``red`` will have dei bit enabled 2804 2805* ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green 2806 2807* ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow 2808 2809* ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red 2810 2811Set port traffic management mark IP dscp 2812~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2813 2814Enables/Disables the traffic management marking on the port for IP dscp packets:: 2815 2816 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red> 2817 2818where: 2819 2820* ``port_id``: The port which on which IP packets marked as ``green`` or 2821 ``yellow`` or ``red`` will have IP dscp bits updated 2822 2823* ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets 2824 2825* ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets 2826 2827* ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets 2828 2829Set port traffic management mark IP ecn 2830~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2831 2832Enables/Disables the traffic management marking on the port for IP ecn packets:: 2833 2834 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red> 2835 2836where: 2837 2838* ``port_id``: The port which on which IP packets marked as ``green`` or 2839 ``yellow`` or ``red`` will have IP ecn bits updated 2840 2841* ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10 2842 to ecn of 2'b11 when IP is caring TCP or SCTP 2843 2844* ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10 2845 to ecn of 2'b11 when IP is caring TCP or SCTP 2846 2847* ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10 2848 to ecn of 2'b11 when IP is caring TCP or SCTP 2849 2850Set port traffic management default hierarchy (softnic forwarding mode) 2851~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2852 2853set the traffic management default hierarchy on the port:: 2854 2855 testpmd> set port tm hierarchy default (port_id) 2856 2857Filter Functions 2858---------------- 2859 2860This section details the available filter functions that are available. 2861 2862Note these functions interface the deprecated legacy filtering framework, 2863superseded by *rte_flow*. See `Flow rules management`_. 2864 2865ethertype_filter 2866~~~~~~~~~~~~~~~~~~~~ 2867 2868Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue:: 2869 2870 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \ 2871 ethertype (ether_type) (drop|fwd) queue (queue_id) 2872 2873The available information parameters are: 2874 2875* ``port_id``: The port which the Ethertype filter assigned on. 2876 2877* ``mac_addr``: Compare destination mac address. 2878 2879* ``mac_ignr``: Ignore destination mac address match. 2880 2881* ``mac_address``: Destination mac address to match. 2882 2883* ``ether_type``: The EtherType value want to match, 2884 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid. 2885 2886* ``queue_id``: The receive queue associated with this EtherType filter. 2887 It is meaningless when deleting or dropping. 2888 2889Example, to add/remove an ethertype filter rule:: 2890 2891 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \ 2892 ethertype 0x0806 fwd queue 3 2893 2894 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \ 2895 ethertype 0x0806 fwd queue 3 2896 28972tuple_filter 2898~~~~~~~~~~~~~~~~~ 2899 2900Add or delete a 2-tuple filter, 2901which identifies packets by specific protocol and destination TCP/UDP port 2902and forwards packets into one of the receive queues:: 2903 2904 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \ 2905 protocol (protocol_value) mask (mask_value) \ 2906 tcp_flags (tcp_flags_value) priority (prio_value) \ 2907 queue (queue_id) 2908 2909The available information parameters are: 2910 2911* ``port_id``: The port which the 2-tuple filter assigned on. 2912 2913* ``dst_port_value``: Destination port in L4. 2914 2915* ``protocol_value``: IP L4 protocol. 2916 2917* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate. 2918 2919* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP). 2920 2921* ``prio_value``: Priority of this filter. 2922 2923* ``queue_id``: The receive queue associated with this 2-tuple filter. 2924 2925Example, to add/remove an 2tuple filter rule:: 2926 2927 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \ 2928 tcp_flags 0x02 priority 3 queue 3 2929 2930 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \ 2931 tcp_flags 0x02 priority 3 queue 3 2932 29335tuple_filter 2934~~~~~~~~~~~~~~~~~ 2935 2936Add or delete a 5-tuple filter, 2937which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port) 2938and routes packets into one of the receive queues:: 2939 2940 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \ 2941 (src_address) dst_port (dst_port_value) \ 2942 src_port (src_port_value) protocol (protocol_value) \ 2943 mask (mask_value) tcp_flags (tcp_flags_value) \ 2944 priority (prio_value) queue (queue_id) 2945 2946The available information parameters are: 2947 2948* ``port_id``: The port which the 5-tuple filter assigned on. 2949 2950* ``dst_address``: Destination IP address. 2951 2952* ``src_address``: Source IP address. 2953 2954* ``dst_port_value``: TCP/UDP destination port. 2955 2956* ``src_port_value``: TCP/UDP source port. 2957 2958* ``protocol_value``: L4 protocol. 2959 2960* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate 2961 2962* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP). 2963 2964* ``prio_value``: The priority of this filter. 2965 2966* ``queue_id``: The receive queue associated with this 5-tuple filter. 2967 2968Example, to add/remove an 5tuple filter rule:: 2969 2970 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \ 2971 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \ 2972 flags 0x0 priority 3 queue 3 2973 2974 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \ 2975 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \ 2976 flags 0x0 priority 3 queue 3 2977 2978syn_filter 2979~~~~~~~~~~ 2980 2981Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue:: 2982 2983 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id) 2984 2985The available information parameters are: 2986 2987* ``port_id``: The port which the SYN filter assigned on. 2988 2989* ``high``: This SYN filter has higher priority than other filters. 2990 2991* ``low``: This SYN filter has lower priority than other filters. 2992 2993* ``queue_id``: The receive queue associated with this SYN filter 2994 2995Example:: 2996 2997 testpmd> syn_filter 0 add priority high queue 3 2998 2999flex_filter 3000~~~~~~~~~~~ 3001 3002With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet 3003and routed into one of the receive queues:: 3004 3005 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \ 3006 mask (mask_value) priority (prio_value) queue (queue_id) 3007 3008The available information parameters are: 3009 3010* ``port_id``: The port which the Flex filter is assigned on. 3011 3012* ``len_value``: Filter length in bytes, no greater than 128. 3013 3014* ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match. 3015 3016* ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match. 3017 3018* ``prio_value``: The priority of this filter. 3019 3020* ``queue_id``: The receive queue associated with this Flex filter. 3021 3022Example:: 3023 3024 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \ 3025 mask 000C priority 3 queue 3 3026 3027 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \ 3028 mask 000C priority 3 queue 3 3029 3030 3031.. _testpmd_flow_director: 3032 3033flow_director_filter 3034~~~~~~~~~~~~~~~~~~~~ 3035 3036The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues. 3037 3038Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and 3039Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter: 3040 3041* Perfect match filters. 3042 The hardware checks a match between the masked fields of the received packets and the programmed filters. 3043 The masked fields are for IP flow. 3044 3045* Signature filters. 3046 The hardware checks a match between a hash-based signature of the masked fields of the received packet. 3047 3048* Perfect-mac-vlan match filters. 3049 The hardware checks a match between the masked fields of the received packets and the programmed filters. 3050 The masked fields are for MAC VLAN flow. 3051 3052* Perfect-tunnel match filters. 3053 The hardware checks a match between the masked fields of the received packets and the programmed filters. 3054 The masked fields are for tunnel flow. 3055 3056* Perfect-raw-flow-type match filters. 3057 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet. 3058 The masked fields are specified by input sets. 3059 3060The Flow Director filters can match the different fields for different type of packet: flow type, specific input set 3061per flow type and the flexible payload. 3062 3063The Flow Director can also mask out parts of all of these fields so that filters 3064are only applied to certain fields or parts of the fields. 3065 3066Note that for raw flow type mode the source and destination fields in the 3067raw packet buffer need to be presented in a reversed order with respect 3068to the expected received packets. 3069For example: IP source and destination addresses or TCP/UDP/SCTP 3070source and destination ports 3071 3072Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information. 3073 3074# Commands to add flow director filters of different flow types:: 3075 3076 flow_director_filter (port_id) mode IP (add|del|update) \ 3077 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \ 3078 src (src_ip_address) dst (dst_ip_address) \ 3079 tos (tos_value) proto (proto_value) ttl (ttl_value) \ 3080 vlan (vlan_value) flexbytes (flexbytes_value) \ 3081 (drop|fwd) pf|vf(vf_id) queue (queue_id) \ 3082 fd_id (fd_id_value) 3083 3084 flow_director_filter (port_id) mode IP (add|del|update) \ 3085 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \ 3086 src (src_ip_address) (src_port) \ 3087 dst (dst_ip_address) (dst_port) \ 3088 tos (tos_value) ttl (ttl_value) \ 3089 vlan (vlan_value) flexbytes (flexbytes_value) \ 3090 (drop|fwd) queue pf|vf(vf_id) (queue_id) \ 3091 fd_id (fd_id_value) 3092 3093 flow_director_filter (port_id) mode IP (add|del|update) \ 3094 flow (ipv4-sctp|ipv6-sctp) \ 3095 src (src_ip_address) (src_port) \ 3096 dst (dst_ip_address) (dst_port) \ 3097 tos (tos_value) ttl (ttl_value) \ 3098 tag (verification_tag) vlan (vlan_value) \ 3099 flexbytes (flexbytes_value) (drop|fwd) \ 3100 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value) 3101 3102 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \ 3103 ether (ethertype) flexbytes (flexbytes_value) \ 3104 (drop|fwd) pf|vf(vf_id) queue (queue_id) 3105 fd_id (fd_id_value) 3106 3107 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \ 3108 mac (mac_address) vlan (vlan_value) \ 3109 flexbytes (flexbytes_value) (drop|fwd) \ 3110 queue (queue_id) fd_id (fd_id_value) 3111 3112 flow_director_filter (port_id) mode Tunnel (add|del|update) \ 3113 mac (mac_address) vlan (vlan_value) \ 3114 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \ 3115 flexbytes (flexbytes_value) (drop|fwd) \ 3116 queue (queue_id) fd_id (fd_id_value) 3117 3118 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \ 3119 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \ 3120 packet (packet file name) 3121 3122For example, to add an ipv4-udp flow type filter:: 3123 3124 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \ 3125 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \ 3126 fwd pf queue 1 fd_id 1 3127 3128For example, add an ipv4-other flow type filter:: 3129 3130 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \ 3131 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \ 3132 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1 3133 3134flush_flow_director 3135~~~~~~~~~~~~~~~~~~~ 3136 3137Flush all flow director filters on a device:: 3138 3139 testpmd> flush_flow_director (port_id) 3140 3141Example, to flush all flow director filter on port 0:: 3142 3143 testpmd> flush_flow_director 0 3144 3145flow_director_mask 3146~~~~~~~~~~~~~~~~~~ 3147 3148Set flow director's input masks:: 3149 3150 flow_director_mask (port_id) mode IP vlan (vlan_value) \ 3151 src_mask (ipv4_src) (ipv6_src) (src_port) \ 3152 dst_mask (ipv4_dst) (ipv6_dst) (dst_port) 3153 3154 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) 3155 3156 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \ 3157 mac (mac_value) tunnel-type (tunnel_type_value) \ 3158 tunnel-id (tunnel_id_value) 3159 3160Example, to set flow director mask on port 0:: 3161 3162 testpmd> flow_director_mask 0 mode IP vlan 0xefff \ 3163 src_mask 255.255.255.255 \ 3164 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \ 3165 dst_mask 255.255.255.255 \ 3166 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF 3167 3168flow_director_flex_mask 3169~~~~~~~~~~~~~~~~~~~~~~~ 3170 3171set masks of flow director's flexible payload based on certain flow type:: 3172 3173 testpmd> flow_director_flex_mask (port_id) \ 3174 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 3175 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \ 3176 l2_payload|all) (mask) 3177 3178Example, to set flow director's flex mask for all flow type on port 0:: 3179 3180 testpmd> flow_director_flex_mask 0 flow all \ 3181 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0) 3182 3183 3184flow_director_flex_payload 3185~~~~~~~~~~~~~~~~~~~~~~~~~~ 3186 3187Configure flexible payload selection:: 3188 3189 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config) 3190 3191For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload:: 3192 3193 testpmd> flow_director_flex_payload 0 l4 \ 3194 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19) 3195 3196get_sym_hash_ena_per_port 3197~~~~~~~~~~~~~~~~~~~~~~~~~ 3198 3199Get symmetric hash enable configuration per port:: 3200 3201 get_sym_hash_ena_per_port (port_id) 3202 3203For example, to get symmetric hash enable configuration of port 1:: 3204 3205 testpmd> get_sym_hash_ena_per_port 1 3206 3207set_sym_hash_ena_per_port 3208~~~~~~~~~~~~~~~~~~~~~~~~~ 3209 3210Set symmetric hash enable configuration per port to enable or disable:: 3211 3212 set_sym_hash_ena_per_port (port_id) (enable|disable) 3213 3214For example, to set symmetric hash enable configuration of port 1 to enable:: 3215 3216 testpmd> set_sym_hash_ena_per_port 1 enable 3217 3218get_hash_global_config 3219~~~~~~~~~~~~~~~~~~~~~~ 3220 3221Get the global configurations of hash filters:: 3222 3223 get_hash_global_config (port_id) 3224 3225For example, to get the global configurations of hash filters of port 1:: 3226 3227 testpmd> get_hash_global_config 1 3228 3229set_hash_global_config 3230~~~~~~~~~~~~~~~~~~~~~~ 3231 3232Set the global configurations of hash filters:: 3233 3234 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \ 3235 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \ 3236 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \ 3237 (enable|disable) 3238 3239For example, to enable simple_xor for flow type of ipv6 on port 2:: 3240 3241 testpmd> set_hash_global_config 2 simple_xor ipv6 enable 3242 3243set_hash_input_set 3244~~~~~~~~~~~~~~~~~~ 3245 3246Set the input set for hash:: 3247 3248 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 3249 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \ 3250 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \ 3251 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \ 3252 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \ 3253 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \ 3254 fld-8th|none) (select|add) 3255 3256For example, to add source IP to hash input set for flow type of ipv4-udp on port 0:: 3257 3258 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add 3259 3260set_fdir_input_set 3261~~~~~~~~~~~~~~~~~~ 3262 3263The Flow Director filters can match the different fields for different type of packet, i.e. specific input set 3264on per flow type and the flexible payload. This command can be used to change input set for each flow type. 3265 3266Set the input set for flow director:: 3267 3268 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 3269 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \ 3270 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \ 3271 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \ 3272 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \ 3273 sctp-dst-port|sctp-veri-tag|none) (select|add) 3274 3275For example to add source IP to FD input set for flow type of ipv4-udp on port 0:: 3276 3277 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add 3278 3279global_config 3280~~~~~~~~~~~~~ 3281 3282Set different GRE key length for input set:: 3283 3284 global_config (port_id) gre-key-len (number in bytes) 3285 3286For example to set GRE key length for input set to 4 bytes on port 0:: 3287 3288 testpmd> global_config 0 gre-key-len 4 3289 3290 3291.. _testpmd_rte_flow: 3292 3293Flow rules management 3294--------------------- 3295 3296Control of the generic flow API (*rte_flow*) is fully exposed through the 3297``flow`` command (validation, creation, destruction, queries and operation 3298modes). 3299 3300Considering *rte_flow* overlaps with all `Filter Functions`_, using both 3301features simultaneously may cause undefined side-effects and is therefore 3302not recommended. 3303 3304``flow`` syntax 3305~~~~~~~~~~~~~~~ 3306 3307Because the ``flow`` command uses dynamic tokens to handle the large number 3308of possible flow rules combinations, its behavior differs slightly from 3309other commands, in particular: 3310 3311- Pressing *?* or the *<tab>* key displays contextual help for the current 3312 token, not that of the entire command. 3313 3314- Optional and repeated parameters are supported (provided they are listed 3315 in the contextual help). 3316 3317The first parameter stands for the operation mode. Possible operations and 3318their general syntax are described below. They are covered in detail in the 3319following sections. 3320 3321- Check whether a flow rule can be created:: 3322 3323 flow validate {port_id} 3324 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3325 pattern {item} [/ {item} [...]] / end 3326 actions {action} [/ {action} [...]] / end 3327 3328- Create a flow rule:: 3329 3330 flow create {port_id} 3331 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3332 pattern {item} [/ {item} [...]] / end 3333 actions {action} [/ {action} [...]] / end 3334 3335- Destroy specific flow rules:: 3336 3337 flow destroy {port_id} rule {rule_id} [...] 3338 3339- Destroy all flow rules:: 3340 3341 flow flush {port_id} 3342 3343- Query an existing flow rule:: 3344 3345 flow query {port_id} {rule_id} {action} 3346 3347- List existing flow rules sorted by priority, filtered by group 3348 identifiers:: 3349 3350 flow list {port_id} [group {group_id}] [...] 3351 3352- Restrict ingress traffic to the defined flow rules:: 3353 3354 flow isolate {port_id} {boolean} 3355 3356Validating flow rules 3357~~~~~~~~~~~~~~~~~~~~~ 3358 3359``flow validate`` reports whether a flow rule would be accepted by the 3360underlying device in its current state but stops short of creating it. It is 3361bound to ``rte_flow_validate()``:: 3362 3363 flow validate {port_id} 3364 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3365 pattern {item} [/ {item} [...]] / end 3366 actions {action} [/ {action} [...]] / end 3367 3368If successful, it will show:: 3369 3370 Flow rule validated 3371 3372Otherwise it will show an error message of the form:: 3373 3374 Caught error type [...] ([...]): [...] 3375 3376This command uses the same parameters as ``flow create``, their format is 3377described in `Creating flow rules`_. 3378 3379Check whether redirecting any Ethernet packet received on port 0 to RX queue 3380index 6 is supported:: 3381 3382 testpmd> flow validate 0 ingress pattern eth / end 3383 actions queue index 6 / end 3384 Flow rule validated 3385 testpmd> 3386 3387Port 0 does not support TCPv6 rules:: 3388 3389 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end 3390 actions drop / end 3391 Caught error type 9 (specific pattern item): Invalid argument 3392 testpmd> 3393 3394Creating flow rules 3395~~~~~~~~~~~~~~~~~~~ 3396 3397``flow create`` validates and creates the specified flow rule. It is bound 3398to ``rte_flow_create()``:: 3399 3400 flow create {port_id} 3401 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3402 pattern {item} [/ {item} [...]] / end 3403 actions {action} [/ {action} [...]] / end 3404 3405If successful, it will return a flow rule ID usable with other commands:: 3406 3407 Flow rule #[...] created 3408 3409Otherwise it will show an error message of the form:: 3410 3411 Caught error type [...] ([...]): [...] 3412 3413Parameters describe in the following order: 3414 3415- Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens). 3416- A matching pattern, starting with the *pattern* token and terminated by an 3417 *end* pattern item. 3418- Actions, starting with the *actions* token and terminated by an *end* 3419 action. 3420 3421These translate directly to *rte_flow* objects provided as-is to the 3422underlying functions. 3423 3424The shortest valid definition only comprises mandatory tokens:: 3425 3426 testpmd> flow create 0 pattern end actions end 3427 3428Note that PMDs may refuse rules that essentially do nothing such as this 3429one. 3430 3431**All unspecified object values are automatically initialized to 0.** 3432 3433Attributes 3434^^^^^^^^^^ 3435 3436These tokens affect flow rule attributes (``struct rte_flow_attr``) and are 3437specified before the ``pattern`` token. 3438 3439- ``group {group id}``: priority group. 3440- ``priority {level}``: priority level within group. 3441- ``ingress``: rule applies to ingress traffic. 3442- ``egress``: rule applies to egress traffic. 3443- ``transfer``: apply rule directly to endpoints found in pattern. 3444 3445Each instance of an attribute specified several times overrides the previous 3446value as shown below (group 4 is used):: 3447 3448 testpmd> flow create 0 group 42 group 24 group 4 [...] 3449 3450Note that once enabled, ``ingress`` and ``egress`` cannot be disabled. 3451 3452While not specifying a direction is an error, some rules may allow both 3453simultaneously. 3454 3455Most rules affect RX therefore contain the ``ingress`` token:: 3456 3457 testpmd> flow create 0 ingress pattern [...] 3458 3459Matching pattern 3460^^^^^^^^^^^^^^^^ 3461 3462A matching pattern starts after the ``pattern`` token. It is made of pattern 3463items and is terminated by a mandatory ``end`` item. 3464 3465Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum 3466rte_flow_item_type``). 3467 3468The ``/`` token is used as a separator between pattern items as shown 3469below:: 3470 3471 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...] 3472 3473Note that protocol items like these must be stacked from lowest to highest 3474layer to make sense. For instance, the following rule is either invalid or 3475unlikely to match any packet:: 3476 3477 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...] 3478 3479More information on these restrictions can be found in the *rte_flow* 3480documentation. 3481 3482Several items support additional specification structures, for example 3483``ipv4`` allows specifying source and destination addresses as follows:: 3484 3485 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1 3486 dst is 10.2.0.0 / end [...] 3487 3488This rule matches all IPv4 traffic with the specified properties. 3489 3490In this example, ``src`` and ``dst`` are field names of the underlying 3491``struct rte_flow_item_ipv4`` object. All item properties can be specified 3492in a similar fashion. 3493 3494The ``is`` token means that the subsequent value must be matched exactly, 3495and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item`` 3496accordingly. Possible assignment tokens are: 3497 3498- ``is``: match value perfectly (with full bit-mask). 3499- ``spec``: match value according to configured bit-mask. 3500- ``last``: specify upper bound to establish a range. 3501- ``mask``: specify bit-mask with relevant bits set to one. 3502- ``prefix``: generate bit-mask from a prefix length. 3503 3504These yield identical results:: 3505 3506 ipv4 src is 10.1.1.1 3507 3508:: 3509 3510 ipv4 src spec 10.1.1.1 src mask 255.255.255.255 3511 3512:: 3513 3514 ipv4 src spec 10.1.1.1 src prefix 32 3515 3516:: 3517 3518 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value 3519 3520:: 3521 3522 ipv4 src is 10.1.1.1 src last 0 # 0 disables range 3523 3524Inclusive ranges can be defined with ``last``:: 3525 3526 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4 3527 3528Note that ``mask`` affects both ``spec`` and ``last``:: 3529 3530 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0 3531 # matches 10.1.0.0 to 10.2.255.255 3532 3533Properties can be modified multiple times:: 3534 3535 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4 3536 3537:: 3538 3539 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16 3540 3541Pattern items 3542^^^^^^^^^^^^^ 3543 3544This section lists supported pattern items and their attributes, if any. 3545 3546- ``end``: end list of pattern items. 3547 3548- ``void``: no-op pattern item. 3549 3550- ``invert``: perform actions when pattern does not match. 3551 3552- ``any``: match any protocol for the current layer. 3553 3554 - ``num {unsigned}``: number of layers covered. 3555 3556- ``pf``: match traffic from/to the physical function. 3557 3558- ``vf``: match traffic from/to a virtual function ID. 3559 3560 - ``id {unsigned}``: VF ID. 3561 3562- ``phy_port``: match traffic from/to a specific physical port. 3563 3564 - ``index {unsigned}``: physical port index. 3565 3566- ``port_id``: match traffic from/to a given DPDK port ID. 3567 3568 - ``id {unsigned}``: DPDK port ID. 3569 3570- ``mark``: match value set in previously matched flow rule using the mark action. 3571 3572 - ``id {unsigned}``: arbitrary integer value. 3573 3574- ``raw``: match an arbitrary byte string. 3575 3576 - ``relative {boolean}``: look for pattern after the previous item. 3577 - ``search {boolean}``: search pattern from offset (see also limit). 3578 - ``offset {integer}``: absolute or relative offset for pattern. 3579 - ``limit {unsigned}``: search area limit for start of pattern. 3580 - ``pattern {string}``: byte string to look for. 3581 3582- ``eth``: match Ethernet header. 3583 3584 - ``dst {MAC-48}``: destination MAC. 3585 - ``src {MAC-48}``: source MAC. 3586 - ``type {unsigned}``: EtherType or TPID. 3587 3588- ``vlan``: match 802.1Q/ad VLAN tag. 3589 3590 - ``tci {unsigned}``: tag control information. 3591 - ``pcp {unsigned}``: priority code point. 3592 - ``dei {unsigned}``: drop eligible indicator. 3593 - ``vid {unsigned}``: VLAN identifier. 3594 - ``inner_type {unsigned}``: inner EtherType or TPID. 3595 3596- ``ipv4``: match IPv4 header. 3597 3598 - ``tos {unsigned}``: type of service. 3599 - ``ttl {unsigned}``: time to live. 3600 - ``proto {unsigned}``: next protocol ID. 3601 - ``src {ipv4 address}``: source address. 3602 - ``dst {ipv4 address}``: destination address. 3603 3604- ``ipv6``: match IPv6 header. 3605 3606 - ``tc {unsigned}``: traffic class. 3607 - ``flow {unsigned}``: flow label. 3608 - ``proto {unsigned}``: protocol (next header). 3609 - ``hop {unsigned}``: hop limit. 3610 - ``src {ipv6 address}``: source address. 3611 - ``dst {ipv6 address}``: destination address. 3612 3613- ``icmp``: match ICMP header. 3614 3615 - ``type {unsigned}``: ICMP packet type. 3616 - ``code {unsigned}``: ICMP packet code. 3617 3618- ``udp``: match UDP header. 3619 3620 - ``src {unsigned}``: UDP source port. 3621 - ``dst {unsigned}``: UDP destination port. 3622 3623- ``tcp``: match TCP header. 3624 3625 - ``src {unsigned}``: TCP source port. 3626 - ``dst {unsigned}``: TCP destination port. 3627 3628- ``sctp``: match SCTP header. 3629 3630 - ``src {unsigned}``: SCTP source port. 3631 - ``dst {unsigned}``: SCTP destination port. 3632 - ``tag {unsigned}``: validation tag. 3633 - ``cksum {unsigned}``: checksum. 3634 3635- ``vxlan``: match VXLAN header. 3636 3637 - ``vni {unsigned}``: VXLAN identifier. 3638 3639- ``e_tag``: match IEEE 802.1BR E-Tag header. 3640 3641 - ``grp_ecid_b {unsigned}``: GRP and E-CID base. 3642 3643- ``nvgre``: match NVGRE header. 3644 3645 - ``tni {unsigned}``: virtual subnet ID. 3646 3647- ``mpls``: match MPLS header. 3648 3649 - ``label {unsigned}``: MPLS label. 3650 3651- ``gre``: match GRE header. 3652 3653 - ``protocol {unsigned}``: protocol type. 3654 3655- ``fuzzy``: fuzzy pattern match, expect faster than default. 3656 3657 - ``thresh {unsigned}``: accuracy threshold. 3658 3659- ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header. 3660 3661 - ``teid {unsigned}``: tunnel endpoint identifier. 3662 3663- ``geneve``: match GENEVE header. 3664 3665 - ``vni {unsigned}``: virtual network identifier. 3666 - ``protocol {unsigned}``: protocol type. 3667 3668- ``vxlan-gpe``: match VXLAN-GPE header. 3669 3670 - ``vni {unsigned}``: VXLAN-GPE identifier. 3671 3672- ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4. 3673 3674 - ``sha {MAC-48}``: sender hardware address. 3675 - ``spa {ipv4 address}``: sender IPv4 address. 3676 - ``tha {MAC-48}``: target hardware address. 3677 - ``tpa {ipv4 address}``: target IPv4 address. 3678 3679- ``ipv6_ext``: match presence of any IPv6 extension header. 3680 3681 - ``next_hdr {unsigned}``: next header. 3682 3683- ``icmp6``: match any ICMPv6 header. 3684 3685 - ``type {unsigned}``: ICMPv6 type. 3686 - ``code {unsigned}``: ICMPv6 code. 3687 3688- ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation. 3689 3690 - ``target_addr {ipv6 address}``: target address. 3691 3692- ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement. 3693 3694 - ``target_addr {ipv6 address}``: target address. 3695 3696- ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option. 3697 3698 - ``type {unsigned}``: ND option type. 3699 3700- ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet 3701 link-layer address option. 3702 3703 - ``sla {MAC-48}``: source Ethernet LLA. 3704 3705- ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery target Ethernet 3706 link-layer address option. 3707 3708 - ``tla {MAC-48}``: target Ethernet LLA. 3709 3710- ``meta``: match application specific metadata. 3711 3712 - ``data {unsigned}``: metadata value. 3713 3714Actions list 3715^^^^^^^^^^^^ 3716 3717A list of actions starts after the ``actions`` token in the same fashion as 3718`Matching pattern`_; actions are separated by ``/`` tokens and the list is 3719terminated by a mandatory ``end`` action. 3720 3721Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum 3722rte_flow_action_type``). 3723 3724Dropping all incoming UDPv4 packets can be expressed as follows:: 3725 3726 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3727 actions drop / end 3728 3729Several actions have configurable properties which must be specified when 3730there is no valid default value. For example, ``queue`` requires a target 3731queue index. 3732 3733This rule redirects incoming UDPv4 traffic to queue index 6:: 3734 3735 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3736 actions queue index 6 / end 3737 3738While this one could be rejected by PMDs (unspecified queue index):: 3739 3740 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3741 actions queue / end 3742 3743As defined by *rte_flow*, the list is not ordered, all actions of a given 3744rule are performed simultaneously. These are equivalent:: 3745 3746 queue index 6 / void / mark id 42 / end 3747 3748:: 3749 3750 void / mark id 42 / queue index 6 / end 3751 3752All actions in a list should have different types, otherwise only the last 3753action of a given type is taken into account:: 3754 3755 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6 3756 3757:: 3758 3759 drop / drop / drop / end # drop is performed only once 3760 3761:: 3762 3763 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24 3764 3765Considering they are performed simultaneously, opposite and overlapping 3766actions can sometimes be combined when the end result is unambiguous:: 3767 3768 drop / queue index 6 / end # drop has no effect 3769 3770:: 3771 3772 queue index 6 / rss queues 6 7 8 / end # queue has no effect 3773 3774:: 3775 3776 drop / passthru / end # drop has no effect 3777 3778Note that PMDs may still refuse such combinations. 3779 3780Actions 3781^^^^^^^ 3782 3783This section lists supported actions and their attributes, if any. 3784 3785- ``end``: end list of actions. 3786 3787- ``void``: no-op action. 3788 3789- ``passthru``: let subsequent rule process matched packets. 3790 3791- ``jump``: redirect traffic to group on device. 3792 3793 - ``group {unsigned}``: group to redirect to. 3794 3795- ``mark``: attach 32 bit value to packets. 3796 3797 - ``id {unsigned}``: 32 bit value to return with packets. 3798 3799- ``flag``: flag packets. 3800 3801- ``queue``: assign packets to a given queue index. 3802 3803 - ``index {unsigned}``: queue index to use. 3804 3805- ``drop``: drop packets (note: passthru has priority). 3806 3807- ``count``: enable counters for this rule. 3808 3809- ``rss``: spread packets among several queues. 3810 3811 - ``func {hash function}``: RSS hash function to apply, allowed tokens are 3812 the same as `set_hash_global_config`_. 3813 3814 - ``level {unsigned}``: encapsulation level for ``types``. 3815 3816 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed 3817 tokens are the same as `set_hash_input_set`_, except that an empty list 3818 does not disable RSS but instead requests unspecified "best-effort" 3819 settings. 3820 3821 - ``key {string}``: RSS hash key, overrides ``key_len``. 3822 3823 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in 3824 conjunction with ``key`` to pad or truncate it. 3825 3826 - ``queues [{unsigned} [...]] end``: queue indices to use. 3827 3828- ``pf``: direct traffic to physical function. 3829 3830- ``vf``: direct traffic to a virtual function ID. 3831 3832 - ``original {boolean}``: use original VF ID if possible. 3833 - ``id {unsigned}``: VF ID. 3834 3835- ``phy_port``: direct packets to physical port index. 3836 3837 - ``original {boolean}``: use original port index if possible. 3838 - ``index {unsigned}``: physical port index. 3839 3840- ``port_id``: direct matching traffic to a given DPDK port ID. 3841 3842 - ``original {boolean}``: use original DPDK port ID if possible. 3843 - ``id {unsigned}``: DPDK port ID. 3844 3845- ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``. 3846 3847 - ``mpls_ttl``: MPLS TTL. 3848 3849- ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``. 3850 3851- ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``. 3852 3853 - ``nw_ttl``: IP TTL. 3854 3855- ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``. 3856 3857- ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``. 3858 3859- ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``. 3860 3861- ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``. 3862 3863- ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``. 3864 3865 - ``ethertype``: Ethertype. 3866 3867- ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``. 3868 3869 - ``vlan_vid``: VLAN id. 3870 3871- ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``. 3872 3873 - ``vlan_pcp``: VLAN priority. 3874 3875- ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``. 3876 3877 - ``ethertype``: Ethertype. 3878 3879- ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``. 3880 3881 - ``ethertype``: Ethertype. 3882 3883- ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration 3884 is done through `Config VXLAN Encap outer layers`_. 3885 3886- ``vxlan_decap``: Performs a decapsulation action by stripping all headers of 3887 the VXLAN tunnel network overlay from the matched flow. 3888 3889- ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration 3890 is done through `Config NVGRE Encap outer layers`_. 3891 3892- ``nvgre_decap``: Performs a decapsulation action by stripping all headers of 3893 the NVGRE tunnel network overlay from the matched flow. 3894 3895- ``l2_encap``: Performs a L2 encapsulation, L2 configuration 3896 is done through `Config L2 Encap`_. 3897 3898- ``l2_decap``: Performs a L2 decapsulation, L2 configuration 3899 is done through `Config L2 Decap`_. 3900 3901- ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer 3902 configuration is done through `Config MPLSoGRE Encap outer layers`_. 3903 3904- ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer 3905 configuration is done through `Config MPLSoGRE Decap outer layers`_. 3906 3907- ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer 3908 configuration is done through `Config MPLSoUDP Encap outer layers`_. 3909 3910- ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer 3911 configuration is done through `Config MPLSoUDP Decap outer layers`_. 3912 3913- ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header. 3914 3915 - ``ipv4_addr``: New IPv4 source address. 3916 3917- ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4 3918 header. 3919 3920 - ``ipv4_addr``: New IPv4 destination address. 3921 3922- ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header. 3923 3924 - ``ipv6_addr``: New IPv6 source address. 3925 3926- ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6 3927 header. 3928 3929 - ``ipv6_addr``: New IPv6 destination address. 3930 3931- ``of_set_tp_src``: Set a new source port number in the outermost TCP/UDP 3932 header. 3933 3934 - ``port``: New TCP/UDP source port number. 3935 3936- ``of_set_tp_dst``: Set a new destination port number in the outermost TCP/UDP 3937 header. 3938 3939 - ``port``: New TCP/UDP destination port number. 3940 3941- ``mac_swap``: Swap the source and destination MAC addresses in the outermost 3942 Ethernet header. 3943 3944- ``dec_ttl``: Performs a decrease TTL value action 3945 3946- ``set_ttl``: Set TTL value with specificed value 3947 - ``ttl_value {unsigned}``: The new TTL value to be set 3948 3949- ``set_mac_src``: set source MAC address 3950 3951 - ``mac_addr {MAC-48}``: new source MAC address 3952 3953- ``set_mac_dst``: set destination MAC address 3954 3955 - ``mac_addr {MAC-48}``: new destination MAC address 3956 3957Destroying flow rules 3958~~~~~~~~~~~~~~~~~~~~~ 3959 3960``flow destroy`` destroys one or more rules from their rule ID (as returned 3961by ``flow create``), this command calls ``rte_flow_destroy()`` as many 3962times as necessary:: 3963 3964 flow destroy {port_id} rule {rule_id} [...] 3965 3966If successful, it will show:: 3967 3968 Flow rule #[...] destroyed 3969 3970It does not report anything for rule IDs that do not exist. The usual error 3971message is shown when a rule cannot be destroyed:: 3972 3973 Caught error type [...] ([...]): [...] 3974 3975``flow flush`` destroys all rules on a device and does not take extra 3976arguments. It is bound to ``rte_flow_flush()``:: 3977 3978 flow flush {port_id} 3979 3980Any errors are reported as above. 3981 3982Creating several rules and destroying them:: 3983 3984 testpmd> flow create 0 ingress pattern eth / ipv6 / end 3985 actions queue index 2 / end 3986 Flow rule #0 created 3987 testpmd> flow create 0 ingress pattern eth / ipv4 / end 3988 actions queue index 3 / end 3989 Flow rule #1 created 3990 testpmd> flow destroy 0 rule 0 rule 1 3991 Flow rule #1 destroyed 3992 Flow rule #0 destroyed 3993 testpmd> 3994 3995The same result can be achieved using ``flow flush``:: 3996 3997 testpmd> flow create 0 ingress pattern eth / ipv6 / end 3998 actions queue index 2 / end 3999 Flow rule #0 created 4000 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4001 actions queue index 3 / end 4002 Flow rule #1 created 4003 testpmd> flow flush 0 4004 testpmd> 4005 4006Non-existent rule IDs are ignored:: 4007 4008 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4009 actions queue index 2 / end 4010 Flow rule #0 created 4011 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4012 actions queue index 3 / end 4013 Flow rule #1 created 4014 testpmd> flow destroy 0 rule 42 rule 10 rule 2 4015 testpmd> 4016 testpmd> flow destroy 0 rule 0 4017 Flow rule #0 destroyed 4018 testpmd> 4019 4020Querying flow rules 4021~~~~~~~~~~~~~~~~~~~ 4022 4023``flow query`` queries a specific action of a flow rule having that 4024ability. Such actions collect information that can be reported using this 4025command. It is bound to ``rte_flow_query()``:: 4026 4027 flow query {port_id} {rule_id} {action} 4028 4029If successful, it will display either the retrieved data for known actions 4030or the following message:: 4031 4032 Cannot display result for action type [...] ([...]) 4033 4034Otherwise, it will complain either that the rule does not exist or that some 4035error occurred:: 4036 4037 Flow rule #[...] not found 4038 4039:: 4040 4041 Caught error type [...] ([...]): [...] 4042 4043Currently only the ``count`` action is supported. This action reports the 4044number of packets that hit the flow rule and the total number of bytes. Its 4045output has the following format:: 4046 4047 count: 4048 hits_set: [...] # whether "hits" contains a valid value 4049 bytes_set: [...] # whether "bytes" contains a valid value 4050 hits: [...] # number of packets 4051 bytes: [...] # number of bytes 4052 4053Querying counters for TCPv6 packets redirected to queue 6:: 4054 4055 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end 4056 actions queue index 6 / count / end 4057 Flow rule #4 created 4058 testpmd> flow query 0 4 count 4059 count: 4060 hits_set: 1 4061 bytes_set: 0 4062 hits: 386446 4063 bytes: 0 4064 testpmd> 4065 4066Listing flow rules 4067~~~~~~~~~~~~~~~~~~ 4068 4069``flow list`` lists existing flow rules sorted by priority and optionally 4070filtered by group identifiers:: 4071 4072 flow list {port_id} [group {group_id}] [...] 4073 4074This command only fails with the following message if the device does not 4075exist:: 4076 4077 Invalid port [...] 4078 4079Output consists of a header line followed by a short description of each 4080flow rule, one per line. There is no output at all when no flow rules are 4081configured on the device:: 4082 4083 ID Group Prio Attr Rule 4084 [...] [...] [...] [...] [...] 4085 4086``Attr`` column flags: 4087 4088- ``i`` for ``ingress``. 4089- ``e`` for ``egress``. 4090 4091Creating several flow rules and listing them:: 4092 4093 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4094 actions queue index 6 / end 4095 Flow rule #0 created 4096 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4097 actions queue index 2 / end 4098 Flow rule #1 created 4099 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end 4100 actions rss queues 6 7 8 end / end 4101 Flow rule #2 created 4102 testpmd> flow list 0 4103 ID Group Prio Attr Rule 4104 0 0 0 i- ETH IPV4 => QUEUE 4105 1 0 0 i- ETH IPV6 => QUEUE 4106 2 0 5 i- ETH IPV4 UDP => RSS 4107 testpmd> 4108 4109Rules are sorted by priority (i.e. group ID first, then priority level):: 4110 4111 testpmd> flow list 1 4112 ID Group Prio Attr Rule 4113 0 0 0 i- ETH => COUNT 4114 6 0 500 i- ETH IPV6 TCP => DROP COUNT 4115 5 0 1000 i- ETH IPV6 ICMP => QUEUE 4116 1 24 0 i- ETH IPV4 UDP => QUEUE 4117 4 24 10 i- ETH IPV4 TCP => DROP 4118 3 24 20 i- ETH IPV4 => DROP 4119 2 24 42 i- ETH IPV4 UDP => QUEUE 4120 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE 4121 testpmd> 4122 4123Output can be limited to specific groups:: 4124 4125 testpmd> flow list 1 group 0 group 63 4126 ID Group Prio Attr Rule 4127 0 0 0 i- ETH => COUNT 4128 6 0 500 i- ETH IPV6 TCP => DROP COUNT 4129 5 0 1000 i- ETH IPV6 ICMP => QUEUE 4130 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE 4131 testpmd> 4132 4133Toggling isolated mode 4134~~~~~~~~~~~~~~~~~~~~~~ 4135 4136``flow isolate`` can be used to tell the underlying PMD that ingress traffic 4137must only be injected from the defined flow rules; that no default traffic 4138is expected outside those rules and the driver is free to assign more 4139resources to handle them. It is bound to ``rte_flow_isolate()``:: 4140 4141 flow isolate {port_id} {boolean} 4142 4143If successful, enabling or disabling isolated mode shows either:: 4144 4145 Ingress traffic on port [...] 4146 is now restricted to the defined flow rules 4147 4148Or:: 4149 4150 Ingress traffic on port [...] 4151 is not restricted anymore to the defined flow rules 4152 4153Otherwise, in case of error:: 4154 4155 Caught error type [...] ([...]): [...] 4156 4157Mainly due to its side effects, PMDs supporting this mode may not have the 4158ability to toggle it more than once without reinitializing affected ports 4159first (e.g. by exiting testpmd). 4160 4161Enabling isolated mode:: 4162 4163 testpmd> flow isolate 0 true 4164 Ingress traffic on port 0 is now restricted to the defined flow rules 4165 testpmd> 4166 4167Disabling isolated mode:: 4168 4169 testpmd> flow isolate 0 false 4170 Ingress traffic on port 0 is not restricted anymore to the defined flow rules 4171 testpmd> 4172 4173Sample QinQ flow rules 4174~~~~~~~~~~~~~~~~~~~~~~ 4175 4176Before creating QinQ rule(s) the following commands should be issued to enable QinQ:: 4177 4178 testpmd> port stop 0 4179 testpmd> vlan set qinq on 0 4180 4181The above command sets the inner and outer TPID's to 0x8100. 4182 4183To change the TPID's the following commands should be used:: 4184 4185 testpmd> vlan set outer tpid 0xa100 0 4186 testpmd> vlan set inner tpid 0x9100 0 4187 testpmd> port start 0 4188 4189Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM. 4190 4191:: 4192 4193 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 / 4194 vlan tci is 456 / end actions vf id 1 / queue index 0 / end 4195 Flow rule #0 validated 4196 4197 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 / 4198 vlan tci is 456 / end actions vf id 123 / queue index 0 / end 4199 Flow rule #0 created 4200 4201 testpmd> flow list 0 4202 ID Group Prio Attr Rule 4203 0 0 0 i- ETH VLAN VLAN=>VF QUEUE 4204 4205Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host. 4206 4207:: 4208 4209 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 / 4210 vlan tci is 654 / end actions pf / queue index 0 / end 4211 Flow rule #1 validated 4212 4213 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 / 4214 vlan tci is 654 / end actions pf / queue index 1 / end 4215 Flow rule #1 created 4216 4217 testpmd> flow list 0 4218 ID Group Prio Attr Rule 4219 0 0 0 i- ETH VLAN VLAN=>VF QUEUE 4220 1 0 0 i- ETH VLAN VLAN=>PF QUEUE 4221 4222Sample VXLAN encapsulation rule 4223~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4224 4225VXLAN encapsulation outer layer has default value pre-configured in testpmd 4226source code, those can be changed by using the following commands 4227 4228IPv4 VXLAN outer header:: 4229 4230 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1 4231 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4232 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4233 queue index 0 / end 4234 4235 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 4236 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11 4237 eth-dst 22:22:22:22:22:22 4238 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4239 queue index 0 / end 4240 4241IPv6 VXLAN outer header:: 4242 4243 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1 4244 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4245 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4246 queue index 0 / end 4247 4248 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 4249 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11 4250 eth-dst 22:22:22:22:22:22 4251 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4252 queue index 0 / end 4253 4254Sample NVGRE encapsulation rule 4255~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4256 4257NVGRE encapsulation outer layer has default value pre-configured in testpmd 4258source code, those can be changed by using the following commands 4259 4260IPv4 NVGRE outer header:: 4261 4262 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1 4263 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4264 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4265 queue index 0 / end 4266 4267 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1 4268 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11 4269 eth-dst 22:22:22:22:22:22 4270 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4271 queue index 0 / end 4272 4273IPv6 NVGRE outer header:: 4274 4275 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222 4276 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4277 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4278 queue index 0 / end 4279 4280 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222 4281 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4282 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4283 queue index 0 / end 4284 4285Sample L2 encapsulation rule 4286~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4287 4288L2 encapsulation has default value pre-configured in testpmd 4289source code, those can be changed by using the following commands 4290 4291L2 header:: 4292 4293 testpmd> set l2_encap ip-version ipv4 4294 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4295 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 4296 mplsoudp_decap / l2_encap / end 4297 4298L2 with VXLAN header:: 4299 4300 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34 4301 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4302 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 4303 mplsoudp_decap / l2_encap / end 4304 4305Sample L2 decapsulation rule 4306~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4307 4308L2 decapsulation has default value pre-configured in testpmd 4309source code, those can be changed by using the following commands 4310 4311L2 header:: 4312 4313 testpmd> set l2_decap 4314 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap / 4315 queue index 0 / end 4316 4317L2 with VXLAN header:: 4318 4319 testpmd> set l2_encap-with-vlan 4320 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap / 4321 queue index 0 / end 4322 4323Sample MPLSoGRE encapsulation rule 4324~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4325 4326MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd 4327source code, those can be changed by using the following commands 4328 4329IPv4 MPLSoGRE outer header:: 4330 4331 testpmd> set mplsogre_encap ip-version ipv4 label 4 4332 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 4333 eth-dst 22:22:22:22:22:22 4334 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4335 mplsogre_encap / end 4336 4337IPv4 MPLSoGRE with VLAN outer header:: 4338 4339 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4 4340 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 4341 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4342 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4343 mplsogre_encap / end 4344 4345IPv6 MPLSoGRE outer header:: 4346 4347 testpmd> set mplsogre_encap ip-version ipv6 mask 4 4348 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11 4349 eth-dst 22:22:22:22:22:22 4350 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4351 mplsogre_encap / end 4352 4353IPv6 MPLSoGRE with VLAN outer header:: 4354 4355 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4 4356 ip-src ::1 ip-dst ::2222 vlan-tci 34 4357 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4358 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4359 mplsogre_encap / end 4360 4361Sample MPLSoGRE decapsulation rule 4362~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4363 4364MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd 4365source code, those can be changed by using the following commands 4366 4367IPv4 MPLSoGRE outer header:: 4368 4369 testpmd> set mplsogre_decap ip-version ipv4 4370 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions 4371 mplsogre_decap / l2_encap / end 4372 4373IPv4 MPLSoGRE with VLAN outer header:: 4374 4375 testpmd> set mplsogre_decap-with-vlan ip-version ipv4 4376 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end 4377 actions mplsogre_decap / l2_encap / end 4378 4379IPv6 MPLSoGRE outer header:: 4380 4381 testpmd> set mplsogre_decap ip-version ipv6 4382 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end 4383 actions mplsogre_decap / l2_encap / end 4384 4385IPv6 MPLSoGRE with VLAN outer header:: 4386 4387 testpmd> set mplsogre_decap-with-vlan ip-version ipv6 4388 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end 4389 actions mplsogre_decap / l2_encap / end 4390 4391Sample MPLSoUDP encapsulation rule 4392~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4393 4394MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd 4395source code, those can be changed by using the following commands 4396 4397IPv4 MPLSoUDP outer header:: 4398 4399 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10 4400 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 4401 eth-dst 22:22:22:22:22:22 4402 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4403 mplsoudp_encap / end 4404 4405IPv4 MPLSoUDP with VLAN outer header:: 4406 4407 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5 4408 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 4409 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4410 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4411 mplsoudp_encap / end 4412 4413IPv6 MPLSoUDP outer header:: 4414 4415 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10 4416 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11 4417 eth-dst 22:22:22:22:22:22 4418 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4419 mplsoudp_encap / end 4420 4421IPv6 MPLSoUDP with VLAN outer header:: 4422 4423 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5 4424 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34 4425 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4426 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4427 mplsoudp_encap / end 4428 4429Sample MPLSoUDP decapsulation rule 4430~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4431 4432MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd 4433source code, those can be changed by using the following commands 4434 4435IPv4 MPLSoUDP outer header:: 4436 4437 testpmd> set mplsoudp_decap ip-version ipv4 4438 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 4439 mplsoudp_decap / l2_encap / end 4440 4441IPv4 MPLSoUDP with VLAN outer header:: 4442 4443 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4 4444 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end 4445 actions mplsoudp_decap / l2_encap / end 4446 4447IPv6 MPLSoUDP outer header:: 4448 4449 testpmd> set mplsoudp_decap ip-version ipv6 4450 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end 4451 actions mplsoudp_decap / l2_encap / end 4452 4453IPv6 MPLSoUDP with VLAN outer header:: 4454 4455 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6 4456 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end 4457 actions mplsoudp_decap / l2_encap / end 4458 4459BPF Functions 4460-------------- 4461 4462The following sections show functions to load/unload eBPF based filters. 4463 4464bpf-load 4465~~~~~~~~ 4466 4467Load an eBPF program as a callback for partciular RX/TX queue:: 4468 4469 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename) 4470 4471The available load-flags are: 4472 4473* ``J``: use JIT generated native code, otherwise BPF interpreter will be used. 4474 4475* ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data. 4476 4477* ``-``: none. 4478 4479.. note:: 4480 4481 You'll need clang v3.7 or above to build bpf program you'd like to load 4482 4483For example: 4484 4485.. code-block:: console 4486 4487 cd test/bpf 4488 clang -O2 -target bpf -c t1.c 4489 4490Then to load (and JIT compile) t1.o at RX queue 0, port 1:: 4491 4492.. code-block:: console 4493 4494 testpmd> bpf-load rx 1 0 J ./dpdk.org/test/bpf/t1.o 4495 4496To load (not JITed) t1.o at TX queue 0, port 0:: 4497 4498.. code-block:: console 4499 4500 testpmd> bpf-load tx 0 0 - ./dpdk.org/test/bpf/t1.o 4501 4502bpf-unload 4503~~~~~~~~~~ 4504 4505Unload previously loaded eBPF program for partciular RX/TX queue:: 4506 4507 testpmd> bpf-unload rx|tx (portid) (queueid) 4508 4509For example to unload BPF filter from TX queue 0, port 0: 4510 4511.. code-block:: console 4512 4513 testpmd> bpf-load tx 0 0 - ./dpdk.org/test/bpf/t1.o 4514