Coverage Report

Created: 2026-01-17 06:04

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/llama.cpp/src/llama-mmap.cpp
Line
Count
Source
1
#include "llama-mmap.h"
2
3
#include "llama-impl.h"
4
5
#include "ggml.h"
6
7
#include <cstring>
8
#include <climits>
9
#include <stdexcept>
10
#include <cerrno>
11
#include <algorithm>
12
13
#ifdef __has_include
14
    #if __has_include(<unistd.h>)
15
        #include <unistd.h>
16
        #include <fcntl.h>
17
        #include <sys/stat.h>
18
        #if defined(_POSIX_MAPPED_FILES)
19
            #include <sys/mman.h>
20
        #endif
21
        #if defined(_POSIX_MEMLOCK_RANGE)
22
            #include <sys/resource.h>
23
        #endif
24
    #endif
25
#endif
26
27
#if defined(_WIN32)
28
    #define WIN32_LEAN_AND_MEAN
29
    #ifndef NOMINMAX
30
        #define NOMINMAX
31
    #endif
32
    #include <windows.h>
33
    #ifndef PATH_MAX
34
        #define PATH_MAX MAX_PATH
35
    #endif
36
    #include <io.h>
37
#endif
38
39
#if defined(__APPLE__)
40
#include <TargetConditionals.h>
41
#endif
42
43
// TODO: consider moving to llama-impl.h if needed in more places
44
#if defined(_WIN32)
45
static std::string llama_format_win_err(DWORD err) {
46
    LPSTR buf;
47
    size_t size = FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
48
                                 NULL, err, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPSTR)&buf, 0, NULL);
49
    if (!size) {
50
        return "FormatMessageA failed";
51
    }
52
    std::string ret(buf, size);
53
    LocalFree(buf);
54
    return ret;
55
}
56
#endif
57
58
// llama_file
59
60
struct llama_file::impl {
61
#if defined(_WIN32)
62
    HANDLE fp_win32;
63
    std::string GetErrorMessageWin32(DWORD error_code) const {
64
        std::string ret;
65
        LPSTR lpMsgBuf = NULL;
66
        DWORD bufLen = FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
67
                                    NULL, error_code, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPSTR)&lpMsgBuf, 0, NULL);
68
        if (!bufLen) {
69
            ret = format("Win32 error code: %lx", error_code);
70
        } else {
71
            ret = lpMsgBuf;
72
            LocalFree(lpMsgBuf);
73
        }
74
75
        return ret;
76
    }
77
78
    impl(const char * fname, const char * mode, [[maybe_unused]] const bool use_direct_io = false) {
79
        fp = ggml_fopen(fname, mode);
80
        if (fp == NULL) {
81
            throw std::runtime_error(format("failed to open %s: %s", fname, strerror(errno)));
82
        }
83
        fp_win32 = (HANDLE) _get_osfhandle(_fileno(fp));
84
        seek(0, SEEK_END);
85
        size = tell();
86
        seek(0, SEEK_SET);
87
    }
88
89
    size_t tell() const {
90
        LARGE_INTEGER li;
91
        li.QuadPart = 0;
92
        BOOL ret = SetFilePointerEx(fp_win32, li, &li, FILE_CURRENT);
93
        if (!ret) {
94
            throw std::runtime_error(format("read error: %s", GetErrorMessageWin32(GetLastError()).c_str()));
95
        }
96
97
        return li.QuadPart;
98
    }
99
100
    void seek(size_t offset, int whence) const {
101
        static_assert(SEEK_SET == FILE_BEGIN, "SEEK_SET != FILE_BEGIN");
102
        static_assert(SEEK_CUR == FILE_CURRENT, "SEEK_CUR != FILE_CURRENT");
103
        static_assert(SEEK_END == FILE_END, "SEEK_END != FILE_END");
104
105
        LARGE_INTEGER li;
106
        li.QuadPart = offset;
107
        BOOL ret = SetFilePointerEx(fp_win32, li, NULL, whence);
108
        if (!ret) {
109
            throw std::runtime_error(format("read error: %s", GetErrorMessageWin32(GetLastError()).c_str()));
110
        }
111
    }
