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