2 * Copyright (c) 2014 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.
19 #include <dali/internal/update/queue/update-message-queue.h>
22 #include <dali/public-api/common/vector-wrapper.h>
23 #include <dali/public-api/common/mutex.h>
24 #include <dali/integration-api/render-controller.h>
25 #include <dali/internal/common/message-buffer.h>
26 #include <dali/internal/render/common/performance-monitor.h>
30 using Dali::Integration::RenderController;
31 using Dali::Internal::SceneGraph::SceneGraphBuffers;
39 namespace // unnamed namespace
42 // A message to set Actor::SIZE is 72 bytes on 32bit device
43 // A buffer of size 32768 would store (32768 - 4) / (72 + 4) = 431 of those messages
44 static const std::size_t INITIAL_BUFFER_SIZE = 32768;
45 static const std::size_t MAX_BUFFER_CAPACITY = 73728; // Avoid keeping buffers which exceed this
46 static const std::size_t MAX_FREE_BUFFER_COUNT = 3; // Allow this number of buffers to be recycled
48 // A queue of message buffers
49 typedef vector< MessageBuffer* > MessageBufferQueue;
50 typedef MessageBufferQueue::iterator MessageBufferIter;
52 typedef Dali::Mutex MessageQueueMutex;
54 } // unnamed namespace
60 * Private MessageQueue data
62 struct MessageQueue::Impl
64 Impl( RenderController& controller, const SceneGraphBuffers& buffers )
65 : renderController(controller),
66 sceneGraphBuffers(buffers),
67 processingEvents(false),
69 sceneUpdateFlag( false ),
71 currentMessageBuffer(NULL)
77 // Delete the current buffer
78 delete currentMessageBuffer;
80 // Delete the unprocessed buffers
81 const MessageBufferIter processQueueEndIter = processQueue.end();
82 for ( MessageBufferIter iter = processQueue.begin(); iter != processQueueEndIter; ++iter )
84 MessageBuffer* unprocessedBuffer = *iter;
85 DeleteBufferContents( unprocessedBuffer );
86 delete unprocessedBuffer;
89 // Delete the recycled buffers
90 const MessageBufferIter recycleQueueEndIter = recycleQueue.end();
91 for ( MessageBufferIter iter = recycleQueue.begin(); iter != recycleQueueEndIter; ++iter )
93 MessageBuffer* recycledBuffer = *iter;
94 DeleteBufferContents( recycledBuffer );
95 delete recycledBuffer;
98 const MessageBufferIter freeQueueEndIter = freeQueue.end();
99 for ( MessageBufferIter iter = freeQueue.begin(); iter != freeQueueEndIter; ++iter )
101 MessageBuffer* freeBuffer = *iter;
102 DeleteBufferContents( freeBuffer );
107 void DeleteBufferContents( MessageBuffer* buffer )
109 for( MessageBuffer::Iterator iter = buffer->Begin(); iter.IsValid(); iter.Next() )
111 MessageBase* message = reinterpret_cast< MessageBase* >( iter.Get() );
113 // Call virtual destructor explictly; since delete will not be called after placement new
114 message->~MessageBase();
118 RenderController& renderController; ///< render controller
119 const SceneGraphBuffers& sceneGraphBuffers; ///< Used to keep track of which buffers are being written or read.
121 bool processingEvents; ///< Whether messages queued will be flushed by core
122 bool queueWasEmpty; ///< Flag whether the queue was empty during the Update()
123 bool sceneUpdateFlag; ///< true when there is a new message that requires a scene-graph node tree update
124 int sceneUpdate; ///< Non zero when there is a message in the queue requiring a scene-graph node tree update
126 MessageQueueMutex queueMutex; ///< queueMutex must be locked whilst accessing processQueue or recycleQueue
127 MessageBufferQueue processQueue; ///< to process in the next update
128 MessageBufferQueue recycleQueue; ///< to recycle MessageBuffers after the messages have been processed
130 MessageBuffer* currentMessageBuffer; ///< can be used without locking
131 MessageBufferQueue freeQueue; ///< buffers from the recycleQueue; can be used without locking
134 MessageQueue::MessageQueue( RenderController& controller, const SceneGraphBuffers& buffers )
137 mImpl = new Impl( controller, buffers );
140 MessageQueue::~MessageQueue()
145 void MessageQueue::EventProcessingStarted()
147 mImpl->processingEvents = true;
150 unsigned int* MessageQueue::ReserveMessageSlot( unsigned int requestedSize, bool updateScene )
152 DALI_ASSERT_DEBUG( 0 != requestedSize );
156 mImpl->sceneUpdateFlag = true;
159 if ( !mImpl->currentMessageBuffer )
161 const MessageBufferIter endIter = mImpl->freeQueue.end();
163 // Find the largest recycled buffer from freeQueue
164 MessageBufferIter nextBuffer = endIter;
165 for ( MessageBufferIter iter = mImpl->freeQueue.begin(); iter != endIter; ++iter )
167 if ( endIter == nextBuffer ||
168 (*nextBuffer)->GetCapacity() < (*iter)->GetCapacity() )
174 if ( endIter != nextBuffer )
176 // Reuse a recycled buffer from freeQueue
177 mImpl->currentMessageBuffer = *nextBuffer;
178 mImpl->freeQueue.erase( nextBuffer );
182 mImpl->currentMessageBuffer = new MessageBuffer( INITIAL_BUFFER_SIZE );
186 // If we are inside Core::ProcessEvents(), core will automatically flush the queue.
187 // If we are outside, then we have to request a call to Core::ProcessEvents() on idle.
188 if ( false == mImpl->processingEvents )
190 mImpl->renderController.RequestProcessEventsOnIdle();
193 return mImpl->currentMessageBuffer->ReserveMessageSlot( requestedSize );
196 BufferIndex MessageQueue::GetEventBufferIndex() const
198 return mImpl->sceneGraphBuffers.GetEventBufferIndex();
201 bool MessageQueue::FlushQueue()
203 const bool messagesToProcess = ( NULL != mImpl->currentMessageBuffer );
205 // If there're messages to flush
206 if ( messagesToProcess )
208 // queueMutex must be locked whilst accessing processQueue or recycleQueue
209 MessageQueueMutex::ScopedLock lock( mImpl->queueMutex );
211 mImpl->processQueue.push_back( mImpl->currentMessageBuffer );
212 mImpl->currentMessageBuffer = NULL;
214 // Grab any recycled MessageBuffers
215 while ( !mImpl->recycleQueue.empty() )
217 MessageBuffer* recycled = mImpl->recycleQueue.back();
218 mImpl->recycleQueue.pop_back();
220 // Guard against excessive message buffer growth
221 if ( MAX_FREE_BUFFER_COUNT < mImpl->freeQueue.size() ||
222 MAX_BUFFER_CAPACITY < recycled->GetCapacity() )
228 mImpl->freeQueue.push_back( recycled );
232 if( mImpl->sceneUpdateFlag )
234 mImpl->sceneUpdate |= 2;
235 mImpl->sceneUpdateFlag = false;
239 mImpl->processingEvents = false;
241 return messagesToProcess;
244 void MessageQueue::ProcessMessages()
246 PERF_MONITOR_START(PerformanceMonitor::PROCESS_MESSAGES);
248 // queueMutex must be locked whilst accessing queue
249 MessageQueueMutex::ScopedLock lock( mImpl->queueMutex );
251 const MessageBufferIter processQueueEndIter = mImpl->processQueue.end();
252 for ( MessageBufferIter iter = mImpl->processQueue.begin(); iter != processQueueEndIter ; ++iter )
254 MessageBuffer* buffer = *iter;
256 for( MessageBuffer::Iterator iter = buffer->Begin(); iter.IsValid(); iter.Next() )
258 MessageBase* message = reinterpret_cast< MessageBase* >( iter.Get() );
260 message->Process( mImpl->sceneGraphBuffers.GetUpdateBufferIndex() );
262 // Call virtual destructor explictly; since delete will not be called after placement new
263 message->~MessageBase();
267 // Pass back for use in the event-thread
268 mImpl->recycleQueue.push_back( buffer );
271 mImpl->sceneUpdate >>= 1;
273 mImpl->queueWasEmpty = mImpl->processQueue.empty(); // Flag whether we processed anything
275 mImpl->processQueue.clear();
277 PERF_MONITOR_END(PerformanceMonitor::PROCESS_MESSAGES);
280 bool MessageQueue::WasEmpty() const
282 return mImpl->queueWasEmpty;
285 bool MessageQueue::IsSceneUpdateRequired() const
287 return mImpl->sceneUpdate;
290 } // namespace Update
292 } // namespace Internal