include/boost/corosio/detail/intrusive.hpp

100.0% Lines (93/93) 100.0% List of functions (92/92) 78.3% Branches (54/69)

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

intrusive.hpp

f(x) Functions (92)

Function Calls Lines Branches Blocks

Line	Branch	Hits	Source Code
1			//
2			// Copyright (c) 2025 Vinnie Falco ([email protected])
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_DETAIL_INTRUSIVE_HPP
11			#define BOOST_COROSIO_DETAIL_INTRUSIVE_HPP
12
13			namespace boost::corosio::detail {
14
15			/** An intrusive doubly linked list.
16
17			This container provides O(1) push and pop operations for
18			elements that derive from @ref node. Elements are not
19			copied or moved; they are linked directly into the list.
20
21			@tparam T The element type. Must derive from `intrusive_list<T>::node`.
22			*/
23			template<class T>
24			class intrusive_list
25			{
26			public:
27			/** Base class for list elements.
28
29			Derive from this class to make a type usable with
30			@ref intrusive_list. The `next_` and `prev_` pointers
31			are private and accessible only to the list.
32			*/
33			class node
34			{
35			friend class intrusive_list;
36
37			private:
38			T* next_ = nullptr;
39			T* prev_ = nullptr;
40			};
41
42			private:
43			T* head_ = nullptr;
44			T* tail_ = nullptr;
45
46			public:
47		20143x	intrusive_list() = default;
48
49		1x	intrusive_list(intrusive_list&& other) noexcept
50		1x	: head_(other.head_)
51		1x	, tail_(other.tail_)
52			{
53		1x	other.head_ = nullptr;
54		1x	other.tail_ = nullptr;
55		1x	}
56
57			intrusive_list(intrusive_list const&) = delete;
58			intrusive_list& operator=(intrusive_list const&) = delete;
59			intrusive_list& operator=(intrusive_list&&) = delete;
60
61		12x	bool empty() const noexcept
62			{
63		12x	return head_ == nullptr;
64			}
65
66			/// Peek at the head element without removing it.
67		6x	T* front() const noexcept
68			{
69		6x	return head_;
70			}
71
72		18637x	void push_back(T* w) noexcept
73			{
74	1/2 ✓ Branch 2 → 3 taken 9204 times. ✗ Branch 2 → 4 not taken.	18637x	auto* n = static_cast<node*>(w);
75		18637x	n->next_ = nullptr;
76		18637x	n->prev_ = tail_;
77	4/4 ✓ Branch 2 → 3 taken 4548 times. ✓ Branch 2 → 4 taken 4885 times. ✓ Branch 5 → 6 taken 4657 times. ✓ Branch 5 → 10 taken 4547 times.	18637x	if (tail_)
78	1/2 ✓ Branch 6 → 7 taken 4657 times. ✗ Branch 6 → 8 not taken.	9205x	static_cast<node*>(tail_)->next_ = w;
79			else
80		9432x	head_ = w;
81		18637x	tail_ = w;
82		18637x	}
83
84		3x	void splice_back(intrusive_list& other) noexcept
85			{
86	2/2 ✓ Branch 3 → 4 taken 1 time. ✓ Branch 3 → 5 taken 2 times.	3x	if (other.empty())
87		1x	return;
88	2/2 ✓ Branch 5 → 6 taken 1 time. ✓ Branch 5 → 7 taken 1 time.	2x	if (tail_)
89			{
90		1x	static_cast<node*>(tail_)->next_ = other.head_;
91		1x	static_cast<node*>(other.head_)->prev_ = tail_;
92		1x	tail_ = other.tail_;
93			}
94			else
95			{
96		1x	head_ = other.head_;
97		1x	tail_ = other.tail_;
98			}
99		2x	other.head_ = nullptr;
100		2x	other.tail_ = nullptr;
101			}
102
103		21184x	T* pop_front() noexcept
104			{
105	2/2 ✓ Branch 2 → 3 taken 20611 times. ✓ Branch 2 → 4 taken 573 times.	21184x	if (!head_)
106		20611x	return nullptr;
107		573x	T* w = head_;
108	1/2 ✓ Branch 4 → 5 taken 18 times. ✗ Branch 4 → 6 not taken.	573x	head_ = static_cast<node*>(head_)->next_;
109	4/4 ✓ Branch 4 → 5 taken 19 times. ✓ Branch 4 → 6 taken 536 times. ✓ Branch 7 → 8 taken 3 times. ✓ Branch 7 → 12 taken 15 times.	573x	if (head_)
110	1/2 ✓ Branch 8 → 9 taken 3 times. ✗ Branch 8 → 10 not taken.	22x	static_cast<node*>(head_)->prev_ = nullptr;
111			else
112		551x	tail_ = nullptr;
113			// Defensive: clear stale linkage so remove() on a
114			// popped node cannot corrupt the list.
115	1/2 ✓ Branch 13 → 14 taken 18 times. ✗ Branch 13 → 15 not taken.	573x	auto* n = static_cast<node*>(w);
116		573x	n->next_ = nullptr;
117		573x	n->prev_ = nullptr;
118		573x	return w;
119			}
120
121		18096x	void remove(T* w) noexcept
122			{
123	1/2 ✓ Branch 2 → 3 taken 9186 times. ✗ Branch 2 → 4 not taken.	18096x	auto* n = static_cast<node*>(w);
124			// Already detached — nothing to do.
125	11/15 ✓ Branch 2 → 3 taken 4635 times. ✓ Branch 2 → 7 taken 4275 times. ✓ Branch 3 → 4 taken 4382 times. ✓ Branch 3 → 7 taken 253 times. ✓ Branch 4 → 5 taken 35 times. ✓ Branch 4 → 7 taken 4347 times. ✓ Branch 5 → 6 taken 4843 times. ✗ Branch 5 → 7 not taken. ✓ Branch 5 → 10 taken 4378 times. ✓ Branch 6 → 7 taken 4532 times. ✓ Branch 6 → 10 taken 276 times. ✗ Branch 7 → 8 not taken. ✓ Branch 7 → 10 taken 4532 times. ✗ Branch 8 → 9 not taken. ✗ Branch 8 → 10 not taken.	18096x	if (!n->next_ && !n->prev_ && head_ != w && tail_ != w)
126		35x	return;
127	4/4 ✓ Branch 7 → 8 taken 647 times. ✓ Branch 7 → 9 taken 8228 times. ✓ Branch 10 → 11 taken 666 times. ✓ Branch 10 → 15 taken 8520 times.	18061x	if (n->prev_)
128	1/2 ✓ Branch 11 → 12 taken 666 times. ✗ Branch 11 → 13 not taken.	1313x	static_cast<node*>(n->prev_)->next_ = n->next_;
129			else
130		16748x	head_ = n->next_;
131	4/4 ✓ Branch 10 → 11 taken 4275 times. ✓ Branch 10 → 12 taken 4600 times. ✓ Branch 16 → 17 taken 4378 times. ✓ Branch 16 → 21 taken 4808 times.	18061x	if (n->next_)
132	1/2 ✓ Branch 17 → 18 taken 4378 times. ✗ Branch 17 → 19 not taken.	8653x	static_cast<node*>(n->next_)->prev_ = n->prev_;
133			else
134		9408x	tail_ = n->prev_;
135		18061x	n->next_ = nullptr;
136		18061x	n->prev_ = nullptr;
137			}
138
139			/// Invoke @p f for each element in the list.
140			template<class F>
141		3x	void for_each(F f)
142			{
143	3/6 ✗ Branch 4 → 5 not taken. ✗ Branch 4 → 6 not taken. ✓ Branch 5 → 3 taken 3 times. ✓ Branch 5 → 6 taken 1 time. ✗ Branch 8 → 3 not taken. ✓ Branch 8 → 9 taken 2 times.	6x	for (T* p = head_; p; p = static_cast<node*>(p)->next_)
144		3x	f(p);
145		3x	}
146			};
147
148			/** An intrusive singly linked FIFO queue.
149
150			This container provides O(1) push and pop operations for
151			elements that derive from @ref node. Elements are not
152			copied or moved; they are linked directly into the queue.
153
154			Unlike @ref intrusive_list, this uses only a single `next_`
155			pointer per node, saving memory at the cost of not supporting
156			O(1) removal of arbitrary elements.
157
158			@tparam T The element type. Must derive from `intrusive_queue<T>::node`.
159			*/
160			template<class T>
161			class intrusive_queue
162			{
163			public:
164			/** Base class for queue elements.
165
166			Derive from this class to make a type usable with
167			@ref intrusive_queue. The `next_` pointer is private
168			and accessible only to the queue.
169			*/
170			class node
171			{
172			friend class intrusive_queue;
173
174			private:
175			T* next_ = nullptr;
176			};
177
178			private:
179			T* head_ = nullptr;
180			T* tail_ = nullptr;
181
182			public:
183		2651x	intrusive_queue() = default;
184
185		1x	intrusive_queue(intrusive_queue&& other) noexcept
186		1x	: head_(other.head_)
187		1x	, tail_(other.tail_)
188			{
189		1x	other.head_ = nullptr;
190		1x	other.tail_ = nullptr;
191		1x	}
192
193			intrusive_queue(intrusive_queue const&) = delete;
194			intrusive_queue& operator=(intrusive_queue const&) = delete;
195			intrusive_queue& operator=(intrusive_queue&&) = delete;
196
197		1858x	bool empty() const noexcept
198			{
199		1858x	return head_ == nullptr;
200			}
201
202		47x	void push(T* w) noexcept
203			{
204		47x	w->next_ = nullptr;
205	2/2 ✓ Branch 2 → 3 taken 16 times. ✓ Branch 2 → 4 taken 31 times.	47x	if (tail_)
206		16x	tail_->next_ = w;
207			else
208		31x	head_ = w;
209		47x	tail_ = w;
210		47x	}
211
212		1817x	void splice(intrusive_queue& other) noexcept
213			{
214	2/2 ✓ Branch 3 → 4 taken 1810 times. ✓ Branch 3 → 5 taken 7 times.	1817x	if (other.empty())
215		1810x	return;
216	2/2 ✓ Branch 5 → 6 taken 1 time. ✓ Branch 5 → 7 taken 6 times.	7x	if (tail_)
217		1x	tail_->next_ = other.head_;
218			else
219		6x	head_ = other.head_;
220		7x	tail_ = other.tail_;
221		7x	other.head_ = nullptr;
222		7x	other.tail_ = nullptr;
223			}
224
225		3136x	T* pop() noexcept
226			{
227	2/2 ✓ Branch 2 → 3 taken 3089 times. ✓ Branch 2 → 4 taken 47 times.	3136x	if (!head_)
228		3089x	return nullptr;
229		47x	T* w = head_;
230		47x	head_ = head_->next_;
231	2/2 ✓ Branch 4 → 5 taken 30 times. ✓ Branch 4 → 6 taken 17 times.	47x	if (!head_)
232		30x	tail_ = nullptr;
233			// Defensive: clear stale linkage on popped node.
234		47x	w->next_ = nullptr;
235		47x	return w;
236			}
237			};
238
239			} // namespace boost::corosio::detail
240
241			#endif
242