112
113
    void read_raw(void * ptr, size_t len) {
114
        size_t bytes_read = 0;
115
        while (bytes_read < len) {
116
            size_t chunk_size = std::min<size_t>(len - bytes_read, 64*1024*1024);
117
            DWORD chunk_read = 0;
118
            BOOL result = ReadFile(fp_win32, reinterpret_cast<char*>(ptr) + bytes_read, chunk_size, &chunk_read, NULL);
119
            if (!result) {
120
                throw std::runtime_error(format("read error: %s", GetErrorMessageWin32(GetLastError()).c_str()));
121
            }
122
            if (chunk_read < chunk_size || chunk_read == 0) {
123
                throw std::runtime_error("unexpectedly reached end of file");
124
            }
125
126
            bytes_read += chunk_read;
127
        }
128
    }
129
130
    uint32_t read_u32() {
131
        uint32_t val;
132
        read_raw(&val, sizeof(val));
133
        return val;
134
    }
135
136
    void write_raw(const void * ptr, size_t len) const {
137
        size_t bytes_written = 0;
138
        while (bytes_written < len) {
139
            size_t chunk_size = std::min<size_t>(len - bytes_written, 64*1024*1024);
140
            DWORD chunk_written = 0;
141
            BOOL result = WriteFile(fp_win32, reinterpret_cast<char const*>(ptr) + bytes_written, chunk_size, &chunk_written, NULL);
142
            if (!result) {
143
                throw std::runtime_error(format("write error: %s", GetErrorMessageWin32(GetLastError()).c_str()));
144
            }
145
            if (chunk_written < chunk_size || chunk_written == 0) {
146
                throw std::runtime_error("unexpectedly failed to write bytes");
147
            }
148
149
            bytes_written += chunk_written;
150
        }
151
    }
152
153
    void write_u32(uint32_t val) const {
154
        write_raw(&val, sizeof(val));
155
    }
156
157
    bool has_direct_io() const {
158
        return true;
159
    }
160
161
    ~impl() {
162
        if (fp) {
163
            std::fclose(fp);
164
        }
165
    }
166
#else
167
0
    impl(const char * fname, const char * mode, [[maybe_unused]] const bool use_direct_io = false) : fname(fname) {
168
0
#ifdef __linux__
169
        // Try unbuffered I/O for read only
170
0
        if (use_direct_io && std::strcmp(mode, "rb") == 0) {
171
0
            if (init_fd()) {
172
0
                return;
173
0
            }
174
0
            LLAMA_LOG_WARN("Failed to open file '%s' with error: %s. Falling back to buffered I/O",
175
0
                           fname, strerror(errno));
176
0
        }
177
0
#endif
178
0
        init_fp(mode);
179
0
    }
180
181
#ifdef __linux__
182
0
    bool init_fd() {
183
0
        fd = open(fname.c_str(), O_RDONLY | O_DIRECT);
184
185
0
        if (fd != -1) {
186
0
            struct stat file_stats{};
187
0
            fstat(fd, &file_stats);
188
189
0
            size = file_stats.st_size;
190
0
            alignment = file_stats.st_blksize;
191
192
0
            off_t ret = lseek(fd, 0, SEEK_SET);
193
0
            if (ret == -1) {
194
0
                throw std::runtime_error(format("seek error: %s", strerror(errno)));
195
0
            }
196
0
            return true;
197
0
        }
198
0
        return false;
199
0
    }
200
#endif
201
202
0
    void init_fp(const char * mode) {
203
0
        fp = ggml_fopen(fname.c_str(), mode);
204
0
        if (fp == NULL) {
205
0
            throw std::runtime_error(format("failed to open %s: %s", fname.c_str(), strerror(errno)));
206
0
        }
207
0
        seek(0, SEEK_END);
208
0
        size = tell();
209
0
        seek(0, SEEK_SET);
210
0
    }
211
212
0
    size_t tell() const {
213
0
        if (fd == -1) {
214
0
            long ret = std::ftell(fp);
215
0
            if (ret == -1) {
216
0
                throw std::runtime_error(format("ftell error: %s", strerror(errno)));
217
0
            }
218
219
0
            return (size_t) ret;
220
0
        }
221
222
0
        off_t pos = lseek(fd, 0, SEEK_CUR);
223
0
        if (pos == -1) {
224
0
            throw std::runtime_error(format("lseek error: %s", strerror(errno)));
225
0
        }
226
0
        return (size_t) pos;
227
0
    }
