debug.c File Reference

#include "wine/config.h"
#include "wine/port.h"
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <string.h>
#include <ctype.h>
#include <excpt.h>
#include "wine/debug.h"
#include "wine/library.h"
#include <rtlfuncs.h>
#include <cmfuncs.h>

Include dependency graph for debug.c:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	WIN32_NO_STATUS
#define	MAX_DEBUG_OPTIONS   256

Functions
	WINE_DECLARE_DEBUG_CHANNEL (pid)
	WINE_DECLARE_DEBUG_CHANNEL (tid)
ULONG NTAPI	vDbgPrintExWithPrefix (IN LPCSTR Prefix, IN ULONG ComponentId, IN ULONG Level, IN LPCSTR Format, IN va_list ap)
static void	debug_init (void)
static int	winefmt_default_dbg_vlog (enum __wine_debug_class cls, struct __wine_debug_channel *channel, const char *file, const char *func, const int line, const char *format, va_list args)
static int	rosfmt_default_dbg_vlog (enum __wine_debug_class cls, struct __wine_debug_channel *channel, const char *file, const char *func, const int line, const char *format, va_list args)
static int	extfmt_default_dbg_vlog (enum __wine_debug_class cls, struct __wine_debug_channel *channel, const char *file, const char *func, const int line, const char *format, va_list args)
static int __cdecl	cmp_name (const void *p1, const void *p2)
unsigned char	__wine_dbg_get_channel_flags (struct __wine_debug_channel *channel)
int	__wine_dbg_set_channel_flags (struct __wine_debug_channel *channel, unsigned char set, unsigned char clear)
static void	add_option (const char *name, unsigned char set, unsigned char clear)
static void	parse_options (const char *str)
int	wine_dbg_printf (const char *format,...)
const char *	wine_dbg_sprintf (const char *format,...)
int	wine_dbg_log (enum __wine_debug_class cls, struct __wine_debug_channel *channel, const char *func, const char *format,...)
int	ros_dbg_log (enum __wine_debug_class cls, struct __wine_debug_channel *channel, const char *file, const char *func, const int line, const char *format,...)
static char *	get_temp_buffer (size_t size)
static void	release_temp_buffer (char *buffer, size_t size)
static const char *	default_dbgstr_an (const char *str, int n)
static const char *	default_dbgstr_wn (const WCHAR *str, int n)
static int	default_dbg_vprintf (const char *format, va_list args)
const char *	wine_dbgstr_an (const char *s, int n)
const char *	wine_dbgstr_wn (const WCHAR *s, int n)
void	__wine_dbg_set_functions (const struct __wine_debug_functions *new_funcs, struct __wine_debug_functions *old_funcs, size_t size)

Variables
static const char *const	debug_classes [] = { "fixme", "err", "warn", "trace" }
static unsigned char	default_flags = (1 << __WINE_DBCL_ERR) | (1 << __WINE_DBCL_FIXME)
static int	nb_debug_options = -1
static struct __wine_debug_channel	debug_options [MAX_DEBUG_OPTIONS]
static struct __wine_debug_functions	funcs

Macro Definition Documentation

MAX_DEBUG_OPTIONS

#define MAX_DEBUG_OPTIONS   256

Definition at line 53 of file debug.c.

WIN32_NO_STATUS

#define WIN32_NO_STATUS

Definition at line 31 of file debug.c.

Function Documentation

__wine_dbg_get_channel_flags()

unsigned char __wine_dbg_get_channel_flags

(

struct __wine_debug_channel *

channel

)

Definition at line 83 of file debug.c.

{
    if (nb_debug_options == -1) debug_init();

    if (nb_debug_options)
    {
        struct __wine_debug_channel *opt = bsearch( channel->name, debug_options, nb_debug_options,
                                                    sizeof(debug_options[0]), cmp_name );
        if (opt) return opt->flags;
    }
    /* no option for this channel */
    if (channel->flags & (1 << __WINE_DBCL_INIT)) channel->flags = default_flags;
    return default_flags;
}

Referenced by ros_dbg_log(), and wine_dbg_log().

__wine_dbg_set_channel_flags()

int __wine_dbg_set_channel_flags	(	struct __wine_debug_channel *	channel,
		unsigned char	set,
		unsigned char	clear
	)

Definition at line 99 of file debug.c.

{
    if (nb_debug_options == -1) debug_init();

    if (nb_debug_options)
    {
        struct __wine_debug_channel *opt = bsearch( channel->name, debug_options, nb_debug_options,
                                                    sizeof(debug_options[0]), cmp_name );
        if (opt)
        {
            opt->flags = (opt->flags & ~clear) | set;
            return 1;
        }
    }
    return 0;
}

