Coverage Report

Created: 2026-01-13 06:16

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
            std::size_t ret = std::fread(ptr, len, 1, fp);
248
0
            if (ferror(fp)) {
249
0
                throw std::runtime_error(format("read error: %s", strerror(errno)));
250
0
            }
251
0
            if (ret != 1) {
252
0
                throw std::runtime_error("unexpectedly reached end of file");
253
0
            }
254
0
        } else {
255
0
            size_t bytes_read = 0;
256
0
            while (bytes_read < len) {
257
0
                const size_t to_read = len - bytes_read;
258
0
                ssize_t ret = ::read(fd, reinterpret_cast<char *>(ptr) + bytes_read, to_read);
259
260
0
                if (ret == -1) {
261
0
                    if (errno == EINTR) {
262
0
                        continue;  // Interrupted by signal, retry
263
0
                    }
264
                    // Fallback to std::fread in case the DMA controller cannot access the buffer
265
0
                    if (errno == EFAULT) {
266
0
                        auto curr_off = tell();
267
0
                        close(fd);
268
0
                        fd = -1;
269
0
                        alignment = 1;
270
0
                        init_fp("rb");
271
0
                        seek(curr_off, SEEK_SET);
272
0
                        read_raw_unsafe(ptr, len);
273
0
                        return;
274
0
                    }
275
0
                    throw std::runtime_error(format("read error: %s", strerror(errno)));
276
0
                }
277
0
                if (ret == 0) {
278
                    // EOF: allow if this read was only pulling alignment padding past file end
279
0
                    off_t pos = lseek(fd, 0, SEEK_CUR);
280
0
                    if (pos != -1 && (size_t) pos == size) {
281
0
                        std::memset(reinterpret_cast<char *>(ptr) + bytes_read, 0, len - bytes_read);
282
0
                        return;
283
0
                    }
284
0
                    throw std::runtime_error("unexpectedly reached end of file");
285
0
                }
286
287
0
                bytes_read += (size_t) ret;
288
0
            }
289
0
        }
290
0
    }
291
292
0
    void read_aligned_chunk(void * dest, size_t size) {
293
0
        size_t offset = tell();
294
0
        off_t aligned_offset = offset & ~(alignment - 1);
295
0
        off_t offset_from_alignment = offset - aligned_offset;
296
0
        size_t bytes_to_read = (offset_from_alignment + size + alignment - 1) & ~(alignment - 1);
297
298
0
        void * raw_buffer = nullptr;
299
0
        int ret = posix_memalign(&raw_buffer, alignment, bytes_to_read);
300
0
        if (ret != 0) {
301
0
            throw std::runtime_error(format("posix_memalign failed with error %d", ret));
302
0
        }
303
304
0
        struct aligned_buffer_deleter {
305
0
            void operator()(void * p) const { free(p); }
306
0
        };
307
0
        std::unique_ptr<void, aligned_buffer_deleter> buffer(raw_buffer);
308
309
0
        seek(aligned_offset, SEEK_SET);
310
0
        read_raw_unsafe(buffer.get(), bytes_to_read);
311
312
0
        uintptr_t actual_data = reinterpret_cast<uintptr_t>(buffer.get()) + offset_from_alignment;
313
0
        memcpy(dest, reinterpret_cast<void *>(actual_data), size);
314
0
    }
315
316
0
    void read_raw(void * ptr, size_t len) {
317
0
        if (has_direct_io()) {
318
0
            read_aligned_chunk(ptr, len);
319
0
        } else {
320
0
            read_raw_unsafe(ptr, len);
321
0
        }
322
0
    }
323
324
0
    uint32_t read_u32() {
325
0
        uint32_t ret;
326
0
        read_raw(&ret, sizeof(ret));
327
0
        return ret;
328
0
    }
329
330
0
    void write_raw(const void * ptr, size_t len) const {
331
0
        if (len == 0) {
332
0
            return;
333
0
        }
334
0
        errno = 0;
335
0
        size_t ret = std::fwrite(ptr, len, 1, fp);
336
0
        if (ret != 1) {
337
0
            throw std::runtime_error(format("write error: %s", strerror(errno)));
338
0
        }
339
0
    }
340
341
0
    void write_u32(uint32_t val) const {
342
0
        write_raw(&val, sizeof(val));
343
0
    }
