1.. BSD LICENSE 2 Copyright(c) 2010-2015 Intel Corporation. All rights reserved. 3 All rights reserved. 4 5 Redistribution and use in source and binary forms, with or without 6 modification, are permitted provided that the following conditions 7 are met: 8 9 * Redistributions of source code must retain the above copyright 10 notice, this list of conditions and the following disclaimer. 11 * Redistributions in binary form must reproduce the above copyright 12 notice, this list of conditions and the following disclaimer in 13 the documentation and/or other materials provided with the 14 distribution. 15 * Neither the name of Intel Corporation nor the names of its 16 contributors may be used to endorse or promote products derived 17 from this software without specific prior written permission. 18 19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31.. _testpmd_runtime: 32 33Testpmd Runtime Functions 34========================= 35 36Where the testpmd application is started in interactive mode, (``-i|--interactive``), 37it displays a prompt that can be used to start and stop forwarding, 38configure the application, display statistics, set the Flow Director and other tasks:: 39 40 testpmd> 41 42The testpmd prompt has some, limited, readline support. 43Common bash command-line functions such as ``Ctrl+a`` and ``Ctrl+e`` to go to the start and end of the prompt line are supported 44as well as access to the command history via the up-arrow. 45 46There is also support for tab completion. 47If you type a partial command and hit ``<TAB>`` you get a list of the available completions: 48 49.. code-block:: console 50 51 testpmd> show port <TAB> 52 53 info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X 54 info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all 55 stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X 56 stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all 57 ... 58 59 60.. note:: 61 62 Some examples in this document are too long to fit on one line are are shown wrapped at `"\\"` for display purposes:: 63 64 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 65 (pause_time) (send_xon) (port_id) 66 67In the real ``testpmd>`` prompt these commands should be on a single line. 68 69Help Functions 70-------------- 71 72The testpmd has on-line help for the functions that are available at runtime. 73These are divided into sections and can be accessed using help, help section or help all: 74 75.. code-block:: console 76 77 testpmd> help 78 79 help control : Start and stop forwarding. 80 help display : Displaying port, stats and config information. 81 help config : Configuration information. 82 help ports : Configuring ports. 83 help registers : Reading and setting port registers. 84 help filters : Filters configuration help. 85 help all : All of the above sections. 86 87 88Control Functions 89----------------- 90 91start 92~~~~~ 93 94Start packet forwarding with current configuration:: 95 96 testpmd> start 97 98start tx_first 99~~~~~~~~~~~~~~ 100 101Start packet forwarding with current configuration after sending one burst of packets:: 102 103 testpmd> start tx_first 104 105stop 106~~~~ 107 108Stop packet forwarding, and display accumulated statistics:: 109 110 testpmd> stop 111 112quit 113~~~~ 114 115Quit to prompt:: 116 117 testpmd> quit 118 119 120Display Functions 121----------------- 122 123The functions in the following sections are used to display information about the 124testpmd configuration or the NIC status. 125 126show port 127~~~~~~~~~ 128 129Display information for a given port or all ports:: 130 131 testpmd> show port (info|stats|fdir|stat_qmap|dcb_tc) (port_id|all) 132 133The available information categories are: 134 135* ``info``: General port information such as MAC address. 136 137* ``stats``: RX/TX statistics. 138 139* ``fdir``: Flow Director information and statistics. 140 141* ``stat_qmap``: Queue statistics mapping. 142 143* ``dcb_tc``: DCB information such as TC mapping. 144 145For example: 146 147.. code-block:: console 148 149 testpmd> show port info 0 150 151 ********************* Infos for port 0 ********************* 152 153 MAC address: XX:XX:XX:XX:XX:XX 154 Connect to socket: 0 155 memory allocation on the socket: 0 156 Link status: up 157 Link speed: 40000 Mbps 158 Link duplex: full-duplex 159 Promiscuous mode: enabled 160 Allmulticast mode: disabled 161 Maximum number of MAC addresses: 64 162 Maximum number of MAC addresses of hash filtering: 0 163 VLAN offload: 164 strip on 165 filter on 166 qinq(extend) off 167 Redirection table size: 512 168 Supported flow types: 169 ipv4-frag 170 ipv4-tcp 171 ipv4-udp 172 ipv4-sctp 173 ipv4-other 174 ipv6-frag 175 ipv6-tcp 176 ipv6-udp 177 ipv6-sctp 178 ipv6-other 179 l2_payload 180 181show port rss reta 182~~~~~~~~~~~~~~~~~~ 183 184Display the rss redirection table entry indicated by masks on port X:: 185 186 testpmd> show port (port_id) rss reta (size) (mask0, mask1...) 187 188size is used to indicate the hardware supported reta size 189 190show port rss-hash 191~~~~~~~~~~~~~~~~~~ 192 193Display the RSS hash functions and RSS hash key of a port:: 194 195 testpmd> show port (port_id) rss-hash ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|ipv6-udp-ex [key] 196 197clear port 198~~~~~~~~~~ 199 200Clear the port statistics for a given port or for all ports:: 201 202 testpmd> clear port (info|stats|fdir|stat_qmap) (port_id|all) 203 204For example:: 205 206 testpmd> clear port stats all 207 208show (rxq|txq) 209~~~~~~~~~~~~~~ 210 211Display information for a given port's RX/TX queue:: 212 213 testpmd> show (rxq|txq) info (port_id) (queue_id) 214 215show config 216~~~~~~~~~~~ 217 218Displays the configuration of the application. 219The configuration comes from the command-line, the runtime or the application defaults:: 220 221 testpmd> show config (rxtx|cores|fwd|txpkts) 222 223The available information categories are: 224 225* ``rxtx``: RX/TX configuration items. 226 227* ``cores``: List of forwarding cores. 228 229* ``fwd``: Packet forwarding configuration. 230 231* ``txpkts``: Packets to TX configuration. 232 233For example: 234 235.. code-block:: console 236 237 testpmd> show config rxtx 238 239 io packet forwarding - CRC stripping disabled - packets/burst=16 240 nb forwarding cores=2 - nb forwarding ports=1 241 RX queues=1 - RX desc=128 - RX free threshold=0 242 RX threshold registers: pthresh=8 hthresh=8 wthresh=4 243 TX queues=1 - TX desc=512 - TX free threshold=0 244 TX threshold registers: pthresh=36 hthresh=0 wthresh=0 245 TX RS bit threshold=0 - TXQ flags=0x0 246 247set fwd 248~~~~~~~ 249 250Set the packet forwarding mode:: 251 252 testpmd> set fwd (io|mac|mac_retry|macswap|flowgen| \ 253 rxonly|txonly|csum|icmpecho) 254 255The available information categories are: 256 257* ``io``: Forwards packets "as-is" in I/O mode. 258 This is the fastest possible forwarding operation as it does not access packets data. 259 This is the default mode. 260 261* ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them. 262 263* ``mac_retry``: Same as "mac" forwarding mode, but includes retries if the destination queue is full. 264 265* ``macswap``: MAC swap forwarding mode. 266 Swaps the source and the destination Ethernet addresses of packets before forwarding them. 267 268* ``flowgen``: Multi-flow generation mode. 269 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic. 270 271* ``rxonly``: Receives packets but doesn't transmit them. 272 273* ``txonly``: Generates and transmits packets without receiving any. 274 275* ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet. 276 277* ``icmpecho``: Receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies. 278 279* ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``. 280 281Note: TX timestamping is only available in the "Full Featured" TX path. To force ``testpmd`` into this mode set ``--txqflags=0``. 282 283Example:: 284 285 testpmd> set fwd rxonly 286 287 Set rxonly packet forwarding mode 288 289 290read rxd 291~~~~~~~~ 292 293Display an RX descriptor for a port RX queue:: 294 295 testpmd> read rxd (port_id) (queue_id) (rxd_id) 296 297For example:: 298 299 testpmd> read rxd 0 0 4 300 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180 301 302read txd 303~~~~~~~~ 304 305Display a TX descriptor for a port TX queue:: 306 307 testpmd> read txd (port_id) (queue_id) (txd_id) 308 309For example:: 310 311 testpmd> read txd 0 0 4 312 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C 313 314 315Configuration Functions 316----------------------- 317 318The testpmd application can be configured from the runtime as well as from the command-line. 319 320This section details the available configuration functions that are available. 321 322.. note:: 323 324 Configuration changes only become active when forwarding is started/restarted. 325 326set default 327~~~~~~~~~~~ 328 329Reset forwarding to the default configuration:: 330 331 testpmd> set default 332 333set verbose 334~~~~~~~~~~~ 335 336Set the debug verbosity level:: 337 338 testpmd> set verbose (level) 339 340Currently the only available levels are 0 (silent except for error) and 1 (fully verbose). 341 342set nbport 343~~~~~~~~~~ 344 345Set the number of ports used by the application: 346 347set nbport (num) 348 349This is equivalent to the ``--nb-ports`` command-line option. 350 351set nbcore 352~~~~~~~~~~ 353 354Set the number of cores used by the application:: 355 356 testpmd> set nbcore (num) 357 358This is equivalent to the ``--nb-cores`` command-line option. 359 360.. note:: 361 362 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port. 363 364set coremask 365~~~~~~~~~~~~ 366 367Set the forwarding cores hexadecimal mask:: 368 369 testpmd> set coremask (mask) 370 371This is equivalent to the ``--coremask`` command-line option. 372 373.. note:: 374 375 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding. 376 377set portmask 378~~~~~~~~~~~~ 379 380Set the forwarding ports hexadecimal mask:: 381 382 testpmd> set portmask (mask) 383 384This is equivalent to the ``--portmask`` command-line option. 385 386set burst 387~~~~~~~~~ 388 389Set number of packets per burst:: 390 391 testpmd> set burst (num) 392 393This is equivalent to the ``--burst command-line`` option. 394 395In ``mac_retry`` forwarding mode, the transmit delay time and number of retries can also be set:: 396 397 testpmd> set burst tx delay (micrseconds) retry (num) 398 399set txpkts 400~~~~~~~~~~ 401 402Set the length of each segment of the TX-ONLY packets:: 403 404 testpmd> set txpkts (x[,y]*) 405 406Where x[,y]* represents a CSV list of values, without white space. 407 408set txsplit 409~~~~~~~~~~~ 410 411Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes:: 412 413 testpmd> set txsplit (off|on|rand) 414 415Where: 416 417* ``off`` disable packet copy & split for CSUM mode. 418 419* ``on`` split outgoing packet into multiple segments. Size of each segment 420 and number of segments per packet is determined by ``set txpkts`` command 421 (see above). 422 423* ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments. 424 425set corelist 426~~~~~~~~~~~~ 427 428Set the list of forwarding cores:: 429 430 testpmd> set corelist (x[,y]*) 431 432For example, to change the forwarding cores: 433 434.. code-block:: console 435 436 testpmd> set corelist 3,1 437 testpmd> show config fwd 438 439 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled 440 Logical Core 3 (socket 0) forwards packets on 1 streams: 441 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01 442 Logical Core 1 (socket 0) forwards packets on 1 streams: 443 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00 444 445.. note:: 446 447 The cores are used in the same order as specified on the command line. 448 449set portlist 450~~~~~~~~~~~~ 451 452Set the list of forwarding ports:: 453 454 testpmd> set portlist (x[,y]*) 455 456For example, to change the port forwarding: 457 458.. code-block:: console 459 460 testpmd> set portlist 0,2,1,3 461 testpmd> show config fwd 462 463 io packet forwarding - ports=4 - cores=1 - streams=4 464 Logical Core 3 (socket 0) forwards packets on 4 streams: 465 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01 466 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00 467 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03 468 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02 469 470vlan set strip 471~~~~~~~~~~~~~~ 472 473Set the VLAN strip on a port:: 474 475 testpmd> vlan set strip (on|off) (port_id) 476 477vlan set stripq 478~~~~~~~~~~~~~~~ 479 480Set the VLAN strip for a queue on a port:: 481 482 testpmd> vlan set stripq (on|off) (port_id,queue_id) 483 484vlan set filter 485~~~~~~~~~~~~~~~ 486 487Set the VLAN filter on a port:: 488 489 testpmd> vlan set filter (on|off) (port_id) 490 491vlan set qinq 492~~~~~~~~~~~~~ 493 494Set the VLAN QinQ (extended queue in queue) on for a port:: 495 496 testpmd> vlan set qinq (on|off) (port_id) 497 498vlan set tpid 499~~~~~~~~~~~~~ 500 501Set the inner or outer VLAN TPID for packet filtering on a port:: 502 503 testpmd> vlan set (inner|outer) tpid (value) (port_id) 504 505.. note:: 506 507 TPID value must be a 16-bit number (value <= 65536). 508 509rx_vlan add 510~~~~~~~~~~~ 511 512Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID:: 513 514 testpmd> rx_vlan add (vlan_id|all) (port_id) 515 516.. note:: 517 518 VLAN filter must be set on that port. VLAN ID < 4096. 519 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries 520 in VFTA table. This is important if enabling all vlan_ids. 521 522rx_vlan rm 523~~~~~~~~~~ 524 525Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID:: 526 527 testpmd> rx_vlan rm (vlan_id|all) (port_id) 528 529rx_vlan add (for VF) 530~~~~~~~~~~~~~~~~~~~~ 531 532Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID:: 533 534 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask) 535 536rx_vlan rm (for VF) 537~~~~~~~~~~~~~~~~~~~ 538 539Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID:: 540 541 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask) 542 543tunnel_filter add 544~~~~~~~~~~~~~~~~~ 545 546Add a tunnel filter on a port:: 547 548 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \ 549 (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id) 550 551tunnel_filter remove 552~~~~~~~~~~~~~~~~~~~~ 553 554Remove a tunnel filter on a port:: 555 556 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \ 557 (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id) 558 559rx_vxlan_port add 560~~~~~~~~~~~~~~~~~ 561 562Add an UDP port for VXLAN packet filter on a port:: 563 564 testpmd> rx_vxlan_port add (udp_port) (port_id) 565 566rx_vxlan_port remove 567~~~~~~~~~~~~~~~~~~~~ 568 569Remove an UDP port for VXLAN packet filter on a port:: 570 571 testpmd> rx_vxlan_port rm (udp_port) (port_id) 572 573tx_vlan set 574~~~~~~~~~~~ 575 576Set hardware insertion of VLAN IDs in packets sent on a port:: 577 578 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer] 579 580For example, set a single VLAN ID (5) insertion on port 0:: 581 582 tx_vlan set 0 5 583 584Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1:: 585 586 tx_vlan set 1 2 3 587 588 589tx_vlan set pvid 590~~~~~~~~~~~~~~~~ 591 592Set port based hardware insertion of VLAN ID in packets sent on a port:: 593 594 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off) 595 596tx_vlan reset 597~~~~~~~~~~~~~ 598 599Disable hardware insertion of a VLAN header in packets sent on a port:: 600 601 testpmd> tx_vlan reset (port_id) 602 603csum set 604~~~~~~~~ 605 606Select hardware or software calculation of the checksum when 607transmitting a packet using the ``csum`` forwarding engine:: 608 609 testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id) 610 611Where: 612 613* ``ip|udp|tcp|sctp`` always relate to the inner layer. 614 615* ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized 616 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are 617 supported). See also the ``csum parse-tunnel`` command. 618 619.. note:: 620 621 Check the NIC Datasheet for hardware limits. 622 623csum parse-tunnel 624~~~~~~~~~~~~~~~~~ 625 626Define how tunneled packets should be handled by the csum forward 627engine:: 628 629 testpmd> csum parse-tunnel (on|off) (tx_port_id) 630 631If enabled, the csum forward engine will try to recognize supported 632tunnel headers (vxlan, gre, ipip). 633 634If disabled, treat tunnel packets as non-tunneled packets (a inner 635header is handled as a packet payload). 636 637.. note:: 638 639 The port argument is the TX port like in the ``csum set`` command. 640 641Example: 642 643Consider a packet in packet like the following:: 644 645 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in 646 647* If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set`` 648 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the 649 ``outer-ip parameter`` relates to the outer headers (here ``ipv4_out``). 650 651* If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set`` 652 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``. 653 654csum show 655~~~~~~~~~ 656 657Display tx checksum offload configuration:: 658 659 testpmd> csum show (port_id) 660 661tso set 662~~~~~~~ 663 664Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine:: 665 666 testpmd> tso set (segsize) (port_id) 667 668.. note:: 669 670 Check the NIC datasheet for hardware limits. 671 672tso show 673~~~~~~~~ 674 675Display the status of TCP Segmentation Offload:: 676 677 testpmd> tso show (port_id) 678 679mac_addr add 680~~~~~~~~~~~~ 681 682Add an alternative MAC address to a port:: 683 684 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX) 685 686mac_addr remove 687~~~~~~~~~~~~~~~ 688 689Remove a MAC address from a port:: 690 691 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX) 692 693mac_addr add(for VF) 694~~~~~~~~~~~~~~~~~~~~ 695 696Add an alternative MAC address for a VF to a port:: 697 698 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX) 699 700set port-uta 701~~~~~~~~~~~~ 702 703Set the unicast hash filter(s) on/off for a port:: 704 705 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off) 706 707set promisc 708~~~~~~~~~~~ 709 710Set the promiscuous mode on for a port or for all ports. 711In promiscuous mode packets are not dropped if they aren't for the specified MAC address:: 712 713 testpmd> set promisc (port_id|all) (on|off) 714 715set allmulti 716~~~~~~~~~~~~ 717 718Set the allmulti mode for a port or for all ports:: 719 720 testpmd> set allmulti (port_id|all) (on|off) 721 722Same as the ifconfig (8) option. Controls how multicast packets are handled. 723 724set flow_ctrl rx 725~~~~~~~~~~~~~~~~ 726 727Set the link flow control parameter on a port:: 728 729 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 730 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \ 731 autoneg (on|off) (port_id) 732 733Where: 734 735* ``high_water`` (integer): High threshold value to trigger XOFF. 736 737* ``low_water`` (integer): Low threshold value to trigger XON. 738 739* ``pause_time`` (integer): Pause quota in the Pause frame. 740 741* ``send_xon`` (0/1): Send XON frame. 742 743* ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames. 744 745* ``autoneg``: Change the auto-negotiation para mete. 746 747set pfc_ctrl rx 748~~~~~~~~~~~~~~~ 749 750Set the priority flow control parameter on a port:: 751 752 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 753 (pause_time) (priority) (port_id) 754 755Where: 756 757* ``high_water`` (integer): High threshold value. 758 759* ``low_water`` (integer): Low threshold value. 760 761* ``pause_time`` (integer): Pause quota in the Pause frame. 762 763* ``priority`` (0-7): VLAN User Priority. 764 765set stat_qmap 766~~~~~~~~~~~~~ 767 768Set statistics mapping (qmapping 0..15) for RX/TX queue on port:: 769 770 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping) 771 772For example, to set rx queue 2 on port 0 to mapping 5:: 773 774 testpmd>set stat_qmap rx 0 2 5 775 776set port - rx/tx (for VF) 777~~~~~~~~~~~~~~~~~~~~~~~~~ 778 779Set VF receive/transmit from a port:: 780 781 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off) 782 783set port - mac address filter (for VF) 784~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 785 786Add/Remove unicast or multicast MAC addr filter for a VF:: 787 788 testpmd> set port (port_id) vf (vf_id) (mac_addr) \ 789 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off) 790 791set port - rx mode(for VF) 792~~~~~~~~~~~~~~~~~~~~~~~~~~ 793 794Set the VF receive mode of a port:: 795 796 testpmd> set port (port_id) vf (vf_id) \ 797 rxmode (AUPE|ROPE|BAM|MPE) (on|off) 798 799The available receive modes are: 800 801* ``AUPE``: Accepts untagged VLAN. 802 803* ``ROPE``: Accepts unicast hash. 804 805* ``BAM``: Accepts broadcast packets. 806 807* ``MPE``: Accepts all multicast packets. 808 809set port - tx_rate (for Queue) 810~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 811 812Set TX rate limitation for a queue on a port:: 813 814 testpmd> set port (port_id) queue (queue_id) rate (rate_value) 815 816set port - tx_rate (for VF) 817~~~~~~~~~~~~~~~~~~~~~~~~~~~ 818 819Set TX rate limitation for queues in VF on a port:: 820 821 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask) 822 823set port - mirror rule 824~~~~~~~~~~~~~~~~~~~~~~ 825 826Set pool or vlan type mirror rule for a port:: 827 828 testpmd> set port (port_id) mirror-rule (rule_id) \ 829 (pool-mirror-up|pool-mirror-down|vlan-mirror) \ 830 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off) 831 832Set link mirror rule for a port:: 833 834 testpmd> set port (port_id) mirror-rule (rule_id) \ 835 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off) 836 837For example to enable mirror traffic with vlan 0,1 to pool 0:: 838 839 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on 840 841reset port - mirror rule 842~~~~~~~~~~~~~~~~~~~~~~~~ 843 844Reset a mirror rule for a port:: 845 846 testpmd> reset port (port_id) mirror-rule (rule_id) 847 848set flush_rx 849~~~~~~~~~~~~ 850 851Set the flush on RX streams before forwarding. 852The default is flush ``on``. 853Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams:: 854 855 testpmd> set flush_rx off 856 857set bypass mode 858~~~~~~~~~~~~~~~ 859 860Set the bypass mode for the lowest port on bypass enabled NIC:: 861 862 testpmd> set bypass mode (normal|bypass|isolate) (port_id) 863 864set bypass event 865~~~~~~~~~~~~~~~~ 866 867Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled:: 868 869 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \ 870 mode (normal|bypass|isolate) (port_id) 871 872Where: 873 874* ``timeout``: Enable bypass after watchdog timeout. 875 876* ``os_on``: Enable bypass when OS/board is powered on. 877 878* ``os_off``: Enable bypass when OS/board is powered off. 879 880* ``power_on``: Enable bypass when power supply is turned on. 881 882* ``power_off``: Enable bypass when power supply is turned off. 883 884 885set bypass timeout 886~~~~~~~~~~~~~~~~~~ 887 888Set the bypass watchdog timeout to ``n`` seconds where 0 = instant:: 889 890 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32) 891 892show bypass config 893~~~~~~~~~~~~~~~~~~ 894 895Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC:: 896 897 testpmd> show bypass config (port_id) 898 899set link up 900~~~~~~~~~~~ 901 902Set link up for a port:: 903 904 testpmd> set link-up port (port id) 905 906set link down 907~~~~~~~~~~~~~ 908 909Set link down for a port:: 910 911 testpmd> set link-down port (port id) 912 913 914Port Functions 915-------------- 916 917The following sections show functions for configuring ports. 918 919.. note:: 920 921 Port configuration changes only become active when forwarding is started/restarted. 922 923port attach 924~~~~~~~~~~~ 925 926Attach a port specified by pci address or virtual device args. 927 928To attach a new pci device, the device should be recognized by kernel first. 929Then it should be moved under DPDK management. 930Finally the port can be attached to testpmd. 931 932For example, to move a pci device using ixgbe under DPDK management: 933 934.. code-block:: console 935 936 # Check the status of the available devices. 937 ./tools/dpdk_nic_bind.py --status 938 939 Network devices using DPDK-compatible driver 940 ============================================ 941 <none> 942 943 Network devices using kernel driver 944 =================================== 945 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused= 946 947 948 # Bind the device to igb_uio. 949 sudo ./tools/dpdk_nic_bind.py -b igb_uio 0000:0a:00.0 950 951 952 # Recheck the status of the devices. 953 ./tools/dpdk_nic_bind.py --status 954 Network devices using DPDK-compatible driver 955 ============================================ 956 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused= 957 958To attach a port created by virtual device, above steps are not needed. 959 960port attach (identifier) 961 962For example, to attach a port whose pci address is 0000:0a:00.0. 963 964.. code-block:: console 965 966 testpmd> port attach 0000:0a:00.0 967 Attaching a new port... 968 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 969 EAL: probe driver: 8086:10fb rte_ixgbe_pmd 970 EAL: PCI memory mapped at 0x7f83bfa00000 971 EAL: PCI memory mapped at 0x7f83bfa80000 972 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5 973 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb 974 Port 0 is attached. Now total ports is 1 975 Done 976 977For example, to attach a port created by pcap PMD. 978 979.. code-block:: console 980 981 testpmd> port attach eth_pcap0 982 Attaching a new port... 983 PMD: Initializing pmd_pcap for eth_pcap0 984 PMD: Creating pcap-backed ethdev on numa socket 0 985 Port 0 is attached. Now total ports is 1 986 Done 987 988In this case, identifier is ``eth_pcap0``. 989This identifier format is the same as ``--vdev`` format of DPDK applications. 990 991For example, to re-attach a bonded port which has been previously detached, 992the mode and slave parameters must be given. 993 994.. code-block:: console 995 996 testpmd> port attach eth_bond_0,mode=0,slave=1 997 Attaching a new port... 998 EAL: Initializing pmd_bond for eth_bond_0 999 EAL: Create bonded device eth_bond_0 on port 0 in mode 0 on socket 0. 1000 Port 0 is attached. Now total ports is 1 1001 Done 1002 1003 1004port detach 1005~~~~~~~~~~~ 1006 1007Detach a specific port. 1008 1009Before detaching a port, the port should be closed:: 1010 1011 testpmd> port detach (port_id) 1012 1013For example, to detach a pci device port 0. 1014 1015.. code-block:: console 1016 1017 testpmd> port close 0 1018 Closing ports... 1019 Done 1020 1021 testpmd> port detach 0 1022 Detaching a port... 1023 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 1024 EAL: remove driver: 8086:10fb rte_ixgbe_pmd 1025 EAL: PCI memory unmapped at 0x7f83bfa00000 1026 EAL: PCI memory unmapped at 0x7f83bfa80000 1027 Done 1028 1029 1030For example, to detach a virtual device port 0. 1031 1032.. code-block:: console 1033 1034 testpmd> port close 0 1035 Closing ports... 1036 Done 1037 1038 testpmd> port detach 0 1039 Detaching a port... 1040 PMD: Closing pcap ethdev on numa socket 0 1041 Port 'eth_pcap0' is detached. Now total ports is 0 1042 Done 1043 1044To remove a pci device completely from the system, first detach the port from testpmd. 1045Then the device should be moved under kernel management. 1046Finally the device can be removed using kernel pci hotplug functionality. 1047 1048For example, to move a pci device under kernel management: 1049 1050.. code-block:: console 1051 1052 sudo ./tools/dpdk_nic_bind.py -b ixgbe 0000:0a:00.0 1053 1054 ./tools/dpdk_nic_bind.py --status 1055 1056 Network devices using DPDK-compatible driver 1057 ============================================ 1058 <none> 1059 1060 Network devices using kernel driver 1061 =================================== 1062 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio 1063 1064To remove a port created by a virtual device, above steps are not needed. 1065 1066port start 1067~~~~~~~~~~ 1068 1069Start all ports or a specific port:: 1070 1071 testpmd> port start (port_id|all) 1072 1073port stop 1074~~~~~~~~~ 1075 1076Stop all ports or a specific port:: 1077 1078 testpmd> port stop (port_id|all) 1079 1080port close 1081~~~~~~~~~~ 1082 1083Close all ports or a specific port:: 1084 1085 testpmd> port close (port_id|all) 1086 1087port start/stop queue 1088~~~~~~~~~~~~~~~~~~~~~ 1089 1090Start/stop a rx/tx queue on a specific port:: 1091 1092 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop) 1093 1094Only take effect when port is started. 1095 1096port config - speed 1097~~~~~~~~~~~~~~~~~~~ 1098 1099Set the speed and duplex mode for all ports or a specific port:: 1100 1101 testpmd> port config (port_id|all) speed (10|100|1000|10000|auto) \ 1102 duplex (half|full|auto) 1103 1104port config - queues/descriptors 1105~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1106 1107Set number of queues/descriptors for rxq, txq, rxd and txd:: 1108 1109 testpmd> port config all (rxq|txq|rxd|txd) (value) 1110 1111This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options. 1112 1113port config - max-pkt-len 1114~~~~~~~~~~~~~~~~~~~~~~~~~ 1115 1116Set the maximum packet length:: 1117 1118 testpmd> port config all max-pkt-len (value) 1119 1120This is equivalent to the ``--max-pkt-len`` command-line option. 1121 1122port config - CRC Strip 1123~~~~~~~~~~~~~~~~~~~~~~~ 1124 1125Set hardware CRC stripping on or off for all ports:: 1126 1127 testpmd> port config all crc-strip (on|off) 1128 1129CRC stripping is off by default. 1130 1131The ``on`` option is equivalent to the ``--crc-strip`` command-line option. 1132 1133port config - RX Checksum 1134~~~~~~~~~~~~~~~~~~~~~~~~~ 1135 1136Set hardware RX checksum offload to on or off for all ports:: 1137 1138 testpmd> port config all rx-cksum (on|off) 1139 1140Checksum offload is off by default. 1141 1142The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option. 1143 1144port config - VLAN 1145~~~~~~~~~~~~~~~~~~ 1146 1147Set hardware VLAN on or off for all ports:: 1148 1149 testpmd> port config all hw-vlan (on|off) 1150 1151Hardware VLAN is on by default. 1152 1153The ``off`` option is equivalent to the ``--disable-hw-vlan`` command-line option. 1154 1155port config - VLAN filter 1156~~~~~~~~~~~~~~~~~~~~~~~~~ 1157 1158Set hardware VLAN filter on or off for all ports:: 1159 1160 testpmd> port config all hw-vlan-filter (on|off) 1161 1162Hardware VLAN filter is on by default. 1163 1164The ``off`` option is equivalent to the ``--disable-hw-vlan-filter`` command-line option. 1165 1166port config - VLAN strip 1167~~~~~~~~~~~~~~~~~~~~~~~~ 1168 1169Set hardware VLAN strip on or off for all ports:: 1170 1171 testpmd> port config all hw-vlan-strip (on|off) 1172 1173Hardware VLAN strip is on by default. 1174 1175The ``off`` option is equivalent to the ``--disable-hw-vlan-strip`` command-line option. 1176 1177port config - VLAN extend 1178~~~~~~~~~~~~~~~~~~~~~~~~~ 1179 1180Set hardware VLAN extend on or off for all ports:: 1181 1182 testpmd> port config all hw-vlan-extend (on|off) 1183 1184Hardware VLAN extend is off by default. 1185 1186The ``off`` option is equivalent to the ``--disable-hw-vlan-extend`` command-line option. 1187 1188port config - Drop Packets 1189~~~~~~~~~~~~~~~~~~~~~~~~~~ 1190 1191Set packet drop for packets with no descriptors on or off for all ports:: 1192 1193 testpmd> port config all drop-en (on|off) 1194 1195Packet dropping for packets with no descriptors is off by default. 1196 1197The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option. 1198 1199port config - RSS 1200~~~~~~~~~~~~~~~~~ 1201 1202Set the RSS (Receive Side Scaling) mode on or off:: 1203 1204 testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|none) 1205 1206RSS is on by default. 1207 1208The ``none`` option is equivalent to the ``--disable-rss`` command-line option. 1209 1210port config - RSS Reta 1211~~~~~~~~~~~~~~~~~~~~~~ 1212 1213Set the RSS (Receive Side Scaling) redirection table:: 1214 1215 testpmd> port config all rss reta (hash,queue)[,(hash,queue)] 1216 1217port config - DCB 1218~~~~~~~~~~~~~~~~~ 1219 1220Set the DCB mode for an individual port:: 1221 1222 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off) 1223 1224The traffic class should be 4 or 8. 1225 1226port config - Burst 1227~~~~~~~~~~~~~~~~~~~ 1228 1229Set the number of packets per burst:: 1230 1231 testpmd> port config all burst (value) 1232 1233This is equivalent to the ``--burst`` command-line option. 1234 1235port config - Threshold 1236~~~~~~~~~~~~~~~~~~~~~~~ 1237 1238Set thresholds for TX/RX queues:: 1239 1240 testpmd> port config all (threshold) (value) 1241 1242Where the threshold type can be: 1243 1244* ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255. 1245 1246* ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255. 1247 1248* ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255. 1249 1250* ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255. 1251 1252* ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255. 1253 1254* ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255. 1255 1256* ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd. 1257 1258* ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd. 1259 1260* ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd. 1261 1262These threshold options are also available from the command-line. 1263 1264port config - E-tag 1265~~~~~~~~~~~~~~~~~~~ 1266 1267Set the value of ether-type for E-tag:: 1268 1269 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value) 1270 1271Enable/disable the E-tag support:: 1272 1273 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable) 1274 1275 1276Link Bonding Functions 1277---------------------- 1278 1279The Link Bonding functions make it possible to dynamically create and 1280manage link bonding devices from within testpmd interactive prompt. 1281 1282create bonded device 1283~~~~~~~~~~~~~~~~~~~~ 1284 1285Create a new bonding device:: 1286 1287 testpmd> create bonded device (mode) (socket) 1288 1289For example, to create a bonded device in mode 1 on socket 0:: 1290 1291 testpmd> create bonded 1 0 1292 created new bonded device (port X) 1293 1294add bonding slave 1295~~~~~~~~~~~~~~~~~ 1296 1297Adds Ethernet device to a Link Bonding device:: 1298 1299 testpmd> add bonding slave (slave id) (port id) 1300 1301For example, to add Ethernet device (port 6) to a Link Bonding device (port 10):: 1302 1303 testpmd> add bonding slave 6 10 1304 1305 1306remove bonding slave 1307~~~~~~~~~~~~~~~~~~~~ 1308 1309Removes an Ethernet slave device from a Link Bonding device:: 1310 1311 testpmd> remove bonding slave (slave id) (port id) 1312 1313For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10):: 1314 1315 testpmd> remove bonding slave 6 10 1316 1317set bonding mode 1318~~~~~~~~~~~~~~~~ 1319 1320Set the Link Bonding mode of a Link Bonding device:: 1321 1322 testpmd> set bonding mode (value) (port id) 1323 1324For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3):: 1325 1326 testpmd> set bonding mode 3 10 1327 1328set bonding primary 1329~~~~~~~~~~~~~~~~~~~ 1330 1331Set an Ethernet slave device as the primary device on a Link Bonding device:: 1332 1333 testpmd> set bonding primary (slave id) (port id) 1334 1335For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10):: 1336 1337 testpmd> set bonding primary 6 10 1338 1339set bonding mac 1340~~~~~~~~~~~~~~~ 1341 1342Set the MAC address of a Link Bonding device:: 1343 1344 testpmd> set bonding mac (port id) (mac) 1345 1346For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01:: 1347 1348 testpmd> set bonding mac 10 00:00:00:00:00:01 1349 1350set bonding xmit_balance_policy 1351~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1352 1353Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:: 1354 1355 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34) 1356 1357For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports):: 1358 1359 testpmd> set bonding xmit_balance_policy 10 l34 1360 1361 1362set bonding mon_period 1363~~~~~~~~~~~~~~~~~~~~~~ 1364 1365Set the link status monitoring polling period in milliseconds for a bonding device. 1366 1367This adds support for PMD slave devices which do not support link status interrupts. 1368When the mon_period is set to a value greater than 0 then all PMD's which do not support 1369link status ISR will be queried every polling interval to check if their link status has changed:: 1370 1371 testpmd> set bonding mon_period (port_id) (value) 1372 1373For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms:: 1374 1375 testpmd> set bonding mon_period 5 150 1376 1377 1378show bonding config 1379~~~~~~~~~~~~~~~~~~~ 1380 1381Show the current configuration of a Link Bonding device:: 1382 1383 testpmd> show bonding config (port id) 1384 1385For example, 1386to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4) 1387in balance mode with a transmission policy of layer 2+3:: 1388 1389 testpmd> show bonding config 9 1390 Bonding mode: 2 1391 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23 1392 Slaves (3): [1 3 4] 1393 Active Slaves (3): [1 3 4] 1394 Primary: [3] 1395 1396 1397Register Functions 1398------------------ 1399 1400The Register Functions can be used to read from and write to registers on the network card referenced by a port number. 1401This is mainly useful for debugging purposes. 1402Reference should be made to the appropriate datasheet for the network card for details on the register addresses 1403and fields that can be accessed. 1404 1405read reg 1406~~~~~~~~ 1407 1408Display the value of a port register:: 1409 1410 testpmd> read reg (port_id) (address) 1411 1412For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller:: 1413 1414 testpmd> read reg 0 0xEE00 1415 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241) 1416 1417read regfield 1418~~~~~~~~~~~~~ 1419 1420Display a port register bit field:: 1421 1422 testpmd> read regfield (port_id) (address) (bit_x) (bit_y) 1423 1424For example, reading the lowest two bits from the register in the example above:: 1425 1426 testpmd> read regfield 0 0xEE00 0 1 1427 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1) 1428 1429read regbit 1430~~~~~~~~~~~ 1431 1432Display a single port register bit:: 1433 1434 testpmd> read regbit (port_id) (address) (bit_x) 1435 1436For example, reading the lowest bit from the register in the example above:: 1437 1438 testpmd> read regbit 0 0xEE00 0 1439 port 0 PCI register at offset 0xEE00: bit 0=1 1440 1441write reg 1442~~~~~~~~~ 1443 1444Set the value of a port register:: 1445 1446 testpmd> write reg (port_id) (address) (value) 1447 1448For example, to clear a register:: 1449 1450 testpmd> write reg 0 0xEE00 0x0 1451 port 0 PCI register at offset 0xEE00: 0x00000000 (0) 1452 1453write regfield 1454~~~~~~~~~~~~~~ 1455 1456Set bit field of a port register:: 1457 1458 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value) 1459 1460For example, writing to the register cleared in the example above:: 1461 1462 testpmd> write regfield 0 0xEE00 0 1 2 1463 port 0 PCI register at offset 0xEE00: 0x00000002 (2) 1464 1465write regbit 1466~~~~~~~~~~~~ 1467 1468Set single bit value of a port register:: 1469 1470 testpmd> write regbit (port_id) (address) (bit_x) (value) 1471 1472For example, to set the high bit in the register from the example above:: 1473 1474 testpmd> write regbit 0 0xEE00 31 1 1475 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658) 1476 1477 1478Filter Functions 1479---------------- 1480 1481This section details the available filter functions that are available. 1482 1483ethertype_filter 1484~~~~~~~~~~~~~~~~~~~~ 1485 1486Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue:: 1487 1488 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \ 1489 ethertype (ether_type) (drop|fwd) queue (queue_id) 1490 1491The available information parameters are: 1492 1493* ``port_id``: The port which the Ethertype filter assigned on. 1494 1495* ``mac_addr``: Compare destination mac address. 1496 1497* ``mac_ignr``: Ignore destination mac address match. 1498 1499* ``mac_address``: Destination mac address to match. 1500 1501* ``ether_type``: The EtherType value want to match, 1502 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid. 1503 1504* ``queue_id``: The receive queue associated with this EtherType filter. 1505 It is meaningless when deleting or dropping. 1506 1507Example, to add/remove an ethertype filter rule:: 1508 1509 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \ 1510 ethertype 0x0806 fwd queue 3 1511 1512 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \ 1513 ethertype 0x0806 fwd queue 3 1514 15152tuple_filter 1516~~~~~~~~~~~~~~~~~ 1517 1518Add or delete a 2-tuple filter, 1519which identifies packets by specific protocol and destination TCP/UDP port 1520and forwards packets into one of the receive queues:: 1521 1522 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \ 1523 protocol (protocol_value) mask (mask_value) \ 1524 tcp_flags (tcp_flags_value) priority (prio_value) \ 1525 queue (queue_id) 1526 1527The available information parameters are: 1528 1529* ``port_id``: The port which the 2-tuple filter assigned on. 1530 1531* ``dst_port_value``: Destination port in L4. 1532 1533* ``protocol_value``: IP L4 protocol. 1534 1535* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate. 1536 1537* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP). 1538 1539* ``prio_value``: Priority of this filter. 1540 1541* ``queue_id``: The receive queue associated with this 2-tuple filter. 1542 1543Example, to add/remove an 2tuple filter rule:: 1544 1545 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \ 1546 tcp_flags 0x02 priority 3 queue 3 1547 1548 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \ 1549 tcp_flags 0x02 priority 3 queue 3 1550 15515tuple_filter 1552~~~~~~~~~~~~~~~~~ 1553 1554Add or delete a 5-tuple filter, 1555which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port) 1556and routes packets into one of the receive queues:: 1557 1558 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \ 1559 (src_address) dst_port (dst_port_value) \ 1560 src_port (src_port_value) protocol (protocol_value) \ 1561 mask (mask_value) tcp_flags (tcp_flags_value) \ 1562 priority (prio_value) queue (queue_id) 1563 1564The available information parameters are: 1565 1566* ``port_id``: The port which the 5-tuple filter assigned on. 1567 1568* ``dst_address``: Destination IP address. 1569 1570* ``src_address``: Source IP address. 1571 1572* ``dst_port_value``: TCP/UDP destination port. 1573 1574* ``src_port_value``: TCP/UDP source port. 1575 1576* ``protocol_value``: L4 protocol. 1577 1578* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate 1579 1580* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP). 1581 1582* ``prio_value``: The priority of this filter. 1583 1584* ``queue_id``: The receive queue associated with this 5-tuple filter. 1585 1586Example, to add/remove an 5tuple filter rule:: 1587 1588 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \ 1589 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \ 1590 flags 0x0 priority 3 queue 3 1591 1592 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \ 1593 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \ 1594 flags 0x0 priority 3 queue 3 1595 1596syn_filter 1597~~~~~~~~~~ 1598 1599Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue:: 1600 1601 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id) 1602 1603The available information parameters are: 1604 1605* ``port_id``: The port which the SYN filter assigned on. 1606 1607* ``high``: This SYN filter has higher priority than other filters. 1608 1609* ``low``: This SYN filter has lower priority than other filters. 1610 1611* ``queue_id``: The receive queue associated with this SYN filter 1612 1613Example:: 1614 1615 testpmd> syn_filter 0 add priority high queue 3 1616 1617flex_filter 1618~~~~~~~~~~~ 1619 1620With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet 1621and routed into one of the receive queues:: 1622 1623 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \ 1624 mask (mask_value) priority (prio_value) queue (queue_id) 1625 1626The available information parameters are: 1627 1628* ``port_id``: The port which the Flex filter is assigned on. 1629 1630* ``len_value``: Filter length in bytes, no greater than 128. 1631 1632* ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match. 1633 1634* ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match. 1635 1636* ``prio_value``: The priority of this filter. 1637 1638* ``queue_id``: The receive queue associated with this Flex filter. 1639 1640Example:: 1641 1642 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \ 1643 mask 000C priority 3 queue 3 1644 1645 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \ 1646 mask 000C priority 3 queue 3 1647 1648 1649.. _testpmd_flow_director: 1650 1651flow_director_filter 1652~~~~~~~~~~~~~~~~~~~~ 1653 1654The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues. 1655 1656Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and 1657Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter: 1658 1659* Perfect match filters. 1660 The hardware checks a match between the masked fields of the received packets and the programmed filters. 1661 The masked fields are for IP flow. 1662 1663* Signature filters. 1664 The hardware checks a match between a hash-based signature of the masked fields of the received packet. 1665 1666* Perfect-mac-vlan match filters. 1667 The hardware checks a match between the masked fields of the received packets and the programmed filters. 1668 The masked fields are for MAC VLAN flow. 1669 1670* Perfect-tunnel match filters. 1671 The hardware checks a match between the masked fields of the received packets and the programmed filters. 1672 The masked fields are for tunnel flow. 1673 1674The Flow Director filters can match the different fields for different type of packet: flow type, specific input set 1675per flow type and the flexible payload. 1676 1677The Flow Director can also mask out parts of all of these fields so that filters 1678are only applied to certain fields or parts of the fields. 1679 1680Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information. 1681 1682# Commands to add flow director filters of different flow types:: 1683 1684 flow_director_filter (port_id) mode IP (add|del|update) \ 1685 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) 1686 src (src_ip_address) dst (dst_ip_address) \ 1687 vlan (vlan_value) flexbytes (flexbytes_value) \ 1688 (drop|fwd) pf|vf(vf_id) queue (queue_id) \ 1689 fd_id (fd_id_value) 1690 1691 flow_director_filter (port_id) mode IP (add|del|update) \ 1692 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \ 1693 src (src_ip_address) (src_port) \ 1694 dst (dst_ip_address) (dst_port) \ 1695 vlan (vlan_value) flexbytes (flexbytes_value) \ 1696 (drop|fwd) queue pf|vf(vf_id) (queue_id) \ 1697 fd_id (fd_id_value) 1698 1699 flow_director_filter (port_id) mode IP (add|del|update) \ 1700 flow (ipv4-sctp|ipv6-sctp) \ 1701 src (src_ip_address) (src_port) \ 1702 dst (dst_ip_address) (dst_port) 1703 tag (verification_tag) vlan (vlan_value) \ 1704 flexbytes (flexbytes_value) (drop|fwd) \ 1705 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value) 1706 1707 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \ 1708 ether (ethertype) flexbytes (flexbytes_value) \ 1709 (drop|fwd) pf|vf(vf_id) queue (queue_id) 1710 fd_id (fd_id_value) 1711 1712 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \ 1713 mac (mac_address) vlan (vlan_value) \ 1714 flexbytes (flexbytes_value) (drop|fwd) \ 1715 queue (queue_id) fd_id (fd_id_value) 1716 1717 flow_director_filter (port_id) mode Tunnel (add|del|update) \ 1718 mac (mac_address) vlan (vlan_value) \ 1719 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \ 1720 flexbytes (flexbytes_value) (drop|fwd) \ 1721 queue (queue_id) fd_id (fd_id_value) 1722 1723For example, to add an ipv4-udp flow type filter:: 1724 1725 testpmd> flow_director_filter 0 add flow ipv4-udp src 2.2.2.3 32 \ 1726 dst 2.2.2.5 33 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1 1727 1728For example, add an ipv4-other flow type filter:: 1729 1730 testpmd> flow_director_filter 0 add flow ipv4-other src 2.2.2.3 \ 1731 dst 2.2.2.5 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1 1732 1733flush_flow_director 1734~~~~~~~~~~~~~~~~~~~ 1735 1736Flush all flow director filters on a device:: 1737 1738 testpmd> flush_flow_director (port_id) 1739 1740Example, to flush all flow director filter on port 0:: 1741 1742 testpmd> flush_flow_director 0 1743 1744flow_director_mask 1745~~~~~~~~~~~~~~~~~~ 1746 1747Set flow director's input masks:: 1748 1749 flow_director_mask (port_id) mode IP vlan (vlan_value) \ 1750 src_mask (ipv4_src) (ipv6_src) (src_port) \ 1751 dst_mask (ipv4_dst) (ipv6_dst) (dst_port) 1752 1753 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) \ 1754 mac (mac_value) 1755 1756 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \ 1757 mac (mac_value) tunnel-type (tunnel_type_value) \ 1758 tunnel-id (tunnel_id_value) 1759 1760Example, to set flow director mask on port 0:: 1761 1762 testpmd> flow_director_mask 0 vlan 0xefff \ 1763 src_mask 255.255.255.255 \ 1764 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \ 1765 dst_mask 255.255.255.255 \ 1766 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF 1767 1768flow_director_flex_mask 1769~~~~~~~~~~~~~~~~~~~~~~~ 1770 1771set masks of flow director's flexible payload based on certain flow type:: 1772 1773 testpmd> flow_director_flex_mask (port_id) \ 1774 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 1775 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \ 1776 l2_payload|all) (mask) 1777 1778Example, to set flow director's flex mask for all flow type on port 0:: 1779 1780 testpmd> flow_director_flex_mask 0 flow all \ 1781 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0) 1782 1783 1784flow_director_flex_payload 1785~~~~~~~~~~~~~~~~~~~~~~~~~~ 1786 1787Configure flexible payload selection:: 1788 1789 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config) 1790 1791For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload:: 1792 1793 testpmd> flow_director_flex_payload 0 l4 \ 1794 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19) 1795 1796get_sym_hash_ena_per_port 1797~~~~~~~~~~~~~~~~~~~~~~~~~ 1798 1799Get symmetric hash enable configuration per port:: 1800 1801 get_sym_hash_ena_per_port (port_id) 1802 1803For example, to get symmetric hash enable configuration of port 1:: 1804 1805 testpmd> get_sym_hash_ena_per_port 1 1806 1807set_sym_hash_ena_per_port 1808~~~~~~~~~~~~~~~~~~~~~~~~~ 1809 1810Set symmetric hash enable configuration per port to enable or disable:: 1811 1812 set_sym_hash_ena_per_port (port_id) (enable|disable) 1813 1814For example, to set symmetric hash enable configuration of port 1 to enable:: 1815 1816 testpmd> set_sym_hash_ena_per_port 1 enable 1817 1818get_hash_global_config 1819~~~~~~~~~~~~~~~~~~~~~~ 1820 1821Get the global configurations of hash filters:: 1822 1823 get_hash_global_config (port_id) 1824 1825For example, to get the global configurations of hash filters of port 1:: 1826 1827 testpmd> get_hash_global_config 1 1828 1829set_hash_global_config 1830~~~~~~~~~~~~~~~~~~~~~~ 1831 1832Set the global configurations of hash filters:: 1833 1834 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \ 1835 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \ 1836 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) \ 1837 (enable|disable) 1838 1839For example, to enable simple_xor for flow type of ipv6 on port 2:: 1840 1841 testpmd> set_hash_global_config 2 simple_xor ipv6 enable 1842 1843set_hash_input_set 1844~~~~~~~~~~~~~~~~~~ 1845 1846Set the input set for hash:: 1847 1848 set_hash_input_set (port_id) (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 1849 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \ 1850 l2_payload) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \ 1851 ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \ 1852 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \ 1853 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \ 1854 fld-8th|none) (select|add) 1855 1856For example, to add source IP to hash input set for flow type of ipv4 on port 0:: 1857 1858 testpmd> set_hash_input_set 0 ipv4 src-ipv4 add 1859 1860set_fdir_input_set 1861~~~~~~~~~~~~~~~~~~ 1862 1863Set the input set for Fdir:: 1864 1865 set_fdir_input_set (port_id) (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 1866 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) 1867 (src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|udp-src-port|udp-dst-port| \ 1868 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \ 1869 fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th|fld-8th|none) \ 1870 (select|add) 1871 1872For example to add source IP to FD input set for flow type of ipv4 on port 0:: 1873 1874 testpmd> set_fdir_input_set 0 ipv4 src-ipv4 add 1875 1876global_config 1877~~~~~~~~~~~~~ 1878 1879Set different GRE key length for input set:: 1880 1881 global_config (port_id) gre-key-len (number in bytes) 1882 1883For example to set GRE key length for input set to 4 bytes on port 0:: 1884 1885 testpmd> global_config 0 gre-key-len 4 1886