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