__wine_dbg_set_functions()

void __wine_dbg_set_functions	(	const struct __wine_debug_functions *	new_funcs,
		struct __wine_debug_functions *	old_funcs,
		size_t	size
	)

Definition at line 551 of file debug.c.

{
    if (old_funcs) memcpy( old_funcs, &funcs, min(sizeof(funcs),size) );
    if (new_funcs) memcpy( &funcs, new_funcs, min(sizeof(funcs),size) );
}

add_option()

static void add_option ( const char *  name, unsigned char  set, unsigned char  clear  )

static

Definition at line 118 of file debug.c.

{
    int min = 0, max = nb_debug_options - 1, pos, res;

    if (!name[0])  /* "all" option */
    {
        default_flags = (default_flags & ~clear) | set;
        return;
    }
    if (strlen(name) >= sizeof(debug_options[0].name)) return;

    while (min <= max)
    {
        pos = (min + max) / 2;
        res = strcmp( name, debug_options[pos].name );
        if (!res)
        {
            debug_options[pos].flags = (debug_options[pos].flags & ~clear) | set;
            return;
        }
        if (res < 0) max = pos - 1;
        else min = pos + 1;
    }
    if (nb_debug_options >= MAX_DEBUG_OPTIONS) return;

    pos = min;
    if (pos < nb_debug_options) memmove( &debug_options[pos + 1], &debug_options[pos],
                                         (nb_debug_options - pos) * sizeof(debug_options[0]) );
    strcpy( debug_options[pos].name, name );
    debug_options[pos].flags = (default_flags & ~clear) | set;
    nb_debug_options++;
}

Referenced by parse_options().

cmp_name()

static int __cdecl cmp_name ( const void *  p1, const void *  p2  )

static

Definition at line 75 of file debug.c.

{
    const char *name = p1;
    const struct __wine_debug_channel *chan = p2;
    return strcmp( name, chan->name );
}

Referenced by __wine_dbg_get_channel_flags(), and __wine_dbg_set_channel_flags().

debug_init()

static void debug_init ( void  )

static

Definition at line 220 of file debug.c.

{
    char *wine_debug;
    DWORD dwLength;
    /* GetEnvironmentVariableA will change LastError! */
    DWORD LastError = GetLastError();

    if (nb_debug_options != -1) return;  /* already initialized */
    nb_debug_options = 0;

    dwLength = GetEnvironmentVariableA("DEBUGCHANNEL", NULL, 0);
    if (dwLength)
    {
        wine_debug = malloc(dwLength);
        if (wine_debug)
        {
            if (GetEnvironmentVariableA("DEBUGCHANNEL", wine_debug, dwLength) < dwLength)
                parse_options(wine_debug);
            free(wine_debug);
        }
    }

    dwLength = GetEnvironmentVariableA("DEBUGFORMAT", NULL, 0);
    if (dwLength)
    {
        wine_debug = malloc(dwLength);
        if (wine_debug)
        {
            if (GetEnvironmentVariableA("DEBUGFORMAT", wine_debug, dwLength) < dwLength)
            {
                if (strcmp(wine_debug, "wine") == 0)
                {
                    funcs.dbg_vlog = winefmt_default_dbg_vlog;
                }
                else
                if (strcmp(wine_debug, "extended") == 0 ||
                    strcmp(wine_debug, "ext") == 0)
                {
                    funcs.dbg_vlog = extfmt_default_dbg_vlog;
                }
                else
                {
                    funcs.dbg_vlog = rosfmt_default_dbg_vlog;
                }
            }
            free(wine_debug);
        }
    }

    SetLastError(LastError);
}

Referenced by __wine_dbg_get_channel_flags(), and __wine_dbg_set_channel_flags().

default_dbg_vprintf()

static int default_dbg_vprintf ( const char *  format, va_list  args  )

static

Definition at line 469 of file debug.c.

{
    return vDbgPrintExWithPrefix("", -1, 0, format, args);
}

default_dbgstr_an()

static const char* default_dbgstr_an ( const char *  str, int  n  )

static

Definition at line 357 of file debug.c.

