Data Plane Development Kit Logo
25.03.0-rc0
  • testbed_model - Testbed Modelling Package
    • traffic_generator Subpackage
      • create_traffic_generator()
      • traffic_generator - Base TG ABC
        • TrafficGenerator
          • __init__()
          • send_packet()
          • send_packets()
          • is_capturing
          • close()
      • capturing_traffic_generator - Base Capturing TG ABC
        • PacketFilteringConfig
          • no_lldp
          • no_arp
          • __init__()
        • CapturingTrafficGenerator
          • is_capturing
          • send_packets_and_capture()
      • scapy - Capturing Traffic Generator
        • ScapyTrafficGenerator
          • __init__()
          • start_application()
    • os_session - OS-aware Remote Session ABC
      • 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()
        • copy_from()
        • copy_to()
        • copy_dir_from()
        • copy_dir_to()
        • remove_remote_file()
        • remove_remote_dir()
        • create_remote_tarball()
        • 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()
        • update_ports()
        • configure_port_mtu()
    • linux_session - Linux Remote Session
      • LshwConfigurationOutput
        • link
      • LshwOutput
        • businfo
        • logicalname
        • serial
        • configuration
      • LinuxSession
        • get_remote_cpus()
        • get_dpdk_file_prefix()
        • setup_hugepages()
        • update_ports()
        • 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()
        • copy_from()
        • copy_to()
        • copy_dir_from()
        • copy_dir_to()
        • remove_remote_file()
        • remove_remote_dir()
        • create_remote_tarball()
        • 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()
    • node - Base Node
      • Node
        • main_session
        • config
        • name
        • lcores
        • ports
        • __init__()
        • set_up_test_run()
        • tear_down_test_run()
        • create_session()
        • filter_lcores()
        • close()
      • create_session()
    • sut_node - System Under Test Node
      • DPDKBuildInfo
        • dpdk_version
        • compiler_version
        • __init__()
      • SutNode
        • config
        • virtual_devices
        • __init__()
        • remote_dpdk_build_dir
        • dpdk_version
        • node_info
        • compiler_version
        • path_to_devbind_script
        • get_dpdk_build_info()
        • set_up_test_run()
        • tear_down_test_run()
        • build_dpdk_app()
        • kill_cleanup_dpdk_apps()
        • run_dpdk_app()
        • bind_ports_to_driver()
    • tg_node - Traffic Generator Node
      • TGNode
        • traffic_generator
        • __init__()
        • send_packets_and_capture()
        • send_packets()
        • close()
    • capability - Testbed Capabilities
      • Capability
        • capabilities_to_check
        • register_to_check()
        • add_to_required()
        • get_supported_capabilities()
      • 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
        • get_test_cases()
        • __init__()
      • requires()
      • get_supported_capabilities()
    • cpu - CPU Representation and Utilities
      • 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
      • PortIdentifier
        • node
        • pci
        • __init__()
      • Port
        • identifier
        • os_driver
        • os_driver_for_dpdk
        • peer
        • mac_address
        • logical_name
        • __init__()
        • node
        • pci
      • PortLink
        • sut_port
        • tg_port
        • __init__()
    • topology - Testbed Topology
      • TopologyType
        • no_link
        • one_link
        • two_links
        • default
        • get_from_value()
        • __new__()
      • Topology
        • type
        • tg_port_egress
        • sut_port_ingress
        • sut_port_egress
        • tg_port_ingress
        • __init__()
      • PortLink
        • sut_port
        • tg_port
        • __init__()
    • virtual_device - Virtual Devices
      • VirtualDevice
        • name
        • __init__()
  • remote_session - Node Connections Package
    • create_remote_session()
    • create_interactive_session()
    • remote_session - Remote Session ABC
      • CommandResult
        • name
        • command
        • stdout
        • stderr
        • return_code
        • __init__()
      • RemoteSession
        • name
        • hostname
        • ip
        • port
        • username
        • password
        • history
        • __init__()
        • send_command()
        • is_alive()
        • copy_from()
        • copy_to()
        • close()
    • ssh_session - SSH Remote Session
      • SSHSession
        • session
        • 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
      • InteractiveShell
        • start_application()
        • close()
    • dpdk_shell - DPDK Interactive Remote Shell
      • compute_eal_params()
      • DPDKShell
        • __init__()
    • testpmd_shell - Testpmd Interactive Remote Shell
      • 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()
      • make_device_private_info_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__()
      • 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
        • __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__()
      • requires_stopped_ports()
      • requires_started_ports()
      • add_remove_mtu()
      • TestPmdShell
        • ports_started
        • path
        • __init__()
        • ports
        • start()
        • stop()
        • get_devices()
        • wait_link_status_up()
        • set_forward_mode()
        • stop_all_ports()
        • start_all_ports()
        • set_ports_queues()
        • show_port_info_all()
        • show_port_info()
        • set_mac_addr()
        • set_multicast_mac_addr()
        • show_port_stats_all()
        • show_port_stats()
        • csum_set_hw()
        • set_port_mtu()
        • set_port_mtu_all()
        • extract_verbose_output()
        • set_vlan_filter()
        • rx_vlan()
        • set_vlan_strip()
        • tx_vlan_set()
        • set_promisc()
        • set_verbose()
        • 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()
        • get_capabilities_rxq_info()
        • get_capabilities_show_port_info()
        • get_capabilities_mcast_filtering()
      • 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
    • 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__()
    • testpmd - TestPMD Parameters Modelling
      • 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__()
    • params.types - Parameters Modelling Types
      • EalParamsDict
      • TestPmdParamsDict
  • config - Configuration Package
    • FrozenModel
      • model_config
    • Architecture
      • i686
      • x86_64
      • x86_32
      • arm64
      • ppc64le
    • OS
      • linux
      • freebsd
      • windows
    • CPUType
      • native
      • armv8a
      • dpaa2
      • thunderx
      • xgene1
    • Compiler
      • gcc
      • clang
      • icc
      • msvc
    • TrafficGeneratorType
      • SCAPY
      • __new__()
    • HugepageConfiguration
      • number_of
      • force_first_numa
    • PortConfig
      • pci
      • os_driver_for_dpdk
      • os_driver
      • peer_node
      • peer_pci
    • TrafficGeneratorConfig
      • type
    • ScapyTrafficGeneratorConfig
      • type
    • TrafficGeneratorConfigTypes
    • LogicalCores
    • NodeConfiguration
      • name
      • hostname
      • user
      • password
      • arch
      • os
      • lcores
      • use_first_core
      • hugepages
      • ports
    • SutNodeConfiguration
      • memory_channels
    • TGNodeConfiguration
      • traffic_generator
    • NodeConfigurationTypes
    • resolve_path()
    • BaseDPDKLocation
      • remote
    • LocalDPDKLocation
      • remote
    • LocalDPDKTreeLocation
      • dpdk_tree
      • resolve_dpdk_tree_path()
      • validate_dpdk_tree_path()
    • LocalDPDKTarballLocation
      • tarball
      • resolve_tarball_path()
      • validate_tarball_path()
    • RemoteDPDKLocation
      • remote
    • RemoteDPDKTreeLocation
      • dpdk_tree
    • RemoteDPDKTarballLocation
      • tarball
    • DPDKLocation
    • BaseDPDKBuildConfiguration
      • dpdk_location
    • DPDKPrecompiledBuildConfiguration
      • precompiled_build_dir
    • DPDKBuildOptionsConfiguration
      • arch
      • os
      • cpu
      • compiler
      • compiler_wrapper
      • name
    • DPDKUncompiledBuildConfiguration
      • build_options
    • DPDKBuildConfiguration
    • TestSuiteConfig
      • test_suite_name
      • test_cases_names
      • test_suite_spec
      • convert_from_string()
      • validate_names()
    • TestRunSUTNodeConfiguration
      • node_name
      • vdevs
    • TestRunConfiguration
      • dpdk_config
      • perf
      • func
      • skip_smoke_tests
      • test_suites
      • system_under_test_node
      • traffic_generator_node
      • random_seed
    • TestRunWithNodesConfiguration
      • test_run_config
      • sut_node_config
      • tg_node_config
      • __new__()
    • Configuration
      • test_runs
      • nodes
      • test_runs_with_nodes
      • validate_node_names()
      • validate_ports()
      • validate_test_runs_with_nodes()
    • load_config()
  • runner - Testbed Setup and Test Suite Runner
    • DTSRunner
      • __init__()
      • run()
  • test_suite - Common Test Suite Features
    • TestSuite
      • sut_node
      • tg_node
      • is_blocking
      • __init__()
      • get_test_cases()
      • filter_test_cases()
      • set_up_suite()
      • tear_down_suite()
      • set_up_test_case()
      • tear_down_test_case()
      • send_packet_and_capture()
      • send_packets_and_capture()
      • send_packets()
      • get_expected_packets()
      • get_expected_packet()
      • verify()
      • verify_packets()
      • match_all_packets()
    • 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
      • __init__()
      • FUNC_TEST_CASE_REGEX
      • PERF_TEST_CASE_REGEX
      • name
      • module
      • class_name
      • class_obj
      • discover_all()
    • AVAILABLE_TEST_SUITES
    • find_by_name()
  • test_result - Test Results Records
    • TestSuiteWithCases
      • test_suite_class
      • test_cases
      • required_capabilities
      • create_config()
      • mark_skip_unsupported()
      • skip
      • __init__()
    • Result
      • PASS
      • FAIL
      • ERROR
      • BLOCK
      • SKIP
    • TestCaseResultDict
      • test_case_name
      • result
    • TestSuiteResultDict
      • test_suite_name
      • test_cases
    • TestRunResultDict
      • compiler_version
      • dpdk_version
      • ports
      • test_suites
      • summary
    • DtsRunResultDict
      • test_runs
      • summary
    • FixtureResult
      • result
      • error
      • __init__()
    • BaseResult
      • setup_result
      • teardown_result
      • child_results
      • __init__()
      • update_setup()
      • update_teardown()
      • get_errors()
      • to_dict()
      • add_result()
      • generate_pass_rate_dict()
    • DTSResult
      • __init__()
      • add_test_run()
      • add_error()
      • process()
      • get_return_code()
      • to_dict()
    • TestRunResult
      • compiler_version
      • dpdk_version
      • sut_os_name
      • sut_os_version
      • sut_kernel_version
      • __init__()
      • add_test_suite()
      • test_suites_with_cases
      • ports
      • sut_info
      • dpdk_build_info
      • to_dict()
    • TestSuiteResult
      • test_suite_name
      • __init__()
      • add_test_case()
      • to_dict()
    • TestCaseResult
      • test_case_name
      • __init__()
      • update()
      • to_dict()
      • add_result()
    • TextSummary
      • __init__()
      • save()
    • JsonResults
      • __init__()
      • save()
  • settings - Command Line Arguments and Environment Variables
    • SETTINGS
    • Settings
      • config_file_path
      • output_dir
      • timeout
      • verbose
      • dpdk_location
      • precompiled_build_dir
      • compile_timeout
      • test_suites
      • re_run
      • random_seed
      • __init__()
    • get_settings()
  • logger - Logging Facility
    • DtsStage
      • pre_run
      • test_run_setup
      • test_suite_setup
      • test_suite
      • test_suite_teardown
      • test_run_teardown
      • post_run
    • DTSLogger
      • __init__()
      • add_dts_root_logger_handlers()
      • set_stage()
    • 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()
    • MultiInheritanceBaseClass
      • __init__()
    • 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
    • BlockingTestSuiteError
      • severity
      • __init__()
    • InternalError
      • severity
Data Plane Development Kit
  • Search

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