1 /* 2 * Copyright (c) 2016-2021 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_CLTENSOR_H 25 #define ARM_COMPUTE_CLTENSOR_H 26 27 #include "arm_compute/core/CL/ICLTensor.h" 28 #include "arm_compute/core/CL/OpenCL.h" 29 #include "arm_compute/runtime/CL/CLTensorAllocator.h" 30 31 #include <cstdint> 32 33 namespace arm_compute 34 { 35 // Forward declarations 36 class ITensorAllocator; 37 class ITensorInfo; 38 class IRuntimeContext; 39 class CLRuntimeContext; 40 /** Basic implementation of the OpenCL tensor interface */ 41 class CLTensor : public ICLTensor, public IMemoryManageable 42 { 43 public: 44 /** Constructor. 45 * 46 * @param[in] ctx (Optional) Pointer to a @ref CLRuntimeContext. 47 * If nullptr is passed in, the legacy api using the singletons will be used. Otherwise the memory for the 48 * tensor will allocate on the context passed in. 49 * The singletons legacy api has been deprecated and will be removed in future releases. 50 */ 51 CLTensor(IRuntimeContext *ctx = nullptr); 52 53 /** Destructor */ 54 ~CLTensor() = default; 55 /** Prevent copying by construction */ 56 CLTensor(const CLTensor &) = delete; 57 /** Default move constructor */ 58 CLTensor(CLTensor &&) = default; 59 /** Prevent copaingy by assignment */ 60 CLTensor &operator=(const CLTensor &) = delete; 61 /** Default move assignment operator */ 62 CLTensor &operator=(CLTensor &&) = default; 63 64 /** Return a pointer to the tensor's allocator 65 * 66 * @return A pointer to the tensor's allocator 67 */ 68 CLTensorAllocator *allocator(); 69 /** Enqueue a map operation of the allocated buffer. 70 * 71 * @param[in] blocking If true, then the mapping will be ready to use by the time 72 * this method returns, else it is the caller's responsibility 73 * to flush the queue and wait for the mapping operation to have completed. 74 */ 75 void map(bool blocking = true); 76 using ICLTensor::map; 77 /** Enqueue an unmap operation of the allocated and mapped buffer. 78 * 79 * @note This method simply enqueues the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before 80 * the memory is accessed by the device. 81 */ 82 void unmap(); 83 using ICLTensor::unmap; 84 85 // Inherited methods overridden: 86 TensorInfo *info() const override; 87 TensorInfo *info() override; 88 const cl::Buffer &cl_buffer() const override; 89 CLQuantization quantization() const override; 90 void associate_memory_group(IMemoryGroup *memory_group) override; 91 CLRuntimeContext *context(); 92 93 protected: 94 // Inherited methods overridden: 95 uint8_t *do_map(cl::CommandQueue &q, bool blocking) override; 96 void do_unmap(cl::CommandQueue &q) override; 97 98 private: 99 mutable CLTensorAllocator _allocator; /**< Instance of the OpenCL tensor allocator */ 100 CLRuntimeContext *_ctx{ nullptr }; 101 }; 102 103 /** OpenCL Image */ 104 using CLImage = CLTensor; 105 } // namespace arm_compute 106 #endif /*ARM_COMPUTE_CLTENSOR_H */ 107