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