GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/ingestion/task.h
Date: 2025-10-19 02:35:28
Exec Total Coverage
Lines: 43 44 97.7%
Branches: 18 24 75.0%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #ifndef CVMFS_INGESTION_TASK_H_
6 #define CVMFS_INGESTION_TASK_H_
7
8 #include <errno.h>
9 #include <pthread.h>
10 #include <unistd.h>
11
12 #include <cassert>
13 #include <vector>
14
15 #include "util/exception.h"
16 #include "util/single_copy.h"
17 #include "util/tube.h"
18
19 /**
20 * Forward declaration of TubeConsumerGroup so that it can be used as a friend
21 * class to TubeConsumer.
22 */
23 template<typename ItemT>
24 class TubeConsumerGroup;
25
26
27 /**
28 * Base class for threads that processes items from a tube one by one. Concrete
29 * implementations overwrite the Process() method.
30 */
31 template<class ItemT>
32 class TubeConsumer : SingleCopy {
33 friend class TubeConsumerGroup<ItemT>;
34
35 public:
36 310328 virtual ~TubeConsumer() { }
37
38 protected:
39 307251 explicit TubeConsumer(Tube<ItemT> *tube) : tube_(tube) { }
40 virtual void Process(ItemT *item) = 0;
41 277286 virtual void OnTerminate() { }
42
43 Tube<ItemT> *tube_;
44
45 private:
46 283443 static void *MainConsumer(void *data) {
47 283443 TubeConsumer<ItemT> *consumer = reinterpret_cast<TubeConsumer<ItemT> *>(
48 data);
49
50 31015359 while (true) {
51 31298802 ItemT *item = consumer->tube_->PopFront();
52
2/2
✓ Branch 1 taken 142420 times.
✓ Branch 2 taken 17173640 times.
 31099247 if (item->IsQuitBeacon()) {
53
2/2
✓ Branch 0 taken 142101 times.
✓ Branch 1 taken 319 times.
 281521 delete item;
54 281250 break;
55 }
56 30732945 consumer->Process(item);
57 }
58 281250 consumer->OnTerminate();
59 280488 return NULL;
60 }
61 };
62
63
64 template<class ItemT>
65 class TubeConsumerGroup : SingleCopy {
66 public:
67 16343 TubeConsumerGroup() : is_active_(false) { }
68
69 16330 ~TubeConsumerGroup() {
70
2/2
✓ Branch 1 taken 155164 times.
✓ Branch 2 taken 9522 times.
 323308 for (unsigned i = 0; i < consumers_.size(); ++i)
71
1/2
✓ Branch 1 taken 155164 times.
✗ Branch 2 not taken.
 306978 delete consumers_[i];
72 16330 }
73
74 307251 void TakeConsumer(TubeConsumer<ItemT> *consumer) {
75
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 155301 times.
 307251 assert(!is_active_);
76 307251 consumers_.push_back(consumer);
77 307251 }
78
79 15599 void Spawn() {
80
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9157 times.
 15599 assert(!is_active_);
81 15599 unsigned N = consumers_.size();
82 15599 threads_.resize(N);
83
2/2
✓ Branch 0 taken 143397 times.
✓ Branch 1 taken 9157 times.
 299042 for (unsigned i = 0; i < N; ++i) {
84 283443 int retval = pthread_create(
85 283443 &threads_[i], NULL, TubeConsumer<ItemT>::MainConsumer, consumers_[i]);
86
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 143397 times.
 283443 if (retval != 0) {
87 ✗ PANIC(kLogStderr, "failed to create new thread (error: %d, pid: %d)",
88 errno, getpid());
89 }
90 }
91 15599 is_active_ = true;
92 15599 }
93
94 15586 void Terminate() {
95
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9150 times.
 15586 assert(is_active_);
96 15586 unsigned N = consumers_.size();
97
2/2
✓ Branch 0 taken 143260 times.
✓ Branch 1 taken 9150 times.
 298756 for (unsigned i = 0; i < N; ++i) {
98 283170 consumers_[i]->tube_->EnqueueBack(ItemT::CreateQuitBeacon());
99 }
100
2/2
✓ Branch 0 taken 143260 times.
✓ Branch 1 taken 9150 times.
 298756 for (unsigned i = 0; i < N; ++i) {
101 283170 int retval = pthread_join(threads_[i], NULL);
102
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 143260 times.
 283170 assert(retval == 0);
103 }
104 15586 is_active_ = false;
105 15586 }
106
107 2714 bool is_active() { return is_active_; }
108
109 private:
110 bool is_active_;
111 std::vector<TubeConsumer<ItemT> *> consumers_;
112 std::vector<pthread_t> threads_;
113 };
114
115 #endif // CVMFS_INGESTION_TASK_H_
116