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