debug.c File Reference

#include "vkd3d_common.h"
#include <ctype.h>
#include <errno.h>
#include <inttypes.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <string.h>
#include <unistd.h>
#include "vkd3d_memory.h"

Include dependency graph for debug.c:

Go to the source code of this file.

Macros
#define	VKD3D_DEBUG_BUFFER_COUNT   64
#define	VKD3D_DEBUG_BUFFER_SIZE   512

Functions
enum vkd3d_dbg_level	vkd3d_dbg_get_level (void)
static void	vkd3d_dbg_voutput (const char *fmt, va_list args)
static void	vkd3d_dbg_output (const char *fmt,...)
void	vkd3d_dbg_printf (enum vkd3d_dbg_level level, const char *function, const char *fmt,...)
void	vkd3d_dbg_set_log_callback (PFN_vkd3d_log callback)
static char *	get_buffer (void)
const char *	vkd3d_dbg_vsprintf (const char *fmt, va_list args)
const char *	vkd3d_dbg_sprintf (const char *fmt,...)
static int	get_escape_char (int c)
const char *	debugstr_an (const char *str, size_t n)
const char *	debugstr_a (const char *str)
static const char *	debugstr_w16 (const uint16_t *wstr)
static const char *	debugstr_w32 (const uint32_t *wstr)
const char *	debugstr_w (const WCHAR *wstr, size_t wchar_size)
unsigned int	vkd3d_env_var_as_uint (const char *name, unsigned int default_value)
static bool	is_option_separator (char c)
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)

Variables
const char *const	vkd3d_dbg_env_name
static const char *const	debug_level_names []
static PFN_vkd3d_log	log_callback

Macro Definition Documentation

VKD3D_DEBUG_BUFFER_COUNT

#define VKD3D_DEBUG_BUFFER_COUNT   64

Definition at line 40 of file debug.c.

VKD3D_DEBUG_BUFFER_SIZE

#define VKD3D_DEBUG_BUFFER_SIZE   512

Definition at line 41 of file debug.c.

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_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);
}

debugstr_w16()

static const char * debugstr_w16 ( const uint16_t *  wstr )

static

Definition at line 227 of file debug.c.

{
    char *buffer, *ptr;
    uint16_t c;
 
    if (!wstr)
        return "(null)";
 
    ptr = buffer = get_buffer();
 
    *ptr++ = '"';
    while ((c = *wstr++) && ptr <= buffer + VKD3D_DEBUG_BUFFER_SIZE - 10)
    {
        int escape_char = get_escape_char(c);
 
        if (escape_char)
        {
            *ptr++ = '\\';
            *ptr++ = escape_char;
            continue;
        }
 
        if (isprint(c))
        {
            *ptr++ = c;
        }
        else
        {
            *ptr++ = '\\';
            sprintf(ptr, "%04x", c);
            ptr += 4;
        }
    }
    *ptr++ = '"';
 
    if (c)
    {
        *ptr++ = '.';
        *ptr++ = '.';
        *ptr++ = '.';
    }
    *ptr = '\0';
 
    return buffer;
}

Referenced by debugstr_w().

debugstr_w32()

static const char * debugstr_w32 ( const uint32_t *  wstr )

static

Definition at line 273 of file debug.c.

{
    char *buffer, *ptr;
    uint32_t c;
 
    if (!wstr)
        return "(null)";
 
    ptr = buffer = get_buffer();
 
    *ptr++ = '"';
    while ((c = *wstr++) && ptr <= buffer + VKD3D_DEBUG_BUFFER_SIZE - 10)
    {
        int escape_char = get_escape_char(c);
 
        if (escape_char)
        {
            *ptr++ = '\\';
            *ptr++ = escape_char;
            continue;
        }
 
        if (isprint(c))
        {
            *ptr++ = c;
        }
        else
        {
            *ptr++ = '\\';
            sprintf(ptr, "%04x", c);
            ptr += 4;
        }
    }
    *ptr++ = '"';
 
    if (c)
    {
        *ptr++ = '.';
        *ptr++ = '.';
        *ptr++ = '.';
    }
    *ptr = '\0';
 
    return buffer;
}

Referenced by debugstr_w().

get_buffer()

static char * get_buffer ( void  )

static

Definition at line 124 of file debug.c.

{
    static char buffers[VKD3D_DEBUG_BUFFER_COUNT][VKD3D_DEBUG_BUFFER_SIZE];
    static unsigned int buffer_index;
    unsigned int current_index;
 
    current_index = vkd3d_atomic_increment_u32(&buffer_index) % ARRAY_SIZE(buffers);
    return buffers[current_index];
}

