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