228
229
0
    void seek(size_t offset, int whence) const {
230
0
        off_t ret = 0;
231
0
        if (fd == -1) {
232
0
            ret = std::fseek(fp, (long) offset, whence);
233
0
        } else {
234
0
            ret = lseek(fd, offset, whence);
235
0
        }
236
0
        if (ret == -1) {
237
0
            throw std::runtime_error(format("seek error: %s", strerror(errno)));
238
0
        }
239
0
    }
240
241
0
    void read_raw_unsafe(void * ptr, size_t len) {
242
0
        if (len == 0) {
243
0
            return;
244
0
        }
245
0
        errno = 0;
246
0
        if (fd == -1) {
247
0
            const size_t curr_off = tell();
248
0
            const size_t to_read = std::min(len, size - curr_off);
249
250
0
            std::size_t ret = std::fread(ptr, to_read, 1, fp);
251
0
            if (ferror(fp)) {
252
0
                throw std::runtime_error(format("read error: %s", strerror(errno)));
253
0
            }
254
0
            if (to_read > 0 && ret != 1) {
255
0
                throw std::runtime_error("unexpectedly reached end of file");
256
0
            }
257
0
        } else {
258
0
            size_t bytes_read = 0;
259
0
            while (bytes_read < len) {
260
0
                const size_t to_read = len - bytes_read;
261
0
                ssize_t ret = ::read(fd, reinterpret_cast<char *>(ptr) + bytes_read, to_read);
262
263
0
                if (ret == -1) {
264
0
                    if (errno == EINTR) {
265
0
                        continue;  // Interrupted by signal, retry
266
0
                    }
267
                    // Fallback to std::fread in case the DMA controller cannot access the buffer
268
0
                    if (errno == EFAULT) {
269
0
                        auto curr_off = tell();
270
0
                        close(fd);
271
0
                        fd = -1;
272
0
                        alignment = 1;
273
0
                        init_fp("rb");
274
0
                        seek(curr_off, SEEK_SET);
275
0
                        read_raw_unsafe(ptr, len);
276
0
                        return;
277
0
                    }
278
0
                    throw std::runtime_error(format("read error: %s", strerror(errno)));
279
0
                }
280
0
                if (ret == 0) {
281
                    // EOF: allow if this read was only pulling alignment padding past file end
282
0
                    off_t pos = lseek(fd, 0, SEEK_CUR);
283
0
                    if (pos != -1 && (size_t) pos == size) {
284
0
                        std::memset(reinterpret_cast<char *>(ptr) + bytes_read, 0, len - bytes_read);
285
0
                        return;
286
0
                    }
287
0
                    throw std::runtime_error("unexpectedly reached end of file");
288
0
                }
289
290
0
                bytes_read += (size_t) ret;
291
0
            }
292
0
        }
293
0
    }
294
295
0
    void read_aligned_chunk(void * dest, size_t size) {
296
0
        size_t offset = tell();
297
0
        off_t aligned_offset = offset & ~(alignment - 1);
298
0
        off_t offset_from_alignment = offset - aligned_offset;
299
0
        size_t bytes_to_read = (offset_from_alignment + size + alignment - 1) & ~(alignment - 1);
300
301
0
        void * raw_buffer = nullptr;
302
0
        int ret = posix_memalign(&raw_buffer, alignment, bytes_to_read);
303
0
        if (ret != 0) {
304
0
            throw std::runtime_error(format("posix_memalign failed with error %d", ret));
305
0
        }
306
307
0
        struct aligned_buffer_deleter {
308
0
            void operator()(void * p) const { free(p); }
309
0
        };
310
0
        std::unique_ptr<void, aligned_buffer_deleter> buffer(raw_buffer);
311
312
0
        seek(aligned_offset, SEEK_SET);
313
0
        read_raw_unsafe(buffer.get(), bytes_to_read);
314
315
0
        uintptr_t actual_data = reinterpret_cast<uintptr_t>(buffer.get()) + offset_from_alignment;
316
0
        memcpy(dest, reinterpret_cast<void *>(actual_data), size);
317
0
    }
318
319
0
    void read_raw(void * ptr, size_t len) {
320
0
        if (has_direct_io()) {
321
0
            read_aligned_chunk(ptr, len);
322
0
        } else {
323
0
            read_raw_unsafe(ptr, len);
324
0
        }
325
0
    }
326
327
0
    uint32_t read_u32() {
328
0
        uint32_t ret;
329
0
        read_raw(&ret, sizeof(ret));
330
0
        return ret;
331
0
    }
