11b1f42d8SLucas Stach /* 21b1f42d8SLucas Stach * Copyright 2015 Advanced Micro Devices, Inc. 31b1f42d8SLucas Stach * 41b1f42d8SLucas Stach * Permission is hereby granted, free of charge, to any person obtaining a 51b1f42d8SLucas Stach * copy of this software and associated documentation files (the "Software"), 61b1f42d8SLucas Stach * to deal in the Software without restriction, including without limitation 71b1f42d8SLucas Stach * the rights to use, copy, modify, merge, publish, distribute, sublicense, 81b1f42d8SLucas Stach * and/or sell copies of the Software, and to permit persons to whom the 91b1f42d8SLucas Stach * Software is furnished to do so, subject to the following conditions: 101b1f42d8SLucas Stach * 111b1f42d8SLucas Stach * The above copyright notice and this permission notice shall be included in 121b1f42d8SLucas Stach * all copies or substantial portions of the Software. 131b1f42d8SLucas Stach * 141b1f42d8SLucas Stach * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 151b1f42d8SLucas Stach * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 161b1f42d8SLucas Stach * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 171b1f42d8SLucas Stach * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR 181b1f42d8SLucas Stach * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 191b1f42d8SLucas Stach * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 201b1f42d8SLucas Stach * OTHER DEALINGS IN THE SOFTWARE. 211b1f42d8SLucas Stach * 221b1f42d8SLucas Stach */ 231b1f42d8SLucas Stach 241b1f42d8SLucas Stach #ifndef _DRM_GPU_SCHEDULER_H_ 251b1f42d8SLucas Stach #define _DRM_GPU_SCHEDULER_H_ 261b1f42d8SLucas Stach 271b1f42d8SLucas Stach #include <drm/spsc_queue.h> 281b1f42d8SLucas Stach #include <linux/dma-fence.h> 29dc10218dSStephen Rothwell #include <linux/completion.h> 30ebd5f742SDaniel Vetter #include <linux/xarray.h> 317d64c40aSDmitry Osipenko #include <linux/workqueue.h> 321b1f42d8SLucas Stach 33741f01e6SAndrey Grodzovsky #define MAX_WAIT_SCHED_ENTITY_Q_EMPTY msecs_to_jiffies(1000) 34741f01e6SAndrey Grodzovsky 357b476affSChristian König /** 367b476affSChristian König * DRM_SCHED_FENCE_DONT_PIPELINE - Prefent dependency pipelining 377b476affSChristian König * 387b476affSChristian König * Setting this flag on a scheduler fence prevents pipelining of jobs depending 397b476affSChristian König * on this fence. In other words we always insert a full CPU round trip before 407b476affSChristian König * dependen jobs are pushed to the hw queue. 417b476affSChristian König */ 427b476affSChristian König #define DRM_SCHED_FENCE_DONT_PIPELINE DMA_FENCE_FLAG_USER_BITS 437b476affSChristian König 444d5230b5SChristian König enum dma_resv_usage; 454d5230b5SChristian König struct dma_resv; 46ebd5f742SDaniel Vetter struct drm_gem_object; 47ebd5f742SDaniel Vetter 481b1f42d8SLucas Stach struct drm_gpu_scheduler; 491b1f42d8SLucas Stach struct drm_sched_rq; 501b1f42d8SLucas Stach 51e2d732fdSLuben Tuikov /* These are often used as an (initial) index 52e2d732fdSLuben Tuikov * to an array, and as such should start at 0. 53e2d732fdSLuben Tuikov */ 541b1f42d8SLucas Stach enum drm_sched_priority { 551b1f42d8SLucas Stach DRM_SCHED_PRIORITY_MIN, 561b1f42d8SLucas Stach DRM_SCHED_PRIORITY_NORMAL, 57e2d732fdSLuben Tuikov DRM_SCHED_PRIORITY_HIGH, 581b1f42d8SLucas Stach DRM_SCHED_PRIORITY_KERNEL, 59e2d732fdSLuben Tuikov 60e2d732fdSLuben Tuikov DRM_SCHED_PRIORITY_COUNT, 611b1f42d8SLucas Stach DRM_SCHED_PRIORITY_UNSET = -2 621b1f42d8SLucas Stach }; 631b1f42d8SLucas Stach 6408fb97deSAndrey Grodzovsky /* Used to chose between FIFO and RR jobs scheduling */ 6508fb97deSAndrey Grodzovsky extern int drm_sched_policy; 6608fb97deSAndrey Grodzovsky 6708fb97deSAndrey Grodzovsky #define DRM_SCHED_POLICY_RR 0 6808fb97deSAndrey Grodzovsky #define DRM_SCHED_POLICY_FIFO 1 6908fb97deSAndrey Grodzovsky 701b1f42d8SLucas Stach /** 712d33948eSNayan Deshmukh * struct drm_sched_entity - A wrapper around a job queue (typically 722d33948eSNayan Deshmukh * attached to the DRM file_priv). 732d33948eSNayan Deshmukh * 741a61ee07SEric Anholt * Entities will emit jobs in order to their corresponding hardware 751a61ee07SEric Anholt * ring, and the scheduler will alternate between entities based on 761a61ee07SEric Anholt * scheduling policy. 771b1f42d8SLucas Stach */ 781b1f42d8SLucas Stach struct drm_sched_entity { 79981b04d9SDaniel Vetter /** 80981b04d9SDaniel Vetter * @list: 81981b04d9SDaniel Vetter * 82981b04d9SDaniel Vetter * Used to append this struct to the list of entities in the runqueue 83981b04d9SDaniel Vetter * @rq under &drm_sched_rq.entities. 84981b04d9SDaniel Vetter * 85981b04d9SDaniel Vetter * Protected by &drm_sched_rq.lock of @rq. 86981b04d9SDaniel Vetter */ 871b1f42d8SLucas Stach struct list_head list; 88981b04d9SDaniel Vetter 89981b04d9SDaniel Vetter /** 90981b04d9SDaniel Vetter * @rq: 91981b04d9SDaniel Vetter * 92981b04d9SDaniel Vetter * Runqueue on which this entity is currently scheduled. 93981b04d9SDaniel Vetter * 94981b04d9SDaniel Vetter * FIXME: Locking is very unclear for this. Writers are protected by 95981b04d9SDaniel Vetter * @rq_lock, but readers are generally lockless and seem to just race 96981b04d9SDaniel Vetter * with not even a READ_ONCE. 97981b04d9SDaniel Vetter */ 981b1f42d8SLucas Stach struct drm_sched_rq *rq; 99981b04d9SDaniel Vetter 100981b04d9SDaniel Vetter /** 101981b04d9SDaniel Vetter * @sched_list: 102981b04d9SDaniel Vetter * 103981b04d9SDaniel Vetter * A list of schedulers (struct drm_gpu_scheduler). Jobs from this entity can 104981b04d9SDaniel Vetter * be scheduled on any scheduler on this list. 105981b04d9SDaniel Vetter * 106981b04d9SDaniel Vetter * This can be modified by calling drm_sched_entity_modify_sched(). 107981b04d9SDaniel Vetter * Locking is entirely up to the driver, see the above function for more 108981b04d9SDaniel Vetter * details. 109981b04d9SDaniel Vetter * 110981b04d9SDaniel Vetter * This will be set to NULL if &num_sched_list equals 1 and @rq has been 111981b04d9SDaniel Vetter * set already. 112981b04d9SDaniel Vetter * 113981b04d9SDaniel Vetter * FIXME: This means priority changes through 114981b04d9SDaniel Vetter * drm_sched_entity_set_priority() will be lost henceforth in this case. 115981b04d9SDaniel Vetter */ 116b3ac1766SNirmoy Das struct drm_gpu_scheduler **sched_list; 117981b04d9SDaniel Vetter 118981b04d9SDaniel Vetter /** 119981b04d9SDaniel Vetter * @num_sched_list: 120981b04d9SDaniel Vetter * 121981b04d9SDaniel Vetter * Number of drm_gpu_schedulers in the @sched_list. 122981b04d9SDaniel Vetter */ 1239e3e90c5SNirmoy Das unsigned int num_sched_list; 124981b04d9SDaniel Vetter 125981b04d9SDaniel Vetter /** 126981b04d9SDaniel Vetter * @priority: 127981b04d9SDaniel Vetter * 128981b04d9SDaniel Vetter * Priority of the entity. This can be modified by calling 129981b04d9SDaniel Vetter * drm_sched_entity_set_priority(). Protected by &rq_lock. 130981b04d9SDaniel Vetter */ 131b3ac1766SNirmoy Das enum drm_sched_priority priority; 132981b04d9SDaniel Vetter 133981b04d9SDaniel Vetter /** 134981b04d9SDaniel Vetter * @rq_lock: 135981b04d9SDaniel Vetter * 136981b04d9SDaniel Vetter * Lock to modify the runqueue to which this entity belongs. 137981b04d9SDaniel Vetter */ 1381b1f42d8SLucas Stach spinlock_t rq_lock; 1391b1f42d8SLucas Stach 140981b04d9SDaniel Vetter /** 141981b04d9SDaniel Vetter * @job_queue: the list of jobs of this entity. 142981b04d9SDaniel Vetter */ 1431b1f42d8SLucas Stach struct spsc_queue job_queue; 1441b1f42d8SLucas Stach 145981b04d9SDaniel Vetter /** 146981b04d9SDaniel Vetter * @fence_seq: 147981b04d9SDaniel Vetter * 148981b04d9SDaniel Vetter * A linearly increasing seqno incremented with each new 149981b04d9SDaniel Vetter * &drm_sched_fence which is part of the entity. 150981b04d9SDaniel Vetter * 151981b04d9SDaniel Vetter * FIXME: Callers of drm_sched_job_arm() need to ensure correct locking, 152981b04d9SDaniel Vetter * this doesn't need to be atomic. 153981b04d9SDaniel Vetter */ 1541b1f42d8SLucas Stach atomic_t fence_seq; 155981b04d9SDaniel Vetter 156981b04d9SDaniel Vetter /** 157981b04d9SDaniel Vetter * @fence_context: 158981b04d9SDaniel Vetter * 159981b04d9SDaniel Vetter * A unique context for all the fences which belong to this entity. The 160981b04d9SDaniel Vetter * &drm_sched_fence.scheduled uses the fence_context but 161981b04d9SDaniel Vetter * &drm_sched_fence.finished uses fence_context + 1. 162981b04d9SDaniel Vetter */ 1631b1f42d8SLucas Stach uint64_t fence_context; 1641b1f42d8SLucas Stach 165981b04d9SDaniel Vetter /** 166981b04d9SDaniel Vetter * @dependency: 167981b04d9SDaniel Vetter * 168981b04d9SDaniel Vetter * The dependency fence of the job which is on the top of the job queue. 169981b04d9SDaniel Vetter */ 1701b1f42d8SLucas Stach struct dma_fence *dependency; 171981b04d9SDaniel Vetter 172981b04d9SDaniel Vetter /** 173981b04d9SDaniel Vetter * @cb: 174981b04d9SDaniel Vetter * 175981b04d9SDaniel Vetter * Callback for the dependency fence above. 176981b04d9SDaniel Vetter */ 1771b1f42d8SLucas Stach struct dma_fence_cb cb; 178981b04d9SDaniel Vetter 179981b04d9SDaniel Vetter /** 180981b04d9SDaniel Vetter * @guilty: 181981b04d9SDaniel Vetter * 182981b04d9SDaniel Vetter * Points to entities' guilty. 183981b04d9SDaniel Vetter */ 1842d33948eSNayan Deshmukh atomic_t *guilty; 185981b04d9SDaniel Vetter 186981b04d9SDaniel Vetter /** 187981b04d9SDaniel Vetter * @last_scheduled: 188981b04d9SDaniel Vetter * 189981b04d9SDaniel Vetter * Points to the finished fence of the last scheduled job. Only written 190981b04d9SDaniel Vetter * by the scheduler thread, can be accessed locklessly from 191981b04d9SDaniel Vetter * drm_sched_job_arm() iff the queue is empty. 192981b04d9SDaniel Vetter */ 1938ee3a52eSEmily Deng struct dma_fence *last_scheduled; 194981b04d9SDaniel Vetter 195981b04d9SDaniel Vetter /** 196981b04d9SDaniel Vetter * @last_user: last group leader pushing a job into the entity. 197981b04d9SDaniel Vetter */ 19843bce41cSChristian König struct task_struct *last_user; 199981b04d9SDaniel Vetter 200981b04d9SDaniel Vetter /** 201981b04d9SDaniel Vetter * @stopped: 202981b04d9SDaniel Vetter * 203981b04d9SDaniel Vetter * Marks the enity as removed from rq and destined for 204981b04d9SDaniel Vetter * termination. This is set by calling drm_sched_entity_flush() and by 205981b04d9SDaniel Vetter * drm_sched_fini(). 206981b04d9SDaniel Vetter */ 20762347a33SAndrey Grodzovsky bool stopped; 208981b04d9SDaniel Vetter 209981b04d9SDaniel Vetter /** 210981b04d9SDaniel Vetter * @entity_idle: 211981b04d9SDaniel Vetter * 212981b04d9SDaniel Vetter * Signals when entity is not in use, used to sequence entity cleanup in 213981b04d9SDaniel Vetter * drm_sched_entity_fini(). 214981b04d9SDaniel Vetter */ 21583a7772bSAndrey Grodzovsky struct completion entity_idle; 21608fb97deSAndrey Grodzovsky 21708fb97deSAndrey Grodzovsky /** 21808fb97deSAndrey Grodzovsky * @oldest_job_waiting: 21908fb97deSAndrey Grodzovsky * 22008fb97deSAndrey Grodzovsky * Marks earliest job waiting in SW queue 22108fb97deSAndrey Grodzovsky */ 22208fb97deSAndrey Grodzovsky ktime_t oldest_job_waiting; 22308fb97deSAndrey Grodzovsky 22408fb97deSAndrey Grodzovsky /** 22508fb97deSAndrey Grodzovsky * @rb_tree_node: 22608fb97deSAndrey Grodzovsky * 22708fb97deSAndrey Grodzovsky * The node used to insert this entity into time based priority queue 22808fb97deSAndrey Grodzovsky */ 22908fb97deSAndrey Grodzovsky struct rb_node rb_tree_node; 23008fb97deSAndrey Grodzovsky 231*df622729SLucas Stach /** 232*df622729SLucas Stach * @elapsed_ns: 233*df622729SLucas Stach * 234*df622729SLucas Stach * Records the amount of time where jobs from this entity were active 235*df622729SLucas Stach * on the GPU. 236*df622729SLucas Stach */ 237*df622729SLucas Stach uint64_t elapsed_ns; 2381b1f42d8SLucas Stach }; 2391b1f42d8SLucas Stach 2401b1f42d8SLucas Stach /** 2412d33948eSNayan Deshmukh * struct drm_sched_rq - queue of entities to be scheduled. 2422d33948eSNayan Deshmukh * 2432d33948eSNayan Deshmukh * @lock: to modify the entities list. 2448dc9fbbfSNayan Deshmukh * @sched: the scheduler to which this rq belongs to. 2452d33948eSNayan Deshmukh * @entities: list of the entities to be scheduled. 2462d33948eSNayan Deshmukh * @current_entity: the entity which is to be scheduled. 24708fb97deSAndrey Grodzovsky * @rb_tree_root: root of time based priory queue of entities for FIFO scheduling 2482d33948eSNayan Deshmukh * 2491b1f42d8SLucas Stach * Run queue is a set of entities scheduling command submissions for 2501b1f42d8SLucas Stach * one specific ring. It implements the scheduling policy that selects 2511b1f42d8SLucas Stach * the next entity to emit commands from. 2521b1f42d8SLucas Stach */ 2531b1f42d8SLucas Stach struct drm_sched_rq { 2541b1f42d8SLucas Stach spinlock_t lock; 2558dc9fbbfSNayan Deshmukh struct drm_gpu_scheduler *sched; 2561b1f42d8SLucas Stach struct list_head entities; 2571b1f42d8SLucas Stach struct drm_sched_entity *current_entity; 25808fb97deSAndrey Grodzovsky struct rb_root_cached rb_tree_root; 2591b1f42d8SLucas Stach }; 2601b1f42d8SLucas Stach 2612d33948eSNayan Deshmukh /** 2622d33948eSNayan Deshmukh * struct drm_sched_fence - fences corresponding to the scheduling of a job. 2632d33948eSNayan Deshmukh */ 2641b1f42d8SLucas Stach struct drm_sched_fence { 2652d33948eSNayan Deshmukh /** 2662d33948eSNayan Deshmukh * @scheduled: this fence is what will be signaled by the scheduler 2672d33948eSNayan Deshmukh * when the job is scheduled. 2682d33948eSNayan Deshmukh */ 2691b1f42d8SLucas Stach struct dma_fence scheduled; 2701a61ee07SEric Anholt 2712d33948eSNayan Deshmukh /** 2722d33948eSNayan Deshmukh * @finished: this fence is what will be signaled by the scheduler 2732d33948eSNayan Deshmukh * when the job is completed. 2741a61ee07SEric Anholt * 2751a61ee07SEric Anholt * When setting up an out fence for the job, you should use 2761a61ee07SEric Anholt * this, since it's available immediately upon 2771a61ee07SEric Anholt * drm_sched_job_init(), and the fence returned by the driver 2781a61ee07SEric Anholt * from run_job() won't be created until the dependencies have 2791a61ee07SEric Anholt * resolved. 2801a61ee07SEric Anholt */ 2811b1f42d8SLucas Stach struct dma_fence finished; 2821a61ee07SEric Anholt 2832d33948eSNayan Deshmukh /** 2842d33948eSNayan Deshmukh * @parent: the fence returned by &drm_sched_backend_ops.run_job 2852d33948eSNayan Deshmukh * when scheduling the job on hardware. We signal the 2862d33948eSNayan Deshmukh * &drm_sched_fence.finished fence once parent is signalled. 2872d33948eSNayan Deshmukh */ 2881b1f42d8SLucas Stach struct dma_fence *parent; 2892d33948eSNayan Deshmukh /** 2902d33948eSNayan Deshmukh * @sched: the scheduler instance to which the job having this struct 2912d33948eSNayan Deshmukh * belongs to. 2922d33948eSNayan Deshmukh */ 2931b1f42d8SLucas Stach struct drm_gpu_scheduler *sched; 2942d33948eSNayan Deshmukh /** 2952d33948eSNayan Deshmukh * @lock: the lock used by the scheduled and the finished fences. 2962d33948eSNayan Deshmukh */ 2971b1f42d8SLucas Stach spinlock_t lock; 2982d33948eSNayan Deshmukh /** 2992d33948eSNayan Deshmukh * @owner: job owner for debugging 3002d33948eSNayan Deshmukh */ 3011b1f42d8SLucas Stach void *owner; 3021b1f42d8SLucas Stach }; 3031b1f42d8SLucas Stach 3041b1f42d8SLucas Stach struct drm_sched_fence *to_drm_sched_fence(struct dma_fence *f); 3051b1f42d8SLucas Stach 3061a61ee07SEric Anholt /** 3072d33948eSNayan Deshmukh * struct drm_sched_job - A job to be run by an entity. 3082d33948eSNayan Deshmukh * 3092d33948eSNayan Deshmukh * @queue_node: used to append this struct to the queue of jobs in an entity. 310c365d304SLuben Tuikov * @list: a job participates in a "pending" and "done" lists. 3112d33948eSNayan Deshmukh * @sched: the scheduler instance on which this job is scheduled. 3122d33948eSNayan Deshmukh * @s_fence: contains the fences for the scheduling of job. 3132d33948eSNayan Deshmukh * @finish_cb: the callback for the finished fence. 314e795df5bSAndrey Grodzovsky * @work: Helper to reschdeule job kill to different context. 3152d33948eSNayan Deshmukh * @id: a unique id assigned to each job scheduled on the scheduler. 3162d33948eSNayan Deshmukh * @karma: increment on every hang caused by this job. If this exceeds the hang 3172d33948eSNayan Deshmukh * limit of the scheduler then the job is marked guilty and will not 3182d33948eSNayan Deshmukh * be scheduled further. 3192d33948eSNayan Deshmukh * @s_priority: the priority of the job. 3202d33948eSNayan Deshmukh * @entity: the entity to which this job belongs. 3213741540eSAndrey Grodzovsky * @cb: the callback for the parent fence in s_fence. 3221a61ee07SEric Anholt * 3231a61ee07SEric Anholt * A job is created by the driver using drm_sched_job_init(), and 3241a61ee07SEric Anholt * should call drm_sched_entity_push_job() once it wants the scheduler 3251a61ee07SEric Anholt * to schedule the job. 3261a61ee07SEric Anholt */ 3271b1f42d8SLucas Stach struct drm_sched_job { 3281b1f42d8SLucas Stach struct spsc_node queue_node; 3298935ff00SLuben Tuikov struct list_head list; 3301b1f42d8SLucas Stach struct drm_gpu_scheduler *sched; 3311b1f42d8SLucas Stach struct drm_sched_fence *s_fence; 332542cff78SAndrey Grodzovsky 333542cff78SAndrey Grodzovsky /* 334542cff78SAndrey Grodzovsky * work is used only after finish_cb has been used and will not be 335542cff78SAndrey Grodzovsky * accessed anymore. 336542cff78SAndrey Grodzovsky */ 337542cff78SAndrey Grodzovsky union { 3381b1f42d8SLucas Stach struct dma_fence_cb finish_cb; 3397d64c40aSDmitry Osipenko struct work_struct work; 340542cff78SAndrey Grodzovsky }; 341542cff78SAndrey Grodzovsky 3421b1f42d8SLucas Stach uint64_t id; 3431b1f42d8SLucas Stach atomic_t karma; 3441b1f42d8SLucas Stach enum drm_sched_priority s_priority; 3458ee3a52eSEmily Deng struct drm_sched_entity *entity; 3463741540eSAndrey Grodzovsky struct dma_fence_cb cb; 347ebd5f742SDaniel Vetter /** 348ebd5f742SDaniel Vetter * @dependencies: 349ebd5f742SDaniel Vetter * 350ebd5f742SDaniel Vetter * Contains the dependencies as struct dma_fence for this job, see 351ebd5f742SDaniel Vetter * drm_sched_job_add_dependency() and 352ebd5f742SDaniel Vetter * drm_sched_job_add_implicit_dependencies(). 353ebd5f742SDaniel Vetter */ 354ebd5f742SDaniel Vetter struct xarray dependencies; 355ebd5f742SDaniel Vetter 356ebd5f742SDaniel Vetter /** @last_dependency: tracks @dependencies as they signal */ 357ebd5f742SDaniel Vetter unsigned long last_dependency; 35808fb97deSAndrey Grodzovsky 35908fb97deSAndrey Grodzovsky /** 36008fb97deSAndrey Grodzovsky * @submit_ts: 36108fb97deSAndrey Grodzovsky * 36208fb97deSAndrey Grodzovsky * When the job was pushed into the entity queue. 36308fb97deSAndrey Grodzovsky */ 36408fb97deSAndrey Grodzovsky ktime_t submit_ts; 3651b1f42d8SLucas Stach }; 3661b1f42d8SLucas Stach 3671b1f42d8SLucas Stach static inline bool drm_sched_invalidate_job(struct drm_sched_job *s_job, 3681b1f42d8SLucas Stach int threshold) 3691b1f42d8SLucas Stach { 3706efa4b46SLuben Tuikov return s_job && atomic_inc_return(&s_job->karma) > threshold; 3711b1f42d8SLucas Stach } 3721b1f42d8SLucas Stach 373a6a1f036SLuben Tuikov enum drm_gpu_sched_stat { 374a6a1f036SLuben Tuikov DRM_GPU_SCHED_STAT_NONE, /* Reserve 0 */ 375a6a1f036SLuben Tuikov DRM_GPU_SCHED_STAT_NOMINAL, 376a6a1f036SLuben Tuikov DRM_GPU_SCHED_STAT_ENODEV, 377a6a1f036SLuben Tuikov }; 378a6a1f036SLuben Tuikov 3791b1f42d8SLucas Stach /** 380f8ad757eSRandy Dunlap * struct drm_sched_backend_ops - Define the backend operations 381f8ad757eSRandy Dunlap * called by the scheduler 3822d33948eSNayan Deshmukh * 383f8ad757eSRandy Dunlap * These functions should be implemented in the driver side. 3841b1f42d8SLucas Stach */ 3851b1f42d8SLucas Stach struct drm_sched_backend_ops { 3862d33948eSNayan Deshmukh /** 387a82f30b0SChristian König * @prepare_job: 388ebd5f742SDaniel Vetter * 389ebd5f742SDaniel Vetter * Called when the scheduler is considering scheduling this job next, to 390ebd5f742SDaniel Vetter * get another struct dma_fence for this job to block on. Once it 391ebd5f742SDaniel Vetter * returns NULL, run_job() may be called. 392ebd5f742SDaniel Vetter * 393a82f30b0SChristian König * Can be NULL if no additional preparation to the dependencies are 394a82f30b0SChristian König * necessary. Skipped when jobs are killed instead of run. 3951a61ee07SEric Anholt */ 396a82f30b0SChristian König struct dma_fence *(*prepare_job)(struct drm_sched_job *sched_job, 3971b1f42d8SLucas Stach struct drm_sched_entity *s_entity); 3981a61ee07SEric Anholt 3992d33948eSNayan Deshmukh /** 4002d33948eSNayan Deshmukh * @run_job: Called to execute the job once all of the dependencies 4012d33948eSNayan Deshmukh * have been resolved. This may be called multiple times, if 4021a61ee07SEric Anholt * timedout_job() has happened and drm_sched_job_recovery() 4031a61ee07SEric Anholt * decides to try it again. 4041a61ee07SEric Anholt */ 4051b1f42d8SLucas Stach struct dma_fence *(*run_job)(struct drm_sched_job *sched_job); 4061a61ee07SEric Anholt 4072d33948eSNayan Deshmukh /** 4082d33948eSNayan Deshmukh * @timedout_job: Called when a job has taken too long to execute, 4092d33948eSNayan Deshmukh * to trigger GPU recovery. 410a6a1f036SLuben Tuikov * 4111fad1b7eSBoris Brezillon * This method is called in a workqueue context. 4121fad1b7eSBoris Brezillon * 4131fad1b7eSBoris Brezillon * Drivers typically issue a reset to recover from GPU hangs, and this 4141fad1b7eSBoris Brezillon * procedure usually follows the following workflow: 4151fad1b7eSBoris Brezillon * 4161fad1b7eSBoris Brezillon * 1. Stop the scheduler using drm_sched_stop(). This will park the 4171fad1b7eSBoris Brezillon * scheduler thread and cancel the timeout work, guaranteeing that 4181fad1b7eSBoris Brezillon * nothing is queued while we reset the hardware queue 4191fad1b7eSBoris Brezillon * 2. Try to gracefully stop non-faulty jobs (optional) 4201fad1b7eSBoris Brezillon * 3. Issue a GPU reset (driver-specific) 4211fad1b7eSBoris Brezillon * 4. Re-submit jobs using drm_sched_resubmit_jobs() 4221fad1b7eSBoris Brezillon * 5. Restart the scheduler using drm_sched_start(). At that point, new 4231fad1b7eSBoris Brezillon * jobs can be queued, and the scheduler thread is unblocked 4241fad1b7eSBoris Brezillon * 42578efe21bSBoris Brezillon * Note that some GPUs have distinct hardware queues but need to reset 42678efe21bSBoris Brezillon * the GPU globally, which requires extra synchronization between the 42778efe21bSBoris Brezillon * timeout handler of the different &drm_gpu_scheduler. One way to 42878efe21bSBoris Brezillon * achieve this synchronization is to create an ordered workqueue 42978efe21bSBoris Brezillon * (using alloc_ordered_workqueue()) at the driver level, and pass this 43078efe21bSBoris Brezillon * queue to drm_sched_init(), to guarantee that timeout handlers are 43178efe21bSBoris Brezillon * executed sequentially. The above workflow needs to be slightly 43278efe21bSBoris Brezillon * adjusted in that case: 43378efe21bSBoris Brezillon * 43478efe21bSBoris Brezillon * 1. Stop all schedulers impacted by the reset using drm_sched_stop() 43578efe21bSBoris Brezillon * 2. Try to gracefully stop non-faulty jobs on all queues impacted by 43678efe21bSBoris Brezillon * the reset (optional) 43778efe21bSBoris Brezillon * 3. Issue a GPU reset on all faulty queues (driver-specific) 43878efe21bSBoris Brezillon * 4. Re-submit jobs on all schedulers impacted by the reset using 43978efe21bSBoris Brezillon * drm_sched_resubmit_jobs() 44078efe21bSBoris Brezillon * 5. Restart all schedulers that were stopped in step #1 using 44178efe21bSBoris Brezillon * drm_sched_start() 44278efe21bSBoris Brezillon * 443a6a1f036SLuben Tuikov * Return DRM_GPU_SCHED_STAT_NOMINAL, when all is normal, 444a6a1f036SLuben Tuikov * and the underlying driver has started or completed recovery. 445a6a1f036SLuben Tuikov * 446a6a1f036SLuben Tuikov * Return DRM_GPU_SCHED_STAT_ENODEV, if the device is no longer 447a6a1f036SLuben Tuikov * available, i.e. has been unplugged. 4481a61ee07SEric Anholt */ 449a6a1f036SLuben Tuikov enum drm_gpu_sched_stat (*timedout_job)(struct drm_sched_job *sched_job); 4501a61ee07SEric Anholt 4512d33948eSNayan Deshmukh /** 4522d33948eSNayan Deshmukh * @free_job: Called once the job's finished fence has been signaled 4532d33948eSNayan Deshmukh * and it's time to clean it up. 4541a61ee07SEric Anholt */ 4551b1f42d8SLucas Stach void (*free_job)(struct drm_sched_job *sched_job); 4561b1f42d8SLucas Stach }; 4571b1f42d8SLucas Stach 4581b1f42d8SLucas Stach /** 459f8ad757eSRandy Dunlap * struct drm_gpu_scheduler - scheduler instance-specific data 4602d33948eSNayan Deshmukh * 4612d33948eSNayan Deshmukh * @ops: backend operations provided by the driver. 4622d33948eSNayan Deshmukh * @hw_submission_limit: the max size of the hardware queue. 4632d33948eSNayan Deshmukh * @timeout: the time after which a job is removed from the scheduler. 4642d33948eSNayan Deshmukh * @name: name of the ring for which this scheduler is being used. 4652d33948eSNayan Deshmukh * @sched_rq: priority wise array of run queues. 4662d33948eSNayan Deshmukh * @wake_up_worker: the wait queue on which the scheduler sleeps until a job 4672d33948eSNayan Deshmukh * is ready to be scheduled. 4682d33948eSNayan Deshmukh * @job_scheduled: once @drm_sched_entity_do_release is called the scheduler 4692d33948eSNayan Deshmukh * waits on this wait queue until all the scheduled jobs are 4702d33948eSNayan Deshmukh * finished. 4712d33948eSNayan Deshmukh * @hw_rq_count: the number of jobs currently in the hardware queue. 4722d33948eSNayan Deshmukh * @job_id_count: used to assign unique id to the each job. 47378efe21bSBoris Brezillon * @timeout_wq: workqueue used to queue @work_tdr 4746a962430SNayan Deshmukh * @work_tdr: schedules a delayed call to @drm_sched_job_timedout after the 4756a962430SNayan Deshmukh * timeout interval is over. 4762d33948eSNayan Deshmukh * @thread: the kthread on which the scheduler which run. 4776efa4b46SLuben Tuikov * @pending_list: the list of jobs which are currently in the job queue. 4786efa4b46SLuben Tuikov * @job_list_lock: lock to protect the pending_list. 4792d33948eSNayan Deshmukh * @hang_limit: once the hangs by a job crosses this limit then it is marked 48095b2151fSAlyssa Rosenzweig * guilty and it will no longer be considered for scheduling. 481d41a39ddSNirmoy Das * @score: score to help loadbalancer pick a idle sched 482be318fd8SChristian König * @_score: score used when the driver doesn't provide one 483faf6e1a8SAndrey Grodzovsky * @ready: marks if the underlying HW is ready to work 484a5343b8aSAndrey Grodzovsky * @free_guilty: A hit to time out handler to free the guilty job. 485f8ad757eSRandy Dunlap * @dev: system &struct device 4862d33948eSNayan Deshmukh * 4872d33948eSNayan Deshmukh * One scheduler is implemented for each hardware ring. 4881b1f42d8SLucas Stach */ 4891b1f42d8SLucas Stach struct drm_gpu_scheduler { 4901b1f42d8SLucas Stach const struct drm_sched_backend_ops *ops; 4911b1f42d8SLucas Stach uint32_t hw_submission_limit; 4921b1f42d8SLucas Stach long timeout; 4931b1f42d8SLucas Stach const char *name; 494e2d732fdSLuben Tuikov struct drm_sched_rq sched_rq[DRM_SCHED_PRIORITY_COUNT]; 4951b1f42d8SLucas Stach wait_queue_head_t wake_up_worker; 4961b1f42d8SLucas Stach wait_queue_head_t job_scheduled; 4971b1f42d8SLucas Stach atomic_t hw_rq_count; 4981b1f42d8SLucas Stach atomic64_t job_id_count; 49978efe21bSBoris Brezillon struct workqueue_struct *timeout_wq; 5006a962430SNayan Deshmukh struct delayed_work work_tdr; 5011b1f42d8SLucas Stach struct task_struct *thread; 5026efa4b46SLuben Tuikov struct list_head pending_list; 5031b1f42d8SLucas Stach spinlock_t job_list_lock; 5041b1f42d8SLucas Stach int hang_limit; 505f2f12eb9SChristian König atomic_t *score; 506f2f12eb9SChristian König atomic_t _score; 507faf6e1a8SAndrey Grodzovsky bool ready; 508a5343b8aSAndrey Grodzovsky bool free_guilty; 5098ab62edaSJiawei Gu struct device *dev; 5101b1f42d8SLucas Stach }; 5111b1f42d8SLucas Stach 5121b1f42d8SLucas Stach int drm_sched_init(struct drm_gpu_scheduler *sched, 5131b1f42d8SLucas Stach const struct drm_sched_backend_ops *ops, 51478efe21bSBoris Brezillon uint32_t hw_submission, unsigned hang_limit, 51578efe21bSBoris Brezillon long timeout, struct workqueue_struct *timeout_wq, 5168ab62edaSJiawei Gu atomic_t *score, const char *name, struct device *dev); 517faf6e1a8SAndrey Grodzovsky 5181b1f42d8SLucas Stach void drm_sched_fini(struct drm_gpu_scheduler *sched); 519620e762fSChristian König int drm_sched_job_init(struct drm_sched_job *job, 520620e762fSChristian König struct drm_sched_entity *entity, 521620e762fSChristian König void *owner); 522dbe48d03SDaniel Vetter void drm_sched_job_arm(struct drm_sched_job *job); 523ebd5f742SDaniel Vetter int drm_sched_job_add_dependency(struct drm_sched_job *job, 524ebd5f742SDaniel Vetter struct dma_fence *fence); 5254d5230b5SChristian König int drm_sched_job_add_resv_dependencies(struct drm_sched_job *job, 5264d5230b5SChristian König struct dma_resv *resv, 5274d5230b5SChristian König enum dma_resv_usage usage); 528ebd5f742SDaniel Vetter int drm_sched_job_add_implicit_dependencies(struct drm_sched_job *job, 529ebd5f742SDaniel Vetter struct drm_gem_object *obj, 530ebd5f742SDaniel Vetter bool write); 531ebd5f742SDaniel Vetter 532ebd5f742SDaniel Vetter 533b37aced3SNirmoy Das void drm_sched_entity_modify_sched(struct drm_sched_entity *entity, 534b37aced3SNirmoy Das struct drm_gpu_scheduler **sched_list, 535b37aced3SNirmoy Das unsigned int num_sched_list); 536b37aced3SNirmoy Das 53726efecf9SSharat Masetty void drm_sched_job_cleanup(struct drm_sched_job *job); 538620e762fSChristian König void drm_sched_wakeup(struct drm_gpu_scheduler *sched); 5395918045cSChristian König void drm_sched_stop(struct drm_gpu_scheduler *sched, struct drm_sched_job *bad); 540222b5f04SAndrey Grodzovsky void drm_sched_start(struct drm_gpu_scheduler *sched, bool full_recovery); 541222b5f04SAndrey Grodzovsky void drm_sched_resubmit_jobs(struct drm_gpu_scheduler *sched); 542222b5f04SAndrey Grodzovsky void drm_sched_increase_karma(struct drm_sched_job *bad); 543e6c6338fSJack Zhang void drm_sched_reset_karma(struct drm_sched_job *bad); 544e6c6338fSJack Zhang void drm_sched_increase_karma_ext(struct drm_sched_job *bad, int type); 545620e762fSChristian König bool drm_sched_dependency_optimized(struct dma_fence* fence, 546620e762fSChristian König struct drm_sched_entity *entity); 5478fe159b0SChristian König void drm_sched_fault(struct drm_gpu_scheduler *sched); 548620e762fSChristian König void drm_sched_job_kickout(struct drm_sched_job *s_job); 549620e762fSChristian König 550620e762fSChristian König void drm_sched_rq_add_entity(struct drm_sched_rq *rq, 551620e762fSChristian König struct drm_sched_entity *entity); 552620e762fSChristian König void drm_sched_rq_remove_entity(struct drm_sched_rq *rq, 553620e762fSChristian König struct drm_sched_entity *entity); 5541b1f42d8SLucas Stach 55508fb97deSAndrey Grodzovsky void drm_sched_rq_update_fifo(struct drm_sched_entity *entity, ktime_t ts); 55608fb97deSAndrey Grodzovsky 557aa16b6c6SNayan Deshmukh int drm_sched_entity_init(struct drm_sched_entity *entity, 558b3ac1766SNirmoy Das enum drm_sched_priority priority, 559b3ac1766SNirmoy Das struct drm_gpu_scheduler **sched_list, 5609e3e90c5SNirmoy Das unsigned int num_sched_list, 5618344c53fSNayan Deshmukh atomic_t *guilty); 562cdc50176SNayan Deshmukh long drm_sched_entity_flush(struct drm_sched_entity *entity, long timeout); 563cdc50176SNayan Deshmukh void drm_sched_entity_fini(struct drm_sched_entity *entity); 564cdc50176SNayan Deshmukh void drm_sched_entity_destroy(struct drm_sched_entity *entity); 565620e762fSChristian König void drm_sched_entity_select_rq(struct drm_sched_entity *entity); 566620e762fSChristian König struct drm_sched_job *drm_sched_entity_pop_job(struct drm_sched_entity *entity); 5670e10e9a1SDaniel Vetter void drm_sched_entity_push_job(struct drm_sched_job *sched_job); 5687febe4bfSChristian König void drm_sched_entity_set_priority(struct drm_sched_entity *entity, 5697febe4bfSChristian König enum drm_sched_priority priority); 570620e762fSChristian König bool drm_sched_entity_is_ready(struct drm_sched_entity *entity); 571620e762fSChristian König 572dbe48d03SDaniel Vetter struct drm_sched_fence *drm_sched_fence_alloc( 5731b1f42d8SLucas Stach struct drm_sched_entity *s_entity, void *owner); 574dbe48d03SDaniel Vetter void drm_sched_fence_init(struct drm_sched_fence *fence, 575dbe48d03SDaniel Vetter struct drm_sched_entity *entity); 576d4c16733SBoris Brezillon void drm_sched_fence_free(struct drm_sched_fence *fence); 577dbe48d03SDaniel Vetter 5781b1f42d8SLucas Stach void drm_sched_fence_scheduled(struct drm_sched_fence *fence); 5791b1f42d8SLucas Stach void drm_sched_fence_finished(struct drm_sched_fence *fence); 5801b1f42d8SLucas Stach 5811db8c142SSharat Masetty unsigned long drm_sched_suspend_timeout(struct drm_gpu_scheduler *sched); 5821db8c142SSharat Masetty void drm_sched_resume_timeout(struct drm_gpu_scheduler *sched, 5831db8c142SSharat Masetty unsigned long remaining); 584ec2edcc2SNirmoy Das struct drm_gpu_scheduler * 585ec2edcc2SNirmoy Das drm_sched_pick_best(struct drm_gpu_scheduler **sched_list, 586ec2edcc2SNirmoy Das unsigned int num_sched_list); 5871db8c142SSharat Masetty 5881b1f42d8SLucas Stach #endif 589