GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/util/file_backed_buffer.cc
Date: 2025-12-21 02:39:23
Exec Total Coverage
Lines: 101 110 91.8%
Branches: 52 78 66.7%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #include "file_backed_buffer.h"
6
7 #include <cassert>
8 #include <cstdint>
9 #include <cstdio>
10 #include <cstdlib>
11 #include <cstring>
12 #include <string>
13 #include <unistd.h>
14
15 #include "util/exception.h"
16 #include "util/logging.h"
17 #include "util/posix.h"
18 #include "util/smalloc.h"
19
20 13830 FileBackedBuffer *FileBackedBuffer::Create(uint64_t in_memory_threshold,
21 const std::string &tmp_dir) {
22
1/2
✓ Branch 2 taken 13830 times.
✗ Branch 3 not taken.
 13830 return new FileBackedBuffer(in_memory_threshold, tmp_dir);
23 }
24
25 13830 FileBackedBuffer::FileBackedBuffer(uint64_t in_memory_threshold,
26 13830 const std::string &tmp_dir)
27 13830 : in_memory_threshold_(in_memory_threshold)
28 13830 , tmp_dir_(tmp_dir)
29 13830 , state_(kWriteState)
30 13830 , mode_(kMemoryMode)
31 13830 , size_(0)
32 13830 , buf_(NULL)
33 13830 , pos_(0)
34 13830 , fp_(NULL)
35
1/2
✓ Branch 2 taken 13830 times.
✗ Branch 3 not taken.
 13830 , file_path_("")
36 27660 , mmapped_(NULL) { }
37
38 27660 FileBackedBuffer::~FileBackedBuffer() {
39 13830 free(buf_);
40
2/2
✓ Branch 0 taken 8172 times.
✓ Branch 1 taken 5658 times.
 13830 if (mode_ != kFileMode)
41 8172 return;
42
43
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5658 times.
 5658 if (state_ == kWriteState) {
44 ✗ const int retval = fclose(fp_);
45 ✗ if (retval != 0)
46 ✗ PANIC(kLogStderr, "could not close temporary file %s: error %d",
47 file_path_.c_str(), retval);
48 } else {
49 5658 mmapped_->Unmap();
50
1/2
✓ Branch 0 taken 5658 times.
✗ Branch 1 not taken.
 5658 delete mmapped_;
51 }
52 5658 const int retval = unlink(file_path_.c_str());
53
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5658 times.
 5658 if (retval != 0)
54 ✗ PANIC(kLogStderr, "could not delete temporary file %s: error %d",
55 file_path_.c_str(), retval);
56
4/4
✓ Branch 1 taken 5658 times.
✓ Branch 2 taken 8172 times.
✓ Branch 4 taken 5658 times.
✓ Branch 5 taken 8172 times.
 22002 }
