Add async file I/O with concurrent random-access operations

doc/modules/ROOT/nav.adoc

@@ -34,6 +34,7 @@
 ** xref:4.guide/4l.tls.adoc[TLS Encryption]
 ** xref:4.guide/4m.error-handling.adoc[Error Handling]
 ** xref:4.guide/4n.buffers.adoc[Buffer Sequences]
+** xref:4.guide/4o.file-io.adoc[File I/O]
 * xref:5.testing/5.intro.adoc[Testing]
 ** xref:5.testing/5a.mocket.adoc[Mock Sockets]
 * xref:benchmark-report.adoc[Benchmarks]

doc/modules/ROOT/pages/4.guide/4o.file-io.adoc

@@ -0,0 +1,203 @@
+//
+// Copyright (c) 2026 Michael Vandeberg
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+// Official repository: https://github.com/cppalliance/corosio
+//
+
+= File I/O
+
+Corosio provides two classes for asynchronous file operations:
+`stream_file` for sequential access and `random_access_file` for
+offset-based access. Both dispatch I/O to a worker thread on POSIX
+platforms and use native overlapped I/O on Windows.
+
+[NOTE]
+====
+Code snippets assume:
+[source,cpp]
+----
+#include <boost/corosio/stream_file.hpp>
+#include <boost/corosio/random_access_file.hpp>
+namespace corosio = boost::corosio;
+----
+====
+
+== Stream File
+
+`stream_file` reads and writes sequentially, maintaining an internal
+position that advances after each operation. It inherits from `io_stream`,
+so it works with any algorithm that accepts an `io_stream&`.
+
+=== Reading a File
+
+[source,cpp]
+----
+corosio::stream_file f(ioc);
+f.open("data.bin", corosio::file_base::read_only);
+
+char buf[4096];
+auto [ec, n] = co_await f.read_some(
+    capy::mutable_buffer(buf, sizeof(buf)));
+
+if (ec == capy::cond::eof)
+    // reached end of file
+----
+
+=== Writing a File
+
+[source,cpp]
+----
+corosio::stream_file f(ioc);
+f.open("output.bin",
+    corosio::file_base::write_only
+    | corosio::file_base::create
+    | corosio::file_base::truncate);
+
+std::string data = "hello world";
+auto [ec, n] = co_await f.write_some(
+    capy::const_buffer(data.data(), data.size()));
+----
+
+=== Seeking
+
+The file position can be moved with `seek()`:
+
+[source,cpp]
+----
+f.seek(0, corosio::file_base::seek_set);    // beginning
+f.seek(100, corosio::file_base::seek_cur);  // forward 100 bytes
+f.seek(-10, corosio::file_base::seek_end);  // 10 bytes before end
+----
+
+== Random Access File
+
+`random_access_file` reads and writes at explicit byte offsets
+without maintaining an internal position. This is useful for
+databases, indices, or any workload that accesses non-sequential
+regions of a file.
+
+=== Reading at an Offset
+
+[source,cpp]
+----
+corosio::random_access_file f(ioc);
+f.open("data.bin", corosio::file_base::read_only);
+
+char buf[256];
+auto [ec, n] = co_await f.read_some_at(
+    1024,  // byte offset
+    capy::mutable_buffer(buf, sizeof(buf)));
+----
+
+=== Writing at an Offset
+
+[source,cpp]
+----
+corosio::random_access_file f(ioc);
+f.open("data.bin", corosio::file_base::read_write);
+
+auto [ec, n] = co_await f.write_some_at(
+    512, capy::const_buffer("patched", 7));
+----
+
+== Open Flags
+
+Both file types accept a bitmask of `file_base::flags` when opening:
+
+[cols="1,3"]
+|===
+| Flag | Meaning
+
+| `read_only` | Open for reading (default)
+| `write_only` | Open for writing
+| `read_write` | Open for both reading and writing
+| `create` | Create the file if it does not exist
+| `exclusive` | Fail if the file already exists (requires `create`)
+| `truncate` | Truncate the file to zero length on open
+| `append` | Seek to end on open (stream_file only)
+| `sync_all_on_write` | Synchronize data to disk on each write
+|===
+
+Flags are combined with `|`:
+
+[source,cpp]
+----
+f.open("log.txt",
+    corosio::file_base::write_only
+    | corosio::file_base::create
+    | corosio::file_base::append);
+----
+
+== File Metadata
+
+Both file types provide synchronous metadata operations:
+
+[source,cpp]
+----
+auto bytes = f.size();       // file size in bytes
+f.resize(1024);              // truncate or extend
+f.sync_data();               // flush data to stable storage
+f.sync_all();                // flush data and metadata
+----
+
+`stream_file` additionally provides `seek()` for repositioning.
+
+== Native Handle Access
+
+Both file types support adopting and releasing native handles:
+
+[source,cpp]
+----
+// Release ownership — caller must close the handle
+auto handle = f.release();
+assert(!f.is_open());
+
+// Adopt an existing handle — file takes ownership
+corosio::random_access_file f2(ioc);
+f2.assign(handle);
+----
+
+== Error Handling
+
+File operations follow the same error model as sockets. Reads past
+end-of-file return `capy::cond::eof`:
+
+[source,cpp]
+----
+auto [ec, n] = co_await f.read_some(buf);
+if (ec == capy::cond::eof)
+{
+    // no more data
+}
+else if (ec)
+{
+    // I/O error
+}
+----
+
+Opening a nonexistent file with `read_only` throws `std::system_error`.
+Use `create` to create files that may not exist.
+
+== Thread Safety
+
+* Distinct objects are safe to use concurrently.
+* `random_access_file` supports multiple concurrent reads and writes
+  from coroutines sharing the same file object. Each operation is
+  independently heap-allocated.
+* `stream_file` allows at most one asynchronous operation in flight at
+  a time (same as Asio's stream_file). Sequential access with an
+  implicit position makes concurrent ops semantically undefined.
+* Non-async operations (open, close, size, resize, etc.) require
+  external synchronization.
+
+== Platform Notes
+
+On Linux, macOS, and BSD, file I/O is dispatched to a shared worker
+thread pool using `preadv`/`pwritev`. This is the same pool used by
+the resolver.
+
+On Windows, file I/O uses native IOCP overlapped I/O via
+`ReadFile`/`WriteFile` with `FILE_FLAG_OVERLAPPED`.

include/boost/corosio.hpp

@@ -13,13 +13,16 @@
 #include <boost/corosio/backend.hpp>
 #include <boost/corosio/cancel.hpp>
 #include <boost/corosio/endpoint.hpp>
+#include <boost/corosio/file_base.hpp>
 #include <boost/corosio/io_context.hpp>
 #include <boost/corosio/ipv4_address.hpp>
 #include <boost/corosio/ipv6_address.hpp>
+#include <boost/corosio/random_access_file.hpp>
 #include <boost/corosio/resolver.hpp>
 #include <boost/corosio/resolver_results.hpp>
 #include <boost/corosio/signal_set.hpp>
 #include <boost/corosio/socket_option.hpp>
+#include <boost/corosio/stream_file.hpp>
 #include <boost/corosio/tcp_acceptor.hpp>
 #include <boost/corosio/tcp_server.hpp>
 #include <boost/corosio/tcp_socket.hpp>

include/boost/corosio/backend.hpp

@@ -176,6 +176,11 @@ class win_signals;
 class win_resolver;
 class win_resolver_service;
 
+class win_stream_file;
+class win_file_service;
+class win_random_access_file;
+class win_random_access_file_service;
+
 } // namespace detail
 
 /// Backend tag for the Windows I/O Completion Ports multiplexer.

