Coverage Report

Created: 2026-08-22 07:18

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/llama.cpp/src/llama-model-loader.cpp
Line
Count
Source
1
#include "llama-model-loader.h"
2
3
#include "ggml-alloc.h"
4
#include "ggml.h"
5
#include "gguf.h"
6
#include "llama-hparams.h"
7
#include "llama.h"
8
9
#include <algorithm>
10
#include <array>
11
#include <cinttypes>
12
#include <cstdint>
13
#include <cstring>
14
#include <future>
15
#include <regex>
16
17
static const size_t kiB = 1024;
18
static const size_t MiB = 1024*kiB;
19
static const size_t GiB = 1024*MiB;
20
21
5.94k
const char * llama_file_version_name(llama_fver version) {
22
5.94k
    switch (version) {
23
0
        case GGUF_FILE_VERSION_V1: return "GGUF V1 (support until nov 2023)";
24
1.42k
        case GGUF_FILE_VERSION_V2: return "GGUF V2";
25
4.51k
        case GGUF_FILE_VERSION_V3: return "GGUF V3 (latest)";
26
5.94k
    }
27
28
0
    return "unknown";
29
5.94k
}
30
31
5.92k
#define LLAMA_FTYPE_PREFIX "(guessed) "
32
33
2.96k
const char * llama_ftype_name(llama_ftype ftype) {
34
2.96k
    static constexpr size_t guessed_prefix_len = sizeof(LLAMA_FTYPE_PREFIX) - 1;
35
2.96k
    const char * name;
36
2.96k
    switch ((enum llama_ftype) (ftype & ~LLAMA_FTYPE_GUESSED)) {
37
2.65k
        case LLAMA_FTYPE_ALL_F32:          name = LLAMA_FTYPE_PREFIX "all F32"; break;
38
21
        case LLAMA_FTYPE_MOSTLY_F16:       name = LLAMA_FTYPE_PREFIX "F16"; break;
39
3
        case LLAMA_FTYPE_MOSTLY_BF16:      name = LLAMA_FTYPE_PREFIX "BF16"; break;
40
4
        case LLAMA_FTYPE_MOSTLY_Q1_0:      name = LLAMA_FTYPE_PREFIX "Q1_0"; break;
41
11
        case LLAMA_FTYPE_MOSTLY_Q2_0:      name = LLAMA_FTYPE_PREFIX "Q2_0"; break;
42
8
        case LLAMA_FTYPE_MOSTLY_Q4_0:      name = LLAMA_FTYPE_PREFIX "Q4_0"; break;
43
9
        case LLAMA_FTYPE_MOSTLY_Q4_1:      name = LLAMA_FTYPE_PREFIX "Q4_1"; break;
44
5
        case LLAMA_FTYPE_MOSTLY_Q5_0:      name = LLAMA_FTYPE_PREFIX "Q5_0"; break;
45
3
        case LLAMA_FTYPE_MOSTLY_Q5_1:      name = LLAMA_FTYPE_PREFIX "Q5_1"; break;
46
3
        case LLAMA_FTYPE_MOSTLY_Q8_0:      name = LLAMA_FTYPE_PREFIX "Q8_0"; break;
47
0
        case LLAMA_FTYPE_MOSTLY_MXFP4_MOE: name = LLAMA_FTYPE_PREFIX "MXFP4 MoE"; break;
48
0
        case LLAMA_FTYPE_MOSTLY_NVFP4:     name = LLAMA_FTYPE_PREFIX "NVFP4"; break;
49
66
        case LLAMA_FTYPE_MOSTLY_Q2_K:      name = LLAMA_FTYPE_PREFIX "Q2_K - Medium"; break;
50
1
        case LLAMA_FTYPE_MOSTLY_Q2_K_S:    name = LLAMA_FTYPE_PREFIX "Q2_K - Small"; break;
51
1
        case LLAMA_FTYPE_MOSTLY_Q3_K_S:    name = LLAMA_FTYPE_PREFIX "Q3_K - Small"; break;
52
3
        case LLAMA_FTYPE_MOSTLY_Q3_K_M:    name = LLAMA_FTYPE_PREFIX "Q3_K - Medium"; break;
53
0
        case LLAMA_FTYPE_MOSTLY_Q3_K_L:    name = LLAMA_FTYPE_PREFIX "Q3_K - Large"; break;
54
1
        case LLAMA_FTYPE_MOSTLY_Q4_K_S:    name = LLAMA_FTYPE_PREFIX "Q4_K - Small"; break;
55
15
        case LLAMA_FTYPE_MOSTLY_Q4_K_M:    name = LLAMA_FTYPE_PREFIX "Q4_K - Medium"; break;
56
0
        case LLAMA_FTYPE_MOSTLY_Q5_K_S:    name = LLAMA_FTYPE_PREFIX "Q5_K - Small"; break;
57
4
        case LLAMA_FTYPE_MOSTLY_Q5_K_M:    name = LLAMA_FTYPE_PREFIX "Q5_K - Medium"; break;
58
3
        case LLAMA_FTYPE_MOSTLY_Q6_K:      name = LLAMA_FTYPE_PREFIX "Q6_K"; break;
59
6
        case LLAMA_FTYPE_MOSTLY_TQ1_0:     name = LLAMA_FTYPE_PREFIX "TQ1_0 - 1.69 bpw ternary"; break;
60
10
        case LLAMA_FTYPE_MOSTLY_TQ2_0:     name = LLAMA_FTYPE_PREFIX "TQ2_0 - 2.06 bpw ternary"; break;
61
10
        case LLAMA_FTYPE_MOSTLY_IQ2_XXS:   name = LLAMA_FTYPE_PREFIX "IQ2_XXS - 2.0625 bpw"; break;
62
3
        case LLAMA_FTYPE_MOSTLY_IQ2_XS:    name = LLAMA_FTYPE_PREFIX "IQ2_XS - 2.3125 bpw"; break;
63
10
        case LLAMA_FTYPE_MOSTLY_IQ2_S:     name = LLAMA_FTYPE_PREFIX "IQ2_S - 2.5 bpw"; break;
64
1
        case LLAMA_FTYPE_MOSTLY_IQ2_M:     name = LLAMA_FTYPE_PREFIX "IQ2_M - 2.7 bpw"; break;
65
1
        case LLAMA_FTYPE_MOSTLY_IQ3_XS:    name = LLAMA_FTYPE_PREFIX "IQ3_XS - 3.3 bpw"; break;
66
1
        case LLAMA_FTYPE_MOSTLY_IQ3_XXS:   name = LLAMA_FTYPE_PREFIX "IQ3_XXS - 3.0625 bpw"; break;
67
1
        case LLAMA_FTYPE_MOSTLY_IQ1_S:     name = LLAMA_FTYPE_PREFIX "IQ1_S - 1.5625 bpw"; break;
68
2
        case LLAMA_FTYPE_MOSTLY_IQ1_M:     name = LLAMA_FTYPE_PREFIX "IQ1_M - 1.75 bpw"; break;
69
2
        case LLAMA_FTYPE_MOSTLY_IQ4_NL:    name = LLAMA_FTYPE_PREFIX "IQ4_NL - 4.5 bpw"; break;
70
3
        case LLAMA_FTYPE_MOSTLY_IQ4_XS:    name = LLAMA_FTYPE_PREFIX "IQ4_XS - 4.25 bpw"; break;
71
6
        case LLAMA_FTYPE_MOSTLY_IQ3_S:     name = LLAMA_FTYPE_PREFIX "IQ3_S - 3.4375 bpw"; break;
72
1
        case LLAMA_FTYPE_MOSTLY_IQ3_M:     name = LLAMA_FTYPE_PREFIX "IQ3_S mix - 3.66 bpw"; break;
73
90
        default:                           name = LLAMA_FTYPE_PREFIX "unknown, may not work"; break;
74
2.96k
    }
75
2.96k
    return (ftype & LLAMA_FTYPE_GUESSED) ? name : name + guessed_prefix_len;
76
2.96k
}
77
78
#undef LLAMA_FTYPE_PREFIX
79
80
// return a list of splits for a given path
81
// for example, given "<name>-00002-of-00004.gguf", returns list of all 4 splits
82
2
static std::vector<std::string> llama_get_list_splits(const std::string & path, const int idx, const int n_split) {
83
2
    std::vector<std::string> paths;
84
2
    std::string split_prefix;
85
2
    std::vector<char> buf(llama_path_max(), 0);
86
87
2
    {
88
2
        int ret = llama_split_prefix(buf.data(), buf.size(), path.c_str(), idx, n_split);
89
2
        if (!ret) {
90
2
            throw std::runtime_error(format("invalid split file name: %s", path.c_str()));
91
2
        }
92
0
        split_prefix = std::string(buf.data(), ret);
93
0
    }
94
95
0
    if (split_prefix.empty()) {
96
0
        throw std::runtime_error(format("invalid split file: %s", path.c_str()));
97
0
    }
98
99
0
    for (int idx = 0; idx < n_split; ++idx) {
100
0
        int ret = llama_split_path(buf.data(), buf.size(), split_prefix.c_str(), idx, n_split);
101
0
        paths.push_back(std::string(buf.data(), ret));
102
0
    }
103
104
0
    return paths;
105
0
}
106
107
namespace GGUFMeta {
108
    template <typename T, gguf_type gt_, T (*gfun)(const gguf_context *, const int64_t)>
109
    struct GKV_Base_Type {
110
        static constexpr gguf_type gt = gt_;
111
112
226
        static T getter(const gguf_context * ctx, const int kid) {
113
226
            return gfun(ctx, kid);
114
226
        }
Unexecuted instantiation: GGUFMeta::GKV_Base_Type<bool, (gguf_type)7, &gguf_get_val_bool>::getter(gguf_context const*, int)
Unexecuted instantiation: GGUFMeta::GKV_Base_Type<float, (gguf_type)6, &gguf_get_val_f32>::getter(gguf_context const*, int)
GGUFMeta::GKV_Base_Type<unsigned int, (gguf_type)4, &gguf_get_val_u32>::getter(gguf_context const*, int)
Line
Count
Source
112
147
        static T getter(const gguf_context * ctx, const int kid) {
113
147
            return gfun(ctx, kid);
114
147
        }
GGUFMeta::GKV_Base_Type<unsigned short, (gguf_type)2, &gguf_get_val_u16>::getter(gguf_context const*, int)
Line
Count
Source
112
79
        static T getter(const gguf_context * ctx, const int kid) {
113
79
            return gfun(ctx, kid);
114
79
        }
Unexecuted instantiation: GGUFMeta::GKV_Base_Type<int, (gguf_type)5, &gguf_get_val_i32>::getter(gguf_context const*, int)
115
    };
116
117
    template<typename T> struct GKV_Base;
118
119
    template<> struct GKV_Base<bool        >: GKV_Base_Type<bool,         GGUF_TYPE_BOOL,    gguf_get_val_bool> {};
120
    template<> struct GKV_Base<uint8_t     >: GKV_Base_Type<uint8_t,      GGUF_TYPE_UINT8,   gguf_get_val_u8  > {};
121
    template<> struct GKV_Base<uint16_t    >: GKV_Base_Type<uint16_t,     GGUF_TYPE_UINT16,  gguf_get_val_u16 > {};
122
    template<> struct GKV_Base<uint32_t    >: GKV_Base_Type<uint32_t,     GGUF_TYPE_UINT32,  gguf_get_val_u32 > {};
123
    template<> struct GKV_Base<uint64_t    >: GKV_Base_Type<uint64_t,     GGUF_TYPE_UINT64,  gguf_get_val_u64 > {};
124
    template<> struct GKV_Base<int8_t      >: GKV_Base_Type<int8_t,       GGUF_TYPE_INT8,    gguf_get_val_i8  > {};
125
    template<> struct GKV_Base<int16_t     >: GKV_Base_Type<int16_t,      GGUF_TYPE_INT16,   gguf_get_val_i16 > {};
126
    template<> struct GKV_Base<int32_t     >: GKV_Base_Type<int32_t,      GGUF_TYPE_INT32,   gguf_get_val_i32 > {};
127
    template<> struct GKV_Base<int64_t     >: GKV_Base_Type<int64_t,      GGUF_TYPE_INT64,   gguf_get_val_i64 > {};
128
    template<> struct GKV_Base<float       >: GKV_Base_Type<float,        GGUF_TYPE_FLOAT32, gguf_get_val_f32 > {};
129
    template<> struct GKV_Base<double      >: GKV_Base_Type<double,       GGUF_TYPE_FLOAT64, gguf_get_val_f64 > {};
130
    template<> struct GKV_Base<const char *>: GKV_Base_Type<const char *, GGUF_TYPE_STRING,  gguf_get_val_str > {};
131
132
    template<> struct GKV_Base<std::string> {
133
        static constexpr gguf_type gt = GGUF_TYPE_STRING;
134
135
598
        static std::string getter(const gguf_context * ctx, const int kid) {
136
598
            return gguf_get_val_str(ctx, kid);
137
598
        }
138
    };
139
140
    struct ArrayInfo {
141
        const gguf_type gt;
142
        const size_t length;
143
        const void * data;
144
    };
145
146
    template<> struct GKV_Base<ArrayInfo> {
147
        public:
148
        static constexpr gguf_type gt = GGUF_TYPE_ARRAY;
149
0
        static ArrayInfo getter(const gguf_context *ctx, const int k) {
150
0
            const enum gguf_type arr_type = gguf_get_arr_type(ctx, k);
151
0
            return ArrayInfo {
152
0
                arr_type,
153
0
                gguf_get_arr_n(ctx, k),
154
0
                arr_type == GGUF_TYPE_STRING ? nullptr : gguf_get_arr_data(ctx, k),
155
0
            };
156
0
        }
157
    };
158
159
    template<typename T>
160
    class GKV : public GKV_Base<T> {
161
        GKV() = delete;
162
163
        public:
164
930
        static T get_kv(const gguf_context * ctx, const int k) {
165
930
            const enum gguf_type kt = gguf_get_kv_type(ctx, k);
166
167
930
            if (kt != GKV::gt) {
168
106
                throw std::runtime_error(format("key %s has wrong type %s but expected type %s",
169
106
                    gguf_get_key(ctx, k), gguf_type_name(kt), gguf_type_name(GKV::gt)));
170
106
            }
171
824
            return GKV::getter(ctx, k);
172
930
        }
GGUFMeta::GKV<GGUFMeta::ArrayInfo>::get_kv(gguf_context const*, int)
Line
Count
Source
164
2
        static T get_kv(const gguf_context * ctx, const int k) {
165
2
            const enum gguf_type kt = gguf_get_kv_type(ctx, k);
166
167
2
            if (kt != GKV::gt) {
168
2
                throw std::runtime_error(format("key %s has wrong type %s but expected type %s",
169
2
                    gguf_get_key(ctx, k), gguf_type_name(kt), gguf_type_name(GKV::gt)));
170
2
            }
171
0
            return GKV::getter(ctx, k);
172
2
        }
GGUFMeta::GKV<bool>::get_kv(gguf_context const*, int)
Line
Count
Source
164
1
        static T get_kv(const gguf_context * ctx, const int k) {
165
1
            const enum gguf_type kt = gguf_get_kv_type(ctx, k);
166
167
1
            if (kt != GKV::gt) {
168
1
                throw std::runtime_error(format("key %s has wrong type %s but expected type %s",
169
1
                    gguf_get_key(ctx, k), gguf_type_name(kt), gguf_type_name(GKV::gt)));
170
1
            }
171
0
            return GKV::getter(ctx, k);
172
1
        }
Unexecuted instantiation: GGUFMeta::GKV<float>::get_kv(gguf_context const*, int)
GGUFMeta::GKV<unsigned int>::get_kv(gguf_context const*, int)
Line
Count
Source
164
198
        static T get_kv(const gguf_context * ctx, const int k) {
165
198
            const enum gguf_type kt = gguf_get_kv_type(ctx, k);
166
167
198
            if (kt != GKV::gt) {
168
51
                throw std::runtime_error(format("key %s has wrong type %s but expected type %s",
169
51
                    gguf_get_key(ctx, k), gguf_type_name(kt), gguf_type_name(GKV::gt)));
170
51
            }
171
147
            return GKV::getter(ctx, k);
172
198
        }
GGUFMeta::GKV<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > >::get_kv(gguf_context const*, int)
Line
Count
Source
164
629
        static T get_kv(const gguf_context * ctx, const int k) {
165
629
            const enum gguf_type kt = gguf_get_kv_type(ctx, k);
166
167
629
            if (kt != GKV::gt) {
168
31
                throw std::runtime_error(format("key %s has wrong type %s but expected type %s",
169
31
                    gguf_get_key(ctx, k), gguf_type_name(kt), gguf_type_name(GKV::gt)));
170
31
            }
171
598
            return GKV::getter(ctx, k);
172
629
        }
GGUFMeta::GKV<unsigned short>::get_kv(gguf_context const*, int)
Line
Count
Source
164
100
        static T get_kv(const gguf_context * ctx, const int k) {
165
100
            const enum gguf_type kt = gguf_get_kv_type(ctx, k);
166
167
100
            if (kt != GKV::gt) {
168
21
                throw std::runtime_error(format("key %s has wrong type %s but expected type %s",
169
21
                    gguf_get_key(ctx, k), gguf_type_name(kt), gguf_type_name(GKV::gt)));
170
21
            }
171
79
            return GKV::getter(ctx, k);
172
100
        }
Unexecuted instantiation: GGUFMeta::GKV<int>::get_kv(gguf_context const*, int)
173
174
1.86k
        static const char * override_type_to_str(const llama_model_kv_override_type ty) {
175
1.86k
            switch (ty) {
176
2
                case LLAMA_KV_OVERRIDE_TYPE_BOOL:  return "bool";
177
9
                case LLAMA_KV_OVERRIDE_TYPE_INT:   return "int";
178
1
                case LLAMA_KV_OVERRIDE_TYPE_FLOAT: return "float";
179
1.85k
                case LLAMA_KV_OVERRIDE_TYPE_STR:   return "str";
180
1.86k
            }
181
0
            return "unknown";
182
1.86k
        }
GGUFMeta::GKV<bool>::override_type_to_str(llama_model_kv_override_type)
Line
Count
Source
174
4
        static const char * override_type_to_str(const llama_model_kv_override_type ty) {
175
4
            switch (ty) {
176
2
                case LLAMA_KV_OVERRIDE_TYPE_BOOL:  return "bool";
177
1
                case LLAMA_KV_OVERRIDE_TYPE_INT:   return "int";
178
1
                case LLAMA_KV_OVERRIDE_TYPE_FLOAT: return "float";
179
0
                case LLAMA_KV_OVERRIDE_TYPE_STR:   return "str";
180
4
            }
181
0
            return "unknown";
182
4
        }
Unexecuted instantiation: GGUFMeta::GKV<float>::override_type_to_str(llama_model_kv_override_type)
GGUFMeta::GKV<unsigned int>::override_type_to_str(llama_model_kv_override_type)
Line
Count
Source
174
10
        static const char * override_type_to_str(const llama_model_kv_override_type ty) {
175
10
            switch (ty) {
176
0
                case LLAMA_KV_OVERRIDE_TYPE_BOOL:  return "bool";
177
8
                case LLAMA_KV_OVERRIDE_TYPE_INT:   return "int";
178
0
                case LLAMA_KV_OVERRIDE_TYPE_FLOAT: return "float";
179
2
                case LLAMA_KV_OVERRIDE_TYPE_STR:   return "str";
180
10
            }
181
0
            return "unknown";
182
10
        }
GGUFMeta::GKV<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > >::override_type_to_str(llama_model_kv_override_type)
Line
Count
Source
174
1.84k
        static const char * override_type_to_str(const llama_model_kv_override_type ty) {
175
1.84k
            switch (ty) {
176
0
                case LLAMA_KV_OVERRIDE_TYPE_BOOL:  return "bool";
177
0
                case LLAMA_KV_OVERRIDE_TYPE_INT:   return "int";
178
0
                case LLAMA_KV_OVERRIDE_TYPE_FLOAT: return "float";
179
1.84k
                case LLAMA_KV_OVERRIDE_TYPE_STR:   return "str";
180
1.84k
            }
181
0
            return "unknown";
182
1.84k
        }
Unexecuted instantiation: GGUFMeta::GKV<unsigned short>::override_type_to_str(llama_model_kv_override_type)
Unexecuted instantiation: GGUFMeta::GKV<int>::override_type_to_str(llama_model_kv_override_type)
183
184
13.8k
        static bool validate_override(const llama_model_kv_override_type expected_type, const struct llama_model_kv_override * ovrd) {
185
13.8k
            if (!ovrd) { return false; }
186
1.85k
            if (ovrd->tag == expected_type) {
187
1.85k
                LLAMA_LOG_INFO("%s: Using metadata override (%5s) '%s' = ",
188
1.85k
                    __func__, override_type_to_str(ovrd->tag), ovrd->key);
189
1.85k
                switch (ovrd->tag) {
190
0
                    case LLAMA_KV_OVERRIDE_TYPE_BOOL:  {
191
0
                        LLAMA_LOG_INFO("%s\n", ovrd->val_bool ? "true" : "false");
192
0
                    } break;
193
6
                    case LLAMA_KV_OVERRIDE_TYPE_INT:   {
194
6
                        LLAMA_LOG_INFO("%" PRId64 "\n", ovrd->val_i64);
195
6
                    } break;
196
0
                    case LLAMA_KV_OVERRIDE_TYPE_FLOAT: {
197
0
                        LLAMA_LOG_INFO("%.6f\n", ovrd->val_f64);
198
0
                    } break;
199
1.84k
                    case LLAMA_KV_OVERRIDE_TYPE_STR: {
200
1.84k
                        LLAMA_LOG_INFO("%s\n", ovrd->val_str);
201
1.84k
                    } break;
202
0
                    default:
203
                        // Shouldn't be possible to end up here, but just in case...
204
0
                        throw std::runtime_error(
205
0
                            format("Unsupported attempt to override %s type for metadata key %s\n",
206
0
                                override_type_to_str(ovrd->tag), ovrd->key));
207
1.85k
                }
208
1.85k
                return true;
209
1.85k
            }
210
4
            LLAMA_LOG_WARN("%s: Warning: Bad metadata override type for key '%s', expected %s but got %s\n",
211
4
                __func__, ovrd->key, override_type_to_str(expected_type), override_type_to_str(ovrd->tag));
212
4
            return false;
213
1.85k
        }
GGUFMeta::GKV<bool>::validate_override(llama_model_kv_override_type, llama_model_kv_override const*)
Line
Count
Source
184
19
        static bool validate_override(const llama_model_kv_override_type expected_type, const struct llama_model_kv_override * ovrd) {
185
19
            if (!ovrd) { return false; }
186
2
            if (ovrd->tag == expected_type) {
187
0
                LLAMA_LOG_INFO("%s: Using metadata override (%5s) '%s' = ",
188
0
                    __func__, override_type_to_str(ovrd->tag), ovrd->key);
189
0
                switch (ovrd->tag) {
190
0
                    case LLAMA_KV_OVERRIDE_TYPE_BOOL:  {
191
0
                        LLAMA_LOG_INFO("%s\n", ovrd->val_bool ? "true" : "false");
192
0
                    } break;
193
0
                    case LLAMA_KV_OVERRIDE_TYPE_INT:   {
194
0
                        LLAMA_LOG_INFO("%" PRId64 "\n", ovrd->val_i64);
195
0
                    } break;
196
0
                    case LLAMA_KV_OVERRIDE_TYPE_FLOAT: {
197
0
                        LLAMA_LOG_INFO("%.6f\n", ovrd->val_f64);
198
0
                    } break;
199
0
                    case LLAMA_KV_OVERRIDE_TYPE_STR: {
200
0
                        LLAMA_LOG_INFO("%s\n", ovrd->val_str);
201
0
                    } break;
202
0
                    default:
203
                        // Shouldn't be possible to end up here, but just in case...
204
0
                        throw std::runtime_error(
205
0
                            format("Unsupported attempt to override %s type for metadata key %s\n",
206
0
                                override_type_to_str(ovrd->tag), ovrd->key));
207
0
                }
208
0
                return true;
209
0
            }
210
2
            LLAMA_LOG_WARN("%s: Warning: Bad metadata override type for key '%s', expected %s but got %s\n",
211
2
                __func__, ovrd->key, override_type_to_str(expected_type), override_type_to_str(ovrd->tag));
212
2
            return false;
213
2
        }
GGUFMeta::GKV<float>::validate_override(llama_model_kv_override_type, llama_model_kv_override const*)
Line
Count
Source
184
16
        static bool validate_override(const llama_model_kv_override_type expected_type, const struct llama_model_kv_override * ovrd) {
185
16
            if (!ovrd) { return false; }
186
0
            if (ovrd->tag == expected_type) {
187
0
                LLAMA_LOG_INFO("%s: Using metadata override (%5s) '%s' = ",
188
0
                    __func__, override_type_to_str(ovrd->tag), ovrd->key);
189
0
                switch (ovrd->tag) {
190
0
                    case LLAMA_KV_OVERRIDE_TYPE_BOOL:  {
191
0
                        LLAMA_LOG_INFO("%s\n", ovrd->val_bool ? "true" : "false");
192
0
                    } break;
193
0
                    case LLAMA_KV_OVERRIDE_TYPE_INT:   {
194
0
                        LLAMA_LOG_INFO("%" PRId64 "\n", ovrd->val_i64);
195
0
                    } break;
196
0
                    case LLAMA_KV_OVERRIDE_TYPE_FLOAT: {
197
0
                        LLAMA_LOG_INFO("%.6f\n", ovrd->val_f64);
198
0
                    } break;
199
0
                    case LLAMA_KV_OVERRIDE_TYPE_STR: {
200
0
                        LLAMA_LOG_INFO("%s\n", ovrd->val_str);
201
0
                    } break;
202
0
                    default:
203
                        // Shouldn't be possible to end up here, but just in case...
204
0
                        throw std::runtime_error(
205
0
                            format("Unsupported attempt to override %s type for metadata key %s\n",
206
0
                                override_type_to_str(ovrd->tag), ovrd->key));
207
0
                }
208
0
                return true;
209
0
            }
210
0
            LLAMA_LOG_WARN("%s: Warning: Bad metadata override type for key '%s', expected %s but got %s\n",
211
0
                __func__, ovrd->key, override_type_to_str(expected_type), override_type_to_str(ovrd->tag));
212
0
            return false;
213
0
        }
GGUFMeta::GKV<unsigned int>::validate_override(llama_model_kv_override_type, llama_model_kv_override const*)
Line
Count
Source
184
5.05k
        static bool validate_override(const llama_model_kv_override_type expected_type, const struct llama_model_kv_override * ovrd) {
185
5.05k
            if (!ovrd) { return false; }
186
8
            if (ovrd->tag == expected_type) {
187
6
                LLAMA_LOG_INFO("%s: Using metadata override (%5s) '%s' = ",
188
6
                    __func__, override_type_to_str(ovrd->tag), ovrd->key);
189
6
                switch (ovrd->tag) {
190
0
                    case LLAMA_KV_OVERRIDE_TYPE_BOOL:  {
191
0
                        LLAMA_LOG_INFO("%s\n", ovrd->val_bool ? "true" : "false");
192
0
                    } break;
193
6
                    case LLAMA_KV_OVERRIDE_TYPE_INT:   {
194
6
                        LLAMA_LOG_INFO("%" PRId64 "\n", ovrd->val_i64);
195
6
                    } break;
196
0
                    case LLAMA_KV_OVERRIDE_TYPE_FLOAT: {
197
0
                        LLAMA_LOG_INFO("%.6f\n", ovrd->val_f64);
198
0
                    } break;
199
0
                    case LLAMA_KV_OVERRIDE_TYPE_STR: {
200
0
                        LLAMA_LOG_INFO("%s\n", ovrd->val_str);
201
0
                    } break;
202
0
                    default:
203
                        // Shouldn't be possible to end up here, but just in case...
204
0
                        throw std::runtime_error(
205
0
                            format("Unsupported attempt to override %s type for metadata key %s\n",
206
0
                                override_type_to_str(ovrd->tag), ovrd->key));
207
6
                }
208
6
                return true;
209
6
            }
210
2
            LLAMA_LOG_WARN("%s: Warning: Bad metadata override type for key '%s', expected %s but got %s\n",
211
2
                __func__, ovrd->key, override_type_to_str(expected_type), override_type_to_str(ovrd->tag));
212
2
            return false;
213
8
        }
GGUFMeta::GKV<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > >::validate_override(llama_model_kv_override_type, llama_model_kv_override const*)
Line
Count
Source
184
5.61k
        static bool validate_override(const llama_model_kv_override_type expected_type, const struct llama_model_kv_override * ovrd) {
185
5.61k
            if (!ovrd) { return false; }
186
1.84k
            if (ovrd->tag == expected_type) {
187
1.84k
                LLAMA_LOG_INFO("%s: Using metadata override (%5s) '%s' = ",
188
1.84k
                    __func__, override_type_to_str(ovrd->tag), ovrd->key);
189
1.84k
                switch (ovrd->tag) {
190
0
                    case LLAMA_KV_OVERRIDE_TYPE_BOOL:  {
191
0
                        LLAMA_LOG_INFO("%s\n", ovrd->val_bool ? "true" : "false");
192
0
                    } break;
193
0
                    case LLAMA_KV_OVERRIDE_TYPE_INT:   {
194
0
                        LLAMA_LOG_INFO("%" PRId64 "\n", ovrd->val_i64);
195
0
                    } break;
196
0
                    case LLAMA_KV_OVERRIDE_TYPE_FLOAT: {
197
0
                        LLAMA_LOG_INFO("%.6f\n", ovrd->val_f64);
198
0
                    } break;
199
1.84k
                    case LLAMA_KV_OVERRIDE_TYPE_STR: {
200
1.84k
                        LLAMA_LOG_INFO("%s\n", ovrd->val_str);
201
1.84k
                    } break;
202
0
                    default:
203
                        // Shouldn't be possible to end up here, but just in case...
204
0
                        throw std::runtime_error(
205
0
                            format("Unsupported attempt to override %s type for metadata key %s\n",
206
0
                                override_type_to_str(ovrd->tag), ovrd->key));
207
1.84k
                }
208
1.84k
                return true;
209
1.84k
            }
210
0
            LLAMA_LOG_WARN("%s: Warning: Bad metadata override type for key '%s', expected %s but got %s\n",
211
0
                __func__, ovrd->key, override_type_to_str(expected_type), override_type_to_str(ovrd->tag));
212
0
            return false;
213
1.84k
        }
GGUFMeta::GKV<unsigned short>::validate_override(llama_model_kv_override_type, llama_model_kv_override const*)
Line
Count
Source
184
3.09k
        static bool validate_override(const llama_model_kv_override_type expected_type, const struct llama_model_kv_override * ovrd) {
185
3.09k
            if (!ovrd) { return false; }
186
0
            if (ovrd->tag == expected_type) {
187
0
                LLAMA_LOG_INFO("%s: Using metadata override (%5s) '%s' = ",
188
0
                    __func__, override_type_to_str(ovrd->tag), ovrd->key);
189
0
                switch (ovrd->tag) {
190
0
                    case LLAMA_KV_OVERRIDE_TYPE_BOOL:  {
191
0
                        LLAMA_LOG_INFO("%s\n", ovrd->val_bool ? "true" : "false");
192
0
                    } break;
193
0
                    case LLAMA_KV_OVERRIDE_TYPE_INT:   {
194
0
                        LLAMA_LOG_INFO("%" PRId64 "\n", ovrd->val_i64);
195
0
                    } break;
196
0
                    case LLAMA_KV_OVERRIDE_TYPE_FLOAT: {
197
0
                        LLAMA_LOG_INFO("%.6f\n", ovrd->val_f64);
198
0
                    } break;
199
0
                    case LLAMA_KV_OVERRIDE_TYPE_STR: {
200
0
                        LLAMA_LOG_INFO("%s\n", ovrd->val_str);
201
0
                    } break;
202
0
                    default:
203
                        // Shouldn't be possible to end up here, but just in case...
204
0
                        throw std::runtime_error(
205
0
                            format("Unsupported attempt to override %s type for metadata key %s\n",
206
0
                                override_type_to_str(ovrd->tag), ovrd->key));
207
0
                }
208
0
                return true;
209
0
            }
210
0
            LLAMA_LOG_WARN("%s: Warning: Bad metadata override type for key '%s', expected %s but got %s\n",
211
0
                __func__, ovrd->key, override_type_to_str(expected_type), override_type_to_str(ovrd->tag));
212
0
            return false;
213
0
        }
Unexecuted instantiation: GGUFMeta::GKV<int>::validate_override(llama_model_kv_override_type, llama_model_kv_override const*)
214
215
        template<typename OT>
216
        static typename std::enable_if<std::is_same<OT, bool>::value, bool>::type
217
19
        try_override(OT & target, const struct llama_model_kv_override * ovrd) {
218
19
            if (validate_override(LLAMA_KV_OVERRIDE_TYPE_BOOL, ovrd)) {
219
0
                target = ovrd->val_bool;
220
0
                return true;
221
0
            }
222
19
            return false;
223
19
        }
224
225
        template<typename OT>
226
        static typename std::enable_if<!std::is_same<OT, bool>::value && std::is_integral<OT>::value, bool>::type
227
8.15k
        try_override(OT & target, const struct llama_model_kv_override * ovrd) {
228
8.15k
            if (validate_override(LLAMA_KV_OVERRIDE_TYPE_INT, ovrd)) {
229
6
                target = ovrd->val_i64;
230
6
                return true;
231
6
            }
232
8.14k
            return false;
233
8.15k
        }
_ZN8GGUFMeta3GKVIjE12try_overrideIjEENSt3__19enable_ifIXaantsr3std7is_sameIT_bEE5valuesr3std11is_integralIS5_EE5valueEbE4typeERS5_PK23llama_model_kv_override
Line
Count
Source
227
5.05k
        try_override(OT & target, const struct llama_model_kv_override * ovrd) {
228
5.05k
            if (validate_override(LLAMA_KV_OVERRIDE_TYPE_INT, ovrd)) {
229
6
                target = ovrd->val_i64;
230
6
                return true;
231
6
            }
232
5.05k
            return false;
233
5.05k
        }
_ZN8GGUFMeta3GKVItE12try_overrideItEENSt3__19enable_ifIXaantsr3std7is_sameIT_bEE5valuesr3std11is_integralIS5_EE5valueEbE4typeERS5_PK23llama_model_kv_override
Line
Count
Source
227
3.09k
        try_override(OT & target, const struct llama_model_kv_override * ovrd) {
228
3.09k
            if (validate_override(LLAMA_KV_OVERRIDE_TYPE_INT, ovrd)) {
229
0
                target = ovrd->val_i64;
230
0
                return true;
231
0
            }
232
3.09k
            return false;
233
3.09k
        }
Unexecuted instantiation: _ZN8GGUFMeta3GKVIiE12try_overrideIiEENSt3__19enable_ifIXaantsr3std7is_sameIT_bEE5valuesr3std11is_integralIS5_EE5valueEbE4typeERS5_PK23llama_model_kv_override
234
235
        template<typename OT>
236
        static typename std::enable_if<std::is_floating_point<OT>::value, bool>::type
237
16
        try_override(T & target, const struct llama_model_kv_override * ovrd) {
238
16
            if (validate_override(LLAMA_KV_OVERRIDE_TYPE_FLOAT, ovrd)) {
239
0
                target = ovrd->val_f64;
240
0
                return true;
241
0
            }
242
16
            return false;
243
16
        }
244
245
        template<typename OT>
246
        static typename std::enable_if<std::is_same<OT, std::string>::value, bool>::type
247
5.61k
        try_override(T & target, const struct llama_model_kv_override * ovrd) {
248
5.61k
            if (validate_override(LLAMA_KV_OVERRIDE_TYPE_STR, ovrd)) {
249
1.84k
                target = ovrd->val_str;
250
1.84k
                return true;
251
1.84k
            }
252
3.77k
            return false;
253
5.61k
        }
254
255
13.8k
        static bool set(const gguf_context * ctx, const int k, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
256
13.8k
            if (try_override<T>(target, ovrd)) {
257
1.85k
                return true;
258
1.85k
            }
259
11.9k
            if (k < 0) { return false; }
260
928
            target = get_kv(ctx, k);
261
928
            return true;
262
11.9k
        }
GGUFMeta::GKV<bool>::set(gguf_context const*, int, bool&, llama_model_kv_override const*)
Line
Count
Source
255
19
        static bool set(const gguf_context * ctx, const int k, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
256
19
            if (try_override<T>(target, ovrd)) {
257
0
                return true;
258
0
            }
259
19
            if (k < 0) { return false; }
260
1
            target = get_kv(ctx, k);
261
1
            return true;
262
19
        }
GGUFMeta::GKV<float>::set(gguf_context const*, int, float&, llama_model_kv_override const*)
Line
Count
Source
255
16
        static bool set(const gguf_context * ctx, const int k, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
256
16
            if (try_override<T>(target, ovrd)) {
257
0
                return true;
258
0
            }
259
16
            if (k < 0) { return false; }
260
0
            target = get_kv(ctx, k);
261
0
            return true;
262
16
        }
GGUFMeta::GKV<unsigned int>::set(gguf_context const*, int, unsigned int&, llama_model_kv_override const*)
Line
Count
Source
255
5.05k
        static bool set(const gguf_context * ctx, const int k, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
256
5.05k
            if (try_override<T>(target, ovrd)) {
257
6
                return true;
258
6
            }
259
5.05k
            if (k < 0) { return false; }
260
198
            target = get_kv(ctx, k);
261
198
            return true;
262
5.05k
        }
GGUFMeta::GKV<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > >::set(gguf_context const*, int, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >&, llama_model_kv_override const*)
Line
Count
Source
255
5.61k
        static bool set(const gguf_context * ctx, const int k, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
256
5.61k
            if (try_override<T>(target, ovrd)) {
257
1.84k
                return true;
258
1.84k
            }
259
3.77k
            if (k < 0) { return false; }
260
629
            target = get_kv(ctx, k);
261
629
            return true;
262
3.77k
        }
GGUFMeta::GKV<unsigned short>::set(gguf_context const*, int, unsigned short&, llama_model_kv_override const*)
Line
Count
Source
255
3.09k
        static bool set(const gguf_context * ctx, const int k, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
256
3.09k
            if (try_override<T>(target, ovrd)) {
257
0
                return true;
258
0
            }
259
3.09k
            if (k < 0) { return false; }
260
100
            target = get_kv(ctx, k);
261
100
            return true;
262
3.09k
        }
Unexecuted instantiation: GGUFMeta::GKV<int>::set(gguf_context const*, int, int&, llama_model_kv_override const*)
263
264
13.8k
        static bool set(const gguf_context * ctx, const char * key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
265
13.8k
            return set(ctx, gguf_find_key(ctx, key), target, ovrd);
266
13.8k
        }
GGUFMeta::GKV<bool>::set(gguf_context const*, char const*, bool&, llama_model_kv_override const*)
Line
Count
Source
264
19
        static bool set(const gguf_context * ctx, const char * key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
265
19
            return set(ctx, gguf_find_key(ctx, key), target, ovrd);
266
19
        }
GGUFMeta::GKV<float>::set(gguf_context const*, char const*, float&, llama_model_kv_override const*)
Line
Count
Source
264
16
        static bool set(const gguf_context * ctx, const char * key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
265
16
            return set(ctx, gguf_find_key(ctx, key), target, ovrd);
266
16
        }
GGUFMeta::GKV<unsigned int>::set(gguf_context const*, char const*, unsigned int&, llama_model_kv_override const*)
Line
Count
Source
264
5.05k
        static bool set(const gguf_context * ctx, const char * key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
265
5.05k
            return set(ctx, gguf_find_key(ctx, key), target, ovrd);
266
5.05k
        }
GGUFMeta::GKV<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > >::set(gguf_context const*, char const*, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >&, llama_model_kv_override const*)
Line
Count
Source
264
5.61k
        static bool set(const gguf_context * ctx, const char * key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
265
5.61k
            return set(ctx, gguf_find_key(ctx, key), target, ovrd);
266
5.61k
        }
GGUFMeta::GKV<unsigned short>::set(gguf_context const*, char const*, unsigned short&, llama_model_kv_override const*)
Line
Count
Source
264
3.09k
        static bool set(const gguf_context * ctx, const char * key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
265
3.09k
            return set(ctx, gguf_find_key(ctx, key), target, ovrd);
266
3.09k
        }
Unexecuted instantiation: GGUFMeta::GKV<int>::set(gguf_context const*, char const*, int&, llama_model_kv_override const*)
267
268
13.8k
        static bool set(const gguf_context * ctx, const std::string & key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
269
13.8k
            return set(ctx, key.c_str(), target, ovrd);
270
13.8k
        }
GGUFMeta::GKV<bool>::set(gguf_context const*, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, bool&, llama_model_kv_override const*)
Line
Count
Source
268
19
        static bool set(const gguf_context * ctx, const std::string & key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
269
19
            return set(ctx, key.c_str(), target, ovrd);
270
19
        }
GGUFMeta::GKV<float>::set(gguf_context const*, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, float&, llama_model_kv_override const*)
Line
Count
Source
268
16
        static bool set(const gguf_context * ctx, const std::string & key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
269
16
            return set(ctx, key.c_str(), target, ovrd);
270
16
        }
GGUFMeta::GKV<unsigned int>::set(gguf_context const*, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, unsigned int&, llama_model_kv_override const*)
Line
Count
Source
268
5.05k
        static bool set(const gguf_context * ctx, const std::string & key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
269
5.05k
            return set(ctx, key.c_str(), target, ovrd);
270
5.05k
        }
GGUFMeta::GKV<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > >::set(gguf_context const*, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >&, llama_model_kv_override const*)
Line
Count
Source
268
5.61k
        static bool set(const gguf_context * ctx, const std::string & key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
269
5.61k
            return set(ctx, key.c_str(), target, ovrd);
270
5.61k
        }
GGUFMeta::GKV<unsigned short>::set(gguf_context const*, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, unsigned short&, llama_model_kv_override const*)
Line
Count
Source
268
3.09k
        static bool set(const gguf_context * ctx, const std::string & key, T & target, const struct llama_model_kv_override * ovrd = nullptr) {
269
3.09k
            return set(ctx, key.c_str(), target, ovrd);
270
3.09k
        }
Unexecuted instantiation: GGUFMeta::GKV<int>::set(gguf_context const*, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, int&, llama_model_kv_override const*)
271
    };
272
}
273
274
    template<typename T>
