cache

type Affinity struct {
	Scope  *resmgr.Expression `json:"scope,omitempty"`  // scope for evaluating this affinity
	Match  *resmgr.Expression `json:"match"`            // affinity expression
	Weight int32              `json:"weight,omitempty"` // (optional) weight for this affinity
}

type Cachable interface {
	// Set value (via a pointer receiver) to the object.
	Set(value interface{})
	// Get the object that should be cached.
	Get() interface{}
}

type Cache interface {
	// InsertPod inserts a pod into the cache, using a runtime request or reply.
	InsertPod(pod *nri.PodSandbox) (Pod, error)
	// DeletePod deletes a pod from the cache.
	DeletePod(id string) Pod
	// LookupPod looks up a pod in the cache.
	LookupPod(id string) (Pod, bool)
	// InsertContainer inserts a container into the cache, using a runtime request or reply.
	InsertContainer(*nri.Container) (Container, error)
	// DeleteContainer deletes a container from the cache.
	DeleteContainer(id string) Container
	// LookupContainer looks up a container in the cache.
	LookupContainer(id string) (Container, bool)
	// LookupContainerByCgroup looks up a container for the given cgroup path.
	LookupContainerByCgroup(path string) (Container, bool)

	// GetPendingContainers returs all containers with pending changes.
	GetPendingContainers() []Container

	// GetPods returns all the pods known to the cache.
	GetPods() []Pod
	// GetContainers returns all the containers known to the cache.
	GetContainers() []Container

	// GetContaineIds return the ids of all containers.
	GetContainerIds() []string

	// FilterScope returns the containers selected by the scope expression.
	FilterScope(*resmgr.Expression) []Container
	// EvaluateAffinity evaluates the given affinity against all known in-scope containers
	EvaluateAffinity(*Affinity) map[string]int32
	// AddImplicitAffinities adds a set of implicit affinities (added to all containers).
	AddImplicitAffinities(map[string]ImplicitAffinity) error

	// GetActivePolicy returns the name of the active policy stored in the cache.
	GetActivePolicy() string
	// SetActivePolicy updates the name of the active policy stored in the cache.
	SetActivePolicy(string) error

	// ResetActivePolicy clears the active policy any any policy-specific data from the cache.
	ResetActivePolicy() error

	// SetPolicyEntry sets the policy entry for a key.
	SetPolicyEntry(string, interface{})
	// GetPolicyEntry gets the policy entry for a key.
	GetPolicyEntry(string, interface{}) bool

	// Save requests a cache save.
	Save() error

	// RefreshPods purges/inserts stale/new pods/containers using a pod sandbox list response.
	RefreshPods([]*nri.PodSandbox) ([]Pod, []Pod, []Container)
	// RefreshContainers purges/inserts stale/new containers using a container list response.
	RefreshContainers([]*nri.Container) ([]Container, []Container)

	// Get the container (data) directory for a container.
	ContainerDirectory(string) string
	// OpenFile opens the names container data file, creating it if necessary.
	OpenFile(string, string, os.FileMode) (*os.File, error)
	// WriteFile writes a container data file, creating it if necessary.
	WriteFile(string, string, os.FileMode, []byte) error
}

type CompareContainersFn func(Container, Container) int

