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.

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

source/cpu: detect Intel SGX #647

Merged
merged 1 commit into from
Nov 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/get-started/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ The **cpu** feature source supports the following labels:
| | RDTL3CA | Intel L3 Cache Allocation Technology
| | RDTL2CA | Intel L2 Cache Allocation Technology
| | RDTMBA | Intel Memory Bandwidth Allocation (MBA) Technology
| sgx | enabled | Set to 'true' if Intel SGX is enabled in BIOS (based a non-zero sum value of SGX EPC section sizes).

The (sub-)set of CPUID attributes to publish is configurable via the
`attributeBlacklist` and `attributeWhitelist` cpuid options of the cpu source.
Expand Down
9 changes: 9 additions & 0 deletions source/cpu/cpu.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ const (
CstateFeature = "cstate"
PstateFeature = "pstate"
RdtFeature = "rdt"
SgxFeature = "sgx"
SstFeature = "sst"
TopologyFeature = "topology"
)
Expand Down Expand Up @@ -153,6 +154,11 @@ func (s *cpuSource) GetLabels() (source.FeatureLabels, error) {
labels["rdt."+k] = true
}

// SGX
for k, v := range features.Values[SgxFeature].Elements {
labels["sgx."+k] = v
}

// SST
for k, v := range features.Values[SstFeature].Elements {
labels["power.sst_"+k] = v
Expand Down Expand Up @@ -191,6 +197,9 @@ func (s *cpuSource) Discover() error {
// Detect RDT features
s.features.Keys[RdtFeature] = feature.NewKeyFeatures(discoverRDT()...)

// Detect SGX features
s.features.Values[SgxFeature] = feature.NewValueFeatures(discoverSGX())

// Detect SST features
s.features.Values[SstFeature] = feature.NewValueFeatures(discoverSST())

Expand Down
46 changes: 46 additions & 0 deletions source/cpu/sgx_amd64.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
//go:build amd64
// +build amd64

/*
Copyright 2021 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package cpu

import (
"github.com/klauspost/cpuid/v2"
)

func discoverSGX() map[string]string {
var epcSize uint64
sgx := make(map[string]string)

if cpuid.CPU.SGX.Available {
for _, s := range cpuid.CPU.SGX.EPCSections {
epcSize += s.EPCSize
}
}

// Set to 'true' based a non-zero sum value of SGX EPC section sizes. The
// kernel checks for IA32_FEATURE_CONTROL.SGX_ENABLE MSR bit but we can't
// do that as a normal user. Typically the BIOS, when enabling SGX,
// allocates "Processor Reserved Memory" for SGX EPC so we rely on > 0
// size here to set "SGX = enabled".
if epcSize > 0 {
sgx["enabled"] = "true"
}
Comment on lines +41 to +43
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we advertise epcSize as the raw feature, directly?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wanted to start with something minimal/basic and enabled is consistent with the other cpusource features. The boolean value can be taken into nodeSelector directly which is my use case at least until #464 lands. Would there be any use for epcSize other than using it in, e.g., {op: Gt, value: ["0"]}?

I'm thinking about these max enclave size etc.

I'm not sure how useful they are. We could label, e.g., sgx2=true but to actually use the feature the kernel support needs to be there and we cannot detect that. max enclave size value is a bit value for 2^(<value>) computation.

Copy link
Contributor

Choose a reason for hiding this comment

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

I wanted to start with something minimal/basic and enabled is consistent with the other cpusource features. The boolean value can be taken into nodeSelector directly which is my use case at least until #464 lands. Would there be any use for epcSize other than using it in, e.g., {op: Gt, value: ["0"]}?

Yeah, for the label enabled makes sense. I might be wrong but my intuition is that the better direction would be to expose "raw features" as raw as possible, avoiding any translations. More likely to avoid problems like the kernel module values (currently =y and =m now translate to true and we have no means of telling between y or m). As you said, in this case enabled would translate to {op: Gt, value: ["0"]} in the custom rules. That said, I don't know what use people could find for the numerical value (expose it as an extended resource?). Maybe we should expose both, enabled and epcSize?

I'm thinking about these max enclave size etc.

I'm not sure how useful they are. We could label, e.g., sgx2=true but to actually use the feature the kernel support needs to be there and we cannot detect that. max enclave size value is a bit value for 2^(<value>) computation.

K, can be added later, if needed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

expose it as an extended resource?). Maybe we should expose both, enabled and epcSize?

We have an NFD source hook to read epcSize and that value is registered as sgx.intel.com/epc. I guess NFD could register the value too but why not then use the NFD source hook because it comes with the device plugin that is also needed.


return sgx
}
24 changes: 24 additions & 0 deletions source/cpu/sgx_stub.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
//go:build !amd64
// +build !amd64

/*
Copyright 2021 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package cpu

func discoverSGX() map[string]string {
return nil
}