GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/util/tube.h
Date: 2026-05-24 02:35:55
Exec Total Coverage
Lines: 129 130 99.2%
Branches: 48 74 64.9%
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 80521729 explicit Link(ItemT *item) : item_(item), next_(NULL), prev_(NULL) { }
46 13 ItemT *item() { return item_; }
47
48 private:
49 ItemT *item_;
50 Link *next_;
51 Link *prev_;
52 };
53
54 143173 Tube() : limit_(uint64_t(-1)), size_(0) { Init(); }
55 1410 explicit Tube(uint64_t limit) : limit_(limit), size_(0) { Init(); }
56 147475 ~Tube() {
57 147593 Link *cursor = head_;
58 do {
59 147603 Link *prev = cursor->prev_;
60
1/2
✓ Branch 0 taken 74960 times.
✗ Branch 1 not taken.
 147603 delete cursor;
61 147603 cursor = prev;
62
2/2
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 74950 times.
 147603 } while (cursor != head_);
63 147593 pthread_cond_destroy(&cond_populated_);
64 147593 pthread_cond_destroy(&cond_capacious_);
65 147593 pthread_cond_destroy(&cond_empty_);
66 147593 pthread_mutex_destroy(&lock_);
67 147593 }
68
69 /**
70 * Push an item to the back of the queue. Block if queue is currently full.
71 */
72 76425321 Link *EnqueueBack(ItemT *item) {
73
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 41618532 times.
 76425321 assert(item != NULL);
74 76425321 MutexLockGuard lock_guard(&lock_);
75
2/2
✓ Branch 0 taken 1797570 times.
✓ Branch 1 taken 41718524 times.
 80217795 while (size_ == limit_)
76
1/2
✓ Branch 1 taken 1803030 times.
✗ Branch 2 not taken.
 3595140 pthread_cond_wait(&cond_capacious_, &lock_);
77
78
1/2
✓ Branch 1 taken 41744913 times.
✗ Branch 2 not taken.
 76622655 Link *link = new Link(item);
79 75820697 link->next_ = head_->next_;
80 75820697 link->prev_ = head_;
81 75820697 head_->next_->prev_ = link;
82 75820697 head_->next_ = link;
83 75820697 size_++;
84 75820697 int retval = pthread_cond_signal(&cond_populated_);
85
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 41793042 times.
 76771691 assert(retval == 0);
86 76454111 return link;
87 76771691 }
88
89 /**
90 * Push an item to the front of the queue. Block if queue currently full.
91 */
92 4034327 Link *EnqueueFront(ItemT *item) {
93
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4033403 times.
 4034327 assert(item != NULL);
94 4034327 MutexLockGuard lock_guard(&lock_);
95
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4033403 times.
 4034327 while (size_ == limit_)
96 ✗ pthread_cond_wait(&cond_capacious_, &lock_);
97
98
1/2
✓ Branch 1 taken 4033403 times.
✗ Branch 2 not taken.
 4034327 Link *link = new Link(item);
99 4034327 link->next_ = head_;
100 4034327 link->prev_ = head_->prev_;
101 4034327 head_->prev_->next_ = link;
102 4034327 head_->prev_ = link;
103 4034327 size_++;
104 4034327 int retval = pthread_cond_signal(&cond_populated_);
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4033393 times.
 4034317 assert(retval == 0);
106 4034277 return link;
107 4034317 }
108
109 /**
110 * Remove any link from the queue and return its item, including first/last
111 * element.
112 */
113 23 ItemT *Slice(Link *link) {
114 23 MutexLockGuard lock_guard(&lock_);
115 23 return SliceUnlocked(link);
116 23 }
117
118 /**
119 * Remove and return the first element from the queue. Block if tube is
120 * empty.
121 */
122 79963636 ItemT *PopFront() {
123 79963636 MutexLockGuard lock_guard(&lock_);
124
2/2
✓ Branch 0 taken 15183434 times.
✓ Branch 1 taken 45498236 times.
 110371470 while (size_ == 0)
125
1/2
✓ Branch 1 taken 15338233 times.
✗ Branch 2 not taken.
 29881317 pthread_cond_wait(&cond_populated_, &lock_);
126 160111922 return SliceUnlocked(head_->prev_);
127 79568293 }
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 4030955 ItemT *TryPopFront() {
137 4030955 MutexLockGuard lock_guard(&lock_);
138 // Note that we don't need to wait for a signal to arrive
139
2/2
✓ Branch 0 taken 3691965 times.
✓ Branch 1 taken 340400 times.
 4032365 if (size_ == 0)
140 3691965 return NULL;
141 340400 return SliceUnlocked(head_->prev_);
142 4032365 }
143
144 /**
145 * Remove and return the last element from the queue. Block if tube is
146 * empty.
147 */
148 1978 ItemT *PopBack() {
149 1978 MutexLockGuard lock_guard(&lock_);
150
2/2
✓ Branch 0 taken 169 times.
✓ Branch 1 taken 1054 times.
 2316 while (size_ == 0)
151
1/2
✓ Branch 1 taken 169 times.
✗ Branch 2 not taken.
 338 pthread_cond_wait(&cond_populated_, &lock_);
152 3956 return SliceUnlocked(head_->next_);
153 1978 }
154
155 /**
156 * Blocks until the tube is empty
157 */
158 1527 void Wait() {
159 1527 MutexLockGuard lock_guard(&lock_);
160
2/2
✓ Branch 0 taken 268 times.
✓ Branch 1 taken 1527 times.
 1795 while (size_ > 0)
161
1/2
✓ Branch 1 taken 268 times.
✗ Branch 2 not taken.
 268 pthread_cond_wait(&cond_empty_, &lock_);
162 1527 }
163
164 8591 bool IsEmpty() {
165 8591 MutexLockGuard lock_guard(&lock_);
166 17182 return size_ == 0;
167 8591 }
168
169 232 uint64_t size() {
170 232 MutexLockGuard lock_guard(&lock_);
171 464 return size_;
172 232 }
173
174 private:
175 145521 void Init() {
176 145521 Link *sentinel = new Link(NULL);
177 145521 head_ = sentinel;
178 145521 head_->next_ = head_->prev_ = sentinel;
179
180 145521 int retval = pthread_mutex_init(&lock_, NULL);
181
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 75026 times.
 145521 assert(retval == 0);
182 145521 retval = pthread_cond_init(&cond_populated_, NULL);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 75026 times.
 145521 assert(retval == 0);
184 145521 retval = pthread_cond_init(&cond_capacious_, NULL);
185
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 75026 times.
 145521 assert(retval == 0);
186 145521 retval = pthread_cond_init(&cond_empty_, NULL);
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 75026 times.
 145521 assert(retval == 0);
188 145521 }
189
190 80302470 ItemT *SliceUnlocked(Link *link) {
191 // Cannot delete the sentinel link
192
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 45574209 times.
 80302470 assert(link != head_);
193 80302470 link->prev_->next_ = link->next_;
194 80302470 link->next_->prev_ = link->prev_;
195 80302470 ItemT *item = link->item_;
196
2/2
✓ Branch 0 taken 45429475 times.
✓ Branch 1 taken 144734 times.
 80302470 delete link;
197 80829526 size_--;
198 80829526 int retval = pthread_cond_signal(&cond_capacious_);
199
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 45555284 times.
 80264630 assert(retval == 0);
200
2/2
✓ Branch 0 taken 17109242 times.
✓ Branch 1 taken 28446042 times.
 80264630 if (size_ == 0) {
201 33224930 retval = pthread_cond_broadcast(&cond_empty_);
202
2/2
✓ Branch 0 taken 17886 times.
✓ Branch 1 taken 17093464 times.
 33229146 assert(retval == 0);
203 }
204 80233074 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 11722 TubeGroup() : is_active_(false) { atomic_init32(&round_robin_); }
248
249 11711 ~TubeGroup() {
250
2/2
✓ Branch 1 taken 69454 times.
✓ Branch 2 taken 6922 times.
 148239 for (unsigned i = 0; i < tubes_.size(); ++i)
251
1/2
✓ Branch 1 taken 69454 times.
✗ Branch 2 not taken.
 136528 delete tubes_[i];
252 11711 }
253
254 136673 void TakeTube(Tube<ItemT> *t) {
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 69527 times.
 136673 assert(!is_active_);
256 136673 tubes_.push_back(t);
257 136673 }
258
259 11722 void Activate() {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6928 times.
 11722 assert(!is_active_);
261
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 6928 times.
 11722 assert(!tubes_.empty());
262 11722 is_active_ = true;
263 11722 }
264
265 /**
266 * Like Tube::EnqueueBack(), but pick a tube according to ItemT::tag()
267 */
268 30844180 typename Tube<ItemT>::Link *Dispatch(ItemT *item) {
269
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 30844180 times.
 30844180 assert(is_active_);
270
2/2
✓ Branch 1 taken 23702206 times.
✓ Branch 2 taken 7053764 times.
 30844180 unsigned tube_idx = (tubes_.size() == 1) ? 0
271 23702206 : (item->tag() % tubes_.size());
272 30575630 return tubes_[tube_idx]->EnqueueBack(item);
273 }
274
275 /**
276 * Like Tube::EnqueueBack(), use tubes one after another
277 */
278 2502074 typename Tube<ItemT>::Link *DispatchAny(ItemT *item) {
279
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2502074 times.
 2502074 assert(is_active_);
280
2/2
✓ Branch 1 taken 2502048 times.
✓ Branch 2 taken 26 times.
 2502074 unsigned tube_idx = (tubes_.size() == 1)
281 ? 0
282 2502048 : (atomic_xadd32(&round_robin_, 1) % tubes_.size());
283 2502074 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