Merge pull request #1283 from bgilbert/taa

os/disabling-smt: document TAA mitigation

os/disabling-smt.md

@@ -2,7 +2,9 @@
 
 Recent Intel CPU vulnerabilities ([L1TF] and [MDS]) cannot be fully mitigated in software without disabling Simultaneous Multi-Threading. This can have a substantial performance impact and is only necessary for certain workloads, so for compatibility reasons, SMT is enabled by default.
 
-SMT should be disabled on affected Intel processors under the following circumstances:
+In addition, the Intel [TAA] vulnerability cannot be fully mitigated without disabling either of SMT or the Transactional Synchronization Extensions (TSX). Disabling TSX generally has less performance impact, so is the preferred approach on systems that don't otherwise need to disable SMT. For compatibility reasons, TSX is enabled by default.
+
+SMT and TSX should be disabled on affected Intel processors under the following circumstances:
 1. A bare-metal host runs untrusted virtual machines, and [other arrangements][l1tf-mitigation] have not been made for mitigation.
 2. A bare-metal host runs untrusted code outside a virtual machine.
 
@@ -12,23 +14,26 @@ SMT can be conditionally disabled by passing `mitigations=auto,nosmt` on the ker
 
 Alternatively, SMT can be unconditionally disabled by passing `nosmt` on the kernel command line. This provides the most protection and avoids possible behavior changes on upgrades, at the cost of a potentially unnecessary reduction in performance.
 
-For typical use cases, we recommend enabling the `mitigations=auto,nosmt` command-line option.
+TSX can be conditionally disabled on vulnerable CPUs by passing `tsx=auto` on the kernel command line, or unconditionally disabled by passing `tsx=off`. However, neither setting takes effect on systems affected by MDS, since MDS mitigation automatically protects against TAA as well.
+
+For typical use cases, we recommend enabling the `mitigations=auto,nosmt` and `tsx=auto` command-line options.
 
 [L1TF]: https://www.kernel.org/doc/html/latest/admin-guide/hw-vuln/l1tf.html
 [l1tf-mitigation]: https://www.kernel.org/doc/html/latest/admin-guide/hw-vuln/l1tf.html#mitigation-selection-guide
 [MDS]: https://www.kernel.org/doc/html/latest/admin-guide/hw-vuln/mds.html
+[TAA]: https://www.kernel.org/doc/html/latest/admin-guide/hw-vuln/tsx_async_abort.html
 
 ## Configuring new machines
 
-The following Container Linux config performs two tasks:
+The following Container Linux Config performs two tasks:
 
-1. Adds `mitigations=auto,nosmt` to the kernel command line. This affects the second and subsequent boots of the machine, but not the first boot.
+1. Adds `mitigations=auto,nosmt tsx=auto` to the kernel command line. This affects the second and subsequent boots of the machine, but not the first boot.
 2. On the first boot, disables SMT at runtime if the system has an Intel processor. This is sufficient to protect against currently-known SMT vulnerabilities until the system is rebooted. After reboot, SMT will be re-enabled if the processor is not actually vulnerable.
 
 ```yaml container-linux-config
-# Add kernel command-line argument to automatically disable SMT on CPUs
-# where it is vulnerable.  This will affect the second and subsequent
-# boots of the machine, but not the first boot.
+# Add kernel command-line arguments to automatically disable SMT or TSX
+# on CPUs where they are vulnerable.  This will affect the second and
+# subsequent boots of the machine, but not the first boot.
 storage:
   filesystems:
     - name: OEM
@@ -42,12 +47,13 @@ storage:
       mode: 0644
       contents:
         inline: |
-          # Disable SMT on CPUs affected by MDS or similar vulnerabilities
-          set linux_append="$linux_append mitigations=auto,nosmt"
+          # Disable SMT on CPUs affected by MDS or similar vulnerabilities.
+          # Disable TSX on CPUs affected by TAA but not by MDS.
+          set linux_append="$linux_append mitigations=auto,nosmt tsx=auto"
 
 # On the first boot only, disable SMT at runtime if it is enabled and
-# the system has an Intel CPU.  L1TF and MDS vulnerabilities are limited
-# to Intel CPUs.
+# the system has an Intel CPU.  L1TF, MDS, and TAA vulnerabilities are
+# limited to Intel CPUs.
 systemd:
   units:
     - name: disable-smt-firstboot.service
@@ -70,16 +76,16 @@ systemd:
 
 ## Configuring existing machines
 
-To add `mitigations=auto,nosmt` to the kernel command line on an existing system, add the following line to `/usr/share/oem/grub.cfg`:
+To add `mitigations=auto,nosmt tsx=auto` to the kernel command line on an existing system, add the following line to `/usr/share/oem/grub.cfg`:
 
 ```
-set linux_append="$linux_append mitigations=auto,nosmt"
+set linux_append="$linux_append mitigations=auto,nosmt tsx=auto"
 ```
 
 For example, using SSH:
 
 ```sh
-ssh core@node01 'sudo sh -c "echo \"set linux_append=\\\"\\\$linux_append mitigations=auto,nosmt\\\"\" >> /usr/share/oem/grub.cfg && systemctl reboot"'
+ssh core@node01 'sudo sh -c "echo \"set linux_append=\\\"\\\$linux_append mitigations=auto,nosmt tsx=auto\\\"\" >> /usr/share/oem/grub.cfg && systemctl reboot"'
 ```
 
 If you use locksmith for reboot coordination, replace `systemctl reboot` with `locksmithctl send-need-reboot`.