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 1527set pfc_ctrl rx 1528~~~~~~~~~~~~~~~ 1529 1530Set the priority flow control parameter on a port:: 1531 1532 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 1533 (pause_time) (priority) (port_id) 1534 1535Where: 1536 1537* ``high_water`` (integer): High threshold value. 1538 1539* ``low_water`` (integer): Low threshold value. 1540 1541* ``pause_time`` (integer): Pause quota in the Pause frame. 1542 1543* ``priority`` (0-7): VLAN User Priority. 1544 1545set stat_qmap 1546~~~~~~~~~~~~~ 1547 1548Set statistics mapping (qmapping 0..15) for RX/TX queue on port:: 1549 1550 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping) 1551 1552For example, to set rx queue 2 on port 0 to mapping 5:: 1553 1554 testpmd>set stat_qmap rx 0 2 5 1555 1556set xstats-hide-zero 1557~~~~~~~~~~~~~~~~~~~~ 1558 1559Set the option to hide zero values for xstats display:: 1560 1561 testpmd> set xstats-hide-zero on|off 1562 1563.. note:: 1564 1565 By default, the zero values are displayed for xstats. 1566 1567set port - rx/tx (for VF) 1568~~~~~~~~~~~~~~~~~~~~~~~~~ 1569 1570Set VF receive/transmit from a port:: 1571 1572 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off) 1573 1574set port - rx mode(for VF) 1575~~~~~~~~~~~~~~~~~~~~~~~~~~ 1576 1577Set the VF receive mode of a port:: 1578 1579 testpmd> set port (port_id) vf (vf_id) \ 1580 rxmode (AUPE|ROPE|BAM|MPE) (on|off) 1581 1582The available receive modes are: 1583 1584* ``AUPE``: Accepts untagged VLAN. 1585 1586* ``ROPE``: Accepts unicast hash. 1587 1588* ``BAM``: Accepts broadcast packets. 1589 1590* ``MPE``: Accepts all multicast packets. 1591 1592set port - tx_rate (for Queue) 1593~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1594 1595Set TX rate limitation for a queue on a port:: 1596 1597 testpmd> set port (port_id) queue (queue_id) rate (rate_value) 1598 1599set port - tx_rate (for VF) 1600~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1601 1602Set TX rate limitation for queues in VF on a port:: 1603 1604 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask) 1605 1606set port - mirror rule 1607~~~~~~~~~~~~~~~~~~~~~~ 1608 1609Set pool or vlan type mirror rule for a port:: 1610 1611 testpmd> set port (port_id) mirror-rule (rule_id) \ 1612 (pool-mirror-up|pool-mirror-down|vlan-mirror) \ 1613 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off) 1614 1615Set link mirror rule for a port:: 1616 1617 testpmd> set port (port_id) mirror-rule (rule_id) \ 1618 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off) 1619 1620For example to enable mirror traffic with vlan 0,1 to pool 0:: 1621 1622 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on 1623 1624reset port - mirror rule 1625~~~~~~~~~~~~~~~~~~~~~~~~ 1626 1627Reset a mirror rule for a port:: 1628 1629 testpmd> reset port (port_id) mirror-rule (rule_id) 1630 1631set flush_rx 1632~~~~~~~~~~~~ 1633 1634Set the flush on RX streams before forwarding. 1635The default is flush ``on``. 1636Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams:: 1637 1638 testpmd> set flush_rx off 1639 1640set bypass mode 1641~~~~~~~~~~~~~~~ 1642 1643Set the bypass mode for the lowest port on bypass enabled NIC:: 1644 1645 testpmd> set bypass mode (normal|bypass|isolate) (port_id) 1646 1647set bypass event 1648~~~~~~~~~~~~~~~~ 1649 1650Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled:: 1651 1652 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \ 1653 mode (normal|bypass|isolate) (port_id) 1654 1655Where: 1656 1657* ``timeout``: Enable bypass after watchdog timeout. 1658 1659* ``os_on``: Enable bypass when OS/board is powered on. 1660 1661* ``os_off``: Enable bypass when OS/board is powered off. 1662 1663* ``power_on``: Enable bypass when power supply is turned on. 1664 1665* ``power_off``: Enable bypass when power supply is turned off. 1666 1667 1668set bypass timeout 1669~~~~~~~~~~~~~~~~~~ 1670 1671Set the bypass watchdog timeout to ``n`` seconds where 0 = instant:: 1672 1673 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32) 1674 1675show bypass config 1676~~~~~~~~~~~~~~~~~~ 1677 1678Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC:: 1679 1680 testpmd> show bypass config (port_id) 1681 1682set link up 1683~~~~~~~~~~~ 1684 1685Set link up for a port:: 1686 1687 testpmd> set link-up port (port id) 1688 1689set link down 1690~~~~~~~~~~~~~ 1691 1692Set link down for a port:: 1693 1694 testpmd> set link-down port (port id) 1695 1696E-tag set 1697~~~~~~~~~ 1698 1699Enable E-tag insertion for a VF on a port:: 1700 1701 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id) 1702 1703Disable E-tag insertion for a VF on a port:: 1704 1705 testpmd> E-tag set insertion off port (port_id) vf (vf_id) 1706 1707Enable/disable E-tag stripping on a port:: 1708 1709 testpmd> E-tag set stripping (on|off) port (port_id) 1710 1711Enable/disable E-tag based forwarding on a port:: 1712 1713 testpmd> E-tag set forwarding (on|off) port (port_id) 1714 1715ddp add 1716~~~~~~~ 1717 1718Load a dynamic device personalization (DDP) profile and store backup profile:: 1719 1720 testpmd> ddp add (port_id) (profile_path[,backup_profile_path]) 1721 1722ddp del 1723~~~~~~~ 1724 1725Delete a dynamic device personalization profile and restore backup profile:: 1726 1727 testpmd> ddp del (port_id) (backup_profile_path) 1728 1729ptype mapping 1730~~~~~~~~~~~~~ 1731 1732List all items from the ptype mapping table:: 1733 1734 testpmd> ptype mapping get (port_id) (valid_only) 1735 1736Where: 1737 1738* ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0). 1739 1740Replace a specific or a group of software defined ptype with a new one:: 1741 1742 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type) 1743 1744where: 1745 1746* ``target``: A specific software ptype or a mask to represent a group of software ptypes. 1747 1748* ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1). 1749 1750* ``pkt_type``: The new software ptype to replace the old ones. 1751 1752Update hardware defined ptype to software defined packet type mapping table:: 1753 1754 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype) 1755 1756where: 1757 1758* ``hw_ptype``: hardware ptype as the index of the ptype mapping table. 1759 1760* ``sw_ptype``: software ptype as the value of the ptype mapping table. 1761 1762Reset ptype mapping table:: 1763 1764 testpmd> ptype mapping reset (port_id) 1765 1766config per port Rx offloading 1767~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1768 1769Enable or disable a per port Rx offloading on all Rx queues of a port:: 1770 1771 testpmd> port config (port_id) rx_offload (offloading) on|off 1772 1773* ``offloading``: can be any of these offloading capability: 1774 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro, 1775 qinq_strip, outer_ipv4_cksum, macsec_strip, 1776 header_split, vlan_filter, vlan_extend, jumbo_frame, 1777 scatter, timestamp, security, keep_crc, rss_hash 1778 1779This command should be run when the port is stopped, or else it will fail. 1780 1781config per queue Rx offloading 1782~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1783 1784Enable or disable a per queue Rx offloading only on a specific Rx queue:: 1785 1786 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off 1787 1788* ``offloading``: can be any of these offloading capability: 1789 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro, 1790 qinq_strip, outer_ipv4_cksum, macsec_strip, 1791 header_split, vlan_filter, vlan_extend, jumbo_frame, 1792 scatter, timestamp, security, keep_crc 1793 1794This command should be run when the port is stopped, or else it will fail. 1795 1796config per port Tx offloading 1797~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1798 1799Enable or disable a per port Tx offloading on all Tx queues of a port:: 1800 1801 testpmd> port config (port_id) tx_offload (offloading) on|off 1802 1803* ``offloading``: can be any of these offloading capability: 1804 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum, 1805 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum, 1806 qinq_insert, vxlan_tnl_tso, gre_tnl_tso, 1807 ipip_tnl_tso, geneve_tnl_tso, macsec_insert, 1808 mt_lockfree, multi_segs, mbuf_fast_free, security 1809 1810This command should be run when the port is stopped, or else it will fail. 1811 1812config per queue Tx offloading 1813~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1814 1815Enable or disable a per queue Tx offloading only on a specific Tx queue:: 1816 1817 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off 1818 1819* ``offloading``: can be any of these offloading capability: 1820 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum, 1821 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum, 1822 qinq_insert, vxlan_tnl_tso, gre_tnl_tso, 1823 ipip_tnl_tso, geneve_tnl_tso, macsec_insert, 1824 mt_lockfree, multi_segs, mbuf_fast_free, security 1825 1826This command should be run when the port is stopped, or else it will fail. 1827 1828Config VXLAN Encap outer layers 1829~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1830 1831Configure the outer layer to encapsulate a packet inside a VXLAN tunnel:: 1832 1833 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \ 1834 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \ 1835 eth-dst (eth-dst) 1836 1837 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \ 1838 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \ 1839 eth-src (eth-src) eth-dst (eth-dst) 1840 1841 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \ 1842 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \ 1843 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst) 1844 1845These commands will set an internal configuration inside testpmd, any following 1846flow rule using the action vxlan_encap will use the last configuration set. 1847To have a different encapsulation header, one of those commands must be called 1848before the flow rule creation. 1849 1850Config NVGRE Encap outer layers 1851~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1852 1853Configure the outer layer to encapsulate a packet inside a NVGRE tunnel:: 1854 1855 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \ 1856 eth-src (eth-src) eth-dst (eth-dst) 1857 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \ 1858 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst) 1859 1860These commands will set an internal configuration inside testpmd, any following 1861flow rule using the action nvgre_encap will use the last configuration set. 1862To have a different encapsulation header, one of those commands must be called 1863before the flow rule creation. 1864 1865Config L2 Encap 1866~~~~~~~~~~~~~~~ 1867 1868Configure the l2 to be used when encapsulating a packet with L2:: 1869 1870 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst) 1871 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \ 1872 eth-src (eth-src) eth-dst (eth-dst) 1873 1874Those commands will set an internal configuration inside testpmd, any following 1875flow rule using the action l2_encap will use the last configuration set. 1876To have a different encapsulation header, one of those commands must be called 1877before the flow rule creation. 1878 1879Config L2 Decap 1880~~~~~~~~~~~~~~~ 1881 1882Configure the l2 to be removed when decapsulating a packet with L2:: 1883 1884 set l2_decap ip-version (ipv4|ipv6) 1885 set l2_decap-with-vlan ip-version (ipv4|ipv6) 1886 1887Those commands will set an internal configuration inside testpmd, any following 1888flow rule using the action l2_decap will use the last configuration set. 1889To have a different encapsulation header, one of those commands must be called 1890before the flow rule creation. 1891 1892Config MPLSoGRE Encap outer layers 1893~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1894 1895Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel:: 1896 1897 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \ 1898 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst) 1899 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \ 1900 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \ 1901 eth-src (eth-src) eth-dst (eth-dst) 1902 1903These commands will set an internal configuration inside testpmd, any following 1904flow rule using the action mplsogre_encap will use the last configuration set. 1905To have a different encapsulation header, one of those commands must be called 1906before the flow rule creation. 1907 1908Config MPLSoGRE Decap outer layers 1909~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1910 1911Configure the outer layer to decapsulate MPLSoGRE packet:: 1912 1913 set mplsogre_decap ip-version (ipv4|ipv6) 1914 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6) 1915 1916These commands will set an internal configuration inside testpmd, any following 1917flow rule using the action mplsogre_decap will use the last configuration set. 1918To have a different decapsulation header, one of those commands must be called 1919before the flow rule creation. 1920 1921Config MPLSoUDP Encap outer layers 1922~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1923 1924Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel:: 1925 1926 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \ 1927 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \ 1928 eth-src (eth-src) eth-dst (eth-dst) 1929 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \ 1930 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \ 1931 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst) 1932 1933These commands will set an internal configuration inside testpmd, any following 1934flow rule using the action mplsoudp_encap will use the last configuration set. 1935To have a different encapsulation header, one of those commands must be called 1936before the flow rule creation. 1937 1938Config MPLSoUDP Decap outer layers 1939~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1940 1941Configure the outer layer to decapsulate MPLSoUDP packet:: 1942 1943 set mplsoudp_decap ip-version (ipv4|ipv6) 1944 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6) 1945 1946These commands will set an internal configuration inside testpmd, any following 1947flow rule using the action mplsoudp_decap will use the last configuration set. 1948To have a different decapsulation header, one of those commands must be called 1949before the flow rule creation. 1950 1951Config Raw Encapsulation 1952~~~~~~~~~~~~~~~~~~~~~~~~~ 1953 1954Configure the raw data to be used when encapsulating a packet by 1955rte_flow_action_raw_encap:: 1956 1957 set raw_encap {index} {item} [/ {item} [...]] / end_set 1958 1959There are multiple global buffers for ``raw_encap``, this command will set one 1960internal buffer index by ``{index}``. 1961If there is no ``{index}`` specified:: 1962 1963 set raw_encap {item} [/ {item} [...]] / end_set 1964 1965the default index ``0`` is used. 1966In order to use different encapsulating header, ``index`` must be specified 1967during the flow rule creation:: 1968 1969 testpmd> flow create 0 egress pattern eth / ipv4 / end actions 1970 raw_encap index 2 / end 1971 1972Otherwise the default index ``0`` is used. 1973 1974Config Raw Decapsulation 1975~~~~~~~~~~~~~~~~~~~~~~~~ 1976 1977Configure the raw data to be used when decapsulating a packet by 1978rte_flow_action_raw_decap:: 1979 1980 set raw_decap {index} {item} [/ {item} [...]] / end_set 1981 1982There are multiple global buffers for ``raw_decap``, this command will set 1983one internal buffer index by ``{index}``. 1984If there is no ``{index}`` specified:: 1985 1986 set raw_decap {item} [/ {item} [...]] / end_set 1987 1988the default index ``0`` is used. 1989In order to use different decapsulating header, ``index`` must be specified 1990during the flow rule creation:: 1991 1992 testpmd> flow create 0 egress pattern eth / ipv4 / end actions 1993 raw_encap index 3 / end 1994 1995Otherwise the default index ``0`` is used. 1996 1997Set fec mode 1998~~~~~~~~~~~~ 1999 2000Set fec mode for a specific port:: 2001 2002 testpmd> set port (port_id) fec_mode auto|off|rs|baser 2003 2004Config Sample actions list 2005~~~~~~~~~~~~~~~~~~~~~~~~~~ 2006 2007Configure the sample actions list to be used when sampling a packet by 2008rte_flow_action_sample:: 2009 2010 set sample_actions {index} {action} [/ {action} [...]] / end 2011 2012There are multiple global buffers for ``sample_actions``, this command will set 2013one internal buffer index by ``{index}``. 2014 2015In order to use different sample actions list, ``index`` must be specified 2016during the flow rule creation:: 2017 2018 testpmd> flow create 0 ingress pattern eth / ipv4 / end actions 2019 sample ratio 2 index 2 / end 2020 2021Otherwise the default index ``0`` is used. 2022 2023Port Functions 2024-------------- 2025 2026The following sections show functions for configuring ports. 2027 2028.. note:: 2029 2030 Port configuration changes only become active when forwarding is started/restarted. 2031 2032port attach 2033~~~~~~~~~~~ 2034 2035Attach a port specified by pci address or virtual device args:: 2036 2037 testpmd> port attach (identifier) 2038 2039To attach a new pci device, the device should be recognized by kernel first. 2040Then it should be moved under DPDK management. 2041Finally the port can be attached to testpmd. 2042 2043For example, to move a pci device using ixgbe under DPDK management: 2044 2045.. code-block:: console 2046 2047 # Check the status of the available devices. 2048 ./usertools/dpdk-devbind.py --status 2049 2050 Network devices using DPDK-compatible driver 2051 ============================================ 2052 <none> 2053 2054 Network devices using kernel driver 2055 =================================== 2056 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused= 2057 2058 2059 # Bind the device to igb_uio. 2060 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0 2061 2062 2063 # Recheck the status of the devices. 2064 ./usertools/dpdk-devbind.py --status 2065 Network devices using DPDK-compatible driver 2066 ============================================ 2067 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused= 2068 2069To attach a port created by virtual device, above steps are not needed. 2070 2071For example, to attach a port whose pci address is 0000:0a:00.0. 2072 2073.. code-block:: console 2074 2075 testpmd> port attach 0000:0a:00.0 2076 Attaching a new port... 2077 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 2078 EAL: probe driver: 8086:10fb rte_ixgbe_pmd 2079 EAL: PCI memory mapped at 0x7f83bfa00000 2080 EAL: PCI memory mapped at 0x7f83bfa80000 2081 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5 2082 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb 2083 Port 0 is attached. Now total ports is 1 2084 Done 2085 2086For example, to attach a port created by pcap PMD. 2087 2088.. code-block:: console 2089 2090 testpmd> port attach net_pcap0 2091 Attaching a new port... 2092 PMD: Initializing pmd_pcap for net_pcap0 2093 PMD: Creating pcap-backed ethdev on numa socket 0 2094 Port 0 is attached. Now total ports is 1 2095 Done 2096 2097In this case, identifier is ``net_pcap0``. 2098This identifier format is the same as ``--vdev`` format of DPDK applications. 2099 2100For example, to re-attach a bonded port which has been previously detached, 2101the mode and slave parameters must be given. 2102 2103.. code-block:: console 2104 2105 testpmd> port attach net_bond_0,mode=0,slave=1 2106 Attaching a new port... 2107 EAL: Initializing pmd_bond for net_bond_0 2108 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0. 2109 Port 0 is attached. Now total ports is 1 2110 Done 2111 2112 2113port detach 2114~~~~~~~~~~~ 2115 2116Detach a specific port:: 2117 2118 testpmd> port detach (port_id) 2119 2120Before detaching a port, the port should be stopped and closed. 2121 2122For example, to detach a pci device port 0. 2123 2124.. code-block:: console 2125 2126 testpmd> port stop 0 2127 Stopping ports... 2128 Done 2129 testpmd> port close 0 2130 Closing ports... 2131 Done 2132 2133 testpmd> port detach 0 2134 Detaching a port... 2135 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 2136 EAL: remove driver: 8086:10fb rte_ixgbe_pmd 2137 EAL: PCI memory unmapped at 0x7f83bfa00000 2138 EAL: PCI memory unmapped at 0x7f83bfa80000 2139 Done 2140 2141 2142For example, to detach a virtual device port 0. 2143 2144.. code-block:: console 2145 2146 testpmd> port stop 0 2147 Stopping ports... 2148 Done 2149 testpmd> port close 0 2150 Closing ports... 2151 Done 2152 2153 testpmd> port detach 0 2154 Detaching a port... 2155 PMD: Closing pcap ethdev on numa socket 0 2156 Port 'net_pcap0' is detached. Now total ports is 0 2157 Done 2158 2159To remove a pci device completely from the system, first detach the port from testpmd. 2160Then the device should be moved under kernel management. 2161Finally the device can be removed using kernel pci hotplug functionality. 2162 2163For example, to move a pci device under kernel management: 2164 2165.. code-block:: console 2166 2167 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0 2168 2169 ./usertools/dpdk-devbind.py --status 2170 2171 Network devices using DPDK-compatible driver 2172 ============================================ 2173 <none> 2174 2175 Network devices using kernel driver 2176 =================================== 2177 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio 2178 2179To remove a port created by a virtual device, above steps are not needed. 2180 2181port start 2182~~~~~~~~~~ 2183 2184Start all ports or a specific port:: 2185 2186 testpmd> port start (port_id|all) 2187 2188port stop 2189~~~~~~~~~ 2190 2191Stop all ports or a specific port:: 2192 2193 testpmd> port stop (port_id|all) 2194 2195port close 2196~~~~~~~~~~ 2197 2198Close all ports or a specific port:: 2199 2200 testpmd> port close (port_id|all) 2201 2202port reset 2203~~~~~~~~~~ 2204 2205Reset all ports or a specific port:: 2206 2207 testpmd> port reset (port_id|all) 2208 2209User should stop port(s) before resetting and (re-)start after reset. 2210 2211port config - queue ring size 2212~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2213 2214Configure a rx/tx queue ring size:: 2215 2216 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value) 2217 2218Only take effect after command that (re-)start the port or command that setup specific queue. 2219 2220port start/stop queue 2221~~~~~~~~~~~~~~~~~~~~~ 2222 2223Start/stop a rx/tx queue on a specific port:: 2224 2225 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop) 2226 2227port config - queue deferred start 2228~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2229 2230Switch on/off deferred start of a specific port queue:: 2231 2232 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off) 2233 2234port setup queue 2235~~~~~~~~~~~~~~~~~~~~~ 2236 2237Setup a rx/tx queue on a specific port:: 2238 2239 testpmd> port (port_id) (rxq|txq) (queue_id) setup 2240 2241Only take effect when port is started. 2242 2243port config - speed 2244~~~~~~~~~~~~~~~~~~~ 2245 2246Set the speed and duplex mode for all ports or a specific port:: 2247 2248 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|200000|auto) \ 2249 duplex (half|full|auto) 2250 2251port config - queues/descriptors 2252~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2253 2254Set number of queues/descriptors for rxq, txq, rxd and txd:: 2255 2256 testpmd> port config all (rxq|txq|rxd|txd) (value) 2257 2258This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options. 2259 2260port config - max-pkt-len 2261~~~~~~~~~~~~~~~~~~~~~~~~~ 2262 2263Set the maximum packet length:: 2264 2265 testpmd> port config all max-pkt-len (value) 2266 2267This is equivalent to the ``--max-pkt-len`` command-line option. 2268 2269port config - max-lro-pkt-size 2270~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2271 2272Set the maximum LRO aggregated packet size:: 2273 2274 testpmd> port config all max-lro-pkt-size (value) 2275 2276This is equivalent to the ``--max-lro-pkt-size`` command-line option. 2277 2278port config - Drop Packets 2279~~~~~~~~~~~~~~~~~~~~~~~~~~ 2280 2281Enable or disable packet drop on all RX queues of all ports when no receive buffers available:: 2282 2283 testpmd> port config all drop-en (on|off) 2284 2285Packet dropping when no receive buffers available is off by default. 2286 2287The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option. 2288 2289port config - RSS 2290~~~~~~~~~~~~~~~~~ 2291 2292Set the RSS (Receive Side Scaling) mode on or off:: 2293 2294 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) 2295 2296RSS is on by default. 2297 2298The ``all`` option is equivalent to eth|vlan|ip|tcp|udp|sctp|ether|l2tpv3|esp|ah|pfcp. 2299 2300The ``default`` option enables all supported RSS types reported by device info. 2301 2302The ``none`` option is equivalent to the ``--disable-rss`` command-line option. 2303 2304port config - RSS Reta 2305~~~~~~~~~~~~~~~~~~~~~~ 2306 2307Set the RSS (Receive Side Scaling) redirection table:: 2308 2309 testpmd> port config all rss reta (hash,queue)[,(hash,queue)] 2310 2311port config - DCB 2312~~~~~~~~~~~~~~~~~ 2313 2314Set the DCB mode for an individual port:: 2315 2316 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off) 2317 2318The traffic class should be 4 or 8. 2319 2320port config - Burst 2321~~~~~~~~~~~~~~~~~~~ 2322 2323Set the number of packets per burst:: 2324 2325 testpmd> port config all burst (value) 2326 2327This is equivalent to the ``--burst`` command-line option. 2328 2329port config - Threshold 2330~~~~~~~~~~~~~~~~~~~~~~~ 2331 2332Set thresholds for TX/RX queues:: 2333 2334 testpmd> port config all (threshold) (value) 2335 2336Where the threshold type can be: 2337 2338* ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255. 2339 2340* ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255. 2341 2342* ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255. 2343 2344* ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255. 2345 2346* ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255. 2347 2348* ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255. 2349 2350* ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd. 2351 2352* ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd. 2353 2354* ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd. 2355 2356These threshold options are also available from the command-line. 2357 2358port config pctype mapping 2359~~~~~~~~~~~~~~~~~~~~~~~~~~ 2360 2361Reset pctype mapping table:: 2362 2363 testpmd> port config (port_id) pctype mapping reset 2364 2365Update hardware defined pctype to software defined flow type mapping table:: 2366 2367 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id) 2368 2369where: 2370 2371* ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table. 2372 2373* ``flow_type_id``: software flow type id as the index of the pctype mapping table. 2374 2375port config input set 2376~~~~~~~~~~~~~~~~~~~~~ 2377 2378Config RSS/FDIR/FDIR flexible payload input set for some pctype:: 2379 2380 testpmd> port config (port_id) pctype (pctype_id) \ 2381 (hash_inset|fdir_inset|fdir_flx_inset) \ 2382 (get|set|clear) field (field_idx) 2383 2384Clear RSS/FDIR/FDIR flexible payload input set for some pctype:: 2385 2386 testpmd> port config (port_id) pctype (pctype_id) \ 2387 (hash_inset|fdir_inset|fdir_flx_inset) clear all 2388 2389where: 2390 2391* ``pctype_id``: hardware packet classification types. 2392* ``field_idx``: hardware field index. 2393 2394port config udp_tunnel_port 2395~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2396 2397Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols:: 2398 2399 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe|ecpri (udp_port) 2400 2401port config tx_metadata 2402~~~~~~~~~~~~~~~~~~~~~~~ 2403 2404Set Tx metadata value per port. 2405testpmd will add this value to any Tx packet sent from this port:: 2406 2407 testpmd> port config (port_id) tx_metadata (value) 2408 2409port config dynf 2410~~~~~~~~~~~~~~~~ 2411 2412Set/clear dynamic flag per port. 2413testpmd will register this flag in the mbuf (same registration 2414for both Tx and Rx). Then set/clear this flag for each Tx 2415packet sent from this port. The set bit only works for Tx packet:: 2416 2417 testpmd> port config (port_id) dynf (name) (set|clear) 2418 2419port config mtu 2420~~~~~~~~~~~~~~~ 2421 2422To configure MTU(Maximum Transmission Unit) on devices using testpmd:: 2423 2424 testpmd> port config mtu (port_id) (value) 2425 2426port config rss hash key 2427~~~~~~~~~~~~~~~~~~~~~~~~ 2428 2429To configure the RSS hash key used to compute the RSS 2430hash of input [IP] packets received on port:: 2431 2432 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\ 2433 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\ 2434 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\ 2435 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\ 2436 ipv6-udp-ex <string of hex digits \ 2437 (variable length, NIC dependent)>) 2438 2439Device Functions 2440---------------- 2441 2442The following sections show functions for device operations. 2443 2444device detach 2445~~~~~~~~~~~~~ 2446 2447Detach a device specified by pci address or virtual device args:: 2448 2449 testpmd> device detach (identifier) 2450 2451Before detaching a device associated with ports, the ports should be stopped and closed. 2452 2453For example, to detach a pci device whose address is 0002:03:00.0. 2454 2455.. code-block:: console 2456 2457 testpmd> device detach 0002:03:00.0 2458 Removing a device... 2459 Port 1 is now closed 2460 EAL: Releasing pci mapped resource for 0002:03:00.0 2461 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000 2462 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000 2463 Device 0002:03:00.0 is detached 2464 Now total ports is 1 2465 2466For example, to detach a port created by pcap PMD. 2467 2468.. code-block:: console 2469 2470 testpmd> device detach net_pcap0 2471 Removing a device... 2472 Port 0 is now closed 2473 Device net_pcap0 is detached 2474 Now total ports is 0 2475 Done 2476 2477In this case, identifier is ``net_pcap0``. 2478This identifier format is the same as ``--vdev`` format of DPDK applications. 2479 2480Link Bonding Functions 2481---------------------- 2482 2483The Link Bonding functions make it possible to dynamically create and 2484manage link bonding devices from within testpmd interactive prompt. 2485 2486create bonded device 2487~~~~~~~~~~~~~~~~~~~~ 2488 2489Create a new bonding device:: 2490 2491 testpmd> create bonded device (mode) (socket) 2492 2493For example, to create a bonded device in mode 1 on socket 0:: 2494 2495 testpmd> create bonded device 1 0 2496 created new bonded device (port X) 2497 2498add bonding slave 2499~~~~~~~~~~~~~~~~~ 2500 2501Adds Ethernet device to a Link Bonding device:: 2502 2503 testpmd> add bonding slave (slave id) (port id) 2504 2505For example, to add Ethernet device (port 6) to a Link Bonding device (port 10):: 2506 2507 testpmd> add bonding slave 6 10 2508 2509 2510remove bonding slave 2511~~~~~~~~~~~~~~~~~~~~ 2512 2513Removes an Ethernet slave device from a Link Bonding device:: 2514 2515 testpmd> remove bonding slave (slave id) (port id) 2516 2517For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10):: 2518 2519 testpmd> remove bonding slave 6 10 2520 2521set bonding mode 2522~~~~~~~~~~~~~~~~ 2523 2524Set the Link Bonding mode of a Link Bonding device:: 2525 2526 testpmd> set bonding mode (value) (port id) 2527 2528For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3):: 2529 2530 testpmd> set bonding mode 3 10 2531 2532set bonding primary 2533~~~~~~~~~~~~~~~~~~~ 2534 2535Set an Ethernet slave device as the primary device on a Link Bonding device:: 2536 2537 testpmd> set bonding primary (slave id) (port id) 2538 2539For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10):: 2540 2541 testpmd> set bonding primary 6 10 2542 2543set bonding mac 2544~~~~~~~~~~~~~~~ 2545 2546Set the MAC address of a Link Bonding device:: 2547 2548 testpmd> set bonding mac (port id) (mac) 2549 2550For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01:: 2551 2552 testpmd> set bonding mac 10 00:00:00:00:00:01 2553 2554set bonding balance_xmit_policy 2555~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2556 2557Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:: 2558 2559 testpmd> set bonding balance_xmit_policy (port_id) (l2|l23|l34) 2560 2561For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports):: 2562 2563 testpmd> set bonding balance_xmit_policy 10 l34 2564 2565 2566set bonding mon_period 2567~~~~~~~~~~~~~~~~~~~~~~ 2568 2569Set the link status monitoring polling period in milliseconds for a bonding device. 2570 2571This adds support for PMD slave devices which do not support link status interrupts. 2572When the mon_period is set to a value greater than 0 then all PMD's which do not support 2573link status ISR will be queried every polling interval to check if their link status has changed:: 2574 2575 testpmd> set bonding mon_period (port_id) (value) 2576 2577For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms:: 2578 2579 testpmd> set bonding mon_period 5 150 2580 2581 2582set bonding lacp dedicated_queue 2583~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2584 2585Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic 2586when in mode 4 (link-aggregation-802.3ad):: 2587 2588 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable) 2589 2590 2591set bonding agg_mode 2592~~~~~~~~~~~~~~~~~~~~ 2593 2594Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad):: 2595 2596 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable) 2597 2598 2599show bonding config 2600~~~~~~~~~~~~~~~~~~~ 2601 2602Show the current configuration of a Link Bonding device:: 2603 2604 testpmd> show bonding config (port id) 2605 2606For example, 2607to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4) 2608in balance mode with a transmission policy of layer 2+3:: 2609 2610 testpmd> show bonding config 9 2611 Bonding mode: 2 2612 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23 2613 Slaves (3): [1 3 4] 2614 Active Slaves (3): [1 3 4] 2615 Primary: [3] 2616 2617 2618Register Functions 2619------------------ 2620 2621The Register Functions can be used to read from and write to registers on the network card referenced by a port number. 2622This is mainly useful for debugging purposes. 2623Reference should be made to the appropriate datasheet for the network card for details on the register addresses 2624and fields that can be accessed. 2625 2626read reg 2627~~~~~~~~ 2628 2629Display the value of a port register:: 2630 2631 testpmd> read reg (port_id) (address) 2632 2633For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller:: 2634 2635 testpmd> read reg 0 0xEE00 2636 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241) 2637 2638read regfield 2639~~~~~~~~~~~~~ 2640 2641Display a port register bit field:: 2642 2643 testpmd> read regfield (port_id) (address) (bit_x) (bit_y) 2644 2645For example, reading the lowest two bits from the register in the example above:: 2646 2647 testpmd> read regfield 0 0xEE00 0 1 2648 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1) 2649 2650read regbit 2651~~~~~~~~~~~ 2652 2653Display a single port register bit:: 2654 2655 testpmd> read regbit (port_id) (address) (bit_x) 2656 2657For example, reading the lowest bit from the register in the example above:: 2658 2659 testpmd> read regbit 0 0xEE00 0 2660 port 0 PCI register at offset 0xEE00: bit 0=1 2661 2662write reg 2663~~~~~~~~~ 2664 2665Set the value of a port register:: 2666 2667 testpmd> write reg (port_id) (address) (value) 2668 2669For example, to clear a register:: 2670 2671 testpmd> write reg 0 0xEE00 0x0 2672 port 0 PCI register at offset 0xEE00: 0x00000000 (0) 2673 2674write regfield 2675~~~~~~~~~~~~~~ 2676 2677Set bit field of a port register:: 2678 2679 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value) 2680 2681For example, writing to the register cleared in the example above:: 2682 2683 testpmd> write regfield 0 0xEE00 0 1 2 2684 port 0 PCI register at offset 0xEE00: 0x00000002 (2) 2685 2686write regbit 2687~~~~~~~~~~~~ 2688 2689Set single bit value of a port register:: 2690 2691 testpmd> write regbit (port_id) (address) (bit_x) (value) 2692 2693For example, to set the high bit in the register from the example above:: 2694 2695 testpmd> write regbit 0 0xEE00 31 1 2696 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658) 2697 2698Traffic Metering and Policing 2699----------------------------- 2700 2701The following section shows functions for configuring traffic metering and 2702policing on the ethernet device through the use of generic ethdev API. 2703 2704show port traffic management capability 2705~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2706 2707Show traffic metering and policing capability of the port:: 2708 2709 testpmd> show port meter cap (port_id) 2710 2711add port meter profile (srTCM rfc2967) 2712~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2713 2714Add meter profile (srTCM rfc2697) to the ethernet device:: 2715 2716 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \ 2717 (cir) (cbs) (ebs) (packet_mode) 2718 2719where: 2720 2721* ``profile_id``: ID for the meter profile. 2722* ``cir``: Committed Information Rate (CIR) (bytes per second or packets per second). 2723* ``cbs``: Committed Burst Size (CBS) (bytes or packets). 2724* ``ebs``: Excess Burst Size (EBS) (bytes or packets). 2725* ``packet_mode``: Packets mode for meter profile. 2726 2727add port meter profile (trTCM rfc2968) 2728~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2729 2730Add meter profile (srTCM rfc2698) to the ethernet device:: 2731 2732 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \ 2733 (cir) (pir) (cbs) (pbs) (packet_mode) 2734 2735where: 2736 2737* ``profile_id``: ID for the meter profile. 2738* ``cir``: Committed information rate (bytes per second or packets per second). 2739* ``pir``: Peak information rate (bytes per second or packets per second). 2740* ``cbs``: Committed burst size (bytes or packets). 2741* ``pbs``: Peak burst size (bytes or packets). 2742* ``packet_mode``: Packets mode for meter profile. 2743 2744add port meter profile (trTCM rfc4115) 2745~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2746 2747Add meter profile (trTCM rfc4115) to the ethernet device:: 2748 2749 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \ 2750 (cir) (eir) (cbs) (ebs) (packet_mode) 2751 2752where: 2753 2754* ``profile_id``: ID for the meter profile. 2755* ``cir``: Committed information rate (bytes per second or packets per second). 2756* ``eir``: Excess information rate (bytes per second or packets per second). 2757* ``cbs``: Committed burst size (bytes or packets). 2758* ``ebs``: Excess burst size (bytes or packets). 2759* ``packet_mode``: Packets mode for meter profile. 2760 2761delete port meter profile 2762~~~~~~~~~~~~~~~~~~~~~~~~~ 2763 2764Delete meter profile from the ethernet device:: 2765 2766 testpmd> del port meter profile (port_id) (profile_id) 2767 2768create port meter 2769~~~~~~~~~~~~~~~~~ 2770 2771Create new meter object for the ethernet device:: 2772 2773 testpmd> create port meter (port_id) (mtr_id) (profile_id) \ 2774 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \ 2775 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\ 2776 (dscp_tbl_entry63)] 2777 2778where: 2779 2780* ``mtr_id``: meter object ID. 2781* ``profile_id``: ID for the meter profile. 2782* ``meter_enable``: When this parameter has a non-zero value, the meter object 2783 gets enabled at the time of creation, otherwise remains disabled. 2784* ``g_action``: Policer action for the packet with green color. 2785* ``y_action``: Policer action for the packet with yellow color. 2786* ``r_action``: Policer action for the packet with red color. 2787* ``stats_mask``: Mask of statistics counter types to be enabled for the 2788 meter object. 2789* ``shared``: When this parameter has a non-zero value, the meter object is 2790 shared by multiple flows. Otherwise, meter object is used by single flow. 2791* ``use_pre_meter_color``: When this parameter has a non-zero value, the 2792 input color for the current meter object is determined by the latest meter 2793 object in the same flow. Otherwise, the current meter object uses the 2794 *dscp_table* to determine the input color. 2795* ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input 2796 color, 0 <= x <= 63. 2797 2798enable port meter 2799~~~~~~~~~~~~~~~~~ 2800 2801Enable meter for the ethernet device:: 2802 2803 testpmd> enable port meter (port_id) (mtr_id) 2804 2805disable port meter 2806~~~~~~~~~~~~~~~~~~ 2807 2808Disable meter for the ethernet device:: 2809 2810 testpmd> disable port meter (port_id) (mtr_id) 2811 2812delete port meter 2813~~~~~~~~~~~~~~~~~ 2814 2815Delete meter for the ethernet device:: 2816 2817 testpmd> del port meter (port_id) (mtr_id) 2818 2819Set port meter profile 2820~~~~~~~~~~~~~~~~~~~~~~ 2821 2822Set meter profile for the ethernet device:: 2823 2824 testpmd> set port meter profile (port_id) (mtr_id) (profile_id) 2825 2826set port meter dscp table 2827~~~~~~~~~~~~~~~~~~~~~~~~~ 2828 2829Set meter dscp table for the ethernet device:: 2830 2831 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \ 2832 (dscp_tbl_entry1)...(dscp_tbl_entry63)] 2833 2834set port meter policer action 2835~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2836 2837Set meter policer action for the ethernet device:: 2838 2839 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \ 2840 (action0) [(action1) (action1)] 2841 2842where: 2843 2844* ``action_mask``: Bit mask indicating which policer actions need to be 2845 updated. One or more policer actions can be updated in a single function 2846 invocation. To update the policer action associated with color C, bit 2847 (1 << C) needs to be set in *action_mask* and element at position C 2848 in the *actions* array needs to be valid. 2849* ``actionx``: Policer action for the color x, 2850 RTE_MTR_GREEN <= x < RTE_MTR_COLORS 2851 2852set port meter stats mask 2853~~~~~~~~~~~~~~~~~~~~~~~~~ 2854 2855Set meter stats mask for the ethernet device:: 2856 2857 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask) 2858 2859where: 2860 2861* ``stats_mask``: Bit mask indicating statistics counter types to be enabled. 2862 2863show port meter stats 2864~~~~~~~~~~~~~~~~~~~~~ 2865 2866Show meter stats of the ethernet device:: 2867 2868 testpmd> show port meter stats (port_id) (mtr_id) (clear) 2869 2870where: 2871 2872* ``clear``: Flag that indicates whether the statistics counters should 2873 be cleared (i.e. set to zero) immediately after they have been read or not. 2874 2875Traffic Management 2876------------------ 2877 2878The following section shows functions for configuring traffic management on 2879the ethernet device through the use of generic TM API. 2880 2881show port traffic management capability 2882~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2883 2884Show traffic management capability of the port:: 2885 2886 testpmd> show port tm cap (port_id) 2887 2888show port traffic management capability (hierarchy level) 2889~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2890 2891Show traffic management hierarchy level capability of the port:: 2892 2893 testpmd> show port tm level cap (port_id) (level_id) 2894 2895show port traffic management capability (hierarchy node level) 2896~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2897 2898Show the traffic management hierarchy node capability of the port:: 2899 2900 testpmd> show port tm node cap (port_id) (node_id) 2901 2902show port traffic management hierarchy node type 2903~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2904 2905Show the port traffic management hierarchy node type:: 2906 2907 testpmd> show port tm node type (port_id) (node_id) 2908 2909show port traffic management hierarchy node stats 2910~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2911 2912Show the port traffic management hierarchy node statistics:: 2913 2914 testpmd> show port tm node stats (port_id) (node_id) (clear) 2915 2916where: 2917 2918* ``clear``: When this parameter has a non-zero value, the statistics counters 2919 are cleared (i.e. set to zero) immediately after they have been read, 2920 otherwise the statistics counters are left untouched. 2921 2922Add port traffic management private shaper profile 2923~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2924 2925Add the port traffic management private shaper profile:: 2926 2927 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \ 2928 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \ 2929 (packet_length_adjust) (packet_mode) 2930 2931where: 2932 2933* ``shaper_profile id``: Shaper profile ID for the new profile. 2934* ``cmit_tb_rate``: Committed token bucket rate (bytes per second or packets per second). 2935* ``cmit_tb_size``: Committed token bucket size (bytes or packets). 2936* ``peak_tb_rate``: Peak token bucket rate (bytes per second or packets per second). 2937* ``peak_tb_size``: Peak token bucket size (bytes or packets). 2938* ``packet_length_adjust``: The value (bytes) to be added to the length of 2939 each packet for the purpose of shaping. This parameter value can be used to 2940 correct the packet length with the framing overhead bytes that are consumed 2941 on the wire. 2942* ``packet_mode``: Shaper configured in packet mode. This parameter value if 2943 zero, configures shaper in byte mode and if non-zero configures it in packet 2944 mode. 2945 2946Delete port traffic management private shaper profile 2947~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2948 2949Delete the port traffic management private shaper:: 2950 2951 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id) 2952 2953where: 2954 2955* ``shaper_profile id``: Shaper profile ID that needs to be deleted. 2956 2957Add port traffic management shared shaper 2958~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2959 2960Create the port traffic management shared shaper:: 2961 2962 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \ 2963 (shaper_profile_id) 2964 2965where: 2966 2967* ``shared_shaper_id``: Shared shaper ID to be created. 2968* ``shaper_profile id``: Shaper profile ID for shared shaper. 2969 2970Set port traffic management shared shaper 2971~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2972 2973Update the port traffic management shared shaper:: 2974 2975 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \ 2976 (shaper_profile_id) 2977 2978where: 2979 2980* ``shared_shaper_id``: Shared shaper ID to be update. 2981* ``shaper_profile id``: Shaper profile ID for shared shaper. 2982 2983Delete port traffic management shared shaper 2984~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2985 2986Delete the port traffic management shared shaper:: 2987 2988 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id) 2989 2990where: 2991 2992* ``shared_shaper_id``: Shared shaper ID to be deleted. 2993 2994Set port traffic management hierarchy node private shaper 2995~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2996 2997set the port traffic management hierarchy node private shaper:: 2998 2999 testpmd> set port tm node shaper profile (port_id) (node_id) \ 3000 (shaper_profile_id) 3001 3002where: 3003 3004* ``shaper_profile id``: Private shaper profile ID to be enabled on the 3005 hierarchy node. 3006 3007Add port traffic management WRED profile 3008~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3009 3010Create a new WRED profile:: 3011 3012 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \ 3013 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \ 3014 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \ 3015 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r) 3016 3017where: 3018 3019* ``wred_profile id``: Identifier for the newly create WRED profile 3020* ``color_g``: Packet color (green) 3021* ``min_th_g``: Minimum queue threshold for packet with green color 3022* ``max_th_g``: Minimum queue threshold for packet with green color 3023* ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp) 3024* ``wq_log2_g``: Negated log2 of queue weight (wq) 3025* ``color_y``: Packet color (yellow) 3026* ``min_th_y``: Minimum queue threshold for packet with yellow color 3027* ``max_th_y``: Minimum queue threshold for packet with yellow color 3028* ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp) 3029* ``wq_log2_y``: Negated log2 of queue weight (wq) 3030* ``color_r``: Packet color (red) 3031* ``min_th_r``: Minimum queue threshold for packet with yellow color 3032* ``max_th_r``: Minimum queue threshold for packet with yellow color 3033* ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp) 3034* ``wq_log2_r``: Negated log2 of queue weight (wq) 3035 3036Delete port traffic management WRED profile 3037~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3038 3039Delete the WRED profile:: 3040 3041 testpmd> del port tm node wred profile (port_id) (wred_profile_id) 3042 3043Add port traffic management hierarchy nonleaf node 3044~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3045 3046Add nonleaf node to port traffic management hierarchy:: 3047 3048 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \ 3049 (priority) (weight) (level_id) (shaper_profile_id) \ 3050 (n_sp_priorities) (stats_mask) (n_shared_shapers) \ 3051 [(shared_shaper_0) (shared_shaper_1) ...] \ 3052 3053where: 3054 3055* ``parent_node_id``: Node ID of the parent. 3056* ``priority``: Node priority (highest node priority is zero). This is used by 3057 the SP algorithm running on the parent node for scheduling this node. 3058* ``weight``: Node weight (lowest weight is one). The node weight is relative 3059 to the weight sum of all siblings that have the same priority. It is used by 3060 the WFQ algorithm running on the parent node for scheduling this node. 3061* ``level_id``: Hierarchy level of the node. 3062* ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by 3063 the node. 3064* ``n_sp_priorities``: Number of strict priorities. 3065* ``stats_mask``: Mask of statistics counter types to be enabled for this node. 3066* ``n_shared_shapers``: Number of shared shapers. 3067* ``shared_shaper_id``: Shared shaper id. 3068 3069Add port traffic management hierarchy nonleaf node with packet mode 3070~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3071 3072Add nonleaf node with packet mode to port traffic management hierarchy:: 3073 3074 testpmd> add port tm nonleaf node pktmode (port_id) (node_id) (parent_node_id) \ 3075 (priority) (weight) (level_id) (shaper_profile_id) \ 3076 (n_sp_priorities) (stats_mask) (n_shared_shapers) \ 3077 [(shared_shaper_0) (shared_shaper_1) ...] \ 3078 3079where: 3080 3081* ``parent_node_id``: Node ID of the parent. 3082* ``priority``: Node priority (highest node priority is zero). This is used by 3083 the SP algorithm running on the parent node for scheduling this node. 3084* ``weight``: Node weight (lowest weight is one). The node weight is relative 3085 to the weight sum of all siblings that have the same priority. It is used by 3086 the WFQ algorithm running on the parent node for scheduling this node. 3087* ``level_id``: Hierarchy level of the node. 3088* ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by 3089 the node. 3090* ``n_sp_priorities``: Number of strict priorities. Packet mode is enabled on 3091 all of them. 3092* ``stats_mask``: Mask of statistics counter types to be enabled for this node. 3093* ``n_shared_shapers``: Number of shared shapers. 3094* ``shared_shaper_id``: Shared shaper id. 3095 3096Add port traffic management hierarchy leaf node 3097~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3098 3099Add leaf node to port traffic management hierarchy:: 3100 3101 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \ 3102 (priority) (weight) (level_id) (shaper_profile_id) \ 3103 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \ 3104 [(shared_shaper_id) (shared_shaper_id) ...] \ 3105 3106where: 3107 3108* ``parent_node_id``: Node ID of the parent. 3109* ``priority``: Node priority (highest node priority is zero). This is used by 3110 the SP algorithm running on the parent node for scheduling this node. 3111* ``weight``: Node weight (lowest weight is one). The node weight is relative 3112 to the weight sum of all siblings that have the same priority. It is used by 3113 the WFQ algorithm running on the parent node for scheduling this node. 3114* ``level_id``: Hierarchy level of the node. 3115* ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by 3116 the node. 3117* ``cman_mode``: Congestion management mode to be enabled for this node. 3118* ``wred_profile_id``: WRED profile id to be enabled for this node. 3119* ``stats_mask``: Mask of statistics counter types to be enabled for this node. 3120* ``n_shared_shapers``: Number of shared shapers. 3121* ``shared_shaper_id``: Shared shaper id. 3122 3123Delete port traffic management hierarchy node 3124~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3125 3126Delete node from port traffic management hierarchy:: 3127 3128 testpmd> del port tm node (port_id) (node_id) 3129 3130Update port traffic management hierarchy parent node 3131~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3132 3133Update port traffic management hierarchy parent node:: 3134 3135 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \ 3136 (priority) (weight) 3137 3138This function can only be called after the hierarchy commit invocation. Its 3139success depends on the port support for this operation, as advertised through 3140the port capability set. This function is valid for all nodes of the traffic 3141management hierarchy except root node. 3142 3143Suspend port traffic management hierarchy node 3144~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3145 3146 testpmd> suspend port tm node (port_id) (node_id) 3147 3148Resume port traffic management hierarchy node 3149~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3150 3151 testpmd> resume port tm node (port_id) (node_id) 3152 3153Commit port traffic management hierarchy 3154~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3155 3156Commit the traffic management hierarchy on the port:: 3157 3158 testpmd> port tm hierarchy commit (port_id) (clean_on_fail) 3159 3160where: 3161 3162* ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function 3163 call failure. On the other hand, hierarchy is preserved when this parameter 3164 is equal to zero. 3165 3166Set port traffic management mark VLAN dei 3167~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3168 3169Enables/Disables the traffic management marking on the port for VLAN packets:: 3170 3171 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red> 3172 3173where: 3174 3175* ``port_id``: The port which on which VLAN packets marked as ``green`` or 3176 ``yellow`` or ``red`` will have dei bit enabled 3177 3178* ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green 3179 3180* ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow 3181 3182* ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red 3183 3184Set port traffic management mark IP dscp 3185~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3186 3187Enables/Disables the traffic management marking on the port for IP dscp packets:: 3188 3189 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red> 3190 3191where: 3192 3193* ``port_id``: The port which on which IP packets marked as ``green`` or 3194 ``yellow`` or ``red`` will have IP dscp bits updated 3195 3196* ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets 3197 3198* ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets 3199 3200* ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets 3201 3202Set port traffic management mark IP ecn 3203~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3204 3205Enables/Disables the traffic management marking on the port for IP ecn packets:: 3206 3207 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red> 3208 3209where: 3210 3211* ``port_id``: The port which on which IP packets marked as ``green`` or 3212 ``yellow`` or ``red`` will have IP ecn bits updated 3213 3214* ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10 3215 to ecn of 2'b11 when IP is caring TCP or SCTP 3216 3217* ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10 3218 to ecn of 2'b11 when IP is caring TCP or SCTP 3219 3220* ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10 3221 to ecn of 2'b11 when IP is caring TCP or SCTP 3222 3223Filter Functions 3224---------------- 3225 3226This section details the available filter functions that are available. 3227 3228Note these functions interface the deprecated legacy filtering framework, 3229superseded by *rte_flow*. See `Flow rules management`_. 3230 3231.. _testpmd_flow_director: 3232 3233flow_director_mask 3234~~~~~~~~~~~~~~~~~~ 3235 3236Set flow director's input masks:: 3237 3238 flow_director_mask (port_id) mode IP vlan (vlan_value) \ 3239 src_mask (ipv4_src) (ipv6_src) (src_port) \ 3240 dst_mask (ipv4_dst) (ipv6_dst) (dst_port) 3241 3242 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) 3243 3244 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \ 3245 mac (mac_value) tunnel-type (tunnel_type_value) \ 3246 tunnel-id (tunnel_id_value) 3247 3248Example, to set flow director mask on port 0:: 3249 3250 testpmd> flow_director_mask 0 mode IP vlan 0xefff \ 3251 src_mask 255.255.255.255 \ 3252 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \ 3253 dst_mask 255.255.255.255 \ 3254 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF 3255 3256flow_director_flex_payload 3257~~~~~~~~~~~~~~~~~~~~~~~~~~ 3258 3259Configure flexible payload selection:: 3260 3261 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config) 3262 3263For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload:: 3264 3265 testpmd> flow_director_flex_payload 0 l4 \ 3266 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19) 3267 3268 3269.. _testpmd_rte_flow: 3270 3271Flow rules management 3272--------------------- 3273 3274Control of the generic flow API (*rte_flow*) is fully exposed through the 3275``flow`` command (validation, creation, destruction, queries and operation 3276modes). 3277 3278Considering *rte_flow* overlaps with all `Filter Functions`_, using both 3279features simultaneously may cause undefined side-effects and is therefore 3280not recommended. 3281 3282``flow`` syntax 3283~~~~~~~~~~~~~~~ 3284 3285Because the ``flow`` command uses dynamic tokens to handle the large number 3286of possible flow rules combinations, its behavior differs slightly from 3287other commands, in particular: 3288 3289- Pressing *?* or the *<tab>* key displays contextual help for the current 3290 token, not that of the entire command. 3291 3292- Optional and repeated parameters are supported (provided they are listed 3293 in the contextual help). 3294 3295The first parameter stands for the operation mode. Possible operations and 3296their general syntax are described below. They are covered in detail in the 3297following sections. 3298 3299- Check whether a flow rule can be created:: 3300 3301 flow validate {port_id} 3302 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3303 pattern {item} [/ {item} [...]] / end 3304 actions {action} [/ {action} [...]] / end 3305 3306- Create a flow rule:: 3307 3308 flow create {port_id} 3309 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3310 pattern {item} [/ {item} [...]] / end 3311 actions {action} [/ {action} [...]] / end 3312 3313- Destroy specific flow rules:: 3314 3315 flow destroy {port_id} rule {rule_id} [...] 3316 3317- Destroy all flow rules:: 3318 3319 flow flush {port_id} 3320 3321- Query an existing flow rule:: 3322 3323 flow query {port_id} {rule_id} {action} 3324 3325- List existing flow rules sorted by priority, filtered by group 3326 identifiers:: 3327 3328 flow list {port_id} [group {group_id}] [...] 3329 3330- Restrict ingress traffic to the defined flow rules:: 3331 3332 flow isolate {port_id} {boolean} 3333 3334- Dump internal representation information of all flows in hardware:: 3335 3336 flow dump {port_id} all {output_file} 3337 3338 for one flow:: 3339 3340 flow dump {port_id} rule {rule_id} {output_file} 3341 3342- List and destroy aged flow rules:: 3343 3344 flow aged {port_id} [destroy] 3345 3346- Tunnel offload - create a tunnel stub:: 3347 3348 flow tunnel create {port_id} type {tunnel_type} 3349 3350- Tunnel offload - destroy a tunnel stub:: 3351 3352 flow tunnel destroy {port_id} id {tunnel_id} 3353 3354- Tunnel offload - list port tunnel stubs:: 3355 3356 flow tunnel list {port_id} 3357 3358Creating a tunnel stub for offload 3359~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3360 3361``flow tunnel create`` setup a tunnel stub for tunnel offload flow rules:: 3362 3363 flow tunnel create {port_id} type {tunnel_type} 3364 3365If successful, it will return a tunnel stub ID usable with other commands:: 3366 3367 port [...]: flow tunnel #[...] type [...] 3368 3369Tunnel stub ID is relative to a port. 3370 3371Destroying tunnel offload stub 3372~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3373 3374``flow tunnel destroy`` destroy port tunnel stub:: 3375 3376 flow tunnel destroy {port_id} id {tunnel_id} 3377 3378Listing tunnel offload stubs 3379~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3380 3381``flow tunnel list`` list port tunnel offload stubs:: 3382 3383 flow tunnel list {port_id} 3384 3385Validating flow rules 3386~~~~~~~~~~~~~~~~~~~~~ 3387 3388``flow validate`` reports whether a flow rule would be accepted by the 3389underlying device in its current state but stops short of creating it. It is 3390bound to ``rte_flow_validate()``:: 3391 3392 flow validate {port_id} 3393 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3394 pattern {item} [/ {item} [...]] / end 3395 actions {action} [/ {action} [...]] / end 3396 3397If successful, it will show:: 3398 3399 Flow rule validated 3400 3401Otherwise it will show an error message of the form:: 3402 3403 Caught error type [...] ([...]): [...] 3404 3405This command uses the same parameters as ``flow create``, their format is 3406described in `Creating flow rules`_. 3407 3408Check whether redirecting any Ethernet packet received on port 0 to RX queue 3409index 6 is supported:: 3410 3411 testpmd> flow validate 0 ingress pattern eth / end 3412 actions queue index 6 / end 3413 Flow rule validated 3414 testpmd> 3415 3416Port 0 does not support TCPv6 rules:: 3417 3418 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end 3419 actions drop / end 3420 Caught error type 9 (specific pattern item): Invalid argument 3421 testpmd> 3422 3423Creating flow rules 3424~~~~~~~~~~~~~~~~~~~ 3425 3426``flow create`` validates and creates the specified flow rule. It is bound 3427to ``rte_flow_create()``:: 3428 3429 flow create {port_id} 3430 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3431 [tunnel_set {tunnel_id}] [tunnel_match {tunnel_id}] 3432 pattern {item} [/ {item} [...]] / end 3433 actions {action} [/ {action} [...]] / end 3434 3435If successful, it will return a flow rule ID usable with other commands:: 3436 3437 Flow rule #[...] created 3438 3439Otherwise it will show an error message of the form:: 3440 3441 Caught error type [...] ([...]): [...] 3442 3443Parameters describe in the following order: 3444 3445- Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens). 3446- Tunnel offload specification (tunnel_set, tunnel_match) 3447- A matching pattern, starting with the *pattern* token and terminated by an 3448 *end* pattern item. 3449- Actions, starting with the *actions* token and terminated by an *end* 3450 action. 3451 3452These translate directly to *rte_flow* objects provided as-is to the 3453underlying functions. 3454 3455The shortest valid definition only comprises mandatory tokens:: 3456 3457 testpmd> flow create 0 pattern end actions end 3458 3459Note that PMDs may refuse rules that essentially do nothing such as this 3460one. 3461 3462**All unspecified object values are automatically initialized to 0.** 3463 3464Attributes 3465^^^^^^^^^^ 3466 3467These tokens affect flow rule attributes (``struct rte_flow_attr``) and are 3468specified before the ``pattern`` token. 3469 3470- ``group {group id}``: priority group. 3471- ``priority {level}``: priority level within group. 3472- ``ingress``: rule applies to ingress traffic. 3473- ``egress``: rule applies to egress traffic. 3474- ``transfer``: apply rule directly to endpoints found in pattern. 3475 3476Each instance of an attribute specified several times overrides the previous 3477value as shown below (group 4 is used):: 3478 3479 testpmd> flow create 0 group 42 group 24 group 4 [...] 3480 3481Note that once enabled, ``ingress`` and ``egress`` cannot be disabled. 3482 3483While not specifying a direction is an error, some rules may allow both 3484simultaneously. 3485 3486Most rules affect RX therefore contain the ``ingress`` token:: 3487 3488 testpmd> flow create 0 ingress pattern [...] 3489 3490Tunnel offload 3491^^^^^^^^^^^^^^ 3492 3493Indicate tunnel offload rule type 3494 3495- ``tunnel_set {tunnel_id}``: mark rule as tunnel offload decap_set type. 3496- ``tunnel_match {tunnel_id}``: mark rule as tunel offload match type. 3497 3498Matching pattern 3499^^^^^^^^^^^^^^^^ 3500 3501A matching pattern starts after the ``pattern`` token. It is made of pattern 3502items and is terminated by a mandatory ``end`` item. 3503 3504Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum 3505rte_flow_item_type``). 3506 3507The ``/`` token is used as a separator between pattern items as shown 3508below:: 3509 3510 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...] 3511 3512Note that protocol items like these must be stacked from lowest to highest 3513layer to make sense. For instance, the following rule is either invalid or 3514unlikely to match any packet:: 3515 3516 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...] 3517 3518More information on these restrictions can be found in the *rte_flow* 3519documentation. 3520 3521Several items support additional specification structures, for example 3522``ipv4`` allows specifying source and destination addresses as follows:: 3523 3524 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1 3525 dst is 10.2.0.0 / end [...] 3526 3527This rule matches all IPv4 traffic with the specified properties. 3528 3529In this example, ``src`` and ``dst`` are field names of the underlying 3530``struct rte_flow_item_ipv4`` object. All item properties can be specified 3531in a similar fashion. 3532 3533The ``is`` token means that the subsequent value must be matched exactly, 3534and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item`` 3535accordingly. Possible assignment tokens are: 3536 3537- ``is``: match value perfectly (with full bit-mask). 3538- ``spec``: match value according to configured bit-mask. 3539- ``last``: specify upper bound to establish a range. 3540- ``mask``: specify bit-mask with relevant bits set to one. 3541- ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one. 3542 3543These yield identical results:: 3544 3545 ipv4 src is 10.1.1.1 3546 3547:: 3548 3549 ipv4 src spec 10.1.1.1 src mask 255.255.255.255 3550 3551:: 3552 3553 ipv4 src spec 10.1.1.1 src prefix 32 3554 3555:: 3556 3557 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value 3558 3559:: 3560 3561 ipv4 src is 10.1.1.1 src last 0 # 0 disables range 3562 3563Inclusive ranges can be defined with ``last``:: 3564 3565 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4 3566 3567Note that ``mask`` affects both ``spec`` and ``last``:: 3568 3569 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0 3570 # matches 10.1.0.0 to 10.2.255.255 3571 3572Properties can be modified multiple times:: 3573 3574 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4 3575 3576:: 3577 3578 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16 3579 3580Pattern items 3581^^^^^^^^^^^^^ 3582 3583This section lists supported pattern items and their attributes, if any. 3584 3585- ``end``: end list of pattern items. 3586 3587- ``void``: no-op pattern item. 3588 3589- ``invert``: perform actions when pattern does not match. 3590 3591- ``any``: match any protocol for the current layer. 3592 3593 - ``num {unsigned}``: number of layers covered. 3594 3595- ``pf``: match traffic from/to the physical function. 3596 3597- ``vf``: match traffic from/to a virtual function ID. 3598 3599 - ``id {unsigned}``: VF ID. 3600 3601- ``phy_port``: match traffic from/to a specific physical port. 3602 3603 - ``index {unsigned}``: physical port index. 3604 3605- ``port_id``: match traffic from/to a given DPDK port ID. 3606 3607 - ``id {unsigned}``: DPDK port ID. 3608 3609- ``mark``: match value set in previously matched flow rule using the mark action. 3610 3611 - ``id {unsigned}``: arbitrary integer value. 3612 3613- ``raw``: match an arbitrary byte string. 3614 3615 - ``relative {boolean}``: look for pattern after the previous item. 3616 - ``search {boolean}``: search pattern from offset (see also limit). 3617 - ``offset {integer}``: absolute or relative offset for pattern. 3618 - ``limit {unsigned}``: search area limit for start of pattern. 3619 - ``pattern {string}``: byte string to look for. 3620 3621- ``eth``: match Ethernet header. 3622 3623 - ``dst {MAC-48}``: destination MAC. 3624 - ``src {MAC-48}``: source MAC. 3625 - ``type {unsigned}``: EtherType or TPID. 3626 3627- ``vlan``: match 802.1Q/ad VLAN tag. 3628 3629 - ``tci {unsigned}``: tag control information. 3630 - ``pcp {unsigned}``: priority code point. 3631 - ``dei {unsigned}``: drop eligible indicator. 3632 - ``vid {unsigned}``: VLAN identifier. 3633 - ``inner_type {unsigned}``: inner EtherType or TPID. 3634 3635- ``ipv4``: match IPv4 header. 3636 3637 - ``tos {unsigned}``: type of service. 3638 - ``ttl {unsigned}``: time to live. 3639 - ``proto {unsigned}``: next protocol ID. 3640 - ``src {ipv4 address}``: source address. 3641 - ``dst {ipv4 address}``: destination address. 3642 3643- ``ipv6``: match IPv6 header. 3644 3645 - ``tc {unsigned}``: traffic class. 3646 - ``flow {unsigned}``: flow label. 3647 - ``proto {unsigned}``: protocol (next header). 3648 - ``hop {unsigned}``: hop limit. 3649 - ``src {ipv6 address}``: source address. 3650 - ``dst {ipv6 address}``: destination address. 3651 3652- ``icmp``: match ICMP header. 3653 3654 - ``type {unsigned}``: ICMP packet type. 3655 - ``code {unsigned}``: ICMP packet code. 3656 3657- ``udp``: match UDP header. 3658 3659 - ``src {unsigned}``: UDP source port. 3660 - ``dst {unsigned}``: UDP destination port. 3661 3662- ``tcp``: match TCP header. 3663 3664 - ``src {unsigned}``: TCP source port. 3665 - ``dst {unsigned}``: TCP destination port. 3666 3667- ``sctp``: match SCTP header. 3668 3669 - ``src {unsigned}``: SCTP source port. 3670 - ``dst {unsigned}``: SCTP destination port. 3671 - ``tag {unsigned}``: validation tag. 3672 - ``cksum {unsigned}``: checksum. 3673 3674- ``vxlan``: match VXLAN header. 3675 3676 - ``vni {unsigned}``: VXLAN identifier. 3677 3678- ``e_tag``: match IEEE 802.1BR E-Tag header. 3679 3680 - ``grp_ecid_b {unsigned}``: GRP and E-CID base. 3681 3682- ``nvgre``: match NVGRE header. 3683 3684 - ``tni {unsigned}``: virtual subnet ID. 3685 3686- ``mpls``: match MPLS header. 3687 3688 - ``label {unsigned}``: MPLS label. 3689 3690- ``gre``: match GRE header. 3691 3692 - ``protocol {unsigned}``: protocol type. 3693 3694- ``gre_key``: match GRE optional key field. 3695 3696 - ``value {unsigned}``: key value. 3697 3698- ``fuzzy``: fuzzy pattern match, expect faster than default. 3699 3700 - ``thresh {unsigned}``: accuracy threshold. 3701 3702- ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header. 3703 3704 - ``teid {unsigned}``: tunnel endpoint identifier. 3705 3706- ``geneve``: match GENEVE header. 3707 3708 - ``vni {unsigned}``: virtual network identifier. 3709 - ``protocol {unsigned}``: protocol type. 3710 3711- ``geneve-opt``: match GENEVE header option. 3712 3713 - ``class {unsigned}``: GENEVE option class. 3714 - ``type {unsigned}``: GENEVE option type. 3715 - ``length {unsigned}``: GENEVE option length in 32-bit words. 3716 - ``data {hex string}``: GENEVE option data, the length is defined by 3717 ``length`` field. 3718 3719- ``vxlan-gpe``: match VXLAN-GPE header. 3720 3721 - ``vni {unsigned}``: VXLAN-GPE identifier. 3722 3723- ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4. 3724 3725 - ``sha {MAC-48}``: sender hardware address. 3726 - ``spa {ipv4 address}``: sender IPv4 address. 3727 - ``tha {MAC-48}``: target hardware address. 3728 - ``tpa {ipv4 address}``: target IPv4 address. 3729 3730- ``ipv6_ext``: match presence of any IPv6 extension header. 3731 3732 - ``next_hdr {unsigned}``: next header. 3733 3734- ``icmp6``: match any ICMPv6 header. 3735 3736 - ``type {unsigned}``: ICMPv6 type. 3737 - ``code {unsigned}``: ICMPv6 code. 3738 3739- ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation. 3740 3741 - ``target_addr {ipv6 address}``: target address. 3742 3743- ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement. 3744 3745 - ``target_addr {ipv6 address}``: target address. 3746 3747- ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option. 3748 3749 - ``type {unsigned}``: ND option type. 3750 3751- ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet 3752 link-layer address option. 3753 3754 - ``sla {MAC-48}``: source Ethernet LLA. 3755 3756- ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet 3757 link-layer address option. 3758 3759 - ``tla {MAC-48}``: target Ethernet LLA. 3760 3761- ``meta``: match application specific metadata. 3762 3763 - ``data {unsigned}``: metadata value. 3764 3765- ``gtp_psc``: match GTP PDU extension header with type 0x85. 3766 3767 - ``pdu_type {unsigned}``: PDU type. 3768 3769 - ``qfi {unsigned}``: PPP, RQI and QoS flow identifier. 3770 3771- ``pppoes``, ``pppoed``: match PPPoE header. 3772 3773 - ``session_id {unsigned}``: session identifier. 3774 3775- ``pppoe_proto_id``: match PPPoE session protocol identifier. 3776 3777 - ``proto_id {unsigned}``: PPP protocol identifier. 3778 3779- ``l2tpv3oip``: match L2TPv3 over IP header. 3780 3781 - ``session_id {unsigned}``: L2TPv3 over IP session identifier. 3782 3783- ``ah``: match AH header. 3784 3785 - ``spi {unsigned}``: security parameters index. 3786 3787- ``pfcp``: match PFCP header. 3788 3789 - ``s_field {unsigned}``: S field. 3790 - ``seid {unsigned}``: session endpoint identifier. 3791 3792- ``integrity``: match packet integrity. 3793 3794 - ``level {unsigned}``: Packet encapsulation level the item should 3795 apply to. See rte_flow_action_rss for details. 3796 - ``value {unsigned}``: A bitmask that specify what packet elements 3797 must be matched for integrity. 3798 3799Actions list 3800^^^^^^^^^^^^ 3801 3802A list of actions starts after the ``actions`` token in the same fashion as 3803`Matching pattern`_; actions are separated by ``/`` tokens and the list is 3804terminated by a mandatory ``end`` action. 3805 3806Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum 3807rte_flow_action_type``). 3808 3809Dropping all incoming UDPv4 packets can be expressed as follows:: 3810 3811 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3812 actions drop / end 3813 3814Several actions have configurable properties which must be specified when 3815there is no valid default value. For example, ``queue`` requires a target 3816queue index. 3817 3818This rule redirects incoming UDPv4 traffic to queue index 6:: 3819 3820 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3821 actions queue index 6 / end 3822 3823While this one could be rejected by PMDs (unspecified queue index):: 3824 3825 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3826 actions queue / end 3827 3828As defined by *rte_flow*, the list is not ordered, all actions of a given 3829rule are performed simultaneously. These are equivalent:: 3830 3831 queue index 6 / void / mark id 42 / end 3832 3833:: 3834 3835 void / mark id 42 / queue index 6 / end 3836 3837All actions in a list should have different types, otherwise only the last 3838action of a given type is taken into account:: 3839 3840 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6 3841 3842:: 3843 3844 drop / drop / drop / end # drop is performed only once 3845 3846:: 3847 3848 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24 3849 3850Considering they are performed simultaneously, opposite and overlapping 3851actions can sometimes be combined when the end result is unambiguous:: 3852 3853 drop / queue index 6 / end # drop has no effect 3854 3855:: 3856 3857 queue index 6 / rss queues 6 7 8 / end # queue has no effect 3858 3859:: 3860 3861 drop / passthru / end # drop has no effect 3862 3863Note that PMDs may still refuse such combinations. 3864 3865Actions 3866^^^^^^^ 3867 3868This section lists supported actions and their attributes, if any. 3869 3870- ``end``: end list of actions. 3871 3872- ``void``: no-op action. 3873 3874- ``passthru``: let subsequent rule process matched packets. 3875 3876- ``jump``: redirect traffic to group on device. 3877 3878 - ``group {unsigned}``: group to redirect to. 3879 3880- ``mark``: attach 32 bit value to packets. 3881 3882 - ``id {unsigned}``: 32 bit value to return with packets. 3883 3884- ``flag``: flag packets. 3885 3886- ``queue``: assign packets to a given queue index. 3887 3888 - ``index {unsigned}``: queue index to use. 3889 3890- ``drop``: drop packets (note: passthru has priority). 3891 3892- ``count``: enable counters for this rule. 3893 3894- ``rss``: spread packets among several queues. 3895 3896 - ``func {hash function}``: RSS hash function to apply, allowed tokens are 3897 ``toeplitz``, ``simple_xor``, ``symmetric_toeplitz`` and ``default``. 3898 3899 - ``level {unsigned}``: encapsulation level for ``types``. 3900 3901 - ``types [{RSS hash type} [...]] end``: specific RSS hash types. 3902 Note that an empty list does not disable RSS but instead requests 3903 unspecified "best-effort" settings. 3904 3905 - ``key {string}``: RSS hash key, overrides ``key_len``. 3906 3907 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in 3908 conjunction with ``key`` to pad or truncate it. 3909 3910 - ``queues [{unsigned} [...]] end``: queue indices to use. 3911 3912- ``pf``: direct traffic to physical function. 3913 3914- ``vf``: direct traffic to a virtual function ID. 3915 3916 - ``original {boolean}``: use original VF ID if possible. 3917 - ``id {unsigned}``: VF ID. 3918 3919- ``phy_port``: direct packets to physical port index. 3920 3921 - ``original {boolean}``: use original port index if possible. 3922 - ``index {unsigned}``: physical port index. 3923 3924- ``port_id``: direct matching traffic to a given DPDK port ID. 3925 3926 - ``original {boolean}``: use original DPDK port ID if possible. 3927 - ``id {unsigned}``: DPDK port ID. 3928 3929- ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``. 3930 3931 - ``mpls_ttl``: MPLS TTL. 3932 3933- ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``. 3934 3935- ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``. 3936 3937 - ``nw_ttl``: IP TTL. 3938 3939- ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``. 3940 3941- ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``. 3942 3943- ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``. 3944 3945- ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``. 3946 3947- ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``. 3948 3949 - ``ethertype``: Ethertype. 3950 3951- ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``. 3952 3953 - ``vlan_vid``: VLAN id. 3954 3955- ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``. 3956 3957 - ``vlan_pcp``: VLAN priority. 3958 3959- ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``. 3960 3961 - ``ethertype``: Ethertype. 3962 3963- ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``. 3964 3965 - ``ethertype``: Ethertype. 3966 3967- ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration 3968 is done through `Config VXLAN Encap outer layers`_. 3969 3970- ``vxlan_decap``: Performs a decapsulation action by stripping all headers of 3971 the VXLAN tunnel network overlay from the matched flow. 3972 3973- ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration 3974 is done through `Config NVGRE Encap outer layers`_. 3975 3976- ``nvgre_decap``: Performs a decapsulation action by stripping all headers of 3977 the NVGRE tunnel network overlay from the matched flow. 3978 3979- ``l2_encap``: Performs a L2 encapsulation, L2 configuration 3980 is done through `Config L2 Encap`_. 3981 3982- ``l2_decap``: Performs a L2 decapsulation, L2 configuration 3983 is done through `Config L2 Decap`_. 3984 3985- ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer 3986 configuration is done through `Config MPLSoGRE Encap outer layers`_. 3987 3988- ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer 3989 configuration is done through `Config MPLSoGRE Decap outer layers`_. 3990 3991- ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer 3992 configuration is done through `Config MPLSoUDP Encap outer layers`_. 3993 3994- ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer 3995 configuration is done through `Config MPLSoUDP Decap outer layers`_. 3996 3997- ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header. 3998 3999 - ``ipv4_addr``: New IPv4 source address. 4000 4001- ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4 4002 header. 4003 4004 - ``ipv4_addr``: New IPv4 destination address. 4005 4006- ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header. 4007 4008 - ``ipv6_addr``: New IPv6 source address. 4009 4010- ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6 4011 header. 4012 4013 - ``ipv6_addr``: New IPv6 destination address. 4014 4015- ``set_tp_src``: Set a new source port number in the outermost TCP/UDP 4016 header. 4017 4018 - ``port``: New TCP/UDP source port number. 4019 4020- ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP 4021 header. 4022 4023 - ``port``: New TCP/UDP destination port number. 4024 4025- ``mac_swap``: Swap the source and destination MAC addresses in the outermost 4026 Ethernet header. 4027 4028- ``dec_ttl``: Performs a decrease TTL value action 4029 4030- ``set_ttl``: Set TTL value with specified value 4031 - ``ttl_value {unsigned}``: The new TTL value to be set 4032 4033- ``set_mac_src``: set source MAC address 4034 4035 - ``mac_addr {MAC-48}``: new source MAC address 4036 4037- ``set_mac_dst``: set destination MAC address 4038 4039 - ``mac_addr {MAC-48}``: new destination MAC address 4040 4041- ``inc_tcp_seq``: Increase sequence number in the outermost TCP header. 4042 4043 - ``value {unsigned}``: Value to increase TCP sequence number by. 4044 4045- ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header. 4046 4047 - ``value {unsigned}``: Value to decrease TCP sequence number by. 4048 4049- ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header. 4050 4051 - ``value {unsigned}``: Value to increase TCP acknowledgment number by. 4052 4053- ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header. 4054 4055 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by. 4056 4057- ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value 4058 4059 - ``dscp_value {unsigned}``: The new DSCP value to be set 4060 4061- ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value 4062 4063 - ``dscp_value {unsigned}``: The new DSCP value to be set 4064 4065- ``indirect``: Use indirect action created via 4066 ``flow indirect_action {port_id} create`` 4067 4068 - ``indirect_action_id {unsigned}``: Indirect action ID to use 4069 4070Destroying flow rules 4071~~~~~~~~~~~~~~~~~~~~~ 4072 4073``flow destroy`` destroys one or more rules from their rule ID (as returned 4074by ``flow create``), this command calls ``rte_flow_destroy()`` as many 4075times as necessary:: 4076 4077 flow destroy {port_id} rule {rule_id} [...] 4078 4079If successful, it will show:: 4080 4081 Flow rule #[...] destroyed 4082 4083It does not report anything for rule IDs that do not exist. The usual error 4084message is shown when a rule cannot be destroyed:: 4085 4086 Caught error type [...] ([...]): [...] 4087 4088``flow flush`` destroys all rules on a device and does not take extra 4089arguments. It is bound to ``rte_flow_flush()``:: 4090 4091 flow flush {port_id} 4092 4093Any errors are reported as above. 4094 4095Creating several rules and destroying them:: 4096 4097 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4098 actions queue index 2 / end 4099 Flow rule #0 created 4100 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4101 actions queue index 3 / end 4102 Flow rule #1 created 4103 testpmd> flow destroy 0 rule 0 rule 1 4104 Flow rule #1 destroyed 4105 Flow rule #0 destroyed 4106 testpmd> 4107 4108The same result can be achieved using ``flow flush``:: 4109 4110 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4111 actions queue index 2 / end 4112 Flow rule #0 created 4113 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4114 actions queue index 3 / end 4115 Flow rule #1 created 4116 testpmd> flow flush 0 4117 testpmd> 4118 4119Non-existent rule IDs are ignored:: 4120 4121 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4122 actions queue index 2 / end 4123 Flow rule #0 created 4124 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4125 actions queue index 3 / end 4126 Flow rule #1 created 4127 testpmd> flow destroy 0 rule 42 rule 10 rule 2 4128 testpmd> 4129 testpmd> flow destroy 0 rule 0 4130 Flow rule #0 destroyed 4131 testpmd> 4132 4133Querying flow rules 4134~~~~~~~~~~~~~~~~~~~ 4135 4136``flow query`` queries a specific action of a flow rule having that 4137ability. Such actions collect information that can be reported using this 4138command. It is bound to ``rte_flow_query()``:: 4139 4140 flow query {port_id} {rule_id} {action} 4141 4142If successful, it will display either the retrieved data for known actions 4143or the following message:: 4144 4145 Cannot display result for action type [...] ([...]) 4146 4147Otherwise, it will complain either that the rule does not exist or that some 4148error occurred:: 4149 4150 Flow rule #[...] not found 4151 4152:: 4153 4154 Caught error type [...] ([...]): [...] 4155 4156Currently only the ``count`` action is supported. This action reports the 4157number of packets that hit the flow rule and the total number of bytes. Its 4158output has the following format:: 4159 4160 count: 4161 hits_set: [...] # whether "hits" contains a valid value 4162 bytes_set: [...] # whether "bytes" contains a valid value 4163 hits: [...] # number of packets 4164 bytes: [...] # number of bytes 4165 4166Querying counters for TCPv6 packets redirected to queue 6:: 4167 4168 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end 4169 actions queue index 6 / count / end 4170 Flow rule #4 created 4171 testpmd> flow query 0 4 count 4172 count: 4173 hits_set: 1 4174 bytes_set: 0 4175 hits: 386446 4176 bytes: 0 4177 testpmd> 4178 4179Listing flow rules 4180~~~~~~~~~~~~~~~~~~ 4181 4182``flow list`` lists existing flow rules sorted by priority and optionally 4183filtered by group identifiers:: 4184 4185 flow list {port_id} [group {group_id}] [...] 4186 4187This command only fails with the following message if the device does not 4188exist:: 4189 4190 Invalid port [...] 4191 4192Output consists of a header line followed by a short description of each 4193flow rule, one per line. There is no output at all when no flow rules are 4194configured on the device:: 4195 4196 ID Group Prio Attr Rule 4197 [...] [...] [...] [...] [...] 4198 4199``Attr`` column flags: 4200 4201- ``i`` for ``ingress``. 4202- ``e`` for ``egress``. 4203 4204Creating several flow rules and listing them:: 4205 4206 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4207 actions queue index 6 / end 4208 Flow rule #0 created 4209 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4210 actions queue index 2 / end 4211 Flow rule #1 created 4212 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end 4213 actions rss queues 6 7 8 end / end 4214 Flow rule #2 created 4215 testpmd> flow list 0 4216 ID Group Prio Attr Rule 4217 0 0 0 i- ETH IPV4 => QUEUE 4218 1 0 0 i- ETH IPV6 => QUEUE 4219 2 0 5 i- ETH IPV4 UDP => RSS 4220 testpmd> 4221 4222Rules are sorted by priority (i.e. group ID first, then priority level):: 4223 4224 testpmd> flow list 1 4225 ID Group Prio Attr Rule 4226 0 0 0 i- ETH => COUNT 4227 6 0 500 i- ETH IPV6 TCP => DROP COUNT 4228 5 0 1000 i- ETH IPV6 ICMP => QUEUE 4229 1 24 0 i- ETH IPV4 UDP => QUEUE 4230 4 24 10 i- ETH IPV4 TCP => DROP 4231 3 24 20 i- ETH IPV4 => DROP 4232 2 24 42 i- ETH IPV4 UDP => QUEUE 4233 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE 4234 testpmd> 4235 4236Output can be limited to specific groups:: 4237 4238 testpmd> flow list 1 group 0 group 63 4239 ID Group Prio Attr Rule 4240 0 0 0 i- ETH => COUNT 4241 6 0 500 i- ETH IPV6 TCP => DROP COUNT 4242 5 0 1000 i- ETH IPV6 ICMP => QUEUE 4243 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE 4244 testpmd> 4245 4246Toggling isolated mode 4247~~~~~~~~~~~~~~~~~~~~~~ 4248 4249``flow isolate`` can be used to tell the underlying PMD that ingress traffic 4250must only be injected from the defined flow rules; that no default traffic 4251is expected outside those rules and the driver is free to assign more 4252resources to handle them. It is bound to ``rte_flow_isolate()``:: 4253 4254 flow isolate {port_id} {boolean} 4255 4256If successful, enabling or disabling isolated mode shows either:: 4257 4258 Ingress traffic on port [...] 4259 is now restricted to the defined flow rules 4260 4261Or:: 4262 4263 Ingress traffic on port [...] 4264 is not restricted anymore to the defined flow rules 4265 4266Otherwise, in case of error:: 4267 4268 Caught error type [...] ([...]): [...] 4269 4270Mainly due to its side effects, PMDs supporting this mode may not have the 4271ability to toggle it more than once without reinitializing affected ports 4272first (e.g. by exiting testpmd). 4273 4274Enabling isolated mode:: 4275 4276 testpmd> flow isolate 0 true 4277 Ingress traffic on port 0 is now restricted to the defined flow rules 4278 testpmd> 4279 4280Disabling isolated mode:: 4281 4282 testpmd> flow isolate 0 false 4283 Ingress traffic on port 0 is not restricted anymore to the defined flow rules 4284 testpmd> 4285 4286Dumping HW internal information 4287~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4288 4289``flow dump`` dumps the hardware's internal representation information of 4290all flows. It is bound to ``rte_flow_dev_dump()``:: 4291 4292 flow dump {port_id} {output_file} 4293 4294If successful, it will show:: 4295 4296 Flow dump finished 4297 4298Otherwise, it will complain error occurred:: 4299 4300 Caught error type [...] ([...]): [...] 4301 4302Listing and destroying aged flow rules 4303~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4304 4305``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``, 4306and ``destroy`` parameter can be used to destroy those flow rules in PMD. 4307 4308 flow aged {port_id} [destroy] 4309 4310Listing current aged flow rules:: 4311 4312 testpmd> flow aged 0 4313 Port 0 total aged flows: 0 4314 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.14 / end 4315 actions age timeout 5 / queue index 0 / end 4316 Flow rule #0 created 4317 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.15 / end 4318 actions age timeout 4 / queue index 0 / end 4319 Flow rule #1 created 4320 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.16 / end 4321 actions age timeout 2 / queue index 0 / end 4322 Flow rule #2 created 4323 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.17 / end 4324 actions age timeout 3 / queue index 0 / end 4325 Flow rule #3 created 4326 4327 4328Aged Rules are simply list as command ``flow list {port_id}``, but strip the detail rule 4329information, all the aged flows are sorted by the longest timeout time. For example, if 4330those rules be configured in the same time, ID 2 will be the first aged out rule, the next 4331will be ID 3, ID 1, ID 0:: 4332 4333 testpmd> flow aged 0 4334 Port 0 total aged flows: 4 4335 ID Group Prio Attr 4336 2 0 0 i-- 4337 3 0 0 i-- 4338 1 0 0 i-- 4339 0 0 0 i-- 4340 4341If attach ``destroy`` parameter, the command will destroy all the list aged flow rules. 4342 4343 testpmd> flow aged 0 destroy 4344 Port 0 total aged flows: 4 4345 ID Group Prio Attr 4346 2 0 0 i-- 4347 3 0 0 i-- 4348 1 0 0 i-- 4349 0 0 0 i-- 4350 4351 Flow rule #2 destroyed 4352 Flow rule #3 destroyed 4353 Flow rule #1 destroyed 4354 Flow rule #0 destroyed 4355 4 flows be destroyed 4356 testpmd> flow aged 0 4357 Port 0 total aged flows: 0 4358 4359Creating indirect actions 4360~~~~~~~~~~~~~~~~~~~~~~~~~ 4361 4362``flow indirect_action {port_id} create`` creates indirect action with optional 4363indirect action ID. It is bound to ``rte_flow_action_handle_create()``:: 4364 4365 flow indirect_action {port_id} create [action_id {indirect_action_id}] 4366 [ingress] [egress] [transfer] action {action} / end 4367 4368If successful, it will show:: 4369 4370 Indirect action #[...] created 4371 4372Otherwise, it will complain either that indirect action already exists or that 4373some error occurred:: 4374 4375 Indirect action #[...] is already assigned, delete it first 4376 4377:: 4378 4379 Caught error type [...] ([...]): [...] 4380 4381Create indirect rss action with id 100 to queues 1 and 2 on port 0:: 4382 4383 testpmd> flow indirect_action 0 create action_id 100 \ 4384 ingress action rss queues 1 2 end / end 4385 4386Create indirect rss action with id assigned by testpmd to queues 1 and 2 on 4387port 0:: 4388 4389 testpmd> flow indirect_action 0 create action_id \ 4390 ingress action rss queues 0 1 end / end 4391 4392Updating indirect actions 4393~~~~~~~~~~~~~~~~~~~~~~~~~ 4394 4395``flow indirect_action {port_id} update`` updates configuration of the indirect 4396action from its indirect action ID (as returned by 4397``flow indirect_action {port_id} create``). It is bound to 4398``rte_flow_action_handle_update()``:: 4399 4400 flow indirect_action {port_id} update {indirect_action_id} 4401 action {action} / end 4402 4403If successful, it will show:: 4404 4405 Indirect action #[...] updated 4406 4407Otherwise, it will complain either that indirect action not found or that some 4408error occurred:: 4409 4410 Failed to find indirect action #[...] on port [...] 4411 4412:: 4413 4414 Caught error type [...] ([...]): [...] 4415 4416Update indirect rss action having id 100 on port 0 with rss to queues 0 and 3 4417(in create example above rss queues were 1 and 2):: 4418 4419 testpmd> flow indirect_action 0 update 100 action rss queues 0 3 end / end 4420 4421Destroying indirect actions 4422~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4423 4424``flow indirect_action {port_id} destroy`` destroys one or more indirect actions 4425from their indirect action IDs (as returned by 4426``flow indirect_action {port_id} create``). It is bound to 4427``rte_flow_action_handle_destroy()``:: 4428 4429 flow indirect_action {port_id} destroy action_id {indirect_action_id} [...] 4430 4431If successful, it will show:: 4432 4433 Indirect action #[...] destroyed 4434 4435It does not report anything for indirect action IDs that do not exist. 4436The usual error message is shown when a indirect action cannot be destroyed:: 4437 4438 Caught error type [...] ([...]): [...] 4439 4440Destroy indirect actions having id 100 & 101:: 4441 4442 testpmd> flow indirect_action 0 destroy action_id 100 action_id 101 4443 4444Query indirect actions 4445~~~~~~~~~~~~~~~~~~~~~~ 4446 4447``flow indirect_action {port_id} query`` queries the indirect action from its 4448indirect action ID (as returned by ``flow indirect_action {port_id} create``). 4449It is bound to ``rte_flow_action_handle_query()``:: 4450 4451 flow indirect_action {port_id} query {indirect_action_id} 4452 4453Currently only rss indirect action supported. If successful, it will show:: 4454 4455 Indirect RSS action: 4456 refs:[...] 4457 4458Otherwise, it will complain either that indirect action not found or that some 4459error occurred:: 4460 4461 Failed to find indirect action #[...] on port [...] 4462 4463:: 4464 4465 Caught error type [...] ([...]): [...] 4466 4467Query indirect action having id 100:: 4468 4469 testpmd> flow indirect_action 0 query 100 4470 4471Sample QinQ flow rules 4472~~~~~~~~~~~~~~~~~~~~~~ 4473 4474Before creating QinQ rule(s) the following commands should be issued to enable QinQ:: 4475 4476 testpmd> port stop 0 4477 testpmd> vlan set extend on 0 4478 4479The above command sets the inner and outer TPID's to 0x8100. 4480 4481To change the TPID's the following commands should be used:: 4482 4483 testpmd> vlan set outer tpid 0x88A8 0 4484 testpmd> vlan set inner tpid 0x8100 0 4485 testpmd> port start 0 4486 4487Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM. 4488 4489:: 4490 4491 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 / 4492 vlan tci is 456 / end actions vf id 1 / queue index 0 / end 4493 Flow rule #0 validated 4494 4495 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 / 4496 vlan tci is 456 / end actions vf id 123 / queue index 0 / end 4497 Flow rule #0 created 4498 4499 testpmd> flow list 0 4500 ID Group Prio Attr Rule 4501 0 0 0 i- ETH VLAN VLAN=>VF QUEUE 4502 4503Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host. 4504 4505:: 4506 4507 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 / 4508 vlan tci is 654 / end actions pf / queue index 0 / end 4509 Flow rule #1 validated 4510 4511 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 / 4512 vlan tci is 654 / end actions pf / queue index 1 / end 4513 Flow rule #1 created 4514 4515 testpmd> flow list 0 4516 ID Group Prio Attr Rule 4517 0 0 0 i- ETH VLAN VLAN=>VF QUEUE 4518 1 0 0 i- ETH VLAN VLAN=>PF QUEUE 4519 4520Sample VXLAN flow rules 4521~~~~~~~~~~~~~~~~~~~~~~~ 4522 4523Before creating VXLAN rule(s), the UDP port should be added for VXLAN packet 4524filter on a port:: 4525 4526 testpmd> rx_vxlan_port add 4789 0 4527 4528Create VXLAN rules on port 0 to steer traffic to PF queues. 4529 4530:: 4531 4532 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / 4533 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 1 / end 4534 Flow rule #0 created 4535 4536 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 3 / 4537 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 2 / end 4538 Flow rule #1 created 4539 4540 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / 4541 eth dst is 00:11:22:33:44:55 / vlan tci is 10 / end actions pf / 4542 queue index 3 / end 4543 Flow rule #2 created 4544 4545 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 5 / 4546 eth dst is 00:11:22:33:44:55 / vlan tci is 20 / end actions pf / 4547 queue index 4 / end 4548 Flow rule #3 created 4549 4550 testpmd> flow create 0 ingress pattern eth dst is 00:00:00:00:01:00 / ipv4 / 4551 udp / vxlan vni is 6 / eth dst is 00:11:22:33:44:55 / end actions pf / 4552 queue index 5 / end 4553 Flow rule #4 created 4554 4555 testpmd> flow list 0 4556 ID Group Prio Attr Rule 4557 0 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE 4558 1 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE 4559 2 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE 4560 3 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE 4561 4 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE 4562 4563Sample VXLAN encapsulation rule 4564~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4565 4566VXLAN encapsulation outer layer has default value pre-configured in testpmd 4567source code, those can be changed by using the following commands 4568 4569IPv4 VXLAN outer header:: 4570 4571 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1 4572 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4573 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4574 queue index 0 / end 4575 4576 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 4577 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11 4578 eth-dst 22:22:22:22:22:22 4579 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4580 queue index 0 / end 4581 4582 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0 4583 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 4584 eth-dst 22:22:22:22:22:22 4585 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4586 queue index 0 / end 4587 4588IPv6 VXLAN outer header:: 4589 4590 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1 4591 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4592 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4593 queue index 0 / end 4594 4595 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 4596 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11 4597 eth-dst 22:22:22:22:22:22 4598 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4599 queue index 0 / end 4600 4601 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4 4602 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11 4603 eth-dst 22:22:22:22:22:22 4604 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4605 queue index 0 / end 4606 4607Sample NVGRE encapsulation rule 4608~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4609 4610NVGRE encapsulation outer layer has default value pre-configured in testpmd 4611source code, those can be changed by using the following commands 4612 4613IPv4 NVGRE outer header:: 4614 4615 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1 4616 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4617 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4618 queue index 0 / end 4619 4620 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1 4621 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11 4622 eth-dst 22:22:22:22:22:22 4623 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4624 queue index 0 / end 4625 4626IPv6 NVGRE outer header:: 4627 4628 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222 4629 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4630 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4631 queue index 0 / end 4632 4633 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222 4634 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4635 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4636 queue index 0 / end 4637 4638Sample L2 encapsulation rule 4639~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4640 4641L2 encapsulation has default value pre-configured in testpmd 4642source code, those can be changed by using the following commands 4643 4644L2 header:: 4645 4646 testpmd> set l2_encap ip-version ipv4 4647 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4648 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 4649 mplsoudp_decap / l2_encap / end 4650 4651L2 with VXLAN header:: 4652 4653 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34 4654 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4655 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 4656 mplsoudp_decap / l2_encap / end 4657 4658Sample L2 decapsulation rule 4659~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4660 4661L2 decapsulation has default value pre-configured in testpmd 4662source code, those can be changed by using the following commands 4663 4664L2 header:: 4665 4666 testpmd> set l2_decap 4667 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap / 4668 queue index 0 / end 4669 4670L2 with VXLAN header:: 4671 4672 testpmd> set l2_encap-with-vlan 4673 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap / 4674 queue index 0 / end 4675 4676Sample MPLSoGRE encapsulation rule 4677~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4678 4679MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd 4680source code, those can be changed by using the following commands 4681 4682IPv4 MPLSoGRE outer header:: 4683 4684 testpmd> set mplsogre_encap ip-version ipv4 label 4 4685 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 4686 eth-dst 22:22:22:22:22:22 4687 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4688 mplsogre_encap / end 4689 4690IPv4 MPLSoGRE with VLAN outer header:: 4691 4692 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4 4693 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 4694 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4695 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4696 mplsogre_encap / end 4697 4698IPv6 MPLSoGRE outer header:: 4699 4700 testpmd> set mplsogre_encap ip-version ipv6 mask 4 4701 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11 4702 eth-dst 22:22:22:22:22:22 4703 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4704 mplsogre_encap / end 4705 4706IPv6 MPLSoGRE with VLAN outer header:: 4707 4708 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4 4709 ip-src ::1 ip-dst ::2222 vlan-tci 34 4710 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4711 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4712 mplsogre_encap / end 4713 4714Sample MPLSoGRE decapsulation rule 4715~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4716 4717MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd 4718source code, those can be changed by using the following commands 4719 4720IPv4 MPLSoGRE outer header:: 4721 4722 testpmd> set mplsogre_decap ip-version ipv4 4723 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions 4724 mplsogre_decap / l2_encap / end 4725 4726IPv4 MPLSoGRE with VLAN outer header:: 4727 4728 testpmd> set mplsogre_decap-with-vlan ip-version ipv4 4729 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end 4730 actions mplsogre_decap / l2_encap / end 4731 4732IPv6 MPLSoGRE outer header:: 4733 4734 testpmd> set mplsogre_decap ip-version ipv6 4735 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end 4736 actions mplsogre_decap / l2_encap / end 4737 4738IPv6 MPLSoGRE with VLAN outer header:: 4739 4740 testpmd> set mplsogre_decap-with-vlan ip-version ipv6 4741 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end 4742 actions mplsogre_decap / l2_encap / end 4743 4744Sample MPLSoUDP encapsulation rule 4745~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4746 4747MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd 4748source code, those can be changed by using the following commands 4749 4750IPv4 MPLSoUDP outer header:: 4751 4752 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10 4753 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 4754 eth-dst 22:22:22:22:22:22 4755 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4756 mplsoudp_encap / end 4757 4758IPv4 MPLSoUDP with VLAN outer header:: 4759 4760 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5 4761 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 4762 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4763 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4764 mplsoudp_encap / end 4765 4766IPv6 MPLSoUDP outer header:: 4767 4768 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10 4769 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11 4770 eth-dst 22:22:22:22:22:22 4771 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4772 mplsoudp_encap / end 4773 4774IPv6 MPLSoUDP with VLAN outer header:: 4775 4776 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5 4777 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34 4778 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4779 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4780 mplsoudp_encap / end 4781 4782Sample MPLSoUDP decapsulation rule 4783~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4784 4785MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd 4786source code, those can be changed by using the following commands 4787 4788IPv4 MPLSoUDP outer header:: 4789 4790 testpmd> set mplsoudp_decap ip-version ipv4 4791 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 4792 mplsoudp_decap / l2_encap / end 4793 4794IPv4 MPLSoUDP with VLAN outer header:: 4795 4796 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4 4797 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end 4798 actions mplsoudp_decap / l2_encap / end 4799 4800IPv6 MPLSoUDP outer header:: 4801 4802 testpmd> set mplsoudp_decap ip-version ipv6 4803 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end 4804 actions mplsoudp_decap / l2_encap / end 4805 4806IPv6 MPLSoUDP with VLAN outer header:: 4807 4808 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6 4809 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end 4810 actions mplsoudp_decap / l2_encap / end 4811 4812Sample Raw encapsulation rule 4813~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4814 4815Raw encapsulation configuration can be set by the following commands 4816 4817Eecapsulating VxLAN:: 4818 4819 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1 4820 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni 4821 is 2 / end_set 4822 testpmd> flow create 0 egress pattern eth / ipv4 / end actions 4823 raw_encap index 4 / end 4824 4825Sample Raw decapsulation rule 4826~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4827 4828Raw decapsulation configuration can be set by the following commands 4829 4830Decapsulating VxLAN:: 4831 4832 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set 4833 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 / 4834 end actions raw_decap / queue index 0 / end 4835 4836Sample ESP rules 4837~~~~~~~~~~~~~~~~ 4838 4839ESP rules can be created by the following commands:: 4840 4841 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions 4842 queue index 3 / end 4843 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end 4844 actions queue index 3 / end 4845 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions 4846 queue index 3 / end 4847 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end 4848 actions queue index 3 / end 4849 4850Sample AH rules 4851~~~~~~~~~~~~~~~~ 4852 4853AH rules can be created by the following commands:: 4854 4855 testpmd> flow create 0 ingress pattern eth / ipv4 / ah spi is 1 / end actions 4856 queue index 3 / end 4857 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / ah spi is 1 / end 4858 actions queue index 3 / end 4859 testpmd> flow create 0 ingress pattern eth / ipv6 / ah spi is 1 / end actions 4860 queue index 3 / end 4861 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / ah spi is 1 / end 4862 actions queue index 3 / end 4863 4864Sample PFCP rules 4865~~~~~~~~~~~~~~~~~ 4866 4867PFCP rules can be created by the following commands(s_field need to be 1 4868if seid is set):: 4869 4870 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 0 / end 4871 actions queue index 3 / end 4872 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 1 4873 seid is 1 / end actions queue index 3 / end 4874 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 0 / end 4875 actions queue index 3 / end 4876 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 1 4877 seid is 1 / end actions queue index 3 / end 4878 4879Sample Sampling/Mirroring rules 4880~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4881 4882Sample/Mirroring rules can be set by the following commands 4883 4884NIC-RX Sampling rule, the matched ingress packets and sent to the queue 1, 4885and 50% packets are duplicated and marked with 0x1234 and sent to queue 0. 4886 4887:: 4888 4889 testpmd> set sample_actions 0 mark id 0x1234 / queue index 0 / end 4890 testpmd> flow create 0 ingress group 1 pattern eth / end actions 4891 sample ratio 2 index 0 / queue index 1 / end 4892 4893Mirroring rule with port representors (with "transfer" attribute), the matched 4894ingress packets with encapsulation header are sent to port id 0, and also 4895mirrored the packets and sent to port id 2. 4896 4897:: 4898 4899 testpmd> set sample_actions 0 port_id id 2 / end 4900 testpmd> flow create 1 ingress transfer pattern eth / end actions 4901 sample ratio 1 index 0 / raw_encap / port_id id 0 / end 4902 4903Mirroring rule with port representors (with "transfer" attribute), the matched 4904ingress packets are sent to port id 2, and also mirrored the packets with 4905encapsulation header and sent to port id 0. 4906 4907:: 4908 4909 testpmd> set sample_actions 0 raw_encap / port_id id 0 / end 4910 testpmd> flow create 0 ingress transfer pattern eth / end actions 4911 sample ratio 1 index 0 / port_id id 2 / end 4912 4913Mirroring rule with port representors (with "transfer" attribute), the matched 4914ingress packets are sent to port id 2, and also mirrored the packets with 4915VXLAN encapsulation header and sent to port id 0. 4916 4917:: 4918 4919 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1 4920 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4921 testpmd> set sample_actions 0 vxlan_encap / port_id id 0 / end 4922 testpmd> flow create 0 ingress transfer pattern eth / end actions 4923 sample ratio 1 index 0 / port_id id 2 / end 4924 4925Mirroring rule with port representors (with "transfer" attribute), the matched 4926ingress packets are sent to port id 2, and also mirrored the packets with 4927NVGRE encapsulation header and sent to port id 0. 4928 4929:: 4930 4931 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1 4932 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4933 testpmd> set sample_actions 0 nvgre_encap / port_id id 0 / end 4934 testpmd> flow create 0 ingress transfer pattern eth / end actions 4935 sample ratio 1 index 0 / port_id id 2 / end 4936 4937Sample integrity rules 4938~~~~~~~~~~~~~~~~~~~~~~ 4939 4940Integrity rules can be created by the following commands: 4941 4942Integrity rule that forwards valid TCP packets to group 1. 4943TCP packet integrity is matched with the ``l4_ok`` bit 3. 4944 4945:: 4946 4947 testpmd> flow create 0 ingress 4948 pattern eth / ipv4 / tcp / integrity value mask 8 value spec 8 / end 4949 actions jump group 1 / end 4950 4951Integrity rule that forwards invalid packets to application. 4952General packet integrity is matched with the ``packet_ok`` bit 0. 4953 4954:: 4955 4956 testpmd> flow create 0 ingress pattern integrity value mask 1 value spec 0 / end actions queue index 0 / end 4957 4958BPF Functions 4959-------------- 4960 4961The following sections show functions to load/unload eBPF based filters. 4962 4963bpf-load 4964~~~~~~~~ 4965 4966Load an eBPF program as a callback for particular RX/TX queue:: 4967 4968 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename) 4969 4970The available load-flags are: 4971 4972* ``J``: use JIT generated native code, otherwise BPF interpreter will be used. 4973 4974* ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data. 4975 4976* ``-``: none. 4977 4978.. note:: 4979 4980 You'll need clang v3.7 or above to build bpf program you'd like to load 4981 4982For example: 4983 4984.. code-block:: console 4985 4986 cd examples/bpf 4987 clang -O2 -target bpf -c t1.c 4988 4989Then to load (and JIT compile) t1.o at RX queue 0, port 1: 4990 4991.. code-block:: console 4992 4993 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o 4994 4995To load (not JITed) t1.o at TX queue 0, port 0: 4996 4997.. code-block:: console 4998 4999 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o 5000 5001bpf-unload 5002~~~~~~~~~~ 5003 5004Unload previously loaded eBPF program for particular RX/TX queue:: 5005 5006 testpmd> bpf-unload rx|tx (portid) (queueid) 5007 5008For example to unload BPF filter from TX queue 0, port 0: 5009 5010.. code-block:: console 5011 5012 testpmd> bpf-unload tx 0 0 5013