GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/cache_transport.cc
Date: 2026-07-26 02:35: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 "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 61018 cvmfs::MsgRpc *CacheTransport::Frame::GetMsgRpc() {
35
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 61018 times.
 61018 assert(msg_typed_ != NULL);
36
1/2
✓ Branch 0 taken 61018 times.
✗ Branch 1 not taken.
 61018 if (!is_wrapped_)
37 61018 WrapMsg();
38 61025 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 75176 google::protobuf::MessageLite *CacheTransport::Frame::GetMsgTyped() {
47
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 75169 times.
 75176 assert(msg_rpc_.IsInitialized());
48
2/2
✓ Branch 0 taken 59743 times.
✓ Branch 1 taken 15426 times.
 75169 if (msg_typed_ == NULL)
49 59743 UnwrapMsg();
50 75155 return msg_typed_;
51 }
52
53
54 75190 CacheTransport::Frame::Frame()
55 75190 : owns_msg_typed_(false)
56 75190 , msg_typed_(NULL)
57 75190 , attachment_(NULL)
58 75190 , att_size_(0)
59 75190 , is_wrapped_(false)
60 75190 , is_msg_out_of_band_(false) { }
61
62
63 61025 CacheTransport::Frame::Frame(google::protobuf::MessageLite *m)
64 61025 : owns_msg_typed_(false)
65 61025 , msg_typed_(m)
66 61025 , attachment_(NULL)
67 61025 , att_size_(0)
68 61025 , is_wrapped_(false)
69 61025 , is_msg_out_of_band_(false) { }
70
71
72 136208 CacheTransport::Frame::~Frame() { Reset(0); }
73
74
75 15433 bool CacheTransport::Frame::IsMsgOutOfBand() {
76
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 15433 times.
 15433 assert(msg_rpc_.IsInitialized());
77
1/2
✓ Branch 0 taken 15433 times.
✗ Branch 1 not taken.
 15433 if (msg_typed_ == NULL)
78 15433 UnwrapMsg();
79 15433 return is_msg_out_of_band_;
80 }
81
82
83 14196 void CacheTransport::Frame::MergeFrom(const Frame &other) {
84 14196 msg_rpc_.CheckTypeAndMergeFrom(other.msg_rpc_);
85 14196 owns_msg_typed_ = true;
86
2/2
✓ Branch 0 taken 12600 times.
✓ Branch 1 taken 1596 times.
 14196 if (other.att_size_ > 0) {
87
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 12600 times.
 12600 assert(att_size_ >= other.att_size_);
88 12600 memcpy(attachment_, other.attachment_, other.att_size_);
89 12600 att_size_ = other.att_size_;
90 }
91 14196 }
92
93
94 60994 bool CacheTransport::Frame::ParseMsgRpc(void *buffer, uint32_t size) {
95 60994 const bool retval = msg_rpc_.ParseFromArray(buffer, size);
96
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 60994 times.
 60994 if (!retval)
97 ✗ return false;
98
99 // Cleanup typed message when Frame leaves scope
100 60994 owns_msg_typed_ = true;
101 60994 return true;
102 }
103
104
105 136215 void CacheTransport::Frame::Release() {
106
2/2
✓ Branch 0 taken 75190 times.
✓ Branch 1 taken 61025 times.
 136215 if (owns_msg_typed_)
107 75190 return;
108
109 61025 msg_rpc_.release_msg_refcount_req();
110 61032 msg_rpc_.release_msg_refcount_reply();
111 61032 msg_rpc_.release_msg_read_req();
112 61032 msg_rpc_.release_msg_read_reply();
113 61032 msg_rpc_.release_msg_object_info_req();
114 61032 msg_rpc_.release_msg_object_info_reply();
115 61032 msg_rpc_.release_msg_store_req();
116 61032 msg_rpc_.release_msg_store_abort_req();
117 61032 msg_rpc_.release_msg_store_reply();
118 61032 msg_rpc_.release_msg_handshake();
119 61032 msg_rpc_.release_msg_handshake_ack();
120 61032 msg_rpc_.release_msg_quit();
121 61032 msg_rpc_.release_msg_ioctl();
122 61032 msg_rpc_.release_msg_info_req();
123 61032 msg_rpc_.release_msg_info_reply();
124 61032 msg_rpc_.release_msg_shrink_req();
125 61032 msg_rpc_.release_msg_shrink_reply();
126 61032 msg_rpc_.release_msg_list_req();
127 61032 msg_rpc_.release_msg_list_reply();
128 61032 msg_rpc_.release_msg_detach();
129 61032 msg_rpc_.release_msg_breadcrumb_store_req();
130 61032 msg_rpc_.release_msg_breadcrumb_load_req();
131 61032 msg_rpc_.release_msg_breadcrumb_reply();
132 }
133
134
135 136215 void CacheTransport::Frame::Reset(uint32_t original_att_size) {
136 136215 msg_typed_ = NULL;
137 136215 att_size_ = original_att_size;
138 136215 is_wrapped_ = false;
139 136215 is_msg_out_of_band_ = false;
140 136215 Release();
141 136222 msg_rpc_.Clear();
142 136222 owns_msg_typed_ = false;
143 136222 }
144
145
146 61025 void CacheTransport::Frame::WrapMsg() {
147
2/2
✓ Branch 3 taken 152 times.
✓ Branch 4 taken 60866 times.
 61025 if (msg_typed_->GetTypeName() == "cvmfs.MsgHandshake") {
148 152 msg_rpc_.set_allocated_msg_handshake(
149 152 reinterpret_cast<cvmfs::MsgHandshake *>(msg_typed_));
150
2/2
✓ Branch 3 taken 126 times.
✓ Branch 4 taken 60747 times.
 60866 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgHandshakeAck") {
151 126 msg_rpc_.set_allocated_msg_handshake_ack(
152 126 reinterpret_cast<cvmfs::MsgHandshakeAck *>(msg_typed_));
153
2/2
✓ Branch 3 taken 150 times.
✓ Branch 4 taken 60590 times.
 60747 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgQuit") {
154 150 msg_rpc_.set_allocated_msg_quit(
155 150 reinterpret_cast<cvmfs::MsgQuit *>(msg_typed_));
156
2/2
✓ Branch 3 taken 28 times.
✓ Branch 4 taken 60569 times.
 60590 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgIoctl") {
157 28 msg_rpc_.set_allocated_msg_ioctl(
158 28 reinterpret_cast<cvmfs::MsgIoctl *>(msg_typed_));
159
2/2
✓ Branch 3 taken 6452 times.
✓ Branch 4 taken 54110 times.
 60569 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgRefcountReq") {
160 6452 msg_rpc_.set_allocated_msg_refcount_req(
161 6452 reinterpret_cast<cvmfs::MsgRefcountReq *>(msg_typed_));
162
2/2
✓ Branch 3 taken 3948 times.
✓ Branch 4 taken 50169 times.
 54110 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgRefcountReply") {
163 3948 msg_rpc_.set_allocated_msg_refcount_reply(
164 3948 reinterpret_cast<cvmfs::MsgRefcountReply *>(msg_typed_));
165
2/2
✓ Branch 3 taken 136 times.
✓ Branch 4 taken 50033 times.
 50169 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgObjectInfoReq") {
166 136 msg_rpc_.set_allocated_msg_object_info_req(
167 136 reinterpret_cast<cvmfs::MsgObjectInfoReq *>(msg_typed_));
168
2/2
✓ Branch 3 taken 112 times.
✓ Branch 4 taken 49921 times.
 50033 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgObjectInfoReply") {
169 112 msg_rpc_.set_allocated_msg_object_info_reply(
170 112 reinterpret_cast<cvmfs::MsgObjectInfoReply *>(msg_typed_));
171
2/2
✓ Branch 3 taken 16178 times.
✓ Branch 4 taken 33743 times.
 49921 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgReadReq") {
172 16178 msg_rpc_.set_allocated_msg_read_req(
173 16178 reinterpret_cast<cvmfs::MsgReadReq *>(msg_typed_));
174
2/2
✓ Branch 3 taken 15477 times.
✓ Branch 4 taken 18266 times.
 33743 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgReadReply") {
175 15477 msg_rpc_.set_allocated_msg_read_reply(
176 15477 reinterpret_cast<cvmfs::MsgReadReply *>(msg_typed_));
177
2/2
✓ Branch 3 taken 6670 times.
✓ Branch 4 taken 11596 times.
 18266 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreReq") {
178 6670 msg_rpc_.set_allocated_msg_store_req(
179 6670 reinterpret_cast<cvmfs::MsgStoreReq *>(msg_typed_));
180
2/2
✓ Branch 3 taken 7 times.
✓ Branch 4 taken 11589 times.
 11596 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreAbortReq") {
181 7 msg_rpc_.set_allocated_msg_store_abort_req(
182 7 reinterpret_cast<cvmfs::MsgStoreAbortReq *>(msg_typed_));
183
2/2
✓ Branch 3 taken 4263 times.
✓ Branch 4 taken 7326 times.
 11589 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgStoreReply") {
184 4263 msg_rpc_.set_allocated_msg_store_reply(
185 4263 reinterpret_cast<cvmfs::MsgStoreReply *>(msg_typed_));
186
2/2
✓ Branch 3 taken 52 times.
✓ Branch 4 taken 7274 times.
 7326 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgInfoReq") {
187 52 msg_rpc_.set_allocated_msg_info_req(
188 52 reinterpret_cast<cvmfs::MsgInfoReq *>(msg_typed_));
189
2/2
✓ Branch 3 taken 28 times.
✓ Branch 4 taken 7246 times.
 7274 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgInfoReply") {
190 28 msg_rpc_.set_allocated_msg_info_reply(
191 28 reinterpret_cast<cvmfs::MsgInfoReply *>(msg_typed_));
192
2/2
✓ Branch 3 taken 22 times.
✓ Branch 4 taken 7224 times.
 7246 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgShrinkReq") {
193 22 msg_rpc_.set_allocated_msg_shrink_req(
194 22 reinterpret_cast<cvmfs::MsgShrinkReq *>(msg_typed_));
195
2/2
✓ Branch 3 taken 14 times.
✓ Branch 4 taken 7210 times.
 7224 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgShrinkReply") {
196 14 msg_rpc_.set_allocated_msg_shrink_reply(
197 14 reinterpret_cast<cvmfs::MsgShrinkReply *>(msg_typed_));
198
2/2
✓ Branch 3 taken 78 times.
✓ Branch 4 taken 7132 times.
 7210 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgListReq") {
199 78 msg_rpc_.set_allocated_msg_list_req(
200 78 reinterpret_cast<cvmfs::MsgListReq *>(msg_typed_));
201
2/2
✓ Branch 3 taken 70 times.
✓ Branch 4 taken 7062 times.
 7132 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgListReply") {
202 70 msg_rpc_.set_allocated_msg_list_reply(
203 70 reinterpret_cast<cvmfs::MsgListReply *>(msg_typed_));
204
2/2
✓ Branch 3 taken 9 times.
✓ Branch 4 taken 7053 times.
 7062 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbStoreReq") {
205 9 msg_rpc_.set_allocated_msg_breadcrumb_store_req(
206 9 reinterpret_cast<cvmfs::MsgBreadcrumbStoreReq *>(msg_typed_));
207
2/2
✓ Branch 3 taken 18 times.
✓ Branch 4 taken 7035 times.
 7053 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbLoadReq") {
208 18 msg_rpc_.set_allocated_msg_breadcrumb_load_req(
209 18 reinterpret_cast<cvmfs::MsgBreadcrumbLoadReq *>(msg_typed_));
210
2/2
✓ Branch 3 taken 21 times.
✓ Branch 4 taken 7014 times.
 7035 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgBreadcrumbReply") {
211 21 msg_rpc_.set_allocated_msg_breadcrumb_reply(
212 21 reinterpret_cast<cvmfs::MsgBreadcrumbReply *>(msg_typed_));
213
1/2
✓ Branch 3 taken 7014 times.
✗ Branch 4 not taken.
 7014 } else if (msg_typed_->GetTypeName() == "cvmfs.MsgDetach") {
214 7014 msg_rpc_.set_allocated_msg_detach(
215 7014 reinterpret_cast<cvmfs::MsgDetach *>(msg_typed_));
216 7014 is_msg_out_of_band_ = true;
217 } else {
218 // Unexpected message type, should never happen
219 ✗ PANIC(NULL);
220 }
221 61025 is_wrapped_ = true;
222 61025 }
223
224
225 75176 void CacheTransport::Frame::UnwrapMsg() {
226
2/2
✓ Branch 1 taken 126 times.
✓ Branch 2 taken 75022 times.
 75176 if (msg_rpc_.has_msg_handshake()) {
227 126 msg_typed_ = msg_rpc_.mutable_msg_handshake();
228
2/2
✓ Branch 1 taken 152 times.
✓ Branch 2 taken 74877 times.
 75022 } else if (msg_rpc_.has_msg_handshake_ack()) {
229 152 msg_typed_ = msg_rpc_.mutable_msg_handshake_ack();
230
2/2
✓ Branch 1 taken 126 times.
✓ Branch 2 taken 74758 times.
 74877 } else if (msg_rpc_.has_msg_quit()) {
231 126 msg_typed_ = msg_rpc_.mutable_msg_quit();
232
2/2
✓ Branch 1 taken 28 times.
✓ Branch 2 taken 74730 times.
 74758 } else if (msg_rpc_.has_msg_ioctl()) {
233 28 msg_typed_ = msg_rpc_.mutable_msg_ioctl();
234
2/2
✓ Branch 1 taken 3948 times.
✓ Branch 2 taken 70796 times.
 74730 } else if (msg_rpc_.has_msg_refcount_req()) {
235 3948 msg_typed_ = msg_rpc_.mutable_msg_refcount_req();
236
2/2
✓ Branch 1 taken 6585 times.
✓ Branch 2 taken 64197 times.
 70796 } else if (msg_rpc_.has_msg_refcount_reply()) {
237 6585 msg_typed_ = msg_rpc_.mutable_msg_refcount_reply();
238
2/2
✓ Branch 1 taken 112 times.
✓ Branch 2 taken 64078 times.
 64197 } else if (msg_rpc_.has_msg_object_info_req()) {
239 112 msg_typed_ = msg_rpc_.mutable_msg_object_info_req();
240
2/2
✓ Branch 1 taken 199 times.
✓ Branch 2 taken 63879 times.
 64078 } else if (msg_rpc_.has_msg_object_info_reply()) {
241 199 msg_typed_ = msg_rpc_.mutable_msg_object_info_reply();
242
2/2
✓ Branch 1 taken 15477 times.
✓ Branch 2 taken 48430 times.
 63879 } else if (msg_rpc_.has_msg_read_req()) {
243 15477 msg_typed_ = msg_rpc_.mutable_msg_read_req();
244
2/2
✓ Branch 1 taken 28778 times.
✓ Branch 2 taken 19659 times.
 48430 } else if (msg_rpc_.has_msg_read_reply()) {
245 28778 msg_typed_ = msg_rpc_.mutable_msg_read_reply();
246
2/2
✓ Branch 1 taken 4256 times.
✓ Branch 2 taken 15403 times.
 19659 } else if (msg_rpc_.has_msg_store_req()) {
247 4256 msg_typed_ = msg_rpc_.mutable_msg_store_req();
248
2/2
✓ Branch 1 taken 7 times.
✓ Branch 2 taken 15396 times.
 15403 } else if (msg_rpc_.has_msg_store_abort_req()) {
249 7 msg_typed_ = msg_rpc_.mutable_msg_store_abort_req();
250
2/2
✓ Branch 1 taken 8077 times.
✓ Branch 2 taken 7319 times.
 15396 } else if (msg_rpc_.has_msg_store_reply()) {
251 8077 msg_typed_ = msg_rpc_.mutable_msg_store_reply();
252
2/2
✓ Branch 1 taken 28 times.
✓ Branch 2 taken 7291 times.
 7319 } else if (msg_rpc_.has_msg_info_req()) {
253 28 msg_typed_ = msg_rpc_.mutable_msg_info_req();
254
2/2
✓ Branch 1 taken 52 times.
✓ Branch 2 taken 7239 times.
 7291 } else if (msg_rpc_.has_msg_info_reply()) {
255 52 msg_typed_ = msg_rpc_.mutable_msg_info_reply();
256
2/2
✓ Branch 1 taken 14 times.
✓ Branch 2 taken 7225 times.
 7239 } else if (msg_rpc_.has_msg_shrink_req()) {
257 14 msg_typed_ = msg_rpc_.mutable_msg_shrink_req();
258
2/2
✓ Branch 1 taken 22 times.
✓ Branch 2 taken 7203 times.
 7225 } else if (msg_rpc_.has_msg_shrink_reply()) {
259 22 msg_typed_ = msg_rpc_.mutable_msg_shrink_reply();
260
2/2
✓ Branch 1 taken 70 times.
✓ Branch 2 taken 7133 times.
 7203 } else if (msg_rpc_.has_msg_list_req()) {
261 70 msg_typed_ = msg_rpc_.mutable_msg_list_req();
262
2/2
✓ Branch 1 taken 78 times.
✓ Branch 2 taken 7055 times.
 7133 } else if (msg_rpc_.has_msg_list_reply()) {
263 78 msg_typed_ = msg_rpc_.mutable_msg_list_reply();
264
2/2
✓ Branch 1 taken 7 times.
✓ Branch 2 taken 7048 times.
 7055 } else if (msg_rpc_.has_msg_breadcrumb_store_req()) {
265 7 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_store_req();
266
2/2
✓ Branch 1 taken 14 times.
✓ Branch 2 taken 7034 times.
 7048 } else if (msg_rpc_.has_msg_breadcrumb_load_req()) {
267 14 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_load_req();
268
2/2
✓ Branch 1 taken 27 times.
✓ Branch 2 taken 7007 times.
 7034 } else if (msg_rpc_.has_msg_breadcrumb_reply()) {
269 27 msg_typed_ = msg_rpc_.mutable_msg_breadcrumb_reply();
270
1/2
✓ Branch 1 taken 7007 times.
✗ Branch 2 not taken.
 7007 } else if (msg_rpc_.has_msg_detach()) {
271 7007 msg_typed_ = msg_rpc_.mutable_msg_detach();
272 7007 is_msg_out_of_band_ = true;
273 } else {
274 // Unexpected message type, should never happen
275 ✗ PANIC(NULL);
276 }
277 75190 }
278
279
280 //------------------------------------------------------------------------------
281
282
283 152 CacheTransport::CacheTransport(int fd_connection)
284 152 : fd_connection_(fd_connection), flags_(0) {
285
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 152 times.
 152 assert(fd_connection_ >= 0);
286 152 }
287
288
289 31227 CacheTransport::CacheTransport(int fd_connection, uint32_t flags)
290 31227 : fd_connection_(fd_connection), flags_(flags) {
291
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 31227 times.
 31227 assert(fd_connection_ >= 0);
292 31227 }
293
294
295 1413634 void CacheTransport::FillMsgHash(const shash::Any &hash,
296 cvmfs::MsgHash *msg_hash) {
297
3/4
✓ Branch 0 taken 1413594 times.
✓ Branch 1 taken 12 times.
✓ Branch 2 taken 28 times.
✗ Branch 3 not taken.
 1413634 switch (hash.algorithm) {
298 1413594 case shash::kSha1:
299 1413594 msg_hash->set_algorithm(cvmfs::HASH_SHA1);
300 1413594 break;
301 12 case shash::kRmd160:
302 12 msg_hash->set_algorithm(cvmfs::HASH_RIPEMD160);
303 12 break;
304 28 case shash::kShake128:
305 28 msg_hash->set_algorithm(cvmfs::HASH_SHAKE128);
306 28 break;
307 ✗ default:
308 ✗ PANIC(NULL);
309 }
310 1413634 msg_hash->set_digest(hash.digest, shash::kDigestSizes[hash.algorithm]);
311 1413634 }
312
313
314 6662 void CacheTransport::FillObjectType(int object_flags,
315 cvmfs::EnumObjectType *wire_type) {
316 6662 *wire_type = cvmfs::OBJECT_REGULAR;
317
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6662 times.
 6662 if (object_flags & CacheManager::kLabelCatalog)
318 ✗ *wire_type = cvmfs::OBJECT_CATALOG;
319
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6662 times.
 6662 if (object_flags & CacheManager::kLabelVolatile)
320 ✗ *wire_type = cvmfs::OBJECT_VOLATILE;
321 6662 }
322
323
324 23809 bool CacheTransport::ParseMsgHash(const cvmfs::MsgHash &msg_hash,
325 shash::Any *hash) {
326
2/4
✓ Branch 1 taken 23793 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 16 times.
✗ Branch 4 not taken.
 23809 switch (msg_hash.algorithm()) {
327 23793 case cvmfs::HASH_SHA1:
328 23793 hash->algorithm = shash::kSha1;
329 23793 break;
330 ✗ case cvmfs::HASH_RIPEMD160:
331 ✗ hash->algorithm = shash::kRmd160;
332 ✗ break;
333 16 case cvmfs::HASH_SHAKE128:
334 16 hash->algorithm = shash::kShake128;
335 16 break;
336 ✗ default:
337 ✗ return false;
338 }
339 23809 const unsigned digest_size = shash::kDigestSizes[hash->algorithm];
340
1/2
✗ Branch 2 not taken.
✓ Branch 3 taken 23809 times.
 23809 if (msg_hash.digest().length() != digest_size)
341 ✗ return false;
342 23809 memcpy(hash->digest, msg_hash.digest().data(), digest_size);
343 23809 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 61001 bool CacheTransport::RecvFrame(CacheTransport::Frame *frame) {
366 uint32_t size;
367 bool has_attachment;
368
1/2
✓ Branch 1 taken 61001 times.
✗ Branch 2 not taken.
 61001 bool retval = RecvHeader(&size, &has_attachment);
369
2/2
✓ Branch 0 taken 7 times.
✓ Branch 1 taken 60994 times.
 61001 if (!retval)
370 7 return false;
371
372 void *buffer;
373
2/2
✓ Branch 0 taken 40809 times.
✓ Branch 1 taken 20185 times.
 60994 if (size <= kMaxStackAlloc)
374 40809 buffer = alloca(size);
375 else
376 20185 buffer = smalloc(size);
377
1/2
✓ Branch 1 taken 60994 times.
✗ Branch 2 not taken.
 60994 const ssize_t nbytes = SafeRead(fd_connection_, buffer, size);
378
2/4
✓ Branch 0 taken 60994 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 60994 times.
 60994 if ((nbytes < 0) || (static_cast<uint32_t>(nbytes) != size)) {
379 ✗ if (size > kMaxStackAlloc) {
380 ✗ free(buffer);
381 }
382 ✗ return false;
383 }
384
385 60994 uint32_t msg_size = size;
386
2/2
✓ Branch 0 taken 20414 times.
✓ Branch 1 taken 40580 times.
 60994 if (has_attachment) {
387
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 20414 times.
 20414 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 20414 msg_size = (*reinterpret_cast<unsigned char *>(buffer))
396 20414 + ((*(reinterpret_cast<unsigned char *>(buffer) + 1)) << 8);
397
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 20414 times.
 20414 if ((msg_size + kInnerHeaderSize) > size) {
398 ✗ if (size > kMaxStackAlloc) {
399 ✗ free(buffer);
400 }
401 ✗ return false;
402 }
403 }
404
405 60994 void *ptr_msg = has_attachment
406
2/2
✓ Branch 0 taken 20414 times.
✓ Branch 1 taken 40580 times.
 60994 ? (reinterpret_cast<char *>(buffer) + kInnerHeaderSize)
407 : buffer;
408
1/2
✓ Branch 1 taken 60994 times.
✗ Branch 2 not taken.
 60994 retval = frame->ParseMsgRpc(ptr_msg, msg_size);
409
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 60994 times.
 60994 if (!retval) {
410 ✗ if (size > kMaxStackAlloc) {
411 ✗ free(buffer);
412 }
413 ✗ return false;
414 }
415
416
2/2
✓ Branch 0 taken 20414 times.
✓ Branch 1 taken 40580 times.
 60994 if (has_attachment) {
417 20414 const uint32_t attachment_size = size - (msg_size + kInnerHeaderSize);
418
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 20414 times.
 20414 if (frame->att_size() < attachment_size) {
419 ✗ if (size > kMaxStackAlloc) {
420 ✗ free(buffer);
421 }
422 ✗ return false;
423 }
424 20414 void *ptr_attachment = reinterpret_cast<char *>(buffer) + kInnerHeaderSize
425 20414 + msg_size;
426 20414 memcpy(frame->attachment(), ptr_attachment, attachment_size);
427 20414 frame->set_att_size(attachment_size);
428 } else {
429 40580 frame->set_att_size(0);
430 }
431
2/2
✓ Branch 0 taken 20185 times.
✓ Branch 1 taken 40788 times.
 60973 if (size > kMaxStackAlloc) {
432 20185 free(buffer);
433 }
434 60973 return true;
435 }
436
437
438 61001 bool CacheTransport::RecvHeader(uint32_t *size, bool *has_attachment) {
439 unsigned char header[kHeaderSize];
440
1/2
✓ Branch 1 taken 61001 times.
✗ Branch 2 not taken.
 61001 const ssize_t nbytes = SafeRead(fd_connection_, header, kHeaderSize);
441
3/4
✓ Branch 0 taken 61001 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 7 times.
✓ Branch 3 taken 60994 times.
 61001 if ((nbytes < 0) || (static_cast<unsigned>(nbytes) != kHeaderSize))
442 7 return false;
443
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 60994 times.
 60994 if ((header[0] & (~kFlagHasAttachment)) != kWireProtocolVersion)
444 ✗ return false;
445 60994 *has_attachment = header[0] & kFlagHasAttachment;
446 60994 *size = header[1] + (header[2] << 8) + (header[3] << 16);
447
2/4
✓ Branch 0 taken 60994 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 60994 times.
✗ Branch 3 not taken.
 60994 return (*size > 0) && (*size <= kMaxMsgSize);
448 }
449
450
451 61025 void CacheTransport::SendData(void *message,
452 uint32_t msg_size,
453 void *attachment,
454 uint32_t att_size) {
455 122050 const uint32_t total_size = msg_size + att_size
456
2/2
✓ Branch 0 taken 22131 times.
✓ Branch 1 taken 38894 times.
 61025 + ((att_size > 0) ? kInnerHeaderSize : 0);
457
458
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 61025 times.
 61025 assert(total_size > 0);
459
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 61025 times.
 61025 assert(total_size <= kMaxMsgSize);
460
1/2
✓ Branch 1 taken 55286 times.
✗ Branch 2 not taken.
 55286 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 38894 times.
✓ Branch 1 taken 22131 times.
 61025 header[0] = kWireProtocolVersion | ((att_size == 0) ? 0 : kFlagHasAttachment);
465 61025 header[1] = (total_size & 0x000000FF);
466 61025 header[2] = (total_size & 0x0000FF00) >> 8;
467 61025 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 61025 iov[0].iov_base = header;
474 61025 iov[0].iov_len = kHeaderSize;
475
476
2/2
✓ Branch 0 taken 22131 times.
✓ Branch 1 taken 38894 times.
 61025 if (att_size > 0) {
477 22131 inner_header[0] = (msg_size & 0x000000FF);
478 22131 inner_header[1] = (msg_size & 0x0000FF00) >> 8;
479 22131 iov[1].iov_base = inner_header;
480 22131 iov[1].iov_len = kInnerHeaderSize;
481 22131 iov[2].iov_base = message;
482 22131 iov[2].iov_len = msg_size;
483 22131 iov[3].iov_base = attachment;
484 22131 iov[3].iov_len = att_size;
485 } else {
486 38894 iov[1].iov_base = message;
487 38894 iov[1].iov_len = msg_size;
488 }
489
2/2
✓ Branch 0 taken 7014 times.
✓ Branch 1 taken 54011 times.
 61025 if (flags_ & kFlagSendNonBlocking) {
490
2/4
✓ Branch 0 taken 7014 times.
✗ Branch 1 not taken.
✓ Branch 3 taken 7014 times.
✗ Branch 4 not taken.
 7014 SendNonBlocking(iov, (att_size == 0) ? 2 : 4);
491 7014 return;
492 }
493
3/4
✓ Branch 0 taken 31880 times.
✓ Branch 1 taken 22131 times.
✓ Branch 3 taken 53990 times.
✗ Branch 4 not taken.
 54011 const bool retval = SafeWriteV(fd_connection_, iov, (att_size == 0) ? 2 : 4);
494
495
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 53990 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 53990 if (!retval && !(flags_ & kFlagSendIgnoreFailure)) {
496 ✗ PANIC(kLogSyslogErr | kLogDebug,
497 "failed to write to external cache transport (%d), aborting", errno);
498 }
499 }
500
501 7014 void CacheTransport::SendNonBlocking(struct iovec *iov, unsigned iovcnt) {
502
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7014 times.
 7014 assert(iovcnt > 0);
503 7014 unsigned total_size = 0;
504
2/2
✓ Branch 0 taken 14028 times.
✓ Branch 1 taken 7014 times.
 21042 for (unsigned i = 0; i < iovcnt; ++i)
505 14028 total_size += iov[i].iov_len;
506 7014 unsigned char *buffer = reinterpret_cast<unsigned char *>(alloca(total_size));
507
508 7014 unsigned pos = 0;
509
2/2
✓ Branch 0 taken 14028 times.
✓ Branch 1 taken 7014 times.
 21042 for (unsigned i = 0; i < iovcnt; ++i) {
510 14028 memcpy(buffer + pos, iov[i].iov_base, iov[i].iov_len);
511 14028 pos += iov[i].iov_len;
512 }
513
514 7014 const int retval = send(fd_connection_, buffer, total_size, MSG_DONTWAIT);
515
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7014 times.
 7014 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 7014 }
524
525
526 61025 void CacheTransport::SendFrame(CacheTransport::Frame *frame) {
527 61025 cvmfs::MsgRpc *msg_rpc = frame->GetMsgRpc();
528 61025 const int32_t size = msg_rpc->ByteSize();
529
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 61025 times.
 61025 assert(size > 0);
530 #ifdef __APPLE__
531 void *buffer = smalloc(size);
532 #else
533 61025 void *buffer = alloca(size);
534 #endif
535 61025 const bool retval = msg_rpc->SerializeToArray(buffer, size);
536
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 61025 times.
 61025 assert(retval);
537 61025 SendData(buffer, size, frame->attachment(), frame->att_size());
538 #ifdef __APPLE__
539 free(buffer);
540 #endif
541 61004 }
542