drm/nouveau: Document weird looking bugfix
Subsystems (4)
PATCH 1/1 drm/nouveau: Document weird looking bugfix
commit c8a5d5ea3ba6 ("nouveau: fix client work fence deletion race") fixed a race. To do so, it replaced the automatically locking dma_fence_is_signaled() with manual locks plus dma_fence_is_signaled_locked().
For someone browsing through the code, this reads very much like a cleanup or rework leftover. Future contributors and / or new maintainers not familiar with the history might be tempted to remove that bugfix.
Document the bugfix.
---
(I did not test this)
--- drivers/gpu/drm/nouveau/nouveau_drm.c | 7 +++++++ 1 file changed, 7 insertions(+)
drivers/gpu/drm/nouveau/nouveau_drm.c +7 -0
@@ -159,6 +159,13 @@ nouveau_cli_work_ready(struct dma_fence *fence)unsigned long flags;bool ret = true; +/* +* This is not a cleanup / rework leftover, but a bugfix to prevent a +* race with someone signalling the fence. The locked +* dma_fence_is_signaled() cannot be used. The dma_fence implementation +* is not fully synchronized with locks, but also uses atomic bits, +* which can cause the dma_fence_put() below to be executed too soon. +*/ dma_fence_lock_irqsave (fence, flags);if (!dma_fence_is_signaled_locked (fence)) ret = false;
Signature · 1 line
2.54.0
Quoted 5 lines · Philipp Stanner
commit
c8a5d5ea3ba6("nouveau: fix client work fence deletion race") fixed a race. To do so, it replaced the automatically lockingdma_fence_is_signaled()with manual locks plusdma_fence_is_signaled_locked().
Quoted 7 lines
For someone browsing through the code, this reads very much like a cleanup or rework leftover. Future contributors and / or new maintainers not familiar with the history might be tempted to remove that bugfix.
Document the bugfix.
Signed-off-by Philipp Stanner <[email protected]>
Quoted 24 lines
---
(I did not test this)--- drivers/gpu/drm/nouveau/nouveau_drm.c | 7 +++++++ 1 file changed, 7 insertions(+)drivers/gpu/drm/nouveau/nouveau_drm.c +7
-0@@ -159,6 +159,13 @@ nouveau_cli_work_ready(struct dma_fence *fence)unsigned long flags;bool ret = true; +/* +* This is not a cleanup / rework leftover, but a bugfix to prevent a +* race with someone signalling the fence. The locked +* dma_fence_is_signaled() cannot be used. The dma_fence implementation +* is not fully synchronized with locks, but also uses atomic bits, +* which can cause the dma_fence_put() below to be executed too soon. +*/ dma_fence_lock_irqsave (fence, flags);if (!dma_fence_is_signaled_locked (fence)) ret = false;
Quoted 23 lines · Philipp Stanner
commit
c8a5d5ea3ba6("nouveau: fix client work fence deletion race") fixed a race. To do so, it replaced the automatically lockingdma_fence_is_signaled()with manual locks plusdma_fence_is_signaled_locked().For someone browsing through the code, this reads very much like a cleanup or rework leftover. Future contributors and / or new maintainers not familiar with the history might be tempted to remove that bugfix.
Document the bugfix.
Signed-off-by Philipp Stanner <[email protected]>---
(I did not test this)--- drivers/gpu/drm/nouveau/nouveau_drm.c | 7 +++++++ 1 file changed, 7 insertions(+)drivers/gpu/drm/nouveau/nouveau_drm.c +0
-0
drivers/gpu/drm/nouveau/nouveau_drm.c nouveau_cli_work_ready(struct dma_fence *fence) · line 168
Quoted 10 lines
drivers/gpu/drm/nouveau/nouveau_drm.c +7
-0@@ -159,6 +159,13 @@ nouveau_cli_work_ready(struct dma_fence *fence)unsigned long flags;bool ret = true; +/* +* This is not a cleanup / rework leftover, but a bugfix to prevent a +* race with someone signalling the fence. The locked +* dma_fence_is_signaled() cannot be used. The dma_fence implementation +* is not fully synchronized with locks, but also uses atomic bits, +* which can cause the dma_fence_put() below to be executed too soon. +*/
IMHO it would also be interesting to document why this happens from the nouveau point of view.
For example I see the two references held on this fences in the call chain, but apparently neither are enough to close the race. Which suggests a third party has a pointer to this fence but with no reference.
I talk about this:
nouveau_gem_object_unmap -> nouveau_cli_work_queue
There it grabs a reference before queing the worker. In the worker it drops it before calling the callback nouveau_gem_object_unmap installed:
static voidnouveau_cli_work(struct work_struct *w)
{
struct nouveau_cli *cli = container_of(w, typeof(*cli), work);
struct nouveau_cli_work *work, *wtmp;
mutex_lock(&cli->lock);
list_for_each_entry_safe(work, wtmp, &cli->worker, head) {
if (!work->fence || nouveau_cli_work_ready(work->fence)) {... nouveau_cli_work_ready can drop one reference
list_del(&work->head); work->func(work);
... then work->func was set to nouveau_gem_object_delete_work by nouveau_gem_object_unmap, which will end up calling:
nouveau_gem_object_delete -> nouveau_fence_unref
On possibly the same fence.
So if there a path inside nouveau itself which signals the fence without holding a reference then could be it that the problem is self-inflicted and not due a dma-fence quirks?
I am not entirely sure since it is not very clear. It needs someone with nouveau expertise to clarify.
Regards,
Tvrtko
Quoted 3 lines
drivers/gpu/drm/nouveau/nouveau_drm.c +0
-0dma_fence_lock_irqsave (fence, flags);if (!dma_fence_is_signaled_locked (fence)) ret = false;