1 /*
2  * Copyright 2003 VMware, Inc.
3  * Copyright © 2007 Intel Corporation
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice (including the
14  * next paragraph) shall be included in all copies or substantial
15  * portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20  * IN NO EVENT SHALL THE COPYRIGHT OWNER(S) AND/OR ITS SUPPLIERS BE
21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24  */
25 
26 #ifndef GEN_DEBUG_H
27 #define GEN_DEBUG_H
28 
29 #include <stdint.h>
30 #include "compiler/shader_enums.h"
31 #include "util/macros.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 /**
37  * \file gen_debug.h
38  *
39  * Basic INTEL_DEBUG environment variable handling.  This file defines the
40  * list of debugging flags, as well as some macros for handling them.
41  */
42 
43 extern uint64_t intel_debug;
44 
45 #define INTEL_DEBUG __builtin_expect(intel_debug, 0)
46 
47 #define DEBUG_TEXTURE             (1ull <<  0)
48 #define DEBUG_STATE               (1ull <<  1)
49 #define DEBUG_BLIT                (1ull <<  2)
50 #define DEBUG_MIPTREE             (1ull <<  3)
51 #define DEBUG_PERF                (1ull <<  4)
52 #define DEBUG_PERFMON             (1ull <<  5)
53 #define DEBUG_BATCH               (1ull <<  6)
54 #define DEBUG_PIXEL               (1ull <<  7)
55 #define DEBUG_BUFMGR              (1ull <<  8)
56 #define DEBUG_FBO                 (1ull <<  9)
57 #define DEBUG_GS                  (1ull << 10)
58 #define DEBUG_SYNC                (1ull << 11)
59 #define DEBUG_PRIMS               (1ull << 12)
60 #define DEBUG_VERTS               (1ull << 13)
61 #define DEBUG_DRI                 (1ull << 14)
62 #define DEBUG_SF                  (1ull << 15)
63 #define DEBUG_SUBMIT              (1ull << 16)
64 #define DEBUG_WM                  (1ull << 17)
65 #define DEBUG_URB                 (1ull << 18)
66 #define DEBUG_VS                  (1ull << 19)
67 #define DEBUG_CLIP                (1ull << 20)
68 #define DEBUG_SHADER_TIME         (1ull << 21)
69 #define DEBUG_BLORP               (1ull << 22)
70 #define DEBUG_NO16                (1ull << 23)
71 #define DEBUG_NO_DUAL_OBJECT_GS   (1ull << 24)
72 #define DEBUG_OPTIMIZER           (1ull << 25)
73 #define DEBUG_ANNOTATION          (1ull << 26)
74 #define DEBUG_NO8                 (1ull << 27)
75 #define DEBUG_NO_OACONFIG         (1ull << 28)
76 #define DEBUG_SPILL_FS            (1ull << 29)
77 #define DEBUG_SPILL_VEC4          (1ull << 30)
78 #define DEBUG_CS                  (1ull << 31)
79 #define DEBUG_HEX                 (1ull << 32)
80 #define DEBUG_NO_COMPACTION       (1ull << 33)
81 #define DEBUG_TCS                 (1ull << 34)
82 #define DEBUG_TES                 (1ull << 35)
83 #define DEBUG_L3                  (1ull << 36)
84 #define DEBUG_DO32                (1ull << 37)
85 #define DEBUG_NO_RBC              (1ull << 38)
86 #define DEBUG_NO_HIZ              (1ull << 39)
87 #define DEBUG_COLOR               (1ull << 40)
88 #define DEBUG_REEMIT              (1ull << 41)
89 #define DEBUG_SOFT64              (1ull << 42)
90 #define DEBUG_TCS_EIGHT_PATCH     (1ull << 43)
91 #define DEBUG_BT                  (1ull << 44)
92 #define DEBUG_PIPE_CONTROL        (1ull << 45)
93 #define DEBUG_NO_FAST_CLEAR       (1ull << 46)
94 #define DEBUG_NO32                (1ull << 47)
95 
96 /* These flags are not compatible with the disk shader cache */
97 #define DEBUG_DISK_CACHE_DISABLE_MASK DEBUG_SHADER_TIME
98 
99 /* These flags may affect program generation */
100 #define DEBUG_DISK_CACHE_MASK \
101    (DEBUG_NO16 | DEBUG_NO_DUAL_OBJECT_GS | DEBUG_NO8 |  DEBUG_SPILL_FS | \
102    DEBUG_SPILL_VEC4 | DEBUG_NO_COMPACTION | DEBUG_DO32 | DEBUG_SOFT64 | \
103    DEBUG_TCS_EIGHT_PATCH | DEBUG_NO32)
104 
105 #ifdef HAVE_ANDROID_PLATFORM
106 #define LOG_TAG "INTEL-MESA"
107 #if ANDROID_API_LEVEL >= 26
108 #include <log/log.h>
109 #else
110 #include <cutils/log.h>
111 #endif /* use log/log.h start from android 8 major version */
112 #ifndef ALOGW
113 #define ALOGW LOGW
114 #endif
115 #define dbg_printf(...)	ALOGW(__VA_ARGS__)
116 #else
117 #define dbg_printf(...)	fprintf(stderr, __VA_ARGS__)
118 #endif /* HAVE_ANDROID_PLATFORM */
119 
120 #define DBG(...) do {						\
121 	if (INTEL_DEBUG & FILE_DEBUG_FLAG)		\
122 		dbg_printf(__VA_ARGS__);			\
123 } while(0)
124 
125 extern uint64_t intel_debug_flag_for_shader_stage(gl_shader_stage stage);
126 
127 extern void brw_process_intel_debug_variable(void);
128 
129 /* Below is a list of structure located in the identifier buffer. The driver
130  * can fill those in for debug purposes.
131  */
132 
133 enum gen_debug_block_type {
134    /* End of the debug blocks */
135    GEN_DEBUG_BLOCK_TYPE_END = 1,
136 
137    /* Driver identifier (struct gen_debug_block_driver) */
138    GEN_DEBUG_BLOCK_TYPE_DRIVER,
139 
140    /* Frame identifier (struct gen_debug_block_frame) */
141    GEN_DEBUG_BLOCK_TYPE_FRAME,
142 
143    /* Internal, never to be written out */
144    GEN_DEBUG_BLOCK_TYPE_MAX,
145 };
146 
147 struct gen_debug_block_base {
148    uint32_t type; /* enum gen_debug_block_type */
149    uint32_t length; /* inclusive of this structure size */
150 };
151 
152 struct gen_debug_block_driver {
153    struct gen_debug_block_base base;
154    uint8_t description[];
155 };
156 
157 struct gen_debug_block_frame {
158    struct gen_debug_block_base base;
159    uint64_t frame_id;
160 };
161 
162 extern void *intel_debug_identifier(void);
163 extern uint32_t intel_debug_identifier_size(void);
164 
165 extern uint32_t intel_debug_write_identifiers(void *output,
166                                               uint32_t output_size,
167                                               const char *driver_name);
168 
169 extern void *intel_debug_get_identifier_block(void *buffer,
170                                               uint32_t buffer_size,
171                                               enum gen_debug_block_type type);
172 
173 #ifdef __cplusplus
174 }
175 #endif
176 
177 #endif /* GEN_DEBUG_H */
178