GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/cache.cc
Date: 2025-08-31 02:39:21
Exec Total Coverage
Lines: 95 115 82.6%
Branches: 60 124 48.4%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #include "cache.h"
6
7 #include <alloca.h>
8 #include <errno.h>
9
10 #include <cassert>
11 #include <cstdlib>
12 #include <string>
13
14 #include "compression/compression.h"
15 #include "crypto/hash.h"
16 #include "directory_entry.h"
17 #include "network/download.h"
18 #include "quota.h"
19 #include "util/posix.h"
20 #include "util/smalloc.h"
21
22 using namespace std; // NOLINT
23
24 const uint64_t CacheManager::kSizeUnknown = uint64_t(-1);
25
26
27
1/2
✓ Branch 3 taken 5219 times.
✗ Branch 4 not taken.
 5219 CacheManager::CacheManager() : quota_mgr_(new NoopQuotaManager()) { }
28
29
30
2/2
✓ Branch 0 taken 4990 times.
✓ Branch 1 taken 215 times.
 10410 CacheManager::~CacheManager() { delete quota_mgr_; }
31
32
33 /**
34 * Compresses and checksums the file pointed to by fd. The hash algorithm needs
35 * to be set in id.
36 */
37 180 int CacheManager::ChecksumFd(int fd, shash::Any *id) {
38
1/2
✓ Branch 1 taken 180 times.
✗ Branch 2 not taken.
 180 shash::ContextPtr hash_context(id->algorithm);
39 180 hash_context.buffer = alloca(hash_context.size);
40
1/2
✓ Branch 1 taken 180 times.
✗ Branch 2 not taken.
 180 shash::Init(hash_context);
41
42 z_stream strm;
43
1/2
✓ Branch 1 taken 180 times.
✗ Branch 2 not taken.
 180 zlib::CompressInit(&strm);
44 zlib::StreamStates retval;
45
46 unsigned char buf[4096];
47 180 uint64_t pos = 0;
48 bool eof;
49
50 do {
51
1/2
✓ Branch 1 taken 225 times.
✗ Branch 2 not taken.
 225 const int64_t nbytes = Pread(fd, buf, 4096, pos);
52
2/2
✓ Branch 0 taken 45 times.
✓ Branch 1 taken 180 times.
 225 if (nbytes < 0) {
53
1/2
✓ Branch 1 taken 45 times.
✗ Branch 2 not taken.
 45 zlib::CompressFini(&strm);
54 45 return nbytes;
55 }
56 180 pos += nbytes;
57 180 eof = nbytes < 4096;
58
1/2
✓ Branch 1 taken 180 times.
✗ Branch 2 not taken.
 180 retval = zlib::CompressZStream2Null(buf, nbytes, eof, &strm, &hash_context);
59
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 180 times.
 180 if (retval == zlib::kStreamDataError) {
60 ✗ zlib::CompressFini(&strm);
61 ✗ return -EINVAL;
62 }
63
2/2
✓ Branch 0 taken 45 times.
✓ Branch 1 taken 135 times.
 180 } while (!eof);
64
65
1/2
✓ Branch 1 taken 135 times.
✗ Branch 2 not taken.
 135 zlib::CompressFini(&strm);
66
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 135 times.
 135 if (retval != zlib::kStreamEnd)
67 ✗ return -EINVAL;
68
1/2
✓ Branch 1 taken 135 times.
✗ Branch 2 not taken.
 135 shash::Final(hash_context, id);
69 135 return 0;
70 }
71
72
73 /**
74 * Commits the memory blob buffer to the given chunk id. No checking!
75 * The hash and the memory blob need to match.
76 */
77 6047 bool CacheManager::CommitFromMem(const LabeledObject &object,
78 const unsigned char *buffer,
79 const uint64_t size) {
80 6047 void *txn = alloca(this->SizeOfTxn());
81 6047 const int fd = this->StartTxn(object.id, size, txn);
82
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 6043 times.
 6047 if (fd < 0)
83 4 return false;
84 6043 this->CtrlTxn(object.label, 0, txn);
85 6043 int64_t retval = this->Write(buffer, size, txn);
86
3/4
✓ Branch 0 taken 5995 times.
✓ Branch 1 taken 48 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 5995 times.
 6043 if ((retval < 0) || (static_cast<uint64_t>(retval) != size)) {
87 48 this->AbortTxn(txn);
88 48 return false;
89 }
90 5995 retval = this->CommitTxn(txn);
91 5995 return retval == 0;
92 }
93
94
95 98 void CacheManager::FreeState(const int fd_progress, void *data) {
96 98 State *state = reinterpret_cast<State *>(data);
97
2/2
✓ Branch 0 taken 90 times.
✓ Branch 1 taken 8 times.
 98 if (fd_progress >= 0)
98
2/4
✓ Branch 2 taken 90 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 90 times.
✗ Branch 6 not taken.
 90 SendMsg2Socket(fd_progress, "Releasing saved open files table\n");
99
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 98 times.
 98 assert(state->version == kStateVersion);
100
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 98 times.
 98 assert(state->manager_type == id());
101 98 const bool result = DoFreeState(state->concrete_state);
102
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 98 times.
 98 if (!result) {
103 ✗ if (fd_progress >= 0) {
104 ✗ SendMsg2Socket(fd_progress,
105 " *** Releasing open files table failed!\n");
106 }
107 ✗ abort();
108 }
109
1/2
✓ Branch 0 taken 98 times.
✗ Branch 1 not taken.
 98 delete state;
110 98 }
111
112
113 /**
114 * Tries to open a file and copies its contents into a newly malloc'd
115 * memory area. User of the function has to free buffer (if successful).
116 *
117 * @param[in] id content hash of the catalog entry.
118 * @param[out] buffer Contents of the file
119 * @param[out] size Size of the file
120 * \return True if successful, false otherwise.
121 */
122 435 bool CacheManager::Open2Mem(const LabeledObject &object,
123 unsigned char **buffer,
124 uint64_t *size) {
125 435 *size = 0;
126 435 *buffer = NULL;
127
128 435 const int fd = this->Open(object);
129
2/2
✓ Branch 0 taken 172 times.
✓ Branch 1 taken 259 times.
 431 if (fd < 0)
130 172 return false;
131
132 259 const int64_t s = this->GetSize(fd);
133
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 263 times.
 263 assert(s >= 0);
134 263 *size = static_cast<uint64_t>(s);
135
136 263 int64_t retval = 0;
137
2/2
✓ Branch 0 taken 212 times.
✓ Branch 1 taken 51 times.
 263 if (*size > 0) {
138 212 *buffer = static_cast<unsigned char *>(smalloc(*size));
139 212 retval = this->Pread(fd, *buffer, *size, 0);
140 } else {
141 51 *buffer = NULL;
142 }
143
144 263 this->Close(fd);
145
3/4
✓ Branch 0 taken 218 times.
✓ Branch 1 taken 45 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 218 times.
 263 if ((retval < 0) || (static_cast<uint64_t>(retval) != *size)) {
146 45 free(*buffer);
147 45 *buffer = NULL;
148 45 *size = 0;
149 45 return false;
150 }
151 218 return true;
152 }
153
154
155 /**
156 * Uses the regular open and, if the file exists in the cache, pins it. There
157 * is a race condition: the file can be removed between the open and the Pin.
158 * This is fixed by the quota manager's unpin method that removes files which
159 * do not exist anymore in the cache. (The quota manager also translates double
160 * pins into a no-op, so that the accounting does not get out of sync.)
161 */
162 1680 int CacheManager::OpenPinned(const LabeledObject &object) {
163 1680 const int fd = this->Open(object);
164
2/2
✓ Branch 0 taken 378 times.
✓ Branch 1 taken 1302 times.
 1680 if (fd >= 0) {
165 378 const int64_t size = this->GetSize(fd);
166
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 378 times.
 378 if (size < 0) {
167 ✗ this->Close(fd);
168 ✗ return size;
169 }
170
1/2
✓ Branch 1 taken 378 times.
✗ Branch 2 not taken.
 378 const bool retval = quota_mgr_->Pin(object.id, static_cast<uint64_t>(size),
171 756 object.label.GetDescription(),
172 378 object.label.IsCatalog());
173
2/2
✓ Branch 0 taken 48 times.
✓ Branch 1 taken 330 times.
 378 if (!retval) {
174 48 this->Close(fd);
175 48 return -ENOSPC;
176 }
177 }
178 1632 return fd;
179 }
180
181
182 100 int CacheManager::RestoreState(const int fd_progress, void *data) {
183 100 State *state = reinterpret_cast<State *>(data);
184
2/2
✓ Branch 0 taken 92 times.
✓ Branch 1 taken 8 times.
 100 if (fd_progress >= 0)
185
2/4
✓ Branch 2 taken 92 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 92 times.
✗ Branch 6 not taken.
 92 SendMsg2Socket(fd_progress, "Restoring open files table... ");
186
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 100 times.
 100 if (state->version != kStateVersion) {
187 ✗ if (fd_progress >= 0)
188 ✗ SendMsg2Socket(fd_progress, "unsupported state version!\n");
189 ✗ abort();
190 }
191
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 100 times.
 100 if (state->manager_type != id()) {
192 ✗ if (fd_progress >= 0)
193 ✗ SendMsg2Socket(fd_progress, "switching cache manager unsupported!\n");
194 ✗ abort();
195 }
196 100 const int new_root_fd = DoRestoreState(state->concrete_state);
197
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 100 times.
 100 if (new_root_fd < -1) {
198 ✗ if (fd_progress >= 0)
199 ✗ SendMsg2Socket(fd_progress, "FAILED!\n");
200 ✗ abort();
201 }
202
2/2
✓ Branch 0 taken 92 times.
✓ Branch 1 taken 8 times.
 100 if (fd_progress >= 0)
203
2/4
✓ Branch 2 taken 92 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 92 times.
✗ Branch 6 not taken.
 92 SendMsg2Socket(fd_progress, "done\n");
204 100 return new_root_fd;
205 }
206
207
208 /**
209 * The actual work is done in the concrete cache managers.
210 */
211 100 void *CacheManager::SaveState(const int fd_progress) {
212
2/2
✓ Branch 0 taken 92 times.
✓ Branch 1 taken 8 times.
 100 if (fd_progress >= 0)
213
2/4
✓ Branch 2 taken 92 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 92 times.
✗ Branch 6 not taken.
 92 SendMsg2Socket(fd_progress, "Saving open files table\n");
214 100 State *state = new State();
215 100 state->manager_type = id();
216 100 state->concrete_state = DoSaveState();
217
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 100 times.
 100 if (state->concrete_state == NULL) {
218 ✗ if (fd_progress >= 0) {
219 ✗ SendMsg2Socket(
220 fd_progress,
221 " *** This cache manager does not support saving state!\n");
222 }
223 ✗ abort();
224 }
225 100 return state;
226 }
227