Added uhd_config_info utility

10 files changed, 396 insertions, 0 deletions

diff --git a/host/cmake/Modules/UHDBuildInfo.cmake b/host/cmake/Modules/UHDBuildInfo.cmake
new file mode 100644
index 000000000..bc30b99ee
--- /dev/null
+++ b/host/cmake/Modules/UHDBuildInfo.cmake
@@ -0,0 +1,60 @@
+#
+# Copyright 2015 National Instruments Corp.
+#
+# 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/>.
+#
+
+#
+# We need this to be macro because GET_DIRECTORY_PROPERTY works with
+# the current directory.
+#
+MACRO(UHD_LOAD_BUILD_INFO)
+    MESSAGE(STATUS "")
+    MESSAGE(STATUS "Loading build info.")
+
+    # Build date
+    EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c
+        "import time; print(time.strftime('%a, %d %b %Y %H:%M:%S', time.gmtime()))"
+        OUTPUT_VARIABLE UHD_BUILD_DATE OUTPUT_STRIP_TRAILING_WHITESPACE
+    )
+
+    # Compiler name
+    IF(MSVC)
+        IF(MSVC10)
+            SET(UHD_C_COMPILER "MSVC 2010")
+            SET(UHD_CXX_COMPILER "MSVC 2010")
+        ELSEIF(MSVC11)
+            SET(UHD_C_COMPILER "MSVC 2012")
+            SET(UHD_CXX_COMPILER "MSVC 2012")
+        ELSEIF(MSVC12)
+            SET(UHD_C_COMPILER "MSVC 2013")
+            SET(UHD_CXX_COMPILER "MSVC 2013")
+        ELSEIF(MSVC14)
+            SET(UHD_C_COMPILER "MSVC 2015")
+            SET(UHD_CXX_COMPILER "MSVC 2015")
+        ELSE()
+            # Go with the ugly string
+            SET(UHD_C_COMPILER "MSVC ${CMAKE_C_COMPILER_VERSION}")
+            SET(UHD_CXX_COMPILER "MSVC ${CMAKE_CXX_COMPILER_VERSION}")
+        ENDIF(MSVC10)
+    ELSE()
+        SET(UHD_C_COMPILER "${CMAKE_C_COMPILER_ID} ${CMAKE_C_COMPILER_VERSION}")
+        SET(UHD_CXX_COMPILER "${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION}")
+    ENDIF(MSVC)
+
+    # Compiler flags
+    GET_DIRECTORY_PROPERTY(uhd_flags COMPILE_DEFINITIONS)
+    SET(UHD_C_FLAGS "${uhd_flags}${CMAKE_C_FLAGS}") # CMAKE_C_FLAGS starts with a space
+    SET(UHD_CXX_FLAGS "${uhd_flags}${CMAKE_CXX_FLAGS}") # CMAKE_CXX_FLAGS starts with a space
+ENDMACRO(UHD_LOAD_BUILD_INFO)
diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt
index 580295235..ed462459c 100644
--- a/host/docs/CMakeLists.txt
+++ b/host/docs/CMakeLists.txt
@@ -119,6 +119,7 @@ SET(man_page_sources
     uhd_cal_rx_iq_balance.1
     uhd_cal_tx_dc_offset.1
     uhd_cal_tx_iq_balance.1
+    uhd_config_info.1
     uhd_find_devices.1
     uhd_image_loader.1
     uhd_images_downloader.1
diff --git a/host/docs/uhd_config_info.1 b/host/docs/uhd_config_info.1
new file mode 100644
index 000000000..edc1b7532
--- /dev/null
+++ b/host/docs/uhd_config_info.1
@@ -0,0 +1,64 @@
+.TH "uhd_find_devices" 1 "3.9.1" UHD "User Commands"
+.SH NAME
+uhd_config_info \- USRP Hardware Driver Build Configuration Info
+.SH DESCRIPTION
+Print build information corresponding to this installation of the USRP
+Hardware Driver (UHD).
+.LP
+The UHD package is the universal hardware driver for Ettus Research
+products. The goal is to provide a host driver and API for
+current and future Ettus Research products. Users will be able to use
+the UHD driver standalone or with 3rd party applications.
+
+.SH SYNOPSIS
+.B  uhd_config_info [OPTIONS]
+
+.SH OPTIONS
+.IP "Print date this build was compiled:"
+--boost-version
+.IP "Print Boost version used:"
+--build-date
+.IP "Print C compiler used:"
+--c-compiler
+.IP "Print C++ compiler used:"
+--cxx-compiler
+.IP "Print C compile flags:"
+--c-flags
+.IP "Print C++ compile flags:"
+--cxx-flags
+.IP "Print UHD components included in this build (comma-delimited):"
+--enabled-components
+.IP "Print default install prefix for this build:"
+--install-prefix
+.IP "Print libusb version used"
+--libusb-version
+.IP "Print all information listed above:"
+--print-all
+.IP "Print UHD version:"
+--version
+.IP "This help information:"
+--help
+
+.SH SEE ALSO
+UHD documentation:
+.B http://files.ettus.com/manual/
+.LP
+GR-UHD documentation:
+.B http://gnuradio.org/doc/doxygen/page_uhd.html
+
+.SH AUTHOR
+This manual page was written by Nicholas Corgan
+for the Debian project (but may be used by others).
+
+.SH COPYRIGHT
+Copyright (c) 2015 National Instruments Corp.
+.LP
+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.
+.LP
+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.
diff --git a/host/include/config.h.in b/host/include/config.h.in
index bd690299e..83370f06f 100644
--- a/host/include/config.h.in
+++ b/host/include/config.h.in
@@ -21,4 +21,5 @@
 #cmakedefine UHD_VERSION_MAJOR ${TRIMMED_VERSION_MAJOR}
 #cmakedefine UHD_VERSION_MINOR ${TRIMMED_VERSION_MINOR}
 #cmakedefine UHD_VERSION_PATCH ${TRIMMED_VERSION_PATCH}
+#cmakedefine ENABLE_USB
 #cmakedefine UHD_VERSION @UHD_VERSION_ADDED@
diff --git a/host/include/uhd/CMakeLists.txt b/host/include/uhd/CMakeLists.txt
index 083ec4951..e55141549 100644
--- a/host/include/uhd/CMakeLists.txt
+++ b/host/include/uhd/CMakeLists.txt
@@ -27,6 +27,7 @@ CONFIGURE_FILE(
 )
 
 UHD_INSTALL(FILES
+    build_info.hpp
     config.hpp
     convert.hpp
     deprecated.hpp
diff --git a/host/include/uhd/build_info.hpp b/host/include/uhd/build_info.hpp
new file mode 100644
index 000000000..2e6571ad0
--- /dev/null
+++ b/host/include/uhd/build_info.hpp
@@ -0,0 +1,55 @@
+//
+// Copyright 2015 National Instruments Corp.
+//
+// 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/>.
+//
+
+#ifndef INCLUDED_UHD_BUILD_INFO_HPP
+#define INCLUDED_UHD_BUILD_INFO_HPP
+
+#include <uhd/config.hpp>
+
+#include <string>
+
+namespace uhd { namespace build_info {
+
+    //! Return the version of Boost this build was built with.
+    UHD_API const std::string boost_version();
+
+    //! Return the date and time (GMT) this UHD build was built.
+    UHD_API const std::string build_date();
+
+    //! Return the C compiler used for this build.
+    UHD_API const std::string c_compiler();
+
+    //! Return the C++ compiler used for this build.
+    UHD_API const std::string cxx_compiler();
+
+    //! Return the C flags passed into this build.
+    UHD_API const std::string c_flags();
+
+    //! Return the C++ flags passed into this build.
+    UHD_API const std::string cxx_flags();
+
+    //! Return the UHD components enabled for this build, comma-delimited.
+    UHD_API const std::string enabled_components();
+
+    //! Return the default CMake install prefix for this build.
+    UHD_API const std::string install_prefix();
+
+    //! Return the version of libusb this build was built with.
+    UHD_API const std::string libusb_version();
+}}
+
+#endif /* INCLUDED_UHD_BUILD_INFO_HPP */
diff --git a/host/lib/CMakeLists.txt b/host/lib/CMakeLists.txt
index 07775895d..5fb75671d 100644
--- a/host/lib/CMakeLists.txt
+++ b/host/lib/CMakeLists.txt
@@ -95,6 +95,16 @@ INCLUDE_SUBDIRECTORY(usrp_clock)
 INCLUDE_SUBDIRECTORY(utils)
 
 ########################################################################
+# Build info
+########################################################################
+INCLUDE(UHDBuildInfo)
+UHD_LOAD_BUILD_INFO()
+CONFIGURE_FILE(
+    ${CMAKE_CURRENT_SOURCE_DIR}/build_info.cpp
+    ${CMAKE_CURRENT_BINARY_DIR}/build_info.cpp
+@ONLY)
+
+########################################################################
 # Setup UHD_VERSION_STRING for version.cpp
 ########################################################################
 CONFIGURE_FILE(
@@ -106,6 +116,7 @@ CONFIGURE_FILE(
 # Append to the list of sources for lib uhd
 ########################################################################
 LIBUHD_APPEND_SOURCES(
+    ${CMAKE_CURRENT_BINARY_DIR}/build_info.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/deprecated.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/device.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/image_loader.cpp
diff --git a/host/lib/build_info.cpp b/host/lib/build_info.cpp
new file mode 100644
index 000000000..5ccfd0268
--- /dev/null
+++ b/host/lib/build_info.cpp
@@ -0,0 +1,113 @@
+//
+// Copyright 2015 National Instruments Corp.
+//
+// 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 <config.h>
+
+#include <uhd/build_info.hpp>
+
+#include <boost/format.hpp>
+#include <boost/version.hpp>
+#include <boost/algorithm/string.hpp>
+
+#ifdef ENABLE_USB
+#include <libusb.h>
+#endif
+
+namespace uhd { namespace build_info {
+
+    const std::string boost_version() {
+        return boost::algorithm::replace_all_copy(
+            std::string(BOOST_LIB_VERSION), "_", "."
+        );
+    }
+
+    const std::string build_date() {
+        return "@UHD_BUILD_DATE@";
+    }
+
+    const std::string c_compiler() {
+        return "@UHD_C_COMPILER@";
+    }
+
+    const std::string cxx_compiler() {
+        return "@UHD_CXX_COMPILER@";
+    }
+
+#ifdef _MSC_VER
+    static const std::string define_flag = "/D ";
+#else
+    static const std::string define_flag = "-D";
+#endif
+
+    const std::string c_flags() {
+        return boost::algorithm::replace_all_copy(
+            (define_flag + std::string("@UHD_C_FLAGS@")),
+            std::string(";"), (" " + define_flag)
+        );
+    }
+
+    const std::string cxx_flags() {
+        return boost::algorithm::replace_all_copy(
+            (define_flag + std::string("@UHD_CXX_FLAGS@")),
+            std::string(";"), (" " + define_flag)
+        );
+    }
+
+    const std::string enabled_components() {
+        return boost::algorithm::replace_all_copy(
+            std::string("@_uhd_enabled_components@"),
+            std::string(";"), std::string(", ")
+        );
+    }
+
+    const std::string install_prefix() {
+        return "@CMAKE_INSTALL_PREFIX@";
+    }
+
+    const std::string libusb_version() {
+    #ifdef ENABLE_USB
+        /*
+         * Versions can only be queried from 1.0.13 onward.
+         * Depending on if the commit came from libusbx or
+         * libusb (now merged), the define might be different.
+         */
+        #ifdef LIBUSB_API_VERSION /* 1.0.18 onward */
+            int major_version = LIBUSB_API_VERSION >> 24;
+            int minor_version = (LIBUSB_API_VERSION & 0xFF0000) >> 16;
+            int micro_version = ((LIBUSB_API_VERSION & 0xFFFF) - 0x100) + 18;
+
+            return str(boost::format("%d.%d.%d")
+                          % major_version % minor_version % micro_version);
+        #elif defined(LIBUSBX_API_VERSION) /* 1.0.13 - 1.0.17 */
+            switch(LIBUSBX_API_VERSION & 0xFF) {
+                case 0x00:
+                    return "1.0.13";
+                case 0x01:
+                    return "1.0.15";
+                case 0xFF:
+                    return "1.0.14";
+                default:
+                    return "1.0.16 or 1.0.17";
+            }
+        #else
+            return "< 1.0.13";
+        #endif
+    #else
+        return "N/A";
+    #endif
+    }
+}}
diff --git a/host/utils/CMakeLists.txt b/host/utils/CMakeLists.txt
index 9ab95596d..bf8d88799 100644
--- a/host/utils/CMakeLists.txt
+++ b/host/utils/CMakeLists.txt
@@ -19,6 +19,7 @@
 # Utilities that get installed into the runtime path
 ########################################################################
 SET(util_runtime_sources
+    uhd_config_info.cpp
     uhd_find_devices.cpp
     uhd_usrp_probe.cpp
     uhd_image_loader.cpp
diff --git a/host/utils/uhd_config_info.cpp b/host/utils/uhd_config_info.cpp
new file mode 100644
index 000000000..4279c325d
--- /dev/null
+++ b/host/utils/uhd_config_info.cpp
@@ -0,0 +1,89 @@
+//
+// Copyright 2015 National Instruments Corp.
+//
+// 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/build_info.hpp>
+#include <uhd/version.hpp>
+#include <uhd/utils/safe_main.hpp>
+
+#include <boost/format.hpp>
+#include <boost/program_options.hpp>
+
+namespace po = boost::program_options;
+
+int UHD_SAFE_MAIN(int argc, char* argv[]) {
+    // Program Options
+    po::options_description desc("Allowed Options");
+    desc.add_options()
+        ("build-date",         "Print build date")
+        ("c-compiler",         "Print C compiler")
+        ("cxx-compiler",       "Print C++ compiler")
+        ("c-flags",            "Print C compiler flags")
+        ("cxx-flags",          "Print C++ compiler flags")
+        ("enabled-components", "Print built-time enabled components")
+        ("install-prefix",     "Print install prefix")
+        ("libusb-version",     "Print libusb version")
+        ("print-all",          "Print everything")
+        ("version",            "Print this UHD build's version")
+        ("help",               "Print help message")
+    ;
+
+    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") > 0) {
+        std::cout << boost::format("UHD Config Info - %s") % desc << std::endl;
+        return EXIT_FAILURE;
+    }
+
+    bool print_all = (vm.count("print-all") > 0);
+
+    if(vm.count("version") > 0 or print_all) {
+        std::cout << "UHD " << uhd::get_version_string() << std::endl;
+    }
+    if(vm.count("build-date") > 0 or print_all) {
+        std::cout << "Build date: " << uhd::build_info::build_date() << std::endl;
+    }
+    if(vm.count("c-compiler") > 0 or print_all) {
+        std::cout << "C compiler: " << uhd::build_info::c_compiler() << std::endl;
+    }
+    if(vm.count("cxx-compiler") > 0 or print_all) {
+        std::cout << "C++ compiler: " << uhd::build_info::cxx_compiler() << std::endl;
+    }
+    if(vm.count("c-flags") > 0 or print_all) {
+        std::cout << "C flags: " << uhd::build_info::c_flags() << std::endl;
+    }
+    if(vm.count("cxx-flags") > 0 or print_all) {
+        std::cout << "C++ flags: " << uhd::build_info::cxx_flags() << std::endl;
+    }
+    if(vm.count("enabled-components") > 0 or print_all) {
+        std::cout << "Enabled components: " << uhd::build_info::enabled_components() << std::endl;
+    }
+    if(vm.count("install-prefix") > 0 or print_all) {
+        std::cout << "Install prefix: " << uhd::build_info::install_prefix() << std::endl;
+    }
+    if(vm.count("boost-version") > 0 or print_all) {
+        std::cout << "Boost version: " << uhd::build_info::boost_version() << std::endl;
+    }
+    if(vm.count("libusb-version") > 0 or print_all) {
+        std::string _libusb_version = uhd::build_info::libusb_version();
+        std::cout << "Libusb version: " << (_libusb_version.empty() ? "N/A" : _libusb_version) << std::endl;
+    }
+
+    return EXIT_SUCCESS;
+}