unusedFeatureTileTracker.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2020 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include <features/featuresDefines.h>

#include <tbb/tbb_thread.h>
#include <tbb/spin_rw_mutex.h>
#include <tbb/atomic.h>

#include <boost/optional.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/weak_ptr.hpp>
#include <boost/scoped_ptr.hpp>
#include <boost/noncopyable.hpp>

#include <list>

#include <vrfutil/objectCounter.h>

class DtConsoleCommandManager;
class DtConsoleCommandOwner;

namespace MAKVRinTerra
{
   class DT_DLL_features DtUnusedFeatureTileTracker
#ifdef DtObjectDebugger_Enable
      : public DtObjectDebugger<DtUnusedFeatureTileTracker>
#endif
   {
   public:
      class DT_DLL_features Trackable;
      class DT_DLL_features Sentinel;

      typedef boost::shared_ptr<DtUnusedFeatureTileTracker> Ptr;
      typedef boost::weak_ptr<DtUnusedFeatureTileTracker>   WeakPtr;
      typedef boost::shared_ptr<Trackable>                  TrackablePtr;
      typedef std::list<TrackablePtr>                       TrackableList;
      typedef std::list<Trackable*>                         TrackableRawPtrList;

      DtUnusedFeatureTileTracker(
         DtConsoleCommandManager* mgr=0,
         const std::string& name = "tracker");

      ~DtUnusedFeatureTileTracker();

      void start();

      unsigned length() const;

      unsigned size() const;

      unsigned totalLength() const;

      void setMaxSize(unsigned max);

      unsigned maxSize() const;

      void setMinUnusedTime(double);

      double minUnusedTime() const;

      unsigned long unloadUntilSize(unsigned maxSize, double minTime);
      unsigned long unloadUntilSize(unsigned maxSize);

      void addSubtracker(const Ptr& subtracker);

      void info(std::ostream&) const;

      void print(std::ostream&) const;

   private:
      friend class Trackable;

      typedef tbb::spin_rw_mutex Mutex;

      bool add(Trackable&);

      bool add(const boost::shared_ptr<Trackable>&);

      bool remove(Trackable&);

      bool removeAndUnload(Trackable&);

      void run();

      mutable Mutex myMutex;
      TrackableList myUnused;

      bool myDoneFlag;
      boost::scoped_ptr<tbb::tbb_thread> myPageOutThread;

      tbb::atomic<unsigned> myMaxSize;
      tbb::atomic<double> myMinUnusedTime;

      typedef std::vector<Ptr> SubTrackerList;
      SubTrackerList mySubtrackers;

      mutable Mutex myTotalListMutex;
      TrackableRawPtrList myTrackables;

      boost::scoped_ptr<DtConsoleCommandManager> myCommandManager;
      boost::scoped_ptr<DtConsoleCommandOwner> myCommandOwner;
   };

   class DtUnusedFeatureTileTracker::Trackable
      : private boost::noncopyable
#ifdef DtObjectDebugger_Enable
      , public DtObjectDebugger<DtUnusedFeatureTileTracker::Trackable>
#endif
   {
   public:
      static bool UnloadTryCatch(Trackable&);

      virtual ~Trackable();

      virtual std::string label() const = 0;

      virtual void load() = 0;

      virtual bool unload() = 0;

      virtual bool loading() const = 0;

      virtual bool loaded() const = 0;

      virtual unsigned size() const = 0;

      virtual boost::shared_ptr<Trackable> getPtr() const = 0;

      boost::shared_ptr<Sentinel> getSentinel(bool loadIfNotPresent=true) const;

      void addToUnusedList();

      unsigned useCount() const;

      tbb::tick_count unusedTime() const;

   protected:
      explicit Trackable(const DtUnusedFeatureTileTracker::Ptr&);

   private:
      friend class DtUnusedFeatureTileTracker;
      friend class Sentinel;

      typedef tbb::spin_rw_mutex Mutex;

      void sentinelDestroyed();

      bool notInList() const { return !myIterator; }
      TrackableList::iterator iterator() const { return *myIterator; }

      mutable Mutex myMutex;

      const DtUnusedFeatureTileTracker::WeakPtr myTracker;

      boost::weak_ptr<Sentinel> mySentinel;
      boost::optional<TrackableList::iterator> myIterator;
      boost::optional<TrackableRawPtrList::iterator> myTrackableListIterator;

      tbb::tick_count myUnusedTime;
   };

   class DtUnusedFeatureTileTracker::Sentinel
      : private boost::noncopyable
#ifdef DtObjectDebugger_Enable
      , public DtObjectDebugger<DtUnusedFeatureTileTracker::Sentinel>
#endif
   {
   public:
      typedef boost::shared_ptr<Sentinel> Ptr;

      ~Sentinel();

   private:
      friend class Trackable;

      explicit Sentinel(const boost::shared_ptr<Trackable>&);

      const boost::shared_ptr<Trackable> myTrackable;
   };
}

DT_DEFINE_OBJECT_DEBUGGER_NAME(MAKVRinTerra::DtUnusedFeatureTileTracker);
DT_DEFINE_OBJECT_DEBUGGER_NAME(MAKVRinTerra::DtUnusedFeatureTileTracker::Trackable);
DT_DEFINE_OBJECT_DEBUGGER_NAME(MAKVRinTerra::DtUnusedFeatureTileTracker::Sentinel);