git.oblomov.eu Git - wine/blob - 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 "winnt.h"
  38 #include "winternl.h"
  39 #include "excpt.h"
  40 #include "ntdll_misc.h"
  41
  42 WINE_DECLARE_DEBUG_CHANNEL(tid);
  43
  44 static struct __wine_debug_functions default_funcs;
  45
  46 /* ---------------------------------------------------------------------- */
  47
  48 /* filter for page-fault exceptions */
  49 static WINE_EXCEPTION_FILTER(page_fault)
  50 {
  51     if (GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION)
  52         return EXCEPTION_EXECUTE_HANDLER;
  53     return EXCEPTION_CONTINUE_SEARCH;
  54 }
  55
  56 /* get the debug info pointer for the current thread */
  57 static inline struct debug_info *get_info(void)
  58 {
  59     return ntdll_get_thread_data()->debug_info;
  60 }
  61
  62 /* allocate some tmp space for a string */
  63 static char *get_temp_buffer( size_t n )
  64 {
  65     struct debug_info *info = get_info();
  66     char *res = info->str_pos;
  67
  68     if (res + n >= &info->strings[sizeof(info->strings)]) res = info->strings;
  69     info->str_pos = res + n;
  70     return res;
  71 }
  72
  73 /* release extra space that we requested in gimme1() */
  74 static void release_temp_buffer( char *ptr, size_t size )
  75 {
  76     struct debug_info *info = get_info();
  77     info->str_pos = ptr + size;
  78 }
  79
  80 /***********************************************************************
  81  *              NTDLL_dbgstr_an
  82  */
  83 static const char *NTDLL_dbgstr_an( const char *src, int n )
  84 {
  85     const char *res;
  86     struct debug_info *info = get_info();
  87     /* save current position to restore it on exception */
  88     char *old_pos = info->str_pos;
  89
  90     __TRY
  91     {
  92         res = default_funcs.dbgstr_an( src, n );
  93     }
  94     __EXCEPT(page_fault)
  95     {
  96         release_temp_buffer( old_pos, 0 );
  97         return "(invalid)";
  98     }
  99     __ENDTRY
 100     return res;
 101 }
 102
 103 /***********************************************************************
 104  *              NTDLL_dbgstr_wn
 105  */
 106 static const char *NTDLL_dbgstr_wn( const WCHAR *src, int n )
 107 {
 108     const char *res;
 109     struct debug_info *info = get_info();
 110     /* save current position to restore it on exception */
 111     char *old_pos = info->str_pos;
 112
 113     __TRY
 114     {
 115         res = default_funcs.dbgstr_wn( src, n );
 116     }
 117     __EXCEPT(page_fault)
 118     {
 119         release_temp_buffer( old_pos, 0 );
 120         return "(invalid)";
 121     }
 122     __ENDTRY
 123      return res;
 124 }
 125
 126 /***********************************************************************
 127  *              NTDLL_dbg_vprintf
 128  */
 129 static int NTDLL_dbg_vprintf( const char *format, va_list args )
 130 {
 131     struct debug_info *info = get_info();
 132     char *p;
 133
 134     int ret = vsnprintf( info->out_pos, sizeof(info->output) - (info->out_pos - info->output),
 135                          format, args );
 136
 137     /* make sure we didn't exceed the buffer length
 138      * the two checks are due to glibc changes in vsnprintfs return value
 139      * the buffer size can be exceeded in case of a missing \n in
 140      * debug output */
 141     if ((ret == -1) || (ret >= sizeof(info->output) - (info->out_pos - info->output)))
 142     {
 143        fprintf( stderr, "wine_dbg_vprintf: debugstr buffer overflow (contents: '%s')\n",
 144                 info->output);
 145        info->out_pos = info->output;
 146        abort();
 147     }
 148
 149     p = strrchr( info->out_pos, '\n' );
 150     if (!p) info->out_pos += ret;
 151     else
 152     {
 153         char *pos = info->output;
 154         p++;
 155         write( 2, pos, p - pos );
 156         /* move beginning of next line to start of buffer */
 157         while ((*pos = *p++)) pos++;
 158         info->out_pos = pos;
 159     }
 160     return ret;
 161 }
 162
 163 /***********************************************************************
 164  *              NTDLL_dbg_vlog
 165  */
 166 static int NTDLL_dbg_vlog( enum __wine_debug_class cls, struct __wine_debug_channel *channel,
 167                            const char *function, const char *format, va_list args )
 168 {
 169     static const char * const classes[] = { "fixme", "err", "warn", "trace" };
 170     struct debug_info *info = get_info();
 171     int ret = 0;
 172
 173     /* only print header if we are at the beginning of the line */
 174     if (info->out_pos == info->output || info->out_pos[-1] == '\n')
 175     {
 176         if (TRACE_ON(tid))
 177             ret = wine_dbg_printf( "%04lx:", GetCurrentThreadId() );
 178         if (cls < sizeof(classes)/sizeof(classes[0]))
 179             ret += wine_dbg_printf( "%s:%s:%s ", classes[cls], channel->name, function );
 180     }
 181     if (format)
 182         ret += NTDLL_dbg_vprintf( format, args );
 183     return ret;
 184 }
 185
 186
 187 static const struct __wine_debug_functions funcs =
 188 {
 189     get_temp_buffer,
 190     release_temp_buffer,
 191     NTDLL_dbgstr_an,
 192     NTDLL_dbgstr_wn,
 193     NTDLL_dbg_vprintf,
 194     NTDLL_dbg_vlog
 195 };
 196
 197 /***********************************************************************
 198  *              debug_init
 199  */
 200 void debug_init(void)
 201 {
 202     __wine_dbg_set_functions( &funcs, &default_funcs, sizeof(funcs) );
 203 }