git.oblomov.eu Git - wine/blob - libs/wine/debug.c

   1 /*
   2  * Management of the debugging channels
   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 <stdlib.h>
  25 #include <stdio.h>
  26 #include <stdarg.h>
  27 #include <string.h>
  28 #include <ctype.h>
  29
  30 #include "wine/debug.h"
  31 #include "wine/library.h"
  32 #include "wine/unicode.h"
  33
  34 static const char * const debug_classes[] = { "fixme", "err", "warn", "trace" };
  35
  36 #define MAX_DEBUG_OPTIONS 256
  37
  38 static unsigned char default_flags = (1 << __WINE_DBCL_ERR) | (1 << __WINE_DBCL_FIXME);
  39 static unsigned int nb_debug_options = 0;
  40 static struct __wine_debug_channel debug_options[MAX_DEBUG_OPTIONS];
  41
  42 static struct __wine_debug_functions funcs;
  43
  44 static int cmp_name( const void *p1, const void *p2 )
  45 {
  46     const char *name = p1;
  47     const struct __wine_debug_channel *chan = p2;
  48     return strcmp( name, chan->name );
  49 }
  50
  51 /* get the flags to use for a given channel, possibly setting them too in case of lazy init */
  52 unsigned char __wine_dbg_get_channel_flags( struct __wine_debug_channel *channel )
  53 {
  54     if (nb_debug_options)
  55     {
  56         struct __wine_debug_channel *opt = bsearch( channel->name, debug_options, nb_debug_options,
  57                                                     sizeof(debug_options[0]), cmp_name );
  58         if (opt) return opt->flags;
  59     }
  60     /* no option for this channel */
  61     if (channel->flags & (1 << __WINE_DBCL_INIT)) channel->flags = default_flags;
  62     return default_flags;
  63 }
  64
  65 /* add a new debug option at the end of the option list */
  66 static void add_option( const char *name, unsigned char set, unsigned char clear )
  67 {
  68     int min = 0, max = nb_debug_options - 1, pos, res;
  69
  70     if (!name[0])  /* "all" option */
  71     {
  72         default_flags = (default_flags & ~clear) | set;
  73         return;
  74     }
  75     if (strlen(name) >= sizeof(debug_options[0].name)) return;
  76
  77     while (min <= max)
  78     {
  79         pos = (min + max) / 2;
  80         res = strcmp( name, debug_options[pos].name );
  81         if (!res)
  82         {
  83             debug_options[pos].flags = (debug_options[pos].flags & ~clear) | set;
  84             return;
  85         }
  86         if (res < 0) max = pos - 1;
  87         else min = pos + 1;
  88     }
  89     if (nb_debug_options >= MAX_DEBUG_OPTIONS) return;
  90
  91     pos = min;
  92     if (pos < nb_debug_options) memmove( &debug_options[pos + 1], &debug_options[pos],
  93                                          (nb_debug_options - pos) * sizeof(debug_options[0]) );
  94     strcpy( debug_options[pos].name, name );
  95     debug_options[pos].flags = (default_flags & ~clear) | set;
  96     nb_debug_options++;
  97 }
  98
  99 /* parse a set of debugging option specifications and add them to the option list */
 100 static void parse_options( const char *str )
 101 {
 102     char *opt, *next, *options;
 103     unsigned int i;
 104
 105     if (!(options = strdup(str))) return;
 106     for (opt = options; opt; opt = next)
 107     {
 108         const char *p;
 109         unsigned char set = 0, clear = 0;
 110
 111         if ((next = strchr( opt, ',' ))) *next++ = 0;
 112
 113         p = opt + strcspn( opt, "+-" );
 114         if (!p[0]) p = opt;  /* assume it's a debug channel name */
 115
 116         if (p > opt)
 117         {
 118             for (i = 0; i < sizeof(debug_classes)/sizeof(debug_classes[0]); i++)
 119             {
 120                 int len = strlen(debug_classes[i]);
 121                 if (len != (p - opt)) continue;
 122                 if (!memcmp( opt, debug_classes[i], len ))  /* found it */
 123                 {
 124                     if (*p == '+') set |= 1 << i;
 125                     else clear |= 1 << i;
 126                     break;
 127                 }
 128             }
 129             if (i == sizeof(debug_classes)/sizeof(debug_classes[0])) /* bad class name, skip it */
 130                 continue;
 131         }
 132         else
 133         {
 134             if (*p == '-') clear = ~0;
 135             else set = ~0;
 136         }
 137         if (*p == '+' || *p == '-') p++;
 138         if (!p[0]) continue;
 139
 140         if (!strcmp( p, "all" ))
 141             default_flags = (default_flags & ~clear) | set;
 142         else
 143             add_option( p, set, clear );
 144     }
 145     free( options );
 146 }
 147
 148
 149 /* print the usage message */
 150 static void debug_usage(void)
 151 {
 152     static const char usage[] =
 153         "Syntax of the WINEDEBUG variable:\n"
 154         "  WINEDEBUG=[class]+xxx,[class]-yyy,...\n\n"
 155         "Example: WINEDEBUG=+all,warn-heap\n"
 156         "    turns on all messages except warning heap messages\n"
 157         "Available message classes: err, warn, fixme, trace\n";
 158     write( 2, usage, sizeof(usage) - 1 );
 159     exit(1);
 160 }
 161
 162
 163 /* initialize all options at startup */
 164 void debug_init(void)
 165 {
 166     char *wine_debug;
 167
 168     if ((wine_debug = getenv("WINEDEBUG")))
 169     {
 170         if (!strcmp( wine_debug, "help" )) debug_usage();
 171         parse_options( wine_debug );
 172     }
 173 }
 174
 175 /* varargs wrapper for funcs.dbg_vprintf */
 176 int wine_dbg_printf( const char *format, ... )
 177 {
 178     int ret;
 179     va_list valist;
 180
 181     va_start(valist, format);
 182     ret = funcs.dbg_vprintf( format, valist );
 183     va_end(valist);
 184     return ret;
 185 }
 186
 187 /* printf with temp buffer allocation */
 188 const char *wine_dbg_sprintf( const char *format, ... )
 189 {
 190     static const int max_size = 200;
 191     char *ret;
 192     int len;
 193     va_list valist;
 194
 195     va_start(valist, format);
 196     ret = funcs.get_temp_buffer( max_size );
 197     len = vsnprintf( ret, max_size, format, valist );
 198     if (len == -1 || len >= max_size) ret[max_size-1] = 0;
 199     else funcs.release_temp_buffer( ret, len + 1 );
 200     va_end(valist);
 201     return ret;
 202 }
 203
 204
 205 /* varargs wrapper for funcs.dbg_vlog */
 206 int wine_dbg_log( enum __wine_debug_class cls, struct __wine_debug_channel *channel,
 207                   const char *func, const char *format, ... )
 208 {
 209     int ret;
 210     va_list valist;
 211
 212     if (!(__wine_dbg_get_channel_flags( channel ) & (1 << cls))) return -1;
 213
 214     va_start(valist, format);
 215     ret = funcs.dbg_vlog( cls, channel, func, format, valist );
 216     va_end(valist);
 217     return ret;
 218 }
 219
 220
 221 /* allocate some tmp string space */
 222 /* FIXME: this is not 100% thread-safe */
 223 static char *get_temp_buffer( size_t size )
 224 {
 225     static char *list[32];
 226     static int pos;
 227     char *ret;
 228     int idx;
 229
 230     idx = interlocked_xchg_add( &pos, 1 ) % (sizeof(list)/sizeof(list[0]));
 231     if ((ret = realloc( list[idx], size ))) list[idx] = ret;
 232     return ret;
 233 }
 234
 235
 236 /* release unused part of the buffer */
 237 static void release_temp_buffer( char *buffer, size_t size )
 238 {
 239     /* don't bother doing anything */
 240 }
 241
 242
 243 /* default implementation of wine_dbgstr_an */
 244 static const char *default_dbgstr_an( const char *str, int n )
 245 {
 246     static const char hex[16] = "0123456789abcdef";
 247     char *dst, *res;
 248     size_t size;
 249
 250     if (!((ULONG_PTR)str >> 16))
 251     {
 252         if (!str) return "(null)";
 253         res = funcs.get_temp_buffer( 6 );
 254         sprintf( res, "#%04x", LOWORD(str) );
 255         return res;
 256     }
 257     if (n == -1) n = strlen(str);
 258     if (n < 0) n = 0;
 259     size = 10 + min( 300, n * 4 );
 260     dst = res = funcs.get_temp_buffer( size );
 261     *dst++ = '"';
 262     while (n-- > 0 && dst <= res + size - 9)
 263     {
 264         unsigned char c = *str++;
 265         switch (c)
 266         {
 267         case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
 268         case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
 269         case '\t': *dst++ = '\\'; *dst++ = 't'; break;
 270         case '"':  *dst++ = '\\'; *dst++ = '"'; break;
 271         case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
 272         default:
 273             if (c >= ' ' && c <= 126)
 274                 *dst++ = c;
 275             else
 276             {
 277                 *dst++ = '\\';
 278                 *dst++ = 'x';
 279                 *dst++ = hex[(c >> 4) & 0x0f];
 280                 *dst++ = hex[c & 0x0f];
 281             }
 282         }
 283     }
 284     *dst++ = '"';
 285     if (*str)
 286     {
 287         *dst++ = '.';
 288         *dst++ = '.';
 289         *dst++ = '.';
 290     }
 291     *dst++ = 0;
 292     funcs.release_temp_buffer( res, dst - res );
 293     return res;
 294 }
 295
 296
 297 /* default implementation of wine_dbgstr_wn */
 298 static const char *default_dbgstr_wn( const WCHAR *str, int n )
 299 {
 300     char *dst, *res;
 301     size_t size;
 302
 303     if (!((ULONG_PTR)str >> 16))
 304     {
 305         if (!str) return "(null)";
 306         res = funcs.get_temp_buffer( 6 );
 307         sprintf( res, "#%04x", LOWORD(str) );
 308         return res;
 309     }
 310     if (n == -1) n = strlenW(str);
 311     if (n < 0) n = 0;
 312     size = 12 + min( 300, n * 5 );
 313     dst = res = funcs.get_temp_buffer( n * 5 + 7 );
 314     *dst++ = 'L';
 315     *dst++ = '"';
 316     while (n-- > 0 && dst <= res + size - 10)
 317     {
 318         WCHAR c = *str++;
 319         switch (c)
 320         {
 321         case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
 322         case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
 323         case '\t': *dst++ = '\\'; *dst++ = 't'; break;
 324         case '"':  *dst++ = '\\'; *dst++ = '"'; break;
 325         case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
 326         default:
 327             if (c >= ' ' && c <= 126)
 328                 *dst++ = c;
 329             else
 330             {
 331                 *dst++ = '\\';
 332                 sprintf(dst,"%04x",c);
 333                 dst+=4;
 334             }
 335         }
 336     }
 337     *dst++ = '"';
 338     if (*str)
 339     {
 340         *dst++ = '.';
 341         *dst++ = '.';
 342         *dst++ = '.';
 343     }
 344     *dst++ = 0;
 345     funcs.release_temp_buffer( res, dst - res );
 346     return res;
 347 }
 348
 349
 350 /* default implementation of wine_dbg_vprintf */
 351 static int default_dbg_vprintf( const char *format, va_list args )
 352 {
 353     return vfprintf( stderr, format, args );
 354 }
 355
 356
 357 /* default implementation of wine_dbg_vlog */
 358 static int default_dbg_vlog( enum __wine_debug_class cls, struct __wine_debug_channel *channel,
 359                              const char *func, const char *format, va_list args )
 360 {
 361     int ret = 0;
 362
 363     if (cls < sizeof(debug_classes)/sizeof(debug_classes[0]))
 364         ret += wine_dbg_printf( "%s:%s:%s ", debug_classes[cls], channel->name, func );
 365     if (format)
 366         ret += funcs.dbg_vprintf( format, args );
 367     return ret;
 368 }
 369
 370 /* wrappers to use the function pointers */
 371
 372 const char *wine_dbgstr_an( const char * s, int n )
 373 {
 374     return funcs.dbgstr_an(s, n);
 375 }
 376
 377 const char *wine_dbgstr_wn( const WCHAR *s, int n )
 378 {
 379     return funcs.dbgstr_wn(s, n);
 380 }
 381
 382 void __wine_dbg_set_functions( const struct __wine_debug_functions *new_funcs,
 383                                struct __wine_debug_functions *old_funcs, size_t size )
 384 {
 385     if (old_funcs) memcpy( old_funcs, &funcs, min(sizeof(funcs),size) );
 386     if (new_funcs) memcpy( &funcs, new_funcs, min(sizeof(funcs),size) );
 387 }
 388
 389 static struct __wine_debug_functions funcs =
 390 {
 391     get_temp_buffer,
 392     release_temp_buffer,
 393     default_dbgstr_an,
 394     default_dbgstr_wn,
 395     default_dbg_vprintf,
 396     default_dbg_vlog
 397 };