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