Merge "Added memory pool logging" into devel/master
[platform/core/uifw/dali-core.git] / dali / internal / update / nodes / node.cpp
index 73b52ee..87b4603 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #include <dali/internal/common/internal-constants.h>
 #include <dali/internal/common/memory-pool-object-allocator.h>
 #include <dali/internal/update/common/discard-queue.h>
-#include <dali/internal/update/manager/geometry-batcher.h>
-#include <dali/public-api/common/dali-common.h>
 #include <dali/public-api/common/constants.h>
+#include <dali/public-api/common/dali-common.h>
 
-namespace //Unnamed namespace
+namespace
 {
-//Memory pool used to allocate new nodes. Memory used by this pool will be released when shutting down DALi
+// Memory pool used to allocate new nodes. Memory used by this pool will be released when process dies
+//  or DALI library is unloaded
 Dali::Internal::MemoryPoolObjectAllocator<Dali::Internal::SceneGraph::Node> gNodeMemoryPool;
+#ifdef DEBUG_ENABLED
+// keep track of nodes alive, to ensure we have 0 when the process exits or DALi library is unloaded
+int32_t gNodeCount = 0;
+
+// Called when the process is about to exit, Node count should be zero at this point.
+void __attribute__((destructor)) ShutDown(void)
+{
+  DALI_ASSERT_DEBUG((gNodeCount == 0) && "Node memory leak");
 }
+#endif
+} // Unnamed namespace
 
 namespace Dali
 {
-
 namespace Internal
 {
-
 namespace SceneGraph
 {
+const ColorMode Node::DEFAULT_COLOR_MODE(USE_OWN_MULTIPLY_PARENT_ALPHA);
 
-const PositionInheritanceMode Node::DEFAULT_POSITION_INHERITANCE_MODE( INHERIT_PARENT_POSITION );
-const ColorMode Node::DEFAULT_COLOR_MODE( USE_OWN_MULTIPLY_PARENT_ALPHA );
+uint32_t Node::mNodeCounter = 0; ///< A counter to provide unique node ids, up-to 4 billion
 
 Node* Node::New()
 {
-  return new ( gNodeMemoryPool.AllocateRawThreadSafe() ) Node();
+  return new(gNodeMemoryPool.AllocateRawThreadSafe()) Node;
+}
+
+void Node::Delete(Node* node)
+{
+  // check we have a node not a derived node
+  if(!node->mIsLayer && !node->mIsCamera)
+  {
+    // Manually call the destructor
+    node->~Node();
+
+    // Mark the memory it used as free in the memory pool
+    gNodeMemoryPool.FreeThreadSafe(node);
+  }
+  else
+  {
+    // not in the pool, just delete it.
+    delete node;
+  }
 }
 
 Node::Node()
-: mTransformManager( NULL ),
-  mTransformId( INVALID_TRANSFORM_ID ),
-  mParentOrigin( TRANSFORM_PROPERTY_PARENT_ORIGIN ),
-  mAnchorPoint( TRANSFORM_PROPERTY_ANCHOR_POINT ),
-  mSize( TRANSFORM_PROPERTY_SIZE ),                                               // Zero initialized by default
-  mPosition( TRANSFORM_PROPERTY_POSITION ),                                       // Zero initialized by default
-  mOrientation(),                                                                 // Initialized to identity by default
-  mScale( TRANSFORM_PROPERTY_SCALE ),
-  mVisible( true ),
-  mColor( Color::WHITE ),
-  mWorldPosition( TRANSFORM_PROPERTY_WORLD_POSITION, Vector3( 0.0f,0.0f,0.0f ) ), // Zero initialized by default
-  mWorldScale( TRANSFORM_PROPERTY_WORLD_SCALE, Vector3( 1.0f,1.0f,1.0f ) ),
-  mWorldOrientation(),                                                            // Initialized to identity by default
+: mOrientation(),                                                               // Initialized to identity by default
+  mWorldPosition(TRANSFORM_PROPERTY_WORLD_POSITION, Vector3(0.0f, 0.0f, 0.0f)), // Zero initialized by default
+  mWorldScale(TRANSFORM_PROPERTY_WORLD_SCALE, Vector3(1.0f, 1.0f, 1.0f)),
+  mWorldOrientation(), // Initialized to identity by default
   mWorldMatrix(),
-  mWorldColor( Color::WHITE ),
-  mGeometryBatcher( NULL ),
-  mBatchIndex( BATCH_NULL_HANDLE ),
-  mClippingSortModifier( 0u ),
-  mIsBatchParent( false ),
-  mParent( NULL ),
-  mBatchParent( NULL ),
-  mExclusiveRenderTask( NULL ),
+  mVisible(true),
+  mCulled(false),
+  mColor(Color::WHITE),
+  mWorldColor(Color::WHITE),
+  mUpdateAreaHint(Vector4::ZERO),
+  mClippingSortModifier(0u),
+  mId(++mNodeCounter),
+  mParent(nullptr),
+  mExclusiveRenderTask(nullptr),
   mChildren(),
-  mClippingDepth( 0u ),
-  mRegenerateUniformMap( 0 ),
-  mDepth( 0u ),
-  mDirtyFlags( AllFlags ),
-  mDrawMode( DrawMode::NORMAL ),
-  mColorMode( DEFAULT_COLOR_MODE ),
-  mClippingMode( ClippingMode::DISABLED ),
-  mIsRoot( false )
+  mClippingDepth(0u),
+  mScissorDepth(0u),
+  mDepthIndex(0u),
+  mDirtyFlags(NodePropertyFlags::ALL),
+  mDrawMode(DrawMode::NORMAL),
+  mColorMode(DEFAULT_COLOR_MODE),
+  mClippingMode(ClippingMode::DISABLED),
+  mIsRoot(false),
+  mIsLayer(false),
+  mIsCamera(false),
+  mPositionUsesAnchorPoint(true),
+  mTransparent(false)
 {
-  mUniformMapChanged[0] = 0u;
-  mUniformMapChanged[1] = 0u;
+#ifdef DEBUG_ENABLED
+  gNodeCount++;
+#endif
 }
 
 Node::~Node()
 {
-  if( mTransformId != INVALID_TRANSFORM_ID )
+  if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
   {
-    mTransformManager->RemoveTransform(mTransformId);
+    mTransformManagerData.Manager()->RemoveTransform(mTransformManagerData.Id());
   }
-}
 
-void Node::operator delete( void* ptr )
-{
-  gNodeMemoryPool.FreeThreadSafe( static_cast<Node*>( ptr ) );
+#ifdef DEBUG_ENABLED
+  gNodeCount--;
+#endif
 }
 
 void Node::OnDestroy()
@@ -105,255 +127,218 @@ void Node::OnDestroy()
   PropertyOwner::Destroy();
 }
 
-void Node::CreateTransform( SceneGraph::TransformManager* transformManager )
+uint32_t Node::GetId() const
 {
-  //Create a new transform
-  mTransformManager = transformManager;
-  mTransformId = transformManager->CreateTransform();
-
-  //Initialize all the animatable properties
-  mPosition.Initialize( transformManager, mTransformId );
-  mScale.Initialize( transformManager, mTransformId );
-  mOrientation.Initialize( transformManager, mTransformId );
-  mSize.Initialize( transformManager, mTransformId );
-  mParentOrigin.Initialize( transformManager, mTransformId );
-  mAnchorPoint.Initialize( transformManager, mTransformId );
-
-  //Initialize all the input properties
-  mWorldPosition.Initialize( transformManager, mTransformId );
-  mWorldScale.Initialize( transformManager, mTransformId );
-  mWorldOrientation.Initialize( transformManager, mTransformId );
-  mWorldMatrix.Initialize( transformManager, mTransformId );
+  return mId;
 }
 
-void Node::SetRoot(bool isRoot)
+void Node::CreateTransform(SceneGraph::TransformManager* transformManager)
 {
-  DALI_ASSERT_DEBUG(!isRoot || mParent == NULL); // Root nodes cannot have a parent
+  // Create a new transform
+  mTransformManagerData.mManager = transformManager;
+  TransformId createdTransformId = transformManager->CreateTransform();
 
-  mIsRoot = isRoot;
-}
+  // Set whether the position should use the anchor point
+  transformManager->SetPositionUsesAnchorPoint(createdTransformId, mPositionUsesAnchorPoint);
 
-void Node::AddUniformMapping( UniformPropertyMapping* map )
-{
-  PropertyOwner::AddUniformMapping( map );
-  mRegenerateUniformMap = 2;
+  // Set TransformId after initialize done.
+  mTransformManagerData.mId = createdTransformId;
 }
 
-void Node::RemoveUniformMapping( const std::string& uniformName )
+void Node::SetRoot(bool isRoot)
 {
-  PropertyOwner::RemoveUniformMapping( uniformName );
-  mRegenerateUniformMap = 2;
+  DALI_ASSERT_DEBUG(!isRoot || mParent == NULL); // Root nodes cannot have a parent
+
+  mIsRoot = isRoot;
 }
 
-void Node::PrepareRender( BufferIndex bufferIndex )
+bool Node::IsAnimationPossible() const
 {
-  if(mRegenerateUniformMap != 0 )
-  {
-    if( mRegenerateUniformMap == 2 )
-    {
-      CollectedUniformMap& localMap = mCollectedUniformMap[ bufferIndex ];
-      localMap.Resize(0);
-
-      for( unsigned int i=0, count=mUniformMaps.Count(); i<count; ++i )
-      {
-        localMap.PushBack( &mUniformMaps[i] );
-      }
-    }
-    else if( mRegenerateUniformMap == 1 )
-    {
-      CollectedUniformMap& localMap = mCollectedUniformMap[ bufferIndex ];
-      CollectedUniformMap& oldMap = mCollectedUniformMap[ 1-bufferIndex ];
-
-      localMap.Resize( oldMap.Count() );
-
-      unsigned int index=0;
-      for( CollectedUniformMap::Iterator iter = oldMap.Begin(), end = oldMap.End() ; iter != end ; ++iter, ++index )
-      {
-        localMap[index] = *iter;
-      }
-    }
-    --mRegenerateUniformMap;
-    mUniformMapChanged[bufferIndex] = 1u;
-  }
+  return mIsConnectedToSceneGraph;
 }
 
-void Node::ConnectChild( Node* childNode )
+void Node::ConnectChild(Node* childNode)
 {
-  DALI_ASSERT_ALWAYS( this != childNode );
-  DALI_ASSERT_ALWAYS( IsRoot() || NULL != mParent ); // Parent should be connected first
-  DALI_ASSERT_ALWAYS( !childNode->IsRoot() && NULL == childNode->GetParent() ); // Child should be disconnected
+  DALI_ASSERT_ALWAYS(this != childNode);
+  DALI_ASSERT_ALWAYS(IsRoot() || nullptr != mParent);                            // Parent should be connected first
+  DALI_ASSERT_ALWAYS(!childNode->IsRoot() && nullptr == childNode->GetParent()); // Child should be disconnected
 
-  childNode->SetParent( *this );
+  childNode->SetParent(*this);
 
   // Everything should be reinherited when reconnected to scene-graph
   childNode->SetAllDirtyFlags();
 
   // Add the node to the end of the child list.
-  mChildren.PushBack( childNode );
+  mChildren.PushBack(childNode);
 
   // Inform property observers of new connection
   childNode->ConnectToSceneGraph();
 }
 
-void Node::DisconnectChild( BufferIndex updateBufferIndex, Node& childNode )
+void Node::DisconnectChild(BufferIndex updateBufferIndex, Node& childNode)
 {
-  DALI_ASSERT_ALWAYS( this != &childNode );
-  DALI_ASSERT_ALWAYS( childNode.GetParent() == this );
+  DALI_ASSERT_ALWAYS(this != &childNode);
+  DALI_ASSERT_ALWAYS(childNode.GetParent() == this);
 
   // Find the childNode and remove it
-  Node* found( NULL );
+  Node* found(nullptr);
 
   const NodeIter endIter = mChildren.End();
-  for ( NodeIter iter = mChildren.Begin(); iter != endIter; ++iter )
+  for(NodeIter iter = mChildren.Begin(); iter != endIter; ++iter)
   {
     Node* current = *iter;
-    if ( current == &childNode )
+    if(current == &childNode)
     {
       found = current;
-      mChildren.Erase( iter ); // order matters here
-      break; // iter is no longer valid
+      mChildren.Erase(iter); // order matters here
+      break;                 // iter is no longer valid
     }
   }
-  DALI_ASSERT_ALWAYS( NULL != found );
+  DALI_ASSERT_ALWAYS(nullptr != found);
 
-  found->RecursiveDisconnectFromSceneGraph( updateBufferIndex );
+  found->RecursiveDisconnectFromSceneGraph(updateBufferIndex);
 }
 
-void Node::AddRenderer( Renderer* renderer )
+void Node::AddRenderer(Renderer* renderer)
 {
-  // Check that it has not been already added.
-  unsigned int rendererCount( mRenderer.Size() );
-  for( unsigned int i(0); i < rendererCount; ++i )
-  {
-    if( mRenderer[i] == renderer )
-    {
-      // Renderer is already in the list.
-      return;
-    }
-  }
-
   // If it is the first renderer added, make sure the world transform will be calculated
   // in the next update as world transform is not computed if node has no renderers.
-  if( rendererCount == 0 )
+  if(mRenderer.Empty())
   {
-    mDirtyFlags |= TransformFlag;
+    mDirtyFlags |= NodePropertyFlags::TRANSFORM;
   }
-
-  mRenderer.PushBack( renderer );
-
-  // Tell geometry batcher if should batch the child
-  if( mRenderer.Size() == 1 && mRenderer[0]->mBatchingEnabled )
+  else
   {
-    mGeometryBatcher->AddNode( this );
+    // Check that it has not been already added.
+    for(auto&& existingRenderer : mRenderer)
+    {
+      if(existingRenderer == renderer)
+      {
+        // Renderer is already in the list.
+        return;
+      }
+    }
   }
+
+  SetUpdated(true);
+
+  mRenderer.PushBack(renderer);
 }
 
-void Node::RemoveRenderer( Renderer* renderer )
+void Node::RemoveRenderer(const Renderer* renderer)
 {
-  unsigned int rendererCount( mRenderer.Size() );
-  for( unsigned int i(0); i<rendererCount; ++i )
+  RendererContainer::SizeType rendererCount(mRenderer.Size());
+  for(RendererContainer::SizeType i = 0; i < rendererCount; ++i)
   {
-    if( mRenderer[i] == renderer )
+    if(mRenderer[i] == renderer)
     {
-      mRenderer.Erase( mRenderer.Begin()+i);
+      SetUpdated(true);
+      mRenderer.Erase(mRenderer.Begin() + i);
       return;
     }
   }
 }
 
-int Node::GetDirtyFlags() const
+NodePropertyFlags Node::GetDirtyFlags() const
 {
   // get initial dirty flags, they are reset ResetDefaultProperties, but setters may have made the node dirty already
-  int flags = mDirtyFlags;
+  NodePropertyFlags flags = mDirtyFlags;
 
   // Check whether the visible property has changed
-  if ( !mVisible.IsClean() )
+  if(!mVisible.IsClean())
   {
-    flags |= VisibleFlag;
+    flags |= NodePropertyFlags::VISIBLE;
   }
 
   // Check whether the color property has changed
-  if ( !mColor.IsClean() )
+  if(!mColor.IsClean())
   {
-    flags |= ColorFlag;
+    flags |= NodePropertyFlags::COLOR;
+  }
+
+  // Check whether the update area property has changed
+  if(!mUpdateAreaHint.IsClean())
+  {
+    flags |= NodePropertyFlags::TRANSFORM;
   }
 
   return flags;
 }
 
-void Node::ResetDefaultProperties( BufferIndex updateBufferIndex )
+NodePropertyFlags Node::GetInheritedDirtyFlags(NodePropertyFlags parentFlags) const
 {
-  mVisible.ResetToBaseValue( updateBufferIndex );
-  mColor.ResetToBaseValue( updateBufferIndex );
+  // Size is not inherited. VisibleFlag is inherited
+  static const NodePropertyFlags InheritedDirtyFlags = NodePropertyFlags::TRANSFORM | NodePropertyFlags::VISIBLE | NodePropertyFlags::COLOR;
+  using UnderlyingType                               = typename std::underlying_type<NodePropertyFlags>::type;
 
-  mDirtyFlags = NothingFlag;
+  return static_cast<NodePropertyFlags>(static_cast<UnderlyingType>(mDirtyFlags) |
+                                        (static_cast<UnderlyingType>(parentFlags) & static_cast<UnderlyingType>(InheritedDirtyFlags)));
 }
 
-void Node::SetParent( Node& parentNode )
+void Node::ResetDirtyFlags(BufferIndex updateBufferIndex)
 {
-  DALI_ASSERT_ALWAYS(this != &parentNode);
-  DALI_ASSERT_ALWAYS(!mIsRoot);
-  DALI_ASSERT_ALWAYS(mParent == NULL);
-
-  mParent = &parentNode;
-  mDepth = mParent->GetDepth() + 1u;
+  mDirtyFlags = NodePropertyFlags::NOTHING;
+}
 
-  if( mTransformId != INVALID_TRANSFORM_ID )
+void Node::UpdateUniformHash(BufferIndex bufferIndex)
+{
+  uint64_t hash = 0xc70f6907UL;
+  for(uint32_t i = 0u, count = mUniformMaps.Count(); i < count; ++i)
+  {
+    hash = mUniformMaps[i].propertyPtr->Hash(bufferIndex, hash);
+  }
+  if(mUniformsHash != hash)
   {
-    mTransformManager->SetParent( mTransformId, parentNode.GetTransformId() );
+    mUniformsHash = hash;
+    SetUpdated(true);
   }
 }
 
-void Node::SetBatchParent( Node* batchParentNode )
+void Node::SetParent(Node& parentNode)
 {
+  DALI_ASSERT_ALWAYS(this != &parentNode);
   DALI_ASSERT_ALWAYS(!mIsRoot);
-  mBatchParent = batchParentNode;
-}
+  DALI_ASSERT_ALWAYS(mParent == nullptr);
 
-void Node::SetIsBatchParent( bool enabled )
-{
-  if( mIsBatchParent != enabled )
-  {
-    mIsBatchParent = enabled;
+  mParent = &parentNode;
 
-    if( enabled )
-    {
-      mGeometryBatcher->AddBatchParent( this );
-    }
-    else
-    {
-      mGeometryBatcher->RemoveBatchParent( this );
-    }
+  if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
+  {
+    mTransformManagerData.Manager()->SetParent(mTransformManagerData.Id(), parentNode.GetTransformId());
   }
 }
 
-void Node::RecursiveDisconnectFromSceneGraph( BufferIndex updateBufferIndex )
+void Node::RecursiveDisconnectFromSceneGraph(BufferIndex updateBufferIndex)
 {
   DALI_ASSERT_ALWAYS(!mIsRoot);
-  DALI_ASSERT_ALWAYS(mParent != NULL);
+  DALI_ASSERT_ALWAYS(mParent != nullptr);
 
   const NodeIter endIter = mChildren.End();
-  for ( NodeIter iter = mChildren.Begin(); iter != endIter; ++iter )
+  for(NodeIter iter = mChildren.Begin(); iter != endIter; ++iter)
   {
-    (*iter)->RecursiveDisconnectFromSceneGraph( updateBufferIndex );
+    (*iter)->RecursiveDisconnectFromSceneGraph(updateBufferIndex);
   }
 
   // Animators, Constraints etc. should be disconnected from the child's properties.
-  PropertyOwner::DisconnectFromSceneGraph( updateBufferIndex );
+  PropertyOwner::DisconnectFromSceneGraph(updateBufferIndex);
 
   // Remove back-pointer to parent
-  mParent = NULL;
-  mDepth = 0u;
+  mParent = nullptr;
 
   // Remove all child pointers
   mChildren.Clear();
 
-  if( mTransformId != INVALID_TRANSFORM_ID )
+  if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
   {
-    mTransformManager->SetParent( mTransformId, INVALID_TRANSFORM_ID );
+    mTransformManagerData.Manager()->SetParent(mTransformManagerData.Id(), INVALID_TRANSFORM_ID);
   }
 }
 
+uint32_t Node::GetMemoryPoolCapacity()
+{
+  return gNodeMemoryPool.GetCapacity();
+}
+
 } // namespace SceneGraph
 
 } // namespace Internal