. /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, and the synchronous 30   the file descriptor, the cached local endpoint, and the synchronous
31   accessors (native_handle / options / bind). The impl lifecycle (the 31   accessors (native_handle / options / bind). The impl lifecycle (the
32   intrusive refcount + the owning service's recycling pool) is carried 32   intrusive refcount + the owning service's recycling pool) is carried
33   by `io_object::implementation`, not by this base. 33   by `io_object::implementation`, not by this base.
34   34  
35   reactor_basic_socket derives from this and adds the readiness machinery 35   reactor_basic_socket derives from this and adds the readiness machinery
36   (descriptor_state, register_op, the cancel/close that deregister from 36   (descriptor_state, register_op, the cancel/close that deregister from
37   the reactor). io_uring's socket impls derive from it and add their op 37   the reactor). io_uring's socket impls derive from it and add their op
38   slots + SQE submission. This is the socket-layer analogue of io_uring 38   slots + SQE submission. This is the socket-layer analogue of io_uring
39   deriving from reactor_scheduler: io_uring sockets share the reactor's 39   deriving from reactor_scheduler: io_uring sockets share the reactor's
40   readiness-agnostic socket surface, while the on-EAGAIN action (park vs 40   readiness-agnostic socket surface, while the on-EAGAIN action (park vs
41   submit-SQE) and the op model stay backend-specific. 41   submit-SQE) and the op model stay backend-specific.
42   42  
43   @tparam Derived The concrete socket type (CRTP). 43   @tparam Derived The concrete socket type (CRTP).
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   { 54   {
55   protected: 55   protected:
56   // CRTP base: not publicly constructible. The check's preferred fix 56   // CRTP base: not publicly constructible. The check's preferred fix
57   // (private ctor + `friend Derived`) is infeasible here — the reactor 57   // (private ctor + `friend Derived`) is infeasible here — the reactor
58   // sockets reach this base through intermediate templates 58   // sockets reach this base through intermediate templates
59   // (reactor_stream_socket -> reactor_basic_socket) that are not `Derived`, 59   // (reactor_stream_socket -> reactor_basic_socket) that are not `Derived`,
60   // so a private ctor would stop those intermediates from constructing it. 60   // so a private ctor would stop those intermediates from constructing it.
61   // Protected is the correct access; suppress the private-only suggestion. 61   // Protected is the correct access; suppress the private-only suggestion.
62   // NOLINTNEXTLINE(bugprone-crtp-constructor-accessibility) 62   // NOLINTNEXTLINE(bugprone-crtp-constructor-accessibility)
HITCBC 63   5670 native_socket_base() = default; 63   5656 native_socket_base() = default;
64   64  
65   int fd_ = -1; 65   int fd_ = -1;
66   // mutable so a derived const local_endpoint() override can lazily fill 66   // mutable so a derived const local_endpoint() override can lazily fill
67   // it via getsockname() on first read (io_uring's lazy_pending state). 67   // it via getsockname() on first read (io_uring's lazy_pending state).
68   mutable Endpoint local_endpoint_; 68   mutable Endpoint local_endpoint_;
69   69  
70   public: 70   public:
HITCBC 71   5670 ~native_socket_base() override = default; 71   5656 ~native_socket_base() override = default;
72   72  
73   /// Return the underlying file descriptor. 73   /// Return the underlying file descriptor.
HITCBC 74   92935 native_handle_type native_handle() const noexcept override 74   91586 native_handle_type native_handle() const noexcept override
75   { 75   {
HITCBC 76   92935 return fd_; 76   91586 return fd_;
77   } 77   }
78   78  
HITCBC 79   7534 corosio::family family() const noexcept override 79   7213 corosio::family family() const noexcept override
80   { 80   {
HITCBC 81   7534 return to_family(socket_family(fd_)); 81   7213 return to_family(socket_family(fd_));
82   } 82   }
83   83  
84   /// Return the cached local endpoint. 84   /// Return the cached local endpoint.
HITCBC 85   200 Endpoint local_endpoint() const noexcept override 85   200 Endpoint local_endpoint() const noexcept override
86   { 86   {
HITCBC 87   200 return local_endpoint_; 87   200 return local_endpoint_;
88   } 88   }
89   89  
90   /// Return true if the socket has an open file descriptor. 90   /// Return true if the socket has an open file descriptor.
91   bool is_open() const noexcept 91   bool is_open() const noexcept
92   { 92   {
93   return fd_ >= 0; 93   return fd_ >= 0;
94   } 94   }
95   95  
96   /// Set a socket option. 96   /// Set a socket option.
HITCBC 97   117 std::error_code set_option( 97   117 std::error_code set_option(
98   int level, 98   int level,
99   int optname, 99   int optname,
100   void const* data, 100   void const* data,
101   std::size_t size) noexcept override 101   std::size_t size) noexcept override
102   { 102   {
HITCBC 103   117 if (::setsockopt( 103   117 if (::setsockopt(
HITCBC 104   117 fd_, level, optname, data, static_cast<socklen_t>(size)) != 0) 104   117 fd_, level, optname, data, static_cast<socklen_t>(size)) != 0)
HITCBC 105   8 return make_err(errno); 105   8 return make_err(errno);
HITCBC 106   109 return {}; 106   109 return {};
107   } 107   }
108   108  
109   /// Get a socket option. 109   /// Get a socket option.
110   std::error_code 110   std::error_code
HITCBC 111   170 get_option(int level, int optname, void* data, std::size_t* size) 111   170 get_option(int level, int optname, void* data, std::size_t* size)
112   const noexcept override 112   const noexcept override
113   { 113   {
HITCBC 114   170 socklen_t len = static_cast<socklen_t>(*size); 114   170 socklen_t len = static_cast<socklen_t>(*size);
HITCBC 115   170 if (::getsockopt(fd_, level, optname, data, &len) != 0) 115   170 if (::getsockopt(fd_, level, optname, data, &len) != 0)
HITCBC 116   13 return make_err(errno); 116   13 return make_err(errno);
HITCBC 117   157 *size = static_cast<std::size_t>(len); 117   157 *size = static_cast<std::size_t>(len);
HITCBC 118   157 return {}; 118   157 return {};
119   } 119   }
120   120  
121   /// Assign the file descriptor. 121   /// Assign the file descriptor.
HITCBC 122   6397 void set_socket(int fd) noexcept 122   6513 void set_socket(int fd) noexcept
123   { 123   {
HITCBC 124   6397 fd_ = fd; 124   6513 fd_ = fd;
HITCBC 125   6397 } 125   6513 }
126   126  
127   /// Cache the local endpoint. 127   /// Cache the local endpoint.
128   void set_local_endpoint(Endpoint ep) noexcept 128   void set_local_endpoint(Endpoint ep) noexcept
129   { 129   {
130   local_endpoint_ = ep; 130   local_endpoint_ = ep;
131   } 131   }
132   132  
133   /** Bind the socket to a local endpoint. 133   /** Bind the socket to a local endpoint.
134   134  
135   Calls ::bind() and caches the resulting local endpoint via 135   Calls ::bind() and caches the resulting local endpoint via
136   getsockname(). Readiness-agnostic; usable by any fd backend. 136   getsockname(). Readiness-agnostic; usable by any fd backend.
137   137  
138   @param ep The endpoint to bind to. 138   @param ep The endpoint to bind to.
139   @return Error code on failure, empty on success. 139   @return Error code on failure, empty on success.
140   */ 140   */
HITCBC 141   278 std::error_code do_bind(Endpoint const& ep) noexcept 141   278 std::error_code do_bind(Endpoint const& ep) noexcept
142   { 142   {
HITCBC 143   278 sockaddr_storage storage{}; 143   278 sockaddr_storage storage{};
HITCBC 144   278 socklen_t addrlen = to_sockaddr(ep, socket_family(fd_), storage); 144   278 socklen_t addrlen = to_sockaddr(ep, socket_family(fd_), storage);
HITCBC 145   278 if (::bind(fd_, reinterpret_cast<sockaddr*>(&storage), addrlen) != 0) 145   278 if (::bind(fd_, reinterpret_cast<sockaddr*>(&storage), addrlen) != 0)
HITCBC 146   20 return make_err(errno); 146   20 return make_err(errno);
147   147  
HITCBC 148   258 sockaddr_storage local_storage{}; 148   258 sockaddr_storage local_storage{};
HITCBC 149   258 socklen_t local_len = sizeof(local_storage); 149   258 socklen_t local_len = sizeof(local_storage);
HITCBC 150   258 if (::getsockname( 150   258 if (::getsockname(
HITCBC 151   258 fd_, reinterpret_cast<sockaddr*>(&local_storage), &local_len) == 151   258 fd_, reinterpret_cast<sockaddr*>(&local_storage), &local_len) ==
152   0) 152   0)
HITCBC 153   197 local_endpoint_ = 153   197 local_endpoint_ =
HITCBC 154   258 from_sockaddr_as(local_storage, local_len, Endpoint{}); 154   258 from_sockaddr_as(local_storage, local_len, Endpoint{});
155   155  
HITCBC 156   258 return {}; 156   258 return {};
157   } 157   }
158   }; 158   };
159   159  
160   } // namespace boost::corosio::detail 160   } // namespace boost::corosio::detail
161   161  
162   #endif // BOOST_COROSIO_NATIVE_DETAIL_NATIVE_SOCKET_BASE_HPP 162   #endif // BOOST_COROSIO_NATIVE_DETAIL_NATIVE_SOCKET_BASE_HPP