1 /*
2  * Copyright (c) 2008 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  * Authors:
24  *    Eric Anholt <eric@anholt.net>
25  *    Keith Packard <keithp@keithp.com>
26  *    Mika Kuoppala <mika.kuoppala@intel.com>
27  *
28  */
29 
30 #include <linux/ascii85.h>
31 #include <linux/highmem.h>
32 #include <linux/nmi.h>
33 #include <linux/pagevec.h>
34 #include <linux/scatterlist.h>
35 #include <linux/string_helpers.h>
36 #include <linux/utsname.h>
37 #include <linux/zlib.h>
38 
39 #include <drm/drm_cache.h>
40 #include <drm/drm_print.h>
41 
42 #include "display/intel_dmc.h"
43 #include "display/intel_overlay.h"
44 
45 #include "gem/i915_gem_context.h"
46 #include "gem/i915_gem_lmem.h"
47 #include "gt/intel_engine_regs.h"
48 #include "gt/intel_gt.h"
49 #include "gt/intel_gt_mcr.h"
50 #include "gt/intel_gt_pm.h"
51 #include "gt/intel_gt_regs.h"
52 #include "gt/uc/intel_guc_capture.h"
53 
54 #include "i915_driver.h"
55 #include "i915_drv.h"
56 #include "i915_gpu_error.h"
57 #include "i915_memcpy.h"
58 #include "i915_scatterlist.h"
59 #include "i915_utils.h"
60 
61 #define ALLOW_FAIL (__GFP_KSWAPD_RECLAIM | __GFP_RETRY_MAYFAIL | __GFP_NOWARN)
62 #define ATOMIC_MAYFAIL (GFP_ATOMIC | __GFP_NOWARN)
63 
64 static void __sg_set_buf(struct scatterlist *sg,
65 			 void *addr, unsigned int len, loff_t it)
66 {
67 	sg->page_link = (unsigned long)virt_to_page(addr);
68 	sg->offset = offset_in_page(addr);
69 	sg->length = len;
70 	sg->dma_address = it;
71 }
72 
73 static bool __i915_error_grow(struct drm_i915_error_state_buf *e, size_t len)
74 {
75 	if (!len)
76 		return false;
77 
78 	if (e->bytes + len + 1 <= e->size)
79 		return true;
80 
81 	if (e->bytes) {
82 		__sg_set_buf(e->cur++, e->buf, e->bytes, e->iter);
83 		e->iter += e->bytes;
84 		e->buf = NULL;
85 		e->bytes = 0;
86 	}
87 
88 	if (e->cur == e->end) {
89 		struct scatterlist *sgl;
90 
91 		sgl = (typeof(sgl))__get_free_page(ALLOW_FAIL);
92 		if (!sgl) {
93 			e->err = -ENOMEM;
94 			return false;
95 		}
96 
97 		if (e->cur) {
98 			e->cur->offset = 0;
99 			e->cur->length = 0;
100 			e->cur->page_link =
101 				(unsigned long)sgl | SG_CHAIN;
102 		} else {
103 			e->sgl = sgl;
104 		}
105 
106 		e->cur = sgl;
107 		e->end = sgl + SG_MAX_SINGLE_ALLOC - 1;
108 	}
109 
110 	e->size = ALIGN(len + 1, SZ_64K);
111 	e->buf = kmalloc(e->size, ALLOW_FAIL);
112 	if (!e->buf) {
113 		e->size = PAGE_ALIGN(len + 1);
114 		e->buf = kmalloc(e->size, GFP_KERNEL);
115 	}
116 	if (!e->buf) {
117 		e->err = -ENOMEM;
118 		return false;
119 	}
120 
121 	return true;
122 }
123 
124 __printf(2, 0)
125 static void i915_error_vprintf(struct drm_i915_error_state_buf *e,
126 			       const char *fmt, va_list args)
127 {
128 	va_list ap;
129 	int len;
130 
131 	if (e->err)
132 		return;
133 
134 	va_copy(ap, args);
135 	len = vsnprintf(NULL, 0, fmt, ap);
136 	va_end(ap);
137 	if (len <= 0) {
138 		e->err = len;
139 		return;
140 	}
141 
142 	if (!__i915_error_grow(e, len))
143 		return;
144 
145 	GEM_BUG_ON(e->bytes >= e->size);
146 	len = vscnprintf(e->buf + e->bytes, e->size - e->bytes, fmt, args);
147 	if (len < 0) {
148 		e->err = len;
149 		return;
150 	}
151 	e->bytes += len;
152 }
153 
154 static void i915_error_puts(struct drm_i915_error_state_buf *e, const char *str)
155 {
156 	unsigned len;
157 
158 	if (e->err || !str)
159 		return;
160 
161 	len = strlen(str);
162 	if (!__i915_error_grow(e, len))
163 		return;
164 
165 	GEM_BUG_ON(e->bytes + len > e->size);
166 	memcpy(e->buf + e->bytes, str, len);
167 	e->bytes += len;
168 }
169 
170 #define err_printf(e, ...) i915_error_printf(e, __VA_ARGS__)
171 #define err_puts(e, s) i915_error_puts(e, s)
172 
173 static void __i915_printfn_error(struct drm_printer *p, struct va_format *vaf)
174 {
175 	i915_error_vprintf(p->arg, vaf->fmt, *vaf->va);
176 }
177 
178 static inline struct drm_printer
179 i915_error_printer(struct drm_i915_error_state_buf *e)
180 {
181 	struct drm_printer p = {
182 		.printfn = __i915_printfn_error,
183 		.arg = e,
184 	};
185 	return p;
186 }
187 
188 /* single threaded page allocator with a reserved stash for emergencies */
189 static void pool_fini(struct pagevec *pv)
190 {
191 	pagevec_release(pv);
192 }
193 
194 static int pool_refill(struct pagevec *pv, gfp_t gfp)
195 {
196 	while (pagevec_space(pv)) {
197 		struct page *p;
198 
199 		p = alloc_page(gfp);
200 		if (!p)
201 			return -ENOMEM;
202 
203 		pagevec_add(pv, p);
204 	}
205 
206 	return 0;
207 }
208 
209 static int pool_init(struct pagevec *pv, gfp_t gfp)
210 {
211 	int err;
212 
213 	pagevec_init(pv);
214 
215 	err = pool_refill(pv, gfp);
216 	if (err)
217 		pool_fini(pv);
218 
219 	return err;
220 }
221 
222 static void *pool_alloc(struct pagevec *pv, gfp_t gfp)
223 {
224 	struct page *p;
225 
226 	p = alloc_page(gfp);
227 	if (!p && pagevec_count(pv))
228 		p = pv->pages[--pv->nr];
229 
230 	return p ? page_address(p) : NULL;
231 }
232 
233 static void pool_free(struct pagevec *pv, void *addr)
234 {
235 	struct page *p = virt_to_page(addr);
236 
237 	if (pagevec_space(pv))
238 		pagevec_add(pv, p);
239 	else
240 		__free_page(p);
241 }
242 
243 #ifdef CONFIG_DRM_I915_COMPRESS_ERROR
244 
245 struct i915_vma_compress {
246 	struct pagevec pool;
247 	struct z_stream_s zstream;
248 	void *tmp;
249 };
250 
251 static bool compress_init(struct i915_vma_compress *c)
252 {
253 	struct z_stream_s *zstream = &c->zstream;
254 
255 	if (pool_init(&c->pool, ALLOW_FAIL))
256 		return false;
257 
258 	zstream->workspace =
259 		kmalloc(zlib_deflate_workspacesize(MAX_WBITS, MAX_MEM_LEVEL),
260 			ALLOW_FAIL);
261 	if (!zstream->workspace) {
262 		pool_fini(&c->pool);
263 		return false;
264 	}
265 
266 	c->tmp = NULL;
267 	if (i915_has_memcpy_from_wc())
268 		c->tmp = pool_alloc(&c->pool, ALLOW_FAIL);
269 
270 	return true;
271 }
272 
273 static bool compress_start(struct i915_vma_compress *c)
274 {
275 	struct z_stream_s *zstream = &c->zstream;
276 	void *workspace = zstream->workspace;
277 
278 	memset(zstream, 0, sizeof(*zstream));
279 	zstream->workspace = workspace;
280 
281 	return zlib_deflateInit(zstream, Z_DEFAULT_COMPRESSION) == Z_OK;
282 }
283 
284 static void *compress_next_page(struct i915_vma_compress *c,
285 				struct i915_vma_coredump *dst)
286 {
287 	void *page_addr;
288 	struct page *page;
289 
290 	page_addr = pool_alloc(&c->pool, ALLOW_FAIL);
291 	if (!page_addr)
292 		return ERR_PTR(-ENOMEM);
293 
294 	page = virt_to_page(page_addr);
295 	list_add_tail(&page->lru, &dst->page_list);
296 	return page_addr;
297 }
298 
299 static int compress_page(struct i915_vma_compress *c,
300 			 void *src,
301 			 struct i915_vma_coredump *dst,
302 			 bool wc)
303 {
304 	struct z_stream_s *zstream = &c->zstream;
305 
306 	zstream->next_in = src;
307 	if (wc && c->tmp && i915_memcpy_from_wc(c->tmp, src, PAGE_SIZE))
308 		zstream->next_in = c->tmp;
309 	zstream->avail_in = PAGE_SIZE;
310 
311 	do {
312 		if (zstream->avail_out == 0) {
313 			zstream->next_out = compress_next_page(c, dst);
314 			if (IS_ERR(zstream->next_out))
315 				return PTR_ERR(zstream->next_out);
316 
317 			zstream->avail_out = PAGE_SIZE;
318 		}
319 
320 		if (zlib_deflate(zstream, Z_NO_FLUSH) != Z_OK)
321 			return -EIO;
322 
323 		cond_resched();
324 	} while (zstream->avail_in);
325 
326 	/* Fallback to uncompressed if we increase size? */
327 	if (0 && zstream->total_out > zstream->total_in)
328 		return -E2BIG;
329 
330 	return 0;
331 }
332 
333 static int compress_flush(struct i915_vma_compress *c,
334 			  struct i915_vma_coredump *dst)
335 {
336 	struct z_stream_s *zstream = &c->zstream;
337 
338 	do {
339 		switch (zlib_deflate(zstream, Z_FINISH)) {
340 		case Z_OK: /* more space requested */
341 			zstream->next_out = compress_next_page(c, dst);
342 			if (IS_ERR(zstream->next_out))
343 				return PTR_ERR(zstream->next_out);
344 
345 			zstream->avail_out = PAGE_SIZE;
346 			break;
347 
348 		case Z_STREAM_END:
349 			goto end;
350 
351 		default: /* any error */
352 			return -EIO;
353 		}
354 	} while (1);
355 
356 end:
357 	memset(zstream->next_out, 0, zstream->avail_out);
358 	dst->unused = zstream->avail_out;
359 	return 0;
360 }
361 
362 static void compress_finish(struct i915_vma_compress *c)
363 {
364 	zlib_deflateEnd(&c->zstream);
365 }
366 
367 static void compress_fini(struct i915_vma_compress *c)
368 {
369 	kfree(c->zstream.workspace);
370 	if (c->tmp)
371 		pool_free(&c->pool, c->tmp);
372 	pool_fini(&c->pool);
373 }
374 
375 static void err_compression_marker(struct drm_i915_error_state_buf *m)
376 {
377 	err_puts(m, ":");
378 }
379 
380 #else
381 
382 struct i915_vma_compress {
383 	struct pagevec pool;
384 };
385 
386 static bool compress_init(struct i915_vma_compress *c)
387 {
388 	return pool_init(&c->pool, ALLOW_FAIL) == 0;
389 }
390 
391 static bool compress_start(struct i915_vma_compress *c)
392 {
393 	return true;
394 }
395 
396 static int compress_page(struct i915_vma_compress *c,
397 			 void *src,
398 			 struct i915_vma_coredump *dst,
399 			 bool wc)
400 {
401 	void *ptr;
402 
403 	ptr = pool_alloc(&c->pool, ALLOW_FAIL);
404 	if (!ptr)
405 		return -ENOMEM;
406 
407 	if (!(wc && i915_memcpy_from_wc(ptr, src, PAGE_SIZE)))
408 		memcpy(ptr, src, PAGE_SIZE);
409 	list_add_tail(&virt_to_page(ptr)->lru, &dst->page_list);
410 	cond_resched();
411 
412 	return 0;
413 }
414 
415 static int compress_flush(struct i915_vma_compress *c,
416 			  struct i915_vma_coredump *dst)
417 {
418 	return 0;
419 }
420 
421 static void compress_finish(struct i915_vma_compress *c)
422 {
423 }
424 
425 static void compress_fini(struct i915_vma_compress *c)
426 {
427 	pool_fini(&c->pool);
428 }
429 
430 static void err_compression_marker(struct drm_i915_error_state_buf *m)
431 {
432 	err_puts(m, "~");
433 }
434 
435 #endif
436 
437 static void error_print_instdone(struct drm_i915_error_state_buf *m,
438 				 const struct intel_engine_coredump *ee)
439 {
440 	int slice;
441 	int subslice;
442 	int iter;
443 
444 	err_printf(m, "  INSTDONE: 0x%08x\n",
445 		   ee->instdone.instdone);
446 
447 	if (ee->engine->class != RENDER_CLASS || GRAPHICS_VER(m->i915) <= 3)
448 		return;
449 
450 	err_printf(m, "  SC_INSTDONE: 0x%08x\n",
451 		   ee->instdone.slice_common);
452 
453 	if (GRAPHICS_VER(m->i915) <= 6)
454 		return;
455 
456 	for_each_ss_steering(iter, ee->engine->gt, slice, subslice)
457 		err_printf(m, "  SAMPLER_INSTDONE[%d][%d]: 0x%08x\n",
458 			   slice, subslice,
459 			   ee->instdone.sampler[slice][subslice]);
460 
461 	for_each_ss_steering(iter, ee->engine->gt, slice, subslice)
462 		err_printf(m, "  ROW_INSTDONE[%d][%d]: 0x%08x\n",
463 			   slice, subslice,
464 			   ee->instdone.row[slice][subslice]);
465 
466 	if (GRAPHICS_VER(m->i915) < 12)
467 		return;
468 
469 	if (GRAPHICS_VER_FULL(m->i915) >= IP_VER(12, 55)) {
470 		for_each_ss_steering(iter, ee->engine->gt, slice, subslice)
471 			err_printf(m, "  GEOM_SVGUNIT_INSTDONE[%d][%d]: 0x%08x\n",
472 				   slice, subslice,
473 				   ee->instdone.geom_svg[slice][subslice]);
474 	}
475 
476 	err_printf(m, "  SC_INSTDONE_EXTRA: 0x%08x\n",
477 		   ee->instdone.slice_common_extra[0]);
478 	err_printf(m, "  SC_INSTDONE_EXTRA2: 0x%08x\n",
479 		   ee->instdone.slice_common_extra[1]);
480 }
481 
482 static void error_print_request(struct drm_i915_error_state_buf *m,
483 				const char *prefix,
484 				const struct i915_request_coredump *erq)
485 {
486 	if (!erq->seqno)
487 		return;
488 
489 	err_printf(m, "%s pid %d, seqno %8x:%08x%s%s, prio %d, head %08x, tail %08x\n",
490 		   prefix, erq->pid, erq->context, erq->seqno,
491 		   test_bit(DMA_FENCE_FLAG_SIGNALED_BIT,
492 			    &erq->flags) ? "!" : "",
493 		   test_bit(DMA_FENCE_FLAG_ENABLE_SIGNAL_BIT,
494 			    &erq->flags) ? "+" : "",
495 		   erq->sched_attr.priority,
496 		   erq->head, erq->tail);
497 }
498 
499 static void error_print_context(struct drm_i915_error_state_buf *m,
500 				const char *header,
501 				const struct i915_gem_context_coredump *ctx)
502 {
503 	err_printf(m, "%s%s[%d] prio %d, guilty %d active %d, runtime total %lluns, avg %lluns\n",
504 		   header, ctx->comm, ctx->pid, ctx->sched_attr.priority,
505 		   ctx->guilty, ctx->active,
506 		   ctx->total_runtime, ctx->avg_runtime);
507 }
508 
509 static struct i915_vma_coredump *
510 __find_vma(struct i915_vma_coredump *vma, const char *name)
511 {
512 	while (vma) {
513 		if (strcmp(vma->name, name) == 0)
514 			return vma;
515 		vma = vma->next;
516 	}
517 
518 	return NULL;
519 }
520 
521 struct i915_vma_coredump *
522 intel_gpu_error_find_batch(const struct intel_engine_coredump *ee)
523 {
524 	return __find_vma(ee->vma, "batch");
525 }
526 
527 static void error_print_engine(struct drm_i915_error_state_buf *m,
528 			       const struct intel_engine_coredump *ee)
529 {
530 	struct i915_vma_coredump *batch;
531 	int n;
532 
533 	err_printf(m, "%s command stream:\n", ee->engine->name);
534 	err_printf(m, "  CCID:  0x%08x\n", ee->ccid);
535 	err_printf(m, "  START: 0x%08x\n", ee->start);
536 	err_printf(m, "  HEAD:  0x%08x [0x%08x]\n", ee->head, ee->rq_head);
537 	err_printf(m, "  TAIL:  0x%08x [0x%08x, 0x%08x]\n",
538 		   ee->tail, ee->rq_post, ee->rq_tail);
539 	err_printf(m, "  CTL:   0x%08x\n", ee->ctl);
540 	err_printf(m, "  MODE:  0x%08x\n", ee->mode);
541 	err_printf(m, "  HWS:   0x%08x\n", ee->hws);
542 	err_printf(m, "  ACTHD: 0x%08x %08x\n",
543 		   (u32)(ee->acthd>>32), (u32)ee->acthd);
544 	err_printf(m, "  IPEIR: 0x%08x\n", ee->ipeir);
545 	err_printf(m, "  IPEHR: 0x%08x\n", ee->ipehr);
546 	err_printf(m, "  ESR:   0x%08x\n", ee->esr);
547 
548 	error_print_instdone(m, ee);
549 
550 	batch = intel_gpu_error_find_batch(ee);
551 	if (batch) {
552 		u64 start = batch->gtt_offset;
553 		u64 end = start + batch->gtt_size;
554 
555 		err_printf(m, "  batch: [0x%08x_%08x, 0x%08x_%08x]\n",
556 			   upper_32_bits(start), lower_32_bits(start),
557 			   upper_32_bits(end), lower_32_bits(end));
558 	}
559 	if (GRAPHICS_VER(m->i915) >= 4) {
560 		err_printf(m, "  BBADDR: 0x%08x_%08x\n",
561 			   (u32)(ee->bbaddr>>32), (u32)ee->bbaddr);
562 		err_printf(m, "  BB_STATE: 0x%08x\n", ee->bbstate);
563 		err_printf(m, "  INSTPS: 0x%08x\n", ee->instps);
564 	}
565 	err_printf(m, "  INSTPM: 0x%08x\n", ee->instpm);
566 	err_printf(m, "  FADDR: 0x%08x %08x\n", upper_32_bits(ee->faddr),
567 		   lower_32_bits(ee->faddr));
568 	if (GRAPHICS_VER(m->i915) >= 6) {
569 		err_printf(m, "  RC PSMI: 0x%08x\n", ee->rc_psmi);
570 		err_printf(m, "  FAULT_REG: 0x%08x\n", ee->fault_reg);
571 	}
572 	if (GRAPHICS_VER(m->i915) >= 11) {
573 		err_printf(m, "  NOPID: 0x%08x\n", ee->nopid);
574 		err_printf(m, "  EXCC: 0x%08x\n", ee->excc);
575 		err_printf(m, "  CMD_CCTL: 0x%08x\n", ee->cmd_cctl);
576 		err_printf(m, "  CSCMDOP: 0x%08x\n", ee->cscmdop);
577 		err_printf(m, "  CTX_SR_CTL: 0x%08x\n", ee->ctx_sr_ctl);
578 		err_printf(m, "  DMA_FADDR_HI: 0x%08x\n", ee->dma_faddr_hi);
579 		err_printf(m, "  DMA_FADDR_LO: 0x%08x\n", ee->dma_faddr_lo);
580 	}
581 	if (HAS_PPGTT(m->i915)) {
582 		err_printf(m, "  GFX_MODE: 0x%08x\n", ee->vm_info.gfx_mode);
583 
584 		if (GRAPHICS_VER(m->i915) >= 8) {
585 			int i;
586 			for (i = 0; i < 4; i++)
587 				err_printf(m, "  PDP%d: 0x%016llx\n",
588 					   i, ee->vm_info.pdp[i]);
589 		} else {
590 			err_printf(m, "  PP_DIR_BASE: 0x%08x\n",
591 				   ee->vm_info.pp_dir_base);
592 		}
593 	}
594 
595 	for (n = 0; n < ee->num_ports; n++) {
596 		err_printf(m, "  ELSP[%d]:", n);
597 		error_print_request(m, " ", &ee->execlist[n]);
598 	}
599 }
600 
601 void i915_error_printf(struct drm_i915_error_state_buf *e, const char *f, ...)
602 {
603 	va_list args;
604 
605 	va_start(args, f);
606 	i915_error_vprintf(e, f, args);
607 	va_end(args);
608 }
609 
610 void intel_gpu_error_print_vma(struct drm_i915_error_state_buf *m,
611 			       const struct intel_engine_cs *engine,
612 			       const struct i915_vma_coredump *vma)
613 {
614 	char out[ASCII85_BUFSZ];
615 	struct page *page;
616 
617 	if (!vma)
618 		return;
619 
620 	err_printf(m, "%s --- %s = 0x%08x %08x\n",
621 		   engine ? engine->name : "global", vma->name,
622 		   upper_32_bits(vma->gtt_offset),
623 		   lower_32_bits(vma->gtt_offset));
624 
625 	if (vma->gtt_page_sizes > I915_GTT_PAGE_SIZE_4K)
626 		err_printf(m, "gtt_page_sizes = 0x%08x\n", vma->gtt_page_sizes);
627 
628 	err_compression_marker(m);
629 	list_for_each_entry(page, &vma->page_list, lru) {
630 		int i, len;
631 		const u32 *addr = page_address(page);
632 
633 		len = PAGE_SIZE;
634 		if (page == list_last_entry(&vma->page_list, typeof(*page), lru))
635 			len -= vma->unused;
636 		len = ascii85_encode_len(len);
637 
638 		for (i = 0; i < len; i++)
639 			err_puts(m, ascii85_encode(addr[i], out));
640 	}
641 	err_puts(m, "\n");
642 }
643 
644 static void err_print_capabilities(struct drm_i915_error_state_buf *m,
645 				   struct i915_gpu_coredump *error)
646 {
647 	struct drm_printer p = i915_error_printer(m);
648 
649 	intel_device_info_print_static(&error->device_info, &p);
650 	intel_device_info_print_runtime(&error->runtime_info, &p);
651 	intel_driver_caps_print(&error->driver_caps, &p);
652 }
653 
654 static void err_print_params(struct drm_i915_error_state_buf *m,
655 			     const struct i915_params *params)
656 {
657 	struct drm_printer p = i915_error_printer(m);
658 
659 	i915_params_dump(params, &p);
660 }
661 
662 static void err_print_pciid(struct drm_i915_error_state_buf *m,
663 			    struct drm_i915_private *i915)
664 {
665 	struct pci_dev *pdev = to_pci_dev(i915->drm.dev);
666 
667 	err_printf(m, "PCI ID: 0x%04x\n", pdev->device);
668 	err_printf(m, "PCI Revision: 0x%02x\n", pdev->revision);
669 	err_printf(m, "PCI Subsystem: %04x:%04x\n",
670 		   pdev->subsystem_vendor,
671 		   pdev->subsystem_device);
672 }
673 
674 static void err_print_uc(struct drm_i915_error_state_buf *m,
675 			 const struct intel_uc_coredump *error_uc)
676 {
677 	struct drm_printer p = i915_error_printer(m);
678 
679 	intel_uc_fw_dump(&error_uc->guc_fw, &p);
680 	intel_uc_fw_dump(&error_uc->huc_fw, &p);
681 	intel_gpu_error_print_vma(m, NULL, error_uc->guc_log);
682 }
683 
684 static void err_free_sgl(struct scatterlist *sgl)
685 {
686 	while (sgl) {
687 		struct scatterlist *sg;
688 
689 		for (sg = sgl; !sg_is_chain(sg); sg++) {
690 			kfree(sg_virt(sg));
691 			if (sg_is_last(sg))
692 				break;
693 		}
694 
695 		sg = sg_is_last(sg) ? NULL : sg_chain_ptr(sg);
696 		free_page((unsigned long)sgl);
697 		sgl = sg;
698 	}
699 }
700 
701 static void err_print_gt_info(struct drm_i915_error_state_buf *m,
702 			      struct intel_gt_coredump *gt)
703 {
704 	struct drm_printer p = i915_error_printer(m);
705 
706 	intel_gt_info_print(&gt->info, &p);
707 	intel_sseu_print_topology(gt->_gt->i915, &gt->info.sseu, &p);
708 }
709 
710 static void err_print_gt_display(struct drm_i915_error_state_buf *m,
711 				 struct intel_gt_coredump *gt)
712 {
713 	err_printf(m, "IER: 0x%08x\n", gt->ier);
714 	err_printf(m, "DERRMR: 0x%08x\n", gt->derrmr);
715 }
716 
717 static void err_print_gt_global_nonguc(struct drm_i915_error_state_buf *m,
718 				       struct intel_gt_coredump *gt)
719 {
720 	int i;
721 
722 	err_printf(m, "GT awake: %s\n", str_yes_no(gt->awake));
723 	err_printf(m, "EIR: 0x%08x\n", gt->eir);
724 	err_printf(m, "PGTBL_ER: 0x%08x\n", gt->pgtbl_er);
725 
726 	for (i = 0; i < gt->ngtier; i++)
727 		err_printf(m, "GTIER[%d]: 0x%08x\n", i, gt->gtier[i]);
728 }
729 
730 static void err_print_gt_global(struct drm_i915_error_state_buf *m,
731 				struct intel_gt_coredump *gt)
732 {
733 	err_printf(m, "FORCEWAKE: 0x%08x\n", gt->forcewake);
734 
735 	if (IS_GRAPHICS_VER(m->i915, 6, 11)) {
736 		err_printf(m, "ERROR: 0x%08x\n", gt->error);
737 		err_printf(m, "DONE_REG: 0x%08x\n", gt->done_reg);
738 	}
739 
740 	if (GRAPHICS_VER(m->i915) >= 8)
741 		err_printf(m, "FAULT_TLB_DATA: 0x%08x 0x%08x\n",
742 			   gt->fault_data1, gt->fault_data0);
743 
744 	if (GRAPHICS_VER(m->i915) == 7)
745 		err_printf(m, "ERR_INT: 0x%08x\n", gt->err_int);
746 
747 	if (IS_GRAPHICS_VER(m->i915, 8, 11))
748 		err_printf(m, "GTT_CACHE_EN: 0x%08x\n", gt->gtt_cache);
749 
750 	if (GRAPHICS_VER(m->i915) == 12)
751 		err_printf(m, "AUX_ERR_DBG: 0x%08x\n", gt->aux_err);
752 
753 	if (GRAPHICS_VER(m->i915) >= 12) {
754 		int i;
755 
756 		for (i = 0; i < I915_MAX_SFC; i++) {
757 			/*
758 			 * SFC_DONE resides in the VD forcewake domain, so it
759 			 * only exists if the corresponding VCS engine is
760 			 * present.
761 			 */
762 			if ((gt->_gt->info.sfc_mask & BIT(i)) == 0 ||
763 			    !HAS_ENGINE(gt->_gt, _VCS(i * 2)))
764 				continue;
765 
766 			err_printf(m, "  SFC_DONE[%d]: 0x%08x\n", i,
767 				   gt->sfc_done[i]);
768 		}
769 
770 		err_printf(m, "  GAM_DONE: 0x%08x\n", gt->gam_done);
771 	}
772 }
773 
774 static void err_print_gt_fences(struct drm_i915_error_state_buf *m,
775 				struct intel_gt_coredump *gt)
776 {
777 	int i;
778 
779 	for (i = 0; i < gt->nfence; i++)
780 		err_printf(m, "  fence[%d] = %08llx\n", i, gt->fence[i]);
781 }
782 
783 static void err_print_gt_engines(struct drm_i915_error_state_buf *m,
784 				 struct intel_gt_coredump *gt)
785 {
786 	const struct intel_engine_coredump *ee;
787 
788 	for (ee = gt->engine; ee; ee = ee->next) {
789 		const struct i915_vma_coredump *vma;
790 
791 		if (ee->guc_capture_node)
792 			intel_guc_capture_print_engine_node(m, ee);
793 		else
794 			error_print_engine(m, ee);
795 
796 		err_printf(m, "  hung: %u\n", ee->hung);
797 		err_printf(m, "  engine reset count: %u\n", ee->reset_count);
798 		error_print_context(m, "  Active context: ", &ee->context);
799 
800 		for (vma = ee->vma; vma; vma = vma->next)
801 			intel_gpu_error_print_vma(m, ee->engine, vma);
802 	}
803 
804 }
805 
806 static void __err_print_to_sgl(struct drm_i915_error_state_buf *m,
807 			       struct i915_gpu_coredump *error)
808 {
809 	const struct intel_engine_coredump *ee;
810 	struct timespec64 ts;
811 
812 	if (*error->error_msg)
813 		err_printf(m, "%s\n", error->error_msg);
814 	err_printf(m, "Kernel: %s %s\n",
815 		   init_utsname()->release,
816 		   init_utsname()->machine);
817 	err_printf(m, "Driver: %s\n", DRIVER_DATE);
818 	ts = ktime_to_timespec64(error->time);
819 	err_printf(m, "Time: %lld s %ld us\n",
820 		   (s64)ts.tv_sec, ts.tv_nsec / NSEC_PER_USEC);
821 	ts = ktime_to_timespec64(error->boottime);
822 	err_printf(m, "Boottime: %lld s %ld us\n",
823 		   (s64)ts.tv_sec, ts.tv_nsec / NSEC_PER_USEC);
824 	ts = ktime_to_timespec64(error->uptime);
825 	err_printf(m, "Uptime: %lld s %ld us\n",
826 		   (s64)ts.tv_sec, ts.tv_nsec / NSEC_PER_USEC);
827 	err_printf(m, "Capture: %lu jiffies; %d ms ago\n",
828 		   error->capture, jiffies_to_msecs(jiffies - error->capture));
829 
830 	for (ee = error->gt ? error->gt->engine : NULL; ee; ee = ee->next)
831 		err_printf(m, "Active process (on ring %s): %s [%d]\n",
832 			   ee->engine->name,
833 			   ee->context.comm,
834 			   ee->context.pid);
835 
836 	err_printf(m, "Reset count: %u\n", error->reset_count);
837 	err_printf(m, "Suspend count: %u\n", error->suspend_count);
838 	err_printf(m, "Platform: %s\n", intel_platform_name(error->device_info.platform));
839 	err_printf(m, "Subplatform: 0x%x\n",
840 		   intel_subplatform(&error->runtime_info,
841 				     error->device_info.platform));
842 	err_print_pciid(m, m->i915);
843 
844 	err_printf(m, "IOMMU enabled?: %d\n", error->iommu);
845 
846 	intel_dmc_print_error_state(m, m->i915);
847 
848 	err_printf(m, "RPM wakelock: %s\n", str_yes_no(error->wakelock));
849 	err_printf(m, "PM suspended: %s\n", str_yes_no(error->suspended));
850 
851 	if (error->gt) {
852 		bool print_guc_capture = false;
853 
854 		if (error->gt->uc && error->gt->uc->is_guc_capture)
855 			print_guc_capture = true;
856 
857 		err_print_gt_display(m, error->gt);
858 		err_print_gt_global_nonguc(m, error->gt);
859 		err_print_gt_fences(m, error->gt);
860 
861 		/*
862 		 * GuC dumped global, eng-class and eng-instance registers together
863 		 * as part of engine state dump so we print in err_print_gt_engines
864 		 */
865 		if (!print_guc_capture)
866 			err_print_gt_global(m, error->gt);
867 
868 		err_print_gt_engines(m, error->gt);
869 
870 		if (error->gt->uc)
871 			err_print_uc(m, error->gt->uc);
872 
873 		err_print_gt_info(m, error->gt);
874 	}
875 
876 	if (error->overlay)
877 		intel_overlay_print_error_state(m, error->overlay);
878 
879 	err_print_capabilities(m, error);
880 	err_print_params(m, &error->params);
881 }
882 
883 static int err_print_to_sgl(struct i915_gpu_coredump *error)
884 {
885 	struct drm_i915_error_state_buf m;
886 
887 	if (IS_ERR(error))
888 		return PTR_ERR(error);
889 
890 	if (READ_ONCE(error->sgl))
891 		return 0;
892 
893 	memset(&m, 0, sizeof(m));
894 	m.i915 = error->i915;
895 
896 	__err_print_to_sgl(&m, error);
897 
898 	if (m.buf) {
899 		__sg_set_buf(m.cur++, m.buf, m.bytes, m.iter);
900 		m.bytes = 0;
901 		m.buf = NULL;
902 	}
903 	if (m.cur) {
904 		GEM_BUG_ON(m.end < m.cur);
905 		sg_mark_end(m.cur - 1);
906 	}
907 	GEM_BUG_ON(m.sgl && !m.cur);
908 
909 	if (m.err) {
910 		err_free_sgl(m.sgl);
911 		return m.err;
912 	}
913 
914 	if (cmpxchg(&error->sgl, NULL, m.sgl))
915 		err_free_sgl(m.sgl);
916 
917 	return 0;
918 }
919 
920 ssize_t i915_gpu_coredump_copy_to_buffer(struct i915_gpu_coredump *error,
921 					 char *buf, loff_t off, size_t rem)
922 {
923 	struct scatterlist *sg;
924 	size_t count;
925 	loff_t pos;
926 	int err;
927 
928 	if (!error || !rem)
929 		return 0;
930 
931 	err = err_print_to_sgl(error);
932 	if (err)
933 		return err;
934 
935 	sg = READ_ONCE(error->fit);
936 	if (!sg || off < sg->dma_address)
937 		sg = error->sgl;
938 	if (!sg)
939 		return 0;
940 
941 	pos = sg->dma_address;
942 	count = 0;
943 	do {
944 		size_t len, start;
945 
946 		if (sg_is_chain(sg)) {
947 			sg = sg_chain_ptr(sg);
948 			GEM_BUG_ON(sg_is_chain(sg));
949 		}
950 
951 		len = sg->length;
952 		if (pos + len <= off) {
953 			pos += len;
954 			continue;
955 		}
956 
957 		start = sg->offset;
958 		if (pos < off) {
959 			GEM_BUG_ON(off - pos > len);
960 			len -= off - pos;
961 			start += off - pos;
962 			pos = off;
963 		}
964 
965 		len = min(len, rem);
966 		GEM_BUG_ON(!len || len > sg->length);
967 
968 		memcpy(buf, page_address(sg_page(sg)) + start, len);
969 
970 		count += len;
971 		pos += len;
972 
973 		buf += len;
974 		rem -= len;
975 		if (!rem) {
976 			WRITE_ONCE(error->fit, sg);
977 			break;
978 		}
979 	} while (!sg_is_last(sg++));
980 
981 	return count;
982 }
983 
984 static void i915_vma_coredump_free(struct i915_vma_coredump *vma)
985 {
986 	while (vma) {
987 		struct i915_vma_coredump *next = vma->next;
988 		struct page *page, *n;
989 
990 		list_for_each_entry_safe(page, n, &vma->page_list, lru) {
991 			list_del_init(&page->lru);
992 			__free_page(page);
993 		}
994 
995 		kfree(vma);
996 		vma = next;
997 	}
998 }
999 
1000 static void cleanup_params(struct i915_gpu_coredump *error)
1001 {
1002 	i915_params_free(&error->params);
1003 }
1004 
1005 static void cleanup_uc(struct intel_uc_coredump *uc)
1006 {
1007 	kfree(uc->guc_fw.path);
1008 	kfree(uc->huc_fw.path);
1009 	i915_vma_coredump_free(uc->guc_log);
1010 
1011 	kfree(uc);
1012 }
1013 
1014 static void cleanup_gt(struct intel_gt_coredump *gt)
1015 {
1016 	while (gt->engine) {
1017 		struct intel_engine_coredump *ee = gt->engine;
1018 
1019 		gt->engine = ee->next;
1020 
1021 		i915_vma_coredump_free(ee->vma);
1022 		intel_guc_capture_free_node(ee);
1023 		kfree(ee);
1024 	}
1025 
1026 	if (gt->uc)
1027 		cleanup_uc(gt->uc);
1028 
1029 	kfree(gt);
1030 }
1031 
1032 void __i915_gpu_coredump_free(struct kref *error_ref)
1033 {
1034 	struct i915_gpu_coredump *error =
1035 		container_of(error_ref, typeof(*error), ref);
1036 
1037 	while (error->gt) {
1038 		struct intel_gt_coredump *gt = error->gt;
1039 
1040 		error->gt = gt->next;
1041 		cleanup_gt(gt);
1042 	}
1043 
1044 	kfree(error->overlay);
1045 
1046 	cleanup_params(error);
1047 
1048 	err_free_sgl(error->sgl);
1049 	kfree(error);
1050 }
1051 
1052 static struct i915_vma_coredump *
1053 i915_vma_coredump_create(const struct intel_gt *gt,
1054 			 const struct i915_vma_resource *vma_res,
1055 			 struct i915_vma_compress *compress,
1056 			 const char *name)
1057 
1058 {
1059 	struct i915_ggtt *ggtt = gt->ggtt;
1060 	const u64 slot = ggtt->error_capture.start;
1061 	struct i915_vma_coredump *dst;
1062 	struct sgt_iter iter;
1063 	int ret;
1064 
1065 	might_sleep();
1066 
1067 	if (!vma_res || !vma_res->bi.pages || !compress)
1068 		return NULL;
1069 
1070 	dst = kmalloc(sizeof(*dst), ALLOW_FAIL);
1071 	if (!dst)
1072 		return NULL;
1073 
1074 	if (!compress_start(compress)) {
1075 		kfree(dst);
1076 		return NULL;
1077 	}
1078 
1079 	INIT_LIST_HEAD(&dst->page_list);
1080 	strcpy(dst->name, name);
1081 	dst->next = NULL;
1082 
1083 	dst->gtt_offset = vma_res->start;
1084 	dst->gtt_size = vma_res->node_size;
1085 	dst->gtt_page_sizes = vma_res->page_sizes_gtt;
1086 	dst->unused = 0;
1087 
1088 	ret = -EINVAL;
1089 	if (drm_mm_node_allocated(&ggtt->error_capture)) {
1090 		void __iomem *s;
1091 		dma_addr_t dma;
1092 
1093 		for_each_sgt_daddr(dma, iter, vma_res->bi.pages) {
1094 			mutex_lock(&ggtt->error_mutex);
1095 			if (ggtt->vm.raw_insert_page)
1096 				ggtt->vm.raw_insert_page(&ggtt->vm, dma, slot,
1097 							 I915_CACHE_NONE, 0);
1098 			else
1099 				ggtt->vm.insert_page(&ggtt->vm, dma, slot,
1100 						     I915_CACHE_NONE, 0);
1101 			mb();
1102 
1103 			s = io_mapping_map_wc(&ggtt->iomap, slot, PAGE_SIZE);
1104 			ret = compress_page(compress,
1105 					    (void  __force *)s, dst,
1106 					    true);
1107 			io_mapping_unmap(s);
1108 
1109 			mb();
1110 			ggtt->vm.clear_range(&ggtt->vm, slot, PAGE_SIZE);
1111 			mutex_unlock(&ggtt->error_mutex);
1112 			if (ret)
1113 				break;
1114 		}
1115 	} else if (vma_res->bi.lmem) {
1116 		struct intel_memory_region *mem = vma_res->mr;
1117 		dma_addr_t dma;
1118 
1119 		for_each_sgt_daddr(dma, iter, vma_res->bi.pages) {
1120 			dma_addr_t offset = dma - mem->region.start;
1121 			void __iomem *s;
1122 
1123 			if (offset + PAGE_SIZE > mem->io_size) {
1124 				ret = -EINVAL;
1125 				break;
1126 			}
1127 
1128 			s = io_mapping_map_wc(&mem->iomap, offset, PAGE_SIZE);
1129 			ret = compress_page(compress,
1130 					    (void __force *)s, dst,
1131 					    true);
1132 			io_mapping_unmap(s);
1133 			if (ret)
1134 				break;
1135 		}
1136 	} else {
1137 		struct page *page;
1138 
1139 		for_each_sgt_page(page, iter, vma_res->bi.pages) {
1140 			void *s;
1141 
1142 			drm_clflush_pages(&page, 1);
1143 
1144 			s = kmap(page);
1145 			ret = compress_page(compress, s, dst, false);
1146 			kunmap(page);
1147 
1148 			drm_clflush_pages(&page, 1);
1149 
1150 			if (ret)
1151 				break;
1152 		}
1153 	}
1154 
1155 	if (ret || compress_flush(compress, dst)) {
1156 		struct page *page, *n;
1157 
1158 		list_for_each_entry_safe_reverse(page, n, &dst->page_list, lru) {
1159 			list_del_init(&page->lru);
1160 			pool_free(&compress->pool, page_address(page));
1161 		}
1162 
1163 		kfree(dst);
1164 		dst = NULL;
1165 	}
1166 	compress_finish(compress);
1167 
1168 	return dst;
1169 }
1170 
1171 static void gt_record_fences(struct intel_gt_coredump *gt)
1172 {
1173 	struct i915_ggtt *ggtt = gt->_gt->ggtt;
1174 	struct intel_uncore *uncore = gt->_gt->uncore;
1175 	int i;
1176 
1177 	if (GRAPHICS_VER(uncore->i915) >= 6) {
1178 		for (i = 0; i < ggtt->num_fences; i++)
1179 			gt->fence[i] =
1180 				intel_uncore_read64(uncore,
1181 						    FENCE_REG_GEN6_LO(i));
1182 	} else if (GRAPHICS_VER(uncore->i915) >= 4) {
1183 		for (i = 0; i < ggtt->num_fences; i++)
1184 			gt->fence[i] =
1185 				intel_uncore_read64(uncore,
1186 						    FENCE_REG_965_LO(i));
1187 	} else {
1188 		for (i = 0; i < ggtt->num_fences; i++)
1189 			gt->fence[i] =
1190 				intel_uncore_read(uncore, FENCE_REG(i));
1191 	}
1192 	gt->nfence = i;
1193 }
1194 
1195 static void engine_record_registers(struct intel_engine_coredump *ee)
1196 {
1197 	const struct intel_engine_cs *engine = ee->engine;
1198 	struct drm_i915_private *i915 = engine->i915;
1199 
1200 	if (GRAPHICS_VER(i915) >= 6) {
1201 		ee->rc_psmi = ENGINE_READ(engine, RING_PSMI_CTL);
1202 
1203 		if (GRAPHICS_VER(i915) >= 12)
1204 			ee->fault_reg = intel_uncore_read(engine->uncore,
1205 							  GEN12_RING_FAULT_REG);
1206 		else if (GRAPHICS_VER(i915) >= 8)
1207 			ee->fault_reg = intel_uncore_read(engine->uncore,
1208 							  GEN8_RING_FAULT_REG);
1209 		else
1210 			ee->fault_reg = GEN6_RING_FAULT_REG_READ(engine);
1211 	}
1212 
1213 	if (GRAPHICS_VER(i915) >= 4) {
1214 		ee->esr = ENGINE_READ(engine, RING_ESR);
1215 		ee->faddr = ENGINE_READ(engine, RING_DMA_FADD);
1216 		ee->ipeir = ENGINE_READ(engine, RING_IPEIR);
1217 		ee->ipehr = ENGINE_READ(engine, RING_IPEHR);
1218 		ee->instps = ENGINE_READ(engine, RING_INSTPS);
1219 		ee->bbaddr = ENGINE_READ(engine, RING_BBADDR);
1220 		ee->ccid = ENGINE_READ(engine, CCID);
1221 		if (GRAPHICS_VER(i915) >= 8) {
1222 			ee->faddr |= (u64)ENGINE_READ(engine, RING_DMA_FADD_UDW) << 32;
1223 			ee->bbaddr |= (u64)ENGINE_READ(engine, RING_BBADDR_UDW) << 32;
1224 		}
1225 		ee->bbstate = ENGINE_READ(engine, RING_BBSTATE);
1226 	} else {
1227 		ee->faddr = ENGINE_READ(engine, DMA_FADD_I8XX);
1228 		ee->ipeir = ENGINE_READ(engine, IPEIR);
1229 		ee->ipehr = ENGINE_READ(engine, IPEHR);
1230 	}
1231 
1232 	if (GRAPHICS_VER(i915) >= 11) {
1233 		ee->cmd_cctl = ENGINE_READ(engine, RING_CMD_CCTL);
1234 		ee->cscmdop = ENGINE_READ(engine, RING_CSCMDOP);
1235 		ee->ctx_sr_ctl = ENGINE_READ(engine, RING_CTX_SR_CTL);
1236 		ee->dma_faddr_hi = ENGINE_READ(engine, RING_DMA_FADD_UDW);
1237 		ee->dma_faddr_lo = ENGINE_READ(engine, RING_DMA_FADD);
1238 		ee->nopid = ENGINE_READ(engine, RING_NOPID);
1239 		ee->excc = ENGINE_READ(engine, RING_EXCC);
1240 	}
1241 
1242 	intel_engine_get_instdone(engine, &ee->instdone);
1243 
1244 	ee->instpm = ENGINE_READ(engine, RING_INSTPM);
1245 	ee->acthd = intel_engine_get_active_head(engine);
1246 	ee->start = ENGINE_READ(engine, RING_START);
1247 	ee->head = ENGINE_READ(engine, RING_HEAD);
1248 	ee->tail = ENGINE_READ(engine, RING_TAIL);
1249 	ee->ctl = ENGINE_READ(engine, RING_CTL);
1250 	if (GRAPHICS_VER(i915) > 2)
1251 		ee->mode = ENGINE_READ(engine, RING_MI_MODE);
1252 
1253 	if (!HWS_NEEDS_PHYSICAL(i915)) {
1254 		i915_reg_t mmio;
1255 
1256 		if (GRAPHICS_VER(i915) == 7) {
1257 			switch (engine->id) {
1258 			default:
1259 				MISSING_CASE(engine->id);
1260 				fallthrough;
1261 			case RCS0:
1262 				mmio = RENDER_HWS_PGA_GEN7;
1263 				break;
1264 			case BCS0:
1265 				mmio = BLT_HWS_PGA_GEN7;
1266 				break;
1267 			case VCS0:
1268 				mmio = BSD_HWS_PGA_GEN7;
1269 				break;
1270 			case VECS0:
1271 				mmio = VEBOX_HWS_PGA_GEN7;
1272 				break;
1273 			}
1274 		} else if (GRAPHICS_VER(engine->i915) == 6) {
1275 			mmio = RING_HWS_PGA_GEN6(engine->mmio_base);
1276 		} else {
1277 			/* XXX: gen8 returns to sanity */
1278 			mmio = RING_HWS_PGA(engine->mmio_base);
1279 		}
1280 
1281 		ee->hws = intel_uncore_read(engine->uncore, mmio);
1282 	}
1283 
1284 	ee->reset_count = i915_reset_engine_count(&i915->gpu_error, engine);
1285 
1286 	if (HAS_PPGTT(i915)) {
1287 		int i;
1288 
1289 		ee->vm_info.gfx_mode = ENGINE_READ(engine, RING_MODE_GEN7);
1290 
1291 		if (GRAPHICS_VER(i915) == 6) {
1292 			ee->vm_info.pp_dir_base =
1293 				ENGINE_READ(engine, RING_PP_DIR_BASE_READ);
1294 		} else if (GRAPHICS_VER(i915) == 7) {
1295 			ee->vm_info.pp_dir_base =
1296 				ENGINE_READ(engine, RING_PP_DIR_BASE);
1297 		} else if (GRAPHICS_VER(i915) >= 8) {
1298 			u32 base = engine->mmio_base;
1299 
1300 			for (i = 0; i < 4; i++) {
1301 				ee->vm_info.pdp[i] =
1302 					intel_uncore_read(engine->uncore,
1303 							  GEN8_RING_PDP_UDW(base, i));
1304 				ee->vm_info.pdp[i] <<= 32;
1305 				ee->vm_info.pdp[i] |=
1306 					intel_uncore_read(engine->uncore,
1307 							  GEN8_RING_PDP_LDW(base, i));
1308 			}
1309 		}
1310 	}
1311 }
1312 
1313 static void record_request(const struct i915_request *request,
1314 			   struct i915_request_coredump *erq)
1315 {
1316 	erq->flags = request->fence.flags;
1317 	erq->context = request->fence.context;
1318 	erq->seqno = request->fence.seqno;
1319 	erq->sched_attr = request->sched.attr;
1320 	erq->head = request->head;
1321 	erq->tail = request->tail;
1322 
1323 	erq->pid = 0;
1324 	rcu_read_lock();
1325 	if (!intel_context_is_closed(request->context)) {
1326 		const struct i915_gem_context *ctx;
1327 
1328 		ctx = rcu_dereference(request->context->gem_context);
1329 		if (ctx)
1330 			erq->pid = pid_nr(ctx->pid);
1331 	}
1332 	rcu_read_unlock();
1333 }
1334 
1335 static void engine_record_execlists(struct intel_engine_coredump *ee)
1336 {
1337 	const struct intel_engine_execlists * const el = &ee->engine->execlists;
1338 	struct i915_request * const *port = el->active;
1339 	unsigned int n = 0;
1340 
1341 	while (*port)
1342 		record_request(*port++, &ee->execlist[n++]);
1343 
1344 	ee->num_ports = n;
1345 }
1346 
1347 static bool record_context(struct i915_gem_context_coredump *e,
1348 			   const struct i915_request *rq)
1349 {
1350 	struct i915_gem_context *ctx;
1351 	struct task_struct *task;
1352 	bool simulated;
1353 
1354 	rcu_read_lock();
1355 	ctx = rcu_dereference(rq->context->gem_context);
1356 	if (ctx && !kref_get_unless_zero(&ctx->ref))
1357 		ctx = NULL;
1358 	rcu_read_unlock();
1359 	if (!ctx)
1360 		return true;
1361 
1362 	rcu_read_lock();
1363 	task = pid_task(ctx->pid, PIDTYPE_PID);
1364 	if (task) {
1365 		strcpy(e->comm, task->comm);
1366 		e->pid = task->pid;
1367 	}
1368 	rcu_read_unlock();
1369 
1370 	e->sched_attr = ctx->sched;
1371 	e->guilty = atomic_read(&ctx->guilty_count);
1372 	e->active = atomic_read(&ctx->active_count);
1373 
1374 	e->total_runtime = intel_context_get_total_runtime_ns(rq->context);
1375 	e->avg_runtime = intel_context_get_avg_runtime_ns(rq->context);
1376 
1377 	simulated = i915_gem_context_no_error_capture(ctx);
1378 
1379 	i915_gem_context_put(ctx);
1380 	return simulated;
1381 }
1382 
1383 struct intel_engine_capture_vma {
1384 	struct intel_engine_capture_vma *next;
1385 	struct i915_vma_resource *vma_res;
1386 	char name[16];
1387 	bool lockdep_cookie;
1388 };
1389 
1390 static struct intel_engine_capture_vma *
1391 capture_vma_snapshot(struct intel_engine_capture_vma *next,
1392 		     struct i915_vma_resource *vma_res,
1393 		     gfp_t gfp, const char *name)
1394 {
1395 	struct intel_engine_capture_vma *c;
1396 
1397 	if (!vma_res)
1398 		return next;
1399 
1400 	c = kmalloc(sizeof(*c), gfp);
1401 	if (!c)
1402 		return next;
1403 
1404 	if (!i915_vma_resource_hold(vma_res, &c->lockdep_cookie)) {
1405 		kfree(c);
1406 		return next;
1407 	}
1408 
1409 	strcpy(c->name, name);
1410 	c->vma_res = i915_vma_resource_get(vma_res);
1411 
1412 	c->next = next;
1413 	return c;
1414 }
1415 
1416 static struct intel_engine_capture_vma *
1417 capture_vma(struct intel_engine_capture_vma *next,
1418 	    struct i915_vma *vma,
1419 	    const char *name,
1420 	    gfp_t gfp)
1421 {
1422 	if (!vma)
1423 		return next;
1424 
1425 	/*
1426 	 * If the vma isn't pinned, then the vma should be snapshotted
1427 	 * to a struct i915_vma_snapshot at command submission time.
1428 	 * Not here.
1429 	 */
1430 	if (GEM_WARN_ON(!i915_vma_is_pinned(vma)))
1431 		return next;
1432 
1433 	next = capture_vma_snapshot(next, vma->resource, gfp, name);
1434 
1435 	return next;
1436 }
1437 
1438 static struct intel_engine_capture_vma *
1439 capture_user(struct intel_engine_capture_vma *capture,
1440 	     const struct i915_request *rq,
1441 	     gfp_t gfp)
1442 {
1443 	struct i915_capture_list *c;
1444 
1445 	for (c = rq->capture_list; c; c = c->next)
1446 		capture = capture_vma_snapshot(capture, c->vma_res, gfp,
1447 					       "user");
1448 
1449 	return capture;
1450 }
1451 
1452 static void add_vma(struct intel_engine_coredump *ee,
1453 		    struct i915_vma_coredump *vma)
1454 {
1455 	if (vma) {
1456 		vma->next = ee->vma;
1457 		ee->vma = vma;
1458 	}
1459 }
1460 
1461 static struct i915_vma_coredump *
1462 create_vma_coredump(const struct intel_gt *gt, struct i915_vma *vma,
1463 		    const char *name, struct i915_vma_compress *compress)
1464 {
1465 	struct i915_vma_coredump *ret = NULL;
1466 	struct i915_vma_resource *vma_res;
1467 	bool lockdep_cookie;
1468 
1469 	if (!vma)
1470 		return NULL;
1471 
1472 	vma_res = vma->resource;
1473 
1474 	if (i915_vma_resource_hold(vma_res, &lockdep_cookie)) {
1475 		ret = i915_vma_coredump_create(gt, vma_res, compress, name);
1476 		i915_vma_resource_unhold(vma_res, lockdep_cookie);
1477 	}
1478 
1479 	return ret;
1480 }
1481 
1482 static void add_vma_coredump(struct intel_engine_coredump *ee,
1483 			     const struct intel_gt *gt,
1484 			     struct i915_vma *vma,
1485 			     const char *name,
1486 			     struct i915_vma_compress *compress)
1487 {
1488 	add_vma(ee, create_vma_coredump(gt, vma, name, compress));
1489 }
1490 
1491 struct intel_engine_coredump *
1492 intel_engine_coredump_alloc(struct intel_engine_cs *engine, gfp_t gfp, u32 dump_flags)
1493 {
1494 	struct intel_engine_coredump *ee;
1495 
1496 	ee = kzalloc(sizeof(*ee), gfp);
1497 	if (!ee)
1498 		return NULL;
1499 
1500 	ee->engine = engine;
1501 
1502 	if (!(dump_flags & CORE_DUMP_FLAG_IS_GUC_CAPTURE)) {
1503 		engine_record_registers(ee);
1504 		engine_record_execlists(ee);
1505 	}
1506 
1507 	return ee;
1508 }
1509 
1510 struct intel_engine_capture_vma *
1511 intel_engine_coredump_add_request(struct intel_engine_coredump *ee,
1512 				  struct i915_request *rq,
1513 				  gfp_t gfp)
1514 {
1515 	struct intel_engine_capture_vma *vma = NULL;
1516 
1517 	ee->simulated |= record_context(&ee->context, rq);
1518 	if (ee->simulated)
1519 		return NULL;
1520 
1521 	/*
1522 	 * We need to copy these to an anonymous buffer
1523 	 * as the simplest method to avoid being overwritten
1524 	 * by userspace.
1525 	 */
1526 	vma = capture_vma_snapshot(vma, rq->batch_res, gfp, "batch");
1527 	vma = capture_user(vma, rq, gfp);
1528 	vma = capture_vma(vma, rq->ring->vma, "ring", gfp);
1529 	vma = capture_vma(vma, rq->context->state, "HW context", gfp);
1530 
1531 	ee->rq_head = rq->head;
1532 	ee->rq_post = rq->postfix;
1533 	ee->rq_tail = rq->tail;
1534 
1535 	return vma;
1536 }
1537 
1538 void
1539 intel_engine_coredump_add_vma(struct intel_engine_coredump *ee,
1540 			      struct intel_engine_capture_vma *capture,
1541 			      struct i915_vma_compress *compress)
1542 {
1543 	const struct intel_engine_cs *engine = ee->engine;
1544 
1545 	while (capture) {
1546 		struct intel_engine_capture_vma *this = capture;
1547 		struct i915_vma_resource *vma_res = this->vma_res;
1548 
1549 		add_vma(ee,
1550 			i915_vma_coredump_create(engine->gt, vma_res,
1551 						 compress, this->name));
1552 
1553 		i915_vma_resource_unhold(vma_res, this->lockdep_cookie);
1554 		i915_vma_resource_put(vma_res);
1555 
1556 		capture = this->next;
1557 		kfree(this);
1558 	}
1559 
1560 	add_vma_coredump(ee, engine->gt, engine->status_page.vma,
1561 			 "HW Status", compress);
1562 
1563 	add_vma_coredump(ee, engine->gt, engine->wa_ctx.vma,
1564 			 "WA context", compress);
1565 }
1566 
1567 static struct intel_engine_coredump *
1568 capture_engine(struct intel_engine_cs *engine,
1569 	       struct i915_vma_compress *compress,
1570 	       u32 dump_flags)
1571 {
1572 	struct intel_engine_capture_vma *capture = NULL;
1573 	struct intel_engine_coredump *ee;
1574 	struct intel_context *ce;
1575 	struct i915_request *rq = NULL;
1576 	unsigned long flags;
1577 
1578 	ee = intel_engine_coredump_alloc(engine, ALLOW_FAIL, dump_flags);
1579 	if (!ee)
1580 		return NULL;
1581 
1582 	ce = intel_engine_get_hung_context(engine);
1583 	if (ce) {
1584 		intel_engine_clear_hung_context(engine);
1585 		rq = intel_context_find_active_request(ce);
1586 		if (!rq || !i915_request_started(rq))
1587 			goto no_request_capture;
1588 	} else {
1589 		/*
1590 		 * Getting here with GuC enabled means it is a forced error capture
1591 		 * with no actual hang. So, no need to attempt the execlist search.
1592 		 */
1593 		if (!intel_uc_uses_guc_submission(&engine->gt->uc)) {
1594 			spin_lock_irqsave(&engine->sched_engine->lock, flags);
1595 			rq = intel_engine_execlist_find_hung_request(engine);
1596 			spin_unlock_irqrestore(&engine->sched_engine->lock,
1597 					       flags);
1598 		}
1599 	}
1600 	if (rq)
1601 		rq = i915_request_get_rcu(rq);
1602 
1603 	if (!rq)
1604 		goto no_request_capture;
1605 
1606 	capture = intel_engine_coredump_add_request(ee, rq, ATOMIC_MAYFAIL);
1607 	if (!capture) {
1608 		i915_request_put(rq);
1609 		goto no_request_capture;
1610 	}
1611 	if (dump_flags & CORE_DUMP_FLAG_IS_GUC_CAPTURE)
1612 		intel_guc_capture_get_matching_node(engine->gt, ee, ce);
1613 
1614 	intel_engine_coredump_add_vma(ee, capture, compress);
1615 	i915_request_put(rq);
1616 
1617 	return ee;
1618 
1619 no_request_capture:
1620 	kfree(ee);
1621 	return NULL;
1622 }
1623 
1624 static void
1625 gt_record_engines(struct intel_gt_coredump *gt,
1626 		  intel_engine_mask_t engine_mask,
1627 		  struct i915_vma_compress *compress,
1628 		  u32 dump_flags)
1629 {
1630 	struct intel_engine_cs *engine;
1631 	enum intel_engine_id id;
1632 
1633 	for_each_engine(engine, gt->_gt, id) {
1634 		struct intel_engine_coredump *ee;
1635 
1636 		/* Refill our page pool before entering atomic section */
1637 		pool_refill(&compress->pool, ALLOW_FAIL);
1638 
1639 		ee = capture_engine(engine, compress, dump_flags);
1640 		if (!ee)
1641 			continue;
1642 
1643 		ee->hung = engine->mask & engine_mask;
1644 
1645 		gt->simulated |= ee->simulated;
1646 		if (ee->simulated) {
1647 			if (dump_flags & CORE_DUMP_FLAG_IS_GUC_CAPTURE)
1648 				intel_guc_capture_free_node(ee);
1649 			kfree(ee);
1650 			continue;
1651 		}
1652 
1653 		ee->next = gt->engine;
1654 		gt->engine = ee;
1655 	}
1656 }
1657 
1658 static struct intel_uc_coredump *
1659 gt_record_uc(struct intel_gt_coredump *gt,
1660 	     struct i915_vma_compress *compress)
1661 {
1662 	const struct intel_uc *uc = &gt->_gt->uc;
1663 	struct intel_uc_coredump *error_uc;
1664 
1665 	error_uc = kzalloc(sizeof(*error_uc), ALLOW_FAIL);
1666 	if (!error_uc)
1667 		return NULL;
1668 
1669 	memcpy(&error_uc->guc_fw, &uc->guc.fw, sizeof(uc->guc.fw));
1670 	memcpy(&error_uc->huc_fw, &uc->huc.fw, sizeof(uc->huc.fw));
1671 
1672 	/* Non-default firmware paths will be specified by the modparam.
1673 	 * As modparams are generally accesible from the userspace make
1674 	 * explicit copies of the firmware paths.
1675 	 */
1676 	error_uc->guc_fw.path = kstrdup(uc->guc.fw.path, ALLOW_FAIL);
1677 	error_uc->huc_fw.path = kstrdup(uc->huc.fw.path, ALLOW_FAIL);
1678 	error_uc->guc_log = create_vma_coredump(gt->_gt, uc->guc.log.vma,
1679 						"GuC log buffer", compress);
1680 
1681 	return error_uc;
1682 }
1683 
1684 /* Capture display registers. */
1685 static void gt_record_display_regs(struct intel_gt_coredump *gt)
1686 {
1687 	struct intel_uncore *uncore = gt->_gt->uncore;
1688 	struct drm_i915_private *i915 = uncore->i915;
1689 
1690 	if (GRAPHICS_VER(i915) >= 6)
1691 		gt->derrmr = intel_uncore_read(uncore, DERRMR);
1692 
1693 	if (GRAPHICS_VER(i915) >= 8)
1694 		gt->ier = intel_uncore_read(uncore, GEN8_DE_MISC_IER);
1695 	else if (IS_VALLEYVIEW(i915))
1696 		gt->ier = intel_uncore_read(uncore, VLV_IER);
1697 	else if (HAS_PCH_SPLIT(i915))
1698 		gt->ier = intel_uncore_read(uncore, DEIER);
1699 	else if (GRAPHICS_VER(i915) == 2)
1700 		gt->ier = intel_uncore_read16(uncore, GEN2_IER);
1701 	else
1702 		gt->ier = intel_uncore_read(uncore, GEN2_IER);
1703 }
1704 
1705 /* Capture all other registers that GuC doesn't capture. */
1706 static void gt_record_global_nonguc_regs(struct intel_gt_coredump *gt)
1707 {
1708 	struct intel_uncore *uncore = gt->_gt->uncore;
1709 	struct drm_i915_private *i915 = uncore->i915;
1710 	int i;
1711 
1712 	if (IS_VALLEYVIEW(i915)) {
1713 		gt->gtier[0] = intel_uncore_read(uncore, GTIER);
1714 		gt->ngtier = 1;
1715 	} else if (GRAPHICS_VER(i915) >= 11) {
1716 		gt->gtier[0] =
1717 			intel_uncore_read(uncore,
1718 					  GEN11_RENDER_COPY_INTR_ENABLE);
1719 		gt->gtier[1] =
1720 			intel_uncore_read(uncore, GEN11_VCS_VECS_INTR_ENABLE);
1721 		gt->gtier[2] =
1722 			intel_uncore_read(uncore, GEN11_GUC_SG_INTR_ENABLE);
1723 		gt->gtier[3] =
1724 			intel_uncore_read(uncore,
1725 					  GEN11_GPM_WGBOXPERF_INTR_ENABLE);
1726 		gt->gtier[4] =
1727 			intel_uncore_read(uncore,
1728 					  GEN11_CRYPTO_RSVD_INTR_ENABLE);
1729 		gt->gtier[5] =
1730 			intel_uncore_read(uncore,
1731 					  GEN11_GUNIT_CSME_INTR_ENABLE);
1732 		gt->ngtier = 6;
1733 	} else if (GRAPHICS_VER(i915) >= 8) {
1734 		for (i = 0; i < 4; i++)
1735 			gt->gtier[i] =
1736 				intel_uncore_read(uncore, GEN8_GT_IER(i));
1737 		gt->ngtier = 4;
1738 	} else if (HAS_PCH_SPLIT(i915)) {
1739 		gt->gtier[0] = intel_uncore_read(uncore, GTIER);
1740 		gt->ngtier = 1;
1741 	}
1742 
1743 	gt->eir = intel_uncore_read(uncore, EIR);
1744 	gt->pgtbl_er = intel_uncore_read(uncore, PGTBL_ER);
1745 }
1746 
1747 /*
1748  * Capture all registers that relate to workload submission.
1749  * NOTE: In GuC submission, when GuC resets an engine, it can dump these for us
1750  */
1751 static void gt_record_global_regs(struct intel_gt_coredump *gt)
1752 {
1753 	struct intel_uncore *uncore = gt->_gt->uncore;
1754 	struct drm_i915_private *i915 = uncore->i915;
1755 	int i;
1756 
1757 	/*
1758 	 * General organization
1759 	 * 1. Registers specific to a single generation
1760 	 * 2. Registers which belong to multiple generations
1761 	 * 3. Feature specific registers.
1762 	 * 4. Everything else
1763 	 * Please try to follow the order.
1764 	 */
1765 
1766 	/* 1: Registers specific to a single generation */
1767 	if (IS_VALLEYVIEW(i915))
1768 		gt->forcewake = intel_uncore_read_fw(uncore, FORCEWAKE_VLV);
1769 
1770 	if (GRAPHICS_VER(i915) == 7)
1771 		gt->err_int = intel_uncore_read(uncore, GEN7_ERR_INT);
1772 
1773 	if (GRAPHICS_VER(i915) >= 12) {
1774 		gt->fault_data0 = intel_uncore_read(uncore,
1775 						    GEN12_FAULT_TLB_DATA0);
1776 		gt->fault_data1 = intel_uncore_read(uncore,
1777 						    GEN12_FAULT_TLB_DATA1);
1778 	} else if (GRAPHICS_VER(i915) >= 8) {
1779 		gt->fault_data0 = intel_uncore_read(uncore,
1780 						    GEN8_FAULT_TLB_DATA0);
1781 		gt->fault_data1 = intel_uncore_read(uncore,
1782 						    GEN8_FAULT_TLB_DATA1);
1783 	}
1784 
1785 	if (GRAPHICS_VER(i915) == 6) {
1786 		gt->forcewake = intel_uncore_read_fw(uncore, FORCEWAKE);
1787 		gt->gab_ctl = intel_uncore_read(uncore, GAB_CTL);
1788 		gt->gfx_mode = intel_uncore_read(uncore, GFX_MODE);
1789 	}
1790 
1791 	/* 2: Registers which belong to multiple generations */
1792 	if (GRAPHICS_VER(i915) >= 7)
1793 		gt->forcewake = intel_uncore_read_fw(uncore, FORCEWAKE_MT);
1794 
1795 	if (GRAPHICS_VER(i915) >= 6) {
1796 		if (GRAPHICS_VER(i915) < 12) {
1797 			gt->error = intel_uncore_read(uncore, ERROR_GEN6);
1798 			gt->done_reg = intel_uncore_read(uncore, DONE_REG);
1799 		}
1800 	}
1801 
1802 	/* 3: Feature specific registers */
1803 	if (IS_GRAPHICS_VER(i915, 6, 7)) {
1804 		gt->gam_ecochk = intel_uncore_read(uncore, GAM_ECOCHK);
1805 		gt->gac_eco = intel_uncore_read(uncore, GAC_ECO_BITS);
1806 	}
1807 
1808 	if (IS_GRAPHICS_VER(i915, 8, 11))
1809 		gt->gtt_cache = intel_uncore_read(uncore, HSW_GTT_CACHE_EN);
1810 
1811 	if (GRAPHICS_VER(i915) == 12)
1812 		gt->aux_err = intel_uncore_read(uncore, GEN12_AUX_ERR_DBG);
1813 
1814 	if (GRAPHICS_VER(i915) >= 12) {
1815 		for (i = 0; i < I915_MAX_SFC; i++) {
1816 			/*
1817 			 * SFC_DONE resides in the VD forcewake domain, so it
1818 			 * only exists if the corresponding VCS engine is
1819 			 * present.
1820 			 */
1821 			if ((gt->_gt->info.sfc_mask & BIT(i)) == 0 ||
1822 			    !HAS_ENGINE(gt->_gt, _VCS(i * 2)))
1823 				continue;
1824 
1825 			gt->sfc_done[i] =
1826 				intel_uncore_read(uncore, GEN12_SFC_DONE(i));
1827 		}
1828 
1829 		gt->gam_done = intel_uncore_read(uncore, GEN12_GAM_DONE);
1830 	}
1831 }
1832 
1833 static void gt_record_info(struct intel_gt_coredump *gt)
1834 {
1835 	memcpy(&gt->info, &gt->_gt->info, sizeof(struct intel_gt_info));
1836 }
1837 
1838 /*
1839  * Generate a semi-unique error code. The code is not meant to have meaning, The
1840  * code's only purpose is to try to prevent false duplicated bug reports by
1841  * grossly estimating a GPU error state.
1842  *
1843  * TODO Ideally, hashing the batchbuffer would be a very nice way to determine
1844  * the hang if we could strip the GTT offset information from it.
1845  *
1846  * It's only a small step better than a random number in its current form.
1847  */
1848 static u32 generate_ecode(const struct intel_engine_coredump *ee)
1849 {
1850 	/*
1851 	 * IPEHR would be an ideal way to detect errors, as it's the gross
1852 	 * measure of "the command that hung." However, has some very common
1853 	 * synchronization commands which almost always appear in the case
1854 	 * strictly a client bug. Use instdone to differentiate those some.
1855 	 */
1856 	return ee ? ee->ipehr ^ ee->instdone.instdone : 0;
1857 }
1858 
1859 static const char *error_msg(struct i915_gpu_coredump *error)
1860 {
1861 	struct intel_engine_coredump *first = NULL;
1862 	unsigned int hung_classes = 0;
1863 	struct intel_gt_coredump *gt;
1864 	int len;
1865 
1866 	for (gt = error->gt; gt; gt = gt->next) {
1867 		struct intel_engine_coredump *cs;
1868 
1869 		for (cs = gt->engine; cs; cs = cs->next) {
1870 			if (cs->hung) {
1871 				hung_classes |= BIT(cs->engine->uabi_class);
1872 				if (!first)
1873 					first = cs;
1874 			}
1875 		}
1876 	}
1877 
1878 	len = scnprintf(error->error_msg, sizeof(error->error_msg),
1879 			"GPU HANG: ecode %d:%x:%08x",
1880 			GRAPHICS_VER(error->i915), hung_classes,
1881 			generate_ecode(first));
1882 	if (first && first->context.pid) {
1883 		/* Just show the first executing process, more is confusing */
1884 		len += scnprintf(error->error_msg + len,
1885 				 sizeof(error->error_msg) - len,
1886 				 ", in %s [%d]",
1887 				 first->context.comm, first->context.pid);
1888 	}
1889 
1890 	return error->error_msg;
1891 }
1892 
1893 static void capture_gen(struct i915_gpu_coredump *error)
1894 {
1895 	struct drm_i915_private *i915 = error->i915;
1896 
1897 	error->wakelock = atomic_read(&i915->runtime_pm.wakeref_count);
1898 	error->suspended = i915->runtime_pm.suspended;
1899 
1900 	error->iommu = i915_vtd_active(i915);
1901 	error->reset_count = i915_reset_count(&i915->gpu_error);
1902 	error->suspend_count = i915->suspend_count;
1903 
1904 	i915_params_copy(&error->params, &i915->params);
1905 	memcpy(&error->device_info,
1906 	       INTEL_INFO(i915),
1907 	       sizeof(error->device_info));
1908 	memcpy(&error->runtime_info,
1909 	       RUNTIME_INFO(i915),
1910 	       sizeof(error->runtime_info));
1911 	error->driver_caps = i915->caps;
1912 }
1913 
1914 struct i915_gpu_coredump *
1915 i915_gpu_coredump_alloc(struct drm_i915_private *i915, gfp_t gfp)
1916 {
1917 	struct i915_gpu_coredump *error;
1918 
1919 	if (!i915->params.error_capture)
1920 		return NULL;
1921 
1922 	error = kzalloc(sizeof(*error), gfp);
1923 	if (!error)
1924 		return NULL;
1925 
1926 	kref_init(&error->ref);
1927 	error->i915 = i915;
1928 
1929 	error->time = ktime_get_real();
1930 	error->boottime = ktime_get_boottime();
1931 	error->uptime = ktime_sub(ktime_get(), to_gt(i915)->last_init_time);
1932 	error->capture = jiffies;
1933 
1934 	capture_gen(error);
1935 
1936 	return error;
1937 }
1938 
1939 #define DAY_AS_SECONDS(x) (24 * 60 * 60 * (x))
1940 
1941 struct intel_gt_coredump *
1942 intel_gt_coredump_alloc(struct intel_gt *gt, gfp_t gfp, u32 dump_flags)
1943 {
1944 	struct intel_gt_coredump *gc;
1945 
1946 	gc = kzalloc(sizeof(*gc), gfp);
1947 	if (!gc)
1948 		return NULL;
1949 
1950 	gc->_gt = gt;
1951 	gc->awake = intel_gt_pm_is_awake(gt);
1952 
1953 	gt_record_display_regs(gc);
1954 	gt_record_global_nonguc_regs(gc);
1955 
1956 	/*
1957 	 * GuC dumps global, eng-class and eng-instance registers
1958 	 * (that can change as part of engine state during execution)
1959 	 * before an engine is reset due to a hung context.
1960 	 * GuC captures and reports all three groups of registers
1961 	 * together as a single set before the engine is reset.
1962 	 * Thus, if GuC triggered the context reset we retrieve
1963 	 * the register values as part of gt_record_engines.
1964 	 */
1965 	if (!(dump_flags & CORE_DUMP_FLAG_IS_GUC_CAPTURE))
1966 		gt_record_global_regs(gc);
1967 
1968 	gt_record_fences(gc);
1969 
1970 	return gc;
1971 }
1972 
1973 struct i915_vma_compress *
1974 i915_vma_capture_prepare(struct intel_gt_coredump *gt)
1975 {
1976 	struct i915_vma_compress *compress;
1977 
1978 	compress = kmalloc(sizeof(*compress), ALLOW_FAIL);
1979 	if (!compress)
1980 		return NULL;
1981 
1982 	if (!compress_init(compress)) {
1983 		kfree(compress);
1984 		return NULL;
1985 	}
1986 
1987 	return compress;
1988 }
1989 
1990 void i915_vma_capture_finish(struct intel_gt_coredump *gt,
1991 			     struct i915_vma_compress *compress)
1992 {
1993 	if (!compress)
1994 		return;
1995 
1996 	compress_fini(compress);
1997 	kfree(compress);
1998 }
1999 
2000 static struct i915_gpu_coredump *
2001 __i915_gpu_coredump(struct intel_gt *gt, intel_engine_mask_t engine_mask, u32 dump_flags)
2002 {
2003 	struct drm_i915_private *i915 = gt->i915;
2004 	struct i915_gpu_coredump *error;
2005 
2006 	/* Check if GPU capture has been disabled */
2007 	error = READ_ONCE(i915->gpu_error.first_error);
2008 	if (IS_ERR(error))
2009 		return error;
2010 
2011 	error = i915_gpu_coredump_alloc(i915, ALLOW_FAIL);
2012 	if (!error)
2013 		return ERR_PTR(-ENOMEM);
2014 
2015 	error->gt = intel_gt_coredump_alloc(gt, ALLOW_FAIL, dump_flags);
2016 	if (error->gt) {
2017 		struct i915_vma_compress *compress;
2018 
2019 		compress = i915_vma_capture_prepare(error->gt);
2020 		if (!compress) {
2021 			kfree(error->gt);
2022 			kfree(error);
2023 			return ERR_PTR(-ENOMEM);
2024 		}
2025 
2026 		if (INTEL_INFO(i915)->has_gt_uc) {
2027 			error->gt->uc = gt_record_uc(error->gt, compress);
2028 			if (error->gt->uc) {
2029 				if (dump_flags & CORE_DUMP_FLAG_IS_GUC_CAPTURE)
2030 					error->gt->uc->is_guc_capture = true;
2031 				else
2032 					GEM_BUG_ON(error->gt->uc->is_guc_capture);
2033 			}
2034 		}
2035 
2036 		gt_record_info(error->gt);
2037 		gt_record_engines(error->gt, engine_mask, compress, dump_flags);
2038 
2039 
2040 		i915_vma_capture_finish(error->gt, compress);
2041 
2042 		error->simulated |= error->gt->simulated;
2043 	}
2044 
2045 	error->overlay = intel_overlay_capture_error_state(i915);
2046 
2047 	return error;
2048 }
2049 
2050 struct i915_gpu_coredump *
2051 i915_gpu_coredump(struct intel_gt *gt, intel_engine_mask_t engine_mask, u32 dump_flags)
2052 {
2053 	static DEFINE_MUTEX(capture_mutex);
2054 	int ret = mutex_lock_interruptible(&capture_mutex);
2055 	struct i915_gpu_coredump *dump;
2056 
2057 	if (ret)
2058 		return ERR_PTR(ret);
2059 
2060 	dump = __i915_gpu_coredump(gt, engine_mask, dump_flags);
2061 	mutex_unlock(&capture_mutex);
2062 
2063 	return dump;
2064 }
2065 
2066 void i915_error_state_store(struct i915_gpu_coredump *error)
2067 {
2068 	struct drm_i915_private *i915;
2069 	static bool warned;
2070 
2071 	if (IS_ERR_OR_NULL(error))
2072 		return;
2073 
2074 	i915 = error->i915;
2075 	drm_info(&i915->drm, "%s\n", error_msg(error));
2076 
2077 	if (error->simulated ||
2078 	    cmpxchg(&i915->gpu_error.first_error, NULL, error))
2079 		return;
2080 
2081 	i915_gpu_coredump_get(error);
2082 
2083 	if (!xchg(&warned, true) &&
2084 	    ktime_get_real_seconds() - DRIVER_TIMESTAMP < DAY_AS_SECONDS(180)) {
2085 		pr_info("GPU hangs can indicate a bug anywhere in the entire gfx stack, including userspace.\n");
2086 		pr_info("Please file a _new_ bug report at https://gitlab.freedesktop.org/drm/intel/issues/new.\n");
2087 		pr_info("Please see https://gitlab.freedesktop.org/drm/intel/-/wikis/How-to-file-i915-bugs for details.\n");
2088 		pr_info("drm/i915 developers can then reassign to the right component if it's not a kernel issue.\n");
2089 		pr_info("The GPU crash dump is required to analyze GPU hangs, so please always attach it.\n");
2090 		pr_info("GPU crash dump saved to /sys/class/drm/card%d/error\n",
2091 			i915->drm.primary->index);
2092 	}
2093 }
2094 
2095 /**
2096  * i915_capture_error_state - capture an error record for later analysis
2097  * @gt: intel_gt which originated the hang
2098  * @engine_mask: hung engines
2099  *
2100  *
2101  * Should be called when an error is detected (either a hang or an error
2102  * interrupt) to capture error state from the time of the error.  Fills
2103  * out a structure which becomes available in debugfs for user level tools
2104  * to pick up.
2105  */
2106 void i915_capture_error_state(struct intel_gt *gt,
2107 			      intel_engine_mask_t engine_mask, u32 dump_flags)
2108 {
2109 	struct i915_gpu_coredump *error;
2110 
2111 	error = i915_gpu_coredump(gt, engine_mask, dump_flags);
2112 	if (IS_ERR(error)) {
2113 		cmpxchg(&gt->i915->gpu_error.first_error, NULL, error);
2114 		return;
2115 	}
2116 
2117 	i915_error_state_store(error);
2118 	i915_gpu_coredump_put(error);
2119 }
2120 
2121 struct i915_gpu_coredump *
2122 i915_first_error_state(struct drm_i915_private *i915)
2123 {
2124 	struct i915_gpu_coredump *error;
2125 
2126 	spin_lock_irq(&i915->gpu_error.lock);
2127 	error = i915->gpu_error.first_error;
2128 	if (!IS_ERR_OR_NULL(error))
2129 		i915_gpu_coredump_get(error);
2130 	spin_unlock_irq(&i915->gpu_error.lock);
2131 
2132 	return error;
2133 }
2134 
2135 void i915_reset_error_state(struct drm_i915_private *i915)
2136 {
2137 	struct i915_gpu_coredump *error;
2138 
2139 	spin_lock_irq(&i915->gpu_error.lock);
2140 	error = i915->gpu_error.first_error;
2141 	if (error != ERR_PTR(-ENODEV)) /* if disabled, always disabled */
2142 		i915->gpu_error.first_error = NULL;
2143 	spin_unlock_irq(&i915->gpu_error.lock);
2144 
2145 	if (!IS_ERR_OR_NULL(error))
2146 		i915_gpu_coredump_put(error);
2147 }
2148 
2149 void i915_disable_error_state(struct drm_i915_private *i915, int err)
2150 {
2151 	spin_lock_irq(&i915->gpu_error.lock);
2152 	if (!i915->gpu_error.first_error)
2153 		i915->gpu_error.first_error = ERR_PTR(err);
2154 	spin_unlock_irq(&i915->gpu_error.lock);
2155 }
2156