GCC Code Coverage Report

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