Add support for windows CPU affinity by kiashok · Pull Request #1258 · opencontainers/runtime-spec

kiashok · 2024-06-20T23:18:07Z

This PR adds support for certain CRI fields in OCI runtime spec for supporting CPU affinity for windows containers.

CRI PR : kubernetes/kubernetes#124285
Github issue: kubernetes/kubernetes#125262
KEP: kubernetes/kubernetes#125262

kiashok · 2024-06-20T23:19:07Z

cc @jsturtevant @kevpar @aravindhp @marosset

kiashok · 2024-06-20T23:21:17Z

@AkihiroSuda @thaJeztah could you please take a look? :) thanks!

tianon · 2024-06-28T02:50:15Z

Is there a compelling reason not to roughly match the naming convention adopted for Linux in #1253?

Also, please don't mark conversations with useful discussion/links as "resolved" especially if the PR itself didn't change as a result of the discussion but the discussion is still useful and potentially something someone else might reasonably ask about or want to discuss -- it makes them much more difficult to discover when reading the PR's comments.

jsturtevant · 2024-07-09T15:31:38Z

Is there a compelling reason not to roughly match the naming convention adopted for Linux in #1253?

For cpu's, Linux is a simple list where as on windows it is a bitmap with a group number (https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/miniport/ns-miniport-_group_affinity) and the naming/structure was used to map to those Windows specific concepts

For memory, I think it was the same idea, making sure it was known this is "perferred" but not guarenteed do to the Windows API's. Depending on outcome of #1258 (comment) we might not have this field

kiashok · 2024-09-17T19:19:43Z

@AkihiroSuda @kevpar addressed review comments. Would you be able to take a look when you have some time please? Thanks!

kolyshkin · 2024-09-18T01:30:13Z

 * **`count`** *(uint64, OPTIONAL)* - specifies the number of CPUs available to the container. It represents the fraction of the configured processor `count` in a container in relation to the processors available in the host. The fraction ultimately determines the portion of processor cycles that the threads in a container can use during each scheduling interval, as the number of cycles per 10,000 cycles.
 * **`shares`** *(uint16, OPTIONAL)* - limits the share of processor time given to the container relative to other workloads on the processor. The processor `shares` (`weight` at the platform level) is a value between 0 and 10,000.
 * **`maximum`** *(uint16, OPTIONAL)* - determines the portion of processor cycles that the threads in a container can use during each scheduling interval, as the number of cycles per 10,000 cycles. Set processor `maximum` to a percentage times 100.
+* **`affinityCPUs`** *(array of objects, OPTIONAL)* - specifies the set of CPU to affinitize for this container.


nit: why not just affinity (since this is a part of cpu struct/group, and other (ajacent) fields do not have CPU in them)

Answering to myself.

I see that earlier version had affinityCPUs and AffinityPreferredNumaNodes, but the latter was dropped.

Still, affinity would work, and, if we're to add NUMA affinity later, a name like NUMAaffinity (or affinityNUMA) would still work.

The sub fields could also be mask and group accordingly 👀

Indeed. The less tautology the better.

@tianon @kolyshkin keeping it similar to how we've defined this in k/k proto file. There was a similar comment in that PR : kubernetes/kubernetes#124285 (comment)

group alone is a keyword in .proto so we couldn't just have mask or group. Thought uniformity would be good across the fields- prefix "cpu" in both fields or neither.

similar rationale to why affinityCPUs was used :

It is part of WindowsContainerResources struct which can mean cpus/memory or any other resource. So we named it affinityCPUs there. I understand that this struct in runtimespec is specifically for CPU alone. So if you would prefer me to drop "cpu" and just use "affinity" let me know, I can have that updated. Thanks.

I imagine there's got to be a way to convince Protobuf to use a keyword as an identifier, right? Some way to escape it?

Regardless, this spec is for a canonically-JSON-format, which doesn't have any constraints like that (or reserved keys at all), so I definitely still agree with @kolyshkin that we should ditch the duplication in the names and go for the simpler and more consistent all-lowercase versions (affinity or affinities, group, and mask).

@tianon have addressed this. Please take a look and let me know if it looks good. Thanks.

kiashok · 2024-10-20T14:39:56Z

