SwitchML Client Library API

Class Hierarchy

• • Namespace switchml
    • Struct BackendConfig
    • Struct DpdkBackendConfig
    • Struct GeneralConfig
    • Struct JobSlice
    • Struct RdmaBackendConfig
    • Struct Tensor
    • Class Backend
    • Class Barrier
    • Class BypassPPP
    • Class Config
    • Class Context
    • Class CpuExponentQuantizerPPP
    • Class DpdkBackend
      • Struct DpdkBackend::DpdkPacketHdr
      • Struct DpdkBackend::E2eAddress
    • Class DpdkMasterThread
    • Class DpdkWorkerThread
    • Class DummyBackend
      • Struct DummyBackend::DummyPacket
    • Class DummyWorkerThread
    • Class FifoScheduler
    • Class GrpcClient
    • Class Job
    • Class PrePostProcessor
    • Class RdmaBackend
    • Class RdmaConnection
    • Class RdmaEndpoint
    • Class RdmaWorkerThread
    • Class Scheduler
    • Class Stats
    • Class TimeoutQueue
      • Struct TimeoutQueue::TQEntry
    • Enum AllReduceOperation
    • Enum DataType
    • Enum JobStatus
    • Enum JobType
    • Union ExtraJobInfo

File Hierarchy

• • Directory root
    • Directory lib
      • Directory src
        • Directory backends
          • Directory dpdk
            • File dpdk_backend.h
            • File dpdk_master_thread.h
            • File dpdk_utils.h
            • File dpdk_worker_thread.h
          • Directory dummy
            • File dummy_backend.h
            • File dummy_worker_thread.h
          • Directory rdma
            • File rdma_backend.h
            • File rdma_connection.h
            • File rdma_endpoint.h
            • File rdma_timeout_queue.h
            • File rdma_utils.h
            • File rdma_worker_thread.h
        • Directory prepostprocessors
          • File bypass_ppp.h
          • File cpu_exponent_quantizer_ppp.h
        • Directory schedulers
          • File fifo_scheduler.h
        • File backend.h
        • File common.h
        • File common_cc.h
        • File config.h
        • File context.h
        • File grpc_client.h
        • File job.h
        • File prepostprocessor.h
        • File scheduler.h
        • File stats.h
        • File utils.h

Full API

Namespaces

• Namespace switchml
  • Classes
  • Enums
  • Functions
  • Typedefs
  • Unions

Classes and Structs

• Struct BackendConfig
  • Struct Documentation

• Struct DpdkBackend::DpdkPacketHdr
  • Nested Relationships
  • Struct Documentation

• Struct DpdkBackend::E2eAddress
  • Nested Relationships
  • Struct Documentation

• Struct DpdkBackendConfig
  • Struct Documentation

• Struct DummyBackend::DummyPacket
  • Nested Relationships
  • Struct Documentation

• Struct GeneralConfig
  • Struct Documentation

• Struct JobSlice
  • Struct Documentation

• Struct RdmaBackendConfig
  • Struct Documentation

• Struct Tensor
  • Struct Documentation

• Struct TimeoutQueue::TQEntry
  • Nested Relationships
  • Struct Documentation

• Class Backend
  • Inheritance Relationships
    • Derived Types
  • Class Documentation

• Class Barrier
  • Class Documentation

• Class BypassPPP
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class Config
  • Class Documentation

• Class Context
  • Class Documentation

• Class CpuExponentQuantizerPPP
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class DpdkBackend
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class DpdkMasterThread
  • Class Documentation

• Class DpdkWorkerThread
  • Class Documentation

• Class DummyBackend
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class DummyWorkerThread
  • Class Documentation

• Class FifoScheduler
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class GrpcClient
  • Class Documentation

• Class Job
  • Class Documentation

• Class PrePostProcessor
  • Inheritance Relationships
    • Derived Types
  • Class Documentation

• Class RdmaBackend
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class RdmaConnection
  • Class Documentation

• Class RdmaEndpoint
  • Class Documentation

• Class RdmaWorkerThread
  • Class Documentation

• Class Scheduler
  • Inheritance Relationships
    • Derived Type
  • Class Documentation

• Class Stats
  • Class Documentation

• Class TimeoutQueue
  • Nested Relationships
    • Nested Types
  • Class Documentation

Enums

• Enum AllReduceOperation
  • Enum Documentation

• Enum DataType
  • Enum Documentation

• Enum JobStatus
  • Enum Documentation

• Enum JobType
  • Enum Documentation

Unions

• Union ExtraJobInfo
  • Union Documentation

Functions

• Function switchml::BindToCore
  • Function Documentation

• Function switchml::ChangeMacEndianness
  • Function Documentation

• Function switchml::DataTypeSize
  • Function Documentation

• Function switchml::Execute
  • Function Documentation

• Function switchml::GetCoresNuma
  • Function Documentation

• Function switchml::GetDeviceNuma
  • Function Documentation

• Function switchml::GIDToIPv4
  • Function Documentation

• Function switchml::GIDToMAC
  • Function Documentation

• Function switchml::IPv4ToGID
  • Function Documentation

• Function switchml::Mac2Str(const uint64_t)
  • Function Documentation

• Function switchml::Mac2Str(const rte_ether_addr)
  • Function Documentation

• Function switchml::MACToGID
  • Function Documentation

• Function switchml::Str2Mac
  • Function Documentation

• Template Function switchml::ToHex
  • Function Documentation

Variables

• Variable job_type_size
  • Variable Documentation

• Variable pkt_id
  • Variable Documentation

• Variable short_job_id
  • Variable Documentation

• Variable switch_pool_index
  • Variable Documentation

Defines

• Define DPDK_SWITCH_ELEMENT_SIZE
  • Define Documentation

• Define DUMMY
  • Define Documentation

• Define DUMMY_ELEMENT_SIZE
  • Define Documentation

• Define RDMA_SWITCH_ELEMENT_SIZE
  • Define Documentation

Typedefs

• Typedef switchml::clock
  • Typedef Documentation

• Typedef switchml::JobId
  • Typedef Documentation

• Typedef switchml::Numel
  • Typedef Documentation

• Typedef switchml::WorkerTid
  • Typedef Documentation