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 INTEL_DEBUG_H
27#define INTEL_DEBUG_H
28
29#include <stdint.h>
30#include "compiler/shader_enums.h"
31#include "util/macros.h"
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36/**
37 * \file intel_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
43extern uint64_t intel_debug;
44
45/* Returns 0/1, not the matching bit mask. */
46#define INTEL_DEBUG(flags)        unlikely(intel_debug & (flags))
47
48#define DEBUG_TEXTURE             (1ull <<  0)
49#define DEBUG_STATE               (1ull <<  1)
50#define DEBUG_BLIT                (1ull <<  2)
51#define DEBUG_MIPTREE             (1ull <<  3)
52#define DEBUG_PERF                (1ull <<  4)
53#define DEBUG_PERFMON             (1ull <<  5)
54#define DEBUG_BATCH               (1ull <<  6)
55#define DEBUG_PIXEL               (1ull <<  7)
56#define DEBUG_BUFMGR              (1ull <<  8)
57#define DEBUG_FBO                 (1ull <<  9)
58#define DEBUG_GS                  (1ull << 10)
59#define DEBUG_SYNC                (1ull << 11)
60#define DEBUG_PRIMS               (1ull << 12)
61#define DEBUG_VERTS               (1ull << 13)
62#define DEBUG_DRI                 (1ull << 14)
63#define DEBUG_SF                  (1ull << 15)
64#define DEBUG_SUBMIT              (1ull << 16)
65#define DEBUG_WM                  (1ull << 17)
66#define DEBUG_URB                 (1ull << 18)
67#define DEBUG_VS                  (1ull << 19)
68#define DEBUG_CLIP                (1ull << 20)
69#define DEBUG_SHADER_TIME         (1ull << 21)
70#define DEBUG_BLORP               (1ull << 22)
71#define DEBUG_NO16                (1ull << 23)
72#define DEBUG_NO_DUAL_OBJECT_GS   (1ull << 24)
73#define DEBUG_OPTIMIZER           (1ull << 25)
74#define DEBUG_ANNOTATION          (1ull << 26)
75#define DEBUG_NO8                 (1ull << 27)
76#define DEBUG_NO_OACONFIG         (1ull << 28)
77#define DEBUG_SPILL_FS            (1ull << 29)
78#define DEBUG_SPILL_VEC4          (1ull << 30)
79#define DEBUG_CS                  (1ull << 31)
80#define DEBUG_HEX                 (1ull << 32)
81#define DEBUG_NO_COMPACTION       (1ull << 33)
82#define DEBUG_TCS                 (1ull << 34)
83#define DEBUG_TES                 (1ull << 35)
84#define DEBUG_L3                  (1ull << 36)
85#define DEBUG_DO32                (1ull << 37)
86#define DEBUG_NO_RBC              (1ull << 38)
87#define DEBUG_NO_HIZ              (1ull << 39)
88#define DEBUG_COLOR               (1ull << 40)
89#define DEBUG_REEMIT              (1ull << 41)
90#define DEBUG_SOFT64              (1ull << 42)
91#define DEBUG_TCS_EIGHT_PATCH     (1ull << 43)
92#define DEBUG_BT                  (1ull << 44)
93#define DEBUG_PIPE_CONTROL        (1ull << 45)
94#define DEBUG_NO_FAST_CLEAR       (1ull << 46)
95#define DEBUG_NO32                (1ull << 47)
96#define DEBUG_RT                  (1ull << 48)
97
98#define DEBUG_ANY                 (~0ull)
99
100/* These flags are not compatible with the disk shader cache */
101#define DEBUG_DISK_CACHE_DISABLE_MASK DEBUG_SHADER_TIME
102
103/* These flags may affect program generation */
104#define DEBUG_DISK_CACHE_MASK \
105   (DEBUG_NO16 | DEBUG_NO_DUAL_OBJECT_GS | DEBUG_NO8 |  DEBUG_SPILL_FS | \
106   DEBUG_SPILL_VEC4 | DEBUG_NO_COMPACTION | DEBUG_DO32 | DEBUG_SOFT64 | \
107   DEBUG_TCS_EIGHT_PATCH | DEBUG_NO32)
108
109#ifdef HAVE_ANDROID_PLATFORM
110#define LOG_TAG "INTEL-MESA"
111#if ANDROID_API_LEVEL >= 26
112#include <log/log.h>
113#else
114#include <cutils/log.h>
115#endif /* use log/log.h start from android 8 major version */
116#ifndef ALOGW
117#define ALOGW LOGW
118#endif
119#define dbg_printf(...)	ALOGW(__VA_ARGS__)
120#else
121#define dbg_printf(...)	fprintf(stderr, __VA_ARGS__)
122#endif /* HAVE_ANDROID_PLATFORM */
123
124#define DBG(...) do {                  \
125   if (INTEL_DEBUG(FILE_DEBUG_FLAG))   \
126      dbg_printf(__VA_ARGS__);         \
127} while(0)
128
129extern uint64_t intel_debug_flag_for_shader_stage(gl_shader_stage stage);
130
131extern void brw_process_intel_debug_variable(void);
132
133/* Below is a list of structure located in the identifier buffer. The driver
134 * can fill those in for debug purposes.
135 */
136
137enum intel_debug_block_type {
138   /* End of the debug blocks */
139   INTEL_DEBUG_BLOCK_TYPE_END = 1,
140
141   /* Driver identifier (struct intel_debug_block_driver) */
142   INTEL_DEBUG_BLOCK_TYPE_DRIVER,
143
144   /* Frame identifier (struct intel_debug_block_frame) */
145   INTEL_DEBUG_BLOCK_TYPE_FRAME,
146
147   /* Internal, never to be written out */
148   INTEL_DEBUG_BLOCK_TYPE_MAX,
149};
150
151struct intel_debug_block_base {
152   uint32_t type; /* enum intel_debug_block_type */
153   uint32_t length; /* inclusive of this structure size */
154};
155
156struct intel_debug_block_driver {
157   struct intel_debug_block_base base;
158   uint8_t description[];
159};
160
161struct intel_debug_block_frame {
162   struct intel_debug_block_base base;
163   uint64_t frame_id;
164};
165
166extern void *intel_debug_identifier(void);
167extern uint32_t intel_debug_identifier_size(void);
168
169extern uint32_t intel_debug_write_identifiers(void *output,
170                                              uint32_t output_size,
171                                              const char *driver_name);
172
173extern void *intel_debug_get_identifier_block(void *buffer,
174                                              uint32_t buffer_size,
175                                              enum intel_debug_block_type type);
176
177#ifdef __cplusplus
178}
179#endif
180
181#endif /* INTEL_DEBUG_H */
182