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