332
333
0
    void write_raw(const void * ptr, size_t len) const {
334
0
        if (len == 0) {
335
0
            return;
336
0
        }
337
0
        errno = 0;
338
0
        size_t ret = std::fwrite(ptr, len, 1, fp);
339
0
        if (ret != 1) {
340
0
            throw std::runtime_error(format("write error: %s", strerror(errno)));
341
0
        }
342
0
    }
343
344
0
    void write_u32(uint32_t val) const {
345
0
        write_raw(&val, sizeof(val));
346
0
    }
347
348
0
    bool has_direct_io() const {
349
0
        return fd != -1 && alignment > 1;
350
0
    }
351
352
0
    ~impl() {
353
0
        if (fd != -1) {
354
0
            close(fd);
355
0
        } else {
356
0
            std::fclose(fp);
357
0
        }
358
0
    }
359
    int fd = -1;
360
    std::string fname;
361
#endif
362
363
0
    size_t read_alignment() const {
364
0
        return alignment;
365
0
    }
366
367
    size_t alignment = 1;
368
369
    FILE * fp{};
370
    size_t size{};
371
};
372
373
llama_file::llama_file(const char * fname, const char * mode, const bool use_direct_io) :
374
0
    pimpl(std::make_unique<impl>(fname, mode, use_direct_io)) {}
