[Piglit] [PATCH V7] KHR_debug: test ObjectLabel(), GetObjectLabel(), ObjectPtrLabel() and GetObjectPtrLabel()
Timothy Arceri
t_arceri at yahoo.com.au
Thu Aug 29 00:10:11 PDT 2013
V7: be defensive when testing max label, use fprintf for errors,
code tidy ups, and added get/set tests for each object type
V6: fix spelling of generated in multiple places
V5: Removed unneeded assignment that was also out of bounds
V4: Removed failure test that will never be true
V3: changed indentation to tabs, use test label constants
and remove unused variable
V2: fixed whitespaces, broke tests into subtests,
added missing build dir, and tidied up fail messages
Signed-off-by: Timothy Arceri <t_arceri at yahoo.com.au>
---
tests/all.tests | 5 +
tests/spec/CMakeLists.txt | 1 +
tests/spec/khr_debug/CMakeLists.gl.txt | 14 +
tests/spec/khr_debug/CMakeLists.txt | 1 +
tests/spec/khr_debug/debug-object-label.c | 449 +++++++++++++++++++++++++++++
5 files changed, 470 insertions(+)
create mode 100644 tests/spec/khr_debug/CMakeLists.gl.txt
create mode 100644 tests/spec/khr_debug/CMakeLists.txt
create mode 100644 tests/spec/khr_debug/debug-object-label.c
diff --git a/tests/all.tests b/tests/all.tests
index 7ab841e..a91dddc 100644
--- a/tests/all.tests
+++ b/tests/all.tests
@@ -1228,6 +1228,11 @@ arb_debug_output = Group()
spec['ARB_debug_output'] = arb_debug_output
add_plain_test(arb_debug_output, 'arb_debug_output-api_error')
+# Group KHR_debug
+khr_debug = Group()
+spec['KHR_debug'] = khr_debug
+add_plain_test(khr_debug, 'khr_debug-object-label')
+
# Group ARB_occlusion_query2
arb_occlusion_query2 = Group()
spec['ARB_occlusion_query2'] = arb_occlusion_query2
diff --git a/tests/spec/CMakeLists.txt b/tests/spec/CMakeLists.txt
index 17c991a..9c10046 100644
--- a/tests/spec/CMakeLists.txt
+++ b/tests/spec/CMakeLists.txt
@@ -1,6 +1,7 @@
add_subdirectory (amd_performance_monitor)
add_subdirectory (arb_color_buffer_float)
add_subdirectory (arb_debug_output)
+add_subdirectory (khr_debug)
add_subdirectory (arb_depth_clamp)
add_subdirectory (arb_draw_instanced)
add_subdirectory (arb_es2_compatibility)
diff --git a/tests/spec/khr_debug/CMakeLists.gl.txt b/tests/spec/khr_debug/CMakeLists.gl.txt
new file mode 100644
index 0000000..b0079df
--- /dev/null
+++ b/tests/spec/khr_debug/CMakeLists.gl.txt
@@ -0,0 +1,14 @@
+include_directories(
+ ${GLEXT_INCLUDE_DIR}
+ ${OPENGL_INCLUDE_PATH}
+)
+
+link_libraries (
+ piglitutil_${piglit_target_api}
+ ${OPENGL_gl_LIBRARY}
+ ${OPENGL_glu_LIBRARY}
+)
+
+piglit_add_executable (khr_debug-object-label debug-object-label.c)
+
+# vim: ft=cmake:
diff --git a/tests/spec/khr_debug/CMakeLists.txt b/tests/spec/khr_debug/CMakeLists.txt
new file mode 100644
index 0000000..144a306
--- /dev/null
+++ b/tests/spec/khr_debug/CMakeLists.txt
@@ -0,0 +1 @@
+piglit_include_target_api()
diff --git a/tests/spec/khr_debug/debug-object-label.c b/tests/spec/khr_debug/debug-object-label.c
new file mode 100644
index 0000000..57891f7
--- /dev/null
+++ b/tests/spec/khr_debug/debug-object-label.c
@@ -0,0 +1,449 @@
+/*
+ * Copyright (c) 2013 Timothy Arceri <t_arceri at yahoo.com.au>
+ *
+ * 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
+ * on the rights to use, copy, modify, merge, publish, distribute, sub
+ * license, 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 (including the next
+ * paragraph) 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
+ * NON-INFRINGEMENT. IN NO EVENT SHALL AUTHORS AND/OR THEIR SUPPLIERS
+ * 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 "piglit-util-gl-common.h"
+
+static const char *TestLabel = "Test Label";
+static const int TestLabelLen = 10;
+
+PIGLIT_GL_TEST_CONFIG_BEGIN
+
+ config.supports_gl_compat_version = 11;
+
+ config.window_visual = PIGLIT_GL_VISUAL_RGBA | PIGLIT_GL_VISUAL_DOUBLE;
+
+PIGLIT_GL_TEST_CONFIG_END
+
+enum piglit_result
+piglit_display(void)
+{
+ return PIGLIT_PASS;
+}
+
+static bool
+test_object_ptr_label()
+{
+ GLsync sync;
+ GLsizei length;
+ GLchar label[TestLabelLen + 1];
+ bool pass = true;
+
+ puts("Test ObjectPtrLabel");
+
+ /* basic check to see if glObjectPtrLabel/glGetObjectPtrLabel
+ * set/get the label
+ */
+ sync = glFenceSync(GL_SYNC_GPU_COMMANDS_COMPLETE, 0);
+ glObjectPtrLabel(sync, -1, TestLabel);
+ glGetObjectPtrLabel(sync, TestLabelLen + 1, &length, label);
+
+ if (length != TestLabelLen || (strcmp(TestLabel, label) != 0)) {
+ fprintf(stderr, "Label or length does not match\n");
+ printf(" actual label: %s actual length: %i\n", label, length);
+ printf(" expected label: %s expected length: %i\n", TestLabel, TestLabelLen);
+ pass = false;
+ }
+ glDeleteSync(sync);
+
+ /* An INVALID_VALUE is generated if the <ptr> parameter of ObjectPtrLabel
+ * is not the name of a sync object.
+ */
+ glObjectPtrLabel(NULL, length, label);
+
+ if (!piglit_check_gl_error(GL_INVALID_VALUE)) {
+ fprintf(stderr, "GL_INVALID_VALUE should be generated when ObjectPtrLabel()"
+ " ptr is not the name of a sync object\n");
+ pass = false;
+ }
+
+ return pass;
+}
+
+/* <label> will be null-terminated. The actual number of
+ * characters written into <label>,
+ * excluding the null terminator, is returned in <length>.
+ */
+static bool
+check_label_and_length(char *label, int length, char *object)
+{
+ bool pass = true;
+
+ printf("Checking label and length of %s object\n", object);
+
+ if (!piglit_check_gl_error(GL_NO_ERROR))
+ pass = false;
+
+ if (length != TestLabelLen || (strcmp(TestLabel, label) != 0)) {
+ fprintf(stderr, "Label or length does not match in %s object\n", object);
+ printf(" actual label: %s actual length: %i\n", label, length);
+ printf(" expected label: %s expected length: %i\n", TestLabel, TestLabelLen);
+ pass = false;
+ }
+
+ return pass;
+}
+
+/* trivial tests to get/set labels on all the different types of objects */
+static bool
+test_object_label_types()
+{
+ int numObjects = 12;
+ GLsizei length[numObjects]; /* create a fresh variable for each object to test */
+ GLchar label[numObjects][TestLabelLen + 1];
+ bool pass = true;
+
+ GLuint buffer;
+ GLuint shader;
+ GLuint program;
+ GLuint vertexArray;
+ GLuint query;
+ GLuint programPipeline;
+ GLuint transformFeedback;
+ GLuint sampler;
+ GLuint texture;
+ GLuint renderbuffer;
+ GLuint framebuffer;
+ GLuint displayList;
+
+ /* Test BUFFER */
+ glGenBuffers(1, &buffer);
+ glBindBuffer(GL_ARRAY_BUFFER, buffer);
+ glObjectLabel(GL_BUFFER, buffer, -1, TestLabel);
+ glGetObjectLabel(GL_BUFFER, buffer, TestLabelLen + 1, &length[0], label[0]);
+
+ check_label_and_length(label[0], length[0], "GL_BUFFER");
+
+ glDeleteBuffers(1, &buffer);
+
+ /* Test SHADER */
+ shader = glCreateShader(GL_FRAGMENT_SHADER);
+ glObjectLabel(GL_SHADER, shader, -1, TestLabel);
+ glGetObjectLabel(GL_SHADER, shader, TestLabelLen + 1, &length[1], label[1]);
+
+ check_label_and_length(label[1], length[1], "GL_SHADER");
+
+ glDeleteShader(shader);
+
+ /* Test PROGRAM */
+ program = glCreateProgram();
+ glObjectLabel(GL_PROGRAM, program, -1, TestLabel);
+ glGetObjectLabel(GL_PROGRAM, program, TestLabelLen + 1, &length[2], label[2]);
+
+ check_label_and_length(label[2], length[2], "GL_PROGRAM");
+
+ glDeleteProgram(program);
+
+ /* Test VERTEX_ARRAY */
+ glGenVertexArrays(1, &vertexArray);
+ glBindVertexArray(vertexArray);
+ glObjectLabel(GL_VERTEX_ARRAY, vertexArray, -1, TestLabel);
+ glGetObjectLabel(GL_VERTEX_ARRAY, vertexArray, TestLabelLen + 1, &length[3], label[3]);
+
+ check_label_and_length(label[3], length[3], "GL_VERTEX_ARRAY");
+
+ glDeleteVertexArrays(1, &vertexArray);
+
+ /* Test QUERY */
+ glGenQueries(1, &query);
+ glBeginQuery(GL_TIME_ELAPSED, query);
+ glEndQuery(GL_TIME_ELAPSED);
+ glObjectLabel(GL_QUERY, query, -1, TestLabel);
+ glGetObjectLabel(GL_QUERY, query, TestLabelLen + 1, &length[4], label[4]);
+
+ check_label_and_length(label[4], length[4], "GL_TEST_QUERY");
+
+ glDeleteQueries(1, &query);
+
+ /* Test PROGRAM_PIPELINE */
+ if (piglit_is_extension_supported("GL_ARB_separate_shader_objects")) {
+ glGenProgramPipelines(1, &programPipeline);
+ glBindProgramPipeline(programPipeline);
+ glObjectLabel(GL_PROGRAM_PIPELINE, programPipeline, -1, TestLabel);
+ glGetObjectLabel(GL_PROGRAM_PIPELINE, programPipeline, TestLabelLen + 1, &length[5], label[5]);
+
+ check_label_and_length(label[5], length[5], "GL_PROGRAM_PIPELINE");
+
+ glDeleteProgramPipelines(1, &programPipeline);
+ }
+
+ /* Test TRANSFORM_FEEDBACK */
+ if (piglit_is_extension_supported("GL_ARB_transform_feedback2")) {
+ glGenTransformFeedbacks(1, &transformFeedback);
+ glBindTransformFeedback(GL_TRANSFORM_FEEDBACK, transformFeedback);
+ glObjectLabel(GL_TRANSFORM_FEEDBACK, transformFeedback, -1, TestLabel);
+ glGetObjectLabel(GL_TRANSFORM_FEEDBACK, transformFeedback, TestLabelLen + 1, &length[6], label[6]);
+
+ check_label_and_length(label[6], length[6], "GL_TRANSFORM_FEEDBACK");
+
+ glDeleteTransformFeedbacks(1, &transformFeedback);
+ }
+
+ /* Test SAMPLER */
+ glGenSamplers(1, &sampler);
+ glBindSampler(0, sampler);
+ glObjectLabel(GL_SAMPLER, sampler, -1, TestLabel);
+ glGetObjectLabel(GL_SAMPLER, sampler, TestLabelLen + 1, &length[7], label[7]);
+
+ check_label_and_length(label[7], length[7], "GL_SAMPLER");
+
+ glDeleteSamplers(1, &sampler);
+
+ /* Test TEXTURE */
+ glGenTextures(1, &texture);
+ glBindTexture(GL_TEXTURE_2D, texture);
+ glObjectLabel(GL_TEXTURE, texture, -1, TestLabel);
+ glGetObjectLabel(GL_TEXTURE, texture, TestLabelLen + 1, &length[8], label[8]);
+
+ check_label_and_length(label[8], length[8], "GL_TEXTURE");
+
+ glDeleteTextures(1, &texture);
+
+ /* Test RENDERBUFFER */
+ glGenRenderbuffers(1, &renderbuffer);
+ glBindRenderbuffer(GL_RENDERBUFFER, renderbuffer);
+ glObjectLabel(GL_RENDERBUFFER, renderbuffer, -1, TestLabel);
+ glGetObjectLabel(GL_RENDERBUFFER, texture, TestLabelLen + 1, &length[9], label[9]);
+
+ check_label_and_length(label[9], length[9], "GL_RENDERBUFFER");
+
+ glDeleteRenderbuffers(1, &renderbuffer);
+
+ /* Test FRAMEBUFFER */
+ glGenFramebuffers(1, &framebuffer);
+ glBindFramebuffer(GL_FRAMEBUFFER, framebuffer);
+ glObjectLabel(GL_FRAMEBUFFER, framebuffer, -1, TestLabel);
+ glGetObjectLabel(GL_FRAMEBUFFER, texture, TestLabelLen + 1, &length[10], label[10]);
+
+ check_label_and_length(label[10], length[10], "GL_FRAMEBUFFER");
+
+ glDeleteFramebuffers(1, &framebuffer);
+
+ /* Test DISPLAY_LIST - Compatibility Profile */
+ displayList = glGenLists(1);
+ glNewList(displayList, GL_COMPILE_AND_EXECUTE);
+ glEndList();
+ glObjectLabel(GL_DISPLAY_LIST, displayList, -1, TestLabel);
+ glGetObjectLabel(GL_DISPLAY_LIST, displayList, TestLabelLen + 1, &length[11], label[11]);
+
+ check_label_and_length(label[11], length[11], "GL_DISPLAY_LIST");
+
+ glDeleteLists(displayList, 1);
+
+ return pass;
+}
+
+static bool
+test_object_label()
+{
+ GLsizei length;
+ GLuint buffer;
+ GLuint invalidBufferName;
+ GLint maxLabelLength;
+ GLchar label[TestLabelLen + 1];
+ GLchar *bigLabel;
+ bool pass = true;
+ int maximumLabelLengthTest = 1024; /* Be defensive about the size label length test to avoid memory issues */
+
+ puts("Test ObjectLabel");
+
+ glGenBuffers(1, &buffer);
+
+ /* 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.
+ */
+ glGetIntegerv(GL_MAX_LABEL_LENGTH, &maxLabelLength);
+ if (maxLabelLength <= maximumLabelLengthTest) {
+ bigLabel = (char *) malloc(maxLabelLength + 1);
+ if (bigLabel){
+ memset(bigLabel,'a',maxLabelLength);
+ bigLabel[maxLabelLength] = '\0';
+
+ /* Test when length -1 */
+ glBindBuffer(GL_ARRAY_BUFFER, buffer);
+ glObjectLabel(GL_BUFFER, buffer, -1, bigLabel);
+
+ if (!piglit_check_gl_error(GL_INVALID_VALUE)) {
+ fprintf(stderr, "GL_INVALID_VALUE should be generated when label >= MAX_LABEL_LENGTH\n");
+ pass = false;
+ }
+
+ /* test with large client defined length */
+ glBindBuffer(GL_ARRAY_BUFFER, buffer);
+ glObjectLabel(GL_BUFFER, buffer, maxLabelLength, bigLabel);
+
+ if (!piglit_check_gl_error(GL_INVALID_VALUE)) {
+ fprintf(stderr, "GL_INVALID_VALUE should be generated when label length >= MAX_LABEL_LENGTH\n");
+ pass = false;
+ }
+ }
+ }
+ else {
+ printf("MAX_LABEL_LENGTH test skipped as implementations MAX_LABEL_LENGTH=%i and max piglit test length=%i\n",
+ maxLabelLength, maximumLabelLengthTest);
+ }
+
+ /* If <label> is NULL, any debug label is effectively removed from the object.
+ */
+ glObjectLabel(GL_BUFFER, buffer, -1, TestLabel);
+ glObjectLabel(GL_BUFFER, buffer, -1, NULL);
+ glGetObjectLabel(GL_BUFFER, buffer, TestLabelLen + 1, &length, label);
+
+ if (length != 0 || (strcmp("", label) != 0)) {
+ fprintf(stderr, "Setting label to NULL should remove the label\n");
+ printf(" actual label: %s actual length: %i\n", label, length);
+ pass = false;
+ }
+
+ /* An INVALID_ENUM error is generated by ObjectLabel if <identifier> is not
+ * one of the object types.
+ */
+ glObjectLabel(GL_ARRAY_BUFFER, buffer, -1, TestLabel);
+
+ if (!piglit_check_gl_error(GL_INVALID_ENUM)) {
+ fprintf(stderr, "GL_INVALID_ENUM should be generated when the ObjectLabel identifier is invalid\n");
+ pass = false;
+ }
+
+ /* An INVALID_VALUE error is generated by ObjectLabel if <name> is not
+ * the name of a valid object of the type specified by <identifier>.
+ */
+ invalidBufferName = buffer;
+ glDeleteBuffers(1, &buffer);
+ glObjectLabel(GL_BUFFER, invalidBufferName, -1, TestLabel);
+
+ if (!piglit_check_gl_error(GL_INVALID_VALUE)) {
+ fprintf(stderr, "GL_INVALID_VALUE should be generated when the ObjectLabel name is invalid\n");
+ pass = false;
+ }
+
+ return pass;
+}
+
+static bool
+test_get_object_label()
+{
+ GLsizei numBuffers = 4;
+ GLsizei length;
+ GLuint buffers[numBuffers];
+ GLuint invalidBufferName;
+ GLchar label[TestLabelLen + 1];
+ bool pass = true;
+
+ puts("Test GetObjectLabel");
+
+ glGenBuffers(numBuffers, buffers);
+
+ /* The maximum number of characters that may
+ * be written into <label>, including the null terminator, is specified by
+ * <bufSize>.
+ */
+ glBindBuffer(GL_ARRAY_BUFFER, buffers[0]);
+ glObjectLabel(GL_BUFFER, buffers[0], -1, TestLabel);
+ glGetObjectLabel(GL_BUFFER, buffers[0], TestLabelLen, &length, label);
+
+ if (length != 9 || (strcmp("Test Labe", label) != 0)) {
+ fprintf(stderr, "BufSize should limit the maximum label length to 9\n");
+ printf(" actual label: %s actual length: %i\n", label, length);
+ pass = false;
+ }
+
+ /* If no debug label was specified for the object then <label>
+ * will contain a null-terminated empty string, and zero will be returned
+ * in <length>.
+ */
+ glBindBuffer(GL_ARRAY_BUFFER, buffers[1]);
+ glGetObjectLabel(GL_BUFFER, buffers[1], TestLabelLen + 1, &length, label);
+
+ if (length != 0 || (strcmp("", label) != 0)) {
+ fprintf(stderr, "Label should be empty and length 0\n");
+ printf(" actual label: %s actual length: %i\n", label, length);
+ pass = false;
+ }
+
+ /* If <label> is NULL and <length> is non-NULL then no string
+ * will be returned and the length of the label will be returned in
+ * <length>.
+ */
+ glBindBuffer(GL_ARRAY_BUFFER, buffers[2]);
+ glObjectLabel(GL_BUFFER, buffers[2], -1, TestLabel);
+ glGetObjectLabel(GL_BUFFER, buffers[2], TestLabelLen + 1, &length, NULL);
+
+ if (length != TestLabelLen) {
+ fprintf(stderr, "Label length should be %i\n", TestLabelLen);
+ printf(" actual length: %i\n", length);
+ pass = false;
+ }
+
+ /* If <length> is NULL, no length is returned.
+ */
+ glBindBuffer(GL_ARRAY_BUFFER, buffers[3]);
+ glObjectLabel(GL_BUFFER, buffers[3], -1, TestLabel);
+ glGetObjectLabel(GL_BUFFER, buffers[3], TestLabelLen + 1, NULL, label);
+
+ if (strcmp(TestLabel, label) != 0) {
+ fprintf(stderr, "Label doent match expected string when length NULL\n");
+ printf(" label: %s expected: %s\n", label, TestLabel);
+ pass = false;
+ }
+
+ /* An INVALID_ENUM error is generated by GetObjectLabel if identifier is not
+ * one of the valid object types
+ */
+ glGetObjectLabel(GL_ARRAY_BUFFER, buffers[3], TestLabelLen + 1, &length, label);
+
+ if (!piglit_check_gl_error(GL_INVALID_ENUM)) {
+ fprintf(stderr, "GL_INVALID_ENUM should be generated when GetObjectLabel identifier is invalid\n");
+ pass = false;
+ }
+
+ /* An INVALID_VALUE error is generated by GetObjectLabel if <name> is not
+ * the name of a valid object of the type specified by <identifier>.
+ */
+ invalidBufferName = buffers[3];
+ glDeleteBuffers(numBuffers, buffers);
+ glGetObjectLabel(GL_BUFFER, invalidBufferName, TestLabelLen + 1, &length, label);
+
+ if (!piglit_check_gl_error(GL_INVALID_VALUE)) {
+ fprintf(stderr, "GL_INVALID_VALUE should be generated when GetObjectLabel name is invalid\n");
+ pass = false;
+ }
+
+ return pass;
+}
+
+void piglit_init(int argc, char **argv)
+{
+ bool pass = true;
+
+ piglit_require_extension("GL_KHR_debug");
+
+ pass = test_object_label_types() && pass;
+ pass = test_object_label() && pass;
+ pass = test_get_object_label() && pass;
+ if (piglit_is_extension_supported("GL_ARB_sync"))
+ pass = test_object_ptr_label() && pass;
+
+ piglit_report_result(pass ? PIGLIT_PASS : PIGLIT_FAIL);
+}
--
1.7.9.5
More information about the Piglit
mailing list