Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Georgios Pinitas | 4c5469b | 2019-05-21 13:32:43 +0100 | [diff] [blame] | 2 | * Copyright (c) 2016-2019 ARM Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 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 | { |
Georgios Pinitas | 4c5469b | 2019-05-21 13:32:43 +0100 | [diff] [blame] | 35 | // Forward declarations |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 36 | class ITensorAllocator; |
| 37 | class ITensorInfo; |
| 38 | |
| 39 | /** Basic implementation of the OpenCL tensor interface */ |
Georgios Pinitas | 26014cf | 2019-09-09 19:00:57 +0100 | [diff] [blame] | 40 | class CLTensor : public ICLTensor, public IMemoryManageable |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 41 | { |
| 42 | public: |
| 43 | /** Constructor */ |
| 44 | CLTensor(); |
| 45 | /** Return a pointer to the tensor's allocator |
| 46 | * |
| 47 | * @return A pointer to the tensor's allocator |
| 48 | */ |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 49 | CLTensorAllocator *allocator(); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 50 | /** Enqueue a map operation of the allocated buffer. |
| 51 | * |
| 52 | * @param[in] blocking If true, then the mapping will be ready to use by the time |
| 53 | * this method returns, else it is the caller's responsibility |
| 54 | * to flush the queue and wait for the mapping operation to have completed. |
| 55 | */ |
| 56 | void map(bool blocking = true); |
| 57 | using ICLTensor::map; |
| 58 | /** Enqueue an unmap operation of the allocated and mapped buffer. |
| 59 | * |
| 60 | * @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 |
| 61 | * the memory is accessed by the device. |
| 62 | */ |
| 63 | void unmap(); |
| 64 | using ICLTensor::unmap; |
| 65 | |
| 66 | // Inherited methods overridden: |
| 67 | TensorInfo *info() const override; |
| 68 | TensorInfo *info() override; |
| 69 | const cl::Buffer &cl_buffer() const override; |
Georgios Pinitas | 4c5469b | 2019-05-21 13:32:43 +0100 | [diff] [blame] | 70 | CLQuantization quantization() const override; |
Georgios Pinitas | 26014cf | 2019-09-09 19:00:57 +0100 | [diff] [blame] | 71 | void associate_memory_group(IMemoryGroup *memory_group) override; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 72 | |
| 73 | protected: |
| 74 | // Inherited methods overridden: |
| 75 | uint8_t *do_map(cl::CommandQueue &q, bool blocking) override; |
| 76 | void do_unmap(cl::CommandQueue &q) override; |
| 77 | |
| 78 | private: |
| 79 | mutable CLTensorAllocator _allocator; /**< Instance of the OpenCL tensor allocator */ |
| 80 | }; |
| 81 | |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 82 | /** OpenCL Image */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 83 | using CLImage = CLTensor; |
Georgios Pinitas | 26014cf | 2019-09-09 19:00:57 +0100 | [diff] [blame] | 84 | } // namespace arm_compute |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 85 | #endif /*__ARM_COMPUTE_CLTENSOR_H__ */ |