ggml-metal.m 63 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268
  1. #import "ggml-metal.h"
  2. #import "ggml.h"
  3. #import <Foundation/Foundation.h>
  4. #import <Metal/Metal.h>
  5. #undef MIN
  6. #undef MAX
  7. #define MIN(a, b) ((a) < (b) ? (a) : (b))
  8. #define MAX(a, b) ((a) > (b) ? (a) : (b))
  9. // TODO: temporary - reuse llama.cpp logging
  10. #ifdef GGML_METAL_NDEBUG
  11. #define metal_printf(...)
  12. #else
  13. #define metal_printf(...) fprintf(stderr, __VA_ARGS__)
  14. #endif
  15. #define UNUSED(x) (void)(x)
  16. #define GGML_MAX_CONCUR (2*GGML_MAX_NODES)
  17. struct ggml_metal_buffer {
  18. const char * name;
  19. void * data;
  20. size_t size;
  21. id<MTLBuffer> metal;
  22. };
  23. struct ggml_metal_context {
  24. int n_cb;
  25. id<MTLDevice> device;
  26. id<MTLCommandQueue> queue;
  27. id<MTLLibrary> library;
  28. id<MTLCommandBuffer> command_buffers [GGML_METAL_MAX_COMMAND_BUFFERS];
  29. id<MTLComputeCommandEncoder> command_encoders[GGML_METAL_MAX_COMMAND_BUFFERS];
  30. dispatch_queue_t d_queue;
  31. int n_buffers;
  32. struct ggml_metal_buffer buffers[GGML_METAL_MAX_BUFFERS];
  33. int concur_list[GGML_MAX_CONCUR];
  34. int concur_list_len;
  35. // custom kernels
  36. #define GGML_METAL_DECL_KERNEL(name) \
  37. id<MTLFunction> function_##name; \
  38. id<MTLComputePipelineState> pipeline_##name
  39. GGML_METAL_DECL_KERNEL(add);
  40. GGML_METAL_DECL_KERNEL(add_row); // TODO: avoid this extra kernel, instead extend the "add" kernel to support broadcast
  41. GGML_METAL_DECL_KERNEL(mul);
  42. GGML_METAL_DECL_KERNEL(mul_row); // TODO: avoid this extra kernel, instead extend the "mul" kernel to support broadcast
  43. GGML_METAL_DECL_KERNEL(scale);
  44. GGML_METAL_DECL_KERNEL(silu);
  45. GGML_METAL_DECL_KERNEL(relu);
  46. GGML_METAL_DECL_KERNEL(gelu);
  47. GGML_METAL_DECL_KERNEL(soft_max);
  48. GGML_METAL_DECL_KERNEL(soft_max_4);
  49. GGML_METAL_DECL_KERNEL(diag_mask_inf);
  50. GGML_METAL_DECL_KERNEL(diag_mask_inf_8);
  51. GGML_METAL_DECL_KERNEL(get_rows_f16);
  52. GGML_METAL_DECL_KERNEL(get_rows_q4_0);
  53. GGML_METAL_DECL_KERNEL(get_rows_q4_1);
  54. GGML_METAL_DECL_KERNEL(get_rows_q8_0);
  55. GGML_METAL_DECL_KERNEL(get_rows_q2_K);
  56. GGML_METAL_DECL_KERNEL(get_rows_q3_K);
  57. GGML_METAL_DECL_KERNEL(get_rows_q4_K);
  58. GGML_METAL_DECL_KERNEL(get_rows_q5_K);
  59. GGML_METAL_DECL_KERNEL(get_rows_q6_K);
  60. GGML_METAL_DECL_KERNEL(rms_norm);
  61. GGML_METAL_DECL_KERNEL(norm);
  62. GGML_METAL_DECL_KERNEL(mul_mat_f16_f32);
  63. GGML_METAL_DECL_KERNEL(mul_mat_f16_f32_1row);
  64. GGML_METAL_DECL_KERNEL(mul_mat_f16_f32_l4);
  65. GGML_METAL_DECL_KERNEL(mul_mat_q4_0_f32);
  66. GGML_METAL_DECL_KERNEL(mul_mat_q4_1_f32);
  67. GGML_METAL_DECL_KERNEL(mul_mat_q8_0_f32);
  68. GGML_METAL_DECL_KERNEL(mul_mat_q2_K_f32);
  69. GGML_METAL_DECL_KERNEL(mul_mat_q3_K_f32);
  70. GGML_METAL_DECL_KERNEL(mul_mat_q4_K_f32);
  71. GGML_METAL_DECL_KERNEL(mul_mat_q5_K_f32);
  72. GGML_METAL_DECL_KERNEL(mul_mat_q6_K_f32);
  73. GGML_METAL_DECL_KERNEL(mul_mm_f16_f32);
  74. GGML_METAL_DECL_KERNEL(mul_mm_q4_0_f32);
  75. GGML_METAL_DECL_KERNEL(mul_mm_q4_1_f32);
  76. GGML_METAL_DECL_KERNEL(mul_mm_q8_0_f32);
  77. GGML_METAL_DECL_KERNEL(mul_mm_q2_K_f32);
  78. GGML_METAL_DECL_KERNEL(mul_mm_q3_K_f32);
  79. GGML_METAL_DECL_KERNEL(mul_mm_q4_K_f32);
  80. GGML_METAL_DECL_KERNEL(mul_mm_q5_K_f32);
  81. GGML_METAL_DECL_KERNEL(mul_mm_q6_K_f32);
  82. GGML_METAL_DECL_KERNEL(rope);
  83. GGML_METAL_DECL_KERNEL(alibi_f32);
  84. GGML_METAL_DECL_KERNEL(cpy_f32_f16);
  85. GGML_METAL_DECL_KERNEL(cpy_f32_f32);
  86. GGML_METAL_DECL_KERNEL(cpy_f16_f16);
  87. #undef GGML_METAL_DECL_KERNEL
  88. };
  89. // MSL code
  90. // TODO: move the contents here when ready
  91. // for now it is easier to work in a separate file
  92. static NSString * const msl_library_source = @"see metal.metal";
  93. // Here to assist with NSBundle Path Hack
  94. @interface GGMLMetalClass : NSObject
  95. @end
  96. @implementation GGMLMetalClass
  97. @end
  98. struct ggml_metal_context * ggml_metal_init(int n_cb) {
  99. metal_printf("%s: allocating\n", __func__);
  100. id <MTLDevice> device;
  101. NSString * s;
  102. #if TARGET_OS_OSX
  103. // Show all the Metal device instances in the system
  104. NSArray * devices = MTLCopyAllDevices();
  105. for (device in devices) {
  106. s = [device name];
  107. metal_printf("%s: found device: %s\n", __func__, [s UTF8String]);
  108. }
  109. #endif
  110. // Pick and show default Metal device
  111. device = MTLCreateSystemDefaultDevice();
  112. s = [device name];
  113. metal_printf("%s: picking default device: %s\n", __func__, [s UTF8String]);
  114. // Configure context
  115. struct ggml_metal_context * ctx = malloc(sizeof(struct ggml_metal_context));
  116. ctx->device = device;
  117. ctx->n_cb = MIN(n_cb, GGML_METAL_MAX_BUFFERS);
  118. ctx->queue = [ctx->device newCommandQueue];
  119. ctx->n_buffers = 0;
  120. ctx->concur_list_len = 0;
  121. ctx->d_queue = dispatch_queue_create("llama.cpp", DISPATCH_QUEUE_CONCURRENT);
  122. #ifdef GGML_SWIFT
  123. // load the default.metallib file
  124. {
  125. NSError * error = nil;
  126. NSBundle * bundle = [NSBundle bundleForClass:[GGMLMetalClass class]];
  127. NSString * llamaBundlePath = [bundle pathForResource:@"llama_llama" ofType:@"bundle"];
  128. NSBundle * llamaBundle = [NSBundle bundleWithPath:llamaBundlePath];
  129. NSString * libPath = [llamaBundle pathForResource:@"default" ofType:@"metallib"];
  130. NSURL * libURL = [NSURL fileURLWithPath:libPath];
  131. // Load the metallib file into a Metal library
  132. ctx->library = [ctx->device newLibraryWithURL:libURL error:&error];
  133. if (error) {
  134. metal_printf("%s: error: %s\n", __func__, [[error description] UTF8String]);
  135. return NULL;
  136. }
  137. }
  138. #else
  139. UNUSED(msl_library_source);
  140. // read the source from "ggml-metal.metal" into a string and use newLibraryWithSource
  141. {
  142. NSError * error = nil;
  143. //NSString * path = [[NSBundle mainBundle] pathForResource:@"../../examples/metal/metal" ofType:@"metal"];
  144. NSBundle * bundle = [NSBundle bundleForClass:[GGMLMetalClass class]];
  145. NSString * path = [bundle pathForResource:@"ggml-metal" ofType:@"metal"];
  146. metal_printf("%s: loading '%s'\n", __func__, [path UTF8String]);
  147. NSString * src = [NSString stringWithContentsOfFile:path encoding:NSUTF8StringEncoding error:&error];
  148. if (error) {
  149. metal_printf("%s: error: %s\n", __func__, [[error description] UTF8String]);
  150. return NULL;
  151. }
  152. #ifdef GGML_QKK_64
  153. MTLCompileOptions* options = [MTLCompileOptions new];
  154. options.preprocessorMacros = @{ @"QK_K" : @(64) };
  155. ctx->library = [ctx->device newLibraryWithSource:src options:options error:&error];
  156. #else
  157. ctx->library = [ctx->device newLibraryWithSource:src options:nil error:&error];
  158. #endif
  159. if (error) {
  160. metal_printf("%s: error: %s\n", __func__, [[error description] UTF8String]);
  161. return NULL;
  162. }
  163. }
  164. #endif
  165. // load kernels
  166. {
  167. NSError * error = nil;
  168. #define GGML_METAL_ADD_KERNEL(name) \
  169. ctx->function_##name = [ctx->library newFunctionWithName:@"kernel_"#name]; \
  170. ctx->pipeline_##name = [ctx->device newComputePipelineStateWithFunction:ctx->function_##name error:&error]; \
  171. metal_printf("%s: loaded %-32s %16p | th_max = %4d | th_width = %4d\n", __func__, "kernel_"#name, (void *) ctx->pipeline_##name, \
  172. (int) ctx->pipeline_##name.maxTotalThreadsPerThreadgroup, \
  173. (int) ctx->pipeline_##name.threadExecutionWidth); \
  174. if (error) { \
  175. metal_printf("%s: load pipeline error: %s\n", __func__, [[error description] UTF8String]); \
  176. return NULL; \
  177. }
  178. GGML_METAL_ADD_KERNEL(add);
  179. GGML_METAL_ADD_KERNEL(add_row);
  180. GGML_METAL_ADD_KERNEL(mul);
  181. GGML_METAL_ADD_KERNEL(mul_row);
  182. GGML_METAL_ADD_KERNEL(scale);
  183. GGML_METAL_ADD_KERNEL(silu);
  184. GGML_METAL_ADD_KERNEL(relu);
  185. GGML_METAL_ADD_KERNEL(gelu);
  186. GGML_METAL_ADD_KERNEL(soft_max);
  187. GGML_METAL_ADD_KERNEL(soft_max_4);
  188. GGML_METAL_ADD_KERNEL(diag_mask_inf);
  189. GGML_METAL_ADD_KERNEL(diag_mask_inf_8);
  190. GGML_METAL_ADD_KERNEL(get_rows_f16);
  191. GGML_METAL_ADD_KERNEL(get_rows_q4_0);
  192. GGML_METAL_ADD_KERNEL(get_rows_q4_1);
  193. GGML_METAL_ADD_KERNEL(get_rows_q8_0);
  194. GGML_METAL_ADD_KERNEL(get_rows_q2_K);
  195. GGML_METAL_ADD_KERNEL(get_rows_q3_K);
  196. GGML_METAL_ADD_KERNEL(get_rows_q4_K);
  197. GGML_METAL_ADD_KERNEL(get_rows_q5_K);
  198. GGML_METAL_ADD_KERNEL(get_rows_q6_K);
  199. GGML_METAL_ADD_KERNEL(rms_norm);
  200. GGML_METAL_ADD_KERNEL(norm);
  201. GGML_METAL_ADD_KERNEL(mul_mat_f16_f32);
  202. GGML_METAL_ADD_KERNEL(mul_mat_f16_f32_1row);
  203. GGML_METAL_ADD_KERNEL(mul_mat_f16_f32_l4);
  204. GGML_METAL_ADD_KERNEL(mul_mat_q4_0_f32);
  205. GGML_METAL_ADD_KERNEL(mul_mat_q4_1_f32);
  206. GGML_METAL_ADD_KERNEL(mul_mat_q8_0_f32);
  207. GGML_METAL_ADD_KERNEL(mul_mat_q2_K_f32);
  208. GGML_METAL_ADD_KERNEL(mul_mat_q3_K_f32);
  209. GGML_METAL_ADD_KERNEL(mul_mat_q4_K_f32);
  210. GGML_METAL_ADD_KERNEL(mul_mat_q5_K_f32);
  211. GGML_METAL_ADD_KERNEL(mul_mat_q6_K_f32);
  212. GGML_METAL_ADD_KERNEL(mul_mm_f16_f32);
  213. GGML_METAL_ADD_KERNEL(mul_mm_q4_0_f32);
  214. GGML_METAL_ADD_KERNEL(mul_mm_q8_0_f32);
  215. GGML_METAL_ADD_KERNEL(mul_mm_q4_1_f32);
  216. GGML_METAL_ADD_KERNEL(mul_mm_q2_K_f32);
  217. GGML_METAL_ADD_KERNEL(mul_mm_q3_K_f32);
  218. GGML_METAL_ADD_KERNEL(mul_mm_q4_K_f32);
  219. GGML_METAL_ADD_KERNEL(mul_mm_q5_K_f32);
  220. GGML_METAL_ADD_KERNEL(mul_mm_q6_K_f32);
  221. GGML_METAL_ADD_KERNEL(rope);
  222. GGML_METAL_ADD_KERNEL(alibi_f32);
  223. GGML_METAL_ADD_KERNEL(cpy_f32_f16);
  224. GGML_METAL_ADD_KERNEL(cpy_f32_f32);
  225. GGML_METAL_ADD_KERNEL(cpy_f16_f16);
  226. #undef GGML_METAL_ADD_KERNEL
  227. }
  228. metal_printf("%s: hasUnifiedMemory = %s\n", __func__, ctx->device.hasUnifiedMemory ? "true" : "false");
  229. #if TARGET_OS_OSX
  230. metal_printf("%s: recommendedMaxWorkingSetSize = %8.2f MB\n", __func__, ctx->device.recommendedMaxWorkingSetSize / 1024.0 / 1024.0);
  231. if (ctx->device.maxTransferRate != 0) {
  232. metal_printf("%s: maxTransferRate = %8.2f MB/s\n", __func__, ctx->device.maxTransferRate / 1024.0 / 1024.0);
  233. } else {
  234. metal_printf("%s: maxTransferRate = built-in GPU\n", __func__);
  235. }
  236. #endif
  237. return ctx;
  238. }
  239. void ggml_metal_free(struct ggml_metal_context * ctx) {
  240. metal_printf("%s: deallocating\n", __func__);
  241. #define GGML_METAL_DEL_KERNEL(name) \
  242. [ctx->function_##name release]; \
  243. [ctx->pipeline_##name release];
  244. GGML_METAL_DEL_KERNEL(add);
  245. GGML_METAL_DEL_KERNEL(add_row);
  246. GGML_METAL_DEL_KERNEL(mul);
  247. GGML_METAL_DEL_KERNEL(mul_row);
  248. GGML_METAL_DEL_KERNEL(scale);
  249. GGML_METAL_DEL_KERNEL(silu);
  250. GGML_METAL_DEL_KERNEL(relu);
  251. GGML_METAL_DEL_KERNEL(gelu);
  252. GGML_METAL_DEL_KERNEL(soft_max);
  253. GGML_METAL_DEL_KERNEL(soft_max_4);
  254. GGML_METAL_DEL_KERNEL(diag_mask_inf_8);
  255. GGML_METAL_DEL_KERNEL(get_rows_f16);
  256. GGML_METAL_DEL_KERNEL(get_rows_q4_0);
  257. GGML_METAL_DEL_KERNEL(get_rows_q4_1);
  258. GGML_METAL_DEL_KERNEL(get_rows_q8_0);
  259. GGML_METAL_DEL_KERNEL(get_rows_q2_K);
  260. GGML_METAL_DEL_KERNEL(get_rows_q3_K);
  261. GGML_METAL_DEL_KERNEL(get_rows_q4_K);
  262. GGML_METAL_DEL_KERNEL(get_rows_q5_K);
  263. GGML_METAL_DEL_KERNEL(get_rows_q6_K);
  264. GGML_METAL_DEL_KERNEL(rms_norm);
  265. GGML_METAL_DEL_KERNEL(norm);
  266. GGML_METAL_DEL_KERNEL(mul_mat_f16_f32);
  267. GGML_METAL_DEL_KERNEL(mul_mat_f16_f32_1row);
  268. GGML_METAL_DEL_KERNEL(mul_mat_f16_f32_l4);
  269. GGML_METAL_DEL_KERNEL(mul_mat_q4_0_f32);
  270. GGML_METAL_DEL_KERNEL(mul_mat_q4_1_f32);
  271. GGML_METAL_DEL_KERNEL(mul_mat_q8_0_f32);
  272. GGML_METAL_DEL_KERNEL(mul_mat_q2_K_f32);
  273. GGML_METAL_DEL_KERNEL(mul_mat_q3_K_f32);
  274. GGML_METAL_DEL_KERNEL(mul_mat_q4_K_f32);
  275. GGML_METAL_DEL_KERNEL(mul_mat_q5_K_f32);
  276. GGML_METAL_DEL_KERNEL(mul_mat_q6_K_f32);
  277. GGML_METAL_DEL_KERNEL(mul_mm_f16_f32);
  278. GGML_METAL_DEL_KERNEL(mul_mm_q4_0_f32);
  279. GGML_METAL_DEL_KERNEL(mul_mm_q8_0_f32);
  280. GGML_METAL_DEL_KERNEL(mul_mm_q4_1_f32);
  281. GGML_METAL_DEL_KERNEL(mul_mm_q2_K_f32);
  282. GGML_METAL_DEL_KERNEL(mul_mm_q3_K_f32);
  283. GGML_METAL_DEL_KERNEL(mul_mm_q4_K_f32);
  284. GGML_METAL_DEL_KERNEL(mul_mm_q5_K_f32);
  285. GGML_METAL_DEL_KERNEL(mul_mm_q6_K_f32);
  286. GGML_METAL_DEL_KERNEL(rope);
  287. GGML_METAL_DEL_KERNEL(alibi_f32);
  288. GGML_METAL_DEL_KERNEL(cpy_f32_f16);
  289. GGML_METAL_DEL_KERNEL(cpy_f32_f32);
  290. GGML_METAL_DEL_KERNEL(cpy_f16_f16);
  291. #undef GGML_METAL_DEL_KERNEL
  292. for (int i = 0; i < ctx->n_buffers; ++i) {
  293. [ctx->buffers[i].metal release];
  294. }
  295. [ctx->library release];
  296. [ctx->queue release];
  297. [ctx->device release];
  298. dispatch_release(ctx->d_queue);
  299. free(ctx);
  300. }
  301. void * ggml_metal_host_malloc(size_t n) {
  302. void * data = NULL;
  303. const int result = posix_memalign((void **) &data, sysconf(_SC_PAGESIZE), n);
  304. if (result != 0) {
  305. metal_printf("%s: error: posix_memalign failed\n", __func__);
  306. return NULL;
  307. }
  308. return data;
  309. }
  310. void ggml_metal_host_free(void * data) {
  311. free(data);
  312. }
  313. void ggml_metal_set_n_cb(struct ggml_metal_context * ctx, int n_cb) {
  314. ctx->n_cb = MIN(n_cb, GGML_METAL_MAX_BUFFERS);
  315. }
  316. int ggml_metal_if_optimized(struct ggml_metal_context * ctx) {
  317. return ctx->concur_list_len;
  318. }
  319. int * ggml_metal_get_concur_list(struct ggml_metal_context * ctx) {
  320. return ctx->concur_list;
  321. }
  322. // finds the Metal buffer that contains the tensor data on the GPU device
  323. // the assumption is that there is 1-to-1 mapping between the host and device memory buffers, so we can find the
  324. // Metal buffer based on the host memory pointer
  325. //
  326. static id<MTLBuffer> ggml_metal_get_buffer(struct ggml_metal_context * ctx, struct ggml_tensor * t, size_t * offs) {
  327. //metal_printf("%s: data tensor '%16s', offs_data = %8ld, offs_eval = %8ld, offs_cach = %8ld\n", __func__, t->name, offs_data, offs_eval, offs_cach);
  328. const int64_t tsize = ggml_nbytes(t);
  329. // find the view that contains the tensor fully
  330. for (int i = 0; i < ctx->n_buffers; ++i) {
  331. const int64_t ioffs = (int64_t) t->data - (int64_t) ctx->buffers[i].data;
  332. if (ioffs >= 0 && ioffs + tsize <= (int64_t) ctx->buffers[i].size) {
  333. *offs = (size_t) ioffs;
  334. //metal_printf("%s: '%s' tensor '%16s', offs = %8ld\n", __func__, ctx->buffers[i].name, t->name, *offs);
  335. return ctx->buffers[i].metal;
  336. }
  337. }
  338. metal_printf("%s: error: buffer is nil\n", __func__);
  339. return nil;
  340. }
  341. bool ggml_metal_add_buffer(
  342. struct ggml_metal_context * ctx,
  343. const char * name,
  344. void * data,
  345. size_t size,
  346. size_t max_size) {
  347. if (ctx->n_buffers >= GGML_METAL_MAX_BUFFERS) {
  348. metal_printf("%s: too many buffers\n", __func__);
  349. return false;
  350. }
  351. if (data) {
  352. // verify that the buffer does not overlap with any of the existing buffers
  353. for (int i = 0; i < ctx->n_buffers; ++i) {
  354. const int64_t ioffs = (int64_t) data - (int64_t) ctx->buffers[i].data;
  355. if (ioffs >= 0 && ioffs < (int64_t) ctx->buffers[i].size) {
  356. metal_printf("%s: error: buffer '%s' overlaps with '%s'\n", __func__, name, ctx->buffers[i].name);
  357. return false;
  358. }
  359. }
  360. const size_t size_page = sysconf(_SC_PAGESIZE);
  361. size_t size_aligned = size;
  362. if ((size_aligned % size_page) != 0) {
  363. size_aligned += (size_page - (size_aligned % size_page));
  364. }
  365. // the buffer fits into the max buffer size allowed by the device
  366. if (size_aligned <= ctx->device.maxBufferLength) {
  367. ctx->buffers[ctx->n_buffers].name = name;
  368. ctx->buffers[ctx->n_buffers].data = data;
  369. ctx->buffers[ctx->n_buffers].size = size;
  370. ctx->buffers[ctx->n_buffers].metal = [ctx->device newBufferWithBytesNoCopy:data length:size_aligned options:MTLResourceStorageModeShared deallocator:nil];
  371. if (ctx->buffers[ctx->n_buffers].metal == nil) {
  372. metal_printf("%s: failed to allocate '%-16s' buffer, size = %8.2f MB\n", __func__, name, size_aligned / 1024.0 / 1024.0);
  373. return false;
  374. }
  375. metal_printf("%s: allocated '%-16s' buffer, size = %8.2f MB", __func__, name, size_aligned / 1024.0 / 1024.0);
  376. ++ctx->n_buffers;
  377. } else {
  378. // this overlap between the views will guarantee that the tensor with the maximum size will fully fit into
  379. // one of the views
  380. const size_t size_ovlp = ((max_size + size_page - 1) / size_page + 1) * size_page; // round-up 2 pages just in case
  381. const size_t size_step = ctx->device.maxBufferLength - size_ovlp;
  382. const size_t size_view = ctx->device.maxBufferLength;
  383. for (size_t i = 0; i < size; i += size_step) {
  384. const size_t size_step_aligned = (i + size_view <= size) ? size_view : (size_aligned - i);
  385. ctx->buffers[ctx->n_buffers].name = name;
  386. ctx->buffers[ctx->n_buffers].data = (void *) ((uint8_t *) data + i);
  387. ctx->buffers[ctx->n_buffers].size = size_step_aligned;
  388. ctx->buffers[ctx->n_buffers].metal = [ctx->device newBufferWithBytesNoCopy:(void *) ((uint8_t *) data + i) length:size_step_aligned options:MTLResourceStorageModeShared deallocator:nil];
  389. if (ctx->buffers[ctx->n_buffers].metal == nil) {
  390. metal_printf("%s: failed to allocate '%-16s' buffer, size = %8.2f MB\n", __func__, name, size_step_aligned / 1024.0 / 1024.0);
  391. return false;
  392. }
  393. metal_printf("%s: allocated '%-16s' buffer, size = %8.2f MB, offs = %12ld", __func__, name, size_step_aligned / 1024.0 / 1024.0, i);
  394. if (i + size_step < size) {
  395. metal_printf("\n");
  396. }
  397. ++ctx->n_buffers;
  398. }
  399. }
  400. #if TARGET_OS_OSX
  401. metal_printf(", (%8.2f / %8.2f)",
  402. ctx->device.currentAllocatedSize / 1024.0 / 1024.0,
  403. ctx->device.recommendedMaxWorkingSetSize / 1024.0 / 1024.0);
  404. if (ctx->device.currentAllocatedSize > ctx->device.recommendedMaxWorkingSetSize) {
  405. metal_printf(", warning: current allocated size is greater than the recommended max working set size\n");
  406. } else {
  407. metal_printf("\n");
  408. }
  409. #else
  410. metal_printf(", (%8.2f)\n", ctx->device.currentAllocatedSize / 1024.0 / 1024.0);
  411. #endif
  412. }
  413. return true;
  414. }
  415. void ggml_metal_set_tensor(
  416. struct ggml_metal_context * ctx,
  417. struct ggml_tensor * t) {
  418. size_t offs;
  419. id<MTLBuffer> id_dst = ggml_metal_get_buffer(ctx, t, &offs);
  420. memcpy((void *) ((uint8_t *) id_dst.contents + offs), t->data, ggml_nbytes(t));
  421. }
  422. void ggml_metal_get_tensor(
  423. struct ggml_metal_context * ctx,
  424. struct ggml_tensor * t) {
  425. size_t offs;
  426. id<MTLBuffer> id_src = ggml_metal_get_buffer(ctx, t, &offs);
  427. memcpy(t->data, (void *) ((uint8_t *) id_src.contents + offs), ggml_nbytes(t));
  428. }
  429. void ggml_metal_graph_find_concurrency(
  430. struct ggml_metal_context * ctx,
  431. struct ggml_cgraph * gf, bool check_mem) {
  432. int search_depth = gf->n_nodes; //we only find concurrency in this range to avoid wasting too much time
  433. int nodes_unused[GGML_MAX_CONCUR];
  434. for (int i = 0; i < GGML_MAX_CONCUR; i++) { ctx->concur_list[i] = 0; }
  435. for (int i = 0; i < gf->n_nodes; i++) { nodes_unused[i] = 1; }
  436. ctx->concur_list_len = 0;
  437. int n_left = gf->n_nodes;
  438. int n_start = 0; // all nodes before n_start at nodes_unused array have been sorted and store back to ctx->concur_list
  439. int level_pos = 0; // at ctx->concur_list, the last layer (level) ends at level_pos
  440. while (n_left > 0) {
  441. // number of nodes at a layer (that can be issued concurrently)
  442. int concurrency = 0;
  443. for (int i = n_start; i < ((n_start + search_depth > gf->n_nodes) ? gf->n_nodes : n_start + search_depth); i++) {
  444. if (nodes_unused[i]) {
  445. // if the requirements for gf->nodes[i] are satisfied
  446. int exe_flag = 1;
  447. // scan all srcs
  448. for (int src_ind = 0; src_ind < GGML_MAX_SRC; src_ind++) {
  449. struct ggml_tensor * src_cur = gf->nodes[i]->src[src_ind];
  450. if (src_cur) {
  451. // if is leaf nodes it's satisfied.
  452. // TODO: ggml_is_leaf()
  453. if (src_cur->op == GGML_OP_NONE && src_cur->grad == NULL) {
  454. continue;
  455. }
  456. // otherwise this src should be the output from previous nodes.
  457. int is_found = 0;
  458. // scan 2*search_depth back because we inserted barrier.
  459. //for (int j = ((level_pos - 2*search_depth) < 0 ? 0 : (level_pos - 2*search_depth)); j < level_pos; j++) {
  460. for (int j = MAX(0, level_pos - 2*search_depth); j < level_pos; j++) {
  461. if (ctx->concur_list[j] >= 0 && gf->nodes[ctx->concur_list[j]] == src_cur) {
  462. is_found = 1;
  463. break;
  464. }
  465. }
  466. if (is_found == 0) {
  467. exe_flag = 0;
  468. break;
  469. }
  470. }
  471. }
  472. if (exe_flag && check_mem) {
  473. // check if nodes[i]'s data will be overwritten by a node before nodes[i].
  474. // if node[5] and node[3] write to the same memory region, then we can't issue node[5] before node[3]
  475. int64_t data_start = (int64_t) gf->nodes[i]->data;
  476. int64_t length = (int64_t) ggml_nbytes(gf->nodes[i]);
  477. for (int j = n_start; j < i; j++) {
  478. if (nodes_unused[j] && gf->nodes[j]->op != GGML_OP_RESHAPE \
  479. && gf->nodes[j]->op != GGML_OP_VIEW \
  480. && gf->nodes[j]->op != GGML_OP_TRANSPOSE \
  481. && gf->nodes[j]->op != GGML_OP_PERMUTE) {
  482. if (((int64_t)gf->nodes[j]->data) >= data_start + length || \
  483. ((int64_t)gf->nodes[j]->data) + (int64_t) ggml_nbytes(gf->nodes[j]) <= data_start) {
  484. continue;
  485. }
  486. exe_flag = 0;
  487. }
  488. }
  489. }
  490. if (exe_flag) {
  491. ctx->concur_list[level_pos + concurrency] = i;
  492. nodes_unused[i] = 0;
  493. concurrency++;
  494. ctx->concur_list_len++;
  495. }
  496. }
  497. }
  498. n_left -= concurrency;
  499. // adding a barrier different layer
  500. ctx->concur_list[level_pos + concurrency] = -1;
  501. ctx->concur_list_len++;
  502. // jump all sorted nodes at nodes_bak
  503. while (!nodes_unused[n_start]) {
  504. n_start++;
  505. }
  506. level_pos += concurrency + 1;
  507. }
  508. if (ctx->concur_list_len > GGML_MAX_CONCUR) {
  509. metal_printf("%s: too many elements for metal ctx->concur_list!\n", __func__);
  510. }
  511. }
  512. void ggml_metal_graph_compute(
  513. struct ggml_metal_context * ctx,
  514. struct ggml_cgraph * gf) {
  515. @autoreleasepool {
  516. // if there is ctx->concur_list, dispatch concurrently
  517. // else fallback to serial dispatch
  518. MTLComputePassDescriptor * edesc = MTLComputePassDescriptor.computePassDescriptor;
  519. const bool has_concur = ctx->concur_list_len && ctx->concur_list_len <= GGML_MAX_CONCUR;
  520. const int n_nodes = has_concur ? ctx->concur_list_len : gf->n_nodes;
  521. edesc.dispatchType = has_concur ? MTLDispatchTypeConcurrent : MTLDispatchTypeSerial;
  522. // create multiple command buffers and enqueue them
  523. // then, we encode the graph into the command buffers in parallel
  524. const int n_cb = ctx->n_cb;
  525. for (int i = 0; i < n_cb; ++i) {
  526. ctx->command_buffers[i] = [ctx->queue commandBuffer];
  527. // enqueue the command buffers in order to specify their execution order
  528. [ctx->command_buffers[i] enqueue];
  529. ctx->command_encoders[i] = [ctx->command_buffers[i] computeCommandEncoderWithDescriptor: edesc];
  530. }
  531. for (int cb_idx = 0; cb_idx < n_cb; ++cb_idx) {
  532. const int n_nodes_per_cb = (n_nodes + n_cb - 1) / n_cb;
  533. dispatch_async(ctx->d_queue, ^{
  534. size_t offs_src0 = 0;
  535. size_t offs_src1 = 0;
  536. size_t offs_dst = 0;
  537. id<MTLCommandBuffer> command_buffer = ctx->command_buffers[cb_idx];
  538. id<MTLComputeCommandEncoder> encoder = ctx->command_encoders[cb_idx];
  539. const int node_start = (cb_idx + 0) * n_nodes_per_cb;
  540. const int node_end = MIN((cb_idx == n_cb - 1) ? n_nodes : (cb_idx + 1) * n_nodes_per_cb, n_nodes);
  541. for (int ind = node_start; ind < node_end; ++ind) {
  542. const int i = has_concur ? ctx->concur_list[ind] : ind;
  543. if (i == -1) {
  544. [encoder memoryBarrierWithScope:MTLBarrierScopeBuffers];
  545. continue;
  546. }
  547. //metal_printf("%s: encoding node %3d, op = %8s\n", __func__, i, ggml_op_name(gf->nodes[i]->op));
  548. struct ggml_tensor * src0 = gf->nodes[i]->src[0];
  549. struct ggml_tensor * src1 = gf->nodes[i]->src[1];
  550. struct ggml_tensor * dst = gf->nodes[i];
  551. const int64_t ne00 = src0 ? src0->ne[0] : 0;
  552. const int64_t ne01 = src0 ? src0->ne[1] : 0;
  553. const int64_t ne02 = src0 ? src0->ne[2] : 0;
  554. const int64_t ne03 = src0 ? src0->ne[3] : 0;
  555. const uint64_t nb00 = src0 ? src0->nb[0] : 0;
  556. const uint64_t nb01 = src0 ? src0->nb[1] : 0;
  557. const uint64_t nb02 = src0 ? src0->nb[2] : 0;
  558. const uint64_t nb03 = src0 ? src0->nb[3] : 0;
  559. const int64_t ne10 = src1 ? src1->ne[0] : 0;
  560. const int64_t ne11 = src1 ? src1->ne[1] : 0;
  561. const int64_t ne12 = src1 ? src1->ne[2] : 0;
  562. const int64_t ne13 = src1 ? src1->ne[3] : 0; UNUSED(ne13);
  563. const uint64_t nb10 = src1 ? src1->nb[0] : 0;
  564. const uint64_t nb11 = src1 ? src1->nb[1] : 0;
  565. const uint64_t nb12 = src1 ? src1->nb[2] : 0;
  566. const uint64_t nb13 = src1 ? src1->nb[3] : 0; UNUSED(nb13);
  567. const int64_t ne0 = dst ? dst->ne[0] : 0;
  568. const int64_t ne1 = dst ? dst->ne[1] : 0;
  569. const int64_t ne2 = dst ? dst->ne[2] : 0;
  570. const int64_t ne3 = dst ? dst->ne[3] : 0;
  571. const uint64_t nb0 = dst ? dst->nb[0] : 0;
  572. const uint64_t nb1 = dst ? dst->nb[1] : 0;
  573. const uint64_t nb2 = dst ? dst->nb[2] : 0;
  574. const uint64_t nb3 = dst ? dst->nb[3] : 0;
  575. const enum ggml_type src0t = src0 ? src0->type : GGML_TYPE_COUNT;
  576. const enum ggml_type src1t = src1 ? src1->type : GGML_TYPE_COUNT;
  577. const enum ggml_type dstt = dst ? dst->type : GGML_TYPE_COUNT;
  578. id<MTLBuffer> id_src0 = src0 ? ggml_metal_get_buffer(ctx, src0, &offs_src0) : nil;
  579. id<MTLBuffer> id_src1 = src1 ? ggml_metal_get_buffer(ctx, src1, &offs_src1) : nil;
  580. id<MTLBuffer> id_dst = dst ? ggml_metal_get_buffer(ctx, dst, &offs_dst) : nil;
  581. //metal_printf("%s: op - %s\n", __func__, ggml_op_name(dst->op));
  582. //if (src0) {
  583. // metal_printf("%s: src0 - %4s [%5lld, %5lld, %5lld], %d, %s\n", __func__, ggml_type_name(src0t), ne00, ne01, ne02,
  584. // ggml_is_contiguous(src0), src0->name);
  585. //}
  586. //if (src1) {
  587. // metal_printf("%s: src1 - %4s [%5lld, %5lld, %5lld], %d, %s\n", __func__, ggml_type_name(src1t), ne10, ne11, ne12,
  588. // ggml_is_contiguous(src1), src1->name);
  589. //}
  590. //if (dst) {
  591. // metal_printf("%s: dst - %4s [%5lld, %5lld, %5lld], 1, %s\n", __func__, ggml_type_name(dstt), ne0, ne1, ne2,
  592. // dst->name);
  593. //}
  594. switch (dst->op) {
  595. case GGML_OP_NONE:
  596. case GGML_OP_RESHAPE:
  597. case GGML_OP_VIEW:
  598. case GGML_OP_TRANSPOSE:
  599. case GGML_OP_PERMUTE:
  600. {
  601. // noop
  602. } break;
  603. case GGML_OP_ADD:
  604. {
  605. GGML_ASSERT(ggml_is_contiguous(src0));
  606. // utilize float4
  607. GGML_ASSERT(ne00 % 4 == 0);
  608. const int64_t nb = ne00/4;
  609. if (ggml_nelements(src1) == ne10) {
  610. // src1 is a row
  611. [encoder setComputePipelineState:ctx->pipeline_add_row];
  612. } else {
  613. [encoder setComputePipelineState:ctx->pipeline_add];
  614. }
  615. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  616. [encoder setBuffer:id_src1 offset:offs_src1 atIndex:1];
  617. [encoder setBuffer:id_dst offset:offs_dst atIndex:2];
  618. [encoder setBytes:&nb length:sizeof(nb) atIndex:3];
  619. const int64_t n = ggml_nelements(dst)/4;
  620. [encoder dispatchThreadgroups:MTLSizeMake(n, 1, 1) threadsPerThreadgroup:MTLSizeMake(1, 1, 1)];
  621. } break;
  622. case GGML_OP_MUL:
  623. {
  624. GGML_ASSERT(ggml_is_contiguous(src0));
  625. // utilize float4
  626. GGML_ASSERT(ne00 % 4 == 0);
  627. const int64_t nb = ne00/4;
  628. if (ggml_nelements(src1) == ne10) {
  629. // src1 is a row
  630. [encoder setComputePipelineState:ctx->pipeline_mul_row];
  631. } else {
  632. [encoder setComputePipelineState:ctx->pipeline_mul];
  633. }
  634. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  635. [encoder setBuffer:id_src1 offset:offs_src1 atIndex:1];
  636. [encoder setBuffer:id_dst offset:offs_dst atIndex:2];
  637. [encoder setBytes:&nb length:sizeof(nb) atIndex:3];
  638. const int64_t n = ggml_nelements(dst)/4;
  639. [encoder dispatchThreadgroups:MTLSizeMake(n, 1, 1) threadsPerThreadgroup:MTLSizeMake(1, 1, 1)];
  640. } break;
  641. case GGML_OP_SCALE:
  642. {
  643. const float scale = *(const float *) src1->data;
  644. [encoder setComputePipelineState:ctx->pipeline_scale];
  645. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  646. [encoder setBuffer:id_dst offset:offs_dst atIndex:1];
  647. [encoder setBytes:&scale length:sizeof(scale) atIndex:2];
  648. const int64_t n = ggml_nelements(dst)/4;
  649. [encoder dispatchThreadgroups:MTLSizeMake(n, 1, 1) threadsPerThreadgroup:MTLSizeMake(1, 1, 1)];
  650. } break;
  651. case GGML_OP_UNARY:
  652. switch (ggml_get_unary_op(gf->nodes[i])) {
  653. case GGML_UNARY_OP_SILU:
  654. {
  655. [encoder setComputePipelineState:ctx->pipeline_silu];
  656. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  657. [encoder setBuffer:id_dst offset:offs_dst atIndex:1];
  658. const int64_t n = ggml_nelements(dst)/4;
  659. [encoder dispatchThreadgroups:MTLSizeMake(n, 1, 1) threadsPerThreadgroup:MTLSizeMake(1, 1, 1)];
  660. } break;
  661. case GGML_UNARY_OP_RELU:
  662. {
  663. [encoder setComputePipelineState:ctx->pipeline_relu];
  664. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  665. [encoder setBuffer:id_dst offset:offs_dst atIndex:1];
  666. const int64_t n = ggml_nelements(dst);
  667. [encoder dispatchThreadgroups:MTLSizeMake(n, 1, 1) threadsPerThreadgroup:MTLSizeMake(1, 1, 1)];
  668. } break;
  669. case GGML_UNARY_OP_GELU:
  670. {
  671. [encoder setComputePipelineState:ctx->pipeline_gelu];
  672. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  673. [encoder setBuffer:id_dst offset:offs_dst atIndex:1];
  674. const int64_t n = ggml_nelements(dst)/4;
  675. [encoder dispatchThreadgroups:MTLSizeMake(n, 1, 1) threadsPerThreadgroup:MTLSizeMake(1, 1, 1)];
  676. } break;
  677. default:
  678. {
  679. metal_printf("%s: node %3d, op = %8s not implemented\n", __func__, i, ggml_op_name(dst->op));
  680. GGML_ASSERT(false);
  681. }
  682. } break;
  683. case GGML_OP_SOFT_MAX:
  684. {
  685. const int nth = 32;
  686. if (ne00%4 == 0) {
  687. [encoder setComputePipelineState:ctx->pipeline_soft_max_4];
  688. } else {
  689. [encoder setComputePipelineState:ctx->pipeline_soft_max];
  690. }
  691. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  692. [encoder setBuffer:id_dst offset:offs_dst atIndex:1];
  693. [encoder setBytes:&ne00 length:sizeof(ne00) atIndex:2];
  694. [encoder setBytes:&ne01 length:sizeof(ne01) atIndex:3];
  695. [encoder setBytes:&ne02 length:sizeof(ne02) atIndex:4];
  696. [encoder dispatchThreadgroups:MTLSizeMake(ne01, ne02, ne03) threadsPerThreadgroup:MTLSizeMake(nth, 1, 1)];
  697. } break;
  698. case GGML_OP_DIAG_MASK_INF:
  699. {
  700. const int n_past = ((int32_t *)(dst->op_params))[0];
  701. if (ne00%8 == 0) {
  702. [encoder setComputePipelineState:ctx->pipeline_diag_mask_inf_8];
  703. } else {
  704. [encoder setComputePipelineState:ctx->pipeline_diag_mask_inf];
  705. }
  706. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  707. [encoder setBuffer:id_dst offset:offs_dst atIndex:1];
  708. [encoder setBytes:&ne00 length:sizeof(ne00) atIndex:2];
  709. [encoder setBytes:&ne01 length:sizeof(ne01) atIndex:3];
  710. [encoder setBytes:&n_past length:sizeof(int) atIndex:4];
  711. if (ne00%8 == 0) {
  712. [encoder dispatchThreadgroups:MTLSizeMake(ne00*ne01*ne02/8, 1, 1) threadsPerThreadgroup:MTLSizeMake(1, 1, 1)];
  713. }
  714. else {
  715. [encoder dispatchThreadgroups:MTLSizeMake(ne00, ne01, ne02) threadsPerThreadgroup:MTLSizeMake(1, 1, 1)];
  716. }
  717. } break;
  718. case GGML_OP_MUL_MAT:
  719. {
  720. // TODO: needs to be updated after PR: https://github.com/ggerganov/ggml/pull/224
  721. GGML_ASSERT(ne00 == ne10);
  722. // GGML_ASSERT(ne02 == ne12); // Should be checked on individual data types until broadcast is implemented everywhere
  723. uint gqa = ne12/ne02;
  724. GGML_ASSERT(ne03 == ne13);
  725. // for now the matrix-matrix multiplication kernel only works on A14+/M1+ SoCs
  726. // AMD GPU and older A-chips will reuse matrix-vector multiplication kernel
  727. if (ggml_is_contiguous(src0) &&
  728. ggml_is_contiguous(src1) &&
  729. src1t == GGML_TYPE_F32 &&
  730. [ctx->device supportsFamily:MTLGPUFamilyApple7] &&
  731. ne00%32 == 0 &&
  732. ne11 > 1) {
  733. switch (src0->type) {
  734. case GGML_TYPE_F16: [encoder setComputePipelineState:ctx->pipeline_mul_mm_f16_f32]; break;
  735. case GGML_TYPE_Q4_0: [encoder setComputePipelineState:ctx->pipeline_mul_mm_q4_0_f32]; break;
  736. case GGML_TYPE_Q4_1: [encoder setComputePipelineState:ctx->pipeline_mul_mm_q4_1_f32]; break;
  737. case GGML_TYPE_Q8_0: [encoder setComputePipelineState:ctx->pipeline_mul_mm_q8_0_f32]; break;
  738. case GGML_TYPE_Q2_K: [encoder setComputePipelineState:ctx->pipeline_mul_mm_q2_K_f32]; break;
  739. case GGML_TYPE_Q3_K: [encoder setComputePipelineState:ctx->pipeline_mul_mm_q3_K_f32]; break;
  740. case GGML_TYPE_Q4_K: [encoder setComputePipelineState:ctx->pipeline_mul_mm_q4_K_f32]; break;
  741. case GGML_TYPE_Q5_K: [encoder setComputePipelineState:ctx->pipeline_mul_mm_q5_K_f32]; break;
  742. case GGML_TYPE_Q6_K: [encoder setComputePipelineState:ctx->pipeline_mul_mm_q6_K_f32]; break;
  743. default: GGML_ASSERT(false && "MUL MAT-MAT not implemented");
  744. }
  745. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  746. [encoder setBuffer:id_src1 offset:offs_src1 atIndex:1];
  747. [encoder setBuffer:id_dst offset:offs_dst atIndex:2];
  748. [encoder setBytes:&ne00 length:sizeof(ne00) atIndex:3];
  749. [encoder setBytes:&ne02 length:sizeof(ne02) atIndex:4];
  750. [encoder setBytes:&nb01 length:sizeof(nb01) atIndex:5];
  751. [encoder setBytes:&nb02 length:sizeof(nb02) atIndex:6];
  752. [encoder setBytes:&ne12 length:sizeof(ne12) atIndex:7];
  753. [encoder setBytes:&ne0 length:sizeof(ne0) atIndex:8];
  754. [encoder setBytes:&ne1 length:sizeof(ne1) atIndex:9];
  755. [encoder setBytes:&gqa length:sizeof(gqa) atIndex:10];
  756. [encoder setThreadgroupMemoryLength:8192 atIndex:0];
  757. [encoder dispatchThreadgroups:MTLSizeMake( (ne11+31)/32, (ne01+63) / 64, ne12) threadsPerThreadgroup:MTLSizeMake(128, 1, 1)];
  758. } else {
  759. int nth0 = 32;
  760. int nth1 = 1;
  761. int nrows = 1;
  762. // use custom matrix x vector kernel
  763. switch (src0t) {
  764. case GGML_TYPE_F16:
  765. {
  766. nth0 = 32;
  767. nth1 = 1;
  768. if (ne11 * ne12 < 4) {
  769. [encoder setComputePipelineState:ctx->pipeline_mul_mat_f16_f32_1row];
  770. } else if (ne00 >= 128 && ne01 >= 8 && ne00%4 == 0) {
  771. [encoder setComputePipelineState:ctx->pipeline_mul_mat_f16_f32_l4];
  772. nrows = ne11;
  773. } else {
  774. [encoder setComputePipelineState:ctx->pipeline_mul_mat_f16_f32];
  775. nrows = 4;
  776. }
  777. } break;
  778. case GGML_TYPE_Q4_0:
  779. {
  780. GGML_ASSERT(ne02 == 1);
  781. GGML_ASSERT(ne12 == 1);
  782. nth0 = 8;
  783. nth1 = 8;
  784. [encoder setComputePipelineState:ctx->pipeline_mul_mat_q4_0_f32];
  785. } break;
  786. case GGML_TYPE_Q4_1:
  787. {
  788. GGML_ASSERT(ne02 == 1);
  789. GGML_ASSERT(ne12 == 1);
  790. nth0 = 8;
  791. nth1 = 8;
  792. [encoder setComputePipelineState:ctx->pipeline_mul_mat_q4_1_f32];
  793. } break;
  794. case GGML_TYPE_Q8_0:
  795. {
  796. GGML_ASSERT(ne02 == 1);
  797. GGML_ASSERT(ne12 == 1);
  798. nth0 = 8;
  799. nth1 = 8;
  800. [encoder setComputePipelineState:ctx->pipeline_mul_mat_q8_0_f32];
  801. } break;
  802. case GGML_TYPE_Q2_K:
  803. {
  804. GGML_ASSERT(ne02 == 1);
  805. GGML_ASSERT(ne12 == 1);
  806. nth0 = 2;
  807. nth1 = 32;
  808. [encoder setComputePipelineState:ctx->pipeline_mul_mat_q2_K_f32];
  809. } break;
  810. case GGML_TYPE_Q3_K:
  811. {
  812. GGML_ASSERT(ne02 == 1);
  813. GGML_ASSERT(ne12 == 1);
  814. nth0 = 2;
  815. nth1 = 32;
  816. [encoder setComputePipelineState:ctx->pipeline_mul_mat_q3_K_f32];
  817. } break;
  818. case GGML_TYPE_Q4_K:
  819. {
  820. GGML_ASSERT(ne02 == 1);
  821. GGML_ASSERT(ne12 == 1);
  822. nth0 = 4; //1;
  823. nth1 = 8; //32;
  824. [encoder setComputePipelineState:ctx->pipeline_mul_mat_q4_K_f32];
  825. } break;
  826. case GGML_TYPE_Q5_K:
  827. {
  828. GGML_ASSERT(ne02 == 1);
  829. GGML_ASSERT(ne12 == 1);
  830. nth0 = 2;
  831. nth1 = 32;
  832. [encoder setComputePipelineState:ctx->pipeline_mul_mat_q5_K_f32];
  833. } break;
  834. case GGML_TYPE_Q6_K:
  835. {
  836. GGML_ASSERT(ne02 == 1);
  837. GGML_ASSERT(ne12 == 1);
  838. nth0 = 2;
  839. nth1 = 32;
  840. [encoder setComputePipelineState:ctx->pipeline_mul_mat_q6_K_f32];
  841. } break;
  842. default:
  843. {
  844. metal_printf("Asserting on type %d\n",(int)src0t);
  845. GGML_ASSERT(false && "not implemented");
  846. }
  847. };
  848. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  849. [encoder setBuffer:id_src1 offset:offs_src1 atIndex:1];
  850. [encoder setBuffer:id_dst offset:offs_dst atIndex:2];
  851. [encoder setBytes:&ne00 length:sizeof(ne00) atIndex:3];
  852. [encoder setBytes:&ne01 length:sizeof(ne01) atIndex:4];
  853. [encoder setBytes:&ne02 length:sizeof(ne02) atIndex:5];
  854. [encoder setBytes:&nb00 length:sizeof(nb00) atIndex:6];
  855. [encoder setBytes:&nb01 length:sizeof(nb01) atIndex:7];
  856. [encoder setBytes:&nb02 length:sizeof(nb02) atIndex:8];
  857. [encoder setBytes:&ne10 length:sizeof(ne10) atIndex:9];
  858. [encoder setBytes:&ne11 length:sizeof(ne11) atIndex:10];
  859. [encoder setBytes:&ne12 length:sizeof(ne12) atIndex:11];
  860. [encoder setBytes:&nb10 length:sizeof(nb10) atIndex:12];
  861. [encoder setBytes:&nb11 length:sizeof(nb11) atIndex:13];
  862. [encoder setBytes:&nb12 length:sizeof(nb12) atIndex:14];
  863. [encoder setBytes:&ne0 length:sizeof(ne0) atIndex:15];
  864. [encoder setBytes:&ne1 length:sizeof(ne1) atIndex:16];
  865. [encoder setBytes:&gqa length:sizeof(gqa) atIndex:17];
  866. if (src0t == GGML_TYPE_Q4_0 || src0t == GGML_TYPE_Q4_1 || src0t == GGML_TYPE_Q8_0 ||
  867. src0t == GGML_TYPE_Q2_K) {// || src0t == GGML_TYPE_Q4_K) {
  868. [encoder dispatchThreadgroups:MTLSizeMake((ne01 + 7)/8, ne11, ne12) threadsPerThreadgroup:MTLSizeMake(nth0, nth1, 1)];
  869. }
  870. else if (src0t == GGML_TYPE_Q4_K) {
  871. [encoder dispatchThreadgroups:MTLSizeMake((ne01 + 3)/4, ne11, ne12) threadsPerThreadgroup:MTLSizeMake(nth0, nth1, 1)];
  872. }
  873. else if (src0t == GGML_TYPE_Q3_K) {
  874. #ifdef GGML_QKK_64
  875. [encoder dispatchThreadgroups:MTLSizeMake((ne01 + 1)/2, ne11, ne12) threadsPerThreadgroup:MTLSizeMake(nth0, nth1, 1)];
  876. #else
  877. [encoder dispatchThreadgroups:MTLSizeMake((ne01 + 3)/4, ne11, ne12) threadsPerThreadgroup:MTLSizeMake(nth0, nth1, 1)];
  878. #endif
  879. }
  880. else if (src0t == GGML_TYPE_Q5_K) {
  881. [encoder dispatchThreadgroups:MTLSizeMake((ne01 + 3)/4, ne11, ne12) threadsPerThreadgroup:MTLSizeMake(nth0, nth1, 1)];
  882. }
  883. else if (src0t == GGML_TYPE_Q6_K) {
  884. [encoder dispatchThreadgroups:MTLSizeMake((ne01 + 1)/2, ne11, ne12) threadsPerThreadgroup:MTLSizeMake(nth0, nth1, 1)];
  885. } else {
  886. int64_t ny = (ne11 + nrows - 1)/nrows;
  887. [encoder dispatchThreadgroups:MTLSizeMake(ne01, ny, ne12) threadsPerThreadgroup:MTLSizeMake(nth0, nth1, 1)];
  888. }
  889. }
  890. } break;
  891. case GGML_OP_GET_ROWS:
  892. {
  893. switch (src0->type) {
  894. case GGML_TYPE_F16: [encoder setComputePipelineState:ctx->pipeline_get_rows_f16]; break;
  895. case GGML_TYPE_Q4_0: [encoder setComputePipelineState:ctx->pipeline_get_rows_q4_0]; break;
  896. case GGML_TYPE_Q4_1: [encoder setComputePipelineState:ctx->pipeline_get_rows_q4_1]; break;
  897. case GGML_TYPE_Q8_0: [encoder setComputePipelineState:ctx->pipeline_get_rows_q8_0]; break;
  898. case GGML_TYPE_Q2_K: [encoder setComputePipelineState:ctx->pipeline_get_rows_q2_K]; break;
  899. case GGML_TYPE_Q3_K: [encoder setComputePipelineState:ctx->pipeline_get_rows_q3_K]; break;
  900. case GGML_TYPE_Q4_K: [encoder setComputePipelineState:ctx->pipeline_get_rows_q4_K]; break;
  901. case GGML_TYPE_Q5_K: [encoder setComputePipelineState:ctx->pipeline_get_rows_q5_K]; break;
  902. case GGML_TYPE_Q6_K: [encoder setComputePipelineState:ctx->pipeline_get_rows_q6_K]; break;
  903. default: GGML_ASSERT(false && "not implemented");
  904. }
  905. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  906. [encoder setBuffer:id_src1 offset:offs_src1 atIndex:1];
  907. [encoder setBuffer:id_dst offset:offs_dst atIndex:2];
  908. [encoder setBytes:&(src0->ne[0]) length:sizeof( int64_t) atIndex:3];
  909. [encoder setBytes:&(src0->nb[1]) length:sizeof(uint64_t) atIndex:4];
  910. [encoder setBytes:&(dst->nb[1]) length:sizeof(uint64_t) atIndex:5];
  911. const int64_t n = ggml_nelements(src1);
  912. [encoder dispatchThreadgroups:MTLSizeMake(n, 1, 1) threadsPerThreadgroup:MTLSizeMake(1, 1, 1)];
  913. } break;
  914. case GGML_OP_RMS_NORM:
  915. {
  916. float eps;
  917. memcpy(&eps, dst->op_params, sizeof(float));
  918. const int nth = 512;
  919. [encoder setComputePipelineState:ctx->pipeline_rms_norm];
  920. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  921. [encoder setBuffer:id_dst offset:offs_dst atIndex:1];
  922. [encoder setBytes:&ne00 length:sizeof( int64_t) atIndex:2];
  923. [encoder setBytes:&nb01 length:sizeof(uint64_t) atIndex:3];
  924. [encoder setBytes:&eps length:sizeof( float) atIndex:4];
  925. [encoder setThreadgroupMemoryLength:nth/32*sizeof(float) atIndex:0];
  926. const int64_t nrows = ggml_nrows(src0);
  927. [encoder dispatchThreadgroups:MTLSizeMake(nrows, 1, 1) threadsPerThreadgroup:MTLSizeMake(nth, 1, 1)];
  928. } break;
  929. case GGML_OP_NORM:
  930. {
  931. float eps;
  932. memcpy(&eps, dst->op_params, sizeof(float));
  933. const int nth = 256;
  934. [encoder setComputePipelineState:ctx->pipeline_norm];
  935. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  936. [encoder setBuffer:id_dst offset:offs_dst atIndex:1];
  937. [encoder setBytes:&ne00 length:sizeof( int64_t) atIndex:2];
  938. [encoder setBytes:&nb01 length:sizeof(uint64_t) atIndex:3];
  939. [encoder setBytes:&eps length:sizeof( float) atIndex:4];
  940. [encoder setThreadgroupMemoryLength:nth*sizeof(float) atIndex:0];
  941. const int64_t nrows = ggml_nrows(src0);
  942. [encoder dispatchThreadgroups:MTLSizeMake(nrows, 1, 1) threadsPerThreadgroup:MTLSizeMake(nth, 1, 1)];
  943. } break;
  944. case GGML_OP_ALIBI:
  945. {
  946. GGML_ASSERT((src0t == GGML_TYPE_F32));
  947. const int n_past = ((int32_t *) dst->op_params)[0]; UNUSED(n_past);
  948. const int n_head = ((int32_t *) dst->op_params)[1];
  949. float max_bias;
  950. memcpy(&max_bias, (int32_t *) dst->op_params + 2, sizeof(float));
  951. if (__builtin_popcount(n_head) != 1) {
  952. GGML_ASSERT(false && "only power-of-two n_head implemented");
  953. }
  954. const int n_heads_log2_floor = 1 << (int) floor(log2(n_head));
  955. const float m0 = powf(2.0f, -(max_bias) / n_heads_log2_floor);
  956. [encoder setComputePipelineState:ctx->pipeline_alibi_f32];
  957. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  958. [encoder setBuffer:id_dst offset:offs_dst atIndex:1];
  959. [encoder setBytes:&ne00 length:sizeof( int64_t) atIndex:2];
  960. [encoder setBytes:&ne01 length:sizeof( int64_t) atIndex:3];
  961. [encoder setBytes:&ne02 length:sizeof( int64_t) atIndex:4];
  962. [encoder setBytes:&ne03 length:sizeof( int64_t) atIndex:5];
  963. [encoder setBytes:&nb00 length:sizeof(uint64_t) atIndex:6];
  964. [encoder setBytes:&nb01 length:sizeof(uint64_t) atIndex:7];
  965. [encoder setBytes:&nb02 length:sizeof(uint64_t) atIndex:8];
  966. [encoder setBytes:&nb03 length:sizeof(uint64_t) atIndex:9];
  967. [encoder setBytes:&ne0 length:sizeof( int64_t) atIndex:10];
  968. [encoder setBytes:&ne1 length:sizeof( int64_t) atIndex:11];
  969. [encoder setBytes:&ne2 length:sizeof( int64_t) atIndex:12];
  970. [encoder setBytes:&ne3 length:sizeof( int64_t) atIndex:13];
  971. [encoder setBytes:&nb0 length:sizeof(uint64_t) atIndex:14];
  972. [encoder setBytes:&nb1 length:sizeof(uint64_t) atIndex:15];
  973. [encoder setBytes:&nb2 length:sizeof(uint64_t) atIndex:16];
  974. [encoder setBytes:&nb3 length:sizeof(uint64_t) atIndex:17];
  975. [encoder setBytes:&m0 length:sizeof( float) atIndex:18];
  976. const int nth = 32;
  977. [encoder dispatchThreadgroups:MTLSizeMake(ne01, ne02, ne03) threadsPerThreadgroup:MTLSizeMake(nth, 1, 1)];
  978. } break;
  979. case GGML_OP_ROPE:
  980. {
  981. const int n_past = ((int32_t *) dst->op_params)[0];
  982. const int n_dims = ((int32_t *) dst->op_params)[1];
  983. const int mode = ((int32_t *) dst->op_params)[2];
  984. float freq_base;
  985. float freq_scale;
  986. memcpy(&freq_base, (int32_t *) dst->op_params + 4, sizeof(float));
  987. memcpy(&freq_scale, (int32_t *) dst->op_params + 5, sizeof(float));
  988. [encoder setComputePipelineState:ctx->pipeline_rope];
  989. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  990. [encoder setBuffer:id_dst offset:offs_dst atIndex:1];
  991. [encoder setBytes:&ne00 length:sizeof( int64_t) atIndex:2];
  992. [encoder setBytes:&ne01 length:sizeof( int64_t) atIndex:3];
  993. [encoder setBytes:&ne02 length:sizeof( int64_t) atIndex:4];
  994. [encoder setBytes:&ne03 length:sizeof( int64_t) atIndex:5];
  995. [encoder setBytes:&nb00 length:sizeof(uint64_t) atIndex:6];
  996. [encoder setBytes:&nb01 length:sizeof(uint64_t) atIndex:7];
  997. [encoder setBytes:&nb02 length:sizeof(uint64_t) atIndex:8];
  998. [encoder setBytes:&nb03 length:sizeof(uint64_t) atIndex:9];
  999. [encoder setBytes:&ne0 length:sizeof( int64_t) atIndex:10];
  1000. [encoder setBytes:&ne1 length:sizeof( int64_t) atIndex:11];
  1001. [encoder setBytes:&ne2 length:sizeof( int64_t) atIndex:12];
  1002. [encoder setBytes:&ne3 length:sizeof( int64_t) atIndex:13];
  1003. [encoder setBytes:&nb0 length:sizeof(uint64_t) atIndex:14];
  1004. [encoder setBytes:&nb1 length:sizeof(uint64_t) atIndex:15];
  1005. [encoder setBytes:&nb2 length:sizeof(uint64_t) atIndex:16];
  1006. [encoder setBytes:&nb3 length:sizeof(uint64_t) atIndex:17];
  1007. [encoder setBytes:&n_past length:sizeof( int) atIndex:18];
  1008. [encoder setBytes:&n_dims length:sizeof( int) atIndex:19];
  1009. [encoder setBytes:&mode length:sizeof( int) atIndex:20];
  1010. [encoder setBytes:&freq_base length:sizeof(float) atIndex:21];
  1011. [encoder setBytes:&freq_scale length:sizeof(float) atIndex:22];
  1012. [encoder dispatchThreadgroups:MTLSizeMake(ne01, ne02, ne03) threadsPerThreadgroup:MTLSizeMake(32, 1, 1)];
  1013. } break;
  1014. case GGML_OP_DUP:
  1015. case GGML_OP_CPY:
  1016. case GGML_OP_CONT:
  1017. {
  1018. const int nth = 32;
  1019. switch (src0t) {
  1020. case GGML_TYPE_F32:
  1021. {
  1022. switch (dstt) {
  1023. case GGML_TYPE_F16: [encoder setComputePipelineState:ctx->pipeline_cpy_f32_f16]; break;
  1024. case GGML_TYPE_F32: [encoder setComputePipelineState:ctx->pipeline_cpy_f32_f32]; break;
  1025. default: GGML_ASSERT(false && "not implemented");
  1026. };
  1027. } break;
  1028. case GGML_TYPE_F16:
  1029. {
  1030. switch (dstt) {
  1031. case GGML_TYPE_F16: [encoder setComputePipelineState:ctx->pipeline_cpy_f16_f16]; break;
  1032. case GGML_TYPE_F32: GGML_ASSERT(false && "cpy_f16_f32 not implemented"); break;
  1033. default: GGML_ASSERT(false && "not implemented");
  1034. };
  1035. } break;
  1036. default: GGML_ASSERT(false && "not implemented");
  1037. }
  1038. [encoder setBuffer:id_src0 offset:offs_src0 atIndex:0];
  1039. [encoder setBuffer:id_dst offset:offs_dst atIndex:1];
  1040. [encoder setBytes:&ne00 length:sizeof( int64_t) atIndex:2];
  1041. [encoder setBytes:&ne01 length:sizeof( int64_t) atIndex:3];
  1042. [encoder setBytes:&ne02 length:sizeof( int64_t) atIndex:4];
  1043. [encoder setBytes:&ne03 length:sizeof( int64_t) atIndex:5];
  1044. [encoder setBytes:&nb00 length:sizeof(uint64_t) atIndex:6];
  1045. [encoder setBytes:&nb01 length:sizeof(uint64_t) atIndex:7];
  1046. [encoder setBytes:&nb02 length:sizeof(uint64_t) atIndex:8];
  1047. [encoder setBytes:&nb03 length:sizeof(uint64_t) atIndex:9];
  1048. [encoder setBytes:&ne0 length:sizeof( int64_t) atIndex:10];
  1049. [encoder setBytes:&ne1 length:sizeof( int64_t) atIndex:11];
  1050. [encoder setBytes:&ne2 length:sizeof( int64_t) atIndex:12];
  1051. [encoder setBytes:&ne3 length:sizeof( int64_t) atIndex:13];
  1052. [encoder setBytes:&nb0 length:sizeof(uint64_t) atIndex:14];
  1053. [encoder setBytes:&nb1 length:sizeof(uint64_t) atIndex:15];
  1054. [encoder setBytes:&nb2 length:sizeof(uint64_t) atIndex:16];
  1055. [encoder setBytes:&nb3 length:sizeof(uint64_t) atIndex:17];
  1056. [encoder dispatchThreadgroups:MTLSizeMake(ne01, ne02, ne03) threadsPerThreadgroup:MTLSizeMake(nth, 1, 1)];
  1057. } break;
  1058. default:
  1059. {
  1060. metal_printf("%s: node %3d, op = %8s not implemented\n", __func__, i, ggml_op_name(dst->op));
  1061. GGML_ASSERT(false);
  1062. }
  1063. }
  1064. }
  1065. if (encoder != nil) {
  1066. [encoder endEncoding];
  1067. encoder = nil;
  1068. }
  1069. [command_buffer commit];
  1070. });
  1071. }
  1072. // wait for all threads to finish
  1073. dispatch_barrier_sync(ctx->d_queue, ^{});
  1074. // check status of command buffers
  1075. // needed to detect if the device ran out-of-memory for example (#1881)
  1076. for (int i = 0; i < n_cb; i++) {
  1077. [ctx->command_buffers[i] waitUntilCompleted];
  1078. MTLCommandBufferStatus status = (MTLCommandBufferStatus) [ctx->command_buffers[i] status];
  1079. if (status != MTLCommandBufferStatusCompleted) {
  1080. metal_printf("%s: command buffer %d failed with status %lu\n", __func__, i, status);
  1081. GGML_ASSERT(false);
  1082. }
  1083. }
  1084. }
  1085. }