anki-3d-engine/AnKi/Resource/ShaderProgramResource.cpp

// Copyright (C) 2009-present, Panagiotis Christopoulos Charitos and contributors.
// All rights reserved.
// Code licensed under the BSD License.
// http://www.anki3d.org/LICENSE

#include <AnKi/Resource/ShaderProgramResource.h>
#include <AnKi/Resource/ResourceManager.h>
#include <AnKi/Resource/ShaderProgramResourceSystem.h>
#include <AnKi/Gr/ShaderProgram.h>
#include <AnKi/Gr/GrManager.h>
#include <AnKi/Util/Filesystem.h>
#include <AnKi/Util/Functions.h>
#include <AnKi/Util/CVarSet.h>

namespace anki {

ShaderProgramResourceVariant::ShaderProgramResourceVariant()
{
}

ShaderProgramResourceVariant::~ShaderProgramResourceVariant()
{
}

ShaderProgramResource::~ShaderProgramResource()
{
	for(auto it : m_variants)
	{
		ShaderProgramResourceVariant* variant = &(*it);
		deleteInstance(ResourceMemoryPool::getSingleton(), variant);
	}

	ResourceMemoryPool::getSingleton().free(m_binary);
}

Error ShaderProgramResource::load(const ResourceFilename& filename, [[maybe_unused]] Bool async)
{
	// Load the binary
	ResourceFilePtr file;
	ANKI_CHECK(openFile(filename, file));
	ANKI_CHECK(deserializeShaderBinaryFromAnyFile(*file, m_binary, ResourceMemoryPool::getSingleton()));

	return Error::kNone;
}

void ShaderProgramResource::getOrCreateVariant(const ShaderProgramResourceVariantInitInfo& info_, const ShaderProgramResourceVariant*& variant) const
{
	ShaderProgramResourceVariantInitInfo info = info_;

	// Sanity checks
	ANKI_ASSERT(info.m_setMutators.getSetBitCount() == m_binary->m_mutators.getSize());

	// User didn't provided Try to guess some defaults
	if(!info.m_shaderTypes)
	{
		U32 techniqueIdx = kMaxU32;
		for(U32 i = 0; i < m_binary->m_techniques.getSize(); ++i)
		{
			if(CString("Unnamed") == m_binary->m_techniques[i].m_name.getBegin())
			{
				techniqueIdx = i;
				break;
			}
		}
		ANKI_ASSERT(techniqueIdx != kMaxU32);
		const ShaderTypeBit techniqueShaderTypes = m_binary->m_techniques[techniqueIdx].m_shaderTypes;

		if(techniqueShaderTypes == (ShaderTypeBit::kPixel | ShaderTypeBit::kVertex))
		{
			info.requestTechniqueAndTypes(techniqueShaderTypes, "Unnamed");
		}
		else if(techniqueShaderTypes == ShaderTypeBit::kCompute)
		{
			info.requestTechniqueAndTypes(techniqueShaderTypes, "Unnamed");
		}
		else
		{
			ANKI_ASSERT(!"Can't figure out a sensible default");
		}
	}

	// Compute variant hash
	U64 hash = computeHash(&info.m_shaderTypes, sizeof(info.m_shaderTypes));

	for(ShaderType stype : EnumBitsIterable<ShaderType, ShaderTypeBit>(info.m_shaderTypes))
	{
		const PtrSize len = strlen(info.m_techniqueNames[stype].getBegin());
		ANKI_ASSERT(len > 0);
		hash = appendHash(info.m_techniqueNames[stype].getBegin(), len, hash);
	}

	if(m_binary->m_mutators.getSize())
	{
		hash = appendHash(info.m_mutation.getBegin(), m_binary->m_mutators.getSize() * sizeof(info.m_mutation[0]), hash);
	}

	// Check if the variant is in the cache
	{
		RLockGuard lock(m_mtx);

		auto it = m_variants.find(hash);
		if(it != m_variants.getEnd())
		{
			// Done
			variant = *it;
			if(!!(info.m_shaderTypes & ShaderTypeBit::kAllGraphics))
			{
				ANKI_ASSERT(variant->m_prog->getShaderTypes() == info.m_shaderTypes);
			}
			return;
		}
	}

	// Create the variant
	WLockGuard lock(m_mtx);

	// Check again
	auto it = m_variants.find(hash);
	if(it != m_variants.getEnd())
	{
		// Done
		variant = *it;
		return;
	}

	// Create
	ShaderProgramResourceVariant* v = createNewVariant(info);
	if(v)
	{
		m_variants.emplace(hash, v);
	}
	variant = v;
	if(!!(info.m_shaderTypes & ShaderTypeBit::kAllGraphics))
	{
		ANKI_ASSERT(variant->m_prog->getShaderTypes() == info.m_shaderTypes);
	}
}

U32 ShaderProgramResource::findTechnique(CString name) const
{
	U32 techniqueIdx = kMaxU32;
	for(U32 i = 0; i < m_binary->m_techniques.getSize(); ++i)
	{
		if(m_binary->m_techniques[i].m_name.getBegin() == name)
		{
			techniqueIdx = i;
			break;
		}
	}
	ANKI_ASSERT(techniqueIdx != kMaxU32 && "Technique not found");

	return techniqueIdx;
}

ShaderProgramResourceVariant* ShaderProgramResource::createNewVariant(const ShaderProgramResourceVariantInitInfo& info) const
{
	// Get the binary program variant
	const ShaderBinaryVariant* binaryVariant = nullptr;
	U32 binaryVariantIdx = kMaxU32;
	U64 mutationHash = 0;
	if(m_binary->m_mutators.getSize())
	{
		// Create the mutation hash
		mutationHash = computeHash(info.m_mutation.getBegin(), m_binary->m_mutators.getSize() * sizeof(info.m_mutation[0]));

		// Search for the mutation in the binary
		// TODO optimize the search
		for(const ShaderBinaryMutation& mutation : m_binary->m_mutations)
		{
			if(mutation.m_hash == mutationHash)
			{
				if(mutation.m_variantIndex == kMaxU32)
				{
					// Skipped mutation, nothing to create
					return nullptr;
				}

				binaryVariantIdx = mutation.m_variantIndex;
				binaryVariant = &m_binary->m_variants[mutation.m_variantIndex];
				break;
			}
		}
	}
	else
	{
		ANKI_ASSERT(m_binary->m_variants.getSize() == 1);
		binaryVariant = &m_binary->m_variants[0];
	}
	ANKI_ASSERT(binaryVariant);
	ShaderProgramResourceVariant* variant = newInstance<ShaderProgramResourceVariant>(ResourceMemoryPool::getSingleton());

	// Time to init the shaders
	if(!!(info.m_shaderTypes & (ShaderTypeBit::kAllGraphics | ShaderTypeBit::kCompute)))
	{
		// Create the program name
		String fname;
		getFilepathFilename(getFilename(), fname);

		ResourceString progName;
		progName.sprintf("%s var%05u", fname.cstr(), binaryVariantIdx);
		for(ShaderType shaderType : EnumBitsIterable<ShaderType, ShaderTypeBit>(info.m_shaderTypes))
		{
			progName += " ";
			progName += info.m_techniqueNames[shaderType].getBegin();
		}

		ShaderProgramInitInfo progInf(progName);
		Array<ShaderPtr, U32(ShaderType::kCount)> shaderRefs; // Just for refcounting
		for(ShaderType shaderType : EnumBitsIterable<ShaderType, ShaderTypeBit>(info.m_shaderTypes))
		{
			const ShaderTypeBit shaderBit = ShaderTypeBit(1 << shaderType);

			const U32 techniqueIdx = findTechnique(info.m_techniqueNames[shaderType].getBegin());
			ANKI_ASSERT(!!(m_binary->m_techniques[techniqueIdx].m_shaderTypes & shaderBit));

			const ResourceString shaderName = (progName + " " + m_binary->m_techniques[techniqueIdx].m_name.getBegin()).cstr();
			ShaderInitInfo inf(shaderName);
			inf.m_shaderType = shaderType;
			const ShaderBinaryCodeBlock& binBlock =
				m_binary->m_codeBlocks[binaryVariant->m_techniqueCodeBlocks[techniqueIdx].m_codeBlockIndices[shaderType]];
			inf.m_binary = binBlock.m_binary;
			inf.m_reflection = binBlock.m_reflection;
			ShaderPtr shader = GrManager::getSingleton().newShader(inf);
			shaderRefs[shaderType] = shader;

			if(!!(shaderBit & ShaderTypeBit::kAllGraphics))
			{
				progInf.m_graphicsShaders[shaderType] = shader.get();
			}
			else if(shaderType == ShaderType::kCompute)
			{
				progInf.m_computeShader = shader.get();
			}
			else
			{
				ANKI_ASSERT(0);
			}
		}

		// Create the program
		variant->m_prog = GrManager::getSingleton().newShaderProgram(progInf);
	}
	else
	{
		ANKI_ASSERT(!!(info.m_shaderTypes & ShaderTypeBit::kAllRayTracing));

		U32 techniqueIdx = kMaxU32;
		for(ShaderType shaderType : EnumBitsIterable<ShaderType, ShaderTypeBit>(info.m_shaderTypes))
		{
			const U32 idx = findTechnique(info.m_techniqueNames[shaderType].getBegin());
			if(techniqueIdx == kMaxU32)
			{
				techniqueIdx = idx;
			}
			else
			{
				ANKI_ASSERT(idx == techniqueIdx && "Can't mix and match different techniques in ray tracing");
			}
		}
		ANKI_ASSERT(techniqueIdx != kMaxU32);

		// Find the library
		const CString libName = m_binary->m_techniques[techniqueIdx].m_name.getBegin();
		ANKI_ASSERT(libName.getLength() > 0);

		const ShaderProgramResourceSystem& progSystem = ShaderProgramResourceSystem::getSingleton();
		const ShaderProgramRaytracingLibrary* foundLib = nullptr;
		for(const ShaderProgramRaytracingLibrary& lib : progSystem.getRayTracingLibraries())
		{
			if(lib.getLibraryName() == libName)
			{
				foundLib = &lib;
				break;
			}
		}
		ANKI_ASSERT(foundLib);

		variant->m_prog = foundLib->getShaderProgram();

		RayTracingShaderGroupType groupType;
		if(!!(info.m_shaderTypes & ShaderTypeBit::kRayGen))
		{
			groupType = RayTracingShaderGroupType::kRayGen;
		}
		else if(!!(info.m_shaderTypes & ShaderTypeBit::kMiss))
		{
			groupType = RayTracingShaderGroupType::kMiss;
		}
		else
		{
			ANKI_ASSERT(!!(info.m_shaderTypes & ShaderTypeBit::kAllHit));
			groupType = RayTracingShaderGroupType::kHit;
		}

		// Set the group handle index
		variant->m_shaderGroupHandleIndex = foundLib->getShaderGroupHandleIndex(getFilename(), mutationHash, groupType);
	}

	return variant;
}

} // end namespace anki