runtime/onert/api/include/nnfw.h

   1 /*
   2  * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file  nnfw.h
  19  * @brief This file describes runtime API
  20  */
  21 #ifndef __NNFW_H__
  22 #define __NNFW_H__
  23
  24 #include <stddef.h>
  25 #include <stdint.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /**
  32  * @brief Session to query with runtime
  33  *
  34  * <p>nnfw_session is started and passed by calling {@link nnfw_create_session}.
  35  * Each session has its own inference environment, such as model to inference, backend usage, etc.
  36  *
  37  * <p>Load model by calling {@link nnfw_load_model_from_file}
  38  *
  39  * <p>After loading, prepare inference by calling {@link nnfw_prepare}.
  40  * Application can set runtime environment before prepare by calling
  41  * {@link nnfw_set_available_backends} and {@link nnfw_set_op_backend}, and it is optional.
  42  *
  43  * <p>Application can inference by calling {@link nnfw_run}.
  44  * Before inference, application has responsibility to set input tensor to set input data by calling
  45  * {@link nnfw_set_output}, and output tensor to get output by calling {@link nnfw_set_input}
  46  *
  47  * <p>To support input and output setting, application can get
  48  * input and output tensor information by calling<ul>
  49  * <li>{@link nnfw_input_size}</li>
  50  * <li>{@link nnfw_output_size}</li>
  51  * <li>{@link nnfw_input_tensorinfo}</li>
  52  * <li>{@link nnfw_output_tensorinfo}</li>
  53  * </ul>
  54  *
  55  * <p>Application can inference many times using one session,
  56  * but next inference can do after prior inference end
  57  *
  58  * <p>Application cannot use muitiple model using one session
  59  */
  60 typedef struct nnfw_session nnfw_session;
  61
  62 /**
  63  * @brief Tensor types
  64  *
  65  * The type of tensor represented in {@link nnfw_tensorinfo}
  66  */
  67 typedef enum
  68 {
  69   /** A tensor of 32 bit floating point */
  70   NNFW_TYPE_TENSOR_FLOAT32 = 0,
  71   /** A tensor of 32 bit signed integer */
  72   NNFW_TYPE_TENSOR_INT32 = 1,
  73   /**
  74    * A tensor of 8 bit unsigned integers that represent real numbers.
  75    *
  76    * real_value = (integer_value - zeroPoint) * scale.
  77    */
  78   NNFW_TYPE_TENSOR_QUANT8_ASYMM = 2,
  79   /** A tensor of boolean */
  80   NNFW_TYPE_TENSOR_BOOL = 3,
  81
  82   /** A tensor of 8 bit unsigned integer */
  83   NNFW_TYPE_TENSOR_UINT8 = 4,
  84
  85   /** A tensor of 64 bit signed integer */
  86   NNFW_TYPE_TENSOR_INT64 = 5,
  87
  88   /**
  89    * A tensor of 8 bit signed integers that represent real numbers.
  90    *
  91    * real_value = (integer_value - zeroPoint) * scale.
  92    */
  93   NNFW_TYPE_TENSOR_QUANT8_ASYMM_SIGNED = 6,
  94
  95 } NNFW_TYPE;
  96
  97 /**
  98  * @brief Result values returned from a call to an API function
  99  */
 100 typedef enum
 101 {
 102   /** Successful */
 103   NNFW_STATUS_NO_ERROR = 0,
 104   /**
 105    * An error code for general use.
 106    * Mostly used when there is no specific value for that certain situation.
 107    */
 108   NNFW_STATUS_ERROR = 1,
 109   /** Unexpected null argument is given. */
 110   NNFW_STATUS_UNEXPECTED_NULL = 2,
 111   /** When a function was called but it is not valid for the current session state. */
 112   NNFW_STATUS_INVALID_STATE = 3,
 113   /** When it is out of memory */
 114   NNFW_STATUS_OUT_OF_MEMORY = 4,
 115   /** When it was given an insufficient output buffer */
 116   NNFW_STATUS_INSUFFICIENT_OUTPUT_SIZE = 5,
 117 } NNFW_STATUS;
 118
 119 /**
 120  * @brief Data format of a tensor
 121  */
 122 typedef enum
 123 {
 124   /** Don't care layout */
 125   NNFW_LAYOUT_NONE = 0,
 126   /**
 127    * Channel last layout
 128    * If rank is 4, layout is NHWC
 129    */
 130   NNFW_LAYOUT_CHANNELS_LAST = 1,
 131   /**
 132    * Channel first layout
 133    * If rank is 4, layout is NCHW
 134    */
 135   NNFW_LAYOUT_CHANNELS_FIRST = 2,
 136 } NNFW_LAYOUT;
 137
 138 /**
 139  * @brief Information ID for retrieving information on nnfw (e.g. version)
 140  */
 141 typedef enum
 142 {
 143   /** nnfw runtime version
 144    * Its value is uint32 in 0xMMmmmmPP, where MM = major, mmmm = minor, PP = patch.
 145    */
 146   NNFW_INFO_ID_VERSION = 0,
 147 } NNFW_INFO_ID;
 148
 149 /**
 150  * @brief Maximum rank expressible with nnfw
 151  */
 152 #define NNFW_MAX_RANK (6)
 153
 154 /**
 155  * @brief tensor info describes the type and shape of tensors
 156  *
 157  * <p>This structure is used to describe input and output tensors.
 158  * Application can get input and output tensor type and shape described in model by using
 159  * {@link nnfw_input_tensorinfo} and {@link nnfw_output_tensorinfo}
 160  *
 161  * <p>Maximum rank is 6 (NNFW_MAX_RANK). And tensor's dimension value is filled in 'dims' field from
 162  * index 0.
 163  * For example, if tensor's rank is 4,
 164  * application can get dimension value from dims[0], dims[1], dims[2], and dims[3]
 165  */
 166 typedef struct nnfw_tensorinfo
 167 {
 168   /** The data type */
 169   NNFW_TYPE dtype;
 170   /** The number of dimensions (rank) */
 171   int32_t rank;
 172   /**
 173    * The dimension of tensor.
 174    * Maximum rank is 6 (NNFW_MAX_RANK).
 175    */
 176   int32_t dims[NNFW_MAX_RANK];
 177 } nnfw_tensorinfo;
 178
 179 /**
 180  * @brief Create a new session instance.
 181  *
 182  * <p>This only creates a session.
 183  * Model is loaded after {@link nnfw_load_model_from_file} is invoked.
 184  * And inference is performed after {@link nnfw_run} is invoked.
 185  *
 186  * <p>{@link nnfw_close_session} should be called once
 187  * if session is no longer need
 188  *
 189  * @param[out]  session The session to be created
 190  * @return      NNFW_STATUS_NO_ERROR if successful
 191  */
 192 NNFW_STATUS nnfw_create_session(nnfw_session **session);
 193
 194 /**
 195  * @brief Close a session instance
 196  *
 197  * After called, access to closed session by application will be invalid
 198  *
 199  * @param[in] session The session to be closed
 200  * @return    @c NNFW_STATUS_NO_ERROR if successful
 201  */
 202 NNFW_STATUS nnfw_close_session(nnfw_session *session);
 203
 204 /**
 205  * @brief     Load model from nnpackage file or directory
 206  *
 207  * The length of \p package_file_path must not execeed 1024 bytes including zero at the end.
 208  *
 209  * @param[in] session           nnfw_session loading the given nnpackage file/dir
 210  * @param[in] package_file_path Path to the nnpackage file or unzipped directory to be loaded
 211  *
 212  * @return    @c NNFW_STATUS_NO_ERROR if successful
 213  */
 214 NNFW_STATUS nnfw_load_model_from_file(nnfw_session *session, const char *package_file_path);
 215
 216 /**
 217  * @brief     Apply i-th input's tensor info to resize input tensor
 218  *
 219  * This function should be called before {@link nnfw_prepare} is invoked, and
 220  * should be called after {@link nnfw_load_model_from_file} is invoked
 221  * See {@link nnfw_prepare} for information applying updated tensor info
 222  * If this function is called many times for same index, tensor info is overwritten
 223  *
 224  * @deprecated Deprecated since 1.7.0. Use {@link nnfw_set_input_tensorinfo} instead.
 225  *
 226  * @param[in] session     Session to the input tensor info is to be set
 227  * @param[in] index       Index of input to be applied (0-indexed)
 228  * @param[in] tensor_info Tensor info to be applied
 229  * @return    @c NNFW_STATUS_NO_ERROR if successful, otherwise return @c NNFW_STATUS_ERROR
 230  */
 231 NNFW_STATUS nnfw_apply_tensorinfo(nnfw_session *session, uint32_t index,
 232                                   nnfw_tensorinfo tensor_info);
 233
 234 /**
 235  * @brief    Set input model's tensor info for resizing
 236  *
 237  * This function can be called at any time after calling {@link nnfw_model_load_from_file}. Changing
 238  * input tensor's shape will cause shape inference for the model. There are two different types of
 239  * shape inference - static and dynamic. Which one to use is depend on the current state of the
 240  * session.
 241  * When it is called after calling {@link nnfw_model_load_from_file} and before calling {@link
 242  * nnfw_prepare}, this info will be used when {@link nnfw_prepare}. And it will perform static shape
 243  * inference for all tensors.
 244  * When it is called after calling {@link nnfw_prepare} or even after {@link nnfw_run}, this info
 245  * will be used when {@link nnfw_run}. And the shapes of the tensors are determined on the fly.
 246  * If this function is called many times for the same index, it is overwritten.
 247  *
 248  * @param[in] session     Session to the input tensor info is to be set
 249  * @param[in] index       Index of input to be set (0-indexed)
 250  * @param[in] tensor_info Tensor info to be set
 251  * @return    @c NNFW_STATUS_NO_ERROR if successful, otherwise return @c NNFW_STATUS_ERROR
 252  */
 253 NNFW_STATUS nnfw_set_input_tensorinfo(nnfw_session *session, uint32_t index,
 254                                       const nnfw_tensorinfo *tensor_info);
 255
 256 /**
 257  * @brief     Prepare session to be ready for inference
 258  *
 259  * This phase may finalize model compilation, scheduling, and additional settings.
 260  * If {@link nnfw_apply_tensor} is called to apply input tensor info different with model
 261  * before this function, tries to resize all tensors.
 262  *
 263  * @param[in] session the session to be prepared
 264  * @return    @c NNFW_STATUS_NO_ERROR if successful, otherwise return @c NNFW_STATUS_ERROR
 265  */
 266 NNFW_STATUS nnfw_prepare(nnfw_session *session);
 267
 268 /**
 269  * @brief     Run inference
 270  *
 271  * <p>This function should be called after model is loaded by {@link nnfw_load_model_from_file},
 272  * session is prepared for inference by {@link nnfw_prepare}, set input and output buffers
 273  * by {@link nnfw_set_input} and {@link nnfw_set_output}.</p>
 274  *
 275  * <p>This function return after inference is finished.</p>
 276  *
 277  * @param[in] session The session to run inference
 278  * @return    @c NNFW_STATUS_NO_ERROR if successful
 279  */
 280 NNFW_STATUS nnfw_run(nnfw_session *session);
 281
 282 /**
 283  * @brief     Run inference asynchronously
 284  *
 285  * <p>This function must be called after model is loaded by {@link nnfw_load_model_from_file},
 286  * session is prepared for inference by {@link nnfw_prepare}, set input and output buffers
 287  * by {@link nnfw_set_input} and {@link nnfw_set_output}.</p>
 288  *
 289  * <p>This function returns immediately after starting a thread to run the inference.
 290  * To get the result of it or to do the next inference with {@link nnfw_run} or
 291  * {@link nnfw_run_async}, {@link nnfw_await} must be called to ensure the current asynchronous
 292  * inference has finished. Only one asynchronous inference is allowed at a time for a session.
 293  * If this function is called while the previous one is still running, it returns an error.</p>
 294  *
 295  * @param[in] session The session to run inference
 296  * @return    @c NNFW_STATUS_NO_ERROR if successful
 297  */
 298 NNFW_STATUS nnfw_run_async(nnfw_session *session);
 299
 300 /**
 301  * @brief     Wait for asynchronous run to finish
 302  *
 303  * <p>This function must be called after calling {@link nnfw_run_asnyc}, and can be called only once
 304  * for a {@link nnfw_run_async} call.
 305  *
 306  * <p>When this function returns, it means that this session has finished the asynchronous run. Then
 307  * the user can safely use the output data.</p>
 308  *
 309  * <p>This function returns after the asynchronous inference is finished.</p>
 310  *
 311  * @param[in] session The session to run inference
 312  * @return    @c NNFW_STATUS_NO_ERROR if successful
 313  */
 314 NNFW_STATUS nnfw_await(nnfw_session *session);
 315
 316 /**
 317  * @brief     Set input buffer
 318  *
 319  * This function must be called after {@link nnfw_prepare}, \p buffer given to this function can be
 320  * reused for many inferences. \p length must be greater or equal than the operand requires. To
 321  * specify an optional input, you can either not call this for that input or call this with \p
 322  * buffer of NULL and \p length of 0.
 323  *
 324  * @param[in] session Session to the input is to be set
 325  * @param[in] index   Index of input to be set (0-indexed)
 326  * @param[in] type    Type of the input
 327  * @param[in] buffer  Raw buffer for input
 328  * @param[in] length  Size of bytes of input buffer
 329  *
 330  * @return    @c NNFW_STATUS_NO_ERROR if successful
 331  */
 332 NNFW_STATUS nnfw_set_input(nnfw_session *session, uint32_t index, NNFW_TYPE type,
 333                            const void *buffer, size_t length);
 334
 335 /**
 336  * @brief       Set output buffer
 337  *
 338  * This function must be called after {@link nnfw_prepare}, \p buffer given to this function can be
 339  * reused for many inferences. \p length must be greater or equal than the operand requires. An
 340  * output operand can have unspecified shape and deduced dynamically during the execution. You must
 341  * provide \p buffer large enough.
 342  *
 343  * @param[in]   session Session from inference output is to be extracted
 344  * @param[in]   index   Index of output to be set (0-indexed)
 345  * @param[in]   type    Type of the output
 346  * @param[out]  buffer  Raw buffer for output
 347  * @param[in]   length  Size of bytes of output buffer
 348  *
 349  * @return      @c NNFW_STATUS_NO_ERROR if successful
 350  */
 351 NNFW_STATUS nnfw_set_output(nnfw_session *session, uint32_t index, NNFW_TYPE type, void *buffer,
 352                             size_t length);
 353
 354 /**
 355  * @brief       Get the number of inputs
 356  *
 357  * Application can call this function to get number of inputs defined in loaded model.
 358  * This function should be called after {@link nnfw_load_model_from_file} is invoked to load model
 359  *
 360  * @param[in]   session Session from input information is to be extracted
 361  * @param[out]  number  Variable which the number of inputs is put into
 362  *
 363  * @return      @c NNFW_STATUS_NO_ERROR if successful
 364  */
 365 NNFW_STATUS nnfw_input_size(nnfw_session *session, uint32_t *number);
 366
 367 /**
 368  * @brief       Get the number of outputs
 369  *
 370  * Application can call this function to get number of outputs defined in loaded model.
 371  * This function should be called after {@link nnfw_load_model_from_file} is invoked to load model
 372  *
 373  * @param[in]   session Session from output information is to be extracted
 374  * @param[out]  number  Variable which the number of outputs is put into
 375  *
 376  * @return      @c NNFW_STATUS_NO_ERROR if successful
 377  */
 378 NNFW_STATUS nnfw_output_size(nnfw_session *session, uint32_t *number);
 379
 380 /**
 381  * @brief Set the layout of an input
 382  *
 383  * The input that does not call this has NNFW_LAYOUT_NHWC layout
 384  *
 385  * @param[in] session session from inference input is to be extracted
 386  * @param[in] index   index of input to be set (0-indexed)
 387  * @param[in] layout  layout to set to target input
 388  *
 389  * @return NNFW_STATUS_NO_ERROR if successful
 390  */
 391 NNFW_STATUS nnfw_set_input_layout(nnfw_session *session, uint32_t index, NNFW_LAYOUT layout);
 392
 393 /**
 394  * @brief Set the layout of an output
 395  *
 396  * The output that does not call this has NNFW_LAYOUT_NHWC layout
 397  *
 398  * @param[in] session session from inference output is to be extracted
 399  * @param[in] index   index of output to be set (0-indexed)
 400  * @param[in] layout  layout to set to target output
 401  *
 402  * @return NNFW_STATUS_NO_ERROR if successful
 403  */
 404 NNFW_STATUS nnfw_set_output_layout(nnfw_session *session, uint32_t index, NNFW_LAYOUT layout);
 405
 406 /**
 407  * @brief       Get i-th input tensor info
 408  *
 409  * <p>Before {@link nnfw_prepare} is invoked, this function return tensor info in model,
 410  * so updated tensor info by {@link nnfw_apply_tensorinfo} is not returned.</p>
 411  *
 412  * <p>After {@link nnfw_prepare} is invoked, this function return updated tensor info
 413  * if tensor info is updated by {@link nnfw_apply_tensorinfo}.</p>
 414  *
 415  * @param[in]   session     Session from input information is to be extracted
 416  * @param[in]   index       Index of input
 417  * @param[out]  tensor_info Tensor info (shape, type, etc)
 418  *
 419  * @return      @c NNFW_STATUS_NO_ERROR if successful
 420  */
 421 NNFW_STATUS nnfw_input_tensorinfo(nnfw_session *session, uint32_t index,
 422                                   nnfw_tensorinfo *tensor_info);
 423
 424 /**
 425  * @brief     Get i-th output tensor info
 426  *
 427  * <p>After {@link nnfw_load_model_from_file} and before {@link nnfw_prepare} is invoked, it returns
 428  * tensor info in the model.</p>
 429  *
 430  * <p>After {@link nnfw_prepare} and before {@link nnfw_run} is invoked, this function returns
 431  * updated tensor info if tensor info is updated by {@link nnfw_set_input_tensorinfo}.</p>
 432  *
 433  * <p>After {@link nnfw_run} is invoked(at least once), it returns the updated tensor info during
 434  * the latest execution.</p>
 435  *
 436  * @param[in]   session     Session from output information is to be extracted
 437  * @param[in]   index       Index of output
 438  * @param[out]  tensor_info Tensor info (shape, type, etc)
 439  *
 440  * @return      @c NNFW_STATUS_NO_ERROR if successful
 441  */
 442 NNFW_STATUS nnfw_output_tensorinfo(nnfw_session *session, uint32_t index,
 443                                    nnfw_tensorinfo *tensor_info);
 444
 445 /**
 446  * @brief     Set available backends
 447  *
 448  * This function should be called before {@link nnfw_prepare} is invoked.
 449  *
 450  * <p>Supported backends differs on each platforms.
 451  * For example, `x86_64` supports "cpu" only.
 452  * Multiple backends can be set and they must be separated by a semicolon (ex: "acl_cl;cpu").
 453  * For each backend string, `libbackend_{backend}.so` will be dynamically loaded during
 454  * {@link nnfw_prepare}.
 455  * Among the multiple backends, the 1st element is used as the default backend.</p>
 456  *
 457  * @param[in] session session to which avilable backends are set
 458  * @param[in] backends available backends on which nnfw uses
 459  *
 460  * @return @c NNFW_STATUS_NO_ERROR if successful
 461  */
 462 NNFW_STATUS nnfw_set_available_backends(nnfw_session *session, const char *backends);
 463
 464 /**
 465  * @brief     Set the operation's backend
 466  *
 467  * This function should be called before {@link nnfw_prepare} is invoked.
 468  *
 469  * <p>The backend for op has higher priority than available backends specified by
 470  * {@link nnfw_set_available_backends}.</p>
 471  *
 472  * @deprecated Deprecated since 1.8.0.
 473  *
 474  * @param[in] session session to be modified
 475  * @param[in] op operation to be set
 476  * @param[in] backend bakcend on which operation run
 477  *
 478  * @return @c NNFW_STATUS_NO_ERROR if successful
 479  */
 480 NNFW_STATUS nnfw_set_op_backend(nnfw_session *session, const char *op, const char *backend);
 481
 482 /**
 483  * @brief     Retrieve uint32 type of nnfw information for given information ID.
 484  *
 485  * <p>Retrieves the information of property given by information id </p>
 486  *
 487  * @note: The input session could be null for global information (e.g. runtime version).*
 488  *
 489  * @param[in] session session to be queried on.
 490  * @param[in] information ID to be queried
 491  * @param[out] val uint32 value to be returned.
 492  *
 493  * @return @c NNFW_STATUS_NO_ERROR if successful
 494  */
 495 NNFW_STATUS nnfw_query_info_u32(nnfw_session *session, NNFW_INFO_ID id, uint32_t *val);
 496
 497 #ifdef __cplusplus
 498 }
 499 #endif
 500
 501 #endif