/*-------------------------------------------------------------------------
 * Vulkan CTS Framework
 * --------------------
 *
 * Copyright (c) 2018 The Khronos Group Inc.
 * Copyright (c) 2018 Google Inc.
 *
 * 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.
 *
 *//*!
 * \file
 * \brief Utility for generating barriers
 *//*--------------------------------------------------------------------*/

#include "vkBarrierUtil.hpp"

namespace vk
{

VkBufferMemoryBarrier makeBufferMemoryBarrier (const VkAccessFlags	srcAccessMask,
											   const VkAccessFlags	dstAccessMask,
											   const VkBuffer		buffer,
											   const VkDeviceSize	offset,
											   const VkDeviceSize	bufferSizeBytes,
											   const deUint32		srcQueueFamilyIndex,
											   const deUint32		dstQueueFamilyIndex)
{
	return
	{
		VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER,		// VkStructureType	sType;
		DE_NULL,										// const void*		pNext;
		srcAccessMask,									// VkAccessFlags	srcAccessMask;
		dstAccessMask,									// VkAccessFlags	dstAccessMask;
		srcQueueFamilyIndex,							// deUint32			srcQueueFamilyIndex;
		dstQueueFamilyIndex,							// deUint32			destQueueFamilyIndex;
		buffer,											// VkBuffer			buffer;
		offset,											// VkDeviceSize		offset;
		bufferSizeBytes,								// VkDeviceSize		size;
	};
}

VkBufferMemoryBarrier2KHR makeBufferMemoryBarrier2(const VkPipelineStageFlags2KHR	srcStageMask,
												   const VkAccessFlags2KHR			srcAccessMask,
												   const VkPipelineStageFlags2KHR	dstStageMask,
												   const VkAccessFlags2KHR			dstAccessMask,
												   const VkBuffer					buffer,
												   const VkDeviceSize				offset,
												   const VkDeviceSize				size,
												   const deUint32					srcQueueFamilyIndex,
												   const deUint32					dstQueueFamilyIndex)
{
	return
	{
		VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER_2_KHR,	// VkStructureType				sType;
		DE_NULL,										// const void*					pNext;
		srcStageMask,									// VkPipelineStageFlags2KHR		srcStageMask;
		srcAccessMask,									// VkAccessFlags2KHR			srcAccessMask;
		dstStageMask,									// VkPipelineStageFlags2KHR		dstStageMask;
		dstAccessMask,									// VkAccessFlags2KHR			dstAccessMask;
		srcQueueFamilyIndex,							// deUint32						srcQueueFamilyIndex;
		dstQueueFamilyIndex,							// deUint32						dstQueueFamilyIndex;
		buffer,											// VkBuffer						buffer;
		offset,											// VkDeviceSize					offset;
		size											// VkDeviceSize					size;
	};
}

VkImageMemoryBarrier makeImageMemoryBarrier (const VkAccessFlags			srcAccessMask,
											 const VkAccessFlags			dstAccessMask,
											 const VkImageLayout			oldLayout,
											 const VkImageLayout			newLayout,
											 const VkImage					image,
											 const VkImageSubresourceRange	subresourceRange,
											 const deUint32					srcQueueFamilyIndex,
											 const deUint32					dstQueueFamilyIndex)
{
	return
	{
		VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER,			// VkStructureType			sType;
		DE_NULL,										// const void*				pNext;
		srcAccessMask,									// VkAccessFlags			outputMask;
		dstAccessMask,									// VkAccessFlags			inputMask;
		oldLayout,										// VkImageLayout			oldLayout;
		newLayout,										// VkImageLayout			newLayout;
		srcQueueFamilyIndex,							// deUint32					srcQueueFamilyIndex;
		dstQueueFamilyIndex,							// deUint32					destQueueFamilyIndex;
		image,											// VkImage					image;
		subresourceRange,								// VkImageSubresourceRange	subresourceRange;
	};
}

VkImageMemoryBarrier2KHR makeImageMemoryBarrier2 (const VkPipelineStageFlags2KHR	srcStageMask,
												  const VkAccessFlags2KHR			srcAccessMask,
												  const VkPipelineStageFlags2KHR	dstStageMask,
												  const VkAccessFlags2KHR			dstAccessMask,
												  const VkImageLayout				oldLayout,
												  const VkImageLayout				newLayout,
												  const VkImage						image,
												  const VkImageSubresourceRange		subresourceRange,
												  const deUint32					srcQueueFamilyIndex,
												  const deUint32					dstQueueFamilyIndex)
{
	return
	{
		VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER_2_KHR,	// VkStructureType				sType;
		DE_NULL,										// const void*					pNext;
		srcStageMask,									// VkPipelineStageFlags2KHR		srcStageMask;
		srcAccessMask,									// VkAccessFlags2KHR			srcAccessMask;
		dstStageMask,									// VkPipelineStageFlags2KHR		dstStageMask;
		dstAccessMask,									// VkAccessFlags2KHR			dstAccessMask;
		oldLayout,										// VkImageLayout				oldLayout;
		newLayout,										// VkImageLayout				newLayout;
		srcQueueFamilyIndex,							// deUint32						srcQueueFamilyIndex;
		dstQueueFamilyIndex,							// deUint32						destQueueFamilyIndex;
		image,											// VkImage						image;
		subresourceRange,								// VkImageSubresourceRange		subresourceRange;
	};
}

VkMemoryBarrier makeMemoryBarrier (const VkAccessFlags	srcAccessMask,
								   const VkAccessFlags	dstAccessMask)
{
	return
	{
		VK_STRUCTURE_TYPE_MEMORY_BARRIER,				// VkStructureType				sType;
		DE_NULL,										// const void*					pNext;
		srcAccessMask,									// VkAccessFlags				srcAccessMask;
		dstAccessMask,									// VkAccessFlags				dstAccessMask;
	};
}

VkMemoryBarrier2KHR makeMemoryBarrier2(const VkPipelineStageFlags2KHR	srcStageMask,
									   const VkAccessFlags2KHR			srcAccessMask,
									   const VkPipelineStageFlags2KHR	dstStageMask,
									   const VkAccessFlags2KHR			dstAccessMask)
{
	return
	{
		VK_STRUCTURE_TYPE_MEMORY_BARRIER_2_KHR,			// VkStructureType				sType;
		DE_NULL,										// const void*					pNext;
		srcStageMask,									// VkPipelineStageFlags2KHR		srcStageMask;
		srcAccessMask,									// VkAccessFlags2KHR			srcAccessMask;
		dstStageMask,									// VkPipelineStageFlags2KHR		dstStageMask;
		dstAccessMask									// VkAccessFlags2KHR			dstAccessMask;
	};
}

void cmdPipelineMemoryBarrier		(const DeviceInterface&			vk,
									 const VkCommandBuffer			commandBuffer,
									 const VkPipelineStageFlags		srcStageMask,
									 const VkPipelineStageFlags		dstStageMask,
									 const VkMemoryBarrier*			pMemoryBarriers,
									 const size_t					memoryBarrierCount,
									 const VkDependencyFlags		dependencyFlags)
{
	const deUint32	memoryBarrierCount32	=static_cast<deUint32>(memoryBarrierCount);

	DE_ASSERT(memoryBarrierCount == memoryBarrierCount32);

	vk.cmdPipelineBarrier(commandBuffer, srcStageMask, dstStageMask, dependencyFlags, memoryBarrierCount32, pMemoryBarriers, 0u, DE_NULL, 0u, DE_NULL);
}

void cmdPipelineBufferMemoryBarrier	(const DeviceInterface&			vk,
									 const VkCommandBuffer			commandBuffer,
									 const VkPipelineStageFlags		srcStageMask,
									 const VkPipelineStageFlags		dstStageMask,
									 const VkBufferMemoryBarrier*	pBufferMemoryBarriers,
									 const size_t					bufferMemoryBarrierCount,
									 const VkDependencyFlags		dependencyFlags)
{
	const deUint32	bufferMemoryBarrierCount32	=static_cast<deUint32>(bufferMemoryBarrierCount);

	DE_ASSERT(bufferMemoryBarrierCount == bufferMemoryBarrierCount32);

	vk.cmdPipelineBarrier(commandBuffer, srcStageMask, dstStageMask, dependencyFlags, 0u, DE_NULL, bufferMemoryBarrierCount32, pBufferMemoryBarriers, 0u, DE_NULL);
}

void cmdPipelineImageMemoryBarrier	(const DeviceInterface&			vk,
									 const VkCommandBuffer			commandBuffer,
									 const VkPipelineStageFlags		srcStageMask,
									 const VkPipelineStageFlags		dstStageMask,
									 const VkImageMemoryBarrier*	pImageMemoryBarriers,
									 const size_t					imageMemoryBarrierCount,
									 const VkDependencyFlags		dependencyFlags)
{
	const deUint32	imageMemoryBarrierCount32	=static_cast<deUint32>(imageMemoryBarrierCount);

	DE_ASSERT(imageMemoryBarrierCount == imageMemoryBarrierCount32);

	vk.cmdPipelineBarrier(commandBuffer, srcStageMask, dstStageMask, dependencyFlags, 0u, DE_NULL, 0u, DE_NULL, imageMemoryBarrierCount32, pImageMemoryBarriers);
}

} // vkt