api

type AffinityGroup struct {
	ObjectMeta `json:"metadata"`
	Status     AffinityGroupStatus `json:"status"`
}

type AffinityGroupList struct {
	Items []AffinityGroup `json:"items"`
}

type AffinityGroupMemberBindInfo struct {
	PodPlacements []PodPlacementInfo `yaml:"podPlacements"`
}

type AffinityGroupMemberSpec struct {
	PodNumber int32 `yaml:"podNumber"`
	GpuNumber int32 `yaml:"gpuNumber"`
}

type AffinityGroupSpec struct {
	Name    string                    `yaml:"name"`
	Members []AffinityGroupMemberSpec `yaml:"members"`
}

type AffinityGroupState string

type AffinityGroupStatus struct {
	VC       VirtualClusterName `json:"vc"`
	Priority int32              `json:"priority"`
	State    AffinityGroupState `json:"state"`
	// node -> GPU indices
	PhysicalPlacement map[string][]int32 `json:"physicalPlacement,omitempty"`
	// preassigned cell -> leaf cells
	VirtualPlacement     map[CellAddress][]CellAddress `json:"virtualPlacement,omitempty"`
	AllocatedPods        []types.UID                   `json:"allocatedPods,omitempty"`
	PreemptingPods       []types.UID                   `json:"preemptingPods,omitempty"`
	LazyPreemptionStatus *LazyPreemptionStatus         `json:"lazyPreemptionStatus,omitempty"`
}

type CellAddress string

type CellHealthiness string

type CellState string

type CellStatus struct {
	GpuType     string   `json:"gpuType,omitempty"`
	CellType    CellType `json:"cellType"`
	IsNodeLevel bool     `json:"isNodeLevel,omitempty"`
	// Address of a physical cell consists of its address (or index) in each level
	// (e.g., node0/0/0/0 may represent node0, CPU socket 0, PCIe switch 0, GPU 0.
	// Address of a virtual cell consists of its VC name, index of the preassigned cell,
	// and the relative index in each level inside the preassigned cell
	// (e.g., VC1/0/0 may represent VC1, preassigned cell 0, index 0 among its children)
	CellAddress CellAddress `json:"cellAddress"`
	// CellState and CellHealthiness are two orthogonal fields.
	// That means, there are four possible combinations of them: a cell may be in
	// (1) used and healthy, (2) used and bad, (3) free and healthy, and (4) free and bad.
	CellState       CellState       `json:"cellState"`
	CellHealthiness CellHealthiness `json:"cellHealthiness"`
	CellPriority    int32           `json:"cellPriority"`
}

type CellType string

type CellTypeSpec struct {
	ChildCellType   CellType `yaml:"childCellType"`
	ChildCellNumber int32    `yaml:"childCellNumber"`
	IsNodeLevel     bool     `yaml:"isNodeLevel"`
}

type ClusterStatus struct {
	// Status of cells in the physical cluster
	PhysicalCluster PhysicalClusterStatus `json:"physicalCluster"`
	// Status of cells in each VC
	VirtualClusters map[VirtualClusterName]VirtualClusterStatus `json:"virtualClusters"`
}

type Config struct {
	// KubeApiServerAddress is default to ${KUBE_APISERVER_ADDRESS}.
	// KubeConfigFilePath is default to ${KUBECONFIG} then falls back to ${HOME}/.kube/config.
	//
	// If both KubeApiServerAddress and KubeConfigFilePath after defaulting are still empty, falls back to the
	// [k8s inClusterConfig](https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod).
	//
	// If both KubeApiServerAddress and KubeConfigFilePath after defaulting are not empty,
	// KubeApiServerAddress overrides the server address specified in the file referred by KubeConfigFilePath.
	//
	// If only KubeApiServerAddress after defaulting is not empty, it should be an insecure ApiServer address (can be got from
	// [Insecure ApiServer](https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/#api-server-ports-and-ips) or
	// [kubectl proxy](https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#using-kubectl-proxy))
	// which does not enforce authentication.
	//
	// If only KubeConfigFilePath after defaulting is not empty, it should be an valid
	// [KubeConfig File](https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/#explore-the-home-kube-directory)
	// which inlines or refers the valid
	// [ApiServer Credential Files](https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/#transport-security).
	//
	// Address should be in format http[s]://host:port
	KubeApiServerAddress *string `yaml:"kubeApiServerAddress"`
	KubeConfigFilePath   *string `yaml:"kubeConfigFilePath"`

	// WebServer
	// Default to :9096
	WebServerAddress *string `yaml:"webServerAddress"`

	// Specify a threshold for PodBindAttempts, that after it is exceeded, an extra
	// Pod binding will be executed forcefully.
	ForcePodBindThreshold *int32 `yaml:"forcePodBindThreshold"`

	// If a Pod is decided to be PodWaiting, it will block the whole scheduling by
	// WaitingPodSchedulingBlockMilliSec.
	// Large value can be used to achieve stronger FIFO scheduling by sacrificing
	// the scheduling throughput.
	// This is a workaround until PodMaxBackoffSeconds can be configured for
	// K8S Default Scheduler.
	WaitingPodSchedulingBlockMilliSec *int64 `yaml:"waitingPodSchedulingBlockMilliSec"`

	// Specify the whole physical cluster
	// TODO: Automatically construct it based on node info from GPU and Network Device Plugins
	PhysicalCluster *PhysicalClusterSpec `yaml:"physicalCluster"`

	// Specify all the virtual clusters belongs to the physical cluster
	VirtualClusters *map[VirtualClusterName]VirtualClusterSpec `yaml:"virtualClusters"`
}

