uhd: created benchmark rx example app

Made mods to time spec to support math operators.

3 files changed, 162 insertions, 4 deletions

diff --git a/host/examples/CMakeLists.txt b/host/examples/CMakeLists.txt
index a537c0901..5071b114f 100644
--- a/host/examples/CMakeLists.txt
+++ b/host/examples/CMakeLists.txt
@@ -15,10 +15,18 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+ADD_EXECUTABLE(benchmark_rx_rate benchmark_rx_rate.cpp)
+TARGET_LINK_LIBRARIES(benchmark_rx_rate uhd)
+
 ADD_EXECUTABLE(rx_timed_samples rx_timed_samples.cpp)
 TARGET_LINK_LIBRARIES(rx_timed_samples uhd)
-INSTALL(TARGETS rx_timed_samples RUNTIME DESTINATION ${PKG_DATA_DIR}/examples)
 
 ADD_EXECUTABLE(tx_timed_samples tx_timed_samples.cpp)
 TARGET_LINK_LIBRARIES(tx_timed_samples uhd)
-INSTALL(TARGETS tx_timed_samples RUNTIME DESTINATION ${PKG_DATA_DIR}/examples)
+
+INSTALL(TARGETS
+    benchmark_rx_rate
+    rx_timed_samples
+    tx_timed_samples
+    RUNTIME DESTINATION ${PKG_DATA_DIR}/examples
+)
diff --git a/host/examples/benchmark_rx_rate.cpp b/host/examples/benchmark_rx_rate.cpp
new file mode 100644
index 000000000..2ab98bc22
--- /dev/null
+++ b/host/examples/benchmark_rx_rate.cpp
@@ -0,0 +1,150 @@
+//
+// Copyright 2010 Ettus Research LLC
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// 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, see <http://www.gnu.org/licenses/>.
+//
+
+#include <uhd/utils/thread_priority.hpp>
+#include <uhd/utils/safe_main.hpp>
+#include <uhd/usrp/simple_usrp.hpp>
+#include <boost/math/special_functions/round.hpp>
+#include <boost/program_options.hpp>
+#include <boost/format.hpp>
+#include <iostream>
+#include <complex>
+
+namespace po = boost::program_options;
+
+//TODO add time spec diff to API
+static inline double time_spec_diff(
+    uhd::time_spec_t time_spec_begin,
+    uhd::time_spec_t time_spec_end
+){
+    return (time_spec_end.secs - time_spec_begin.secs) + \
+        ((time_spec_end.nsecs - time_spec_begin.nsecs)*1e-9);
+}
+
+static inline void test_device(
+    uhd::usrp::simple_usrp::sptr sdev,
+    double rx_rate_sps,
+    double duration_secs
+){
+    uhd::device::sptr dev = sdev->get_device();
+    std::cout << boost::format("Testing receive rate %f Msps (%f second run)") % (rx_rate_sps/1e6) % duration_secs << std::endl;
+
+    //allocate recv buffer and metatdata
+    uhd::rx_metadata_t md;
+    std::vector<std::complex<float> > buff(dev->get_max_recv_samps_per_packet());
+
+    //declare status variables
+    bool got_first_packet = false;
+    size_t total_recv_packets = 0;
+    size_t total_lost_samples = 0;
+    size_t total_recv_samples = 0;
+    uhd::time_spec_t initial_time_spec;
+    uhd::time_spec_t next_expected_time_spec;
+    
+    sdev->issue_stream_cmd(uhd::stream_cmd_t::STREAM_MODE_START_CONTINUOUS);
+    do {
+        size_t num_rx_samps = dev->recv(
+            boost::asio::buffer(buff), md,
+            uhd::io_type_t::COMPLEX_FLOAT32,
+            uhd::device::RECV_MODE_ONE_PACKET
+        );
+        if (num_rx_samps == 0){
+            std::cerr << "Unexpected timeout on recv, exit test..." << std::endl;
+            return;
+        }
+        if (not md.has_time_spec){
+            std::cerr << "Metadata missing time spec, exit test..." << std::endl;
+            return;
+        }
+
+        total_recv_samples += num_rx_samps;
+        total_recv_packets++;
+
+        if (not got_first_packet){
+            initial_time_spec = md.time_spec;
+            next_expected_time_spec = initial_time_spec;
+            got_first_packet = true;
+        }
+
+        total_lost_samples += boost::math::iround(rx_rate_sps*time_spec_diff(next_expected_time_spec, md.time_spec));
+        next_expected_time_spec = md.time_spec + uhd::time_spec_t(0, num_rx_samps, rx_rate_sps);
+
+    } while(time_spec_diff(initial_time_spec, next_expected_time_spec) < duration_secs);
+    sdev->issue_stream_cmd(uhd::stream_cmd_t::STREAM_MODE_STOP_CONTINUOUS);
+    
+    //flush the buffers
+    while(dev->recv(
+        boost::asio::buffer(buff), md,
+        uhd::io_type_t::COMPLEX_FLOAT32,
+        uhd::device::RECV_MODE_ONE_PACKET
+    ));
+
+    //print a summary
+    std::cout << std::endl; //go to newline, recv may spew SXSYSZ...
+    std::cout << boost::format("    Received packets: %d") % total_recv_packets << std::endl;
+    std::cout << boost::format("    Received samples: %d") % total_recv_samples << std::endl;
+    std::cout << boost::format("    Lost samples: %d") % total_lost_samples << std::endl;
+    size_t packets_lost = boost::math::iround(double(total_lost_samples)/dev->get_max_recv_samps_per_packet());
+    std::cout << boost::format("    Lost packets: %d (approximate)") % packets_lost << std::endl;
+    double actual_rx_rate_sps = (total_recv_samples*rx_rate_sps)/(total_recv_samples+total_lost_samples);
+    std::cout << boost::format("    Sustained receive rate: %f Msps") % (actual_rx_rate_sps/1e6) << std::endl;
+    std::cout << std::endl << std::endl;
+}
+
+int UHD_SAFE_MAIN(int argc, char *argv[]){
+    uhd::set_thread_priority_safe();
+
+    //variables to be set by po
+    std::string args;
+    double duration;
+
+    //setup the program options
+    po::options_description desc("Allowed options");
+    desc.add_options()
+        ("help", "help message")
+        ("args", po::value<std::string>(&args)->default_value(""), "simple uhd device address args")
+        ("duration", po::value<double>(&duration)->default_value(10.0), "duration for each test in seconds")
+    ;
+    po::variables_map vm;
+    po::store(po::parse_command_line(argc, argv, desc), vm);
+    po::notify(vm);
+
+    //print the help message
+    if (vm.count("help")){
+        std::cout << boost::format("UHD Benchmark RX Rate %s") % desc << std::endl;
+        return ~0;
+    }
+
+    //create a usrp device
+    std::cout << std::endl;
+    std::cout << boost::format("Creating the usrp device with: %s...") % args << std::endl;
+    uhd::usrp::simple_usrp::sptr sdev = uhd::usrp::simple_usrp::make(args);
+    std::cout << boost::format("Using Device: %s") % sdev->get_name() << std::endl;
+
+    sdev->set_rx_rate(500e3); //initial rate
+    while(true){
+        double rate = sdev->get_rx_rate();
+        test_device(sdev, rate, duration);
+        sdev->set_rx_rate(rate*2); //double the rate
+        if (sdev->get_rx_rate() == rate) break;
+    }
+
+    //finished
+    std::cout << std::endl << "Done!" << std::endl << std::endl;
+
+    return 0;
+}
diff --git a/host/examples/rx_timed_samples.cpp b/host/examples/rx_timed_samples.cpp
index 6920b34d1..adc745024 100644
--- a/host/examples/rx_timed_samples.cpp
+++ b/host/examples/rx_timed_samples.cpp
@@ -85,8 +85,8 @@ int UHD_SAFE_MAIN(int argc, char *argv[]){
         uhd::rx_metadata_t md;
         std::vector<std::complex<float> > buff(dev->get_max_recv_samps_per_packet());
         size_t num_rx_samps = dev->recv(
-            boost::asio::buffer(buff),
-            md, uhd::io_type_t::COMPLEX_FLOAT32,
+            boost::asio::buffer(buff), md,
+            uhd::io_type_t::COMPLEX_FLOAT32,
             uhd::device::RECV_MODE_ONE_PACKET
         );
         if (num_rx_samps == 0 and num_acc_samps > 0){