src/core/ne-handler.cc

   1 /**
   2  * Proprietary
   3  * Copyright (C) 2020 Samsung Electronics
   4  * Copyright (C) 2020 Dongju Chae <dongju.chae@samsung.com>
   5  */
   6 /**
   7  * @file ne-host-handler.cc
   8  * @date 03 Apr 2020
   9  * @brief Implementation of APIs to access NPU from Host
  10  * @see https://code.sec.samsung.net/confluence/display/ODLC/2020+Overall+Software+Stack
  11  * @author Dongju Chae <dongju.chae@samsung.com>
  12  * @bug No known bugs except for NYI items
  13  */
  14
  15 #include "ne-handler.h"
  16
  17 #include <libnpuhost.h>
  18 #include <npubinfmt.h>
  19 #include <NPUdrvAPI.h>
  20 #include <CommPlugin.h>
  21
  22 #include <string.h>
  23 #include <assert.h>
  24
  25 #include <condition_variable>
  26 #include <functional>
  27 #include <atomic>
  28 #include <map>
  29
  30 #define TAG _N2
  31
  32 #define INIT_HOST_HANDLER(handler, dev) \
  33   Device *tdev = static_cast <Device *> (dev); \
  34   if (tdev == nullptr) return -EINVAL; \
  35   HostHandler *handler = tdev->getHostHandler (); \
  36   if (handler == nullptr) return -EINVAL;
  37
  38 /** just for backward-compatability */
  39 npudev_h HostHandler::latest_dev_ = nullptr;
  40
  41 /** implement libnpuhost APIs */
  42
  43 /**
  44  * @brief Returns the number of available NPU devices.
  45  * @return @c The number of NPU devices.
  46  * @retval 0 if no NPU devices available. if positive (number of NPUs) if NPU devices available. otherwise, a negative error value.
  47  * @note the caller should call putNPUdevice() to release the device handle
  48  */
  49 int getnumNPUdeviceByType (dev_type type)
  50 {
  51   return HostHandler::getNumDevices (type);
  52 }
  53
  54 /**
  55  * @brief Returns the handle of the chosen NPU devices.
  56  * @param[out] dev The NPU device handle
  57  * @param[in] id The NPU id to get the handle. 0 <= id < getnumNPUdeviceByType().
  58  * @return @c 0 if no error. otherwise a negative error value
  59  * @note the caller should call putNPUdevice() to release the device handle
  60  */
  61 int getNPUdeviceByType (npudev_h *dev, dev_type type, uint32_t id)
  62 {
  63   return HostHandler::getDevice (dev, type, id);
  64 }
  65
  66 /**
  67  * @brief release the NPU device instance obtained by getDevice ()
  68  * @param[in] dev the NPU device handle
  69  */
  70 void putNPUdevice (npudev_h dev)
  71 {
  72   if (dev != nullptr)
  73     delete static_cast<Device *> (dev);
  74 }
  75
  76 /**
  77  * @brief Send the NN model to NPU.
  78  * @param[in] dev The NPU device handle
  79  * @param[in] modelfile The filepath to the compiled NPU NN model in any buffer_type
  80  * @param[out] modelid The modelid allocated for this instance of NN model.
  81  * @return @c 0 if no error. otherwise a negative error value
  82  *
  83  * @detail For ASR devices, which do not accept models, but have models
  84  *         embedded in devices, you do not need to call register and
  85  *         register calls for ASR are ignored.
  86  *
  87  * @todo Add a variation: in-memory model register.
  88  */
  89 int registerNPUmodel (npudev_h dev, generic_buffer *modelfile, uint32_t *modelid)
  90 {
  91   INIT_HOST_HANDLER (host_handler, dev);
  92
  93   return host_handler->registerModel (modelfile, modelid);
  94 }
  95
  96 /**
  97  * @brief Remove the NN model from NPU
  98  * @param[in] dev The NPU device handle
  99  * @param[in] modelid The model to be removed from the NPU.
 100  * @return @c 0 if no error. otherwise a negative error value
 101  * @detail This may incur some latency with memory compatcion.
 102  */
 103 int unregisterNPUmodel(npudev_h dev, uint32_t modelid)
 104 {
 105   INIT_HOST_HANDLER (host_handler, dev);
 106
 107   return host_handler->unregisterModel (modelid);
 108 }
 109
 110 /**
 111  * @brief Remove all NN models from NPU
 112  * @param[in] dev The NPU device handle
 113  * @return @c 0 if no error. otherwise a negative error value
 114  */
 115 int unregisterNPUmodel_all(npudev_h dev)
 116 {
 117   INIT_HOST_HANDLER (host_handler, dev);
 118
 119   return host_handler->unregisterModels ();
 120 }
 121
 122 /**
 123  * @brief [OPTIONAL] Set the data layout for input/output tensors
 124  * @param[in] dev The NPU device handle
 125  * @param[in] modelid The ID of model whose layouts are set
 126  * @param[in] info_in the layout/type info for input tensors
 127  * @param[in] info_out the layout/type info for output tensors
 128  * @return @c 0 if no error. otherwise a negative error value
 129  * @note if this function is not called, default layout/type will be used.
 130  */
 131 int setNPU_dataInfo(npudev_h dev, uint32_t modelid,
 132     tensors_data_info *info_in, tensors_data_info *info_out)
 133 {
 134   INIT_HOST_HANDLER (host_handler, dev);
 135
 136   return host_handler->setDataInfo (modelid, info_in, info_out);
 137 }
 138
 139 /**
 140  * @brief [OPTIONAL] Set the inference constraint for next NPU inferences
 141  * @param[in] dev The NPU device handle
 142  * @param[in] modelid The target model id
 143  * @param[in] constraint inference constraint (e.g., timeout, priority)
 144  * @return @c 0 if no error. otherwise a negative error value
 145  * @note If this function is not called, default values are used.
 146  */
 147 int setNPU_constraint(npudev_h dev, uint32_t modelid, npuConstraint constraint)
 148 {
 149   INIT_HOST_HANDLER (host_handler, dev);
 150
 151   return host_handler->setConstraint (modelid, constraint);
 152 }
 153
 154 /**
 155  * @brief Execute inference. Wait (block) until the output is available.
 156  * @param[in] dev The NPU device handle
 157  * @param[in] modelid The model to be inferred.
 158  * @param[in] input The input data to be inferred.
 159  * @param[out] output The output result. The caller MUST allocate appropriately before calling this.
 160  * @return @c 0 if no error. otherwise a negative error value
 161  *
 162  * @detail This is a syntactic sugar of runNPU_async().
 163  *         CAUTION: There is a memcpy for the output buffer.
 164  */
 165 int runNPU_sync(npudev_h dev, uint32_t modelid, const input_buffers *input,
 166     output_buffers *output)
 167 {
 168   INIT_HOST_HANDLER (host_handler, dev);
 169
 170   return host_handler->runSync (modelid, input, output);
 171 }
 172
 173 /**
 174  * @brief Invoke NPU inference. Unblocking call.
 175  * @param[in] dev The NPU device handle
 176  * @param[in] modelid The model to be inferred.
 177  * @param[in] input The input data to be inferred.
 178  * @param[in] cb The output buffer handler.
 179  * @param[out] sequence The sequence number returned with runNPU_async.
 180  * @param[in] data The data given as a parameter to the runNPU_async call.
 181  * @param[in] mode Configures how this operation works.
 182  * @return @c 0 if no error. otherwise a negative error value
 183  */
 184 int runNPU_async(npudev_h dev, uint32_t modelid, const input_buffers *input,
 185     npuOutputNotify cb, uint64_t *sequence, void *data,
 186     npu_async_mode mode)
 187 {
 188   INIT_HOST_HANDLER (host_handler, dev);
 189
 190   return host_handler->runAsync (modelid, input, cb, data, mode, sequence);
 191 }
 192
 193 /**
 194  * @brief Let NPU accept input frames from its internal source continuously
 195  * @param[in] dev The NPU device handle
 196  * @param[in] modelid The model to be inferred.
 197  * @param[in] opmode NPU has different opmode with auto-inputs. Choose one.
 198  * @param[in] hw_dev The target device feeding input data
 199  * @return @c 0 if no error. otherwise a negative error value
 200  */
 201 int runNPU_internalInput(npudev_h dev, uint32_t modelid, npu_input_opmode opmode,
 202     const char * hw_dev)
 203 {
 204   INIT_HOST_HANDLER (host_handler, dev);
 205
 206   return host_handler->runInternal (modelid, opmode, hw_dev);
 207 }
 208
 209 /**
 210  * @brief Stop the request with the given id
 211  * @param[in] dev The NPU device handle
 212  * @param[in] id The request id
 213  * @return @c 0 if no error. otherwise a negative error value
 214  */
 215 int stopNPU_internalInput(npudev_h dev, int id)
 216 {
 217   INIT_HOST_HANDLER (host_handler, dev);
 218
 219   return host_handler->stopInternal (id);
 220 }
 221
 222 /**
 223  * @brief Allocate a generic buffer with the requested buffer type.
 224  * @param[in] dev The NPU device handle
 225  * @param[in/out] Buffer the buffer pointer where memory is allocated.
 226  * @return 0 if no error, otherwise a negative errno.
 227  */
 228 int allocNPU_genericBuffer (npudev_h dev, generic_buffer * buffer)
 229 {
 230   INIT_HOST_HANDLER (host_handler, dev);
 231
 232   return host_handler->allocGenericBuffer (buffer);
 233 }
 234
 235 /**
 236  * @brief Free the generic buffer and remove the address mapping
 237  * @param[in] dev The NPU device handle
 238  * @param[in] buffer the model buffer
 239  * @return 0 if no error, otherwise a negative errno.
 240  */
 241 int cleanNPU_genericBuffer (npudev_h dev, generic_buffer * buffer)
 242 {
 243   INIT_HOST_HANDLER (host_handler, dev);
 244
 245   return host_handler->deallocGenericBuffer (buffer);
 246 }
 247
 248 /**
 249  * @brief Allocate generic buffers, which have multiple instances of generic_buffer
 250  * @param[in] dev The NPU device handle
 251  * @param[in/out] buffers generic buffers.
 252  * @return 0 if no error, otherwise a negative errno.
 253  * @note it reuses allocGenericBuffer().
 254  */
 255 int allocNPU_genericBuffers (npudev_h dev, generic_buffers * buffers)
 256 {
 257   INIT_HOST_HANDLER (host_handler, dev);
 258
 259   return host_handler->allocGenericBuffer (buffers);
 260 }
 261
 262 /**
 263  * @brief Free generic buffers allocated by allocGenericBuffers().
 264  * @param[in] dev The NPU device handle
 265  * @param[in/out] buffers generic buffers.
 266  * @note it reuses cleanGenericbuffer().
 267  * @return 0 if no error, otherwise a negative errno.
 268  */
 269 int cleanNPU_genericBuffers (npudev_h dev, generic_buffers * buffers)
 270 {
 271   INIT_HOST_HANDLER (host_handler, dev);
 272
 273   return host_handler->deallocGenericBuffer (buffers);
 274 }
 275
 276 /**
 277  * @brief alias of allocNPU_genericBuffer for model buffer
 278  */
 279 int allocNPU_modelBuffer (npudev_h dev, generic_buffer * model)
 280 {
 281   return allocNPU_genericBuffer (dev, model);
 282 }
 283
 284 /**
 285  * @brief alias of cleanNPU_genericBuffer for model buffer
 286  */
 287 int cleanNPU_modelBuffer (npudev_h dev, generic_buffer * model)
 288 {
 289   return cleanNPU_genericBuffer (dev, model);
 290 }
 291
 292 /**
 293  * @brief alias of allocNPU_genericBuffer for input buffer
 294  */
 295 int allocNPU_inputBuffer (npudev_h dev, generic_buffer * input)
 296 {
 297   return allocNPU_genericBuffer (dev, input);
 298 }
 299
 300 /**
 301  * @brief alias of cleanNPU_genericBuffer for input buffer
 302  */
 303 int cleanNPU_inputBuffer (npudev_h dev, generic_buffer * input)
 304 {
 305   return cleanNPU_genericBuffer (dev, input);
 306 }
 307
 308 /**
 309  * @brief alias of allocNPU_genericBuffers for input buffers
 310  */
 311 int allocNPU_inputBuffers (npudev_h dev, input_buffers * input)
 312 {
 313   return allocNPU_genericBuffers (dev, input);
 314 }
 315
 316 /**
 317  * @brief alias of cleanNPU_genericBuffers for input buffers
 318  */
 319 int cleanNPU_inputBuffers (npudev_h dev, input_buffers * input)
 320 {
 321   return cleanNPU_genericBuffers (dev, input);
 322 }
 323
 324 /**
 325  * @brief get the current memory status for the given device
 326  * @param[in] dev The NPU device handle
 327  * @param[out] alloc_total The size of allocated memory until now
 328  * @param[out] free_total The size of freed memory until now
 329  * @return @c 0 if no error. otherwise a negatice error value
 330  */
 331 int getNPU_memoryStatus(npudev_h dev, size_t *alloc_total, size_t *free_total)
 332 {
 333   INIT_HOST_HANDLER (host_handler, dev);
 334
 335   return host_handler->getMemoryStatus (alloc_total, free_total);
 336 }
 337
 338 /**
 339  * @brief Get the current device status to be used
 340  * @param[in] dev The NPU device handle
 341  * @param[out] status the device status
 342  * @param[out] num_requests the number of running requests (or pending)
 343  * @return 0 if no error, otherwise a negative errno.
 344  */
 345 int getNPU_deviceStatus(npudev_h dev, npu_status *status, uint32_t *num_requests)
 346 {
 347   INIT_HOST_HANDLER (host_handler, dev);
 348
 349   return host_handler->getDeviceStatus (status, num_requests);
 350 }
 351
 352 /**
 353  * @brief Get metadata for NPU model
 354  * @param[in] model The path of model binary file
 355  * @param[in] need_extra whether you want to extract the extra data in metadata
 356  * @return the metadata structure to be filled if no error, otherwise nullptr
 357  *
 358  * @note For most npu-engine users, the extra data is not useful because it will be
 359  *       used for second-party users (e.g., compiler, simulator).
 360  *       Also, the caller needs to free the metadata.
 361  *
 362  * @note the caller needs to free the metadata
 363  */
 364 npubin_meta * getNPUmodel_metadata (const char *model, bool need_extra)
 365 {
 366   npubin_meta *meta;
 367   FILE *fp;
 368   size_t ret;
 369
 370   if (!model)
 371     return nullptr;
 372
 373   fp = fopen (model, "rb");
 374   if (!fp) {
 375     logerr (TAG, "Failed to open the model binary: %d\n", -errno);
 376     return nullptr;
 377   }
 378
 379   meta = (npubin_meta *) malloc (NPUBIN_META_SIZE);
 380   if (!meta) {
 381     logerr (TAG, "Failed to allocate metadata\n");
 382     goto exit_err;
 383   }
 384
 385   ret = fread (meta, 1, NPUBIN_META_SIZE, fp);
 386   if (ret != NPUBIN_META_SIZE) {
 387     logerr (TAG, "Failed to read the metadata\n");
 388     goto exit_free;
 389   }
 390
 391   if (!CHECK_NPUBIN (meta->magiccode)) {
 392     logerr (TAG, "Invalid metadata provided\n");
 393     goto exit_free;
 394   }
 395
 396   if (need_extra && NPUBIN_META_EXTRA (meta->magiccode) > 0) {
 397     npubin_meta *new_meta;
 398
 399     new_meta = (npubin_meta *) realloc (meta, NPUBIN_META_TOTAL_SIZE(meta->magiccode));
 400     if (!new_meta) {
 401       logerr (TAG, "Failed to allocate extra metadata\n");
 402       goto exit_free;
 403     }
 404
 405     ret = fread (new_meta->reserved_extra, 1, NPUBIN_META_EXTRA_SIZE (meta->magiccode), fp);
 406     if (ret != NPUBIN_META_EXTRA_SIZE (meta->magiccode)) {
 407       logerr (TAG, "Invalid extra metadata provided\n");
 408       free (new_meta);
 409       goto exit_err;
 410     }
 411
 412     meta = new_meta;
 413   }
 414
 415   fclose (fp);
 416
 417   return meta;
 418
 419 exit_free:
 420   free (meta);
 421 exit_err:
 422   fclose (fp);
 423
 424   return nullptr;
 425 }
 426
 427 /** implement methods of HostHandler class */
 428
 429 /** @brief host handler constructor */
 430 HostHandler::HostHandler (Device *device)
 431   : device_(device),
 432     /* ignored as we don't use double buffering anymore, but for backward-compatibility */
 433     async_mode_ (NPUASYNC_WAIT)
 434 {
 435 }
 436
 437 /** @brief host handler destructor */
 438 HostHandler::~HostHandler ()
 439 {
 440 }
 441
 442 /**
 443  * @brief register model from generic buffer
 444  * @param[in] model_buf model buffer
 445  * @param[out] modelid model id
 446  * @return 0 if no error. otherwise a negative errno
 447  */
 448 int
 449 HostHandler::registerModel (generic_buffer *model_buf, uint32_t *modelid)
 450 {
 451   if (model_buf == nullptr || modelid == nullptr) {
 452     logerr (TAG, "Invalid arguments given\n");
 453     return -EINVAL;
 454   }
 455
 456   Model *model = nullptr;
 457   int status = device_->setModel (model_buf, &model);
 458   if (status != 0) {
 459     logerr (TAG, "Failed to set model: %d\n", status);
 460     return status;
 461   }
 462
 463   assert (model != nullptr);
 464
 465   status = models_.insert (model->getID(), model);
 466   if (status != 0) {
 467     logerr (TAG, "Failed to insert model id\n");
 468     delete model;
 469     return status;
 470   }
 471
 472   *modelid = model->getID();
 473   return 0;
 474 }
 475
 476 /**
 477  * @brief remove the registered model
 478  * @param[in] modelid model id
 479  * @return 0 if no error. otherwise a negative errno
 480  */
 481 int
 482 HostHandler::unregisterModel (uint32_t modelid)
 483 {
 484   Model *model = models_.find (modelid);
 485   if (model == nullptr)
 486     return -ENOENT;
 487
 488   int status = device_->unsetModel (model);
 489   if (status != 0) {
 490     logerr (TAG, "Failed to unset model: %d\n", status);
 491     return status;
 492   }
 493
 494   return models_.remove (modelid);
 495 }
 496
 497 /**
 498  * @brief remove all registered models
 499  * @return 0
 500  */
 501 int
 502 HostHandler::unregisterModels ()
 503 {
 504   models_.clear ();
 505   return 0;
 506 }
 507
 508 /**
 509  * @brief Set the data layout for input/output tensors
 510  * @param[in] modelid The ID of model whose layouts are set
 511  * @param[in] in the layout/type info for input tensors
 512  * @param[in] out the layout/type info for output tensors
 513  * @return @c 0 if no error. otherwise a negative error value
 514  * @note if this function is not called, default layout/type will be used.
 515  */
 516 int
 517 HostHandler::setDataInfo (uint32_t modelid, tensors_data_info *in,
 518     tensors_data_info *out)
 519 {
 520   Model *model = models_.find (modelid);
 521   if (model == nullptr)
 522     return -ENOENT;
 523
 524   return model->setDataInfo (in, out);
 525 }
 526
 527 /**
 528  * @brief Set the inference constraint for next NPU inferences
 529  * @param[in] modelid The target model id
 530  * @param[in] constraint inference constraint (e.g., timeout, priority)
 531  * @return @c 0 if no error. otherwise a negative error value
 532  * @note If this function is not called, default values are used.
 533  */
 534 int
 535 HostHandler::setConstraint (uint32_t modelid, npuConstraint constraint)
 536 {
 537   Model *model = models_.find (modelid);
 538   if (model == nullptr)
 539     return -ENOENT;
 540
 541   model->setConstraint (constraint);
 542
 543   return 0;
 544 }
 545
 546 /**
 547  * @brief find and return model instance
 548  * @param[in] modelid model id
 549  * @return model instance if found. otherwise nullptr
 550  */
 551 Model *
 552 HostHandler::getModel (uint32_t modelid)
 553 {
 554   return models_.find (modelid);
 555 }
 556
 557 /** @brief dummay callback for runSync. */
 558 class callbackSync {
 559   public:
 560     callbackSync (output_buffers *output) : output_(output), done_(false) {}
 561
 562     static void callback (output_buffers *output, uint64_t sequence, void *data) {
 563       callbackSync *sync = static_cast<callbackSync *>(data);
 564       sync->callback (output, sequence);
 565     }
 566
 567     void callback (output_buffers *output, uint64_t sequence) {
 568       if (output_ != nullptr) {
 569         /** just copy internal variables of output buffers */
 570         memcpy (output_, output, sizeof (output_buffers));
 571       }
 572       done_ = true;
 573       cv_.notify_one ();
 574     }
 575
 576     void wait () {
 577       std::unique_lock<std::mutex> lock (m_);
 578       cv_.wait (lock, [this]() { return done_; });
 579     }
 580
 581   private:
 582     std::mutex m_;
 583     std::condition_variable cv_;
 584     output_buffers *output_;
 585     bool done_;
 586 };
 587
 588 /**
 589  * @brief Execute inference. Wait (block) until the output is available.
 590  * @param[in] modelid The model to be inferred.
 591  * @param[in] input The input data to be inferred.
 592  * @param[out] output The output result.
 593  * @return @c 0 if no error. otherwise a negative error value
 594  */
 595 int
 596 HostHandler::runSync (uint32_t modelid, const input_buffers *input,
 597     output_buffers *output)
 598 {
 599   callbackSync sync (output);
 600   int status = runAsync (modelid, input, callbackSync::callback,
 601       static_cast <void*> (&sync), NPUASYNC_DROP_OLD, nullptr);
 602   if (status == 0) {
 603     /** sync needs to wait callback */
 604     sync.wait ();
 605   }
 606   return status;
 607 }
 608
 609 /**
 610  * @brief Invoke NPU inference. Unblocking call.
 611  * @param[in] modelid The model to be inferred.
 612  * @param[in] input The input data to be inferred.
 613  * @param[in] cb The output buffer handler.
 614  * @param[in] cb_data The data given as a parameter to the runNPU_async call.
 615  * @param[in] mode Configures how this operation works.
 616  * @param[out] sequence The sequence number returned with runNPU_async.
 617  * @return @c 0 if no error. otherwise a negative error value
 618  */
 619 int
 620 HostHandler::runAsync (uint32_t modelid, const input_buffers *input,
 621     npuOutputNotify cb, void *cb_data, npu_async_mode mode, uint64_t *sequence)
 622 {
 623   Model *model = nullptr;
 624
 625   if (device_->needModel()) {
 626     model = getModel (modelid);
 627     if (model == nullptr)
 628       return -ENOENT;
 629   }
 630
 631   /* check the given model before running */
 632   if (model != nullptr && !model->finalize ()) {
 633     logerr (TAG, "Failed to finalize the model. Please see the log messages\n");
 634     return -EINVAL;
 635   }
 636
 637   device_->setAsyncMode (mode);
 638   return device_->run (NPUINPUT_HOST, model, input, cb, cb_data, sequence);
 639 }
 640
 641 /**
 642  * @brief Let NPU accept input frames from its internal source continuously
 643  * @param[in] modelid The model to be inferred.
 644  * @param[in] opmode NPU has different opmode with auto-inputs. Choose one.
 645  * @param[in] hw_dev The target device feeding input data
 646  * @return @c 0 if no error. otherwise a negative error value
 647  */
 648 int
 649 HostHandler::runInternal (uint32_t modelid, npu_input_opmode opmode,
 650     std::string hw_dev)
 651 {
 652   Model *model = nullptr;
 653
 654   if (device_->needModel()) {
 655     model = getModel (modelid);
 656     if (model == nullptr)
 657       return -ENOENT;
 658   }
 659
 660   /* check the given model before running */
 661   if (model != nullptr && !model->finalize ()) {
 662     logerr (TAG, "Failed to finalize the model. Please see the log messages\n");
 663     return -EINVAL;
 664   }
 665
 666   return device_->runInternal (opmode, model, hw_dev);
 667 }
 668
 669 /**
 670  * @brief Stop the request with the given id
 671  * @param[in] dev The NPU device handle
 672  * @param[in] id The request id
 673  * @return @c 0 if no error. otherwise a negative error value
 674  */
 675 int
 676 HostHandler::stopInternal (int id)
 677 {
 678   if (id <= 0) {
 679     logerr (TAG, "Unable to stop this request with id (%d)\n", id);
 680     return -EINVAL;
 681   }
 682
 683   const DriverAPI * api = device_->getDriverAPI ();
 684   assert (api != nullptr);
 685
 686   return api->stop_target (id);
 687 }
 688
 689 /**
 690  * @brief get number of available devices
 691  * @param[in] type device type
 692  * @return number of devices
 693  */
 694 int
 695 HostHandler::getNumDevices (dev_type type)
 696 {
 697   return DriverAPI::getNumDevices (type);
 698 }
 699
 700 /**
 701  * @brief get device instance
 702  * @param[out] dev device instance
 703  * @param[in] type device type
 704  * @param[in] id device id
 705  * @return 0 if no error. otherwise a negative errno
 706  */
 707 int
 708 HostHandler::getDevice (npudev_h *dev, dev_type type, uint32_t id)
 709 {
 710   int num_devices = getNumDevices (type);
 711
 712   /** check the validity of device id */
 713   if (!(num_devices > 0 && id < static_cast<uint32_t>(num_devices))) {
 714     logerr (TAG, "Invalid arguments provided\n");
 715     return -ENODEV;
 716   }
 717
 718   Device *device = Device::createInstance (type, id);
 719   if (device == nullptr) {
 720     logerr (TAG, "Failed to create a device with the given type\n");
 721     return -EINVAL;
 722   }
 723
 724   *dev = device;
 725   /** This is just for backward-compatility; we don't guarantee its corresness */
 726   latest_dev_ = *dev;
 727
 728   return 0;
 729 }
 730
 731 /**
 732  * @brief allocate generic buffer (just for users)
 733  * @param[out] buffer buffer instance
 734  * @return 0 if no error. otherwise a negative errno
 735  */
 736 int
 737 HostHandler::allocGenericBuffer (generic_buffer *buffer)
 738 {
 739   if (buffer == NULL)
 740     return -EINVAL;
 741
 742   if (buffer->size == 0) {
 743     logerr (TAG, "Invalid size\n");
 744     return -EINVAL;
 745   }
 746
 747   if (buffer->size > UINT32_MAX) {
 748     logerr (TAG, "Don't support such a large size");
 749     return -ENOMEM;
 750   }
 751
 752   switch (buffer->type) {
 753     case BUFFER_FILE:
 754       /* nothing to do */
 755       if (buffer->filepath == nullptr)
 756         return -EINVAL;
 757       break;
 758     case BUFFER_MAPPED:
 759     {
 760       /* now, npu-engine always provides dmabuf-based allocation */
 761       void *addr = nullptr;
 762       int dmabuf = device_->allocMemory (buffer->size, &addr);
 763       if (dmabuf < 0)
 764         return dmabuf;
 765
 766       buffer->dmabuf = dmabuf;
 767       buffer->offset = 0;
 768       buffer->addr = addr;
 769     } break;
 770     default:
 771       return -EINVAL;
 772   }
 773
 774   return 0;
 775 }
 776
 777 /**
 778  * @brief deallocate generic buffer (just for users)
 779  * @param[in] buffer buffer instance
 780  * @return 0 if no error. otherwise a negative errno
 781  */
 782 int
 783 HostHandler::deallocGenericBuffer (generic_buffer *buffer)
 784 {
 785   if (buffer == NULL)
 786     return -EINVAL;
 787
 788   switch (buffer->type) {
 789     case BUFFER_FILE:
 790       /** always true cuz nothing to do */
 791       break;
 792     case BUFFER_MAPPED:
 793       return device_->deallocMemory (buffer->dmabuf, buffer->size, buffer->addr);
 794     default:
 795       return -EINVAL;
 796   }
 797
 798   return 0;
 799 }
 800
 801 /**
 802  * @brief allocate multiple generic buffers (just for users)
 803  * @param[out] buffers multi-buffer instance
 804  * @return 0 if no error. otherwise a negative errno
 805  */
 806 int
 807 HostHandler::allocGenericBuffer (generic_buffers *buffers)
 808 {
 809   uint32_t idx;
 810   int status = 0;
 811
 812   if (buffers == NULL || buffers->num_buffers < 1)
 813     return -EINVAL;
 814
 815   for (idx = 0; idx < buffers->num_buffers; idx++) {
 816     status = allocGenericBuffer (&buffers->bufs[idx]);
 817     if (status != 0)
 818       goto free_buffer;
 819   }
 820
 821   return 0;
 822
 823 free_buffer:
 824   while (idx != 0) {
 825     deallocGenericBuffer (&buffers->bufs[--idx]);
 826   }
 827
 828   return status;
 829 }
 830
 831 /**
 832  * @brief deallocate multiple generic buffers (just for users)
 833  * @param[in] buffers multi-buffer instance
 834  * @return 0 if no error. otherwise a negative errno
 835  */
 836 int
 837 HostHandler::deallocGenericBuffer (generic_buffers *buffers)
 838 {
 839   if (buffers == NULL || buffers->num_buffers < 1)
 840     return -EINVAL;
 841
 842   for (uint32_t idx = 0; idx < buffers->num_buffers; idx++)
 843     deallocGenericBuffer (&buffers->bufs[idx]);
 844   buffers->num_buffers = 0;
 845
 846   return 0;
 847 }
 848
 849 /**
 850  * @brief get the current memory status
 851  * @param[out] alloc_total The size of allocated memory until now
 852  * @param[out] free_total The size of freed memory until now
 853  * @return 0 if no error. otherwise a negatice error value
 854  */
 855 int
 856 HostHandler::getMemoryStatus (size_t *alloc_total, size_t *free_total)
 857 {
 858   /** API is always set in initialize () */
 859   const DriverAPI * api = device_->getDriverAPI ();
 860   assert (api != nullptr);
 861
 862   return api->getMemoryStatus (alloc_total, free_total);
 863 }
 864
 865 /**
 866  * @brief Get the current device status to be used
 867  * @param[out] status the device status
 868  * @param[out] num_requests the number of running requests (or pending)
 869  * @return 0 if no error, otherwise a negative errno.
 870  */
 871 int
 872 HostHandler::getDeviceStatus (npu_status *status, uint32_t *num_requests)
 873 {
 874   /** API is always set in initialize () */
 875   const DriverAPI * api = device_->getDriverAPI ();
 876   assert (api != nullptr);
 877
 878   device_state_t state = api->isReady ();
 879   if (state == device_state_t::STATE_READY) {
 880     *num_requests = api->numRequests ();
 881     if (*num_requests > 0)
 882       *status = NPU_READY;
 883     else
 884       *status = NPU_IDLE;
 885   } else {
 886     *num_requests = 0;
 887     *status = NPU_ERROR;
 888   }
 889
 890   return 0;
 891 }
 892
 893 /** implement methods of Device class */
 894
 895 /** @brief constructor of device */
 896 Device::Device (dev_type type, int id, bool need_model)
 897   : comm_ (CommPlugin::getCommPlugin()), type_ (type), id_ (id), need_model_ (true),
 898     mode_ (NPUASYNC_WAIT), initialized_ (false), atomic_flag_ (ATOMIC_FLAG_INIT)
 899 {
 900 }
 901
 902 /**
 903  * @brief create device instance depending on device type and id
 904  * @param[in] type device type
 905  * @param[in] id device id
 906  * @return device instance
 907  */
 908 Device *
 909 Device::createInstance (dev_type type, int id)
 910 {
 911   Device *device = nullptr;
 912
 913   switch (type & DEVICETYPE_MASK) {
 914     case DEVICETYPE_TRIV:
 915       device = new TrinityVision (id);
 916       break;
 917     case DEVICETYPE_TRIV2:
 918       device = new TrinityVision2 (id);
 919       break;
 920     case DEVICETYPE_TRIA:
 921       device = new TrinityAsr (id);
 922       break;
 923     default:
 924       break;
 925   }
 926
 927   if (device != nullptr && device->init () != 0) {
 928     delete device;
 929     device = nullptr;
 930   }
 931
 932   return device;
 933 }
 934
 935 /**
 936  * @brief device initialization
 937  * @return 0 if no error, otherwise a negative errno
 938  * @note Init failures come from createDriverAPI() only.
 939  */
 940 int
 941 Device::init ()
 942 {
 943   /** should be initilizaed only once */
 944   if (!atomic_flag_.test_and_set()) {
 945     /** create the corresponding driver API */
 946     api_ = DriverAPI::createDriverAPI (type_, id_);
 947     if (api_.get() == nullptr) {
 948       atomic_flag_.clear();
 949       logerr (TAG, "Failed to create driver API\n");
 950       return -EINVAL;
 951     }
 952
 953     handler_.reset (new HostHandler (this));
 954     scheduler_.reset (new Scheduler (api_.get()));
 955     mem_ = MemAllocator::createInstance (api_.get());
 956
 957     initialized_ = true;  /** c++11 does not provide test() of atomic flag */
 958   }
 959
 960   return 0;
 961 }
 962
 963 /**
 964  * @brief stop all requests from this device
 965  * @param[in] force_stop indicate the schedduler waits until to handle previous requests
 966  * @return 0 if no error, otherwise a negative errno
 967  */
 968 int
 969 Device::stop (bool force_stop)
 970 {
 971   if (!initialized ()) {
 972     logerr (TAG, "Uninitialized device; should use libnpuhost APIs\n");
 973     return -EPERM;
 974   }
 975
 976   Request *req = new Request (NPUINPUT_STOP);
 977   req->setForceStop (force_stop);
 978   return scheduler_->submitRequest (req);
 979 }
 980
 981 /**
 982  * @brief allocate generic memory buffer
 983  * @param[in] size the size to allocate
 984  * @param[out] addr the mapped address
 985  * @return dmabuf fd if no error, otherwise a negative errno
 986  */
 987 int
 988 Device::allocMemory (size_t size, void **addr)
 989 {
 990   if (!initialized ()) {
 991     logerr (TAG, "Uninitialized device; should use libnpuhost APIs\n");
 992     return -EPERM;
 993   }
 994
 995   if (size == 0 || addr == nullptr) {
 996     logerr (TAG, "Invalid arguments\n");
 997     return -EINVAL;
 998   }
 999
1000   return mem_->allocMemory (size, addr);
1001 }
1002
1003 /**
1004  * @brief deallocate generic memory buffer
1005  * @param[in] dmabuf_fd dmabuf file descriptor
1006  * @param[in] size buffer size
1007  * @param[in] addr mapped addr
1008  * @return 0 if no error, otherwise a negative errno
1009  */
1010 int
1011 Device::deallocMemory (int dmabuf_fd, size_t size, void * addr)
1012 {
1013   if (!initialized ()) {
1014     logerr (TAG, "Uninitialized device; should use libnpuhost APIs\n");
1015     return -EPERM;
1016   }
1017
1018   if (dmabuf_fd < 0 || size == 0 || addr == nullptr) {
1019     logerr (TAG, "Invalid arguments\n");
1020     return -EINVAL;
1021   }
1022
1023   return mem_->deallocMemory (dmabuf_fd, size, addr);
1024 }
1025
1026 /**
1027  * @brief extract the buffer instance from input generic buffers
1028  * @param[in] meta the model metadata
1029  * @param[in] input the input generic buffers
1030  * @return the buffer instance
1031  */
1032 Buffer *
1033 TrinityVision::prepareInputBuffers (const Metadata *meta, const input_buffers *input)
1034 {
1035   if (meta == nullptr || input == nullptr ||
1036       meta->getInputNum() != input->num_buffers) {
1037     logerr (TAG, "Invalid metadata info provided\n");
1038     return nullptr;
1039   }
1040
1041   Buffer * buffer;
1042   const generic_buffer *first = &input->bufs[0];
1043   if (first->type == BUFFER_DMABUF) {
1044     buffer = mem_->allocBuffer (new HWmemExternal);
1045     if (buffer == nullptr)
1046       return nullptr;
1047
1048     buffer->setDmabuf (first->dmabuf);
1049     buffer->setOffset (first->offset);
1050     buffer->setSize (meta->getBufferSize());
1051   } else {
1052     buffer = mem_->allocBuffer (new HWmemDevice);
1053     if (buffer == nullptr)
1054       return nullptr;
1055
1056     int status = buffer->alloc (meta->getBufferSize ());
1057     if (status != 0) {
1058       logerr (TAG, "Failed to allocate buffer: %d\n", status);
1059       delete buffer;
1060       return nullptr;
1061     }
1062   }
1063
1064   int status = buffer->createTensors (meta);
1065   if (status != 0) {
1066     logerr (TAG, "Failed to create tensors: %d\n", status);
1067     delete buffer;
1068     buffer = nullptr;
1069   }
1070
1071   return buffer;
1072 }
1073
1074 /**
1075  * @brief implementation of TRIV's setModel ()
1076  * @param[in] model_buf the model generic buffer
1077  * @param[out] model the model instance
1078  * @return 0 if no error, otherwise a negative errno
1079  */
1080 int
1081 TrinityVision::setModel (const generic_buffer *model_buf, Model ** model_ptr)
1082 {
1083   if (!initialized ()) {
1084     logerr (TAG, "Uninitialized device; should use libnpuhost APIs\n");
1085     return -EPERM;
1086   }
1087
1088   if (model_buf == nullptr || model_ptr == nullptr)
1089     return -EINVAL;
1090
1091   Model *model = nullptr;
1092   HWmem * hwmem_prog = nullptr;
1093   HWmem * hwmem_weight = nullptr;
1094   int status;
1095
1096   /** In TRIV1, model data (including program/weight) should be contiguous */
1097
1098   switch (model_buf->type) {
1099   case BUFFER_FILE:
1100   case BUFFER_MAPPED:
1101     model = mem_->allocModel (new HWmemDevice);
1102     if (model == nullptr) {
1103       logerr (TAG, "Failed to allocate model\n");
1104       return -ENOMEM;
1105     }
1106
1107     status = model->alloc (model_buf->size);
1108     if (status != 0) {
1109       logerr (TAG, "Failed to allocate model: %d\n", status);
1110       goto delete_exit;
1111     }
1112
1113     /** extract the whole model data */
1114     status = comm_.extractGenericBuffer (model_buf, model->getData(), nullptr);
1115     if (status != 0) {
1116       logerr (TAG, "Failed to extract generic buffer: %d\n", status);
1117       goto delete_exit;
1118     }
1119     break;
1120   default:
1121     return -EINVAL;
1122   }
1123
1124   status = model->setMetadata (model->getData());
1125   if (status != 0)
1126     goto delete_exit;
1127
1128   /** allocate program (optional; NOP) */
1129   if (model->getMetadata()->getProgramSize() > 0) {
1130     hwmem_prog = new HWmem (new HWmemChunk);
1131     model->setProgramData (hwmem_prog);
1132
1133     hwmem_prog->setParent (model);
1134     hwmem_prog->setOffset (model->getMetadata()->getMetaSize());
1135     status = hwmem_prog->alloc (model->getMetadata()->getProgramSize());
1136     if (status != 0) {
1137       logerr (TAG, "Failed to allocate program\n");
1138       goto delete_exit;
1139     }
1140   }
1141
1142   /** allocate weight (optional) */
1143   if (model->getMetadata()->getWeightSize() > 0) {
1144     hwmem_weight = new HWmem (new HWmemChunk);
1145     model->setWeightData (hwmem_weight);
1146
1147     hwmem_weight->setParent (model);
1148     hwmem_weight->setOffset (model->getMetadata()->getMetaSize() +
1149         model->getMetadata()->getProgramSize());
1150     status = hwmem_weight->alloc (model->getMetadata()->getWeightSize());
1151     if (status != 0) {
1152       logerr (TAG, "Failed to allocate program\n");
1153       goto delete_exit;
1154     }
1155   }
1156
1157   if (hwmem_prog != nullptr) {
1158     /** register this model to the driver */
1159     model_config_t config;
1160     config.dbuf_fd = hwmem_prog->getDmabuf ();
1161     config.program_size = hwmem_prog->getSize ();
1162     config.program_offset_addr = hwmem_prog->getOffset ();
1163     if (hwmem_weight != nullptr)
1164       config.weight_offset_addr = hwmem_weight->getOffset ();
1165
1166     status = api_->registerModel (&config);
1167     if (status != 0)
1168       goto delete_exit;
1169
1170     model->setInternalID(config.id);
1171   }
1172
1173   *model_ptr = model;
1174   return status;
1175
1176 delete_exit:
1177   delete model;
1178   return status;
1179 }
1180
1181 /**
1182  * @brief implementation of TRIV's unsetModel ()
1183  * @param[in] model the model instance
1184  * @return 0 if no error, otherwise a negative errno
1185  */
1186 int
1187 TrinityVision::unsetModel (Model * model)
1188 {
1189   if (!initialized ()) {
1190     logerr (TAG, "Uninitialized device; should use libnpuhost APIs\n");
1191     return -EPERM;
1192   }
1193
1194   if (model == nullptr) {
1195     logerr (TAG, "Invalid model instance\n");
1196     return -EINVAL;
1197   }
1198
1199   if (model->getMetadata()->getProgramSize() > 0)
1200     return api_->deregisterModel (model->getInternalID ());
1201
1202   return 0;
1203 }
1204
1205 /**
1206  * @brief implementation of TRIV's run()
1207  * @param[in] opmode input opmode
1208  * @param[in] model the model instance
1209  * @param[in] input generic buffers of input data
1210  * @param[in] cb the output callback
1211  * @param[in] cb_data the output callback data
1212  * @param[out] sequence The sequence number returned with runNPU_async.
1213  */
1214 int
1215 TrinityVision::run (npu_input_opmode opmode, const Model *model,
1216     const input_buffers *input, npuOutputNotify cb, void *cb_data,
1217     uint64_t *sequence)
1218 {
1219   if (!initialized ()) {
1220     logerr (TAG, "Uninitialized device; should use libnpuhost APIs\n");
1221     return -EPERM;
1222   }
1223
1224   if (opmode != NPUINPUT_HOST) {
1225     logerr (TAG, "TRIV supports only host inputservice\n");
1226     return -EINVAL;
1227   }
1228
1229   if (model == nullptr || input == nullptr) {
1230     logerr (TAG, "TRIV requires both model and input buffers\n");
1231     return -EINVAL;
1232   }
1233
1234   Buffer *buffer = prepareInputBuffers (model->getMetadata(), input);
1235   if (buffer == nullptr) {
1236     logerr (TAG, "Failed to extract buffer instance\n");
1237     return -EINVAL;
1238   }
1239
1240   if (!buffer->isExternal ()) {
1241     for (uint32_t idx = 0; idx < input->num_buffers; idx++) {
1242       auto func = std::bind (TrinityVision::manipulateData, model, idx, true,
1243           std::placeholders::_1, std::placeholders::_2, std::placeholders::_3);
1244       int status = comm_.extractGenericBuffer (&input->bufs[idx],
1245           buffer->getInputTensor(idx)->getData(), func);
1246       if (status != 0) {
1247         logerr (TAG, "Failed to feed input buffer: %d\n", status);
1248         return status;
1249       }
1250     }
1251   }
1252
1253   /** this device uses CMA buffer */
1254
1255   Request *req = new Request (opmode);
1256   req->setModel (model);
1257   req->setBuffer (buffer);
1258
1259   if (cb != nullptr)
1260     req->setCallback (std::bind (&TrinityVision::callback, this, req, cb, cb_data));
1261
1262   if (sequence != nullptr)
1263     *sequence = req->getID();
1264
1265   return scheduler_->submitRequest (req);
1266 }
1267
1268 /**
1269  * @brief callback of TRIV2 request
1270  * @param[in] req the request instance
1271  * @param[in] cb callback for completion
1272  * @param[in] cb_data callback data
1273  * @note The callback invoke does not gurantee the request was successful
1274  * @todo Check the request failures
1275  */
1276 void
1277 TrinityVision::callback (Request *req, npuOutputNotify cb, void *cb_data)
1278 {
1279   const Model *model = req->getModel ();
1280   Buffer *buffer = req->getBuffer ();
1281   output_buffers output = {
1282     .num_buffers = buffer->getOutputNum ()
1283   };
1284
1285   for (uint32_t idx = 0; idx < output.num_buffers; idx++) {
1286     uint32_t output_tensor_size = model->getOutputTensorSize (idx);
1287
1288     if (buffer->isExternal ()) {
1289       output.bufs[idx].type = BUFFER_DMABUF;
1290       output.bufs[idx].size = output_tensor_size;
1291       output.bufs[idx].addr = buffer->getOutputTensor(idx)->getData();
1292     } else {
1293       output.bufs[idx].type = BUFFER_MAPPED;
1294       output.bufs[idx].size = output_tensor_size;
1295       /** user needs to free this */
1296       output.bufs[idx].addr = malloc (output_tensor_size);
1297
1298       auto func = std::bind (TrinityVision::manipulateData, model, idx, false,
1299           std::placeholders::_1, std::placeholders::_2, std::placeholders::_3);
1300       int status = comm_.insertGenericBuffer (buffer->getOutputTensor(idx)->getData(),
1301           &output.bufs[idx], func);
1302       if (status != 0) {
1303         logerr (TAG, "Failed to return output buffer: %d\n", status);
1304       }
1305     }
1306   }
1307
1308   cb (&output, req->getID(), cb_data);
1309
1310   delete buffer;
1311 }
1312
1313 /**
1314  * @brief extract the segment table instance from input generic buffers
1315  * @param[in] model the model instance
1316  * @param[in] input the input generic buffers
1317  * @param[in] output the output generic buffers
1318  * @return the segment table instance
1319  */
1320 SegmentTable *
1321 TrinityVision2::prepareSegmentTable (const Model *model, const input_buffers *input,
1322     const output_buffers *output)
1323 {
1324   if (model == nullptr) {
1325     logerr (TAG, "Invalid arguments provided\n");
1326     return nullptr;
1327   }
1328
1329   const Metadata *meta = model->getMetadata ();
1330   if (meta == nullptr || (input != nullptr &&
1331         meta->getInputNum() != input->num_buffers)) {
1332     logerr (TAG, "Invalid metadata info provided\n");
1333     return nullptr;
1334   }
1335
1336   SegmentTable * segt = mem_->allocSegmentTable (new HWmemDevice);
1337   int status = segt->alloc ();
1338   if (status != 0) {
1339     logerr (TAG, "Failed to allocate segment table: %d\n", status);
1340     goto delete_segt;
1341   }
1342
1343   status = segt->createSegments (model, input, output);
1344   if (status != 0) {
1345     logerr (TAG, "Failed to create segments: %d\n", status);
1346     goto delete_segt;
1347   }
1348
1349   return segt;
1350
1351 delete_segt:
1352   delete segt;
1353   return nullptr;
1354 }
1355
1356 /**
1357  * @brief implementation of TRIV2's setModel ()
1358  * @param[in] model_buf the model generic buffer
1359  * @param[out] model the model instance
1360  * @return 0 if no error, otherwise a negative errno
1361  */
1362 int
1363 TrinityVision2::setModel (const generic_buffer *model_buf, Model ** model_ptr)
1364 {
1365   if (!initialized ()) {
1366     logerr (TAG, "Uninitialized device; should use libnpuhost APIs\n");
1367     return -EPERM;
1368   }
1369
1370   if (model_buf == nullptr || model_ptr == nullptr)
1371     return -EINVAL;
1372
1373   Model *model;
1374   int status;
1375
1376   switch (model_buf->type) {
1377   case BUFFER_FILE:
1378   case BUFFER_MAPPED:
1379     model = mem_->allocModel (new HWmemDevice);
1380     if (model == nullptr) {
1381       logerr (TAG, "Failed to allocate model\n");
1382       return -ENOMEM;
1383     }
1384
1385     status = model->alloc (NPUBIN_META_SIZE);
1386     if (status != 0) {
1387       logerr (TAG, "Failed to allocate model: %d\n", status);
1388       goto delete_exit;
1389     }
1390
1391     status = comm_.extractGenericBuffer (model_buf, model->getData(), nullptr,
1392         0, NPUBIN_META_SIZE);
1393     if (status != 0) {
1394       logerr (TAG, "Failed to extract generic buffer: %d\n", status);
1395       goto delete_exit;
1396     }
1397     break;
1398   default:
1399     return -EINVAL;
1400   }
1401
1402   status = model->setMetadata (model->getData());
1403   if (status != 0)
1404     goto delete_exit;
1405
1406   /** allocate program (optional; NOP) */
1407   if (model->getMetadata()->getProgramSize() > 0) {
1408     HWmem * hwmem_prog = new HWmem (new HWmemDevice);
1409     hwmem_prog->setDriverAPI (api_.get());
1410
1411     model->setProgramData (hwmem_prog);
1412
1413     status = hwmem_prog->alloc (model->getMetadata()->getProgramSize());
1414     if (status != 0) {
1415       logerr (TAG, "Failed to allocate program\n");
1416       goto delete_exit;
1417     }
1418
1419     status = comm_.extractGenericBuffer (model_buf, hwmem_prog->getData(), nullptr,
1420         model->getMetadata()->getMetaSize(),
1421         model->getMetadata()->getProgramSize());
1422     if (status != 0) {
1423       logerr (TAG, "Failed to extract generic buffer: %d\n", status);
1424       goto delete_exit;
1425     }
1426
1427     /** register this model to the driver */
1428     model_config_t config;
1429     config.dbuf_fd = hwmem_prog->getDmabuf ();
1430     config.program_size = hwmem_prog->getSize ();
1431     config.program_offset_addr = 0;
1432
1433     status = api_->registerModel (&config);
1434     if (status != 0)
1435       goto delete_exit;
1436
1437     model->setInternalID(config.id);
1438   }
1439
1440   /** allocate weight (optional) */
1441   if (model->getMetadata()->getWeightSize() > 0) {
1442     HWmem * hwmem_weight = new HWmem (new HWmemDevice);
1443     hwmem_weight->setDriverAPI (api_.get());
1444
1445     model->setWeightData (hwmem_weight);
1446
1447     status = hwmem_weight->alloc (model->getMetadata()->getWeightSize());
1448     if (status != 0) {
1449       logerr (TAG, "Failed to allocate program\n");
1450       goto delete_exit;
1451     }
1452
1453     status = comm_.extractGenericBuffer (model_buf, hwmem_weight->getData(), nullptr,
1454         model->getMetadata()->getMetaSize() + model->getMetadata()->getProgramSize(),
1455         model->getMetadata()->getWeightSize());
1456     if (status != 0) {
1457       logerr (TAG, "Failed to extract generic buffer: %d\n", status);
1458       goto delete_exit;
1459     }
1460   }
1461
1462   *model_ptr = model;
1463   return status;
1464
1465 delete_exit:
1466   delete model;
1467   return status;
1468 }
1469
1470 /**
1471  * @brief implementation of TRIV2's unsetModel ()
1472  * @param[in] model the model instance
1473  * @return 0 if no error, otherwise a negative errno
1474  */
1475 int
1476 TrinityVision2::unsetModel (Model * model)
1477 {
1478   if (!initialized ()) {
1479     logerr (TAG, "Uninitialized device; should use libnpuhost APIs\n");
1480     return -EPERM;
1481   }
1482
1483   if (model == nullptr) {
1484     logerr (TAG, "Invalid model instance\n");
1485     return -EINVAL;
1486   }
1487
1488   if (model->getMetadata()->getProgramSize() > 0)
1489     return api_->deregisterModel (model->getInternalID ());
1490
1491   return 0;
1492 }
1493
1494 /** @brief implementation of TRIV2's run() */
1495 int
1496 TrinityVision2::run (npu_input_opmode opmode, const Model *model,
1497     const input_buffers *input, npuOutputNotify cb, void *cb_data,
1498     uint64_t *sequence)
1499 {
1500   if (!initialized ()) {
1501     logerr (TAG, "Uninitialized device; should use libnpuhost APIs\n");
1502     return -EPERM;
1503   }
1504
1505   if (opmode != NPUINPUT_HOST)
1506     return -EINVAL;
1507
1508   /** this device uses segment table */
1509   SegmentTable * segt = prepareSegmentTable (model, input);
1510   if (segt == nullptr) {
1511     logerr (TAG, "Failed to create segment table instance\n");
1512     return -EINVAL;
1513   }
1514
1515   /** extract input data */
1516   for (uint32_t idx = 0; idx < input->num_buffers; idx++) {
1517     size_t max_seg_size = segt->getInputSegment(idx)->getSize();
1518     uint32_t seg_offset = segt->getInputSegmentOffset(idx);
1519
1520     if (input->bufs[idx].size + seg_offset > max_seg_size) {
1521       logerr (TAG, "Too large input data provided: max segment size (%zu)\n",
1522           max_seg_size);
1523       return -ERANGE;
1524     }
1525
1526     if (!segt->getInputSegment(idx)->isExternal ()) {
1527       auto func = std::bind (TrinityVision2::manipulateData, model, idx, true,
1528           std::placeholders::_1, std::placeholders::_2, std::placeholders::_3);
1529       int status = comm_.extractGenericBuffer (
1530           &input->bufs[idx],
1531           segt->getInputSegment(idx)->getData() + seg_offset,
1532           func);
1533       if (status != 0) {
1534         logerr (TAG, "Failed to feed input segment: %d\n", status);
1535         return status;
1536       }
1537     }
1538   }
1539
1540   Request *req = new Request (opmode);
1541   req->setModel (model);
1542   req->setSegmentTable (segt);
1543   req->setCallback (std::bind (&TrinityVision2::callback, this, req, cb, cb_data));
1544
1545   if (sequence)
1546     *sequence = req->getID();
1547
1548   return scheduler_->submitRequest (req);
1549 }
1550
1551 /** @brief implementation of TRIV2's runInternal() */
1552 int
1553 TrinityVision2::runInternal (npu_input_opmode opmode, const Model *model,
1554     std::string hw_dev)
1555 {
1556   if (!initialized ()) {
1557     logerr (TAG, "Uninitialized device; should use libnpuhost APIs\n");
1558     return -EPERM;
1559   }
1560
1561   if (opmode != NPUINPUT_HW_RECURRING)
1562     return -EINVAL;
1563
1564   /** this device uses segment table */
1565   SegmentTable * segt = prepareSegmentTable (model, nullptr, nullptr);
1566   if (segt == nullptr) {
1567     logerr (TAG, "Failed to create segment table instance\n");
1568     return -EINVAL;
1569   }
1570
1571   Request *req = new Request (opmode);
1572   req->setModel (model);
1573   req->setSegmentTable (segt);
1574   req->setHwDevice (hw_dev);
1575
1576   return scheduler_->submitRequest (req);
1577 }
1578
1579 /** @brief callback of TRIV2 request */
1580 void
1581 TrinityVision2::callback (Request *req, npuOutputNotify cb, void *cb_data)
1582 {
1583   const Model *model = req->getModel ();
1584   SegmentTable *segt = req->getSegmentTable ();
1585   output_buffers output = {
1586     .num_buffers = segt->getNumOutputSegments ()
1587   };
1588
1589   for (uint32_t idx = 0; idx < output.num_buffers; idx++) {
1590     uint32_t output_tensor_size = model->getOutputTensorSize (idx);
1591
1592     output.bufs[idx].type = BUFFER_MAPPED;
1593     output.bufs[idx].size = output_tensor_size;
1594     /** user needs to free this */
1595     output.bufs[idx].addr = calloc (1, output_tensor_size);
1596
1597     auto func = std::bind (TrinityVision2::manipulateData, model, idx, false,
1598         std::placeholders::_1, std::placeholders::_2, std::placeholders::_3);
1599     int status = comm_.insertGenericBuffer (
1600         segt->getOutputSegment(idx)->getData() + segt->getOutputSegmentOffset(idx),
1601         &output.bufs[idx], func);
1602
1603     if (status != 0) {
1604       logerr (TAG, "Failed to return output buffer: %d\n", status);
1605     }
1606   }
1607
1608   cb (&output, req->getID(), cb_data);
1609
1610   delete segt;
1611 }
1612
1613 /** @brief implementation of TRIA's run(): WIP */
1614 int
1615 TrinityAsr::run (npu_input_opmode opmode, const Model *model,
1616     const input_buffers *input, npuOutputNotify cb, void *cb_data,
1617     uint64_t *sequence)
1618 {
1619   if (!initialized ()) {
1620     logerr (TAG, "Uninitialized device; should use libnpuhost APIs\n");
1621     return -EPERM;
1622   }
1623
1624   if (opmode != NPUINPUT_HOST)
1625     return -EINVAL;
1626
1627   Buffer * buffer;
1628   int status;
1629   /** ASR does not require model and support only a single tensor */
1630   const generic_buffer *first_buf = &input->bufs[0];
1631   if (first_buf->type == BUFFER_DMABUF) {
1632     buffer = mem_->allocBuffer (new HWmemExternal);
1633     if (buffer == nullptr)
1634       return -ENOMEM;
1635
1636     buffer->setDmabuf (first_buf->dmabuf);
1637     buffer->setOffset (first_buf->offset);
1638     buffer->setSize (first_buf->size);
1639   } else {
1640     buffer = mem_->allocBuffer (new HWmemDevice);
1641     if (buffer == nullptr)
1642       return -ENOMEM;
1643
1644     status = buffer->alloc (first_buf->size);
1645     if (status != 0) {
1646       delete buffer;
1647       return status;
1648     }
1649   }
1650
1651   status = buffer->createTensors ();
1652   if (status != 0) {
1653     logerr (TAG, "Failed to create tensors: %d\n", status);
1654     delete buffer;
1655     return status;
1656   }
1657
1658   if (!buffer->isExternal ()) {
1659     status = comm_.extractGenericBuffer (first_buf,
1660         buffer->getInputTensor(0)->getData(), nullptr);
1661     if (status != 0)
1662       return status;
1663   }
1664
1665   Request *req = new Request (opmode);
1666   req->setBuffer (buffer);
1667   req->setCallback (std::bind (&TrinityAsr::callback, this, req, cb, cb_data));
1668
1669   if (sequence)
1670     *sequence = req->getID();
1671
1672   return scheduler_->submitRequest (req);
1673 }
1674
1675 /** @brief callback of TRIA request: WIP */
1676 void
1677 TrinityAsr::callback (Request *req, npuOutputNotify cb, void *cb_data)
1678 {
1679 }
1680
1681 /** Implement data manipulation (each device may have different impl.) */
1682
1683 #ifdef ENABLE_MANIP
1684
1685 #define do_quantized_memcpy(type) do {\
1686     idx = 0;\
1687     if (quant) {\
1688       while (idx < num_elems) {\
1689           val = ((type *) src)[idx];\
1690           val = val / _scale;\
1691           val += _zero_point;\
1692           val = (val > 255.0) ? 255.0 : 0.0;\
1693           ((uint8_t *) dst)[idx++] = (uint8_t) val;\
1694       }\
1695     } else {\
1696       while (idx < num_elems) {\
1697           val = *(uint8_t *) src;\
1698           val -= _zero_point;\
1699           val *= _scale;\
1700           ((type *) dst)[idx++] = (type) val;\
1701           dst = (void*)(((uint8_t *) dst) + data_size);\
1702           src = (void*)(((uint8_t *) src) + 1);\
1703       }\
1704     }\
1705   } while (0)
1706
1707 /**
1708  * @brief memcpy during quantization
1709  */
1710 static void memcpy_with_quant (bool quant, data_type type, float scale, uint32_t zero_point,
1711     void *dst, const void *src, uint32_t num_elems)
1712 {
1713   double _scale = (double) scale;
1714   double _zero_point = (double) zero_point;
1715   double val;
1716   uint32_t data_size = get_data_size (type);
1717   uint32_t idx;
1718
1719   switch (type) {
1720     case DATA_TYPE_INT8:
1721       do_quantized_memcpy (int8_t);
1722       break;
1723     case DATA_TYPE_UINT8:
1724       do_quantized_memcpy (uint8_t);
1725       break;
1726     case DATA_TYPE_INT16:
1727       do_quantized_memcpy (int16_t);
1728       break;
1729     case DATA_TYPE_UINT16:
1730       do_quantized_memcpy (uint16_t);
1731       break;
1732     case DATA_TYPE_INT32:
1733       do_quantized_memcpy (int32_t);
1734       break;
1735     case DATA_TYPE_UINT32:
1736       do_quantized_memcpy (uint32_t);
1737       break;
1738     case DATA_TYPE_INT64:
1739       do_quantized_memcpy (int64_t);
1740       break;
1741     case DATA_TYPE_UINT64:
1742       do_quantized_memcpy (uint64_t);
1743       break;
1744     case DATA_TYPE_FLOAT32:
1745       do_quantized_memcpy (float);
1746       break;
1747     case DATA_TYPE_FLOAT64:
1748       do_quantized_memcpy (double);
1749       break;
1750     default:
1751       logerr (TAG, "Unsupported datatype %d\n", type);
1752   }
1753 }
1754
1755 /**
1756  * @brief perform data manipulation
1757  * @param[in] model model instance
1758  * @param[in] idx tensor index
1759  * @param[in] is_input indicate it's input manipulation
1760  * @param[out] dst destination buffer
1761  * @param[in] src source buffer (feature map)
1762  * @param[in] size size to be copied
1763  * @return size of memory copy if no error, otherwise zero
1764  *
1765  * @note the input data format should be NHWC
1766  * @detail rules for the memory address of activations in NPU HW.
1767  *         (https://code.sec.samsung.net/confluence/pages/viewpage.action?pageId=146491864)
1768  *
1769  * 1) Special case (depth == 3)
1770  * - addr(x,y,z) = addr(0,0,0) + (z) + 3 * (x + width * y)
1771  *
1772  * 2) Common case
1773  * - addr(x,y,z) = addr(0,0,0) + (z % MPA_L) + MPA_L * (x + width * (y + height * (z / MPA_L)))
1774  *
1775  * Thus, if depth is not a multiple of MPA_L (i.e., 64), zero padding is required
1776  */
1777 size_t
1778 TrinityVision::manipulateData (const Model *model, uint32_t idx, bool is_input,
1779     void *dst, void *src, size_t size)
1780 {
1781   const Metadata *meta = model->getMetadata();
1782   const tensor_data_info* info;
1783   const uint32_t *dims;
1784   uint32_t zero_point;
1785   float scale;
1786
1787   /** extract required information from the metadata */
1788   if (is_input) {
1789     if (idx >= meta->getInputNum()) {
1790       logerr (TAG, "Wrong information for input tensors in metadata\n");
1791       return 0;
1792     }
1793
1794     info = model->getInputDataInfo (idx);
1795     dims = meta->getInputDims (idx);
1796     zero_point = meta->getInputQuantZero (idx);
1797     scale = meta->getInputQuantScale (idx);
1798   } else {
1799     if (idx >= meta->getOutputNum()) {
1800       logerr (TAG, "Wrong information for output tensors in metadata\n");
1801       return 0;
1802     }
1803
1804     info = model->getOutputDataInfo (idx);
1805     dims = meta->getOutputDims (idx);
1806     zero_point = meta->getOutputQuantZero (idx);
1807     scale = meta->getOutputQuantScale (idx);
1808   }
1809
1810   if (info == nullptr) {
1811     logerr (TAG, "Unmatched tensors info\n");
1812     return 0;
1813   }
1814
1815   uint32_t batch = dims[0];
1816   uint32_t height = dims[1];
1817   uint32_t width = dims[2];
1818   uint32_t depth = dims[3];
1819
1820   uint32_t data_size = get_data_size (info->type);
1821   if (data_size == 0) {
1822     logerr (TAG, "Invalid data size\n");
1823     return 0;
1824   }
1825
1826   bool need_quantization = false;
1827   /**
1828    * note that we assume DATA_TYPE_SRNPU is the smallest data type that we consider.
1829    * Also, DATA_TYPE_SRNPU and uint8_t may be regarded as the same in the view of apps.
1830    */
1831   if (info->type != DATA_TYPE_SRNPU) {
1832     assert (data_size >= get_data_size (DATA_TYPE_SRNPU));
1833
1834     if (data_size > get_data_size (DATA_TYPE_SRNPU) ||
1835         !(zero_point == default_quant_zero && scale == default_quant_scale))
1836       need_quantization = true;
1837   }
1838
1839   /** check data manipulation is required */
1840   if (depth != 3 && depth != 64 && info->layout != DATA_LAYOUT_SRNPU) {
1841     uint32_t MPA_L = DATA_GRANULARITY;
1842     uint32_t n, h, w, d;
1843     uint32_t std_offset;  /* standard offset in NHWC data format */
1844     uint32_t npu_offset;  /* npu offset in NPU HW data format*/
1845     uint32_t src_offset;
1846     uint32_t dst_offset;
1847     uint32_t slice_size;
1848
1849     /* @todo we currently support only NHWC */
1850     if (info->layout != DATA_LAYOUT_NHWC) {
1851       logerr (TAG, "data manipulation is supported for NHWC only\n");
1852       return 0;
1853     }
1854
1855     for (n = 0; n < batch; n++) {
1856       for (h = 0; h < height; h++) {
1857         for (w = 0; w < width; w++) {
1858           for (d = 0; d < depth; d += MPA_L) {
1859             std_offset = d + depth * (w + width * (h + n * height));
1860             npu_offset = MPA_L * (w + width * (h + (n + d / MPA_L) * height));
1861             slice_size = (depth - d >= MPA_L) ? MPA_L : depth - d;
1862
1863             if (is_input) {
1864               src_offset = std_offset * data_size;
1865               dst_offset = npu_offset;
1866             } else {
1867               src_offset = npu_offset;
1868               dst_offset = std_offset * data_size;
1869             }
1870
1871             /* if depth is not a multiple of MPA_L, add zero paddings (not exact values) */
1872             if (need_quantization) {
1873               memcpy_with_quant (is_input, info->type, scale, zero_point,
1874                   static_cast<char*>(dst) + dst_offset,
1875                   static_cast<char*>(src) + src_offset,
1876                   slice_size);
1877             } else {
1878               memcpy (
1879                   static_cast<char*>(dst) + dst_offset,
1880                   static_cast<char*>(src) + src_offset,
1881                   slice_size);
1882             }
1883           }
1884         }
1885       }
1886     }
1887   } else if (need_quantization) {
1888     /** depth == 3 || depth == 64; special cases which can directly copy input tensor data */
1889     memcpy_with_quant (is_input, info->type, scale, zero_point,
1890         dst, src, is_input ? size / data_size : size);
1891   } else {
1892     memcpy (dst, src, size);
1893   }
1894
1895   return size;
1896 }
1897
1898 #else
1899
1900 size_t
1901 TrinityVision::manipulateData (const Model *model, uint32_t idx, bool is_input,
1902     void *dst, void *src, size_t size)
1903 {
1904   memcpy (dst, src, size);
1905   return size;
1906 }
1907
1908 #endif
1909
1910 /** other device types don't have data manip impl. yet */
1911
1912 size_t
1913 TrinityVision2::manipulateData (const Model *model, uint32_t idx, bool is_input,
1914     void *dst, void *src, size_t size)
1915 {
1916   memcpy (dst, src, size);
1917   return size;
1918 }
1919
1920 size_t
1921 TrinityAsr::manipulateData (const Model *model, uint32_t idx, bool is_input,
1922     void *dst, void *src, size_t size)
1923 {
1924   memcpy (dst, src, size);
1925   return size;
1926 }