summaryrefslogtreecommitdiff
path: root/compiler/kuma/include/kuma.h
blob: a3d9a2e916a953f8acb063ac47d7d1bf7d8abcb1 (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
/*
 * Copyright (c) 2020 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.
 */

#ifndef __KUMA_H__
#define __KUMA_H__

#include <cstdint>
#include <set>

namespace kuma
{

// Supported algorithms
enum Algorithm
{
  // No reuse
  Greedy,
  LinearScanFirstFit,
};

/**
 * Each algorithm defines its own context. The context describes its in and out.
 */
template <Algorithm Alg> class Context;

using ItemID = uint32_t;
using ItemSize = uint32_t;

using MemoryOffset = uint32_t;
using MemorySize = uint32_t;

//
// Greedy Algorithm
//
template <> class Context<Algorithm::Greedy>
{
public:
  virtual ~Context() = default;

public: // Inputs
  // count() returns the number of items to be allocated
  virtual uint32_t item_count(void) const = 0;

  // size(N) returns the size of the N-th item
  virtual ItemSize item_size(const ItemID &) const = 0;

public: // Outputs
  virtual void mem_offset(const ItemID &, const MemoryOffset &) = 0;
  virtual void mem_total(const MemorySize &) = 0;
};

void solve(Context<Greedy> *);

//
// Linear Scan First-Fit Algorithm
//
template <> class Context<Algorithm::LinearScanFirstFit>
{
public:
  virtual ~Context() = default;

public: // Inputs
  // count() returns the number of items to be allocated
  virtual uint32_t item_count(void) const = 0;

  // size(N) returns the size of the N-th item
  virtual ItemSize item_size(const ItemID &) const = 0;

  // conflict_with(N) returns all the items that are in conflict with item N
  // - An item N is said to be in conflict with item M if item M and N cannot have overlap
  //
  // NOTE
  // - conflict_with(N) SHOULD NOT include N itself
  virtual std::set<ItemID> conflict_with(const ItemID &) const = 0;

public: // Outputs
  virtual void mem_offset(const ItemID &, const MemoryOffset &) = 0;
  virtual void mem_total(const MemorySize &) = 0;
};

void solve(Context<Algorithm::LinearScanFirstFit> *);

} // namespace kuma

#endif // __KUMA_H__