ggml-backend.c 66 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842
  1. #include "ggml-backend-impl.h"
  2. #include "ggml-alloc.h"
  3. #include "ggml-impl.h"
  4. #include <assert.h>
  5. #include <limits.h>
  6. #include <stdarg.h>
  7. #include <stdio.h>
  8. #include <stdlib.h>
  9. #include <string.h>
  10. #define MAX(a, b) ((a) > (b) ? (a) : (b))
  11. // backend buffer type
  12. const char * ggml_backend_buft_name(ggml_backend_buffer_type_t buft) {
  13. return buft->iface.get_name(buft);
  14. }
  15. GGML_CALL ggml_backend_buffer_t ggml_backend_buft_alloc_buffer(ggml_backend_buffer_type_t buft, size_t size) {
  16. return buft->iface.alloc_buffer(buft, size);
  17. }
  18. size_t ggml_backend_buft_get_alignment(ggml_backend_buffer_type_t buft) {
  19. return buft->iface.get_alignment(buft);
  20. }
  21. size_t ggml_backend_buft_get_max_size(ggml_backend_buffer_type_t buft) {
  22. // get_max_size is optional, defaults to SIZE_MAX
  23. if (buft->iface.get_max_size) {
  24. return buft->iface.get_max_size(buft);
  25. }
  26. return SIZE_MAX;
  27. }
  28. GGML_CALL size_t ggml_backend_buft_get_alloc_size(ggml_backend_buffer_type_t buft, struct ggml_tensor * tensor) {
  29. // get_alloc_size is optional, defaults to ggml_nbytes
  30. if (buft->iface.get_alloc_size) {
  31. size_t size = buft->iface.get_alloc_size(buft, tensor);
  32. assert(size >= ggml_nbytes(tensor));
  33. return size;
  34. }
  35. return ggml_nbytes(tensor);
  36. }
  37. bool ggml_backend_buft_supports_backend(ggml_backend_buffer_type_t buft, ggml_backend_t backend) {
  38. return buft->iface.supports_backend(buft, backend);
  39. }
  40. bool ggml_backend_buft_is_host(ggml_backend_buffer_type_t buft) {
  41. if (buft->iface.is_host) {
  42. return buft->iface.is_host(buft);
  43. }
  44. return false;
  45. }
  46. // backend buffer
  47. GGML_CALL ggml_backend_buffer_t ggml_backend_buffer_init(
  48. ggml_backend_buffer_type_t buft,
  49. struct ggml_backend_buffer_i iface,
  50. ggml_backend_buffer_context_t context,
  51. size_t size) {
  52. ggml_backend_buffer_t buffer = malloc(sizeof(struct ggml_backend_buffer));
  53. (*buffer) = (struct ggml_backend_buffer) {
  54. /* .interface = */ iface,
  55. /* .buft = */ buft,
  56. /* .context = */ context,
  57. /* .size = */ size,
  58. /* .usage = */ GGML_BACKEND_BUFFER_USAGE_ANY
  59. };
  60. return buffer;
  61. }
  62. const char * ggml_backend_buffer_name(ggml_backend_buffer_t buffer) {
  63. return buffer->iface.get_name(buffer);
  64. }
  65. void ggml_backend_buffer_free(ggml_backend_buffer_t buffer) {
  66. if (buffer == NULL) {
  67. return;
  68. }
  69. if (buffer->iface.free_buffer != NULL) {
  70. buffer->iface.free_buffer(buffer);
  71. }
  72. free(buffer);
  73. }
  74. size_t ggml_backend_buffer_get_size(ggml_backend_buffer_t buffer) {
  75. return buffer->size;
  76. }
  77. void * ggml_backend_buffer_get_base(ggml_backend_buffer_t buffer) {
  78. void * base = buffer->iface.get_base(buffer);
  79. GGML_ASSERT(base != NULL && "backend buffer base cannot be NULL");
  80. return base;
  81. }
  82. GGML_CALL void ggml_backend_buffer_init_tensor(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor) {
  83. // init_tensor is optional
  84. if (buffer->iface.init_tensor) {
  85. buffer->iface.init_tensor(buffer, tensor);
  86. }
  87. }
  88. size_t ggml_backend_buffer_get_alignment (ggml_backend_buffer_t buffer) {
  89. return ggml_backend_buft_get_alignment(ggml_backend_buffer_get_type(buffer));
  90. }
  91. size_t ggml_backend_buffer_get_max_size(ggml_backend_buffer_t buffer) {
  92. return ggml_backend_buft_get_max_size(ggml_backend_buffer_get_type(buffer));
  93. }
  94. size_t ggml_backend_buffer_get_alloc_size(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor) {
  95. return ggml_backend_buft_get_alloc_size(ggml_backend_buffer_get_type(buffer), tensor);
  96. }
  97. void ggml_backend_buffer_clear(ggml_backend_buffer_t buffer, uint8_t value) {
  98. buffer->iface.clear(buffer, value);
  99. }
  100. bool ggml_backend_buffer_is_host(ggml_backend_buffer_t buffer) {
  101. return ggml_backend_buft_is_host(ggml_backend_buffer_get_type(buffer));
  102. }
  103. void ggml_backend_buffer_set_usage(ggml_backend_buffer_t buffer, enum ggml_backend_buffer_usage usage) {
  104. buffer->usage = usage;
  105. // FIXME: add a generic callback to the buffer interface
  106. if (ggml_backend_buffer_is_multi_buffer(buffer)) {
  107. ggml_backend_multi_buffer_set_usage(buffer, usage);
  108. }
  109. }
  110. ggml_backend_buffer_type_t ggml_backend_buffer_get_type(ggml_backend_buffer_t buffer) {
  111. return buffer->buft;
  112. }
  113. void ggml_backend_buffer_reset(ggml_backend_buffer_t buffer) {
  114. if (buffer->iface.reset) {
  115. buffer->iface.reset(buffer);
  116. }
  117. }
  118. bool ggml_backend_buffer_copy_tensor(const struct ggml_tensor * src, struct ggml_tensor * dst) {
  119. ggml_backend_buffer_t dst_buf = dst->view_src ? dst->view_src->buffer : dst->buffer;
  120. if (dst_buf->iface.cpy_tensor) {
  121. return src->buffer->iface.cpy_tensor(dst_buf, src, dst);
  122. }
  123. return false;
  124. }
  125. // backend
  126. ggml_guid_t ggml_backend_guid(ggml_backend_t backend) {
  127. if (backend == NULL) {
  128. return NULL;
  129. }
  130. return backend->guid;
  131. }
  132. const char * ggml_backend_name(ggml_backend_t backend) {
  133. if (backend == NULL) {
  134. return "NULL";
  135. }
  136. return backend->iface.get_name(backend);
  137. }
  138. void ggml_backend_free(ggml_backend_t backend) {
  139. if (backend == NULL) {
  140. return;
  141. }
  142. backend->iface.free(backend);
  143. }
  144. ggml_backend_buffer_type_t ggml_backend_get_default_buffer_type(ggml_backend_t backend) {
  145. return backend->iface.get_default_buffer_type(backend);
  146. }
  147. ggml_backend_buffer_t ggml_backend_alloc_buffer(ggml_backend_t backend, size_t size) {
  148. return ggml_backend_buft_alloc_buffer(ggml_backend_get_default_buffer_type(backend), size);
  149. }
  150. size_t ggml_backend_get_alignment(ggml_backend_t backend) {
  151. return ggml_backend_buft_get_alignment(ggml_backend_get_default_buffer_type(backend));
  152. }
  153. size_t ggml_backend_get_max_size(ggml_backend_t backend) {
  154. return ggml_backend_buft_get_max_size(ggml_backend_get_default_buffer_type(backend));
  155. }
  156. void ggml_backend_tensor_set_async(ggml_backend_t backend, struct ggml_tensor * tensor, const void * data, size_t offset, size_t size) {
  157. GGML_ASSERT(tensor->data != NULL && "tensor not allocated");
  158. GGML_ASSERT(offset + size <= ggml_nbytes(tensor) && "tensor write out of bounds");
  159. if (backend->iface.set_tensor_async == NULL) {
  160. ggml_backend_tensor_set(tensor, data, offset, size);
  161. } else {
  162. backend->iface.set_tensor_async(backend, tensor, data, offset, size);
  163. }
  164. }
  165. void ggml_backend_tensor_get_async(ggml_backend_t backend, const struct ggml_tensor * tensor, void * data, size_t offset, size_t size) {
  166. GGML_ASSERT(tensor->data != NULL && "tensor not allocated");
  167. GGML_ASSERT(offset + size <= ggml_nbytes(tensor) && "tensor read out of bounds");
  168. if (backend->iface.get_tensor_async == NULL) {
  169. ggml_backend_tensor_get(tensor, data, offset, size);
  170. } else {
  171. backend->iface.get_tensor_async(backend, tensor, data, offset, size);
  172. }
  173. }
  174. GGML_CALL void ggml_backend_tensor_set(struct ggml_tensor * tensor, const void * data, size_t offset, size_t size) {
  175. ggml_backend_buffer_t buf = tensor->view_src ? tensor->view_src->buffer : tensor->buffer;
  176. GGML_ASSERT(tensor->data != NULL && "tensor not allocated");
  177. GGML_ASSERT(buf != NULL && "tensor buffer not set");
  178. GGML_ASSERT(offset + size <= ggml_nbytes(tensor) && "tensor write out of bounds");
  179. if (!size) {
  180. return;
  181. }
  182. tensor->buffer->iface.set_tensor(buf, tensor, data, offset, size);
  183. }
  184. GGML_CALL void ggml_backend_tensor_get(const struct ggml_tensor * tensor, void * data, size_t offset, size_t size) {
  185. ggml_backend_buffer_t buf = tensor->view_src ? tensor->view_src->buffer : tensor->buffer;
  186. GGML_ASSERT(tensor->data != NULL && "tensor not allocated");
  187. GGML_ASSERT(tensor->buffer != NULL && "tensor buffer not set");
  188. GGML_ASSERT(offset + size <= ggml_nbytes(tensor) && "tensor read out of bounds");
  189. if (!size) {
  190. return;
  191. }
  192. tensor->buffer->iface.get_tensor(buf, tensor, data, offset, size);
  193. }
  194. void ggml_backend_synchronize(ggml_backend_t backend) {
  195. if (backend->iface.synchronize == NULL) {
  196. return;
  197. }
  198. backend->iface.synchronize(backend);
  199. }
  200. ggml_backend_graph_plan_t ggml_backend_graph_plan_create(ggml_backend_t backend, struct ggml_cgraph * cgraph) {
  201. return backend->iface.graph_plan_create(backend, cgraph);
  202. }
  203. void ggml_backend_graph_plan_free(ggml_backend_t backend, ggml_backend_graph_plan_t plan) {
  204. backend->iface.graph_plan_free(backend, plan);
  205. }
  206. enum ggml_status ggml_backend_graph_plan_compute(ggml_backend_t backend, ggml_backend_graph_plan_t plan) {
  207. return backend->iface.graph_plan_compute(backend, plan);
  208. }
  209. enum ggml_status ggml_backend_graph_compute(ggml_backend_t backend, struct ggml_cgraph * cgraph) {
  210. return backend->iface.graph_compute(backend, cgraph);
  211. }
  212. bool ggml_backend_supports_op(ggml_backend_t backend, const struct ggml_tensor * op) {
  213. return backend->iface.supports_op(backend, op);
  214. }
  215. // backend copy
  216. static bool ggml_are_same_layout(const struct ggml_tensor * a, const struct ggml_tensor * b) {
  217. if (a->type != b->type) {
  218. return false;
  219. }
  220. for (int i = 0; i < GGML_MAX_DIMS; i++) {
  221. if (a->ne[i] != b->ne[i]) {
  222. return false;
  223. }
  224. if (a->nb[i] != b->nb[i]) {
  225. return false;
  226. }
  227. }
  228. return true;
  229. }
  230. void ggml_backend_tensor_copy(struct ggml_tensor * src, struct ggml_tensor * dst) {
  231. GGML_ASSERT(ggml_are_same_layout(src, dst) && "cannot copy tensors with different layouts");
  232. if (src == dst) {
  233. return;
  234. }
  235. if (ggml_backend_buffer_is_host(src->buffer)) {
  236. ggml_backend_tensor_set(dst, src->data, 0, ggml_nbytes(src));
  237. } else if (ggml_backend_buffer_is_host(dst->buffer)) {
  238. ggml_backend_tensor_get(src, dst->data, 0, ggml_nbytes(src));
  239. } else if (!ggml_backend_buffer_copy_tensor(src, dst)) {
  240. #ifndef NDEBUG
  241. fprintf(stderr, "%s: warning: slow copy from %s to %s\n", __func__, ggml_backend_buffer_name(src->buffer), ggml_backend_buffer_name(dst->buffer));
  242. #endif
  243. size_t nbytes = ggml_nbytes(src);
  244. void * data = malloc(nbytes);
  245. ggml_backend_tensor_get(src, data, 0, nbytes);
  246. ggml_backend_tensor_set(dst, data, 0, nbytes);
  247. free(data);
  248. }
  249. }
  250. void ggml_backend_tensor_copy_async(ggml_backend_t backend, struct ggml_tensor * src, struct ggml_tensor * dst) {
  251. GGML_ASSERT(ggml_are_same_layout(src, dst) && "cannot copy tensors with different layouts");
  252. if (src == dst) {
  253. return;
  254. }
  255. if (ggml_backend_buft_supports_backend(src->buffer->buft, backend) && ggml_backend_buft_supports_backend(dst->buffer->buft, backend)) {
  256. if (backend->iface.cpy_tensor_async != NULL) {
  257. if (backend->iface.cpy_tensor_async(backend, src, dst)) {
  258. return;
  259. }
  260. }
  261. }
  262. size_t nbytes = ggml_nbytes(src);
  263. if (ggml_backend_buffer_is_host(src->buffer)) {
  264. ggml_backend_tensor_set_async(backend, dst, src->data, 0, nbytes);
  265. }
  266. else {
  267. ggml_backend_tensor_copy(src, dst);
  268. }
  269. }
  270. // backend registry
  271. #define GGML_MAX_BACKENDS_REG 16
  272. struct ggml_backend_reg {
  273. char name[128];
  274. ggml_backend_init_fn init_fn;
  275. ggml_backend_buffer_type_t default_buffer_type;
  276. void * user_data;
  277. };
  278. static struct ggml_backend_reg ggml_backend_registry[GGML_MAX_BACKENDS_REG];
  279. static size_t ggml_backend_registry_count = 0;
  280. GGML_CALL static ggml_backend_t ggml_backend_reg_cpu_init(const char * params, void * user_data);
  281. GGML_CALL static void ggml_backend_registry_init(void) {
  282. static bool initialized = false;
  283. if (initialized) {
  284. return;
  285. }
  286. initialized = true;
  287. ggml_backend_register("CPU", ggml_backend_reg_cpu_init, ggml_backend_cpu_buffer_type(), NULL);
  288. // add forward decls here to avoid including the backend headers
  289. #ifdef GGML_USE_CUBLAS
  290. extern GGML_CALL void ggml_backend_cuda_reg_devices(void);
  291. ggml_backend_cuda_reg_devices();
  292. #endif
  293. #ifdef GGML_USE_SYCL
  294. extern void ggml_backend_sycl_reg_devices(void);
  295. ggml_backend_sycl_reg_devices();
  296. #endif
  297. #ifdef GGML_USE_METAL
  298. extern GGML_CALL ggml_backend_t ggml_backend_reg_metal_init(const char * params, void * user_data);
  299. extern GGML_CALL ggml_backend_buffer_type_t ggml_backend_metal_buffer_type(void);
  300. ggml_backend_register("Metal", ggml_backend_reg_metal_init, ggml_backend_metal_buffer_type(), NULL);
  301. #endif
  302. #ifdef GGML_USE_VULKAN
  303. extern GGML_CALL int ggml_backend_vk_reg_devices(void);
  304. ggml_backend_vk_reg_devices();
  305. #endif
  306. #ifdef GGML_USE_KOMPUTE
  307. extern GGML_CALL void ggml_backend_kompute_reg_devices(void);
  308. ggml_backend_kompute_reg_devices();
  309. #endif
  310. }
  311. GGML_CALL void ggml_backend_register(const char * name, ggml_backend_init_fn init_fn, ggml_backend_buffer_type_t default_buffer_type, void * user_data) {
  312. GGML_ASSERT(ggml_backend_registry_count < GGML_MAX_BACKENDS_REG);
  313. size_t id = ggml_backend_registry_count;
  314. ggml_backend_registry[id] = (struct ggml_backend_reg) {
  315. /* .name = */ {0},
  316. /* .fn = */ init_fn,
  317. /* .default_buffer_type = */ default_buffer_type,
  318. /* .user_data = */ user_data,
  319. };
  320. snprintf(ggml_backend_registry[id].name, sizeof(ggml_backend_registry[id].name), "%s", name);
  321. #ifndef NDEBUG
  322. fprintf(stderr, "%s: registered backend %s\n", __func__, name);
  323. #endif
  324. ggml_backend_registry_count++;
  325. }
  326. size_t ggml_backend_reg_get_count(void) {
  327. ggml_backend_registry_init();
  328. return ggml_backend_registry_count;
  329. }
  330. size_t ggml_backend_reg_find_by_name(const char * name) {
  331. ggml_backend_registry_init();
  332. for (size_t i = 0; i < ggml_backend_registry_count; i++) {
  333. // TODO: case insensitive in a portable way
  334. if (strcmp(ggml_backend_registry[i].name, name) == 0) {
  335. return i;
  336. }
  337. }
  338. // not found
  339. return SIZE_MAX;
  340. }
  341. // init from backend:params string
  342. ggml_backend_t ggml_backend_reg_init_backend_from_str(const char * backend_str) {
  343. ggml_backend_registry_init();
  344. const char * params = strchr(backend_str, ':');
  345. char backend_name[128];
  346. if (params == NULL) {
  347. snprintf(backend_name, sizeof(backend_name), "%s", backend_str);
  348. params = "";
  349. } else {
  350. snprintf(backend_name, sizeof(backend_name), "%.*s", (int)(params - backend_str), backend_str);
  351. params++;
  352. }
  353. size_t backend_i = ggml_backend_reg_find_by_name(backend_name);
  354. if (backend_i == SIZE_MAX) {
  355. fprintf(stderr, "%s: backend %s not found\n", __func__, backend_name);
  356. return NULL;
  357. }
  358. return ggml_backend_reg_init_backend(backend_i, params);
  359. }
  360. const char * ggml_backend_reg_get_name(size_t i) {
  361. ggml_backend_registry_init();
  362. GGML_ASSERT(i < ggml_backend_registry_count);
  363. return ggml_backend_registry[i].name;
  364. }
  365. ggml_backend_t ggml_backend_reg_init_backend(size_t i, const char * params) {
  366. ggml_backend_registry_init();
  367. GGML_ASSERT(i < ggml_backend_registry_count);
  368. return ggml_backend_registry[i].init_fn(params, ggml_backend_registry[i].user_data);
  369. }
  370. ggml_backend_buffer_type_t ggml_backend_reg_get_default_buffer_type(size_t i) {
  371. ggml_backend_registry_init();
  372. GGML_ASSERT(i < ggml_backend_registry_count);
  373. return ggml_backend_registry[i].default_buffer_type;
  374. }
  375. ggml_backend_buffer_t ggml_backend_reg_alloc_buffer(size_t i, size_t size) {
  376. ggml_backend_registry_init();
  377. GGML_ASSERT(i < ggml_backend_registry_count);
  378. return ggml_backend_buft_alloc_buffer(ggml_backend_registry[i].default_buffer_type, size);
  379. }
  380. // backend CPU
  381. static const size_t TENSOR_ALIGNMENT = 32; // required for mmap as gguf only guarantees 32-byte alignment
  382. GGML_CALL static const char * ggml_backend_cpu_buffer_name(ggml_backend_buffer_t buffer) {
  383. return "CPU";
  384. GGML_UNUSED(buffer);
  385. }
  386. GGML_CALL static void * ggml_backend_cpu_buffer_get_base(ggml_backend_buffer_t buffer) {
  387. uintptr_t data = (uintptr_t)buffer->context;
  388. // align the buffer
  389. if (data % TENSOR_ALIGNMENT != 0) {
  390. data = GGML_PAD(data, TENSOR_ALIGNMENT);
  391. }
  392. return (void *)data;
  393. }
  394. GGML_CALL static void ggml_backend_cpu_buffer_free_buffer(ggml_backend_buffer_t buffer) {
  395. free(buffer->context);
  396. }
  397. GGML_CALL static void ggml_backend_cpu_buffer_set_tensor(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor, const void * data, size_t offset, size_t size) {
  398. memcpy((char *)tensor->data + offset, data, size);
  399. GGML_UNUSED(buffer);
  400. }
  401. GGML_CALL static void ggml_backend_cpu_buffer_get_tensor(ggml_backend_buffer_t buffer, const struct ggml_tensor * tensor, void * data, size_t offset, size_t size) {
  402. memcpy(data, (const char *)tensor->data + offset, size);
  403. GGML_UNUSED(buffer);
  404. }
  405. GGML_CALL static bool ggml_backend_cpu_buffer_cpy_tensor(ggml_backend_buffer_t buffer, const struct ggml_tensor * src, struct ggml_tensor * dst) {
  406. if (ggml_backend_buffer_is_host(src->buffer)) {
  407. memcpy(dst->data, src->data, ggml_nbytes(src));
  408. return true;
  409. }
  410. return false;
  411. GGML_UNUSED(buffer);
  412. }
  413. GGML_CALL static void ggml_backend_cpu_buffer_clear(ggml_backend_buffer_t buffer, uint8_t value) {
  414. memset(buffer->context, value, buffer->size);
  415. }
  416. static struct ggml_backend_buffer_i cpu_backend_buffer_i = {
  417. /* .get_name = */ ggml_backend_cpu_buffer_name,
  418. /* .free_buffer = */ ggml_backend_cpu_buffer_free_buffer,
  419. /* .get_base = */ ggml_backend_cpu_buffer_get_base,
  420. /* .init_tensor = */ NULL, // no initialization required
  421. /* .set_tensor = */ ggml_backend_cpu_buffer_set_tensor,
  422. /* .get_tensor = */ ggml_backend_cpu_buffer_get_tensor,
  423. /* .cpy_tensor = */ ggml_backend_cpu_buffer_cpy_tensor,
  424. /* .clear = */ ggml_backend_cpu_buffer_clear,
  425. /* .reset = */ NULL,
  426. };
  427. // for buffers from ptr, free is not called
  428. static struct ggml_backend_buffer_i cpu_backend_buffer_i_from_ptr = {
  429. /* .get_name = */ ggml_backend_cpu_buffer_name,
  430. /* .free_buffer = */ NULL, // ptr is not owned by the buffer, so it does not need to be freed
  431. /* .get_base = */ ggml_backend_cpu_buffer_get_base,
  432. /* .init_tensor = */ NULL, // no initialization required
  433. /* .set_tensor = */ ggml_backend_cpu_buffer_set_tensor,
  434. /* .get_tensor = */ ggml_backend_cpu_buffer_get_tensor,
  435. /* .cpy_tensor = */ ggml_backend_cpu_buffer_cpy_tensor,
  436. /* .clear = */ ggml_backend_cpu_buffer_clear,
  437. /* .reset = */ NULL,
  438. };
  439. GGML_CALL static const char * ggml_backend_cpu_buffer_type_get_name(ggml_backend_buffer_type_t buft) {
  440. return "CPU";
  441. GGML_UNUSED(buft);
  442. }
  443. GGML_CALL static ggml_backend_buffer_t ggml_backend_cpu_buffer_type_alloc_buffer(ggml_backend_buffer_type_t buft, size_t size) {
  444. size += TENSOR_ALIGNMENT; // malloc may return an address that is not aligned
  445. void * data = malloc(size); // TODO: use GGML_ALIGNED_MALLOC (move to ggml-impl.h)
  446. if (data == NULL) {
  447. fprintf(stderr, "%s: failed to allocate buffer of size %zu\n", __func__, size);
  448. return NULL;
  449. }
  450. return ggml_backend_buffer_init(buft, cpu_backend_buffer_i, data, size);
  451. }
  452. GGML_CALL static size_t ggml_backend_cpu_buffer_type_get_alignment(ggml_backend_buffer_type_t buft) {
  453. return TENSOR_ALIGNMENT;
  454. GGML_UNUSED(buft);
  455. }
  456. GGML_CALL static bool ggml_backend_cpu_buffer_type_supports_backend(ggml_backend_buffer_type_t buft, ggml_backend_t backend) {
  457. return ggml_backend_is_cpu(backend);
  458. GGML_UNUSED(buft);
  459. }
  460. GGML_CALL static bool ggml_backend_cpu_buffer_type_is_host(ggml_backend_buffer_type_t buft) {
  461. return true;
  462. GGML_UNUSED(buft);
  463. }
  464. GGML_CALL ggml_backend_buffer_type_t ggml_backend_cpu_buffer_type(void) {
  465. static struct ggml_backend_buffer_type ggml_backend_cpu_buffer_type = {
  466. /* .iface = */ {
  467. /* .get_name = */ ggml_backend_cpu_buffer_type_get_name,
  468. /* .alloc_buffer = */ ggml_backend_cpu_buffer_type_alloc_buffer,
  469. /* .get_alignment = */ ggml_backend_cpu_buffer_type_get_alignment,
  470. /* .get_max_size = */ NULL, // defaults to SIZE_MAX
  471. /* .get_alloc_size = */ NULL, // defaults to ggml_nbytes
  472. /* .supports_backend = */ ggml_backend_cpu_buffer_type_supports_backend,
  473. /* .is_host = */ ggml_backend_cpu_buffer_type_is_host,
  474. },
  475. /* .context = */ NULL,
  476. };
  477. return &ggml_backend_cpu_buffer_type;
  478. }
  479. #ifdef GGML_USE_CPU_HBM
  480. // buffer type HBM
  481. #include <hbwmalloc.h>
  482. GGML_CALL static const char * ggml_backend_cpu_hbm_buffer_type_get_name(ggml_backend_buffer_type_t buft) {
  483. return "CPU_HBM";
  484. GGML_UNUSED(buft);
  485. }
  486. GGML_CALL static const char * ggml_backend_cpu_hbm_buffer_get_name(ggml_backend_buffer_t buf) {
  487. return "CPU_HBM";
  488. GGML_UNUSED(buf);
  489. }
  490. GGML_CALL static void ggml_backend_cpu_hbm_buffer_free_buffer(ggml_backend_buffer_t buffer) {
  491. hbw_free(buffer->context);
  492. }
  493. GGML_CALL static ggml_backend_buffer_t ggml_backend_cpu_hbm_buffer_type_alloc_buffer(ggml_backend_buffer_type_t buft, size_t size) {
  494. //void * ptr = hbw_malloc(size);
  495. void * ptr;
  496. int result = hbw_posix_memalign(&ptr, ggml_backend_cpu_buffer_type_get_alignment(buft), size);
  497. if (result != 0) {
  498. fprintf(stderr, "failed to allocate HBM buffer of size %zu\n", size);
  499. return NULL;
  500. }
  501. ggml_backend_buffer_t buffer = ggml_backend_cpu_buffer_from_ptr(ptr, size);
  502. buffer->buft = buft;
  503. buffer->iface.get_name = ggml_backend_cpu_hbm_buffer_get_name;
  504. buffer->iface.free_buffer = ggml_backend_cpu_hbm_buffer_free_buffer;
  505. return buffer;
  506. }
  507. ggml_backend_buffer_type_t ggml_backend_cpu_hbm_buffer_type(void) {
  508. static struct ggml_backend_buffer_type ggml_backend_cpu_buffer_type_hbm = {
  509. /* .iface = */ {
  510. /* .get_name = */ ggml_backend_cpu_hbm_buffer_type_get_name,
  511. /* .alloc_buffer = */ ggml_backend_cpu_hbm_buffer_type_alloc_buffer,
  512. /* .get_alignment = */ ggml_backend_cpu_buffer_type_get_alignment,
  513. /* .get_max_size = */ NULL, // defaults to SIZE_MAX
  514. /* .get_alloc_size = */ NULL, // defaults to ggml_nbytes
  515. /* .supports_backend = */ ggml_backend_cpu_buffer_type_supports_backend,
  516. /* .is_host = */ ggml_backend_cpu_buffer_type_is_host,
  517. },
  518. /* .context = */ NULL,
  519. };
  520. return &ggml_backend_cpu_buffer_type_hbm;
  521. }
  522. #endif
  523. struct ggml_backend_cpu_context {
  524. int n_threads;
  525. void * work_data;
  526. size_t work_size;
  527. ggml_abort_callback abort_callback;
  528. void * abort_callback_data;
  529. };
  530. GGML_CALL static const char * ggml_backend_cpu_name(ggml_backend_t backend) {
  531. return "CPU";
  532. GGML_UNUSED(backend);
  533. }
  534. GGML_CALL static void ggml_backend_cpu_free(ggml_backend_t backend) {
  535. struct ggml_backend_cpu_context * cpu_ctx = (struct ggml_backend_cpu_context *)backend->context;
  536. free(cpu_ctx->work_data);
  537. free(cpu_ctx);
  538. free(backend);
  539. }
  540. GGML_CALL static ggml_backend_buffer_type_t ggml_backend_cpu_get_default_buffer_type(ggml_backend_t backend) {
  541. return ggml_backend_cpu_buffer_type();
  542. GGML_UNUSED(backend);
  543. }
  544. struct ggml_backend_plan_cpu {
  545. struct ggml_cplan cplan;
  546. struct ggml_cgraph cgraph;
  547. };
  548. GGML_CALL static ggml_backend_graph_plan_t ggml_backend_cpu_graph_plan_create(ggml_backend_t backend, const struct ggml_cgraph * cgraph) {
  549. struct ggml_backend_cpu_context * cpu_ctx = (struct ggml_backend_cpu_context *)backend->context;
  550. struct ggml_backend_plan_cpu * cpu_plan = malloc(sizeof(struct ggml_backend_plan_cpu));
  551. cpu_plan->cplan = ggml_graph_plan(cgraph, cpu_ctx->n_threads);
  552. cpu_plan->cgraph = *cgraph; // FIXME: deep copy
  553. if (cpu_plan->cplan.work_size > 0) {
  554. cpu_plan->cplan.work_data = malloc(cpu_plan->cplan.work_size);
  555. }
  556. cpu_plan->cplan.abort_callback = cpu_ctx->abort_callback;
  557. cpu_plan->cplan.abort_callback_data = cpu_ctx->abort_callback_data;
  558. return cpu_plan;
  559. }
  560. GGML_CALL static void ggml_backend_cpu_graph_plan_free(ggml_backend_t backend, ggml_backend_graph_plan_t plan) {
  561. struct ggml_backend_plan_cpu * cpu_plan = (struct ggml_backend_plan_cpu *)plan;
  562. free(cpu_plan->cplan.work_data);
  563. free(cpu_plan);
  564. GGML_UNUSED(backend);
  565. }
  566. GGML_CALL static enum ggml_status ggml_backend_cpu_graph_plan_compute(ggml_backend_t backend, ggml_backend_graph_plan_t plan) {
  567. struct ggml_backend_plan_cpu * cpu_plan = (struct ggml_backend_plan_cpu *)plan;
  568. return ggml_graph_compute(&cpu_plan->cgraph, &cpu_plan->cplan);
  569. GGML_UNUSED(backend);
  570. }
  571. GGML_CALL static enum ggml_status ggml_backend_cpu_graph_compute(ggml_backend_t backend, struct ggml_cgraph * cgraph) {
  572. struct ggml_backend_cpu_context * cpu_ctx = (struct ggml_backend_cpu_context *)backend->context;
  573. struct ggml_cplan cplan = ggml_graph_plan(cgraph, cpu_ctx->n_threads);
  574. if (cpu_ctx->work_size < cplan.work_size) {
  575. // TODO: may be faster to free and use malloc to avoid the copy
  576. cpu_ctx->work_data = realloc(cpu_ctx->work_data, cplan.work_size);
  577. cpu_ctx->work_size = cplan.work_size;
  578. }
  579. cplan.work_data = cpu_ctx->work_data;
  580. cplan.abort_callback = cpu_ctx->abort_callback;
  581. cplan.abort_callback_data = cpu_ctx->abort_callback_data;
  582. return ggml_graph_compute(cgraph, &cplan);
  583. }
  584. GGML_CALL static bool ggml_backend_cpu_supports_op(ggml_backend_t backend, const struct ggml_tensor * op) {
  585. switch (op->op) {
  586. case GGML_OP_CPY:
  587. return op->type != GGML_TYPE_IQ2_XXS && op->type != GGML_TYPE_IQ2_XS && op->type != GGML_TYPE_IQ1_S; // missing type_traits.from_float
  588. case GGML_OP_MUL_MAT:
  589. return op->src[1]->type == GGML_TYPE_F32 || op->src[1]->type == ggml_internal_get_type_traits(op->src[0]->type).vec_dot_type;
  590. default:
  591. return true;
  592. }
  593. GGML_UNUSED(backend);
  594. }
  595. static struct ggml_backend_i cpu_backend_i = {
  596. /* .get_name = */ ggml_backend_cpu_name,
  597. /* .free = */ ggml_backend_cpu_free,
  598. /* .get_default_buffer_type = */ ggml_backend_cpu_get_default_buffer_type,
  599. /* .set_tensor_async = */ NULL,
  600. /* .get_tensor_async = */ NULL,
  601. /* .cpy_tensor_async = */ NULL,
  602. /* .synchronize = */ NULL,
  603. /* .graph_plan_create = */ ggml_backend_cpu_graph_plan_create,
  604. /* .graph_plan_free = */ ggml_backend_cpu_graph_plan_free,
  605. /* .graph_plan_compute = */ ggml_backend_cpu_graph_plan_compute,
  606. /* .graph_compute = */ ggml_backend_cpu_graph_compute,
  607. /* .supports_op = */ ggml_backend_cpu_supports_op,
  608. };
  609. static ggml_guid_t ggml_backend_cpu_guid(void) {
  610. static ggml_guid guid = { 0xaa, 0x67, 0xc7, 0x43, 0x96, 0xe6, 0xa3, 0x8a, 0xe3, 0xaf, 0xea, 0x92, 0x36, 0xbc, 0xfc, 0x89 };
  611. return &guid;
  612. }
  613. ggml_backend_t ggml_backend_cpu_init(void) {
  614. struct ggml_backend_cpu_context * ctx = malloc(sizeof(struct ggml_backend_cpu_context));
  615. if (ctx == NULL) {
  616. return NULL;
  617. }
  618. ctx->n_threads = GGML_DEFAULT_N_THREADS;
  619. ctx->work_data = NULL;
  620. ctx->work_size = 0;
  621. ctx->abort_callback = NULL;
  622. ctx->abort_callback_data = NULL;
  623. ggml_backend_t cpu_backend = malloc(sizeof(struct ggml_backend));
  624. if (cpu_backend == NULL) {
  625. free(ctx);
  626. return NULL;
  627. }
  628. *cpu_backend = (struct ggml_backend) {
  629. /* .guid = */ ggml_backend_cpu_guid(),
  630. /* .interface = */ cpu_backend_i,
  631. /* .context = */ ctx
  632. };
  633. return cpu_backend;
  634. }
  635. GGML_CALL bool ggml_backend_is_cpu(ggml_backend_t backend) {
  636. return backend != NULL && ggml_guid_matches(backend->guid, ggml_backend_cpu_guid());
  637. }
  638. void ggml_backend_cpu_set_n_threads(ggml_backend_t backend_cpu, int n_threads) {
  639. GGML_ASSERT(ggml_backend_is_cpu(backend_cpu));
  640. struct ggml_backend_cpu_context * ctx = (struct ggml_backend_cpu_context *)backend_cpu->context;
  641. ctx->n_threads = n_threads;
  642. }
  643. void ggml_backend_cpu_set_abort_callback(ggml_backend_t backend_cpu, ggml_abort_callback abort_callback, void * abort_callback_data) {
  644. GGML_ASSERT(ggml_backend_is_cpu(backend_cpu));
  645. struct ggml_backend_cpu_context * ctx = (struct ggml_backend_cpu_context *)backend_cpu->context;
  646. ctx->abort_callback = abort_callback;
  647. ctx->abort_callback_data = abort_callback_data;
  648. }
  649. GGML_CALL ggml_backend_buffer_t ggml_backend_cpu_buffer_from_ptr(void * ptr, size_t size) {
  650. GGML_ASSERT((uintptr_t)ptr % TENSOR_ALIGNMENT == 0 && "buffer pointer must be aligned");
  651. return ggml_backend_buffer_init(ggml_backend_cpu_buffer_type(), cpu_backend_buffer_i_from_ptr, ptr, size);
  652. }
  653. GGML_CALL static ggml_backend_t ggml_backend_reg_cpu_init(const char * params, void * user_data) {
  654. return ggml_backend_cpu_init();
  655. GGML_UNUSED(params);
  656. GGML_UNUSED(user_data);
  657. }
  658. // multi-buffer buffer
  659. struct ggml_backend_multi_buffer_context {
  660. ggml_backend_buffer_t * buffers;
  661. size_t n_buffers;
  662. };
  663. typedef struct ggml_backend_multi_buffer_context * ggml_backend_multi_buffer_context_t;
  664. GGML_CALL static const char * ggml_backend_multi_buffer_get_name(ggml_backend_buffer_t buffer) {
  665. ggml_backend_multi_buffer_context_t ctx = (ggml_backend_multi_buffer_context_t) buffer->context;
  666. return ctx->buffers[0]->iface.get_name(ctx->buffers[0]);
  667. }
  668. GGML_CALL static void ggml_backend_multi_buffer_free_buffer(ggml_backend_buffer_t buffer) {
  669. ggml_backend_multi_buffer_context_t ctx = (ggml_backend_multi_buffer_context_t) buffer->context;
  670. for (size_t i = 0; i < ctx->n_buffers; i++) {
  671. ggml_backend_buffer_free(ctx->buffers[i]);
  672. }
  673. free(ctx->buffers);
  674. free(ctx);
  675. }
  676. GGML_CALL static void ggml_backend_multi_buffer_clear(ggml_backend_buffer_t buffer, uint8_t value) {
  677. ggml_backend_multi_buffer_context_t ctx = (ggml_backend_multi_buffer_context_t) buffer->context;
  678. for (size_t i = 0; i < ctx->n_buffers; i++) {
  679. ggml_backend_buffer_clear(ctx->buffers[i], value);
  680. }
  681. }
  682. static struct ggml_backend_buffer_i ggml_backend_multi_buffer_context_interface(void) {
  683. static struct ggml_backend_buffer_i multi_backend_buffer_i = {
  684. /* .get_name = */ ggml_backend_multi_buffer_get_name,
  685. /* .free_buffer = */ ggml_backend_multi_buffer_free_buffer,
  686. /* .get_base = */ NULL,
  687. /* .init_tensor = */ NULL,
  688. /* .set_tensor = */ NULL,
  689. /* .get_tensor = */ NULL,
  690. /* .cpy_tensor = */ NULL,
  691. /* .clear = */ ggml_backend_multi_buffer_clear,
  692. /* .reset = */ NULL,
  693. };
  694. return multi_backend_buffer_i;
  695. }
  696. GGML_CALL ggml_backend_buffer_t ggml_backend_multi_buffer_alloc_buffer(ggml_backend_buffer_t * buffers, size_t n_buffers) {
  697. ggml_backend_multi_buffer_context_t ctx = (ggml_backend_multi_buffer_context_t) malloc(sizeof(struct ggml_backend_multi_buffer_context));
  698. ctx->n_buffers = n_buffers;
  699. ctx->buffers = (ggml_backend_buffer_t *) malloc(n_buffers * sizeof(ggml_backend_buffer_t));
  700. GGML_ASSERT(ctx->buffers != NULL);
  701. size_t total_size = 0;
  702. for (size_t i = 0; i < n_buffers; i++) {
  703. ctx->buffers[i] = buffers[i];
  704. total_size += ggml_backend_buffer_get_size(buffers[i]);
  705. }
  706. return ggml_backend_buffer_init(buffers[0]->buft, ggml_backend_multi_buffer_context_interface(), ctx, total_size);
  707. }
  708. GGML_CALL bool ggml_backend_buffer_is_multi_buffer(ggml_backend_buffer_t buffer) {
  709. return buffer->iface.get_name == ggml_backend_multi_buffer_get_name;
  710. }
  711. GGML_CALL void ggml_backend_multi_buffer_set_usage(ggml_backend_buffer_t buffer, enum ggml_backend_buffer_usage usage) {
  712. GGML_ASSERT(ggml_backend_buffer_is_multi_buffer(buffer));
  713. ggml_backend_multi_buffer_context_t ctx = (ggml_backend_multi_buffer_context_t) buffer->context;
  714. for (size_t i = 0; i < ctx->n_buffers; i++) {
  715. ggml_backend_buffer_set_usage(ctx->buffers[i], usage);
  716. }
  717. }
  718. // creates a copy of the tensor with the same memory layout
  719. static struct ggml_tensor * ggml_dup_tensor_layout(struct ggml_context * ctx, const struct ggml_tensor * tensor) {
  720. struct ggml_tensor * dup = ggml_dup_tensor(ctx, tensor);
  721. for (int i = 0; i < GGML_MAX_DIMS; i++) {
  722. dup->nb[i] = tensor->nb[i];
  723. }
  724. return dup;
  725. }
  726. static bool ggml_is_view_op(enum ggml_op op) {
  727. return op == GGML_OP_VIEW || op == GGML_OP_RESHAPE || op == GGML_OP_PERMUTE || op == GGML_OP_TRANSPOSE;
  728. }
  729. // scheduler
  730. #define GGML_MAX_BACKENDS 16
  731. #define GGML_MAX_SPLITS 256
  732. #define GGML_MAX_SPLIT_INPUTS 16
  733. struct ggml_backend_sched_split {
  734. int backend_id;
  735. int i_start;
  736. int i_end;
  737. struct ggml_tensor * inputs[GGML_MAX_SPLIT_INPUTS];
  738. int n_inputs;
  739. // graph view of this split
  740. struct ggml_cgraph graph;
  741. };
  742. struct ggml_backend_sched {
  743. bool is_reset; // true if the scheduler has been reset since the last graph split
  744. int n_backends;
  745. ggml_backend_t backends[GGML_MAX_BACKENDS];
  746. ggml_backend_buffer_type_t bufts[GGML_MAX_BACKENDS];
  747. ggml_gallocr_t galloc;
  748. // hash keys of the nodes in the graph
  749. struct ggml_hash_set hash_set;
  750. // hash values
  751. int * tensor_backend_id;
  752. struct ggml_tensor * (* tensor_copies)[GGML_MAX_BACKENDS];
  753. int * node_backend_ids; // [n_nodes]
  754. int n_nodes;
  755. // copy of the graph with modified inputs
  756. struct ggml_cgraph * graph;
  757. struct ggml_backend_sched_split splits[GGML_MAX_SPLITS];
  758. int n_splits;
  759. struct ggml_context * ctx;
  760. ggml_backend_sched_eval_callback callback_eval;
  761. void * callback_eval_user_data;
  762. // align context_buffer to GGML_MEM_ALIGN
  763. #ifdef _MSC_VER
  764. __declspec(align(GGML_MEM_ALIGN))
  765. #else
  766. __attribute__((aligned(GGML_MEM_ALIGN)))
  767. #endif
  768. char context_buffer[GGML_MAX_SPLITS*GGML_MAX_SPLIT_INPUTS*2*sizeof(struct ggml_tensor) + sizeof(struct ggml_cgraph)];
  769. };
  770. #define hash_id(node) ggml_hash_find_or_insert(sched->hash_set, node)
  771. #define tensor_backend_id(node) sched->tensor_backend_id[hash_id(node)]
  772. #define tensor_backend(node) (tensor_backend_id(node) == -1 ? NULL : sched->backends[tensor_backend_id(node)])
  773. // returns the priority of the backend, lower id is higher priority
  774. static int ggml_backend_sched_backend_id(ggml_backend_sched_t sched, ggml_backend_t backend) {
  775. for (int i = 0; i < sched->n_backends; i++) {
  776. if (sched->backends[i] == backend) {
  777. return i;
  778. }
  779. }
  780. return -1;
  781. }
  782. static int ggml_backend_sched_backend_from_buffer(ggml_backend_sched_t sched, ggml_backend_buffer_t buffer) {
  783. if (buffer == NULL) {
  784. return -1;
  785. }
  786. // find highest prio backend that supports the buffer type
  787. for (int i = 0; i < sched->n_backends; i++) {
  788. if (ggml_backend_buft_supports_backend(buffer->buft, sched->backends[i])) {
  789. return i;
  790. }
  791. }
  792. GGML_ASSERT(false && "tensor buffer type not supported by any backend");
  793. return -1; // silence warning
  794. }
  795. #if 0
  796. static char causes[GGML_DEFAULT_GRAPH_SIZE*16 + GGML_MAX_SPLITS*GGML_MAX_SPLIT_INPUTS][128]; // debug only
  797. #define SET_CAUSE(node, ...) sprintf(causes[hash_id(node)], __VA_ARGS__)
  798. #define GET_CAUSE(node) causes[hash_id(node)]
  799. #else
  800. #define SET_CAUSE(node, ...)
  801. #define GET_CAUSE(node) ""
  802. #endif
  803. // returns the backend that should be used for the node based on the current locations
  804. static int ggml_backend_sched_backend_id_from_cur(ggml_backend_sched_t sched, struct ggml_tensor * tensor) {
  805. // TODO: use supports_op to check if the backend supports the op
  806. // assign pre-allocated nodes to their backend
  807. // dst
  808. int cur_backend = ggml_backend_sched_backend_from_buffer(sched, tensor->buffer);
  809. if (cur_backend != -1) {
  810. SET_CAUSE(node, "1.dst");
  811. return cur_backend;
  812. }
  813. // view_src
  814. if (tensor->view_src != NULL) {
  815. cur_backend = ggml_backend_sched_backend_from_buffer(sched, tensor->view_src->buffer);
  816. if (cur_backend != -1) {
  817. SET_CAUSE(node, "1.vsrc");
  818. return cur_backend;
  819. }
  820. }
  821. // assign nodes that use weights to the backend of the weights
  822. for (int i = 0; i < GGML_MAX_SRC; i++) {
  823. const struct ggml_tensor * src = tensor->src[i];
  824. if (src == NULL) {
  825. continue;
  826. }
  827. if (src->buffer != NULL && src->buffer->usage == GGML_BACKEND_BUFFER_USAGE_WEIGHTS) {
  828. int src_backend = ggml_backend_sched_backend_from_buffer(sched, src->buffer);
  829. // operations with weights are always run on the same backend as the weights
  830. SET_CAUSE(node, "1.wgt%d", i);
  831. return src_backend;
  832. }
  833. }
  834. return -1;
  835. }
  836. static char * fmt_size(size_t size) {
  837. static char buffer[128];
  838. if (size >= 1024*1024) {
  839. sprintf(buffer, "%zuM", size/1024/1024);
  840. } else {
  841. sprintf(buffer, "%zuK", size/1024);
  842. }
  843. return buffer;
  844. }
  845. static void ggml_backend_sched_print_assignments(ggml_backend_sched_t sched, struct ggml_cgraph * graph) {
  846. int cur_split = 0;
  847. for (int i = 0; i < graph->n_nodes; i++) {
  848. if (cur_split < sched->n_splits && i == sched->splits[cur_split].i_start) {
  849. ggml_backend_t split_backend = sched->backends[sched->splits[cur_split].backend_id];
  850. fprintf(stderr, "\n## SPLIT #%d: %s # %d inputs: ", cur_split, ggml_backend_name(split_backend),
  851. sched->splits[cur_split].n_inputs);
  852. for (int j = 0; j < sched->splits[cur_split].n_inputs; j++) {
  853. fprintf(stderr, "[%s (%5.5s)] ", sched->splits[cur_split].inputs[j]->name,
  854. fmt_size(ggml_nbytes(sched->splits[cur_split].inputs[j])));
  855. }
  856. fprintf(stderr, "\n");
  857. cur_split++;
  858. }
  859. struct ggml_tensor * node = graph->nodes[i];
  860. if (ggml_is_view_op(node->op)) {
  861. continue;
  862. }
  863. ggml_backend_t tensor_backend = tensor_backend(node);
  864. fprintf(stderr, "node #%3d (%10.10s): %20.20s (%5.5s) [%5.5s %8.8s]:", i, ggml_op_name(node->op), node->name,
  865. fmt_size(ggml_nbytes(node)), tensor_backend ? ggml_backend_name(tensor_backend) : "NULL", GET_CAUSE(node));
  866. for (int j = 0; j < GGML_MAX_SRC; j++) {
  867. struct ggml_tensor * src = node->src[j];
  868. if (src == NULL) {
  869. continue;
  870. }
  871. ggml_backend_t src_backend = tensor_backend(src);
  872. fprintf(stderr, " %20.20s (%5.5s) [%5.5s %8.8s]", src->name,
  873. fmt_size(ggml_nbytes(src)), src_backend ? ggml_backend_name(src_backend) : "NULL", GET_CAUSE(src));
  874. }
  875. fprintf(stderr, "\n");
  876. }
  877. }
  878. //#define DEBUG_PASS1
  879. //#define DEBUG_PASS2
  880. //#define DEBUG_PASS3
  881. //#define DEBUG_PASS4
  882. // assigns backends to ops and splits the graph into subgraphs that can be computed on the same backend
  883. static void ggml_backend_sched_split_graph(ggml_backend_sched_t sched, struct ggml_cgraph * graph) {
  884. // reset splits
  885. sched->n_splits = 0;
  886. sched->is_reset = false;
  887. struct ggml_init_params params = {
  888. /* .mem_size = */ sizeof(sched->context_buffer),
  889. /* .mem_buffer = */ sched->context_buffer,
  890. /* .no_alloc = */ true
  891. };
  892. ggml_free(sched->ctx);
  893. sched->ctx = ggml_init(params);
  894. if (sched->ctx == NULL) {
  895. fprintf(stderr, "%s: failed to initialize context\n", __func__);
  896. GGML_ASSERT(false);
  897. }
  898. // pass 1: assign backends to ops with pre-allocated inputs
  899. for (int i = 0; i < graph->n_leafs; i++) {
  900. struct ggml_tensor * leaf = graph->leafs[i];
  901. if (tensor_backend_id(leaf) != -1) {
  902. // do not overwrite user assignments
  903. continue;
  904. }
  905. tensor_backend_id(leaf) = ggml_backend_sched_backend_id_from_cur(sched, leaf);
  906. }
  907. for (int i = 0; i < graph->n_nodes; i++) {
  908. struct ggml_tensor * node = graph->nodes[i];
  909. if (tensor_backend_id(node) != -1) {
  910. // do not overwrite user assignments
  911. continue;
  912. }
  913. tensor_backend_id(node) = ggml_backend_sched_backend_id_from_cur(sched, node);
  914. // src
  915. for (int j = 0; j < GGML_MAX_SRC; j++) {
  916. struct ggml_tensor * src = node->src[j];
  917. if (src == NULL) {
  918. continue;
  919. }
  920. if (tensor_backend_id(src) == -1) {
  921. tensor_backend_id(src) = ggml_backend_sched_backend_id_from_cur(sched, src);
  922. }
  923. }
  924. }
  925. #ifdef DEBUG_PASS1
  926. fprintf(stderr, "PASS 1 ASSIGNMENTS\n"); sched_print_assignments(sched, graph);
  927. #endif
  928. // pass 2: expand current backend assignments
  929. // assign the same backend to adjacent nodes
  930. // expand gpu backends (i.e. non last prio) up and down, ignoring cpu (the lowest priority backend)
  931. // thus, cpu will never be used unless weights are on cpu, or there are no gpu ops between cpu ops
  932. // pass 2.1 expand gpu up
  933. {
  934. int cur_backend_id = -1;
  935. for (int i = graph->n_nodes - 1; i >= 0; i--) {
  936. struct ggml_tensor * node = graph->nodes[i];
  937. if (ggml_is_view_op(node->op)) {
  938. continue;
  939. }
  940. int tensor_backend_id = tensor_backend_id(node);
  941. if (tensor_backend_id != -1) {
  942. if (tensor_backend_id == sched->n_backends - 1) {
  943. // skip cpu (lowest prio backend)
  944. cur_backend_id = -1;
  945. } else {
  946. cur_backend_id = tensor_backend_id;
  947. }
  948. } else {
  949. tensor_backend_id(node) = cur_backend_id;
  950. SET_CAUSE(node, "2.1");
  951. }
  952. }
  953. }
  954. // pass 2.2 expand gpu down
  955. {
  956. int cur_backend_id = -1;
  957. for (int i = 0; i < graph->n_nodes; i++) {
  958. struct ggml_tensor * node = graph->nodes[i];
  959. if (ggml_is_view_op(node->op)) {
  960. continue;
  961. }
  962. int tensor_backend_id = tensor_backend_id(node);
  963. if (tensor_backend_id != -1) {
  964. if (tensor_backend_id == sched->n_backends - 1) {
  965. // skip cpu (lowest prio backend)
  966. cur_backend_id = -1;
  967. } else {
  968. cur_backend_id = tensor_backend_id;
  969. }
  970. } else {
  971. tensor_backend_id(node) = cur_backend_id;
  972. SET_CAUSE(node, "2.2");
  973. }
  974. }
  975. }
  976. // pass 2.3 expand rest up
  977. {
  978. int cur_backend_id = -1;
  979. for (int i = graph->n_nodes - 1; i >= 0; i--) {
  980. struct ggml_tensor * node = graph->nodes[i];
  981. if (ggml_is_view_op(node->op)) {
  982. continue;
  983. }
  984. int tensor_backend_id = tensor_backend_id(node);
  985. if (tensor_backend_id != -1) {
  986. cur_backend_id = tensor_backend_id;
  987. } else {
  988. tensor_backend_id(node) = cur_backend_id;
  989. SET_CAUSE(node, "2.3");
  990. }
  991. }
  992. }
  993. // pass 2.4 expand rest down
  994. {
  995. int cur_backend_id = -1;
  996. for (int i = 0; i < graph->n_nodes; i++) {
  997. struct ggml_tensor * node = graph->nodes[i];
  998. if (ggml_is_view_op(node->op)) {
  999. continue;
  1000. }
  1001. int tensor_backend_id = tensor_backend_id(node);
  1002. if (tensor_backend_id != -1) {
  1003. cur_backend_id = tensor_backend_id;
  1004. } else {
  1005. tensor_backend_id(node) = cur_backend_id;
  1006. SET_CAUSE(node, "2.4");
  1007. }
  1008. }
  1009. }
  1010. #ifdef DEBUG_PASS2
  1011. fprintf(stderr, "PASS 2 ASSIGNMENTS\n"); sched_print_assignments(sched, graph);
  1012. #endif
  1013. // pass 3: assign backends to remaining src from dst and view_src
  1014. for (int i = 0; i < graph->n_nodes; i++) {
  1015. struct ggml_tensor * node = graph->nodes[i];
  1016. int cur_backend_id = tensor_backend_id(node);
  1017. if (node->view_src != NULL && cur_backend_id == -1) {
  1018. cur_backend_id = tensor_backend_id(node) = tensor_backend_id(node->view_src);
  1019. SET_CAUSE(node, "3.vsrc");
  1020. }
  1021. for (int j = 0; j < GGML_MAX_SRC; j++) {
  1022. struct ggml_tensor * src = node->src[j];
  1023. if (src == NULL) {
  1024. continue;
  1025. }
  1026. int src_backend_id = tensor_backend_id(src);
  1027. if (src_backend_id == -1) {
  1028. if (src->view_src != NULL) {
  1029. // views are always on the same backend as the source
  1030. tensor_backend_id(src) = tensor_backend_id(src->view_src);
  1031. SET_CAUSE(src, "3.vsrc");
  1032. } else {
  1033. tensor_backend_id(src) = cur_backend_id;
  1034. SET_CAUSE(src, "3.cur");
  1035. }
  1036. }
  1037. }
  1038. }
  1039. #ifdef DEBUG_PASS3
  1040. fprintf(stderr, "PASS 3 ASSIGNMENTS\n"); sched_print_assignments(sched, graph);
  1041. #endif
  1042. // pass 4: split graph, find tensors that need to be copied
  1043. {
  1044. int cur_split = 0;
  1045. // find the backend of the first split, skipping view ops
  1046. for (int i = 0; i < graph->n_nodes; i++) {
  1047. struct ggml_tensor * node = graph->nodes[i];
  1048. if (!ggml_is_view_op(node->op)) {
  1049. sched->splits[0].backend_id = tensor_backend_id(node);
  1050. break;
  1051. }
  1052. }
  1053. sched->splits[0].i_start = 0;
  1054. sched->splits[0].n_inputs = 0;
  1055. memset(sched->splits[0].inputs, 0, sizeof(sched->splits[0].inputs)); //HACK
  1056. int cur_backend_id = sched->splits[0].backend_id;
  1057. for (int i = 0; i < graph->n_nodes; i++) {
  1058. struct ggml_tensor * node = graph->nodes[i];
  1059. if (ggml_is_view_op(node->op)) {
  1060. continue;
  1061. }
  1062. int tensor_backend_id = tensor_backend_id(node);
  1063. GGML_ASSERT(tensor_backend_id != -1); // all nodes should be assigned by now
  1064. if (tensor_backend_id != cur_backend_id) {
  1065. sched->splits[cur_split].i_end = i;
  1066. cur_split++;
  1067. GGML_ASSERT(cur_split < GGML_MAX_SPLITS);
  1068. sched->splits[cur_split].backend_id = tensor_backend_id;
  1069. sched->splits[cur_split].i_start = i;
  1070. sched->splits[cur_split].n_inputs = 0;
  1071. cur_backend_id = tensor_backend_id;
  1072. }
  1073. // find inputs that are not on the same backend
  1074. for (int j = 0; j < GGML_MAX_SRC; j++) {
  1075. struct ggml_tensor * src = node->src[j];
  1076. if (src == NULL) {
  1077. continue;
  1078. }
  1079. int src_backend_id = tensor_backend_id(src);
  1080. assert(src_backend_id != -1); // all inputs should be assigned by now
  1081. if (src_backend_id != tensor_backend_id) {
  1082. // create a copy of the input in the split's backend
  1083. size_t id = hash_id(src);
  1084. if (sched->tensor_copies[id][cur_backend_id] == NULL) {
  1085. ggml_backend_t backend = sched->backends[cur_backend_id];
  1086. struct ggml_tensor * tensor_copy = ggml_dup_tensor_layout(sched->ctx, src);
  1087. ggml_format_name(tensor_copy, "%s#%s", ggml_backend_name(backend), src->name);
  1088. sched->tensor_copies[id][cur_backend_id] = tensor_copy;
  1089. tensor_backend_id(tensor_copy) = cur_backend_id;
  1090. SET_CAUSE(tensor_copy, "4.cpy");
  1091. int n_inputs = sched->splits[cur_split].n_inputs++;
  1092. GGML_ASSERT(n_inputs < GGML_MAX_SPLIT_INPUTS);
  1093. sched->splits[cur_split].inputs[n_inputs] = src;
  1094. }
  1095. node->src[j] = sched->tensor_copies[id][cur_backend_id];
  1096. }
  1097. }
  1098. }
  1099. sched->splits[cur_split].i_end = graph->n_nodes;
  1100. sched->n_splits = cur_split + 1;
  1101. }
  1102. #ifdef DEBUG_PASS4
  1103. fprintf(stderr, "PASS 4 ASSIGNMENTS\n"); sched_print_assignments(sched, graph);
  1104. #endif
  1105. #ifndef NDEBUG
  1106. // sanity check: all sources should have the same backend as the node
  1107. for (int i = 0; i < graph->n_nodes; i++) {
  1108. struct ggml_tensor * node = graph->nodes[i];
  1109. ggml_backend_t tensor_backend = tensor_backend(node);
  1110. if (tensor_backend == NULL) {
  1111. fprintf(stderr, "!!!!!!! %s has no backend\n", node->name);
  1112. }
  1113. if (node->view_src != NULL && tensor_backend != tensor_backend(node->view_src)) {
  1114. fprintf(stderr, "!!!!!!! %s has backend %s, view_src %s has backend %s\n",
  1115. node->name, tensor_backend ? ggml_backend_name(tensor_backend) : "NULL",
  1116. node->view_src->name, tensor_backend(node->view_src) ? ggml_backend_name(tensor_backend(node->view_src)) : "NULL");
  1117. }
  1118. for (int j = 0; j < GGML_MAX_SRC; j++) {
  1119. struct ggml_tensor * src = node->src[j];
  1120. if (src == NULL) {
  1121. continue;
  1122. }
  1123. ggml_backend_t src_backend = tensor_backend(src);
  1124. if (src_backend != tensor_backend /* && src_backend != NULL */) {
  1125. fprintf(stderr, "!!!! %s has backend %s, src %d (%s) has backend %s\n",
  1126. node->name, tensor_backend ? ggml_backend_name(tensor_backend) : "NULL",
  1127. j, src->name, src_backend ? ggml_backend_name(src_backend) : "NULL");
  1128. }
  1129. if (src->view_src != NULL && src_backend != tensor_backend(src->view_src)) {
  1130. fprintf(stderr, "!!!!!!! [src] %s has backend %s, view_src %s has backend %s\n",
  1131. src->name, src_backend ? ggml_backend_name(src_backend) : "NULL",
  1132. src->view_src->name, tensor_backend(src->view_src) ? ggml_backend_name(tensor_backend(src->view_src)) : "NULL");
  1133. }
  1134. }
  1135. }
  1136. fflush(stderr);
  1137. #endif
  1138. // create copies of the graph for each split
  1139. // FIXME: avoid this copy, pass split inputs to ggml_gallocr_alloc_graph_n in some other way
  1140. struct ggml_cgraph * graph_copy = ggml_new_graph_custom(sched->ctx, graph->n_nodes + sched->n_splits*GGML_MAX_SPLIT_INPUTS, false);
  1141. for (int i = 0; i < sched->n_splits; i++) {
  1142. struct ggml_backend_sched_split * split = &sched->splits[i];
  1143. split->graph = ggml_graph_view(graph, split->i_start, split->i_end);
  1144. for (int j = 0; j < split->n_inputs; j++) {
  1145. struct ggml_tensor * input = split->inputs[j];
  1146. struct ggml_tensor * input_cpy = sched->tensor_copies[hash_id(input)][split->backend_id];
  1147. // add a dependency to the input source so that it is not freed before the copy is done
  1148. struct ggml_tensor * input_dep = ggml_view_tensor(sched->ctx, input);
  1149. sched->node_backend_ids[graph_copy->n_nodes] = tensor_backend_id(input);
  1150. graph_copy->nodes[graph_copy->n_nodes++] = input_dep;
  1151. // add a dependency to the input copy so that it is allocated at the start of the split
  1152. sched->node_backend_ids[graph_copy->n_nodes] = split->backend_id;
  1153. graph_copy->nodes[graph_copy->n_nodes++] = input_cpy;
  1154. }
  1155. for (int j = split->i_start; j < split->i_end; j++) {
  1156. sched->node_backend_ids[graph_copy->n_nodes] = tensor_backend_id(graph->nodes[j]);
  1157. graph_copy->nodes[graph_copy->n_nodes++] = graph->nodes[j];
  1158. }
  1159. }
  1160. sched->graph = graph_copy;
  1161. }
  1162. static bool ggml_backend_sched_alloc_splits(ggml_backend_sched_t sched) {
  1163. // ggml_gallocr_reserve_n(sched->galloc, sched->graph, sched->node_backend_ids);
  1164. if (!ggml_gallocr_alloc_graph(sched->galloc, sched->graph)) {
  1165. #ifndef NDEBUG
  1166. fprintf(stderr, "ggml_backend_sched: failed to allocate graph, reserving\n");
  1167. #endif
  1168. ggml_gallocr_reserve_n(sched->galloc, sched->graph, sched->node_backend_ids);
  1169. if (!ggml_gallocr_alloc_graph(sched->galloc, sched->graph)) {
  1170. fprintf(stderr, "ggml_backend_sched: failed to allocate graph\n");
  1171. return false;
  1172. }
  1173. }
  1174. return true;
  1175. }
  1176. static enum ggml_status ggml_backend_sched_compute_splits(ggml_backend_sched_t sched) {
  1177. uint64_t copy_us[GGML_MAX_BACKENDS] = {0};
  1178. uint64_t compute_us[GGML_MAX_BACKENDS] = {0};
  1179. struct ggml_backend_sched_split * splits = sched->splits;
  1180. for (int i = 0; i < sched->n_splits; i++) {
  1181. struct ggml_backend_sched_split * split = &splits[i];
  1182. int split_backend_id = split->backend_id;
  1183. ggml_backend_t split_backend = sched->backends[split_backend_id];
  1184. // copy the input tensors to the split backend
  1185. uint64_t copy_start_us = ggml_time_us();
  1186. for (int j = 0; j < split->n_inputs; j++) {
  1187. struct ggml_tensor * input = split->inputs[j];
  1188. struct ggml_tensor * input_cpy = sched->tensor_copies[hash_id(input)][split_backend_id];
  1189. GGML_ASSERT(input->buffer != NULL);
  1190. GGML_ASSERT(input_cpy->buffer != NULL);
  1191. ggml_backend_tensor_copy_async(split_backend, input, input_cpy);
  1192. }
  1193. //ggml_backend_synchronize(split_backend); // necessary to measure copy time
  1194. int64_t copy_end_us = ggml_time_us();
  1195. copy_us[split_backend_id] += copy_end_us - copy_start_us;
  1196. #if 0
  1197. char split_filename[GGML_MAX_NAME];
  1198. snprintf(split_filename, GGML_MAX_NAME, "split_%i_%s.dot", i, ggml_backend_name(split_backend));
  1199. ggml_graph_dump_dot(split->graph, NULL, split_filename);
  1200. #endif
  1201. uint64_t compute_start_us = ggml_time_us();
  1202. if (!sched->callback_eval) {
  1203. enum ggml_status ec = ggml_backend_graph_compute(split_backend, &split->graph);
  1204. if (ec != GGML_STATUS_SUCCESS) {
  1205. return ec;
  1206. }
  1207. //ggml_backend_synchronize(split_backend); // necessary to measure compute time
  1208. } else {
  1209. // similar to ggml_backend_compare_graph_backend
  1210. for (int j0 = 0; j0 < split->graph.n_nodes; j0++) {
  1211. struct ggml_tensor * t = split->graph.nodes[j0];
  1212. // check if the user needs data from this node
  1213. bool need = sched->callback_eval(t, true, sched->callback_eval_user_data);
  1214. int j1 = j0;
  1215. // determine the range [j0, j1] of nodes that can be computed together
  1216. while (!need && j1 < split->graph.n_nodes - 1) {
  1217. t = split->graph.nodes[++j1];
  1218. need = sched->callback_eval(t, true, sched->callback_eval_user_data);
  1219. }
  1220. struct ggml_cgraph gv = ggml_graph_view(&split->graph, j0, j1 + 1);
  1221. enum ggml_status ec = ggml_backend_graph_compute(split_backend, &gv);
  1222. if (ec != GGML_STATUS_SUCCESS) {
  1223. return ec;
  1224. }
  1225. if (need && !sched->callback_eval(t, false, sched->callback_eval_user_data)) {
  1226. break;
  1227. }
  1228. j0 = j1;
  1229. }
  1230. }
  1231. uint64_t compute_end_us = ggml_time_us();
  1232. compute_us[split_backend_id] += compute_end_us - compute_start_us;
  1233. }
  1234. #if 0
  1235. // per-backend timings
  1236. fprintf(stderr, "sched_compute_splits times (%d splits):\n", sched->n_splits);
  1237. for (int i = 0; i < sched->n_backends; i++) {
  1238. if (copy_us[i] > 0 || compute_us[i] > 0) {
  1239. fprintf(stderr, "\t%5.5s: %lu us copy, %lu us compute\n", ggml_backend_name(sched->backends[i]), copy_us[i], compute_us[i]);
  1240. }
  1241. }
  1242. #endif
  1243. return GGML_STATUS_SUCCESS;
  1244. }
  1245. ggml_backend_sched_t ggml_backend_sched_new(ggml_backend_t * backends, ggml_backend_buffer_type_t * bufts, int n_backends, size_t graph_size) {
  1246. GGML_ASSERT(n_backends > 0);
  1247. GGML_ASSERT(n_backends <= GGML_MAX_BACKENDS);
  1248. struct ggml_backend_sched * sched = calloc(sizeof(struct ggml_backend_sched), 1);
  1249. // initialize hash table
  1250. sched->hash_set = ggml_hash_set_new(graph_size + GGML_MAX_SPLITS*GGML_MAX_SPLIT_INPUTS);
  1251. sched->tensor_backend_id = calloc(sizeof(sched->tensor_backend_id[0]), sched->hash_set.size);
  1252. sched->tensor_copies = calloc(sizeof(sched->tensor_copies[0]), sched->hash_set.size);
  1253. sched->node_backend_ids = calloc(sizeof(sched->node_backend_ids[0]), graph_size);
  1254. sched->n_backends = n_backends;
  1255. for (int i = 0; i < n_backends; i++) {
  1256. sched->backends[i] = backends[i];
  1257. sched->bufts[i] = bufts ? bufts[i] : ggml_backend_get_default_buffer_type(backends[i]);
  1258. }
  1259. sched->galloc = ggml_gallocr_new_n(sched->bufts, n_backends);
  1260. ggml_backend_sched_reset(sched);
  1261. return sched;
  1262. }
  1263. void ggml_backend_sched_free(ggml_backend_sched_t sched) {
  1264. if (sched == NULL) {
  1265. return;
  1266. }
  1267. ggml_gallocr_free(sched->galloc);
  1268. ggml_free(sched->ctx);
  1269. free(sched->hash_set.keys);
  1270. free(sched->tensor_backend_id);
  1271. free(sched->tensor_copies);
  1272. free(sched->node_backend_ids);
  1273. free(sched);
  1274. }
  1275. void ggml_backend_sched_reset(ggml_backend_sched_t sched) {
  1276. // reset state for the next run
  1277. size_t hash_size = sched->hash_set.size;
  1278. memset(sched->hash_set.keys, 0, sizeof(sched->hash_set.keys[0]) * hash_size); // NOLINT
  1279. memset(sched->tensor_backend_id, -1, sizeof(sched->tensor_backend_id[0]) * hash_size);
  1280. memset(sched->tensor_copies, 0, sizeof(sched->tensor_copies[0]) * hash_size);
  1281. sched->is_reset = true;
  1282. }
  1283. bool ggml_backend_sched_reserve(ggml_backend_sched_t sched, struct ggml_cgraph * measure_graph) {
  1284. ggml_backend_sched_split_graph(sched, measure_graph);
  1285. if (!ggml_gallocr_reserve_n(sched->galloc, sched->graph, sched->node_backend_ids)) {
  1286. return false;
  1287. }
  1288. ggml_backend_sched_reset(sched);
  1289. return true;
  1290. }
  1291. enum ggml_status ggml_backend_sched_graph_compute(ggml_backend_sched_t sched, struct ggml_cgraph * graph) {
  1292. GGML_ASSERT((int)sched->hash_set.size >= graph->n_nodes + GGML_MAX_SPLITS*GGML_MAX_SPLIT_INPUTS);
  1293. if (!sched->is_reset) {
  1294. ggml_backend_sched_reset(sched);
  1295. }
  1296. ggml_backend_sched_split_graph(sched, graph);
  1297. if (!ggml_backend_sched_alloc_splits(sched)) {
  1298. return GGML_STATUS_ALLOC_FAILED;
  1299. }
  1300. return ggml_backend_sched_compute_splits(sched);
  1301. }
  1302. void ggml_backend_sched_set_eval_callback(ggml_backend_sched_t sched, ggml_backend_sched_eval_callback callback, void * user_data) {
  1303. sched->callback_eval = callback;
  1304. sched->callback_eval_user_data = user_data;
  1305. }
  1306. int ggml_backend_sched_get_n_splits(ggml_backend_sched_t sched) {
  1307. return sched->n_splits;
  1308. }
  1309. size_t ggml_backend_sched_get_buffer_size(ggml_backend_sched_t sched, ggml_backend_t backend) {
  1310. int backend_index = ggml_backend_sched_backend_id(sched, backend);
  1311. GGML_ASSERT(backend_index >= 0 && backend_index < sched->n_backends);
  1312. return ggml_gallocr_get_buffer_size(sched->galloc, backend_index);
  1313. }
  1314. void ggml_backend_sched_set_node_backend(ggml_backend_sched_t sched, struct ggml_tensor * node, ggml_backend_t backend) {
  1315. int backend_index = ggml_backend_sched_backend_id(sched, backend);
  1316. GGML_ASSERT(backend_index >= 0 && backend_index < sched->n_backends);
  1317. tensor_backend_id(node) = backend_index;
  1318. }
  1319. ggml_backend_t ggml_backend_sched_get_node_backend(ggml_backend_sched_t sched, struct ggml_tensor * node) {
  1320. int backend_index = tensor_backend_id(node);
  1321. if (backend_index == -1) {
  1322. return NULL;
  1323. }
  1324. return sched->backends[backend_index];
  1325. }
  1326. // utils
  1327. void ggml_backend_view_init(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor) {
  1328. GGML_ASSERT(tensor->buffer == NULL);
  1329. GGML_ASSERT(tensor->view_src != NULL);
  1330. GGML_ASSERT(tensor->view_src->buffer != NULL);
  1331. GGML_ASSERT(tensor->view_src->data != NULL);
  1332. tensor->buffer = buffer;
  1333. tensor->data = (char *)tensor->view_src->data + tensor->view_offs;
  1334. tensor->backend = tensor->view_src->backend;
  1335. ggml_backend_buffer_init_tensor(buffer, tensor);
  1336. }
  1337. void ggml_backend_tensor_alloc(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor, void * addr) {
  1338. GGML_ASSERT(tensor->buffer == NULL);
  1339. GGML_ASSERT(tensor->data == NULL);
  1340. GGML_ASSERT(tensor->view_src == NULL);
  1341. GGML_ASSERT(addr >= ggml_backend_buffer_get_base(buffer));
  1342. GGML_ASSERT((char *)addr + ggml_backend_buffer_get_alloc_size(buffer, tensor) <=
  1343. (char *)ggml_backend_buffer_get_base(buffer) + ggml_backend_buffer_get_size(buffer));
  1344. tensor->buffer = buffer;
  1345. tensor->data = addr;
  1346. ggml_backend_buffer_init_tensor(buffer, tensor);
  1347. }
  1348. static struct ggml_tensor * graph_copy_dup_tensor(struct ggml_hash_set hash_set, struct ggml_tensor ** node_copies,
  1349. struct ggml_context * ctx_allocated, struct ggml_context * ctx_unallocated, struct ggml_tensor * src) {
  1350. GGML_ASSERT(src != NULL);
  1351. GGML_ASSERT(src->data && "graph must be allocated");
  1352. size_t id = ggml_hash_insert(hash_set, src);
  1353. if (id == GGML_HASHTABLE_ALREADY_EXISTS) {
  1354. return node_copies[ggml_hash_find(hash_set, src)];
  1355. }
  1356. struct ggml_tensor * dst = ggml_dup_tensor_layout(src->data && !src->view_src ? ctx_allocated : ctx_unallocated, src);
  1357. if (src->view_src != NULL) {
  1358. dst->view_src = graph_copy_dup_tensor(hash_set, node_copies, ctx_allocated, ctx_unallocated, src->view_src);
  1359. dst->view_offs = src->view_offs;
  1360. }
  1361. dst->op = src->op;
  1362. memcpy(dst->op_params, src->op_params, sizeof(dst->op_params));
  1363. ggml_set_name(dst, src->name);
  1364. // copy src
  1365. for (int i = 0; i < GGML_MAX_SRC; i++) {
  1366. struct ggml_tensor * s = src->src[i];
  1367. if (s == NULL) {
  1368. continue;
  1369. }
  1370. dst->src[i] = graph_copy_dup_tensor(hash_set, node_copies, ctx_allocated, ctx_unallocated, s);
  1371. }
  1372. node_copies[id] = dst;
  1373. return dst;
  1374. }
  1375. static void graph_copy_init_tensor(struct ggml_hash_set hash_set, struct ggml_tensor ** node_copies, bool * node_init, struct ggml_tensor * src) {
  1376. size_t id = ggml_hash_find(hash_set, src);
  1377. if (node_init[id]) {
  1378. return;
  1379. }
  1380. node_init[id] = true;
  1381. struct ggml_tensor * dst = node_copies[id];
  1382. if (dst->view_src != NULL) {
  1383. graph_copy_init_tensor(hash_set, node_copies, node_init, src->view_src);
  1384. ggml_backend_view_init(dst->view_src->buffer, dst);
  1385. }
  1386. else {
  1387. ggml_backend_tensor_copy(src, dst);
  1388. }
  1389. // init src
  1390. for (int i = 0; i < GGML_MAX_SRC; i++) {
  1391. struct ggml_tensor * s = src->src[i];
  1392. if (s == NULL) {
  1393. continue;
  1394. }
  1395. graph_copy_init_tensor(hash_set, node_copies, node_init, s);
  1396. }
  1397. }
  1398. struct ggml_backend_graph_copy ggml_backend_graph_copy(ggml_backend_t backend, struct ggml_cgraph * graph) {
  1399. struct ggml_hash_set hash_set = {
  1400. /* .size = */ graph->visited_hash_table.size,
  1401. /* .keys = */ calloc(sizeof(hash_set.keys[0]), graph->visited_hash_table.size) // NOLINT
  1402. };
  1403. struct ggml_tensor ** node_copies = calloc(sizeof(node_copies[0]), hash_set.size); // NOLINT
  1404. bool * node_init = calloc(sizeof(node_init[0]), hash_set.size);
  1405. struct ggml_init_params params = {
  1406. /* .mem_size = */ ggml_tensor_overhead()*hash_set.size + ggml_graph_overhead_custom(graph->size, false),
  1407. /* .mem_buffer = */ NULL,
  1408. /* .no_alloc = */ true
  1409. };
  1410. struct ggml_context * ctx_allocated = ggml_init(params);
  1411. struct ggml_context * ctx_unallocated = ggml_init(params);
  1412. if (ctx_allocated == NULL || ctx_unallocated == NULL) {
  1413. fprintf(stderr, "failed to allocate context for graph copy\n");
  1414. free(hash_set.keys);
  1415. free(node_copies);
  1416. free(node_init);
  1417. ggml_free(ctx_allocated);
  1418. ggml_free(ctx_unallocated);
  1419. return (struct ggml_backend_graph_copy) {
  1420. /* .buffer = */ NULL,
  1421. /* .ctx_allocated = */ NULL,
  1422. /* .ctx_unallocated = */ NULL,
  1423. /* .graph = */ NULL,
  1424. };
  1425. }
  1426. // dup nodes
  1427. for (int i = 0; i < graph->n_nodes; i++) {
  1428. struct ggml_tensor * node = graph->nodes[i];
  1429. graph_copy_dup_tensor(hash_set, node_copies, ctx_allocated, ctx_unallocated, node);
  1430. }
  1431. // allocate nodes
  1432. ggml_backend_buffer_t buffer = ggml_backend_alloc_ctx_tensors(ctx_allocated, backend);
  1433. if (buffer == NULL) {
  1434. fprintf(stderr, "failed to allocate buffer for graph copy\n");
  1435. free(hash_set.keys);
  1436. free(node_copies);
  1437. free(node_init);
  1438. ggml_free(ctx_allocated);
  1439. ggml_free(ctx_unallocated);
  1440. return (struct ggml_backend_graph_copy) {
  1441. /* .buffer = */ NULL,
  1442. /* .ctx_allocated = */ NULL,
  1443. /* .ctx_unallocated = */ NULL,
  1444. /* .graph = */ NULL,
  1445. };
  1446. }
  1447. //printf("copy buffer size: %zu MB\n", ggml_backend_buffer_get_size(buffer) / 1024 / 1024);
  1448. // copy data and init views
  1449. for (int i = 0; i < graph->n_nodes; i++) {
  1450. struct ggml_tensor * node = graph->nodes[i];
  1451. graph_copy_init_tensor(hash_set, node_copies, node_init, node);
  1452. }
  1453. // build graph copy
  1454. struct ggml_cgraph * graph_copy = ggml_new_graph_custom(ctx_allocated, graph->size, false);
  1455. for (int i = 0; i < graph->n_nodes; i++) {
  1456. struct ggml_tensor * node = graph->nodes[i];
  1457. struct ggml_tensor * node_copy = node_copies[ggml_hash_find(hash_set, node)];
  1458. graph_copy->nodes[i] = node_copy;
  1459. }
  1460. graph_copy->n_nodes = graph->n_nodes;
  1461. free(hash_set.keys);
  1462. free(node_copies);
  1463. free(node_init);
  1464. return (struct ggml_backend_graph_copy) {
  1465. /* .buffer = */ buffer,
  1466. /* .ctx_allocated = */ ctx_allocated,
  1467. /* .ctx_unallocated = */ ctx_unallocated,
  1468. /* .graph = */ graph_copy,
  1469. };
  1470. }
  1471. void ggml_backend_graph_copy_free(struct ggml_backend_graph_copy copy) {
  1472. ggml_backend_buffer_free(copy.buffer);
  1473. ggml_free(copy.ctx_allocated);
  1474. ggml_free(copy.ctx_unallocated);
  1475. }
  1476. bool ggml_backend_compare_graph_backend(ggml_backend_t backend1, ggml_backend_t backend2, struct ggml_cgraph * graph, ggml_backend_eval_callback callback, void * user_data) {
  1477. struct ggml_backend_graph_copy copy = ggml_backend_graph_copy(backend2, graph);
  1478. if (copy.buffer == NULL) {
  1479. return false;
  1480. }
  1481. struct ggml_cgraph * g1 = graph;
  1482. struct ggml_cgraph * g2 = copy.graph;
  1483. assert(g1->n_nodes == g2->n_nodes);
  1484. for (int i = 0; i < g1->n_nodes; i++) {
  1485. //printf("eval %d/%d\n", i, g1->n_nodes);
  1486. struct ggml_tensor * t1 = g1->nodes[i];
  1487. struct ggml_tensor * t2 = g2->nodes[i];
  1488. assert(t1->op == t2->op && ggml_are_same_layout(t1, t2));
  1489. struct ggml_cgraph g1v = ggml_graph_view(g1, i, i + 1);
  1490. struct ggml_cgraph g2v = ggml_graph_view(g2, i, i + 1);
  1491. ggml_backend_graph_compute(backend1, &g1v);
  1492. ggml_backend_graph_compute(backend2, &g2v);
  1493. if (ggml_is_view_op(t1->op)) {
  1494. continue;
  1495. }
  1496. // compare results, calculate rms etc
  1497. if (!callback(i, t1, t2, user_data)) {
  1498. break;
  1499. }
  1500. }
  1501. ggml_backend_graph_copy_free(copy);
  1502. return true;
  1503. }