[Mesa-dev] [PATCH 10/15] mesa: Implement KHR_debug ObjectLabel functions
Ian Romanick
idr at freedesktop.org
Wed Sep 4 13:54:11 PDT 2013
On 08/26/2013 03:43 AM, Timothy Arceri wrote:
>
> Signed-off-by: Timothy Arceri <t_arceri at yahoo.com.au>
> ---
> src/mesa/main/objectlabel.c | 277 +++++++++++++++++++++++++++++++++++++++++++
> src/mesa/main/objectlabel.h | 61 ++++++++++
> 2 files changed, 338 insertions(+)
> create mode 100644 src/mesa/main/objectlabel.c
> create mode 100644 src/mesa/main/objectlabel.h
>
> diff --git a/src/mesa/main/objectlabel.c b/src/mesa/main/objectlabel.c
> new file mode 100644
> index 0000000..78f9b33
> --- /dev/null
> +++ b/src/mesa/main/objectlabel.c
> @@ -0,0 +1,277 @@
> +/*
> + * Mesa 3-D graphics library
> + *
> + * Copyright (C) 2013 Timothy Arceri All Rights Reserved.
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a
> + * copy of this software and associated documentation files (the "Software"),
> + * to deal in the Software without restriction, including without limitation
> + * the rights to use, copy, modify, merge, publish, distribute, sublicense,
> + * and/or sell copies of the Software, and to permit persons to whom the
> + * Software is furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice shall be included
> + * in all copies or substantial portions of the Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
> + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
> + * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
> + * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
> + * OTHER DEALINGS IN THE SOFTWARE.
> + */
> +
> +
> +#include "arrayobj.h"
> +#include "bufferobj.h"
> +#include "context.h"
> +#include "dlist.h"
> +#include "enums.h"
> +#include "fbobject.h"
> +#include "objectlabel.h"
> +#include "queryobj.h"
> +#include "samplerobj.h"
> +#include "shaderobj.h"
> +#include "syncobj.h"
> +#include "texobj.h"
> +#include "transformfeedback.h"
> +
> +
> +/**
> + * Helper for _mesa_ObjectLabel() and _mesa_ObjectPtrLabel().
> + */
> +static void
> +set_label(struct gl_context *ctx, char **labelPtr, const char *label,
> + int length, const char *caller)
> +{
> + if (*labelPtr) {
> + /* free old label string */
> + free(*labelPtr);
> + }
> +
> + if (label) {
> + /* set new label string */
> +
> + if (length >= 0) {
This should be > 0. malloc(0) is not portable.
Shouldn't there also be a MAX_LABEL_LENGTH test for this patch?
> + /* explicit length */
> + *labelPtr = (char *) malloc(length);
> + if (*labelPtr) {
> + memcpy(*labelPtr, label, length);
> + }
> + }
> + else {
> + /* null-terminated string */
> + int len = strlen(label);
> + if (len >= MAX_LABEL_LENGTH) {
The reason MAX_LABEL_LENGTH exists is so that you can have a fixed-size
array in your structure (so you don't have to malloc a buffer. Either
make a fixed size buffer, or make MAX_LABEL_LENGTH be the maximum size
representable in a GLsizei (and eliminate this check).
> + /* An INVALID_VALUE error is generated if the number of characters
> + * in <label>, excluding the null terminator when <length> is
> + * negative, is not less than the value of MAX_LABEL_LENGTH.
> + */
> + _mesa_error(ctx, GL_INVALID_VALUE,
> + "%s(length=%d, which is not less than "
> + "GL_MAX_LABEL_LENGTH=%d)", caller, length,
> + MAX_LABEL_LENGTH);
> + return;
> + }
> + *labelPtr = _mesa_strdup(label);
> + }
> + }
> +}
> +
> +/**
> + * Helper for _mesa_GetObjectLabel() and _mesa_GetObjectPtrLabel().
> + */
> +static void
> +copy_label(char **labelPtr, char *label, int *length, int bufSize)
> +{
> + int labelLen = 0;
> +
> + if (*labelPtr)
> + labelLen = strlen(*labelPtr);
> +
> + if (label) {
There should be a spec quote here explaining why this value is returned.
Other places in OpenGL include the NUL terminator in the length.
/* The KHR_debug spec says:
*
* "The string representation of the message is stored in
* <message> and its length (excluding the null-terminator)
* is stored in <length>"
*/
> + if (bufSize <= labelLen)
> + labelLen = bufSize-1;
> +
> + memcpy(label, *labelPtr, labelLen);
> + label[labelLen] = '\0';
> + }
> +
> + if (length)
> + *length = labelLen;
> +}
> +
> +/**
> + * Helper for _mesa_ObjectLabel() and _mesa_GetObjectLabel().
> + */
> +static char **
> +get_label_pointer(struct gl_context *ctx, GLenum identifier, GLuint name,
> + const char *caller)
> +{
> + char **labelPtr = NULL;
> +
> + switch (identifier) {
> + case GL_BUFFER:
> + {
Coding style fail. The { goes on the same line as the case, and there's
only one level of indent
> + struct gl_buffer_object *bufObj = _mesa_lookup_bufferobj(ctx, name);
> + if (bufObj)
> + labelPtr = &bufObj->Label;
> + }
> + break;
> + case GL_SHADER:
> + {
> + struct gl_shader *shader = _mesa_lookup_shader(ctx, name);
> + if (shader)
> + labelPtr = &shader->Label;
> + }
> + break;
> + case GL_PROGRAM:
> + {
> + struct gl_shader_program *program =
> + _mesa_lookup_shader_program(ctx, name);
> + if (program)
> + labelPtr = &program->Label;
> + }
> + break;
> + case GL_VERTEX_ARRAY:
> + {
> + struct gl_array_object *obj = _mesa_lookup_arrayobj(ctx, name);
> + if (obj)
> + labelPtr = &obj->Label;
> + }
> + break;
> + case GL_QUERY:
> + {
> + struct gl_query_object *query = _mesa_lookup_query_object(ctx, name);
> + if (query)
> + labelPtr = &query->Label;
> + }
> + break;
> + case GL_TRANSFORM_FEEDBACK:
> + {
> + struct gl_transform_feedback_object *tfo =
> + _mesa_lookup_transform_feedback_object(ctx, name);
> + if (tfo)
> + labelPtr = &tfo->Label;
> + }
> + break;
> + case GL_SAMPLER:
> + {
> + struct gl_sampler_object *so = _mesa_lookup_samplerobj(ctx, name);
> + if (so)
> + labelPtr = &so->Label;
> + }
> + break;
> + case GL_TEXTURE:
> + {
> + struct gl_texture_object *texObj = _mesa_lookup_texture(ctx, name);
> + if (texObj)
> + labelPtr = &texObj->Label;
> + }
> + break;
> + case GL_RENDERBUFFER:
> + {
> + struct gl_renderbuffer *rb = _mesa_lookup_renderbuffer(ctx, name);
> + if (rb)
> + labelPtr = &rb->Label;
> + }
> + break;
> + case GL_FRAMEBUFFER:
> + {
> + struct gl_framebuffer *rb = _mesa_lookup_framebuffer(ctx, name);
> + if (rb)
> + labelPtr = &rb->Label;
> + }
> + break;
> + case GL_DISPLAY_LIST:
> + if (ctx->API == API_OPENGL_COMPAT) {
> + struct gl_display_list *list = _mesa_lookup_list(ctx, name);
> + if (list)
> + labelPtr = &list->Label;
> + }
> + else {
> + goto invalid_enum;
> + }
> + break;
> + case GL_PROGRAM_PIPELINE:
> + /* requires GL 4.2 */
> + goto invalid_enum;
> + default:
> + goto invalid_enum;
> + }
> +
> + if (NULL == labelPtr) {
> + _mesa_error(ctx, GL_INVALID_VALUE, "glObjectLabel(name = %u)", name);
> + }
> +
> + return labelPtr;
> +
> +invalid_enum:
> + _mesa_error(ctx, GL_INVALID_ENUM, "%s(identifier = %s)",
> + caller, _mesa_lookup_enum_by_nr(identifier));
> + return NULL;
> +}
> +
> +void GLAPIENTRY
> +_mesa_ObjectLabel(GLenum identifier, GLuint name, GLsizei length,
> + const GLchar *label)
> +{
> + GET_CURRENT_CONTEXT(ctx);
> + char **labelPtr;
> +
> + labelPtr = get_label_pointer(ctx, identifier, name, "glObjectLabel");
> + if (!labelPtr)
> + return;
> +
> + set_label(ctx, labelPtr, label, length, "glObjectLabel");
> +}
> +
> +void GLAPIENTRY
> +_mesa_GetObjectLabel(GLenum identifier, GLuint name, GLsizei bufSize,
> + GLsizei *length, GLchar *label)
> +{
> + GET_CURRENT_CONTEXT(ctx);
> + char **labelPtr;
> +
> + labelPtr = get_label_pointer(ctx, identifier, name, "glGetObjectLabel");
> + if (!labelPtr)
> + return;
> +
> + copy_label(labelPtr, label, length, bufSize);
> +}
> +
> +void GLAPIENTRY
> +_mesa_ObjectPtrLabel(const void *ptr, GLsizei length, const GLchar *label)
> +{
> + GET_CURRENT_CONTEXT(ctx);
> + char **labelPtr;
> + struct gl_sync_object *const syncObj = (struct gl_sync_object *) ptr;
> +
> + if (!_mesa_validate_sync(ctx, syncObj)) {
> + _mesa_error(ctx, GL_INVALID_VALUE, "glObjectPtrLabel (not a valid sync object)");
> + return;
> + }
> +
> + labelPtr = &syncObj->Label;
> +
> + set_label(ctx, labelPtr, label, length, "glObjectPtrLabel");
> +}
> +
> +void GLAPIENTRY
> +_mesa_GetObjectPtrLabel(const void *ptr, GLsizei bufSize, GLsizei *length,
> + GLchar *label)
> +{
> + GET_CURRENT_CONTEXT(ctx);
> + char **labelPtr;
> + struct gl_sync_object *const syncObj = (struct gl_sync_object *) ptr;
> +
> + if (!_mesa_validate_sync(ctx, syncObj)) {
> + _mesa_error(ctx, GL_INVALID_VALUE, "glGetObjectPtrLabel (not a valid sync object)");
> + return;
> + }
> +
> + labelPtr = &syncObj->Label;
> +
> + copy_label(labelPtr, label, length, bufSize);
> +}
> diff --git a/src/mesa/main/objectlabel.h b/src/mesa/main/objectlabel.h
> new file mode 100644
> index 0000000..f57d5f7
> --- /dev/null
> +++ b/src/mesa/main/objectlabel.h
> @@ -0,0 +1,61 @@
> +/*
> + * Mesa 3-D graphics library
> + *
> + * Copyright (C) 2013 Timothy Arceri All Rights Reserved.
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a
> + * copy of this software and associated documentation files (the "Software"),
> + * to deal in the Software without restriction, including without limitation
> + * the rights to use, copy, modify, merge, publish, distribute, sublicense,
> + * and/or sell copies of the Software, and to permit persons to whom the
> + * Software is furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice shall be included
> + * in all copies or substantial portions of the Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
> + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
> + * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
> + * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
> + * OTHER DEALINGS IN THE SOFTWARE.
> + */
> +
> +
> +/**
> + * \file objectlabel.h
> + * Mesa object label functions.
> + *
> + * This file provides functions to assign and retrieve object labels.
> + */
> +
> +#ifndef OBJECTLABEL_H
> +#define OBJECTLABEL_H
> +
> +
> +#include "glheader.h"
> +
> +
> +#ifdef __cplusplus
> +extern "C" {
> +#endif
> +
> +void GLAPIENTRY
> +_mesa_ObjectLabel(GLenum identifier, GLuint name, GLsizei length,
> + const GLchar *label);
> +void GLAPIENTRY
> +_mesa_GetObjectLabel(GLenum identifier, GLuint name, GLsizei bufSize,
> + GLsizei *length, GLchar *label);
> +void GLAPIENTRY
> +_mesa_ObjectPtrLabel(const void *ptr, GLsizei length, const GLchar *label);
> +void GLAPIENTRY
> +_mesa_GetObjectPtrLabel(const void *ptr, GLsizei bufSize, GLsizei *length,
> + GLchar *label);
> +
> +#ifdef __cplusplus
> +}
> +#endif
> +
> +
> +#endif /* OBJECTLABEL_H */
>
More information about the mesa-dev
mailing list