singleton.hh

Go to the documentation of this file.

#ifndef DUNE_FEM_SINGLETON_HH
#define DUNE_FEM_SINGLETON_HH
 
//- System includes
#include <cassert>
#include <algorithm>
#include <memory>
#include <mutex>
#include <typeindex>
#include <unordered_map>
#include <vector>
#include <iostream>
 
#include <dune/common/visibility.hh>
#ifdef USING_DUNE_PYTHON
#include <dune/python/pybind11/pybind11.h>
#endif
 
namespace Dune
{
  namespace Fem
  {
    namespace detail
    {
      class SingletonStorage
      {
      public:
        // item to be stored in storage list
        struct Item {  virtual ~Item() {} };
 
        typedef std::shared_ptr< Item > WeakPointerType;
        typedef std::unique_ptr< Item > PointerType;
        typedef std::type_index         KeyType;
 
        //typedef std::pair< std::unordered_map< KeyType, std::shared_ptr< Item > >, std::vector<PointerType> >  StorageType;
 
        struct Storage :
          public std::pair< std::unordered_map< KeyType, std::shared_ptr< Item > >, std::vector<PointerType> >
        {
          Storage() :
            std::pair< std::unordered_map< KeyType, std::shared_ptr< Item > >, std::vector<PointerType> > (),
            mutex_()
          {}
 
          //typedef std::mutex mutex_t;
          typedef std::recursive_mutex mutex_t;
          mutex_t mutex_;
        };
 
        typedef Storage StorageType;
 
        // delete for singletons deleting each singleton object
        // in reverse order of creation
        struct SingletonDeleter
        {
          void operator()(StorageType* storage) const
          {
            // delete singletons in reverse order
            std::for_each(storage->second.rbegin(), storage->second.rend(), [](PointerType& item) { item.reset(); });
 
            storage->second.clear();
            storage->first.clear();
          }
        };
 
        typedef std::shared_ptr<StorageType> StoragePointer;
 
        static StoragePointer storage_;
 
        DUNE_EXPORT static StorageType& getStorage()
        {
          if(! storage_ )
          {
            // this should happen during the creation of MPIManager
            // which is the first static variable to accessed
#ifndef USING_DUNE_PYTHON
            storage_.reset( new StorageType(), SingletonDeleter() );
#else
            storage_ = pybind11::cast< StoragePointer >(
                       pybind11::module::import( "dune.fem._fem" ).attr( "_singleton" ) );
#endif
          }
 
          return *storage_;
        }
      };
    } // end namespace detail
 
    template< class Object >
    class Singleton : public detail::SingletonStorage
    {
      typedef detail::SingletonStorage BaseType;
      typedef typename BaseType::StorageType      StorageType;
      typedef typename BaseType::Item             Item;
      typedef typename BaseType::PointerType      PointerType;
      typedef typename BaseType::WeakPointerType  WeakPointerType;
 
      using BaseType::getStorage;
 
      // item to be created containing the correct object
      struct ItemWrapper : public Item
      {
        Object obj_;
        template <class... Args>
        ItemWrapper(Args &&... args) : obj_(std::forward< Args >( args )...)
        {}
      };
      typedef ItemWrapper ItemWrapperType;
 
      // null delete for shared_ptr hash map
      struct NullDeleter
      {
        void operator()(Item *p) const {}
      };
 
    public:
      template <class... Args>
      DUNE_EXPORT static Object& instance(Args &&... args)
      {
        // capture thread_local reference as static variable to avoid
        // map search later on, object creation is protected by a mutex lock
        static thread_local Object& inst = getObject(std::forward< Args >( args )...);
        return inst;
      }
 
    protected:
      // placing variables as static inside functions only works with gcc
      static const bool placeStaticVariableInline = false ;
 
      template <class... Args>
      DUNE_EXPORT static Object& getObject(Args &&... args)
      {
        // this way of creating static variables only works with gcc, not with clang
        if constexpr ( placeStaticVariableInline )
        {
          static Object obj( std::forward< Args >( args )...);
          return obj;
        }
        else
        {
          // get storage reference (see base class)
          // this should exists since we initialize some static
          // variables inside the MPIManager at program start
          StorageType& storage = getStorage();
 
          // this section needs locking to avoid race conditions
          // unlock is done on destruction of lock_guard
          std::lock_guard< StorageType::mutex_t > guard( storage.mutex_ );
 
          // get pointer of singleton objects belonging to hash id
          auto& ptr = storage.first[ std::type_index(typeid(Object)) ];
          // if pointer has not been set, create object and set pointer
          if( ! ptr )
          {
            // create object in vector for later correct deletion order
            storage.second.emplace_back( PointerType(new ItemWrapperType(std::forward< Args >( args )...) ) );
 
            // create pointer to object in hash map for later use
            ptr = WeakPointerType( storage.second.back().operator->(), NullDeleter() );
          }
 
          // return object reference
          assert( dynamic_cast< ItemWrapperType* > (ptr.operator->()) );
          return static_cast< ItemWrapperType& > (*ptr).obj_;
        }
      }
 
    };
 
  } // namespace Fem
 
} // namespace Dune
 
#endif //  #ifndef DUNE_FEM_SINGLETONLIST_HH