examples: Re-enabled better thread interruption in benchmark_rate

The previous version (using atomic variables) was fine, but didn't work
with all the Boost versions we currently support on the 3.9.X release
line.
This is a slightly less safe, but still sufficient example.

1 files changed, 126 insertions, 32 deletions

diff --git a/host/examples/benchmark_rate.cpp b/host/examples/benchmark_rate.cpp
index f8c0342c0..bf3015119 100644
--- a/host/examples/benchmark_rate.cpp
+++ b/host/examples/benchmark_rate.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright 2011-2013 Ettus Research LLC
+// Copyright 2011-2015 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
@@ -24,12 +24,19 @@
 #include <boost/thread/thread.hpp>
 #include <boost/algorithm/string.hpp>
 #include <boost/lexical_cast.hpp>
+//#include <boost/atomic.hpp>
 #include <iostream>
 #include <complex>
 #include <cstdlib>
 
 namespace po = boost::program_options;
 
+const double INIT_DELAY = 0.05;  // 50mS initial delay before transmit
+//typedef boost::atomic<bool>   atomic_bool;
+// We'll fake atomic bools for now, for more backward compat.
+// This is just an example, after all.
+typedef bool atomic_bool;
+
 /***********************************************************************
  * Test result variables
  **********************************************************************/
