rfnoc: examples: Porting examples to new RFNoC

rfnoc_nullsource_ce_rx, rfnoc_rx_to_file:

These examples are modified so they can be run with the new RFNoC API.

test_messages:

Fixes failures in the time test when it is executed immediately after an
underrun test. The DUC considers time specs on a per burst basis, so
when the underrun test leaves a burst unfinished, a time spec on the
next burst is ignored.

1 files changed, 46 insertions, 110 deletions

diff --git a/host/examples/rfnoc_nullsource_ce_rx.cpp b/host/examples/rfnoc_nullsource_ce_rx.cpp
index 7dd21905f..640e5bcff 100644
--- a/host/examples/rfnoc_nullsource_ce_rx.cpp
+++ b/host/examples/rfnoc_nullsource_ce_rx.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright 2014 Ettus Research LLC
+// Copyright 2019 Ettus Research, a National Instruments Brand
 //
 // 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
@@ -22,8 +22,9 @@
 
 #include <uhd/device3.hpp>
 #include <uhd/exception.hpp>
-#include <uhd/rfnoc/block_ctrl.hpp>
-#include <uhd/rfnoc/null_block_ctrl.hpp>
+#include <uhd/rfnoc/block_control.hpp>
+#include <uhd/rfnoc/null_block_control.hpp>
+#include <uhd/rfnoc_graph.hpp>
 #include <uhd/utils/safe_main.hpp>
 #include <uhd/utils/thread.hpp>
 #include <boost/format.hpp>
