2 * Copyright 2015 Advanced Micro Devices, Inc.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
27 * The GPU scheduler provides entities which allow userspace to push jobs
28 * into software queues which are then scheduled on a hardware run queue.
29 * The software queues have a priority among them. The scheduler selects the entities
30 * from the run queue using a FIFO. The scheduler provides dependency handling
31 * features among jobs. The driver is supposed to provide callback functions for
32 * backend operations to the scheduler like submitting a job to hardware run queue,
33 * returning the dependencies of a job etc.
35 * The organisation of the scheduler is the following:
37 * 1. Each hw run queue has one scheduler
38 * 2. Each scheduler has multiple run queues with different priorities
39 * (e.g., HIGH_HW,HIGH_SW, KERNEL, NORMAL)
40 * 3. Each scheduler run queue has a queue of entities to schedule
41 * 4. Entities themselves maintain a queue of jobs that will be scheduled on
44 * The jobs in a entity are always scheduled in the order that they were pushed.
47 #include <linux/kthread.h>
48 #include <linux/wait.h>
49 #include <linux/sched.h>
50 #include <uapi/linux/sched/types.h>
52 #include <drm/drm_print.h>
53 #include <drm/gpu_scheduler.h>
54 #include <drm/spsc_queue.h>
56 #define CREATE_TRACE_POINTS
57 #include "gpu_scheduler_trace.h"
59 #define to_drm_sched_job(sched_job) \
60 container_of((sched_job), struct drm_sched_job, queue_node)
62 static void drm_sched_process_job(struct dma_fence *f, struct dma_fence_cb *cb);
65 * drm_sched_rq_init - initialize a given run queue struct
67 * @rq: scheduler run queue
69 * Initializes a scheduler runqueue.
71 static void drm_sched_rq_init(struct drm_gpu_scheduler *sched,
72 struct drm_sched_rq *rq)
74 spin_lock_init(&rq->lock);
75 INIT_LIST_HEAD(&rq->entities);
76 rq->current_entity = NULL;
81 * drm_sched_rq_add_entity - add an entity
83 * @rq: scheduler run queue
84 * @entity: scheduler entity
86 * Adds a scheduler entity to the run queue.
88 void drm_sched_rq_add_entity(struct drm_sched_rq *rq,
89 struct drm_sched_entity *entity)
91 if (!list_empty(&entity->list))
94 list_add_tail(&entity->list, &rq->entities);
95 spin_unlock(&rq->lock);
99 * drm_sched_rq_remove_entity - remove an entity
101 * @rq: scheduler run queue
102 * @entity: scheduler entity
104 * Removes a scheduler entity from the run queue.
106 void drm_sched_rq_remove_entity(struct drm_sched_rq *rq,
107 struct drm_sched_entity *entity)
109 if (list_empty(&entity->list))
111 spin_lock(&rq->lock);
112 list_del_init(&entity->list);
113 if (rq->current_entity == entity)
114 rq->current_entity = NULL;
115 spin_unlock(&rq->lock);
119 * drm_sched_rq_select_entity - Select an entity which could provide a job to run
121 * @rq: scheduler run queue to check.
123 * Try to find a ready entity, returns NULL if none found.
125 static struct drm_sched_entity *
126 drm_sched_rq_select_entity(struct drm_sched_rq *rq)
128 struct drm_sched_entity *entity;
130 spin_lock(&rq->lock);
132 entity = rq->current_entity;
134 list_for_each_entry_continue(entity, &rq->entities, list) {
135 if (drm_sched_entity_is_ready(entity)) {
136 rq->current_entity = entity;
137 spin_unlock(&rq->lock);
143 list_for_each_entry(entity, &rq->entities, list) {
145 if (drm_sched_entity_is_ready(entity)) {
146 rq->current_entity = entity;
147 spin_unlock(&rq->lock);
151 if (entity == rq->current_entity)
155 spin_unlock(&rq->lock);
161 * drm_sched_dependency_optimized
163 * @fence: the dependency fence
164 * @entity: the entity which depends on the above fence
166 * Returns true if the dependency can be optimized and false otherwise
168 bool drm_sched_dependency_optimized(struct dma_fence* fence,
169 struct drm_sched_entity *entity)
171 struct drm_gpu_scheduler *sched = entity->rq->sched;
172 struct drm_sched_fence *s_fence;
174 if (!fence || dma_fence_is_signaled(fence))
176 if (fence->context == entity->fence_context)
178 s_fence = to_drm_sched_fence(fence);
179 if (s_fence && s_fence->sched == sched)
184 EXPORT_SYMBOL(drm_sched_dependency_optimized);
187 * drm_sched_start_timeout - start timeout for reset worker
189 * @sched: scheduler instance to start the worker for
191 * Start the timeout for the given scheduler.
193 static void drm_sched_start_timeout(struct drm_gpu_scheduler *sched)
195 if (sched->timeout != MAX_SCHEDULE_TIMEOUT &&
196 !list_empty(&sched->ring_mirror_list))
197 schedule_delayed_work(&sched->work_tdr, sched->timeout);
201 * drm_sched_fault - immediately start timeout handler
203 * @sched: scheduler where the timeout handling should be started.
205 * Start timeout handling immediately when the driver detects a hardware fault.
207 void drm_sched_fault(struct drm_gpu_scheduler *sched)
209 mod_delayed_work(system_wq, &sched->work_tdr, 0);
211 EXPORT_SYMBOL(drm_sched_fault);
214 * drm_sched_suspend_timeout - Suspend scheduler job timeout
216 * @sched: scheduler instance for which to suspend the timeout
218 * Suspend the delayed work timeout for the scheduler. This is done by
219 * modifying the delayed work timeout to an arbitrary large value,
220 * MAX_SCHEDULE_TIMEOUT in this case. Note that this function can be
221 * called from an IRQ context.
223 * Returns the timeout remaining
226 unsigned long drm_sched_suspend_timeout(struct drm_gpu_scheduler *sched)
228 unsigned long sched_timeout, now = jiffies;
230 sched_timeout = sched->work_tdr.timer.expires;
233 * Modify the timeout to an arbitrarily large value. This also prevents
234 * the timeout to be restarted when new submissions arrive
236 if (mod_delayed_work(system_wq, &sched->work_tdr, MAX_SCHEDULE_TIMEOUT)
237 && time_after(sched_timeout, now))
238 return sched_timeout - now;
240 return sched->timeout;
242 EXPORT_SYMBOL(drm_sched_suspend_timeout);
245 * drm_sched_resume_timeout - Resume scheduler job timeout
247 * @sched: scheduler instance for which to resume the timeout
248 * @remaining: remaining timeout
250 * Resume the delayed work timeout for the scheduler. Note that
251 * this function can be called from an IRQ context.
253 void drm_sched_resume_timeout(struct drm_gpu_scheduler *sched,
254 unsigned long remaining)
258 spin_lock_irqsave(&sched->job_list_lock, flags);
260 if (list_empty(&sched->ring_mirror_list))
261 cancel_delayed_work(&sched->work_tdr);
263 mod_delayed_work(system_wq, &sched->work_tdr, remaining);
265 spin_unlock_irqrestore(&sched->job_list_lock, flags);
267 EXPORT_SYMBOL(drm_sched_resume_timeout);
269 static void drm_sched_job_begin(struct drm_sched_job *s_job)
271 struct drm_gpu_scheduler *sched = s_job->sched;
274 spin_lock_irqsave(&sched->job_list_lock, flags);
275 list_add_tail(&s_job->node, &sched->ring_mirror_list);
276 drm_sched_start_timeout(sched);
277 spin_unlock_irqrestore(&sched->job_list_lock, flags);
280 static void drm_sched_job_timedout(struct work_struct *work)
282 struct drm_gpu_scheduler *sched;
283 struct drm_sched_job *job;
286 sched = container_of(work, struct drm_gpu_scheduler, work_tdr.work);
287 job = list_first_entry_or_null(&sched->ring_mirror_list,
288 struct drm_sched_job, node);
291 job->sched->ops->timedout_job(job);
294 * Guilty job did complete and hence needs to be manually removed
295 * See drm_sched_stop doc.
297 if (sched->free_guilty) {
298 job->sched->ops->free_job(job);
299 sched->free_guilty = false;
303 spin_lock_irqsave(&sched->job_list_lock, flags);
304 drm_sched_start_timeout(sched);
305 spin_unlock_irqrestore(&sched->job_list_lock, flags);
309 * drm_sched_increase_karma - Update sched_entity guilty flag
311 * @bad: The job guilty of time out
313 * Increment on every hang caused by the 'bad' job. If this exceeds the hang
314 * limit of the scheduler then the respective sched entity is marked guilty and
315 * jobs from it will not be scheduled further
317 void drm_sched_increase_karma(struct drm_sched_job *bad)
320 struct drm_sched_entity *tmp;
321 struct drm_sched_entity *entity;
322 struct drm_gpu_scheduler *sched = bad->sched;
324 /* don't increase @bad's karma if it's from KERNEL RQ,
325 * because sometimes GPU hang would cause kernel jobs (like VM updating jobs)
326 * corrupt but keep in mind that kernel jobs always considered good.
328 if (bad->s_priority != DRM_SCHED_PRIORITY_KERNEL) {
329 atomic_inc(&bad->karma);
330 for (i = DRM_SCHED_PRIORITY_MIN; i < DRM_SCHED_PRIORITY_KERNEL;
332 struct drm_sched_rq *rq = &sched->sched_rq[i];
334 spin_lock(&rq->lock);
335 list_for_each_entry_safe(entity, tmp, &rq->entities, list) {
336 if (bad->s_fence->scheduled.context ==
337 entity->fence_context) {
338 if (atomic_read(&bad->karma) >
339 bad->sched->hang_limit)
341 atomic_set(entity->guilty, 1);
345 spin_unlock(&rq->lock);
346 if (&entity->list != &rq->entities)
351 EXPORT_SYMBOL(drm_sched_increase_karma);
354 * drm_sched_stop - stop the scheduler
356 * @sched: scheduler instance
357 * @bad: job which caused the time out
359 * Stop the scheduler and also removes and frees all completed jobs.
360 * Note: bad job will not be freed as it might be used later and so it's
361 * callers responsibility to release it manually if it's not part of the
362 * mirror list any more.
365 void drm_sched_stop(struct drm_gpu_scheduler *sched, struct drm_sched_job *bad)
367 struct drm_sched_job *s_job, *tmp;
370 kthread_park(sched->thread);
373 * Iterate the job list from later to earlier one and either deactive
374 * their HW callbacks or remove them from mirror list if they already
376 * This iteration is thread safe as sched thread is stopped.
378 list_for_each_entry_safe_reverse(s_job, tmp, &sched->ring_mirror_list, node) {
379 if (s_job->s_fence->parent &&
380 dma_fence_remove_callback(s_job->s_fence->parent,
382 atomic_dec(&sched->hw_rq_count);
385 * remove job from ring_mirror_list.
386 * Locking here is for concurrent resume timeout
388 spin_lock_irqsave(&sched->job_list_lock, flags);
389 list_del_init(&s_job->node);
390 spin_unlock_irqrestore(&sched->job_list_lock, flags);
393 * Wait for job's HW fence callback to finish using s_job
394 * before releasing it.
396 * Job is still alive so fence refcount at least 1
398 dma_fence_wait(&s_job->s_fence->finished, false);
401 * We must keep bad job alive for later use during
402 * recovery by some of the drivers but leave a hint
403 * that the guilty job must be released.
406 sched->ops->free_job(s_job);
408 sched->free_guilty = true;
413 * Stop pending timer in flight as we rearm it in drm_sched_start. This
414 * avoids the pending timeout work in progress to fire right away after
415 * this TDR finished and before the newly restarted jobs had a
416 * chance to complete.
418 cancel_delayed_work(&sched->work_tdr);
421 EXPORT_SYMBOL(drm_sched_stop);
424 * drm_sched_job_recovery - recover jobs after a reset
426 * @sched: scheduler instance
427 * @full_recovery: proceed with complete sched restart
430 void drm_sched_start(struct drm_gpu_scheduler *sched, bool full_recovery)
432 struct drm_sched_job *s_job, *tmp;
437 * Locking the list is not required here as the sched thread is parked
438 * so no new jobs are being inserted or removed. Also concurrent
439 * GPU recovers can't run in parallel.
441 list_for_each_entry_safe(s_job, tmp, &sched->ring_mirror_list, node) {
442 struct dma_fence *fence = s_job->s_fence->parent;
444 atomic_inc(&sched->hw_rq_count);
450 r = dma_fence_add_callback(fence, &s_job->cb,
451 drm_sched_process_job);
453 drm_sched_process_job(fence, &s_job->cb);
455 DRM_ERROR("fence add callback failed (%d)\n",
458 drm_sched_process_job(NULL, &s_job->cb);
462 spin_lock_irqsave(&sched->job_list_lock, flags);
463 drm_sched_start_timeout(sched);
464 spin_unlock_irqrestore(&sched->job_list_lock, flags);
467 kthread_unpark(sched->thread);
469 EXPORT_SYMBOL(drm_sched_start);
472 * drm_sched_resubmit_jobs - helper to relunch job from mirror ring list
474 * @sched: scheduler instance
477 void drm_sched_resubmit_jobs(struct drm_gpu_scheduler *sched)
479 struct drm_sched_job *s_job, *tmp;
480 uint64_t guilty_context;
481 bool found_guilty = false;
482 struct dma_fence *fence;
484 list_for_each_entry_safe(s_job, tmp, &sched->ring_mirror_list, node) {
485 struct drm_sched_fence *s_fence = s_job->s_fence;
487 if (!found_guilty && atomic_read(&s_job->karma) > sched->hang_limit) {
489 guilty_context = s_job->s_fence->scheduled.context;
492 if (found_guilty && s_job->s_fence->scheduled.context == guilty_context)
493 dma_fence_set_error(&s_fence->finished, -ECANCELED);
495 dma_fence_put(s_job->s_fence->parent);
496 fence = sched->ops->run_job(s_job);
498 if (IS_ERR_OR_NULL(fence)) {
499 s_job->s_fence->parent = NULL;
500 dma_fence_set_error(&s_fence->finished, PTR_ERR(fence));
502 s_job->s_fence->parent = fence;
508 EXPORT_SYMBOL(drm_sched_resubmit_jobs);
511 * drm_sched_job_init - init a scheduler job
513 * @job: scheduler job to init
514 * @entity: scheduler entity to use
515 * @owner: job owner for debugging
517 * Refer to drm_sched_entity_push_job() documentation
518 * for locking considerations.
520 * Returns 0 for success, negative error code otherwise.
522 int drm_sched_job_init(struct drm_sched_job *job,
523 struct drm_sched_entity *entity,
526 struct drm_gpu_scheduler *sched;
528 drm_sched_entity_select_rq(entity);
532 sched = entity->rq->sched;
535 job->entity = entity;
536 job->s_priority = entity->rq - sched->sched_rq;
537 job->s_fence = drm_sched_fence_create(entity, owner);
540 job->id = atomic64_inc_return(&sched->job_id_count);
542 INIT_LIST_HEAD(&job->node);
546 EXPORT_SYMBOL(drm_sched_job_init);
549 * drm_sched_job_cleanup - clean up scheduler job resources
551 * @job: scheduler job to clean up
553 void drm_sched_job_cleanup(struct drm_sched_job *job)
555 dma_fence_put(&job->s_fence->finished);
558 EXPORT_SYMBOL(drm_sched_job_cleanup);
561 * drm_sched_ready - is the scheduler ready
563 * @sched: scheduler instance
565 * Return true if we can push more jobs to the hw, otherwise false.
567 static bool drm_sched_ready(struct drm_gpu_scheduler *sched)
569 return atomic_read(&sched->hw_rq_count) <
570 sched->hw_submission_limit;
574 * drm_sched_wakeup - Wake up the scheduler when it is ready
576 * @sched: scheduler instance
579 void drm_sched_wakeup(struct drm_gpu_scheduler *sched)
581 if (drm_sched_ready(sched))
582 wake_up_interruptible(&sched->wake_up_worker);
586 * drm_sched_select_entity - Select next entity to process
588 * @sched: scheduler instance
590 * Returns the entity to process or NULL if none are found.
592 static struct drm_sched_entity *
593 drm_sched_select_entity(struct drm_gpu_scheduler *sched)
595 struct drm_sched_entity *entity;
598 if (!drm_sched_ready(sched))
601 /* Kernel run queue has higher priority than normal run queue*/
602 for (i = DRM_SCHED_PRIORITY_MAX - 1; i >= DRM_SCHED_PRIORITY_MIN; i--) {
603 entity = drm_sched_rq_select_entity(&sched->sched_rq[i]);
612 * drm_sched_process_job - process a job
615 * @cb: fence callbacks
617 * Called after job has finished execution.
619 static void drm_sched_process_job(struct dma_fence *f, struct dma_fence_cb *cb)
621 struct drm_sched_job *s_job = container_of(cb, struct drm_sched_job, cb);
622 struct drm_sched_fence *s_fence = s_job->s_fence;
623 struct drm_gpu_scheduler *sched = s_fence->sched;
625 atomic_dec(&sched->hw_rq_count);
626 atomic_dec(&sched->num_jobs);
628 trace_drm_sched_process_job(s_fence);
630 drm_sched_fence_finished(s_fence);
631 wake_up_interruptible(&sched->wake_up_worker);
635 * drm_sched_cleanup_jobs - destroy finished jobs
637 * @sched: scheduler instance
639 * Remove all finished jobs from the mirror list and destroy them.
641 static void drm_sched_cleanup_jobs(struct drm_gpu_scheduler *sched)
645 /* Don't destroy jobs while the timeout worker is running */
646 if (sched->timeout != MAX_SCHEDULE_TIMEOUT &&
647 !cancel_delayed_work(&sched->work_tdr))
651 while (!list_empty(&sched->ring_mirror_list)) {
652 struct drm_sched_job *job;
654 job = list_first_entry(&sched->ring_mirror_list,
655 struct drm_sched_job, node);
656 if (!dma_fence_is_signaled(&job->s_fence->finished))
659 spin_lock_irqsave(&sched->job_list_lock, flags);
660 /* remove job from ring_mirror_list */
661 list_del_init(&job->node);
662 spin_unlock_irqrestore(&sched->job_list_lock, flags);
664 sched->ops->free_job(job);
667 /* queue timeout for next job */
668 spin_lock_irqsave(&sched->job_list_lock, flags);
669 drm_sched_start_timeout(sched);
670 spin_unlock_irqrestore(&sched->job_list_lock, flags);
675 * drm_sched_blocked - check if the scheduler is blocked
677 * @sched: scheduler instance
679 * Returns true if blocked, otherwise false.
681 static bool drm_sched_blocked(struct drm_gpu_scheduler *sched)
683 if (kthread_should_park()) {
692 * drm_sched_main - main scheduler thread
694 * @param: scheduler instance
698 static int drm_sched_main(void *param)
700 struct sched_param sparam = {.sched_priority = 1};
701 struct drm_gpu_scheduler *sched = (struct drm_gpu_scheduler *)param;
704 sched_setscheduler(current, SCHED_FIFO, &sparam);
706 while (!kthread_should_stop()) {
707 struct drm_sched_entity *entity = NULL;
708 struct drm_sched_fence *s_fence;
709 struct drm_sched_job *sched_job;
710 struct dma_fence *fence;
712 wait_event_interruptible(sched->wake_up_worker,
713 (drm_sched_cleanup_jobs(sched),
714 (!drm_sched_blocked(sched) &&
715 (entity = drm_sched_select_entity(sched))) ||
716 kthread_should_stop()));
721 sched_job = drm_sched_entity_pop_job(entity);
725 s_fence = sched_job->s_fence;
727 atomic_inc(&sched->hw_rq_count);
728 drm_sched_job_begin(sched_job);
730 fence = sched->ops->run_job(sched_job);
731 drm_sched_fence_scheduled(s_fence);
733 if (!IS_ERR_OR_NULL(fence)) {
734 s_fence->parent = dma_fence_get(fence);
735 r = dma_fence_add_callback(fence, &sched_job->cb,
736 drm_sched_process_job);
738 drm_sched_process_job(fence, &sched_job->cb);
740 DRM_ERROR("fence add callback failed (%d)\n",
742 dma_fence_put(fence);
745 dma_fence_set_error(&s_fence->finished, PTR_ERR(fence));
746 drm_sched_process_job(NULL, &sched_job->cb);
749 wake_up(&sched->job_scheduled);
755 * drm_sched_init - Init a gpu scheduler instance
757 * @sched: scheduler instance
758 * @ops: backend operations for this scheduler
759 * @hw_submission: number of hw submissions that can be in flight
760 * @hang_limit: number of times to allow a job to hang before dropping it
761 * @timeout: timeout value in jiffies for the scheduler
762 * @name: name used for debugging
764 * Return 0 on success, otherwise error code.
766 int drm_sched_init(struct drm_gpu_scheduler *sched,
767 const struct drm_sched_backend_ops *ops,
768 unsigned hw_submission,
775 sched->hw_submission_limit = hw_submission;
777 sched->timeout = timeout;
778 sched->hang_limit = hang_limit;
779 for (i = DRM_SCHED_PRIORITY_MIN; i < DRM_SCHED_PRIORITY_MAX; i++)
780 drm_sched_rq_init(sched, &sched->sched_rq[i]);
782 init_waitqueue_head(&sched->wake_up_worker);
783 init_waitqueue_head(&sched->job_scheduled);
784 INIT_LIST_HEAD(&sched->ring_mirror_list);
785 spin_lock_init(&sched->job_list_lock);
786 atomic_set(&sched->hw_rq_count, 0);
787 INIT_DELAYED_WORK(&sched->work_tdr, drm_sched_job_timedout);
788 atomic_set(&sched->num_jobs, 0);
789 atomic64_set(&sched->job_id_count, 0);
791 /* Each scheduler will run on a seperate kernel thread */
792 sched->thread = kthread_run(drm_sched_main, sched, sched->name);
793 if (IS_ERR(sched->thread)) {
794 ret = PTR_ERR(sched->thread);
795 sched->thread = NULL;
796 DRM_ERROR("Failed to create scheduler for %s.\n", name);
803 EXPORT_SYMBOL(drm_sched_init);
806 * drm_sched_fini - Destroy a gpu scheduler
808 * @sched: scheduler instance
810 * Tears down and cleans up the scheduler.
812 void drm_sched_fini(struct drm_gpu_scheduler *sched)
815 kthread_stop(sched->thread);
817 sched->ready = false;
819 EXPORT_SYMBOL(drm_sched_fini);