. /include/boost/corosio /native /detail /native_socket_base.hpp
100.00% Lines (34/34) 100.00% Functions (9/9)
[ ] prev/next file n p prev/next uncovered line
TLA Baseline Branch
Line Hits Code Line Hits Code
1   // 1   //
2   // Copyright (c) 2026 Michael Vandeberg 2   // Copyright (c) 2026 Michael Vandeberg
3   // 3   //
4   // Distributed under the Boost Software License, Version 1.0. (See accompanying 4   // Distributed under the Boost Software License, Version 1.0. (See accompanying
5   // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 5   // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6   // 6   //
7   // Official repository: https://github.com/cppalliance/corosio 7   // Official repository: https://github.com/cppalliance/corosio
8   // 8   //
9   9  
10   #ifndef BOOST_COROSIO_NATIVE_DETAIL_NATIVE_SOCKET_BASE_HPP 10   #ifndef BOOST_COROSIO_NATIVE_DETAIL_NATIVE_SOCKET_BASE_HPP
11   #define BOOST_COROSIO_NATIVE_DETAIL_NATIVE_SOCKET_BASE_HPP 11   #define BOOST_COROSIO_NATIVE_DETAIL_NATIVE_SOCKET_BASE_HPP
12   12  
13   #include <boost/corosio/detail/native_handle.hpp> 13   #include <boost/corosio/detail/native_handle.hpp>
14   #include <boost/corosio/endpoint.hpp> 14   #include <boost/corosio/endpoint.hpp>
15   #include <boost/corosio/native/detail/endpoint_convert.hpp> 15   #include <boost/corosio/native/detail/endpoint_convert.hpp>
16   #include <boost/corosio/native/detail/make_err.hpp> 16   #include <boost/corosio/native/detail/make_err.hpp>
17   17  
18   #include <memory> 18   #include <memory>
19   #include <system_error> 19   #include <system_error>
20   20  
21   #include <errno.h> 21   #include <errno.h>
22   #include <sys/socket.h> 22   #include <sys/socket.h>
23   23  
24   /* 24   /*
25   Readiness/completion-agnostic socket base for the POSIX-fd backends. 25   Readiness/completion-agnostic socket base for the POSIX-fd backends.
26   26  
27   Holds the part of a socket impl that does not care whether the backend 27   Holds the part of a socket impl that does not care whether the backend
28   is readiness-based (epoll/kqueue/select, which park ops on a 28   is readiness-based (epoll/kqueue/select, which park ops on a
29   descriptor_state) or completion-based (io_uring, which submits SQEs): 29   descriptor_state) or completion-based (io_uring, which submits SQEs):
30   the file descriptor, the cached local endpoint, the impl lifecycle 30   the file descriptor, the cached local endpoint, the impl lifecycle
31   bases (enable_shared_from_this + the service's intrusive tracking node), 31   bases (enable_shared_from_this + the service's intrusive tracking node),
32   and the synchronous accessors (native_handle / options / bind). 32   and the synchronous accessors (native_handle / options / bind).
33   33  
34   reactor_basic_socket derives from this and adds the readiness machinery 34   reactor_basic_socket derives from this and adds the readiness machinery
35   (descriptor_state, register_op, the cancel/close that deregister from 35   (descriptor_state, register_op, the cancel/close that deregister from
36   the reactor). io_uring's socket impls derive from it and add their op 36   the reactor). io_uring's socket impls derive from it and add their op
37   slots + SQE submission. This is the socket-layer analogue of io_uring 37   slots + SQE submission. This is the socket-layer analogue of io_uring
38   deriving from reactor_scheduler: io_uring sockets share the reactor's 38   deriving from reactor_scheduler: io_uring sockets share the reactor's
39   readiness-agnostic socket surface, while the on-EAGAIN action (park vs 39   readiness-agnostic socket surface, while the on-EAGAIN action (park vs
40   submit-SQE) and the op model stay backend-specific. 40   submit-SQE) and the op model stay backend-specific.
41   41  
42   @tparam Derived The concrete socket type (CRTP, for shared_from_this 42   @tparam Derived The concrete socket type (CRTP, for shared_from_this
43   and the intrusive node). 43   and the intrusive node).
44   @tparam ImplBase The public vtable base (tcp_socket::implementation, 44   @tparam ImplBase The public vtable base (tcp_socket::implementation,
45   udp_socket::implementation, ...). 45   udp_socket::implementation, ...).
46   @tparam Endpoint The endpoint type (endpoint or local_endpoint). 46   @tparam Endpoint The endpoint type (endpoint or local_endpoint).
47   */ 47   */
48   48  
49   namespace boost::corosio::detail { 49   namespace boost::corosio::detail {
50   50  
51   template<class Derived, class ImplBase, class Endpoint = endpoint> 51   template<class Derived, class ImplBase, class Endpoint = endpoint>
52   class native_socket_base 52   class native_socket_base
53   : public ImplBase 53   : public ImplBase
54   , public std::enable_shared_from_this<Derived> 54   , public std::enable_shared_from_this<Derived>
55   { 55   {
56   protected: 56   protected:
57   // CRTP base: not publicly constructible. The check's preferred fix 57   // CRTP base: not publicly constructible. The check's preferred fix
58   // (private ctor + `friend Derived`) is infeasible here — the reactor 58   // (private ctor + `friend Derived`) is infeasible here — the reactor
59   // sockets reach this base through intermediate templates 59   // sockets reach this base through intermediate templates
60   // (reactor_stream_socket -> reactor_basic_socket) that are not `Derived`, 60   // (reactor_stream_socket -> reactor_basic_socket) that are not `Derived`,
61   // so a private ctor would stop those intermediates from constructing it. 61   // so a private ctor would stop those intermediates from constructing it.
62   // Protected is the correct access; suppress the private-only suggestion. 62   // Protected is the correct access; suppress the private-only suggestion.
63   // NOLINTNEXTLINE(bugprone-crtp-constructor-accessibility) 63   // NOLINTNEXTLINE(bugprone-crtp-constructor-accessibility)
HITCBC 64   14634 native_socket_base() = default; 64   14678 native_socket_base() = default;
65   65  
66   int fd_ = -1; 66   int fd_ = -1;
67   // mutable so a derived const local_endpoint() override can lazily fill 67   // mutable so a derived const local_endpoint() override can lazily fill
68   // it via getsockname() on first read (io_uring's lazy_pending state). 68   // it via getsockname() on first read (io_uring's lazy_pending state).
69   mutable Endpoint local_endpoint_; 69   mutable Endpoint local_endpoint_;
70   70  
71   public: 71   public:
HITCBC 72   14634 ~native_socket_base() override = default; 72   14678 ~native_socket_base() override = default;
73   73  
74   /// Return the underlying file descriptor. 74   /// Return the underlying file descriptor.
HITCBC 75   45724 native_handle_type native_handle() const noexcept override 75   45855 native_handle_type native_handle() const noexcept override
76   { 76   {
HITCBC 77   45724 return fd_; 77   45855 return fd_;
78   } 78   }
79   79  
HITCBC 80   585 corosio::family family() const noexcept override 80   585 corosio::family family() const noexcept override
81   { 81   {
HITCBC 82   585 return to_family(socket_family(fd_)); 82   585 return to_family(socket_family(fd_));
83   } 83   }
84   84  
85   /// Return the cached local endpoint. 85   /// Return the cached local endpoint.
HITCBC 86   194 Endpoint local_endpoint() const noexcept override 86   194 Endpoint local_endpoint() const noexcept override
87   { 87   {
HITCBC 88   194 return local_endpoint_; 88   194 return local_endpoint_;
89   } 89   }
90   90  
91   /// Return true if the socket has an open file descriptor. 91   /// Return true if the socket has an open file descriptor.
92   bool is_open() const noexcept 92   bool is_open() const noexcept
93   { 93   {
94   return fd_ >= 0; 94   return fd_ >= 0;
95   } 95   }
96   96  
97   /// Set a socket option. 97   /// Set a socket option.
HITCBC 98   117 std::error_code set_option( 98   117 std::error_code set_option(
99   int level, 99   int level,
100   int optname, 100   int optname,
101   void const* data, 101   void const* data,
102   std::size_t size) noexcept override 102   std::size_t size) noexcept override
103   { 103   {
HITCBC 104   117 if (::setsockopt( 104   117 if (::setsockopt(
HITCBC 105   117 fd_, level, optname, data, static_cast<socklen_t>(size)) != 0) 105   117 fd_, level, optname, data, static_cast<socklen_t>(size)) != 0)
HITCBC 106   8 return make_err(errno); 106   8 return make_err(errno);
HITCBC 107   109 return {}; 107   109 return {};
108   } 108   }
109   109  
110   /// Get a socket option. 110   /// Get a socket option.
111   std::error_code 111   std::error_code
HITCBC 112   170 get_option(int level, int optname, void* data, std::size_t* size) 112   170 get_option(int level, int optname, void* data, std::size_t* size)
113   const noexcept override 113   const noexcept override
114   { 114   {
HITCBC 115   170 socklen_t len = static_cast<socklen_t>(*size); 115   170 socklen_t len = static_cast<socklen_t>(*size);
HITCBC 116   170 if (::getsockopt(fd_, level, optname, data, &len) != 0) 116   170 if (::getsockopt(fd_, level, optname, data, &len) != 0)
HITCBC 117   13 return make_err(errno); 117   13 return make_err(errno);
HITCBC 118   157 *size = static_cast<std::size_t>(len); 118   157 *size = static_cast<std::size_t>(len);
HITCBC 119   157 return {}; 119   157 return {};
120   } 120   }
121   121  
122   /// Assign the file descriptor. 122   /// Assign the file descriptor.
HITCBC 123   4473 void set_socket(int fd) noexcept 123   4488 void set_socket(int fd) noexcept
124   { 124   {
HITCBC 125   4473 fd_ = fd; 125   4488 fd_ = fd;
HITCBC 126   4473 } 126   4488 }
127   127  
128   /// Cache the local endpoint. 128   /// Cache the local endpoint.
129   void set_local_endpoint(Endpoint ep) noexcept 129   void set_local_endpoint(Endpoint ep) noexcept
130   { 130   {
131   local_endpoint_ = ep; 131   local_endpoint_ = ep;
132   } 132   }
133   133  
134   /** Bind the socket to a local endpoint. 134   /** Bind the socket to a local endpoint.
135   135  
136   Calls ::bind() and caches the resulting local endpoint via 136   Calls ::bind() and caches the resulting local endpoint via
137   getsockname(). Readiness-agnostic; usable by any fd backend. 137   getsockname(). Readiness-agnostic; usable by any fd backend.
138   138  
139   @param ep The endpoint to bind to. 139   @param ep The endpoint to bind to.
140   @return Error code on failure, empty on success. 140   @return Error code on failure, empty on success.
141   */ 141   */
HITCBC 142   270 std::error_code do_bind(Endpoint const& ep) noexcept 142   270 std::error_code do_bind(Endpoint const& ep) noexcept
143   { 143   {
HITCBC 144   270 sockaddr_storage storage{}; 144   270 sockaddr_storage storage{};
HITCBC 145   270 socklen_t addrlen = to_sockaddr(ep, socket_family(fd_), storage); 145   270 socklen_t addrlen = to_sockaddr(ep, socket_family(fd_), storage);
HITCBC 146   270 if (::bind(fd_, reinterpret_cast<sockaddr*>(&storage), addrlen) != 0) 146   270 if (::bind(fd_, reinterpret_cast<sockaddr*>(&storage), addrlen) != 0)
HITCBC 147   20 return make_err(errno); 147   20 return make_err(errno);
148   148  
HITCBC 149   250 sockaddr_storage local_storage{}; 149   250 sockaddr_storage local_storage{};
HITCBC 150   250 socklen_t local_len = sizeof(local_storage); 150   250 socklen_t local_len = sizeof(local_storage);
HITCBC 151   250 if (::getsockname( 151   250 if (::getsockname(
HITCBC 152   250 fd_, reinterpret_cast<sockaddr*>(&local_storage), &local_len) == 152   250 fd_, reinterpret_cast<sockaddr*>(&local_storage), &local_len) ==
153   0) 153   0)
HITCBC 154   189 local_endpoint_ = 154   189 local_endpoint_ =
HITCBC 155   250 from_sockaddr_as(local_storage, local_len, Endpoint{}); 155   250 from_sockaddr_as(local_storage, local_len, Endpoint{});
156   156  
HITCBC 157   250 return {}; 157   250 return {};
158   } 158   }
159   }; 159   };
160   160  
161   } // namespace boost::corosio::detail 161   } // namespace boost::corosio::detail
162   162  
163   #endif // BOOST_COROSIO_NATIVE_DETAIL_NATIVE_SOCKET_BASE_HPP 163   #endif // BOOST_COROSIO_NATIVE_DETAIL_NATIVE_SOCKET_BASE_HPP