[Piglit] [PATCH 8/8] GL3.2 GL_ARB_sync: Test that the correct error messages are returned from invalid input for WaitSync

[Chad Versace]

On 10/07/2013 08:46 AM, Nicholas Mack wrote:
> v2: Fix comments, remove redundant code
>
> v3: Add to all.tests
> ---
>   tests/all.tests                       |  1 +
>   tests/spec/arb_sync/CMakeLists.gl.txt |  1 +
>   tests/spec/arb_sync/WaitSync-errors.c | 82 +++++++++++++++++++++++++++++++++++
>   3 files changed, 84 insertions(+)
>   create mode 100644 tests/spec/arb_sync/WaitSync-errors.c
>
> diff --git a/tests/all.tests b/tests/all.tests
> index e56ae38..f4c0079 100644
> --- a/tests/all.tests
> +++ b/tests/all.tests
> @@ -1108,6 +1108,7 @@ arb_sync['IsSync'] = concurrent_test('arb_sync-IsSync')
>   arb_sync['repeat-wait'] = concurrent_test('arb_sync-repeat-wait')
>   arb_sync['sync-initialize'] = concurrent_test('arb_sync-sync-initialize')
>   arb_sync['timeout-zero'] = concurrent_test('arb_sync-timeout-zero')
> +arb_sync['WaitSync-errors'] = concurrent_test('arb_sync-WaitSync-errors')
>   add_plain_test(arb_sync, 'sync_api')
>
>   # Group ARB_ES2_compatibility
> diff --git a/tests/spec/arb_sync/CMakeLists.gl.txt b/tests/spec/arb_sync/CMakeLists.gl.txt
> index 9855d69..5385fa0 100644
> --- a/tests/spec/arb_sync/CMakeLists.gl.txt
> +++ b/tests/spec/arb_sync/CMakeLists.gl.txt
> @@ -19,3 +19,4 @@ piglit_add_executable (arb_sync-is-sync IsSync.c)
>   piglit_add_executable (arb_sync-repeat-wait repeat-wait.c)
>   piglit_add_executable (arb_sync-sync-initialize sync-initialize.c)
>   piglit_add_executable (arb_sync-timeout-zero timeout-zero.c)
> +piglit_add_executable (arb_sync-WaitSync-errors WaitSync-errors.c)
> diff --git a/tests/spec/arb_sync/WaitSync-errors.c b/tests/spec/arb_sync/WaitSync-errors.c
> new file mode 100644
> index 0000000..a6f9976
> --- /dev/null
> +++ b/tests/spec/arb_sync/WaitSync-errors.c
> @@ -0,0 +1,82 @@
> +/**
> + * 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.
> + */
> +
> +/**

Add a \file command here.

> + * Test WaitSync() returns correct error codes
> + *
> + * 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 timeout is not TIMEOUT_IGNORED or flags is not zero, an
> + *  INVALID_VALUE error is generated."

Indent the spec quote.

> + *
> + */
> +
> +#include "piglit-util-gl-common.h"
> +
> +PIGLIT_GL_TEST_CONFIG_BEGIN
> +
> +config.supports_gl_compat_version = 10;
> +config.supports_gl_core_version = 31;

Indent the CONFIG block.

> +
> +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;
> +	GLsync b = (GLsync)20;

Please rename a,b to valid_sync,invalid_sync.

> +
> +	if (piglit_get_gl_version() < 32) {
> +		piglit_require_extension("GL_ARB_sync");
> +	}
> +
> +	a = glFenceSync(GL_SYNC_GPU_COMMANDS_COMPLETE, 0);
> +
> +	/* test that valid parameters passed results in NO_ERROR */
> +	glWaitSync(a, 0, GL_TIMEOUT_IGNORED);
> +	pass = piglit_check_gl_error(GL_NO_ERROR) && pass;
> +
> +	/* test that invalid sync results in INVALID_VALUE */
> +	glWaitSync(b, 0, GL_TIMEOUT_IGNORED);
> +	pass = piglit_check_gl_error(GL_INVALID_VALUE) && pass;
> +
> +	/* test that invalid flag value results in INVALID_VALUE */
> +	glWaitSync(a, 3, GL_TIMEOUT_IGNORED);
> +	pass = piglit_check_gl_error(GL_INVALID_VALUE) && pass;
> +
> +	/* test that invalid timeout value results in INVALID_VALUE */
> +	glWaitSync(a, 0, 15);
> +	pass = piglit_check_gl_error(GL_INVALID_VALUE) && pass;

Regarding the above testcase, it's actually correct to call glWaitSync(valid_sync, 0, 15).
The timeout parameter may legally be any value. When the timeout value is less than
UINT64_MAX, then the value specifies nanoseconds. When the timeout value is UINT64_MAX,
then the GL ignores the timeout and waits forever. As a convenience, the GL headers
define GL_TIMEOUT_IGNORED = UINT64_MAX.

Remove that testcase, and everything else looks correct and has my r-b.

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