OMTensor.h

转到此文件的文档。

/*
 * SPDX-License-Identifier: Apache-2.0
 */
 
//===-------------- OMTensor.h - OMTensor 声明头文件 --------------===//
//
// Copyright 2019-2023 The IBM Research Authors.
//
// =============================================================================
//
// This file contains declaration of OMTensor data structures and
// API functions.
//
//===----------------------------------------------------------------------===//
 
#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