@@ -48,7 +49,6 @@ template <typename samp_type>
 void recv_to_file(uhd::rx_streamer::sptr rx_stream,
     const std::string& file,
     size_t samps_per_buff,
-    unsigned long long num_requested_samples,
     double time_requested       = 0.0,
     bool bw_summary             = false,
     bool stats                  = false,
@@ -65,10 +65,8 @@ void recv_to_file(uhd::rx_streamer::sptr rx_stream,
     bool overflow_message = true;
 
     // setup streaming
-    uhd::stream_cmd_t stream_cmd((num_requested_samples == 0)
-                                     ? uhd::stream_cmd_t::STREAM_MODE_START_CONTINUOUS
-                                     : uhd::stream_cmd_t::STREAM_MODE_NUM_SAMPS_AND_DONE);
-    stream_cmd.num_samps  = num_requested_samples;
+    uhd::stream_cmd_t stream_cmd(uhd::stream_cmd_t::STREAM_MODE_START_CONTINUOUS);
+    stream_cmd.num_samps  = 0;
     stream_cmd.stream_now = true;
     stream_cmd.time_spec  = uhd::time_spec_t();
     std::cout << "Issuing start stream cmd" << std::endl;
@@ -85,7 +83,6 @@ void recv_to_file(uhd::rx_streamer::sptr rx_stream,
     unsigned long long last_update_samps = 0;
 
     while (not stop_signal_called
-           and (num_requested_samples != num_total_samps or num_requested_samples == 0)
            and (time_requested == 0.0 or std::chrono::steady_clock::now() <= stop_time)) {
         const auto now = std::chrono::steady_clock::now();
 
@@ -207,9 +204,9 @@ void pretty_print_flow_graph(std::vector<std::string> blocks)
 int UHD_SAFE_MAIN(int argc, char* argv[])
 {
     // variables to be set by po
-    std::string args, file, format, nullid, blockid, blockid2;
-    size_t total_num_samps, spb, spp;
-    double rate, total_time, setup_time, block_rate;
+    std::string args, file, format, nullid;
+    size_t spb, spp, throttle_cycles;
+    double rate, total_time;
 
     // setup the program options
     po::options_description desc("Allowed options");
@@ -217,22 +214,18 @@ int UHD_SAFE_MAIN(int argc, char* argv[])
     desc.add_options()
         ("help", "help message")
         ("args", po::value<std::string>(&args)->default_value("type=x300"), "multi uhd device address args")
-        ("file", po::value<std::string>(&file)->default_value("usrp_samples.dat"), "name of the file to write binary samples to, set to stdout to print")
+        ("file", po::value<std::string>(&file)->default_value("graph_samples.dat"), "name of the file to write binary samples to, set to stdout to print")
         ("null", "run without writing to file")
-        ("nsamps", po::value<size_t>(&total_num_samps)->default_value(0), "total number of samples to receive")
         ("time", po::value<double>(&total_time)->default_value(0), "total number of seconds to receive")
         ("spb", po::value<size_t>(&spb)->default_value(10000), "samples per buffer")
         ("spp", po::value<size_t>(&spp)->default_value(64), "samples per packet (on FPGA and wire)")
-        ("block_rate", po::value<double>(&block_rate)->default_value(160e6), "The clock rate of the processing block.")
+        ("throttle-cycles", po::value<size_t>(&throttle_cycles)->default_value(0), "Number of cycles to force in between packets")
         ("rate", po::value<double>(&rate)->default_value(1e6), "rate at which samples are produced in the null source")
-        ("setup", po::value<double>(&setup_time)->default_value(1.0), "seconds of setup time")
         ("format", po::value<std::string>(&format)->default_value("sc16"), "File sample type: sc16, fc32, or fc64")
         ("progress", "periodically display short-term bandwidth")
         ("stats", "show average bandwidth on exit")
         ("continue", "don't abort on a bad packet")
-        ("nullid", po::value<std::string>(&nullid)->default_value("0/NullSrcSink_0"), "The block ID for the null source.")
-        ("blockid", po::value<std::string>(&blockid)->default_value("FIFO"), "The block ID for the processing block.")
-        ("blockid2", po::value<std::string>(&blockid2)->default_value(""), "Optional: The block ID for the 2nd processing block.")
+        ("nullid", po::value<std::string>(&nullid)->default_value("0/NullSrcSink#0"), "The block ID for the null source.")
     ;
     // clang-format on
     po::variables_map vm;
@@ -256,36 +249,16 @@ int UHD_SAFE_MAIN(int argc, char* argv[])
         std::cout << "Must specify a valid block ID for the null source." << std::endl;
         return ~0;
     }
-    if (not uhd::rfnoc::block_id_t::is_valid_block_id(blockid)) {
-        std::cout << "Must specify a valid block ID for the processing block."
-                  << std::endl;
-        return ~0;
-    }
-    if (not blockid2.empty()) {
-        if (not uhd::rfnoc::block_id_t::is_valid_block_id(blockid2)) {
-            std::cout << "Invalid block ID for the 2nd processing block." << std::endl;
-            return ~0;
-        }
-    }
 
     // Set up SIGINT handler. For indefinite streaming, display info on how to stop.
     std::signal(SIGINT, &sig_int_handler);
-    if (total_num_samps == 0) {
-        std::cout << "Press Ctrl + C to stop streaming..." << std::endl;
-    }
 
     /////////////////////////////////////////////////////////////////////////
     //////// 1. Setup a USRP device /////////////////////////////////////////
     /////////////////////////////////////////////////////////////////////////
     std::cout << std::endl;
     std::cout << "Creating the USRP device with args: " << args << std::endl;
-    uhd::device3::sptr usrp = uhd::device3::make(args);
-
-    std::this_thread::sleep_for( // allow for some setup time
-        std::chrono::milliseconds(int64_t(setup_time * 1000)));
-    // Reset device streaming state
-    usrp->clear();
-    uhd::rfnoc::graph::sptr rx_graph = usrp->create_graph("rx_graph");
+    uhd::rfnoc::rfnoc_graph::sptr graph = uhd::rfnoc::rfnoc_graph::make(args);
 
     /////////////////////////////////////////////////////////////////////////
     //////// 2. Get block control objects ///////////////////////////////////
@@ -293,28 +266,16 @@ int UHD_SAFE_MAIN(int argc, char* argv[])
     std::vector<std::string> blocks;
 
     // For the null source control, we want to use the subclassed access,
-    // so we create a null_block_ctrl:
-    uhd::rfnoc::null_block_ctrl::sptr null_src_ctrl;
-    if (usrp->has_block<uhd::rfnoc::null_block_ctrl>(nullid)) {
-        null_src_ctrl = usrp->get_block_ctrl<uhd::rfnoc::null_block_ctrl>(nullid);
+    // so we create a null_block_control:
+    uhd::rfnoc::null_block_control::sptr null_src_ctrl;
+    if (graph->has_block<uhd::rfnoc::null_block_control>(nullid)) {
+        null_src_ctrl = graph->get_block<uhd::rfnoc::null_block_control>(nullid);
         blocks.push_back(null_src_ctrl->get_block_id());
     } else {
         std::cout << "Error: Device has no null block." << std::endl;
         return ~0;
     }
 
-    // For the processing blocks, we don't care what type the block is,
-    // so we make it a block_ctrl_base (default):
-    uhd::rfnoc::block_ctrl_base::sptr proc_block_ctrl, proc_block_ctrl2;
-    if (usrp->has_block(blockid)) {
-        proc_block_ctrl = usrp->get_block_ctrl(blockid);
-        blocks.push_back(proc_block_ctrl->get_block_id());
-    }
-    if (not blockid2.empty() and usrp->has_block(blockid2)) {
-        proc_block_ctrl2 = usrp->get_block_ctrl(blockid2);
-        blocks.push_back(proc_block_ctrl2->get_block_id());
-    }
-
     blocks.push_back("HOST");
     pretty_print_flow_graph(blocks);
 
@@ -322,77 +283,52 @@ int UHD_SAFE_MAIN(int argc, char* argv[])
     //////// 3. Set channel definitions /////////////////////////////////////
     /////////////////////////////////////////////////////////////////////////
     uhd::device_addr_t stream_args_args;
-    //
-    // Here, we define that there is only 1 channel, and it points
-    // to the final processing block.
-    if (proc_block_ctrl2 and proc_block_ctrl) {
-        stream_args_args["block_id"] = blockid2;
-    } else if (proc_block_ctrl) {
-        stream_args_args["block_id"] = blockid;
-    } else {
-        stream_args_args["block_id"] = nullid;
-    }
+    stream_args_args["block_id"] = nullid;
 
     /////////////////////////////////////////////////////////////////////////
     //////// 4. Configure blocks (packet size and rate) /////////////////////
     /////////////////////////////////////////////////////////////////////////
     std::cout << "Samples per packet coming from null source: " << spp << std::endl;
-    // To access properties, there's two ways. You can access args as defined
-    // in the XML file:
     const size_t BYTES_PER_SAMPLE = 4;
-    null_src_ctrl->set_arg<int>("bpp", int(spp * BYTES_PER_SAMPLE));
-    if (null_src_ctrl->get_arg<int>("bpp") != int(spp * BYTES_PER_SAMPLE)) {
+    null_src_ctrl->set_bytes_per_packet(uint32_t(spp * BYTES_PER_SAMPLE));
+    if (null_src_ctrl->get_bytes_per_packet() != uint32_t(spp * BYTES_PER_SAMPLE)) {
         std::cout << "[ERROR] Could not set samples per packet!" << std::endl;
         return ~0;
     }
-
-    // Or, if our block has its own getters + setters, you can call those:
-    std::cout << str(boost::format("Requesting rate:   %.2f Msps (%.2f MByte/s).")
-                     % (rate / 1e6) % (rate * 4 / 1e6))
-              << std::endl;
-    const size_t SAMPLES_PER_LINE = 2;
-    null_src_ctrl->set_line_rate(rate / SAMPLES_PER_LINE, block_rate);
-    // Now, it's possible that this requested rate is not available.
-    // Let's read back the true rate with the getter:
-    double actual_rate_mega =
-        null_src_ctrl->get_line_rate(block_rate) / 1e6 * SAMPLES_PER_LINE;
-    std::cout << str(boost::format("Actually got rate: %.2f Msps (%.2f MByte/s).")
-                     % actual_rate_mega % (actual_rate_mega * BYTES_PER_SAMPLE))
-              << std::endl;
-
-
-    /////////////////////////////////////////////////////////////////////////
-    //////// 5. Connect blocks //////////////////////////////////////////////
-    /////////////////////////////////////////////////////////////////////////
-    std::cout << "Connecting blocks..." << std::endl;
-    if (proc_block_ctrl) {
-        rx_graph->connect( // Yes, it's that easy!
-            null_src_ctrl->get_block_id(),
-            proc_block_ctrl->get_block_id());
-    }
-    if (proc_block_ctrl2 and proc_block_ctrl) {
-        rx_graph->connect(
-            proc_block_ctrl->get_block_id(), proc_block_ctrl2->get_block_id());
-    }
+    null_src_ctrl->set_throttle_cycles(throttle_cycles);
 
     /////////////////////////////////////////////////////////////////////////
-    //////// 6. Spawn receiver //////////////////////////////////////////////
+    //////// 5. Spawn receiver //////////////////////////////////////////////
     /////////////////////////////////////////////////////////////////////////
     uhd::stream_args_t stream_args(format, "sc16");
     stream_args.args        = stream_args_args;
     stream_args.args["spp"] = std::to_string(spp);
     UHD_LOGGER_DEBUG("RFNOC") << "Using streamer args: " << stream_args.args.to_string()
                               << std::endl;
-    uhd::rx_streamer::sptr rx_stream = usrp->get_rx_stream(stream_args);
-
-#define recv_to_file_args() \
-    (rx_stream,             \
-        file,               \
-        spb,                \
-        total_num_samps,    \
-        total_time,         \
-        bw_summary,         \
-        stats,              \
+    uhd::rx_streamer::sptr rx_stream = graph->create_rx_streamer(1, stream_args);
+
+    /////////////////////////////////////////////////////////////////////////
+    //////// 6. Connect blocks //////////////////////////////////////////////
+    /////////////////////////////////////////////////////////////////////////
+    std::cout << "Connecting blocks..." << std::endl;
+    graph->connect( // Yes, it's that easy!
+        null_src_ctrl->get_block_id(),
+        0,
+        rx_stream,
+        0);
+    graph->commit();
+
+    if (total_time == 0) {
+        std::cout << "Press Ctrl + C to stop streaming..." << std::endl;
+    }
+
+#define recv_to_file_args()           \
+    (rx_stream,                       \
+        vm.count("null") ? "" : file, \
+        spb,                          \
+        total_time,                   \
+        bw_summary,                   \
+        stats,                        \
         continue_on_bad_packet)
     // recv to file
     if (format == "fc64")