[Piglit] [PATCH 1/9] GL3.2 GL_ARB_sync: Test to check the correct error messages are returned for invalid inputs for ClientWaitSync

[Kenneth Graunke]

On 07/25/2013 03:43 PM, Nicholas Mack wrote:
> ---
>   tests/spec/arb_sync/CMakeLists.gl.txt       |  1 +
>   tests/spec/arb_sync/ClientWaitSync-errors.c | 94 +++++++++++++++++++++++++++++
>   2 files changed, 95 insertions(+)
>   create mode 100644 tests/spec/arb_sync/ClientWaitSync-errors.c
>
> diff --git a/tests/spec/arb_sync/CMakeLists.gl.txt b/tests/spec/arb_sync/CMakeLists.gl.txt
> index dd4cf35..5e78daa 100644
> --- a/tests/spec/arb_sync/CMakeLists.gl.txt
> +++ b/tests/spec/arb_sync/CMakeLists.gl.txt
> @@ -10,5 +10,6 @@ link_libraries (
>   	${OPENGL_glu_LIBRARY}
>   )
>
> +piglit_add_executable (arb_sync-client-wait-errors ClientWaitSync-errors.c)
>   piglit_add_executable (arb_sync-repeat-wait repeat-wait.c)
>   piglit_add_executable (arb_sync-timeout-zero timeout-zero.c)
> diff --git a/tests/spec/arb_sync/ClientWaitSync-errors.c b/tests/spec/arb_sync/ClientWaitSync-errors.c
> new file mode 100644
> index 0000000..529d745
> --- /dev/null
> +++ b/tests/spec/arb_sync/ClientWaitSync-errors.c
> @@ -0,0 +1,94 @@
> +/* Copyright © 2013 Intel Corporation
> + *

Usually there is a blank line at the top here, like so:

/*
  * Copyright © 2013 Intel Corporation
  *

> + * 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 (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 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.
> + */
> +
> +/*
> + *Test ClientWaitSync() returns correct error messages for invalid input
> + *
> + *
> + *Section 5.2.1(Waiting for Sync Objects) of OpenGL 3.2 Core says:
> + *"If <sync> is not the name of a sync object, an INVALID_VALUE error
> + * is generated. If <flags> contains any bits other than
> + * SYNC_FLUSH_COMMANDS_BIT, an INVALID_VALUE error is generated."
> + *
> + */

You should have a space after your stars, and start with two stars:

/**
  * Test ClientWaitSync() returns correct error messages for ...
  *
  * Section 5.2.1 (Waiting for Sync Objects) of ...
  * "If <sync> is...
  *  ...an INVALID_VALUE error is generated."
  */

> +
> +#include "piglit-util-gl-common.h"
> +
> +PIGLIT_GL_TEST_CONFIG_BEGIN
> +
> +config.supports_gl_compat_version = 10;
> +config.supports_gl_core_version = 31;
> +
> +PIGLIT_GL_TEST_CONFIG_END
> +
> +enum piglit_result
> +piglit_display(void)
> +{
> +	/* UNREACHED */
> +	return PIGLIT_FAIL;
> +}
> +
> +void
> +piglit_init(int argc, char **argv)
> +{
> +	bool pass = true;
> +	GLsync a, b;
> +	GLint c;
> +	c = 20;

Doing this on two lines generates mixed declarations/code errors.  You 
could combine them by doing: GLint c = 20;

This generates the following warning:
warning: passing argument 1 of ‘piglit_dispatch_glClientWaitSync’ makes 
pointer from integer without a cast [enabled by default]

I think you can fix it by doing:
GLsync c = (GLsync) 20;

> +	GLenum mess1;
> +	int i;
> +
> +	if (piglit_get_gl_version() < 32) {
> +		piglit_require_extension("GL_ARB_sync");
> +	}
> +
> +	a = glFenceSync(GL_SYNC_GPU_COMMANDS_COMPLETE, 0);
> +
> +	//test that valid sync results in NO_ERROR

Since this is C code, you should use C-style comments:
/* test that valid sync results in NO_ERROR */

> +	mess1 = glClientWaitSync(a, GL_SYNC_FLUSH_COMMANDS_BIT, 0);
> +	pass = piglit_check_gl_error(GL_NO_ERROR) && pass;
> +
> +	//test that invalid sync results in INVALID_VALUE
> +	mess1 = glClientWaitSync(b, GL_SYNC_FLUSH_COMMANDS_BIT, 0);
> +	pass = piglit_check_gl_error(GL_INVALID_VALUE) && pass;

I'm uncomfortable with this code: you never initialize 'b', so it gets a 
random value.  In theory, it's possible that it could get the same value 
as 'a', which would make it valid.  Extremely unlikely, yes.

Also, running this in a tool like valgrind would complain about the 
uninitialized value.  I'd just drop this part...

> +	mess1 = glClientWaitSync(c, GL_SYNC_FLUSH_COMMANDS_BIT, 0);
> +	pass = piglit_check_gl_error(GL_INVALID_VALUE) && pass;

...since I think the test with 'c' basically tests the same thing as 'b' 
anyway.

> +	//test valid flag values result in NO_ERROR (only one current option)
> +	mess1 = glClientWaitSync(a, GL_SYNC_FLUSH_COMMANDS_BIT, 0);
> +	pass = piglit_check_gl_error(GL_NO_ERROR) && pass;
> +
> +	//test that invalid flag value results in INVALID_VALUE
> +	for(i = 0; i < sizeof(GLbitfield) * 8; i++) {
> +		GLbitfield mask = 1 << i;
> +		if(i == GL_SYNC_FLUSH_COMMANDS_BIT) {
> +			continue;
> +		}
> +		mess1 = glClientWaitSync(a, GL_COLOR_BUFFER_BIT, 0);
> +		pass = piglit_check_gl_error(GL_INVALID_VALUE) && pass;
> +	}

Style-nit: you should put a space after "for" and "if".

More importantly, you're not actually using "mask" nor "i"...you're only 
passing GL_COLOR_BUFFER_BIT.  I think what you want is:

for (i = 0; i < sizeof(GLbitfield) * 8; i++) {
	GLbitfield mask = 1 << i;
	/* Skip over the one valid bit */
	if (i == GL_SYNC_FLUSH_COMMANDS_BIT) {
		continue;
	}
	mess1 = glClientWaitSync(a, mask, 0);
	pass = piglit_check_gl_error(GL_INVALID_VALUE) && pass;
}

> +
> +	glDeleteSync(a);
> +
> +	piglit_report_result(pass ? PIGLIT_PASS : PIGLIT_FAIL);
> +}
>