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:   Tue, 27 Jun 2023 10:29:55 +0300
From:   Pekka Paalanen <ppaalanen@gmail.com>
To:     =?UTF-8?B?QW5kcsOp?= Almeida <andrealmeid@igalia.com>
Cc:     dri-devel@lists.freedesktop.org, amd-gfx@lists.freedesktop.org,
        linux-kernel@vger.kernel.org, kernel-dev@igalia.com,
        alexander.deucher@amd.com, christian.koenig@amd.com,
        pierre-eric.pelloux-prayer@amd.com,
        Simon Ser <contact@emersion.fr>,
        Rob Clark <robdclark@gmail.com>,
        Daniel Vetter <daniel@ffwll.ch>,
        Daniel Stone <daniel@fooishbar.org>,
        'Marek =?UTF-8?B?T2zFocOhayc=?= <maraeo@gmail.com>,
        Dave Airlie <airlied@gmail.com>,
        Michel =?UTF-8?B?RMOkbnplcg==?= <michel.daenzer@mailbox.org>,
        Samuel Pitoiset <samuel.pitoiset@gmail.com>,
        Timur =?UTF-8?B?S3Jpc3TDs2Y=?= <timur.kristof@gmail.com>,
        Bas Nieuwenhuizen <bas@basnieuwenhuizen.nl>
Subject: Re: [PATCH v4 1/1] drm/doc: Document DRM device reset expectations
Message-ID: <20230627102955.6a2c5796@eldfell>
In-Reply-To: <20230626183347.55118-2-andrealmeid@igalia.com>
References: <20230626183347.55118-1-andrealmeid@igalia.com>
        <20230626183347.55118-2-andrealmeid@igalia.com>
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="Sig_/orsJdneEox0Kbc+g6Dj4_fM";
 protocol="application/pgp-signature"; micalg=pgp-sha256
Precedence: bulk

--Sig_/orsJdneEox0Kbc+g6Dj4_fM
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

On Mon, 26 Jun 2023 15:33:47 -0300
Andr=C3=A9 Almeida <andrealmeid@igalia.com> wrote:

> Create a section that specifies how to deal with DRM device resets for
> kernel and userspace drivers.
>=20
> Signed-off-by: Andr=C3=A9 Almeida <andrealmeid@igalia.com>
> ---
>  Documentation/gpu/drm-uapi.rst | 68 ++++++++++++++++++++++++++++++++++
>  1 file changed, 68 insertions(+)

Hi,

grammar nitpicks notwithstanding, I'm happy with the contents now, so

Acked-by: Pekka Paalanen <pekka.paalanen@collabora.com>


Thanks,
pq

>=20
> diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.=
rst
> index 65fb3036a580..25a11b9b98fa 100644
> --- a/Documentation/gpu/drm-uapi.rst
> +++ b/Documentation/gpu/drm-uapi.rst
> @@ -285,6 +285,74 @@ for GPU1 and GPU2 from different vendors, and a thir=
d handler for
>  mmapped regular files. Threads cause additional pain with signal
>  handling as well.
> =20
> +Device reset
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +
> +The GPU stack is really complex and is prone to errors, from hardware bu=
gs,
> +faulty applications and everything in between the many layers. Some erro=
rs
> +require resetting the device in order to make the device usable again. T=
his
> +section describes what is the expectations for DRM and usermode drivers =
when a
> +device resets and how to propagate the reset status.
> +
> +Kernel Mode Driver
> +------------------
> +
> +The KMD is responsible for checking if the device needs a reset, and to =
perform
> +it as needed. Usually a hang is detected when a job gets stuck executing=
. KMD
> +should keep track of resets, because userspace can query any time about =
the
> +reset stats for an specific context. This is needed to propagate to the =
rest of
> +the stack that a reset has happened. Currently, this is implemented by e=
ach
> +driver separately, with no common DRM interface.
> +
> +User Mode Driver
> +----------------
> +
> +The UMD should check before submitting new commands to the KMD if the de=
vice has
> +been reset, and this can be checked more often if it requires to. After
> +detecting a reset, UMD will then proceed to report it to the application=
 using
