vkd3d_debug.h File Reference

#include "vkd3d_common.h"
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>

Include dependency graph for vkd3d_debug.h:

Go to the source code of this file.

Classes
struct	vkd3d_debug_option

Macros
#define	VKD3D_DBG_LOG(level)
#define	VKD3D_DBG_LOG_ONCE(first_time_level, level)
#define	VKD3D_DBG_PRINTF(...)    vkd3d_dbg_printf(vkd3d_dbg_level, __FUNCTION__, __VA_ARGS__); } while (0)
#define	ERR   VKD3D_DBG_LOG(ERR)
#define	FIXME_ONCE   VKD3D_DBG_LOG_ONCE(FIXME, WARN)
#define	VKD3D_DEBUG_ENV_NAME(name)   const char *const vkd3d_dbg_env_name = name
#define	TO_STR(u)   case u: return #u;

Enumerations
enum	vkd3d_dbg_level {   VKD3D_DBG_LEVEL_NONE , VKD3D_DBG_LEVEL_MESSAGE , VKD3D_DBG_LEVEL_ERR , VKD3D_DBG_LEVEL_FIXME ,   VKD3D_DBG_LEVEL_WARN , VKD3D_DBG_LEVEL_TRACE , VKD3D_DBG_LEVEL_NONE , VKD3D_DBG_LEVEL_ERR ,   VKD3D_DBG_LEVEL_FIXME , VKD3D_DBG_LEVEL_WARN , VKD3D_DBG_LEVEL_TRACE }