type Container interface {
	// GetPod returns the pod of the container and a boolean indicating if there was one.
	GetPod() (Pod, bool)
	// GetID returns the ID of the container.
	GetID() string
	// GetPodID returns the pod ID of the container.
	GetPodID() string
	// GetName returns the name of the container.
	GetName() string
	// GetNamespace returns the namespace of the container.
	GetNamespace() string
	// GetCtime returns the creation time of the container cache object.
	GetCtime() time.Time
	// UpdateState updates the state of the container.
	UpdateState(ContainerState)
	// GetState returns the ContainerState of the container.
	GetState() ContainerState
	// GetQOSClass returns the QoS class the pod would have if this was its only container.
	GetQOSClass() v1.PodQOSClass
	// GetArgs returns the container command arguments.
	GetArgs() []string
	// GetLabel returns the value of a container label.
	GetLabel(string) (string, bool)
	// GetAnnotation returns the value of a container annotation.
	GetAnnotation(key string, objPtr interface{}) (string, bool)
	// GetEnv returns the value of a container environment variable.
	GetEnv(string) (string, bool)
	// GetMounts returns all the mounts of the container.
	GetMounts() []*Mount
	// GetDevices returns all the linux devices of the container.
	GetDevices() []*Device

	// PrettyName returns the user-friendly $namespace/$pod/$container for the container.
	PrettyName() string

	// GetResmgrLabel returns the value of a container label from the
	// nri-resource-policy namespace.
	GetResmgrLabel(string) (string, bool)
	// GetResmgrAnnotation returns the value of a container annotation from the
	// nri-resource-policy namespace.
	GetResmgrAnnotation(key string, objPtr interface{}) (string, bool)
	// GetEffectiveAnnotation returns the effective annotation for the container from the pod.
	GetEffectiveAnnotation(key string) (string, bool)

	// Containers can be subject for expression evaluation.
	resmgr.Evaluable

	// Expand a string with possible key references.
	Expand(string, bool) (string, error)

	// We have String() for containers.
	fmt.Stringer

	// GetResourceRequirements returns the resource requirements for this container.
	// The requirements are calculated from the containers cgroup parameters.
	GetResourceRequirements() v1.ResourceRequirements

	// SetResourceUpdates sets updated resources for a container. Returns true if the
	// resources were really updated.
	SetResourceUpdates(*nri.LinuxResources) bool
	// GetResourceUpdates() returns any updated resource requirements for this container.
	// The updates are calculated from the cgroups parameters in the resource update.
	GetResourceUpdates() (v1.ResourceRequirements, bool)

	// InsertMount inserts a mount into the container.
	InsertMount(*Mount)

	// Get any attached topology hints.
	GetTopologyHints() topology.Hints

	// SetCPUShares sets the CFS CPU shares of the container.
	SetCPUShares(int64)
	// SetCPUQuota sets the CFS CPU quota of the container.
	SetCPUQuota(int64)
	// SetCPUPeriod sets the CFS CPU period of the container.
	SetCPUPeriod(int64)
	// SetCpusetCpu sets the cgroup cpuset.cpus of the container.
	SetCpusetCpus(string)
	// SetCpusetMems sets the cgroup cpuset.mems of the container.
	SetCpusetMems(string)
	// SetMemoryLimit sets the memory limit in bytes for the container.
	SetMemoryLimit(int64)
	// SetMemorySwap sets the swap limit in bytes for the container.
	SetMemorySwap(int64)

	// GetCPUShares gets the CFS CPU shares of the container.
	GetCPUShares() int64
	// GetCPUQuota gets the CFS CPU quota of the container.
	GetCPUQuota() int64
	// GetCPUPeriod gets the CFS CPU period of the container.
	GetCPUPeriod() int64
	// GetCpusetCpu gets the cgroup cpuset.cpus of the container.
	GetCpusetCpus() string
	// GetCpusetMems gets the cgroup cpuset.mems of the container.
	GetCpusetMems() string
	// GetMemoryLimit gets the memory limit in bytes for the container.
	GetMemoryLimit() int64
	// GetMemorySwap gets the swap limit in bytes for the container.
	GetMemorySwap() int64

	// PreserveCpuResources() returns true if CPU resources of the
	// container must not be changed.
	PreserveCpuResources() bool
	// PreserveMemoryResources() returns true if memory resources
	// of the container must not be changed.
	PreserveMemoryResources() bool

	// GetPendingAdjusmentn clears and returns any pending adjustment for the container.
	GetPendingAdjustment() *nri.ContainerAdjustment
	// GetPendingUpdate clears and returns any pending update for the container.
	GetPendingUpdate() *nri.ContainerUpdate

	// GetAffinity returns the annotated affinity expressions for this container.
	GetAffinity() ([]*Affinity, error)

	// GetCgroupDir returns the relative path of the cgroup directory for the container.
	GetCgroupDir() string

	// SetRDTClass assigns this container to the given RDT class.
	SetRDTClass(string)
	// GetRDTClass returns the RDT class for this container.
	GetRDTClass() string

	// SetBlockIOClass assigns this container to the given BlockIO class.
	SetBlockIOClass(string)
	// GetBlockIOClass returns the BlockIO class for this container.
	GetBlockIOClass() string

	// GetProcesses returns the pids of processes in the container.
	GetProcesses() ([]string, error)
	// GetTasks returns the pids of threads in the container.
	GetTasks() ([]string, error)

	// GetPending gets the names of the controllers with pending changes.
	GetPending() []string
	// HasPending checks if the container has pending chanhes for the given controller.
	HasPending(string) bool
	// ClearPending clears the pending change marker for the given controller.
	ClearPending(string)

	// GetTag gets the value of the given tag.
	GetTag(string) (string, bool)
	// SetTag sets the value of the given tag and returns its previous value..
	SetTag(string, string) (string, bool)
	// DeleteTag deletes the given tag, returning its deleted value.
	DeleteTag(string) (string, bool)
}

