ggml-backend.c 81 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214
  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_is_host(ggml_backend_buffer_type_t buft) {
  38. if (buft->iface.is_host) {
  39. return buft->iface.is_host(buft);
  40. }
  41. return false;
  42. }
  43. // backend buffer
  44. GGML_CALL ggml_backend_buffer_t ggml_backend_buffer_init(
  45. ggml_backend_buffer_type_t buft,
  46. struct ggml_backend_buffer_i iface,
  47. ggml_backend_buffer_context_t context,
  48. size_t size) {
  49. ggml_backend_buffer_t buffer = malloc(sizeof(struct ggml_backend_buffer));
  50. (*buffer) = (struct ggml_backend_buffer) {
  51. /* .interface = */ iface,
  52. /* .buft = */ buft,
  53. /* .context = */ context,
  54. /* .size = */ size,
  55. /* .usage = */ GGML_BACKEND_BUFFER_USAGE_ANY
  56. };
  57. return buffer;
  58. }
  59. const char * ggml_backend_buffer_name(ggml_backend_buffer_t buffer) {
  60. return buffer->iface.get_name(buffer);
  61. }
  62. void ggml_backend_buffer_free(ggml_backend_buffer_t buffer) {
  63. if (buffer == NULL) {
  64. return;
  65. }
  66. if (buffer->iface.free_buffer != NULL) {
  67. buffer->iface.free_buffer(buffer);
  68. }
  69. free(buffer);
  70. }
  71. size_t ggml_backend_buffer_get_size(ggml_backend_buffer_t buffer) {
  72. return buffer->size;
  73. }
  74. void * ggml_backend_buffer_get_base(ggml_backend_buffer_t buffer) {
  75. void * base = buffer->iface.get_base(buffer);
  76. GGML_ASSERT(base != NULL && "backend buffer base cannot be NULL");
  77. return base;
  78. }
  79. GGML_CALL void ggml_backend_buffer_init_tensor(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor) {
  80. // init_tensor is optional
  81. if (buffer->iface.init_tensor) {
  82. buffer->iface.init_tensor(buffer, tensor);
  83. }
  84. }
  85. size_t ggml_backend_buffer_get_alignment (ggml_backend_buffer_t buffer) {
  86. return ggml_backend_buft_get_alignment(ggml_backend_buffer_get_type(buffer));
  87. }
  88. size_t ggml_backend_buffer_get_max_size(ggml_backend_buffer_t buffer) {
  89. return ggml_backend_buft_get_max_size(ggml_backend_buffer_get_type(buffer));
  90. }
  91. size_t ggml_backend_buffer_get_alloc_size(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor) {
  92. return ggml_backend_buft_get_alloc_size(ggml_backend_buffer_get_type(buffer), tensor);
  93. }
  94. void ggml_backend_buffer_clear(ggml_backend_buffer_t buffer, uint8_t value) {
  95. buffer->iface.clear(buffer, value);
  96. }
  97. bool ggml_backend_buffer_is_host(ggml_backend_buffer_t buffer) {
  98. return ggml_backend_buft_is_host(ggml_backend_buffer_get_type(buffer));
  99. }
  100. void ggml_backend_buffer_set_usage(ggml_backend_buffer_t buffer, enum ggml_backend_buffer_usage usage) {
  101. buffer->usage = usage;
  102. // FIXME: add a generic callback to the buffer interface
  103. if (ggml_backend_buffer_is_multi_buffer(buffer)) {
  104. ggml_backend_multi_buffer_set_usage(buffer, usage);
  105. }
  106. }
  107. ggml_backend_buffer_type_t ggml_backend_buffer_get_type(ggml_backend_buffer_t buffer) {
  108. return buffer->buft;
  109. }
  110. void ggml_backend_buffer_reset(ggml_backend_buffer_t buffer) {
  111. if (buffer->iface.reset) {
  112. buffer->iface.reset(buffer);
  113. }
  114. }
  115. bool ggml_backend_buffer_copy_tensor(const struct ggml_tensor * src, struct ggml_tensor * dst) {
  116. ggml_backend_buffer_t dst_buf = dst->view_src ? dst->view_src->buffer : dst->buffer;
  117. if (dst_buf->iface.cpy_tensor) {
  118. return dst_buf->iface.cpy_tensor(dst_buf, src, dst);
  119. }
  120. return false;
  121. }
  122. // backend
  123. ggml_guid_t ggml_backend_guid(ggml_backend_t backend) {
  124. if (backend == NULL) {
  125. return NULL;
  126. }
  127. return backend->guid;
  128. }
  129. const char * ggml_backend_name(ggml_backend_t backend) {
  130. if (backend == NULL) {
  131. return "NULL";
  132. }
  133. return backend->iface.get_name(backend);
  134. }
  135. void ggml_backend_free(ggml_backend_t backend) {
  136. if (backend == NULL) {
  137. return;
  138. }
  139. backend->iface.free(backend);
  140. }
  141. ggml_backend_buffer_type_t ggml_backend_get_default_buffer_type(ggml_backend_t backend) {
  142. return backend->iface.get_default_buffer_type(backend);
  143. }
  144. ggml_backend_buffer_t ggml_backend_alloc_buffer(ggml_backend_t backend, size_t size) {
  145. return ggml_backend_buft_alloc_buffer(ggml_backend_get_default_buffer_type(backend), size);
  146. }
  147. size_t ggml_backend_get_alignment(ggml_backend_t backend) {
  148. return ggml_backend_buft_get_alignment(ggml_backend_get_default_buffer_type(backend));
  149. }
  150. size_t ggml_backend_get_max_size(ggml_backend_t backend) {
  151. return ggml_backend_buft_get_max_size(ggml_backend_get_default_buffer_type(backend));
  152. }
  153. void ggml_backend_tensor_set_async(ggml_backend_t backend, struct ggml_tensor * tensor, const void * data, size_t offset, size_t size) {
  154. GGML_ASSERT(tensor->data != NULL && "tensor not allocated");
  155. GGML_ASSERT(offset + size <= ggml_nbytes(tensor) && "tensor write out of bounds");
  156. if (backend->iface.set_tensor_async == NULL) {
  157. ggml_backend_tensor_set(tensor, data, offset, size);
  158. } else {
  159. backend->iface.set_tensor_async(backend, tensor, data, offset, size);
  160. }
  161. }
  162. void ggml_backend_tensor_get_async(ggml_backend_t backend, const struct ggml_tensor * tensor, void * data, size_t offset, size_t size) {
  163. GGML_ASSERT(tensor->data != NULL && "tensor not allocated");
  164. GGML_ASSERT(offset + size <= ggml_nbytes(tensor) && "tensor read out of bounds");
  165. if (backend->iface.get_tensor_async == NULL) {
  166. ggml_backend_tensor_get(tensor, data, offset, size);
  167. } else {
  168. backend->iface.get_tensor_async(backend, tensor, data, offset, size);
  169. }
  170. }
  171. GGML_CALL void ggml_backend_tensor_set(struct ggml_tensor * tensor, const void * data, size_t offset, size_t size) {
  172. ggml_backend_buffer_t buf = tensor->view_src ? tensor->view_src->buffer : tensor->buffer;
  173. GGML_ASSERT(buf != NULL && "tensor buffer not set");
  174. GGML_ASSERT(tensor->data != NULL && "tensor not allocated");
  175. GGML_ASSERT(offset + size <= ggml_nbytes(tensor) && "tensor write out of bounds");
  176. if (!size) {
  177. return;
  178. }
  179. buf->iface.set_tensor(buf, tensor, data, offset, size);
  180. }
  181. GGML_CALL void ggml_backend_tensor_get(const struct ggml_tensor * tensor, void * data, size_t offset, size_t size) {
  182. ggml_backend_buffer_t buf = tensor->view_src ? tensor->view_src->buffer : tensor->buffer;
  183. GGML_ASSERT(buf != NULL && "tensor buffer not set");
  184. GGML_ASSERT(tensor->data != NULL && "tensor not allocated");
  185. GGML_ASSERT(offset + size <= ggml_nbytes(tensor) && "tensor read out of bounds");
  186. if (!size) {
  187. return;
  188. }
  189. buf->iface.get_tensor(buf, tensor, data, offset, size);
  190. }
  191. void ggml_backend_synchronize(ggml_backend_t backend) {
  192. if (backend->iface.synchronize == NULL) {
  193. return;
  194. }
  195. backend->iface.synchronize(backend);
  196. }
  197. ggml_backend_graph_plan_t ggml_backend_graph_plan_create(ggml_backend_t backend, struct ggml_cgraph * cgraph) {
  198. GGML_ASSERT(backend->iface.graph_plan_create != NULL);
  199. return backend->iface.graph_plan_create(backend, cgraph);
  200. }
  201. void ggml_backend_graph_plan_free(ggml_backend_t backend, ggml_backend_graph_plan_t plan) {
  202. GGML_ASSERT(backend->iface.graph_plan_free != NULL);
  203. backend->iface.graph_plan_free(backend, plan);
  204. }
  205. enum ggml_status ggml_backend_graph_plan_compute(ggml_backend_t backend, ggml_backend_graph_plan_t plan) {
  206. GGML_ASSERT(backend->iface.graph_plan_compute != NULL);
  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. enum ggml_status err = ggml_backend_graph_compute_async(backend, cgraph);
  211. ggml_backend_synchronize(backend);
  212. return err;
  213. }
  214. enum ggml_status ggml_backend_graph_compute_async(ggml_backend_t backend, struct ggml_cgraph * cgraph) {
  215. return backend->iface.graph_compute(backend, cgraph);
  216. }
  217. bool ggml_backend_supports_op(ggml_backend_t backend, const struct ggml_tensor * op) {
  218. return backend->iface.supports_op(backend, op);
  219. }
  220. bool ggml_backend_supports_buft(ggml_backend_t backend, ggml_backend_buffer_type_t buft) {
  221. return backend->iface.supports_buft(backend, buft);
  222. }
  223. bool ggml_backend_offload_op(ggml_backend_t backend, const struct ggml_tensor * op) {
  224. if (backend->iface.offload_op != NULL) {
  225. return backend->iface.offload_op(backend, op);
  226. }
  227. return false;
  228. }
  229. // backend copy
  230. static bool ggml_are_same_layout(const struct ggml_tensor * a, const struct ggml_tensor * b) {
  231. if (a->type != b->type) {
  232. return false;
  233. }
  234. for (int i = 0; i < GGML_MAX_DIMS; i++) {
  235. if (a->ne[i] != b->ne[i]) {
  236. return false;
  237. }
  238. if (a->nb[i] != b->nb[i]) {
  239. return false;
  240. }
  241. }
  242. return true;
  243. }
  244. void ggml_backend_tensor_copy(struct ggml_tensor * src, struct ggml_tensor * dst) {
  245. GGML_ASSERT(ggml_are_same_layout(src, dst) && "cannot copy tensors with different layouts");
  246. if (src == dst) {
  247. return;
  248. }
  249. if (ggml_backend_buffer_is_host(src->buffer)) {
  250. ggml_backend_tensor_set(dst, src->data, 0, ggml_nbytes(src));
  251. } else if (ggml_backend_buffer_is_host(dst->buffer)) {
  252. ggml_backend_tensor_get(src, dst->data, 0, ggml_nbytes(src));
  253. } else if (!ggml_backend_buffer_copy_tensor(src, dst)) {
  254. #ifndef NDEBUG
  255. fprintf(stderr, "%s: warning: slow copy from %s to %s\n", __func__, ggml_backend_buffer_name(src->buffer), ggml_backend_buffer_name(dst->buffer));
  256. #endif
  257. size_t nbytes = ggml_nbytes(src);
  258. void * data = malloc(nbytes);
  259. ggml_backend_tensor_get(src, data, 0, nbytes);
  260. ggml_backend_tensor_set(dst, data, 0, nbytes);
  261. free(data);
  262. }
  263. }
  264. void ggml_backend_tensor_copy_async(ggml_backend_t backend_src, ggml_backend_t backend_dst, struct ggml_tensor * src, struct ggml_tensor * dst) {
  265. GGML_ASSERT(ggml_are_same_layout(src, dst) && "cannot copy tensors with different layouts");
  266. if (src == dst) {
  267. return;
  268. }
  269. if (backend_dst->iface.cpy_tensor_async != NULL) {
  270. if (backend_dst->iface.cpy_tensor_async(backend_src, backend_dst, src, dst)) {
  271. return;
  272. }
  273. }
  274. // an async copy would normally happen after all the queued operations on both backends are completed
  275. // sync src, set_async dst
  276. if (ggml_backend_buffer_is_host(src->buffer)) {
  277. ggml_backend_synchronize(backend_src);
  278. ggml_backend_tensor_set_async(backend_dst, dst, src->data, 0, ggml_nbytes(src));
  279. } else {
  280. ggml_backend_synchronize(backend_src);
  281. ggml_backend_tensor_copy(src, dst);
  282. ggml_backend_synchronize(backend_dst);
  283. }
  284. }
  285. // events
  286. ggml_backend_event_t ggml_backend_event_new(ggml_backend_t backend) {
  287. if (backend->iface.event_new == NULL) {
  288. return NULL;
  289. }
  290. return backend->iface.event_new(backend);
  291. }
  292. void ggml_backend_event_free(ggml_backend_event_t event) {
  293. if (event == NULL) {
  294. return;
  295. }
  296. event->backend->iface.event_free(event);
  297. }
  298. void ggml_backend_event_record(ggml_backend_event_t event) {
  299. GGML_ASSERT(event->backend->iface.event_record != NULL);
  300. event->backend->iface.event_record(event);
  301. }
  302. void ggml_backend_event_synchronize(ggml_backend_event_t event) {
  303. GGML_ASSERT(event->backend->iface.event_synchronize != NULL);
  304. event->backend->iface.event_synchronize(event);
  305. }
  306. void ggml_backend_event_wait(ggml_backend_t backend, ggml_backend_event_t event) {
  307. GGML_ASSERT(backend->iface.event_wait != NULL);
  308. backend->iface.event_wait(backend, event);
  309. }
  310. // backend registry
  311. #define GGML_REG_MAX_BACKENDS 16
  312. struct ggml_backend_reg {
  313. char name[128];
  314. ggml_backend_init_fn init_fn;
  315. ggml_backend_buffer_type_t default_buffer_type;
  316. void * user_data;
  317. };
  318. static struct ggml_backend_reg ggml_backend_registry[GGML_REG_MAX_BACKENDS];
  319. static size_t ggml_backend_registry_count = 0;
  320. GGML_CALL static ggml_backend_t ggml_backend_reg_cpu_init(const char * params, void * user_data);
  321. GGML_CALL static void ggml_backend_registry_init(void) {
  322. static bool initialized = false;
  323. if (initialized) {
  324. return;
  325. }
  326. initialized = true;
  327. ggml_backend_register("CPU", ggml_backend_reg_cpu_init, ggml_backend_cpu_buffer_type(), NULL);
  328. // add forward decls here to avoid including the backend headers
  329. #ifdef GGML_USE_CUDA
  330. extern GGML_CALL void ggml_backend_cuda_reg_devices(void);
  331. ggml_backend_cuda_reg_devices();
  332. #endif
  333. #ifdef GGML_USE_SYCL
  334. extern void ggml_backend_sycl_reg_devices(void);
  335. ggml_backend_sycl_reg_devices();
  336. #endif
  337. #ifdef GGML_USE_METAL
  338. extern GGML_CALL ggml_backend_t ggml_backend_reg_metal_init(const char * params, void * user_data);
  339. extern GGML_CALL ggml_backend_buffer_type_t ggml_backend_metal_buffer_type(void);
  340. ggml_backend_register("Metal", ggml_backend_reg_metal_init, ggml_backend_metal_buffer_type(), NULL);
  341. #endif
  342. #ifdef GGML_USE_VULKAN
  343. extern GGML_CALL int ggml_backend_vk_reg_devices(void);
  344. ggml_backend_vk_reg_devices();
  345. #endif
  346. #ifdef GGML_USE_KOMPUTE
  347. extern GGML_CALL void ggml_backend_kompute_reg_devices(void);
  348. ggml_backend_kompute_reg_devices();
  349. #endif
  350. }
  351. 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) {
  352. GGML_ASSERT(ggml_backend_registry_count < GGML_REG_MAX_BACKENDS);
  353. size_t id = ggml_backend_registry_count;
  354. ggml_backend_registry[id] = (struct ggml_backend_reg) {
  355. /* .name = */ {0},
  356. /* .fn = */ init_fn,
  357. /* .default_buffer_type = */ default_buffer_type,
  358. /* .user_data = */ user_data,
  359. };
  360. snprintf(ggml_backend_registry[id].name, sizeof(ggml_backend_registry[id].name), "%s", name);
  361. #ifndef NDEBUG
  362. fprintf(stderr, "%s: registered backend %s\n", __func__, name);
  363. #endif
  364. ggml_backend_registry_count++;
  365. }
  366. size_t ggml_backend_reg_get_count(void) {
  367. ggml_backend_registry_init();
  368. return ggml_backend_registry_count;
  369. }
  370. size_t ggml_backend_reg_find_by_name(const char * name) {
  371. ggml_backend_registry_init();
  372. for (size_t i = 0; i < ggml_backend_registry_count; i++) {
  373. // TODO: case insensitive in a portable way
  374. if (strcmp(ggml_backend_registry[i].name, name) == 0) {
  375. return i;
  376. }
  377. }
  378. // not found
  379. return SIZE_MAX;
  380. }
  381. // init from backend:params string
  382. ggml_backend_t ggml_backend_reg_init_backend_from_str(const char * backend_str) {
  383. ggml_backend_registry_init();
  384. const char * params = strchr(backend_str, ':');
  385. char backend_name[128];
  386. if (params == NULL) {
  387. snprintf(backend_name, sizeof(backend_name), "%s", backend_str);
  388. params = "";
  389. } else {
  390. snprintf(backend_name, sizeof(backend_name), "%.*s", (int)(params - backend_str), backend_str);
  391. params++;
  392. }
  393. size_t backend_i = ggml_backend_reg_find_by_name(backend_name);
  394. if (backend_i == SIZE_MAX) {
  395. fprintf(stderr, "%s: backend %s not found\n", __func__, backend_name);
  396. return NULL;
  397. }
  398. return ggml_backend_reg_init_backend(backend_i, params);
  399. }
  400. const char * ggml_backend_reg_get_name(size_t i) {
  401. ggml_backend_registry_init();
  402. GGML_ASSERT(i < ggml_backend_registry_count);
  403. return ggml_backend_registry[i].name;
  404. }
  405. ggml_backend_t ggml_backend_reg_init_backend(size_t i, const char * params) {
  406. ggml_backend_registry_init();
  407. GGML_ASSERT(i < ggml_backend_registry_count);
  408. return ggml_backend_registry[i].init_fn(params, ggml_backend_registry[i].user_data);
  409. }
  410. ggml_backend_buffer_type_t ggml_backend_reg_get_default_buffer_type(size_t i) {
  411. ggml_backend_registry_init();
  412. GGML_ASSERT(i < ggml_backend_registry_count);
  413. return ggml_backend_registry[i].default_buffer_type;
  414. }
  415. ggml_backend_buffer_t ggml_backend_reg_alloc_buffer(size_t i, size_t size) {
  416. ggml_backend_registry_init();
  417. GGML_ASSERT(i < ggml_backend_registry_count);
  418. return ggml_backend_buft_alloc_buffer(ggml_backend_registry[i].default_buffer_type, size);
  419. }
  420. // backend CPU
  421. static const size_t TENSOR_ALIGNMENT = 32; // required for mmap as gguf only guarantees 32-byte alignment
  422. GGML_CALL static const char * ggml_backend_cpu_buffer_name(ggml_backend_buffer_t buffer) {
  423. return "CPU";
  424. GGML_UNUSED(buffer);
  425. }
  426. GGML_CALL static void * ggml_backend_cpu_buffer_get_base(ggml_backend_buffer_t buffer) {
  427. uintptr_t data = (uintptr_t)buffer->context;
  428. // align the buffer
  429. if (data % TENSOR_ALIGNMENT != 0) {
  430. data = GGML_PAD(data, TENSOR_ALIGNMENT);
  431. }
  432. return (void *)data;
  433. }
  434. GGML_CALL static void ggml_backend_cpu_buffer_free_buffer(ggml_backend_buffer_t buffer) {
  435. free(buffer->context);
  436. }
  437. 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) {
  438. memcpy((char *)tensor->data + offset, data, size);
  439. GGML_UNUSED(buffer);
  440. }
  441. 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) {
  442. memcpy(data, (const char *)tensor->data + offset, size);
  443. GGML_UNUSED(buffer);
  444. }
  445. GGML_CALL static bool ggml_backend_cpu_buffer_cpy_tensor(ggml_backend_buffer_t buffer, const struct ggml_tensor * src, struct ggml_tensor * dst) {
  446. if (ggml_backend_buffer_is_host(src->buffer)) {
  447. memcpy(dst->data, src->data, ggml_nbytes(src));
  448. return true;
  449. }
  450. return false;
  451. GGML_UNUSED(buffer);
  452. }
  453. GGML_CALL static void ggml_backend_cpu_buffer_clear(ggml_backend_buffer_t buffer, uint8_t value) {
  454. memset(buffer->context, value, buffer->size);
  455. }
  456. static struct ggml_backend_buffer_i cpu_backend_buffer_i = {
  457. /* .get_name = */ ggml_backend_cpu_buffer_name,
  458. /* .free_buffer = */ ggml_backend_cpu_buffer_free_buffer,
  459. /* .get_base = */ ggml_backend_cpu_buffer_get_base,
  460. /* .init_tensor = */ NULL, // no initialization required
  461. /* .set_tensor = */ ggml_backend_cpu_buffer_set_tensor,
  462. /* .get_tensor = */ ggml_backend_cpu_buffer_get_tensor,
  463. /* .cpy_tensor = */ ggml_backend_cpu_buffer_cpy_tensor,
  464. /* .clear = */ ggml_backend_cpu_buffer_clear,
  465. /* .reset = */ NULL,
  466. };
  467. // for buffers from ptr, free is not called
  468. static struct ggml_backend_buffer_i cpu_backend_buffer_i_from_ptr = {
  469. /* .get_name = */ ggml_backend_cpu_buffer_name,
  470. /* .free_buffer = */ NULL, // ptr is not owned by the buffer, so it does not need to be freed
  471. /* .get_base = */ ggml_backend_cpu_buffer_get_base,
  472. /* .init_tensor = */ NULL, // no initialization required
  473. /* .set_tensor = */ ggml_backend_cpu_buffer_set_tensor,
  474. /* .get_tensor = */ ggml_backend_cpu_buffer_get_tensor,
  475. /* .cpy_tensor = */ ggml_backend_cpu_buffer_cpy_tensor,
  476. /* .clear = */ ggml_backend_cpu_buffer_clear,
  477. /* .reset = */ NULL,
  478. };
  479. GGML_CALL static const char * ggml_backend_cpu_buffer_type_get_name(ggml_backend_buffer_type_t buft) {
  480. return "CPU";
  481. GGML_UNUSED(buft);
  482. }
  483. GGML_CALL static ggml_backend_buffer_t ggml_backend_cpu_buffer_type_alloc_buffer(ggml_backend_buffer_type_t buft, size_t size) {
  484. size += TENSOR_ALIGNMENT; // malloc may return an address that is not aligned
  485. void * data = malloc(size); // TODO: use GGML_ALIGNED_MALLOC (move to ggml-impl.h)
  486. if (data == NULL) {
  487. fprintf(stderr, "%s: failed to allocate buffer of size %zu\n", __func__, size);
  488. return NULL;
  489. }
  490. return ggml_backend_buffer_init(buft, cpu_backend_buffer_i, data, size);
  491. }
  492. GGML_CALL static size_t ggml_backend_cpu_buffer_type_get_alignment(ggml_backend_buffer_type_t buft) {
  493. return TENSOR_ALIGNMENT;
  494. GGML_UNUSED(buft);
  495. }
  496. GGML_CALL static bool ggml_backend_cpu_buffer_type_is_host(ggml_backend_buffer_type_t buft) {
  497. return true;
  498. GGML_UNUSED(buft);
  499. }
  500. GGML_CALL ggml_backend_buffer_type_t ggml_backend_cpu_buffer_type(void) {
  501. static struct ggml_backend_buffer_type ggml_backend_cpu_buffer_type = {
  502. /* .iface = */ {
  503. /* .get_name = */ ggml_backend_cpu_buffer_type_get_name,
  504. /* .alloc_buffer = */ ggml_backend_cpu_buffer_type_alloc_buffer,
  505. /* .get_alignment = */ ggml_backend_cpu_buffer_type_get_alignment,
  506. /* .get_max_size = */ NULL, // defaults to SIZE_MAX
  507. /* .get_alloc_size = */ NULL, // defaults to ggml_nbytes
  508. /* .is_host = */ ggml_backend_cpu_buffer_type_is_host,
  509. },
  510. /* .context = */ NULL,
  511. };
  512. return &ggml_backend_cpu_buffer_type;
  513. }
  514. #ifdef GGML_USE_CPU_HBM
  515. // buffer type HBM
  516. #include <hbwmalloc.h>
  517. GGML_CALL static const char * ggml_backend_cpu_hbm_buffer_type_get_name(ggml_backend_buffer_type_t buft) {
  518. return "CPU_HBM";
  519. GGML_UNUSED(buft);
  520. }
  521. GGML_CALL static const char * ggml_backend_cpu_hbm_buffer_get_name(ggml_backend_buffer_t buf) {
  522. return "CPU_HBM";
  523. GGML_UNUSED(buf);
  524. }
  525. GGML_CALL static void ggml_backend_cpu_hbm_buffer_free_buffer(ggml_backend_buffer_t buffer) {
  526. hbw_free(buffer->context);
  527. }
  528. GGML_CALL static ggml_backend_buffer_t ggml_backend_cpu_hbm_buffer_type_alloc_buffer(ggml_backend_buffer_type_t buft, size_t size) {
  529. //void * ptr = hbw_malloc(size);
  530. void * ptr;
  531. int result = hbw_posix_memalign(&ptr, ggml_backend_cpu_buffer_type_get_alignment(buft), size);
  532. if (result != 0) {
  533. fprintf(stderr, "failed to allocate HBM buffer of size %zu\n", size);
  534. return NULL;
  535. }
  536. ggml_backend_buffer_t buffer = ggml_backend_cpu_buffer_from_ptr(ptr, size);
  537. buffer->buft = buft;
  538. buffer->iface.get_name = ggml_backend_cpu_hbm_buffer_get_name;
  539. buffer->iface.free_buffer = ggml_backend_cpu_hbm_buffer_free_buffer;
  540. return buffer;
  541. }
  542. ggml_backend_buffer_type_t ggml_backend_cpu_hbm_buffer_type(void) {
  543. static struct ggml_backend_buffer_type ggml_backend_cpu_buffer_type_hbm = {
  544. /* .iface = */ {
  545. /* .get_name = */ ggml_backend_cpu_hbm_buffer_type_get_name,
  546. /* .alloc_buffer = */ ggml_backend_cpu_hbm_buffer_type_alloc_buffer,
  547. /* .get_alignment = */ ggml_backend_cpu_buffer_type_get_alignment,
  548. /* .get_max_size = */ NULL, // defaults to SIZE_MAX
  549. /* .get_alloc_size = */ NULL, // defaults to ggml_nbytes
  550. /* .is_host = */ ggml_backend_cpu_buffer_type_is_host,
  551. },
  552. /* .context = */ NULL,
  553. };
  554. return &ggml_backend_cpu_buffer_type_hbm;
  555. }
  556. #endif
  557. struct ggml_backend_cpu_context {
  558. int n_threads;
  559. void * work_data;
  560. size_t work_size;
  561. ggml_abort_callback abort_callback;
  562. void * abort_callback_data;
  563. };
  564. GGML_CALL static const char * ggml_backend_cpu_name(ggml_backend_t backend) {
  565. return "CPU";
  566. GGML_UNUSED(backend);
  567. }
  568. GGML_CALL static void ggml_backend_cpu_free(ggml_backend_t backend) {
  569. struct ggml_backend_cpu_context * cpu_ctx = (struct ggml_backend_cpu_context *)backend->context;
  570. free(cpu_ctx->work_data);
  571. free(cpu_ctx);
  572. free(backend);
  573. }
  574. GGML_CALL static ggml_backend_buffer_type_t ggml_backend_cpu_get_default_buffer_type(ggml_backend_t backend) {
  575. return ggml_backend_cpu_buffer_type();
  576. GGML_UNUSED(backend);
  577. }
  578. struct ggml_backend_plan_cpu {
  579. struct ggml_cplan cplan;
  580. struct ggml_cgraph cgraph;
  581. };
  582. GGML_CALL static ggml_backend_graph_plan_t ggml_backend_cpu_graph_plan_create(ggml_backend_t backend, const struct ggml_cgraph * cgraph) {
  583. struct ggml_backend_cpu_context * cpu_ctx = (struct ggml_backend_cpu_context *)backend->context;
  584. struct ggml_backend_plan_cpu * cpu_plan = malloc(sizeof(struct ggml_backend_plan_cpu));
  585. cpu_plan->cplan = ggml_graph_plan(cgraph, cpu_ctx->n_threads);
  586. cpu_plan->cgraph = *cgraph; // FIXME: deep copy
  587. if (cpu_plan->cplan.work_size > 0) {
  588. cpu_plan->cplan.work_data = malloc(cpu_plan->cplan.work_size);
  589. if (cpu_plan->cplan.work_data == NULL) {
  590. free(cpu_plan);
  591. return NULL;
  592. }
  593. }
  594. cpu_plan->cplan.abort_callback = cpu_ctx->abort_callback;
  595. cpu_plan->cplan.abort_callback_data = cpu_ctx->abort_callback_data;
  596. return cpu_plan;
  597. }
  598. GGML_CALL static void ggml_backend_cpu_graph_plan_free(ggml_backend_t backend, ggml_backend_graph_plan_t plan) {
  599. struct ggml_backend_plan_cpu * cpu_plan = (struct ggml_backend_plan_cpu *)plan;
  600. free(cpu_plan->cplan.work_data);
  601. free(cpu_plan);
  602. GGML_UNUSED(backend);
  603. }
  604. GGML_CALL static enum ggml_status ggml_backend_cpu_graph_plan_compute(ggml_backend_t backend, ggml_backend_graph_plan_t plan) {
  605. struct ggml_backend_plan_cpu * cpu_plan = (struct ggml_backend_plan_cpu *)plan;
  606. return ggml_graph_compute(&cpu_plan->cgraph, &cpu_plan->cplan);
  607. GGML_UNUSED(backend);
  608. }
  609. GGML_CALL static enum ggml_status ggml_backend_cpu_graph_compute(ggml_backend_t backend, struct ggml_cgraph * cgraph) {
  610. struct ggml_backend_cpu_context * cpu_ctx = (struct ggml_backend_cpu_context *)backend->context;
  611. struct ggml_cplan cplan = ggml_graph_plan(cgraph, cpu_ctx->n_threads);
  612. if (cpu_ctx->work_size < cplan.work_size) {
  613. free(cpu_ctx->work_data);
  614. cpu_ctx->work_data = malloc(cplan.work_size);
  615. if (cpu_ctx->work_data == NULL) {
  616. cpu_ctx->work_size = 0;
  617. return GGML_STATUS_ALLOC_FAILED;
  618. }
  619. cpu_ctx->work_size = cplan.work_size;
  620. }
  621. cplan.work_data = cpu_ctx->work_data;
  622. cplan.abort_callback = cpu_ctx->abort_callback;
  623. cplan.abort_callback_data = cpu_ctx->abort_callback_data;
  624. return ggml_graph_compute(cgraph, &cplan);
  625. }
  626. GGML_CALL static bool ggml_backend_cpu_supports_op(ggml_backend_t backend, const struct ggml_tensor * op) {
  627. switch (op->op) {
  628. case GGML_OP_CPY:
  629. return
  630. op->type != GGML_TYPE_IQ2_XXS &&
  631. op->type != GGML_TYPE_IQ2_XS &&
  632. op->type != GGML_TYPE_IQ1_S &&
  633. op->type != GGML_TYPE_IQ1_M; // missing type_traits.from_float
  634. case GGML_OP_MUL_MAT:
  635. return op->src[1]->type == GGML_TYPE_F32 || op->src[1]->type == ggml_internal_get_type_traits(op->src[0]->type).vec_dot_type;
  636. default:
  637. return true;
  638. }
  639. GGML_UNUSED(backend);
  640. }
  641. GGML_CALL static bool ggml_backend_cpu_supports_buft(ggml_backend_t backend, ggml_backend_buffer_type_t buft) {
  642. return ggml_backend_buft_is_host(buft);
  643. GGML_UNUSED(backend);
  644. }
  645. static struct ggml_backend_i cpu_backend_i = {
  646. /* .get_name = */ ggml_backend_cpu_name,
  647. /* .free = */ ggml_backend_cpu_free,
  648. /* .get_default_buffer_type = */ ggml_backend_cpu_get_default_buffer_type,
  649. /* .set_tensor_async = */ NULL,
  650. /* .get_tensor_async = */ NULL,
  651. /* .cpy_tensor_async = */ NULL,
  652. /* .synchronize = */ NULL,
  653. /* .graph_plan_create = */ ggml_backend_cpu_graph_plan_create,
  654. /* .graph_plan_free = */ ggml_backend_cpu_graph_plan_free,
  655. /* .graph_plan_update = */ NULL,
  656. /* .graph_plan_compute = */ ggml_backend_cpu_graph_plan_compute,
  657. /* .graph_compute = */ ggml_backend_cpu_graph_compute,
  658. /* .supports_op = */ ggml_backend_cpu_supports_op,
  659. /* .supports_buft = */ ggml_backend_cpu_supports_buft,
  660. /* .offload_op = */ NULL,
  661. /* .event_new = */ NULL,
  662. /* .event_free = */ NULL,
  663. /* .event_record = */ NULL,
  664. /* .event_wait = */ NULL,
  665. /* .event_synchronize = */ NULL,
  666. };
  667. static ggml_guid_t ggml_backend_cpu_guid(void) {
  668. static ggml_guid guid = { 0xaa, 0x67, 0xc7, 0x43, 0x96, 0xe6, 0xa3, 0x8a, 0xe3, 0xaf, 0xea, 0x92, 0x36, 0xbc, 0xfc, 0x89 };
  669. return &guid;
  670. }
  671. ggml_backend_t ggml_backend_cpu_init(void) {
  672. struct ggml_backend_cpu_context * ctx = malloc(sizeof(struct ggml_backend_cpu_context));
  673. if (ctx == NULL) {
  674. return NULL;
  675. }
  676. ctx->n_threads = GGML_DEFAULT_N_THREADS;
  677. ctx->work_data = NULL;
  678. ctx->work_size = 0;
  679. ctx->abort_callback = NULL;
  680. ctx->abort_callback_data = NULL;
  681. ggml_backend_t cpu_backend = malloc(sizeof(struct ggml_backend));
  682. if (cpu_backend == NULL) {
  683. free(ctx);
  684. return NULL;
  685. }
  686. *cpu_backend = (struct ggml_backend) {
  687. /* .guid = */ ggml_backend_cpu_guid(),
  688. /* .interface = */ cpu_backend_i,
  689. /* .context = */ ctx
  690. };
  691. return cpu_backend;
  692. }
  693. GGML_CALL bool ggml_backend_is_cpu(ggml_backend_t backend) {
  694. return backend != NULL && ggml_guid_matches(backend->guid, ggml_backend_cpu_guid());
  695. }
  696. void ggml_backend_cpu_set_n_threads(ggml_backend_t backend_cpu, int n_threads) {
  697. GGML_ASSERT(ggml_backend_is_cpu(backend_cpu));
  698. struct ggml_backend_cpu_context * ctx = (struct ggml_backend_cpu_context *)backend_cpu->context;
  699. ctx->n_threads = n_threads;
  700. }
  701. void ggml_backend_cpu_set_abort_callback(ggml_backend_t backend_cpu, ggml_abort_callback abort_callback, void * abort_callback_data) {
  702. GGML_ASSERT(ggml_backend_is_cpu(backend_cpu));
  703. struct ggml_backend_cpu_context * ctx = (struct ggml_backend_cpu_context *)backend_cpu->context;
  704. ctx->abort_callback = abort_callback;
  705. ctx->abort_callback_data = abort_callback_data;
  706. }
  707. GGML_CALL ggml_backend_buffer_t ggml_backend_cpu_buffer_from_ptr(void * ptr, size_t size) {
  708. GGML_ASSERT((uintptr_t)ptr % TENSOR_ALIGNMENT == 0 && "buffer pointer must be aligned");
  709. return ggml_backend_buffer_init(ggml_backend_cpu_buffer_type(), cpu_backend_buffer_i_from_ptr, ptr, size);
  710. }
  711. GGML_CALL static ggml_backend_t ggml_backend_reg_cpu_init(const char * params, void * user_data) {
  712. return ggml_backend_cpu_init();
  713. GGML_UNUSED(params);
  714. GGML_UNUSED(user_data);
  715. }
  716. // multi-buffer buffer
  717. struct ggml_backend_multi_buffer_context {
  718. ggml_backend_buffer_t * buffers;
  719. size_t n_buffers;
  720. };
  721. typedef struct ggml_backend_multi_buffer_context * ggml_backend_multi_buffer_context_t;
  722. GGML_CALL static const char * ggml_backend_multi_buffer_get_name(ggml_backend_buffer_t buffer) {
  723. ggml_backend_multi_buffer_context_t ctx = (ggml_backend_multi_buffer_context_t) buffer->context;
  724. return ctx->buffers[0]->iface.get_name(ctx->buffers[0]);
  725. }
  726. GGML_CALL static void ggml_backend_multi_buffer_free_buffer(ggml_backend_buffer_t buffer) {
  727. ggml_backend_multi_buffer_context_t ctx = (ggml_backend_multi_buffer_context_t) buffer->context;
  728. for (size_t i = 0; i < ctx->n_buffers; i++) {
  729. ggml_backend_buffer_free(ctx->buffers[i]);
  730. }
  731. free(ctx->buffers);
  732. free(ctx);
  733. }
  734. GGML_CALL static void ggml_backend_multi_buffer_clear(ggml_backend_buffer_t buffer, uint8_t value) {
  735. ggml_backend_multi_buffer_context_t ctx = (ggml_backend_multi_buffer_context_t) buffer->context;
  736. for (size_t i = 0; i < ctx->n_buffers; i++) {
  737. ggml_backend_buffer_clear(ctx->buffers[i], value);
  738. }
  739. }
  740. static struct ggml_backend_buffer_i ggml_backend_multi_buffer_context_interface(void) {
  741. static struct ggml_backend_buffer_i multi_backend_buffer_i = {
  742. /* .get_name = */ ggml_backend_multi_buffer_get_name,
  743. /* .free_buffer = */ ggml_backend_multi_buffer_free_buffer,
  744. /* .get_base = */ NULL,
  745. /* .init_tensor = */ NULL,
  746. /* .set_tensor = */ NULL,
  747. /* .get_tensor = */ NULL,
  748. /* .cpy_tensor = */ NULL,
  749. /* .clear = */ ggml_backend_multi_buffer_clear,
  750. /* .reset = */ NULL,
  751. };
  752. return multi_backend_buffer_i;
  753. }
  754. GGML_CALL ggml_backend_buffer_t ggml_backend_multi_buffer_alloc_buffer(ggml_backend_buffer_t * buffers, size_t n_buffers) {
  755. ggml_backend_multi_buffer_context_t ctx = (ggml_backend_multi_buffer_context_t) malloc(sizeof(struct ggml_backend_multi_buffer_context));
  756. ctx->n_buffers = n_buffers;
  757. ctx->buffers = (ggml_backend_buffer_t *) malloc(n_buffers * sizeof(ggml_backend_buffer_t));
  758. GGML_ASSERT(ctx->buffers != NULL);
  759. size_t total_size = 0;
  760. for (size_t i = 0; i < n_buffers; i++) {
  761. ctx->buffers[i] = buffers[i];
  762. total_size += ggml_backend_buffer_get_size(buffers[i]);
  763. }
  764. return ggml_backend_buffer_init(buffers[0]->buft, ggml_backend_multi_buffer_context_interface(), ctx, total_size);
  765. }
  766. GGML_CALL bool ggml_backend_buffer_is_multi_buffer(ggml_backend_buffer_t buffer) {
  767. return buffer->iface.get_name == ggml_backend_multi_buffer_get_name;
  768. }
  769. GGML_CALL void ggml_backend_multi_buffer_set_usage(ggml_backend_buffer_t buffer, enum ggml_backend_buffer_usage usage) {
  770. GGML_ASSERT(ggml_backend_buffer_is_multi_buffer(buffer));
  771. ggml_backend_multi_buffer_context_t ctx = (ggml_backend_multi_buffer_context_t) buffer->context;
  772. for (size_t i = 0; i < ctx->n_buffers; i++) {
  773. ggml_backend_buffer_set_usage(ctx->buffers[i], usage);
  774. }
  775. }
  776. // creates a copy of the tensor with the same memory layout
  777. static struct ggml_tensor * ggml_dup_tensor_layout(struct ggml_context * ctx, const struct ggml_tensor * tensor) {
  778. struct ggml_tensor * dup = ggml_dup_tensor(ctx, tensor);
  779. for (int i = 0; i < GGML_MAX_DIMS; i++) {
  780. dup->nb[i] = tensor->nb[i];
  781. }
  782. return dup;
  783. }
  784. static bool ggml_is_view_op(enum ggml_op op) {
  785. return op == GGML_OP_VIEW || op == GGML_OP_RESHAPE || op == GGML_OP_PERMUTE || op == GGML_OP_TRANSPOSE;
  786. }
  787. // scheduler
  788. #ifndef GGML_SCHED_MAX_BACKENDS
  789. #define GGML_SCHED_MAX_BACKENDS 16
  790. #endif
  791. #ifndef GGML_SCHED_MAX_SPLITS
  792. #define GGML_SCHED_MAX_SPLITS 2048
  793. #endif
  794. #ifndef GGML_SCHED_MAX_SPLIT_INPUTS
  795. #define GGML_SCHED_MAX_SPLIT_INPUTS GGML_MAX_SRC
  796. #endif
  797. #ifndef GGML_SCHED_MAX_COPIES
  798. #define GGML_SCHED_MAX_COPIES 4
  799. #endif
  800. struct ggml_backend_sched_split {
  801. int backend_id;
  802. int i_start;
  803. int i_end;
  804. struct ggml_tensor * inputs[GGML_SCHED_MAX_SPLIT_INPUTS];
  805. int n_inputs;
  806. // graph view of this split
  807. struct ggml_cgraph graph;
  808. };
  809. struct ggml_backend_sched {
  810. bool is_reset; // true if the scheduler has been reset since the last graph split
  811. bool is_alloc;
  812. int n_backends;
  813. ggml_backend_t backends[GGML_SCHED_MAX_BACKENDS];
  814. ggml_backend_buffer_type_t bufts[GGML_SCHED_MAX_BACKENDS];
  815. ggml_gallocr_t galloc;
  816. // hash keys of the nodes in the graph
  817. struct ggml_hash_set hash_set;
  818. // hash values
  819. int * tensor_backend_id;
  820. struct ggml_tensor * (* tensor_copies)[GGML_SCHED_MAX_BACKENDS][GGML_SCHED_MAX_COPIES];
  821. int * node_backend_ids; // [graph_size]
  822. int * leaf_backend_ids; // [graph_size]
  823. int * prev_node_backend_ids; // [graph_size]
  824. int * prev_leaf_backend_ids; // [graph_size]
  825. // copy of the graph with modified inputs
  826. struct ggml_cgraph * graph;
  827. // graph splits
  828. struct ggml_backend_sched_split * splits;
  829. int n_splits;
  830. int splits_capacity;
  831. // pipeline parallelism support
  832. int n_copies;
  833. int cur_copy;
  834. ggml_backend_event_t events[GGML_SCHED_MAX_BACKENDS][GGML_SCHED_MAX_COPIES];
  835. struct ggml_tensor * graph_inputs[GGML_SCHED_MAX_SPLIT_INPUTS];
  836. int n_graph_inputs;
  837. struct ggml_context * ctx;
  838. ggml_backend_sched_eval_callback callback_eval;
  839. void * callback_eval_user_data;
  840. bool debug;
  841. // align context_buffer to GGML_MEM_ALIGN
  842. #ifdef _MSC_VER
  843. __declspec(align(GGML_MEM_ALIGN))
  844. #else
  845. __attribute__((aligned(GGML_MEM_ALIGN)))
  846. #endif
  847. char context_buffer[GGML_SCHED_MAX_SPLITS*GGML_SCHED_MAX_SPLIT_INPUTS*2*sizeof(struct ggml_tensor) + sizeof(struct ggml_cgraph)];
  848. };
  849. #define hash_id(tensor) ggml_hash_find_or_insert(sched->hash_set, tensor)
  850. #define tensor_backend_id(tensor) sched->tensor_backend_id[hash_id(tensor)]
  851. // returns the priority of the backend, lower id is higher priority
  852. static int ggml_backend_sched_backend_id(ggml_backend_sched_t sched, ggml_backend_t backend) {
  853. for (int i = 0; i < sched->n_backends; i++) {
  854. if (sched->backends[i] == backend) {
  855. return i;
  856. }
  857. }
  858. return -1;
  859. }
  860. static int ggml_backend_sched_backend_from_buffer(ggml_backend_sched_t sched, const struct ggml_tensor * tensor, const struct ggml_tensor * op) {
  861. ggml_backend_buffer_t buffer = tensor->buffer;
  862. if (buffer == NULL) {
  863. return -1;
  864. }
  865. // find highest prio backend that supports the buffer type and the op
  866. for (int i = 0; i < sched->n_backends; i++) {
  867. if (ggml_backend_supports_buft(sched->backends[i], buffer->buft) &&
  868. ggml_backend_supports_op(sched->backends[i], op)) {
  869. return i;
  870. }
  871. }
  872. #ifndef NDEBUG
  873. fprintf(stderr, "%s: warning: no backend supports op %s with a weight with buffer type %s used in tensor %s, the weight will need to be copied\n",
  874. __func__, ggml_op_desc(tensor), ggml_backend_buffer_name(buffer), tensor->name);
  875. #endif
  876. return -1;
  877. }
  878. #if 0
  879. static char causes[GGML_DEFAULT_GRAPH_SIZE*16 + GGML_SCHED_MAX_SPLITS*GGML_SCHED_MAX_SPLIT_INPUTS][128]; // debug only
  880. #define SET_CAUSE(node, ...) sprintf(causes[hash_id(node)], __VA_ARGS__)
  881. #define GET_CAUSE(node) causes[hash_id(node)]
  882. #else
  883. #define SET_CAUSE(node, ...)
  884. #define GET_CAUSE(node) ""
  885. #endif
  886. // returns the backend that should be used for the node based on the current locations
  887. static int ggml_backend_sched_backend_id_from_cur(ggml_backend_sched_t sched, struct ggml_tensor * tensor) {
  888. // TODO: use supports_op to check if the backend supports the op
  889. // assign pre-allocated nodes to their backend
  890. int cur_backend_id = ggml_backend_sched_backend_from_buffer(sched, tensor, tensor);
  891. if (cur_backend_id != -1) {
  892. SET_CAUSE(tensor, "1.dst");
  893. return cur_backend_id;
  894. }
  895. // view_src
  896. if (tensor->view_src != NULL) {
  897. cur_backend_id = ggml_backend_sched_backend_from_buffer(sched, tensor->view_src, tensor);
  898. if (cur_backend_id != -1) {
  899. SET_CAUSE(tensor, "1.vsrc");
  900. return cur_backend_id;
  901. }
  902. }
  903. // graph input
  904. if (tensor->flags & GGML_TENSOR_FLAG_INPUT) {
  905. cur_backend_id = sched->n_backends - 1; // last backend (assumed CPU)
  906. SET_CAUSE(tensor, "1.inp");
  907. return cur_backend_id;
  908. }
  909. // assign nodes that use weights to the backend of the weights
  910. // operations with weights are preferably run on the same backend as the weights
  911. for (int i = 0; i < GGML_MAX_SRC; i++) {
  912. const struct ggml_tensor * src = tensor->src[i];
  913. if (src == NULL) {
  914. continue;
  915. }
  916. if (src->buffer != NULL && src->buffer->usage == GGML_BACKEND_BUFFER_USAGE_WEIGHTS) {
  917. int src_backend_id = ggml_backend_sched_backend_from_buffer(sched, src, tensor);
  918. // check if a backend with higher prio wants to offload the op
  919. if (src_backend_id == sched->n_backends - 1) {
  920. for (int b = 0; b < src_backend_id; b++) {
  921. if (ggml_backend_offload_op(sched->backends[b], tensor)) {
  922. SET_CAUSE(tensor, "1.off");
  923. return b;
  924. }
  925. }
  926. }
  927. SET_CAUSE(tensor, "1.wgt%d", i);
  928. return src_backend_id;
  929. }
  930. }
  931. return -1;
  932. }
  933. static char * fmt_size(size_t size) {
  934. static char buffer[128];
  935. if (size >= 1024*1024) {
  936. snprintf(buffer, sizeof(buffer), "%zuM", size/1024/1024);
  937. } else {
  938. snprintf(buffer, sizeof(buffer), "%zuK", size/1024);
  939. }
  940. return buffer;
  941. }
  942. static void ggml_backend_sched_print_assignments(ggml_backend_sched_t sched, struct ggml_cgraph * graph) {
  943. int cur_split = 0;
  944. for (int i = 0; i < graph->n_nodes; i++) {
  945. if (cur_split < sched->n_splits && i == sched->splits[cur_split].i_start) {
  946. ggml_backend_t split_backend = sched->backends[sched->splits[cur_split].backend_id];
  947. fprintf(stderr, "\n## SPLIT #%d: %s # %d inputs: ", cur_split, ggml_backend_name(split_backend),
  948. sched->splits[cur_split].n_inputs);
  949. for (int j = 0; j < sched->splits[cur_split].n_inputs; j++) {
  950. fprintf(stderr, "[%s (%5.5s)] ", sched->splits[cur_split].inputs[j]->name,
  951. fmt_size(ggml_nbytes(sched->splits[cur_split].inputs[j])));
  952. }
  953. fprintf(stderr, "\n");
  954. cur_split++;
  955. }
  956. struct ggml_tensor * node = graph->nodes[i];
  957. if (ggml_is_view_op(node->op)) {
  958. continue;
  959. }
  960. ggml_backend_t tensor_backend = ggml_backend_sched_get_tensor_backend(sched, node);
  961. fprintf(stderr, "node #%3d (%10.10s): %20.20s (%5.5s) [%5.5s %8.8s]:", i, ggml_op_name(node->op), node->name,
  962. fmt_size(ggml_nbytes(node)), tensor_backend ? ggml_backend_name(tensor_backend) : "NULL", GET_CAUSE(node));
  963. for (int j = 0; j < GGML_MAX_SRC; j++) {
  964. struct ggml_tensor * src = node->src[j];
  965. if (src == NULL) {
  966. continue;
  967. }
  968. ggml_backend_t src_backend = ggml_backend_sched_get_tensor_backend(sched, src);
  969. fprintf(stderr, " %20.20s (%5.5s) [%5.5s %8.8s]", src->name,
  970. fmt_size(ggml_nbytes(src)), src_backend ? ggml_backend_name(src_backend) : "NULL", GET_CAUSE(src));
  971. }
  972. fprintf(stderr, "\n");
  973. }
  974. }
  975. static bool ggml_backend_sched_buffer_supported(ggml_backend_sched_t sched, struct ggml_tensor * t, int backend_id) {
  976. ggml_backend_buffer_t buf = t->view_src ? t->view_src->buffer : t->buffer;
  977. ggml_backend_buffer_type_t buft = NULL;
  978. if (buf) {
  979. // the tensor is already allocated
  980. buft = buf->buft;
  981. } else {
  982. // see if the tensor already has a backend assigned, and use the buffer type of that backend
  983. int tensor_backend_id = tensor_backend_id(t);
  984. if (tensor_backend_id == -1 && t->view_src) {
  985. tensor_backend_id = tensor_backend_id(t->view_src);
  986. }
  987. if (tensor_backend_id != -1) {
  988. buft = sched->bufts[tensor_backend_id];
  989. }
  990. }
  991. return buft != NULL && ggml_backend_supports_buft(sched->backends[backend_id], buft);
  992. }
  993. static void ggml_backend_sched_set_if_supported(ggml_backend_sched_t sched, struct ggml_tensor * node, int cur_backend_id, int * node_backend_id) {
  994. if (ggml_backend_supports_op(sched->backends[cur_backend_id], node)) {
  995. *node_backend_id = cur_backend_id;
  996. SET_CAUSE(node, "2.sup");
  997. }
  998. }
  999. // assigns backends to ops and splits the graph into subgraphs that can be computed on the same backend
  1000. static void ggml_backend_sched_split_graph(ggml_backend_sched_t sched, struct ggml_cgraph * graph) {
  1001. // reset splits
  1002. sched->n_splits = 0;
  1003. sched->n_graph_inputs = 0;
  1004. sched->is_reset = false;
  1005. struct ggml_init_params params = {
  1006. /* .mem_size = */ sizeof(sched->context_buffer),
  1007. /* .mem_buffer = */ sched->context_buffer,
  1008. /* .no_alloc = */ true
  1009. };
  1010. ggml_free(sched->ctx);
  1011. sched->ctx = ggml_init(params);
  1012. if (sched->ctx == NULL) {
  1013. fprintf(stderr, "%s: failed to initialize context\n", __func__);
  1014. GGML_ASSERT(false);
  1015. }
  1016. // pass 1: assign backends to ops with pre-allocated inputs
  1017. for (int i = 0; i < graph->n_leafs; i++) {
  1018. struct ggml_tensor * leaf = graph->leafs[i];
  1019. int * leaf_backend_id = &tensor_backend_id(leaf);
  1020. if (*leaf_backend_id != -1) {
  1021. // do not overwrite user assignments
  1022. continue;
  1023. }
  1024. *leaf_backend_id = ggml_backend_sched_backend_id_from_cur(sched, leaf);
  1025. }
  1026. for (int i = 0; i < graph->n_nodes; i++) {
  1027. struct ggml_tensor * node = graph->nodes[i];
  1028. int * node_backend_id = &tensor_backend_id(node);
  1029. if (*node_backend_id != -1) {
  1030. // do not overwrite user assignments
  1031. continue;
  1032. }
  1033. *node_backend_id = ggml_backend_sched_backend_id_from_cur(sched, node);
  1034. // src
  1035. for (int j = 0; j < GGML_MAX_SRC; j++) {
  1036. struct ggml_tensor * src = node->src[j];
  1037. if (src == NULL) {
  1038. continue;
  1039. }
  1040. int * src_backend_id = &tensor_backend_id(src);
  1041. if (*src_backend_id == -1) {
  1042. *src_backend_id = ggml_backend_sched_backend_id_from_cur(sched, src);
  1043. }
  1044. }
  1045. }
  1046. // pass 2: expand current backend assignments
  1047. // assign the same backend to adjacent nodes
  1048. // expand gpu backends (i.e. non last prio) up and down, ignoring cpu (the lowest priority backend)
  1049. // thus, cpu will never be used unless weights are on cpu, or there are no gpu ops between cpu ops
  1050. // ops unsupported by the backend being expanded will be left unassigned so that they can be assigned later when the locations of its inputs are known
  1051. // expand gpu down
  1052. {
  1053. int cur_backend_id = -1;
  1054. for (int i = 0; i < graph->n_nodes; i++) {
  1055. struct ggml_tensor * node = graph->nodes[i];
  1056. if (ggml_is_view_op(node->op)) {
  1057. continue;
  1058. }
  1059. int * node_backend_id = &tensor_backend_id(node);
  1060. if (*node_backend_id != -1) {
  1061. if (*node_backend_id == sched->n_backends - 1) {
  1062. // skip cpu (lowest prio backend)
  1063. cur_backend_id = -1;
  1064. } else {
  1065. cur_backend_id = *node_backend_id;
  1066. }
  1067. } else if (cur_backend_id != -1) {
  1068. ggml_backend_sched_set_if_supported(sched, node, cur_backend_id, node_backend_id);
  1069. }
  1070. }
  1071. }
  1072. // expand gpu up
  1073. {
  1074. int cur_backend_id = -1;
  1075. for (int i = graph->n_nodes - 1; i >= 0; i--) {
  1076. struct ggml_tensor * node = graph->nodes[i];
  1077. if (ggml_is_view_op(node->op)) {
  1078. continue;
  1079. }
  1080. int * node_backend_id = &tensor_backend_id(node);
  1081. if (*node_backend_id != -1) {
  1082. if (*node_backend_id == sched->n_backends - 1) {
  1083. // skip cpu (lowest prio backend)
  1084. cur_backend_id = -1;
  1085. } else {
  1086. cur_backend_id = *node_backend_id;
  1087. }
  1088. } else if (cur_backend_id != -1) {
  1089. ggml_backend_sched_set_if_supported(sched, node, cur_backend_id, node_backend_id);
  1090. }
  1091. }
  1092. }
  1093. // expand rest down
  1094. {
  1095. int cur_backend_id = -1;
  1096. for (int i = 0; i < graph->n_nodes; i++) {
  1097. struct ggml_tensor * node = graph->nodes[i];
  1098. if (ggml_is_view_op(node->op)) {
  1099. continue;
  1100. }
  1101. int * node_backend_id = &tensor_backend_id(node);
  1102. if (*node_backend_id != -1) {
  1103. cur_backend_id = *node_backend_id;
  1104. } else if (cur_backend_id != -1) {
  1105. ggml_backend_sched_set_if_supported(sched, node, cur_backend_id, node_backend_id);
  1106. }
  1107. }
  1108. }
  1109. // expand rest up
  1110. {
  1111. int cur_backend_id = -1;
  1112. for (int i = graph->n_nodes - 1; i >= 0; i--) {
  1113. struct ggml_tensor * node = graph->nodes[i];
  1114. if (ggml_is_view_op(node->op)) {
  1115. continue;
  1116. }
  1117. int * node_backend_id = &tensor_backend_id(node);
  1118. if (*node_backend_id != -1) {
  1119. cur_backend_id = *node_backend_id;
  1120. } else if (cur_backend_id != -1) {
  1121. ggml_backend_sched_set_if_supported(sched, node, cur_backend_id, node_backend_id);
  1122. }
  1123. }
  1124. }
  1125. // pass 3: upgrade nodes to higher prio backends with compatible buffer types
  1126. // if the tensor is already in the same buffer type (*) as another higher priority backend, we should move it there
  1127. // however, we also need to verify that the sources are in compatible buffer types
  1128. // (*) the actual requirement is more relaxed, the buffer type of the backend should be supported by all the users of this tensor further down the graph
  1129. // however, this is slow to verify, so we have a more strict requirement that the buffer type is the same
  1130. // this is not uncommon since multiple backends can use host memory, with the same buffer type (eg. BLAS and CPU)
  1131. // additionally, set remaining unassigned nodes to the backend with the most supported inputs
  1132. // only nodes that could not be assigned during expansion due to the backend not supporting the op should be unassigned at this point
  1133. for (int i = 0; i < graph->n_nodes; i++) {
  1134. struct ggml_tensor * node = graph->nodes[i];
  1135. if (ggml_is_view_op(node->op)) {
  1136. continue;
  1137. }
  1138. int * node_backend_id = &tensor_backend_id(node);
  1139. if (*node_backend_id == -1) {
  1140. // unassigned node: find the backend with the most supported inputs
  1141. int n_supported_best = -1;
  1142. for (int b = 0; b < sched->n_backends; b++) {
  1143. if (ggml_backend_supports_op(sched->backends[b], node)) {
  1144. int n_supported = 0;
  1145. for (int j = 0; j < GGML_MAX_SRC; j++) {
  1146. struct ggml_tensor * src = node->src[j];
  1147. if (src == NULL) {
  1148. continue;
  1149. }
  1150. if ((tensor_backend_id(src) != -1 || tensor_backend_id(src->view_src) != -1) && ggml_backend_sched_buffer_supported(sched, src, b)) {
  1151. n_supported++;
  1152. }
  1153. }
  1154. if (n_supported > n_supported_best) {
  1155. n_supported_best = n_supported;
  1156. *node_backend_id = b;
  1157. SET_CAUSE(node, "3.best");
  1158. }
  1159. }
  1160. }
  1161. } else {
  1162. // assigned node: upgrade to higher prio backend if possible
  1163. for (int b = 0; b < *node_backend_id; b++) {
  1164. if (sched->bufts[b] == sched->bufts[*node_backend_id] && ggml_backend_supports_op(sched->backends[b], node)) {
  1165. bool supported = true;
  1166. for (int j = 0; j < GGML_MAX_SRC; j++) {
  1167. struct ggml_tensor * src = node->src[j];
  1168. if (src == NULL) {
  1169. continue;
  1170. }
  1171. if (!ggml_backend_sched_buffer_supported(sched, src, b)) {
  1172. supported = false;
  1173. break;
  1174. }
  1175. }
  1176. if (supported) {
  1177. *node_backend_id = b;
  1178. SET_CAUSE(node, "3.upg");
  1179. break;
  1180. }
  1181. }
  1182. }
  1183. }
  1184. }
  1185. // pass 4: assign backends to remaining src from dst and view_src
  1186. for (int i = 0; i < graph->n_nodes; i++) {
  1187. struct ggml_tensor * node = graph->nodes[i];
  1188. int * cur_backend_id = &tensor_backend_id(node);
  1189. if (node->view_src != NULL && *cur_backend_id == -1) {
  1190. *cur_backend_id = tensor_backend_id(node->view_src);
  1191. SET_CAUSE(node, "4.vsrc");
  1192. }
  1193. for (int j = 0; j < GGML_MAX_SRC; j++) {
  1194. struct ggml_tensor * src = node->src[j];
  1195. if (src == NULL) {
  1196. continue;
  1197. }
  1198. int * src_backend_id = &tensor_backend_id(src);
  1199. if (*src_backend_id == -1) {
  1200. if (src->view_src != NULL) {
  1201. // views are always on the same backend as the source
  1202. *src_backend_id = tensor_backend_id(src->view_src);
  1203. SET_CAUSE(src, "4.vsrc");
  1204. } else {
  1205. *src_backend_id = *cur_backend_id;
  1206. SET_CAUSE(src, "4.cur");
  1207. }
  1208. }
  1209. }
  1210. }
  1211. // pass 4: split graph, find tensors that need to be copied
  1212. {
  1213. int i_split = 0;
  1214. struct ggml_backend_sched_split * split = &sched->splits[0];
  1215. // find the backend of the first split, skipping view ops
  1216. for (int i = 0; i < graph->n_nodes; i++) {
  1217. struct ggml_tensor * node = graph->nodes[i];
  1218. if (!ggml_is_view_op(node->op)) {
  1219. split->backend_id = tensor_backend_id(node);
  1220. break;
  1221. }
  1222. }
  1223. split->i_start = 0;
  1224. split->n_inputs = 0;
  1225. memset(split->inputs, 0, sizeof(split->inputs)); //HACK
  1226. int cur_backend_id = split->backend_id;
  1227. for (int i = 0; i < graph->n_nodes; i++) {
  1228. struct ggml_tensor * node = graph->nodes[i];
  1229. if (ggml_is_view_op(node->op)) {
  1230. continue;
  1231. }
  1232. const int node_backend_id = tensor_backend_id(node);
  1233. GGML_ASSERT(node_backend_id != -1); // all nodes should be assigned by now
  1234. // check if we should start a new split based on the sources of the current node
  1235. bool need_new_split = false;
  1236. if (node_backend_id == cur_backend_id && split->n_inputs > 0) {
  1237. for (int j = 0; j < GGML_MAX_SRC; j++) {
  1238. struct ggml_tensor * src = node->src[j];
  1239. if (src == NULL) {
  1240. continue;
  1241. }
  1242. // check if a weight is on a different backend
  1243. // by starting a new split, the memory of the previously offloaded weights can be reused
  1244. if (src->buffer != NULL && src->buffer->usage == GGML_BACKEND_BUFFER_USAGE_WEIGHTS) {
  1245. int src_backend_id = tensor_backend_id(src);
  1246. if (src_backend_id != -1 && src_backend_id != cur_backend_id) {
  1247. need_new_split = true;
  1248. break;
  1249. }
  1250. }
  1251. // check if the split has too many inputs
  1252. // FIXME: count the number of inputs instead of only checking when full
  1253. if (split->n_inputs == GGML_SCHED_MAX_SPLIT_INPUTS) {
  1254. const size_t id = hash_id(src);
  1255. int src_backend_id = sched->tensor_backend_id[id];
  1256. bool supported = ggml_backend_sched_buffer_supported(sched, src, cur_backend_id);
  1257. if (src_backend_id != cur_backend_id && sched->tensor_copies[hash_id(src)][cur_backend_id][0] == NULL && !supported) {
  1258. //printf("starting new split because of too many inputs: node %s, input %s\n", node->name, src->name);
  1259. need_new_split = true;
  1260. break;
  1261. }
  1262. }
  1263. }
  1264. }
  1265. if (node_backend_id != cur_backend_id || need_new_split) {
  1266. split->i_end = i;
  1267. i_split++;
  1268. if (i_split >= sched->splits_capacity) {
  1269. sched->splits_capacity *= 2;
  1270. sched->splits = realloc(sched->splits, sched->splits_capacity * sizeof(struct ggml_backend_sched_split));
  1271. GGML_ASSERT(sched->splits != NULL);
  1272. }
  1273. GGML_ASSERT(i_split < GGML_SCHED_MAX_SPLITS);
  1274. split = &sched->splits[i_split];
  1275. split->backend_id = node_backend_id;
  1276. split->i_start = i;
  1277. split->n_inputs = 0;
  1278. cur_backend_id = node_backend_id;
  1279. }
  1280. // find inputs that are not on the same backend
  1281. for (int j = 0; j < GGML_MAX_SRC; j++) {
  1282. struct ggml_tensor * src = node->src[j];
  1283. if (src == NULL) {
  1284. continue;
  1285. }
  1286. const int src_backend_id = tensor_backend_id(src);
  1287. assert(src_backend_id != -1); // all inputs should be assigned by now
  1288. if (src->flags & GGML_TENSOR_FLAG_INPUT && sched->n_copies > 1) {
  1289. size_t id = hash_id(src);
  1290. if (sched->tensor_copies[id][src_backend_id][0] == NULL) {
  1291. ggml_backend_t backend = sched->backends[src_backend_id];
  1292. for (int c = 0; c < sched->n_copies; c++) {
  1293. struct ggml_tensor * tensor_copy;
  1294. if (c == sched->cur_copy) {
  1295. tensor_copy = src; // use the original tensor as the current copy
  1296. } else {
  1297. tensor_copy = ggml_dup_tensor_layout(sched->ctx, src);
  1298. ggml_format_name(tensor_copy, "%s#%s#%d", ggml_backend_name(backend), src->name, c);
  1299. }
  1300. if (sched->n_copies > 1) {
  1301. ggml_set_input(tensor_copy);
  1302. ggml_set_output(tensor_copy); // prevent ggml-alloc from overwriting the tensor
  1303. }
  1304. sched->tensor_copies[id][src_backend_id][c] = tensor_copy;
  1305. SET_CAUSE(tensor_copy, "4.cpy");
  1306. }
  1307. int n_graph_inputs = sched->n_graph_inputs++;
  1308. GGML_ASSERT(n_graph_inputs < GGML_SCHED_MAX_SPLIT_INPUTS);
  1309. sched->graph_inputs[n_graph_inputs] = src;
  1310. }
  1311. }
  1312. bool supported = ggml_backend_sched_buffer_supported(sched, src, cur_backend_id);
  1313. if (src_backend_id != cur_backend_id && !supported) {
  1314. // create a copy of the input in the split's backend
  1315. const size_t id = hash_id(src);
  1316. if (sched->tensor_copies[id][cur_backend_id][0] == NULL) {
  1317. ggml_backend_t backend = sched->backends[cur_backend_id];
  1318. for (int c = 0; c < sched->n_copies; c++) {
  1319. struct ggml_tensor * tensor_copy = ggml_dup_tensor_layout(sched->ctx, src);
  1320. ggml_format_name(tensor_copy, "%s#%s#%d", ggml_backend_name(backend), src->name, c);
  1321. if (sched->n_copies > 1) {
  1322. ggml_set_input(tensor_copy);
  1323. ggml_set_output(tensor_copy); // prevent ggml-alloc from overwriting the tensor
  1324. }
  1325. sched->tensor_copies[id][cur_backend_id][c] = tensor_copy;
  1326. SET_CAUSE(tensor_copy, "4.cpy");
  1327. }
  1328. int n_inputs = split->n_inputs++;
  1329. GGML_ASSERT(n_inputs < GGML_SCHED_MAX_SPLIT_INPUTS);
  1330. split->inputs[n_inputs] = src;
  1331. }
  1332. node->src[j] = sched->tensor_copies[id][cur_backend_id][sched->cur_copy];
  1333. }
  1334. }
  1335. }
  1336. split->i_end = graph->n_nodes;
  1337. sched->n_splits = i_split + 1;
  1338. }
  1339. if (sched->debug) {
  1340. ggml_backend_sched_print_assignments(sched, graph);
  1341. }
  1342. // swap node_backend_ids and leaf_backend_ids and prevs
  1343. {
  1344. int * tmp = sched->node_backend_ids;
  1345. sched->node_backend_ids = sched->prev_node_backend_ids;
  1346. sched->prev_node_backend_ids = tmp;
  1347. tmp = sched->leaf_backend_ids;
  1348. sched->leaf_backend_ids = sched->prev_leaf_backend_ids;
  1349. sched->prev_leaf_backend_ids = tmp;
  1350. }
  1351. // create copies of the graph for each split
  1352. // TODO: avoid this copy
  1353. struct ggml_cgraph * graph_copy = ggml_new_graph_custom(sched->ctx, graph->n_nodes + sched->n_splits*GGML_SCHED_MAX_SPLIT_INPUTS*2, false);
  1354. for (int i = 0; i < sched->n_splits; i++) {
  1355. struct ggml_backend_sched_split * split = &sched->splits[i];
  1356. split->graph = ggml_graph_view(graph, split->i_start, split->i_end);
  1357. // add inputs to the graph copy so that they are allocated by ggml-alloc at the start of the split
  1358. for (int j = 0; j < split->n_inputs; j++) {
  1359. assert(graph_copy->size > (graph_copy->n_nodes + 1));
  1360. struct ggml_tensor * input = split->inputs[j];
  1361. const size_t input_id = hash_id(input);
  1362. struct ggml_tensor * input_cpy = sched->tensor_copies[input_id][split->backend_id][sched->cur_copy];
  1363. // add a dependency to the input source so that it is not freed before the copy is done
  1364. struct ggml_tensor * input_dep = ggml_view_tensor(sched->ctx, input);
  1365. input_dep->src[0] = input;
  1366. sched->node_backend_ids[graph_copy->n_nodes] = sched->tensor_backend_id[input_id];
  1367. graph_copy->nodes[graph_copy->n_nodes++] = input_dep;
  1368. // add a dependency to the input copy so that it is allocated at the start of the split
  1369. sched->node_backend_ids[graph_copy->n_nodes] = split->backend_id;
  1370. graph_copy->nodes[graph_copy->n_nodes++] = input_cpy;
  1371. }
  1372. for (int j = split->i_start; j < split->i_end; j++) {
  1373. assert(graph_copy->size > graph_copy->n_nodes);
  1374. sched->node_backend_ids[graph_copy->n_nodes] = tensor_backend_id(graph->nodes[j]);
  1375. graph_copy->nodes[graph_copy->n_nodes++] = graph->nodes[j];
  1376. }
  1377. }
  1378. if (sched->n_copies > 1) {
  1379. // add input copies as leafs so that they are allocated first
  1380. for (int i = 0; i < sched->n_graph_inputs; i++) {
  1381. struct ggml_tensor * input = sched->graph_inputs[i];
  1382. size_t id = hash_id(input);
  1383. int backend_id = tensor_backend_id(input);
  1384. for (int c = 0; c < sched->n_copies; c++) {
  1385. struct ggml_tensor * input_cpy = sched->tensor_copies[id][backend_id][c];
  1386. sched->leaf_backend_ids[graph_copy->n_leafs] = backend_id;
  1387. graph_copy->leafs[graph_copy->n_leafs++] = input_cpy;
  1388. }
  1389. }
  1390. for (int i = 0; i < sched->n_splits; i++) {
  1391. struct ggml_backend_sched_split * split = &sched->splits[i];
  1392. int backend_id = split->backend_id;
  1393. for (int j = 0; j < split->n_inputs; j++) {
  1394. struct ggml_tensor * input = split->inputs[j];
  1395. size_t id = hash_id(input);
  1396. for (int c = 0; c < sched->n_copies; c++) {
  1397. struct ggml_tensor * input_cpy = sched->tensor_copies[id][backend_id][c];
  1398. sched->leaf_backend_ids[graph_copy->n_leafs] = backend_id;
  1399. graph_copy->leafs[graph_copy->n_leafs++] = input_cpy;
  1400. }
  1401. }
  1402. }
  1403. }
  1404. // add leafs from the original graph
  1405. for (int i = 0; i < graph->n_leafs; i++) {
  1406. struct ggml_tensor * leaf = graph->leafs[i];
  1407. sched->leaf_backend_ids[graph_copy->n_leafs] = tensor_backend_id(leaf);
  1408. graph_copy->leafs[graph_copy->n_leafs++] = leaf;
  1409. }
  1410. sched->graph = graph_copy;
  1411. }
  1412. static bool ggml_backend_sched_alloc_splits(ggml_backend_sched_t sched) {
  1413. bool backend_ids_changed = false;
  1414. for (int i = 0; i < sched->graph->n_nodes; i++) {
  1415. if (sched->node_backend_ids[i] != sched->prev_node_backend_ids[i]) {
  1416. backend_ids_changed = true;
  1417. break;
  1418. }
  1419. }
  1420. if (!backend_ids_changed) {
  1421. for (int i = 0; i < sched->graph->n_leafs; i++) {
  1422. if (sched->leaf_backend_ids[i] != sched->prev_leaf_backend_ids[i]) {
  1423. backend_ids_changed = true;
  1424. break;
  1425. }
  1426. }
  1427. }
  1428. // allocate graph
  1429. if (backend_ids_changed || !ggml_gallocr_alloc_graph(sched->galloc, sched->graph)) {
  1430. // the re-allocation may cause the split inputs to be moved to a different address
  1431. ggml_backend_sched_synchronize(sched);
  1432. #ifndef NDEBUG
  1433. fprintf(stderr, "%s: failed to allocate graph, reserving\n", __func__);
  1434. #endif
  1435. ggml_gallocr_reserve_n(sched->galloc, sched->graph, sched->node_backend_ids, sched->leaf_backend_ids);
  1436. if (!ggml_gallocr_alloc_graph(sched->galloc, sched->graph)) {
  1437. fprintf(stderr, "%s: failed to allocate graph\n", __func__);
  1438. return false;
  1439. }
  1440. }
  1441. return true;
  1442. }
  1443. static enum ggml_status ggml_backend_sched_compute_splits(ggml_backend_sched_t sched) {
  1444. struct ggml_backend_sched_split * splits = sched->splits;
  1445. for (int i = 0; i < sched->n_splits; i++) {
  1446. struct ggml_backend_sched_split * split = &splits[i];
  1447. int split_backend_id = split->backend_id;
  1448. ggml_backend_t split_backend = sched->backends[split_backend_id];
  1449. // copy the input tensors to the split backend
  1450. for (int j = 0; j < split->n_inputs; j++) {
  1451. ggml_backend_t input_backend = ggml_backend_sched_get_tensor_backend(sched, split->inputs[j]);
  1452. struct ggml_tensor * input = split->inputs[j];
  1453. struct ggml_tensor * input_cpy = sched->tensor_copies[hash_id(input)][split_backend_id][sched->cur_copy];
  1454. if (input->flags & GGML_TENSOR_FLAG_INPUT) {
  1455. // inputs from the user must be copied immediately to prevent the user overwriting the data before the copy is done
  1456. if (sched->events[split_backend_id][sched->cur_copy] != NULL) {
  1457. ggml_backend_event_synchronize(sched->events[split_backend_id][sched->cur_copy]);
  1458. } else {
  1459. ggml_backend_synchronize(split_backend);
  1460. }
  1461. ggml_backend_tensor_copy(input, input_cpy);
  1462. } else {
  1463. // wait for the split backend to finish using the input before overwriting it
  1464. if (sched->events[split_backend_id][sched->cur_copy] != NULL) {
  1465. ggml_backend_event_wait(split_backend, sched->events[split_backend_id][sched->cur_copy]);
  1466. } else {
  1467. ggml_backend_synchronize(split_backend);
  1468. }
  1469. ggml_backend_tensor_copy_async(input_backend, split_backend, input, input_cpy);
  1470. }
  1471. }
  1472. if (!sched->callback_eval) {
  1473. enum ggml_status ec = ggml_backend_graph_compute_async(split_backend, &split->graph);
  1474. if (ec != GGML_STATUS_SUCCESS) {
  1475. return ec;
  1476. }
  1477. } else {
  1478. // similar to ggml_backend_compare_graph_backend
  1479. for (int j0 = 0; j0 < split->graph.n_nodes; j0++) {
  1480. struct ggml_tensor * t = split->graph.nodes[j0];
  1481. // check if the user needs data from this node
  1482. bool need = sched->callback_eval(t, true, sched->callback_eval_user_data);
  1483. int j1 = j0;
  1484. // determine the range [j0, j1] of nodes that can be computed together
  1485. while (!need && j1 < split->graph.n_nodes - 1) {
  1486. t = split->graph.nodes[++j1];
  1487. need = sched->callback_eval(t, true, sched->callback_eval_user_data);
  1488. }
  1489. struct ggml_cgraph gv = ggml_graph_view(&split->graph, j0, j1 + 1);
  1490. enum ggml_status ec = ggml_backend_graph_compute_async(split_backend, &gv);
  1491. if (ec != GGML_STATUS_SUCCESS) {
  1492. return ec;
  1493. }
  1494. // TODO: pass backend to the callback, then the user can decide if they want to synchronize
  1495. ggml_backend_synchronize(split_backend);
  1496. if (need && !sched->callback_eval(t, false, sched->callback_eval_user_data)) {
  1497. break;
  1498. }
  1499. j0 = j1;
  1500. }
  1501. }
  1502. // record the event of this copy
  1503. if (split->n_inputs > 0) {
  1504. if (sched->events[split_backend_id][sched->cur_copy] != NULL) {
  1505. ggml_backend_event_record(sched->events[split_backend_id][sched->cur_copy]);
  1506. }
  1507. }
  1508. }
  1509. sched->cur_copy = (sched->cur_copy + 1) % sched->n_copies;
  1510. return GGML_STATUS_SUCCESS;
  1511. }
  1512. ggml_backend_sched_t ggml_backend_sched_new(
  1513. ggml_backend_t * backends,
  1514. ggml_backend_buffer_type_t * bufts,
  1515. int n_backends,
  1516. size_t graph_size,
  1517. bool parallel) {
  1518. GGML_ASSERT(n_backends > 0);
  1519. GGML_ASSERT(n_backends <= GGML_SCHED_MAX_BACKENDS);
  1520. GGML_ASSERT(ggml_backend_is_cpu(backends[n_backends - 1])); // last backend must be CPU
  1521. struct ggml_backend_sched * sched = calloc(1, sizeof(struct ggml_backend_sched));
  1522. sched->debug = getenv("GGML_SCHED_DEBUG") != NULL;
  1523. // initialize hash table
  1524. sched->hash_set = ggml_hash_set_new(graph_size);
  1525. sched->tensor_backend_id = calloc(sched->hash_set.size, sizeof(sched->tensor_backend_id[0]));
  1526. sched->tensor_copies = calloc(sched->hash_set.size, sizeof(sched->tensor_copies[0]));
  1527. const size_t nodes_size = graph_size + GGML_SCHED_MAX_SPLITS*GGML_SCHED_MAX_SPLIT_INPUTS*2;
  1528. sched->node_backend_ids = calloc(nodes_size, sizeof(sched->node_backend_ids[0]));
  1529. sched->leaf_backend_ids = calloc(nodes_size, sizeof(sched->leaf_backend_ids[0]));
  1530. sched->prev_node_backend_ids = calloc(nodes_size, sizeof(sched->prev_node_backend_ids[0]));
  1531. sched->prev_leaf_backend_ids = calloc(nodes_size, sizeof(sched->prev_leaf_backend_ids[0]));
  1532. sched->n_backends = n_backends;
  1533. sched->n_copies = parallel ? GGML_SCHED_MAX_COPIES : 1;
  1534. const int initial_splits_capacity = 16;
  1535. sched->splits = calloc(initial_splits_capacity, sizeof(sched->splits[0]));
  1536. sched->splits_capacity = initial_splits_capacity;
  1537. for (int b = 0; b < n_backends; b++) {
  1538. sched->backends[b] = backends[b];
  1539. sched->bufts[b] = bufts ? bufts[b] : ggml_backend_get_default_buffer_type(backends[b]);
  1540. GGML_ASSERT(ggml_backend_supports_buft(backends[b], sched->bufts[b]));
  1541. if (sched->n_copies > 1) {
  1542. for (int c = 0; c < sched->n_copies; c++) {
  1543. sched->events[b][c] = ggml_backend_event_new(backends[b]);
  1544. }
  1545. }
  1546. }
  1547. sched->galloc = ggml_gallocr_new_n(sched->bufts, n_backends);
  1548. ggml_backend_sched_reset(sched);
  1549. return sched;
  1550. }
  1551. void ggml_backend_sched_free(ggml_backend_sched_t sched) {
  1552. if (sched == NULL) {
  1553. return;
  1554. }
  1555. for (int b = 0; b < sched->n_backends; b++) {
  1556. for (int c = 0; c < sched->n_copies; c++) {
  1557. ggml_backend_event_free(sched->events[b][c]);
  1558. }
  1559. }
  1560. ggml_gallocr_free(sched->galloc);
  1561. ggml_free(sched->ctx);
  1562. free(sched->splits);
  1563. free(sched->hash_set.keys);
  1564. free(sched->tensor_backend_id);
  1565. free(sched->tensor_copies);
  1566. free(sched->node_backend_ids);
  1567. free(sched->leaf_backend_ids);
  1568. free(sched->prev_node_backend_ids);
  1569. free(sched->prev_leaf_backend_ids);
  1570. free(sched);
  1571. }
  1572. void ggml_backend_sched_reset(ggml_backend_sched_t sched) {
  1573. // reset state for the next run
  1574. if (!sched->is_reset) {
  1575. size_t hash_size = sched->hash_set.size;
  1576. memset(sched->hash_set.keys, 0, sizeof(sched->hash_set.keys[0]) * hash_size); // NOLINT
  1577. memset(sched->tensor_backend_id, -1, sizeof(sched->tensor_backend_id[0]) * hash_size);
  1578. memset(sched->tensor_copies, 0, sizeof(sched->tensor_copies[0]) * hash_size);
  1579. sched->is_reset = true;
  1580. }
  1581. sched->is_alloc = false;
  1582. }
  1583. bool ggml_backend_sched_reserve(ggml_backend_sched_t sched, struct ggml_cgraph * measure_graph) {
  1584. GGML_ASSERT((int)sched->hash_set.size >= measure_graph->n_nodes);
  1585. ggml_backend_sched_split_graph(sched, measure_graph);
  1586. // TODO: extract this to a separate function
  1587. if (!ggml_gallocr_reserve_n(sched->galloc, sched->graph, sched->node_backend_ids, sched->leaf_backend_ids)) {
  1588. return false;
  1589. }
  1590. ggml_backend_sched_reset(sched);
  1591. ggml_backend_sched_synchronize(sched);
  1592. return true;
  1593. }
  1594. bool ggml_backend_sched_alloc_graph(ggml_backend_sched_t sched, struct ggml_cgraph * graph) {
  1595. GGML_ASSERT((int)sched->hash_set.size >= graph->n_nodes);
  1596. ggml_backend_sched_split_graph(sched, graph);
  1597. if (!ggml_backend_sched_alloc_splits(sched)) {
  1598. return false;
  1599. }
  1600. sched->is_alloc = true;
  1601. return true;
  1602. }
  1603. enum ggml_status ggml_backend_sched_graph_compute(ggml_backend_sched_t sched, struct ggml_cgraph * graph) {
  1604. enum ggml_status err = ggml_backend_sched_graph_compute_async(sched, graph);
  1605. ggml_backend_sched_synchronize(sched);
  1606. return err;
  1607. }
  1608. enum ggml_status ggml_backend_sched_graph_compute_async(ggml_backend_sched_t sched, struct ggml_cgraph * graph) {
  1609. if (!sched->is_reset && !sched->is_alloc) {
  1610. ggml_backend_sched_reset(sched);
  1611. }
  1612. if (!sched->is_alloc) {
  1613. if (!ggml_backend_sched_alloc_graph(sched, graph)) {
  1614. return GGML_STATUS_ALLOC_FAILED;
  1615. }
  1616. }
  1617. return ggml_backend_sched_compute_splits(sched);
  1618. }
  1619. void ggml_backend_sched_synchronize(ggml_backend_sched_t sched) {
  1620. for (int i = 0; i < sched->n_backends; i++) {
  1621. ggml_backend_synchronize(sched->backends[i]);
  1622. }
  1623. }
  1624. void ggml_backend_sched_set_eval_callback(ggml_backend_sched_t sched, ggml_backend_sched_eval_callback callback, void * user_data) {
  1625. sched->callback_eval = callback;
  1626. sched->callback_eval_user_data = user_data;
  1627. }
  1628. int ggml_backend_sched_get_n_splits(ggml_backend_sched_t sched) {
  1629. return sched->n_splits;
  1630. }
  1631. int ggml_backend_sched_get_n_copies(ggml_backend_sched_t sched) {
  1632. return sched->n_copies;
  1633. }
  1634. size_t ggml_backend_sched_get_buffer_size(ggml_backend_sched_t sched, ggml_backend_t backend) {
  1635. int backend_index = ggml_backend_sched_backend_id(sched, backend);
  1636. GGML_ASSERT(backend_index >= 0 && backend_index < sched->n_backends);
  1637. return ggml_gallocr_get_buffer_size(sched->galloc, backend_index);
  1638. }
  1639. void ggml_backend_sched_set_tensor_backend(ggml_backend_sched_t sched, struct ggml_tensor * node, ggml_backend_t backend) {
  1640. int backend_index = ggml_backend_sched_backend_id(sched, backend);
  1641. GGML_ASSERT(backend_index >= 0 && backend_index < sched->n_backends);
  1642. tensor_backend_id(node) = backend_index;
  1643. SET_CAUSE(node, "usr");
  1644. }
  1645. ggml_backend_t ggml_backend_sched_get_tensor_backend(ggml_backend_sched_t sched, struct ggml_tensor * node) {
  1646. int backend_index = tensor_backend_id(node);
  1647. if (backend_index == -1) {
  1648. return NULL;
  1649. }
  1650. return sched->backends[backend_index];
  1651. }
  1652. // utils
  1653. void ggml_backend_view_init(struct ggml_tensor * tensor) {
  1654. GGML_ASSERT(tensor->buffer == NULL);
  1655. GGML_ASSERT(tensor->view_src != NULL);
  1656. GGML_ASSERT(tensor->view_src->buffer != NULL);
  1657. GGML_ASSERT(tensor->view_src->data != NULL);
  1658. tensor->buffer = tensor->view_src->buffer;
  1659. tensor->data = (char *)tensor->view_src->data + tensor->view_offs;
  1660. ggml_backend_buffer_init_tensor(tensor->buffer, tensor);
  1661. }
  1662. void ggml_backend_tensor_alloc(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor, void * addr) {
  1663. GGML_ASSERT(tensor->buffer == NULL);
  1664. GGML_ASSERT(tensor->data == NULL);
  1665. GGML_ASSERT(tensor->view_src == NULL);
  1666. GGML_ASSERT(addr >= ggml_backend_buffer_get_base(buffer));
  1667. GGML_ASSERT((char *)addr + ggml_backend_buffer_get_alloc_size(buffer, tensor) <=
  1668. (char *)ggml_backend_buffer_get_base(buffer) + ggml_backend_buffer_get_size(buffer));
  1669. tensor->buffer = buffer;
  1670. tensor->data = addr;
  1671. ggml_backend_buffer_init_tensor(buffer, tensor);
  1672. }
  1673. static struct ggml_tensor * graph_copy_dup_tensor(struct ggml_hash_set hash_set, struct ggml_tensor ** node_copies,
  1674. struct ggml_context * ctx_allocated, struct ggml_context * ctx_unallocated, struct ggml_tensor * src) {
  1675. GGML_ASSERT(src != NULL);
  1676. GGML_ASSERT(src->data && "graph must be allocated");
  1677. size_t id = ggml_hash_insert(hash_set, src);
  1678. if (id == GGML_HASHTABLE_ALREADY_EXISTS) {
  1679. return node_copies[ggml_hash_find(hash_set, src)];
  1680. }
  1681. struct ggml_tensor * dst = ggml_dup_tensor_layout(src->data && !src->view_src ? ctx_allocated : ctx_unallocated, src);
  1682. if (src->view_src != NULL) {
  1683. dst->view_src = graph_copy_dup_tensor(hash_set, node_copies, ctx_allocated, ctx_unallocated, src->view_src);
  1684. dst->view_offs = src->view_offs;
  1685. }
  1686. dst->op = src->op;
  1687. memcpy(dst->op_params, src->op_params, sizeof(dst->op_params));
  1688. ggml_set_name(dst, src->name);
  1689. // copy src
  1690. for (int i = 0; i < GGML_MAX_SRC; i++) {
  1691. struct ggml_tensor * s = src->src[i];
  1692. if (s == NULL) {
  1693. continue;
  1694. }
  1695. dst->src[i] = graph_copy_dup_tensor(hash_set, node_copies, ctx_allocated, ctx_unallocated, s);
  1696. }
  1697. node_copies[id] = dst;
  1698. return dst;
  1699. }
  1700. static void graph_copy_init_tensor(struct ggml_hash_set hash_set, struct ggml_tensor ** node_copies, bool * node_init, struct ggml_tensor * src) {
  1701. size_t id = ggml_hash_find(hash_set, src);
  1702. if (node_init[id]) {
  1703. return;
  1704. }
  1705. node_init[id] = true;
  1706. struct ggml_tensor * dst = node_copies[id];
  1707. if (dst->view_src != NULL) {
  1708. graph_copy_init_tensor(hash_set, node_copies, node_init, src->view_src);
  1709. ggml_backend_view_init(dst);
  1710. }
  1711. else {
  1712. ggml_backend_tensor_copy(src, dst);
  1713. }
  1714. // init src
  1715. for (int i = 0; i < GGML_MAX_SRC; i++) {
  1716. struct ggml_tensor * s = src->src[i];
  1717. if (s == NULL) {
  1718. continue;
  1719. }
  1720. graph_copy_init_tensor(hash_set, node_copies, node_init, s);
  1721. }
  1722. }
  1723. struct ggml_backend_graph_copy ggml_backend_graph_copy(ggml_backend_t backend, struct ggml_cgraph * graph) {
  1724. struct ggml_hash_set hash_set = {
  1725. /* .size = */ graph->visited_hash_table.size,
  1726. /* .keys = */ calloc(graph->visited_hash_table.size, sizeof(hash_set.keys[0])) // NOLINT
  1727. };
  1728. struct ggml_tensor ** node_copies = calloc(hash_set.size, sizeof(node_copies[0])); // NOLINT
  1729. bool * node_init = calloc(hash_set.size, sizeof(node_init[0]));
  1730. struct ggml_init_params params = {
  1731. /* .mem_size = */ ggml_tensor_overhead()*hash_set.size + ggml_graph_overhead_custom(graph->size, false),
  1732. /* .mem_buffer = */ NULL,
  1733. /* .no_alloc = */ true
  1734. };
  1735. struct ggml_context * ctx_allocated = ggml_init(params);
  1736. struct ggml_context * ctx_unallocated = ggml_init(params);
  1737. if (ctx_allocated == NULL || ctx_unallocated == NULL) {
  1738. fprintf(stderr, "failed to allocate context for graph copy\n");
  1739. free(hash_set.keys);
  1740. free(node_copies);
  1741. free(node_init);
  1742. ggml_free(ctx_allocated);
  1743. ggml_free(ctx_unallocated);
  1744. return (struct ggml_backend_graph_copy) {
  1745. /* .buffer = */ NULL,
  1746. /* .ctx_allocated = */ NULL,
  1747. /* .ctx_unallocated = */ NULL,
  1748. /* .graph = */ NULL,
  1749. };
  1750. }
  1751. // dup nodes
  1752. for (int i = 0; i < graph->n_nodes; i++) {
  1753. struct ggml_tensor * node = graph->nodes[i];
  1754. graph_copy_dup_tensor(hash_set, node_copies, ctx_allocated, ctx_unallocated, node);
  1755. }
  1756. // allocate nodes
  1757. ggml_backend_buffer_t buffer = ggml_backend_alloc_ctx_tensors(ctx_allocated, backend);
  1758. if (buffer == NULL) {
  1759. fprintf(stderr, "failed to allocate buffer for graph copy\n");
  1760. free(hash_set.keys);
  1761. free(node_copies);
  1762. free(node_init);
  1763. ggml_free(ctx_allocated);
  1764. ggml_free(ctx_unallocated);
  1765. return (struct ggml_backend_graph_copy) {
  1766. /* .buffer = */ NULL,
  1767. /* .ctx_allocated = */ NULL,
  1768. /* .ctx_unallocated = */ NULL,
  1769. /* .graph = */ NULL,
  1770. };
  1771. }
  1772. //printf("copy buffer size: %zu MB\n", ggml_backend_buffer_get_size(buffer) / 1024 / 1024);
  1773. // copy data and init views
  1774. for (int i = 0; i < graph->n_nodes; i++) {
  1775. struct ggml_tensor * node = graph->nodes[i];
  1776. graph_copy_init_tensor(hash_set, node_copies, node_init, node);
  1777. }
  1778. // build graph copy
  1779. struct ggml_cgraph * graph_copy = ggml_new_graph_custom(ctx_allocated, graph->size, false);
  1780. for (int i = 0; i < graph->n_nodes; i++) {
  1781. struct ggml_tensor * node = graph->nodes[i];
  1782. struct ggml_tensor * node_copy = node_copies[ggml_hash_find(hash_set, node)];
  1783. graph_copy->nodes[i] = node_copy;
  1784. }
  1785. graph_copy->n_nodes = graph->n_nodes;
  1786. free(hash_set.keys);
  1787. free(node_copies);
  1788. free(node_init);
  1789. return (struct ggml_backend_graph_copy) {
  1790. /* .buffer = */ buffer,
  1791. /* .ctx_allocated = */ ctx_allocated,
  1792. /* .ctx_unallocated = */ ctx_unallocated,
  1793. /* .graph = */ graph_copy,
  1794. };
  1795. }
  1796. void ggml_backend_graph_copy_free(struct ggml_backend_graph_copy copy) {
  1797. ggml_backend_buffer_free(copy.buffer);
  1798. ggml_free(copy.ctx_allocated);
  1799. ggml_free(copy.ctx_unallocated);
  1800. }
  1801. 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) {
  1802. struct ggml_backend_graph_copy copy = ggml_backend_graph_copy(backend2, graph);
  1803. if (copy.buffer == NULL) {
  1804. return false;
  1805. }
  1806. struct ggml_cgraph * g1 = graph;
  1807. struct ggml_cgraph * g2 = copy.graph;
  1808. assert(g1->n_nodes == g2->n_nodes);
  1809. for (int i = 0; i < g1->n_nodes; i++) {
  1810. //printf("eval %d/%d\n", i, g1->n_nodes);
  1811. struct ggml_tensor * t1 = g1->nodes[i];
  1812. struct ggml_tensor * t2 = g2->nodes[i];
  1813. assert(t1->op == t2->op && ggml_are_same_layout(t1, t2));
  1814. struct ggml_cgraph g1v = ggml_graph_view(g1, i, i + 1);
  1815. struct ggml_cgraph g2v = ggml_graph_view(g2, i, i + 1);
  1816. ggml_backend_graph_compute(backend1, &g1v);
  1817. ggml_backend_graph_compute(backend2, &g2v);
  1818. if (ggml_is_view_op(t1->op)) {
  1819. continue;
  1820. }
  1821. // compare results, calculate rms etc
  1822. if (!callback(i, t1, t2, user_data)) {
  1823. break;
  1824. }
  1825. }
  1826. ggml_backend_graph_copy_free(copy);
  1827. return true;
  1828. }