dlls/ntdll/debugtools.c

   1 /*
   2  * Debugging functions
   3  *
   4  * Copyright 2000 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #include "config.h"
  22 #include "wine/port.h"
  23
  24 #include <assert.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #ifdef HAVE_UNISTD_H
  29 # include <unistd.h>
  30 #endif
  31 #include <ctype.h>
  32
  33 #include "wine/debug.h"
  34 #include "wine/exception.h"
  35 #include "wine/library.h"
  36 #include "wine/unicode.h"
  37 #include "ntstatus.h"
  38 #include "thread.h"
  39 #include "winbase.h"
  40 #include "winnt.h"
  41 #include "winternl.h"
  42 #include "excpt.h"
  43 #include "ntdll_misc.h"
  44
  45 WINE_DECLARE_DEBUG_CHANNEL(tid);
  46
  47 /* ---------------------------------------------------------------------- */
  48
  49 /* filter for page-fault exceptions */
  50 static WINE_EXCEPTION_FILTER(page_fault)
  51 {
  52     if (GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION)
  53         return EXCEPTION_EXECUTE_HANDLER;
  54     return EXCEPTION_CONTINUE_SEARCH;
  55 }
  56
  57 /* get the debug info pointer for the current thread */
  58 static inline struct debug_info *get_info(void)
  59 {
  60     return NtCurrentTeb()->debug_info;
  61 }
  62
  63 /* allocate some tmp space for a string */
  64 static void *gimme1(int n)
  65 {
  66     struct debug_info *info = get_info();
  67     char *res = info->str_pos;
  68
  69     if (res + n >= &info->strings[sizeof(info->strings)]) res = info->strings;
  70     info->str_pos = res + n;
  71     return res;
  72 }
  73
  74 /* release extra space that we requested in gimme1() */
  75 static inline void release( void *ptr )
  76 {
  77     struct debug_info *info = NtCurrentTeb()->debug_info;
  78     info->str_pos = ptr;
  79 }
  80
  81 /* put an ASCII string into the debug buffer */
  82 inline static char *put_string_a( const char *src, int n )
  83 {
  84     static const char hex[16] = "0123456789abcdef";
  85     char *dst, *res;
  86     size_t size;
  87
  88     if (n == -1) n = strlen(src);
  89     if (n < 0) n = 0;
  90     size = 10 + min( 300, n * 4 );
  91     dst = res = gimme1( size );
  92     *dst++ = '"';
  93     while (n-- > 0 && dst <= res + size - 9)
  94     {
  95         unsigned char c = *src++;
  96         switch (c)
  97         {
  98         case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
  99         case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
 100         case '\t': *dst++ = '\\'; *dst++ = 't'; break;
 101         case '"': *dst++ = '\\'; *dst++ = '"'; break;
 102         case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
 103         default:
 104             if (c >= ' ' && c <= 126)
 105                 *dst++ = c;
 106             else
 107             {
 108                 *dst++ = '\\';
 109                 *dst++ = 'x';
 110                 *dst++ = hex[(c >> 4) & 0x0f];
 111                 *dst++ = hex[c & 0x0f];
 112             }
 113         }
 114     }
 115     *dst++ = '"';
 116     if (*src)
 117     {
 118         *dst++ = '.';
 119         *dst++ = '.';
 120         *dst++ = '.';
 121     }
 122     *dst++ = '\0';
 123     release( dst );
 124     return res;
 125 }
 126
 127 /* put a Unicode string into the debug buffer */
 128 inline static char *put_string_w( const WCHAR *src, int n )
 129 {
 130     char *dst, *res;
 131     size_t size;
 132
 133     if (n == -1) n = strlenW(src);
 134     if (n < 0) n = 0;
 135     size = 12 + min( 300, n * 5 );
 136     dst = res = gimme1( size );
 137     *dst++ = 'L';
 138     *dst++ = '"';
 139     while (n-- > 0 && dst <= res + size - 10)
 140     {
 141         WCHAR c = *src++;
 142         switch (c)
 143         {
 144         case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
 145         case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
 146         case '\t': *dst++ = '\\'; *dst++ = 't'; break;
 147         case '"': *dst++ = '\\'; *dst++ = '"'; break;
 148         case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
 149         default:
 150             if (c >= ' ' && c <= 126)
 151                 *dst++ = c;
 152             else
 153             {
 154                 *dst++ = '\\';
 155                 sprintf(dst,"%04x",c);
 156                 dst+=4;
 157             }
 158         }
 159     }
 160     *dst++ = '"';
 161     if (*src)
 162     {
 163         *dst++ = '.';
 164         *dst++ = '.';
 165         *dst++ = '.';
 166     }
 167     *dst++ = '\0';
 168     release( dst );
 169     return res;
 170 }
 171
 172 /***********************************************************************
 173  *              NTDLL_dbgstr_an
 174  */
 175 static const char *NTDLL_dbgstr_an( const char *src, int n )
 176 {
 177     char *res, *old_pos;
 178     struct debug_info *info = get_info();
 179
 180     if (!HIWORD(src))
 181     {
 182         if (!src) return "(null)";
 183         res = gimme1(6);
 184         sprintf(res, "#%04x", LOWORD(src) );
 185         return res;
 186     }
 187     /* save current position to restore it on exception */
 188     old_pos = info->str_pos;
 189     __TRY
 190     {
 191         res = put_string_a( src, n );
 192     }
 193     __EXCEPT(page_fault)
 194     {
 195         release( old_pos );
 196         return "(invalid)";
 197     }
 198     __ENDTRY
 199     return res;
 200 }
 201
 202 /***********************************************************************
 203  *              NTDLL_dbgstr_wn
 204  */
 205 static const char *NTDLL_dbgstr_wn( const WCHAR *src, int n )
 206 {
 207     char *res, *old_pos;
 208     struct debug_info *info = get_info();
 209
 210     if (!HIWORD(src))
 211     {
 212         if (!src) return "(null)";
 213         res = gimme1(6);
 214         sprintf(res, "#%04x", LOWORD(src) );
 215         return res;
 216     }
 217
 218     /* save current position to restore it on exception */
 219     old_pos = info->str_pos;
 220     __TRY
 221     {
 222         res = put_string_w( src, n );
 223     }
 224     __EXCEPT(page_fault)
 225     {
 226         release( old_pos );
 227         return "(invalid)";
 228     }
 229     __ENDTRY
 230      return res;
 231 }
 232
 233 /***********************************************************************
 234  *              NTDLL_dbg_vsprintf
 235  */
 236 static const char *NTDLL_dbg_vsprintf( const char *format, va_list args )
 237 {
 238     static const int max_size = 200;
 239
 240     char *res = gimme1( max_size );
 241     int len = vsnprintf( res, max_size, format, args );
 242     if (len == -1 || len >= max_size) res[max_size-1] = 0;
 243     else release( res + len + 1 );
 244     return res;
 245 }
 246
 247 /***********************************************************************
 248  *              NTDLL_dbg_vprintf
 249  */
 250 static int NTDLL_dbg_vprintf( const char *format, va_list args )
 251 {
 252     struct debug_info *info = get_info();
 253     char *p;
 254
 255     int ret = vsnprintf( info->out_pos, sizeof(info->output) - (info->out_pos - info->output),
 256                          format, args );
 257
 258     /* make sure we didn't exceed the buffer length
 259      * the two checks are due to glibc changes in vsnprintfs return value
 260      * the buffer size can be exceeded in case of a missing \n in
 261      * debug output */
 262     if ((ret == -1) || (ret >= sizeof(info->output) - (info->out_pos - info->output)))
 263     {
 264        fprintf( stderr, "wine_dbg_vprintf: debugstr buffer overflow (contents: '%s')\n",
 265                 info->output);
 266        info->out_pos = info->output;
 267        abort();
 268     }
 269
 270     p = strrchr( info->out_pos, '\n' );
 271     if (!p) info->out_pos += ret;
 272     else
 273     {
 274         char *pos = info->output;
 275         p++;
 276         write( 2, pos, p - pos );
 277         /* move beginning of next line to start of buffer */
 278         while ((*pos = *p++)) pos++;
 279         info->out_pos = pos;
 280     }
 281     return ret;
 282 }
 283
 284 /***********************************************************************
 285  *              NTDLL_dbg_vlog
 286  */
 287 static int NTDLL_dbg_vlog( unsigned int cls, const char *channel,
 288                            const char *function, const char *format, va_list args )
 289 {
 290     static const char * const classes[] = { "fixme", "err", "warn", "trace" };
 291     struct debug_info *info = get_info();
 292     int ret = 0;
 293
 294     /* only print header if we are at the beginning of the line */
 295     if (info->out_pos == info->output || info->out_pos[-1] == '\n')
 296     {
 297         if (TRACE_ON(tid))
 298             ret = wine_dbg_printf( "%04lx:", GetCurrentThreadId() );
 299         if (cls < sizeof(classes)/sizeof(classes[0]))
 300             ret += wine_dbg_printf( "%s:%s:%s ", classes[cls], channel + 1, function );
 301     }
 302     if (format)
 303         ret += NTDLL_dbg_vprintf( format, args );
 304     return ret;
 305 }
 306
 307 /***********************************************************************
 308  *              debug_init
 309  */
 310 void debug_init(void)
 311 {
 312     extern void __wine_dbg_ntdll_init(void);
 313
 314     __wine_dbgstr_an    = NTDLL_dbgstr_an;
 315     __wine_dbgstr_wn    = NTDLL_dbgstr_wn;
 316     __wine_dbg_vsprintf = NTDLL_dbg_vsprintf;
 317     __wine_dbg_vprintf  = NTDLL_dbg_vprintf;
 318     __wine_dbg_vlog     = NTDLL_dbg_vlog;
 319     __wine_dbg_ntdll_init();  /* hack: register debug channels early */
 320 }