c1d86fc126bb8e243a67df04d30bfb5c3aca63d8
[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 "execution_object_internal.h"
36 namespace tidl {
38 class Kernel;
39 class Device;
40 class LayerOutput;
41 class IODeviceArgInfo;
44 /*! @class ExecutionObject
45     @brief Runs the TIDL network on an OpenCL device
46 */
48 class ExecutionObject : public ExecutionObjectInternalInterface
49 {
50     public:
52         //! @private
53         // Used by the Executor to construct an ExecutionObject
54         ExecutionObject(Device* d, uint8_t device_index,
55                         const  ArgInfo& create_arg,
56                         const  ArgInfo& param_heap_arg,
57                         size_t extmem_heap_size,
58                         int    layersGroupId,
59                         bool   output_trace,
60                         bool   internal_input);
61         //! @private
62         ~ExecutionObject();
64         //! Specify the input and output buffers used by the EO
65         //! @param in buffer used for input.
66         //! @param out buffer used for output.
67         void SetInputOutputBuffer(const ArgInfo& in,
68                                   const ArgInfo& out) override;
70         //! Returns a pointer to the input buffer set via SetInputOutputBuffer
71         char* GetInputBufferPtr() const override;
73         //! Returns size of the input buffer
74         size_t GetInputBufferSizeInBytes() const override;
76         //! Returns a pointer to the output buffer
77         char* GetOutputBufferPtr() const override;
79         //! Returns size of the output buffer
80         size_t GetOutputBufferSizeInBytes() const override;
82         //! @brief Set the frame index of the frame currently processed by the
83         //! ExecutionObject. Used for trace/debug messages
84         //! @param idx index of the frame
85         void  SetFrameIndex(int idx) override;
87         //! Returns the index of a frame being processed (set by SetFrameIndex)
88         int   GetFrameIndex() const override;
90         //! @brief Start processing a frame. The call is asynchronous and
91         //! returns immediately. Use ExecutionObject::ProcessFrameWait to wait
92         bool ProcessFrameStartAsync() override;
94         //! Wait for the execution object to complete processing a frame
95         //! @return false if ExecutionObject::ProcessFrameWait was called
96         //! without a corresponding call to
97         //! ExecutionObject::ProcessFrameStartAsync.
98         bool ProcessFrameWait() override;
100         //! @brief return the number of milliseconds taken *on the device* to
101         //! execute the process call
102         //! @return Number of milliseconds to process a frame on the device.
103         float GetProcessTimeInMilliSeconds() const override;
105         //! @brief return the number of milliseconds taken *on the host* to
106         //! execute the process call
107         //! @return Number of milliseconds to process a frame on the host.
108         float GetHostProcessTimeInMilliSeconds() const override;
110         //! Returns the device name that the ExecutionObject runs on
111         const std::string& GetDeviceName() const override;
113         //! Write the output buffer for each layer to a file
114         //! \<filename_prefix>_<ID>_HxW.bin
115         void WriteLayerOutputsToFile(const std::string& filename_prefix=
116                                      "trace_dump_") const override;
118         //! Returns a LayerOutput object corresponding to a layer.
119         //! Caller is responsible for deleting the LayerOutput object.
120         //! @see LayerOutput
121         //! @param layer_index The layer index of the layer
122         //! @param output_index The output index of the buffer for a given
123         //!                     layer. Defaults to 0.
124         const LayerOutput* GetOutputFromLayer(uint32_t layer_index,
125                                        uint32_t output_index=0) const override;
127         //! Get output buffers from all layers
128         const LayerOutputs* GetOutputsFromAllLayers() const override;
130         //! Returns the layersGrupId that the ExecutionObject is processing
131         int   GetLayersGroupId() const;
133         //! @private
134         // Used by the Executor
135         enum class CallType { INIT, PROCESS, CLEANUP };
136         bool RunAsync(CallType ct);
137         bool Wait    (CallType ct);
139         //! @private
140         // Used by the ExecutionObjectPipeline
141         bool AddCallback(CallType ct, void *user_data);
142         void AcquireLock();
143         void ReleaseLock();
145         ExecutionObject()                                  = delete;
146         ExecutionObject(const ExecutionObject&)            = delete;
147         ExecutionObject& operator=(const ExecutionObject&) = delete;
149         //! @private
150         void SetInputOutputBuffer(const IODeviceArgInfo* in,
151                                   const IODeviceArgInfo* out);
153     private:
154         class Impl;
155         std::unique_ptr<Impl> pimpl_m;
156 };
159 /*! @class LayerOutput
160     @brief Describes the output of a layer in terms of its shape. Also
161     includes a pointer to the data.
162 */
163 class LayerOutput
165     public:
166         //! @private
167         //! Constructor called within API, not by the user
168         LayerOutput(int layer_index, int output_index, int buffer_id,
169                     int num_roi_m, int num_channels, size_t height,
170                     size_t width, const char* data);
172         //! Must be called to delete the data pointer.
173         ~LayerOutput();
175         //! @return The index of a layer
176         int    LayerIndex()       const { return layer_index_m; }
178         //! @return The number of channels associated with an output
179         int    NumberOfChannels() const { return num_channels_m; }
181         //! @return The height of the output. Can be 1 for 1D outputs
182         size_t Height()           const { return height_m; }
184         //! @return The width of the output
185         size_t Width()            const { return width_m; }
187         //! @return Size of the output in bytes
188         size_t Size()             const { return height_m * width_m *
189                                                  num_channels_m; }
190         //! @return Pointer to output. Must call destructor to free the
191         //! memory used to hold the output.
192         const char* Data()        const { return data_m; }
194         //! @private Disable copy construction and assignment since
195         //! class holds a pointer to allocated data
196         LayerOutput(const LayerOutput&)             = delete;
197         LayerOutput& operator= (const LayerOutput&) = delete;
199     private:
200         int layer_index_m;
201         int output_index_m;
202         int buffer_id_m;
203         int num_roi_m;
204         int num_channels_m;
205         size_t height_m;
206         size_t width_m;
207         const char* data_m;
208 };
211 } // namespace tidl