GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/util/tube.h
Date: 2026-03-01 02:36:14
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 31015591 explicit Link(ItemT *item) : item_(item), next_(NULL), prev_(NULL) { }
46 40 ItemT *item() { return item_; }
47
48 private:
49 ItemT *item_;
50 Link *next_;
51 Link *prev_;
52 };
53
54 147934 Tube() : limit_(uint64_t(-1)), size_(0) { Init(); }
55 2234 explicit Tube(uint64_t limit) : limit_(limit), size_(0) { Init(); }
56 153250 ~Tube() {
57 153569 Link *cursor = head_;
58 do {
59 153605 Link *prev = cursor->prev_;
60
1/2
✓ Branch 0 taken 78878 times.
✗ Branch 1 not taken.
 153605 delete cursor;
61 153605 cursor = prev;
62
2/2
✓ Branch 0 taken 36 times.
✓ Branch 1 taken 78842 times.
 153605 } while (cursor != head_);
63 153569 pthread_cond_destroy(&cond_populated_);
64 153569 pthread_cond_destroy(&cond_capacious_);
65 153569 pthread_cond_destroy(&cond_empty_);
66 153569 pthread_mutex_destroy(&lock_);
67 153569 }
68
69 /**
70 * Push an item to the back of the queue. Block if queue is currently full.
71 */
72 16428066 Link *EnqueueBack(ItemT *item) {
73
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9201717 times.
 16428066 assert(item != NULL);
74 16428066 MutexLockGuard lock_guard(&lock_);
75
2/2
✓ Branch 0 taken 183916 times.
✓ Branch 1 taken 9181276 times.
 16754850 while (size_ == limit_)
76
1/2
✓ Branch 1 taken 183685 times.
✗ Branch 2 not taken.
 367832 pthread_cond_wait(&cond_capacious_, &lock_);
77
78
1/2
✓ Branch 1 taken 9190225 times.
✗ Branch 2 not taken.
 16387018 Link *link = new Link(item);
79 16339698 link->next_ = head_->next_;
80 16339698 link->prev_ = head_;
81 16339698 head_->next_->prev_ = link;
82 16339698 head_->next_ = link;
83 16339698 size_++;
84 16339698 int retval = pthread_cond_signal(&cond_populated_);
85
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9212283 times.
 16449032 assert(retval == 0);
86 16408670 return link;
87 16449032 }
88
89 /**
90 * Push an item to the front of the queue. Block if queue currently full.
91 */
92 14487855 Link *EnqueueFront(ItemT *item) {
93
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 14484870 times.
 14487855 assert(item != NULL);
94 14487855 MutexLockGuard lock_guard(&lock_);
95
2/2
✓ Branch 0 taken 129 times.
✓ Branch 1 taken 14484834 times.
 14488077 while (size_ == limit_)
96
1/2
✓ Branch 1 taken 129 times.
✗ Branch 2 not taken.
 258 pthread_cond_wait(&cond_capacious_, &lock_);
97
98
1/2
✓ Branch 1 taken 14484834 times.
✗ Branch 2 not taken.
 14487819 Link *link = new Link(item);
99 14487711 link->next_ = head_;
100 14487711 link->prev_ = head_->prev_;
101 14487711 head_->prev_->next_ = link;
102 14487711 head_->prev_ = link;
103 14487711 size_++;
104 14487711 int retval = pthread_cond_signal(&cond_populated_);
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 14484726 times.
 14487711 assert(retval == 0);
106 14487747 return link;
107 14487711 }
108
109 /**
110 * Remove any link from the queue and return its item, including first/last
111 * element.
112 */
113 80 ItemT *Slice(Link *link) {
114 80 MutexLockGuard lock_guard(&lock_);
115 80 return SliceUnlocked(link);
116 80 }
117
118 /**
119 * Remove and return the first element from the queue. Block if tube is
120 * empty.
121 */
122 29643997 ItemT *PopFront() {
123 29643997 MutexLockGuard lock_guard(&lock_);
124
2/2
✓ Branch 0 taken 2833669 times.
✓ Branch 1 taken 22452327 times.
 35284880 while (size_ == 0)
125
1/2
✓ Branch 1 taken 2836340 times.
✗ Branch 2 not taken.
 5614112 pthread_cond_wait(&cond_populated_, &lock_);
126 59239336 return SliceUnlocked(head_->prev_);
127 29636458 }
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 14475501 ItemT *TryPopFront() {
137 14475501 MutexLockGuard lock_guard(&lock_);
138 // Note that we don't need to wait for a signal to arrive
139
2/2
✓ Branch 0 taken 13258472 times.
✓ Branch 1 taken 1222933 times.
 14481405 if (size_ == 0)
140 13258472 return NULL;
141 1222933 return SliceUnlocked(head_->prev_);
142 14481405 }
143
144 /**
145 * Remove and return the last element from the queue. Block if tube is
146 * empty.
147 */
148 6490 ItemT *PopBack() {
149 6490 MutexLockGuard lock_guard(&lock_);
150
2/2
✓ Branch 0 taken 817 times.
✓ Branch 1 taken 3505 times.
 8124 while (size_ == 0)
151
1/2
✓ Branch 1 taken 817 times.
✗ Branch 2 not taken.
 1634 pthread_cond_wait(&cond_populated_, &lock_);
152 12980 return SliceUnlocked(head_->next_);
153 6490 }
154
155 /**
156 * Blocks until the tube is empty
157 */
158 1747 void Wait() {
159 1747 MutexLockGuard lock_guard(&lock_);
160
2/2
✓ Branch 0 taken 268 times.
✓ Branch 1 taken 1747 times.
 2015 while (size_ > 0)
161
1/2
✓ Branch 1 taken 268 times.
✗ Branch 2 not taken.
 268 pthread_cond_wait(&cond_empty_, &lock_);
162 1747 }
163
164 12091 bool IsEmpty() {
165 12091 MutexLockGuard lock_guard(&lock_);
166 24182 return size_ == 0;
167 12091 }
168
169 760 uint64_t size() {
170 760 MutexLockGuard lock_guard(&lock_);
171 1520 return size_;
172 760 }
173
174 private:
175 151126 void Init() {
176 151126 Link *sentinel = new Link(NULL);
177 151126 head_ = sentinel;
178 151126 head_->next_ = head_->prev_ = sentinel;
179
180 151126 int retval = pthread_mutex_init(&lock_, NULL);
181
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 78918 times.
 151126 assert(retval == 0);
182 151126 retval = pthread_cond_init(&cond_populated_, NULL);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 78918 times.
 151126 assert(retval == 0);
184 151126 retval = pthread_cond_init(&cond_capacious_, NULL);
185
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 78918 times.
 151126 assert(retval == 0);
186 151126 retval = pthread_cond_init(&cond_empty_, NULL);
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 78918 times.
 151126 assert(retval == 0);
188 151126 }
189
190 30862262 ItemT *SliceUnlocked(Link *link) {
191 // Cannot delete the sentinel link
192
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 23658348 times.
 30862262 assert(link != head_);
193 30862262 link->prev_->next_ = link->next_;
194 30862262 link->next_->prev_ = link->prev_;
195 30862262 ItemT *item = link->item_;
196
2/2
✓ Branch 0 taken 23646009 times.
✓ Branch 1 taken 12339 times.
 30862262 delete link;
197 30953578 size_--;
198 30953578 int retval = pthread_cond_signal(&cond_capacious_);
199
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 23690712 times.
 30926990 assert(retval == 0);
200
2/2
✓ Branch 0 taken 3679807 times.
✓ Branch 1 taken 20010905 times.
 30926990 if (size_ == 0) {
201 6061960 retval = pthread_cond_broadcast(&cond_empty_);
202
2/2
✓ Branch 0 taken 21390 times.
✓ Branch 1 taken 3658739 times.
 6062604 assert(retval == 0);
203 }
204 30884892 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 12962 TubeGroup() : is_active_(false) { atomic_init32(&round_robin_); }
248
249 12951 ~TubeGroup() {
250
2/2
✓ Branch 1 taken 70737 times.
✓ Branch 2 taken 7846 times.
 151392 for (unsigned i = 0; i < tubes_.size(); ++i)
251
1/2
✓ Branch 1 taken 70737 times.
✗ Branch 2 not taken.
 138441 delete tubes_[i];
252 12951 }
253
254 138586 void TakeTube(Tube<ItemT> *t) {
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 70810 times.
 138586 assert(!is_active_);
256 138586 tubes_.push_back(t);
257 138586 }
258
259 12962 void Activate() {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7852 times.
 12962 assert(!is_active_);
261
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 7852 times.
 12962 assert(!tubes_.empty());
262 12962 is_active_ = true;
263 12962 }
264
265 /**
266 * Like Tube::EnqueueBack(), but pick a tube according to ItemT::tag()
267 */
268 5170448 typename Tube<ItemT>::Link *Dispatch(ItemT *item) {
269
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5170448 times.
 5170448 assert(is_active_);
270
2/2
✓ Branch 1 taken 2408019 times.
✓ Branch 2 taken 2755561 times.
 5170448 unsigned tube_idx = (tubes_.size() == 1) ? 0
271 2408019 : (item->tag() % tubes_.size());
272 5138814 return tubes_[tube_idx]->EnqueueBack(item);
273 }
274
275 /**
276 * Like Tube::EnqueueBack(), use tubes one after another
277 */
278 251800 typename Tube<ItemT>::Link *DispatchAny(ItemT *item) {
279
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 251800 times.
 251800 assert(is_active_);
280
2/2
✓ Branch 1 taken 251720 times.
✓ Branch 2 taken 80 times.
 251800 unsigned tube_idx = (tubes_.size() == 1)
281 ? 0
282 251720 : (atomic_xadd32(&round_robin_, 1) % tubes_.size());
283 251800 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