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 21 kB

4 years ago
4 years ago
4 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618
  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. } aclDataType;
  141. typedef enum {
  142. ACL_FORMAT_UNDEFINED = -1,
  143. ACL_FORMAT_NCHW = 0,
  144. ACL_FORMAT_NHWC = 1,
  145. ACL_FORMAT_ND = 2,
  146. ACL_FORMAT_NC1HWC0 = 3,
  147. ACL_FORMAT_FRACTAL_Z = 4,
  148. ACL_FORMAT_NC1HWC0_C04 = 12,
  149. ACL_FORMAT_NDHWC = 27,
  150. ACL_FORMAT_FRACTAL_NZ = 29,
  151. ACL_FORMAT_NCDHW = 30,
  152. ACL_FORMAT_NDC1HWC0 = 32,
  153. ACL_FRACTAL_Z_3D = 33
  154. } aclFormat;
  155. typedef enum {
  156. ACL_DEBUG = 0,
  157. ACL_INFO = 1,
  158. ACL_WARNING = 2,
  159. ACL_ERROR = 3,
  160. } aclLogLevel;
  161. /**
  162. * @ingroup AscendCL
  163. * @brief Converts data of type aclFloat16 to data of type float
  164. *
  165. * @param value [IN] Data to be converted
  166. *
  167. * @retval Transformed data
  168. */
  169. ACL_FUNC_VISIBILITY float aclFloat16ToFloat(aclFloat16 value);
  170. /**
  171. * @ingroup AscendCL
  172. * @brief Converts data of type float to data of type aclFloat16
  173. *
  174. * @param value [IN] Data to be converted
  175. *
  176. * @retval Transformed data
  177. */
  178. ACL_FUNC_VISIBILITY aclFloat16 aclFloatToFloat16(float value);
  179. /**
  180. * @ingroup AscendCL
  181. * @brief create data of aclDataBuffer
  182. *
  183. * @param data [IN] pointer to data
  184. * @li Need to be managed by the user,
  185. * call aclrtMalloc interface to apply for memory,
  186. * call aclrtFree interface to release memory
  187. *
  188. * @param size [IN] size of data in bytes
  189. *
  190. * @retval pointer to created instance. nullptr if run out of memory
  191. *
  192. * @see aclrtMalloc | aclrtFree
  193. */
  194. ACL_FUNC_VISIBILITY aclDataBuffer *aclCreateDataBuffer(void *data, size_t size);
  195. /**
  196. * @ingroup AscendCL
  197. * @brief destroy data of aclDataBuffer
  198. *
  199. * @par Function
  200. * Only the aclDataBuffer type data is destroyed here.
  201. * The memory of the data passed in when the aclDataDataBuffer interface
  202. * is called to create aclDataBuffer type data must be released by the user
  203. *
  204. * @param dataBuffer [IN] pointer to the aclDataBuffer
  205. *
  206. * @retval ACL_SUCCESS The function is successfully executed.
  207. * @retval OtherValues Failure
  208. *
  209. * @see aclCreateDataBuffer
  210. */
  211. ACL_FUNC_VISIBILITY aclError aclDestroyDataBuffer(const aclDataBuffer *dataBuffer);
  212. /**
  213. * @ingroup AscendCL
  214. * @brief update new data of aclDataBuffer
  215. *
  216. * @param dataBuffer [OUT] pointer to aclDataBuffer
  217. * @li The old data need to be released by the user, otherwise it may occur memory leak leakage
  218. * call aclGetDataBufferAddr interface to get old data address
  219. * call aclrtFree interface to release memory
  220. *
  221. * @param data [IN] pointer to new data
  222. * @li Need to be managed by the user,
  223. * call aclrtMalloc interface to apply for memory,
  224. * call aclrtFree interface to release memory
  225. *
  226. * @param size [IN] size of data in bytes
  227. *
  228. * @retval ACL_SUCCESS The function is successfully executed.
  229. * @retval OtherValues Failure
  230. *
  231. * @see aclrtMalloc | aclrtFree | aclGetDataBufferAddr
  232. */
  233. ACL_FUNC_VISIBILITY aclError aclUpdateDataBuffer(aclDataBuffer *dataBuffer, void *data, size_t size);
  234. /**
  235. * @ingroup AscendCL
  236. * @brief get data address from aclDataBuffer
  237. *
  238. * @param dataBuffer [IN] pointer to the data of aclDataBuffer
  239. *
  240. * @retval data address
  241. */
  242. ACL_FUNC_VISIBILITY void *aclGetDataBufferAddr(const aclDataBuffer *dataBuffer);
  243. /**
  244. * @ingroup AscendCL
  245. * @brief get data size of aclDataBuffer
  246. *
  247. * @param dataBuffer [IN] pointer to the data of aclDataBuffer
  248. *
  249. * @retval data size
  250. */
  251. ACL_DEPRECATED_MESSAGE("aclGetDataBufferSize is deprecated, use aclGetDataBufferSizeV2 instead")
  252. ACL_FUNC_VISIBILITY uint32_t aclGetDataBufferSize(const aclDataBuffer *dataBuffer);
  253. /**
  254. * @ingroup AscendCL
  255. * @brief get data size of aclDataBuffer to replace aclGetDataBufferSize
  256. *
  257. * @param dataBuffer [IN] pointer to the data of aclDataBuffer
  258. *
  259. * @retval data size
  260. */
  261. ACL_FUNC_VISIBILITY size_t aclGetDataBufferSizeV2(const aclDataBuffer *dataBuffer);
  262. /**
  263. * @ingroup AscendCL
  264. * @brief get size of aclDataType
  265. *
  266. * @param dataType [IN] aclDataType data the size to get
  267. *
  268. * @retval size of the aclDataType
  269. */
  270. ACL_FUNC_VISIBILITY size_t aclDataTypeSize(aclDataType dataType);
  271. // interfaces of tensor desc
  272. /**
  273. * @ingroup AscendCL
  274. * @brief create data aclTensorDesc
  275. *
  276. * @param dataType [IN] Data types described by tensor
  277. * @param numDims [IN] the number of dimensions of the shape
  278. * @param dims [IN] the size of the specified dimension
  279. * @param format [IN] tensor format
  280. *
  281. * @retval aclTensorDesc pointer.
  282. * @retval nullptr if param is invalid or run out of memory
  283. */
  284. ACL_FUNC_VISIBILITY aclTensorDesc *aclCreateTensorDesc(aclDataType dataType,
  285. int numDims,
  286. const int64_t *dims,
  287. aclFormat format);
  288. /**
  289. * @ingroup AscendCL
  290. * @brief destroy data aclTensorDesc
  291. *
  292. * @param desc [IN] pointer to the data of aclTensorDesc to destroy
  293. */
  294. ACL_FUNC_VISIBILITY void aclDestroyTensorDesc(const aclTensorDesc *desc);
  295. /**
  296. * @ingroup AscendCL
  297. * @brief set tensor shape range for aclTensorDesc
  298. *
  299. * @param desc [OUT] pointer to the data of aclTensorDesc
  300. * @param dimsCount [IN] the number of dimensions of the shape
  301. * @param dimsRange [IN] the range of dimensions of the shape
  302. *
  303. * @retval ACL_SUCCESS The function is successfully executed.
  304. * @retval OtherValues Failure
  305. */
  306. ACL_FUNC_VISIBILITY aclError aclSetTensorShapeRange(aclTensorDesc* desc,
  307. size_t dimsCount,
  308. int64_t dimsRange[][ACL_TENSOR_SHAPE_RANGE_NUM]);
  309. /**
  310. * @ingroup AscendCL
  311. * @brief get data type specified by the tensor description
  312. *
  313. * @param desc [IN] pointer to the instance of aclTensorDesc
  314. *
  315. * @retval data type specified by the tensor description.
  316. * @retval ACL_DT_UNDEFINED if description is null
  317. */
  318. ACL_FUNC_VISIBILITY aclDataType aclGetTensorDescType(const aclTensorDesc *desc);
  319. /**
  320. * @ingroup AscendCL
  321. * @brief get data format specified by the tensor description
  322. *
  323. * @param desc [IN] pointer to the instance of aclTensorDesc
  324. *
  325. * @retval data format specified by the tensor description.
  326. * @retval ACL_FORMAT_UNDEFINED if description is null
  327. */
  328. ACL_FUNC_VISIBILITY aclFormat aclGetTensorDescFormat(const aclTensorDesc *desc);
  329. /**
  330. * @ingroup AscendCL
  331. * @brief get tensor size specified by the tensor description
  332. *
  333. * @param desc [IN] pointer to the instance of aclTensorDesc
  334. *
  335. * @retval data size specified by the tensor description.
  336. * @retval 0 if description is null
  337. */
  338. ACL_FUNC_VISIBILITY size_t aclGetTensorDescSize(const aclTensorDesc *desc);
  339. /**
  340. * @ingroup AscendCL
  341. * @brief get element count specified by the tensor description
  342. *
  343. * @param desc [IN] pointer to the instance of aclTensorDesc
  344. *
  345. * @retval element count specified by the tensor description.
  346. * @retval 0 if description is null
  347. */
  348. ACL_FUNC_VISIBILITY size_t aclGetTensorDescElementCount(const aclTensorDesc *desc);
  349. /**
  350. * @ingroup AscendCL
  351. * @brief get number of dims specified by the tensor description
  352. *
  353. * @param desc [IN] pointer to the instance of aclTensorDesc
  354. *
  355. * @retval number of dims specified by the tensor description.
  356. * @retval 0 if description is null
  357. * @retval ACL_UNKNOWN_RANK if the tensor dim is -2
  358. */
  359. ACL_FUNC_VISIBILITY size_t aclGetTensorDescNumDims(const aclTensorDesc *desc);
  360. /**
  361. * @ingroup AscendCL
  362. * @brief Get the size of the specified dim in the tensor description
  363. *
  364. * @param desc [IN] pointer to the instance of aclTensorDesc
  365. * @param index [IN] index of dims, start from 0.
  366. *
  367. * @retval dim specified by the tensor description and index.
  368. * @retval -1 if description or index is invalid
  369. */
  370. ACL_DEPRECATED_MESSAGE("aclGetTensorDescDim is deprecated, use aclGetTensorDescDimV2 instead")
  371. ACL_FUNC_VISIBILITY int64_t aclGetTensorDescDim(const aclTensorDesc *desc, size_t index);
  372. /**
  373. * @ingroup AscendCL
  374. * @brief Get the size of the specified dim in the tensor description
  375. *
  376. * @param desc [IN] pointer to the instance of aclTensorDesc
  377. * @param index [IN] index of dims, start from 0.
  378. * @param dimSize [OUT] size of the specified dim.
  379. *
  380. * @retval ACL_SUCCESS The function is successfully executed.
  381. * @retval OtherValues Failure
  382. */
  383. ACL_FUNC_VISIBILITY aclError aclGetTensorDescDimV2(const aclTensorDesc *desc, size_t index, int64_t *dimSize);
  384. /**
  385. * @ingroup AscendCL
  386. * @brief Get the range of the specified dim in the tensor description
  387. *
  388. * @param desc [IN] pointer to the instance of aclTensorDesc
  389. * @param index [IN] index of dims, start from 0.
  390. * @param dimRangeNum [IN] number of dimRange.
  391. * @param dimRange [OUT] range of the specified dim.
  392. *
  393. * @retval ACL_SUCCESS The function is successfully executed.
  394. * @retval OtherValues Failure
  395. */
  396. ACL_FUNC_VISIBILITY aclError aclGetTensorDescDimRange(const aclTensorDesc *desc,
  397. size_t index,
  398. size_t dimRangeNum,
  399. int64_t *dimRange);
  400. /**
  401. * @ingroup AscendCL
  402. * @brief set tensor description name
  403. *
  404. * @param desc [OUT] pointer to the instance of aclTensorDesc
  405. * @param name [IN] tensor description name
  406. */
  407. ACL_FUNC_VISIBILITY void aclSetTensorDescName(aclTensorDesc *desc, const char *name);
  408. /**
  409. * @ingroup AscendCL
  410. * @brief get tensor description name
  411. *
  412. * @param desc [IN] pointer to the instance of aclTensorDesc
  413. *
  414. * @retval tensor description name.
  415. * @retval empty string if description is null
  416. */
  417. ACL_FUNC_VISIBILITY const char *aclGetTensorDescName(aclTensorDesc *desc);
  418. /**
  419. * @ingroup AscendCL
  420. * @brief Convert the format in the source aclTensorDesc according to
  421. * the specified dstFormat to generate a new target aclTensorDesc.
  422. * The format in the source aclTensorDesc remains unchanged.
  423. *
  424. * @param srcDesc [IN] pointer to the source tensor desc
  425. * @param dstFormat [IN] destination format
  426. * @param dstDesc [OUT] pointer to the pointer to the destination tensor desc
  427. *
  428. * @retval ACL_SUCCESS The function is successfully executed.
  429. * @retval OtherValues Failure
  430. */
  431. ACL_FUNC_VISIBILITY aclError aclTransTensorDescFormat(const aclTensorDesc *srcDesc, aclFormat dstFormat,
  432. aclTensorDesc **dstDesc);
  433. /**
  434. * @ingroup AscendCL
  435. * @brief Set the storage format specified by the tensor description
  436. *
  437. * @param desc [OUT] pointer to the instance of aclTensorDesc
  438. * @param format [IN] the storage format
  439. *
  440. * @retval ACL_SUCCESS The function is successfully executed.
  441. * @retval OtherValues Failure
  442. */
  443. ACL_DEPRECATED_MESSAGE("aclSetTensorStorageFormat is deprecated, use aclSetTensorFormat instead")
  444. ACL_FUNC_VISIBILITY aclError aclSetTensorStorageFormat(aclTensorDesc *desc, aclFormat format);
  445. /**
  446. * @ingroup AscendCL
  447. * @brief Set the storage shape specified by the tensor description
  448. *
  449. * @param desc [OUT] pointer to the instance of aclTensorDesc
  450. * @param numDims [IN] the number of dimensions of the shape
  451. * @param dims [IN] the size of the specified dimension
  452. *
  453. * @retval ACL_SUCCESS The function is successfully executed.
  454. * @retval OtherValues Failure
  455. */
  456. ACL_DEPRECATED_MESSAGE("aclSetTensorStorageShape is deprecated, use aclSetTensorShape instead")
  457. ACL_FUNC_VISIBILITY aclError aclSetTensorStorageShape(aclTensorDesc *desc, int numDims, const int64_t *dims);
  458. /**
  459. * @ingroup AscendCL
  460. * @brief Set the format specified by the tensor description
  461. *
  462. * @param desc [OUT] pointer to the instance of aclTensorDesc
  463. * @param format [IN] the storage format
  464. *
  465. * @retval ACL_SUCCESS The function is successfully executed.
  466. * @retval OtherValues Failure
  467. */
  468. ACL_FUNC_VISIBILITY aclError aclSetTensorFormat(aclTensorDesc *desc, aclFormat format);
  469. /**
  470. * @ingroup AscendCL
  471. * @brief Set the shape specified by the tensor description
  472. *
  473. * @param desc [OUT] pointer to the instance of aclTensorDesc
  474. * @param numDims [IN] the number of dimensions of the shape
  475. * @param dims [IN] the size of the specified dimension
  476. *
  477. * @retval ACL_SUCCESS The function is successfully executed.
  478. * @retval OtherValues Failure
  479. */
  480. ACL_FUNC_VISIBILITY aclError aclSetTensorShape(aclTensorDesc *desc, int numDims, const int64_t *dims);
  481. /**
  482. * @ingroup AscendCL
  483. * @brief Set the original format specified by the tensor description
  484. *
  485. * @param desc [OUT] pointer to the instance of aclTensorDesc
  486. * @param format [IN] the storage format
  487. *
  488. * @retval ACL_SUCCESS The function is successfully executed.
  489. * @retval OtherValues Failure
  490. */
  491. ACL_FUNC_VISIBILITY aclError aclSetTensorOriginFormat(aclTensorDesc *desc, aclFormat format);
  492. /**
  493. * @ingroup AscendCL
  494. * @brief Set the original shape specified by the tensor description
  495. *
  496. * @param desc [OUT] pointer to the instance of aclTensorDesc
  497. * @param numDims [IN] the number of dimensions of the shape
  498. * @param dims [IN] the size of the specified dimension
  499. *
  500. * @retval ACL_SUCCESS The function is successfully executed.
  501. * @retval OtherValues Failure
  502. */
  503. ACL_FUNC_VISIBILITY aclError aclSetTensorOriginShape(aclTensorDesc *desc, int numDims, const int64_t *dims);
  504. /**
  505. * @ingroup AscendCL
  506. * @brief get op description info
  507. *
  508. * @param desc [IN] pointer to tensor description
  509. * @param index [IN] index of tensor
  510. *
  511. * @retval null for failed.
  512. * @retval OtherValues success.
  513. */
  514. ACL_FUNC_VISIBILITY aclTensorDesc *aclGetTensorDescByIndex(aclTensorDesc *desc, size_t index);
  515. /**
  516. * @ingroup AscendCL
  517. * @brief get address of tensor
  518. *
  519. * @param desc [IN] pointer to tensor description
  520. *
  521. * @retval null for failed
  522. * @retval OtherValues success
  523. */
  524. ACL_FUNC_VISIBILITY void *aclGetTensorDescAddress(const aclTensorDesc *desc);
  525. /**
  526. * @ingroup AscendCL
  527. * @brief Set the dynamic input name specified by the tensor description
  528. *
  529. * @param desc [OUT] pointer to the instance of aclTensorDesc
  530. * @param dynamicInputName [IN] pointer to the dynamic input name
  531. *
  532. * @retval ACL_SUCCESS The function is successfully executed.
  533. * @retval OtherValues Failure
  534. */
  535. ACL_FUNC_VISIBILITY aclError aclSetTensorDynamicInput(aclTensorDesc *desc, const char *dynamicInputName);
  536. /**
  537. * @ingroup AscendCL
  538. * @brief Set const data specified by the tensor description
  539. *
  540. * @param desc [OUT] pointer to the instance of aclTensorDesc
  541. * @param dataBuffer [IN] pointer to the const databuffer
  542. * @param length [IN] the length of const databuffer
  543. *
  544. * @retval ACL_SUCCESS The function is successfully executed.
  545. * @retval OtherValues Failure
  546. */
  547. ACL_FUNC_VISIBILITY aclError aclSetTensorConst(aclTensorDesc *desc, void *dataBuffer, size_t length);
  548. /**
  549. * @ingroup AscendCL
  550. * @brief an interface for users to output APP logs
  551. *
  552. * @param logLevel [IN] the level of current log
  553. * @param func [IN] the function where the log is located
  554. * @param file [IN] the file where the log is located
  555. * @param line [IN] Number of source lines where the log is located
  556. * @param fmt [IN] the format of current log
  557. * @param ... [IN] the value of current log
  558. */
  559. ACL_FUNC_VISIBILITY void aclAppLog(aclLogLevel logLevel, const char *func, const char *file, uint32_t line,
  560. const char *fmt, ...);
  561. #define ACL_APP_LOG(level, fmt, ...) \
  562. aclAppLog(level, __FUNCTION__, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
  563. #ifdef __cplusplus
  564. }
  565. #endif
  566. #endif // INC_EXTERNAL_ACL_ACL_BASE_H_

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