2 * Copyright © 2014 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
26 #include "common/gen_debug.h"
27 #include "intel_asm_annotation.h"
28 #include "compiler/nir/nir.h"
30 __attribute__((weak
)) void nir_print_instr(const nir_instr
*instr
, FILE *fp
) {}
33 dump_assembly(void *assembly
, int num_annotations
, struct annotation
*annotation
,
34 const struct gen_device_info
*devinfo
)
36 const char *last_annotation_string
= NULL
;
37 const void *last_annotation_ir
= NULL
;
39 for (int i
= 0; i
< num_annotations
; i
++) {
40 int start_offset
= annotation
[i
].offset
;
41 int end_offset
= annotation
[i
+ 1].offset
;
43 if (annotation
[i
].block_start
) {
44 fprintf(stderr
, " START B%d", annotation
[i
].block_start
->num
);
45 foreach_list_typed(struct bblock_link
, predecessor_link
, link
,
46 &annotation
[i
].block_start
->parents
) {
47 struct bblock_t
*predecessor_block
= predecessor_link
->block
;
48 fprintf(stderr
, " <-B%d", predecessor_block
->num
);
50 fprintf(stderr
, " (%u cycles)\n", annotation
[i
].block_start
->cycle_count
);
53 if (last_annotation_ir
!= annotation
[i
].ir
) {
54 last_annotation_ir
= annotation
[i
].ir
;
55 if (last_annotation_ir
) {
57 nir_print_instr(annotation
[i
].ir
, stderr
);
58 fprintf(stderr
, "\n");
62 if (last_annotation_string
!= annotation
[i
].annotation
) {
63 last_annotation_string
= annotation
[i
].annotation
;
64 if (last_annotation_string
)
65 fprintf(stderr
, " %s\n", last_annotation_string
);
68 brw_disassemble(devinfo
, assembly
, start_offset
, end_offset
, stderr
);
70 if (annotation
[i
].error
) {
71 fputs(annotation
[i
].error
, stderr
);
74 if (annotation
[i
].block_end
) {
75 fprintf(stderr
, " END B%d", annotation
[i
].block_end
->num
);
76 foreach_list_typed(struct bblock_link
, successor_link
, link
,
77 &annotation
[i
].block_end
->children
) {
78 struct bblock_t
*successor_block
= successor_link
->block
;
79 fprintf(stderr
, " ->B%d", successor_block
->num
);
81 fprintf(stderr
, "\n");
84 fprintf(stderr
, "\n");
88 annotation_array_ensure_space(struct annotation_info
*annotation
)
90 if (annotation
->ann_size
<= annotation
->ann_count
) {
91 int old_size
= annotation
->ann_size
;
92 annotation
->ann_size
= MAX2(1024, annotation
->ann_size
* 2);
93 annotation
->ann
= reralloc(annotation
->mem_ctx
, annotation
->ann
,
94 struct annotation
, annotation
->ann_size
);
98 memset(annotation
->ann
+ old_size
, 0,
99 (annotation
->ann_size
- old_size
) * sizeof(struct annotation
));
105 void annotate(const struct gen_device_info
*devinfo
,
106 struct annotation_info
*annotation
, const struct cfg_t
*cfg
,
107 struct backend_instruction
*inst
, unsigned offset
)
109 if (annotation
->mem_ctx
== NULL
)
110 annotation
->mem_ctx
= ralloc_context(NULL
);
112 if (!annotation_array_ensure_space(annotation
))
115 struct annotation
*ann
= &annotation
->ann
[annotation
->ann_count
++];
116 ann
->offset
= offset
;
117 if ((INTEL_DEBUG
& DEBUG_ANNOTATION
) != 0) {
119 ann
->annotation
= inst
->annotation
;
122 if (bblock_start(cfg
->blocks
[annotation
->cur_block
]) == inst
) {
123 ann
->block_start
= cfg
->blocks
[annotation
->cur_block
];
126 /* There is no hardware DO instruction on Gen6+, so since DO always
127 * starts a basic block, we need to set the .block_start of the next
128 * instruction's annotation with a pointer to the bblock started by
131 * There's also only complication from emitting an annotation without
132 * a corresponding hardware instruction to disassemble.
134 if (devinfo
->gen
>= 6 && inst
->opcode
== BRW_OPCODE_DO
) {
135 annotation
->ann_count
--;
138 if (bblock_end(cfg
->blocks
[annotation
->cur_block
]) == inst
) {
139 ann
->block_end
= cfg
->blocks
[annotation
->cur_block
];
140 annotation
->cur_block
++;
145 annotation_finalize(struct annotation_info
*annotation
,
146 unsigned next_inst_offset
)
148 if (!annotation
->ann_count
)
151 if (annotation
->ann_count
== annotation
->ann_size
) {
152 annotation
->ann
= reralloc(annotation
->mem_ctx
, annotation
->ann
,
153 struct annotation
, annotation
->ann_size
+ 1);
155 annotation
->ann
[annotation
->ann_count
].offset
= next_inst_offset
;
159 annotation_insert_error(struct annotation_info
*annotation
, unsigned offset
,
162 struct annotation
*ann
;
164 if (!annotation
->ann_count
)
167 /* We may have to split an annotation, so ensure we have enough space
168 * allocated for that case up front.
170 if (!annotation_array_ensure_space(annotation
))
173 assume(annotation
->ann_count
> 0);
175 for (int i
= 0; i
< annotation
->ann_count
; i
++) {
176 struct annotation
*cur
= &annotation
->ann
[i
];
177 struct annotation
*next
= &annotation
->ann
[i
+ 1];
180 if (next
->offset
<= offset
)
183 if (offset
+ sizeof(brw_inst
) != next
->offset
) {
185 (annotation
->ann_count
- i
+ 2) * sizeof(struct annotation
));
187 cur
->error_length
= 0;
188 cur
->block_end
= NULL
;
189 next
->offset
= offset
+ sizeof(brw_inst
);
190 next
->block_start
= NULL
;
191 annotation
->ann_count
++;
197 ralloc_strcat(&ann
->error
, error
);
199 ann
->error
= ralloc_strdup(annotation
->mem_ctx
, error
);