rename ht_enabled to smt

Signed-off-by: alindima <[email protected]>

Author: alindima

CHANGELOG.md

@@ -57,9 +57,10 @@
   interfaces. Specifying interfaces that allow forwarding requests to MMDS is done
   by adding the network interface's ID to the `network_interfaces` field of PUT
   `/mmds/config` request's body.
-- Configuring `ht_enabled: true` on aarch64 via the API is forbidden.
-- `ht_enabled` field is now optional on PUT `/machine-config`, defaulting to
+- Renamed `/machine-config` `ht_enabled` to `smt`.
+- `smt` field is now optional on PUT `/machine-config`, defaulting to
   `false`.
+- Configuring `smt: true` on aarch64 via the API is forbidden.
 
 ### Fixed
 

docs/device-api.md

@@ -65,7 +65,7 @@ specification: [firecracker.yaml](./../src/api_server/swagger/firecracker.yaml).
 |                            | show_level            |    O     |       O        |      O       |       O       |      O       |
 |                            | show_log_origin       |    O     |       O        |      O       |       O       |      O       |
 | `MachineConfiguration`     | cpu_template          |    O     |       O        |      O       |       O       |      O       |
-|                            | ht_enabled            |    O     |       O        |      O       |       O       |      O       |
+|                            | smt                   |    O     |       O        |      O       |       O       |      O       |
 |                            | mem_size_mib          |    O     |       O        |      O       |       O       |      O       |
 |                            | track_dirty_pages     |    O     |       O        |      O       |       O       |      O       |
 |                            | vcpu_count            |    O     |       O        |      O       |       O       |      O       |
@@ -112,7 +112,7 @@ specification: [firecracker.yaml](./../src/api_server/swagger/firecracker.yaml).
 |                        | state             |    O     |       O        |      O       |     O      |      O       |
 |                        | vmm_version       |    O     |       O        |      O       |     O      |      O       |
 | `MachineConfiguration` | cpu_template      |    O     |       O        |      O       |     O      |      O       |
-|                        | ht_enabled        |    O     |       O        |      O       |     O      |      O       |
+|                        | smt               |    O     |       O        |      O       |     O      |      O       |
 |                        | mem_size_mib      |    O     |       O        |      O       |     O      |      O       |
 |                        | track_dirty_pages |    O     |       O        |      O       |     O      |      O       |
 |                        | vcpu_count        |    O     |       O        |      O       |     O      |      O       |

docs/snapshotting/snapshot-support.md

@@ -333,7 +333,7 @@ curl --unix-socket /tmp/firecracker.socket -i  \
     -d '{
             "vcpu_count": 2,
             "mem_size_mib": 1024,