include/boost/corosio/detail/file_service.hpp

@@ -0,0 +1,60 @@
+//
+// Copyright (c) 2026 Michael Vandeberg
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+// Official repository: https://github.com/cppalliance/corosio
+//
+
+#ifndef BOOST_COROSIO_DETAIL_FILE_SERVICE_HPP
+#define BOOST_COROSIO_DETAIL_FILE_SERVICE_HPP
+
+#include <boost/corosio/detail/config.hpp>
+#include <boost/corosio/stream_file.hpp>
+#include <boost/capy/ex/execution_context.hpp>
+
+#include <filesystem>
+#include <system_error>
+
+namespace boost::corosio::detail {
+
+/** Abstract stream file service base class.
+
+    Concrete implementations (posix, IOCP) inherit from
+    this class and provide platform-specific file operations.
+    The context constructor installs whichever backend via
+    `make_service`, and `stream_file.cpp` retrieves it via
+    `use_service<file_service>()`.
+*/
+class BOOST_COROSIO_DECL file_service
+    : public capy::execution_context::service
+    , public io_object::io_service
+{
+public:
+    /// Identifies this service for `execution_context` lookup.
+    using key_type = file_service;
+
+    /** Open a file.
+
+        Opens the file at the given path with the specified flags
+        and associates it with the platform I/O mechanism.
+
+        @param impl The file implementation to initialize.
+        @param path The filesystem path to open.
+        @param mode Bitmask of file_base::flags.
+        @return Error code on failure, empty on success.
+    */
+    virtual std::error_code open_file(
+        stream_file::implementation& impl,
+        std::filesystem::path const& path,
+        file_base::flags mode) = 0;
+
+protected:
+    file_service() = default;
+    ~file_service() override = default;
+};
+
+} // namespace boost::corosio::detail
+
+#endif // BOOST_COROSIO_DETAIL_FILE_SERVICE_HPP

