tinn_api/inc/executor.h

   1 /******************************************************************************
   2  * Copyright (c) 2017-18 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  *****************************************************************************/
  28
  29 //! @file executor.h
  30
  31 #pragma once
  32 #include <string>
  33 #include <vector>
  34 #include <memory>
  35 #include <cstdint>
  36 #include <cassert>
  37 #include <set>
  38 #include <exception>
  39
  40 #include "configuration.h"
  41 #include "custom.h"
  42
  43 namespace tinn {
  44
  45 //! Enumerates types of devices available to offload the network.
  46 enum class DeviceType { DSP, /**< Offload to C66x DSP */
  47                         DLA  /**< Offload to TI DLA */
  48                       };
  49
  50 //! Enumerates IDs for devices of a given type.
  51 enum class DeviceId : int { ID0=0, /**< DSP1 or DLA1 */
  52                             ID1,   /**< DSP2 or DLA2 */
  53                             ID2,   /**< DLA3 */
  54                             ID3    /**< DLA4 */
  55                           };
  56
  57 //! Used to specify the set of devices available to an Executor
  58 typedef std::set<DeviceId> DeviceIds;
  59
  60 class ExecutorImpl;
  61 class ExecutionObject;
  62
  63 //! Defines the return type for Executor::GetExecutionObjects
  64 typedef std::vector<std::unique_ptr<ExecutionObject>> ExecutionObjects;
  65
  66 /*! @class Executor
  67     @brief Manages the overall execution of a network using the
  68     specified configuration and the set of devices available to the
  69     executor.
  70 */
  71 class Executor
  72 {
  73     public:
  74         //! @brief Create an Executor object.
  75         //!
  76         //! The Executor will create the required ExecutionObject's and
  77         //! initialize them with the specified TI DL network. E.g.
  78         //! @code
  79         //!   Configuration configuration;
  80         //!   configuration.ReadFromFile("path to configuration file");
  81         //!   DeviceIds ids1 = {DeviceId::ID2, DeviceId::ID3};
  82         //!   Executor executor(DeviceType::DLA, ids, configuration);
  83         //! @endcode
  84         //!
  85         //! @param device_type DSP or EVE/DLA device
  86         //! @param ids Set of devices uses by this instance of the Executor
  87         //! @param configuration Configuration used to initialize the Executor
  88         Executor(DeviceType device_type, const DeviceIds& ids,
  89                  const Configuration& configuration);
  90
  91         //! @brief Tear down an Executor and free resources used by the
  92         //! Executor object
  93         ~Executor();
  94
  95         //! Returns a vector of unique_ptr's to execution objects
  96         //! available on this instance of the Executor
  97         const ExecutionObjects& GetExecutionObjects() const;
  98
  99         //! @brief Returns the number of devices of the specified type
 100         //! available for TI DL.
 101         //! @param  device_type DSP or EVE/DLA device
 102         //! @return number of devices available
 103         static uint32_t GetNumDevices(DeviceType device_type);
 104
 105         //! @brief Returns a string corresponding to the API version
 106         //!
 107         //! @return <major_ver>.<minor_ver>.<patch_ver>.<git_sha>
 108         static std::string GetAPIVersion();
 109
 110         Executor(const Executor&) = delete;
 111         Executor& operator= (const Executor&) = delete;
 112
 113
 114     private:
 115         std::unique_ptr<ExecutorImpl> pimpl_m;
 116 };
 117
 118 /*! @class PipeInfo
 119  *  @brief Describe input and output required by piping output and input
 120  *         between Execution Objects
 121  */
 122 class PipeInfo
 123 {
 124     public:
 125         uint32_t dataQ_m[OCL_TIDL_MAX_IN_BUFS];
 126         uint32_t bufAddr_m[OCL_TIDL_MAX_IN_BUFS];
 127 };
 128
 129 /*! @class ArgInfo
 130  *  @brief Describe input and output buffers required by ExecutionObjects
 131  */
 132 class ArgInfo
 133 {
 134     public:
 135         enum class DeviceAccess { R_ONLY=0, W_ONLY, RW };
 136
 137         //! Enumerates the types of arguments represented by ArgInfo
 138         enum class Kind { BUFFER=0, SCALAR };
 139
 140         //! Construct an ArgInfo object from a pointer to a chunk of memory
 141         //! and its size.
 142         ArgInfo(void *p, size_t size) :
 143             ptr_m(p), size_m(size),
 144             access_m(DeviceAccess::RW), kind_m(Kind::BUFFER)
 145         { pipe_m = std::make_shared<PipeInfo>(); }
 146
 147         //! Construct an ArgInfo object from a pointer to a chunk of memory
 148         //! its size and kind
 149         ArgInfo(void *p, size_t size, Kind kind) :
 150             ptr_m(p), size_m(size), access_m(DeviceAccess::RW), kind_m(kind) {}
 151
 152         //! @return Pointer to the buffer or scalar represented by ArgInfo
 153         void  *ptr()  const { return ptr_m; }
 154
 155         //! @return The size of the buffer or scalar represented by ArgInfo
 156         size_t size() const { return size_m; }
 157
 158         // Only used by tinn::Device
 159         Kind   kind() const { return kind_m; }
 160         bool   isLocal() const { return (ptr_m == nullptr) && (size_m > 0); }
 161
 162         // Only used by tinn::ExecutionObject::Impl
 163         PipeInfo *GetPipe() const { return pipe_m.get(); }
 164
 165     private:
 166         void*        ptr_m;
 167         size_t       size_m;
 168         DeviceAccess access_m;
 169         Kind         kind_m;
 170         std::shared_ptr<PipeInfo> pipe_m;
 171 };
 172
 173
 174 extern "C" void  __free_ddr(void *ptr);
 175 extern "C" void* __malloc_ddr(size_t s);
 176
 177 //! template typedef for unique_ptr with __free_ddr deleter
 178 template<class T>
 179 using up_malloc_ddr = std::unique_ptr<T, decltype(&__free_ddr)>;
 180
 181 //! __malloc_ddr wrapper - Bytes allocated determined by sizeof(T)
 182 template<class T>
 183 inline T* malloc_ddr()
 184 {
 185     assert (std::is_pointer<T>::value == false);
 186     T* val =  reinterpret_cast<T *>(__malloc_ddr(sizeof(T)));
 187     assert (val != nullptr);
 188     return val;
 189 }
 190
 191 //! __malloc_ddr wrapper - Bytes allocated passed as argument
 192 template<class T>
 193 inline T* malloc_ddr(size_t size)
 194 {
 195     assert (std::is_pointer<T>::value == false);
 196     T* val = reinterpret_cast<T *>(__malloc_ddr(size));
 197     assert (val != nullptr);
 198     return val;
 199 }
 200
 201 /*! @class Exception
 202  *  @brief Used to error reporting
 203  */
 204 class Exception : public std::exception
 205 {
 206     public:
 207         Exception() {}
 208         Exception(const std::string& error, const std::string& file,
 209                   const std::string& func, uint32_t line_no);
 210         Exception(int32_t errorCode, const std::string& file,
 211                   const std::string& func, uint32_t line_no);
 212
 213         virtual ~Exception() {}
 214
 215         //! @return String describing the error message and its location
 216         virtual const char* what() const noexcept;
 217
 218     private:
 219         std::string message_m;
 220 };
 221
 222 } // namespace tinn