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| \ 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}] 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- Destroy a table:: 3003 3004 flow table {port_id} destroy table {id} [...] 3005 3006- Check whether a flow rule can be created:: 3007 3008 flow validate {port_id} 3009 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3010 pattern {item} [/ {item} [...]] / end 3011 actions {action} [/ {action} [...]] / end 3012 3013- Enqueue creation of a flow rule:: 3014 3015 flow queue {port_id} create {queue_id} 3016 [postpone {boolean}] template_table {table_id} 3017 pattern_template {pattern_template_index} 3018 actions_template {actions_template_index} 3019 pattern {item} [/ {item} [...]] / end 3020 actions {action} [/ {action} [...]] / end 3021 3022- Enqueue destruction of specific flow rules:: 3023 3024 flow queue {port_id} destroy {queue_id} 3025 [postpone {boolean}] rule {rule_id} [...] 3026 3027- Push enqueued operations:: 3028 3029 flow push {port_id} queue {queue_id} 3030 3031- Pull all operations results from a queue:: 3032 3033 flow pull {port_id} queue {queue_id} 3034 3035- Create a flow rule:: 3036 3037 flow create {port_id} 3038 [group {group_id}] [priority {level}] [ingress] [egress] 3039 [transfer] [tunnel_set {tunnel_id}] [tunnel_match {tunnel_id}] 3040 [user_id {user_id}] pattern {item} [/ {item} [...]] / end 3041 actions {action} [/ {action} [...]] / end 3042 3043- Destroy specific flow rules:: 3044 3045 flow destroy {port_id} rule {rule_id} [...] [user_id] 3046 3047- Destroy all flow rules:: 3048 3049 flow flush {port_id} 3050 3051- Query an existing flow rule:: 3052 3053 flow query {port_id} {rule_id} {action} [user_id] 3054 3055- List existing flow rules sorted by priority, filtered by group 3056 identifiers:: 3057 3058 flow list {port_id} [group {group_id}] [...] 3059 3060- Restrict ingress traffic to the defined flow rules:: 3061 3062 flow isolate {port_id} {boolean} 3063 3064- Dump internal representation information of all flows in hardware:: 3065 3066 flow dump {port_id} all {output_file} [user_id] 3067 3068 for one flow:: 3069 3070 flow dump {port_id} rule {rule_id} {output_file} [user_id] 3071 3072- List and destroy aged flow rules:: 3073 3074 flow aged {port_id} [destroy] 3075 3076- Enqueue list and destroy aged flow rules:: 3077 3078 flow queue {port_id} aged {queue_id} [destroy] 3079 3080- Tunnel offload - create a tunnel stub:: 3081 3082 flow tunnel create {port_id} type {tunnel_type} 3083 3084- Tunnel offload - destroy a tunnel stub:: 3085 3086 flow tunnel destroy {port_id} id {tunnel_id} 3087 3088- Tunnel offload - list port tunnel stubs:: 3089 3090 flow tunnel list {port_id} 3091 3092Retrieving info about flow management engine 3093~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3094 3095``flow info`` retrieves info on pre-configurable resources in the underlying 3096device to give a hint of possible values for flow engine configuration. 3097 3098``rte_flow_info_get()``:: 3099 3100 flow info {port_id} 3101 3102If successful, it will show:: 3103 3104 Flow engine resources on port #[...]: 3105 Number of queues: #[...] 3106 Size of queues: #[...] 3107 Number of counters: #[...] 3108 Number of aging objects: #[...] 3109 Number of meters: #[...] 3110 3111Otherwise it will show an error message of the form:: 3112 3113 Caught error type [...] ([...]): [...] 3114 3115Configuring flow management engine 3116~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3117 3118``flow configure`` pre-allocates all the needed resources in the underlying 3119device to be used later at the flow creation. Flow queues are allocated as well 3120for asynchronous flow creation/destruction operations. It is bound to 3121``rte_flow_configure()``:: 3122 3123 flow configure {port_id} 3124 [queues_number {number}] [queues_size {size}] 3125 [counters_number {number}] 3126 [aging_counters_number {number}] 3127 [host_port {number}] 3128 [meters_number {number}] 3129 [flags {number}] 3130 3131If successful, it will show:: 3132 3133 Configure flows on port #[...]: number of queues #[...] with #[...] elements 3134 3135Otherwise it will show an error message of the form:: 3136 3137 Caught error type [...] ([...]): [...] 3138 3139Creating pattern templates 3140~~~~~~~~~~~~~~~~~~~~~~~~~~ 3141 3142``flow pattern_template create`` creates the specified pattern template. 3143It is bound to ``rte_flow_pattern_template_create()``:: 3144 3145 flow pattern_template {port_id} create [pattern_template_id {id}] 3146 [relaxed {boolean}] [ingress] [egress] [transfer] 3147 template {item} [/ {item} [...]] / end 3148 3149If successful, it will show:: 3150 3151 Pattern template #[...] created 3152 3153Otherwise it will show an error message of the form:: 3154 3155 Caught error type [...] ([...]): [...] 3156 3157This command uses the same pattern items as ``flow create``, 3158their format is described in `Creating flow rules`_. 3159 3160Destroying pattern templates 3161~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3162 3163``flow pattern_template destroy`` destroys one or more pattern templates 3164from their template ID (as returned by ``flow pattern_template create``), 3165this command calls ``rte_flow_pattern_template_destroy()`` as many 3166times as necessary:: 3167 3168 flow pattern_template {port_id} destroy pattern_template {id} [...] 3169 3170If successful, it will show:: 3171 3172 Pattern template #[...] destroyed 3173 3174It does not report anything for pattern template IDs that do not exist. 3175The usual error message is shown when a pattern template cannot be destroyed:: 3176 3177 Caught error type [...] ([...]): [...] 3178 3179Creating actions templates 3180~~~~~~~~~~~~~~~~~~~~~~~~~~ 3181 3182``flow actions_template create`` creates the specified actions template. 3183It is bound to ``rte_flow_actions_template_create()``:: 3184 3185 flow actions_template {port_id} create [actions_template_id {id}] 3186 [ingress] [egress] [transfer] 3187 template {action} [/ {action} [...]] / end 3188 mask {action} [/ {action} [...]] / end 3189 3190If successful, it will show:: 3191 3192 Actions template #[...] created 3193 3194Otherwise it will show an error message of the form:: 3195 3196 Caught error type [...] ([...]): [...] 3197 3198This command uses the same actions as ``flow create``, 3199their format is described in `Creating flow rules`_. 3200 3201Destroying actions templates 3202~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3203 3204``flow actions_template destroy`` destroys one or more actions templates 3205from their template ID (as returned by ``flow actions_template create``), 3206this command calls ``rte_flow_actions_template_destroy()`` as many 3207times as necessary:: 3208 3209 flow actions_template {port_id} destroy actions_template {id} [...] 3210 3211If successful, it will show:: 3212 3213 Actions template #[...] destroyed 3214 3215It does not report anything for actions template IDs that do not exist. 3216The usual error message is shown when an actions template cannot be destroyed:: 3217 3218 Caught error type [...] ([...]): [...] 3219 3220Creating template table 3221~~~~~~~~~~~~~~~~~~~~~~~ 3222 3223``flow template_table create`` creates the specified template table. 3224It is bound to ``rte_flow_template_table_create()``:: 3225 3226 flow template_table {port_id} create 3227 [table_id {id}] [group {group_id}] 3228 [priority {level}] [ingress] [egress] 3229 [transfer [vport_orig] [wire_orig]] 3230 rules_number {number} 3231 pattern_template {pattern_template_id} 3232 actions_template {actions_template_id} 3233 3234If successful, it will show:: 3235 3236 Template table #[...] created 3237 3238Otherwise it will show an error message of the form:: 3239 3240 Caught error type [...] ([...]): [...] 3241 3242Destroying flow table 3243~~~~~~~~~~~~~~~~~~~~~ 3244 3245``flow template_table destroy`` destroys one or more template tables 3246from their table ID (as returned by ``flow template_table create``), 3247this command calls ``rte_flow_template_table_destroy()`` as many 3248times as necessary:: 3249 3250 flow template_table {port_id} destroy table {id} [...] 3251 3252If successful, it will show:: 3253 3254 Template table #[...] destroyed 3255 3256It does not report anything for table IDs that do not exist. 3257The usual error message is shown when a table cannot be destroyed:: 3258 3259 Caught error type [...] ([...]): [...] 3260 3261Pushing enqueued operations 3262~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3263 3264``flow push`` pushes all the outstanding enqueued operations 3265to the underlying device immediately. 3266It is bound to ``rte_flow_push()``:: 3267 3268 flow push {port_id} queue {queue_id} 3269 3270If successful, it will show:: 3271 3272 Queue #[...] operations pushed 3273 3274The usual error message is shown when operations cannot be pushed:: 3275 3276 Caught error type [...] ([...]): [...] 3277 3278Pulling flow operations results 3279~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3280 3281``flow pull`` asks the underlying device about flow queue operations 3282results and return all the processed (successfully or not) operations. 3283It is bound to ``rte_flow_pull()``:: 3284 3285 flow pull {port_id} queue {queue_id} 3286 3287If successful, it will show:: 3288 3289 Queue #[...] pulled #[...] operations (#[...] failed, #[...] succeeded) 3290 3291The usual error message is shown when operations results cannot be pulled:: 3292 3293 Caught error type [...] ([...]): [...] 3294 3295Calculating hash 3296~~~~~~~~~~~~~~~~ 3297 3298``flow hash`` calculates the hash for a given pattern. 3299It is bound to ``rte_flow_calc_table_hash()``:: 3300 3301 flow hash {port_id} template_table {table_id} 3302 pattern_template {pattern_template_index} 3303 actions_template {actions_template_index} 3304 pattern {item} [/ {item} [...]] / end 3305 3306If successful, it will show the calculated hash result as seen below:: 3307 3308 Hash results 0x[...] 3309 3310Otherwise, it will show an error message of the form:: 3311 3312 Caught error type [...] ([...]): [...] 3313 3314This command uses the same pattern items as ``flow create``, 3315their format is described in `Creating flow rules`_. 3316 3317Creating a tunnel stub for offload 3318~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3319 3320``flow tunnel create`` setup a tunnel stub for tunnel offload flow rules:: 3321 3322 flow tunnel create {port_id} type {tunnel_type} 3323 3324If successful, it will return a tunnel stub ID usable with other commands:: 3325 3326 port [...]: flow tunnel #[...] type [...] 3327 3328Tunnel stub ID is relative to a port. 3329 3330Destroying tunnel offload stub 3331~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3332 3333``flow tunnel destroy`` destroy port tunnel stub:: 3334 3335 flow tunnel destroy {port_id} id {tunnel_id} 3336 3337Listing tunnel offload stubs 3338~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3339 3340``flow tunnel list`` list port tunnel offload stubs:: 3341 3342 flow tunnel list {port_id} 3343 3344Validating flow rules 3345~~~~~~~~~~~~~~~~~~~~~ 3346 3347``flow validate`` reports whether a flow rule would be accepted by the 3348underlying device in its current state but stops short of creating it. It is 3349bound to ``rte_flow_validate()``:: 3350 3351 flow validate {port_id} 3352 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3353 pattern {item} [/ {item} [...]] / end 3354 actions {action} [/ {action} [...]] / end 3355 3356If successful, it will show:: 3357 3358 Flow rule validated 3359 3360Otherwise it will show an error message of the form:: 3361 3362 Caught error type [...] ([...]): [...] 3363 3364This command uses the same parameters as ``flow create``, their format is 3365described in `Creating flow rules`_. 3366 3367Check whether redirecting any Ethernet packet received on port 0 to RX queue 3368index 6 is supported:: 3369 3370 testpmd> flow validate 0 ingress pattern eth / end 3371 actions queue index 6 / end 3372 Flow rule validated 3373 testpmd> 3374 3375Port 0 does not support TCPv6 rules:: 3376 3377 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end 3378 actions drop / end 3379 Caught error type 9 (specific pattern item): Invalid argument 3380 testpmd> 3381 3382Creating flow rules 3383~~~~~~~~~~~~~~~~~~~ 3384 3385``flow create`` validates and creates the specified flow rule. It is bound 3386to ``rte_flow_create()``:: 3387 3388 flow create {port_id} 3389 [group {group_id}] [priority {level}] [ingress] [egress] [transfer] 3390 [tunnel_set {tunnel_id}] [tunnel_match {tunnel_id}] 3391 [user_id {user_id}] pattern {item} [/ {item} [...]] / end 3392 actions {action} [/ {action} [...]] / end 3393 3394If successful, it will return a flow rule ID usable with other commands:: 3395 3396 Flow rule #[...] created 3397 3398Or if ``user_id`` is provided:: 3399 3400 Flow rule #[...] created, user-id [...] 3401 3402Otherwise it will show an error message of the form:: 3403 3404 Caught error type [...] ([...]): [...] 3405 3406Parameters describe in the following order: 3407 3408- Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens). 3409- Tunnel offload specification (tunnel_set, tunnel_match) 3410- User identifier for the flow. 3411- A matching pattern, starting with the *pattern* token and terminated by an 3412 *end* pattern item. 3413- Actions, starting with the *actions* token and terminated by an *end* 3414 action. 3415 3416These translate directly to *rte_flow* objects provided as-is to the 3417underlying functions. 3418 3419The shortest valid definition only comprises mandatory tokens:: 3420 3421 testpmd> flow create 0 pattern end actions end 3422 3423Note that PMDs may refuse rules that essentially do nothing such as this 3424one. 3425 3426**All unspecified object values are automatically initialized to 0.** 3427 3428Enqueueing creation of flow rules 3429~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3430 3431``flow queue create`` adds creation operation of a flow rule to a queue. 3432It is bound to ``rte_flow_async_create()``:: 3433 3434 flow queue {port_id} create {queue_id} 3435 [postpone {boolean}] template_table {table_id} 3436 pattern_template {pattern_template_index} 3437 actions_template {actions_template_index} 3438 pattern {item} [/ {item} [...]] / end 3439 actions {action} [/ {action} [...]] / end 3440 3441If successful, it will return a flow rule ID usable with other commands:: 3442 3443 Flow rule #[...] creaion enqueued 3444 3445Otherwise it will show an error message of the form:: 3446 3447 Caught error type [...] ([...]): [...] 3448 3449This command uses the same pattern items and actions as ``flow create``, 3450their format is described in `Creating flow rules`_. 3451 3452``flow queue pull`` must be called to retrieve the operation status. 3453 3454Attributes 3455^^^^^^^^^^ 3456 3457These tokens affect flow rule attributes (``struct rte_flow_attr``) and are 3458specified before the ``pattern`` token. 3459 3460- ``group {group id}``: priority group. 3461- ``priority {level}``: priority level within group. 3462- ``ingress``: rule applies to ingress traffic. 3463- ``egress``: rule applies to egress traffic. 3464- ``transfer``: apply rule directly to endpoints found in pattern. 3465 3466Please note that use of ``transfer`` attribute requires that the flow and 3467its indirect components be managed via so-called ``transfer`` proxy port. 3468See `show flow transfer proxy port ID for the given port`_ for details. 3469 3470Each instance of an attribute specified several times overrides the previous 3471value as shown below (group 4 is used):: 3472 3473 testpmd> flow create 0 group 42 group 24 group 4 [...] 3474 3475Note that once enabled, ``ingress`` and ``egress`` cannot be disabled. 3476 3477While not specifying a direction is an error, some rules may allow both 3478simultaneously. 3479 3480Most rules affect RX therefore contain the ``ingress`` token:: 3481 3482 testpmd> flow create 0 ingress pattern [...] 3483 3484Tunnel offload 3485^^^^^^^^^^^^^^ 3486 3487Indicate tunnel offload rule type 3488 3489- ``tunnel_set {tunnel_id}``: mark rule as tunnel offload decap_set type. 3490- ``tunnel_match {tunnel_id}``: mark rule as tunnel offload match type. 3491 3492Matching pattern 3493^^^^^^^^^^^^^^^^ 3494 3495A matching pattern starts after the ``pattern`` token. It is made of pattern 3496items and is terminated by a mandatory ``end`` item. 3497 3498Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum 3499rte_flow_item_type``). 3500 3501The ``/`` token is used as a separator between pattern items as shown 3502below:: 3503 3504 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...] 3505 3506Note that protocol items like these must be stacked from lowest to highest 3507layer to make sense. For instance, the following rule is either invalid or 3508unlikely to match any packet:: 3509 3510 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...] 3511 3512More information on these restrictions can be found in the *rte_flow* 3513documentation. 3514 3515Several items support additional specification structures, for example 3516``ipv4`` allows specifying source and destination addresses as follows:: 3517 3518 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1 3519 dst is 10.2.0.0 / end [...] 3520 3521This rule matches all IPv4 traffic with the specified properties. 3522 3523In this example, ``src`` and ``dst`` are field names of the underlying 3524``struct rte_flow_item_ipv4`` object. All item properties can be specified 3525in a similar fashion. 3526 3527The ``is`` token means that the subsequent value must be matched exactly, 3528and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item`` 3529accordingly. Possible assignment tokens are: 3530 3531- ``is``: match value perfectly (with full bit-mask). 3532- ``spec``: match value according to configured bit-mask. 3533- ``last``: specify upper bound to establish a range. 3534- ``mask``: specify bit-mask with relevant bits set to one. 3535- ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one. 3536 3537These yield identical results:: 3538 3539 ipv4 src is 10.1.1.1 3540 3541:: 3542 3543 ipv4 src spec 10.1.1.1 src mask 255.255.255.255 3544 3545:: 3546 3547 ipv4 src spec 10.1.1.1 src prefix 32 3548 3549:: 3550 3551 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value 3552 3553:: 3554 3555 ipv4 src is 10.1.1.1 src last 0 # 0 disables range 3556 3557Inclusive ranges can be defined with ``last``:: 3558 3559 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4 3560 3561Note that ``mask`` affects both ``spec`` and ``last``:: 3562 3563 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0 3564 # matches 10.1.0.0 to 10.2.255.255 3565 3566Properties can be modified multiple times:: 3567 3568 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4 3569 3570:: 3571 3572 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16 3573 3574Pattern items 3575^^^^^^^^^^^^^ 3576 3577This section lists supported pattern items and their attributes, if any. 3578 3579- ``end``: end list of pattern items. 3580 3581- ``void``: no-op pattern item. 3582 3583- ``invert``: perform actions when pattern does not match. 3584 3585- ``any``: match any protocol for the current layer. 3586 3587 - ``num {unsigned}``: number of layers covered. 3588 3589- ``port_id``: match traffic from/to a given DPDK port ID. 3590 3591 - ``id {unsigned}``: DPDK port ID. 3592 3593- ``mark``: match value set in previously matched flow rule using the mark action. 3594 3595 - ``id {unsigned}``: arbitrary integer value. 3596 3597- ``raw``: match an arbitrary byte string. 3598 3599 - ``relative {boolean}``: look for pattern after the previous item. 3600 - ``search {boolean}``: search pattern from offset (see also limit). 3601 - ``offset {integer}``: absolute or relative offset for pattern. 3602 - ``limit {unsigned}``: search area limit for start of pattern. 3603 - ``pattern {string}``: byte string to look for. 3604 - ``pattern_hex {string}``: byte string (provided in hexadecimal) to look for. 3605 3606- ``eth``: match Ethernet header. 3607 3608 - ``dst {MAC-48}``: destination MAC. 3609 - ``src {MAC-48}``: source MAC. 3610 - ``type {unsigned}``: EtherType or TPID. 3611 3612- ``vlan``: match 802.1Q/ad VLAN tag. 3613 3614 - ``tci {unsigned}``: tag control information. 3615 - ``pcp {unsigned}``: priority code point. 3616 - ``dei {unsigned}``: drop eligible indicator. 3617 - ``vid {unsigned}``: VLAN identifier. 3618 - ``inner_type {unsigned}``: inner EtherType or TPID. 3619 3620- ``ipv4``: match IPv4 header. 3621 3622 - ``version_ihl {unsigned}``: IPv4 version and IP header length. 3623 - ``tos {unsigned}``: type of service. 3624 - ``ttl {unsigned}``: time to live. 3625 - ``proto {unsigned}``: next protocol ID. 3626 - ``src {ipv4 address}``: source address. 3627 - ``dst {ipv4 address}``: destination address. 3628 3629- ``ipv6``: match IPv6 header. 3630 3631 - ``tc {unsigned}``: traffic class. 3632 - ``flow {unsigned}``: flow label. 3633 - ``proto {unsigned}``: protocol (next header). 3634 - ``hop {unsigned}``: hop limit. 3635 - ``src {ipv6 address}``: source address. 3636 - ``dst {ipv6 address}``: destination address. 3637 3638- ``icmp``: match ICMP header. 3639 3640 - ``type {unsigned}``: ICMP packet type. 3641 - ``code {unsigned}``: ICMP packet code. 3642 3643- ``udp``: match UDP header. 3644 3645 - ``src {unsigned}``: UDP source port. 3646 - ``dst {unsigned}``: UDP destination port. 3647 3648- ``tcp``: match TCP header. 3649 3650 - ``src {unsigned}``: TCP source port. 3651 - ``dst {unsigned}``: TCP destination port. 3652 3653- ``sctp``: match SCTP header. 3654 3655 - ``src {unsigned}``: SCTP source port. 3656 - ``dst {unsigned}``: SCTP destination port. 3657 - ``tag {unsigned}``: validation tag. 3658 - ``cksum {unsigned}``: checksum. 3659 3660- ``vxlan``: match VXLAN header. 3661 3662 - ``vni {unsigned}``: VXLAN identifier. 3663 - ``last_rsvd {unsigned}``: VXLAN last reserved 8-bits. 3664 3665- ``e_tag``: match IEEE 802.1BR E-Tag header. 3666 3667 - ``grp_ecid_b {unsigned}``: GRP and E-CID base. 3668 3669- ``nvgre``: match NVGRE header. 3670 3671 - ``tni {unsigned}``: virtual subnet ID. 3672 3673- ``mpls``: match MPLS header. 3674 3675 - ``label {unsigned}``: MPLS label. 3676 3677- ``gre``: match GRE header. 3678 3679 - ``protocol {unsigned}``: protocol type. 3680 3681- ``gre_key``: match GRE optional key field. 3682 3683 - ``value {unsigned}``: key value. 3684 3685- ``gre_option``: match GRE optional fields(checksum/key/sequence). 3686 3687 - ``checksum {unsigned}``: checksum value. 3688 - ``key {unsigned}``: key value. 3689 - ``sequence {unsigned}``: sequence number value. 3690 3691- ``fuzzy``: fuzzy pattern match, expect faster than default. 3692 3693 - ``thresh {unsigned}``: accuracy threshold. 3694 3695- ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header. 3696 3697 - ``teid {unsigned}``: tunnel endpoint identifier. 3698 3699- ``geneve``: match GENEVE header. 3700 3701 - ``vni {unsigned}``: virtual network identifier. 3702 - ``protocol {unsigned}``: protocol type. 3703 3704- ``geneve-opt``: match GENEVE header option. 3705 3706 - ``class {unsigned}``: GENEVE option class. 3707 - ``type {unsigned}``: GENEVE option type. 3708 - ``length {unsigned}``: GENEVE option length in 32-bit words. 3709 - ``data {hex string}``: GENEVE option data, the length is defined by 3710 ``length`` field. 3711 3712- ``vxlan-gpe``: match VXLAN-GPE header. 3713 3714 - ``vni {unsigned}``: VXLAN-GPE identifier. 3715 3716- ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4. 3717 3718 - ``sha {MAC-48}``: sender hardware address. 3719 - ``spa {ipv4 address}``: sender IPv4 address. 3720 - ``tha {MAC-48}``: target hardware address. 3721 - ``tpa {ipv4 address}``: target IPv4 address. 3722 3723- ``ipv6_ext``: match presence of any IPv6 extension header. 3724 3725 - ``next_hdr {unsigned}``: next header. 3726 3727- ``icmp6``: match any ICMPv6 header. 3728 3729 - ``type {unsigned}``: ICMPv6 type. 3730 - ``code {unsigned}``: ICMPv6 code. 3731 3732- ``icmp6_echo_request``: match ICMPv6 echo request. 3733 3734 - ``ident {unsigned}``: ICMPv6 echo request identifier. 3735 - ``seq {unsigned}``: ICMPv6 echo request sequence number. 3736 3737- ``icmp6_echo_reply``: match ICMPv6 echo reply. 3738 3739 - ``ident {unsigned}``: ICMPv6 echo reply identifier. 3740 - ``seq {unsigned}``: ICMPv6 echo reply sequence number. 3741 3742- ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation. 3743 3744 - ``target_addr {ipv6 address}``: target address. 3745 3746- ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement. 3747 3748 - ``target_addr {ipv6 address}``: target address. 3749 3750- ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option. 3751 3752 - ``type {unsigned}``: ND option type. 3753 3754- ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet 3755 link-layer address option. 3756 3757 - ``sla {MAC-48}``: source Ethernet LLA. 3758 3759- ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet 3760 link-layer address option. 3761 3762 - ``tla {MAC-48}``: target Ethernet LLA. 3763 3764- ``meta``: match application specific metadata. 3765 3766 - ``data {unsigned}``: metadata value. 3767 3768- ``random``: match application specific random value. 3769 3770 - ``value {unsigned}``: random value. 3771 3772- ``gtp_psc``: match GTP PDU extension header with type 0x85. 3773 3774 - ``pdu_type {unsigned}``: PDU type. 3775 3776 - ``qfi {unsigned}``: QoS flow identifier. 3777 3778- ``pppoes``, ``pppoed``: match PPPoE header. 3779 3780 - ``session_id {unsigned}``: session identifier. 3781 3782- ``pppoe_proto_id``: match PPPoE session protocol identifier. 3783 3784 - ``proto_id {unsigned}``: PPP protocol identifier. 3785 3786- ``l2tpv3oip``: match L2TPv3 over IP header. 3787 3788 - ``session_id {unsigned}``: L2TPv3 over IP session identifier. 3789 3790- ``ah``: match AH header. 3791 3792 - ``spi {unsigned}``: security parameters index. 3793 3794- ``pfcp``: match PFCP header. 3795 3796 - ``s_field {unsigned}``: S field. 3797 - ``seid {unsigned}``: session endpoint identifier. 3798 3799- ``integrity``: match packet integrity. 3800 3801 - ``level {unsigned}``: Packet encapsulation level the item should 3802 apply to. See rte_flow_action_rss for details. 3803 - ``value {unsigned}``: A bitmask that specify what packet elements 3804 must be matched for integrity. 3805 3806- ``conntrack``: match conntrack state. 3807 3808- ``port_representor``: match traffic entering the embedded switch from the given ethdev 3809 3810 - ``port_id {unsigned}``: ethdev port ID 3811 3812- ``represented_port``: match traffic entering the embedded switch from 3813 the entity represented by the given ethdev 3814 3815 - ``ethdev_port_id {unsigned}``: ethdev port ID 3816 3817- ``l2tpv2``: match L2TPv2 header. 3818 3819 - ``length {unsigned}``: L2TPv2 option length. 3820 - ``tunnel_id {unsigned}``: L2TPv2 tunnel identifier. 3821 - ``session_id {unsigned}``: L2TPv2 session identifier. 3822 - ``ns {unsigned}``: L2TPv2 option ns. 3823 - ``nr {unsigned}``: L2TPv2 option nr. 3824 - ``offset_size {unsigned}``: L2TPv2 option offset. 3825 3826- ``ppp``: match PPP header. 3827 3828 - ``addr {unsigned}``: PPP address. 3829 - ``ctrl {unsigned}``: PPP control. 3830 - ``proto_id {unsigned}``: PPP protocol identifier. 3831 3832- ``ib_bth``: match InfiniBand BTH(base transport header). 3833 3834 - ``opcode {unsigned}``: Opcode. 3835 - ``pkey {unsigned}``: Partition key. 3836 - ``dst_qp {unsigned}``: Destination Queue Pair. 3837 - ``psn {unsigned}``: Packet Sequence Number. 3838 3839- ``meter``: match meter color. 3840 3841 - ``color {value}``: meter color value (green/yellow/red). 3842 3843- ``aggr_affinity``: match aggregated port. 3844 3845 - ``affinity {value}``: aggregated port (starts from 1). 3846 3847- ``tx_queue``: match Tx queue of sent packet. 3848 3849 - ``tx_queue {value}``: send queue value (starts from 0). 3850 3851- ``send_to_kernel``: send packets to kernel. 3852 3853- ``ptype``: match the packet type (L2/L3/L4 and tunnel information). 3854 3855 - ``packet_type {unsigned}``: packet type. 3856 3857- ``compare``: match the comparison result between packet fields or value. 3858 3859 - ``op {string}``: comparison operation type. 3860 - ``a_type {string}``: compared field. 3861 - ``b_type {string}``: comparator field. 3862 - ``width {unsigned}``: comparison width. 3863 3864 3865Actions list 3866^^^^^^^^^^^^ 3867 3868A list of actions starts after the ``actions`` token in the same fashion as 3869`Matching pattern`_; actions are separated by ``/`` tokens and the list is 3870terminated by a mandatory ``end`` action. 3871 3872Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum 3873rte_flow_action_type``). 3874 3875Dropping all incoming UDPv4 packets can be expressed as follows:: 3876 3877 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3878 actions drop / end 3879 3880Several actions have configurable properties which must be specified when 3881there is no valid default value. For example, ``queue`` requires a target 3882queue index. 3883 3884This rule redirects incoming UDPv4 traffic to queue index 6:: 3885 3886 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3887 actions queue index 6 / end 3888 3889While this one could be rejected by PMDs (unspecified queue index):: 3890 3891 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end 3892 actions queue / end 3893 3894As defined by *rte_flow*, the list is not ordered, all actions of a given 3895rule are performed simultaneously. These are equivalent:: 3896 3897 queue index 6 / void / mark id 42 / end 3898 3899:: 3900 3901 void / mark id 42 / queue index 6 / end 3902 3903All actions in a list should have different types, otherwise only the last 3904action of a given type is taken into account:: 3905 3906 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6 3907 3908:: 3909 3910 drop / drop / drop / end # drop is performed only once 3911 3912:: 3913 3914 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24 3915 3916Considering they are performed simultaneously, opposite and overlapping 3917actions can sometimes be combined when the end result is unambiguous:: 3918 3919 drop / queue index 6 / end # drop has no effect 3920 3921:: 3922 3923 queue index 6 / rss queues 6 7 8 / end # queue has no effect 3924 3925:: 3926 3927 drop / passthru / end # drop has no effect 3928 3929Note that PMDs may still refuse such combinations. 3930 3931Actions 3932^^^^^^^ 3933 3934This section lists supported actions and their attributes, if any. 3935 3936- ``end``: end list of actions. 3937 3938- ``void``: no-op action. 3939 3940- ``passthru``: let subsequent rule process matched packets. 3941 3942- ``jump``: redirect traffic to group on device. 3943 3944 - ``group {unsigned}``: group to redirect to. 3945 3946- ``mark``: attach 32 bit value to packets. 3947 3948 - ``id {unsigned}``: 32 bit value to return with packets. 3949 3950- ``flag``: flag packets. 3951 3952- ``queue``: assign packets to a given queue index. 3953 3954 - ``index {unsigned}``: queue index to use. 3955 3956- ``drop``: drop packets (note: passthru has priority). 3957 3958- ``count``: enable counters for this rule. 3959 3960- ``rss``: spread packets among several queues. 3961 3962 - ``func {hash function}``: RSS hash function to apply, allowed tokens are 3963 ``toeplitz``, ``simple_xor``, ``symmetric_toeplitz`` and ``default``. 3964 3965 - ``level {unsigned}``: encapsulation level for ``types``. 3966 3967 - ``types [{RSS hash type} [...]] end``: specific RSS hash types. 3968 Note that an empty list does not disable RSS but instead requests 3969 unspecified "best-effort" settings. 3970 3971 - ``key {string}``: RSS hash key, overrides ``key_len``. 3972 3973 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in 3974 conjunction with ``key`` to pad or truncate it. 3975 3976 - ``queues [{unsigned} [...]] end``: queue indices to use. 3977 3978- ``pf``: direct traffic to physical function. 3979 3980- ``vf``: direct traffic to a virtual function ID. 3981 3982 - ``original {boolean}``: use original VF ID if possible. 3983 - ``id {unsigned}``: VF ID. 3984 3985- ``port_id``: direct matching traffic to a given DPDK port ID. 3986 3987 - ``original {boolean}``: use original DPDK port ID if possible. 3988 - ``id {unsigned}``: DPDK port ID. 3989 3990- ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``. 3991 3992 - ``mpls_ttl``: MPLS TTL. 3993 3994- ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``. 3995 3996- ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``. 3997 3998 - ``nw_ttl``: IP TTL. 3999 4000- ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``. 4001 4002- ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``. 4003 4004- ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``. 4005 4006- ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``. 4007 4008- ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``. 4009 4010 - ``ethertype``: Ethertype. 4011 4012- ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``. 4013 4014 - ``vlan_vid``: VLAN id. 4015 4016- ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``. 4017 4018 - ``vlan_pcp``: VLAN priority. 4019 4020- ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``. 4021 4022 - ``ethertype``: Ethertype. 4023 4024- ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``. 4025 4026 - ``ethertype``: Ethertype. 4027 4028- ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration 4029 is done through `Config VXLAN Encap outer layers`_. 4030 4031- ``vxlan_decap``: Performs a decapsulation action by stripping all headers of 4032 the VXLAN tunnel network overlay from the matched flow. 4033 4034- ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration 4035 is done through `Config NVGRE Encap outer layers`_. 4036 4037- ``nvgre_decap``: Performs a decapsulation action by stripping all headers of 4038 the NVGRE tunnel network overlay from the matched flow. 4039 4040- ``l2_encap``: Performs a L2 encapsulation, L2 configuration 4041 is done through `Config L2 Encap`_. 4042 4043- ``l2_decap``: Performs a L2 decapsulation, L2 configuration 4044 is done through `Config L2 Decap`_. 4045 4046- ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer 4047 configuration is done through `Config MPLSoGRE Encap outer layers`_. 4048 4049- ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer 4050 configuration is done through `Config MPLSoGRE Decap outer layers`_. 4051 4052- ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer 4053 configuration is done through `Config MPLSoUDP Encap outer layers`_. 4054 4055- ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer 4056 configuration is done through `Config MPLSoUDP Decap outer layers`_. 4057 4058- ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header. 4059 4060 - ``ipv4_addr``: New IPv4 source address. 4061 4062- ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4 4063 header. 4064 4065 - ``ipv4_addr``: New IPv4 destination address. 4066 4067- ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header. 4068 4069 - ``ipv6_addr``: New IPv6 source address. 4070 4071- ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6 4072 header. 4073 4074 - ``ipv6_addr``: New IPv6 destination address. 4075 4076- ``set_tp_src``: Set a new source port number in the outermost TCP/UDP 4077 header. 4078 4079 - ``port``: New TCP/UDP source port number. 4080 4081- ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP 4082 header. 4083 4084 - ``port``: New TCP/UDP destination port number. 4085 4086- ``mac_swap``: Swap the source and destination MAC addresses in the outermost 4087 Ethernet header. 4088 4089- ``dec_ttl``: Performs a decrease TTL value action 4090 4091- ``set_ttl``: Set TTL value with specified value 4092 - ``ttl_value {unsigned}``: The new TTL value to be set 4093 4094- ``set_mac_src``: set source MAC address 4095 4096 - ``mac_addr {MAC-48}``: new source MAC address 4097 4098- ``set_mac_dst``: set destination MAC address 4099 4100 - ``mac_addr {MAC-48}``: new destination MAC address 4101 4102- ``inc_tcp_seq``: Increase sequence number in the outermost TCP header. 4103 4104 - ``value {unsigned}``: Value to increase TCP sequence number by. 4105 4106- ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header. 4107 4108 - ``value {unsigned}``: Value to decrease TCP sequence number by. 4109 4110- ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header. 4111 4112 - ``value {unsigned}``: Value to increase TCP acknowledgment number by. 4113 4114- ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header. 4115 4116 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by. 4117 4118- ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value 4119 4120 - ``dscp_value {unsigned}``: The new DSCP value to be set 4121 4122- ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value 4123 4124 - ``dscp_value {unsigned}``: The new DSCP value to be set 4125 4126- ``indirect``: Use indirect action created via 4127 ``flow indirect_action {port_id} create`` 4128 4129 - ``indirect_action_id {unsigned}``: Indirect action ID to use 4130 4131- ``color``: Color the packet to reflect the meter color result 4132 4133 - ``type {value}``: Set color type with specified value(green/yellow/red) 4134 4135- ``port_representor``: at embedded switch level, send matching traffic to 4136 the given ethdev 4137 4138 - ``port_id {unsigned}``: ethdev port ID 4139 4140- ``represented_port``: at embedded switch level, send matching traffic to 4141 the entity represented by the given ethdev 4142 4143 - ``ethdev_port_id {unsigned}``: ethdev port ID 4144 4145- ``meter_mark``: meter the directed packets using profile and policy 4146 4147 - ``mtr_profile {unsigned}``: meter profile ID to use 4148 - ``mtr_policy {unsigned}``: meter policy ID to use 4149 - ``mtr_color_mode {unsigned}``: meter color-awareness mode (blind/aware) 4150 - ``mtr_init_color {value}``: initial color value (green/yellow/red) 4151 - ``mtr_state {unsigned}``: meter state (disabled/enabled) 4152 4153- ``modify_field``: Modify packet field 4154 4155 - ``op``: modify operation (set/add/sub) 4156 - ``dst_type``: the destination field to be modified, the supported fields as 4157 ``enum rte_flow_field_id`` listed. 4158 - ``dst_level``: destination field level. 4159 - ``dst_tag_index``: destination field tag array. 4160 - ``dst_type_id``: destination field type ID. 4161 - ``dst_class``: destination field class ID. 4162 - ``dst_offset``: destination field bit offset. 4163 - ``src_type``: the modify source field, the supported fields as 4164 ``enum rte_flow_field_id`` listed. 4165 - ``src_level``: source field level. 4166 - ``src_tag_index``: source field tag array. 4167 - ``src_type_id``: source field type ID. 4168 - ``src_class``: source field class ID. 4169 - ``src_offset``: source field bit offset. 4170 - ``src_value``: source immediate value. 4171 - ``src_ptr``: pointer to source immediate value. 4172 - ``width``: number of bits to copy. 4173 4174- ``nat64``: NAT64 IP headers translation 4175 4176 - ``type {unsigned}``: NAT64 translation type 4177 4178Destroying flow rules 4179~~~~~~~~~~~~~~~~~~~~~ 4180 4181``flow destroy`` destroys one or more rules from their rule ID (as returned 4182by ``flow create``), this command calls ``rte_flow_destroy()`` as many 4183times as necessary:: 4184 4185 flow destroy {port_id} rule {rule_id} [...] [user_id] 4186 4187If successful, it will show:: 4188 4189 Flow rule #[...] destroyed 4190 4191Or if ``user_id`` flag is provided:: 4192 4193 Flow rule #[...] destroyed, user-id [...] 4194 4195Optional ``user_id`` is a flag that signifies the rule ID 4196is the one provided by the user at creation. 4197It does not report anything for rule IDs that do not exist. The usual error 4198message is shown when a rule cannot be destroyed:: 4199 4200 Caught error type [...] ([...]): [...] 4201 4202``flow flush`` destroys all rules on a device and does not take extra 4203arguments. It is bound to ``rte_flow_flush()``:: 4204 4205 flow flush {port_id} 4206 4207Any errors are reported as above. 4208 4209Creating several rules and destroying them:: 4210 4211 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4212 actions queue index 2 / end 4213 Flow rule #0 created 4214 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4215 actions queue index 3 / end 4216 Flow rule #1 created 4217 testpmd> flow destroy 0 rule 0 rule 1 4218 Flow rule #1 destroyed 4219 Flow rule #0 destroyed 4220 testpmd> 4221 4222The same result can be achieved using ``flow flush``:: 4223 4224 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4225 actions queue index 2 / end 4226 Flow rule #0 created 4227 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4228 actions queue index 3 / end 4229 Flow rule #1 created 4230 testpmd> flow flush 0 4231 testpmd> 4232 4233Non-existent rule IDs are ignored:: 4234 4235 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4236 actions queue index 2 / end 4237 Flow rule #0 created 4238 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4239 actions queue index 3 / end 4240 Flow rule #1 created 4241 testpmd> flow destroy 0 rule 42 rule 10 rule 2 4242 testpmd> 4243 testpmd> flow destroy 0 rule 0 4244 Flow rule #0 destroyed 4245 testpmd> 4246 4247Enqueueing destruction of flow rules 4248~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4249 4250``flow queue destroy`` adds destruction operations to destroy one or more rules 4251from their rule ID (as returned by ``flow queue create``) to a queue, 4252this command calls ``rte_flow_async_destroy()`` as many times as necessary:: 4253 4254 flow queue {port_id} destroy {queue_id} 4255 [postpone {boolean}] rule {rule_id} [...] 4256 4257If successful, it will show:: 4258 4259 Flow rule #[...] destruction enqueued 4260 4261It does not report anything for rule IDs that do not exist. The usual error 4262message is shown when a rule cannot be destroyed:: 4263 4264 Caught error type [...] ([...]): [...] 4265 4266``flow queue pull`` must be called to retrieve the operation status. 4267 4268Querying flow rules 4269~~~~~~~~~~~~~~~~~~~ 4270 4271``flow query`` queries a specific action of a flow rule having that 4272ability. Such actions collect information that can be reported using this 4273command. It is bound to ``rte_flow_query()``:: 4274 4275 flow query {port_id} {rule_id} {action} [user_id] 4276 4277Optional ``user_id`` is a flag that signifies the rule ID 4278is the one provided by the user at creation. 4279If successful, it will display either the retrieved data for known actions 4280or the following message:: 4281 4282 Cannot display result for action type [...] ([...]) 4283 4284Otherwise, it will complain either that the rule does not exist or that some 4285error occurred:: 4286 4287 Flow rule #[...] not found 4288 4289:: 4290 4291 Caught error type [...] ([...]): [...] 4292 4293Currently only the ``count`` action is supported. This action reports the 4294number of packets that hit the flow rule and the total number of bytes. Its 4295output has the following format:: 4296 4297 count: 4298 hits_set: [...] # whether "hits" contains a valid value 4299 bytes_set: [...] # whether "bytes" contains a valid value 4300 hits: [...] # number of packets 4301 bytes: [...] # number of bytes 4302 4303Querying counters for TCPv6 packets redirected to queue 6:: 4304 4305 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end 4306 actions queue index 6 / count / end 4307 Flow rule #4 created 4308 testpmd> flow query 0 4 count 4309 count: 4310 hits_set: 1 4311 bytes_set: 0 4312 hits: 386446 4313 bytes: 0 4314 testpmd> 4315 4316Listing flow rules 4317~~~~~~~~~~~~~~~~~~ 4318 4319``flow list`` lists existing flow rules sorted by priority and optionally 4320filtered by group identifiers:: 4321 4322 flow list {port_id} [group {group_id}] [...] 4323 4324This command only fails with the following message if the device does not 4325exist:: 4326 4327 Invalid port [...] 4328 4329Output consists of a header line followed by a short description of each 4330flow rule, one per line. There is no output at all when no flow rules are 4331configured on the device:: 4332 4333 ID Group Prio Attr Rule 4334 [...] [...] [...] [...] [...] 4335 4336``Attr`` column flags: 4337 4338- ``i`` for ``ingress``. 4339- ``e`` for ``egress``. 4340 4341Creating several flow rules and listing them:: 4342 4343 testpmd> flow create 0 ingress pattern eth / ipv4 / end 4344 actions queue index 6 / end 4345 Flow rule #0 created 4346 testpmd> flow create 0 ingress pattern eth / ipv6 / end 4347 actions queue index 2 / end 4348 Flow rule #1 created 4349 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end 4350 actions rss queues 6 7 8 end / end 4351 Flow rule #2 created 4352 testpmd> flow list 0 4353 ID Group Prio Attr Rule 4354 0 0 0 i- ETH IPV4 => QUEUE 4355 1 0 0 i- ETH IPV6 => QUEUE 4356 2 0 5 i- ETH IPV4 UDP => RSS 4357 testpmd> 4358 4359Rules are sorted by priority (i.e. group ID first, then priority level):: 4360 4361 testpmd> flow list 1 4362 ID Group Prio Attr Rule 4363 0 0 0 i- ETH => COUNT 4364 6 0 500 i- ETH IPV6 TCP => DROP COUNT 4365 5 0 1000 i- ETH IPV6 ICMP => QUEUE 4366 1 24 0 i- ETH IPV4 UDP => QUEUE 4367 4 24 10 i- ETH IPV4 TCP => DROP 4368 3 24 20 i- ETH IPV4 => DROP 4369 2 24 42 i- ETH IPV4 UDP => QUEUE 4370 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE 4371 testpmd> 4372 4373Output can be limited to specific groups:: 4374 4375 testpmd> flow list 1 group 0 group 63 4376 ID Group Prio Attr Rule 4377 0 0 0 i- ETH => COUNT 4378 6 0 500 i- ETH IPV6 TCP => DROP COUNT 4379 5 0 1000 i- ETH IPV6 ICMP => QUEUE 4380 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE 4381 testpmd> 4382 4383Toggling isolated mode 4384~~~~~~~~~~~~~~~~~~~~~~ 4385 4386``flow isolate`` can be used to tell the underlying PMD that ingress traffic 4387must only be injected from the defined flow rules; that no default traffic 4388is expected outside those rules and the driver is free to assign more 4389resources to handle them. It is bound to ``rte_flow_isolate()``:: 4390 4391 flow isolate {port_id} {boolean} 4392 4393If successful, enabling or disabling isolated mode shows either:: 4394 4395 Ingress traffic on port [...] 4396 is now restricted to the defined flow rules 4397 4398Or:: 4399 4400 Ingress traffic on port [...] 4401 is not restricted anymore to the defined flow rules 4402 4403Otherwise, in case of error:: 4404 4405 Caught error type [...] ([...]): [...] 4406 4407Mainly due to its side effects, PMDs supporting this mode may not have the 4408ability to toggle it more than once without reinitializing affected ports 4409first (e.g. by exiting testpmd). 4410 4411Enabling isolated mode:: 4412 4413 testpmd> flow isolate 0 true 4414 Ingress traffic on port 0 is now restricted to the defined flow rules 4415 testpmd> 4416 4417Disabling isolated mode:: 4418 4419 testpmd> flow isolate 0 false 4420 Ingress traffic on port 0 is not restricted anymore to the defined flow rules 4421 testpmd> 4422 4423Dumping HW internal information 4424~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4425 4426``flow dump`` dumps the hardware's internal representation information of 4427all flows. It is bound to ``rte_flow_dev_dump()``:: 4428 4429 flow dump {port_id} {output_file} [user_id] 4430 4431If successful, it will show:: 4432 4433 Flow dump finished 4434 4435Otherwise, it will complain error occurred:: 4436 4437 Caught error type [...] ([...]): [...] 4438 4439Optional ``user_id`` is a flag that signifies the rule ID 4440is the one provided by the user at creation. 4441 4442Listing and destroying aged flow rules 4443~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4444 4445``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``, 4446and ``destroy`` parameter can be used to destroy those flow rules in PMD:: 4447 4448 flow aged {port_id} [destroy] 4449 4450Listing current aged flow rules:: 4451 4452 testpmd> flow aged 0 4453 Port 0 total aged flows: 0 4454 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.14 / end 4455 actions age timeout 5 / queue index 0 / end 4456 Flow rule #0 created 4457 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.15 / end 4458 actions age timeout 4 / queue index 0 / end 4459 Flow rule #1 created 4460 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.16 / end 4461 actions age timeout 2 / queue index 0 / end 4462 Flow rule #2 created 4463 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.17 / end 4464 actions age timeout 3 / queue index 0 / end 4465 Flow rule #3 created 4466 4467 4468Aged Rules are simply list as command ``flow list {port_id}``, but strip the detail rule 4469information, all the aged flows are sorted by the longest timeout time. For example, if 4470those rules be configured in the same time, ID 2 will be the first aged out rule, the next 4471will be ID 3, ID 1, ID 0:: 4472 4473 testpmd> flow aged 0 4474 Port 0 total aged flows: 4 4475 ID Group Prio Attr 4476 2 0 0 i-- 4477 3 0 0 i-- 4478 1 0 0 i-- 4479 0 0 0 i-- 4480 4481If attach ``destroy`` parameter, the command will destroy all the list aged flow rules:: 4482 4483 testpmd> flow aged 0 destroy 4484 Port 0 total aged flows: 4 4485 ID Group Prio Attr 4486 2 0 0 i-- 4487 3 0 0 i-- 4488 1 0 0 i-- 4489 0 0 0 i-- 4490 4491 Flow rule #2 destroyed 4492 Flow rule #3 destroyed 4493 Flow rule #1 destroyed 4494 Flow rule #0 destroyed 4495 4 flows be destroyed 4496 testpmd> flow aged 0 4497 Port 0 total aged flows: 0 4498 4499 4500Enqueueing listing and destroying aged flow rules 4501~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4502 4503``flow queue aged`` simply lists aged flow rules be get from 4504``rte_flow_get_q_aged_flows`` API, and ``destroy`` parameter can be used to 4505destroy those flow rules in PMD:: 4506 4507 flow queue {port_id} aged {queue_id} [destroy] 4508 4509Listing current aged flow rules:: 4510 4511 testpmd> flow queue 0 aged 0 4512 Port 0 queue 0 total aged flows: 0 4513 testpmd> flow queue 0 create 0 ingress tanle 0 item_template 0 action_template 0 4514 pattern eth / ipv4 src is 2.2.2.14 / end 4515 actions age timeout 5 / queue index 0 / end 4516 Flow rule #0 creation enqueued 4517 testpmd> flow queue 0 create 0 ingress tanle 0 item_template 0 action_template 0 4518 pattern eth / ipv4 src is 2.2.2.15 / end 4519 actions age timeout 4 / queue index 0 / end 4520 Flow rule #1 creation enqueued 4521 testpmd> flow queue 0 create 0 ingress tanle 0 item_template 0 action_template 0 4522 pattern eth / ipv4 src is 2.2.2.16 / end 4523 actions age timeout 4 / queue index 0 / end 4524 Flow rule #2 creation enqueued 4525 testpmd> flow queue 0 create 0 ingress tanle 0 item_template 0 action_template 0 4526 pattern eth / ipv4 src is 2.2.2.17 / end 4527 actions age timeout 4 / queue index 0 / end 4528 Flow rule #3 creation enqueued 4529 testpmd> flow pull 0 queue 0 4530 Queue #0 pulled 4 operations (0 failed, 4 succeeded) 4531 4532Aged Rules are simply list as command ``flow queue {port_id} list {queue_id}``, 4533but strip the detail rule information, all the aged flows are sorted by the 4534longest timeout time. For example, if those rules is configured in the same time, 4535ID 2 will be the first aged out rule, the next will be ID 3, ID 1, ID 0:: 4536 4537 testpmd> flow queue 0 aged 0 4538 Port 0 queue 0 total aged flows: 4 4539 ID Group Prio Attr 4540 2 0 0 --- 4541 3 0 0 --- 4542 1 0 0 --- 4543 0 0 0 --- 4544 4545 0 flows destroyed 4546 4547If attach ``destroy`` parameter, the command will destroy all the list aged flow rules:: 4548 4549 testpmd> flow queue 0 aged 0 destroy 4550 Port 0 queue 0 total aged flows: 4 4551 ID Group Prio Attr 4552 2 0 0 --- 4553 3 0 0 --- 4554 1 0 0 --- 4555 0 0 0 --- 4556 Flow rule #2 destruction enqueued 4557 Flow rule #3 destruction enqueued 4558 Flow rule #1 destruction enqueued 4559 Flow rule #0 destruction enqueued 4560 4561 4 flows destroyed 4562 testpmd> flow queue 0 aged 0 4563 Port 0 total aged flows: 0 4564 4565.. note:: 4566 4567 The queue must be empty before attaching ``destroy`` parameter. 4568 4569 4570Creating indirect actions 4571~~~~~~~~~~~~~~~~~~~~~~~~~ 4572 4573``flow indirect_action {port_id} create`` creates indirect action with optional 4574indirect action ID. It is bound to ``rte_flow_action_handle_create()``:: 4575 4576 flow indirect_action {port_id} create [action_id {indirect_action_id}] 4577 [ingress] [egress] [transfer] action {action} / end 4578 4579If successful, it will show:: 4580 4581 Indirect action #[...] created 4582 4583Otherwise, it will complain either that indirect action already exists or that 4584some error occurred:: 4585 4586 Indirect action #[...] is already assigned, delete it first 4587 4588:: 4589 4590 Caught error type [...] ([...]): [...] 4591 4592Create indirect rss action with id 100 to queues 1 and 2 on port 0:: 4593 4594 testpmd> flow indirect_action 0 create action_id 100 \ 4595 ingress action rss queues 1 2 end / end 4596 4597Create indirect rss action with id assigned by testpmd to queues 1 and 2 on 4598port 0:: 4599 4600 testpmd> flow indirect_action 0 create action_id \ 4601 ingress action rss queues 0 1 end / end 4602 4603Enqueueing creation of indirect actions 4604~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4605 4606``flow queue indirect_action create`` adds creation operation of an indirect 4607action to a queue. It is bound to ``rte_flow_async_action_handle_create()``:: 4608 4609 flow queue {port_id} create {queue_id} [postpone {boolean}] 4610 table {table_id} item_template {item_template_id} 4611 action_template {action_template_id} 4612 pattern {item} [/ {item} [...]] / end 4613 actions {action} [/ {action} [...]] / end 4614 4615If successful, it will show:: 4616 4617 Indirect action #[...] creation queued 4618 4619Otherwise it will show an error message of the form:: 4620 4621 Caught error type [...] ([...]): [...] 4622 4623This command uses the same parameters as ``flow indirect_action create``, 4624described in `Creating indirect actions`_. 4625 4626``flow queue pull`` must be called to retrieve the operation status. 4627 4628Updating indirect actions 4629~~~~~~~~~~~~~~~~~~~~~~~~~ 4630 4631``flow indirect_action {port_id} update`` updates configuration of the indirect 4632action from its indirect action ID (as returned by 4633``flow indirect_action {port_id} create``). It is bound to 4634``rte_flow_action_handle_update()``:: 4635 4636 flow indirect_action {port_id} update {indirect_action_id} 4637 action {action} / end 4638 4639If successful, it will show:: 4640 4641 Indirect action #[...] updated 4642 4643Otherwise, it will complain either that indirect action not found or that some 4644error occurred:: 4645 4646 Failed to find indirect action #[...] on port [...] 4647 4648:: 4649 4650 Caught error type [...] ([...]): [...] 4651 4652Update indirect rss action having id 100 on port 0 with rss to queues 0 and 3 4653(in create example above rss queues were 1 and 2):: 4654 4655 testpmd> flow indirect_action 0 update 100 action rss queues 0 3 end / end 4656 4657Enqueueing update of indirect actions 4658~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4659 4660``flow queue indirect_action update`` adds update operation for an indirect 4661action to a queue. It is bound to ``rte_flow_async_action_handle_update()``:: 4662 4663 flow queue {port_id} indirect_action {queue_id} update 4664 {indirect_action_id} [postpone {boolean}] action {action} / end 4665 4666If successful, it will show:: 4667 4668 Indirect action #[...] update queued 4669 4670Otherwise it will show an error message of the form:: 4671 4672 Caught error type [...] ([...]): [...] 4673 4674``flow queue pull`` must be called to retrieve the operation status. 4675 4676Destroying indirect actions 4677~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4678 4679``flow indirect_action {port_id} destroy`` destroys one or more indirect actions 4680from their indirect action IDs (as returned by 4681``flow indirect_action {port_id} create``). It is bound to 4682``rte_flow_action_handle_destroy()``:: 4683 4684 flow indirect_action {port_id} destroy action_id {indirect_action_id} [...] 4685 4686If successful, it will show:: 4687 4688 Indirect action #[...] destroyed 4689 4690It does not report anything for indirect action IDs that do not exist. 4691The usual error message is shown when a indirect action cannot be destroyed:: 4692 4693 Caught error type [...] ([...]): [...] 4694 4695Destroy indirect actions having id 100 & 101:: 4696 4697 testpmd> flow indirect_action 0 destroy action_id 100 action_id 101 4698 4699Enqueueing destruction of indirect actions 4700~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4701 4702``flow queue indirect_action destroy`` adds destruction operation to destroy 4703one or more indirect actions from their indirect action IDs (as returned by 4704``flow queue {port_id} indirect_action {queue_id} create``) to a queue. 4705It is bound to ``rte_flow_async_action_handle_destroy()``:: 4706 4707 flow queue {port_id} indirect_action {queue_id} destroy 4708 [postpone {boolean}] action_id {indirect_action_id} [...] 4709 4710If successful, it will show:: 4711 4712 Indirect action #[...] destruction queued 4713 4714Otherwise it will show an error message of the form:: 4715 4716 Caught error type [...] ([...]): [...] 4717 4718``flow queue pull`` must be called to retrieve the operation status. 4719 4720Query indirect actions 4721~~~~~~~~~~~~~~~~~~~~~~ 4722 4723``flow indirect_action {port_id} query`` queries the indirect action from its 4724indirect action ID (as returned by ``flow indirect_action {port_id} create``). 4725It is bound to ``rte_flow_action_handle_query()``:: 4726 4727 flow indirect_action {port_id} query {indirect_action_id} 4728 4729Currently only rss indirect action supported. If successful, it will show:: 4730 4731 Indirect RSS action: 4732 refs:[...] 4733 4734Otherwise, it will complain either that indirect action not found or that some 4735error occurred:: 4736 4737 Failed to find indirect action #[...] on port [...] 4738 4739:: 4740 4741 Caught error type [...] ([...]): [...] 4742 4743Query indirect action having id 100:: 4744 4745 testpmd> flow indirect_action 0 query 100 4746 4747Enqueueing query of indirect actions 4748~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4749 4750``flow queue indirect_action query`` adds query operation for an indirect 4751action to a queue. It is bound to ``rte_flow_async_action_handle_query()``:: 4752 4753 flow queue {port_id} indirect_action {queue_id} query 4754 {indirect_action_id} [postpone {boolean}] 4755 4756If successful, it will show:: 4757 4758 Indirect action #[...] query queued 4759 4760Otherwise it will show an error message of the form:: 4761 4762 Caught error type [...] ([...]): [...] 4763 4764``flow queue pull`` must be called to retrieve the operation status. 4765 4766Sample QinQ flow rules 4767~~~~~~~~~~~~~~~~~~~~~~ 4768 4769Before creating QinQ rule(s) the following commands should be issued to enable QinQ:: 4770 4771 testpmd> port stop 0 4772 testpmd> vlan set extend on 0 4773 4774The above command sets the inner and outer TPID's to 0x8100. 4775 4776To change the TPID's the following commands should be used:: 4777 4778 testpmd> vlan set outer tpid 0x88A8 0 4779 testpmd> vlan set inner tpid 0x8100 0 4780 testpmd> port start 0 4781 4782Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM. 4783 4784:: 4785 4786 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 / 4787 vlan tci is 456 / end actions vf id 1 / queue index 0 / end 4788 Flow rule #0 validated 4789 4790 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 / 4791 vlan tci is 456 / end actions vf id 123 / queue index 0 / end 4792 Flow rule #0 created 4793 4794 testpmd> flow list 0 4795 ID Group Prio Attr Rule 4796 0 0 0 i- ETH VLAN VLAN=>VF QUEUE 4797 4798Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host. 4799 4800:: 4801 4802 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 / 4803 vlan tci is 654 / end actions pf / queue index 0 / end 4804 Flow rule #1 validated 4805 4806 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 / 4807 vlan tci is 654 / end actions pf / queue index 1 / end 4808 Flow rule #1 created 4809 4810 testpmd> flow list 0 4811 ID Group Prio Attr Rule 4812 0 0 0 i- ETH VLAN VLAN=>VF QUEUE 4813 1 0 0 i- ETH VLAN VLAN=>PF QUEUE 4814 4815Sample VXLAN flow rules 4816~~~~~~~~~~~~~~~~~~~~~~~ 4817 4818Before creating VXLAN rule(s), the UDP port should be added for VXLAN packet 4819filter on a port:: 4820 4821 testpmd> rx_vxlan_port add 4789 0 4822 4823Create VXLAN rules on port 0 to steer traffic to PF queues. 4824 4825:: 4826 4827 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / 4828 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 1 / end 4829 Flow rule #0 created 4830 4831 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 3 / 4832 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 2 / end 4833 Flow rule #1 created 4834 4835 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / 4836 eth dst is 00:11:22:33:44:55 / vlan tci is 10 / end actions pf / 4837 queue index 3 / end 4838 Flow rule #2 created 4839 4840 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 5 / 4841 eth dst is 00:11:22:33:44:55 / vlan tci is 20 / end actions pf / 4842 queue index 4 / end 4843 Flow rule #3 created 4844 4845 testpmd> flow create 0 ingress pattern eth dst is 00:00:00:00:01:00 / ipv4 / 4846 udp / vxlan vni is 6 / eth dst is 00:11:22:33:44:55 / end actions pf / 4847 queue index 5 / end 4848 Flow rule #4 created 4849 4850 testpmd> flow list 0 4851 ID Group Prio Attr Rule 4852 0 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE 4853 1 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE 4854 2 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE 4855 3 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE 4856 4 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE 4857 4858Sample VXLAN encapsulation rule 4859~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4860 4861VXLAN encapsulation outer layer has default value pre-configured in testpmd 4862source code, those can be changed by using the following commands 4863 4864IPv4 VXLAN outer header:: 4865 4866 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1 4867 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4868 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4869 queue index 0 / end 4870 4871 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 4872 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11 4873 eth-dst 22:22:22:22:22:22 4874 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4875 queue index 0 / end 4876 4877 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0 4878 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 4879 eth-dst 22:22:22:22:22:22 4880 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4881 queue index 0 / end 4882 4883IPv6 VXLAN outer header:: 4884 4885 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1 4886 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4887 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4888 queue index 0 / end 4889 4890 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 4891 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11 4892 eth-dst 22:22:22:22:22:22 4893 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4894 queue index 0 / end 4895 4896 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4 4897 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11 4898 eth-dst 22:22:22:22:22:22 4899 testpmd> flow create 0 ingress pattern end actions vxlan_encap / 4900 queue index 0 / end 4901 4902Sample NVGRE encapsulation rule 4903~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4904 4905NVGRE encapsulation outer layer has default value pre-configured in testpmd 4906source code, those can be changed by using the following commands 4907 4908IPv4 NVGRE outer header:: 4909 4910 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1 4911 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4912 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4913 queue index 0 / end 4914 4915 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1 4916 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11 4917 eth-dst 22:22:22:22:22:22 4918 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4919 queue index 0 / end 4920 4921IPv6 NVGRE outer header:: 4922 4923 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222 4924 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4925 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4926 queue index 0 / end 4927 4928 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222 4929 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4930 testpmd> flow create 0 ingress pattern end actions nvgre_encap / 4931 queue index 0 / end 4932 4933Sample L2 encapsulation rule 4934~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4935 4936L2 encapsulation has default value pre-configured in testpmd 4937source code, those can be changed by using the following commands 4938 4939L2 header:: 4940 4941 testpmd> set l2_encap ip-version ipv4 4942 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4943 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 4944 mplsoudp_decap / l2_encap / end 4945 4946L2 with VXLAN header:: 4947 4948 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34 4949 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4950 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 4951 mplsoudp_decap / l2_encap / end 4952 4953Sample L2 decapsulation rule 4954~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4955 4956L2 decapsulation has default value pre-configured in testpmd 4957source code, those can be changed by using the following commands 4958 4959L2 header:: 4960 4961 testpmd> set l2_decap 4962 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap / 4963 queue index 0 / end 4964 4965L2 with VXLAN header:: 4966 4967 testpmd> set l2_encap-with-vlan 4968 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap / 4969 queue index 0 / end 4970 4971Sample MPLSoGRE encapsulation rule 4972~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4973 4974MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd 4975source code, those can be changed by using the following commands 4976 4977IPv4 MPLSoGRE outer header:: 4978 4979 testpmd> set mplsogre_encap ip-version ipv4 label 4 4980 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 4981 eth-dst 22:22:22:22:22:22 4982 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4983 mplsogre_encap / end 4984 4985IPv4 MPLSoGRE with VLAN outer header:: 4986 4987 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4 4988 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 4989 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 4990 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4991 mplsogre_encap / end 4992 4993IPv6 MPLSoGRE outer header:: 4994 4995 testpmd> set mplsogre_encap ip-version ipv6 mask 4 4996 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11 4997 eth-dst 22:22:22:22:22:22 4998 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 4999 mplsogre_encap / end 5000 5001IPv6 MPLSoGRE with VLAN outer header:: 5002 5003 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4 5004 ip-src ::1 ip-dst ::2222 vlan-tci 34 5005 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 5006 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 5007 mplsogre_encap / end 5008 5009Sample MPLSoGRE decapsulation rule 5010~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5011 5012MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd 5013source code, those can be changed by using the following commands 5014 5015IPv4 MPLSoGRE outer header:: 5016 5017 testpmd> set mplsogre_decap ip-version ipv4 5018 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions 5019 mplsogre_decap / l2_encap / end 5020 5021IPv4 MPLSoGRE with VLAN outer header:: 5022 5023 testpmd> set mplsogre_decap-with-vlan ip-version ipv4 5024 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end 5025 actions mplsogre_decap / l2_encap / end 5026 5027IPv6 MPLSoGRE outer header:: 5028 5029 testpmd> set mplsogre_decap ip-version ipv6 5030 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end 5031 actions mplsogre_decap / l2_encap / end 5032 5033IPv6 MPLSoGRE with VLAN outer header:: 5034 5035 testpmd> set mplsogre_decap-with-vlan ip-version ipv6 5036 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end 5037 actions mplsogre_decap / l2_encap / end 5038 5039Sample MPLSoUDP encapsulation rule 5040~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5041 5042MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd 5043source code, those can be changed by using the following commands 5044 5045IPv4 MPLSoUDP outer header:: 5046 5047 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10 5048 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 5049 eth-dst 22:22:22:22:22:22 5050 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 5051 mplsoudp_encap / end 5052 5053IPv4 MPLSoUDP with VLAN outer header:: 5054 5055 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5 5056 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 5057 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 5058 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 5059 mplsoudp_encap / end 5060 5061IPv6 MPLSoUDP outer header:: 5062 5063 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10 5064 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11 5065 eth-dst 22:22:22:22:22:22 5066 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 5067 mplsoudp_encap / end 5068 5069IPv6 MPLSoUDP with VLAN outer header:: 5070 5071 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5 5072 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34 5073 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 5074 testpmd> flow create 0 egress pattern eth / end actions l2_decap / 5075 mplsoudp_encap / end 5076 5077Sample MPLSoUDP decapsulation rule 5078~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5079 5080MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd 5081source code, those can be changed by using the following commands 5082 5083IPv4 MPLSoUDP outer header:: 5084 5085 testpmd> set mplsoudp_decap ip-version ipv4 5086 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions 5087 mplsoudp_decap / l2_encap / end 5088 5089IPv4 MPLSoUDP with VLAN outer header:: 5090 5091 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4 5092 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end 5093 actions mplsoudp_decap / l2_encap / end 5094 5095IPv6 MPLSoUDP outer header:: 5096 5097 testpmd> set mplsoudp_decap ip-version ipv6 5098 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end 5099 actions mplsoudp_decap / l2_encap / end 5100 5101IPv6 MPLSoUDP with VLAN outer header:: 5102 5103 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6 5104 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end 5105 actions mplsoudp_decap / l2_encap / end 5106 5107Sample Raw encapsulation rule 5108~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5109 5110Raw encapsulation configuration can be set by the following commands 5111 5112Encapsulating VxLAN:: 5113 5114 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1 5115 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni 5116 is 2 / end_set 5117 testpmd> flow create 0 egress pattern eth / ipv4 / end actions 5118 raw_encap index 4 / end 5119 5120Sample Raw decapsulation rule 5121~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5122 5123Raw decapsulation configuration can be set by the following commands 5124 5125Decapsulating VxLAN:: 5126 5127 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set 5128 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 / 5129 end actions raw_decap / queue index 0 / end 5130 5131Sample ESP rules 5132~~~~~~~~~~~~~~~~ 5133 5134ESP rules can be created by the following commands:: 5135 5136 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions 5137 queue index 3 / end 5138 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end 5139 actions queue index 3 / end 5140 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions 5141 queue index 3 / end 5142 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end 5143 actions queue index 3 / end 5144 5145Sample AH rules 5146~~~~~~~~~~~~~~~~ 5147 5148AH rules can be created by the following commands:: 5149 5150 testpmd> flow create 0 ingress pattern eth / ipv4 / ah spi is 1 / end actions 5151 queue index 3 / end 5152 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / ah spi is 1 / end 5153 actions queue index 3 / end 5154 testpmd> flow create 0 ingress pattern eth / ipv6 / ah spi is 1 / end actions 5155 queue index 3 / end 5156 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / ah spi is 1 / end 5157 actions queue index 3 / end 5158 5159Sample PFCP rules 5160~~~~~~~~~~~~~~~~~ 5161 5162PFCP rules can be created by the following commands(s_field need to be 1 5163if seid is set):: 5164 5165 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 0 / end 5166 actions queue index 3 / end 5167 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 1 5168 seid is 1 / end actions queue index 3 / end 5169 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 0 / end 5170 actions queue index 3 / end 5171 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 1 5172 seid is 1 / end actions queue index 3 / end 5173 5174Sample Sampling/Mirroring rules 5175~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5176 5177Sample/Mirroring rules can be set by the following commands 5178 5179NIC-RX Sampling rule, the matched ingress packets and sent to the queue 1, 5180and 50% packets are duplicated and marked with 0x1234 and sent to queue 0. 5181 5182:: 5183 5184 testpmd> set sample_actions 0 mark id 0x1234 / queue index 0 / end 5185 testpmd> flow create 0 ingress group 1 pattern eth / end actions 5186 sample ratio 2 index 0 / queue index 1 / end 5187 5188Match packets coming from a VM which is referred to by means of 5189its representor ethdev (port 1), mirror 50% of them to the 5190said representor (for bookkeeping) as well as encapsulate 5191all the packets and steer them to the physical port: 5192 5193:: 5194 5195 testpmd> set sample_actions 0 port_representor ethdev_port_id 1 / end 5196 5197 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 32 udp-dst 4789 ip-src 127.0.0.1 5198 ip-dst 127.0.0.2 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22 5199 5200 testpmd> flow create 0 transfer pattern represented_port ethdev_port_id is 1 / end 5201 actions sample ratio 2 index 0 / vxlan_encap / 5202 represented_port ethdev_port_id 0 / end 5203 5204The rule is inserted via port 0 (assumed to have "transfer" privilege). 5205 5206Sample integrity rules 5207~~~~~~~~~~~~~~~~~~~~~~ 5208 5209Integrity rules can be created by the following commands: 5210 5211Integrity rule that forwards valid TCP packets to group 1. 5212TCP packet integrity is matched with the ``l4_ok`` bit 3. 5213 5214:: 5215 5216 testpmd> flow create 0 ingress 5217 pattern eth / ipv4 / tcp / integrity value mask 8 value spec 8 / end 5218 actions jump group 1 / end 5219 5220Integrity rule that forwards invalid packets to application. 5221General packet integrity is matched with the ``packet_ok`` bit 0. 5222 5223:: 5224 5225 testpmd> flow create 0 ingress pattern integrity value mask 1 value spec 0 / end actions queue index 0 / end 5226 5227Sample conntrack rules 5228~~~~~~~~~~~~~~~~~~~~~~ 5229 5230Conntrack rules can be set by the following commands 5231 5232Need to construct the connection context with provided information. 5233In the first table, create a flow rule by using conntrack action and jump to 5234the next table. In the next table, create a rule to check the state. 5235 5236:: 5237 5238 testpmd> set conntrack com peer 1 is_orig 1 enable 1 live 1 sack 1 cack 0 5239 last_dir 0 liberal 0 state 1 max_ack_win 7 r_lim 5 last_win 510 5240 last_seq 2632987379 last_ack 2532480967 last_end 2632987379 5241 last_index 0x8 5242 testpmd> set conntrack orig scale 7 fin 0 acked 1 unack_data 0 5243 sent_end 2632987379 reply_end 2633016339 max_win 28960 5244 max_ack 2632987379 5245 testpmd> set conntrack rply scale 7 fin 0 acked 1 unack_data 0 5246 sent_end 2532480967 reply_end 2532546247 max_win 65280 5247 max_ack 2532480967 5248 testpmd> flow indirect_action 0 create ingress action conntrack / end 5249 testpmd> flow create 0 group 3 ingress pattern eth / ipv4 / tcp / end actions indirect 0 / jump group 5 / end 5250 testpmd> flow create 0 group 5 ingress pattern eth / ipv4 / tcp / conntrack is 1 / end actions queue index 5 / end 5251 5252Construct the conntrack again with only "is_orig" set to 0 (other fields are 5253ignored), then use "update" interface to update the direction. Create flow 5254rules like above for the peer port. 5255 5256:: 5257 5258 testpmd> flow indirect_action 0 update 0 action conntrack_update dir / end 5259 5260Sample meter with policy rules 5261~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5262 5263Meter with policy rules can be created by the following commands: 5264 5265Need to create policy first and actions are set for green/yellow/red colors. 5266Create meter with policy id. Create flow with meter id. 5267 5268Example for policy with meter color action. The purpose is to color the packet 5269to reflect the meter color result. 5270The meter policy action list: ``green -> green, yellow -> yellow, red -> red``. 5271 5272:: 5273 5274 testpmd> add port meter profile srtcm_rfc2697 0 13 21504 2688 0 0 5275 testpmd> add port meter policy 0 1 g_actions color type green / end y_actions color type yellow / end 5276 r_actions color type red / end 5277 testpmd> create port meter 0 1 13 1 yes 0xffff 0 0 5278 testpmd> flow create 0 priority 0 ingress group 1 pattern eth / end actions meter mtr_id 1 / end 5279 5280Sample L2TPv2 RSS rules 5281~~~~~~~~~~~~~~~~~~~~~~~ 5282 5283L2TPv2 RSS rules can be created by the following commands:: 5284 5285 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 type control 5286 / end actions rss types l2tpv2 end queues end / end 5287 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / end 5288 actions rss types eth l2-src-only end queues end / end 5289 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / end 5290 actions rss types l2tpv2 end queues end / end 5291 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv4 5292 / end actions rss types ipv4 end queues end / end 5293 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv6 5294 / udp / end actions rss types ipv6-udp end queues end / end 5295 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / l2tpv2 / ppp / ipv4 5296 / tcp / end actions rss types ipv4-tcp end queues end / end 5297 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / l2tpv2 / ppp / ipv6 5298 / end actions rss types ipv6 end queues end / end 5299 5300Sample L2TPv2 FDIR rules 5301~~~~~~~~~~~~~~~~~~~~~~~~ 5302 5303L2TPv2 FDIR rules can be created by the following commands:: 5304 5305 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 type control 5306 session_id is 0x1111 / end actions queue index 3 / end 5307 testpmd> flow create 0 ingress pattern eth src is 00:00:00:00:00:01 / ipv4 5308 / udp / l2tpv2 type data / end actions queue index 3 / end 5309 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 type data 5310 session_id is 0x1111 / ppp / end actions queue index 3 / end 5311 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv4 5312 src is 10.0.0.1 / end actions queue index 3 / end 5313 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / l2tpv2 / ppp / ipv6 5314 dst is ABAB:910B:6666:3457:8295:3333:1800:2929 / end actions queue index 3 / end 5315 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv4 5316 / udp src is 22 / end actions queue index 3 / end 5317 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv4 5318 / tcp dst is 23 / end actions queue index 3 / end 5319 5320Sample RAW rule 5321~~~~~~~~~~~~~~~ 5322 5323A RAW rule can be created as following using ``pattern_hex`` key and mask. 5324 5325:: 5326 5327 testpmd> flow create 0 group 0 priority 1 ingress pattern raw relative is 0 search is 0 offset 5328 is 0 limit is 0 pattern_hex spec 00000000000000000000000000000000000000000000000000000a0a0a0a 5329 pattern_hex mask 0000000000000000000000000000000000000000000000000000ffffffff / end actions 5330 queue index 4 / end 5331 5332Sample match with comparison rule 5333~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5334 5335Match with comparison rule can be created as following using ``compare``. 5336 5337:: 5338 5339 testpmd> flow pattern_template 0 create ingress pattern_template_id 1 template compare op mask le 5340 a_type mask tag a_tag_index mask 1 b_type mask tag b_tag_index mask 2 width mask 0xffffffff / end 5341 testpmd> flow actions_template 0 create ingress actions_template_id 1 template count / drop / end 5342 mask count / drop / end 5343 testpmd> flow template_table 0 create table_id 1 group 2 priority 1 ingress rules_number 1 5344 pattern_template 1 actions_template 1 5345 testpmd> flow queue 0 create 0 template_table 1 pattern_template 0 actions_template 0 postpone no 5346 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 5347 actions count / drop / end 5348 5349BPF Functions 5350-------------- 5351 5352The following sections show functions to load/unload eBPF based filters. 5353 5354bpf-load 5355~~~~~~~~ 5356 5357Load an eBPF program as a callback for particular RX/TX queue:: 5358 5359 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename) 5360 5361The available load-flags are: 5362 5363* ``J``: use JIT generated native code, otherwise BPF interpreter will be used. 5364 5365* ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data. 5366 5367* ``-``: none. 5368 5369.. note:: 5370 5371 You'll need clang v3.7 or above to build bpf program you'd like to load 5372 5373For example: 5374 5375.. code-block:: console 5376 5377 cd examples/bpf 5378 clang -O2 -target bpf -c t1.c 5379 5380Then to load (and JIT compile) t1.o at RX queue 0, port 1: 5381 5382.. code-block:: console 5383 5384 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o 5385 5386To load (not JITed) t1.o at TX queue 0, port 0: 5387 5388.. code-block:: console 5389 5390 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o 5391 5392bpf-unload 5393~~~~~~~~~~ 5394 5395Unload previously loaded eBPF program for particular RX/TX queue:: 5396 5397 testpmd> bpf-unload rx|tx (portid) (queueid) 5398 5399For example to unload BPF filter from TX queue 0, port 0: 5400 5401.. code-block:: console 5402 5403 testpmd> bpf-unload tx 0 0 5404 5405Flex Item Functions 5406------------------- 5407 5408The following sections show functions that configure and create flex item object, 5409create flex pattern and use it in a flow rule. 5410The commands will use 20 bytes IPv4 header for examples: 5411 5412:: 5413 5414 0 1 2 3 5415 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 5416 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 5417 | ver | IHL | TOS | length | +0 5418 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 5419 | identification | flg | frag. offset | +4 5420 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 5421 | TTL | protocol | checksum | +8 5422 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 5423 | source IP address | +12 5424 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 5425 | destination IP address | +16 5426 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 5427 5428 5429Create flex item 5430~~~~~~~~~~~~~~~~ 5431 5432Flex item object is created by PMD according to a new header configuration. The 5433header configuration is compiled by the testpmd and stored in 5434``rte_flow_item_flex_conf`` type variable. 5435 5436:: 5437 5438 # flow flex_item create <port> <flex id> <configuration file> 5439 testpmd> flow flex_item init 0 3 ipv4_flex_config.json 5440 port-0: created flex item #3 5441 5442Flex item configuration is kept in external JSON file. 5443It describes the following header elements: 5444 5445**New header length.** 5446 5447Specify whether the new header has fixed or variable length and the basic/minimal 5448header length value. 5449 5450If header length is not fixed, header location with a value that completes header 5451length calculation and scale/offset function must be added. 5452 5453Scale function depends on port hardware. 5454 5455**Next protocol.** 5456 5457Describes location in the new header that specify following network header type. 5458 5459**Flow match samples.** 5460 5461Describes locations in the new header that will be used in flow rules. 5462 5463Number of flow samples and sample maximal length depend of port hardware. 5464 5465**Input trigger.** 5466 5467Describes preceding network header configuration. 5468 5469**Output trigger.** 5470 5471Describes conditions that trigger transfer to following network header 5472 5473.. code-block:: json 5474 5475 { 5476 "next_header": { "field_mode": "FIELD_MODE_FIXED", "field_size": 20}, 5477 "next_protocol": {"field_size": 8, "field_base": 72}, 5478 "sample_data": [ 5479 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 0}, 5480 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 32}, 5481 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 64}, 5482 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 96} 5483 ], 5484 "input_link": [ 5485 {"item": "eth type is 0x0800"}, 5486 {"item": "vlan inner_type is 0x0800"} 5487 ], 5488 "output_link": [ 5489 {"item": "udp", "next": 17}, 5490 {"item": "tcp", "next": 6}, 5491 {"item": "icmp", "next": 1} 5492 ] 5493 } 5494 5495 5496Flex pattern and flow rules 5497~~~~~~~~~~~~~~~~~~~~~~~~~~~ 5498 5499Flex pattern describe parts of network header that will trigger flex flow item hit in a flow rule. 5500Flex pattern directly related to flex item samples configuration. 5501Flex pattern can be shared between ports. 5502 5503**Flex pattern and flow rule to match IPv4 version and 20 bytes length** 5504 5505:: 5506 5507 # set flex_pattern <pattern_id> is <hex bytes sequence> 5508 testpmd> flow flex_item pattern 5 is 45FF 5509 created pattern #5 5510 5511 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 5512 Flow rule #0 created 5513 5514**Flex pattern and flow rule to match packets with source address 1.2.3.4** 5515 5516:: 5517 5518 testpmd> flow flex_item pattern 2 spec 45000000000000000000000001020304 mask FF0000000000000000000000FFFFFFFF 5519 created pattern #2 5520 5521 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 5522 Flow rule #0 created 5523 5524Driver specific commands 5525------------------------ 5526 5527Some drivers provide specific features. 5528See: 5529 5530- :ref:`net/bonding testpmd driver specific commands <bonding_testpmd_commands>` 5531- :ref:`net/i40e testpmd driver specific commands <net_i40e_testpmd_commands>` 5532- :ref:`net/ixgbe testpmd driver specific commands <net_ixgbe_testpmd_commands>` 5533