MemoryPool.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2017 The University of Utah
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef UT_MemoryPool_h
#define UT_MemoryPool_h

#include <stack>
#include <map>

#include <spatialops/structured/MemoryTypes.h>

namespace SpatialOps {

template<typename T>
class Pool{

  struct FieldQueue{
    size_t accessCounter;
    typedef std::stack<T*> Queue;
    Queue queue;
    FieldQueue(){ accessCounter=0; }
  };

  typedef std::map<size_t,FieldQueue> FQSizeMap;
  typedef std::map<T*,size_t>         FieldSizeMap;

  static bool destroyed_;
  bool pinned_;
  size_t accessCounter_;

  FQSizeMap cpufqm_, gpufqm_;
  FieldSizeMap fsm_;
  size_t cpuhighWater_, gpuhighWater_;
  Pool();
  ~Pool();
  Pool(const Pool&);
  Pool& operator=(const Pool&);

  static Pool& self();

  const unsigned short int deviceIndex_;

 public:

  static T* get( const short int deviceLocation, const size_t n );

  static void put( const short int deviceLocation, T* t );

  static size_t active();

  static size_t total();

  static size_t flush_unused( const size_t n );

};

template<typename T> bool Pool<T>::destroyed_ = false;

template<typename T>
class PoolAutoPtr{
  public:
    inline PoolAutoPtr(T* ptr, short int activeIndex)
      : ptr(ptr), activeIndex(activeIndex)
    {}

    inline T* get() { return ptr; }
    inline const T* get() const { return ptr; }

    inline operator T*() { return ptr; }
    inline operator const T*() const { return ptr; }

    inline T& operator*() { return *ptr; }
    inline const T& operator*() const { return *ptr; }

    inline T* operator->() { return ptr; }
    inline const T* operator->() const { return ptr; }

    inline ~PoolAutoPtr() { if(ptr != NULL) Pool<T>::put( activeIndex, ptr ); }

  private:
    T* ptr;
    const short int activeIndex;
};


} //namespace SpatialOps


#endif