llama-model-loader.cpp 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166
  1. #include "llama-model-loader.h"
  2. #include "ggml.h"
  3. #include <array>
  4. #include <cinttypes>
  5. #include <cstring>
  6. #include <future>
  7. static const size_t kiB = 1024;
  8. static const size_t MiB = 1024*kiB;
  9. static const size_t GiB = 1024*MiB;
  10. const char * llama_file_version_name(llama_fver version) {
  11. switch (version) {
  12. case GGUF_FILE_VERSION_V1: return "GGUF V1 (support until nov 2023)";
  13. case GGUF_FILE_VERSION_V2: return "GGUF V2";
  14. case GGUF_FILE_VERSION_V3: return "GGUF V3 (latest)";
  15. }
  16. return "unknown";
  17. }
  18. static std::string llama_model_ftype_name(llama_ftype ftype) {
  19. if (ftype & LLAMA_FTYPE_GUESSED) {
  20. return llama_model_ftype_name((enum llama_ftype) (ftype & ~LLAMA_FTYPE_GUESSED)) + " (guessed)";
  21. }
  22. switch (ftype) {
  23. case LLAMA_FTYPE_ALL_F32: return "all F32";
  24. case LLAMA_FTYPE_MOSTLY_F16: return "F16";
  25. case LLAMA_FTYPE_MOSTLY_BF16: return "BF16";
  26. case LLAMA_FTYPE_MOSTLY_Q4_0: return "Q4_0";
  27. case LLAMA_FTYPE_MOSTLY_Q4_1: return "Q4_1";
  28. case LLAMA_FTYPE_MOSTLY_Q5_0: return "Q5_0";
  29. case LLAMA_FTYPE_MOSTLY_Q5_1: return "Q5_1";
  30. case LLAMA_FTYPE_MOSTLY_Q8_0: return "Q8_0";
  31. case LLAMA_FTYPE_MOSTLY_MXFP4_MOE: return "MXFP4 MoE";
  32. case LLAMA_FTYPE_MOSTLY_Q2_K: return "Q2_K - Medium";
  33. case LLAMA_FTYPE_MOSTLY_Q2_K_S: return "Q2_K - Small";
  34. case LLAMA_FTYPE_MOSTLY_Q3_K_S: return "Q3_K - Small";
  35. case LLAMA_FTYPE_MOSTLY_Q3_K_M: return "Q3_K - Medium";
  36. case LLAMA_FTYPE_MOSTLY_Q3_K_L: return "Q3_K - Large";
  37. case LLAMA_FTYPE_MOSTLY_Q4_K_S: return "Q4_K - Small";
  38. case LLAMA_FTYPE_MOSTLY_Q4_K_M: return "Q4_K - Medium";
  39. case LLAMA_FTYPE_MOSTLY_Q5_K_S: return "Q5_K - Small";
  40. case LLAMA_FTYPE_MOSTLY_Q5_K_M: return "Q5_K - Medium";
  41. case LLAMA_FTYPE_MOSTLY_Q6_K: return "Q6_K";
  42. case LLAMA_FTYPE_MOSTLY_TQ1_0: return "TQ1_0 - 1.69 bpw ternary";
  43. case LLAMA_FTYPE_MOSTLY_TQ2_0: return "TQ2_0 - 2.06 bpw ternary";
  44. case LLAMA_FTYPE_MOSTLY_IQ2_XXS: return "IQ2_XXS - 2.0625 bpw";
  45. case LLAMA_FTYPE_MOSTLY_IQ2_XS: return "IQ2_XS - 2.3125 bpw";
  46. case LLAMA_FTYPE_MOSTLY_IQ2_S: return "IQ2_S - 2.5 bpw";
  47. case LLAMA_FTYPE_MOSTLY_IQ2_M: return "IQ2_M - 2.7 bpw";
  48. case LLAMA_FTYPE_MOSTLY_IQ3_XS: return "IQ3_XS - 3.3 bpw";
  49. case LLAMA_FTYPE_MOSTLY_IQ3_XXS: return "IQ3_XXS - 3.0625 bpw";
  50. case LLAMA_FTYPE_MOSTLY_IQ1_S: return "IQ1_S - 1.5625 bpw";
  51. case LLAMA_FTYPE_MOSTLY_IQ1_M: return "IQ1_M - 1.75 bpw";
  52. case LLAMA_FTYPE_MOSTLY_IQ4_NL: return "IQ4_NL - 4.5 bpw";
  53. case LLAMA_FTYPE_MOSTLY_IQ4_XS: return "IQ4_XS - 4.25 bpw";
  54. case LLAMA_FTYPE_MOSTLY_IQ3_S: return "IQ3_S - 3.4375 bpw";
  55. case LLAMA_FTYPE_MOSTLY_IQ3_M: return "IQ3_S mix - 3.66 bpw";
  56. default: return "unknown, may not work";
  57. }
  58. }
  59. // return a list of splits for a given path
  60. // for example, given "<name>-00002-of-00004.gguf", returns list of all 4 splits
  61. static std::vector<std::string> llama_get_list_splits(const std::string & path, const int idx, const int n_split) {
  62. std::vector<std::string> paths;
  63. std::string split_prefix;
  64. std::vector<char> buf(llama_path_max(), 0);
  65. {
  66. int ret = llama_split_prefix(buf.data(), buf.size(), path.c_str(), idx, n_split);
  67. if (!ret) {
  68. throw std::runtime_error(format("invalid split file name: %s", path.c_str()));
  69. }
  70. split_prefix = std::string(buf.data(), ret);
  71. }
  72. if (split_prefix.empty()) {
  73. throw std::runtime_error(format("invalid split file: %s", path.c_str()));
  74. }
  75. for (int idx = 0; idx < n_split; ++idx) {
  76. int ret = llama_split_path(buf.data(), buf.size(), split_prefix.c_str(), idx, n_split);
  77. paths.push_back(std::string(buf.data(), ret));
  78. }
  79. return paths;
  80. }
  81. namespace GGUFMeta {
  82. template <typename T, gguf_type gt_, T (*gfun)(const gguf_context *, const int64_t)>
  83. struct GKV_Base_Type {
  84. static constexpr gguf_type gt = gt_;
  85. static T getter(const gguf_context * ctx, const int kid) {
  86. return gfun(ctx, kid);
  87. }
  88. };
  89. template<typename T> struct GKV_Base;
  90. template<> struct GKV_Base<bool >: GKV_Base_Type<bool, GGUF_TYPE_BOOL, gguf_get_val_bool> {};
  91. template<> struct GKV_Base<uint8_t >: GKV_Base_Type<uint8_t, GGUF_TYPE_UINT8, gguf_get_val_u8 > {};
  92. template<> struct GKV_Base<uint16_t >: GKV_Base_Type<uint16_t, GGUF_TYPE_UINT16, gguf_get_val_u16 > {};
  93. template<> struct GKV_Base<uint32_t >: GKV_Base_Type<uint32_t, GGUF_TYPE_UINT32, gguf_get_val_u32 > {};
  94. template<> struct GKV_Base<uint64_t >: GKV_Base_Type<uint64_t, GGUF_TYPE_UINT64, gguf_get_val_u64 > {};
  95. template<> struct GKV_Base<int8_t >: GKV_Base_Type<int8_t, GGUF_TYPE_INT8, gguf_get_val_i8 > {};
  96. template<> struct GKV_Base<int16_t >: GKV_Base_Type<int16_t, GGUF_TYPE_INT16, gguf_get_val_i16 > {};
  97. template<> struct GKV_Base<int32_t >: GKV_Base_Type<int32_t, GGUF_TYPE_INT32, gguf_get_val_i32 > {};
  98. template<> struct GKV_Base<int64_t >: GKV_Base_Type<int64_t, GGUF_TYPE_INT64, gguf_get_val_i64 > {};
  99. template<> struct GKV_Base<float >: GKV_Base_Type<float, GGUF_TYPE_FLOAT32, gguf_get_val_f32 > {};
  100. template<> struct GKV_Base<double >: GKV_Base_Type<double, GGUF_TYPE_FLOAT64, gguf_get_val_f64 > {};
  101. template<> struct GKV_Base<const char *>: GKV_Base_Type<const char *, GGUF_TYPE_STRING, gguf_get_val_str > {};
  102. template<> struct GKV_Base<std::string> {
  103. static constexpr gguf_type gt = GGUF_TYPE_STRING;
  104. static std::string getter(const gguf_context * ctx, const int kid) {
  105. return gguf_get_val_str(ctx, kid);
  106. }
  107. };
  108. struct ArrayInfo {
  109. const gguf_type gt;
  110. const size_t length;
  111. const void * data;
  112. };
  113. template<> struct GKV_Base<ArrayInfo> {
  114. public:
  115. static constexpr gguf_type gt = GGUF_TYPE_ARRAY;
  116. static ArrayInfo getter(const gguf_context *ctx, const int k) {
  117. const enum gguf_type arr_type = gguf_get_arr_type(ctx, k);
  118. return ArrayInfo {
  119. arr_type,
  120. size_t(gguf_get_arr_n(ctx, k)),
  121. arr_type == GGUF_TYPE_STRING ? nullptr : gguf_get_arr_data(ctx, k),
  122. };
  123. }
  124. };
  125. template<typename T>
  126. class GKV : public GKV_Base<T> {
  127. GKV() = delete;
  128. public:
  129. static T get_kv(const gguf_context * ctx, const int k) {
  130. const enum gguf_type kt = gguf_get_kv_type(ctx, k);
  131. if (kt != GKV::gt) {
  132. throw std::runtime_error(format("key %s has wrong type %s but expected type %s",
  133. gguf_get_key(ctx, k), gguf_type_name(kt), gguf_type_name(GKV::gt)));
  134. }
  135. return GKV::getter(ctx, k);
  136. }
  137. static const char * override_type_to_str(const llama_model_kv_override_type ty) {
  138. switch (ty) {
  139. case LLAMA_KV_OVERRIDE_TYPE_BOOL: return "bool";
  140. case LLAMA_KV_OVERRIDE_TYPE_INT: return "int";
  141. case LLAMA_KV_OVERRIDE_TYPE_FLOAT: return "float";
  142. case LLAMA_KV_OVERRIDE_TYPE_STR: return "str";
  143. }
  144. return "unknown";
  145. }
  146. static bool validate_override(const llama_model_kv_override_type expected_type, const struct llama_model_kv_override * ovrd) {
  147. if (!ovrd) { return false; }
  148. if (ovrd->tag == expected_type) {
  149. LLAMA_LOG_INFO("%s: Using metadata override (%5s) '%s' = ",
  150. __func__, override_type_to_str(ovrd->tag), ovrd->key);
  151. switch (ovrd->tag) {
  152. case LLAMA_KV_OVERRIDE_TYPE_BOOL: {
  153. LLAMA_LOG_INFO("%s\n", ovrd->val_bool ? "true" : "false");
  154. } break;
  155. case LLAMA_KV_OVERRIDE_TYPE_INT: {
  156. LLAMA_LOG_INFO("%" PRId64 "\n", ovrd->val_i64);
  157. } break;
  158. case LLAMA_KV_OVERRIDE_TYPE_FLOAT: {
  159. LLAMA_LOG_INFO("%.6f\n", ovrd->val_f64);
  160. } break;
  161. case LLAMA_KV_OVERRIDE_TYPE_STR: {
  162. LLAMA_LOG_INFO("%s\n", ovrd->val_str);
  163. } break;
  164. default:
  165. // Shouldn't be possible to end up here, but just in case...
  166. throw std::runtime_error(
  167. format("Unsupported attempt to override %s type for metadata key %s\n",
  168. override_type_to_str(ovrd->tag), ovrd->key));
  169. }
  170. return true;
  171. }
  172. LLAMA_LOG_WARN("%s: Warning: Bad metadata override type for key '%s', expected %s but got %s\n",
  173. __func__, ovrd->key, override_type_to_str(expected_type), override_type_to_str(ovrd->tag));
  174. return false;
  175. }
  176. template<typename OT>
  177. static typename std::enable_if<std::is_same<OT, bool>::value, bool>::type
  178. try_override(OT & target, const struct llama_model_kv_override * ovrd) {
  179. if (validate_override(LLAMA_KV_OVERRIDE_TYPE_BOOL, ovrd)) {
  180. target = ovrd->val_bool;
  181. return true;
  182. }
  183. return false;
  184. }
  185. template<typename OT>
  186. static typename std::enable_if<!std::is_same<OT, bool>::value && std::is_integral<OT>::value, bool>::type
  187. try_override(OT & target, const struct llama_model_kv_override * ovrd) {
  188. if (validate_override(LLAMA_KV_OVERRIDE_TYPE_INT, ovrd)) {
  189. target = ovrd->val_i64;
  190. return true;
  191. }
  192. return false;
  193. }
  194. template<typename OT>
  195. static typename std::enable_if<std::is_floating_point<OT>::value, bool>::type
  196. try_override(T & target, const struct llama_model_kv_override * ovrd) {
  197. if (validate_override(LLAMA_KV_OVERRIDE_TYPE_FLOAT, ovrd)) {
  198. target = ovrd->val_f64;
  199. return true;
  200. }
  201. return false;
  202. }
  203. template<typename OT>
  204. static typename std::enable_if<std::is_same<OT, std::string>::value, bool>::type
  205. try_override(T & target, const struct llama_model_kv_override * ovrd) {
  206. if (validate_override(LLAMA_KV_OVERRIDE_TYPE_STR, ovrd)) {
  207. target = ovrd->val_str;
  208. return true;
  209. }
  210. return false;
  211. }
  212. static bool set(const gguf_context * ctx, const int k, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
  213. if (try_override<T>(target, ovrd)) {
  214. return true;
  215. }
  216. if (k < 0) { return false; }
  217. target = get_kv(ctx, k);
  218. return true;
  219. }
  220. static bool set(const gguf_context * ctx, const char * key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
  221. return set(ctx, gguf_find_key(ctx, key), target, ovrd);
  222. }
  223. static bool set(const gguf_context * ctx, const std::string & key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
  224. return set(ctx, key.c_str(), target, ovrd);
  225. }
  226. };
  227. }
  228. template<typename T>
  229. typename std::enable_if<std::is_integral<T>::value, bool>::type
  230. llama_model_loader::get_arr_n(const std::string & key, T & result, bool required) {
  231. const int kid = gguf_find_key(meta.get(), key.c_str());
  232. if (kid < 0) {
  233. if (required) {
  234. throw std::runtime_error(format("key not found in model: %s", key.c_str()));
  235. }
  236. return false;
  237. }
  238. struct GGUFMeta::ArrayInfo arr_info =
  239. GGUFMeta::GKV<GGUFMeta::ArrayInfo>::get_kv(meta.get(), kid);
  240. result = arr_info.length;
  241. return true;
  242. }
  243. template<typename T>
  244. typename std::enable_if<std::is_integral<T>::value, bool>::type
  245. llama_model_loader::get_arr_n(enum llm_kv kid, T & result, bool required) {
  246. return get_arr_n(llm_kv(kid), result, required);
  247. }
  248. template bool llama_model_loader::get_arr_n(enum llm_kv kid, uint32_t & result, bool required);
  249. template<typename T>
  250. bool llama_model_loader::get_arr(const std::string & key, std::vector<T> & result, bool required) {
  251. const gguf_context * ctx = meta.get();
  252. const int kid = gguf_find_key(ctx, key.c_str());
  253. if (kid < 0 || gguf_get_kv_type(ctx, kid) != GGUF_TYPE_ARRAY) {
  254. if (required) {
  255. throw std::runtime_error(format("array key not found in model: %s", key.c_str()));
  256. }
  257. return false;
  258. }
  259. struct GGUFMeta::ArrayInfo arr_info =
  260. GGUFMeta::GKV<GGUFMeta::ArrayInfo>::get_kv(ctx, kid);
  261. switch (arr_info.gt) {
  262. case GGUF_TYPE_UINT32:
  263. case GGUF_TYPE_INT32: GGML_ASSERT((std::is_same<T, int32_t>::value) ||
  264. (std::is_same<T, uint32_t>::value)); break;
  265. case GGUF_TYPE_FLOAT32: GGML_ASSERT((std::is_same<T, float>::value)); break;
  266. case GGUF_TYPE_STRING: GGML_ASSERT((std::is_same<T, std::string>::value)); break;
  267. default:
  268. throw std::runtime_error(format("%s is not a string/float32/uint32/int32 array", key.c_str()));
  269. }
  270. if constexpr (std::is_same<T, std::string>::value) {
  271. const size_t n_items = gguf_get_arr_n(ctx, kid);
  272. result.clear();
  273. for (size_t i = 0; i < n_items; i++) {
  274. const T value = gguf_get_arr_str(ctx, kid, i);
  275. result.emplace_back(value);
  276. }
  277. } else {
  278. result.resize(arr_info.length);
  279. result.assign((const T*)arr_info.data, (const T *)arr_info.data + arr_info.length);
  280. }
  281. return true;
  282. }
  283. template<typename T, size_t N_MAX>
  284. bool llama_model_loader::get_arr(const std::string & key, std::array<T, N_MAX> & result, bool required) {
  285. const gguf_context * ctx = meta.get();
  286. const int kid = gguf_find_key(ctx, key.c_str());
  287. if (kid < 0 || gguf_get_kv_type(ctx, kid) != GGUF_TYPE_ARRAY) {
  288. if (required) {
  289. throw std::runtime_error(format("array key not found in model: %s", key.c_str()));
  290. }
  291. return false;
  292. }
  293. struct GGUFMeta::ArrayInfo arr_info =
  294. GGUFMeta::GKV<GGUFMeta::ArrayInfo>::get_kv(ctx, kid);
  295. switch (arr_info.gt) {
  296. case GGUF_TYPE_UINT32:
  297. case GGUF_TYPE_INT32: GGML_ASSERT((std::is_same<T, int32_t>::value) ||
  298. (std::is_same<T, uint32_t>::value)); break;
  299. case GGUF_TYPE_FLOAT32: GGML_ASSERT((std::is_same<T, float>::value)); break;
  300. case GGUF_TYPE_STRING: GGML_ASSERT((std::is_same<T, std::string>::value)); break;
  301. default:
  302. throw std::runtime_error(format("%s is not a string/float32/uint32/int32 array", key.c_str()));
  303. }
  304. if (arr_info.length > N_MAX) {
  305. throw std::runtime_error(format("array length %u for key %s exceeds max %u", (uint32_t) arr_info.length, key.c_str(), (uint32_t) N_MAX));
  306. }
  307. if constexpr (std::is_same<T, std::string>::value) {
  308. const size_t n_items = gguf_get_arr_n(ctx, kid);
  309. for (size_t i = 0; i < n_items; i++) {
  310. const T value = gguf_get_arr_str(ctx, kid, i);
  311. result[i] = value;
  312. }
  313. } else {
  314. std::copy((const T*)arr_info.data, (const T *)arr_info.data + arr_info.length, result.begin());
  315. }
  316. return true;
  317. }
  318. template<typename T>
  319. bool llama_model_loader::get_arr(enum llm_kv kid, T & result, bool required) {
  320. return get_arr(llm_kv(kid), result, required);
  321. }
  322. template bool llama_model_loader::get_arr<std::vector<std::string>>(enum llm_kv kid, std::vector<std::string> & result, bool required);
  323. template<typename T>
  324. bool llama_model_loader::get_key(const std::string & key, T & result, bool required) {
  325. auto it = kv_overrides.find(key);
  326. const struct llama_model_kv_override * override =
  327. it != kv_overrides.end() ? &it->second : nullptr;
  328. const bool found = GGUFMeta::GKV<T>::set(meta.get(), key, result, override);
  329. if (required && !found) {
  330. throw std::runtime_error(format("key not found in model: %s", key.c_str()));
  331. }
  332. return found;
  333. }
  334. template<typename T>
  335. bool llama_model_loader::get_key(enum llm_kv kid, T & result, bool required) {
  336. return get_key(llm_kv(kid), result, required);
  337. }
  338. template bool llama_model_loader::get_key<bool> (enum llm_kv kid, bool & result, bool required);
  339. template bool llama_model_loader::get_key<float> (enum llm_kv kid, float & result, bool required);
  340. template bool llama_model_loader::get_key<uint32_t> (enum llm_kv kid, uint32_t & result, bool required);
  341. template bool llama_model_loader::get_key<std::string>(enum llm_kv kid, std::string & result, bool required);
  342. template<>
  343. bool llama_model_loader::get_key(enum llm_kv kid, enum llama_pooling_type & result, bool required) {
  344. uint32_t tmp;
  345. const bool found = get_key(kid, tmp, required);
  346. if (found) {
  347. result = (enum llama_pooling_type) tmp;
  348. } else {
  349. result = LLAMA_POOLING_TYPE_UNSPECIFIED;
  350. }
  351. return found;
  352. }
  353. // get array of n <= N_MAX elements, or a single element repeated n times
  354. template<typename T, size_t N_MAX>
  355. bool llama_model_loader::get_key_or_arr(const std::string & key, std::array<T, N_MAX> & result, uint32_t n, bool required) {
  356. const int kid = gguf_find_key(meta.get(), key.c_str());
  357. if (kid < 0) {
  358. if (required) {
  359. throw std::runtime_error(format("key not found in model: %s", key.c_str()));
  360. }
  361. return false;
  362. }
  363. if (n > N_MAX) {
  364. throw std::runtime_error(format("n > N_MAX: %u > %u for key %s", (uint32_t) n, (uint32_t) N_MAX, key.c_str()));
  365. }
  366. if (gguf_get_kv_type(meta.get(), kid) == GGUF_TYPE_ARRAY) {
  367. struct GGUFMeta::ArrayInfo arr_info =
  368. GGUFMeta::GKV<GGUFMeta::ArrayInfo>::get_kv(meta.get(), kid);
  369. if (n != arr_info.length) {
  370. throw std::runtime_error(format("key %s has wrong array length; expected %u, got %u", key.c_str(), n, (uint32_t) arr_info.length));
  371. }
  372. return get_arr(key, result, required);
  373. }
  374. T value;
  375. bool ok = get_key(key, value, required);
  376. if (!ok) {
  377. return false;
  378. }
  379. for (uint32_t i = 0; i < n; i++) {
  380. result[i] = value;
  381. }
  382. return true;
  383. }
  384. template<typename T>
  385. bool llama_model_loader::get_key_or_arr(enum llm_kv kid, T & result, uint32_t n, bool required) {
  386. return get_key_or_arr(llm_kv(kid), result, n, required);
  387. }
  388. // TODO: this is not very clever - figure out something better
  389. template bool llama_model_loader::get_key_or_arr<std::array<int, 4>>(enum llm_kv kid, std::array<int, 4> & result, uint32_t n, bool required);
  390. template bool llama_model_loader::get_key_or_arr<std::array<uint32_t, 512>>(enum llm_kv kid, std::array<uint32_t, 512> & result, uint32_t n, bool required);
  391. llama_model_loader::llama_model_loader(
  392. const std::string & fname,
  393. std::vector<std::string> & splits,
  394. bool use_mmap,
  395. bool check_tensors,
  396. const llama_model_kv_override * param_overrides_p,
  397. const llama_model_tensor_buft_override * param_tensor_buft_overrides_p) {
  398. int trace = 0;
  399. if (getenv("LLAMA_TRACE")) {
  400. trace = atoi(getenv("LLAMA_TRACE"));
  401. }
  402. if (param_overrides_p != nullptr) {
  403. for (const struct llama_model_kv_override * p = param_overrides_p; p->key[0] != 0; p++) {
  404. kv_overrides.insert({std::string(p->key), *p});
  405. }
  406. }
  407. tensor_buft_overrides = param_tensor_buft_overrides_p;
  408. // Load the main GGUF
  409. struct ggml_context * ctx = NULL;
  410. struct gguf_init_params params = {
  411. /*.no_alloc = */ true,
  412. /*.ctx = */ &ctx,
  413. };
  414. meta.reset(gguf_init_from_file(fname.c_str(), params));
  415. if (!meta) {
  416. throw std::runtime_error(format("%s: failed to load model from %s", __func__, fname.c_str()));
  417. }
  418. get_key(llm_kv(LLM_KV_GENERAL_ARCHITECTURE), arch_name, false);
  419. llm_kv = LLM_KV(llm_arch_from_string(arch_name));
  420. files.emplace_back(new llama_file(fname.c_str(), "rb"));
  421. contexts.emplace_back(ctx);
  422. // Save tensors data offset of the main file.
  423. // For subsidiary files, `meta` tensor data offset must not be used,
  424. // so we build a unified tensors index for weights.
  425. for (ggml_tensor * cur = ggml_get_first_tensor(ctx); cur; cur = ggml_get_next_tensor(ctx, cur)) {
  426. std::string tensor_name = std::string(cur->name);
  427. // make sure there is no duplicated tensor names
  428. if (weights_map.find(tensor_name) != weights_map.end()) {
  429. throw std::runtime_error(format("invalid model: tensor '%s' is duplicated", ggml_get_name(cur)));
  430. }
  431. n_elements += ggml_nelements(cur);
  432. n_bytes += ggml_nbytes(cur);
  433. weights_map.emplace(tensor_name, llama_tensor_weight(files.back().get(), 0, meta.get(), cur));
  434. }
  435. uint16_t n_split = 0;
  436. get_key(llm_kv(LLM_KV_SPLIT_COUNT), n_split, false);
  437. // Load additional GGML contexts
  438. if (n_split > 1) {
  439. // make sure the main file is loaded first
  440. uint16_t idx = 0;
  441. const std::string kv_split_no = llm_kv(LLM_KV_SPLIT_NO);
  442. get_key(kv_split_no, idx);
  443. if (idx != 0) {
  444. throw std::runtime_error(format("illegal split file idx: %d (file: %s), model must be loaded with the first split", idx, fname.c_str()));
  445. }
  446. // generate list of splits if needed
  447. if (splits.empty()) {
  448. splits = llama_get_list_splits(fname, idx, n_split);
  449. }
  450. // in case user give a custom list of splits, check if it matches the expected number
  451. if (n_split != (uint16_t)splits.size()) {
  452. throw std::runtime_error(format("invalid split count, given: %zu splits, but expected %d", splits.size(), n_split));
  453. }
  454. if (trace > 0) {
  455. LLAMA_LOG_INFO("%s: loading additional %d GGUFs\n", __func__, n_split);
  456. }
  457. // load other splits
  458. for (idx = 1; idx < n_split; idx++) {
  459. const char * fname_split = splits[idx].c_str();
  460. struct gguf_init_params split_params = {
  461. /*.no_alloc = */ true,
  462. /*.ctx = */ &ctx,
  463. };
  464. gguf_context_ptr ctx_gguf { gguf_init_from_file(fname_split, split_params) };
  465. if (!ctx_gguf) {
  466. throw std::runtime_error(format("%s: failed to load GGUF split from %s", __func__, fname_split));
  467. }
  468. // check idx
  469. {
  470. const int kid = gguf_find_key(ctx_gguf.get(), kv_split_no.c_str());
  471. if (kid < 0) {
  472. throw std::runtime_error(format("missing key %s in GGUF split %s", kv_split_no.c_str(), fname_split));
  473. }
  474. int idx_gguf = gguf_get_val_u16(ctx_gguf.get(), kid);
  475. if (idx_gguf != idx) {
  476. throw std::runtime_error(format("invalid split file idx: %d (file: %s), expected %d", idx_gguf, fname_split, idx));
  477. }
  478. }
  479. files.emplace_back(new llama_file(fname_split, "rb"));
  480. contexts.emplace_back(ctx);
  481. // Save tensors data offset info of the shard.
  482. for (ggml_tensor * cur = ggml_get_first_tensor(ctx); cur; cur = ggml_get_next_tensor(ctx, cur)) {
  483. std::string tensor_name = std::string(cur->name);
  484. // make sure there is no duplicated tensor names
  485. if (weights_map.find(tensor_name) != weights_map.end()) {
  486. throw std::runtime_error(format("invalid model: tensor '%s' is duplicated", ggml_get_name(cur)));
  487. }
  488. n_elements += ggml_nelements(cur);
  489. n_bytes += ggml_nbytes(cur);
  490. weights_map.emplace(tensor_name, llama_tensor_weight(files.back().get(), idx, ctx_gguf.get(), cur));
  491. }
  492. }
  493. get_key(llm_kv(LLM_KV_SPLIT_TENSORS_COUNT), n_tensors);
  494. // sanity check
  495. {
  496. const int n_tensors_loaded = (int) weights_map.size();
  497. if (n_tensors != n_tensors_loaded) {
  498. throw std::runtime_error(format("corrupted model: %d tensors expected but %d found", n_tensors, n_tensors_loaded));
  499. }
  500. }
  501. LLAMA_LOG_INFO("%s: additional %d GGUFs metadata loaded.\n", __func__, n_split - 1);
  502. }
  503. n_kv = gguf_get_n_kv(meta.get());
  504. n_tensors = weights_map.size();
  505. fver = (enum llama_fver) gguf_get_version(meta.get());
  506. LLAMA_LOG_INFO("%s: loaded meta data with %d key-value pairs and %d tensors from %s (version %s)\n",
  507. __func__, n_kv, n_tensors, fname.c_str(), llama_file_version_name(fver));
  508. // determine file type based on the number of tensors for each quantization and print meta data
  509. // TODO: make optional
  510. {
  511. std::map<enum ggml_type, uint32_t> n_type;
  512. uint32_t n_type_max = 0;
  513. enum ggml_type type_max = GGML_TYPE_F32;
  514. for (const auto & it : weights_map) {
  515. const llama_tensor_weight & w = it.second;
  516. const ggml_tensor * tensor = w.tensor;
  517. enum ggml_type type = tensor->type;
  518. n_type[type]++;
  519. if (n_type_max < n_type[type]) {
  520. n_type_max = n_type[type];
  521. type_max = type;
  522. }
  523. if (trace > 0) {
  524. const uint16_t sid = w.idx;
  525. LLAMA_LOG_INFO("%s: - tensor split %2d: %32s %-8s [ %s ] %8.2f MiB\n", __func__,
  526. sid, ggml_get_name(tensor), ggml_type_name(type), llama_format_tensor_shape(tensor).c_str(),
  527. ggml_nbytes(tensor)/1024.0f/1024.0f);
  528. }
  529. }
  530. switch (type_max) {
  531. case GGML_TYPE_F32: ftype = LLAMA_FTYPE_ALL_F32; break;
  532. case GGML_TYPE_F16: ftype = LLAMA_FTYPE_MOSTLY_F16; break;
  533. case GGML_TYPE_BF16: ftype = LLAMA_FTYPE_MOSTLY_BF16; break;
  534. case GGML_TYPE_Q4_0: ftype = LLAMA_FTYPE_MOSTLY_Q4_0; break;
  535. case GGML_TYPE_Q4_1: ftype = LLAMA_FTYPE_MOSTLY_Q4_1; break;
  536. case GGML_TYPE_Q5_0: ftype = LLAMA_FTYPE_MOSTLY_Q5_0; break;
  537. case GGML_TYPE_Q5_1: ftype = LLAMA_FTYPE_MOSTLY_Q5_1; break;
  538. case GGML_TYPE_Q8_0: ftype = LLAMA_FTYPE_MOSTLY_Q8_0; break;
  539. case GGML_TYPE_Q2_K: ftype = LLAMA_FTYPE_MOSTLY_Q2_K; break;
  540. case GGML_TYPE_Q3_K: ftype = LLAMA_FTYPE_MOSTLY_Q3_K_M; break;
  541. case GGML_TYPE_Q4_K: ftype = LLAMA_FTYPE_MOSTLY_Q4_K_M; break;
  542. case GGML_TYPE_Q5_K: ftype = LLAMA_FTYPE_MOSTLY_Q5_K_M; break;
  543. case GGML_TYPE_Q6_K: ftype = LLAMA_FTYPE_MOSTLY_Q6_K; break;
  544. case GGML_TYPE_TQ1_0: ftype = LLAMA_FTYPE_MOSTLY_TQ1_0; break;
  545. case GGML_TYPE_TQ2_0: ftype = LLAMA_FTYPE_MOSTLY_TQ2_0; break;
  546. case GGML_TYPE_IQ2_XXS: ftype = LLAMA_FTYPE_MOSTLY_IQ2_XXS; break;
  547. case GGML_TYPE_IQ2_XS: ftype = LLAMA_FTYPE_MOSTLY_IQ2_XS; break;
  548. case GGML_TYPE_IQ2_S: ftype = LLAMA_FTYPE_MOSTLY_IQ2_S; break;
  549. case GGML_TYPE_IQ3_XXS: ftype = LLAMA_FTYPE_MOSTLY_IQ3_XXS; break;
  550. case GGML_TYPE_IQ1_S: ftype = LLAMA_FTYPE_MOSTLY_IQ1_S; break;
  551. case GGML_TYPE_IQ1_M: ftype = LLAMA_FTYPE_MOSTLY_IQ1_M; break;
  552. case GGML_TYPE_IQ4_NL: ftype = LLAMA_FTYPE_MOSTLY_IQ4_NL; break;
  553. case GGML_TYPE_IQ4_XS: ftype = LLAMA_FTYPE_MOSTLY_IQ4_XS; break;
  554. case GGML_TYPE_IQ3_S: ftype = LLAMA_FTYPE_MOSTLY_IQ3_S; break;
  555. default:
  556. {
  557. LLAMA_LOG_WARN("%s: unknown type %s\n", __func__, ggml_type_name(type_max));
  558. ftype = LLAMA_FTYPE_ALL_F32;
  559. } break;
  560. }
  561. // this is a way to mark that we have "guessed" the file type
  562. ftype = (llama_ftype) (ftype | LLAMA_FTYPE_GUESSED);
  563. {
  564. uint32_t ftype_val = 0;
  565. if (get_key(LLM_KV_GENERAL_FILE_TYPE, ftype_val, false)) {
  566. ftype = (llama_ftype) ftype_val;
  567. }
  568. }
  569. LLAMA_LOG_INFO("%s: Dumping metadata keys/values. Note: KV overrides do not apply in this output.\n", __func__);
  570. for (int i = 0; i < n_kv; i++) {
  571. const char * name = gguf_get_key(meta.get(), i);
  572. const enum gguf_type type = gguf_get_kv_type(meta.get(), i);
  573. const std::string type_name =
  574. type == GGUF_TYPE_ARRAY
  575. ? format("%s[%s,%zu]", gguf_type_name(type), gguf_type_name(gguf_get_arr_type(meta.get(), i)), gguf_get_arr_n(meta.get(), i))
  576. : gguf_type_name(type);
  577. std::string value = gguf_kv_to_str(meta.get(), i);
  578. const size_t MAX_VALUE_LEN = 40;
  579. if (value.size() > MAX_VALUE_LEN) {
  580. value = format("%s...", value.substr(0, MAX_VALUE_LEN - 3).c_str());
  581. }
  582. replace_all(value, "\n", "\\n");
  583. LLAMA_LOG_INFO("%s: - kv %3d: %42s %-16s = %s\n", __func__, i, name, type_name.c_str(), value.c_str());
  584. }
  585. // print type counts
  586. for (auto & kv : n_type) {
  587. if (kv.second == 0) {
  588. continue;
  589. }
  590. LLAMA_LOG_INFO("%s: - type %4s: %4d tensors\n", __func__, ggml_type_name(kv.first), kv.second);
  591. }
  592. }
  593. if (!llama_mmap::SUPPORTED) {
  594. LLAMA_LOG_WARN("%s: mmap is not supported on this platform\n", __func__);
  595. use_mmap = false;
  596. }
  597. this->use_mmap = use_mmap;
  598. this->check_tensors = check_tensors;
  599. }
  600. std::string llama_model_loader::get_arch_name() const {
  601. return arch_name;
  602. }
  603. enum llm_arch llama_model_loader::get_arch() const {
  604. return llm_kv.arch;
  605. }
  606. const llama_model_loader::llama_tensor_weight * llama_model_loader::get_weight(const char * name) const {
  607. auto pos = weights_map.find(name);
  608. if (pos != weights_map.end()) {
  609. return &pos->second;
  610. }
  611. return nullptr;
  612. }
  613. const llama_model_loader::llama_tensor_weight & llama_model_loader::require_weight(const char * name) const {
  614. const llama_tensor_weight * weight = get_weight(name);
  615. if (!weight) {
  616. throw std::runtime_error(format("%s: tensor '%s' not found", __func__, name));
  617. }
  618. return *weight;
  619. }
  620. struct ggml_tensor * llama_model_loader::get_tensor_meta(const char * name) const {
  621. const auto * weight = get_weight(name);
  622. if (!weight) {
  623. return nullptr;
  624. }
  625. return weight->tensor;
  626. }
  627. struct ggml_tensor * llama_model_loader::require_tensor_meta(const std::string & name) const {
  628. struct ggml_tensor * tensor = get_tensor_meta(name.c_str());
  629. if (!tensor) {
  630. throw std::runtime_error(format("%s: tensor '%s' not found", __func__, name.c_str()));
  631. }
  632. return tensor;
  633. }
  634. const struct ggml_tensor * llama_model_loader::check_tensor_dims(const std::string & name, const std::vector<int64_t> & ne, bool required) const {
  635. const struct ggml_tensor * cur = get_tensor_meta(name.c_str());
  636. if (cur == NULL) {
  637. if (!required) {
  638. return NULL;
  639. }
  640. throw std::runtime_error(format("%s: tensor '%s' not found", __func__, name.c_str()));
  641. }
  642. {
  643. bool is_ok = true;
  644. for (size_t i = 0; i < GGML_MAX_DIMS; ++i) {
  645. if ((i < ne.size() && ne[i] != cur->ne[i]) || (i >= ne.size() && cur->ne[i] != 1)) {
  646. is_ok = false;
  647. break;
  648. }
  649. }
  650. if (!is_ok) {
  651. throw std::runtime_error(
  652. format("%s: tensor '%s' has wrong shape; expected %s, got %s",
  653. __func__, name.c_str(),
  654. llama_format_tensor_shape(ne).c_str(),
  655. llama_format_tensor_shape(cur).c_str()));
  656. }
  657. }
  658. return cur;
  659. }
  660. struct ggml_tensor * llama_model_loader::create_tensor(struct ggml_context * ctx, const std::string & name, const std::initializer_list<int64_t> & ne, int flags) {
  661. LLAMA_LOG_DEBUG("%s: loading tensor %s\n", __func__, name.c_str());
  662. const struct ggml_tensor * cur = check_tensor_dims(name, ne, !(flags & TENSOR_NOT_REQUIRED));
  663. if (cur == NULL) {
  664. return NULL;
  665. }
  666. bool duplicated = flags & TENSOR_DUPLICATED;
  667. struct ggml_tensor * tensor = ggml_dup_tensor(ctx, cur);
  668. ggml_set_name(tensor, ggml_get_name(cur));
  669. if (duplicated) {
  670. size_data += ggml_nbytes(cur);
  671. } else {
  672. n_created++;
  673. }
  674. return tensor;
  675. }
  676. struct ggml_tensor * llama_model_loader::create_tensor_as_view(struct ggml_context * ctx, struct ggml_tensor * base, const std::string & name, const std::initializer_list<int64_t> & ne, size_t offset, bool required) {
  677. LLAMA_LOG_DEBUG("%s: loading tensor %s as view\n", __func__, name.c_str());
  678. const struct ggml_tensor * cur = check_tensor_dims(name, ne, required);
  679. if (cur == NULL) {
  680. return NULL;
  681. }
  682. if (cur->type != base->type) {
  683. throw std::runtime_error(format("%s: tensor '%s' has wrong type; expected %s, got %s", __func__, name.c_str(), ggml_type_name(base->type), ggml_type_name(cur->type)));
  684. }
  685. std::array<int64_t, GGML_MAX_DIMS> dims;
  686. for (size_t i = 0; i < GGML_MAX_DIMS; ++i) {
  687. dims[i] = i < ne.size() ? ne.begin()[i] : 1;
  688. }
  689. struct ggml_tensor * tensor = ggml_view_4d(ctx, base,
  690. dims[0], dims[1], dims[2], dims[3],
  691. cur->nb[1], cur->nb[2], cur->nb[3],
  692. offset);
  693. ggml_set_name(tensor, name.c_str());
  694. n_created++;
  695. return tensor;
  696. }
  697. void llama_model_loader::done_getting_tensors() const {
  698. if (n_created != n_tensors) {
  699. throw std::runtime_error(format("%s: wrong number of tensors; expected %d, got %d", __func__, n_tensors, n_created));
  700. }
  701. }
  702. void llama_model_loader::init_mappings(bool prefetch, llama_mlocks * mlock_mmaps) {
  703. if (use_mmap) {
  704. mappings.reserve(files.size());
  705. mmaps_used.reserve(files.size());
  706. for (const auto & file : files) {
  707. bool is_numa = false;
  708. auto * dev = ggml_backend_dev_by_type(GGML_BACKEND_DEVICE_TYPE_CPU);
  709. if (dev) {
  710. auto * reg = ggml_backend_dev_backend_reg(dev);
  711. auto * is_numa_fn = (decltype(ggml_is_numa) *) ggml_backend_reg_get_proc_address(reg, "ggml_backend_cpu_is_numa");
  712. if (is_numa_fn) {
  713. is_numa = is_numa_fn();
  714. }
  715. }
  716. std::unique_ptr<llama_mmap> mapping = std::make_unique<llama_mmap>(file.get(), prefetch ? -1 : 0, is_numa);
  717. mmaps_used.emplace_back(mapping->size(), 0);
  718. if (mlock_mmaps) {
  719. std::unique_ptr<llama_mlock> mlock_mmap(new llama_mlock());
  720. mlock_mmap->init(mapping->addr());
  721. mlock_mmaps->emplace_back(std::move(mlock_mmap));
  722. }
  723. mappings.emplace_back(std::move(mapping));
  724. }
  725. }
  726. // compute the total size of all tensors for progress reporting
  727. for (const auto & it : weights_map) {
  728. size_data += ggml_nbytes(it.second.tensor);
  729. }
  730. }
  731. void llama_model_loader::get_mapping_range(size_t * first, size_t * last, void ** addr, int idx, ggml_context * ctx) const {
  732. GGML_ASSERT(!mappings.empty());
  733. const auto & mapping = mappings.at(idx);
  734. *first = mapping->size();
  735. *last = 0;
  736. *addr = mapping->addr();
  737. for (ggml_tensor * tensor = ggml_get_first_tensor(ctx); tensor; tensor = ggml_get_next_tensor(ctx, tensor)) {
  738. const auto * weight = get_weight(ggml_get_name(tensor));
  739. if (!weight || weight->idx != idx) {
  740. continue;
  741. }
  742. *first = std::min(*first, weight->offs);
  743. *last = std::max(*last, weight->offs + ggml_nbytes(tensor));
  744. }
  745. }
  746. void llama_model_loader::load_data_for(struct ggml_tensor * cur) const {
  747. const auto & w = require_weight(ggml_get_name(cur));
  748. if (use_mmap) {
  749. const auto & mapping = mappings.at(w.idx);
  750. if (cur->data == nullptr) {
  751. cur->data = (uint8_t *)mapping->addr() + w.offs;
  752. } else {
  753. memcpy(cur->data, (uint8_t *)mapping->addr() + w.offs, ggml_nbytes(cur));
  754. }
  755. } else {
  756. GGML_ASSERT(cur->data != nullptr);
  757. GGML_ASSERT(w.idx < files.size());
  758. const auto & file = files.at(w.idx);
  759. file->seek(w.offs, SEEK_SET);
  760. file->read_raw(cur->data, ggml_nbytes(cur));
  761. }
  762. if (check_tensors && !ggml_validate_row_data(cur->type, cur->data, ggml_nbytes(cur))) {
  763. throw std::runtime_error(format("tensor '%s' has invalid data", ggml_get_name(cur)));
  764. }
  765. }
  766. bool llama_model_loader::load_all_data(
  767. struct ggml_context * ctx,
  768. llama_buf_map & bufs,
  769. llama_mlocks * lmlocks,
  770. llama_progress_callback progress_callback,
  771. void * progress_callback_user_data) {
  772. GGML_ASSERT(size_data != 0 && "call init_mappings() first");
  773. std::vector<no_init<uint8_t>> read_buf;
  774. std::vector<std::future<std::pair<ggml_tensor *, bool>>> validation_result;
  775. // 4 staging buffers for async uploads, each sized 1MB seems to be a good default for single NVMe drives.
  776. // NVMe raid configurations might require more / larger buffers.
  777. constexpr size_t n_buffers = 4;
  778. constexpr size_t buffer_size = 1 * 1024 * 1024; // 1MB
  779. std::vector<ggml_backend_buffer_t> host_buffers;
  780. std::vector<ggml_backend_event_t> events;
  781. std::vector<void *> host_ptrs;
  782. size_t buffer_idx = 0; // buffer to use for async loads
  783. ggml_backend_t upload_backend = [&](const char * func) -> ggml_backend_t {
  784. if (use_mmap || check_tensors) {
  785. return nullptr;
  786. }
  787. // When not using mmaped io use async uploads from pinned memory to GPU memory.
  788. // First determine if the backend supports the necessary features for async uploads.
  789. auto * buf = bufs.count(0) ? bufs.at(0) : nullptr;
  790. if (!buf) {
  791. LLAMA_LOG_DEBUG("%s: no buffer found for async uploads\n", func);
  792. return nullptr;
  793. }
  794. auto * buft = ggml_backend_buffer_get_type(buf);
  795. auto * dev = ggml_backend_buft_get_device(buft);
  796. if (!dev) {
  797. LLAMA_LOG_DEBUG("%s: no device found for buffer type %s for async uploads\n", func,
  798. ggml_backend_buft_name(buft));
  799. return nullptr;
  800. }
  801. if (buft != ggml_backend_dev_buffer_type(dev)) {
  802. LLAMA_LOG_DEBUG("%s: buffer type %s is not the default buffer type for device %s for async uploads\n", func,
  803. ggml_backend_buft_name(buft), ggml_backend_dev_name(dev));
  804. return nullptr;
  805. }
  806. ggml_backend_dev_props props;
  807. ggml_backend_dev_get_props(dev, &props);
  808. if (!props.caps.async || !props.caps.host_buffer || !props.caps.events) {
  809. LLAMA_LOG_DEBUG("%s: device %s does not support async, host buffers or events\n", func,
  810. ggml_backend_dev_name(dev));
  811. return nullptr;
  812. }
  813. auto * host_buft = ggml_backend_dev_host_buffer_type(dev);
  814. if (!host_buft) {
  815. LLAMA_LOG_DEBUG("%s: no host buffer type found for device %s\n", func,
  816. ggml_backend_dev_name(dev));
  817. return nullptr;
  818. }
  819. // If the backend is supported, create pinned memory buffers and events for synchronisation.
  820. for (size_t idx = 0; idx < n_buffers; ++idx) {
  821. auto * buf = ggml_backend_buft_alloc_buffer(host_buft, buffer_size);
  822. if (!buf) {
  823. LLAMA_LOG_DEBUG("%s: failed to allocate host buffer for async uploads for device %s\n", func,
  824. ggml_backend_dev_name(dev));
  825. return nullptr;
  826. }
  827. host_buffers.emplace_back(buf);
  828. host_ptrs.emplace_back(ggml_backend_buffer_get_base(buf));
  829. auto * event = ggml_backend_event_new(dev);
  830. if (!event) {
  831. LLAMA_LOG_DEBUG("%s: failed to create event for async uploads for device %s\n", func,
  832. ggml_backend_dev_name(dev));
  833. return nullptr;
  834. }
  835. events.emplace_back(event);
  836. }
  837. ggml_backend_t backend = ggml_backend_dev_init(dev, nullptr);
  838. if (!backend) {
  839. LLAMA_LOG_DEBUG("%s: failed to initialize backend for device %s for async uploads\n", func,
  840. ggml_backend_dev_name(dev));
  841. return nullptr;
  842. }
  843. return backend;
  844. }(__func__);
  845. if (upload_backend) {
  846. LLAMA_LOG_DEBUG("%s: using async uploads for device %s, buffer type %s, backend %s\n", __func__,
  847. ggml_backend_dev_name(ggml_backend_get_device(upload_backend)),
  848. ggml_backend_buft_name(ggml_backend_buffer_get_type(bufs.at(0))),
  849. ggml_backend_name(upload_backend));
  850. }
  851. for (struct ggml_tensor * cur = ggml_get_first_tensor(ctx); cur != NULL; cur = ggml_get_next_tensor(ctx, cur)) {
  852. const auto * weight = get_weight(ggml_get_name(cur));
  853. if (weight == nullptr) {
  854. // this can happen with split experts models
  855. continue;
  856. }
  857. if (progress_callback) {
  858. if (!progress_callback((float) size_done / size_data, progress_callback_user_data)) {
  859. return false;
  860. }
  861. }
  862. size_t n_size = ggml_nbytes(cur);
  863. if (use_mmap) {
  864. const auto & mapping = mappings.at(weight->idx);
  865. ggml_backend_buffer_t buf_mmap = nullptr;
  866. if (bufs.count(weight->idx)) {
  867. buf_mmap = bufs.at(weight->idx);
  868. }
  869. uint8_t * data = (uint8_t *) mapping->addr() + weight->offs;
  870. if (check_tensors) {
  871. validation_result.emplace_back(std::async(std::launch::async, [cur, data, n_size] {
  872. return std::make_pair(cur, ggml_validate_row_data(cur->type, data, n_size));
  873. }));
  874. }
  875. GGML_ASSERT(buf_mmap || cur->data); // either we have a buffer to allocate the tensor in, or it is already allocated
  876. if (buf_mmap && cur->data == nullptr) {
  877. ggml_backend_tensor_alloc(buf_mmap, cur, data);
  878. if (lmlocks) {
  879. const auto & lmlock = lmlocks->at(weight->idx);
  880. lmlock->grow_to(weight->offs + n_size);
  881. }
  882. auto & mmap_used = mmaps_used[weight->idx];
  883. mmap_used.first = std::min(mmap_used.first, weight->offs);
  884. mmap_used.second = std::max(mmap_used.second, weight->offs + n_size);
  885. } else {
  886. ggml_backend_tensor_set(cur, data, 0, n_size);
  887. }
  888. } else {
  889. const auto & file = files.at(weight->idx);
  890. if (ggml_backend_buffer_is_host(cur->buffer)) {
  891. file->seek(weight->offs, SEEK_SET);
  892. file->read_raw(cur->data, n_size);
  893. if (check_tensors) {
  894. validation_result.emplace_back(std::async(std::launch::async, [cur, n_size] {
  895. return std::make_pair(cur, ggml_validate_row_data(cur->type, cur->data, n_size));
  896. }));
  897. }
  898. } else {
  899. // If upload_backend is valid load the tensor in chunks to pinned memory and upload the buffers asynchronously to the GPU.
  900. if (upload_backend) {
  901. file->seek(weight->offs, SEEK_SET);
  902. size_t bytes_read = 0;
  903. while (bytes_read < n_size) {
  904. size_t read_iteration = std::min<size_t>(buffer_size, n_size - bytes_read);
  905. ggml_backend_event_synchronize(events[buffer_idx]);
  906. file->read_raw(host_ptrs[buffer_idx], read_iteration);
  907. ggml_backend_tensor_set_async(upload_backend, cur, host_ptrs[buffer_idx], bytes_read, read_iteration);
  908. ggml_backend_event_record(events[buffer_idx], upload_backend);
  909. bytes_read += read_iteration;
  910. ++buffer_idx;
  911. buffer_idx %= n_buffers;
  912. }
  913. } else {
  914. read_buf.resize(n_size);
  915. file->seek(weight->offs, SEEK_SET);
  916. file->read_raw(read_buf.data(), n_size);
  917. ggml_backend_tensor_set(cur, read_buf.data(), 0, n_size);
  918. if (check_tensors && !ggml_validate_row_data(cur->type, read_buf.data(), n_size)) {
  919. throw std::runtime_error(format("tensor '%s' has invalid data", ggml_get_name(cur)));
  920. }
  921. }
  922. }
  923. }
  924. size_done += n_size;
  925. }
  926. // free temporary resources used for async uploads
  927. for (auto * event : events) {
  928. ggml_backend_event_synchronize(event);
  929. ggml_backend_event_free(event);
  930. }
  931. for (auto * buf : host_buffers) {
  932. ggml_backend_buffer_free(buf);
  933. }
  934. ggml_backend_free(upload_backend);
  935. // check validation results
  936. bool validation_failed = false;
  937. for (auto & future : validation_result) {
  938. auto result = future.get();
  939. if (!result.second) {
  940. LLAMA_LOG_ERROR("%s: tensor '%s' has invalid data\n", __func__, ggml_get_name(result.first));
  941. validation_failed = true;
  942. }
  943. }
  944. if (validation_failed) {
  945. throw std::runtime_error("found tensors with invalid data");
  946. }
  947. // check if this is the last call and do final cleanup
  948. if (size_done >= size_data) {
  949. // unmap offloaded tensors and metadata
  950. if (use_mmap) {
  951. for (uint32_t idx = 0; idx < mappings.size(); idx++) {
  952. const auto & mmap_used = mmaps_used.at(idx);
  953. auto & mapping = mappings.at(idx);
  954. mapping->unmap_fragment(0, mmap_used.first);
  955. if (mmap_used.second != 0) {
  956. mapping->unmap_fragment(mmap_used.second, mapping->size());
  957. }
  958. }
  959. }
  960. if (progress_callback) {
  961. // Even though the model is done loading, we still honor
  962. // cancellation since we need to free allocations.
  963. return progress_callback(1.0f, progress_callback_user_data);
  964. }
  965. }
  966. return true;
  967. }
  968. std::string llama_model_loader::ftype_name() const {
  969. return llama_model_ftype_name(ftype);
  970. }
  971. void llama_model_loader::print_info() const {
  972. LLAMA_LOG_INFO("%s: file format = %s\n", __func__, llama_file_version_name(fver));
  973. LLAMA_LOG_INFO("%s: file type = %s\n", __func__, llama_model_ftype_name(ftype).c_str());
  974. if (n_bytes < GiB) {
  975. LLAMA_LOG_INFO("%s: file size = %.2f MiB (%.2f BPW) \n", __func__, n_bytes/1024.0/1024.0, n_bytes*8.0/n_elements);
  976. } else {
  977. LLAMA_LOG_INFO("%s: file size = %.2f GiB (%.2f BPW) \n", __func__, n_bytes/1024.0/1024.0/1024.0, n_bytes*8.0/n_elements);
  978. }
  979. }