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