GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/fetch.cc
Date: 2026-05-24 02:35:55
Exec Total Coverage
Lines: 155 157 98.7%
Branches: 101 173 58.4%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5
6 #include "fetch.h"
7
8 #include <unistd.h>
9
10 #include "backoff.h"
11 #include "cache.h"
12 #include "clientctx.h"
13 #include "network/download.h"
14 #include "quota.h"
15 #include "statistics.h"
16 #include "util/logging.h"
17 #include "util/posix.h"
18
19 using namespace std; // NOLINT
20
21 namespace cvmfs {
22
23 54 void TLSDestructor(void *data) {
24 54 Fetcher::ThreadLocalStorage *tls = static_cast<Fetcher::ThreadLocalStorage *>(
25 data);
26 54 std::vector<Fetcher::ThreadLocalStorage *> *tls_blocks = &tls->fetcher
27 ->tls_blocks_;
28
29 {
30 54 const MutexLockGuard m(tls->fetcher->lock_tls_blocks_);
31 54 for (vector<Fetcher::ThreadLocalStorage *>::iterator
32 54 i = tls_blocks->begin(),
33 54 iEnd = tls_blocks->end();
34
1/2
✓ Branch 1 taken 108 times.
✗ Branch 2 not taken.
 108 i != iEnd;
35 54 ++i) {
36
2/2
✓ Branch 1 taken 54 times.
✓ Branch 2 taken 54 times.
 108 if ((*i) == tls) {
37
1/2
✓ Branch 2 taken 54 times.
✗ Branch 3 not taken.
 54 tls_blocks->erase(i);
38 54 break;
39 }
40 }
41 54 }
42 54 tls->fetcher->CleanupTls(tls);
43 54 }
44
45
46 /**
47 * Called when a thread exists, releases a ThreadLocalStorage object and
48 * removes the pointer to it from tls_blocks_.
49 */
50 788 void Fetcher::CleanupTls(ThreadLocalStorage *tls) {
51 788 ClosePipe(tls->pipe_wait);
52
1/2
✓ Branch 0 taken 788 times.
✗ Branch 1 not taken.
 788 delete tls;
53 788 }
54
55
56 /**
57 * Initialized thread-local storage if called the first time in a new thread.
58 */
59 1326 Fetcher::ThreadLocalStorage *Fetcher::GetTls() {
60 ThreadLocalStorage *tls = static_cast<ThreadLocalStorage *>(
61 1326 pthread_getspecific(thread_local_storage_));
62
2/2
✓ Branch 0 taken 538 times.
✓ Branch 1 taken 788 times.
 1326 if (tls != NULL)
63 538 return tls;
64
65
2/4
✓ Branch 1 taken 788 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 788 times.
✗ Branch 5 not taken.
 788 tls = new ThreadLocalStorage();
66 788 tls->fetcher = this;
67
1/2
✓ Branch 1 taken 788 times.
✗ Branch 2 not taken.
 788 MakePipe(tls->pipe_wait);
68 788 tls->download_job.SetCompressed(true);
69 788 tls->download_job.SetProbeHosts(true);
70 788 const int retval = pthread_setspecific(thread_local_storage_, tls);
71
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 788 times.
 788 assert(retval == 0);
72
73 788 const MutexLockGuard m(lock_tls_blocks_);
74
1/2
✓ Branch 1 taken 788 times.
✗ Branch 2 not taken.
 788 tls_blocks_.push_back(tls);
75
76 788 return tls;
77 788 }
78
79
80 1518 int Fetcher::Fetch(const CacheManager::LabeledObject &object,
81 const std::string &alt_url) {
82 int fd_return; // Read-only file descriptor that is returned
83 int retval;
84
85 1518 perf::Inc(n_invocations);
86
87 // Try to open from local cache
88
3/4
✓ Branch 1 taken 1518 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 462 times.
✓ Branch 4 taken 1056 times.
 1518 if ((fd_return = OpenSelect(object)) >= 0) {
89
1/2
✓ Branch 2 taken 462 times.
✗ Branch 3 not taken.
 462 LogCvmfs(kLogCache, kLogDebug, "hit: %s", object.label.path.c_str());
90 462 return fd_return;
91 }
92
93
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1056 times.
 1056 if (object.id.IsNull()) {
94 // This has been seen when trying to load the root catalog signed by an
95 // invalid certificate on an empty cache
96 // TODO(jblomer): check if still necessary after the catalog reload refactor
97 ✗ LogCvmfs(kLogCache, kLogDebug, "cancel attempt to download null hash");
98 ✗ return -EIO;
99 }
100
101
1/2
✓ Branch 1 taken 1056 times.
✗ Branch 2 not taken.
 1056 ThreadLocalStorage *tls = GetTls();
102
103 // Synchronization point: either act as a master thread for this object or
104 // enqueue to the list of waiting threads.
105 1056 pthread_mutex_lock(lock_queues_download_);
106 1056 const ThreadQueues::iterator iDownloadQueue = queues_download_.find(
107
1/2
✓ Branch 1 taken 1056 times.
✗ Branch 2 not taken.
 1056 object.id);
108
2/2
✓ Branch 2 taken 27 times.
✓ Branch 3 taken 1029 times.
 1056 if (iDownloadQueue != queues_download_.end()) {
109
1/2
✓ Branch 2 taken 27 times.
✗ Branch 3 not taken.
 27 LogCvmfs(kLogCache, kLogDebug, "waiting for download of %s",
110 object.label.path.c_str());
111
112
1/2
✓ Branch 2 taken 27 times.
✗ Branch 3 not taken.
 27 iDownloadQueue->second->push_back(tls->pipe_wait[1]);
113 27 pthread_mutex_unlock(lock_queues_download_);
114
1/2
✓ Branch 1 taken 27 times.
✗ Branch 2 not taken.
 27 ReadPipe(tls->pipe_wait[0], &fd_return, sizeof(int));
115
116
1/2
✓ Branch 2 taken 27 times.
✗ Branch 3 not taken.
 27 LogCvmfs(kLogCache, kLogDebug, "received from another thread fd %d for %s",
117 fd_return, object.label.path.c_str());
118 27 return fd_return;
119 } else {
120 // Seems we are the first one, check again in the cache (race condition)
121
1/2
✓ Branch 1 taken 1029 times.
✗ Branch 2 not taken.
 1029 fd_return = OpenSelect(object);
122
2/2
✓ Branch 0 taken 27 times.
✓ Branch 1 taken 1002 times.
 1029 if (fd_return >= 0) {
123 27 pthread_mutex_unlock(lock_queues_download_);
124 27 return fd_return;
125 }
126
127 // Create a new queue for this chunk
128
1/2
✓ Branch 1 taken 1002 times.
✗ Branch 2 not taken.
 1002 queues_download_[object.id] = &tls->other_pipes_waiting;
129 1002 pthread_mutex_unlock(lock_queues_download_);
130 }
131
132 1002 perf::Inc(n_downloads);
133
134 // Involve the download manager
135
1/2
✓ Branch 2 taken 1002 times.
✗ Branch 3 not taken.
 1002 LogCvmfs(kLogCache, kLogDebug, "downloading %s", object.label.path.c_str());
136 1002 std::string url;
137
2/2
✓ Branch 1 taken 81 times.
✓ Branch 2 taken 921 times.
 1002 if (object.label.IsExternal()) {
138
2/4
✓ Branch 1 taken 81 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 81 times.
✗ Branch 5 not taken.
 81 url = !alt_url.empty() ? alt_url : object.label.path;
139 } else {
140
8/14
✓ Branch 1 taken 27 times.
✓ Branch 2 taken 894 times.
✓ Branch 4 taken 27 times.
✗ Branch 5 not taken.
✓ Branch 7 taken 894 times.
✗ Branch 8 not taken.
✓ Branch 10 taken 894 times.
✗ Branch 11 not taken.
✓ Branch 13 taken 921 times.
✗ Branch 14 not taken.
✓ Branch 18 taken 894 times.
✓ Branch 19 taken 27 times.
✗ Branch 22 not taken.
✗ Branch 23 not taken.
 921 url = "/" + (alt_url.size() ? alt_url : "data/" + object.id.MakePath());
141 }
142
1/2
✓ Branch 1 taken 1002 times.
✗ Branch 2 not taken.
 1002 void *txn = alloca(cache_mgr_->SizeOfTxn());
143
1/2
✓ Branch 1 taken 1002 times.
✗ Branch 2 not taken.
 1002 retval = cache_mgr_->StartTxn(object.id, object.label.size, txn);
144
2/2
✓ Branch 0 taken 27 times.
✓ Branch 1 taken 975 times.
 1002 if (retval < 0) {
145
1/2
✓ Branch 2 taken 27 times.
✗ Branch 3 not taken.
 27 LogCvmfs(kLogCache, kLogDebug, "could not start transaction on %s",
146 object.label.path.c_str());
147
1/2
✓ Branch 1 taken 27 times.
✗ Branch 2 not taken.
 27 SignalWaitingThreads(retval, object.id, tls);
148 27 return retval;
149 }
150
1/2
✓ Branch 1 taken 975 times.
✗ Branch 2 not taken.
 975 cache_mgr_->CtrlTxn(object.label, 0, txn);
151
152
1/2
✓ Branch 3 taken 975 times.
✗ Branch 4 not taken.
 975 LogCvmfs(kLogCache, kLogDebug, "miss: %s %s", object.label.path.c_str(),
153 url.c_str());
154 975 TransactionSink sink(cache_mgr_, txn);
155 975 tls->download_job.SetUrl(&url);
156 975 tls->download_job.SetSink(&sink);
157 975 tls->download_job.SetExpectedHash(&object.id);
158 975 tls->download_job.SetPathInfo(&object.label.path);
159
1/2
✓ Branch 1 taken 975 times.
✗ Branch 2 not taken.
 975 ClientCtx *ctx = ClientCtx::GetInstance();
160
3/4
✓ Branch 1 taken 975 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 102 times.
✓ Branch 4 taken 873 times.
 975 if (ctx->IsSet()) {
161
1/2
✓ Branch 5 taken 102 times.
✗ Branch 6 not taken.
 102 ctx->Get(tls->download_job.GetUidPtr(),
162 tls->download_job.GetGidPtr(),
163 tls->download_job.GetPidPtr(),
164 tls->download_job.GetInterruptCuePtr());
165 } else {
166 873 *(tls->download_job.GetUidPtr()) = -1;
167 873 *(tls->download_job.GetGidPtr()) = -1;
168 873 *(tls->download_job.GetPidPtr()) = -1;
169 873 *(tls->download_job.GetInterruptCuePtr()) = NULL;
170 }
171 975 tls->download_job.SetCompressed(object.label.zip_algorithm
172 == zlib::kZlibDefault);
173 975 tls->download_job.SetRangeOffset(object.label.range_offset);
174 975 tls->download_job.SetRangeSize(static_cast<int64_t>(object.label.size));
175
1/2
✓ Branch 1 taken 975 times.
✗ Branch 2 not taken.
 975 download_mgr_->Fetch(&tls->download_job);
176
177
2/2
✓ Branch 1 taken 857 times.
✓ Branch 2 taken 118 times.
 975 if (tls->download_job.error_code() == download::kFailOk) {
178
1/2
✓ Branch 2 taken 857 times.
✗ Branch 3 not taken.
 857 LogCvmfs(kLogCache, kLogDebug, "finished downloading of %s", url.c_str());
179
180
1/2
✓ Branch 1 taken 857 times.
✗ Branch 2 not taken.
 857 fd_return = cache_mgr_->OpenFromTxn(txn);
181
2/2
✓ Branch 0 taken 27 times.
✓ Branch 1 taken 830 times.
 857 if (fd_return < 0) {
182
1/2
✓ Branch 1 taken 27 times.
✗ Branch 2 not taken.
 27 cache_mgr_->AbortTxn(txn);
183
1/2
✓ Branch 1 taken 27 times.
✗ Branch 2 not taken.
 27 SignalWaitingThreads(fd_return, object.id, tls);
184 27 return fd_return;
185 }
186
187
1/2
✓ Branch 1 taken 830 times.
✗ Branch 2 not taken.
 830 retval = cache_mgr_->CommitTxn(txn);
188
2/2
✓ Branch 0 taken 54 times.
✓ Branch 1 taken 776 times.
 830 if (retval < 0) {
189
1/2
✓ Branch 1 taken 54 times.
✗ Branch 2 not taken.
 54 cache_mgr_->Close(fd_return);
190
1/2
✓ Branch 1 taken 54 times.
✗ Branch 2 not taken.
 54 SignalWaitingThreads(retval, object.id, tls);
191 54 return retval;
192 }
193
1/2
✓ Branch 1 taken 776 times.
✗ Branch 2 not taken.
 776 SignalWaitingThreads(fd_return, object.id, tls);
194 776 return fd_return;
195 }
196
197 // Download failed
198
1/5
✗ Branch 4 not taken.
✓ Branch 5 taken 118 times.
✗ Branch 6 not taken.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
 236 LogCvmfs(kLogCache, kLogDebug | kLogSyslogErr,
199 "failed to fetch %s (hash: %s, error %d [%s])",
200
1/2
✓ Branch 1 taken 118 times.
✗ Branch 2 not taken.
 236 object.label.path.c_str(), object.id.ToString().c_str(),
201 118 tls->download_job.error_code(),
202 download::Code2Ascii(tls->download_job.error_code()));
203
1/2
✓ Branch 1 taken 118 times.
✗ Branch 2 not taken.
 118 cache_mgr_->AbortTxn(txn);
204
1/2
✓ Branch 1 taken 118 times.
✗ Branch 2 not taken.
 118 backoff_throttle_->Throttle();
205
1/2
✓ Branch 1 taken 118 times.
✗ Branch 2 not taken.
 118 SignalWaitingThreads(-EIO, object.id, tls);
206 118 return -EIO;
207 1002 }
208
209
210 2200 Fetcher::Fetcher(CacheManager *cache_mgr,
211 download::DownloadManager *download_mgr,
212 BackoffThrottle *backoff_throttle,
213 2200 perf::StatisticsTemplate statistics)
214 2200 : lock_queues_download_(NULL)
215 2200 , lock_tls_blocks_(NULL)
216 2200 , cache_mgr_(cache_mgr)
217 2200 , download_mgr_(download_mgr)
218 2200 , backoff_throttle_(backoff_throttle) {
219 int retval;
220 2200 retval = pthread_key_create(&thread_local_storage_, TLSDestructor);
221
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2200 times.
 2200 assert(retval == 0);
222 2200 lock_queues_download_ = reinterpret_cast<pthread_mutex_t *>(
223 2200 smalloc(sizeof(pthread_mutex_t)));
224 2200 retval = pthread_mutex_init(lock_queues_download_, NULL);
225
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2200 times.
 2200 assert(retval == 0);
226 2200 lock_tls_blocks_ = reinterpret_cast<pthread_mutex_t *>(
227 2200 smalloc(sizeof(pthread_mutex_t)));
228 2200 retval = pthread_mutex_init(lock_tls_blocks_, NULL);
229
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2200 times.
 2200 assert(retval == 0);
230
3/6
✓ Branch 2 taken 2200 times.
✗ Branch 3 not taken.
✓ Branch 6 taken 2200 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 2200 times.
✗ Branch 10 not taken.
 2200 n_downloads = statistics.RegisterTemplated(
231 "n_downloads",
232 "overall number of downloaded files (incl. catalogs, chunks)");
233
3/6
✓ Branch 2 taken 2200 times.
✗ Branch 3 not taken.
✓ Branch 6 taken 2200 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 2200 times.
✗ Branch 10 not taken.
 2200 n_invocations = statistics.RegisterTemplated(
234 "n_invocations",
235 "overall number of object requests (incl. catalogs, chunks)");
236 2200 }
237
238
239 2200 Fetcher::~Fetcher() {
240 int retval;
241
242 {
243 2200 const MutexLockGuard m(lock_tls_blocks_);
244
2/2
✓ Branch 1 taken 734 times.
✓ Branch 2 taken 2200 times.
 2934 for (unsigned i = 0; i < tls_blocks_.size(); ++i)
245 734 CleanupTls(tls_blocks_[i]);
246 2200 }
247
248 2200 retval = pthread_mutex_destroy(lock_tls_blocks_);
249
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2200 times.
 2200 assert(retval == 0);
250 2200 free(lock_tls_blocks_);
251
252 2200 retval = pthread_mutex_destroy(lock_queues_download_);
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2200 times.
 2200 assert(retval == 0);
254 2200 free(lock_queues_download_);
255
256 2200 retval = pthread_key_delete(thread_local_storage_);
257
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2200 times.
 2200 assert(retval == 0);
258 2200 }
259
260
261 /**
262 * Depending on the object type, uses either Open() or OpenPinned() from the
263 * cache manager
264 */
265 2547 int Fetcher::OpenSelect(const CacheManager::LabeledObject &object) {
266
5/6
✓ Branch 1 taken 776 times.
✓ Branch 2 taken 1771 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 776 times.
✓ Branch 6 taken 1771 times.
✓ Branch 7 taken 776 times.
 2547 if (object.label.IsCatalog() || object.label.IsPinned()) {
267 1771 return cache_mgr_->OpenPinned(object);
268 } else {
269 776 return cache_mgr_->Open(object);
270 }
271 }
272
273
274 1083 void Fetcher::SignalWaitingThreads(const int fd,
275 const shash::Any &id,
276 ThreadLocalStorage *tls) {
277 1083 const MutexLockGuard m(lock_queues_download_);
278
2/2
✓ Branch 1 taken 108 times.
✓ Branch 2 taken 1083 times.
 1191 for (unsigned i = 0, s = tls->other_pipes_waiting.size(); i < s; ++i) {
279
3/4
✓ Branch 0 taken 81 times.
✓ Branch 1 taken 27 times.
✓ Branch 3 taken 81 times.
✗ Branch 4 not taken.
 108 int fd_dup = (fd >= 0) ? cache_mgr_->Dup(fd) : fd;
280
1/2
✓ Branch 2 taken 108 times.
✗ Branch 3 not taken.
 108 WritePipe(tls->other_pipes_waiting[i], &fd_dup, sizeof(int));
281 }
282 1083 tls->other_pipes_waiting.clear();
283
1/2
✓ Branch 1 taken 1083 times.
✗ Branch 2 not taken.
 1083 queues_download_.erase(id);
284 1083 }
285
286 } // namespace cvmfs
287