#include "imports.h"
#include "context.h"
#include "dispatch.h"
+#include "hash.h"
#include "mtypes.h"
#include "version.h"
#define MAXSTRING MAX_DEBUG_MESSAGE_LENGTH
+struct gl_client_severity
+{
+ struct simple_node link;
+ GLuint ID;
+};
+
static char out_of_memory[] = "Debugging error: out of memory";
#define enum_is(e, kind1, kind2) \
#define source_is(s, kind) enum_is(s, SOURCE, kind)
#define type_is(t, kind) enum_is(t, TYPE, kind)
+/* Prevent define collision on Windows */
+#undef ERROR
+
enum {
SOURCE_APPLICATION,
SOURCE_THIRD_PARTY,
};
}
+
+/*
+ * We store a bitfield in the hash table, with five possible values total.
+ *
+ * The ENABLED_BIT's purpose is self-explanatory.
+ *
+ * The FOUND_BIT is needed to differentiate the value of DISABLED from
+ * the value returned by HashTableLookup() when it can't find the given key.
+ *
+ * The KNOWN_SEVERITY bit is a bit complicated:
+ *
+ * A client may call Control() with an array of IDs, then call Control()
+ * on all message IDs of a certain severity, then Insert() one of the
+ * previously specified IDs, giving us a known severity level, then call
+ * Control() on all message IDs of a certain severity level again.
+ *
+ * After the first call, those IDs will have a FOUND_BIT, but will not
+ * exist in any severity-specific list, so the second call will not
+ * impact them. This is undesirable but unavoidable given the API:
+ * The only entrypoint that gives a severity for a client-defined ID
+ * is the Insert() call.
+ *
+ * For the sake of Control(), we want to maintain the invariant
+ * that an ID will either appear in none of the three severity lists,
+ * or appear once, to minimize pointless duplication and potential surprises.
+ *
+ * Because Insert() is the only place that will learn an ID's severity,
+ * it should insert an ID into the appropriate list, but only if the ID
+ * doesn't exist in it or any other list yet. Because searching all three
+ * lists at O(n) is needlessly expensive, we store KNOWN_SEVERITY.
+ */
+enum {
+ FOUND_BIT = 1 << 0,
+ ENABLED_BIT = 1 << 1,
+ KNOWN_SEVERITY = 1 << 2,
+
+ /* HashTable reserves zero as a return value meaning 'not found' */
+ NOT_FOUND = 0,
+ DISABLED = FOUND_BIT,
+ ENABLED = ENABLED_BIT | FOUND_BIT
+};
+
+/**
+ * Returns the state of the given message ID in a client-controlled
+ * namespace.
+ * 'source', 'type', and 'severity' are array indices like TYPE_ERROR,
+ * not GL enums.
+ */
+static GLboolean
+get_message_state(struct gl_context *ctx, int source, int type,
+ GLuint id, int severity)
+{
+ struct gl_client_namespace *nspace =
+ &ctx->Debug.ClientIDs.Namespaces[source][type];
+ uintptr_t state;
+
+ /* In addition to not being able to store zero as a value, HashTable also
+ can't use zero as a key. */
+ if (id)
+ state = (uintptr_t)_mesa_HashLookup(nspace->IDs, id);
+ else
+ state = nspace->ZeroID;
+
+ /* Only do this once for each ID. This makes sure the ID exists in,
+ at most, one list, and does not pointlessly appear multiple times. */
+ if (!(state & KNOWN_SEVERITY)) {
+ struct gl_client_severity *entry;
+
+ if (state == NOT_FOUND) {
+ if (ctx->Debug.ClientIDs.Defaults[severity][source][type])
+ state = ENABLED;
+ else
+ state = DISABLED;
+ }
+
+ entry = malloc(sizeof *entry);
+ if (!entry)
+ goto out;
+
+ state |= KNOWN_SEVERITY;
+
+ if (id)
+ _mesa_HashInsert(nspace->IDs, id, (void*)state);
+ else
+ nspace->ZeroID = state;
+
+ entry->ID = id;
+ insert_at_tail(&nspace->Severity[severity], &entry->link);
+ }
+
+out:
+ return !!(state & ENABLED_BIT);
+}
+
+/**
+ * Sets the state of the given message ID in a client-controlled
+ * namespace.
+ * 'source' and 'type' are array indices like TYPE_ERROR, not GL enums.
+ */
+static void
+set_message_state(struct gl_context *ctx, int source, int type,
+ GLuint id, GLboolean enabled)
+{
+ struct gl_client_namespace *nspace =
+ &ctx->Debug.ClientIDs.Namespaces[source][type];
+ uintptr_t state;
+
+ /* In addition to not being able to store zero as a value, HashTable also
+ can't use zero as a key. */
+ if (id)
+ state = (uintptr_t)_mesa_HashLookup(nspace->IDs, id);
+ else
+ state = nspace->ZeroID;
+
+ if (state == NOT_FOUND)
+ state = enabled ? ENABLED : DISABLED;
+ else {
+ if (enabled)
+ state |= ENABLED_BIT;
+ else
+ state &= ~ENABLED_BIT;
+ }
+
+ if (id)
+ _mesa_HashInsert(nspace->IDs, id, (void*)state);
+ else
+ nspace->ZeroID = state;
+}
+
/**
* Whether a debugging message should be logged or not.
* For implementation-controlled namespaces, we keep an array
t = enum_to_index(type);
sev = enum_to_index(severity);
- return ctx->Debug.ClientIDs.Defaults[sev][s][t];
- /* TODO: tracking individual client IDs. */
+ return get_message_state(ctx, s, t, sev, id);
}
if (type_is(type, ERROR)) {
assert(!emptySlot->message && !emptySlot->length);
- emptySlot->message = MALLOC(len+1);
+ emptySlot->message = malloc(len+1);
if (emptySlot->message) {
(void) strncpy(emptySlot->message, buf, (size_t)len);
emptySlot->message[len] = '\0';
}
if (msg->message != (char*)out_of_memory)
- FREE(msg->message);
+ free(msg->message);
msg->message = NULL;
msg->length = 0;
}
/**
- * Debugging-message namespaces with the source APPLICATION or THIRD_PARTY
- * require special handling, since the IDs in them are controlled by clients,
- * not the OpenGL implementation.
+ * Set the state of all message IDs found in the given intersection
+ * of 'source', 'type', and 'severity'. Note that all three of these
+ * parameters are array indices, not the corresponding GL enums.
*
- * When controlling entire categories of messages without specifying IDs,
- * the default state for IDs that haven't been seen yet have to be adjusted.
+ * This requires both setting the state of all previously seen message
+ * IDs in the hash table, and setting the default state for all
+ * applicable combinations of source/type/severity, so that all the
+ * yet-unknown message IDs that may be used in the future will be
+ * impacted as if they were already known.
*/
static void
-control_app_messages(struct gl_context *ctx, GLenum esource, GLenum etype,
- GLenum eseverity, GLsizei count, const GLuint *ids,
- GLboolean enabled)
+control_app_messages_by_group(struct gl_context *ctx, int source, int type,
+ int severity, GLboolean enabled)
{
- int source, type, severity, s, t, sev, smax, tmax, sevmax;
-
- assert(!count && "glDebugMessageControlARB():"
- " controlling for client-provided IDs is not implemented");
- if (count)
- return;
-
- source = enum_to_index(esource);
- type = enum_to_index(etype);
- severity = enum_to_index(eseverity);
+ struct gl_client_debug *ClientIDs = &ctx->Debug.ClientIDs;
+ int s, t, sev, smax, tmax, sevmax;
if (source == SOURCE_ANY) {
source = 0;
for (sev = severity; sev < sevmax; sev++)
for (s = source; s < smax; s++)
- for (t = type; t < tmax; t++)
- ctx->Debug.ClientIDs.Defaults[sev][s][t] = enabled;
+ for (t = type; t < tmax; t++) {
+ struct simple_node *node;
+ struct gl_client_severity *entry;
+
+ /* change the default for IDs we've never seen before. */
+ ClientIDs->Defaults[sev][s][t] = enabled;
+
+ /* Now change the state of IDs we *have* seen... */
+ foreach(node, &ClientIDs->Namespaces[s][t].Severity[sev]) {
+ entry = (struct gl_client_severity *)node;
+ set_message_state(ctx, s, t, entry->ID, enabled);
+ }
+ }
+}
+
+/**
+ * Debugging-message namespaces with the source APPLICATION or THIRD_PARTY
+ * require special handling, since the IDs in them are controlled by clients,
+ * not the OpenGL implementation.
+ *
+ * 'count' is the length of the array 'ids'. If 'count' is nonzero, all
+ * the given IDs in the namespace defined by 'esource' and 'etype'
+ * will be affected.
+ *
+ * If 'count' is zero, this sets the state of all IDs that match
+ * the combination of 'esource', 'etype', and 'eseverity'.
+ */
+static void
+control_app_messages(struct gl_context *ctx, GLenum esource, GLenum etype,
+ GLenum eseverity, GLsizei count, const GLuint *ids,
+ GLboolean enabled)
+{
+ int source, type, severity;
+ GLsizei i;
+
+ source = enum_to_index(esource);
+ type = enum_to_index(etype);
+ severity = enum_to_index(eseverity);
+
+ if (count)
+ assert(severity == SEVERITY_ANY && type != TYPE_ANY
+ && source != SOURCE_ANY);
+
+ for (i = 0; i < count; i++)
+ set_message_state(ctx, source, type, ids[i], enabled);
+
+ if (count)
+ return;
+
+ control_app_messages_by_group(ctx, source, type, severity, enabled);
}
static void GLAPIENTRY
}
static void GLAPIENTRY
-_mesa_DebugMessageCallbackARB(GLvoid *callback, GLvoid *userParam)
+_mesa_DebugMessageCallbackARB(GLDEBUGPROCARB callback, const GLvoid *userParam)
{
GET_CURRENT_CONTEXT(ctx);
- ctx->Debug.Callback = (GLDEBUGPROCARB)callback;
- ctx->Debug.CallbackData = userParam;
+ ctx->Debug.Callback = callback;
+ ctx->Debug.CallbackData = (void *) userParam;
}
void
void
_mesa_init_errors(struct gl_context *ctx)
{
+ int s, t, sev;
+ struct gl_client_debug *ClientIDs = &ctx->Debug.ClientIDs;
+
ctx->Debug.Callback = NULL;
ctx->Debug.SyncOutput = GL_FALSE;
ctx->Debug.Log[0].length = 0;
memset(ctx->Debug.WinsysErrors, GL_TRUE, sizeof ctx->Debug.WinsysErrors);
memset(ctx->Debug.ShaderErrors, GL_TRUE, sizeof ctx->Debug.ShaderErrors);
memset(ctx->Debug.OtherErrors, GL_TRUE, sizeof ctx->Debug.OtherErrors);
- memset(ctx->Debug.ClientIDs.Defaults[SEVERITY_HIGH], GL_TRUE,
- sizeof ctx->Debug.ClientIDs.Defaults[SEVERITY_HIGH]);
- memset(ctx->Debug.ClientIDs.Defaults[SEVERITY_MEDIUM], GL_TRUE,
- sizeof ctx->Debug.ClientIDs.Defaults[SEVERITY_MEDIUM]);
- memset(ctx->Debug.ClientIDs.Defaults[SEVERITY_LOW], GL_FALSE,
- sizeof ctx->Debug.ClientIDs.Defaults[SEVERITY_LOW]);
+ memset(ClientIDs->Defaults[SEVERITY_HIGH], GL_TRUE,
+ sizeof ClientIDs->Defaults[SEVERITY_HIGH]);
+ memset(ClientIDs->Defaults[SEVERITY_MEDIUM], GL_TRUE,
+ sizeof ClientIDs->Defaults[SEVERITY_MEDIUM]);
+ memset(ClientIDs->Defaults[SEVERITY_LOW], GL_FALSE,
+ sizeof ClientIDs->Defaults[SEVERITY_LOW]);
+
+ /* Initialize state for filtering client-provided debug messages. */
+ for (s = 0; s < SOURCE_COUNT; s++)
+ for (t = 0; t < TYPE_COUNT; t++) {
+ ClientIDs->Namespaces[s][t].IDs = _mesa_NewHashTable();
+ assert(ClientIDs->Namespaces[s][t].IDs);
+
+ for (sev = 0; sev < SEVERITY_COUNT; sev++)
+ make_empty_list(&ClientIDs->Namespaces[s][t].Severity[sev]);
+ }
+}
+
+void
+_mesa_free_errors_data(struct gl_context *ctx)
+{
+ int s, t, sev;
+ struct gl_client_debug *ClientIDs = &ctx->Debug.ClientIDs;
+
+ /* Tear down state for filtering client-provided debug messages. */
+ for (s = 0; s < SOURCE_COUNT; s++)
+ for (t = 0; t < TYPE_COUNT; t++) {
+ _mesa_DeleteHashTable(ClientIDs->Namespaces[s][t].IDs);
+ for (sev = 0; sev < SEVERITY_COUNT; sev++) {
+ struct simple_node *node, *tmp;
+ struct gl_client_severity *entry;
+
+ foreach_s(node, tmp, &ClientIDs->Namespaces[s][t].Severity[sev]) {
+ entry = (struct gl_client_severity *)node;
+ free(entry);
+ }
+ }
+ }
}
/**********************************************************************/
GLboolean newline)
{
static int debug = -1;
+ static FILE *fout = NULL;
- /* Check the MESA_DEBUG environment variable if it hasn't
- * been checked yet. We only have to check it once...
+ /* Init the local 'debug' var once.
+ * Note: the _mesa_init_debug() function should have been called
+ * by now so MESA_DEBUG_FLAGS will be initialized.
*/
if (debug == -1) {
- char *env = _mesa_getenv("MESA_DEBUG");
-
- /* In a debug build, we print warning messages *unless*
- * MESA_DEBUG is 0. In a non-debug build, we don't
- * print warning messages *unless* MESA_DEBUG is
- * set *to any value*.
+ /* If MESA_LOG_FILE env var is set, log Mesa errors, warnings,
+ * etc to the named file. Otherwise, output to stderr.
*/
+ const char *logFile = _mesa_getenv("MESA_LOG_FILE");
+ if (logFile)
+ fout = fopen(logFile, "w");
+ if (!fout)
+ fout = stderr;
#ifdef DEBUG
- debug = (env != NULL && atoi(env) == 0) ? 0 : 1;
+ /* in debug builds, print messages unless MESA_DEBUG="silent" */
+ if (MESA_DEBUG_FLAGS & DEBUG_SILENT)
+ debug = 0;
+ else
+ debug = 1;
#else
- debug = (env != NULL) ? 1 : 0;
+ /* in release builds, be silent unless MESA_DEBUG is set */
+ debug = _mesa_getenv("MESA_DEBUG") != NULL;
#endif
}
/* Now only print the string if we're required to do so. */
if (debug) {
- fprintf(stderr, "%s: %s", prefixString, outputString);
+ fprintf(fout, "%s: %s", prefixString, outputString);
if (newline)
- fprintf(stderr, "\n");
+ fprintf(fout, "\n");
+ fflush(fout);
#if defined(_WIN32) && !defined(_WIN32_WCE)
/* stderr from windows applications without console is not usually
}
}
-
-/**
- * Record an OpenGL state error. These usually occur when the user
- * passes invalid parameters to a GL function.
- *
- * If debugging is enabled (either at compile-time via the DEBUG macro, or
- * run-time via the MESA_DEBUG environment variable), report the error with
- * _mesa_debug().
- *
- * \param ctx the GL context.
- * \param error the error value.
- * \param fmtString printf() style format string, followed by optional args
- */
-void
-_mesa_error( struct gl_context *ctx, GLenum error, const char *fmtString, ... )
+static GLboolean
+should_output(struct gl_context *ctx, GLenum error, const char *fmtString)
{
static GLint debug = -1;
#endif
}
- if (debug) {
- if (ctx->ErrorValue == error &&
- ctx->ErrorDebugFmtString == fmtString) {
- ctx->ErrorDebugCount++;
+ if (debug) {
+ if (ctx->ErrorValue != error ||
+ ctx->ErrorDebugFmtString != fmtString) {
+ flush_delayed_errors( ctx );
+ ctx->ErrorDebugFmtString = fmtString;
+ ctx->ErrorDebugCount = 0;
+ return GL_TRUE;
}
- else {
- char s[MAXSTRING], s2[MAXSTRING];
- va_list args;
+ ctx->ErrorDebugCount++;
+ }
+ return GL_FALSE;
+}
- flush_delayed_errors( ctx );
-
- va_start(args, fmtString);
- _mesa_vsnprintf(s, MAXSTRING, fmtString, args);
- va_end(args);
- _mesa_snprintf(s2, MAXSTRING, "%s in %s", error_string(error), s);
+/**
+ * Record an OpenGL state error. These usually occur when the user
+ * passes invalid parameters to a GL function.
+ *
+ * If debugging is enabled (either at compile-time via the DEBUG macro, or
+ * run-time via the MESA_DEBUG environment variable), report the error with
+ * _mesa_debug().
+ *
+ * \param ctx the GL context.
+ * \param error the error value.
+ * \param fmtString printf() style format string, followed by optional args
+ */
+void
+_mesa_error( struct gl_context *ctx, GLenum error, const char *fmtString, ... )
+{
+ GLboolean do_output, do_log;
+
+ do_output = should_output(ctx, error, fmtString);
+ do_log = should_log(ctx, GL_DEBUG_SOURCE_API_ARB, GL_DEBUG_TYPE_ERROR_ARB,
+ API_ERROR_UNKNOWN, GL_DEBUG_SEVERITY_HIGH_ARB);
+
+ if (do_output || do_log) {
+ char s[MAXSTRING], s2[MAXSTRING];
+ int len;
+ va_list args;
+
+ va_start(args, fmtString);
+ len = _mesa_vsnprintf(s, MAXSTRING, fmtString, args);
+ va_end(args);
+
+ if (len >= MAXSTRING) {
+ /* Too long error message. Whoever calls _mesa_error should use
+ * shorter strings. */
+ ASSERT(0);
+ return;
+ }
+
+ len = _mesa_snprintf(s2, MAXSTRING, "%s in %s", error_string(error), s);
+ if (len >= MAXSTRING) {
+ /* Same as above. */
+ ASSERT(0);
+ return;
+ }
+
+ /* Print the error to stderr if needed. */
+ if (do_output) {
output_if_debug("Mesa: User error", s2, GL_TRUE);
-
- ctx->ErrorDebugFmtString = fmtString;
- ctx->ErrorDebugCount = 0;
+ }
+
+ /* Log the error via ARB_debug_output if needed.*/
+ if (do_log) {
+ _mesa_log_msg(ctx, GL_DEBUG_SOURCE_API_ARB, GL_DEBUG_TYPE_ERROR_ARB,
+ API_ERROR_UNKNOWN, GL_DEBUG_SEVERITY_HIGH_ARB, len, s2);
}
}
+ /* Set the GL context error state for glGetError. */
_mesa_record_error(ctx, error);
}
(void) fmtString;
}
+
+/**
+ * Report debug information from the shader compiler via GL_ARB_debug_output.
+ *
+ * \param ctx GL context.
+ * \param type The namespace to which this message belongs.
+ * \param id The message ID within the given namespace.
+ * \param msg The message to output. Need not be null-terminated.
+ * \param len The length of 'msg'. If negative, 'msg' must be null-terminated.
+ */
+void
+_mesa_shader_debug( struct gl_context *ctx, GLenum type, GLuint id,
+ const char *msg, int len )
+{
+ GLenum source = GL_DEBUG_SOURCE_SHADER_COMPILER_ARB,
+ severity;
+
+ switch (type) {
+ case GL_DEBUG_TYPE_ERROR_ARB:
+ assert(id < SHADER_ERROR_COUNT);
+ severity = GL_DEBUG_SEVERITY_HIGH_ARB;
+ break;
+ case GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR_ARB:
+ case GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR_ARB:
+ case GL_DEBUG_TYPE_PORTABILITY_ARB:
+ case GL_DEBUG_TYPE_PERFORMANCE_ARB:
+ case GL_DEBUG_TYPE_OTHER_ARB:
+ assert(0 && "other categories not implemented yet");
+ default:
+ _mesa_problem(ctx, "bad enum in _mesa_shader_debug()");
+ return;
+ }
+
+ if (len < 0)
+ len = strlen(msg);
+
+ /* Truncate the message if necessary. */
+ if (len >= MAX_DEBUG_MESSAGE_LENGTH)
+ len = MAX_DEBUG_MESSAGE_LENGTH - 1;
+
+ _mesa_log_msg(ctx, source, type, id, severity, len, msg);
+}
+
/*@}*/
projects / mesa.git / blobdiff