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