Testpmd Application User Guide

• 1. Introduction
• 2. Compiling the Application
• 3. Running the Application
  • 3.1. EAL Command-line Options
  • 3.2. Testpmd Command-line Options
    • 3.2.1. Testpmd Multi-Process Command-line Options
• 4. Testpmd Runtime Functions
  • 4.1. Help Functions
  • 4.2. Command File Functions
  • 4.3. Control Functions
    • 4.3.1. start
    • 4.3.2. start tx_first
    • 4.3.3. stop
    • 4.3.4. quit
  • 4.4. Display Functions
    • 4.4.1. show port
    • 4.4.2. show port (module_eeprom|eeprom)
    • 4.4.3. show port rss reta
    • 4.4.4. show port rss-hash
    • 4.4.5. clear port
    • 4.4.6. show (rxq|txq)
    • 4.4.7. show desc status(rxq|txq)
    • 4.4.8. show rxq desc used count
    • 4.4.9. show config
    • 4.4.10. set fwd
    • 4.4.11. show fwd
    • 4.4.12. clear fwd
    • 4.4.13. read rxd
    • 4.4.14. read txd
    • 4.4.15. show vf stats
    • 4.4.16. clear vf stats
    • 4.4.17. show rx offloading capabilities
    • 4.4.18. show rx offloading configuration
    • 4.4.19. show tx offloading capabilities
    • 4.4.20. show tx offloading configuration
    • 4.4.21. show tx metadata setting
    • 4.4.22. show port supported ptypes
    • 4.4.23. set port supported ptypes
    • 4.4.24. show port mac addresses info
    • 4.4.25. show port multicast mac addresses info
    • 4.4.26. show flow transfer proxy port ID for the given port
    • 4.4.27. show device info
    • 4.4.28. dump physmem
    • 4.4.29. dump memzone
    • 4.4.30. dump socket memory
    • 4.4.31. dump struct size
    • 4.4.32. dump ring
    • 4.4.33. dump mempool
    • 4.4.34. dump devargs
    • 4.4.35. dump log types
    • 4.4.36. show (raw_encap|raw_decap)
    • 4.4.37. show fec capabilities
    • 4.4.38. show fec mode
  • 4.5. Configuration Functions
    • 4.5.1. set default
    • 4.5.2. set verbose
    • 4.5.3. set log
    • 4.5.4. set nbport
    • 4.5.5. set nbcore
    • 4.5.6. set coremask
    • 4.5.7. set portmask
    • 4.5.8. set record-core-cycles
    • 4.5.9. set record-burst-stats
    • 4.5.10. set burst
    • 4.5.11. set rxoffs
    • 4.5.12. set rxpkts
    • 4.5.13. set txpkts
    • 4.5.14. set txtimes
    • 4.5.15. set txsplit
    • 4.5.16. set corelist
    • 4.5.17. set portlist
    • 4.5.18. set port setup on
    • 4.5.19. set tx loopback
    • 4.5.20. set drop enable
    • 4.5.21. set split drop enable (for VF)
    • 4.5.22. set mac antispoof (for VF)
    • 4.5.23. set macsec offload
    • 4.5.24. set macsec sc
    • 4.5.25. set macsec sa
    • 4.5.26. vlan set stripq
    • 4.5.27. vlan set stripq (for VF)
    • 4.5.28. vlan set insert (for VF)
    • 4.5.29. vlan set antispoof (for VF)
    • 4.5.30. vlan set (strip|filter|qinq_strip|extend)
    • 4.5.31. vlan set tpid
    • 4.5.32. rx_vlan add
    • 4.5.33. rx_vlan rm
    • 4.5.34. rx_vlan add (for VF)
    • 4.5.35. rx_vlan rm (for VF)
    • 4.5.36. rx_vxlan_port add
    • 4.5.37. rx_vxlan_port remove
    • 4.5.38. tx_vlan set
    • 4.5.39. tx_vlan set pvid
    • 4.5.40. tx_vlan reset
    • 4.5.41. csum set
    • 4.5.42. csum parse-tunnel
    • 4.5.43. csum show
    • 4.5.44. tso set
    • 4.5.45. tso show
    • 4.5.46. tunnel tso set
    • 4.5.47. tunnel tso show
    • 4.5.48. set port - gro
    • 4.5.49. show port - gro
    • 4.5.50. set gro flush
    • 4.5.51. set port - gso
    • 4.5.52. set gso segsz
    • 4.5.53. show port - gso
    • 4.5.54. mac_addr add
    • 4.5.55. mac_addr remove
    • 4.5.56. mcast_addr add
    • 4.5.57. mcast_addr remove
    • 4.5.58. mac_addr add (for VF)
    • 4.5.59. mac_addr set
    • 4.5.60. mac_addr set (for VF)
    • 4.5.61. set eth-peer
    • 4.5.62. set port-uta
    • 4.5.63. set promisc
    • 4.5.64. set allmulti
    • 4.5.65. set tc tx min bandwidth
    • 4.5.66. set flow_ctrl rx
    • 4.5.67. show flow control
    • 4.5.68. set pfc_ctrl rx
    • 4.5.69. set pfc_queue_ctrl
    • 4.5.70. Set Rx queue available descriptors threshold
    • 4.5.71. set stat_qmap
    • 4.5.72. set xstats-hide-zero
    • 4.5.73. set port - rx/tx (for VF)
    • 4.5.74. set port - rx mode(for VF)
    • 4.5.75. set port - tx_rate (for Queue)
    • 4.5.76. set port - tx_rate (for VF)
    • 4.5.77. set flush_rx
    • 4.5.78. set bypass mode
    • 4.5.79. set bypass event
    • 4.5.80. set bypass timeout
    • 4.5.81. show bypass config
    • 4.5.82. set link up
    • 4.5.83. set link down
    • 4.5.84. E-tag set
    • 4.5.85. config per port Rx offloading
    • 4.5.86. config per queue Rx offloading
    • 4.5.87. config per port Tx offloading
    • 4.5.88. config per queue Tx offloading
    • 4.5.89. Config VXLAN Encap outer layers
    • 4.5.90. Config NVGRE Encap outer layers
    • 4.5.91. Config L2 Encap
    • 4.5.92. Config L2 Decap
    • 4.5.93. Config MPLSoGRE Encap outer layers
    • 4.5.94. Config MPLSoGRE Decap outer layers
    • 4.5.95. Config MPLSoUDP Encap outer layers
    • 4.5.96. Config MPLSoUDP Decap outer layers
    • 4.5.97. Config Raw Encapsulation
    • 4.5.98. Config Raw Decapsulation
    • 4.5.99. Set fec mode
    • 4.5.100. Config Sample actions list
  • 4.6. Port Functions
    • 4.6.1. port attach
    • 4.6.2. port detach
    • 4.6.3. port start
    • 4.6.4. port stop
    • 4.6.5. port close
    • 4.6.6. port reset
    • 4.6.7. port config - queue ring size
    • 4.6.8. port start/stop queue
    • 4.6.9. port config - queue deferred start
    • 4.6.10. port setup queue
    • 4.6.11. port config - speed
    • 4.6.12. port config - queues/descriptors
    • 4.6.13. port config - max-pkt-len
    • 4.6.14. port config - max-lro-pkt-size
    • 4.6.15. port config - Drop Packets
    • 4.6.16. port config - RSS
    • 4.6.17. port config - RSS Reta
    • 4.6.18. port config - DCB
    • 4.6.19. port config - Burst
    • 4.6.20. port config - Threshold
    • 4.6.21. port config pctype mapping
    • 4.6.22. port config input set
    • 4.6.23. port config udp_tunnel_port
    • 4.6.24. port config tx_metadata
    • 4.6.25. port config dynf
    • 4.6.26. port config mtu
    • 4.6.27. port config rss hash key
    • 4.6.28. port cleanup txq mbufs
  • 4.7. Device Functions
    • 4.7.1. device detach
  • 4.8. Link Bonding Functions
  • 4.9. Register Functions
    • 4.9.1. read reg
    • 4.9.2. read regfield
    • 4.9.3. read regbit
    • 4.9.4. write reg
    • 4.9.5. write regfield
    • 4.9.6. write regbit
  • 4.10. Traffic Metering and Policing
    • 4.10.1. show port traffic management capability
    • 4.10.2. add port meter profile (srTCM rfc2967)
    • 4.10.3. add port meter profile (trTCM rfc2968)
    • 4.10.4. add port meter profile (trTCM rfc4115)
    • 4.10.5. delete port meter profile
    • 4.10.6. create port policy
    • 4.10.7. delete port policy
    • 4.10.8. create port meter
    • 4.10.9. enable port meter
    • 4.10.10. disable port meter
    • 4.10.11. delete port meter
    • 4.10.12. Set port meter profile
    • 4.10.13. set port meter dscp table
    • 4.10.14. set port meter vlan table
    • 4.10.15. set port meter protocol
    • 4.10.16. get port meter protocol
    • 4.10.17. get port meter protocol priority
    • 4.10.18. set port meter stats mask
    • 4.10.19. show port meter stats
  • 4.11. Traffic Management
    • 4.11.1. show port traffic management capability
    • 4.11.2. show port traffic management capability (hierarchy level)
    • 4.11.3. show port traffic management capability (hierarchy node level)
    • 4.11.4. show port traffic management hierarchy node type
    • 4.11.5. show port traffic management hierarchy node stats
    • 4.11.6. Add port traffic management private shaper profile
    • 4.11.7. Delete port traffic management private shaper profile
    • 4.11.8. Add port traffic management shared shaper
    • 4.11.9. Set port traffic management shared shaper
    • 4.11.10. Delete port traffic management shared shaper
    • 4.11.11. Set port traffic management hierarchy node private shaper
    • 4.11.12. Add port traffic management WRED profile
    • 4.11.13. Delete port traffic management WRED profile
    • 4.11.14. Add port traffic management hierarchy nonleaf node
    • 4.11.15. Add port traffic management hierarchy nonleaf node with packet mode
    • 4.11.16. Add port traffic management hierarchy leaf node
    • 4.11.17. Delete port traffic management hierarchy node
    • 4.11.18. Update port traffic management hierarchy parent node
    • 4.11.19. Suspend port traffic management hierarchy node
    • 4.11.20. Resume port traffic management hierarchy node
    • 4.11.21. Commit port traffic management hierarchy
    • 4.11.22. Set port traffic management mark VLAN dei
    • 4.11.23. Set port traffic management mark IP dscp
    • 4.11.24. Set port traffic management mark IP ecn
  • 4.12. Filter Functions
    • 4.12.1. flow_director_mask
    • 4.12.2. flow_director_flex_payload
  • 4.13. Flow rules management
    • 4.13.1. flow syntax
    • 4.13.2. Retrieving info about flow management engine
    • 4.13.3. Configuring flow management engine
    • 4.13.4. Creating pattern templates
    • 4.13.5. Destroying pattern templates
    • 4.13.6. Creating actions templates
    • 4.13.7. Destroying actions templates
    • 4.13.8. Creating template table
    • 4.13.9. Destroying flow table
    • 4.13.10. Pushing enqueued operations
    • 4.13.11. Pulling flow operations results
    • 4.13.12. Creating a tunnel stub for offload
    • 4.13.13. Destroying tunnel offload stub
    • 4.13.14. Listing tunnel offload stubs
    • 4.13.15. Validating flow rules
    • 4.13.16. Creating flow rules
    • 4.13.17. Enqueueing creation of flow rules
    • 4.13.18. Destroying flow rules
    • 4.13.19. Enqueueing destruction of flow rules
    • 4.13.20. Querying flow rules
    • 4.13.21. Listing flow rules
    • 4.13.22. Toggling isolated mode
    • 4.13.23. Dumping HW internal information
    • 4.13.24. Listing and destroying aged flow rules
    • 4.13.25. Creating indirect actions
    • 4.13.26. Enqueueing creation of indirect actions
    • 4.13.27. Updating indirect actions
    • 4.13.28. Enqueueing update of indirect actions
    • 4.13.29. Destroying indirect actions
    • 4.13.30. Enqueueing destruction of indirect actions
    • 4.13.31. Query indirect actions
    • 4.13.32. Sample QinQ flow rules
    • 4.13.33. Sample VXLAN flow rules
    • 4.13.34. Sample VXLAN encapsulation rule
    • 4.13.35. Sample NVGRE encapsulation rule
    • 4.13.36. Sample L2 encapsulation rule
    • 4.13.37. Sample L2 decapsulation rule
    • 4.13.38. Sample MPLSoGRE encapsulation rule
    • 4.13.39. Sample MPLSoGRE decapsulation rule
    • 4.13.40. Sample MPLSoUDP encapsulation rule
    • 4.13.41. Sample MPLSoUDP decapsulation rule
    • 4.13.42. Sample Raw encapsulation rule
    • 4.13.43. Sample Raw decapsulation rule
    • 4.13.44. Sample ESP rules
    • 4.13.45. Sample AH rules
    • 4.13.46. Sample PFCP rules
    • 4.13.47. Sample Sampling/Mirroring rules
    • 4.13.48. Sample integrity rules
    • 4.13.49. Sample conntrack rules
    • 4.13.50. Sample meter with policy rules
    • 4.13.51. Sample L2TPv2 RSS rules
    • 4.13.52. Sample L2TPv2 FDIR rules
    • 4.13.53. Sample RAW rule
  • 4.14. BPF Functions
    • 4.14.1. bpf-load
    • 4.14.2. bpf-unload
  • 4.15. Flex Item Functions
    • 4.15.1. Create flex item
    • 4.15.2. Flex pattern and flow rules
  • 4.16. Driver specific commands