GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/cache_transport.cc
Date: 2026-01-25 02:35:50
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 234752 cvmfs::MsgRpc *CacheTransport::Frame::GetMsgRpc() {
34
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 234752 times.
 234752 assert(msg_typed_ != NULL);
35
1/2
✓ Branch 0 taken 234752 times.
✗ Branch 1 not taken.
 234752 if (!is_wrapped_)
36 234752 WrapMsg();
37 234752 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 293337 google::protobuf::MessageLite *CacheTransport::Frame::GetMsgTyped() {
46
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 293482 times.
 293337 assert(msg_rpc_.IsInitialized());
47
2/2
✓ Branch 0 taken 247425 times.
✓ Branch 1 taken 46057 times.
 293482 if (msg_typed_ == NULL)
48 247425 UnwrapMsg();
49 292786 return msg_typed_;
50 }
51
52
53 293424 CacheTransport::Frame::Frame()
54 293482 : owns_msg_typed_(false)
55 293482 , msg_typed_(NULL)
56 293482 , attachment_(NULL)
57 293482 , att_size_(0)
58 293482 , is_wrapped_(false)
59 293424 , is_msg_out_of_band_(false) { }
60
61
62 234752 CacheTransport::Frame::Frame(google::protobuf::MessageLite *m)
63 234723 : owns_msg_typed_(false)
64 234723 , msg_typed_(m)
65 234723 , attachment_(NULL)
66 234723 , att_size_(0)
67 234723 , is_wrapped_(false)
68 234752 , is_msg_out_of_band_(false) { }
69
70
71 528205 CacheTransport::Frame::~Frame() { Reset(0); }
72
73
74 46057 bool CacheTransport::Frame::IsMsgOutOfBand() {
75
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 46057 times.
 46057 assert(msg_rpc_.IsInitialized());
76
1/2
✓ Branch 0 taken 46057 times.
✗ Branch 1 not taken.
 46057 if (msg_typed_ == NULL)
77 46057 UnwrapMsg();
78 46057 return is_msg_out_of_band_;
79 }
80
81
82 58812 void CacheTransport::Frame::MergeFrom(const Frame &other) {
83 58812 msg_rpc_.CheckTypeAndMergeFrom(other.msg_rpc_);
84 58812 owns_msg_typed_ = true;
85
2/2
✓ Branch 0 taken 52200 times.
✓ Branch 1 taken 6612 times.
 58812 if (other.att_size_ > 0) {
86
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 52200 times.
 52200 assert(att_size_ >= other.att_size_);
87 52200 memcpy(attachment_, other.attachment_, other.att_size_);
88 52200 att_size_ = other.att_size_;
89 }
90 58812 }
91
92
93 234728 bool CacheTransport::Frame::ParseMsgRpc(void *buffer, uint32_t size) {
94 234728 const bool retval = msg_rpc_.ParseFromArray(buffer, size);
95
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 234728 times.
 234728 if (!retval)
96 ✗ return false;
97
98 // Cleanup typed message when Frame leaves scope
99 234728 owns_msg_typed_ = true;
100 234728 return true;
101 }
102
103
104 528176 void CacheTransport::Frame::Release() {
105
2/2
✓ Branch 0 taken 293482 times.
✓ Branch 1 taken 234694 times.
 528176 if (owns_msg_typed_)
106 293482 return;
107
108 234694 msg_rpc_.release_msg_refcount_req();
109 234723 msg_rpc_.release_msg_refcount_reply();
110 234723 msg_rpc_.release_msg_read_req();
111 234752 msg_rpc_.release_msg_read_reply();
112 234752 msg_rpc_.release_msg_object_info_req();
113 234781 msg_rpc_.release_msg_object_info_reply();
114 234810 msg_rpc_.release_msg_store_req();
115 234752 msg_rpc_.release_msg_store_abort_req();
116 234752 msg_rpc_.release_msg_store_reply();
117 234752 msg_rpc_.release_msg_handshake();
118 234781 msg_rpc_.release_msg_handshake_ack();
119 234781 msg_rpc_.release_msg_quit();
120 234810 msg_rpc_.release_msg_ioctl();
121 234781 msg_rpc_.release_msg_info_req();
122 234810 msg_rpc_.release_msg_info_reply();
123 234810 msg_rpc_.release_msg_shrink_req();
124 234810 msg_rpc_.release_msg_shrink_reply();
125 234752 msg_rpc_.release_msg_list_req();
126 234781 msg_rpc_.release_msg_list_reply();
127 234781 msg_rpc_.release_msg_detach();
128 234781 msg_rpc_.release_msg_breadcrumb_store_req();
129 234781 msg_rpc_.release_msg_breadcrumb_load_req();
130 234810 msg_rpc_.release_msg_breadcrumb_reply();
131 }
132
133
134 528234 void CacheTransport::Frame::Reset(uint32_t original_att_size) {
135 528234 msg_typed_ = NULL;
136 528234 att_size_ = original_att_size;
137 528234 is_wrapped_ = false;
138 528234 is_msg_out_of_band_ = false;
139 528234 Release();
140 528176 msg_rpc_.Clear();
141 528089 owns_msg_typed_ = false;
142 528089 }
143
144
145 234752 void CacheTransport::Frame::WrapMsg() {
146
2/2
✓ Branch 3 taken 548 times.
✓ Branch 4 taken 234233 times.
 234752 if (msg_typed_->GetTypeName() == "cvmfs.MsgHandshake") {
147 548 msg_rpc_.set_allocated_msg_handshake(
148 548 reinterpret_cast<cvmfs::MsgHandshake *>(msg_typed_));
149
2/2
✓ Branch 3 taken 522 times.
✓ Branch 4 taken 233711 times.
 234233 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgHandshakeAck") {
150 522 msg_rpc_.set_allocated_msg_handshake_ack(
151 522 reinterpret_cast<cvmfs::MsgHandshakeAck *>(msg_typed_));
152
2/2
✓ Branch 3 taken 546 times.
✓ Branch 4 taken 233165 times.
 233711 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgQuit") {
153 546 msg_rpc_.set_allocated_msg_quit(
154 546 reinterpret_cast<cvmfs::MsgQuit *>(msg_typed_));
155
2/2
✓ Branch 3 taken 116 times.
✓ Branch 4 taken 233049 times.
 233165 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgIoctl") {
156 116 msg_rpc_.set_allocated_msg_ioctl(
157 116 reinterpret_cast<cvmfs::MsgIoctl *>(msg_typed_));
158
2/2
✓ Branch 3 taken 18860 times.
✓ Branch 4 taken 214160 times.
 233049 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgRefcountReq") {
159 18860 msg_rpc_.set_allocated_msg_refcount_req(
160 18860 reinterpret_cast<cvmfs::MsgRefcountReq *>(msg_typed_));
161
2/2
✓ Branch 3 taken 16356 times.
✓ Branch 4 taken 197833 times.
 214160 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgRefcountReply") {
162 16356 msg_rpc_.set_allocated_msg_refcount_reply(
163 16356 reinterpret_cast<cvmfs::MsgRefcountReply *>(msg_typed_));
164
2/2
✓ Branch 3 taken 488 times.
✓ Branch 4 taken 197345 times.
 197833 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgObjectInfoReq") {
165 488 msg_rpc_.set_allocated_msg_object_info_req(
166 488 reinterpret_cast<cvmfs::MsgObjectInfoReq *>(msg_typed_));
167
2/2
✓ Branch 3 taken 464 times.
✓ Branch 4 taken 196852 times.
 197345 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgObjectInfoReply") {
168 464 msg_rpc_.set_allocated_msg_object_info_reply(
169 464 reinterpret_cast<cvmfs::MsgObjectInfoReply *>(msg_typed_));
170
2/2
✓ Branch 3 taken 64820 times.
✓ Branch 4 taken 132061 times.
 196852 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgReadReq") {
171 64820 msg_rpc_.set_allocated_msg_read_req(
172 64820 reinterpret_cast<cvmfs::MsgReadReq *>(msg_typed_));
173
2/2
✓ Branch 3 taken 64119 times.
✓ Branch 4 taken 67942 times.
 132061 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgReadReply") {
174 64119 msg_rpc_.set_allocated_msg_read_reply(
175 64119 reinterpret_cast<cvmfs::MsgReadReply *>(msg_typed_));
176
2/2
✓ Branch 3 taken 20046 times.
✓ Branch 4 taken 47896 times.
 67942 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreReq") {
177 20046 msg_rpc_.set_allocated_msg_store_req(
178 20046 reinterpret_cast<cvmfs::MsgStoreReq *>(msg_typed_));
179
2/2
✓ Branch 3 taken 29 times.
✓ Branch 4 taken 47867 times.
 47896 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreAbortReq") {
180 29 msg_rpc_.set_allocated_msg_store_abort_req(
181 29 reinterpret_cast<cvmfs::MsgStoreAbortReq *>(msg_typed_));
182
2/2
✓ Branch 3 taken 17661 times.
✓ Branch 4 taken 30206 times.
 47867 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreReply") {
183 17661 msg_rpc_.set_allocated_msg_store_reply(
184 17661 reinterpret_cast<cvmfs::MsgStoreReply *>(msg_typed_));
185
2/2
✓ Branch 3 taken 140 times.
✓ Branch 4 taken 30066 times.
 30206 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgInfoReq") {
186 140 msg_rpc_.set_allocated_msg_info_req(
187 140 reinterpret_cast<cvmfs::MsgInfoReq *>(msg_typed_));
188
2/2
✓ Branch 3 taken 116 times.
✓ Branch 4 taken 29950 times.
 30066 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgInfoReply") {
189 116 msg_rpc_.set_allocated_msg_info_reply(
190 116 reinterpret_cast<cvmfs::MsgInfoReply *>(msg_typed_));
191
2/2
✓ Branch 3 taken 66 times.
✓ Branch 4 taken 29884 times.
 29950 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgShrinkReq") {
192 66 msg_rpc_.set_allocated_msg_shrink_req(
193 66 reinterpret_cast<cvmfs::MsgShrinkReq *>(msg_typed_));
194
2/2
✓ Branch 3 taken 58 times.
✓ Branch 4 taken 29826 times.
 29884 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgShrinkReply") {
195 58 msg_rpc_.set_allocated_msg_shrink_reply(
196 58 reinterpret_cast<cvmfs::MsgShrinkReply *>(msg_typed_));
197
2/2
✓ Branch 3 taken 298 times.
✓ Branch 4 taken 29528 times.
 29826 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgListReq") {
198 298 msg_rpc_.set_allocated_msg_list_req(
199 298 reinterpret_cast<cvmfs::MsgListReq *>(msg_typed_));
200
2/2
✓ Branch 3 taken 290 times.
✓ Branch 4 taken 29238 times.
 29528 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgListReply") {
201 290 msg_rpc_.set_allocated_msg_list_reply(
202 290 reinterpret_cast<cvmfs::MsgListReply *>(msg_typed_));
203
2/2
✓ Branch 3 taken 31 times.
✓ Branch 4 taken 29207 times.
 29238 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbStoreReq") {
204 31 msg_rpc_.set_allocated_msg_breadcrumb_store_req(
205 31 reinterpret_cast<cvmfs::MsgBreadcrumbStoreReq *>(msg_typed_));
206
2/2
✓ Branch 3 taken 62 times.
✓ Branch 4 taken 29145 times.
 29207 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbLoadReq") {
207 62 msg_rpc_.set_allocated_msg_breadcrumb_load_req(
208 62 reinterpret_cast<cvmfs::MsgBreadcrumbLoadReq *>(msg_typed_));
209
2/2
✓ Branch 3 taken 87 times.
✓ Branch 4 taken 29058 times.
 29145 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbReply") {
210 87 msg_rpc_.set_allocated_msg_breadcrumb_reply(
211 87 reinterpret_cast<cvmfs::MsgBreadcrumbReply *>(msg_typed_));
212
1/2
✓ Branch 3 taken 29058 times.
✗ Branch 4 not taken.
 29058 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgDetach") {
213 29058 msg_rpc_.set_allocated_msg_detach(
214 29058 reinterpret_cast<cvmfs::MsgDetach *>(msg_typed_));
215 29058 is_msg_out_of_band_ = true;
216 } else {
217 // Unexpected message type, should never happen
218 ✗ PANIC(NULL);
219 }
220 234781 is_wrapped_ = true;
221 234781 }
222
223
224 293511 void CacheTransport::Frame::UnwrapMsg() {
225
2/2
✓ Branch 1 taken 522 times.
✓ Branch 2 taken 292757 times.
 293511 if (msg_rpc_.has_msg_handshake()) {
226 522 msg_typed_ = msg_rpc_.mutable_msg_handshake();
227
2/2
✓ Branch 1 taken 548 times.
✓ Branch 2 taken 292267 times.
 292757 } else if (msg_rpc_.has_msg_handshake_ack()) {
228 548 msg_typed_ = msg_rpc_.mutable_msg_handshake_ack();
229
2/2
✓ Branch 1 taken 522 times.
✓ Branch 2 taken 291803 times.
 292267 } else if (msg_rpc_.has_msg_quit()) {
230 522 msg_typed_ = msg_rpc_.mutable_msg_quit();
231
2/2
✓ Branch 1 taken 116 times.
✓ Branch 2 taken 291745 times.
 291803 } else if (msg_rpc_.has_msg_ioctl()) {
232 116 msg_typed_ = msg_rpc_.mutable_msg_ioctl();
233
2/2
✓ Branch 1 taken 16356 times.
✓ Branch 2 taken 275012 times.
 291745 } else if (msg_rpc_.has_msg_refcount_req()) {
234 16356 msg_typed_ = msg_rpc_.mutable_msg_refcount_req();
235
2/2
✓ Branch 1 taken 19411 times.
✓ Branch 2 taken 255688 times.
 275012 } else if (msg_rpc_.has_msg_refcount_reply()) {
236 19411 msg_typed_ = msg_rpc_.mutable_msg_refcount_reply();
237
2/2
✓ Branch 1 taken 464 times.
✓ Branch 2 taken 254992 times.
 255688 } else if (msg_rpc_.has_msg_object_info_req()) {
238 464 msg_typed_ = msg_rpc_.mutable_msg_object_info_req();
239
2/2
✓ Branch 1 taken 749 times.
✓ Branch 2 taken 254446 times.
 254992 } else if (msg_rpc_.has_msg_object_info_reply()) {
240 749 msg_typed_ = msg_rpc_.mutable_msg_object_info_reply();
241
2/2
✓ Branch 1 taken 64119 times.
✓ Branch 2 taken 190443 times.
 254446 } else if (msg_rpc_.has_msg_read_req()) {
242 64119 msg_typed_ = msg_rpc_.mutable_msg_read_req();
243
2/2
✓ Branch 1 taken 116991 times.
✓ Branch 2 taken 73713 times.
 190443 } else if (msg_rpc_.has_msg_read_reply()) {
244 116991 msg_typed_ = msg_rpc_.mutable_msg_read_reply();
245
2/2
✓ Branch 1 taken 17632 times.
✓ Branch 2 taken 56081 times.
 73713 } else if (msg_rpc_.has_msg_store_req()) {
246 17632 msg_typed_ = msg_rpc_.mutable_msg_store_req();
247
2/2
✓ Branch 1 taken 29 times.
✓ Branch 2 taken 56052 times.
 56081 } else if (msg_rpc_.has_msg_store_abort_req()) {
248 29 msg_typed_ = msg_rpc_.mutable_msg_store_abort_req();
249
2/2
✓ Branch 1 taken 25875 times.
✓ Branch 2 taken 30177 times.
 56052 } else if (msg_rpc_.has_msg_store_reply()) {
250 25875 msg_typed_ = msg_rpc_.mutable_msg_store_reply();
251
2/2
✓ Branch 1 taken 116 times.
✓ Branch 2 taken 30061 times.
 30177 } else if (msg_rpc_.has_msg_info_req()) {
252 116 msg_typed_ = msg_rpc_.mutable_msg_info_req();
253
2/2
✓ Branch 1 taken 140 times.
✓ Branch 2 taken 29921 times.
 30061 } else if (msg_rpc_.has_msg_info_reply()) {
254 140 msg_typed_ = msg_rpc_.mutable_msg_info_reply();
255
2/2
✓ Branch 1 taken 58 times.
✓ Branch 2 taken 29863 times.
 29921 } else if (msg_rpc_.has_msg_shrink_req()) {
256 58 msg_typed_ = msg_rpc_.mutable_msg_shrink_req();
257
2/2
✓ Branch 1 taken 66 times.
✓ Branch 2 taken 29797 times.
 29863 } else if (msg_rpc_.has_msg_shrink_reply()) {
258 66 msg_typed_ = msg_rpc_.mutable_msg_shrink_reply();
259
2/2
✓ Branch 1 taken 290 times.
✓ Branch 2 taken 29507 times.
 29797 } else if (msg_rpc_.has_msg_list_req()) {
260 290 msg_typed_ = msg_rpc_.mutable_msg_list_req();
261
2/2
✓ Branch 1 taken 298 times.
✓ Branch 2 taken 29209 times.
 29507 } else if (msg_rpc_.has_msg_list_reply()) {
262 298 msg_typed_ = msg_rpc_.mutable_msg_list_reply();
263
2/2
✓ Branch 1 taken 29 times.
✓ Branch 2 taken 29180 times.
 29209 } else if (msg_rpc_.has_msg_breadcrumb_store_req()) {
264 29 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_store_req();
265
2/2
✓ Branch 1 taken 58 times.
✓ Branch 2 taken 29122 times.
 29180 } else if (msg_rpc_.has_msg_breadcrumb_load_req()) {
266 58 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_load_req();
267
2/2
✓ Branch 1 taken 93 times.
✓ Branch 2 taken 29029 times.
 29122 } else if (msg_rpc_.has_msg_breadcrumb_reply()) {
268 93 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_reply();
269
1/2
✓ Branch 1 taken 29029 times.
✗ Branch 2 not taken.
 29029 } else if (msg_rpc_.has_msg_detach()) {
270 29029 msg_typed_ = msg_rpc_.mutable_msg_detach();
271 29029 is_msg_out_of_band_ = true;
272 } else {
273 // Unexpected message type, should never happen
274 ✗ PANIC(NULL);
275 }
276 293482 }
277
278
279 //------------------------------------------------------------------------------
280
281
282 548 CacheTransport::CacheTransport(int fd_connection)
283 548 : fd_connection_(fd_connection), flags_(0) {
284
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 548 times.
 548 assert(fd_connection_ >= 0);
285 548 }
286
287
288 129369 CacheTransport::CacheTransport(int fd_connection, uint32_t flags)
289 129369 : fd_connection_(fd_connection), flags_(flags) {
290
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 129369 times.
 129369 assert(fd_connection_ >= 0);
291 129369 }
292
293
294 5840229 void CacheTransport::FillMsgHash(const shash::Any &hash,
295 cvmfs::MsgHash *msg_hash) {
296
3/4
✓ Branch 0 taken 5840145 times.
✓ Branch 1 taken 12 times.
✓ Branch 2 taken 72 times.
✗ Branch 3 not taken.
 5840229 switch (hash.algorithm) {
297 5840145 case shash::kSha1:
298 5840145 msg_hash->set_algorithm(cvmfs::HASH_SHA1);
299 5840145 break;
300 12 case shash::kRmd160:
301 12 msg_hash->set_algorithm(cvmfs::HASH_RIPEMD160);
302 12 break;
303 72 case shash::kShake128:
304 72 msg_hash->set_algorithm(cvmfs::HASH_SHAKE128);
305 72 break;
306 ✗ default:
307 ✗ PANIC(NULL);
308 }
309 5840229 msg_hash->set_digest(hash.digest, shash::kDigestSizes[hash.algorithm]);
310 5840229 }
311
312
313 20038 void CacheTransport::FillObjectType(int object_flags,
314 cvmfs::EnumObjectType *wire_type) {
315 20038 *wire_type = cvmfs::OBJECT_REGULAR;
316
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 20038 times.
 20038 if (object_flags & CacheManager::kLabelCatalog)
317 ✗ *wire_type = cvmfs::OBJECT_CATALOG;
318
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 20038 times.
 20038 if (object_flags & CacheManager::kLabelVolatile)
319 ✗ *wire_type = cvmfs::OBJECT_VOLATILE;
320 20038 }
321
322
323 98631 bool CacheTransport::ParseMsgHash(const cvmfs::MsgHash &msg_hash,
324 shash::Any *hash) {
325
2/4
✓ Branch 1 taken 98571 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 60 times.
✗ Branch 4 not taken.
 98631 switch (msg_hash.algorithm()) {
326 98571 case cvmfs::HASH_SHA1:
327 98571 hash->algorithm = shash::kSha1;
328 98571 break;
329 ✗ case cvmfs::HASH_RIPEMD160:
330 ✗ hash->algorithm = shash::kRmd160;
331 ✗ break;
332 60 case cvmfs::HASH_SHAKE128:
333 60 hash->algorithm = shash::kShake128;
334 60 break;
335 ✗ default:
336 ✗ return false;
337 }
338 98631 const unsigned digest_size = shash::kDigestSizes[hash->algorithm];
339
1/2
✗ Branch 2 not taken.
✓ Branch 3 taken 98631 times.
 98631 if (msg_hash.digest().length() != digest_size)
340 ✗ return false;
341 98631 memcpy(hash->digest, msg_hash.digest().data(), digest_size);
342 98631 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 234757 bool CacheTransport::RecvFrame(CacheTransport::Frame *frame) {
365 uint32_t size;
366 bool has_attachment;
367
1/2
✓ Branch 1 taken 234757 times.
✗ Branch 2 not taken.
 234757 bool retval = RecvHeader(&size, &has_attachment);
368
2/2
✓ Branch 0 taken 29 times.
✓ Branch 1 taken 234728 times.
 234757 if (!retval)
369 29 return false;
370
371 void *buffer;
372
2/2
✓ Branch 0 taken 152609 times.
✓ Branch 1 taken 82119 times.
 234728 if (size <= kMaxStackAlloc)
373 152609 buffer = alloca(size);
374 else
375 82119 buffer = smalloc(size);
376
1/2
✓ Branch 1 taken 234728 times.
✗ Branch 2 not taken.
 234728 const ssize_t nbytes = SafeRead(fd_connection_, buffer, size);
377
2/4
✓ Branch 0 taken 234728 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 234728 times.
 234728 if ((nbytes < 0) || (static_cast<uint32_t>(nbytes) != size)) {
378 ✗ if (size > kMaxStackAlloc) {
379 ✗ free(buffer);
380 }
381 ✗ return false;
382 }
383
384 234728 uint32_t msg_size = size;
385
2/2
✓ Branch 0 taken 82388 times.
✓ Branch 1 taken 152340 times.
 234728 if (has_attachment) {
386
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 82388 times.
 82388 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 82388 msg_size = (*reinterpret_cast<unsigned char *>(buffer))
395 82388 + ((*(reinterpret_cast<unsigned char *>(buffer) + 1)) << 8);
396
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 82388 times.
 82388 if ((msg_size + kInnerHeaderSize) > size) {
397 ✗ if (size > kMaxStackAlloc) {
398 ✗ free(buffer);
399 }
400 ✗ return false;
401 }
402 }
403
404 234728 void *ptr_msg = has_attachment
405
2/2
✓ Branch 0 taken 82388 times.
✓ Branch 1 taken 152340 times.
 234728 ? (reinterpret_cast<char *>(buffer) + kInnerHeaderSize)
406 : buffer;
407
1/2
✓ Branch 1 taken 234728 times.
✗ Branch 2 not taken.
 234728 retval = frame->ParseMsgRpc(ptr_msg, msg_size);
408
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 234728 times.
 234728 if (!retval) {
409 ✗ if (size > kMaxStackAlloc) {
410 ✗ free(buffer);
411 }
412 ✗ return false;
413 }
414
415
2/2
✓ Branch 0 taken 82388 times.
✓ Branch 1 taken 152340 times.
 234728 if (has_attachment) {
416 82388 const uint32_t attachment_size = size - (msg_size + kInnerHeaderSize);
417
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 82388 times.
 82388 if (frame->att_size() < attachment_size) {
418 ✗ if (size > kMaxStackAlloc) {
419 ✗ free(buffer);
420 }
421 ✗ return false;
422 }
423 82388 void *ptr_attachment = reinterpret_cast<char *>(buffer) + kInnerHeaderSize
424 82388 + msg_size;
425 82388 memcpy(frame->attachment(), ptr_attachment, attachment_size);
426 82388 frame->set_att_size(attachment_size);
427 } else {
428 152340 frame->set_att_size(0);
429 }
430
2/2
✓ Branch 0 taken 82119 times.
✓ Branch 1 taken 152580 times.
 234699 if (size > kMaxStackAlloc) {
431 82119 free(buffer);
432 }
433 234699 return true;
434 }
435
436
437 234757 bool CacheTransport::RecvHeader(uint32_t *size, bool *has_attachment) {
438 unsigned char header[kHeaderSize];
439
1/2
✓ Branch 1 taken 234757 times.
✗ Branch 2 not taken.
 234757 const ssize_t nbytes = SafeRead(fd_connection_, header, kHeaderSize);
440
3/4
✓ Branch 0 taken 234757 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 29 times.
✓ Branch 3 taken 234728 times.
 234757 if ((nbytes < 0) || (static_cast<unsigned>(nbytes) != kHeaderSize))
441 29 return false;
442
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 234728 times.
 234728 if ((header[0] & (~kFlagHasAttachment)) != kWireProtocolVersion)
443 ✗ return false;
444 234728 *has_attachment = header[0] & kFlagHasAttachment;
445 234728 *size = header[1] + (header[2] << 8) + (header[3] << 16);
446
2/4
✓ Branch 0 taken 234728 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 234728 times.
✗ Branch 3 not taken.
 234728 return (*size > 0) && (*size <= kMaxMsgSize);
447 }
448
449
450 234781 void CacheTransport::SendData(void *message,
451 uint32_t msg_size,
452 void *attachment,
453 uint32_t att_size) {
454 469562 const uint32_t total_size = msg_size + att_size
455
2/2
✓ Branch 0 taken 84105 times.
✓ Branch 1 taken 150676 times.
 234781 + ((att_size > 0) ? kInnerHeaderSize : 0);
456
457
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 234781 times.
 234781 assert(total_size > 0);
458
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 234781 times.
 234781 assert(total_size <= kMaxMsgSize);
459
1/2
✓ Branch 1 taken 229042 times.
✗ Branch 2 not taken.
 229042 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 150676 times.
✓ Branch 1 taken 84105 times.
 234781 header[0] = kWireProtocolVersion | ((att_size == 0) ? 0 : kFlagHasAttachment);
464 234781 header[1] = (total_size & 0x000000FF);
465 234781 header[2] = (total_size & 0x0000FF00) >> 8;
466 234781 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 234781 iov[0].iov_base = header;
473 234781 iov[0].iov_len = kHeaderSize;
474
475
2/2
✓ Branch 0 taken 84105 times.
✓ Branch 1 taken 150676 times.
 234781 if (att_size > 0) {
476 84105 inner_header[0] = (msg_size & 0x000000FF);
477 84105 inner_header[1] = (msg_size & 0x0000FF00) >> 8;
478 84105 iov[1].iov_base = inner_header;
479 84105 iov[1].iov_len = kInnerHeaderSize;
480 84105 iov[2].iov_base = message;
481 84105 iov[2].iov_len = msg_size;
482 84105 iov[3].iov_base = attachment;
483 84105 iov[3].iov_len = att_size;
484 } else {
485 150676 iov[1].iov_base = message;
486 150676 iov[1].iov_len = msg_size;
487 }
488
2/2
✓ Branch 0 taken 29058 times.
✓ Branch 1 taken 205723 times.
 234781 if (flags_ & kFlagSendNonBlocking) {
489
2/4
✓ Branch 0 taken 29058 times.
✗ Branch 1 not taken.
✓ Branch 3 taken 29058 times.
✗ Branch 4 not taken.
 29058 SendNonBlocking(iov, (att_size == 0) ? 2 : 4);
490 29058 return;
491 }
492
3/4
✓ Branch 0 taken 121618 times.
✓ Branch 1 taken 84105 times.
✓ Branch 3 taken 205694 times.
✗ Branch 4 not taken.
 205723 const bool retval = SafeWriteV(fd_connection_, iov, (att_size == 0) ? 2 : 4);
493
494
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 205694 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 205694 if (!retval && !(flags_ & kFlagSendIgnoreFailure)) {
495 ✗ PANIC(kLogSyslogErr | kLogDebug,
496 "failed to write to external cache transport (%d), aborting", errno);
497 }
498 }
499
500 29058 void CacheTransport::SendNonBlocking(struct iovec *iov, unsigned iovcnt) {
501
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 29058 times.
 29058 assert(iovcnt > 0);
502 29058 unsigned total_size = 0;
503
2/2
✓ Branch 0 taken 58116 times.
✓ Branch 1 taken 29058 times.
 87174 for (unsigned i = 0; i < iovcnt; ++i)
504 58116 total_size += iov[i].iov_len;
505 29058 unsigned char *buffer = reinterpret_cast<unsigned char *>(alloca(total_size));
506
507 29058 unsigned pos = 0;
508
2/2
✓ Branch 0 taken 58116 times.
✓ Branch 1 taken 29058 times.
 87174 for (unsigned i = 0; i < iovcnt; ++i) {
509 58116 memcpy(buffer + pos, iov[i].iov_base, iov[i].iov_len);
510 58116 pos += iov[i].iov_len;
511 }
512
513 29058 const int retval = send(fd_connection_, buffer, total_size, MSG_DONTWAIT);
514
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 29058 times.
 29058 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 29058 }
523
524
525 234781 void CacheTransport::SendFrame(CacheTransport::Frame *frame) {
526 234781 cvmfs::MsgRpc *msg_rpc = frame->GetMsgRpc();
527 234752 const int32_t size = msg_rpc->ByteSize();
528
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 234781 times.
 234781 assert(size > 0);
529 #ifdef __APPLE__
530 void *buffer = smalloc(size);
531 #else
532 234781 void *buffer = alloca(size);
533 #endif
534 234781 const bool retval = msg_rpc->SerializeToArray(buffer, size);
535
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 234781 times.
 234781 assert(retval);
536 234781 SendData(buffer, size, frame->attachment(), frame->att_size());
537 #ifdef __APPLE__
538 free(buffer);
539 #endif
540 234549 }
541