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

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