p_debug.c File Reference

Include dependency graph for p_debug.c:

Go to the source code of this file.

Functions
void	_debug_vprintf (const char *format, va_list ap)
void	_debug_break (void)
static const char *	_debug_get_option (const char *name)
const char *	debug_get_option (const char *name, const char *dfault)
	Get option.
boolean	debug_get_bool_option (const char *name, boolean dfault)
long	debug_get_num_option (const char *name, long dfault)
unsigned long	debug_get_flags_option (const char *name, const struct debug_named_value *flags, unsigned long dfault)
void	_debug_assert_fail (const char *expr, const char *file, unsigned line, const char *function)
const char *	debug_dump_enum (const struct debug_named_value *names, unsigned long value)
	Convert a enum value to a string.
const char *	debug_dump_flags (const struct debug_named_value *names, unsigned long value)
	Convert binary flags value to a string.
const char *	pf_name (enum pipe_format format)
	Builds pipe format name from format token.
Variables
static struct debug_named_value	pipe_format_names []

---

Function Documentation

void _debug_assert_fail	(	const char *	expr,
		const char *	file,
		unsigned	line,
		const char *	function
	)

Definition at line 337 of file p_debug.c.

References _debug_printf(), debug_break, debug_get_bool_option(), FALSE, and TRUE.

{
   _debug_printf("%s:%u:%s: Assertion `%s' failed.\n", file, line, function, expr);
#if defined(PIPE_OS_WINDOWS) && !defined(PIPE_SUBSYSTEM_WINDOWS_USER)
   if (debug_get_bool_option("GALLIUM_ABORT_ON_ASSERT", FALSE))
#else
   if (debug_get_bool_option("GALLIUM_ABORT_ON_ASSERT", TRUE))
#endif
      debug_break();
   else
      _debug_printf("continuing...\n");
}

void _debug_break

(

void

)

Definition at line 140 of file p_debug.c.

{
#if defined(PIPE_ARCH_X86) && defined(PIPE_CC_GCC)
   __asm("int3");
#elif defined(PIPE_ARCH_X86) && defined(PIPE_CC_MSVC)
   _asm {int 3};
#elif defined(PIPE_SUBSYSTEM_WINDOWS_DISPLAY)
   EngDebugBreak();
#else
   abort();
#endif
}

static const char* _debug_get_option

(

const char *

name

)

[static]

Definition at line 192 of file p_debug.c.

{
#if defined(PIPE_SUBSYSTEM_WINDOWS_DISPLAY)
   /* EngMapFile creates the file if it does not exists, so it must either be
    * disabled on release versions (or put in a less conspicuous place). */
#ifdef DEBUG
   const char *result = NULL;
   ULONG_PTR iFile = 0;
   const void *pMap = NULL;
   const char *sol, *eol, *sep;
   static char output[1024];
   
   pMap = EngMapFile(L"\\??\\c:\\gallium.cfg", 0, &iFile);
   if(pMap) {
      sol = (const char *)pMap;
      while(1) {
         /* TODO: handle LF line endings */
         eol = find(sol, NULL, '\r');
         if(!eol || eol == sol)
            break;
         sep = find(sol, eol, '=');
         if(!sep)
            break;
         if(compare(sol, sep, name)) {
            copy(output, sep + 1, eol, sizeof(output));
            result = output;
            break;
         }
         sol = eol + 2;
      }
      EngUnmapFile(iFile);
   }
   return result;
#else
   return NULL;
#endif
#elif defined(PIPE_SUBSYSTEM_WINDOWS_CE) || defined(PIPE_SUBSYSTEM_WINDOWS_MINIPORT) 
   /* TODO: implement */
   return NULL;
#else
   return getenv(name);
#endif
}

void _debug_vprintf	(	const char *	format,
		va_list	ap
	)

Definition at line 79 of file p_debug.c.

References util_strchr, and util_vsnprintf.

{
#if defined(PIPE_SUBSYSTEM_WINDOWS_DISPLAY)
   /* EngDebugPrint does not handle float point arguments, so we need to use
    * our own vsnprintf implementation. It is also very slow, so buffer until
    * we find a newline. */
   static char buf[512] = {'\0'};
   size_t len = strlen(buf);
   int ret = util_vsnprintf(buf + len, sizeof(buf) - len, format, ap);
   if(ret > (int)(sizeof(buf) - len - 1) || util_strchr(buf + len, '\n')) {
      _EngDebugPrint("%s", buf);
      buf[0] = '\0';
   }
#elif defined(PIPE_SUBSYSTEM_WINDOWS_USER)
   /* EngDebugPrint does not handle float point arguments, so we need to use
    * our own vsnprintf implementation. It is also very slow, so buffer until
    * we find a newline. */
   static char buf[512 + 1] = {'\0'};
   size_t len = strlen(buf);
   int ret = util_vsnprintf(buf + len, sizeof(buf) - len, format, ap);
   if(ret > (int)(sizeof(buf) - len - 1) || util_strchr(buf + len, '\n')) {
      OutputDebugStringA(buf);
      buf[0] = '\0';
   }

   
   if(GetConsoleWindow() && !IsDebuggerPresent()) {
      fflush(stdout);
      vfprintf(stderr, format, ap);
      fflush(stderr);
   }
   

#elif defined(PIPE_SUBSYSTEM_WINDOWS_CE) || defined(PIPE_SUBSYSTEM_WINDOWS_MINIPORT) 
   /* TODO */
#else /* !PIPE_SUBSYSTEM_WINDOWS */
#ifdef DEBUG
   vfprintf(stderr, format, ap);
#endif
#endif
}

