dali/internal/graphics/gles-impl/gles-graphics-pipeline-cache.cpp

   1 /*
   2  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 #include "gles-graphics-pipeline-cache.h"
  19 #include <algorithm>
  20 #include "egl-graphics-controller.h"
  21 #include "gles-graphics-pipeline.h"
  22 #include "gles-graphics-program.h"
  23
  24 namespace Dali::Graphics::GLES
  25 {
  26 /**
  27  * @brief custom delete function for cached object
  28  */
  29 template<class T>
  30 struct CachedObjectDeleter
  31 {
  32   CachedObjectDeleter() = default;
  33
  34   void operator()(T* object)
  35   {
  36     // Discard resource (add it to discard queue)
  37     object->DiscardResource();
  38   }
  39 };
  40
  41 template<>
  42 struct CachedObjectDeleter<GLES::Program>
  43 {
  44   CachedObjectDeleter() = default;
  45
  46   void operator()(GLES::Program* object)
  47   {
  48     // Program deleter should skip discard queue if controller shutting down
  49     if(!object->GetController().IsShuttingDown())
  50     {
  51       object->DiscardResource();
  52     }
  53     else
  54     {
  55       // delete object otherwise
  56       delete object;
  57     }
  58   }
  59 };
  60
  61 /**
  62  * @brief The order of states being stored in the cache and mask
  63  */
  64 enum class StateLookupIndex : uint32_t
  65 {
  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,
  73   MAX_STATE                = 7
  74 };
  75
  76 /**
  77  * Helper float compare function
  78  */
  79 static bool cmpf(float A, float B, float epsilon = 0.005f)
  80 {
  81   return (fabs(A - B) < epsilon);
  82 }
  83
  84 /**
  85  * Helper operators
  86  */
  87 static bool operator==(const Graphics::Viewport& lhs, const Graphics::Viewport& rhs)
  88 {
  89   return cmpf(lhs.x, rhs.x) &&
  90          cmpf(lhs.y, rhs.y) &&
  91          cmpf(lhs.width, rhs.width) &&
  92          cmpf(lhs.height, rhs.height) &&
  93          cmpf(lhs.minDepth, rhs.minDepth) &&
  94          cmpf(lhs.maxDepth, rhs.maxDepth);
  95 }
  96
  97 static bool operator==(const Graphics::Rect2D& lhs, const Graphics::Rect2D& rhs)
  98 {
  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);
 103 }
 104
 105 static bool operator==(const Graphics::StencilOpState& lhs, const Graphics::StencilOpState& rhs)
 106 {
 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;
 114 }
 115
 116 static bool
 117 operator==(const Dali::Graphics::VertexInputState::Attribute& lhs,
 118            const Dali::Graphics::VertexInputState::Attribute& rhs)
 119 {
 120   return lhs.location == rhs.location &&
 121          lhs.binding == rhs.binding &&
 122          lhs.offset == rhs.offset &&
 123          lhs.format == rhs.format;
 124 }
 125
 126 static bool
 127 operator==(const Dali::Graphics::VertexInputState::Binding& lhs, const Dali::Graphics::VertexInputState::Binding& rhs)
 128 {
 129   return lhs.stride == rhs.stride &&
 130          lhs.inputRate == rhs.inputRate;
 131 }
 132
 133 using PipelineStateCompateFunctionType = bool(const Graphics::PipelineCreateInfo*,
 134                                               const Graphics::PipelineCreateInfo*);
 135
 136 static std::vector<PipelineStateCompateFunctionType*>& GetStateCompareFuncTable()
 137 {
 138   static std::vector<PipelineStateCompateFunctionType*> stateCompareFuncTable{};
 139   return stateCompareFuncTable;
 140 }
 141
 142 /**
 143  * @brief Initialises compare function lookup table
 144  */
 145 void InitialiseStateCompareLookupTable()
 146 {
 147   GetStateCompareFuncTable().clear();
 148   GetStateCompareFuncTable().push_back([](const auto* lhs, const auto* rhs) -> bool // colorBlendState
 149                                        {
 150                                          const auto& lcb = *lhs->colorBlendState;
 151                                          const auto& rcb = *rhs->colorBlendState;
 152                                          return lcb.logicOpEnable == rcb.logicOpEnable &&
 153                                                 lcb.logicOp == rcb.logicOp &&
 154                                                 cmpf(lcb.blendConstants[0], rcb.blendConstants[0]) &&
 155                                                 cmpf(lcb.blendConstants[1], rcb.blendConstants[1]) &&
 156                                                 cmpf(lcb.blendConstants[2], rcb.blendConstants[2]) &&
 157                                                 cmpf(lcb.blendConstants[3], rcb.blendConstants[3]) &&
 158                                                 lcb.blendEnable == rcb.blendEnable &&
 159                                                 lcb.srcColorBlendFactor == rcb.srcColorBlendFactor &&
 160                                                 lcb.dstColorBlendFactor == rcb.dstColorBlendFactor &&
 161                                                 lcb.colorBlendOp == rcb.colorBlendOp &&
 162                                                 lcb.srcAlphaBlendFactor == rcb.srcAlphaBlendFactor &&
 163                                                 lcb.dstAlphaBlendFactor == rcb.dstAlphaBlendFactor &&
 164                                                 lcb.alphaBlendOp == rcb.alphaBlendOp &&
 165                                                 lcb.colorComponentWriteBits == rcb.colorComponentWriteBits;
 166                                        });
 167   GetStateCompareFuncTable().push_back([](const auto* lhs, const auto* rhs) -> bool // viewport state
 168                                        {
 169                                          const auto& lvp = *lhs->viewportState;
 170                                          const auto& rvp = *rhs->viewportState;
 171                                          return lvp.viewport == rvp.viewport &&
 172                                                 lvp.scissor == rvp.scissor &&
 173                                                 lvp.scissorTestEnable == rvp.scissorTestEnable;
 174                                        });
 175   GetStateCompareFuncTable().push_back([](const auto* lhs, const auto* rhs) -> bool // basePipeline
 176                                        {
 177                                          return lhs->basePipeline == rhs->basePipeline;
 178                                        });
 179   GetStateCompareFuncTable().push_back([](const auto* lhs, const auto* rhs) -> bool // depthStencilState
 180                                        {
 181                                          const auto& lds = *lhs->depthStencilState;
 182                                          const auto& rds = *rhs->depthStencilState;
 183                                          return lds.depthTestEnable == rds.depthTestEnable &&
 184                                                 lds.depthWriteEnable == rds.depthWriteEnable &&
 185                                                 lds.depthCompareOp == rds.depthCompareOp &&
 186                                                 lds.stencilTestEnable == rds.stencilTestEnable &&
 187                                                 lds.front == rds.front &&
 188                                                 lds.back == rds.back;
 189                                        });
 190   GetStateCompareFuncTable().push_back([](const auto* lhs, const auto* rhs) -> bool // rasterizationState
 191                                        {
 192                                          const auto& lrs = *lhs->rasterizationState;
 193                                          const auto& rrs = *rhs->rasterizationState;
 194                                          return lrs.cullMode == rrs.cullMode &&
 195                                                 lrs.polygonMode == rrs.polygonMode &&
 196                                                 lrs.frontFace == rrs.frontFace;
 197                                        });
 198   GetStateCompareFuncTable().push_back([](const auto* lhs, const auto* rhs) -> bool // vertexInputState
 199                                        {
 200                                          const auto& lvi = *lhs->vertexInputState;
 201                                          const auto& rvi = *rhs->vertexInputState;
 202                                          return lvi.bufferBindings.size() == rvi.bufferBindings.size() &&
 203                                                 lvi.attributes.size() == rvi.attributes.size() &&
 204                                                 std::equal(lvi.bufferBindings.begin(), lvi.bufferBindings.end(), rvi.bufferBindings.begin(), [](const auto& lhs, const auto& rhs) {
 205                                                   return operator==(lhs, rhs);
 206                                                 }) &&
 207                                                 std::equal(lvi.attributes.begin(), lvi.attributes.end(), rvi.attributes.begin(), [](const auto& lhs, const auto& rhs) {
 208                                                   return operator==(lhs, rhs);
 209                                                 });
 210                                        });
 211   GetStateCompareFuncTable().push_back([](const auto* lhs, const auto* rhs) -> bool // inputAssemblyState
 212                                        {
 213                                          const auto& lia = *lhs->inputAssemblyState;
 214                                          const auto& ria = *rhs->inputAssemblyState;
 215                                          return lia.topology == ria.topology &&
 216                                                 lia.primitiveRestartEnable == ria.primitiveRestartEnable;
 217                                        });
 218 }
 219
 220 /**
 221  * @brief Helper function calculating the bitmask of set states
 222  *
 223  * @param[in] info Valid PipelineCreateInfo structure
 224  * @return bitmask of set states
 225  */
 226 inline uint32_t GetStateBitmask(const PipelineCreateInfo& info)
 227 {
 228   uint32_t mask{0u};
 229   mask |= bool(info.colorBlendState) << int(StateLookupIndex::COLOR_BLEND_STATE_BIT);
 230   mask |= bool(info.viewportState) << int(StateLookupIndex::VIEWPORT_STATE_BIT);
 231   mask |= bool(info.basePipeline) << int(StateLookupIndex::BASE_PIPELINE_STATE_BIT);
 232   mask |= bool(info.depthStencilState) << int(StateLookupIndex::DEPTH_STENCIL_STATE_BIT);
 233   mask |= bool(info.rasterizationState) << int(StateLookupIndex::RASTERIZATION_STATE_BIT);
 234   mask |= bool(info.vertexInputState) << int(StateLookupIndex::VERTEX_INPUT_STATE_BIT);
 235   mask |= bool(info.inputAssemblyState) << int(StateLookupIndex::INPUT_ASSEMBLY_STATE_BIT);
 236   return mask;
 237 }
 238
 239 /**
 240  * @brief Implementation of cache
 241  */
 242 struct PipelineCache::Impl
 243 {
 244   /**
 245    * @brief Constructor
 246    */
 247   explicit Impl(EglGraphicsController& _controller)
 248   : controller(_controller),
 249     pipelineEntriesFlushRequired(false),
 250     programEntriesFlushRequired(false)
 251   {
 252     // Initialise lookup table
 253     InitialiseStateCompareLookupTable();
 254   }
 255
 256   /**
 257    * @brief destructor
 258    */
 259   ~Impl()
 260   {
 261     // First destroy pipelines
 262     entries.clear();
 263
 264     // Now programs
 265     programEntries.clear();
 266   }
 267
 268   /**
 269    * @brief Structure describes a single cache entry
 270    */
 271   struct CacheEntry
 272   {
 273     CacheEntry() = default;
 274
 275     CacheEntry(UniquePtr<PipelineImpl>&& _pipeline, uint32_t _bitmask)
 276     : pipeline(std::move(_pipeline)),
 277       stateBitmask(_bitmask)
 278     {
 279     }
 280
 281     ~CacheEntry() = default;
 282
 283     CacheEntry(CacheEntry&&) = default;
 284     CacheEntry& operator=(CacheEntry&&) = default;
 285
 286     UniquePtr<PipelineImpl> pipeline{nullptr};
 287     uint32_t                stateBitmask{0u};
 288   };
 289
 290   EglGraphicsController&  controller;
 291   std::vector<CacheEntry> entries;
 292
 293   /**
 294    * @brief Sorted array of shaders used to create program
 295    */
 296   struct ProgramCacheEntry
 297   {
 298     // sorted array of shaders
 299     std::vector<const Graphics::Shader*> shaders;
 300     UniquePtr<ProgramImpl>               program{nullptr};
 301   };
 302
 303   std::vector<ProgramCacheEntry> programEntries;
 304
 305   bool pipelineEntriesFlushRequired : 1;
 306   bool programEntriesFlushRequired : 1;
 307 };
 308
 309 PipelineCache::PipelineCache(EglGraphicsController& controller)
 310 {
 311   mImpl = std::make_unique<Impl>(controller);
 312 }
 313
 314 PipelineCache::~PipelineCache() = default;
 315
 316 PipelineImpl* PipelineCache::FindPipelineImpl(const PipelineCreateInfo& info)
 317 {
 318   auto bitmask = GetStateBitmask(info);
 319
 320   for(auto& entry : mImpl->entries)
 321   {
 322     auto& pipeline  = entry.pipeline;
 323     auto& cacheInfo = pipeline->GetCreateInfo();
 324     if(!info.programState)
 325     {
 326       continue;
 327     }
 328
 329     // Check whether the program is the same
 330     if(info.programState->program)
 331     {
 332       const auto& lhsProgram = *static_cast<const GLES::Program*>(info.programState->program);
 333       const auto& rhsProgram = *static_cast<const GLES::Program*>(cacheInfo.programState->program);
 334       if(lhsProgram != rhsProgram)
 335       {
 336         continue;
 337       }
 338
 339       // Test whether set states bitmask matches
 340       if(entry.stateBitmask != bitmask)
 341       {
 342         continue;
 343       }
 344
 345       // Now test only for states that are set
 346       auto i = 0;
 347       for(i = 0; i < int(StateLookupIndex::MAX_STATE); ++i)
 348       {
 349         // Test only set states
 350         if((entry.stateBitmask & (1 << i)))
 351         {
 352           if(!(GetStateCompareFuncTable()[i](&info, &cacheInfo)))
 353           {
 354             break;
 355           }
 356         }
 357       }
 358
 359       // TODO: For now ignoring dynamic state mask and allocator
 360       // Getting as far as here, we have found our pipeline impl
 361       if(i == int(StateLookupIndex::MAX_STATE))
 362       {
 363         return pipeline.get();
 364       }
 365     }
 366   }
 367   return nullptr;
 368 }
 369
 370 ProgramImpl* PipelineCache::FindProgramImpl(const ProgramCreateInfo& info)
 371 {
 372   if(mImpl->programEntries.empty())
 373   {
 374     return nullptr;
 375   }
 376
 377   // assert if no shaders given
 378   std::vector<const Graphics::Shader*> shaders;
 379   shaders.reserve(info.shaderState->size());
 380
 381   for(auto& state : *info.shaderState)
 382   {
 383     shaders.push_back(state.shader);
 384   }
 385
 386   // sort
 387   std::sort(shaders.begin(), shaders.end());
 388
 389   for(auto& item : mImpl->programEntries)
 390   {
 391     if(item.shaders.size() != shaders.size())
 392     {
 393       continue;
 394     }
 395
 396     int k = shaders.size();
 397     while(--k >= 0 && item.shaders[k] == shaders[k])
 398       ;
 399
 400     if(k < 0)
 401     {
 402       return item.program.get();
 403     }
 404   }
 405   return nullptr;
 406 }
 407
 408 Graphics::UniquePtr<Graphics::Pipeline> PipelineCache::GetPipeline(const PipelineCreateInfo&                 pipelineCreateInfo,
 409                                                                    Graphics::UniquePtr<Graphics::Pipeline>&& oldPipeline)
 410 {
 411   auto cachedPipeline = FindPipelineImpl(pipelineCreateInfo);
 412
 413   // Return same pointer if nothing changed
 414   if(oldPipeline && *static_cast<GLES::Pipeline*>(oldPipeline.get()) == cachedPipeline)
 415   {
 416     return std::move(oldPipeline);
 417   }
 418
 419   if(!cachedPipeline)
 420   {
 421     // create new pipeline
 422     auto pipeline = MakeUnique<GLES::PipelineImpl>(pipelineCreateInfo, mImpl->controller, *this);
 423
 424     cachedPipeline = pipeline.get();
 425
 426     // add it to cache
 427     mImpl->entries.emplace_back(std::move(pipeline), GetStateBitmask(pipelineCreateInfo));
 428   }
 429
 430   auto wrapper = MakeUnique<GLES::Pipeline, CachedObjectDeleter<GLES::Pipeline>>(*cachedPipeline);
 431   return std::move(wrapper);
 432 }
 433
 434 Graphics::UniquePtr<Graphics::Program> PipelineCache::GetProgram(const ProgramCreateInfo&                 programCreateInfo,
 435                                                                  Graphics::UniquePtr<Graphics::Program>&& oldProgram)
 436 {
 437   ProgramImpl* cachedProgram = FindProgramImpl(programCreateInfo);
 438
 439   // Return same pointer if nothing changed
 440   if(oldProgram && *static_cast<GLES::Program*>(oldProgram.get()) == cachedProgram)
 441   {
 442     return std::move(oldProgram);
 443   }
 444
 445   if(!cachedProgram)
 446   {
 447     // create new pipeline
 448     auto program = MakeUnique<GLES::ProgramImpl>(programCreateInfo, mImpl->controller);
 449
 450     program->Create(); // Don't currently handle failure.
 451
 452     cachedProgram = program.get();
 453
 454     // add it to cache
 455     mImpl->programEntries.emplace_back();
 456     auto& item   = mImpl->programEntries.back();
 457     item.program = std::move(program);
 458     for(auto& state : *programCreateInfo.shaderState)
 459     {
 460       item.shaders.push_back(state.shader);
 461     }
 462
 463     std::sort(item.shaders.begin(), item.shaders.end());
 464   }
 465
 466   auto wrapper = MakeUnique<GLES::Program, CachedObjectDeleter<GLES::Program>>(cachedProgram);
 467   return std::move(wrapper);
 468 }
 469
 470 void PipelineCache::FlushCache()
 471 {
 472   if(mImpl->pipelineEntriesFlushRequired)
 473   {
 474     decltype(mImpl->entries) newEntries;
 475     newEntries.reserve(mImpl->entries.size());
 476
 477     for(auto& entry : mImpl->entries)
 478     {
 479       // Move items which are still in use into the new array
 480       if(entry.pipeline->GetRefCount() != 0)
 481       {
 482         newEntries.emplace_back(std::move(entry));
 483       }
 484     }
 485
 486     // Move temporary array in place of stored cache
 487     // Unused pipelines will be deleted automatically
 488     mImpl->entries = std::move(newEntries);
 489
 490     mImpl->pipelineEntriesFlushRequired = false;
 491   }
 492
 493   if(mImpl->programEntriesFlushRequired)
 494   {
 495     // Program cache require similar action.
 496     decltype(mImpl->programEntries) newProgramEntries;
 497     newProgramEntries.reserve(mImpl->programEntries.size());
 498
 499     for(auto& entry : mImpl->programEntries)
 500     {
 501       // Move items which are still in use into the new array
 502       if(entry.program->GetRefCount() != 0)
 503       {
 504         newProgramEntries.emplace_back(std::move(entry));
 505       }
 506     }
 507
 508     mImpl->programEntries = std::move(newProgramEntries);
 509
 510     mImpl->programEntriesFlushRequired = false;
 511   }
 512 }
 513
 514 void PipelineCache::MarkPipelineCacheFlushRequired()
 515 {
 516   mImpl->pipelineEntriesFlushRequired = true;
 517 }
 518
 519 void PipelineCache::MarkProgramCacheFlushRequired()
 520 {
 521   mImpl->programEntriesFlushRequired = true;
 522 }
 523
 524 } // namespace Dali::Graphics::GLES