blob: bba0ffd39566f40cfb94fc99b1a7084ff0c61e71 [file] [log] [blame]
Mark Lobodzinski6eda00a2016-02-02 15:55:36 -07001/* Copyright (c) 2015-2016 The Khronos Group Inc.
2 * Copyright (c) 2015-2016 Valve Corporation
3 * Copyright (c) 2015-2016 LunarG, Inc.
4 * Copyright (C) 2015-2016 Google Inc.
Jeremy Hayes9cc31582015-06-18 10:12:39 -06005 *
Jon Ashburn3ebf1252016-04-19 11:30:31 -06006 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
Jeremy Hayes9cc31582015-06-18 10:12:39 -06009 *
Jon Ashburn3ebf1252016-04-19 11:30:31 -060010 * http://www.apache.org/licenses/LICENSE-2.0
Jeremy Hayes9cc31582015-06-18 10:12:39 -060011 *
Jon Ashburn3ebf1252016-04-19 11:30:31 -060012 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
Courtney Goeltzenleuchter05559522015-10-30 11:14:30 -060017 *
18 * Author: Jeremy Hayes <jeremy@lunarg.com>
19 * Author: Mark Lobodzinski <mark@lunarg.com>
20 * Author: Mike Stroyan <mike@LunarG.com>
21 * Author: Tobin Ehlis <tobin@lunarg.com>
Jeremy Hayes9cc31582015-06-18 10:12:39 -060022 */
23
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -060024// Allow use of STL min and max functions in Windows
25#define NOMINMAX
26
Jeremy Hayese0ed6a22016-04-08 09:53:54 -060027#include <algorithm>
28#include <assert.h>
Karl Schultzd7f37542016-05-10 11:36:08 -060029#include <cinttypes>
Jeremy Hayese0ed6a22016-04-08 09:53:54 -060030#include <memory>
31#include <mutex>
Jeremy Hayes9cc31582015-06-18 10:12:39 -060032#include <stdio.h>
33#include <stdlib.h>
34#include <string.h>
Mark Lobodzinski040142c2016-11-22 11:18:46 -070035#include <limits.h>
Jeremy Hayes9cc31582015-06-18 10:12:39 -060036#include <unordered_map>
Jeremy Hayese0ed6a22016-04-08 09:53:54 -060037#include <vector>
Mark Lobodzinski040142c2016-11-22 11:18:46 -070038#include <bitset>
Mark Lobodzinski9acd2e32016-12-21 15:22:39 -070039#include <sstream>
Jeremy Hayes9cc31582015-06-18 10:12:39 -060040
Tobin Ehlisb835d1b2015-07-03 10:34:49 -060041#include "vk_loader_platform.h"
Courtney Goeltzenleuchter8f8367e2015-10-07 08:38:30 -060042#include "vk_dispatch_table_helper.h"
Mark Lobodzinski9acd2e32016-12-21 15:22:39 -070043#include "vk_enum_string_helper.h"
Courtney Goeltzenleuchter8f8367e2015-10-07 08:38:30 -060044#include "image.h"
45#include "vk_layer_config.h"
46#include "vk_layer_extension_utils.h"
Tobin Ehlisa0cb02e2015-07-03 10:15:26 -060047#include "vk_layer_table.h"
48#include "vk_layer_data.h"
Courtney Goeltzenleuchter426e1872015-07-07 11:18:30 -060049#include "vk_layer_extension_utils.h"
Mike Stroyana3082432015-09-25 13:39:21 -060050#include "vk_layer_utils.h"
Courtney Goeltzenleuchter8f8367e2015-10-07 08:38:30 -060051#include "vk_layer_logging.h"
Mark Lobodzinski69b52fe2016-10-14 11:43:06 -060052#include "vk_validation_error_messages.h"
Jeremy Hayes9cc31582015-06-18 10:12:39 -060053
Mark Muelleraab36502016-05-03 13:17:29 -060054using namespace std;
55
Chia-I Wuaacb0fc2016-04-28 11:27:46 +080056namespace image {
57
Cody Northrop55443ef2015-09-28 15:09:32 -060058struct layer_data {
Chia-I Wu2cfc77c2016-04-28 16:04:15 +080059 VkInstance instance;
60
Jon Ashburn5484e0c2016-03-08 17:48:44 -070061 debug_report_data *report_data;
62 vector<VkDebugReportCallbackEXT> logging_callback;
63 VkLayerDispatchTable *device_dispatch_table;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -070064 VkLayerInstanceDispatchTable *instance_dispatch_table;
Jon Ashburn5484e0c2016-03-08 17:48:44 -070065 VkPhysicalDevice physicalDevice;
66 VkPhysicalDeviceProperties physicalDeviceProperties;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -070067
Chia-I Wue2fc5522015-10-26 20:04:44 +080068 unordered_map<VkImage, IMAGE_STATE> imageMap;
Cody Northrop55443ef2015-09-28 15:09:32 -060069
Jon Ashburn5484e0c2016-03-08 17:48:44 -070070 layer_data()
71 : report_data(nullptr), device_dispatch_table(nullptr), instance_dispatch_table(nullptr), physicalDevice(0),
72 physicalDeviceProperties(){};
Cody Northrop55443ef2015-09-28 15:09:32 -060073};
Jeremy Hayes9cc31582015-06-18 10:12:39 -060074
Mark Young39389872017-01-19 21:10:49 -070075static uint32_t loader_layer_if_version = CURRENT_LOADER_LAYER_INTERFACE_VERSION;
76
Jon Ashburn5484e0c2016-03-08 17:48:44 -070077static unordered_map<void *, layer_data *> layer_data_map;
Jeremy Hayese0ed6a22016-04-08 09:53:54 -060078static std::mutex global_lock;
Jeremy Hayes9cc31582015-06-18 10:12:39 -060079
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -060080static void init_image(layer_data *my_data, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -060081 layer_debug_actions(my_data->report_data, my_data->logging_callback, pAllocator, "lunarg_image");
Jeremy Hayes9cc31582015-06-18 10:12:39 -060082}
83
Tobin Ehlisf4d352b2016-05-19 09:59:30 -060084static IMAGE_STATE const *getImageState(layer_data const *dev_data, VkImage image) {
85 auto it = dev_data->imageMap.find(image);
86 if (it == dev_data->imageMap.end()) {
87 return nullptr;
88 }
89 return &it->second;
90}
91
Chia-I Wu4935c762016-04-28 14:01:30 +080092VKAPI_ATTR VkResult VKAPI_CALL
93CreateDebugReportCallbackEXT(VkInstance instance, const VkDebugReportCallbackCreateInfoEXT *pCreateInfo,
94 const VkAllocationCallbacks *pAllocator, VkDebugReportCallbackEXT *pMsgCallback) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -070095 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
96 VkResult res = my_data->instance_dispatch_table->CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback);
Jeremy Hayes9cc31582015-06-18 10:12:39 -060097 if (res == VK_SUCCESS) {
Mark Lobodzinski97c4d512016-05-19 15:27:18 -060098 res = layer_create_msg_callback(my_data->report_data, false, pCreateInfo, pAllocator, pMsgCallback);
Jeremy Hayes9cc31582015-06-18 10:12:39 -060099 }
100 return res;
101}
102
Chia-I Wu4935c762016-04-28 14:01:30 +0800103VKAPI_ATTR void VKAPI_CALL DestroyDebugReportCallbackEXT(VkInstance instance,
104 VkDebugReportCallbackEXT msgCallback,
105 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700106 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
107 my_data->instance_dispatch_table->DestroyDebugReportCallbackEXT(instance, msgCallback, pAllocator);
Courtney Goeltzenleuchter05854bf2015-11-30 12:13:14 -0700108 layer_destroy_msg_callback(my_data->report_data, msgCallback, pAllocator);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600109}
110
Chia-I Wu4935c762016-04-28 14:01:30 +0800111VKAPI_ATTR void VKAPI_CALL
112DebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objType, uint64_t object,
113 size_t location, int32_t msgCode, const char *pLayerPrefix, const char *pMsg) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700114 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700115 my_data->instance_dispatch_table->DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix,
116 pMsg);
Courtney Goeltzenleuchterf0de7242015-12-01 14:10:55 -0700117}
118
Chia-I Wu4935c762016-04-28 14:01:30 +0800119VKAPI_ATTR VkResult VKAPI_CALL
120CreateInstance(const VkInstanceCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkInstance *pInstance) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700121 VkLayerInstanceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600122
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700123 assert(chain_info->u.pLayerInfo);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700124 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700125 PFN_vkCreateInstance fpCreateInstance = (PFN_vkCreateInstance)fpGetInstanceProcAddr(NULL, "vkCreateInstance");
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700126 if (fpCreateInstance == NULL) {
127 return VK_ERROR_INITIALIZATION_FAILED;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600128 }
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700129
130 // Advance the link info for the next element on the chain
131 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
132
133 VkResult result = fpCreateInstance(pCreateInfo, pAllocator, pInstance);
134 if (result != VK_SUCCESS)
135 return result;
136
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700137 layer_data *my_data = get_my_data_ptr(get_dispatch_key(*pInstance), layer_data_map);
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800138 my_data->instance = *pInstance;
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700139 my_data->instance_dispatch_table = new VkLayerInstanceDispatchTable;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700140 layer_init_instance_dispatch_table(*pInstance, my_data->instance_dispatch_table, fpGetInstanceProcAddr);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700141 my_data->report_data = debug_report_create_instance(my_data->instance_dispatch_table, *pInstance,
142 pCreateInfo->enabledExtensionCount, pCreateInfo->ppEnabledExtensionNames);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700143
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -0600144 init_image(my_data, pAllocator);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700145
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600146 return result;
147}
148
Chia-I Wu4935c762016-04-28 14:01:30 +0800149VKAPI_ATTR void VKAPI_CALL DestroyInstance(VkInstance instance, const VkAllocationCallbacks *pAllocator) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600150 // Grab the key before the instance is destroyed.
151 dispatch_key key = get_dispatch_key(instance);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600152 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
153 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
Chia-I Wuf7458c52015-10-26 21:10:41 +0800154 pTable->DestroyInstance(instance, pAllocator);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600155
156 // Clean up logging callback, if any
Courtney Goeltzenleuchterffcdd8b2015-10-05 15:59:11 -0600157 while (my_data->logging_callback.size() > 0) {
Courtney Goeltzenleuchter7415d5a2015-12-09 15:48:16 -0700158 VkDebugReportCallbackEXT callback = my_data->logging_callback.back();
Courtney Goeltzenleuchter05854bf2015-11-30 12:13:14 -0700159 layer_destroy_msg_callback(my_data->report_data, callback, pAllocator);
Courtney Goeltzenleuchterffcdd8b2015-10-05 15:59:11 -0600160 my_data->logging_callback.pop_back();
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600161 }
162
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600163 layer_debug_report_destroy_instance(my_data->report_data);
164 delete my_data->instance_dispatch_table;
165 layer_data_map.erase(key);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600166}
167
Chia-I Wu4935c762016-04-28 14:01:30 +0800168VKAPI_ATTR VkResult VKAPI_CALL CreateDevice(VkPhysicalDevice physicalDevice,
169 const VkDeviceCreateInfo *pCreateInfo,
170 const VkAllocationCallbacks *pAllocator, VkDevice *pDevice) {
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800171 layer_data *my_instance_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700172 VkLayerDeviceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700173
174 assert(chain_info->u.pLayerInfo);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700175 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
176 PFN_vkGetDeviceProcAddr fpGetDeviceProcAddr = chain_info->u.pLayerInfo->pfnNextGetDeviceProcAddr;
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800177 PFN_vkCreateDevice fpCreateDevice = (PFN_vkCreateDevice)fpGetInstanceProcAddr(my_instance_data->instance, "vkCreateDevice");
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700178 if (fpCreateDevice == NULL) {
179 return VK_ERROR_INITIALIZATION_FAILED;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600180 }
181
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700182 // Advance the link info for the next element on the chain
183 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
184
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700185 VkResult result = fpCreateDevice(physicalDevice, pCreateInfo, pAllocator, pDevice);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700186 if (result != VK_SUCCESS) {
187 return result;
188 }
189
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700190 layer_data *my_device_data = get_my_data_ptr(get_dispatch_key(*pDevice), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700191
192 // Setup device dispatch table
193 my_device_data->device_dispatch_table = new VkLayerDispatchTable;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700194 layer_init_device_dispatch_table(*pDevice, my_device_data->device_dispatch_table, fpGetDeviceProcAddr);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700195
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700196 my_device_data->report_data = layer_debug_report_create_device(my_instance_data->report_data, *pDevice);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700197 my_device_data->physicalDevice = physicalDevice;
198
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700199 my_instance_data->instance_dispatch_table->GetPhysicalDeviceProperties(physicalDevice,
200 &(my_device_data->physicalDeviceProperties));
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700201
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600202 return result;
203}
204
Chia-I Wu4935c762016-04-28 14:01:30 +0800205VKAPI_ATTR void VKAPI_CALL DestroyDevice(VkDevice device, const VkAllocationCallbacks *pAllocator) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600206 dispatch_key key = get_dispatch_key(device);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600207 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
Chia-I Wuf7458c52015-10-26 21:10:41 +0800208 my_data->device_dispatch_table->DestroyDevice(device, pAllocator);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600209 delete my_data->device_dispatch_table;
210 layer_data_map.erase(key);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600211}
212
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700213static const VkExtensionProperties instance_extensions[] = {{VK_EXT_DEBUG_REPORT_EXTENSION_NAME, VK_EXT_DEBUG_REPORT_SPEC_VERSION}};
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600214
Chia-I Wu740891e2016-04-28 14:12:27 +0800215static const VkLayerProperties global_layer = {
Jon Ashburndc9111c2016-03-22 12:57:13 -0600216 "VK_LAYER_LUNARG_image", VK_LAYER_API_VERSION, 1, "LunarG Validation Layer",
Chia-I Wu740891e2016-04-28 14:12:27 +0800217};
Courtney Goeltzenleuchter52857662015-12-01 14:08:28 -0700218
Mark Lobodzinski2fd634c2015-07-29 09:21:22 -0600219// Start of the Image layer proper
220
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600221VKAPI_ATTR VkResult VKAPI_CALL CreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
222 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
223 bool skip_call = false;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700224 VkResult result = VK_ERROR_VALIDATION_FAILED_EXT;
Michael Lentine0a369f62016-02-03 16:51:46 -0600225 VkImageFormatProperties ImageFormatProperties;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700226
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700227 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
228 VkPhysicalDevice physicalDevice = device_data->physicalDevice;
229 layer_data *phy_dev_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700230
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700231 if (pCreateInfo->format != VK_FORMAT_UNDEFINED) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600232 VkFormatProperties properties;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700233 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceFormatProperties(device_data->physicalDevice, pCreateInfo->format,
234 &properties);
Dave Houlton34df4cb2016-12-01 16:43:06 -0700235 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties.linearTilingFeatures == 0)) {
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600236 std::stringstream ss;
237 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600238 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700239 0, __LINE__, VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(),
240 validation_error_map[VALIDATION_ERROR_02150]);
241 }
242
243 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties.optimalTilingFeatures == 0)) {
244 std::stringstream ss;
245 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
246 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
247 0, __LINE__, VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(),
248 validation_error_map[VALIDATION_ERROR_02155]);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600249 }
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600250
251 // Validate that format supports usage as color attachment
252 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
253 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
254 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
255 std::stringstream ss;
256 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
257 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700258 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
259 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02158, "IMAGE",
260 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02158]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600261 }
262 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
263 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
264 std::stringstream ss;
265 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
266 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700267 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
268 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02153, "IMAGE",
269 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02153]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600270 }
271 }
272 // Validate that format supports usage as depth/stencil attachment
273 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
274 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
275 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
276 std::stringstream ss;
277 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
278 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700279 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
280 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02159, "IMAGE",
281 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02159]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600282 }
283 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
284 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
285 std::stringstream ss;
286 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
287 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700288 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
289 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02154, "IMAGE",
290 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02154]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600291 }
292 }
293 } else {
294 skip_call |=
295 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700296 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
297 validation_error_map[VALIDATION_ERROR_00715]);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600298 }
299
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700300 // Internal call to get format info. Still goes through layers, could potentially go directly to ICD.
301 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceImageFormatProperties(
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700302 physicalDevice, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
303 &ImageFormatProperties);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600304
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700305 VkDeviceSize imageGranularity = device_data->physicalDeviceProperties.limits.bufferImageGranularity;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700306 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
307
Mark Youngc48c4c12016-04-11 14:26:49 -0600308 // Make sure all required dimension are non-zero at least.
309 bool failedMinSize = false;
310 switch (pCreateInfo->imageType) {
311 case VK_IMAGE_TYPE_3D:
312 if (pCreateInfo->extent.depth == 0) {
313 failedMinSize = true;
314 }
315 // Intentional fall-through
316 case VK_IMAGE_TYPE_2D:
317 if (pCreateInfo->extent.height == 0) {
318 failedMinSize = true;
319 }
320 // Intentional fall-through
321 case VK_IMAGE_TYPE_1D:
322 if (pCreateInfo->extent.width == 0) {
323 failedMinSize = true;
324 }
325 break;
326 default:
327 break;
328 }
Dave Houlton34df4cb2016-12-01 16:43:06 -0700329 // TODO: VALIDATION_ERROR_00716
330 // this is *almost* VU 00716, except should not be condidtional on image type - all extents must be non-zero for all types
Mark Youngc48c4c12016-04-11 14:26:49 -0600331 if (failedMinSize) {
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600332 skip_call |=
Dave Houlton34df4cb2016-12-01 16:43:06 -0700333 log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
334 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
Mark Youngc48c4c12016-04-11 14:26:49 -0600335 "CreateImage extents is 0 for at least one required dimension for image of type %d: "
336 "Width = %d Height = %d Depth = %d.",
337 pCreateInfo->imageType, pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth);
338 }
339
Dave Houlton34df4cb2016-12-01 16:43:06 -0700340 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
341 // All these extent-related VUs should be checked here
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700342 if ((pCreateInfo->extent.depth > ImageFormatProperties.maxExtent.depth) ||
343 (pCreateInfo->extent.width > ImageFormatProperties.maxExtent.width) ||
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700344 (pCreateInfo->extent.height > ImageFormatProperties.maxExtent.height)) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700345 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
346 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
347 "CreateImage extents exceed allowable limits for format: "
348 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
349 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
350 ImageFormatProperties.maxExtent.width, ImageFormatProperties.maxExtent.height,
351 ImageFormatProperties.maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700352 }
353
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700354 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
355 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
356 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
357 (uint64_t)imageGranularity) &
358 ~(uint64_t)imageGranularity;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700359
360 if (totalSize > ImageFormatProperties.maxResourceSize) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700361 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
362 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
363 "CreateImage resource size exceeds allowable maximum "
364 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
365 totalSize, ImageFormatProperties.maxResourceSize);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700366 }
367
Dave Houlton34df4cb2016-12-01 16:43:06 -0700368 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700369 if (pCreateInfo->mipLevels > ImageFormatProperties.maxMipLevels) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700370 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
371 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
372 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
373 ImageFormatProperties.maxMipLevels);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700374 }
375
376 if (pCreateInfo->arrayLayers > ImageFormatProperties.maxArrayLayers) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700377 skip_call |= log_msg(
378 phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
379 VALIDATION_ERROR_02133, "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s",
380 pCreateInfo->arrayLayers, ImageFormatProperties.maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700381 }
382
383 if ((pCreateInfo->samples & ImageFormatProperties.sampleCounts) == 0) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700384 skip_call |=
385 log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
386 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
387 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties.sampleCounts,
388 validation_error_map[VALIDATION_ERROR_02138]);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700389 }
390
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700391 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700392 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
393 __LINE__, VALIDATION_ERROR_00731, "Image",
394 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
395 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
396 validation_error_map[VALIDATION_ERROR_00731]);
Jeremy Hayesffc8a702016-03-01 14:01:45 -0700397 }
398
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600399 if (!skip_call) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700400 result = device_data->device_dispatch_table->CreateImage(device, pCreateInfo, pAllocator, pImage);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700401 }
402 if (result == VK_SUCCESS) {
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600403 std::lock_guard<std::mutex> lock(global_lock);
Chia-I Wue2fc5522015-10-26 20:04:44 +0800404 device_data->imageMap[*pImage] = IMAGE_STATE(pCreateInfo);
Tobin Ehlisad8c4462015-09-21 15:20:28 -0600405 }
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600406 return result;
407}
408
Chia-I Wu4935c762016-04-28 14:01:30 +0800409VKAPI_ATTR void VKAPI_CALL DestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700410 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600411 std::unique_lock<std::mutex> lock(global_lock);
Chia-I Wue2fc5522015-10-26 20:04:44 +0800412 device_data->imageMap.erase(image);
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600413 lock.unlock();
Chia-I Wuf7458c52015-10-26 21:10:41 +0800414 device_data->device_dispatch_table->DestroyImage(device, image, pAllocator);
Tobin Ehlisad8c4462015-09-21 15:20:28 -0600415}
416
Chia-I Wu4935c762016-04-28 14:01:30 +0800417VKAPI_ATTR VkResult VKAPI_CALL CreateRenderPass(VkDevice device, const VkRenderPassCreateInfo *pCreateInfo,
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600418 const VkAllocationCallbacks *pAllocator, VkRenderPass *pRenderPass) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700419 layer_data *my_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600420 bool skip_call = false;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600421
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700422 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
Mark Lobodzinski27ced8b2016-08-05 11:30:15 -0600423 if (pCreateInfo->pAttachments[i].format == VK_FORMAT_UNDEFINED) {
424 std::stringstream ss;
425 ss << "vkCreateRenderPass: pCreateInfo->pAttachments[" << i << "].format is VK_FORMAT_UNDEFINED";
426 skip_call |= log_msg(my_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
427 IMAGE_RENDERPASS_INVALID_ATTACHMENT, "IMAGE", "%s", ss.str().c_str());
428 }
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600429 }
430
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600431 if (skip_call) {
Courtney Goeltzenleuchter52fee652015-12-10 16:41:22 -0700432 return VK_ERROR_VALIDATION_FAILED_EXT;
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600433 }
Mark Lobodzinski2fd634c2015-07-29 09:21:22 -0600434
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700435 VkResult result = my_data->device_dispatch_table->CreateRenderPass(device, pCreateInfo, pAllocator, pRenderPass);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600436
437 return result;
438}
439
Dave Houlton34df4cb2016-12-01 16:43:06 -0700440VKAPI_ATTR void VKAPI_CALL CmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
441 const VkClearColorValue *pColor, uint32_t rangeCount,
442 const VkImageSubresourceRange *pRanges) {
Dustin Graves080069b2016-04-05 13:48:15 -0600443 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700444 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Jeremy Hayesa4dc0ac2016-03-01 16:51:02 -0700445
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600446 // For each range, image aspect must be color only
Dave Houlton34df4cb2016-12-01 16:43:06 -0700447 // TODO: this is a 'must' in the spec, so there should be a VU enum for it
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600448 for (uint32_t i = 0; i < rangeCount; i++) {
449 if (pRanges[i].aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700450 char const str[] =
451 "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
452 skipCall |=
453 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
454 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600455 }
456 }
457
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600458 auto image_state = getImageState(device_data, image);
459 if (image_state) {
460 if (vk_format_is_depth_or_stencil(image_state->format)) {
461 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
462 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700463 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
464 validation_error_map[VALIDATION_ERROR_01088]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600465 } else if (vk_format_is_compressed(image_state->format)) {
466 char const str[] = "vkCmdClearColorImage called with compressed image.";
467 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700468 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
469 validation_error_map[VALIDATION_ERROR_01088]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600470 }
Tony Barbour26434b92016-06-02 09:43:50 -0600471
472 if (!(image_state->usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
473 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
474 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700475 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
476 validation_error_map[VALIDATION_ERROR_01084]);
Tony Barbour26434b92016-06-02 09:43:50 -0600477 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600478 }
479
Dustin Graves080069b2016-04-05 13:48:15 -0600480 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700481 device_data->device_dispatch_table->CmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600482 }
483}
484
Dave Houlton34df4cb2016-12-01 16:43:06 -0700485VKAPI_ATTR void VKAPI_CALL CmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
486 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
487 const VkImageSubresourceRange *pRanges) {
Dustin Graves080069b2016-04-05 13:48:15 -0600488 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700489 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600490 // For each range, Image aspect must be depth or stencil or both
491 for (uint32_t i = 0; i < rangeCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700492 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
493 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700494 char const str[] = "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
495 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700496 skipCall |=
497 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
498 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600499 }
500 }
501
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600502 auto image_state = getImageState(device_data, image);
503 if (image_state && !vk_format_is_depth_or_stencil(image_state->format)) {
504 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
505 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700506 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
507 validation_error_map[VALIDATION_ERROR_01103]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600508 }
509
Dustin Graves080069b2016-04-05 13:48:15 -0600510 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700511 device_data->device_dispatch_table->CmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount,
512 pRanges);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600513 }
514}
515
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600516// Returns true if [x, xoffset] and [y, yoffset] overlap
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600517static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600518 bool result = false;
519 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
520 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
521
522 if (intersection_max > intersection_min) {
523 result = true;
524 }
525 return result;
526}
527
528// Returns true if two VkImageCopy structures overlap
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600529static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
Alex Smith7b567442017-01-17 11:13:23 +0000530 bool result = false;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600531 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600532 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
533 dst->dstSubresource.layerCount))) {
Alex Smith7b567442017-01-17 11:13:23 +0000534 result = true;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600535 switch (type) {
536 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600537 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600538 // Intentionally fall through to 2D case
539 case VK_IMAGE_TYPE_2D:
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600540 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600541 // Intentionally fall through to 1D case
542 case VK_IMAGE_TYPE_1D:
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600543 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600544 break;
545 default:
546 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
547 assert(false);
548 }
549 }
550 return result;
551}
552
553// Returns true if offset and extent exceed image extents
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600554static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const IMAGE_STATE *image) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600555 bool result = false;
556 // Extents/depths cannot be negative but checks left in for clarity
Mark Lobodzinski39573d22016-10-14 10:59:27 -0600557 switch (image->imageType) {
558 case VK_IMAGE_TYPE_3D: // Validate z and depth
559 if ((offset->z + extent->depth > image->extent.depth) || (offset->z < 0) ||
560 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
561 result = true;
562 }
563 // Intentionally fall through to 2D case to check height
564 case VK_IMAGE_TYPE_2D: // Validate y and height
565 if ((offset->y + extent->height > image->extent.height) || (offset->y < 0) ||
566 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
567 result = true;
568 }
569 // Intentionally fall through to 1D case to check width
570 case VK_IMAGE_TYPE_1D: // Validate x and width
571 if ((offset->x + extent->width > image->extent.width) || (offset->x < 0) ||
572 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
573 result = true;
574 }
575 break;
576 default:
577 assert(false);
578 }
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600579 return result;
580}
581
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600582bool PreCallValidateCmdCopyImage(VkCommandBuffer command_buffer, VkImage src_image, VkImage dst_image, uint32_t region_count,
583 const VkImageCopy *regions) {
584 bool skip = false;
585 layer_data *device_data = get_my_data_ptr(get_dispatch_key(command_buffer), layer_data_map);
586 auto src_image_entry = getImageState(device_data, src_image);
587 auto dst_image_entry = getImageState(device_data, dst_image);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600588
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600589 // TODO: This does not cover swapchain-created images. This should fall out when this layer is moved
590 // into the core_validation layer
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600591 if (src_image_entry && dst_image_entry) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600592
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600593 for (uint32_t i = 0; i < region_count; i++) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600594
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600595 if (regions[i].srcSubresource.layerCount == 0) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600596 std::stringstream ss;
597 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600598 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
599 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t &>(command_buffer),
600 __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600601 }
602
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600603 if (regions[i].dstSubresource.layerCount == 0) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600604 std::stringstream ss;
605 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600606 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
607 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t &>(command_buffer),
608 __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600609 }
610
611 // For each region the layerCount member of srcSubresource and dstSubresource must match
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600612 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600613 std::stringstream ss;
614 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
615 << "] do not match";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600616 skip |=
Mark Lobodzinskia9a69ad2016-10-14 12:13:33 -0600617 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600618 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
Mark Lobodzinskia9a69ad2016-10-14 12:13:33 -0600619 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600620 }
621
622 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600623 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600624 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600625 skip |=
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600626 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700627 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
628 validation_error_map[VALIDATION_ERROR_01197]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600629 }
630
631 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600632 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
633 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600634 std::stringstream ss;
635 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700636 skip |=
637 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
638 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01222, "IMAGE", "%s. %s",
639 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600640 }
641
642 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
643 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600644 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
645 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600646 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600647 skip |=
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600648 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700649 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
650 validation_error_map[VALIDATION_ERROR_01221]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600651 }
652
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600653 // If either of the calling command's src_image or dst_image parameters are of VkImageType VK_IMAGE_TYPE_3D,
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600654 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600655 if (((src_image_entry->imageType == VK_IMAGE_TYPE_3D) || (dst_image_entry->imageType == VK_IMAGE_TYPE_3D)) &&
656 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
657 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600658 std::stringstream ss;
659 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
660 << "] baseArrayLayer was not zero or layerCount was not 1.";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700661 skip |=
662 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
663 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01199, "IMAGE", "%s. %s",
664 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600665 }
666
667 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600668 if (regions[i].srcSubresource.mipLevel >= src_image_entry->mipLevels) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600669 std::stringstream ss;
670 ss << "vkCmdCopyImage: pRegions[" << i
671 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700672 skip |=
673 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
674 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
675 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600676 }
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600677 if (regions[i].dstSubresource.mipLevel >= dst_image_entry->mipLevels) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600678 std::stringstream ss;
679 ss << "vkCmdCopyImage: pRegions[" << i
680 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700681 skip |=
682 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
683 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
684 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600685 }
686
687 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
688 // image was created
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600689 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) > src_image_entry->arraySize) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600690 std::stringstream ss;
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600691 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_entry->arraySize << " but subRegion[" << i
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600692 << "] baseArrayLayer + layerCount is "
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600693 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
Dave Houlton34df4cb2016-12-01 16:43:06 -0700694 skip |=
695 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
696 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
697 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600698 }
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600699 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) > dst_image_entry->arraySize) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600700 std::stringstream ss;
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600701 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_entry->arraySize << " but subRegion[" << i
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600702 << "] baseArrayLayer + layerCount is "
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600703 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
Dave Houlton34df4cb2016-12-01 16:43:06 -0700704 skip |=
705 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
706 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
707 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600708 }
709
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600710 // The source region specified by a given element of regions must be a region that is contained within srcImage
711 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, src_image_entry)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600712 std::stringstream ss;
713 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage was created with";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600714 skip |=
Mark Lobodzinski8ea6eb02016-10-14 11:40:31 -0600715 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600716 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01175, "IMAGE", "%s. %s",
Tobin Ehlis15edfa82016-10-18 07:31:22 -0600717 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600718 }
719
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600720 // The destination region specified by a given element of regions must be a region that is contained within dst_image
721 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, dst_image_entry)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600722 std::stringstream ss;
723 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600724 skip |=
Mark Lobodzinski8ea6eb02016-10-14 11:40:31 -0600725 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600726 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
Mark Lobodzinski8ea6eb02016-10-14 11:40:31 -0600727 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600728 }
729
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600730 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600731 // must not overlap in memory
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600732 if (src_image == dst_image) {
733 for (uint32_t j = 0; j < region_count; j++) {
734 if (RegionIntersects(&regions[i], &regions[j], src_image_entry->imageType)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600735 std::stringstream ss;
736 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700737 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
738 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
739 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
740 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600741 }
742 }
743 }
Mike Stroyana3082432015-09-25 13:39:21 -0600744 }
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600745
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600746 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600747 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
748 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600749 if (vk_format_is_depth_or_stencil(src_image_entry->format) || vk_format_is_depth_or_stencil(dst_image_entry->format)) {
750 if (src_image_entry->format != dst_image_entry->format) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700751 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600752 skip |=
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700753 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600754 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, IMAGE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mike Stroyana3082432015-09-25 13:39:21 -0600755 }
756 } else {
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600757 size_t srcSize = vk_format_get_size(src_image_entry->format);
758 size_t destSize = vk_format_get_size(dst_image_entry->format);
Mike Stroyana3082432015-09-25 13:39:21 -0600759 if (srcSize != destSize) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700760 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600761 skip |=
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700762 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600763 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
Tobin Ehlis15edfa82016-10-18 07:31:22 -0600764 validation_error_map[VALIDATION_ERROR_01184]);
Mike Stroyana3082432015-09-25 13:39:21 -0600765 }
766 }
767 }
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600768 return skip;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600769}
770
Chia-I Wu4935c762016-04-28 14:01:30 +0800771VKAPI_ATTR void VKAPI_CALL CmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage,
772 VkImageLayout srcImageLayout, VkImage dstImage,
773 VkImageLayout dstImageLayout, uint32_t regionCount,
774 const VkImageCopy *pRegions) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600775
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600776 bool skip = false;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600777 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
778
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600779 skip = PreCallValidateCmdCopyImage(commandBuffer, srcImage, dstImage, regionCount, pRegions);
Mike Stroyana3082432015-09-25 13:39:21 -0600780
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600781 if (!skip) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700782 device_data->device_dispatch_table->CmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
783 regionCount, pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600784 }
785}
786
Chia-I Wu4935c762016-04-28 14:01:30 +0800787VKAPI_ATTR void VKAPI_CALL CmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
788 const VkClearAttachment *pAttachments, uint32_t rectCount,
789 const VkClearRect *pRects) {
Dustin Graves080069b2016-04-05 13:48:15 -0600790 bool skipCall = false;
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600791 VkImageAspectFlags aspectMask;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700792 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600793 for (uint32_t i = 0; i < attachmentCount; i++) {
794 aspectMask = pAttachments[i].aspectMask;
Dave Houlton34df4cb2016-12-01 16:43:06 -0700795 if (0 == aspectMask) {
796 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
797 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
798 VALIDATION_ERROR_01128, "IMAGE", "%s", validation_error_map[VALIDATION_ERROR_01128]);
799 } else if (aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
800 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
801 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
802 VALIDATION_ERROR_01126, "IMAGE", "%s", validation_error_map[VALIDATION_ERROR_01126]);
803 } else if (aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
804 if ((aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) || (aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700805 char const str[] =
Dave Houlton34df4cb2016-12-01 16:43:06 -0700806 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
807 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
808 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
809 VALIDATION_ERROR_01125, "IMAGE", str, i, validation_error_map[VALIDATION_ERROR_01125]);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600810 }
811 } else {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700812 // Having eliminated all other possibilities, image aspect must be depth or stencil or both
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700813 if (((aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
814 ((aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
815 char const str[] = "vkCmdClearAttachments aspectMask [%d] must be set to VK_IMAGE_ASPECT_DEPTH_BIT and/or "
Dave Houlton34df4cb2016-12-01 16:43:06 -0700816 "VK_IMAGE_ASPECT_STENCIL_BIT. %s";
817 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
818 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
819 VALIDATION_ERROR_01127, "IMAGE", str, i, validation_error_map[VALIDATION_ERROR_01127]);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600820 }
821 }
822 }
823
Dustin Graves080069b2016-04-05 13:48:15 -0600824 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700825 device_data->device_dispatch_table->CmdClearAttachments(commandBuffer, attachmentCount, pAttachments, rectCount, pRects);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600826 }
827}
828
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700829static bool ValidateBufferImageCopyData(layer_data *dev_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
830 VkImage image, const char *function) {
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600831 bool skip = false;
832
833 for (uint32_t i = 0; i < regionCount; i++) {
834
835 auto image_info = getImageState(dev_data, image);
836 if (image_info) {
Mark Lobodzinski1bda8892016-11-22 14:46:39 -0700837
838 if ((image_info->imageType == VK_IMAGE_TYPE_1D) || (image_info->imageType == VK_IMAGE_TYPE_2D)) {
839 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
840 skip |= log_msg(dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
841 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01269, "IMAGE",
842 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. These must be 0 and 1, "
843 "respectively. %s",
844 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
845 validation_error_map[VALIDATION_ERROR_01269]);
846 }
847 }
848
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600849 // BufferOffset must be a multiple of the calling command's VkImage parameter's texel size
850 auto texel_size = vk_format_get_size(image_info->format);
851 if (vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
852 skip |= log_msg(dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700853 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600854 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700855 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
856 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600857 }
Mark Lobodzinski1bda8892016-11-22 14:46:39 -0700858
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600859 // BufferOffset must be a multiple of 4
860 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
861 skip |= log_msg(dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700862 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
863 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
864 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600865 }
866
867 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
868 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
869 skip |= log_msg(
870 dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700871 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
872 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
873 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
874 validation_error_map[VALIDATION_ERROR_01265]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600875 }
876
877 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
878 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
879 skip |= log_msg(
880 dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700881 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
882 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
883 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
884 validation_error_map[VALIDATION_ERROR_01266]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600885 }
Mark Lobodzinski040142c2016-11-22 11:18:46 -0700886
887 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700888 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
Mark Lobodzinski040142c2016-11-22 11:18:46 -0700889 if (aspect_mask_bits.count() != 1) {
890 skip |=
891 log_msg(dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
892 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
893 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
894 validation_error_map[VALIDATION_ERROR_01280]);
895 }
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600896 }
897 }
898
899 return skip;
900}
901
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700902static bool PreCallValidateCmdCopyImageToBuffer(layer_data *dev_data, VkImage srcImage, uint32_t regionCount,
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700903 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700904 return ValidateBufferImageCopyData(dev_data, regionCount, pRegions, srcImage, "vkCmdCopyImageToBuffer");
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700905}
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600906
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700907VKAPI_ATTR void VKAPI_CALL CmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
908 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
909 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
910
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700911 if (!PreCallValidateCmdCopyImageToBuffer(device_data, srcImage, regionCount, pRegions, "vkCmdCopyImageToBuffer()")) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700912 device_data->device_dispatch_table->CmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount,
913 pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600914 }
915}
916
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700917static bool PreCallValidateCmdCopyBufferToImage(layer_data *dev_data, VkImage dstImage, uint32_t regionCount,
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700918 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700919 return ValidateBufferImageCopyData(dev_data, regionCount, pRegions, dstImage, "vkCmdCopyBufferToImage");
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700920}
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600921
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700922VKAPI_ATTR void VKAPI_CALL CmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
923 VkImageLayout dstImageLayout, uint32_t regionCount,
924 const VkBufferImageCopy *pRegions) {
925 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
926
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700927 if (!PreCallValidateCmdCopyBufferToImage(device_data, dstImage, regionCount, pRegions, "vkCmdCopyBufferToImage()")) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700928 device_data->device_dispatch_table->CmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount,
929 pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600930 }
931}
932
Dave Houlton34df4cb2016-12-01 16:43:06 -0700933VKAPI_ATTR void VKAPI_CALL CmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
934 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
935 const VkImageBlit *pRegions, VkFilter filter) {
Dustin Graves080069b2016-04-05 13:48:15 -0600936 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700937 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600938
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600939 // Warn for zero-sized regions
940 for (uint32_t i = 0; i < regionCount; i++) {
941 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
942 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
943 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
944 std::stringstream ss;
945 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
946 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700947 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(commandBuffer), __LINE__,
948 IMAGE_INVALID_EXTENTS, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600949 }
950 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
951 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
952 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
953 std::stringstream ss;
954 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
955 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700956 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(commandBuffer), __LINE__,
957 IMAGE_INVALID_EXTENTS, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600958 }
959 }
960
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600961 auto srcImageEntry = getImageState(device_data, srcImage);
962 auto dstImageEntry = getImageState(device_data, dstImage);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600963
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600964 if (srcImageEntry && dstImageEntry) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600965
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600966 VkFormat srcFormat = srcImageEntry->format;
967 VkFormat dstFormat = dstImageEntry->format;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600968
Dave Houlton34df4cb2016-12-01 16:43:06 -0700969 // Validate consistency for unsigned formats
970 if (vk_format_is_uint(srcFormat) != vk_format_is_uint(dstFormat)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600971 std::stringstream ss;
Dave Houlton34df4cb2016-12-01 16:43:06 -0700972 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
973 << "the other one must also have unsigned integer format. "
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700974 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700975 skipCall |=
976 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700977 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s", ss.str().c_str(),
978 validation_error_map[VALIDATION_ERROR_02191]);
979 }
980
981 // Validate consistency for signed formats
982 if (vk_format_is_sint(srcFormat) != vk_format_is_sint(dstFormat)) {
983 std::stringstream ss;
984 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
985 << "the other one must also have signed integer format. "
986 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
987 skipCall |=
988 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
989 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s", ss.str().c_str(),
990 validation_error_map[VALIDATION_ERROR_02190]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600991 }
992
993 // Validate aspect bits and formats for depth/stencil images
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700994 if (vk_format_is_depth_or_stencil(srcFormat) || vk_format_is_depth_or_stencil(dstFormat)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600995 if (srcFormat != dstFormat) {
996 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700997 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
998 << "stencil, the other one must have exactly the same format. "
999 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001000 skipCall |=
1001 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -07001002 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02192, "IMAGE", "%s. %s", ss.str().c_str(),
1003 validation_error_map[VALIDATION_ERROR_02192]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001004 }
1005
Dave Houlton34df4cb2016-12-01 16:43:06 -07001006 // TODO: Confirm that all these checks are intended to be nested under depth/stencil only
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001007 for (uint32_t i = 0; i < regionCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001008 if (pRegions[i].srcSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001009 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1010 // TODO: Verify against Valid Use section of spec, if this case yields undefined results, then it's an error
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001011 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1012 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1013 IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001014 }
1015
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001016 if (pRegions[i].dstSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001017 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1018 // TODO: Verify against Valid Use section of spec, if this case yields undefined results, then it's an error
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001019 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1020 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1021 IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001022 }
1023
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001024 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001025 char const str[] = "vkCmdBlitImage: number of layers in source and destination subresources must match";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001026 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1027 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1028 IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001029 }
1030
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001031 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
1032 VkImageAspectFlags dstAspect = pRegions[i].dstSubresource.aspectMask;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001033
1034 if (srcAspect != dstAspect) {
1035 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001036 ss << "vkCmdBlitImage: Image aspects of depth/stencil images should match";
1037 // TODO: Verify against Valid Use section of spec, if this case yields undefined results, then it's an error
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001038 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1039 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1040 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001041 }
1042 if (vk_format_is_depth_and_stencil(srcFormat)) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001043 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001044 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001045 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1046 "VK_IMAGE_ASPECT_DEPTH_BIT "
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001047 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001048 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1049 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1050 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001051 }
1052 } else if (vk_format_is_stencil_only(srcFormat)) {
1053 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1054 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001055 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
Chia-I Wu3432a0c2015-10-27 18:04:07 +08001056 << "set in both the srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001057 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1058 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1059 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001060 }
1061 } else if (vk_format_is_depth_only(srcFormat)) {
1062 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1063 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001064 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
Chia-I Wu3432a0c2015-10-27 18:04:07 +08001065 << "set in both the srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001066 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1067 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1068 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001069 }
1070 }
1071 }
1072 }
1073
1074 // Validate filter
Dave Houlton34df4cb2016-12-01 16:43:06 -07001075 if (vk_format_is_depth_or_stencil(srcFormat) && (filter != VK_FILTER_NEAREST)) {
1076 std::stringstream ss;
1077 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1078 << "then filter must be VK_FILTER_NEAREST.";
1079 skipCall |=
1080 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1081 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s", ss.str().c_str(),
1082 validation_error_map[VALIDATION_ERROR_02193]);
1083 }
1084 if (vk_format_is_int(srcFormat) && (filter != VK_FILTER_NEAREST)) {
1085 std::stringstream ss;
1086 ss << "vkCmdBlitImage: If the format of srcImage is an integer-based format "
1087 << "then filter must be VK_FILTER_NEAREST.";
1088 skipCall |=
1089 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1090 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_FILTER, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001091 }
1092 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001093
Tony Barbourf8309102016-05-05 10:50:21 -06001094 if (!skipCall) {
Dave Houlton34df4cb2016-12-01 16:43:06 -07001095 device_data->device_dispatch_table->CmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
1096 regionCount, pRegions, filter);
Tony Barbourf8309102016-05-05 10:50:21 -06001097 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001098}
1099
Chia-I Wu4935c762016-04-28 14:01:30 +08001100VKAPI_ATTR void VKAPI_CALL
1101CmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
1102 VkDependencyFlags dependencyFlags, uint32_t memoryBarrierCount, const VkMemoryBarrier *pMemoryBarriers,
1103 uint32_t bufferMemoryBarrierCount, const VkBufferMemoryBarrier *pBufferMemoryBarriers,
1104 uint32_t imageMemoryBarrierCount, const VkImageMemoryBarrier *pImageMemoryBarriers) {
Dustin Graves080069b2016-04-05 13:48:15 -06001105 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001106 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Jeremy Hayes01b38892015-11-17 18:19:55 -07001107
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001108 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
1109 VkImageMemoryBarrier const *const barrier = (VkImageMemoryBarrier const *const) & pImageMemoryBarriers[i];
Dave Houlton34df4cb2016-12-01 16:43:06 -07001110 // TODO: add VALIDATION_ERROR_00309 (sType == VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER) here
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001111 if (barrier->sType == VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER) {
Dave Houlton34df4cb2016-12-01 16:43:06 -07001112 // TODO: this check should include VALIDATION_ERROR_00301 and VALIDATION_ERROR_00316
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001113 if (barrier->subresourceRange.layerCount == 0) {
Jeremy Hayes01b38892015-11-17 18:19:55 -07001114 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001115 ss << "vkCmdPipelineBarrier called with 0 in ppMemoryBarriers[" << i << "]->subresourceRange.layerCount.";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001116 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
1117 __LINE__, IMAGE_INVALID_IMAGE_RESOURCE, "IMAGE", "%s", ss.str().c_str());
Jeremy Hayes01b38892015-11-17 18:19:55 -07001118 }
1119 }
1120 }
1121
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001122 if (skipCall) {
Jeremy Hayes01b38892015-11-17 18:19:55 -07001123 return;
1124 }
1125
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001126 device_data->device_dispatch_table->CmdPipelineBarrier(commandBuffer, srcStageMask, dstStageMask, dependencyFlags,
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001127 memoryBarrierCount, pMemoryBarriers, bufferMemoryBarrierCount,
1128 pBufferMemoryBarriers, imageMemoryBarrierCount, pImageMemoryBarriers);
Jeremy Hayes01b38892015-11-17 18:19:55 -07001129}
1130
Dave Houlton34df4cb2016-12-01 16:43:06 -07001131VKAPI_ATTR void VKAPI_CALL CmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
1132 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
1133 const VkImageResolve *pRegions) {
Dustin Graves080069b2016-04-05 13:48:15 -06001134 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001135 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001136 auto srcImageEntry = getImageState(device_data, srcImage);
1137 auto dstImageEntry = getImageState(device_data, dstImage);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001138
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001139 // For each region, the number of layers in the image subresource should not be zero
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001140 // For each region, src and dest image aspect must be color only
1141 for (uint32_t i = 0; i < regionCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001142 if (pRegions[i].srcSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001143 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
1144 // TODO: Verify against Valid Use section of spec. Generally if something yield an undefined result, it's invalid/error
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001145 skipCall |=
1146 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1147 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001148 }
1149
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001150 if (pRegions[i].dstSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001151 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Courtney Goeltzenleuchter7415d5a2015-12-09 15:48:16 -07001152
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001153 // TODO: Verify against Valid Use section of spec. Generally if something yield an undefined result, it's invalid/error
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001154 skipCall |=
1155 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1156 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001157 }
1158
Dave Houlton34df4cb2016-12-01 16:43:06 -07001159 // TODO: VALIDATION_ERROR_01339
1160
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001161 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001162 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001163 char const str[] =
1164 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001165 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1166 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1167 VALIDATION_ERROR_01338, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001168 }
1169 }
1170
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001171 if (srcImageEntry && dstImageEntry) {
1172 if (srcImageEntry->format != dstImageEntry->format) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001173 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
1174 skipCall |=
1175 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1176 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mike Stroyana3082432015-09-25 13:39:21 -06001177 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001178 if (srcImageEntry->imageType != dstImageEntry->imageType) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001179 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
1180 skipCall |=
1181 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1182 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mike Stroyana3082432015-09-25 13:39:21 -06001183 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001184 if (srcImageEntry->samples == VK_SAMPLE_COUNT_1_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001185 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001186 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1187 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1188 VALIDATION_ERROR_01320, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01320]);
Mike Stroyana3082432015-09-25 13:39:21 -06001189 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001190 if (dstImageEntry->samples != VK_SAMPLE_COUNT_1_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001191 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001192 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1193 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1194 VALIDATION_ERROR_01321, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01321]);
Mike Stroyana3082432015-09-25 13:39:21 -06001195 }
1196 }
1197
Dustin Graves080069b2016-04-05 13:48:15 -06001198 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001199 device_data->device_dispatch_table->CmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
1200 regionCount, pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001201 }
1202}
1203
Dave Houlton34df4cb2016-12-01 16:43:06 -07001204VKAPI_ATTR void VKAPI_CALL GetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
1205 VkSubresourceLayout *pLayout) {
Dustin Graves080069b2016-04-05 13:48:15 -06001206 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001207 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001208 VkFormat format;
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001209
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001210 auto imageEntry = getImageState(device_data, image);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001211
1212 // Validate that image aspects match formats
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001213 if (imageEntry) {
1214 format = imageEntry->format;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001215 if (vk_format_is_color(format)) {
Chia-I Wu52b07e72015-10-27 19:55:05 +08001216 if (pSubresource->aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001217 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001218 ss << "vkGetImageSubresourceLayout: For color formats, the aspectMask field of VkImageSubresource must be "
1219 "VK_IMAGE_ASPECT_COLOR.";
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001220 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -07001221 (uint64_t)image, __LINE__, VALIDATION_ERROR_00741, "IMAGE", "%s. %s", ss.str().c_str(),
1222 validation_error_map[VALIDATION_ERROR_00741]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001223 }
1224 } else if (vk_format_is_depth_or_stencil(format)) {
Chia-I Wu52b07e72015-10-27 19:55:05 +08001225 if ((pSubresource->aspectMask != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1226 (pSubresource->aspectMask != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001227 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001228 ss << "vkGetImageSubresourceLayout: For depth/stencil formats, the aspectMask selects either the depth or stencil "
1229 "image aspectMask.";
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001230 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -07001231 (uint64_t)image, __LINE__, VALIDATION_ERROR_00741, "IMAGE", "%s. %s", ss.str().c_str(),
1232 validation_error_map[VALIDATION_ERROR_00741]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001233 }
1234 }
1235 }
1236
Dustin Graves080069b2016-04-05 13:48:15 -06001237 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001238 device_data->device_dispatch_table->GetImageSubresourceLayout(device, image, pSubresource, pLayout);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001239 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001240}
1241
Chia-I Wu4935c762016-04-28 14:01:30 +08001242VKAPI_ATTR void VKAPI_CALL
1243GetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice, VkPhysicalDeviceProperties *pProperties) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001244 layer_data *phy_dev_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
1245 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceProperties(physicalDevice, pProperties);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -07001246}
1247
Chia-I Wub02600c2016-05-20 07:11:22 +08001248VKAPI_ATTR VkResult VKAPI_CALL
1249EnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) {
1250 return util_GetLayerProperties(1, &global_layer, pCount, pProperties);
1251}
1252
1253VKAPI_ATTR VkResult VKAPI_CALL
1254EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, VkLayerProperties *pProperties) {
1255 return util_GetLayerProperties(1, &global_layer, pCount, pProperties);
1256}
1257
1258VKAPI_ATTR VkResult VKAPI_CALL
1259EnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, VkExtensionProperties *pProperties) {
1260 if (pLayerName && !strcmp(pLayerName, global_layer.layerName))
1261 return util_GetExtensionProperties(1, instance_extensions, pCount, pProperties);
1262
1263 return VK_ERROR_LAYER_NOT_PRESENT;
1264}
1265
Chia-I Wu4935c762016-04-28 14:01:30 +08001266VKAPI_ATTR VkResult VKAPI_CALL EnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice,
1267 const char *pLayerName, uint32_t *pCount,
1268 VkExtensionProperties *pProperties) {
Chia-I Wueec9a312016-04-28 11:21:49 +08001269 // Image does not have any physical device extensions
Chia-I Wu3f326222016-04-28 14:21:13 +08001270 if (pLayerName && !strcmp(pLayerName, global_layer.layerName))
Chia-I Wueec9a312016-04-28 11:21:49 +08001271 return util_GetExtensionProperties(0, NULL, pCount, pProperties);
Chia-I Wu3f326222016-04-28 14:21:13 +08001272
1273 assert(physicalDevice);
1274
1275 dispatch_key key = get_dispatch_key(physicalDevice);
1276 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
1277 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
1278 return pTable->EnumerateDeviceExtensionProperties(physicalDevice, NULL, pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001279}
1280
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001281static PFN_vkVoidFunction
Chia-I Wu428eba02016-04-28 14:38:57 +08001282intercept_core_instance_command(const char *name);
1283static PFN_vkVoidFunction
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001284intercept_core_device_command(const char *name);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -06001285
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001286VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetDeviceProcAddr(VkDevice device, const char *funcName) {
1287 PFN_vkVoidFunction proc = intercept_core_device_command(funcName);
1288 if (proc)
1289 return proc;
1290
1291 assert(device);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001292
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001293 layer_data *my_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001294
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001295 VkLayerDispatchTable *pTable = my_data->device_dispatch_table;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001296 {
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -06001297 if (pTable->GetDeviceProcAddr == NULL)
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001298 return NULL;
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -06001299 return pTable->GetDeviceProcAddr(device, funcName);
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001300 }
1301}
1302
Chia-I Wu4935c762016-04-28 14:01:30 +08001303VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetInstanceProcAddr(VkInstance instance, const char *funcName) {
Chia-I Wu428eba02016-04-28 14:38:57 +08001304 PFN_vkVoidFunction proc = intercept_core_instance_command(funcName);
Chia-I Wuf89922c2016-04-28 15:16:59 +08001305 if (!proc)
1306 proc = intercept_core_device_command(funcName);
Chia-I Wu428eba02016-04-28 14:38:57 +08001307 if (proc)
1308 return proc;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001309
Chia-I Wuf89922c2016-04-28 15:16:59 +08001310 assert(instance);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001311 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001312
Chia-I Wuf89922c2016-04-28 15:16:59 +08001313 proc = debug_report_get_instance_proc_addr(my_data->report_data, funcName);
1314 if (proc)
1315 return proc;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001316
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001317 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001318 if (pTable->GetInstanceProcAddr == NULL)
1319 return NULL;
1320 return pTable->GetInstanceProcAddr(instance, funcName);
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001321}
Chia-I Wueec9a312016-04-28 11:21:49 +08001322
Mark Young39389872017-01-19 21:10:49 -07001323VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetPhysicalDeviceProcAddr(VkInstance instance, const char *funcName) {
1324 assert(instance);
1325
1326 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
1327
1328 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
1329 if (pTable->GetPhysicalDeviceProcAddr == NULL)
1330 return NULL;
1331 return pTable->GetPhysicalDeviceProcAddr(instance, funcName);
1332}
1333
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001334static PFN_vkVoidFunction
Chia-I Wu428eba02016-04-28 14:38:57 +08001335intercept_core_instance_command(const char *name) {
1336 static const struct {
1337 const char *name;
1338 PFN_vkVoidFunction proc;
1339 } core_instance_commands[] = {
1340 { "vkGetInstanceProcAddr", reinterpret_cast<PFN_vkVoidFunction>(GetInstanceProcAddr) },
1341 { "vkCreateInstance", reinterpret_cast<PFN_vkVoidFunction>(CreateInstance) },
1342 { "vkDestroyInstance", reinterpret_cast<PFN_vkVoidFunction>(DestroyInstance) },
1343 { "vkCreateDevice", reinterpret_cast<PFN_vkVoidFunction>(CreateDevice) },
Chia-I Wub02600c2016-05-20 07:11:22 +08001344 { "vkEnumerateInstanceLayerProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateInstanceLayerProperties) },
1345 { "vkEnumerateDeviceLayerProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateDeviceLayerProperties) },
1346 { "vkEnumerateInstanceExtensionProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateInstanceExtensionProperties) },
Chia-I Wu428eba02016-04-28 14:38:57 +08001347 { "vkEnumerateDeviceExtensionProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateDeviceExtensionProperties) },
1348 { "vkGetPhysicalDeviceProperties", reinterpret_cast<PFN_vkVoidFunction>(GetPhysicalDeviceProperties) },
Mark Young39389872017-01-19 21:10:49 -07001349 { "vk_layerGetPhysicalDeviceProcAddr", reinterpret_cast<PFN_vkVoidFunction>(GetPhysicalDeviceProcAddr) },
Chia-I Wu428eba02016-04-28 14:38:57 +08001350 };
1351
1352 for (size_t i = 0; i < ARRAY_SIZE(core_instance_commands); i++) {
1353 if (!strcmp(core_instance_commands[i].name, name))
1354 return core_instance_commands[i].proc;
1355 }
1356
1357 return nullptr;
1358}
1359
1360static PFN_vkVoidFunction
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001361intercept_core_device_command(const char *name) {
1362 static const struct {
1363 const char *name;
1364 PFN_vkVoidFunction proc;
1365 } core_device_commands[] = {
Tobin Ehlis16239872016-10-26 10:42:49 -06001366 {"vkGetDeviceProcAddr", reinterpret_cast<PFN_vkVoidFunction>(GetDeviceProcAddr)},
1367 {"vkDestroyDevice", reinterpret_cast<PFN_vkVoidFunction>(DestroyDevice)},
1368 {"vkCreateImage", reinterpret_cast<PFN_vkVoidFunction>(CreateImage)},
1369 {"vkDestroyImage", reinterpret_cast<PFN_vkVoidFunction>(DestroyImage)},
1370 {"vkCreateRenderPass", reinterpret_cast<PFN_vkVoidFunction>(CreateRenderPass)},
1371 {"vkCmdClearColorImage", reinterpret_cast<PFN_vkVoidFunction>(CmdClearColorImage)},
1372 {"vkCmdClearDepthStencilImage", reinterpret_cast<PFN_vkVoidFunction>(CmdClearDepthStencilImage)},
1373 {"vkCmdClearAttachments", reinterpret_cast<PFN_vkVoidFunction>(CmdClearAttachments)},
1374 {"vkCmdCopyImage", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyImage)},
1375 {"vkCmdCopyImageToBuffer", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyImageToBuffer)},
1376 {"vkCmdCopyBufferToImage", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyBufferToImage)},
1377 {"vkCmdBlitImage", reinterpret_cast<PFN_vkVoidFunction>(CmdBlitImage)},
1378 {"vkCmdPipelineBarrier", reinterpret_cast<PFN_vkVoidFunction>(CmdPipelineBarrier)},
1379 {"vkCmdResolveImage", reinterpret_cast<PFN_vkVoidFunction>(CmdResolveImage)},
1380 {"vkGetImageSubresourceLayout", reinterpret_cast<PFN_vkVoidFunction>(GetImageSubresourceLayout)},
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001381 };
1382
1383 for (size_t i = 0; i < ARRAY_SIZE(core_device_commands); i++) {
1384 if (!strcmp(core_device_commands[i].name, name))
1385 return core_device_commands[i].proc;
1386 }
1387
1388 return nullptr;
1389}
1390
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001391} // namespace image
1392
1393// vk_layer_logging.h expects these to be defined
1394
1395VKAPI_ATTR VkResult VKAPI_CALL
1396vkCreateDebugReportCallbackEXT(VkInstance instance, const VkDebugReportCallbackCreateInfoEXT *pCreateInfo,
1397 const VkAllocationCallbacks *pAllocator, VkDebugReportCallbackEXT *pMsgCallback) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001398 return image::CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001399}
1400
1401VKAPI_ATTR void VKAPI_CALL
1402vkDestroyDebugReportCallbackEXT(VkInstance instance,
1403 VkDebugReportCallbackEXT msgCallback,
1404 const VkAllocationCallbacks *pAllocator) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001405 image::DestroyDebugReportCallbackEXT(instance, msgCallback, pAllocator);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001406}
1407
1408VKAPI_ATTR void VKAPI_CALL
1409vkDebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objType, uint64_t object,
1410 size_t location, int32_t msgCode, const char *pLayerPrefix, const char *pMsg) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001411 image::DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix, pMsg);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001412}
1413
Chia-I Wub02600c2016-05-20 07:11:22 +08001414// loader-layer interface v0, just wrappers since there is only a layer
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001415
Chia-I Wueec9a312016-04-28 11:21:49 +08001416VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL
1417vkEnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, VkExtensionProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001418 return image::EnumerateInstanceExtensionProperties(pLayerName, pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001419}
1420
1421VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL
1422vkEnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001423 return image::EnumerateInstanceLayerProperties(pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001424}
1425
1426VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL
1427vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, VkLayerProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001428 // the layer command handles VK_NULL_HANDLE just fine internally
1429 assert(physicalDevice == VK_NULL_HANDLE);
1430 return image::EnumerateDeviceLayerProperties(VK_NULL_HANDLE, pCount, pProperties);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001431}
1432
1433VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice,
1434 const char *pLayerName, uint32_t *pCount,
1435 VkExtensionProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001436 // the layer command handles VK_NULL_HANDLE just fine internally
1437 assert(physicalDevice == VK_NULL_HANDLE);
Chia-I Wu3f326222016-04-28 14:21:13 +08001438 return image::EnumerateDeviceExtensionProperties(VK_NULL_HANDLE, pLayerName, pCount, pProperties);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001439}
1440
1441VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001442 return image::GetDeviceProcAddr(dev, funcName);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001443}
1444
1445VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001446 return image::GetInstanceProcAddr(instance, funcName);
Chia-I Wueec9a312016-04-28 11:21:49 +08001447}
Mark Young39389872017-01-19 21:10:49 -07001448
1449VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vk_layerGetPhysicalDeviceProcAddr(VkInstance instance, const char *funcName) {
1450 return image::GetPhysicalDeviceProcAddr(instance, funcName);
1451}
1452
1453VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkNegotiateLoaderLayerInterfaceVersion(VkNegotiateLayerInterface *pVersionStruct) {
1454 assert(pVersionStruct != NULL);
1455 assert(pVersionStruct->sType == LAYER_NEGOTIATE_INTERFACE_STRUCT);
1456
1457 // Fill in the function pointers if our version is at least capable of having the structure contain them.
1458 if (pVersionStruct->loaderLayerInterfaceVersion >= 2) {
1459 pVersionStruct->pfnGetInstanceProcAddr = vkGetInstanceProcAddr;
1460 pVersionStruct->pfnGetDeviceProcAddr = vkGetDeviceProcAddr;
1461 pVersionStruct->pfnGetPhysicalDeviceProcAddr = vk_layerGetPhysicalDeviceProcAddr;
1462 }
1463
1464 if (pVersionStruct->loaderLayerInterfaceVersion < CURRENT_LOADER_LAYER_INTERFACE_VERSION) {
1465 image::loader_layer_if_version = pVersionStruct->loaderLayerInterfaceVersion;
1466 } else if (pVersionStruct->loaderLayerInterfaceVersion > CURRENT_LOADER_LAYER_INTERFACE_VERSION) {
1467 pVersionStruct->loaderLayerInterfaceVersion = CURRENT_LOADER_LAYER_INTERFACE_VERSION;
1468 }
1469
1470 return VK_SUCCESS;
1471}