2 * Copyright © 2007-2017 Intel Corporation
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:
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
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
34 #include <sys/types.h>
41 #include "common/gen_decoder.h"
42 #include "util/macros.h"
45 #define BLUE_HEADER CSI "0;44m"
46 #define GREEN_HEADER CSI "1;42m"
47 #define NORMAL CSI "0m"
49 #define MIN(a, b) ((a) < (b) ? (a) : (b))
53 static bool option_full_decode
= true;
54 static bool option_print_all_bb
= false;
55 static bool option_print_offsets
= true;
56 static enum { COLOR_AUTO
, COLOR_ALWAYS
, COLOR_NEVER
} option_color
;
57 static char *xml_path
= NULL
;
60 print_head(unsigned int reg
)
62 printf(" head = 0x%08x, wraps = %d\n", reg
& (0x7ffff<<2), reg
>> 21);
63 return reg
& (0x7ffff<<2);
67 print_register(struct gen_spec
*spec
, const char *name
, uint32_t reg
)
69 struct gen_group
*reg_spec
=
70 name
? gen_spec_find_register_by_name(spec
, name
) : NULL
;
73 gen_print_group(stdout
, reg_spec
, 0, ®
, 0,
74 option_color
== COLOR_ALWAYS
);
78 struct ring_register_mapping
{
79 enum drm_i915_gem_engine_class ring_class
;
80 unsigned ring_instance
;
81 const char *register_name
;
84 static const struct ring_register_mapping acthd_registers
[] = {
85 { I915_ENGINE_CLASS_COPY
, 0, "BCS_ACTHD_UDW" },
86 { I915_ENGINE_CLASS_VIDEO
, 0, "VCS_ACTHD_UDW" },
87 { I915_ENGINE_CLASS_VIDEO
, 1, "VCS2_ACTHD_UDW" },
88 { I915_ENGINE_CLASS_RENDER
, 0, "ACTHD_UDW" },
89 { I915_ENGINE_CLASS_VIDEO_ENHANCE
, 0, "VECS_ACTHD_UDW" },
92 static const struct ring_register_mapping ctl_registers
[] = {
93 { I915_ENGINE_CLASS_COPY
, 0, "BCS_RING_BUFFER_CTL" },
94 { I915_ENGINE_CLASS_VIDEO
, 0, "VCS_RING_BUFFER_CTL" },
95 { I915_ENGINE_CLASS_VIDEO
, 1, "VCS2_RING_BUFFER_CTL" },
96 { I915_ENGINE_CLASS_RENDER
, 0, "RCS_RING_BUFFER_CTL" },
97 { I915_ENGINE_CLASS_VIDEO_ENHANCE
, 0, "VECS_RING_BUFFER_CTL" },
100 static const struct ring_register_mapping fault_registers
[] = {
101 { I915_ENGINE_CLASS_COPY
, 0, "BCS_FAULT_REG" },
102 { I915_ENGINE_CLASS_VIDEO
, 0, "VCS_FAULT_REG" },
103 { I915_ENGINE_CLASS_RENDER
, 0, "RCS_FAULT_REG" },
104 { I915_ENGINE_CLASS_VIDEO_ENHANCE
, 0, "VECS_FAULT_REG" },
107 static int ring_name_to_class(const char *ring_name
,
108 enum drm_i915_gem_engine_class
*class)
110 static const char *class_names
[] = {
111 [I915_ENGINE_CLASS_RENDER
] = "rcs",
112 [I915_ENGINE_CLASS_COPY
] = "bcs",
113 [I915_ENGINE_CLASS_VIDEO
] = "vcs",
114 [I915_ENGINE_CLASS_VIDEO_ENHANCE
] = "vecs",
116 for (size_t i
= 0; i
< ARRAY_SIZE(class_names
); i
++) {
117 if (strncmp(ring_name
, class_names
[i
], strlen(class_names
[i
])))
121 return atoi(ring_name
+ strlen(class_names
[i
]));
124 static const struct {
129 { "render", I915_ENGINE_CLASS_RENDER
, 0 },
130 { "blt", I915_ENGINE_CLASS_COPY
, 0 },
131 { "bsd", I915_ENGINE_CLASS_VIDEO
, 0 },
132 { "bsd2", I915_ENGINE_CLASS_VIDEO
, 1 },
133 { "vebox", I915_ENGINE_CLASS_VIDEO_ENHANCE
, 0 },
135 for (size_t i
= 0; i
< ARRAY_SIZE(legacy_names
); i
++) {
136 if (strcmp(ring_name
, legacy_names
[i
].name
))
139 *class = legacy_names
[i
].class;
140 return legacy_names
[i
].instance
;
147 register_name_from_ring(const struct ring_register_mapping
*mapping
,
149 const char *ring_name
)
151 enum drm_i915_gem_engine_class
class;
154 instance
= ring_name_to_class(ring_name
, &class);
158 for (unsigned i
= 0; i
< nb_mapping
; i
++) {
159 if (mapping
[i
].ring_class
== class &&
160 mapping
[i
].ring_instance
== instance
)
161 return mapping
[i
].register_name
;
167 instdone_register_for_ring(const struct gen_device_info
*devinfo
,
168 const char *ring_name
)
170 enum drm_i915_gem_engine_class
class;
173 instance
= ring_name_to_class(ring_name
, &class);
178 case I915_ENGINE_CLASS_RENDER
:
179 if (devinfo
->gen
== 6)
184 case I915_ENGINE_CLASS_COPY
:
185 return "BCS_INSTDONE";
187 case I915_ENGINE_CLASS_VIDEO
:
190 return "VCS_INSTDONE";
192 return "VCS2_INSTDONE";
197 case I915_ENGINE_CLASS_VIDEO_ENHANCE
:
198 return "VECS_INSTDONE";
205 print_pgtbl_err(unsigned int reg
, struct gen_device_info
*devinfo
)
208 printf(" Invalid Sampler Cache GTT entry\n");
210 printf(" Invalid Render Cache GTT entry\n");
212 printf(" Invalid Instruction/State Cache GTT entry\n");
214 printf(" There is no ROC, this cannot occur!\n");
216 printf(" Invalid GTT entry during Vertex Fetch\n");
218 printf(" Invalid GTT entry during Command Fetch\n");
220 printf(" Invalid GTT entry during CS\n");
222 printf(" Invalid GTT entry during Cursor Fetch\n");
224 printf(" Invalid GTT entry during Overlay Fetch\n");
226 printf(" Invalid GTT entry during Display B Fetch\n");
228 printf(" Invalid GTT entry during Display A Fetch\n");
230 printf(" Valid PTE references illegal memory\n");
232 printf(" Invalid GTT entry during fetch for host\n");
236 print_snb_fence(struct gen_device_info
*devinfo
, uint64_t fence
)
238 printf(" %svalid, %c-tiled, pitch: %i, start: 0x%08x, size: %u\n",
239 fence
& 1 ? "" : "in",
240 fence
& (1<<1) ? 'y' : 'x',
241 (int)(((fence
>>32)&0xfff)+1)*128,
242 (uint32_t)fence
& 0xfffff000,
243 (uint32_t)(((fence
>>32)&0xfffff000) - (fence
&0xfffff000) + 4096));
247 print_i965_fence(struct gen_device_info
*devinfo
, uint64_t fence
)
249 printf(" %svalid, %c-tiled, pitch: %i, start: 0x%08x, size: %u\n",
250 fence
& 1 ? "" : "in",
251 fence
& (1<<1) ? 'y' : 'x',
252 (int)(((fence
>>2)&0x1ff)+1)*128,
253 (uint32_t)fence
& 0xfffff000,
254 (uint32_t)(((fence
>>32)&0xfffff000) - (fence
&0xfffff000) + 4096));
258 print_fence(struct gen_device_info
*devinfo
, uint64_t fence
)
260 if (devinfo
->gen
== 6 || devinfo
->gen
== 7) {
261 return print_snb_fence(devinfo
, fence
);
262 } else if (devinfo
->gen
== 4 || devinfo
->gen
== 5) {
263 return print_i965_fence(devinfo
, fence
);
268 print_fault_data(struct gen_device_info
*devinfo
, uint32_t data1
, uint32_t data0
)
272 if (devinfo
->gen
< 8)
275 address
= ((uint64_t)(data0
) << 12) | ((uint64_t)data1
& 0xf) << 44;
276 printf(" Address 0x%016" PRIx64
" %s\n", address
,
277 data1
& (1 << 4) ? "GGTT" : "PPGTT");
281 #define NORMAL CSI "0m"
286 const char *buffer_name
;
291 #define MAX_SECTIONS 256
292 static unsigned num_sections
;
293 static struct section sections
[MAX_SECTIONS
];
295 static int zlib_inflate(uint32_t **ptr
, int len
)
297 struct z_stream_s zstream
;
299 const uint32_t out_size
= 128*4096; /* approximate obj size */
301 memset(&zstream
, 0, sizeof(zstream
));
303 zstream
.next_in
= (unsigned char *)*ptr
;
304 zstream
.avail_in
= 4*len
;
306 if (inflateInit(&zstream
) != Z_OK
)
309 out
= malloc(out_size
);
310 zstream
.next_out
= out
;
311 zstream
.avail_out
= out_size
;
314 switch (inflate(&zstream
, Z_SYNC_FLUSH
)) {
320 inflateEnd(&zstream
);
324 if (zstream
.avail_out
)
327 out
= realloc(out
, 2*zstream
.total_out
);
329 inflateEnd(&zstream
);
333 zstream
.next_out
= (unsigned char *)out
+ zstream
.total_out
;
334 zstream
.avail_out
= zstream
.total_out
;
337 inflateEnd(&zstream
);
340 return zstream
.total_out
/ 4;
343 static int ascii85_decode(const char *in
, uint32_t **out
, bool inflate
)
345 int len
= 0, size
= 1024;
347 *out
= realloc(*out
, sizeof(uint32_t)*size
);
351 while (*in
>= '!' && *in
<= 'z') {
356 *out
= realloc(*out
, sizeof(uint32_t)*size
);
364 v
+= in
[0] - 33; v
*= 85;
365 v
+= in
[1] - 33; v
*= 85;
366 v
+= in
[2] - 33; v
*= 85;
367 v
+= in
[3] - 33; v
*= 85;
377 return zlib_inflate(out
, len
);
380 static struct gen_batch_decode_bo
381 get_gen_batch_bo(void *user_data
, uint64_t address
)
383 for (int s
= 0; s
< num_sections
; s
++) {
384 if (sections
[s
].gtt_offset
<= address
&&
385 address
< sections
[s
].gtt_offset
+ sections
[s
].dword_count
* 4) {
386 return (struct gen_batch_decode_bo
) {
387 .addr
= sections
[s
].gtt_offset
,
388 .map
= sections
[s
].data
,
389 .size
= sections
[s
].dword_count
* 4,
394 return (struct gen_batch_decode_bo
) { .map
= NULL
};
398 read_data_file(FILE *file
)
400 struct gen_spec
*spec
= NULL
;
401 long long unsigned fence
;
405 uint32_t offset
, value
;
406 char *ring_name
= NULL
;
407 struct gen_device_info devinfo
;
409 while (getline(&line
, &line_size
, file
) > 0) {
410 char *new_ring_name
= NULL
;
413 if (sscanf(line
, "%m[^ ] command stream\n", &new_ring_name
) > 0) {
415 ring_name
= new_ring_name
;
418 if (line
[0] == ':' || line
[0] == '~') {
419 uint32_t *data
= NULL
;
420 int dword_count
= ascii85_decode(line
+1, &data
, line
[0] == ':');
421 if (dword_count
== 0) {
422 fprintf(stderr
, "ASCII85 decode failed.\n");
425 assert(num_sections
< MAX_SECTIONS
);
426 sections
[num_sections
].data
= data
;
427 sections
[num_sections
].dword_count
= dword_count
;
432 dashes
= strstr(line
, "---");
438 { "ringbuffer", "ring buffer" },
439 { "gtt_offset", "batch buffer" },
440 { "hw context", "HW Context" },
441 { "hw status", "HW status" },
442 { "wa context", "WA context" },
443 { "wa batchbuffer", "WA batch" },
444 { "NULL context", "Kernel context" },
446 { "semaphores", "semaphores", },
447 { "guc log buffer", "GuC log", },
452 ring_name
= malloc(dashes
- line
);
453 strncpy(ring_name
, line
, dashes
- line
);
454 ring_name
[dashes
- line
- 1] = '\0';
457 for (b
= buffers
; b
->match
; b
++) {
458 if (strncasecmp(dashes
, b
->match
, strlen(b
->match
)) == 0)
462 assert(num_sections
< MAX_SECTIONS
);
463 sections
[num_sections
].buffer_name
= b
->name
;
464 sections
[num_sections
].ring_name
= strdup(ring_name
);
467 dashes
= strchr(dashes
, '=');
468 if (dashes
&& sscanf(dashes
, "= 0x%08x %08x\n", &hi
, &lo
))
469 sections
[num_sections
].gtt_offset
= ((uint64_t) hi
) << 32 | lo
;
474 matched
= sscanf(line
, "%08x : %08x", &offset
, &value
);
478 /* display reg section is after the ringbuffers, don't mix them */
481 matched
= sscanf(line
, "PCI ID: 0x%04x\n", ®
);
483 matched
= sscanf(line
, " PCI ID: 0x%04x\n", ®
);
485 const char *pci_id_start
= strstr(line
, "PCI ID");
487 matched
= sscanf(pci_id_start
, "PCI ID: 0x%04x\n", ®
);
490 if (!gen_get_device_info(reg
, &devinfo
)) {
491 printf("Unable to identify devid=%x\n", reg
);
495 printf("Detected GEN%i chipset\n", devinfo
.gen
);
497 if (xml_path
== NULL
)
498 spec
= gen_spec_load(&devinfo
);
500 spec
= gen_spec_load_from_path(&devinfo
, xml_path
);
503 matched
= sscanf(line
, " CTL: 0x%08x\n", ®
);
506 register_name_from_ring(ctl_registers
,
507 ARRAY_SIZE(ctl_registers
),
511 matched
= sscanf(line
, " HEAD: 0x%08x\n", ®
);
515 matched
= sscanf(line
, " ACTHD: 0x%08x\n", ®
);
518 register_name_from_ring(acthd_registers
,
519 ARRAY_SIZE(acthd_registers
),
523 matched
= sscanf(line
, " PGTBL_ER: 0x%08x\n", ®
);
524 if (matched
== 1 && reg
)
525 print_pgtbl_err(reg
, &devinfo
);
527 matched
= sscanf(line
, " ERROR: 0x%08x\n", ®
);
528 if (matched
== 1 && reg
) {
529 print_register(spec
, "GFX_ARB_ERROR_RPT", reg
);
532 matched
= sscanf(line
, " INSTDONE: 0x%08x\n", ®
);
534 const char *reg_name
=
535 instdone_register_for_ring(&devinfo
, ring_name
);
537 print_register(spec
, reg_name
, reg
);
540 matched
= sscanf(line
, " SC_INSTDONE: 0x%08x\n", ®
);
542 print_register(spec
, "SC_INSTDONE", reg
);
544 matched
= sscanf(line
, " SAMPLER_INSTDONE[%*d][%*d]: 0x%08x\n", ®
);
546 print_register(spec
, "SAMPLER_INSTDONE", reg
);
548 matched
= sscanf(line
, " ROW_INSTDONE[%*d][%*d]: 0x%08x\n", ®
);
550 print_register(spec
, "ROW_INSTDONE", reg
);
552 matched
= sscanf(line
, " INSTDONE1: 0x%08x\n", ®
);
554 print_register(spec
, "INSTDONE_1", reg
);
556 matched
= sscanf(line
, " fence[%i] = %Lx\n", ®
, &fence
);
558 print_fence(&devinfo
, fence
);
560 matched
= sscanf(line
, " FAULT_REG: 0x%08x\n", ®
);
561 if (matched
== 1 && reg
) {
562 const char *reg_name
=
563 register_name_from_ring(fault_registers
,
564 ARRAY_SIZE(fault_registers
),
566 if (reg_name
== NULL
)
567 reg_name
= "FAULT_REG";
568 print_register(spec
, reg_name
, reg
);
571 matched
= sscanf(line
, " FAULT_TLB_DATA: 0x%08x 0x%08x\n", ®
, ®2
);
573 print_fault_data(&devinfo
, reg
, reg2
);
582 enum gen_batch_decode_flags batch_flags
= 0;
583 if (option_color
== COLOR_ALWAYS
)
584 batch_flags
|= GEN_BATCH_DECODE_IN_COLOR
;
585 if (option_full_decode
)
586 batch_flags
|= GEN_BATCH_DECODE_FULL
;
587 if (option_print_offsets
)
588 batch_flags
|= GEN_BATCH_DECODE_OFFSETS
;
589 batch_flags
|= GEN_BATCH_DECODE_FLOATS
;
591 struct gen_batch_decode_ctx batch_ctx
;
592 gen_batch_decode_ctx_init(&batch_ctx
, &devinfo
, stdout
, batch_flags
,
593 xml_path
, get_gen_batch_bo
, NULL
, NULL
);
596 for (int s
= 0; s
< num_sections
; s
++) {
597 enum drm_i915_gem_engine_class
class;
598 ring_name_to_class(sections
[s
].ring_name
, &class);
600 printf("--- %s (%s) at 0x%08x %08x\n",
601 sections
[s
].buffer_name
, sections
[s
].ring_name
,
602 (unsigned) (sections
[s
].gtt_offset
>> 32),
603 (unsigned) sections
[s
].gtt_offset
);
605 if (option_print_all_bb
||
606 strcmp(sections
[s
].buffer_name
, "batch buffer") == 0 ||
607 strcmp(sections
[s
].buffer_name
, "ring buffer") == 0 ||
608 strcmp(sections
[s
].buffer_name
, "HW Context") == 0) {
609 batch_ctx
.engine
= class;
610 gen_print_batch(&batch_ctx
, sections
[s
].data
,
611 sections
[s
].dword_count
* 4,
612 sections
[s
].gtt_offset
);
616 gen_batch_decode_ctx_finish(&batch_ctx
);
618 for (int s
= 0; s
< num_sections
; s
++) {
619 free(sections
[s
].ring_name
);
620 free(sections
[s
].data
);
643 execlp("less", "less", "-FRSi", NULL
);
652 print_help(const char *progname
, FILE *file
)
655 "Usage: %s [OPTION]... [FILE]\n"
656 "Parse an Intel GPU i915_error_state.\n"
657 "With no FILE, debugfs-dri-directory is probed for in /debug and \n"
658 "/sys/kernel/debug. Otherwise, it may be specified. If a file is given,\n"
659 "it is parsed as an GPU dump in the format of /debug/dri/0/i915_error_state.\n\n"
660 " --help display this help and exit\n"
661 " --headers decode only command headers\n"
662 " --color[=WHEN] colorize the output; WHEN can be 'auto' (default\n"
663 " if omitted), 'always', or 'never'\n"
664 " --no-pager don't launch pager\n"
665 " --no-offsets don't print instruction offsets\n"
666 " --xml=DIR load hardware xml description from directory DIR\n"
667 " --all-bb print out all batchbuffers\n",
672 main(int argc
, char *argv
[])
678 bool help
= false, pager
= true;
679 const struct option aubinator_opts
[] = {
680 { "help", no_argument
, (int *) &help
, true },
681 { "no-pager", no_argument
, (int *) &pager
, false },
682 { "no-offsets", no_argument
, (int *) &option_print_offsets
, false },
683 { "headers", no_argument
, (int *) &option_full_decode
, false },
684 { "color", required_argument
, NULL
, 'c' },
685 { "xml", required_argument
, NULL
, 'x' },
686 { "all-bb", no_argument
, (int *) &option_print_all_bb
, true },
691 while ((c
= getopt_long(argc
, argv
, "", aubinator_opts
, &i
)) != -1) {
694 if (optarg
== NULL
|| strcmp(optarg
, "always") == 0)
695 option_color
= COLOR_ALWAYS
;
696 else if (strcmp(optarg
, "never") == 0)
697 option_color
= COLOR_NEVER
;
698 else if (strcmp(optarg
, "auto") == 0)
699 option_color
= COLOR_AUTO
;
701 fprintf(stderr
, "invalid value for --color: %s", optarg
);
706 xml_path
= strdup(optarg
);
713 if (help
|| argc
== 1) {
714 print_help(argv
[0], stderr
);
718 if (optind
>= argc
) {
720 path
= "/sys/class/drm/card0/error";
721 error
= stat(path
, &st
);
724 error
= stat(path
, &st
);
727 path
= "/sys/kernel/debug/dri";
728 error
= stat(path
, &st
);
732 "Couldn't find i915 debugfs directory.\n\n"
733 "Is debugfs mounted? You might try mounting it with a command such as:\n\n"
734 "\tsudo mount -t debugfs debugfs /sys/kernel/debug\n");
737 read_data_file(stdin
);
742 error
= stat(path
, &st
);
744 fprintf(stderr
, "Error opening %s: %s\n",
745 path
, strerror(errno
));
750 if (option_color
== COLOR_AUTO
)
751 option_color
= isatty(1) ? COLOR_ALWAYS
: COLOR_NEVER
;
753 if (isatty(1) && pager
)
756 if (S_ISDIR(st
.st_mode
)) {
757 MAYBE_UNUSED
int ret
;
760 ret
= asprintf(&filename
, "%s/i915_error_state", path
);
762 file
= fopen(filename
, "r");
766 for (minor
= 0; minor
< 64; minor
++) {
767 ret
= asprintf(&filename
, "%s/%d/i915_error_state", path
, minor
);
770 file
= fopen(filename
, "r");
778 fprintf(stderr
, "Failed to find i915_error_state beneath %s\n",
783 file
= fopen(path
, "r");
785 fprintf(stderr
, "Failed to open %s: %s\n",
786 path
, strerror(errno
));
791 read_data_file(file
);
794 /* close the stdout which is opened to write the output */
805 /* vim: set ts=8 sw=8 tw=0 cino=:0,(0 noet :*/