]>
Commit | Line | Data |
---|---|---|
28a4c9c5 | 1 | /* |
b3f22de0 | 2 | * This file is part of the PulseView project. |
28a4c9c5 | 3 | * |
26a883ed | 4 | * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net> |
28a4c9c5 JH |
5 | * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk> |
6 | * | |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
efdec55a | 18 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
28a4c9c5 JH |
19 | */ |
20 | ||
f3d66e52 | 21 | #include "segment.hpp" |
28a4c9c5 | 22 | |
eb8269e3 UH |
23 | #include <cassert> |
24 | #include <cstdlib> | |
25 | #include <cstring> | |
26a883ed | 26 | |
65c92359 SA |
27 | #include <QDebug> |
28 | ||
2c39cfe2 | 29 | using std::bad_alloc; |
3b68d03d | 30 | using std::lock_guard; |
6f925ba9 | 31 | using std::min; |
3b68d03d | 32 | using std::recursive_mutex; |
7d29656f | 33 | |
51e77110 | 34 | namespace pv { |
1b1ec774 | 35 | namespace data { |
51e77110 | 36 | |
51d3950f | 37 | const uint64_t Segment::MaxChunkSize = 10 * 1024 * 1024; /* 10MiB */ |
dd3f9a41 | 38 | |
85a70280 SA |
39 | Segment::Segment(uint32_t segment_id, uint64_t samplerate, unsigned int unit_size) : |
40 | segment_id_(segment_id), | |
8dbbc7f0 | 41 | sample_count_(0), |
7f4038d6 | 42 | start_time_(0), |
ff008de6 | 43 | samplerate_(samplerate), |
c70e3464 SA |
44 | unit_size_(unit_size), |
45 | iterator_count_(0), | |
558ad6ce SA |
46 | mem_optimization_requested_(false), |
47 | is_complete_(false) | |
f556bc6a | 48 | { |
8dbbc7f0 JH |
49 | lock_guard<recursive_mutex> lock(mutex_); |
50 | assert(unit_size_ > 0); | |
26a883ed SA |
51 | |
52 | // Determine the number of samples we can fit in one chunk | |
53 | // without exceeding MaxChunkSize | |
6f925ba9 | 54 | chunk_size_ = min(MaxChunkSize, (MaxChunkSize / unit_size_) * unit_size_); |
26a883ed SA |
55 | |
56 | // Create the initial chunk | |
de2fc10b | 57 | current_chunk_ = new uint8_t[chunk_size_ + 7]; /* FIXME +7 is workaround for #1284 */ |
26a883ed SA |
58 | data_chunks_.push_back(current_chunk_); |
59 | used_samples_ = 0; | |
60 | unused_samples_ = chunk_size_ / unit_size_; | |
f556bc6a JH |
61 | } |
62 | ||
f3d66e52 | 63 | Segment::~Segment() |
28a4c9c5 | 64 | { |
8dbbc7f0 | 65 | lock_guard<recursive_mutex> lock(mutex_); |
26a883ed SA |
66 | |
67 | for (uint8_t* chunk : data_chunks_) | |
68 | delete[] chunk; | |
28a4c9c5 JH |
69 | } |
70 | ||
f3d66e52 | 71 | uint64_t Segment::get_sample_count() const |
28a4c9c5 | 72 | { |
8dbbc7f0 JH |
73 | lock_guard<recursive_mutex> lock(mutex_); |
74 | return sample_count_; | |
f556bc6a JH |
75 | } |
76 | ||
60d9b99a | 77 | const pv::util::Timestamp& Segment::start_time() const |
7f4038d6 JH |
78 | { |
79 | return start_time_; | |
80 | } | |
81 | ||
f3d66e52 | 82 | double Segment::samplerate() const |
ff008de6 JH |
83 | { |
84 | return samplerate_; | |
85 | } | |
86 | ||
f3d66e52 | 87 | void Segment::set_samplerate(double samplerate) |
ff008de6 JH |
88 | { |
89 | samplerate_ = samplerate; | |
90 | } | |
91 | ||
f3d66e52 | 92 | unsigned int Segment::unit_size() const |
6fd14a32 | 93 | { |
8dbbc7f0 | 94 | return unit_size_; |
6fd14a32 JH |
95 | } |
96 | ||
85a70280 SA |
97 | uint32_t Segment::segment_id() const |
98 | { | |
99 | return segment_id_; | |
100 | } | |
101 | ||
558ad6ce SA |
102 | void Segment::set_complete() |
103 | { | |
104 | is_complete_ = true; | |
105 | } | |
106 | ||
107 | bool Segment::is_complete() const | |
108 | { | |
109 | return is_complete_; | |
110 | } | |
111 | ||
5e6967cb SA |
112 | void Segment::free_unused_memory() |
113 | { | |
114 | lock_guard<recursive_mutex> lock(mutex_); | |
115 | ||
c70e3464 SA |
116 | // Do not mess with the data chunks if we have iterators pointing at them |
117 | if (iterator_count_ > 0) { | |
118 | mem_optimization_requested_ = true; | |
119 | return; | |
120 | } | |
121 | ||
2c39cfe2 SA |
122 | if (current_chunk_) { |
123 | // No more data will come in, so re-create the last chunk accordingly | |
de2fc10b | 124 | uint8_t* resized_chunk = new uint8_t[used_samples_ * unit_size_ + 7]; /* FIXME +7 is workaround for #1284 */ |
2c39cfe2 | 125 | memcpy(resized_chunk, current_chunk_, used_samples_ * unit_size_); |
5e6967cb | 126 | |
2c39cfe2 SA |
127 | delete[] current_chunk_; |
128 | current_chunk_ = resized_chunk; | |
5e6967cb | 129 | |
2c39cfe2 SA |
130 | data_chunks_.pop_back(); |
131 | data_chunks_.push_back(resized_chunk); | |
132 | } | |
5e6967cb SA |
133 | } |
134 | ||
26a883ed SA |
135 | void Segment::append_single_sample(void *data) |
136 | { | |
137 | lock_guard<recursive_mutex> lock(mutex_); | |
138 | ||
139 | // There will always be space for at least one sample in | |
140 | // the current chunk, so we do not need to test for space | |
141 | ||
c063290a | 142 | memcpy(current_chunk_ + (used_samples_ * unit_size_), data, unit_size_); |
26a883ed SA |
143 | used_samples_++; |
144 | unused_samples_--; | |
145 | ||
146 | if (unused_samples_ == 0) { | |
de2fc10b | 147 | current_chunk_ = new uint8_t[chunk_size_ + 7]; /* FIXME +7 is workaround for #1284 */ |
26a883ed SA |
148 | data_chunks_.push_back(current_chunk_); |
149 | used_samples_ = 0; | |
150 | unused_samples_ = chunk_size_ / unit_size_; | |
151 | } | |
152 | ||
153 | sample_count_++; | |
154 | } | |
155 | ||
156 | void Segment::append_samples(void* data, uint64_t samples) | |
27d7c96b | 157 | { |
8dbbc7f0 | 158 | lock_guard<recursive_mutex> lock(mutex_); |
27d7c96b | 159 | |
257211b8 SA |
160 | const uint8_t* data_byte_ptr = (uint8_t*)data; |
161 | uint64_t remaining_samples = samples; | |
162 | uint64_t data_offset = 0; | |
163 | ||
164 | do { | |
165 | uint64_t copy_count = 0; | |
166 | ||
167 | if (remaining_samples <= unused_samples_) { | |
168 | // All samples fit into the current chunk | |
169 | copy_count = remaining_samples; | |
170 | } else { | |
171 | // Only a part of the samples fit, fill up current chunk | |
172 | copy_count = unused_samples_; | |
173 | } | |
174 | ||
175 | const uint8_t* dest = &(current_chunk_[used_samples_ * unit_size_]); | |
176 | const uint8_t* src = &(data_byte_ptr[data_offset]); | |
177 | memcpy((void*)dest, (void*)src, (copy_count * unit_size_)); | |
178 | ||
179 | used_samples_ += copy_count; | |
180 | unused_samples_ -= copy_count; | |
181 | remaining_samples -= copy_count; | |
182 | data_offset += (copy_count * unit_size_); | |
183 | ||
184 | if (unused_samples_ == 0) { | |
2c39cfe2 SA |
185 | try { |
186 | // If we're out of memory, allocating a chunk will throw | |
187 | // std::bad_alloc. To give the application some usable memory | |
188 | // to work with in case chunk allocation fails, we allocate | |
189 | // extra memory and throw it away if it all succeeded. | |
190 | // This way, memory allocation will fail early enough to let | |
191 | // PV remain alive. Otherwise, PV will crash in a random | |
192 | // memory-allocating part of the application. | |
de2fc10b | 193 | current_chunk_ = new uint8_t[chunk_size_ + 7]; /* FIXME +7 is workaround for #1284 */ |
2c39cfe2 SA |
194 | |
195 | const int dummy_size = 2 * chunk_size_; | |
196 | auto dummy_chunk = new uint8_t[dummy_size]; | |
197 | memset(dummy_chunk, 0xFF, dummy_size); | |
198 | delete[] dummy_chunk; | |
30fe44fb | 199 | } catch (bad_alloc&) { |
2c39cfe2 SA |
200 | delete[] current_chunk_; // The new may have succeeded |
201 | current_chunk_ = nullptr; | |
202 | throw; | |
203 | } | |
204 | ||
257211b8 SA |
205 | data_chunks_.push_back(current_chunk_); |
206 | used_samples_ = 0; | |
207 | unused_samples_ = chunk_size_ / unit_size_; | |
208 | } | |
209 | } while (remaining_samples > 0); | |
26a883ed SA |
210 | |
211 | sample_count_ += samples; | |
27d7c96b DK |
212 | } |
213 | ||
27ff2925 SA |
214 | const uint8_t* Segment::get_raw_sample(uint64_t sample_num) const |
215 | { | |
216 | assert(sample_num <= sample_count_); | |
217 | ||
218 | uint64_t chunk_num = (sample_num * unit_size_) / chunk_size_; | |
219 | uint64_t chunk_offs = (sample_num * unit_size_) % chunk_size_; | |
220 | ||
221 | lock_guard<recursive_mutex> lock(mutex_); // Because of free_unused_memory() | |
222 | ||
223 | const uint8_t* chunk = data_chunks_[chunk_num]; | |
224 | ||
225 | return chunk + chunk_offs; | |
226 | } | |
227 | ||
b82243f7 SA |
228 | void Segment::get_raw_samples(uint64_t start, uint64_t count, |
229 | uint8_t* dest) const | |
27d7c96b | 230 | { |
26a883ed SA |
231 | assert(start < sample_count_); |
232 | assert(start + count <= sample_count_); | |
233 | assert(count > 0); | |
b82243f7 | 234 | assert(dest != nullptr); |
26a883ed | 235 | |
26a883ed SA |
236 | uint8_t* dest_ptr = dest; |
237 | ||
238 | uint64_t chunk_num = (start * unit_size_) / chunk_size_; | |
239 | uint64_t chunk_offs = (start * unit_size_) % chunk_size_; | |
240 | ||
27ff2925 SA |
241 | lock_guard<recursive_mutex> lock(mutex_); // Because of free_unused_memory() |
242 | ||
26a883ed SA |
243 | while (count > 0) { |
244 | const uint8_t* chunk = data_chunks_[chunk_num]; | |
245 | ||
6f925ba9 | 246 | uint64_t copy_size = min(count * unit_size_, |
26a883ed SA |
247 | chunk_size_ - chunk_offs); |
248 | ||
249 | memcpy(dest_ptr, chunk + chunk_offs, copy_size); | |
250 | ||
251 | dest_ptr += copy_size; | |
252 | count -= (copy_size / unit_size_); | |
253 | ||
254 | chunk_num++; | |
255 | chunk_offs = 0; | |
256 | } | |
27d7c96b DK |
257 | } |
258 | ||
65c92359 | 259 | SegmentDataIterator* Segment::begin_sample_iteration(uint64_t start) |
26a883ed | 260 | { |
65c92359 | 261 | SegmentDataIterator* it = new SegmentDataIterator; |
26a883ed SA |
262 | |
263 | assert(start < sample_count_); | |
264 | ||
c70e3464 SA |
265 | iterator_count_++; |
266 | ||
26a883ed SA |
267 | it->sample_index = start; |
268 | it->chunk_num = (start * unit_size_) / chunk_size_; | |
269 | it->chunk_offs = (start * unit_size_) % chunk_size_; | |
270 | it->chunk = data_chunks_[it->chunk_num]; | |
26a883ed SA |
271 | |
272 | return it; | |
273 | } | |
274 | ||
65c92359 | 275 | void Segment::continue_sample_iteration(SegmentDataIterator* it, uint64_t increase) |
f556bc6a | 276 | { |
c063290a UH |
277 | it->sample_index += increase; |
278 | it->chunk_offs += (increase * unit_size_); | |
26a883ed SA |
279 | |
280 | if (it->chunk_offs > (chunk_size_ - 1)) { | |
281 | it->chunk_num++; | |
282 | it->chunk_offs -= chunk_size_; | |
283 | it->chunk = data_chunks_[it->chunk_num]; | |
284 | } | |
26a883ed | 285 | } |
27d7c96b | 286 | |
65c92359 | 287 | void Segment::end_sample_iteration(SegmentDataIterator* it) |
26a883ed SA |
288 | { |
289 | delete it; | |
c70e3464 SA |
290 | |
291 | iterator_count_--; | |
292 | ||
293 | if ((iterator_count_ == 0) && mem_optimization_requested_) { | |
294 | mem_optimization_requested_ = false; | |
295 | free_unused_memory(); | |
296 | } | |
28a4c9c5 | 297 | } |
51e77110 | 298 | |
65c92359 SA |
299 | uint8_t* Segment::get_iterator_value(SegmentDataIterator* it) |
300 | { | |
301 | assert(it->sample_index <= (sample_count_ - 1)); | |
302 | ||
303 | return (it->chunk + it->chunk_offs); | |
304 | } | |
305 | ||
50e56db0 JB |
306 | uint64_t Segment::get_iterator_valid_length(SegmentDataIterator* it) |
307 | { | |
308 | assert(it->sample_index <= (sample_count_ - 1)); | |
309 | ||
310 | return ((chunk_size_ - it->chunk_offs) / unit_size_); | |
311 | } | |
312 | ||
1b1ec774 | 313 | } // namespace data |
51e77110 | 314 | } // namespace pv |