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