GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/ingestion/task.h
Date: 2025-08-31 02:39:21
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 269840 virtual ~TubeConsumer() { }
37
38 protected:
39 267969 explicit TubeConsumer(Tube<ItemT> *tube) : tube_(tube) { }
40 virtual void Process(ItemT *item) = 0;
41 262357 virtual void OnTerminate() { }
42
43 Tube<ItemT> *tube_;
44
45 private:
46 264897 static void *MainConsumer(void *data) {
47 264897 TubeConsumer<ItemT> *consumer = reinterpret_cast<TubeConsumer<ItemT> *>(
48 data);
49
50 114975849 while (true) {
51 115240746 ItemT *item = consumer->tube_->PopFront();
52
2/2
✓ Branch 1 taken 132824 times.
✓ Branch 2 taken 62669387 times.
 114230471 if (item->IsQuitBeacon()) {
53
2/2
✓ Branch 0 taken 132817 times.
✓ Branch 1 taken 7 times.
 263504 delete item;
54 262725 break;
55 }
56 113740721 consumer->Process(item);
57 }
58 262725 consumer->OnTerminate();
59 262005 return NULL;
60 }
61 };
62
63
64 template<class ItemT>
65 class TubeConsumerGroup : SingleCopy {
66 public:
67 13817 TubeConsumerGroup() : is_active_(false) { }
68
69 13804 ~TubeConsumerGroup() {
70
2/2
✓ Branch 1 taken 134920 times.
✓ Branch 2 taken 7932 times.
 281500 for (unsigned i = 0; i < consumers_.size(); ++i)
71
1/2
✓ Branch 1 taken 134920 times.
✗ Branch 2 not taken.
 267696 delete consumers_[i];
72 13804 }
73
74 267969 void TakeConsumer(TubeConsumer<ItemT> *consumer) {
75
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 135057 times.
 267969 assert(!is_active_);
76 267969 consumers_.push_back(consumer);
77 267969 }
78
79 13721 void Spawn() {
80
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7891 times.
 13721 assert(!is_active_);
81 13721 unsigned N = consumers_.size();
82 13721 threads_.resize(N);
83
2/2
✓ Branch 0 taken 133521 times.
✓ Branch 1 taken 7891 times.
 278618 for (unsigned i = 0; i < N; ++i) {
84 264897 int retval = pthread_create(
85 264897 &threads_[i], NULL, TubeConsumer<ItemT>::MainConsumer, consumers_[i]);
86
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 133521 times.
 264897 if (retval != 0) {
87 ✗ PANIC(kLogStderr, "failed to create new thread (error: %d, pid: %d)",
88 errno, getpid());
89 }
90 }
91 13721 is_active_ = true;
92 13721 }
93
94 13708 void Terminate() {
95
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7884 times.
 13708 assert(is_active_);
96 13708 unsigned N = consumers_.size();
97
2/2
✓ Branch 0 taken 133384 times.
✓ Branch 1 taken 7884 times.
 278332 for (unsigned i = 0; i < N; ++i) {
98 264624 consumers_[i]->tube_->EnqueueBack(ItemT::CreateQuitBeacon());
99 }
100
2/2
✓ Branch 0 taken 133384 times.
✓ Branch 1 taken 7884 times.
 278332 for (unsigned i = 0; i < N; ++i) {
101 264624 int retval = pthread_join(threads_[i], NULL);
102
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 133384 times.
 264624 assert(retval == 0);
103 }
104 13708 is_active_ = false;
105 13708 }
106
107 2060 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