GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/fetch.cc
Date: 2026-05-19 11:45:12
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 92 void TLSDestructor(void *data) {
24 92 Fetcher::ThreadLocalStorage *tls = static_cast<Fetcher::ThreadLocalStorage *>(
25 data);
26 92 std::vector<Fetcher::ThreadLocalStorage *> *tls_blocks = &tls->fetcher
27 ->tls_blocks_;
28
29 {
30 92 const MutexLockGuard m(tls->fetcher->lock_tls_blocks_);
31 92 for (vector<Fetcher::ThreadLocalStorage *>::iterator
32 92 i = tls_blocks->begin(),
33 92 iEnd = tls_blocks->end();
34
1/2
✓ Branch 1 taken 184 times.
✗ Branch 2 not taken.
 184 i != iEnd;
35 92 ++i) {
36
2/2
✓ Branch 1 taken 92 times.
✓ Branch 2 taken 92 times.
 184 if ((*i) == tls) {
37
1/2
✓ Branch 2 taken 92 times.
✗ Branch 3 not taken.
 92 tls_blocks->erase(i);
38 92 break;
39 }
40 }
41 92 }
42 92 tls->fetcher->CleanupTls(tls);
43 92 }
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 900 void Fetcher::CleanupTls(ThreadLocalStorage *tls) {
51 900 ClosePipe(tls->pipe_wait);
52
1/2
✓ Branch 0 taken 900 times.
✗ Branch 1 not taken.
 900 delete tls;
53 900 }
54
55
56 /**
57 * Initialized thread-local storage if called the first time in a new thread.
58 */
59 1819 Fetcher::ThreadLocalStorage *Fetcher::GetTls() {
60 ThreadLocalStorage *tls = static_cast<ThreadLocalStorage *>(
61 1819 pthread_getspecific(thread_local_storage_));
62
2/2
✓ Branch 0 taken 919 times.
✓ Branch 1 taken 900 times.
 1819 if (tls != NULL)
63 919 return tls;
64
65
2/4
✓ Branch 1 taken 900 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 900 times.
✗ Branch 5 not taken.
 900 tls = new ThreadLocalStorage();
66 900 tls->fetcher = this;
67
1/2
✓ Branch 1 taken 900 times.
✗ Branch 2 not taken.
 900 MakePipe(tls->pipe_wait);
68 900 tls->download_job.SetCompressed(true);
69 900 tls->download_job.SetProbeHosts(true);
70 900 const int retval = pthread_setspecific(thread_local_storage_, tls);
71
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 900 times.
 900 assert(retval == 0);
72
73 900 const MutexLockGuard m(lock_tls_blocks_);
74
1/2
✓ Branch 1 taken 900 times.
✗ Branch 2 not taken.
 900 tls_blocks_.push_back(tls);
75
76 900 return tls;
77 900 }
78
79
80 1815 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 1815 perf::Inc(n_invocations);
86
87 // Try to open from local cache
88
3/4
✓ Branch 1 taken 1815 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 456 times.
✓ Branch 4 taken 1359 times.
 1815 if ((fd_return = OpenSelect(object)) >= 0) {
89
1/2
✓ Branch 2 taken 456 times.
✗ Branch 3 not taken.
 456 LogCvmfs(kLogCache, kLogDebug, "hit: %s", object.label.path.c_str());
90 456 return fd_return;
91 }
92
93
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1359 times.
 1359 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 1359 times.
✗ Branch 2 not taken.
 1359 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 1359 pthread_mutex_lock(lock_queues_download_);
106 1359 const ThreadQueues::iterator iDownloadQueue = queues_download_.find(
107
1/2
✓ Branch 1 taken 1359 times.
✗ Branch 2 not taken.
 1359 object.id);
