src/gpu-compute/pool_manager.hh

   1 /*
   2  * Copyright (c) 2015 Advanced Micro Devices, Inc.
   3  * All rights reserved.
   4  *
   5  * For use for simulation and test purposes only
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright notice,
  11  * this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright notice,
  14  * this list of conditions and the following disclaimer in the documentation
  15  * and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the copyright holder nor the names of its contributors
  18  * may be used to endorse or promote products derived from this software
  19  * without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  * Author: John Kalamatianos
  34  */
  35
  36 #ifndef __POOL_MANAGER_HH__
  37 #define __POOL_MANAGER_HH__
  38
  39 #include <cassert>
  40 #include <cstdint>
  41 #include <string>
  42
  43 // Pool Manager Logic
  44 class PoolManager
  45 {
  46   public:
  47     PoolManager(uint32_t minAlloc, uint32_t poolSize);
  48     uint32_t minAllocation() { return _minAllocation; }
  49     virtual std::string printRegion() = 0;
  50     virtual uint32_t regionSize(std::pair<uint32_t,uint32_t> &region) = 0;
  51     virtual bool canAllocate(uint32_t numRegions, uint32_t size) = 0;
  52
  53     virtual uint32_t allocateRegion(const uint32_t size,
  54                                     uint32_t *reserved) = 0;
  55
  56     virtual void freeRegion(uint32_t firstIdx, uint32_t lastIdx) = 0;
  57     uint32_t poolSize() { return _poolSize; }
  58
  59   private:
  60     // minimum size that can be reserved per allocation
  61     uint32_t _minAllocation;
  62     // pool size in number of elements
  63     uint32_t _poolSize;
  64 };
  65
  66 #endif // __POOL_MANAGER_HH__