57
58 4392524 void FileBackedBuffer::Append(const void *source, uint64_t len) {
59
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4392524 times.
 4392524 assert(source != NULL);
60
61 // Cannot write after Commit()
62
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4392524 times.
 4392524 assert(state_ == kWriteState);
63
64
2/2
✓ Branch 0 taken 46 times.
✓ Branch 1 taken 4392478 times.
 4392524 if (len == 0)
65 46 return;
66
67 // check the size and eventually save to file
68
4/4
✓ Branch 0 taken 520804 times.
✓ Branch 1 taken 3871674 times.
✓ Branch 2 taken 5658 times.
✓ Branch 3 taken 515146 times.
 4392478 if (mode_ == kMemoryMode && pos_ + len > in_memory_threshold_) {
69 // changes mode_ to kFileMode
70 5658 SaveToFile();
71 }
72
73
2/2
✓ Branch 0 taken 515146 times.
✓ Branch 1 taken 3877332 times.
 4392478 if (mode_ == kMemoryMode) {
74
2/2
✓ Branch 0 taken 9378 times.
✓ Branch 1 taken 505768 times.
 515146 if (buf_ == NULL) {
75
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9378 times.
 9378 assert(size_ == 0);
76
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9378 times.
 9378 assert(pos_ == 0);
77 9378 buf_ = reinterpret_cast<unsigned char *>(smalloc(len));
78 9378 size_ = len;
79
2/2
✓ Branch 0 taken 42842 times.
✓ Branch 1 taken 462926 times.
 505768 } else if (size_ < pos_ + len) {
80 42842 const uint64_t newsize = (size_ * 2 < pos_ + len) ? (pos_ + len)
81 : (size_ * 2);
82 42842 buf_ = reinterpret_cast<unsigned char *>(srealloc(buf_, newsize));
83 42842 size_ = newsize;
84 }
85
86 515146 memcpy(buf_ + pos_, source, len);
87 515146 pos_ += len;
88 } else {
89
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3877332 times.
 3877332 assert(fp_ != NULL);
90 3877332 const uint64_t bytes_written = fwrite(source, 1, len, fp_);
91
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3877332 times.
 3877332 if (bytes_written != len) {
92 ✗ PANIC(kLogStderr,
93 "could not append to temporary file %s: length %lu, "
94 "actually written %lu, error %d",
95 file_path_.c_str(), len, bytes_written, ferror(fp_));
96 }
97 3877332 pos_ += len;
98 3877332 size_ += len;
99 }
100 }
101
102 13652 void FileBackedBuffer::Commit() {
103
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 13652 times.
 13652 assert(state_ == kWriteState);
104
105
2/2
✓ Branch 0 taken 5658 times.
✓ Branch 1 taken 7994 times.
 13652 if (mode_ == kFileMode) {
106 5658 const int retval = fclose(fp_);
107
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5658 times.
 5658 if (retval != 0)
108 ✗ PANIC(kLogStderr, "could not close file after writing finished: %s",
109 file_path_.c_str());
110 5658 fp_ = NULL;
111
112
1/2
✓ Branch 2 taken 5658 times.
✗ Branch 3 not taken.
 5658 mmapped_ = new MemoryMappedFile(file_path_);
113
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 5658 times.
 5658 if (!mmapped_->Map())
114 ✗ PANIC(kLogStderr, "could not memory-map file %s", file_path_.c_str());
115 } else {
116 // Trim memory chunk size to actual data size
117 7994 buf_ = reinterpret_cast<unsigned char *>(srealloc(buf_, pos_));
118 7994 size_ = pos_;
119 }
120
121 13652 pos_ = 0;
122 13652 state_ = kReadState;
123 13652 }
124
125 358646 int64_t FileBackedBuffer::Data(void **ptr, int64_t len, uint64_t pos) {
126
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 358646 times.
 358646 assert(state_ == kReadState);
127
128 717292 const int64_t actual_len = (pos + len <= size_)
129
2/2
✓ Branch 0 taken 6490 times.
✓ Branch 1 taken 352156 times.
 358646 ? len
130 6490 : static_cast<int64_t>(size_)
131 6490 - static_cast<int64_t>(pos);
132
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 358646 times.
 358646 assert(actual_len >= 0);
133
134
2/2
✓ Branch 0 taken 13392 times.
✓ Branch 1 taken 345254 times.
 358646 if (mode_ == kMemoryMode) {
135 13392 *ptr = buf_ + pos;
136 } else {
137 345254 *ptr = mmapped_->buffer() + pos;
138 }
139 358646 return actual_len;
140 }
141
142 345040 int64_t FileBackedBuffer::Read(void *ptr, int64_t len) {
143 345040 const int64_t bytes_read = ReadP(ptr, len, pos_);
144 345040 pos_ += bytes_read;
145 345040 return bytes_read;
146 }
147
148 345040 int64_t FileBackedBuffer::ReadP(void *ptr, int64_t len, uint64_t pos) {
149 void *source;
150
1/2
✓ Branch 1 taken 345040 times.
✗ Branch 2 not taken.
 345040 const int64_t bytes_read = Data(&source, len, pos);
151 345040 memcpy(ptr, source, bytes_read);
152 345040 return bytes_read;
153 }
154
155 13376 void FileBackedBuffer::Rewind() {
156
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 13376 times.
 13376 assert(state_ == kReadState);
157 13376 pos_ = 0;
158 13376 }
159
160 69510 uint64_t FileBackedBuffer::GetSize() const {
161
4/4
✓ Branch 0 taken 270 times.
✓ Branch 1 taken 69240 times.
✓ Branch 2 taken 224 times.
✓ Branch 3 taken 46 times.
 69510 if (state_ == kWriteState && mode_ == kMemoryMode)
162 224 return pos_;
163 69286 return size_;
164 }
165
166
167 5658 void FileBackedBuffer::SaveToFile() {
168
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5658 times.
 5658 assert(state_ == kWriteState);
169
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5658 times.
 5658 assert(mode_ == kMemoryMode);
170
171
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5658 times.
 5658 assert(fp_ == NULL);
172 5658 fp_ = CreateTempFile(tmp_dir_, 0644, "w", &file_path_);
173
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5658 times.
 5658 if (fp_ == NULL)
174 ✗ PANIC(kLogStderr, "could not create temporary file");
175
176 5658 const uint64_t bytes_written = fwrite(buf_, 1, pos_, fp_);
177
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5658 times.
 5658 if (bytes_written != pos_) {
178 ✗ PANIC(kLogStderr,
179 "could not write to temporary file %s: length %lu, "
180 "actually written %lu, error %d",
181 file_path_.c_str(), pos_, bytes_written, ferror(fp_));
182 }
183
184 5658 free(buf_);
185 5658 buf_ = NULL;
186 5658 size_ = pos_;
187 5658 mode_ = kFileMode;
188 5658 }
189