GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/util/tube.h
Date: 2026-02-22 02:35:58
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 208708983 explicit Link(ItemT *item) : item_(item), next_(NULL), prev_(NULL) { }
46 10 ItemT *item() { return item_; }
47
48 private:
49 ItemT *item_;
50 Link *next_;
51 Link *prev_;
52 };
53
54 170807 Tube() : limit_(uint64_t(-1)), size_(0) { Init(); }
55 1635 explicit Tube(uint64_t limit) : limit_(limit), size_(0) { Init(); }
56 176272 ~Tube() {
57 176400 Link *cursor = head_;
58 do {
59 176409 Link *prev = cursor->prev_;
60
1/2
✓ Branch 0 taken 89234 times.
✗ Branch 1 not taken.
 176409 delete cursor;
61 176409 cursor = prev;
62
2/2
✓ Branch 0 taken 9 times.
✓ Branch 1 taken 89225 times.
 176409 } while (cursor != head_);
63 176400 pthread_cond_destroy(&cond_populated_);
64 176400 pthread_cond_destroy(&cond_capacious_);
65 176400 pthread_cond_destroy(&cond_empty_);
66 176400 pthread_mutex_destroy(&lock_);
67 176400 }
68
69 /**
70 * Push an item to the back of the queue. Block if queue is currently full.
71 */
72 205768598 Link *EnqueueBack(ItemT *item) {
73
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 112001247 times.
 205768598 assert(item != NULL);
74 205768598 MutexLockGuard lock_guard(&lock_);
75
2/2
✓ Branch 0 taken 5202576 times.
✓ Branch 1 taken 111958817 times.
 216082194 while (size_ == limit_)
76
1/2
✓ Branch 1 taken 5214294 times.
✗ Branch 2 not taken.
 10405152 pthread_cond_wait(&cond_capacious_, &lock_);
77
78
1/2
✓ Branch 1 taken 112003071 times.
✗ Branch 2 not taken.
 205677042 Link *link = new Link(item);
79 203479496 link->next_ = head_->next_;
80 203479496 link->prev_ = head_;
81 203479496 head_->next_->prev_ = link;
82 203479496 head_->next_ = link;
83 203479496 size_++;
84 203479496 int retval = pthread_cond_signal(&cond_populated_);
85
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 112237800 times.
 206235008 assert(retval == 0);
86 204924525 return link;
87 206235008 }
88
89 /**
90 * Push an item to the front of the queue. Block if queue currently full.
91 */
92 3631263 Link *EnqueueFront(ItemT *item) {
93
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3630081 times.
 3631263 assert(item != NULL);
94 3631263 MutexLockGuard lock_guard(&lock_);
95
2/2
✓ Branch 0 taken 68 times.
✓ Branch 1 taken 3630036 times.
 3631354 while (size_ == limit_)
96
1/2
✓ Branch 1 taken 68 times.
✗ Branch 2 not taken.
 136 pthread_cond_wait(&cond_capacious_, &lock_);
97
98
1/2
✓ Branch 1 taken 3630036 times.
✗ Branch 2 not taken.
 3631218 Link *link = new Link(item);
99 3631200 link->next_ = head_;
100 3631200 link->prev_ = head_->prev_;
101 3631200 head_->prev_->next_ = link;
102 3631200 head_->prev_ = link;
103 3631200 size_++;
104 3631200 int retval = pthread_cond_signal(&cond_populated_);
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3630036 times.
 3631218 assert(retval == 0);
106 3631236 return link;
107 3631218 }
108
109 /**
110 * Remove any link from the queue and return its item, including first/last
111 * element.
112 */
113 19 ItemT *Slice(Link *link) {
114 19 MutexLockGuard lock_guard(&lock_);
115 19 return SliceUnlocked(link);
116 19 }
117
118 /**
119 * Remove and return the first element from the queue. Block if tube is
120 * empty.
121 */
122 207909108 ItemT *PopFront() {
123 207909108 MutexLockGuard lock_guard(&lock_);
124
2/2
✓ Branch 0 taken 40035227 times.
✓ Branch 1 taken 115400572 times.
 288244354 while (size_ == 0)
125
1/2
✓ Branch 1 taken 40447543 times.
✗ Branch 2 not taken.
 79006222 pthread_cond_wait(&cond_populated_, &lock_);
126 415885771 return SliceUnlocked(head_->prev_);
127 206932120 }
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 3627470 ItemT *TryPopFront() {
137 3627470 MutexLockGuard lock_guard(&lock_);
138 // Note that we don't need to wait for a signal to arrive
139
2/2
✓ Branch 0 taken 3322450 times.
✓ Branch 1 taken 306334 times.
 3628784 if (size_ == 0)
140 3322450 return NULL;
141 306334 return SliceUnlocked(head_->prev_);
142 3628784 }
143
144 /**
145 * Remove and return the last element from the queue. Block if tube is
146 * empty.
147 */
148 2481 ItemT *PopBack() {
149 2481 MutexLockGuard lock_guard(&lock_);
150
2/2
✓ Branch 0 taken 204 times.
✓ Branch 1 taken 1299 times.
 2889 while (size_ == 0)
151
1/2
✓ Branch 1 taken 204 times.
✗ Branch 2 not taken.
 408 pthread_cond_wait(&cond_populated_, &lock_);
152 4962 return SliceUnlocked(head_->next_);
153 2481 }
154
155 /**
156 * Blocks until the tube is empty
157 */
158 1642 void Wait() {
159 1642 MutexLockGuard lock_guard(&lock_);
160
2/2
✓ Branch 0 taken 637 times.
✓ Branch 1 taken 1642 times.
 2279 while (size_ > 0)
161
1/2
✓ Branch 1 taken 637 times.
✗ Branch 2 not taken.
 637 pthread_cond_wait(&cond_empty_, &lock_);
162 1642 }
163
164 7774 bool IsEmpty() {
165 7774 MutexLockGuard lock_guard(&lock_);
166 15548 return size_ == 0;
167 7774 }
168
169 311 uint64_t size() {
170 311 MutexLockGuard lock_guard(&lock_);
171 622 return size_;
172 311 }
173
174 private:
175 173565 void Init() {
176 173565 Link *sentinel = new Link(NULL);
177 173565 head_ = sentinel;
178 173565 head_->next_ = head_->prev_ = sentinel;
179
180 173565 int retval = pthread_mutex_init(&lock_, NULL);
181
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 89301 times.
 173565 assert(retval == 0);
182 173565 retval = pthread_cond_init(&cond_populated_, NULL);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 89301 times.
 173565 assert(retval == 0);
184 173565 retval = pthread_cond_init(&cond_capacious_, NULL);
185
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 89301 times.
 173565 assert(retval == 0);
186 173565 retval = pthread_cond_init(&cond_empty_, NULL);
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 89301 times.
 173565 assert(retval == 0);
188 173565 }
189
190 208278912 ItemT *SliceUnlocked(Link *link) {
191 // Cannot delete the sentinel link
192
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 115073606 times.
 208278912 assert(link != head_);
193 208278912 link->prev_->next_ = link->next_;
194 208278912 link->next_->prev_ = link->prev_;
195 208278912 ItemT *item = link->item_;
196
2/2
✓ Branch 0 taken 114786887 times.
✓ Branch 1 taken 286719 times.
 208278912 delete link;
197 209549581 size_--;
198 209549581 int retval = pthread_cond_signal(&cond_capacious_);
199
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 115003697 times.
 208139094 assert(retval == 0);
200
2/2
✓ Branch 0 taken 45239159 times.
✓ Branch 1 taken 69764538 times.
 208139094 if (size_ == 0) {
201 88768419 retval = pthread_cond_broadcast(&cond_empty_);
202
2/2
✓ Branch 0 taken 15201 times.
✓ Branch 1 taken 45226170 times.
 88772843 assert(retval == 0);
203 }
204 208113116 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 14429 TubeGroup() : is_active_(false) { atomic_init32(&round_robin_); }
248
249 14418 ~TubeGroup() {
250
2/2
✓ Branch 1 taken 82998 times.
✓ Branch 2 taken 8560 times.
 177270 for (unsigned i = 0; i < tubes_.size(); ++i)
251
1/2
✓ Branch 1 taken 82998 times.
✗ Branch 2 not taken.
 162852 delete tubes_[i];
252 14418 }
253
254 162997 void TakeTube(Tube<ItemT> *t) {
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 83071 times.
 162997 assert(!is_active_);
256 162997 tubes_.push_back(t);
257 162997 }
258
259 14429 void Activate() {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8566 times.
 14429 assert(!is_active_);
261
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 8566 times.
 14429 assert(!tubes_.empty());
262 14429 is_active_ = true;
263 14429 }
264
265 /**
266 * Like Tube::EnqueueBack(), but pick a tube according to ItemT::tag()
267 */
268 83081307 typename Tube<ItemT>::Link *Dispatch(ItemT *item) {
269
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 83081307 times.
 83081307 assert(is_active_);
270
2/2
✓ Branch 1 taken 64247772 times.
✓ Branch 2 taken 18819630 times.
 83081307 unsigned tube_idx = (tubes_.size() == 1) ? 0
271 64247772 : (item->tag() % tubes_.size());
272 82739028 return tubes_[tube_idx]->EnqueueBack(item);
273 }
274
275 /**
276 * Like Tube::EnqueueBack(), use tubes one after another
277 */
278 6752188 typename Tube<ItemT>::Link *DispatchAny(ItemT *item) {
279
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6752188 times.
 6752188 assert(is_active_);
280
2/2
✓ Branch 1 taken 6752126 times.
✓ Branch 2 taken 62 times.
 6752188 unsigned tube_idx = (tubes_.size() == 1)
281 ? 0
282 6752126 : (atomic_xadd32(&round_robin_, 1) % tubes_.size());
283 6752188 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