275
    typename std::enable_if<std::is_integral<T>::value, bool>::type
276
3
    llama_model_loader::get_arr_n(const std::string & key, T & result, bool required) {
277
3
        const int kid = gguf_find_key(metadata, key.c_str());
278
279
3
        if (kid < 0) {
280
1
            if (required) {
281
0
                throw std::runtime_error(format("key not found in model: %s", key.c_str()));
282
0
            }
283
1
            return false;
284
1
        }
285
286
2
        struct GGUFMeta::ArrayInfo arr_info =
287
2
            GGUFMeta::GKV<GGUFMeta::ArrayInfo>::get_kv(metadata, kid);
288
289
290
2
        result = arr_info.length;
291
2
        return true;
292
3
    }
293
294
    template<typename T>
295
    typename std::enable_if<std::is_integral<T>::value, bool>::type
296
3
    llama_model_loader::get_arr_n(enum llm_kv kid, T & result, bool required) {
297
3
        return get_arr_n(llm_kv(kid), result, required);
298
3
    }
299
300
    template bool llama_model_loader::get_arr_n(enum llm_kv kid, uint32_t & result, bool required);
301
    template std::enable_if<std::is_integral<uint32_t>::value, bool>::type
302
    llama_model_loader::get_arr_n<uint32_t>(const std::string & key, uint32_t & result, bool required);
