Skip to content

Commit 317c214

Browse files
committed
doc: Be more specific to supported CPU models for CPU templates
We are going to add a new Intel CPU (Sapphire Rapids). But the existing CPU templates cannot be used on Sapphire Rapids. The reason is as follows. Sapphire Rapids supports a wider CPUID range. To adapt the existing templates to Sapphire Rapids, they have to mask CPUID bits off on the new CPUID range. However, if such a CPU template is applied on older CPUs that don't have the new CPUID range, Firecracker exits with an error. This error is intentional because the CPU template feature has the great power of tweaking very low layer stuff and fail-close is preferable. Signed-off-by: Takahiro Itazuri <[email protected]>
1 parent 45fc21b commit 317c214

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/cpu_templates/cpu-templates.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,14 @@ Firecracker supports two types of CPU templates:
4848

4949
At the moment the following set of static CPU templates are supported:
5050

51-
| CPU template | CPU vendor | CPU model |
52-
| ------------ | ---------- | --------------------- |
53-
| C3 | Intel | any |
54-
| T2 | Intel | any |
55-
| T2A | AMD | Milan |
56-
| T2CL | Intel | Cascade Lake or newer |
57-
| T2S | Intel | any |
58-
| V1N1 | ARM | Neoverse V1 |
51+
| CPU template | CPU vendor | CPU model |
52+
| ------------ | ---------- | ------------------------------- |
53+
| C3 | Intel | Skylake, Cascade Lake, Ice Lake |
54+
| T2 | Intel | Skylake, Cascade Lake, Ice Lake |
55+
| T2A | AMD | Milan |
56+
| T2CL | Intel | Cascade Lake, Ice Lake |
57+
| T2S | Intel | Skylake, Cascade Lake |
58+
| V1N1 | ARM | Neoverse V1 |
5959

6060
T2 and C3 templates are mapped as close as possible to AWS T2 and C3 instances
6161
in terms of CPU features. Note that on a microVM that is lauched with the C3
@@ -72,7 +72,7 @@ Firecracker expects the host to always be running the latest version of the
7272
microcode.
7373

7474
The T2CL template is mapped to be close to Intel Cascade Lake. It is not safe to
75-
use it on Intel CPUs older than Cascade Lake (such as Skylake).
75+
use it on Intel CPUs other than Cascade Lake and Ice Lake.
7676

7777
The only AMD template is T2A. It is considered safe to be used with AMD Milan.
7878

0 commit comments

Comments
 (0)