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