openmv/lib/stai/libstai/include/ai_platform_interface.h
iabdalkader e95a19c963 lib: Add STAI library and ML backend.
Signed-off-by: iabdalkader <i.abdalkader@gmail.com>
2025-06-10 11:53:31 +02:00

1145 lines
38 KiB
C

/**
******************************************************************************
* @file ai_platform_interface.h
* @author AST Embedded Analytics Research Platform
* @brief Definitions of AI platform interface APIs types
******************************************************************************
* @attention
*
* Copyright (c) 2018 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
*/
#ifndef AI_PLATFORM_INTERFACE_H
#define AI_PLATFORM_INTERFACE_H
#include "ai_platform.h"
#include "datatypes_network.h"
#include "ai_datatypes.h"
#include "ai_datatypes_defines.h"
#include "ai_datatypes_format.h"
#include "stai.h"
/*****************************************************************************/
#define AI_INTERFACE_TYPE /* AI_INTERFACE_TYPE */
/*****************************************************************************/
/*!
* @defgroup datatypes_interface Interface Datatypes
* @brief Data structures and defines used to implement neural networks
*/
#define AI_MAGIC_LEGACY_TOKEN (0xA1C00103)
#define AI_MAGIC_CONTEXT_TOKEN (0xA1C00100) /*!< Network Context Magic Token */
#define AI_MAGIC_INSPECTOR_TOKEN (0xB1C00100) /*!< Inspector Magic Token */
/*****************************************************************************/
#define AI_ERROR_TRAP(net_, type_, code_) \
ai_platform_network_set_error(AI_CONTEXT_OBJ(net_), AI_CONCAT(AI_ERROR_,type_), \
AI_CONCAT(AI_ERROR_CODE_,code_))
/*! AI_PTR HANDLERS SECTION ************************************/
#define AI_PTR(ptr_) AI_CAST(ai_ptr, ptr_)
#define AI_PTR_CONST(ptr_) AI_CAST(ai_ptr_const, ptr_)
/*! STATIC ARRAYS ALLOCATOR SECTION ************************************/
#define AI_PACK_STORAGE_ARRAY(type_, dim_, ...) \
(type_[dim_]) { AI_PACK(__VA_ARGS__) }
/*! AI_STORAGE_KLASS SECTION ************************************/
#define AI_STORAGE_KLASS_PACK(type_, dim_, ...) \
AI_PACK_STORAGE_ARRAY(type_, dim_, __VA_ARGS__)
#define AI_STORAGE_KLASS_INIT(type_, size_, data_) \
{ \
.type = (type_), \
.size = (size_), \
.data = (ai_handle)(data_), \
}
/*!
* @enum ai_storage_klass_type
* @ingroup ai_platform_interface
* @brief @ref ai_storage_class types enum
*/
typedef enum {
AI_STORAGE_KLASS_NONE = 0x00,
AI_STORAGE_KLASS_SHAPE = 0x01,
AI_STORAGE_KLASS_STRIDE = 0x02,
} ai_storage_klass_type;
/*!
* @struct ai_storage_klass
* @ingroup ai_platform_interface
* @brief Generic "Template" klass for generic storage arrays containers
* from this klass several typed containers are derived (see e.g. @ref ai_shape)
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED ai_storage_klass_s {
ai_u32 type : 8;
ai_u32 size : 24;
ai_handle data;
} ai_storage_klass;
AI_PACKED_STRUCT_END
/*! AI_SHAPES SECTION ************************************/
#define AI_SHAPE_MAX_DIMENSION (6)
#define AI_SHAPE_2D_INIT(w_, h_) \
{ .data = { (w_), (h_) } }
#define AI_SHAPE_INIT(dim_, ...) \
AI_STORAGE_KLASS_INIT( \
AI_STORAGE_KLASS_SHAPE, \
dim_, \
AI_STORAGE_KLASS_PACK(ai_shape_dimension, dim_, ## __VA_ARGS__))
#define AI_SHAPE_INIT_FROM_BUFFER(dim_, buffer_) \
AI_STORAGE_KLASS_INIT( \
AI_STORAGE_KLASS_SHAPE, \
dim_, \
buffer_)
#define AI_SHAPE_ALLOCATE_STATIC(num_dim_) \
AI_SHAPE_INIT((num_dim_), 0)
typedef ai_u8 ai_shape_idx;
/*!
* @struct ai_shape
* @ingroup ai_platform_interface
* @brief Dimensions for generic 4D tensors
*/
typedef ai_storage_klass ai_shape;
/*! AI_STRIDES HANDLERS SECTION ************************************/
#define AI_STRIDE_INIT(dim_, ...) \
AI_STORAGE_KLASS_INIT( \
AI_STORAGE_KLASS_STRIDE, \
dim_, \
AI_STORAGE_KLASS_PACK(ai_stride_dimension, dim_, ## __VA_ARGS__))
#define AI_STRIDE_INIT_FROM_BUFFER(dim_, buffer_) \
AI_STORAGE_KLASS_INIT( \
AI_STORAGE_KLASS_STRIDE, \
dim_, \
buffer_)
#define AI_STRIDE_ALLOCATE_STATIC(num_dims_) \
AI_STRIDE_INIT((num_dims_), 0)
/*!
* @struct ai_stride
* @ingroup ai_platform_interface
* @brief Stride dimensions for generic 4D tensors (in number of elements)
*/
typedef ai_storage_klass ai_stride;
/*! BASIC_TYPES HANDLERS SECTION ************************************/
#define AI_SIZE(value_) \
AI_CAST(ai_size, value_)
/*! AI_KLASS_OBJ HANDLERS SECTION ************************************/
#define AI_KLASS_OBJ(obj_) \
AI_CAST(ai_klass_obj, obj_)
/*! GENERIC HANDLERS SECTION ************************************/
#define AI_OBJ_DATA(obj_, type_) \
AI_CAST(type_, (obj_)->data)
/*! AI_BUFFER HANDLERS SECTION ************************************/
#define AI_BUFFER_OBJ(ptr_) \
AI_CAST(ai_buffer*, ptr_)
/*! AI_ARRAY HANDLERS SECTION ************************************/
#define AI_ARRAY_OBJ(ptr_) \
AI_CAST(ai_array*, ptr_)
#define AI_ARRAY_OBJ_INIT_STATIC(type_, format_, size_, ...) { \
.format = AI_FMT_OBJ(format_), \
.size = (ai_array_size)(size_), \
.data = (ai_ptr)((type_[]){ __VA_ARGS__ }), \
.data_start = AI_PTR(0), \
}
#define AI_ARRAY_OBJ_INIT(format_, data_, data_start_, size_) { \
.format = AI_FMT_OBJ(format_), \
.size = AI_CAST(ai_array_size, size_), \
.data = AI_PTR(data_), \
.data_start = AI_PTR(data_start_) }
#define AI_ARRAY_OBJ_DECLARE_STATIC(name_, type_, format_, attr_, size_, ...) \
AI_ALIGNED(4) \
attr_ ai_array name_ = AI_ARRAY_OBJ_INIT_STATIC(type_, format_, size_, __VA_ARGS__);
#define AI_ARRAY_OBJ_DECLARE(name_, format_, data_, data_start_, size_, attr_) \
AI_ALIGNED(4) \
attr_ ai_array name_ = AI_ARRAY_OBJ_INIT(format_, data_, data_start_, size_);
/********************************* ai_array macros ***************************/
#define AI_PACK_ARRAYS(...) \
(ai_array[]) { AI_PACK(__VA_ARGS__) }
#define AI_ARRAY_LIST_OBJ_INIT(arrays_ptr_) \
((ai_array*)(arrays_ptr_))
#define AI_ARRAY_LIST_FLAGS(list_) \
((list_) ? (list_)->flags : 0x0)
#define AI_ARRAY_LIST_SIZE(list_) \
((list_) ? (list_)->size : 0)
#define AI_ARRAY_LIST_DATA(list_, pos_) \
((list_) ? &((list_)->data[pos_]) : NULL)
/********************************* ai_tensor macros **************************/
#define AI_TENSOR_OBJ(obj_) \
AI_CAST(ai_tensor*, obj_)
#define AI_TENSOR_INFO_OBJ_INIT(id_, flags_, data_size_) { \
.id = (id_), \
.flags = (flags_), \
.data_size = (data_size_) \
}
#define AI_TENSOR_OBJ_INIT(id_, flags_, shape_, stride_, arrays_size_, arrays_ptr_, klass_obj_) { \
.klass = (ai_klass_obj)(klass_obj_), \
.info = AI_TENSOR_INFO_OBJ_INIT(id_, flags_, arrays_size_), \
.shape = shape_, \
.stride = stride_, \
.data = AI_ARRAY_LIST_OBJ_INIT(AI_PACK(arrays_ptr_)), \
}
#define AI_TENSOR_OBJ_DECLARE(name_, attr_, id_, flags_, shape_, stride_, \
arrays_size_, arrays_ptr_, klass_obj_) \
AI_ALIGNED(4) \
attr_ ai_tensor name_ = AI_TENSOR_OBJ_INIT(id_, flags_, AI_PACK(shape_), AI_PACK(stride_), \
arrays_size_, AI_PACK(arrays_ptr_), AI_PACK(klass_obj_));
/********************************* TENSOR STATE MACROS ***********************/
#define AI_TENSOR_STATE_OBJ_INIT(end_ptr_ , curr_ptr_, stride_, size_) \
{ (end_ptr_), (curr_ptr_), (stride_), (size_) }
/********************************* TENSOR LIST MACROS ************************/
#if (AI_TOOLS_API_VERSION <= AI_TOOLS_API_VERSION_1_3)
#pragma message ("Including deprecated AI_TENSOR_LIST_ENTRY, AI_TENSOR_LIST_EMPTY, AI_TENSOR_LIST_IO_ENTRY")
AI_DEPRECATED
#define AI_TENSOR_LIST_EMPTY \
AI_TENSOR_LIST_OBJ_EMPTY
AI_DEPRECATED
#define AI_TENSOR_LIST_ENTRY(...) \
AI_TENSOR_LIST_OBJ_INIT(AI_FLAG_NONE, AI_NUMARGS(__VA_ARGS__), __VA_ARGS__)
AI_DEPRECATED
#define AI_TENSOR_LIST_IO_ENTRY(flags_, size_, ...) \
AI_TENSOR_LIST_IO_OBJ_INIT(flags_, size_, __VA_ARGS__)
#endif /* AI_TOOLS_API_VERSION_1_3 */
#define AI_TENSOR_LIST_OBJ_INIT(flags_, size_, ...) \
{ .size = (size_), .flags = (flags_), \
.tensor = (ai_tensor*[]) { __VA_ARGS__ }, .info = NULL \
}
#define AI_TENSOR_LIST_OBJ_EMPTY \
{ .size = 0, .flags = AI_FLAG_NONE, \
.tensor = (ai_tensor*[]) { NULL }, .info = NULL \
}
#define AI_TENSOR_LIST_OBJ_DECLARE(name_, attr_, flags_, size_, ...) \
AI_ALIGNED(4) \
attr_ ai_tensor_list name_ = AI_TENSOR_LIST_OBJ_INIT( \
flags_, size_, __VA_ARGS__);
/********************************* TENSOR LIST I/O MACROS ********************/
#define AI_TENSOR_LIST_IO_OBJ_INIT(flags_, size_, ...) \
{ .size = (size_), .flags = (flags_), \
.tensor = (ai_tensor*[]) { __VA_ARGS__ }, \
.info = (ai_tensor_list_info[1]) { { \
.buffer = (ai_buffer[size_]){AI_STRUCT_INIT}, \
.state = (ai_tensor_state[size_]){AI_STRUCT_INIT}, \
.meta = (ai_buffer_meta_info[size_]){AI_STRUCT_INIT} \
} } \
}
/********************************* TENSOR CHAIN MACROS ***********************/
#define AI_TENSOR_CHAIN_OBJ_INIT(flags_, size_, ...) \
{ .size = (size_), .flags = (flags_), \
.chain = (ai_tensor_list[]){ __VA_ARGS__ } }
#define AI_TENSOR_CHAIN_OBJ_DECLARE(name_, attr_, size_, ...) \
AI_ALIGNED(4) \
attr_ ai_tensor_chain name_ = \
AI_TENSOR_CHAIN_OBJ_INIT(AI_FLAG_NONE, size_, __VA_ARGS__);
/********************************* TENSOR CHAIN I/O MACROS *******************/
#define AI_TENSOR_CHAIN_IO_OBJ_INIT(flags_, in_tensor_list_, out_tensor_list_) \
{ .chain = (ai_tensor_list[]){ in_tensor_list_, out_tensor_list_ }, \
.size = 2, .flags = (flags_) }
#define AI_TENSOR_CHAIN_IO_OBJ_DECLARE( \
name_, attr_, flags_, in_tensor_list_, out_tensor_list_) \
AI_ALIGNED(4) \
attr_ ai_tensor_chain_io name_ = \
AI_TENSOR_CHAIN_IO_OBJ_INIT(flags_, in_tensor_list_, out_tensor_list_);
/******************************* NETWORK SECTION ****************************/
#define AI_NETWORK_OBJ(obj_) \
((ai_network*)(obj_))
#if (AI_TOOLS_API_VERSION < AI_TOOLS_API_VERSION_1_5)
AI_DEPRECATED
#define AI_NETWORK_OBJ_INIT( \
weights_buffer_, activations_buffer_, \
in_tensor_list_ptr_, out_tensor_list_ptr_, \
in_node_ptr_, signature_, klass_obj_) { \
.magic = AI_MAGIC_CONTEXT_TOKEN, \
.signature = signature_, \
.tool_api_version = 0x0, \
.error = AI_ERROR_INIT(NONE, NONE), \
.flags = AI_FLAG_NONE, \
.klass = AI_KLASS_OBJ(klass_obj_), \
.n_batches = 0, \
.batch_id = 0, \
.buffers = AI_NETWORK_BUFFERS_INIT( \
AI_BUFFER_ARRAY_OBJ_INIT_STATIC(AI_FLAG_NONE, 1, AI_PACK(weights_buffer_)), \
AI_BUFFER_ARRAY_OBJ_INIT_STATIC(AI_FLAG_NONE, 1, AI_PACK(activations_buffer_))), \
.tensors = AI_TENSOR_CHAIN_IO_OBJ_INIT(AI_FLAG_NONE, \
AI_PACK(in_tensor_list_ptr_), \
AI_PACK(out_tensor_list_ptr_)), \
.input_node = AI_NODE_OBJ(in_node_ptr_), \
.current_node = AI_NODE_OBJ(NULL), \
.on_node_exec = NULL, \
.data_exec = NULL, \
.lite_cb = NULL, \
}
#else
#define AI_NETWORK_OBJ_INIT( \
weights_buffer_, activations_buffer_, \
in_tensor_list_ptr_, out_tensor_list_ptr_, \
in_node_ptr_, signature_, klass_obj_) { \
.magic = AI_MAGIC_CONTEXT_TOKEN, \
.signature = signature_, \
.tool_api_version = 0x0, \
.error = AI_ERROR_INIT(NONE, NONE), \
.klass = AI_KLASS_OBJ(klass_obj_), \
.flags = AI_FLAG_NONE, \
.n_batches = 0, \
.batch_id = 0, \
.buffers = AI_NETWORK_BUFFERS_INIT(AI_PACK(weights_buffer_), \
AI_PACK(activations_buffer_)), \
.tensors = AI_TENSOR_CHAIN_IO_OBJ_INIT(AI_FLAG_NONE, \
AI_PACK(in_tensor_list_ptr_), \
AI_PACK(out_tensor_list_ptr_)), \
.input_node = AI_NODE_OBJ(in_node_ptr_), \
.current_node = AI_NODE_OBJ(NULL), \
.on_node_exec = NULL, \
.data_exec = NULL, \
.lite_cb = NULL, \
}
#endif // AI_TOOLS_API_VERSION
#define AI_NETWORK_OBJ_DECLARE( \
name_, attr_, \
weights_buffer_, activations_buffer_, \
in_tensor_list_ptr_, out_tensor_list_ptr_, \
in_node_ptr_, signature_, klass_obj_) \
AI_ALIGNED(4) \
attr_ ai_network name_ = AI_NETWORK_OBJ_INIT( \
AI_PACK(weights_buffer_), \
AI_PACK(activations_buffer_), \
AI_PACK(in_tensor_list_ptr_), \
AI_PACK(out_tensor_list_ptr_), \
(in_node_ptr_), (signature_), (klass_obj_));
#define AI_NETWORK_ACQUIRE_CTX(handle_) \
AI_NETWORK_OBJ(ai_platform_context_acquire(handle_))
/******************************************************************************/
AI_API_DECLARE_BEGIN
/*!
* @typedef ai_version
* @ingroup ai_platform_interface
* @brief Packed representation for @ref ai_platform_version
*/
typedef uint32_t ai_version;
/*!
* @typedef ai_klass_obj
* @ingroup ai_platform_interface
* @brief handler to (private) generic subclass derivatives implementation
*/
typedef void* ai_klass_obj;
/*!
* @typedef ai_ptr
* @ingroup ai_platform_interface
* @brief Byte pointer data addressing
*/
typedef uint8_t* ai_ptr;
/*!
* @typedef ai_ptr_const
* @ingroup ai_platform_interface
* @brief Constant byte pointer data addressing
*/
typedef const uint8_t* ai_ptr_const;
/*!
* @typedef ai_ptr_offset
* @ingroup ai_platform_interface
* @brief byte offset for computing strides
*/
typedef int32_t ai_ptr_offset;
/*!
* @typedef ai_magic
* @ingroup ai_platform_interface
* @brief magic field to mark internal datatstructures
*/
typedef uint32_t ai_magic;
/*!
* @typedef ai_complex_f64
* @ingroup ai_platform_interface
* @brief Definition of float complex number (i.e. two 32bits numbers)
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED {
ai_float real;
ai_float imag;
} ai_complex_f64;
AI_PACKED_STRUCT_END
/*!
* @typedef ai_complex_s64
* @ingroup ai_platform_interface
* @brief Definition of signed integer complex number (i.e. two 32bits numbers)
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED {
ai_i32 real;
ai_i32 imag;
} ai_complex_s64;
AI_PACKED_STRUCT_END
/*!
* @typedef ai_complex_s32
* @ingroup ai_platform_interface
* @brief Definition of signed integer complex number (i.e. two 16bits numbers)
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED {
ai_i16 real;
ai_i16 imag;
} ai_complex_s32;
AI_PACKED_STRUCT_END
/*!
* @typedef ai_complex_s16
* @ingroup ai_platform_interface
* @brief Definition of signed integer complex number (i.e. two 8bits numbers)
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED {
ai_i8 real;
ai_i8 imag;
} ai_complex_s16;
AI_PACKED_STRUCT_END
/*!
* @typedef ai_any_ptr
* @ingroup ai_platform_interface
* @brief union for defining any pointer
*/
typedef union {
ai_handle handle;
ai_ptr ptr;
ai_float* float32;
ai_double* float64;
ai_u8* u8;
ai_i8* s8;
ai_u16* u16;
ai_i16* s16;
ai_u32* u32;
ai_i32* s32;
ai_u64* u64;
ai_i64* s64;
ai_complex_s16* complexs16;
ai_complex_s32* complexs32;
ai_complex_s64* complexs64;
ai_complex_f64* complexfloat64;
} ai_any_ptr;
#define AI_ANY_PTR_INIT(ptr_) \
{ .handle = (ai_handle)(ptr_) }
#define AI_CONTEXT_FIELDS \
ai_magic magic; /*!< magic word to mark valid contexts datastructs*/ \
ai_signature signature; /*!< 32bit signature for network consistency checks */ \
ai_version tool_api_version; /*! Tools Codegen API version */ \
ai_error error; /*!< track 1st error code in the network */ \
ai_flags flags; /*!< bitflags mask to track some network state info */
#define AI_CONTEXT_OBJ(obj) ((ai_context*)(obj))
/*!
* @typedef ai_context
* @ingroup ai_platform_interface
* @brief Abstract internal context header exposed to codegen interface
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED {
AI_CONTEXT_FIELDS
} ai_context;
AI_PACKED_STRUCT_END
/*!
* @enum ai_shape_2d_type
* @ingroup ai_platform_interface
* @brief Codes for the 2D tensor dimensions
*/
typedef enum {
AI_SHAPE_2D_MAX_DIMENSION = 0x2,
AI_SHAPE_2D_HEIGHT = 0x1,
AI_SHAPE_2D_WIDTH = 0x0,
} ai_shape_2d_type;
/*!
* @struct ai_shape_2d
* @ingroup ai_platform_interface
* @brief Dimensions for generic 2D tensors
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED ai_shape_2d_s {
ai_shape_dimension data[AI_SHAPE_2D_MAX_DIMENSION]; /*!< 2D tensor dimensions */
} ai_shape_2d;
AI_PACKED_STRUCT_END
/*!
* @struct ai_array
* @ingroup ai_platform_interface
* @brief Generic flattened array with size
* and (byte) stride of each item
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED ai_array_s {
ai_array_format format; /*!< array format (see @ref ai_array_format) */
ai_array_size size; /*!< number of elements in the array (NOT number
of bytes!). The size of the array could be
determine using @ref AI_ARRAY_GET_BYTE_SIZE
macro */
ai_ptr data; /*!< pointer to data */
ai_ptr data_start; /*!< pointer to parent's data start address */
} ai_array;
AI_PACKED_STRUCT_END
/*!
* @struct ai_tensor_info
* @ingroup ai_platform_interface
* @brief ai_tensor_info info structure for storing size of the array list,
* tensor dimensionality, etc.
*
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED ai_tensor_info_s {
ai_u16 id;
ai_u8 flags;
ai_u8 data_size;
} ai_tensor_info;
AI_PACKED_STRUCT_END
/*!
* @struct ai_tensor
* @ingroup ai_platform_interface
* @brief Generic tensor structure for storing parameters and activations
*
* The data is stored in a flattened array with an implicit order given by the
* reverse order in @ref ai_shape_dimension:
* in_channels, channels, width, height.
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED ai_tensor_s {
ai_klass_obj klass; /*!< opaque pointer to klass context */
ai_tensor_info info; /*!< tensor info metadata see @ref ai_tensor_info)*/
ai_shape shape; /*!< tensor shape see @ref ai_shape */
ai_stride stride; /*!< tensor stride see @ref ai_stride */
ai_array* data; /*!< flattened array pointer to tensor data */
} ai_tensor;
AI_PACKED_STRUCT_END
/*!
* @struct ai_tensor_state
* @ingroup ai_platform_interface
* @brief state context for tensor management (used for I/O network tensors)
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED ai_tensor_state_s {
ai_ptr end_ptr; /*!< end address of the I/O tensor data buffer */
ai_ptr curr_ptr; /*!< current address of the I/O tensor data buffer (for batching) */
ai_ptr_offset stride; /*!< single batch buffer size (in bytes) */
ai_size size; /*!< total size in bytes of the I/O tensor buffer */
} ai_tensor_state;
AI_PACKED_STRUCT_END
/*!
* @struct ai_tensor_list_info
* @ingroup ai_platform_interface
* @brief info metadata for tensor list management (used for I/O network tensors)
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED ai_tensor_list_info_s {
ai_tensor_state* state; /*!< I/O buffer internal pointers state */
ai_buffer* buffer; /*!< I/O buffer pointer */
ai_buffer_meta_info* meta; /*!< I/O buffer meta informations */
} ai_tensor_list_info;
AI_PACKED_STRUCT_END
/********************************* INTEGER QUANTIZATION DATATYPES ************/
#define AI_INTQ_INFO_OBJ_INIT(flags_, scale_ , zeropoint_) { \
.scale = (scale_), \
.zeropoint = (ai_handle)(zeropoint_), \
.flags = (flags_), \
}
#define AI_PACK_INTQ_INFO_LIST(...) \
(ai_intq_info_list[]) { AI_PACK(__VA_ARGS__) }
#define AI_PACK_INTQ_INFO(scale_, zp_) \
(INTQ_CONST ai_intq_info[1]) { { \
.scale = (INTQ_CONST ai_float*) AI_PACK(scale_), \
.zeropoint = (ai_handle) AI_PACK(zp_) \
} }
#define AI_PACK_INTQ_SCALE(...) \
(INTQ_CONST ai_float[]) { AI_PACK(__VA_ARGS__) }
#define AI_PACK_INTQ_ZP(...) \
(INTQ_CONST ai_i8[]) { AI_PACK(__VA_ARGS__) }
#define AI_PACK_UINTQ_ZP(...) \
(INTQ_CONST ai_u8[]) { AI_PACK(__VA_ARGS__) }
#define AI_PACK_INTQ_ZP16(...) \
(INTQ_CONST ai_i16[]) { AI_PACK(__VA_ARGS__) }
#define AI_PACK_UINTQ_ZP16(...) \
(INTQ_CONST ai_u16[]) { AI_PACK(__VA_ARGS__) }
#define AI_INTQ_INFO_LIST_OBJ_INIT(flags_, size_, info_) \
{ \
.flags = (flags_), \
.size = (size_), \
.info = (info_), \
}
#define AI_INTQ_INFO_LIST_OBJ_EMPTY { 0 }
#define AI_INTQ_INFO_LIST_OBJ_DECLARE(name_, attr_, flags_, size_, info_) \
AI_ALIGNED(4) \
attr_ ai_intq_info_list name_ = \
AI_INTQ_INFO_LIST_OBJ_INIT(flags_, size_, AI_PACK(info_));
#define AI_INTQ_INFO_LIST_OBJ_DECLARE_EMPTY(name_, attr_) \
AI_ALIGNED(4) \
attr_ ai_intq_info_list name_ = AI_INTQ_INFO_LIST_OBJ_EMPTY;
/********************************* TENSOR CHAINS DATATYPES *******************/
/*!
* @enum ai_tensor_chain_type
* @ingroup ai_platform_interface
* @brief Enum for the different tensor chains supported in the library
*/
typedef enum {
AI_TENSOR_CHAIN_INPUT = 0x0,
AI_TENSOR_CHAIN_OUTPUT = 0x1,
AI_TENSOR_CHAIN_WEIGHTS = 0x2,
AI_TENSOR_CHAIN_SCRATCH = 0x3,
AI_TENSOR_CHAIN_SIZE
} ai_tensor_chain_type;
/*!
* @struct ai_tensor_list
* @ingroup ai_platform_interface
* @brief list (in form of arrays) of internal nodes tensor pointers
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED ai_tensor_list_s {
ai_u16 size; /*!< number of elements in the the tensor list */
ai_u16 flags; /*!< optional flags to store tensor list attributes */
ai_tensor** tensor; /*!< array of linked tensor pointer */
ai_tensor_list_info* info; /*!< pointer to an array of metainfo associated to the tensors */
} ai_tensor_list;
AI_PACKED_STRUCT_END
/*!
* @struct ai_tensor_chain
* @ingroup ai_platform_interface
* @brief tensor chain datastruct for internal network nodes
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED ai_tensor_chain_s {
ai_u16 size;
ai_u16 flags;
ai_tensor_list* chain; /*!< pointer to a 4 sized array see @ref ai_tensor_chain_type */
} ai_tensor_chain;
AI_PACKED_STRUCT_END
/************************************** LAYER DATATYPES *******************/
/*!
* @struct ai_layer
* @ingroup ai_platform_interface
* @brief Structure encoding a generic opaque layer in the network
*
*/
typedef void ai_layer;
/************************************** OBSERVER DATATYPES *******************/
/* forward function */
struct ai_node_s;
/*!
* @struct ai_observer_node
* @ingroup ai_observer_interface
* @brief observer node data struct for internal network nodes
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED ai_observer_node_s {
ai_u16 c_idx; /*!< node index (position in the execution list) */
ai_u16 type; /*!< node type info @see ai_node datastruct */
ai_u16 id; /*!< node id assigned by codegen tool to identify the model layer*/
ai_u16 unused; /*!< unused field for alignment */
const ai_tensor_chain* inner_tensors; /*!< pointer to the inner tensor if available */
const ai_tensor_chain* tensors; /*!< pointer to a 4 sized array see @ref ai_tensor_chain_type */
} ai_observer_node;
AI_PACKED_STRUCT_END
#define AI_OBSERVER_NONE_EVT (0) /*!< No event */
#define AI_OBSERVER_INIT_EVT (1 << 0) /*!< called at the end of the init function */
#define AI_OBSERVER_PRE_EVT (1 << 1) /*!< before c-node execution */
#define AI_OBSERVER_POST_EVT (1 << 2) /*!< after c-node execution */
#define AI_OBSERVER_FIRST_EVT (1 << 8) /*!< indicate the first c-node */
#define AI_OBSERVER_LAST_EVT (1 << 9) /*!< indicate the last c-node */
#define AI_OBSERVER_REGISTERED (1 << 24) /*!< internal flag */
#define AI_OBSERVER_MASK_EVT (0xFF) /*!< mask for requested user event */
/* Client callback definition */
typedef ai_u32 (*ai_observer_node_cb)(
const ai_handle cookie,
const ai_u32 flags,
const ai_observer_node *node);
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED ai_observer_exec_ctx_s {
ai_observer_node_cb on_node; /*!< registered user observer call-back function */
ai_handle cookie; /*!< reference of the user context */
ai_u32 flags; /*!< flags definition */
ai_u16 c_idx; /*!< store/indicate the index of the current c_node */
ai_u16 n_nodes; /*!< total number of c_node */
struct ai_node_s *cur; /*!< pointer of the current node (pre or post) */
} ai_observer_exec_ctx;
AI_PACKED_STRUCT_END
typedef enum {
AI_NODE_EXEC_INIT = 0x0,
AI_NODE_EXEC_START = 0x1,
AI_NODE_EXEC_PRE = 0x2,
AI_NODE_EXEC_POST = 0x3,
} ai_node_exec_state;
/* Internal/private definition of node execution callback */
typedef ai_u32 (*ai_node_exec_cb)(
const ai_node_exec_state state,
struct ai_node_s *cur,
const ai_handle ctx);
/********************************* NETWORK DATATYPES *************************/
/*!
* @struct ai_network
* @ingroup layers
* @brief Structure encoding a sequential neural network
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED {
AI_CONTEXT_FIELDS
ai_klass_obj klass; /*!< opaque handler to specific network implementations */
ai_u16 n_batches; /*!< number of batches to process */
ai_u16 batch_id; /*!< current batch to to process btw [0, n_batches)*/
// New 6.1 context storing explicitly network buffers. This allow also management of network persistent state now
ai_network_buffers buffers; /*!< network buffers datastruct */
ai_tensor_chain tensors; /*!< I/O tensor chain list see @ref ai_tensor_list */
struct ai_node_s* input_node; /*!< first node to execute */
struct ai_node_s* current_node; /*!< current node to execute */
ai_node_exec_cb on_node_exec; /*!< registered call-back function called when
a node/operator is scheduled */
ai_handle data_exec; /*!< private reference for the runtime context */
ai_handle lite_cb; /*!< registered opaque call-back handler for lite APIs */
} ai_network;
AI_PACKED_STRUCT_END
/*!
* @struct ai_network
* @ingroup layers
* @brief Structure encoding a sequential neural network
*/
AI_PACKED_STRUCT_START
typedef AI_ALIGNED_TYPE(struct, 4) AI_PACKED {
AI_CONTEXT_FIELDS
// ai_klass_obj klass; /*!< opaque handler to specific network implementations */
// ai_u16 n_batches; /*!< number of batches to process */
// ai_u16 batch_id; /*!< current batch to to process btw [0, n_batches)*/
ai_buffer* _inputs;
ai_buffer* _outputs;
ai_buffer_array _map_weights;
ai_buffer_array _map_activations;
ai_u64* _ctx;
} ai_network_context;
AI_PACKED_STRUCT_END
/*!
* @brief Get platform runtime lib revision version as string.
* @ingroup ai_platform_interface
* @return a string containing the revision of the runtime library
*/
AI_INTERFACE_TYPE
const char* ai_platform_runtime_get_revision(void);
/*!
* @brief Get platform runtime lib version as datastruct.
* @ingroup ai_platform_interface
* @return a datastruct containing the version of the runtime library
*/
AI_INTERFACE_TYPE
ai_platform_version ai_platform_runtime_get_version(void);
/*!
* @brief Get platform public APIs version as datastruct.
* @ingroup ai_platform_interface
* @return a datastruct containing the version of the public APIs
*/
AI_INTERFACE_TYPE
ai_platform_version ai_platform_api_get_version(void);
/*!
* @brief Get platform interface private APIs version as datastruct.
* @ingroup ai_platform_interface
* @return a datastruct containing the version of the interface private APIs
*/
AI_INTERFACE_TYPE
ai_platform_version ai_platform_interface_api_get_version(void);
/****************************************************************************
** Context APIs
****************************************************************************/
/*!
* @brief Get platform context.
* @ingroup ai_platform_interface
* @return a valid context handle or NULL otherwise
*/
AI_INTERFACE_TYPE
ai_context* ai_platform_context_acquire(const ai_handle handle);
/*!
* @brief Release platform context.
* @ingroup ai_platform_interface
* @return an opaque handle to the released object
*/
AI_INTERFACE_TYPE
ai_handle ai_platform_context_release(ai_context* ctx);
/****************************************************************************
** Platform Network Params APIs
****************************************************************************/
/*!
* @brief get the weights map from user provided network params info
* @ingroup ai_platform_interface
* @param params a pointer to ai_network_params struct
* @param map table pointer to the table map to initialize
* @param map_size the number of entries of the table to initialize
* @return true if initialization succeeded, false otherwise
*/
AI_INTERFACE_TYPE
ai_bool ai_platform_get_weights_map(
ai_ptr* map, const ai_size map_size, const ai_network_params* params);
/*!
* @brief get the activations map from user provided network params info
* @ingroup ai_platform_interface
* @param params a pointer to ai_network_params struct
* @param map table pointer to the table map to initialize
* @param map_size the number of entries of the table to initialize
* @return true if initialization succeeded, false otherwise
*/
AI_INTERFACE_TYPE
ai_bool ai_platform_get_activations_map(
ai_ptr* map, const ai_size map_size, const ai_network_params* params);
/*!
* @brief bind code generated weights and activations map arrays to ai_netwoek_params
* @ingroup ai_platform_interface
* @param[out] params the network params struct reporting binded params
* @param[in] map_weights pointer to the codegened weights map array to be bound
* @param[in] map_activations pointer to the codegened activation map array to be bound
* @return true if network parameters binding succeed, false otherwise
*/
AI_INTERFACE_TYPE
ai_bool ai_platform_bind_network_params(
ai_network_params* params,
const ai_buffer_array* map_weights, const ai_buffer_array* map_activations);
/****************************************************************************
** Platform Network APIs
****************************************************************************/
/*!
* @brief get **first** error tracked when using the network
* @ingroup ai_platform_interface
* @param network an opaque handler to the network context
* @return ai_error the FIRST error generated during network processing
*/
AI_INTERFACE_TYPE
ai_error ai_platform_network_get_error(ai_handle network);
/*!
* @brief Set specific error code of the network. if an error is already present
* keep it
* @ingroup ai_platform_interface
* @param net_ctx a pointer to the network context
* @param type error type as defined in @ref ai_error_type
* @param code error code as defined in @ref ai_error_code
* @return true if no previous errors where recorded, false if a previous error
* is present or context is invalid
*/
AI_INTERFACE_TYPE
ai_bool ai_platform_network_set_error(
ai_context* net_ctx, const ai_error_type type, const ai_error_code code);
/*!
* @brief Finalize network report datastruct with I/O buffer infos
* @ingroup ai_platform_interface
* @return bool if the report has been finalized correctly. false otherwise
*/
AI_INTERFACE_TYPE
ai_bool ai_platform_api_get_network_report(
ai_handle network, ai_network_report* r);
/*!
* @brief Get network inputs array pointer as a ai_buffer array pointer.
* @ingroup network
* @param network an opaque handler to the network context
* @param n_buffer optional parameter to return the number of inputs
* @return a ai_buffer pointer to the inputs arrays
*/
AI_INTERFACE_TYPE
ai_buffer* ai_platform_inputs_get(ai_handle network, ai_u16 *n_buffer);
/*!
* @brief Get network outputs array pointer as a ai_buffer array pointer.
* @ingroup network
* @param network an opaque handler to the network context
* @param n_buffer optional parameter to return the number of outputs
* @return a ai_buffer pointer to the inputs arrays
*/
AI_INTERFACE_TYPE
ai_buffer* ai_platform_outputs_get(ai_handle network, ai_u16 *n_buffer);
/*!
* @brief create a network context with some error check
* @ingroup ai_platform_interface
* @param a pointer to an opaque handle of the network context
* @param an (optional) pointer to the network config buffer info
* @param net_ctx a pointer to the network context structure to initialize
* @param tool_major major version id of the tool used to generate the network
* @param tool_minor minor version id of the tool used to generate the network
* @param tool_micro micro version id of the tool used to generate the network
* @return the error during network creation or error none if ok
*/
AI_INTERFACE_TYPE
ai_error ai_platform_network_create(
ai_handle* network, const ai_buffer* network_config,
ai_context* net_ctx,
const ai_u8 tool_major, const ai_u8 tool_minor, const ai_u8 tool_micro);
/*!
* @brief destroy a network context
* @ingroup ai_platform_interface
* @param network a pointer to an opaque handle of the network context
* @return AI_HANDLE_NULL if deallocation OK, same network handle if failed
*/
AI_INTERFACE_TYPE
ai_handle ai_platform_network_destroy(ai_handle network);
/*!
* @brief initialize the network context
* @ingroup ai_platform_interface
* @param network a pointer to an opaque handle of the network context
* @return a valid network context, NULL if initialization failed
*/
AI_INTERFACE_TYPE
ai_context* ai_platform_network_init(
ai_handle network, const ai_network_params* params);
/*!
* @brief post-initialize of the network context.
* @ingroup ai_platform_interface
* @param network a pointer to an opaque handle of the network context
* @return a valid network context, NULL if initialization failed
*/
AI_INTERFACE_TYPE
ai_bool ai_platform_network_post_init(ai_handle network);
/*!
* @brief main platform runtime execute of a network
* @ingroup ai_platform_interface
* @param network an opaque handler to the network context
* @param input a pointer to the input buffer data to process
* @param output a pointer to the output buffer
* @return the number of batches processed from the input. A result <=0 in case
* of error
*/
AI_INTERFACE_TYPE
ai_i32 ai_platform_network_process(
ai_handle network, const ai_buffer* input, ai_buffer* output);
/****************************************************************************
** ST.AI Wrapper APIs
****************************************************************************/
AI_INTERFACE_TYPE
void ai_platform_stai_handle_error(
ai_error* dst_error,
const stai_return_code code);
AI_INTERFACE_TYPE
ai_buffer* ai_platform_stai_bind_io(
ai_u16* n_buffer,
ai_buffer* dst_io_buffers,
const stai_ptr* src_io_buffers,
const stai_size src_io_buffers_size);
AI_INTERFACE_TYPE
ai_bool ai_platform_stai_update_io(
ai_i32* batch_id,
stai_ptr* dst_inputs, stai_ptr* dst_outputs,
const ai_buffer* src_inputs, const ai_buffer* src_outputs,
const ai_size n_inputs, const ai_size n_outputs);
/****************************************************************************
** Observer APIs
****************************************************************************/
/*!
* @brief Return the info of a requested c-node (defined by the
* c_idx field). Should be called after the initialization phase.
* @ingroup ai_platform_observer
* @param network a pointer to an opaque handle of the network context
* @param node_info a pointer to a reference of the node description
* @return true if the node_info->c_idx designates a valid index else
* false (network error is updated).
*/
AI_INTERFACE_TYPE
ai_bool ai_platform_observer_node_info(
ai_handle network, ai_observer_node *node_info);
/*!
* @brief Register an observer context. Allows to register a client CB which
* will be called before or/and after the execution of a c-node with
* the references of the used tensors (see @ref ai_observer_node).
* @ingroup ai_platform_observer
* @param network a pointer to an opaque handle of the network context
* @param cb reference of the user callback function
* @param cookie reference of a user object/ctx
* @param flags indicate expected events (see AI_OBSERVER_XX_EVT flag definition)
* @return false if the registration has failed (network error is updated) else true
* of error.
*/
AI_INTERFACE_TYPE
ai_bool ai_platform_observer_register(
ai_handle network,
ai_observer_node_cb cb,
ai_handle cookie,
ai_u32 flags);
AI_INTERFACE_TYPE
ai_bool ai_platform_observer_register_s(ai_handle network,
ai_observer_exec_ctx *ctx);
/*!
* @brief un-register the observer context.
* @ingroup ai_platform_observer
* @param network a pointer to an opaque handle of the network context
* @param ctx a pointer to a reference of the registered platform observer context
* @param cb reference of the registered user callback function
* @param cookie reference of the registered user object/ctx
* @return false if the un-registration has failed (network error is updated) else true
* of error.
*/
AI_INTERFACE_TYPE
ai_bool ai_platform_observer_unregister(ai_handle network,
ai_observer_node_cb cb, ai_handle cookie);
AI_INTERFACE_TYPE
ai_bool ai_platform_observer_unregister_s(ai_handle network,
ai_observer_exec_ctx *ctx);
AI_API_DECLARE_END
#endif /*AI_PLATFORM_INTERFACE_H*/