ggml-backend.cpp 75 KB

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