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 outer VLAN TPID for packet filtering on a port:: 502 503 testpmd> vlan set 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 543rx_vlan set tpid 544~~~~~~~~~~~~~~~~ 545 546Set the outer VLAN TPID for packet filtering on a port:: 547 548 testpmd> rx_vlan set tpid (value) (port_id) 549 550tunnel_filter add 551~~~~~~~~~~~~~~~~~ 552 553Add a tunnel filter on a port:: 554 555 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \ 556 (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id) 557 558tunnel_filter remove 559~~~~~~~~~~~~~~~~~~~~ 560 561Remove a tunnel filter on a port:: 562 563 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \ 564 (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id) 565 566rx_vxlan_port add 567~~~~~~~~~~~~~~~~~ 568 569Add an UDP port for VXLAN packet filter on a port:: 570 571 testpmd> rx_vxlan_port add (udp_port) (port_id) 572 573rx_vxlan_port remove 574~~~~~~~~~~~~~~~~~~~~ 575 576Remove an UDP port for VXLAN packet filter on a port:: 577 578 testpmd> rx_vxlan_port rm (udp_port) (port_id) 579 580tx_vlan set 581~~~~~~~~~~~ 582 583Set hardware insertion of VLAN IDs in packets sent on a port:: 584 585 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer] 586 587For example, set a single VLAN ID (5) insertion on port 0:: 588 589 tx_vlan set 0 5 590 591Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1:: 592 593 tx_vlan set 1 2 3 594 595 596tx_vlan set pvid 597~~~~~~~~~~~~~~~~ 598 599Set port based hardware insertion of VLAN ID in packets sent on a port:: 600 601 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off) 602 603tx_vlan reset 604~~~~~~~~~~~~~ 605 606Disable hardware insertion of a VLAN header in packets sent on a port:: 607 608 testpmd> tx_vlan reset (port_id) 609 610csum set 611~~~~~~~~ 612 613Select hardware or software calculation of the checksum when 614transmitting a packet using the ``csum`` forwarding engine:: 615 616 testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id) 617 618Where: 619 620* ``ip|udp|tcp|sctp`` always relate to the inner layer. 621 622* ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized 623 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are 624 supported). See also the ``csum parse-tunnel`` command. 625 626.. note:: 627 628 Check the NIC Datasheet for hardware limits. 629 630csum parse-tunnel 631~~~~~~~~~~~~~~~~~ 632 633Define how tunneled packets should be handled by the csum forward 634engine:: 635 636 testpmd> csum parse-tunnel (on|off) (tx_port_id) 637 638If enabled, the csum forward engine will try to recognize supported 639tunnel headers (vxlan, gre, ipip). 640 641If disabled, treat tunnel packets as non-tunneled packets (a inner 642header is handled as a packet payload). 643 644.. note:: 645 646 The port argument is the TX port like in the ``csum set`` command. 647 648Example: 649 650Consider a packet in packet like the following:: 651 652 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in 653 654* If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set`` 655 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the 656 ``outer-ip parameter`` relates to the outer headers (here ``ipv4_out``). 657 658* If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set`` 659 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``. 660 661csum show 662~~~~~~~~~ 663 664Display tx checksum offload configuration:: 665 666 testpmd> csum show (port_id) 667 668tso set 669~~~~~~~ 670 671Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine:: 672 673 testpmd> tso set (segsize) (port_id) 674 675.. note:: 676 677 Check the NIC datasheet for hardware limits. 678 679tso show 680~~~~~~~~ 681 682Display the status of TCP Segmentation Offload:: 683 684 testpmd> tso show (port_id) 685 686mac_addr add 687~~~~~~~~~~~~ 688 689Add an alternative MAC address to a port:: 690 691 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX) 692 693mac_addr remove 694~~~~~~~~~~~~~~~ 695 696Remove a MAC address from a port:: 697 698 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX) 699 700mac_addr add(for VF) 701~~~~~~~~~~~~~~~~~~~~ 702 703Add an alternative MAC address for a VF to a port:: 704 705 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX) 706 707set port-uta 708~~~~~~~~~~~~ 709 710Set the unicast hash filter(s) on/off for a port:: 711 712 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off) 713 714set promisc 715~~~~~~~~~~~ 716 717Set the promiscuous mode on for a port or for all ports. 718In promiscuous mode packets are not dropped if they aren't for the specified MAC address:: 719 720 testpmd> set promisc (port_id|all) (on|off) 721 722set allmulti 723~~~~~~~~~~~~ 724 725Set the allmulti mode for a port or for all ports:: 726 727 testpmd> set allmulti (port_id|all) (on|off) 728 729Same as the ifconfig (8) option. Controls how multicast packets are handled. 730 731set flow_ctrl rx 732~~~~~~~~~~~~~~~~ 733 734Set the link flow control parameter on a port:: 735 736 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 737 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \ 738 autoneg (on|off) (port_id) 739 740Where: 741 742* ``high_water`` (integer): High threshold value to trigger XOFF. 743 744* ``low_water`` (integer): Low threshold value to trigger XON. 745 746* ``pause_time`` (integer): Pause quota in the Pause frame. 747 748* ``send_xon`` (0/1): Send XON frame. 749 750* ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames. 751 752* ``autoneg``: Change the auto-negotiation para mete. 753 754set pfc_ctrl rx 755~~~~~~~~~~~~~~~ 756 757Set the priority flow control parameter on a port:: 758 759 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ 760 (pause_time) (priority) (port_id) 761 762Where: 763 764* ``high_water`` (integer): High threshold value. 765 766* ``low_water`` (integer): Low threshold value. 767 768* ``pause_time`` (integer): Pause quota in the Pause frame. 769 770* ``priority`` (0-7): VLAN User Priority. 771 772set stat_qmap 773~~~~~~~~~~~~~ 774 775Set statistics mapping (qmapping 0..15) for RX/TX queue on port:: 776 777 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping) 778 779For example, to set rx queue 2 on port 0 to mapping 5:: 780 781 testpmd>set stat_qmap rx 0 2 5 782 783set port - rx/tx (for VF) 784~~~~~~~~~~~~~~~~~~~~~~~~~ 785 786Set VF receive/transmit from a port:: 787 788 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off) 789 790set port - mac address filter (for VF) 791~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 792 793Add/Remove unicast or multicast MAC addr filter for a VF:: 794 795 testpmd> set port (port_id) vf (vf_id) (mac_addr) \ 796 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off) 797 798set port - rx mode(for VF) 799~~~~~~~~~~~~~~~~~~~~~~~~~~ 800 801Set the VF receive mode of a port:: 802 803 testpmd> set port (port_id) vf (vf_id) \ 804 rxmode (AUPE|ROPE|BAM|MPE) (on|off) 805 806The available receive modes are: 807 808* ``AUPE``: Accepts untagged VLAN. 809 810* ``ROPE``: Accepts unicast hash. 811 812* ``BAM``: Accepts broadcast packets. 813 814* ``MPE``: Accepts all multicast packets. 815 816set port - tx_rate (for Queue) 817~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 818 819Set TX rate limitation for a queue on a port:: 820 821 testpmd> set port (port_id) queue (queue_id) rate (rate_value) 822 823set port - tx_rate (for VF) 824~~~~~~~~~~~~~~~~~~~~~~~~~~~ 825 826Set TX rate limitation for queues in VF on a port:: 827 828 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask) 829 830set port - mirror rule 831~~~~~~~~~~~~~~~~~~~~~~ 832 833Set pool or vlan type mirror rule for a port:: 834 835 testpmd> set port (port_id) mirror-rule (rule_id) \ 836 (pool-mirror-up|pool-mirror-down|vlan-mirror) \ 837 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off) 838 839Set link mirror rule for a port:: 840 841 testpmd> set port (port_id) mirror-rule (rule_id) \ 842 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off) 843 844For example to enable mirror traffic with vlan 0,1 to pool 0:: 845 846 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on 847 848reset port - mirror rule 849~~~~~~~~~~~~~~~~~~~~~~~~ 850 851Reset a mirror rule for a port:: 852 853 testpmd> reset port (port_id) mirror-rule (rule_id) 854 855set flush_rx 856~~~~~~~~~~~~ 857 858Set the flush on RX streams before forwarding. 859The default is flush ``on``. 860Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams:: 861 862 testpmd> set flush_rx off 863 864set bypass mode 865~~~~~~~~~~~~~~~ 866 867Set the bypass mode for the lowest port on bypass enabled NIC:: 868 869 testpmd> set bypass mode (normal|bypass|isolate) (port_id) 870 871set bypass event 872~~~~~~~~~~~~~~~~ 873 874Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled:: 875 876 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \ 877 mode (normal|bypass|isolate) (port_id) 878 879Where: 880 881* ``timeout``: Enable bypass after watchdog timeout. 882 883* ``os_on``: Enable bypass when OS/board is powered on. 884 885* ``os_off``: Enable bypass when OS/board is powered off. 886 887* ``power_on``: Enable bypass when power supply is turned on. 888 889* ``power_off``: Enable bypass when power supply is turned off. 890 891 892set bypass timeout 893~~~~~~~~~~~~~~~~~~ 894 895Set the bypass watchdog timeout to ``n`` seconds where 0 = instant:: 896 897 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32) 898 899show bypass config 900~~~~~~~~~~~~~~~~~~ 901 902Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC:: 903 904 testpmd> show bypass config (port_id) 905 906set link up 907~~~~~~~~~~~ 908 909Set link up for a port:: 910 911 testpmd> set link-up port (port id) 912 913set link down 914~~~~~~~~~~~~~ 915 916Set link down for a port:: 917 918 testpmd> set link-down port (port id) 919 920 921Port Functions 922-------------- 923 924The following sections show functions for configuring ports. 925 926.. note:: 927 928 Port configuration changes only become active when forwarding is started/restarted. 929 930port attach 931~~~~~~~~~~~ 932 933Attach a port specified by pci address or virtual device args. 934 935To attach a new pci device, the device should be recognized by kernel first. 936Then it should be moved under DPDK management. 937Finally the port can be attached to testpmd. 938 939For example, to move a pci device using ixgbe under DPDK management: 940 941.. code-block:: console 942 943 # Check the status of the available devices. 944 ./tools/dpdk_nic_bind.py --status 945 946 Network devices using DPDK-compatible driver 947 ============================================ 948 <none> 949 950 Network devices using kernel driver 951 =================================== 952 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused= 953 954 955 # Bind the device to igb_uio. 956 sudo ./tools/dpdk_nic_bind.py -b igb_uio 0000:0a:00.0 957 958 959 # Recheck the status of the devices. 960 ./tools/dpdk_nic_bind.py --status 961 Network devices using DPDK-compatible driver 962 ============================================ 963 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused= 964 965To attach a port created by virtual device, above steps are not needed. 966 967port attach (identifier) 968 969For example, to attach a port whose pci address is 0000:0a:00.0. 970 971.. code-block:: console 972 973 testpmd> port attach 0000:0a:00.0 974 Attaching a new port... 975 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 976 EAL: probe driver: 8086:10fb rte_ixgbe_pmd 977 EAL: PCI memory mapped at 0x7f83bfa00000 978 EAL: PCI memory mapped at 0x7f83bfa80000 979 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5 980 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb 981 Port 0 is attached. Now total ports is 1 982 Done 983 984For example, to attach a port created by pcap PMD. 985 986.. code-block:: console 987 988 testpmd> port attach eth_pcap0 989 Attaching a new port... 990 PMD: Initializing pmd_pcap for eth_pcap0 991 PMD: Creating pcap-backed ethdev on numa socket 0 992 Port 0 is attached. Now total ports is 1 993 Done 994 995In this case, identifier is ``eth_pcap0``. 996This identifier format is the same as ``--vdev`` format of DPDK applications. 997 998For example, to re-attach a bonded port which has been previously detached, 999the mode and slave parameters must be given. 1000 1001.. code-block:: console 1002 1003 testpmd> port attach eth_bond_0,mode=0,slave=1 1004 Attaching a new port... 1005 EAL: Initializing pmd_bond for eth_bond_0 1006 EAL: Create bonded device eth_bond_0 on port 0 in mode 0 on socket 0. 1007 Port 0 is attached. Now total ports is 1 1008 Done 1009 1010 1011port detach 1012~~~~~~~~~~~ 1013 1014Detach a specific port. 1015 1016Before detaching a port, the port should be closed:: 1017 1018 testpmd> port detach (port_id) 1019 1020For example, to detach a pci device port 0. 1021 1022.. code-block:: console 1023 1024 testpmd> port close 0 1025 Closing ports... 1026 Done 1027 1028 testpmd> port detach 0 1029 Detaching a port... 1030 EAL: PCI device 0000:0a:00.0 on NUMA socket -1 1031 EAL: remove driver: 8086:10fb rte_ixgbe_pmd 1032 EAL: PCI memory unmapped at 0x7f83bfa00000 1033 EAL: PCI memory unmapped at 0x7f83bfa80000 1034 Done 1035 1036 1037For example, to detach a virtual device port 0. 1038 1039.. code-block:: console 1040 1041 testpmd> port close 0 1042 Closing ports... 1043 Done 1044 1045 testpmd> port detach 0 1046 Detaching a port... 1047 PMD: Closing pcap ethdev on numa socket 0 1048 Port 'eth_pcap0' is detached. Now total ports is 0 1049 Done 1050 1051To remove a pci device completely from the system, first detach the port from testpmd. 1052Then the device should be moved under kernel management. 1053Finally the device can be removed using kernel pci hotplug functionality. 1054 1055For example, to move a pci device under kernel management: 1056 1057.. code-block:: console 1058 1059 sudo ./tools/dpdk_nic_bind.py -b ixgbe 0000:0a:00.0 1060 1061 ./tools/dpdk_nic_bind.py --status 1062 1063 Network devices using DPDK-compatible driver 1064 ============================================ 1065 <none> 1066 1067 Network devices using kernel driver 1068 =================================== 1069 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio 1070 1071To remove a port created by a virtual device, above steps are not needed. 1072 1073port start 1074~~~~~~~~~~ 1075 1076Start all ports or a specific port:: 1077 1078 testpmd> port start (port_id|all) 1079 1080port stop 1081~~~~~~~~~ 1082 1083Stop all ports or a specific port:: 1084 1085 testpmd> port stop (port_id|all) 1086 1087port close 1088~~~~~~~~~~ 1089 1090Close all ports or a specific port:: 1091 1092 testpmd> port close (port_id|all) 1093 1094port start/stop queue 1095~~~~~~~~~~~~~~~~~~~~~ 1096 1097Start/stop a rx/tx queue on a specific port:: 1098 1099 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop) 1100 1101Only take effect when port is started. 1102 1103port config - speed 1104~~~~~~~~~~~~~~~~~~~ 1105 1106Set the speed and duplex mode for all ports or a specific port:: 1107 1108 testpmd> port config (port_id|all) speed (10|100|1000|10000|auto) \ 1109 duplex (half|full|auto) 1110 1111port config - queues/descriptors 1112~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1113 1114Set number of queues/descriptors for rxq, txq, rxd and txd:: 1115 1116 testpmd> port config all (rxq|txq|rxd|txd) (value) 1117 1118This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options. 1119 1120port config - max-pkt-len 1121~~~~~~~~~~~~~~~~~~~~~~~~~ 1122 1123Set the maximum packet length:: 1124 1125 testpmd> port config all max-pkt-len (value) 1126 1127This is equivalent to the ``--max-pkt-len`` command-line option. 1128 1129port config - CRC Strip 1130~~~~~~~~~~~~~~~~~~~~~~~ 1131 1132Set hardware CRC stripping on or off for all ports:: 1133 1134 testpmd> port config all crc-strip (on|off) 1135 1136CRC stripping is off by default. 1137 1138The ``on`` option is equivalent to the ``--crc-strip`` command-line option. 1139 1140port config - RX Checksum 1141~~~~~~~~~~~~~~~~~~~~~~~~~ 1142 1143Set hardware RX checksum offload to on or off for all ports:: 1144 1145 testpmd> port config all rx-cksum (on|off) 1146 1147Checksum offload is off by default. 1148 1149The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option. 1150 1151port config - VLAN 1152~~~~~~~~~~~~~~~~~~ 1153 1154Set hardware VLAN on or off for all ports:: 1155 1156 testpmd> port config all hw-vlan (on|off) 1157 1158Hardware VLAN is on by default. 1159 1160The ``off`` option is equivalent to the ``--disable-hw-vlan`` command-line option. 1161 1162port config - VLAN filter 1163~~~~~~~~~~~~~~~~~~~~~~~~~ 1164 1165Set hardware VLAN filter on or off for all ports:: 1166 1167 testpmd> port config all hw-vlan-filter (on|off) 1168 1169Hardware VLAN filter is on by default. 1170 1171The ``off`` option is equivalent to the ``--disable-hw-vlan-filter`` command-line option. 1172 1173port config - VLAN strip 1174~~~~~~~~~~~~~~~~~~~~~~~~ 1175 1176Set hardware VLAN strip on or off for all ports:: 1177 1178 testpmd> port config all hw-vlan-strip (on|off) 1179 1180Hardware VLAN strip is on by default. 1181 1182The ``off`` option is equivalent to the ``--disable-hw-vlan-strip`` command-line option. 1183 1184port config - VLAN extend 1185~~~~~~~~~~~~~~~~~~~~~~~~~ 1186 1187Set hardware VLAN extend on or off for all ports:: 1188 1189 testpmd> port config all hw-vlan-extend (on|off) 1190 1191Hardware VLAN extend is off by default. 1192 1193The ``off`` option is equivalent to the ``--disable-hw-vlan-extend`` command-line option. 1194 1195port config - Drop Packets 1196~~~~~~~~~~~~~~~~~~~~~~~~~~ 1197 1198Set packet drop for packets with no descriptors on or off for all ports:: 1199 1200 testpmd> port config all drop-en (on|off) 1201 1202Packet dropping for packets with no descriptors is off by default. 1203 1204The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option. 1205 1206port config - RSS 1207~~~~~~~~~~~~~~~~~ 1208 1209Set the RSS (Receive Side Scaling) mode on or off:: 1210 1211 testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|none) 1212 1213RSS is on by default. 1214 1215The ``none`` option is equivalent to the ``--disable-rss`` command-line option. 1216 1217port config - RSS Reta 1218~~~~~~~~~~~~~~~~~~~~~~ 1219 1220Set the RSS (Receive Side Scaling) redirection table:: 1221 1222 testpmd> port config all rss reta (hash,queue)[,(hash,queue)] 1223 1224port config - DCB 1225~~~~~~~~~~~~~~~~~ 1226 1227Set the DCB mode for an individual port:: 1228 1229 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off) 1230 1231The traffic class should be 4 or 8. 1232 1233port config - Burst 1234~~~~~~~~~~~~~~~~~~~ 1235 1236Set the number of packets per burst:: 1237 1238 testpmd> port config all burst (value) 1239 1240This is equivalent to the ``--burst`` command-line option. 1241 1242port config - Threshold 1243~~~~~~~~~~~~~~~~~~~~~~~ 1244 1245Set thresholds for TX/RX queues:: 1246 1247 testpmd> port config all (threshold) (value) 1248 1249Where the threshold type can be: 1250 1251* ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255. 1252 1253* ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255. 1254 1255* ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255. 1256 1257* ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255. 1258 1259* ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255. 1260 1261* ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255. 1262 1263* ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd. 1264 1265* ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd. 1266 1267* ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd. 1268 1269These threshold options are also available from the command-line. 1270 1271 1272Link Bonding Functions 1273---------------------- 1274 1275The Link Bonding functions make it possible to dynamically create and 1276manage link bonding devices from within testpmd interactive prompt. 1277 1278create bonded device 1279~~~~~~~~~~~~~~~~~~~~ 1280 1281Create a new bonding device:: 1282 1283 testpmd> create bonded device (mode) (socket) 1284 1285For example, to create a bonded device in mode 1 on socket 0:: 1286 1287 testpmd> create bonded 1 0 1288 created new bonded device (port X) 1289 1290add bonding slave 1291~~~~~~~~~~~~~~~~~ 1292 1293Adds Ethernet device to a Link Bonding device:: 1294 1295 testpmd> add bonding slave (slave id) (port id) 1296 1297For example, to add Ethernet device (port 6) to a Link Bonding device (port 10):: 1298 1299 testpmd> add bonding slave 6 10 1300 1301 1302remove bonding slave 1303~~~~~~~~~~~~~~~~~~~~ 1304 1305Removes an Ethernet slave device from a Link Bonding device:: 1306 1307 testpmd> remove bonding slave (slave id) (port id) 1308 1309For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10):: 1310 1311 testpmd> remove bonding slave 6 10 1312 1313set bonding mode 1314~~~~~~~~~~~~~~~~ 1315 1316Set the Link Bonding mode of a Link Bonding device:: 1317 1318 testpmd> set bonding mode (value) (port id) 1319 1320For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3):: 1321 1322 testpmd> set bonding mode 3 10 1323 1324set bonding primary 1325~~~~~~~~~~~~~~~~~~~ 1326 1327Set an Ethernet slave device as the primary device on a Link Bonding device:: 1328 1329 testpmd> set bonding primary (slave id) (port id) 1330 1331For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10):: 1332 1333 testpmd> set bonding primary 6 10 1334 1335set bonding mac 1336~~~~~~~~~~~~~~~ 1337 1338Set the MAC address of a Link Bonding device:: 1339 1340 testpmd> set bonding mac (port id) (mac) 1341 1342For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01:: 1343 1344 testpmd> set bonding mac 10 00:00:00:00:00:01 1345 1346set bonding xmit_balance_policy 1347~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1348 1349Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:: 1350 1351 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34) 1352 1353For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports):: 1354 1355 testpmd> set bonding xmit_balance_policy 10 l34 1356 1357 1358set bonding mon_period 1359~~~~~~~~~~~~~~~~~~~~~~ 1360 1361Set the link status monitoring polling period in milliseconds for a bonding device. 1362 1363This adds support for PMD slave devices which do not support link status interrupts. 1364When the mon_period is set to a value greater than 0 then all PMD's which do not support 1365link status ISR will be queried every polling interval to check if their link status has changed:: 1366 1367 testpmd> set bonding mon_period (port_id) (value) 1368 1369For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms:: 1370 1371 testpmd> set bonding mon_period 5 150 1372 1373 1374show bonding config 1375~~~~~~~~~~~~~~~~~~~ 1376 1377Show the current configuration of a Link Bonding device:: 1378 1379 testpmd> show bonding config (port id) 1380 1381For example, 1382to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4) 1383in balance mode with a transmission policy of layer 2+3:: 1384 1385 testpmd> show bonding config 9 1386 Bonding mode: 2 1387 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23 1388 Slaves (3): [1 3 4] 1389 Active Slaves (3): [1 3 4] 1390 Primary: [3] 1391 1392 1393Register Functions 1394------------------ 1395 1396The Register Functions can be used to read from and write to registers on the network card referenced by a port number. 1397This is mainly useful for debugging purposes. 1398Reference should be made to the appropriate datasheet for the network card for details on the register addresses 1399and fields that can be accessed. 1400 1401read reg 1402~~~~~~~~ 1403 1404Display the value of a port register:: 1405 1406 testpmd> read reg (port_id) (address) 1407 1408For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller:: 1409 1410 testpmd> read reg 0 0xEE00 1411 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241) 1412 1413read regfield 1414~~~~~~~~~~~~~ 1415 1416Display a port register bit field:: 1417 1418 testpmd> read regfield (port_id) (address) (bit_x) (bit_y) 1419 1420For example, reading the lowest two bits from the register in the example above:: 1421 1422 testpmd> read regfield 0 0xEE00 0 1 1423 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1) 1424 1425read regbit 1426~~~~~~~~~~~ 1427 1428Display a single port register bit:: 1429 1430 testpmd> read regbit (port_id) (address) (bit_x) 1431 1432For example, reading the lowest bit from the register in the example above:: 1433 1434 testpmd> read regbit 0 0xEE00 0 1435 port 0 PCI register at offset 0xEE00: bit 0=1 1436 1437write reg 1438~~~~~~~~~ 1439 1440Set the value of a port register:: 1441 1442 testpmd> write reg (port_id) (address) (value) 1443 1444For example, to clear a register:: 1445 1446 testpmd> write reg 0 0xEE00 0x0 1447 port 0 PCI register at offset 0xEE00: 0x00000000 (0) 1448 1449write regfield 1450~~~~~~~~~~~~~~ 1451 1452Set bit field of a port register:: 1453 1454 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value) 1455 1456For example, writing to the register cleared in the example above:: 1457 1458 testpmd> write regfield 0 0xEE00 0 1 2 1459 port 0 PCI register at offset 0xEE00: 0x00000002 (2) 1460 1461write regbit 1462~~~~~~~~~~~~ 1463 1464Set single bit value of a port register:: 1465 1466 testpmd> write regbit (port_id) (address) (bit_x) (value) 1467 1468For example, to set the high bit in the register from the example above:: 1469 1470 testpmd> write regbit 0 0xEE00 31 1 1471 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658) 1472 1473 1474Filter Functions 1475---------------- 1476 1477This section details the available filter functions that are available. 1478 1479ethertype_filter 1480~~~~~~~~~~~~~~~~~~~~ 1481 1482Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue:: 1483 1484 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \ 1485 ethertype (ether_type) (drop|fwd) queue (queue_id) 1486 1487The available information parameters are: 1488 1489* ``port_id``: The port which the Ethertype filter assigned on. 1490 1491* ``mac_addr``: Compare destination mac address. 1492 1493* ``mac_ignr``: Ignore destination mac address match. 1494 1495* ``mac_address``: Destination mac address to match. 1496 1497* ``ether_type``: The EtherType value want to match, 1498 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid. 1499 1500* ``queue_id``: The receive queue associated with this EtherType filter. 1501 It is meaningless when deleting or dropping. 1502 1503Example, to add/remove an ethertype filter rule:: 1504 1505 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \ 1506 ethertype 0x0806 fwd queue 3 1507 1508 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \ 1509 ethertype 0x0806 fwd queue 3 1510 15112tuple_filter 1512~~~~~~~~~~~~~~~~~ 1513 1514Add or delete a 2-tuple filter, 1515which identifies packets by specific protocol and destination TCP/UDP port 1516and forwards packets into one of the receive queues:: 1517 1518 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \ 1519 protocol (protocol_value) mask (mask_value) \ 1520 tcp_flags (tcp_flags_value) priority (prio_value) \ 1521 queue (queue_id) 1522 1523The available information parameters are: 1524 1525* ``port_id``: The port which the 2-tuple filter assigned on. 1526 1527* ``dst_port_value``: Destination port in L4. 1528 1529* ``protocol_value``: IP L4 protocol. 1530 1531* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate. 1532 1533* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP). 1534 1535* ``prio_value``: Priority of this filter. 1536 1537* ``queue_id``: The receive queue associated with this 2-tuple filter. 1538 1539Example, to add/remove an 2tuple filter rule:: 1540 1541 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \ 1542 tcp_flags 0x02 priority 3 queue 3 1543 1544 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \ 1545 tcp_flags 0x02 priority 3 queue 3 1546 15475tuple_filter 1548~~~~~~~~~~~~~~~~~ 1549 1550Add or delete a 5-tuple filter, 1551which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port) 1552and routes packets into one of the receive queues:: 1553 1554 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \ 1555 (src_address) dst_port (dst_port_value) \ 1556 src_port (src_port_value) protocol (protocol_value) \ 1557 mask (mask_value) tcp_flags (tcp_flags_value) \ 1558 priority (prio_value) queue (queue_id) 1559 1560The available information parameters are: 1561 1562* ``port_id``: The port which the 5-tuple filter assigned on. 1563 1564* ``dst_address``: Destination IP address. 1565 1566* ``src_address``: Source IP address. 1567 1568* ``dst_port_value``: TCP/UDP destination port. 1569 1570* ``src_port_value``: TCP/UDP source port. 1571 1572* ``protocol_value``: L4 protocol. 1573 1574* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate 1575 1576* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP). 1577 1578* ``prio_value``: The priority of this filter. 1579 1580* ``queue_id``: The receive queue associated with this 5-tuple filter. 1581 1582Example, to add/remove an 5tuple filter rule:: 1583 1584 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \ 1585 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \ 1586 flags 0x0 priority 3 queue 3 1587 1588 testpmd> 5tuple_filter 0 del 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 1592syn_filter 1593~~~~~~~~~~ 1594 1595Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue:: 1596 1597 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id) 1598 1599The available information parameters are: 1600 1601* ``port_id``: The port which the SYN filter assigned on. 1602 1603* ``high``: This SYN filter has higher priority than other filters. 1604 1605* ``low``: This SYN filter has lower priority than other filters. 1606 1607* ``queue_id``: The receive queue associated with this SYN filter 1608 1609Example:: 1610 1611 testpmd> syn_filter 0 add priority high queue 3 1612 1613flex_filter 1614~~~~~~~~~~~ 1615 1616With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet 1617and routed into one of the receive queues:: 1618 1619 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \ 1620 mask (mask_value) priority (prio_value) queue (queue_id) 1621 1622The available information parameters are: 1623 1624* ``port_id``: The port which the Flex filter is assigned on. 1625 1626* ``len_value``: Filter length in bytes, no greater than 128. 1627 1628* ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match. 1629 1630* ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match. 1631 1632* ``prio_value``: The priority of this filter. 1633 1634* ``queue_id``: The receive queue associated with this Flex filter. 1635 1636Example:: 1637 1638 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \ 1639 mask 000C priority 3 queue 3 1640 1641 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \ 1642 mask 000C priority 3 queue 3 1643 1644 1645.. _testpmd_flow_director: 1646 1647flow_director_filter 1648~~~~~~~~~~~~~~~~~~~~ 1649 1650The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues. 1651 1652Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and 1653Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter: 1654 1655* Perfect match filters. 1656 The hardware checks a match between the masked fields of the received packets and the programmed filters. 1657 The masked fields are for IP flow. 1658 1659* Signature filters. 1660 The hardware checks a match between a hash-based signature of the masked fields of the received packet. 1661 1662* Perfect-mac-vlan match filters. 1663 The hardware checks a match between the masked fields of the received packets and the programmed filters. 1664 The masked fields are for MAC VLAN flow. 1665 1666* Perfect-tunnel 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 tunnel flow. 1669 1670The Flow Director filters can match the different fields for different type of packet: flow type, specific input set 1671per flow type and the flexible payload. 1672 1673The Flow Director can also mask out parts of all of these fields so that filters 1674are only applied to certain fields or parts of the fields. 1675 1676Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information. 1677 1678# Commands to add flow director filters of different flow types:: 1679 1680 flow_director_filter (port_id) mode IP (add|del|update) \ 1681 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) 1682 src (src_ip_address) dst (dst_ip_address) \ 1683 vlan (vlan_value) flexbytes (flexbytes_value) \ 1684 (drop|fwd) pf|vf(vf_id) queue (queue_id) \ 1685 fd_id (fd_id_value) 1686 1687 flow_director_filter (port_id) mode IP (add|del|update) \ 1688 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \ 1689 src (src_ip_address) (src_port) \ 1690 dst (dst_ip_address) (dst_port) \ 1691 vlan (vlan_value) flexbytes (flexbytes_value) \ 1692 (drop|fwd) queue pf|vf(vf_id) (queue_id) \ 1693 fd_id (fd_id_value) 1694 1695 flow_director_filter (port_id) mode IP (add|del|update) \ 1696 flow (ipv4-sctp|ipv6-sctp) \ 1697 src (src_ip_address) (src_port) \ 1698 dst (dst_ip_address) (dst_port) 1699 tag (verification_tag) vlan (vlan_value) \ 1700 flexbytes (flexbytes_value) (drop|fwd) \ 1701 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value) 1702 1703 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \ 1704 ether (ethertype) flexbytes (flexbytes_value) \ 1705 (drop|fwd) pf|vf(vf_id) queue (queue_id) 1706 fd_id (fd_id_value) 1707 1708 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \ 1709 mac (mac_address) vlan (vlan_value) \ 1710 flexbytes (flexbytes_value) (drop|fwd) \ 1711 queue (queue_id) fd_id (fd_id_value) 1712 1713 flow_director_filter (port_id) mode Tunnel (add|del|update) \ 1714 mac (mac_address) vlan (vlan_value) \ 1715 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \ 1716 flexbytes (flexbytes_value) (drop|fwd) \ 1717 queue (queue_id) fd_id (fd_id_value) 1718 1719For example, to add an ipv4-udp flow type filter:: 1720 1721 testpmd> flow_director_filter 0 add flow ipv4-udp src 2.2.2.3 32 \ 1722 dst 2.2.2.5 33 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1 1723 1724For example, add an ipv4-other flow type filter:: 1725 1726 testpmd> flow_director_filter 0 add flow ipv4-other src 2.2.2.3 \ 1727 dst 2.2.2.5 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1 1728 1729flush_flow_director 1730~~~~~~~~~~~~~~~~~~~ 1731 1732Flush all flow director filters on a device:: 1733 1734 testpmd> flush_flow_director (port_id) 1735 1736Example, to flush all flow director filter on port 0:: 1737 1738 testpmd> flush_flow_director 0 1739 1740flow_director_mask 1741~~~~~~~~~~~~~~~~~~ 1742 1743Set flow director's input masks:: 1744 1745 flow_director_mask (port_id) mode IP vlan (vlan_value) \ 1746 src_mask (ipv4_src) (ipv6_src) (src_port) \ 1747 dst_mask (ipv4_dst) (ipv6_dst) (dst_port) 1748 1749 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) \ 1750 mac (mac_value) 1751 1752 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \ 1753 mac (mac_value) tunnel-type (tunnel_type_value) \ 1754 tunnel-id (tunnel_id_value) 1755 1756Example, to set flow director mask on port 0:: 1757 1758 testpmd> flow_director_mask 0 vlan 0xefff \ 1759 src_mask 255.255.255.255 \ 1760 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \ 1761 dst_mask 255.255.255.255 \ 1762 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF 1763 1764flow_director_flex_mask 1765~~~~~~~~~~~~~~~~~~~~~~~ 1766 1767set masks of flow director's flexible payload based on certain flow type:: 1768 1769 testpmd> flow_director_flex_mask (port_id) \ 1770 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 1771 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \ 1772 l2_payload|all) (mask) 1773 1774Example, to set flow director's flex mask for all flow type on port 0:: 1775 1776 testpmd> flow_director_flex_mask 0 flow all \ 1777 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0) 1778 1779 1780flow_director_flex_payload 1781~~~~~~~~~~~~~~~~~~~~~~~~~~ 1782 1783Configure flexible payload selection:: 1784 1785 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config) 1786 1787For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload:: 1788 1789 testpmd> flow_director_flex_payload 0 l4 \ 1790 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19) 1791 1792get_sym_hash_ena_per_port 1793~~~~~~~~~~~~~~~~~~~~~~~~~ 1794 1795Get symmetric hash enable configuration per port:: 1796 1797 get_sym_hash_ena_per_port (port_id) 1798 1799For example, to get symmetric hash enable configuration of port 1:: 1800 1801 testpmd> get_sym_hash_ena_per_port 1 1802 1803set_sym_hash_ena_per_port 1804~~~~~~~~~~~~~~~~~~~~~~~~~ 1805 1806Set symmetric hash enable configuration per port to enable or disable:: 1807 1808 set_sym_hash_ena_per_port (port_id) (enable|disable) 1809 1810For example, to set symmetric hash enable configuration of port 1 to enable:: 1811 1812 testpmd> set_sym_hash_ena_per_port 1 enable 1813 1814get_hash_global_config 1815~~~~~~~~~~~~~~~~~~~~~~ 1816 1817Get the global configurations of hash filters:: 1818 1819 get_hash_global_config (port_id) 1820 1821For example, to get the global configurations of hash filters of port 1:: 1822 1823 testpmd> get_hash_global_config 1 1824 1825set_hash_global_config 1826~~~~~~~~~~~~~~~~~~~~~~ 1827 1828Set the global configurations of hash filters:: 1829 1830 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \ 1831 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \ 1832 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) \ 1833 (enable|disable) 1834 1835For example, to enable simple_xor for flow type of ipv6 on port 2:: 1836 1837 testpmd> set_hash_global_config 2 simple_xor ipv6 enable 1838 1839set_hash_input_set 1840~~~~~~~~~~~~~~~~~~ 1841 1842Set the input set for hash:: 1843 1844 set_hash_input_set (port_id) (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 1845 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \ 1846 l2_payload) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \ 1847 ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \ 1848 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \ 1849 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \ 1850 fld-8th|none) (select|add) 1851 1852For example, to add source IP to hash input set for flow type of ipv4 on port 0:: 1853 1854 testpmd> set_hash_input_set 0 ipv4 src-ipv4 add 1855 1856set_fdir_input_set 1857~~~~~~~~~~~~~~~~~~ 1858 1859Set the input set for Fdir:: 1860 1861 set_fdir_input_set (port_id) (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \ 1862 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) 1863 (src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|udp-src-port|udp-dst-port| \ 1864 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \ 1865 fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th|fld-8th|none) \ 1866 (select|add) 1867 1868For example to add source IP to FD input set for flow type of ipv4 on port 0:: 1869 1870 testpmd> set_fdir_input_set 0 ipv4 src-ipv4 add 1871 1872global_config 1873~~~~~~~~~~~~~ 1874 1875Set different GRE key length for input set:: 1876 1877 global_config (port_id) gre-key-len (number in bytes) 1878 1879For example to set GRE key length for input set to 4 bytes on port 0:: 1880 1881 testpmd> global_config 0 gre-key-len 4 1882