i915_gem_request.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733
  1. /*
  2. * Copyright © 2008-2015 Intel Corporation
  3. *
  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:
  10. *
  11. * The above copyright notice and this permission notice (including the next
  12. * paragraph) shall be included in all copies or substantial portions of the
  13. * Software.
  14. *
  15. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  18. * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20. * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21. * IN THE SOFTWARE.
  22. *
  23. */
  24. #ifndef I915_GEM_REQUEST_H
  25. #define I915_GEM_REQUEST_H
  26. #include <linux/dma-fence.h>
  27. #include "i915_gem.h"
  28. #include "i915_sw_fence.h"
  29. struct drm_file;
  30. struct drm_i915_gem_object;
  31. struct drm_i915_gem_request;
  32. struct intel_wait {
  33. struct rb_node node;
  34. struct task_struct *tsk;
  35. struct drm_i915_gem_request *request;
  36. u32 seqno;
  37. };
  38. struct intel_signal_node {
  39. struct rb_node node;
  40. struct intel_wait wait;
  41. };
  42. struct i915_dependency {
  43. struct i915_priotree *signaler;
  44. struct list_head signal_link;
  45. struct list_head wait_link;
  46. struct list_head dfs_link;
  47. unsigned long flags;
  48. #define I915_DEPENDENCY_ALLOC BIT(0)
  49. };
  50. /* Requests exist in a complex web of interdependencies. Each request
  51. * has to wait for some other request to complete before it is ready to be run
  52. * (e.g. we have to wait until the pixels have been rendering into a texture
  53. * before we can copy from it). We track the readiness of a request in terms
  54. * of fences, but we also need to keep the dependency tree for the lifetime
  55. * of the request (beyond the life of an individual fence). We use the tree
  56. * at various points to reorder the requests whilst keeping the requests
  57. * in order with respect to their various dependencies.
  58. */
  59. struct i915_priotree {
  60. struct list_head signalers_list; /* those before us, we depend upon */
  61. struct list_head waiters_list; /* those after us, they depend upon us */
  62. struct rb_node node;
  63. int priority;
  64. #define I915_PRIORITY_MAX 1024
  65. #define I915_PRIORITY_MIN (-I915_PRIORITY_MAX)
  66. };
  67. /**
  68. * Request queue structure.
  69. *
  70. * The request queue allows us to note sequence numbers that have been emitted
  71. * and may be associated with active buffers to be retired.
  72. *
  73. * By keeping this list, we can avoid having to do questionable sequence
  74. * number comparisons on buffer last_read|write_seqno. It also allows an
  75. * emission time to be associated with the request for tracking how far ahead
  76. * of the GPU the submission is.
  77. *
  78. * When modifying this structure be very aware that we perform a lockless
  79. * RCU lookup of it that may race against reallocation of the struct
  80. * from the slab freelist. We intentionally do not zero the structure on
  81. * allocation so that the lookup can use the dangling pointers (and is
  82. * cogniscent that those pointers may be wrong). Instead, everything that
  83. * needs to be initialised must be done so explicitly.
  84. *
  85. * The requests are reference counted.
  86. */
  87. struct drm_i915_gem_request {
  88. struct dma_fence fence;
  89. spinlock_t lock;
  90. /** On Which ring this request was generated */
  91. struct drm_i915_private *i915;
  92. /**
  93. * Context and ring buffer related to this request
  94. * Contexts are refcounted, so when this request is associated with a
  95. * context, we must increment the context's refcount, to guarantee that
  96. * it persists while any request is linked to it. Requests themselves
  97. * are also refcounted, so the request will only be freed when the last
  98. * reference to it is dismissed, and the code in
  99. * i915_gem_request_free() will then decrement the refcount on the
  100. * context.
  101. */
  102. struct i915_gem_context *ctx;
  103. struct intel_engine_cs *engine;
  104. struct intel_ring *ring;
  105. struct intel_timeline *timeline;
  106. struct intel_signal_node signaling;
  107. /* Fences for the various phases in the request's lifetime.
  108. *
  109. * The submit fence is used to await upon all of the request's
  110. * dependencies. When it is signaled, the request is ready to run.
  111. * It is used by the driver to then queue the request for execution.
  112. */
  113. struct i915_sw_fence submit;
  114. wait_queue_entry_t submitq;
  115. wait_queue_head_t execute;
  116. /* A list of everyone we wait upon, and everyone who waits upon us.
  117. * Even though we will not be submitted to the hardware before the
  118. * submit fence is signaled (it waits for all external events as well
  119. * as our own requests), the scheduler still needs to know the
  120. * dependency tree for the lifetime of the request (from execbuf
  121. * to retirement), i.e. bidirectional dependency information for the
  122. * request not tied to individual fences.
  123. */
  124. struct i915_priotree priotree;
  125. struct i915_dependency dep;
  126. /** GEM sequence number associated with this request on the
  127. * global execution timeline. It is zero when the request is not
  128. * on the HW queue (i.e. not on the engine timeline list).
  129. * Its value is guarded by the timeline spinlock.
  130. */
  131. u32 global_seqno;
  132. /** Position in the ring of the start of the request */
  133. u32 head;
  134. /**
  135. * Position in the ring of the start of the postfix.
  136. * This is required to calculate the maximum available ring space
  137. * without overwriting the postfix.
  138. */
  139. u32 postfix;
  140. /** Position in the ring of the end of the whole request */
  141. u32 tail;
  142. /** Position in the ring of the end of any workarounds after the tail */
  143. u32 wa_tail;
  144. /** Preallocate space in the ring for the emitting the request */
  145. u32 reserved_space;
  146. /** Batch buffer related to this request if any (used for
  147. * error state dump only).
  148. */
  149. struct i915_vma *batch;
  150. struct list_head active_list;
  151. /** Time at which this request was emitted, in jiffies. */
  152. unsigned long emitted_jiffies;
  153. /** engine->request_list entry for this request */
  154. struct list_head link;
  155. /** ring->request_list entry for this request */
  156. struct list_head ring_link;
  157. struct drm_i915_file_private *file_priv;
  158. /** file_priv list entry for this request */
  159. struct list_head client_link;
  160. };
  161. extern const struct dma_fence_ops i915_fence_ops;
  162. static inline bool dma_fence_is_i915(const struct dma_fence *fence)
  163. {
  164. return fence->ops == &i915_fence_ops;
  165. }
  166. struct drm_i915_gem_request * __must_check
  167. i915_gem_request_alloc(struct intel_engine_cs *engine,
  168. struct i915_gem_context *ctx);
  169. void i915_gem_request_retire_upto(struct drm_i915_gem_request *req);
  170. static inline struct drm_i915_gem_request *
  171. to_request(struct dma_fence *fence)
  172. {
  173. /* We assume that NULL fence/request are interoperable */
  174. BUILD_BUG_ON(offsetof(struct drm_i915_gem_request, fence) != 0);
  175. GEM_BUG_ON(fence && !dma_fence_is_i915(fence));
  176. return container_of(fence, struct drm_i915_gem_request, fence);
  177. }
  178. static inline struct drm_i915_gem_request *
  179. i915_gem_request_get(struct drm_i915_gem_request *req)
  180. {
  181. return to_request(dma_fence_get(&req->fence));
  182. }
  183. static inline struct drm_i915_gem_request *
  184. i915_gem_request_get_rcu(struct drm_i915_gem_request *req)
  185. {
  186. return to_request(dma_fence_get_rcu(&req->fence));
  187. }
  188. static inline void
  189. i915_gem_request_put(struct drm_i915_gem_request *req)
  190. {
  191. dma_fence_put(&req->fence);
  192. }
  193. static inline void i915_gem_request_assign(struct drm_i915_gem_request **pdst,
  194. struct drm_i915_gem_request *src)
  195. {
  196. if (src)
  197. i915_gem_request_get(src);
  198. if (*pdst)
  199. i915_gem_request_put(*pdst);
  200. *pdst = src;
  201. }
  202. /**
  203. * i915_gem_request_global_seqno - report the current global seqno
  204. * @request - the request
  205. *
  206. * A request is assigned a global seqno only when it is on the hardware
  207. * execution queue. The global seqno can be used to maintain a list of
  208. * requests on the same engine in retirement order, for example for
  209. * constructing a priority queue for waiting. Prior to its execution, or
  210. * if it is subsequently removed in the event of preemption, its global
  211. * seqno is zero. As both insertion and removal from the execution queue
  212. * may operate in IRQ context, it is not guarded by the usual struct_mutex
  213. * BKL. Instead those relying on the global seqno must be prepared for its
  214. * value to change between reads. Only when the request is complete can
  215. * the global seqno be stable (due to the memory barriers on submitting
  216. * the commands to the hardware to write the breadcrumb, if the HWS shows
  217. * that it has passed the global seqno and the global seqno is unchanged
  218. * after the read, it is indeed complete).
  219. */
  220. static u32
  221. i915_gem_request_global_seqno(const struct drm_i915_gem_request *request)
  222. {
  223. return READ_ONCE(request->global_seqno);
  224. }
  225. int
  226. i915_gem_request_await_object(struct drm_i915_gem_request *to,
  227. struct drm_i915_gem_object *obj,
  228. bool write);
  229. int i915_gem_request_await_dma_fence(struct drm_i915_gem_request *req,
  230. struct dma_fence *fence);
  231. void __i915_add_request(struct drm_i915_gem_request *req, bool flush_caches);
  232. #define i915_add_request(req) \
  233. __i915_add_request(req, false)
  234. void __i915_gem_request_submit(struct drm_i915_gem_request *request);
  235. void i915_gem_request_submit(struct drm_i915_gem_request *request);
  236. void __i915_gem_request_unsubmit(struct drm_i915_gem_request *request);
  237. void i915_gem_request_unsubmit(struct drm_i915_gem_request *request);
  238. struct intel_rps_client;
  239. #define NO_WAITBOOST ERR_PTR(-1)
  240. #define IS_RPS_CLIENT(p) (!IS_ERR(p))
  241. #define IS_RPS_USER(p) (!IS_ERR_OR_NULL(p))
  242. long i915_wait_request(struct drm_i915_gem_request *req,
  243. unsigned int flags,
  244. long timeout)
  245. __attribute__((nonnull(1)));
  246. #define I915_WAIT_INTERRUPTIBLE BIT(0)
  247. #define I915_WAIT_LOCKED BIT(1) /* struct_mutex held, handle GPU reset */
  248. #define I915_WAIT_ALL BIT(2) /* used by i915_gem_object_wait() */
  249. static inline u32 intel_engine_get_seqno(struct intel_engine_cs *engine);
  250. /**
  251. * Returns true if seq1 is later than seq2.
  252. */
  253. static inline bool i915_seqno_passed(u32 seq1, u32 seq2)
  254. {
  255. return (s32)(seq1 - seq2) >= 0;
  256. }
  257. static inline bool
  258. __i915_gem_request_started(const struct drm_i915_gem_request *req, u32 seqno)
  259. {
  260. GEM_BUG_ON(!seqno);
  261. return i915_seqno_passed(intel_engine_get_seqno(req->engine),
  262. seqno - 1);
  263. }
  264. static inline bool
  265. i915_gem_request_started(const struct drm_i915_gem_request *req)
  266. {
  267. u32 seqno;
  268. seqno = i915_gem_request_global_seqno(req);
  269. if (!seqno)
  270. return false;
  271. return __i915_gem_request_started(req, seqno);
  272. }
  273. static inline bool
  274. __i915_gem_request_completed(const struct drm_i915_gem_request *req, u32 seqno)
  275. {
  276. GEM_BUG_ON(!seqno);
  277. return i915_seqno_passed(intel_engine_get_seqno(req->engine), seqno) &&
  278. seqno == i915_gem_request_global_seqno(req);
  279. }
  280. static inline bool
  281. i915_gem_request_completed(const struct drm_i915_gem_request *req)
  282. {
  283. u32 seqno;
  284. seqno = i915_gem_request_global_seqno(req);
  285. if (!seqno)
  286. return false;
  287. return __i915_gem_request_completed(req, seqno);
  288. }
  289. bool __i915_spin_request(const struct drm_i915_gem_request *request,
  290. u32 seqno, int state, unsigned long timeout_us);
  291. static inline bool i915_spin_request(const struct drm_i915_gem_request *request,
  292. int state, unsigned long timeout_us)
  293. {
  294. u32 seqno;
  295. seqno = i915_gem_request_global_seqno(request);
  296. if (!seqno)
  297. return 0;
  298. return (__i915_gem_request_started(request, seqno) &&
  299. __i915_spin_request(request, seqno, state, timeout_us));
  300. }
  301. /* We treat requests as fences. This is not be to confused with our
  302. * "fence registers" but pipeline synchronisation objects ala GL_ARB_sync.
  303. * We use the fences to synchronize access from the CPU with activity on the
  304. * GPU, for example, we should not rewrite an object's PTE whilst the GPU
  305. * is reading them. We also track fences at a higher level to provide
  306. * implicit synchronisation around GEM objects, e.g. set-domain will wait
  307. * for outstanding GPU rendering before marking the object ready for CPU
  308. * access, or a pageflip will wait until the GPU is complete before showing
  309. * the frame on the scanout.
  310. *
  311. * In order to use a fence, the object must track the fence it needs to
  312. * serialise with. For example, GEM objects want to track both read and
  313. * write access so that we can perform concurrent read operations between
  314. * the CPU and GPU engines, as well as waiting for all rendering to
  315. * complete, or waiting for the last GPU user of a "fence register". The
  316. * object then embeds a #i915_gem_active to track the most recent (in
  317. * retirement order) request relevant for the desired mode of access.
  318. * The #i915_gem_active is updated with i915_gem_active_set() to track the
  319. * most recent fence request, typically this is done as part of
  320. * i915_vma_move_to_active().
  321. *
  322. * When the #i915_gem_active completes (is retired), it will
  323. * signal its completion to the owner through a callback as well as mark
  324. * itself as idle (i915_gem_active.request == NULL). The owner
  325. * can then perform any action, such as delayed freeing of an active
  326. * resource including itself.
  327. */
  328. struct i915_gem_active;
  329. typedef void (*i915_gem_retire_fn)(struct i915_gem_active *,
  330. struct drm_i915_gem_request *);
  331. struct i915_gem_active {
  332. struct drm_i915_gem_request __rcu *request;
  333. struct list_head link;
  334. i915_gem_retire_fn retire;
  335. };
  336. void i915_gem_retire_noop(struct i915_gem_active *,
  337. struct drm_i915_gem_request *request);
  338. /**
  339. * init_request_active - prepares the activity tracker for use
  340. * @active - the active tracker
  341. * @func - a callback when then the tracker is retired (becomes idle),
  342. * can be NULL
  343. *
  344. * init_request_active() prepares the embedded @active struct for use as
  345. * an activity tracker, that is for tracking the last known active request
  346. * associated with it. When the last request becomes idle, when it is retired
  347. * after completion, the optional callback @func is invoked.
  348. */
  349. static inline void
  350. init_request_active(struct i915_gem_active *active,
  351. i915_gem_retire_fn retire)
  352. {
  353. INIT_LIST_HEAD(&active->link);
  354. active->retire = retire ?: i915_gem_retire_noop;
  355. }
  356. /**
  357. * i915_gem_active_set - updates the tracker to watch the current request
  358. * @active - the active tracker
  359. * @request - the request to watch
  360. *
  361. * i915_gem_active_set() watches the given @request for completion. Whilst
  362. * that @request is busy, the @active reports busy. When that @request is
  363. * retired, the @active tracker is updated to report idle.
  364. */
  365. static inline void
  366. i915_gem_active_set(struct i915_gem_active *active,
  367. struct drm_i915_gem_request *request)
  368. {
  369. list_move(&active->link, &request->active_list);
  370. rcu_assign_pointer(active->request, request);
  371. }
  372. /**
  373. * i915_gem_active_set_retire_fn - updates the retirement callback
  374. * @active - the active tracker
  375. * @fn - the routine called when the request is retired
  376. * @mutex - struct_mutex used to guard retirements
  377. *
  378. * i915_gem_active_set_retire_fn() updates the function pointer that
  379. * is called when the final request associated with the @active tracker
  380. * is retired.
  381. */
  382. static inline void
  383. i915_gem_active_set_retire_fn(struct i915_gem_active *active,
  384. i915_gem_retire_fn fn,
  385. struct mutex *mutex)
  386. {
  387. lockdep_assert_held(mutex);
  388. active->retire = fn ?: i915_gem_retire_noop;
  389. }
  390. static inline struct drm_i915_gem_request *
  391. __i915_gem_active_peek(const struct i915_gem_active *active)
  392. {
  393. /* Inside the error capture (running with the driver in an unknown
  394. * state), we want to bend the rules slightly (a lot).
  395. *
  396. * Work is in progress to make it safer, in the meantime this keeps
  397. * the known issue from spamming the logs.
  398. */
  399. return rcu_dereference_protected(active->request, 1);
  400. }
  401. /**
  402. * i915_gem_active_raw - return the active request
  403. * @active - the active tracker
  404. *
  405. * i915_gem_active_raw() returns the current request being tracked, or NULL.
  406. * It does not obtain a reference on the request for the caller, so the caller
  407. * must hold struct_mutex.
  408. */
  409. static inline struct drm_i915_gem_request *
  410. i915_gem_active_raw(const struct i915_gem_active *active, struct mutex *mutex)
  411. {
  412. return rcu_dereference_protected(active->request,
  413. lockdep_is_held(mutex));
  414. }
  415. /**
  416. * i915_gem_active_peek - report the active request being monitored
  417. * @active - the active tracker
  418. *
  419. * i915_gem_active_peek() returns the current request being tracked if
  420. * still active, or NULL. It does not obtain a reference on the request
  421. * for the caller, so the caller must hold struct_mutex.
  422. */
  423. static inline struct drm_i915_gem_request *
  424. i915_gem_active_peek(const struct i915_gem_active *active, struct mutex *mutex)
  425. {
  426. struct drm_i915_gem_request *request;
  427. request = i915_gem_active_raw(active, mutex);
  428. if (!request || i915_gem_request_completed(request))
  429. return NULL;
  430. return request;
  431. }
  432. /**
  433. * i915_gem_active_get - return a reference to the active request
  434. * @active - the active tracker
  435. *
  436. * i915_gem_active_get() returns a reference to the active request, or NULL
  437. * if the active tracker is idle. The caller must hold struct_mutex.
  438. */
  439. static inline struct drm_i915_gem_request *
  440. i915_gem_active_get(const struct i915_gem_active *active, struct mutex *mutex)
  441. {
  442. return i915_gem_request_get(i915_gem_active_peek(active, mutex));
  443. }
  444. /**
  445. * __i915_gem_active_get_rcu - return a reference to the active request
  446. * @active - the active tracker
  447. *
  448. * __i915_gem_active_get() returns a reference to the active request, or NULL
  449. * if the active tracker is idle. The caller must hold the RCU read lock, but
  450. * the returned pointer is safe to use outside of RCU.
  451. */
  452. static inline struct drm_i915_gem_request *
  453. __i915_gem_active_get_rcu(const struct i915_gem_active *active)
  454. {
  455. /* Performing a lockless retrieval of the active request is super
  456. * tricky. SLAB_TYPESAFE_BY_RCU merely guarantees that the backing
  457. * slab of request objects will not be freed whilst we hold the
  458. * RCU read lock. It does not guarantee that the request itself
  459. * will not be freed and then *reused*. Viz,
  460. *
  461. * Thread A Thread B
  462. *
  463. * req = active.request
  464. * retire(req) -> free(req);
  465. * (req is now first on the slab freelist)
  466. * active.request = NULL
  467. *
  468. * req = new submission on a new object
  469. * ref(req)
  470. *
  471. * To prevent the request from being reused whilst the caller
  472. * uses it, we take a reference like normal. Whilst acquiring
  473. * the reference we check that it is not in a destroyed state
  474. * (refcnt == 0). That prevents the request being reallocated
  475. * whilst the caller holds on to it. To check that the request
  476. * was not reallocated as we acquired the reference we have to
  477. * check that our request remains the active request across
  478. * the lookup, in the same manner as a seqlock. The visibility
  479. * of the pointer versus the reference counting is controlled
  480. * by using RCU barriers (rcu_dereference and rcu_assign_pointer).
  481. *
  482. * In the middle of all that, we inspect whether the request is
  483. * complete. Retiring is lazy so the request may be completed long
  484. * before the active tracker is updated. Querying whether the
  485. * request is complete is far cheaper (as it involves no locked
  486. * instructions setting cachelines to exclusive) than acquiring
  487. * the reference, so we do it first. The RCU read lock ensures the
  488. * pointer dereference is valid, but does not ensure that the
  489. * seqno nor HWS is the right one! However, if the request was
  490. * reallocated, that means the active tracker's request was complete.
  491. * If the new request is also complete, then both are and we can
  492. * just report the active tracker is idle. If the new request is
  493. * incomplete, then we acquire a reference on it and check that
  494. * it remained the active request.
  495. *
  496. * It is then imperative that we do not zero the request on
  497. * reallocation, so that we can chase the dangling pointers!
  498. * See i915_gem_request_alloc().
  499. */
  500. do {
  501. struct drm_i915_gem_request *request;
  502. request = rcu_dereference(active->request);
  503. if (!request || i915_gem_request_completed(request))
  504. return NULL;
  505. /* An especially silly compiler could decide to recompute the
  506. * result of i915_gem_request_completed, more specifically
  507. * re-emit the load for request->fence.seqno. A race would catch
  508. * a later seqno value, which could flip the result from true to
  509. * false. Which means part of the instructions below might not
  510. * be executed, while later on instructions are executed. Due to
  511. * barriers within the refcounting the inconsistency can't reach
  512. * past the call to i915_gem_request_get_rcu, but not executing
  513. * that while still executing i915_gem_request_put() creates
  514. * havoc enough. Prevent this with a compiler barrier.
  515. */
  516. barrier();
  517. request = i915_gem_request_get_rcu(request);
  518. /* What stops the following rcu_access_pointer() from occurring
  519. * before the above i915_gem_request_get_rcu()? If we were
  520. * to read the value before pausing to get the reference to
  521. * the request, we may not notice a change in the active
  522. * tracker.
  523. *
  524. * The rcu_access_pointer() is a mere compiler barrier, which
  525. * means both the CPU and compiler are free to perform the
  526. * memory read without constraint. The compiler only has to
  527. * ensure that any operations after the rcu_access_pointer()
  528. * occur afterwards in program order. This means the read may
  529. * be performed earlier by an out-of-order CPU, or adventurous
  530. * compiler.
  531. *
  532. * The atomic operation at the heart of
  533. * i915_gem_request_get_rcu(), see dma_fence_get_rcu(), is
  534. * atomic_inc_not_zero() which is only a full memory barrier
  535. * when successful. That is, if i915_gem_request_get_rcu()
  536. * returns the request (and so with the reference counted
  537. * incremented) then the following read for rcu_access_pointer()
  538. * must occur after the atomic operation and so confirm
  539. * that this request is the one currently being tracked.
  540. *
  541. * The corresponding write barrier is part of
  542. * rcu_assign_pointer().
  543. */
  544. if (!request || request == rcu_access_pointer(active->request))
  545. return rcu_pointer_handoff(request);
  546. i915_gem_request_put(request);
  547. } while (1);
  548. }
  549. /**
  550. * i915_gem_active_get_unlocked - return a reference to the active request
  551. * @active - the active tracker
  552. *
  553. * i915_gem_active_get_unlocked() returns a reference to the active request,
  554. * or NULL if the active tracker is idle. The reference is obtained under RCU,
  555. * so no locking is required by the caller.
  556. *
  557. * The reference should be freed with i915_gem_request_put().
  558. */
  559. static inline struct drm_i915_gem_request *
  560. i915_gem_active_get_unlocked(const struct i915_gem_active *active)
  561. {
  562. struct drm_i915_gem_request *request;
  563. rcu_read_lock();
  564. request = __i915_gem_active_get_rcu(active);
  565. rcu_read_unlock();
  566. return request;
  567. }
  568. /**
  569. * i915_gem_active_isset - report whether the active tracker is assigned
  570. * @active - the active tracker
  571. *
  572. * i915_gem_active_isset() returns true if the active tracker is currently
  573. * assigned to a request. Due to the lazy retiring, that request may be idle
  574. * and this may report stale information.
  575. */
  576. static inline bool
  577. i915_gem_active_isset(const struct i915_gem_active *active)
  578. {
  579. return rcu_access_pointer(active->request);
  580. }
  581. /**
  582. * i915_gem_active_wait - waits until the request is completed
  583. * @active - the active request on which to wait
  584. * @flags - how to wait
  585. * @timeout - how long to wait at most
  586. * @rps - userspace client to charge for a waitboost
  587. *
  588. * i915_gem_active_wait() waits until the request is completed before
  589. * returning, without requiring any locks to be held. Note that it does not
  590. * retire any requests before returning.
  591. *
  592. * This function relies on RCU in order to acquire the reference to the active
  593. * request without holding any locks. See __i915_gem_active_get_rcu() for the
  594. * glory details on how that is managed. Once the reference is acquired, we
  595. * can then wait upon the request, and afterwards release our reference,
  596. * free of any locking.
  597. *
  598. * This function wraps i915_wait_request(), see it for the full details on
  599. * the arguments.
  600. *
  601. * Returns 0 if successful, or a negative error code.
  602. */
  603. static inline int
  604. i915_gem_active_wait(const struct i915_gem_active *active, unsigned int flags)
  605. {
  606. struct drm_i915_gem_request *request;
  607. long ret = 0;
  608. request = i915_gem_active_get_unlocked(active);
  609. if (request) {
  610. ret = i915_wait_request(request, flags, MAX_SCHEDULE_TIMEOUT);
  611. i915_gem_request_put(request);
  612. }
  613. return ret < 0 ? ret : 0;
  614. }
  615. /**
  616. * i915_gem_active_retire - waits until the request is retired
  617. * @active - the active request on which to wait
  618. *
  619. * i915_gem_active_retire() waits until the request is completed,
  620. * and then ensures that at least the retirement handler for this
  621. * @active tracker is called before returning. If the @active
  622. * tracker is idle, the function returns immediately.
  623. */
  624. static inline int __must_check
  625. i915_gem_active_retire(struct i915_gem_active *active,
  626. struct mutex *mutex)
  627. {
  628. struct drm_i915_gem_request *request;
  629. long ret;
  630. request = i915_gem_active_raw(active, mutex);
  631. if (!request)
  632. return 0;
  633. ret = i915_wait_request(request,
  634. I915_WAIT_INTERRUPTIBLE | I915_WAIT_LOCKED,
  635. MAX_SCHEDULE_TIMEOUT);
  636. if (ret < 0)
  637. return ret;
  638. list_del_init(&active->link);
  639. RCU_INIT_POINTER(active->request, NULL);
  640. active->retire(active, request);
  641. return 0;
  642. }
  643. #define for_each_active(mask, idx) \
  644. for (; mask ? idx = ffs(mask) - 1, 1 : 0; mask &= ~BIT(idx))
  645. #endif /* I915_GEM_REQUEST_H */