Memory leak fix for SamplingRoutine cache
- The SamplingRoutine cache is now owned by the Device and
has the same lifetime as the device, which means it gets
released when the device gets released.
- Added a utility class, SamplingRoutineCache, to contain
the cache and release all routine entries upon destruction.
- Added a pointer to the current device in the sampler object
in order to retrieve it during sampling, in order to access
the routine cache
- The cache is now internally an LRUCache, so it can't cache
a large quantity of routines and take up a lot of memory.
Bug b/129523279 b/137649247 b/137524292 chromium:971325
Change-Id: If4ff1fbc87962355d0a281b9d0acace4316a02b8
Reviewed-on: https://swiftshader-review.googlesource.com/c/SwiftShader/+/32688
Tested-by: Alexis Hétu <sugoi@google.com>
Presubmit-Ready: Alexis Hétu <sugoi@google.com>
Reviewed-by: Chris Forbes <chrisforbes@google.com>
Kokoro-Presubmit: kokoro <noreply+kokoro@google.com>
diff --git a/src/Pipeline/SpirvShaderSampling.cpp b/src/Pipeline/SpirvShaderSampling.cpp
index 6d067e1..ba6f2ac 100644
--- a/src/Pipeline/SpirvShaderSampling.cpp
+++ b/src/Pipeline/SpirvShaderSampling.cpp
@@ -16,13 +16,11 @@
#include "SamplerCore.hpp" // TODO: Figure out what's needed.
#include "System/Math.hpp"
-#include "Vulkan/VkBuffer.hpp"
#include "Vulkan/VkDebug.hpp"
-#include "Vulkan/VkDescriptorSet.hpp"
-#include "Vulkan/VkPipelineLayout.hpp"
+#include "Vulkan/VkDescriptorSetLayout.hpp"
+#include "Vulkan/VkDevice.hpp"
#include "Vulkan/VkImageView.hpp"
#include "Vulkan/VkSampler.hpp"
-#include "Vulkan/VkDescriptorSetLayout.hpp"
#include "Device/Config.hpp"
#include <spirv/unified1/spirv.hpp>
@@ -31,31 +29,6 @@
#include <climits>
#include <mutex>
-namespace
-{
-
-struct SamplingRoutineKey
-{
- uint32_t instruction;
- uint32_t sampler;
- uint32_t imageView;
-
- bool operator==(const SamplingRoutineKey &rhs) const
- {
- return instruction == rhs.instruction && sampler == rhs.sampler && imageView == rhs.imageView;
- }
-
- struct Hash
- {
- std::size_t operator()(const SamplingRoutineKey &key) const noexcept
- {
- return (key.instruction << 16) ^ (key.sampler << 8) ^ key.imageView;
- }
- };
-};
-
-}
-
namespace sw {
SpirvShader::ImageSampler *SpirvShader::getImageSampler(uint32_t inst, vk::SampledImageDescriptor const *imageDescriptor, const vk::Sampler *sampler)
@@ -63,15 +36,18 @@
ImageInstruction instruction(inst);
ASSERT(imageDescriptor->imageViewId != 0 && (sampler->id != 0 || instruction.samplerMethod == Fetch));
- // TODO(b/129523279): Move somewhere sensible.
- static std::unordered_map<SamplingRoutineKey, ImageSampler*, SamplingRoutineKey::Hash> cache;
- static std::mutex mutex;
+ vk::Device::SamplingRoutineCache::Key key = {inst, imageDescriptor->imageViewId, sampler->id};
- SamplingRoutineKey key = {inst, imageDescriptor->imageViewId, sampler->id};
+ ASSERT(imageDescriptor->device);
- std::unique_lock<std::mutex> lock(mutex);
- auto it = cache.find(key);
- if (it != cache.end()) { return it->second; }
+ std::unique_lock<std::mutex> lock(imageDescriptor->device->getSamplingRoutineCacheMutex());
+ vk::Device::SamplingRoutineCache* cache = imageDescriptor->device->getSamplingRoutineCache();
+
+ rr::Routine* routine = cache->query(key);
+ if(routine)
+ {
+ return (ImageSampler*)(routine->getEntry());
+ }
auto type = imageDescriptor->type;
@@ -108,13 +84,13 @@
UNSUPPORTED("anisotropyEnable");
}
- auto fptr = emitSamplerFunction(instruction, samplerState);
+ routine = emitSamplerRoutine(instruction, samplerState);
- cache.emplace(key, fptr);
- return fptr;
+ cache->add(key, routine);
+ return (ImageSampler*)(routine->getEntry());
}
-SpirvShader::ImageSampler *SpirvShader::emitSamplerFunction(ImageInstruction instruction, const Sampler &samplerState)
+rr::Routine *SpirvShader::emitSamplerRoutine(ImageInstruction instruction, const Sampler &samplerState)
{
// TODO(b/129523279): Hold a separate mutex lock for the sampler being built.
rr::Function<Void(Pointer<Byte>, Pointer<Byte>, Pointer<SIMD::Float>, Pointer<SIMD::Float>, Pointer<Byte>)> function;
@@ -231,7 +207,7 @@
}
}
- return (ImageSampler*)function("sampler")->getEntry();
+ return function("sampler");
}
sw::TextureType SpirvShader::convertTextureType(VkImageViewType imageViewType)
