linux-kernel - [PATCH] docs: Add desc for best effort mode of mmio_stale

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20230830144426.80258-1-itazur@amazon.com>
Date:   Wed, 30 Aug 2023 15:44:26 +0100
From:   Takahiro Itazuri <itazur@...zon.com>
To:     <linux-doc@...r.kernel.org>, <linux-kernel@...r.kernel.org>
CC:     Jonathan Corbet <corbet@....net>,
        Pawan Gupta <pawan.kumar.gupta@...ux.intel.com>,
        Josh Poimboeuf <jpoimboe@...nel.org>,
        Peter Zijlstra <peterz@...radead.org>,
        Borislav Petkov <bp@...en8.de>,
        "Thomas Gleixner" <tglx@...utronix.de>,
        Takahiro Itazuri <zulinx86@...il.com>,
        Takahiro Itazuri <itazur@...zon.com>
Subject: [PATCH] docs: Add desc for best effort mode of mmio_stale_data

Similar to the sysfs files for mds and tsx_async_abort, that for
mmio_stale_data also provides the best effort mitigation mode which
invokes the mitigation instructions without a guarantee they clear the
CPU buffers to address virtualized scenarios. Adds description for the
mode in the mmio_stale_data's page to make it self-contained.

Signed-off-by: Takahiro Itazuri <itazur@...zon.com>
---
 .../hw-vuln/processor_mmio_stale_data.rst     | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/hw-vuln/processor_mmio_stale_data.rst b/Documentation/admin-guide/hw-vuln/processor_mmio_stale_data.rst
index c98fd1190..c1c96eeb8 100644
--- a/Documentation/admin-guide/hw-vuln/processor_mmio_stale_data.rst
+++ b/Documentation/admin-guide/hw-vuln/processor_mmio_stale_data.rst
@@ -226,7 +226,7 @@ The possible values in this file are:
        - The processor is vulnerable, but no mitigation enabled
      * - 'Vulnerable: Clear CPU buffers attempted, no microcode'
        - The processor is vulnerable, but microcode is not updated. The
-         mitigation is enabled on a best effort basis.
+         mitigation is enabled on a best effort basis. See :ref:`best_effort`.
      * - 'Mitigation: Clear CPU buffers'
        - The processor is vulnerable and the CPU buffer clearing mitigation is
          enabled.
@@ -254,6 +254,23 @@ the above information:
   'SMT Host state unknown'  Kernel runs in a VM, Host SMT state unknown
   ========================  ===========================================
 
+.. _best_effort:
+
+Best effort mitigation mode
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If the processor is vulnerable, but the availability of the microcode-based
+mitigation mechanism is not advertised via CPUID the kernel selects a best
+effort mitigation mode.  This mode invokes the mitigation instructions
+without a guarantee that they clear the CPU buffers.
+
+This is done to address virtualization scenarios where the host has the
+microcode update applied, but the hypervisor is not yet updated to expose the
+CPUID to the guest. If the host has updated microcode the protection takes
+effect; otherwise a few CPU cycles are wasted pointlessly.
+
+The state in the mmio_stale_data sysfs file reflects this situation accordingly.
+
 References
 ----------
 .. [#f1] Affected Processors
-- 
2.40.1