|
| 1 | +// mt-locked-buffer.cpp — see header for rationale. |
| 2 | +#include "mt-locked-buffer.h" |
| 3 | + |
| 4 | +#include "llama-impl.h" // LLAMA_LOG_* |
| 5 | + |
| 6 | +#include <cerrno> |
| 7 | +#include <cstring> |
| 8 | + |
| 9 | +#ifdef _WIN32 |
| 10 | + #include <windows.h> |
| 11 | +#else |
| 12 | + #include <sys/mman.h> |
| 13 | + #include <unistd.h> |
| 14 | +#endif |
| 15 | + |
| 16 | +namespace mt { |
| 17 | + |
| 18 | +LockedBuffer::~LockedBuffer() { |
| 19 | + reset(); |
| 20 | +} |
| 21 | + |
| 22 | +LockedBuffer::LockedBuffer(LockedBuffer && other) noexcept |
| 23 | + : data_(other.data_), size_(other.size_), locked_(other.locked_) { |
| 24 | + other.data_ = nullptr; |
| 25 | + other.size_ = 0; |
| 26 | + other.locked_ = false; |
| 27 | +} |
| 28 | + |
| 29 | +LockedBuffer & LockedBuffer::operator=(LockedBuffer && other) noexcept { |
| 30 | + if (this != &other) { |
| 31 | + reset(); |
| 32 | + data_ = other.data_; |
| 33 | + size_ = other.size_; |
| 34 | + locked_ = other.locked_; |
| 35 | + other.data_ = nullptr; |
| 36 | + other.size_ = 0; |
| 37 | + other.locked_ = false; |
| 38 | + } |
| 39 | + return *this; |
| 40 | +} |
| 41 | + |
| 42 | +void LockedBuffer::reset() { |
| 43 | + if (!data_) { |
| 44 | + size_ = 0; |
| 45 | + locked_ = false; |
| 46 | + return; |
| 47 | + } |
| 48 | +#ifdef _WIN32 |
| 49 | + if (locked_) { |
| 50 | + VirtualUnlock(data_, size_); |
| 51 | + } |
| 52 | + VirtualFree(data_, 0, MEM_RELEASE); |
| 53 | +#else |
| 54 | + if (locked_) { |
| 55 | + munlock(data_, size_); |
| 56 | + } |
| 57 | + munmap(data_, size_); |
| 58 | +#endif |
| 59 | + data_ = nullptr; |
| 60 | + size_ = 0; |
| 61 | + locked_ = false; |
| 62 | +} |
| 63 | + |
| 64 | +bool LockedBuffer::allocate(size_t size_bytes, bool lock) { |
| 65 | + reset(); |
| 66 | + if (size_bytes == 0) { |
| 67 | + return true; |
| 68 | + } |
| 69 | + |
| 70 | +#ifdef _WIN32 |
| 71 | + data_ = static_cast<uint8_t *>( |
| 72 | + VirtualAlloc(nullptr, size_bytes, MEM_COMMIT | MEM_RESERVE, PAGE_READWRITE)); |
| 73 | + if (!data_) { |
| 74 | + LLAMA_LOG_ERROR( |
| 75 | + "mt::LockedBuffer: VirtualAlloc(%zu bytes / %.1f MiB) failed (error %lu)\n", |
| 76 | + size_bytes, (double) size_bytes / (1024.0 * 1024.0), |
| 77 | + (unsigned long) GetLastError()); |
| 78 | + return false; |
| 79 | + } |
| 80 | + size_ = size_bytes; |
| 81 | + if (lock) { |
| 82 | + if (VirtualLock(data_, size_bytes)) { |
| 83 | + locked_ = true; |
| 84 | + } else { |
| 85 | + LLAMA_LOG_WARN( |
| 86 | + "mt::LockedBuffer: VirtualLock(%.1f MiB) failed (error %lu). " |
| 87 | + "Buffer is allocated but eligible for page-out under RAM pressure. " |
| 88 | + "Raise the process working-set quota to fix.\n", |
| 89 | + (double) size_bytes / (1024.0 * 1024.0), |
| 90 | + (unsigned long) GetLastError()); |
| 91 | + } |
| 92 | + } |
| 93 | +#else |
| 94 | + int flags = MAP_PRIVATE | MAP_ANONYMOUS; |
| 95 | + bool tried_map_locked = false; |
| 96 | + |
| 97 | + #ifdef MAP_LOCKED |
| 98 | + if (lock) { |
| 99 | + flags |= MAP_LOCKED; |
| 100 | + tried_map_locked = true; |
| 101 | + } |
| 102 | + #endif |
| 103 | + |
| 104 | + void * p = mmap(nullptr, size_bytes, PROT_READ | PROT_WRITE, flags, -1, 0); |
| 105 | + |
| 106 | + #ifdef MAP_LOCKED |
| 107 | + if (p == MAP_FAILED && tried_map_locked) { |
| 108 | + // MAP_LOCKED often fails on RLIMIT_MEMLOCK; retry without it and try |
| 109 | + // mlock() after, which gives a clearer error path. |
| 110 | + int saved_errno = errno; |
| 111 | + flags &= ~MAP_LOCKED; |
| 112 | + p = mmap(nullptr, size_bytes, PROT_READ | PROT_WRITE, flags, -1, 0); |
| 113 | + if (p == MAP_FAILED) { |
| 114 | + LLAMA_LOG_ERROR( |
| 115 | + "mt::LockedBuffer: mmap(%.1f MiB) failed: %s " |
| 116 | + "(also failed with MAP_LOCKED: %s)\n", |
| 117 | + (double) size_bytes / (1024.0 * 1024.0), |
| 118 | + strerror(errno), strerror(saved_errno)); |
| 119 | + return false; |
| 120 | + } |
| 121 | + // fall through — we have an unlocked mapping; mlock() pass below. |
| 122 | + tried_map_locked = false; |
| 123 | + } else if (p != MAP_FAILED && tried_map_locked) { |
| 124 | + // MAP_LOCKED succeeded — pages are pinned. |
| 125 | + locked_ = true; |
| 126 | + } |
| 127 | + #endif |
| 128 | + |
| 129 | + if (p == MAP_FAILED) { |
| 130 | + LLAMA_LOG_ERROR( |
| 131 | + "mt::LockedBuffer: mmap(%.1f MiB) failed: %s\n", |
| 132 | + (double) size_bytes / (1024.0 * 1024.0), strerror(errno)); |
| 133 | + return false; |
| 134 | + } |
| 135 | + |
| 136 | + data_ = static_cast<uint8_t *>(p); |
| 137 | + size_ = size_bytes; |
| 138 | + |
| 139 | + // If we asked for a lock but MAP_LOCKED wasn't used or didn't apply, |
| 140 | + // do a follow-up mlock() so we get a clear errno path. |
| 141 | + if (lock && !locked_) { |
| 142 | + if (mlock(data_, size_bytes) == 0) { |
| 143 | + locked_ = true; |
| 144 | + } else { |
| 145 | + LLAMA_LOG_WARN( |
| 146 | + "mt::LockedBuffer: mlock(%.1f MiB) failed: %s. " |
| 147 | + "Buffer is allocated but eligible for swap-out under RAM pressure. " |
| 148 | + "Raise RLIMIT_MEMLOCK (systemd unit: LimitMEMLOCK=infinity) " |
| 149 | + "or run with CAP_IPC_LOCK to fix.\n", |
| 150 | + (double) size_bytes / (1024.0 * 1024.0), strerror(errno)); |
| 151 | + } |
| 152 | + } |
| 153 | +#endif |
| 154 | + |
| 155 | + return true; |
| 156 | +} |
| 157 | + |
| 158 | +} // namespace mt |
0 commit comments