library/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 struct dll
  35 {
  36     struct dll   *next;        /* linked list of dlls */
  37     struct dll   *prev;
  38     char * const *channels;    /* array of channels */
  39     int           nb_channels; /* number of channels in array */
  40 };
  41
  42 static struct dll *first_dll;
  43
  44 struct debug_option
  45 {
  46     struct debug_option *next;       /* next option in list */
  47     unsigned char        set;        /* bits to set */
  48     unsigned char        clear;      /* bits to clear */
  49     char                 name[14];   /* channel name, or empty for "all" */
  50 };
  51
  52 static struct debug_option *first_option;
  53 static struct debug_option *last_option;
  54
  55 static const char * const debug_classes[] = { "fixme", "err", "warn", "trace" };
  56
  57 static int cmp_name( const void *p1, const void *p2 )
  58 {
  59     const char *name = p1;
  60     const char * const *chan = p2;
  61     return strcmp( name, *chan + 1 );
  62 }
  63
  64 /* apply a debug option to the channels of a given dll */
  65 static void apply_option( struct dll *dll, const struct debug_option *opt )
  66 {
  67     if (opt->name[0])
  68     {
  69         char **dbch = bsearch( opt->name, dll->channels, dll->nb_channels,
  70                                sizeof(*dll->channels), cmp_name );
  71         if (dbch) **dbch = (**dbch & ~opt->clear) | opt->set;
  72     }
  73     else /* all */
  74     {
  75         int i;
  76         for (i = 0; i < dll->nb_channels; i++)
  77             dll->channels[i][0] = (dll->channels[i][0] & ~opt->clear) | opt->set;
  78     }
  79 }
  80
  81 /* register a new set of channels for a dll */
  82 void *__wine_dbg_register( char * const *channels, int nb )
  83 {
  84     struct debug_option *opt = first_option;
  85     struct dll *dll = malloc( sizeof(*dll) );
  86     if (dll)
  87     {
  88         dll->channels = channels;
  89         dll->nb_channels = nb;
  90         dll->prev = NULL;
  91         if ((dll->next = first_dll)) dll->next->prev = dll;
  92         first_dll = dll;
  93
  94         /* apply existing options to this dll */
  95         while (opt)
  96         {
  97             apply_option( dll, opt );
  98             opt = opt->next;
  99         }
 100     }
 101     return dll;
 102 }
 103
 104
 105 /* unregister a set of channels; must pass the pointer obtained from wine_dbg_register */
 106 void __wine_dbg_unregister( void *channel )
 107 {
 108     struct dll *dll = channel;
 109     if (dll)
 110     {
 111         if (dll->next) dll->next->prev = dll->prev;
 112         if (dll->prev) dll->prev->next = dll->next;
 113         else first_dll = dll->next;
 114         free( dll );
 115     }
 116 }
 117
 118
 119 /* add a new debug option at the end of the option list */
 120 void wine_dbg_add_option( const char *name, unsigned char set, unsigned char clear )
 121 {
 122     struct dll *dll = first_dll;
 123     struct debug_option *opt;
 124
 125     if (!(opt = malloc( sizeof(*opt) ))) return;
 126     opt->next  = NULL;
 127     opt->set   = set;
 128     opt->clear = clear;
 129     strncpy( opt->name, name, sizeof(opt->name) );
 130     opt->name[sizeof(opt->name)-1] = 0;
 131     if (last_option) last_option->next = opt;
 132     else first_option = opt;
 133     last_option = opt;
 134
 135     /* apply option to all existing dlls */
 136     while (dll)
 137     {
 138         apply_option( dll, opt );
 139         dll = dll->next;
 140     }
 141 }
 142
 143 /* parse a set of debugging option specifications and add them to the option list */
 144 int wine_dbg_parse_options( const char *str )
 145 {
 146     char *p, *opt, *next, *options;
 147     int i, errors = 0;
 148
 149     if (!(options = strdup(str))) return -1;
 150     for (opt = options; opt; opt = next)
 151     {
 152         unsigned char set = 0, clear = 0;
 153
 154         if ((next = strchr( opt, ',' ))) *next++ = 0;
 155
 156         p = opt + strcspn( opt, "+-" );
 157         if (!p[0] || !p[1])  /* bad option, skip it */
 158         {
 159             errors++;
 160             continue;
 161         }
 162
 163         if (p > opt)
 164         {
 165             for (i = 0; i < sizeof(debug_classes)/sizeof(debug_classes[0]); i++)
 166             {
 167                 int len = strlen(debug_classes[i]);
 168                 if (len != (p - opt)) continue;
 169                 if (!memcmp( opt, debug_classes[i], len ))  /* found it */
 170                 {
 171                     if (*p == '+') set |= 1 << i;
 172                     else clear |= 1 << i;
 173                     break;
 174                 }
 175             }
 176             if (i == sizeof(debug_classes)/sizeof(debug_classes[0])) /* bad class name, skip it */
 177             {
 178                 errors++;
 179                 continue;
 180             }
 181         }
 182         else
 183         {
 184             if (*p == '+') set = ~0;
 185             else clear = ~0;
 186         }
 187         p++;
 188         if (!strcmp( p, "all" )) p = "";  /* empty string means all */
 189         wine_dbg_add_option( p, set, clear );
 190     }
 191     free( options );
 192     return errors;
 193 }
 194
 195 /* varargs wrapper for __wine_dbg_vprintf */
 196 int wine_dbg_printf( const char *format, ... )
 197 {
 198     int ret;
 199     va_list valist;
 200
 201     va_start(valist, format);
 202     ret = __wine_dbg_vprintf( format, valist );
 203     va_end(valist);
 204     return ret;
 205 }
 206
 207
 208 /* varargs wrapper for __wine_dbg_vlog */
 209 int wine_dbg_log( int cls, const char *channel, const char *func, const char *format, ... )
 210 {
 211     int ret;
 212     va_list valist;
 213
 214     va_start(valist, format);
 215     ret = __wine_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_tmp_space( int size )
 224 {
 225     static char *list[32];
 226     static long 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 /* default implementation of wine_dbgstr_an */
 237 static const char *default_dbgstr_an( const char *str, int n )
 238 {
 239     char *dst, *res;
 240
 241     if (!HIWORD(str))
 242     {
 243         if (!str) return "(null)";
 244         res = get_tmp_space( 6 );
 245         sprintf( res, "#%04x", LOWORD(str) );
 246         return res;
 247     }
 248     if (n == -1) n = strlen(str);
 249     if (n < 0) n = 0;
 250     else if (n > 200) n = 200;
 251     dst = res = get_tmp_space( n * 4 + 6 );
 252     *dst++ = '"';
 253     while (n-- > 0)
 254     {
 255         unsigned char c = *str++;
 256         switch (c)
 257         {
 258         case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
 259         case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
 260         case '\t': *dst++ = '\\'; *dst++ = 't'; break;
 261         case '"':  *dst++ = '\\'; *dst++ = '"'; break;
 262         case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
 263         default:
 264             if (c >= ' ' && c <= 126)
 265                 *dst++ = c;
 266             else
 267             {
 268                 *dst++ = '\\';
 269                 *dst++ = '0' + ((c >> 6) & 7);
 270                 *dst++ = '0' + ((c >> 3) & 7);
 271                 *dst++ = '0' + ((c >> 0) & 7);
 272             }
 273         }
 274     }
 275     *dst++ = '"';
 276     if (*str)
 277     {
 278         *dst++ = '.';
 279         *dst++ = '.';
 280         *dst++ = '.';
 281     }
 282     *dst = 0;
 283     return res;
 284 }
 285
 286
 287 /* default implementation of wine_dbgstr_wn */
 288 static const char *default_dbgstr_wn( const WCHAR *str, int n )
 289 {
 290     char *dst, *res;
 291
 292     if (!HIWORD(str))
 293     {
 294         if (!str) return "(null)";
 295         res = get_tmp_space( 6 );
 296         sprintf( res, "#%04x", LOWORD(str) );
 297         return res;
 298     }
 299     if (n == -1) n = strlenW(str);
 300     if (n < 0) n = 0;
 301     else if (n > 200) n = 200;
 302     dst = res = get_tmp_space( n * 5 + 7 );
 303     *dst++ = 'L';
 304     *dst++ = '"';
 305     while (n-- > 0)
 306     {
 307         WCHAR c = *str++;
 308         switch (c)
 309         {
 310         case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
 311         case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
 312         case '\t': *dst++ = '\\'; *dst++ = 't'; break;
 313         case '"':  *dst++ = '\\'; *dst++ = '"'; break;
 314         case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
 315         default:
 316             if (c >= ' ' && c <= 126)
 317                 *dst++ = c;
 318             else
 319             {
 320                 *dst++ = '\\';
 321                 sprintf(dst,"%04x",c);
 322                 dst+=4;
 323             }
 324         }
 325     }
 326     *dst++ = '"';
 327     if (*str)
 328     {
 329         *dst++ = '.';
 330         *dst++ = '.';
 331         *dst++ = '.';
 332     }
 333     *dst = 0;
 334     return res;
 335 }
 336
 337
 338 /* default implementation of wine_dbgstr_guid */
 339 static const char *default_dbgstr_guid( const struct _GUID *id )
 340 {
 341     char *str;
 342
 343     if (!id) return "(null)";
 344     if (!((int)id >> 16))
 345     {
 346         str = get_tmp_space( 12 );
 347         sprintf( str, "<guid-0x%04x>", (int)id & 0xffff );
 348     }
 349     else
 350     {
 351         str = get_tmp_space( 40 );
 352         sprintf( str, "{%08lx-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
 353                  id->Data1, id->Data2, id->Data3,
 354                  id->Data4[0], id->Data4[1], id->Data4[2], id->Data4[3],
 355                  id->Data4[4], id->Data4[5], id->Data4[6], id->Data4[7] );
 356     }
 357     return str;
 358 }
 359
 360
 361 /* default implementation of wine_dbg_vprintf */
 362 static int default_dbg_vprintf( const char *format, va_list args )
 363 {
 364     return vfprintf( stderr, format, args );
 365 }
 366
 367
 368 /* default implementation of wine_dbg_vlog */
 369 static int default_dbg_vlog( int cls, const char *channel, const char *func,
 370                              const char *format, va_list args )
 371 {
 372     int ret = 0;
 373
 374     if (cls < sizeof(debug_classes)/sizeof(debug_classes[0]))
 375         ret += wine_dbg_printf( "%s:%s:%s ", debug_classes[cls], channel + 1, func );
 376     if (format)
 377         ret += __wine_dbg_vprintf( format, args );
 378     return ret;
 379 }
 380
 381
 382 /* exported function pointers so that debugging functions can be redirected at run-time */
 383
 384 const char * (*__wine_dbgstr_an)( const char * s, int n ) = default_dbgstr_an;
 385 const char * (*__wine_dbgstr_wn)( const WCHAR *s, int n ) = default_dbgstr_wn;
 386 const char * (*__wine_dbgstr_guid)( const struct _GUID *id ) = default_dbgstr_guid;
 387 int (*__wine_dbg_vprintf)( const char *format, va_list args ) = default_dbg_vprintf;
 388 int (*__wine_dbg_vlog)( int cls, const char *channel, const char *function,
 389                         const char *format, va_list args ) = default_dbg_vlog;
 390
 391 /* wrappers to use the function pointers */
 392
 393 const char *wine_dbgstr_guid( const struct _GUID *id )
 394 {
 395     return __wine_dbgstr_guid(id);
 396 }
 397
 398 const char *wine_dbgstr_an( const char * s, int n )
 399 {
 400     return __wine_dbgstr_an(s, n);
 401 }
 402
 403 const char *wine_dbgstr_wn( const WCHAR *s, int n )
 404 {
 405     return __wine_dbgstr_wn(s, n);
 406 }
 407
 408 const char *wine_dbgstr_a( const char *s )
 409 {
 410     return __wine_dbgstr_an( s, -1 );
 411 }
 412
 413 const char *wine_dbgstr_w( const WCHAR *s )
 414 {
 415     return __wine_dbgstr_wn( s, -1 );
 416 }