108
2/2
✓ Branch 2 taken 46 times.
✓ Branch 3 taken 1313 times.
 1359 if (iDownloadQueue != queues_download_.end()) {
109
1/2
✓ Branch 2 taken 46 times.
✗ Branch 3 not taken.
 46 LogCvmfs(kLogCache, kLogDebug, "waiting for download of %s",
110 object.label.path.c_str());
111
112
1/2
✓ Branch 2 taken 46 times.
✗ Branch 3 not taken.
 46 iDownloadQueue->second->push_back(tls->pipe_wait[1]);
113 46 pthread_mutex_unlock(lock_queues_download_);
114
1/2
✓ Branch 1 taken 46 times.
✗ Branch 2 not taken.
 46 ReadPipe(tls->pipe_wait[0], &fd_return, sizeof(int));
115
116
1/2
✓ Branch 2 taken 46 times.
✗ Branch 3 not taken.
 46 LogCvmfs(kLogCache, kLogDebug, "received from another thread fd %d for %s",
117 fd_return, object.label.path.c_str());
118 46 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 1313 times.
✗ Branch 2 not taken.
 1313 fd_return = OpenSelect(object);
122
2/2
✓ Branch 0 taken 46 times.
✓ Branch 1 taken 1267 times.
 1313 if (fd_return >= 0) {
123 46 pthread_mutex_unlock(lock_queues_download_);
124 46 return fd_return;
125 }
126
127 // Create a new queue for this chunk
128
1/2
✓ Branch 1 taken 1267 times.
✗ Branch 2 not taken.
 1267 queues_download_[object.id] = &tls->other_pipes_waiting;
129 1267 pthread_mutex_unlock(lock_queues_download_);
130 }
131
132 1267 perf::Inc(n_downloads);
133
134 // Involve the download manager
135
1/2
✓ Branch 2 taken 1267 times.
✗ Branch 3 not taken.
 1267 LogCvmfs(kLogCache, kLogDebug, "downloading %s", object.label.path.c_str());
136 1267 std::string url;
137
2/2
✓ Branch 1 taken 138 times.
✓ Branch 2 taken 1129 times.
 1267 if (object.label.IsExternal()) {
138
2/4
✓ Branch 1 taken 138 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 138 times.
✗ Branch 5 not taken.
 138 url = !alt_url.empty() ? alt_url : object.label.path;
139 } else {
140
8/14
✓ Branch 1 taken 46 times.
✓ Branch 2 taken 1083 times.
✓ Branch 4 taken 46 times.
✗ Branch 5 not taken.
✓ Branch 7 taken 1083 times.
✗ Branch 8 not taken.
✓ Branch 10 taken 1083 times.
✗ Branch 11 not taken.
✓ Branch 13 taken 1129 times.
✗ Branch 14 not taken.
✓ Branch 18 taken 1083 times.
✓ Branch 19 taken 46 times.
✗ Branch 22 not taken.
✗ Branch 23 not taken.
 1129 url = "/" + (alt_url.size() ? alt_url : "data/" + object.id.MakePath());
141 }
142
1/2
✓ Branch 1 taken 1267 times.
✗ Branch 2 not taken.
 1267 void *txn = alloca(cache_mgr_->SizeOfTxn());
143
1/2
✓ Branch 1 taken 1267 times.
✗ Branch 2 not taken.
 1267 retval = cache_mgr_->StartTxn(object.id, object.label.size, txn);
144
2/2
✓ Branch 0 taken 46 times.
✓ Branch 1 taken 1221 times.
 1267 if (retval < 0) {
145
1/2
✓ Branch 2 taken 46 times.
✗ Branch 3 not taken.
 46 LogCvmfs(kLogCache, kLogDebug, "could not start transaction on %s",
146 object.label.path.c_str());
147
1/2
✓ Branch 1 taken 46 times.
✗ Branch 2 not taken.
 46 SignalWaitingThreads(retval, object.id, tls);
148 46 return retval;
149 }
150
1/2
✓ Branch 1 taken 1221 times.
✗ Branch 2 not taken.
 1221 cache_mgr_->CtrlTxn(object.label, 0, txn);
151
152
1/2
✓ Branch 3 taken 1221 times.
✗ Branch 4 not taken.
 1221 LogCvmfs(kLogCache, kLogDebug, "miss: %s %s", object.label.path.c_str(),
153 url.c_str());
154 1221 TransactionSink sink(cache_mgr_, txn);
155 1221 tls->download_job.SetUrl(&url);
156 1221 tls->download_job.SetSink(&sink);
157 1221 tls->download_job.SetExpectedHash(&object.id);
158 1221 tls->download_job.SetPathInfo(&object.label.path);
159
1/2
✓ Branch 1 taken 1221 times.
✗ Branch 2 not taken.
 1221 ClientCtx *ctx = ClientCtx::GetInstance();
