arm_compute/runtime/IMemoryManager.h

   1 /*
   2  * Copyright (c) 2017 ARM Limited.
   3  *
   4  * SPDX-License-Identifier: MIT
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to
   8  * deal in the Software without restriction, including without limitation the
   9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24 #ifndef __ARM_COMPUTE_IMEMORYMANAGER_H__
  25 #define __ARM_COMPUTE_IMEMORYMANAGER_H__
  26
  27 #include "arm_compute/runtime/ILifetimeManager.h"
  28 #include "arm_compute/runtime/IPoolManager.h"
  29
  30 #include <cstddef>
  31
  32 namespace arm_compute
  33 {
  34 class IMemoryGroup;
  35
  36 /** Memory manager interface to handle allocations of backing memory */
  37 class IMemoryManager
  38 {
  39 public:
  40     /** Default virtual destructor */
  41     virtual ~IMemoryManager() = default;
  42     /** Returns the lifetime manager used by the memory manager
  43      *
  44      * @return The lifetime manager
  45      */
  46     virtual ILifetimeManager *lifetime_manager() = 0;
  47     /** Returns the pool manager used by the memory manager
  48      *
  49      * @return The pool manager
  50      */
  51     virtual IPoolManager *pool_manager() = 0;
  52     /** Finalize memory manager */
  53     virtual void finalize() = 0;
  54 };
  55 } // arm_compute
  56 #endif /*__ARM_COMPUTE_IMEMORYMANAGER_H__ */