src/mesa/drivers/dri/radeon/radeon_debug.h

   1 /*
   2  * Copyright © 2009 Pauli Nieminen
   3  * All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * 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, sub license, 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 SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  16  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  17  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  18  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  19  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  20  *
  21  * The above copyright notice and this permission notice (including the
  22  * next paragraph) shall be included in all copies or substantial portions
  23  * of the Software.
  24  */
  25 /*
  26  * Authors:
  27  *      Pauli Nieminen <suokkos@gmail.com>
  28  */
  29
  30 #ifndef RADEON_DEBUG_H_INCLUDED
  31 #define RADEON_DEBUG_H_INCLUDED
  32
  33 #include <stdarg.h>
  34 #include <stdio.h>
  35
  36 typedef enum radeon_debug_levels {
  37         RADEON_CRITICAL  = 0, /* Only errors */
  38         RADEON_IMPORTANT = 1, /* Important warnings and messages */
  39         RADEON_NORMAL    = 2, /* Normal log messages usefull for debugging */
  40         RADEON_VERBOSE   = 3, /* Extra details to debugging */
  41         RADEON_TRACE     = 4  /* Log about everything that happens */
  42 } radeon_debug_level_t;
  43
  44 /**
  45  * Compile time option to change level of debugging compiled to dri driver.
  46  */
  47 #ifndef RADEON_DEBUG_LEVEL
  48 #define RADEON_DEBUG_LEVEL RADEON_NORMAL
  49 #endif
  50
  51 typedef enum radeon_debug_types {
  52         RADEON_TEXTURE   = 0x00001,
  53         RADEON_STATE     = 0x00002,
  54         RADEON_IOCTL     = 0x00004,
  55         RADEON_RENDER    = 0x00008,
  56         RADEON_SWRENDER  = 0x00010,
  57         RADEON_FALLBACKS = 0x00020,
  58         RADEON_VFMT      = 0x00040,
  59         RADEON_SHADER    = 0x00080,
  60         RADEON_CS        = 0x00100,
  61         RADEON_DRI       = 0x00200,
  62         RADEON_DMA       = 0x00400,
  63         RADEON_SANITY    = 0x00800,
  64         RADEON_SYNC      = 0x01000,
  65         RADEON_PIXEL     = 0x02000,
  66         RADEON_MEMORY    = 0x04000,
  67         RADEON_VERTS     = 0x08000,
  68         RADEON_GENERAL   = 0x10000   /* Used for errors and warnings */
  69 } radeon_debug_type_t;
  70
  71 extern radeon_debug_type_t radeon_enabled_debug_types;
  72
  73 /**
  74  * Compabibility layer for old debug code
  75  **/
  76 #define RADEON_DEBUG radeon_enabled_debug_types
  77
  78 static inline int radeon_is_debug_enabled(const radeon_debug_type_t type,
  79            const radeon_debug_level_t level)
  80 {
  81        return RADEON_DEBUG_LEVEL <= level
  82                 && (type & radeon_enabled_debug_types);
  83 }
  84 /*
  85  * define macro for gcc specific __attribute__ if using alternative compiler
  86  */
  87 #ifndef __GNUC__
  88 #define  __attribute__(x)  /*empty*/
  89 #endif
  90
  91 /**
  92  * Format attribute requires declaration for setting it. Don't ask me why!
  93  */
  94 static inline void radeon_print(const radeon_debug_type_t type,
  95            const radeon_debug_level_t level,
  96            const char* message,
  97            ...) __attribute__((format(printf,3,4)));
  98
  99 /**
 100  * Print out debug message if channel specified by type is enabled
 101  * and compile time debugging level is at least as high as level parameter
 102  */
 103 static inline void radeon_print(const radeon_debug_type_t type,
 104            const radeon_debug_level_t level,
 105            const char* message,
 106            ...)
 107 {
 108         /* Compile out if level of message is too high */
 109         if (radeon_is_debug_enabled(type, level)) {
 110
 111                 va_list values;
 112                 va_start( values, message );
 113                 vfprintf(stderr, message, values);
 114                 va_end( values );
 115         }
 116 }
 117
 118 static inline void radeon_error(const char* message, ...)  __attribute__((format(printf,1,2)));
 119 /**
 120  * printf style function for writing error messages.
 121  */
 122 static inline void radeon_error(const char* message, ...)
 123 {
 124        va_list values;
 125        va_start( values, message );
 126        radeon_print(RADEON_GENERAL, RADEON_CRITICAL, message, values);
 127        va_end( values );
 128 }
 129
 130 static inline void radeon_warning(const char* message, ...)  __attribute__((format(printf,1,2)));
 131 /**
 132  * printf style function for writing warnings.
 133  */
 134 static inline void radeon_warning(const char* message, ...)
 135 {
 136        va_list values;
 137        va_start( values, message );
 138        radeon_print(RADEON_GENERAL, RADEON_IMPORTANT, message, values);
 139        va_end( values );
 140 }
 141
 142
 143 extern void radeon_init_debug(void);
 144
 145 /* From http://gcc. gnu.org/onlinedocs/gcc-3.2.3/gcc/Variadic-Macros.html .
 146    I suppose we could inline this and use macro to fetch out __LINE__ and stuff in case we run into trouble
 147    with other compilers ... GLUE!
 148 */
 149 #define WARN_ONCE(a, ...)      { \
 150        static int warn##__LINE__=1; \
 151        if(warn##__LINE__){ \
 152                radeon_warning("*********************************WARN_ONCE*********************************\n"); \
 153                radeon_warning("File %s function %s line %d\n", \
 154                        __FILE__, __FUNCTION__, __LINE__); \
 155                radeon_warning(  (a), ## __VA_ARGS__);\
 156                radeon_warning("***************************************************************************\n"); \
 157                warn##__LINE__=0;\
 158                } \
 159        }
 160
 161
 162 #endif