type ContainerState = nri.ContainerState

type Device = nri.LinuxDevice

type Expression struct {
	resmgr.Expression
}

type ImplicitAffinity func(Container, bool) *Affinity

type MatchType int

type Mount = nri.Mount

type Options struct {
	// CacheDir is the directory the cache should save its state in.
	CacheDir string
}

type PathList struct {
	Type  MatchType `yaml:"type"`
	Paths []string  `yaml:"paths"`
}

type Pod interface {
	// GetContainers returns the containers of the pod.
	GetContainers() []Container
	// GetId returns the pod id of the pod.
	GetID() string
	// GetUID returns the (kubernetes) unique id of the pod.
	GetUID() string
	// GetName returns the name of the pod.
	GetName() string
	// GetNamespace returns the namespace of the pod.
	GetNamespace() string
	// GetCtime returns the creation time of the pod cache object.
	GetCtime() time.Time
	// GetQOSClass returns the PodQOSClass of the pod.
	GetQOSClass() v1.PodQOSClass
	// GetLabel returns the value of the given label and whether it was found.
	GetLabel(string) (string, bool)
	// GetAnnotation returns the value of the given annotation and whether it was found.
	GetAnnotation(key string) (string, bool)
	// GetCgroupParent returns the pods cgroup parent directory.
	GetCgroupParent() string

	// PrettyName returns $namespace/$name as the pretty name for the pod.
	PrettyName() string

	// GetResmgrLabel returns the value of a pod label from the
	// nri-resource-policy namespace.
	GetResmgrLabel(string) (string, bool)
	// GetAnnotation returns the value of a pod annotation from the
	// nri-resource-policy namespace and whether it was found.
	GetResmgrAnnotation(key string) (string, bool)
	// GetEffectiveAnnotation returns the effective annotation for a container.
	// For any given key $K and container $C it will look for annotations in
	// this order and return the first one found:
	//     $K/container.$C
	//     $K/pod
	//     $K
	// and return the value of the first key found.
	GetEffectiveAnnotation(key, container string) (string, bool)

	// GetContainerAffinity returns the affinity expressions for the named container.
	GetContainerAffinity(string) ([]*Affinity, error)
	// ScopeExpression returns an affinity expression for defining this pod as the scope.
	ScopeExpression() *resmgr.Expression

	// Pods can be subject for expression evaluation.
	resmgr.Evaluable

	// Expand a string with possible key references.
	Expand(string, bool) (string, error)

	// We have String() for pods.
	fmt.Stringer

	// GetProcesses returns the pids of all processes in the pod either excluding
	// container processes, if called with false, or including those if called with true.
	GetProcesses(bool) ([]string, error)
	// GetTasks returns the pids of all threads in the pod either excluding cotnainer
	// processes, if called with false, or including those if called with true.
	GetTasks(bool) ([]string, error)
}

type PodState int32