Data Plane Development Kit Logo
25.11.0-rc1
  • Test Suites
    • blocklist Test Suite
      • TestBlocklist
        • no_blocklisted()
        • one_port_blocklisted()
        • all_but_one_port_blocklisted()
    • checksum_offload Test Suite
      • TestChecksumOffload
        • insert_checksums()
        • no_insert_checksums()
        • l4_rx_checksum()
        • l3_rx_checksum()
        • validate_rx_checksum()
        • vlan_checksum()
        • validate_sctp_checksum()
        • required_capabilities
    • dual_vlan Test Suite
      • TestDualVlan
        • TestCaseOptions
          • VLAN_STRIP
          • VLAN_FILTER_INNER
          • VLAN_FILTER_OUTER
        • inner_vlan_tag
        • outer_vlan_tag
        • vlan_insert_tag
        • rx_port
        • tx_port
        • insert_second_vlan()
        • all_vlan_functions()
        • maintains_priority()
    • dynamic_config Test Suite
      • TestDynamicConfig
        • default_mode()
        • disable_promisc()
        • disable_promisc_broadcast()
        • disable_promisc_multicast()
        • required_capabilities
    • dynamic_queue_conf Test Suite
      • setup_and_teardown_test()
      • TestDynamicQueueConf
        • num_ports_to_modify
        • src_addr
        • dst_address_subnet
        • rx_port_num
        • tx_port_num
        • number_of_queues
        • number_of_packets_to_send
        • rx_queue_stop()
        • rx_queue_configuration()
        • tx_queue_stop()
        • tx_queue_configuration()
        • required_capabilities
    • hello_world Test Suite
      • Config
        • msg
      • TestHelloWorld
        • hello_world()
    • l2fwd Test Suite
      • TestL2fwd
        • NUMBER_OF_PACKETS_TO_SEND
        • PAYLOAD_SIZE
        • set_up_suite()
        • l2fwd_integrity()
        • required_capabilities
    • mac_filter Test Suite
      • TestMacFilter
        • add_remove_mac_addresses()
        • invalid_address()
        • multicast_filter()
        • required_capabilities
    • mtu Test Suite
      • TestMtu
        • set_up_suite()
        • runtime_mtu_updating_and_forwarding()
        • cli_mtu_forwarding_for_std_packets()
        • cli_jumbo_forwarding_for_jumbo_mtu()
        • cli_mtu_std_packets_for_jumbo_mtu()
        • tear_down_suite()
        • required_capabilities
    • packet_capture Test Suite
      • DumpcapParams
        • lcore_list
        • file_prefix
        • interface
        • output_pcap_path
        • packet_filter
        • __init__()
      • TestPacketCapture
        • packets
        • rx_pcap
        • tx_pcap
        • set_up_suite()
        • set_up_test_case()
        • dumpcap()
        • dumpcap_filter()
    • pmd_buffer_scatter Test Suite
      • TestPmdBufferScatter
        • set_up_suite()
        • scatter_mbuf_2048()
        • scatter_mbuf_2048_with_offload()
        • tear_down_suite()
        • required_capabilities
    • port_control Test Suite
      • TestPortControl
        • start_ports()
        • stop_ports()
        • close_ports()
        • required_capabilities
    • port_restart_config_persistency Test Suite
      • TestPortRestartConfigPersistency
        • port_configuration_persistence()
        • flow_ctrl_port_configuration_persistence()
    • port_stats Test Suite
      • TestPortStats
        • recv_port
        • send_port
        • ip_header_len
        • ether_header_len
        • total_packet_len
        • stats_updates()
        • required_capabilities
    • promisc_support Test Suite
      • TestPromiscSupport
        • ALTERNATIVE_MAC_ADDRESS
        • promisc_packets()
        • required_capabilities
    • queue_start_stop Test Suite
      • TestQueueStartStop
        • rx_queue_start_stop()
        • tx_queue_start_stop()
        • rx_queue_deferred_start()
        • tx_queue_deferred_start()
        • required_capabilities
    • rte_flow Test Suite
      • TestRteFlow
        • queue_action_ETH()
        • queue_action_IP()
        • queue_action_L4()
        • queue_action_VLAN()
        • drop_action_ETH()
        • drop_action_IP()
        • drop_action_L4()
        • drop_action_VLAN()
        • modify_actions()
        • egress_rules()
        • jump_action()
        • priority_attribute()
        • required_capabilities
    • smoke_tests Test Suite
      • TestSmokeTests
        • nics_in_node
        • is_blocking
        • set_up_suite()
        • unit_tests()
        • driver_tests()
        • devices_listed_in_testpmd()
        • device_bound_to_driver()
        • required_capabilities
        • topology_type
    • softnic Test Suite
      • TestSoftnic
        • NUMBER_OF_PACKETS_TO_SEND
        • PAYLOAD_SIZE
        • set_up_suite()
        • softnic()
        • required_capabilities
    • uni_pkt Test Suite
      • TestUniPkt
        • l2_packet_detect()
        • l3_l4_packet_detect()
        • ipv6_l4_packet_detect()
        • l3_tunnel_packet_detect()
        • gre_tunnel_packet_detect()
        • nsh_packet_detect()
        • vxlan_tunnel_packet_detect()
    • vlan Test Suite
      • TestVlan
        • vlan_receipt_no_stripping()
        • vlan_receipt_stripping()
        • vlan_no_receipt()
        • vlan_header_insertion()
        • required_capabilities
  • api - DTS API
    • testpmd - Testpmd Interactive Remote Shell
      • TestPmd
        • ports_started
        • __init__()
        • path
        • ports
        • start()
        • stop()
        • get_devices()
        • wait_link_status_up()
        • set_forward_mode()
        • stop_all_ports()
        • start_all_ports()
        • set_ports_queues()
        • close_all_ports()
        • show_port_info_all()
        • show_port_info()
        • set_mac_addr()
        • set_multicast_mac_addr()
        • show_port_stats_all()
        • show_port_stats()
        • set_multicast_all()
        • csum_set_hw()
        • flow_create()
        • flow_validate()
        • flow_delete()
        • set_port_mtu()
        • set_port_mtu_all()
        • extract_verbose_output()
        • set_vlan_filter()
        • set_mac_address()
        • set_flow_control()
        • show_port_flow_info()
        • rx_vlan()
        • set_vlan_strip()
        • tx_vlan_set()
        • set_promisc()
        • set_verbose()
        • rx_vxlan()
        • clear_port_stats()
        • clear_port_stats_all()
        • get_capabilities_rx_offload()
        • get_port_queue_info()
        • setup_port_queue()
        • stop_port_queue()
        • start_port_queue()
        • get_queue_ring_size()
        • set_queue_ring_size()
        • set_queue_deferred_start()
        • get_capabilities_rxq_info()
        • get_capabilities_show_port_info()
        • get_capabilities_mcast_filtering()
        • get_capabilities_flow_ctrl()
        • get_capabilities_physical_function()
      • types - Testpmd types
        • TestPmdDevice
          • pci_address
          • __init__()
        • VLANOffloadFlag
          • STRIP
          • FILTER
          • EXTEND
          • QINQ_STRIP
          • from_str_dict()
          • make_parser()
        • ChecksumOffloadOptions
          • ip
          • udp
          • tcp
          • sctp
          • outer_ip
          • outer_udp
        • RSSOffloadTypesFlag
          • 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
          • port
          • vxlan
          • geneve
          • nvgre
          • user_defined_22
          • gtpu
          • eth
          • s_vlan
          • c_vlan
          • esp
          • ah
          • l2tpv3
          • pfcp
          • pppoe
          • ecpri
          • mpls
          • ipv4_chksum
          • l4_chksum
          • l2tpv2
          • ipv6_flow_label
          • user_defined_38
          • user_defined_39
          • user_defined_40
          • user_defined_41
          • user_defined_42
          • user_defined_43
          • user_defined_44
          • user_defined_45
          • user_defined_46
          • user_defined_47
          • user_defined_48
          • user_defined_49
          • user_defined_50
          • user_defined_51
          • l3_pre96
          • l3_pre64
          • l3_pre56
          • l3_pre48
          • l3_pre40
          • l3_pre32
          • l2_dst_only
          • l2_src_only
          • l4_dst_only
          • l4_src_only
          • l3_dst_only
          • l3_src_only
          • ip
          • udp
          • tcp
          • sctp
          • tunnel
          • vlan
          • all
          • from_list_string()
          • from_str()
          • make_parser()
        • DeviceCapabilitiesFlag
          • RUNTIME_RX_QUEUE_SETUP
          • RUNTIME_TX_QUEUE_SETUP
          • RXQ_SHARE
          • FLOW_RULE_KEEP
          • FLOW_SHARED_OBJECT_KEEP
          • make_parser()
        • DeviceErrorHandlingMode
          • none
          • passive
          • proactive
          • unknown
          • make_parser()
        • RxQueueState
          • stopped
          • started
          • hairpin
          • unknown
          • make_parser()
        • TestPmdQueueInfo
          • prefetch_threshold
          • host_threshold
          • writeback_threshold
          • free_threshold
          • deferred_start
          • ring_size
          • is_queue_started
          • burst_mode
          • __init__()
        • TestPmdTxqInfo
          • rs_threshold
          • __init__()
        • TestPmdRxqInfo
          • mempool
          • drop_packets
          • scattered_packets
          • queue_state
          • __init__()
        • TestPmdPort
          • id
          • device_name
          • driver_name
          • socket_id
          • is_link_up
          • link_speed
          • is_link_full_duplex
          • is_link_autonegotiated
          • is_promiscuous_mode_enabled
          • is_allmulticast_mode_enabled
          • max_mac_addresses_num
          • max_hash_mac_addresses_num
          • min_rx_bufsize
          • max_rx_packet_length
          • max_lro_packet_size
          • rx_queues_num
          • max_rx_queues_num
          • max_queue_rxd_num
          • min_queue_rxd_num
          • rxd_alignment_num
          • tx_queues_num
          • max_tx_queues_num
          • max_queue_txd_num
          • min_queue_txd_num
          • txd_alignment_num
          • max_packet_segment_num
          • max_mtu_segment_num
          • device_capabilities
          • device_error_handling_mode
          • device_private_info
          • hash_key_size
          • redirection_table_size
          • supported_rss_offload_flow_types
          • mac_address
          • fw_version
          • dev_args
          • mem_alloc_socket_id
          • mtu
          • vlan_offload
          • max_rx_bufsize
          • max_vfs_num
          • max_vmdq_pools_num
          • switch_name
          • switch_domain_id
          • switch_port_id
          • switch_rx_domain
          • __init__()
        • TestPmdPortStats
          • port_id
          • rx_packets
          • rx_missed
          • rx_bytes
          • rx_errors
          • rx_nombuf
          • tx_packets
          • tx_errors
          • tx_bytes
          • rx_pps
          • rx_bps
          • tx_pps
          • tx_bps
          • __init__()
        • FlowRule
          • group_id
          • priority_level
          • direction
          • user_id
          • pattern
          • actions
          • __init__()
        • PacketOffloadFlag
          • RTE_MBUF_F_RX_VLAN
          • RTE_MBUF_F_RX_RSS_HASH
          • RTE_MBUF_F_RX_FDIR
          • RTE_MBUF_F_RX_OUTER_IP_CKSUM_BAD
          • RTE_MBUF_F_RX_VLAN_STRIPPED
          • RTE_MBUF_F_RX_IP_CKSUM_UNKNOWN
          • RTE_MBUF_F_RX_IP_CKSUM_BAD
          • RTE_MBUF_F_RX_IP_CKSUM_GOOD
          • RTE_MBUF_F_RX_IP_CKSUM_NONE
          • RTE_MBUF_F_RX_L4_CKSUM_UNKNOWN
          • RTE_MBUF_F_RX_L4_CKSUM_BAD
          • RTE_MBUF_F_RX_L4_CKSUM_GOOD
          • RTE_MBUF_F_RX_L4_CKSUM_NONE
          • RTE_MBUF_F_RX_IEEE1588_PTP
          • RTE_MBUF_F_RX_IEEE1588_TMST
          • RTE_MBUF_F_RX_FDIR_ID
          • RTE_MBUF_F_RX_FDIR_FLX
          • RTE_MBUF_F_RX_QINQ_STRIPPED
          • RTE_MBUF_F_RX_LRO
          • RTE_MBUF_F_RX_SEC_OFFLOAD
          • RTE_MBUF_F_RX_SEC_OFFLOAD_FAILED
          • RTE_MBUF_F_RX_QINQ
          • RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN
          • RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD
          • RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD
          • RTE_MBUF_F_RX_OUTER_L4_CKSUM_INVALID
          • RTE_MBUF_F_TX_OUTER_UDP_CKSUM
          • RTE_MBUF_F_TX_UDP_SEG
          • RTE_MBUF_F_TX_SEC_OFFLOAD
          • RTE_MBUF_F_TX_MACSEC
          • RTE_MBUF_F_TX_TUNNEL_VXLAN
          • RTE_MBUF_F_TX_TUNNEL_GRE
          • RTE_MBUF_F_TX_TUNNEL_IPIP
          • RTE_MBUF_F_TX_TUNNEL_GENEVE
          • RTE_MBUF_F_TX_TUNNEL_MPLSINUDP
          • RTE_MBUF_F_TX_TUNNEL_VXLAN_GPE
          • RTE_MBUF_F_TX_TUNNEL_GTP
          • RTE_MBUF_F_TX_TUNNEL_ESP
          • RTE_MBUF_F_TX_TUNNEL_IP
          • RTE_MBUF_F_TX_TUNNEL_UDP
          • RTE_MBUF_F_TX_QINQ
          • RTE_MBUF_F_TX_TCP_SEG
          • RTE_MBUF_F_TX_IEEE1588_TMST
          • RTE_MBUF_F_TX_L4_NO_CKSUM
          • RTE_MBUF_F_TX_TCP_CKSUM
          • RTE_MBUF_F_TX_SCTP_CKSUM
          • RTE_MBUF_F_TX_UDP_CKSUM
          • RTE_MBUF_F_TX_IP_CKSUM
          • RTE_MBUF_F_TX_IPV4
          • RTE_MBUF_F_TX_IPV6
          • RTE_MBUF_F_TX_VLAN
          • RTE_MBUF_F_TX_OUTER_IP_CKSUM
          • RTE_MBUF_F_TX_OUTER_IPV4
          • RTE_MBUF_F_TX_OUTER_IPV6
          • from_list_string()
          • from_str()
          • make_parser()
        • RtePTypes
          • L2_ETHER
          • L2_ETHER_TIMESYNC
          • L2_ETHER_ARP
          • L2_ETHER_LLDP
          • L2_ETHER_NSH
          • L2_ETHER_VLAN
          • L2_ETHER_QINQ
          • L2_ETHER_PPPOE
          • L2_ETHER_FCOE
          • L2_ETHER_MPLS
          • L2_UNKNOWN
          • L3_IPV4
          • L3_IPV4_EXT
          • L3_IPV6
          • L3_IPV4_EXT_UNKNOWN
          • L3_IPV6_EXT
          • L3_IPV6_EXT_UNKNOWN
          • L3_UNKNOWN
          • L4_TCP
          • L4_UDP
          • L4_FRAG
          • L4_SCTP
          • L4_ICMP
          • L4_NONFRAG
          • L4_IGMP
          • L4_UNKNOWN
          • TUNNEL_IP
          • TUNNEL_GRE
          • TUNNEL_VXLAN
          • TUNNEL_NVGRE
          • TUNNEL_GENEVE
          • TUNNEL_GRENAT
          • TUNNEL_GTPC
          • TUNNEL_GTPU
          • TUNNEL_ESP
          • TUNNEL_L2TP
          • TUNNEL_VXLAN_GPE
          • TUNNEL_MPLS_IN_UDP
          • TUNNEL_MPLS_IN_GRE
          • TUNNEL_UNKNOWN
          • INNER_L2_ETHER
          • INNER_L2_ETHER_VLAN
          • INNER_L2_ETHER_QINQ
          • INNER_L2_UNKNOWN
          • INNER_L3_IPV4
          • INNER_L3_IPV4_EXT
          • INNER_L3_IPV6
          • INNER_L3_IPV4_EXT_UNKNOWN
          • INNER_L3_IPV6_EXT
          • INNER_L3_IPV6_EXT_UNKNOWN
          • INNER_L3_UNKNOWN
          • INNER_L4_TCP
          • INNER_L4_UDP
          • INNER_L4_FRAG
          • INNER_L4_SCTP
          • INNER_L4_ICMP
          • INNER_L4_NONFRAG
          • INNER_L4_UNKNOWN
          • from_list_string()
          • from_str()
          • make_parser()
        • TestPmdVerbosePacket
          • port_id
          • queue_id
          • was_received
          • src_mac
          • dst_mac
          • pool
          • p_type
          • length
          • nb_segs
          • hw_ptype
          • sw_ptype
          • l2_len
          • ol_flags
          • rss_hash
          • rss_queue
          • l3_len
          • l4_len
          • l4_dport
          • __init__()
        • RxOffloadCapability
          • RX_OFFLOAD_VLAN_STRIP
          • RX_OFFLOAD_IPV4_CKSUM
          • RX_OFFLOAD_UDP_CKSUM
          • RX_OFFLOAD_TCP_CKSUM
          • RX_OFFLOAD_TCP_LRO
          • RX_OFFLOAD_QINQ_STRIP
          • RX_OFFLOAD_OUTER_IPV4_CKSUM
          • RX_OFFLOAD_MACSEC_STRIP
          • RX_OFFLOAD_VLAN_FILTER
          • RX_OFFLOAD_VLAN_EXTEND
          • RX_OFFLOAD_SCATTER
          • RX_OFFLOAD_TIMESTAMP
          • RX_OFFLOAD_SECURITY
          • RX_OFFLOAD_KEEP_CRC
          • RX_OFFLOAD_SCTP_CKSUM
          • RX_OFFLOAD_OUTER_UDP_CKSUM
          • RX_OFFLOAD_RSS_HASH
          • RX_OFFLOAD_BUFFER_SPLIT
          • RX_OFFLOAD_CHECKSUM
          • RX_OFFLOAD_VLAN
          • from_string()
          • make_parser()
        • RxOffloadCapabilities
          • port_id
          • per_queue
          • per_port
          • __init__()
        • TestPmdPortFlowCtrl
          • rx
          • tx
          • high_water
          • low_water
          • pause_time
          • send_xon
          • mac_ctrl_frame_fwd
          • autoneg
          • __init__()
      • config - Testpmd configuration
        • PortTopology
          • paired
          • chained
          • loop
        • PortNUMAConfig
          • port
          • socket
          • __new__()
        • FlowDirection
          • RX
          • TX
        • RingNUMAConfig
          • port
          • direction
          • socket
          • __new__()
        • EthPeer
          • port_no
          • mac_address
          • __new__()
        • TxIPAddrPair
          • source_ip
          • dest_ip
          • __new__()
        • TxUDPPortPair
          • source_port
          • dest_port
          • __new__()
        • DisableRSS
          • __init__()
        • SetRSSIPOnly
          • __init__()
        • SetRSSUDP
          • __init__()
        • RSSSetting
          • Disabled
          • SetIPOnly
          • SetUDP
        • SimpleForwardingModes
          • io
          • mac
          • macswap
          • rxonly
          • csum
          • icmpecho
          • ieee1588
          • fivetswap
          • shared_rxq
          • recycle_mbufs
        • TXOnlyForwardingMode
          • multi_flow
          • segments_length
          • __init__()
        • FlowGenForwardingMode
          • clones
          • flows
          • segments_length
          • __init__()
        • NoisyForwardingMode
          • forward_mode
          • tx_sw_buffer_size
          • tx_sw_buffer_flushtime
          • lkup_memory
          • lkup_num_reads
          • lkup_num_writes
          • lkup_num_reads_writes
          • __init__()
        • HairpinMode
          • TWO_PORTS_LOOP
          • TWO_PORTS_PAIRED
          • EXPLICIT_TX_FLOW
          • FORCE_RX_QUEUE_MEM_SETTINGS
          • FORCE_TX_QUEUE_MEM_SETTINGS
          • RX_QUEUE_USE_LOCKED_DEVICE_MEMORY
          • RX_QUEUE_USE_RTE_MEMORY
          • TX_QUEUE_USE_LOCKED_DEVICE_MEMORY
          • TX_QUEUE_USE_RTE_MEMORY
        • RXRingParams
          • descriptors
          • prefetch_threshold
          • host_threshold
          • write_back_threshold
          • free_threshold
          • __init__()
        • RXMultiQueueMode
          • RSS
          • DCB
          • VMDQ
        • TXRingParams
          • descriptors
          • rs_bit_threshold
          • prefetch_threshold
          • host_threshold
          • write_back_threshold
          • free_threshold
          • __init__()
        • Event
          • unknown
          • queue_state
          • vf_mbox
          • macsec
          • intr_lsc
          • intr_rmv
          • intr_reset
          • dev_probed
          • dev_released
          • flow_aged
          • err_recovering
          • recovery_success
          • recovery_failed
          • all
        • SimpleMempoolAllocationMode
          • native
          • xmem
          • xmemhuge
        • AnonMempoolAllocationMode
          • no_iova_contig
          • __init__()
        • TestPmdParams
          • interactive_mode
          • auto_start
          • tx_first
          • stats_period
          • display_xstats
          • nb_cores
          • coremask
          • nb_ports
          • port_topology
          • portmask
          • portlist
          • numa
          • socket_num
          • port_numa_config
          • ring_numa_config
          • total_num_mbufs
          • mbuf_size
          • mbcache
          • max_pkt_len
          • eth_peers_configfile
          • eth_peer
          • tx_ip
          • tx_udp
          • enable_lro
          • max_lro_pkt_size
          • disable_crc_strip
          • enable_scatter
          • enable_hw_vlan
          • enable_hw_vlan_filter
          • enable_hw_vlan_strip
          • enable_hw_vlan_extend
          • enable_hw_qinq_strip
          • pkt_drop_enabled
          • rss
          • forward_mode
          • hairpin_mode
          • hairpin_queues
          • burst
          • enable_rx_cksum
          • rx_queues
          • rx_ring
          • no_flush_rx
          • rx_segments_offsets
          • rx_segments_length
          • multi_rx_mempool
          • rx_shared_queue
          • rx_offloads
          • rx_mq_mode
          • tx_queues
          • tx_ring
          • tx_offloads
          • eth_link_speed
          • disable_link_check
          • disable_device_start
          • no_lsc_interrupt
          • no_rmv_interrupt
          • bitrate_stats
          • latencystats
          • print_events
          • mask_events
          • flow_isolate_all
          • disable_flow_flush
          • hot_plug
          • vxlan_gpe_port
          • geneve_parsed_port
          • lock_all_memory
          • mempool_allocation_mode
          • record_core_cycles
          • record_burst_status
          • __init__()
    • capabilities - SUT Capabilities
      • LinkTopology
        • NO_LINK
        • ONE_LINK
        • TWO_LINKS
        • default()
        • __new__()
      • NicCapability
        • SCATTERED_RX_ENABLED
        • RX_OFFLOAD_VLAN_STRIP
        • RX_OFFLOAD_IPV4_CKSUM
        • RX_OFFLOAD_UDP_CKSUM
        • RX_OFFLOAD_TCP_CKSUM
        • RX_OFFLOAD_TCP_LRO
        • RX_OFFLOAD_QINQ_STRIP
        • RX_OFFLOAD_OUTER_IPV4_CKSUM
        • RX_OFFLOAD_MACSEC_STRIP
        • RX_OFFLOAD_VLAN_FILTER
        • RX_OFFLOAD_VLAN_EXTEND
        • RX_OFFLOAD_SCATTER
        • RX_OFFLOAD_TIMESTAMP
        • RX_OFFLOAD_SECURITY
        • RX_OFFLOAD_KEEP_CRC
        • RX_OFFLOAD_SCTP_CKSUM
        • RX_OFFLOAD_OUTER_UDP_CKSUM
        • RX_OFFLOAD_RSS_HASH
        • RX_OFFLOAD_BUFFER_SPLIT
        • RX_OFFLOAD_CHECKSUM
        • RX_OFFLOAD_VLAN
        • RUNTIME_RX_QUEUE_SETUP
        • RUNTIME_TX_QUEUE_SETUP
        • RXQ_SHARE
        • FLOW_RULE_KEEP
        • FLOW_SHARED_OBJECT_KEEP
        • MCAST_FILTERING
        • FLOW_CTRL
        • PHYSICAL_FUNCTION
        • __new__()
      • requires_link_topology()
      • requires_nic_capability()
    • packet - Sending and capturing packets
      • send_packet_and_capture()
      • send_packets_and_capture()
      • send_packets()
      • get_expected_packets()
      • get_expected_packet()
      • adjust_addresses()
      • match_all_packets()
      • verify_packets()
    • test - Reporting results and logging
      • get_current_test_case_name()
      • log()
      • log_debug()
      • verify()
      • verify_else_skip()
      • skip()
      • fail()
      • get_logger()
  • testbed_model - Testbed Modelling Package
    • traffic_generator Subpackage
      • create_traffic_generator()
      • traffic_generator - Base TG ABC
        • TrafficGenerator
          • __init__()
          • setup()
          • teardown()
          • send_packet()
          • send_packets()
          • is_capturing
          • close()
      • capturing_traffic_generator - Base Capturing TG ABC
        • PacketFilteringConfig
          • no_lldp
          • no_arp
          • no_icmp
          • __init__()
        • CapturingTrafficGenerator
          • is_capturing
          • send_packets_and_capture()
      • scapy - Capturing Traffic Generator
        • ScapyAsyncSniffer
          • __init__()
          • start_capturing()
          • collect()
          • stop_capturing()
          • stop_capturing_and_collect()
          • start_application()
          • close()
        • ScapyTrafficGenerator
          • __init__()
          • setup()
          • close()
    • artifact - File Management
      • TextMode
      • BinaryMode
      • OpenMode
      • make_file_path()
      • make_unique_file_name()
      • Artifact
        • save_local_copy
        • DIRECTORY_PERMISSIONS
        • TEXT_MODE_ENCODING
        • TEXT_MODE_NEWLINE
        • __init__()
        • open()
        • create_from()
        • copy_contents_from()
        • path
        • local_path
        • save_locally()
        • delete()
        • touch()
        • chmod()
        • exists()
        • mkdir()
      • ArtifactFile
        • __init__()
        • close()
        • read()
        • readline()
        • readlines()
        • write()
        • writelines()
        • flush()
        • seek()
        • tell()
        • truncate()
        • name
        • mode
        • closed
        • fileno()
        • isatty()
        • readable()
        • writable()
        • seekable()
    • os_session - OS-aware Remote Session ABC
      • FilePermissions
        • OTHERS_EXECUTE
        • OTHERS_WRITE
        • OTHERS_READ
        • GROUP_EXECUTE
        • GROUP_WRITE
        • GROUP_READ
        • OWNER_EXECUTE
        • OWNER_WRITE
        • OWNER_READ
        • to_octal()
      • OSSessionInfo
        • os_name
        • os_version
        • kernel_version
        • __init__()
      • OSSession
        • name
        • remote_session
        • interactive_session
        • __init__()
        • is_alive()
        • send_command()
        • close()
        • get_remote_tmp_dir()
        • get_dpdk_build_env_vars()
        • join_remote_path()
        • remote_path_exists()
        • create_tmp_dir()
        • copy_from()
        • copy_to()
        • copy_dir_from()
        • copy_dir_to()
        • change_permissions()
        • remove_remote_file()
        • remove_remote_dir()
        • create_remote_tarball()
        • create_directory()
        • extract_remote_tarball()
        • is_remote_dir()
        • is_remote_tarfile()
        • get_tarball_top_dir()
        • build_dpdk()
        • get_dpdk_version()
        • get_remote_cpus()
        • kill_cleanup_dpdk_apps()
        • get_dpdk_file_prefix()
        • setup_hugepages()
        • get_compiler_version()
        • get_node_info()
        • get_arch_info()
        • get_port_info()
        • bind_ports_to_driver()
        • bring_up_link()
        • configure_port_mtu()
        • create_vfs()
        • delete_vfs()
        • get_pci_addr_of_vfs()
    • linux_session - Linux Remote Session
      • LshwConfigurationOutput
        • driver
        • link
      • LshwOutput
        • businfo
        • logicalname
        • serial
        • configuration
      • LinuxSession
        • get_remote_cpus()
        • get_dpdk_file_prefix()
        • setup_hugepages()
        • get_port_info()
        • bind_ports_to_driver()
        • bring_up_link()
        • devbind_script_path
        • create_vfs()
        • delete_vfs()
        • get_pci_addr_of_vfs()
        • refresh_lshw()
        • configure_port_mtu()
        • configure_ipv4_forwarding()
    • posix_session - Posix Remote Session
      • PosixSession
        • combine_short_options()
        • guess_dpdk_remote_dir()
        • get_remote_tmp_dir()
        • get_dpdk_build_env_vars()
        • join_remote_path()
        • remote_path_exists()
        • create_tmp_dir()
        • copy_from()
        • copy_to()
        • copy_dir_from()
        • copy_dir_to()
        • change_permissions()
        • remove_remote_file()
        • remove_remote_dir()
        • create_remote_tarball()
        • create_directory()
        • extract_remote_tarball()
        • is_remote_dir()
        • is_remote_tarfile()
        • get_tarball_top_dir()
        • build_dpdk()
        • get_dpdk_version()
        • kill_cleanup_dpdk_apps()
        • get_dpdk_file_prefix()
        • get_compiler_version()
        • get_node_info()
        • get_arch_info()
    • node - Base Node
      • Node
        • main_session
        • config
        • name
        • lcores
        • ports
        • __init__()
        • setup()
        • teardown()
        • tmp_dir
        • ports_by_name
        • create_session()
        • node_info
        • compiler_version
        • close()
      • create_session()
      • LocalNodeIdentifier
      • RemoteNodeIdentifier
      • NodeIdentifier
      • get_node()
    • capability - Testbed Capabilities
      • Capability
        • capabilities_to_check
        • register_to_check()
        • add_to_required()
        • get_supported_capabilities()
        • is_comparable_with()
      • DecoratedNicCapability
        • nic_capability
        • capability_fn
        • capability_decorator
        • get_unique()
        • get_supported_capabilities()
        • __init__()
      • TopologyCapability
        • topology_type
        • get_unique()
        • get_supported_capabilities()
        • set_required()
        • __init__()
      • TestProtocol
        • skip
        • skip_reason
        • topology_type
        • required_capabilities
        • sut_ports_drivers
        • get_test_cases()
        • __init__()
      • configure_ports()
      • requires()
      • get_supported_capabilities()
      • test_if_supported()
    • cpu - CPU Representation and Utilities
      • Architecture
        • i686
        • x86_64
        • x86_32
        • aarch64
        • ppc64le
      • LogicalCore
        • lcore
        • core
        • socket
        • node
        • __init__()
      • LogicalCoreList
        • __init__()
        • lcore_list
      • LogicalCoreCount
        • lcores_per_core
        • cores_per_socket
        • socket_count
        • sockets
        • __init__()
      • LogicalCoreFilter
        • __init__()
        • filter()
      • LogicalCoreCountFilter
        • filter()
      • LogicalCoreListFilter
        • filter()
      • lcore_filter()
    • port - NIC Port Representation
    • topology - Testbed Topology
      • PortLink
        • sut_port
        • tg_port
        • __new__()
      • Topology
        • type
        • sut_ports
        • tg_ports
        • from_port_links()
        • node_and_ports_from_id()
        • setup()
        • teardown()
        • instantiate_vf_ports()
        • delete_vf_ports()
        • configure_ports()
        • sut_dpdk_ports
        • tg_port_egress
        • sut_port_ingress
        • sut_port_egress
        • tg_port_ingress
        • __init__()
    • virtual_device - Virtual Devices
      • VirtualDevice
        • name
        • __init__()
  • remote_session - Node Connections Package
    • remote_session - Remote Session ABC
      • CommandResult
        • name
        • command
        • stdout
        • stderr
        • return_code
        • __init__()
      • RemoteSession
        • name
        • hostname
        • ip
        • port
        • username
        • password
        • history
        • session
        • __init__()
        • send_command()
        • is_alive()
        • copy_from()
        • copy_to()
        • close()
    • interactive_remote_session - SSH Interactive Remote Session
      • InteractiveRemoteSession
        • hostname
        • ip
        • port
        • username
        • password
        • session
        • __init__()
    • interactive_shell - Base Interactive Remote Shell
      • only_active()
      • InteractiveShell
        • is_alive
        • __init__()
        • start_application()
        • send_command()
        • path
    • shell_pool - Shell Pooling Manager
      • ShellPool
        • __init__()
        • pool_level
        • register_shell()
        • unregister_shell()
        • start_new_pool()
        • terminate_current_pool()
    • dpdk - DPDK Environments
      • DPDKBuildInfo
        • dpdk_version
        • compiler_version
        • __init__()
      • DPDKBuildEnvironment
        • __init__()
        • setup()
        • teardown()
        • get_app()
        • remote_dpdk_tree_path
        • remote_dpdk_build_dir
        • dpdk_version
        • get_dpdk_build_info()
      • DPDKRuntimeEnvironment
        • __init__()
        • setup()
        • teardown()
        • run_dpdk_app()
        • filter_lcores()
        • kill_cleanup_dpdk_apps()
        • get_virtual_devices()
    • dpdk_shell - DPDK Interactive Remote Shell
      • compute_eal_params()
      • DPDKShell
        • __init__()
        • path
    • python_shell - Python Interactive Remote Shell
      • PythonShell
        • path
  • params - Command Line Parameters Modelling
    • FnPtr
    • Switch
    • YesNoSwitch
    • modify_str()
    • comma_separated()
    • bracketed()
    • str_from_flag_value()
    • hex_from_flag_value()
    • ParamsModifier
      • Params_short
      • Params_long
      • Params_multiple
      • Params_convert_value
    • Params
      • short()
      • long()
      • multiple()
      • convert_value()
      • append_str()
      • from_str()
      • __init__()
    • eal - EAL Parameters Modelling
      • EalParams
        • lcore_list
        • memory_channels
        • prefix
        • no_pci
        • vdevs
        • ports
        • other_eal_param
        • __init__()
    • params.types - Parameters Modelling Types
      • EalParamsDict
      • TestPmdParamsDict
  • config - Configuration Package
    • Configuration
      • test_run
      • nodes
      • tests_config
      • validate_node_names()
      • validate_port_links()
      • validate_test_run_against_nodes()
    • load_config()
  • runner - Testbed Setup and Test Suite Runner
    • DTSRunner
      • __init__()
      • run()
  • test_run - Test Run Execution
    • TestRun
      • config
      • logger
      • state
      • ctx
      • result
      • selected_tests
      • blocked
      • remaining_tests
      • remaining_test_cases
      • supported_capabilities
      • __init__()
      • required_capabilities
      • spin()
      • init_random_seed()
    • State
      • before()
      • after()
      • description
      • logger
      • next()
      • on_error()
      • handle_exception()
      • __init__()
    • TestRunSetup
      • description
      • next()
      • on_error()
      • __init__()
    • TestRunExecution
      • description
      • next()
      • on_error()
      • __init__()
    • TestRunTeardown
      • description
      • next()
      • on_error()
      • __init__()
    • TestSuiteState
      • __init__()
    • TestSuiteSetup
      • before()
      • description
      • next()
      • on_error()
      • __init__()
    • TestSuiteExecution
      • description
      • next()
      • on_error()
      • __init__()
    • TestSuiteTeardown
      • description
      • next()
      • on_error()
      • after()
      • __init__()
    • TestCaseState
      • __init__()
    • TestCaseSetup
      • description
      • next()
      • on_error()
      • __init__()
    • TestCaseExecution
      • __init__()
      • description
      • next()
      • on_error()
    • TestCaseTeardown
      • __init__()
      • description
      • next()
      • on_error()
  • test_suite - Common Test Suite Features
    • BaseConfig
    • TestSuite
      • config
      • is_blocking
      • __init__()
      • name
      • topology
      • get_test_cases()
      • filter_test_cases()
      • set_up_suite()
      • tear_down_suite()
      • set_up_test_case()
      • tear_down_test_case()
    • TestSuiteMethodType
    • TestCaseType
      • FUNCTIONAL
      • PERFORMANCE
    • TestCase
      • name
      • test_type
      • make_decorator()
    • func_test()
    • perf_test()
    • TestSuiteSpec
      • module_name
      • TEST_SUITES_PACKAGE_NAME
      • TEST_SUITE_MODULE_PREFIX
      • TEST_SUITE_CLASS_PREFIX
      • TEST_CASE_METHOD_PREFIX
      • FUNC_TEST_CASE_REGEX
      • PERF_TEST_CASE_REGEX
      • name
      • __init__()
      • module
      • class_name
      • class_obj
      • config_obj
      • discover_all()
    • AVAILABLE_TEST_SUITES
    • find_by_name()
  • test_result - Test Results Records
    • Result
      • PASS
      • SKIP
      • BLOCK
      • FAIL
      • ERROR
      • __new__()
    • ResultLeaf
      • result
      • reason
    • ExecutionStep
    • ResultNode
      • label
      • children
      • parent
      • add_child()
      • mark_result_as()
      • mark_step_as()
      • serialize_model()
      • get_overall_result()
      • make_summary()
      • print_results()
    • TestRunResult
      • sut_session_info
      • dpdk_build_info
      • ports
      • test_suites
      • execution_errors
      • serialize_errors()
      • add_error()
      • summary
      • return_code
      • print_summary()
      • dump_json()
      • process()
  • settings - Command Line Arguments and Environment Variables
    • SETTINGS
    • Settings
      • test_run_config_path
      • nodes_config_path
      • tests_config_path
      • output_dir
      • timeout
      • verbose
      • dpdk_location
      • precompiled_build_dir
      • compile_timeout
      • test_suites
      • re_run
      • random_seed
      • __init__()
    • get_settings()
  • context - DTS execution context
    • LocalContext
      • current_test_suite
      • current_test_case
      • lcore_filter_specifier
      • ascending_cores
      • append_prefix_timestamp
      • timeout
      • reset()
      • __init__()
    • Context
      • __init__()
    • get_ctx()
    • init_ctx()
    • filter_cores()
  • logger - Logging Facility
    • ArtifactHandler
      • artifact
      • handler
      • __new__()
    • DTSLogger
      • __init__()
      • add_dts_root_logger_handlers()
      • set_stage()
      • set_custom_log_file()
    • get_dts_logger()
  • parser - Text Parsing Utilities
    • ParserFn
      • TextParser_fn
    • TextParser
      • wrap()
      • find()
      • find_int()
      • parse()
      • __init__()
  • utils - Various Utilities
    • REGEX_FOR_PCI_ADDRESS
    • expand_range()
    • get_packet_summaries()
    • StrEnum
    • MesonArgs
      • __init__()
    • TarCompressionFormat
      • extension
    • convert_to_list_of_string()
    • create_tarball()
    • extract_tarball()
    • PacketProtocols
      • IP
      • TCP
      • UDP
      • ALL
    • generate_random_packets()
    • to_pascal_case()
  • exception - Exceptions
    • ErrorSeverity
      • NO_ERR
      • GENERIC_ERR
      • CONFIG_ERR
      • REMOTE_CMD_EXEC_ERR
      • SSH_ERR
      • INTERNAL_ERR
      • DPDK_BUILD_ERR
      • TESTCASE_VERIFY_ERR
      • BLOCKING_TESTSUITE_ERR
      • __new__()
    • DTSError
      • severity
    • SSHConnectionError
      • severity
      • __init__()
    • SSHTimeoutError
    • InteractiveSSHTimeoutError
    • SSHSessionDeadError
    • InteractiveSSHSessionDeadError
    • ConfigurationError
      • severity
    • RemoteCommandExecutionError
      • severity
      • __init__()
      • command
    • InteractiveCommandExecutionError
      • severity
    • RemoteFileNotFoundError
      • severity
    • DPDKBuildError
      • severity
    • TestCaseVerifyError
      • severity
    • InternalError
      • severity
    • SkippedTestException
      • severity
      • __init__()
Data Plane Development Kit
  • Search

Built with Sphinx using a theme provided by Read the Docs.