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