303
304
    template<typename T>
305
3
    bool llama_model_loader::get_arr(const std::string & key, std::vector<T> & result, bool required) {
306
3
        const gguf_context * ctx = metadata;
307
3
        const int kid = gguf_find_key(ctx, key.c_str());
308
309
3
        if (kid < 0 || gguf_get_kv_type(ctx, kid) != GGUF_TYPE_ARRAY) {
310
3
            if (required) {
311
0
                throw std::runtime_error(format("array key not found in model: %s", key.c_str()));
312
0
            }
313
3
            return false;
314
3
        }
315
316
0
        struct GGUFMeta::ArrayInfo arr_info =
317
0
            GGUFMeta::GKV<GGUFMeta::ArrayInfo>::get_kv(ctx, kid);
318
319
0
        bool type_ok = false;
320
0
        switch (arr_info.gt) {
321
0
            case GGUF_TYPE_UINT32:
322
0
            case GGUF_TYPE_INT32:   type_ok = (std::is_same<T,     int32_t>::value) ||
323
0
                                              (std::is_same<T,    uint32_t>::value); break;
324
0
            case GGUF_TYPE_FLOAT32: type_ok = (std::is_same<T,       float>::value); break;
325
0
            case GGUF_TYPE_STRING:  type_ok = (std::is_same<T, std::string>::value); break;
326
0
            default:
327
0
                throw std::runtime_error(format("%s is not a string/float32/uint32/int32 array", key.c_str()));
328
0
        }
329
0
        if (!type_ok) {
330
0
            throw std::runtime_error(format("%s has wrong array element type %s", key.c_str(), gguf_type_name(arr_info.gt)));
331
0
        }
332
333
0
        if constexpr (std::is_same<T, std::string>::value) {
334
0
            const size_t n_items = gguf_get_arr_n(ctx, kid);
335
0
            result.clear();
336
337
0
            for (size_t i = 0; i < n_items; i++) {
338
0
                const T value = gguf_get_arr_str(ctx, kid, i);
339
0
                result.emplace_back(value);
340
0
            }
341
0
        } else {
342
0
            result.resize(arr_info.length);
343
0
            result.assign((const T*)arr_info.data, (const T *)arr_info.data + arr_info.length);
344
0
        }
345
346
0
        return true;
347
0
    }
bool llama_model_loader::get_arr<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > >(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > > >&, bool)
Line
Count
Source
305
3
    bool llama_model_loader::get_arr(const std::string & key, std::vector<T> & result, bool required) {
306
3
        const gguf_context * ctx = metadata;
307
3
        const int kid = gguf_find_key(ctx, key.c_str());
308
309
3
        if (kid < 0 || gguf_get_kv_type(ctx, kid) != GGUF_TYPE_ARRAY) {
310
3
            if (required) {
311
0
                throw std::runtime_error(format("array key not found in model: %s", key.c_str()));
312
0
            }
313
3
            return false;
314
3
        }
315
316
0
        struct GGUFMeta::ArrayInfo arr_info =
317
0
            GGUFMeta::GKV<GGUFMeta::ArrayInfo>::get_kv(ctx, kid);
318
319
0
        bool type_ok = false;
320
0
        switch (arr_info.gt) {
321
0
            case GGUF_TYPE_UINT32:
322
0
            case GGUF_TYPE_INT32:   type_ok = (std::is_same<T,     int32_t>::value) ||
323
0
                                              (std::is_same<T,    uint32_t>::value); break;
324
0
            case GGUF_TYPE_FLOAT32: type_ok = (std::is_same<T,       float>::value); break;
325
0
            case GGUF_TYPE_STRING:  type_ok = (std::is_same<T, std::string>::value); break;
326
0
            default:
327
0
                throw std::runtime_error(format("%s is not a string/float32/uint32/int32 array", key.c_str()));
328
0
        }
329
0
        if (!type_ok) {
330
0
            throw std::runtime_error(format("%s has wrong array element type %s", key.c_str(), gguf_type_name(arr_info.gt)));
331
0
        }
332
333
0
        if constexpr (std::is_same<T, std::string>::value) {
334
0
            const size_t n_items = gguf_get_arr_n(ctx, kid);
335
0
            result.clear();
336
337
0
            for (size_t i = 0; i < n_items; i++) {
338
0
                const T value = gguf_get_arr_str(ctx, kid, i);
339
0
                result.emplace_back(value);
340
0
            }
341
        } else {
342
            result.resize(arr_info.length);
343
            result.assign((const T*)arr_info.data, (const T *)arr_info.data + arr_info.length);
344
        }
345
346
0
        return true;
347
0
    }
Unexecuted instantiation: bool llama_model_loader::get_arr<int>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::vector<int, std::__1::allocator<int> >&, bool)
348
349
    template<typename T, size_t N_MAX>
