src/intel/dev/gen_debug.h

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