pv/session.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012-14 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifdef _WIN32
  22 // Windows: Avoid boost/thread namespace pollution (which includes windows.h).
  23 #define NOGDI
  24 #define NORESOURCE
  25 #endif
  26 #include <boost/thread/locks.hpp>
  27 #include <boost/thread/shared_mutex.hpp>
  28
  29 #ifdef ENABLE_DECODE
  30 #include <libsigrokdecode/libsigrokdecode.h>
  31 #endif
  32
  33 #include "session.hpp"
  34
  35 #include "devicemanager.hpp"
  36
  37 #include "data/analog.hpp"
  38 #include "data/analogsegment.hpp"
  39 #include "data/decoderstack.hpp"
  40 #include "data/logic.hpp"
  41 #include "data/logicsegment.hpp"
  42 #include "data/decode/decoder.hpp"
  43
  44 #include "devices/hardwaredevice.hpp"
  45 #include "devices/sessionfile.hpp"
  46
  47 #include "view/analogsignal.hpp"
  48 #include "view/decodetrace.hpp"
  49 #include "view/logicsignal.hpp"
  50
  51 #include <cassert>
  52 #include <mutex>
  53 #include <stdexcept>
  54
  55 #include <sys/stat.h>
  56
  57 #include <QDebug>
  58
  59 #include <libsigrokcxx/libsigrokcxx.hpp>
  60
  61 using boost::shared_lock;
  62 using boost::shared_mutex;
  63 using boost::unique_lock;
  64
  65 using std::dynamic_pointer_cast;
  66 using std::function;
  67 using std::lock_guard;
  68 using std::list;
  69 using std::map;
  70 using std::mutex;
  71 using std::recursive_mutex;
  72 using std::set;
  73 using std::shared_ptr;
  74 using std::string;
  75 using std::unordered_set;
  76 using std::vector;
  77
  78 using sigrok::Analog;
  79 using sigrok::Channel;
  80 using sigrok::ChannelType;
  81 using sigrok::ConfigKey;
  82 using sigrok::DatafeedCallbackFunction;
  83 using sigrok::Error;
  84 using sigrok::Header;
  85 using sigrok::Logic;
  86 using sigrok::Meta;
  87 using sigrok::Packet;
  88 using sigrok::PacketPayload;
  89 using sigrok::Session;
  90 using sigrok::SessionDevice;
  91
  92 using Glib::VariantBase;
  93 using Glib::Variant;
  94
  95 namespace pv {
  96 Session::Session(DeviceManager &device_manager) :
  97         device_manager_(device_manager),
  98         capture_state_(Stopped),
  99         cur_samplerate_(0)
 100 {
 101 }
 102
 103 Session::~Session()
 104 {
 105         // Stop and join to the thread
 106         stop_capture();
 107 }
 108
 109 DeviceManager& Session::device_manager()
 110 {
 111         return device_manager_;
 112 }
 113
 114 const DeviceManager& Session::device_manager() const
 115 {
 116         return device_manager_;
 117 }
 118
 119 shared_ptr<sigrok::Session> Session::session() const
 120 {
 121         if (!device_)
 122                 return shared_ptr<sigrok::Session>();
 123         return device_->session();
 124 }
 125
 126 shared_ptr<devices::Device> Session::device() const
 127 {
 128         return device_;
 129 }
 130
 131 void Session::set_device(shared_ptr<devices::Device> device)
 132 {
 133         assert(device);
 134
 135         // Ensure we are not capturing before setting the device
 136         stop_capture();
 137
 138         if (device_)
 139                 device_->close();
 140
 141         device_ = std::move(device);
 142         device_->open();
 143         device_->session()->add_datafeed_callback([=]
 144                 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
 145                         data_feed_in(device, packet);
 146                 });
 147         update_signals();
 148
 149         decode_traces_.clear();
 150
 151         device_selected();
 152 }
 153
 154 void Session::set_default_device()
 155 {
 156         const list< shared_ptr<devices::HardwareDevice> > &devices =
 157                 device_manager_.devices();
 158
 159         if (devices.empty())
 160                 return;
 161
 162         // Try and find the demo device and select that by default
 163         const auto iter = std::find_if(devices.begin(), devices.end(),
 164                 [] (const shared_ptr<devices::HardwareDevice> &d) {
 165                         return d->hardware_device()->driver()->name() ==
 166                         "demo"; });
 167         set_device((iter == devices.end()) ? devices.front() : *iter);
 168 }
 169
 170 Session::capture_state Session::get_capture_state() const
 171 {
 172         lock_guard<mutex> lock(sampling_mutex_);
 173         return capture_state_;
 174 }
 175
 176 void Session::start_capture(function<void (const QString)> error_handler)
 177 {
 178         stop_capture();
 179
 180         // Check that at least one channel is enabled
 181         assert(device_);
 182         const shared_ptr<sigrok::Device> sr_dev = device_->device();
 183         if (sr_dev) {
 184                 const auto channels = sr_dev->channels();
 185                 if (!std::any_of(channels.begin(), channels.end(),
 186                         [](shared_ptr<Channel> channel) {
 187                                 return channel->enabled(); })) {
 188                         error_handler(tr("No channels enabled."));
 189                         return;
 190                 }
 191         }
 192
 193         // Clear signal data
 194         for (const shared_ptr<data::SignalData> d : get_data())
 195                 d->clear();
 196
 197         // Begin the session
 198         sampling_thread_ = std::thread(
 199                 &Session::sample_thread_proc, this, device_,
 200                         error_handler);
 201 }
 202
 203 void Session::stop_capture()
 204 {
 205         if (get_capture_state() != Stopped)
 206                 device_->stop();
 207
 208         // Check that sampling stopped
 209         if (sampling_thread_.joinable())
 210                 sampling_thread_.join();
 211 }
 212
 213 set< shared_ptr<data::SignalData> > Session::get_data() const
 214 {
 215         shared_lock<shared_mutex> lock(signals_mutex_);
 216         set< shared_ptr<data::SignalData> > data;
 217         for (const shared_ptr<view::Signal> sig : signals_) {
 218                 assert(sig);
 219                 data.insert(sig->data());
 220         }
 221
 222         return data;
 223 }
 224
 225 const unordered_set< shared_ptr<view::Signal> > Session::signals() const
 226 {
 227         shared_lock<shared_mutex> lock(signals_mutex_);
 228         return signals_;
 229 }
 230
 231 #ifdef ENABLE_DECODE
 232 bool Session::add_decoder(srd_decoder *const dec)
 233 {
 234         map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
 235         shared_ptr<data::DecoderStack> decoder_stack;
 236
 237         try
 238         {
 239                 lock_guard<boost::shared_mutex> lock(signals_mutex_);
 240
 241                 // Create the decoder
 242                 decoder_stack = shared_ptr<data::DecoderStack>(
 243                         new data::DecoderStack(*this, dec));
 244
 245                 // Make a list of all the channels
 246                 std::vector<const srd_channel*> all_channels;
 247                 for (const GSList *i = dec->channels; i; i = i->next)
 248                         all_channels.push_back((const srd_channel*)i->data);
 249                 for (const GSList *i = dec->opt_channels; i; i = i->next)
 250                         all_channels.push_back((const srd_channel*)i->data);
 251
 252                 // Auto select the initial channels
 253                 for (const srd_channel *pdch : all_channels)
 254                         for (shared_ptr<view::Signal> s : signals_)
 255                         {
 256                                 shared_ptr<view::LogicSignal> l =
 257                                         dynamic_pointer_cast<view::LogicSignal>(s);
 258                                 if (l && QString::fromUtf8(pdch->name).
 259                                         toLower().contains(
 260                                         l->name().toLower()))
 261                                         channels[pdch] = l;
 262                         }
 263
 264                 assert(decoder_stack);
 265                 assert(!decoder_stack->stack().empty());
 266                 assert(decoder_stack->stack().front());
 267                 decoder_stack->stack().front()->set_channels(channels);
 268
 269                 // Create the decode signal
 270                 shared_ptr<view::DecodeTrace> d(
 271                         new view::DecodeTrace(*this, decoder_stack,
 272                                 decode_traces_.size()));
 273                 decode_traces_.push_back(d);
 274         }
 275         catch(std::runtime_error e)
 276         {
 277                 return false;
 278         }
 279
 280         signals_changed();
 281
 282         // Do an initial decode
 283         decoder_stack->begin_decode();
 284
 285         return true;
 286 }
 287
 288 vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
 289 {
 290         shared_lock<shared_mutex> lock(signals_mutex_);
 291         return decode_traces_;
 292 }
 293
 294 void Session::remove_decode_signal(view::DecodeTrace *signal)
 295 {
 296         for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
 297                 if ((*i).get() == signal)
 298                 {
 299                         decode_traces_.erase(i);
 300                         signals_changed();
 301                         return;
 302                 }
 303 }
 304 #endif
 305
 306 void Session::set_capture_state(capture_state state)
 307 {
 308         lock_guard<mutex> lock(sampling_mutex_);
 309         const bool changed = capture_state_ != state;
 310         capture_state_ = state;
 311         if (changed)
 312                 capture_state_changed(state);
 313 }
 314
 315 void Session::update_signals()
 316 {
 317         assert(device_);
 318
 319         lock_guard<recursive_mutex> lock(data_mutex_);
 320
 321         const shared_ptr<sigrok::Device> sr_dev = device_->device();
 322         if (!sr_dev) {
 323                 signals_.clear();
 324                 logic_data_.reset();
 325                 return;
 326         }
 327
 328         // Detect what data types we will receive
 329         auto channels = sr_dev->channels();
 330         unsigned int logic_channel_count = std::count_if(
 331                 channels.begin(), channels.end(),
 332                 [] (shared_ptr<Channel> channel) {
 333                         return channel->type() == ChannelType::LOGIC; });
 334
 335         // Create data containers for the logic data segments
 336         {
 337                 lock_guard<recursive_mutex> data_lock(data_mutex_);
 338
 339                 if (logic_channel_count == 0) {
 340                         logic_data_.reset();
 341                 } else if (!logic_data_ ||
 342                         logic_data_->num_channels() != logic_channel_count) {
 343                         logic_data_.reset(new data::Logic(
 344                                 logic_channel_count));
 345                         assert(logic_data_);
 346                 }
 347         }
 348
 349         // Make the Signals list
 350         {
 351                 unique_lock<shared_mutex> lock(signals_mutex_);
 352
 353                 unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_);
 354                 signals_.clear();
 355
 356                 for (auto channel : sr_dev->channels()) {
 357                         shared_ptr<view::Signal> signal;
 358
 359                         // Find the channel in the old signals
 360                         const auto iter = std::find_if(
 361                                 prev_sigs.cbegin(), prev_sigs.cend(),
 362                                 [&](const shared_ptr<view::Signal> &s) {
 363                                         return s->channel() == channel;
 364                                 });
 365                         if (iter != prev_sigs.end()) {
 366                                 // Copy the signal from the old set to the new
 367                                 signal = *iter;
 368                                 auto logic_signal = dynamic_pointer_cast<
 369                                         view::LogicSignal>(signal);
 370                                 if (logic_signal)
 371                                         logic_signal->set_logic_data(
 372                                                 logic_data_);
 373                         } else {
 374                                 // Create a new signal
 375                                 switch(channel->type()->id()) {
 376                                 case SR_CHANNEL_LOGIC:
 377                                         signal = shared_ptr<view::Signal>(
 378                                                 new view::LogicSignal(*this,
 379                                                         device_, channel,
 380                                                         logic_data_));
 381                                         break;
 382
 383                                 case SR_CHANNEL_ANALOG:
 384                                 {
 385                                         shared_ptr<data::Analog> data(
 386                                                 new data::Analog());
 387                                         signal = shared_ptr<view::Signal>(
 388                                                 new view::AnalogSignal(
 389                                                         *this, channel, data));
 390                                         break;
 391                                 }
 392
 393                                 default:
 394                                         assert(0);
 395                                         break;
 396                                 }
 397                         }
 398
 399                         assert(signal);
 400                         signals_.insert(signal);
 401                 }
 402         }
 403
 404         signals_changed();
 405 }
 406
 407 shared_ptr<view::Signal> Session::signal_from_channel(
 408         shared_ptr<Channel> channel) const
 409 {
 410         lock_guard<boost::shared_mutex> lock(signals_mutex_);
 411         for (shared_ptr<view::Signal> sig : signals_) {
 412                 assert(sig);
 413                 if (sig->channel() == channel)
 414                         return sig;
 415         }
 416         return shared_ptr<view::Signal>();
 417 }
 418
 419 void Session::sample_thread_proc(shared_ptr<devices::Device> device,
 420         function<void (const QString)> error_handler)
 421 {
 422         assert(device);
 423         assert(error_handler);
 424
 425         (void)device;
 426
 427         cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
 428
 429         out_of_memory_ = false;
 430
 431         try {
 432                 device_->start();
 433         } catch(Error e) {
 434                 error_handler(e.what());
 435                 return;
 436         }
 437
 438         set_capture_state(device_->session()->trigger() ?
 439                 AwaitingTrigger : Running);
 440
 441         device_->run();
 442         set_capture_state(Stopped);
 443
 444         // Confirm that SR_DF_END was received
 445         if (cur_logic_segment_)
 446         {
 447                 qDebug("SR_DF_END was not received.");
 448                 assert(0);
 449         }
 450
 451         if (out_of_memory_)
 452                 error_handler(tr("Out of memory, acquisition stopped."));
 453 }
 454
 455 void Session::feed_in_header()
 456 {
 457         cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
 458 }
 459
 460 void Session::feed_in_meta(shared_ptr<Meta> meta)
 461 {
 462         for (auto entry : meta->config()) {
 463                 switch (entry.first->id()) {
 464                 case SR_CONF_SAMPLERATE:
 465                         /// @todo handle samplerate changes
 466                         break;
 467                 default:
 468                         // Unknown metadata is not an error.
 469                         break;
 470                 }
 471         }
 472
 473         signals_changed();
 474 }
 475
 476 void Session::feed_in_frame_begin()
 477 {
 478         if (cur_logic_segment_ || !cur_analog_segments_.empty())
 479                 frame_began();
 480 }
 481
 482 void Session::feed_in_logic(shared_ptr<Logic> logic)
 483 {
 484         lock_guard<recursive_mutex> lock(data_mutex_);
 485
 486         const size_t sample_count = logic->data_length() / logic->unit_size();
 487
 488         if (!logic_data_)
 489         {
 490                 // The only reason logic_data_ would not have been created is
 491                 // if it was not possible to determine the signals when the
 492                 // device was created.
 493                 update_signals();
 494         }
 495
 496         if (!cur_logic_segment_)
 497         {
 498                 // This could be the first packet after a trigger
 499                 set_capture_state(Running);
 500
 501                 // Create a new data segment
 502                 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
 503                         new data::LogicSegment(
 504                                 logic, cur_samplerate_, sample_count));
 505                 logic_data_->push_segment(cur_logic_segment_);
 506
 507                 // @todo Putting this here means that only listeners querying
 508                 // for logic will be notified. Currently the only user of
 509                 // frame_began is DecoderStack, but in future we need to signal
 510                 // this after both analog and logic sweeps have begun.
 511                 frame_began();
 512         }
 513         else
 514         {
 515                 // Append to the existing data segment
 516                 cur_logic_segment_->append_payload(logic);
 517         }
 518
 519         data_received();
 520 }
 521
 522 void Session::feed_in_analog(shared_ptr<Analog> analog)
 523 {
 524         lock_guard<recursive_mutex> lock(data_mutex_);
 525
 526         const vector<shared_ptr<Channel>> channels = analog->channels();
 527         const unsigned int channel_count = channels.size();
 528         const size_t sample_count = analog->num_samples() / channel_count;
 529         const float *data = static_cast<const float *>(analog->data_pointer());
 530         bool sweep_beginning = false;
 531
 532         for (auto channel : channels)
 533         {
 534                 shared_ptr<data::AnalogSegment> segment;
 535
 536                 // Try to get the segment of the channel
 537                 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
 538                         iterator iter = cur_analog_segments_.find(channel);
 539                 if (iter != cur_analog_segments_.end())
 540                         segment = (*iter).second;
 541                 else
 542                 {
 543                         // If no segment was found, this means we havn't
 544                         // created one yet. i.e. this is the first packet
 545                         // in the sweep containing this segment.
 546                         sweep_beginning = true;
 547
 548                         // Create a segment, keep it in the maps of channels
 549                         segment = shared_ptr<data::AnalogSegment>(
 550                                 new data::AnalogSegment(
 551                                         cur_samplerate_, sample_count));
 552                         cur_analog_segments_[channel] = segment;
 553
 554                         // Find the analog data associated with the channel
 555                         shared_ptr<view::AnalogSignal> sig =
 556                                 dynamic_pointer_cast<view::AnalogSignal>(
 557                                         signal_from_channel(channel));
 558                         assert(sig);
 559
 560                         shared_ptr<data::Analog> data(sig->analog_data());
 561                         assert(data);
 562
 563                         // Push the segment into the analog data.
 564                         data->push_segment(segment);
 565                 }
 566
 567                 assert(segment);
 568
 569                 // Append the samples in the segment
 570                 segment->append_interleaved_samples(data++, sample_count,
 571                         channel_count);
 572         }
 573
 574         if (sweep_beginning) {
 575                 // This could be the first packet after a trigger
 576                 set_capture_state(Running);
 577         }
 578
 579         data_received();
 580 }
 581
 582 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
 583         shared_ptr<Packet> packet)
 584 {
 585         (void)device;
 586
 587         assert(device);
 588         assert(device == device_->device());
 589         assert(packet);
 590
 591         switch (packet->type()->id()) {
 592         case SR_DF_HEADER:
 593                 feed_in_header();
 594                 break;
 595
 596         case SR_DF_META:
 597                 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
 598                 break;
 599
 600         case SR_DF_FRAME_BEGIN:
 601                 feed_in_frame_begin();
 602                 break;
 603
 604         case SR_DF_LOGIC:
 605                 try {
 606                         feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
 607                 } catch (std::bad_alloc) {
 608                         out_of_memory_ = true;
 609                         device_->stop();
 610                 }
 611                 break;
 612
 613         case SR_DF_ANALOG:
 614                 try {
 615                         feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
 616                 } catch (std::bad_alloc) {
 617                         out_of_memory_ = true;
 618                         device_->stop();
 619                 }
 620                 break;
 621
 622         case SR_DF_END:
 623         {
 624                 {
 625                         lock_guard<recursive_mutex> lock(data_mutex_);
 626                         cur_logic_segment_.reset();
 627                         cur_analog_segments_.clear();
 628                 }
 629                 frame_ended();
 630                 break;
 631         }
 632         default:
 633                 break;
 634         }
 635 }
 636
 637 } // namespace pv