-            "ht_enabled": false,
+            "smt": false,
             "track_dirty_pages": true
     }'
 ```

src/api_server/src/parsed_request.rs

@@ -1019,7 +1019,7 @@ pub(crate) mod tests {
         let body = "{ \
             \"vcpu_count\": 0, \
             \"mem_size_mib\": 0, \
-            \"ht_enabled\": false, \
+            \"smt\": false, \
             \"cpu_template\": \"C3\" \
         }";
         sender

src/api_server/src/request/machine_configuration.rs

@@ -54,7 +54,7 @@ pub(crate) fn parse_patch_machine_config(body: &Body) -> Result<ParsedRequest, E
     if vm_config.vcpu_count.is_none()
         && vm_config.mem_size_mib.is_none()
         && vm_config.cpu_template.is_none()
-        && vm_config.ht_enabled.is_none()
+        && vm_config.smt.is_none()
     {
         return method_to_error(Method::Patch);
     }
@@ -73,11 +73,11 @@ fn check_unsupported_fields(vm_config: &VmConfig) -> Result<(), Error> {
         ));
     }
 
-    if let Some(true) = vm_config.ht_enabled {
-        // ht_enabled: true is not supported on aarch64
+    if let Some(true) = vm_config.smt {
+        // smt: true is not supported on aarch64
         return Err(Error::Generic(
             StatusCode::BadRequest,
-            "Enabling HyperThreading is not supported on aarch64".to_string(),
+            "Enabling simultaneous multithreading is not supported on aarch64".to_string(),
         ));
     }
 
@@ -120,7 +120,7 @@ mod tests {
         let expected_config = VmConfig {
             vcpu_count: Some(8),
             mem_size_mib: Some(1024),
-            ht_enabled: None,
+            smt: None,
             cpu_template: None,
             track_dirty_pages: false,
         };
@@ -133,13 +133,13 @@ mod tests {
         let body = r#"{
                 "vcpu_count": 8,
                 "mem_size_mib": 1024,
-                "ht_enabled": false,
+                "smt": false,
                 "track_dirty_pages": true
             }"#;
         let expected_config = VmConfig {
             vcpu_count: Some(8),
             mem_size_mib: Some(1024),
-            ht_enabled: Some(false),
+            smt: Some(false),
             cpu_template: None,
             track_dirty_pages: true,
         };
@@ -153,7 +153,7 @@ mod tests {
         let body = r#"{
                 "vcpu_count": 8,
                 "mem_size_mib": 1024,
-                "ht_enabled": false,
+                "smt": false,
                 "cpu_template": "T2",
                 "track_dirty_pages": true
               }"#;
@@ -164,7 +164,7 @@ mod tests {
             let expected_config = VmConfig {
                 vcpu_count: Some(8),
                 mem_size_mib: Some(1024),
-                ht_enabled: Some(false),
+                smt: Some(false),
                 cpu_template: Some(CpuFeaturesTemplate::T2),
                 track_dirty_pages: true,
             };
@@ -180,11 +180,11 @@ mod tests {
             assert!(parse_put_machine_config(&Body::new(body)).is_err());
         }
 
-        // 5. Test that setting `ht_enabled: true` is successful on x86_64 while on aarch64, it is not.
+        // 5. Test that setting `smt: true` is successful on x86_64 while on aarch64, it is not.
         let body = r#"{
             "vcpu_count": 8,
             "mem_size_mib": 1024,
-            "ht_enabled": true,
+            "smt": true,
             "track_dirty_pages": true
           }"#;
 
@@ -193,7 +193,7 @@ mod tests {
             let expected_config = VmConfig {
                 vcpu_count: Some(8),
                 mem_size_mib: Some(1024),
-                ht_enabled: Some(true),
+                smt: Some(true),
                 cpu_template: None,
                 track_dirty_pages: true,
             };
@@ -239,7 +239,7 @@ mod tests {
         let body = r#"{
                 "vcpu_count": 8,
                 "mem_size_mib": 1024,
-                "ht_enabled": false
+                "smt": false
               }"#;
         assert!(parse_patch_machine_config(&Body::new(body)).is_ok());
     }

src/api_server/swagger/firecracker.yaml

@@ -285,7 +285,7 @@ paths:
       description:
         Gets the machine configuration of the VM. When called before the PUT operation, it
         will return the default values for the vCPU count (=1), memory size (=128 MiB).
-        By default Hyperthreading is disabled and there is no CPU Template.
+        By default SMT is disabled and there is no CPU Template.
       operationId: getMachineConfiguration
       responses:
         200:
@@ -302,7 +302,7 @@ paths:
       description:
         Updates the Virtual Machine Configuration with the specified input.
         Firecracker starts with default values for vCPU count (=1) and memory size (=128 MiB).
-        With Hyperthreading enabled, the vCPU count is restricted to be 1 or an even number,
+        With SMT enabled, the vCPU count is restricted to be 1 or an even number,
         otherwise there are no restrictions regarding the vCPU count.
         If any of the parameters has an incorrect value, the whole update fails.
       operationId: putMachineConfiguration
@@ -925,17 +925,18 @@ definitions:
   MachineConfiguration:
     type: object
     description:
-      Describes the number of vCPUs, memory size, Hyperthreading capabilities and
+      Describes the number of vCPUs, memory size, SMT capabilities and
       the CPU template.
     required:
       - mem_size_mib
       - vcpu_count
     properties:
       cpu_template:
         $ref: "#/definitions/CpuTemplate"
-      ht_enabled:
+      smt:
         type: boolean
-        description: Flag for enabling/disabling Hyperthreading. x86-only.
+        description: Flag for enabling/disabling simultaneous multithreading. Can be enabled only on x86.
+        default: false
       mem_size_mib:
         type: integer
         description: Memory size of VM

src/cpuid/src/transformer/amd.rs

@@ -252,10 +252,10 @@ mod tests {
         assert_eq!(entry.ecx.read_bit(ecx::TOPOEXT_INDEX), true);
     }
 
-    fn check_update_amd_features_entry(cpu_count: u8, ht_enabled: bool) {
+    fn check_update_amd_features_entry(cpu_count: u8, smt: bool) {
         use crate::cpu_leaf::leaf_0x80000008::*;
 
-        let vm_spec = VmSpec::new(0, cpu_count, ht_enabled).expect("Error creating vm_spec");
+        let vm_spec = VmSpec::new(0, cpu_count, smt).expect("Error creating vm_spec");
         let mut entry = &mut kvm_cpuid_entry2 {
             function: LEAF_NUM,
             index: 0,
@@ -282,13 +282,13 @@ mod tests {
     fn check_update_extended_apic_id_entry(
         cpu_id: u8,
         cpu_count: u8,
-        ht_enabled: bool,
+        smt: bool,
         expected_core_id: u32,
         expected_threads_per_core: u32,
     ) {
         use crate::cpu_leaf::leaf_0x8000001e::*;
 
-        let vm_spec = VmSpec::new(cpu_id, cpu_count, ht_enabled).expect("Error creating vm_spec");
+        let vm_spec = VmSpec::new(cpu_id, cpu_count, smt).expect("Error creating vm_spec");
         let mut entry = &mut kvm_cpuid_entry2 {
             function: LEAF_NUM,
             index: 0,

src/cpuid/src/transformer/common.rs

@@ -174,13 +174,13 @@ mod tests {
 
     fn check_update_cache_parameters_entry(
         cpu_count: u8,
-        ht_enabled: bool,
+        smt: bool,
         cache_level: u32,
         expected_max_cpus_per_core: u32,
     ) {
         use crate::cpu_leaf::leaf_cache_parameters::*;
 
-        let vm_spec = VmSpec::new(0, cpu_count, ht_enabled).expect("Error creating vm_spec");
+        let vm_spec = VmSpec::new(0, cpu_count, smt).expect("Error creating vm_spec");
         let mut entry = &mut kvm_cpuid_entry2 {
             function: 0x0,
             index: 0,

src/cpuid/src/transformer/intel.rs

@@ -162,13 +162,13 @@ mod tests {
 
     fn check_update_deterministic_cache_entry(
         cpu_count: u8,
-        ht_enabled: bool,
+        smt: bool,
         cache_level: u32,
         expected_max_cores_per_package: u32,
     ) {
         use crate::cpu_leaf::leaf_0x4::*;
 
-        let vm_spec = VmSpec::new(0, cpu_count, ht_enabled).expect("Error creating vm_spec");
+        let vm_spec = VmSpec::new(0, cpu_count, smt).expect("Error creating vm_spec");
         let mut entry = &mut kvm_cpuid_entry2 {
             function: 0x0,
             index: 0,
@@ -192,15 +192,15 @@ mod tests {
 
     fn check_update_extended_topology_entry(
         cpu_count: u8,
-        ht_enabled: bool,
+        smt: bool,
         index: u32,
         expected_apicid: u32,
         expected_num_logical_processors: u32,
         expected_level_type: u32,
     ) {
         use crate::cpu_leaf::leaf_0xb::*;
 
-        let vm_spec = VmSpec::new(0, cpu_count, ht_enabled).expect("Error creating vm_spec");
+        let vm_spec = VmSpec::new(0, cpu_count, smt).expect("Error creating vm_spec");
         let mut entry = &mut kvm_cpuid_entry2 {
             function: 0x0,
             index,

src/cpuid/src/transformer/mod.rs

@@ -30,14 +30,14 @@ pub struct VmSpec {
 impl VmSpec {
     /// Creates a new instance of VmSpec with the specified parameters
     /// The brand string is deduced from the vendor_id
-    pub fn new(cpu_index: u8, cpu_count: u8, ht_enabled: bool) -> Result<VmSpec, Error> {
+    pub fn new(cpu_index: u8, cpu_count: u8, smt: bool) -> Result<VmSpec, Error> {
         let cpu_vendor_id = get_vendor_id_from_host().map_err(Error::InternalError)?;
 
         Ok(VmSpec {
             cpu_vendor_id,
             cpu_index,
             cpu_count,
-            cpu_bits: (cpu_count > 1 && ht_enabled) as u8,
+            cpu_bits: (cpu_count > 1 && smt) as u8,
             brand_string: BrandString::from_vendor_id(&cpu_vendor_id),
         })
     }