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