-#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) \
- ((e) == GL_DEBUG_##kind1##_##kind2##_ARB || (e) == GL_DONT_CARE)
-#define severity_is(sev, kind) enum_is(sev, SEVERITY, kind)
-#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,
-
- SOURCE_COUNT,
- SOURCE_ANY = -1
-};
-
-enum {
- TYPE_ERROR,
- TYPE_DEPRECATED,
- TYPE_UNDEFINED,
- TYPE_PORTABILITY,
- TYPE_PERFORMANCE,
- TYPE_OTHER,
-
- TYPE_COUNT,
- TYPE_ANY = -1
-};
-
-enum {
- SEVERITY_LOW,
- SEVERITY_MEDIUM,
- SEVERITY_HIGH,
-
- SEVERITY_COUNT,
- SEVERITY_ANY = -1
-};
-
-static int
-enum_to_index(GLenum e)
-{
- switch (e) {
- case GL_DEBUG_SOURCE_APPLICATION_ARB:
- return (int)SOURCE_APPLICATION;
- case GL_DEBUG_SOURCE_THIRD_PARTY_ARB:
- return (int)SOURCE_THIRD_PARTY;
-
- case GL_DEBUG_TYPE_ERROR_ARB:
- return (int)TYPE_ERROR;
- case GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR_ARB:
- return (int)TYPE_DEPRECATED;
- case GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR_ARB:
- return (int)TYPE_UNDEFINED;
- case GL_DEBUG_TYPE_PERFORMANCE_ARB:
- return (int)TYPE_PERFORMANCE;
- case GL_DEBUG_TYPE_PORTABILITY_ARB:
- return (int)TYPE_PORTABILITY;
- case GL_DEBUG_TYPE_OTHER_ARB:
- return (int)TYPE_OTHER;
-
- case GL_DEBUG_SEVERITY_LOW_ARB:
- return (int)SEVERITY_LOW;
- case GL_DEBUG_SEVERITY_MEDIUM_ARB:
- return (int)SEVERITY_MEDIUM;
- case GL_DEBUG_SEVERITY_HIGH_ARB:
- return (int)SEVERITY_HIGH;
-
- case GL_DONT_CARE:
- return (int)TYPE_ANY;
-
- default:
- assert(0 && "unreachable");
- return -2;
- };
-}
-
-
-/*
- * 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
- * of booleans per namespace, per context, recording whether
- * each individual message is enabled or not. The message ID
- * is an index into the namespace's array.
- */
-static GLboolean
-should_log(struct gl_context *ctx, GLenum source, GLenum type,
- GLuint id, GLenum severity)
-{
- if (source == GL_DEBUG_SOURCE_APPLICATION_ARB ||
- source == GL_DEBUG_SOURCE_THIRD_PARTY_ARB) {
- int s, t, sev;
- s = enum_to_index(source);
- t = enum_to_index(type);
- sev = enum_to_index(severity);
-
- return get_message_state(ctx, s, t, sev, id);
- }
-
- if (type_is(type, ERROR)) {
- if (source_is(source, API))
- return ctx->Debug.ApiErrors[id];
- if (source_is(source, WINDOW_SYSTEM))
- return ctx->Debug.WinsysErrors[id];
- if (source_is(source, SHADER_COMPILER))
- return ctx->Debug.ShaderErrors[id];
- if (source_is(source, OTHER))
- return ctx->Debug.OtherErrors[id];
- }
-
- return (severity != GL_DEBUG_SEVERITY_LOW_ARB);
-}
-
-/**
- * '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
-_mesa_log_msg(struct gl_context *ctx, GLenum source, GLenum type,
- GLuint id, GLenum severity, GLint len, const char *buf)
-{
- GLint nextEmpty;
- struct gl_debug_msg *emptySlot;
-
- assert(len >= 0 && len < MAX_DEBUG_MESSAGE_LENGTH);
-
- if (!should_log(ctx, source, type, id, severity))
- return;
-
- if (ctx->Debug.Callback) {
- ctx->Debug.Callback(source, type, id, severity,
- len, buf, ctx->Debug.CallbackData);
- return;
- }
-
- if (ctx->Debug.NumMessages == MAX_DEBUG_LOGGED_MESSAGES)
- return;
-
- nextEmpty = (ctx->Debug.NextMsg + ctx->Debug.NumMessages)
- % MAX_DEBUG_LOGGED_MESSAGES;
- emptySlot = &ctx->Debug.Log[nextEmpty];
-
- assert(!emptySlot->message && !emptySlot->length);
-
- emptySlot->message = malloc(len+1);
- if (emptySlot->message) {
- (void) strncpy(emptySlot->message, buf, (size_t)len);
- emptySlot->message[len] = '\0';
-
- emptySlot->length = len+1;
- emptySlot->source = source;
- emptySlot->type = type;
- emptySlot->id = id;
- emptySlot->severity = severity;
- } else {
- /* malloc failed! */
- emptySlot->message = out_of_memory;
- emptySlot->length = strlen(out_of_memory)+1;
- emptySlot->source = GL_DEBUG_SOURCE_OTHER_ARB;
- emptySlot->type = GL_DEBUG_TYPE_ERROR_ARB;
- emptySlot->id = OTHER_ERROR_OUT_OF_MEMORY;
- emptySlot->severity = GL_DEBUG_SEVERITY_HIGH_ARB;
- }
-
- if (ctx->Debug.NumMessages == 0)
- ctx->Debug.NextMsgLength = ctx->Debug.Log[ctx->Debug.NextMsg].length;
-
- ctx->Debug.NumMessages++;
-}
-
-/**
- * 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
-_mesa_get_msg(struct gl_context *ctx, GLenum *source, GLenum *type,
- GLuint *id, GLenum *severity, GLsizei bufSize, char *buf)
-{
- struct gl_debug_msg *msg;
- GLsizei length;
-
- if (ctx->Debug.NumMessages == 0)
- return 0;
-
- msg = &ctx->Debug.Log[ctx->Debug.NextMsg];
- length = msg->length;
-
- assert(length > 0 && length == ctx->Debug.NextMsgLength);
-
- if (bufSize < length && buf != NULL)
- return 0;
-
- if (severity)
- *severity = msg->severity;
- if (source)
- *source = msg->source;
- if (type)
- *type = msg->type;
- if (id)
- *id = msg->id;
-
- if (buf) {
- assert(msg->message[length-1] == '\0');
- (void) strncpy(buf, msg->message, (size_t)length);
- }
-
- if (msg->message != (char*)out_of_memory)
- free(msg->message);
- msg->message = NULL;
- msg->length = 0;
-
- ctx->Debug.NumMessages--;
- ctx->Debug.NextMsg++;
- ctx->Debug.NextMsg %= MAX_DEBUG_LOGGED_MESSAGES;
- ctx->Debug.NextMsgLength = ctx->Debug.Log[ctx->Debug.NextMsg].length;
-
- return length;
-}
-
-/**
- * Verify that source, type, and severity are valid enums.
- * glDebugMessageInsertARB only accepts two values for 'source',
- * and glDebugMessageControlARB will additionally accept GL_DONT_CARE
- * in any parameter, so handle those cases specially.
- */
-static GLboolean
-validate_params(struct gl_context *ctx, unsigned caller,
- 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;
- case GL_DONT_CARE:
- if (caller == CONTROL)
- break;
- 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:
- break;
- case GL_DONT_CARE:
- if (caller == CONTROL)
- break;
- default:
- goto error;
- }
-
- switch(severity) {
- case GL_DEBUG_SEVERITY_HIGH_ARB:
- case GL_DEBUG_SEVERITY_MEDIUM_ARB:
- case GL_DEBUG_SEVERITY_LOW_ARB:
- break;
- case GL_DONT_CARE:
- if (caller == CONTROL)
- break;
- default:
- goto error;
- }
- return GL_TRUE;
-
-error:
- {
- const char *callerstr;
- if (caller == INSERT)
- callerstr = "glDebugMessageInsertARB";
- else if (caller == CONTROL)
- callerstr = "glDebugMessageControlARB";
- else
- return GL_FALSE;
-
- _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 GLAPIENTRY
-_mesa_DebugMessageInsertARB(GLenum source, GLenum type, GLuint id,
- GLenum severity, GLint length,
- const GLcharARB* buf)
-{
- GET_CURRENT_CONTEXT(ctx);
-
- if (!validate_params(ctx, INSERT, source, type, severity))
- return; /* GL_INVALID_ENUM */
-
- if (length < 0)
- length = strlen(buf);
-
- if (length >= MAX_DEBUG_MESSAGE_LENGTH) {
- _mesa_error(ctx, GL_INVALID_VALUE, "glDebugMessageInsertARB"
- "(length=%d, which is not less than "
- "GL_MAX_DEBUG_MESSAGE_LENGTH_ARB=%d)", length,
- MAX_DEBUG_MESSAGE_LENGTH);
- return;
- }
-
- _mesa_log_msg(ctx, source, type, id, severity, length, buf);
-}