Compute Library
 21.05
MemoryRegion.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2020 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_RUNTIME_MEMORY_REGION_H
25 #define ARM_COMPUTE_RUNTIME_MEMORY_REGION_H
26 
28 
29 #include "arm_compute/core/Error.h"
30 
31 #include <cstddef>
32 
33 namespace arm_compute
34 {
35 /** Memory region CPU implementation */
36 class MemoryRegion final : public IMemoryRegion
37 {
38 public:
39  /** Constructor
40  *
41  * @param[in] size Region size
42  * @param[in] alignment Alignment in bytes of the base pointer. Defaults to 0
43  */
44  MemoryRegion(size_t size, size_t alignment = 0)
45  : IMemoryRegion(size), _mem(nullptr), _ptr(nullptr)
46  {
47  if(size != 0)
48  {
49  // Allocate backing memory
50  size_t space = size + alignment;
51  _mem = std::shared_ptr<uint8_t>(new uint8_t[space](), [](uint8_t *ptr)
52  {
53  delete[] ptr;
54  });
55  _ptr = _mem.get();
56 
57  // Calculate alignment offset
58  if(alignment != 0)
59  {
60  void *aligned_ptr = _mem.get();
61  std::align(alignment, size, aligned_ptr, space);
62  _ptr = aligned_ptr;
63  }
64  }
65  }
66  MemoryRegion(void *ptr, size_t size)
67  : IMemoryRegion(size), _mem(nullptr), _ptr(nullptr)
68  {
69  if(size != 0)
70  {
71  _ptr = ptr;
72  }
73  }
74  /** Prevent instances of this class from being copied (As this class contains pointers) */
75  MemoryRegion(const MemoryRegion &) = delete;
76  /** Default move constructor */
77  MemoryRegion(MemoryRegion &&) = default;
78  /** Prevent instances of this class from being copied (As this class contains pointers) */
79  MemoryRegion &operator=(const MemoryRegion &) = delete;
80  /** Default move assignment operator */
81  MemoryRegion &operator=(MemoryRegion &&) = default;
82 
83  // Inherited methods overridden :
84  void *buffer() final
85  {
86  return _ptr;
87  }
88  const void *buffer() const final
89  {
90  return _ptr;
91  }
92  std::unique_ptr<IMemoryRegion> extract_subregion(size_t offset, size_t size) final
93  {
94  if(_ptr != nullptr && (offset < _size) && (_size - offset >= size))
95  {
96  return std::make_unique<MemoryRegion>(static_cast<uint8_t *>(_ptr) + offset, size);
97  }
98  else
99  {
100  return nullptr;
101  }
102  }
103 
104 protected:
105  std::shared_ptr<uint8_t> _mem;
106  void *_ptr;
107 };
108 } // namespace arm_compute
109 #endif /* ARM_COMPUTE_RUNTIME_MEMORY_REGION_H */
void * buffer() final
Returns the pointer to the allocated data.
Definition: MemoryRegion.h:84
__global uchar * offset(const Image *img, int x, int y)
Get the pointer position of a Image.
Definition: helpers.h:861
std::unique_ptr< IMemoryRegion > extract_subregion(size_t offset, size_t size) final
Extract a sub-region from the memory.
Definition: MemoryRegion.h:92
Memory region interface.
Definition: IMemoryRegion.h:33
Memory region CPU implementation.
Definition: MemoryRegion.h:36
Copyright (c) 2017-2021 Arm Limited.
MemoryRegion(void *ptr, size_t size)
Definition: MemoryRegion.h:66
const void * buffer() const final
Returns the pointer to the allocated data.
Definition: MemoryRegion.h:88
MemoryRegion(size_t size, size_t alignment=0)
Constructor.
Definition: MemoryRegion.h:44
MemoryRegion & operator=(const MemoryRegion &)=delete
Prevent instances of this class from being copied (As this class contains pointers)
size_t size() const
Memory region size accessor.
Definition: IMemoryRegion.h:73