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