GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/util/tube.h
Date: 2026-09-13 02:40:16
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 162048381 explicit Link(ItemT *item) : item_(item), next_(NULL), prev_(NULL) { }
46 16 ItemT *item() { return item_; }
47
48 private:
49 ItemT *item_;
50 Link *next_;
51 Link *prev_;
52 };
53
54 125871 Tube() : limit_(uint64_t(-1)), size_(0) { Init(); }
55 942 explicit Tube(uint64_t limit) : limit_(limit), size_(0) { Init(); }
56 129620 ~Tube() {
57 129650 Link *cursor = head_;
58 do {
59 129673 Link *prev = cursor->prev_;
60
1/2
✓ Branch 0 taken 65984 times.
✗ Branch 1 not taken.
 129673 delete cursor;
61 129673 cursor = prev;
62
2/2
✓ Branch 0 taken 23 times.
✓ Branch 1 taken 65961 times.
 129673 } while (cursor != head_);
63 129650 pthread_cond_destroy(&cond_populated_);
64 129650 pthread_cond_destroy(&cond_capacious_);
65 129650 pthread_cond_destroy(&cond_empty_);
66 129650 pthread_mutex_destroy(&lock_);
67 129650 }
68
69 /**
70 * Push an item to the back of the queue. Block if queue is currently full.
71 */
72 152689534 Link *EnqueueBack(ItemT *item) {
73
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 82989448 times.
 152689534 assert(item != NULL);
74 152689534 MutexLockGuard lock_guard(&lock_);
75
2/2
✓ Branch 0 taken 4473740 times.
✓ Branch 1 taken 82990396 times.
 161638110 while (size_ == limit_)
76
1/2
✓ Branch 1 taken 4472940 times.
✗ Branch 2 not taken.
 8947480 pthread_cond_wait(&cond_capacious_, &lock_);
77
78
1/2
✓ Branch 1 taken 83002964 times.
✗ Branch 2 not taken.
 152690630 Link *link = new Link(item);
79 152566582 link->next_ = head_->next_;
80 152566582 link->prev_ = head_;
81 152566582 head_->next_->prev_ = link;
82 152566582 head_->next_ = link;
83 152566582 size_++;
84 152566582 int retval = pthread_cond_signal(&cond_populated_);
85
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 83015700 times.
 152741238 assert(retval == 0);
86 152747566 return link;
87 152741238 }
88
89 /**
90 * Push an item to the front of the queue. Block if queue currently full.
91 */
92 9252099 Link *EnqueueFront(ItemT *item) {
93
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9252007 times.
 9252099 assert(item != NULL);
94 9252099 MutexLockGuard lock_guard(&lock_);
95
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 9252053 times.
 9252147 while (size_ == limit_)
96
1/2
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
 2 pthread_cond_wait(&cond_capacious_, &lock_);
97
98
1/2
✓ Branch 1 taken 9252053 times.
✗ Branch 2 not taken.
 9252145 Link *link = new Link(item);
99 9252007 link->next_ = head_;
100 9252007 link->prev_ = head_->prev_;
101 9252007 head_->prev_->next_ = link;
102 9252007 head_->prev_ = link;
103 9252007 size_++;
104 9252007 int retval = pthread_cond_signal(&cond_populated_);
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9251915 times.
 9252007 assert(retval == 0);
106 9252099 return link;
107 9252007 }
108
109 /**
110 * Remove any link from the queue and return its item, including first/last
111 * element.
112 */
113 20 ItemT *Slice(Link *link) {
114 20 MutexLockGuard lock_guard(&lock_);
115 20 return SliceUnlocked(link);
116 20 }
117
118 /**
119 * Remove and return the first element from the queue. Block if tube is
120 * empty.
121 */
122 161182380 ItemT *PopFront() {
123 161182380 MutexLockGuard lock_guard(&lock_);
124
2/2
✓ Branch 0 taken 35053749 times.
✓ Branch 1 taken 91501825 times.
 225377672 while (size_ == 0)
125
1/2
✓ Branch 1 taken 35055045 times.
✗ Branch 2 not taken.
 64134734 pthread_cond_wait(&cond_populated_, &lock_);
126 322479259 return SliceUnlocked(head_->prev_);
127 161160796 }
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 9247521 ItemT *TryPopFront() {
137 9247521 MutexLockGuard lock_guard(&lock_);
138 // Note that we don't need to wait for a signal to arrive
139
2/2
✓ Branch 0 taken 8470632 times.
✓ Branch 1 taken 781305 times.
 9251937 if (size_ == 0)
140 8470632 return NULL;
141 781305 return SliceUnlocked(head_->prev_);
142 9251937 }
143
144 /**
145 * Remove and return the last element from the queue. Block if tube is
146 * empty.
147 */
148 236 ItemT *PopBack() {
149 236 MutexLockGuard lock_guard(&lock_);
150
2/2
✓ Branch 0 taken 26 times.
✓ Branch 1 taken 144 times.
 288 while (size_ == 0)
151
1/2
✓ Branch 1 taken 26 times.
✗ Branch 2 not taken.
 52 pthread_cond_wait(&cond_populated_, &lock_);
152 472 return SliceUnlocked(head_->next_);
153 236 }
154
155 /**
156 * Blocks until the tube is empty
157 */
158 1189 void Wait() {
159 1189 MutexLockGuard lock_guard(&lock_);
160
2/2
✓ Branch 0 taken 492 times.
✓ Branch 1 taken 1189 times.
 1681 while (size_ > 0)
161
1/2
✓ Branch 1 taken 492 times.
✗ Branch 2 not taken.
 492 pthread_cond_wait(&cond_empty_, &lock_);
162 1189 }
163
164 6275 bool IsEmpty() {
165 6275 MutexLockGuard lock_guard(&lock_);
166 12550 return size_ == 0;
167 6275 }
168
169 244 uint64_t size() {
170 244 MutexLockGuard lock_guard(&lock_);
171 488 return size_;
172 244 }
173
174 private:
175 127635 void Init() {
176 127635 Link *sentinel = new Link(NULL);
177 127635 head_ = sentinel;
178 127635 head_->next_ = head_->prev_ = sentinel;
179
180 127635 int retval = pthread_mutex_init(&lock_, NULL);
181
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 66037 times.
 127635 assert(retval == 0);
182 127635 retval = pthread_cond_init(&cond_populated_, NULL);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 66037 times.
 127635 assert(retval == 0);
184 127635 retval = pthread_cond_init(&cond_capacious_, NULL);
185
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 66037 times.
 127635 assert(retval == 0);
186 127635 retval = pthread_cond_init(&cond_empty_, NULL);
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 66037 times.
 127635 assert(retval == 0);
188 127635 }
189
190 161978494 ItemT *SliceUnlocked(Link *link) {
191 // Cannot delete the sentinel link
192
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 92260234 times.
 161978494 assert(link != head_);
193 161978494 link->prev_->next_ = link->next_;
194 161978494 link->next_->prev_ = link->prev_;
195 161978494 ItemT *item = link->item_;
196
2/2
✓ Branch 0 taken 92171294 times.
✓ Branch 1 taken 88940 times.
 161978494 delete link;
197 162130823 size_--;
198 162130823 int retval = pthread_cond_signal(&cond_capacious_);
199
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 92293474 times.
 162044917 assert(retval == 0);
200
2/2
✓ Branch 0 taken 35927426 times.
✓ Branch 1 taken 56366048 times.
 162044917 if (size_ == 0) {
201 64857814 retval = pthread_cond_broadcast(&cond_empty_);
202
2/2
✓ Branch 0 taken 21491 times.
✓ Branch 1 taken 35905478 times.
 64856900 assert(retval == 0);
203 }
204 162001021 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 10263 TubeGroup() : is_active_(false) { atomic_init32(&round_robin_); }
248
249 10252 ~TubeGroup() {
250
2/2
✓ Branch 1 taken 60876 times.
✓ Branch 2 taken 6019 times.
 129760 for (unsigned i = 0; i < tubes_.size(); ++i)
251
1/2
✓ Branch 1 taken 60876 times.
✗ Branch 2 not taken.
 119508 delete tubes_[i];
252 10252 }
253
254 119653 void TakeTube(Tube<ItemT> *t) {
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 60949 times.
 119653 assert(!is_active_);
256 119653 tubes_.push_back(t);
257 119653 }
258
259 10263 void Activate() {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6025 times.
 10263 assert(!is_active_);
261
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 6025 times.
 10263 assert(!tubes_.empty());
262 10263 is_active_ = true;
263 10263 }
264
265 /**
266 * Like Tube::EnqueueBack(), but pick a tube according to ItemT::tag()
267 */
268 61738940 typename Tube<ItemT>::Link *Dispatch(ItemT *item) {
269
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 61738940 times.
 61738940 assert(is_active_);
270
2/2
✓ Branch 1 taken 48149464 times.
✓ Branch 2 taken 13577336 times.
 61738940 unsigned tube_idx = (tubes_.size() == 1) ? 0
271 48149464 : (item->tag() % tubes_.size());
272 61702640 return tubes_[tube_idx]->EnqueueBack(item);
273 }
274
275 /**
276 * Like Tube::EnqueueBack(), use tubes one after another
277 */
278 5001725 typename Tube<ItemT>::Link *DispatchAny(ItemT *item) {
279
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5001725 times.
 5001725 assert(is_active_);
280
2/2
✓ Branch 1 taken 5001693 times.
✓ Branch 2 taken 32 times.
 5001725 unsigned tube_idx = (tubes_.size() == 1)
281 ? 0
282 5001693 : (atomic_xadd32(&round_robin_, 1) % tubes_.size());
283 5001725 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