types

type Device interface {
	encoding.BinaryMarshaler
	encoding.BinaryUnmarshaler

	GetAttrs() map[resourceapi.QualifiedName]resourceapi.DeviceAttribute
	GetCapacity() map[resourceapi.QualifiedName]resourceapi.DeviceCapacity
	AllowMultipleAllocations() bool
	// Setup prepares one allocation and returns the device representing it.
	// For a shared allocation, this may be an allocation-specific child, such as a
	// netdev that leases one RX queue, rather than the device published in the
	// ResourceSlice.
	Setup(allocation DeviceAllocation) (Device, error)
	// Recover re-creates missing kernel state for an allocation restored from
	// ResourceClaim status. The returned device must represent the same logical
	// allocation because recovery does not rewrite that status.
	Recover(allocation DeviceAllocation) (Device, error)
	Free(allocation DeviceAllocation) error
	Match(filter v2alpha1.CiliumNetworkDriverDeviceFilter) bool
	IfName() string
	KernelIfName() string
	Merge(Device)
}

type DeviceAllocation struct {
	Config DeviceConfig
	// ShareID identifies a shared allocation and is empty for a dedicated one.
	// It reflects the scheduler's allocation-time decision, which may differ
	// from the device's current sharing mode.
	ShareID kube_types.UID
	// ConsumedCapacity contains the capacity assigned by the scheduler.
	ConsumedCapacity map[resourceapi.QualifiedName]resource.Quantity
}

type DeviceConfig struct {
	PodIfName string       `json:"podIfName,omitempty"` // Custom interface name for the pod namespace
	Vlan      int32        `json:"vlan,omitempty"`      // VLAN ID to assign to the device (0 = untagged / no change)
	IPv4Addr  netip.Prefix `json:"ipv4Addr,omitzero"`
	IPv6Addr  netip.Prefix `json:"ipv6Addr,omitzero"`
	IPPool    string       `json:"ipPool,omitempty"`

	// InterfaceSysctlIPv4/IPv6 hold leaf sysctl parameters (e.g.
	// "arp_filter") applied under net.<family>.conf.<interface>. for the
	// interface this claim allocates. Applied once, inside the pod netns,
	// when the interface is brought up; not reverted on Free (the
	// namespace is destroyed with the pod).
	InterfaceSysctlIPv4 map[string]string `json:"interfaceSysctlIPv4,omitempty"`
	InterfaceSysctlIPv6 map[string]string `json:"interfaceSysctlIPv6,omitempty"`
}

type DeviceManager interface {
	Type() DeviceManagerType
	// Run publishes the current device set by calling publish, then blocks
	// until ctx is cancelled. Implementations must call publish at least once
	// before returning so the driver knows what devices are available.
	// On any change to the device set, Run calls publish again with the full
	// updated set.
	Run(ctx context.Context, publish func([]Device)) error
	RestoreDevice([]byte) (Device, error)
}

type DeviceManagerType int

type SerializedDevice struct {
	Manager DeviceManagerType
	Dev     json.RawMessage
	Config  DeviceConfig
	// LogicalPool is the Cilium pool the device was matched against when
	// this allocation was prepared. Persisted so restore can keep the pool
	// pinned even if pool config changes while the driver is down.
	LogicalPool      string                                          `json:"logicalPool,omitempty"`
	ConsumedCapacity map[resourceapi.QualifiedName]resource.Quantity `json:",omitempty"`
}