32  * backend operations to the scheduler like submitting a job to hardware run queue,
33  * returning the dependencies of a job etc.
46  * Note that once a job was taken from the entities queue and pushed to the
61  * Once a job is executed (but not yet finished), the job's credits contribute
62  * to the scheduler's credit count until the job is finished. If by executing
63  * one more job the scheduler's credit count would exceed the scheduler's
64  * credit limit, the job won't be executed. Instead, the scheduler will wait
69  * struct drm_sched_backend_ops to update the job's credits dynamically. The
70  * scheduler executes this callback every time the scheduler considers a job for
71  * execution and subsequently checks whether the job fits the scheduler's credit
124  * Return true if we can push at least one more job from @entity, false
140 			 "Jobs with zero credits bypass job-flow control.\n");  in drm_sched_can_queue()
143 	/* If a job exceeds the credit limit, truncate it to the credit limit  in drm_sched_can_queue()
261  * drm_sched_rq_select_entity_rr - Select an entity which could provide a job to run
270  * its job; return NULL, if no ready entity was found.
326  * drm_sched_rq_select_entity_fifo - Select an entity which provides a job to run
335  * its job; return NULL, if no ready entity was found.
367  * drm_sched_run_job_queue - enqueue run-job work
377  * __drm_sched_run_free_queue - enqueue free-job work
387  * drm_sched_run_free_queue - enqueue free-job work if ready
392 	struct drm_sched_job *job;  in drm_sched_run_free_queue()  local
395 	job = list_first_entry_or_null(&sched->pending_list,  in drm_sched_run_free_queue()
397 	if (job && dma_fence_is_signaled(&job->s_fence->finished))  in drm_sched_run_free_queue()
403  * drm_sched_job_done - complete a job
404  * @s_job: pointer to the job which is done
406  * Finish the job's fence and wake up the worker thread.
425  * drm_sched_job_done_cb - the callback for a done job
460  * drm_sched_tdr_queue_imm: - immediately start job timeout handler
490  * drm_sched_suspend_timeout - Suspend scheduler job timeout
520  * drm_sched_resume_timeout - Resume scheduler job timeout
554 	struct drm_sched_job *job;  in drm_sched_job_timedout()  local
561 	job = list_first_entry_or_null(&sched->pending_list,  in drm_sched_job_timedout()
564 	if (job) {  in drm_sched_job_timedout()
566 		 * Remove the bad job so it cannot be freed by concurrent  in drm_sched_job_timedout()
570 		list_del_init(&job->list);  in drm_sched_job_timedout()
573 		status = job->sched->ops->timedout_job(job);  in drm_sched_job_timedout()
576 		 * Guilty job did complete and hence needs to be manually removed  in drm_sched_job_timedout()
580 			job->sched->ops->free_job(job);  in drm_sched_job_timedout()
595  * @bad: job which caused the time out
598  * Note: bad job will not be freed as it might be used later and so it's
613 	 * Reinsert back the bad job here - now it's safe as  in drm_sched_stop()
615 	 * bad job at this point - we parked (waited for) any in progress  in drm_sched_stop()
622 		 * job extracted.  in drm_sched_stop()
627 	 * Iterate the job list from later to  earlier one and either deactive  in drm_sched_stop()
642 			 * remove job from pending_list.  in drm_sched_stop()
650 			 * Wait for job's HW fence callback to finish using s_job  in drm_sched_stop()
653 			 * Job is still alive so fence refcount at least 1  in drm_sched_stop()
658 			 * We must keep bad job alive for later use during  in drm_sched_stop()
660 			 * that the guilty job must be released.  in drm_sched_stop()
725  * recovery after a job timeout.
773  * drm_sched_job_init - init a scheduler job
774  * @job: scheduler job to init
776  * @credits: the number of credits this job contributes to the schedulers
778  * @owner: job owner for debugging
784  * successfully, even when @job is aborted before drm_sched_job_arm() is called.
797 int drm_sched_job_init(struct drm_sched_job *job,  in drm_sched_job_init()  argument
806 		drm_err(job->sched, "%s: entity has no rq!\n", __func__);  in drm_sched_job_init()
821 	memset(job, 0, sizeof(*job));  in drm_sched_job_init()
823 	job->entity = entity;  in drm_sched_job_init()
824 	job->credits = credits;  in drm_sched_job_init()
825 	job->s_fence = drm_sched_fence_alloc(entity, owner);  in drm_sched_job_init()
826 	if (!job->s_fence)  in drm_sched_job_init()
829 	INIT_LIST_HEAD(&job->list);  in drm_sched_job_init()
831 	xa_init_flags(&job->dependencies, XA_FLAGS_ALLOC);  in drm_sched_job_init()
838  * drm_sched_job_arm - arm a scheduler job for execution
839  * @job: scheduler job to arm
841  * This arms a scheduler job for execution. Specifically it initializes the
842  * &drm_sched_job.s_fence of @job, so that it can be attached to struct dma_resv
843  * or other places that need to track the completion of this job.
850 void drm_sched_job_arm(struct drm_sched_job *job)  in drm_sched_job_arm()  argument
853 	struct drm_sched_entity *entity = job->entity;  in drm_sched_job_arm()
859 	job->sched = sched;  in drm_sched_job_arm()
860 	job->s_priority = entity->priority;  in drm_sched_job_arm()
861 	job->id = atomic64_inc_return(&sched->job_id_count);  in drm_sched_job_arm()
863 	drm_sched_fence_init(job->s_fence, job->entity);  in drm_sched_job_arm()
868  * drm_sched_job_add_dependency - adds the fence as a job dependency
869  * @job: scheduler job to add the dependencies to
877 int drm_sched_job_add_dependency(struct drm_sched_job *job,  in drm_sched_job_add_dependency()  argument
892 	xa_for_each(&job->dependencies, index, entry) {  in drm_sched_job_add_dependency()
898 			xa_store(&job->dependencies, index, fence, GFP_KERNEL);  in drm_sched_job_add_dependency()
905 	ret = xa_alloc(&job->dependencies, &id, fence, xa_limit_32b, GFP_KERNEL);  in drm_sched_job_add_dependency()
914  * drm_sched_job_add_syncobj_dependency - adds a syncobj's fence as a job dependency
915  * @job: scheduler job to add the dependencies to
920  * This adds the fence matching the given syncobj to @job.
925 int drm_sched_job_add_syncobj_dependency(struct drm_sched_job *job,  in drm_sched_job_add_syncobj_dependency()  argument
937 	return drm_sched_job_add_dependency(job, fence);  in drm_sched_job_add_syncobj_dependency()
942  * drm_sched_job_add_resv_dependencies - add all fences from the resv to the job
943  * @job: scheduler job to add the dependencies to
947  * This adds all fences matching the given usage from @resv to @job.
953 int drm_sched_job_add_resv_dependencies(struct drm_sched_job *job,  in drm_sched_job_add_resv_dependencies()  argument
966 		ret = drm_sched_job_add_dependency(job, fence);  in drm_sched_job_add_resv_dependencies()
977  * drm_sched_job_add_implicit_dependencies - adds implicit dependencies as job
979  * @job: scheduler job to add the dependencies to
981  * @write: whether the job might write the object (so we need to depend on
985  * GEM objects used in the job but before updating the reservations with your
991 int drm_sched_job_add_implicit_dependencies(struct drm_sched_job *job,  in drm_sched_job_add_implicit_dependencies()  argument
995 	return drm_sched_job_add_resv_dependencies(job, obj->resv,  in drm_sched_job_add_implicit_dependencies()
1001  * drm_sched_job_cleanup - clean up scheduler job resources
1002  * @job: scheduler job to clean up
1006  * Drivers should call this from their error unwind code if @job is aborted
1009  * After that point of no return @job is committed to be executed by the
1013 void drm_sched_job_cleanup(struct drm_sched_job *job)  in drm_sched_job_cleanup()  argument
1018 	if (kref_read(&job->s_fence->finished.refcount)) {  in drm_sched_job_cleanup()
1020 		dma_fence_put(&job->s_fence->finished);  in drm_sched_job_cleanup()
1022 		/* aborted job before committing to run it */  in drm_sched_job_cleanup()
1023 		drm_sched_fence_free(job->s_fence);  in drm_sched_job_cleanup()
1026 	job->s_fence = NULL;  in drm_sched_job_cleanup()
1028 	xa_for_each(&job->dependencies, index, fence) {  in drm_sched_job_cleanup()
1031 	xa_destroy(&job->dependencies);  in drm_sched_job_cleanup()
1078  * drm_sched_get_finished_job - fetch the next finished job to be destroyed
1082  * Returns the next finished job from the pending list (if there is one)
1088 	struct drm_sched_job *job, *next;  in drm_sched_get_finished_job()  local
1092 	job = list_first_entry_or_null(&sched->pending_list,  in drm_sched_get_finished_job()
1095 	if (job && dma_fence_is_signaled(&job->s_fence->finished)) {  in drm_sched_get_finished_job()
1096 		/* remove job from pending_list */  in drm_sched_get_finished_job()
1097 		list_del_init(&job->list);  in drm_sched_get_finished_job()
1099 		/* cancel this job's TO timer */  in drm_sched_get_finished_job()
1109 					dma_fence_timestamp(&job->s_fence->finished);  in drm_sched_get_finished_job()
1110 			/* start TO timer for next job */  in drm_sched_get_finished_job()
1114 		job = NULL;  in drm_sched_get_finished_job()
1119 	return job;  in drm_sched_get_finished_job()
1161  * @w: free job work
1167 	struct drm_sched_job *job;  in drm_sched_free_job_work()  local
1172 	job = drm_sched_get_finished_job(sched);  in drm_sched_free_job_work()
1173 	if (job)  in drm_sched_free_job_work()
1174 		sched->ops->free_job(job);  in drm_sched_free_job_work()
1183  * @w: run job work
1198 	/* Find entity with a ready job */  in drm_sched_run_job_work()
1248  * @hang_limit: number of times to allow a job to hang before dropping it
1407  * @bad: The job guilty of time out
1409  * Increment on every hang caused by the 'bad' job. If this exceeds the hang