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) 2019 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 timeInterval to specify the frequency of reporting
  49    */
  50   ObjectProfiler( uint32_t timeInterval );
  51
  52   /**
  53    * Destructor
  54    */
  55   ~ObjectProfiler();
  56
  57   /**
  58    * Display a list of types with the current number of instances in the system
  59    */
  60   void DisplayInstanceCounts();
  61
  62 private:
  63   /**
  64    * If timer is running, display the instance counts
  65    */
  66   bool OnTimeout();
  67
  68   /**
  69    * Callback used when objects are created. Increases instance count for that object type
  70    * @param[in] handle of the created object
  71    */
  72   void OnObjectCreated( BaseHandle handle );
  73
  74   /**
  75    * Callback used when objects are created. Decreases instance count for that object type
  76    * @param[in] object The object being destroyed
  77    */
  78   void OnObjectDestroyed( const Dali::RefObject* object );
  79
  80   /**
  81    * Get the memory size of the given object
  82    */
  83   std::size_t GetMemorySize( const std::string& name, uint32_t count );
  84
  85 private:
  86
  87   using InstanceCountPair = std::pair< const std::string, uint32_t >;
  88   using InstanceTypePair = std::pair< BaseObject*, std::string >;
  89
  90   Dali::ObjectRegistry    mObjectRegistry;
  91   Dali::Timer             mTimer;
  92   std::vector< InstanceCountPair > mInstanceCountContainer;
  93   std::vector< InstanceTypePair >  mInstanceTypes;
  94 };
  95
  96 } // Adaptor
  97 } // Internal
  98 } // Dali
  99
 100 #endif // DALI_ADAPTOR_OBJECT_PROFILER_H