OMTensor.h

转到此文件的文档。

/*
 * SPDX-License-Identifier: Apache-2.0
 */
 
//===-------------- OMTensor.h - OMTensor Declaration header --------------===//
//
// Copyright 2019-2023 The IBM Research Authors.
//
// =============================================================================
//
// 此文件包含 OMTensor 数据结构和
// API 函数的声明。
//
//===----------------------------------------------------------------------===//
 
#ifndef ONNX_MLIR_OMTENSOR_H
#define ONNX_MLIR_OMTENSOR_H
 
#ifdef __cplusplus
#include <algorithm>
#include <iostream>
#include <map>
#include <numeric>
#include <string>
#include <vector>
#else
#include <stdbool.h>
#endif // #ifdef __cplusplus
 
#if defined(__APPLE__) || defined(__MVS__)
#include <stdlib.h>
#else
#include <malloc.h>
#endif // #ifdef __APPLE__
 
#include "onnx-mlir/Compiler/OMCompilerMacros.h"
#include "onnx-mlir/Runtime/OnnxDataType.h"
 
/* 通常，MLIR 上下文中的 MemRefs 用作编译时构造。
 * 数据载荷的元素类型和等级等信息是静态编码的，
 * 这意味着它们在编译时确定并固定。这给任何试图
 * 与已编译可执行文件交互的运行时组件带来了巨大的负担。
 * 
 *
 * 因此，提供了一个适合运行时操作的 MemRef 结构版本，作为构建
 * 任何提供用户编程接口的运行时相关组件的基础。所有信息
 * 都动态编码为此结构的成员，以便在运行时可以轻松访问和修改。
 * 
 * 我们将其称为 OMTensor。
 *
 * 我们将其称为 OMTensor。
 */
 
struct OMTensor;
 
#ifndef __cplusplus
typedef struct OMTensor OMTensor;
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
OM_EXTERNAL_VISIBILITY OMTensor *omTensorCreate(
 void *data_ptr, const int64_t *shape, int64_t rank, OM_DATA_TYPE dtype);
 
OM_EXTERNAL_VISIBILITY OMTensor *omTensorCreateWithOwnership(void *data_ptr,
 const int64_t *shape, int64_t rank, OM_DATA_TYPE dtype, int64_t owning);
 
OM_EXTERNAL_VISIBILITY OMTensor *omTensorCreateEmpty(
 const int64_t *shape, int64_t rank, OM_DATA_TYPE dtype);
 
OM_EXTERNAL_VISIBILITY void omTensorDestroy(OMTensor *tensor);
 
OM_EXTERNAL_VISIBILITY void *omTensorGetDataPtr(const OMTensor *tensor);
 
OM_EXTERNAL_VISIBILITY void *omTensorGetAllocatedPtr(const OMTensor *tensor);
 
OM_EXTERNAL_VISIBILITY const int64_t *omTensorGetShape(const OMTensor *tensor);
 
OM_EXTERNAL_VISIBILITY void omTensorSetShape(
 OMTensor *tensor, const int64_t *shape);
 
OM_EXTERNAL_VISIBILITY const int64_t *omTensorGetStrides(
 const OMTensor *tensor);
 
OM_EXTERNAL_VISIBILITY void omTensorSetStrides(
 OMTensor *tensor, const int64_t *stride);
 
OM_EXTERNAL_VISIBILITY void omTensorSetStridesWithPyArrayStrides(
 OMTensor *tensor, const int64_t *stridesInBytes);
 
OM_EXTERNAL_VISIBILITY OM_DATA_TYPE omTensorGetDataType(const OMTensor *tensor);
 
OM_EXTERNAL_VISIBILITY void omTensorSetDataType(
 OMTensor *tensor, OM_DATA_TYPE dataType);
 
/* 获取 ONNX 数据类型大小（字节）的辅助函数 */
static inline int64_t getDataTypeSize(OM_DATA_TYPE dataType) {
 return OM_DATA_TYPE_SIZE[dataType];
}
 
OM_EXTERNAL_VISIBILITY int64_t omTensorGetBufferSize(const OMTensor *tensor);
 
OM_EXTERNAL_VISIBILITY int64_t omTensorGetRank(const OMTensor *tensor);
 
OM_EXTERNAL_VISIBILITY int64_t omTensorGetNumElems(const OMTensor *tensor);
 
OM_EXTERNAL_VISIBILITY int64_t omTensorGetOwning(const OMTensor *tensor);
 
OM_EXTERNAL_VISIBILITY void omTensorSetOwning(OMTensor *tensor, int64_t owning);
 
OM_EXTERNAL_VISIBILITY void omTensorPrint(
 const char *msg, const OMTensor *tensor);
 
#ifdef __cplusplus
}
#endif
 
#endif // ONNX_MLIR_OMTENSOR_H