You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

acl_base.h 22 kB

4 years ago
4 years ago
4 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640
  1. /**
  2. * Copyright 2019-2020 Huawei Technologies Co., Ltd
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #ifndef INC_EXTERNAL_ACL_ACL_BASE_H_
  17. #define INC_EXTERNAL_ACL_ACL_BASE_H_
  18. #include <stdint.h>
  19. #include <stddef.h>
  20. #include "error_codes/rt_error_codes.h"
  21. #include "error_codes/ge_error_codes.h"
  22. #ifdef __cplusplus
  23. extern "C" {
  24. #endif
  25. #if defined(_MSC_VER)
  26. #ifdef FUNC_VISIBILITY
  27. #define ACL_FUNC_VISIBILITY _declspec(dllexport)
  28. #else
  29. #define ACL_FUNC_VISIBILITY
  30. #endif
  31. #else
  32. #ifdef FUNC_VISIBILITY
  33. #define ACL_FUNC_VISIBILITY __attribute__((visibility("default")))
  34. #else
  35. #define ACL_FUNC_VISIBILITY
  36. #endif
  37. #endif
  38. #ifdef __GNUC__
  39. #define ACL_DEPRECATED __attribute__((deprecated))
  40. #define ACL_DEPRECATED_MESSAGE(message) __attribute__((deprecated(message)))
  41. #elif defined(_MSC_VER)
  42. #define ACL_DEPRECATED __declspec(deprecated)
  43. #define ACL_DEPRECATED_MESSAGE(message) __declspec(deprecated(message))
  44. #else
  45. #define ACL_DEPRECATED
  46. #define ACL_DEPRECATED_MESSAGE(message)
  47. #endif
  48. typedef void *aclrtStream;
  49. typedef void *aclrtEvent;
  50. typedef void *aclrtContext;
  51. typedef int aclError;
  52. typedef uint16_t aclFloat16;
  53. typedef struct aclDataBuffer aclDataBuffer;
  54. typedef struct aclTensorDesc aclTensorDesc;
  55. static const int ACL_ERROR_NONE = 0;
  56. static const int ACL_SUCCESS = 0;
  57. static const int ACL_ERROR_INVALID_PARAM = 100000;
  58. static const int ACL_ERROR_UNINITIALIZE = 100001;
  59. static const int ACL_ERROR_REPEAT_INITIALIZE = 100002;
  60. static const int ACL_ERROR_INVALID_FILE = 100003;
  61. static const int ACL_ERROR_WRITE_FILE = 100004;
  62. static const int ACL_ERROR_INVALID_FILE_SIZE = 100005;
  63. static const int ACL_ERROR_PARSE_FILE = 100006;
  64. static const int ACL_ERROR_FILE_MISSING_ATTR = 100007;
  65. static const int ACL_ERROR_FILE_ATTR_INVALID = 100008;
  66. static const int ACL_ERROR_INVALID_DUMP_CONFIG = 100009;
  67. static const int ACL_ERROR_INVALID_PROFILING_CONFIG = 100010;
  68. static const int ACL_ERROR_INVALID_MODEL_ID = 100011;
  69. static const int ACL_ERROR_DESERIALIZE_MODEL = 100012;
  70. static const int ACL_ERROR_PARSE_MODEL = 100013;
  71. static const int ACL_ERROR_READ_MODEL_FAILURE = 100014;
  72. static const int ACL_ERROR_MODEL_SIZE_INVALID = 100015;
  73. static const int ACL_ERROR_MODEL_MISSING_ATTR = 100016;
  74. static const int ACL_ERROR_MODEL_INPUT_NOT_MATCH = 100017;
  75. static const int ACL_ERROR_MODEL_OUTPUT_NOT_MATCH = 100018;
  76. static const int ACL_ERROR_MODEL_NOT_DYNAMIC = 100019;
  77. static const int ACL_ERROR_OP_TYPE_NOT_MATCH = 100020;
  78. static const int ACL_ERROR_OP_INPUT_NOT_MATCH = 100021;
  79. static const int ACL_ERROR_OP_OUTPUT_NOT_MATCH = 100022;
  80. static const int ACL_ERROR_OP_ATTR_NOT_MATCH = 100023;
  81. static const int ACL_ERROR_OP_NOT_FOUND = 100024;
  82. static const int ACL_ERROR_OP_LOAD_FAILED = 100025;
  83. static const int ACL_ERROR_UNSUPPORTED_DATA_TYPE = 100026;
  84. static const int ACL_ERROR_FORMAT_NOT_MATCH = 100027;
  85. static const int ACL_ERROR_BIN_SELECTOR_NOT_REGISTERED = 100028;
  86. static const int ACL_ERROR_KERNEL_NOT_FOUND = 100029;
  87. static const int ACL_ERROR_BIN_SELECTOR_ALREADY_REGISTERED = 100030;
  88. static const int ACL_ERROR_KERNEL_ALREADY_REGISTERED = 100031;
  89. static const int ACL_ERROR_INVALID_QUEUE_ID = 100032;
  90. static const int ACL_ERROR_REPEAT_SUBSCRIBE = 100033;
  91. static const int ACL_ERROR_STREAM_NOT_SUBSCRIBE = 100034;
  92. static const int ACL_ERROR_THREAD_NOT_SUBSCRIBE = 100035;
  93. static const int ACL_ERROR_WAIT_CALLBACK_TIMEOUT = 100036;
  94. static const int ACL_ERROR_REPEAT_FINALIZE = 100037;
  95. static const int ACL_ERROR_NOT_STATIC_AIPP = 100038;
  96. static const int ACL_ERROR_COMPILING_STUB_MODE = 100039;
  97. static const int ACL_ERROR_GROUP_NOT_SET = 100040;
  98. static const int ACL_ERROR_GROUP_NOT_CREATE = 100041;
  99. static const int ACL_ERROR_PROF_ALREADY_RUN = 100042;
  100. static const int ACL_ERROR_PROF_NOT_RUN = 100043;
  101. static const int ACL_ERROR_DUMP_ALREADY_RUN = 100044;
  102. static const int ACL_ERROR_DUMP_NOT_RUN = 100045;
  103. static const int ACL_ERROR_PROF_REPEAT_SUBSCRIBE = 148046;
  104. static const int ACL_ERROR_PROF_API_CONFLICT = 148047;
  105. static const int ACL_ERROR_INVALID_MAX_OPQUEUE_NUM_CONFIG = 148048;
  106. static const int ACL_ERROR_INVALID_OPP_PATH = 148049;
  107. static const int ACL_ERROR_OP_UNSUPPORTED_DYNAMIC = 148050;
  108. static const int ACL_ERROR_BAD_ALLOC = 200000;
  109. static const int ACL_ERROR_API_NOT_SUPPORT = 200001;
  110. static const int ACL_ERROR_INVALID_DEVICE = 200002;
  111. static const int ACL_ERROR_MEMORY_ADDRESS_UNALIGNED = 200003;
  112. static const int ACL_ERROR_RESOURCE_NOT_MATCH = 200004;
  113. static const int ACL_ERROR_INVALID_RESOURCE_HANDLE = 200005;
  114. static const int ACL_ERROR_FEATURE_UNSUPPORTED = 200006;
  115. static const int ACL_ERROR_PROF_MODULES_UNSUPPORTED = 200007;
  116. static const int ACL_ERROR_STORAGE_OVER_LIMIT = 300000;
  117. static const int ACL_ERROR_INTERNAL_ERROR = 500000;
  118. static const int ACL_ERROR_FAILURE = 500001;
  119. static const int ACL_ERROR_GE_FAILURE = 500002;
  120. static const int ACL_ERROR_RT_FAILURE = 500003;
  121. static const int ACL_ERROR_DRV_FAILURE = 500004;
  122. static const int ACL_ERROR_PROFILING_FAILURE = 500005;
  123. #define ACL_TENSOR_SHAPE_RANGE_NUM 2
  124. #define ACL_UNKNOWN_RANK 0xFFFFFFFFFFFFFFFE
  125. typedef enum {
  126. ACL_DT_UNDEFINED = -1,
  127. ACL_FLOAT = 0,
  128. ACL_FLOAT16 = 1,
  129. ACL_INT8 = 2,
  130. ACL_INT32 = 3,
  131. ACL_UINT8 = 4,
  132. ACL_INT16 = 6,
  133. ACL_UINT16 = 7,
  134. ACL_UINT32 = 8,
  135. ACL_INT64 = 9,
  136. ACL_UINT64 = 10,
  137. ACL_DOUBLE = 11,
  138. ACL_BOOL = 12,
  139. ACL_STRING = 13,
  140. ACL_COMPLEX64 = 16,
  141. ACL_COMPLEX128 = 17
  142. } aclDataType;
  143. typedef enum {
  144. ACL_FORMAT_UNDEFINED = -1,
  145. ACL_FORMAT_NCHW = 0,
  146. ACL_FORMAT_NHWC = 1,
  147. ACL_FORMAT_ND = 2,
  148. ACL_FORMAT_NC1HWC0 = 3,
  149. ACL_FORMAT_FRACTAL_Z = 4,
  150. ACL_FORMAT_NC1HWC0_C04 = 12,
  151. ACL_FORMAT_NDHWC = 27,
  152. ACL_FORMAT_FRACTAL_NZ = 29,
  153. ACL_FORMAT_NCDHW = 30,
  154. ACL_FORMAT_NDC1HWC0 = 32,
  155. ACL_FRACTAL_Z_3D = 33
  156. } aclFormat;
  157. typedef enum {
  158. ACL_DEBUG = 0,
  159. ACL_INFO = 1,
  160. ACL_WARNING = 2,
  161. ACL_ERROR = 3,
  162. } aclLogLevel;
  163. typedef enum {
  164. ACL_MEMTYPE_DEVICE = 0,
  165. ACL_MEMTYPE_HOST = 1,
  166. } aclMemType;
  167. /**
  168. * @ingroup AscendCL
  169. * @brief Converts data of type aclFloat16 to data of type float
  170. *
  171. * @param value [IN] Data to be converted
  172. *
  173. * @retval Transformed data
  174. */
  175. ACL_FUNC_VISIBILITY float aclFloat16ToFloat(aclFloat16 value);
  176. /**
  177. * @ingroup AscendCL
  178. * @brief Converts data of type float to data of type aclFloat16
  179. *
  180. * @param value [IN] Data to be converted
  181. *
  182. * @retval Transformed data
  183. */
  184. ACL_FUNC_VISIBILITY aclFloat16 aclFloatToFloat16(float value);
  185. /**
  186. * @ingroup AscendCL
  187. * @brief create data of aclDataBuffer
  188. *
  189. * @param data [IN] pointer to data
  190. * @li Need to be managed by the user,
  191. * call aclrtMalloc interface to apply for memory,
  192. * call aclrtFree interface to release memory
  193. *
  194. * @param size [IN] size of data in bytes
  195. *
  196. * @retval pointer to created instance. nullptr if run out of memory
  197. *
  198. * @see aclrtMalloc | aclrtFree
  199. */
  200. ACL_FUNC_VISIBILITY aclDataBuffer *aclCreateDataBuffer(void *data, size_t size);
  201. /**
  202. * @ingroup AscendCL
  203. * @brief destroy data of aclDataBuffer
  204. *
  205. * @par Function
  206. * Only the aclDataBuffer type data is destroyed here.
  207. * The memory of the data passed in when the aclDataDataBuffer interface
  208. * is called to create aclDataBuffer type data must be released by the user
  209. *
  210. * @param dataBuffer [IN] pointer to the aclDataBuffer
  211. *
  212. * @retval ACL_SUCCESS The function is successfully executed.
  213. * @retval OtherValues Failure
  214. *
  215. * @see aclCreateDataBuffer
  216. */
  217. ACL_FUNC_VISIBILITY aclError aclDestroyDataBuffer(const aclDataBuffer *dataBuffer);
  218. /**
  219. * @ingroup AscendCL
  220. * @brief update new data of aclDataBuffer
  221. *
  222. * @param dataBuffer [OUT] pointer to aclDataBuffer
  223. * @li The old data need to be released by the user, otherwise it may occur memory leak leakage
  224. * call aclGetDataBufferAddr interface to get old data address
  225. * call aclrtFree interface to release memory
  226. *
  227. * @param data [IN] pointer to new data
  228. * @li Need to be managed by the user,
  229. * call aclrtMalloc interface to apply for memory,
  230. * call aclrtFree interface to release memory
  231. *
  232. * @param size [IN] size of data in bytes
  233. *
  234. * @retval ACL_SUCCESS The function is successfully executed.
  235. * @retval OtherValues Failure
  236. *
  237. * @see aclrtMalloc | aclrtFree | aclGetDataBufferAddr
  238. */
  239. ACL_FUNC_VISIBILITY aclError aclUpdateDataBuffer(aclDataBuffer *dataBuffer, void *data, size_t size);
  240. /**
  241. * @ingroup AscendCL
  242. * @brief get data address from aclDataBuffer
  243. *
  244. * @param dataBuffer [IN] pointer to the data of aclDataBuffer
  245. *
  246. * @retval data address
  247. */
  248. ACL_FUNC_VISIBILITY void *aclGetDataBufferAddr(const aclDataBuffer *dataBuffer);
  249. /**
  250. * @ingroup AscendCL
  251. * @brief get data size of aclDataBuffer
  252. *
  253. * @param dataBuffer [IN] pointer to the data of aclDataBuffer
  254. *
  255. * @retval data size
  256. */
  257. ACL_DEPRECATED_MESSAGE("aclGetDataBufferSize is deprecated, use aclGetDataBufferSizeV2 instead")
  258. ACL_FUNC_VISIBILITY uint32_t aclGetDataBufferSize(const aclDataBuffer *dataBuffer);
  259. /**
  260. * @ingroup AscendCL
  261. * @brief get data size of aclDataBuffer to replace aclGetDataBufferSize
  262. *
  263. * @param dataBuffer [IN] pointer to the data of aclDataBuffer
  264. *
  265. * @retval data size
  266. */
  267. ACL_FUNC_VISIBILITY size_t aclGetDataBufferSizeV2(const aclDataBuffer *dataBuffer);
  268. /**
  269. * @ingroup AscendCL
  270. * @brief get size of aclDataType
  271. *
  272. * @param dataType [IN] aclDataType data the size to get
  273. *
  274. * @retval size of the aclDataType
  275. */
  276. ACL_FUNC_VISIBILITY size_t aclDataTypeSize(aclDataType dataType);
  277. // interfaces of tensor desc
  278. /**
  279. * @ingroup AscendCL
  280. * @brief create data aclTensorDesc
  281. *
  282. * @param dataType [IN] Data types described by tensor
  283. * @param numDims [IN] the number of dimensions of the shape
  284. * @param dims [IN] the size of the specified dimension
  285. * @param format [IN] tensor format
  286. *
  287. * @retval aclTensorDesc pointer.
  288. * @retval nullptr if param is invalid or run out of memory
  289. */
  290. ACL_FUNC_VISIBILITY aclTensorDesc *aclCreateTensorDesc(aclDataType dataType, int numDims, const int64_t *dims,
  291. aclFormat format);
  292. /**
  293. * @ingroup AscendCL
  294. * @brief destroy data aclTensorDesc
  295. *
  296. * @param desc [IN] pointer to the data of aclTensorDesc to destroy
  297. */
  298. ACL_FUNC_VISIBILITY void aclDestroyTensorDesc(const aclTensorDesc *desc);
  299. /**
  300. * @ingroup AscendCL
  301. * @brief set tensor shape range for aclTensorDesc
  302. *
  303. * @param desc [OUT] pointer to the data of aclTensorDesc
  304. * @param dimsCount [IN] the number of dimensions of the shape
  305. * @param dimsRange [IN] the range of dimensions of the shape
  306. *
  307. * @retval ACL_SUCCESS The function is successfully executed.
  308. * @retval OtherValues Failure
  309. */
  310. ACL_FUNC_VISIBILITY aclError aclSetTensorShapeRange(aclTensorDesc *desc, size_t dimsCount,
  311. int64_t dimsRange[][ACL_TENSOR_SHAPE_RANGE_NUM]);
  312. /**
  313. * @ingroup AscendCL
  314. * @brief get data type specified by the tensor description
  315. *
  316. * @param desc [IN] pointer to the instance of aclTensorDesc
  317. *
  318. * @retval data type specified by the tensor description.
  319. * @retval ACL_DT_UNDEFINED if description is null
  320. */
  321. ACL_FUNC_VISIBILITY aclDataType aclGetTensorDescType(const aclTensorDesc *desc);
  322. /**
  323. * @ingroup AscendCL
  324. * @brief get data format specified by the tensor description
  325. *
  326. * @param desc [IN] pointer to the instance of aclTensorDesc
  327. *
  328. * @retval data format specified by the tensor description.
  329. * @retval ACL_FORMAT_UNDEFINED if description is null
  330. */
  331. ACL_FUNC_VISIBILITY aclFormat aclGetTensorDescFormat(const aclTensorDesc *desc);
  332. /**
  333. * @ingroup AscendCL
  334. * @brief get tensor size specified by the tensor description
  335. *
  336. * @param desc [IN] pointer to the instance of aclTensorDesc
  337. *
  338. * @retval data size specified by the tensor description.
  339. * @retval 0 if description is null
  340. */
  341. ACL_FUNC_VISIBILITY size_t aclGetTensorDescSize(const aclTensorDesc *desc);
  342. /**
  343. * @ingroup AscendCL
  344. * @brief get element count specified by the tensor description
  345. *
  346. * @param desc [IN] pointer to the instance of aclTensorDesc
  347. *
  348. * @retval element count specified by the tensor description.
  349. * @retval 0 if description is null
  350. */
  351. ACL_FUNC_VISIBILITY size_t aclGetTensorDescElementCount(const aclTensorDesc *desc);
  352. /**
  353. * @ingroup AscendCL
  354. * @brief get number of dims specified by the tensor description
  355. *
  356. * @param desc [IN] pointer to the instance of aclTensorDesc
  357. *
  358. * @retval number of dims specified by the tensor description.
  359. * @retval 0 if description is null
  360. * @retval ACL_UNKNOWN_RANK if the tensor dim is -2
  361. */
  362. ACL_FUNC_VISIBILITY size_t aclGetTensorDescNumDims(const aclTensorDesc *desc);
  363. /**
  364. * @ingroup AscendCL
  365. * @brief Get the size of the specified dim in the tensor description
  366. *
  367. * @param desc [IN] pointer to the instance of aclTensorDesc
  368. * @param index [IN] index of dims, start from 0.
  369. *
  370. * @retval dim specified by the tensor description and index.
  371. * @retval -1 if description or index is invalid
  372. */
  373. ACL_DEPRECATED_MESSAGE("aclGetTensorDescDim is deprecated, use aclGetTensorDescDimV2 instead")
  374. ACL_FUNC_VISIBILITY int64_t aclGetTensorDescDim(const aclTensorDesc *desc, size_t index);
  375. /**
  376. * @ingroup AscendCL
  377. * @brief Get the size of the specified dim in the tensor description
  378. *
  379. * @param desc [IN] pointer to the instance of aclTensorDesc
  380. * @param index [IN] index of dims, start from 0.
  381. * @param dimSize [OUT] size of the specified dim.
  382. *
  383. * @retval ACL_SUCCESS The function is successfully executed.
  384. * @retval OtherValues Failure
  385. */
  386. ACL_FUNC_VISIBILITY aclError aclGetTensorDescDimV2(const aclTensorDesc *desc, size_t index, int64_t *dimSize);
  387. /**
  388. * @ingroup AscendCL
  389. * @brief Get the range of the specified dim in the tensor description
  390. *
  391. * @param desc [IN] pointer to the instance of aclTensorDesc
  392. * @param index [IN] index of dims, start from 0.
  393. * @param dimRangeNum [IN] number of dimRange.
  394. * @param dimRange [OUT] range of the specified dim.
  395. *
  396. * @retval ACL_SUCCESS The function is successfully executed.
  397. * @retval OtherValues Failure
  398. */
  399. ACL_FUNC_VISIBILITY aclError aclGetTensorDescDimRange(const aclTensorDesc *desc, size_t index, size_t dimRangeNum,
  400. int64_t *dimRange);
  401. /**
  402. * @ingroup AscendCL
  403. * @brief set tensor description name
  404. *
  405. * @param desc [OUT] pointer to the instance of aclTensorDesc
  406. * @param name [IN] tensor description name
  407. */
  408. ACL_FUNC_VISIBILITY void aclSetTensorDescName(aclTensorDesc *desc, const char *name);
  409. /**
  410. * @ingroup AscendCL
  411. * @brief get tensor description name
  412. *
  413. * @param desc [IN] pointer to the instance of aclTensorDesc
  414. *
  415. * @retval tensor description name.
  416. * @retval empty string if description is null
  417. */
  418. ACL_FUNC_VISIBILITY const char *aclGetTensorDescName(aclTensorDesc *desc);
  419. /**
  420. * @ingroup AscendCL
  421. * @brief Convert the format in the source aclTensorDesc according to
  422. * the specified dstFormat to generate a new target aclTensorDesc.
  423. * The format in the source aclTensorDesc remains unchanged.
  424. *
  425. * @param srcDesc [IN] pointer to the source tensor desc
  426. * @param dstFormat [IN] destination format
  427. * @param dstDesc [OUT] pointer to the pointer to the destination tensor desc
  428. *
  429. * @retval ACL_SUCCESS The function is successfully executed.
  430. * @retval OtherValues Failure
  431. */
  432. ACL_FUNC_VISIBILITY aclError aclTransTensorDescFormat(const aclTensorDesc *srcDesc, aclFormat dstFormat,
  433. aclTensorDesc **dstDesc);
  434. /**
  435. * @ingroup AscendCL
  436. * @brief Set the storage format specified by the tensor description
  437. *
  438. * @param desc [OUT] pointer to the instance of aclTensorDesc
  439. * @param format [IN] the storage format
  440. *
  441. * @retval ACL_SUCCESS The function is successfully executed.
  442. * @retval OtherValues Failure
  443. */
  444. ACL_DEPRECATED_MESSAGE("aclSetTensorStorageFormat is deprecated, use aclSetTensorFormat instead")
  445. ACL_FUNC_VISIBILITY aclError aclSetTensorStorageFormat(aclTensorDesc *desc, aclFormat format);
  446. /**
  447. * @ingroup AscendCL
  448. * @brief Set the storage shape specified by the tensor description
  449. *
  450. * @param desc [OUT] pointer to the instance of aclTensorDesc
  451. * @param numDims [IN] the number of dimensions of the shape
  452. * @param dims [IN] the size of the specified dimension
  453. *
  454. * @retval ACL_SUCCESS The function is successfully executed.
  455. * @retval OtherValues Failure
  456. */
  457. ACL_DEPRECATED_MESSAGE("aclSetTensorStorageShape is deprecated, use aclSetTensorShape instead")
  458. ACL_FUNC_VISIBILITY aclError aclSetTensorStorageShape(aclTensorDesc *desc, int numDims, const int64_t *dims);
  459. /**
  460. * @ingroup AscendCL
  461. * @brief Set the format specified by the tensor description
  462. *
  463. * @param desc [OUT] pointer to the instance of aclTensorDesc
  464. * @param format [IN] the storage format
  465. *
  466. * @retval ACL_SUCCESS The function is successfully executed.
  467. * @retval OtherValues Failure
  468. */
  469. ACL_FUNC_VISIBILITY aclError aclSetTensorFormat(aclTensorDesc *desc, aclFormat format);
  470. /**
  471. * @ingroup AscendCL
  472. * @brief Set the shape specified by the tensor description
  473. *
  474. * @param desc [OUT] pointer to the instance of aclTensorDesc
  475. * @param numDims [IN] the number of dimensions of the shape
  476. * @param dims [IN] the size of the specified dimension
  477. *
  478. * @retval ACL_SUCCESS The function is successfully executed.
  479. * @retval OtherValues Failure
  480. */
  481. ACL_FUNC_VISIBILITY aclError aclSetTensorShape(aclTensorDesc *desc, int numDims, const int64_t *dims);
  482. /**
  483. * @ingroup AscendCL
  484. * @brief Set the original format specified by the tensor description
  485. *
  486. * @param desc [OUT] pointer to the instance of aclTensorDesc
  487. * @param format [IN] the storage format
  488. *
  489. * @retval ACL_SUCCESS The function is successfully executed.
  490. * @retval OtherValues Failure
  491. */
  492. ACL_FUNC_VISIBILITY aclError aclSetTensorOriginFormat(aclTensorDesc *desc, aclFormat format);
  493. /**
  494. * @ingroup AscendCL
  495. * @brief Set the original shape specified by the tensor description
  496. *
  497. * @param desc [OUT] pointer to the instance of aclTensorDesc
  498. * @param numDims [IN] the number of dimensions of the shape
  499. * @param dims [IN] the size of the specified dimension
  500. *
  501. * @retval ACL_SUCCESS The function is successfully executed.
  502. * @retval OtherValues Failure
  503. */
  504. ACL_FUNC_VISIBILITY aclError aclSetTensorOriginShape(aclTensorDesc *desc, int numDims, const int64_t *dims);
  505. /**
  506. * @ingroup AscendCL
  507. * @brief get op description info
  508. *
  509. * @param desc [IN] pointer to tensor description
  510. * @param index [IN] index of tensor
  511. *
  512. * @retval null for failed.
  513. * @retval OtherValues success.
  514. */
  515. ACL_FUNC_VISIBILITY aclTensorDesc *aclGetTensorDescByIndex(aclTensorDesc *desc, size_t index);
  516. /**
  517. * @ingroup AscendCL
  518. * @brief get address of tensor
  519. *
  520. * @param desc [IN] pointer to tensor description
  521. *
  522. * @retval null for failed
  523. * @retval OtherValues success
  524. */
  525. ACL_FUNC_VISIBILITY void *aclGetTensorDescAddress(const aclTensorDesc *desc);
  526. /**
  527. * @ingroup AscendCL
  528. * @brief Set the dynamic input name specified by the tensor description
  529. *
  530. * @param desc [OUT] pointer to the instance of aclTensorDesc
  531. * @param dynamicInputName [IN] pointer to the dynamic input name
  532. *
  533. * @retval ACL_SUCCESS The function is successfully executed.
  534. * @retval OtherValues Failure
  535. */
  536. ACL_FUNC_VISIBILITY aclError aclSetTensorDynamicInput(aclTensorDesc *desc, const char *dynamicInputName);
  537. /**
  538. * @ingroup AscendCL
  539. * @brief Set const data specified by the tensor description
  540. *
  541. * @param desc [OUT] pointer to the instance of aclTensorDesc
  542. * @param dataBuffer [IN] pointer to the const databuffer
  543. * @param length [IN] the length of const databuffer
  544. *
  545. * @retval ACL_SUCCESS The function is successfully executed.
  546. * @retval OtherValues Failure
  547. */
  548. ACL_FUNC_VISIBILITY aclError aclSetTensorConst(aclTensorDesc *desc, void *dataBuffer, size_t length);
  549. /**
  550. * @ingroup AscendCL
  551. * @brief Set tensor memory type specified by the tensor description
  552. *
  553. * @param desc [OUT] pointer to the instance of aclTensorDesc
  554. * @param memType [IN] ACL_MEMTYPE_DEVICE means device, ACL_MEMTYPE_HOST means host
  555. *
  556. * @retval ACL_SUCCESS The function is successfully executed.
  557. * @retval OtherValues Failure
  558. */
  559. ACL_FUNC_VISIBILITY aclError aclSetTensorPlaceMent(aclTensorDesc *desc, aclMemType memType);
  560. /**
  561. * @ingroup AscendCL
  562. * @brief an interface for users to output APP logs
  563. *
  564. * @param logLevel [IN] the level of current log
  565. * @param func [IN] the function where the log is located
  566. * @param file [IN] the file where the log is located
  567. * @param line [IN] Number of source lines where the log is located
  568. * @param fmt [IN] the format of current log
  569. * @param ... [IN] the value of current log
  570. */
  571. ACL_FUNC_VISIBILITY void aclAppLog(aclLogLevel logLevel, const char *func, const char *file, uint32_t line,
  572. const char *fmt, ...);
  573. /**
  574. * @ingroup AscendCL
  575. * @brief get soc name
  576. *
  577. * @retval null for failed
  578. * @retval OtherValues success
  579. */
  580. ACL_FUNC_VISIBILITY const char *aclrtGetSocName();
  581. #define ACL_APP_LOG(level, fmt, ...) aclAppLog(level, __FUNCTION__, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
  582. #ifdef __cplusplus
  583. }
  584. #endif
  585. #endif // INC_EXTERNAL_ACL_ACL_BASE_H_

图引擎模块(GE)是MindSpore的一个子模块,其代码由C++实现,位于前端模块ME和底层硬件之间,起到承接作用。图引擎模块以ME下发的图作为输入,然后进行一系列的深度图优化操作,最后输出一张可以在底层硬件上高效运行的图。GE针对昇腾AI处理器的硬件结构特点,做了特定的优化工作,以此来充分发挥出昇腾AI处理器的强大算力。在进行模型训练/推理时,GE会被自动调用而用户并不感知。GE主要由GE API和GE Core两部分组成,详细的架构图如下所示