drivers/gpu/drm/i915/gt/intel_context.h

   1 /* SPDX-License-Identifier: MIT */
   2 /*
   3  * Copyright © 2019 Intel Corporation
   4  */
   5
   6 #ifndef __INTEL_CONTEXT_H__
   7 #define __INTEL_CONTEXT_H__
   8
   9 #include <linux/bitops.h>
  10 #include <linux/lockdep.h>
  11 #include <linux/types.h>
  12
  13 #include "i915_active.h"
  14 #include "i915_drv.h"
  15 #include "intel_context_types.h"
  16 #include "intel_engine_types.h"
  17 #include "intel_ring_types.h"
  18 #include "intel_timeline_types.h"
  19 #include "i915_trace.h"
  20
  21 #define CE_TRACE(ce, fmt, ...) do {                                     \
  22         const struct intel_context *ce__ = (ce);                        \
  23         ENGINE_TRACE(ce__->engine, "context:%llx " fmt,                 \
  24                      ce__->timeline->fence_context,                     \
  25                      ##__VA_ARGS__);                                    \
  26 } while (0)
  27
  28 struct i915_gem_ww_ctx;
  29
  30 void intel_context_init(struct intel_context *ce,
  31                         struct intel_engine_cs *engine);
  32 void intel_context_fini(struct intel_context *ce);
  33
  34 void i915_context_module_exit(void);
  35 int i915_context_module_init(void);
  36
  37 struct intel_context *
  38 intel_context_create(struct intel_engine_cs *engine);
  39
  40 int intel_context_alloc_state(struct intel_context *ce);
  41
  42 void intel_context_free(struct intel_context *ce);
  43
  44 int intel_context_reconfigure_sseu(struct intel_context *ce,
  45                                    const struct intel_sseu sseu);
  46
  47 /**
  48  * intel_context_lock_pinned - Stablises the 'pinned' status of the HW context
  49  * @ce - the context
  50  *
  51  * Acquire a lock on the pinned status of the HW context, such that the context
  52  * can neither be bound to the GPU or unbound whilst the lock is held, i.e.
  53  * intel_context_is_pinned() remains stable.
  54  */
  55 static inline int intel_context_lock_pinned(struct intel_context *ce)
  56         __acquires(ce->pin_mutex)
  57 {
  58         return mutex_lock_interruptible(&ce->pin_mutex);
  59 }
  60
  61 /**
  62  * intel_context_is_pinned - Reports the 'pinned' status
  63  * @ce - the context
  64  *
  65  * While in use by the GPU, the context, along with its ring and page
  66  * tables is pinned into memory and the GTT.
  67  *
  68  * Returns: true if the context is currently pinned for use by the GPU.
  69  */
  70 static inline bool
  71 intel_context_is_pinned(struct intel_context *ce)
  72 {
  73         return atomic_read(&ce->pin_count);
  74 }
  75
  76 static inline void intel_context_cancel_request(struct intel_context *ce,
  77                                                 struct i915_request *rq)
  78 {
  79         GEM_BUG_ON(!ce->ops->cancel_request);
  80         return ce->ops->cancel_request(ce, rq);
  81 }
  82
  83 /**
  84  * intel_context_unlock_pinned - Releases the earlier locking of 'pinned' status
  85  * @ce - the context
  86  *
  87  * Releases the lock earlier acquired by intel_context_unlock_pinned().
  88  */
  89 static inline void intel_context_unlock_pinned(struct intel_context *ce)
  90         __releases(ce->pin_mutex)
  91 {
  92         mutex_unlock(&ce->pin_mutex);
  93 }
  94
  95 int __intel_context_do_pin(struct intel_context *ce);
  96 int __intel_context_do_pin_ww(struct intel_context *ce,
  97                               struct i915_gem_ww_ctx *ww);
  98
  99 static inline bool intel_context_pin_if_active(struct intel_context *ce)
 100 {
 101         return atomic_inc_not_zero(&ce->pin_count);
 102 }
 103
 104 static inline int intel_context_pin(struct intel_context *ce)
 105 {
 106         if (likely(intel_context_pin_if_active(ce)))
 107                 return 0;
 108
 109         return __intel_context_do_pin(ce);
 110 }
 111
 112 static inline int intel_context_pin_ww(struct intel_context *ce,
 113                                        struct i915_gem_ww_ctx *ww)
 114 {
 115         if (likely(intel_context_pin_if_active(ce)))
 116                 return 0;
 117
 118         return __intel_context_do_pin_ww(ce, ww);
 119 }
 120
 121 static inline void __intel_context_pin(struct intel_context *ce)
 122 {
 123         GEM_BUG_ON(!intel_context_is_pinned(ce));
 124         atomic_inc(&ce->pin_count);
 125 }
 126
 127 void __intel_context_do_unpin(struct intel_context *ce, int sub);
 128
 129 static inline void intel_context_sched_disable_unpin(struct intel_context *ce)
 130 {
 131         __intel_context_do_unpin(ce, 2);
 132 }
 133
 134 static inline void intel_context_unpin(struct intel_context *ce)
 135 {
 136         if (!ce->ops->sched_disable) {
 137                 __intel_context_do_unpin(ce, 1);
 138         } else {
 139                 /*
 140                  * Move ownership of this pin to the scheduling disable which is
 141                  * an async operation. When that operation completes the above
 142                  * intel_context_sched_disable_unpin is called potentially
 143                  * unpinning the context.
 144                  */
 145                 while (!atomic_add_unless(&ce->pin_count, -1, 1)) {
 146                         if (atomic_cmpxchg(&ce->pin_count, 1, 2) == 1) {
 147                                 ce->ops->sched_disable(ce);
 148                                 break;
 149                         }
 150                 }
 151         }
 152 }
 153
 154 void intel_context_enter_engine(struct intel_context *ce);
 155 void intel_context_exit_engine(struct intel_context *ce);
 156
 157 static inline void intel_context_enter(struct intel_context *ce)
 158 {
 159         lockdep_assert_held(&ce->timeline->mutex);
 160         if (!ce->active_count++)
 161                 ce->ops->enter(ce);
 162 }
 163
 164 static inline void intel_context_mark_active(struct intel_context *ce)
 165 {
 166         lockdep_assert(lockdep_is_held(&ce->timeline->mutex) ||
 167                        test_bit(CONTEXT_IS_PARKED, &ce->flags));
 168         ++ce->active_count;
 169 }
 170
 171 static inline void intel_context_exit(struct intel_context *ce)
 172 {
 173         lockdep_assert_held(&ce->timeline->mutex);
 174         GEM_BUG_ON(!ce->active_count);
 175         if (!--ce->active_count)
 176                 ce->ops->exit(ce);
 177 }
 178
 179 static inline struct intel_context *intel_context_get(struct intel_context *ce)
 180 {
 181         kref_get(&ce->ref);
 182         return ce;
 183 }
 184
 185 static inline void intel_context_put(struct intel_context *ce)
 186 {
 187         kref_put(&ce->ref, ce->ops->destroy);
 188 }
 189
 190 static inline struct intel_timeline *__must_check
 191 intel_context_timeline_lock(struct intel_context *ce)
 192         __acquires(&ce->timeline->mutex)
 193 {
 194         struct intel_timeline *tl = ce->timeline;
 195         int err;
 196
 197         err = mutex_lock_interruptible(&tl->mutex);
 198         if (err)
 199                 return ERR_PTR(err);
 200
 201         return tl;
 202 }
 203
 204 static inline void intel_context_timeline_unlock(struct intel_timeline *tl)
 205         __releases(&tl->mutex)
 206 {
 207         mutex_unlock(&tl->mutex);
 208 }
 209
 210 int intel_context_prepare_remote_request(struct intel_context *ce,
 211                                          struct i915_request *rq);
 212
 213 struct i915_request *intel_context_create_request(struct intel_context *ce);
 214
 215 struct i915_request *
 216 intel_context_find_active_request(struct intel_context *ce);
 217
 218 static inline bool intel_context_is_barrier(const struct intel_context *ce)
 219 {
 220         return test_bit(CONTEXT_BARRIER_BIT, &ce->flags);
 221 }
 222
 223 static inline bool intel_context_is_closed(const struct intel_context *ce)
 224 {
 225         return test_bit(CONTEXT_CLOSED_BIT, &ce->flags);
 226 }
 227
 228 static inline bool intel_context_has_inflight(const struct intel_context *ce)
 229 {
 230         return test_bit(COPS_HAS_INFLIGHT_BIT, &ce->ops->flags);
 231 }
 232
 233 static inline bool intel_context_use_semaphores(const struct intel_context *ce)
 234 {
 235         return test_bit(CONTEXT_USE_SEMAPHORES, &ce->flags);
 236 }
 237
 238 static inline void intel_context_set_use_semaphores(struct intel_context *ce)
 239 {
 240         set_bit(CONTEXT_USE_SEMAPHORES, &ce->flags);
 241 }
 242
 243 static inline void intel_context_clear_use_semaphores(struct intel_context *ce)
 244 {
 245         clear_bit(CONTEXT_USE_SEMAPHORES, &ce->flags);
 246 }
 247
 248 static inline bool intel_context_is_banned(const struct intel_context *ce)
 249 {
 250         return test_bit(CONTEXT_BANNED, &ce->flags);
 251 }
 252
 253 static inline bool intel_context_set_banned(struct intel_context *ce)
 254 {
 255         return test_and_set_bit(CONTEXT_BANNED, &ce->flags);
 256 }
 257
 258 static inline bool intel_context_ban(struct intel_context *ce,
 259                                      struct i915_request *rq)
 260 {
 261         bool ret = intel_context_set_banned(ce);
 262
 263         trace_intel_context_ban(ce);
 264         if (ce->ops->ban)
 265                 ce->ops->ban(ce, rq);
 266
 267         return ret;
 268 }
 269
 270 static inline bool
 271 intel_context_force_single_submission(const struct intel_context *ce)
 272 {
 273         return test_bit(CONTEXT_FORCE_SINGLE_SUBMISSION, &ce->flags);
 274 }
 275
 276 static inline void
 277 intel_context_set_single_submission(struct intel_context *ce)
 278 {
 279         __set_bit(CONTEXT_FORCE_SINGLE_SUBMISSION, &ce->flags);
 280 }
 281
 282 static inline bool
 283 intel_context_nopreempt(const struct intel_context *ce)
 284 {
 285         return test_bit(CONTEXT_NOPREEMPT, &ce->flags);
 286 }
 287
 288 static inline void
 289 intel_context_set_nopreempt(struct intel_context *ce)
 290 {
 291         set_bit(CONTEXT_NOPREEMPT, &ce->flags);
 292 }
 293
 294 static inline void
 295 intel_context_clear_nopreempt(struct intel_context *ce)
 296 {
 297         clear_bit(CONTEXT_NOPREEMPT, &ce->flags);
 298 }
 299
 300 static inline u64 intel_context_get_total_runtime_ns(struct intel_context *ce)
 301 {
 302         const u32 period = ce->engine->gt->clock_period_ns;
 303
 304         return READ_ONCE(ce->runtime.total) * period;
 305 }
 306
 307 static inline u64 intel_context_get_avg_runtime_ns(struct intel_context *ce)
 308 {
 309         const u32 period = ce->engine->gt->clock_period_ns;
 310
 311         return mul_u32_u32(ewma_runtime_read(&ce->runtime.avg), period);
 312 }
 313
 314 #endif /* __INTEL_CONTEXT_H__ */