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