350
0
    bool llama_model_loader::get_arr(const std::string & key, std::array<T, N_MAX> & result, bool required) {
351
0
        const gguf_context * ctx = metadata;
352
0
        const int kid = gguf_find_key(ctx, key.c_str());
353
354
0
        if (kid < 0 || gguf_get_kv_type(ctx, kid) != GGUF_TYPE_ARRAY) {
355
0
            if (required) {
356
0
                throw std::runtime_error(format("array key not found in model: %s", key.c_str()));
357
0
            }
358
0
            return false;
359
0
        }
360
361
0
        struct GGUFMeta::ArrayInfo arr_info =
362
0
            GGUFMeta::GKV<GGUFMeta::ArrayInfo>::get_kv(ctx, kid);
363
364
0
        bool type_ok = false;
365
0
        switch (arr_info.gt) {
366
0
            case GGUF_TYPE_BOOL:
367
0
            case GGUF_TYPE_UINT32:
368
0
            case GGUF_TYPE_INT32:   type_ok = (std::is_same<T,     int32_t>::value) ||
369
0
                                              (std::is_same<T,    uint32_t>::value); break;
370
0
            case GGUF_TYPE_FLOAT32: type_ok = (std::is_same<T,       float>::value); break;
371
0
            case GGUF_TYPE_STRING:  type_ok = (std::is_same<T, std::string>::value); break;
372
0
            default:
373
0
                throw std::runtime_error(format("%s is not a string/float32/uint32/int32 array", key.c_str()));
374
0
        }
375
0
        if (!type_ok) {
376
0
            throw std::runtime_error(format("%s has wrong array element type %s", key.c_str(), gguf_type_name(arr_info.gt)));
377
0
        }
378
379
0
        if (arr_info.length > N_MAX) {
380
0
            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));
381
0
        }
382
383
        if constexpr (std::is_same<T, std::string>::value) {
384
            const size_t n_items = gguf_get_arr_n(ctx, kid);
385
386
            for (size_t i = 0; i < n_items; i++) {
387
                const T value = gguf_get_arr_str(ctx, kid, i);
388
                result[i] = value;
389
            }
390
0
        } else {
391
0
            if (arr_info.gt == GGUF_TYPE_BOOL) {
392
0
                const int8_t * values = (const int8_t *) arr_info.data;
393
0
                std::transform(values, values + arr_info.length, result.begin(), [](int8_t x) {
394
0
                    return static_cast<T>(x != 0);
395
0
                });
Unexecuted instantiation: llama_model_loader::get_arr<int, 512ul>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::array<int, 512ul>&, bool)::{lambda(signed char)#1}::operator()(signed char) const
Unexecuted instantiation: llama_model_loader::get_arr<unsigned int, 512ul>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::array<unsigned int, 512ul>&, bool)::{lambda(signed char)#1}::operator()(signed char) const
Unexecuted instantiation: llama_model_loader::get_arr<int, 4ul>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::array<int, 4ul>&, bool)::{lambda(signed char)#1}::operator()(signed char) const
Unexecuted instantiation: llama_model_loader::get_arr<float, 512ul>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::array<float, 512ul>&, bool)::{lambda(signed char)#1}::operator()(signed char) const
396
0
            } else {
397
0
                std::copy((const T*)arr_info.data, (const T *)arr_info.data + arr_info.length, result.begin());
398
0
            }
399
0
        }
400
401
0
        return true;
402
0
    }
Unexecuted instantiation: bool llama_model_loader::get_arr<int, 512ul>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::array<int, 512ul>&, bool)
Unexecuted instantiation: bool llama_model_loader::get_arr<unsigned int, 512ul>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::array<unsigned int, 512ul>&, bool)
Unexecuted instantiation: bool llama_model_loader::get_arr<int, 4ul>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::array<int, 4ul>&, bool)
Unexecuted instantiation: bool llama_model_loader::get_arr<float, 512ul>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::array<float, 512ul>&, bool)
403
404
    template<typename T>
405
3
    bool llama_model_loader::get_arr(enum llm_kv kid, T & result, bool required) {
406
3
        return get_arr(llm_kv(kid), result, required);
407
3
    }
bool llama_model_loader::get_arr<std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > > > >(llm_kv, std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > > >&, bool)
Line
Count
Source
405
3
    bool llama_model_loader::get_arr(enum llm_kv kid, T & result, bool required) {
406
3
        return get_arr(llm_kv(kid), result, required);
407
3
    }
Unexecuted instantiation: bool llama_model_loader::get_arr<std::__1::array<int, 512ul> >(llm_kv, std::__1::array<int, 512ul>&, bool)
Unexecuted instantiation: bool llama_model_loader::get_arr<std::__1::vector<int, std::__1::allocator<int> > >(llm_kv, std::__1::vector<int, std::__1::allocator<int> >&, bool)
Unexecuted instantiation: bool llama_model_loader::get_arr<std::__1::array<unsigned int, 512ul> >(llm_kv, std::__1::array<unsigned int, 512ul>&, bool)
408
409
    template bool llama_model_loader::get_arr<std::vector<std::string>>(enum llm_kv kid, std::vector<std::string> & result, bool required);
410
    template bool llama_model_loader::get_arr<std::array<int32_t, 512>>(enum llm_kv kid, std::array<int32_t, 512> & result, bool required);
411
    template bool llama_model_loader::get_arr<std::vector<int32_t>>(enum llm_kv kid, std::vector<int32_t> & result, bool required);
412
    template bool llama_model_loader::get_arr<std::array<uint32_t, LLAMA_MAX_LAYERS>>(enum llm_kv kid, std::array<uint32_t, LLAMA_MAX_LAYERS> & result, bool required);
413
414
    template<typename T>
415
13.8k
    bool llama_model_loader::get_key(const std::string & key, T & result, bool required) {
416
13.8k
        auto it = kv_overrides.find(key);
417
418
13.8k
        const struct llama_model_kv_override * override =
419
13.8k
            it != kv_overrides.end() ? &it->second : nullptr;
420
421
13.8k
        const bool found = GGUFMeta::GKV<T>::set(metadata, key, result, override);
422
423
13.8k
        if (required && !found) {
424
1.96k
            throw std::runtime_error(format("key not found in model: %s", key.c_str()));
425
1.96k
        }
426
427
11.8k
        return found;
428
13.8k
    }
bool llama_model_loader::get_key<bool>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, bool&, bool)
Line
Count
Source
415
19
    bool llama_model_loader::get_key(const std::string & key, T & result, bool required) {
416
19
        auto it = kv_overrides.find(key);
417
418
19
        const struct llama_model_kv_override * override =
419
19
            it != kv_overrides.end() ? &it->second : nullptr;
420
421
19
        const bool found = GGUFMeta::GKV<T>::set(metadata, key, result, override);
422
423
19
        if (required && !found) {
424
0
            throw std::runtime_error(format("key not found in model: %s", key.c_str()));
425
0
        }
426
427
19
        return found;
428
19
    }
bool llama_model_loader::get_key<float>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, float&, bool)
Line
Count
Source
415
16
    bool llama_model_loader::get_key(const std::string & key, T & result, bool required) {
416
16
        auto it = kv_overrides.find(key);
417
418
16
        const struct llama_model_kv_override * override =
419
16
            it != kv_overrides.end() ? &it->second : nullptr;
420
421
16
        const bool found = GGUFMeta::GKV<T>::set(metadata, key, result, override);
422
423
16
        if (required && !found) {
424
1
            throw std::runtime_error(format("key not found in model: %s", key.c_str()));
425
1
        }
426
427
15
        return found;
428
16
    }
bool llama_model_loader::get_key<unsigned int>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, unsigned int&, bool)
Line
Count
Source
415
5.05k
    bool llama_model_loader::get_key(const std::string & key, T & result, bool required) {
416
5.05k
        auto it = kv_overrides.find(key);
417
418
5.05k
        const struct llama_model_kv_override * override =
419
5.05k
            it != kv_overrides.end() ? &it->second : nullptr;
420
421
5.05k
        const bool found = GGUFMeta::GKV<T>::set(metadata, key, result, override);
422
423
5.05k
        if (required && !found) {
424
1.93k
            throw std::runtime_error(format("key not found in model: %s", key.c_str()));
425
1.93k
        }
426
427
3.12k
        return found;
428
5.05k
    }
bool llama_model_loader::get_key<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > >(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >&, bool)
Line
Count
Source
415
5.61k
    bool llama_model_loader::get_key(const std::string & key, T & result, bool required) {
416
5.61k
        auto it = kv_overrides.find(key);
417
418
5.61k
        const struct llama_model_kv_override * override =
419
5.61k
            it != kv_overrides.end() ? &it->second : nullptr;
420
421
5.61k
        const bool found = GGUFMeta::GKV<T>::set(metadata, key, result, override);
422
423
5.61k
        if (required && !found) {
424
0
            throw std::runtime_error(format("key not found in model: %s", key.c_str()));
425
0
        }
426
427
5.61k
        return found;
428
5.61k
    }
bool llama_model_loader::get_key<unsigned short>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, unsigned short&, bool)
Line
Count
Source
415
3.09k
    bool llama_model_loader::get_key(const std::string & key, T & result, bool required) {
416
3.09k
        auto it = kv_overrides.find(key);
417
418
3.09k
        const struct llama_model_kv_override * override =
419
3.09k
            it != kv_overrides.end() ? &it->second : nullptr;
420
421
3.09k
        const bool found = GGUFMeta::GKV<T>::set(metadata, key, result, override);
422
423
3.09k
        if (required && !found) {
424
29
            throw std::runtime_error(format("key not found in model: %s", key.c_str()));
425
29
        }
426
427
3.07k
        return found;
428
3.09k
    }
Unexecuted instantiation: bool llama_model_loader::get_key<int>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, int&, bool)
429
430
    template<typename T>
431
7.09k
    bool llama_model_loader::get_key(enum llm_kv kid, T & result, bool required) {
432
7.09k
        return get_key(llm_kv(kid), result, required);
433
7.09k
    }
bool llama_model_loader::get_key<bool>(llm_kv, bool&, bool)
Line
Count
Source
431
19
    bool llama_model_loader::get_key(enum llm_kv kid, T & result, bool required) {
432
19
        return get_key(llm_kv(kid), result, required);
433
19
    }
bool llama_model_loader::get_key<float>(llm_kv, float&, bool)
Line
Count
Source
431
16
    bool llama_model_loader::get_key(enum llm_kv kid, T & result, bool required) {
432
16
        return get_key(llm_kv(kid), result, required);
433
16
    }
bool llama_model_loader::get_key<unsigned int>(llm_kv, unsigned int&, bool)
Line
Count
Source
431
5.05k
    bool llama_model_loader::get_key(enum llm_kv kid, T & result, bool required) {
432
5.05k
        return get_key(llm_kv(kid), result, required);
433
5.05k
    }
bool llama_model_loader::get_key<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > >(llm_kv, std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> >&, bool)
Line
Count
Source
431
2.00k
    bool llama_model_loader::get_key(enum llm_kv kid, T & result, bool required) {
432
2.00k
        return get_key(llm_kv(kid), result, required);
433
2.00k
    }
434
435
    template bool llama_model_loader::get_key<bool>       (enum llm_kv kid, bool & result,        bool required);
436
    template bool llama_model_loader::get_key<float>      (enum llm_kv kid, float & result,       bool required);
437
    template bool llama_model_loader::get_key<uint32_t>   (enum llm_kv kid, uint32_t & result,    bool required);
438
    template bool llama_model_loader::get_key<std::string>(enum llm_kv kid, std::string & result, bool required);
439
440
    template<>
441
15
    bool llama_model_loader::get_key(enum llm_kv kid, enum llama_pooling_type & result, bool required) {
442
15
        uint32_t tmp;
443
15
        const bool found = get_key(kid, tmp, required);
444
15
        if (found) {
445
1
            result = (enum llama_pooling_type) tmp;
446
14
        } else {
447
14
            result = LLAMA_POOLING_TYPE_UNSPECIFIED;
448
14
        }
449
15
        return found;
450
15
    }
451
452
    // get array of n <= N_MAX elements, or a single element repeated n times
453
    template<typename T, size_t N_MAX>
454
9
    bool llama_model_loader::get_key_or_arr(const std::string & key, std::array<T, N_MAX> & result, uint32_t n, bool required) {
455
9
        const int kid = gguf_find_key(metadata, key.c_str());
456
457
9
        if (kid < 0) {
458
9
            if (required) {
459
0
                throw std::runtime_error(format("key not found in model: %s", key.c_str()));
460
0
            }
461
9
            return false;
462
9
        }
463
464
0
        if (n > N_MAX) {
465
0
            throw std::runtime_error(format("n > N_MAX: %u > %u for key %s", n, (uint32_t) N_MAX, key.c_str()));
466
0
        }
467
468
0
        if (gguf_get_kv_type(metadata, kid) == GGUF_TYPE_ARRAY) {
469
0
            struct GGUFMeta::ArrayInfo arr_info =
470
0
                GGUFMeta::GKV<GGUFMeta::ArrayInfo>::get_kv(metadata, kid);
471
472
0
            if (n != arr_info.length) {
473
0
                throw std::runtime_error(format("key %s has wrong array length; expected %u, got %u", key.c_str(), n, (uint32_t) arr_info.length));
474
0
            }
475
476
0
            return get_arr(key, result, required);
477
0
        }
478
479
0
        T value;
480
481
0
        bool ok = get_key(key, value, required);
482
0
        if (!ok) {
483
0
            return false;
484
0
        }
485
486
0
        for (uint32_t i = 0; i < n; i++) {
487
0
            result[i] = value;
488
0
        }
489
490
0
        return true;
491
0
    }
Unexecuted instantiation: bool llama_model_loader::get_key_or_arr<int, 4ul>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::array<int, 4ul>&, unsigned int, bool)
bool llama_model_loader::get_key_or_arr<unsigned int, 512ul>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::array<unsigned int, 512ul>&, unsigned int, bool)
Line
Count
Source
454
9
    bool llama_model_loader::get_key_or_arr(const std::string & key, std::array<T, N_MAX> & result, uint32_t n, bool required) {
455
9
        const int kid = gguf_find_key(metadata, key.c_str());
456
457
9
        if (kid < 0) {
458
9
            if (required) {
459
0
                throw std::runtime_error(format("key not found in model: %s", key.c_str()));
460
0
            }
461
9
            return false;
462
9
        }
463
464
0
        if (n > N_MAX) {
465
0
            throw std::runtime_error(format("n > N_MAX: %u > %u for key %s", n, (uint32_t) N_MAX, key.c_str()));
466
0
        }
467
468
0
        if (gguf_get_kv_type(metadata, kid) == GGUF_TYPE_ARRAY) {
469
0
            struct GGUFMeta::ArrayInfo arr_info =
470
0
                GGUFMeta::GKV<GGUFMeta::ArrayInfo>::get_kv(metadata, kid);
471
472
0
            if (n != arr_info.length) {
473
0
                throw std::runtime_error(format("key %s has wrong array length; expected %u, got %u", key.c_str(), n, (uint32_t) arr_info.length));
474
0
            }
475
476
0
            return get_arr(key, result, required);
477
0
        }
478
479
0
        T value;
480
481
0
        bool ok = get_key(key, value, required);
482
0
        if (!ok) {
483
0
            return false;
484
0
        }
485
486
0
        for (uint32_t i = 0; i < n; i++) {
487
0
            result[i] = value;
488
0
        }
489
490
0
        return true;
491
0
    }
Unexecuted instantiation: bool llama_model_loader::get_key_or_arr<float, 512ul>(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&, std::__1::array<float, 512ul>&, unsigned int, bool)
492
493
    template<typename T>
494
9
    bool llama_model_loader::get_key_or_arr(enum llm_kv kid, T & result, uint32_t n, bool required) {
495
9
        return get_key_or_arr(llm_kv(kid), result, n, required);
496
9
    }
Unexecuted instantiation: bool llama_model_loader::get_key_or_arr<std::__1::array<int, 4ul> >(llm_kv, std::__1::array<int, 4ul>&, unsigned int, bool)
bool llama_model_loader::get_key_or_arr<std::__1::array<unsigned int, 512ul> >(llm_kv, std::__1::array<unsigned int, 512ul>&, unsigned int, bool)
Line
Count
Source
494
9
    bool llama_model_loader::get_key_or_arr(enum llm_kv kid, T & result, uint32_t n, bool required) {
495
9
        return get_key_or_arr(llm_kv(kid), result, n, required);
496
9
    }
Unexecuted instantiation: bool llama_model_loader::get_key_or_arr<std::__1::array<float, 512ul> >(llm_kv, std::__1::array<float, 512ul>&, unsigned int, bool)
497
498
0
    bool llama_model_loader::get_key_or_arr(enum llm_kv kid, uint32_t & result, bool required) {
499
0
        const std::string key = llm_kv(kid);
500
501
0
        const int id = gguf_find_key(metadata, key.c_str());
502
503
0
        if (id < 0) {
504
0
            if (required) {
505
0
                throw std::runtime_error(format("key not found in model: %s", key.c_str()));
506
0
            }
507
0
            return false;
508
0
        }
509
510
        // throw and error if type is an array
511
0
        if (gguf_get_kv_type(metadata, id) == GGUF_TYPE_ARRAY) {
512
0
            if (required) {
513
0
                throw std::runtime_error(format("expected scalar, found array for key: %s", key.c_str()));
514
0
            }
515
0
            return false;
516
0
        }
517
518
0
        return get_key(key, result, required);
519
0
    }
