dali/internal/adaptor/common/combined-update-render-controller.h

   1 #ifndef DALI_INTERNAL_COMBINED_UPDATE_RENDER_CONTROLLER_H
   2 #define DALI_INTERNAL_COMBINED_UPDATE_RENDER_CONTROLLER_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <pthread.h>
  23 #include <semaphore.h>
  24 #include <stdint.h>
  25 #include <dali/devel-api/threading/conditional-wait.h>
  26 #include <dali/integration-api/core.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali/integration-api/adaptor-framework/thread-synchronization-interface.h>
  30 #include <dali/internal/adaptor/common/thread-controller-interface.h>
  31 #include <dali/internal/system/common/fps-tracker.h>
  32 #include <dali/internal/system/common/performance-interface.h>
  33 #include <dali/internal/system/common/update-status-logger.h>
  34 #include <dali/internal/window-system/common/display-connection.h>
  35
  36 namespace Dali
  37 {
  38
  39 class RenderSurfaceInterface;
  40 class TriggerEventInterface;
  41
  42 namespace Internal
  43 {
  44
  45 namespace Adaptor
  46 {
  47
  48 class AdaptorInternalServices;
  49 class EnvironmentOptions;
  50
  51 /**
  52  * @brief Two threads where events/application interaction is handled on the main/event thread and the Update & Render
  53  * happen on the other thread.
  54  *
  55  * Key Points:
  56  *  1. Two Threads:
  57  *    a. Main/Event Thread.
  58  *    b. Update/Render Thread.
  59  *  2. There is NO VSync thread:
  60  *    a. We retrieve the time before Update.
  61  *    b. Then retrieve the time after Render.
  62  *    c. We calculate the difference between these two times and if:
  63  *      i.  The difference is less than the default frame time, we sleep.
  64  *      ii. If it’s more or the same, we continue.
  65  *  3. On the update/render thread, if we discover that we do not need to do any more updates, we use a trigger-event
  66  *     to inform the main/event thread. This is then processed as soon as the event thread is able to do so where it
  67  *     is easier to make a decision about whether we should stop the update/render thread or not (depending on any
  68  *     update requests etc.).
  69  *  4. The main thread is blocked while the surface is being replaced.
  70  *  5. When we resume from paused, elapsed time is used for the animations, i.e. the could have finished while we were paused.
  71  *     However, FinishedSignal emission will only happen upon resumption.
  72  *  6. Elapsed time is NOT used while if we are waking up from a sleep state or doing an UpdateOnce.
  73  */
  74 class CombinedUpdateRenderController : public ThreadControllerInterface,
  75                                        public ThreadSynchronizationInterface
  76 {
  77 public:
  78
  79   /**
  80    * Constructor
  81    */
  82   CombinedUpdateRenderController( AdaptorInternalServices& adaptorInterfaces, const EnvironmentOptions& environmentOptions );
  83
  84   /**
  85    * Non virtual destructor. Not intended as base class.
  86    */
  87   ~CombinedUpdateRenderController();
  88
  89   /**
  90    * @copydoc ThreadControllerInterface::Initialize()
  91    */
  92   virtual void Initialize();
  93
  94   /**
  95    * @copydoc ThreadControllerInterface::Start()
  96    */
  97   virtual void Start();
  98
  99   /**
 100    * @copydoc ThreadControllerInterface::Pause()
 101    */
 102   virtual void Pause();
 103
 104   /**
 105    * @copydoc ThreadControllerInterface::Resume()
 106    */
 107   virtual void Resume();
 108
 109   /**
 110    * @copydoc ThreadControllerInterface::Stop()
 111    */
 112   virtual void Stop();
 113
 114   /**
 115    * @copydoc ThreadControllerInterface::RequestUpdate()
 116    */
 117   virtual void RequestUpdate();
 118
 119   /**
 120    * @copydoc ThreadControllerInterface::RequestUpdateOnce()
 121    */
 122   virtual void RequestUpdateOnce( UpdateMode updateMode );
 123
 124   /**
 125    * @copydoc ThreadControllerInterface::ReplaceSurface()
 126    */
 127   virtual void ReplaceSurface( Dali::RenderSurfaceInterface* surface );
 128
 129   /**
 130    * @copydoc ThreadControllerInterface::ResizeSurface()
 131    */
 132   virtual void ResizeSurface();
 133
 134   /**
 135    * @copydoc ThreadControllerInterface::WaitForGraphicsInitialization()
 136    */
 137   virtual void WaitForGraphicsInitialization();
 138
 139   /**
 140    * @copydoc ThreadControllerInterface::SetRenderRefreshRate()
 141    */
 142   virtual void SetRenderRefreshRate( unsigned int numberOfFramesPerRender );
 143
 144   /**
 145    * @copydoc ThreadControllerInterface::SetPreRenderCallback
 146    */
 147   void SetPreRenderCallback( CallbackBase* callback ) override;
 148
 149   /**
 150    * @copydoc ThreadControllerInterface::AddSurface()
 151    */
 152   virtual void AddSurface( Dali::RenderSurfaceInterface* surface );
 153
 154 private:
 155
 156   // Undefined copy constructor.
 157   CombinedUpdateRenderController( const CombinedUpdateRenderController& );
 158
 159   // Undefined assignment operator.
 160   CombinedUpdateRenderController& operator=( const CombinedUpdateRenderController& );
 161
 162   /////////////////////////////////////////////////////////////////////////////////////////////////
 163   // EventThread
 164   /////////////////////////////////////////////////////////////////////////////////////////////////
 165
 166   enum AnimationProgression
 167   {
 168     USE_ELAPSED_TIME,          ///< Animation progression using elapsed time
 169     NONE                       ///< No animation progression
 170   };
 171
 172   /**
 173    * Runs the Update/Render Thread.
 174    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 175    *
 176    * @param[in]  numberOfCycles           The number of times the update/render cycle should run. If -1, then it will run continuously.
 177    * @param[in]  animationProgression     Whether to progress animation using time elapsed since the last frame.
 178    * @param[in]  updateMode               The update mode (i.e. either update & render or skip rendering)
 179    */
 180   inline void RunUpdateRenderThread( int numberOfCycles, AnimationProgression animationProgression, UpdateMode updateMode );
 181
 182   /**
 183    * Pauses the Update/Render Thread.
 184    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 185    */
 186   inline void PauseUpdateRenderThread();
 187
 188   /**
 189    * Stops the Update/Render Thread.
 190    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 191    *
 192    * @note Should only be called in Stop as calling this will kill the update-thread.
 193    */
 194   inline void StopUpdateRenderThread();
 195
 196   /**
 197    * Checks if the the Update/Render Thread is paused.
 198    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 199    *
 200    * @return true if paused, false otherwise
 201    */
 202   inline bool IsUpdateRenderThreadPaused();
 203
 204   /**
 205    * Used as the callback for the sleep-trigger.
 206    *
 207    * Will sleep when enough requests are made without any requests.
 208    */
 209   void ProcessSleepRequest();
 210
 211   /////////////////////////////////////////////////////////////////////////////////////////////////
 212   // UpdateRenderThread
 213   /////////////////////////////////////////////////////////////////////////////////////////////////
 214
 215   /**
 216    * The Update/Render thread loop. This thread will be destroyed on exit from this function.
 217    */
 218   void UpdateRenderThread();
 219
 220   /**
 221    * Called by the Update/Render Thread which ensures a wait if required.
 222    *
 223    * @param[out] useElapsedTime    If true when returned, then the actual elapsed time will be used for animation.
 224    *                               If false when returned, then there should NOT be any animation progression in the next Update.
 225    * @param[in]  updateRequired    Whether another update is required.
 226    * @param[out] timeToSleepUntil  The time remaining in nanoseconds to keep the thread sleeping before resuming.
 227    * @return false, if the thread should stop.
 228    */
 229   bool UpdateRenderReady( bool& useElapsedTime, bool updateRequired, uint64_t& timeToSleepUntil );
 230
 231   /**
 232    * Checks to see if the surface needs to be replaced.
 233    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 234    *
 235    * @return Pointer to the new surface, NULL otherwise
 236    */
 237   Dali::RenderSurfaceInterface* ShouldSurfaceBeReplaced();
 238
 239   /**
 240    * Called by the Update/Render thread after a surface has been replaced.
 241    *
 242    * This will lock the mutex in mEventThreadWaitCondition
 243    */
 244   void SurfaceReplaced();
 245
 246   /**
 247    * Checks to see if the surface needs to be resized.
 248    * This will lock the mutex in mUpdateRenderThreadWaitCondition.
 249    *
 250    * @return true if the surface should be resized, false otherwise
 251    */
 252   bool ShouldSurfaceBeResized();
 253
 254   /**
 255    * Called by the Update/Render thread after a surface has been resized.
 256    *
 257    * This will lock the mutex in mEventThreadWaitCondition
 258    */
 259   void SurfaceResized();
 260
 261   /**
 262    * Helper for the thread calling the entry function
 263    * @param[in] This A pointer to the current object
 264    */
 265   static void* InternalUpdateRenderThreadEntryFunc( void* This )
 266   {
 267     ( static_cast<CombinedUpdateRenderController*>( This ) )->UpdateRenderThread();
 268     return NULL;
 269   }
 270
 271   /////////////////////////////////////////////////////////////////////////////////////////////////
 272   // ALL Threads
 273   /////////////////////////////////////////////////////////////////////////////////////////////////
 274
 275   /**
 276    * Called by the update-render & v-sync threads when they up and running.
 277    *
 278    * This will lock the mutex in mEventThreadWaitCondition.
 279    */
 280   void NotifyThreadInitialised();
 281
 282   /**
 283    * Called by the update-render thread when graphics has been initialised.
 284    */
 285   void NotifyGraphicsInitialised();
 286
 287   /**
 288    * Helper to add a performance marker to the performance server (if it's active)
 289    * @param[in]  type  performance marker type
 290    */
 291   void AddPerformanceMarker( PerformanceInterface::MarkerType type );
 292
 293   /////////////////////////////////////////////////////////////////////////////////////////////////
 294   // POST RENDERING - ThreadSynchronizationInterface overrides
 295   /////////////////////////////////////////////////////////////////////////////////////////////////
 296
 297   /////////////////////////////////////////////////////////////////////////////////////////////////
 298   //// Called by the Event Thread if post-rendering is required
 299   /////////////////////////////////////////////////////////////////////////////////////////////////
 300
 301   /**
 302    * @copydoc ThreadSynchronizationInterface::PostRenderComplete()
 303    */
 304   virtual void PostRenderComplete();
 305
 306   /////////////////////////////////////////////////////////////////////////////////////////////////
 307   //// Called by the Render Thread if post-rendering is required
 308   /////////////////////////////////////////////////////////////////////////////////////////////////
 309
 310   /**
 311    * @copydoc ThreadSynchronizationInterface::PostRenderStarted()
 312    */
 313   virtual void PostRenderStarted();
 314
 315   /**
 316    * @copydoc ThreadSynchronizationInterface::PostRenderStarted()
 317    */
 318   virtual void PostRenderWaitForCompletion();
 319
 320 private:
 321
 322   FpsTracker                        mFpsTracker;                       ///< Object that tracks the FPS
 323   UpdateStatusLogger                mUpdateStatusLogger;               ///< Object that logs the update-status as required.
 324
 325   sem_t                             mEventThreadSemaphore;             ///< Used by the event thread to ensure all threads have been initialised, and when replacing the surface.
 326   sem_t                             mGraphicsInitializeSemaphore;      ///< Used by the render thread to ensure the graphics has been initialised.
 327
 328   ConditionalWait                   mUpdateRenderThreadWaitCondition;  ///< The wait condition for the update-render-thread.
 329
 330   AdaptorInternalServices&          mAdaptorInterfaces;                ///< The adaptor internal interface
 331   PerformanceInterface*             mPerformanceInterface;             ///< The performance logging interface
 332   Integration::Core&                mCore;                             ///< Dali core reference
 333   const EnvironmentOptions&         mEnvironmentOptions;               ///< Environment options
 334   TriggerEventInterface&            mNotificationTrigger;              ///< Reference to notification event trigger
 335   TriggerEventInterface*            mSleepTrigger;                     ///< Used by the update-render thread to trigger the event thread when it no longer needs to do any updates
 336   CallbackBase*                     mPreRenderCallback;                ///< Used by Update/Render thread when PreRender is about to be called on graphics.
 337
 338   pthread_t*                        mUpdateRenderThread;               ///< The Update/Render thread.
 339
 340   float                             mDefaultFrameDelta;                ///< Default time delta between each frame (used for animations). Not protected by lock, but written to rarely so not worth adding a lock when reading.
 341   // TODO: mDefaultFrameDurationMilliseconds is defined as uint64_t, the only place where it is used, it is converted to an unsigned int!!!
 342   uint64_t                          mDefaultFrameDurationMilliseconds; ///< Default duration of a frame (used for predicting the time of the next frame). Not protected by lock, but written to rarely so not worth adding a lock when reading.
 343   uint64_t                          mDefaultFrameDurationNanoseconds;  ///< Default duration of a frame (used for sleeping if not enough time elapsed). Not protected by lock, but written to rarely so not worth adding a lock when reading.
 344   uint64_t                          mDefaultHalfFrameNanoseconds;      ///< Is half of mDefaultFrameDurationNanoseconds. Using a member variable avoids having to do the calculation every frame. Not protected by lock, but written to rarely so not worth adding a lock when reading.
 345
 346   unsigned int                      mUpdateRequestCount;               ///< Count of update-requests we have received to ensure we do not go to sleep too early.
 347   unsigned int                      mRunning;                          ///< Read and set on the event-thread only to state whether we are running.
 348
 349   //
 350   // NOTE: cannot use booleans as these are used from multiple threads, must use variable with machine word size for atomic read/write
 351   //
 352
 353   volatile int                      mUpdateRenderRunCount;             ///< The number of times Update/Render cycle should run. If -1, then will run continuously (set by the event-thread, read by v-sync-thread).
 354   volatile unsigned int             mDestroyUpdateRenderThread;        ///< Whether the Update/Render thread be destroyed (set by the event-thread, read by the update-render-thread).
 355   volatile unsigned int             mUpdateRenderThreadCanSleep;       ///< Whether the Update/Render thread can sleep (set by the event-thread, read by the update-render-thread).
 356   volatile unsigned int             mPendingRequestUpdate;             ///< Is set as soon as an RequestUpdate is made and unset when the next update happens (set by the event-thread and update-render thread, read by the update-render-thread).
 357                                                                        ///< Ensures we do not go to sleep if we have not processed the most recent update-request.
 358
 359   volatile unsigned int             mUseElapsedTimeAfterWait;          ///< Whether we should use the elapsed time after waiting (set by the event-thread, read by the update-render-thread).
 360
 361   Dali::RenderSurfaceInterface* volatile mNewSurface;                  ///< Will be set to the new-surface if requested (set by the event-thread, read & cleared by the update-render thread).
 362
 363   volatile unsigned int             mPostRendering;                    ///< Whether post-rendering is taking place (set by the event & render threads, read by the render-thread).
 364   volatile unsigned int             mSurfaceResized;                   ///< Will be set to resize the surface (set by the event-thread, read & cleared by the update-render thread).
 365   volatile unsigned int             mForceClear;                       ///< Will be set to clear forcibly
 366
 367   volatile unsigned int             mUploadWithoutRendering;           ///< Will be set to upload the resource only (with no rendering)
 368
 369   volatile unsigned int             mFirstFrameAfterResume;            ///< Will be set to check the first frame after resume (for log)
 370 };
 371
 372 } // namespace Adaptor
 373
 374 } // namespace Internal
 375
 376 } // namespace Dali
 377
 378 #endif // DALI_INTERNAL_COMBINED_UPDATE_RENDER_CONTROLLER_H