blob: ca1d50a7d2f574e451d93b7c60b5d22ed6798ed5 [file] [log] [blame]
Jamie Madill9e54b5a2016-05-25 12:57:39 -04001//
2// Copyright 2016 The ANGLE Project Authors. All rights reserved.
3// Use of this source code is governed by a BSD-style license that can be
4// found in the LICENSE file.
5//
6// RendererVk.cpp:
7// Implements the class methods for RendererVk.
8//
9
10#include "libANGLE/renderer/vulkan/RendererVk.h"
11
Jamie Madill4d0bf552016-12-28 15:45:24 -050012// Placing this first seems to solve an intellisense bug.
Jamie Madill3c424b42018-01-19 12:35:09 -050013#include "libANGLE/renderer/vulkan/vk_utils.h"
Jamie Madill4d0bf552016-12-28 15:45:24 -050014
Jamie Madille09bd5d2016-11-29 16:20:35 -050015#include <EGL/eglext.h>
16
Jamie Madill9e54b5a2016-05-25 12:57:39 -040017#include "common/debug.h"
Jamie Madilla66779f2017-01-06 10:43:44 -050018#include "common/system_utils.h"
Yuly Novikovb56ddbb2018-11-02 16:53:18 -040019#include "libANGLE/Display.h"
Jamie Madill4d0bf552016-12-28 15:45:24 -050020#include "libANGLE/renderer/driver_utils.h"
Jamie Madill1f46bc12018-02-20 16:09:43 -050021#include "libANGLE/renderer/vulkan/CommandGraph.h"
Jamie Madille09bd5d2016-11-29 16:20:35 -050022#include "libANGLE/renderer/vulkan/CompilerVk.h"
Shahbaz Youssefi996628a2018-09-24 16:39:26 -040023#include "libANGLE/renderer/vulkan/DisplayVk.h"
Jamie Madille09bd5d2016-11-29 16:20:35 -050024#include "libANGLE/renderer/vulkan/FramebufferVk.h"
Jamie Madill8ecf7f92017-01-13 17:29:52 -050025#include "libANGLE/renderer/vulkan/GlslangWrapper.h"
Jamie Madillffa4cbb2018-01-23 13:04:07 -050026#include "libANGLE/renderer/vulkan/ProgramVk.h"
Jamie Madille09bd5d2016-11-29 16:20:35 -050027#include "libANGLE/renderer/vulkan/VertexArrayVk.h"
Luc Ferrone4741fd2018-01-25 13:25:27 -050028#include "libANGLE/renderer/vulkan/vk_caps_utils.h"
Jamie Madill3c424b42018-01-19 12:35:09 -050029#include "libANGLE/renderer/vulkan/vk_format_utils.h"
Jamie Madille09bd5d2016-11-29 16:20:35 -050030#include "platform/Platform.h"
Jamie Madill9e54b5a2016-05-25 12:57:39 -040031
Shahbaz Youssefi61656022018-10-24 15:00:50 -040032#include "third_party/trace_event/trace_event.h"
33
Tobin Ehlisa3b220f2018-03-06 16:22:13 -070034// Consts
35namespace
36{
Jamie Madill7c985f52018-11-29 18:16:17 -050037const uint32_t kMockVendorID = 0xba5eba11;
38const uint32_t kMockDeviceID = 0xf005ba11;
39constexpr char kMockDeviceName[] = "Vulkan Mock Device";
40constexpr size_t kInFlightCommandsLimit = 100u;
Shahbaz Youssefi96bd8fd2018-11-30 14:30:18 -050041constexpr VkFormatFeatureFlags kInvalidFormatFeatureFlags = static_cast<VkFormatFeatureFlags>(-1);
Tobin Ehlisa3b220f2018-03-06 16:22:13 -070042} // anonymous namespace
43
Jamie Madill9e54b5a2016-05-25 12:57:39 -040044namespace rx
45{
46
Jamie Madille09bd5d2016-11-29 16:20:35 -050047namespace
48{
Luc Ferrondaedf4d2018-03-16 09:28:53 -040049// We currently only allocate 2 uniform buffer per descriptor set, one for the fragment shader and
50// one for the vertex shader.
51constexpr size_t kUniformBufferDescriptorsPerDescriptorSet = 2;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -040052// Update the pipeline cache every this many swaps (if 60fps, this means every 10 minutes)
53static constexpr uint32_t kPipelineCacheVkUpdatePeriod = 10 * 60 * 60;
Yuly Novikovb56ddbb2018-11-02 16:53:18 -040054// Wait a maximum of 10s. If that times out, we declare it a failure.
55static constexpr uint64_t kMaxFenceWaitTimeNs = 10'000'000'000llu;
Jamie Madille09bd5d2016-11-29 16:20:35 -050056
Omar El Sheikh26c61b22018-06-29 12:50:59 -060057bool ShouldEnableMockICD(const egl::AttributeMap &attribs)
58{
59#if !defined(ANGLE_PLATFORM_ANDROID)
60 // Mock ICD does not currently run on Android
61 return (attribs.get(EGL_PLATFORM_ANGLE_DEVICE_TYPE_ANGLE,
62 EGL_PLATFORM_ANGLE_DEVICE_TYPE_HARDWARE_ANGLE) ==
63 EGL_PLATFORM_ANGLE_DEVICE_TYPE_NULL_ANGLE);
64#else
65 return false;
66#endif // !defined(ANGLE_PLATFORM_ANDROID)
67}
68
Jamie Madille09bd5d2016-11-29 16:20:35 -050069VkResult VerifyExtensionsPresent(const std::vector<VkExtensionProperties> &extensionProps,
70 const std::vector<const char *> &enabledExtensionNames)
71{
72 // Compile the extensions names into a set.
73 std::set<std::string> extensionNames;
74 for (const auto &extensionProp : extensionProps)
75 {
76 extensionNames.insert(extensionProp.extensionName);
77 }
78
Jamie Madillacf2f3a2017-11-21 19:22:44 -050079 for (const char *extensionName : enabledExtensionNames)
Jamie Madille09bd5d2016-11-29 16:20:35 -050080 {
81 if (extensionNames.count(extensionName) == 0)
82 {
83 return VK_ERROR_EXTENSION_NOT_PRESENT;
84 }
85 }
86
87 return VK_SUCCESS;
88}
89
Tobin Ehlis3a181e32018-08-29 15:17:05 -060090// Array of Validation error/warning messages that will be ignored, should include bugID
91constexpr std::array<const char *, 1> kSkippedMessages = {
92 // http://anglebug.com/2796
93 " [ UNASSIGNED-CoreValidation-Shader-PointSizeMissing ] Object: VK_NULL_HANDLE (Type = 19) "
94 "| Pipeline topology is set to POINT_LIST, but PointSize is not written to in the shader "
95 "corresponding to VK_SHADER_STAGE_VERTEX_BIT."};
96
97// Suppress validation errors that are known
98// return "true" if given code/prefix/message is known, else return "false"
99bool IsIgnoredDebugMessage(const char *message)
100{
101 for (const auto &msg : kSkippedMessages)
102 {
103 if (strcmp(msg, message) == 0)
104 {
105 return true;
106 }
107 }
108 return false;
109}
110
Yuly Novikov199f4292018-01-19 19:04:05 -0500111VKAPI_ATTR VkBool32 VKAPI_CALL DebugReportCallback(VkDebugReportFlagsEXT flags,
112 VkDebugReportObjectTypeEXT objectType,
113 uint64_t object,
114 size_t location,
115 int32_t messageCode,
116 const char *layerPrefix,
117 const char *message,
118 void *userData)
Jamie Madill0448ec82016-12-23 13:41:47 -0500119{
Tobin Ehlis3a181e32018-08-29 15:17:05 -0600120 if (IsIgnoredDebugMessage(message))
121 {
122 return VK_FALSE;
123 }
Jamie Madill0448ec82016-12-23 13:41:47 -0500124 if ((flags & VK_DEBUG_REPORT_ERROR_BIT_EXT) != 0)
125 {
Yuly Novikovbcb3f9b2017-01-27 22:45:18 -0500126 ERR() << message;
Jamie Madill0448ec82016-12-23 13:41:47 -0500127#if !defined(NDEBUG)
128 // Abort the call in Debug builds.
129 return VK_TRUE;
130#endif
131 }
132 else if ((flags & VK_DEBUG_REPORT_WARNING_BIT_EXT) != 0)
133 {
Yuly Novikovbcb3f9b2017-01-27 22:45:18 -0500134 WARN() << message;
Jamie Madill0448ec82016-12-23 13:41:47 -0500135 }
136 else
137 {
Yuly Novikovbcb3f9b2017-01-27 22:45:18 -0500138 // Uncomment this if you want Vulkan spam.
139 // WARN() << message;
Jamie Madill0448ec82016-12-23 13:41:47 -0500140 }
141
142 return VK_FALSE;
143}
144
Yuly Novikov199f4292018-01-19 19:04:05 -0500145// If we're loading the validation layers, we could be running from any random directory.
146// Change to the executable directory so we can find the layers, then change back to the
147// previous directory to be safe we don't disrupt the application.
148class ScopedVkLoaderEnvironment : angle::NonCopyable
149{
150 public:
Omar El Sheikh26c61b22018-06-29 12:50:59 -0600151 ScopedVkLoaderEnvironment(bool enableValidationLayers, bool enableMockICD)
152 : mEnableValidationLayers(enableValidationLayers),
153 mEnableMockICD(enableMockICD),
154 mChangedCWD(false),
155 mChangedICDPath(false)
Yuly Novikov199f4292018-01-19 19:04:05 -0500156 {
157// Changing CWD and setting environment variables makes no sense on Android,
158// since this code is a part of Java application there.
159// Android Vulkan loader doesn't need this either.
160#if !defined(ANGLE_PLATFORM_ANDROID)
Omar El Sheikh26c61b22018-06-29 12:50:59 -0600161 if (enableMockICD)
162 {
163 // Override environment variable to use built Mock ICD
164 // ANGLE_VK_ICD_JSON gets set to the built mock ICD in BUILD.gn
165 mPreviousICDPath = angle::GetEnvironmentVar(g_VkICDPathEnv);
166 mChangedICDPath = angle::SetEnvironmentVar(g_VkICDPathEnv, ANGLE_VK_ICD_JSON);
167 if (!mChangedICDPath)
168 {
169 ERR() << "Error setting Path for Mock/Null Driver.";
170 mEnableMockICD = false;
171 }
172 }
Jamie Madill46848422018-08-09 10:46:06 -0400173 if (mEnableValidationLayers || mEnableMockICD)
Yuly Novikov199f4292018-01-19 19:04:05 -0500174 {
175 const auto &cwd = angle::GetCWD();
176 if (!cwd.valid())
177 {
178 ERR() << "Error getting CWD for Vulkan layers init.";
179 mEnableValidationLayers = false;
Jamie Madill46848422018-08-09 10:46:06 -0400180 mEnableMockICD = false;
Yuly Novikov199f4292018-01-19 19:04:05 -0500181 }
182 else
183 {
184 mPreviousCWD = cwd.value();
185 const char *exeDir = angle::GetExecutableDirectory();
186 mChangedCWD = angle::SetCWD(exeDir);
187 if (!mChangedCWD)
188 {
189 ERR() << "Error setting CWD for Vulkan layers init.";
190 mEnableValidationLayers = false;
Jamie Madill46848422018-08-09 10:46:06 -0400191 mEnableMockICD = false;
Yuly Novikov199f4292018-01-19 19:04:05 -0500192 }
193 }
194 }
195
196 // Override environment variable to use the ANGLE layers.
197 if (mEnableValidationLayers)
198 {
Tobin Ehlisa3b220f2018-03-06 16:22:13 -0700199 if (!angle::PrependPathToEnvironmentVar(g_VkLoaderLayersPathEnv, ANGLE_VK_DATA_DIR))
Yuly Novikov199f4292018-01-19 19:04:05 -0500200 {
201 ERR() << "Error setting environment for Vulkan layers init.";
202 mEnableValidationLayers = false;
203 }
204 }
205#endif // !defined(ANGLE_PLATFORM_ANDROID)
206 }
207
208 ~ScopedVkLoaderEnvironment()
209 {
210 if (mChangedCWD)
211 {
212#if !defined(ANGLE_PLATFORM_ANDROID)
213 ASSERT(mPreviousCWD.valid());
214 angle::SetCWD(mPreviousCWD.value().c_str());
215#endif // !defined(ANGLE_PLATFORM_ANDROID)
216 }
Omar El Sheikh26c61b22018-06-29 12:50:59 -0600217 if (mChangedICDPath)
218 {
Omar El Sheikh80d4ef12018-07-13 17:08:19 -0600219 if (mPreviousICDPath.value().empty())
220 {
221 angle::UnsetEnvironmentVar(g_VkICDPathEnv);
222 }
223 else
224 {
225 angle::SetEnvironmentVar(g_VkICDPathEnv, mPreviousICDPath.value().c_str());
226 }
Omar El Sheikh26c61b22018-06-29 12:50:59 -0600227 }
Yuly Novikov199f4292018-01-19 19:04:05 -0500228 }
229
Jamie Madillaaca96e2018-06-12 10:19:48 -0400230 bool canEnableValidationLayers() const { return mEnableValidationLayers; }
Yuly Novikov199f4292018-01-19 19:04:05 -0500231
Omar El Sheikh26c61b22018-06-29 12:50:59 -0600232 bool canEnableMockICD() const { return mEnableMockICD; }
233
Yuly Novikov199f4292018-01-19 19:04:05 -0500234 private:
235 bool mEnableValidationLayers;
Omar El Sheikh26c61b22018-06-29 12:50:59 -0600236 bool mEnableMockICD;
Yuly Novikov199f4292018-01-19 19:04:05 -0500237 bool mChangedCWD;
238 Optional<std::string> mPreviousCWD;
Omar El Sheikh26c61b22018-06-29 12:50:59 -0600239 bool mChangedICDPath;
240 Optional<std::string> mPreviousICDPath;
Yuly Novikov199f4292018-01-19 19:04:05 -0500241};
242
Jamie Madill21061022018-07-12 23:56:30 -0400243void ChoosePhysicalDevice(const std::vector<VkPhysicalDevice> &physicalDevices,
244 bool preferMockICD,
245 VkPhysicalDevice *physicalDeviceOut,
246 VkPhysicalDeviceProperties *physicalDevicePropertiesOut)
247{
248 ASSERT(!physicalDevices.empty());
249 if (preferMockICD)
250 {
251 for (const VkPhysicalDevice &physicalDevice : physicalDevices)
252 {
253 vkGetPhysicalDeviceProperties(physicalDevice, physicalDevicePropertiesOut);
254 if ((kMockVendorID == physicalDevicePropertiesOut->vendorID) &&
255 (kMockDeviceID == physicalDevicePropertiesOut->deviceID) &&
256 (strcmp(kMockDeviceName, physicalDevicePropertiesOut->deviceName) == 0))
257 {
258 *physicalDeviceOut = physicalDevice;
259 return;
260 }
261 }
262 WARN() << "Vulkan Mock Driver was requested but Mock Device was not found. Using default "
263 "physicalDevice instead.";
264 }
265
266 // Fall back to first device.
267 *physicalDeviceOut = physicalDevices[0];
268 vkGetPhysicalDeviceProperties(*physicalDeviceOut, physicalDevicePropertiesOut);
269}
Jamie Madill0da73fe2018-10-02 09:31:39 -0400270
271// Initially dumping the command graphs is disabled.
272constexpr bool kEnableCommandGraphDiagnostics = false;
Ian Elliottbcb78902018-12-19 11:46:29 -0700273
274bool ExtensionFound(const char *extensionName,
275 const std::vector<VkExtensionProperties> &extensionProps)
276{
277 for (const auto &extensionProp : extensionProps)
278 {
279 if (strcmp(extensionProp.extensionName, extensionName) == 0)
280 {
281 return true;
282 }
283 }
284 return false;
285}
Jamie Madille09bd5d2016-11-29 16:20:35 -0500286} // anonymous namespace
287
Jamie Madill49ac74b2017-12-21 14:42:33 -0500288// CommandBatch implementation.
Jamie Madillaaca96e2018-06-12 10:19:48 -0400289RendererVk::CommandBatch::CommandBatch() = default;
Jamie Madill49ac74b2017-12-21 14:42:33 -0500290
Jamie Madillaaca96e2018-06-12 10:19:48 -0400291RendererVk::CommandBatch::~CommandBatch() = default;
Jamie Madill49ac74b2017-12-21 14:42:33 -0500292
293RendererVk::CommandBatch::CommandBatch(CommandBatch &&other)
294 : commandPool(std::move(other.commandPool)), fence(std::move(other.fence)), serial(other.serial)
Jamie Madillb980c562018-11-27 11:34:27 -0500295{}
Jamie Madill49ac74b2017-12-21 14:42:33 -0500296
297RendererVk::CommandBatch &RendererVk::CommandBatch::operator=(CommandBatch &&other)
298{
299 std::swap(commandPool, other.commandPool);
300 std::swap(fence, other.fence);
301 std::swap(serial, other.serial);
302 return *this;
303}
304
Jamie Madillbea35a62018-07-05 11:54:10 -0400305void RendererVk::CommandBatch::destroy(VkDevice device)
306{
307 commandPool.destroy(device);
308 fence.destroy(device);
309}
310
Jamie Madill9f2a8612017-11-30 12:43:09 -0500311// RendererVk implementation.
Jamie Madill0448ec82016-12-23 13:41:47 -0500312RendererVk::RendererVk()
Yuly Novikovb56ddbb2018-11-02 16:53:18 -0400313 : mDisplay(nullptr),
314 mCapsInitialized(false),
Ian Elliottbcb78902018-12-19 11:46:29 -0700315 mFeaturesInitialized(false),
Jamie Madill0448ec82016-12-23 13:41:47 -0500316 mInstance(VK_NULL_HANDLE),
317 mEnableValidationLayers(false),
Jamie Madill0ea96212018-10-30 15:14:51 -0400318 mEnableMockICD(false),
Jamie Madill4d0bf552016-12-28 15:45:24 -0500319 mDebugReportCallback(VK_NULL_HANDLE),
320 mPhysicalDevice(VK_NULL_HANDLE),
321 mQueue(VK_NULL_HANDLE),
322 mCurrentQueueFamilyIndex(std::numeric_limits<uint32_t>::max()),
323 mDevice(VK_NULL_HANDLE),
Jamie Madillfb05bcb2017-06-07 15:43:18 -0400324 mLastCompletedQueueSerial(mQueueSerialFactory.generate()),
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400325 mCurrentQueueSerial(mQueueSerialFactory.generate()),
Geoff Lang2fe5e1d2018-08-28 14:00:24 -0400326 mDeviceLost(false),
Jamie Madill0da73fe2018-10-02 09:31:39 -0400327 mPipelineCacheVkUpdateTimeout(kPipelineCacheVkUpdatePeriod),
Shahbaz Youssefi25224e72018-10-22 11:56:02 -0400328 mCommandGraph(kEnableCommandGraphDiagnostics),
329 mGpuEventsEnabled(false),
330 mGpuClockSync{std::numeric_limits<double>::max(), std::numeric_limits<double>::max()},
331 mGpuEventTimestampOrigin(0)
Shahbaz Youssefi96bd8fd2018-11-30 14:30:18 -0500332{
333 VkFormatProperties invalid = {0, 0, kInvalidFormatFeatureFlags};
334 mFormatProperties.fill(invalid);
335}
Jamie Madill9e54b5a2016-05-25 12:57:39 -0400336
Jamie Madillb980c562018-11-27 11:34:27 -0500337RendererVk::~RendererVk() {}
Jamie Madill21061022018-07-12 23:56:30 -0400338
339void RendererVk::onDestroy(vk::Context *context)
340{
Jamie Madill49ac74b2017-12-21 14:42:33 -0500341 if (!mInFlightCommands.empty() || !mGarbage.empty())
Jamie Madill4c26fc22017-02-24 11:04:10 -0500342 {
Jamie Madill49ac74b2017-12-21 14:42:33 -0500343 // TODO(jmadill): Not nice to pass nullptr here, but shouldn't be a problem.
Jamie Madill21061022018-07-12 23:56:30 -0400344 (void)finish(context);
Jamie Madill4c26fc22017-02-24 11:04:10 -0500345 }
346
Shahbaz Youssefi8f1b7a62018-11-14 16:02:54 -0500347 mDispatchUtils.destroy(mDevice);
348
Jamie Madillc7918ce2018-06-13 13:25:31 -0400349 mPipelineLayoutCache.destroy(mDevice);
350 mDescriptorSetLayoutCache.destroy(mDevice);
351
Jamie Madilldc65c5b2018-11-21 11:07:26 -0500352 mFullScreenClearShaderProgram.destroy(mDevice);
353
Jamie Madill9f2a8612017-11-30 12:43:09 -0500354 mRenderPassCache.destroy(mDevice);
Jamie Madilldc65c5b2018-11-21 11:07:26 -0500355 mPipelineCache.destroy(mDevice);
Shahbaz Youssefi3a482172018-10-11 10:34:44 -0400356 mSubmitSemaphorePool.destroy(mDevice);
Jamie Madilld47044a2018-04-27 11:45:03 -0400357 mShaderLibrary.destroy(mDevice);
Shahbaz Youssefi25224e72018-10-22 11:56:02 -0400358 mGpuEventQueryPool.destroy(mDevice);
Jamie Madill9f2a8612017-11-30 12:43:09 -0500359
Jamie Madill06ca6342018-07-12 15:56:53 -0400360 GlslangWrapper::Release();
Jamie Madill8ecf7f92017-01-13 17:29:52 -0500361
Jamie Madill5deea722017-02-16 10:44:46 -0500362 if (mCommandPool.valid())
363 {
364 mCommandPool.destroy(mDevice);
365 }
Jamie Madill4d0bf552016-12-28 15:45:24 -0500366
367 if (mDevice)
368 {
369 vkDestroyDevice(mDevice, nullptr);
370 mDevice = VK_NULL_HANDLE;
371 }
372
Jamie Madill0448ec82016-12-23 13:41:47 -0500373 if (mDebugReportCallback)
374 {
375 ASSERT(mInstance);
376 auto destroyDebugReportCallback = reinterpret_cast<PFN_vkDestroyDebugReportCallbackEXT>(
377 vkGetInstanceProcAddr(mInstance, "vkDestroyDebugReportCallbackEXT"));
378 ASSERT(destroyDebugReportCallback);
379 destroyDebugReportCallback(mInstance, mDebugReportCallback, nullptr);
380 }
381
Jamie Madill4d0bf552016-12-28 15:45:24 -0500382 if (mInstance)
383 {
384 vkDestroyInstance(mInstance, nullptr);
385 mInstance = VK_NULL_HANDLE;
386 }
387
Omar El Sheikheb4b8692018-07-17 10:55:40 -0600388 mMemoryProperties.destroy();
Jamie Madill4d0bf552016-12-28 15:45:24 -0500389 mPhysicalDevice = VK_NULL_HANDLE;
Jamie Madill327ba852016-11-30 12:38:28 -0500390}
391
Yuly Novikovb56ddbb2018-11-02 16:53:18 -0400392void RendererVk::notifyDeviceLost()
Geoff Lang2fe5e1d2018-08-28 14:00:24 -0400393{
394 mDeviceLost = true;
Yuly Novikovb56ddbb2018-11-02 16:53:18 -0400395
396 mCommandGraph.clear();
397 mLastSubmittedQueueSerial = mCurrentQueueSerial;
398 mCurrentQueueSerial = mQueueSerialFactory.generate();
399 freeAllInFlightResources();
400
401 mDisplay->notifyDeviceLost();
Geoff Lang2fe5e1d2018-08-28 14:00:24 -0400402}
403
404bool RendererVk::isDeviceLost() const
405{
406 return mDeviceLost;
407}
408
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400409angle::Result RendererVk::initialize(DisplayVk *displayVk,
Yuly Novikovb56ddbb2018-11-02 16:53:18 -0400410 egl::Display *display,
Jamie Madill21061022018-07-12 23:56:30 -0400411 const char *wsiName)
Jamie Madill327ba852016-11-30 12:38:28 -0500412{
Yuly Novikovb56ddbb2018-11-02 16:53:18 -0400413 mDisplay = display;
414 const egl::AttributeMap &attribs = mDisplay->getAttributeMap();
Omar El Sheikh26c61b22018-06-29 12:50:59 -0600415 ScopedVkLoaderEnvironment scopedEnvironment(ShouldUseDebugLayers(attribs),
416 ShouldEnableMockICD(attribs));
Yuly Novikov199f4292018-01-19 19:04:05 -0500417 mEnableValidationLayers = scopedEnvironment.canEnableValidationLayers();
Jamie Madill0ea96212018-10-30 15:14:51 -0400418 mEnableMockICD = scopedEnvironment.canEnableMockICD();
Jamie Madilla66779f2017-01-06 10:43:44 -0500419
Jamie Madill0448ec82016-12-23 13:41:47 -0500420 // Gather global layer properties.
421 uint32_t instanceLayerCount = 0;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400422 ANGLE_VK_TRY(displayVk, vkEnumerateInstanceLayerProperties(&instanceLayerCount, nullptr));
Jamie Madill0448ec82016-12-23 13:41:47 -0500423
424 std::vector<VkLayerProperties> instanceLayerProps(instanceLayerCount);
425 if (instanceLayerCount > 0)
426 {
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400427 ANGLE_VK_TRY(displayVk, vkEnumerateInstanceLayerProperties(&instanceLayerCount,
428 instanceLayerProps.data()));
Jamie Madill0448ec82016-12-23 13:41:47 -0500429 }
430
Jamie Madille09bd5d2016-11-29 16:20:35 -0500431 uint32_t instanceExtensionCount = 0;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400432 ANGLE_VK_TRY(displayVk,
Jamie Madill21061022018-07-12 23:56:30 -0400433 vkEnumerateInstanceExtensionProperties(nullptr, &instanceExtensionCount, nullptr));
Jamie Madille09bd5d2016-11-29 16:20:35 -0500434
435 std::vector<VkExtensionProperties> instanceExtensionProps(instanceExtensionCount);
436 if (instanceExtensionCount > 0)
437 {
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400438 ANGLE_VK_TRY(displayVk,
439 vkEnumerateInstanceExtensionProperties(nullptr, &instanceExtensionCount,
440 instanceExtensionProps.data()));
Jamie Madille09bd5d2016-11-29 16:20:35 -0500441 }
442
Yuly Novikov199f4292018-01-19 19:04:05 -0500443 const char *const *enabledLayerNames = nullptr;
444 uint32_t enabledLayerCount = 0;
Jamie Madill0448ec82016-12-23 13:41:47 -0500445 if (mEnableValidationLayers)
446 {
Yuly Novikov199f4292018-01-19 19:04:05 -0500447 bool layersRequested =
448 (attribs.get(EGL_PLATFORM_ANGLE_DEBUG_LAYERS_ENABLED_ANGLE, EGL_DONT_CARE) == EGL_TRUE);
449 mEnableValidationLayers = GetAvailableValidationLayers(
450 instanceLayerProps, layersRequested, &enabledLayerNames, &enabledLayerCount);
Jamie Madill0448ec82016-12-23 13:41:47 -0500451 }
452
Jamie Madille09bd5d2016-11-29 16:20:35 -0500453 std::vector<const char *> enabledInstanceExtensions;
454 enabledInstanceExtensions.push_back(VK_KHR_SURFACE_EXTENSION_NAME);
Frank Henigman29f148b2016-11-23 21:05:36 -0500455 enabledInstanceExtensions.push_back(wsiName);
Jamie Madille09bd5d2016-11-29 16:20:35 -0500456
Jamie Madill0448ec82016-12-23 13:41:47 -0500457 // TODO(jmadill): Should be able to continue initialization if debug report ext missing.
458 if (mEnableValidationLayers)
459 {
460 enabledInstanceExtensions.push_back(VK_EXT_DEBUG_REPORT_EXTENSION_NAME);
461 }
462
Jamie Madille09bd5d2016-11-29 16:20:35 -0500463 // Verify the required extensions are in the extension names set. Fail if not.
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400464 ANGLE_VK_TRY(displayVk,
Jamie Madill21061022018-07-12 23:56:30 -0400465 VerifyExtensionsPresent(instanceExtensionProps, enabledInstanceExtensions));
Jamie Madille09bd5d2016-11-29 16:20:35 -0500466
Shahbaz Youssefi06270c92018-10-03 17:00:25 -0400467 VkApplicationInfo applicationInfo = {};
Jamie Madill327ba852016-11-30 12:38:28 -0500468 applicationInfo.sType = VK_STRUCTURE_TYPE_APPLICATION_INFO;
Jamie Madill327ba852016-11-30 12:38:28 -0500469 applicationInfo.pApplicationName = "ANGLE";
470 applicationInfo.applicationVersion = 1;
471 applicationInfo.pEngineName = "ANGLE";
472 applicationInfo.engineVersion = 1;
Ian Elliott899c5d22018-12-21 13:12:50 -0700473
474 auto enumerateInstanceVersion = reinterpret_cast<PFN_vkEnumerateInstanceVersion>(
475 vkGetInstanceProcAddr(mInstance, "vkEnumerateInstanceVersion"));
476 if (!enumerateInstanceVersion)
477 {
478 applicationInfo.apiVersion = VK_API_VERSION_1_0;
479 }
480 else
481 {
482 uint32_t apiVersion = VK_API_VERSION_1_0;
483 ANGLE_VK_TRY(displayVk, enumerateInstanceVersion(&apiVersion));
484 if ((VK_VERSION_MAJOR(apiVersion) > 1) || (VK_VERSION_MINOR(apiVersion) >= 1))
485 {
486 // Note: will need to revisit this with Vulkan 1.2+.
487 applicationInfo.apiVersion = VK_API_VERSION_1_1;
488 }
489 else
490 {
491 applicationInfo.apiVersion = VK_API_VERSION_1_0;
492 }
493 }
Jamie Madill327ba852016-11-30 12:38:28 -0500494
Shahbaz Youssefi06270c92018-10-03 17:00:25 -0400495 VkInstanceCreateInfo instanceInfo = {};
Jamie Madillb980c562018-11-27 11:34:27 -0500496 instanceInfo.sType = VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO;
497 instanceInfo.flags = 0;
498 instanceInfo.pApplicationInfo = &applicationInfo;
Jamie Madill327ba852016-11-30 12:38:28 -0500499
Jamie Madille09bd5d2016-11-29 16:20:35 -0500500 // Enable requested layers and extensions.
501 instanceInfo.enabledExtensionCount = static_cast<uint32_t>(enabledInstanceExtensions.size());
502 instanceInfo.ppEnabledExtensionNames =
503 enabledInstanceExtensions.empty() ? nullptr : enabledInstanceExtensions.data();
Yuly Novikov199f4292018-01-19 19:04:05 -0500504 instanceInfo.enabledLayerCount = enabledLayerCount;
505 instanceInfo.ppEnabledLayerNames = enabledLayerNames;
Jamie Madill327ba852016-11-30 12:38:28 -0500506
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400507 ANGLE_VK_TRY(displayVk, vkCreateInstance(&instanceInfo, nullptr, &mInstance));
Jamie Madill327ba852016-11-30 12:38:28 -0500508
Jamie Madill0448ec82016-12-23 13:41:47 -0500509 if (mEnableValidationLayers)
510 {
Shahbaz Youssefi06270c92018-10-03 17:00:25 -0400511 VkDebugReportCallbackCreateInfoEXT debugReportInfo = {};
Jamie Madill0448ec82016-12-23 13:41:47 -0500512
513 debugReportInfo.sType = VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT;
Jamie Madill0448ec82016-12-23 13:41:47 -0500514 debugReportInfo.flags = VK_DEBUG_REPORT_ERROR_BIT_EXT | VK_DEBUG_REPORT_WARNING_BIT_EXT |
515 VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT |
516 VK_DEBUG_REPORT_INFORMATION_BIT_EXT | VK_DEBUG_REPORT_DEBUG_BIT_EXT;
517 debugReportInfo.pfnCallback = &DebugReportCallback;
518 debugReportInfo.pUserData = this;
519
520 auto createDebugReportCallback = reinterpret_cast<PFN_vkCreateDebugReportCallbackEXT>(
521 vkGetInstanceProcAddr(mInstance, "vkCreateDebugReportCallbackEXT"));
522 ASSERT(createDebugReportCallback);
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400523 ANGLE_VK_TRY(displayVk, createDebugReportCallback(mInstance, &debugReportInfo, nullptr,
524 &mDebugReportCallback));
Jamie Madill0448ec82016-12-23 13:41:47 -0500525 }
526
Jamie Madill4d0bf552016-12-28 15:45:24 -0500527 uint32_t physicalDeviceCount = 0;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400528 ANGLE_VK_TRY(displayVk, vkEnumeratePhysicalDevices(mInstance, &physicalDeviceCount, nullptr));
529 ANGLE_VK_CHECK(displayVk, physicalDeviceCount > 0, VK_ERROR_INITIALIZATION_FAILED);
Jamie Madill4d0bf552016-12-28 15:45:24 -0500530
531 // TODO(jmadill): Handle multiple physical devices. For now, use the first device.
Tobin Ehlisa3b220f2018-03-06 16:22:13 -0700532 std::vector<VkPhysicalDevice> physicalDevices(physicalDeviceCount);
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400533 ANGLE_VK_TRY(displayVk, vkEnumeratePhysicalDevices(mInstance, &physicalDeviceCount,
534 physicalDevices.data()));
Jamie Madill0ea96212018-10-30 15:14:51 -0400535 ChoosePhysicalDevice(physicalDevices, mEnableMockICD, &mPhysicalDevice,
Tobin Ehlisa3b220f2018-03-06 16:22:13 -0700536 &mPhysicalDeviceProperties);
Jamie Madill4d0bf552016-12-28 15:45:24 -0500537
Jamie Madill30b5d842018-08-31 17:19:12 -0400538 vkGetPhysicalDeviceFeatures(mPhysicalDevice, &mPhysicalDeviceFeatures);
539
Jamie Madill4d0bf552016-12-28 15:45:24 -0500540 // Ensure we can find a graphics queue family.
541 uint32_t queueCount = 0;
542 vkGetPhysicalDeviceQueueFamilyProperties(mPhysicalDevice, &queueCount, nullptr);
543
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400544 ANGLE_VK_CHECK(displayVk, queueCount > 0, VK_ERROR_INITIALIZATION_FAILED);
Jamie Madill4d0bf552016-12-28 15:45:24 -0500545
546 mQueueFamilyProperties.resize(queueCount);
547 vkGetPhysicalDeviceQueueFamilyProperties(mPhysicalDevice, &queueCount,
548 mQueueFamilyProperties.data());
549
Jamie Madillb980c562018-11-27 11:34:27 -0500550 size_t graphicsQueueFamilyCount = false;
551 uint32_t firstGraphicsQueueFamily = 0;
Shahbaz Youssefi823d8972018-11-13 10:52:40 -0500552 constexpr VkQueueFlags kGraphicsAndCompute = VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT;
Jamie Madill4d0bf552016-12-28 15:45:24 -0500553 for (uint32_t familyIndex = 0; familyIndex < queueCount; ++familyIndex)
554 {
555 const auto &queueInfo = mQueueFamilyProperties[familyIndex];
Shahbaz Youssefi823d8972018-11-13 10:52:40 -0500556 if ((queueInfo.queueFlags & kGraphicsAndCompute) == kGraphicsAndCompute)
Jamie Madill4d0bf552016-12-28 15:45:24 -0500557 {
558 ASSERT(queueInfo.queueCount > 0);
559 graphicsQueueFamilyCount++;
560 if (firstGraphicsQueueFamily == 0)
561 {
562 firstGraphicsQueueFamily = familyIndex;
563 }
564 break;
565 }
566 }
567
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400568 ANGLE_VK_CHECK(displayVk, graphicsQueueFamilyCount > 0, VK_ERROR_INITIALIZATION_FAILED);
Jamie Madill4d0bf552016-12-28 15:45:24 -0500569
570 // If only one queue family, go ahead and initialize the device. If there is more than one
571 // queue, we'll have to wait until we see a WindowSurface to know which supports present.
572 if (graphicsQueueFamilyCount == 1)
573 {
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400574 ANGLE_TRY(initializeDevice(displayVk, firstGraphicsQueueFamily));
Jamie Madill4d0bf552016-12-28 15:45:24 -0500575 }
576
Jamie Madill035fd6b2017-10-03 15:43:22 -0400577 // Store the physical device memory properties so we can find the right memory pools.
578 mMemoryProperties.init(mPhysicalDevice);
Jamie Madill7b57b9d2017-01-13 09:33:38 -0500579
Jamie Madill06ca6342018-07-12 15:56:53 -0400580 GlslangWrapper::Initialize();
Jamie Madill8ecf7f92017-01-13 17:29:52 -0500581
Jamie Madill6a89d222017-11-02 11:59:51 -0400582 // Initialize the format table.
Shahbaz Youssefi96bd8fd2018-11-30 14:30:18 -0500583 mFormatTable.initialize(this, &mNativeTextureCaps, &mNativeCaps.compressedTextureFormats);
Jamie Madill6a89d222017-11-02 11:59:51 -0400584
Jamie Madill7c985f52018-11-29 18:16:17 -0500585 return angle::Result::Continue;
Jamie Madill9e54b5a2016-05-25 12:57:39 -0400586}
587
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400588angle::Result RendererVk::initializeDevice(DisplayVk *displayVk, uint32_t queueFamilyIndex)
Jamie Madill4d0bf552016-12-28 15:45:24 -0500589{
590 uint32_t deviceLayerCount = 0;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400591 ANGLE_VK_TRY(displayVk,
Jamie Madill21061022018-07-12 23:56:30 -0400592 vkEnumerateDeviceLayerProperties(mPhysicalDevice, &deviceLayerCount, nullptr));
Jamie Madill4d0bf552016-12-28 15:45:24 -0500593
594 std::vector<VkLayerProperties> deviceLayerProps(deviceLayerCount);
595 if (deviceLayerCount > 0)
596 {
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400597 ANGLE_VK_TRY(displayVk, vkEnumerateDeviceLayerProperties(mPhysicalDevice, &deviceLayerCount,
598 deviceLayerProps.data()));
Jamie Madill4d0bf552016-12-28 15:45:24 -0500599 }
600
601 uint32_t deviceExtensionCount = 0;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400602 ANGLE_VK_TRY(displayVk, vkEnumerateDeviceExtensionProperties(mPhysicalDevice, nullptr,
603 &deviceExtensionCount, nullptr));
Jamie Madill4d0bf552016-12-28 15:45:24 -0500604
605 std::vector<VkExtensionProperties> deviceExtensionProps(deviceExtensionCount);
606 if (deviceExtensionCount > 0)
607 {
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400608 ANGLE_VK_TRY(displayVk, vkEnumerateDeviceExtensionProperties(mPhysicalDevice, nullptr,
609 &deviceExtensionCount,
610 deviceExtensionProps.data()));
Jamie Madill4d0bf552016-12-28 15:45:24 -0500611 }
612
Yuly Novikov199f4292018-01-19 19:04:05 -0500613 const char *const *enabledLayerNames = nullptr;
614 uint32_t enabledLayerCount = 0;
Jamie Madill4d0bf552016-12-28 15:45:24 -0500615 if (mEnableValidationLayers)
616 {
Yuly Novikov199f4292018-01-19 19:04:05 -0500617 mEnableValidationLayers = GetAvailableValidationLayers(
618 deviceLayerProps, false, &enabledLayerNames, &enabledLayerCount);
Jamie Madill4d0bf552016-12-28 15:45:24 -0500619 }
620
621 std::vector<const char *> enabledDeviceExtensions;
622 enabledDeviceExtensions.push_back(VK_KHR_SWAPCHAIN_EXTENSION_NAME);
623
Ian Elliottbcb78902018-12-19 11:46:29 -0700624 initFeatures(deviceExtensionProps);
625 mFeaturesInitialized = true;
626
Luc Ferronbf6dc372018-06-28 15:24:19 -0400627 // Selectively enable KHR_MAINTENANCE1 to support viewport flipping.
Ian Elliott52f5da42018-12-21 09:02:09 -0700628 if ((getFeatures().flipViewportY) &&
629 (mPhysicalDeviceProperties.apiVersion < VK_MAKE_VERSION(1, 1, 0)))
Luc Ferronbf6dc372018-06-28 15:24:19 -0400630 {
631 enabledDeviceExtensions.push_back(VK_KHR_MAINTENANCE1_EXTENSION_NAME);
632 }
Ian Elliottbcb78902018-12-19 11:46:29 -0700633 if (getFeatures().supportsIncrementalPresent)
634 {
635 enabledDeviceExtensions.push_back(VK_KHR_INCREMENTAL_PRESENT_EXTENSION_NAME);
636 }
Luc Ferronbf6dc372018-06-28 15:24:19 -0400637
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400638 ANGLE_VK_TRY(displayVk, VerifyExtensionsPresent(deviceExtensionProps, enabledDeviceExtensions));
Jamie Madill4d0bf552016-12-28 15:45:24 -0500639
Shahbaz Youssefi563fbaa2018-10-02 11:22:01 -0400640 // Select additional features to be enabled
641 VkPhysicalDeviceFeatures enabledFeatures = {};
642 enabledFeatures.inheritedQueries = mPhysicalDeviceFeatures.inheritedQueries;
643
Shahbaz Youssefi06270c92018-10-03 17:00:25 -0400644 VkDeviceQueueCreateInfo queueCreateInfo = {};
Jamie Madill4d0bf552016-12-28 15:45:24 -0500645
646 float zeroPriority = 0.0f;
647
648 queueCreateInfo.sType = VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO;
Jamie Madill4d0bf552016-12-28 15:45:24 -0500649 queueCreateInfo.flags = 0;
650 queueCreateInfo.queueFamilyIndex = queueFamilyIndex;
651 queueCreateInfo.queueCount = 1;
652 queueCreateInfo.pQueuePriorities = &zeroPriority;
653
654 // Initialize the device
Shahbaz Youssefi06270c92018-10-03 17:00:25 -0400655 VkDeviceCreateInfo createInfo = {};
Jamie Madill4d0bf552016-12-28 15:45:24 -0500656
Jamie Madill50cf2be2018-06-15 09:46:57 -0400657 createInfo.sType = VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO;
Jamie Madill50cf2be2018-06-15 09:46:57 -0400658 createInfo.flags = 0;
659 createInfo.queueCreateInfoCount = 1;
660 createInfo.pQueueCreateInfos = &queueCreateInfo;
Yuly Novikov199f4292018-01-19 19:04:05 -0500661 createInfo.enabledLayerCount = enabledLayerCount;
662 createInfo.ppEnabledLayerNames = enabledLayerNames;
Jamie Madill4d0bf552016-12-28 15:45:24 -0500663 createInfo.enabledExtensionCount = static_cast<uint32_t>(enabledDeviceExtensions.size());
664 createInfo.ppEnabledExtensionNames =
665 enabledDeviceExtensions.empty() ? nullptr : enabledDeviceExtensions.data();
Shahbaz Youssefi563fbaa2018-10-02 11:22:01 -0400666 createInfo.pEnabledFeatures = &enabledFeatures;
Jamie Madill4d0bf552016-12-28 15:45:24 -0500667
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400668 ANGLE_VK_TRY(displayVk, vkCreateDevice(mPhysicalDevice, &createInfo, nullptr, &mDevice));
Jamie Madill4d0bf552016-12-28 15:45:24 -0500669
670 mCurrentQueueFamilyIndex = queueFamilyIndex;
671
672 vkGetDeviceQueue(mDevice, mCurrentQueueFamilyIndex, 0, &mQueue);
673
674 // Initialize the command pool now that we know the queue family index.
Shahbaz Youssefi06270c92018-10-03 17:00:25 -0400675 VkCommandPoolCreateInfo commandPoolInfo = {};
Jamie Madillb980c562018-11-27 11:34:27 -0500676 commandPoolInfo.sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO;
677 commandPoolInfo.flags = VK_COMMAND_POOL_CREATE_TRANSIENT_BIT;
678 commandPoolInfo.queueFamilyIndex = mCurrentQueueFamilyIndex;
Jamie Madill4d0bf552016-12-28 15:45:24 -0500679
Yuly Novikov27780292018-11-09 11:19:49 -0500680 ANGLE_VK_TRY(displayVk, mCommandPool.init(mDevice, commandPoolInfo));
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400681
Shahbaz Youssefi3a482172018-10-11 10:34:44 -0400682 // Initialize the vulkan pipeline cache.
Jamie Madilldc65c5b2018-11-21 11:07:26 -0500683 ANGLE_TRY(initPipelineCache(displayVk));
Jamie Madill4d0bf552016-12-28 15:45:24 -0500684
Shahbaz Youssefi3a482172018-10-11 10:34:44 -0400685 // Initialize the submission semaphore pool.
686 ANGLE_TRY(mSubmitSemaphorePool.init(displayVk, vk::kDefaultSemaphorePoolSize));
687
Shahbaz Youssefi25224e72018-10-22 11:56:02 -0400688#if ANGLE_ENABLE_VULKAN_GPU_TRACE_EVENTS
689 angle::PlatformMethods *platform = ANGLEPlatformCurrent();
690 ASSERT(platform);
691
692 // GPU tracing workaround for anglebug.com/2927. The renderer should not emit gpu events during
693 // platform discovery.
694 const unsigned char *gpuEventsEnabled =
695 platform->getTraceCategoryEnabledFlag(platform, "gpu.angle.gpu");
696 mGpuEventsEnabled = gpuEventsEnabled && *gpuEventsEnabled;
697#endif
698
699 if (mGpuEventsEnabled)
700 {
701 // Calculate the difference between CPU and GPU clocks for GPU event reporting.
702 ANGLE_TRY(mGpuEventQueryPool.init(displayVk, VK_QUERY_TYPE_TIMESTAMP,
703 vk::kDefaultTimestampQueryPoolSize));
704 ANGLE_TRY(synchronizeCpuGpuTime(displayVk));
705 }
706
Jamie Madill7c985f52018-11-29 18:16:17 -0500707 return angle::Result::Continue;
Jamie Madill4d0bf552016-12-28 15:45:24 -0500708}
709
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400710angle::Result RendererVk::selectPresentQueueForSurface(DisplayVk *displayVk,
Jamie Madill21061022018-07-12 23:56:30 -0400711 VkSurfaceKHR surface,
712 uint32_t *presentQueueOut)
Jamie Madill4d0bf552016-12-28 15:45:24 -0500713{
714 // We've already initialized a device, and can't re-create it unless it's never been used.
715 // TODO(jmadill): Handle the re-creation case if necessary.
716 if (mDevice != VK_NULL_HANDLE)
717 {
718 ASSERT(mCurrentQueueFamilyIndex != std::numeric_limits<uint32_t>::max());
719
720 // Check if the current device supports present on this surface.
721 VkBool32 supportsPresent = VK_FALSE;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400722 ANGLE_VK_TRY(displayVk,
Jamie Madill21061022018-07-12 23:56:30 -0400723 vkGetPhysicalDeviceSurfaceSupportKHR(mPhysicalDevice, mCurrentQueueFamilyIndex,
Jamie Madill4d0bf552016-12-28 15:45:24 -0500724 surface, &supportsPresent));
725
Jamie Madill6cad7732018-07-11 09:01:17 -0400726 if (supportsPresent == VK_TRUE)
727 {
728 *presentQueueOut = mCurrentQueueFamilyIndex;
Jamie Madill7c985f52018-11-29 18:16:17 -0500729 return angle::Result::Continue;
Jamie Madill6cad7732018-07-11 09:01:17 -0400730 }
Jamie Madill4d0bf552016-12-28 15:45:24 -0500731 }
732
733 // Find a graphics and present queue.
734 Optional<uint32_t> newPresentQueue;
735 uint32_t queueCount = static_cast<uint32_t>(mQueueFamilyProperties.size());
Shahbaz Youssefi823d8972018-11-13 10:52:40 -0500736 constexpr VkQueueFlags kGraphicsAndCompute = VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT;
Jamie Madill4d0bf552016-12-28 15:45:24 -0500737 for (uint32_t queueIndex = 0; queueIndex < queueCount; ++queueIndex)
738 {
739 const auto &queueInfo = mQueueFamilyProperties[queueIndex];
Shahbaz Youssefi823d8972018-11-13 10:52:40 -0500740 if ((queueInfo.queueFlags & kGraphicsAndCompute) == kGraphicsAndCompute)
Jamie Madill4d0bf552016-12-28 15:45:24 -0500741 {
742 VkBool32 supportsPresent = VK_FALSE;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400743 ANGLE_VK_TRY(displayVk, vkGetPhysicalDeviceSurfaceSupportKHR(
744 mPhysicalDevice, queueIndex, surface, &supportsPresent));
Jamie Madill4d0bf552016-12-28 15:45:24 -0500745
746 if (supportsPresent == VK_TRUE)
747 {
748 newPresentQueue = queueIndex;
749 break;
750 }
751 }
752 }
753
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400754 ANGLE_VK_CHECK(displayVk, newPresentQueue.valid(), VK_ERROR_INITIALIZATION_FAILED);
755 ANGLE_TRY(initializeDevice(displayVk, newPresentQueue.value()));
Jamie Madill4d0bf552016-12-28 15:45:24 -0500756
Jamie Madill6cad7732018-07-11 09:01:17 -0400757 *presentQueueOut = newPresentQueue.value();
Jamie Madill7c985f52018-11-29 18:16:17 -0500758 return angle::Result::Continue;
Jamie Madill4d0bf552016-12-28 15:45:24 -0500759}
760
761std::string RendererVk::getVendorString() const
762{
Olli Etuahoc6a06182018-04-13 14:11:46 +0300763 return GetVendorString(mPhysicalDeviceProperties.vendorID);
Jamie Madill4d0bf552016-12-28 15:45:24 -0500764}
765
Jamie Madille09bd5d2016-11-29 16:20:35 -0500766std::string RendererVk::getRendererDescription() const
767{
Jamie Madill4d0bf552016-12-28 15:45:24 -0500768 std::stringstream strstr;
769
770 uint32_t apiVersion = mPhysicalDeviceProperties.apiVersion;
771
772 strstr << "Vulkan ";
773 strstr << VK_VERSION_MAJOR(apiVersion) << ".";
774 strstr << VK_VERSION_MINOR(apiVersion) << ".";
775 strstr << VK_VERSION_PATCH(apiVersion);
776
Olli Etuahoc6a06182018-04-13 14:11:46 +0300777 strstr << "(";
778
779 // In the case of NVIDIA, deviceName does not necessarily contain "NVIDIA". Add "NVIDIA" so that
780 // Vulkan end2end tests can be selectively disabled on NVIDIA. TODO(jmadill): should not be
781 // needed after http://anglebug.com/1874 is fixed and end2end_tests use more sophisticated
782 // driver detection.
783 if (mPhysicalDeviceProperties.vendorID == VENDOR_ID_NVIDIA)
784 {
785 strstr << GetVendorString(mPhysicalDeviceProperties.vendorID) << " ";
786 }
787
Geoff Langa7af56b2018-12-14 14:20:28 -0500788 strstr << mPhysicalDeviceProperties.deviceName;
789 strstr << " (" << gl::FmtHex(mPhysicalDeviceProperties.deviceID) << ")";
790
791 strstr << ")";
Jamie Madill4d0bf552016-12-28 15:45:24 -0500792
793 return strstr.str();
Jamie Madille09bd5d2016-11-29 16:20:35 -0500794}
795
Shahbaz Youssefi092481a2018-11-08 00:25:50 -0500796gl::Version RendererVk::getMaxSupportedESVersion() const
797{
798 // Declare GLES2 support if necessary features for GLES3 are missing
799 bool necessaryFeaturesForES3 = mPhysicalDeviceFeatures.inheritedQueries;
800
801 if (!necessaryFeaturesForES3)
802 {
803 return gl::Version(2, 0);
804 }
805
806 return gl::Version(3, 0);
807}
808
Ian Elliottbcb78902018-12-19 11:46:29 -0700809void RendererVk::initFeatures(const std::vector<VkExtensionProperties> &deviceExtensionProps)
Jamie Madill12222072018-07-11 14:59:48 -0400810{
Jamie Madillb36a4812018-09-25 10:15:11 -0400811// Use OpenGL line rasterization rules by default.
812// TODO(jmadill): Fix Android support. http://anglebug.com/2830
813#if defined(ANGLE_PLATFORM_ANDROID)
814 mFeatures.basicGLLineRasterization = false;
815#else
Jamie Madill12222072018-07-11 14:59:48 -0400816 mFeatures.basicGLLineRasterization = true;
Jamie Madillb36a4812018-09-25 10:15:11 -0400817#endif // defined(ANGLE_PLATFORM_ANDROID)
Jamie Madill12222072018-07-11 14:59:48 -0400818
Ian Elliott52f5da42018-12-21 09:02:09 -0700819 if ((mPhysicalDeviceProperties.apiVersion >= VK_MAKE_VERSION(1, 1, 0)) ||
820 ExtensionFound(VK_KHR_MAINTENANCE1_EXTENSION_NAME, deviceExtensionProps))
Ian Elliottd50521f2018-12-20 12:05:14 -0700821 {
822 // TODO(lucferron): Currently disabled on Intel only since many tests are failing and need
823 // investigation. http://anglebug.com/2728
824 mFeatures.flipViewportY = !IsIntel(mPhysicalDeviceProperties.vendorID);
825 }
Frank Henigmanbeb669d2018-09-21 16:25:52 -0400826
827#ifdef ANGLE_PLATFORM_WINDOWS
828 // http://anglebug.com/2838
829 mFeatures.extraCopyBufferRegion = IsIntel(mPhysicalDeviceProperties.vendorID);
830#endif
Shahbaz Youssefid856ca42018-10-31 16:55:12 -0400831
832 angle::PlatformMethods *platform = ANGLEPlatformCurrent();
833 platform->overrideFeaturesVk(platform, &mFeatures);
Jamie Madillfde74c02018-11-18 16:12:02 -0500834
835 // Work around incorrect NVIDIA point size range clamping.
836 // TODO(jmadill): Narrow driver range once fixed. http://anglebug.com/2970
837 if (IsNvidia(mPhysicalDeviceProperties.vendorID))
838 {
839 mFeatures.clampPointSize = true;
840 }
Shahbaz Youssefi611bbaa2018-12-06 01:59:53 +0100841
842#if defined(ANGLE_PLATFORM_ANDROID)
Shahbaz Youssefib08457d2018-12-11 15:13:54 -0500843 // Work around ineffective compute-graphics barriers on Nexus 5X.
844 // TODO(syoussefi): Figure out which other vendors and driver versions are affected.
845 // http://anglebug.com/3019
846 mFeatures.flushAfterVertexConversion =
847 IsNexus5X(mPhysicalDeviceProperties.vendorID, mPhysicalDeviceProperties.deviceID);
Shahbaz Youssefi611bbaa2018-12-06 01:59:53 +0100848#endif
Ian Elliottbcb78902018-12-19 11:46:29 -0700849
850 if (ExtensionFound(VK_KHR_INCREMENTAL_PRESENT_EXTENSION_NAME, deviceExtensionProps))
851 {
852 mFeatures.supportsIncrementalPresent = true;
853 }
Jamie Madill12222072018-07-11 14:59:48 -0400854}
855
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400856void RendererVk::initPipelineCacheVkKey()
857{
858 std::ostringstream hashStream("ANGLE Pipeline Cache: ", std::ios_base::ate);
859 // Add the pipeline cache UUID to make sure the blob cache always gives a compatible pipeline
860 // cache. It's not particularly necessary to write it as a hex number as done here, so long as
861 // there is no '\0' in the result.
862 for (const uint32_t c : mPhysicalDeviceProperties.pipelineCacheUUID)
863 {
864 hashStream << std::hex << c;
865 }
866 // Add the vendor and device id too for good measure.
867 hashStream << std::hex << mPhysicalDeviceProperties.vendorID;
868 hashStream << std::hex << mPhysicalDeviceProperties.deviceID;
869
870 const std::string &hashString = hashStream.str();
871 angle::base::SHA1HashBytes(reinterpret_cast<const unsigned char *>(hashString.c_str()),
872 hashString.length(), mPipelineCacheVkBlobKey.data());
873}
874
Jamie Madilldc65c5b2018-11-21 11:07:26 -0500875angle::Result RendererVk::initPipelineCache(DisplayVk *display)
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400876{
877 initPipelineCacheVkKey();
878
879 egl::BlobCache::Value initialData;
880 bool success = display->getBlobCache()->get(display->getScratchBuffer(),
881 mPipelineCacheVkBlobKey, &initialData);
882
Shahbaz Youssefi06270c92018-10-03 17:00:25 -0400883 VkPipelineCacheCreateInfo pipelineCacheCreateInfo = {};
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400884
885 pipelineCacheCreateInfo.sType = VK_STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400886 pipelineCacheCreateInfo.flags = 0;
887 pipelineCacheCreateInfo.initialDataSize = success ? initialData.size() : 0;
888 pipelineCacheCreateInfo.pInitialData = success ? initialData.data() : nullptr;
889
Jamie Madilldc65c5b2018-11-21 11:07:26 -0500890 ANGLE_VK_TRY(display, mPipelineCache.init(mDevice, pipelineCacheCreateInfo));
Jamie Madill7c985f52018-11-29 18:16:17 -0500891 return angle::Result::Continue;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -0400892}
893
Jamie Madillacccc6c2016-05-03 17:22:10 -0400894void RendererVk::ensureCapsInitialized() const
895{
896 if (!mCapsInitialized)
897 {
Shahbaz Youssefic2b576d2018-10-12 14:45:34 -0400898 ASSERT(mCurrentQueueFamilyIndex < mQueueFamilyProperties.size());
899 vk::GenerateCaps(mPhysicalDeviceProperties, mPhysicalDeviceFeatures,
900 mQueueFamilyProperties[mCurrentQueueFamilyIndex], mNativeTextureCaps,
Jamie Madill30b5d842018-08-31 17:19:12 -0400901 &mNativeCaps, &mNativeExtensions, &mNativeLimitations);
Jamie Madillacccc6c2016-05-03 17:22:10 -0400902 mCapsInitialized = true;
903 }
904}
905
Shahbaz Youssefi3a482172018-10-11 10:34:44 -0400906void RendererVk::getSubmitWaitSemaphores(
907 vk::Context *context,
Shahbaz Youssefi25224e72018-10-22 11:56:02 -0400908 angle::FixedVector<VkSemaphore, kMaxWaitSemaphores> *waitSemaphores,
909 angle::FixedVector<VkPipelineStageFlags, kMaxWaitSemaphores> *waitStageMasks)
Shahbaz Youssefi3a482172018-10-11 10:34:44 -0400910{
911 if (mSubmitLastSignaledSemaphore.getSemaphore())
912 {
913 waitSemaphores->push_back(mSubmitLastSignaledSemaphore.getSemaphore()->getHandle());
Shahbaz Youssefi25224e72018-10-22 11:56:02 -0400914 waitStageMasks->push_back(VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT);
Shahbaz Youssefi3a482172018-10-11 10:34:44 -0400915
916 // Return the semaphore to the pool (which will remain valid and unused until the
917 // queue it's about to be waited on has finished execution).
918 mSubmitSemaphorePool.freeSemaphore(context, &mSubmitLastSignaledSemaphore);
919 }
920
921 for (vk::SemaphoreHelper &semaphore : mSubmitWaitSemaphores)
922 {
923 waitSemaphores->push_back(semaphore.getSemaphore()->getHandle());
Shahbaz Youssefi25224e72018-10-22 11:56:02 -0400924 waitStageMasks->push_back(VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT);
925
Shahbaz Youssefi3a482172018-10-11 10:34:44 -0400926 mSubmitSemaphorePool.freeSemaphore(context, &semaphore);
927 }
928 mSubmitWaitSemaphores.clear();
929}
930
Jamie Madillacccc6c2016-05-03 17:22:10 -0400931const gl::Caps &RendererVk::getNativeCaps() const
932{
933 ensureCapsInitialized();
934 return mNativeCaps;
935}
936
937const gl::TextureCapsMap &RendererVk::getNativeTextureCaps() const
938{
939 ensureCapsInitialized();
940 return mNativeTextureCaps;
941}
942
943const gl::Extensions &RendererVk::getNativeExtensions() const
944{
945 ensureCapsInitialized();
946 return mNativeExtensions;
947}
948
949const gl::Limitations &RendererVk::getNativeLimitations() const
950{
951 ensureCapsInitialized();
952 return mNativeLimitations;
953}
954
Luc Ferrondaedf4d2018-03-16 09:28:53 -0400955uint32_t RendererVk::getMaxActiveTextures()
956{
957 // TODO(lucferron): expose this limitation to GL in Context Caps
958 return std::min<uint32_t>(mPhysicalDeviceProperties.limits.maxPerStageDescriptorSamplers,
959 gl::IMPLEMENTATION_MAX_ACTIVE_TEXTURES);
960}
961
Jamie Madill49ac74b2017-12-21 14:42:33 -0500962const vk::CommandPool &RendererVk::getCommandPool() const
Jamie Madill4d0bf552016-12-28 15:45:24 -0500963{
Jamie Madill49ac74b2017-12-21 14:42:33 -0500964 return mCommandPool;
Jamie Madill4d0bf552016-12-28 15:45:24 -0500965}
966
Jamie Madill21061022018-07-12 23:56:30 -0400967angle::Result RendererVk::finish(vk::Context *context)
Jamie Madill4d0bf552016-12-28 15:45:24 -0500968{
Jamie Madill1f46bc12018-02-20 16:09:43 -0500969 if (!mCommandGraph.empty())
Jamie Madill49ac74b2017-12-21 14:42:33 -0500970 {
Shahbaz Youssefi61656022018-10-24 15:00:50 -0400971 TRACE_EVENT0("gpu.angle", "RendererVk::finish");
972
Luc Ferron1617e692018-07-11 11:08:19 -0400973 vk::Scoped<vk::CommandBuffer> commandBatch(mDevice);
974 ANGLE_TRY(flushCommandGraph(context, &commandBatch.get()));
Jamie Madill0c0dc342017-03-24 14:18:51 -0400975
Shahbaz Youssefi3a482172018-10-11 10:34:44 -0400976 angle::FixedVector<VkSemaphore, kMaxWaitSemaphores> waitSemaphores;
Shahbaz Youssefi25224e72018-10-22 11:56:02 -0400977 angle::FixedVector<VkPipelineStageFlags, kMaxWaitSemaphores> waitStageMasks;
978 getSubmitWaitSemaphores(context, &waitSemaphores, &waitStageMasks);
Shahbaz Youssefi3a482172018-10-11 10:34:44 -0400979
Shahbaz Youssefi06270c92018-10-03 17:00:25 -0400980 VkSubmitInfo submitInfo = {};
Jamie Madill49ac74b2017-12-21 14:42:33 -0500981 submitInfo.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO;
Shahbaz Youssefi3a482172018-10-11 10:34:44 -0400982 submitInfo.waitSemaphoreCount = static_cast<uint32_t>(waitSemaphores.size());
983 submitInfo.pWaitSemaphores = waitSemaphores.data();
Shahbaz Youssefi25224e72018-10-22 11:56:02 -0400984 submitInfo.pWaitDstStageMask = waitStageMasks.data();
Jamie Madill49ac74b2017-12-21 14:42:33 -0500985 submitInfo.commandBufferCount = 1;
Luc Ferron1617e692018-07-11 11:08:19 -0400986 submitInfo.pCommandBuffers = commandBatch.get().ptr();
Jamie Madill49ac74b2017-12-21 14:42:33 -0500987 submitInfo.signalSemaphoreCount = 0;
988 submitInfo.pSignalSemaphores = nullptr;
Jamie Madill4d0bf552016-12-28 15:45:24 -0500989
Jamie Madill21061022018-07-12 23:56:30 -0400990 ANGLE_TRY(submitFrame(context, submitInfo, std::move(commandBatch.get())));
Jamie Madill49ac74b2017-12-21 14:42:33 -0500991 }
Jamie Madill4d0bf552016-12-28 15:45:24 -0500992
Jamie Madill4c26fc22017-02-24 11:04:10 -0500993 ASSERT(mQueue != VK_NULL_HANDLE);
Jamie Madill21061022018-07-12 23:56:30 -0400994 ANGLE_VK_TRY(context, vkQueueWaitIdle(mQueue));
Jamie Madill0c0dc342017-03-24 14:18:51 -0400995 freeAllInFlightResources();
Shahbaz Youssefi25224e72018-10-22 11:56:02 -0400996
997 if (mGpuEventsEnabled)
998 {
Shahbaz Youssefi749589f2018-10-25 12:48:49 -0400999 // This loop should in practice execute once since the queue is already idle.
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001000 while (mInFlightGpuEventQueries.size() > 0)
1001 {
1002 ANGLE_TRY(checkCompletedGpuEvents(context));
1003 }
Shahbaz Youssefi749589f2018-10-25 12:48:49 -04001004 // Recalculate the CPU/GPU time difference to account for clock drifting. Avoid unnecessary
1005 // synchronization if there is no event to be adjusted (happens when finish() gets called
1006 // multiple times towards the end of the application).
1007 if (mGpuEvents.size() > 0)
1008 {
1009 ANGLE_TRY(synchronizeCpuGpuTime(context));
1010 }
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001011 }
1012
Jamie Madill7c985f52018-11-29 18:16:17 -05001013 return angle::Result::Continue;
Jamie Madill4c26fc22017-02-24 11:04:10 -05001014}
1015
Jamie Madill0c0dc342017-03-24 14:18:51 -04001016void RendererVk::freeAllInFlightResources()
1017{
Jamie Madill49ac74b2017-12-21 14:42:33 -05001018 for (CommandBatch &batch : mInFlightCommands)
Jamie Madill0c0dc342017-03-24 14:18:51 -04001019 {
Yuly Novikovb56ddbb2018-11-02 16:53:18 -04001020 // On device loss we need to wait for fence to be signaled before destroying it
1021 if (mDeviceLost)
1022 {
1023 VkResult status = batch.fence.wait(mDevice, kMaxFenceWaitTimeNs);
1024 // If wait times out, it is probably not possible to recover from lost device
1025 ASSERT(status == VK_SUCCESS || status == VK_ERROR_DEVICE_LOST);
1026 }
Jamie Madill49ac74b2017-12-21 14:42:33 -05001027 batch.fence.destroy(mDevice);
1028 batch.commandPool.destroy(mDevice);
Jamie Madill0c0dc342017-03-24 14:18:51 -04001029 }
1030 mInFlightCommands.clear();
1031
1032 for (auto &garbage : mGarbage)
1033 {
Jamie Madille88ec8e2017-10-31 17:18:14 -04001034 garbage.destroy(mDevice);
Jamie Madill0c0dc342017-03-24 14:18:51 -04001035 }
1036 mGarbage.clear();
Shahbaz Youssefi61656022018-10-24 15:00:50 -04001037
1038 mLastCompletedQueueSerial = mLastSubmittedQueueSerial;
Jamie Madill0c0dc342017-03-24 14:18:51 -04001039}
1040
Shahbaz Youssefic4765aa2018-10-12 14:40:29 -04001041angle::Result RendererVk::checkCompletedCommands(vk::Context *context)
Jamie Madill4c26fc22017-02-24 11:04:10 -05001042{
Jamie Madill49ac74b2017-12-21 14:42:33 -05001043 int finishedCount = 0;
Jamie Madillf651c772017-02-21 15:03:51 -05001044
Jamie Madill49ac74b2017-12-21 14:42:33 -05001045 for (CommandBatch &batch : mInFlightCommands)
Jamie Madill4c26fc22017-02-24 11:04:10 -05001046 {
Yuly Novikov27780292018-11-09 11:19:49 -05001047 VkResult result = batch.fence.getStatus(mDevice);
1048 if (result == VK_NOT_READY)
1049 {
Jamie Madill0c0dc342017-03-24 14:18:51 -04001050 break;
Yuly Novikov27780292018-11-09 11:19:49 -05001051 }
1052 ANGLE_VK_TRY(context, result);
Jamie Madill49ac74b2017-12-21 14:42:33 -05001053
Jamie Madill49ac74b2017-12-21 14:42:33 -05001054 ASSERT(batch.serial > mLastCompletedQueueSerial);
1055 mLastCompletedQueueSerial = batch.serial;
Jamie Madill0c0dc342017-03-24 14:18:51 -04001056
Jamie Madill49ac74b2017-12-21 14:42:33 -05001057 batch.fence.destroy(mDevice);
1058 batch.commandPool.destroy(mDevice);
1059 ++finishedCount;
Jamie Madill4c26fc22017-02-24 11:04:10 -05001060 }
1061
Jamie Madill49ac74b2017-12-21 14:42:33 -05001062 mInFlightCommands.erase(mInFlightCommands.begin(), mInFlightCommands.begin() + finishedCount);
Jamie Madill0c0dc342017-03-24 14:18:51 -04001063
1064 size_t freeIndex = 0;
1065 for (; freeIndex < mGarbage.size(); ++freeIndex)
1066 {
Jamie Madill49ac74b2017-12-21 14:42:33 -05001067 if (!mGarbage[freeIndex].destroyIfComplete(mDevice, mLastCompletedQueueSerial))
Jamie Madill0c0dc342017-03-24 14:18:51 -04001068 break;
1069 }
1070
1071 // Remove the entries from the garbage list - they should be ready to go.
1072 if (freeIndex > 0)
1073 {
1074 mGarbage.erase(mGarbage.begin(), mGarbage.begin() + freeIndex);
Jamie Madillf651c772017-02-21 15:03:51 -05001075 }
1076
Jamie Madill7c985f52018-11-29 18:16:17 -05001077 return angle::Result::Continue;
Jamie Madill4c26fc22017-02-24 11:04:10 -05001078}
1079
Jamie Madill21061022018-07-12 23:56:30 -04001080angle::Result RendererVk::submitFrame(vk::Context *context,
1081 const VkSubmitInfo &submitInfo,
1082 vk::CommandBuffer &&commandBuffer)
Jamie Madill4c26fc22017-02-24 11:04:10 -05001083{
Tobin Ehlis573f76b2018-05-03 11:10:44 -06001084 TRACE_EVENT0("gpu.angle", "RendererVk::submitFrame");
Shahbaz Youssefi06270c92018-10-03 17:00:25 -04001085 VkFenceCreateInfo fenceInfo = {};
Jamie Madillb980c562018-11-27 11:34:27 -05001086 fenceInfo.sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO;
1087 fenceInfo.flags = 0;
Jamie Madill49ac74b2017-12-21 14:42:33 -05001088
Jamie Madillbea35a62018-07-05 11:54:10 -04001089 vk::Scoped<CommandBatch> scopedBatch(mDevice);
1090 CommandBatch &batch = scopedBatch.get();
Yuly Novikov27780292018-11-09 11:19:49 -05001091 ANGLE_VK_TRY(context, batch.fence.init(mDevice, fenceInfo));
Jamie Madill49ac74b2017-12-21 14:42:33 -05001092
Jamie Madill21061022018-07-12 23:56:30 -04001093 ANGLE_VK_TRY(context, vkQueueSubmit(mQueue, 1, &submitInfo, batch.fence.getHandle()));
Jamie Madill4c26fc22017-02-24 11:04:10 -05001094
1095 // Store this command buffer in the in-flight list.
Jamie Madill49ac74b2017-12-21 14:42:33 -05001096 batch.commandPool = std::move(mCommandPool);
1097 batch.serial = mCurrentQueueSerial;
Jamie Madill4c26fc22017-02-24 11:04:10 -05001098
Jamie Madillbea35a62018-07-05 11:54:10 -04001099 mInFlightCommands.emplace_back(scopedBatch.release());
Jamie Madill0c0dc342017-03-24 14:18:51 -04001100
Shahbaz Youssefi61656022018-10-24 15:00:50 -04001101 // CPU should be throttled to avoid mInFlightCommands from growing too fast. That is done on
1102 // swap() though, and there could be multiple submissions in between (through glFlush() calls),
Shahbaz Youssefi611bbaa2018-12-06 01:59:53 +01001103 // so the limit is larger than the expected number of images. The
1104 // InterleavedAttributeDataBenchmark perf test for example issues a large number of flushes.
Shahbaz Youssefi61656022018-10-24 15:00:50 -04001105 ASSERT(mInFlightCommands.size() <= kInFlightCommandsLimit);
Jamie Madill0c0dc342017-03-24 14:18:51 -04001106
1107 // Increment the queue serial. If this fails, we should restart ANGLE.
Jamie Madillfb05bcb2017-06-07 15:43:18 -04001108 // TODO(jmadill): Overflow check.
Shahbaz Youssefi61656022018-10-24 15:00:50 -04001109 mLastSubmittedQueueSerial = mCurrentQueueSerial;
Jamie Madillb980c562018-11-27 11:34:27 -05001110 mCurrentQueueSerial = mQueueSerialFactory.generate();
Jamie Madill0c0dc342017-03-24 14:18:51 -04001111
Shahbaz Youssefic4765aa2018-10-12 14:40:29 -04001112 ANGLE_TRY(checkCompletedCommands(context));
Jamie Madill0c0dc342017-03-24 14:18:51 -04001113
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001114 if (mGpuEventsEnabled)
1115 {
1116 ANGLE_TRY(checkCompletedGpuEvents(context));
1117 }
1118
Jamie Madill49ac74b2017-12-21 14:42:33 -05001119 // Simply null out the command buffer here - it was allocated using the command pool.
1120 commandBuffer.releaseHandle();
1121
1122 // Reallocate the command pool for next frame.
1123 // TODO(jmadill): Consider reusing command pools.
Shahbaz Youssefi06270c92018-10-03 17:00:25 -04001124 VkCommandPoolCreateInfo poolInfo = {};
Shahbaz Youssefi749589f2018-10-25 12:48:49 -04001125 poolInfo.sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO;
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001126 poolInfo.flags = VK_COMMAND_POOL_CREATE_TRANSIENT_BIT;
Shahbaz Youssefi749589f2018-10-25 12:48:49 -04001127 poolInfo.queueFamilyIndex = mCurrentQueueFamilyIndex;
Jamie Madill49ac74b2017-12-21 14:42:33 -05001128
Yuly Novikov27780292018-11-09 11:19:49 -05001129 ANGLE_VK_TRY(context, mCommandPool.init(mDevice, poolInfo));
Jamie Madill7c985f52018-11-29 18:16:17 -05001130 return angle::Result::Continue;
Jamie Madill4c26fc22017-02-24 11:04:10 -05001131}
1132
Jamie Madillaaca96e2018-06-12 10:19:48 -04001133bool RendererVk::isSerialInUse(Serial serial) const
Jamie Madill97760352017-11-09 13:08:29 -05001134{
1135 return serial > mLastCompletedQueueSerial;
1136}
1137
Shahbaz Youssefic4765aa2018-10-12 14:40:29 -04001138angle::Result RendererVk::finishToSerial(vk::Context *context, Serial serial)
1139{
1140 if (!isSerialInUse(serial) || mInFlightCommands.empty())
1141 {
Jamie Madill7c985f52018-11-29 18:16:17 -05001142 return angle::Result::Continue;
Shahbaz Youssefic4765aa2018-10-12 14:40:29 -04001143 }
1144
1145 // Find the first batch with serial equal to or bigger than given serial (note that
1146 // the batch serials are unique, otherwise upper-bound would have been necessary).
1147 size_t batchIndex = mInFlightCommands.size() - 1;
1148 for (size_t i = 0; i < mInFlightCommands.size(); ++i)
1149 {
1150 if (mInFlightCommands[i].serial >= serial)
1151 {
1152 batchIndex = i;
1153 break;
1154 }
1155 }
1156 const CommandBatch &batch = mInFlightCommands[batchIndex];
1157
1158 // Wait for it finish
Yuly Novikov27780292018-11-09 11:19:49 -05001159 ANGLE_VK_TRY(context, batch.fence.wait(mDevice, kMaxFenceWaitTimeNs));
Shahbaz Youssefic4765aa2018-10-12 14:40:29 -04001160
1161 // Clean up finished batches.
1162 return checkCompletedCommands(context);
1163}
1164
Jamie Madill21061022018-07-12 23:56:30 -04001165angle::Result RendererVk::getCompatibleRenderPass(vk::Context *context,
1166 const vk::RenderPassDesc &desc,
1167 vk::RenderPass **renderPassOut)
Jamie Madill9f2a8612017-11-30 12:43:09 -05001168{
Jamie Madill21061022018-07-12 23:56:30 -04001169 return mRenderPassCache.getCompatibleRenderPass(context, mCurrentQueueSerial, desc,
Jamie Madill9f2a8612017-11-30 12:43:09 -05001170 renderPassOut);
1171}
1172
Jamie Madill21061022018-07-12 23:56:30 -04001173angle::Result RendererVk::getRenderPassWithOps(vk::Context *context,
1174 const vk::RenderPassDesc &desc,
1175 const vk::AttachmentOpsArray &ops,
1176 vk::RenderPass **renderPassOut)
Jamie Madill9f2a8612017-11-30 12:43:09 -05001177{
Jamie Madill21061022018-07-12 23:56:30 -04001178 return mRenderPassCache.getRenderPassWithOps(context, mCurrentQueueSerial, desc, ops,
Jamie Madillbef918c2017-12-13 13:11:30 -05001179 renderPassOut);
Jamie Madill9f2a8612017-11-30 12:43:09 -05001180}
1181
Jamie Madilla5e06072018-05-18 14:36:05 -04001182vk::CommandGraph *RendererVk::getCommandGraph()
Jamie Madill49ac74b2017-12-21 14:42:33 -05001183{
Jamie Madilla5e06072018-05-18 14:36:05 -04001184 return &mCommandGraph;
Jamie Madill49ac74b2017-12-21 14:42:33 -05001185}
1186
Jamie Madill21061022018-07-12 23:56:30 -04001187angle::Result RendererVk::flushCommandGraph(vk::Context *context, vk::CommandBuffer *commandBatch)
Jamie Madill49ac74b2017-12-21 14:42:33 -05001188{
Jamie Madill21061022018-07-12 23:56:30 -04001189 return mCommandGraph.submitCommands(context, mCurrentQueueSerial, &mRenderPassCache,
Jamie Madill1f46bc12018-02-20 16:09:43 -05001190 &mCommandPool, commandBatch);
Jamie Madill49ac74b2017-12-21 14:42:33 -05001191}
1192
Shahbaz Youssefi3a482172018-10-11 10:34:44 -04001193angle::Result RendererVk::flush(vk::Context *context)
Jamie Madill49ac74b2017-12-21 14:42:33 -05001194{
Shahbaz Youssefi3a482172018-10-11 10:34:44 -04001195 if (mCommandGraph.empty())
1196 {
Jamie Madill7c985f52018-11-29 18:16:17 -05001197 return angle::Result::Continue;
Shahbaz Youssefi3a482172018-10-11 10:34:44 -04001198 }
1199
Shahbaz Youssefi61656022018-10-24 15:00:50 -04001200 TRACE_EVENT0("gpu.angle", "RendererVk::flush");
1201
Jamie Madillbea35a62018-07-05 11:54:10 -04001202 vk::Scoped<vk::CommandBuffer> commandBatch(mDevice);
1203 ANGLE_TRY(flushCommandGraph(context, &commandBatch.get()));
Jamie Madill49ac74b2017-12-21 14:42:33 -05001204
Shahbaz Youssefi3a482172018-10-11 10:34:44 -04001205 angle::FixedVector<VkSemaphore, kMaxWaitSemaphores> waitSemaphores;
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001206 angle::FixedVector<VkPipelineStageFlags, kMaxWaitSemaphores> waitStageMasks;
1207 getSubmitWaitSemaphores(context, &waitSemaphores, &waitStageMasks);
Shahbaz Youssefi3a482172018-10-11 10:34:44 -04001208
1209 // On every flush, create a semaphore to be signaled. On the next submission, this semaphore
1210 // will be waited on.
1211 ANGLE_TRY(mSubmitSemaphorePool.allocateSemaphore(context, &mSubmitLastSignaledSemaphore));
Jamie Madill49ac74b2017-12-21 14:42:33 -05001212
Shahbaz Youssefi06270c92018-10-03 17:00:25 -04001213 VkSubmitInfo submitInfo = {};
Jamie Madill49ac74b2017-12-21 14:42:33 -05001214 submitInfo.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO;
Shahbaz Youssefi3a482172018-10-11 10:34:44 -04001215 submitInfo.waitSemaphoreCount = static_cast<uint32_t>(waitSemaphores.size());
1216 submitInfo.pWaitSemaphores = waitSemaphores.data();
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001217 submitInfo.pWaitDstStageMask = waitStageMasks.data();
Jamie Madill49ac74b2017-12-21 14:42:33 -05001218 submitInfo.commandBufferCount = 1;
Jamie Madillbea35a62018-07-05 11:54:10 -04001219 submitInfo.pCommandBuffers = commandBatch.get().ptr();
Jamie Madill49ac74b2017-12-21 14:42:33 -05001220 submitInfo.signalSemaphoreCount = 1;
Shahbaz Youssefi3a482172018-10-11 10:34:44 -04001221 submitInfo.pSignalSemaphores = mSubmitLastSignaledSemaphore.getSemaphore()->ptr();
Jamie Madill49ac74b2017-12-21 14:42:33 -05001222
Jamie Madill21061022018-07-12 23:56:30 -04001223 ANGLE_TRY(submitFrame(context, submitInfo, commandBatch.release()));
Shahbaz Youssefi3a482172018-10-11 10:34:44 -04001224
Jamie Madill7c985f52018-11-29 18:16:17 -05001225 return angle::Result::Continue;
Jamie Madill49ac74b2017-12-21 14:42:33 -05001226}
1227
Jamie Madill78feddc2018-04-27 11:45:05 -04001228Serial RendererVk::issueShaderSerial()
Jamie Madillf2f6d372018-01-10 21:37:23 -05001229{
Jamie Madill78feddc2018-04-27 11:45:05 -04001230 return mShaderSerialFactory.generate();
Jamie Madillf2f6d372018-01-10 21:37:23 -05001231}
1232
Jamie Madill21061022018-07-12 23:56:30 -04001233angle::Result RendererVk::getDescriptorSetLayout(
1234 vk::Context *context,
Jamie Madill9b168d02018-06-13 13:25:32 -04001235 const vk::DescriptorSetLayoutDesc &desc,
1236 vk::BindingPointer<vk::DescriptorSetLayout> *descriptorSetLayoutOut)
1237{
Jamie Madill21061022018-07-12 23:56:30 -04001238 return mDescriptorSetLayoutCache.getDescriptorSetLayout(context, desc, descriptorSetLayoutOut);
Jamie Madill9b168d02018-06-13 13:25:32 -04001239}
1240
Jamie Madill21061022018-07-12 23:56:30 -04001241angle::Result RendererVk::getPipelineLayout(
1242 vk::Context *context,
Jamie Madill9b168d02018-06-13 13:25:32 -04001243 const vk::PipelineLayoutDesc &desc,
1244 const vk::DescriptorSetLayoutPointerArray &descriptorSetLayouts,
1245 vk::BindingPointer<vk::PipelineLayout> *pipelineLayoutOut)
1246{
Jamie Madill21061022018-07-12 23:56:30 -04001247 return mPipelineLayoutCache.getPipelineLayout(context, desc, descriptorSetLayouts,
Jamie Madill9b168d02018-06-13 13:25:32 -04001248 pipelineLayoutOut);
1249}
1250
Shahbaz Youssefi996628a2018-09-24 16:39:26 -04001251angle::Result RendererVk::syncPipelineCacheVk(DisplayVk *displayVk)
1252{
Jamie Madilldc65c5b2018-11-21 11:07:26 -05001253 ASSERT(mPipelineCache.valid());
Shahbaz Youssefi996628a2018-09-24 16:39:26 -04001254
1255 if (--mPipelineCacheVkUpdateTimeout > 0)
1256 {
Jamie Madill7c985f52018-11-29 18:16:17 -05001257 return angle::Result::Continue;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -04001258 }
1259
1260 mPipelineCacheVkUpdateTimeout = kPipelineCacheVkUpdatePeriod;
1261
1262 // Get the size of the cache.
1263 size_t pipelineCacheSize = 0;
Jamie Madilldc65c5b2018-11-21 11:07:26 -05001264 VkResult result = mPipelineCache.getCacheData(mDevice, &pipelineCacheSize, nullptr);
Yuly Novikov27780292018-11-09 11:19:49 -05001265 if (result != VK_INCOMPLETE)
1266 {
1267 ANGLE_VK_TRY(displayVk, result);
1268 }
Shahbaz Youssefi996628a2018-09-24 16:39:26 -04001269
1270 angle::MemoryBuffer *pipelineCacheData = nullptr;
1271 ANGLE_VK_CHECK_ALLOC(displayVk,
1272 displayVk->getScratchBuffer(pipelineCacheSize, &pipelineCacheData));
1273
1274 size_t originalPipelineCacheSize = pipelineCacheSize;
Jamie Madilldc65c5b2018-11-21 11:07:26 -05001275 result = mPipelineCache.getCacheData(mDevice, &pipelineCacheSize, pipelineCacheData->data());
Shahbaz Youssefi996628a2018-09-24 16:39:26 -04001276 // Note: currently we don't accept incomplete as we don't expect it (the full size of cache
1277 // was determined just above), so receiving it hints at an implementation bug we would want
1278 // to know about early.
Yuly Novikov27780292018-11-09 11:19:49 -05001279 ASSERT(result != VK_INCOMPLETE);
1280 ANGLE_VK_TRY(displayVk, result);
Shahbaz Youssefi996628a2018-09-24 16:39:26 -04001281
1282 // If vkGetPipelineCacheData ends up writing fewer bytes than requested, zero out the rest of
1283 // the buffer to avoid leaking garbage memory.
1284 ASSERT(pipelineCacheSize <= originalPipelineCacheSize);
1285 if (pipelineCacheSize < originalPipelineCacheSize)
1286 {
1287 memset(pipelineCacheData->data() + pipelineCacheSize, 0,
1288 originalPipelineCacheSize - pipelineCacheSize);
1289 }
1290
1291 displayVk->getBlobCache()->putApplication(mPipelineCacheVkBlobKey, *pipelineCacheData);
1292
Jamie Madill7c985f52018-11-29 18:16:17 -05001293 return angle::Result::Continue;
Shahbaz Youssefi996628a2018-09-24 16:39:26 -04001294}
1295
Shahbaz Youssefi3a482172018-10-11 10:34:44 -04001296angle::Result RendererVk::allocateSubmitWaitSemaphore(vk::Context *context,
1297 const vk::Semaphore **outSemaphore)
1298{
1299 ASSERT(mSubmitWaitSemaphores.size() < mSubmitWaitSemaphores.max_size());
1300
1301 vk::SemaphoreHelper semaphore;
1302 ANGLE_TRY(mSubmitSemaphorePool.allocateSemaphore(context, &semaphore));
1303
1304 mSubmitWaitSemaphores.push_back(std::move(semaphore));
1305 *outSemaphore = mSubmitWaitSemaphores.back().getSemaphore();
1306
Jamie Madill7c985f52018-11-29 18:16:17 -05001307 return angle::Result::Continue;
Shahbaz Youssefi3a482172018-10-11 10:34:44 -04001308}
1309
1310const vk::Semaphore *RendererVk::getSubmitLastSignaledSemaphore(vk::Context *context)
1311{
1312 const vk::Semaphore *semaphore = mSubmitLastSignaledSemaphore.getSemaphore();
1313
1314 // Return the semaphore to the pool (which will remain valid and unused until the
1315 // queue it's about to be waited on has finished execution). The caller is about
1316 // to wait on it.
1317 mSubmitSemaphorePool.freeSemaphore(context, &mSubmitLastSignaledSemaphore);
1318
1319 return semaphore;
1320}
1321
Jamie Madilldc65c5b2018-11-21 11:07:26 -05001322angle::Result RendererVk::getFullScreenClearShaderProgram(vk::Context *context,
1323 vk::ShaderProgramHelper **programOut)
Jamie Madilld47044a2018-04-27 11:45:03 -04001324{
Jamie Madilldc65c5b2018-11-21 11:07:26 -05001325 if (!mFullScreenClearShaderProgram.valid())
1326 {
1327 vk::RefCounted<vk::ShaderAndSerial> *fullScreenQuad = nullptr;
Shahbaz Youssefia1442ec2018-11-26 12:48:10 -05001328 ANGLE_TRY(mShaderLibrary.getFullScreenQuad_vert(context, 0, &fullScreenQuad));
Jamie Madilldc65c5b2018-11-21 11:07:26 -05001329
1330 vk::RefCounted<vk::ShaderAndSerial> *pushConstantColor = nullptr;
Shahbaz Youssefia1442ec2018-11-26 12:48:10 -05001331 ANGLE_TRY(mShaderLibrary.getPushConstantColor_frag(context, 0, &pushConstantColor));
Jamie Madilldc65c5b2018-11-21 11:07:26 -05001332
1333 mFullScreenClearShaderProgram.setShader(gl::ShaderType::Vertex, fullScreenQuad);
1334 mFullScreenClearShaderProgram.setShader(gl::ShaderType::Fragment, pushConstantColor);
1335 }
1336
1337 *programOut = &mFullScreenClearShaderProgram;
Jamie Madill7c985f52018-11-29 18:16:17 -05001338 return angle::Result::Continue;
Jamie Madilld47044a2018-04-27 11:45:03 -04001339}
Luc Ferron90968362018-05-04 08:47:22 -04001340
Shahbaz Youssefi749589f2018-10-25 12:48:49 -04001341angle::Result RendererVk::getTimestamp(vk::Context *context, uint64_t *timestampOut)
1342{
1343 // The intent of this function is to query the timestamp without stalling the GPU. Currently,
1344 // that seems impossible, so instead, we are going to make a small submission with just a
1345 // timestamp query. First, the disjoint timer query extension says:
1346 //
1347 // > This will return the GL time after all previous commands have reached the GL server but
1348 // have not yet necessarily executed.
1349 //
1350 // The previous commands are stored in the command graph at the moment and are not yet flushed.
1351 // The wording allows us to make a submission to get the timestamp without performing a flush.
1352 //
1353 // Second:
1354 //
1355 // > By using a combination of this synchronous get command and the asynchronous timestamp query
1356 // object target, applications can measure the latency between when commands reach the GL server
1357 // and when they are realized in the framebuffer.
1358 //
1359 // This fits with the above strategy as well, although inevitably we are possibly introducing a
1360 // GPU bubble. This function directly generates a command buffer and submits it instead of
1361 // using the other member functions. This is to avoid changing any state, such as the queue
1362 // serial.
1363
1364 // Create a query used to receive the GPU timestamp
1365 vk::Scoped<vk::DynamicQueryPool> timestampQueryPool(mDevice);
1366 vk::QueryHelper timestampQuery;
1367 ANGLE_TRY(timestampQueryPool.get().init(context, VK_QUERY_TYPE_TIMESTAMP, 1));
1368 ANGLE_TRY(timestampQueryPool.get().allocateQuery(context, &timestampQuery));
1369
1370 // Record the command buffer
1371 vk::Scoped<vk::CommandBuffer> commandBatch(mDevice);
1372 vk::CommandBuffer &commandBuffer = commandBatch.get();
1373
1374 VkCommandBufferAllocateInfo commandBufferInfo = {};
1375 commandBufferInfo.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
1376 commandBufferInfo.commandPool = mCommandPool.getHandle();
1377 commandBufferInfo.level = VK_COMMAND_BUFFER_LEVEL_PRIMARY;
1378 commandBufferInfo.commandBufferCount = 1;
1379
Yuly Novikov27780292018-11-09 11:19:49 -05001380 ANGLE_VK_TRY(context, commandBuffer.init(mDevice, commandBufferInfo));
Shahbaz Youssefi749589f2018-10-25 12:48:49 -04001381
1382 VkCommandBufferBeginInfo beginInfo = {};
1383 beginInfo.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO;
1384 beginInfo.flags = 0;
1385 beginInfo.pInheritanceInfo = nullptr;
1386
Yuly Novikov27780292018-11-09 11:19:49 -05001387 ANGLE_VK_TRY(context, commandBuffer.begin(beginInfo));
Shahbaz Youssefi749589f2018-10-25 12:48:49 -04001388
1389 commandBuffer.resetQueryPool(timestampQuery.getQueryPool()->getHandle(),
1390 timestampQuery.getQuery(), 1);
1391 commandBuffer.writeTimestamp(VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT,
1392 timestampQuery.getQueryPool()->getHandle(),
1393 timestampQuery.getQuery());
1394
Yuly Novikov27780292018-11-09 11:19:49 -05001395 ANGLE_VK_TRY(context, commandBuffer.end());
Shahbaz Youssefi749589f2018-10-25 12:48:49 -04001396
1397 // Create fence for the submission
1398 VkFenceCreateInfo fenceInfo = {};
1399 fenceInfo.sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO;
1400 fenceInfo.flags = 0;
1401
1402 vk::Scoped<vk::Fence> fence(mDevice);
Yuly Novikov27780292018-11-09 11:19:49 -05001403 ANGLE_VK_TRY(context, fence.get().init(mDevice, fenceInfo));
Shahbaz Youssefi749589f2018-10-25 12:48:49 -04001404
1405 // Submit the command buffer
1406 VkSubmitInfo submitInfo = {};
1407 submitInfo.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO;
1408 submitInfo.waitSemaphoreCount = 0;
1409 submitInfo.pWaitSemaphores = nullptr;
1410 submitInfo.pWaitDstStageMask = nullptr;
1411 submitInfo.commandBufferCount = 1;
1412 submitInfo.pCommandBuffers = commandBuffer.ptr();
1413 submitInfo.signalSemaphoreCount = 0;
1414 submitInfo.pSignalSemaphores = nullptr;
1415
1416 ANGLE_VK_TRY(context, vkQueueSubmit(mQueue, 1, &submitInfo, fence.get().getHandle()));
1417
1418 // Wait for the submission to finish. Given no semaphores, there is hope that it would execute
1419 // in parallel with what's already running on the GPU.
Yuly Novikov27780292018-11-09 11:19:49 -05001420 ANGLE_VK_TRY(context, fence.get().wait(mDevice, kMaxFenceWaitTimeNs));
Shahbaz Youssefi749589f2018-10-25 12:48:49 -04001421
1422 // Get the query results
1423 constexpr VkQueryResultFlags queryFlags = VK_QUERY_RESULT_WAIT_BIT | VK_QUERY_RESULT_64_BIT;
1424
Yuly Novikov27780292018-11-09 11:19:49 -05001425 ANGLE_VK_TRY(context, timestampQuery.getQueryPool()->getResults(
1426 mDevice, timestampQuery.getQuery(), 1, sizeof(*timestampOut),
1427 timestampOut, sizeof(*timestampOut), queryFlags));
Shahbaz Youssefi749589f2018-10-25 12:48:49 -04001428
1429 timestampQueryPool.get().freeQuery(context, &timestampQuery);
1430
Jamie Madill7c985f52018-11-29 18:16:17 -05001431 return angle::Result::Continue;
Shahbaz Youssefi749589f2018-10-25 12:48:49 -04001432}
1433
Shahbaz Youssefi96bd8fd2018-11-30 14:30:18 -05001434// These functions look at the mandatory format for support, and fallback to querying the device (if
1435// necessary) to test the availability of the bits.
1436bool RendererVk::hasLinearTextureFormatFeatureBits(VkFormat format,
1437 const VkFormatFeatureFlags featureBits)
1438{
1439 return hasFormatFeatureBits<&VkFormatProperties::linearTilingFeatures>(format, featureBits);
1440}
1441
1442bool RendererVk::hasTextureFormatFeatureBits(VkFormat format,
1443 const VkFormatFeatureFlags featureBits)
1444{
1445 return hasFormatFeatureBits<&VkFormatProperties::optimalTilingFeatures>(format, featureBits);
1446}
1447
1448bool RendererVk::hasBufferFormatFeatureBits(VkFormat format, const VkFormatFeatureFlags featureBits)
1449{
1450 return hasFormatFeatureBits<&VkFormatProperties::bufferFeatures>(format, featureBits);
1451}
1452
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001453angle::Result RendererVk::synchronizeCpuGpuTime(vk::Context *context)
1454{
1455 ASSERT(mGpuEventsEnabled);
1456
1457 angle::PlatformMethods *platform = ANGLEPlatformCurrent();
1458 ASSERT(platform);
1459
1460 // To synchronize CPU and GPU times, we need to get the CPU timestamp as close as possible to
1461 // the GPU timestamp. The process of getting the GPU timestamp is as follows:
1462 //
1463 // CPU GPU
1464 //
1465 // Record command buffer
1466 // with timestamp query
1467 //
1468 // Submit command buffer
1469 //
1470 // Post-submission work Begin execution
1471 //
1472 // ???? Write timstamp Tgpu
1473 //
1474 // ???? End execution
1475 //
1476 // ???? Return query results
1477 //
1478 // ????
1479 //
1480 // Get query results
1481 //
1482 // The areas of unknown work (????) on the CPU indicate that the CPU may or may not have
1483 // finished post-submission work while the GPU is executing in parallel. With no further work,
1484 // querying CPU timestamps before submission and after getting query results give the bounds to
1485 // Tgpu, which could be quite large.
1486 //
1487 // Using VkEvents, the GPU can be made to wait for the CPU and vice versa, in an effort to
1488 // reduce this range. This function implements the following procedure:
1489 //
1490 // CPU GPU
1491 //
1492 // Record command buffer
1493 // with timestamp query
1494 //
1495 // Submit command buffer
1496 //
1497 // Post-submission work Begin execution
1498 //
1499 // ???? Set Event GPUReady
1500 //
1501 // Wait on Event GPUReady Wait on Event CPUReady
1502 //
1503 // Get CPU Time Ts Wait on Event CPUReady
1504 //
1505 // Set Event CPUReady Wait on Event CPUReady
1506 //
1507 // Get CPU Time Tcpu Get GPU Time Tgpu
1508 //
1509 // Wait on Event GPUDone Set Event GPUDone
1510 //
1511 // Get CPU Time Te End Execution
1512 //
1513 // Idle Return query results
1514 //
1515 // Get query results
1516 //
1517 // If Te-Ts > epsilon, a GPU or CPU interruption can be assumed and the operation can be
1518 // retried. Once Te-Ts < epsilon, Tcpu can be taken to presumably match Tgpu. Finding an
1519 // epsilon that's valid for all devices may be difficult, so the loop can be performed only a
1520 // limited number of times and the Tcpu,Tgpu pair corresponding to smallest Te-Ts used for
1521 // calibration.
1522 //
1523 // Note: Once VK_EXT_calibrated_timestamps is ubiquitous, this should be redone.
1524
1525 // Make sure nothing is running
1526 ASSERT(mCommandGraph.empty());
1527
1528 TRACE_EVENT0("gpu.angle", "RendererVk::synchronizeCpuGpuTime");
1529
1530 // Create a query used to receive the GPU timestamp
1531 vk::QueryHelper timestampQuery;
1532 ANGLE_TRY(mGpuEventQueryPool.allocateQuery(context, &timestampQuery));
1533
1534 // Create the three events
1535 VkEventCreateInfo eventCreateInfo = {};
1536 eventCreateInfo.sType = VK_STRUCTURE_TYPE_EVENT_CREATE_INFO;
1537 eventCreateInfo.flags = 0;
1538
1539 vk::Scoped<vk::Event> cpuReady(mDevice), gpuReady(mDevice), gpuDone(mDevice);
Yuly Novikov27780292018-11-09 11:19:49 -05001540 ANGLE_VK_TRY(context, cpuReady.get().init(mDevice, eventCreateInfo));
1541 ANGLE_VK_TRY(context, gpuReady.get().init(mDevice, eventCreateInfo));
1542 ANGLE_VK_TRY(context, gpuDone.get().init(mDevice, eventCreateInfo));
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001543
1544 constexpr uint32_t kRetries = 10;
1545
1546 // Time suffixes used are S for seconds and Cycles for cycles
1547 double tightestRangeS = 1e6f;
1548 double TcpuS = 0;
1549 uint64_t TgpuCycles = 0;
1550 for (uint32_t i = 0; i < kRetries; ++i)
1551 {
1552 // Reset the events
Yuly Novikov27780292018-11-09 11:19:49 -05001553 ANGLE_VK_TRY(context, cpuReady.get().reset(mDevice));
1554 ANGLE_VK_TRY(context, gpuReady.get().reset(mDevice));
1555 ANGLE_VK_TRY(context, gpuDone.get().reset(mDevice));
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001556
1557 // Record the command buffer
1558 vk::Scoped<vk::CommandBuffer> commandBatch(mDevice);
1559 vk::CommandBuffer &commandBuffer = commandBatch.get();
1560
1561 VkCommandBufferAllocateInfo commandBufferInfo = {};
1562 commandBufferInfo.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
1563 commandBufferInfo.commandPool = mCommandPool.getHandle();
1564 commandBufferInfo.level = VK_COMMAND_BUFFER_LEVEL_PRIMARY;
1565 commandBufferInfo.commandBufferCount = 1;
1566
Yuly Novikov27780292018-11-09 11:19:49 -05001567 ANGLE_VK_TRY(context, commandBuffer.init(mDevice, commandBufferInfo));
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001568
1569 VkCommandBufferBeginInfo beginInfo = {};
1570 beginInfo.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO;
1571 beginInfo.flags = 0;
1572 beginInfo.pInheritanceInfo = nullptr;
1573
Yuly Novikov27780292018-11-09 11:19:49 -05001574 ANGLE_VK_TRY(context, commandBuffer.begin(beginInfo));
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001575
1576 commandBuffer.setEvent(gpuReady.get(), VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT);
1577 commandBuffer.waitEvents(1, cpuReady.get().ptr(), VK_PIPELINE_STAGE_HOST_BIT,
1578 VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT, 0, nullptr, 0, nullptr, 0,
1579 nullptr);
1580
1581 commandBuffer.resetQueryPool(timestampQuery.getQueryPool()->getHandle(),
1582 timestampQuery.getQuery(), 1);
1583 commandBuffer.writeTimestamp(VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT,
1584 timestampQuery.getQueryPool()->getHandle(),
1585 timestampQuery.getQuery());
1586
1587 commandBuffer.setEvent(gpuDone.get(), VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT);
1588
Yuly Novikov27780292018-11-09 11:19:49 -05001589 ANGLE_VK_TRY(context, commandBuffer.end());
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001590
1591 // Submit the command buffer
1592 angle::FixedVector<VkSemaphore, kMaxWaitSemaphores> waitSemaphores;
1593 angle::FixedVector<VkPipelineStageFlags, kMaxWaitSemaphores> waitStageMasks;
1594 getSubmitWaitSemaphores(context, &waitSemaphores, &waitStageMasks);
1595
1596 VkSubmitInfo submitInfo = {};
1597 submitInfo.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO;
1598 submitInfo.waitSemaphoreCount = static_cast<uint32_t>(waitSemaphores.size());
1599 submitInfo.pWaitSemaphores = waitSemaphores.data();
1600 submitInfo.pWaitDstStageMask = waitStageMasks.data();
1601 submitInfo.commandBufferCount = 1;
1602 submitInfo.pCommandBuffers = commandBuffer.ptr();
1603 submitInfo.signalSemaphoreCount = 0;
1604 submitInfo.pSignalSemaphores = nullptr;
1605
1606 ANGLE_TRY(submitFrame(context, submitInfo, std::move(commandBuffer)));
1607
1608 // Wait for GPU to be ready. This is a short busy wait.
Yuly Novikov27780292018-11-09 11:19:49 -05001609 VkResult result = VK_EVENT_RESET;
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001610 do
1611 {
Yuly Novikov27780292018-11-09 11:19:49 -05001612 result = gpuReady.get().getStatus(mDevice);
1613 if (result != VK_EVENT_SET && result != VK_EVENT_RESET)
1614 {
1615 ANGLE_VK_TRY(context, result);
1616 }
1617 } while (result == VK_EVENT_RESET);
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001618
1619 double TsS = platform->monotonicallyIncreasingTime(platform);
1620
1621 // Tell the GPU to go ahead with the timestamp query.
Yuly Novikov27780292018-11-09 11:19:49 -05001622 ANGLE_VK_TRY(context, cpuReady.get().set(mDevice));
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001623 double cpuTimestampS = platform->monotonicallyIncreasingTime(platform);
1624
1625 // Wait for GPU to be done. Another short busy wait.
1626 do
1627 {
Yuly Novikov27780292018-11-09 11:19:49 -05001628 result = gpuDone.get().getStatus(mDevice);
1629 if (result != VK_EVENT_SET && result != VK_EVENT_RESET)
1630 {
1631 ANGLE_VK_TRY(context, result);
1632 }
1633 } while (result == VK_EVENT_RESET);
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001634
1635 double TeS = platform->monotonicallyIncreasingTime(platform);
1636
1637 // Get the query results
1638 ANGLE_TRY(finishToSerial(context, getLastSubmittedQueueSerial()));
1639
1640 constexpr VkQueryResultFlags queryFlags = VK_QUERY_RESULT_WAIT_BIT | VK_QUERY_RESULT_64_BIT;
1641
1642 uint64_t gpuTimestampCycles = 0;
Yuly Novikov27780292018-11-09 11:19:49 -05001643 ANGLE_VK_TRY(context, timestampQuery.getQueryPool()->getResults(
1644 mDevice, timestampQuery.getQuery(), 1, sizeof(gpuTimestampCycles),
1645 &gpuTimestampCycles, sizeof(gpuTimestampCycles), queryFlags));
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001646
1647 // Use the first timestamp queried as origin.
1648 if (mGpuEventTimestampOrigin == 0)
1649 {
1650 mGpuEventTimestampOrigin = gpuTimestampCycles;
1651 }
1652
1653 // Take these CPU and GPU timestamps if there is better confidence.
1654 double confidenceRangeS = TeS - TsS;
1655 if (confidenceRangeS < tightestRangeS)
1656 {
1657 tightestRangeS = confidenceRangeS;
1658 TcpuS = cpuTimestampS;
1659 TgpuCycles = gpuTimestampCycles;
1660 }
1661 }
1662
1663 mGpuEventQueryPool.freeQuery(context, &timestampQuery);
1664
1665 // timestampPeriod gives nanoseconds/cycle.
1666 double TgpuS = (TgpuCycles - mGpuEventTimestampOrigin) *
1667 static_cast<double>(mPhysicalDeviceProperties.limits.timestampPeriod) /
1668 1'000'000'000.0;
1669
1670 flushGpuEvents(TgpuS, TcpuS);
1671
1672 mGpuClockSync.gpuTimestampS = TgpuS;
1673 mGpuClockSync.cpuTimestampS = TcpuS;
1674
Jamie Madill7c985f52018-11-29 18:16:17 -05001675 return angle::Result::Continue;
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001676}
1677
1678angle::Result RendererVk::traceGpuEventImpl(vk::Context *context,
1679 vk::CommandBuffer *commandBuffer,
1680 char phase,
1681 const char *name)
1682{
1683 ASSERT(mGpuEventsEnabled);
1684
1685 GpuEventQuery event;
1686
1687 event.name = name;
1688 event.phase = phase;
1689 event.serial = mCurrentQueueSerial;
1690
1691 ANGLE_TRY(mGpuEventQueryPool.allocateQuery(context, &event.queryPoolIndex, &event.queryIndex));
1692
1693 commandBuffer->resetQueryPool(
1694 mGpuEventQueryPool.getQueryPool(event.queryPoolIndex)->getHandle(), event.queryIndex, 1);
1695 commandBuffer->writeTimestamp(
1696 VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT,
1697 mGpuEventQueryPool.getQueryPool(event.queryPoolIndex)->getHandle(), event.queryIndex);
1698
1699 mInFlightGpuEventQueries.push_back(std::move(event));
1700
Jamie Madill7c985f52018-11-29 18:16:17 -05001701 return angle::Result::Continue;
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001702}
1703
1704angle::Result RendererVk::checkCompletedGpuEvents(vk::Context *context)
1705{
1706 ASSERT(mGpuEventsEnabled);
1707
1708 angle::PlatformMethods *platform = ANGLEPlatformCurrent();
1709 ASSERT(platform);
1710
1711 int finishedCount = 0;
1712
1713 for (GpuEventQuery &eventQuery : mInFlightGpuEventQueries)
1714 {
1715 // Only check the timestamp query if the submission has finished.
1716 if (eventQuery.serial > mLastCompletedQueueSerial)
1717 {
1718 break;
1719 }
1720
1721 // See if the results are available.
1722 uint64_t gpuTimestampCycles = 0;
Yuly Novikov27780292018-11-09 11:19:49 -05001723 VkResult result = mGpuEventQueryPool.getQueryPool(eventQuery.queryPoolIndex)
1724 ->getResults(mDevice, eventQuery.queryIndex, 1,
1725 sizeof(gpuTimestampCycles), &gpuTimestampCycles,
1726 sizeof(gpuTimestampCycles), VK_QUERY_RESULT_64_BIT);
1727 if (result == VK_NOT_READY)
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001728 {
1729 break;
1730 }
Yuly Novikov27780292018-11-09 11:19:49 -05001731 ANGLE_VK_TRY(context, result);
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001732
1733 mGpuEventQueryPool.freeQuery(context, eventQuery.queryPoolIndex, eventQuery.queryIndex);
1734
1735 GpuEvent event;
1736 event.gpuTimestampCycles = gpuTimestampCycles;
1737 event.name = eventQuery.name;
1738 event.phase = eventQuery.phase;
1739
1740 mGpuEvents.emplace_back(event);
1741
1742 ++finishedCount;
1743 }
1744
1745 mInFlightGpuEventQueries.erase(mInFlightGpuEventQueries.begin(),
1746 mInFlightGpuEventQueries.begin() + finishedCount);
1747
Jamie Madill7c985f52018-11-29 18:16:17 -05001748 return angle::Result::Continue;
Shahbaz Youssefi25224e72018-10-22 11:56:02 -04001749}
1750
1751void RendererVk::flushGpuEvents(double nextSyncGpuTimestampS, double nextSyncCpuTimestampS)
1752{
1753 if (mGpuEvents.size() == 0)
1754 {
1755 return;
1756 }
1757
1758 angle::PlatformMethods *platform = ANGLEPlatformCurrent();
1759 ASSERT(platform);
1760
1761 // Find the slope of the clock drift for adjustment
1762 double lastGpuSyncTimeS = mGpuClockSync.gpuTimestampS;
1763 double lastGpuSyncDiffS = mGpuClockSync.cpuTimestampS - mGpuClockSync.gpuTimestampS;
1764 double gpuSyncDriftSlope = 0;
1765
1766 double nextGpuSyncTimeS = nextSyncGpuTimestampS;
1767 double nextGpuSyncDiffS = nextSyncCpuTimestampS - nextSyncGpuTimestampS;
1768
1769 // No gpu trace events should have been generated before the clock sync, so if there is no
1770 // "previous" clock sync, there should be no gpu events (i.e. the function early-outs above).
1771 ASSERT(mGpuClockSync.gpuTimestampS != std::numeric_limits<double>::max() &&
1772 mGpuClockSync.cpuTimestampS != std::numeric_limits<double>::max());
1773
1774 gpuSyncDriftSlope =
1775 (nextGpuSyncDiffS - lastGpuSyncDiffS) / (nextGpuSyncTimeS - lastGpuSyncTimeS);
1776
1777 for (const GpuEvent &event : mGpuEvents)
1778 {
1779 double gpuTimestampS =
1780 (event.gpuTimestampCycles - mGpuEventTimestampOrigin) *
1781 static_cast<double>(mPhysicalDeviceProperties.limits.timestampPeriod) * 1e-9;
1782
1783 // Account for clock drift.
1784 gpuTimestampS += lastGpuSyncDiffS + gpuSyncDriftSlope * (gpuTimestampS - lastGpuSyncTimeS);
1785
1786 // Generate the trace now that the GPU timestamp is available and clock drifts are accounted
1787 // for.
1788 static long long eventId = 1;
1789 static const unsigned char *categoryEnabled =
1790 TRACE_EVENT_API_GET_CATEGORY_ENABLED("gpu.angle.gpu");
1791 platform->addTraceEvent(platform, event.phase, categoryEnabled, event.name, eventId++,
1792 gpuTimestampS, 0, nullptr, nullptr, nullptr, TRACE_EVENT_FLAG_NONE);
1793 }
1794
1795 mGpuEvents.clear();
1796}
1797
Shahbaz Youssefi96bd8fd2018-11-30 14:30:18 -05001798template <VkFormatFeatureFlags VkFormatProperties::*features>
1799bool RendererVk::hasFormatFeatureBits(VkFormat format, const VkFormatFeatureFlags featureBits)
1800{
1801 ASSERT(static_cast<uint32_t>(format) < vk::kNumVkFormats);
1802 VkFormatProperties &deviceProperties = mFormatProperties[format];
1803
1804 if (deviceProperties.bufferFeatures == kInvalidFormatFeatureFlags)
1805 {
1806 // If we don't have the actual device features, see if the requested features are mandatory.
1807 // If so, there's no need to query the device.
1808 const VkFormatProperties &mandatoryProperties = vk::GetMandatoryFormatSupport(format);
1809 if (IsMaskFlagSet(mandatoryProperties.*features, featureBits))
1810 {
1811 return true;
1812 }
1813
1814 // Otherwise query the format features and cache it.
1815 vkGetPhysicalDeviceFormatProperties(mPhysicalDevice, format, &deviceProperties);
1816 }
1817
1818 return IsMaskFlagSet(deviceProperties.*features, featureBits);
1819}
1820
Jamie Madillaaca96e2018-06-12 10:19:48 -04001821uint32_t GetUniformBufferDescriptorCount()
1822{
1823 return kUniformBufferDescriptorsPerDescriptorSet;
1824}
1825
Jamie Madill9e54b5a2016-05-25 12:57:39 -04001826} // namespace rx