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