@tianon @kolyshkin @kevpar @jsturtevant could you please take a look at this PR when you have some time please? Thanks!

jsturtevant · 2024-10-21T15:57:00Z

/lgtm
for the functionality, I will defer to the reviewers here on the naming discussion

rchincha · 2024-10-28T21:17:07Z

 	// 100.
 	Maximum *uint16 `json:"maximum,omitempty"`
+	// Set of CPUs to affinitize for this container.
+	AffinityCPUs []WindowsCPUGroupAffinity `json:"affinityCPUs,omitempty"`


Why is this specific to "Windows"? CPU affinity is more general?

The specific structure/fields supported are Windows-specific -- see https://github.com/opencontainers/runtime-spec/blob/8f3fbc881602d85699e5c448634ec1288860d966/config.md#:~:text=to%207%20(lowest).-,execCPUAffinity,-(object%2C%20OPTIONAL)%20specifies (execCPUAffinity) for how this is specified on Linux (part of the process object).

kiashok · 2024-11-13T16:44:37Z

@tianon @kolyshkin @AkihiroSuda @thaJeztah could you please take a look when you have a chance please? thanks!

jsturtevant · 2024-12-03T23:05:01Z

LGTM

@tianon @kevpar @kolyshkin could you give a final look?

kevpar

LGTM

tianon

A couple really minor nits, but I think this is probably fine.

Maybe we need to update the JSON schema also?

runtime-spec/schema/config-windows.json

Lines 30 to 43 in 09fcb39

    
           "cpu": { 
        
               "type": "object", 
        
               "properties": { 
        
                   "count": { 
        
                       "$ref": "defs.json#/definitions/uint64" 
        
                   }, 
        
                   "shares": { 
        
                       "$ref": "defs.json#/definitions/uint16" 
        
                   }, 
        
                   "maximum": { 
        
                       "$ref": "defs.json#/definitions/uint16" 
        
                   } 
        
               } 
        
           },

tianon · 2024-12-14T08:39:46Z

+
+  Each entry has the following structure:
+
+  Ref: https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/miniport/ns-miniport-_group_affinity


I think this ref should probably be after the list (like the other one in this same section), but it is a little odd then to have the ref for count+shares+maximum follow immediately. 🤔 Maybe it's fine (since the indentation should make it clear which is which)? Maybe that's why you chose to put it here instead of matching the outer pattern?

yeah that's right - I thought keeping it closest to the declaration might help. The indentation is helping keep it readable.

Signed-off-by: Kirtana Ashok <kiashok@microsoft.com>

kiashok · 2024-12-16T18:28:47Z

A couple really minor nits, but I think this is probably fine.

Maybe we need to update the JSON schema also?

runtime-spec/schema/config-windows.json

Lines 30 to 43 in 09fcb39

"cpu": {

"type": "object",

"properties": {

"count": {

"$ref": "defs.json#/definitions/uint64"

},

"shares": {

"$ref": "defs.json#/definitions/uint16"

},

"maximum": {

"$ref": "defs.json#/definitions/uint16"

}

}

},

Addressed this!

kiashok · 2024-12-26T18:28:34Z

@tianon would you be able to take a look at this PR when you have a chance please? Thanks!

jsturtevant · 2025-01-06T17:57:19Z

LGTM

kiashok requested review from AkihiroSuda, crosbymichael, cyphar, dqminh, giuseppe, hqhq, kolyshkin, mrunalp, thaJeztah, tianon and utam0k as code owners June 20, 2024 23:18

AkihiroSuda reviewed Jun 21, 2024

View reviewed changes

Comment thread specs-go/config.go

kevpar reviewed Jun 21, 2024

View reviewed changes

Comment thread specs-go/config.go Outdated

kevpar reviewed Jun 21, 2024

View reviewed changes

Comment thread specs-go/config.go Outdated

kevpar reviewed Jun 21, 2024

View reviewed changes

Comment thread specs-go/config.go Outdated

kiashok force-pushed the cpuAffinity-oci branch from e9d4443 to e85a1c8 Compare June 26, 2024 23:42

kiashok force-pushed the cpuAffinity-oci branch from e85a1c8 to fd1ac23 Compare September 5, 2024 21:00

kevpar reviewed Sep 16, 2024

