MoltenVK/MoltenVK/Commands/MVKCmdPipeline.mm - external/github.com/KhronosGroup/MoltenVK - Git at Google

 /*
  * MVKCmdPipeline.mm
  *
  * Copyright (c) 2015-2022 The Brenwill Workshop Ltd. (http://www.brenwill.com)
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 #include "MVKCmdPipeline.h"
 #include "MVKCommandBuffer.h"
 #include "MVKCommandPool.h"
 #include "MVKImage.h"
 #include "MVKBuffer.h"
 #include "MVKPipeline.h"
 #include "MVKFoundation.h"
 #include "MVKEnvironment.h"
 #include "mvk_datatypes.hpp"


 #pragma mark -
 #pragma mark MVKCmdPipelineBarrier

 template <size_t N>
 VkResult MVKCmdPipelineBarrier<N>::setContent(MVKCommandBuffer* cmdBuff,
 											  VkPipelineStageFlags srcStageMask,
 											  VkPipelineStageFlags dstStageMask,
 											  VkDependencyFlags dependencyFlags,
 											  uint32_t memoryBarrierCount,
 											  const VkMemoryBarrier* pMemoryBarriers,
 											  uint32_t bufferMemoryBarrierCount,
 											  const VkBufferMemoryBarrier* pBufferMemoryBarriers,
 											  uint32_t imageMemoryBarrierCount,
 											  const VkImageMemoryBarrier* pImageMemoryBarriers) {
 	_srcStageMask = srcStageMask;
 	_dstStageMask = dstStageMask;
 	_dependencyFlags = dependencyFlags;

 	_barriers.clear();	// Clear for reuse
 	_barriers.reserve(memoryBarrierCount + bufferMemoryBarrierCount + imageMemoryBarrierCount);

 	for (uint32_t i = 0; i < memoryBarrierCount; i++) {
 		_barriers.emplace_back(pMemoryBarriers[i]);
 	}
 	for (uint32_t i = 0; i < bufferMemoryBarrierCount; i++) {
 		_barriers.emplace_back(pBufferMemoryBarriers[i]);
 	}
 	for (uint32_t i = 0; i < imageMemoryBarrierCount; i++) {
 		_barriers.emplace_back(pImageMemoryBarriers[i]);
 	}

 	return VK_SUCCESS;
 }

 template <size_t N>
 void MVKCmdPipelineBarrier<N>::encode(MVKCommandEncoder* cmdEncoder) {

 #if MVK_MACOS
 	// Calls below invoke MTLBlitCommandEncoder so must apply this first.
 	// Check if pipeline barriers are available and we are in a renderpass.
 	if (cmdEncoder->getDevice()->_pMetalFeatures->memoryBarriers && cmdEncoder->_mtlRenderEncoder) {
 		MTLRenderStages srcStages = mvkMTLRenderStagesFromVkPipelineStageFlags(_srcStageMask, false);
 		MTLRenderStages dstStages = mvkMTLRenderStagesFromVkPipelineStageFlags(_dstStageMask, true);

 		id<MTLResource> resources[_barriers.size()];
 		uint32_t rezCnt = 0;

 		for (auto& b : _barriers) {
 			switch (b.type) {
 				case MVKPipelineBarrier::Memory: {
 					MTLBarrierScope scope = (mvkMTLBarrierScopeFromVkAccessFlags(b.srcAccessMask) |
 											 mvkMTLBarrierScopeFromVkAccessFlags(b.dstAccessMask));
 					[cmdEncoder->_mtlRenderEncoder memoryBarrierWithScope: scope
 															  afterStages: srcStages
 															 beforeStages: dstStages];
 					break;
 				}

 				case MVKPipelineBarrier::Buffer:
 					resources[rezCnt++] = b.mvkBuffer->getMTLBuffer();
 					break;

 				case MVKPipelineBarrier::Image:
                     for (uint8_t planeIndex = 0; planeIndex < b.mvkImage->getPlaneCount(); planeIndex++) {
                         resources[rezCnt++] = b.mvkImage->getMTLTexture(planeIndex);
                     }
 					break;

 				default:
 					break;
 			}
 		}

 		if (rezCnt) {
 			[cmdEncoder->_mtlRenderEncoder memoryBarrierWithResources: resources
 																count: rezCnt
 														  afterStages: srcStages
 														 beforeStages: dstStages];
 		}
 	} else if (cmdEncoder->getDevice()->_pMetalFeatures->textureBarriers) {
 #if !MVK_MACCAT
 		if (coversTextures()) { [cmdEncoder->_mtlRenderEncoder textureBarrier]; }
 #endif
 	}
 #endif

 	// Apple GPUs do not support renderpass barriers, and do not support rendering/writing
 	// to an attachment and then reading from that attachment within a single renderpass.
 	// So, in the case where we are inside a Metal renderpass, we need to split those activities
 	// into separate Metal renderpasses. Since this is a potentially expensive operation,
 	// verify that at least one attachment is being used both as an input and render attachment
 	// by checking for a VK_IMAGE_LAYOUT_GENERAL layout.
 	if (cmdEncoder->_mtlRenderEncoder && cmdEncoder->getDevice()->_pMetalFeatures->tileBasedDeferredRendering) {
 		bool needsRenderpassRestart = false;
 		for (auto& b : _barriers) {
 			if (b.type == MVKPipelineBarrier::Image && b.newLayout == VK_IMAGE_LAYOUT_GENERAL) {
 				needsRenderpassRestart = true;
 				break;
 			}
 		}
 		if (needsRenderpassRestart) {
 			cmdEncoder->encodeStoreActions(true);
 			cmdEncoder->beginMetalRenderPass(kMVKCommandUseRestartSubpass);
 		}
 	}

 	MVKDevice* mvkDvc = cmdEncoder->getDevice();
 	MVKCommandUse cmdUse = kMVKCommandUsePipelineBarrier;

 	for (auto& b : _barriers) {
 		switch (b.type) {
 			case MVKPipelineBarrier::Memory:
 				mvkDvc->applyMemoryBarrier(_srcStageMask, _dstStageMask, b, cmdEncoder, cmdUse);
 				break;

 			case MVKPipelineBarrier::Buffer:
 				b.mvkBuffer->applyBufferMemoryBarrier(_srcStageMask, _dstStageMask, b, cmdEncoder, cmdUse);
 				break;

 			case MVKPipelineBarrier::Image:
 				b.mvkImage->applyImageMemoryBarrier(_srcStageMask, _dstStageMask, b, cmdEncoder, cmdUse);
 				break;

 			default:
 				break;
 		}
 	}
 }

 template <size_t N>
 bool MVKCmdPipelineBarrier<N>::coversTextures() {
 	for (auto& b : _barriers) {
 		switch (b.type) {
 			case MVKPipelineBarrier::Memory:	return true;
 			case MVKPipelineBarrier::Image: 	return true;
 			default: 							break;
 		}
 	}
 	return false;
 }

 template class MVKCmdPipelineBarrier<1>;
 template class MVKCmdPipelineBarrier<4>;
 template class MVKCmdPipelineBarrier<32>;


 #pragma mark -
 #pragma mark MVKCmdBindPipeline

 VkResult MVKCmdBindPipeline::setContent(MVKCommandBuffer* cmdBuff, VkPipeline pipeline) {
 	_pipeline = (MVKPipeline*)pipeline;

 	cmdBuff->recordBindPipeline(this);

 	return VK_SUCCESS;
 }


 #pragma mark -
 #pragma mark MVKCmdBindGraphicsPipeline

 void MVKCmdBindGraphicsPipeline::encode(MVKCommandEncoder* cmdEncoder) {
 	cmdEncoder->bindPipeline(VK_PIPELINE_BIND_POINT_GRAPHICS, _pipeline);
 }

 bool MVKCmdBindGraphicsPipeline::isTessellationPipeline() {
 	return ((MVKGraphicsPipeline*)_pipeline)->isTessellationPipeline();
 }


 #pragma mark -
 #pragma mark MVKCmdBindComputePipeline

 void MVKCmdBindComputePipeline::encode(MVKCommandEncoder* cmdEncoder) {
 	cmdEncoder->bindPipeline(VK_PIPELINE_BIND_POINT_COMPUTE, _pipeline);
 }


 #pragma mark -
 #pragma mark MVKCmdBindDescriptorSetsStatic

 template <size_t N>
 VkResult MVKCmdBindDescriptorSetsStatic<N>::setContent(MVKCommandBuffer* cmdBuff,
 													   VkPipelineBindPoint pipelineBindPoint,
 													   VkPipelineLayout layout,
 													   uint32_t firstSet,
 													   uint32_t setCount,
 													   const VkDescriptorSet* pDescriptorSets) {
 	if (_pipelineLayout) { _pipelineLayout->release(); }

 	_pipelineBindPoint = pipelineBindPoint;
 	_pipelineLayout = (MVKPipelineLayout*)layout;
 	_firstSet = firstSet;

 	_pipelineLayout->retain();

 	// Add the descriptor sets
 	_descriptorSets.clear();	// Clear for reuse
 	_descriptorSets.reserve(setCount);
 	for (uint32_t dsIdx = 0; dsIdx < setCount; dsIdx++) {
 		_descriptorSets.push_back((MVKDescriptorSet*)pDescriptorSets[dsIdx]);
 	}

 	return VK_SUCCESS;
 }

 template <size_t N>
 void MVKCmdBindDescriptorSetsStatic<N>::encode(MVKCommandEncoder* cmdEncoder) {
 	encode(cmdEncoder, MVKArrayRef<uint32_t>());
 }

 template <size_t N>
 void MVKCmdBindDescriptorSetsStatic<N>::encode(MVKCommandEncoder* cmdEncoder, MVKArrayRef<uint32_t> dynamicOffsets) {
 	_pipelineLayout->bindDescriptorSets(cmdEncoder, _pipelineBindPoint, _descriptorSets.contents(), _firstSet, dynamicOffsets);
 }

 template <size_t N>
 MVKCmdBindDescriptorSetsStatic<N>::~MVKCmdBindDescriptorSetsStatic() {
 	if (_pipelineLayout) { _pipelineLayout->release(); }
 }

 template class MVKCmdBindDescriptorSetsStatic<1>;
 template class MVKCmdBindDescriptorSetsStatic<4>;
 template class MVKCmdBindDescriptorSetsStatic<8>;


 #pragma mark -
 #pragma mark MVKCmdBindDescriptorSetsDynamic

 template <size_t N>
 VkResult MVKCmdBindDescriptorSetsDynamic<N>::setContent(MVKCommandBuffer* cmdBuff,
 														VkPipelineBindPoint pipelineBindPoint,
 														VkPipelineLayout layout,
 														uint32_t firstSet,
 														uint32_t setCount,
 														const VkDescriptorSet* pDescriptorSets,
 														uint32_t dynamicOffsetCount,
 														const uint32_t* pDynamicOffsets) {

 	MVKCmdBindDescriptorSetsStatic<N>::setContent(cmdBuff, pipelineBindPoint, layout,
 												  firstSet, setCount, pDescriptorSets);

 	// Add the dynamic offsets
 	_dynamicOffsets.clear();	// Clear for reuse
 	_dynamicOffsets.reserve(dynamicOffsetCount);
 	for (uint32_t doIdx = 0; doIdx < dynamicOffsetCount; doIdx++) {
 		_dynamicOffsets.push_back(pDynamicOffsets[doIdx]);
 	}

 	return VK_SUCCESS;
 }

 template <size_t N>
 void MVKCmdBindDescriptorSetsDynamic<N>::encode(MVKCommandEncoder* cmdEncoder) {
 	MVKCmdBindDescriptorSetsStatic<N>::encode(cmdEncoder, _dynamicOffsets.contents());
 }

 template class MVKCmdBindDescriptorSetsDynamic<4>;
 template class MVKCmdBindDescriptorSetsDynamic<8>;


 #pragma mark -
 #pragma mark MVKCmdPushConstants

 template <size_t N>
 VkResult MVKCmdPushConstants<N>::setContent(MVKCommandBuffer* cmdBuff,
 											VkPipelineLayout layout,
 											VkShaderStageFlags stageFlags,
 											uint32_t offset,
 											uint32_t size,
 											const void* pValues) {
 	_stageFlags = stageFlags;
 	_offset = offset;

 	_pushConstants.resize(size);
 	std::copy_n((char*)pValues, size, _pushConstants.begin());

 	return VK_SUCCESS;
 }

 template <size_t N>
 void MVKCmdPushConstants<N>::encode(MVKCommandEncoder* cmdEncoder) {
     VkShaderStageFlagBits stages[] = {
         VK_SHADER_STAGE_VERTEX_BIT,
         VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT,
         VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT,
         VK_SHADER_STAGE_FRAGMENT_BIT,
         VK_SHADER_STAGE_COMPUTE_BIT
     };
     for (auto stage : stages) {
         if (mvkAreAllFlagsEnabled(_stageFlags, stage)) {
 			cmdEncoder->getPushConstants(stage)->setPushConstants(_offset, _pushConstants.contents());
         }
     }
 }

 template class MVKCmdPushConstants<64>;
 template class MVKCmdPushConstants<128>;
 template class MVKCmdPushConstants<512>;


 #pragma mark -
 #pragma mark MVKCmdPushDescriptorSet

 VkResult MVKCmdPushDescriptorSet::setContent(MVKCommandBuffer* cmdBuff,
 											 VkPipelineBindPoint pipelineBindPoint,
 											 VkPipelineLayout layout,
 											 uint32_t set,
 											 uint32_t descriptorWriteCount,
 											 const VkWriteDescriptorSet* pDescriptorWrites) {
 	if (_pipelineLayout) { _pipelineLayout->release(); }

 	_pipelineBindPoint = pipelineBindPoint;
 	_pipelineLayout = (MVKPipelineLayout*)layout;
 	_set = set;

 	_pipelineLayout->retain();

 	// Add the descriptor writes
 	MVKDevice* mvkDvc = cmdBuff->getDevice();
 	clearDescriptorWrites();	// Clear for reuse
 	_descriptorWrites.reserve(descriptorWriteCount);
 	for (uint32_t dwIdx = 0; dwIdx < descriptorWriteCount; dwIdx++) {
 		_descriptorWrites.push_back(pDescriptorWrites[dwIdx]);
 		VkWriteDescriptorSet& descWrite = _descriptorWrites.back();
 		// Make a copy of the associated data.
 		if (descWrite.pImageInfo) {
 			auto* pNewImageInfo = new VkDescriptorImageInfo[descWrite.descriptorCount];
 			std::copy_n(descWrite.pImageInfo, descWrite.descriptorCount, pNewImageInfo);
 			descWrite.pImageInfo = pNewImageInfo;
 		}
 		if (descWrite.pBufferInfo) {
 			auto* pNewBufferInfo = new VkDescriptorBufferInfo[descWrite.descriptorCount];
 			std::copy_n(descWrite.pBufferInfo, descWrite.descriptorCount, pNewBufferInfo);
 			descWrite.pBufferInfo = pNewBufferInfo;
 		}
 		if (descWrite.pTexelBufferView) {
 			auto* pNewTexelBufferView = new VkBufferView[descWrite.descriptorCount];
 			std::copy_n(descWrite.pTexelBufferView, descWrite.descriptorCount, pNewTexelBufferView);
 			descWrite.pTexelBufferView = pNewTexelBufferView;
 		}
         if (mvkDvc->_enabledExtensions.vk_EXT_inline_uniform_block.enabled) {
             const VkWriteDescriptorSetInlineUniformBlockEXT* pInlineUniformBlock = nullptr;
 			for (const auto* next = (VkBaseInStructure*)descWrite.pNext; next; next = next->pNext) {
                 switch (next->sType) {
                 case VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK_EXT: {
                     pInlineUniformBlock = (VkWriteDescriptorSetInlineUniformBlockEXT*)next;
                     break;
                 }
                 default:
                     break;
                 }
             }
             if (pInlineUniformBlock) {
                 auto *pNewInlineUniformBlock = new VkWriteDescriptorSetInlineUniformBlockEXT(*pInlineUniformBlock);
                 pNewInlineUniformBlock->pNext = nullptr; // clear pNext just in case, no other extensions are supported at this time
                 descWrite.pNext = pNewInlineUniformBlock;
             }
         }
 	}

 	// Validate by encoding on a null encoder
 	encode(nullptr);
 	return _pipelineLayout->getConfigurationResult();
 }

 void MVKCmdPushDescriptorSet::encode(MVKCommandEncoder* cmdEncoder) {
 	_pipelineLayout->pushDescriptorSet(cmdEncoder, _descriptorWrites.contents(), _set);
 }

 MVKCmdPushDescriptorSet::~MVKCmdPushDescriptorSet() {
 	clearDescriptorWrites();
 	if (_pipelineLayout) { _pipelineLayout->release(); }
 }

 void MVKCmdPushDescriptorSet::clearDescriptorWrites() {
 	for (VkWriteDescriptorSet &descWrite : _descriptorWrites) {
 		if (descWrite.pImageInfo) { delete[] descWrite.pImageInfo; }
 		if (descWrite.pBufferInfo) { delete[] descWrite.pBufferInfo; }
 		if (descWrite.pTexelBufferView) { delete[] descWrite.pTexelBufferView; }

 		const VkWriteDescriptorSetInlineUniformBlockEXT* pInlineUniformBlock = nullptr;
 		for (const auto* next = (VkBaseInStructure*)descWrite.pNext; next; next = next->pNext) {
 			switch (next->sType) {
 				case VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK_EXT: {
 					pInlineUniformBlock = (VkWriteDescriptorSetInlineUniformBlockEXT*)next;
 					break;
 				}
 				default:
 					break;
 			}
 		}
 		if (pInlineUniformBlock) { delete pInlineUniformBlock; }
 	}
 	_descriptorWrites.clear();
 }


 #pragma mark -
 #pragma mark MVKCmdPushDescriptorSetWithTemplate

 VkResult MVKCmdPushDescriptorSetWithTemplate::setContent(MVKCommandBuffer* cmdBuff,
 														 VkDescriptorUpdateTemplateKHR descUpdateTemplate,
 														 VkPipelineLayout layout,
 														 uint32_t set,
 														 const void* pData) {
 	if (_pipelineLayout) { _pipelineLayout->release(); }

 	_descUpdateTemplate = (MVKDescriptorUpdateTemplate*)descUpdateTemplate;
 	_pipelineLayout = (MVKPipelineLayout*)layout;
 	_set = set;

 	_pipelineLayout->retain();

 	if (_pData) delete[] (char*)_pData;
 	// Work out how big the memory block in pData is.
 	const VkDescriptorUpdateTemplateEntryKHR* pEntry =
 		_descUpdateTemplate->getEntry(_descUpdateTemplate->getNumberOfEntries()-1);
 	size_t size = pEntry->offset;
 	// If we were given a stride, use that; otherwise, assume only one info
 	// struct of the appropriate type.
 	if (pEntry->stride)
 		size += pEntry->stride * pEntry->descriptorCount;
 	else switch (pEntry->descriptorType) {

 		case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
 		case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
 		case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
 		case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
 			size += sizeof(VkDescriptorBufferInfo);
 			break;

 		case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
 		case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
 		case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
 		case VK_DESCRIPTOR_TYPE_SAMPLER:
 		case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
 			size += sizeof(VkDescriptorImageInfo);
 			break;

 		case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
 		case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
 			size += sizeof(VkBufferView);
 			break;

 		default:
 			break;
 	}
 	_pData = new char[size];
 	memcpy(_pData, pData, size);

 	// Validate by encoding on a null encoder
 	encode(nullptr);
 	return _pipelineLayout->getConfigurationResult();
 }

 void MVKCmdPushDescriptorSetWithTemplate::encode(MVKCommandEncoder* cmdEncoder) {
 	_pipelineLayout->pushDescriptorSet(cmdEncoder, _descUpdateTemplate, _set, _pData);
 }

 MVKCmdPushDescriptorSetWithTemplate::~MVKCmdPushDescriptorSetWithTemplate() {
 	if (_pipelineLayout) { _pipelineLayout->release(); }
 	if (_pData) delete[] (char*)_pData;
 }


 #pragma mark -
 #pragma mark MVKCmdSetResetEvent

 VkResult MVKCmdSetResetEvent::setContent(MVKCommandBuffer* cmdBuff,
 										 VkEvent event,
 										 VkPipelineStageFlags stageMask) {
 	_mvkEvent = (MVKEvent*)event;

 	return VK_SUCCESS;
 }


 #pragma mark -
 #pragma mark MVKCmdSetEvent

 void MVKCmdSetEvent::encode(MVKCommandEncoder* cmdEncoder) {
 	cmdEncoder->signalEvent(_mvkEvent, true);
 }


 #pragma mark -
 #pragma mark MVKCmdResetEvent

 void MVKCmdResetEvent::encode(MVKCommandEncoder* cmdEncoder) {
 	cmdEncoder->signalEvent(_mvkEvent, false);
 }


 #pragma mark -
 #pragma mark MVKCmdWaitEvents

 template <size_t N>
 VkResult MVKCmdWaitEvents<N>::setContent(MVKCommandBuffer* cmdBuff,
 										 uint32_t eventCount,
 										 const VkEvent* pEvents,
 										 VkPipelineStageFlags srcStageMask,
 										 VkPipelineStageFlags dstStageMask,
 										 uint32_t memoryBarrierCount,
 										 const VkMemoryBarrier* pMemoryBarriers,
 										 uint32_t bufferMemoryBarrierCount,
 										 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
 										 uint32_t imageMemoryBarrierCount,
 										 const VkImageMemoryBarrier* pImageMemoryBarriers) {
 	_mvkEvents.clear();	// Clear for reuse
 	_mvkEvents.reserve(eventCount);
 	for (uint32_t i = 0; i < eventCount; i++) {
 		_mvkEvents.push_back((MVKEvent*)pEvents[i]);
 	}

 	return VK_SUCCESS;
 }

 template <size_t N>
 void MVKCmdWaitEvents<N>::encode(MVKCommandEncoder* cmdEncoder) {
 	for (MVKEvent* mvkEvt : _mvkEvents) {
 		mvkEvt->encodeWait(cmdEncoder->_mtlCmdBuffer);
 	}
 }

 template class MVKCmdWaitEvents<1>;
 template class MVKCmdWaitEvents<8>;
	/*
	* MVKCmdPipeline.mm
	*
	* Copyright (c) 2015-2022 The Brenwill Workshop Ltd. (http://www.brenwill.com)
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	#include "MVKCmdPipeline.h"
	#include "MVKCommandBuffer.h"
	#include "MVKCommandPool.h"
	#include "MVKImage.h"
	#include "MVKBuffer.h"
	#include "MVKPipeline.h"
	#include "MVKFoundation.h"
	#include "MVKEnvironment.h"
	#include "mvk_datatypes.hpp"


	#pragma mark -
	#pragma mark MVKCmdPipelineBarrier

	template <size_t N>
	VkResult MVKCmdPipelineBarrier<N>::setContent(MVKCommandBuffer* cmdBuff,
	VkPipelineStageFlags srcStageMask,
	VkPipelineStageFlags dstStageMask,
	VkDependencyFlags dependencyFlags,
	uint32_t memoryBarrierCount,
	const VkMemoryBarrier* pMemoryBarriers,
	uint32_t bufferMemoryBarrierCount,
	const VkBufferMemoryBarrier* pBufferMemoryBarriers,
	uint32_t imageMemoryBarrierCount,
	const VkImageMemoryBarrier* pImageMemoryBarriers) {
	_srcStageMask = srcStageMask;
	_dstStageMask = dstStageMask;
	_dependencyFlags = dependencyFlags;

	_barriers.clear(); // Clear for reuse
	_barriers.reserve(memoryBarrierCount + bufferMemoryBarrierCount + imageMemoryBarrierCount);

	for (uint32_t i = 0; i < memoryBarrierCount; i++) {
	_barriers.emplace_back(pMemoryBarriers[i]);
	}
	for (uint32_t i = 0; i < bufferMemoryBarrierCount; i++) {
	_barriers.emplace_back(pBufferMemoryBarriers[i]);
	}
	for (uint32_t i = 0; i < imageMemoryBarrierCount; i++) {
	_barriers.emplace_back(pImageMemoryBarriers[i]);
	}

	return VK_SUCCESS;
	}

	template <size_t N>
	void MVKCmdPipelineBarrier<N>::encode(MVKCommandEncoder* cmdEncoder) {

	#if MVK_MACOS
	// Calls below invoke MTLBlitCommandEncoder so must apply this first.
	// Check if pipeline barriers are available and we are in a renderpass.
	if (cmdEncoder->getDevice()->_pMetalFeatures->memoryBarriers && cmdEncoder->_mtlRenderEncoder) {
	MTLRenderStages srcStages = mvkMTLRenderStagesFromVkPipelineStageFlags(_srcStageMask, false);
	MTLRenderStages dstStages = mvkMTLRenderStagesFromVkPipelineStageFlags(_dstStageMask, true);

	id<MTLResource> resources[_barriers.size()];
	uint32_t rezCnt = 0;

	for (auto& b : _barriers) {
	switch (b.type) {
	case MVKPipelineBarrier::Memory: {
	MTLBarrierScope scope = (mvkMTLBarrierScopeFromVkAccessFlags(b.srcAccessMask) \|
	mvkMTLBarrierScopeFromVkAccessFlags(b.dstAccessMask));
	[cmdEncoder->_mtlRenderEncoder memoryBarrierWithScope: scope
	afterStages: srcStages
	beforeStages: dstStages];
	break;
	}

	case MVKPipelineBarrier::Buffer:
	resources[rezCnt++] = b.mvkBuffer->getMTLBuffer();
	break;

	case MVKPipelineBarrier::Image:
	for (uint8_t planeIndex = 0; planeIndex < b.mvkImage->getPlaneCount(); planeIndex++) {
	resources[rezCnt++] = b.mvkImage->getMTLTexture(planeIndex);
	}
	break;

	default:
	break;
	}
	}

	if (rezCnt) {
	[cmdEncoder->_mtlRenderEncoder memoryBarrierWithResources: resources
	count: rezCnt
	afterStages: srcStages
	beforeStages: dstStages];
	}
	} else if (cmdEncoder->getDevice()->_pMetalFeatures->textureBarriers) {
	#if !MVK_MACCAT
	if (coversTextures()) { [cmdEncoder->_mtlRenderEncoder textureBarrier]; }
	#endif
	}
	#endif

	// Apple GPUs do not support renderpass barriers, and do not support rendering/writing
	// to an attachment and then reading from that attachment within a single renderpass.
	// So, in the case where we are inside a Metal renderpass, we need to split those activities
	// into separate Metal renderpasses. Since this is a potentially expensive operation,
	// verify that at least one attachment is being used both as an input and render attachment
	// by checking for a VK_IMAGE_LAYOUT_GENERAL layout.
	if (cmdEncoder->_mtlRenderEncoder && cmdEncoder->getDevice()->_pMetalFeatures->tileBasedDeferredRendering) {
	bool needsRenderpassRestart = false;
	for (auto& b : _barriers) {
	if (b.type == MVKPipelineBarrier::Image && b.newLayout == VK_IMAGE_LAYOUT_GENERAL) {
	needsRenderpassRestart = true;
	break;
	}
	}
	if (needsRenderpassRestart) {
	cmdEncoder->encodeStoreActions(true);
	cmdEncoder->beginMetalRenderPass(kMVKCommandUseRestartSubpass);
	}
	}

	MVKDevice* mvkDvc = cmdEncoder->getDevice();
	MVKCommandUse cmdUse = kMVKCommandUsePipelineBarrier;

	for (auto& b : _barriers) {
	switch (b.type) {
	case MVKPipelineBarrier::Memory:
	mvkDvc->applyMemoryBarrier(_srcStageMask, _dstStageMask, b, cmdEncoder, cmdUse);
	break;

	case MVKPipelineBarrier::Buffer:
	b.mvkBuffer->applyBufferMemoryBarrier(_srcStageMask, _dstStageMask, b, cmdEncoder, cmdUse);
	break;

	case MVKPipelineBarrier::Image:
	b.mvkImage->applyImageMemoryBarrier(_srcStageMask, _dstStageMask, b, cmdEncoder, cmdUse);
	break;

	default:
	break;
	}
	}
	}

	template <size_t N>
	bool MVKCmdPipelineBarrier<N>::coversTextures() {
	for (auto& b : _barriers) {
	switch (b.type) {
	case MVKPipelineBarrier::Memory: return true;
	case MVKPipelineBarrier::Image: return true;
	default: break;
	}
	}
	return false;
	}

	template class MVKCmdPipelineBarrier<1>;
	template class MVKCmdPipelineBarrier<4>;
	template class MVKCmdPipelineBarrier<32>;


	#pragma mark -
	#pragma mark MVKCmdBindPipeline

	VkResult MVKCmdBindPipeline::setContent(MVKCommandBuffer* cmdBuff, VkPipeline pipeline) {
	_pipeline = (MVKPipeline*)pipeline;

	cmdBuff->recordBindPipeline(this);

	return VK_SUCCESS;
	}


	#pragma mark -
	#pragma mark MVKCmdBindGraphicsPipeline

	void MVKCmdBindGraphicsPipeline::encode(MVKCommandEncoder* cmdEncoder) {
	cmdEncoder->bindPipeline(VK_PIPELINE_BIND_POINT_GRAPHICS, _pipeline);
	}

	bool MVKCmdBindGraphicsPipeline::isTessellationPipeline() {
	return ((MVKGraphicsPipeline*)_pipeline)->isTessellationPipeline();
	}


	#pragma mark -
	#pragma mark MVKCmdBindComputePipeline

	void MVKCmdBindComputePipeline::encode(MVKCommandEncoder* cmdEncoder) {
	cmdEncoder->bindPipeline(VK_PIPELINE_BIND_POINT_COMPUTE, _pipeline);
	}


	#pragma mark -
	#pragma mark MVKCmdBindDescriptorSetsStatic

	template <size_t N>
	VkResult MVKCmdBindDescriptorSetsStatic<N>::setContent(MVKCommandBuffer* cmdBuff,
	VkPipelineBindPoint pipelineBindPoint,
	VkPipelineLayout layout,
	uint32_t firstSet,
	uint32_t setCount,
	const VkDescriptorSet* pDescriptorSets) {
	if (_pipelineLayout) { _pipelineLayout->release(); }

	_pipelineBindPoint = pipelineBindPoint;
	_pipelineLayout = (MVKPipelineLayout*)layout;
	_firstSet = firstSet;

	_pipelineLayout->retain();

	// Add the descriptor sets
	_descriptorSets.clear(); // Clear for reuse
	_descriptorSets.reserve(setCount);
	for (uint32_t dsIdx = 0; dsIdx < setCount; dsIdx++) {
	_descriptorSets.push_back((MVKDescriptorSet*)pDescriptorSets[dsIdx]);
	}

	return VK_SUCCESS;
	}

	template <size_t N>
	void MVKCmdBindDescriptorSetsStatic<N>::encode(MVKCommandEncoder* cmdEncoder) {
	encode(cmdEncoder, MVKArrayRef<uint32_t>());
	}

	template <size_t N>
	void MVKCmdBindDescriptorSetsStatic<N>::encode(MVKCommandEncoder* cmdEncoder, MVKArrayRef<uint32_t> dynamicOffsets) {
	_pipelineLayout->bindDescriptorSets(cmdEncoder, _pipelineBindPoint, _descriptorSets.contents(), _firstSet, dynamicOffsets);
	}

	template <size_t N>
	MVKCmdBindDescriptorSetsStatic<N>::~MVKCmdBindDescriptorSetsStatic() {
	if (_pipelineLayout) { _pipelineLayout->release(); }
	}

	template class MVKCmdBindDescriptorSetsStatic<1>;
	template class MVKCmdBindDescriptorSetsStatic<4>;
	template class MVKCmdBindDescriptorSetsStatic<8>;


	#pragma mark -
	#pragma mark MVKCmdBindDescriptorSetsDynamic

	template <size_t N>
	VkResult MVKCmdBindDescriptorSetsDynamic<N>::setContent(MVKCommandBuffer* cmdBuff,
	VkPipelineBindPoint pipelineBindPoint,
	VkPipelineLayout layout,
	uint32_t firstSet,
	uint32_t setCount,
	const VkDescriptorSet* pDescriptorSets,
	uint32_t dynamicOffsetCount,
	const uint32_t* pDynamicOffsets) {

	MVKCmdBindDescriptorSetsStatic<N>::setContent(cmdBuff, pipelineBindPoint, layout,
	firstSet, setCount, pDescriptorSets);

	// Add the dynamic offsets
	_dynamicOffsets.clear(); // Clear for reuse
	_dynamicOffsets.reserve(dynamicOffsetCount);
	for (uint32_t doIdx = 0; doIdx < dynamicOffsetCount; doIdx++) {
	_dynamicOffsets.push_back(pDynamicOffsets[doIdx]);
	}

	return VK_SUCCESS;
	}

	template <size_t N>
	void MVKCmdBindDescriptorSetsDynamic<N>::encode(MVKCommandEncoder* cmdEncoder) {
	MVKCmdBindDescriptorSetsStatic<N>::encode(cmdEncoder, _dynamicOffsets.contents());
	}

	template class MVKCmdBindDescriptorSetsDynamic<4>;
	template class MVKCmdBindDescriptorSetsDynamic<8>;


	#pragma mark -
	#pragma mark MVKCmdPushConstants

	template <size_t N>
	VkResult MVKCmdPushConstants<N>::setContent(MVKCommandBuffer* cmdBuff,
	VkPipelineLayout layout,
	VkShaderStageFlags stageFlags,
	uint32_t offset,
	uint32_t size,
	const void* pValues) {
	_stageFlags = stageFlags;
	_offset = offset;

	_pushConstants.resize(size);
	std::copy_n((char*)pValues, size, _pushConstants.begin());

	return VK_SUCCESS;
	}

	template <size_t N>
	void MVKCmdPushConstants<N>::encode(MVKCommandEncoder* cmdEncoder) {
	VkShaderStageFlagBits stages[] = {
	VK_SHADER_STAGE_VERTEX_BIT,
	VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT,
	VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT,
	VK_SHADER_STAGE_FRAGMENT_BIT,
	VK_SHADER_STAGE_COMPUTE_BIT
	};
	for (auto stage : stages) {
	if (mvkAreAllFlagsEnabled(_stageFlags, stage)) {
	cmdEncoder->getPushConstants(stage)->setPushConstants(_offset, _pushConstants.contents());
	}
	}
	}

	template class MVKCmdPushConstants<64>;
	template class MVKCmdPushConstants<128>;
	template class MVKCmdPushConstants<512>;


	#pragma mark -
	#pragma mark MVKCmdPushDescriptorSet

	VkResult MVKCmdPushDescriptorSet::setContent(MVKCommandBuffer* cmdBuff,
	VkPipelineBindPoint pipelineBindPoint,
	VkPipelineLayout layout,
	uint32_t set,
	uint32_t descriptorWriteCount,
	const VkWriteDescriptorSet* pDescriptorWrites) {
	if (_pipelineLayout) { _pipelineLayout->release(); }

	_pipelineBindPoint = pipelineBindPoint;
	_pipelineLayout = (MVKPipelineLayout*)layout;
	_set = set;

	_pipelineLayout->retain();

	// Add the descriptor writes
	MVKDevice* mvkDvc = cmdBuff->getDevice();
	clearDescriptorWrites(); // Clear for reuse
	_descriptorWrites.reserve(descriptorWriteCount);
	for (uint32_t dwIdx = 0; dwIdx < descriptorWriteCount; dwIdx++) {
	_descriptorWrites.push_back(pDescriptorWrites[dwIdx]);
	VkWriteDescriptorSet& descWrite = _descriptorWrites.back();
	// Make a copy of the associated data.
	if (descWrite.pImageInfo) {
	auto* pNewImageInfo = new VkDescriptorImageInfo[descWrite.descriptorCount];
	std::copy_n(descWrite.pImageInfo, descWrite.descriptorCount, pNewImageInfo);
	descWrite.pImageInfo = pNewImageInfo;
	}
	if (descWrite.pBufferInfo) {
	auto* pNewBufferInfo = new VkDescriptorBufferInfo[descWrite.descriptorCount];
	std::copy_n(descWrite.pBufferInfo, descWrite.descriptorCount, pNewBufferInfo);
	descWrite.pBufferInfo = pNewBufferInfo;
	}
	if (descWrite.pTexelBufferView) {
	auto* pNewTexelBufferView = new VkBufferView[descWrite.descriptorCount];
	std::copy_n(descWrite.pTexelBufferView, descWrite.descriptorCount, pNewTexelBufferView);
	descWrite.pTexelBufferView = pNewTexelBufferView;
	}
	if (mvkDvc->_enabledExtensions.vk_EXT_inline_uniform_block.enabled) {
	const VkWriteDescriptorSetInlineUniformBlockEXT* pInlineUniformBlock = nullptr;
	for (const auto* next = (VkBaseInStructure*)descWrite.pNext; next; next = next->pNext) {
	switch (next->sType) {
	case VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK_EXT: {
	pInlineUniformBlock = (VkWriteDescriptorSetInlineUniformBlockEXT*)next;
	break;
	}
	default:
	break;
	}
	}
	if (pInlineUniformBlock) {
	auto pNewInlineUniformBlock = new VkWriteDescriptorSetInlineUniformBlockEXT(pInlineUniformBlock);
	pNewInlineUniformBlock->pNext = nullptr; // clear pNext just in case, no other extensions are supported at this time
	descWrite.pNext = pNewInlineUniformBlock;
	}
	}
	}

	// Validate by encoding on a null encoder
	encode(nullptr);
	return _pipelineLayout->getConfigurationResult();
	}

	void MVKCmdPushDescriptorSet::encode(MVKCommandEncoder* cmdEncoder) {
	_pipelineLayout->pushDescriptorSet(cmdEncoder, _descriptorWrites.contents(), _set);
	}

	MVKCmdPushDescriptorSet::~MVKCmdPushDescriptorSet() {
	clearDescriptorWrites();
	if (_pipelineLayout) { _pipelineLayout->release(); }
	}

	void MVKCmdPushDescriptorSet::clearDescriptorWrites() {
	for (VkWriteDescriptorSet &descWrite : _descriptorWrites) {
	if (descWrite.pImageInfo) { delete[] descWrite.pImageInfo; }
	if (descWrite.pBufferInfo) { delete[] descWrite.pBufferInfo; }
	if (descWrite.pTexelBufferView) { delete[] descWrite.pTexelBufferView; }

	const VkWriteDescriptorSetInlineUniformBlockEXT* pInlineUniformBlock = nullptr;
	for (const auto* next = (VkBaseInStructure*)descWrite.pNext; next; next = next->pNext) {
	switch (next->sType) {
	case VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK_EXT: {
	pInlineUniformBlock = (VkWriteDescriptorSetInlineUniformBlockEXT*)next;
	break;
	}
	default:
	break;
	}
	}
	if (pInlineUniformBlock) { delete pInlineUniformBlock; }
	}
	_descriptorWrites.clear();
	}


	#pragma mark -
	#pragma mark MVKCmdPushDescriptorSetWithTemplate

	VkResult MVKCmdPushDescriptorSetWithTemplate::setContent(MVKCommandBuffer* cmdBuff,
	VkDescriptorUpdateTemplateKHR descUpdateTemplate,
	VkPipelineLayout layout,
	uint32_t set,
	const void* pData) {
	if (_pipelineLayout) { _pipelineLayout->release(); }

	_descUpdateTemplate = (MVKDescriptorUpdateTemplate*)descUpdateTemplate;
	_pipelineLayout = (MVKPipelineLayout*)layout;
	_set = set;

	_pipelineLayout->retain();

	if (_pData) delete[] (char*)_pData;
	// Work out how big the memory block in pData is.
	const VkDescriptorUpdateTemplateEntryKHR* pEntry =
	_descUpdateTemplate->getEntry(_descUpdateTemplate->getNumberOfEntries()-1);
	size_t size = pEntry->offset;
	// If we were given a stride, use that; otherwise, assume only one info
	// struct of the appropriate type.
	if (pEntry->stride)
	size += pEntry->stride * pEntry->descriptorCount;
	else switch (pEntry->descriptorType) {

	case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
	case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
	case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
	case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
	size += sizeof(VkDescriptorBufferInfo);
	break;

	case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
	case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
	case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
	case VK_DESCRIPTOR_TYPE_SAMPLER:
	case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
	size += sizeof(VkDescriptorImageInfo);
	break;

	case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
	case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
	size += sizeof(VkBufferView);
	break;

	default:
	break;
	}
	_pData = new char[size];
	memcpy(_pData, pData, size);

	// Validate by encoding on a null encoder
	encode(nullptr);
	return _pipelineLayout->getConfigurationResult();
	}

	void MVKCmdPushDescriptorSetWithTemplate::encode(MVKCommandEncoder* cmdEncoder) {
	_pipelineLayout->pushDescriptorSet(cmdEncoder, _descUpdateTemplate, _set, _pData);
	}

	MVKCmdPushDescriptorSetWithTemplate::~MVKCmdPushDescriptorSetWithTemplate() {
	if (_pipelineLayout) { _pipelineLayout->release(); }
	if (_pData) delete[] (char*)_pData;
	}


	#pragma mark -
	#pragma mark MVKCmdSetResetEvent

	VkResult MVKCmdSetResetEvent::setContent(MVKCommandBuffer* cmdBuff,
	VkEvent event,
	VkPipelineStageFlags stageMask) {
	_mvkEvent = (MVKEvent*)event;

	return VK_SUCCESS;
	}


	#pragma mark -
	#pragma mark MVKCmdSetEvent

	void MVKCmdSetEvent::encode(MVKCommandEncoder* cmdEncoder) {
	cmdEncoder->signalEvent(_mvkEvent, true);
	}


	#pragma mark -
	#pragma mark MVKCmdResetEvent

	void MVKCmdResetEvent::encode(MVKCommandEncoder* cmdEncoder) {
	cmdEncoder->signalEvent(_mvkEvent, false);
	}


	#pragma mark -
	#pragma mark MVKCmdWaitEvents

	template <size_t N>
	VkResult MVKCmdWaitEvents<N>::setContent(MVKCommandBuffer* cmdBuff,
	uint32_t eventCount,
	const VkEvent* pEvents,
	VkPipelineStageFlags srcStageMask,
	VkPipelineStageFlags dstStageMask,
	uint32_t memoryBarrierCount,
	const VkMemoryBarrier* pMemoryBarriers,
	uint32_t bufferMemoryBarrierCount,
	const VkBufferMemoryBarrier* pBufferMemoryBarriers,
	uint32_t imageMemoryBarrierCount,
	const VkImageMemoryBarrier* pImageMemoryBarriers) {
	_mvkEvents.clear(); // Clear for reuse
	_mvkEvents.reserve(eventCount);
	for (uint32_t i = 0; i < eventCount; i++) {
	_mvkEvents.push_back((MVKEvent*)pEvents[i]);
	}

	return VK_SUCCESS;
	}

	template <size_t N>
	void MVKCmdWaitEvents<N>::encode(MVKCommandEncoder* cmdEncoder) {
	for (MVKEvent* mvkEvt : _mvkEvents) {
	mvkEvt->encodeWait(cmdEncoder->_mtlCmdBuffer);
	}
	}

	template class MVKCmdWaitEvents<1>;
	template class MVKCmdWaitEvents<8>;