Data Plane Development Kit Logo
25.11.0-rc3
  • Test Suites
    • blocklist Test Suite
    • checksum_offload Test Suite
    • dual_vlan Test Suite
    • dynamic_config Test Suite
    • dynamic_queue_conf Test Suite
    • hello_world Test Suite
    • l2fwd Test Suite
    • mac_filter Test Suite
    • mtu Test Suite
    • packet_capture Test Suite
    • pmd_buffer_scatter Test Suite
    • port_control Test Suite
    • port_restart_config_persistency Test Suite
    • port_stats Test Suite
    • promisc_support Test Suite
    • queue_start_stop Test Suite
    • rte_flow Test Suite
    • rx_tx_offload Test Suite
    • single_core_forward_perf Test Suite
    • smoke_tests Test Suite
    • softnic Test Suite
    • uni_pkt Test Suite
    • virtio_fwd Test Suite
    • vlan Test Suite
  • api - DTS API
    • testpmd - Testpmd Interactive Remote Shell
      • types - Testpmd types
      • config - Testpmd configuration
    • 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()
    • capabilities - SUT Capabilities
      • LinkTopology
        • NO_LINK
        • ONE_LINK
        • TWO_LINKS
        • default()
        • __new__()
      • NicCapability
        • SCATTERED_RX_ENABLED
        • PORT_RX_OFFLOAD_VLAN_STRIP
        • PORT_RX_OFFLOAD_IPV4_CKSUM
        • PORT_RX_OFFLOAD_UDP_CKSUM
        • PORT_RX_OFFLOAD_TCP_CKSUM
        • PORT_RX_OFFLOAD_TCP_LRO
        • PORT_RX_OFFLOAD_QINQ_STRIP
        • PORT_RX_OFFLOAD_OUTER_IPV4_CKSUM
        • PORT_RX_OFFLOAD_MACSEC_STRIP
        • PORT_RX_OFFLOAD_VLAN_FILTER
        • PORT_RX_OFFLOAD_VLAN_EXTEND
        • PORT_RX_OFFLOAD_SCATTER
        • PORT_RX_OFFLOAD_TIMESTAMP
        • PORT_RX_OFFLOAD_SECURITY
        • PORT_RX_OFFLOAD_KEEP_CRC
        • PORT_RX_OFFLOAD_SCTP_CKSUM
        • PORT_RX_OFFLOAD_OUTER_UDP_CKSUM
        • PORT_RX_OFFLOAD_RSS_HASH
        • PORT_RX_OFFLOAD_BUFFER_SPLIT
        • PORT_RX_OFFLOAD_CHECKSUM
        • PORT_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
        • PORT_TX_OFFLOAD_VLAN_INSERT
        • PORT_TX_OFFLOAD_IPV4_CKSUM
        • PORT_TX_OFFLOAD_UDP_CKSUM
        • PORT_TX_OFFLOAD_TCP_CKSUM
        • PORT_TX_OFFLOAD_SCTP_CKSUM
        • PORT_TX_OFFLOAD_TCP_TSO
        • PORT_TX_OFFLOAD_UDP_TSO
        • PORT_TX_OFFLOAD_OUTER_IPV4_CKSUM
        • PORT_TX_OFFLOAD_QINQ_INSERT
        • PORT_TX_OFFLOAD_VXLAN_TNL_TSO
        • PORT_TX_OFFLOAD_GRE_TNL_TSO
        • PORT_TX_OFFLOAD_IPIP_TNL_TSO
        • PORT_TX_OFFLOAD_GENEVE_TNL_TSO
        • PORT_TX_OFFLOAD_MACSEC_INSERT
        • PORT_TX_OFFLOAD_MT_LOCKFREE
        • PORT_TX_OFFLOAD_MULTI_SEGS
        • PORT_TX_OFFLOAD_MBUF_FAST_FREE
        • PORT_TX_OFFLOAD_SECURITY
        • PORT_TX_OFFLOAD_UDP_TNL_TSO
        • PORT_TX_OFFLOAD_IP_TNL_TSO
        • PORT_TX_OFFLOAD_OUTER_UDP_CKSUM
        • PORT_TX_OFFLOAD_SEND_ON_TIMESTAMP
        • __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()
      • assess_performance_by_packet()
    • test - Reporting results and logging
      • get_current_test_case_name()
      • log()
      • log_debug()
      • verify()
      • verify_else_skip()
      • skip()
      • fail()
      • get_logger()
      • write_performance_json()
  • testbed_model - Testbed Modelling Package
    • traffic_generator Subpackage
      • create_traffic_generator()
      • traffic_generator - Base TG ABC
        • TrafficGenerator
          • __init__()
          • send_packets()
          • setup()
          • teardown()
          • is_capturing
          • close()
          • is_setup
      • capturing_traffic_generator - Base Capturing TG ABC
        • PacketFilteringConfig
          • no_lldp
          • no_arp
          • no_icmp
          • __init__()
        • CapturingTrafficGenerator
          • is_capturing
          • send_packet()
          • send_packets()
          • 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()
    • 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()
        • set_interface_link_up()
        • delete_interface()
        • 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()
        • set_interface_link_up()
        • delete_interface()
        • 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
  • 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
  • test_run - Test Run Execution
  • test_suite - Common Test Suite Features
  • 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_all()
      • 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
  • Python Module Index

Python Module Index

a | f
 
a
- api
    api.artifact
    api.capabilities
    api.packet
    api.test
 
f
- framework
    framework.config
    framework.context
    framework.exception
    framework.logger
    framework.params
    framework.params.eal
    framework.parser
    framework.remote_session
    framework.remote_session.dpdk
    framework.remote_session.dpdk_shell
    framework.remote_session.interactive_remote_session
    framework.remote_session.interactive_shell
    framework.remote_session.python_shell
    framework.remote_session.remote_session
    framework.remote_session.shell_pool
    framework.settings
    framework.test_result
    framework.testbed_model
    framework.testbed_model.capability
    framework.testbed_model.cpu
    framework.testbed_model.linux_session
    framework.testbed_model.node
    framework.testbed_model.os_session
    framework.testbed_model.posix_session
    framework.testbed_model.topology
    framework.testbed_model.traffic_generator
    framework.testbed_model.traffic_generator.capturing_traffic_generator
    framework.testbed_model.traffic_generator.scapy
    framework.testbed_model.traffic_generator.traffic_generator
    framework.testbed_model.virtual_device
    framework.utils

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