160
3/4
✓ Branch 1 taken 1221 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 108 times.
✓ Branch 4 taken 1113 times.
 1221 if (ctx->IsSet()) {
161
1/2
✓ Branch 5 taken 108 times.
✗ Branch 6 not taken.
 108 ctx->Get(tls->download_job.GetUidPtr(),
162 tls->download_job.GetGidPtr(),
163 tls->download_job.GetPidPtr(),
164 tls->download_job.GetInterruptCuePtr());
165 } else {
166 1113 *(tls->download_job.GetUidPtr()) = -1;
167 1113 *(tls->download_job.GetGidPtr()) = -1;
168 1113 *(tls->download_job.GetPidPtr()) = -1;
169 1113 *(tls->download_job.GetInterruptCuePtr()) = NULL;
170 }
171 1221 tls->download_job.SetCompressed(object.label.zip_algorithm
172 == zlib::kZlibDefault);
173 1221 tls->download_job.SetRangeOffset(object.label.range_offset);
174 1221 tls->download_job.SetRangeSize(static_cast<int64_t>(object.label.size));
175
1/2
✓ Branch 1 taken 1221 times.
✗ Branch 2 not taken.
 1221 download_mgr_->Fetch(&tls->download_job);
176
177
2/2
✓ Branch 1 taken 997 times.
✓ Branch 2 taken 224 times.
 1221 if (tls->download_job.error_code() == download::kFailOk) {
178
1/2
✓ Branch 2 taken 997 times.
✗ Branch 3 not taken.
 997 LogCvmfs(kLogCache, kLogDebug, "finished downloading of %s", url.c_str());
179
180
1/2
✓ Branch 1 taken 997 times.
✗ Branch 2 not taken.
 997 fd_return = cache_mgr_->OpenFromTxn(txn);
181
2/2
✓ Branch 0 taken 46 times.
✓ Branch 1 taken 951 times.
 997 if (fd_return < 0) {
182
1/2
✓ Branch 1 taken 46 times.
✗ Branch 2 not taken.
 46 cache_mgr_->AbortTxn(txn);
183
1/2
✓ Branch 1 taken 46 times.
✗ Branch 2 not taken.
 46 SignalWaitingThreads(fd_return, object.id, tls);
184 46 return fd_return;
185 }
186
187
1/2
✓ Branch 1 taken 951 times.
✗ Branch 2 not taken.
 951 retval = cache_mgr_->CommitTxn(txn);
188
2/2
✓ Branch 0 taken 92 times.
✓ Branch 1 taken 859 times.
 951 if (retval < 0) {
189
1/2
✓ Branch 1 taken 92 times.
✗ Branch 2 not taken.
 92 cache_mgr_->Close(fd_return);
190
1/2
✓ Branch 1 taken 92 times.
✗ Branch 2 not taken.
 92 SignalWaitingThreads(retval, object.id, tls);
191 92 return retval;
192 }
193
1/2
✓ Branch 1 taken 859 times.
✗ Branch 2 not taken.
 859 SignalWaitingThreads(fd_return, object.id, tls);
194 859 return fd_return;
195 }
196
197 // Download failed
198
1/5
✗ Branch 4 not taken.
✓ Branch 5 taken 224 times.
✗ Branch 6 not taken.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
 448 LogCvmfs(kLogCache, kLogDebug | kLogSyslogErr,
199 "failed to fetch %s (hash: %s, error %d [%s])",
200
1/2
✓ Branch 1 taken 224 times.
✗ Branch 2 not taken.
 448 object.label.path.c_str(), object.id.ToString().c_str(),
201 224 tls->download_job.error_code(),
202 download::Code2Ascii(tls->download_job.error_code()));
203
1/2
✓ Branch 1 taken 224 times.
✗ Branch 2 not taken.
 224 cache_mgr_->AbortTxn(txn);
204
1/2
✓ Branch 1 taken 224 times.
✗ Branch 2 not taken.
 224 backoff_throttle_->Throttle();
205
1/2
✓ Branch 1 taken 224 times.
✗ Branch 2 not taken.
 224 SignalWaitingThreads(-EIO, object.id, tls);
