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