GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/util/tube.h
Date: 2026-08-30 02:40:36
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 332624088 explicit Link(ItemT *item) : item_(item), next_(NULL), prev_(NULL) { }
46 2 ItemT *item() { return item_; }
47
48 private:
49 ItemT *item_;
50 Link *next_;
51 Link *prev_;
52 };
53
54 303927 Tube() : limit_(uint64_t(-1)), size_(0) { Init(); }
55 3551 explicit Tube(uint64_t limit) : limit_(limit), size_(0) { Init(); }
56 313460 ~Tube() {
57 313847 Link *cursor = head_;
58 do {
59 313854 Link *prev = cursor->prev_;
60
1/2
✓ Branch 0 taken 158455 times.
✗ Branch 1 not taken.
 313854 delete cursor;
61 313854 cursor = prev;
62
2/2
✓ Branch 0 taken 7 times.
✓ Branch 1 taken 158448 times.
 313854 } while (cursor != head_);
63 313847 pthread_cond_destroy(&cond_populated_);
64 313847 pthread_cond_destroy(&cond_capacious_);
65 313847 pthread_cond_destroy(&cond_empty_);
66 313847 pthread_mutex_destroy(&lock_);
67 313847 }
68
69 /**
70 * Push an item to the back of the queue. Block if queue is currently full.
71 */
72 329469627 Link *EnqueueBack(ItemT *item) {
73
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 178874883 times.
 329469627 assert(item != NULL);
74 329469627 MutexLockGuard lock_guard(&lock_);
75
2/2
✓ Branch 0 taken 9835012 times.
✓ Branch 1 taken 178890459 times.
 349169483 while (size_ == limit_)
76
1/2
✓ Branch 1 taken 9831580 times.
✗ Branch 2 not taken.
 19670024 pthread_cond_wait(&cond_capacious_, &lock_);
77
78
1/2
✓ Branch 1 taken 178936789 times.
✗ Branch 2 not taken.
 329499459 Link *link = new Link(item);
79 329169691 link->next_ = head_->next_;
80 329169691 link->prev_ = head_;
81 329169691 head_->next_->prev_ = link;
82 329169691 head_->next_ = link;
83 329169691 size_++;
84 329169691 int retval = pthread_cond_signal(&cond_populated_);
85
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 178942821 times.
 329604183 assert(retval == 0);
86 329654511 return link;
87 329604183 }
88
89 /**
90 * Push an item to the front of the queue. Block if queue currently full.
91 */
92 2839848 Link *EnqueueFront(ItemT *item) {
93
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2836423 times.
 2839848 assert(item != NULL);
94 2839848 MutexLockGuard lock_guard(&lock_);
95
2/2
✓ Branch 0 taken 147 times.
✓ Branch 1 taken 2836430 times.
 2840149 while (size_ == limit_)
96
1/2
✓ Branch 1 taken 147 times.
✗ Branch 2 not taken.
 294 pthread_cond_wait(&cond_capacious_, &lock_);
97
98
1/2
✓ Branch 1 taken 2836423 times.
✗ Branch 2 not taken.
 2839855 Link *link = new Link(item);
99 2839848 link->next_ = head_;
100 2839848 link->prev_ = head_->prev_;
101 2839848 head_->prev_->next_ = link;
102 2839848 head_->prev_ = link;
103 2839848 size_++;
104 2839848 int retval = pthread_cond_signal(&cond_populated_);
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2836409 times.
 2839834 assert(retval == 0);
106 2839841 return link;
107 2839834 }
108
109 /**
110 * Remove any link from the queue and return its item, including first/last
111 * element.
112 */
113 3 ItemT *Slice(Link *link) {
114 3 MutexLockGuard lock_guard(&lock_);
115 3 return SliceUnlocked(link);
116 3 }
117
118 /**
119 * Remove and return the first element from the queue. Block if tube is
120 * empty.
121 */
122 332187876 ItemT *PopFront() {
123 332187876 MutexLockGuard lock_guard(&lock_);
124
2/2
✓ Branch 0 taken 76203548 times.
✓ Branch 1 taken 181599516 times.
 471554918 while (size_ == 0)
125
1/2
✓ Branch 1 taken 76203577 times.
✗ Branch 2 not taken.
 139231270 pthread_cond_wait(&cond_populated_, &lock_);
126 664660624 return SliceUnlocked(head_->prev_);
127 332131606 }
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 2832239 ItemT *TryPopFront() {
137 2832239 MutexLockGuard lock_guard(&lock_);
138 // Note that we don't need to wait for a signal to arrive
139
2/2
✓ Branch 0 taken 2593978 times.
✓ Branch 1 taken 239010 times.
 2832988 if (size_ == 0)
140 2593978 return NULL;
141 239010 return SliceUnlocked(head_->prev_);
142 2832988 }
143
144 /**
145 * Remove and return the last element from the queue. Block if tube is
146 * empty.
147 */
148 6863 ItemT *PopBack() {
149 6863 MutexLockGuard lock_guard(&lock_);
150
2/2
✓ Branch 0 taken 490 times.
✓ Branch 1 taken 3438 times.
 7843 while (size_ == 0)
151
1/2
✓ Branch 1 taken 490 times.
✗ Branch 2 not taken.
 980 pthread_cond_wait(&cond_populated_, &lock_);
152 13726 return SliceUnlocked(head_->next_);
153 6863 }
154
155 /**
156 * Blocks until the tube is empty
157 */
158 3021 void Wait() {
159 3021 MutexLockGuard lock_guard(&lock_);
160
2/2
✓ Branch 0 taken 854 times.
✓ Branch 1 taken 3021 times.
 3875 while (size_ > 0)
161
1/2
✓ Branch 1 taken 854 times.
✗ Branch 2 not taken.
 854 pthread_cond_wait(&cond_empty_, &lock_);
162 3021 }
163
164 13235 bool IsEmpty() {
165 13235 MutexLockGuard lock_guard(&lock_);
166 26470 return size_ == 0;
167 13235 }
168
169 57 uint64_t size() {
170 57 MutexLockGuard lock_guard(&lock_);
171 114 return size_;
172 57 }
173
174 private:
175 309481 void Init() {
176 309481 Link *sentinel = new Link(NULL);
177 309481 head_ = sentinel;
178 309481 head_->next_ = head_->prev_ = sentinel;
179
180 309481 int retval = pthread_mutex_init(&lock_, NULL);
181
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 158524 times.
 309481 assert(retval == 0);
182 309481 retval = pthread_cond_init(&cond_populated_, NULL);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 158524 times.
 309481 assert(retval == 0);
184 309481 retval = pthread_cond_init(&cond_capacious_, NULL);
185
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 158524 times.
 309481 assert(retval == 0);
186 309481 retval = pthread_cond_init(&cond_empty_, NULL);
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 158524 times.
 309481 assert(retval == 0);
188 309481 }
189
190 332443833 ItemT *SliceUnlocked(Link *link) {
191 // Cannot delete the sentinel link
192
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 181777409 times.
 332443833 assert(link != head_);
193 332443833 link->prev_->next_ = link->next_;
194 332443833 link->next_->prev_ = link->prev_;
195 332443833 ItemT *item = link->item_;
196
2/2
✓ Branch 0 taken 181583685 times.
✓ Branch 1 taken 193724 times.
 332443833 delete link;
197 332780802 size_--;
198 332780802 int retval = pthread_cond_signal(&cond_capacious_);
199
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 181862523 times.
 332614014 assert(retval == 0);
200
2/2
✓ Branch 0 taken 77389883 times.
✓ Branch 1 taken 104472640 times.
 332614014 if (size_ == 0) {
201 140897308 retval = pthread_cond_broadcast(&cond_empty_);
202
2/2
✓ Branch 0 taken 43547 times.
✓ Branch 1 taken 77343767 times.
 140892170 assert(retval == 0);
203 }
204 332521829 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 24034 TubeGroup() : is_active_(false) { atomic_init32(&round_robin_); }
248
249 24023 ~TubeGroup() {
250
2/2
✓ Branch 1 taken 148874 times.
✓ Branch 2 taken 13965 times.
 316861 for (unsigned i = 0; i < tubes_.size(); ++i)
251
1/2
✓ Branch 1 taken 148874 times.
✗ Branch 2 not taken.
 292838 delete tubes_[i];
252 24023 }
253
254 292983 void TakeTube(Tube<ItemT> *t) {
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 148947 times.
 292983 assert(!is_active_);
256 292983 tubes_.push_back(t);
257 292983 }
258
259 24034 void Activate() {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 13971 times.
 24034 assert(!is_active_);
261
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 13971 times.
 24034 assert(!tubes_.empty());
262 24034 is_active_ = true;
263 24034 }
264
265 /**
266 * Like Tube::EnqueueBack(), but pick a tube according to ItemT::tag()
267 */
268 134250797 typename Tube<ItemT>::Link *Dispatch(ItemT *item) {
269
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 134250797 times.
 134250797 assert(is_active_);
270
2/2
✓ Branch 1 taken 105882629 times.
✓ Branch 2 taken 28325928 times.
 134250797 unsigned tube_idx = (tubes_.size() == 1) ? 0
271 105882629 : (item->tag() % tubes_.size());
272 134142689 return tubes_[tube_idx]->EnqueueBack(item);
273 }
274
275 /**
276 * Like Tube::EnqueueBack(), use tubes one after another
277 */
278 11003609 typename Tube<ItemT>::Link *DispatchAny(ItemT *item) {
279
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 11003609 times.
 11003609 assert(is_active_);
280
2/2
✓ Branch 1 taken 11003597 times.
✓ Branch 2 taken 12 times.
 11003609 unsigned tube_idx = (tubes_.size() == 1)
281 ? 0
282 11003597 : (atomic_xadd32(&round_robin_, 1) % tubes_.size());
283 11003609 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