include/boost/corosio/detail/intrusive.hpp

@@ -65,10 +65,11 @@ class intrusive_list
 
     void push_back(T* w) noexcept
     {
-        w->next_ = nullptr;
-        w->prev_ = tail_;
+        auto* n = static_cast<node*>(w);
+        n->next_ = nullptr;
+        n->prev_ = tail_;
         if (tail_)
-            tail_->next_ = w;
+            static_cast<node*>(tail_)->next_ = w;
         else
             head_ = w;
         tail_ = w;
@@ -80,9 +81,9 @@ class intrusive_list
             return;
         if (tail_)
         {
-            tail_->next_       = other.head_;
-            other.head_->prev_ = tail_;
-            tail_              = other.tail_;
+            static_cast<node*>(tail_)->next_        = other.head_;
+            static_cast<node*>(other.head_)->prev_  = tail_;
+            tail_                                   = other.tail_;
         }
         else
         {
@@ -98,28 +99,43 @@ class intrusive_list
         if (!head_)
             return nullptr;
         T* w  = head_;
-        head_ = head_->next_;
+        head_ = static_cast<node*>(head_)->next_;
         if (head_)
-            head_->prev_ = nullptr;
+            static_cast<node*>(head_)->prev_ = nullptr;
         else
             tail_ = nullptr;
         // Defensive: clear stale linkage so remove() on a
         // popped node cannot corrupt the list.
-        w->next_ = nullptr;
-        w->prev_ = nullptr;
+        auto* n = static_cast<node*>(w);
+        n->next_ = nullptr;
+        n->prev_ = nullptr;
         return w;
     }
 
     void remove(T* w) noexcept
     {
-        if (w->prev_)
-            w->prev_->next_ = w->next_;
+        auto* n = static_cast<node*>(w);
+        // Already detached — nothing to do.
+        if (!n->next_ && !n->prev_ && head_ != w && tail_ != w)
+            return;
+        if (n->prev_)
+            static_cast<node*>(n->prev_)->next_ = n->next_;
         else
-            head_ = w->next_;
-        if (w->next_)
-            w->next_->prev_ = w->prev_;
+            head_ = n->next_;
+        if (n->next_)
+            static_cast<node*>(n->next_)->prev_ = n->prev_;
         else
-            tail_ = w->prev_;
+            tail_ = n->prev_;
+        n->next_ = nullptr;
+        n->prev_ = nullptr;
+    }
+
+    /// Invoke @p f for each element in the list.
+    template<class F>
+    void for_each(F f)
+    {
+        for (T* p = head_; p; p = static_cast<node*>(p)->next_)
+            f(p);
     }
 };