Functions
enum vkd3d_dbg_level	vkd3d_dbg_get_level (void)
void	vkd3d_dbg_printf (enum vkd3d_dbg_level level, const char *function, const char *fmt,...) VKD3D_PRINTF_FUNC(3
void void	vkd3d_dbg_set_log_callback (PFN_vkd3d_log callback)
const char *	vkd3d_dbg_sprintf (const char *fmt,...) VKD3D_PRINTF_FUNC(1
const char const char *	vkd3d_dbg_vsprintf (const char *fmt, va_list args)
const char *	debugstr_a (const char *str)
const char *	debugstr_an (const char *str, size_t n)
const char *	debugstr_w (const WCHAR *wstr, size_t wchar_size)
static const char *	debugstr_guid (const GUID *guid)
static const char *	debugstr_hresult (HRESULT hr)
unsigned int	vkd3d_env_var_as_uint (const char *name, unsigned int default_value)
bool	vkd3d_debug_list_has_member (const char *string, const char *member)
uint64_t	vkd3d_parse_debug_options (const char *string, const struct vkd3d_debug_option *options, unsigned int option_count)
void	vkd3d_set_thread_name (const char *name)

Macro Definition Documentation

ERR

#define ERR   VKD3D_DBG_LOG(ERR)

Definition at line 86 of file vkd3d_debug.h.

FIXME_ONCE

#define FIXME_ONCE   VKD3D_DBG_LOG_ONCE(FIXME, WARN)

Definition at line 96 of file vkd3d_debug.h.

TO_STR

#define TO_STR

(

u

)

case u: return #u;

VKD3D_DBG_LOG

#define VKD3D_DBG_LOG

(

level

)

Value:

        do { \
        const enum vkd3d_dbg_level vkd3d_dbg_level = VKD3D_DBG_LEVEL_##level; \
        VKD3D_DBG_PRINTF

Definition at line 58 of file vkd3d_debug.h.

VKD3D_DBG_LOG_ONCE

#define VKD3D_DBG_LOG_ONCE	(		first_time_level,
			level
	)

Value:

        do { \
        static bool vkd3d_dbg_next_time; \
        const enum vkd3d_dbg_level vkd3d_dbg_level = vkd3d_dbg_next_time \
        ? VKD3D_DBG_LEVEL_##level : VKD3D_DBG_LEVEL_##first_time_level; \
        vkd3d_dbg_next_time = true; \
        VKD3D_DBG_PRINTF

Definition at line 63 of file vkd3d_debug.h.

VKD3D_DBG_PRINTF

#define VKD3D_DBG_PRINTF

(

...

)

vkd3d_dbg_printf(vkd3d_dbg_level, __FUNCTION__, __VA_ARGS__); } while (0)

Definition at line 71 of file vkd3d_debug.h.

VKD3D_DEBUG_ENV_NAME

#define VKD3D_DEBUG_ENV_NAME

(

name

)

const char *const vkd3d_dbg_env_name = name

Definition at line 98 of file vkd3d_debug.h.

Enumeration Type Documentation

vkd3d_dbg_level

enum vkd3d_dbg_level

Enumerator
VKD3D_DBG_LEVEL_NONE
VKD3D_DBG_LEVEL_MESSAGE
VKD3D_DBG_LEVEL_ERR
VKD3D_DBG_LEVEL_FIXME
VKD3D_DBG_LEVEL_WARN
VKD3D_DBG_LEVEL_TRACE
VKD3D_DBG_LEVEL_NONE
VKD3D_DBG_LEVEL_ERR
VKD3D_DBG_LEVEL_FIXME
VKD3D_DBG_LEVEL_WARN
VKD3D_DBG_LEVEL_TRACE

Definition at line 38 of file vkd3d_debug.h.

{
    VKD3D_DBG_LEVEL_NONE,
    VKD3D_DBG_LEVEL_ERR,
    VKD3D_DBG_LEVEL_FIXME,
    VKD3D_DBG_LEVEL_WARN,
    VKD3D_DBG_LEVEL_TRACE,
};

Function Documentation

debugstr_a()

const char * debugstr_a

(

const char *

str

)

Definition at line 222 of file debug.c.

{
    return debugstr_an(str, SIZE_MAX);
}

debugstr_an()

const char * debugstr_an	(	const char *	str,
		size_t	n
	)

Definition at line 173 of file debug.c.

{
    char *buffer, *ptr;
    int escape_char;
    char c;
 
    if (!str)
        return "(null)";
    if (n == SIZE_MAX)
        n = strlen(str);
 
    ptr = buffer = get_buffer();
 
    *ptr++ = '"';
    while (n-- && ptr <= buffer + VKD3D_DEBUG_BUFFER_SIZE - 8)
    {
        c = *str++;
 
        if ((escape_char = get_escape_char(c)))
        {
            *ptr++ = '\\';
            *ptr++ = escape_char;
            continue;
        }
 
        if (isprint(c))
        {
            *ptr++ = c;
        }
        else
        {
            *ptr++ = '\\';
            sprintf(ptr, "%02x", c);
            ptr += 2;
        }
    }
    *ptr++ = '"';
 
    if (++n)
    {
        *ptr++ = '.';
        *ptr++ = '.';
        *ptr++ = '.';
    }
    *ptr = '\0';
 
    return buffer;
}

Referenced by debugstr_a().

debugstr_guid()

static const char * debugstr_guid ( const GUID *  guid )

inlinestatic

Definition at line 100 of file vkd3d_debug.h.

{
    if (!guid)
        return "(null)";
 
    return vkd3d_dbg_sprintf("{%08lx-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
            (unsigned long)guid->Data1, guid->Data2, guid->Data3, guid->Data4[0],
            guid->Data4[1], guid->Data4[2], guid->Data4[3], guid->Data4[4],
            guid->Data4[5], guid->Data4[6], guid->Data4[7]);
}

debugstr_hresult()

static const char * debugstr_hresult ( HRESULT  hr )

inlinestatic

Definition at line 111 of file vkd3d_debug.h.

{
    switch (hr)
    {
#define TO_STR(u) case u: return #u;
        TO_STR(S_OK)
        TO_STR(S_FALSE)
        TO_STR(E_NOTIMPL)
        TO_STR(E_NOINTERFACE)
        TO_STR(E_POINTER)
        TO_STR(E_ABORT)
        TO_STR(E_FAIL)
        TO_STR(E_OUTOFMEMORY)
        TO_STR(E_INVALIDARG)
        TO_STR(DXGI_ERROR_NOT_FOUND)
        TO_STR(DXGI_ERROR_MORE_DATA)
        TO_STR(DXGI_ERROR_UNSUPPORTED)
#undef TO_STR
        default:
            return vkd3d_dbg_sprintf("%#x", (int)hr);
    }
}

debugstr_w()

const char * debugstr_w	(	const WCHAR *	wstr,
		size_t	wchar_size
	)

Definition at line 319 of file debug.c.

{
    if (wchar_size == 2)
        return debugstr_w16((const uint16_t *)wstr);
    return debugstr_w32((const uint32_t *)wstr);
}

vkd3d_dbg_get_level()

enum vkd3d_dbg_level vkd3d_dbg_get_level

(

void

)

Definition at line 55 of file debug.c.

{
    static unsigned int level = ~0u;
    const char *vkd3d_debug;
    unsigned int i;
 
    if (level != ~0u)
        return level;
 
    if (!(vkd3d_debug = getenv(vkd3d_dbg_env_name)))
        vkd3d_debug = "";
 
    for (i = 0; i < ARRAY_SIZE(debug_level_names); ++i)
    {
        if (!strcmp(debug_level_names[i], vkd3d_debug))
        {
            level = i;
            return level;
        }
    }
 
    /* Default debug level. */
    level = VKD3D_DBG_LEVEL_FIXME;
    return level;
}

Referenced by vkd3d_dbg_printf().

vkd3d_dbg_printf()

void vkd3d_dbg_printf	(	enum vkd3d_dbg_level	level,
		const char *	function,
		const char *	fmt,
			...
	)

vkd3d_dbg_set_log_callback()

void void vkd3d_dbg_set_log_callback

(

PFN_vkd3d_log

callback

)

Definition at line 119 of file debug.c.

{
    log_callback = callback;
}

vkd3d_dbg_sprintf()

const char * vkd3d_dbg_sprintf	(	const char *	fmt,
			...
	)

Referenced by debugstr_guid(), and debugstr_hresult().

vkd3d_dbg_vsprintf()

const char const char * vkd3d_dbg_vsprintf	(	const char *	fmt,
		va_list	args
	)

Definition at line 134 of file debug.c.

{
    char *buffer;
 
    buffer = get_buffer();
    vsnprintf(buffer, VKD3D_DEBUG_BUFFER_SIZE, fmt, args);
    buffer[VKD3D_DEBUG_BUFFER_SIZE - 1] = '\0';
    return buffer;
}

Referenced by vkd3d_dbg_sprintf().

vkd3d_debug_list_has_member()

bool vkd3d_debug_list_has_member	(	const char *	string,
		const char *	member
	)

Definition at line 348 of file debug.c.

{
    char prev_char, next_char;
    const char *p;
 
    p = string;
    while (p)
    {
        if ((p = strstr(p, member)))
        {
            prev_char = p > string ? p[-1] : 0;
            p += strlen(member);
            next_char = *p;
 
            if (is_option_separator(prev_char) && is_option_separator(next_char))
                return true;
        }
    }
 
    return false;
}

Referenced by vkd3d_parse_debug_options().

vkd3d_env_var_as_uint()

unsigned int vkd3d_env_var_as_uint	(	const char *	name,
		unsigned int	default_value
	)

Definition at line 326 of file debug.c.

{
    const char *value = getenv(name);
    unsigned long r;
    char *end_ptr;
 
    if (value)
    {
        errno = 0;
        r = strtoul(value, &end_ptr, 0);
        if (!errno && end_ptr != value)
            return min(r, UINT_MAX);
    }
 
    return default_value;
}

vkd3d_parse_debug_options()

uint64_t vkd3d_parse_debug_options	(	const char *	string,
		const struct vkd3d_debug_option *	options,
		unsigned int	option_count
	)

Definition at line 370 of file debug.c.

{
    uint64_t flags = 0;
    unsigned int i;
 
    for (i = 0; i < option_count; ++i)
    {
        const struct vkd3d_debug_option *opt = &options[i];
 
        if (vkd3d_debug_list_has_member(string, opt->name))
            flags |= opt->flag;
    }
 
    return flags;
}

vkd3d_set_thread_name()

void vkd3d_set_thread_name

(

const char *

name

)

Definition at line 405 of file debug.c.

{
#ifdef _WIN32
    static INIT_ONCE init_once = INIT_ONCE_STATIC_INIT;
    WCHAR *wname;
    int ret;
 
    InitOnceExecuteOnce(&init_once, resolve_SetThreadDescription, NULL, NULL);
    if (!pfn_SetThreadDescription)
        return;
 
    if ((ret = MultiByteToWideChar(CP_UTF8, 0, name, -1, NULL, 0)) <= 0)
        return;
 
    if (!(wname = vkd3d_malloc(ret * sizeof(*wname))))
        return;
 
    if ((ret = MultiByteToWideChar(CP_UTF8, 0, name, -1, wname, ret)) > 0)
        pfn_SetThreadDescription(GetCurrentThread(), wname);
 
    vkd3d_free(wname);
#elif defined(HAVE_PTHREAD_SETNAME_NP_2)
    pthread_setname_np(pthread_self(), name);
#elif defined(HAVE_PTHREAD_SETNAME_NP_1)
    pthread_setname_np(name);
#endif
}