dali/internal/update/queue/update-message-queue.cpp

   1 /*
   2  * Copyright (c) 2014 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 // CLASS HEADER
  19 #include <dali/internal/update/queue/update-message-queue.h>
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/common/vector-wrapper.h>
  23 #include <dali/devel-api/threading/mutex.h>
  24 #include <dali/integration-api/render-controller.h>
  25 #include <dali/internal/common/message.h>
  26 #include <dali/internal/common/message-buffer.h>
  27 #include <dali/internal/render/common/performance-monitor.h>
  28
  29 using std::vector;
  30
  31 using Dali::Integration::RenderController;
  32 using Dali::Internal::SceneGraph::SceneGraphBuffers;
  33
  34 namespace Dali
  35 {
  36
  37 namespace Internal
  38 {
  39
  40 namespace // unnamed namespace
  41 {
  42
  43 // A message to set Actor::SIZE is 72 bytes on 32bit device
  44 // A buffer of size 32768 would store (32768 - 4) / (72 + 4) = 431 of those messages
  45 static const std::size_t INITIAL_BUFFER_SIZE =  32768;
  46 static const std::size_t MAX_BUFFER_CAPACITY = 73728; // Avoid keeping buffers which exceed this
  47 static const std::size_t MAX_FREE_BUFFER_COUNT = 3; // Allow this number of buffers to be recycled
  48
  49 // A queue of message buffers
  50 typedef vector< MessageBuffer* > MessageBufferQueue;
  51 typedef MessageBufferQueue::iterator MessageBufferIter;
  52
  53 typedef Dali::Mutex MessageQueueMutex;
  54
  55 } // unnamed namespace
  56
  57 namespace Update
  58 {
  59
  60 /**
  61  * Private MessageQueue data
  62  */
  63 struct MessageQueue::Impl
  64 {
  65   Impl( RenderController& controller, const SceneGraphBuffers& buffers )
  66   : renderController(controller),
  67     sceneGraphBuffers(buffers),
  68     processingEvents(false),
  69     queueWasEmpty(true),
  70     sceneUpdateFlag( false ),
  71     sceneUpdate( 0 ),
  72     currentMessageBuffer(NULL)
  73   {
  74   }
  75
  76   ~Impl()
  77   {
  78     // Delete the current buffer
  79     if( currentMessageBuffer )
  80     {
  81       DeleteBufferContents( currentMessageBuffer );
  82       delete currentMessageBuffer;
  83     }
  84
  85     // Delete the unprocessed buffers
  86     const MessageBufferIter processQueueEndIter = processQueue.end();
  87     for ( MessageBufferIter iter = processQueue.begin(); iter != processQueueEndIter; ++iter )
  88     {
  89       MessageBuffer* unprocessedBuffer = *iter;
  90       DeleteBufferContents( unprocessedBuffer );
  91       delete unprocessedBuffer;
  92     }
  93
  94     // Delete the recycled buffers
  95     const MessageBufferIter recycleQueueEndIter = recycleQueue.end();
  96     for ( MessageBufferIter iter = recycleQueue.begin(); iter != recycleQueueEndIter; ++iter )
  97     {
  98       MessageBuffer* recycledBuffer = *iter;
  99       DeleteBufferContents( recycledBuffer );
 100       delete recycledBuffer;
 101     }
 102
 103     const MessageBufferIter freeQueueEndIter = freeQueue.end();
 104     for ( MessageBufferIter iter = freeQueue.begin(); iter != freeQueueEndIter; ++iter )
 105     {
 106       MessageBuffer* freeBuffer = *iter;
 107       DeleteBufferContents( freeBuffer );
 108       delete freeBuffer;
 109     }
 110   }
 111
 112   void DeleteBufferContents( MessageBuffer* buffer )
 113   {
 114     for( MessageBuffer::Iterator iter = buffer->Begin(); iter.IsValid(); iter.Next() )
 115     {
 116       MessageBase* message = reinterpret_cast< MessageBase* >( iter.Get() );
 117
 118       // Call virtual destructor explictly; since delete will not be called after placement new
 119       message->~MessageBase();
 120     }
 121   }
 122
 123   RenderController&        renderController;     ///< render controller
 124   const SceneGraphBuffers& sceneGraphBuffers;    ///< Used to keep track of which buffers are being written or read.
 125
 126   bool                     processingEvents;     ///< Whether messages queued will be flushed by core
 127   bool                     queueWasEmpty;        ///< Flag whether the queue was empty during the Update()
 128   bool                     sceneUpdateFlag;      ///< true when there is a new message that requires a scene-graph node tree update
 129   int                      sceneUpdate;          ///< Non zero when there is a message in the queue requiring a scene-graph node tree update
 130
 131   MessageQueueMutex        queueMutex;           ///< queueMutex must be locked whilst accessing processQueue or recycleQueue
 132   MessageBufferQueue       processQueue;         ///< to process in the next update
 133   MessageBufferQueue       recycleQueue;         ///< to recycle MessageBuffers after the messages have been processed
 134
 135   MessageBuffer*           currentMessageBuffer; ///< can be used without locking
 136   MessageBufferQueue       freeQueue;            ///< buffers from the recycleQueue; can be used without locking
 137 };
 138
 139 MessageQueue::MessageQueue( Integration::RenderController& controller, const SceneGraph::SceneGraphBuffers& buffers )
 140 : mImpl(NULL)
 141 {
 142   mImpl = new Impl( controller, buffers );
 143 }
 144
 145 MessageQueue::~MessageQueue()
 146 {
 147   delete mImpl;
 148 }
 149
 150 void MessageQueue::EventProcessingStarted()
 151 {
 152   mImpl->processingEvents = true;
 153 }
 154
 155 unsigned int* MessageQueue::ReserveMessageSlot( unsigned int requestedSize, bool updateScene )
 156 {
 157   DALI_ASSERT_DEBUG( 0 != requestedSize );
 158
 159   if( updateScene )
 160   {
 161     mImpl->sceneUpdateFlag = true;
 162   }
 163
 164   if ( !mImpl->currentMessageBuffer )
 165   {
 166     const MessageBufferIter endIter = mImpl->freeQueue.end();
 167
 168     // Find the largest recycled buffer from freeQueue
 169     MessageBufferIter nextBuffer = endIter;
 170     for ( MessageBufferIter iter = mImpl->freeQueue.begin(); iter != endIter; ++iter )
 171     {
 172       if ( endIter == nextBuffer ||
 173            (*nextBuffer)->GetCapacity() < (*iter)->GetCapacity() )
 174       {
 175         nextBuffer = iter;
 176       }
 177     }
 178
 179     if ( endIter != nextBuffer )
 180     {
 181       // Reuse a recycled buffer from freeQueue
 182       mImpl->currentMessageBuffer = *nextBuffer;
 183       mImpl->freeQueue.erase( nextBuffer );
 184     }
 185     else
 186     {
 187       mImpl->currentMessageBuffer = new MessageBuffer( INITIAL_BUFFER_SIZE );
 188     }
 189   }
 190
 191   // If we are inside Core::ProcessEvents(), core will automatically flush the queue.
 192   // If we are outside, then we have to request a call to Core::ProcessEvents() on idle.
 193   if ( false == mImpl->processingEvents )
 194   {
 195     mImpl->renderController.RequestProcessEventsOnIdle();
 196   }
 197
 198   return mImpl->currentMessageBuffer->ReserveMessageSlot( requestedSize );
 199 }
 200
 201 bool MessageQueue::FlushQueue()
 202 {
 203   const bool messagesToProcess = ( NULL != mImpl->currentMessageBuffer );
 204
 205   // If there're messages to flush
 206   if ( messagesToProcess )
 207   {
 208     // queueMutex must be locked whilst accessing processQueue or recycleQueue
 209     MessageQueueMutex::ScopedLock lock( mImpl->queueMutex );
 210
 211     mImpl->processQueue.push_back( mImpl->currentMessageBuffer );
 212     mImpl->currentMessageBuffer = NULL;
 213
 214     // Grab any recycled MessageBuffers
 215     while ( !mImpl->recycleQueue.empty() )
 216     {
 217       MessageBuffer* recycled = mImpl->recycleQueue.back();
 218       mImpl->recycleQueue.pop_back();
 219
 220       // Guard against excessive message buffer growth
 221       if ( MAX_FREE_BUFFER_COUNT < mImpl->freeQueue.size() ||
 222            MAX_BUFFER_CAPACITY   < recycled->GetCapacity() )
 223       {
 224         delete recycled;
 225       }
 226       else
 227       {
 228         mImpl->freeQueue.push_back( recycled );
 229       }
 230     }
 231
 232     if( mImpl->sceneUpdateFlag )
 233     {
 234       mImpl->sceneUpdate |= 2;
 235       mImpl->sceneUpdateFlag = false;
 236     }
 237   }
 238
 239   mImpl->processingEvents = false;
 240
 241   return messagesToProcess;
 242 }
 243
 244 void MessageQueue::ProcessMessages( BufferIndex updateBufferIndex )
 245 {
 246   PERF_MONITOR_START(PerformanceMonitor::PROCESS_MESSAGES);
 247
 248   // queueMutex must be locked whilst accessing queue
 249   MessageQueueMutex::ScopedLock lock( mImpl->queueMutex );
 250
 251   const MessageBufferIter processQueueEndIter = mImpl->processQueue.end();
 252   for ( MessageBufferIter iter = mImpl->processQueue.begin(); iter != processQueueEndIter ; ++iter )
 253   {
 254     MessageBuffer* buffer = *iter;
 255
 256     for( MessageBuffer::Iterator iter = buffer->Begin(); iter.IsValid(); iter.Next() )
 257     {
 258       MessageBase* message = reinterpret_cast< MessageBase* >( iter.Get() );
 259
 260       message->Process( updateBufferIndex  );
 261
 262       // Call virtual destructor explictly; since delete will not be called after placement new
 263       message->~MessageBase();
 264     }
 265     buffer->Reset();
 266
 267     // Pass back for use in the event-thread
 268     mImpl->recycleQueue.push_back( buffer );
 269   }
 270
 271   mImpl->sceneUpdate >>= 1;
 272
 273   mImpl->queueWasEmpty = mImpl->processQueue.empty(); // Flag whether we processed anything
 274
 275   mImpl->processQueue.clear();
 276
 277   PERF_MONITOR_END(PerformanceMonitor::PROCESS_MESSAGES);
 278 }
 279
 280 bool MessageQueue::WasEmpty() const
 281 {
 282   return mImpl->queueWasEmpty;
 283 }
 284
 285 bool MessageQueue::IsSceneUpdateRequired() const
 286 {
 287   return mImpl->sceneUpdate;
 288 }
 289
 290 } // namespace Update
 291
 292 } // namespace Internal
 293
 294 } // namespace Dali