GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/util/tube.h
Date: 2026-04-26 02:35:59
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 <cassert>
12 #include <cstddef>
13 #include <vector>
14
15 #include "util/atomic.h"
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 304442077 explicit Link(ItemT *item) : item_(item), next_(NULL), prev_(NULL) { }
46 44 ItemT *item() { return item_; }
47
48 private:
49 ItemT *item_;
50 Link *next_;
51 Link *prev_;
52 };
53
54 215737 Tube() : limit_(uint64_t(-1)), size_(0) { Init(); }
55 2295 explicit Tube(uint64_t limit) : limit_(limit), size_(0) { Init(); }
56 222408 ~Tube() {
57 222632 Link *cursor = head_;
58 do {
59 222671 Link *prev = cursor->prev_;
60
1/2
✓ Branch 0 taken 114042 times.
✗ Branch 1 not taken.
 222671 delete cursor;
61 222671 cursor = prev;
62
2/2
✓ Branch 0 taken 39 times.
✓ Branch 1 taken 114003 times.
 222671 } while (cursor != head_);
63 222632 pthread_cond_destroy(&cond_populated_);
64 222632 pthread_cond_destroy(&cond_capacious_);
65 222632 pthread_cond_destroy(&cond_empty_);
66 222632 pthread_mutex_destroy(&lock_);
67 222632 }
68
69 /**
70 * Push an item to the back of the queue. Block if queue is currently full.
71 */
72 289333615 Link *EnqueueBack(ItemT *item) {
73
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 157139871 times.
 289333615 assert(item != NULL);
74 289333615 MutexLockGuard lock_guard(&lock_);
75
2/2
✓ Branch 0 taken 46254 times.
✓ Branch 1 taken 156886384 times.
 288901794 while (size_ == limit_)
76
1/2
✓ Branch 1 taken 48789 times.
✗ Branch 2 not taken.
 92508 pthread_cond_wait(&cond_capacious_, &lock_);
77
78
1/2
✓ Branch 1 taken 157001343 times.
✗ Branch 2 not taken.
 288809286 Link *link = new Link(item);
79 287709280 link->next_ = head_->next_;
80 287709280 link->prev_ = head_;
81 287709280 head_->next_->prev_ = link;
82 287709280 head_->next_ = link;
83 287709280 size_++;
84 287709280 int retval = pthread_cond_signal(&cond_populated_);
85
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 157665804 times.
 290368126 assert(retval == 0);
86 289615618 return link;
87 290368126 }
88
89 /**
90 * Push an item to the front of the queue. Block if queue currently full.
91 */
92 15701311 Link *EnqueueFront(ItemT *item) {
93
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 15699413 times.
 15701311 assert(item != NULL);
94 15701311 MutexLockGuard lock_guard(&lock_);
95
2/2
✓ Branch 0 taken 81 times.
✓ Branch 1 taken 15699413 times.
 15701473 while (size_ == limit_)
96
1/2
✓ Branch 1 taken 81 times.
✗ Branch 2 not taken.
 162 pthread_cond_wait(&cond_capacious_, &lock_);
97
98
1/2
✓ Branch 1 taken 15699452 times.
✗ Branch 2 not taken.
 15701311 Link *link = new Link(item);
99 15701194 link->next_ = head_;
100 15701194 link->prev_ = head_->prev_;
101 15701194 head_->prev_->next_ = link;
102 15701194 head_->prev_ = link;
103 15701194 size_++;
104 15701194 int retval = pthread_cond_signal(&cond_populated_);
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 15699296 times.
 15701194 assert(retval == 0);
106 15701389 return link;
107 15701194 }
108
109 /**
110 * Remove any link from the queue and return its item, including first/last
111 * element.
112 */
113 88 ItemT *Slice(Link *link) {
114 88 MutexLockGuard lock_guard(&lock_);
115 88 return SliceUnlocked(link);
116 88 }
117
118 /**
119 * Remove and return the first element from the queue. Block if tube is
120 * empty.
121 */
122 303646574 ItemT *PopFront() {
123 303646574 MutexLockGuard lock_guard(&lock_);
124
2/2
✓ Branch 0 taken 49380710 times.
✓ Branch 1 taken 171425131 times.
 401459686 while (size_ == 0)
125
1/2
✓ Branch 1 taken 49179382 times.
✗ Branch 2 not taken.
 97944362 pthread_cond_wait(&cond_populated_, &lock_);
126 607626844 return SliceUnlocked(head_->prev_);
127 303586466 }
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 15694335 ItemT *TryPopFront() {
137 15694335 MutexLockGuard lock_guard(&lock_);
138 // Note that we don't need to wait for a signal to arrive
139
2/2
✓ Branch 0 taken 14371588 times.
✓ Branch 1 taken 1325477 times.
 15697065 if (size_ == 0)
140 14371588 return NULL;
141 1325477 return SliceUnlocked(head_->prev_);
142 15697065 }
143
144 /**
145 * Remove and return the last element from the queue. Block if tube is
146 * empty.
147 */
148 4368 ItemT *PopBack() {
149 4368 MutexLockGuard lock_guard(&lock_);
150
2/2
✓ Branch 0 taken 567 times.
✓ Branch 1 taken 2470 times.
 5502 while (size_ == 0)
151
1/2
✓ Branch 1 taken 567 times.
✗ Branch 2 not taken.
 1134 pthread_cond_wait(&cond_populated_, &lock_);
152 8736 return SliceUnlocked(head_->next_);
153 4368 }
154
155 /**
156 * Blocks until the tube is empty
157 */
158 2048 void Wait() {
159 2048 MutexLockGuard lock_guard(&lock_);
160
2/2
✓ Branch 0 taken 753 times.
✓ Branch 1 taken 2048 times.
 2801 while (size_ > 0)
161
1/2
✓ Branch 1 taken 753 times.
✗ Branch 2 not taken.
 753 pthread_cond_wait(&cond_empty_, &lock_);
162 2048 }
163
164 16900 bool IsEmpty() {
165 16900 MutexLockGuard lock_guard(&lock_);
166 33800 return size_ == 0;
167 16900 }
168
169 590 uint64_t size() {
170 590 MutexLockGuard lock_guard(&lock_);
171 1180 return size_;
172 590 }
173
174 private:
175 219431 void Init() {
176 219431 Link *sentinel = new Link(NULL);
177 219431 head_ = sentinel;
178 219431 head_->next_ = head_->prev_ = sentinel;
179
180 219431 int retval = pthread_mutex_init(&lock_, NULL);
181
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 114079 times.
 219431 assert(retval == 0);
182 219431 retval = pthread_cond_init(&cond_populated_, NULL);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 114079 times.
 219431 assert(retval == 0);
184 219431 retval = pthread_cond_init(&cond_capacious_, NULL);
185
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 114079 times.
 219431 assert(retval == 0);
186 219431 retval = pthread_cond_init(&cond_empty_, NULL);
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 114079 times.
 219431 assert(retval == 0);
188 219431 }
189
190 304705661 ItemT *SliceUnlocked(Link *link) {
191 // Cannot delete the sentinel link
192
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 172682419 times.
 304705661 assert(link != head_);
193 304705661 link->prev_->next_ = link->next_;
194 304705661 link->next_->prev_ = link->prev_;
195 304705661 ItemT *item = link->item_;
196
2/2
✓ Branch 0 taken 171847835 times.
✓ Branch 1 taken 834584 times.
 304705661 delete link;
197 308005339 size_--;
198 308005339 int retval = pthread_cond_signal(&cond_capacious_);
199
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 173619931 times.
 306580685 assert(retval == 0);
200
2/2
✓ Branch 0 taken 44846503 times.
✓ Branch 1 taken 128773428 times.
 306580685 if (size_ == 0) {
201 87412849 retval = pthread_cond_broadcast(&cond_empty_);
202
2/2
✓ Branch 0 taken 609776 times.
✓ Branch 1 taken 44233655 times.
 87406705 assert(retval == 0);
203 }
204 305354989 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 17209 TubeGroup() : is_active_(false) { atomic_init32(&round_robin_); }
248
249 17198 ~TubeGroup() {
250
2/2
✓ Branch 1 taken 104274 times.
✓ Branch 2 taken 10184 times.
 222038 for (unsigned i = 0; i < tubes_.size(); ++i)
251
1/2
✓ Branch 1 taken 104274 times.
✗ Branch 2 not taken.
 204840 delete tubes_[i];
252 17198 }
253
254 204985 void TakeTube(Tube<ItemT> *t) {
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 104347 times.
 204985 assert(!is_active_);
256 204985 tubes_.push_back(t);
257 204985 }
258
259 17209 void Activate() {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 10190 times.
 17209 assert(!is_active_);
261
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 10190 times.
 17209 assert(!tubes_.empty());
262 17209 is_active_ = true;
263 17209 }
264
265 /**
266 * Like Tube::EnqueueBack(), but pick a tube according to ItemT::tag()
267 */
268 118158313 typename Tube<ItemT>::Link *Dispatch(ItemT *item) {
269
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 118158313 times.
 118158313 assert(is_active_);
270
2/2
✓ Branch 1 taken 93366295 times.
✓ Branch 2 taken 24960030 times.
 118158313 unsigned tube_idx = (tubes_.size() == 1) ? 0
271 93366295 : (item->tag() % tubes_.size());
272 117966624 return tubes_[tube_idx]->EnqueueBack(item);
273 }
274
275 /**
276 * Like Tube::EnqueueBack(), use tubes one after another
277 */
278 9752529 typename Tube<ItemT>::Link *DispatchAny(ItemT *item) {
279
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9752529 times.
 9752529 assert(is_active_);
280
2/2
✓ Branch 1 taken 9752523 times.
✓ Branch 2 taken 6 times.
 9752529 unsigned tube_idx = (tubes_.size() == 1)
281 ? 0
282 9752523 : (atomic_xadd32(&round_robin_, 1) % tubes_.size());
283 9752529 return tubes_[tube_idx]->EnqueueBack(item);
284 }
285
286 private:
287 bool is_active_;
288 std::vector<Tube<ItemT> *> tubes_;
289 atomic_int32 round_robin_;
290 };
291
292 #endif // CVMFS_UTIL_TUBE_H_
293