gem5  v20.1.0.0
pool_manager.hh
Go to the documentation of this file.
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 #include "params/PoolManager.hh"
42 #include "sim/sim_object.hh"
43 
44 // Pool Manager Logic
45 class PoolManager : public SimObject
46 {
47  public:
48  PoolManager(const PoolManagerParams *p);
49  virtual ~PoolManager() { _poolSize = 0; }
50  uint32_t minAllocation() { return _minAllocation; }
51  virtual std::string printRegion() = 0;
52  virtual uint32_t regionSize(std::pair<uint32_t,uint32_t> &region) = 0;
53  virtual bool canAllocate(uint32_t numRegions, uint32_t size) = 0;
54 
55  virtual uint32_t allocateRegion(const uint32_t size,
56  uint32_t *reserved) = 0;
57 
58  virtual void freeRegion(uint32_t firstIdx, uint32_t lastIdx) = 0;
59  uint32_t poolSize() { return _poolSize; }
60 
61  private:
62  // minimum size that can be reserved per allocation
63  uint32_t _minAllocation;
64  // pool size in number of elements
65  uint32_t _poolSize;
66 };
67 
68 #endif // __POOL_MANAGER_HH__
PoolManager::freeRegion
virtual void freeRegion(uint32_t firstIdx, uint32_t lastIdx)=0
PoolManager::PoolManager
PoolManager(const PoolManagerParams *p)
Definition: pool_manager.cc:36
PoolManager::canAllocate
virtual bool canAllocate(uint32_t numRegions, uint32_t size)=0
PoolManager
Definition: pool_manager.hh:45
PoolManager::printRegion
virtual std::string printRegion()=0
sim_object.hh
PoolManager::minAllocation
uint32_t minAllocation()
Definition: pool_manager.hh:50
std::pair
STL pair class.
Definition: stl.hh:58
PoolManager::_minAllocation
uint32_t _minAllocation
Definition: pool_manager.hh:63
PoolManager::poolSize
uint32_t poolSize()
Definition: pool_manager.hh:59
PoolManager::~PoolManager
virtual ~PoolManager()
Definition: pool_manager.hh:49
MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:323
PoolManager::allocateRegion
virtual uint32_t allocateRegion(const uint32_t size, uint32_t *reserved)=0
PoolManager::regionSize
virtual uint32_t regionSize(std::pair< uint32_t, uint32_t > &region)=0
PoolManager::_poolSize
uint32_t _poolSize
Definition: pool_manager.hh:65
SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:92

Generated on Wed Sep 30 2020 14:02:12 for gem5 by doxygen 1.8.17