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