blob: ddc07382de455462afd92436af2fd385b2b39ca3 [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()
Mark Lobodzinski64318ba2017-01-26 13:34:13 -070071 : report_data(nullptr),
72 device_dispatch_table(nullptr),
73 instance_dispatch_table(nullptr),
74 physicalDevice(0),
Jon Ashburn5484e0c2016-03-08 17:48:44 -070075 physicalDeviceProperties(){};
Cody Northrop55443ef2015-09-28 15:09:32 -060076};
Jeremy Hayes9cc31582015-06-18 10:12:39 -060077
Mark Young39389872017-01-19 21:10:49 -070078static uint32_t loader_layer_if_version = CURRENT_LOADER_LAYER_INTERFACE_VERSION;
79
Jon Ashburn5484e0c2016-03-08 17:48:44 -070080static unordered_map<void *, layer_data *> layer_data_map;
Jeremy Hayese0ed6a22016-04-08 09:53:54 -060081static std::mutex global_lock;
Jeremy Hayes9cc31582015-06-18 10:12:39 -060082
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -060083static void init_image(layer_data *my_data, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -060084 layer_debug_actions(my_data->report_data, my_data->logging_callback, pAllocator, "lunarg_image");
Jeremy Hayes9cc31582015-06-18 10:12:39 -060085}
86
Tobin Ehlisf4d352b2016-05-19 09:59:30 -060087static IMAGE_STATE const *getImageState(layer_data const *dev_data, VkImage image) {
88 auto it = dev_data->imageMap.find(image);
89 if (it == dev_data->imageMap.end()) {
90 return nullptr;
91 }
92 return &it->second;
93}
94
Mark Lobodzinski729a8d32017-01-26 12:16:30 -070095VKAPI_ATTR VkResult VKAPI_CALL CreateDebugReportCallbackEXT(VkInstance instance,
96 const VkDebugReportCallbackCreateInfoEXT *pCreateInfo,
97 const VkAllocationCallbacks *pAllocator,
98 VkDebugReportCallbackEXT *pMsgCallback) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -070099 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
100 VkResult res = my_data->instance_dispatch_table->CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600101 if (res == VK_SUCCESS) {
Mark Lobodzinski97c4d512016-05-19 15:27:18 -0600102 res = layer_create_msg_callback(my_data->report_data, false, pCreateInfo, pAllocator, pMsgCallback);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600103 }
104 return res;
105}
106
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700107VKAPI_ATTR void VKAPI_CALL DestroyDebugReportCallbackEXT(VkInstance instance, VkDebugReportCallbackEXT msgCallback,
Chia-I Wu4935c762016-04-28 14:01:30 +0800108 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700109 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
110 my_data->instance_dispatch_table->DestroyDebugReportCallbackEXT(instance, msgCallback, pAllocator);
Courtney Goeltzenleuchter05854bf2015-11-30 12:13:14 -0700111 layer_destroy_msg_callback(my_data->report_data, msgCallback, pAllocator);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600112}
113
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700114VKAPI_ATTR void VKAPI_CALL DebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags,
115 VkDebugReportObjectTypeEXT objType, uint64_t object, size_t location,
116 int32_t msgCode, const char *pLayerPrefix, const char *pMsg) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700117 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700118 my_data->instance_dispatch_table->DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix,
119 pMsg);
Courtney Goeltzenleuchterf0de7242015-12-01 14:10:55 -0700120}
121
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700122VKAPI_ATTR VkResult VKAPI_CALL CreateInstance(const VkInstanceCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
123 VkInstance *pInstance) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700124 VkLayerInstanceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600125
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700126 assert(chain_info->u.pLayerInfo);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700127 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700128 PFN_vkCreateInstance fpCreateInstance = (PFN_vkCreateInstance)fpGetInstanceProcAddr(NULL, "vkCreateInstance");
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700129 if (fpCreateInstance == NULL) {
130 return VK_ERROR_INITIALIZATION_FAILED;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600131 }
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700132
133 // Advance the link info for the next element on the chain
134 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
135
136 VkResult result = fpCreateInstance(pCreateInfo, pAllocator, pInstance);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700137 if (result != VK_SUCCESS) return result;
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700138
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700139 layer_data *my_data = get_my_data_ptr(get_dispatch_key(*pInstance), layer_data_map);
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800140 my_data->instance = *pInstance;
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700141 my_data->instance_dispatch_table = new VkLayerInstanceDispatchTable;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700142 layer_init_instance_dispatch_table(*pInstance, my_data->instance_dispatch_table, fpGetInstanceProcAddr);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700143 my_data->report_data = debug_report_create_instance(my_data->instance_dispatch_table, *pInstance,
144 pCreateInfo->enabledExtensionCount, pCreateInfo->ppEnabledExtensionNames);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700145
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -0600146 init_image(my_data, pAllocator);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700147
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600148 return result;
149}
150
Chia-I Wu4935c762016-04-28 14:01:30 +0800151VKAPI_ATTR void VKAPI_CALL DestroyInstance(VkInstance instance, const VkAllocationCallbacks *pAllocator) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600152 // Grab the key before the instance is destroyed.
153 dispatch_key key = get_dispatch_key(instance);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600154 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
155 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
Chia-I Wuf7458c52015-10-26 21:10:41 +0800156 pTable->DestroyInstance(instance, pAllocator);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600157
158 // Clean up logging callback, if any
Courtney Goeltzenleuchterffcdd8b2015-10-05 15:59:11 -0600159 while (my_data->logging_callback.size() > 0) {
Courtney Goeltzenleuchter7415d5a2015-12-09 15:48:16 -0700160 VkDebugReportCallbackEXT callback = my_data->logging_callback.back();
Courtney Goeltzenleuchter05854bf2015-11-30 12:13:14 -0700161 layer_destroy_msg_callback(my_data->report_data, callback, pAllocator);
Courtney Goeltzenleuchterffcdd8b2015-10-05 15:59:11 -0600162 my_data->logging_callback.pop_back();
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600163 }
164
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600165 layer_debug_report_destroy_instance(my_data->report_data);
166 delete my_data->instance_dispatch_table;
167 layer_data_map.erase(key);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600168}
169
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700170VKAPI_ATTR VkResult VKAPI_CALL CreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo *pCreateInfo,
Chia-I Wu4935c762016-04-28 14:01:30 +0800171 const VkAllocationCallbacks *pAllocator, VkDevice *pDevice) {
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800172 layer_data *my_instance_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700173 VkLayerDeviceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700174
175 assert(chain_info->u.pLayerInfo);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700176 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
177 PFN_vkGetDeviceProcAddr fpGetDeviceProcAddr = chain_info->u.pLayerInfo->pfnNextGetDeviceProcAddr;
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800178 PFN_vkCreateDevice fpCreateDevice = (PFN_vkCreateDevice)fpGetInstanceProcAddr(my_instance_data->instance, "vkCreateDevice");
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700179 if (fpCreateDevice == NULL) {
180 return VK_ERROR_INITIALIZATION_FAILED;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600181 }
182
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700183 // Advance the link info for the next element on the chain
184 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
185
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700186 VkResult result = fpCreateDevice(physicalDevice, pCreateInfo, pAllocator, pDevice);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700187 if (result != VK_SUCCESS) {
188 return result;
189 }
190
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700191 layer_data *my_device_data = get_my_data_ptr(get_dispatch_key(*pDevice), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700192
193 // Setup device dispatch table
194 my_device_data->device_dispatch_table = new VkLayerDispatchTable;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700195 layer_init_device_dispatch_table(*pDevice, my_device_data->device_dispatch_table, fpGetDeviceProcAddr);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700196
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700197 my_device_data->report_data = layer_debug_report_create_device(my_instance_data->report_data, *pDevice);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700198 my_device_data->physicalDevice = physicalDevice;
199
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700200 my_instance_data->instance_dispatch_table->GetPhysicalDeviceProperties(physicalDevice,
201 &(my_device_data->physicalDeviceProperties));
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700202
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600203 return result;
204}
205
Chia-I Wu4935c762016-04-28 14:01:30 +0800206VKAPI_ATTR void VKAPI_CALL DestroyDevice(VkDevice device, const VkAllocationCallbacks *pAllocator) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600207 dispatch_key key = get_dispatch_key(device);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600208 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
Chia-I Wuf7458c52015-10-26 21:10:41 +0800209 my_data->device_dispatch_table->DestroyDevice(device, pAllocator);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600210 delete my_data->device_dispatch_table;
211 layer_data_map.erase(key);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600212}
213
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700214static const VkExtensionProperties instance_extensions[] = {{VK_EXT_DEBUG_REPORT_EXTENSION_NAME, VK_EXT_DEBUG_REPORT_SPEC_VERSION}};
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600215
Chia-I Wu740891e2016-04-28 14:12:27 +0800216static const VkLayerProperties global_layer = {
Jon Ashburndc9111c2016-03-22 12:57:13 -0600217 "VK_LAYER_LUNARG_image", VK_LAYER_API_VERSION, 1, "LunarG Validation Layer",
Chia-I Wu740891e2016-04-28 14:12:27 +0800218};
Courtney Goeltzenleuchter52857662015-12-01 14:08:28 -0700219
Mark Lobodzinski2fd634c2015-07-29 09:21:22 -0600220// Start of the Image layer proper
221
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600222VKAPI_ATTR VkResult VKAPI_CALL CreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
223 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
224 bool skip_call = false;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700225 VkResult result = VK_ERROR_VALIDATION_FAILED_EXT;
Michael Lentine0a369f62016-02-03 16:51:46 -0600226 VkImageFormatProperties ImageFormatProperties;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700227
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700228 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
229 VkPhysicalDevice physicalDevice = device_data->physicalDevice;
230 layer_data *phy_dev_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700231
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700232 if (pCreateInfo->format != VK_FORMAT_UNDEFINED) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600233 VkFormatProperties properties;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700234 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceFormatProperties(device_data->physicalDevice, pCreateInfo->format,
235 &properties);
Dave Houlton34df4cb2016-12-01 16:43:06 -0700236 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties.linearTilingFeatures == 0)) {
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600237 std::stringstream ss;
238 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600239 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 -0700240 0, __LINE__, VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(),
241 validation_error_map[VALIDATION_ERROR_02150]);
242 }
243
244 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties.optimalTilingFeatures == 0)) {
245 std::stringstream ss;
246 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
247 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
248 0, __LINE__, VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(),
249 validation_error_map[VALIDATION_ERROR_02155]);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600250 }
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600251
252 // Validate that format supports usage as color attachment
253 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
254 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
255 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
256 std::stringstream ss;
257 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
258 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700259 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
260 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02158, "IMAGE",
261 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02158]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600262 }
263 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
264 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
265 std::stringstream ss;
266 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
267 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700268 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
269 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02153, "IMAGE",
270 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02153]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600271 }
272 }
273 // Validate that format supports usage as depth/stencil attachment
274 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
275 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
276 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
277 std::stringstream ss;
278 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
279 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700280 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
281 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02159, "IMAGE",
282 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02159]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600283 }
284 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
285 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
286 std::stringstream ss;
287 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
288 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700289 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
290 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02154, "IMAGE",
291 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02154]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600292 }
293 }
294 } else {
295 skip_call |=
296 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 -0700297 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
298 validation_error_map[VALIDATION_ERROR_00715]);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600299 }
300
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700301 // Internal call to get format info. Still goes through layers, could potentially go directly to ICD.
302 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceImageFormatProperties(
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700303 physicalDevice, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
304 &ImageFormatProperties);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600305
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700306 VkDeviceSize imageGranularity = device_data->physicalDeviceProperties.limits.bufferImageGranularity;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700307 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
308
Mark Youngc48c4c12016-04-11 14:26:49 -0600309 // Make sure all required dimension are non-zero at least.
310 bool failedMinSize = false;
311 switch (pCreateInfo->imageType) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700312 case VK_IMAGE_TYPE_3D:
313 if (pCreateInfo->extent.depth == 0) {
314 failedMinSize = true;
315 }
316 // Intentional fall-through
317 case VK_IMAGE_TYPE_2D:
318 if (pCreateInfo->extent.height == 0) {
319 failedMinSize = true;
320 }
321 // Intentional fall-through
322 case VK_IMAGE_TYPE_1D:
323 if (pCreateInfo->extent.width == 0) {
324 failedMinSize = true;
325 }
326 break;
327 default:
328 break;
Mark Youngc48c4c12016-04-11 14:26:49 -0600329 }
Dave Houlton34df4cb2016-12-01 16:43:06 -0700330 // TODO: VALIDATION_ERROR_00716
331 // 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 -0600332 if (failedMinSize) {
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600333 skip_call |=
Dave Houlton34df4cb2016-12-01 16:43:06 -0700334 log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
335 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
Mark Youngc48c4c12016-04-11 14:26:49 -0600336 "CreateImage extents is 0 for at least one required dimension for image of type %d: "
337 "Width = %d Height = %d Depth = %d.",
338 pCreateInfo->imageType, pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth);
339 }
340
Dave Houlton34df4cb2016-12-01 16:43:06 -0700341 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
342 // All these extent-related VUs should be checked here
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700343 if ((pCreateInfo->extent.depth > ImageFormatProperties.maxExtent.depth) ||
344 (pCreateInfo->extent.width > ImageFormatProperties.maxExtent.width) ||
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700345 (pCreateInfo->extent.height > ImageFormatProperties.maxExtent.height)) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700346 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
347 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
348 "CreateImage extents exceed allowable limits for format: "
349 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
350 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
351 ImageFormatProperties.maxExtent.width, ImageFormatProperties.maxExtent.height,
352 ImageFormatProperties.maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700353 }
354
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700355 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
356 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
357 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
358 (uint64_t)imageGranularity) &
359 ~(uint64_t)imageGranularity;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700360
361 if (totalSize > ImageFormatProperties.maxResourceSize) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700362 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
363 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
364 "CreateImage resource size exceeds allowable maximum "
365 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
366 totalSize, ImageFormatProperties.maxResourceSize);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700367 }
368
Dave Houlton34df4cb2016-12-01 16:43:06 -0700369 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700370 if (pCreateInfo->mipLevels > ImageFormatProperties.maxMipLevels) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700371 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
372 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
373 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
374 ImageFormatProperties.maxMipLevels);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700375 }
376
377 if (pCreateInfo->arrayLayers > ImageFormatProperties.maxArrayLayers) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700378 skip_call |= log_msg(
379 phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
380 VALIDATION_ERROR_02133, "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s",
381 pCreateInfo->arrayLayers, ImageFormatProperties.maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700382 }
383
384 if ((pCreateInfo->samples & ImageFormatProperties.sampleCounts) == 0) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700385 skip_call |=
386 log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
387 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
388 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties.sampleCounts,
389 validation_error_map[VALIDATION_ERROR_02138]);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700390 }
391
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700392 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700393 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
394 __LINE__, VALIDATION_ERROR_00731, "Image",
395 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
396 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
397 validation_error_map[VALIDATION_ERROR_00731]);
Jeremy Hayesffc8a702016-03-01 14:01:45 -0700398 }
399
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600400 if (!skip_call) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700401 result = device_data->device_dispatch_table->CreateImage(device, pCreateInfo, pAllocator, pImage);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700402 }
403 if (result == VK_SUCCESS) {
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600404 std::lock_guard<std::mutex> lock(global_lock);
Chia-I Wue2fc5522015-10-26 20:04:44 +0800405 device_data->imageMap[*pImage] = IMAGE_STATE(pCreateInfo);
Tobin Ehlisad8c4462015-09-21 15:20:28 -0600406 }
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600407 return result;
408}
409
Chia-I Wu4935c762016-04-28 14:01:30 +0800410VKAPI_ATTR void VKAPI_CALL DestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700411 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600412 std::unique_lock<std::mutex> lock(global_lock);
Chia-I Wue2fc5522015-10-26 20:04:44 +0800413 device_data->imageMap.erase(image);
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600414 lock.unlock();
Chia-I Wuf7458c52015-10-26 21:10:41 +0800415 device_data->device_dispatch_table->DestroyImage(device, image, pAllocator);
Tobin Ehlisad8c4462015-09-21 15:20:28 -0600416}
417
Chia-I Wu4935c762016-04-28 14:01:30 +0800418VKAPI_ATTR VkResult VKAPI_CALL CreateRenderPass(VkDevice device, const VkRenderPassCreateInfo *pCreateInfo,
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600419 const VkAllocationCallbacks *pAllocator, VkRenderPass *pRenderPass) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700420 layer_data *my_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600421 bool skip_call = false;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600422
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700423 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
Mark Lobodzinski27ced8b2016-08-05 11:30:15 -0600424 if (pCreateInfo->pAttachments[i].format == VK_FORMAT_UNDEFINED) {
425 std::stringstream ss;
426 ss << "vkCreateRenderPass: pCreateInfo->pAttachments[" << i << "].format is VK_FORMAT_UNDEFINED";
427 skip_call |= log_msg(my_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
428 IMAGE_RENDERPASS_INVALID_ATTACHMENT, "IMAGE", "%s", ss.str().c_str());
429 }
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600430 }
431
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600432 if (skip_call) {
Courtney Goeltzenleuchter52fee652015-12-10 16:41:22 -0700433 return VK_ERROR_VALIDATION_FAILED_EXT;
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600434 }
Mark Lobodzinski2fd634c2015-07-29 09:21:22 -0600435
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700436 VkResult result = my_data->device_dispatch_table->CreateRenderPass(device, pCreateInfo, pAllocator, pRenderPass);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600437
438 return result;
439}
440
Dave Houlton34df4cb2016-12-01 16:43:06 -0700441VKAPI_ATTR void VKAPI_CALL CmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
442 const VkClearColorValue *pColor, uint32_t rangeCount,
443 const VkImageSubresourceRange *pRanges) {
Dustin Graves080069b2016-04-05 13:48:15 -0600444 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700445 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Jeremy Hayesa4dc0ac2016-03-01 16:51:02 -0700446
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600447 // For each range, image aspect must be color only
Dave Houlton34df4cb2016-12-01 16:43:06 -0700448 // TODO: this is a 'must' in the spec, so there should be a VU enum for it
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600449 for (uint32_t i = 0; i < rangeCount; i++) {
450 if (pRanges[i].aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700451 char const str[] =
452 "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
453 skipCall |=
454 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
455 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600456 }
457 }
458
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600459 auto image_state = getImageState(device_data, image);
460 if (image_state) {
461 if (vk_format_is_depth_or_stencil(image_state->format)) {
462 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
463 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 -0700464 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
465 validation_error_map[VALIDATION_ERROR_01088]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600466 } else if (vk_format_is_compressed(image_state->format)) {
467 char const str[] = "vkCmdClearColorImage called with compressed image.";
468 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 -0700469 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
470 validation_error_map[VALIDATION_ERROR_01088]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600471 }
Tony Barbour26434b92016-06-02 09:43:50 -0600472
473 if (!(image_state->usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
474 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
475 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 -0700476 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
477 validation_error_map[VALIDATION_ERROR_01084]);
Tony Barbour26434b92016-06-02 09:43:50 -0600478 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600479 }
480
Dustin Graves080069b2016-04-05 13:48:15 -0600481 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700482 device_data->device_dispatch_table->CmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600483 }
484}
485
Dave Houlton34df4cb2016-12-01 16:43:06 -0700486VKAPI_ATTR void VKAPI_CALL CmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
487 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
488 const VkImageSubresourceRange *pRanges) {
Dustin Graves080069b2016-04-05 13:48:15 -0600489 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700490 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600491 // For each range, Image aspect must be depth or stencil or both
492 for (uint32_t i = 0; i < rangeCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700493 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
494 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700495 char const str[] =
496 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
497 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700498 skipCall |=
499 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
500 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600501 }
502 }
503
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600504 auto image_state = getImageState(device_data, image);
505 if (image_state && !vk_format_is_depth_or_stencil(image_state->format)) {
506 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
507 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 -0700508 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
509 validation_error_map[VALIDATION_ERROR_01103]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600510 }
511
Dustin Graves080069b2016-04-05 13:48:15 -0600512 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700513 device_data->device_dispatch_table->CmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount,
514 pRanges);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600515 }
516}
517
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600518// Returns true if [x, xoffset] and [y, yoffset] overlap
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600519static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600520 bool result = false;
521 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
522 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
523
524 if (intersection_max > intersection_min) {
525 result = true;
526 }
527 return result;
528}
529
530// Returns true if two VkImageCopy structures overlap
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600531static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
Alex Smith7b567442017-01-17 11:13:23 +0000532 bool result = false;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600533 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600534 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
535 dst->dstSubresource.layerCount))) {
Alex Smith7b567442017-01-17 11:13:23 +0000536 result = true;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600537 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700538 case VK_IMAGE_TYPE_3D:
539 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
540 // Intentionally fall through to 2D case
541 case VK_IMAGE_TYPE_2D:
542 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
543 // Intentionally fall through to 1D case
544 case VK_IMAGE_TYPE_1D:
545 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
546 break;
547 default:
548 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
549 assert(false);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600550 }
551 }
552 return result;
553}
554
555// Returns true if offset and extent exceed image extents
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600556static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const IMAGE_STATE *image) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600557 bool result = false;
558 // Extents/depths cannot be negative but checks left in for clarity
Mark Lobodzinski39573d22016-10-14 10:59:27 -0600559 switch (image->imageType) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700560 case VK_IMAGE_TYPE_3D: // Validate z and depth
561 if ((offset->z + extent->depth > image->extent.depth) || (offset->z < 0) ||
562 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
563 result = true;
564 }
565 // Intentionally fall through to 2D case to check height
566 case VK_IMAGE_TYPE_2D: // Validate y and height
567 if ((offset->y + extent->height > image->extent.height) || (offset->y < 0) ||
568 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
569 result = true;
570 }
571 // Intentionally fall through to 1D case to check width
572 case VK_IMAGE_TYPE_1D: // Validate x and width
573 if ((offset->x + extent->width > image->extent.width) || (offset->x < 0) ||
574 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
575 result = true;
576 }
577 break;
578 default:
579 assert(false);
Mark Lobodzinski39573d22016-10-14 10:59:27 -0600580 }
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600581 return result;
582}
583
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600584bool PreCallValidateCmdCopyImage(VkCommandBuffer command_buffer, VkImage src_image, VkImage dst_image, uint32_t region_count,
585 const VkImageCopy *regions) {
586 bool skip = false;
587 layer_data *device_data = get_my_data_ptr(get_dispatch_key(command_buffer), layer_data_map);
588 auto src_image_entry = getImageState(device_data, src_image);
589 auto dst_image_entry = getImageState(device_data, dst_image);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600590
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600591 // TODO: This does not cover swapchain-created images. This should fall out when this layer is moved
592 // into the core_validation layer
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600593 if (src_image_entry && dst_image_entry) {
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600594 for (uint32_t i = 0; i < region_count; i++) {
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
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700771VKAPI_ATTR void VKAPI_CALL CmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
772 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Chia-I Wu4935c762016-04-28 14:01:30 +0800773 const VkImageCopy *pRegions) {
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600774 bool skip = false;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600775 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
776
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600777 skip = PreCallValidateCmdCopyImage(commandBuffer, srcImage, dstImage, regionCount, pRegions);
Mike Stroyana3082432015-09-25 13:39:21 -0600778
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600779 if (!skip) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700780 device_data->device_dispatch_table->CmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
781 regionCount, pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600782 }
783}
784
Chia-I Wu4935c762016-04-28 14:01:30 +0800785VKAPI_ATTR void VKAPI_CALL CmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
786 const VkClearAttachment *pAttachments, uint32_t rectCount,
787 const VkClearRect *pRects) {
Dustin Graves080069b2016-04-05 13:48:15 -0600788 bool skipCall = false;
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600789 VkImageAspectFlags aspectMask;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700790 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600791 for (uint32_t i = 0; i < attachmentCount; i++) {
792 aspectMask = pAttachments[i].aspectMask;
Dave Houlton34df4cb2016-12-01 16:43:06 -0700793 if (0 == aspectMask) {
794 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
795 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
796 VALIDATION_ERROR_01128, "IMAGE", "%s", validation_error_map[VALIDATION_ERROR_01128]);
797 } else if (aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
798 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
799 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
800 VALIDATION_ERROR_01126, "IMAGE", "%s", validation_error_map[VALIDATION_ERROR_01126]);
801 } else if (aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
802 if ((aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) || (aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700803 char const str[] =
Dave Houlton34df4cb2016-12-01 16:43:06 -0700804 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
805 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
806 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
807 VALIDATION_ERROR_01125, "IMAGE", str, i, validation_error_map[VALIDATION_ERROR_01125]);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600808 }
809 } else {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700810 // Having eliminated all other possibilities, image aspect must be depth or stencil or both
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700811 if (((aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
812 ((aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700813 char const str[] =
814 "vkCmdClearAttachments aspectMask [%d] must be set to VK_IMAGE_ASPECT_DEPTH_BIT and/or "
815 "VK_IMAGE_ASPECT_STENCIL_BIT. %s";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700816 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
817 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
818 VALIDATION_ERROR_01127, "IMAGE", str, i, validation_error_map[VALIDATION_ERROR_01127]);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600819 }
820 }
821 }
822
Dustin Graves080069b2016-04-05 13:48:15 -0600823 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700824 device_data->device_dispatch_table->CmdClearAttachments(commandBuffer, attachmentCount, pAttachments, rectCount, pRects);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600825 }
826}
827
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700828static bool ValidateBufferImageCopyData(layer_data *dev_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
829 VkImage image, const char *function) {
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600830 bool skip = false;
831
832 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600833 auto image_info = getImageState(dev_data, image);
834 if (image_info) {
Mark Lobodzinski1bda8892016-11-22 14:46:39 -0700835 if ((image_info->imageType == VK_IMAGE_TYPE_1D) || (image_info->imageType == VK_IMAGE_TYPE_2D)) {
836 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
837 skip |= log_msg(dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
838 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01269, "IMAGE",
839 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. These must be 0 and 1, "
840 "respectively. %s",
841 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
842 validation_error_map[VALIDATION_ERROR_01269]);
843 }
844 }
845
Marcin Kantoch2a00b312017-01-27 12:33:21 +0100846 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
847 // then bufferOffset must be a multiple of the calling command's VkImage parameter's texel size
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600848 auto texel_size = vk_format_get_size(image_info->format);
Marcin Kantoch2a00b312017-01-27 12:33:21 +0100849 if (!vk_format_is_depth_and_stencil(image_info->format) && vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600850 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 -0700851 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600852 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700853 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
854 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600855 }
Mark Lobodzinski1bda8892016-11-22 14:46:39 -0700856
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600857 // BufferOffset must be a multiple of 4
858 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
859 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 -0700860 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
861 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
862 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600863 }
864
865 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
866 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
867 skip |= log_msg(
868 dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700869 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
870 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
871 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
872 validation_error_map[VALIDATION_ERROR_01265]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600873 }
874
875 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
876 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
877 skip |= log_msg(
878 dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700879 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
880 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
881 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
882 validation_error_map[VALIDATION_ERROR_01266]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600883 }
Mark Lobodzinski040142c2016-11-22 11:18:46 -0700884
885 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700886 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
Mark Lobodzinski040142c2016-11-22 11:18:46 -0700887 if (aspect_mask_bits.count() != 1) {
888 skip |=
889 log_msg(dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
890 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
891 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
892 validation_error_map[VALIDATION_ERROR_01280]);
893 }
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600894 }
895 }
896
897 return skip;
898}
899
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700900static bool PreCallValidateCmdCopyImageToBuffer(layer_data *dev_data, VkImage srcImage, uint32_t regionCount,
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700901 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700902 return ValidateBufferImageCopyData(dev_data, regionCount, pRegions, srcImage, "vkCmdCopyImageToBuffer");
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700903}
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600904
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700905VKAPI_ATTR void VKAPI_CALL CmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
906 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
907 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
908
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700909 if (!PreCallValidateCmdCopyImageToBuffer(device_data, srcImage, regionCount, pRegions, "vkCmdCopyImageToBuffer()")) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700910 device_data->device_dispatch_table->CmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount,
911 pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600912 }
913}
914
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700915static bool PreCallValidateCmdCopyBufferToImage(layer_data *dev_data, VkImage dstImage, uint32_t regionCount,
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700916 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700917 return ValidateBufferImageCopyData(dev_data, regionCount, pRegions, dstImage, "vkCmdCopyBufferToImage");
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700918}
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600919
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700920VKAPI_ATTR void VKAPI_CALL CmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
921 VkImageLayout dstImageLayout, uint32_t regionCount,
922 const VkBufferImageCopy *pRegions) {
923 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
924
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700925 if (!PreCallValidateCmdCopyBufferToImage(device_data, dstImage, regionCount, pRegions, "vkCmdCopyBufferToImage()")) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700926 device_data->device_dispatch_table->CmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount,
927 pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600928 }
929}
930
Dave Houlton34df4cb2016-12-01 16:43:06 -0700931VKAPI_ATTR void VKAPI_CALL CmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
932 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
933 const VkImageBlit *pRegions, VkFilter filter) {
Dustin Graves080069b2016-04-05 13:48:15 -0600934 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700935 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600936
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600937 // Warn for zero-sized regions
938 for (uint32_t i = 0; i < regionCount; i++) {
939 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
940 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
941 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
942 std::stringstream ss;
943 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
944 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700945 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(commandBuffer), __LINE__,
946 IMAGE_INVALID_EXTENTS, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600947 }
948 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
949 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
950 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
951 std::stringstream ss;
952 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
953 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700954 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(commandBuffer), __LINE__,
955 IMAGE_INVALID_EXTENTS, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600956 }
957 }
958
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600959 auto srcImageEntry = getImageState(device_data, srcImage);
960 auto dstImageEntry = getImageState(device_data, dstImage);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600961
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600962 if (srcImageEntry && dstImageEntry) {
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600963 VkFormat srcFormat = srcImageEntry->format;
964 VkFormat dstFormat = dstImageEntry->format;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600965
Dave Houlton34df4cb2016-12-01 16:43:06 -0700966 // Validate consistency for unsigned formats
967 if (vk_format_is_uint(srcFormat) != vk_format_is_uint(dstFormat)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600968 std::stringstream ss;
Dave Houlton34df4cb2016-12-01 16:43:06 -0700969 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
970 << "the other one must also have unsigned integer format. "
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700971 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700972 skipCall |=
973 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 -0700974 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s", ss.str().c_str(),
975 validation_error_map[VALIDATION_ERROR_02191]);
976 }
977
978 // Validate consistency for signed formats
979 if (vk_format_is_sint(srcFormat) != vk_format_is_sint(dstFormat)) {
980 std::stringstream ss;
981 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
982 << "the other one must also have signed integer format. "
983 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
984 skipCall |=
985 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
986 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s", ss.str().c_str(),
987 validation_error_map[VALIDATION_ERROR_02190]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600988 }
989
990 // Validate aspect bits and formats for depth/stencil images
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700991 if (vk_format_is_depth_or_stencil(srcFormat) || vk_format_is_depth_or_stencil(dstFormat)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600992 if (srcFormat != dstFormat) {
993 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700994 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
995 << "stencil, the other one must have exactly the same format. "
996 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700997 skipCall |=
998 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 -0700999 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02192, "IMAGE", "%s. %s", ss.str().c_str(),
1000 validation_error_map[VALIDATION_ERROR_02192]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001001 }
1002
Dave Houlton34df4cb2016-12-01 16:43:06 -07001003 // TODO: Confirm that all these checks are intended to be nested under depth/stencil only
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001004 for (uint32_t i = 0; i < regionCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001005 if (pRegions[i].srcSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001006 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1007 // 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 -07001008 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1009 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1010 IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001011 }
1012
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001013 if (pRegions[i].dstSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001014 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1015 // 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 -07001016 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1017 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1018 IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001019 }
1020
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001021 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001022 char const str[] = "vkCmdBlitImage: number of layers in source and destination subresources must match";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001023 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1024 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1025 IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001026 }
1027
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001028 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
1029 VkImageAspectFlags dstAspect = pRegions[i].dstSubresource.aspectMask;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001030
1031 if (srcAspect != dstAspect) {
1032 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001033 ss << "vkCmdBlitImage: Image aspects of depth/stencil images should match";
1034 // 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 -07001035 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1036 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1037 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001038 }
1039 if (vk_format_is_depth_and_stencil(srcFormat)) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001040 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001041 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001042 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1043 "VK_IMAGE_ASPECT_DEPTH_BIT "
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001044 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001045 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1046 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1047 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001048 }
1049 } else if (vk_format_is_stencil_only(srcFormat)) {
1050 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1051 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001052 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
Chia-I Wu3432a0c2015-10-27 18:04:07 +08001053 << "set in both the srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001054 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1055 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1056 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001057 }
1058 } else if (vk_format_is_depth_only(srcFormat)) {
1059 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1060 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001061 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
Chia-I Wu3432a0c2015-10-27 18:04:07 +08001062 << "set in both the srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001063 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1064 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1065 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001066 }
1067 }
1068 }
1069 }
1070
1071 // Validate filter
Dave Houlton34df4cb2016-12-01 16:43:06 -07001072 if (vk_format_is_depth_or_stencil(srcFormat) && (filter != VK_FILTER_NEAREST)) {
1073 std::stringstream ss;
1074 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1075 << "then filter must be VK_FILTER_NEAREST.";
1076 skipCall |=
1077 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1078 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s", ss.str().c_str(),
1079 validation_error_map[VALIDATION_ERROR_02193]);
1080 }
1081 if (vk_format_is_int(srcFormat) && (filter != VK_FILTER_NEAREST)) {
1082 std::stringstream ss;
1083 ss << "vkCmdBlitImage: If the format of srcImage is an integer-based format "
1084 << "then filter must be VK_FILTER_NEAREST.";
1085 skipCall |=
1086 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1087 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_FILTER, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001088 }
1089 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001090
Tony Barbourf8309102016-05-05 10:50:21 -06001091 if (!skipCall) {
Dave Houlton34df4cb2016-12-01 16:43:06 -07001092 device_data->device_dispatch_table->CmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
1093 regionCount, pRegions, filter);
Tony Barbourf8309102016-05-05 10:50:21 -06001094 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001095}
1096
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001097VKAPI_ATTR void VKAPI_CALL CmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
1098 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
1099 uint32_t memoryBarrierCount, const VkMemoryBarrier *pMemoryBarriers,
1100 uint32_t bufferMemoryBarrierCount, const VkBufferMemoryBarrier *pBufferMemoryBarriers,
1101 uint32_t imageMemoryBarrierCount, const VkImageMemoryBarrier *pImageMemoryBarriers) {
Dustin Graves080069b2016-04-05 13:48:15 -06001102 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001103 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Jeremy Hayes01b38892015-11-17 18:19:55 -07001104
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001105 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
1106 VkImageMemoryBarrier const *const barrier = (VkImageMemoryBarrier const *const) & pImageMemoryBarriers[i];
Dave Houlton34df4cb2016-12-01 16:43:06 -07001107 // TODO: add VALIDATION_ERROR_00309 (sType == VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER) here
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001108 if (barrier->sType == VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER) {
Dave Houlton34df4cb2016-12-01 16:43:06 -07001109 // TODO: this check should include VALIDATION_ERROR_00301 and VALIDATION_ERROR_00316
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001110 if (barrier->subresourceRange.layerCount == 0) {
Jeremy Hayes01b38892015-11-17 18:19:55 -07001111 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001112 ss << "vkCmdPipelineBarrier called with 0 in ppMemoryBarriers[" << i << "]->subresourceRange.layerCount.";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001113 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
1114 __LINE__, IMAGE_INVALID_IMAGE_RESOURCE, "IMAGE", "%s", ss.str().c_str());
Jeremy Hayes01b38892015-11-17 18:19:55 -07001115 }
1116 }
1117 }
1118
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001119 if (skipCall) {
Jeremy Hayes01b38892015-11-17 18:19:55 -07001120 return;
1121 }
1122
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001123 device_data->device_dispatch_table->CmdPipelineBarrier(commandBuffer, srcStageMask, dstStageMask, dependencyFlags,
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001124 memoryBarrierCount, pMemoryBarriers, bufferMemoryBarrierCount,
1125 pBufferMemoryBarriers, imageMemoryBarrierCount, pImageMemoryBarriers);
Jeremy Hayes01b38892015-11-17 18:19:55 -07001126}
1127
Dave Houlton34df4cb2016-12-01 16:43:06 -07001128VKAPI_ATTR void VKAPI_CALL CmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
1129 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
1130 const VkImageResolve *pRegions) {
Dustin Graves080069b2016-04-05 13:48:15 -06001131 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001132 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001133 auto srcImageEntry = getImageState(device_data, srcImage);
1134 auto dstImageEntry = getImageState(device_data, dstImage);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001135
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001136 // For each region, the number of layers in the image subresource should not be zero
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001137 // For each region, src and dest image aspect must be color only
1138 for (uint32_t i = 0; i < regionCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001139 if (pRegions[i].srcSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001140 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
1141 // 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 -07001142 skipCall |=
1143 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1144 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001145 }
1146
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001147 if (pRegions[i].dstSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001148 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Courtney Goeltzenleuchter7415d5a2015-12-09 15:48:16 -07001149
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001150 // 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 -07001151 skipCall |=
1152 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1153 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001154 }
1155
Dave Houlton34df4cb2016-12-01 16:43:06 -07001156 // TODO: VALIDATION_ERROR_01339
1157
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001158 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001159 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001160 char const str[] =
1161 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001162 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1163 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1164 VALIDATION_ERROR_01338, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001165 }
1166 }
1167
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001168 if (srcImageEntry && dstImageEntry) {
1169 if (srcImageEntry->format != dstImageEntry->format) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001170 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
1171 skipCall |=
1172 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1173 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mike Stroyana3082432015-09-25 13:39:21 -06001174 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001175 if (srcImageEntry->imageType != dstImageEntry->imageType) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001176 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
1177 skipCall |=
1178 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1179 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mike Stroyana3082432015-09-25 13:39:21 -06001180 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001181 if (srcImageEntry->samples == VK_SAMPLE_COUNT_1_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001182 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001183 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1184 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1185 VALIDATION_ERROR_01320, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01320]);
Mike Stroyana3082432015-09-25 13:39:21 -06001186 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001187 if (dstImageEntry->samples != VK_SAMPLE_COUNT_1_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001188 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001189 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1190 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1191 VALIDATION_ERROR_01321, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01321]);
Mike Stroyana3082432015-09-25 13:39:21 -06001192 }
1193 }
1194
Dustin Graves080069b2016-04-05 13:48:15 -06001195 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001196 device_data->device_dispatch_table->CmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
1197 regionCount, pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001198 }
1199}
1200
Dave Houlton34df4cb2016-12-01 16:43:06 -07001201VKAPI_ATTR void VKAPI_CALL GetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
1202 VkSubresourceLayout *pLayout) {
Dustin Graves080069b2016-04-05 13:48:15 -06001203 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001204 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001205 VkFormat format;
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001206
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001207 auto imageEntry = getImageState(device_data, image);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001208
1209 // Validate that image aspects match formats
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001210 if (imageEntry) {
1211 format = imageEntry->format;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001212 if (vk_format_is_color(format)) {
Chia-I Wu52b07e72015-10-27 19:55:05 +08001213 if (pSubresource->aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001214 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001215 ss << "vkGetImageSubresourceLayout: For color formats, the aspectMask field of VkImageSubresource must be "
1216 "VK_IMAGE_ASPECT_COLOR.";
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001217 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 -07001218 (uint64_t)image, __LINE__, VALIDATION_ERROR_00741, "IMAGE", "%s. %s", ss.str().c_str(),
1219 validation_error_map[VALIDATION_ERROR_00741]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001220 }
1221 } else if (vk_format_is_depth_or_stencil(format)) {
Chia-I Wu52b07e72015-10-27 19:55:05 +08001222 if ((pSubresource->aspectMask != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1223 (pSubresource->aspectMask != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001224 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001225 ss << "vkGetImageSubresourceLayout: For depth/stencil formats, the aspectMask selects either the depth or stencil "
1226 "image aspectMask.";
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001227 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 -07001228 (uint64_t)image, __LINE__, VALIDATION_ERROR_00741, "IMAGE", "%s. %s", ss.str().c_str(),
1229 validation_error_map[VALIDATION_ERROR_00741]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001230 }
1231 }
1232 }
1233
Dustin Graves080069b2016-04-05 13:48:15 -06001234 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001235 device_data->device_dispatch_table->GetImageSubresourceLayout(device, image, pSubresource, pLayout);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001236 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001237}
1238
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001239VKAPI_ATTR void VKAPI_CALL GetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice, VkPhysicalDeviceProperties *pProperties) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001240 layer_data *phy_dev_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
1241 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceProperties(physicalDevice, pProperties);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -07001242}
1243
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001244VKAPI_ATTR VkResult VKAPI_CALL EnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001245 return util_GetLayerProperties(1, &global_layer, pCount, pProperties);
1246}
1247
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001248VKAPI_ATTR VkResult VKAPI_CALL EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount,
1249 VkLayerProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001250 return util_GetLayerProperties(1, &global_layer, pCount, pProperties);
1251}
1252
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001253VKAPI_ATTR VkResult VKAPI_CALL EnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount,
1254 VkExtensionProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001255 if (pLayerName && !strcmp(pLayerName, global_layer.layerName))
1256 return util_GetExtensionProperties(1, instance_extensions, pCount, pProperties);
1257
1258 return VK_ERROR_LAYER_NOT_PRESENT;
1259}
1260
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001261VKAPI_ATTR VkResult VKAPI_CALL EnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, const char *pLayerName,
1262 uint32_t *pCount, VkExtensionProperties *pProperties) {
Chia-I Wueec9a312016-04-28 11:21:49 +08001263 // Image does not have any physical device extensions
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001264 if (pLayerName && !strcmp(pLayerName, global_layer.layerName)) return util_GetExtensionProperties(0, NULL, pCount, pProperties);
Chia-I Wu3f326222016-04-28 14:21:13 +08001265
1266 assert(physicalDevice);
1267
1268 dispatch_key key = get_dispatch_key(physicalDevice);
1269 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
1270 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
1271 return pTable->EnumerateDeviceExtensionProperties(physicalDevice, NULL, pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001272}
1273
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001274static PFN_vkVoidFunction intercept_core_instance_command(const char *name);
1275static PFN_vkVoidFunction intercept_core_device_command(const char *name);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -06001276
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001277VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetDeviceProcAddr(VkDevice device, const char *funcName) {
1278 PFN_vkVoidFunction proc = intercept_core_device_command(funcName);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001279 if (proc) return proc;
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001280
1281 assert(device);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001282
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001283 layer_data *my_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001284
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001285 VkLayerDispatchTable *pTable = my_data->device_dispatch_table;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001286 {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001287 if (pTable->GetDeviceProcAddr == NULL) return NULL;
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -06001288 return pTable->GetDeviceProcAddr(device, funcName);
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001289 }
1290}
1291
Chia-I Wu4935c762016-04-28 14:01:30 +08001292VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetInstanceProcAddr(VkInstance instance, const char *funcName) {
Chia-I Wu428eba02016-04-28 14:38:57 +08001293 PFN_vkVoidFunction proc = intercept_core_instance_command(funcName);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001294 if (!proc) proc = intercept_core_device_command(funcName);
1295 if (proc) return proc;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001296
Chia-I Wuf89922c2016-04-28 15:16:59 +08001297 assert(instance);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001298 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001299
Chia-I Wuf89922c2016-04-28 15:16:59 +08001300 proc = debug_report_get_instance_proc_addr(my_data->report_data, funcName);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001301 if (proc) return proc;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001302
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001303 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001304 if (pTable->GetInstanceProcAddr == NULL) return NULL;
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001305 return pTable->GetInstanceProcAddr(instance, funcName);
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001306}
Chia-I Wueec9a312016-04-28 11:21:49 +08001307
Mark Young39389872017-01-19 21:10:49 -07001308VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetPhysicalDeviceProcAddr(VkInstance instance, const char *funcName) {
1309 assert(instance);
1310
1311 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
1312
1313 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001314 if (pTable->GetPhysicalDeviceProcAddr == NULL) return NULL;
Mark Young39389872017-01-19 21:10:49 -07001315 return pTable->GetPhysicalDeviceProcAddr(instance, funcName);
1316}
1317
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001318static PFN_vkVoidFunction intercept_core_instance_command(const char *name) {
Chia-I Wu428eba02016-04-28 14:38:57 +08001319 static const struct {
1320 const char *name;
1321 PFN_vkVoidFunction proc;
1322 } core_instance_commands[] = {
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001323 {"vkGetInstanceProcAddr", reinterpret_cast<PFN_vkVoidFunction>(GetInstanceProcAddr)},
1324 {"vkCreateInstance", reinterpret_cast<PFN_vkVoidFunction>(CreateInstance)},
1325 {"vkDestroyInstance", reinterpret_cast<PFN_vkVoidFunction>(DestroyInstance)},
1326 {"vkCreateDevice", reinterpret_cast<PFN_vkVoidFunction>(CreateDevice)},
1327 {"vkEnumerateInstanceLayerProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateInstanceLayerProperties)},
1328 {"vkEnumerateDeviceLayerProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateDeviceLayerProperties)},
1329 {"vkEnumerateInstanceExtensionProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateInstanceExtensionProperties)},
1330 {"vkEnumerateDeviceExtensionProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateDeviceExtensionProperties)},
1331 {"vkGetPhysicalDeviceProperties", reinterpret_cast<PFN_vkVoidFunction>(GetPhysicalDeviceProperties)},
1332 {"vk_layerGetPhysicalDeviceProcAddr", reinterpret_cast<PFN_vkVoidFunction>(GetPhysicalDeviceProcAddr)},
Chia-I Wu428eba02016-04-28 14:38:57 +08001333 };
1334
1335 for (size_t i = 0; i < ARRAY_SIZE(core_instance_commands); i++) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001336 if (!strcmp(core_instance_commands[i].name, name)) return core_instance_commands[i].proc;
Chia-I Wu428eba02016-04-28 14:38:57 +08001337 }
1338
1339 return nullptr;
1340}
1341
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001342static PFN_vkVoidFunction intercept_core_device_command(const char *name) {
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001343 static const struct {
1344 const char *name;
1345 PFN_vkVoidFunction proc;
1346 } core_device_commands[] = {
Tobin Ehlis16239872016-10-26 10:42:49 -06001347 {"vkGetDeviceProcAddr", reinterpret_cast<PFN_vkVoidFunction>(GetDeviceProcAddr)},
1348 {"vkDestroyDevice", reinterpret_cast<PFN_vkVoidFunction>(DestroyDevice)},
1349 {"vkCreateImage", reinterpret_cast<PFN_vkVoidFunction>(CreateImage)},
1350 {"vkDestroyImage", reinterpret_cast<PFN_vkVoidFunction>(DestroyImage)},
1351 {"vkCreateRenderPass", reinterpret_cast<PFN_vkVoidFunction>(CreateRenderPass)},
1352 {"vkCmdClearColorImage", reinterpret_cast<PFN_vkVoidFunction>(CmdClearColorImage)},
1353 {"vkCmdClearDepthStencilImage", reinterpret_cast<PFN_vkVoidFunction>(CmdClearDepthStencilImage)},
1354 {"vkCmdClearAttachments", reinterpret_cast<PFN_vkVoidFunction>(CmdClearAttachments)},
1355 {"vkCmdCopyImage", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyImage)},
1356 {"vkCmdCopyImageToBuffer", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyImageToBuffer)},
1357 {"vkCmdCopyBufferToImage", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyBufferToImage)},
1358 {"vkCmdBlitImage", reinterpret_cast<PFN_vkVoidFunction>(CmdBlitImage)},
1359 {"vkCmdPipelineBarrier", reinterpret_cast<PFN_vkVoidFunction>(CmdPipelineBarrier)},
1360 {"vkCmdResolveImage", reinterpret_cast<PFN_vkVoidFunction>(CmdResolveImage)},
1361 {"vkGetImageSubresourceLayout", reinterpret_cast<PFN_vkVoidFunction>(GetImageSubresourceLayout)},
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001362 };
1363
1364 for (size_t i = 0; i < ARRAY_SIZE(core_device_commands); i++) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001365 if (!strcmp(core_device_commands[i].name, name)) return core_device_commands[i].proc;
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001366 }
1367
1368 return nullptr;
1369}
1370
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001371} // namespace image
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001372
1373// vk_layer_logging.h expects these to be defined
1374
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001375VKAPI_ATTR VkResult VKAPI_CALL vkCreateDebugReportCallbackEXT(VkInstance instance,
1376 const VkDebugReportCallbackCreateInfoEXT *pCreateInfo,
1377 const VkAllocationCallbacks *pAllocator,
1378 VkDebugReportCallbackEXT *pMsgCallback) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001379 return image::CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001380}
1381
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001382VKAPI_ATTR void VKAPI_CALL vkDestroyDebugReportCallbackEXT(VkInstance instance, VkDebugReportCallbackEXT msgCallback,
1383 const VkAllocationCallbacks *pAllocator) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001384 image::DestroyDebugReportCallbackEXT(instance, msgCallback, pAllocator);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001385}
1386
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001387VKAPI_ATTR void VKAPI_CALL vkDebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags,
1388 VkDebugReportObjectTypeEXT objType, uint64_t object, size_t location,
1389 int32_t msgCode, const char *pLayerPrefix, const char *pMsg) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001390 image::DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix, pMsg);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001391}
1392
Chia-I Wub02600c2016-05-20 07:11:22 +08001393// loader-layer interface v0, just wrappers since there is only a layer
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001394
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001395VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount,
1396 VkExtensionProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001397 return image::EnumerateInstanceExtensionProperties(pLayerName, pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001398}
1399
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001400VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceLayerProperties(uint32_t *pCount,
1401 VkLayerProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001402 return image::EnumerateInstanceLayerProperties(pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001403}
1404
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001405VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount,
1406 VkLayerProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001407 // the layer command handles VK_NULL_HANDLE just fine internally
1408 assert(physicalDevice == VK_NULL_HANDLE);
1409 return image::EnumerateDeviceLayerProperties(VK_NULL_HANDLE, pCount, pProperties);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001410}
1411
1412VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice,
1413 const char *pLayerName, uint32_t *pCount,
1414 VkExtensionProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001415 // the layer command handles VK_NULL_HANDLE just fine internally
1416 assert(physicalDevice == VK_NULL_HANDLE);
Chia-I Wu3f326222016-04-28 14:21:13 +08001417 return image::EnumerateDeviceExtensionProperties(VK_NULL_HANDLE, pLayerName, pCount, pProperties);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001418}
1419
1420VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001421 return image::GetDeviceProcAddr(dev, funcName);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001422}
1423
1424VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001425 return image::GetInstanceProcAddr(instance, funcName);
Chia-I Wueec9a312016-04-28 11:21:49 +08001426}
Mark Young39389872017-01-19 21:10:49 -07001427
Mark Lobodzinski729a8d32017-01-26 12:16:30 -07001428VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vk_layerGetPhysicalDeviceProcAddr(VkInstance instance,
1429 const char *funcName) {
Mark Young39389872017-01-19 21:10:49 -07001430 return image::GetPhysicalDeviceProcAddr(instance, funcName);
1431}
1432
1433VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkNegotiateLoaderLayerInterfaceVersion(VkNegotiateLayerInterface *pVersionStruct) {
1434 assert(pVersionStruct != NULL);
1435 assert(pVersionStruct->sType == LAYER_NEGOTIATE_INTERFACE_STRUCT);
1436
1437 // Fill in the function pointers if our version is at least capable of having the structure contain them.
1438 if (pVersionStruct->loaderLayerInterfaceVersion >= 2) {
1439 pVersionStruct->pfnGetInstanceProcAddr = vkGetInstanceProcAddr;
1440 pVersionStruct->pfnGetDeviceProcAddr = vkGetDeviceProcAddr;
1441 pVersionStruct->pfnGetPhysicalDeviceProcAddr = vk_layerGetPhysicalDeviceProcAddr;
1442 }
1443
1444 if (pVersionStruct->loaderLayerInterfaceVersion < CURRENT_LOADER_LAYER_INTERFACE_VERSION) {
1445 image::loader_layer_if_version = pVersionStruct->loaderLayerInterfaceVersion;
1446 } else if (pVersionStruct->loaderLayerInterfaceVersion > CURRENT_LOADER_LAYER_INTERFACE_VERSION) {
1447 pVersionStruct->loaderLayerInterfaceVersion = CURRENT_LOADER_LAYER_INTERFACE_VERSION;
1448 }
1449
1450 return VK_SUCCESS;
1451}