arm_compute/runtime/Memory.h

   1 /*
   2  * Copyright (c) 2017-2018 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_MEMORY_H__
  25 #define __ARM_COMPUTE_MEMORY_H__
  26
  27 #include "arm_compute/runtime/IMemoryRegion.h"
  28
  29 #include <cstddef>
  30 #include <memory>
  31
  32 namespace arm_compute
  33 {
  34 /** CPU implementation of memory object */
  35 class Memory
  36 {
  37 public:
  38     /** Default Constructor */
  39     Memory();
  40     /** Default Constructor
  41      *
  42      * @param[in] memory Memory to be imported
  43      */
  44     Memory(std::shared_ptr<IMemoryRegion> memory);
  45     /** Default Constructor
  46      *
  47      * @note Ownership of the memory is not transferred to this object.
  48      *       Thus management (allocate/free) should be done by the client.
  49      *
  50      * @param[in] memory Memory to be imported
  51      */
  52     Memory(IMemoryRegion *memory);
  53     /** Allow instances of this class to be copied */
  54     Memory(const Memory &) = default;
  55     /** Allow instances of this class to be copy assigned */
  56     Memory &operator=(const Memory &) = default;
  57     /** Allow instances of this class to be moved */
  58     Memory(Memory &&) noexcept = default;
  59     /** Allow instances of this class to be move assigned */
  60     Memory &operator=(Memory &&) noexcept = default;
  61     /** Region accessor
  62      *
  63      * @return Memory region
  64      */
  65     IMemoryRegion *region();
  66     /** Region accessor
  67      *
  68      * @return Memory region
  69      */
  70     IMemoryRegion *region() const;
  71
  72 private:
  73     /** Creates empty region */
  74     void create_empty_region();
  75
  76 private:
  77     IMemoryRegion                 *_region;
  78     std::shared_ptr<IMemoryRegion> _region_owned;
  79 };
  80 }
  81 #endif /* __ARM_COMPUTE_MEMORY_H__ */