type LazyPreemptionStatus struct {
	// The AffinityGroup who has lazy preempted it.
	Preemptor string `json:"preemptor"`
	// It was lazy preempted at PreemptionTime.
	PreemptionTime meta.Time `json:"preemptionTime"`
}

type ObjectMeta struct {
	Name string `json:"name"`
}

type PhysicalCellSpec struct {
	CellType      CellType           `yaml:"cellType"`
	CellAddress   CellAddress        `yaml:"cellAddress"`
	ReservationId ReservationId      `yaml:"reservationId"`
	CellChildren  []PhysicalCellSpec `yaml:"cellChildren,omitempty"`
}

type PhysicalCellStatus struct {
	CellStatus
	CellChildren []*PhysicalCellStatus `json:"cellChildren,omitempty"`
	VC           VirtualClusterName    `json:"vc,omitempty"`
	VirtualCell  *VirtualCellStatus    `json:"virtualCell,omitempty"`
}

type PhysicalClusterSpec struct {
	CellTypes     map[CellType]CellTypeSpec `yaml:"cellTypes"`
	PhysicalCells []PhysicalCellSpec        `yaml:"physicalCells"`
}

type PhysicalClusterStatus []*PhysicalCellStatus

type PodBindInfo struct {
	Node                  string                        `yaml:"node"`         // node to bind
	GpuIsolation          []int32                       `yaml:"gpuIsolation"` // GPUs to bind
	CellChain             string                        `yaml:"cellChain"`    // cell chain selected
	AffinityGroupBindInfo []AffinityGroupMemberBindInfo `yaml:"affinityGroupBindInfo"`
}

type PodPlacementInfo struct {
	PhysicalNode       string  `yaml:"physicalNode"`
	PhysicalGpuIndices []int32 `yaml:"physicalGpuIndices"`
	// preassigned cell types used by the pods. used to locate the virtual cells
	// when adding an allocated pod
	PreassignedCellTypes []CellType `yaml:"preassignedCellTypes"`
}

type PodSchedulingSpec struct {
	VirtualCluster       VirtualClusterName `yaml:"virtualCluster"`
	Priority             int32              `yaml:"priority"`
	ReservationId        ReservationId      `yaml:"reservationId"`
	GpuType              string             `yaml:"gpuType"`
	GpuNumber            int32              `yaml:"gpuNumber"`
	GangReleaseEnable    bool               `yaml:"gangReleaseEnable"`
	LazyPreemptionEnable bool               `yaml:"lazyPreemptionEnable"`
	AffinityGroup        *AffinityGroupSpec `yaml:"affinityGroup"`
}

type ReservationId string

type ReservedCellSpec struct {
	ReservationId ReservationId `yaml:"reservationId"`
}

type VirtualCellSpec struct {
	CellNumber int32    `yaml:"cellNumber"`
	CellType   CellType `yaml:"cellType"`
}

type VirtualCellStatus struct {
	CellStatus
	CellChildren []*VirtualCellStatus `json:"cellChildren,omitempty"`
	PhysicalCell *PhysicalCellStatus  `json:"physicalCell,omitempty"`
}

type VirtualClusterName string

type VirtualClusterSpec struct {
	VirtualCells  []VirtualCellSpec  `yaml:"virtualCells"`
	ReservedCells []ReservedCellSpec `yaml:"reservedCells,omitempty"`
}

type VirtualClusterStatus []*VirtualCellStatus

type WebServerError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

type WebServerPaths struct {
	Paths []string `json:"paths"`
}