Hash :
5313c8a8
Author :
Date :
2019-01-14T17:02:52
Implement EGL_KHR_fence_sync and EGL_KHR_wait_sync EGL_KHR_fence_sync introduces the EGLSync object and associated create/destroy/clientWait functions. EGL_KHR_wait_sync adds the serverWait function on top of that. Bug: angleproject:2466 Change-Id: Iebb239a85c4471ea18b3c3a8a83b793af555e31d Reviewed-on: https://chromium-review.googlesource.com/c/1412261 Commit-Queue: Shahbaz Youssefi <syoussefi@chromium.org> Reviewed-by: Geoff Lang <geofflang@chromium.org> Reviewed-by: Jamie Madill <jmadill@chromium.org>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
//
// Copyright 2019 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// EGLSyncTest.cpp:
// Tests of EGL_KHR_fence_sync and EGL_KHR_wait_sync extensions.
#include <gtest/gtest.h>
#include "test_utils/ANGLETest.h"
#include "test_utils/angle_test_configs.h"
#include "util/EGLWindow.h"
using namespace angle;
class EGLSyncTest : public ANGLETest
{
protected:
bool hasFenceSyncExtension() const
{
return eglDisplayExtensionEnabled(getEGLWindow()->getDisplay(), "EGL_KHR_fence_sync");
}
bool hasWaitSyncExtension() const
{
return hasFenceSyncExtension() &&
eglDisplayExtensionEnabled(getEGLWindow()->getDisplay(), "EGL_KHR_wait_sync");
}
bool hasGLSyncExtension() const { return extensionEnabled("GL_OES_EGL_sync"); }
};
// Test error cases for all EGL_KHR_fence_sync functions
TEST_P(EGLSyncTest, FenceSyncErrors)
{
ANGLE_SKIP_TEST_IF(!hasFenceSyncExtension());
EGLDisplay display = getEGLWindow()->getDisplay();
// If the client API doesn't have the necessary extension, test that sync creation fails and
// ignore the rest of the tests.
if (!hasGLSyncExtension())
{
EXPECT_EQ(EGL_NO_SYNC_KHR, eglCreateSyncKHR(display, EGL_SYNC_FENCE_KHR, nullptr));
EXPECT_EGL_ERROR(EGL_BAD_MATCH);
}
ANGLE_SKIP_TEST_IF(!hasGLSyncExtension());
EGLContext context = eglGetCurrentContext();
EGLSurface drawSurface = eglGetCurrentSurface(EGL_DRAW);
EGLSurface readSurface = eglGetCurrentSurface(EGL_READ);
EXPECT_NE(context, EGL_NO_CONTEXT);
EXPECT_NE(drawSurface, EGL_NO_SURFACE);
EXPECT_NE(readSurface, EGL_NO_SURFACE);
// CreateSync with no attribute shouldn't cause an error
EGLSyncKHR sync = eglCreateSyncKHR(display, EGL_SYNC_FENCE_KHR, nullptr);
EXPECT_NE(sync, EGL_NO_SYNC_KHR);
EXPECT_EGL_TRUE(eglDestroySyncKHR(display, sync));
// CreateSync with empty attribute shouldn't cause an error
const EGLint emptyAttributes[] = {EGL_NONE};
sync = eglCreateSyncKHR(display, EGL_SYNC_FENCE_KHR, emptyAttributes);
EXPECT_NE(sync, EGL_NO_SYNC_KHR);
// DestroySync generates BAD_PARAMETER if the sync is not valid
EXPECT_EGL_FALSE(eglDestroySyncKHR(display, reinterpret_cast<EGLSyncKHR>(20)));
EXPECT_EGL_ERROR(EGL_BAD_PARAMETER);
// CreateSync generates BAD_DISPLAY if display is not valid
EXPECT_EQ(EGL_NO_SYNC_KHR, eglCreateSyncKHR(EGL_NO_DISPLAY, EGL_SYNC_FENCE_KHR, nullptr));
EXPECT_EGL_ERROR(EGL_BAD_DISPLAY);
// CreateSync generates BAD_ATTRIBUTE if attribute is neither nullptr nor empty.
const EGLint nonEmptyAttributes[] = {
EGL_CL_EVENT_HANDLE,
0,
EGL_NONE,
};
EXPECT_EQ(EGL_NO_SYNC_KHR, eglCreateSyncKHR(display, EGL_SYNC_FENCE_KHR, nonEmptyAttributes));
EXPECT_EGL_ERROR(EGL_BAD_ATTRIBUTE);
// CreateSync generates BAD_ATTRIBUTE if type is not valid
EXPECT_EQ(EGL_NO_SYNC_KHR, eglCreateSyncKHR(display, 0, nullptr));
EXPECT_EGL_ERROR(EGL_BAD_ATTRIBUTE);
// CreateSync generates BAD_MATCH if no context is current
eglMakeCurrent(display, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
EXPECT_EQ(EGL_NO_SYNC_KHR, eglCreateSyncKHR(display, EGL_SYNC_FENCE_KHR, nullptr));
EXPECT_EGL_ERROR(EGL_BAD_MATCH);
eglMakeCurrent(display, drawSurface, readSurface, context);
// ClientWaitSync generates EGL_BAD_PARAMETER if the sync object is not valid
EXPECT_EGL_FALSE(eglClientWaitSyncKHR(display, reinterpret_cast<EGLSyncKHR>(30), 0, 0));
EXPECT_EGL_ERROR(EGL_BAD_PARAMETER);
// GetSyncAttrib generates EGL_BAD_PARAMETER if the sync object is not valid, and value is not
// modified
constexpr EGLint kSentinelAttribValue = 123456789;
EGLint attribValue = kSentinelAttribValue;
EXPECT_EGL_FALSE(eglGetSyncAttribKHR(display, reinterpret_cast<EGLSyncKHR>(40),
EGL_SYNC_TYPE_KHR, &attribValue));
EXPECT_EGL_ERROR(EGL_BAD_PARAMETER);
EXPECT_EQ(attribValue, kSentinelAttribValue);
// GetSyncAttrib generates EGL_BAD_ATTRIBUTE if the attribute is not valid, and value is not
// modified
EXPECT_EGL_FALSE(eglGetSyncAttribKHR(display, sync, EGL_CL_EVENT_HANDLE, &attribValue));
EXPECT_EGL_ERROR(EGL_BAD_ATTRIBUTE);
EXPECT_EQ(attribValue, kSentinelAttribValue);
// GetSyncAttrib generates EGL_BAD_MATCH if the attribute is valid for sync, but not the
// particular sync type. We don't have such a case at the moment.
EXPECT_EGL_TRUE(eglDestroySyncKHR(display, sync));
}
// Test error cases for all EGL_KHR_wait_sync functions
TEST_P(EGLSyncTest, WaitSyncErrors)
{
// The client API that shows support for eglWaitSyncKHR is the same as the one required for
// eglCreateSyncKHR. As such, there is no way to create a sync and not be able to wait on it.
// This would have created an EGL_BAD_MATCH error.
ANGLE_SKIP_TEST_IF(!hasWaitSyncExtension() || !hasGLSyncExtension());
EGLDisplay display = getEGLWindow()->getDisplay();
EGLContext context = eglGetCurrentContext();
EGLSurface drawSurface = eglGetCurrentSurface(EGL_DRAW);
EGLSurface readSurface = eglGetCurrentSurface(EGL_READ);
EXPECT_NE(context, EGL_NO_CONTEXT);
EXPECT_NE(drawSurface, EGL_NO_SURFACE);
EXPECT_NE(readSurface, EGL_NO_SURFACE);
EGLSyncKHR sync = eglCreateSyncKHR(display, EGL_SYNC_FENCE_KHR, nullptr);
EXPECT_NE(sync, EGL_NO_SYNC_KHR);
// WaitSync generates BAD_MATCH if no context is current
eglMakeCurrent(display, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
EXPECT_EGL_FALSE(eglWaitSyncKHR(display, sync, 0));
EXPECT_EGL_ERROR(EGL_BAD_MATCH);
eglMakeCurrent(display, drawSurface, readSurface, context);
// WaitSync generates BAD_PARAMETER if the sync is not valid
EXPECT_EGL_FALSE(eglWaitSyncKHR(display, reinterpret_cast<EGLSyncKHR>(20), 0));
EXPECT_EGL_ERROR(EGL_BAD_PARAMETER);
// WaitSync generates BAD_PARAMETER if flags is non-zero
EXPECT_EGL_FALSE(eglWaitSyncKHR(display, sync, 1));
EXPECT_EGL_ERROR(EGL_BAD_PARAMETER);
EXPECT_EGL_TRUE(eglDestroySyncKHR(display, sync));
}
// Test usage of eglGetSyncAttribKHR
TEST_P(EGLSyncTest, GetSyncAttrib)
{
ANGLE_SKIP_TEST_IF(!hasFenceSyncExtension() || !hasGLSyncExtension());
EGLDisplay display = getEGLWindow()->getDisplay();
EGLSyncKHR sync = eglCreateSyncKHR(display, EGL_SYNC_FENCE_KHR, nullptr);
EXPECT_NE(sync, EGL_NO_SYNC_KHR);
// Fence sync attributes are:
//
// EGL_SYNC_TYPE_KHR: EGL_SYNC_FENCE_KHR
// EGL_SYNC_STATUS_KHR: EGL_UNSIGNALED_KHR or EGL_SIGNALED_KHR
// EGL_SYNC_CONDITION_KHR: EGL_SYNC_PRIOR_COMMANDS_COMPLETE_KHR
constexpr EGLint kSentinelAttribValue = 123456789;
EGLint attribValue = kSentinelAttribValue;
EXPECT_EGL_TRUE(eglGetSyncAttribKHR(display, sync, EGL_SYNC_TYPE_KHR, &attribValue));
EXPECT_EQ(attribValue, EGL_SYNC_FENCE_KHR);
attribValue = kSentinelAttribValue;
EXPECT_EGL_TRUE(eglGetSyncAttribKHR(display, sync, EGL_SYNC_CONDITION_KHR, &attribValue));
EXPECT_EQ(attribValue, EGL_SYNC_PRIOR_COMMANDS_COMPLETE_KHR);
attribValue = kSentinelAttribValue;
EXPECT_EGL_TRUE(eglGetSyncAttribKHR(display, sync, EGL_SYNC_STATUS_KHR, &attribValue));
// Hack around EXPECT_* not having an "either this or that" variant:
if (attribValue != EGL_SIGNALED_KHR)
{
EXPECT_EQ(attribValue, EGL_UNSIGNALED_KHR);
}
EXPECT_EGL_TRUE(eglDestroySyncKHR(display, sync));
}
// Test that basic usage works and doesn't generate errors or crash
TEST_P(EGLSyncTest, BasicOperations)
{
ANGLE_SKIP_TEST_IF(!hasFenceSyncExtension() || !hasGLSyncExtension());
EGLDisplay display = getEGLWindow()->getDisplay();
EGLSyncKHR sync = eglCreateSyncKHR(display, EGL_SYNC_FENCE_KHR, nullptr);
EXPECT_NE(sync, EGL_NO_SYNC_KHR);
glClearColor(1.0f, 0.0f, 1.0f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT);
EXPECT_EGL_TRUE(eglWaitSyncKHR(display, sync, 0));
glFlush();
EGLint value = 0;
unsigned int loopCount = 0;
// Use 'loopCount' to make sure the test doesn't get stuck in an infinite loop
while (value != EGL_SIGNALED_KHR && loopCount <= 1000000)
{
loopCount++;
EXPECT_EGL_TRUE(eglGetSyncAttribKHR(display, sync, EGL_SYNC_STATUS_KHR, &value));
}
ASSERT_EQ(value, EGL_SIGNALED_KHR);
for (size_t i = 0; i < 20; i++)
{
glClear(GL_COLOR_BUFFER_BIT);
EXPECT_EQ(
EGL_CONDITION_SATISFIED_KHR,
eglClientWaitSyncKHR(display, sync, EGL_SYNC_FLUSH_COMMANDS_BIT_KHR, EGL_FOREVER_KHR));
EXPECT_EGL_TRUE(eglGetSyncAttribKHR(display, sync, EGL_SYNC_STATUS_KHR, &value));
EXPECT_EQ(value, EGL_SIGNALED_KHR);
}
EXPECT_EGL_TRUE(eglDestroySyncKHR(display, sync));
}
ANGLE_INSTANTIATE_TEST(EGLSyncTest,
ES2_D3D9(),
ES2_D3D11(),
ES3_D3D11(),
ES2_OPENGL(),
ES3_OPENGL(),
ES2_OPENGLES(),
ES3_OPENGLES(),
ES2_VULKAN(),
ES3_VULKAN());