Merge tag 'v01.01.00.00' into develop
[tidl/tidl-api.git] / tidl_api / inc / execution_object.h
1 /******************************************************************************
2  * Copyright (c) 2017-2018 Texas Instruments Incorporated - http://www.ti.com/
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *      * Redistributions of source code must retain the above copyright
8  *        notice, this list of conditions and the following disclaimer.
9  *      * Redistributions in binary form must reproduce the above copyright
10  *        notice, this list of conditions and the following disclaimer in the
11  *        documentation and/or other materials provided with the distribution.
12  *      * Neither the name of Texas Instruments Incorporated nor the
13  *        names of its contributors may be used to endorse or promote products
14  *        derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
26  *  THE POSSIBILITY OF SUCH DAMAGE.
27  *****************************************************************************/
29 /*! @file execution_object.h */
31 #pragma once
33 #include <memory>
34 #include "configuration.h"
35 #include "execution_object_internal.h"
37 namespace tidl {
39 class Kernel;
40 class Device;
41 class LayerOutput;
42 class IODeviceArgInfo;
45 /*! @class ExecutionObject
46     @brief Runs the TIDL network on an OpenCL device
47 */
49 class ExecutionObject : public ExecutionObjectInternalInterface
50 {
51     public:
53         //! @private
54         // Used by the Executor to construct an ExecutionObject
55         ExecutionObject(Device* d, uint8_t device_index,
56                         const  ArgInfo& create_arg,
57                         const  ArgInfo& param_heap_arg,
58                         const  Configuration& configuration,
59                         int    layersGroupId);
60         //! @private
61         ~ExecutionObject();
63         //! Specify the input and output buffers used by the EO
64         //! @param in buffer used for input.
65         //! @param out buffer used for output.
66         void SetInputOutputBuffer(const ArgInfo& in,
67                                   const ArgInfo& out) override;
69         //! Returns a pointer to the input buffer set via SetInputOutputBuffer
70         char* GetInputBufferPtr() const override;
72         //! Returns size of the input buffer
73         size_t GetInputBufferSizeInBytes() const override;
75         //! Returns a pointer to the output buffer
76         char* GetOutputBufferPtr() const override;
78         //! Returns size of the output buffer
79         size_t GetOutputBufferSizeInBytes() const override;
81         //! @brief Set the frame index of the frame currently processed by the
82         //! ExecutionObject. Used for trace/debug messages
83         //! @param idx index of the frame
84         void  SetFrameIndex(int idx) override;
86         //! Returns the index of a frame being processed (set by SetFrameIndex)
87         int   GetFrameIndex() const override;
89         //! @brief Start processing a frame. The call is asynchronous and
90         //! returns immediately. Use ExecutionObject::ProcessFrameWait to wait
91         bool ProcessFrameStartAsync() override;
93         //! Wait for the execution object to complete processing a frame
94         //! @return false if ExecutionObject::ProcessFrameWait was called
95         //! without a corresponding call to
96         //! ExecutionObject::ProcessFrameStartAsync.
97         bool ProcessFrameWait() override;
99         //! @brief return the number of milliseconds taken *on the device* to
100         //! execute the process call
101         //! @return Number of milliseconds to process a frame on the device.
102         float GetProcessTimeInMilliSeconds() const override;
104         //! @brief return the number of milliseconds taken *on the host* to
105         //! execute the process call
106         //! @return Number of milliseconds to process a frame on the host.
107         float GetHostProcessTimeInMilliSeconds() const override;
109         //! Returns the device name that the ExecutionObject runs on
110         const std::string& GetDeviceName() const override;
112         //! Write the output buffer for each layer to a file
113         //! \<filename_prefix>_<ID>_HxW.bin
114         void WriteLayerOutputsToFile(const std::string& filename_prefix=
115                                      "trace_dump_") const override;
117         //! Returns a LayerOutput object corresponding to a layer.
118         //! Caller is responsible for deleting the LayerOutput object.
119         //! @see LayerOutput
120         //! @param layer_index The layer index of the layer
121         //! @param output_index The output index of the buffer for a given
122         //!                     layer. Defaults to 0.
123         const LayerOutput* GetOutputFromLayer(uint32_t layer_index,
124                                        uint32_t output_index=0) const override;
126         //! Get output buffers from all layers
127         const LayerOutputs* GetOutputsFromAllLayers() const override;
129         //! Returns the layersGrupId that the ExecutionObject is processing
130         int   GetLayersGroupId() const;
132         //! @private
133         // Used by the Executor
134         enum class CallType { INIT, PROCESS, CLEANUP };
135         bool RunAsync(CallType ct);
136         bool Wait    (CallType ct);
138         //! @private
139         // Used by the ExecutionObjectPipeline
140         bool AddCallback(CallType ct, void *user_data);
141         void AcquireLock();
142         void ReleaseLock();
144         ExecutionObject()                                  = delete;
145         ExecutionObject(const ExecutionObject&)            = delete;
146         ExecutionObject& operator=(const ExecutionObject&) = delete;
148         //! @private
149         void SetInputOutputBuffer(const IODeviceArgInfo* in,
150                                   const IODeviceArgInfo* out);
152     private:
153         class Impl;
154         std::unique_ptr<Impl> pimpl_m;
155 };
158 /*! @class LayerOutput
159     @brief Describes the output of a layer in terms of its shape. Also
160     includes a pointer to the data.
161 */
162 class LayerOutput
164     public:
165         //! @private
166         //! Constructor called within API, not by the user
167         LayerOutput(int layer_index, int output_index, int buffer_id,
168                     int num_roi_m, int num_channels, size_t height,
169                     size_t width, const char* data);
171         //! Must be called to delete the data pointer.
172         ~LayerOutput();
174         //! @return The index of a layer
175         int    LayerIndex()       const { return layer_index_m; }
177         //! @return The number of channels associated with an output
178         int    NumberOfChannels() const { return num_channels_m; }
180         //! @return The height of the output. Can be 1 for 1D outputs
181         size_t Height()           const { return height_m; }
183         //! @return The width of the output
184         size_t Width()            const { return width_m; }
186         //! @return Size of the output in bytes
187         size_t Size()             const { return height_m * width_m *
188                                                  num_channels_m; }
189         //! @return Pointer to output. Must call destructor to free the
190         //! memory used to hold the output.
191         const char* Data()        const { return data_m; }
193         //! @private Disable copy construction and assignment since
194         //! class holds a pointer to allocated data
195         LayerOutput(const LayerOutput&)             = delete;
196         LayerOutput& operator= (const LayerOutput&) = delete;
198     private:
199         int layer_index_m;
200         int output_index_m;
201         int buffer_id_m;
202         int num_roi_m;
203         int num_channels_m;
204         size_t height_m;
205         size_t width_m;
206         const char* data_m;
207 };
210 } // namespace tidl