drm/i915: Dump the engine state before declaring wedged from wait_for_engines()
[linux-block.git] / drivers / gpu / drm / i915 / i915_sw_fence.c
CommitLineData
e68a139f
CW
1/*
2 * (C) Copyright 2016 Intel Corporation
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; version 2
7 * of the License.
8 */
9
10#include <linux/slab.h>
f54d1867 11#include <linux/dma-fence.h>
81c0ed21 12#include <linux/irq_work.h>
e68a139f
CW
13#include <linux/reservation.h>
14
15#include "i915_sw_fence.h"
47624cc3 16#include "i915_selftest.h"
e68a139f 17
7e941861
CW
18#define I915_SW_FENCE_FLAG_ALLOC BIT(3) /* after WQ_FLAG_* for safety */
19
e68a139f
CW
20static DEFINE_SPINLOCK(i915_sw_fence_lock);
21
fc158405
CW
22enum {
23 DEBUG_FENCE_IDLE = 0,
24 DEBUG_FENCE_NOTIFY,
25};
26
27#ifdef CONFIG_DRM_I915_SW_FENCE_DEBUG_OBJECTS
28
29static void *i915_sw_fence_debug_hint(void *addr)
30{
31 return (void *)(((struct i915_sw_fence *)addr)->flags & I915_SW_FENCE_MASK);
32}
33
34static struct debug_obj_descr i915_sw_fence_debug_descr = {
35 .name = "i915_sw_fence",
36 .debug_hint = i915_sw_fence_debug_hint,
37};
38
39static inline void debug_fence_init(struct i915_sw_fence *fence)
40{
41 debug_object_init(fence, &i915_sw_fence_debug_descr);
42}
43
214707fc
CW
44static inline void debug_fence_init_onstack(struct i915_sw_fence *fence)
45{
46 debug_object_init_on_stack(fence, &i915_sw_fence_debug_descr);
47}
48
fc158405
CW
49static inline void debug_fence_activate(struct i915_sw_fence *fence)
50{
51 debug_object_activate(fence, &i915_sw_fence_debug_descr);
52}
53
54static inline void debug_fence_set_state(struct i915_sw_fence *fence,
55 int old, int new)
56{
57 debug_object_active_state(fence, &i915_sw_fence_debug_descr, old, new);
58}
59
60static inline void debug_fence_deactivate(struct i915_sw_fence *fence)
61{
62 debug_object_deactivate(fence, &i915_sw_fence_debug_descr);
63}
64
65static inline void debug_fence_destroy(struct i915_sw_fence *fence)
66{
67 debug_object_destroy(fence, &i915_sw_fence_debug_descr);
68}
69
70static inline void debug_fence_free(struct i915_sw_fence *fence)
71{
72 debug_object_free(fence, &i915_sw_fence_debug_descr);
6f13f29f 73 smp_wmb(); /* flush the change in state before reallocation */
fc158405
CW
74}
75
76static inline void debug_fence_assert(struct i915_sw_fence *fence)
77{
78 debug_object_assert_init(fence, &i915_sw_fence_debug_descr);
79}
80
81#else
82
83static inline void debug_fence_init(struct i915_sw_fence *fence)
84{
85}
86
214707fc
CW
87static inline void debug_fence_init_onstack(struct i915_sw_fence *fence)
88{
89}
90
fc158405
CW
91static inline void debug_fence_activate(struct i915_sw_fence *fence)
92{
93}
94
95static inline void debug_fence_set_state(struct i915_sw_fence *fence,
96 int old, int new)
97{
98}
99
100static inline void debug_fence_deactivate(struct i915_sw_fence *fence)
101{
102}
103
104static inline void debug_fence_destroy(struct i915_sw_fence *fence)
105{
106}
107
108static inline void debug_fence_free(struct i915_sw_fence *fence)
109{
110}
111
112static inline void debug_fence_assert(struct i915_sw_fence *fence)
113{
114}
115
116#endif
117
e68a139f
CW
118static int __i915_sw_fence_notify(struct i915_sw_fence *fence,
119 enum i915_sw_fence_notify state)
120{
121 i915_sw_fence_notify_t fn;
122
123 fn = (i915_sw_fence_notify_t)(fence->flags & I915_SW_FENCE_MASK);
124 return fn(fence, state);
125}
126
fc158405
CW
127#ifdef CONFIG_DRM_I915_SW_FENCE_DEBUG_OBJECTS
128void i915_sw_fence_fini(struct i915_sw_fence *fence)
129{
130 debug_fence_free(fence);
131}
132#endif
133
e68a139f
CW
134static void __i915_sw_fence_wake_up_all(struct i915_sw_fence *fence,
135 struct list_head *continuation)
136{
137 wait_queue_head_t *x = &fence->wait;
ac6424b9 138 wait_queue_entry_t *pos, *next;
e68a139f
CW
139 unsigned long flags;
140
fc158405 141 debug_fence_deactivate(fence);
e68a139f
CW
142 atomic_set_release(&fence->pending, -1); /* 0 -> -1 [done] */
143
144 /*
145 * To prevent unbounded recursion as we traverse the graph of
2055da97
IM
146 * i915_sw_fences, we move the entry list from this, the next ready
147 * fence, to the tail of the original fence's entry list
e68a139f
CW
148 * (and so added to the list to be woken).
149 */
150
151 spin_lock_irqsave_nested(&x->lock, flags, 1 + !!continuation);
152 if (continuation) {
2055da97 153 list_for_each_entry_safe(pos, next, &x->head, entry) {
e68a139f
CW
154 if (pos->func == autoremove_wake_function)
155 pos->func(pos, TASK_NORMAL, 0, continuation);
156 else
2055da97 157 list_move_tail(&pos->entry, continuation);
e68a139f
CW
158 }
159 } else {
160 LIST_HEAD(extra);
161
162 do {
2055da97 163 list_for_each_entry_safe(pos, next, &x->head, entry)
e68a139f
CW
164 pos->func(pos, TASK_NORMAL, 0, &extra);
165
166 if (list_empty(&extra))
167 break;
168
2055da97 169 list_splice_tail_init(&extra, &x->head);
e68a139f
CW
170 } while (1);
171 }
172 spin_unlock_irqrestore(&x->lock, flags);
fc158405
CW
173
174 debug_fence_assert(fence);
e68a139f
CW
175}
176
177static void __i915_sw_fence_complete(struct i915_sw_fence *fence,
178 struct list_head *continuation)
179{
fc158405
CW
180 debug_fence_assert(fence);
181
e68a139f
CW
182 if (!atomic_dec_and_test(&fence->pending))
183 return;
184
fc158405
CW
185 debug_fence_set_state(fence, DEBUG_FENCE_IDLE, DEBUG_FENCE_NOTIFY);
186
9310cb7f 187 if (__i915_sw_fence_notify(fence, FENCE_COMPLETE) != NOTIFY_DONE)
e68a139f
CW
188 return;
189
fc158405
CW
190 debug_fence_set_state(fence, DEBUG_FENCE_NOTIFY, DEBUG_FENCE_IDLE);
191
e68a139f 192 __i915_sw_fence_wake_up_all(fence, continuation);
9310cb7f
CW
193
194 debug_fence_destroy(fence);
195 __i915_sw_fence_notify(fence, FENCE_FREE);
e68a139f
CW
196}
197
198static void i915_sw_fence_complete(struct i915_sw_fence *fence)
199{
fc158405
CW
200 debug_fence_assert(fence);
201
e68a139f
CW
202 if (WARN_ON(i915_sw_fence_done(fence)))
203 return;
204
205 __i915_sw_fence_complete(fence, NULL);
206}
207
208static void i915_sw_fence_await(struct i915_sw_fence *fence)
209{
fc158405 210 debug_fence_assert(fence);
e68a139f
CW
211 WARN_ON(atomic_inc_return(&fence->pending) <= 1);
212}
213
556b7487
CW
214void __i915_sw_fence_init(struct i915_sw_fence *fence,
215 i915_sw_fence_notify_t fn,
216 const char *name,
217 struct lock_class_key *key)
e68a139f 218{
9310cb7f 219 BUG_ON(!fn || (unsigned long)fn & ~I915_SW_FENCE_MASK);
e68a139f 220
fc158405
CW
221 debug_fence_init(fence);
222
556b7487 223 __init_waitqueue_head(&fence->wait, name, key);
e68a139f
CW
224 atomic_set(&fence->pending, 1);
225 fence->flags = (unsigned long)fn;
226}
227
fc158405
CW
228void i915_sw_fence_commit(struct i915_sw_fence *fence)
229{
230 debug_fence_activate(fence);
9310cb7f 231 i915_sw_fence_complete(fence);
fc158405
CW
232}
233
ac6424b9 234static int i915_sw_fence_wake(wait_queue_entry_t *wq, unsigned mode, int flags, void *key)
e68a139f 235{
2055da97 236 list_del(&wq->entry);
e68a139f 237 __i915_sw_fence_complete(wq->private, key);
9310cb7f 238
7e941861
CW
239 if (wq->flags & I915_SW_FENCE_FLAG_ALLOC)
240 kfree(wq);
e68a139f
CW
241 return 0;
242}
243
244static bool __i915_sw_fence_check_if_after(struct i915_sw_fence *fence,
245 const struct i915_sw_fence * const signaler)
246{
ac6424b9 247 wait_queue_entry_t *wq;
e68a139f
CW
248
249 if (__test_and_set_bit(I915_SW_FENCE_CHECKED_BIT, &fence->flags))
250 return false;
251
252 if (fence == signaler)
253 return true;
254
2055da97 255 list_for_each_entry(wq, &fence->wait.head, entry) {
e68a139f
CW
256 if (wq->func != i915_sw_fence_wake)
257 continue;
258
259 if (__i915_sw_fence_check_if_after(wq->private, signaler))
260 return true;
261 }
262
263 return false;
264}
265
266static void __i915_sw_fence_clear_checked_bit(struct i915_sw_fence *fence)
267{
ac6424b9 268 wait_queue_entry_t *wq;
e68a139f
CW
269
270 if (!__test_and_clear_bit(I915_SW_FENCE_CHECKED_BIT, &fence->flags))
271 return;
272
2055da97 273 list_for_each_entry(wq, &fence->wait.head, entry) {
e68a139f
CW
274 if (wq->func != i915_sw_fence_wake)
275 continue;
276
277 __i915_sw_fence_clear_checked_bit(wq->private);
278 }
279}
280
281static bool i915_sw_fence_check_if_after(struct i915_sw_fence *fence,
282 const struct i915_sw_fence * const signaler)
283{
284 unsigned long flags;
285 bool err;
286
47624cc3 287 if (!IS_ENABLED(CONFIG_DRM_I915_SW_FENCE_CHECK_DAG))
e68a139f
CW
288 return false;
289
290 spin_lock_irqsave(&i915_sw_fence_lock, flags);
291 err = __i915_sw_fence_check_if_after(fence, signaler);
292 __i915_sw_fence_clear_checked_bit(fence);
293 spin_unlock_irqrestore(&i915_sw_fence_lock, flags);
294
295 return err;
296}
297
7e941861
CW
298static int __i915_sw_fence_await_sw_fence(struct i915_sw_fence *fence,
299 struct i915_sw_fence *signaler,
ac6424b9 300 wait_queue_entry_t *wq, gfp_t gfp)
e68a139f
CW
301{
302 unsigned long flags;
303 int pending;
304
fc158405
CW
305 debug_fence_assert(fence);
306
e68a139f
CW
307 if (i915_sw_fence_done(signaler))
308 return 0;
309
fc158405
CW
310 debug_fence_assert(signaler);
311
e68a139f
CW
312 /* The dependency graph must be acyclic. */
313 if (unlikely(i915_sw_fence_check_if_after(fence, signaler)))
314 return -EINVAL;
315
7e941861
CW
316 pending = 0;
317 if (!wq) {
318 wq = kmalloc(sizeof(*wq), gfp);
319 if (!wq) {
320 if (!gfpflags_allow_blocking(gfp))
321 return -ENOMEM;
322
323 i915_sw_fence_wait(signaler);
324 return 0;
325 }
326
327 pending |= I915_SW_FENCE_FLAG_ALLOC;
328 }
329
2055da97 330 INIT_LIST_HEAD(&wq->entry);
7e941861 331 wq->flags = pending;
e68a139f 332 wq->func = i915_sw_fence_wake;
9310cb7f 333 wq->private = fence;
e68a139f
CW
334
335 i915_sw_fence_await(fence);
336
337 spin_lock_irqsave(&signaler->wait.lock, flags);
338 if (likely(!i915_sw_fence_done(signaler))) {
ac6424b9 339 __add_wait_queue_entry_tail(&signaler->wait, wq);
e68a139f
CW
340 pending = 1;
341 } else {
342 i915_sw_fence_wake(wq, 0, 0, NULL);
343 pending = 0;
344 }
345 spin_unlock_irqrestore(&signaler->wait.lock, flags);
346
347 return pending;
348}
349
7e941861
CW
350int i915_sw_fence_await_sw_fence(struct i915_sw_fence *fence,
351 struct i915_sw_fence *signaler,
ac6424b9 352 wait_queue_entry_t *wq)
7e941861
CW
353{
354 return __i915_sw_fence_await_sw_fence(fence, signaler, wq, 0);
355}
356
357int i915_sw_fence_await_sw_fence_gfp(struct i915_sw_fence *fence,
358 struct i915_sw_fence *signaler,
359 gfp_t gfp)
360{
361 return __i915_sw_fence_await_sw_fence(fence, signaler, NULL, gfp);
362}
363
f54d1867
CW
364struct i915_sw_dma_fence_cb {
365 struct dma_fence_cb base;
e68a139f 366 struct i915_sw_fence *fence;
f54d1867 367 struct dma_fence *dma;
e68a139f 368 struct timer_list timer;
81c0ed21 369 struct irq_work work;
e68a139f
CW
370};
371
39cbf2aa 372static void timer_i915_sw_fence_wake(struct timer_list *t)
e68a139f 373{
39cbf2aa 374 struct i915_sw_dma_fence_cb *cb = from_timer(cb, t, timer);
81c0ed21
CW
375 struct i915_sw_fence *fence;
376
377 fence = xchg(&cb->fence, NULL);
378 if (!fence)
379 return;
e68a139f 380
8dfe162a
JP
381 pr_warn("asynchronous wait on fence %s:%s:%x timed out\n",
382 cb->dma->ops->get_driver_name(cb->dma),
383 cb->dma->ops->get_timeline_name(cb->dma),
384 cb->dma->seqno);
e68a139f 385
81c0ed21 386 i915_sw_fence_complete(fence);
e68a139f
CW
387}
388
f54d1867
CW
389static void dma_i915_sw_fence_wake(struct dma_fence *dma,
390 struct dma_fence_cb *data)
e68a139f 391{
f54d1867 392 struct i915_sw_dma_fence_cb *cb = container_of(data, typeof(*cb), base);
81c0ed21
CW
393 struct i915_sw_fence *fence;
394
395 fence = xchg(&cb->fence, NULL);
396 if (fence)
397 i915_sw_fence_complete(fence);
398
399 irq_work_queue(&cb->work);
400}
401
402static void irq_i915_sw_fence_work(struct irq_work *wrk)
403{
404 struct i915_sw_dma_fence_cb *cb = container_of(wrk, typeof(*cb), work);
e68a139f
CW
405
406 del_timer_sync(&cb->timer);
f54d1867 407 dma_fence_put(cb->dma);
e68a139f
CW
408
409 kfree(cb);
410}
411
412int i915_sw_fence_await_dma_fence(struct i915_sw_fence *fence,
f54d1867 413 struct dma_fence *dma,
e68a139f
CW
414 unsigned long timeout,
415 gfp_t gfp)
416{
f54d1867 417 struct i915_sw_dma_fence_cb *cb;
e68a139f
CW
418 int ret;
419
fc158405
CW
420 debug_fence_assert(fence);
421
f54d1867 422 if (dma_fence_is_signaled(dma))
e68a139f
CW
423 return 0;
424
425 cb = kmalloc(sizeof(*cb), gfp);
426 if (!cb) {
427 if (!gfpflags_allow_blocking(gfp))
428 return -ENOMEM;
429
f54d1867 430 return dma_fence_wait(dma, false);
e68a139f
CW
431 }
432
9310cb7f 433 cb->fence = fence;
e68a139f
CW
434 i915_sw_fence_await(fence);
435
436 cb->dma = NULL;
39cbf2aa 437 timer_setup(&cb->timer, timer_i915_sw_fence_wake, TIMER_IRQSAFE);
81c0ed21 438 init_irq_work(&cb->work, irq_i915_sw_fence_work);
e68a139f 439 if (timeout) {
f54d1867 440 cb->dma = dma_fence_get(dma);
e68a139f
CW
441 mod_timer(&cb->timer, round_jiffies_up(jiffies + timeout));
442 }
443
f54d1867 444 ret = dma_fence_add_callback(dma, &cb->base, dma_i915_sw_fence_wake);
e68a139f
CW
445 if (ret == 0) {
446 ret = 1;
447 } else {
448 dma_i915_sw_fence_wake(dma, &cb->base);
449 if (ret == -ENOENT) /* fence already signaled */
450 ret = 0;
451 }
452
453 return ret;
454}
455
456int i915_sw_fence_await_reservation(struct i915_sw_fence *fence,
457 struct reservation_object *resv,
f54d1867 458 const struct dma_fence_ops *exclude,
e68a139f
CW
459 bool write,
460 unsigned long timeout,
461 gfp_t gfp)
462{
f54d1867 463 struct dma_fence *excl;
e68a139f
CW
464 int ret = 0, pending;
465
fc158405
CW
466 debug_fence_assert(fence);
467
e68a139f 468 if (write) {
f54d1867 469 struct dma_fence **shared;
e68a139f
CW
470 unsigned int count, i;
471
472 ret = reservation_object_get_fences_rcu(resv,
473 &excl, &count, &shared);
474 if (ret)
475 return ret;
476
477 for (i = 0; i < count; i++) {
478 if (shared[i]->ops == exclude)
479 continue;
480
481 pending = i915_sw_fence_await_dma_fence(fence,
482 shared[i],
483 timeout,
484 gfp);
485 if (pending < 0) {
486 ret = pending;
487 break;
488 }
489
490 ret |= pending;
491 }
492
493 for (i = 0; i < count; i++)
f54d1867 494 dma_fence_put(shared[i]);
e68a139f
CW
495 kfree(shared);
496 } else {
497 excl = reservation_object_get_excl_rcu(resv);
498 }
499
500 if (ret >= 0 && excl && excl->ops != exclude) {
501 pending = i915_sw_fence_await_dma_fence(fence,
502 excl,
503 timeout,
504 gfp);
505 if (pending < 0)
506 ret = pending;
507 else
508 ret |= pending;
509 }
510
f54d1867 511 dma_fence_put(excl);
e68a139f
CW
512
513 return ret;
514}
47624cc3
CW
515
516#if IS_ENABLED(CONFIG_DRM_I915_SELFTEST)
214707fc 517#include "selftests/lib_sw_fence.c"
47624cc3
CW
518#include "selftests/i915_sw_fence.c"
519#endif