{
    static const char hex[16] = "0123456789abcdef";
    char *dst, *res;
    size_t size;

    if (!((ULONG_PTR)str >> 16))
    {
        if (!str) return "(null)";
        res = funcs.get_temp_buffer( 6 );
        sprintf( res, "#%04x", LOWORD(str) );
        return res;
    }
    if (n == -1) n = strlen(str);
    if (n < 0) n = 0;
    size = 10 + min( 300, n * 4 );
    dst = res = funcs.get_temp_buffer( size );
    *dst++ = '"';
    while (n-- > 0 && dst <= res + size - 9)
    {
        unsigned char c = *str++;
        switch (c)
        {
        case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
        case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
        case '\t': *dst++ = '\\'; *dst++ = 't'; break;
        case '"':  *dst++ = '\\'; *dst++ = '"'; break;
        case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
        default:
            if (c >= ' ' && c <= 126)
                *dst++ = c;
            else
            {
                *dst++ = '\\';
                *dst++ = 'x';
                *dst++ = hex[(c >> 4) & 0x0f];
                *dst++ = hex[c & 0x0f];
            }
        }
    }
    *dst++ = '"';
    if (n > 0)
    {
        *dst++ = '.';
        *dst++ = '.';
        *dst++ = '.';
    }
    *dst++ = 0;
    funcs.release_temp_buffer( res, dst - res );
    return res;
}

default_dbgstr_wn()

static const char* default_dbgstr_wn ( const WCHAR *  str, int  n  )

static

Definition at line 411 of file debug.c.

{
    char *dst, *res;
    size_t size;

    if (!((ULONG_PTR)str >> 16))
    {
        if (!str) return "(null)";
        res = funcs.get_temp_buffer( 6 );
        sprintf( res, "#%04x", LOWORD(str) );
        return res;
    }
    if (n == -1)
    {
        const WCHAR *end = str;
        while (*end) end++;
        n = end - str;
    }
    if (n < 0) n = 0;
    size = 12 + min( 300, n * 5 );
    dst = res = funcs.get_temp_buffer( size );
    *dst++ = 'L';
    *dst++ = '"';
    while (n-- > 0 && dst <= res + size - 10)
    {
        WCHAR c = *str++;
        switch (c)
        {
        case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
        case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
        case '\t': *dst++ = '\\'; *dst++ = 't'; break;
        case '"':  *dst++ = '\\'; *dst++ = '"'; break;
        case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
        default:
            if (c >= ' ' && c <= 126)
                *dst++ = c;
            else
            {
                *dst++ = '\\';
                sprintf(dst,"%04x",c);
                dst+=4;
            }
        }
    }
    *dst++ = '"';
    if (n > 0)
    {
        *dst++ = '.';
        *dst++ = '.';
        *dst++ = '.';
    }
    *dst++ = 0;
    funcs.release_temp_buffer( res, dst - res );
    return res;
}

extfmt_default_dbg_vlog()

static int extfmt_default_dbg_vlog ( enum __wine_debug_class  cls, struct __wine_debug_channel *  channel, const char *  file, const char *  func, const int  line, const char *  format, va_list  args  )

static

Definition at line 514 of file debug.c.

{
    int ret = 0;

    if (TRACE_ON(pid) || TRACE_ON(tid))
    {
        ret += wine_dbg_printf( "[%04x:%04x]:",
                                (TRACE_ON(pid) ? HandleToULong(NtCurrentTeb()->ClientId.UniqueProcess) : 0),
                                (TRACE_ON(tid) ? HandleToULong(NtCurrentTeb()->ClientId.UniqueThread)  : 0) );
    }

    if (cls < sizeof(debug_classes)/sizeof(debug_classes[0]))
        ret += wine_dbg_printf( "%s:", debug_classes[cls] );

    if (file && line)
        ret += wine_dbg_printf( "(%s:%d):", file, line );

    ret += wine_dbg_printf( "%s:%s ", channel->name, func );

    if (format)
        ret += funcs.dbg_vprintf( format, args );
    return ret;
}

Referenced by debug_init().

get_temp_buffer()

static char* get_temp_buffer ( size_t  size )

static

Definition at line 336 of file debug.c.

{
    static char *list[32];
    static int pos;
    char *ret;
    int idx;

    idx = interlocked_xchg_add( &pos, 1 ) % (sizeof(list)/sizeof(list[0]));
    if ((ret = realloc( list[idx], size ))) list[idx] = ret;
    return ret;
}

parse_options()

static void parse_options ( const char *  str )

static

Definition at line 152 of file debug.c.