206 224 return -EIO;
207 1267 }
208
209
210 1786 Fetcher::Fetcher(CacheManager *cache_mgr,
211 download::DownloadManager *download_mgr,
212 BackoffThrottle *backoff_throttle,
213 1786 perf::StatisticsTemplate statistics)
214 1786 : lock_queues_download_(NULL)
215 1786 , lock_tls_blocks_(NULL)
216 1786 , cache_mgr_(cache_mgr)
217 1786 , download_mgr_(download_mgr)
218 1786 , backoff_throttle_(backoff_throttle) {
219 int retval;
220 1786 retval = pthread_key_create(&thread_local_storage_, TLSDestructor);
221
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1786 times.
 1786 assert(retval == 0);
222 1786 lock_queues_download_ = reinterpret_cast<pthread_mutex_t *>(
223 1786 smalloc(sizeof(pthread_mutex_t)));
224 1786 retval = pthread_mutex_init(lock_queues_download_, NULL);
225
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1786 times.
 1786 assert(retval == 0);
226 1786 lock_tls_blocks_ = reinterpret_cast<pthread_mutex_t *>(
227 1786 smalloc(sizeof(pthread_mutex_t)));
228 1786 retval = pthread_mutex_init(lock_tls_blocks_, NULL);
229
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1786 times.
 1786 assert(retval == 0);
230
3/6
✓ Branch 2 taken 1786 times.
✗ Branch 3 not taken.
✓ Branch 6 taken 1786 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 1786 times.
✗ Branch 10 not taken.
 1786 n_downloads = statistics.RegisterTemplated(
231 "n_downloads",
232 "overall number of downloaded files (incl. catalogs, chunks)");
233
3/6
✓ Branch 2 taken 1786 times.
✗ Branch 3 not taken.
✓ Branch 6 taken 1786 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 1786 times.
✗ Branch 10 not taken.
 1786 n_invocations = statistics.RegisterTemplated(
234 "n_invocations",
235 "overall number of object requests (incl. catalogs, chunks)");
236 1786 }
237
238
239 1786 Fetcher::~Fetcher() {
240 int retval;
241
242 {
243 1786 const MutexLockGuard m(lock_tls_blocks_);
244
2/2
✓ Branch 1 taken 808 times.
✓ Branch 2 taken 1786 times.
 2594 for (unsigned i = 0; i < tls_blocks_.size(); ++i)
245 808 CleanupTls(tls_blocks_[i]);
246 1786 }
247
248 1786 retval = pthread_mutex_destroy(lock_tls_blocks_);
249
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1786 times.
 1786 assert(retval == 0);
250 1786 free(lock_tls_blocks_);
251
252 1786 retval = pthread_mutex_destroy(lock_queues_download_);
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1786 times.
 1786 assert(retval == 0);
254 1786 free(lock_queues_download_);
255
256 1786 retval = pthread_key_delete(thread_local_storage_);
257
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1786 times.
 1786 assert(retval == 0);
258 1786 }
259
260
261 /**
262 * Depending on the object type, uses either Open() or OpenPinned() from the
263 * cache manager
264 */
265 3128 int Fetcher::OpenSelect(const CacheManager::LabeledObject &object) {
266
5/6
✓ Branch 1 taken 1093 times.
✓ Branch 2 taken 2035 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 1093 times.
✓ Branch 6 taken 2035 times.
✓ Branch 7 taken 1093 times.
 3128 if (object.label.IsCatalog() || object.label.IsPinned()) {
267 2035 return cache_mgr_->OpenPinned(object);
268 } else {
269 1093 return cache_mgr_->Open(object);
270 }
271 }
272
273
274 1405 void Fetcher::SignalWaitingThreads(const int fd,
275 const shash::Any &id,
276 ThreadLocalStorage *tls) {
277 1405 const MutexLockGuard m(lock_queues_download_);
278
2/2
✓ Branch 1 taken 184 times.
✓ Branch 2 taken 1405 times.
 1589 for (unsigned i = 0, s = tls->other_pipes_waiting.size(); i < s; ++i) {
279
3/4
✓ Branch 0 taken 138 times.
✓ Branch 1 taken 46 times.
✓ Branch 3 taken 138 times.
✗ Branch 4 not taken.
 184 int fd_dup = (fd >= 0) ? cache_mgr_->Dup(fd) : fd;
280
1/2
✓ Branch 2 taken 184 times.
✗ Branch 3 not taken.
 184 WritePipe(tls->other_pipes_waiting[i], &fd_dup, sizeof(int));
281 }
282 1405 tls->other_pipes_waiting.clear();
283
1/2
✓ Branch 1 taken 1405 times.
✗ Branch 2 not taken.
 1405 queues_download_.erase(id);
284 1405 }
285
286 } // namespace cvmfs
287