Coverage Report

Created: 2026-04-12 06:40

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