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