include/boost/corosio/native/detail/posix/posix_resolver_service.hpp

81.1% Lines (236/291) 93.5% List of functions (29/31)

[ ] prev/next file n p prev/next uncovered line

posix_resolver_service.hpp

f(x) Functions (31)

Function Calls Lines Blocks

Line	Hits	Source Code
1		//
2		// Copyright (c) 2026 Steve Gerbino
3		//
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)
6		//
7		// Official repository: https://github.com/cppalliance/corosio
8		//
9
10		#ifndef BOOST_COROSIO_NATIVE_DETAIL_POSIX_POSIX_RESOLVER_SERVICE_HPP
11		#define BOOST_COROSIO_NATIVE_DETAIL_POSIX_POSIX_RESOLVER_SERVICE_HPP
12
13		#include <boost/corosio/detail/platform.hpp>
14
15		#if BOOST_COROSIO_POSIX
16
17		#include <boost/corosio/native/detail/posix/posix_resolver.hpp>
18		#include <boost/corosio/native/detail/reactor/reactor_scheduler.hpp>
19		#include <boost/corosio/detail/thread_pool.hpp>
20
21		#include <unordered_map>
22
23		namespace boost::corosio::detail {
24
25		/** Resolver service for POSIX backends.
26
27		Owns all posix_resolver instances. Thread lifecycle is managed
28		by the thread_pool service.
29		*/
30		class BOOST_COROSIO_DECL posix_resolver_service final
31		: public capy::execution_context::service
32		, public io_object::io_service
33		{
34		public:
35		using key_type = posix_resolver_service;
36
37	517x	posix_resolver_service(capy::execution_context& ctx, scheduler& sched)
38	1034x	: sched_(&sched)
39	517x	, pool_(ctx.make_service<thread_pool>())
40		{
41	517x	}
42
43	1034x	~posix_resolver_service() override = default;
44
45		posix_resolver_service(posix_resolver_service const&) = delete;
46		posix_resolver_service& operator=(posix_resolver_service const&) = delete;
47
48		io_object::implementation* construct() override;
49
50	29x	void destroy(io_object::implementation* p) override
51		{
52	29x	auto& impl = static_cast<posix_resolver&>(*p);
53	29x	impl.cancel();
54	29x	destroy_impl(impl);
55	29x	}
56
57		void shutdown() override;
58		void destroy_impl(posix_resolver& impl);
59
60		void post(scheduler_op* op);
61		void work_started() noexcept;
62		void work_finished() noexcept;
63
64		/** Return the resolver thread pool. */
65	26x	thread_pool& pool() noexcept
66		{
67	26x	return pool_;
68		}
69
70		/** Return true if single-threaded mode is active. */
71	26x	bool single_threaded() const noexcept
72		{
73	26x	return static_cast<reactor_scheduler const*>(sched_)
74	26x	->is_single_threaded();
75		}
76
77		private:
78		scheduler* sched_;
79		thread_pool& pool_;
80		std::mutex mutex_;
81		intrusive_list<posix_resolver> resolver_list_;
82		std::unordered_map<posix_resolver*, std::shared_ptr<posix_resolver>>
83		resolver_ptrs_;
84		};
85
86		/** Get or create the resolver service for the given context.
87
88		This function is called by the concrete scheduler during initialization
89		to create the resolver service with a reference to itself.
90
91		@param ctx Reference to the owning execution_context.
92		@param sched Reference to the scheduler for posting completions.
93		@return Reference to the resolver service.
94		*/
95		posix_resolver_service&
96		get_resolver_service(capy::execution_context& ctx, scheduler& sched);
97
98		// ---------------------------------------------------------------------------
99		// Inline implementation
100		// ---------------------------------------------------------------------------
101
102		// posix_resolver_detail helpers
103
104		inline int
105	16x	posix_resolver_detail::flags_to_hints(resolve_flags flags)
106		{
107	16x	int hints = 0;
108
109	16x	if ((flags & resolve_flags::passive) != resolve_flags::none)
110	✗	hints \|= AI_PASSIVE;
111	16x	if ((flags & resolve_flags::numeric_host) != resolve_flags::none)
112	11x	hints \|= AI_NUMERICHOST;
113	16x	if ((flags & resolve_flags::numeric_service) != resolve_flags::none)
114	8x	hints \|= AI_NUMERICSERV;
115	16x	if ((flags & resolve_flags::address_configured) != resolve_flags::none)
116	✗	hints \|= AI_ADDRCONFIG;
117	16x	if ((flags & resolve_flags::v4_mapped) != resolve_flags::none)
118	✗	hints \|= AI_V4MAPPED;
119	16x	if ((flags & resolve_flags::all_matching) != resolve_flags::none)
120	✗	hints \|= AI_ALL;
121
122	16x	return hints;
123		}
124
125		inline int
126	10x	posix_resolver_detail::flags_to_ni_flags(reverse_flags flags)
127		{
128	10x	int ni_flags = 0;
129
130	10x	if ((flags & reverse_flags::numeric_host) != reverse_flags::none)
131	5x	ni_flags \|= NI_NUMERICHOST;
132	10x	if ((flags & reverse_flags::numeric_service) != reverse_flags::none)
133	5x	ni_flags \|= NI_NUMERICSERV;
134	10x	if ((flags & reverse_flags::name_required) != reverse_flags::none)
135	1x	ni_flags \|= NI_NAMEREQD;
136	10x	if ((flags & reverse_flags::datagram_service) != reverse_flags::none)
137	✗	ni_flags \|= NI_DGRAM;
138
139	10x	return ni_flags;
140		}
141
142		inline resolver_results
143	13x	posix_resolver_detail::convert_results(
144		struct addrinfo* ai, std::string_view host, std::string_view service)
145		{
146	13x	std::vector<resolver_entry> entries;
147	13x	entries.reserve(4); // Most lookups return 1-4 addresses
148
149	26x	for (auto* p = ai; p != nullptr; p = p->ai_next)
150		{
151	13x	if (p->ai_family == AF_INET)
152		{
153	11x	auto* addr = reinterpret_cast<sockaddr_in*>(p->ai_addr);
154	11x	auto ep = from_sockaddr_in(*addr);
155	11x	entries.emplace_back(ep, host, service);
156		}
157	2x	else if (p->ai_family == AF_INET6)
158		{
159	2x	auto* addr = reinterpret_cast<sockaddr_in6*>(p->ai_addr);
160	2x	auto ep = from_sockaddr_in6(*addr);
161	2x	entries.emplace_back(ep, host, service);
162		}
163		}
164
165	26x	return resolver_results(std::move(entries));
166	13x	}
167
168		inline std::error_code
169	4x	posix_resolver_detail::make_gai_error(int gai_err)
170		{
171		// Map GAI errors to appropriate generic error codes
172	4x	switch (gai_err)
173		{
174	✗	case EAI_AGAIN:
175		// Temporary failure - try again later
176	✗	return std::error_code(
177		static_cast<int>(std::errc::resource_unavailable_try_again),
178	✗	std::generic_category());
179
180	✗	case EAI_BADFLAGS:
181		// Invalid flags
182	✗	return std::error_code(
183		static_cast<int>(std::errc::invalid_argument),
184	✗	std::generic_category());
185
186	✗	case EAI_FAIL:
187		// Non-recoverable failure
188	✗	return std::error_code(
189	✗	static_cast<int>(std::errc::io_error), std::generic_category());
190
191	✗	case EAI_FAMILY:
192		// Address family not supported
193	✗	return std::error_code(
194		static_cast<int>(std::errc::address_family_not_supported),
195	✗	std::generic_category());
196
197	✗	case EAI_MEMORY:
198		// Memory allocation failure
199	✗	return std::error_code(
200		static_cast<int>(std::errc::not_enough_memory),
201	✗	std::generic_category());
202
203	4x	case EAI_NONAME:
204		// Host or service not found
205	4x	return std::error_code(
206		static_cast<int>(std::errc::no_such_device_or_address),
207	4x	std::generic_category());
208
209	✗	case EAI_SERVICE:
210		// Service not supported for socket type
211	✗	return std::error_code(
212		static_cast<int>(std::errc::invalid_argument),
213	✗	std::generic_category());
214
215	✗	case EAI_SOCKTYPE:
216		// Socket type not supported
217	✗	return std::error_code(
218		static_cast<int>(std::errc::not_supported),
219	✗	std::generic_category());
220
221	✗	case EAI_SYSTEM:
222		// System error - use errno
223	✗	return std::error_code(errno, std::generic_category());
224
225	✗	default:
226		// Unknown error
227	✗	return std::error_code(
228	✗	static_cast<int>(std::errc::io_error), std::generic_category());
229		}
230		}
231
232		// posix_resolver
233
234	29x	inline posix_resolver::posix_resolver(posix_resolver_service& svc) noexcept
235	29x	: svc_(svc)
236		{
237	29x	}
238
239		// posix_resolver::resolve_op implementation
240
241		inline void
242	16x	posix_resolver::resolve_op::reset() noexcept
243		{
244	16x	host.clear();
245	16x	service.clear();
246	16x	flags = resolve_flags::none;
247	16x	stored_results = resolver_results{};
248	16x	gai_error = 0;
249	16x	cancelled.store(false, std::memory_order_relaxed);
250	16x	stop_cb.reset();
251	16x	ec_out = nullptr;
252	16x	out = nullptr;
253	16x	}
254
255		inline void
256	16x	posix_resolver::resolve_op::operator()()
257		{
258	16x	stop_cb.reset(); // Disconnect stop callback
259
260	16x	bool const was_cancelled = cancelled.load(std::memory_order_acquire);
261
262	16x	if (ec_out)
263		{
264	16x	if (was_cancelled)
265	✗	*ec_out = capy::error::canceled;
266	16x	else if (gai_error != 0)
267	3x	*ec_out = posix_resolver_detail::make_gai_error(gai_error);
268		else
269	13x	*ec_out = {}; // Clear on success
270		}
271
272	16x	if (out && !was_cancelled && gai_error == 0)
273	13x	*out = std::move(stored_results);
274
275	16x	impl->svc_.work_finished();
276	16x	cont_op.cont.h = h;
277	16x	dispatch_coro(ex, cont_op.cont).resume();
278	16x	}
279
280		inline void
281	✗	posix_resolver::resolve_op::destroy()
282		{
283	✗	stop_cb.reset();
284	✗	}
285
286		inline void
287	33x	posix_resolver::resolve_op::request_cancel() noexcept
288		{
289	33x	cancelled.store(true, std::memory_order_release);
290	33x	}
291
292		inline void
293	16x	posix_resolver::resolve_op::start(std::stop_token const& token)
294		{
295	16x	cancelled.store(false, std::memory_order_release);
296	16x	stop_cb.reset();
297
298	16x	if (token.stop_possible())
299	✗	stop_cb.emplace(token, canceller{this});
300	16x	}
301
302		// posix_resolver::reverse_resolve_op implementation
303
304		inline void
305	10x	posix_resolver::reverse_resolve_op::reset() noexcept
306		{
307	10x	ep = endpoint{};
308	10x	flags = reverse_flags::none;
309	10x	stored_host.clear();
310	10x	stored_service.clear();
311	10x	gai_error = 0;
312	10x	cancelled.store(false, std::memory_order_relaxed);
313	10x	stop_cb.reset();
314	10x	ec_out = nullptr;
315	10x	result_out = nullptr;
316	10x	}
317
318		inline void
319	10x	posix_resolver::reverse_resolve_op::operator()()
320		{
321	10x	stop_cb.reset(); // Disconnect stop callback
322
323	10x	bool const was_cancelled = cancelled.load(std::memory_order_acquire);
324
325	10x	if (ec_out)
326		{
327	10x	if (was_cancelled)
328	✗	*ec_out = capy::error::canceled;
329	10x	else if (gai_error != 0)
330	1x	*ec_out = posix_resolver_detail::make_gai_error(gai_error);
331		else
332	9x	*ec_out = {}; // Clear on success
333		}
334
335	10x	if (result_out && !was_cancelled && gai_error == 0)
336		{
337	27x	*result_out = reverse_resolver_result(
338	27x	ep, std::move(stored_host), std::move(stored_service));
339		}
340
341	10x	impl->svc_.work_finished();
342	10x	cont_op.cont.h = h;
343	10x	dispatch_coro(ex, cont_op.cont).resume();
344	10x	}
345
346		inline void
347	✗	posix_resolver::reverse_resolve_op::destroy()
348		{
349	✗	stop_cb.reset();
350	✗	}
351
352		inline void
353	33x	posix_resolver::reverse_resolve_op::request_cancel() noexcept
354		{
355	33x	cancelled.store(true, std::memory_order_release);
356	33x	}
357
358		inline void
359	10x	posix_resolver::reverse_resolve_op::start(std::stop_token const& token)
360		{
361	10x	cancelled.store(false, std::memory_order_release);
362	10x	stop_cb.reset();
363
364	10x	if (token.stop_possible())
365	✗	stop_cb.emplace(token, canceller{this});
366	10x	}
367
368		// posix_resolver implementation
369
370		inline std::coroutine_handle<>
371	16x	posix_resolver::resolve(
372		std::coroutine_handle<> h,
373		capy::executor_ref ex,
374		std::string_view host,
375		std::string_view service,
376		resolve_flags flags,
377		std::stop_token token,
378		std::error_code* ec,
379		resolver_results* out)
380		{
381	16x	if (svc_.single_threaded())
382		{
383	✗	*ec = std::make_error_code(std::errc::operation_not_supported);
384	✗	op_.cont_op.cont.h = h;
385	✗	return dispatch_coro(ex, op_.cont_op.cont);
386		}
387
388	16x	auto& op = op_;
389	16x	op.reset();
390	16x	op.h = h;
391	16x	op.ex = ex;
392	16x	op.impl = this;
393	16x	op.ec_out = ec;
394	16x	op.out = out;
395	16x	op.host = host;
396	16x	op.service = service;
397	16x	op.flags = flags;
398	16x	op.start(token);
399
400		// Keep io_context alive while resolution is pending
401	16x	op.ex.on_work_started();
402
403		// Prevent impl destruction while work is in flight
404	16x	resolve_pool_op_.resolver_ = this;
405	16x	resolve_pool_op_.ref_ = this->shared_from_this();
406	16x	resolve_pool_op_.func_ = &posix_resolver::do_resolve_work;
407	16x	if (!svc_.pool().post(&resolve_pool_op_))
408		{
409		// Pool shut down — complete with cancellation
410	✗	resolve_pool_op_.ref_.reset();
411	✗	op.cancelled.store(true, std::memory_order_release);
412	✗	svc_.post(&op_);
413		}
414	16x	return std::noop_coroutine();
415		}
416
417		inline std::coroutine_handle<>
418	10x	posix_resolver::reverse_resolve(
419		std::coroutine_handle<> h,
420		capy::executor_ref ex,
421		endpoint const& ep,
422		reverse_flags flags,
423		std::stop_token token,
424		std::error_code* ec,
425		reverse_resolver_result* result_out)
426		{
427	10x	if (svc_.single_threaded())
428		{
429	✗	*ec = std::make_error_code(std::errc::operation_not_supported);
430	✗	reverse_op_.cont_op.cont.h = h;
431	✗	return dispatch_coro(ex, reverse_op_.cont_op.cont);
432		}
433
434	10x	auto& op = reverse_op_;
435	10x	op.reset();
436	10x	op.h = h;
437	10x	op.ex = ex;
438	10x	op.impl = this;
439	10x	op.ec_out = ec;
440	10x	op.result_out = result_out;
441	10x	op.ep = ep;
442	10x	op.flags = flags;
443	10x	op.start(token);
444
445		// Keep io_context alive while resolution is pending
446	10x	op.ex.on_work_started();
447
448		// Prevent impl destruction while work is in flight
449	10x	reverse_pool_op_.resolver_ = this;
450	10x	reverse_pool_op_.ref_ = this->shared_from_this();
451	10x	reverse_pool_op_.func_ = &posix_resolver::do_reverse_resolve_work;
452	10x	if (!svc_.pool().post(&reverse_pool_op_))
453		{
454		// Pool shut down — complete with cancellation
455	✗	reverse_pool_op_.ref_.reset();
456	✗	op.cancelled.store(true, std::memory_order_release);
457	✗	svc_.post(&reverse_op_);
458		}
459	10x	return std::noop_coroutine();
460		}
461
462		inline void
463	33x	posix_resolver::cancel() noexcept
464		{
465	33x	op_.request_cancel();
466	33x	reverse_op_.request_cancel();
467	33x	}
468
469		inline void
470	16x	posix_resolver::do_resolve_work(pool_work_item* w) noexcept
471		{
472	16x	auto* pw = static_cast<pool_op*>(w);
473	16x	auto* self = pw->resolver_;
474
475	16x	struct addrinfo hints{};
476	16x	hints.ai_family = AF_UNSPEC;
477	16x	hints.ai_socktype = SOCK_STREAM;
478	16x	hints.ai_flags = posix_resolver_detail::flags_to_hints(self->op_.flags);
479
480	16x	struct addrinfo* ai = nullptr;
481	48x	int result = ::getaddrinfo(
482	32x	self->op_.host.empty() ? nullptr : self->op_.host.c_str(),
483	32x	self->op_.service.empty() ? nullptr : self->op_.service.c_str(), &hints,
484		&ai);
485
486	16x	if (!self->op_.cancelled.load(std::memory_order_acquire))
487		{
488	16x	if (result == 0 && ai)
489		{
490	26x	self->op_.stored_results = posix_resolver_detail::convert_results(
491	13x	ai, self->op_.host, self->op_.service);
492	13x	self->op_.gai_error = 0;
493		}
494		else
495		{
496	3x	self->op_.gai_error = result;
497		}
498		}
499
500	16x	if (ai)
501	13x	::freeaddrinfo(ai);
502
503		// Move ref to stack before post — post may trigger destroy_impl
504		// which erases the last shared_ptr, destroying self (and pw)
505	16x	auto ref = std::move(pw->ref_);
506	16x	self->svc_.post(&self->op_);
507	16x	}
508
509		inline void
510	10x	posix_resolver::do_reverse_resolve_work(pool_work_item* w) noexcept
511		{
512	10x	auto* pw = static_cast<pool_op*>(w);
513	10x	auto* self = pw->resolver_;
514
515	10x	sockaddr_storage ss{};
516		socklen_t ss_len;
517
518	10x	if (self->reverse_op_.ep.is_v4())
519		{
520	8x	auto sa = to_sockaddr_in(self->reverse_op_.ep);
521	8x	std::memcpy(&ss, &sa, sizeof(sa));
522	8x	ss_len = sizeof(sockaddr_in);
523		}
524		else
525		{
526	2x	auto sa = to_sockaddr_in6(self->reverse_op_.ep);
527	2x	std::memcpy(&ss, &sa, sizeof(sa));
528	2x	ss_len = sizeof(sockaddr_in6);
529		}
530
531		char host[NI_MAXHOST];
532		char service[NI_MAXSERV];
533
534	10x	int result = ::getnameinfo(
535		reinterpret_cast<sockaddr*>(&ss), ss_len, host, sizeof(host), service,
536		sizeof(service),
537		posix_resolver_detail::flags_to_ni_flags(self->reverse_op_.flags));
538
539	10x	if (!self->reverse_op_.cancelled.load(std::memory_order_acquire))
540		{
541	10x	if (result == 0)
542		{
543	9x	self->reverse_op_.stored_host = host;
544	9x	self->reverse_op_.stored_service = service;
545	9x	self->reverse_op_.gai_error = 0;
546		}
547		else
548		{
549	1x	self->reverse_op_.gai_error = result;
550		}
551		}
552
553		// Move ref to stack before post — post may trigger destroy_impl
554		// which erases the last shared_ptr, destroying self (and pw)
555	10x	auto ref = std::move(pw->ref_);
556	10x	self->svc_.post(&self->reverse_op_);
557	10x	}
558
559		// posix_resolver_service implementation
560
561		inline void
562	517x	posix_resolver_service::shutdown()
563		{
564	517x	std::lock_guard<std::mutex> lock(mutex_);
565
566		// Cancel all resolvers (sets cancelled flag checked by pool threads)
567	517x	for (auto* impl = resolver_list_.pop_front(); impl != nullptr;
568	✗	impl = resolver_list_.pop_front())
569		{
570	✗	impl->cancel();
571		}
572
573		// Clear the map which releases shared_ptrs.
574		// The thread pool service shuts down separately via
575		// execution_context service ordering.
576	517x	resolver_ptrs_.clear();
577	517x	}
578
579		inline io_object::implementation*
580	29x	posix_resolver_service::construct()
581		{
582	29x	auto ptr = std::make_shared<posix_resolver>(*this);
583	29x	auto* impl = ptr.get();
584
585		{
586	29x	std::lock_guard<std::mutex> lock(mutex_);
587	29x	resolver_list_.push_back(impl);
588	29x	resolver_ptrs_[impl] = std::move(ptr);
589	29x	}
590
591	29x	return impl;
592	29x	}
593
594		inline void
595	29x	posix_resolver_service::destroy_impl(posix_resolver& impl)
596		{
597	29x	std::lock_guard<std::mutex> lock(mutex_);
598	29x	resolver_list_.remove(&impl);
599	29x	resolver_ptrs_.erase(&impl);
600	29x	}
601
602		inline void
603	26x	posix_resolver_service::post(scheduler_op* op)
604		{
605	26x	sched_->post(op);
606	26x	}
607
608		inline void
609		posix_resolver_service::work_started() noexcept
610		{
611		sched_->work_started();
612		}
613
614		inline void
615	26x	posix_resolver_service::work_finished() noexcept
616		{
617	26x	sched_->work_finished();
618	26x	}
619
620		// Free function to get/create the resolver service
621
622		inline posix_resolver_service&
623	517x	get_resolver_service(capy::execution_context& ctx, scheduler& sched)
624		{
625	517x	return ctx.make_service<posix_resolver_service>(sched);
626		}
627
628		} // namespace boost::corosio::detail
629
630		#endif // BOOST_COROSIO_POSIX
631
632		#endif // BOOST_COROSIO_NATIVE_DETAIL_POSIX_POSIX_RESOLVER_SERVICE_HPP
633