2 * Copyright © 2016 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
35 #include <sys/types.h>
40 #include "util/macros.h"
42 #include "common/gen_decoder.h"
43 #include "common/gen_disasm.h"
44 #include "intel_aub.h"
46 /* Below is the only command missing from intel_aub.h in libdrm
47 * So, reuse intel_aub.h from libdrm and #define the
48 * AUB_MI_BATCH_BUFFER_END as below
50 #define AUB_MI_BATCH_BUFFER_END (0x0500 << 16)
53 #define BLUE_HEADER CSI "0;44m"
54 #define GREEN_HEADER CSI "1;42m"
55 #define NORMAL CSI "0m"
59 static int option_full_decode
= true;
60 static int option_print_offsets
= true;
61 static int max_vbo_lines
= -1;
62 static enum { COLOR_AUTO
, COLOR_ALWAYS
, COLOR_NEVER
} option_color
;
67 char *input_file
= NULL
, *xml_path
= NULL
;
68 struct gen_device_info devinfo
;
69 struct gen_batch_decode_ctx batch_ctx
;
71 uint64_t gtt_size
, gtt_end
;
76 struct brw_instruction
;
78 #define GEN_ENGINE_RENDER 1
79 #define GEN_ENGINE_BLITTER 2
82 handle_trace_block(uint32_t *p
)
84 int operation
= p
[1] & AUB_TRACE_OPERATION_MASK
;
85 int type
= p
[1] & AUB_TRACE_TYPE_MASK
;
86 int address_space
= p
[1] & AUB_TRACE_ADDRESS_SPACE_MASK
;
87 uint64_t offset
= p
[3];
89 int header_length
= p
[0] & 0xffff;
90 uint32_t *data
= p
+ header_length
+ 2;
91 int engine
= GEN_ENGINE_RENDER
;
94 offset
+= (uint64_t) p
[5] << 32;
97 case AUB_TRACE_OP_DATA_WRITE
:
98 if (address_space
!= AUB_TRACE_MEMTYPE_GTT
)
100 if (gtt_size
< offset
+ size
) {
101 fprintf(stderr
, "overflow gtt space: %s\n", strerror(errno
));
104 memcpy((char *) gtt
+ offset
, data
, size
);
105 if (gtt_end
< offset
+ size
)
106 gtt_end
= offset
+ size
;
108 case AUB_TRACE_OP_COMMAND_WRITE
:
110 case AUB_TRACE_TYPE_RING_PRB0
:
111 engine
= GEN_ENGINE_RENDER
;
113 case AUB_TRACE_TYPE_RING_PRB2
:
114 engine
= GEN_ENGINE_BLITTER
;
117 fprintf(outfile
, "command write to unknown ring %d\n", type
);
121 (void)engine
; /* TODO */
122 gen_print_batch(&batch_ctx
, data
, size
, 0);
129 static struct gen_batch_decode_bo
130 get_gen_batch_bo(void *user_data
, uint64_t address
)
132 if (address
> gtt_end
)
133 return (struct gen_batch_decode_bo
) { .map
= NULL
};
135 /* We really only have one giant address range */
136 return (struct gen_batch_decode_bo
) {
144 aubinator_init(uint16_t aub_pci_id
, const char *app_name
)
146 if (!gen_get_device_info(pci_id
, &devinfo
)) {
147 fprintf(stderr
, "can't find device information: pci_id=0x%x\n", pci_id
);
151 enum gen_batch_decode_flags batch_flags
= 0;
152 if (option_color
== COLOR_ALWAYS
)
153 batch_flags
|= GEN_BATCH_DECODE_IN_COLOR
;
154 if (option_full_decode
)
155 batch_flags
|= GEN_BATCH_DECODE_FULL
;
156 if (option_print_offsets
)
157 batch_flags
|= GEN_BATCH_DECODE_OFFSETS
;
158 batch_flags
|= GEN_BATCH_DECODE_FLOATS
;
160 gen_batch_decode_ctx_init(&batch_ctx
, &devinfo
, outfile
, batch_flags
,
161 xml_path
, get_gen_batch_bo
, NULL
, NULL
);
162 batch_ctx
.max_vbo_decoded_lines
= max_vbo_lines
;
164 char *color
= GREEN_HEADER
, *reset_color
= NORMAL
;
165 if (option_color
== COLOR_NEVER
)
166 color
= reset_color
= "";
168 fprintf(outfile
, "%sAubinator: Intel AUB file decoder.%-80s%s\n",
169 color
, "", reset_color
);
172 fprintf(outfile
, "File name: %s\n", input_file
);
175 fprintf(outfile
, "PCI ID: 0x%x\n", aub_pci_id
);
177 fprintf(outfile
, "Application name: %s\n", app_name
);
179 fprintf(outfile
, "Decoding as: %s\n", gen_get_device_name(pci_id
));
181 /* Throw in a new line before the first batch */
182 fprintf(outfile
, "\n");
186 handle_trace_header(uint32_t *p
)
188 /* The intel_aubdump tool from IGT is kind enough to put a PCI-ID= tag in
189 * the AUB header comment. If the user hasn't specified a hardware
190 * generation, try to use the one from the AUB file.
192 uint32_t *end
= p
+ (p
[0] & 0xffff) + 2;
194 if (end
> &p
[12] && p
[12] > 0)
195 sscanf((char *)&p
[13], "PCI-ID=%i", &aub_pci_id
);
201 strncpy(app_name
, (char *)&p
[2], 32);
204 aubinator_init(aub_pci_id
, app_name
);
208 handle_memtrace_version(uint32_t *p
)
210 int header_length
= p
[0] & 0xffff;
212 int app_name_len
= MIN2(4 * (header_length
+ 1 - 5), ARRAY_SIZE(app_name
) - 1);
216 strncpy(app_name
, (char *)&p
[5], app_name_len
);
217 app_name
[app_name_len
] = 0;
218 sscanf(app_name
, "PCI-ID=%i %n", &aub_pci_id
, &pci_id_len
);
221 aubinator_init(aub_pci_id
, app_name
+ pci_id_len
);
225 handle_memtrace_reg_write(uint32_t *p
)
227 uint32_t offset
= p
[1];
228 uint32_t value
= p
[5];
230 static int render_elsp_writes
= 0;
231 static int blitter_elsp_writes
= 0;
232 static int render_elsq0
= 0;
233 static int blitter_elsq0
= 0;
236 if (offset
== 0x2230) {
237 render_elsp_writes
++;
238 engine
= GEN_ENGINE_RENDER
;
239 } else if (offset
== 0x22230) {
240 blitter_elsp_writes
++;
241 engine
= GEN_ENGINE_BLITTER
;
242 } else if (offset
== 0x2510) {
243 render_elsq0
= value
;
244 } else if (offset
== 0x22510) {
245 blitter_elsq0
= value
;
246 } else if (offset
== 0x2550 || offset
== 0x22550) {
252 if (render_elsp_writes
> 3 || blitter_elsp_writes
> 3) {
253 render_elsp_writes
= blitter_elsp_writes
= 0;
254 pphwsp
= (uint8_t*)gtt
+ (value
& 0xfffff000);
255 } else if (offset
== 0x2550) {
256 engine
= GEN_ENGINE_RENDER
;
257 pphwsp
= (uint8_t*)gtt
+ (render_elsq0
& 0xfffff000);
258 } else if (offset
== 0x22550) {
259 engine
= GEN_ENGINE_BLITTER
;
260 pphwsp
= (uint8_t*)gtt
+ (blitter_elsq0
& 0xfffff000);
265 const uint32_t pphwsp_size
= 4096;
266 uint32_t *context
= (uint32_t*)(pphwsp
+ pphwsp_size
);
267 uint32_t ring_buffer_head
= context
[5];
268 uint32_t ring_buffer_tail
= context
[7];
269 uint32_t ring_buffer_start
= context
[9];
270 uint32_t *commands
= (uint32_t*)((uint8_t*)gtt
+ ring_buffer_start
+ ring_buffer_head
);
271 (void)engine
; /* TODO */
272 gen_print_batch(&batch_ctx
, commands
, ring_buffer_tail
- ring_buffer_head
, 0);
276 handle_memtrace_mem_write(uint32_t *p
)
278 uint64_t address
= *(uint64_t*)&p
[1];
279 uint32_t address_space
= p
[3] >> 28;
280 uint32_t size
= p
[4];
281 uint32_t *data
= p
+ 5;
283 if (address_space
!= 1)
286 if (gtt_size
< address
+ size
) {
287 fprintf(stderr
, "overflow gtt space: %s\n", strerror(errno
));
291 memcpy((char *) gtt
+ address
, data
, size
);
292 if (gtt_end
< address
+ size
)
293 gtt_end
= address
+ size
;
299 uint32_t *map
, *end
, *cursor
;
303 static struct aub_file
*
304 aub_file_open(const char *filename
)
306 struct aub_file
*file
;
310 file
= calloc(1, sizeof *file
);
311 fd
= open(filename
, O_RDONLY
);
313 fprintf(stderr
, "open %s failed: %s\n", filename
, strerror(errno
));
317 if (fstat(fd
, &sb
) == -1) {
318 fprintf(stderr
, "stat failed: %s\n", strerror(errno
));
322 file
->map
= mmap(NULL
, sb
.st_size
,
323 PROT_READ
, MAP_SHARED
, fd
, 0);
324 if (file
->map
== MAP_FAILED
) {
325 fprintf(stderr
, "mmap failed: %s\n", strerror(errno
));
331 file
->cursor
= file
->map
;
332 file
->end
= file
->map
+ sb
.st_size
/ 4;
337 static struct aub_file
*
340 struct aub_file
*file
;
342 file
= calloc(1, sizeof *file
);
343 file
->stream
= stdin
;
348 #define TYPE(dw) (((dw) >> 29) & 7)
349 #define OPCODE(dw) (((dw) >> 23) & 0x3f)
350 #define SUBOPCODE(dw) (((dw) >> 16) & 0x7f)
352 #define MAKE_HEADER(type, opcode, subopcode) \
353 (((type) << 29) | ((opcode) << 23) | ((subopcode) << 16))
357 /* Classic AUB opcodes */
358 #define OPCODE_AUB 0x01
359 #define SUBOPCODE_HEADER 0x05
360 #define SUBOPCODE_BLOCK 0x41
361 #define SUBOPCODE_BMP 0x1e
363 /* Newer version AUB opcode */
364 #define OPCODE_NEW_AUB 0x2e
365 #define SUBOPCODE_REG_POLL 0x02
366 #define SUBOPCODE_REG_WRITE 0x03
367 #define SUBOPCODE_MEM_POLL 0x05
368 #define SUBOPCODE_MEM_WRITE 0x06
369 #define SUBOPCODE_VERSION 0x0e
371 #define MAKE_GEN(major, minor) ( ((major) << 8) | (minor) )
375 AUB_ITEM_DECODE_FAILED
,
376 AUB_ITEM_DECODE_NEED_MORE_DATA
,
380 aub_file_decode_batch(struct aub_file
*file
)
382 uint32_t *p
, h
, *new_cursor
;
383 int header_length
, bias
;
385 if (file
->end
- file
->cursor
< 1)
386 return AUB_ITEM_DECODE_NEED_MORE_DATA
;
390 header_length
= h
& 0xffff;
400 fprintf(outfile
, "unknown opcode %d at %td/%td\n",
401 OPCODE(h
), file
->cursor
- file
->map
,
402 file
->end
- file
->map
);
403 return AUB_ITEM_DECODE_FAILED
;
406 new_cursor
= p
+ header_length
+ bias
;
407 if ((h
& 0xffff0000) == MAKE_HEADER(TYPE_AUB
, OPCODE_AUB
, SUBOPCODE_BLOCK
)) {
408 if (file
->end
- file
->cursor
< 4)
409 return AUB_ITEM_DECODE_NEED_MORE_DATA
;
410 new_cursor
+= p
[4] / 4;
413 if (new_cursor
> file
->end
)
414 return AUB_ITEM_DECODE_NEED_MORE_DATA
;
416 switch (h
& 0xffff0000) {
417 case MAKE_HEADER(TYPE_AUB
, OPCODE_AUB
, SUBOPCODE_HEADER
):
418 handle_trace_header(p
);
420 case MAKE_HEADER(TYPE_AUB
, OPCODE_AUB
, SUBOPCODE_BLOCK
):
421 handle_trace_block(p
);
423 case MAKE_HEADER(TYPE_AUB
, OPCODE_AUB
, SUBOPCODE_BMP
):
425 case MAKE_HEADER(TYPE_AUB
, OPCODE_NEW_AUB
, SUBOPCODE_VERSION
):
426 handle_memtrace_version(p
);
428 case MAKE_HEADER(TYPE_AUB
, OPCODE_NEW_AUB
, SUBOPCODE_REG_WRITE
):
429 handle_memtrace_reg_write(p
);
431 case MAKE_HEADER(TYPE_AUB
, OPCODE_NEW_AUB
, SUBOPCODE_MEM_WRITE
):
432 handle_memtrace_mem_write(p
);
434 case MAKE_HEADER(TYPE_AUB
, OPCODE_NEW_AUB
, SUBOPCODE_MEM_POLL
):
435 fprintf(outfile
, "memory poll block (dwords %d):\n", h
& 0xffff);
437 case MAKE_HEADER(TYPE_AUB
, OPCODE_NEW_AUB
, SUBOPCODE_REG_POLL
):
440 fprintf(outfile
, "unknown block type=0x%x, opcode=0x%x, "
441 "subopcode=0x%x (%08x)\n", TYPE(h
), OPCODE(h
), SUBOPCODE(h
), h
);
444 file
->cursor
= new_cursor
;
446 return AUB_ITEM_DECODE_OK
;
450 aub_file_more_stuff(struct aub_file
*file
)
452 return file
->cursor
< file
->end
|| (file
->stream
&& !feof(file
->stream
));
455 #define AUB_READ_BUFFER_SIZE (4096)
456 #define MAX(a, b) ((a) < (b) ? (b) : (a))
459 aub_file_data_grow(struct aub_file
*file
)
461 size_t old_size
= (file
->mem_end
- file
->map
) * 4;
462 size_t new_size
= MAX(old_size
* 2, AUB_READ_BUFFER_SIZE
);
463 uint32_t *new_start
= realloc(file
->map
, new_size
);
465 file
->cursor
= new_start
+ (file
->cursor
- file
->map
);
466 file
->end
= new_start
+ (file
->end
- file
->map
);
467 file
->map
= new_start
;
468 file
->mem_end
= file
->map
+ (new_size
/ 4);
472 aub_file_data_load(struct aub_file
*file
)
476 if (file
->stream
== NULL
)
479 /* First remove any consumed data */
480 if (file
->cursor
> file
->map
) {
481 memmove(file
->map
, file
->cursor
,
482 (file
->end
- file
->cursor
) * 4);
483 file
->end
-= file
->cursor
- file
->map
;
484 file
->cursor
= file
->map
;
487 /* Then load some new data in */
488 if ((file
->mem_end
- file
->end
) < (AUB_READ_BUFFER_SIZE
/ 4))
489 aub_file_data_grow(file
);
491 r
= fread(file
->end
, 1, (file
->mem_end
- file
->end
) * 4, file
->stream
);
516 execlp("less", "less", "-FRSi", NULL
);
525 print_help(const char *progname
, FILE *file
)
528 "Usage: %s [OPTION]... [FILE]\n"
529 "Decode aub file contents from either FILE or the standard input.\n\n"
530 "A valid --gen option must be provided.\n\n"
531 " --help display this help and exit\n"
532 " --gen=platform decode for given platform (3 letter platform name)\n"
533 " --headers decode only command headers\n"
534 " --color[=WHEN] colorize the output; WHEN can be 'auto' (default\n"
535 " if omitted), 'always', or 'never'\n"
536 " --max-vbo-lines=N limit the number of decoded VBO lines\n"
537 " --no-pager don't launch pager\n"
538 " --no-offsets don't print instruction offsets\n"
539 " --xml=DIR load hardware xml description from directory DIR\n",
543 int main(int argc
, char *argv
[])
545 struct aub_file
*file
;
547 bool help
= false, pager
= true;
548 const struct option aubinator_opts
[] = {
549 { "help", no_argument
, (int *) &help
, true },
550 { "no-pager", no_argument
, (int *) &pager
, false },
551 { "no-offsets", no_argument
, (int *) &option_print_offsets
, false },
552 { "gen", required_argument
, NULL
, 'g' },
553 { "headers", no_argument
, (int *) &option_full_decode
, false },
554 { "color", required_argument
, NULL
, 'c' },
555 { "xml", required_argument
, NULL
, 'x' },
556 { "max-vbo-lines", required_argument
, NULL
, 'v' },
563 while ((c
= getopt_long(argc
, argv
, "", aubinator_opts
, &i
)) != -1) {
566 const int id
= gen_device_name_to_pci_device_id(optarg
);
568 fprintf(stderr
, "can't parse gen: '%s', expected ivb, byt, hsw, "
569 "bdw, chv, skl, kbl or bxt\n", optarg
);
577 if (optarg
== NULL
|| strcmp(optarg
, "always") == 0)
578 option_color
= COLOR_ALWAYS
;
579 else if (strcmp(optarg
, "never") == 0)
580 option_color
= COLOR_NEVER
;
581 else if (strcmp(optarg
, "auto") == 0)
582 option_color
= COLOR_AUTO
;
584 fprintf(stderr
, "invalid value for --color: %s", optarg
);
589 xml_path
= strdup(optarg
);
592 max_vbo_lines
= atoi(optarg
);
599 if (help
|| argc
== 1) {
600 print_help(argv
[0], stderr
);
605 input_file
= argv
[optind
];
607 /* Do this before we redirect stdout to pager. */
608 if (option_color
== COLOR_AUTO
)
609 option_color
= isatty(1) ? COLOR_ALWAYS
: COLOR_NEVER
;
611 if (isatty(1) && pager
)
614 if (input_file
== NULL
)
615 file
= aub_file_stdin();
617 file
= aub_file_open(input_file
);
619 /* mmap a terabyte for our gtt space. */
620 gtt_size
= 1ull << 40;
621 gtt
= mmap(NULL
, gtt_size
, PROT_READ
| PROT_WRITE
,
622 MAP_PRIVATE
| MAP_ANONYMOUS
| MAP_NORESERVE
, -1, 0);
623 if (gtt
== MAP_FAILED
) {
624 fprintf(stderr
, "failed to alloc gtt space: %s\n", strerror(errno
));
628 while (aub_file_more_stuff(file
)) {
629 switch (aub_file_decode_batch(file
)) {
630 case AUB_ITEM_DECODE_OK
:
632 case AUB_ITEM_DECODE_NEED_MORE_DATA
:
634 file
->cursor
= file
->end
;
637 if (aub_file_more_stuff(file
) && !aub_file_data_load(file
)) {
638 fprintf(stderr
, "failed to load data from stdin\n");
643 fprintf(stderr
, "failed to parse aubdump data\n");
650 /* close the stdout which is opened to write the output */