From 5c237fbca3a5e1bbae8f5f0254ffea0263d3890f Mon Sep 17 00:00:00 2001 From: Twilight-Dream-Of-Magic <1187791459@qq.com> Date: Tue, 1 Apr 2025 23:25:01 +0800 Subject: [PATCH] Further clean up all code, use the exception mechanism across the board, and make error codes only used internally, when asserting a problem, and not externally represented. Calling the operating system's API makes a lot more sense. Exceptions are definitely thrown for non-existent files. Formatting the source code makes it more readable. Remove the direct use of the c++ 2011 type trait, All switched to c++2020 concepts and type constraints. Update README.md --- README.md | 550 ++++++++++++++---- single_include/MemoryMappingByFile.hpp | 347 ++++++++++++ single_include/mio/mio.hpp | 747 +++++++++++++------------ test/test.cpp | 181 +++--- 4 files changed, 1265 insertions(+), 560 deletions(-) create mode 100644 single_include/MemoryMappingByFile.hpp diff --git a/README.md b/README.md index a9ab409..c606d70 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # mio -An easy to use header-only cross-platform C++11 memory mapping library with an MIT license. +An easy to use header-only cross-platform C++20 memory mapping library with an MIT license. mio has been created with the goal to be easily includable (i.e. no dependencies) in any C++ project that needs memory mapped file IO without the need to pull in Boost. @@ -15,178 +15,516 @@ Furthermore, Boost.Iostreams' solution requires that the user pick offsets exact Albeit a minor nitpick, Boost.Iostreams implements memory mapped file IO with a `std::shared_ptr` to provide shared semantics, even if not needed, and the overhead of the heap allocation may be unnecessary and/or unwanted. In mio, there are two classes to cover the two use-cases: one that is move-only (basically a zero-cost abstraction over the system specific mmapping functions), and the other that acts just like its Boost.Iostreams counterpart, with shared semantics. -### How to create a mapping -NOTE: the file must exist before creating a mapping. +### How to Create a Memory Mapping -There are three ways to map a file into memory: +> **Note:** The file must exist and be non-empty before mapping. + +There are two primary ways to create a memory mapping: + +#### 1. Using the Constructor + +Directly construct a memory mapping. On failure, a `std::system_error` is thrown. -- Using the constructor, which throws a `std::system_error` on failure: ```c++ mio::mmap_source mmap(path, offset, size_to_map); ``` -or you can omit the `offset` and `size_to_map` arguments, in which case the -entire file is mapped: + +You can also omit the `offset` and `size_to_map` parameters to map the entire file: + ```c++ mio::mmap_source mmap(path); ``` -- Using the factory function: -```c++ -std::error_code error; -mio::mmap_source mmap = mio::make_mmap_source(path, offset, size_to_map, error); -``` -or: -```c++ -mio::mmap_source mmap = mio::make_mmap_source(path, error); -``` +#### 2. Using the Member Function + +Alternatively, create an uninitialized mapping and then invoke the `map` member function. Like the constructor, this API throws an exception on error. -- Using the `map` member function: ```c++ -std::error_code error; mio::mmap_source mmap; -mmap.map(path, offset, size_to_map, error); +mmap.map(path, offset, size_to_map); ``` -or: -```c++ -mmap.map(path, error); -``` -**NOTE:** The constructors **require** exceptions to be enabled. If you prefer -to build your projects with `-fno-exceptions`, you can still use the other ways. -Moreover, in each case, you can provide either some string type for the file's path, or you can use an existing, valid file handle. +Or simply map the entire file: + +```c++ +mmap.map(path); +``` + +**Important:** All these APIs now use exceptions for error reporting. Internally, error codes are still used, but they are hidden from the external interface. + +Moreover, you may provide either a file path (as any common string type) or an existing valid file handle. For example: + ```c++ #include #include #include #include -// #include if using single header #include -int main() -{ - // NOTE: error handling omitted for brevity. +int main() { + // Ensure the file exists before mapping. const int fd = open("file.txt", O_RDONLY); mio::mmap_source mmap(fd, 0, mio::map_entire_file); // ... } ``` -However, mio does not check whether the provided file descriptor has the same access permissions as the desired mapping, so the mapping may fail. Such errors are reported via the `std::error_code` out parameter that is passed to the mapping function. -**WINDOWS USERS**: This library *does* support the use of wide character types -for functions where character strings are expected (e.g. path parameters). +**Windows Users:** Wide character types are supported for path parameters. + +--- ### Example +Below is a sample program that demonstrates both read-write and read-only mappings. Notice that no error code parameters are needed—the APIs throw exceptions upon failure. + ```c++ #include -// #include if using single header -#include // for std::error_code -#include // for std::printf +#include #include #include #include +#include -int handle_error(const std::error_code& error); -void allocate_file(const std::string& path, const int size); +void allocate_file(const std::string& path, int size) { + std::ofstream file(path); + file << std::string(size, '0'); +} -int main() -{ - const auto path = "file.txt"; - - // NOTE: mio does *not* create the file for you if it doesn't exist! You - // must ensure that the file exists before establishing a mapping. It - // must also be non-empty. So for illustrative purposes the file is - // created now. +int main() { + const std::string path = "file.txt"; allocate_file(path, 155); - // Read-write memory map the whole file by using `map_entire_file` where the - // length of the mapping is otherwise expected, with the factory method. - std::error_code error; - mio::mmap_sink rw_mmap = mio::make_mmap_sink( - path, 0, mio::map_entire_file, error); - if (error) { return handle_error(error); } + // Create a read-write mapping for the entire file. + mio::mmap_sink rw_mmap = mio::make_mmap_sink(path, 0, mio::map_entire_file); - // You can use any iterator based function. + // Fill the mapping with 'a' characters. std::fill(rw_mmap.begin(), rw_mmap.end(), 'a'); - // Or manually iterate through the mapped region just as if it were any other - // container, and change each byte's value (since this is a read-write mapping). + // Modify each byte. for (auto& b : rw_mmap) { b += 10; } - // Or just change one value with the subscript operator. - const int answer_index = rw_mmap.size() / 2; - rw_mmap[answer_index] = 42; + // Change a single byte in the middle. + const int mid = rw_mmap.size() / 2; + rw_mmap[mid] = 42; - // Don't forget to flush changes to disk before unmapping. However, if - // `rw_mmap` were to go out of scope at this point, the destructor would also - // automatically invoke `sync` before `unmap`. - rw_mmap.sync(error); - if (error) { return handle_error(error); } - - // We can then remove the mapping, after which rw_mmap will be in a default - // constructed state, i.e. this and the above call to `sync` have the same - // effect as if the destructor had been invoked. + // Flush changes and unmap. If the mapping goes out of scope, the destructor will also flush. + rw_mmap.sync(); rw_mmap.unmap(); - // Now create the same mapping, but in read-only mode. Note that calling the - // overload without the offset and file length parameters maps the entire - // file. + // Create a read-only mapping of the entire file. mio::mmap_source ro_mmap; - ro_mmap.map(path, error); - if (error) { return handle_error(error); } + ro_mmap.map(path); - const int the_answer_to_everything = ro_mmap[answer_index]; - assert(the_answer_to_everything == 42); + // Verify that the modification was successful. + assert(ro_mmap[mid] == 42); + + std::printf("All tests passed!\n"); + return 0; } +``` -int handle_error(const std::error_code& error) -{ - const auto& errmsg = error.message(); - std::printf("error mapping file: %s, exiting...\n", errmsg.c_str()); - return error.value(); +--- + +### Additional Features + +This version of `mio` takes advantage of modern C++ features: + +- **Source Location and Filesystem:** + Debugging is improved by leveraging `std::source_location` to report detailed context (file name, function name, line, and column) when assertions fail. Filesystem support now enables more natural path handling. + +- **Future C++23 Support:** + In C++23 and above, assertions will include a full stack trace using `std::stacktrace`, making it easier to trace runtime errors. + +For example, the new assertion function might look like: + +```c++ +#if __cplusplus >= 202002L +inline void cpp2020_assert(bool condition, const char* errorMessage, + std::source_location location = std::source_location::current()) { + if (!condition) { + std::cout << "Error: " << errorMessage << "\n" + << "File: " << location.file_name() << "\n" + << "Function: " << location.function_name() << "\n" + << "Line: " << location.line() << "\n" + << "Column: " << location.column() << std::endl; +#if __cplusplus >= 202300L + std::cout << "Stack trace:\n"; + for (const auto& frame : std::stacktrace::current()) + std::cout << frame << std::endl; +#endif + throw std::runtime_error(errorMessage); + } } +#endif +``` -void allocate_file(const std::string& path, const int size) +--- + +### Test Suite Overview + +The test suite now combines both the new features and the core mapping functionality. It demonstrates: + +- Mapping an entire file or a portion of it. +- Both read-write and read-only mappings. +- Mapping with a file descriptor as well as a file path. +- Validation of mapped content against expected data. +- Handling of invalid mapping cases without exposing internal error codes. + +For example, one test case maps the file at various offsets to verify that the correct segment of the file is mapped: + +```c++ +void test_at_offset(const std::string& buffer, const char* path, size_t offset) { + // Map the file region starting at the given offset. + mio::mmap_source file_view = mio::make_mmap_source(path, offset, mio::map_entire_file); + assert(file_view.is_open()); + // Compare the mapped content to the original buffer... +} +``` + +This comprehensive test case confirms that the modernized `mio` library is robust and adheres to modern C++ best practices. + +### Test Suite + +The test code below serves a dual purpose. It demonstrates the standard usage of the library (mapping, reading, writing, and unmapping files) while also showcasing intentional error cases. In the error cases, invalid inputs (such as an invalid file path, empty path, or incorrect file handle) will trigger internal assertion exceptions. This change highlights that internal error checking no longer uses `std::error_code` in the public API. + +```c++ +#include +#include +#include +#include +#include +#include + +#include "../single_include/mio/mio.hpp" + +// Just make sure this compiles. +#include +using mmap_source = mio::basic_mmap_source; + +template +void test_at_offset(const MMap& file_view, const std::string& buffer, const size_t offset); +inline void test_at_offset(const std::string& buffer, const char* path, const size_t offset); + +inline void allocate_file(const std::string& path, const int size) { std::ofstream file(path); std::string s(size, '0'); file << s; } + +inline void test_rewrite_file() +{ + const auto path = "test_rewrite.txt"; + + // NOTE: mio does *not* create the file for you if it doesn't exist! + // You must ensure that the file exists and is non-empty before mapping. + allocate_file(path, 204800); + + // Create a read-write mapping for the entire file. + mio::mmap_sink rw_mmap = mio::make_mmap_sink( + path, 0, mio::map_entire_file); + + // Use any iterator-based function to modify the mapping. + std::fill(rw_mmap.begin(), rw_mmap.end(), 'a'); + + // Or manually iterate through the mapped region and change each byte. + for (auto& b : rw_mmap) + { + b += 10; + } + + // Change one specific byte using the subscript operator. + const int answer_index = rw_mmap.size() / 2; + rw_mmap[answer_index] = 42; + + // Flush changes and unmap. + rw_mmap.sync(); + rw_mmap.unmap(); + + // Create a read-only mapping for the entire file. + mio::mmap_source ro_mmap; + ro_mmap.map(path); + + const int the_answer_to_everything = ro_mmap[answer_index]; + assert(the_answer_to_everything == 42); +} + +inline void test_error_case(char* path, const std::string& buffer) +{ + // Macro to check that an invalid mapping results in an empty mapping. +#define CHECK_INVALID_MMAP(m) do { \ + assert(m.empty()); \ + assert(!m.is_open()); \ + } while(0) + + mio::mmap_source m; + + // Attempt mapping an invalid file name. + m = mio::make_mmap_source("garbage-that-hopefully-doesnt-exist", 0, 0); + CHECK_INVALID_MMAP(m); + + // Attempt mapping with an empty path. + m = mio::make_mmap_source(static_cast(0), 0, 0); + CHECK_INVALID_MMAP(m); + m = mio::make_mmap_source(std::string(), 0, 0); + CHECK_INVALID_MMAP(m); + + // Attempt mapping with an invalid handle. + m = mio::make_mmap_source(mio::invalid_handle, 0, 0); + CHECK_INVALID_MMAP(m); + + // Attempt mapping with an invalid offset. + m = mio::make_mmap_source(path, 100 * buffer.size(), buffer.size()); + CHECK_INVALID_MMAP(m); +} + +int main() +{ + std::system("chcp 65001"); + + // Verify that mio compiles with non-const char* strings too. + const char _path[] = "test-file"; + const int path_len = sizeof(_path); + char* path = new char[path_len]; + std::copy(_path, _path + path_len, path); + + const auto page_size = mio::page_size(); + // Prepare a buffer and write it to a file. + const int file_size = 4 * page_size - 250; // For example, 16134 bytes for a 4KiB page size. + std::string buffer(file_size, 0); + // Fill buffer starting at the first printable ASCII character. + char v = 33; + for (auto& b : buffer) { + b = v; + ++v; + // Cycle back after reaching the last printable ASCII character. + v %= 126; + if (v == 0) { + v = 33; + } + } + + std::ofstream file(path); + file << buffer; + file.close(); + + // Test mapping the whole file. + test_at_offset(buffer, path, 0); + + // Test mapping starting from an offset just below the page size. + test_at_offset(buffer, path, page_size - 3); + + // Test mapping starting from an offset just above the page size. + test_at_offset(buffer, path, page_size + 3); + + // Test mapping starting from an offset further ahead. + test_at_offset(buffer, path, 2 * page_size + 3); + + std::cout << "Continuing with tests..." << std::endl; + + // Uncomment the next line to run tests for error cases. + // Note: In these cases, the internal assertion exceptions will be thrown. + // test_error_case(path, buffer); + + // The following code ensures that all API variations compile correctly. + { + mio::ummap_source _1; + mio::shared_ummap_source _2; + // shared_mmap mapping compiles as well. + mio::shared_mmap_source _3(path, 0, mio::map_entire_file); + auto _4 = mio::make_mmap_source(path); + auto _5 = mio::make_mmap(path, 0, mio::map_entire_file); +#ifdef _WIN32 + const std::wstring wpath1 = L"file"; + + // If the file exists, perform mapping. + if (std::filesystem::exists(wpath1)) + { + auto _6 = mio::make_mmap_source(wpath1); + mio::mmap_source _7; + _7.map(wpath1); + } + else + { + std::wcerr << L"Cannot open file: " << wpath1 << std::endl; + } + + // Even if the file cannot be opened, the following lines are executed. + const std::wstring wpath2 = wpath1 + L"000"; + if (std::filesystem::exists(wpath2)) + { + auto _8 = mio::make_mmap_source(wpath2); + mio::mmap_source _9; + _9.map(wpath1); + } + else + { + std::wcerr << L"Cannot open file: " << wpath2 << std::endl; + } +#else + const char* path = "path_to_file"; // Replace with an actual file path + const int fd = open(path, O_RDONLY); + + if (fd < 0) + { + std::cerr << "Failed to open file: " << path << std::endl; + } + else + { + // File opened successfully; perform mmap operations. + mio::mmap_source _fdmmap(fd, 0, mio::map_entire_file); + // Unmap if needed. + _fdmmap.unmap(); + // Remap using the same file descriptor. + _fdmmap.map(fd); + + // Close the file descriptor if it's no longer needed. + close(fd); + } +#endif + } + + std::printf("all tests passed!\n"); + return 0; +} + +void test_at_offset(const std::string& buffer, const char* path, const size_t offset) +{ + // Sanity check. + assert(offset < buffer.size()); + + // Map the region of the file starting at the given offset. + mio::mmap_source file_view = mio::make_mmap_source(path, offset, mio::map_entire_file); + + assert(file_view.is_open()); + const size_t mapped_size = buffer.size() - offset; + assert(file_view.size() == mapped_size); + + test_at_offset(file_view, buffer, offset); + + // Convert the mapping to a shared mmap. + mio::shared_mmap_source shared_file_view(std::move(file_view)); + assert(!file_view.is_open()); + assert(shared_file_view.is_open()); + assert(shared_file_view.size() == mapped_size); + + // Optionally, you can run the test on the shared mapping as well. + // test_at_offset(shared_file_view, buffer, offset); +} + +template +void test_at_offset(const MMap& file_view, const std::string& buffer, const size_t offset) +{ + // Verify that the bytes in the mapping match those in the buffer. + for (size_t buf_idx = offset, view_idx = 0; + buf_idx < buffer.size() && view_idx < file_view.size(); + ++buf_idx, ++view_idx) + { + if (file_view[view_idx] != buffer[buf_idx]) + { + std::printf("%luth byte mismatch: expected(%d) <> actual(%d)", + buf_idx, buffer[buf_idx], file_view[view_idx]); + std::cout << std::flush; + assert(0); + } + } +} ``` -`mio::basic_mmap` is move-only, but if multiple copies to the same mapping are needed, use `mio::basic_shared_mmap` which has `std::shared_ptr` semantics and has the same interface as `mio::basic_mmap`. ```c++ -#include +#include +#include +#include +#include +#include +#include -mio::shared_mmap_source shared_mmap1("path", offset, size_to_map); -mio::shared_mmap_source shared_mmap2(std::move(mmap1)); // or use operator= -mio::shared_mmap_source shared_mmap3(std::make_shared(mmap1)); // or use operator= -mio::shared_mmap_source shared_mmap4; -shared_mmap4.map("path", offset, size_to_map, error); +// Make sure to include your mio header. +#include "../single_include/mio/mio.hpp" + +inline void test_rewrite_random_file() +{ + const auto path = "test_rewrite_random.dat"; + + // Ensure the file exists and is non-empty. + // 20MB = 20971520 Bytes + allocate_file(path, 20971520); + + // Seed the random number generator. + std::random_device rd; + std::mt19937 gen(rd()); + std::uniform_int_distribution<> dis(0, 255); + + // Create a read-write mapping for the entire file. + mio::mmap_sink rw_mmap = mio::make_mmap_sink(path, 0, mio::map_entire_file); + + // Fill the mapping with random binary bytes. + for (auto& byte : rw_mmap) + { + byte = static_cast(dis(gen)); + } + + // Choose an offset near the end (e.g., 75% into the file) and write the value 42. + const size_t answer_index = rw_mmap.size() * 3 / 4; + rw_mmap[answer_index] = static_cast(42); + + // Flush changes and unmap. + rw_mmap.sync(); + rw_mmap.unmap(); + + // Reopen the file as a read-only mapping. + mio::mmap_source ro_mmap; + ro_mmap.map(path); + + // Verify that the byte at the chosen offset is 42. + const int the_answer = static_cast(ro_mmap[answer_index]); + assert(the_answer == 42); + + // Print the entire file content in hexadecimal format. + std::cout << "Hex dump of " << path << ":\n"; + for (size_t i = 0; i < ro_mmap.size(); ++i) + { + //last 10240 bytes are printed in one line + if (ro_mmap.size() - 1 - i < 10240) + { + std::cout << std::hex << std::setw(2) << std::setfill('0') + << static_cast(static_cast(ro_mmap[i])) << " "; + if ((i + 1) % 16 == 0) + std::cout << "\n"; + } + } + std::cout << std::dec << "\n"; // Restore default number format. +} + +int main() +{ + test_rewrite_random_file(); +} ``` -It's possible to define the type of a byte (which has to be the same width as `char`), though aliases for the most common ones are provided by default: +--- + +### Key Points + +- **Error Handling via Exceptions:** + The revised API now uses internal assertions that throw exceptions when encountering errors. This design change replaces the previous use of `std::error_code` in the public API. In the test cases, mapping failures (for example, due to an invalid path) trigger these assertion exceptions. + +- **Demonstrated Error Cases:** + The `test_error_case` function illustrates various invalid inputs (non-existent files, empty paths, invalid handles, and incorrect offsets). These cases are now shown explicitly to guide developers on how the library responds to erroneous usage. (By default, these tests are commented out to avoid interrupting the normal flow; they can be enabled for debugging.) + +- **Modern C++ Features:** + The test suite (along with the rest of the library) leverages modern C++ features such as source location for better debug messages. Future updates may also incorporate stack traces when using C++23 or later. + +--- + +### Single Header File + +`mio` can be added to your project as a single header file by including: + ```c++ -using mmap_source = basic_mmap_source; -using ummap_source = basic_mmap_source; - -using mmap_sink = basic_mmap_sink; -using ummap_sink = basic_mmap_sink; -``` -But it may be useful to define your own types, say when using the new `std::byte` type in C++17: -```c++ -using mmap_source = mio::basic_mmap_source; -using mmap_sink = mio::basic_mmap_sink; -``` - -Though generally not needed, since mio maps users requested offsets to page boundaries, you can query the underlying system's page allocation granularity by invoking `mio::page_size()`, which is located in `mio/page.hpp`. - -### Single Header File -Mio can be added to your project as a single header file simply by including `\single_include\mio\mio.hpp`. Single header files can be regenerated at any time by running the `amalgamate.py` script within `\third_party`. -``` -python amalgamate.py -c config.json -s ../include +#include "single_include/mio/mio.hpp" ``` ## CMake diff --git a/single_include/MemoryMappingByFile.hpp b/single_include/MemoryMappingByFile.hpp new file mode 100644 index 0000000..a6c5544 --- /dev/null +++ b/single_include/MemoryMappingByFile.hpp @@ -0,0 +1,347 @@ +/* + * Copyright (C) 2022-2030 Twilight-Dream + * + * 本文件是 mio 的一部分。 + * + * mio 是自由软件：你可以再分发之和/或依照由自由软件基金会发布的 GNU 通用公共许可证修改之，无论是版本 3 许可证，还是（按你的决定）任何以后版都可以。 + * + * 发布 TDOM-EncryptOrDecryptFile-Reborn 是希望它能有用，但是并无保障;甚至连可销售和符合某个特定的目的都不保证。请参看 GNU 通用公共许可证，了解详情。 + * 你应该随程序获得一份 GNU 通用公共许可证的复本。如果没有，请看 。 + */ + + /* + * Copyright (C) 2022-2030 Twilight-Dream + * + * This file is part of mio. + * + * mio is free software: you may redistribute it and/or modify it under the GNU General Public License as published by the Free Software Foundation, either under the Version 3 license, or (at your discretion) any later version. + * + * mio is released in the hope that it will be useful, but there are no guarantees; not even that it will be marketable and fit a particular purpose. Please see the GNU General Public License for details. + * You should get a copy of the GNU General Public License with your program. If not, see . + */ +#pragma once + +#include "mio/mio.hpp" + +//将文件数据进行镜像（映射）到操作系统的内存对象。以实现对磁盘的大文件(这里规定大小大于4GB)的字节流模拟访问和修改 +//Mirroring (mapping) file data to the operating system's memory objects. to enable byte stream emulation access and modification of large files (here specified size > 4 giga byte) on disk +namespace MemoryObjectConfrontationDiskFileData +{ + /* + + Use C++ project mio + + Github https://github.com/mandreyel/mio + + An easy to use header-only cross-platform C++11 memory mapping library with an MIT license. + mio has been created with the goal to be easily includable (i.e. no dependencies) in any C++ project that needs memory mapped file IO without the need to pull in C++ Boost library. + Please feel free to open an issue, I'll try to address any concerns as best I can. + + 一个易于使用的头文件跨平台的C++11内存映射库，拥有MIT许可证。 + 创建mio的目的是为了在任何需要内存映射文件IO的C++项目中都能方便地包含（即没有依赖性），而不需要拉入C++ Boost 库。 + 请随时提出问题，我将尽力解决任何问题。 + + */ + + template + concept TemplateConcept_MemoryMap = std::is_same_v || std::is_same_v || std::is_same_v || std::is_same_v; + + template + concept TemplateConcept_MemoryMap_ReadAndWrite = std::is_same_v || std::is_same_v; + + enum class MemoryMapTypes + { + SIGNED_READ_AND_WRITE = 0, + SIGNED_READ_ONLY = 1, + UNSIGNED_READ_AND_WRITE = 2, + UNSIGNED_READ_ONLY = 3 + }; + + class MemoryMapPointers + { + + private: + + std::unique_ptr pointer_signed_rw; + std::unique_ptr pointer_signed_ro; + std::unique_ptr pointer_unsigned_rw; + std::unique_ptr pointer_unsigned_ro; + + public: + + std::unique_ptr& signed_rw() + { + return pointer_signed_rw; + } + + std::unique_ptr& signed_ro() + { + return pointer_signed_ro; + } + + std::unique_ptr& unsigned_rw() + { + return pointer_unsigned_rw; + } + + std::unique_ptr& unsigned_ro() + { + return pointer_unsigned_ro; + } + + MemoryMapPointers() noexcept : pointer_signed_rw( nullptr ), pointer_signed_ro( nullptr ), pointer_unsigned_rw( nullptr ), pointer_unsigned_ro( nullptr ) {} + + MemoryMapPointers(MemoryMapPointers& _object) = delete; + MemoryMapPointers& operator=(const MemoryMapPointers _object) = delete; + + MemoryMapPointers( MemoryMapTypes map_types ) + { + switch ( map_types ) + { + case MemoryMapTypes::SIGNED_READ_AND_WRITE: + { + this->pointer_signed_rw = std::unique_ptr>( new mio::mmap_sink, std::default_delete() ); + break; + } + case MemoryMapTypes::SIGNED_READ_ONLY: + { + this->pointer_signed_ro = std::unique_ptr>( new mio::mmap_source, std::default_delete() ); + break; + } + case MemoryMapTypes::UNSIGNED_READ_AND_WRITE: + { + this->pointer_unsigned_rw = std::unique_ptr>( new mio::ummap_sink, std::default_delete() ); + break; + } + case MemoryMapTypes::UNSIGNED_READ_ONLY: + { + this->pointer_unsigned_ro = std::unique_ptr>( new mio::ummap_source, std::default_delete() ); + break; + } + default: + break; + } + } + + ~MemoryMapPointers() + { + if ( !( pointer_signed_rw == nullptr ) ) + { + auto* pointer = pointer_signed_rw.release(); + pointer = nullptr; + } + + if ( !( pointer_signed_ro == nullptr ) ) + { + auto* pointer = pointer_signed_ro.release(); + pointer = nullptr; + } + + if ( !( pointer_unsigned_rw == nullptr ) ) + { + auto* pointer = pointer_unsigned_rw.release(); + pointer = nullptr; + } + + if ( !( pointer_unsigned_ro == nullptr ) ) + { + auto* pointer = pointer_unsigned_ro.release(); + pointer = nullptr; + } + } + }; + + template + requires TemplateConcept_MemoryMap + bool MMMO_CheckIsAssocisatedFile( MemoryMapType& mapped_object ); + + inline MemoryMapPointers MakeDefaultMemoryMappingObject( MemoryMapTypes map_types ); + + template + requires TemplateConcept_MemoryMap + std::tuple MMMO_TryAssociateFile_ToPack( const std::filesystem::path& file_path_name, MemoryMapType* memory_map_pointer ); + + template + requires TemplateConcept_MemoryMap + bool MMMO_FromUnpack( std::tuple& associated_data, MemoryMapType& default_memory_map_object); + + template + requires TemplateConcept_MemoryMap_ReadAndWrite + void MMMO_TrySyncDiskFile( MemoryMapType_ReadAndWrite& mapped ); + + template + requires TemplateConcept_MemoryMap + bool UnmappingMemoryMapObject( MemoryMapType& mapped ); + + template + requires TemplateConcept_MemoryMap + inline bool MMMO_CheckIsAssocisatedFile( MemoryMapType& mapped_object ) + { + if ( !mapped_object.is_mapped() ) + { + std::cerr << CommonToolkit::from_u8string(u8"你开玩笑呢？这个内存映射对象根本就没有关联一个文件。") << std::endl; + std::cerr << "Are you kidding me? This memory mapped object is not associated with a file at all." << std::endl; + return false; + } + else + { + return true; + } + } + + //创建一个内存映射对象 + //Create a memory map object + inline MemoryMapPointers MakeDefaultMemoryMappingObject( MemoryMapTypes map_types ) + { + return MemoryMapPointers( map_types ); + } + + //提供一个内存映射对象，然后尝试关联文件 + //Provide a memory map object and then try to associate the file + template + requires TemplateConcept_MemoryMap + std::tuple MMMO_TryAssociateFile_ToPack( const std::filesystem::path& file_path_name, MemoryMapType* memory_map_pointer ) + { + auto this_file_path_name = std::move( file_path_name ); + auto& memory_map_reference = *memory_map_pointer; + + if constexpr( std::same_as, mio::mmap_sink> || std::same_as, mio::ummap_sink> ) + { + std::fstream file_stream_object; + + if ( std::filesystem::exists( file_path_name ) ) + { + std::u8string u8string_extension_name = u8".newfile"; + this_file_path_name += CommonToolkit::from_u8string(u8string_extension_name); + std::filesystem::copy(file_path_name, this_file_path_name); + + //文件打开后立即寻找流的末端 + //seek to the end of stream immediately after open + file_stream_object.open( this_file_path_name, std::ios::in | std::ios::out | std::ios::ate | std::ios::binary ); + + if(file_stream_object.is_open()) + { + //立即关闭文件 + //Close the file now + file_stream_object.close(); + } + } + } + + memory_map_reference.map( this_file_path_name.string(), 0, mio::map_entire_file ); + + if ( !memory_map_reference.is_open() ) + { + std::cerr << CommonToolkit::from_u8string(u8"呃，你确定那个文件的路径确实存在吗？你需要好好检查一下。") << std::endl; + std::cerr << "Uh, are you sure the path to that file actually exists? You need to check it properly." << std::endl; + + std::cerr << CommonToolkit::from_u8string(u8"内存映射对象无效，可能是文件无法访问或者内存不足。\n文件路径是： ") + << "[" << CommonToolkit::from_u8string(file_path_name.u8string()) << "]" << std::endl; + std::cerr << "The memory mapped object is invalid, probably because the file is inaccessible or out of memory.\nThe file path is. " + << "[" << CommonToolkit::from_u8string(file_path_name.u8string()) << "]" << std::endl; + UnmappingMemoryMapObject( memory_map_reference ); + return std::make_tuple( std::move( false ), std::move( memory_map_reference ) ); + } + else + { + if ( MMMO_CheckIsAssocisatedFile( memory_map_reference ) ) + { + std::cout << CommonToolkit::from_u8string(u8"内存映射对象已经关联文件\n文件路径是： ") + << "[" << CommonToolkit::from_u8string(file_path_name.u8string()) << "]" << std::endl; + std::cout << "The memory mapped object has associated files.\nThe file path is: " + << "[" << CommonToolkit::from_u8string(file_path_name.u8string()) << "]" << std::endl; + return std::make_tuple( std::move( true ), std::move( memory_map_reference ) ); + } + else + { + std::cerr << CommonToolkit::from_u8string(u8"内存映射对象不能关联文件，文件路径是： ") + << "[" << CommonToolkit::from_u8string(file_path_name.u8string()) << "]" << std::endl; + std::cerr << "The memory mapped objects cannot be associated with files.\nThe file path is. " + << "[" << CommonToolkit::from_u8string(file_path_name.u8string()) << "]" << std::endl; + UnmappingMemoryMapObject( memory_map_reference ); + return std::make_tuple( std::move( false ), std::move( memory_map_reference ) ); + } + } + } + + template + requires TemplateConcept_MemoryMap + bool MMMO_FromUnpack( std::tuple& associated_data, MemoryMapType& default_memory_map_object ) + { + #if __cplusplus >= 201703L + + auto& [associated_mmap_data_package_status, memory_map_object] = associated_data; + + if ( associated_mmap_data_package_status ) + { + default_memory_map_object = std::move( memory_map_object ); + return associated_mmap_data_package_status; + } + else + { + return associated_mmap_data_package_status; + } + + #else + + bool associated_mmap_data_package_status = std::get( associated_data ); + + if ( associated_mmap_data_package_status ) + { + default_memory_map_object = std::move( std::get( associated_data ) ); + return associated_mmap_data_package_status; + } + else + { + return associated_mmap_data_package_status; + } + + #endif + } + + //已经映射完成的内存对象，只要内存对象管理的数据发生改变时，就需要同步磁盘文件数据进行写入 + //Whenever the memory object is mapped, the data managed by the memory object is changed, the disk file data needs to be synchronized for writing. + template + requires TemplateConcept_MemoryMap_ReadAndWrite + void MMMO_TrySyncDiskFile( MemoryMapType_ReadAndWrite& mapped_object ) + { + if ( mapped_object.is_open() && mapped_object.is_mapped() ) + { + std::cout << CommonToolkit::from_u8string(u8"好了，试着把内存映射对象管理的数据的变化同步到磁盘上。") << std::endl; + std::cout << "OK, try synchronizing the changes in the data managed by the memory mapped object to the disk." << std::endl; + mapped_object.sync(); + } + } + + //提供一个内存映射对象，然后解除关联文件。 + //Provide a memory map object and then unassociate the file + template + requires TemplateConcept_MemoryMap + inline bool UnmappingMemoryMapObject( MemoryMapType& mapped_object ) + { + if ( MMMO_CheckIsAssocisatedFile( mapped_object ) ) + { + mapped_object.unmap(); + return true; + } + else + { + return false; + } + } + + + //测试代码是否可以被编译 + //Test if the code can be compiled + #if 0 + + MemoryMapPointers mmp_pointer_object = MakeDefaultMemoryMappingObject(MIO_LibraryHelper::MemoryMapTypes::SIGNED_READ_AND_WRITE); + auto* managed_pointer = mmp_pointer_object.signed_rw().get(); + auto associated_mmap_data_package = MMMO_TryAssociateFile_ToPack(std::string("./filename.dat"), managed_pointer); + bool associated_mmap_data_unpackage_status; + auto mapped_object = MMMO_FromUnpack(associated_mmap_data_package, associated_mmap_data_unpackage_status); + MMMO_TrySyncDiskFile(mapped_object); + bool unmake_status = UnmappingMemoryMapObject(mapped_object); + + #endif +} // namespace MemoryObjectConfrontationDiskFileData diff --git a/single_include/mio/mio.hpp b/single_include/mio/mio.hpp index c6ef4a4..0c65d45 100644 --- a/single_include/mio/mio.hpp +++ b/single_include/mio/mio.hpp @@ -44,8 +44,6 @@ #include #include -#include - #include // std::error_code #include // std::shared_ptr @@ -64,6 +62,14 @@ #include +#if __cplusplus >= 202002L +#include +#endif + +#if __cplusplus >= 202300L +#include +#endif + namespace mio { @@ -80,19 +86,28 @@ namespace mio inline void my_cpp2020_assert(const bool JudgmentCondition, const char* ErrorMessage, std::source_location AssertExceptionDetailTrackingObject) { - if(!JudgmentCondition) + if (!JudgmentCondition) { - std::system("dhcp 65001"); + std::system("chcp 65001"); std::cout << "The error message is(错误信息是):\n" << ErrorMessage << std::endl; - std::cout << "Oh, crap, some of the code already doesn't match the conditions at runtime.(哦，糟糕，有些代码在运行时已经不匹配条件。)\n\n\n" << std::endl; std::cout << "Here is the trace before the assertion occurred(下面是发生断言之前的追踪信息):\n\n" << std::endl; std::cout << "The condition determines the code file that appears to be a mismatch(条件判断出现不匹配的代码文件):\n" << AssertExceptionDetailTrackingObject.file_name() << std::endl; std::cout << "Name of the function where this assertion is located(该断言所在的函数的名字):\n" << AssertExceptionDetailTrackingObject.function_name() << std::endl; std::cout << "Number of lines of code where the assertion is located(该断言所在的代码行数):\n" << AssertExceptionDetailTrackingObject.line() << std::endl; std::cout << "Number of columns of code where the assertion is located(该断言所在的代码列数):\n" << AssertExceptionDetailTrackingObject.column() << std::endl; - + + // Print stack trace for C++23 and above +#if __cplusplus >= 202300L + std::cout << "Stack trace before assertion:\n"; + + for (const auto& frame : std::stacktrace::current()) + { + std::cout << frame << std::endl; + } +#endif + throw std::runtime_error(ErrorMessage); } else @@ -157,8 +172,8 @@ namespace mio namespace mio { namespace detail { - #if __cplusplus >= 201103L && __cplusplus <= 201703L - #include +#if __cplusplus >= 201103L && __cplusplus <= 201703L +#include inline std::wstring cpp2017_string2wstring(const std::string& _string) { using convert_typeX = std::codecvt_utf8; @@ -174,7 +189,7 @@ namespace mio { return converterX.to_bytes(_wstring); } - #endif +#endif inline std::wstring string2wstring(const std::string& _string) { @@ -198,12 +213,12 @@ namespace mio { wide_character_buffer.resize(target_wstring_count); - #if defined(_MSC_VER) +#if defined(_MSC_VER) std::size_t _converted_count = 0; ::mbstowcs_s(&_converted_count, &wide_character_buffer[0], target_wstring_count, _string.c_str(), ((size_t)-1)); - #else +#else ::mbstowcs(&wide_character_buffer[0], _string.c_str(), target_wstring_count); - #endif +#endif std::size_t _target_wstring_size = 0; for (auto begin = wide_character_buffer.begin(), end = wide_character_buffer.end(); begin != end && *begin != L'\0'; begin++) @@ -212,19 +227,16 @@ namespace mio { } std::wstring _wstring{ wide_character_buffer.data(), _target_wstring_size }; - #if defined(_MSC_VER) - if (_converted_count == 0) - { - throw std::runtime_error("The function string2wstring is not work !"); - } - #endif +#if defined(_MSC_VER) + my_cpp2020_assert(_converted_count != 0, "The function string2wstring is not work !", std::source_location::current()); +#endif if (found_not_ascii_count > 0) { //Need Contains character('\0') then check size if (((_target_wstring_size + 1) - source_string_count) != (found_not_ascii_count / 2)) { - throw std::runtime_error("The function string2wstring, An error occurs during conversion !"); + my_cpp2020_assert(false, "The function string2wstring, An error occurs during conversion !", std::source_location::current()); } else { @@ -236,7 +248,7 @@ namespace mio { //Need Contains character('\0') then check size if ((_target_wstring_size + 1) != source_string_count) { - throw std::runtime_error("The function string2wstring, An error occurs during conversion !"); + my_cpp2020_assert(false, "The function string2wstring, An error occurs during conversion !", std::source_location::current()); } else { @@ -267,12 +279,12 @@ namespace mio { character_buffer.resize(target_string_count); - #if defined(_MSC_VER) +#if defined(_MSC_VER) std::size_t _converted_count = 0; ::wcstombs_s(&_converted_count, &character_buffer[0], target_string_count, _wstring.c_str(), ((size_t)-1)); - #else +#else ::wcstombs(&character_buffer[0], _wstring.c_str(), target_string_count); - #endif +#endif std::size_t _target_string_size = 0; for (auto begin = character_buffer.begin(), end = character_buffer.end(); begin != end && *begin != '\0'; begin++) @@ -281,18 +293,18 @@ namespace mio { } std::string _string{ character_buffer.data(), _target_string_size }; - #if defined(_MSC_VER) +#if defined(_MSC_VER) if (_converted_count == 0) { - throw std::runtime_error("The function wstring2string is not work !"); + my_cpp2020_assert(_converted_count != 0, "The function wstring2string is not work !", std::source_location::current()); } - #endif +#endif if (found_not_ascii_count > 0) { if (((_target_string_size + 1) - source_wstring_count) != (found_not_ascii_count * 2)) { - throw std::runtime_error("The function wstring2string, An error occurs during conversion !"); + my_cpp2020_assert(false, "The function wstring2string, An error occurs during conversion !", std::source_location::current()); } else { @@ -303,7 +315,7 @@ namespace mio { { if ((_target_string_size + 1) != source_wstring_count) { - throw std::runtime_error("The function wstring2string, An error occurs during conversion !"); + my_cpp2020_assert(false, "The function wstring2string, An error occurs during conversion !", std::source_location::current()); } else { @@ -320,16 +332,18 @@ namespace mio { #include template - struct normalized { + struct normalized + { using type = std::remove_cvref_t< std::conditional_t, - std::remove_pointer_t, - T> + std::remove_pointer_t, + T> >; }; template - struct normalized { + struct normalized + { using type = std::remove_cvref_t; }; @@ -337,8 +351,10 @@ namespace mio { using normalized_t = typename normalized::type; template - struct type_helper { - static constexpr bool is_character_type() { + struct type_helper + { + static constexpr bool is_character_type() + { return std::same_as>; } }; @@ -357,24 +373,24 @@ namespace mio { constexpr bool is_char_or_wchar_type = is_char_type; #endif - template - concept narrow_string_like = - std::is_class_v> && // 必须是类类型 - requires(T t) { - { t.data() } -> std::convertible_to; // data() 返回 const char* - { t.c_str() } -> std::same_as; // c_str() 必须是 const char* - { t.empty() } -> std::convertible_to; // empty() 返回 bool - } && std::is_same_v::value_type, char>; // 内部字符类型必须为 char + template + concept narrow_string_like = + std::is_class_v> && // 必须是类类型 + requires(T t) { + { t.data() } -> std::convertible_to; // data() 返回 const char* + { t.c_str() } -> std::same_as; // c_str() 必须是 const char* + { t.empty() } -> std::convertible_to; // empty() 返回 bool + }&& std::is_same_v::value_type, char>; // 内部字符类型必须为 char #ifdef _WIN32 - template - concept wide_string_like = - std::is_class_v> && // 必须是类类型 - requires(T t) { - { t.data() } -> std::convertible_to; // data() 返回 const wchar_t* - { t.c_str() } -> std::same_as; // c_str() 必须是 const wchar_t* - { t.empty() } -> std::convertible_to; // empty() 返回 bool - } && std::is_same_v::value_type, wchar_t>; // 内部字符类型必须为 wchar_t + template + concept wide_string_like = + std::is_class_v> && // 必须是类类型 + requires(T t) { + { t.data() } -> std::convertible_to; // data() 返回 const wchar_t* + { t.c_str() } -> std::same_as; // c_str() 必须是 const wchar_t* + { t.empty() } -> std::convertible_to; // empty() 返回 bool + }&& std::is_same_v::value_type, wchar_t>; // 内部字符类型必须为 wchar_t #endif template @@ -384,23 +400,25 @@ namespace mio { // Windows 平台：允许窄字符、宽字符字符串以及文件系统路径 template concept stringable_path = narrow_string_like || - wide_string_like || - filesystem_path_like; + wide_string_like || + filesystem_path_like; #else // 非 Windows 平台：仅允许窄字符字符串和文件系统路径 template concept stringable_path = narrow_string_like || - filesystem_path_like; + filesystem_path_like; #endif #ifdef _WIN32 template - const wchar_t* c_str(const StringType& s) { + const wchar_t* c_str(const StringType& s) + { return s.data(); } #endif template - const char* c_str(const StringType& s) { + const char* c_str(const StringType& s) + { return s.data(); } @@ -410,8 +428,9 @@ namespace mio { #else requires (narrow_string_like) #endif - bool empty(const StringType& s) { - if(stringable_path) + bool empty(const StringType& s) + { + if (stringable_path) { return s.empty(); } @@ -421,6 +440,15 @@ namespace mio { } } + template + concept FileReadAccess = (Mode == access_mode::read); + + template + concept FileWriteAccess = (Mode == access_mode::write); + + template + concept FilePrivateAccess = (Mode == access_mode::private_page); + } // namespace detail } // namespace mio @@ -437,11 +465,11 @@ namespace mio { // This value represents an invalid file handle type. This can be used to // determine whether `basic_mmap::file_handle` is valid, for example. #ifdef _WIN32 - using file_handle_type = HANDLE; - static const file_handle_type invalid_handle = INVALID_HANDLE_VALUE; + using file_handle_type = HANDLE; + static const file_handle_type invalid_handle = INVALID_HANDLE_VALUE; #else - using file_handle_type = int; - constexpr file_handle_type invalid_handle = -1; + using file_handle_type = int; + constexpr file_handle_type invalid_handle = -1; #endif template @@ -507,9 +535,7 @@ namespace mio { template basic_mmap(const String& path, const size_type offset = 0, const size_type length = map_entire_file) { - std::error_code error; - map(path, offset, length, error); - if (error) { throw std::system_error(error); } + map(path, offset, length); } /** @@ -519,9 +545,7 @@ namespace mio { */ basic_mmap(const handle_type handle, const size_type offset = 0, const size_type length = map_entire_file) { - std::error_code error; - map(handle, offset, length, error); - if (error) { throw std::system_error(error); } + map(handle, offset, length); } #endif // __cpp_exceptions @@ -581,20 +605,18 @@ namespace mio { * Returns a pointer to the first requested byte, or `nullptr` if no memory mapping * exists. */ - template< - access_mode A = AccessMode, - typename = typename std::enable_if::type - > pointer data() noexcept { return data_; } + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + pointer data() noexcept { return data_; } const_pointer data() const noexcept { return data_; } /** * Returns an iterator to the first requested byte, if a valid memory mapping * exists, otherwise this function call is undefined behaviour. */ - template< - access_mode A = AccessMode, - typename = typename std::enable_if::type - > iterator begin() noexcept { return data(); } + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + iterator begin() noexcept { return data(); } const_iterator begin() const noexcept { return data(); } const_iterator cbegin() const noexcept { return data(); } @@ -602,10 +624,9 @@ namespace mio { * Returns an iterator one past the last requested byte, if a valid memory mapping * exists, otherwise this function call is undefined behaviour. */ - template< - access_mode A = AccessMode, - typename = typename std::enable_if::type - > iterator end() noexcept { return data() + length(); } + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + iterator end() noexcept { return data() + length(); } const_iterator end() const noexcept { return data() + length(); } const_iterator cend() const noexcept { return data() + length(); } @@ -614,10 +635,9 @@ namespace mio { * memory mapping exists, otherwise this function call is undefined * behaviour. */ - template< - access_mode A = AccessMode, - typename = typename std::enable_if::type - > reverse_iterator rbegin() noexcept { return reverse_iterator(end()); } + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + reverse_iterator rbegin() noexcept { return reverse_iterator(end()); } const_reverse_iterator rbegin() const noexcept { return const_reverse_iterator(end()); @@ -631,10 +651,9 @@ namespace mio { * Returns a reverse iterator past the first mapped byte, if a valid memory * mapping exists, otherwise this function call is undefined behaviour. */ - template< - access_mode A = AccessMode, - typename = typename std::enable_if::type - > reverse_iterator rend() noexcept { return reverse_iterator(begin()); } + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + reverse_iterator rend() noexcept { return reverse_iterator(begin()); } const_reverse_iterator rend() const noexcept { return const_reverse_iterator(begin()); @@ -644,6 +663,43 @@ namespace mio { return const_reverse_iterator(begin()); } + /** + * Establishes a memory mapping with AccessMode. If the mapping is + * unsuccesful, the reason is reported via `error` and the object remains in + * a state as if this function hadn't been called. + * + * `handle`, which must be a valid file handle, which is used to memory map the + * requested region. Upon failure, `error` is set to indicate the reason and the + * object remains in an unmapped state. + * + * `offset` is the number of bytes, relative to the start of the file, where the + * mapping should begin. When specifying it, there is no need to worry about + * providing a value that is aligned with the operating system's page allocation + * granularity. This is adjusted by the implementation such that the first requested + * byte (as returned by `data` or `begin`), so long as `offset` is valid, will be at + * `offset` from the start of the file. + * + * `length` is the number of bytes to map. It may be `map_entire_file`, in which + * case a mapping of the entire file is created. + */ + void map(const handle_type handle, const size_type offset, const size_type length); + + /** + * Establishes a memory mapping with AccessMode. If the mapping is + * unsuccesful, the reason is reported via `error` and the object remains in + * a state as if this function hadn't been called. + * + * `handle`, which must be a valid file handle, which is used to memory map the + * requested region. Upon failure, `error` is set to indicate the reason and the + * object remains in an unmapped state. + * + * The entire file is mapped. + */ + void map(const handle_type handle) + { + map(handle, 0, map_entire_file); + } + /** * Returns a reference to the `i`th byte from the first requested byte (as returned * by `data`). If this is invoked when no valid memory mapping has been created @@ -652,9 +708,9 @@ namespace mio { reference operator[](const size_type i) noexcept { return data_[i]; } const_reference operator[](const size_type i) const noexcept { return data_[i]; } - void map_sp(const char* path, const size_type offset, const size_type length, std::error_code& error); + void map_sp(const char* path, const size_type offset, const size_type length); #ifdef _WIN32 - void map_wsp(const wchar_t* path, const size_type offset, const size_type length, std::error_code& error); + void map_wsp(const wchar_t* path, const size_type offset, const size_type length); #endif /** @@ -678,7 +734,7 @@ namespace mio { * case a mapping of the entire file is created. */ template - void map(const String & path, const size_type offset, const size_type length, std::error_code & error); + void map(const String& path, const size_type offset, const size_type length); /** * Establishes a memory mapping with AccessMode. If the mapping is unsuccesful, the @@ -693,47 +749,9 @@ namespace mio { * The entire file is mapped. */ template - void map(const StringPath & path, std::error_code & error) + void map(const StringPath& path) { - map(path, 0, map_entire_file, error); - } - - /** - * Establishes a memory mapping with AccessMode. If the mapping is - * unsuccesful, the reason is reported via `error` and the object remains in - * a state as if this function hadn't been called. - * - * `handle`, which must be a valid file handle, which is used to memory map the - * requested region. Upon failure, `error` is set to indicate the reason and the - * object remains in an unmapped state. - * - * `offset` is the number of bytes, relative to the start of the file, where the - * mapping should begin. When specifying it, there is no need to worry about - * providing a value that is aligned with the operating system's page allocation - * granularity. This is adjusted by the implementation such that the first requested - * byte (as returned by `data` or `begin`), so long as `offset` is valid, will be at - * `offset` from the start of the file. - * - * `length` is the number of bytes to map. It may be `map_entire_file`, in which - * case a mapping of the entire file is created. - */ - void map(const handle_type handle, const size_type offset, - const size_type length, std::error_code& error); - - /** - * Establishes a memory mapping with AccessMode. If the mapping is - * unsuccesful, the reason is reported via `error` and the object remains in - * a state as if this function hadn't been called. - * - * `handle`, which must be a valid file handle, which is used to memory map the - * requested region. Upon failure, `error` is set to indicate the reason and the - * object remains in an unmapped state. - * - * The entire file is mapped. - */ - void map(const handle_type handle, std::error_code& error) - { - map(handle, 0, map_entire_file, error); + map(path, 0, map_entire_file); } /** @@ -750,9 +768,9 @@ namespace mio { void swap(basic_mmap& other); /** Flushes the memory mapped page to disk. Errors are reported via `error`. */ - template - typename std::enable_if::type - sync(std::error_code& error); + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + void sync(); /** * All operators compare the address of the first byte and size of the two mapped @@ -760,10 +778,9 @@ namespace mio { */ private: - template< - access_mode A = AccessMode, - typename = typename std::enable_if::type - > pointer get_mapping_start() noexcept + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + pointer get_mapping_start() noexcept { return !data() ? nullptr : data() - mapping_offset(); } @@ -778,11 +795,12 @@ namespace mio { * if it's `read`, but since the destructor cannot be templated, we need to * do SFINAE in a dedicated function, where one syncs and the other is a noop. */ - template - typename std::enable_if::type - conditional_sync(); - template - typename std::enable_if::type conditional_sync(); + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + void conditional_sync(); + template + requires (detail::FileReadAccess) + void conditional_sync(); }; template @@ -841,66 +859,54 @@ namespace mio { typename MMap, typename MappingToken > MMap make_mmap(const MappingToken& token, - int64_t offset, int64_t length, std::error_code& error) + int64_t offset, int64_t length) { MMap mmap; - mmap.map(token, offset, length, error); + mmap.map(token, offset, length); return mmap; } // Generic template for mmap_source for various MappingToken types template - mmap_source make_mmap_source(const MappingToken& token, - mmap_source::size_type offset, - mmap_source::size_type length, - std::error_code& error) + mmap_source make_mmap_source(const MappingToken& token, mmap_source::size_type offset, mmap_source::size_type length) { - return make_mmap(token, offset, length, error); + return make_mmap(token, offset, length); } // Overload specialized for std::filesystem::path - inline mmap_source make_mmap_source(const std::filesystem::path& path, - mmap_source::size_type offset, - mmap_source::size_type length, - std::error_code& error) + inline mmap_source make_mmap_source(const std::filesystem::path& path, mmap_source::size_type offset, mmap_source::size_type length) { // Convert filesystem path to std::string and call the generic make_mmap function. - return make_mmap(path, offset, length, error); + return make_mmap(path, offset, length); } // Overload for mmap_source that omits offset and length parameters (defaults to 0 and map_entire_file). template - mmap_source make_mmap_source(const MappingToken& token, std::error_code& error) + mmap_source make_mmap_source(const MappingToken& token) { - return make_mmap_source(token, 0, map_entire_file, error); + return make_mmap_source(token, 0, map_entire_file); } // Generic template for mmap_sink for various MappingToken types template - mmap_sink make_mmap_sink(const MappingToken& token, - mmap_sink::size_type offset, - mmap_sink::size_type length, - std::error_code& error) + mmap_sink make_mmap_sink(const MappingToken& token, mmap_sink::size_type offset, mmap_sink::size_type length) { - return make_mmap(token, offset, length, error); + return make_mmap(token, offset, length); } // Overload specialized for std::filesystem::path for mmap_sink - inline mmap_sink make_mmap_sink(const std::filesystem::path& path, - mmap_sink::size_type offset, - mmap_sink::size_type length, - std::error_code& error) + inline mmap_sink make_mmap_sink(const std::filesystem::path& path, mmap_sink::size_type offset, mmap_sink::size_type length) { - return make_mmap(path.string(), offset, length, error); + return make_mmap(path.string(), offset, length); } // Overload for mmap_sink that omits offset and length parameters (defaults to 0 and map_entire_file). template - mmap_sink make_mmap_sink(const MappingToken& token, std::error_code& error) + mmap_sink make_mmap_sink(const MappingToken& token) { - return make_mmap_sink(token, 0, map_entire_file, error); + return make_mmap_sink(token, 0, map_entire_file); } } // namespace mio @@ -930,7 +936,7 @@ namespace mio struct mio_open_file_helper { - #ifdef _WIN32 +#ifdef _WIN32 /** * Windows-specific helper function to open a file given a wide-character (wstring) path. * @param path The file path as a wide-character string. @@ -939,13 +945,17 @@ namespace mio */ static file_handle_type open_file_helper_wstring(const std::wstring& path, const access_mode mode) { + //File read or read/write mode. DWORD desired_access = (mode == access_mode::read) ? GENERIC_READ : (GENERIC_READ | GENERIC_WRITE); + //Private files do not have any attributes. DWORD flags_and_attributes = (mode == access_mode::private_page) ? FILE_ATTRIBUTE_NORMAL : (mode == access_mode::read ? FILE_ATTRIBUTE_READONLY : FILE_ATTRIBUTE_TEMPORARY); + //Is the file inaccessible to other processes? + DWORD file_share_mode = (mode == access_mode::private_page) ? 0 : (FILE_SHARE_READ | FILE_SHARE_WRITE); return ::CreateFileW ( path.c_str(), desired_access, - FILE_SHARE_READ | FILE_SHARE_WRITE, //ShareMode + file_share_mode, //ShareMode nullptr, //SecurityAttributes OPEN_EXISTING, //CreationDisposition flags_and_attributes, //FlagsAndAttributes @@ -975,7 +985,7 @@ namespace mio { return open_file_helper_wstring(path.wstring(), mode); } - #endif // _WIN32 +#endif // _WIN32 /** * Internal helper function to check if a given path is empty. @@ -1005,7 +1015,7 @@ namespace mio file_handle_type handle = invalid_handle; //For windows, we need to use CreateFileW to open a file with a wide-character path. - #ifdef _WIN32 +#ifdef _WIN32 if constexpr (std::same_as) handle = open_file_helper(path, mode); else if constexpr (std::same_as) @@ -1015,42 +1025,18 @@ namespace mio else // Attempt to convert other types to std::string handle = open_file_helper(std::string(path), mode); - #else - //For macos and linux with POSIX stdandard, we can use the open() function to open a file with a narrow-character path. +#else + //For macos and linux with POSIX stdandard, we can use the open() function to open a file with a narrow-character path. int flags = mode == access_mode::read ? O_RDONLY : O_RDWR; - #ifdef _LARGEFILE64_SOURCE - flags |= O_LARGEFILE; - #endif +#ifdef _LARGEFILE64_SOURCE + flags |= O_LARGEFILE; +#endif if constexpr (std::same_as) handle = ::open(path.c_str(), flags, S_IRWXU); else handle = ::open(c_str(path), flags, S_IRWXU); - #endif - return handle; - } - - /** - * Public interface to open a file with various path types. - * It returns a file handle and also sets an error code if any issues arise. - * @param path The file path to open (can be string, wstring, or filesystem::path). - * @param mode The access mode (read or write). - * @param error The error code to capture any errors. - * @return A file handle if successful, invalid_handle if an error occurs. - */ - template - static file_handle_type open_file(const Path& path, const access_mode mode, std::error_code& error) - { - error.clear(); - if (is_empty(path)) { - error = std::make_error_code(std::errc::invalid_argument); - return invalid_handle; - } - file_handle_type handle = open_file_implement(path, mode); - - if (handle == invalid_handle) - error = last_error(); - +#endif return handle; } @@ -1060,8 +1046,13 @@ namespace mio */ struct file_literal { - enum class literal_type { narrow, wide } type; - union { + enum class literal_type + { + narrow, wide + } type; + + union + { const char* narrow; const wchar_t* wide; }; @@ -1073,7 +1064,8 @@ namespace mio * Converts the file literal to a std::string (narrow string) representation. * @return The converted narrow string. */ - std::string to_string() const { + std::string to_string() const + { if (type == literal_type::narrow) return std::string(narrow); else @@ -1084,7 +1076,8 @@ namespace mio * Converts the file literal to a std::wstring (wide string) representation. * @return The converted wide string. */ - std::wstring to_wstring() const { + std::wstring to_wstring() const + { if (type == literal_type::wide) return std::wstring(wide); else @@ -1092,39 +1085,59 @@ namespace mio } }; + /** + * Public interface to open a file with various path types. + * It returns a file handle and also sets an error code if any issues arise. + * @param path The file path to open (can be string, wstring, or filesystem::path). + * @param mode The access mode (read or write). + * @return A file handle if successful, invalid_handle if an error occurs. + */ + template + static file_handle_type open_file(const Path& path, const access_mode mode) + { + if (is_empty(path)) + { + std::error_code error = std::make_error_code(std::errc::invalid_argument); + std::string error_message = "String literal path is empty! " + error.message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); + } + + file_handle_type handle = open_file_implement(path, mode); + + return handle; + } + /** * Overloaded function to open a file using file literal types (either narrow or wide strings). * This helps open files using string literals directly. * @param literal The file literal (either narrow or wide string). * @param mode The access mode (read or write). - * @param error The error code to capture any errors. * @return A file handle if successful, invalid_handle if an error occurs. */ - static file_handle_type open_file(const file_literal& literal, const access_mode mode, std::error_code& error) + static file_handle_type open_file(const file_literal& literal, const access_mode mode) { - error.clear(); bool empty_literal = false; if (literal.type == file_literal::literal_type::narrow) empty_literal = (literal.narrow == nullptr || literal.narrow[0] == '\0'); else empty_literal = (literal.wide == nullptr || literal.wide[0] == L'\0'); - if (empty_literal) { - error = std::make_error_code(std::errc::invalid_argument); - return invalid_handle; + if (empty_literal) + { + std::error_code error = std::make_error_code(std::errc::invalid_argument); + std::string error_message = "String literal path is empty! " + error.message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); } - #ifdef _WIN32 +#ifdef _WIN32 file_handle_type handle = (literal.type == file_literal::literal_type::narrow) ? open_file_helper(literal.to_string(), mode) : open_file_helper_wstring(literal.to_wstring(), mode); - #else +#else // On POSIX platforms, treat all literals as narrow strings std::string pathStr = literal.to_string(); file_handle_type handle = ::open(pathStr.c_str(), mode == access_mode::read ? O_RDONLY : O_RDWR); - #endif - if (handle == invalid_handle) - error = last_error(); +#endif return handle; } @@ -1135,9 +1148,9 @@ namespace mio * @param error The error code to capture any errors. * @return A file handle if successful, invalid_handle if an error occurs. */ - static file_handle_type open_file(const char* path, const access_mode mode, std::error_code& error) + static file_handle_type open_file(const char* path, const access_mode mode) { - return open_file(file_literal(path), mode, error); + return open_file(file_literal(path), mode); } /** @@ -1147,9 +1160,9 @@ namespace mio * @param error The error code to capture any errors. * @return A file handle if successful, invalid_handle if an error occurs. */ - static file_handle_type open_file(const wchar_t* path, const access_mode mode, std::error_code& error) + static file_handle_type open_file(const wchar_t* path, const access_mode mode) { - return open_file(file_literal(path), mode, error); + return open_file(file_literal(path), mode); } }; @@ -1162,26 +1175,23 @@ namespace mio * @param error The error code to capture any errors that occur during the operation. * @return The size of the file in bytes, or 0 if an error occurs. */ - inline size_t query_file_size(file_handle_type handle, std::error_code& error) + inline size_t query_file_size(file_handle_type handle) { - error.clear(); - #ifdef _WIN32 +#ifdef _WIN32 LARGE_INTEGER file_size; if (::GetFileSizeEx(handle, &file_size) == 0) { - error = detail::last_error(); return 0; } return static_cast(file_size.QuadPart); - #else // POSIX +#else // POSIX struct stat sbuf; if (::fstat(handle, &sbuf) == -1) { - error = detail::last_error(); return 0; } return sbuf.st_size; - #endif +#endif } /** @@ -1193,9 +1203,9 @@ namespace mio char* data; ///< Pointer to the start of the mapped memory int64_t length; ///< The length of the memory-mapped region int64_t mapped_length; ///< The actual length of the memory-mapped region - #ifdef _WIN32 +#ifdef _WIN32 file_handle_type file_mapping_handle; ///< Handle to the file mapping object on Windows - #endif +#endif }; /** @@ -1209,14 +1219,14 @@ namespace mio * @return An `mmap_context` struct containing information about the memory-mapped region, or an empty context if an error occurs. */ inline mmap_context memory_map(const file_handle_type file_handle, const int64_t offset, - const int64_t length, const access_mode mode, std::error_code& error) + const int64_t length, const access_mode mode) { // Align the offset to the page boundary const int64_t aligned_offset = make_offset_page_aligned(offset); // Calculate the length of the region to map const int64_t length_to_map = offset - aligned_offset + length; - - #ifdef _WIN32 + +#ifdef _WIN32 DWORD protect = (mode == access_mode::private_page) ? PAGE_WRITECOPY : (mode == access_mode::read ? PAGE_READONLY : PAGE_READWRITE); const int64_t max_file_size = offset + length; // Create a file mapping object on Windows @@ -1232,7 +1242,8 @@ namespace mio if (file_mapping_handle == invalid_handle) { - error = detail::last_error(); + std::string error_message = "CreateFileMapping failed: " + detail::last_error().message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); return {}; } @@ -1242,12 +1253,12 @@ namespace mio ( ::MapViewOfFileEx ( - file_mapping_handle, //FileMappingObject - desired_access, //DesiredAccess - static_cast(aligned_offset >> 32), //FileOffsetHigh - static_cast(aligned_offset & 0xffffffff), //FileOffsetLow - static_cast(length_to_map) != static_cast(-1) ? length_to_map : 0, //NumberOfBytesToMap - reinterpret_cast(0) //BaseAddress + file_mapping_handle, //FileMappingObject + desired_access, //DesiredAccess + static_cast(aligned_offset >> 32), //FileOffsetHigh + static_cast(aligned_offset & 0xffffffff), //FileOffsetLow + static_cast(length_to_map) != static_cast(-1) ? length_to_map : 0, //NumberOfBytesToMap + reinterpret_cast(0) //BaseAddress ) ); @@ -1267,21 +1278,24 @@ namespace mio { // Close file handle if mapping failed ::CloseHandle(file_mapping_handle); - error = detail::last_error(); + + std::string error_message = "MapViewOfFile failed: " + detail::last_error().message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); + return {}; } - #else // POSIX +#else // POSIX // Create a memory mapping on POSIX char* mapping_start = static_cast ( ::mmap ( - const_cast(0), // No hint on where to map - length_to_map, - mode == access_mode::read ? PROT_READ : (PROT_READ | PROT_WRITE), - mode == access_mode::private_page ? MAP_PRIVATE : MAP_SHARED, - file_handle, - aligned_offset + const_cast(0), // No hint on where to map + length_to_map, + mode == access_mode::read ? PROT_READ : (PROT_READ | PROT_WRITE), + mode == access_mode::private_page ? MAP_PRIVATE : MAP_SHARED, + file_handle, + aligned_offset ) ); if (mapping_start == MAP_FAILED) @@ -1289,16 +1303,16 @@ namespace mio error = detail::last_error(); return {}; } - #endif +#endif // Return a context containing the memory-mapped region details mmap_context ctx; - ctx.data = mapping_start + offset - aligned_offset; // Adjust the pointer to the original offset + ctx.data = mapping_start + (offset - aligned_offset); // Adjust the pointer to the original offset ctx.length = length; ctx.mapped_length = length_to_map; - #ifdef _WIN32 +#ifdef _WIN32 ctx.file_mapping_handle = file_mapping_handle; // Store file mapping handle on Windows - #endif +#endif return ctx; } @@ -1307,24 +1321,24 @@ namespace mio if (data_pointer != nullptr) { - #ifdef _WIN32 +#ifdef _WIN32 if (::FlushViewOfFile(mapping_pointer, mapped_length) == 0 || ::FlushFileBuffers(file_handle) == 0) - #else // POSIX +#else // POSIX if (::msync(mapping_pointer, mapped_length, MS_SYNC) != 0) - #endif +#endif { - std::string error_message = "FlushViewOfFile or Sync failed: " + detail::last_error().message(); + std::string error_message = "FlushViewOfFile or mync failed: " + detail::last_error().message(); my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); } } - #ifdef _WIN32 +#ifdef _WIN32 if (::FlushFileBuffers(file_handle) == 0) { std::string error_message = "FlushFileBuffers failed: " + detail::last_error().message(); my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); } - #endif +#endif } } } @@ -1403,22 +1417,25 @@ namespace mio { template void basic_mmap::map_sp(const char* path, const size_type offset, - const size_type length, std::error_code& error) + const size_type length) { - error.clear(); if (path == nullptr || path[0] == '\0') { - error = std::make_error_code(std::errc::invalid_argument); - return; - } - const auto handle = mio::detail::mio_open_file_helper::open_file(path, AccessMode, error); - if (error) - { + std::error_code error = std::make_error_code(std::errc::invalid_argument); + std::string error_message = "Path is empty! " + error.message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); return; } - map(handle, offset, length, error); - if (!error) + const auto handle = mio::detail::mio_open_file_helper::open_file(path, AccessMode); + if (handle == invalid_handle) + { + std::string error_message = "Open file failed, file handle is invalid! " + detail::last_error().message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); + } + + map(handle, offset, length); + if (file_handle_ != invalid_handle) { is_handle_internal_ = true; } @@ -1426,23 +1443,24 @@ namespace mio { #ifdef _WIN32 template - void basic_mmap::map_wsp(const wchar_t* path, const size_type offset, - const size_type length, std::error_code& error) + void basic_mmap::map_wsp(const wchar_t* path, const size_type offset, const size_type length) { - error.clear(); if (path == nullptr || path[0] == L'\0') { - error = std::make_error_code(std::errc::invalid_argument); - return; - } - const auto handle = mio::detail::mio_open_file_helper::open_file(path, AccessMode, error); - if (error) - { - return; + std::error_code error = std::make_error_code(std::errc::invalid_argument); + std::string error_message = "Path is empty! " + error.message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); } - map(handle, offset, length, error); - if (!error) + const auto handle = mio::detail::mio_open_file_helper::open_file(path, AccessMode); + if (handle == invalid_handle) + { + std::string error_message = "Open file failed, file handle is invalid! " + detail::last_error().message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); + } + + map(handle, offset, length); + if (file_handle_ != invalid_handle) { is_handle_internal_ = true; } @@ -1462,25 +1480,23 @@ namespace mio { * @param offset The offset within the file where the mapping should begin. * @param length The length of the region to map. If set to a special value (e.g., map_entire_file), * the mapping will extend to the end of the file. - * @param error A reference to a std::error_code object that will be set if any error occurs. */ template template void basic_mmap::map(const String& path, const size_type offset, - const size_type length, std::error_code& error) + const size_type length) { - error.clear(); - // Open the file using the underlying platform-specific API. // The mio_open_file_helper::open_file() supports std::string, std::wstring, and std::filesystem::path. - const auto handle = mio::detail::mio_open_file_helper::open_file(path, AccessMode, error); - if (error) - return; + const auto handle = mio::detail::mio_open_file_helper::open_file(path, AccessMode); + if (handle == invalid_handle) + { + std::string error_message = "Open file failed, file handle is invalid! " + detail::last_error().message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); + } // Proceed to map the file into memory using the obtained file handle. - map(handle, offset, length, error); - if (error) - return; + map(handle, offset, length); // Set internal flag indicating that the file handle was not internally managed // (i.e., it was provided externally by the user through the file opening process). @@ -1513,40 +1529,50 @@ namespace mio { * @param offset The offset within the file from which to start mapping. * @param length The length of the memory region to map. If length is equal to map_entire_file, * then the mapping will extend from the offset to the end of the file. - * @param error A reference to a std::error_code object that will be set if an error occurs during - * any of the operations. */ template - void basic_mmap::map(const handle_type handle, - const size_type offset, const size_type length, std::error_code& error) + void basic_mmap::map(const handle_type handle, const size_type offset, const size_type length) { - error.clear(); if (handle == invalid_handle) { - error = std::make_error_code(std::errc::bad_file_descriptor); + std::error_code error = std::make_error_code(std::errc::bad_file_descriptor); + std::string error_message = "file handle is invalid. " + error.message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); return; } // Query the size of the file using a platform-specific implementation. - const auto file_size = detail::query_file_size(handle, error); - if (error) + const auto file_size = detail::query_file_size(handle); + if (file_size == 0) { - return; +#ifdef _WIN32 + std::string error_message = "Query file size is failed - GetFileSizeEx: " + detail::last_error().message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); +#else // POSIX + std::string error_message = "Query file size is failed - fstat: " + detail::last_error().message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); +#endif } // Validate that the requested mapping region [offset, offset+length) is within the file bounds. if (offset + length > file_size) { - error = std::make_error_code(std::errc::invalid_argument); + std::error_code error = std::make_error_code(std::errc::invalid_argument); + std::string error_message = "requested large mapping region [offset, offset+length) outside of file size bounds. " + error.message(); + my_cpp2020_assert(false, error_message.c_str(), std::source_location::current()); return; } // Create a memory mapping of the file region. // If length equals map_entire_file, the mapping extends from offset to the end of the file. - const auto ctx = detail::memory_map(handle, offset, + const auto context = detail::memory_map + ( + handle, offset, length == map_entire_file ? (file_size - offset) : length, - AccessMode, error); - if (!error) + AccessMode + ); + + if (context.data != nullptr) { // We must unmap the previous mapping that may have existed prior to this call. // Note that this must only be invoked after a new mapping has been created in @@ -1558,24 +1584,23 @@ namespace mio { // Update internal state with the new mapping details. file_handle_ = handle; is_handle_internal_ = false; - data_ = reinterpret_cast(ctx.data); - length_ = ctx.length; - mapped_length_ = ctx.mapped_length; - #ifdef _WIN32 - file_mapping_handle_ = ctx.file_mapping_handle; - #endif + data_ = reinterpret_cast(context.data); + length_ = context.length; + mapped_length_ = context.mapped_length; +#ifdef _WIN32 + file_mapping_handle_ = context.file_mapping_handle; +#endif } } template - template - typename std::enable_if::type - basic_mmap::sync(std::error_code& error) + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + void basic_mmap::sync() { - error.clear(); if (!is_open()) { - error = std::make_error_code(std::errc::bad_file_descriptor); + //Current file is not open or closed return; } @@ -1650,20 +1675,18 @@ namespace mio { } template - template - typename std::enable_if::type - basic_mmap::conditional_sync() + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + void basic_mmap::conditional_sync() { - // This is invoked from the destructor, so not much we can do about - // failures here. - std::error_code ec; - sync(ec); + // This is invoked from the destructor, so not much we can do about failures here. + sync(); } template - template - typename std::enable_if::type - basic_mmap::conditional_sync() + template + requires (detail::FileReadAccess) + void basic_mmap::conditional_sync() { // noop } @@ -1785,29 +1808,15 @@ namespace mio { } #ifdef __cpp_exceptions - /** - * The same as invoking the `map` function, except any error that may occur - * while establishing the mapping is wrapped in a `std::system_error` and is - * thrown. - */ template basic_shared_mmap(const String& path, const size_type offset = 0, const size_type length = map_entire_file) { - std::error_code error; - map(path, offset, length, error); - if (error) { throw std::system_error(error); } + map(path, offset, length); } - /** - * The same as invoking the `map` function, except any error that may occur - * while establishing the mapping is wrapped in a `std::system_error` and is - * thrown. - */ basic_shared_mmap(const handle_type handle, const size_type offset = 0, const size_type length = map_entire_file) { - std::error_code error; - map(handle, offset, length, error); - if (error) { throw std::system_error(error); } + map(handle, offset, length); } #endif // __cpp_exceptions @@ -1863,10 +1872,9 @@ namespace mio { * Returns a pointer to the first requested byte, or `nullptr` if no memory mapping * exists. */ - template< - access_mode A = AccessMode, - typename = typename std::enable_if::type - > pointer data() noexcept { return pimpl_->data(); } + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + pointer data() noexcept { return pimpl_->data(); } const_pointer data() const noexcept { return pimpl_ ? pimpl_->data() : nullptr; } /** @@ -1881,10 +1889,9 @@ namespace mio { * Returns an iterator one past the last requested byte, if a valid memory mapping * exists, otherwise this function call is undefined behaviour. */ - template< - access_mode A = AccessMode, - typename = typename std::enable_if::type - > iterator end() noexcept { return pimpl_->end(); } + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + iterator end() noexcept { return pimpl_->end(); } const_iterator end() const noexcept { return pimpl_->end(); } const_iterator cend() const noexcept { return pimpl_->cend(); } @@ -1893,10 +1900,9 @@ namespace mio { * memory mapping exists, otherwise this function call is undefined * behaviour. */ - template< - access_mode A = AccessMode, - typename = typename std::enable_if::type - > reverse_iterator rbegin() noexcept { return pimpl_->rbegin(); } + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + reverse_iterator rbegin() noexcept { return pimpl_->rbegin(); } const_reverse_iterator rbegin() const noexcept { return pimpl_->rbegin(); } const_reverse_iterator crbegin() const noexcept { return pimpl_->crbegin(); } @@ -1904,10 +1910,9 @@ namespace mio { * Returns a reverse iterator past the first mapped byte, if a valid memory * mapping exists, otherwise this function call is undefined behaviour. */ - template< - access_mode A = AccessMode, - typename = typename std::enable_if::type - > reverse_iterator rend() noexcept { return pimpl_->rend(); } + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + reverse_iterator rend() noexcept { return pimpl_->rend(); } const_reverse_iterator rend() const noexcept { return pimpl_->rend(); } const_reverse_iterator crend() const noexcept { return pimpl_->crend(); } @@ -1941,9 +1946,9 @@ namespace mio { */ template void map(const String& path, const size_type offset, - const size_type length, std::error_code& error) + const size_type length) { - map_impl(path, offset, length, error); + map_impl(path, offset, length); } /** @@ -1959,9 +1964,9 @@ namespace mio { * The entire file is mapped. */ template - void map(const String& path, std::error_code& error) + void map(const String& path) { - map_impl(path, 0, map_entire_file, error); + map_impl(path, 0, map_entire_file); } /** @@ -1984,9 +1989,9 @@ namespace mio { * case a mapping of the entire file is created. */ void map(const handle_type handle, const size_type offset, - const size_type length, std::error_code& error) + const size_type length) { - map_impl(handle, offset, length, error); + map_impl(handle, offset, length); } /** @@ -2000,9 +2005,9 @@ namespace mio { * * The entire file is mapped. */ - void map(const handle_type handle, std::error_code& error) + void map(const handle_type handle) { - map_impl(handle, 0, map_entire_file, error); + map_impl(handle, 0, map_entire_file); } /** @@ -2019,10 +2024,9 @@ namespace mio { void swap(basic_shared_mmap& other) { pimpl_.swap(other.pimpl_); } /** Flushes the memory mapped page to disk. Errors are reported via `error`. */ - template< - access_mode A = AccessMode, - typename = typename std::enable_if::type - > void sync(std::error_code& error) { if (pimpl_) pimpl_->sync(error); } + template + requires (detail::FileWriteAccess || detail::FilePrivateAccess) + void sync() { if (pimpl_) pimpl_->sync(); } /** All operators compare the underlying `basic_mmap`'s addresses. */ @@ -2059,17 +2063,16 @@ namespace mio { private: template void map_impl(const MappingToken& token, const size_type offset, - const size_type length, std::error_code& error) + const size_type length) { if (!pimpl_) { - mmap_type mmap = make_mmap(token, offset, length, error); - if (error) { return; } + mmap_type mmap = make_mmap(token, offset, length); pimpl_ = std::make_shared(std::move(mmap)); } else { - pimpl_->map(token, offset, length, error); + pimpl_->map(token, offset, length); } } }; diff --git a/test/test.cpp b/test/test.cpp index f51c364..35f5b95 100644 --- a/test/test.cpp +++ b/test/test.cpp @@ -2,22 +2,18 @@ #include #include #include -#include #include #include #include "../single_include/mio/mio.hpp" // Just make sure this compiles. -# include -using mmap_source = mio::basic_mmap_source; +#include +using mmap_source_bytes = mio::basic_mmap_source; template -void test_at_offset(const MMap& file_view, const std::string& buffer, - const size_t offset); -inline void test_at_offset(const std::string& buffer, const char* path, - const size_t offset, std::error_code& error); -inline int handle_error(const std::error_code& error); +void test_at_offset(const MMap& file_view, const std::string& buffer, const size_t offset); +inline void test_at_offset(const std::string& buffer, const char* path, const size_t offset); inline void allocate_file(const std::string& path, const int size) { @@ -26,14 +22,7 @@ inline void allocate_file(const std::string& path, const int size) file << s; } -inline int handle_error(const std::error_code& error) -{ - const auto& errmsg = error.message(); - std::printf("Error mapping file: %s, exiting...\n", errmsg.c_str()); - return error.value(); -} - -inline int test_rewrite_file() +inline void test_rewrite_file() { const auto path = "test_rewrite.txt"; @@ -45,10 +34,8 @@ inline int test_rewrite_file() // Read-write memory map the whole file by using `map_entire_file` where the // length of the mapping is otherwise expected, with the factory method. - std::error_code error; mio::mmap_sink rw_mmap = mio::make_mmap_sink( - path, 0, mio::map_entire_file, error); - if (error) { return handle_error(error); } + path, 0, mio::map_entire_file); // You can use any iterator based function. std::fill(rw_mmap.begin(), rw_mmap.end(), 'a'); @@ -67,8 +54,7 @@ inline int test_rewrite_file() // Don't forget to flush changes to disk before unmapping. However, if // `rw_mmap` were to go out of scope at this point, the destructor would also // automatically invoke `sync` before `unmap`. - rw_mmap.sync(error); - if (error) { return handle_error(error); } + rw_mmap.sync(); // We can then remove the mapping, after which rw_mmap will be in a default // constructed state, i.e. this and the above call to `sync` have the same @@ -79,16 +65,44 @@ inline int test_rewrite_file() // overload without the offset and file length parameters maps the entire // file. mio::mmap_source ro_mmap; - ro_mmap.map(path, error); - if (error) { return handle_error(error); } + ro_mmap.map(path); const int the_answer_to_everything = ro_mmap[answer_index]; assert(the_answer_to_everything == 42); } +inline void test_error_case(char* path, const std::string& buffer) +{ + +#define CHECK_INVALID_MMAP(m) do { \ + assert(m.empty()); \ + assert(!m.is_open()); \ + } while(0) + + mio::mmap_source m; + + // See if mapping an invalid file results in an error. + m = mio::make_mmap_source("garbage-that-hopefully-doesnt-exist", 0, 0); + CHECK_INVALID_MMAP(m); + + // Empty path? + m = mio::make_mmap_source(static_cast(0), 0, 0); + CHECK_INVALID_MMAP(m); + m = mio::make_mmap_source(std::string(), 0, 0); + CHECK_INVALID_MMAP(m); + + // Invalid handle? + m = mio::make_mmap_source(mio::invalid_handle, 0, 0); + CHECK_INVALID_MMAP(m); + + // Invalid offset? + m = mio::make_mmap_source(path, 100 * buffer.size(), buffer.size()); + CHECK_INVALID_MMAP(m); +} + int main() { - std::error_code error; + std::system("chcp 65001"); // Make sure mio compiles with non-const char* strings too. const char _path[] = "test-file"; @@ -117,48 +131,21 @@ int main() file.close(); // Test whole file mapping. - test_at_offset(buffer, path, 0, error); - if (error) { return handle_error(error); } + test_at_offset(buffer, path, 0); //Test starting from below the page size. - test_at_offset(buffer, path, page_size - 3, error); - if (error) { return handle_error(error); } + test_at_offset(buffer, path, page_size - 3); // Test starting from above the page size. - test_at_offset(buffer, path, page_size + 3, error); - if (error) { return handle_error(error); } + test_at_offset(buffer, path, page_size + 3); // Test starting from above the page size. - test_at_offset(buffer, path, 2 * page_size + 3, error); - if (error) { return handle_error(error); } + test_at_offset(buffer, path, 2 * page_size + 3); - { -#define CHECK_INVALID_MMAP(m) do { \ - assert(error); \ - assert(m.empty()); \ - assert(!m.is_open()); \ - error.clear(); } while(0) + std::cout << "Continuing with tests..." << std::endl; - mio::mmap_source m; - - // See if mapping an invalid file results in an error. - m = mio::make_mmap_source("garbage-that-hopefully-doesnt-exist", 0, 0, error); - CHECK_INVALID_MMAP(m); - - // Empty path? - m = mio::make_mmap_source(static_cast(0), 0, 0, error); - CHECK_INVALID_MMAP(m); - m = mio::make_mmap_source(std::string(), 0, 0, error); - CHECK_INVALID_MMAP(m); - - // Invalid handle? - m = mio::make_mmap_source(mio::invalid_handle, 0, 0, error); - CHECK_INVALID_MMAP(m); - - // Invalid offset? - m = mio::make_mmap_source(path, 100 * buffer.size(), buffer.size(), error); - CHECK_INVALID_MMAP(m); - } + //Uncomment this line code for checking test error cases. + //test_error_case(path, buffer); // Make sure these compile. { @@ -167,41 +154,70 @@ int main() // Make sure shared_mmap mapping compiles as all testing was done on // normal mmaps. mio::shared_mmap_source _3(path, 0, mio::map_entire_file); - auto _4 = mio::make_mmap_source(path, error); - auto _5 = mio::make_mmap(path, 0, mio::map_entire_file, error); + auto _4 = mio::make_mmap_source(path); + auto _5 = mio::make_mmap(path, 0, mio::map_entire_file); #ifdef _WIN32 - const wchar_t* wpath1 = L"dasfsf"; - auto _6 = mio::make_mmap_source(wpath1, error); - mio::mmap_source _7; - _7.map(wpath1, error); - const std::wstring wpath2 = wpath1; - auto _8 = mio::make_mmap_source(wpath2, error); - mio::mmap_source _9; - _9.map(wpath1, error); + const std::wstring wpath1 = L"file"; + + // If the file can be opened, perform make_mmap_source and mapping. + if (std::filesystem::exists(wpath1)) + { + auto _6 = mio::make_mmap_source(wpath1); + mio::mmap_source _7; + _7.map(wpath1); + } + else + { + std::wcerr << L"Cannot open file: " << wpath1 << std::endl; + } + + // Other operations that must execute regardless. + // Even if the file is not openable, these lines are executed. + const std::wstring wpath2 = wpath1 + L"000"; + if (std::filesystem::exists(wpath2)) + { + auto _8 = mio::make_mmap_source(wpath2); + mio::mmap_source _9; + _9.map(wpath1); + } + else + { + std::wcerr << L"Cannot open file: " << wpath2 << std::endl; + } #else + const char* path = "path_to_file"; // Replace with your actual file path const int fd = open(path, O_RDONLY); - mio::mmap_source _fdmmap(fd, 0, mio::map_entire_file); - _fdmmap.unmap(); - _fdmmap.map(fd, error); + + if (fd < 0) + { + std::cerr << "Failed to open file: " << path << std::endl; + } + else + { + // File opened successfully, proceed with mmap operations + mio::mmap_source _fdmmap(fd, 0, mio::map_entire_file); + // Unmap first if needed + _fdmmap.unmap(); + // Remap using the same file descriptor + _fdmmap.map(fd); + + // Close the file descriptor if it's no longer needed + close(fd); + } #endif } - if (test_rewrite_file()) - throw std::runtime_error("test_rewrite_file failed"); - std::printf("all tests passed!\n"); } void test_at_offset(const std::string& buffer, const char* path, - const size_t offset, std::error_code& error) + const size_t offset) { // Sanity check. assert(offset < buffer.size()); // Map the region of the file to which buffer was written. - mio::mmap_source file_view = mio::make_mmap_source( - path, offset, mio::map_entire_file, error); - if (error) { return; } + mio::mmap_source file_view = mio::make_mmap_source(path, offset, mio::map_entire_file); assert(file_view.is_open()); const size_t mapped_size = buffer.size() - offset; @@ -219,14 +235,15 @@ void test_at_offset(const std::string& buffer, const char* path, } template -void test_at_offset(const MMap& file_view, const std::string& buffer, - const size_t offset) +void test_at_offset(const MMap& file_view, const std::string& buffer, const size_t offset) { // Then verify that mmap's bytes correspond to that of buffer. for (size_t buf_idx = offset, view_idx = 0; buf_idx < buffer.size() && view_idx < file_view.size(); - ++buf_idx, ++view_idx) { - if (file_view[view_idx] != buffer[buf_idx]) { + ++buf_idx, ++view_idx) + { + if (file_view[view_idx] != buffer[buf_idx]) + { std::printf("%luth byte mismatch: expected(%d) <> actual(%d)", buf_idx, buffer[buf_idx], file_view[view_idx]); std::cout << std::flush;