2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "gles-graphics-pipeline-cache.h"
20 #include "egl-graphics-controller.h"
21 #include "gles-graphics-pipeline.h"
22 #include "gles-graphics-program.h"
24 namespace Dali::Graphics::GLES
27 * @brief custom delete function for cached object
30 struct CachedObjectDeleter
32 CachedObjectDeleter() = default;
34 void operator()(T* object)
36 // Discard resource (add it to discard queue)
37 object->DiscardResource();
42 struct CachedObjectDeleter<GLES::Program>
44 CachedObjectDeleter() = default;
46 void operator()(GLES::Program* object)
48 // Program deleter should skip discard queue if controller shutting down
49 if(!object->GetController().IsShuttingDown())
51 object->DiscardResource();
55 // delete object otherwise
62 * @brief The order of states being stored in the cache and mask
64 enum class StateLookupIndex : uint32_t
66 COLOR_BLEND_STATE_BIT = 0,
67 VIEWPORT_STATE_BIT = 1,
68 BASE_PIPELINE_STATE_BIT = 2,
69 DEPTH_STENCIL_STATE_BIT = 3,
70 RASTERIZATION_STATE_BIT = 4,
71 VERTEX_INPUT_STATE_BIT = 5,
72 INPUT_ASSEMBLY_STATE_BIT = 6,
77 * Helper float compare function
79 static bool cmpf(float A, float B, float epsilon = 0.005f)
81 return (fabs(A - B) < epsilon);
87 static bool operator==(const Graphics::Viewport& lhs, const Graphics::Viewport& rhs)
89 return cmpf(lhs.x, rhs.x) &&
91 cmpf(lhs.width, rhs.width) &&
92 cmpf(lhs.height, rhs.height) &&
93 cmpf(lhs.minDepth, rhs.minDepth) &&
94 cmpf(lhs.maxDepth, rhs.maxDepth);
97 static bool operator==(const Graphics::Rect2D& lhs, const Graphics::Rect2D& rhs)
99 return cmpf(lhs.x, rhs.x) &&
100 cmpf(lhs.y, rhs.y) &&
101 cmpf(lhs.width, rhs.width) &&
102 cmpf(lhs.height, rhs.height);
105 static bool operator==(const Graphics::StencilOpState& lhs, const Graphics::StencilOpState& rhs)
107 return lhs.failOp == rhs.failOp &&
108 lhs.passOp == rhs.passOp &&
109 lhs.depthFailOp == rhs.depthFailOp &&
110 lhs.compareOp == rhs.compareOp &&
111 lhs.compareMask == rhs.compareMask &&
112 lhs.writeMask == rhs.writeMask &&
113 lhs.reference == rhs.reference;
117 operator==(const Dali::Graphics::VertexInputState::Attribute& lhs,
118 const Dali::Graphics::VertexInputState::Attribute& rhs)
120 return lhs.location == rhs.location &&
121 lhs.binding == rhs.binding &&
122 lhs.offset == rhs.offset &&
123 lhs.format == rhs.format;
127 operator==(const Dali::Graphics::VertexInputState::Binding& lhs, const Dali::Graphics::VertexInputState::Binding& rhs)
129 return lhs.stride == rhs.stride &&
130 lhs.inputRate == rhs.inputRate;
133 using PipelineStateCompateFunctionType = bool(const Graphics::PipelineCreateInfo*,
134 const Graphics::PipelineCreateInfo*);
136 static std::vector<PipelineStateCompateFunctionType*> STATE_COMPARE_FUNC_TABLE{};
139 * @brief Initialises compare function lookup table
141 void InitialiseStateCompareLookupTable()
143 STATE_COMPARE_FUNC_TABLE = {
144 [](const auto* lhs, const auto* rhs) -> bool // colorBlendState
146 const auto& lcb = *lhs->colorBlendState;
147 const auto& rcb = *rhs->colorBlendState;
148 return lcb.logicOpEnable == rcb.logicOpEnable &&
149 lcb.logicOp == rcb.logicOp &&
150 cmpf(lcb.blendConstants[0], rcb.blendConstants[0]) &&
151 cmpf(lcb.blendConstants[1], rcb.blendConstants[1]) &&
152 cmpf(lcb.blendConstants[2], rcb.blendConstants[2]) &&
153 cmpf(lcb.blendConstants[3], rcb.blendConstants[3]) &&
154 lcb.blendEnable == rcb.blendEnable &&
155 lcb.srcColorBlendFactor == rcb.srcColorBlendFactor &&
156 lcb.dstColorBlendFactor == rcb.dstColorBlendFactor &&
157 lcb.colorBlendOp == rcb.colorBlendOp &&
158 lcb.srcAlphaBlendFactor == rcb.srcAlphaBlendFactor &&
159 lcb.dstAlphaBlendFactor == rcb.dstAlphaBlendFactor &&
160 lcb.alphaBlendOp == rcb.alphaBlendOp &&
161 lcb.colorComponentWriteBits == rcb.colorComponentWriteBits;
163 [](const auto* lhs, const auto* rhs) -> bool // viewport state
165 const auto& lvp = *lhs->viewportState;
166 const auto& rvp = *rhs->viewportState;
167 return lvp.viewport == rvp.viewport &&
168 lvp.scissor == rvp.scissor &&
169 lvp.scissorTestEnable == rvp.scissorTestEnable;
171 [](const auto* lhs, const auto* rhs) -> bool // basePipeline
173 return lhs->basePipeline == rhs->basePipeline;
175 [](const auto* lhs, const auto* rhs) -> bool // depthStencilState
177 const auto& lds = *lhs->depthStencilState;
178 const auto& rds = *rhs->depthStencilState;
179 return lds.depthTestEnable == rds.depthTestEnable &&
180 lds.depthWriteEnable == rds.depthWriteEnable &&
181 lds.depthCompareOp == rds.depthCompareOp &&
182 lds.stencilTestEnable == rds.stencilTestEnable &&
183 lds.front == rds.front &&
184 lds.back == rds.back;
186 [](const auto* lhs, const auto* rhs) -> bool // rasterizationState
188 const auto& lrs = *lhs->rasterizationState;
189 const auto& rrs = *rhs->rasterizationState;
190 return lrs.cullMode == rrs.cullMode &&
191 lrs.polygonMode == rrs.polygonMode &&
192 lrs.frontFace == rrs.frontFace;
194 [](const auto* lhs, const auto* rhs) -> bool // vertexInputState
196 const auto& lvi = *lhs->vertexInputState;
197 const auto& rvi = *rhs->vertexInputState;
198 return lvi.bufferBindings.size() == rvi.bufferBindings.size() &&
199 lvi.attributes.size() == rvi.attributes.size() &&
200 std::equal(lvi.bufferBindings.begin(), lvi.bufferBindings.end(), rvi.bufferBindings.begin(), [](const auto& lhs, const auto& rhs) {
201 return operator==(lhs, rhs);
203 std::equal(lvi.attributes.begin(), lvi.attributes.end(), rvi.attributes.begin(), [](const auto& lhs, const auto& rhs) {
204 return operator==(lhs, rhs);
207 [](const auto* lhs, const auto* rhs) -> bool // inputAssemblyState
209 const auto& lia = *lhs->inputAssemblyState;
210 const auto& ria = *rhs->inputAssemblyState;
211 return lia.topology == ria.topology &&
212 lia.primitiveRestartEnable == ria.primitiveRestartEnable;
218 * @brief Helper function calculating the bitmask of set states
220 * @param[in] info Valid PipelineCreateInfo structure
221 * @return bitmask of set states
223 inline uint32_t GetStateBitmask(const PipelineCreateInfo& info)
226 mask |= bool(info.colorBlendState) << int(StateLookupIndex::COLOR_BLEND_STATE_BIT);
227 mask |= bool(info.viewportState) << int(StateLookupIndex::VIEWPORT_STATE_BIT);
228 mask |= bool(info.basePipeline) << int(StateLookupIndex::BASE_PIPELINE_STATE_BIT);
229 mask |= bool(info.depthStencilState) << int(StateLookupIndex::DEPTH_STENCIL_STATE_BIT);
230 mask |= bool(info.rasterizationState) << int(StateLookupIndex::RASTERIZATION_STATE_BIT);
231 mask |= bool(info.vertexInputState) << int(StateLookupIndex::VERTEX_INPUT_STATE_BIT);
232 mask |= bool(info.inputAssemblyState) << int(StateLookupIndex::INPUT_ASSEMBLY_STATE_BIT);
237 * @brief Implementation of cache
239 struct PipelineCache::Impl
244 explicit Impl(EglGraphicsController& _controller)
245 : controller(_controller)
247 // Initialise lookup table
248 InitialiseStateCompareLookupTable();
256 // First destroy pipelines
260 programEntries.clear();
264 * @brief Structure describes a single cache entry
268 CacheEntry() = default;
270 CacheEntry(UniquePtr<PipelineImpl>&& _pipeline, uint32_t _bitmask)
271 : pipeline(std::move(_pipeline)),
272 stateBitmask(_bitmask)
276 ~CacheEntry() = default;
278 CacheEntry(CacheEntry&&) = default;
279 CacheEntry& operator=(CacheEntry&&) = default;
281 UniquePtr<PipelineImpl> pipeline{nullptr};
282 uint32_t stateBitmask{0u};
285 EglGraphicsController& controller;
286 std::vector<CacheEntry> entries;
289 * @brief Sorted array of shaders used to create program
291 struct ProgramCacheEntry
293 // sorted array of shaders
294 std::vector<const Graphics::Shader*> shaders;
295 UniquePtr<ProgramImpl> program{nullptr};
298 std::vector<ProgramCacheEntry> programEntries;
301 PipelineCache::PipelineCache(EglGraphicsController& controller)
303 mImpl = std::make_unique<Impl>(controller);
306 PipelineCache::~PipelineCache() = default;
308 PipelineImpl* PipelineCache::FindPipelineImpl(const PipelineCreateInfo& info)
310 auto bitmask = GetStateBitmask(info);
312 for(auto& entry : mImpl->entries)
314 auto& pipeline = entry.pipeline;
315 auto& cacheInfo = pipeline->GetCreateInfo();
316 if(!info.programState)
321 // Check whether the program is the same
322 if(info.programState->program)
324 const auto& lhsProgram = *static_cast<const GLES::Program*>(info.programState->program);
325 const auto& rhsProgram = *static_cast<const GLES::Program*>(cacheInfo.programState->program);
326 if(lhsProgram != rhsProgram)
331 // Test whether set states bitmask matches
332 if(entry.stateBitmask != bitmask)
337 // Now test only for states that are set
339 for(i = 0; i < int(StateLookupIndex::MAX_STATE); ++i)
341 // Test only set states
342 if((entry.stateBitmask & (1 << i)))
344 if(!STATE_COMPARE_FUNC_TABLE[i](&info, &cacheInfo))
351 // TODO: For now ignoring dynamic state mask and allocator
352 // Getting as far as here, we have found our pipeline impl
353 if(i == int(StateLookupIndex::MAX_STATE))
355 return pipeline.get();
362 ProgramImpl* PipelineCache::FindProgramImpl(const ProgramCreateInfo& info)
364 if(mImpl->programEntries.empty())
369 // assert if no shaders given
370 std::vector<const Graphics::Shader*> shaders;
371 shaders.reserve(info.shaderState->size());
373 for(auto& state : *info.shaderState)
375 shaders.push_back(state.shader);
379 std::sort(shaders.begin(), shaders.end());
381 for(auto& item : mImpl->programEntries)
383 if(item.shaders.size() != shaders.size())
388 int k = shaders.size();
389 while(--k >= 0 && item.shaders[k] == shaders[k])
394 return item.program.get();
400 Graphics::UniquePtr<Graphics::Pipeline> PipelineCache::GetPipeline(const PipelineCreateInfo& pipelineCreateInfo,
401 Graphics::UniquePtr<Graphics::Pipeline>&& oldPipeline)
403 auto cachedPipeline = FindPipelineImpl(pipelineCreateInfo);
405 // Return same pointer if nothing changed
406 if(oldPipeline && *static_cast<GLES::Pipeline*>(oldPipeline.get()) == cachedPipeline)
408 return std::move(oldPipeline);
413 // create new pipeline
414 auto pipeline = MakeUnique<GLES::PipelineImpl>(pipelineCreateInfo, mImpl->controller, *this);
416 cachedPipeline = pipeline.get();
419 mImpl->entries.emplace_back(std::move(pipeline), GetStateBitmask(pipelineCreateInfo));
422 auto wrapper = MakeUnique<GLES::Pipeline, CachedObjectDeleter<GLES::Pipeline>>(*cachedPipeline);
423 return std::move(wrapper);
426 Graphics::UniquePtr<Graphics::Program> PipelineCache::GetProgram(const ProgramCreateInfo& programCreateInfo,
427 Graphics::UniquePtr<Graphics::Program>&& oldProgram)
429 ProgramImpl* cachedProgram = FindProgramImpl(programCreateInfo);
431 // Return same pointer if nothing changed
432 if(oldProgram && *static_cast<GLES::Program*>(oldProgram.get()) == cachedProgram)
434 return std::move(oldProgram);
439 // create new pipeline
440 auto program = MakeUnique<GLES::ProgramImpl>(programCreateInfo, mImpl->controller);
444 cachedProgram = program.get();
447 mImpl->programEntries.emplace_back();
448 auto& item = mImpl->programEntries.back();
449 item.program = std::move(program);
450 for(auto& state : *programCreateInfo.shaderState)
452 item.shaders.push_back(state.shader);
455 std::sort(item.shaders.begin(), item.shaders.end());
458 auto wrapper = MakeUnique<GLES::Program, CachedObjectDeleter<GLES::Program>>(cachedProgram);
459 return std::move(wrapper);
462 void PipelineCache::FlushCache()
464 decltype(mImpl->entries) newEntries;
465 newEntries.reserve(mImpl->entries.size());
467 for(auto& entry : mImpl->entries)
469 // Move items which are still in use into the new array
470 if(entry.pipeline->GetRefCount() != 0)
472 newEntries.emplace_back(std::move(entry));
476 // Move temporary array in place of stored cache
477 // Unused pipelines will be deleted automatically
478 mImpl->entries = std::move(newEntries);
480 // TODO: program cache may require similar action. However,
481 // since there is always one wrapper for Program object
482 // kept in the pipeline, then death of pipeline will result
483 // killing the program (if program isn't in use anymore)
486 } // namespace Dali::Graphics::GLES