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-peers-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 ICMP 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 software stored 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) (peer_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 1586 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \ 1587 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \ 1588 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst) 1589 1590Those command will set an internal configuration inside testpmd, any following 1591flow rule using the action vxlan_encap will use the last configuration set. 1592To have a different encapsulation header, one of those commands must be called 1593before the flow rule creation. 1594 1595Config NVGRE Encap outer layers 1596~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1597 1598Configure the outer layer to encapsulate a packet inside a NVGRE tunnel:: 1599 1600 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \ 1601 eth-src (eth-src) eth-dst (eth-dst) 1602 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \ 1603 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst) 1604 1605Those command will set an internal configuration inside testpmd, any following 1606flow rule using the action nvgre_encap will use the last configuration set. 1607To have a different encapsulation header, one of those commands must be called 1608before the flow rule creation. 1609 1610Config L2 Encap 1611~~~~~~~~~~~~~~~ 1612 1613Configure the l2 to be used when encapsulating a packet with L2:: 1614 1615 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst) 1616 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \ 1617 eth-src (eth-src) eth-dst (eth-dst) 1618 1619Those commands will set an internal configuration inside testpmd, any following 1620flow rule using the action l2_encap will use the last configuration set. 1621To have a different encapsulation header, one of those commands must be called 1622before the flow rule creation. 1623 1624Config L2 Decap 1625~~~~~~~~~~~~~~~ 1626 1627Configure the l2 to be removed when decapsulating a packet with L2:: 1628 1629 set l2_decap ip-version (ipv4|ipv6) 1630 set l2_decap-with-vlan ip-version (ipv4|ipv6) 1631 1632Those commands will set an internal configuration inside testpmd, any following 1633flow rule using the action l2_decap will use the last configuration set. 1634To have a different encapsulation header, one of those commands must be called 1635before the flow rule creation. 1636 1637Config MPLSoGRE Encap outer layers 1638~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1639 1640Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel:: 1641 1642 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \ 1643 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst) 1644 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \ 1645 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \ 1646 eth-src (eth-src) eth-dst (eth-dst) 1647 1648Those command will set an internal configuration inside testpmd, any following 1649flow rule using the action mplsogre_encap will use the last configuration set. 1650To have a different encapsulation header, one of those commands must be called 1651before the flow rule creation. 1652 1653Config MPLSoGRE Decap outer layers 1654~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1655 1656Configure the outer layer to decapsulate MPLSoGRE packet:: 1657 1658 set mplsogre_decap ip-version (ipv4|ipv6) 1659 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6) 1660 1661Those command will set an internal configuration inside testpmd, any following 1662flow rule using the action mplsogre_decap will use the last configuration set. 1663To have a different decapsulation header, one of those commands must be called 1664before the flow rule creation. 1665 1666Config MPLSoUDP Encap outer layers 1667~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1668 1669Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel:: 1670 1671 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \ 1672 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \ 1673 eth-src (eth-src) eth-dst (eth-dst) 1674 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \ 1675 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \ 1676 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst) 1677 1678Those command will set an internal configuration inside testpmd, any following 1679flow rule using the action mplsoudp_encap will use the last configuration set. 1680To have a different encapsulation header, one of those commands must be called 1681before the flow rule creation. 1682 1683Config MPLSoUDP Decap outer layers 1684~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1685 1686Configure the outer layer to decapsulate MPLSoUDP packet:: 1687 1688 set mplsoudp_decap ip-version (ipv4|ipv6) 1689 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6) 1690 1691Those command will set an internal configuration inside testpmd, any following 1692flow rule using the action mplsoudp_decap will use the last configuration set. 1693To have a different decapsulation header, one of those commands must be called 1694before the flow rule creation. 1695 1696Port Functions 1697-------------- 1698 1699The following sections show functions for configuring ports. 1700 1701.. note:: 1702 1703 Port configuration changes only become active when forwarding is started/restarted. 1704 1705port attach 1706~~~~~~~~~~~ 1707 1708Attach a port specified by pci address or virtual device args:: 1709 1710 testpmd> port attach (identifier) 1711 1712To attach a new pci device, the device should be recognized by kernel first. 1713Then it should be moved under DPDK management. 1714Finally the port can be attached to testpmd. 1715 1716For example, to move a pci device using ixgbe under DPDK management: 1717 1718.. code-block:: console 1719 1720 # Check the status of the available devices. 1721 ./usertools/dpdk-devbind.py --status 1722 1723 Network devices using DPDK-compatible driver 1724 ============================================ 1725 <none> 1726 1727 Network devices using kernel driver 1728 =================================== 1729 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused= 1730 1731 1732 # Bind the device to igb_uio. 1733 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0 1734 1735 1736 # Recheck the status of the devices. 1737 ./usertools/dpdk-devbind.py --status 1738 Network devices using DPDK-compatible driver 1739 ============================================ 1740 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused= 1741 1742To attach a port created by virtual device, above steps are not needed. 1743 1744For example, to attach a port whose pci address is 0000:0a:00.0. 1745 1746.. code-block:: console 1747 1748 testpmd> port attach 0000:0a:00.0 1749 Attaching a new port... 1750 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 1751 EAL: probe driver: 8086:10fb rte_ixgbe_pmd 1752 EAL: PCI memory mapped at 0x7f83bfa00000 1753 EAL: PCI memory mapped at 0x7f83bfa80000 1754 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5 1755 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb 1756 Port 0 is attached. Now total ports is 1 1757 Done 1758 1759For example, to attach a port created by pcap PMD. 1760 1761.. code-block:: console 1762 1763 testpmd> port attach net_pcap0 1764 Attaching a new port... 1765 PMD: Initializing pmd_pcap for net_pcap0 1766 PMD: Creating pcap-backed ethdev on numa socket 0 1767 Port 0 is attached. Now total ports is 1 1768 Done 1769 1770In this case, identifier is ``net_pcap0``. 1771This identifier format is the same as ``--vdev`` format of DPDK applications. 1772 1773For example, to re-attach a bonded port which has been previously detached, 1774the mode and slave parameters must be given. 1775 1776.. code-block:: console 1777 1778 testpmd> port attach net_bond_0,mode=0,slave=1 1779 Attaching a new port... 1780 EAL: Initializing pmd_bond for net_bond_0 1781 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0. 1782 Port 0 is attached. Now total ports is 1 1783 Done 1784 1785 1786port detach 1787~~~~~~~~~~~ 1788 1789Detach a specific port:: 1790 1791 testpmd> port detach (port_id) 1792 1793Before detaching a port, the port should be stopped and closed. 1794 1795For example, to detach a pci device port 0. 1796 1797.. code-block:: console 1798 1799 testpmd> port stop 0 1800 Stopping ports... 1801 Done 1802 testpmd> port close 0 1803 Closing ports... 1804 Done 1805 1806 testpmd> port detach 0 1807 Detaching a port... 1808 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 1809 EAL: remove driver: 8086:10fb rte_ixgbe_pmd 1810 EAL: PCI memory unmapped at 0x7f83bfa00000 1811 EAL: PCI memory unmapped at 0x7f83bfa80000 1812 Done 1813 1814 1815For example, to detach a virtual device port 0. 1816 1817.. code-block:: console 1818 1819 testpmd> port stop 0 1820 Stopping ports... 1821 Done 1822 testpmd> port close 0 1823 Closing ports... 1824 Done 1825 1826 testpmd> port detach 0 1827 Detaching a port... 1828 PMD: Closing pcap ethdev on numa socket 0 1829 Port 'net_pcap0' is detached. Now total ports is 0 1830 Done 1831 1832To remove a pci device completely from the system, first detach the port from testpmd. 1833Then the device should be moved under kernel management. 1834Finally the device can be removed using kernel pci hotplug functionality. 1835 1836For example, to move a pci device under kernel management: 1837 1838.. code-block:: console 1839 1840 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0 1841 1842 ./usertools/dpdk-devbind.py --status 1843 1844 Network devices using DPDK-compatible driver 1845 ============================================ 1846 <none> 1847 1848 Network devices using kernel driver 1849 =================================== 1850 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio 1851 1852To remove a port created by a virtual device, above steps are not needed. 1853 1854port start 1855~~~~~~~~~~ 1856 1857Start all ports or a specific port:: 1858 1859 testpmd> port start (port_id|all) 1860 1861port stop 1862~~~~~~~~~ 1863 1864Stop all ports or a specific port:: 1865 1866 testpmd> port stop (port_id|all) 1867 1868port close 1869~~~~~~~~~~ 1870 1871Close all ports or a specific port:: 1872 1873 testpmd> port close (port_id|all) 1874 1875port config - queue ring size 1876~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1877 1878Configure a rx/tx queue ring size:: 1879 1880 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value) 1881 1882Only take effect after command that (re-)start the port or command that setup specific queue. 1883 1884port start/stop queue 1885~~~~~~~~~~~~~~~~~~~~~ 1886 1887Start/stop a rx/tx queue on a specific port:: 1888 1889 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop) 1890 1891port config - queue deferred start 1892~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1893 1894Switch on/off deferred start of a specific port queue:: 1895 1896 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off) 1897 1898port setup queue 1899~~~~~~~~~~~~~~~~~~~~~ 1900 1901Setup a rx/tx queue on a specific port:: 1902 1903 testpmd> port (port_id) (rxq|txq) (queue_id) setup 1904 1905Only take effect when port is started. 1906 1907port config - speed 1908~~~~~~~~~~~~~~~~~~~ 1909 1910Set the speed and duplex mode for all ports or a specific port:: 1911 1912 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \ 1913 duplex (half|full|auto) 1914 1915port config - queues/descriptors 1916~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1917 1918Set number of queues/descriptors for rxq, txq, rxd and txd:: 1919 1920 testpmd> port config all (rxq|txq|rxd|txd) (value) 1921 1922This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options. 1923 1924port config - max-pkt-len 1925~~~~~~~~~~~~~~~~~~~~~~~~~ 1926 1927Set the maximum packet length:: 1928 1929 testpmd> port config all max-pkt-len (value) 1930 1931This is equivalent to the ``--max-pkt-len`` command-line option. 1932 1933port config - CRC Strip 1934~~~~~~~~~~~~~~~~~~~~~~~ 1935 1936Set hardware CRC stripping on or off for all ports:: 1937 1938 testpmd> port config all crc-strip (on|off) 1939 1940CRC stripping is on by default. 1941 1942The ``off`` option is equivalent to the ``--disable-crc-strip`` command-line option. 1943 1944port config - scatter 1945~~~~~~~~~~~~~~~~~~~~~~~ 1946 1947Set RX scatter mode on or off for all ports:: 1948 1949 testpmd> port config all scatter (on|off) 1950 1951RX scatter mode is off by default. 1952 1953The ``on`` option is equivalent to the ``--enable-scatter`` command-line option. 1954 1955port config - RX Checksum 1956~~~~~~~~~~~~~~~~~~~~~~~~~ 1957 1958Set hardware RX checksum offload to on or off for all ports:: 1959 1960 testpmd> port config all rx-cksum (on|off) 1961 1962Checksum offload is off by default. 1963 1964The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option. 1965 1966port config - VLAN 1967~~~~~~~~~~~~~~~~~~ 1968 1969Set hardware VLAN on or off for all ports:: 1970 1971 testpmd> port config all hw-vlan (on|off) 1972 1973Hardware VLAN is off by default. 1974 1975The ``on`` option is equivalent to the ``--enable-hw-vlan`` command-line option. 1976 1977port config - VLAN filter 1978~~~~~~~~~~~~~~~~~~~~~~~~~ 1979 1980Set hardware VLAN filter on or off for all ports:: 1981 1982 testpmd> port config all hw-vlan-filter (on|off) 1983 1984Hardware VLAN filter is off by default. 1985 1986The ``on`` option is equivalent to the ``--enable-hw-vlan-filter`` command-line option. 1987 1988port config - VLAN strip 1989~~~~~~~~~~~~~~~~~~~~~~~~ 1990 1991Set hardware VLAN strip on or off for all ports:: 1992 1993 testpmd> port config all hw-vlan-strip (on|off) 1994 1995Hardware VLAN strip is off by default. 1996 1997The ``on`` option is equivalent to the ``--enable-hw-vlan-strip`` command-line option. 1998 1999port config - VLAN extend 2000~~~~~~~~~~~~~~~~~~~~~~~~~ 2001 2002Set hardware VLAN extend on or off for all ports:: 2003 2004 testpmd> port config all hw-vlan-extend (on|off) 2005 2006Hardware VLAN extend is off by default. 2007 2008The ``on`` option is equivalent to the ``--enable-hw-vlan-extend`` command-line option. 2009 2010port config - Drop Packets 2011~~~~~~~~~~~~~~~~~~~~~~~~~~ 2012 2013Set packet drop for packets with no descriptors on or off for all ports:: 2014 2015 testpmd> port config all drop-en (on|off) 2016 2017Packet dropping for packets with no descriptors is off by default. 2018 2019The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option. 2020 2021port config - RSS 2022~~~~~~~~~~~~~~~~~ 2023 2024Set the RSS (Receive Side Scaling) mode on or off:: 2025 2026 testpmd> port config all rss (all|default|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|none) 2027 2028RSS is on by default. 2029 2030The ``all`` option is equivalent to ip|tcp|udp|sctp|ether. 2031The ``default`` option enables all supported RSS types reported by device info. 2032The ``none`` option is equivalent to the ``--disable-rss`` command-line option. 2033 2034port config - RSS Reta 2035~~~~~~~~~~~~~~~~~~~~~~ 2036 2037Set the RSS (Receive Side Scaling) redirection table:: 2038 2039 testpmd> port config all rss reta (hash,queue)[,(hash,queue)] 2040 2041port config - DCB 2042~~~~~~~~~~~~~~~~~ 2043 2044Set the DCB mode for an individual port:: 2045 2046 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off) 2047 2048The traffic class should be 4 or 8. 2049 2050port config - Burst 2051~~~~~~~~~~~~~~~~~~~ 2052 2053Set the number of packets per burst:: 2054 2055 testpmd> port config all burst (value) 2056 2057This is equivalent to the ``--burst`` command-line option. 2058 2059port config - Threshold 2060~~~~~~~~~~~~~~~~~~~~~~~ 2061 2062Set thresholds for TX/RX queues:: 2063 2064 testpmd> port config all (threshold) (value) 2065 2066Where the threshold type can be: 2067 2068* ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255. 2069 2070* ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255. 2071 2072* ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255. 2073 2074* ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255. 2075 2076* ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255. 2077 2078* ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255. 2079 2080* ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd. 2081 2082* ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd. 2083 2084* ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd. 2085 2086These threshold options are also available from the command-line. 2087 2088port config - E-tag 2089~~~~~~~~~~~~~~~~~~~ 2090 2091Set the value of ether-type for E-tag:: 2092 2093 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value) 2094 2095Enable/disable the E-tag support:: 2096 2097 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable) 2098 2099port config pctype mapping 2100~~~~~~~~~~~~~~~~~~~~~~~~~~ 2101 2102Reset pctype mapping table:: 2103 2104 testpmd> port config (port_id) pctype mapping reset 2105 2106Update hardware defined pctype to software defined flow type mapping table:: 2107 2108 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id) 2109 2110where: 2111 2112* ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table. 2113 2114* ``flow_type_id``: software flow type id as the index of the pctype mapping table. 2115 2116port config input set 2117~~~~~~~~~~~~~~~~~~~~~ 2118 2119Config RSS/FDIR/FDIR flexible payload input set for some pctype:: 2120 testpmd> port config (port_id) pctype (pctype_id) \ 2121 (hash_inset|fdir_inset|fdir_flx_inset) \ 2122 (get|set|clear) field (field_idx) 2123 2124Clear RSS/FDIR/FDIR flexible payload input set for some pctype:: 2125 testpmd> port config (port_id) pctype (pctype_id) \ 2126 (hash_inset|fdir_inset|fdir_flx_inset) clear all 2127 2128where: 2129 2130* ``pctype_id``: hardware packet classification types. 2131* ``field_idx``: hardware field index. 2132 2133port config udp_tunnel_port 2134~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2135 2136Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols:: 2137 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve (udp_port) 2138 2139port config tx_metadata 2140~~~~~~~~~~~~~~~~~~~~~~~ 2141 2142Set Tx metadata value per port. 2143testpmd will add this value to any Tx packet sent from this port:: 2144 2145 testpmd> port config (port_id) tx_metadata (value) 2146 2147Link Bonding Functions 2148---------------------- 2149 2150The Link Bonding functions make it possible to dynamically create and 2151manage link bonding devices from within testpmd interactive prompt. 2152 2153create bonded device 2154~~~~~~~~~~~~~~~~~~~~ 2155 2156Create a new bonding device:: 2157 2158 testpmd> create bonded device (mode) (socket) 2159 2160For example, to create a bonded device in mode 1 on socket 0:: 2161 2162 testpmd> create bonded device 1 0 2163 created new bonded device (port X) 2164 2165add bonding slave 2166~~~~~~~~~~~~~~~~~ 2167 2168Adds Ethernet device to a Link Bonding device:: 2169 2170 testpmd> add bonding slave (slave id) (port id) 2171 2172For example, to add Ethernet device (port 6) to a Link Bonding device (port 10):: 2173 2174 testpmd> add bonding slave 6 10 2175 2176 2177remove bonding slave 2178~~~~~~~~~~~~~~~~~~~~ 2179 2180Removes an Ethernet slave device from a Link Bonding device:: 2181 2182 testpmd> remove bonding slave (slave id) (port id) 2183 2184For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10):: 2185 2186 testpmd> remove bonding slave 6 10 2187 2188set bonding mode 2189~~~~~~~~~~~~~~~~ 2190 2191Set the Link Bonding mode of a Link Bonding device:: 2192 2193 testpmd> set bonding mode (value) (port id) 2194 2195For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3):: 2196 2197 testpmd> set bonding mode 3 10 2198 2199set bonding primary 2200~~~~~~~~~~~~~~~~~~~ 2201 2202Set an Ethernet slave device as the primary device on a Link Bonding device:: 2203 2204 testpmd> set bonding primary (slave id) (port id) 2205 2206For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10):: 2207 2208 testpmd> set bonding primary 6 10 2209 2210set bonding mac 2211~~~~~~~~~~~~~~~ 2212 2213Set the MAC address of a Link Bonding device:: 2214 2215 testpmd> set bonding mac (port id) (mac) 2216 2217For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01:: 2218 2219 testpmd> set bonding mac 10 00:00:00:00:00:01 2220 2221set bonding xmit_balance_policy 2222~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2223 2224Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:: 2225 2226 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34) 2227 2228For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports):: 2229 2230 testpmd> set bonding xmit_balance_policy 10 l34 2231 2232 2233set bonding mon_period 2234~~~~~~~~~~~~~~~~~~~~~~ 2235 2236Set the link status monitoring polling period in milliseconds for a bonding device. 2237 2238This adds support for PMD slave devices which do not support link status interrupts. 2239When the mon_period is set to a value greater than 0 then all PMD's which do not support 2240link status ISR will be queried every polling interval to check if their link status has changed:: 2241 2242 testpmd> set bonding mon_period (port_id) (value) 2243 2244For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms:: 2245 2246 testpmd> set bonding mon_period 5 150 2247 2248 2249set bonding lacp dedicated_queue 2250~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2251 2252Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic 2253when in mode 4 (link-aggregration-802.3ad):: 2254 2255 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable) 2256 2257 2258set bonding agg_mode 2259~~~~~~~~~~~~~~~~~~~~ 2260 2261Enable one of the specific aggregators mode when in mode 4 (link-aggregration-802.3ad):: 2262 2263 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable) 2264 2265 2266show bonding config 2267~~~~~~~~~~~~~~~~~~~ 2268 2269Show the current configuration of a Link Bonding device:: 2270 2271 testpmd> show bonding config (port id) 2272 2273For example, 2274to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4) 2275in balance mode with a transmission policy of layer 2+3:: 2276 2277 testpmd> show bonding config 9 2278 Bonding mode: 2 2279 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23 2280 Slaves (3): [1 3 4] 2281 Active Slaves (3): [1 3 4] 2282 Primary: [3] 2283 2284 2285Register Functions 2286------------------ 2287 2288The Register Functions can be used to read from and write to registers on the network card referenced by a port number. 2289This is mainly useful for debugging purposes. 2290Reference should be made to the appropriate datasheet for the network card for details on the register addresses 2291and fields that can be accessed. 2292 2293read reg 2294~~~~~~~~ 2295 2296Display the value of a port register:: 2297 2298 testpmd> read reg (port_id) (address) 2299 2300For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller:: 2301 2302 testpmd> read reg 0 0xEE00 2303 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241) 2304 2305read regfield 2306~~~~~~~~~~~~~ 2307 2308Display a port register bit field:: 2309 2310 testpmd> read regfield (port_id) (address) (bit_x) (bit_y) 2311 2312For example, reading the lowest two bits from the register in the example above:: 2313 2314 testpmd> read regfield 0 0xEE00 0 1 2315 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1) 2316 2317read regbit 2318~~~~~~~~~~~ 2319 2320Display a single port register bit:: 2321 2322 testpmd> read regbit (port_id) (address) (bit_x) 2323 2324For example, reading the lowest bit from the register in the example above:: 2325 2326 testpmd> read regbit 0 0xEE00 0 2327 port 0 PCI register at offset 0xEE00: bit 0=1 2328 2329write reg 2330~~~~~~~~~ 2331 2332Set the value of a port register:: 2333 2334 testpmd> write reg (port_id) (address) (value) 2335 2336For example, to clear a register:: 2337 2338 testpmd> write reg 0 0xEE00 0x0 2339 port 0 PCI register at offset 0xEE00: 0x00000000 (0) 2340 2341write regfield 2342~~~~~~~~~~~~~~ 2343 2344Set bit field of a port register:: 2345 2346 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value) 2347 2348For example, writing to the register cleared in the example above:: 2349 2350 testpmd> write regfield 0 0xEE00 0 1 2 2351 port 0 PCI register at offset 0xEE00: 0x00000002 (2) 2352 2353write regbit 2354~~~~~~~~~~~~ 2355 2356Set single bit value of a port register:: 2357 2358 testpmd> write regbit (port_id) (address) (bit_x) (value) 2359 2360For example, to set the high bit in the register from the example above:: 2361 2362 testpmd> write regbit 0 0xEE00 31 1 2363 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658) 2364 2365Traffic Metering and Policing 2366----------------------------- 2367 2368The following section shows functions for configuring traffic metering and 2369policing on the ethernet device through the use of generic ethdev API. 2370 2371show port traffic management capability 2372~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2373 2374Show traffic metering and policing capability of the port:: 2375 2376 testpmd> show port meter cap (port_id) 2377 2378add port meter profile (srTCM rfc2967) 2379~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2380 2381Add meter profile (srTCM rfc2697) to the ethernet device:: 2382 2383 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \ 2384 (cir) (cbs) (ebs) 2385 2386where: 2387 2388* ``profile_id``: ID for the meter profile. 2389* ``cir``: Committed Information Rate (CIR) (bytes/second). 2390* ``cbs``: Committed Burst Size (CBS) (bytes). 2391* ``ebs``: Excess Burst Size (EBS) (bytes). 2392 2393add port meter profile (trTCM rfc2968) 2394~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2395 2396Add meter profile (srTCM rfc2698) to the ethernet device:: 2397 2398 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \ 2399 (cir) (pir) (cbs) (pbs) 2400 2401where: 2402 2403* ``profile_id``: ID for the meter profile. 2404* ``cir``: Committed information rate (bytes/second). 2405* ``pir``: Peak information rate (bytes/second). 2406* ``cbs``: Committed burst size (bytes). 2407* ``pbs``: Peak burst size (bytes). 2408 2409add port meter profile (trTCM rfc4115) 2410~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2411 2412Add meter profile (trTCM rfc4115) to the ethernet device:: 2413 2414 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \ 2415 (cir) (eir) (cbs) (ebs) 2416 2417where: 2418 2419* ``profile_id``: ID for the meter profile. 2420* ``cir``: Committed information rate (bytes/second). 2421* ``eir``: Excess information rate (bytes/second). 2422* ``cbs``: Committed burst size (bytes). 2423* ``ebs``: Excess burst size (bytes). 2424 2425delete port meter profile 2426~~~~~~~~~~~~~~~~~~~~~~~~~ 2427 2428Delete meter profile from the ethernet device:: 2429 2430 testpmd> del port meter profile (port_id) (profile_id) 2431 2432create port meter 2433~~~~~~~~~~~~~~~~~ 2434 2435Create new meter object for the ethernet device:: 2436 2437 testpmd> create port meter (port_id) (mtr_id) (profile_id) \ 2438 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \ 2439 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\ 2440 (dscp_tbl_entry63)] 2441 2442where: 2443 2444* ``mtr_id``: meter object ID. 2445* ``profile_id``: ID for the meter profile. 2446* ``meter_enable``: When this parameter has a non-zero value, the meter object 2447 gets enabled at the time of creation, otherwise remains disabled. 2448* ``g_action``: Policer action for the packet with green color. 2449* ``y_action``: Policer action for the packet with yellow color. 2450* ``r_action``: Policer action for the packet with red color. 2451* ``stats_mask``: Mask of statistics counter types to be enabled for the 2452 meter object. 2453* ``shared``: When this parameter has a non-zero value, the meter object is 2454 shared by multiple flows. Otherwise, meter object is used by single flow. 2455* ``use_pre_meter_color``: When this parameter has a non-zero value, the 2456 input color for the current meter object is determined by the latest meter 2457 object in the same flow. Otherwise, the current meter object uses the 2458 *dscp_table* to determine the input color. 2459* ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input 2460 color, 0 <= x <= 63. 2461 2462enable port meter 2463~~~~~~~~~~~~~~~~~ 2464 2465Enable meter for the ethernet device:: 2466 2467 testpmd> enable port meter (port_id) (mtr_id) 2468 2469disable port meter 2470~~~~~~~~~~~~~~~~~~ 2471 2472Disable meter for the ethernet device:: 2473 2474 testpmd> disable port meter (port_id) (mtr_id) 2475 2476delete port meter 2477~~~~~~~~~~~~~~~~~ 2478 2479Delete meter for the ethernet device:: 2480 2481 testpmd> del port meter (port_id) (mtr_id) 2482 2483Set port meter profile 2484~~~~~~~~~~~~~~~~~~~~~~ 2485 2486Set meter profile for the ethernet device:: 2487 2488 testpmd> set port meter profile (port_id) (mtr_id) (profile_id) 2489 2490set port meter dscp table 2491~~~~~~~~~~~~~~~~~~~~~~~~~ 2492 2493Set meter dscp table for the ethernet device:: 2494 2495 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \ 2496 (dscp_tbl_entry1)...(dscp_tbl_entry63)] 2497 2498set port meter policer action 2499~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2500 2501Set meter policer action for the ethernet device:: 2502 2503 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \ 2504 (action0) [(action1) (action1)] 2505 2506where: 2507 2508* ``action_mask``: Bit mask indicating which policer actions need to be 2509 updated. One or more policer actions can be updated in a single function 2510 invocation. To update the policer action associated with color C, bit 2511 (1 << C) needs to be set in *action_mask* and element at position C 2512 in the *actions* array needs to be valid. 2513* ``actionx``: Policer action for the color x, 2514 RTE_MTR_GREEN <= x < RTE_MTR_COLORS 2515 2516set port meter stats mask 2517~~~~~~~~~~~~~~~~~~~~~~~~~ 2518 2519Set meter stats mask for the ethernet device:: 2520 2521 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask) 2522 2523where: 2524 2525* ``stats_mask``: Bit mask indicating statistics counter types to be enabled. 2526 2527show port meter stats 2528~~~~~~~~~~~~~~~~~~~~~ 2529 2530Show meter stats of the ethernet device:: 2531 2532 testpmd> show port meter stats (port_id) (mtr_id) (clear) 2533 2534where: 2535 2536* ``clear``: Flag that indicates whether the statistics counters should 2537 be cleared (i.e. set to zero) immediately after they have been read or not. 2538 2539Traffic Management 2540------------------ 2541 2542The following section shows functions for configuring traffic management on 2543on the ethernet device through the use of generic TM API. 2544 2545show port traffic management capability 2546~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2547 2548Show traffic management capability of the port:: 2549 2550 testpmd> show port tm cap (port_id) 2551 2552show port traffic management capability (hierarchy level) 2553~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2554 2555Show traffic management hierarchy level capability of the port:: 2556 2557 testpmd> show port tm level cap (port_id) (level_id) 2558 2559show port traffic management capability (hierarchy node level) 2560~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2561 2562Show the traffic management hierarchy node capability of the port:: 2563 2564 testpmd> show port tm node cap (port_id) (node_id) 2565 2566show port traffic management hierarchy node type 2567~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2568 2569Show the port traffic management hierarchy node type:: 2570 2571 testpmd> show port tm node type (port_id) (node_id) 2572 2573show port traffic management hierarchy node stats 2574~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2575 2576Show the port traffic management hierarchy node statistics:: 2577 2578 testpmd> show port tm node stats (port_id) (node_id) (clear) 2579 2580where: 2581 2582* ``clear``: When this parameter has a non-zero value, the statistics counters 2583 are cleared (i.e. set to zero) immediately after they have been read, 2584 otherwise the statistics counters are left untouched. 2585 2586Add port traffic management private shaper profile 2587~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2588 2589Add the port traffic management private shaper profile:: 2590 2591 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \ 2592 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \ 2593 (packet_length_adjust) 2594 2595where: 2596 2597* ``shaper_profile id``: Shaper profile ID for the new profile. 2598* ``cmit_tb_rate``: Committed token bucket rate (bytes per second). 2599* ``cmit_tb_size``: Committed token bucket size (bytes). 2600* ``peak_tb_rate``: Peak token bucket rate (bytes per second). 2601* ``peak_tb_size``: Peak token bucket size (bytes). 2602* ``packet_length_adjust``: The value (bytes) to be added to the length of 2603 each packet for the purpose of shaping. This parameter value can be used to 2604 correct the packet length with the framing overhead bytes that are consumed 2605 on the wire. 2606 2607Delete port traffic management private shaper profile 2608~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2609 2610Delete the port traffic management private shaper:: 2611 2612 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id) 2613 2614where: 2615 2616* ``shaper_profile id``: Shaper profile ID that needs to be deleted. 2617 2618Add port traffic management shared shaper 2619~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2620 2621Create the port traffic management shared shaper:: 2622 2623 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \ 2624 (shaper_profile_id) 2625 2626where: 2627 2628* ``shared_shaper_id``: Shared shaper ID to be created. 2629* ``shaper_profile id``: Shaper profile ID for shared shaper. 2630 2631Set port traffic management shared shaper 2632~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2633 2634Update the port traffic management shared shaper:: 2635 2636 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \ 2637 (shaper_profile_id) 2638 2639where: 2640 2641* ``shared_shaper_id``: Shared shaper ID to be update. 2642* ``shaper_profile id``: Shaper profile ID for shared shaper. 2643 2644Delete port traffic management shared shaper 2645~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2646 2647Delete the port traffic management shared shaper:: 2648 2649 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id) 2650 2651where: 2652 2653* ``shared_shaper_id``: Shared shaper ID to be deleted. 2654 2655Set port traffic management hiearchy node private shaper 2656~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2657 2658set the port traffic management hierarchy node private shaper:: 2659 2660 testpmd> set port tm node shaper profile (port_id) (node_id) \ 2661 (shaper_profile_id) 2662 2663where: 2664 2665* ``shaper_profile id``: Private shaper profile ID to be enabled on the 2666 hierarchy node. 2667 2668Add port traffic management WRED profile 2669~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2670 2671Create a new WRED profile:: 2672 2673 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \ 2674 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \ 2675 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \ 2676 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r) 2677 2678where: 2679 2680* ``wred_profile id``: Identifier for the newly create WRED profile 2681* ``color_g``: Packet color (green) 2682* ``min_th_g``: Minimum queue threshold for packet with green color 2683* ``max_th_g``: Minimum queue threshold for packet with green color 2684* ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp) 2685* ``wq_log2_g``: Negated log2 of queue weight (wq) 2686* ``color_y``: Packet color (yellow) 2687* ``min_th_y``: Minimum queue threshold for packet with yellow color 2688* ``max_th_y``: Minimum queue threshold for packet with yellow color 2689* ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp) 2690* ``wq_log2_y``: Negated log2 of queue weight (wq) 2691* ``color_r``: Packet color (red) 2692* ``min_th_r``: Minimum queue threshold for packet with yellow color 2693* ``max_th_r``: Minimum queue threshold for packet with yellow color 2694* ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp) 2695* ``wq_log2_r``: Negated log2 of queue weight (wq) 2696 2697Delete port traffic management WRED profile 2698~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2699 2700Delete the WRED profile:: 2701 2702 testpmd> del port tm node wred profile (port_id) (wred_profile_id) 2703 2704Add port traffic management hierarchy nonleaf node 2705~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2706 2707Add nonleaf node to port traffic management hiearchy:: 2708 2709 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \ 2710 (priority) (weight) (level_id) (shaper_profile_id) \ 2711 (n_sp_priorities) (stats_mask) (n_shared_shapers) \ 2712 [(shared_shaper_0) (shared_shaper_1) ...] \ 2713 2714where: 2715 2716* ``parent_node_id``: Node ID of the parent. 2717* ``priority``: Node priority (highest node priority is zero). This is used by 2718 the SP algorithm running on the parent node for scheduling this node. 2719* ``weight``: Node weight (lowest weight is one). The node weight is relative 2720 to the weight sum of all siblings that have the same priority. It is used by 2721 the WFQ algorithm running on the parent node for scheduling this node. 2722* ``level_id``: Hiearchy level of the node. 2723* ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by 2724 the node. 2725* ``n_sp_priorities``: Number of strict priorities. 2726* ``stats_mask``: Mask of statistics counter types to be enabled for this node. 2727* ``n_shared_shapers``: Number of shared shapers. 2728* ``shared_shaper_id``: Shared shaper id. 2729 2730Add port traffic management hierarchy leaf node 2731~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2732 2733Add leaf node to port traffic management hiearchy:: 2734 2735 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \ 2736 (priority) (weight) (level_id) (shaper_profile_id) \ 2737 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \ 2738 [(shared_shaper_id) (shared_shaper_id) ...] \ 2739 2740where: 2741 2742* ``parent_node_id``: Node ID of the parent. 2743* ``priority``: Node priority (highest node priority is zero). This is used by 2744 the SP algorithm running on the parent node for scheduling this node. 2745* ``weight``: Node weight (lowest weight is one). The node weight is relative 2746 to the weight sum of all siblings that have the same priority. It is used by 2747 the WFQ algorithm running on the parent node for scheduling this node. 2748* ``level_id``: Hiearchy level of the node. 2749* ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by 2750 the node. 2751* ``cman_mode``: Congestion management mode to be enabled for this node. 2752* ``wred_profile_id``: WRED profile id to be enabled for this node. 2753* ``stats_mask``: Mask of statistics counter types to be enabled for this node. 2754* ``n_shared_shapers``: Number of shared shapers. 2755* ``shared_shaper_id``: Shared shaper id. 2756 2757Delete port traffic management hierarchy node 2758~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2759 2760Delete node from port traffic management hiearchy:: 2761 2762 testpmd> del port tm node (port_id) (node_id) 2763 2764Update port traffic management hierarchy parent node 2765~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2766 2767Update port traffic management hierarchy parent node:: 2768 2769 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \ 2770 (priority) (weight) 2771 2772This function can only be called after the hierarchy commit invocation. Its 2773success depends on the port support for this operation, as advertised through 2774the port capability set. This function is valid for all nodes of the traffic 2775management hierarchy except root node. 2776 2777Suspend port traffic management hierarchy node 2778~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2779 2780 testpmd> suspend port tm node (port_id) (node_id) 2781 2782Resume port traffic management hierarchy node 2783~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2784 2785 testpmd> resume port tm node (port_id) (node_id) 2786 2787Commit port traffic management hierarchy 2788~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2789 2790Commit the traffic management hierarchy on the port:: 2791 2792 testpmd> port tm hierarchy commit (port_id) (clean_on_fail) 2793 2794where: 2795 2796* ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function 2797 call failure. On the other hand, hierarchy is preserved when this parameter 2798 is equal to zero. 2799 2800Set port traffic management mark VLAN dei 2801~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2802 2803Enables/Disables the traffic management marking on the port for VLAN packets:: 2804 2805 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red> 2806 2807where: 2808 2809* ``port_id``: The port which on which VLAN packets marked as ``green`` or 2810 ``yellow`` or ``red`` will have dei bit enabled 2811 2812* ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green 2813 2814* ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow 2815 2816* ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red 2817 2818Set port traffic management mark IP dscp 2819~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2820 2821Enables/Disables the traffic management marking on the port for IP dscp packets:: 2822 2823 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red> 2824 2825where: 2826 2827* ``port_id``: The port which on which IP packets marked as ``green`` or 2828 ``yellow`` or ``red`` will have IP dscp bits updated 2829 2830* ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets 2831 2832* ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets 2833 2834* ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets 2835 2836Set port traffic management mark IP ecn 2837~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2838 2839Enables/Disables the traffic management marking on the port for IP ecn packets:: 2840 2841 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red> 2842 2843where: 2844 2845* ``port_id``: The port which on which IP packets marked as ``green`` or 2846 ``yellow`` or ``red`` will have IP ecn bits updated 2847 2848* ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10 2849 to ecn of 2'b11 when IP is caring TCP or SCTP 2850 2851* ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10 2852 to ecn of 2'b11 when IP is caring TCP or SCTP 2853 2854* ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10 2855 to ecn of 2'b11 when IP is caring TCP or SCTP 2856 2857Set port traffic management default hierarchy (softnic forwarding mode) 2858~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2859 2860set the traffic management default hierarchy on the port:: 2861 2862 testpmd> set port tm hierarchy default (port_id) 2863 2864Filter Functions 2865---------------- 2866 2867This section details the available filter functions that are available. 2868 2869Note these functions interface the deprecated legacy filtering framework, 2870superseded by *rte_flow*. See `Flow rules management`_. 2871 2872ethertype_filter 2873~~~~~~~~~~~~~~~~~~~~ 2874 2875Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue:: 2876 2877 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \ 2878 ethertype (ether_type) (drop|fwd) queue (queue_id) 2879 2880The available information parameters are: 2881 2882* ``port_id``: The port which the Ethertype filter assigned on. 2883 2884* ``mac_addr``: Compare destination mac address. 2885 2886* ``mac_ignr``: Ignore destination mac address match. 2887 2888* ``mac_address``: Destination mac address to match. 2889 2890* ``ether_type``: The EtherType value want to match, 2891 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid. 2892 2893* ``queue_id``: The receive queue associated with this EtherType filter. 2894 It is meaningless when deleting or dropping. 2895 2896Example, to add/remove an ethertype filter rule:: 2897 2898 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \ 2899 ethertype 0x0806 fwd queue 3 2900 2901 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \ 2902 ethertype 0x0806 fwd queue 3 2903 29042tuple_filter 2905~~~~~~~~~~~~~~~~~ 2906 2907Add or delete a 2-tuple filter, 2908which identifies packets by specific protocol and destination TCP/UDP port 2909and forwards packets into one of the receive queues:: 2910 2911 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \ 2912 protocol (protocol_value) mask (mask_value) \ 2913 tcp_flags (tcp_flags_value) priority (prio_value) \ 2914 queue (queue_id) 2915 2916The available information parameters are: 2917 2918* ``port_id``: The port which the 2-tuple filter assigned on. 2919 2920* ``dst_port_value``: Destination port in L4. 2921 2922* ``protocol_value``: IP L4 protocol. 2923 2924* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate. 2925 2926* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP). 2927 2928* ``prio_value``: Priority of this filter. 2929 2930* ``queue_id``: The receive queue associated with this 2-tuple filter. 2931 2932Example, to add/remove an 2tuple filter rule:: 2933 2934 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \ 2935 tcp_flags 0x02 priority 3 queue 3 2936 2937 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \ 2938 tcp_flags 0x02 priority 3 queue 3 2939 29405tuple_filter 2941~~~~~~~~~~~~~~~~~ 2942 2943Add or delete a 5-tuple filter, 2944which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port) 2945and routes packets into one of the receive queues:: 2946 2947 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \ 2948 (src_address) dst_port (dst_port_value) \ 2949 src_port (src_port_value) protocol (protocol_value) \ 2950 mask (mask_value) tcp_flags (tcp_flags_value) \ 2951 priority (prio_value) queue (queue_id) 2952 2953The available information parameters are: 2954 2955* ``port_id``: The port which the 5-tuple filter assigned on. 2956 2957* ``dst_address``: Destination IP address. 2958 2959* ``src_address``: Source IP address. 2960 2961* ``dst_port_value``: TCP/UDP destination port. 2962 2963* ``src_port_value``: TCP/UDP source port. 2964 2965* ``protocol_value``: L4 protocol. 2966 2967* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate 2968 2969* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP). 2970 2971* ``prio_value``: The priority of this filter. 2972 2973* ``queue_id``: The receive queue associated with this 5-tuple filter. 2974 2975Example, to add/remove an 5tuple filter rule:: 2976 2977 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \ 2978 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \ 2979 flags 0x0 priority 3 queue 3 2980 2981 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \ 2982 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \ 2983 flags 0x0 priority 3 queue 3 2984 2985syn_filter 2986~~~~~~~~~~ 2987 2988Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue:: 2989 2990 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id) 2991 2992The available information parameters are: 2993 2994* ``port_id``: The port which the SYN filter assigned on. 2995 2996* ``high``: This SYN filter has higher priority than other filters. 2997 2998* ``low``: This SYN filter has lower priority than other filters. 2999 3000* ``queue_id``: The receive queue associated with this SYN filter 3001 3002Example:: 3003 3004 testpmd> syn_filter 0 add priority high queue 3 3005 3006flex_filter 3007~~~~~~~~~~~ 3008 3009With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet 3010and routed into one of the receive queues:: 3011 3012 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \ 3013 mask (mask_value) priority (prio_value) queue (queue_id) 3014 3015The available information parameters are: 3016 3017* ``port_id``: The port which the Flex filter is assigned on. 3018 3019* ``len_value``: Filter length in bytes, no greater than 128. 3020 3021* ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match. 3022 3023* ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match. 3024 3025* ``prio_value``: The priority of this filter. 3026 3027* ``queue_id``: The receive queue associated with this Flex filter. 3028 3029Example:: 3030 3031 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \ 3032 mask 000C priority 3 queue 3 3033 3034 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \ 3035 mask 000C priority 3 queue 3 3036 3037 3038.. _testpmd_flow_director: 3039 3040flow_director_filter 3041~~~~~~~~~~~~~~~~~~~~ 3042 3043The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues. 3044 3045Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and 3046Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter: 3047 3048* Perfect 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 IP flow. 3051 3052* Signature filters. 3053 The hardware checks a match between a hash-based signature of the masked fields of the received packet. 3054 3055* Perfect-mac-vlan match filters. 3056 The hardware checks a match between the masked fields of the received packets and the programmed filters. 3057 The masked fields are for MAC VLAN flow. 3058 3059* Perfect-tunnel match filters. 3060 The hardware checks a match between the masked fields of the received packets and the programmed filters. 3061 The masked fields are for tunnel flow. 3062 3063* Perfect-raw-flow-type match filters. 3064 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet. 3065 The masked fields are specified by input sets. 3066 3067The Flow Director filters can match the different fields for different type of packet: flow type, specific input set 3068per flow type and the flexible payload. 3069 3070The Flow Director can also mask out parts of all of these fields so that filters 3071are only applied to certain fields or parts of the fields. 3072 3073Note that for raw flow type mode the source and destination fields in the 3074raw packet buffer need to be presented in a reversed order with respect 3075to the expected received packets. 3076For example: IP source and destination addresses or TCP/UDP/SCTP 3077source and destination ports 3078 3079Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information. 3080 3081# Commands to add flow director filters of different flow types:: 3082 3083 flow_director_filter (port_id) mode IP (add|del|update) \ 3084 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \ 3085 src (src_ip_address) dst (dst_ip_address) \ 3086 tos (tos_value) proto (proto_value) ttl (ttl_value) \ 3087 vlan (vlan_value) flexbytes (flexbytes_value) \ 3088 (drop|fwd) pf|vf(vf_id) queue (queue_id) \ 3089 fd_id (fd_id_value) 3090 3091 flow_director_filter (port_id) mode IP (add|del|update) \ 3092 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \ 3093 src (src_ip_address) (src_port) \ 3094 dst (dst_ip_address) (dst_port) \ 3095 tos (tos_value) ttl (ttl_value) \ 3096 vlan (vlan_value) flexbytes (flexbytes_value) \ 3097 (drop|fwd) queue pf|vf(vf_id) (queue_id) \ 3098 fd_id (fd_id_value) 3099 3100 flow_director_filter (port_id) mode IP (add|del|update) \ 3101 flow (ipv4-sctp|ipv6-sctp) \ 3102 src (src_ip_address) (src_port) \ 3103 dst (dst_ip_address) (dst_port) \ 3104 tos (tos_value) ttl (ttl_value) \ 3105 tag (verification_tag) vlan (vlan_value) \ 3106 flexbytes (flexbytes_value) (drop|fwd) \ 3107 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value) 3108 3109 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \ 3110 ether (ethertype) flexbytes (flexbytes_value) \ 3111 (drop|fwd) pf|vf(vf_id) queue (queue_id) 3112 fd_id (fd_id_value) 3113 3114 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \ 3115 mac (mac_address) vlan (vlan_value) \ 3116 flexbytes (flexbytes_value) (drop|fwd) \ 3117 queue (queue_id) fd_id (fd_id_value) 3118 3119 flow_director_filter (port_id) mode Tunnel (add|del|update) \ 3120 mac (mac_address) vlan (vlan_value) \ 3121 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \ 3122 flexbytes (flexbytes_value) (drop|fwd) \ 3123 queue (queue_id) fd_id (fd_id_value) 3124 3125 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \ 3126 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \ 3127 packet (packet file name) 3128 3129For example, to add an ipv4-udp flow type filter:: 3130 3131 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \ 3132 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \ 3133 fwd pf queue 1 fd_id 1 3134 3135For example, add an ipv4-other flow type filter:: 3136 3137 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \ 3138 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \ 3139 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1 3140 3141flush_flow_director 3142~~~~~~~~~~~~~~~~~~~ 3143 3144Flush all flow director filters on a device:: 3145 3146 testpmd> flush_flow_director (port_id) 3147 3148Example, to flush all flow director filter on port 0:: 3149 3150 testpmd> flush_flow_director 0 3151 3152flow_director_mask 3153~~~~~~~~~~~~~~~~~~ 3154 3155Set flow director's input masks:: 3156 3157 flow_director_mask (port_id) mode IP vlan (vlan_value) \ 3158 src_mask (ipv4_src) (ipv6_src) (src_port) \ 3159 dst_mask (ipv4_dst) (ipv6_dst) (dst_port) 3160 3161 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) 3162 3163 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \ 3164 mac (mac_value) tunnel-type (tunnel_type_value) \ 3165 tunnel-id (tunnel_id_value) 3166 3167Example, to set flow director mask on port 0:: 3168 3169 testpmd> flow_director_mask 0 mode IP vlan 0xefff \ 3170 src_mask 255.255.255.255 \ 3171 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \ 3172 dst_mask 255.255.255.255 \ 3173 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF 3174 3175flow_director_flex_mask 3176~~~~~~~~~~~~~~~~~~~~~~~ 3177 3178set masks of flow director's flexible payload based on certain flow type:: 3179 3180 testpmd> flow_director_flex_mask (port_id) \ 3181 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 3182 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \ 3183 l2_payload|all) (mask) 3184 3185Example, to set flow director's flex mask for all flow type on port 0:: 3186 3187 testpmd> flow_director_flex_mask 0 flow all \ 3188 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0) 3189 3190 3191flow_director_flex_payload 3192~~~~~~~~~~~~~~~~~~~~~~~~~~ 3193 3194Configure flexible payload selection:: 3195 3196 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config) 3197 3198For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload:: 3199 3200 testpmd> flow_director_flex_payload 0 l4 \ 3201 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19) 3202 3203get_sym_hash_ena_per_port 3204~~~~~~~~~~~~~~~~~~~~~~~~~ 3205 3206Get symmetric hash enable configuration per port:: 3207 3208 get_sym_hash_ena_per_port (port_id) 3209 3210For example, to get symmetric hash enable configuration of port 1:: 3211 3212 testpmd> get_sym_hash_ena_per_port 1 3213 3214set_sym_hash_ena_per_port 3215~~~~~~~~~~~~~~~~~~~~~~~~~ 3216 3217Set symmetric hash enable configuration per port to enable or disable:: 3218 3219 set_sym_hash_ena_per_port (port_id) (enable|disable) 3220 3221For example, to set symmetric hash enable configuration of port 1 to enable:: 3222 3223 testpmd> set_sym_hash_ena_per_port 1 enable 3224 3225get_hash_global_config 3226~~~~~~~~~~~~~~~~~~~~~~ 3227 3228Get the global configurations of hash filters:: 3229 3230 get_hash_global_config (port_id) 3231 3232For example, to get the global configurations of hash filters of port 1:: 3233 3234 testpmd> get_hash_global_config 1 3235 3236set_hash_global_config 3237~~~~~~~~~~~~~~~~~~~~~~ 3238 3239Set the global configurations of hash filters:: 3240 3241 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \ 3242 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \ 3243 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \ 3244 (enable|disable) 3245 3246For example, to enable simple_xor for flow type of ipv6 on port 2:: 3247 3248 testpmd> set_hash_global_config 2 simple_xor ipv6 enable 3249 3250set_hash_input_set 3251~~~~~~~~~~~~~~~~~~ 3252 3253Set the input set for hash:: 3254 3255 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 3256 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \ 3257 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \ 3258 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \ 3259 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \ 3260 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \ 3261 fld-8th|none) (select|add) 3262 3263For example, to add source IP to hash input set for flow type of ipv4-udp on port 0:: 3264 3265 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add 3266 3267set_fdir_input_set 3268~~~~~~~~~~~~~~~~~~ 3269 3270The Flow Director filters can match the different fields for different type of packet, i.e. specific input set 3271on per flow type and the flexible payload. This command can be used to change input set for each flow type. 3272 3273Set the input set for flow director:: 3274 3275 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 3276 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \ 3277 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \ 3278 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \ 3279 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \ 3280 sctp-dst-port|sctp-veri-tag|none) (select|add) 3281 3282For example to add source IP to FD input set for flow type of ipv4-udp on port 0:: 3283 3284 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add 3285 3286global_config 3287~~~~~~~~~~~~~ 3288 3289Set different GRE key length for input set:: 3290 3291 global_config (port_id) gre-key-len (number in bytes) 3292 3293For example to set GRE key length for input set to 4 bytes on port 0:: 3294 3295 testpmd> global_config 0 gre-key-len 4 3296 3297 3298.. _testpmd_rte_flow: 3299 3300Flow rules management 3301--------------------- 3302 3303Control of the generic flow API (*rte_flow*) is fully exposed through the 3304``flow`` command (validation, creation, destruction, queries and operation 3305modes). 3306 3307Considering *rte_flow* overlaps with all `Filter Functions`_, using both 3308features simultaneously may cause undefined side-effects and is therefore 3309not recommended. 3310 3311``flow`` syntax 3312~~~~~~~~~~~~~~~ 3313 3314Because the ``flow`` command uses dynamic tokens to handle the large number 3315of possible flow rules combinations, its behavior differs slightly from 3316other commands, in particular: 3317 3318- Pressing *?* or the *<tab>* key displays contextual help for the current 3319 token, not that of the entire command. 3320 3321- Optional and repeated parameters are supported (provided they are listed 3322 in the contextual help). 3323 3324The first parameter stands for the operation mode. Possible operations and 3325their general syntax are described below. They are covered in detail in the 3326following sections. 3327 3328- Check whether a flow rule can be created:: 3329 3330 flow validate {port_id} 3331 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3332 pattern {item} [/ {item} [...]] / end 3333 actions {action} [/ {action} [...]] / end 3334 3335- Create a flow rule:: 3336 3337 flow create {port_id} 3338 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3339 pattern {item} [/ {item} [...]] / end 3340 actions {action} [/ {action} [...]] / end 3341 3342- Destroy specific flow rules:: 3343 3344 flow destroy {port_id} rule {rule_id} [...] 3345 3346- Destroy all flow rules:: 3347 3348 flow flush {port_id} 3349 3350- Query an existing flow rule:: 3351 3352 flow query {port_id} {rule_id} {action} 3353 3354- List existing flow rules sorted by priority, filtered by group 3355 identifiers:: 3356 3357 flow list {port_id} [group {group_id}] [...] 3358 3359- Restrict ingress traffic to the defined flow rules:: 3360 3361 flow isolate {port_id} {boolean} 3362 3363Validating flow rules 3364~~~~~~~~~~~~~~~~~~~~~ 3365 3366``flow validate`` reports whether a flow rule would be accepted by the 3367underlying device in its current state but stops short of creating it. It is 3368bound to ``rte_flow_validate()``:: 3369 3370 flow validate {port_id} 3371 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3372 pattern {item} [/ {item} [...]] / end 3373 actions {action} [/ {action} [...]] / end 3374 3375If successful, it will show:: 3376 3377 Flow rule validated 3378 3379Otherwise it will show an error message of the form:: 3380 3381 Caught error type [...] ([...]): [...] 3382 3383This command uses the same parameters as ``flow create``, their format is 3384described in `Creating flow rules`_. 3385 3386Check whether redirecting any Ethernet packet received on port 0 to RX queue 3387index 6 is supported:: 3388 3389 testpmd> flow validate 0 ingress pattern eth / end 3390 actions queue index 6 / end 3391 Flow rule validated 3392 testpmd> 3393 3394Port 0 does not support TCPv6 rules:: 3395 3396 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end 3397 actions drop / end 3398 Caught error type 9 (specific pattern item): Invalid argument 3399 testpmd> 3400 3401Creating flow rules 3402~~~~~~~~~~~~~~~~~~~ 3403 3404``flow create`` validates and creates the specified flow rule. It is bound 3405to ``rte_flow_create()``:: 3406 3407 flow create {port_id} 3408 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3409 pattern {item} [/ {item} [...]] / end 3410 actions {action} [/ {action} [...]] / end 3411 3412If successful, it will return a flow rule ID usable with other commands:: 3413 3414 Flow rule #[...] created 3415 3416Otherwise it will show an error message of the form:: 3417 3418 Caught error type [...] ([...]): [...] 3419 3420Parameters describe in the following order: 3421 3422- Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens). 3423- A matching pattern, starting with the *pattern* token and terminated by an 3424 *end* pattern item. 3425- Actions, starting with the *actions* token and terminated by an *end* 3426 action. 3427 3428These translate directly to *rte_flow* objects provided as-is to the 3429underlying functions. 3430 3431The shortest valid definition only comprises mandatory tokens:: 3432 3433 testpmd> flow create 0 pattern end actions end 3434 3435Note that PMDs may refuse rules that essentially do nothing such as this 3436one. 3437 3438**All unspecified object values are automatically initialized to 0.** 3439 3440Attributes 3441^^^^^^^^^^ 3442 3443These tokens affect flow rule attributes (``struct rte_flow_attr``) and are 3444specified before the ``pattern`` token. 3445 3446- ``group {group id}``: priority group. 3447- ``priority {level}``: priority level within group. 3448- ``ingress``: rule applies to ingress traffic. 3449- ``egress``: rule applies to egress traffic. 3450- ``transfer``: apply rule directly to endpoints found in pattern. 3451 3452Each instance of an attribute specified several times overrides the previous 3453value as shown below (group 4 is used):: 3454 3455 testpmd> flow create 0 group 42 group 24 group 4 [...] 3456 3457Note that once enabled, ``ingress`` and ``egress`` cannot be disabled. 3458 3459While not specifying a direction is an error, some rules may allow both 3460simultaneously. 3461 3462Most rules affect RX therefore contain the ``ingress`` token:: 3463 3464 testpmd> flow create 0 ingress pattern [...] 3465 3466Matching pattern 3467^^^^^^^^^^^^^^^^ 3468 3469A matching pattern starts after the ``pattern`` token. It is made of pattern 3470items and is terminated by a mandatory ``end`` item. 3471 3472Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum 3473rte_flow_item_type``). 3474 3475The ``/`` token is used as a separator between pattern items as shown 3476below:: 3477 3478 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...] 3479 3480Note that protocol items like these must be stacked from lowest to highest 3481layer to make sense. For instance, the following rule is either invalid or 3482unlikely to match any packet:: 3483 3484 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...] 3485 3486More information on these restrictions can be found in the *rte_flow* 3487documentation. 3488 3489Several items support additional specification structures, for example 3490``ipv4`` allows specifying source and destination addresses as follows:: 3491 3492 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1 3493 dst is 10.2.0.0 / end [...] 3494 3495This rule matches all IPv4 traffic with the specified properties. 3496 3497In this example, ``src`` and ``dst`` are field names of the underlying 3498``struct rte_flow_item_ipv4`` object. All item properties can be specified 3499in a similar fashion. 3500 3501The ``is`` token means that the subsequent value must be matched exactly, 3502and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item`` 3503accordingly. Possible assignment tokens are: 3504 3505- ``is``: match value perfectly (with full bit-mask). 3506- ``spec``: match value according to configured bit-mask. 3507- ``last``: specify upper bound to establish a range. 3508- ``mask``: specify bit-mask with relevant bits set to one. 3509- ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one. 3510 3511These yield identical results:: 3512 3513 ipv4 src is 10.1.1.1 3514 3515:: 3516 3517 ipv4 src spec 10.1.1.1 src mask 255.255.255.255 3518 3519:: 3520 3521 ipv4 src spec 10.1.1.1 src prefix 32 3522 3523:: 3524 3525 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value 3526 3527:: 3528 3529 ipv4 src is 10.1.1.1 src last 0 # 0 disables range 3530 3531Inclusive ranges can be defined with ``last``:: 3532 3533 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4 3534 3535Note that ``mask`` affects both ``spec`` and ``last``:: 3536 3537 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0 3538 # matches 10.1.0.0 to 10.2.255.255 3539 3540Properties can be modified multiple times:: 3541 3542 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4 3543 3544:: 3545 3546 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16 3547 3548Pattern items 3549^^^^^^^^^^^^^ 3550 3551This section lists supported pattern items and their attributes, if any. 3552 3553- ``end``: end list of pattern items. 3554 3555- ``void``: no-op pattern item. 3556 3557- ``invert``: perform actions when pattern does not match. 3558 3559- ``any``: match any protocol for the current layer. 3560 3561 - ``num {unsigned}``: number of layers covered. 3562 3563- ``pf``: match traffic from/to the physical function. 3564 3565- ``vf``: match traffic from/to a virtual function ID. 3566 3567 - ``id {unsigned}``: VF ID. 3568 3569- ``phy_port``: match traffic from/to a specific physical port. 3570 3571 - ``index {unsigned}``: physical port index. 3572 3573- ``port_id``: match traffic from/to a given DPDK port ID. 3574 3575 - ``id {unsigned}``: DPDK port ID. 3576 3577- ``mark``: match value set in previously matched flow rule using the mark action. 3578 3579 - ``id {unsigned}``: arbitrary integer value. 3580 3581- ``raw``: match an arbitrary byte string. 3582 3583 - ``relative {boolean}``: look for pattern after the previous item. 3584 - ``search {boolean}``: search pattern from offset (see also limit). 3585 - ``offset {integer}``: absolute or relative offset for pattern. 3586 - ``limit {unsigned}``: search area limit for start of pattern. 3587 - ``pattern {string}``: byte string to look for. 3588 3589- ``eth``: match Ethernet header. 3590 3591 - ``dst {MAC-48}``: destination MAC. 3592 - ``src {MAC-48}``: source MAC. 3593 - ``type {unsigned}``: EtherType or TPID. 3594 3595- ``vlan``: match 802.1Q/ad VLAN tag. 3596 3597 - ``tci {unsigned}``: tag control information. 3598 - ``pcp {unsigned}``: priority code point. 3599 - ``dei {unsigned}``: drop eligible indicator. 3600 - ``vid {unsigned}``: VLAN identifier. 3601 - ``inner_type {unsigned}``: inner EtherType or TPID. 3602 3603- ``ipv4``: match IPv4 header. 3604 3605 - ``tos {unsigned}``: type of service. 3606 - ``ttl {unsigned}``: time to live. 3607 - ``proto {unsigned}``: next protocol ID. 3608 - ``src {ipv4 address}``: source address. 3609 - ``dst {ipv4 address}``: destination address. 3610 3611- ``ipv6``: match IPv6 header. 3612 3613 - ``tc {unsigned}``: traffic class. 3614 - ``flow {unsigned}``: flow label. 3615 - ``proto {unsigned}``: protocol (next header). 3616 - ``hop {unsigned}``: hop limit. 3617 - ``src {ipv6 address}``: source address. 3618 - ``dst {ipv6 address}``: destination address. 3619 3620- ``icmp``: match ICMP header. 3621 3622 - ``type {unsigned}``: ICMP packet type. 3623 - ``code {unsigned}``: ICMP packet code. 3624 3625- ``udp``: match UDP header. 3626 3627 - ``src {unsigned}``: UDP source port. 3628 - ``dst {unsigned}``: UDP destination port. 3629 3630- ``tcp``: match TCP header. 3631 3632 - ``src {unsigned}``: TCP source port. 3633 - ``dst {unsigned}``: TCP destination port. 3634 3635- ``sctp``: match SCTP header. 3636 3637 - ``src {unsigned}``: SCTP source port. 3638 - ``dst {unsigned}``: SCTP destination port. 3639 - ``tag {unsigned}``: validation tag. 3640 - ``cksum {unsigned}``: checksum. 3641 3642- ``vxlan``: match VXLAN header. 3643 3644 - ``vni {unsigned}``: VXLAN identifier. 3645 3646- ``e_tag``: match IEEE 802.1BR E-Tag header. 3647 3648 - ``grp_ecid_b {unsigned}``: GRP and E-CID base. 3649 3650- ``nvgre``: match NVGRE header. 3651 3652 - ``tni {unsigned}``: virtual subnet ID. 3653 3654- ``mpls``: match MPLS header. 3655 3656 - ``label {unsigned}``: MPLS label. 3657 3658- ``gre``: match GRE header. 3659 3660 - ``protocol {unsigned}``: protocol type. 3661 3662- ``fuzzy``: fuzzy pattern match, expect faster than default. 3663 3664 - ``thresh {unsigned}``: accuracy threshold. 3665 3666- ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header. 3667 3668 - ``teid {unsigned}``: tunnel endpoint identifier. 3669 3670- ``geneve``: match GENEVE header. 3671 3672 - ``vni {unsigned}``: virtual network identifier. 3673 - ``protocol {unsigned}``: protocol type. 3674 3675- ``vxlan-gpe``: match VXLAN-GPE header. 3676 3677 - ``vni {unsigned}``: VXLAN-GPE identifier. 3678 3679- ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4. 3680 3681 - ``sha {MAC-48}``: sender hardware address. 3682 - ``spa {ipv4 address}``: sender IPv4 address. 3683 - ``tha {MAC-48}``: target hardware address. 3684 - ``tpa {ipv4 address}``: target IPv4 address. 3685 3686- ``ipv6_ext``: match presence of any IPv6 extension header. 3687 3688 - ``next_hdr {unsigned}``: next header. 3689 3690- ``icmp6``: match any ICMPv6 header. 3691 3692 - ``type {unsigned}``: ICMPv6 type. 3693 - ``code {unsigned}``: ICMPv6 code. 3694 3695- ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation. 3696 3697 - ``target_addr {ipv6 address}``: target address. 3698 3699- ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement. 3700 3701 - ``target_addr {ipv6 address}``: target address. 3702 3703- ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option. 3704 3705 - ``type {unsigned}``: ND option type. 3706 3707- ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet 3708 link-layer address option. 3709 3710 - ``sla {MAC-48}``: source Ethernet LLA. 3711 3712- ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery target Ethernet 3713 link-layer address option. 3714 3715 - ``tla {MAC-48}``: target Ethernet LLA. 3716 3717- ``meta``: match application specific metadata. 3718 3719 - ``data {unsigned}``: metadata value. 3720 3721Actions list 3722^^^^^^^^^^^^ 3723 3724A list of actions starts after the ``actions`` token in the same fashion as 3725`Matching pattern`_; actions are separated by ``/`` tokens and the list is 3726terminated by a mandatory ``end`` action. 3727 3728Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum 3729rte_flow_action_type``). 3730 3731Dropping all incoming UDPv4 packets can be expressed as follows:: 3732 3733 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3734 actions drop / end 3735 3736Several actions have configurable properties which must be specified when 3737there is no valid default value. For example, ``queue`` requires a target 3738queue index. 3739 3740This rule redirects incoming UDPv4 traffic to queue index 6:: 3741 3742 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3743 actions queue index 6 / end 3744 3745While this one could be rejected by PMDs (unspecified queue index):: 3746 3747 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3748 actions queue / end 3749 3750As defined by *rte_flow*, the list is not ordered, all actions of a given 3751rule are performed simultaneously. These are equivalent:: 3752 3753 queue index 6 / void / mark id 42 / end 3754 3755:: 3756 3757 void / mark id 42 / queue index 6 / end 3758 3759All actions in a list should have different types, otherwise only the last 3760action of a given type is taken into account:: 3761 3762 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6 3763 3764:: 3765 3766 drop / drop / drop / end # drop is performed only once 3767 3768:: 3769 3770 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24 3771 3772Considering they are performed simultaneously, opposite and overlapping 3773actions can sometimes be combined when the end result is unambiguous:: 3774 3775 drop / queue index 6 / end # drop has no effect 3776 3777:: 3778 3779 queue index 6 / rss queues 6 7 8 / end # queue has no effect 3780 3781:: 3782 3783 drop / passthru / end # drop has no effect 3784 3785Note that PMDs may still refuse such combinations. 3786 3787Actions 3788^^^^^^^ 3789 3790This section lists supported actions and their attributes, if any. 3791 3792- ``end``: end list of actions. 3793 3794- ``void``: no-op action. 3795 3796- ``passthru``: let subsequent rule process matched packets. 3797 3798- ``jump``: redirect traffic to group on device. 3799 3800 - ``group {unsigned}``: group to redirect to. 3801 3802- ``mark``: attach 32 bit value to packets. 3803 3804 - ``id {unsigned}``: 32 bit value to return with packets. 3805 3806- ``flag``: flag packets. 3807 3808- ``queue``: assign packets to a given queue index. 3809 3810 - ``index {unsigned}``: queue index to use. 3811 3812- ``drop``: drop packets (note: passthru has priority). 3813 3814- ``count``: enable counters for this rule. 3815 3816- ``rss``: spread packets among several queues. 3817 3818 - ``func {hash function}``: RSS hash function to apply, allowed tokens are 3819 the same as `set_hash_global_config`_. 3820 3821 - ``level {unsigned}``: encapsulation level for ``types``. 3822 3823 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed 3824 tokens are the same as `set_hash_input_set`_, except that an empty list 3825 does not disable RSS but instead requests unspecified "best-effort" 3826 settings. 3827 3828 - ``key {string}``: RSS hash key, overrides ``key_len``. 3829 3830 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in 3831 conjunction with ``key`` to pad or truncate it. 3832 3833 - ``queues [{unsigned} [...]] end``: queue indices to use. 3834 3835- ``pf``: direct traffic to physical function. 3836 3837- ``vf``: direct traffic to a virtual function ID. 3838 3839 - ``original {boolean}``: use original VF ID if possible. 3840 - ``id {unsigned}``: VF ID. 3841 3842- ``phy_port``: direct packets to physical port index. 3843 3844 - ``original {boolean}``: use original port index if possible. 3845 - ``index {unsigned}``: physical port index. 3846 3847- ``port_id``: direct matching traffic to a given DPDK port ID. 3848 3849 - ``original {boolean}``: use original DPDK port ID if possible. 3850 - ``id {unsigned}``: DPDK port ID. 3851 3852- ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``. 3853 3854 - ``mpls_ttl``: MPLS TTL. 3855 3856- ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``. 3857 3858- ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``. 3859 3860 - ``nw_ttl``: IP TTL. 3861 3862- ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``. 3863 3864- ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``. 3865 3866- ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``. 3867 3868- ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``. 3869 3870- ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``. 3871 3872 - ``ethertype``: Ethertype. 3873 3874- ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``. 3875 3876 - ``vlan_vid``: VLAN id. 3877 3878- ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``. 3879 3880 - ``vlan_pcp``: VLAN priority. 3881 3882- ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``. 3883 3884 - ``ethertype``: Ethertype. 3885 3886- ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``. 3887 3888 - ``ethertype``: Ethertype. 3889 3890- ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration 3891 is done through `Config VXLAN Encap outer layers`_. 3892 3893- ``vxlan_decap``: Performs a decapsulation action by stripping all headers of 3894 the VXLAN tunnel network overlay from the matched flow. 3895 3896- ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration 3897 is done through `Config NVGRE Encap outer layers`_. 3898 3899- ``nvgre_decap``: Performs a decapsulation action by stripping all headers of 3900 the NVGRE tunnel network overlay from the matched flow. 3901 3902- ``l2_encap``: Performs a L2 encapsulation, L2 configuration 3903 is done through `Config L2 Encap`_. 3904 3905- ``l2_decap``: Performs a L2 decapsulation, L2 configuration 3906 is done through `Config L2 Decap`_. 3907 3908- ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer 3909 configuration is done through `Config MPLSoGRE Encap outer layers`_. 3910 3911- ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer 3912 configuration is done through `Config MPLSoGRE Decap outer layers`_. 3913 3914- ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer 3915 configuration is done through `Config MPLSoUDP Encap outer layers`_. 3916 3917- ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer 3918 configuration is done through `Config MPLSoUDP Decap outer layers`_. 3919 3920- ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header. 3921 3922 - ``ipv4_addr``: New IPv4 source address. 3923 3924- ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4 3925 header. 3926 3927 - ``ipv4_addr``: New IPv4 destination address. 3928 3929- ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header. 3930 3931 - ``ipv6_addr``: New IPv6 source address. 3932 3933- ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6 3934 header. 3935 3936 - ``ipv6_addr``: New IPv6 destination address. 3937 3938- ``set_tp_src``: Set a new source port number in the outermost TCP/UDP 3939 header. 3940 3941 - ``port``: New TCP/UDP source port number. 3942 3943- ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP 3944 header. 3945 3946 - ``port``: New TCP/UDP destination port number. 3947 3948- ``mac_swap``: Swap the source and destination MAC addresses in the outermost 3949 Ethernet header. 3950 3951- ``dec_ttl``: Performs a decrease TTL value action 3952 3953- ``set_ttl``: Set TTL value with specificed value 3954 - ``ttl_value {unsigned}``: The new TTL value to be set 3955 3956- ``set_mac_src``: set source MAC address 3957 3958 - ``mac_addr {MAC-48}``: new source MAC address 3959 3960- ``set_mac_dst``: set destination MAC address 3961 3962 - ``mac_addr {MAC-48}``: new destination MAC address 3963 3964Destroying flow rules 3965~~~~~~~~~~~~~~~~~~~~~ 3966 3967``flow destroy`` destroys one or more rules from their rule ID (as returned 3968by ``flow create``), this command calls ``rte_flow_destroy()`` as many 3969times as necessary:: 3970 3971 flow destroy {port_id} rule {rule_id} [...] 3972 3973If successful, it will show:: 3974 3975 Flow rule #[...] destroyed 3976 3977It does not report anything for rule IDs that do not exist. The usual error 3978message is shown when a rule cannot be destroyed:: 3979 3980 Caught error type [...] ([...]): [...] 3981 3982``flow flush`` destroys all rules on a device and does not take extra 3983arguments. It is bound to ``rte_flow_flush()``:: 3984 3985 flow flush {port_id} 3986 3987Any errors are reported as above. 3988 3989Creating several rules and destroying them:: 3990 3991 testpmd> flow create 0 ingress pattern eth / ipv6 / end 3992 actions queue index 2 / end 3993 Flow rule #0 created 3994 testpmd> flow create 0 ingress pattern eth / ipv4 / end 3995 actions queue index 3 / end 3996 Flow rule #1 created 3997 testpmd> flow destroy 0 rule 0 rule 1 3998 Flow rule #1 destroyed 3999 Flow rule #0 destroyed 4000 testpmd> 4001 4002The same result can be achieved using ``flow flush``:: 4003 4004 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4005 actions queue index 2 / end 4006 Flow rule #0 created 4007 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4008 actions queue index 3 / end 4009 Flow rule #1 created 4010 testpmd> flow flush 0 4011 testpmd> 4012 4013Non-existent rule IDs are ignored:: 4014 4015 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4016 actions queue index 2 / end 4017 Flow rule #0 created 4018 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4019 actions queue index 3 / end 4020 Flow rule #1 created 4021 testpmd> flow destroy 0 rule 42 rule 10 rule 2 4022 testpmd> 4023 testpmd> flow destroy 0 rule 0 4024 Flow rule #0 destroyed 4025 testpmd> 4026 4027Querying flow rules 4028~~~~~~~~~~~~~~~~~~~ 4029 4030``flow query`` queries a specific action of a flow rule having that 4031ability. Such actions collect information that can be reported using this 4032command. It is bound to ``rte_flow_query()``:: 4033 4034 flow query {port_id} {rule_id} {action} 4035 4036If successful, it will display either the retrieved data for known actions 4037or the following message:: 4038 4039 Cannot display result for action type [...] ([...]) 4040 4041Otherwise, it will complain either that the rule does not exist or that some 4042error occurred:: 4043 4044 Flow rule #[...] not found 4045 4046:: 4047 4048 Caught error type [...] ([...]): [...] 4049 4050Currently only the ``count`` action is supported. This action reports the 4051number of packets that hit the flow rule and the total number of bytes. Its 4052output has the following format:: 4053 4054 count: 4055 hits_set: [...] # whether "hits" contains a valid value 4056 bytes_set: [...] # whether "bytes" contains a valid value 4057 hits: [...] # number of packets 4058 bytes: [...] # number of bytes 4059 4060Querying counters for TCPv6 packets redirected to queue 6:: 4061 4062 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end 4063 actions queue index 6 / count / end 4064 Flow rule #4 created 4065 testpmd> flow query 0 4 count 4066 count: 4067 hits_set: 1 4068 bytes_set: 0 4069 hits: 386446 4070 bytes: 0 4071 testpmd> 4072 4073Listing flow rules 4074~~~~~~~~~~~~~~~~~~ 4075 4076``flow list`` lists existing flow rules sorted by priority and optionally 4077filtered by group identifiers:: 4078 4079 flow list {port_id} [group {group_id}] [...] 4080 4081This command only fails with the following message if the device does not 4082exist:: 4083 4084 Invalid port [...] 4085 4086Output consists of a header line followed by a short description of each 4087flow rule, one per line. There is no output at all when no flow rules are 4088configured on the device:: 4089 4090 ID Group Prio Attr Rule 4091 [...] [...] [...] [...] [...] 4092 4093``Attr`` column flags: 4094 4095- ``i`` for ``ingress``. 4096- ``e`` for ``egress``. 4097 4098Creating several flow rules and listing them:: 4099 4100 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4101 actions queue index 6 / end 4102 Flow rule #0 created 4103 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4104 actions queue index 2 / end 4105 Flow rule #1 created 4106 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end 4107 actions rss queues 6 7 8 end / end 4108 Flow rule #2 created 4109 testpmd> flow list 0 4110 ID Group Prio Attr Rule 4111 0 0 0 i- ETH IPV4 => QUEUE 4112 1 0 0 i- ETH IPV6 => QUEUE 4113 2 0 5 i- ETH IPV4 UDP => RSS 4114 testpmd> 4115 4116Rules are sorted by priority (i.e. group ID first, then priority level):: 4117 4118 testpmd> flow list 1 4119 ID Group Prio Attr Rule 4120 0 0 0 i- ETH => COUNT 4121 6 0 500 i- ETH IPV6 TCP => DROP COUNT 4122 5 0 1000 i- ETH IPV6 ICMP => QUEUE 4123 1 24 0 i- ETH IPV4 UDP => QUEUE 4124 4 24 10 i- ETH IPV4 TCP => DROP 4125 3 24 20 i- ETH IPV4 => DROP 4126 2 24 42 i- ETH IPV4 UDP => QUEUE 4127 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE 4128 testpmd> 4129 4130Output can be limited to specific groups:: 4131 4132 testpmd> flow list 1 group 0 group 63 4133 ID Group Prio Attr Rule 4134 0 0 0 i- ETH => COUNT 4135 6 0 500 i- ETH IPV6 TCP => DROP COUNT 4136 5 0 1000 i- ETH IPV6 ICMP => QUEUE 4137 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE 4138 testpmd> 4139 4140Toggling isolated mode 4141~~~~~~~~~~~~~~~~~~~~~~ 4142 4143``flow isolate`` can be used to tell the underlying PMD that ingress traffic 4144must only be injected from the defined flow rules; that no default traffic 4145is expected outside those rules and the driver is free to assign more 4146resources to handle them. It is bound to ``rte_flow_isolate()``:: 4147 4148 flow isolate {port_id} {boolean} 4149 4150If successful, enabling or disabling isolated mode shows either:: 4151 4152 Ingress traffic on port [...] 4153 is now restricted to the defined flow rules 4154 4155Or:: 4156 4157 Ingress traffic on port [...] 4158 is not restricted anymore to the defined flow rules 4159 4160Otherwise, in case of error:: 4161 4162 Caught error type [...] ([...]): [...] 4163 4164Mainly due to its side effects, PMDs supporting this mode may not have the 4165ability to toggle it more than once without reinitializing affected ports 4166first (e.g. by exiting testpmd). 4167 4168Enabling isolated mode:: 4169 4170 testpmd> flow isolate 0 true 4171 Ingress traffic on port 0 is now restricted to the defined flow rules 4172 testpmd> 4173 4174Disabling isolated mode:: 4175 4176 testpmd> flow isolate 0 false 4177 Ingress traffic on port 0 is not restricted anymore to the defined flow rules 4178 testpmd> 4179 4180Sample QinQ flow rules 4181~~~~~~~~~~~~~~~~~~~~~~ 4182 4183Before creating QinQ rule(s) the following commands should be issued to enable QinQ:: 4184 4185 testpmd> port stop 0 4186 testpmd> vlan set qinq on 0 4187 4188The above command sets the inner and outer TPID's to 0x8100. 4189 4190To change the TPID's the following commands should be used:: 4191 4192 testpmd> vlan set outer tpid 0xa100 0 4193 testpmd> vlan set inner tpid 0x9100 0 4194 testpmd> port start 0 4195 4196Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM. 4197 4198:: 4199 4200 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 / 4201 vlan tci is 456 / end actions vf id 1 / queue index 0 / end 4202 Flow rule #0 validated 4203 4204 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 / 4205 vlan tci is 456 / end actions vf id 123 / queue index 0 / end 4206 Flow rule #0 created 4207 4208 testpmd> flow list 0 4209 ID Group Prio Attr Rule 4210 0 0 0 i- ETH VLAN VLAN=>VF QUEUE 4211 4212Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host. 4213 4214:: 4215 4216 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 / 4217 vlan tci is 654 / end actions pf / queue index 0 / end 4218 Flow rule #1 validated 4219 4220 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 / 4221 vlan tci is 654 / end actions pf / queue index 1 / end 4222 Flow rule #1 created 4223 4224 testpmd> flow list 0 4225 ID Group Prio Attr Rule 4226 0 0 0 i- ETH VLAN VLAN=>VF QUEUE 4227 1 0 0 i- ETH VLAN VLAN=>PF QUEUE 4228 4229Sample VXLAN encapsulation rule 4230~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4231 4232VXLAN encapsulation outer layer has default value pre-configured in testpmd 4233source code, those can be changed by using the following commands 4234 4235IPv4 VXLAN outer header:: 4236 4237 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1 4238 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4239 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4240 queue index 0 / end 4241 4242 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 4243 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11 4244 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-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0 4249 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 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 4254IPv6 VXLAN outer header:: 4255 4256 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1 4257 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4258 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4259 queue index 0 / end 4260 4261 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 4262 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11 4263 eth-dst 22:22:22:22:22:22 4264 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4265 queue index 0 / end 4266 4267 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4 4268 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 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 vxlan_encap / 4271 queue index 0 / end 4272 4273Sample NVGRE encapsulation rule 4274~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4275 4276NVGRE encapsulation outer layer has default value pre-configured in testpmd 4277source code, those can be changed by using the following commands 4278 4279IPv4 NVGRE outer header:: 4280 4281 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1 4282 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4283 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4284 queue index 0 / end 4285 4286 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1 4287 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11 4288 eth-dst 22:22:22:22:22:22 4289 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4290 queue index 0 / end 4291 4292IPv6 NVGRE outer header:: 4293 4294 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222 4295 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4296 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4297 queue index 0 / end 4298 4299 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222 4300 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4301 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4302 queue index 0 / end 4303 4304Sample L2 encapsulation rule 4305~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4306 4307L2 encapsulation has default value pre-configured in testpmd 4308source code, those can be changed by using the following commands 4309 4310L2 header:: 4311 4312 testpmd> set l2_encap ip-version ipv4 4313 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4314 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 4315 mplsoudp_decap / l2_encap / end 4316 4317L2 with VXLAN header:: 4318 4319 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34 4320 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4321 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 4322 mplsoudp_decap / l2_encap / end 4323 4324Sample L2 decapsulation rule 4325~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4326 4327L2 decapsulation has default value pre-configured in testpmd 4328source code, those can be changed by using the following commands 4329 4330L2 header:: 4331 4332 testpmd> set l2_decap 4333 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap / 4334 queue index 0 / end 4335 4336L2 with VXLAN header:: 4337 4338 testpmd> set l2_encap-with-vlan 4339 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap / 4340 queue index 0 / end 4341 4342Sample MPLSoGRE encapsulation rule 4343~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4344 4345MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd 4346source code, those can be changed by using the following commands 4347 4348IPv4 MPLSoGRE outer header:: 4349 4350 testpmd> set mplsogre_encap ip-version ipv4 label 4 4351 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 4352 eth-dst 22:22:22:22:22:22 4353 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4354 mplsogre_encap / end 4355 4356IPv4 MPLSoGRE with VLAN outer header:: 4357 4358 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4 4359 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 4360 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4361 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4362 mplsogre_encap / end 4363 4364IPv6 MPLSoGRE outer header:: 4365 4366 testpmd> set mplsogre_encap ip-version ipv6 mask 4 4367 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11 4368 eth-dst 22:22:22:22:22:22 4369 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4370 mplsogre_encap / end 4371 4372IPv6 MPLSoGRE with VLAN outer header:: 4373 4374 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4 4375 ip-src ::1 ip-dst ::2222 vlan-tci 34 4376 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4377 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4378 mplsogre_encap / end 4379 4380Sample MPLSoGRE decapsulation rule 4381~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4382 4383MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd 4384source code, those can be changed by using the following commands 4385 4386IPv4 MPLSoGRE outer header:: 4387 4388 testpmd> set mplsogre_decap ip-version ipv4 4389 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions 4390 mplsogre_decap / l2_encap / end 4391 4392IPv4 MPLSoGRE with VLAN outer header:: 4393 4394 testpmd> set mplsogre_decap-with-vlan ip-version ipv4 4395 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end 4396 actions mplsogre_decap / l2_encap / end 4397 4398IPv6 MPLSoGRE outer header:: 4399 4400 testpmd> set mplsogre_decap ip-version ipv6 4401 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end 4402 actions mplsogre_decap / l2_encap / end 4403 4404IPv6 MPLSoGRE with VLAN outer header:: 4405 4406 testpmd> set mplsogre_decap-with-vlan ip-version ipv6 4407 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end 4408 actions mplsogre_decap / l2_encap / end 4409 4410Sample MPLSoUDP encapsulation rule 4411~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4412 4413MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd 4414source code, those can be changed by using the following commands 4415 4416IPv4 MPLSoUDP outer header:: 4417 4418 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10 4419 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 4420 eth-dst 22:22:22:22:22:22 4421 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4422 mplsoudp_encap / end 4423 4424IPv4 MPLSoUDP with VLAN outer header:: 4425 4426 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5 4427 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 4428 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4429 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4430 mplsoudp_encap / end 4431 4432IPv6 MPLSoUDP outer header:: 4433 4434 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10 4435 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11 4436 eth-dst 22:22:22:22:22:22 4437 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4438 mplsoudp_encap / end 4439 4440IPv6 MPLSoUDP with VLAN outer header:: 4441 4442 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5 4443 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34 4444 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4445 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4446 mplsoudp_encap / end 4447 4448Sample MPLSoUDP decapsulation rule 4449~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4450 4451MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd 4452source code, those can be changed by using the following commands 4453 4454IPv4 MPLSoUDP outer header:: 4455 4456 testpmd> set mplsoudp_decap ip-version ipv4 4457 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 4458 mplsoudp_decap / l2_encap / end 4459 4460IPv4 MPLSoUDP with VLAN outer header:: 4461 4462 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4 4463 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end 4464 actions mplsoudp_decap / l2_encap / end 4465 4466IPv6 MPLSoUDP outer header:: 4467 4468 testpmd> set mplsoudp_decap ip-version ipv6 4469 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end 4470 actions mplsoudp_decap / l2_encap / end 4471 4472IPv6 MPLSoUDP with VLAN outer header:: 4473 4474 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6 4475 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end 4476 actions mplsoudp_decap / l2_encap / end 4477 4478BPF Functions 4479-------------- 4480 4481The following sections show functions to load/unload eBPF based filters. 4482 4483bpf-load 4484~~~~~~~~ 4485 4486Load an eBPF program as a callback for partciular RX/TX queue:: 4487 4488 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename) 4489 4490The available load-flags are: 4491 4492* ``J``: use JIT generated native code, otherwise BPF interpreter will be used. 4493 4494* ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data. 4495 4496* ``-``: none. 4497 4498.. note:: 4499 4500 You'll need clang v3.7 or above to build bpf program you'd like to load 4501 4502For example: 4503 4504.. code-block:: console 4505 4506 cd examples/bpf 4507 clang -O2 -target bpf -c t1.c 4508 4509Then to load (and JIT compile) t1.o at RX queue 0, port 1:: 4510 4511.. code-block:: console 4512 4513 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o 4514 4515To load (not JITed) t1.o at TX queue 0, port 0:: 4516 4517.. code-block:: console 4518 4519 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o 4520 4521bpf-unload 4522~~~~~~~~~~ 4523 4524Unload previously loaded eBPF program for partciular RX/TX queue:: 4525 4526 testpmd> bpf-unload rx|tx (portid) (queueid) 4527 4528For example to unload BPF filter from TX queue 0, port 0: 4529 4530.. code-block:: console 4531 4532 testpmd> bpf-unload tx 0 0 4533