Files
llama.cpp/tests/test-llama-mmap.cpp
T
Julius TischbeinandOliver Simons 9d340ec341 Windows unbuffered model load (#26014)
* Windows unbuffered io

* Fix read len calculation

* Add test and model load timing

* chunked fallback read + removing filepointer semantic divergence between linux and windows

* tests : remove unused mmap test arguments

Assisted-by: Codex

* remove timing, set file pointer after chunk read, test refinement

* Update tests/test-llama-mmap.cpp

Co-authored-by: Oliver Simons <osimons@nvidia.com>

* Update src/llama-mmap.cpp

Co-authored-by: Oliver Simons <osimons@nvidia.com>

* test refinement

Assisted-by: Codex

* remove duplicate constexpr

Assisted-by: Codex

* adding label behavior to tests

Assisted-by: Codex

---------

Co-authored-by: Oliver Simons <osimons@nvidia.com>
2026-11-09 19:22:08 +01:00

233 lines
8.7 KiB
C++

#include "testing.h"
#include "../src/llama-mmap.h"
#include <algorithm>
#include <chrono>
#include <cstddef>
#include <cstdio>
#include <cstdlib>
#include <filesystem>
#include <fstream>
#include <stdexcept>
#include <string>
#include <system_error>
#include <utility>
#include <vector>
#if defined(_WIN32)
#include <malloc.h>
#endif
static constexpr size_t test_file_size = LLAMA_DIRECT_IO_BUFFER_SIZE + 3*1024*1024 + 1;
static constexpr size_t test_io_size = 1024*1024;
static uint8_t test_byte(size_t offset) {
// Mix high offset bits into each byte to detect repeated chunks.
uint64_t value = offset;
value = (value ^ (value >> 30)) * 0xbf58476d1ce4e5b9ULL;
value = (value ^ (value >> 27)) * 0x94d049bb133111ebULL;
return static_cast<uint8_t>(value ^ (value >> 31));
}
static bool matches(const void * data, size_t offset, size_t size) {
const auto * bytes = static_cast<const uint8_t *>(data);
for (size_t i = 0; i < size; ++i) {
if (bytes[i] != test_byte(offset + i)) {
return false;
}
}
return true;
}
static void check_test_pattern(testing & t) {
uint8_t buffer[256];
for (size_t i = 0; i < sizeof(buffer); ++i) {
buffer[i] = test_byte(i);
}
t.assert_true("reject data repeated after 512 KiB", !matches(buffer, 512 * 1024, sizeof(buffer)));
t.assert_true("reject data repeated after a direct I/O chunk", !matches(buffer, LLAMA_DIRECT_IO_BUFFER_SIZE, sizeof(buffer)));
}
struct temporary_file {
std::filesystem::path path;
temporary_file() {
const auto now = std::chrono::steady_clock::now().time_since_epoch().count();
path = std::filesystem::temp_directory_path() / ("test-llama-mmap-" + std::to_string(now) + ".bin");
}
~temporary_file() {
std::error_code error;
std::filesystem::remove(path, error);
}
};
struct aligned_buffer {
void * data = nullptr;
aligned_buffer(size_t alignment, size_t size) {
alignment = std::max(alignment, alignof(std::max_align_t));
#if defined(_WIN32)
data = _aligned_malloc(size, alignment);
#else
if (posix_memalign(&data, alignment, size) != 0) {
data = nullptr;
}
#endif
}
~aligned_buffer() {
#if defined(_WIN32)
_aligned_free(data);
#else
free(data);
#endif
}
aligned_buffer(const aligned_buffer &) = delete;
aligned_buffer & operator=(const aligned_buffer &) = delete;
};
static void write_test_file(const std::filesystem::path & path) {
std::ofstream file(path, std::ios::binary);
if (!file) {
throw std::runtime_error("failed to create test file");
}
std::vector<uint8_t> buffer(test_io_size);
for (size_t offset = 0; offset < test_file_size; offset += buffer.size()) {
const size_t size = std::min(buffer.size(), test_file_size - offset);
for (size_t i = 0; i < size; ++i) {
buffer[i] = test_byte(offset + i);
}
file.write(reinterpret_cast<const char *>(buffer.data()), size);
if (!file) {
throw std::runtime_error("failed to write test file");
}
}
}
static void check_file(testing & t, const std::filesystem::path & path, bool use_direct_io) {
llama_file file(path.string().c_str(), "rb", use_direct_io);
if (use_direct_io && !file.has_direct_io()) {
t.skip("direct I/O is unavailable for the test file");
return;
}
t.assert_equal("requested I/O mode", use_direct_io, file.has_direct_io());
t.assert_equal(test_file_size, file.size());
t.assert_true("read alignment is nonzero", file.read_alignment() != 0);
const size_t alignment = file.read_alignment();
const std::vector<std::pair<size_t, size_t>> ranges = {
{ 0, 1 },
{ 1, 31 },
{ alignment - 1, alignment + 3 },
{ LLAMA_DIRECT_IO_BUFFER_SIZE - 11, 27 },
{ test_file_size - 31, 31 },
{ 1, LLAMA_DIRECT_IO_BUFFER_SIZE + 31 },
{ 1, test_file_size - 1 },
{0, test_file_size}
};
for (const auto & range : ranges) {
std::vector<uint8_t> buffer(range.second);
file.seek(range.first, SEEK_SET);
file.read_raw(buffer.data(), buffer.size());
t.assert_equal("I/O mode after read", use_direct_io, file.has_direct_io());
t.assert_true("read expected bytes", matches(buffer.data(), range.first, buffer.size()));
t.assert_equal(range.first + range.second, file.tell());
}
std::vector<uint8_t> buffer(test_io_size - 1);
file.seek(0, SEEK_SET);
for (size_t offset = 0; offset < test_file_size; offset += buffer.size()) {
const size_t size = std::min(buffer.size(), test_file_size - offset);
file.read_raw(buffer.data(), size);
t.assert_equal("I/O mode after sequential read", use_direct_io, file.has_direct_io());
t.assert_true("sequential read expected bytes", matches(buffer.data(), offset, size));
t.assert_equal(offset + size, file.tell());
}
const size_t unsafe_size = ((LLAMA_DIRECT_IO_BUFFER_SIZE + 3 * alignment - 1) / alignment) * alignment;
aligned_buffer buffer_aligned(alignment, unsafe_size);
t.assert_true("allocate aligned buffer", buffer_aligned.data != nullptr);
if (buffer_aligned.data != nullptr) {
const size_t offset = 7 * alignment;
file.seek(offset, SEEK_SET);
file.read_raw_unsafe(buffer_aligned.data, unsafe_size);
t.assert_equal("I/O mode after unsafe read", use_direct_io, file.has_direct_io());
t.assert_true("unsafe read expected bytes", matches(buffer_aligned.data, offset, unsafe_size));
t.assert_equal(offset + unsafe_size, file.tell());
const size_t final_offset = (test_file_size - 1) & ~(alignment - 1);
file.seek(final_offset, SEEK_SET);
file.read_raw_unsafe(buffer_aligned.data, alignment);
t.assert_equal("I/O mode after unsafe EOF read", use_direct_io, file.has_direct_io());
t.assert_true("unsafe EOF read expected bytes", matches(buffer_aligned.data, final_offset, test_file_size - final_offset));
t.assert_equal(test_file_size, file.tell());
}
}
static void check_direct_io_fallback(testing & t, const std::filesystem::path & path) {
llama_file file(path.string().c_str(), "rb", true);
if (!file.has_direct_io()) {
t.skip("direct I/O is unavailable for the test file");
return;
}
t.assert_true("direct I/O is enabled before fallback", file.has_direct_io());
const size_t alignment = file.read_alignment();
aligned_buffer buffer(alignment, alignment + 1);
if (!t.assert_true("allocate aligned buffer", buffer.data != nullptr)) {
return;
}
auto * unaligned = static_cast<uint8_t *>(buffer.data) + 1;
const size_t offset = 7 * alignment;
file.seek(offset, SEEK_SET);
file.read_raw_unsafe(unaligned, alignment);
#ifdef _WIN32
t.assert_true("unaligned read disables direct I/O", !file.has_direct_io());
t.assert_equal(size_t(1), file.read_alignment());
#endif
t.assert_true("fallback read expected bytes", matches(unaligned, offset, alignment));
t.assert_equal(offset + alignment, file.tell());
file.read_raw(unaligned, alignment);
#ifdef _WIN32
t.assert_true("subsequent read stays buffered", !file.has_direct_io());
#endif
t.assert_true("subsequent read expected bytes", matches(unaligned, offset + alignment, alignment));
t.assert_equal(offset + 2 * alignment, file.tell());
}
static void check_mmap(testing & t, const std::filesystem::path & path) {
if (!llama_mmap::SUPPORTED) {
return;
}
llama_file file(path.string().c_str(), "rb");
llama_mmap mapping(&file, 0, false);
t.assert_equal(test_file_size, mapping.size());
const auto * data = static_cast<const uint8_t *>(mapping.addr());
t.assert_true("mapping has an address", data != nullptr);
if (data != nullptr) {
t.assert_true("first byte", matches(data, 0, 1));
t.assert_true("chunk boundary", matches(data + LLAMA_DIRECT_IO_BUFFER_SIZE - 11, LLAMA_DIRECT_IO_BUFFER_SIZE - 11, 27));
t.assert_true("last bytes", matches(data + test_file_size - 31, test_file_size - 31, 31));
}
}
int main() {
testing t;
temporary_file test_file;
t.test("test_pattern", [&] (testing & t) { check_test_pattern(t); });
t.test("write_test_file", [&] (testing &) { write_test_file(test_file.path); });
t.test("llama_file.buffered", [&] (testing & t) { check_file(t, test_file.path, false); });
t.test("llama_file.direct", [&] (testing & t) { check_file(t, test_file.path, true); });
t.test("llama_file.direct_fallback", [&] (testing & t) { check_direct_io_fallback(t, test_file.path); });
t.test("llama_mmap", [&] (testing & t) { check_mmap(t, test_file.path); });
return t.summary();
}