blob: 373ae37e35d86789d2c4e8f93a36588181b1ac15 [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>
Jeremy Hayes9cc31582015-06-18 10:12:39 -060039
Tobin Ehlisb835d1b2015-07-03 10:34:49 -060040#include "vk_loader_platform.h"
Courtney Goeltzenleuchter8f8367e2015-10-07 08:38:30 -060041#include "vk_dispatch_table_helper.h"
42#include "vk_struct_string_helper_cpp.h"
Courtney Goeltzenleuchter8f8367e2015-10-07 08:38:30 -060043#include "image.h"
44#include "vk_layer_config.h"
45#include "vk_layer_extension_utils.h"
Tobin Ehlisa0cb02e2015-07-03 10:15:26 -060046#include "vk_layer_table.h"
47#include "vk_layer_data.h"
Courtney Goeltzenleuchter426e1872015-07-07 11:18:30 -060048#include "vk_layer_extension_utils.h"
Mike Stroyana3082432015-09-25 13:39:21 -060049#include "vk_layer_utils.h"
Courtney Goeltzenleuchter8f8367e2015-10-07 08:38:30 -060050#include "vk_layer_logging.h"
Mark Lobodzinski69b52fe2016-10-14 11:43:06 -060051#include "vk_validation_error_messages.h"
Jeremy Hayes9cc31582015-06-18 10:12:39 -060052
Mark Muelleraab36502016-05-03 13:17:29 -060053using namespace std;
54
Chia-I Wuaacb0fc2016-04-28 11:27:46 +080055namespace image {
56
Cody Northrop55443ef2015-09-28 15:09:32 -060057struct layer_data {
Chia-I Wu2cfc77c2016-04-28 16:04:15 +080058 VkInstance instance;
59
Jon Ashburn5484e0c2016-03-08 17:48:44 -070060 debug_report_data *report_data;
61 vector<VkDebugReportCallbackEXT> logging_callback;
62 VkLayerDispatchTable *device_dispatch_table;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -070063 VkLayerInstanceDispatchTable *instance_dispatch_table;
Jon Ashburn5484e0c2016-03-08 17:48:44 -070064 VkPhysicalDevice physicalDevice;
65 VkPhysicalDeviceProperties physicalDeviceProperties;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -070066
Chia-I Wue2fc5522015-10-26 20:04:44 +080067 unordered_map<VkImage, IMAGE_STATE> imageMap;
Cody Northrop55443ef2015-09-28 15:09:32 -060068
Jon Ashburn5484e0c2016-03-08 17:48:44 -070069 layer_data()
70 : report_data(nullptr), device_dispatch_table(nullptr), instance_dispatch_table(nullptr), physicalDevice(0),
71 physicalDeviceProperties(){};
Cody Northrop55443ef2015-09-28 15:09:32 -060072};
Jeremy Hayes9cc31582015-06-18 10:12:39 -060073
Jon Ashburn5484e0c2016-03-08 17:48:44 -070074static unordered_map<void *, layer_data *> layer_data_map;
Jeremy Hayese0ed6a22016-04-08 09:53:54 -060075static std::mutex global_lock;
Jeremy Hayes9cc31582015-06-18 10:12:39 -060076
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -060077static void init_image(layer_data *my_data, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -060078 layer_debug_actions(my_data->report_data, my_data->logging_callback, pAllocator, "lunarg_image");
Jeremy Hayes9cc31582015-06-18 10:12:39 -060079}
80
Tobin Ehlisf4d352b2016-05-19 09:59:30 -060081static IMAGE_STATE const *getImageState(layer_data const *dev_data, VkImage image) {
82 auto it = dev_data->imageMap.find(image);
83 if (it == dev_data->imageMap.end()) {
84 return nullptr;
85 }
86 return &it->second;
87}
88
Chia-I Wu4935c762016-04-28 14:01:30 +080089VKAPI_ATTR VkResult VKAPI_CALL
90CreateDebugReportCallbackEXT(VkInstance instance, const VkDebugReportCallbackCreateInfoEXT *pCreateInfo,
91 const VkAllocationCallbacks *pAllocator, VkDebugReportCallbackEXT *pMsgCallback) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -070092 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
93 VkResult res = my_data->instance_dispatch_table->CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback);
Jeremy Hayes9cc31582015-06-18 10:12:39 -060094 if (res == VK_SUCCESS) {
Mark Lobodzinski97c4d512016-05-19 15:27:18 -060095 res = layer_create_msg_callback(my_data->report_data, false, pCreateInfo, pAllocator, pMsgCallback);
Jeremy Hayes9cc31582015-06-18 10:12:39 -060096 }
97 return res;
98}
99
Chia-I Wu4935c762016-04-28 14:01:30 +0800100VKAPI_ATTR void VKAPI_CALL DestroyDebugReportCallbackEXT(VkInstance instance,
101 VkDebugReportCallbackEXT msgCallback,
102 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700103 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
104 my_data->instance_dispatch_table->DestroyDebugReportCallbackEXT(instance, msgCallback, pAllocator);
Courtney Goeltzenleuchter05854bf2015-11-30 12:13:14 -0700105 layer_destroy_msg_callback(my_data->report_data, msgCallback, pAllocator);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600106}
107
Chia-I Wu4935c762016-04-28 14:01:30 +0800108VKAPI_ATTR void VKAPI_CALL
109DebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objType, uint64_t object,
110 size_t location, int32_t msgCode, const char *pLayerPrefix, const char *pMsg) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700111 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700112 my_data->instance_dispatch_table->DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix,
113 pMsg);
Courtney Goeltzenleuchterf0de7242015-12-01 14:10:55 -0700114}
115
Chia-I Wu4935c762016-04-28 14:01:30 +0800116VKAPI_ATTR VkResult VKAPI_CALL
117CreateInstance(const VkInstanceCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkInstance *pInstance) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700118 VkLayerInstanceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600119
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700120 assert(chain_info->u.pLayerInfo);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700121 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700122 PFN_vkCreateInstance fpCreateInstance = (PFN_vkCreateInstance)fpGetInstanceProcAddr(NULL, "vkCreateInstance");
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700123 if (fpCreateInstance == NULL) {
124 return VK_ERROR_INITIALIZATION_FAILED;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600125 }
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700126
127 // Advance the link info for the next element on the chain
128 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
129
130 VkResult result = fpCreateInstance(pCreateInfo, pAllocator, pInstance);
131 if (result != VK_SUCCESS)
132 return result;
133
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700134 layer_data *my_data = get_my_data_ptr(get_dispatch_key(*pInstance), layer_data_map);
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800135 my_data->instance = *pInstance;
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700136 my_data->instance_dispatch_table = new VkLayerInstanceDispatchTable;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700137 layer_init_instance_dispatch_table(*pInstance, my_data->instance_dispatch_table, fpGetInstanceProcAddr);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700138
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700139 my_data->report_data = debug_report_create_instance(my_data->instance_dispatch_table, *pInstance,
140 pCreateInfo->enabledExtensionCount, pCreateInfo->ppEnabledExtensionNames);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700141
Mark Lobodzinski1079e1b2016-03-15 14:21:59 -0600142 init_image(my_data, pAllocator);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700143
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600144 return result;
145}
146
Chia-I Wu4935c762016-04-28 14:01:30 +0800147VKAPI_ATTR void VKAPI_CALL DestroyInstance(VkInstance instance, const VkAllocationCallbacks *pAllocator) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600148 // Grab the key before the instance is destroyed.
149 dispatch_key key = get_dispatch_key(instance);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600150 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
151 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
Chia-I Wuf7458c52015-10-26 21:10:41 +0800152 pTable->DestroyInstance(instance, pAllocator);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600153
154 // Clean up logging callback, if any
Courtney Goeltzenleuchterffcdd8b2015-10-05 15:59:11 -0600155 while (my_data->logging_callback.size() > 0) {
Courtney Goeltzenleuchter7415d5a2015-12-09 15:48:16 -0700156 VkDebugReportCallbackEXT callback = my_data->logging_callback.back();
Courtney Goeltzenleuchter05854bf2015-11-30 12:13:14 -0700157 layer_destroy_msg_callback(my_data->report_data, callback, pAllocator);
Courtney Goeltzenleuchterffcdd8b2015-10-05 15:59:11 -0600158 my_data->logging_callback.pop_back();
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600159 }
160
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600161 layer_debug_report_destroy_instance(my_data->report_data);
162 delete my_data->instance_dispatch_table;
163 layer_data_map.erase(key);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600164}
165
Chia-I Wu4935c762016-04-28 14:01:30 +0800166VKAPI_ATTR VkResult VKAPI_CALL CreateDevice(VkPhysicalDevice physicalDevice,
167 const VkDeviceCreateInfo *pCreateInfo,
168 const VkAllocationCallbacks *pAllocator, VkDevice *pDevice) {
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800169 layer_data *my_instance_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700170 VkLayerDeviceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700171
172 assert(chain_info->u.pLayerInfo);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700173 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
174 PFN_vkGetDeviceProcAddr fpGetDeviceProcAddr = chain_info->u.pLayerInfo->pfnNextGetDeviceProcAddr;
Chia-I Wu2cfc77c2016-04-28 16:04:15 +0800175 PFN_vkCreateDevice fpCreateDevice = (PFN_vkCreateDevice)fpGetInstanceProcAddr(my_instance_data->instance, "vkCreateDevice");
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700176 if (fpCreateDevice == NULL) {
177 return VK_ERROR_INITIALIZATION_FAILED;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600178 }
179
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700180 // Advance the link info for the next element on the chain
181 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
182
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700183 VkResult result = fpCreateDevice(physicalDevice, pCreateInfo, pAllocator, pDevice);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700184 if (result != VK_SUCCESS) {
185 return result;
186 }
187
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700188 layer_data *my_device_data = get_my_data_ptr(get_dispatch_key(*pDevice), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700189
190 // Setup device dispatch table
191 my_device_data->device_dispatch_table = new VkLayerDispatchTable;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700192 layer_init_device_dispatch_table(*pDevice, my_device_data->device_dispatch_table, fpGetDeviceProcAddr);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700193
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700194 my_device_data->report_data = layer_debug_report_create_device(my_instance_data->report_data, *pDevice);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -0700195 my_device_data->physicalDevice = physicalDevice;
196
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700197 my_instance_data->instance_dispatch_table->GetPhysicalDeviceProperties(physicalDevice,
198 &(my_device_data->physicalDeviceProperties));
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700199
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600200 return result;
201}
202
Chia-I Wu4935c762016-04-28 14:01:30 +0800203VKAPI_ATTR void VKAPI_CALL DestroyDevice(VkDevice device, const VkAllocationCallbacks *pAllocator) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600204 dispatch_key key = get_dispatch_key(device);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600205 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
Chia-I Wuf7458c52015-10-26 21:10:41 +0800206 my_data->device_dispatch_table->DestroyDevice(device, pAllocator);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -0600207 delete my_data->device_dispatch_table;
208 layer_data_map.erase(key);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600209}
210
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700211static const VkExtensionProperties instance_extensions[] = {{VK_EXT_DEBUG_REPORT_EXTENSION_NAME, VK_EXT_DEBUG_REPORT_SPEC_VERSION}};
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600212
Chia-I Wu740891e2016-04-28 14:12:27 +0800213static const VkLayerProperties global_layer = {
Jon Ashburndc9111c2016-03-22 12:57:13 -0600214 "VK_LAYER_LUNARG_image", VK_LAYER_API_VERSION, 1, "LunarG Validation Layer",
Chia-I Wu740891e2016-04-28 14:12:27 +0800215};
Courtney Goeltzenleuchter52857662015-12-01 14:08:28 -0700216
Mark Lobodzinski2fd634c2015-07-29 09:21:22 -0600217// Start of the Image layer proper
218
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600219VKAPI_ATTR VkResult VKAPI_CALL CreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
220 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
221 bool skip_call = false;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700222 VkResult result = VK_ERROR_VALIDATION_FAILED_EXT;
Michael Lentine0a369f62016-02-03 16:51:46 -0600223 VkImageFormatProperties ImageFormatProperties;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700224
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700225 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
226 VkPhysicalDevice physicalDevice = device_data->physicalDevice;
227 layer_data *phy_dev_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700228
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700229 if (pCreateInfo->format != VK_FORMAT_UNDEFINED) {
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600230 VkFormatProperties properties;
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700231 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceFormatProperties(device_data->physicalDevice, pCreateInfo->format,
232 &properties);
Dave Houlton34df4cb2016-12-01 16:43:06 -0700233 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) && (properties.linearTilingFeatures == 0)) {
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600234 std::stringstream ss;
235 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600236 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 -0700237 0, __LINE__, VALIDATION_ERROR_02150, "IMAGE", "%s. %s", ss.str().c_str(),
238 validation_error_map[VALIDATION_ERROR_02150]);
239 }
240
241 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) && (properties.optimalTilingFeatures == 0)) {
242 std::stringstream ss;
243 ss << "vkCreateImage format parameter (" << string_VkFormat(pCreateInfo->format) << ") is an unsupported format";
244 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
245 0, __LINE__, VALIDATION_ERROR_02155, "IMAGE", "%s. %s", ss.str().c_str(),
246 validation_error_map[VALIDATION_ERROR_02155]);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600247 }
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600248
249 // Validate that format supports usage as color attachment
250 if (pCreateInfo->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) {
251 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
252 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
253 std::stringstream ss;
254 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
255 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700256 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
257 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02158, "IMAGE",
258 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02158]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600259 }
260 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
261 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT) == 0)) {
262 std::stringstream ss;
263 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
264 << ") does not support requested Image usage type VK_IMAGE_USAGE_COLOR_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700265 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
266 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02153, "IMAGE",
267 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02153]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600268 }
269 }
270 // Validate that format supports usage as depth/stencil attachment
271 if (pCreateInfo->usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) {
272 if ((pCreateInfo->tiling == VK_IMAGE_TILING_OPTIMAL) &&
273 ((properties.optimalTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
274 std::stringstream ss;
275 ss << "vkCreateImage: VkFormat for TILING_OPTIMAL image (" << string_VkFormat(pCreateInfo->format)
276 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700277 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
278 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02159, "IMAGE",
279 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02159]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600280 }
281 if ((pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) &&
282 ((properties.linearTilingFeatures & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0)) {
283 std::stringstream ss;
284 ss << "vkCreateImage: VkFormat for TILING_LINEAR image (" << string_VkFormat(pCreateInfo->format)
285 << ") does not support requested Image usage type VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700286 skip_call |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
287 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, __LINE__, VALIDATION_ERROR_02154, "IMAGE",
288 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_02154]);
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600289 }
290 }
291 } else {
292 skip_call |=
293 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 -0700294 VALIDATION_ERROR_00715, "IMAGE", "vkCreateImage: VkFormat for image must not be VK_FORMAT_UNDEFINED. %s",
295 validation_error_map[VALIDATION_ERROR_00715]);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600296 }
297
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700298 // Internal call to get format info. Still goes through layers, could potentially go directly to ICD.
299 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceImageFormatProperties(
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700300 physicalDevice, pCreateInfo->format, pCreateInfo->imageType, pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
301 &ImageFormatProperties);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600302
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700303 VkDeviceSize imageGranularity = device_data->physicalDeviceProperties.limits.bufferImageGranularity;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700304 imageGranularity = imageGranularity == 1 ? 0 : imageGranularity;
305
Mark Youngc48c4c12016-04-11 14:26:49 -0600306 // Make sure all required dimension are non-zero at least.
307 bool failedMinSize = false;
308 switch (pCreateInfo->imageType) {
309 case VK_IMAGE_TYPE_3D:
310 if (pCreateInfo->extent.depth == 0) {
311 failedMinSize = true;
312 }
313 // Intentional fall-through
314 case VK_IMAGE_TYPE_2D:
315 if (pCreateInfo->extent.height == 0) {
316 failedMinSize = true;
317 }
318 // Intentional fall-through
319 case VK_IMAGE_TYPE_1D:
320 if (pCreateInfo->extent.width == 0) {
321 failedMinSize = true;
322 }
323 break;
324 default:
325 break;
326 }
Dave Houlton34df4cb2016-12-01 16:43:06 -0700327 // TODO: VALIDATION_ERROR_00716
328 // 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 -0600329 if (failedMinSize) {
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600330 skip_call |=
Dave Houlton34df4cb2016-12-01 16:43:06 -0700331 log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
332 IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
Mark Youngc48c4c12016-04-11 14:26:49 -0600333 "CreateImage extents is 0 for at least one required dimension for image of type %d: "
334 "Width = %d Height = %d Depth = %d.",
335 pCreateInfo->imageType, pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth);
336 }
337
Dave Houlton34df4cb2016-12-01 16:43:06 -0700338 // TODO: VALIDATION_ERROR_02125 VALIDATION_ERROR_02126 VALIDATION_ERROR_02128 VALIDATION_ERROR_00720
339 // All these extent-related VUs should be checked here
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700340 if ((pCreateInfo->extent.depth > ImageFormatProperties.maxExtent.depth) ||
341 (pCreateInfo->extent.width > ImageFormatProperties.maxExtent.width) ||
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700342 (pCreateInfo->extent.height > ImageFormatProperties.maxExtent.height)) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700343 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
344 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
345 "CreateImage extents exceed allowable limits for format: "
346 "Width = %d Height = %d Depth = %d: Limits for Width = %d Height = %d Depth = %d for format %s.",
347 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->extent.depth,
348 ImageFormatProperties.maxExtent.width, ImageFormatProperties.maxExtent.height,
349 ImageFormatProperties.maxExtent.depth, string_VkFormat(pCreateInfo->format));
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700350 }
351
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700352 uint64_t totalSize = ((uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
353 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
354 (uint64_t)pCreateInfo->samples * (uint64_t)vk_format_get_size(pCreateInfo->format) +
355 (uint64_t)imageGranularity) &
356 ~(uint64_t)imageGranularity;
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700357
358 if (totalSize > ImageFormatProperties.maxResourceSize) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700359 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
360 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
361 "CreateImage resource size exceeds allowable maximum "
362 "Image resource size = 0x%" PRIxLEAST64 ", maximum resource size = 0x%" PRIxLEAST64 " ",
363 totalSize, ImageFormatProperties.maxResourceSize);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700364 }
365
Dave Houlton34df4cb2016-12-01 16:43:06 -0700366 // TODO: VALIDATION_ERROR_02132
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700367 if (pCreateInfo->mipLevels > ImageFormatProperties.maxMipLevels) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700368 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
369 __LINE__, IMAGE_INVALID_FORMAT_LIMITS_VIOLATION, "Image",
370 "CreateImage mipLevels=%d exceeds allowable maximum supported by format of %d", pCreateInfo->mipLevels,
371 ImageFormatProperties.maxMipLevels);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700372 }
373
374 if (pCreateInfo->arrayLayers > ImageFormatProperties.maxArrayLayers) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700375 skip_call |= log_msg(
376 phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
377 VALIDATION_ERROR_02133, "Image", "CreateImage arrayLayers=%d exceeds allowable maximum supported by format of %d. %s",
378 pCreateInfo->arrayLayers, ImageFormatProperties.maxArrayLayers, validation_error_map[VALIDATION_ERROR_02133]);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700379 }
380
381 if ((pCreateInfo->samples & ImageFormatProperties.sampleCounts) == 0) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700382 skip_call |=
383 log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, __LINE__,
384 VALIDATION_ERROR_02138, "Image", "CreateImage samples %s is not supported by format 0x%.8X. %s",
385 string_VkSampleCountFlagBits(pCreateInfo->samples), ImageFormatProperties.sampleCounts,
386 validation_error_map[VALIDATION_ERROR_02138]);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700387 }
388
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700389 if (pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_PREINITIALIZED) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700390 skip_call |= log_msg(phy_dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
391 __LINE__, VALIDATION_ERROR_00731, "Image",
392 "vkCreateImage parameter, pCreateInfo->initialLayout, must be VK_IMAGE_LAYOUT_UNDEFINED or "
393 "VK_IMAGE_LAYOUT_PREINITIALIZED. %s",
394 validation_error_map[VALIDATION_ERROR_00731]);
Jeremy Hayesffc8a702016-03-01 14:01:45 -0700395 }
396
Mark Lobodzinski9d1d6b12016-05-17 08:42:03 -0600397 if (!skip_call) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700398 result = device_data->device_dispatch_table->CreateImage(device, pCreateInfo, pAllocator, pImage);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -0700399 }
400 if (result == VK_SUCCESS) {
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600401 std::lock_guard<std::mutex> lock(global_lock);
Chia-I Wue2fc5522015-10-26 20:04:44 +0800402 device_data->imageMap[*pImage] = IMAGE_STATE(pCreateInfo);
Tobin Ehlisad8c4462015-09-21 15:20:28 -0600403 }
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600404 return result;
405}
406
Chia-I Wu4935c762016-04-28 14:01:30 +0800407VKAPI_ATTR void VKAPI_CALL DestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700408 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600409 std::unique_lock<std::mutex> lock(global_lock);
Chia-I Wue2fc5522015-10-26 20:04:44 +0800410 device_data->imageMap.erase(image);
Jeremy Hayese0ed6a22016-04-08 09:53:54 -0600411 lock.unlock();
Chia-I Wuf7458c52015-10-26 21:10:41 +0800412 device_data->device_dispatch_table->DestroyImage(device, image, pAllocator);
Tobin Ehlisad8c4462015-09-21 15:20:28 -0600413}
414
Chia-I Wu4935c762016-04-28 14:01:30 +0800415VKAPI_ATTR VkResult VKAPI_CALL CreateRenderPass(VkDevice device, const VkRenderPassCreateInfo *pCreateInfo,
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600416 const VkAllocationCallbacks *pAllocator, VkRenderPass *pRenderPass) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700417 layer_data *my_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600418 bool skip_call = false;
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600419
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700420 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
Mark Lobodzinski27ced8b2016-08-05 11:30:15 -0600421 if (pCreateInfo->pAttachments[i].format == VK_FORMAT_UNDEFINED) {
422 std::stringstream ss;
423 ss << "vkCreateRenderPass: pCreateInfo->pAttachments[" << i << "].format is VK_FORMAT_UNDEFINED";
424 skip_call |= log_msg(my_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0, __LINE__,
425 IMAGE_RENDERPASS_INVALID_ATTACHMENT, "IMAGE", "%s", ss.str().c_str());
426 }
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600427 }
428
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600429 if (skip_call) {
Courtney Goeltzenleuchter52fee652015-12-10 16:41:22 -0700430 return VK_ERROR_VALIDATION_FAILED_EXT;
Mark Lobodzinskif2eabc82016-08-05 11:20:21 -0600431 }
Mark Lobodzinski2fd634c2015-07-29 09:21:22 -0600432
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700433 VkResult result = my_data->device_dispatch_table->CreateRenderPass(device, pCreateInfo, pAllocator, pRenderPass);
Jeremy Hayes9cc31582015-06-18 10:12:39 -0600434
435 return result;
436}
437
Dave Houlton34df4cb2016-12-01 16:43:06 -0700438VKAPI_ATTR void VKAPI_CALL CmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
439 const VkClearColorValue *pColor, uint32_t rangeCount,
440 const VkImageSubresourceRange *pRanges) {
Dustin Graves080069b2016-04-05 13:48:15 -0600441 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700442 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Jeremy Hayesa4dc0ac2016-03-01 16:51:02 -0700443
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700444 if (imageLayout != VK_IMAGE_LAYOUT_GENERAL && imageLayout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700445 char const str[] =
446 "vkCmdClearColorImage parameter, imageLayout, must be VK_IMAGE_LAYOUT_GENERAL or VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL";
Jeremy Hayesa4dc0ac2016-03-01 16:51:02 -0700447 skipCall |= 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 -0700448 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_01086, "IMAGE", "%s. %s", str,
449 validation_error_map[VALIDATION_ERROR_01086]);
Jeremy Hayesa4dc0ac2016-03-01 16:51:02 -0700450 }
451
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600452 // For each range, image aspect must be color only
Dave Houlton34df4cb2016-12-01 16:43:06 -0700453 // TODO: this is a 'must' in the spec, so there should be a VU enum for it
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600454 for (uint32_t i = 0; i < rangeCount; i++) {
455 if (pRanges[i].aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700456 char const str[] =
457 "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
458 skipCall |=
459 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
460 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600461 }
462 }
463
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600464 auto image_state = getImageState(device_data, image);
465 if (image_state) {
466 if (vk_format_is_depth_or_stencil(image_state->format)) {
467 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
468 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700469 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01088, "IMAGE", "%s. %s", str,
470 validation_error_map[VALIDATION_ERROR_01088]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600471 } else if (vk_format_is_compressed(image_state->format)) {
472 char const str[] = "vkCmdClearColorImage called with compressed image.";
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_01088, "IMAGE", "%s. %s", str,
475 validation_error_map[VALIDATION_ERROR_01088]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600476 }
Tony Barbour26434b92016-06-02 09:43:50 -0600477
478 if (!(image_state->usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
479 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
480 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 -0700481 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01084, "IMAGE", "%s. %s", str,
482 validation_error_map[VALIDATION_ERROR_01084]);
Tony Barbour26434b92016-06-02 09:43:50 -0600483 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600484 }
485
Dustin Graves080069b2016-04-05 13:48:15 -0600486 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700487 device_data->device_dispatch_table->CmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600488 }
489}
490
Dave Houlton34df4cb2016-12-01 16:43:06 -0700491VKAPI_ATTR void VKAPI_CALL CmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
492 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
493 const VkImageSubresourceRange *pRanges) {
Dustin Graves080069b2016-04-05 13:48:15 -0600494 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700495 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600496 // For each range, Image aspect must be depth or stencil or both
497 for (uint32_t i = 0; i < rangeCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700498 if (((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
499 ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700500 char const str[] = "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be "
501 "set to VK_IMAGE_ASPECT_DEPTH_BIT and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700502 skipCall |=
503 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
504 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", str);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600505 }
506 }
507
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600508 auto image_state = getImageState(device_data, image);
509 if (image_state && !vk_format_is_depth_or_stencil(image_state->format)) {
510 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
511 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 -0700512 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01103, "IMAGE", "%s. %s", str,
513 validation_error_map[VALIDATION_ERROR_01103]);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600514 }
515
Dustin Graves080069b2016-04-05 13:48:15 -0600516 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700517 device_data->device_dispatch_table->CmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount,
518 pRanges);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600519 }
520}
521
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600522// Returns true if [x, xoffset] and [y, yoffset] overlap
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600523static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600524 bool result = false;
525 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
526 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
527
528 if (intersection_max > intersection_min) {
529 result = true;
530 }
531 return result;
532}
533
534// Returns true if two VkImageCopy structures overlap
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600535static bool RegionIntersects(const VkImageCopy *src, const VkImageCopy *dst, VkImageType type) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600536 bool result = true;
537 if ((src->srcSubresource.mipLevel == dst->dstSubresource.mipLevel) &&
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600538 (RangesIntersect(src->srcSubresource.baseArrayLayer, src->srcSubresource.layerCount, dst->dstSubresource.baseArrayLayer,
539 dst->dstSubresource.layerCount))) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600540
541 switch (type) {
542 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600543 result &= RangesIntersect(src->srcOffset.z, src->extent.depth, dst->dstOffset.z, dst->extent.depth);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600544 // Intentionally fall through to 2D case
545 case VK_IMAGE_TYPE_2D:
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600546 result &= RangesIntersect(src->srcOffset.y, src->extent.height, dst->dstOffset.y, dst->extent.height);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600547 // Intentionally fall through to 1D case
548 case VK_IMAGE_TYPE_1D:
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600549 result &= RangesIntersect(src->srcOffset.x, src->extent.width, dst->dstOffset.x, dst->extent.width);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600550 break;
551 default:
552 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
553 assert(false);
554 }
555 }
556 return result;
557}
558
559// Returns true if offset and extent exceed image extents
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600560static bool ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const IMAGE_STATE *image) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600561 bool result = false;
562 // Extents/depths cannot be negative but checks left in for clarity
Mark Lobodzinski39573d22016-10-14 10:59:27 -0600563 switch (image->imageType) {
564 case VK_IMAGE_TYPE_3D: // Validate z and depth
565 if ((offset->z + extent->depth > image->extent.depth) || (offset->z < 0) ||
566 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
567 result = true;
568 }
569 // Intentionally fall through to 2D case to check height
570 case VK_IMAGE_TYPE_2D: // Validate y and height
571 if ((offset->y + extent->height > image->extent.height) || (offset->y < 0) ||
572 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
573 result = true;
574 }
575 // Intentionally fall through to 1D case to check width
576 case VK_IMAGE_TYPE_1D: // Validate x and width
577 if ((offset->x + extent->width > image->extent.width) || (offset->x < 0) ||
578 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
579 result = true;
580 }
581 break;
582 default:
583 assert(false);
584 }
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600585 return result;
586}
587
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600588bool PreCallValidateCmdCopyImage(VkCommandBuffer command_buffer, VkImage src_image, VkImage dst_image, uint32_t region_count,
589 const VkImageCopy *regions) {
590 bool skip = false;
591 layer_data *device_data = get_my_data_ptr(get_dispatch_key(command_buffer), layer_data_map);
592 auto src_image_entry = getImageState(device_data, src_image);
593 auto dst_image_entry = getImageState(device_data, dst_image);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600594
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600595 // TODO: This does not cover swapchain-created images. This should fall out when this layer is moved
596 // into the core_validation layer
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600597 if (src_image_entry && dst_image_entry) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600598
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600599 for (uint32_t i = 0; i < region_count; i++) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600600
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600601 if (regions[i].srcSubresource.layerCount == 0) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600602 std::stringstream ss;
603 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] srcSubresource is zero";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600604 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
605 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t &>(command_buffer),
606 __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600607 }
608
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600609 if (regions[i].dstSubresource.layerCount == 0) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600610 std::stringstream ss;
611 ss << "vkCmdCopyImage: number of layers in pRegions[" << i << "] dstSubresource is zero";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600612 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
613 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t &>(command_buffer),
614 __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600615 }
616
617 // For each region the layerCount member of srcSubresource and dstSubresource must match
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600618 if (regions[i].srcSubresource.layerCount != regions[i].dstSubresource.layerCount) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600619 std::stringstream ss;
620 ss << "vkCmdCopyImage: number of layers in source and destination subresources for pRegions[" << i
621 << "] do not match";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600622 skip |=
Mark Lobodzinskia9a69ad2016-10-14 12:13:33 -0600623 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 -0600624 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01198, "IMAGE", "%s. %s",
Mark Lobodzinskia9a69ad2016-10-14 12:13:33 -0600625 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01198]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600626 }
627
628 // For each region, the aspectMask member of srcSubresource and dstSubresource must match
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600629 if (regions[i].srcSubresource.aspectMask != regions[i].dstSubresource.aspectMask) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600630 char const str[] = "vkCmdCopyImage: Src and dest aspectMasks for each region must match";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600631 skip |=
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600632 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 -0700633 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01197, "IMAGE", "%s. %s", str,
634 validation_error_map[VALIDATION_ERROR_01197]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600635 }
636
637 // AspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600638 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) ||
639 (regions[i].dstSubresource.aspectMask & VK_IMAGE_ASPECT_METADATA_BIT)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600640 std::stringstream ss;
641 ss << "vkCmdCopyImage: pRegions[" << i << "] may not specify aspectMask containing VK_IMAGE_ASPECT_METADATA_BIT";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700642 skip |=
643 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
644 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01222, "IMAGE", "%s. %s",
645 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01222]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600646 }
647
648 // For each region, if aspectMask contains VK_IMAGE_ASPECT_COLOR_BIT, it must not contain either of
649 // VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600650 if ((regions[i].srcSubresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
651 (regions[i].srcSubresource.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600652 char const str[] = "vkCmdCopyImage aspectMask cannot specify both COLOR and DEPTH/STENCIL aspects";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600653 skip |=
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600654 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 -0700655 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01221, "IMAGE", "%s. %s", str,
656 validation_error_map[VALIDATION_ERROR_01221]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600657 }
658
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600659 // 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 -0600660 // the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600661 if (((src_image_entry->imageType == VK_IMAGE_TYPE_3D) || (dst_image_entry->imageType == VK_IMAGE_TYPE_3D)) &&
662 ((regions[i].srcSubresource.baseArrayLayer != 0) || (regions[i].srcSubresource.layerCount != 1) ||
663 (regions[i].dstSubresource.baseArrayLayer != 0) || (regions[i].dstSubresource.layerCount != 1))) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600664 std::stringstream ss;
665 ss << "vkCmdCopyImage: src or dstImage type was IMAGE_TYPE_3D, but in subRegion[" << i
666 << "] baseArrayLayer was not zero or layerCount was not 1.";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700667 skip |=
668 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
669 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01199, "IMAGE", "%s. %s",
670 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01199]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600671 }
672
673 // MipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600674 if (regions[i].srcSubresource.mipLevel >= src_image_entry->mipLevels) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600675 std::stringstream ss;
676 ss << "vkCmdCopyImage: pRegions[" << i
677 << "] specifies a src mipLevel greater than the number specified when the srcImage was created.";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700678 skip |=
679 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
680 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
681 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600682 }
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600683 if (regions[i].dstSubresource.mipLevel >= dst_image_entry->mipLevels) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600684 std::stringstream ss;
685 ss << "vkCmdCopyImage: pRegions[" << i
686 << "] specifies a dst mipLevel greater than the number specified when the dstImage was created.";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700687 skip |=
688 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
689 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01223, "IMAGE", "%s. %s",
690 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01223]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600691 }
692
693 // (baseArrayLayer + layerCount) must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the
694 // image was created
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600695 if ((regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount) > src_image_entry->arraySize) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600696 std::stringstream ss;
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600697 ss << "vkCmdCopyImage: srcImage arrayLayers was " << src_image_entry->arraySize << " but subRegion[" << i
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600698 << "] baseArrayLayer + layerCount is "
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600699 << (regions[i].srcSubresource.baseArrayLayer + regions[i].srcSubresource.layerCount);
Dave Houlton34df4cb2016-12-01 16:43:06 -0700700 skip |=
701 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
702 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
703 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600704 }
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600705 if ((regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount) > dst_image_entry->arraySize) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600706 std::stringstream ss;
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600707 ss << "vkCmdCopyImage: dstImage arrayLayers was " << dst_image_entry->arraySize << " but subRegion[" << i
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600708 << "] baseArrayLayer + layerCount is "
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600709 << (regions[i].dstSubresource.baseArrayLayer + regions[i].dstSubresource.layerCount);
Dave Houlton34df4cb2016-12-01 16:43:06 -0700710 skip |=
711 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
712 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01224, "IMAGE", "%s. %s",
713 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01224]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600714 }
715
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600716 // The source region specified by a given element of regions must be a region that is contained within srcImage
717 if (ExceedsBounds(&regions[i].srcOffset, &regions[i].extent, src_image_entry)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600718 std::stringstream ss;
719 ss << "vkCmdCopyImage: srcSubResource in pRegions[" << i << "] exceeds extents srcImage was created with";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600720 skip |=
Mark Lobodzinski8ea6eb02016-10-14 11:40:31 -0600721 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 -0600722 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01175, "IMAGE", "%s. %s",
Tobin Ehlis15edfa82016-10-18 07:31:22 -0600723 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01175]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600724 }
725
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600726 // The destination region specified by a given element of regions must be a region that is contained within dst_image
727 if (ExceedsBounds(&regions[i].dstOffset, &regions[i].extent, dst_image_entry)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600728 std::stringstream ss;
729 ss << "vkCmdCopyImage: dstSubResource in pRegions[" << i << "] exceeds extents dstImage was created with";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600730 skip |=
Mark Lobodzinski8ea6eb02016-10-14 11:40:31 -0600731 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 -0600732 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01176, "IMAGE", "%s. %s",
Mark Lobodzinski8ea6eb02016-10-14 11:40:31 -0600733 ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01176]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600734 }
735
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600736 // 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 -0600737 // must not overlap in memory
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600738 if (src_image == dst_image) {
739 for (uint32_t j = 0; j < region_count; j++) {
740 if (RegionIntersects(&regions[i], &regions[j], src_image_entry->imageType)) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600741 std::stringstream ss;
742 ss << "vkCmdCopyImage: pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Dave Houlton34df4cb2016-12-01 16:43:06 -0700743 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
744 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
745 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01177, "IMAGE",
746 "%s. %s", ss.str().c_str(), validation_error_map[VALIDATION_ERROR_01177]);
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600747 }
748 }
749 }
Mike Stroyana3082432015-09-25 13:39:21 -0600750 }
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600751
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600752 // 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 -0600753 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
754 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600755 if (vk_format_is_depth_or_stencil(src_image_entry->format) || vk_format_is_depth_or_stencil(dst_image_entry->format)) {
756 if (src_image_entry->format != dst_image_entry->format) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700757 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600758 skip |=
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700759 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 -0600760 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, IMAGE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mike Stroyana3082432015-09-25 13:39:21 -0600761 }
762 } else {
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600763 size_t srcSize = vk_format_get_size(src_image_entry->format);
764 size_t destSize = vk_format_get_size(dst_image_entry->format);
Mike Stroyana3082432015-09-25 13:39:21 -0600765 if (srcSize != destSize) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700766 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600767 skip |=
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700768 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 -0600769 reinterpret_cast<uint64_t &>(command_buffer), __LINE__, VALIDATION_ERROR_01184, "IMAGE", "%s. %s", str,
Tobin Ehlis15edfa82016-10-18 07:31:22 -0600770 validation_error_map[VALIDATION_ERROR_01184]);
Mike Stroyana3082432015-09-25 13:39:21 -0600771 }
772 }
773 }
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600774 return skip;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600775}
776
Chia-I Wu4935c762016-04-28 14:01:30 +0800777VKAPI_ATTR void VKAPI_CALL CmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage,
778 VkImageLayout srcImageLayout, VkImage dstImage,
779 VkImageLayout dstImageLayout, uint32_t regionCount,
780 const VkImageCopy *pRegions) {
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600781
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600782 bool skip = false;
Mark Lobodzinskib2ad7022016-03-29 17:10:14 -0600783 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
784
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600785 skip = PreCallValidateCmdCopyImage(commandBuffer, srcImage, dstImage, regionCount, pRegions);
Mike Stroyana3082432015-09-25 13:39:21 -0600786
Mark Lobodzinskia9920fb2016-10-14 13:09:48 -0600787 if (!skip) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700788 device_data->device_dispatch_table->CmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
789 regionCount, pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600790 }
791}
792
Chia-I Wu4935c762016-04-28 14:01:30 +0800793VKAPI_ATTR void VKAPI_CALL CmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
794 const VkClearAttachment *pAttachments, uint32_t rectCount,
795 const VkClearRect *pRects) {
Dustin Graves080069b2016-04-05 13:48:15 -0600796 bool skipCall = false;
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600797 VkImageAspectFlags aspectMask;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700798 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600799 for (uint32_t i = 0; i < attachmentCount; i++) {
800 aspectMask = pAttachments[i].aspectMask;
Dave Houlton34df4cb2016-12-01 16:43:06 -0700801 if (0 == aspectMask) {
802 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
803 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
804 VALIDATION_ERROR_01128, "IMAGE", "%s", validation_error_map[VALIDATION_ERROR_01128]);
805 } else if (aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
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_01126, "IMAGE", "%s", validation_error_map[VALIDATION_ERROR_01126]);
809 } else if (aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
810 if ((aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) || (aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700811 char const str[] =
Dave Houlton34df4cb2016-12-01 16:43:06 -0700812 "vkCmdClearAttachments aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment. %s";
813 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
814 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
815 VALIDATION_ERROR_01125, "IMAGE", str, i, validation_error_map[VALIDATION_ERROR_01125]);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600816 }
817 } else {
Dave Houlton34df4cb2016-12-01 16:43:06 -0700818 // Having eliminated all other possibilities, image aspect must be depth or stencil or both
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700819 if (((aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
820 ((aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
821 char const str[] = "vkCmdClearAttachments aspectMask [%d] must be set to VK_IMAGE_ASPECT_DEPTH_BIT and/or "
Dave Houlton34df4cb2016-12-01 16:43:06 -0700822 "VK_IMAGE_ASPECT_STENCIL_BIT. %s";
823 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
824 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
825 VALIDATION_ERROR_01127, "IMAGE", str, i, validation_error_map[VALIDATION_ERROR_01127]);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600826 }
827 }
828 }
829
Dustin Graves080069b2016-04-05 13:48:15 -0600830 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700831 device_data->device_dispatch_table->CmdClearAttachments(commandBuffer, attachmentCount, pAttachments, rectCount, pRects);
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600832 }
833}
834
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700835static bool ValidateBufferImageCopyData(layer_data *dev_data, uint32_t regionCount, const VkBufferImageCopy *pRegions,
836 VkImage image, const char *function) {
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600837 bool skip = false;
838
839 for (uint32_t i = 0; i < regionCount; i++) {
840
841 auto image_info = getImageState(dev_data, image);
842 if (image_info) {
Mark Lobodzinski1bda8892016-11-22 14:46:39 -0700843
844 if ((image_info->imageType == VK_IMAGE_TYPE_1D) || (image_info->imageType == VK_IMAGE_TYPE_2D)) {
845 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
846 skip |= log_msg(dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
847 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01269, "IMAGE",
848 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. These must be 0 and 1, "
849 "respectively. %s",
850 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth,
851 validation_error_map[VALIDATION_ERROR_01269]);
852 }
853 }
854
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600855 // BufferOffset must be a multiple of the calling command's VkImage parameter's texel size
856 auto texel_size = vk_format_get_size(image_info->format);
857 if (vk_safe_modulo(pRegions[i].bufferOffset, texel_size) != 0) {
858 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 -0700859 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01263, "IMAGE",
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600860 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700861 " must be a multiple of this format's texel size (" PRINTF_SIZE_T_SPECIFIER "). %s",
862 function, i, pRegions[i].bufferOffset, texel_size, validation_error_map[VALIDATION_ERROR_01263]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600863 }
Mark Lobodzinski1bda8892016-11-22 14:46:39 -0700864
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600865 // BufferOffset must be a multiple of 4
866 if (vk_safe_modulo(pRegions[i].bufferOffset, 4) != 0) {
867 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 -0700868 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01264, "IMAGE",
869 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4. %s", function, i,
870 pRegions[i].bufferOffset, validation_error_map[VALIDATION_ERROR_01264]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600871 }
872
873 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
874 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
875 skip |= log_msg(
876 dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700877 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01265, "IMAGE",
878 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d). %s",
879 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width,
880 validation_error_map[VALIDATION_ERROR_01265]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600881 }
882
883 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
884 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
885 skip |= log_msg(
886 dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski576d8392016-11-22 10:44:37 -0700887 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01266, "IMAGE",
888 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d). %s",
889 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height,
890 validation_error_map[VALIDATION_ERROR_01266]);
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600891 }
Mark Lobodzinski040142c2016-11-22 11:18:46 -0700892
893 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700894 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
Mark Lobodzinski040142c2016-11-22 11:18:46 -0700895 if (aspect_mask_bits.count() != 1) {
896 skip |=
897 log_msg(dev_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
898 reinterpret_cast<uint64_t &>(image), __LINE__, VALIDATION_ERROR_01280, "IMAGE",
899 "%s: aspectMasks for imageSubresource in each region must have only a single bit set. %s", function,
900 validation_error_map[VALIDATION_ERROR_01280]);
901 }
Mark Lobodzinskia0efcdd2016-08-19 08:50:15 -0600902 }
903 }
904
905 return skip;
906}
907
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700908static bool PreCallValidateCmdCopyImageToBuffer(layer_data *dev_data, VkImage srcImage, uint32_t regionCount,
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700909 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700910 return ValidateBufferImageCopyData(dev_data, regionCount, pRegions, srcImage, "vkCmdCopyImageToBuffer");
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700911}
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600912
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700913VKAPI_ATTR void VKAPI_CALL CmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
914 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
915 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
916
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700917 if (!PreCallValidateCmdCopyImageToBuffer(device_data, srcImage, regionCount, pRegions, "vkCmdCopyImageToBuffer()")) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700918 device_data->device_dispatch_table->CmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount,
919 pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600920 }
921}
922
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700923static bool PreCallValidateCmdCopyBufferToImage(layer_data *dev_data, VkImage dstImage, uint32_t regionCount,
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700924 const VkBufferImageCopy *pRegions, const char *func_name) {
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700925 return ValidateBufferImageCopyData(dev_data, regionCount, pRegions, dstImage, "vkCmdCopyBufferToImage");
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700926}
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600927
Mark Lobodzinski39b83282016-11-22 09:33:23 -0700928VKAPI_ATTR void VKAPI_CALL CmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
929 VkImageLayout dstImageLayout, uint32_t regionCount,
930 const VkBufferImageCopy *pRegions) {
931 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
932
Mark Lobodzinski3702e932016-11-22 11:40:48 -0700933 if (!PreCallValidateCmdCopyBufferToImage(device_data, dstImage, regionCount, pRegions, "vkCmdCopyBufferToImage()")) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700934 device_data->device_dispatch_table->CmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount,
935 pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -0600936 }
937}
938
Dave Houlton34df4cb2016-12-01 16:43:06 -0700939VKAPI_ATTR void VKAPI_CALL CmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
940 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
941 const VkImageBlit *pRegions, VkFilter filter) {
Dustin Graves080069b2016-04-05 13:48:15 -0600942 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700943 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600944
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600945 // Warn for zero-sized regions
946 for (uint32_t i = 0; i < regionCount; i++) {
947 if ((pRegions[i].srcOffsets[0].x == pRegions[i].srcOffsets[1].x) ||
948 (pRegions[i].srcOffsets[0].y == pRegions[i].srcOffsets[1].y) ||
949 (pRegions[i].srcOffsets[0].z == pRegions[i].srcOffsets[1].z)) {
950 std::stringstream ss;
951 ss << "vkCmdBlitImage: pRegions[" << i << "].srcOffsets specify a zero-volume area.";
952 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700953 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(commandBuffer), __LINE__,
954 IMAGE_INVALID_EXTENTS, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600955 }
956 if ((pRegions[i].dstOffsets[0].x == pRegions[i].dstOffsets[1].x) ||
957 (pRegions[i].dstOffsets[0].y == pRegions[i].dstOffsets[1].y) ||
958 (pRegions[i].dstOffsets[0].z == pRegions[i].dstOffsets[1].z)) {
959 std::stringstream ss;
960 ss << "vkCmdBlitImage: pRegions[" << i << "].dstOffsets specify a zero-volume area.";
961 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT,
Dave Houlton34df4cb2016-12-01 16:43:06 -0700962 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, reinterpret_cast<uint64_t>(commandBuffer), __LINE__,
963 IMAGE_INVALID_EXTENTS, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinski1af172a2016-08-16 11:51:12 -0600964 }
965 }
966
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600967 auto srcImageEntry = getImageState(device_data, srcImage);
968 auto dstImageEntry = getImageState(device_data, dstImage);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600969
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600970 if (srcImageEntry && dstImageEntry) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600971
Tobin Ehlisf4d352b2016-05-19 09:59:30 -0600972 VkFormat srcFormat = srcImageEntry->format;
973 VkFormat dstFormat = dstImageEntry->format;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600974
Dave Houlton34df4cb2016-12-01 16:43:06 -0700975 // Validate consistency for unsigned formats
976 if (vk_format_is_uint(srcFormat) != vk_format_is_uint(dstFormat)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600977 std::stringstream ss;
Dave Houlton34df4cb2016-12-01 16:43:06 -0700978 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has unsigned integer format, "
979 << "the other one must also have unsigned integer format. "
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -0700980 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
Jon Ashburn5484e0c2016-03-08 17:48:44 -0700981 skipCall |=
982 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 -0700983 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02191, "IMAGE", "%s. %s", ss.str().c_str(),
984 validation_error_map[VALIDATION_ERROR_02191]);
985 }
986
987 // Validate consistency for signed formats
988 if (vk_format_is_sint(srcFormat) != vk_format_is_sint(dstFormat)) {
989 std::stringstream ss;
990 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has signed integer format, "
991 << "the other one must also have signed integer format. "
992 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
993 skipCall |=
994 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
995 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02190, "IMAGE", "%s. %s", ss.str().c_str(),
996 validation_error_map[VALIDATION_ERROR_02190]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -0600997 }
998
999 // Validate aspect bits and formats for depth/stencil images
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001000 if (vk_format_is_depth_or_stencil(srcFormat) || vk_format_is_depth_or_stencil(dstFormat)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001001 if (srcFormat != dstFormat) {
1002 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001003 ss << "vkCmdBlitImage: If one of srcImage and dstImage images has a format of depth, stencil or depth "
1004 << "stencil, the other one must have exactly the same format. "
1005 << "Source format is " << string_VkFormat(srcFormat) << " Destination format is " << string_VkFormat(dstFormat);
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001006 skipCall |=
1007 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 -07001008 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02192, "IMAGE", "%s. %s", ss.str().c_str(),
1009 validation_error_map[VALIDATION_ERROR_02192]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001010 }
1011
Dave Houlton34df4cb2016-12-01 16:43:06 -07001012 // TODO: Confirm that all these checks are intended to be nested under depth/stencil only
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001013 for (uint32_t i = 0; i < regionCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001014 if (pRegions[i].srcSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001015 char const str[] = "vkCmdBlitImage: number of layers in source subresource is zero";
1016 // 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 -07001017 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1018 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1019 IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001020 }
1021
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001022 if (pRegions[i].dstSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001023 char const str[] = "vkCmdBlitImage: number of layers in destination subresource is zero";
1024 // 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 -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
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001030 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001031 char const str[] = "vkCmdBlitImage: number of layers in source and destination subresources must match";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001032 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1033 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1034 IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001035 }
1036
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001037 VkImageAspectFlags srcAspect = pRegions[i].srcSubresource.aspectMask;
1038 VkImageAspectFlags dstAspect = pRegions[i].dstSubresource.aspectMask;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001039
1040 if (srcAspect != dstAspect) {
1041 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001042 ss << "vkCmdBlitImage: Image aspects of depth/stencil images should match";
1043 // 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 -07001044 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1045 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1046 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001047 }
1048 if (vk_format_is_depth_and_stencil(srcFormat)) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001049 if ((srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001050 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001051 ss << "vkCmdBlitImage: Combination depth/stencil image formats must have only one of "
1052 "VK_IMAGE_ASPECT_DEPTH_BIT "
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001053 << "and VK_IMAGE_ASPECT_STENCIL_BIT set in srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001054 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1055 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1056 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001057 }
1058 } else if (vk_format_is_stencil_only(srcFormat)) {
1059 if (srcAspect != VK_IMAGE_ASPECT_STENCIL_BIT) {
1060 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001061 ss << "vkCmdBlitImage: Stencil-only image formats must have only the VK_IMAGE_ASPECT_STENCIL_BIT "
Chia-I Wu3432a0c2015-10-27 18:04:07 +08001062 << "set in both the srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001063 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1064 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1065 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001066 }
1067 } else if (vk_format_is_depth_only(srcFormat)) {
1068 if (srcAspect != VK_IMAGE_ASPECT_DEPTH_BIT) {
1069 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001070 ss << "vkCmdBlitImage: Depth-only image formats must have only the VK_IMAGE_ASPECT_DEPTH "
Chia-I Wu3432a0c2015-10-27 18:04:07 +08001071 << "set in both the srcImage and dstImage";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001072 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1073 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1074 IMAGE_INVALID_IMAGE_ASPECT, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001075 }
1076 }
1077 }
1078 }
1079
1080 // Validate filter
Dave Houlton34df4cb2016-12-01 16:43:06 -07001081 if (vk_format_is_depth_or_stencil(srcFormat) && (filter != VK_FILTER_NEAREST)) {
1082 std::stringstream ss;
1083 ss << "vkCmdBlitImage: If the format of srcImage is a depth, stencil, or depth stencil "
1084 << "then filter must be VK_FILTER_NEAREST.";
1085 skipCall |=
1086 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1087 (uint64_t)commandBuffer, __LINE__, VALIDATION_ERROR_02193, "IMAGE", "%s. %s", ss.str().c_str(),
1088 validation_error_map[VALIDATION_ERROR_02193]);
1089 }
1090 if (vk_format_is_int(srcFormat) && (filter != VK_FILTER_NEAREST)) {
1091 std::stringstream ss;
1092 ss << "vkCmdBlitImage: If the format of srcImage is an integer-based format "
1093 << "then filter must be VK_FILTER_NEAREST.";
1094 skipCall |=
1095 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1096 (uint64_t)commandBuffer, __LINE__, IMAGE_INVALID_FILTER, "IMAGE", "%s", ss.str().c_str());
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001097 }
1098 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001099
Tony Barbourf8309102016-05-05 10:50:21 -06001100 if (!skipCall) {
Dave Houlton34df4cb2016-12-01 16:43:06 -07001101 device_data->device_dispatch_table->CmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
1102 regionCount, pRegions, filter);
Tony Barbourf8309102016-05-05 10:50:21 -06001103 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001104}
1105
Chia-I Wu4935c762016-04-28 14:01:30 +08001106VKAPI_ATTR void VKAPI_CALL
1107CmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
1108 VkDependencyFlags dependencyFlags, uint32_t memoryBarrierCount, const VkMemoryBarrier *pMemoryBarriers,
1109 uint32_t bufferMemoryBarrierCount, const VkBufferMemoryBarrier *pBufferMemoryBarriers,
1110 uint32_t imageMemoryBarrierCount, const VkImageMemoryBarrier *pImageMemoryBarriers) {
Dustin Graves080069b2016-04-05 13:48:15 -06001111 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001112 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Jeremy Hayes01b38892015-11-17 18:19:55 -07001113
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001114 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
1115 VkImageMemoryBarrier const *const barrier = (VkImageMemoryBarrier const *const) & pImageMemoryBarriers[i];
Dave Houlton34df4cb2016-12-01 16:43:06 -07001116 // TODO: add VALIDATION_ERROR_00309 (sType == VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER) here
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001117 if (barrier->sType == VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER) {
Dave Houlton34df4cb2016-12-01 16:43:06 -07001118 // TODO: this check should include VALIDATION_ERROR_00301 and VALIDATION_ERROR_00316
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001119 if (barrier->subresourceRange.layerCount == 0) {
Jeremy Hayes01b38892015-11-17 18:19:55 -07001120 std::stringstream ss;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001121 ss << "vkCmdPipelineBarrier called with 0 in ppMemoryBarriers[" << i << "]->subresourceRange.layerCount.";
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001122 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, (VkDebugReportObjectTypeEXT)0, 0,
1123 __LINE__, IMAGE_INVALID_IMAGE_RESOURCE, "IMAGE", "%s", ss.str().c_str());
Jeremy Hayes01b38892015-11-17 18:19:55 -07001124 }
1125 }
1126 }
1127
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001128 if (skipCall) {
Jeremy Hayes01b38892015-11-17 18:19:55 -07001129 return;
1130 }
1131
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001132 device_data->device_dispatch_table->CmdPipelineBarrier(commandBuffer, srcStageMask, dstStageMask, dependencyFlags,
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001133 memoryBarrierCount, pMemoryBarriers, bufferMemoryBarrierCount,
1134 pBufferMemoryBarriers, imageMemoryBarrierCount, pImageMemoryBarriers);
Jeremy Hayes01b38892015-11-17 18:19:55 -07001135}
1136
Dave Houlton34df4cb2016-12-01 16:43:06 -07001137VKAPI_ATTR void VKAPI_CALL CmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
1138 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
1139 const VkImageResolve *pRegions) {
Dustin Graves080069b2016-04-05 13:48:15 -06001140 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001141 layer_data *device_data = get_my_data_ptr(get_dispatch_key(commandBuffer), layer_data_map);
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001142 auto srcImageEntry = getImageState(device_data, srcImage);
1143 auto dstImageEntry = getImageState(device_data, dstImage);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001144
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001145 // For each region, the number of layers in the image subresource should not be zero
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001146 // For each region, src and dest image aspect must be color only
1147 for (uint32_t i = 0; i < regionCount; i++) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001148 if (pRegions[i].srcSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001149 char const str[] = "vkCmdResolveImage: number of layers in source subresource is zero";
1150 // TODO: Verify against Valid Use section of spec. Generally if something yield an undefined result, it's invalid/error
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001151 skipCall |=
1152 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1153 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001154 }
1155
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001156 if (pRegions[i].dstSubresource.layerCount == 0) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001157 char const str[] = "vkCmdResolveImage: number of layers in destination subresource is zero";
Courtney Goeltzenleuchter7415d5a2015-12-09 15:48:16 -07001158
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001159 // 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 -07001160 skipCall |=
1161 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1162 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_ASPECT, "IMAGE", str);
Jeremy Hayes148bab22015-10-28 13:01:39 -06001163 }
1164
Dave Houlton34df4cb2016-12-01 16:43:06 -07001165 // TODO: VALIDATION_ERROR_01339
1166
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001167 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001168 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001169 char const str[] =
1170 "vkCmdResolveImage: src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001171 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1172 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1173 VALIDATION_ERROR_01338, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01338]);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001174 }
1175 }
1176
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001177 if (srcImageEntry && dstImageEntry) {
1178 if (srcImageEntry->format != dstImageEntry->format) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001179 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
1180 skipCall |=
1181 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1182 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_FORMAT, "IMAGE", str);
Mike Stroyana3082432015-09-25 13:39:21 -06001183 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001184 if (srcImageEntry->imageType != dstImageEntry->imageType) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001185 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
1186 skipCall |=
1187 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1188 (uint64_t)commandBuffer, __LINE__, IMAGE_MISMATCHED_IMAGE_TYPE, "IMAGE", str);
Mike Stroyana3082432015-09-25 13:39:21 -06001189 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001190 if (srcImageEntry->samples == VK_SAMPLE_COUNT_1_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001191 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001192 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1193 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1194 VALIDATION_ERROR_01320, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01320]);
Mike Stroyana3082432015-09-25 13:39:21 -06001195 }
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001196 if (dstImageEntry->samples != VK_SAMPLE_COUNT_1_BIT) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001197 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Dave Houlton34df4cb2016-12-01 16:43:06 -07001198 skipCall |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT,
1199 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)commandBuffer, __LINE__,
1200 VALIDATION_ERROR_01321, "IMAGE", "%s. %s", str, validation_error_map[VALIDATION_ERROR_01321]);
Mike Stroyana3082432015-09-25 13:39:21 -06001201 }
1202 }
1203
Dustin Graves080069b2016-04-05 13:48:15 -06001204 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001205 device_data->device_dispatch_table->CmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
1206 regionCount, pRegions);
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001207 }
1208}
1209
Dave Houlton34df4cb2016-12-01 16:43:06 -07001210VKAPI_ATTR void VKAPI_CALL GetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
1211 VkSubresourceLayout *pLayout) {
Dustin Graves080069b2016-04-05 13:48:15 -06001212 bool skipCall = false;
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001213 layer_data *device_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001214 VkFormat format;
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001215
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001216 auto imageEntry = getImageState(device_data, image);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001217
1218 // Validate that image aspects match formats
Tobin Ehlisf4d352b2016-05-19 09:59:30 -06001219 if (imageEntry) {
1220 format = imageEntry->format;
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001221 if (vk_format_is_color(format)) {
Chia-I Wu52b07e72015-10-27 19:55:05 +08001222 if (pSubresource->aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001223 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001224 ss << "vkGetImageSubresourceLayout: For color formats, the aspectMask field of VkImageSubresource must be "
1225 "VK_IMAGE_ASPECT_COLOR.";
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001226 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 -07001227 (uint64_t)image, __LINE__, VALIDATION_ERROR_00741, "IMAGE", "%s. %s", ss.str().c_str(),
1228 validation_error_map[VALIDATION_ERROR_00741]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001229 }
1230 } else if (vk_format_is_depth_or_stencil(format)) {
Chia-I Wu52b07e72015-10-27 19:55:05 +08001231 if ((pSubresource->aspectMask != VK_IMAGE_ASPECT_DEPTH_BIT) &&
1232 (pSubresource->aspectMask != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001233 std::stringstream ss;
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001234 ss << "vkGetImageSubresourceLayout: For depth/stencil formats, the aspectMask selects either the depth or stencil "
1235 "image aspectMask.";
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001236 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 -07001237 (uint64_t)image, __LINE__, VALIDATION_ERROR_00741, "IMAGE", "%s. %s", ss.str().c_str(),
1238 validation_error_map[VALIDATION_ERROR_00741]);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001239 }
1240 }
1241 }
1242
Dustin Graves080069b2016-04-05 13:48:15 -06001243 if (!skipCall) {
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001244 device_data->device_dispatch_table->GetImageSubresourceLayout(device, image, pSubresource, pLayout);
Mark Lobodzinskidc86b852015-10-23 14:20:31 -06001245 }
Mark Lobodzinskia5eabe72015-10-05 17:16:05 -06001246}
1247
Chia-I Wu4935c762016-04-28 14:01:30 +08001248VKAPI_ATTR void VKAPI_CALL
1249GetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice, VkPhysicalDeviceProperties *pProperties) {
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001250 layer_data *phy_dev_data = get_my_data_ptr(get_dispatch_key(physicalDevice), layer_data_map);
1251 phy_dev_data->instance_dispatch_table->GetPhysicalDeviceProperties(physicalDevice, pProperties);
Mark Lobodzinskid5a23822015-11-12 15:14:35 -07001252}
1253
Chia-I Wub02600c2016-05-20 07:11:22 +08001254VKAPI_ATTR VkResult VKAPI_CALL
1255EnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) {
1256 return util_GetLayerProperties(1, &global_layer, pCount, pProperties);
1257}
1258
1259VKAPI_ATTR VkResult VKAPI_CALL
1260EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, VkLayerProperties *pProperties) {
1261 return util_GetLayerProperties(1, &global_layer, pCount, pProperties);
1262}
1263
1264VKAPI_ATTR VkResult VKAPI_CALL
1265EnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, VkExtensionProperties *pProperties) {
1266 if (pLayerName && !strcmp(pLayerName, global_layer.layerName))
1267 return util_GetExtensionProperties(1, instance_extensions, pCount, pProperties);
1268
1269 return VK_ERROR_LAYER_NOT_PRESENT;
1270}
1271
Chia-I Wu4935c762016-04-28 14:01:30 +08001272VKAPI_ATTR VkResult VKAPI_CALL EnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice,
1273 const char *pLayerName, uint32_t *pCount,
1274 VkExtensionProperties *pProperties) {
Chia-I Wueec9a312016-04-28 11:21:49 +08001275 // Image does not have any physical device extensions
Chia-I Wu3f326222016-04-28 14:21:13 +08001276 if (pLayerName && !strcmp(pLayerName, global_layer.layerName))
Chia-I Wueec9a312016-04-28 11:21:49 +08001277 return util_GetExtensionProperties(0, NULL, pCount, pProperties);
Chia-I Wu3f326222016-04-28 14:21:13 +08001278
1279 assert(physicalDevice);
1280
1281 dispatch_key key = get_dispatch_key(physicalDevice);
1282 layer_data *my_data = get_my_data_ptr(key, layer_data_map);
1283 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
1284 return pTable->EnumerateDeviceExtensionProperties(physicalDevice, NULL, pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001285}
1286
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001287static PFN_vkVoidFunction
Chia-I Wu428eba02016-04-28 14:38:57 +08001288intercept_core_instance_command(const char *name);
1289static PFN_vkVoidFunction
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001290intercept_core_device_command(const char *name);
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -06001291
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001292VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetDeviceProcAddr(VkDevice device, const char *funcName) {
1293 PFN_vkVoidFunction proc = intercept_core_device_command(funcName);
1294 if (proc)
1295 return proc;
1296
1297 assert(device);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001298
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001299 layer_data *my_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001300
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001301 VkLayerDispatchTable *pTable = my_data->device_dispatch_table;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001302 {
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -06001303 if (pTable->GetDeviceProcAddr == NULL)
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001304 return NULL;
Tobin Ehlisb74f6ab2015-10-29 14:19:18 -06001305 return pTable->GetDeviceProcAddr(device, funcName);
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001306 }
1307}
1308
Chia-I Wu4935c762016-04-28 14:01:30 +08001309VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetInstanceProcAddr(VkInstance instance, const char *funcName) {
Chia-I Wu428eba02016-04-28 14:38:57 +08001310 PFN_vkVoidFunction proc = intercept_core_instance_command(funcName);
Chia-I Wuf89922c2016-04-28 15:16:59 +08001311 if (!proc)
1312 proc = intercept_core_device_command(funcName);
Chia-I Wu428eba02016-04-28 14:38:57 +08001313 if (proc)
1314 return proc;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001315
Chia-I Wuf89922c2016-04-28 15:16:59 +08001316 assert(instance);
Mark Lobodzinski1ed594e2016-02-03 09:57:14 -07001317 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map);
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001318
Chia-I Wuf89922c2016-04-28 15:16:59 +08001319 proc = debug_report_get_instance_proc_addr(my_data->report_data, funcName);
1320 if (proc)
1321 return proc;
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001322
Jon Ashburn5484e0c2016-03-08 17:48:44 -07001323 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
Courtney Goeltzenleuchter00150eb2016-01-08 12:18:43 -07001324 if (pTable->GetInstanceProcAddr == NULL)
1325 return NULL;
1326 return pTable->GetInstanceProcAddr(instance, funcName);
Jeremy Hayes9cc31582015-06-18 10:12:39 -06001327}
Chia-I Wueec9a312016-04-28 11:21:49 +08001328
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001329static PFN_vkVoidFunction
Chia-I Wu428eba02016-04-28 14:38:57 +08001330intercept_core_instance_command(const char *name) {
1331 static const struct {
1332 const char *name;
1333 PFN_vkVoidFunction proc;
1334 } core_instance_commands[] = {
1335 { "vkGetInstanceProcAddr", reinterpret_cast<PFN_vkVoidFunction>(GetInstanceProcAddr) },
1336 { "vkCreateInstance", reinterpret_cast<PFN_vkVoidFunction>(CreateInstance) },
1337 { "vkDestroyInstance", reinterpret_cast<PFN_vkVoidFunction>(DestroyInstance) },
1338 { "vkCreateDevice", reinterpret_cast<PFN_vkVoidFunction>(CreateDevice) },
Chia-I Wub02600c2016-05-20 07:11:22 +08001339 { "vkEnumerateInstanceLayerProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateInstanceLayerProperties) },
1340 { "vkEnumerateDeviceLayerProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateDeviceLayerProperties) },
1341 { "vkEnumerateInstanceExtensionProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateInstanceExtensionProperties) },
Chia-I Wu428eba02016-04-28 14:38:57 +08001342 { "vkEnumerateDeviceExtensionProperties", reinterpret_cast<PFN_vkVoidFunction>(EnumerateDeviceExtensionProperties) },
1343 { "vkGetPhysicalDeviceProperties", reinterpret_cast<PFN_vkVoidFunction>(GetPhysicalDeviceProperties) },
1344 };
1345
1346 for (size_t i = 0; i < ARRAY_SIZE(core_instance_commands); i++) {
1347 if (!strcmp(core_instance_commands[i].name, name))
1348 return core_instance_commands[i].proc;
1349 }
1350
1351 return nullptr;
1352}
1353
1354static PFN_vkVoidFunction
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001355intercept_core_device_command(const char *name) {
1356 static const struct {
1357 const char *name;
1358 PFN_vkVoidFunction proc;
1359 } core_device_commands[] = {
Tobin Ehlis16239872016-10-26 10:42:49 -06001360 {"vkGetDeviceProcAddr", reinterpret_cast<PFN_vkVoidFunction>(GetDeviceProcAddr)},
1361 {"vkDestroyDevice", reinterpret_cast<PFN_vkVoidFunction>(DestroyDevice)},
1362 {"vkCreateImage", reinterpret_cast<PFN_vkVoidFunction>(CreateImage)},
1363 {"vkDestroyImage", reinterpret_cast<PFN_vkVoidFunction>(DestroyImage)},
1364 {"vkCreateRenderPass", reinterpret_cast<PFN_vkVoidFunction>(CreateRenderPass)},
1365 {"vkCmdClearColorImage", reinterpret_cast<PFN_vkVoidFunction>(CmdClearColorImage)},
1366 {"vkCmdClearDepthStencilImage", reinterpret_cast<PFN_vkVoidFunction>(CmdClearDepthStencilImage)},
1367 {"vkCmdClearAttachments", reinterpret_cast<PFN_vkVoidFunction>(CmdClearAttachments)},
1368 {"vkCmdCopyImage", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyImage)},
1369 {"vkCmdCopyImageToBuffer", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyImageToBuffer)},
1370 {"vkCmdCopyBufferToImage", reinterpret_cast<PFN_vkVoidFunction>(CmdCopyBufferToImage)},
1371 {"vkCmdBlitImage", reinterpret_cast<PFN_vkVoidFunction>(CmdBlitImage)},
1372 {"vkCmdPipelineBarrier", reinterpret_cast<PFN_vkVoidFunction>(CmdPipelineBarrier)},
1373 {"vkCmdResolveImage", reinterpret_cast<PFN_vkVoidFunction>(CmdResolveImage)},
1374 {"vkGetImageSubresourceLayout", reinterpret_cast<PFN_vkVoidFunction>(GetImageSubresourceLayout)},
Chia-I Wu64df8ed2016-04-28 14:38:57 +08001375 };
1376
1377 for (size_t i = 0; i < ARRAY_SIZE(core_device_commands); i++) {
1378 if (!strcmp(core_device_commands[i].name, name))
1379 return core_device_commands[i].proc;
1380 }
1381
1382 return nullptr;
1383}
1384
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001385} // namespace image
1386
1387// vk_layer_logging.h expects these to be defined
1388
1389VKAPI_ATTR VkResult VKAPI_CALL
1390vkCreateDebugReportCallbackEXT(VkInstance instance, const VkDebugReportCallbackCreateInfoEXT *pCreateInfo,
1391 const VkAllocationCallbacks *pAllocator, VkDebugReportCallbackEXT *pMsgCallback) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001392 return image::CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001393}
1394
1395VKAPI_ATTR void VKAPI_CALL
1396vkDestroyDebugReportCallbackEXT(VkInstance instance,
1397 VkDebugReportCallbackEXT msgCallback,
1398 const VkAllocationCallbacks *pAllocator) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001399 image::DestroyDebugReportCallbackEXT(instance, msgCallback, pAllocator);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001400}
1401
1402VKAPI_ATTR void VKAPI_CALL
1403vkDebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objType, uint64_t object,
1404 size_t location, int32_t msgCode, const char *pLayerPrefix, const char *pMsg) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001405 image::DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix, pMsg);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001406}
1407
Chia-I Wub02600c2016-05-20 07:11:22 +08001408// loader-layer interface v0, just wrappers since there is only a layer
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001409
Chia-I Wueec9a312016-04-28 11:21:49 +08001410VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL
1411vkEnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, VkExtensionProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001412 return image::EnumerateInstanceExtensionProperties(pLayerName, pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001413}
1414
1415VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL
1416vkEnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001417 return image::EnumerateInstanceLayerProperties(pCount, pProperties);
Chia-I Wueec9a312016-04-28 11:21:49 +08001418}
1419
1420VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL
1421vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, VkLayerProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001422 // the layer command handles VK_NULL_HANDLE just fine internally
1423 assert(physicalDevice == VK_NULL_HANDLE);
1424 return image::EnumerateDeviceLayerProperties(VK_NULL_HANDLE, pCount, pProperties);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001425}
1426
1427VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice,
1428 const char *pLayerName, uint32_t *pCount,
1429 VkExtensionProperties *pProperties) {
Chia-I Wub02600c2016-05-20 07:11:22 +08001430 // the layer command handles VK_NULL_HANDLE just fine internally
1431 assert(physicalDevice == VK_NULL_HANDLE);
Chia-I Wu3f326222016-04-28 14:21:13 +08001432 return image::EnumerateDeviceExtensionProperties(VK_NULL_HANDLE, pLayerName, pCount, pProperties);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001433}
1434
1435VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001436 return image::GetDeviceProcAddr(dev, funcName);
Chia-I Wuaacb0fc2016-04-28 11:27:46 +08001437}
1438
1439VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) {
Chia-I Wu4935c762016-04-28 14:01:30 +08001440 return image::GetInstanceProcAddr(instance, funcName);
Chia-I Wueec9a312016-04-28 11:21:49 +08001441}