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