blob: fd4e133874e2df50247c474784aec3779e94d3ef [file] [log] [blame]
Mark Lobodzinski6eda00a2016-02-02 15:55:36 -07001/* Copyright (c) 2015-2016 The Khronos Group Inc.
2 * Copyright (c) 2015-2016 Valve Corporation
3 * Copyright (c) 2015-2016 LunarG, Inc.
4 * Copyright (C) 2015-2016 Google Inc.
Jeremy Hayes9cc31582015-06-18 10:12:39 -06005 *
Jon Ashburn3ebf1252016-04-19 11:30:31 -06006 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
Jeremy Hayes9cc31582015-06-18 10:12:39 -06009 *
Jon Ashburn3ebf1252016-04-19 11:30:31 -060010 * http://www.apache.org/licenses/LICENSE-2.0
Jeremy Hayes9cc31582015-06-18 10:12:39 -060011 *
Jon Ashburn3ebf1252016-04-19 11:30:31 -060012 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
Courtney Goeltzenleuchter05559522015-10-30 11:14:30 -060017 *
18 * Author: Jeremy Hayes <jeremy@lunarg.com>
19 * Author: Mark Lobodzinski <mark@lunarg.com>
20 * Author: Mike Stroyan <mike@LunarG.com>
21 * Author: Tobin Ehlis <tobin@lunarg.com>
Jeremy Hayes9cc31582015-06-18 10:12:39 -060022 */
23
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -060024// Allow use of STL min and max functions in Windows
25#define NOMINMAX
26
Jeremy Hayese0ed6a22016-04-08 09:53:54 -060027#include <algorithm>
28#include <assert.h>
Karl Schultzd7f37542016-05-10 11:36:08 -060029#include <cinttypes>
Jeremy Hayese0ed6a22016-04-08 09:53:54 -060030#include <memory>
31#include <mutex>
Jeremy Hayes9cc31582015-06-18 10:12:39 -060032#include <stdio.h>
33#include <stdlib.h>
34#include <string.h>
Mark Lobodzinski040142c2016-11-22 11:18:46 -070035#include <limits.h>
Jeremy Hayes9cc31582015-06-18 10:12:39 -060036#include <unordered_map>
Jeremy Hayese0ed6a22016-04-08 09:53:54 -060037#include <vector>
Mark Lobodzinski040142c2016-11-22 11:18:46 -070038#include <bitset>
Mark Lobodzinski9acd2e32016-12-21 15:22:39 -070039#include <sstream>
Jeremy Hayes9cc31582015-06-18 10:12:39 -060040
Tobin Ehlisb835d1b2015-07-03 10:34:49 -060041#include "vk_loader_platform.h"
Courtney Goeltzenleuchter8f8367e2015-10-07 08:38:30 -060042#include "vk_dispatch_table_helper.h"
Mark Lobodzinski9acd2e32016-12-21 15:22:39 -070043#include "vk_enum_string_helper.h"
Courtney Goeltzenleuchter8f8367e2015-10-07 08:38:30 -060044#include "image.h"
45#include "vk_layer_config.h"
46#include "vk_layer_extension_utils.h"
Tobin Ehlisa0cb02e2015-07-03 10:15:26 -060047#include "vk_layer_table.h"
48#include "vk_layer_data.h"
Courtney Goeltzenleuchter426e1872015-07-07 11:18:30 -060049#include "vk_layer_extension_utils.h"
Mike Stroyana3082432015-09-25 13:39:21 -060050#include "vk_layer_utils.h"
Courtney Goeltzenleuchter8f8367e2015-10-07 08:38:30 -060051#include "vk_layer_logging.h"
Mark Lobodzinski69b52fe2016-10-14 11:43:06 -060052#include "vk_validation_error_messages.h"
Jeremy Hayes9cc31582015-06-18 10:12:39 -060053
Mark Muelleraab36502016-05-03 13:17:29 -060054using namespace std;
55
Chia-I Wuaacb0fc2016-04-28 11:27:46 +080056namespace image {
57
Cody Northrop55443ef2015-09-28 15:09:32 -060058struct layer_data {
Chia-I Wu2cfc77c2016-04-28 16:04:15 +080059 VkInstance instance;
60
Jon Ashburn5484e0c2016-03-08 17:48:44 -070061 debug_report_data *report_data;
62 vector<VkDebugReportCallbackEXT> logging_callback;
63 VkLayerDispatchTable *device_dispatch_table;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -070064 VkLayerInstanceDispatchTable *instance_dispatch_table;
Jon Ashburn5484e0c2016-03-08 17:48:44 -070065 VkPhysicalDevice physicalDevice;
66 VkPhysicalDeviceProperties physicalDeviceProperties;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -070067
Chia-I Wue2fc5522015-10-26 20:04:44 +080068 unordered_map<VkImage, IMAGE_STATE> imageMap;
Cody Northrop55443ef2015-09-28 15:09:32 -060069
Jon Ashburn5484e0c2016-03-08 17:48:44 -070070 layer_data()
71 : report_data(nullptr), device_dispatch_table(nullptr), instance_dispatch_table(nullptr), physicalDevice(0),
72 physicalDeviceProperties(){};
Cody Northrop55443ef2015-09-28 15:09:32 -060073};
Jeremy Hayes9cc31582015-06-18 10:12:39 -060074
Jon Ashburn5484e0c2016-03-08 17:48:44 -070075static unordered_map<void *, layer_data *> layer_data_map;
Jeremy Hayese0ed6a22016-04-08 09:53:54 -060076static std::mutex global_lock;
Jeremy Hayes9cc31582015-06-18 10:12:39 -060077
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -060078static void init_image(layer_data *my_data, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -060079 layer_debug_actions(my_data->report_data, my_data->logging_callback, pAllocator, "lunarg_image");
Jeremy Hayes9cc31582015-06-18 10:12:39 -060080}
81
Tobin Ehlisf4d352b2016-05-19 09:59:30 -060082static IMAGE_STATE const *getImageState(layer_data const *dev_data, VkImage image) {
83 auto it = dev_data->imageMap.find(image);
84 if (it == dev_data->imageMap.end()) {
85 return nullptr;
86 }
87 return &it->second;
88}
89
Chia-I Wu4935c762016-04-28 14:01:30 +080090VKAPI_ATTR VkResult VKAPI_CALL
91CreateDebugReportCallbackEXT(VkInstance instance, const VkDebugReportCallbackCreateInfoEXT *pCreateInfo,
92 const VkAllocationCallbacks *pAllocator, VkDebugReportCallbackEXT *pMsgCallback) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -070093 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
94 VkResult res = my_data->instance_dispatch_table->CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback);
Jeremy Hayes9cc31582015-06-18 10:12:39 -060095 if (res == VK_SUCCESS) {
Mark Lobodzinski97c4d512016-05-19 15:27:18 -060096 res = layer_create_msg_callback(my_data->report_data, false, pCreateInfo, pAllocator, pMsgCallback);
Jeremy Hayes9cc31582015-06-18 10:12:39 -060097 }
98 return res;
99}
100
Chia-I Wu4935c762016-04-28 14:01:30 +0800101VKAPI_ATTR void VKAPI_CALL DestroyDebugReportCallbackEXT(VkInstance instance,
102 VkDebugReportCallbackEXT msgCallback,
103 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700104 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
105 my_data->instance_dispatch_table->DestroyDebugReportCallbackEXT(instance, msgCallback, pAllocator);
Courtney Goeltzenleuchter05854bf2015-11-30 12:13:14 -0700106 layer_destroy_msg_callback(my_data->report_data, msgCallback, pAllocator);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600107}
108
Chia-I Wu4935c762016-04-28 14:01:30 +0800109VKAPI_ATTR void VKAPI_CALL
110DebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objType, uint64_t object,
111 size_t location, int32_t msgCode, const char *pLayerPrefix, const char *pMsg) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700112 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700113 my_data->instance_dispatch_table->DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix,
114 pMsg);
Courtney Goeltzenleuchterf0de7242015-12-01 14:10:55 -0700115}
116
Chia-I Wu4935c762016-04-28 14:01:30 +0800117VKAPI_ATTR VkResult VKAPI_CALL
118CreateInstance(const VkInstanceCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkInstance *pInstance) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700119 VkLayerInstanceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600120
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700121 assert(chain_info->u.pLayerInfo);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700122 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700123 PFN_vkCreateInstance fpCreateInstance = (PFN_vkCreateInstance)fpGetInstanceProcAddr(NULL, "vkCreateInstance");
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700124 if (fpCreateInstance == NULL) {
125 return VK_ERROR_INITIALIZATION_FAILED;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600126 }
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700127
128 // Advance the link info for the next element on the chain
129 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
130
131 VkResult result = fpCreateInstance(pCreateInfo, pAllocator, pInstance);
132 if (result != VK_SUCCESS)
133 return result;
134
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700135 layer_data *my_data = get_my_data_ptr(get_dispatch_key(*pInstance), layer_data_map);
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800136 my_data->instance = *pInstance;
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700137 my_data->instance_dispatch_table = new VkLayerInstanceDispatchTable;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700138 layer_init_instance_dispatch_table(*pInstance, my_data->instance_dispatch_table, fpGetInstanceProcAddr);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700139
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700140 my_data->report_data = debug_report_create_instance(my_data->instance_dispatch_table, *pInstance,
141 pCreateInfo->enabledExtensionCount, pCreateInfo->ppEnabledExtensionNames);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700142
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -0600143 init_image(my_data, pAllocator);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700144
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600145 return result;
146}
147
Chia-I Wu4935c762016-04-28 14:01:30 +0800148VKAPI_ATTR void VKAPI_CALL DestroyInstance(VkInstance instance, const VkAllocationCallbacks *pAllocator) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600149 // Grab the key before the instance is destroyed.
150 dispatch_key key = get_dispatch_key(instance);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600151 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
152 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
Chia-I Wuf7458c52015-10-26 21:10:41 +0800153 pTable->DestroyInstance(instance, pAllocator);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600154
155 // Clean up logging callback, if any
Courtney Goeltzenleuchterffcdd8b2015-10-05 15:59:11 -0600156 while (my_data->logging_callback.size() > 0) {
Courtney Goeltzenleuchter7415d5a2015-12-09 15:48:16 -0700157 VkDebugReportCallbackEXT callback = my_data->logging_callback.back();
Courtney Goeltzenleuchter05854bf2015-11-30 12:13:14 -0700158 layer_destroy_msg_callback(my_data->report_data, callback, pAllocator);
Courtney Goeltzenleuchterffcdd8b2015-10-05 15:59:11 -0600159 my_data->logging_callback.pop_back();
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600160 }
161
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600162 layer_debug_report_destroy_instance(my_data->report_data);
163 delete my_data->instance_dispatch_table;
164 layer_data_map.erase(key);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600165}
166
Chia-I Wu4935c762016-04-28 14:01:30 +0800167VKAPI_ATTR VkResult VKAPI_CALL CreateDevice(VkPhysicalDevice physicalDevice,
168 const VkDeviceCreateInfo *pCreateInfo,
169 const VkAllocationCallbacks *pAllocator, VkDevice *pDevice) {
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800170 layer_data *my_instance_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700171 VkLayerDeviceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700172
173 assert(chain_info->u.pLayerInfo);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700174 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
175 PFN_vkGetDeviceProcAddr fpGetDeviceProcAddr = chain_info->u.pLayerInfo->pfnNextGetDeviceProcAddr;
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800176 PFN_vkCreateDevice fpCreateDevice = (PFN_vkCreateDevice)fpGetInstanceProcAddr(my_instance_data->instance, "vkCreateDevice");
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700177 if (fpCreateDevice == NULL) {
178 return VK_ERROR_INITIALIZATION_FAILED;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600179 }
180
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700181 // Advance the link info for the next element on the chain
182 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
183
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700184 VkResult result = fpCreateDevice(physicalDevice, pCreateInfo, pAllocator, pDevice);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700185 if (result != VK_SUCCESS) {
186 return result;
187 }
188
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700189 layer_data *my_device_data = get_my_data_ptr(get_dispatch_key(*pDevice), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700190
191 // Setup device dispatch table
192 my_device_data->device_dispatch_table = new VkLayerDispatchTable;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700193 layer_init_device_dispatch_table(*pDevice, my_device_data->device_dispatch_table, fpGetDeviceProcAddr);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700194
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700195 my_device_data->report_data = layer_debug_report_create_device(my_instance_data->report_data, *pDevice);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700196 my_device_data->physicalDevice = physicalDevice;
197
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700198 my_instance_data->instance_dispatch_table->GetPhysicalDeviceProperties(physicalDevice,
199 &(my_device_data->physicalDeviceProperties));
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700200
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600201 return result;
202}
203
Chia-I Wu4935c762016-04-28 14:01:30 +0800204VKAPI_ATTR void VKAPI_CALL DestroyDevice(VkDevice device, const VkAllocationCallbacks *pAllocator) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600205 dispatch_key key = get_dispatch_key(device);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600206 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
Chia-I Wuf7458c52015-10-26 21:10:41 +0800207 my_data->device_dispatch_table->DestroyDevice(device, pAllocator);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600208 delete my_data->device_dispatch_table;
209 layer_data_map.erase(key);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600210}
211
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700212static const VkExtensionProperties instance_extensions[] = {{VK_EXT_DEBUG_REPORT_EXTENSION_NAME, VK_EXT_DEBUG_REPORT_SPEC_VERSION}};
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600213
Chia-I Wu740891e2016-04-28 14:12:27 +0800214static const VkLayerProperties global_layer = {
Jon Ashburndc9111c2016-03-22 12:57:13 -0600215 "VK_LAYER_LUNARG_image", VK_LAYER_API_VERSION, 1, "LunarG Validation Layer",
Chia-I Wu740891e2016-04-28 14:12:27 +0800216};
Courtney Goeltzenleuchter52857662015-12-01 14:08:28 -0700217
Mark Lobodzinski2fd634c2015-07-29 09:21:22 -0600218// Start of the Image layer proper
219
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600220VKAPI_ATTR VkResult VKAPI_CALL CreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
221 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
222 bool skip_call = false;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700223 VkResult result = VK_ERROR_VALIDATION_FAILED_EXT;
Michael Lentine0a369f62016-02-03 16:51:46 -0600224 VkImageFormatProperties ImageFormatProperties;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700225
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700226 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
227 VkPhysicalDevice physicalDevice = device_data->physicalDevice;
228 layer_data *phy_dev_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700229
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700230 if (pCreateInfo->format != VK_FORMAT_UNDEFINED) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600231 VkFormatProperties properties;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700232 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceFormatProperties(device_data->physicalDevice, pCreateInfo->format,
233 &properties);
Dave Houlton34df4cb2016-12-01 16:43:06 -0700234 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties.linearTilingFeatures == 0)) {
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600235 std::stringstream ss;
236 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600237 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 -0700238 0, __LINE__, VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(),
239 validation_error_map[VALIDATION_ERROR_02150]);
240 }
241
242 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties.optimalTilingFeatures == 0)) {
243 std::stringstream ss;
244 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
245 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
246 0, __LINE__, VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(),
247 validation_error_map[VALIDATION_ERROR_02155]);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600248 }
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600249
250 // Validate that format supports usage as color attachment
251 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
252 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
253 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
254 std::stringstream ss;
255 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
256 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700257 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
258 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02158, "IMAGE",
259 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02158]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600260 }
261 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
262 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
263 std::stringstream ss;
264 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
265 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700266 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
267 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02153, "IMAGE",
268 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02153]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600269 }
270 }
271 // Validate that format supports usage as depth/stencil attachment
272 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
273 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
274 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
275 std::stringstream ss;
276 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
277 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700278 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
279 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02159, "IMAGE",
280 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02159]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600281 }
282 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
283 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
284 std::stringstream ss;
285 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
286 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700287 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
288 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02154, "IMAGE",
289 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02154]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600290 }
291 }
292 } else {
293 skip_call |=
294 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 -0700295 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
296 validation_error_map[VALIDATION_ERROR_00715]);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600297 }
298
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700299 // Internal call to get format info. Still goes through layers, could potentially go directly to ICD.
300 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceImageFormatProperties(
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700301 physicalDevice, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
302 &ImageFormatProperties);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600303
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700304 VkDeviceSize imageGranularity = device_data->physicalDeviceProperties.limits.bufferImageGranularity;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700305 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
306
Mark Youngc48c4c12016-04-11 14:26:49 -0600307 // Make sure all required dimension are non-zero at least.
308 bool failedMinSize = false;
309 switch (pCreateInfo->imageType) {
310 case VK_IMAGE_TYPE_3D:
311 if (pCreateInfo->extent.depth == 0) {
312 failedMinSize = true;
313 }
314 // Intentional fall-through
315 case VK_IMAGE_TYPE_2D:
316 if (pCreateInfo->extent.height == 0) {
317 failedMinSize = true;
318 }
319 // Intentional fall-through
320 case VK_IMAGE_TYPE_1D:
321 if (pCreateInfo->extent.width == 0) {
322 failedMinSize = true;
323 }
324 break;
325 default:
326 break;
327 }
Dave Houlton34df4cb2016-12-01 16:43:06 -0700328 // TODO: VALIDATION_ERROR_00716
329 // 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 -0600330 if (failedMinSize) {
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600331 skip_call |=
Dave Houlton34df4cb2016-12-01 16:43:06 -0700332 log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
333 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
Mark Youngc48c4c12016-04-11 14:26:49 -0600334 "CreateImage extents is 0 for at least one required dimension for image of type %d: "
335 "Width = %d Height = %d Depth = %d.",
336 pCreateInfo->imageType, pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth);
337 }
338
Dave Houlton34df4cb2016-12-01 16:43:06 -0700339 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
340 // All these extent-related VUs should be checked here
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700341 if ((pCreateInfo->extent.depth > ImageFormatProperties.maxExtent.depth) ||
342 (pCreateInfo->extent.width > ImageFormatProperties.maxExtent.width) ||
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700343 (pCreateInfo->extent.height > ImageFormatProperties.maxExtent.height)) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700344 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
345 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
346 "CreateImage extents exceed allowable limits for format: "
347 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
348 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
349 ImageFormatProperties.maxExtent.width, ImageFormatProperties.maxExtent.height,
350 ImageFormatProperties.maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700351 }
352
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700353 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
354 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
355 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
356 (uint64_t)imageGranularity) &
357 ~(uint64_t)imageGranularity;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700358
359 if (totalSize > ImageFormatProperties.maxResourceSize) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700360 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
361 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
362 "CreateImage resource size exceeds allowable maximum "
363 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
364 totalSize, ImageFormatProperties.maxResourceSize);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700365 }
366
Dave Houlton34df4cb2016-12-01 16:43:06 -0700367 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700368 if (pCreateInfo->mipLevels > ImageFormatProperties.maxMipLevels) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700369 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
370 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
371 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
372 ImageFormatProperties.maxMipLevels);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700373 }
374
375 if (pCreateInfo->arrayLayers > ImageFormatProperties.maxArrayLayers) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700376 skip_call |= log_msg(
377 phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
378 VALIDATION_ERROR_02133, "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s",
379 pCreateInfo->arrayLayers, ImageFormatProperties.maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700380 }
381
382 if ((pCreateInfo->samples & ImageFormatProperties.sampleCounts) == 0) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700383 skip_call |=
384 log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
385 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
386 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties.sampleCounts,
387 validation_error_map[VALIDATION_ERROR_02138]);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700388 }
389
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700390 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700391 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
392 __LINE__, VALIDATION_ERROR_00731, "Image",
393 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
394 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
395 validation_error_map[VALIDATION_ERROR_00731]);
Jeremy Hayesffc8a702016-03-01 14:01:45 -0700396 }
397
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600398 if (!skip_call) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700399 result = device_data->device_dispatch_table->CreateImage(device, pCreateInfo, pAllocator, pImage);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700400 }
401 if (result == VK_SUCCESS) {
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600402 std::lock_guard<std::mutex> lock(global_lock);
Chia-I Wue2fc5522015-10-26 20:04:44 +0800403 device_data->imageMap[*pImage] = IMAGE_STATE(pCreateInfo);
Tobin Ehlisad8c4462015-09-21 15:20:28 -0600404 }
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600405 return result;
406}
407
Chia-I Wu4935c762016-04-28 14:01:30 +0800408VKAPI_ATTR void VKAPI_CALL DestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700409 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600410 std::unique_lock<std::mutex> lock(global_lock);
Chia-I Wue2fc5522015-10-26 20:04:44 +0800411 device_data->imageMap.erase(image);
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600412 lock.unlock();
Chia-I Wuf7458c52015-10-26 21:10:41 +0800413 device_data->device_dispatch_table->DestroyImage(device, image, pAllocator);
Tobin Ehlisad8c4462015-09-21 15:20:28 -0600414}
415
Chia-I Wu4935c762016-04-28 14:01:30 +0800416VKAPI_ATTR VkResult VKAPI_CALL CreateRenderPass(VkDevice device, const VkRenderPassCreateInfo *pCreateInfo,
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600417 const VkAllocationCallbacks *pAllocator, VkRenderPass *pRenderPass) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700418 layer_data *my_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600419 bool skip_call = false;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600420
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700421 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
Mark Lobodzinski27ced8b2016-08-05 11:30:15 -0600422 if (pCreateInfo->pAttachments[i].format == VK_FORMAT_UNDEFINED) {
423 std::stringstream ss;
424 ss << "vkCreateRenderPass: pCreateInfo->pAttachments[" << i << "].format is VK_FORMAT_UNDEFINED";
425 skip_call |= log_msg(my_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
426 IMAGE_RENDERPASS_INVALID_ATTACHMENT, "IMAGE", "%s", ss.str().c_str());
427 }
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600428 }
429
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600430 if (skip_call) {
Courtney Goeltzenleuchter52fee652015-12-10 16:41:22 -0700431 return VK_ERROR_VALIDATION_FAILED_EXT;
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600432 }
Mark Lobodzinski2fd634c2015-07-29 09:21:22 -0600433
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700434 VkResult result = my_data->device_dispatch_table->CreateRenderPass(device, pCreateInfo, pAllocator, pRenderPass);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600435
436 return result;
437}
438
Dave Houlton34df4cb2016-12-01 16:43:06 -0700439VKAPI_ATTR void VKAPI_CALL CmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
440 const VkClearColorValue *pColor, uint32_t rangeCount,
441 const VkImageSubresourceRange *pRanges) {
Dustin Graves080069b2016-04-05 13:48:15 -0600442 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700443 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Jeremy Hayesa4dc0ac2016-03-01 16:51:02 -0700444
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600445 // For each range, image aspect must be color only
Dave Houlton34df4cb2016-12-01 16:43:06 -0700446 // TODO: this is a 'must' in the spec, so there should be a VU enum for it
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600447 for (uint32_t i = 0; i < rangeCount; i++) {
448 if (pRanges[i].aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700449 char const str[] =
450 "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
451 skipCall |=
452 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
453 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600454 }
455 }
456
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600457 auto image_state = getImageState(device_data, image);
458 if (image_state) {
459 if (vk_format_is_depth_or_stencil(image_state->format)) {
460 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
461 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 -0700462 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
463 validation_error_map[VALIDATION_ERROR_01088]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600464 } else if (vk_format_is_compressed(image_state->format)) {
465 char const str[] = "vkCmdClearColorImage called with compressed image.";
466 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 -0700467 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
468 validation_error_map[VALIDATION_ERROR_01088]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600469 }
Tony Barbour26434b92016-06-02 09:43:50 -0600470
471 if (!(image_state->usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
472 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
473 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 -0700474 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
475 validation_error_map[VALIDATION_ERROR_01084]);
Tony Barbour26434b92016-06-02 09:43:50 -0600476 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600477 }
478
Dustin Graves080069b2016-04-05 13:48:15 -0600479 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700480 device_data->device_dispatch_table->CmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600481 }
482}
483
Dave Houlton34df4cb2016-12-01 16:43:06 -0700484VKAPI_ATTR void VKAPI_CALL CmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
485 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
486 const VkImageSubresourceRange *pRanges) {
Dustin Graves080069b2016-04-05 13:48:15 -0600487 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700488 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600489 // For each range, Image aspect must be depth or stencil or both
490 for (uint32_t i = 0; i < rangeCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700491 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
492 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700493 char const str[] = "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
494 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700495 skipCall |=
496 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
497 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600498 }
499 }
500
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600501 auto image_state = getImageState(device_data, image);
502 if (image_state && !vk_format_is_depth_or_stencil(image_state->format)) {
503 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
504 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 -0700505 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
506 validation_error_map[VALIDATION_ERROR_01103]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600507 }
508
Dustin Graves080069b2016-04-05 13:48:15 -0600509 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700510 device_data->device_dispatch_table->CmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount,
511 pRanges);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600512 }
513}
514
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600515// Returns true if [x, xoffset] and [y, yoffset] overlap
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600516static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600517 bool result = false;
518 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
519 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
520
521 if (intersection_max > intersection_min) {
522 result = true;
523 }
524 return result;
525}
526
527// Returns true if two VkImageCopy structures overlap
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600528static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
Alex Smith7b567442017-01-17 11:13:23 +0000529 bool result = false;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600530 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600531 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
532 dst->dstSubresource.layerCount))) {
Alex Smith7b567442017-01-17 11:13:23 +0000533 result = true;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600534 switch (type) {
535 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600536 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600537 // Intentionally fall through to 2D case
538 case VK_IMAGE_TYPE_2D:
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600539 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600540 // Intentionally fall through to 1D case
541 case VK_IMAGE_TYPE_1D:
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600542 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600543 break;
544 default:
545 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
546 assert(false);
547 }
548 }
549 return result;
550}
551
552// Returns true if offset and extent exceed image extents
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600553static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const IMAGE_STATE *image) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600554 bool result = false;
555 // Extents/depths cannot be negative but checks left in for clarity
Mark Lobodzinski39573d22016-10-14 10:59:27 -0600556 switch (image->imageType) {
557 case VK_IMAGE_TYPE_3D: // Validate z and depth
558 if ((offset->z + extent->depth > image->extent.depth) || (offset->z < 0) ||
559 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
560 result = true;
561 }
562 // Intentionally fall through to 2D case to check height
563 case VK_IMAGE_TYPE_2D: // Validate y and height
564 if ((offset->y + extent->height > image->extent.height) || (offset->y < 0) ||
565 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
566 result = true;
567 }
568 // Intentionally fall through to 1D case to check width
569 case VK_IMAGE_TYPE_1D: // Validate x and width
570 if ((offset->x + extent->width > image->extent.width) || (offset->x < 0) ||
571 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
572 result = true;
573 }
574 break;
575 default:
576 assert(false);
577 }
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600578 return result;
579}
580
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600581bool PreCallValidateCmdCopyImage(VkCommandBuffer command_buffer, VkImage src_image, VkImage dst_image, uint32_t region_count,
582 const VkImageCopy *regions) {
583 bool skip = false;
584 layer_data *device_data = get_my_data_ptr(get_dispatch_key(command_buffer), layer_data_map);
585 auto src_image_entry = getImageState(device_data, src_image);
586 auto dst_image_entry = getImageState(device_data, dst_image);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600587
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600588 // TODO: This does not cover swapchain-created images. This should fall out when this layer is moved
589 // into the core_validation layer
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600590 if (src_image_entry && dst_image_entry) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600591
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600592 for (uint32_t i = 0; i < region_count; i++) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600593
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600594 if (regions[i].srcSubresource.layerCount == 0) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600595 std::stringstream ss;
596 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600597 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
598 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t &>(command_buffer),
599 __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600600 }
601
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600602 if (regions[i].dstSubresource.layerCount == 0) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600603 std::stringstream ss;
604 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600605 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
606 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t &>(command_buffer),
607 __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600608 }
609
610 // For each region the layerCount member of srcSubresource and dstSubresource must match
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600611 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600612 std::stringstream ss;
613 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
614 << "] do not match";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600615 skip |=
Mark Lobodzinskia9a69ad2016-10-14 12:13:33 -0600616 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 -0600617 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
Mark Lobodzinskia9a69ad2016-10-14 12:13:33 -0600618 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600619 }
620
621 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600622 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600623 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600624 skip |=
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600625 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 -0700626 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
627 validation_error_map[VALIDATION_ERROR_01197]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600628 }
629
630 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600631 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
632 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600633 std::stringstream ss;
634 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700635 skip |=
636 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
637 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01222, "IMAGE", "%s. %s",
638 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600639 }
640
641 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
642 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600643 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
644 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600645 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600646 skip |=
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600647 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 -0700648 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
649 validation_error_map[VALIDATION_ERROR_01221]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600650 }
651
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600652 // 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 -0600653 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600654 if (((src_image_entry->imageType == VK_IMAGE_TYPE_3D) || (dst_image_entry->imageType == VK_IMAGE_TYPE_3D)) &&
655 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
656 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600657 std::stringstream ss;
658 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
659 << "] baseArrayLayer was not zero or layerCount was not 1.";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700660 skip |=
661 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
662 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01199, "IMAGE", "%s. %s",
663 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600664 }
665
666 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600667 if (regions[i].srcSubresource.mipLevel >= src_image_entry->mipLevels) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600668 std::stringstream ss;
669 ss << "vkCmdCopyImage: pRegions[" << i
670 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700671 skip |=
672 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
673 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
674 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600675 }
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600676 if (regions[i].dstSubresource.mipLevel >= dst_image_entry->mipLevels) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600677 std::stringstream ss;
678 ss << "vkCmdCopyImage: pRegions[" << i
679 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700680 skip |=
681 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
682 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
683 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600684 }
685
686 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
687 // image was created
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600688 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) > src_image_entry->arraySize) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600689 std::stringstream ss;
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600690 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_entry->arraySize << " but subRegion[" << i
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600691 << "] baseArrayLayer + layerCount is "
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600692 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
Dave Houlton34df4cb2016-12-01 16:43:06 -0700693 skip |=
694 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
695 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
696 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600697 }
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600698 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) > dst_image_entry->arraySize) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600699 std::stringstream ss;
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600700 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_entry->arraySize << " but subRegion[" << i
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600701 << "] baseArrayLayer + layerCount is "
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600702 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
Dave Houlton34df4cb2016-12-01 16:43:06 -0700703 skip |=
704 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
705 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
706 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600707 }
708
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600709 // The source region specified by a given element of regions must be a region that is contained within srcImage
710 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, src_image_entry)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600711 std::stringstream ss;
712 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage was created with";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600713 skip |=
Mark Lobodzinski8ea6eb02016-10-14 11:40:31 -0600714 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 -0600715 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01175, "IMAGE", "%s. %s",
Tobin Ehlis15edfa82016-10-18 07:31:22 -0600716 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600717 }
718
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600719 // The destination region specified by a given element of regions must be a region that is contained within dst_image
720 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, dst_image_entry)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600721 std::stringstream ss;
722 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600723 skip |=
Mark Lobodzinski8ea6eb02016-10-14 11:40:31 -0600724 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 -0600725 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
Mark Lobodzinski8ea6eb02016-10-14 11:40:31 -0600726 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600727 }
728
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600729 // 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 -0600730 // must not overlap in memory
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600731 if (src_image == dst_image) {
732 for (uint32_t j = 0; j < region_count; j++) {
733 if (RegionIntersects(&regions[i], &regions[j], src_image_entry->imageType)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600734 std::stringstream ss;
735 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700736 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
737 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
738 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
739 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600740 }
741 }
742 }
Mike Stroyana3082432015-09-25 13:39:21 -0600743 }
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600744
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600745 // 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 -0600746 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
747 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600748 if (vk_format_is_depth_or_stencil(src_image_entry->format) || vk_format_is_depth_or_stencil(dst_image_entry->format)) {
749 if (src_image_entry->format != dst_image_entry->format) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700750 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600751 skip |=
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700752 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 -0600753 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, IMAGE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mike Stroyana3082432015-09-25 13:39:21 -0600754 }
755 } else {
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600756 size_t srcSize = vk_format_get_size(src_image_entry->format);
757 size_t destSize = vk_format_get_size(dst_image_entry->format);
Mike Stroyana3082432015-09-25 13:39:21 -0600758 if (srcSize != destSize) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700759 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600760 skip |=
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700761 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 -0600762 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
Tobin Ehlis15edfa82016-10-18 07:31:22 -0600763 validation_error_map[VALIDATION_ERROR_01184]);
Mike Stroyana3082432015-09-25 13:39:21 -0600764 }
765 }
766 }
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600767 return skip;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600768}
769
Chia-I Wu4935c762016-04-28 14:01:30 +0800770VKAPI_ATTR void VKAPI_CALL CmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage,
771 VkImageLayout srcImageLayout, VkImage dstImage,
772 VkImageLayout dstImageLayout, uint32_t regionCount,
773 const VkImageCopy *pRegions) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600774
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600775 bool skip = false;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600776 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
777
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600778 skip = PreCallValidateCmdCopyImage(commandBuffer, srcImage, dstImage, regionCount, pRegions);
Mike Stroyana3082432015-09-25 13:39:21 -0600779
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600780 if (!skip) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700781 device_data->device_dispatch_table->CmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
782 regionCount, pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600783 }
784}
785
Chia-I Wu4935c762016-04-28 14:01:30 +0800786VKAPI_ATTR void VKAPI_CALL CmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
787 const VkClearAttachment *pAttachments, uint32_t rectCount,
788 const VkClearRect *pRects) {
Dustin Graves080069b2016-04-05 13:48:15 -0600789 bool skipCall = false;
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600790 VkImageAspectFlags aspectMask;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700791 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600792 for (uint32_t i = 0; i < attachmentCount; i++) {
793 aspectMask = pAttachments[i].aspectMask;
Dave Houlton34df4cb2016-12-01 16:43:06 -0700794 if (0 == aspectMask) {
795 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
796 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
797 VALIDATION_ERROR_01128, "IMAGE", "%s", validation_error_map[VALIDATION_ERROR_01128]);
798 } else if (aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
799 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
800 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
801 VALIDATION_ERROR_01126, "IMAGE", "%s", validation_error_map[VALIDATION_ERROR_01126]);
802 } else if (aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
803 if ((aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) || (aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700804 char const str[] =
Dave Houlton34df4cb2016-12-01 16:43:06 -0700805 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
806 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
807 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
808 VALIDATION_ERROR_01125, "IMAGE", str, i, validation_error_map[VALIDATION_ERROR_01125]);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600809 }
810 } else {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700811 // Having eliminated all other possibilities, image aspect must be depth or stencil or both
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700812 if (((aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
813 ((aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
814 char const str[] = "vkCmdClearAttachments aspectMask [%d] must be set to VK_IMAGE_ASPECT_DEPTH_BIT and/or "
Dave Houlton34df4cb2016-12-01 16:43:06 -0700815 "VK_IMAGE_ASPECT_STENCIL_BIT. %s";
816 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++) {
833
834 auto image_info = getImageState(dev_data, image);
835 if (image_info) {
Mark Lobodzinski1bda8892016-11-22 14:46:39 -0700836
837 if ((image_info->imageType == VK_IMAGE_TYPE_1D) || (image_info->imageType == VK_IMAGE_TYPE_2D)) {
838 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
839 skip |= log_msg(dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
840 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01269, "IMAGE",
841 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. These must be 0 and 1, "
842 "respectively. %s",
843 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
844 validation_error_map[VALIDATION_ERROR_01269]);
845 }
846 }
847
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600848 // BufferOffset must be a multiple of the calling command's VkImage parameter's texel size
849 auto texel_size = vk_format_get_size(image_info->format);
850 if (vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
851 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 -0700852 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600853 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700854 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
855 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600856 }
Mark Lobodzinski1bda8892016-11-22 14:46:39 -0700857
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600858 // BufferOffset must be a multiple of 4
859 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
860 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 -0700861 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
862 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
863 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600864 }
865
866 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
867 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
868 skip |= log_msg(
869 dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700870 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
871 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
872 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
873 validation_error_map[VALIDATION_ERROR_01265]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600874 }
875
876 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
877 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
878 skip |= log_msg(
879 dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700880 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
881 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
882 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
883 validation_error_map[VALIDATION_ERROR_01266]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600884 }
Mark Lobodzinski040142c2016-11-22 11:18:46 -0700885
886 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700887 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
Mark Lobodzinski040142c2016-11-22 11:18:46 -0700888 if (aspect_mask_bits.count() != 1) {
889 skip |=
890 log_msg(dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
891 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
892 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
893 validation_error_map[VALIDATION_ERROR_01280]);
894 }
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600895 }
896 }
897
898 return skip;
899}
900
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700901static bool PreCallValidateCmdCopyImageToBuffer(layer_data *dev_data, VkImage srcImage, uint32_t regionCount,
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700902 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700903 return ValidateBufferImageCopyData(dev_data, regionCount, pRegions, srcImage, "vkCmdCopyImageToBuffer");
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700904}
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600905
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700906VKAPI_ATTR void VKAPI_CALL CmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
907 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
908 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
909
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700910 if (!PreCallValidateCmdCopyImageToBuffer(device_data, srcImage, regionCount, pRegions, "vkCmdCopyImageToBuffer()")) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700911 device_data->device_dispatch_table->CmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount,
912 pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600913 }
914}
915
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700916static bool PreCallValidateCmdCopyBufferToImage(layer_data *dev_data, VkImage dstImage, uint32_t regionCount,
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700917 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700918 return ValidateBufferImageCopyData(dev_data, regionCount, pRegions, dstImage, "vkCmdCopyBufferToImage");
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700919}
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600920
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700921VKAPI_ATTR void VKAPI_CALL CmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
922 VkImageLayout dstImageLayout, uint32_t regionCount,
923 const VkBufferImageCopy *pRegions) {
924 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
925
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700926 if (!PreCallValidateCmdCopyBufferToImage(device_data, dstImage, regionCount, pRegions, "vkCmdCopyBufferToImage()")) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700927 device_data->device_dispatch_table->CmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount,
928 pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600929 }
930}
931
Dave Houlton34df4cb2016-12-01 16:43:06 -0700932VKAPI_ATTR void VKAPI_CALL CmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
933 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
934 const VkImageBlit *pRegions, VkFilter filter) {
Dustin Graves080069b2016-04-05 13:48:15 -0600935 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700936 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600937
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600938 // Warn for zero-sized regions
939 for (uint32_t i = 0; i < regionCount; i++) {
940 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
941 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
942 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
943 std::stringstream ss;
944 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
945 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700946 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(commandBuffer), __LINE__,
947 IMAGE_INVALID_EXTENTS, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600948 }
949 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
950 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
951 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
952 std::stringstream ss;
953 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
954 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700955 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(commandBuffer), __LINE__,
956 IMAGE_INVALID_EXTENTS, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600957 }
958 }
959
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600960 auto srcImageEntry = getImageState(device_data, srcImage);
961 auto dstImageEntry = getImageState(device_data, dstImage);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600962
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600963 if (srcImageEntry && dstImageEntry) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600964
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600965 VkFormat srcFormat = srcImageEntry->format;
966 VkFormat dstFormat = dstImageEntry->format;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600967
Dave Houlton34df4cb2016-12-01 16:43:06 -0700968 // Validate consistency for unsigned formats
969 if (vk_format_is_uint(srcFormat) != vk_format_is_uint(dstFormat)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600970 std::stringstream ss;
Dave Houlton34df4cb2016-12-01 16:43:06 -0700971 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
972 << "the other one must also have unsigned integer format. "
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700973 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700974 skipCall |=
975 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 -0700976 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s", ss.str().c_str(),
977 validation_error_map[VALIDATION_ERROR_02191]);
978 }
979
980 // Validate consistency for signed formats
981 if (vk_format_is_sint(srcFormat) != vk_format_is_sint(dstFormat)) {
982 std::stringstream ss;
983 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
984 << "the other one must also have signed integer format. "
985 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
986 skipCall |=
987 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
988 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s", ss.str().c_str(),
989 validation_error_map[VALIDATION_ERROR_02190]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600990 }
991
992 // Validate aspect bits and formats for depth/stencil images
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700993 if (vk_format_is_depth_or_stencil(srcFormat) || vk_format_is_depth_or_stencil(dstFormat)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600994 if (srcFormat != dstFormat) {
995 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700996 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
997 << "stencil, the other one must have exactly the same format. "
998 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700999 skipCall |=
1000 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 -07001001 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02192, "IMAGE", "%s. %s", ss.str().c_str(),
1002 validation_error_map[VALIDATION_ERROR_02192]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001003 }
1004
Dave Houlton34df4cb2016-12-01 16:43:06 -07001005 // TODO: Confirm that all these checks are intended to be nested under depth/stencil only
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001006 for (uint32_t i = 0; i < regionCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001007 if (pRegions[i].srcSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001008 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1009 // 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 -07001010 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1011 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1012 IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001013 }
1014
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001015 if (pRegions[i].dstSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001016 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1017 // 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 -07001018 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1019 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1020 IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001021 }
1022
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001023 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001024 char const str[] = "vkCmdBlitImage: number of layers in source and destination subresources must match";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001025 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1026 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1027 IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001028 }
1029
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001030 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
1031 VkImageAspectFlags dstAspect = pRegions[i].dstSubresource.aspectMask;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001032
1033 if (srcAspect != dstAspect) {
1034 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001035 ss << "vkCmdBlitImage: Image aspects of depth/stencil images should match";
1036 // 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 -07001037 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1038 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1039 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001040 }
1041 if (vk_format_is_depth_and_stencil(srcFormat)) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001042 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001043 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001044 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1045 "VK_IMAGE_ASPECT_DEPTH_BIT "
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001046 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001047 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1048 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1049 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001050 }
1051 } else if (vk_format_is_stencil_only(srcFormat)) {
1052 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1053 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001054 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
Chia-I Wu3432a0c2015-10-27 18:04:07 +08001055 << "set in both the srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001056 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1057 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1058 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001059 }
1060 } else if (vk_format_is_depth_only(srcFormat)) {
1061 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1062 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001063 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
Chia-I Wu3432a0c2015-10-27 18:04:07 +08001064 << "set in both the srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001065 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1066 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1067 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001068 }
1069 }
1070 }
1071 }
1072
1073 // Validate filter
Dave Houlton34df4cb2016-12-01 16:43:06 -07001074 if (vk_format_is_depth_or_stencil(srcFormat) && (filter != VK_FILTER_NEAREST)) {
1075 std::stringstream ss;
1076 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1077 << "then filter must be VK_FILTER_NEAREST.";
1078 skipCall |=
1079 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1080 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s", ss.str().c_str(),
1081 validation_error_map[VALIDATION_ERROR_02193]);
1082 }
1083 if (vk_format_is_int(srcFormat) && (filter != VK_FILTER_NEAREST)) {
1084 std::stringstream ss;
1085 ss << "vkCmdBlitImage: If the format of srcImage is an integer-based format "
1086 << "then filter must be VK_FILTER_NEAREST.";
1087 skipCall |=
1088 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1089 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_FILTER, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001090 }
1091 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001092
Tony Barbourf8309102016-05-05 10:50:21 -06001093 if (!skipCall) {
Dave Houlton34df4cb2016-12-01 16:43:06 -07001094 device_data->device_dispatch_table->CmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
1095 regionCount, pRegions, filter);
Tony Barbourf8309102016-05-05 10:50:21 -06001096 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001097}
1098
Chia-I Wu4935c762016-04-28 14:01:30 +08001099VKAPI_ATTR void VKAPI_CALL
1100CmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
1101 VkDependencyFlags dependencyFlags, uint32_t memoryBarrierCount, const VkMemoryBarrier *pMemoryBarriers,
1102 uint32_t bufferMemoryBarrierCount, const VkBufferMemoryBarrier *pBufferMemoryBarriers,
1103 uint32_t imageMemoryBarrierCount, const VkImageMemoryBarrier *pImageMemoryBarriers) {
Dustin Graves080069b2016-04-05 13:48:15 -06001104 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001105 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Jeremy Hayes01b38892015-11-17 18:19:55 -07001106
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001107 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
1108 VkImageMemoryBarrier const *const barrier = (VkImageMemoryBarrier const *const) & pImageMemoryBarriers[i];
Dave Houlton34df4cb2016-12-01 16:43:06 -07001109 // TODO: add VALIDATION_ERROR_00309 (sType == VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER) here
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001110 if (barrier->sType == VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER) {
Dave Houlton34df4cb2016-12-01 16:43:06 -07001111 // TODO: this check should include VALIDATION_ERROR_00301 and VALIDATION_ERROR_00316
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001112 if (barrier->subresourceRange.layerCount == 0) {
Jeremy Hayes01b38892015-11-17 18:19:55 -07001113 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001114 ss << "vkCmdPipelineBarrier called with 0 in ppMemoryBarriers[" << i << "]->subresourceRange.layerCount.";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001115 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
1116 __LINE__, IMAGE_INVALID_IMAGE_RESOURCE, "IMAGE", "%s", ss.str().c_str());
Jeremy Hayes01b38892015-11-17 18:19:55 -07001117 }
1118 }
1119 }
1120
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001121 if (skipCall) {
Jeremy Hayes01b38892015-11-17 18:19:55 -07001122 return;
1123 }
1124
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001125 device_data->device_dispatch_table->CmdPipelineBarrier(commandBuffer, srcStageMask, dstStageMask, dependencyFlags,
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001126 memoryBarrierCount, pMemoryBarriers, bufferMemoryBarrierCount,
1127 pBufferMemoryBarriers, imageMemoryBarrierCount, pImageMemoryBarriers);
Jeremy Hayes01b38892015-11-17 18:19:55 -07001128}
1129
Dave Houlton34df4cb2016-12-01 16:43:06 -07001130VKAPI_ATTR void VKAPI_CALL CmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
1131 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
1132 const VkImageResolve *pRegions) {
Dustin Graves080069b2016-04-05 13:48:15 -06001133 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001134 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001135 auto srcImageEntry = getImageState(device_data, srcImage);
1136 auto dstImageEntry = getImageState(device_data, dstImage);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001137
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001138 // For each region, the number of layers in the image subresource should not be zero
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001139 // For each region, src and dest image aspect must be color only
1140 for (uint32_t i = 0; i < regionCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001141 if (pRegions[i].srcSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001142 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
1143 // 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 -07001144 skipCall |=
1145 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1146 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001147 }
1148
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001149 if (pRegions[i].dstSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001150 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Courtney Goeltzenleuchter7415d5a2015-12-09 15:48:16 -07001151
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001152 // 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 -07001153 skipCall |=
1154 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1155 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001156 }
1157
Dave Houlton34df4cb2016-12-01 16:43:06 -07001158 // TODO: VALIDATION_ERROR_01339
1159
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001160 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001161 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001162 char const str[] =
1163 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001164 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1165 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1166 VALIDATION_ERROR_01338, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001167 }
1168 }
1169
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001170 if (srcImageEntry && dstImageEntry) {
1171 if (srcImageEntry->format != dstImageEntry->format) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001172 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
1173 skipCall |=
1174 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1175 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mike Stroyana3082432015-09-25 13:39:21 -06001176 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001177 if (srcImageEntry->imageType != dstImageEntry->imageType) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001178 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
1179 skipCall |=
1180 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1181 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mike Stroyana3082432015-09-25 13:39:21 -06001182 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001183 if (srcImageEntry->samples == VK_SAMPLE_COUNT_1_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001184 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001185 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1186 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1187 VALIDATION_ERROR_01320, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01320]);
Mike Stroyana3082432015-09-25 13:39:21 -06001188 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001189 if (dstImageEntry->samples != VK_SAMPLE_COUNT_1_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001190 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001191 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1192 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1193 VALIDATION_ERROR_01321, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01321]);
Mike Stroyana3082432015-09-25 13:39:21 -06001194 }
1195 }
1196
Dustin Graves080069b2016-04-05 13:48:15 -06001197 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001198 device_data->device_dispatch_table->CmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
1199 regionCount, pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001200 }
1201}
1202
Dave Houlton34df4cb2016-12-01 16:43:06 -07001203VKAPI_ATTR void VKAPI_CALL GetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
1204 VkSubresourceLayout *pLayout) {
Dustin Graves080069b2016-04-05 13:48:15 -06001205 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001206 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001207 VkFormat format;
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001208
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001209 auto imageEntry = getImageState(device_data, image);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001210
1211 // Validate that image aspects match formats
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001212 if (imageEntry) {
1213 format = imageEntry->format;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001214 if (vk_format_is_color(format)) {
Chia-I Wu52b07e72015-10-27 19:55:05 +08001215 if (pSubresource->aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001216 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001217 ss << "vkGetImageSubresourceLayout: For color formats, the aspectMask field of VkImageSubresource must be "
1218 "VK_IMAGE_ASPECT_COLOR.";
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001219 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 -07001220 (uint64_t)image, __LINE__, VALIDATION_ERROR_00741, "IMAGE", "%s. %s", ss.str().c_str(),
1221 validation_error_map[VALIDATION_ERROR_00741]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001222 }
1223 } else if (vk_format_is_depth_or_stencil(format)) {
Chia-I Wu52b07e72015-10-27 19:55:05 +08001224 if ((pSubresource->aspectMask != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1225 (pSubresource->aspectMask != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001226 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001227 ss << "vkGetImageSubresourceLayout: For depth/stencil formats, the aspectMask selects either the depth or stencil "
1228 "image aspectMask.";
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001229 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 -07001230 (uint64_t)image, __LINE__, VALIDATION_ERROR_00741, "IMAGE", "%s. %s", ss.str().c_str(),
1231 validation_error_map[VALIDATION_ERROR_00741]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001232 }
1233 }
1234 }
1235
Dustin Graves080069b2016-04-05 13:48:15 -06001236 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001237 device_data->device_dispatch_table->GetImageSubresourceLayout(device, image, pSubresource, pLayout);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001238 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001239}
1240
Chia-I Wu4935c762016-04-28 14:01:30 +08001241VKAPI_ATTR void VKAPI_CALL
1242GetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice, VkPhysicalDeviceProperties *pProperties) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001243 layer_data *phy_dev_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
1244 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceProperties(physicalDevice, pProperties);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -07001245}
1246
Chia-I Wub02600c2016-05-20 07:11:22 +08001247VKAPI_ATTR VkResult VKAPI_CALL
1248EnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) {
1249 return util_GetLayerProperties(1, &global_layer, pCount, pProperties);
1250}
1251
1252VKAPI_ATTR VkResult VKAPI_CALL
1253EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, VkLayerProperties *pProperties) {
1254 return util_GetLayerProperties(1, &global_layer, pCount, pProperties);
1255}
1256
1257VKAPI_ATTR VkResult VKAPI_CALL
1258EnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, VkExtensionProperties *pProperties) {
1259 if (pLayerName && !strcmp(pLayerName, global_layer.layerName))
1260 return util_GetExtensionProperties(1, instance_extensions, pCount, pProperties);
1261
1262 return VK_ERROR_LAYER_NOT_PRESENT;
1263}
1264
Chia-I Wu4935c762016-04-28 14:01:30 +08001265VKAPI_ATTR VkResult VKAPI_CALL EnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice,
1266 const char *pLayerName, uint32_t *pCount,
1267 VkExtensionProperties *pProperties) {
Chia-I Wueec9a312016-04-28 11:21:49 +08001268 // Image does not have any physical device extensions
Chia-I Wu3f326222016-04-28 14:21:13 +08001269 if (pLayerName && !strcmp(pLayerName, global_layer.layerName))
Chia-I Wueec9a312016-04-28 11:21:49 +08001270 return util_GetExtensionProperties(0, NULL, pCount, pProperties);
Chia-I Wu3f326222016-04-28 14:21:13 +08001271
1272 assert(physicalDevice);
1273
1274 dispatch_key key = get_dispatch_key(physicalDevice);
1275 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
1276 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
1277 return pTable->EnumerateDeviceExtensionProperties(physicalDevice, NULL, pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001278}
1279
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001280static PFN_vkVoidFunction
Chia-I Wu428eba02016-04-28 14:38:57 +08001281intercept_core_instance_command(const char *name);
1282static PFN_vkVoidFunction
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001283intercept_core_device_command(const char *name);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -06001284
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001285VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetDeviceProcAddr(VkDevice device, const char *funcName) {
1286 PFN_vkVoidFunction proc = intercept_core_device_command(funcName);
1287 if (proc)
1288 return proc;
1289
1290 assert(device);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001291
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001292 layer_data *my_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001293
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001294 VkLayerDispatchTable *pTable = my_data->device_dispatch_table;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001295 {
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -06001296 if (pTable->GetDeviceProcAddr == NULL)
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001297 return NULL;
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -06001298 return pTable->GetDeviceProcAddr(device, funcName);
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001299 }
1300}
1301
Chia-I Wu4935c762016-04-28 14:01:30 +08001302VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetInstanceProcAddr(VkInstance instance, const char *funcName) {
Chia-I Wu428eba02016-04-28 14:38:57 +08001303 PFN_vkVoidFunction proc = intercept_core_instance_command(funcName);
Chia-I Wuf89922c2016-04-28 15:16:59 +08001304 if (!proc)
1305 proc = intercept_core_device_command(funcName);
Chia-I Wu428eba02016-04-28 14:38:57 +08001306 if (proc)
1307 return proc;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001308
Chia-I Wuf89922c2016-04-28 15:16:59 +08001309 assert(instance);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001310 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001311
Chia-I Wuf89922c2016-04-28 15:16:59 +08001312 proc = debug_report_get_instance_proc_addr(my_data->report_data, funcName);
1313 if (proc)
1314 return proc;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001315
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001316 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001317 if (pTable->GetInstanceProcAddr == NULL)
1318 return NULL;
1319 return pTable->GetInstanceProcAddr(instance, funcName);
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001320}
Chia-I Wueec9a312016-04-28 11:21:49 +08001321
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001322static PFN_vkVoidFunction
Chia-I Wu428eba02016-04-28 14:38:57 +08001323intercept_core_instance_command(const char *name) {
1324 static const struct {
1325 const char *name;
1326 PFN_vkVoidFunction proc;
1327 } core_instance_commands[] = {
1328 { "vkGetInstanceProcAddr", reinterpret_cast<PFN_vkVoidFunction>(GetInstanceProcAddr) },
1329 { "vkCreateInstance", reinterpret_cast<PFN_vkVoidFunction>(CreateInstance) },
1330 { "vkDestroyInstance", reinterpret_cast<PFN_vkVoidFunction>(DestroyInstance) },
1331 { "vkCreateDevice", reinterpret_cast<PFN_vkVoidFunction>(CreateDevice) },
Chia-I Wub02600c2016-05-20 07:11:22 +08001332 { "vkEnumerateInstanceLayerProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateInstanceLayerProperties) },
1333 { "vkEnumerateDeviceLayerProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateDeviceLayerProperties) },
1334 { "vkEnumerateInstanceExtensionProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateInstanceExtensionProperties) },
Chia-I Wu428eba02016-04-28 14:38:57 +08001335 { "vkEnumerateDeviceExtensionProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateDeviceExtensionProperties) },
1336 { "vkGetPhysicalDeviceProperties", reinterpret_cast<PFN_vkVoidFunction>(GetPhysicalDeviceProperties) },
1337 };
1338
1339 for (size_t i = 0; i < ARRAY_SIZE(core_instance_commands); i++) {
1340 if (!strcmp(core_instance_commands[i].name, name))
1341 return core_instance_commands[i].proc;
1342 }
1343
1344 return nullptr;
1345}
1346
1347static PFN_vkVoidFunction
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001348intercept_core_device_command(const char *name) {
1349 static const struct {
1350 const char *name;
1351 PFN_vkVoidFunction proc;
1352 } core_device_commands[] = {
Tobin Ehlis16239872016-10-26 10:42:49 -06001353 {"vkGetDeviceProcAddr", reinterpret_cast<PFN_vkVoidFunction>(GetDeviceProcAddr)},
1354 {"vkDestroyDevice", reinterpret_cast<PFN_vkVoidFunction>(DestroyDevice)},
1355 {"vkCreateImage", reinterpret_cast<PFN_vkVoidFunction>(CreateImage)},
1356 {"vkDestroyImage", reinterpret_cast<PFN_vkVoidFunction>(DestroyImage)},
1357 {"vkCreateRenderPass", reinterpret_cast<PFN_vkVoidFunction>(CreateRenderPass)},
1358 {"vkCmdClearColorImage", reinterpret_cast<PFN_vkVoidFunction>(CmdClearColorImage)},
1359 {"vkCmdClearDepthStencilImage", reinterpret_cast<PFN_vkVoidFunction>(CmdClearDepthStencilImage)},
1360 {"vkCmdClearAttachments", reinterpret_cast<PFN_vkVoidFunction>(CmdClearAttachments)},
1361 {"vkCmdCopyImage", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyImage)},
1362 {"vkCmdCopyImageToBuffer", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyImageToBuffer)},
1363 {"vkCmdCopyBufferToImage", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyBufferToImage)},
1364 {"vkCmdBlitImage", reinterpret_cast<PFN_vkVoidFunction>(CmdBlitImage)},
1365 {"vkCmdPipelineBarrier", reinterpret_cast<PFN_vkVoidFunction>(CmdPipelineBarrier)},
1366 {"vkCmdResolveImage", reinterpret_cast<PFN_vkVoidFunction>(CmdResolveImage)},
1367 {"vkGetImageSubresourceLayout", reinterpret_cast<PFN_vkVoidFunction>(GetImageSubresourceLayout)},
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001368 };
1369
1370 for (size_t i = 0; i < ARRAY_SIZE(core_device_commands); i++) {
1371 if (!strcmp(core_device_commands[i].name, name))
1372 return core_device_commands[i].proc;
1373 }
1374
1375 return nullptr;
1376}
1377
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001378} // namespace image
1379
1380// vk_layer_logging.h expects these to be defined
1381
1382VKAPI_ATTR VkResult VKAPI_CALL
1383vkCreateDebugReportCallbackEXT(VkInstance instance, const VkDebugReportCallbackCreateInfoEXT *pCreateInfo,
1384 const VkAllocationCallbacks *pAllocator, VkDebugReportCallbackEXT *pMsgCallback) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001385 return image::CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001386}
1387
1388VKAPI_ATTR void VKAPI_CALL
1389vkDestroyDebugReportCallbackEXT(VkInstance instance,
1390 VkDebugReportCallbackEXT msgCallback,
1391 const VkAllocationCallbacks *pAllocator) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001392 image::DestroyDebugReportCallbackEXT(instance, msgCallback, pAllocator);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001393}
1394
1395VKAPI_ATTR void VKAPI_CALL
1396vkDebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objType, uint64_t object,
1397 size_t location, int32_t msgCode, const char *pLayerPrefix, const char *pMsg) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001398 image::DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix, pMsg);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001399}
1400
Chia-I Wub02600c2016-05-20 07:11:22 +08001401// loader-layer interface v0, just wrappers since there is only a layer
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001402
Chia-I Wueec9a312016-04-28 11:21:49 +08001403VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL
1404vkEnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, VkExtensionProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001405 return image::EnumerateInstanceExtensionProperties(pLayerName, pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001406}
1407
1408VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL
1409vkEnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001410 return image::EnumerateInstanceLayerProperties(pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001411}
1412
1413VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL
1414vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, VkLayerProperties *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);
1417 return image::EnumerateDeviceLayerProperties(VK_NULL_HANDLE, pCount, pProperties);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001418}
1419
1420VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice,
1421 const char *pLayerName, uint32_t *pCount,
1422 VkExtensionProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001423 // the layer command handles VK_NULL_HANDLE just fine internally
1424 assert(physicalDevice == VK_NULL_HANDLE);
Chia-I Wu3f326222016-04-28 14:21:13 +08001425 return image::EnumerateDeviceExtensionProperties(VK_NULL_HANDLE, pLayerName, pCount, pProperties);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001426}
1427
1428VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001429 return image::GetDeviceProcAddr(dev, funcName);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001430}
1431
1432VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001433 return image::GetInstanceProcAddr(instance, funcName);
Chia-I Wueec9a312016-04-28 11:21:49 +08001434}