dlls/ntdll/debugtools.c

   1 /*
   2  * Debugging functions
   3  */
   4
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include <string.h>
   8 #include <unistd.h>
   9 #include <ctype.h>
  10
  11 #include "debugtools.h"
  12 #include "thread.h"
  13 #include "winbase.h"
  14 #include "winnt.h"
  15 #include "wtypes.h"
  16
  17 /* ---------------------------------------------------------------------- */
  18
  19 struct debug_info
  20 {
  21     char *str_pos;       /* current position in strings buffer */
  22     char *out_pos;       /* current position in output buffer */
  23     char  strings[504];  /* buffer for temporary strings */
  24     char  output[504];   /* current output line */
  25 };
  26
  27 static struct debug_info tmp;
  28
  29 /* get the debug info pointer for the current thread */
  30 static inline struct debug_info *get_info(void)
  31 {
  32     struct debug_info *info = NtCurrentTeb()->debug_info;
  33     if (!info)
  34     {
  35         if (!tmp.str_pos)
  36         {
  37             tmp.str_pos = tmp.strings;
  38             tmp.out_pos = tmp.output;
  39         }
  40         if (!GetProcessHeap()) return &tmp;
  41         /* setup the temp structure in case HeapAlloc wants to print something */
  42         NtCurrentTeb()->debug_info = &tmp;
  43         info = HeapAlloc( GetProcessHeap(), 0, sizeof(*info) );
  44         info->str_pos = info->strings;
  45         info->out_pos = info->output;
  46         NtCurrentTeb()->debug_info = info;
  47     }
  48     return info;
  49 }
  50
  51 /* allocate some tmp space for a string */
  52 static void *gimme1(int n)
  53 {
  54     struct debug_info *info = get_info();
  55     char *res = info->str_pos;
  56
  57     if (res + n >= &info->strings[sizeof(info->strings)]) res = info->strings;
  58     info->str_pos = res + n;
  59     return res;
  60 }
  61
  62 /* release extra space that we requested in gimme1() */
  63 static inline void release( void *ptr )
  64 {
  65     struct debug_info *info = NtCurrentTeb()->debug_info;
  66     info->str_pos = ptr;
  67 }
  68
  69 /***********************************************************************
  70  *              wine_dbgstr_an
  71  */
  72 const char *wine_dbgstr_an( const char *src, int n )
  73 {
  74     char *dst, *res;
  75
  76     if (!HIWORD(src))
  77     {
  78         if (!src) return "(null)";
  79         res = gimme1(6);
  80         sprintf(res, "#%04x", LOWORD(src) );
  81         return res;
  82     }
  83     if (n < 0) n = 0;
  84     dst = res = gimme1 (n * 4 + 6);
  85     *dst++ = '"';
  86     while (n-- > 0 && *src)
  87     {
  88         unsigned char c = *src++;
  89         switch (c)
  90         {
  91         case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
  92         case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
  93         case '\t': *dst++ = '\\'; *dst++ = 't'; break;
  94         case '"': *dst++ = '\\'; *dst++ = '"'; break;
  95         case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
  96         default:
  97             if (c >= ' ' && c <= 126)
  98                 *dst++ = c;
  99             else
 100             {
 101                 *dst++ = '\\';
 102                 *dst++ = '0' + ((c >> 6) & 7);
 103                 *dst++ = '0' + ((c >> 3) & 7);
 104                 *dst++ = '0' + ((c >> 0) & 7);
 105             }
 106         }
 107     }
 108     *dst++ = '"';
 109     if (*src)
 110     {
 111         *dst++ = '.';
 112         *dst++ = '.';
 113         *dst++ = '.';
 114     }
 115     *dst++ = '\0';
 116     release( dst );
 117     return res;
 118 }
 119
 120 /***********************************************************************
 121  *              wine_dbgstr_wn
 122  */
 123 const char *wine_dbgstr_wn( const WCHAR *src, int n )
 124 {
 125     char *dst, *res;
 126
 127     if (!HIWORD(src))
 128     {
 129         if (!src) return "(null)";
 130         res = gimme1(6);
 131         sprintf(res, "#%04x", LOWORD(src) );
 132         return res;
 133     }
 134     if (n < 0) n = 0;
 135     dst = res = gimme1 (n * 5 + 7);
 136     *dst++ = 'L';
 137     *dst++ = '"';
 138     while (n-- > 0 && *src)
 139     {
 140         WCHAR c = *src++;
 141         switch (c)
 142         {
 143         case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
 144         case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
 145         case '\t': *dst++ = '\\'; *dst++ = 't'; break;
 146         case '"': *dst++ = '\\'; *dst++ = '"'; break;
 147         case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
 148         default:
 149             if (c >= ' ' && c <= 126)
 150                 *dst++ = c;
 151             else
 152             {
 153                 *dst++ = '\\';
 154                 sprintf(dst,"%04x",c);
 155                 dst+=4;
 156             }
 157         }
 158     }
 159     *dst++ = '"';
 160     if (*src)
 161     {
 162         *dst++ = '.';
 163         *dst++ = '.';
 164         *dst++ = '.';
 165     }
 166     *dst++ = '\0';
 167     release( dst );
 168     return res;
 169 }
 170
 171 /***********************************************************************
 172  *              wine_dbgstr_guid
 173  */
 174 const char *wine_dbgstr_guid( const GUID *id )
 175 {
 176     char *str;
 177
 178     if (!id) return "(null)";
 179     if (!HIWORD(id))
 180     {
 181         str = gimme1(12);
 182         sprintf( str, "<guid-0x%04x>", LOWORD(id) );
 183     }
 184     else
 185     {
 186         str = gimme1(40);
 187         sprintf( str, "{%08lx-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
 188                  id->Data1, id->Data2, id->Data3,
 189                  id->Data4[0], id->Data4[1], id->Data4[2], id->Data4[3],
 190                  id->Data4[4], id->Data4[5], id->Data4[6], id->Data4[7] );
 191     }
 192     return str;
 193 }
 194
 195 /***********************************************************************
 196  *              wine_dbg_vprintf
 197  */
 198 int wine_dbg_vprintf( const char *format, va_list args )
 199 {
 200     struct debug_info *info = get_info();
 201
 202     int ret = vsprintf( info->out_pos, format, args );
 203     char *p = strrchr( info->out_pos, '\n' );
 204     if (!p) info->out_pos += ret;
 205     else
 206     {
 207         char *pos = info->output;
 208         p++;
 209         write( 2, pos, p - pos );
 210         /* move beginning of next line to start of buffer */
 211         while ((*pos = *p++)) pos++;
 212         info->out_pos = pos;
 213     }
 214     return ret;
 215 }
 216
 217 /***********************************************************************
 218  *              wine_dbg_printf
 219  */
 220 int wine_dbg_printf(const char *format, ...)
 221 {
 222     int ret;
 223     va_list valist;
 224
 225     va_start(valist, format);
 226     ret = wine_dbg_vprintf( format, valist );
 227     va_end(valist);
 228     return ret;
 229 }
 230
 231 /***********************************************************************
 232  *              wine_dbg_log
 233  */
 234 int wine_dbg_log(enum __DEBUG_CLASS cls, const char *channel,
 235                  const char *function, const char *format, ... )
 236 {
 237     static const char *classes[__DBCL_COUNT] = { "fixme", "err", "warn", "trace" };
 238     va_list valist;
 239     int ret = 0;
 240
 241     va_start(valist, format);
 242     if (cls < __DBCL_COUNT)
 243         ret = wine_dbg_printf( "%s:%s:%s ", classes[cls], channel + 1, function );
 244     if (format)
 245         ret += wine_dbg_vprintf( format, valist );
 246     va_end(valist);
 247     return ret;
 248 }