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