344
345
0
    bool has_direct_io() const {
346
0
        return fd != -1 && alignment > 1;
347
0
    }
348
349
0
    ~impl() {
350
0
        if (fd != -1) {
351
0
            close(fd);
352
0
        } else {
353
0
            std::fclose(fp);
354
0
        }
355
0
    }
356
    int fd = -1;
357
    std::string fname;
358
#endif
359
360
0
    size_t read_alignment() const {
361
0
        return alignment;
362
0
    }
363
364
    size_t alignment = 1;
365
366
    FILE * fp{};
367
    size_t size{};
368
};
369
370
llama_file::llama_file(const char * fname, const char * mode, const bool use_direct_io) :
371
0
    pimpl(std::make_unique<impl>(fname, mode, use_direct_io)) {}
372
0
llama_file::~llama_file() = default;
373
374
0
size_t llama_file::tell() const { return pimpl->tell(); }
375
0
size_t llama_file::size() const { return pimpl->size; }
376
377
0
size_t llama_file::read_alignment() const { return pimpl->read_alignment(); }
378
0
bool llama_file::has_direct_io() const { return pimpl->has_direct_io(); }
379
380
0
int llama_file::file_id() const {
381
#ifdef _WIN32
382
    return _fileno(pimpl->fp);
383
#else
384
#if defined(fileno)
385
    return fileno(pimpl->fp);
386
#else
387
0
    return ::fileno(pimpl->fp);
388
0
#endif
389
0
#endif
390
0
}
391
392
0
void llama_file::seek(size_t offset, int whence) const { pimpl->seek(offset, whence); }
393
0
void llama_file::read_raw(void * ptr, size_t len) { pimpl->read_raw(ptr, len); }
394
#ifdef _WIN32
395
void llama_file::read_raw_unsafe(void * ptr, size_t len) { pimpl->read_raw(ptr, len); }
396
#else
397
0
void llama_file::read_raw_unsafe(void * ptr, size_t len) { pimpl->read_raw_unsafe(ptr, len); }
398
#endif
399
400
0
uint32_t llama_file::read_u32() { return pimpl->read_u32(); }
401
402
0
void llama_file::write_raw(const void * ptr, size_t len) const { pimpl->write_raw(ptr, len); }
403
0
void llama_file::write_u32(uint32_t val) const { pimpl->write_u32(val); }
404
405
// llama_mmap
406
407
struct llama_mmap::impl {
408
#ifdef _POSIX_MAPPED_FILES
409
    std::vector<std::pair<size_t, size_t>> mapped_fragments;
410
411
0
    impl(struct llama_file * file, size_t prefetch, bool numa) {
412
0
        size = file->size();
413
0
        int fd = file->file_id();
414
0
        int flags = MAP_SHARED;
415
0
        if (numa) { prefetch = 0; }
416
0
#ifdef __linux__
417
0
        if (posix_fadvise(fd, 0, 0, POSIX_FADV_SEQUENTIAL)) {
418
0
            LLAMA_LOG_WARN("warning: posix_fadvise(.., POSIX_FADV_SEQUENTIAL) failed: %s\n",
419
0
                    strerror(errno));
420
0
        }
421
0
        if (prefetch) { flags |= MAP_POPULATE; }
422
0
#endif
423
0
        addr = mmap(NULL, file->size(), PROT_READ, flags, fd, 0);
424
0
        if (addr == MAP_FAILED) {
425
0
            throw std::runtime_error(format("mmap failed: %s", strerror(errno)));
426
0
        }
427
428
0
        if (prefetch > 0) {
429
0
            if (posix_madvise(addr, std::min(file->size(), prefetch), POSIX_MADV_WILLNEED)) {
430
0
                LLAMA_LOG_WARN("warning: posix_madvise(.., POSIX_MADV_WILLNEED) failed: %s\n",
431
0
                        strerror(errno));
432
0
            }
433
0
        }
434
0
        if (numa) {
435
0
            if (posix_madvise(addr, file->size(), POSIX_MADV_RANDOM)) {
436
0
                LLAMA_LOG_WARN("warning: posix_madvise(.., POSIX_MADV_RANDOM) failed: %s\n",
437
0
                        strerror(errno));
438
0
            }
439
0
        }
440
441
0
        mapped_fragments.emplace_back(0, file->size());
442
0
    }
443
444
0
    static void align_range(size_t * first, size_t * last, size_t page_size) {
445
0
        size_t offset_in_page = *first & (page_size - 1);
446
0
        size_t offset_to_page = offset_in_page == 0 ? 0 : page_size - offset_in_page;
447
0
        *first += offset_to_page;
448
449
0
        *last = *last & ~(page_size - 1);
450
451
0
        if (*last <= *first) {
452
0
            *last = *first;
453
0
        }
454
0
    }
455
456
0
    void unmap_fragment(size_t first, size_t last) {
457
0
        int page_size = sysconf(_SC_PAGESIZE);
458
0
        align_range(&first, &last, page_size);
459
0
        size_t len = last - first;
460
461
0
        if (len == 0) {
462
0
            return;
463
0
        }
464
465
0
        GGML_ASSERT(first % page_size == 0);
466
0
        GGML_ASSERT(last % page_size == 0);
467
0
        GGML_ASSERT(last > first);
468
469
0
        void * next_page_start = (uint8_t *) addr + first;
470
471
0
        if (munmap(next_page_start, len)) {
472
0
            LLAMA_LOG_WARN("warning: munmap failed: %s\n", strerror(errno));
473
0
        }
474
475
0
        std::vector<std::pair<size_t, size_t>> new_mapped_fragments;
476
0
        for (const auto & frag : mapped_fragments) {
477
0
            if (frag.first < first && frag.second > last) {
478
0
                new_mapped_fragments.emplace_back(frag.first, first);
479
0
                new_mapped_fragments.emplace_back(last, frag.second);
480
0
            } else if (frag.first < first && frag.second > first) {
481
0
                new_mapped_fragments.emplace_back(frag.first, first);
482
0
            } else if (frag.first < last && frag.second > last) {
483
0
                new_mapped_fragments.emplace_back(last, frag.second);
484
0
            } else if (frag.first >= first && frag.second <= last) {
485
0
            } else {
486
0
                new_mapped_fragments.push_back(frag);
487
0
            }
488
0
        }
489
0
        mapped_fragments = std::move(new_mapped_fragments);
490
0
    }
491
492
0
    ~impl() {
493
0
        for (const auto & frag : mapped_fragments) {
494
0
            if (munmap((char *) addr + frag.first, frag.second - frag.first)) {
495
0
                LLAMA_LOG_WARN("warning: munmap failed: %s\n", strerror(errno));
496
0
            }
497
0
        }
498
0
    }
499
#elif defined(_WIN32)
500
    impl(struct llama_file * file, size_t prefetch, bool numa) {
501
        GGML_UNUSED(numa);
502
503
        size = file->size();
504
505
        HANDLE hFile = (HANDLE) _get_osfhandle(file->file_id());
506
507
        HANDLE hMapping = CreateFileMappingA(hFile, NULL, PAGE_READONLY, 0, 0, NULL);
508
509
        if (hMapping == NULL) {
510
            DWORD error = GetLastError();
511
            throw std::runtime_error(format("CreateFileMappingA failed: %s", llama_format_win_err(error).c_str()));
512
        }
513
514
        addr = MapViewOfFile(hMapping, FILE_MAP_READ, 0, 0, 0);
515
        DWORD error = GetLastError();
516
        CloseHandle(hMapping);
517
518
        if (addr == NULL) {
519
            throw std::runtime_error(format("MapViewOfFile failed: %s", llama_format_win_err(error).c_str()));
520
        }
521
522
        if (prefetch > 0) {
523
#if _WIN32_WINNT >= 0x602
524
            BOOL (WINAPI *pPrefetchVirtualMemory) (HANDLE, ULONG_PTR, PWIN32_MEMORY_RANGE_ENTRY, ULONG);
525
            HMODULE hKernel32 = GetModuleHandleW(L"kernel32.dll");
526
527
            pPrefetchVirtualMemory = (decltype(pPrefetchVirtualMemory))(void *) GetProcAddress(hKernel32, "PrefetchVirtualMemory");
528
529
            if (pPrefetchVirtualMemory) {
530
                WIN32_MEMORY_RANGE_ENTRY range;
531
                range.VirtualAddress = addr;
532
                range.NumberOfBytes = (SIZE_T) std::min(size, prefetch);
533
                if (!pPrefetchVirtualMemory(GetCurrentProcess(), 1, &range, 0)) {
534
                    LLAMA_LOG_WARN("warning: PrefetchVirtualMemory failed: %s\n",
535
                            llama_format_win_err(GetLastError()).c_str());
536
                }
537
            }
538
#else
539
            LLAMA_LOG_DEBUG("skipping PrefetchVirtualMemory because _WIN32_WINNT < 0x602\n");
540
#endif
541
        }
542
    }
543
544
    void unmap_fragment(size_t first, size_t last) {
545
        GGML_UNUSED(first);
546
        GGML_UNUSED(last);
547
    }
548
549
    ~impl() {
550
        if (!UnmapViewOfFile(addr)) {
551
            LLAMA_LOG_WARN("warning: UnmapViewOfFile failed: %s\n",
552
                    llama_format_win_err(GetLastError()).c_str());
553
        }
554
    }
555
#else
556
    impl(struct llama_file * file, size_t prefetch, bool numa) {
557
        GGML_UNUSED(file);
558
        GGML_UNUSED(prefetch);
559
        GGML_UNUSED(numa);
560
561
        throw std::runtime_error("mmap not supported");
562
    }
563
564
    void unmap_fragment(size_t first, size_t last) {
565
        GGML_UNUSED(first);
566
        GGML_UNUSED(last);
567
568
        throw std::runtime_error("mmap not supported");
569
    }
570
#endif
571
572
    void * addr;
573
    size_t size;
574
};
575
576
0
llama_mmap::llama_mmap(struct llama_file * file, size_t prefetch, bool numa) : pimpl(std::make_unique<impl>(file, prefetch, numa)) {}
577
0
llama_mmap::~llama_mmap() = default;
578
579
0
size_t llama_mmap::size() const { return pimpl->size; }
580
0
void * llama_mmap::addr() const { return pimpl->addr; }
581
582
0
void llama_mmap::unmap_fragment(size_t first, size_t last) { pimpl->unmap_fragment(first, last); }
583
584
#if defined(_POSIX_MEMLOCK_RANGE) || defined(_WIN32)
585
const bool llama_mmap::SUPPORTED  = true;
586
#else
587
const bool llama_mmap::SUPPORTED  = false;
588
#endif
589
590
// llama_mlock
591
592
struct llama_mlock::impl {
593
#ifdef _POSIX_MEMLOCK_RANGE
594
0
    static size_t lock_granularity() {
595
0
        return (size_t) sysconf(_SC_PAGESIZE);
596
0
    }
597
598
0
    bool raw_lock(const void * addr, size_t size) const {
599
0
        if (!mlock(addr, size)) {
600
0
            return true;
601
0
        }
602
603
#ifdef __APPLE__
604
#define MLOCK_SUGGESTION \
605
        "Try increasing the sysctl values 'vm.user_wire_limit' and 'vm.global_user_wire_limit' and/or " \
606
        "decreasing 'vm.global_no_user_wire_amount'.  Also try increasing RLIMIT_MEMLOCK (ulimit -l).\n"
607
#else
608
0
#define MLOCK_SUGGESTION \
609
0
        "Try increasing RLIMIT_MEMLOCK ('ulimit -l' as root).\n"
610
0
#endif
611
612
0
        char* errmsg = std::strerror(errno);
613
0
        bool suggest = (errno == ENOMEM);
614
#if defined(TARGET_OS_VISION) || defined(TARGET_OS_TV) || defined(_AIX)
615
        // visionOS/tvOS dont't support RLIMIT_MEMLOCK
616
        // Skip resource limit checks on visionOS/tvOS
617
        suggest = false;
618
#else
619
0
        struct rlimit lock_limit;
620
0
        if (suggest && getrlimit(RLIMIT_MEMLOCK, &lock_limit)) {
621
0
            suggest = false;
622
0
        }
623
0
        if (suggest && ((uint64_t)lock_limit.rlim_max > (uint64_t)lock_limit.rlim_cur + size)) {
624
0
            suggest = false;
625
0
        }
626
0
#endif
627
628
0
        LLAMA_LOG_WARN("warning: failed to mlock %zu-byte buffer (after previously locking %zu bytes): %s\n%s",
629
0
                size, this->size, errmsg, suggest ? MLOCK_SUGGESTION : "");
630
0
        return false;
631
0
    }
632
633
0
    static void raw_unlock(void * addr, size_t size) {
634
0
        if (munlock(addr, size)) {
635
0
            LLAMA_LOG_WARN("warning: failed to munlock buffer: %s\n", std::strerror(errno));
636
0
        }
637
0
    }
638
#elif defined(_WIN32)
639
    static size_t lock_granularity() {
640
        SYSTEM_INFO si;
641
        GetSystemInfo(&si);
642
        return (size_t) si.dwPageSize;
643
    }
644
645
    bool raw_lock(void * ptr, size_t len) const {
646
        for (int tries = 1; ; tries++) {
647
            if (VirtualLock(ptr, len)) {
648
                return true;
649
            }
650
            if (tries == 2) {
651
                LLAMA_LOG_WARN("warning: failed to VirtualLock %zu-byte buffer (after previously locking %zu bytes): %s\n",
652
                    len, size, llama_format_win_err(GetLastError()).c_str());
653
                return false;
654
            }
655
656
            SIZE_T min_ws_size, max_ws_size;
657
            if (!GetProcessWorkingSetSize(GetCurrentProcess(), &min_ws_size, &max_ws_size)) {
658
                LLAMA_LOG_WARN("warning: GetProcessWorkingSetSize failed: %s\n",
659
                        llama_format_win_err(GetLastError()).c_str());
660
                return false;
661
            }
662
            size_t increment = len + 1048576;
663
            min_ws_size += increment;
664
            max_ws_size += increment;
665
            if (!SetProcessWorkingSetSize(GetCurrentProcess(), min_ws_size, max_ws_size)) {
666
                LLAMA_LOG_WARN("warning: SetProcessWorkingSetSize failed: %s\n",
667
                        llama_format_win_err(GetLastError()).c_str());
668
                return false;
669
            }
670
        }
671
    }
672
673
    static void raw_unlock(void * ptr, size_t len) {
674
        if (!VirtualUnlock(ptr, len)) {
675
            LLAMA_LOG_WARN("warning: failed to VirtualUnlock buffer: %s\n",
676
                    llama_format_win_err(GetLastError()).c_str());
677
        }
678
    }
679
#else
680
    static size_t lock_granularity() {
681
        return (size_t) 65536;
682
    }
683
684
    bool raw_lock(const void * addr, size_t len) const {
685
        LLAMA_LOG_WARN("warning: mlock not supported on this system\n");
686
        return false;
687
    }
688
689
    static void raw_unlock(const void * addr, size_t len) {}
690
#endif
691
692
0
    impl() : addr(NULL), size(0), failed_already(false) {}
693
694
0
    void init(void * ptr) {
695
0
        GGML_ASSERT(addr == NULL && size == 0);
696
0
        addr = ptr;
697
0
    }
698
699
0
    void grow_to(size_t target_size) {
700
0
        GGML_ASSERT(addr);
701
0
        if (failed_already) {
702
0
            return;
703
0
        }
704
0
        size_t granularity = lock_granularity();
705
0
        target_size = (target_size + granularity - 1) & ~(granularity - 1);
706
0
        if (target_size > size) {
707
0
            if (raw_lock((uint8_t *) addr + size, target_size - size)) {
708
0
                size = target_size;
709
0
            } else {
710
0
                failed_already = true;
711
0
            }
712
0
        }
713
0
    }
714
715
    void * addr;
716
    size_t size;
717
718
    bool failed_already;
719
};
720
721
0
llama_mlock::llama_mlock() : pimpl(std::make_unique<impl>()) {}
722
0
llama_mlock::~llama_mlock() = default;
723
724
0
void llama_mlock::init(void * ptr) { pimpl->init(ptr); }
725
0
void llama_mlock::grow_to(size_t target_size) { pimpl->grow_to(target_size); }
726
727
#if defined(_POSIX_MEMLOCK_RANGE) || defined(_WIN32)
728
const bool llama_mlock::SUPPORTED = true;
729
#else
730
const bool llama_mlock::SUPPORTED = false;
731
#endif
732
733
0
size_t llama_path_max() {
734
    return PATH_MAX;
735
0
}