ggml-backend.cpp 77 KB

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