Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Sun, 16 Oct 2022 10:00:39 +0700
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     "Guilherme G. Piccoli" <gpiccoli@igalia.com>
Cc:     x86@kernel.org, linux-kernel@vger.kernel.org, tglx@linutronix.de,
        mingo@redhat.com, bp@alien8.de, dave.hansen@linux.intel.com,
        hpa@zytor.com, luto@kernel.org, corbet@lwn.net,
        linux-doc@vger.kernel.org, kernel-dev@igalia.com,
        kernel@gpiccoli.net, Andre Almeida <andrealmeid@igalia.com>,
        Fenghua Yu <fenghua.yu@intel.com>,
        Joshua Ashton <joshua@froggi.es>,
        Melissa Wen <mwen@igalia.com>,
        Paul Gofman <pgofman@codeweavers.com>,
        Pavel Machek <pavel@denx.de>,
        Pierre-Loup Griffais <pgriffais@valvesoftware.com>,
        Tony Luck <tony.luck@intel.com>,
        Zebediah Figura <zfigura@codeweavers.com>
Subject: Re: [PATCH V2] x86/split_lock: Add sysctl to control the misery mode
Message-ID: <Y0tz1/pR/s7+j6s+@debian.me>
References: <20221014180506.211592-1-gpiccoli@igalia.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha256;
        protocol="application/pgp-signature"; boundary="he7fAmT252Uv1Vmd"
Content-Disposition: inline
In-Reply-To: <20221014180506.211592-1-gpiccoli@igalia.com>
Precedence: bulk


--he7fAmT252Uv1Vmd
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Fri, Oct 14, 2022 at 03:05:06PM -0300, Guilherme G. Piccoli wrote:
> diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/=
admin-guide/sysctl/kernel.rst
> index ee6572b1edad..508952e42914 100644
> --- a/Documentation/admin-guide/sysctl/kernel.rst
> +++ b/Documentation/admin-guide/sysctl/kernel.rst
> @@ -1298,6 +1298,24 @@ watchdog work to be queued by the watchdog timer f=
unction, otherwise the NMI
>  watchdog =E2=80=94 if enabled =E2=80=94 can detect a hard lockup conditi=
on.
> =20
> =20
> +split_lock_mitigate (x86 only)
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +

The heading underline above is too short (doesn't cover the whole text
length), so I have applied the fixup:

---- >8 ----

diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/ad=
min-guide/sysctl/kernel.rst
index c733d424d4e830..4824cfed71ab31 100644
--- a/Documentation/admin-guide/sysctl/kernel.rst
+++ b/Documentation/admin-guide/sysctl/kernel.rst
@@ -1315,7 +1315,7 @@ watchdog =E2=80=94 if enabled =E2=80=94 can detect a =
hard lockup condition.
=20
=20
 split_lock_mitigate (x86 only)
-=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D
=20
 For x86 CPUs supporting the split lock detection mechanism, this parameter
 allows the users to turn off what is called "the misery mode", which

> +For x86 CPUs supporting the split lock detection mechanism, this paramet=
er
> +allows the users to turn off what is called "the misery mode", which
> +introduces intentional delay in userspace applications that split locks.
> +The goal of the misery mode is to prevent using such unaligned access to
> +DoS the system dropping the performance overall, but some of these split
> +locking programs are legacy and/or proprietary software that cannot be f=
ixed,
> +so using this sysctl is a way to allow them to run with a decent perform=
ance.
> +
> +=3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +0 Disables the misery mode - just warns the split lock on kernel log.
> +1 Enables the misery mode (this is the default) - penalizes the split
> +  lockers with intentional performance degradation.
> +=3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +
> +
>  stack_erasing
>  =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> =20

The wording can be improved:

---- >8 ----

diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/ad=
min-guide/sysctl/kernel.rst
index 4824cfed71ab31..961c19f4beae51 100644
--- a/Documentation/admin-guide/sysctl/kernel.rst
+++ b/Documentation/admin-guide/sysctl/kernel.rst
@@ -1320,15 +1320,15 @@ split_lock_mitigate (x86 only)
 For x86 CPUs supporting the split lock detection mechanism, this parameter
 allows the users to turn off what is called "the misery mode", which
 introduces intentional delay in userspace applications that split locks.
-The goal of the misery mode is to prevent using such unaligned access to
-DoS the system dropping the performance overall, but some of these split
-locking programs are legacy and/or proprietary software that cannot be fix=
ed,
-so using this sysctl is a way to allow them to run with a decent performan=
ce.
+The goal of this mode is to prevent using such unaligned access to
+drop the overall performance (and DoS the system). However, some of progra=
ms
+which uses split locking are legacy and/or proprietary software that cannot
+be fixed, so disabling this sysctl can allow them to run with a decent
+performance.
=20
 =3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
 0 Disables the misery mode - just warns the split lock on kernel log.
-1 Enables the misery mode (this is the default) - penalizes the split
-  lockers with intentional performance degradation.
+1 Enables the misery mode (default)
 =3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
=20
=20
Thanks.

--=20
An old man doll... just what I always wanted! - Clara

--he7fAmT252Uv1Vmd
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYIAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCY0tzzgAKCRD2uYlJVVFO
o1cgAQDd/HW8c+Qs9uusV20c8oAtnOt6/XUnT+jKgpaIiu/fCAEAmcW8ipB1AlKn
0Hgwi+pK4l9GDZm9Y85pbhEVqk+mVwQ=
=fqhd
-----END PGP SIGNATURE-----

--he7fAmT252Uv1Vmd--