KytyPS5/src/graphics/host_gpu/renderer/textureCache.h

#ifndef EMULATOR_SRC_GRAPHICS_HOST_GPU_RENDERER_TEXTURECACHE_H_
#define EMULATOR_SRC_GRAPHICS_HOST_GPU_RENDERER_TEXTURECACHE_H_

#include "common/abi.h"
#include "common/common.h"
#include "common/threads.h"
#include "graphics/host_gpu/memoryTracker.h"
#include "graphics/host_gpu/renderer/imageInfo.h"
#include "graphics/host_gpu/renderer/tiler.h"

#include <array>
#include <map>
#include <memory>
#include <mutex>
#include <vector>
#include <vulkan/vulkan_core.h>

namespace Libs::Graphics {

struct DepthStencilVulkanImage;
struct GpuTextureVulkanImage;
struct GraphicContext;
struct RenderTextureVulkanImage;
struct StorageTextureVulkanImage;
struct VideoOutVulkanImage;
struct VulkanImage;
struct VulkanMemory;
class BufferCache;
class CommandBuffer;
class ResourceMutex;

class TextureCache {
public:
	TextureCache(PageManager& page_manager, BufferCache& buffer_cache,
	             ResourceMutex& resource_mutex);
	~TextureCache();
	KYTY_CLASS_NO_COPY(TextureCache);

	[[nodiscard]] VulkanImage* FindTexture(CommandBuffer* command, GraphicContext* ctx,
	                                       const ImageInfo& info, bool metadata_read);
	[[nodiscard]] StorageTextureVulkanImage*
	FindStorageTexture(CommandBuffer* command, GraphicContext* ctx, const ImageInfo& info);
	[[nodiscard]] RenderTextureVulkanImage*
	FindRenderTarget(CommandBuffer* command, GraphicContext* ctx, const RenderTargetInfo& info);
	[[nodiscard]] DepthStencilVulkanImage*
	FindDepthTarget(CommandBuffer* command, GraphicContext* ctx, const DepthTargetInfo& info);
	[[nodiscard]] std::vector<VideoOutVulkanImage*>
	     RegisterVideoOutSurfaces(GraphicContext* ctx, const std::vector<VideoOutInfo>& infos);
	void RefreshVideoOut(VideoOutVulkanImage* image, bool render_target = false);
	void UnregisterVideoOutSurfaces(const std::vector<VideoOutVulkanImage*>& images);
	[[nodiscard]] bool ClearColorImageFromBuffer(CommandBuffer* command, uint64_t vaddr,
	                                             uint64_t size, uint32_t packed_clear);
	[[nodiscard]] bool ClearDepthImageFromBuffer(CommandBuffer* command, uint64_t vaddr,
	                                             uint64_t size, uint32_t packed_clear);
	[[nodiscard]] bool ClearStencilImageFromBuffer(CommandBuffer* command, uint64_t vaddr,
	                                               uint64_t size, uint32_t packed_clear);
	void               MarkGpuWritten(VulkanImage* image);
	void               PrepareHostWrite(uint64_t vaddr, uint64_t size);
	[[nodiscard]] bool InvalidateMemoryFromGPU(uint64_t vaddr, uint64_t size,
	                                           bool formatted_buffer_write = false);
	[[nodiscard]] RenderTextureVulkanImage* FindRenderTargetByRange(CommandBuffer* command,
	                                                                uint64_t vaddr, uint64_t size);
	[[nodiscard]] VkImageView GetRenderTargetAttachmentView(GraphicContext*           ctx,
	                                                        RenderTextureVulkanImage* image,
	                                                        VkFormat format, uint32_t level,
	                                                        uint32_t base_layer,
	                                                        uint32_t layer_count);
	[[nodiscard]] VkImageView GetDepthTargetAttachmentView(GraphicContext*          ctx,
	                                                       DepthStencilVulkanImage* image,
	                                                       uint32_t                 base_layer,
	                                                       uint32_t                 layer_count);
	[[nodiscard]] VkImageView GetRenderTargetSampledView(GraphicContext*           ctx,
	                                                     RenderTextureVulkanImage* image,
	                                                     VkFormat view_format, int variant,
	                                                     uint32_t base_level, uint32_t level_count,
	                                                     VkImageViewType type, uint32_t base_layer,
	                                                     uint32_t layer_count);
	[[nodiscard]] VkImageView GetRenderTargetStorageView(GraphicContext*           ctx,
	                                                     RenderTextureVulkanImage* image,
	                                                     VkFormat view_format, uint32_t base_level,
	                                                     uint32_t level_count, VkImageViewType type,
	                                                     uint32_t base_layer, uint32_t layer_count);
	[[nodiscard]] VkImageView GetStorageTextureSampledView(GraphicContext*            ctx,
	                                                       StorageTextureVulkanImage* image,
	                                                       const ImageInfo&           info);
	[[nodiscard]] DepthStencilVulkanImage* FindDepthTargetByRange(uint64_t vaddr, uint64_t size);
	[[nodiscard]] bool                     HasPageOverlap(uint64_t vaddr, uint64_t size);
	[[nodiscard]] bool                     HasRangeOverlap(uint64_t vaddr, uint64_t size);
	[[nodiscard]] bool HasGpuModifiedRangeOverlap(uint64_t vaddr, uint64_t size);
	[[nodiscard]] bool HasGpuTargetPageOverlap(uint64_t vaddr, uint64_t size);
	void               RegisterMeta(uint64_t vaddr, uint64_t size, uint32_t layers = 1);
	[[nodiscard]] bool IsMeta(uint64_t vaddr);
	[[nodiscard]] bool IsMetaRange(uint64_t vaddr, uint64_t size);
	[[nodiscard]] bool HasMetaRangeOverlap(uint64_t vaddr, uint64_t size);
	[[nodiscard]] bool HasMetaOverlap(uint64_t vaddr, uint64_t size);
	[[nodiscard]] bool IsMetaGpuModified(uint64_t vaddr, uint64_t size);
	[[nodiscard]] bool IsMetaCleared(uint64_t vaddr, uint32_t slice);
	[[nodiscard]] bool ClearMeta(uint64_t vaddr);
	[[nodiscard]] bool TouchMeta(uint64_t vaddr, uint32_t slice, bool is_clear);
	[[nodiscard]] bool InvalidateMemory(PageFaultAccess access, uint64_t vaddr, uint64_t size,
	                                    PageFaultPhase phase) noexcept;
	void               UnmapMemory(uint64_t vaddr, uint64_t size);

