GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/cache_transport.cc
Date: 2025-11-30 02:35:17
Exec Total Coverage
Lines: 326 372 87.6%
Branches: 166 228 72.8%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #include "cache_transport.h"
6
7 #include <alloca.h>
8 #include <errno.h>
9 #include <sys/socket.h>
10
11 #include <cassert>
12 #include <cstdlib>
13 #include <cstring>
14
15 #include "crypto/hash.h"
16 #include "util/exception.h"
17 #include "util/logging.h"
18 #include "util/posix.h"
19 #include "util/smalloc.h"
20
21 // TODO(jblomer): Check for possible starvation of plugin by dying clients
22 // (blocking read). Probably only relevant for TCP sockets.
23
24 using namespace std; // NOLINT
25
26 const char
27 *CacheTransport::kEnvReadyNotifyFd = "__CVMFS_CACHE_EXTERNAL_PIPE_READY__";
28
29 /**
30 * Called on the sender side to wrap a message into a MsgRpc message for wire
31 * transfer.
32 */
33 369034 cvmfs::MsgRpc *CacheTransport::Frame::GetMsgRpc() {
34
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 369034 times.
 369034 assert(msg_typed_ != NULL);
35
1/2
✓ Branch 0 taken 369034 times.
✗ Branch 1 not taken.
 369034 if (!is_wrapped_)
36 369034 WrapMsg();
37 369034 return &msg_rpc_;
38 }
39
40
41 /**
42 * Called on the receiving end of an RPC to extract the actual message from the
43 * MsgRpc.
44 */
45 462160 google::protobuf::MessageLite *CacheTransport::Frame::GetMsgTyped() {
46
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 462160 times.
 462160 assert(msg_rpc_.IsInitialized());
47
2/2
✓ Branch 0 taken 392452 times.
✓ Branch 1 taken 69708 times.
 462160 if (msg_typed_ == NULL)
48 392452 UnwrapMsg();
49 461792 return msg_typed_;
50 }
51
52
53 462252 CacheTransport::Frame::Frame()
54 462206 : owns_msg_typed_(false)
55 462206 , msg_typed_(NULL)
56 462206 , attachment_(NULL)
57 462206 , att_size_(0)
58 462206 , is_wrapped_(false)
59 462252 , is_msg_out_of_band_(false) { }
60
61
62 369034 CacheTransport::Frame::Frame(google::protobuf::MessageLite *m)
63 369034 : owns_msg_typed_(false)
64 369034 , msg_typed_(m)
65 369034 , attachment_(NULL)
66 369034 , att_size_(0)
67 369034 , is_wrapped_(false)
68 369034 , is_msg_out_of_band_(false) { }
69
70
71 831148 CacheTransport::Frame::~Frame() { Reset(0); }
72
73
74 69708 bool CacheTransport::Frame::IsMsgOutOfBand() {
75
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 69708 times.
 69708 assert(msg_rpc_.IsInitialized());
76
1/2
✓ Branch 0 taken 69708 times.
✗ Branch 1 not taken.
 69708 if (msg_typed_ == NULL)
77 69708 UnwrapMsg();
78 69708 return is_msg_out_of_band_;
79 }
80
81
82 93288 void CacheTransport::Frame::MergeFrom(const Frame &other) {
83 93288 msg_rpc_.CheckTypeAndMergeFrom(other.msg_rpc_);
84 93288 owns_msg_typed_ = true;
85
2/2
✓ Branch 0 taken 82800 times.
✓ Branch 1 taken 10488 times.
 93288 if (other.att_size_ > 0) {
86
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 82800 times.
 82800 assert(att_size_ >= other.att_size_);
87 82800 memcpy(attachment_, other.attachment_, other.att_size_);
88 82800 att_size_ = other.att_size_;
89 }
90 93288 }
91
92
93 368918 bool CacheTransport::Frame::ParseMsgRpc(void *buffer, uint32_t size) {
94 368918 const bool retval = msg_rpc_.ParseFromArray(buffer, size);
95
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 368872 times.
 368872 if (!retval)
96 ✗ return false;
97
98 // Cleanup typed message when Frame leaves scope
99 368872 owns_msg_typed_ = true;
100 368872 return true;
101 }
102
103
104 831056 void CacheTransport::Frame::Release() {
105
2/2
✓ Branch 0 taken 462206 times.
✓ Branch 1 taken 368850 times.
 831056 if (owns_msg_typed_)
106 462206 return;
107
108 368850 msg_rpc_.release_msg_refcount_req();
109 369080 msg_rpc_.release_msg_refcount_reply();
110 369034 msg_rpc_.release_msg_read_req();
111 369034 msg_rpc_.release_msg_read_reply();
112 369080 msg_rpc_.release_msg_object_info_req();
113 369080 msg_rpc_.release_msg_object_info_reply();
114 369080 msg_rpc_.release_msg_store_req();
115 369080 msg_rpc_.release_msg_store_abort_req();
116 369080 msg_rpc_.release_msg_store_reply();
117 369080 msg_rpc_.release_msg_handshake();
118 369080 msg_rpc_.release_msg_handshake_ack();
119 369080 msg_rpc_.release_msg_quit();
120 369080 msg_rpc_.release_msg_ioctl();
121 369080 msg_rpc_.release_msg_info_req();
122 369080 msg_rpc_.release_msg_info_reply();
123 369080 msg_rpc_.release_msg_shrink_req();
124 369080 msg_rpc_.release_msg_shrink_reply();
125 369080 msg_rpc_.release_msg_list_req();
126 369080 msg_rpc_.release_msg_list_reply();
127 369034 msg_rpc_.release_msg_detach();
128 369034 msg_rpc_.release_msg_breadcrumb_store_req();
129 369034 msg_rpc_.release_msg_breadcrumb_load_req();
130 369080 msg_rpc_.release_msg_breadcrumb_reply();
131 }
132
133
134 831148 void CacheTransport::Frame::Reset(uint32_t original_att_size) {
135 831148 msg_typed_ = NULL;
136 831148 att_size_ = original_att_size;
137 831148 is_wrapped_ = false;
138 831148 is_msg_out_of_band_ = false;
139 831148 Release();
140 831240 msg_rpc_.Clear();
141 831286 owns_msg_typed_ = false;
142 831286 }
143
144
145 369034 void CacheTransport::Frame::WrapMsg() {
146
2/2
✓ Branch 3 taken 854 times.
✓ Branch 4 taken 368134 times.
 369034 if (msg_typed_->GetTypeName() == "cvmfs.MsgHandshake") {
147 854 msg_rpc_.set_allocated_msg_handshake(
148 854 reinterpret_cast<cvmfs::MsgHandshake *>(msg_typed_));
149
2/2
✓ Branch 3 taken 828 times.
✓ Branch 4 taken 367260 times.
 368134 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgHandshakeAck") {
150 828 msg_rpc_.set_allocated_msg_handshake_ack(
151 828 reinterpret_cast<cvmfs::MsgHandshakeAck *>(msg_typed_));
152
2/2
✓ Branch 3 taken 852 times.
✓ Branch 4 taken 366454 times.
 367260 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgQuit") {
153 852 msg_rpc_.set_allocated_msg_quit(
154 852 reinterpret_cast<cvmfs::MsgQuit *>(msg_typed_));
155
2/2
✓ Branch 3 taken 184 times.
✓ Branch 4 taken 366270 times.
 366454 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgIoctl") {
156 184 msg_rpc_.set_allocated_msg_ioctl(
157 184 reinterpret_cast<cvmfs::MsgIoctl *>(msg_typed_));
158
2/2
✓ Branch 3 taken 28448 times.
✓ Branch 4 taken 337868 times.
 366270 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgRefcountReq") {
159 28448 msg_rpc_.set_allocated_msg_refcount_req(
160 28448 reinterpret_cast<cvmfs::MsgRefcountReq *>(msg_typed_));
161
2/2
✓ Branch 3 taken 25944 times.
✓ Branch 4 taken 311878 times.
 337868 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgRefcountReply") {
162 25944 msg_rpc_.set_allocated_msg_refcount_reply(
163 25944 reinterpret_cast<cvmfs::MsgRefcountReply *>(msg_typed_));
164
2/2
✓ Branch 3 taken 760 times.
✓ Branch 4 taken 311164 times.
 311878 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgObjectInfoReq") {
165 760 msg_rpc_.set_allocated_msg_object_info_req(
166 760 reinterpret_cast<cvmfs::MsgObjectInfoReq *>(msg_typed_));
167
2/2
✓ Branch 3 taken 736 times.
✓ Branch 4 taken 310336 times.
 311164 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgObjectInfoReply") {
168 736 msg_rpc_.set_allocated_msg_object_info_reply(
169 736 reinterpret_cast<cvmfs::MsgObjectInfoReply *>(msg_typed_));
170
2/2
✓ Branch 3 taken 102394 times.
✓ Branch 4 taken 208034 times.
 310336 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgReadReq") {
171 102394 msg_rpc_.set_allocated_msg_read_req(
172 102394 reinterpret_cast<cvmfs::MsgReadReq *>(msg_typed_));
173
2/2
✓ Branch 3 taken 101706 times.
✓ Branch 4 taken 106328 times.
 208034 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgReadReply") {
174 101706 msg_rpc_.set_allocated_msg_read_reply(
175 101706 reinterpret_cast<cvmfs::MsgReadReply *>(msg_typed_));
176
2/2
✓ Branch 3 taken 30382 times.
✓ Branch 4 taken 75946 times.
 106328 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreReq") {
177 30382 msg_rpc_.set_allocated_msg_store_req(
178 30382 reinterpret_cast<cvmfs::MsgStoreReq *>(msg_typed_));
179
2/2
✓ Branch 3 taken 46 times.
✓ Branch 4 taken 75900 times.
 75946 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreAbortReq") {
180 46 msg_rpc_.set_allocated_msg_store_abort_req(
181 46 reinterpret_cast<cvmfs::MsgStoreAbortReq *>(msg_typed_));
182
2/2
✓ Branch 3 taken 28014 times.
✓ Branch 4 taken 47886 times.
 75900 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreReply") {
183 28014 msg_rpc_.set_allocated_msg_store_reply(
184 28014 reinterpret_cast<cvmfs::MsgStoreReply *>(msg_typed_));
185
2/2
✓ Branch 3 taken 208 times.
✓ Branch 4 taken 47678 times.
 47886 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgInfoReq") {
186 208 msg_rpc_.set_allocated_msg_info_req(
187 208 reinterpret_cast<cvmfs::MsgInfoReq *>(msg_typed_));
188
2/2
✓ Branch 3 taken 184 times.
✓ Branch 4 taken 47494 times.
 47678 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgInfoReply") {
189 184 msg_rpc_.set_allocated_msg_info_reply(
190 184 reinterpret_cast<cvmfs::MsgInfoReply *>(msg_typed_));
191
2/2
✓ Branch 3 taken 100 times.
✓ Branch 4 taken 47394 times.
 47494 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgShrinkReq") {
192 100 msg_rpc_.set_allocated_msg_shrink_req(
193 100 reinterpret_cast<cvmfs::MsgShrinkReq *>(msg_typed_));
194
2/2
✓ Branch 3 taken 92 times.
✓ Branch 4 taken 47302 times.
 47394 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgShrinkReply") {
195 92 msg_rpc_.set_allocated_msg_shrink_reply(
196 92 reinterpret_cast<cvmfs::MsgShrinkReply *>(msg_typed_));
197
2/2
✓ Branch 3 taken 468 times.
✓ Branch 4 taken 46834 times.
 47302 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgListReq") {
198 468 msg_rpc_.set_allocated_msg_list_req(
199 468 reinterpret_cast<cvmfs::MsgListReq *>(msg_typed_));
200
2/2
✓ Branch 3 taken 460 times.
✓ Branch 4 taken 46374 times.
 46834 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgListReply") {
201 460 msg_rpc_.set_allocated_msg_list_reply(
202 460 reinterpret_cast<cvmfs::MsgListReply *>(msg_typed_));
203
2/2
✓ Branch 3 taken 48 times.
✓ Branch 4 taken 46326 times.
 46374 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbStoreReq") {
204 48 msg_rpc_.set_allocated_msg_breadcrumb_store_req(
205 48 reinterpret_cast<cvmfs::MsgBreadcrumbStoreReq *>(msg_typed_));
206
2/2
✓ Branch 3 taken 96 times.
✓ Branch 4 taken 46230 times.
 46326 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbLoadReq") {
207 96 msg_rpc_.set_allocated_msg_breadcrumb_load_req(
208 96 reinterpret_cast<cvmfs::MsgBreadcrumbLoadReq *>(msg_typed_));
209
2/2
✓ Branch 3 taken 138 times.
✓ Branch 4 taken 46092 times.
 46230 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbReply") {
210 138 msg_rpc_.set_allocated_msg_breadcrumb_reply(
211 138 reinterpret_cast<cvmfs::MsgBreadcrumbReply *>(msg_typed_));
212
1/2
✓ Branch 3 taken 46092 times.
✗ Branch 4 not taken.
 46092 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgDetach") {
213 46092 msg_rpc_.set_allocated_msg_detach(
214 46092 reinterpret_cast<cvmfs::MsgDetach *>(msg_typed_));
215 46092 is_msg_out_of_band_ = true;
216 } else {
217 // Unexpected message type, should never happen
218 ✗ PANIC(NULL);
219 }
220 369034 is_wrapped_ = true;
221 369034 }
222
223
224 462114 void CacheTransport::Frame::UnwrapMsg() {
225
2/2
✓ Branch 1 taken 828 times.
✓ Branch 2 taken 461286 times.
 462114 if (msg_rpc_.has_msg_handshake()) {
226 828 msg_typed_ = msg_rpc_.mutable_msg_handshake();
227
2/2
✓ Branch 1 taken 854 times.
✓ Branch 2 taken 460524 times.
 461286 } else if (msg_rpc_.has_msg_handshake_ack()) {
228 854 msg_typed_ = msg_rpc_.mutable_msg_handshake_ack();
229
2/2
✓ Branch 1 taken 828 times.
✓ Branch 2 taken 459650 times.
 460524 } else if (msg_rpc_.has_msg_quit()) {
230 828 msg_typed_ = msg_rpc_.mutable_msg_quit();
231
2/2
✓ Branch 1 taken 184 times.
✓ Branch 2 taken 459466 times.
 459650 } else if (msg_rpc_.has_msg_ioctl()) {
232 184 msg_typed_ = msg_rpc_.mutable_msg_ioctl();
233
2/2
✓ Branch 1 taken 25944 times.
✓ Branch 2 taken 433430 times.
 459466 } else if (msg_rpc_.has_msg_refcount_req()) {
234 25944 msg_typed_ = msg_rpc_.mutable_msg_refcount_req();
235
2/2
✓ Branch 1 taken 29322 times.
✓ Branch 2 taken 404246 times.
 433430 } else if (msg_rpc_.has_msg_refcount_reply()) {
236 29322 msg_typed_ = msg_rpc_.mutable_msg_refcount_reply();
237
2/2
✓ Branch 1 taken 736 times.
✓ Branch 2 taken 403188 times.
 404246 } else if (msg_rpc_.has_msg_object_info_req()) {
238 736 msg_typed_ = msg_rpc_.mutable_msg_object_info_req();
239
2/2
✓ Branch 1 taken 1174 times.
✓ Branch 2 taken 402106 times.
 403188 } else if (msg_rpc_.has_msg_object_info_reply()) {
240 1174 msg_typed_ = msg_rpc_.mutable_msg_object_info_reply();
241
2/2
✓ Branch 1 taken 101706 times.
✓ Branch 2 taken 300354 times.
 402106 } else if (msg_rpc_.has_msg_read_req()) {
242 101706 msg_typed_ = msg_rpc_.mutable_msg_read_req();
243
2/2
✓ Branch 1 taken 185194 times.
✓ Branch 2 taken 115482 times.
 300354 } else if (msg_rpc_.has_msg_read_reply()) {
244 185194 msg_typed_ = msg_rpc_.mutable_msg_read_reply();
245
2/2
✓ Branch 1 taken 27968 times.
✓ Branch 2 taken 87514 times.
 115482 } else if (msg_rpc_.has_msg_store_req()) {
246 27968 msg_typed_ = msg_rpc_.mutable_msg_store_req();
247
2/2
✓ Branch 1 taken 46 times.
✓ Branch 2 taken 87468 times.
 87514 } else if (msg_rpc_.has_msg_store_abort_req()) {
248 46 msg_typed_ = msg_rpc_.mutable_msg_store_abort_req();
249
2/2
✓ Branch 1 taken 39628 times.
✓ Branch 2 taken 47840 times.
 87468 } else if (msg_rpc_.has_msg_store_reply()) {
250 39628 msg_typed_ = msg_rpc_.mutable_msg_store_reply();
251
2/2
✓ Branch 1 taken 184 times.
✓ Branch 2 taken 47656 times.
 47840 } else if (msg_rpc_.has_msg_info_req()) {
252 184 msg_typed_ = msg_rpc_.mutable_msg_info_req();
253
2/2
✓ Branch 1 taken 208 times.
✓ Branch 2 taken 47448 times.
 47656 } else if (msg_rpc_.has_msg_info_reply()) {
254 208 msg_typed_ = msg_rpc_.mutable_msg_info_reply();
255
2/2
✓ Branch 1 taken 92 times.
✓ Branch 2 taken 47356 times.
 47448 } else if (msg_rpc_.has_msg_shrink_req()) {
256 92 msg_typed_ = msg_rpc_.mutable_msg_shrink_req();
257
2/2
✓ Branch 1 taken 100 times.
✓ Branch 2 taken 47256 times.
 47356 } else if (msg_rpc_.has_msg_shrink_reply()) {
258 100 msg_typed_ = msg_rpc_.mutable_msg_shrink_reply();
259
2/2
✓ Branch 1 taken 460 times.
✓ Branch 2 taken 46796 times.
 47256 } else if (msg_rpc_.has_msg_list_req()) {
260 460 msg_typed_ = msg_rpc_.mutable_msg_list_req();
261
2/2
✓ Branch 1 taken 468 times.
✓ Branch 2 taken 46328 times.
 46796 } else if (msg_rpc_.has_msg_list_reply()) {
262 468 msg_typed_ = msg_rpc_.mutable_msg_list_reply();
263
2/2
✓ Branch 1 taken 46 times.
✓ Branch 2 taken 46282 times.
 46328 } else if (msg_rpc_.has_msg_breadcrumb_store_req()) {
264 46 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_store_req();
265
2/2
✓ Branch 1 taken 92 times.
✓ Branch 2 taken 46190 times.
 46282 } else if (msg_rpc_.has_msg_breadcrumb_load_req()) {
266 92 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_load_req();
267
2/2
✓ Branch 1 taken 144 times.
✓ Branch 2 taken 46046 times.
 46190 } else if (msg_rpc_.has_msg_breadcrumb_reply()) {
268 144 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_reply();
269
1/2
✓ Branch 1 taken 46046 times.
✗ Branch 2 not taken.
 46046 } else if (msg_rpc_.has_msg_detach()) {
270 46046 msg_typed_ = msg_rpc_.mutable_msg_detach();
271 46046 is_msg_out_of_band_ = true;
272 } else {
273 // Unexpected message type, should never happen
274 ✗ PANIC(NULL);
275 }
276 462252 }
277
278
279 //------------------------------------------------------------------------------
280
281
282 854 CacheTransport::CacheTransport(int fd_connection)
283 854 : fd_connection_(fd_connection), flags_(0) {
284
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 854 times.
 854 assert(fd_connection_ >= 0);
285 854 }
286
287
288 205206 CacheTransport::CacheTransport(int fd_connection, uint32_t flags)
289 205206 : fd_connection_(fd_connection), flags_(flags) {
290
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 205206 times.
 205206 assert(fd_connection_ >= 0);
291 205206 }
292
293
294 9260774 void CacheTransport::FillMsgHash(const shash::Any &hash,
295 cvmfs::MsgHash *msg_hash) {
296
3/4
✓ Branch 0 taken 9260656 times.
✓ Branch 1 taken 12 times.
✓ Branch 2 taken 106 times.
✗ Branch 3 not taken.
 9260774 switch (hash.algorithm) {
297 9260656 case shash::kSha1:
298 9260656 msg_hash->set_algorithm(cvmfs::HASH_SHA1);
299 9260656 break;
300 12 case shash::kRmd160:
301 12 msg_hash->set_algorithm(cvmfs::HASH_RIPEMD160);
302 12 break;
303 106 case shash::kShake128:
304 106 msg_hash->set_algorithm(cvmfs::HASH_SHAKE128);
305 106 break;
306 ✗ default:
307 ✗ PANIC(NULL);
308 }
309 9260774 msg_hash->set_digest(hash.digest, shash::kDigestSizes[hash.algorithm]);
310 9260774 }
311
312
313 30374 void CacheTransport::FillObjectType(int object_flags,
314 cvmfs::EnumObjectType *wire_type) {
315 30374 *wire_type = cvmfs::OBJECT_REGULAR;
316
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 30374 times.
 30374 if (object_flags & CacheManager::kLabelCatalog)
317 ✗ *wire_type = cvmfs::OBJECT_CATALOG;
318
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 30374 times.
 30374 if (object_flags & CacheManager::kLabelVolatile)
319 ✗ *wire_type = cvmfs::OBJECT_VOLATILE;
320 30374 }
321
322
323 156448 bool CacheTransport::ParseMsgHash(const cvmfs::MsgHash &msg_hash,
324 shash::Any *hash) {
325
2/4
✓ Branch 1 taken 156354 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 94 times.
✗ Branch 4 not taken.
 156448 switch (msg_hash.algorithm()) {
326 156354 case cvmfs::HASH_SHA1:
327 156354 hash->algorithm = shash::kSha1;
328 156354 break;
329 ✗ case cvmfs::HASH_RIPEMD160:
330 ✗ hash->algorithm = shash::kRmd160;
331 ✗ break;
332 94 case cvmfs::HASH_SHAKE128:
333 94 hash->algorithm = shash::kShake128;
334 94 break;
335 ✗ default:
336 ✗ return false;
337 }
338 156448 const unsigned digest_size = shash::kDigestSizes[hash->algorithm];
339
1/2
✗ Branch 2 not taken.
✓ Branch 3 taken 156448 times.
 156448 if (msg_hash.digest().length() != digest_size)
340 ✗ return false;
341 156448 memcpy(hash->digest, msg_hash.digest().data(), digest_size);
342 156448 return true;
343 }
344
345
346 ✗ bool CacheTransport::ParseObjectType(cvmfs::EnumObjectType wire_type,
347 int *object_flags) {
348 ✗ *object_flags = 0;
349 ✗ switch (wire_type) {
350 ✗ case cvmfs::OBJECT_REGULAR:
351 ✗ return true;
352 ✗ case cvmfs::OBJECT_CATALOG:
353 ✗ *object_flags |= CacheManager::kLabelCatalog;
354 ✗ return true;
355 ✗ case cvmfs::OBJECT_VOLATILE:
356 ✗ *object_flags |= CacheManager::kLabelVolatile;
357 ✗ return true;
358 ✗ default:
359 ✗ return false;
360 }
361 }
362
363
364 369010 bool CacheTransport::RecvFrame(CacheTransport::Frame *frame) {
365 uint32_t size;
366 bool has_attachment;
367
1/2
✓ Branch 1 taken 369010 times.
✗ Branch 2 not taken.
 369010 bool retval = RecvHeader(&size, &has_attachment);
368
2/2
✓ Branch 0 taken 46 times.
✓ Branch 1 taken 368964 times.
 369010 if (!retval)
369 46 return false;
370
371 void *buffer;
372
2/2
✓ Branch 0 taken 238996 times.
✓ Branch 1 taken 129968 times.
 368964 if (size <= kMaxStackAlloc)
373 238996 buffer = alloca(size);
374 else
375 129968 buffer = smalloc(size);
376
1/2
✓ Branch 1 taken 368964 times.
✗ Branch 2 not taken.
 368964 const ssize_t nbytes = SafeRead(fd_connection_, buffer, size);
377
2/4
✓ Branch 0 taken 368964 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 368964 times.
 368964 if ((nbytes < 0) || (static_cast<uint32_t>(nbytes) != size)) {
378 ✗ if (size > kMaxStackAlloc) {
379 ✗ free(buffer);
380 }
381 ✗ return false;
382 }
383
384 368964 uint32_t msg_size = size;
385
2/2
✓ Branch 0 taken 130264 times.
✓ Branch 1 taken 238700 times.
 368964 if (has_attachment) {
386
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 130264 times.
 130264 if (size < 2) {
387 // kMaxStackAlloc is > 2 (of course!) but we'll leave the condition here
388 // for consistency.
389 ✗ if (size > kMaxStackAlloc) {
390 ✗ free(buffer);
391 }
392 ✗ return false;
393 }
394 130264 msg_size = (*reinterpret_cast<unsigned char *>(buffer))
395 130264 + ((*(reinterpret_cast<unsigned char *>(buffer) + 1)) << 8);
396
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 130264 times.
 130264 if ((msg_size + kInnerHeaderSize) > size) {
397 ✗ if (size > kMaxStackAlloc) {
398 ✗ free(buffer);
399 }
400 ✗ return false;
401 }
402 }
403
404 368964 void *ptr_msg = has_attachment
405
2/2
✓ Branch 0 taken 130264 times.
✓ Branch 1 taken 238700 times.
 368964 ? (reinterpret_cast<char *>(buffer) + kInnerHeaderSize)
406 : buffer;
407
1/2
✓ Branch 1 taken 368918 times.
✗ Branch 2 not taken.
 368964 retval = frame->ParseMsgRpc(ptr_msg, msg_size);
408
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 368918 times.
 368918 if (!retval) {
409 ✗ if (size > kMaxStackAlloc) {
410 ✗ free(buffer);
411 }
412 ✗ return false;
413 }
414
415
2/2
✓ Branch 0 taken 130264 times.
✓ Branch 1 taken 238654 times.
 368918 if (has_attachment) {
416 130264 const uint32_t attachment_size = size - (msg_size + kInnerHeaderSize);
417
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 130264 times.
 130264 if (frame->att_size() < attachment_size) {
418 ✗ if (size > kMaxStackAlloc) {
419 ✗ free(buffer);
420 }
421 ✗ return false;
422 }
423 130264 void *ptr_attachment = reinterpret_cast<char *>(buffer) + kInnerHeaderSize
424 130264 + msg_size;
425 130264 memcpy(frame->attachment(), ptr_attachment, attachment_size);
426 130264 frame->set_att_size(attachment_size);
427 } else {
428 238654 frame->set_att_size(0);
429 }
430
2/2
✓ Branch 0 taken 129968 times.
✓ Branch 1 taken 238996 times.
 368964 if (size > kMaxStackAlloc) {
431 129968 free(buffer);
432 }
433 368964 return true;
434 }
435
436
437 369010 bool CacheTransport::RecvHeader(uint32_t *size, bool *has_attachment) {
438 unsigned char header[kHeaderSize];
439
1/2
✓ Branch 1 taken 369010 times.
✗ Branch 2 not taken.
 369010 const ssize_t nbytes = SafeRead(fd_connection_, header, kHeaderSize);
440
3/4
✓ Branch 0 taken 369010 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 46 times.
✓ Branch 3 taken 368964 times.
 369010 if ((nbytes < 0) || (static_cast<unsigned>(nbytes) != kHeaderSize))
441 46 return false;
442
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 368964 times.
 368964 if ((header[0] & (~kFlagHasAttachment)) != kWireProtocolVersion)
443 ✗ return false;
444 368964 *has_attachment = header[0] & kFlagHasAttachment;
445 368964 *size = header[1] + (header[2] << 8) + (header[3] << 16);
446
2/4
✓ Branch 0 taken 368964 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 368964 times.
✗ Branch 3 not taken.
 368964 return (*size > 0) && (*size <= kMaxMsgSize);
447 }
448
449
450 368942 void CacheTransport::SendData(void *message,
451 uint32_t msg_size,
452 void *attachment,
453 uint32_t att_size) {
454 737884 const uint32_t total_size = msg_size + att_size
455
2/2
✓ Branch 0 taken 131994 times.
✓ Branch 1 taken 236948 times.
 368942 + ((att_size > 0) ? kInnerHeaderSize : 0);
456
457
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 368942 times.
 368942 assert(total_size > 0);
458
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 368942 times.
 368942 assert(total_size <= kMaxMsgSize);
459
1/2
✓ Branch 1 taken 363308 times.
✗ Branch 2 not taken.
 363216 LogCvmfs(kLogCache, kLogDebug,
460 "sending message of size %u to cache transport", total_size);
461
462 unsigned char header[kHeaderSize];
463
2/2
✓ Branch 0 taken 237040 times.
✓ Branch 1 taken 131994 times.
 369034 header[0] = kWireProtocolVersion | ((att_size == 0) ? 0 : kFlagHasAttachment);
464 369034 header[1] = (total_size & 0x000000FF);
465 369034 header[2] = (total_size & 0x0000FF00) >> 8;
466 369034 header[3] = (total_size & 0x00FF0000) >> 16;
467 // Only transferred if an attachment is present. Otherwise the overall size
468 // is also the size of the protobuf message.
469 unsigned char inner_header[kInnerHeaderSize];
470
471 struct iovec iov[4];
472 369034 iov[0].iov_base = header;
473 369034 iov[0].iov_len = kHeaderSize;
474
475
2/2
✓ Branch 0 taken 131994 times.
✓ Branch 1 taken 237040 times.
 369034 if (att_size > 0) {
476 131994 inner_header[0] = (msg_size & 0x000000FF);
477 131994 inner_header[1] = (msg_size & 0x0000FF00) >> 8;
478 131994 iov[1].iov_base = inner_header;
479 131994 iov[1].iov_len = kInnerHeaderSize;
480 131994 iov[2].iov_base = message;
481 131994 iov[2].iov_len = msg_size;
482 131994 iov[3].iov_base = attachment;
483 131994 iov[3].iov_len = att_size;
484 } else {
485 237040 iov[1].iov_base = message;
486 237040 iov[1].iov_len = msg_size;
487 }
488
2/2
✓ Branch 0 taken 46092 times.
✓ Branch 1 taken 322942 times.
 369034 if (flags_ & kFlagSendNonBlocking) {
489
2/4
✓ Branch 0 taken 46092 times.
✗ Branch 1 not taken.
✓ Branch 3 taken 46092 times.
✗ Branch 4 not taken.
 46092 SendNonBlocking(iov, (att_size == 0) ? 2 : 4);
490 46092 return;
491 }
492
3/4
✓ Branch 0 taken 190948 times.
✓ Branch 1 taken 131994 times.
✓ Branch 3 taken 322850 times.
✗ Branch 4 not taken.
 322942 const bool retval = SafeWriteV(fd_connection_, iov, (att_size == 0) ? 2 : 4);
493
494
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 322850 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 322850 if (!retval && !(flags_ & kFlagSendIgnoreFailure)) {
495 ✗ PANIC(kLogSyslogErr | kLogDebug,
496 "failed to write to external cache transport (%d), aborting", errno);
497 }
498 }
499
500 46092 void CacheTransport::SendNonBlocking(struct iovec *iov, unsigned iovcnt) {
501
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 46092 times.
 46092 assert(iovcnt > 0);
502 46092 unsigned total_size = 0;
503
2/2
✓ Branch 0 taken 92184 times.
✓ Branch 1 taken 46092 times.
 138276 for (unsigned i = 0; i < iovcnt; ++i)
504 92184 total_size += iov[i].iov_len;
505 46092 unsigned char *buffer = reinterpret_cast<unsigned char *>(alloca(total_size));
506
507 46092 unsigned pos = 0;
508
2/2
✓ Branch 0 taken 92184 times.
✓ Branch 1 taken 46092 times.
 138276 for (unsigned i = 0; i < iovcnt; ++i) {
509 92184 memcpy(buffer + pos, iov[i].iov_base, iov[i].iov_len);
510 92184 pos += iov[i].iov_len;
511 }
512
513 46092 const int retval = send(fd_connection_, buffer, total_size, MSG_DONTWAIT);
514
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 46092 times.
 46092 if (retval < 0) {
515 ✗ assert(errno != EMSGSIZE);
516 ✗ if (!(flags_ & kFlagSendIgnoreFailure)) {
517 ✗ PANIC(kLogSyslogErr | kLogDebug,
518 "failed to write to external cache transport (%d), aborting",
519 errno);
520 }
521 }
522 46092 }
523
524
525 369034 void CacheTransport::SendFrame(CacheTransport::Frame *frame) {
526 369034 cvmfs::MsgRpc *msg_rpc = frame->GetMsgRpc();
527 369034 const int32_t size = msg_rpc->ByteSize();
528
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 369034 times.
 369034 assert(size > 0);
529 #ifdef __APPLE__
530 void *buffer = smalloc(size);
531 #else
532 369034 void *buffer = alloca(size);
533 #endif
534 369034 const bool retval = msg_rpc->SerializeToArray(buffer, size);
535
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 369034 times.
 369034 assert(retval);
536 369034 SendData(buffer, size, frame->attachment(), frame->att_size());
537 #ifdef __APPLE__
538 free(buffer);
539 #endif
540 368850 }
541