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