runtime.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/dnnrt/runtime.h
 *
 *   Copyright 2018 Sony Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of Sony Corporation nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/
 
#ifndef __INCLUDE_DNNRT_RUNTIME_H
#  define __INCLUDE_DNNRT_RUNTIME_H
 
#  include <malloc.h>
#  include <asmp/types.h>
#  include <dnnrt/nnablart/network.h>
 
#  ifdef __cplusplus
#    define EXTERN extern "C"
extern "C"
{
#  else
#    define EXTERN extern
#  endif
 
#  define DNNRT_IMPLEMENT (0)
 
typedef struct dnn_runtime
{
  void *impl_ctx;
} dnn_runtime_t;
 
typedef struct dnn_config
{
 
  unsigned char cpu_num; 
} dnn_config_t;
 
typedef struct dnn_mallinfo
{
  cpuid_t cpu;
  size_t total_bytes;
  size_t used_bytes;
  size_t largest_bytes;
} dnn_mallinfo_t;
 
/********************************************************************************
 * Public Function Prototypes
 ********************************************************************************/
 
int dnn_initialize(dnn_config_t * config);
 
int dnn_finalize(void);
 
int dnn_runtime_initialize(dnn_runtime_t * rt, const nn_network_t * network);
 
int dnn_runtime_finalize(dnn_runtime_t * rt);
 
int dnn_runtime_forward(dnn_runtime_t * rt, const void *inputs[],
                        unsigned char input_num);
 
int dnn_runtime_input_num(dnn_runtime_t * rt);
 
int dnn_runtime_input_size(dnn_runtime_t * rt, unsigned char input_index);
 
int dnn_runtime_input_ndim(dnn_runtime_t * rt, unsigned char input_index);
 
int dnn_runtime_input_shape(dnn_runtime_t * rt, unsigned char input_index,
                            unsigned char dim_index);
 
nn_variable_t *dnn_runtime_input_variable(dnn_runtime_t * rt,
                                          unsigned char input_index);
 
int dnn_runtime_output_num(dnn_runtime_t * rt);
 
int dnn_runtime_output_size(dnn_runtime_t * rt, unsigned char output_index);
 
int dnn_runtime_output_ndim(dnn_runtime_t * rt, unsigned char output_index);
 
int dnn_runtime_output_shape(dnn_runtime_t * rt, unsigned char output_index,
                             unsigned char dim_index);
 
nn_variable_t *dnn_runtime_output_variable(dnn_runtime_t * rt,
                                           unsigned char output_index);
 
void *dnn_runtime_output_buffer(dnn_runtime_t * rt, unsigned char output_index);
 
int dnn_nuttx_mallinfo(dnn_mallinfo_t * info);
 
int dnn_asmp_mallinfo(unsigned char array_length, dnn_mallinfo_t * info_array);
 
#  undef EXTERN
#  ifdef __cplusplus
}
#  endif
 
#endif                                 /* __INCLUDE_DNNRT_RUNTIME_H */