Referenced by debugstr_an(), debugstr_w16(), debugstr_w32(), find_actctx_dll(), jpeg_fill_bit_buffer(), jpeg_huff_decode(), RtlDosApplyFileIsolationRedirection_Ustr(), and vkd3d_dbg_vsprintf().

get_escape_char()

static int get_escape_char ( int  c )

static

Definition at line 155 of file debug.c.

{
    switch (c)
    {
        case '"':
        case '\\':
            return c;
        case '\t':
            return 't';
        case '\n':
            return 'n';
        case '\r':
            return 'r';
        default:
            return 0;
    }
}

Referenced by debugstr_an(), debugstr_w16(), and debugstr_w32().

is_option_separator()

static bool is_option_separator ( char  c )

static

Definition at line 343 of file debug.c.

{
    return c == ',' || c == ';' || c == '\0';
}

Referenced by vkd3d_debug_list_has_member().

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_output()

static void vkd3d_dbg_output ( const char *  fmt,   ...  )

static

Definition at line 91 of file debug.c.

{
    va_list args;
 
    va_start(args, fmt);
    vkd3d_dbg_voutput(fmt, args);
    va_end(args);
}

Referenced by vkd3d_dbg_printf().

vkd3d_dbg_printf()

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

Definition at line 100 of file debug.c.

{
    va_list args;
 
    if (vkd3d_dbg_get_level() < level)
        return;
 
#ifdef _WIN32
    vkd3d_dbg_output("vkd3d:%04lx:%s:%s ", GetCurrentThreadId(), debug_level_names[level], function);
#elif HAVE_GETTID
    vkd3d_dbg_output("vkd3d:%u:%s:%s ", gettid(), debug_level_names[level], function);
#else
    vkd3d_dbg_output("vkd3d:%s:%s ", debug_level_names[level], function);
#endif
    va_start(args, fmt);
    vkd3d_dbg_voutput(fmt, args);
    va_end(args);
}

vkd3d_dbg_set_log_callback()

void vkd3d_dbg_set_log_callback

(

PFN_vkd3d_log

callback

)

Definition at line 119 of file debug.c.

{
    log_callback = callback;
}

Referenced by vkd3d_set_log_callback(), and vkd3d_shader_set_log_callback().

vkd3d_dbg_sprintf()

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

Definition at line 144 of file debug.c.

{
    const char *buffer;
    va_list args;
 
    va_start(args, fmt);
    buffer = vkd3d_dbg_vsprintf(fmt, args);
    va_end(args);
    return buffer;
}

vkd3d_dbg_voutput()

static void vkd3d_dbg_voutput ( const char *  fmt, va_list  args  )

static

Definition at line 83 of file debug.c.

{
    if (log_callback)
        log_callback(fmt, args);
    else
        vfprintf(stderr, fmt, args);
}

Referenced by vkd3d_dbg_output(), and vkd3d_dbg_printf().

vkd3d_dbg_vsprintf()

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 d3d12_command_list_mark_as_invalid(), d3d12_device_mark_as_removed(), and 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 is_extension_disabled(), and 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;
}

Referenced by vkd3d_create_vk_device().

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;
}

Referenced by vkd3d_init_config_flags(), and vkd3d_shader_init_config_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
}

Referenced by device_worker_main(), and vkd3d_fence_worker_main().

Variable Documentation

debug_level_names

const char* const debug_level_names[]

static

Initial value:

=
{
    [VKD3D_DBG_LEVEL_NONE ] =   "none",
    [VKD3D_DBG_LEVEL_MESSAGE] = "message",
    [VKD3D_DBG_LEVEL_ERR  ] =   "err",
    [VKD3D_DBG_LEVEL_FIXME] =   "fixme",
    [VKD3D_DBG_LEVEL_WARN ] =   "warn",
    [VKD3D_DBG_LEVEL_TRACE] =   "trace",
}

Definition at line 45 of file debug.c.

Referenced by vkd3d_dbg_get_level(), and vkd3d_dbg_printf().

log_callback

PFN_vkd3d_log log_callback

static

Definition at line 81 of file debug.c.

Referenced by vkd3d_dbg_set_log_callback(), and vkd3d_dbg_voutput().

vkd3d_dbg_env_name

const char* const vkd3d_dbg_env_name

extern

Referenced by vkd3d_dbg_get_level().