src/gpu-compute/pool_manager.hh

   1 /*
   2  * Copyright (c) 2015-2017 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
  18  * contributors may be used to endorse or promote products derived from this
  19  * software 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
  34 #ifndef __POOL_MANAGER_HH__
  35 #define __POOL_MANAGER_HH__
  36
  37 #include <cassert>
  38 #include <cstdint>
  39 #include <string>
  40
  41 // Pool Manager Logic
  42 class PoolManager
  43 {
  44   public:
  45     PoolManager(uint32_t minAlloc, uint32_t poolSize);
  46     uint32_t minAllocation() { return _minAllocation; }
  47     virtual std::string printRegion() = 0;
  48     virtual uint32_t regionSize(std::pair<uint32_t,uint32_t> &region) = 0;
  49     virtual bool canAllocate(uint32_t numRegions, uint32_t size) = 0;
  50
  51     virtual uint32_t allocateRegion(const uint32_t size,
  52                                     uint32_t *reserved) = 0;
  53
  54     virtual void freeRegion(uint32_t firstIdx, uint32_t lastIdx) = 0;
  55     uint32_t poolSize() { return _poolSize; }
  56
  57   private:
  58     // minimum size that can be reserved per allocation
  59     uint32_t _minAllocation;
  60     // pool size in number of elements
  61     uint32_t _poolSize;
  62 };
  63
  64 #endif // __POOL_MANAGER_HH__