2 * This file is part of the PulseView project.
4 * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
5 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #include "segment.hpp"
30 using std::lock_guard;
32 using std::recursive_mutex;
37 const uint64_t Segment::MaxChunkSize = 10 * 1024 * 1024; /* 10MiB */
39 Segment::Segment(uint32_t segment_id, uint64_t samplerate, unsigned int unit_size) :
40 segment_id_(segment_id),
43 samplerate_(samplerate),
44 unit_size_(unit_size),
46 mem_optimization_requested_(false),
49 lock_guard<recursive_mutex> lock(mutex_);
50 assert(unit_size_ > 0);
52 // Determine the number of samples we can fit in one chunk
53 // without exceeding MaxChunkSize
54 chunk_size_ = min(MaxChunkSize, (MaxChunkSize / unit_size_) * unit_size_);
56 // Create the initial chunk
57 current_chunk_ = new uint8_t[chunk_size_ + 7]; /* FIXME +7 is workaround for #1284 */
58 data_chunks_.push_back(current_chunk_);
60 unused_samples_ = chunk_size_ / unit_size_;
65 lock_guard<recursive_mutex> lock(mutex_);
67 for (uint8_t* chunk : data_chunks_)
71 uint64_t Segment::get_sample_count() const
76 const pv::util::Timestamp& Segment::start_time() const
81 double Segment::samplerate() const
86 void Segment::set_samplerate(double samplerate)
88 samplerate_ = samplerate;
91 unsigned int Segment::unit_size() const
96 uint32_t Segment::segment_id() const
101 void Segment::set_complete()
108 bool Segment::is_complete() const
113 void Segment::free_unused_memory()
115 lock_guard<recursive_mutex> lock(mutex_);
117 // Do not mess with the data chunks if we have iterators pointing at them
118 if (iterator_count_ > 0) {
119 mem_optimization_requested_ = true;
123 if (current_chunk_) {
124 // No more data will come in, so re-create the last chunk accordingly
125 uint8_t* resized_chunk = new uint8_t[used_samples_ * unit_size_ + 7]; /* FIXME +7 is workaround for #1284 */
126 memcpy(resized_chunk, current_chunk_, used_samples_ * unit_size_);
128 delete[] current_chunk_;
129 current_chunk_ = resized_chunk;
131 data_chunks_.pop_back();
132 data_chunks_.push_back(resized_chunk);
136 void Segment::append_single_sample(void *data)
138 lock_guard<recursive_mutex> lock(mutex_);
140 // There will always be space for at least one sample in
141 // the current chunk, so we do not need to test for space
143 memcpy(current_chunk_ + (used_samples_ * unit_size_), data, unit_size_);
147 if (unused_samples_ == 0) {
148 current_chunk_ = new uint8_t[chunk_size_ + 7]; /* FIXME +7 is workaround for #1284 */
149 data_chunks_.push_back(current_chunk_);
151 unused_samples_ = chunk_size_ / unit_size_;
157 void Segment::append_samples(void* data, uint64_t samples)
159 lock_guard<recursive_mutex> lock(mutex_);
161 const uint8_t* data_byte_ptr = (uint8_t*)data;
162 uint64_t remaining_samples = samples;
163 uint64_t data_offset = 0;
166 uint64_t copy_count = 0;
168 if (remaining_samples <= unused_samples_) {
169 // All samples fit into the current chunk
170 copy_count = remaining_samples;
172 // Only a part of the samples fit, fill up current chunk
173 copy_count = unused_samples_;
176 const uint8_t* dest = &(current_chunk_[used_samples_ * unit_size_]);
177 const uint8_t* src = &(data_byte_ptr[data_offset]);
178 memcpy((void*)dest, (void*)src, (copy_count * unit_size_));
180 used_samples_ += copy_count;
181 unused_samples_ -= copy_count;
182 remaining_samples -= copy_count;
183 data_offset += (copy_count * unit_size_);
185 if (unused_samples_ == 0) {
187 // If we're out of memory, allocating a chunk will throw
188 // std::bad_alloc. To give the application some usable memory
189 // to work with in case chunk allocation fails, we allocate
190 // extra memory and throw it away if it all succeeded.
191 // This way, memory allocation will fail early enough to let
192 // PV remain alive. Otherwise, PV will crash in a random
193 // memory-allocating part of the application.
194 current_chunk_ = new uint8_t[chunk_size_ + 7]; /* FIXME +7 is workaround for #1284 */
196 const int dummy_size = 2 * chunk_size_;
197 auto dummy_chunk = new uint8_t[dummy_size];
198 memset(dummy_chunk, 0xFF, dummy_size);
199 delete[] dummy_chunk;
200 } catch (bad_alloc&) {
201 delete[] current_chunk_; // The new may have succeeded
202 current_chunk_ = nullptr;
206 data_chunks_.push_back(current_chunk_);
208 unused_samples_ = chunk_size_ / unit_size_;
210 } while (remaining_samples > 0);
212 sample_count_ += samples;
215 const uint8_t* Segment::get_raw_sample(uint64_t sample_num) const
217 assert(sample_num <= sample_count_);
219 uint64_t chunk_num = (sample_num * unit_size_) / chunk_size_;
220 uint64_t chunk_offs = (sample_num * unit_size_) % chunk_size_;
222 lock_guard<recursive_mutex> lock(mutex_); // Because of free_unused_memory()
224 const uint8_t* chunk = data_chunks_[chunk_num];
226 return chunk + chunk_offs;
229 void Segment::get_raw_samples(uint64_t start, uint64_t count, uint8_t* dest) const
231 assert(start < sample_count_);
232 assert(start + count <= sample_count_);
234 assert(dest != nullptr);
236 uint8_t* dest_ptr = dest;
238 uint64_t chunk_num = (start * unit_size_) / chunk_size_;
239 uint64_t chunk_offs = (start * unit_size_) % chunk_size_;
241 lock_guard<recursive_mutex> lock(mutex_); // Because of free_unused_memory()
244 const uint8_t* chunk = data_chunks_[chunk_num];
246 uint64_t copy_size = min(count * unit_size_,
247 chunk_size_ - chunk_offs);
249 memcpy(dest_ptr, chunk + chunk_offs, copy_size);
251 dest_ptr += copy_size;
252 count -= (copy_size / unit_size_);
259 SegmentDataIterator* Segment::begin_sample_iteration(uint64_t start)
261 SegmentDataIterator* it = new SegmentDataIterator;
263 assert(start < sample_count_);
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];
275 void Segment::continue_sample_iteration(SegmentDataIterator* it, uint64_t increase)
277 it->sample_index += increase;
278 it->chunk_offs += (increase * unit_size_);
280 if (it->chunk_offs > (chunk_size_ - 1)) {
282 it->chunk_offs -= chunk_size_;
283 it->chunk = data_chunks_[it->chunk_num];
287 void Segment::end_sample_iteration(SegmentDataIterator* it)
293 if ((iterator_count_ == 0) && mem_optimization_requested_) {
294 mem_optimization_requested_ = false;
295 free_unused_memory();
299 uint8_t* Segment::get_iterator_value(SegmentDataIterator* it)
301 assert(it->sample_index <= (sample_count_ - 1));
303 return (it->chunk + it->chunk_offs);
306 uint64_t Segment::get_iterator_valid_length(SegmentDataIterator* it)
308 assert(it->sample_index <= (sample_count_ - 1));
310 return ((chunk_size_ - it->chunk_offs) / unit_size_);