arm_compute/runtime/Types.h

   1 /*
   2  * Copyright (c) 2016, 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_RUNTIME_TYPES_H__
  25 #define __ARM_COMPUTE_RUNTIME_TYPES_H__
  26
  27 #include <map>
  28
  29 namespace arm_compute
  30 {
  31 /** Mapping type */
  32 enum class MappingType
  33 {
  34     BLOBS,  /**< Mappings are in blob granularity */
  35     OFFSETS /**< Mappings are in offset granularity in the same blob */
  36 };
  37
  38 /** A map of (handle, index/offset), where handle is the memory handle of the object
  39  * to provide the memory for and index/offset is the buffer/offset from the pool that should be used
  40  *
  41  * @note All objects are pre-pinned to specific buffers to avoid any relevant overheads
  42  */
  43 using MemoryMappings = std::map<void **, size_t>;
  44
  45 /** A map of the groups and memory mappings */
  46 using GroupMappings = std::map<size_t, MemoryMappings>;
  47
  48 } // arm_compute
  49 #endif /* __ARM_COMPUTE_RUNTIME_TYPES_H__ */