Split scheduler's PodInfo into two types, PodInfo and PodQueueInfo

Author: ahg-g

pkg/scheduler/factory.go

@@ -456,8 +456,8 @@ func NewPodInformer(client clientset.Interface, resyncPeriod time.Duration) core
 }
 
 // MakeDefaultErrorFunc construct a function to handle pod scheduler error
-func MakeDefaultErrorFunc(client clientset.Interface, podQueue internalqueue.SchedulingQueue, schedulerCache internalcache.Cache) func(*framework.PodInfo, error) {
-	return func(podInfo *framework.PodInfo, err error) {
+func MakeDefaultErrorFunc(client clientset.Interface, podQueue internalqueue.SchedulingQueue, schedulerCache internalcache.Cache) func(*framework.QueuedPodInfo, error) {
+	return func(podInfo *framework.QueuedPodInfo, err error) {
 		pod := podInfo.Pod
 		if err == core.ErrNoNodesAvailable {
 			klog.V(2).Infof("Unable to schedule %v/%v: no nodes are registered to the cluster; waiting", pod.Namespace, pod.Name)

pkg/scheduler/factory_test.go

@@ -328,7 +328,7 @@ func TestDefaultErrorFunc(t *testing.T) {
 		&v1.Node{ObjectMeta: metav1.ObjectMeta{Name: "bar"}},
 		&v1.Node{ObjectMeta: metav1.ObjectMeta{Name: "foo"}}
 
-	testPodInfo := &framework.PodInfo{Pod: testPod}
+	testPodInfo := &framework.QueuedPodInfo{Pod: testPod}
 	client := fake.NewSimpleClientset(&v1.PodList{Items: []v1.Pod{*testPod}}, &v1.NodeList{Items: []v1.Node{*nodeBar}})
 	stopCh := make(chan struct{})
 	defer close(stopCh)

pkg/scheduler/framework/plugins/queuesort/priority_sort.go

@@ -37,8 +37,8 @@ func (pl *PrioritySort) Name() string {
 
 // Less is the function used by the activeQ heap algorithm to sort pods.
 // It sorts pods based on their priority. When priorities are equal, it uses
-// PodInfo.timestamp.
-func (pl *PrioritySort) Less(pInfo1, pInfo2 *framework.PodInfo) bool {
+// PodQueueInfo.timestamp.
+func (pl *PrioritySort) Less(pInfo1, pInfo2 *framework.QueuedPodInfo) bool {
 	p1 := pod.GetPodPriority(pInfo1.Pod)
 	p2 := pod.GetPodPriority(pInfo2.Pod)
 	return (p1 > p2) || (p1 == p2 && pInfo1.Timestamp.Before(pInfo2.Timestamp))

pkg/scheduler/framework/plugins/queuesort/priority_sort_test.go

@@ -31,20 +31,20 @@ func TestLess(t *testing.T) {
 	t2 := t1.Add(time.Second)
 	for _, tt := range []struct {
 		name     string
-		p1       *framework.PodInfo
-		p2       *framework.PodInfo
+		p1       *framework.QueuedPodInfo
+		p2       *framework.QueuedPodInfo
 		expected bool
 	}{
 		{
 			name: "p1.priority less than p2.priority",
-			p1: &framework.PodInfo{
+			p1: &framework.QueuedPodInfo{
 				Pod: &v1.Pod{
 					Spec: v1.PodSpec{
 						Priority: &lowPriority,
 					},
 				},
 			},
-			p2: &framework.PodInfo{
+			p2: &framework.QueuedPodInfo{
 				Pod: &v1.Pod{
 					Spec: v1.PodSpec{
 						Priority: &highPriority,
@@ -55,14 +55,14 @@ func TestLess(t *testing.T) {
 		},
 		{
 			name: "p1.priority greater than p2.priority",
-			p1: &framework.PodInfo{
+			p1: &framework.QueuedPodInfo{
 				Pod: &v1.Pod{
 					Spec: v1.PodSpec{
 						Priority: &highPriority,
 					},
 				},
 			},
-			p2: &framework.PodInfo{
+			p2: &framework.QueuedPodInfo{
 				Pod: &v1.Pod{
 					Spec: v1.PodSpec{
 						Priority: &lowPriority,
@@ -73,15 +73,15 @@ func TestLess(t *testing.T) {
 		},
 		{
 			name: "equal priority. p1 is added to schedulingQ earlier than p2",
-			p1: &framework.PodInfo{
+			p1: &framework.QueuedPodInfo{
 				Pod: &v1.Pod{
 					Spec: v1.PodSpec{
 						Priority: &highPriority,
 					},
 				},
 				Timestamp: t1,
 			},
-			p2: &framework.PodInfo{
+			p2: &framework.QueuedPodInfo{
 				Pod: &v1.Pod{
 					Spec: v1.PodSpec{
 						Priority: &highPriority,
@@ -93,15 +93,15 @@ func TestLess(t *testing.T) {
 		},
 		{
 			name: "equal priority. p2 is added to schedulingQ earlier than p1",
-			p1: &framework.PodInfo{
+			p1: &framework.QueuedPodInfo{
 				Pod: &v1.Pod{
 					Spec: v1.PodSpec{
 						Priority: &highPriority,
 					},
 				},
 				Timestamp: t2,
 			},
-			p2: &framework.PodInfo{
+			p2: &framework.QueuedPodInfo{
 				Pod: &v1.Pod{
 					Spec: v1.PodSpec{
 						Priority: &highPriority,

pkg/scheduler/framework/v1alpha1/framework.go

@@ -295,7 +295,7 @@ func (f *framework) QueueSortFunc() LessFunc {
 	if f == nil {
 		// If framework is nil, simply keep their order unchanged.
 		// NOTE: this is primarily for tests.
-		return func(_, _ *PodInfo) bool { return false }
+		return func(_, _ *QueuedPodInfo) bool { return false }
 	}
 
 	if len(f.queueSortPlugins) == 0 {

pkg/scheduler/framework/v1alpha1/framework_test.go

@@ -288,7 +288,7 @@ func (pl *TestQueueSortPlugin) Name() string {
 	return queueSortPlugin
 }
 
-func (pl *TestQueueSortPlugin) Less(_, _ *PodInfo) bool {
+func (pl *TestQueueSortPlugin) Less(_, _ *QueuedPodInfo) bool {
 	return false
 }
 

pkg/scheduler/framework/v1alpha1/interface.go

@@ -211,15 +211,15 @@ type Plugin interface {
 }
 
 // LessFunc is the function to sort pod info
-type LessFunc func(podInfo1, podInfo2 *PodInfo) bool
+type LessFunc func(podInfo1, podInfo2 *QueuedPodInfo) bool
 
 // QueueSortPlugin is an interface that must be implemented by "QueueSort" plugins.
 // These plugins are used to sort pods in the scheduling queue. Only one queue sort
 // plugin may be enabled at a time.
 type QueueSortPlugin interface {
 	Plugin
 	// Less are used to sort pods in the scheduling queue.
-	Less(*PodInfo, *PodInfo) bool
+	Less(*QueuedPodInfo, *QueuedPodInfo) bool
 }
 
 // PreFilterExtensions is an interface that is included in plugins that allow specifying

pkg/scheduler/framework/v1alpha1/types.go

@@ -34,9 +34,10 @@ import (
 
 var generation int64
 
-// PodInfo is a wrapper to a Pod with additional information for purposes such as tracking
-// the timestamp when it's added to the queue or recording per-pod metrics.
-type PodInfo struct {
+// QueuedPodInfo is a Pod wrapper with additional information related to
+// the pod's status in the scheduling queue, such as the timestamp when
+// it's added to the queue.
+type QueuedPodInfo struct {
 	Pod *v1.Pod
 	// The time pod added to the scheduling queue.
 	Timestamp time.Time
@@ -50,16 +51,23 @@ type PodInfo struct {
 	InitialAttemptTimestamp time.Time
 }
 
-// DeepCopy returns a deep copy of the PodInfo object.
-func (podInfo *PodInfo) DeepCopy() *PodInfo {
-	return &PodInfo{
-		Pod:                     podInfo.Pod.DeepCopy(),
-		Timestamp:               podInfo.Timestamp,
-		Attempts:                podInfo.Attempts,
-		InitialAttemptTimestamp: podInfo.InitialAttemptTimestamp,
+// DeepCopy returns a deep copy of the QueuedPodInfo object.
+func (pqi *QueuedPodInfo) DeepCopy() *QueuedPodInfo {
+	return &QueuedPodInfo{
+		Pod:                     pqi.Pod.DeepCopy(),
+		Timestamp:               pqi.Timestamp,
+		Attempts:                pqi.Attempts,
+		InitialAttemptTimestamp: pqi.InitialAttemptTimestamp,
 	}
 }
 
+// PodInfo is a wrapper to a Pod with additional pre-computed information to
+// accelerate processing. This information is typically immutable (e.g., pre-processed
+// inter-pod affinity selectors).
+type PodInfo struct {
+	Pod *v1.Pod
+}
+
 // NewPodInfo return a new PodInfo
 func NewPodInfo(pod *v1.Pod) *PodInfo {
 	return &PodInfo{
@@ -359,7 +367,6 @@ func (n *NodeInfo) String() string {
 
 // AddPod adds pod information to this NodeInfo.
 func (n *NodeInfo) AddPod(pod *v1.Pod) {
-	// TODO(#89528): AddPod should accept a PodInfo as an input argument.
 	podInfo := NewPodInfo(pod)
 	res, non0CPU, non0Mem := calculateResource(pod)
 	n.Requested.MilliCPU += res.MilliCPU