]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decoderstack.cpp
DecoderStack: Fix memory leak
[pulseview.git] / pv / data / decoderstack.cpp
index c179b24a85701f548468ae244019444700af21e8..3499baf22205cb1d0338f8d77d8645ab7d437cbd 100644 (file)
@@ -14,8 +14,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #include <libsigrokdecode/libsigrokdecode.h>
@@ -27,7 +26,7 @@
 #include "decoderstack.hpp"
 
 #include <pv/data/logic.hpp>
-#include <pv/data/logicsnapshot.hpp>
+#include <pv/data/logicsegment.hpp>
 #include <pv/data/decode/decoder.hpp>
 #include <pv/data/decode/annotation.hpp>
 #include <pv/session.hpp>
@@ -35,7 +34,6 @@
 
 using std::lock_guard;
 using std::mutex;
-using boost::optional;
 using std::unique_lock;
 using std::deque;
 using std::make_pair;
@@ -45,8 +43,11 @@ using std::list;
 using std::map;
 using std::pair;
 using std::shared_ptr;
+using std::make_shared;
 using std::vector;
 
+using boost::optional;
+
 using namespace pv::data::decode;
 
 namespace pv {
@@ -54,14 +55,16 @@ namespace data {
 
 const double DecoderStack::DecodeMargin = 1.0;
 const double DecoderStack::DecodeThreshold = 0.2;
-const int64_t DecoderStack::DecodeChunkLength = 4096;
-const unsigned int DecoderStack::DecodeNotifyPeriod = 65536;
+const int64_t DecoderStack::DecodeChunkLength = 10 * 1024 * 1024;
+const unsigned int DecoderStack::DecodeNotifyPeriod = 1024;
 
-mutex DecoderStack::global_decode_mutex_;
+mutex DecoderStack::global_srd_mutex_;
 
 DecoderStack::DecoderStack(pv::Session &session,
        const srd_decoder *const dec) :
        session_(session),
+       start_time_(0),
+       samplerate_(0),
        sample_count_(0),
        frame_complete_(false),
        samples_decoded_(0)
@@ -73,8 +76,7 @@ DecoderStack::DecoderStack(pv::Session &session,
        connect(&session_, SIGNAL(frame_ended()),
                this, SLOT(on_frame_ended()));
 
-       stack_.push_back(shared_ptr<decode::Decoder>(
-               new decode::Decoder(dec)));
+       stack_.push_back(make_shared<decode::Decoder>(dec));
 }
 
 DecoderStack::~DecoderStack()
@@ -86,13 +88,12 @@ DecoderStack::~DecoderStack()
        }
 }
 
-const std::list< std::shared_ptr<decode::Decoder> >&
-DecoderStack::stack() const
+const list< shared_ptr<decode::Decoder> >& DecoderStack::stack() const
 {
        return stack_;
 }
 
-void DecoderStack::push(std::shared_ptr<decode::Decoder> decoder)
+void DecoderStack::push(shared_ptr<decode::Decoder> decoder)
 {
        assert(decoder);
        stack_.push_back(decoder);
@@ -105,27 +106,36 @@ void DecoderStack::remove(int index)
 
        // Find the decoder in the stack
        auto iter = stack_.begin();
-       for(int i = 0; i < index; i++, iter++)
+       for (int i = 0; i < index; i++, iter++)
                assert(iter != stack_.end());
 
        // Delete the element
        stack_.erase(iter);
 }
 
+double DecoderStack::samplerate() const
+{
+       return samplerate_;
+}
+
+const pv::util::Timestamp& DecoderStack::start_time() const
+{
+       return start_time_;
+}
+
 int64_t DecoderStack::samples_decoded() const
 {
        lock_guard<mutex> decode_lock(output_mutex_);
        return samples_decoded_;
 }
 
