1/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20/*!
21 * \file tir/usmp/algorithms.h
22 * \brief The memory planning algorithm for USMP
23 */
24
25#ifndef TVM_TIR_USMP_ALGORITHMS_H_
26#define TVM_TIR_USMP_ALGORITHMS_H_
27
28#include <tvm/tir/usmp/utils.h>
29
30namespace tvm {
31namespace tir {
32namespace usmp {
33namespace algo {
34
35/*!
36 * \brief The Greedy-by-Size algorithm to plan memory
37 *
38 * This will perform a greedy algorithm in deciding the offsets
39 * within provided Pools, using the size of the buffer.
40 *
41 * \return A Map of BufferInfo objects and their associated PoolAllocation
42 */
43Map<BufferInfo, PoolAllocation> GreedyBySize(const Array<BufferInfo>& buffer_info_arr,
44 const Integer& memory_pressure);
45
46/*!
47 * \brief The Greedy-by-Conflicts algorithm to plan memory
48 *
49 * This will perform a greedy algorithm in deciding the offsets
50 * within provided Pools, using the number of liveness conflicts of the buffer.
51 *
52 * \return A Map of BufferInfo objects and their associated PoolAllocation
53 */
54Map<BufferInfo, PoolAllocation> GreedyByConflicts(const Array<BufferInfo>& buffer_info_arr,
55 const Integer& memory_pressure);
56/*!
57 *\brief The Hill-Climb algoritm to plan memory
58 *
59 * This will perform an attempt to utilize probabalistic approach to memory
60 * allocation. Typically better than greedy family, but quite slow due to large
61 * number of iterations.
62 *
63 * \return A Map of BufferInfo objects and their associated PoolAllocation
64 */
65Map<BufferInfo, PoolAllocation> HillClimb(const Array<BufferInfo>& buffer_info_arr,
66 const Integer& memory_pressure);
67
68/*!
69 * \brief The Hill-Climb algorithm to plan memory
70 *
71 * This will perform a hill climbing algorithm in deciding the offsets
72 * within provided Pools.
73 *
74 * \return A Map of BufferInfo objects and their associated PoolAllocation
75 */
76Map<BufferInfo, PoolAllocation> HillClimb(const Array<BufferInfo>& buffer_info_arr,
77 const Integer& memory_pressure);
78
79} // namespace algo
80} // namespace usmp
81} // namespace tir
82} // namespace tvm
83
84#endif // TVM_TIR_USMP_ALGORITHMS_H_
85