arm_compute/graph/ITensorHandle.h

   1 /*
   2  * Copyright (c) 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_GRAPH_ITENSORHANDLE_H__
  25 #define __ARM_COMPUTE_GRAPH_ITENSORHANDLE_H__
  26
  27 #include "arm_compute/core/ITensor.h"
  28 #include "arm_compute/graph/Types.h"
  29
  30 namespace arm_compute
  31 {
  32 // Forward declarations
  33 class IMemoryGroup;
  34
  35 namespace graph
  36 {
  37 /** Tensor handle interface object */
  38 class ITensorHandle
  39 {
  40 public:
  41     /** Default virtual destructor */
  42     virtual ~ITensorHandle() = default;
  43     /** Allocates backend memory for the handle */
  44     virtual void allocate() = 0;
  45     /** Allocates backend memory for the handle */
  46     virtual void free() = 0;
  47     /** Set backend tensor to be managed by a memory group
  48      *
  49      * @param[in] mg Memory group
  50      */
  51     virtual void manage(IMemoryGroup *mg) = 0;
  52     /** Maps backend tensor object
  53      *
  54      * @param[in] blocking Flags if the mapping operations should be blocking
  55      */
  56     virtual void map(bool blocking) = 0;
  57     /** Un-maps a backend tensor object */
  58     virtual void unmap() = 0;
  59     /** Releases backend tensor if is marked as unused
  60      *
  61      *
  62      * @note This has no effect on sub-tensors
  63      * @warning Parent tensors don't keep track of sub-tensors,
  64      *          thus if a parent is set as unused then all sub-tensors will be invalidated,
  65      *          on the other hand if a sub-tensor is marked as unused then the parent tensor won't be released
  66      */
  67     virtual void release_if_unused() = 0;
  68     /** Backend tensor object accessor */
  69     virtual arm_compute::ITensor &tensor() = 0;
  70     /** Backend tensor object const accessor */
  71     virtual const arm_compute::ITensor &tensor() const = 0;
  72     /** Return the parent tensor handle if is a subtensor else this
  73      *
  74      * @return Parent tensor handle
  75      */
  76     virtual ITensorHandle *parent_handle() = 0;
  77     /** Checks if a backing tensor is a sub-tensor object or not
  78      *
  79      * @return True if the backend tensor is a sub-tensor else false
  80      */
  81     virtual bool is_subtensor() const = 0;
  82     /** Returns target type
  83      *
  84      * @return Target type
  85      */
  86     virtual Target target() const = 0;
  87 };
  88 } // namespace graph
  89 } // namespace arm_compute
  90 #endif /* __ARM_COMPUTE_GRAPH_ITENSORHANDLE_H__ */