uhd: Added sid_t

This is a data type to represent SIDs (stream IDs).
It includes setters and getters for all components of the
SID, converters to and from string and uint32 as well
as C++ streams.

2 files changed, 159 insertions, 0 deletions

diff --git a/host/tests/CMakeLists.txt b/host/tests/CMakeLists.txt
index 62544b69b..ea0b30cb8 100644
--- a/host/tests/CMakeLists.txt
+++ b/host/tests/CMakeLists.txt
@@ -37,6 +37,7 @@ SET(test_sources
     msg_test.cpp
     property_test.cpp
     ranges_test.cpp
+    sid_t_test.cpp
     sph_recv_test.cpp
     sph_send_test.cpp
     subdev_spec_test.cpp
diff --git a/host/tests/sid_t_test.cpp b/host/tests/sid_t_test.cpp
new file mode 100644
index 000000000..71ab2c213
--- /dev/null
+++ b/host/tests/sid_t_test.cpp
@@ -0,0 +1,158 @@
+//
+// Copyright 2014 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 <iostream>
+#include <sstream>
+#include <boost/test/unit_test.hpp>
+#include <uhd/types/sid.hpp>
+#include <uhd/exception.hpp>
+
+using uhd::sid_t;
+
+BOOST_AUTO_TEST_CASE(test_sid_t) {
+    boost::uint32_t sid_value = 0x01020310;
+    sid_t sid(sid_value);
+
+    BOOST_CHECK_EQUAL(sid.is_set(), true);
+    BOOST_CHECK_EQUAL(sid.to_pp_string(), "1.2>3.16");
+    BOOST_CHECK_EQUAL(sid.to_pp_string_hex(), "01:02>03:10");
+    BOOST_CHECK_EQUAL(sid.get_src(), 0x0102);
+    BOOST_CHECK_EQUAL(sid.get_dst(), 0x0310);
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 0x01);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 0x02);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 0x03);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 0x10);
+    BOOST_CHECK_EQUAL(sid == sid, true);
+    BOOST_CHECK_EQUAL(sid == sid_value, true);
+
+    boost::uint32_t check_sid_val = (boost::uint32_t) sid;
+    BOOST_CHECK_EQUAL(check_sid_val, sid_value);
+
+    std::stringstream ss_dec;
+    ss_dec << sid;
+    BOOST_CHECK_EQUAL(ss_dec.str(), "1.2>3.16");
+
+    std::stringstream ss_hex;
+    ss_hex << std::hex << sid;
+    BOOST_CHECK_EQUAL(ss_hex.str(), "01:02>03:10");
+
+    sid_t empty_sid;
+    BOOST_CHECK_EQUAL(empty_sid.is_set(), false);
+    BOOST_CHECK_EQUAL(empty_sid.to_pp_string(), "x.x>x.x");
+    BOOST_CHECK_EQUAL(empty_sid.to_pp_string_hex(), "xx:xx>xx:xx");
+    BOOST_CHECK_EQUAL(empty_sid == sid, false);
+    BOOST_CHECK_EQUAL(empty_sid == sid_value, false);
+    BOOST_CHECK_EQUAL((bool) empty_sid, false);
+
+    empty_sid = sid_value; // No longer empty
+    BOOST_CHECK_EQUAL(empty_sid.is_set(), true);
+    BOOST_CHECK_EQUAL(empty_sid == sid, true);
+}
+
+BOOST_AUTO_TEST_CASE(test_sid_t_set) {
+    boost::uint32_t sid_value = 0x0;
+    sid_t sid(sid_value);
+
+    sid.set(0x01020304);
+    BOOST_CHECK_EQUAL(sid.get(), 0x01020304);
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 0x01);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 0x02);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 0x03);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 0x04);
+    BOOST_CHECK_EQUAL(sid.get_dst_xbarport(), 0x0);
+    BOOST_CHECK_EQUAL(sid.get_dst_blockport(), 0x4);
+
+    sid.set_src_addr(0x0a);
+    BOOST_CHECK_EQUAL(sid.get(), 0x0a020304);
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 0x0a);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 0x02);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 0x03);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 0x04);
+
+    sid.set_src_endpoint(0x0b);
+    BOOST_CHECK_EQUAL(sid.get(), 0x0a0b0304);
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 0x0a);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 0x0b);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 0x03);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 0x04);
+
+    sid.set_dst_addr(0x0c);
+    BOOST_CHECK_EQUAL(sid.get(), 0x0a0b0c04);
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 0x0a);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 0x0b);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 0x0c);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 0x04);
+
+    sid.set_dst_endpoint(0x0d);
+    BOOST_CHECK_EQUAL(sid.get(), 0x0a0b0c0d);
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 0x0a);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 0x0b);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 0x0c);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 0x0d);
+
+    sid.set_dst_xbarport(0xb);
+    BOOST_CHECK_EQUAL(sid.get(), 0x0a0b0cbd);
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 0x0a);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 0x0b);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 0x0c);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 0xbd);
+
+    sid.set_dst_blockport(0xc);
+    BOOST_CHECK_EQUAL(sid.get(), 0x0a0b0cbc);
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 0x0a);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 0x0b);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 0x0c);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 0xbc);
+
+    sid_t flipped_sid = sid.reversed();
+    BOOST_CHECK_EQUAL(flipped_sid.get(), 0x0cbc0a0b);
+
+    // In-place
+    sid.reverse();
+    BOOST_CHECK_EQUAL(sid.get(), 0x0cbc0a0b);
+}
+
+BOOST_AUTO_TEST_CASE(test_sid_t_from_str) {
+    sid_t sid("1.2>3.4");
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 1);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 2);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 3);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 4);
+
+    sid = "01:02>03:10";
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 1);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 2);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 3);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 16);
+
+    sid = "01:06/03:10";
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 1);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 6);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 3);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 16);
+
+    sid = "01:02:04:10";
+    BOOST_CHECK_EQUAL(sid.get_src_addr(), 1);
+    BOOST_CHECK_EQUAL(sid.get_src_endpoint(), 2);
+    BOOST_CHECK_EQUAL(sid.get_dst_addr(), 4);
+    BOOST_CHECK_EQUAL(sid.get_dst_endpoint(), 16);
+
+    BOOST_REQUIRE_THROW(sid_t fail_sid("foobar"), uhd::value_error);
+    BOOST_REQUIRE_THROW(sid_t fail_sid("01:02:03:4"), uhd::value_error);
+    BOOST_REQUIRE_THROW(sid_t fail_sid("01:02:03:004"), uhd::value_error);
+    BOOST_REQUIRE_THROW(sid_t fail_sid("1.2.3.0004"), uhd::value_error);
+}