[PATCH v2] x86/retbleed: add "stuff" mode admin documentation

[PATCH v2] x86/retbleed: add "stuff" mode admin documentation

[Randy Dunlap]

Add admin documentation for "retbleed=stuff", based on commit
description and source code.

Fixes: d82a0345cf21 ("x86/retbleed: Add call depth tracking mitigation")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Borislav Petkov <bp@alien8.de>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Dave Hansen <dave.hansen@linux.intel.com>
Cc: x86@kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Acked-by: Ingo Molnar <mingo@kernel.org>
---
v2: fix typo "if effect" -> "in effect" (thanks Ingo)

 Documentation/admin-guide/kernel-parameters.txt |    8 ++++++++
 1 file changed, 8 insertions(+)

diff -- a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -5364,6 +5364,14 @@
 				       when STIBP is not available. This is
 				       the alternative for systems which do not
 				       have STIBP.
+			stuff        - Enables "stuffing" mode mitigation,
+				       which uses return thunking and call depth
+				       tracking.  Only in effect if
+				       CONFIG_CALL_DEPTH_TRACKING is set and
+				       Spectre V2 mitigation mode is
+				       "retpoline".
+				       IBRS is fully secure mitigation but is
+				       more costly (slower) than stuffing.
 			unret        - Force enable untrained return thunks,
 				       only effective on AMD f15h-f17h based
 				       systems.

Re: [PATCH v2] x86/retbleed: add "stuff" mode admin documentation

[Dave Hansen]

On 1/9/23 08:08, Randy Dunlap wrote:
> +			stuff        - Enables "stuffing" mode mitigation,
> +				       which uses return thunking and call depth
> +				       tracking.  Only in effect if
> +				       CONFIG_CALL_DEPTH_TRACKING is set and
> +				       Spectre V2 mitigation mode is
> +				       "retpoline".
> +				       IBRS is fully secure mitigation but is
> +				       more costly (slower) than stuffing.

The "fully secure" thing makes me cringe a bit.

I'd suggest saying:

	IBRS is a stronger mitigation
	but is more costly than stuffing
	(slower).

Re: [PATCH v2] x86/retbleed: add "stuff" mode admin documentation

[Randy Dunlap]

On 1/9/23 09:19, Dave Hansen wrote:
> On 1/9/23 08:08, Randy Dunlap wrote:
>> +			stuff        - Enables "stuffing" mode mitigation,
>> +				       which uses return thunking and call depth
>> +				       tracking.  Only in effect if
>> +				       CONFIG_CALL_DEPTH_TRACKING is set and
>> +				       Spectre V2 mitigation mode is
>> +				       "retpoline".
>> +				       IBRS is fully secure mitigation but is
>> +				       more costly (slower) than stuffing.
> 
> The "fully secure" thing makes me cringe a bit.
> 
> I'd suggest saying:
> 
> 	IBRS is a stronger mitigation
> 	but is more costly than stuffing
> 	(slower).

OK, will do (v3).  :)

Thanks.

-- 
~Randy