summaryrefslogtreecommitdiffhomepage
path: root/pkg/cpuid/cpuid_test.go
blob: 35e7b8e50e2e52a53af01471d91527517caf2768 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
// Copyright 2018 Google LLC
//
// 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 cpuid

import (
	"testing"
)

// These are the default values of various FeatureSet fields.
const (
	defaultVendorID = "GenuineIntel"

	// These processor signature defaults are derived from the values
	// listed in Intel Application Note 485 for i7/Xeon processors.
	defaultExtFamily  uint8 = 0
	defaultExtModel   uint8 = 1
	defaultType       uint8 = 0
	defaultFamily     uint8 = 0x06
	defaultModel      uint8 = 0x0a
	defaultSteppingID uint8 = 0
)

// newEmptyFeatureSet creates a new FeatureSet with a sensible default model and no features.
func newEmptyFeatureSet() *FeatureSet {
	return &FeatureSet{
		Set:            make(map[Feature]bool),
		VendorID:       defaultVendorID,
		ExtendedFamily: defaultExtFamily,
		ExtendedModel:  defaultExtModel,
		ProcessorType:  defaultType,
		Family:         defaultFamily,
		Model:          defaultModel,
		SteppingID:     defaultSteppingID,
	}
}

var justFPU = &FeatureSet{
	Set: map[Feature]bool{
		X86FeatureFPU: true,
	}}

var justFPUandPAE = &FeatureSet{
	Set: map[Feature]bool{
		X86FeatureFPU: true,
		X86FeaturePAE: true,
	}}

func TestIsSubset(t *testing.T) {
	if !justFPU.IsSubset(justFPUandPAE) {
		t.Errorf("Got %v is not subset of %v, want IsSubset being true", justFPU, justFPUandPAE)
	}

	if justFPUandPAE.IsSubset(justFPU) {
		t.Errorf("Got %v is a subset of %v, want IsSubset being false", justFPU, justFPUandPAE)
	}
}

func TestTakeFeatureIntersection(t *testing.T) {
	testFeatures := HostFeatureSet()
	testFeatures.TakeFeatureIntersection(justFPU)
	if !testFeatures.IsSubset(justFPU) {
		t.Errorf("Got more features than expected after intersecting host features with justFPU: %v, want %v", testFeatures.Set, justFPU.Set)
	}
	if !testFeatures.HasFeature(X86FeatureFPU) {
		t.Errorf("Got no features in testFeatures after intersecting, want %v", X86FeatureFPU)
	}
}

// TODO: Run this test on a very old platform, and make sure more
// bits are enabled than just FPU and PAE. This test currently may not detect
// if HostFeatureSet gives back junk bits.
func TestHostFeatureSet(t *testing.T) {
	hostFeatures := HostFeatureSet()
	if !justFPUandPAE.IsSubset(hostFeatures) {
		t.Errorf("Got invalid feature set %v from HostFeatureSet()", hostFeatures)
	}
}

func TestHasFeature(t *testing.T) {
	if !justFPU.HasFeature(X86FeatureFPU) {
		t.Errorf("HasFeature failed, %v should contain %v", justFPU, X86FeatureFPU)
	}

	if justFPU.HasFeature(X86FeatureAVX) {
		t.Errorf("HasFeature failed, %v should not contain %v", justFPU, X86FeatureAVX)
	}
}

// Note: these tests are aware of and abuse internal details of FeatureSets.
// Users of FeatureSets should not depend on this.
func TestAdd(t *testing.T) {
	// Test a basic insertion into the FeatureSet.
	testFeatures := newEmptyFeatureSet()
	testFeatures.Add(X86FeatureCLFSH)
	if len(testFeatures.Set) != 1 {
		t.Errorf("Got length %v want 1", len(testFeatures.Set))
	}

	if !testFeatures.HasFeature(X86FeatureCLFSH) {
		t.Errorf("Add failed, got %v want set with %v", testFeatures, X86FeatureCLFSH)
	}

	// Test that duplicates are ignored.
	testFeatures.Add(X86FeatureCLFSH)
	if len(testFeatures.Set) != 1 {
		t.Errorf("Got length %v, want 1", len(testFeatures.Set))
	}
}

func TestRemove(t *testing.T) {
	// Try removing the last feature.
	testFeatures := newEmptyFeatureSet()
	testFeatures.Add(X86FeatureFPU)
	testFeatures.Add(X86FeaturePAE)
	testFeatures.Remove(X86FeaturePAE)
	if !testFeatures.HasFeature(X86FeatureFPU) || len(testFeatures.Set) != 1 || testFeatures.HasFeature(X86FeaturePAE) {
		t.Errorf("Remove failed, got %v want %v", testFeatures, justFPU)
	}

	// Try removing a feature not in the set.
	testFeatures.Remove(X86FeatureRDRAND)
	if !testFeatures.HasFeature(X86FeatureFPU) || len(testFeatures.Set) != 1 {
		t.Errorf("Remove failed, got %v want %v", testFeatures, justFPU)
	}
}

func TestFeatureFromString(t *testing.T) {
	f, ok := FeatureFromString("avx")
	if f != X86FeatureAVX || !ok {
		t.Errorf("got %v want avx", f)
	}

	f, ok = FeatureFromString("bad")
	if ok {
		t.Errorf("got %v want nothing", f)
	}
}