@@ -47,7 +54,8 @@ void benchmark_rx_rate(
         uhd::usrp::multi_usrp::sptr usrp,
         const std::string &rx_cpu,
         uhd::rx_streamer::sptr rx_stream,
-        bool random_nsamps
+        bool random_nsamps,
+        atomic_bool& burst_timer_elapsed
 ) {
     uhd::set_thread_priority_safe();
 
@@ -68,31 +76,31 @@ void benchmark_rx_rate(
     const double rate = usrp->get_rx_rate();
 
     uhd::stream_cmd_t cmd(uhd::stream_cmd_t::STREAM_MODE_START_CONTINUOUS);
-    cmd.time_spec = usrp->get_time_now() + uhd::time_spec_t(0.05);
+    cmd.time_spec = usrp->get_time_now() + uhd::time_spec_t(INIT_DELAY);
     cmd.stream_now = (buffs.size() == 1);
     rx_stream->issue_stream_cmd(cmd);
 
-    while (not boost::this_thread::interruption_requested()){
+    const float burst_pkt_time = std::max(0.100, (2 * max_samps_per_packet/rate));
+    float recv_timeout = burst_pkt_time + INIT_DELAY;
+
+    while (true) {
+        //if (burst_timer_elapsed.load(boost::memory_order_relaxed)) {
+        if (burst_timer_elapsed) {
+            rx_stream->issue_stream_cmd(uhd::stream_cmd_t::STREAM_MODE_STOP_CONTINUOUS);
+        }
         if (random_nsamps) {
             cmd.num_samps = rand() % max_samps_per_packet;
             rx_stream->issue_stream_cmd(cmd);
         }
         try {
-            num_rx_samps += rx_stream->recv(buffs, max_samps_per_packet, md)*rx_stream->get_num_channels();
+            num_rx_samps += rx_stream->recv(buffs, max_samps_per_packet, md, recv_timeout)*rx_stream->get_num_channels();
+            recv_timeout = burst_pkt_time;
         }
         catch (uhd::io_error &e) {
             std::cerr << "Caught an IO exception. " << std::endl;
             std::cerr << e.what() << std::endl;
-
             return;
         }
-        catch (...) {
-            /* apparently, the boost thread interruption can sometimes result in
-               throwing exceptions not of type boost::exception, this catch allows
-               this thread to still attempt to issue the STREAM_MODE_STOP_CONTINUOUS
-            */
-            break;
-        }
 
         //handle the error codes
         switch(md.error_code){
@@ -112,13 +120,19 @@ void benchmark_rx_rate(
                 num_overflows++;
             break;
 
+        case uhd::rx_metadata_t::ERROR_CODE_TIMEOUT:
+            // If we stopped the streamer, then we expect this at some point
+            //if (burst_timer_elapsed.load(boost::memory_order_relaxed)) {
+            if (burst_timer_elapsed) {
+                return;
+            }
+            // Otherwise, it's an error
         default:
             std::cerr << "Receiver error: " << md.strerror() << std::endl;
             std::cerr << "Unexpected error on recv, continuing..." << std::endl;
             break;
         }
     }
-    rx_stream->issue_stream_cmd(uhd::stream_cmd_t::STREAM_MODE_STOP_CONTINUOUS);
 }
 
 /***********************************************************************
@@ -128,6 +142,7 @@ void benchmark_tx_rate(
         uhd::usrp::multi_usrp::sptr usrp,
         const std::string &tx_cpu,
         uhd::tx_streamer::sptr tx_stream,
+        atomic_bool& burst_timer_elapsed,
         bool random_nsamps=false
 ) {
     uhd::set_thread_priority_safe();
@@ -139,7 +154,8 @@ void benchmark_tx_rate(
 
     //setup variables and allocate buffer
     uhd::tx_metadata_t md;
-    md.time_spec = usrp->get_time_now() + uhd::time_spec_t(0.05);
+    md.time_spec = usrp->get_time_now() + uhd::time_spec_t(INIT_DELAY);
+    md.has_time_spec = (tx_stream->get_num_channels() > 1);
     const size_t max_samps_per_packet = tx_stream->get_max_num_samps();
     std::vector<char> buff(max_samps_per_packet*uhd::convert::get_bytes_per_item(tx_cpu));
     std::vector<const void *> buffs;
@@ -148,8 +164,9 @@ void benchmark_tx_rate(
     md.has_time_spec = (buffs.size() != 1);
 
     if (random_nsamps) {
-        std::srand( (unsigned int)time(NULL) );
-        while(not boost::this_thread::interruption_requested()){
+        std::srand((unsigned int)time(NULL));
+        //while (not burst_timer_elapsed.load(boost::memory_order_relaxed)) {
+        while (not burst_timer_elapsed) {
             size_t total_num_samps = rand() % max_samps_per_packet;
             size_t num_acc_samps = 0;
             const float timeout = 1;
@@ -162,7 +179,8 @@ void benchmark_tx_rate(
             }
         }
     } else {
-        while (not boost::this_thread::interruption_requested()){
+        //while (not burst_timer_elapsed.load(boost::memory_order_relaxed)) {
+        while (not burst_timer_elapsed) {
             num_tx_samps += tx_stream->send(buffs, max_samps_per_packet, md)*tx_stream->get_num_channels();
             md.has_time_spec = false;
         }
@@ -173,13 +191,25 @@ void benchmark_tx_rate(
     tx_stream->send(buffs, 0, md);
 }
 
-void benchmark_tx_rate_async_helper(uhd::tx_streamer::sptr tx_stream){
+void benchmark_tx_rate_async_helper(
+        uhd::tx_streamer::sptr tx_stream,
+        atomic_bool& burst_timer_elapsed
+) {
     //setup variables and allocate buffer
     uhd::async_metadata_t async_md;
+    bool exit_flag = false;
 
-    while (not boost::this_thread::interruption_requested()){
+    while (true) {
+        //if (burst_timer_elapsed.load(boost::memory_order_relaxed)) {
+        if (burst_timer_elapsed) {
+            exit_flag = true;
+        }
 
-        if (not tx_stream->recv_async_msg(async_md)) continue;
+        if (not tx_stream->recv_async_msg(async_md)) {
+            if (exit_flag == true)
+                return;
+            continue;
+        }
 
         //handle the error codes
         switch(async_md.event_code){
@@ -216,9 +246,10 @@ int UHD_SAFE_MAIN(int argc, char *argv[]){
     double rx_rate, tx_rate;
     std::string rx_otw, tx_otw;
     std::string rx_cpu, tx_cpu;
-    std::string mode;
+    std::string mode, ref, pps;
     std::string channel_list;
     bool random_nsamps = false;
+    atomic_bool burst_timer_elapsed(false);
 
     //setup the program options
     po::options_description desc("Allowed options");
@@ -232,7 +263,9 @@ int UHD_SAFE_MAIN(int argc, char *argv[]){
         ("tx_otw", po::value<std::string>(&tx_otw)->default_value("sc16"), "specify the over-the-wire sample mode for TX")
         ("rx_cpu", po::value<std::string>(&rx_cpu)->default_value("fc32"), "specify the host/cpu sample mode for RX")
         ("tx_cpu", po::value<std::string>(&tx_cpu)->default_value("fc32"), "specify the host/cpu sample mode for TX")
-        ("mode", po::value<std::string>(&mode)->default_value("none"), "multi-channel sync mode option: none, mimo")
+        ("ref", po::value<std::string>(&ref), "clock reference (internal, external, mimo, gpsdo)")
+        ("pps", po::value<std::string>(&pps), "PPS source (internal, external, mimo, gpsdo)")
+        ("mode", po::value<std::string>(&mode), "DEPRECATED - use \"ref\" and \"pps\" instead (none, mimo)")
         ("random", "Run with random values of samples in send() and recv() to stress-test the I/O.")
         ("channels", po::value<std::string>(&channel_list)->default_value("0"), "which channel(s) to use (specify \"0\", \"1\", \"0,1\", etc)")
     ;
@@ -257,6 +290,16 @@ int UHD_SAFE_MAIN(int argc, char *argv[]){
         random_nsamps = true;
     }
 
+    if (vm.count("mode")) {
+        if (vm.count("pps") or vm.count("ref")) {
+            std::cout << "ERROR: The \"mode\" parameter cannot be used with the \"ref\" and \"pps\" parameters.\n" << std::endl;
+            return -1;
+        } else if (mode == "mimo") {
+            ref = pps = "mimo";
+            std::cout << "The use of the \"mode\" parameter is deprecated.  Please use \"ref\" and \"pps\" parameters instead\n" << std::endl;
+        }
+    }
+
     //create a usrp device
     std::cout << std::endl;
     uhd::device_addrs_t device_addrs = uhd::device::find(args, uhd::device::USRP);
@@ -267,14 +310,57 @@ int UHD_SAFE_MAIN(int argc, char *argv[]){
     std::cout << boost::format("Creating the usrp device with: %s...") % args << std::endl;
     uhd::usrp::multi_usrp::sptr usrp = uhd::usrp::multi_usrp::make(args);
     std::cout << boost::format("Using Device: %s") % usrp->get_pp_string() << std::endl;
+    int num_mboards = usrp->get_num_mboards();
+
+    boost::thread_group thread_group;
 
-    if (mode == "mimo"){
-        usrp->set_clock_source("mimo", 0);
-        usrp->set_time_source("mimo", 0);
-        boost::this_thread::sleep(boost::posix_time::seconds(1));
+    if(vm.count("ref"))
+    {
+        if (ref == "mimo")
+        {
+            if (num_mboards != 2) {
+                std::cerr << "ERROR: ref = \"mimo\" implies 2 motherboards; your system has " << num_mboards << " boards" << std::endl;
+                return -1;
+            }
+            usrp->set_clock_source("mimo",1);
+        } else {
+            usrp->set_clock_source(ref);
+        }
+
+        if(ref != "internal") {
+            std::cout << "Now confirming lock on clock signals..." << std::endl;
+            bool is_locked = false;
+            boost::system_time end_time = boost::get_system_time() + boost::posix_time::milliseconds(80);
+            for (int i = 0; i < num_mboards; i++) {
+                if (ref == "mimo" and i == 0) continue;
+                while((is_locked = usrp->get_mboard_sensor("ref_locked",i).to_bool()) == false and
+                            boost::get_system_time() < end_time )
+                {
+                    boost::this_thread::sleep(boost::posix_time::milliseconds(1));
+                }
+                if (is_locked == false) {
+                    std::cerr << "ERROR: Unable to confirm clock signal locked on board:" << i <<  std::endl;
+                    return -1;
+                }
+                is_locked = false;
+            }
+        }
     }
 
-    boost::thread_group thread_group;
+    if(vm.count("pps"))
+    {
+       if(pps == "mimo")
+       {
+           if (num_mboards != 2) {
+               std::cerr << "ERROR: ref = \"mimo\" implies 2 motherboards; your system has " << num_mboards << " boards" << std::endl;
+               return -1;
+           }
+           //make mboard 1 a slave over the MIMO Cable
+           usrp->set_time_source("mimo", 1);
+       } else {
+           usrp->set_time_source(pps);
+       }
+    }
 
     //detect which channels to use
     std::vector<std::string> channel_strings;
@@ -288,6 +374,13 @@ int UHD_SAFE_MAIN(int argc, char *argv[]){
         else channel_nums.push_back(boost::lexical_cast<int>(channel_strings[ch]));
     }
 
+    std::cout << boost::format("Setting device timestamp to 0...") << std::endl;
+    if (pps == "mimo" or ref == "mimo" or channel_nums.size() == 1) {
+       usrp->set_time_now(0.0);
+    } else {
+       usrp->set_time_unknown_pps(uhd::time_spec_t(0.0));
+    }
+
     //spawn the receive test thread
     if (vm.count("rx_rate")){
         usrp->set_rx_rate(rx_rate);
@@ -295,7 +388,7 @@ int UHD_SAFE_MAIN(int argc, char *argv[]){
         uhd::stream_args_t stream_args(rx_cpu, rx_otw);
         stream_args.channels = channel_nums;
         uhd::rx_streamer::sptr rx_stream = usrp->get_rx_stream(stream_args);
-        thread_group.create_thread(boost::bind(&benchmark_rx_rate, usrp, rx_cpu, rx_stream, random_nsamps));
+        thread_group.create_thread(boost::bind(&benchmark_rx_rate, usrp, rx_cpu, rx_stream, random_nsamps, boost::ref(burst_timer_elapsed)));
     }
 
     //spawn the transmit test thread
@@ -305,8 +398,8 @@ int UHD_SAFE_MAIN(int argc, char *argv[]){
         uhd::stream_args_t stream_args(tx_cpu, tx_otw);
         stream_args.channels = channel_nums;
         uhd::tx_streamer::sptr tx_stream = usrp->get_tx_stream(stream_args);
-        thread_group.create_thread(boost::bind(&benchmark_tx_rate, usrp, tx_cpu, tx_stream, random_nsamps));
-        thread_group.create_thread(boost::bind(&benchmark_tx_rate_async_helper, tx_stream));
+        thread_group.create_thread(boost::bind(&benchmark_tx_rate, usrp, tx_cpu, tx_stream, boost::ref(burst_timer_elapsed), random_nsamps));
+        thread_group.create_thread(boost::bind(&benchmark_tx_rate_async_helper, tx_stream, boost::ref(burst_timer_elapsed)));
     }
 
     //sleep for the required duration
@@ -315,7 +408,8 @@ int UHD_SAFE_MAIN(int argc, char *argv[]){
     boost::this_thread::sleep(boost::posix_time::seconds(secs) + boost::posix_time::microseconds(usecs));
 
     //interrupt and join the threads
-    thread_group.interrupt_all();
+    //burst_timer_elapsed.store(true, boost::memory_order_relaxed);
+    burst_timer_elapsed = true;
     thread_group.join_all();
 
     //print summary