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