View reviewed changes

Comment thread config-windows.md Outdated

kiashok force-pushed the cpuAffinity-oci branch from fd1ac23 to 6be4095 Compare September 17, 2024 19:18

kolyshkin reviewed Sep 18, 2024

View reviewed changes

Comment thread config-windows.md Outdated

kevpar reviewed Sep 24, 2024

View reviewed changes

Comment thread config-windows.md Outdated

jsturtevant mentioned this pull request Sep 30, 2024

Windows CPU and Memory Affinity kubernetes/enhancements#4885

Open

9 tasks

kiashok force-pushed the cpuAffinity-oci branch from 6be4095 to 0679c9d Compare October 2, 2024 16:52

jsturtevant mentioned this pull request Oct 21, 2024

Docs: Windows CPU and Memory Affinity kubernetes/website#48469

Merged

rchincha reviewed Oct 28, 2024

View reviewed changes

kiashok force-pushed the cpuAffinity-oci branch from 0679c9d to 1ef7ea5 Compare October 29, 2024 13:04

kevpar reviewed Nov 13, 2024

View reviewed changes

Comment thread config-windows.md Outdated

kevpar reviewed Nov 13, 2024

View reviewed changes

Comment thread specs-go/config.go Outdated

kevpar reviewed Nov 13, 2024

View reviewed changes

Comment thread config-windows.md Outdated

kiashok force-pushed the cpuAffinity-oci branch from 1ef7ea5 to d71e8e3 Compare November 13, 2024 16:41

kevpar reviewed Nov 20, 2024

View reviewed changes

Comment thread config-windows.md Outdated

kevpar reviewed Nov 20, 2024

View reviewed changes

Comment thread specs-go/config.go Outdated

kiashok force-pushed the cpuAffinity-oci branch from d71e8e3 to e0be0a1 Compare December 2, 2024 18:08

kevpar reviewed Dec 5, 2024

View reviewed changes

Comment thread config-windows.md Outdated

kiashok force-pushed the cpuAffinity-oci branch from e0be0a1 to fd2f1d3 Compare December 9, 2024 02:42

kevpar approved these changes Dec 13, 2024

View reviewed changes

tianon reviewed Dec 14, 2024

View reviewed changes

Add support for windows CPU affinity

b9e8fdb

Signed-off-by: Kirtana Ashok <kiashok@microsoft.com>

kiashok force-pushed the cpuAffinity-oci branch from fd2f1d3 to b9e8fdb Compare December 16, 2024 18:28

AkihiroSuda added this to the v1.2.1 (tentative) milestone Jan 6, 2025

AkihiroSuda approved these changes Jan 6, 2025

View reviewed changes

AkihiroSuda merged commit d61dee6 into opencontainers:main Jan 6, 2025

thaJeztah mentioned this pull request Feb 26, 2025

Release v1.2.1 #1278

Merged

11 tasks

	"cpu": {
	"type": "object",
	"properties": {
	"count": {
	"$ref": "defs.json#/definitions/uint64"
	},
	"shares": {
	"$ref": "defs.json#/definitions/uint16"
	},
	"maximum": {
	"$ref": "defs.json#/definitions/uint16"
	}
	}
	},


		Each entry has the following structure:

		Ref: https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/miniport/ns-miniport-_group_affinity

Conversation

kiashok commented Jun 20, 2024

Uh oh!

kiashok commented Jun 20, 2024

Uh oh!

kiashok commented Jun 20, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tianon commented Jun 28, 2024

Uh oh!

jsturtevant commented Jul 9, 2024

Uh oh!

Uh oh!

kiashok commented Sep 17, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kiashok commented Oct 20, 2024

Uh oh!

jsturtevant commented Oct 21, 2024

Uh oh!

rchincha Oct 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kiashok commented Nov 13, 2024

Uh oh!

Uh oh!

Uh oh!

jsturtevant commented Dec 3, 2024

Uh oh!

Uh oh!

kevpar left a comment

Choose a reason for hiding this comment

Uh oh!

tianon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kiashok commented Dec 16, 2024

Uh oh!

kiashok commented Dec 26, 2024

Uh oh!

jsturtevant commented Jan 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

rchincha Oct 28, 2024 •

edited

Loading