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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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 "ntdll_misc.h"
  40
  41 WINE_DECLARE_DEBUG_CHANNEL(pid);
  42 WINE_DECLARE_DEBUG_CHANNEL(timestamp);
  43
  44 static struct __wine_debug_functions default_funcs;
  45
  46 /* ---------------------------------------------------------------------- */
  47
  48 /* get the debug info pointer for the current thread */
  49 static inline struct debug_info *get_info(void)
  50 {
  51     return ntdll_get_thread_data()->debug_info;
  52 }
  53
  54 /* allocate some tmp space for a string */
  55 static char *get_temp_buffer( size_t n )
  56 {
  57     struct debug_info *info = get_info();
  58     char *res = info->str_pos;
  59
  60     if (res + n >= &info->strings[sizeof(info->strings)]) res = info->strings;
  61     info->str_pos = res + n;
  62     return res;
  63 }
  64
  65 /* release extra space that we requested in get_temp_buffer() */
  66 static void release_temp_buffer( char *ptr, size_t size )
  67 {
  68     struct debug_info *info = get_info();
  69     info->str_pos = ptr + size;
  70 }
  71
  72 /***********************************************************************
  73  *              NTDLL_dbgstr_an
  74  */
  75 static const char *NTDLL_dbgstr_an( const char *src, int n )
  76 {
  77     const char *res;
  78     struct debug_info *info = get_info();
  79     /* save current position to restore it on exception */
  80     char *old_pos = info->str_pos;
  81
  82     __TRY
  83     {
  84         res = default_funcs.dbgstr_an( src, n );
  85     }
  86     __EXCEPT_PAGE_FAULT
  87     {
  88         release_temp_buffer( old_pos, 0 );
  89         return "(invalid)";
  90     }
  91     __ENDTRY
  92     return res;
  93 }
  94
  95 /***********************************************************************
  96  *              NTDLL_dbgstr_wn
  97  */
  98 static const char *NTDLL_dbgstr_wn( const WCHAR *src, int n )
  99 {
 100     const char *res;
 101     struct debug_info *info = get_info();
 102     /* save current position to restore it on exception */
 103     char *old_pos = info->str_pos;
 104
 105     __TRY
 106     {
 107         res = default_funcs.dbgstr_wn( src, n );
 108     }
 109     __EXCEPT_PAGE_FAULT
 110     {
 111         release_temp_buffer( old_pos, 0 );
 112         return "(invalid)";
 113     }
 114     __ENDTRY
 115      return res;
 116 }
 117
 118 /***********************************************************************
 119  *              NTDLL_dbg_vprintf
 120  */
 121 static int NTDLL_dbg_vprintf( const char *format, va_list args )
 122 {
 123     struct debug_info *info = get_info();
 124     int end;
 125
 126     int ret = vsnprintf( info->out_pos, sizeof(info->output) - (info->out_pos - info->output),
 127                          format, args );
 128
 129     /* make sure we didn't exceed the buffer length
 130      * the two checks are due to glibc changes in vsnprintfs return value
 131      * the buffer size can be exceeded in case of a missing \n in
 132      * debug output */
 133     if ((ret == -1) || (ret >= sizeof(info->output) - (info->out_pos - info->output)))
 134     {
 135        fprintf( stderr, "wine_dbg_vprintf: debugstr buffer overflow (contents: '%s')\n",
 136                 info->output);
 137        info->out_pos = info->output;
 138        abort();
 139     }
 140
 141     for (end = ret; end > 0; end--) if (info->out_pos[end - 1] == '\n') break;
 142
 143     if (!end) info->out_pos += ret;
 144     else
 145     {
 146         char *pos = info->output;
 147         write( 2, pos, info->out_pos + end - pos );
 148         /* move beginning of next line to start of buffer */
 149         memmove( pos, info->out_pos + end, ret - end );
 150         info->out_pos = pos + ret - end;
 151     }
 152     return ret;
 153 }
 154
 155 /***********************************************************************
 156  *              NTDLL_dbg_vlog
 157  */
 158 static int NTDLL_dbg_vlog( enum __wine_debug_class cls, struct __wine_debug_channel *channel,
 159                            const char *function, const char *format, va_list args )
 160 {
 161     static const char * const classes[] = { "fixme", "err", "warn", "trace" };
 162     struct debug_info *info = get_info();
 163     int ret = 0;
 164
 165     /* only print header if we are at the beginning of the line */
 166     if (info->out_pos == info->output || info->out_pos[-1] == '\n')
 167     {
 168         if (TRACE_ON(timestamp))
 169         {
 170             ULONG ticks = NtGetTickCount();
 171             ret = wine_dbg_printf( "%3u.%03u:", ticks / 1000, ticks % 1000 );
 172         }
 173         if (TRACE_ON(pid))
 174             ret += wine_dbg_printf( "%04x:", GetCurrentProcessId() );
 175         ret += wine_dbg_printf( "%04x:", GetCurrentThreadId() );
 176         if (*format == '\1')  /* special magic to avoid standard prefix */
 177             format++;
 178         else if (cls < ARRAY_SIZE( classes ))
 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 }