-std::vector<Row> DecoderStack::get_visible_rows() const
+vector<Row> DecoderStack::get_visible_rows() const
 {
        lock_guard<mutex> lock(output_mutex_);
 
        vector<Row> rows;
 
-       for (const shared_ptr<decode::Decoder> &dec : stack_)
-       {
+       for (const shared_ptr<decode::Decoder> &dec : stack_) {
                assert(dec);
                if (!dec->shown())
                        continue;
@@ -135,15 +145,14 @@ std::vector<Row> DecoderStack::get_visible_rows() const
 
                // Add a row for the decoder if it doesn't have a row list
                if (!decc->annotation_rows)
-                       rows.push_back(Row(decc));
+                       rows.emplace_back(decc);
 
                // Add the decoder rows
-               for (const GSList *l = decc->annotation_rows; l; l = l->next)
-               {
+               for (const GSList *l = decc->annotation_rows; l; l = l->next) {
                        const srd_decoder_annotation_row *const ann_row =
                                (srd_decoder_annotation_row *)l->data;
                        assert(ann_row);
-                       rows.push_back(Row(decc, ann_row));
+                       rows.emplace_back(decc, ann_row);
                }
        }
 
@@ -151,7 +160,7 @@ std::vector<Row> DecoderStack::get_visible_rows() const
 }
 
 void DecoderStack::get_annotation_subset(
-       std::vector<pv::data::decode::Annotation> &dest,
+       vector<pv::data::decode::Annotation> &dest,
        const Row &row, uint64_t start_sample,
        uint64_t end_sample) const
 {
@@ -181,9 +190,6 @@ void DecoderStack::clear()
 
 void DecoderStack::begin_decode()
 {
-       shared_ptr<pv::view::LogicSignal> logic_signal;
-       shared_ptr<pv::data::Logic> data;
-
        if (decode_thread_.joinable()) {
                interrupt_ = true;
                input_cond_.notify_one();
@@ -201,8 +207,7 @@ void DecoderStack::begin_decode()
                }
 
        // Add classes
-       for (const shared_ptr<decode::Decoder> &dec : stack_)
-       {
+       for (const shared_ptr<decode::Decoder> &dec : stack_) {
                assert(dec);
                const srd_decoder *const decc = dec->decoder();
                assert(dec->decoder());
@@ -212,8 +217,7 @@ void DecoderStack::begin_decode()
                        rows_[Row(decc)] = decode::RowData();
 
                // Add the decoder rows
-               for (const GSList *l = decc->annotation_rows; l; l = l->next)
-               {
+               for (const GSList *l = decc->annotation_rows; l; l = l->next) {
                        const srd_decoder_annotation_row *const ann_row =
                                (srd_decoder_annotation_row *)l->data;
                        assert(ann_row);
@@ -233,26 +237,29 @@ void DecoderStack::begin_decode()
 
        // We get the logic data of the first channel in the list.
        // This works because we are currently assuming all
-       // LogicSignals have the same data/snapshot
+       // logic signals have the same data/segment
+       pv::data::SignalBase *signalbase;
+       pv::data::Logic *data = nullptr;
+
        for (const shared_ptr<decode::Decoder> &dec : stack_)
                if (dec && !dec->channels().empty() &&
-                       ((logic_signal = (*dec->channels().begin()).second)) &&
-                       ((data = logic_signal->logic_data())))
+                       ((signalbase = (*dec->channels().begin()).second.get())) &&
+                       ((data = signalbase->logic_data().get())))
                        break;
 
        if (!data)
                return;
 
-       // Check we have a snapshot of data
-       const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots =
-               data->get_snapshots();
-       if (snapshots.empty())
+       // Check we have a segment of data
+       const deque< shared_ptr<pv::data::LogicSegment> > &segments =
+               data->logic_segments();
+       if (segments.empty())
                return;
-       snapshot_ = snapshots.front();
+       segment_ = segments.front();
 
        // Get the samplerate and start time
-       start_time_ = data->get_start_time();
-       samplerate_ = data->samplerate();
+       start_time_ = segment_->start_time();
+       samplerate_ = segment_->samplerate();
        if (samplerate_ == 0.0)
                samplerate_ = 1.0;
 
@@ -260,13 +267,13 @@ void DecoderStack::begin_decode()
        decode_thread_ = std::thread(&DecoderStack::decode_proc, this);
 }
 
-uint64_t DecoderStack::get_max_sample_count() const
+uint64_t DecoderStack::max_sample_count() const
 {
        uint64_t max_sample_count = 0;
 
-       for (auto i = rows_.cbegin(); i != rows_.end(); i++)
+       for (const auto& row : rows_)
                max_sample_count = max(max_sample_count,
-                       (*i).second.get_max_sample());
+                       row.second.get_max_sample());
 
        return max_sample_count;
 }
@@ -274,37 +281,46 @@ uint64_t DecoderStack::get_max_sample_count() const
 optional<int64_t> DecoderStack::wait_for_data() const
 {
        unique_lock<mutex> input_lock(input_mutex_);
-       while(!interrupt_ && !frame_complete_ &&
-               samples_decoded_ >= sample_count_)
+
+       // Do wait if we decoded all samples but we're still capturing
+       // Do not wait if we're done capturing
+       while (!interrupt_ && !frame_complete_ &&
+               (samples_decoded_ >= sample_count_) &&
+               (session_.get_capture_state() != Session::Stopped)) {
+
                input_cond_.wait(input_lock);
+       }
+
+       // Return value is valid if we're not aborting the decode,
        return boost::make_optional(!interrupt_ &&
-               (samples_decoded_ < sample_count_ || !frame_complete_),
+               // and there's more work to do...
+               (samples_decoded_ < sample_count_ || !frame_complete_) &&
+               // and if the end of the data hasn't been reached yet
+               (!((samples_decoded_ >= sample_count_) && (session_.get_capture_state() == Session::Stopped))),
                sample_count_);
 }
 
 void DecoderStack::decode_data(
-       const int64_t sample_count, const unsigned int unit_size,
+       const int64_t abs_start_samplenum, const int64_t sample_count, const unsigned int unit_size,
        srd_session *const session)
 {
-       uint8_t chunk[DecodeChunkLength];
-
        const unsigned int chunk_sample_count =
-               DecodeChunkLength / snapshot_->unit_size();
+               DecodeChunkLength / segment_->unit_size();
 
-       for (int64_t i = 0; !interrupt_ && i < sample_count;
-               i += chunk_sample_count)
-       {
-               lock_guard<mutex> decode_lock(global_decode_mutex_);
+       for (int64_t i = abs_start_samplenum; !interrupt_ && i < sample_count;
+                       i += chunk_sample_count) {
 
                const int64_t chunk_end = min(
                        i + chunk_sample_count, sample_count);
-               snapshot_->get_samples(chunk, i, chunk_end);
+               const uint8_t* chunk = segment_->get_samples(i, chunk_end);
 
-               if (srd_session_send(session, i, i + sample_count, chunk,
-                               (chunk_end - i) * unit_size) != SRD_OK) {
+               if (srd_session_send(session, i, chunk_end, chunk,
+                               (chunk_end - i) * unit_size, unit_size) != SRD_OK) {
                        error_message_ = tr("Decoder reported an error");
+                       delete[] chunk;
                        break;
                }
+               delete[] chunk;
 
                {
                        lock_guard<mutex> lock(output_mutex_);
@@ -322,23 +338,24 @@ void DecoderStack::decode_proc()
 {
        optional<int64_t> sample_count;
        srd_session *session;
-       srd_decoder_inst *prev_di = NULL;
+       srd_decoder_inst *prev_di = nullptr;
 
-       assert(snapshot_);
+       assert(segment_);
+
+       // Prevent any other decode threads from accessing libsigrokdecode
+       lock_guard<mutex> srd_lock(global_srd_mutex_);
 
        // Create the session
        srd_session_new(&session);
        assert(session);
 
        // Create the decoders
-       const unsigned int unit_size = snapshot_->unit_size();
+       const unsigned int unit_size = segment_->unit_size();
 
-       for (const shared_ptr<decode::Decoder> &dec : stack_)
-       {
-               srd_decoder_inst *const di = dec->create_decoder_inst(session, unit_size);
+       for (const shared_ptr<decode::Decoder> &dec : stack_) {
+               srd_decoder_inst *const di = dec->create_decoder_inst(session);
 
-               if (!di)
-               {
+               if (!di) {
                        error_message_ = tr("Failed to create decoder instance");
                        srd_session_destroy(session);
                        return;
@@ -353,7 +370,7 @@ void DecoderStack::decode_proc()
        // Get the intial sample count
        {
                unique_lock<mutex> input_lock(input_mutex_);
-               sample_count = sample_count_ = snapshot_->get_sample_count();
+               sample_count = sample_count_ = segment_->get_sample_count();
        }
 
        // Start the session
@@ -365,9 +382,11 @@ void DecoderStack::decode_proc()
 
        srd_session_start(session);
 
+       int64_t abs_start_samplenum = 0;
        do {
-               decode_data(*sample_count, unit_size, session);
-       } while(error_message_.isEmpty() && (sample_count = wait_for_data()));
+               decode_data(abs_start_samplenum, *sample_count, unit_size, session);
+               abs_start_samplenum = *sample_count;
+       } while (error_message_.isEmpty() && (sample_count = wait_for_data()));
 
        // Destroy the session
        srd_session_destroy(session);
@@ -397,8 +416,7 @@ void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
        const auto r = d->class_rows_.find(make_pair(decc, a.format()));
        if (r != d->class_rows_.end())
                row_iter = d->rows_.find((*r).second);
-       else
-       {
+       else {
                // Failing that, use the decoder as a key
                row_iter = d->rows_.find(Row(decc));    
        }
@@ -424,8 +442,8 @@ void DecoderStack::on_data_received()
 {
        {
                unique_lock<mutex> lock(input_mutex_);
-               if (snapshot_)
-                       sample_count_ = snapshot_->get_sample_count();
+               if (segment_)
+                       sample_count_ = segment_->get_sample_count();
        }
        input_cond_.notify_one();
 }
@@ -434,7 +452,7 @@ void DecoderStack::on_frame_ended()
 {
        {
                unique_lock<mutex> lock(input_mutex_);
-               if (snapshot_)
+               if (segment_)
                        frame_complete_ = true;
        }
        input_cond_.notify_one();