MemoryPlanner.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 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 __ONERT_BACKEND_TRAIN_MEMORY_PLANNER_H__
#define __ONERT_BACKEND_TRAIN_MEMORY_PLANNER_H__
 
#include <backend/basic/IMemoryPlanner.h>
 
#include "DisposableTensorIndex.h"
 
#include <map>
#include <vector>
#include <unordered_set>
#include <memory>
 
namespace onert
{
namespace backend
{
namespace train
{
 
template <typename Index> class BumpPlanner : public basic::IMemoryPlanner<Index>
{
private:
  using MemoryPlans = typename basic::IMemoryPlanner<Index>::MemoryPlans;
 
public:
  void claim(const Index &, size_t) override;
  void release(const Index &) override;
  uint32_t capacity() override { return _capacity; }
  MemoryPlans &memory_plans() override { return _mem_plans; }
 
private:
  uint32_t _capacity = 0;
  MemoryPlans _mem_plans;
};
 
template <typename Index> class FirstFitPlanner : public basic::IMemoryPlanner<Index>
{
private:
  using MemoryPlans = typename basic::IMemoryPlanner<Index>::MemoryPlans;
 
public:
  void claim(const Index &, size_t) override;
  void release(const Index &) override;
  uint32_t capacity() override { return _capacity; }
  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, Index> _claim_table;
};
 
template <typename Index> class WICPlanner : public basic::IMemoryPlanner<Index>
{
private:
  using MemoryPlans = typename basic::IMemoryPlanner<Index>::MemoryPlans;
 
public:
  WICPlanner();
 
  void claim(const Index &, size_t) override;
  void release(const Index &) override;
  uint32_t capacity() override
  {
    if (!_initialized)
      buildMemoryPlans();
    return _capacity;
  }
  MemoryPlans &memory_plans() override;
 
private:
  void buildMemoryPlans();
 
  bool _initialized;
  uint32_t _capacity;
  MemoryPlans _mem_plans;
  std::unordered_set<Index> _live_indices;
  std::unordered_map<Index, std::vector<Index>> _interference_graph;
  // Sort tensors by descending order of size
  std::multimap<uint32_t, Index, std::greater<uint32_t>> _indices;
};
 
} // namespace train
} // namespace backend
} // namespace onert
 
#endif // __ONERT_BACKEND_TRAIN_MEMORY_PLANNER_H__