dali/internal/system/common/object-profiler.h

   1 #ifndef DALI_ADAPTOR_OBJECT_PROFILER_H
   2 #define DALI_ADAPTOR_OBJECT_PROFILER_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 <cstdint> // uint32_t
  23 #include <cstddef> // size_t
  24 #include <dali/public-api/common/vector-wrapper.h>
  25 #include <dali/public-api/object/object-registry.h>
  26 #include <dali/public-api/object/type-registry.h>
  27 #include <dali/public-api/signals/connection-tracker.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali/public-api/adaptor-framework/timer.h>
  31
  32 namespace Dali
  33 {
  34 namespace Internal
  35 {
  36 namespace Adaptor
  37 {
  38
  39 /**
  40  * Class to profile the number of instances of Objects in the system
  41  */
  42 class ObjectProfiler : public ConnectionTracker
  43 {
  44 public:
  45
  46   /**
  47    * Constructor
  48    * @param objectRegistry The objectRegistry
  49    * @param timeInterval to specify the frequency of reporting
  50    */
  51   ObjectProfiler( Dali::ObjectRegistry objectRegistry, uint32_t timeInterval );
  52
  53   /**
  54    * Destructor
  55    */
  56   ~ObjectProfiler();
  57
  58   /**
  59    * Display a list of types with the current number of instances in the system
  60    */
  61   void DisplayInstanceCounts();
  62
  63 private:
  64   /**
  65    * If timer is running, display the instance counts
  66    */
  67   bool OnTimeout();
  68
  69   /**
  70    * Callback used when objects are created. Increases instance count for that object type
  71    * @param[in] handle of the created object
  72    */
  73   void OnObjectCreated( BaseHandle handle );
  74
  75   /**
  76    * Callback used when objects are created. Decreases instance count for that object type
  77    * @param[in] object The object being destroyed
  78    */
  79   void OnObjectDestroyed( const Dali::RefObject* object );
  80
  81   /**
  82    * Get the memory size of the given object
  83    */
  84   std::size_t GetMemorySize( const std::string& name, uint32_t count );
  85
  86 private:
  87
  88   using InstanceCountPair = std::pair< const std::string, uint32_t >;
  89   using InstanceTypePair = std::pair< BaseObject*, std::string >;
  90
  91   Dali::ObjectRegistry    mObjectRegistry;
  92   Dali::Timer             mTimer;
  93   std::vector< InstanceCountPair > mInstanceCountContainer;
  94   std::vector< InstanceTypePair >  mInstanceTypes;
  95 };
  96
  97 } // Adaptor
  98 } // Internal
  99 } // Dali
 100
 101 #endif // DALI_ADAPTOR_OBJECT_PROFILER_H