// This tests function 0 (eax=0), which returns the vendor ID and highest cpuid
// function reported to be available.
func TestEmulateIDVendorAndLength(t *testing.T) {
	testFeatures := newEmptyFeatureSet()

	ax, bx, cx, dx := testFeatures.EmulateID(0, 0)
	wantEax := uint32(0xd) // Highest supported cpuid function.

	// These magical constants are the characters of "GenuineIntel".
	// See Intel AN485 for a reference on why they are laid out like this.
	wantEbx := uint32(0x756e6547)
	wantEcx := uint32(0x6c65746e)
	wantEdx := uint32(0x49656e69)
	if wantEax != ax {
		t.Errorf("highest function failed, got %x want %x", ax, wantEax)
	}

	if wantEbx != bx || wantEcx != cx || wantEdx != dx {
		t.Errorf("vendor string emulation failed, bx:cx:dx, got %x:%x:%x want %x:%x:%x", bx, cx, dx, wantEbx, wantEcx, wantEdx)
	}
}

func TestEmulateIDBasicFeatures(t *testing.T) {
	// Make a minimal test feature set.
	testFeatures := newEmptyFeatureSet()
	testFeatures.Add(X86FeatureCLFSH)
	testFeatures.Add(X86FeatureAVX)

	ax, bx, cx, dx := testFeatures.EmulateID(1, 0)
	ECXAVXBit := uint32(1 << uint(X86FeatureAVX))
	EDXCLFlushBit := uint32(1 << uint(X86FeatureCLFSH-32)) // We adjust by 32 since it's in block 1.

	if EDXCLFlushBit&dx == 0 || dx&^EDXCLFlushBit != 0 {
		t.Errorf("EmulateID failed, got feature bits %x want %x", dx, testFeatures.blockMask(1))
	}

	if ECXAVXBit&cx == 0 || cx&^ECXAVXBit != 0 {
		t.Errorf("EmulateID failed, got feature bits %x want %x", cx, testFeatures.blockMask(0))
	}

	// Default signature bits, based on values for i7/Xeon.
	// See Intel AN485 for information on stepping/model bits.
	defaultSignature := uint32(0x000106a0)
	if defaultSignature != ax {
		t.Errorf("EmulateID stepping emulation failed, got %x want %x", ax, defaultSignature)
	}

	clflushSizeInfo := uint32(8 << 8)
	if clflushSizeInfo != bx {
		t.Errorf("EmulateID bx emulation failed, got %x want %x", bx, clflushSizeInfo)
	}
}

func TestEmulateIDExtendedFeatures(t *testing.T) {
	// Make a minimal test feature set, one bit in each extended feature word.
	testFeatures := newEmptyFeatureSet()
	testFeatures.Add(X86FeatureSMEP)
	testFeatures.Add(X86FeatureAVX512VBMI)

	ax, bx, cx, dx := testFeatures.EmulateID(7, 0)
	EBXSMEPBit := uint32(1 << uint(X86FeatureSMEP-2*32))      // Adjust by 2*32 since SMEP is a block 2 feature.
	ECXAVXBit := uint32(1 << uint(X86FeatureAVX512VBMI-3*32)) // We adjust by 3*32 since it's a block 3 feature.

	// Test that the desired bit is set and no other bits are set.
	if EBXSMEPBit&bx == 0 || bx&^EBXSMEPBit != 0 {
		t.Errorf("extended feature emulation failed, got feature bits %x want %x", bx, testFeatures.blockMask(2))
	}

	if ECXAVXBit&cx == 0 || cx&^ECXAVXBit != 0 {
		t.Errorf("extended feature emulation failed, got feature bits %x want %x", cx, testFeatures.blockMask(3))
	}

	if ax != 0 || dx != 0 {
		t.Errorf("extended feature emulation failed, ax:dx, got %x:%x want 0:0", ax, dx)
	}

	// Check that no subleaves other than 0 do anything.
	ax, bx, cx, dx = testFeatures.EmulateID(7, 1)
	if ax != 0 || bx != 0 || cx != 0 || dx != 0 {
		t.Errorf("extended feature emulation failed, got %x:%x:%x:%x want 0:0", ax, bx, cx, dx)
	}

}

// Checks that the expected extended features are available via cpuid functions
// 0x80000000 and up.
func TestEmulateIDExtended(t *testing.T) {
	testFeatures := newEmptyFeatureSet()
	testFeatures.Add(X86FeatureSYSCALL)
	EDXSYSCALLBit := uint32(1 << uint(X86FeatureSYSCALL-6*32)) // Adjust by 6*32 since SYSCALL is a block 6 feature.

	ax, bx, cx, dx := testFeatures.EmulateID(0x80000000, 0)
	if ax != 0x80000001 || bx != 0 || cx != 0 || dx != 0 {
		t.Errorf("EmulateID extended emulation failed, ax:bx:cx:dx, got %x:%x:%x:%x want 0x80000001:0:0:0", ax, bx, cx, dx)
	}

	_, _, _, dx = testFeatures.EmulateID(0x80000001, 0)
	if EDXSYSCALLBit&dx == 0 || dx&^EDXSYSCALLBit != 0 {
		t.Errorf("extended feature emulation failed, got feature bits %x want %x", dx, testFeatures.blockMask(6))
	}
}