GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/util/tube.h
Date: 2025-09-14 02:35:40
Exec Total Coverage
Lines: 129 130 99.2%
Branches: 47 74 63.5%
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 342544046 explicit Link(ItemT *item) : item_(item), next_(NULL), prev_(NULL) { }
46 3 ItemT *item() { return item_; }
47
48 private:
49 ItemT *item_;
50 Link *next_;
51 Link *prev_;
52 };
53
54 266044 Tube() : limit_(uint64_t(-1)), size_(0) { Init(); }
55 2926 explicit Tube(uint64_t limit) : limit_(limit), size_(0) { Init(); }
56 275299 ~Tube() {
57 275593 Link *cursor = head_;
58 do {
59 275596 Link *prev = cursor->prev_;
60
1/2
✓ Branch 0 taken 138921 times.
✗ Branch 1 not taken.
 275596 delete cursor;
61 275596 cursor = prev;
62
2/2
✓ Branch 0 taken 3 times.
✓ Branch 1 taken 138918 times.
 275596 } while (cursor != head_);
63 275593 pthread_cond_destroy(&cond_populated_);
64 275593 pthread_cond_destroy(&cond_capacious_);
65 275593 pthread_cond_destroy(&cond_empty_);
66 275593 pthread_mutex_destroy(&lock_);
67 275593 }
68
69 /**
70 * Push an item to the back of the queue. Block if queue is currently full.
71 */
72 341263803 Link *EnqueueBack(ItemT *item) {
73
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 185572893 times.
 341263803 assert(item != NULL);
74 341263803 MutexLockGuard lock_guard(&lock_);
75
2/2
✓ Branch 0 taken 8399784 times.
✓ Branch 1 taken 186135893 times.
 359180723 while (size_ == limit_)
76
1/2
✓ Branch 1 taken 8421864 times.
✗ Branch 2 not taken.
 16799568 pthread_cond_wait(&cond_capacious_, &lock_);
77
78
1/2
✓ Branch 1 taken 186218905 times.
✗ Branch 2 not taken.
 342381155 Link *link = new Link(item);
79 338868651 link->next_ = head_->next_;
80 338868651 link->prev_ = head_;
81 338868651 head_->next_->prev_ = link;
82 338868651 head_->next_ = link;
83 338868651 size_++;
84 338868651 int retval = pthread_cond_signal(&cond_populated_);
85
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 186479841 times.
 343069051 assert(retval == 0);
86 341338675 return link;
87 343069051 }
88
89 /**
90 * Push an item to the front of the queue. Block if queue currently full.
91 */
92 1225594 Link *EnqueueFront(ItemT *item) {
93
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1223006 times.
 1225594 assert(item != NULL);
94 1225594 MutexLockGuard lock_guard(&lock_);
95
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1223006 times.
 1225594 while (size_ == limit_)
96 ✗ pthread_cond_wait(&cond_capacious_, &lock_);
97
98
1/2
✓ Branch 1 taken 1223006 times.
✗ Branch 2 not taken.
 1225594 Link *link = new Link(item);
99 1225582 link->next_ = head_;
100 1225582 link->prev_ = head_->prev_;
101 1225582 head_->prev_->next_ = link;
102 1225582 head_->prev_ = link;
103 1225582 size_++;
104 1225582 int retval = pthread_cond_signal(&cond_populated_);
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1222988 times.
 1225576 assert(retval == 0);
106 1225591 return link;
107 1225576 }
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 341751225 ItemT *PopFront() {
123 341751225 MutexLockGuard lock_guard(&lock_);
124
2/2
✓ Branch 0 taken 66969241 times.
✓ Branch 1 taken 187543941 times.
 476210609 while (size_ == 0)
125
1/2
✓ Branch 1 taken 67706124 times.
✗ Branch 2 not taken.
 132130688 pthread_cond_wait(&cond_populated_, &lock_);
126 684301659 return SliceUnlocked(head_->prev_);
127 341425643 }
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 1219906 ItemT *TryPopFront() {
137 1219906 MutexLockGuard lock_guard(&lock_);
138 // Note that we don't need to wait for a signal to arrive
139
2/2
✓ Branch 0 taken 1117339 times.
✓ Branch 1 taken 102867 times.
 1220206 if (size_ == 0)
140 1117339 return NULL;
141 102867 return SliceUnlocked(head_->prev_);
142 1220206 }
143
144 /**
145 * Remove and return the last element from the queue. Block if tube is
146 * empty.
147 */
148 5384 ItemT *PopBack() {
149 5384 MutexLockGuard lock_guard(&lock_);
150
2/2
✓ Branch 0 taken 592 times.
✓ Branch 1 taken 2796 times.
 6568 while (size_ == 0)
151
1/2
✓ Branch 1 taken 592 times.
✗ Branch 2 not taken.
 1184 pthread_cond_wait(&cond_populated_, &lock_);
152 10768 return SliceUnlocked(head_->next_);
153 5384 }
154
155 /**
156 * Blocks until the tube is empty
157 */
158 2560 void Wait() {
159 2560 MutexLockGuard lock_guard(&lock_);
160
2/2
✓ Branch 0 taken 1035 times.
✓ Branch 1 taken 2560 times.
 3595 while (size_ > 0)
161
1/2
✓ Branch 1 taken 1035 times.
✗ Branch 2 not taken.
 1035 pthread_cond_wait(&cond_empty_, &lock_);
162 2560 }
163
164 9800 bool IsEmpty() {
165 9800 MutexLockGuard lock_guard(&lock_);
166 19600 return size_ == 0;
167 9800 }
168
169 200 uint64_t size() {
170 200 MutexLockGuard lock_guard(&lock_);
171 400 return size_;
172 200 }
173
174 private:
175 270720 void Init() {
176 270720 Link *sentinel = new Link(NULL);
177 270720 head_ = sentinel;
178 270720 head_->next_ = head_->prev_ = sentinel;
179
180 270720 int retval = pthread_mutex_init(&lock_, NULL);
181
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 138994 times.
 270720 assert(retval == 0);
182 270720 retval = pthread_cond_init(&cond_populated_, NULL);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 138994 times.
 270720 assert(retval == 0);
184 270720 retval = pthread_cond_init(&cond_capacious_, NULL);
185
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 138994 times.
 270720 assert(retval == 0);
186 270720 retval = pthread_cond_init(&cond_empty_, NULL);
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 138994 times.
 270720 assert(retval == 0);
188 270720 }
189
190 341629751 ItemT *SliceUnlocked(Link *link) {
191 // Cannot delete the sentinel link
192
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 186369109 times.
 341629751 assert(link != head_);
193 341629751 link->prev_->next_ = link->next_;
194 341629751 link->next_->prev_ = link->prev_;
195 341629751 ItemT *item = link->item_;
196
2/2
✓ Branch 0 taken 186349950 times.
✓ Branch 1 taken 19159 times.
 341629751 delete link;
197 343402938 size_--;
198 343402938 int retval = pthread_cond_signal(&cond_capacious_);
199
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 187055976 times.
 343003525 assert(retval == 0);
200
2/2
✓ Branch 0 taken 74924054 times.
✓ Branch 1 taken 112131922 times.
 343003525 if (size_ == 0) {
201 147262870 retval = pthread_cond_broadcast(&cond_empty_);
202
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 75344558 times.
 147229718 assert(retval == 0);
203 }
204 343844581 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 22061 TubeGroup() : is_active_(false) { atomic_init32(&round_robin_); }
248
249 22050 ~TubeGroup() {
250
2/2
✓ Branch 1 taken 130775 times.
✓ Branch 2 taken 13177 times.
 278273 for (unsigned i = 0; i < tubes_.size(); ++i)
251
1/2
✓ Branch 1 taken 130775 times.
✗ Branch 2 not taken.
 256223 delete tubes_[i];
252 22050 }
253
254 256368 void TakeTube(Tube<ItemT> *t) {
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 130848 times.
 256368 assert(!is_active_);
256 256368 tubes_.push_back(t);
257 256368 }
258
259 22061 void Activate() {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 13183 times.
 22061 assert(!is_active_);
261
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 13183 times.
 22061 assert(!tubes_.empty());
262 22061 is_active_ = true;
263 22061 }
264
265 /**
266 * Like Tube::EnqueueBack(), but pick a tube according to ItemT::tag()
267 */
268 139747987 typename Tube<ItemT>::Link *Dispatch(ItemT *item) {
269
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 139747987 times.
 139747987 assert(is_active_);
270
2/2
✓ Branch 1 taken 109420417 times.
✓ Branch 2 taken 30120616 times.
 139747987 unsigned tube_idx = (tubes_.size() == 1) ? 0
271 109420417 : (item->tag() % tubes_.size());
272 138481055 return tubes_[tube_idx]->EnqueueBack(item);
273 }
274
275 /**
276 * Like Tube::EnqueueBack(), use tubes one after another
277 */
278 11503573 typename Tube<ItemT>::Link *DispatchAny(ItemT *item) {
279
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 11503573 times.
 11503573 assert(is_active_);
280
2/2
✓ Branch 1 taken 11503541 times.
✓ Branch 2 taken 32 times.
 11503573 unsigned tube_idx = (tubes_.size() == 1)
281 ? 0
282 11503541 : (atomic_xadd32(&round_robin_, 1) % tubes_.size());
283 11503573 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