	static void DeleteGpuTexture(GraphicContext* ctx, GpuTextureVulkanImage* image,
	                             VulkanMemory* mem);
	static void DeleteRenderTexture(GraphicContext* ctx, RenderTextureVulkanImage* image,
	                                VulkanMemory* mem);
	static void DeleteDepthStencil(GraphicContext* ctx, DepthStencilVulkanImage* image,
	                               VulkanMemory* mem);
	static void DeleteVideoOut(GraphicContext* ctx, VideoOutVulkanImage* image, VulkanMemory* mem);

	VulkanImage* GetDummySampledTexture(bool uint_format, bool image_3d);
	VulkanImage* GetDummyStorageTexture(bool uint_format, bool image_3d);

private:
	struct CachedImage;
	struct ReadbackWorker;
	struct MetaDataInfo {
		uint64_t size         = 0;
		uint32_t layers       = 1;
		uint32_t clear_mask   = 0;
		bool     gpu_modified = false;
	};
	static void                DeleteImageViews(GraphicContext* ctx, VulkanImage* image);
	[[nodiscard]] bool         HasMetaOverlapLocked(uint64_t vaddr, uint64_t size) const;
	[[nodiscard]] CachedImage* FindGpuReadbackPageCandidateLocked(uint64_t vaddr,
	                                                              uint64_t size) const;
	void                       RequireNoMetaOverlapLocked(uint64_t vaddr, uint64_t size) const;
	void                       MarkSampledAliasesCpuDirtyLocked(uint64_t vaddr, uint64_t size);
	void RetireSampledTargetAliases(GraphicContext* ctx, const ImageInfo& requested);
	void RetireStoragePageNeighbors(GraphicContext* ctx, const ImageInfo& requested);
	void RequireRetirementIsolation(const std::vector<CachedImage*>& retire, const char* operation,
	                                uint64_t address, uint64_t size) const;
	void RetireImages(const std::vector<CachedImage*>& retire,
	                  const CachedImage*               native_image_source = nullptr);
	void SynchronizeRenderTargetToBufferLocked(CachedImage& cached);

	Common::Mutex                             m_dummy_mutex;
	std::array<VulkanImage*, 4>               m_dummy_sampled_textures {};
	std::array<VulkanImage*, 4>               m_dummy_storage_textures {};
	std::array<VulkanMemory*, 4>              m_dummy_sampled_memory {};
	std::array<VulkanMemory*, 4>              m_dummy_storage_memory {};
	GraphicContext*                           m_dummy_ctx = nullptr;
	TrackingSpinLock                          m_lock;
	std::mutex                                m_fault_mutex;
	MemoryTracker                             m_memory_tracker;
	MemoryTracker                             m_metadata_tracker;
	Tiler                                     m_tiler;
	BufferCache&                              m_buffer_cache;
	ResourceMutex&                            m_resource_mutex;
	std::vector<std::shared_ptr<CachedImage>> m_images;
	std::map<uint64_t, MetaDataInfo>          m_surface_metas;
	std::unique_ptr<ReadbackWorker>           m_readback;
	std::vector<uint8_t>                      m_buffer_transition_linear;
	std::vector<uint8_t>                      m_buffer_transition_guest;
};

} // namespace Libs::Graphics

#endif // EMULATOR_SRC_GRAPHICS_HOST_GPU_RENDERER_TEXTURECACHE_H_