> +the appropriated API error code, as explained in the below section about
> +robustness.
> +
> +Robustness
> +----------
> +
> +The only way to try to keep an application working after a reset is if it
> +complies with the robustness aspects of the graphical API that it is usi=
ng.
> +
> +Graphical APIs provide ways to application to deal with device resets. H=
owever,
> +there is no guarantee that the app will be correctly using such features=
, and
> +UMD can implement policies to close the app if it is a repeating offende=
r,
> +likely in a broken loop. This is done to ensure that it does not keeps b=
locking
> +the user interface from being correctly displayed. This should be done e=
ven if
> +the app is correct but happens to trigger some bug in the hardware/drive=
r.
> +
> +OpenGL
> +~~~~~~
> +
> +Apps using OpenGL should use the available robust interfaces, like the
> +extension ``GL_ARB_robustness`` (or ``GL_EXT_robustness`` for OpenGL ES)=
. This
> +interface tells if a reset has happened, and if so, all the context stat=
e is
> +considered lost and the app proceeds by creating new ones. If is possibl=
e to
> +determine that robustness is not in use, UMD will terminate the app when=
 a reset
> +is detected, giving that the contexts are lost and the app won't be able=
 to
> +figure this out and recreate the contexts.
> +
> +Vulkan
> +~~~~~~
> +
> +Apps using Vulkan should check for ``VK_ERROR_DEVICE_LOST`` for submissi=
ons.
> +This error code means, among other things, that a device reset has happe=
ned and
> +it needs to recreate the contexts to keep going.
> +
> +Reporting resets causes
> +-----------------------
> +
> +Apart from propagating the reset through the stack so apps can recover, =
it's
> +really useful for driver developers to learn more about what caused the =
reset in
> +first place. DRM devices should make use of devcoredump to store relevant
> +information about the reset, so this information can be added to user bug
> +reports.
> +
>  .. _drm_driver_ioctl:
> =20
>  IOCTL Support on Device Nodes


--Sig_/orsJdneEox0Kbc+g6Dj4_fM
Content-Type: application/pgp-signature
Content-Description: OpenPGP digital signature

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

iQIzBAEBCAAdFiEEJQjwWQChkWOYOIONI1/ltBGqqqcFAmSaj/MACgkQI1/ltBGq
qqfDXRAAm2d0qCfUurM9gqoskeR0oqeuQx2qnSmrJ0JdOxYVwnhUgFa5jqiWP0Jt
15vwqIgqKkJTBaREdBZ0T3WeRZnm8DFWcol+qAwU1WV4rXzdjfAIwv0L4UjPDbBD
VDA2uAfrMYvoKApiuLCpleMbFnKD79nkWe/FDkrZksGTFmK/u2SDFFMJXAhEoy7s
3PwNvUbHijAeTgSwu68qJ4zMM1uLZI4ff6eWuS6GQKiLk8zCnZN+/6NmKk/pgVlo
Mr+1Br1/ZaHV78LQNZWyuq+njnyC7I2pyx3Qy/1X0Tka8PapG5V2QVZLMnnc4WI3
nSwCOYDMpQ8yGNRoSRZaNd9B88xTweKIpXrvIrJw3sBmfKRNTJcoTuBeiB32x1BO
Wm2f0v24lnc9tb3EYrhruAbmrofCHGUUD6Fd6cgbf938D4DaNrR6uhTJdEj8JDif
CcbnPgzR2pOg3gNOJ3va9QsSdInFwv2wYr4ftVh76O6hzCvuyMdsskxUwophl8x0
Vn0OQDrKfBoRacuHwOLgRlgI4SA/6TZ7SDyfHI+Uljg3tP49VPUji6oFyxljLccp
Qeq2vLtLbBDeY+68lUOXOMieC+D/FZlODi05gjfKLuhdNg4l4+VnDvSQN7Btb7DQ
WSS+I5IHK7yFXV1Y/N4DqWqGjSA9mEEc3CLDC50N4JF62/ri1FI=
=76Wv
-----END PGP SIGNATURE-----

--Sig_/orsJdneEox0Kbc+g6Dj4_fM--