2 * Copyright (c) 2023 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 <dali/internal/render/renderers/pipeline-cache.h>
21 #include <dali/graphics-api/graphics-types.h>
22 #include <dali/integration-api/debug.h>
23 #include <dali/internal/render/common/render-instruction.h>
24 #include <dali/internal/render/renderers/render-renderer.h>
25 #include <dali/internal/render/renderers/render-vertex-buffer.h>
26 #include <dali/internal/render/shaders/program.h>
28 namespace Dali::Internal::Render
32 constexpr uint32_t CACHE_CLEAN_FRAME_COUNT = 600; // 60fps * 10sec
34 // Helper to get the vertex input format
35 Dali::Graphics::VertexInputFormat GetPropertyVertexFormat(Property::Type propertyType)
37 Dali::Graphics::VertexInputFormat type{};
41 case Property::BOOLEAN:
43 type = Dali::Graphics::VertexInputFormat::UNDEFINED; // type = GL_BYTE; @todo new type for this?
46 case Property::INTEGER:
48 type = Dali::Graphics::VertexInputFormat::INTEGER; // (short)
53 type = Dali::Graphics::VertexInputFormat::FLOAT;
56 case Property::VECTOR2:
58 type = Dali::Graphics::VertexInputFormat::FVECTOR2;
61 case Property::VECTOR3:
63 type = Dali::Graphics::VertexInputFormat::FVECTOR3;
66 case Property::VECTOR4:
68 type = Dali::Graphics::VertexInputFormat::FVECTOR4;
73 type = Dali::Graphics::VertexInputFormat::UNDEFINED;
80 constexpr Graphics::CullMode ConvertCullFace(Dali::FaceCullingMode::Type mode)
84 case Dali::FaceCullingMode::NONE:
86 return Graphics::CullMode::NONE;
88 case Dali::FaceCullingMode::FRONT:
90 return Graphics::CullMode::FRONT;
92 case Dali::FaceCullingMode::BACK:
94 return Graphics::CullMode::BACK;
96 case Dali::FaceCullingMode::FRONT_AND_BACK:
98 return Graphics::CullMode::FRONT_AND_BACK;
102 return Graphics::CullMode::NONE;
107 constexpr Graphics::BlendFactor ConvertBlendFactor(BlendFactor::Type blendFactor)
111 case BlendFactor::ZERO:
112 return Graphics::BlendFactor::ZERO;
113 case BlendFactor::ONE:
114 return Graphics::BlendFactor::ONE;
115 case BlendFactor::SRC_COLOR:
116 return Graphics::BlendFactor::SRC_COLOR;
117 case BlendFactor::ONE_MINUS_SRC_COLOR:
118 return Graphics::BlendFactor::ONE_MINUS_SRC_COLOR;
119 case BlendFactor::SRC_ALPHA:
120 return Graphics::BlendFactor::SRC_ALPHA;
121 case BlendFactor::ONE_MINUS_SRC_ALPHA:
122 return Graphics::BlendFactor::ONE_MINUS_SRC_ALPHA;
123 case BlendFactor::DST_ALPHA:
124 return Graphics::BlendFactor::DST_ALPHA;
125 case BlendFactor::ONE_MINUS_DST_ALPHA:
126 return Graphics::BlendFactor::ONE_MINUS_DST_ALPHA;
127 case BlendFactor::DST_COLOR:
128 return Graphics::BlendFactor::DST_COLOR;
129 case BlendFactor::ONE_MINUS_DST_COLOR:
130 return Graphics::BlendFactor::ONE_MINUS_DST_COLOR;
131 case BlendFactor::SRC_ALPHA_SATURATE:
132 return Graphics::BlendFactor::SRC_ALPHA_SATURATE;
133 case BlendFactor::CONSTANT_COLOR:
134 return Graphics::BlendFactor::CONSTANT_COLOR;
135 case BlendFactor::ONE_MINUS_CONSTANT_COLOR:
136 return Graphics::BlendFactor::ONE_MINUS_CONSTANT_COLOR;
137 case BlendFactor::CONSTANT_ALPHA:
138 return Graphics::BlendFactor::CONSTANT_ALPHA;
139 case BlendFactor::ONE_MINUS_CONSTANT_ALPHA:
140 return Graphics::BlendFactor::ONE_MINUS_CONSTANT_ALPHA;
142 return Graphics::BlendFactor();
146 constexpr Graphics::BlendOp ConvertBlendEquation(DevelBlendEquation::Type blendEquation)
148 switch(blendEquation)
150 case DevelBlendEquation::ADD:
151 return Graphics::BlendOp::ADD;
152 case DevelBlendEquation::SUBTRACT:
153 return Graphics::BlendOp::SUBTRACT;
154 case DevelBlendEquation::REVERSE_SUBTRACT:
155 return Graphics::BlendOp::REVERSE_SUBTRACT;
156 case DevelBlendEquation::COLOR:
157 return Graphics::BlendOp::COLOR;
158 case DevelBlendEquation::COLOR_BURN:
159 return Graphics::BlendOp::COLOR_BURN;
160 case DevelBlendEquation::COLOR_DODGE:
161 return Graphics::BlendOp::COLOR_DODGE;
162 case DevelBlendEquation::DARKEN:
163 return Graphics::BlendOp::DARKEN;
164 case DevelBlendEquation::DIFFERENCE:
165 return Graphics::BlendOp::DIFFERENCE;
166 case DevelBlendEquation::EXCLUSION:
167 return Graphics::BlendOp::EXCLUSION;
168 case DevelBlendEquation::HARD_LIGHT:
169 return Graphics::BlendOp::HARD_LIGHT;
170 case DevelBlendEquation::HUE:
171 return Graphics::BlendOp::HUE;
172 case DevelBlendEquation::LIGHTEN:
173 return Graphics::BlendOp::LIGHTEN;
174 case DevelBlendEquation::LUMINOSITY:
175 return Graphics::BlendOp::LUMINOSITY;
176 case DevelBlendEquation::MAX:
177 return Graphics::BlendOp::MAX;
178 case DevelBlendEquation::MIN:
179 return Graphics::BlendOp::MIN;
180 case DevelBlendEquation::MULTIPLY:
181 return Graphics::BlendOp::MULTIPLY;
182 case DevelBlendEquation::OVERLAY:
183 return Graphics::BlendOp::OVERLAY;
184 case DevelBlendEquation::SATURATION:
185 return Graphics::BlendOp::SATURATION;
186 case DevelBlendEquation::SCREEN:
187 return Graphics::BlendOp::SCREEN;
188 case DevelBlendEquation::SOFT_LIGHT:
189 return Graphics::BlendOp::SOFT_LIGHT;
191 return Graphics::BlendOp{};
195 PipelineCacheL0Ptr PipelineCache::GetPipelineCacheL0(std::size_t hash, Program* program, Render::Geometry* geometry)
197 auto it = std::find_if(level0nodes.begin(), level0nodes.end(), [hash, program, geometry](PipelineCacheL0& item) { return ((item.hash == hash && item.program == program && item.geometry == geometry)); });
199 // Add new node to cache
200 if(it == level0nodes.end())
202 uint32_t bindingIndex{0u};
203 auto& reflection = graphicsController->GetProgramReflection(program->GetGraphicsProgram());
205 Graphics::VertexInputState vertexInputState{};
208 for(auto&& vertexBuffer : geometry->GetVertexBuffers())
210 const VertexBuffer::Format& vertexFormat = *vertexBuffer->GetFormat();
212 uint32_t divisor = vertexBuffer->GetDivisor();
213 Graphics::VertexInputRate vertexInputRate = (divisor == 0
214 ? Graphics::VertexInputRate::PER_VERTEX
215 : Graphics::VertexInputRate::PER_INSTANCE);
217 vertexInputState.bufferBindings.emplace_back(vertexFormat.size, // stride
219 //@todo Add the actual rate to the graphics struct
221 const uint32_t attributeCount = vertexBuffer->GetAttributeCount();
222 uint32_t lastBoundAttributeIndex = 0;
223 for(uint32_t i = 0; i < attributeCount; ++i)
225 auto attributeName = vertexBuffer->GetAttributeName(i);
226 int32_t pLocation = reflection.GetVertexAttributeLocation(std::string(attributeName.GetStringView()));
229 auto location = static_cast<uint32_t>(pLocation);
230 vertexInputState.attributes.emplace_back(location,
232 vertexFormat.components[i].offset,
233 GetPropertyVertexFormat(vertexFormat.components[i].type));
234 ++lastBoundAttributeIndex;
238 DALI_LOG_WARNING("Attribute not found in the shader: %s\n", attributeName.GetCString());
239 // Don't bind unused attributes.
242 base += lastBoundAttributeIndex;
245 PipelineCacheL0 level0;
247 level0.program = program;
248 level0.geometry = geometry;
249 level0.inputState = vertexInputState;
251 it = level0nodes.insert(level0nodes.end(), std::move(level0));
257 PipelineCacheL1Ptr PipelineCacheL0::GetPipelineCacheL1(Render::Renderer* renderer, bool usingReflection)
259 // hash must be collision free
261 auto topo = (uint32_t(geometry->GetTopology()) & 0xffu);
262 auto cull = (uint32_t(renderer->GetFaceCullMode()) & 0xffu);
264 static const Graphics::PolygonMode polyTable[] = {
265 Graphics::PolygonMode::POINT,
266 Graphics::PolygonMode::LINE,
267 Graphics::PolygonMode::LINE,
268 Graphics::PolygonMode::LINE,
269 Graphics::PolygonMode::FILL,
270 Graphics::PolygonMode::FILL,
271 Graphics::PolygonMode::FILL};
273 auto poly = polyTable[topo];
275 static const FaceCullingMode::Type adjFaceCullingMode[4] =
277 FaceCullingMode::NONE,
278 FaceCullingMode::BACK,
279 FaceCullingMode::FRONT,
280 FaceCullingMode::FRONT_AND_BACK,
283 static const FaceCullingMode::Type normalFaceCullingMode[4] =
285 FaceCullingMode::NONE,
286 FaceCullingMode::FRONT,
287 FaceCullingMode::BACK,
288 FaceCullingMode::FRONT_AND_BACK,
291 static const FaceCullingMode::Type* cullModeTable[2] = {
292 normalFaceCullingMode,
295 // Retrieve cull mode
296 auto cullModeTableIndex = uint32_t(usingReflection) & 1u;
297 cull = cullModeTable[cullModeTableIndex][renderer->GetFaceCullMode()];
299 hash = (topo & 0xffu) | ((cull << 8u) & 0xff00u) | ((uint32_t(poly) << 16u) & 0xff0000u);
301 // If L1 not found by hash, create rasterization state describing pipeline and store it
302 auto it = std::find_if(level1nodes.begin(), level1nodes.end(), [hash](PipelineCacheL1& item) { return item.hashCode == hash; });
304 if(it == level1nodes.end())
306 PipelineCacheL1 item;
307 item.hashCode = hash;
308 item.rs.cullMode = ConvertCullFace(FaceCullingMode::Type(cull));
309 item.rs.frontFace = Graphics::FrontFace::COUNTER_CLOCKWISE;
310 item.rs.polygonMode = poly; // not in use
311 item.ia.topology = geometry->GetTopology();
313 it = level1nodes.insert(level1nodes.end(), std::move(item));
319 void PipelineCacheL0::ClearUnusedCache()
321 for(auto iter = level1nodes.begin(); iter != level1nodes.end();)
323 if(iter->ClearUnusedCache())
325 iter = level1nodes.erase(iter);
334 PipelineCacheL2Ptr PipelineCacheL1::GetPipelineCacheL2(bool blend, bool premul, BlendingOptions& blendingOptions)
339 if(DALI_UNLIKELY(noBlends.empty()))
341 noBlends.emplace_back(PipelineCacheL2{});
344 auto& noBlend = *noBlends.begin();
346 if(noBlend.pipeline == nullptr)
348 // reset all before returning if pipeline has never been created for that case
350 memset(&noBlend.colorBlendState, 0, sizeof(Graphics::ColorBlendState));
352 return noBlends.begin();
355 auto bitmask = uint32_t(blendingOptions.GetBitmask());
357 // Find by bitmask (L2 entries must be sorted by bitmask)
358 auto it = std::find_if(level2nodes.begin(), level2nodes.end(), [bitmask](PipelineCacheL2& item) { return item.hash == bitmask; });
360 // TODO: find better way of blend constants lookup
361 PipelineCacheL2Ptr retval = level2nodes.end();
362 if(it != level2nodes.end())
364 bool hasBlendColor = blendingOptions.GetBlendColor();
365 while(hasBlendColor && it != level2nodes.end() && (*it).hash == bitmask)
367 Vector4 v(it->colorBlendState.blendConstants);
368 if(v == *blendingOptions.GetBlendColor())
380 if(retval == level2nodes.end())
382 // create new entry and return it with null pipeline
383 PipelineCacheL2 l2{};
384 l2.pipeline = nullptr;
385 auto& colorBlendState = l2.colorBlendState;
386 colorBlendState.SetBlendEnable(true);
387 Graphics::BlendOp rgbOp = ConvertBlendEquation(blendingOptions.GetBlendEquationRgb());
388 Graphics::BlendOp alphaOp = ConvertBlendEquation(blendingOptions.GetBlendEquationAlpha());
389 if(blendingOptions.IsAdvancedBlendEquationApplied() && premul)
393 DALI_LOG_ERROR("Advanced Blend Equation MUST be applied by using BlendEquation.\n");
399 .SetSrcColorBlendFactor(ConvertBlendFactor(blendingOptions.GetBlendSrcFactorRgb()))
400 .SetSrcAlphaBlendFactor(ConvertBlendFactor(blendingOptions.GetBlendSrcFactorAlpha()))
401 .SetDstColorBlendFactor(ConvertBlendFactor(blendingOptions.GetBlendDestFactorRgb()))
402 .SetDstAlphaBlendFactor(ConvertBlendFactor(blendingOptions.GetBlendDestFactorAlpha()))
403 .SetColorBlendOp(rgbOp)
404 .SetAlphaBlendOp(alphaOp);
406 // Blend color is optional and rarely used
407 auto* blendColor = const_cast<Vector4*>(blendingOptions.GetBlendColor());
410 colorBlendState.SetBlendConstants(blendColor->AsFloat());
413 l2.hash = blendingOptions.GetBitmask();
415 auto upperBound = std::upper_bound(level2nodes.begin(), level2nodes.end(), l2, [](const PipelineCacheL2& lhs, const PipelineCacheL2& rhs) { return lhs.hash < rhs.hash; });
417 level2nodes.insert(upperBound, std::move(l2));
419 // run same function to retrieve retval
420 retval = GetPipelineCacheL2(blend, premul, blendingOptions);
426 bool PipelineCacheL1::ClearUnusedCache()
428 for(auto iter = level2nodes.begin(); iter != level2nodes.end();)
430 if(iter->referenceCount == 0)
432 iter = level2nodes.erase(iter);
440 if(!noBlends.empty() && noBlends.begin()->referenceCount > 0)
445 return level2nodes.empty();
448 void PipelineCacheQueryInfo::GenerateHash()
450 // Lightweight hash value generation.
451 hash = (reinterpret_cast<std::size_t>(program) >> Dali::Log<sizeof(decltype(*program))>::value) ^
452 (reinterpret_cast<std::size_t>(geometry) >> Dali::Log<sizeof(decltype(*geometry))>::value) ^
453 ((blendingEnabled ? 1u : 0u) << 0u) ^
454 ((alphaPremultiplied ? 1u : 0u) << 1u) ^
455 (static_cast<std::size_t>(geometry->GetTopology()) << 2u) ^
456 (static_cast<std::size_t>(renderer->GetFaceCullMode()) << 5u) ^
457 ((cameraUsingReflection ? 1u : 0u) << 8u) ^
458 (blendingEnabled ? static_cast<std::size_t>(blendingOptions->GetBitmask()) : 0xDA11u);
461 bool PipelineCacheQueryInfo::Equal(const PipelineCacheQueryInfo& lhs, const PipelineCacheQueryInfo& rhs) noexcept
463 // Naive equal check.
464 const bool ret = (lhs.hash == rhs.hash) && // Check hash value first
465 (lhs.program == rhs.program) &&
466 (lhs.geometry == rhs.geometry) &&
467 (lhs.blendingEnabled == rhs.blendingEnabled) &&
468 (lhs.alphaPremultiplied == rhs.alphaPremultiplied) &&
469 (lhs.geometry->GetTopology() == rhs.geometry->GetTopology()) &&
470 (lhs.renderer->GetFaceCullMode() == rhs.renderer->GetFaceCullMode()) &&
471 (lhs.cameraUsingReflection == rhs.cameraUsingReflection) &&
472 (!lhs.blendingEnabled ||
473 (lhs.blendingOptions->GetBitmask() == rhs.blendingOptions->GetBitmask() &&
474 ((lhs.blendingOptions->GetBlendColor() == nullptr && rhs.blendingOptions->GetBlendColor() == nullptr) ||
475 (lhs.blendingOptions->GetBlendColor() &&
476 rhs.blendingOptions->GetBlendColor() &&
477 (*lhs.blendingOptions->GetBlendColor() == *rhs.blendingOptions->GetBlendColor())))));
482 PipelineCache::PipelineCache(Graphics::Controller& controller)
483 : graphicsController(&controller)
485 // Clean up cache first
486 CleanLatestUsedCache();
489 PipelineResult PipelineCache::GetPipeline(const PipelineCacheQueryInfo& queryInfo, bool createNewIfNotFound)
491 // Seperate branch whether query use blending or not.
492 const int latestUsedCacheIndex = queryInfo.blendingEnabled ? 0 : 1;
494 // If we can reuse latest bound pipeline, Fast return.
495 if(ReuseLatestBoundPipeline(latestUsedCacheIndex, queryInfo))
497 mLatestResult[latestUsedCacheIndex].level2->referenceCount++;
498 return mLatestResult[latestUsedCacheIndex];
501 auto level0 = GetPipelineCacheL0(queryInfo.hash, queryInfo.program, queryInfo.geometry);
502 auto level1 = level0->GetPipelineCacheL1(queryInfo.renderer, queryInfo.cameraUsingReflection);
504 PipelineCachePtr level2 = level1->GetPipelineCacheL2(queryInfo.blendingEnabled, queryInfo.alphaPremultiplied, *queryInfo.blendingOptions);
506 // Create new pipeline at level2 if requested
507 if(level2->pipeline == nullptr && createNewIfNotFound)
509 Graphics::ProgramState programState{};
510 programState.program = &queryInfo.program->GetGraphicsProgram();
511 // Create the pipeline
512 Graphics::PipelineCreateInfo createInfo;
514 .SetInputAssemblyState(&level1->ia)
515 .SetVertexInputState(&level0->inputState)
516 .SetRasterizationState(&level1->rs)
517 .SetColorBlendState(&level2->colorBlendState)
518 .SetProgramState(&programState);
520 // Store a pipeline per renderer per render (renderer can be owned by multiple nodes,
521 // and re-drawn in multiple instructions).
522 level2->pipeline = graphicsController->CreatePipeline(createInfo, nullptr);
525 PipelineResult result{};
527 result.pipeline = level2->pipeline.get();
528 result.level2 = level2;
530 level2->referenceCount++;
532 // Copy query and result
533 mLatestQuery[latestUsedCacheIndex] = queryInfo;
534 mLatestResult[latestUsedCacheIndex] = result;
539 bool PipelineCache::ReuseLatestBoundPipeline(const int latestUsedCacheIndex, const PipelineCacheQueryInfo& queryInfo) const
541 return mLatestResult[latestUsedCacheIndex].pipeline != nullptr && PipelineCacheQueryInfo::Equal(queryInfo, mLatestQuery[latestUsedCacheIndex]);
544 void PipelineCache::PreRender()
546 CleanLatestUsedCache();
548 // We don't need to check this every frame
549 if(++mFrameCount >= CACHE_CLEAN_FRAME_COUNT)
556 void PipelineCache::ClearUnusedCache()
558 for(auto iter = level0nodes.begin(); iter != level0nodes.end();)
560 iter->ClearUnusedCache();
562 if(iter->level1nodes.empty())
564 iter = level0nodes.erase(iter);
573 void PipelineCache::ResetPipeline(PipelineCachePtr pipelineCache)
575 // TODO : Can we always assume that pipelineCache input is valid iterator?
576 pipelineCache->referenceCount--;
579 } // namespace Dali::Internal::Render