GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/util/tube.h
Date: 2026-01-18 02:35:49
Exec Total Coverage
Lines: 130 130 100.0%
Branches: 49 74 66.2%
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 80557014 explicit Link(ItemT *item) : item_(item), next_(NULL), prev_(NULL) { }
46 7 ItemT *item() { return item_; }
47
48 private:
49 ItemT *item_;
50 Link *next_;
51 Link *prev_;
52 };
53
54 162681 Tube() : limit_(uint64_t(-1)), size_(0) { Init(); }
55 1478 explicit Tube(uint64_t limit) : limit_(limit), size_(0) { Init(); }
56 167705 ~Tube() {
57 167810 Link *cursor = head_;
58 do {
59 167856 Link *prev = cursor->prev_;
60
1/2
✓ Branch 0 taken 85956 times.
✗ Branch 1 not taken.
 167856 delete cursor;
61 167856 cursor = prev;
62
2/2
✓ Branch 0 taken 46 times.
✓ Branch 1 taken 85910 times.
 167856 } while (cursor != head_);
63 167810 pthread_cond_destroy(&cond_populated_);
64 167810 pthread_cond_destroy(&cond_capacious_);
65 167810 pthread_cond_destroy(&cond_empty_);
66 167810 pthread_mutex_destroy(&lock_);
67 167810 }
68
69 /**
70 * Push an item to the back of the queue. Block if queue is currently full.
71 */
72 62134036 Link *EnqueueBack(ItemT *item) {
73
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 34087417 times.
 62134036 assert(item != NULL);
74 62134036 MutexLockGuard lock_guard(&lock_);
75
2/2
✓ Branch 0 taken 1370600 times.
✓ Branch 1 taken 34035272 times.
 64769133 while (size_ == limit_)
76
1/2
✓ Branch 1 taken 1373813 times.
✗ Branch 2 not taken.
 2741200 pthread_cond_wait(&cond_capacious_, &lock_);
77
78
1/2
✓ Branch 1 taken 34059483 times.
✗ Branch 2 not taken.
 62027933 Link *link = new Link(item);
79 61623541 link->next_ = head_->next_;
80 61623541 link->prev_ = head_;
81 61623541 head_->next_->prev_ = link;
82 61623541 head_->next_ = link;
83 61623541 size_++;
84 61623541 int retval = pthread_cond_signal(&cond_populated_);
85
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 34166380 times.
 62290149 assert(retval == 0);
86 62116662 return link;
87 62290149 }
88
89 /**
90 * Push an item to the front of the queue. Block if queue currently full.
91 */
92 18500444 Link *EnqueueFront(ItemT *item) {
93
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 18499719 times.
 18500444 assert(item != NULL);
94 18500444 MutexLockGuard lock_guard(&lock_);
95
2/2
✓ Branch 0 taken 50 times.
✓ Branch 1 taken 18499535 times.
 18500360 while (size_ == limit_)
96
1/2
✓ Branch 1 taken 50 times.
✗ Branch 2 not taken.
 100 pthread_cond_wait(&cond_capacious_, &lock_);
97
98
1/2
✓ Branch 1 taken 18499535 times.
✗ Branch 2 not taken.
 18500260 Link *link = new Link(item);
99 18500306 link->next_ = head_;
100 18500306 link->prev_ = head_->prev_;
101 18500306 head_->prev_->next_ = link;
102 18500306 head_->prev_ = link;
103 18500306 size_++;
104 18500306 int retval = pthread_cond_signal(&cond_populated_);
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 18499535 times.
 18500260 assert(retval == 0);
106 18500352 return link;
107 18500260 }
108
109 /**
110 * Remove any link from the queue and return its item, including first/last
111 * element.
112 */
113 42 ItemT *Slice(Link *link) {
114 42 MutexLockGuard lock_guard(&lock_);
115 42 return SliceUnlocked(link);
116 42 }
117
118 /**
119 * Remove and return the first element from the queue. Block if tube is
120 * empty.
121 */
122 78882488 ItemT *PopFront() {
123 78882488 MutexLockGuard lock_guard(&lock_);
124
2/2
✓ Branch 0 taken 11626865 times.
✓ Branch 1 taken 51055617 times.
 102129391 while (size_ == 0)
125
1/2
✓ Branch 1 taken 11783583 times.
✗ Branch 2 not taken.
 22997016 pthread_cond_wait(&cond_populated_, &lock_);
126 157801162 return SliceUnlocked(head_->prev_);
127 78562219 }
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 18492078 ItemT *TryPopFront() {
137 18492078 MutexLockGuard lock_guard(&lock_);
138 // Note that we don't need to wait for a signal to arrive
139
2/2
✓ Branch 0 taken 16936311 times.
✓ Branch 1 taken 1562207 times.
 18498518 if (size_ == 0)
140 16936311 return NULL;
141 1562207 return SliceUnlocked(head_->prev_);
142 18498518 }
143
144 /**
145 * Remove and return the last element from the queue. Block if tube is
146 * empty.
147 */
148 1905 ItemT *PopBack() {
149 1905 MutexLockGuard lock_guard(&lock_);
150
2/2
✓ Branch 0 taken 100 times.
✓ Branch 1 taken 1180 times.
 2105 while (size_ == 0)
151
1/2
✓ Branch 1 taken 100 times.
✗ Branch 2 not taken.
 200 pthread_cond_wait(&cond_populated_, &lock_);
152 3810 return SliceUnlocked(head_->next_);
153 1905 }
154
155 /**
156 * Blocks until the tube is empty
157 */
158 1784 void Wait() {
159 1784 MutexLockGuard lock_guard(&lock_);
160
2/2
✓ Branch 0 taken 326 times.
✓ Branch 1 taken 1784 times.
 2110 while (size_ > 0)
161
1/2
✓ Branch 1 taken 326 times.
✗ Branch 2 not taken.
 326 pthread_cond_wait(&cond_empty_, &lock_);
162 1784 }
163
164 10298 bool IsEmpty() {
165 10298 MutexLockGuard lock_guard(&lock_);
166 20596 return size_ == 0;
167 10298 }
168
169 513 uint64_t size() {
170 513 MutexLockGuard lock_guard(&lock_);
171 1026 return size_;
172 513 }
173
174 private:
175 165217 void Init() {
176 165217 Link *sentinel = new Link(NULL);
177 165217 head_ = sentinel;
178 165217 head_->next_ = head_->prev_ = sentinel;
179
180 165217 int retval = pthread_mutex_init(&lock_, NULL);
181
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 85986 times.
 165217 assert(retval == 0);
182 165217 retval = pthread_cond_init(&cond_populated_, NULL);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 85986 times.
 165217 assert(retval == 0);
184 165217 retval = pthread_cond_init(&cond_capacious_, NULL);
185
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 85986 times.
 165217 assert(retval == 0);
186 165217 retval = pthread_cond_init(&cond_empty_, NULL);
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 85986 times.
 165217 assert(retval == 0);
188 165217 }
189
190 80362902 ItemT *SliceUnlocked(Link *link) {
191 // Cannot delete the sentinel link
192
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 52451888 times.
 80362902 assert(link != head_);
193 80362902 link->prev_->next_ = link->next_;
194 80362902 link->next_->prev_ = link->prev_;
195 80362902 ItemT *item = link->item_;
196
2/2
✓ Branch 0 taken 52374114 times.
✓ Branch 1 taken 77774 times.
 80362902 delete link;
197 80697062 size_--;
198 80697062 int retval = pthread_cond_signal(&cond_capacious_);
199
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 52402270 times.
 80263702 assert(retval == 0);
200
2/2
✓ Branch 0 taken 13439160 times.
✓ Branch 1 taken 38963110 times.
 80263702 if (size_ == 0) {
201 24939723 retval = pthread_cond_broadcast(&cond_empty_);
202
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 13453328 times.
 24942117 assert(retval == 0);
203 }
204 80292038 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 13692 TubeGroup() : is_active_(false) { atomic_init32(&round_robin_); }
248
249 13681 ~TubeGroup() {
250
2/2
✓ Branch 1 taken 77564 times.
✓ Branch 2 taken 8020 times.
 165939 for (unsigned i = 0; i < tubes_.size(); ++i)
251
1/2
✓ Branch 1 taken 77564 times.
✗ Branch 2 not taken.
 152258 delete tubes_[i];
252 13681 }
253
254 152403 void TakeTube(Tube<ItemT> *t) {
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 77637 times.
 152403 assert(!is_active_);
256 152403 tubes_.push_back(t);
257 152403 }
258
259 13692 void Activate() {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8026 times.
 13692 assert(!is_active_);
261
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 8026 times.
 13692 assert(!tubes_.empty());
262 13692 is_active_ = true;
263 13692 }
264
265 /**
266 * Like Tube::EnqueueBack(), but pick a tube according to ItemT::tag()
267 */
268 23667089 typename Tube<ItemT>::Link *Dispatch(ItemT *item) {
269
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 23667089 times.
 23667089 assert(is_active_);
270
2/2
✓ Branch 1 taken 16695334 times.
✓ Branch 2 taken 6943048 times.
 23667089 unsigned tube_idx = (tubes_.size() == 1) ? 0
271 16695334 : (item->tag() % tubes_.size());
272 23522469 return tubes_[tube_idx]->EnqueueBack(item);
273 }
274
275 /**
276 * Like Tube::EnqueueBack(), use tubes one after another
277 */
278 1752308 typename Tube<ItemT>::Link *DispatchAny(ItemT *item) {
279
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1752308 times.
 1752308 assert(is_active_);
280
2/2
✓ Branch 1 taken 1752214 times.
✓ Branch 2 taken 94 times.
 1752308 unsigned tube_idx = (tubes_.size() == 1)
281 ? 0
282 1752214 : (atomic_xadd32(&round_robin_, 1) % tubes_.size());
283 1752308 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