odla_device.h

Go to the documentation of this file.

//===- odla_device.h ------------------------------------------------------===//
//
// Copyright (C) 2019-2020 Alibaba Group Holding Limited.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// =============================================================================
 
#ifndef _ODLA_DEVICE_H_
#define _ODLA_DEVICE_H_
 
#include <ODLA/odla_value.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
  ODLA_VENDOR_DEFAULT,
  ODLA_VENDOR_ALIBABA,
  ODLA_VENDOR_ARM,
  ODLA_VENDOR_CAMBRICON,
  ODLA_VENDOR_GRAPHCORE,
  ODLA_VENDOR_HABANA,
  ODLA_VENDOR_INTEL,
  ODLA_VENDOR_NVIDIA,
  ODLA_VENDOR_QUALCOMM,
} odla_vendor_name;
 
typedef enum {
  OVI_DESCRIPTION,
  OVI_FEATURE_SET,
} odla_vendor_info;
 
typedef enum {
  ODLA_DEVICE_DEFAULT,
  // Alibaba
  ODLA_DEVICE_ALIBABA_HANGUANG,
  // ARM
  ODLA_DEVICE_ARM_CORTEX_M,
  // Cambricon
  ODLA_DEVICE_CAMBRICON_MLU220,
  ODLA_DEVICE_CAMBRICON_MLU270,
  // GraphCore
  ODLA_DEVICE_GRAPHCORE_IPU,
  // Intel Habana
  ODLA_DEVICE_HABANA_GAUDI,
  ODLA_DEVICE_HABANA_GOYA,
  // Intel CPU
  ODLA_DEVICE_INTEL_X86,
  ODLA_DEVICE_INTEL_DNNL,
  // NVidia
  ODLA_DEVICE_NVIDIA_GPU,
  ODLA_DEVICE_NVIDIA_TENSORRT,
  // Qualcomm
  ODLA_DEVICE_QUALCOMM_AIC100,
} odla_device_name;
 
typedef enum {
  ODLA_DEVICE_INFO_ODLA_LIB_VERSION, 
  ODLA_DEVICE_INFO_DEV_COUNT,        
  ODLA_DEVICE_INFO_DEV_INDEX,        
  ODLA_DEVICE_INFO_DEV_TYPE,         
  ODLA_DEVICE_INFO_DEV_UUID,         
  ODLA_DEVICE_INFO_PROCESSOR_UTIL, 
  ODLA_DEVICE_INFO_MEMORY_UTIL,    
  ODLA_DEVICE_INFO_TOTAL_MEMORY,   
  ODLA_DEVICE_INFO_USED_MEMORY,    
  ODLA_DEVICE_INFO_POWER_USAGE,    
  ODLA_DEVICE_INFO_POWER_LIMIT,    
  ODLA_DEVICE_INFO_DRIVER_VERSION, 
  ODLA_DEVICE_INFO_SDK_VERSION,    
} odla_device_info;
 
typedef struct _odla_vendor* odla_vendor;
 
typedef struct _odla_device* odla_device;
 
typedef struct _odla_device_config* odla_device_config;
 
typedef struct _odla_device_config_item* odla_device_config_item;
 
 
extern ODLA_API_EXPORT odla_status ODLA_API_CALL
odla_GetVendor(const odla_vendor_name vendor_name, odla_vendor* vendor);
 
 
extern ODLA_API_EXPORT odla_status ODLA_API_CALL odla_GetVendorInfo(
    const odla_vendor vendor, const odla_vendor_info info_name,
    const odla_size_t allocated_info_value_size, odla_void* info_value,
    odla_size_t* retrieved_info_value_size);
 
 
extern ODLA_API_EXPORT odla_status ODLA_API_CALL
odla_AllocateDevice(odla_vendor vendor, odla_device_name device_name,
                    odla_int32 device_idx, odla_device* device);
 
 
extern ODLA_API_EXPORT odla_status ODLA_API_CALL
odla_GetDeviceInfo(odla_device device, odla_device_info info_type,
                   odla_scalar_value* info_value);
 
 
extern ODLA_API_EXPORT odla_status ODLA_API_CALL
odla_InitDevice(odla_device device, const odla_device_config config);
 
 
extern ODLA_API_EXPORT odla_status ODLA_API_CALL
odla_SetCurrentDevice(odla_device device);
 
 
extern ODLA_API_EXPORT odla_status ODLA_API_CALL
odla_DestroyDevice(odla_device device);
 
 
extern ODLA_API_EXPORT odla_status ODLA_API_CALL
odla_CreateDeviceConfig(odla_device_config* device_config);
 
 
extern ODLA_API_EXPORT odla_status ODLA_API_CALL
odla_SetDeviceConfigItem(odla_device_config device_config,
                         odla_device_config_item device_config_item, ...);
 
 
extern ODLA_API_EXPORT odla_status ODLA_API_CALL
odla_DestroyDeviceConfig(odla_device_config device_config);
 
#ifdef __cplusplus
} // C extern
#endif
 
#endif // _ODLA_DEVICE_H_