Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for windows CPU affinity #1258

Merged
merged 1 commit into from
Jan 6, 2025
Merged

Add support for windows CPU affinity #1258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions config-windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,14 @@ The following parameters can be specified (mutually exclusive):
* **`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.
* **`affinity`** *(array of objects, OPTIONAL)* - specifies the set of CPU to affinitize for this container.

Each entry has the following structure:

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


* **`mask`** *(uint64, REQUIRED)* - specifies the CPU mask relative to this CPU group.
* **`group`** *(uint32, REQUIRED)* - specifies the processor group this mask refers to, as returned by GetLogicalProcessorInformationEx.

Ref: https://docs.microsoft.com/en-us/virtualization/api/hcs/schemareference#Container_Processor

Expand Down
11 changes: 11 additions & 0 deletions schema/config-windows.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,17 @@
},
"maximum": {
"$ref": "defs.json#/definitions/uint16"
},
"affinity": {
"type": "object",
"properties": {
"mask": {
"$ref": "defs.json#/definitions/uint64"
},
"group": {
"$ref": "defs.json#/definitions/uint32"
}
}
}
}
},
Expand Down
11 changes: 11 additions & 0 deletions specs-go/config.go
View file
Open in desktop
kiashok marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,17 @@ type WindowsCPUResources struct {
// cycles per 10,000 cycles. Set processor `maximum` to a percentage times
// 100.
Maximum *uint16 `json:"maximum,omitempty"`
// Set of CPUs to affinitize for this container.
Affinity []WindowsCPUGroupAffinity `json:"affinity,omitempty"`
}

// Similar to _GROUP_AFFINITY struct defined in
// https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/miniport/ns-miniport-_group_affinity
type WindowsCPUGroupAffinity struct {
// CPU mask relative to this CPU group.
Mask uint64 `json:"mask,omitempty"`
// Processor group the mask refers to, as returned by GetLogicalProcessorInformationEx.
Group uint32 `json:"group,omitempty"`
}

// WindowsStorageResources contains storage resource management settings.
Expand Down
Loading