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.

kernel.h 23 kB

5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
3 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
3 years ago
5 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698
  1. /**
  2. * Copyright 2020 Huawei Technologies Co., Ltd
  3. * Licensed under the Apache License, Version 2.0 (the "License");
  4. * you may not use this file except in compliance with the License.
  5. * You may obtain a copy of the License at
  6. * http://www.apache.org/licenses/LICENSE-2.0
  7. * Unless required by applicable law or agreed to in writing, software
  8. * distributed under the License is distributed on an "AS IS" BASIS,
  9. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. * See the License for the specific language governing permissions and
  11. * limitations under the License.
  12. */
  13. #ifndef __CCE_RUNTIME_KERNEL_H__
  14. #define __CCE_RUNTIME_KERNEL_H__
  15. #include "base.h"
  16. #include "stream.h"
  17. #if defined(__cplusplus)
  18. extern "C" {
  19. #endif
  20. /**
  21. * @ingroup rt_kernel
  22. * @brief shared memory data control
  23. */
  24. typedef struct tagRtSmData {
  25. uint64_t L2_mirror_addr; // preload or swap source address
  26. uint32_t L2_data_section_size; // every data size
  27. uint8_t L2_preload; // 1 - preload from mirrorAddr, 0 - no preload
  28. uint8_t modified; // 1 - data will be modified by kernel, 0 - no modified
  29. uint8_t priority; // data priority
  30. int8_t prev_L2_page_offset_base; // remap source section offset
  31. uint8_t L2_page_offset_base; // remap destination section offset
  32. uint8_t L2_load_to_ddr; // 1 - need load out, 0 - no need
  33. uint8_t reserved[2]; // reserved
  34. } rtSmData_t;
  35. /**
  36. * @ingroup rt_kernel
  37. * @brief shared memory description
  38. */
  39. typedef struct tagRtSmCtrl {
  40. rtSmData_t data[8]; // data description
  41. uint64_t size; // max page Num
  42. uint8_t remap[64]; /* just using for static remap mode, default:0xFF
  43. array index: virtual l2 page id, array value: physic l2 page id */
  44. uint8_t l2_in_main; // 0-DDR, 1-L2, default:0xFF
  45. uint8_t reserved[3];
  46. } rtSmDesc_t;
  47. typedef rtSmDesc_t rtL2Ctrl_t;
  48. /**
  49. * @ingroup rt_kernel
  50. * @brief device binary type
  51. */
  52. typedef struct tagRtDevBinary {
  53. uint32_t magic; // magic number
  54. uint32_t version; // version of binary
  55. const void *data; // binary data
  56. uint64_t length; // binary length
  57. } rtDevBinary_t;
  58. /**
  59. * @ingroup rt_kernel
  60. * @brief function mode type
  61. */
  62. #define ONLINE_PROF_MAX_PMU_NUM (8)
  63. typedef struct ProfilefDataInfo {
  64. const void *stubFunc;
  65. uint32_t blockDim;
  66. const void *args;
  67. uint32_t argsSize;
  68. rtSmDesc_t *smDesc;
  69. rtStream_t stream;
  70. uint64_t totalcycle;
  71. uint64_t ovcycle;
  72. uint64_t pmu_cnt[ONLINE_PROF_MAX_PMU_NUM];
  73. } rtProfDataInfo_t;
  74. /**
  75. * @ingroup rt_kernel
  76. * @brief function mode type
  77. */
  78. typedef enum {
  79. FUNC_MODE_NORMAL = 0,
  80. FUNC_MODE_PCTRACE_USERPROFILE_RECORDLOOP,
  81. FUNC_MODE_PCTRACE_USERPROFILE_SKIPLOOP,
  82. FUNC_MODE_PCTRACE_CYCLECNT_RECORDLOOP,
  83. FUNC_MODE_PCTRACE_CYCLECNT_SKIPLOOP,
  84. FUNC_MODE_BUTT
  85. } rtFuncModeType_t;
  86. /**
  87. * @ingroup rt_kernel
  88. * @brief kernel info
  89. */
  90. typedef struct rtKernelInfo {
  91. uint64_t task_offset; // kernel offset in module
  92. /* flowtable */
  93. void *arg; // launch kernel arg
  94. uint32_t arg_size;
  95. /* module */
  96. void *module_addr; // module::baseaddr_
  97. uint32_t module_size;
  98. } *rtKernelInfo_t;
  99. /**
  100. * @ingroup rt_kernel
  101. * @brief op name
  102. */
  103. typedef struct rtKernelLaunchNames {
  104. const char *soName; // defined for so name
  105. const char *kernelName; // defined for kernel type name
  106. const char *opName; // defined for operator name
  107. } rtKernelLaunchNames_t;
  108. /**
  109. * @ingroup rt_kernel
  110. * @brief args struct
  111. */
  112. typedef struct tagRtArgsWithTiling {
  113. void *args; // args host mem addr
  114. uint32_t argsSize; // input + output + tiling addr size + tiling data size
  115. uint32_t argsSizeWithoutTiling; // input + output + tiling addr size
  116. uint16_t tilingAddrOffset; // tiling addr offset
  117. uint16_t tilingDataOffset; // tiling data offset
  118. uint16_t reserved[2];
  119. } rtArgsWithTiling_t;
  120. /**
  121. * @ingroup rt_KernelConfigDump
  122. * @brief device dump type
  123. */
  124. typedef enum tagRtDumpKind {
  125. RT_DATA_DUMP_KIND_INVALID = -1,
  126. RT_DATA_DUMP_KIND_DUMP = 0,
  127. RT_DATA_DUMP_KIND_RESERVED
  128. } rtDumpKind_t;
  129. /**
  130. * @ingroup rt_kernel
  131. * @brief report callback
  132. */
  133. typedef rtError_t (*rtKernelReportCallback)(rtStream_t stream, rtKernelInfo_t kernelInfo);
  134. /**
  135. * @ingroup rt_kernel
  136. * @brief stream report callback
  137. */
  138. typedef void (*rtCallback_t)(void *fnData);
  139. /**
  140. * @ingroup rt_kernel
  141. * @brief magic number of plain binary for aicore
  142. */
  143. #define RT_DEV_BINARY_MAGIC_PLAIN 0xabceed50
  144. /**
  145. * @ingroup rt_kernel
  146. * @brief magic number of plain binary for aicpu
  147. */
  148. #define RT_DEV_BINARY_MAGIC_PLAIN_AICPU 0xabceed51
  149. /**
  150. * @ingroup rt_kernel
  151. * @brief magic number of plain binary for aivector
  152. */
  153. #define RT_DEV_BINARY_MAGIC_PLAIN_AIVEC 0xabceed52
  154. /**
  155. * @ingroup rt_kernel
  156. * @brief magic number of elf binary for aicore
  157. */
  158. #define RT_DEV_BINARY_MAGIC_ELF 0x43554245
  159. /**
  160. * @ingroup rt_kernel
  161. * @brief magic number of elf binary for aicpu
  162. */
  163. #define RT_DEV_BINARY_MAGIC_ELF_AICPU 0x41415243
  164. /**
  165. * @ingroup rt_kernel
  166. * @brief magic number of elf binary for aivector
  167. */
  168. #define RT_DEV_BINARY_MAGIC_ELF_AIVEC 0x41415246
  169. /**
  170. * @ingroup rt_kernel
  171. * @brief magic number of elf binary for aicube
  172. */
  173. #define RT_DEV_BINARY_MAGIC_ELF_AICUBE 0x41494343
  174. /**
  175. * @ingroup rt_kernel_flags
  176. * @brief kernel op bit flags
  177. */
  178. #define RT_KERNEL_DEFAULT (0x00)
  179. #define RT_KERNEL_CONVERT (0x01)
  180. #define RT_KERNEL_DUMPFLAG (0x02)
  181. #define RT_FUSION_KERNEL_DUMPFLAG (0x04)
  182. #define RT_KERNEL_CUSTOM_AICPU (0x08)
  183. // STARS topic scheduler sqe : topic_type
  184. #define RT_KERNEL_DEVICE_FIRST (0x10)
  185. #define RT_KERNEL_HOST_ONLY (0x20)
  186. #define RT_KERNEL_HOST_FIRST (0x40)
  187. /**
  188. * @ingroup rt_kernel
  189. * @brief kernel mode
  190. **/
  191. #define RT_DEFAULT_KERNEL_MODE (0x00)
  192. #define RT_NORMAL_KERNEL_MODE (0x01)
  193. #define RT_ALL_KERNEL_MODE (0x02)
  194. /**
  195. * @ingroup rt_kernel
  196. * @brief kernel L1 Fusion Dump bit flags
  197. */
  198. #define RT_DDR_ADDR (0x0)
  199. /**
  200. * @ingroup rt_kernel
  201. * @brief register device binary
  202. * @param [in] bin device binary description
  203. * @param [out] handle device binary handle
  204. * @return RT_ERROR_NONE for ok
  205. * @return RT_ERROR_INVALID_VALUE for error input
  206. */
  207. RTS_API rtError_t rtDevBinaryRegister(const rtDevBinary_t *bin, void **handle);
  208. /**
  209. * @ingroup rt_kernel
  210. * @brief register device binary with all kernel
  211. * @param [in] bin device binary description
  212. * @param [out] handle device binary handle
  213. * @return RT_ERROR_NONE for ok
  214. * @return RT_ERROR_INVALID_VALUE for error input
  215. */
  216. RTS_API rtError_t rtRegisterAllKernel(const rtDevBinary_t *bin, void **handle);
  217. /**
  218. * @ingroup rt_kernel
  219. * @brief register fast memeory device binary
  220. * @param [in] handle device binary handle
  221. * @return RT_ERROR_NONE for ok
  222. * @return RT_ERROR_INVALID_VALUE for error input
  223. */
  224. RTS_API rtError_t rtBinaryRegisterToFastMemory(void *handle);
  225. /**
  226. * @ingroup rt_kernel
  227. * @brief unregister device binary
  228. * @param [in] handle device binary handle
  229. * @return RT_ERROR_NONE for ok
  230. * @return RT_ERROR_INVALID_VALUE for error input
  231. */
  232. RTS_API rtError_t rtDevBinaryUnRegister(void *handle);
  233. /**
  234. * @ingroup rt_kernel
  235. * @brief register device binary metadata
  236. * @param [in] handle device binary description
  237. * @param [in] metadata device binary metadata
  238. * @return RT_ERROR_NONE for ok
  239. * @return RT_ERROR_INVALID_VALUE for error input
  240. */
  241. RTS_API rtError_t rtMetadataRegister(void *handle, const char *metadata);
  242. /**
  243. * @ingroup rt_kernel
  244. * @brief register device binary dependency
  245. * @param [in] mHandle master device binary description
  246. * @param [in] sHandle slave device binary description
  247. * @return RT_ERROR_NONE for ok
  248. * @return RT_ERROR_INVALID_VALUE for error input
  249. */
  250. RTS_API rtError_t rtDependencyRegister(void *mHandle, void *sHandle);
  251. /**
  252. * @ingroup rt_kernel
  253. * @brief register device function
  254. * @param [in] binHandle device binary handle
  255. * @param [in] stubFunc stub function
  256. * @param [in] stubName stub function name
  257. * @param [in] devFunc device function description. symbol name or address
  258. * offset, depending binary type.
  259. * @return RT_ERROR_NONE for ok
  260. * @return RT_ERROR_INVALID_VALUE for error input
  261. */
  262. RTS_API rtError_t rtFunctionRegister(void *binHandle, const void *stubFunc, const char *stubName, const void *devFunc,
  263. uint32_t funcMode);
  264. /**
  265. * @ingroup rt_kernel
  266. * @brief find stub function by name
  267. * @param [in] stubName stub function name
  268. * @param [out] stubFunc stub function
  269. * @return RT_ERROR_NONE for ok
  270. * @return RT_ERROR_INVALID_VALUE for error input
  271. */
  272. RTS_API rtError_t rtGetFunctionByName(const char *stubName, void **stubFunc);
  273. /**
  274. * @ingroup rt_kernel
  275. * @brief find addr by stub func
  276. * @param [in] stubFunc stub function
  277. * @param [out] addr
  278. * @return RT_ERROR_NONE for ok
  279. * @return RT_ERROR_INVALID_VALUE for error input
  280. */
  281. RTS_API rtError_t rtGetAddrByFun(const void *stubFunc, void **addr);
  282. /**
  283. * @ingroup rt_kernel
  284. * @brief query registered or not by stubName
  285. * @param [in] stubName stub function name
  286. * @return RT_ERROR_NONE for ok
  287. * @return RT_ERROR_INVALID_VALUE for error input
  288. */
  289. RTS_API rtError_t rtQueryFunctionRegistered(const char *stubName);
  290. /**
  291. * @ingroup rt_kernel
  292. * @brief config data dump
  293. * @param [in] dumpSizePerBlock dump size
  294. * @param [in] blockDim block dimentions
  295. * @param [in] dumpBaseAddr dump base address
  296. * @return RT_ERROR_NONE for ok
  297. * @return RT_ERROR_INVALID_VALUE for error input
  298. */
  299. RTS_API rtError_t rtKernelConfigDump(uint32_t kind, uint32_t dumpSizePerBlock, uint32_t blockDim, void **dumpBaseAddr,
  300. rtStream_t stream);
  301. /**
  302. * @ingroup rt_kernel
  303. * @brief launch kernel to device
  304. * @param [in] stubFunc stub function
  305. * @param [in] blockDim block dimentions
  306. * @param [in] args argments address for kernel function
  307. * @param [in] argsSize argements size
  308. * @param [in] smDesc shared memory description
  309. * @param [in] stream associated stream
  310. * @return RT_ERROR_NONE for ok
  311. * @return RT_ERROR_INVALID_VALUE for error input
  312. */
  313. RTS_API rtError_t rtKernelLaunch(const void *stubFunc, uint32_t blockDim, void *args, uint32_t argsSize,
  314. rtSmDesc_t *smDesc, rtStream_t stream);
  315. /**
  316. * @ingroup rt_kernel
  317. * @brief launch kernel with handle to device
  318. * @param [in] handle program
  319. * @param [in] devFunc device function description.
  320. * @param [in] blockDim block dimentions
  321. * @param [in] args argments address for kernel function
  322. * @param [in] argsSize argements size
  323. * @param [in] smDesc shared memory description
  324. * @param [in] stream associated stream
  325. * @param [in] kernelInfo kernel info
  326. * @return RT_ERROR_NONE for ok
  327. * @return RT_ERROR_INVALID_VALUE for error input
  328. */
  329. RTS_API rtError_t rtKernelLaunchWithHandle(void *handle, const void *devFunc, uint32_t blockDim, void *args, uint32_t argsSize,
  330. rtSmDesc_t *smDesc, rtStream_t stream_, const void *kernelInfo);
  331. /**
  332. * @ingroup rt_kernel
  333. * @brief launch kernel to device
  334. * @param [in] stubFunc stub function
  335. * @param [in] blockDim block dimentions
  336. * @param [in] args argments address for kernel function
  337. * @param [in] argsSize argements size
  338. * @param [in] smDesc shared memory description
  339. * @param [in] stream associated stream
  340. * @param [in] flag dump flag
  341. * @return RT_ERROR_NONE for ok
  342. * @return RT_ERROR_INVALID_VALUE for error input
  343. */
  344. RTS_API rtError_t rtKernelLaunchWithFlag(const void *stubFunc, uint32_t blockDim, void *args, uint32_t argsSize,
  345. rtSmDesc_t *smDesc, rtStream_t stream, uint32_t flags);
  346. /**
  347. * @ingroup rt_kernel(abandoned)
  348. * @brief launch kernel to device
  349. * @param [in] args argments address for kernel function
  350. * @param [in] argsSize argements size
  351. * @param [in] flags launch flags
  352. * @param [in] stream associated stream
  353. * @return RT_ERROR_NONE for ok
  354. * @return RT_ERROR_INVALID_VALUE for error input
  355. */
  356. RTS_API rtError_t rtKernelLaunchEx(void *args, uint32_t argsSize, uint32_t flags, rtStream_t stream);
  357. /**
  358. * @ingroup rt_kernel(in use)
  359. * @brief launch kernel to device
  360. * @param [in] opName opkernel name
  361. * @param [in] args argments address for kernel function
  362. * @param [in] argsSize argements size
  363. * @param [in] flags launch flags
  364. * @param [in] stream associated stream
  365. * @return RT_ERROR_NONE for ok
  366. * @return RT_ERROR_INVALID_VALUE for error input
  367. */
  368. RTS_API rtError_t rtKernelLaunchFwk(const char *opName, void *args, uint32_t argsSize, uint32_t flags,
  369. rtStream_t rtStream);
  370. /**
  371. * @ingroup rt_kernel(abandoned)
  372. * @brief launch cpu kernel to device
  373. * @param [in] soName so name
  374. * @param [in] kernelName kernel name
  375. * @param [in] blockDim block dimentions
  376. * @param [in] args argments address for kernel function
  377. * @param [in] argsSize argments size
  378. * @param [in] smDesc shared memory description
  379. * @param [in] stream associated stream
  380. * @return RT_ERROR_NONE for ok
  381. * @return RT_ERROR_INVALID_VALUE for error input
  382. */
  383. RTS_API rtError_t rtCpuKernelLaunch(const void *soName, const void *kernelName, uint32_t blockDim, const void *args,
  384. uint32_t argsSize, rtSmDesc_t *smDesc, rtStream_t stream);
  385. /**
  386. * @ingroup rt_kernel(in use)
  387. * @brief launch cpu kernel to device
  388. * @param [in] launchNames names for kernel launch
  389. * @param [in] blockDim block dimentions
  390. * @param [in] args argments address for kernel function
  391. * @param [in] argsSize argments size
  392. * @param [in] smDesc shared memory description
  393. * @param [in] stream associated stream
  394. * @return RT_ERROR_NONE for ok
  395. * @return RT_ERROR_INVALID_VALUE for error input
  396. */
  397. RTS_API rtError_t rtAicpuKernelLaunch(const rtKernelLaunchNames_t *launchNames,
  398. uint32_t blockDim, const void *args, uint32_t argsSize, rtSmDesc_t *smDesc, rtStream_t stream);
  399. /**
  400. * @ingroup rt_kernel(abandoned)
  401. * @brief launch cpu kernel to device with dump identifier
  402. * @param [in] soName so name
  403. * @param [in] kernelName kernel name
  404. * @param [in] blockDim block dimentions
  405. * @param [in] args argments address for kernel function
  406. * @param [in] argsSize argments size
  407. * @param [in] smDesc shared memory description
  408. * @param [in] stream associated stream
  409. * @param [in] flag dump flag or others function flag
  410. * @return RT_ERROR_NONE for ok
  411. * @return RT_ERROR_INVALID_VALUE for error input
  412. */
  413. RTS_API rtError_t rtCpuKernelLaunchWithFlag(const void *soName, const void *kernelName, uint32_t blockDim,
  414. const void *args, uint32_t argsSize, rtSmDesc_t *smDesc, rtStream_t stream,
  415. uint32_t flags);
  416. /**
  417. * @ingroup rt_kernel(in use)
  418. * @brief launch cpu kernel to device with dump identifier
  419. * @param [in] launchNames names for kernel launch
  420. * @param [in] blockDim block dimentions
  421. * @param [in] args argments address for kernel function
  422. * @param [in] argsSize argments size
  423. * @param [in] smDesc shared memory description
  424. * @param [in] stream associated stream
  425. * @param [in] flag dump flag or others function flag
  426. * @return RT_ERROR_NONE for ok
  427. * @return RT_ERROR_INVALID_VALUE for error input
  428. */
  429. RTS_API rtError_t rtAicpuKernelLaunchWithFlag(const rtKernelLaunchNames_t *launchNames, uint32_t blockDim,
  430. const void *args, uint32_t argsSize, rtSmDesc_t *smDesc, rtStream_t stream, uint32_t flags);
  431. /**
  432. * @ingroup rt_kernel
  433. * @brief L1 fusion dump addr transfered to device
  434. * @param [in] model handle info
  435. * @param [in] addr ddr address of L1 Fusion Dump
  436. * @param [in] dumpSize memory size
  437. * @param [in] flag memory flag
  438. * @return RT_ERROR_NONE for ok
  439. * @return RT_ERROR_INVALID_VALUE for error input
  440. */
  441. RTS_API rtError_t rtDumpAddrSet(rtModel_t model, void *addr, uint32_t dumpSize, uint32_t flag);
  442. /**
  443. * @ingroup rt_kernel
  444. * @brief load dump info to aicpu
  445. * @param [in] dumpInfo dump info
  446. * @param [in] length length of dump info
  447. * @return RT_ERROR_NONE for ok
  448. * @return RT_ERROR_INVALID_VALUE for error input
  449. */
  450. RTS_API rtError_t rtDatadumpInfoLoad(const void *dumpInfo, uint32_t length);
  451. #ifndef __CLANG_CCE_RUNTIME_H__
  452. #define __CLANG_CCE_RUNTIME_H__
  453. /**
  454. * @ingroup rt_kernel
  455. * @brief configure call argment for next rtLaunch in current thread
  456. * @param [in] numBlocks block dimentions
  457. * @param [in] smDesc shared memory description
  458. * @param [in] stream associated stream
  459. * @return RT_ERROR_NONE for ok
  460. * @return RT_ERROR_INVALID_VALUE for error input
  461. */
  462. #ifdef __cplusplus
  463. RTS_API rtError_t rtConfigureCall(uint32_t numBlocks, rtSmDesc_t *smDesc = nullptr, rtStream_t stream = nullptr);
  464. #else
  465. RTS_API rtError_t rtConfigureCall(uint32_t numBlocks, rtSmDesc_t *smDesc, rtStream_t stream);
  466. #endif
  467. #endif // __CLANG_CCE_RUNTIME_H__
  468. /**
  469. * @ingroup rt_kernel
  470. * @brief setup argment for next rtLaunch in current thread
  471. * @param [in] arg argment address for kernel function
  472. * @param [in] size argment size
  473. * @param [in] offset argment table offset
  474. * @return RT_ERROR_NONE for ok
  475. * @return RT_ERROR_INVALID_VALUE for error input
  476. */
  477. RTS_API rtError_t rtSetupArgument(const void *arg, uint32_t size, uint32_t offset);
  478. /**
  479. * @ingroup rt_kernel
  480. * @brief launch kernel to device with previous setting kernel argment
  481. * and call argment
  482. * @param [in] stubFunc stub function
  483. * @return RT_ERROR_NONE for ok
  484. * @return RT_ERROR_INVALID_VALUE for error input
  485. */
  486. RTS_API rtError_t rtLaunch(const void *stubFunc);
  487. /**
  488. * @ingroup rt_kernel
  489. * @brief implicitly transfered data to device.
  490. * lifecycle end after next kernel task finish
  491. * @param [in] ptr host memory
  492. * @param [in] size host memory size
  493. * @param [in] flag reserved. set to 0
  494. * @param [out] arg returned arg. used for next kernel's arg.
  495. * @return RT_ERROR_NONE for ok
  496. * @return RT_ERROR_INVALID_VALUE for error input
  497. */
  498. RTS_API rtError_t rtKernelConfigTransArg(const void *ptr, uint64_t size, uint32_t flag, void **arg);
  499. /**
  500. * @ingroup rt_kernel
  501. * @brief start fusion kernels.
  502. * @param [in] stream stream for fusion kernels
  503. * @return RT_ERROR_NONE for ok
  504. * @return RT_ERROR_INVALID_VALUE for error input
  505. */
  506. RTS_API rtError_t rtKernelFusionStart(rtStream_t stream);
  507. /**
  508. * @ingroup rt_kernel
  509. * @brief end fusion kernels.
  510. * @param [in] stream stream for fusion kernels
  511. * @return RT_ERROR_NONE for ok
  512. * @return RT_ERROR_INVALID_VALUE for error input
  513. */
  514. RTS_API rtError_t rtKernelFusionEnd(rtStream_t stream);
  515. /**
  516. * @ingroup rt_kernel
  517. * @brief set kernelinfo callback
  518. * @param [in] callback
  519. * @return RT_ERROR_NONE for ok
  520. * @return RT_ERROR_INVALID_VALUE for error input
  521. */
  522. RTS_API rtError_t rtSetKernelReportCallback(rtKernelReportCallback callBack);
  523. /**
  524. * @ingroup rt_kernel
  525. * @brief subscribe stream callback report.
  526. * @param [in] threadId thread id for stream
  527. * @param [in] stream stream for subscribe
  528. * @return RT_ERROR_NONE for ok
  529. * @return RT_ERROR_INVALID_VALUE for error input
  530. */
  531. RTS_API rtError_t rtSubscribeReport(uint64_t threadId, rtStream_t stream);
  532. /**
  533. * @ingroup rt_kernel
  534. * @brief add callback launch task in stream.
  535. * @param [in] callBackFunc app callback function
  536. * @param [in] fnData user data
  537. * @param [in] stream subscribed stream
  538. * @return RT_ERROR_NONE for ok
  539. * @return RT_ERROR_INVALID_VALUE for error input
  540. */
  541. RTS_API rtError_t rtCallbackLaunch(rtCallback_t callBackFunc, void *fnData, rtStream_t stream, bool isBlock);
  542. /**
  543. * @ingroup rt_kernel
  544. * @brief process callback report.
  545. * @param [in] timeout if timeout=-1, while(1); else timeout
  546. * @return RT_ERROR_NONE for ok
  547. * @return RT_ERROR_INVALID_VALUE for error input
  548. */
  549. RTS_API rtError_t rtProcessReport(int32_t timeout);
  550. /**
  551. * @ingroup rt_kernel
  552. * @brief unsubscribe callback report.
  553. * @param [in] threadId thread id for stream
  554. * @param [in] stream stream for subscribe
  555. * @return RT_ERROR_NONE for ok
  556. * @return RT_ERROR_INVALID_VALUE for error input
  557. */
  558. RTS_API rtError_t rtUnSubscribeReport(uint64_t threadId, rtStream_t stream);
  559. /**
  560. * @ingroup profiling_base
  561. * @brief start online prof.
  562. * @return RT_ERROR_NONE for ok
  563. * @return RT_ERROR_INVALID_VALUE for error input
  564. */
  565. RTS_API rtError_t rtStartOnlineProf(rtStream_t stream, uint32_t sampleNum);
  566. /**
  567. * @ingroup profiling_base
  568. * @brief stop online prof.
  569. * @return RT_ERROR_NONE for ok
  570. * @return RT_ERROR_INVALID_VALUE for error input
  571. */
  572. RTS_API rtError_t rtStopOnlineProf(rtStream_t stream);
  573. /**
  574. * @ingroup profiling_base
  575. * @brief get online prof.
  576. * @return RT_ERROR_NONE for ok
  577. * @return RT_ERROR_INVALID_VALUE for error input
  578. */
  579. RTS_API rtError_t rtGetOnlineProfData(rtStream_t stream, rtProfDataInfo_t *pProfData, uint32_t profDataNum);
  580. /**
  581. * @ingroup profiling_base
  582. * @brief start mdc profiler.
  583. * @return RT_ERROR_NONE for ok
  584. * @return RT_ERROR_INVALID_VALUE for error input
  585. */
  586. RTS_API rtError_t rtStartMDCProfiler(void **addr, uint32_t length);
  587. /**
  588. * @ingroup profiling_base
  589. * @brief stop mdc profiler.
  590. * @return RT_ERROR_NONE for ok
  591. * @return RT_ERROR_INVALID_VALUE for error input
  592. */
  593. RTS_API rtError_t rtStopMDCProfiler(void *addr);
  594. /**
  595. * @ingroup rt_kernel
  596. * @brief launch kernel with tiling data to device
  597. * @param [in] stubFunc stub function
  598. * @param [in] blockDim block dimentions
  599. * @param [in] argsInfo argments info address for kernel function
  600. * @param [in] smDesc shared memory description
  601. * @param [in] stream associated stream
  602. * @return RT_ERROR_NONE for ok
  603. * @return RT_ERROR_INVALID_VALUE for error input
  604. */
  605. RTS_API rtError_t rtKernelLaunchWithTiling(const void *stubFunc, uint32_t blockDim,
  606. rtArgsWithTiling_t *argsInfo, rtSmDesc_t *smDesc, rtStream_t stream_);
  607. /**
  608. * @ingroup rt_kernel
  609. * @brief launch kernel with handle and tiling data to device
  610. * @param [in] handle program
  611. * @param [in] devFunc device function description.
  612. * @param [in] blockDim block dimentions
  613. * @param [in] argsInfo argments info address for kernel function
  614. * @param [in] smDesc shared memory description
  615. * @param [in] stream associated stream
  616. * @param [in] kernelInfo kernel info
  617. * @return RT_ERROR_NONE for ok
  618. * @return RT_ERROR_INVALID_VALUE for error input
  619. */
  620. RTS_API rtError_t rtKernelLaunchWithHandleAndTiling(void *handle, const void *devFunc, uint32_t blockDim,
  621. rtArgsWithTiling_t *argsInfo, rtSmDesc_t *smDesc, rtStream_t stream_, const void* kernelInfo);
  622. #if defined(__cplusplus)
  623. }
  624. #endif
  625. #endif // __CCE_RUNTIME_KERNEL_H__

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