375
0
llama_file::~llama_file() = default;
376
377
0
size_t llama_file::tell() const { return pimpl->tell(); }
378
0
size_t llama_file::size() const { return pimpl->size; }
379
380
0
size_t llama_file::read_alignment() const { return pimpl->read_alignment(); }
381
0
bool llama_file::has_direct_io() const { return pimpl->has_direct_io(); }
382
383
0
int llama_file::file_id() const {
384
#ifdef _WIN32
385
    return _fileno(pimpl->fp);
386
#else
387
#if defined(fileno)
388
    return fileno(pimpl->fp);
389
#else
390
0
    return ::fileno(pimpl->fp);
391
0
#endif
392
0
#endif
393
0
}
394
395
0
void llama_file::seek(size_t offset, int whence) const { pimpl->seek(offset, whence); }
396
0
void llama_file::read_raw(void * ptr, size_t len) { pimpl->read_raw(ptr, len); }
397
#ifdef _WIN32
398
void llama_file::read_raw_unsafe(void * ptr, size_t len) { pimpl->read_raw(ptr, len); }
399
#else
400
0
void llama_file::read_raw_unsafe(void * ptr, size_t len) { pimpl->read_raw_unsafe(ptr, len); }
401
#endif
402
403
0
uint32_t llama_file::read_u32() { return pimpl->read_u32(); }
404
405
0
void llama_file::write_raw(const void * ptr, size_t len) const { pimpl->write_raw(ptr, len); }
406
0
void llama_file::write_u32(uint32_t val) const { pimpl->write_u32(val); }
407
408
// llama_mmap
409
410
struct llama_mmap::impl {
411
#ifdef _POSIX_MAPPED_FILES
412
    std::vector<std::pair<size_t, size_t>> mapped_fragments;
413
414
0
    impl(struct llama_file * file, size_t prefetch, bool numa) {
415
0
        size = file->size();
416
0
        int fd = file->file_id();
417
0
        int flags = MAP_SHARED;
418
0
        if (numa) { prefetch = 0; }
419
0
#ifdef __linux__
420
0
        if (posix_fadvise(fd, 0, 0, POSIX_FADV_SEQUENTIAL)) {
421
0
            LLAMA_LOG_WARN("warning: posix_fadvise(.., POSIX_FADV_SEQUENTIAL) failed: %s\n",
422
0
                    strerror(errno));
423
0
        }
424
0
        if (prefetch) { flags |= MAP_POPULATE; }
425
0
#endif
426
0
        addr = mmap(NULL, file->size(), PROT_READ, flags, fd, 0);
427
0
        if (addr == MAP_FAILED) {
428
0
            throw std::runtime_error(format("mmap failed: %s", strerror(errno)));
429
0
        }
430
431
0
        if (prefetch > 0) {
432
0
            if (posix_madvise(addr, std::min(file->size(), prefetch), POSIX_MADV_WILLNEED)) {
433
0
                LLAMA_LOG_WARN("warning: posix_madvise(.., POSIX_MADV_WILLNEED) failed: %s\n",
434
0
                        strerror(errno));
435
0
            }
436
0
        }
437
0
        if (numa) {
438
0
            if (posix_madvise(addr, file->size(), POSIX_MADV_RANDOM)) {
439
0
                LLAMA_LOG_WARN("warning: posix_madvise(.., POSIX_MADV_RANDOM) failed: %s\n",
440
0
                        strerror(errno));
441
0
            }
442
0
        }
443
444
0
        mapped_fragments.emplace_back(0, file->size());
445
0
    }
446
447
0
    static void align_range(size_t * first, size_t * last, size_t page_size) {
448
0
        size_t offset_in_page = *first & (page_size - 1);
449
0
        size_t offset_to_page = offset_in_page == 0 ? 0 : page_size - offset_in_page;
450
0
        *first += offset_to_page;
451
452
0
        *last = *last & ~(page_size - 1);
453
454
0
        if (*last <= *first) {
455
0
            *last = *first;
456
0
        }
457
0
    }
458
459
0
    void unmap_fragment(size_t first, size_t last) {
460
0
        int page_size = sysconf(_SC_PAGESIZE);
461
0
        align_range(&first, &last, page_size);
462
0
        size_t len = last - first;
463
464
0
        if (len == 0) {
465
0
            return;
466
0
        }
467
468
0
        GGML_ASSERT(first % page_size == 0);
469
0
        GGML_ASSERT(last % page_size == 0);
470
0
        GGML_ASSERT(last > first);
471
472
0
        void * next_page_start = (uint8_t *) addr + first;
473
474
0
        if (munmap(next_page_start, len)) {
475
0
            LLAMA_LOG_WARN("warning: munmap failed: %s\n", strerror(errno));
476
0
        }
477
478
0
        std::vector<std::pair<size_t, size_t>> new_mapped_fragments;
479
0
        for (const auto & frag : mapped_fragments) {
480
0
            if (frag.first < first && frag.second > last) {
481
0
                new_mapped_fragments.emplace_back(frag.first, first);
482
0
                new_mapped_fragments.emplace_back(last, frag.second);
483
0
            } else if (frag.first < first && frag.second > first) {
484
0
                new_mapped_fragments.emplace_back(frag.first, first);
485
0
            } else if (frag.first < last && frag.second > last) {
486
0
                new_mapped_fragments.emplace_back(last, frag.second);
487
0
            } else if (frag.first >= first && frag.second <= last) {
488
0
            } else {
489
0
                new_mapped_fragments.push_back(frag);
490
0
            }
491
0
        }
492
0
        mapped_fragments = std::move(new_mapped_fragments);
493
0
    }
494
495
0
    ~impl() {
496
0
        for (const auto & frag : mapped_fragments) {
497
0
            if (munmap((char *) addr + frag.first, frag.second - frag.first)) {
498
0
                LLAMA_LOG_WARN("warning: munmap failed: %s\n", strerror(errno));
499
0
            }
500
0
        }
501
0
    }
502
#elif defined(_WIN32)
503
    impl(struct llama_file * file, size_t prefetch, bool numa) {
504
        GGML_UNUSED(numa);
505
506
        size = file->size();
507
508
        HANDLE hFile = (HANDLE) _get_osfhandle(file->file_id());
509
510
        HANDLE hMapping = CreateFileMappingA(hFile, NULL, PAGE_READONLY, 0, 0, NULL);
511
512
        if (hMapping == NULL) {
513
            DWORD error = GetLastError();
514
            throw std::runtime_error(format("CreateFileMappingA failed: %s", llama_format_win_err(error).c_str()));
515
        }
516
517
        addr = MapViewOfFile(hMapping, FILE_MAP_READ, 0, 0, 0);
518
        DWORD error = GetLastError();
519
        CloseHandle(hMapping);
520
521
        if (addr == NULL) {
522
            throw std::runtime_error(format("MapViewOfFile failed: %s", llama_format_win_err(error).c_str()));
523
        }
524
525
        if (prefetch > 0) {
526
#if _WIN32_WINNT >= 0x602
527
            BOOL (WINAPI *pPrefetchVirtualMemory) (HANDLE, ULONG_PTR, PWIN32_MEMORY_RANGE_ENTRY, ULONG);
528
            HMODULE hKernel32 = GetModuleHandleW(L"kernel32.dll");
529
530
            pPrefetchVirtualMemory = (decltype(pPrefetchVirtualMemory))(void *) GetProcAddress(hKernel32, "PrefetchVirtualMemory");
531
532
            if (pPrefetchVirtualMemory) {
533
                WIN32_MEMORY_RANGE_ENTRY range;
534
                range.VirtualAddress = addr;
535
                range.NumberOfBytes = (SIZE_T) std::min(size, prefetch);
536
                if (!pPrefetchVirtualMemory(GetCurrentProcess(), 1, &range, 0)) {
537
                    LLAMA_LOG_WARN("warning: PrefetchVirtualMemory failed: %s\n",
538
                            llama_format_win_err(GetLastError()).c_str());
539
                }
540
            }
541
#else
542
            LLAMA_LOG_DEBUG("skipping PrefetchVirtualMemory because _WIN32_WINNT < 0x602\n");
543
#endif
544
        }
545
    }
546
547
    void unmap_fragment(size_t first, size_t last) {
548
        GGML_UNUSED(first);
549
        GGML_UNUSED(last);
550
    }
551
552
    ~impl() {
553
        if (!UnmapViewOfFile(addr)) {
554
            LLAMA_LOG_WARN("warning: UnmapViewOfFile failed: %s\n",
555
                    llama_format_win_err(GetLastError()).c_str());
556
        }
557
    }
558
#else
559
    impl(struct llama_file * file, size_t prefetch, bool numa) {
560
        GGML_UNUSED(file);
561
        GGML_UNUSED(prefetch);
562
        GGML_UNUSED(numa);
563
564
        throw std::runtime_error("mmap not supported");
565
    }
566
567
    void unmap_fragment(size_t first, size_t last) {
568
        GGML_UNUSED(first);
569
        GGML_UNUSED(last);
570
571
        throw std::runtime_error("mmap not supported");
572
    }
573
#endif
574
575
    void * addr;
576
    size_t size;
577
};
578
579
0
llama_mmap::llama_mmap(struct llama_file * file, size_t prefetch, bool numa) : pimpl(std::make_unique<impl>(file, prefetch, numa)) {}
580
0
llama_mmap::~llama_mmap() = default;
581
582
0
size_t llama_mmap::size() const { return pimpl->size; }
583
0
void * llama_mmap::addr() const { return pimpl->addr; }
584
585
0
void llama_mmap::unmap_fragment(size_t first, size_t last) { pimpl->unmap_fragment(first, last); }
586
587
#if defined(_POSIX_MEMLOCK_RANGE) || defined(_WIN32)
588
const bool llama_mmap::SUPPORTED  = true;
589
#else
590
const bool llama_mmap::SUPPORTED  = false;
591
#endif
592
593
// llama_mlock
594
595
struct llama_mlock::impl {
596
#ifdef _POSIX_MEMLOCK_RANGE
597
0
    static size_t lock_granularity() {
598
0
        return (size_t) sysconf(_SC_PAGESIZE);
599
0
    }
600
601
0
    bool raw_lock(const void * addr, size_t size) const {
602
0
        if (!mlock(addr, size)) {
603
0
            return true;
604
0
        }
605
606
#ifdef __APPLE__
607
#define MLOCK_SUGGESTION \
608
        "Try increasing the sysctl values 'vm.user_wire_limit' and 'vm.global_user_wire_limit' and/or " \
609
        "decreasing 'vm.global_no_user_wire_amount'.  Also try increasing RLIMIT_MEMLOCK (ulimit -l).\n"
610
#else
611
0
#define MLOCK_SUGGESTION \
612
0
        "Try increasing RLIMIT_MEMLOCK ('ulimit -l' as root).\n"
613
0
#endif
614
615
0
        char* errmsg = std::strerror(errno);
616
0
        bool suggest = (errno == ENOMEM);
617
#if defined(TARGET_OS_VISION) || defined(TARGET_OS_TV) || defined(_AIX) || defined(__HAIKU__)
618
        // visionOS/tvOS/Haiku don't support RLIMIT_MEMLOCK
619
        // Skip resource limit checks on these platforms
620
        suggest = false;
621
#else
622
0
        struct rlimit lock_limit;
623
0
        if (suggest && getrlimit(RLIMIT_MEMLOCK, &lock_limit)) {
624
0
            suggest = false;
625
0
        }
626
0
        if (suggest && ((uint64_t)lock_limit.rlim_max > (uint64_t)lock_limit.rlim_cur + size)) {
627
0
            suggest = false;
628
0
        }
629
0
#endif
630
631
0
        LLAMA_LOG_WARN("warning: failed to mlock %zu-byte buffer (after previously locking %zu bytes): %s\n%s",
632
0
                size, this->size, errmsg, suggest ? MLOCK_SUGGESTION : "");
633
0
        return false;
634
0
    }
635
636
0
    static void raw_unlock(void * addr, size_t size) {
637
0
        if (munlock(addr, size)) {
638
0
            LLAMA_LOG_WARN("warning: failed to munlock buffer: %s\n", std::strerror(errno));
639
0
        }
640
0
    }
641
#elif defined(_WIN32)
642
    static size_t lock_granularity() {
643
        SYSTEM_INFO si;
644
        GetSystemInfo(&si);
645
        return (size_t) si.dwPageSize;
646
    }
647
648
    bool raw_lock(void * ptr, size_t len) const {
649
        for (int tries = 1; ; tries++) {
650
            if (VirtualLock(ptr, len)) {
651
                return true;
652
            }
653
            if (tries == 2) {
654
                LLAMA_LOG_WARN("warning: failed to VirtualLock %zu-byte buffer (after previously locking %zu bytes): %s\n",
655
                    len, size, llama_format_win_err(GetLastError()).c_str());
656
                return false;
657
            }
658
659
            SIZE_T min_ws_size, max_ws_size;
660
            if (!GetProcessWorkingSetSize(GetCurrentProcess(), &min_ws_size, &max_ws_size)) {
661
                LLAMA_LOG_WARN("warning: GetProcessWorkingSetSize failed: %s\n",
662
                        llama_format_win_err(GetLastError()).c_str());
663
                return false;
664
            }
665
            size_t increment = len + 1048576;
666
            min_ws_size += increment;
667
            max_ws_size += increment;
668
            if (!SetProcessWorkingSetSize(GetCurrentProcess(), min_ws_size, max_ws_size)) {
669
                LLAMA_LOG_WARN("warning: SetProcessWorkingSetSize failed: %s\n",
670
                        llama_format_win_err(GetLastError()).c_str());
671
                return false;
672
            }
673
        }
674
    }
675
676
    static void raw_unlock(void * ptr, size_t len) {
677
        if (!VirtualUnlock(ptr, len)) {
678
            LLAMA_LOG_WARN("warning: failed to VirtualUnlock buffer: %s\n",
679
                    llama_format_win_err(GetLastError()).c_str());
680
        }
681
    }
682
#else
683
    static size_t lock_granularity() {
684
        return (size_t) 65536;
685
    }
686
687
    bool raw_lock(const void * addr, size_t len) const {
688
        LLAMA_LOG_WARN("warning: mlock not supported on this system\n");
689
        return false;
690
    }
691
692
    static void raw_unlock(const void * addr, size_t len) {}
693
#endif
694
695
0
    impl() : addr(NULL), size(0), failed_already(false) {}
696
697
0
    void init(void * ptr) {
698
0
        GGML_ASSERT(addr == NULL && size == 0);
699
0
        addr = ptr;
700
0
    }
701
702
0
    void grow_to(size_t target_size) {
703
0
        GGML_ASSERT(addr);
704
0
        if (failed_already) {
705
0
            return;
706
0
        }
707
0
        size_t granularity = lock_granularity();
708
0
        target_size = (target_size + granularity - 1) & ~(granularity - 1);
709
0
        if (target_size > size) {
710
0
            if (raw_lock((uint8_t *) addr + size, target_size - size)) {
711
0
                size = target_size;
712
0
            } else {
713
0
                failed_already = true;
714
0
            }
715
0
        }
716
0
    }
717
718
    void * addr;
719
    size_t size;
720
721
    bool failed_already;
722
};
723
724
0
llama_mlock::llama_mlock() : pimpl(std::make_unique<impl>()) {}
725
0
llama_mlock::~llama_mlock() = default;
726
727
0
void llama_mlock::init(void * ptr) { pimpl->init(ptr); }
728
0
void llama_mlock::grow_to(size_t target_size) { pimpl->grow_to(target_size); }
729
730
#if defined(_POSIX_MEMLOCK_RANGE) || defined(_WIN32)
731
const bool llama_mlock::SUPPORTED = true;
732
#else
733
const bool llama_mlock::SUPPORTED = false;
734
#endif
735
736
0
size_t llama_path_max() {
737
    return PATH_MAX;
738
0
}