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