Merge vk-gl-cts/vulkan-cts-1.1.2 into vk-gl-cts/vulkan-cts-1.1.3
[platform/upstream/VK-GL-CTS.git] / modules / egl / teglGetFrameTimestampsTests.cpp
1 /*-------------------------------------------------------------------------
2  * drawElements Quality Program EGL Module
3  * ---------------------------------------
4  *
5  * Copyright 2017 The Android Open Source Project
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  *//*!
20  * \file
21  * \brief Test the EGL_ANDROID_get_frame_timestamps extension.
22  *//*--------------------------------------------------------------------*/
23
24 #include "teglGetFrameTimestampsTests.hpp"
25
26 #include "teglSimpleConfigCase.hpp"
27
28 #include "egluNativeWindow.hpp"
29 #include "egluUtil.hpp"
30 #include "egluUnique.hpp"
31 #include "eglwLibrary.hpp"
32 #include "eglwEnums.hpp"
33
34 #include "gluDefs.hpp"
35 #include "glwEnums.hpp"
36 #include "glwFunctions.hpp"
37
38 #include "tcuResultCollector.hpp"
39 #include "tcuTestLog.hpp"
40 #include "tcuSurface.hpp"
41 #include "tcuTexture.hpp"
42 #include "tcuTextureUtil.hpp"
43 #include "tcuImageCompare.hpp"
44 #include "tcuVector.hpp"
45 #include "tcuVectorUtil.hpp"
46
47 #include "deClock.h"
48 #include "deMath.h"
49 #include "deUniquePtr.hpp"
50 #include "deStringUtil.hpp"
51 #include "deThread.hpp"
52
53 #include <algorithm>
54 #include <string>
55 #include <vector>
56 #include <sstream>
57
58 // Tentative EGL header definitions for EGL_ANDROID_get_Frame_timestamps.
59 // \todo [2017-01-25 brianderson] Remove once defined in the official headers.
60 #define EGL_TIMESTAMPS_ANDROID 0x3430
61 #define EGL_COMPOSITE_DEADLINE_ANDROID 0x3431
62 #define EGL_COMPOSITE_INTERVAL_ANDROID 0x3432
63 #define EGL_COMPOSITE_TO_PRESENT_LATENCY_ANDROID 0x3433
64 #define EGL_REQUESTED_PRESENT_TIME_ANDROID 0x3434
65 #define EGL_RENDERING_COMPLETE_TIME_ANDROID 0x3435
66 #define EGL_COMPOSITION_LATCH_TIME_ANDROID 0x3436
67 #define EGL_FIRST_COMPOSITION_START_TIME_ANDROID 0x3437
68 #define EGL_LAST_COMPOSITION_START_TIME_ANDROID 0x3438
69 #define EGL_FIRST_COMPOSITION_GPU_FINISHED_TIME_ANDROID 0x3439
70 #define EGL_DISPLAY_PRESENT_TIME_ANDROID 0x343A
71 #define EGL_DEQUEUE_READY_TIME_ANDROID 0x343B
72 #define EGL_READS_DONE_TIME_ANDROID 0x343C
73 typedef deInt64 EGLnsecsANDROID;
74 typedef deUint64 EGLuint64KHR;
75 #define EGL_TIMESTAMP_PENDING_ANDROID (-2)
76 #define EGL_TIMESTAMP_INVALID_ANDROID (-1)
77 typedef EGLW_APICALL eglw::EGLBoolean (EGLW_APIENTRY* eglGetNextFrameIdANDROIDFunc) (eglw::EGLDisplay dpy, eglw::EGLSurface surface, EGLuint64KHR *frameId);
78 typedef EGLW_APICALL eglw::EGLBoolean (EGLW_APIENTRY* eglGetCompositorTimingANDROIDFunc) (eglw::EGLDisplay dpy, eglw::EGLSurface surface, eglw::EGLint numTimestamps, const eglw::EGLint *names, EGLnsecsANDROID *values);
79 typedef EGLW_APICALL eglw::EGLBoolean (EGLW_APIENTRY* eglGetCompositorTimingSupportedANDROIDFunc) (eglw::EGLDisplay dpy, eglw::EGLSurface surface, eglw::EGLint name);
80 typedef EGLW_APICALL eglw::EGLBoolean (EGLW_APIENTRY* eglGetFrameTimestampsANDROIDFunc) (eglw::EGLDisplay dpy, eglw::EGLSurface surface, EGLuint64KHR frameId, eglw::EGLint numTimestamps, const eglw::EGLint *timestamps, EGLnsecsANDROID *values);
81 typedef EGLW_APICALL eglw::EGLBoolean (EGLW_APIENTRY* eglGetFrameTimestampSupportedANDROIDFunc) (eglw::EGLDisplay dpy, eglw::EGLSurface surface, eglw::EGLint timestamp);
82
83 #define CHECK_NAKED_EGL_CALL(EGLW, CALL)        do { CALL; eglu::checkError((EGLW).getError(), #CALL, __FILE__, __LINE__); } while (deGetFalse())
84
85 namespace deqp
86 {
87 namespace egl
88 {
89
90 using tcu::TestLog;
91 using std::string;
92 using std::vector;
93 using namespace eglw;
94
95 namespace
96 {
97
98 // Careful: This has microsecond precision, which can cause timestamps to
99 // appear non monotonic when compared to the nanosecond precision timestamps
100 // we get from the eglGetFrameTimestamps extension.
101 // Current test expectations only make sure microsecond precision timestamps
102 // are less than the nanosecond precision timestamps, so this is okay.
103 EGLnsecsANDROID getNanoseconds (void)
104 {
105         return deGetMicroseconds() * 1000;
106 }
107
108 struct FrameTimes
109 {
110         FrameTimes (void)
111                 : frameId                                               (-1)
112                 , swapBufferBeginNs                             (-1)
113                 , compositeDeadline                             (-1)
114                 , compositeInterval                             (-1)
115                 , compositeToPresentLatency             (-1)
116                 , requestedPresent                              (-1)
117                 , latch                                                 (-1)
118                 , firstCompositionStart                 (-1)
119                 , lastCompositionStart                  (-1)
120                 , dequeueReady                                  (-1)
121                 , renderingComplete                             (-1)
122                 , firstCompositionGpuFinished   (-1)
123                 , displayPresent                                (-1)
124                 , readsDone                                             (-1)
125         {
126         }
127
128         EGLuint64KHR    frameId;
129
130         // Timestamps sampled by the test.
131         EGLnsecsANDROID swapBufferBeginNs;
132
133         // Compositor info.
134         EGLnsecsANDROID compositeDeadline;
135         EGLnsecsANDROID compositeInterval;
136         EGLnsecsANDROID compositeToPresentLatency;
137
138         // CPU Timeline.
139         EGLnsecsANDROID requestedPresent;
140         EGLnsecsANDROID latch;
141         EGLnsecsANDROID firstCompositionStart;
142         EGLnsecsANDROID lastCompositionStart;
143         EGLnsecsANDROID dequeueReady;
144
145         // GPU Timeline.
146         EGLnsecsANDROID renderingComplete;
147         EGLnsecsANDROID firstCompositionGpuFinished;
148         EGLnsecsANDROID displayPresent;
149         EGLnsecsANDROID readsDone;
150 };
151
152
153 struct TimestampInfo
154 {
155         TimestampInfo()
156                 : required(false)
157                 , supported(false)
158                 , supportedIndex(0)
159         {
160         }
161
162         TimestampInfo(bool required_, bool supported_, size_t supportedIndex_)
163                 : required(required_)
164                 , supported(supported_)
165                 , supportedIndex(supportedIndex_)
166         {
167         }
168
169         bool    required;
170         bool    supported;
171         size_t  supportedIndex;
172 };
173
174 typedef std::map<eglw::EGLint, TimestampInfo> TimestampInfoMap;
175
176 EGLnsecsANDROID getTimestamp(eglw::EGLint name, TimestampInfoMap& map, const std::vector<EGLnsecsANDROID>& supportedValues)
177 {
178         TimestampInfo& info = map[name];
179         return info.supported ? supportedValues[info.supportedIndex] : EGL_TIMESTAMP_INVALID_ANDROID;
180 }
181
182 void populateFrameTimes(FrameTimes* frameTimes, TimestampInfoMap& map, const std::vector<EGLnsecsANDROID>& supportedValues)
183 {
184         frameTimes->requestedPresent                    =       getTimestamp(EGL_REQUESTED_PRESENT_TIME_ANDROID, map, supportedValues);
185         frameTimes->renderingComplete                   =       getTimestamp(EGL_RENDERING_COMPLETE_TIME_ANDROID, map, supportedValues);
186         frameTimes->latch                                               =       getTimestamp(EGL_COMPOSITION_LATCH_TIME_ANDROID, map, supportedValues);
187         frameTimes->firstCompositionStart               =       getTimestamp(EGL_FIRST_COMPOSITION_START_TIME_ANDROID, map, supportedValues);
188         frameTimes->lastCompositionStart                =       getTimestamp(EGL_LAST_COMPOSITION_START_TIME_ANDROID, map, supportedValues);
189         frameTimes->firstCompositionGpuFinished =       getTimestamp(EGL_FIRST_COMPOSITION_GPU_FINISHED_TIME_ANDROID, map, supportedValues);
190         frameTimes->displayPresent                              =       getTimestamp(EGL_DISPLAY_PRESENT_TIME_ANDROID, map, supportedValues);
191         frameTimes->dequeueReady                                =       getTimestamp(EGL_DEQUEUE_READY_TIME_ANDROID, map, supportedValues);
192         frameTimes->readsDone                                   =       getTimestamp(EGL_READS_DONE_TIME_ANDROID, map, supportedValues);
193 }
194
195 bool timestampValid (EGLnsecsANDROID timestamp)
196 {
197         // \todo [2017-10-19 brianderson] Don't consider 0 invalid once kernel fix is in.
198         return (timestamp > 0) || (timestamp == EGL_TIMESTAMP_PENDING_ANDROID);
199 }
200
201 bool timestampPending (EGLnsecsANDROID timestamp)
202 {
203         return timestamp == EGL_TIMESTAMP_PENDING_ANDROID;
204 }
205
206 template<typename T>
207 void check_lt(tcu::ResultCollector& result, const T& a, const T& b, const std::string& msg) {
208         if (a < b)
209                 return;
210         std::string m = msg + "!(" + de::toString(a) + " < " + de::toString(b) + ")";
211         result.fail(m);
212 }
213
214 template<typename T>
215 void check_le(tcu::ResultCollector& result, const T& a, const T& b, const std::string& msg) {
216         if (a <= b)
217                 return;
218         std::string m = msg + "!(" + de::toString(a) + " <= " + de::toString(b) + ")";
219         result.fail(m);
220 }
221
222 void verifySingleFrame (const FrameTimes& frameTimes, tcu::ResultCollector& result, bool verifyReadsDone)
223 {
224         // Verify CPU timeline is monotonic.
225         check_lt(result, frameTimes.swapBufferBeginNs, frameTimes.latch, "Buffer latched before it was swapped.");
226         check_lt(result, frameTimes.latch, frameTimes.firstCompositionStart, "Buffer composited before it was latched.");
227         check_le(result, frameTimes.firstCompositionStart, frameTimes.lastCompositionStart, "First composition start after last composition start.");
228         check_lt(result, frameTimes.lastCompositionStart, frameTimes.dequeueReady, "Buffer composited after it was ready to be dequeued.");
229
230         // Verify GPU timeline is monotonic.
231         if (timestampValid(frameTimes.firstCompositionGpuFinished))
232                 check_lt(result, frameTimes.renderingComplete, frameTimes.firstCompositionGpuFinished, "Buffer rendering completed after compositor GPU work finished.");
233
234         if (timestampValid(frameTimes.displayPresent))
235                 check_lt(result, frameTimes.renderingComplete, frameTimes.displayPresent, "Buffer displayed before rendering completed.");
236
237         if (timestampValid(frameTimes.firstCompositionGpuFinished) && timestampValid(frameTimes.displayPresent))
238                 check_lt(result, frameTimes.firstCompositionGpuFinished, frameTimes.displayPresent, "Buffer displayed before compositor GPU work completed");
239
240         // Drivers may maintain shadow copies of the buffer, so the readsDone time
241         // of the real buffer may be earlier than apparent dependencies. We can only
242         // be sure that the readsDone time must be after the renderingComplete time.
243     // It may also be equal to the renderingComplete time if no reads were
244     // peformed.
245         if (verifyReadsDone && timestampValid(frameTimes.readsDone))
246                 check_le(result, frameTimes.renderingComplete, frameTimes.readsDone, "Buffer rendering completed after reads completed.");
247
248         // Verify CPU/GPU dependencies
249         if (timestampValid(frameTimes.firstCompositionGpuFinished))
250                 check_lt(result, frameTimes.firstCompositionStart, frameTimes.firstCompositionGpuFinished, "Composition CPU work started after GPU work finished.");
251
252         if (timestampValid(frameTimes.displayPresent))
253                 check_lt(result, frameTimes.firstCompositionStart, frameTimes.displayPresent, "Buffer displayed before it was composited.");
254 }
255
256 void verifyNeighboringFrames (const FrameTimes& frame1, const FrameTimes& frame2, tcu::ResultCollector& result)
257 {
258         // CPU timeline.
259         check_lt(result, frame1.swapBufferBeginNs, frame2.swapBufferBeginNs, "Swap begin times not monotonic.");
260         check_lt(result, frame1.latch, frame2.latch, "Latch times not monotonic.");
261         check_lt(result, frame1.lastCompositionStart, frame2.latch, "Old buffer composited after new buffer latched.");
262         check_lt(result, frame1.lastCompositionStart, frame2.firstCompositionStart, "Composition times overlap.");
263         check_lt(result, frame1.dequeueReady, frame2.dequeueReady, "Dequeue ready times not monotonic.");
264
265         // GPU timeline.
266         // Same rendering complete time is fine.
267         check_le(result, frame1.renderingComplete, frame2.renderingComplete, "Rendering complete times not monotonic.");
268
269         if (timestampValid(frame1.firstCompositionGpuFinished) && timestampValid(frame2.firstCompositionGpuFinished))
270                 check_lt(result, frame1.firstCompositionGpuFinished, frame2.firstCompositionGpuFinished, "Composition GPU work complete times not monotonic.");
271
272         if (timestampValid(frame1.displayPresent) && timestampValid(frame2.displayPresent))
273                 check_lt(result, frame1.displayPresent, frame2.displayPresent, "Display present times not monotonic.");
274 }
275
276 EGLContext createGLES2Context (const Library& egl, EGLDisplay display, EGLConfig config)
277 {
278         EGLContext              context = EGL_NO_CONTEXT;
279         const EGLint    attribList[] =
280         {
281                 EGL_CONTEXT_CLIENT_VERSION, 2,
282                 EGL_NONE
283         };
284
285         EGLU_CHECK_CALL(egl, bindAPI(EGL_OPENGL_ES_API));
286
287         context = egl.createContext(display, config, EGL_NO_CONTEXT, attribList);
288         EGLU_CHECK_MSG(egl, "eglCreateContext() failed");
289         TCU_CHECK(context);
290
291         return context;
292 }
293
294 class GetFrameTimestampTest : public SimpleConfigCase
295 {
296 public:
297                                                         GetFrameTimestampTest   (EglTestContext& eglTestCtx, const NamedFilterList& filters);
298                                                         ~GetFrameTimestampTest  (void);
299
300 private:
301         void                                    executeForConfig                (EGLDisplay display, EGLConfig config);
302         void                                    initializeExtension             (const Library& egl);
303
304         // Not allowed
305                                                         GetFrameTimestampTest   (const GetFrameTimestampTest&);
306         GetFrameTimestampTest&  operator=                               (const GetFrameTimestampTest&);
307
308         // TODO: Move these to eglw::Library.
309         eglGetNextFrameIdANDROIDFunc                            m_eglGetNextFrameIdANDROID;
310         eglGetCompositorTimingANDROIDFunc                       m_eglGetCompositorTimingANDROID;
311         eglGetCompositorTimingSupportedANDROIDFunc      m_eglGetCompositorTimingSupportedANDROID;
312         eglGetFrameTimestampsANDROIDFunc                        m_eglGetFrameTimestampsANDROID;
313         eglGetFrameTimestampSupportedANDROIDFunc        m_eglGetFrameTimestampSupportedANDROID;
314
315         tcu::ResultCollector                                            m_result;
316 };
317
318 GetFrameTimestampTest::GetFrameTimestampTest (EglTestContext& eglTestCtx, const NamedFilterList& filters)
319         : SimpleConfigCase                                                      (eglTestCtx, filters.getName(), filters.getDescription(), filters)
320         , m_eglGetNextFrameIdANDROID                            (DE_NULL)
321         , m_eglGetCompositorTimingANDROID                       (DE_NULL)
322         , m_eglGetCompositorTimingSupportedANDROID      (DE_NULL)
323         , m_eglGetFrameTimestampsANDROID                        (DE_NULL)
324         , m_eglGetFrameTimestampSupportedANDROID        (DE_NULL)
325         , m_result                                                                      (m_testCtx.getLog())
326 {
327 }
328
329 GetFrameTimestampTest::~GetFrameTimestampTest (void)
330 {
331 }
332
333 void GetFrameTimestampTest::initializeExtension (const Library& egl)
334 {
335         m_eglGetNextFrameIdANDROID = reinterpret_cast<eglGetNextFrameIdANDROIDFunc>(egl.getProcAddress("eglGetNextFrameIdANDROID"));
336         EGLU_CHECK_MSG(egl, "getProcAddress of eglGetNextFrameIdANDROID failed.");
337         m_eglGetCompositorTimingANDROID = reinterpret_cast<eglGetCompositorTimingANDROIDFunc>(egl.getProcAddress("eglGetCompositorTimingANDROID"));
338         EGLU_CHECK_MSG(egl, "getProcAddress of eglGetCompositorTimingANDROID failed.");
339         m_eglGetCompositorTimingSupportedANDROID = reinterpret_cast<eglGetCompositorTimingSupportedANDROIDFunc>(egl.getProcAddress("eglGetCompositorTimingSupportedANDROID"));
340         EGLU_CHECK_MSG(egl, "getProcAddress of eglGetCompositorTimingSupportedANDROID failed.");
341         m_eglGetFrameTimestampsANDROID = reinterpret_cast<eglGetFrameTimestampsANDROIDFunc>(egl.getProcAddress("eglGetFrameTimestampsANDROID"));
342         EGLU_CHECK_MSG(egl, "getProcAddress of eglGetFrameTimestampsANDROID failed.");
343         m_eglGetFrameTimestampSupportedANDROID = reinterpret_cast<eglGetFrameTimestampSupportedANDROIDFunc>(egl.getProcAddress("eglGetFrameTimestampSupportedANDROID"));
344         EGLU_CHECK_MSG(egl, "getProcAddress of eglGetFrameTimestampSupportedANDROID failed.");
345 }
346
347
348 string getConfigIdString (const Library& egl, EGLDisplay display, EGLConfig config)
349 {
350         std::ostringstream      stream;
351         EGLint                          id;
352
353         EGLU_CHECK_CALL(egl, getConfigAttrib(display, config , EGL_CONFIG_ID, &id));
354
355         stream << id;
356
357         return stream.str();
358 }
359
360 deUint32 createGLES2Program (const glw::Functions& gl, TestLog& log)
361 {
362         const char* const vertexShaderSource =
363         "attribute highp vec2 a_pos;\n"
364         "void main (void)\n"
365         "{\n"
366         "\tgl_Position = vec4(a_pos, 0.0, 1.0);\n"
367         "}";
368
369         const char* const fragmentShaderSource =
370         "void main (void)\n"
371         "{\n"
372         "\tgl_FragColor = vec4(0.9, 0.1, 0.4, 1.0);\n"
373         "}";
374
375         deUint32        program                 = 0;
376         deUint32        vertexShader    = 0;
377         deUint32        fragmentShader  = 0;
378
379         deInt32         vertexCompileStatus;
380         string          vertexInfoLog;
381         deInt32         fragmentCompileStatus;
382         string          fragmentInfoLog;
383         deInt32         linkStatus;
384         string          programInfoLog;
385
386         try
387         {
388                 program                 = gl.createProgram();
389                 vertexShader    = gl.createShader(GL_VERTEX_SHADER);
390                 fragmentShader  = gl.createShader(GL_FRAGMENT_SHADER);
391
392                 GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to create shaders and program");
393
394                 gl.shaderSource(vertexShader, 1, &vertexShaderSource, DE_NULL);
395                 gl.compileShader(vertexShader);
396                 GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to setup vertex shader");
397
398                 gl.shaderSource(fragmentShader, 1, &fragmentShaderSource, DE_NULL);
399                 gl.compileShader(fragmentShader);
400                 GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to setup fragment shader");
401
402                 {
403                         deInt32         infoLogLength = 0;
404
405                         gl.getShaderiv(vertexShader, GL_COMPILE_STATUS, &vertexCompileStatus);
406                         gl.getShaderiv(vertexShader, GL_INFO_LOG_LENGTH, &infoLogLength);
407
408                         vertexInfoLog.resize(infoLogLength, '\0');
409
410                         gl.getShaderInfoLog(vertexShader, (glw::GLsizei)vertexInfoLog.length(), &infoLogLength, &(vertexInfoLog[0]));
411                         GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to get vertex shader compile info");
412
413                         vertexInfoLog.resize(infoLogLength);
414                 }
415
416                 {
417                         deInt32         infoLogLength = 0;
418
419                         gl.getShaderiv(fragmentShader, GL_COMPILE_STATUS, &fragmentCompileStatus);
420                         gl.getShaderiv(fragmentShader, GL_INFO_LOG_LENGTH, &infoLogLength);
421
422                         fragmentInfoLog.resize(infoLogLength, '\0');
423
424                         gl.getShaderInfoLog(fragmentShader, (glw::GLsizei)fragmentInfoLog.length(), &infoLogLength, &(fragmentInfoLog[0]));
425                         GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to get fragment shader compile info");
426
427                         fragmentInfoLog.resize(infoLogLength);
428                 }
429
430                 gl.attachShader(program, vertexShader);
431                 gl.attachShader(program, fragmentShader);
432                 gl.linkProgram(program);
433                 GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to setup program");
434
435                 {
436                         deInt32         infoLogLength = 0;
437
438                         gl.getProgramiv(program, GL_LINK_STATUS, &linkStatus);
439                         gl.getProgramiv(program, GL_INFO_LOG_LENGTH, &infoLogLength);
440
441                         programInfoLog.resize(infoLogLength, '\0');
442
443                         gl.getProgramInfoLog(program, (glw::GLsizei)programInfoLog.length(), &infoLogLength, &(programInfoLog[0]));
444                         GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to get program link info");
445
446                         programInfoLog.resize(infoLogLength);
447                 }
448
449                 if (linkStatus == 0 || vertexCompileStatus == 0 || fragmentCompileStatus == 0)
450                 {
451
452                         log.startShaderProgram(linkStatus != 0, programInfoLog.c_str());
453
454                         log << TestLog::Shader(QP_SHADER_TYPE_VERTEX, vertexShaderSource, vertexCompileStatus != 0, vertexInfoLog);
455                         log << TestLog::Shader(QP_SHADER_TYPE_FRAGMENT, fragmentShaderSource, fragmentCompileStatus != 0, fragmentInfoLog);
456
457                         log.endShaderProgram();
458                 }
459
460                 gl.deleteShader(vertexShader);
461                 gl.deleteShader(fragmentShader);
462                 GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to delete shaders");
463
464                 TCU_CHECK(linkStatus != 0 && vertexCompileStatus != 0 && fragmentCompileStatus != 0);
465         }
466         catch (...)
467         {
468                 if (program)
469                         gl.deleteProgram(program);
470
471                 if (vertexShader)
472                         gl.deleteShader(vertexShader);
473
474                 if (fragmentShader)
475                         gl.deleteShader(fragmentShader);
476
477                 throw;
478         }
479
480         return program;
481 }
482
483 void GetFrameTimestampTest::executeForConfig (EGLDisplay display, EGLConfig config)
484 {
485         const Library&                                          egl                     = m_eglTestCtx.getLibrary();
486
487         if (!eglu::hasExtension(egl, display, "EGL_ANDROID_get_frame_timestamps"))
488                 TCU_THROW(NotSupportedError, "EGL_ANDROID_get_frame_timestamps is not supported");
489
490         initializeExtension(egl);
491
492         const string                                            configIdStr     (getConfigIdString(egl, display, config));
493         tcu::ScopedLogSection                           logSection      (m_testCtx.getLog(), ("Config ID " + configIdStr).c_str(), ("Config ID " + configIdStr).c_str());
494         const eglu::NativeWindowFactory&        factory         = eglu::selectNativeWindowFactory(m_eglTestCtx.getNativeDisplayFactory(), m_testCtx.getCommandLine());
495
496         {
497                 TestLog& log = m_testCtx.getLog();
498
499                 log << TestLog::Message << "EGL_RED_SIZE: "             << eglu::getConfigAttribInt(egl, display, config, EGL_RED_SIZE)         << TestLog::EndMessage;
500                 log << TestLog::Message << "EGL_GREEN_SIZE: "   << eglu::getConfigAttribInt(egl, display, config, EGL_GREEN_SIZE)       << TestLog::EndMessage;
501                 log << TestLog::Message << "EGL_BLUE_SIZE: "    << eglu::getConfigAttribInt(egl, display, config, EGL_BLUE_SIZE)        << TestLog::EndMessage;
502                 log << TestLog::Message << "EGL_ALPHA_SIZE: "   << eglu::getConfigAttribInt(egl, display, config, EGL_ALPHA_SIZE)       << TestLog::EndMessage;
503                 log << TestLog::Message << "EGL_DEPTH_SIZE: "   << eglu::getConfigAttribInt(egl, display, config, EGL_DEPTH_SIZE)       << TestLog::EndMessage;
504                 log << TestLog::Message << "EGL_STENCIL_SIZE: " << eglu::getConfigAttribInt(egl, display, config, EGL_STENCIL_SIZE)     << TestLog::EndMessage;
505                 log << TestLog::Message << "EGL_SAMPLES: "              << eglu::getConfigAttribInt(egl, display, config, EGL_SAMPLES)          << TestLog::EndMessage;
506         }
507
508         de::UniquePtr<eglu::NativeWindow>       window  (factory.createWindow(&m_eglTestCtx.getNativeDisplay(), display, config, DE_NULL, eglu::WindowParams(128, 128, eglu::WindowParams::VISIBILITY_VISIBLE)));
509
510         eglu::UniqueSurface                                     surface (egl, display, eglu::createWindowSurface(m_eglTestCtx.getNativeDisplay(), *window, display, config, DE_NULL));
511         eglu::UniqueContext                                     context (egl, display, createGLES2Context(egl, display, config));
512         glw::Functions                                          gl;
513         deUint32                                                        program = 0;
514
515         EGLU_CHECK_CALL(egl, surfaceAttrib(display, *surface, EGL_TIMESTAMPS_ANDROID, EGL_TRUE));
516
517         m_eglTestCtx.initGLFunctions(&gl, glu::ApiType::es(2,0));
518
519         EGLU_CHECK_CALL(egl, makeCurrent(display, *surface, *surface, *context));
520
521         try
522         {
523                 // EGL_DISPLAY_PRESENT_TIME_ANDROID support is currently optional
524                 // but should be required once HWC1 is no longer supported.
525                 // All HWC2 devices should support EGL_DISPLAY_PRESENT_TIME_ANDROID.
526                 TimestampInfoMap timestamps;
527                 timestamps[EGL_REQUESTED_PRESENT_TIME_ANDROID]                          =       TimestampInfo(true,             false, 0);
528                 timestamps[EGL_RENDERING_COMPLETE_TIME_ANDROID]                         =       TimestampInfo(true,             false, 0);
529                 timestamps[EGL_COMPOSITION_LATCH_TIME_ANDROID]                          =       TimestampInfo(true,             false, 0);
530                 timestamps[EGL_FIRST_COMPOSITION_START_TIME_ANDROID]            =       TimestampInfo(true,             false, 0);
531                 timestamps[EGL_LAST_COMPOSITION_START_TIME_ANDROID]                     =       TimestampInfo(true,             false, 0);
532                 timestamps[EGL_FIRST_COMPOSITION_GPU_FINISHED_TIME_ANDROID]     =       TimestampInfo(true,             false, 0);
533                 timestamps[EGL_DISPLAY_PRESENT_TIME_ANDROID]                            =       TimestampInfo(false,    false, 0);
534                 timestamps[EGL_DEQUEUE_READY_TIME_ANDROID]                                      =       TimestampInfo(true,             false, 0);
535                 timestamps[EGL_READS_DONE_TIME_ANDROID]                                         =       TimestampInfo(true,             false, 0);
536
537                 const eglw::EGLint invalidTimestampName = EGL_READS_DONE_TIME_ANDROID + 1;
538
539                 // Verify required timestamps are supported and populate supportedNames.
540                 std::vector<eglw::EGLint> supportedNames;
541                 for (TimestampInfoMap::iterator i = timestamps.begin(); i != timestamps.end(); i++)
542                 {
543                         TimestampInfo& info = i->second;
544                         info.supported = m_eglGetFrameTimestampSupportedANDROID(display, *surface, i->first) != EGL_FALSE;
545                         EGLU_CHECK_MSG(egl, "eglGetFrameTimestampSupportedANDROID failed.");
546
547                         if (info.supported)
548                         {
549                                 info.supportedIndex = supportedNames.size();
550                                 supportedNames.push_back(i->first);
551                         }
552                         else
553                                 TCU_CHECK_MSG(!info.required, "Required timestamp not supported.");
554                 }
555
556                 // Verify unsupported timestamps are reported properly.
557                 const bool invalidSupported = m_eglGetFrameTimestampSupportedANDROID(display, *surface, invalidTimestampName) != EGL_FALSE;
558                 EGLU_CHECK_MSG(egl, "eglGetFrameTimestampSupportedANDROID failed.");
559                 TCU_CHECK_MSG(!invalidSupported, "Non existant timestamp reports that it is supported.");
560
561                 // Verify compositor timings are supported.
562                 const bool deadlineSupported = m_eglGetCompositorTimingSupportedANDROID(display, *surface, EGL_COMPOSITE_DEADLINE_ANDROID) != EGL_FALSE;
563                 EGLU_CHECK_MSG(egl, "eglGetCompositorTimingSupportedANDROID failed.");
564                 TCU_CHECK_MSG(deadlineSupported, "EGL_COMPOSITE_DEADLINE_ANDROID not supported.");
565                 const bool intervalSupported = m_eglGetCompositorTimingSupportedANDROID(display, *surface, EGL_COMPOSITE_INTERVAL_ANDROID) != EGL_FALSE;
566                 EGLU_CHECK_MSG(egl, "eglGetCompositorTimingSupportedANDROID failed.");
567                 TCU_CHECK_MSG(intervalSupported, "EGL_COMPOSITE_INTERVAL_ANDROID not supported.");
568                 const bool latencySupported = m_eglGetCompositorTimingSupportedANDROID(display, *surface, EGL_COMPOSITE_TO_PRESENT_LATENCY_ANDROID) != EGL_FALSE;
569                 EGLU_CHECK_MSG(egl, "eglGetCompositorTimingSupportedANDROID failed.");
570                 TCU_CHECK_MSG(latencySupported, "EGL_COMPOSITE_TO_PRESENT_LATENCY_ANDROID not supported.");
571
572                 const float positions1[] =
573                 {
574                          0.00f,  0.00f,
575                          0.75f,  0.00f,
576                          0.75f,  0.75f,
577
578                          0.75f,  0.75f,
579                          0.00f,  0.75f,
580                          0.00f,  0.00f
581                 };
582
583                 const float positions2[] =
584                 {
585                         -0.75f, -0.75f,
586                          0.00f, -0.75f,
587                          0.00f,  0.00f,
588
589                          0.00f,  0.00f,
590                         -0.75f,  0.00f,
591                         -0.75f, -0.75f
592                 };
593
594                 deUint32 posLocation;
595
596                 program = createGLES2Program(gl, m_testCtx.getLog());
597
598                 gl.useProgram(program);
599                 posLocation     = gl.getAttribLocation(program, "a_pos");
600                 gl.enableVertexAttribArray(posLocation);
601                 GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to setup shader program for rendering");
602
603                 const size_t frameCount = 120;
604                 std::vector<FrameTimes> frameTimes(frameCount);
605                 for (size_t i = 0; i < frameCount; i++)
606                 {
607                         FrameTimes& frame = frameTimes[i];
608
609                         const eglw::EGLint compositorTimingNames[] =
610                         {
611                                 EGL_COMPOSITE_DEADLINE_ANDROID,
612                                 EGL_COMPOSITE_INTERVAL_ANDROID,
613                                 EGL_COMPOSITE_TO_PRESENT_LATENCY_ANDROID,
614                         };
615                         const EGLint compositorTimingCount = DE_LENGTH_OF_ARRAY(compositorTimingNames);
616                         EGLnsecsANDROID compositorTimingValues[compositorTimingCount] = { -2 };
617
618                         // Get the current time before making any API calls in case "now"
619                         // just happens to get sampled near one of the composite deadlines.
620                         EGLnsecsANDROID now = getNanoseconds();
621
622                         // Get the frame id.
623                         EGLuint64KHR nextFrameId = 0;
624                         CHECK_NAKED_EGL_CALL(egl, m_eglGetNextFrameIdANDROID(display, *surface, &nextFrameId));
625                         frame.frameId                           =       nextFrameId;
626
627                         // Get the compositor timing.
628                         CHECK_NAKED_EGL_CALL(egl, m_eglGetCompositorTimingANDROID(
629                                 display, *surface, compositorTimingCount,
630                                 compositorTimingNames, compositorTimingValues));
631                         frame.compositeDeadline                 =       compositorTimingValues[0];
632                         frame.compositeInterval                 =       compositorTimingValues[1];
633                         frame.compositeToPresentLatency =       compositorTimingValues[2];
634
635                         // Verify compositor timing is sane.
636                         check_lt<EGLnsecsANDROID>(m_result, 1000000, frame.compositeInterval, "Reported refresh rate greater than 1kHz.");
637                         check_lt<EGLnsecsANDROID>(m_result, frame.compositeInterval, 1000000000, "Reported refresh rate less than 1Hz.");
638                         check_lt<EGLnsecsANDROID>(m_result, 0, frame.compositeToPresentLatency, "Composite to present latency must be greater than 0.");
639                         check_lt(m_result, frame.compositeToPresentLatency, frame.compositeInterval * 3, "Composite to present latency is more than 3 vsyncs.");
640                         const EGLnsecsANDROID minDeadline = now;
641                         check_lt(m_result, minDeadline, frame.compositeDeadline, "Next composite deadline is in the past.");
642                         const EGLnsecsANDROID maxDeadline = now + frame.compositeInterval * 2;
643                         check_lt(m_result, frame.compositeDeadline, maxDeadline, "Next composite deadline over two intervals away.");
644
645                         const float colorAngle = (static_cast<float>(i) / static_cast<float>(frameCount)) * 6.28318f;
646                         gl.clearColor((1.0f + deFloatSin(colorAngle)) / 2.0f, 0.7f, (1.0f + deFloatCos(colorAngle)) / 2.0f, 1.0f);
647                         gl.clear(GL_COLOR_BUFFER_BIT);
648                         GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to clear surface");
649
650                         const bool posSelect  = ((i % 2) == 0);
651                         gl.vertexAttribPointer(posLocation, 2, GL_FLOAT, GL_FALSE, 0, posSelect ? positions1 : positions2);
652                         gl.drawArrays(GL_TRIANGLES, 0, 6);
653                         GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to render");
654
655                         frame.swapBufferBeginNs = getNanoseconds();
656                         EGLU_CHECK_CALL(egl, swapBuffers(display, *surface));
657
658                         // All timestamps from 5 frames ago should definitely be available.
659                         const size_t frameDelay = 5;
660                         if (i >= frameDelay)
661                         {
662                                 // \todo [2017-01-25 brianderson] Remove this work around once reads done is fixed.
663                                 const bool verifyReadsDone      =       i > (frameDelay + 3);
664                                 FrameTimes&             frame5ago       =       frameTimes[i-frameDelay];
665                                 std::vector<EGLnsecsANDROID> supportedValues(supportedNames.size(), 0);
666
667                                 CHECK_NAKED_EGL_CALL(egl, m_eglGetFrameTimestampsANDROID(
668                                         display, *surface, frame5ago.frameId, static_cast<eglw::EGLint>(supportedNames.size()),
669                                         &supportedNames[0], &supportedValues[0]));
670                                 populateFrameTimes(&frame5ago, timestamps, supportedValues);
671
672                                 verifySingleFrame(frame5ago, m_result, verifyReadsDone);
673                                 if (i >= frameDelay + 1)
674                                 {
675                                         FrameTimes& frame6ago = frameTimes[i-frameDelay-1];
676                                         verifyNeighboringFrames(frame6ago, frame5ago, m_result);
677                                 }
678                         }
679                 }
680
681                 // All timestamps for the most recently swapped frame should
682                 // become available by only polling eglGetFrametimestamps.
683                 // No additional swaps should be necessary.
684                 FrameTimes&                             lastFrame                               =       frameTimes.back();
685                 const EGLnsecsANDROID   pollingDeadline                 =       lastFrame.swapBufferBeginNs + 1000000000;
686                 bool                                    finalTimestampAvailable =       false;
687
688                 do
689                 {
690                         std::vector<EGLnsecsANDROID> supportedValues(supportedNames.size(), 0);
691                         CHECK_NAKED_EGL_CALL(egl, m_eglGetFrameTimestampsANDROID(
692                                 display, *surface, lastFrame.frameId, static_cast<eglw::EGLint>(supportedNames.size()),
693                                 &supportedNames[0], &supportedValues[0]));
694                         populateFrameTimes(&lastFrame, timestamps, supportedValues);
695
696                         // Poll for present if it's supported.
697                         // Otherwise, poll for firstCompositionStart.
698                         if (timestamps[EGL_DISPLAY_PRESENT_TIME_ANDROID].supported)
699                                 finalTimestampAvailable = !timestampPending(lastFrame.displayPresent);
700                         else
701                                 finalTimestampAvailable = !timestampPending(lastFrame.firstCompositionStart);
702                 } while (!finalTimestampAvailable && (getNanoseconds() < pollingDeadline));
703
704                 m_result.check(finalTimestampAvailable, "Timed out polling for timestamps of last swap.");
705                 m_result.check((lastFrame.requestedPresent >= 0), "Requested present of last swap not avaiable.");
706                 m_result.check((lastFrame.renderingComplete >= 0), "Rendering complete of last swap not avaiable.");
707                 m_result.check((lastFrame.latch >= 0), "Latch of last swap not avaiable.");
708                 m_result.check((lastFrame.firstCompositionStart >= 0), "First composite time of last swap not avaiable.");
709                 m_result.check((lastFrame.lastCompositionStart >= 0), "Last composite time of last swap not avaiable.");
710
711                 window->processEvents();
712                 gl.disableVertexAttribArray(posLocation);
713                 gl.useProgram(0);
714                 GLU_EXPECT_NO_ERROR(gl.getError(), "Failed to release program state");
715
716                 gl.deleteProgram(program);
717                 program = 0;
718                 GLU_EXPECT_NO_ERROR(gl.getError(), "glDeleteProgram()");
719
720                 m_result.setTestContextResult(m_testCtx);
721         }
722         catch (...)
723         {
724                 if (program != 0)
725                         gl.deleteProgram(program);
726
727                 EGLU_CHECK_CALL(egl, makeCurrent(display, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT));
728                 throw;
729         }
730
731         EGLU_CHECK_CALL(egl, makeCurrent(display, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT));
732 }
733
734 class GetFrameTimestampsTests : public TestCaseGroup
735 {
736 public:
737                                                                 GetFrameTimestampsTests (EglTestContext& eglTestCtx);
738         void                                            init                                    (void);
739
740 private:
741                                                                 GetFrameTimestampsTests (const GetFrameTimestampsTests&);
742         GetFrameTimestampsTests&        operator=                               (const GetFrameTimestampsTests&);
743 };
744
745
746 GetFrameTimestampsTests::GetFrameTimestampsTests (EglTestContext& eglTestCtx)
747         : TestCaseGroup(eglTestCtx, "get_frame_timestamps", "Get frame timestamp tests")
748 {
749 }
750
751 bool isWindow (const eglu::CandidateConfig& c)
752 {
753         return (c.surfaceType() & EGL_WINDOW_BIT) != 0;
754 }
755
756 void GetFrameTimestampsTests::init (void)
757 {
758         eglu::FilterList baseFilters;
759         baseFilters << isWindow;
760
761         vector<NamedFilterList> filterLists;
762         getDefaultFilterLists(filterLists, baseFilters);
763
764         for (vector<NamedFilterList>::iterator i = filterLists.begin(); i != filterLists.end(); i++)
765                 addChild(new GetFrameTimestampTest(m_eglTestCtx, *i));
766 }
767
768 } // anonymous
769
770 TestCaseGroup* createGetFrameTimestampsTests (EglTestContext& eglTestCtx)
771 {
772         return new GetFrameTimestampsTests(eglTestCtx);
773 }
774
775 } // egl
776 } // deqp