drm/sched: Documentation and refcount improvements
Subsystems (4)
Philipp Stanner
maintainerv4 cover drm/sched: Documentation and refcount improvements
Changes in v4:
- Remove mention of vague "dma_fence rules" in timedout_job() again since I couldn't get input on what those rules precisely are.
- Address a forgotten TODO. (Me)
- Reposition "Return:" statements to make them congruent with the official kernel style. (Tvrtko)
- Change formatting a bit because of crazy make htmldocs errors. (Me)
Changes in v3:
- timedout_job(): various docu wording improvements. (Danilo)
- Use the term "ring" consistently. (Danilo)
- Add fully fledged docu for enum drm_gpu_sched_stat. (Danilo)
Changes in v2:
- Document what run_job() is allowed to return. (Tvrtko)
- Delete confusing comment about putting the fence. (Danilo)
- Apply Danilo's RB to patch 1.
- Delete info about job recovery for entities in patch 3. (Danilo, me)
- Set the term "ring" as fix term for both HW rings and FW rings. A ring shall always be the thingy on the CPU ;) (Danilo)
- Many (all) other comments improvements in patch 3. (Danilo)
This is as series succeeding my previous patch [1].
I recognized that we are still referring to a non-existing function and a deprecated one in the callback docu. We should probably also point out the important distinction between hardware and firmware schedulers more cleanly.
Please give me feedback, especially on the RFC comments in patch3.
(This series still fires docu-build-warnings. I want to gather feedback on the opion questions first and will solve them in v2.)
Thank you,
Philipp
[1] https://lore.kernel.org/all/[email protected]/
Philipp Stanner (3):
drm/sched: Document run_job() refcount hazard drm/sched: Adjust outdated docu for run_job() drm/sched: Update timedout_job()'s documentation
drivers/gpu/drm/scheduler/sched_main.c | 5 +- include/drm/gpu_scheduler.h | 106 +++++++++++++++++-------- 2 files changed, 73 insertions(+), 38 deletions(-)
Signature · 1 line
2.47.1
Philipp Stanner
maintainerPATCH v4 1/3 drm/sched: Document run_job() refcount hazard
From: Philipp Stanner <[email protected]>
drm_sched_backend_ops.run_job() returns a dma_fence for the scheduler. That fence is signalled by the driver once the hardware completed the associated job. The scheduler does not increment the reference count on that fence, but implicitly expects to inherit this fence from run_job().
This is relatively subtle and prone to misunderstandings.
This implies that, to keep a reference for itself, a driver needs to call dma_fence_get() in addition to dma_fence_init() in that callback.
It's further complicated by the fact that the scheduler even decrements the refcount in drm_sched_run_job_work() since it created a new reference in drm_sched_fence_scheduled(). It does, however, still use its pointer to the fence after calling dma_fence_put() - which is safe because of the aforementioned new reference, but actually still violates the refcounting rules.
Move the call to dma_fence_put() to the position behind the last usage of the fence.
Document the necessity to increment the reference count in drm_sched_backend_ops.run_job().
--- drivers/gpu/drm/scheduler/sched_main.c | 5 ++--- include/drm/gpu_scheduler.h | 19 +++++++++++++++---- 2 files changed, 17 insertions(+), 7 deletions(-)
drivers/gpu/drm/scheduler/sched_main.c +2 -3
@@ -1222,15 +1222,14 @@ static void drm_sched_run_job_work(struct work_struct *w)drm_sched_fence_scheduled (s_fence, fence);if (!IS_ERR_OR_NULL (fence)) { -/* Drop for original kref_init of the fence */ -dma_fence_put (fence); - r =dma_fence_add_callback (fence, &sched_job->cb, drm_sched_job_done_cb);if (r == -ENOENT )drm_sched_job_done (sched_job, fence->error);else if (r)DRM_DEV_ERROR (sched->dev,"fence add callback failed (%d)\n" , r); + +dma_fence_put (fence); }else {drm_sched_job_done (sched_job,IS_ERR (fence) ?PTR_ERR (fence) :0 );
include/drm/gpu_scheduler.h +15 -4
@@ -420,10 +420,21 @@ struct drm_sched_backend_ops { struct drm_sched_entity *s_entity);/** -* @run_job: Called to execute the job once all of the dependencies -* have been resolved. This may be called multiple times, if -* timedout_job() has happened and drm_sched_job_recovery() -* decides to try it again. +* @run_job: Called to execute the job once all of the dependencies +* have been resolved. This may be called multiple times, if +* timedout_job() has happened and drm_sched_job_recovery() decides to +* try it again. +* +* @sched_job: the job to run +* +* Returns: dma_fence the driver must signal once the hardware has +* completed the job ("hardware fence"). +* +* Note that the scheduler expects to 'inherit' its own reference to +* this fence from the callback. It does not invoke an extra +* dma_fence_get() on it. Consequently, this callback must take a +* reference for the scheduler, and additional ones for the driver's +* respective needs. */ struct dma_fence *(*run_job)(struct drm_sched_job *sched_job);
Signature · 1 line
2.47.1
Philipp Stanner
maintainerPATCH v4 2/3 drm/sched: Adjust outdated docu for run_job()
In reply to Philipp StannerThe documentation for drm_sched_backend_ops.run_job() mentions a certain function called drm_sched_job_recovery(). This function does not exist. What's actually meant is drm_sched_resubmit_jobs(), which is by now also deprecated.
Remove the mention of the removed function.
Discourage the behavior of drm_sched_backend_ops.run_job() being called multiple times for the same job.
--- include/drm/gpu_scheduler.h | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-)
include/drm/gpu_scheduler.h +10 -6
@@ -421,20 +421,24 @@ struct drm_sched_backend_ops {/** * @run_job: Called to execute the job once all of the dependencies -* have been resolved. This may be called multiple times, if -* timedout_job() has happened and drm_sched_job_recovery() decides to -* try it again. +* have been resolved. +* +* The deprecated drm_sched_resubmit_jobs() (called from +* drm_sched_backend_ops.timedout_job()) can invoke this again with the +* same parameters. * * @sched_job: the job to run * -* Returns: dma_fence the driver must signal once the hardware has -* completed the job ("hardware fence"). -* * Note that the scheduler expects to 'inherit' its own reference to * this fence from the callback. It does not invoke an extra * dma_fence_get() on it. Consequently, this callback must take a * reference for the scheduler, and additional ones for the driver's * respective needs. +* +* Return: +* * On success: dma_fence the driver must signal once the hardware has +* completed the job ("hardware fence"). +* * On failure: NULL or an ERR_PTR. */ struct dma_fence *(*run_job)(struct drm_sched_job *sched_job);
Signature · 1 line
2.47.1
Philipp Stanner
maintainerPATCH v4 3/3 drm/sched: Update timedout_job()'s documentation
In reply to Philipp Stannerdrm_sched_backend_ops.timedout_job()'s documentation is outdated. It mentions the deprecated function drm_sched_resubmit_job(). Furthermore, it does not point out the important distinction between hardware and firmware schedulers.
Since firmware schedulers tyipically only use one entity per scheduler, timeout handling is significantly more simple because the entity the faulted job came from can just be killed without affecting innocent processes.
Update the documentation with that distinction and other details.
Reformat the docstring to work to a unified style with the other handles.
--- include/drm/gpu_scheduler.h | 83 +++++++++++++++++++++++-------------- 1 file changed, 52 insertions(+), 31 deletions(-)
include/drm/gpu_scheduler.h +52 -31
@@ -393,8 +393,15 @@ static inline bool drm_sched_invalidate_job(struct drm_sched_job *s_job,return s_job &&atomic_inc_return (&s_job->karma) > threshold; } +/** +* enum drm_gpu_sched_stat - the scheduler's status +* +* @DRM_GPU_SCHED_STAT_NONE: Reserved. Do not use. +* @DRM_GPU_SCHED_STAT_NOMINAL: Operation succeeded. +* @DRM_GPU_SCHED_STAT_ENODEV: Error: Device is not available anymore. +*/ enum drm_gpu_sched_stat { -DRM_GPU_SCHED_STAT_NONE ,/* Reserve 0 */ +DRM_GPU_SCHED_STAT_NONE ,DRM_GPU_SCHED_STAT_NOMINAL ,DRM_GPU_SCHED_STAT_ENODEV , };
@@ -427,6 +434,11 @@ struct drm_sched_backend_ops {* drm_sched_backend_ops.timedout_job()) can invoke this again with the * same parameters. * +* This method is called in a workqueue context - either from the +* submit_wq the driver passed through &drm_sched_init(), or, if the +* driver passed NULL, a separate, ordered workqueue the scheduler +* allocated. +* * @sched_job: the job to run * * Note that the scheduler expects to 'inherit' its own reference to
@@ -446,43 +458,52 @@ struct drm_sched_backend_ops {* @timedout_job: Called when a job has taken too long to execute, * to trigger GPU recovery. * -* This method is called in a workqueue context. +* @sched_job: The job that has timed out * -* Drivers typically issue a reset to recover from GPU hangs, and this -* procedure usually follows the following workflow: +* Drivers typically issue a reset to recover from GPU hangs. +* This procedure looks very different depending on whether a firmware +* or a hardware scheduler is being used. * -* 1. Stop the scheduler using drm_sched_stop(). This will park the -* scheduler thread and cancel the timeout work, guaranteeing that -* nothing is queued while we reset the hardware queue -* 2. Try to gracefully stop non-faulty jobs (optional) -* 3. Issue a GPU reset (driver-specific) -* 4. Re-submit jobs using drm_sched_resubmit_jobs() -* 5. Restart the scheduler using drm_sched_start(). At that point, new -* jobs can be queued, and the scheduler thread is unblocked +* For a FIRMWARE SCHEDULER, each ring has one scheduler, and each +* scheduler has one entity. Hence, the steps taken typically look as +* follows: +* +* 1. Stop the scheduler using drm_sched_stop(). This will pause the +* scheduler workqueues and cancel the timeout work, guaranteeing +* that nothing is queued while the ring is being removed. +* 2. Remove the ring. The firmware will make sure that the +* corresponding parts of the hardware are resetted, and that other +* rings are not impacted. +* 3. Kill the entity and the associated scheduler. +* +* +* For a HARDWARE SCHEDULER, a scheduler instance schedules jobs from +* one or more entities to one ring. This implies that all entities +* associated with the affected scheduler cannot be torn down, because +* this would effectively also affect innocent userspace processes which +* did not submit faulty jobs (for example). +* +* Consequently, the procedure to recover with a hardware scheduler +* should look like this: +* +* 1. Stop all schedulers impacted by the reset using drm_sched_stop(). +* 3. Kill the entity the faulty job stems from. +* 4. Issue a GPU reset on all faulty rings (driver-specific). +* 5. Re-submit jobs on all schedulers impacted by re-submitting them to +* the entities which are still alive. +* 6. Restart all schedulers that were stopped in step #1 using +* drm_sched_start(). * * Note that some GPUs have distinct hardware queues but need to reset * the GPU globally, which requires extra synchronization between the -* timeout handler of the different &drm_gpu_scheduler. One way to -* achieve this synchronization is to create an ordered workqueue -* (using alloc_ordered_workqueue()) at the driver level, and pass this -* queue to drm_sched_init(), to guarantee that timeout handlers are -* executed sequentially. The above workflow needs to be slightly -* adjusted in that case: +* timeout handlers of different schedulers. One way to achieve this +* synchronization is to create an ordered workqueue (using +* alloc_ordered_workqueue()) at the driver level, and pass this queue +* as drm_sched_init()'s @timeout_wq parameter. This will guarantee +* that timeout handlers are executed sequentially. * -* 1. Stop all schedulers impacted by the reset using drm_sched_stop() -* 2. Try to gracefully stop non-faulty jobs on all queues impacted by -* the reset (optional) -* 3. Issue a GPU reset on all faulty queues (driver-specific) -* 4. Re-submit jobs on all schedulers impacted by the reset using -* drm_sched_resubmit_jobs() -* 5. Restart all schedulers that were stopped in step #1 using -* drm_sched_start() +* Return: The scheduler's status, defined by &drm_gpu_sched_stat * -* Return DRM_GPU_SCHED_STAT_NOMINAL, when all is normal, -* and the underlying driver has started or completed recovery. -* -* Return DRM_GPU_SCHED_STAT_ENODEV, if the device is no longer -* available, i.e. has been unplugged. */ enum drm_gpu_sched_stat (*timedout_job)(struct drm_sched_job *sched_job);
Signature · 1 line
2.47.1