Compute Library
 21.02
Types.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2019 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_TYPES_H
25 #define ARM_COMPUTE_RUNTIME_TYPES_H
26 
28 
29 #include <map>
30 
31 namespace arm_compute
32 {
33 /** Mapping type */
34 enum class MappingType
35 {
36  BLOBS, /**< Mappings are in blob granularity */
37  OFFSETS /**< Mappings are in offset granularity in the same blob */
38 };
39 
40 /** A map of (handle, index/offset), where handle is the memory handle of the object
41  * to provide the memory for and index/offset is the buffer/offset from the pool that should be used
42  *
43  * @note All objects are pre-pinned to specific buffers to avoid any relevant overheads
44  */
45 using MemoryMappings = std::map<IMemory *, size_t>;
46 
47 /** A map of the groups and memory mappings */
48 using GroupMappings = std::map<size_t, MemoryMappings>;
49 
50 /** Meta-data information for each blob */
51 struct BlobInfo
52 {
53  BlobInfo(size_t size_ = 0, size_t alignment_ = 0, size_t owners_ = 1)
54  : size(size_), alignment(alignment_), owners(owners_)
55  {
56  }
57  size_t size; /**< Blob size */
58  size_t alignment; /**< Blob alignment */
59  size_t owners; /**< Number of owners in parallel of the blob */
60 };
61 } // namespace arm_compute
62 #endif /* ARM_COMPUTE_RUNTIME_TYPES_H */
Meta-data information for each blob.
Definition: Types.h:51
std::map< size_t, MemoryMappings > GroupMappings
A map of the groups and memory mappings.
Definition: Types.h:48
Copyright (c) 2017-2021 Arm Limited.
Mappings are in blob granularity.
size_t alignment
Blob alignment.
Definition: Types.h:58
BlobInfo(size_t size_=0, size_t alignment_=0, size_t owners_=1)
Definition: Types.h:53
MappingType
Mapping type.
Definition: Types.h:34
size_t owners
Number of owners in parallel of the blob.
Definition: Types.h:59
Mappings are in offset granularity in the same blob.
std::map< IMemory *, size_t > MemoryMappings
A map of (handle, index/offset), where handle is the memory handle of the object to provide the memor...
Definition: Types.h:45
size_t size
Blob size.
Definition: Types.h:57