{
    char *opt, *next, *options;
    unsigned int i;

    if (!(options = _strdup(str))) return;
    for (opt = options; opt; opt = next)
    {
        const char *p;
        unsigned char set = 0, clear = 0;

        if ((next = strchr( opt, ',' ))) *next++ = 0;

        p = opt + strcspn( opt, "+-" );
        if (!p[0]) p = opt;  /* assume it's a debug channel name */

        if (p > opt)
        {
            for (i = 0; i < sizeof(debug_classes)/sizeof(debug_classes[0]); i++)
            {
                int len = strlen(debug_classes[i]);
                if (len != (p - opt)) continue;
                if (!memcmp( opt, debug_classes[i], len ))  /* found it */
                {
                    if (*p == '+') set |= 1 << i;
                    else clear |= 1 << i;
                    break;
                }
            }
            if (i == sizeof(debug_classes)/sizeof(debug_classes[0])) /* bad class name, skip it */
                continue;
        }
        else
        {
            if (*p == '-') clear = ~0;
            else set = ~0;
        }
        if (*p == '+' || *p == '-') p++;
        if (!p[0]) continue;

        if (!strcmp( p, "all" ))
            default_flags = (default_flags & ~clear) | set;
        else
            add_option( p, set, clear );
    }
    free( options );
}

Referenced by debug_init().

release_temp_buffer()

static void release_temp_buffer ( char *  buffer, size_t  size  )

static

Definition at line 350 of file debug.c.

{
    /* don't bother doing anything */
}

ros_dbg_log()

int ros_dbg_log	(	enum __wine_debug_class	cls,
		struct __wine_debug_channel *	channel,
		const char *	file,
		const char *	func,
		const int	line,
		const char *	format,
			...
	)

Definition at line 319 of file debug.c.

{
    int ret;
    va_list valist;

    if (!(__wine_dbg_get_channel_flags( channel ) & (1 << cls))) return -1;

    va_start(valist, format);
    ret = funcs.dbg_vlog( cls, channel, file, func, line, format, valist );
    va_end(valist);
    return ret;
}

rosfmt_default_dbg_vlog()

static int rosfmt_default_dbg_vlog ( enum __wine_debug_class  cls, struct __wine_debug_channel *  channel, const char *  file, const char *  func, const int  line, const char *  format, va_list  args  )

static

Definition at line 493 of file debug.c.

{
    int ret = 0;

    if (TRACE_ON(tid))
        ret += wine_dbg_printf( "%04x:", HandleToULong(NtCurrentTeb()->ClientId.UniqueThread) );

    if (cls < sizeof(debug_classes)/sizeof(debug_classes[0]))
        ret += wine_dbg_printf( "%s:", debug_classes[cls] );

    if (file && line)
        ret += wine_dbg_printf( "(%s:%d) ", file, line );
    else
        ret += wine_dbg_printf( "%s:%s: ", channel->name, func );

    if (format)
        ret += funcs.dbg_vprintf( format, args );
    return ret;
}

Referenced by debug_init().

vDbgPrintExWithPrefix()

ULONG NTAPI vDbgPrintExWithPrefix	(	IN LPCSTR	Prefix,
		IN ULONG	ComponentId,
		IN ULONG	Level,
		IN LPCSTR	Format,
		IN va_list	ap
	)

Referenced by default_dbg_vprintf(), and EngDebugPrint().

wine_dbg_log()

int wine_dbg_log	(	enum __wine_debug_class	cls,
		struct __wine_debug_channel *	channel,
		const char *	func,
		const char *	format,
			...
	)

Definition at line 303 of file debug.c.

{
    int ret;
    va_list valist;

    if (!(__wine_dbg_get_channel_flags( channel ) & (1 << cls))) return -1;

    va_start(valist, format);
    ret = funcs.dbg_vlog( cls, channel, NULL, func, 0, format, valist );
    va_end(valist);
    return ret;
}

wine_dbg_printf()

int wine_dbg_printf	(	const char *	format,
			...
	)

Definition at line 273 of file debug.c.

{
    int ret;
    va_list valist;

    va_start(valist, format);
    ret = funcs.dbg_vprintf( format, valist );
    va_end(valist);
    return ret;
}

Referenced by extfmt_default_dbg_vlog(), rosfmt_default_dbg_vlog(), and winefmt_default_dbg_vlog().

wine_dbg_sprintf()

const char* wine_dbg_sprintf	(	const char *	format,
			...
	)

Definition at line 285 of file debug.c.

{
    static const int max_size = 200;
    char *ret;
    int len;
    va_list valist;

    va_start(valist, format);
    ret = funcs.get_temp_buffer( max_size );
    len = vsnprintf( ret, max_size, format, valist );
    if (len == -1 || len >= max_size) ret[max_size-1] = 0;
    else funcs.release_temp_buffer( ret, len + 1 );
    va_end(valist);
    return ret;
}

Referenced by wine_dbgstr_longlong().

wine_dbgstr_an()

const char* wine_dbgstr_an	(	const char *	s,
		int	n
	)

Definition at line 541 of file debug.c.

