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