const char* debug_dump_enum	(	const struct debug_named_value *	names,
		unsigned long	value
	)

Convert a enum value to a string.

Definition at line 355 of file p_debug.c.

References debug_named_value::name, util_snprintf, and debug_named_value::value.

{
   static char rest[64];
   
   while(names->name) {
      if(names->value == value)
         return names->name;
      ++names;
   }

   util_snprintf(rest, sizeof(rest), "0x%08lx", value);
   return rest;
}

const char* debug_dump_flags	(	const struct debug_named_value *	names,
		unsigned long	value
	)

Convert binary flags value to a string.

Definition at line 372 of file p_debug.c.

References debug_named_value::name, util_snprintf, util_strncat, and debug_named_value::value.

{
   static char output[4096];
   static char rest[256];
   int first = 1;

   output[0] = '\0';

   while(names->name) {
      if((names->value & value) == names->value) {
         if (!first)
            util_strncat(output, "|", sizeof(output));
         else
            first = 0;
         util_strncat(output, names->name, sizeof(output));
         value &= ~names->value;
      }
      ++names;
   }
   
   if (value) {
      if (!first)
         util_strncat(output, "|", sizeof(output));
      else
         first = 0;
      
      util_snprintf(rest, sizeof(rest), "0x%08lx", value);
      util_strncat(output, rest, sizeof(output));
   }
   
   if(first)
      return "0";
   
   return output;
}

boolean debug_get_bool_option	(	const char *	name,
		boolean	dfault
	)

Definition at line 251 of file p_debug.c.

References _debug_get_option(), debug_printf(), FALSE, TRUE, and util_strcmp.

{
   const char *str = _debug_get_option(name);
   boolean result;
   
   if(str == NULL)
      result = dfault;
   else if(!util_strcmp(str, "n"))
      result = FALSE;
   else if(!util_strcmp(str, "no"))
      result = FALSE;
   else if(!util_strcmp(str, "0"))
      result = FALSE;
   else if(!util_strcmp(str, "f"))
      result = FALSE;
   else if(!util_strcmp(str, "false"))
      result = FALSE;
   else
      result = TRUE;

   debug_printf("%s: %s = %s\n", __FUNCTION__, name, result ? "TRUE" : "FALSE");
   
   return result;
}

unsigned long debug_get_flags_option	(	const char *	name,
		const struct debug_named_value *	flags,
		unsigned long	dfault
	)

Definition at line 312 of file p_debug.c.

References _debug_get_option(), debug_printf(), debug_named_value::name, util_strcmp, util_strstr, and debug_named_value::value.

{
   unsigned long result;
   const char *str;
   
   str = _debug_get_option(name);
   if(!str)
      result = dfault;
   else {
      result = 0;
      while( flags->name ) {
         if (!util_strcmp(str, "all") || util_strstr(str, flags->name ))
            result |= flags->value;
         ++flags;
      }
   }

   debug_printf("%s: %s = 0x%lx\n", __FUNCTION__, name, result);

   return result;
}

long debug_get_num_option	(	const char *	name,
		long	dfault
	)

Definition at line 278 of file p_debug.c.

References _debug_get_option(), and debug_printf().

{
   long result;
   const char *str;
   
   str = _debug_get_option(name);
   if(!str)
      result = dfault;
   else {
      long sign;
      char c;
      c = *str++;
      if(c == '-') {
         sign = -1;
         c = *str++;
      } 
      else {
         sign = 1;
      }
      result = 0;
      while('0' <= c && c <= '9') {
         result = result*10 + (c - '0');
         c = *str++;
      }
      result *= sign;
   }
   
   debug_printf("%s: %s = %li\n", __FUNCTION__, name, result);

   return result;
}

const char* debug_get_option	(	const char *	name,
		const char *	dfault
	)

Get option.

It is an alias for getenv on Linux.

On Windows it reads C:.cfg, which is a text file with CR+LF line endings with one option per line as

NAME=value

This file must be terminated with an extra empty line.

Definition at line 237 of file p_debug.c.

References _debug_get_option(), and debug_printf().

{
   const char *result;

   result = _debug_get_option(name);
   if(!result)
      result = dfault;
      
   debug_printf("%s: %s = %s\n", __FUNCTION__, name, result ? result : "(null)");
   
   return result;
}

const char* pf_name

(

enum pipe_format

format

)

Builds pipe format name from format token.

Definition at line 521 of file p_debug.c.

References debug_dump_enum().

{
   return debug_dump_enum(pipe_format_names, format);
}

---

Variable Documentation

struct debug_named_value pipe_format_names[] [static]

Definition at line 410 of file p_debug.c.

---