summaryrefslogtreecommitdiff
path: root/runtimes/neurun/backend/cpu/MemoryPlanner.h
blob: eaa4299eabbbadc36c84a20b0a4a848e4e924de6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
 * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file        MemoryPlanner.h
 * @brief       This file contains Memory Planning related classes
 */

#ifndef __NEURUN_BACKEND_CPU_MEMORY_PLANNER_H__
#define __NEURUN_BACKEND_CPU_MEMORY_PLANNER_H__

#include <map>
#include <cpp14/memory.h>

#include "model/OperandIndexMap.h"

namespace neurun
{
namespace backend
{
namespace cpu
{

/**
 * @brief Structure to have memory offset and size
 */
struct Block
{
  uint32_t offset;
  size_t size;
};

/**
 * @brief Class to allocate memory
 */
class Allocator
{
public:
  Allocator(uint32_t capacity);
  /**
   * @brief Get memory base pointer
   * @return base pointer
   */
  uint8_t *base() const { return _base.get(); }
  void release() { _base.reset(); }

private:
  std::unique_ptr<uint8_t[]> _base;
};

/**
 * @brief Interface to plan memory
 */
struct IMemoryPlanner
{
  using MemoryPlans = model::OperandIndexMap<Block>;

  /**
   * @brief Claim memory for operand
   * @param[in] index The operand index
   * @param[in] size The size of the memory
   */
  virtual void claim(const model::OperandIndex &, size_t) = 0;
  /**
   * @brief Release memory for operand
   * @param[in] index The operand index
   */
  virtual void release(const model::OperandIndex &) = 0;
  /**
   * @brief Get capacity for memory planning
   * @return The value of capacity
   */
  virtual uint32_t capacity() = 0;
  /**
   * @brief Get MemoryPlans
   * @return MemoryPlans
   */
  virtual MemoryPlans &memory_plans() = 0;

  virtual ~IMemoryPlanner() = default;
};

/**
 * @brief Class to plan memory by bump way
 */
class BumpPlanner : public IMemoryPlanner
{
public:
  /**
   * @brief Claim memory for operand by bump way
   * @param[in] index The operand index
   * @param[in] size The size of the memory
   */
  void claim(const model::OperandIndex &, size_t) override;
  /**
   * @brief Release memory for operand by bump way
   * @param[in] index The operand index
   */
  void release(const model::OperandIndex &) override;
  /**
   * @brief Get capacity for memory planning
   * @return The value of capacity
   */
  uint32_t capacity() override { return _capacity; }
  /**
   * @brief Get MemoryPlans
   * @return MemoryPlans
   */
  MemoryPlans &memory_plans() override { return _mem_plans; }

private:
  uint32_t _capacity = 0;
  MemoryPlans _mem_plans;
};

/**
 * @brief Class to plan memory by firstfit way
 */
class FirstFitPlanner : public IMemoryPlanner
{
public:
  /**
   * @brief Claim memory for operand by firstfit way
   * @param[in] index The operand index
   * @param[in] size The size of the memory
   */
  void claim(const model::OperandIndex &, size_t) override;
  /**
   * @brief Release memory for operand by firstfit way
   * @param[in] index The operand index
   */
  void release(const model::OperandIndex &) override;
  /**
   * @brief Get capacity for memory planning
   * @return The value of capacity
   */
  uint32_t capacity() override { return _capacity; }
  /**
   * @brief Get MemoryPlans
   * @return MemoryPlans
   */
  MemoryPlans &memory_plans() override { return _mem_plans; }

private:
  uint32_t _capacity = 0;
  MemoryPlans _mem_plans;
  // Use std::map because claim() assumes that _claim_table is sorted by uint32_t(base_offset)
  std::map<uint32_t, model::OperandIndex> _claim_table;
};

} // namespace cpu
} // namespace backend
} // namespace neurun

#endif // __NEURUN_BACKEND_CPU_MEMORY_PLANNER_H__