*/
+#include <stdarg.h>
+#include <stdio.h>
#include "errors.h"
#include "enums.h"
#include "imports.h"
#include "context.h"
+#include "debug_output.h"
#include "dispatch.h"
#include "hash.h"
#include "mtypes.h"
#include "version.h"
-#include "hash_table.h"
+#include "util/hash_table.h"
+#include "util/simple_list.h"
-static mtx_t DynamicIDMutex = _MTX_INITIALIZER_NP;
-static GLuint NextDynamicID = 1;
-struct gl_debug_severity
-{
- struct simple_node link;
- GLuint ID;
-};
-
-static char out_of_memory[] = "Debugging error: out of memory";
-
-static const GLenum debug_source_enums[] = {
- GL_DEBUG_SOURCE_API,
- GL_DEBUG_SOURCE_WINDOW_SYSTEM,
- GL_DEBUG_SOURCE_SHADER_COMPILER,
- GL_DEBUG_SOURCE_THIRD_PARTY,
- GL_DEBUG_SOURCE_APPLICATION,
- GL_DEBUG_SOURCE_OTHER,
-};
-
-static const GLenum debug_type_enums[] = {
- GL_DEBUG_TYPE_ERROR,
- GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR,
- GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR,
- GL_DEBUG_TYPE_PORTABILITY,
- GL_DEBUG_TYPE_PERFORMANCE,
- GL_DEBUG_TYPE_OTHER,
- GL_DEBUG_TYPE_MARKER,
- GL_DEBUG_TYPE_PUSH_GROUP,
- GL_DEBUG_TYPE_POP_GROUP,
-};
-
-static const GLenum debug_severity_enums[] = {
- GL_DEBUG_SEVERITY_LOW,
- GL_DEBUG_SEVERITY_MEDIUM,
- GL_DEBUG_SEVERITY_HIGH,
- GL_DEBUG_SEVERITY_NOTIFICATION,
-};
-
-
-static enum mesa_debug_source
-gl_enum_to_debug_source(GLenum e)
-{
- int i;
-
- for (i = 0; i < Elements(debug_source_enums); i++) {
- if (debug_source_enums[i] == e)
- break;
- }
- return i;
-}
-
-static enum mesa_debug_type
-gl_enum_to_debug_type(GLenum e)
-{
- int i;
-
- for (i = 0; i < Elements(debug_type_enums); i++) {
- if (debug_type_enums[i] == e)
- break;
- }
- return i;
-}
-
-static enum mesa_debug_severity
-gl_enum_to_debug_severity(GLenum e)
-{
- int i;
-
- for (i = 0; i < Elements(debug_severity_enums); i++) {
- if (debug_severity_enums[i] == e)
- break;
- }
- return i;
-}
-
-
-/**
- * Handles generating a GL_ARB_debug_output message ID generated by the GL or
- * GLSL compiler.
- *
- * The GL API has this "ID" mechanism, where the intention is to allow a
- * client to filter in/out messages based on source, type, and ID. Of course,
- * building a giant enum list of all debug output messages that Mesa might
- * generate is ridiculous, so instead we have our caller pass us a pointer to
- * static storage where the ID should get stored. This ID will be shared
- * across all contexts for that message (which seems like a desirable
- * property, even if it's not expected by the spec), but note that it won't be
- * the same between executions if messages aren't generated in the same order.
- */
-static void
-debug_get_id(GLuint *id)
-{
- if (!(*id)) {
- mtx_lock(&DynamicIDMutex);
- if (!(*id))
- *id = NextDynamicID++;
- mtx_unlock(&DynamicIDMutex);
- }
-}
-
-
-/*
- * 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
-};
-
-static void
-debug_message_clear(struct gl_debug_msg *msg)
-{
- if (msg->message != (char*)out_of_memory)
- free(msg->message);
- msg->message = NULL;
- msg->length = 0;
-}
-
-static void
-debug_message_store(struct gl_debug_msg *msg,
- enum mesa_debug_source source,
- enum mesa_debug_type type, GLuint id,
- enum mesa_debug_severity severity,
- GLsizei len, const char *buf)
-{
- assert(!msg->message && !msg->length);
-
- msg->message = malloc(len+1);
- if (msg->message) {
- (void) strncpy(msg->message, buf, (size_t)len);
- msg->message[len] = '\0';
-
- msg->length = len+1;
- msg->source = source;
- msg->type = type;
- msg->id = id;
- msg->severity = severity;
- } else {
- static GLuint oom_msg_id = 0;
- debug_get_id(&oom_msg_id);
-
- /* malloc failed! */
- msg->message = out_of_memory;
- msg->length = strlen(out_of_memory)+1;
- msg->source = MESA_DEBUG_SOURCE_OTHER;
- msg->type = MESA_DEBUG_TYPE_ERROR;
- msg->id = oom_msg_id;
- msg->severity = MESA_DEBUG_SEVERITY_HIGH;
- }
-}
-
-/**
- * Allocate and initialize context debug state.
- */
-static struct gl_debug_state *
-debug_create(void)
-{
- struct gl_debug_state *debug;
- int s, t, sev;
-
- debug = CALLOC_STRUCT(gl_debug_state);
- if (!debug)
- return NULL;
-
- /* Enable all the messages with severity HIGH or MEDIUM by default. */
- memset(debug->Defaults[0][MESA_DEBUG_SEVERITY_HIGH], GL_TRUE,
- sizeof debug->Defaults[0][MESA_DEBUG_SEVERITY_HIGH]);
- memset(debug->Defaults[0][MESA_DEBUG_SEVERITY_MEDIUM], GL_TRUE,
- sizeof debug->Defaults[0][MESA_DEBUG_SEVERITY_MEDIUM]);
- memset(debug->Defaults[0][MESA_DEBUG_SEVERITY_LOW], GL_FALSE,
- sizeof debug->Defaults[0][MESA_DEBUG_SEVERITY_LOW]);
-
- /* Initialize state for filtering known debug messages. */
- for (s = 0; s < MESA_DEBUG_SOURCE_COUNT; s++) {
- for (t = 0; t < MESA_DEBUG_TYPE_COUNT; t++) {
- debug->Namespaces[0][s][t].IDs = _mesa_NewHashTable();
- assert(debug->Namespaces[0][s][t].IDs);
-
- for (sev = 0; sev < MESA_DEBUG_SEVERITY_COUNT; sev++) {
- make_empty_list(&debug->Namespaces[0][s][t].Severity[sev]);
- }
- }
- }
-
- return debug;
-}
-
-static void
-debug_clear_group_cb(GLuint key, void *data, void *userData)
-{
-}
-
-/**
- * Free debug state for the given stack depth.
- */
-static void
-debug_clear_group(struct gl_debug_state *debug, GLint gstack)
-{
- enum mesa_debug_type t;
- enum mesa_debug_source s;
- enum mesa_debug_severity sev;
-
- /* Tear down state for filtering debug messages. */
- for (s = 0; s < MESA_DEBUG_SOURCE_COUNT; s++) {
- for (t = 0; t < MESA_DEBUG_TYPE_COUNT; t++) {
- struct gl_debug_namespace *nspace = &debug->Namespaces[gstack][s][t];
-
- _mesa_HashDeleteAll(nspace->IDs, debug_clear_group_cb, NULL);
- _mesa_DeleteHashTable(nspace->IDs);
- for (sev = 0; sev < MESA_DEBUG_SEVERITY_COUNT; sev++) {
- struct simple_node *node, *tmp;
- struct gl_debug_severity *entry;
-
- foreach_s(node, tmp, &nspace->Severity[sev]) {
- entry = (struct gl_debug_severity *)node;
- free(entry);
- }
- }
- }
- }
-}
-
-/**
- * Loop through debug group stack tearing down states for
- * filtering debug messages. Then free debug output state.
- */
-static void
-debug_destroy(struct gl_debug_state *debug)
-{
- GLint i;
-
- for (i = 0; i <= debug->GroupStackDepth; i++)
- debug_clear_group(debug, i);
-
- free(debug);
-}
-
-/**
- * Sets the state of the given message source/type/ID tuple.
- */
-static void
-debug_set_message_enable(struct gl_debug_state *debug,
- enum mesa_debug_source source,
- enum mesa_debug_type type,
- GLuint id, GLboolean enabled)
-{
- GLint gstack = debug->GroupStackDepth;
- struct gl_debug_namespace *nspace =
- &debug->Namespaces[gstack][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;
-}
-
-/*
- * Set the state of all message IDs found in the given intersection of
- * 'source', 'type', and 'severity'. The _COUNT enum can be used for
- * GL_DONT_CARE (include all messages in the class).
- *
- * 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
-debug_set_message_enable_all(struct gl_debug_state *debug,
- enum mesa_debug_source source,
- enum mesa_debug_type type,
- enum mesa_debug_severity severity,
- GLboolean enabled)
-{
- const GLint gstack = debug->GroupStackDepth;
- int s, t, sev, smax, tmax, sevmax;
-
- if (source == MESA_DEBUG_SOURCE_COUNT) {
- source = 0;
- smax = MESA_DEBUG_SOURCE_COUNT;
- } else {
- smax = source+1;
- }
-
- if (type == MESA_DEBUG_TYPE_COUNT) {
- type = 0;
- tmax = MESA_DEBUG_TYPE_COUNT;
- } else {
- tmax = type+1;
- }
-
- if (severity == MESA_DEBUG_SEVERITY_COUNT) {
- severity = 0;
- sevmax = MESA_DEBUG_SEVERITY_COUNT;
- } else {
- sevmax = severity+1;
- }
-
- for (sev = severity; sev < sevmax; sev++) {
- for (s = source; s < smax; s++) {
- for (t = type; t < tmax; t++) {
- struct simple_node *node;
- struct gl_debug_severity *entry;
-
- /* change the default for IDs we've never seen before. */
- debug->Defaults[gstack][sev][s][t] = enabled;
-
- /* Now change the state of IDs we *have* seen... */
- foreach(node, &debug->Namespaces[gstack][s][t].Severity[sev]) {
- entry = (struct gl_debug_severity *)node;
- debug_set_message_enable(debug, s, t, entry->ID, enabled);
- }
- }
- }
- }
-}
-
-/**
- * Returns if the given message source/type/ID tuple is enabled.
- */
-static bool
-debug_is_message_enabled(struct gl_debug_state *debug,
- enum mesa_debug_source source,
- enum mesa_debug_type type,
- GLuint id,
- enum mesa_debug_severity severity)
-{
- const GLint gstack = debug->GroupStackDepth;
- struct gl_debug_namespace *nspace =
- &debug->Namespaces[gstack][source][type];
- uintptr_t state = 0;
-
- if (!debug->DebugOutput)
- return false;
-
- /* 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_debug_severity *entry;
-
- if (state == NOT_FOUND) {
- if (debug->Defaults[gstack][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;
+static FILE *LogFile = NULL;
- entry->ID = id;
- insert_at_tail(&nspace->Severity[severity], &entry->link);
- }
-out:
- return (state & ENABLED_BIT);
-}
-
-/**
- * 'buf' is not necessarily a null-terminated string. When logging, copy
- * 'len' characters from it, store them in a new, null-terminated string,
- * and remember the number of bytes used by that string, *including*
- * the null terminator this time.
- */
-static void
-debug_log_message(struct gl_debug_state *debug,
- enum mesa_debug_source source,
- enum mesa_debug_type type, GLuint id,
- enum mesa_debug_severity severity,
- GLsizei len, const char *buf)
-{
- GLint nextEmpty;
- struct gl_debug_msg *emptySlot;
-
- assert(len >= 0 && len < MAX_DEBUG_MESSAGE_LENGTH);
-
- if (debug->NumMessages == MAX_DEBUG_LOGGED_MESSAGES)
- return;
-
- nextEmpty = (debug->NextMsg + debug->NumMessages)
- % MAX_DEBUG_LOGGED_MESSAGES;
- emptySlot = &debug->Log[nextEmpty];
-
- debug_message_store(emptySlot, source, type,
- id, severity, len, buf);
-
- if (debug->NumMessages == 0)
- debug->NextMsgLength = debug->Log[debug->NextMsg].length;
-
- debug->NumMessages++;
-}
-
-/**
- * Return the oldest debug message out of the log.
- */
-static const struct gl_debug_msg *
-debug_fetch_message(const struct gl_debug_state *debug)
-{
- return (debug->NumMessages) ? &debug->Log[debug->NextMsg] : NULL;
-}
-
-/**
- * Delete the oldest debug messages out of the log.
- */
-static void
-debug_delete_messages(struct gl_debug_state *debug, unsigned count)
-{
- if (count > debug->NumMessages)
- count = debug->NumMessages;
-
- while (count--) {
- struct gl_debug_msg *msg = &debug->Log[debug->NextMsg];
-
- assert(msg->length > 0 && msg->length == debug->NextMsgLength);
- debug_message_clear(msg);
-
- debug->NumMessages--;
- debug->NextMsg++;
- debug->NextMsg %= MAX_DEBUG_LOGGED_MESSAGES;
- debug->NextMsgLength = debug->Log[debug->NextMsg].length;
- }
-}
-
-static struct gl_debug_msg *
-debug_get_group_message(struct gl_debug_state *debug)
-{
- return &debug->DebugGroupMsgs[debug->GroupStackDepth];
-}
-
-static void
-debug_push_group(struct gl_debug_state *debug)
-{
- const GLint gstack = debug->GroupStackDepth;
- int s, t, sev;
-
- /* inherit the control volume of the debug group previously residing on
- * the top of the debug group stack
- */
- for (s = 0; s < MESA_DEBUG_SOURCE_COUNT; s++) {
- for (t = 0; t < MESA_DEBUG_TYPE_COUNT; t++) {
- const struct gl_debug_namespace *nspace =
- &debug->Namespaces[gstack][s][t];
- struct gl_debug_namespace *next =
- &debug->Namespaces[gstack + 1][s][t];
-
- /* copy id settings */
- next->IDs = _mesa_HashClone(nspace->IDs);
-
- for (sev = 0; sev < MESA_DEBUG_SEVERITY_COUNT; sev++) {
- struct simple_node *node;
-
- /* copy default settings for unknown ids */
- debug->Defaults[gstack + 1][sev][s][t] =
- debug->Defaults[gstack][sev][s][t];
-
- /* copy known id severity settings */
- make_empty_list(&next->Severity[sev]);
- foreach(node, &nspace->Severity[sev]) {
- const struct gl_debug_severity *entry =
- (const struct gl_debug_severity *) node;
- struct gl_debug_severity *copy;
-
- copy = malloc(sizeof *entry);
- if (!copy)
- goto out;
-
- copy->ID = entry->ID;
- insert_at_tail(&next->Severity[sev], ©->link);
- }
- }
- }
- }
-
-out:
- debug->GroupStackDepth++;
-}
-
-static void
-debug_pop_group(struct gl_debug_state *debug)
-{
- const GLint gstack = debug->GroupStackDepth;
-
- debug->GroupStackDepth--;
- debug_clear_group(debug, gstack);
-}
-
-
-/**
- * Return debug state for the context. The debug state will be allocated
- * and initialized upon the first call.
- */
-struct gl_debug_state *
-_mesa_get_debug_state(struct gl_context *ctx)
-{
- if (!ctx->Debug) {
- ctx->Debug = debug_create();
- if (!ctx->Debug) {
- _mesa_error(ctx, GL_OUT_OF_MEMORY, "allocating debug state");
- }
- }
-
- return ctx->Debug;
-}
-
-
-
-static GLboolean
-should_log(struct gl_context *ctx,
- enum mesa_debug_source source,
- enum mesa_debug_type type,
- GLuint id,
- enum mesa_debug_severity severity)
-{
- struct gl_debug_state *debug;
-
- if (!ctx->Debug) {
- /* no debug state set so far */
- return GL_FALSE;
- }
-
- debug = _mesa_get_debug_state(ctx);
- if (debug)
- return debug_is_message_enabled(debug, source, type, id, severity);
- else
- return GL_FALSE;
-}
-
-
-static void
-set_message_state(struct gl_context *ctx,
- enum mesa_debug_source source,
- enum mesa_debug_type type,
- GLuint id, GLboolean enabled)
-{
- struct gl_debug_state *debug = _mesa_get_debug_state(ctx);
-
- if (debug)
- debug_set_message_enable(debug, source, type, id, enabled);
-}
-
-
-
-/**
- * Log a client or driver debug message.
- */
-static void
-log_msg(struct gl_context *ctx, enum mesa_debug_source source,
- enum mesa_debug_type type, GLuint id,
- enum mesa_debug_severity severity, GLint len, const char *buf)
-{
- struct gl_debug_state *debug = _mesa_get_debug_state(ctx);
-
- if (!debug)
- return;
-
- if (!should_log(ctx, source, type, id, severity))
- return;
-
- if (debug->Callback) {
- GLenum gl_type = debug_type_enums[type];
- GLenum gl_severity = debug_severity_enums[severity];
-
- debug->Callback(debug_source_enums[source], gl_type, id, gl_severity,
- len, buf, debug->CallbackData);
- return;
- }
-
- debug_log_message(debug, source, type, id, severity, len, buf);
-}
-
-
-/**
- * Pop the oldest debug message out of the log.
- * Writes the message string, including the null terminator, into 'buf',
- * using up to 'bufSize' bytes. If 'bufSize' is too small, or
- * if 'buf' is NULL, nothing is written.
- *
- * Returns the number of bytes written on success, or when 'buf' is NULL,
- * the number that would have been written. A return value of 0
- * indicates failure.
- */
-static GLsizei
-get_msg(struct gl_context *ctx, GLenum *source, GLenum *type,
- GLuint *id, GLenum *severity, GLsizei bufSize, char *buf)
-{
- struct gl_debug_state *debug = _mesa_get_debug_state(ctx);
- const struct gl_debug_msg *msg;
- GLsizei length;
-
- if (!debug)
- return 0;
-
- msg = debug_fetch_message(debug);
- if (!msg)
- return 0;
-
- msg = &debug->Log[debug->NextMsg];
- length = msg->length;
-
- assert(length > 0 && length == debug->NextMsgLength);
-
- if (bufSize < length && buf != NULL)
- return 0;
-
- if (severity) {
- *severity = debug_severity_enums[msg->severity];
- }
-
- if (source) {
- *source = debug_source_enums[msg->source];
- }
-
- if (type) {
- *type = debug_type_enums[msg->type];
- }
-
- if (id) {
- *id = msg->id;
- }
-
- if (buf) {
- assert(msg->message[length-1] == '\0');
- (void) strncpy(buf, msg->message, (size_t)length);
- }
-
- debug_delete_messages(debug, 1);
-
- return length;
-}
-
-
-/**
- * Verify that source, type, and severity are valid enums.
- *
- * The 'caller' param is used for handling values available
- * only in glDebugMessageInsert or glDebugMessageControl
- */
-static GLboolean
-validate_params(struct gl_context *ctx, unsigned caller,
- const char *callerstr, GLenum source, GLenum type,
- GLenum severity)
-{
-#define INSERT 1
-#define CONTROL 2
- switch(source) {
- case GL_DEBUG_SOURCE_APPLICATION_ARB:
- case GL_DEBUG_SOURCE_THIRD_PARTY_ARB:
- break;
- case GL_DEBUG_SOURCE_API_ARB:
- case GL_DEBUG_SOURCE_SHADER_COMPILER_ARB:
- case GL_DEBUG_SOURCE_WINDOW_SYSTEM_ARB:
- case GL_DEBUG_SOURCE_OTHER_ARB:
- if (caller != INSERT)
- break;
- else
- goto error;
- case GL_DONT_CARE:
- if (caller == CONTROL)
- break;
- else
- goto error;
- default:
- goto error;
- }
-
- switch(type) {
- case GL_DEBUG_TYPE_ERROR_ARB:
- case GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR_ARB:
- case GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR_ARB:
- case GL_DEBUG_TYPE_PERFORMANCE_ARB:
- case GL_DEBUG_TYPE_PORTABILITY_ARB:
- case GL_DEBUG_TYPE_OTHER_ARB:
- case GL_DEBUG_TYPE_MARKER:
- break;
- case GL_DEBUG_TYPE_PUSH_GROUP:
- case GL_DEBUG_TYPE_POP_GROUP:
- case GL_DONT_CARE:
- if (caller == CONTROL)
- break;
- else
- goto error;
- default:
- goto error;
- }
-
- switch(severity) {
- case GL_DEBUG_SEVERITY_HIGH_ARB:
- case GL_DEBUG_SEVERITY_MEDIUM_ARB:
- case GL_DEBUG_SEVERITY_LOW_ARB:
- case GL_DEBUG_SEVERITY_NOTIFICATION:
- break;
- case GL_DONT_CARE:
- if (caller == CONTROL)
- break;
- else
- goto error;
- default:
- goto error;
- }
- return GL_TRUE;
-
-error:
- _mesa_error(ctx, GL_INVALID_ENUM, "bad values passed to %s"
- "(source=0x%x, type=0x%x, severity=0x%x)", callerstr,
- source, type, severity);
-
- return GL_FALSE;
-}
-
-
-static void
-control_messages(struct gl_context *ctx,
- enum mesa_debug_source source,
- enum mesa_debug_type type,
- enum mesa_debug_severity severity,
- GLboolean enabled)
-{
- struct gl_debug_state *debug = _mesa_get_debug_state(ctx);
-
- if (!debug)
- return;
-
- debug_set_message_enable_all(debug, source, type, severity, 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)
-{
- GLsizei i;
- enum mesa_debug_source source = gl_enum_to_debug_source(esource);
- enum mesa_debug_type type = gl_enum_to_debug_type(etype);
- enum mesa_debug_severity severity = gl_enum_to_debug_severity(eseverity);
-
- for (i = 0; i < count; i++)
- set_message_state(ctx, source, type, ids[i], enabled);
-
- if (count)
- return;
-
- control_messages(ctx, source, type, severity, enabled);
-}
-
-
-/**
- * This is a generic message insert function.
- * Validation of source, type and severity parameters should be done
- * before calling this funtion.
- */
-static void
-message_insert(GLenum source, GLenum type, GLuint id,
- GLenum severity, GLint length, const GLchar *buf,
- const char *callerstr)
-{
- GET_CURRENT_CONTEXT(ctx);
-
- if (length < 0)
- length = strlen(buf);
-
- if (length >= MAX_DEBUG_MESSAGE_LENGTH) {
- _mesa_error(ctx, GL_INVALID_VALUE,
- "%s(length=%d, which is not less than "
- "GL_MAX_DEBUG_MESSAGE_LENGTH=%d)", callerstr, length,
- MAX_DEBUG_MESSAGE_LENGTH);
- return;
- }
-
- log_msg(ctx,
- gl_enum_to_debug_source(source),
- gl_enum_to_debug_type(type), id,
- gl_enum_to_debug_severity(severity), length, buf);
-}
-
-
-void GLAPIENTRY
-_mesa_DebugMessageInsert(GLenum source, GLenum type, GLuint id,
- GLenum severity, GLint length,
- const GLchar *buf)
-{
- const char *callerstr = "glDebugMessageInsert";
-
- GET_CURRENT_CONTEXT(ctx);
-
- if (!validate_params(ctx, INSERT, callerstr, source, type, severity))
- return; /* GL_INVALID_ENUM */
-
- message_insert(source, type, id, severity, length, buf, callerstr);
-}
-
-
-GLuint GLAPIENTRY
-_mesa_GetDebugMessageLog(GLuint count, GLsizei logSize, GLenum *sources,
- GLenum *types, GLenum *ids, GLenum *severities,
- GLsizei *lengths, GLchar *messageLog)
-{
- GET_CURRENT_CONTEXT(ctx);
- GLuint ret;
-
- if (!messageLog)
- logSize = 0;
-
- if (logSize < 0) {
- _mesa_error(ctx, GL_INVALID_VALUE,
- "glGetDebugMessageLog(logSize=%d : logSize must not be"
- " negative)", logSize);
- return 0;
- }
-
- for (ret = 0; ret < count; ret++) {
- GLsizei written = get_msg(ctx, sources, types, ids, severities,
- logSize, messageLog);
- if (!written)
- break;
-
- if (messageLog) {
- messageLog += written;
- logSize -= written;
- }
- if (lengths) {
- *lengths = written;
- lengths++;
- }
-
- if (severities)
- severities++;
- if (sources)
- sources++;
- if (types)
- types++;
- if (ids)
- ids++;
- }
-
- return ret;
-}
-
-
-void GLAPIENTRY
-_mesa_DebugMessageControl(GLenum gl_source, GLenum gl_type,
- GLenum gl_severity, GLsizei count,
- const GLuint *ids, GLboolean enabled)
-{
- const char *callerstr = "glDebugMessageControl";
-
- GET_CURRENT_CONTEXT(ctx);
-
- if (count < 0) {
- _mesa_error(ctx, GL_INVALID_VALUE,
- "%s(count=%d : count must not be negative)", callerstr,
- count);
- return;
- }
-
- if (!validate_params(ctx, CONTROL, callerstr, gl_source, gl_type,
- gl_severity))
- return; /* GL_INVALID_ENUM */
-
- if (count && (gl_severity != GL_DONT_CARE || gl_type == GL_DONT_CARE
- || gl_source == GL_DONT_CARE)) {
- _mesa_error(ctx, GL_INVALID_OPERATION,
- "%s(When passing an array of ids, severity must be"
- " GL_DONT_CARE, and source and type must not be GL_DONT_CARE.",
- callerstr);
- return;
- }
-
- control_app_messages(ctx, gl_source, gl_type, gl_severity,
- count, ids, enabled);
-}
-
-
-void GLAPIENTRY
-_mesa_DebugMessageCallback(GLDEBUGPROC callback, const void *userParam)
-{
- GET_CURRENT_CONTEXT(ctx);
- struct gl_debug_state *debug = _mesa_get_debug_state(ctx);
- if (debug) {
- debug->Callback = callback;
- debug->CallbackData = userParam;
- }
-}
-
-
-void GLAPIENTRY
-_mesa_PushDebugGroup(GLenum source, GLuint id, GLsizei length,
- const GLchar *message)
-{
- GET_CURRENT_CONTEXT(ctx);
- struct gl_debug_state *debug = _mesa_get_debug_state(ctx);
- const char *callerstr = "glPushDebugGroup";
- struct gl_debug_msg *emptySlot;
-
- if (!debug)
- return;
-
- if (debug->GroupStackDepth >= MAX_DEBUG_GROUP_STACK_DEPTH-1) {
- _mesa_error(ctx, GL_STACK_OVERFLOW, "%s", callerstr);
- return;
- }
-
- switch(source) {
- case GL_DEBUG_SOURCE_APPLICATION:
- case GL_DEBUG_SOURCE_THIRD_PARTY:
- break;
- default:
- _mesa_error(ctx, GL_INVALID_ENUM, "bad value passed to %s"
- "(source=0x%x)", callerstr, source);
- return;
- }
-
- if (length < 0)
- length = strlen(message);
-
- message_insert(source, GL_DEBUG_TYPE_PUSH_GROUP, id,
- GL_DEBUG_SEVERITY_NOTIFICATION, length,
- message, callerstr);
-
- /* pop reuses the message details from push so we store this */
- emptySlot = debug_get_group_message(debug);
- debug_message_store(emptySlot,
- gl_enum_to_debug_source(source),
- gl_enum_to_debug_type(GL_DEBUG_TYPE_PUSH_GROUP),
- id,
- gl_enum_to_debug_severity(GL_DEBUG_SEVERITY_NOTIFICATION),
- length, message);
-
- debug_push_group(debug);
-}
-
-
-void GLAPIENTRY
-_mesa_PopDebugGroup(void)
-{
- GET_CURRENT_CONTEXT(ctx);
- struct gl_debug_state *debug = _mesa_get_debug_state(ctx);
- const char *callerstr = "glPopDebugGroup";
- struct gl_debug_msg *gdmessage;
-
- if (!debug)
- return;
-
- if (debug->GroupStackDepth <= 0) {
- _mesa_error(ctx, GL_STACK_UNDERFLOW, "%s", callerstr);
- return;
- }
-
- debug_pop_group(debug);
-
- gdmessage = debug_get_group_message(debug);
- /* using log_msg() directly here as verification of parameters
- * already done in push
- */
- log_msg(ctx, gdmessage->source,
- gl_enum_to_debug_type(GL_DEBUG_TYPE_POP_GROUP),
- gdmessage->id,
- gl_enum_to_debug_severity(GL_DEBUG_SEVERITY_NOTIFICATION),
- gdmessage->length, gdmessage->message);
-
- debug_message_clear(gdmessage);
-}
-
-
-void
-_mesa_init_errors(struct gl_context *ctx)
-{
- /* no-op */
-}
-
-
-void
-_mesa_free_errors_data(struct gl_context *ctx)
-{
- if (ctx->Debug) {
- debug_destroy(ctx->Debug);
- /* set to NULL just in case it is used before context is completely gone. */
- ctx->Debug = NULL;
- }
-}
-
-
-/**********************************************************************/
-/** \name Diagnostics */
-/*@{*/
static void
output_if_debug(const char *prefixString, const char *outputString,
GLboolean newline)
{
static int debug = -1;
- static FILE *fout = NULL;
/* Init the local 'debug' var once.
* Note: the _mesa_init_debug() function should have been called
/* 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");
+ const char *logFile = getenv("MESA_LOG_FILE");
if (logFile)
- fout = fopen(logFile, "w");
- if (!fout)
- fout = stderr;
+ LogFile = fopen(logFile, "w");
+ if (!LogFile)
+ LogFile = stderr;
#ifdef DEBUG
/* in debug builds, print messages unless MESA_DEBUG="silent" */
if (MESA_DEBUG_FLAGS & DEBUG_SILENT)
debug = 1;
#else
/* in release builds, be silent unless MESA_DEBUG is set */
- debug = _mesa_getenv("MESA_DEBUG") != NULL;
+ debug = getenv("MESA_DEBUG") != NULL;
#endif
}
/* Now only print the string if we're required to do so. */
if (debug) {
- fprintf(fout, "%s: %s", prefixString, outputString);
+ if (prefixString)
+ fprintf(LogFile, "%s: %s", prefixString, outputString);
+ else
+ fprintf(LogFile, "%s", outputString);
if (newline)
- fprintf(fout, "\n");
- fflush(fout);
+ fprintf(LogFile, "\n");
+ fflush(LogFile);
-#if defined(_WIN32) && !defined(_WIN32_WCE)
+#if defined(_WIN32)
/* stderr from windows applications without console is not usually
* visible, so communicate with the debugger instead */
{
}
+/**
+ * Return the file handle to use for debug/logging. Defaults to stderr
+ * unless MESA_LOG_FILE is defined.
+ */
+FILE *
+_mesa_get_log_file(void)
+{
+ assert(LogFile);
+ return LogFile;
+}
+
+
/**
* When a new type of error is recorded, print a message describing
* previous errors which were accumulated.
if (ctx->ErrorDebugCount) {
_mesa_snprintf(s, MAX_DEBUG_MESSAGE_LENGTH, "%d similar %s errors",
ctx->ErrorDebugCount,
- _mesa_lookup_enum_by_nr(ctx->ErrorValue));
+ _mesa_enum_to_string(ctx->ErrorValue));
output_if_debug("Mesa", s, GL_TRUE);
/* Check debug environment variable only once:
*/
if (debug == -1) {
- const char *debugEnv = _mesa_getenv("MESA_DEBUG");
+ const char *debugEnv = getenv("MESA_DEBUG");
#ifdef DEBUG
if (debugEnv && strstr(debugEnv, "silent"))
}
+void
+_mesa_gl_vdebug(struct gl_context *ctx,
+ GLuint *id,
+ enum mesa_debug_source source,
+ enum mesa_debug_type type,
+ enum mesa_debug_severity severity,
+ const char *fmtString,
+ va_list args)
+{
+ char s[MAX_DEBUG_MESSAGE_LENGTH];
+ int len;
+
+ _mesa_debug_get_id(id);
+
+ len = _mesa_vsnprintf(s, MAX_DEBUG_MESSAGE_LENGTH, fmtString, args);
+
+ _mesa_log_msg(ctx, source, type, *id, severity, len, s);
+}
+
+
void
_mesa_gl_debug(struct gl_context *ctx,
GLuint *id,
+ enum mesa_debug_source source,
enum mesa_debug_type type,
enum mesa_debug_severity severity,
const char *fmtString, ...)
{
- char s[MAX_DEBUG_MESSAGE_LENGTH];
- int len;
va_list args;
-
- debug_get_id(id);
-
va_start(args, fmtString);
- len = _mesa_vsnprintf(s, MAX_DEBUG_MESSAGE_LENGTH, fmtString, args);
+ _mesa_gl_vdebug(ctx, id, source, type, severity, fmtString, args);
va_end(args);
-
- log_msg(ctx, MESA_DEBUG_SOURCE_API, type, *id, severity, len, s);
}
*/
static GLuint error_msg_id = 0;
- debug_get_id(&error_msg_id);
+ _mesa_debug_get_id(&error_msg_id);
do_output = should_output(ctx, error, fmtString);
- do_log = should_log(ctx,
- MESA_DEBUG_SOURCE_API,
- MESA_DEBUG_TYPE_ERROR,
- error_msg_id,
- MESA_DEBUG_SEVERITY_HIGH);
+
+ mtx_lock(&ctx->DebugMutex);
+ if (ctx->Debug) {
+ do_log = _mesa_debug_is_message_enabled(ctx->Debug,
+ MESA_DEBUG_SOURCE_API,
+ MESA_DEBUG_TYPE_ERROR,
+ error_msg_id,
+ MESA_DEBUG_SEVERITY_HIGH);
+ }
+ else {
+ do_log = GL_FALSE;
+ }
+ mtx_unlock(&ctx->DebugMutex);
if (do_output || do_log) {
char s[MAX_DEBUG_MESSAGE_LENGTH], s2[MAX_DEBUG_MESSAGE_LENGTH];
/* Too long error message. Whoever calls _mesa_error should use
* shorter strings.
*/
- ASSERT(0);
+ assert(0);
return;
}
len = _mesa_snprintf(s2, MAX_DEBUG_MESSAGE_LENGTH, "%s in %s",
- _mesa_lookup_enum_by_nr(error), s);
+ _mesa_enum_to_string(error), s);
if (len >= MAX_DEBUG_MESSAGE_LENGTH) {
/* Same as above. */
- ASSERT(0);
+ assert(0);
return;
}
/* Log the error via ARB_debug_output if needed.*/
if (do_log) {
- log_msg(ctx, MESA_DEBUG_SOURCE_API, MESA_DEBUG_TYPE_ERROR,
- error_msg_id, MESA_DEBUG_SEVERITY_HIGH, len, s2);
+ _mesa_log_msg(ctx, MESA_DEBUG_SOURCE_API, MESA_DEBUG_TYPE_ERROR,
+ error_msg_id, MESA_DEBUG_SEVERITY_HIGH, len, s2);
}
}
_mesa_record_error(ctx, error);
}
+void
+_mesa_error_no_memory(const char *caller)
+{
+ GET_CURRENT_CONTEXT(ctx);
+ _mesa_error(ctx, GL_OUT_OF_MEMORY, "out of memory in %s", caller);
+}
/**
* Report debug information. Print error message to stderr via fprintf().
}
+void
+_mesa_log(const char *fmtString, ...)
+{
+ char s[MAX_DEBUG_MESSAGE_LENGTH];
+ va_list args;
+ va_start(args, fmtString);
+ _mesa_vsnprintf(s, MAX_DEBUG_MESSAGE_LENGTH, fmtString, args);
+ va_end(args);
+ output_if_debug("", s, GL_FALSE);
+}
+
+
/**
* 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.
+ * \param msg The message to output. Must be null-terminated.
*/
void
-_mesa_shader_debug( struct gl_context *ctx, GLenum type, GLuint *id,
- const char *msg, int len )
+_mesa_shader_debug(struct gl_context *ctx, GLenum type, GLuint *id,
+ const char *msg)
{
enum mesa_debug_source source = MESA_DEBUG_SOURCE_SHADER_COMPILER;
enum mesa_debug_severity severity = MESA_DEBUG_SEVERITY_HIGH;
+ int len;
- debug_get_id(id);
+ _mesa_debug_get_id(id);
- if (len < 0)
- len = strlen(msg);
+ len = strlen(msg);
/* Truncate the message if necessary. */
if (len >= MAX_DEBUG_MESSAGE_LENGTH)
len = MAX_DEBUG_MESSAGE_LENGTH - 1;
- log_msg(ctx, source, type, *id, severity, len, msg);
+ _mesa_log_msg(ctx, source, type, *id, severity, len, msg);
}
-
-/*@}*/