520
521
    // TODO: this is not very clever - figure out something better
522
    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);
523
    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);
524
    template bool llama_model_loader::get_key_or_arr<std::array<float,    512>>(enum llm_kv kid, std::array<float,    512> & result, uint32_t n, bool required);
525
526
527
llama_model_loader::llama_model_loader(
528
        struct gguf_context * meta,
529
        llama_model_set_tensor_data_t set_tensor_data,
530
        void * set_tensor_data_ud,
531
        const std::string & fname,
532
        std::vector<std::string> & splits,
533
        FILE * file,
534
        llama_load_mode load_mode,
535
        bool check_tensors,
536
        bool no_alloc,
537
        bool load_mtp,
538
        const llama_model_kv_override * param_overrides_p,
539
        const llama_model_tensor_buft_override * param_tensor_buft_overrides_p)
540
13.2k
        : metadata(meta), set_tensor_data(set_tensor_data), set_tensor_data_ud(set_tensor_data_ud) {
541
13.2k
    int trace = 0;
542
13.2k
    if (getenv("LLAMA_TRACE")) {
543
0
        trace = atoi(getenv("LLAMA_TRACE"));
544
0
    }
545
546
13.2k
    if (param_overrides_p != nullptr) {
547
13.7k
        for (const struct llama_model_kv_override * p = param_overrides_p; p->key[0] != 0; p++) {
548
7.03k
            kv_overrides.insert({std::string(p->key), *p});
549
7.03k
        }
550
6.74k
    }
551
552
13.2k
    tensor_buft_overrides = param_tensor_buft_overrides_p;
553
554
13.2k
    this->use_mmap      = load_mode == LLAMA_LOAD_MODE_MMAP || load_mode == LLAMA_LOAD_MODE_MMAP_MLOCK || load_mode == LLAMA_LOAD_MODE_AUTO;
555
13.2k
    this->use_direct_io = load_mode == LLAMA_LOAD_MODE_DIRECT_IO;
556
557
13.2k
    if (!fname.empty()) {
558
        // Load the main GGUF
559
13.2k
        struct ggml_context * ctx = NULL;
560
13.2k
        struct gguf_init_params params = {
561
13.2k
            /*.no_alloc = */ true,
562
13.2k
            /*.ctx      = */ &ctx,
563
13.2k
        };
564
565
13.2k
        metadata_ptr.reset(gguf_init_from_file(fname.c_str(), params));
566
13.2k
        metadata = metadata_ptr.get();
567
13.2k
        if (metadata == nullptr) {
568
9.68k
            throw std::runtime_error(format("%s: failed to load model from %s", __func__, fname.c_str()));
569
9.68k
        }
570
571
3.61k
        get_key(llm_kv(LLM_KV_GENERAL_ARCHITECTURE), arch_name, false);
572
3.61k
        llm_kv = LLM_KV(llm_arch_from_string(arch_name));
573
574
3.61k
        files.emplace_back(new llama_file(fname.c_str(), "rb", use_direct_io));
575
3.61k
        contexts.emplace_back(ctx);
576
577
        // Save tensors data offset of the main file.
578
        // For subsidiary files, `meta` tensor data offset must not be used,
579
        // so we build a unified tensors index for weights.
580
7.05k
        for (ggml_tensor * cur = ggml_get_first_tensor(ctx); cur; cur = ggml_get_next_tensor(ctx, cur)) {
581
3.44k
            std::string tensor_name = std::string(cur->name);
582
            // make sure there is no duplicated tensor names
583
3.44k
            if (weights_map.find(tensor_name) != weights_map.end()) {
584
0
                throw std::runtime_error(format("invalid model: tensor '%s' is duplicated", ggml_get_name(cur)));
585
0
            }
586
3.44k
            n_elements += ggml_nelements(cur);
587
3.44k
            n_bytes    += ggml_nbytes(cur);
588
3.44k
            weights_map.emplace(tensor_name, llama_tensor_weight(files.back().get(), 0, metadata, cur));
589
3.44k
        }
590
3.61k
        uint16_t n_split = 0;
591
3.61k
        get_key(llm_kv(LLM_KV_SPLIT_COUNT), n_split, false);
592
593
        // Load additional GGML contexts
594
3.61k
        if (n_split > 1) {
595
            // make sure the main file is loaded first
596
50
            uint16_t idx = 0;
597
50
            const std::string kv_split_no = llm_kv(LLM_KV_SPLIT_NO);
598
50
            get_key(kv_split_no, idx);
599
50
            if (idx != 0) {
600
15
                throw std::runtime_error(format("illegal split file idx: %d (file: %s), model must be loaded with the first split", idx, fname.c_str()));
601
15
            }
602
603
            // generate list of splits if needed
604
35
            if (splits.empty()) {
605
2
                splits = llama_get_list_splits(fname, idx, n_split);
606
2
            }
607
608
            // in case user give a custom list of splits, check if it matches the expected number
609
35
            if (n_split != (uint16_t)splits.size()) {
610
0
                throw std::runtime_error(format("invalid split count, given: %zu splits, but expected %d", splits.size(), n_split));
611
0
            }
612
613
35
            if (trace > 0) {
614
0
                LLAMA_LOG_INFO("%s: loading additional %d GGUFs\n", __func__, n_split);
615
0
            }
616
617
            // load other splits
618
35
            for (idx = 1; idx < n_split; idx++) {
619
0
                const char * fname_split = splits[idx].c_str();
620
621
0
                struct gguf_init_params split_params = {
622
0
                    /*.no_alloc = */ true,
623
0
                    /*.ctx      = */ &ctx,
624
0
                };
625
0
                gguf_context_ptr ctx_gguf { gguf_init_from_file(fname_split, split_params) };
626
0
                if (!ctx_gguf) {
627
0
                    throw std::runtime_error(format("%s: failed to load GGUF split from %s", __func__, fname_split));
628
0
                }
629
630
                // check idx
631
0
                {
632
0
                    const int kid = gguf_find_key(ctx_gguf.get(), kv_split_no.c_str());
633
0
                    if (kid < 0) {
634
0
                        throw std::runtime_error(format("missing key %s in GGUF split %s", kv_split_no.c_str(), fname_split));
635
0
                    }
636
0
                    int idx_gguf = gguf_get_val_u16(ctx_gguf.get(), kid);
637
0
                    if (idx_gguf != idx) {
638
0
                        throw std::runtime_error(format("invalid split file idx: %d (file: %s), expected %d", idx_gguf, fname_split, idx));
639
0
                    }
640
0
                }
641
642
0
                files.emplace_back(new llama_file(fname_split, "rb", use_direct_io));
643
0
                contexts.emplace_back(ctx);
644
645
                // Save tensors data offset info of the shard.
646
0
                for (ggml_tensor * cur = ggml_get_first_tensor(ctx); cur; cur = ggml_get_next_tensor(ctx, cur)) {
647
0
                    std::string tensor_name = std::string(cur->name);
648
                    // make sure there is no duplicated tensor names
649
0
                    if (weights_map.find(tensor_name) != weights_map.end()) {
650
0
                        throw std::runtime_error(format("invalid model: tensor '%s' is duplicated", ggml_get_name(cur)));
651
0
                    }
652
0
                    n_elements += ggml_nelements(cur);
653
0
                    n_bytes    += ggml_nbytes(cur);
654
0
                    weights_map.emplace(tensor_name, llama_tensor_weight(files.back().get(), idx, ctx_gguf.get(), cur));
655
0
                }
656
0
            }
657
658
35
            get_key(llm_kv(LLM_KV_SPLIT_TENSORS_COUNT), n_tensors);
659
660
            // sanity check
661
35
            {
662
35
                const int n_tensors_loaded = (int) weights_map.size();
663
35
                if (n_tensors != n_tensors_loaded) {
664
0
                    throw std::runtime_error(format("corrupted model: %d tensors expected but %d found", n_tensors, n_tensors_loaded));
665
0
                }
666
35
            }
667
668
35
            LLAMA_LOG_INFO("%s: additional %d GGUFs metadata loaded.\n",  __func__, n_split - 1);
669
35
        }
670
3.61k
    } else if (file != nullptr) {
671
0
        struct ggml_context * ctx = NULL;
672
0
        struct gguf_init_params params = {
673
0
            /*.no_alloc = */ true,
674
0
            /*.ctx      = */ &ctx,
675
0
        };
676
677
0
        metadata_ptr.reset(gguf_init_from_file_ptr(file, params));
678
0
        metadata = metadata_ptr.get();
679
0
        if (metadata == nullptr) {
680
0
            throw std::runtime_error(format("%s: failed to load model from file pointer", __func__));
681
0
        }
682
683
0
        get_key(llm_kv(LLM_KV_GENERAL_ARCHITECTURE), arch_name, false);
684
0
        llm_kv = LLM_KV(llm_arch_from_string(arch_name));
685
686
0
        files.emplace_back(new llama_file(file));
687
0
        contexts.emplace_back(ctx);
688
689
        // Save tensors data offset info of the main file.
690
0
        for (ggml_tensor * cur = ggml_get_first_tensor(ctx); cur; cur = ggml_get_next_tensor(ctx, cur)) {
691
0
            std::string tensor_name = std::string(cur->name);
692
            // make sure there is no duplicated tensor names
693
0
            if (weights_map.find(tensor_name) != weights_map.end()) {
694
0
                throw std::runtime_error(format("invalid model: tensor '%s' is duplicated", ggml_get_name(cur)));
695
0
            }
696
0
            n_elements += ggml_nelements(cur);
697
0
            n_bytes    += ggml_nbytes(cur);
698
0
            weights_map.emplace(tensor_name, llama_tensor_weight(files.back().get(), 0, metadata, cur));
699
0
        }
700
0
    } else {
701
0
        get_key(llm_kv(LLM_KV_GENERAL_ARCHITECTURE), arch_name, false);
702
0
        llm_kv = LLM_KV(llm_arch_from_string(arch_name));
703
0
    }
704
705
3.60k
    n_kv      = gguf_get_n_kv(metadata);
706
3.60k
    n_tensors = weights_map.size();
707
708
3.60k
    fver = (enum llama_fver) gguf_get_version(metadata);
709
710
3.60k
    LLAMA_LOG_INFO("%s: loaded meta data with %d key-value pairs and %d tensors from %s (version %s)\n",
711
3.60k
            __func__, n_kv, n_tensors, fname.empty() ? "(file*)" : fname.c_str(), llama_file_version_name(fver));
712
713
    // determine file type based on the number of tensors for each quantization and print meta data
714
    // TODO: make optional
715
3.60k
    {
716
3.60k
        std::map<enum ggml_type, uint32_t> n_type;
717
718
3.60k
        uint32_t n_type_max = 0;
719
3.60k
        enum ggml_type type_max = GGML_TYPE_F32;
720
721
3.60k
        for (const auto & it : weights_map) {
722
2.23k
            const llama_tensor_weight & w = it.second;
723
2.23k
            const ggml_tensor * tensor = w.tensor;
724
725
2.23k
            enum ggml_type type = tensor->type;
726
727
2.23k
            n_type[type]++;
728
729
2.23k
            if (n_type_max < n_type[type]) {
730
1.59k
                n_type_max = n_type[type];
731
1.59k
                type_max   = type;
732
1.59k
            }
733
734
2.23k
            if (trace > 0) {
735
0
                const uint16_t sid = w.idx;
736
0
                LLAMA_LOG_INFO("%s: - tensor split %2d: %32s %-8s [ %s ] %8.2f MiB\n", __func__,
737
0
                        sid, ggml_get_name(tensor), ggml_type_name(type), llama_format_tensor_shape(tensor).c_str(),
738
0
                        ggml_nbytes(tensor)/1024.0f/1024.0f);
739
0
            }
740
2.23k
        }
741
742
3.60k
        switch (type_max) {
743
2.76k
            case GGML_TYPE_F32:     ftype = LLAMA_FTYPE_ALL_F32;        break;
744
21
            case GGML_TYPE_F16:     ftype = LLAMA_FTYPE_MOSTLY_F16;     break;
745
3
            case GGML_TYPE_BF16:    ftype = LLAMA_FTYPE_MOSTLY_BF16;    break;
746
8
            case GGML_TYPE_Q4_0:    ftype = LLAMA_FTYPE_MOSTLY_Q4_0;    break;
747
9
            case GGML_TYPE_Q4_1:    ftype = LLAMA_FTYPE_MOSTLY_Q4_1;    break;
748
5
            case GGML_TYPE_Q5_0:    ftype = LLAMA_FTYPE_MOSTLY_Q5_0;    break;
749
3
            case GGML_TYPE_Q5_1:    ftype = LLAMA_FTYPE_MOSTLY_Q5_1;    break;
750
3
            case GGML_TYPE_Q8_0:    ftype = LLAMA_FTYPE_MOSTLY_Q8_0;    break;
751
66
            case GGML_TYPE_Q2_K:    ftype = LLAMA_FTYPE_MOSTLY_Q2_K;    break;
752
3
            case GGML_TYPE_Q3_K:    ftype = LLAMA_FTYPE_MOSTLY_Q3_K_M;  break;
753
14
            case GGML_TYPE_Q4_K:    ftype = LLAMA_FTYPE_MOSTLY_Q4_K_M;  break;
754
4
            case GGML_TYPE_Q5_K:    ftype = LLAMA_FTYPE_MOSTLY_Q5_K_M;  break;
755
3
            case GGML_TYPE_Q6_K:    ftype = LLAMA_FTYPE_MOSTLY_Q6_K;    break;
756
6
            case GGML_TYPE_TQ1_0:   ftype = LLAMA_FTYPE_MOSTLY_TQ1_0;   break;
757
10
            case GGML_TYPE_TQ2_0:   ftype = LLAMA_FTYPE_MOSTLY_TQ2_0;   break;
758
10
            case GGML_TYPE_IQ2_XXS: ftype = LLAMA_FTYPE_MOSTLY_IQ2_XXS; break;
759
3
            case GGML_TYPE_IQ2_XS:  ftype = LLAMA_FTYPE_MOSTLY_IQ2_XS;  break;
760
10
            case GGML_TYPE_IQ2_S:   ftype = LLAMA_FTYPE_MOSTLY_IQ2_S;   break;
761
1
            case GGML_TYPE_IQ3_XXS: ftype = LLAMA_FTYPE_MOSTLY_IQ3_XXS; break;
762
1
            case GGML_TYPE_IQ1_S:   ftype = LLAMA_FTYPE_MOSTLY_IQ1_S;   break;
763
2
            case GGML_TYPE_IQ1_M:   ftype = LLAMA_FTYPE_MOSTLY_IQ1_M;   break;
764
2
            case GGML_TYPE_IQ4_NL:  ftype = LLAMA_FTYPE_MOSTLY_IQ4_NL;  break;
765
3
            case GGML_TYPE_IQ4_XS:  ftype = LLAMA_FTYPE_MOSTLY_IQ4_XS;  break;
766
6
            case GGML_TYPE_IQ3_S:   ftype = LLAMA_FTYPE_MOSTLY_IQ3_S;   break;
767
0
            case GGML_TYPE_NVFP4:   ftype = LLAMA_FTYPE_MOSTLY_NVFP4;   break;
768
3
            case GGML_TYPE_Q1_0:    ftype = LLAMA_FTYPE_MOSTLY_Q1_0;    break;
769
10
            case GGML_TYPE_Q2_0:    ftype = LLAMA_FTYPE_MOSTLY_Q2_0;    break;
770
12
            default:
771
12
                {
772
12
                    LLAMA_LOG_WARN("%s: unknown type %s\n", __func__, ggml_type_name(type_max));
773
12
                    ftype = LLAMA_FTYPE_ALL_F32;
774
12
                } break;
775
3.60k
        }
776
777
        // this is a way to mark that we have "guessed" the file type
778
2.98k
        ftype = (llama_ftype) (ftype | LLAMA_FTYPE_GUESSED);
779
780
2.98k
        {
781
2.98k
            uint32_t ftype_val = 0;
782
2.98k
            if (get_key(LLM_KV_GENERAL_FILE_TYPE, ftype_val, false)) {
783
99
                ftype = (llama_ftype) ftype_val;
784
99
            }
785
2.98k
        }
786
787
2.98k
        LLAMA_LOG_INFO("%s: Dumping metadata keys/values. Note: KV overrides do not apply in this output.\n", __func__);
788
789
13.2k
        for (int i = 0; i < n_kv; i++) {
790
10.2k
            const char * name           = gguf_get_key(metadata, i);
791
10.2k
            const enum gguf_type type   = gguf_get_kv_type(metadata, i);
792
10.2k
            const std::string type_name =
793
10.2k
                type == GGUF_TYPE_ARRAY
794
10.2k
                ? format("%s[%s,%zu]", gguf_type_name(type), gguf_type_name(gguf_get_arr_type(metadata, i)), gguf_get_arr_n(metadata, i))
795
10.2k
                : gguf_type_name(type);
796
797
10.2k
            std::string value          = gguf_kv_to_str(metadata, i);
798
10.2k
            const size_t MAX_VALUE_LEN = 40;
799
10.2k
            if (value.size() > MAX_VALUE_LEN) {
800
851
                value = format("%s...", value.substr(0, MAX_VALUE_LEN - 3).c_str());
801
851
            }
802
10.2k
            replace_all(value, "\n", "\\n");
803
804
10.2k
            LLAMA_LOG_INFO("%s: - kv %3d: %42s %-16s = %s\n", __func__, i, name, type_name.c_str(), value.c_str());
805
10.2k
        }
806
807
        // print type counts
808
2.98k
        for (auto & kv : n_type) {
809
1.32k
            if (kv.second == 0) {
810
0
                continue;
811
0
            }
812
813
1.32k
            LLAMA_LOG_INFO("%s: - type %4s: %4d tensors\n", __func__, ggml_type_name(kv.first), kv.second);
814
1.32k
        }
815
2.98k
    }
816
817
2.98k
    if (this->use_mmap && !llama_mmap::SUPPORTED) {
818
0
        LLAMA_LOG_WARN("%s: mmap is not supported on this platform\n", __func__);
819
0
        this->use_mmap = false;
820
0
    }
821
822
2.98k
    this->check_tensors = check_tensors;
823
2.98k
    this->no_alloc = no_alloc;
824
2.98k
    this->load_mtp = load_mtp;
825
2.98k
}
826
827
962
std::string llama_model_loader::get_arch_name() const {
828
962
    return arch_name;
829
962
}
830
831
4.94k
enum llm_arch llama_model_loader::get_arch() const {
832
4.94k
    return llm_kv.arch;
833
4.94k
}
834
835
0
const llama_model_loader::llama_tensor_weight * llama_model_loader::get_weight(const char * name) const {
836
0
    auto pos = weights_map.find(name);
837
0
    if (pos != weights_map.end()) {
838
0
        return &pos->second;
839
0
    }
840
841
0
    return nullptr;
842
0
}
843
844
0
const llama_model_loader::llama_tensor_weight & llama_model_loader::require_weight(const char * name) const {
845
0
    const llama_tensor_weight * weight = get_weight(name);
846
0
    if (!weight) {
847
0
        throw std::runtime_error(format("%s: tensor '%s' not found", __func__, name));
848
0
    }
849
0
    return *weight;
850
0
}
851
852
0
struct ggml_tensor * llama_model_loader::get_tensor_meta(const char * name) const {
853
0
    const auto * weight = get_weight(name);
854
0
    if (!weight) {
855
0
        return nullptr;
856
0
    }
857
0
    return weight->tensor;
858
0
}
859
860
0
struct ggml_tensor * llama_model_loader::require_tensor_meta(const std::string & name) const {
861
0
    struct ggml_tensor * tensor = get_tensor_meta(name.c_str());
862
0
    if (!tensor) {
863
0
        throw std::runtime_error(format("%s: tensor '%s' not found", __func__, name.c_str()));
864
0
    }
865
0
    return tensor;
866
0
}
867
868
const struct ggml_tensor * llama_model_loader::check_tensor_dims(
869
        const std::string & name,
870
        const std::vector<int64_t> & ne,
871
        bool required,
872
0
        bool allow_reshape) const {
873
0
    const struct ggml_tensor * cur = get_tensor_meta(name.c_str());
874
875
0
    if (cur == NULL) {
876
0
        if (!required) {
877
0
            return NULL;
878
0
        }
879
0
        throw std::runtime_error(format("%s: tensor '%s' not found", __func__, name.c_str()));
880
0
    }
881
882
0
    bool is_ok = true;
883
884
0
    if (allow_reshape) {
885
        // check total number of elements only
886
0
        const int64_t ncur = ggml_nelements(cur);
887
0
        int64_t nexp = 1;
888
0
        for (size_t i = 0; i < ne.size(); ++i) {
889
0
            nexp *= ne[i];
890
0
        }
891
0
        if (ncur != nexp) {
892
0
            is_ok = false;
893
0
        }
894
0
    } else {
895
0
        for (size_t i = 0; i < GGML_MAX_DIMS; ++i) {
896
0
            if ((i < ne.size() && ne[i] != cur->ne[i]) || (i >= ne.size() && cur->ne[i] != 1)) {
897
0
                is_ok = false;
898
0
                break;
899
0
            }
900
0
        }
901
0
    }
902
903
0
    if (!is_ok) {
904
0
        throw std::runtime_error(
905
0
                format("%s: tensor '%s' has wrong shape; expected %s, got %s",
906
0
                    __func__, name.c_str(),
907
0
                    llama_format_tensor_shape(ne).c_str(),
908
0
                    llama_format_tensor_shape(cur).c_str()));
909
0
    }
910
911
0
    return cur;
912
0
}
913
914
// checks if the weight tensor can be used with the specified buffer type and device
915
0
static bool weight_buft_supported(const llama_hparams & hparams, ggml_tensor * w, ggml_op op, ggml_backend_buffer_type_t buft, ggml_backend_dev_t dev) {
916
0
    GGML_ASSERT(w != nullptr);
917
918
0
    if (op == GGML_OP_NONE) {
919
0
        return true;
920
0
    }
921
922
0
    ggml_init_params params = {
923
0
        /*.mem_size   =*/ ggml_tensor_overhead()*8,
924
0
        /*.mem_buffer =*/ NULL,
925
0
        /*.no_alloc   =*/ true,
926
0
    };
927
0
    ggml_context_ptr ctx_ptr { ggml_init(params) };
928
0
    if (!ctx_ptr) {
929
0
        throw std::runtime_error(format("failed to create ggml context"));
930
0
    }
931
0
    ggml_context * ctx = ctx_ptr.get();
932
933
0
    ggml_tensor * op_tensor = nullptr;
934
935
0
    switch (op) {
936
0
        case GGML_OP_GET_ROWS:
937
0
            {
938
0
                ggml_tensor * b = ggml_new_tensor_1d(ctx, GGML_TYPE_I32, 512);
939
0
                op_tensor = ggml_get_rows(ctx, w, b);
940
0
            } break;
941
0
        case GGML_OP_MUL_MAT:
942
0
            {
943
0
                ggml_tensor * b = ggml_new_tensor_4d(ctx, GGML_TYPE_F32, w->ne[0], 512, w->ne[2], w->ne[3]);
944
0
                op_tensor = ggml_mul_mat(ctx, w, b);
945
0
            } break;
946
0
        case GGML_OP_MUL_MAT_ID:
947
0
            {
948
                // Used for either MoE expert routing or embedded adapter routing
949
0
                const int n_ids_used = hparams.router_layer >= 0 ? 1 : hparams.n_expert_used;
950
0
                GGML_ASSERT(n_ids_used > 0);
951
0
                ggml_tensor * b = ggml_new_tensor_3d(ctx, GGML_TYPE_F32, w->ne[0], n_ids_used, 512);
952
0
                ggml_tensor * ids = ggml_new_tensor_2d(ctx, GGML_TYPE_I32, n_ids_used, 512);
953
0
                op_tensor = ggml_mul_mat_id(ctx, w, b, ids);
954
0
            } break;
955
0
        case GGML_OP_ADD:
956
0
            {
957
0
                ggml_tensor * a = ggml_new_tensor_4d(ctx, GGML_TYPE_F32, w->ne[0], w->ne[1], w->ne[2], w->ne[3]);
958
0
                op_tensor = ggml_add(ctx, a, w);
959
0
            } break;
960
0
        case GGML_OP_ADD_ID:
961
0
            {
962
0
                const int n_expert_used = hparams.n_expert_used;
963
0
                GGML_ASSERT(n_expert_used > 0);
964
0
                ggml_tensor * a = ggml_new_tensor_3d(ctx, GGML_TYPE_F32, w->ne[0], n_expert_used, 512);
965
0
                ggml_tensor * c = ggml_new_tensor_2d(ctx, GGML_TYPE_I32, n_expert_used, 512);
966
0
                op_tensor = ggml_add_id(ctx, a, w, c);
967
0
            } break;
968
0
        case GGML_OP_MUL:
969
0
            {
970
0
                ggml_tensor * a = ggml_new_tensor_4d(ctx, GGML_TYPE_F32, w->ne[0], w->ne[1], w->ne[2], w->ne[3]);
971
0
                op_tensor = ggml_mul(ctx, a, w);
972
0
            } break;
973
0
        case GGML_OP_DIV:
974
0
            {
975
0
                ggml_tensor * a = ggml_new_tensor_1d(ctx, GGML_TYPE_F32, w->ne[0]);
976
0
                op_tensor = ggml_div(ctx, a, w);
977
0
            } break;
978
0
        case GGML_OP_ROPE:
979
0
            {
980
0
                const int n_embd_head = hparams.n_embd_head_v();
981
0
                const int n_head = hparams.n_head();
982
0
                ggml_tensor * a = ggml_new_tensor_3d(ctx, GGML_TYPE_F32, n_embd_head, n_head, 512);
983
0
                ggml_tensor * b = ggml_new_tensor_1d(ctx, GGML_TYPE_I32, 512);
984
0
                op_tensor = ggml_rope_ext(
985
0
                    ctx, a, b, w,
986
0
                    0, 0, 0, 0, 0,
987
0
                    0, 0, 0, 0
988
0
                );
989
990
0
            } break;
991
0
        case GGML_OP_SSM_CONV:
992
0
            {
993
0
                const int64_t n_seq_tokens = 512;
994
0
                const int64_t n_seqs       = 3;
995
0
                ggml_tensor * conv_x = ggml_new_tensor_3d(ctx, GGML_TYPE_F32, w->ne[0] - 1 + n_seq_tokens, w->ne[1], n_seqs);
996
0
                op_tensor = ggml_ssm_conv(ctx, conv_x, w);
997
0
            } break;
998
0
        case GGML_OP_SSM_SCAN:
999
0
            {
1000
                // w is ssm_a, which is used to distinguish Mamba-1 and Mamba-2
1001
0
                const int64_t d_state      = w->ne[0] == 1 ? hparams.ssm_d_state : w->ne[0];
1002
0
                const int64_t n_head       = w->ne[1];
1003
0
                const int64_t head_dim     = hparams.ssm_d_inner / n_head;
1004
0
                const int64_t n_group      = hparams.ssm_n_group ? hparams.ssm_n_group : 1;
1005
0
                const int64_t n_seq_tokens = 512;
1006
0
                const int64_t n_seqs       = 3;
1007
0
                ggml_tensor * s   = ggml_new_tensor_4d(ctx, GGML_TYPE_F32, d_state, head_dim, n_head, n_seqs);
1008
0
                ggml_tensor * x   = ggml_new_tensor_4d(ctx, GGML_TYPE_F32, head_dim, n_head, n_seq_tokens, n_seqs);
1009
0
                ggml_tensor * dt  = ggml_new_tensor_3d(ctx, GGML_TYPE_F32, n_head, n_seq_tokens, n_seqs);
1010
0
                ggml_tensor * B   = ggml_new_tensor_4d(ctx, GGML_TYPE_F32, d_state, n_group, n_seq_tokens, n_seqs);
1011
0
                ggml_tensor * C   = ggml_new_tensor_4d(ctx, GGML_TYPE_F32, d_state, n_group, n_seq_tokens, n_seqs);
1012
0
                ggml_tensor * ids = ggml_new_tensor_1d(ctx, GGML_TYPE_I32, n_seqs);
1013
0
                op_tensor = ggml_ssm_scan(ctx, s, x, dt, w, B, C, ids, /*K=*/1);
1014
0
            } break;
1015
0
        case GGML_OP_RWKV_WKV6:
1016
0
            {
1017
                // FIXME
1018
0
                const int64_t S = 123;
1019
0
                const int64_t H = 123;
1020
0
                const int64_t n_tokens = 123;
1021
0
                const int64_t n_seqs = 123;
1022
0
                ggml_tensor  * k = ggml_new_tensor_3d(ctx, GGML_TYPE_F32, S, H, n_tokens);
1023
0
                ggml_tensor  * v = ggml_new_tensor_3d(ctx, GGML_TYPE_F32, S, H, n_tokens);
1024
0
                ggml_tensor  * r = ggml_new_tensor_3d(ctx, GGML_TYPE_F32, S, H, n_tokens);
1025
0
                ggml_tensor  * tf = w;
1026
0
                ggml_tensor  * td = ggml_new_tensor_3d(ctx, GGML_TYPE_F32, S, H, n_tokens);
1027
0
                ggml_tensor  * state = ggml_new_tensor_4d(ctx, GGML_TYPE_F32, S, n_seqs, S, H);
1028
0
                op_tensor = ggml_rwkv_wkv6(ctx, k, v, r, tf, td, state);
1029
0
            } break;
1030
0
        case GGML_OP_IM2COL:
1031
0
            {
1032
0
                const int n_embd_inp = hparams.n_embd_inp();
1033
0
                ggml_tensor * b = ggml_new_tensor_4d(ctx, GGML_TYPE_F32, n_embd_inp, w->ne[1], 1, 1);
1034
0
                op_tensor = ggml_im2col(ctx, w, b, 1, 0, 0, 0, 1, 0, false, GGML_TYPE_F16);
1035
0
            } break;
1036
0
        case GGML_OP_SCALE:
1037
0
            {
1038
0
                op_tensor = ggml_scale(ctx, w, 1.0f);
1039
0
            } break;
1040
0
        default:
1041
0
            GGML_ABORT("%s: missing test for op %s for tensor %s", __func__, ggml_op_name(op), w->name);
1042
0
    }
1043
1044
    // create a temporary dummy buffer for the weight so that supports_op can check the buffer type
1045
0
    GGML_ASSERT(w->buffer == nullptr);
1046
0
    w->buffer = ggml_backend_buft_alloc_buffer(buft, 0);
1047
0
    bool op_supported = ggml_backend_dev_supports_op(dev, op_tensor);
1048
0
    ggml_backend_buffer_free(w->buffer);
1049
0
    w->buffer = nullptr;
1050
1051
0
    return op_supported;
1052
0
}
1053
1054
// find the first buffer type in the list that can use the tensor
1055
0
static ggml_backend_buffer_type_t select_weight_buft(const llama_hparams & hparams, ggml_tensor * tensor, ggml_op op, const buft_list_t * buft_list) {
1056
0
    GGML_ASSERT(!buft_list->empty());
1057
0
    for (const auto & cur : *buft_list) {
1058
0
        ggml_backend_dev_t cur_dev = cur.first;
1059
0
        ggml_backend_buffer_type_t cur_buft = cur.second;
1060
0
        if (weight_buft_supported(hparams, tensor, op, cur_buft, cur_dev)) {
1061
0
            return cur_buft;
1062
0
        }
1063
0
    }
1064
1065
0
    return nullptr;
1066
0
}
1067
1068
struct ggml_tensor * llama_model_loader::create_tensor(
1069
        const llama_hparams & hparams, const buft_list_t * buft_list_cpu, const buft_list_t * buft_list_input, const buft_list_t * buft_list_output,
1070
0
        const buft_list_t * buft_list_layer, const LLM_TN_IMPL & tn, const std::initializer_list<int64_t> & ne, int flags) {
1071
0
    auto ctx_for_buft = [&](ggml_backend_buffer_type_t buft) -> ggml_context * {
1072
0
        auto it = ctx_map.find(buft);
1073
0
        if (it == ctx_map.end()) {
1074
            // one ggml context per buffer type
1075
0
            int max_n_tensors = n_tensors;
1076
0
            max_n_tensors += 1;                   // duplicated output tensor
1077
0
            max_n_tensors += hparams.n_layer()*2; // duplicated rope freq tensors
1078
0
            if (files.empty()) {
1079
0
                max_n_tensors += hparams.n_layer()*256; // this should be well above what any model actually uses
1080
0
            }
1081
0
            const size_t ctx_size = ggml_tensor_overhead()*max_n_tensors;
1082
1083
0
            ggml_init_params params = {
1084
0
                /*.mem_size   =*/ ctx_size,
1085
0
                /*.mem_buffer =*/ NULL,
1086
0
                /*.no_alloc   =*/ true,
1087
0
            };
1088
1089
0
            ggml_context * ctx = ggml_init(params);
1090
0
            if (!ctx) {
1091
0
                throw std::runtime_error(format("failed to create ggml context"));
1092
0
            }
1093
1094
0
            ctx_map.emplace(buft, ctx);
1095
1096
0
            return ctx;
1097
0
        }
1098
0
        return it->second.get();
1099
0
    };
1100
1101
0
    auto buft_for_tensor = [&](ggml_tensor * t_meta) -> ggml_backend_buffer_type_t {
1102
0
        if (!t_meta) {
1103
0
            if (flags & TENSOR_NOT_REQUIRED) {
1104
0
                return nullptr;
1105
0
            }
1106
0
            throw std::runtime_error(format("missing tensor '%s'", tn.str().c_str()));
1107
0
        }
1108
1109
        // some models use the token embedding tensor as the output, but since these are used in different layers and with different ops
1110
        // the tensor is duplicated
1111
        // to handle this, we check if the tensor is duplicated, and if so, we assume that it is being loaded as the output tensor
1112
0
        llm_tensor tn_tensor = tn.tensor;
1113
0
        if (tn.tensor == LLM_TENSOR_TOKEN_EMBD && (flags & TENSOR_DUPLICATED)) {
1114
0
            tn_tensor = LLM_TENSOR_OUTPUT;
1115
0
        }
1116
1117
0
        llm_tensor_info info;
1118
0
        try {
1119
0
            info = llm_tensor_info_for(tn_tensor);
1120
0
        } catch (const std::out_of_range & e) {
1121
0
            throw std::runtime_error(format("missing tensor info mapping for %s", tn.str().c_str()));
1122
0
        }
1123
1124
        // skip unused tensors
1125
0
        if (info.op == GGML_OP_NONE || (flags & TENSOR_SKIP)) {
1126
0
            const size_t nbytes = ggml_nbytes(t_meta);
1127
0
            LLAMA_LOG_WARN("model has unused tensor %s (size = %zu bytes) -- ignoring\n", tn.str().c_str(), nbytes);
1128
1129
0
            size_data -= nbytes;
1130
0
            n_created++;
1131
1132
0
            return nullptr;
1133
0
        }
1134
1135
        // tensors with "bias" suffix are always used with GGML_OP_ADD or GGML_OP_ADD_ID;
1136
        // embedded-adapter ".lora_a"/".lora_b" tensors are always used with GGML_OP_MUL_MAT_ID
1137
0
        ggml_op op;
1138
0
        if (tn.suffix != nullptr && strcmp(tn.suffix, "bias") == 0) {
1139
0
            op = info.op == GGML_OP_MUL_MAT_ID ? GGML_OP_ADD_ID : GGML_OP_ADD;
1140
0
        } else if (hparams.router_layer >= 0 && tn.suffix != nullptr &&
1141
0
                (strcmp(tn.suffix, "lora_a") == 0 || strcmp(tn.suffix, "lora_b") == 0)) {
1142
0
            op = GGML_OP_MUL_MAT_ID;
1143
0
        } else {
1144
0
            op = info.op;
1145
0
        }
1146
1147
        // sanity checks
1148
0
        if (info.layer == LLM_TENSOR_LAYER_INPUT || info.layer == LLM_TENSOR_LAYER_OUTPUT) {
1149
0
            if (tn.bid != -1) {
1150
0
                GGML_ABORT("input/output layer tensor %s used with a layer number", tn.str().c_str());
1151
0
            }
1152
0
        } else {
1153
0
            if (tn.bid == -1) {
1154
0
                GGML_ABORT("repeating layer tensor %s used without a layer number", tn.str().c_str());
1155
0
            }
1156
0
        }
1157
1158
        // select the buffer type for this tensor
1159
0
        const buft_list_t * buft_list;
1160
0
        switch (info.layer) {
1161
0
            case LLM_TENSOR_LAYER_INPUT:
1162
0
                buft_list = buft_list_input;
1163
0
                break;
1164
0
            case LLM_TENSOR_LAYER_OUTPUT:
1165
0
                buft_list = buft_list_output;
1166
0
                break;
1167
0
            case LLM_TENSOR_LAYER_REPEATING:
1168
0
                GGML_ASSERT(buft_list_layer != nullptr);
1169
0
                buft_list = buft_list_layer;
1170
0
                break;
1171
0
            default:
1172
0
                GGML_ABORT("invalid layer %d for tensor %s", info.layer, tn.str().c_str());
1173
0
        }
1174
1175
0
        ggml_backend_buffer_type_t buft = nullptr;
1176
1177
        // check overrides
1178
0
        if (tensor_buft_overrides) {
1179
0
            std::string tensor_name = tn.str();
1180
0
            for (const auto * overrides = tensor_buft_overrides; overrides->pattern != nullptr; ++overrides) {
1181
0
                std::regex pattern(overrides->pattern);
1182
0
                if (std::regex_search(tensor_name, pattern)) {
1183
0
                    if (overrides->buft == ggml_backend_cpu_buffer_type()) {
1184
                        // when overriding to a CPU buffer, consider the extra buffer types
1185
0
                        buft = select_weight_buft(hparams, t_meta, op, buft_list_cpu);
1186
0
                        if (use_mmap) {
1187
0
                            static std::once_flag once;
1188
0
                            std::call_once(once, [] {
1189
0
                                LLAMA_LOG_WARN("llama_model_loader: tensor overrides to CPU are used with mmap enabled - consider using --load-mode none for better performance\n");
1190
0
                            });
1191
0
                        }
1192
0
                    } else {
1193
0
                        buft = overrides->buft;
1194
0
                    }
1195
1196
0
                    LLAMA_LOG_DEBUG("tensor %s (%zu MiB %s) buffer type overridden to %s\n",
1197
0
                            tensor_name.c_str(),
1198
0
                            ggml_nbytes(t_meta) / 1024 / 1024, ggml_type_name(t_meta->type),
1199
0
                            ggml_backend_buft_name(buft));
1200
0
                    break;
1201
0
                }
1202
0
            }
1203
0
        }
1204
1205
0
        if (!buft) {
1206
0
            buft = select_weight_buft(hparams, t_meta, op, buft_list);
1207
0
            if (!buft) {
1208
0
                throw std::runtime_error(format("failed to find a compatible buffer type for tensor %s", tn.str().c_str()));
1209
0
            }
1210
0
        }
1211
1212
        // avoid using a host buffer when using mmap
1213
0
        auto * buft_dev = ggml_backend_buft_get_device(buft);
1214
0
        if (use_mmap && buft_dev && buft == ggml_backend_dev_host_buffer_type(buft_dev)) {
1215
0
            auto * cpu_dev = ggml_backend_dev_by_type(GGML_BACKEND_DEVICE_TYPE_CPU);
1216
0
            if (!cpu_dev) {
1217
0
                throw std::runtime_error("no CPU backend found");
1218
0
            }
1219
0
            buft = ggml_backend_dev_buffer_type(cpu_dev);
1220
0
        }
1221
1222
0
        if (buft != buft_list->front().second) {
1223
0
            if (n_tensors_moved == 0) {
1224
0
                first_tensor_moved_name = t_meta->name;
1225
0
                first_tensor_moved_type_name = ggml_type_name(t_meta->type);
1226
0
                first_moved_from_buft = buft_list->front().second;
1227
0
                first_moved_to_buft   = buft;
1228
0
            }
1229
0
            n_tensors_moved++;
1230
0
        }
1231
1232
0
        return buft;
1233
0
    };
1234
1235
0
    if (files.empty()) {
1236
0
        if (flags & TENSOR_SKIP_IF_VIRTUAL) {
1237
0
            return nullptr;
1238
0
        }
1239
0
        ggml_type type = GGML_TYPE_F32;
1240
0
        const int64_t tid = gguf_find_tensor(metadata, tn.str().c_str());
1241
0
        if (tid != -1) {
1242
0
            type = gguf_get_tensor_type(metadata, tid);
1243
0
        }
1244
1245
        // for tensors that are not required some of the dimensions can be invalid:
1246
0
        if (flags & TENSOR_NOT_REQUIRED) {
1247
0
            for (size_t dim = 0; dim < ne.size(); dim++) {
1248
0
                if (ne.begin()[dim] <= 0) {
1249
0
                    return nullptr;
1250
0
                }
1251
0
            }
1252
0
        }
1253
1254
0
        ggml_tensor t_meta;
1255
0
        memset(&t_meta, 0, sizeof(ggml_tensor));
1256
0
        t_meta.type = type;
1257
0
        for (size_t dim = 0; dim < GGML_MAX_DIMS; dim++) {
1258
0
            t_meta.ne[dim] = dim < ne.size() ? ne.begin()[dim] : 1;
1259
0
            GGML_ASSERT(t_meta.ne[dim] >= 1);
1260
0
            if (dim == 0) {
1261
0
                t_meta.nb[dim] = ggml_type_size(type);
1262
0
            } else if (dim == 1) {
1263
0
                t_meta.nb[dim] = ggml_row_size(type, t_meta.ne[dim-1]);
1264
0
            } else {
1265
0
                t_meta.nb[dim] = t_meta.nb[dim-1]*t_meta.ne[dim-1];
1266
0
            }
1267
0
            GGML_ASSERT(t_meta.nb[dim] >= 1);
1268
0
        }
1269
0
        ggml_set_name(&t_meta, tn.str().c_str());
1270
1271
0
        ggml_backend_buffer_type_t buft = buft_for_tensor(&t_meta);
1272
0
        GGML_ASSERT(buft != nullptr);
1273
0
        ggml_context * ctx = ctx_for_buft(buft);
1274
0
        ggml_tensor * ret = ggml_dup_tensor(ctx, &t_meta);
1275
0
        ggml_set_name(ret, tn.str().c_str());
1276
0
        return ret;
1277
0
    }
1278
1279
0
    LLAMA_LOG_DEBUG("%s: loading tensor %s\n", __func__, tn.str().c_str());
1280
0
    const struct ggml_tensor * cur = check_tensor_dims(tn.str(), ne, !(flags & TENSOR_NOT_REQUIRED), flags & TENSOR_ALLOW_RESHAPE);
1281
0
    if (cur == NULL) {
1282
0
        return NULL;
1283
0
    }
1284
1285
0
    ggml_tensor t_meta = *cur;
1286
0
    if (flags & TENSOR_ALLOW_RESHAPE) {
1287
0
        for (size_t dim = 0; dim < GGML_MAX_DIMS; dim++) {
1288
0
            t_meta.ne[dim] = dim < ne.size() ? ne.begin()[dim] : 1;
1289
0
            if (dim == 0) {
1290
0
                t_meta.nb[dim] = ggml_type_size(t_meta.type);
1291
0
            } else if (dim == 1) {
1292
0
                t_meta.nb[dim] = ggml_row_size(t_meta.type, t_meta.ne[dim-1]);
1293
0
            } else {
1294
0
                t_meta.nb[dim] = t_meta.ne[dim-1]*t_meta.nb[dim-1];
1295
0
            }
1296
0
        }
1297
0
    }
1298
1299
0
    GGML_ASSERT(ggml_nbytes(&t_meta) == ggml_nbytes(cur));
1300
1301
0
    ggml_backend_buffer_type_t buft = buft_for_tensor(&t_meta);
1302
0
    if (buft == nullptr) {
1303
0
        return nullptr;
1304
0
    }
1305
1306
0
    ggml_context * ctx = ctx_for_buft(buft);
1307
1308
    // if duplicated, check if the original tensor was allocated in the same buffer type context and avoid creating a new one
1309
0
    if (flags & TENSOR_DUPLICATED) {
1310
0
        ggml_tensor * t = ggml_get_tensor(ctx, tn.str().c_str());
1311
0
        if (t) {
1312
0
            return t;
1313
0
        }
1314
0
    }
1315
1316
0
    const bool duplicated = flags & TENSOR_DUPLICATED;
1317
1318
0
    struct ggml_tensor * tensor = ggml_dup_tensor(ctx, &t_meta);
1319
0
    ggml_set_name(tensor, ggml_get_name(&t_meta));
1320
1321
0
    if (duplicated) {
1322
0
        size_data += ggml_nbytes(&t_meta);
1323
0
    } else {
1324
0
        n_created++;
1325
0
    }
1326
1327
0
    return tensor;
1328
0
}
1329
1330
0
void llama_model_loader::done_getting_tensors(bool partial) const {
1331
0
    if (n_created > n_tensors) {
1332
0
        throw std::runtime_error(format("%s: too many tensors created; expected %d, got %d", __func__, n_tensors, n_created));
1333
0
    }
1334
0
    if (n_created < n_tensors) {
1335
0
        if (!partial) {
1336
0
            throw std::runtime_error(format("%s: wrong number of tensors; expected %d, got %d", __func__, n_tensors, n_created));
1337
0
        }
1338
0
        LLAMA_LOG_INFO("%s: partial load — used %d of %d tensors in the file (rest belong to a sibling model on the same .gguf)\n",
1339
0
                __func__, n_created, n_tensors);
1340
0
    }
1341
0
    if (n_tensors_moved > 0) {
1342
0
        LLAMA_LOG_DEBUG("%s: tensor '%s' (%s) (and %zu others) cannot be used with preferred buffer type %s, using %s instead\n",
1343
0
            __func__, first_tensor_moved_name.c_str(), first_tensor_moved_type_name.c_str(), n_tensors_moved - 1,
1344
0
            ggml_backend_buft_name(first_moved_from_buft), ggml_backend_buft_name(first_moved_to_buft));
1345
0
    }
1346
0
}
1347
1348
0
void llama_model_loader::init_mappings(bool prefetch, llama_mlocks * mlock_mmaps) {
1349
0
    if (use_mmap) {
1350
0
        mappings.reserve(files.size());
1351
0
        mmaps_used.reserve(files.size());
1352
0
        for (const auto & file : files) {
1353
0
            bool is_numa = false;
1354
1355
0
            auto * dev = ggml_backend_dev_by_type(GGML_BACKEND_DEVICE_TYPE_CPU);
1356
0
            if (dev) {
1357
0
                auto * reg = ggml_backend_dev_backend_reg(dev);
1358
0
                auto * is_numa_fn = (decltype(ggml_is_numa) *) ggml_backend_reg_get_proc_address(reg, "ggml_backend_cpu_is_numa");
1359
0
                if (is_numa_fn) {
1360
0
                    is_numa = is_numa_fn();
1361
0
                }
1362
0
            }
1363
1364
0
            std::unique_ptr<llama_mmap> mapping = std::make_unique<llama_mmap>(file.get(), prefetch ? -1 : 0, is_numa);
1365
0
            mmaps_used.emplace_back(mapping->size(), 0);
1366
0
            if (mlock_mmaps) {
1367
0
                std::unique_ptr<llama_mlock> mlock_mmap(new llama_mlock());
1368
0
                mlock_mmap->init(mapping->addr());
1369
0
                mlock_mmaps->emplace_back(std::move(mlock_mmap));
1370
0
            }
1371
0
            mappings.emplace_back(std::move(mapping));
1372
0
        }
1373
0
    }
1374
1375
    // compute the total size of all tensors for progress reporting
1376
0
    for (const auto & it : weights_map) {
1377
0
        size_data += ggml_nbytes(it.second.tensor);
1378
0
    }
1379
0
}
1380
1381
0
void llama_model_loader::get_mapping_range(size_t * first, size_t * last, void ** addr, int idx, ggml_context * ctx) const {
1382
0
    GGML_ASSERT(!mappings.empty());
1383
0
    const auto & mapping = mappings.at(idx);
1384
1385
0
    *first = mapping->size();
1386
0
    *last  = 0;
1387
0
    *addr = mapping->addr();
1388
0
    for (ggml_tensor * tensor = ggml_get_first_tensor(ctx); tensor; tensor = ggml_get_next_tensor(ctx, tensor)) {
1389
0
        const auto * weight = get_weight(ggml_get_name(tensor));
1390
0
        if (!weight || weight->idx != idx) {
1391
0
            continue;
1392
0
        }
1393
0
        *first = std::min(*first, weight->offs);
1394
0
        *last  = std::max(*last,  weight->offs + ggml_nbytes(tensor));
1395
0
    }
1396
0
}
1397
1398
0
void llama_model_loader::unmap_weight(const llama_tensor_weight & w) const {
1399
0
    if (!use_mmap) { return; }
1400
0
    mappings.at(w.idx)->unmap_fragment(w.offs, w.offs + ggml_nbytes(w.tensor));
1401
0
}
1402
1403
0
void llama_model_loader::load_data_for(struct ggml_tensor * cur) const {
1404
0
    const auto & w = require_weight(ggml_get_name(cur));
1405
1406
0
    if (use_mmap) {
1407
0
        const auto & mapping = mappings.at(w.idx);
1408
0
        if (cur->data == nullptr) {
1409
0
            cur->data = (uint8_t *)mapping->addr() + w.offs;
1410
0
        } else {
1411
0
            memcpy(cur->data, (uint8_t *)mapping->addr() + w.offs, ggml_nbytes(cur));
1412
0
        }
1413
0
    } else {
1414
0
        GGML_ASSERT(cur->data != nullptr);
1415
0
        GGML_ASSERT(w.idx < files.size());
1416
0
        const auto & file = files.at(w.idx);
1417
0
        file->seek(w.offs, SEEK_SET);
1418
0
        file->read_raw(cur->data, ggml_nbytes(cur));
1419
0
    }
1420
1421
0
    if (check_tensors && !ggml_validate_row_data(cur->type, cur->data, ggml_nbytes(cur))) {
1422
0
        throw std::runtime_error(format("tensor '%s' has invalid data", ggml_get_name(cur)));
1423
0
    }
1424
0
}
1425
1426
bool llama_model_loader::load_all_data(
1427
        struct ggml_context * ctx,
1428
        llama_buf_map & bufs,
1429
        llama_mlocks * lmlocks,
1430
        llama_progress_callback progress_callback,
1431
0
        void * progress_callback_user_data) {
1432
0
    if (files.empty()) {
1433
0
        for (ggml_tensor * t = ggml_get_first_tensor(ctx); t != nullptr; t = ggml_get_next_tensor(ctx, t)) {
1434
0
            set_tensor_data(t, set_tensor_data_ud);
1435
0
        }
1436
0
        return true;
1437
0
    }
1438
0
    GGML_ASSERT(size_data != 0 && "call init_mappings() first");
1439
1440
0
    std::vector<no_init<uint8_t>> read_buf;
1441
0
    std::vector<std::future<std::pair<ggml_tensor *, bool>>> validation_result;
1442
1443
    // 4 staging buffers for async uploads, each sized 1MB seems to be a good default for single NVMe drives.
1444
    // NVMe raid configurations might require more / larger buffers.
1445
0
    constexpr size_t n_buffers = 4;
1446
1447
0
    size_t alignment = 1;
1448
0
    for (const auto & file : files) {
1449
0
        alignment = std::max(file->read_alignment(), alignment);
1450
0
    }
1451
1452
    // Buffer size: balance between memory usage and I/O efficiency
1453
    // 64MB works well for NVMe drives
1454
0
    const size_t buffer_size = alignment != 1 ? 64 * 1024 * 1024 + 2 * alignment : 1 * 1024 * 1024;
1455
1456
0
    std::vector<ggml_backend_buffer_t> host_buffers;
1457
0
    std::vector<ggml_backend_event_t> events;
1458
0
    std::vector<void *> host_ptrs;
1459
0
    size_t buffer_idx = 0; // buffer to use for async loads
1460
0
    ggml_backend_t upload_backend = [&](const char * func) -> ggml_backend_t {
1461
0
        if (use_mmap || check_tensors) {
1462
0
            return nullptr;
1463
0
        }
1464
        // When not using mmaped io use async uploads from pinned memory to GPU memory.
1465
        // First determine if the backend supports the necessary features for async uploads.
1466
0
        auto * buf = bufs.count(0) ? bufs.at(0) : nullptr;
1467
0
        if (!buf) {
1468
0
            LLAMA_LOG_DEBUG("%s: no buffer found for async uploads\n", func);
1469
0
            return nullptr;
1470
0
        }
1471
1472
0
        auto * buft = ggml_backend_buffer_get_type(buf);
1473
0
        auto * dev = ggml_backend_buft_get_device(buft);
1474
0
        if (!dev) {
1475
0
            LLAMA_LOG_DEBUG("%s: no device found for buffer type %s for async uploads\n", func,
1476
0
                ggml_backend_buft_name(buft));
1477
0
            return nullptr;
1478
0
        }
1479
1480
0
        if (buft != ggml_backend_dev_buffer_type(dev)) {
1481
0
            LLAMA_LOG_DEBUG("%s: buffer type %s is not the default buffer type for device %s for async uploads\n", func,
1482
0
                ggml_backend_buft_name(buft), ggml_backend_dev_name(dev));
1483
0
            return nullptr;
1484
0
        }
1485
1486
0
        ggml_backend_dev_props props;
1487
0
        ggml_backend_dev_get_props(dev, &props);
1488
0
        if (!props.caps.async || !props.caps.host_buffer || !props.caps.events) {
1489
0
            LLAMA_LOG_DEBUG("%s: device %s does not support async, host buffers or events\n", func,
1490
0
                ggml_backend_dev_name(dev));
1491
0
            return nullptr;
1492
0
        }
1493
1494
0
        auto * host_buft = ggml_backend_dev_host_buffer_type(dev);
1495
0
        if (!host_buft) {
1496
0
            LLAMA_LOG_DEBUG("%s: no host buffer type found for device %s\n", func,
1497
0
                ggml_backend_dev_name(dev));
1498
0
            return nullptr;
1499
0
        }
1500
1501
        // If the backend is supported, create pinned memory buffers and events for synchronisation.
1502
0
        for (size_t idx = 0; idx < n_buffers; ++idx) {
1503
0
            auto * buf = ggml_backend_buft_alloc_buffer(host_buft, buffer_size);
1504
1505
0
            if (!buf) {
1506
0
                LLAMA_LOG_DEBUG("%s: failed to allocate host buffer for async uploads for device %s\n", func,
1507
0
                    ggml_backend_dev_name(dev));
1508
0
                return nullptr;
1509
0
            }
1510
1511
0
            host_buffers.emplace_back(buf);
1512
0
            host_ptrs.emplace_back(ggml_backend_buffer_get_base(buf));
1513
1514
0
            auto * event = ggml_backend_event_new(dev);
1515
0
            if (!event) {
1516
0
                LLAMA_LOG_DEBUG("%s: failed to create event for async uploads for device %s\n", func,
1517
0
                    ggml_backend_dev_name(dev));
1518
0
                return nullptr;
1519
0
            }
1520
1521
0
            events.emplace_back(event);
1522
0
        }
1523
1524
0
        ggml_backend_t backend = ggml_backend_dev_init(dev, nullptr);
1525
0
        if (!backend) {
1526
0
            LLAMA_LOG_DEBUG("%s: failed to initialize backend for device %s for async uploads\n", func,
1527
0
                ggml_backend_dev_name(dev));
1528
0
            return nullptr;
1529
0
        }
1530
1531
0
        return backend;
1532
0
    }(__func__);
1533
1534
0
    if (upload_backend) {
1535
0
        LLAMA_LOG_DEBUG("%s: using async uploads for device %s, buffer type %s, backend %s\n", __func__,
1536
0
            ggml_backend_dev_name(ggml_backend_get_device(upload_backend)),
1537
0
            ggml_backend_buft_name(ggml_backend_buffer_get_type(bufs.at(0))),
1538
0
            ggml_backend_name(upload_backend));
1539
0
    }
1540
1541
0
    for (struct ggml_tensor * cur = ggml_get_first_tensor(ctx); cur != NULL; cur = ggml_get_next_tensor(ctx, cur)) {
1542
0
        const auto * weight = get_weight(ggml_get_name(cur));
1543
0
        if (weight == nullptr) {
1544
            // this can happen with split experts models
1545
0
            continue;
1546
0
        }
1547
1548
0
        if (progress_callback) {
1549
0
            if (!progress_callback((float) size_done / size_data, progress_callback_user_data)) {
1550
0
                return false;
1551
0
            }
1552
0
        }
1553
1554
0
        size_t n_size = ggml_nbytes(cur);
1555
1556
0
        if (use_mmap) {
1557
0
            const auto & mapping = mappings.at(weight->idx);
1558
0
            ggml_backend_buffer_t buf_mmap = nullptr;
1559
0
            if (bufs.count(weight->idx)) {
1560
0
                buf_mmap = bufs.at(weight->idx);
1561
0
            }
1562
0
            uint8_t * data = (uint8_t *) mapping->addr() + weight->offs;
1563
1564
0
            if (check_tensors) {
1565
0
                validation_result.emplace_back(std::async(std::launch::async, [cur, data, n_size] {
1566
0
                    return std::make_pair(cur, ggml_validate_row_data(cur->type, data, n_size));
1567
0
                }));
1568
0
            }
1569
1570
0
            GGML_ASSERT(buf_mmap || cur->data); // either we have a buffer to allocate the tensor in, or it is already allocated
1571
0
            if (buf_mmap && cur->data == nullptr) {
1572
0
                ggml_backend_tensor_alloc(buf_mmap, cur, data);
1573
0
                if (lmlocks) {
1574
0
                    const auto & lmlock = lmlocks->at(weight->idx);
1575
0
                    lmlock->grow_to(weight->offs + n_size);
1576
0
                }
1577
1578
0
                auto & mmap_used = mmaps_used[weight->idx];
1579
0
                mmap_used.first  = std::min(mmap_used.first,  weight->offs);
1580
0
                mmap_used.second = std::max(mmap_used.second, weight->offs + n_size);
1581
0
            } else {
1582
0
                ggml_backend_tensor_set(cur, data, 0, n_size);
1583
0
            }
1584
0
        } else {
1585
0
            const auto & file = files.at(weight->idx);
1586
1587
0
            if (ggml_backend_buffer_is_host(cur->buffer)) {
1588
0
                file->seek(weight->offs, SEEK_SET);
1589
0
                file->read_raw(cur->data, n_size);
1590
0
                if (check_tensors) {
1591
0
                    validation_result.emplace_back(std::async(std::launch::async, [cur, n_size] {
1592
0
                        return std::make_pair(cur, ggml_validate_row_data(cur->type, cur->data, n_size));
1593
0
                    }));
1594
0
                }
1595
0
            } else {
1596
                // If upload_backend is valid load the tensor in chunks to pinned memory and upload the buffers asynchronously to the GPU.
1597
0
                if (upload_backend) {
1598
0
                    size_t offset = weight->offs;
1599
0
                    alignment = file->read_alignment();
1600
0
                    size_t aligned_offset = offset & ~(alignment - 1);
1601
0
                    size_t offset_from_alignment = offset - aligned_offset;
1602
0
                    file->seek(aligned_offset, SEEK_SET);
1603
1604
                    // Calculate aligned read boundaries
1605
0
                    size_t read_start = aligned_offset;
1606
0
                    size_t read_end = (offset + n_size + alignment - 1) & ~(alignment - 1);
1607
1608
0
                    size_t bytes_read = 0;
1609
0
                    size_t data_read = 0;  // Actual tensor data copied (excluding padding)
1610
1611
0
                    while (bytes_read < read_end - read_start) {
1612
0
                        size_t read_size = std::min<size_t>(buffer_size, read_end - read_start - bytes_read);
1613
1614
                        // Align the destination pointer within the pinned buffer
1615
0
                        uintptr_t ptr_dest_aligned = (reinterpret_cast<uintptr_t>(host_ptrs[buffer_idx]) + alignment - 1) & ~(alignment - 1);
1616
1617
                        // Wait for previous upload to complete before reusing buffer
1618
0
                        ggml_backend_event_synchronize(events[buffer_idx]);
1619
1620
                        // Read aligned chunk from file
1621
0
                        file->read_raw_unsafe(reinterpret_cast<void *>(ptr_dest_aligned), read_size);
1622
1623
                        // Calculate actual data portion (excluding alignment padding)
1624
0
                        uintptr_t ptr_data = ptr_dest_aligned;
1625
0
                        size_t data_to_copy = read_size;
1626
1627
                        // Skip alignment padding at start of first chunk
1628
0
                        if (bytes_read == 0) {
1629
0
                            ptr_data += offset_from_alignment;
1630
0
                            data_to_copy -= offset_from_alignment;
1631
0
                        }
1632
1633
                        // Trim alignment padding at end of last chunk
1634
0
                        if (aligned_offset + bytes_read + read_size > offset + n_size) {
1635
0
                            data_to_copy -= (read_end - (offset + n_size));
1636
0
                        }
1637
1638
                        // Async upload actual data to GPU
1639
0
                        ggml_backend_tensor_set_async(upload_backend, cur,
1640
0
                                                      reinterpret_cast<void *>(ptr_data), data_read, data_to_copy);
1641
0
                        ggml_backend_event_record(events[buffer_idx], upload_backend);
1642
1643
0
                        data_read += data_to_copy;
1644
0
                        bytes_read += read_size;
1645
1646
0
                        ++buffer_idx;
1647
0
                        buffer_idx %= n_buffers;
1648
0
                    }
1649
0
                } else {
1650
0
                    read_buf.resize(n_size);
1651
0
                    file->seek(weight->offs, SEEK_SET);
1652
0
                    file->read_raw(read_buf.data(), n_size);
1653
0
                    ggml_backend_tensor_set(cur, read_buf.data(), 0, n_size);
1654
0
                    if (check_tensors && !ggml_validate_row_data(cur->type, read_buf.data(), n_size)) {
1655
0
                        throw std::runtime_error(format("tensor '%s' has invalid data", ggml_get_name(cur)));
1656
0
                    }
1657
0
                }
1658
0
            }
1659
0
        }
1660
1661
0
        size_done += n_size;
1662
0
    }
1663
1664
    // free temporary resources used for async uploads
1665
0
    for (auto * event : events) {
1666
0
        ggml_backend_event_synchronize(event);
1667
0
        ggml_backend_event_free(event);
1668
0
    }
1669
0
    for (auto * buf : host_buffers) {
1670
0
        ggml_backend_buffer_free(buf);
1671
0
    }
1672
0
    ggml_backend_free(upload_backend);
1673
1674
    // check validation results
1675
0
    bool validation_failed = false;
1676
0
    for (auto & future : validation_result) {
1677
0
        auto result = future.get();
1678
0
        if (!result.second) {
1679
0
            LLAMA_LOG_ERROR("%s: tensor '%s' has invalid data\n", __func__, ggml_get_name(result.first));
1680
0
            validation_failed = true;
1681
0
        }
1682
0
    }
1683
0
    if (validation_failed) {
1684
0
        throw std::runtime_error("found tensors with invalid data");
1685
0
    }
1686
1687
    // check if this is the last call and do final cleanup
1688
0
    if (size_done >= size_data) {
1689
        // unmap offloaded tensors and metadata
1690
0
        if (use_mmap) {
1691
0
            for (uint32_t idx = 0; idx < mappings.size(); idx++) {
1692
0
                const auto & mmap_used = mmaps_used.at(idx);
1693
0
                auto & mapping = mappings.at(idx);
1694
0
                mapping->unmap_fragment(0, mmap_used.first);
1695
0
                if (mmap_used.second != 0) {
1696
0
                    mapping->unmap_fragment(mmap_used.second, mapping->size());
1697
0
                }
1698
0
            }
1699
0
        }
1700
0
        if (progress_callback) {
1701
            // Even though the model is done loading, we still honor
1702
            // cancellation since we need to free allocations.
1703
0
            return progress_callback(1.0f, progress_callback_user_data);
1704
0
        }
1705
0
    }
1706
1707
0
    return true;
1708
0
}
1709
1710
0
std::string llama_model_loader::ftype_name() const {
1711
0
    return llama_ftype_name(ftype);
1712
0
}
1713
1714
2.96k
void llama_model_loader::print_info() const {
1715
2.96k
    LLAMA_LOG_INFO("%s: file format = %s\n", __func__, llama_file_version_name(fver));
1716
2.96k
    LLAMA_LOG_INFO("%s: file type   = %s\n", __func__, llama_ftype_name(ftype));
1717
2.96k
    if (n_bytes < GiB) {
1718
2.96k
        LLAMA_LOG_INFO("%s: file size   = %.2f MiB (%.2f BPW) \n", __func__, n_bytes/1024.0/1024.0,        n_bytes*8.0/n_elements);
1719
2.96k
    } else {
1720
0
        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);
1721
0
    }
1722
2.96k
}