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