GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/util/tube.h
Date: 2026-10-11 02:40:02
Exec Total Coverage
Lines: 130 130 100.0%
Branches: 50 74 67.6%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #ifndef CVMFS_UTIL_TUBE_H_
6 #define CVMFS_UTIL_TUBE_H_
7
8 #include <pthread.h>
9 #include <stdint.h>
10
11 #include <atomic>
12 #include <cassert>
13 #include <cstddef>
14 #include <vector>
15
16 #include "util/mutex.h"
17 #include "util/single_copy.h"
18
19 /**
20 * A thread-safe, doubly linked list of links containing pointers to ItemT. The
21 * ItemT elements are not owned by the Tube. FIFO or LIFO semantics. Using
22 * Slice(), items at arbitrary locations in the tube can be removed, too.
23 *
24 *
25 * The layout of the linked list is as follows:
26 *
27 * --------------------------------------------------------------
28 * | |
29 * --> I$n$ (back) <--> I2 <--> ... <--> I1 (front) <--> HEAD <--
30 *
31 * The tube links the steps in the file processing pipeline. It connects
32 * multiple producers to multiple consumers and can throttle the producers if a
33 * limit for the tube size is set.
34 *
35 * Internally, uses conditional variables to block when threads try to pop from
36 * the empty tube or insert into the full tube.
37 */
38 template<class ItemT>
39 class Tube : SingleCopy {
40 public:
41 class Link : SingleCopy {
42 friend class Tube<ItemT>;
43
44 public:
45 161706504 explicit Link(ItemT *item) : item_(item), next_(NULL), prev_(NULL) { }
46 1 ItemT *item() { return item_; }
47
48 private:
49 ItemT *item_;
50 Link *next_;
51 Link *prev_;
52 };
53
54 164679 Tube() : limit_(uint64_t(-1)), size_(0) { Init(); }
55 2431 explicit Tube(uint64_t limit) : limit_(limit), size_(0) { Init(); }
56 170353 ~Tube() {
57 170692 Link *cursor = head_;
58 do {
59 170736 Link *prev = cursor->prev_;
60
1/2
✓ Branch 0 taken 87151 times.
✗ Branch 1 not taken.
 170736 delete cursor;
61 170736 cursor = prev;
62
2/2
✓ Branch 0 taken 44 times.
✓ Branch 1 taken 87107 times.
 170736 } while (cursor != head_);
63 170692 pthread_cond_destroy(&cond_populated_);
64 170692 pthread_cond_destroy(&cond_capacious_);
65 170692 pthread_cond_destroy(&cond_empty_);
66 170692 pthread_mutex_destroy(&lock_);
67 170692 }
68
69 /**
70 * Push an item to the back of the queue. Block if queue is currently full.
71 */
72 143812650 Link *EnqueueBack(ItemT *item) {
73
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 78363161 times.
 143812650 assert(item != NULL);
74 143812650 MutexLockGuard lock_guard(&lock_);
75
2/2
✓ Branch 0 taken 4052898 times.
✓ Branch 1 taken 78405910 times.
 152003044 while (size_ == limit_)
76
1/2
✓ Branch 1 taken 4052880 times.
✗ Branch 2 not taken.
 8105796 pthread_cond_wait(&cond_capacious_, &lock_);
77
78
1/2
✓ Branch 1 taken 78409731 times.
✗ Branch 2 not taken.
 143897248 Link *link = new Link(item);
79 143803570 link->next_ = head_->next_;
80 143803570 link->prev_ = head_;
81 143803570 head_->next_->prev_ = link;
82 143803570 head_->next_ = link;
83 143803570 size_++;
84 143803570 int retval = pthread_cond_signal(&cond_populated_);
85
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 78393332 times.
 143872092 assert(retval == 0);
86 143850830 return link;
87 143872092 }
88
89 /**
90 * Push an item to the front of the queue. Block if queue currently full.
91 */
92 17697111 Link *EnqueueFront(ItemT *item) {
93
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 17694106 times.
 17697111 assert(item != NULL);
94 17697111 MutexLockGuard lock_guard(&lock_);
95
2/2
✓ Branch 0 taken 129 times.
✓ Branch 1 taken 17694106 times.
 17697369 while (size_ == limit_)
96
1/2
✓ Branch 1 taken 129 times.
✗ Branch 2 not taken.
 258 pthread_cond_wait(&cond_capacious_, &lock_);
97
98
1/2
✓ Branch 1 taken 17694106 times.
✗ Branch 2 not taken.
 17697111 Link *link = new Link(item);
99 17697155 link->next_ = head_;
100 17697155 link->prev_ = head_->prev_;
101 17697155 head_->prev_->next_ = link;
102 17697155 head_->prev_ = link;
103 17697155 size_++;
104 17697155 int retval = pthread_cond_signal(&cond_populated_);
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 17694150 times.
 17697155 assert(retval == 0);
106 17697155 return link;
107 17697155 }
108
109 /**
110 * Remove any link from the queue and return its item, including first/last
111 * element.
112 */
113 10 ItemT *Slice(Link *link) {
114 10 MutexLockGuard lock_guard(&lock_);
115 10 return SliceUnlocked(link);
116 10 }
117
118 /**
119 * Remove and return the first element from the queue. Block if tube is
120 * empty.
121 */
122 160012133 ItemT *PopFront() {
123 160012133 MutexLockGuard lock_guard(&lock_);
124
2/2
✓ Branch 0 taken 32630370 times.
✓ Branch 1 taken 94629953 times.
 219990787 while (size_ == 0)
125
1/2
✓ Branch 1 taken 32654046 times.
✗ Branch 2 not taken.
 59842379 pthread_cond_wait(&cond_populated_, &lock_);
126 320243699 return SliceUnlocked(head_->prev_);
127 160044138 }
128
129 /**
130 * Remove and return the first element from the queue if there is any.
131 * Equivalent to an antomic
132 * ItemT item = NULL;
133 * if (!IsEmpty())
134 * item = PopFront();
135 */
136 17687941 ItemT *TryPopFront() {
137 17687941 MutexLockGuard lock_guard(&lock_);
138 // Note that we don't need to wait for a signal to arrive
139
2/2
✓ Branch 0 taken 16196929 times.
✓ Branch 1 taken 1494048 times.
 17690977 if (size_ == 0)
140 16196929 return NULL;
141 1494048 return SliceUnlocked(head_->prev_);
142 17690977 }
143
144 /**
145 * Remove and return the last element from the queue. Block if tube is
146 * empty.
147 */
148 6127 ItemT *PopBack() {
149 6127 MutexLockGuard lock_guard(&lock_);
150
2/2
✓ Branch 0 taken 387 times.
✓ Branch 1 taken 3122 times.
 6901 while (size_ == 0)
151
1/2
✓ Branch 1 taken 387 times.
✗ Branch 2 not taken.
 774 pthread_cond_wait(&cond_populated_, &lock_);
152 12254 return SliceUnlocked(head_->next_);
153 6127 }
154
155 /**
156 * Blocks until the tube is empty
157 */
158 1607 void Wait() {
159 1607 MutexLockGuard lock_guard(&lock_);
160
2/2
✓ Branch 0 taken 557 times.
✓ Branch 1 taken 1607 times.
 2164 while (size_ > 0)
161
1/2
✓ Branch 1 taken 557 times.
✗ Branch 2 not taken.
 557 pthread_cond_wait(&cond_empty_, &lock_);
162 1607 }
163
164 9387 bool IsEmpty() {
165 9387 MutexLockGuard lock_guard(&lock_);
166 18774 return size_ == 0;
167 9387 }
168
169 311 uint64_t size() {
170 311 MutexLockGuard lock_guard(&lock_);
171 622 return size_;
172 311 }
173
174 private:
175 168185 void Init() {
176 168185 Link *sentinel = new Link(NULL);
177 168185 head_ = sentinel;
178 168185 head_->next_ = head_->prev_ = sentinel;
179
180 168185 int retval = pthread_mutex_init(&lock_, NULL);
181
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 87183 times.
 168185 assert(retval == 0);
182 168185 retval = pthread_cond_init(&cond_populated_, NULL);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 87183 times.
 168185 assert(retval == 0);
184 168185 retval = pthread_cond_init(&cond_capacious_, NULL);
185
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 87183 times.
 168185 assert(retval == 0);
186 168185 retval = pthread_cond_init(&cond_empty_, NULL);
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 87183 times.
 168185 assert(retval == 0);
188 168185 }
189
190 161564720 ItemT *SliceUnlocked(Link *link) {
191 // Cannot delete the sentinel link
192
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 96083694 times.
 161564720 assert(link != head_);
193 161564720 link->prev_->next_ = link->next_;
194 161564720 link->next_->prev_ = link->prev_;
195 161564720 ItemT *item = link->item_;
196
2/2
✓ Branch 0 taken 96004669 times.
✓ Branch 1 taken 79025 times.
 161564720 delete link;
197 161684536 size_--;
198 161684536 int retval = pthread_cond_signal(&cond_capacious_);
199
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 96112711 times.
 161622754 assert(retval == 0);
200
2/2
✓ Branch 0 taken 33808536 times.
✓ Branch 1 taken 62304175 times.
 161622754 if (size_ == 0) {
201 60543078 retval = pthread_cond_broadcast(&cond_empty_);
202
2/2
✓ Branch 0 taken 22607 times.
✓ Branch 1 taken 33785756 times.
 60542732 assert(retval == 0);
203 }
204 161577238 return item;
205 }
206
207
208 /**
209 * Adding new item blocks as long as limit_ == size_
210 */
211 uint64_t limit_;
212 /**
213 * The current number of links in the list
214 */
215 uint64_t size_;
216 /**
217 * Sentinel element in front of the first (front) element
218 */
219 Link *head_;
220 /**
221 * Protects all internal state
222 */
223 pthread_mutex_t lock_;
224 /**
225 * Signals if there are items enqueued
226 */
227 pthread_cond_t cond_populated_;
228 /**
229 * Signals if there is space to enqueue more items
230 */
231 pthread_cond_t cond_capacious_;
232 /**
233 * Signals if the queue runs empty
234 */
235 pthread_cond_t cond_empty_;
236 };
237
238
239 /**
240 * A tube group manages a fixed set of Tubes and dispatches items among them in
241 * such a way that items with the same tag (a positive integer) are all sent
242 * to the same tube.
243 */
244 template<class ItemT>
245 class TubeGroup : SingleCopy {
246 public:
247 13853 TubeGroup() : is_active_(false) { round_robin_.store(0); }
248
249 13842 ~TubeGroup() {
250
2/2
✓ Branch 1 taken 79038 times.
✓ Branch 2 taken 8128 times.
 168918 for (unsigned i = 0; i < tubes_.size(); ++i)
251
1/2
✓ Branch 1 taken 79038 times.
✗ Branch 2 not taken.
 155076 delete tubes_[i];
252 13842 }
253
254 155221 void TakeTube(Tube<ItemT> *t) {
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 79111 times.
 155221 assert(!is_active_);
256 155221 tubes_.push_back(t);
257 155221 }
258
259 13853 void Activate() {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8134 times.
 13853 assert(!is_active_);
261
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 8134 times.
 13853 assert(!tubes_.empty());
262 13853 is_active_ = true;
263 13853 }
264
265 /**
266 * Like Tube::EnqueueBack(), but pick a tube according to ItemT::tag()
267 */
268 57084948 typename Tube<ItemT>::Link *Dispatch(ItemT *item) {
269
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 57084948 times.
 57084948 assert(is_active_);
270
2/2
✓ Branch 1 taken 43345014 times.
✓ Branch 2 taken 13733076 times.
 57084948 unsigned tube_idx = (tubes_.size() == 1) ? 0
271 43345014 : (item->tag() % tubes_.size());
272 57052926 return tubes_[tube_idx]->EnqueueBack(item);
273 }
274
275 /**
276 * Like Tube::EnqueueBack(), use tubes one after another
277 */
278 4502139 typename Tube<ItemT>::Link *DispatchAny(ItemT *item) {
279
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4502139 times.
 4502139 assert(is_active_);
280
2/2
✓ Branch 1 taken 4502053 times.
✓ Branch 2 taken 86 times.
 4502139 unsigned tube_idx = (tubes_.size() == 1)
281 ? 0
282 9004106 : (round_robin_.fetch_add(1) % tubes_.size());
283 4502139 return tubes_[tube_idx]->EnqueueBack(item);
284 }
285
286 private:
287 bool is_active_;
288 std::vector<Tube<ItemT> *> tubes_;
289 std::atomic<int32_t> round_robin_;
290 };
291
292 #endif // CVMFS_UTIL_TUBE_H_
293