{
    return funcs.dbgstr_an(s, n);
}

Referenced by debugstr_a(), debugstr_an(), and wine_dbgstr_a().

wine_dbgstr_wn()

const char* wine_dbgstr_wn	(	const WCHAR *	s,
		int	n
	)

Definition at line 546 of file debug.c.

{
    return funcs.dbgstr_wn(s, n);
}

Referenced by debugstr_w(), debugstr_wn(), and wine_dbgstr_w().

WINE_DECLARE_DEBUG_CHANNEL() [1/2]

WINE_DECLARE_DEBUG_CHANNEL

(

pid

)

WINE_DECLARE_DEBUG_CHANNEL() [2/2]

WINE_DECLARE_DEBUG_CHANNEL

(

tid

)

winefmt_default_dbg_vlog()

static int winefmt_default_dbg_vlog ( enum __wine_debug_class  cls, struct __wine_debug_channel *  channel, const char *  file, const char *  func, const int  line, const char *  format, va_list  args  )

static

Definition at line 477 of file debug.c.

{
    int ret = 0;

    if (TRACE_ON(pid))
        ret += wine_dbg_printf( "%04x:", HandleToULong(NtCurrentTeb()->ClientId.UniqueProcess) );
    ret += wine_dbg_printf( "%04x:", HandleToULong(NtCurrentTeb()->ClientId.UniqueThread) );

    if (cls < sizeof(debug_classes)/sizeof(debug_classes[0]))
        ret += wine_dbg_printf( "%s:%s:%s ", debug_classes[cls], channel->name, func );
    if (format)
        ret += funcs.dbg_vprintf( format, args );
    return ret;
}

Referenced by debug_init().

Variable Documentation

debug_classes

const char* const debug_classes[] = { "fixme", "err", "warn", "trace" }

static

Definition at line 51 of file debug.c.

Referenced by extfmt_default_dbg_vlog(), KdbpCmdFilter(), parse_options(), rosfmt_default_dbg_vlog(), and winefmt_default_dbg_vlog().

debug_options

struct __wine_debug_channel debug_options[MAX_DEBUG_OPTIONS]

static

Definition at line 57 of file debug.c.

Referenced by __wine_dbg_get_channel_flags(), __wine_dbg_set_channel_flags(), and add_option().

default_flags

unsigned char default_flags = (1 << __WINE_DBCL_ERR) | (1 << __WINE_DBCL_FIXME)

static

Definition at line 55 of file debug.c.

Referenced by __wine_dbg_get_channel_flags(), add_option(), and parse_options().

funcs

static struct __wine_debug_functions funcs

static

Initial value:

=
{
    get_temp_buffer,
    release_temp_buffer,
    default_dbgstr_an,
    default_dbgstr_wn,
    default_dbg_vprintf,
    rosfmt_default_dbg_vlog
}

Definition at line 59 of file debug.c.

Referenced by __wine_dbg_set_functions(), add_func_info(), add_function_decl(), build_format_strings(), cff_size_done(), cff_size_init(), cff_size_request(), cff_slot_init(), cid_size_done(), cid_size_init(), cid_size_request(), cid_slot_init(), CreateProxyFromTypeInfo(), CreateStubFromTypeInfo(), debug_init(), default_dbgstr_an(), default_dbgstr_wn(), DispatchEx_GetNextDispID(), extfmt_default_dbg_vlog(), find_dc_driver(), get_iface_info(), ITypeInfoImpl_GetInternalDispatchFuncDesc(), NP_GetEntryPoints(), num_handlers(), pci_setup(), pop_dc_driver(), psh_globals_funcs_init(), push_dc_driver_ros(), report(), ros_dbg_log(), rosfmt_default_dbg_vlog(), T1_GlyphSlot_Init(), t1_hints_funcs_init(), T1_Size_Done(), T1_Size_Init(), T1_Size_Request(), t2_hints_funcs_init(), tess_callback_begin(), tess_callback_end(), tess_callback_vertex(), test_FakeDLL(), test_LoadFunctionPointers(), test_provider_funcs(), test_utils(), testCertTrust(), testInitialize(), testObjTrust(), wglUseFontBitmaps_common(), wglUseFontOutlines_common(), wine_dbg_log(), wine_dbg_printf(), wine_dbg_sprintf(), wine_dbgstr_an(), wine_dbgstr_wn(), winefmt_default_dbg_vlog(), and write_iface_fs().

nb_debug_options

int nb_debug_options = -1

static

Definition at line 56 of file debug.c.

Referenced by __wine_dbg_get_channel_flags(), __wine_dbg_set_channel_flags(), add_option(), and debug_init().