GCC Code Coverage Report


Directory: cvmfs/
File: cvmfs/cache_transport.cc
Date: 2026-03-01 02:36:14
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 147912 cvmfs::MsgRpc *CacheTransport::Frame::GetMsgRpc() {
34
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 147912 times.
147912 assert(msg_typed_ != NULL);
35
1/2
✓ Branch 0 taken 147912 times.
✗ Branch 1 not taken.
147912 if (!is_wrapped_)
36 147912 WrapMsg();
37 147912 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 184356 google::protobuf::MessageLite *CacheTransport::Frame::GetMsgTyped() {
46
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 184302 times.
184356 assert(msg_rpc_.IsInitialized());
47
2/2
✓ Branch 0 taken 153548 times.
✓ Branch 1 taken 30754 times.
184302 if (msg_typed_ == NULL)
48 153548 UnwrapMsg();
49 184230 return msg_typed_;
50 }
51
52
53 184356 CacheTransport::Frame::Frame()
54 184338 : owns_msg_typed_(false)
55 184338 , msg_typed_(NULL)
56 184338 , attachment_(NULL)
57 184338 , att_size_(0)
58 184338 , is_wrapped_(false)
59 184356 , is_msg_out_of_band_(false) { }
60
61
62 147894 CacheTransport::Frame::Frame(google::protobuf::MessageLite *m)
63 147894 : owns_msg_typed_(false)
64 147894 , msg_typed_(m)
65 147894 , attachment_(NULL)
66 147894 , att_size_(0)
67 147894 , is_wrapped_(false)
68 147894 , is_msg_out_of_band_(false) { }
69
70
71 332268 CacheTransport::Frame::~Frame() { Reset(0); }
72
73
74 30754 bool CacheTransport::Frame::IsMsgOutOfBand() {
75
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 30754 times.
30754 assert(msg_rpc_.IsInitialized());
76
1/2
✓ Branch 0 taken 30754 times.
✗ Branch 1 not taken.
30754 if (msg_typed_ == NULL)
77 30754 UnwrapMsg();
78 30754 return is_msg_out_of_band_;
79 }
80
81
82 36504 void CacheTransport::Frame::MergeFrom(const Frame &other) {
83 36504 msg_rpc_.CheckTypeAndMergeFrom(other.msg_rpc_);
84 36504 owns_msg_typed_ = true;
85
2/2
✓ Branch 0 taken 32400 times.
✓ Branch 1 taken 4104 times.
36504 if (other.att_size_ > 0) {
86
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 32400 times.
32400 assert(att_size_ >= other.att_size_);
87 32400 memcpy(attachment_, other.attachment_, other.att_size_);
88 32400 att_size_ = other.att_size_;
89 }
90 36504 }
91
92
93 147870 bool CacheTransport::Frame::ParseMsgRpc(void *buffer, uint32_t size) {
94 147870 const bool retval = msg_rpc_.ParseFromArray(buffer, size);
95
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 147798 times.
147798 if (!retval)
96 return false;
97
98 // Cleanup typed message when Frame leaves scope
99 147798 owns_msg_typed_ = true;
100 147798 return true;
101 }
102
103
104 332286 void CacheTransport::Frame::Release() {
105
2/2
✓ Branch 0 taken 184356 times.
✓ Branch 1 taken 147930 times.
332286 if (owns_msg_typed_)
106 184356 return;
107
108 147930 msg_rpc_.release_msg_refcount_req();
109 147912 msg_rpc_.release_msg_refcount_reply();
110 147930 msg_rpc_.release_msg_read_req();
111 147912 msg_rpc_.release_msg_read_reply();
112 147912 msg_rpc_.release_msg_object_info_req();
113 147894 msg_rpc_.release_msg_object_info_reply();
114 147894 msg_rpc_.release_msg_store_req();
115 147930 msg_rpc_.release_msg_store_abort_req();
116 147930 msg_rpc_.release_msg_store_reply();
117 147930 msg_rpc_.release_msg_handshake();
118 147930 msg_rpc_.release_msg_handshake_ack();
119 147930 msg_rpc_.release_msg_quit();
120 147912 msg_rpc_.release_msg_ioctl();
121 147912 msg_rpc_.release_msg_info_req();
122 147912 msg_rpc_.release_msg_info_reply();
123 147912 msg_rpc_.release_msg_shrink_req();
124 147912 msg_rpc_.release_msg_shrink_reply();
125 147912 msg_rpc_.release_msg_list_req();
126 147912 msg_rpc_.release_msg_list_reply();
127 147912 msg_rpc_.release_msg_detach();
128 147894 msg_rpc_.release_msg_breadcrumb_store_req();
129 147894 msg_rpc_.release_msg_breadcrumb_load_req();
130 147894 msg_rpc_.release_msg_breadcrumb_reply();
131 }
132
133
134 332286 void CacheTransport::Frame::Reset(uint32_t original_att_size) {
135 332286 msg_typed_ = NULL;
136 332286 att_size_ = original_att_size;
137 332286 is_wrapped_ = false;
138 332286 is_msg_out_of_band_ = false;
139 332286 Release();
140 332250 msg_rpc_.Clear();
141 332286 owns_msg_typed_ = false;
142 332286 }
143
144
145 147912 void CacheTransport::Frame::WrapMsg() {
146
2/2
✓ Branch 3 taken 350 times.
✓ Branch 4 taken 147562 times.
147912 if (msg_typed_->GetTypeName() == "cvmfs.MsgHandshake") {
147 350 msg_rpc_.set_allocated_msg_handshake(
148 350 reinterpret_cast<cvmfs::MsgHandshake *>(msg_typed_));
149
2/2
✓ Branch 3 taken 324 times.
✓ Branch 4 taken 147238 times.
147562 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgHandshakeAck") {
150 324 msg_rpc_.set_allocated_msg_handshake_ack(
151 324 reinterpret_cast<cvmfs::MsgHandshakeAck *>(msg_typed_));
152
2/2
✓ Branch 3 taken 348 times.
✓ Branch 4 taken 146890 times.
147238 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgQuit") {
153 348 msg_rpc_.set_allocated_msg_quit(
154 348 reinterpret_cast<cvmfs::MsgQuit *>(msg_typed_));
155
2/2
✓ Branch 3 taken 72 times.
✓ Branch 4 taken 146818 times.
146890 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgIoctl") {
156 72 msg_rpc_.set_allocated_msg_ioctl(
157 72 reinterpret_cast<cvmfs::MsgIoctl *>(msg_typed_));
158
2/2
✓ Branch 3 taken 12656 times.
✓ Branch 4 taken 134162 times.
146818 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgRefcountReq") {
159 12656 msg_rpc_.set_allocated_msg_refcount_req(
160 12656 reinterpret_cast<cvmfs::MsgRefcountReq *>(msg_typed_));
161
2/2
✓ Branch 3 taken 10152 times.
✓ Branch 4 taken 124010 times.
134162 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgRefcountReply") {
162 10152 msg_rpc_.set_allocated_msg_refcount_reply(
163 10152 reinterpret_cast<cvmfs::MsgRefcountReply *>(msg_typed_));
164
2/2
✓ Branch 3 taken 312 times.
✓ Branch 4 taken 123698 times.
124010 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgObjectInfoReq") {
165 312 msg_rpc_.set_allocated_msg_object_info_req(
166 312 reinterpret_cast<cvmfs::MsgObjectInfoReq *>(msg_typed_));
167
2/2
✓ Branch 3 taken 288 times.
✓ Branch 4 taken 123410 times.
123698 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgObjectInfoReply") {
168 288 msg_rpc_.set_allocated_msg_object_info_reply(
169 288 reinterpret_cast<cvmfs::MsgObjectInfoReply *>(msg_typed_));
170
2/2
✓ Branch 3 taken 40508 times.
✓ Branch 4 taken 82902 times.
123410 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgReadReq") {
171 40508 msg_rpc_.set_allocated_msg_read_req(
172 40508 reinterpret_cast<cvmfs::MsgReadReq *>(msg_typed_));
173
2/2
✓ Branch 3 taken 39798 times.
✓ Branch 4 taken 43104 times.
82902 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgReadReply") {
174 39798 msg_rpc_.set_allocated_msg_read_reply(
175 39798 reinterpret_cast<cvmfs::MsgReadReply *>(msg_typed_));
176
2/2
✓ Branch 3 taken 13358 times.
✓ Branch 4 taken 29746 times.
43104 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreReq") {
177 13358 msg_rpc_.set_allocated_msg_store_req(
178 13358 reinterpret_cast<cvmfs::MsgStoreReq *>(msg_typed_));
179
2/2
✓ Branch 3 taken 18 times.
✓ Branch 4 taken 29728 times.
29746 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreAbortReq") {
180 18 msg_rpc_.set_allocated_msg_store_abort_req(
181 18 reinterpret_cast<cvmfs::MsgStoreAbortReq *>(msg_typed_));
182
2/2
✓ Branch 3 taken 10962 times.
✓ Branch 4 taken 18766 times.
29728 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreReply") {
183 10962 msg_rpc_.set_allocated_msg_store_reply(
184 10962 reinterpret_cast<cvmfs::MsgStoreReply *>(msg_typed_));
185
2/2
✓ Branch 3 taken 96 times.
✓ Branch 4 taken 18670 times.
18766 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgInfoReq") {
186 96 msg_rpc_.set_allocated_msg_info_req(
187 96 reinterpret_cast<cvmfs::MsgInfoReq *>(msg_typed_));
188
2/2
✓ Branch 3 taken 72 times.
✓ Branch 4 taken 18598 times.
18670 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgInfoReply") {
189 72 msg_rpc_.set_allocated_msg_info_reply(
190 72 reinterpret_cast<cvmfs::MsgInfoReply *>(msg_typed_));
191
2/2
✓ Branch 3 taken 44 times.
✓ Branch 4 taken 18554 times.
18598 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgShrinkReq") {
192 44 msg_rpc_.set_allocated_msg_shrink_req(
193 44 reinterpret_cast<cvmfs::MsgShrinkReq *>(msg_typed_));
194
2/2
✓ Branch 3 taken 36 times.
✓ Branch 4 taken 18518 times.
18554 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgShrinkReply") {
195 36 msg_rpc_.set_allocated_msg_shrink_reply(
196 36 reinterpret_cast<cvmfs::MsgShrinkReply *>(msg_typed_));
197
2/2
✓ Branch 3 taken 188 times.
✓ Branch 4 taken 18330 times.
18518 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgListReq") {
198 188 msg_rpc_.set_allocated_msg_list_req(
199 188 reinterpret_cast<cvmfs::MsgListReq *>(msg_typed_));
200
2/2
✓ Branch 3 taken 180 times.
✓ Branch 4 taken 18150 times.
18330 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgListReply") {
201 180 msg_rpc_.set_allocated_msg_list_reply(
202 180 reinterpret_cast<cvmfs::MsgListReply *>(msg_typed_));
203
2/2
✓ Branch 3 taken 20 times.
✓ Branch 4 taken 18130 times.
18150 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbStoreReq") {
204 20 msg_rpc_.set_allocated_msg_breadcrumb_store_req(
205 20 reinterpret_cast<cvmfs::MsgBreadcrumbStoreReq *>(msg_typed_));
206
2/2
✓ Branch 3 taken 40 times.
✓ Branch 4 taken 18090 times.
18130 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbLoadReq") {
207 40 msg_rpc_.set_allocated_msg_breadcrumb_load_req(
208 40 reinterpret_cast<cvmfs::MsgBreadcrumbLoadReq *>(msg_typed_));
209
2/2
✓ Branch 3 taken 54 times.
✓ Branch 4 taken 18036 times.
18090 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbReply") {
210 54 msg_rpc_.set_allocated_msg_breadcrumb_reply(
211 54 reinterpret_cast<cvmfs::MsgBreadcrumbReply *>(msg_typed_));
212
1/2
✓ Branch 3 taken 18036 times.
✗ Branch 4 not taken.
18036 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgDetach") {
213 18036 msg_rpc_.set_allocated_msg_detach(
214 18036 reinterpret_cast<cvmfs::MsgDetach *>(msg_typed_));
215 18036 is_msg_out_of_band_ = true;
216 } else {
217 // Unexpected message type, should never happen
218 PANIC(NULL);
219 }
220 147912 is_wrapped_ = true;
221 147912 }
222
223
224 184302 void CacheTransport::Frame::UnwrapMsg() {
225
2/2
✓ Branch 1 taken 324 times.
✓ Branch 2 taken 183960 times.
184302 if (msg_rpc_.has_msg_handshake()) {
226 324 msg_typed_ = msg_rpc_.mutable_msg_handshake();
227
2/2
✓ Branch 1 taken 350 times.
✓ Branch 2 taken 183610 times.
183960 } else if (msg_rpc_.has_msg_handshake_ack()) {
228 350 msg_typed_ = msg_rpc_.mutable_msg_handshake_ack();
229
2/2
✓ Branch 1 taken 324 times.
✓ Branch 2 taken 183178 times.
183610 } else if (msg_rpc_.has_msg_quit()) {
230 324 msg_typed_ = msg_rpc_.mutable_msg_quit();
231
2/2
✓ Branch 1 taken 72 times.
✓ Branch 2 taken 183196 times.
183178 } else if (msg_rpc_.has_msg_ioctl()) {
232 72 msg_typed_ = msg_rpc_.mutable_msg_ioctl();
233
2/2
✓ Branch 1 taken 10152 times.
✓ Branch 2 taken 173098 times.
183196 } else if (msg_rpc_.has_msg_refcount_req()) {
234 10152 msg_typed_ = msg_rpc_.mutable_msg_refcount_req();
235
2/2
✓ Branch 1 taken 12998 times.
✓ Branch 2 taken 159812 times.
173098 } else if (msg_rpc_.has_msg_refcount_reply()) {
236 12998 msg_typed_ = msg_rpc_.mutable_msg_refcount_reply();
237
2/2
✓ Branch 1 taken 288 times.
✓ Branch 2 taken 159614 times.
159812 } else if (msg_rpc_.has_msg_object_info_req()) {
238 288 msg_typed_ = msg_rpc_.mutable_msg_object_info_req();
239
2/2
✓ Branch 1 taken 474 times.
✓ Branch 2 taken 159248 times.
159614 } else if (msg_rpc_.has_msg_object_info_reply()) {
240 474 msg_typed_ = msg_rpc_.mutable_msg_object_info_reply();
241
2/2
✓ Branch 1 taken 39798 times.
✓ Branch 2 taken 119468 times.
159248 } else if (msg_rpc_.has_msg_read_req()) {
242 39798 msg_typed_ = msg_rpc_.mutable_msg_read_req();
243
2/2
✓ Branch 1 taken 72908 times.
✓ Branch 2 taken 46686 times.
119468 } else if (msg_rpc_.has_msg_read_reply()) {
244 72908 msg_typed_ = msg_rpc_.mutable_msg_read_reply();
245
2/2
✓ Branch 1 taken 10944 times.
✓ Branch 2 taken 35742 times.
46686 } else if (msg_rpc_.has_msg_store_req()) {
246 10944 msg_typed_ = msg_rpc_.mutable_msg_store_req();
247
2/2
✓ Branch 1 taken 18 times.
✓ Branch 2 taken 35724 times.
35742 } else if (msg_rpc_.has_msg_store_abort_req()) {
248 18 msg_typed_ = msg_rpc_.mutable_msg_store_abort_req();
249
2/2
✓ Branch 1 taken 16976 times.
✓ Branch 2 taken 18748 times.
35724 } else if (msg_rpc_.has_msg_store_reply()) {
250 16976 msg_typed_ = msg_rpc_.mutable_msg_store_reply();
251
2/2
✓ Branch 1 taken 72 times.
✓ Branch 2 taken 18676 times.
18748 } else if (msg_rpc_.has_msg_info_req()) {
252 72 msg_typed_ = msg_rpc_.mutable_msg_info_req();
253
2/2
✓ Branch 1 taken 96 times.
✓ Branch 2 taken 18580 times.
18676 } else if (msg_rpc_.has_msg_info_reply()) {
254 96 msg_typed_ = msg_rpc_.mutable_msg_info_reply();
255
2/2
✓ Branch 1 taken 36 times.
✓ Branch 2 taken 18544 times.
18580 } else if (msg_rpc_.has_msg_shrink_req()) {
256 36 msg_typed_ = msg_rpc_.mutable_msg_shrink_req();
257
2/2
✓ Branch 1 taken 44 times.
✓ Branch 2 taken 18500 times.
18544 } else if (msg_rpc_.has_msg_shrink_reply()) {
258 44 msg_typed_ = msg_rpc_.mutable_msg_shrink_reply();
259
2/2
✓ Branch 1 taken 180 times.
✓ Branch 2 taken 18320 times.
18500 } else if (msg_rpc_.has_msg_list_req()) {
260 180 msg_typed_ = msg_rpc_.mutable_msg_list_req();
261
2/2
✓ Branch 1 taken 188 times.
✓ Branch 2 taken 18132 times.
18320 } else if (msg_rpc_.has_msg_list_reply()) {
262 188 msg_typed_ = msg_rpc_.mutable_msg_list_reply();
263
2/2
✓ Branch 1 taken 18 times.
✓ Branch 2 taken 18114 times.
18132 } else if (msg_rpc_.has_msg_breadcrumb_store_req()) {
264 18 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_store_req();
265
2/2
✓ Branch 1 taken 36 times.
✓ Branch 2 taken 18078 times.
18114 } else if (msg_rpc_.has_msg_breadcrumb_load_req()) {
266 36 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_load_req();
267
2/2
✓ Branch 1 taken 60 times.
✓ Branch 2 taken 18018 times.
18078 } else if (msg_rpc_.has_msg_breadcrumb_reply()) {
268 60 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_reply();
269
1/2
✓ Branch 1 taken 18018 times.
✗ Branch 2 not taken.
18018 } else if (msg_rpc_.has_msg_detach()) {
270 18018 msg_typed_ = msg_rpc_.mutable_msg_detach();
271 18018 is_msg_out_of_band_ = true;
272 } else {
273 // Unexpected message type, should never happen
274 PANIC(NULL);
275 }
276 184374 }
277
278
279 //------------------------------------------------------------------------------
280
281
282 350 CacheTransport::CacheTransport(int fd_connection)
283 350 : fd_connection_(fd_connection), flags_(0) {
284
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 350 times.
350 assert(fd_connection_ >= 0);
285 350 }
286
287
288 80298 CacheTransport::CacheTransport(int fd_connection, uint32_t flags)
289 80298 : fd_connection_(fd_connection), flags_(flags) {
290
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 80298 times.
80298 assert(fd_connection_ >= 0);
291 80298 }
292
293
294 3626947 void CacheTransport::FillMsgHash(const shash::Any &hash,
295 cvmfs::MsgHash *msg_hash) {
296
3/4
✓ Branch 0 taken 3626885 times.
✓ Branch 1 taken 12 times.
✓ Branch 2 taken 50 times.
✗ Branch 3 not taken.
3626947 switch (hash.algorithm) {
297 3626885 case shash::kSha1:
298 3626885 msg_hash->set_algorithm(cvmfs::HASH_SHA1);
299 3626885 break;
300 12 case shash::kRmd160:
301 12 msg_hash->set_algorithm(cvmfs::HASH_RIPEMD160);
302 12 break;
303 50 case shash::kShake128:
304 50 msg_hash->set_algorithm(cvmfs::HASH_SHAKE128);
305 50 break;
306 default:
307 PANIC(NULL);
308 }
309 3626947 msg_hash->set_digest(hash.digest, shash::kDigestSizes[hash.algorithm]);
310 3626947 }
311
312
313 13350 void CacheTransport::FillObjectType(int object_flags,
314 cvmfs::EnumObjectType *wire_type) {
315 13350 *wire_type = cvmfs::OBJECT_REGULAR;
316
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 13350 times.
13350 if (object_flags & CacheManager::kLabelCatalog)
317 *wire_type = cvmfs::OBJECT_CATALOG;
318
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 13350 times.
13350 if (object_flags & CacheManager::kLabelVolatile)
319 *wire_type = cvmfs::OBJECT_VOLATILE;
320 13350 }
321
322
323 61220 bool CacheTransport::ParseMsgHash(const cvmfs::MsgHash &msg_hash,
324 shash::Any *hash) {
325
2/4
✓ Branch 1 taken 61182 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 38 times.
✗ Branch 4 not taken.
61220 switch (msg_hash.algorithm()) {
326 61182 case cvmfs::HASH_SHA1:
327 61182 hash->algorithm = shash::kSha1;
328 61182 break;
329 case cvmfs::HASH_RIPEMD160:
330 hash->algorithm = shash::kRmd160;
331 break;
332 38 case cvmfs::HASH_SHAKE128:
333 38 hash->algorithm = shash::kShake128;
334 38 break;
335 default:
336 return false;
337 }
338 61220 const unsigned digest_size = shash::kDigestSizes[hash->algorithm];
339
1/2
✗ Branch 2 not taken.
✓ Branch 3 taken 61220 times.
61220 if (msg_hash.digest().length() != digest_size)
340 return false;
341 61220 memcpy(hash->digest, msg_hash.digest().data(), digest_size);
342 61220 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 147888 bool CacheTransport::RecvFrame(CacheTransport::Frame *frame) {
365 uint32_t size;
366 bool has_attachment;
367
1/2
✓ Branch 1 taken 147888 times.
✗ Branch 2 not taken.
147888 bool retval = RecvHeader(&size, &has_attachment);
368
2/2
✓ Branch 0 taken 18 times.
✓ Branch 1 taken 147870 times.
147888 if (!retval)
369 18 return false;
370
371 void *buffer;
372
2/2
✓ Branch 0 taken 96725 times.
✓ Branch 1 taken 51145 times.
147870 if (size <= kMaxStackAlloc)
373 96725 buffer = alloca(size);
374 else
375 51145 buffer = smalloc(size);
376
1/2
✓ Branch 1 taken 147870 times.
✗ Branch 2 not taken.
147870 const ssize_t nbytes = SafeRead(fd_connection_, buffer, size);
377
2/4
✓ Branch 0 taken 147870 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 147870 times.
147870 if ((nbytes < 0) || (static_cast<uint32_t>(nbytes) != size)) {
378 if (size > kMaxStackAlloc) {
379 free(buffer);
380 }
381 return false;
382 }
383
384 147870 uint32_t msg_size = size;
385
2/2
✓ Branch 0 taken 51410 times.
✓ Branch 1 taken 96460 times.
147870 if (has_attachment) {
386
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 51410 times.
51410 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 51410 msg_size = (*reinterpret_cast<unsigned char *>(buffer))
395 51410 + ((*(reinterpret_cast<unsigned char *>(buffer) + 1)) << 8);
396
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 51410 times.
51410 if ((msg_size + kInnerHeaderSize) > size) {
397 if (size > kMaxStackAlloc) {
398 free(buffer);
399 }
400 return false;
401 }
402 }
403
404 147870 void *ptr_msg = has_attachment
405
2/2
✓ Branch 0 taken 51410 times.
✓ Branch 1 taken 96460 times.
147870 ? (reinterpret_cast<char *>(buffer) + kInnerHeaderSize)
406 : buffer;
407
1/2
✓ Branch 1 taken 147816 times.
✗ Branch 2 not taken.
147870 retval = frame->ParseMsgRpc(ptr_msg, msg_size);
408
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 147816 times.
147816 if (!retval) {
409 if (size > kMaxStackAlloc) {
410 free(buffer);
411 }
412 return false;
413 }
414
415
2/2
✓ Branch 0 taken 51410 times.
✓ Branch 1 taken 96406 times.
147816 if (has_attachment) {
416 51410 const uint32_t attachment_size = size - (msg_size + kInnerHeaderSize);
417
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 51410 times.
51410 if (frame->att_size() < attachment_size) {
418 if (size > kMaxStackAlloc) {
419 free(buffer);
420 }
421 return false;
422 }
423 51410 void *ptr_attachment = reinterpret_cast<char *>(buffer) + kInnerHeaderSize
424 51410 + msg_size;
425 51410 memcpy(frame->attachment(), ptr_attachment, attachment_size);
426 51410 frame->set_att_size(attachment_size);
427 } else {
428 96406 frame->set_att_size(0);
429 }
430
2/2
✓ Branch 0 taken 51145 times.
✓ Branch 1 taken 96671 times.
147816 if (size > kMaxStackAlloc) {
431 51145 free(buffer);
432 }
433 147816 return true;
434 }
435
436
437 147888 bool CacheTransport::RecvHeader(uint32_t *size, bool *has_attachment) {
438 unsigned char header[kHeaderSize];
439
1/2
✓ Branch 1 taken 147888 times.
✗ Branch 2 not taken.
147888 const ssize_t nbytes = SafeRead(fd_connection_, header, kHeaderSize);
440
3/4
✓ Branch 0 taken 147888 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 18 times.
✓ Branch 3 taken 147870 times.
147888 if ((nbytes < 0) || (static_cast<unsigned>(nbytes) != kHeaderSize))
441 18 return false;
442
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 147870 times.
147870 if ((header[0] & (~kFlagHasAttachment)) != kWireProtocolVersion)
443 return false;
444 147870 *has_attachment = header[0] & kFlagHasAttachment;
445 147870 *size = header[1] + (header[2] << 8) + (header[3] << 16);
446
2/4
✓ Branch 0 taken 147870 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 147870 times.
✗ Branch 3 not taken.
147870 return (*size > 0) && (*size <= kMaxMsgSize);
447 }
448
449
450 147912 void CacheTransport::SendData(void *message,
451 uint32_t msg_size,
452 void *attachment,
453 uint32_t att_size) {
454 295824 const uint32_t total_size = msg_size + att_size
455
2/2
✓ Branch 0 taken 53118 times.
✓ Branch 1 taken 94794 times.
147912 + ((att_size > 0) ? kInnerHeaderSize : 0);
456
457
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 147912 times.
147912 assert(total_size > 0);
458
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 147912 times.
147912 assert(total_size <= kMaxMsgSize);
459
1/2
✓ Branch 1 taken 142164 times.
✗ Branch 2 not taken.
142164 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 94794 times.
✓ Branch 1 taken 53118 times.
147912 header[0] = kWireProtocolVersion | ((att_size == 0) ? 0 : kFlagHasAttachment);
464 147912 header[1] = (total_size & 0x000000FF);
465 147912 header[2] = (total_size & 0x0000FF00) >> 8;
466 147912 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 147912 iov[0].iov_base = header;
473 147912 iov[0].iov_len = kHeaderSize;
474
475
2/2
✓ Branch 0 taken 53118 times.
✓ Branch 1 taken 94794 times.
147912 if (att_size > 0) {
476 53118 inner_header[0] = (msg_size & 0x000000FF);
477 53118 inner_header[1] = (msg_size & 0x0000FF00) >> 8;
478 53118 iov[1].iov_base = inner_header;
479 53118 iov[1].iov_len = kInnerHeaderSize;
480 53118 iov[2].iov_base = message;
481 53118 iov[2].iov_len = msg_size;
482 53118 iov[3].iov_base = attachment;
483 53118 iov[3].iov_len = att_size;
484 } else {
485 94794 iov[1].iov_base = message;
486 94794 iov[1].iov_len = msg_size;
487 }
488
2/2
✓ Branch 0 taken 18036 times.
✓ Branch 1 taken 129876 times.
147912 if (flags_ & kFlagSendNonBlocking) {
489
2/4
✓ Branch 0 taken 18036 times.
✗ Branch 1 not taken.
✓ Branch 3 taken 18036 times.
✗ Branch 4 not taken.
18036 SendNonBlocking(iov, (att_size == 0) ? 2 : 4);
490 18036 return;
491 }
492
3/4
✓ Branch 0 taken 76758 times.
✓ Branch 1 taken 53118 times.
✓ Branch 3 taken 129840 times.
✗ Branch 4 not taken.
129876 const bool retval = SafeWriteV(fd_connection_, iov, (att_size == 0) ? 2 : 4);
493
494
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 129840 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
129840 if (!retval && !(flags_ & kFlagSendIgnoreFailure)) {
495 PANIC(kLogSyslogErr | kLogDebug,
496 "failed to write to external cache transport (%d), aborting", errno);
497 }
498 }
499
500 18036 void CacheTransport::SendNonBlocking(struct iovec *iov, unsigned iovcnt) {
501
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 18036 times.
18036 assert(iovcnt > 0);
502 18036 unsigned total_size = 0;
503
2/2
✓ Branch 0 taken 36072 times.
✓ Branch 1 taken 18036 times.
54108 for (unsigned i = 0; i < iovcnt; ++i)
504 36072 total_size += iov[i].iov_len;
505 18036 unsigned char *buffer = reinterpret_cast<unsigned char *>(alloca(total_size));
506
507 18036 unsigned pos = 0;
508
2/2
✓ Branch 0 taken 36072 times.
✓ Branch 1 taken 18036 times.
54108 for (unsigned i = 0; i < iovcnt; ++i) {
509 36072 memcpy(buffer + pos, iov[i].iov_base, iov[i].iov_len);
510 36072 pos += iov[i].iov_len;
511 }
512
513 18036 const int retval = send(fd_connection_, buffer, total_size, MSG_DONTWAIT);
514
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 18036 times.
18036 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 18036 }
523
524
525 147912 void CacheTransport::SendFrame(CacheTransport::Frame *frame) {
526 147912 cvmfs::MsgRpc *msg_rpc = frame->GetMsgRpc();
527 147912 const int32_t size = msg_rpc->ByteSize();
528
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 147858 times.
147858 assert(size > 0);
529 #ifdef __APPLE__
530 void *buffer = smalloc(size);
531 #else
532 147858 void *buffer = alloca(size);
533 #endif
534 147858 const bool retval = msg_rpc->SerializeToArray(buffer, size);
535
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 147912 times.
147912 assert(retval);
536 147912 SendData(buffer, size, frame->attachment(), frame->att_size());
537 #ifdef __APPLE__
538 free(buffer);
539 #endif
540 147876 }
541