diff options
Diffstat (limited to 'contrib')
27 files changed, 2319 insertions, 643 deletions
diff --git a/contrib/ClockTAI.cpp b/contrib/ClockTAI.cpp new file mode 100644 index 0000000..2656345 --- /dev/null +++ b/contrib/ClockTAI.cpp @@ -0,0 +1,607 @@ +/* + Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, + 2011, 2012 Her Majesty the Queen in Right of Canada (Communications + Research Center Canada) + + Copyright (C) 2019 + Matthias P. Braendli, matthias.braendli@mpb.li + + http://www.opendigitalradio.org + */ +/* + This file is part of the ODR-mmbTools. + + 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/>. + */ + +/* This file downloads the TAI-UTC bulletins from the from IETF and parses them + * so that correct time can be communicated in EDI timestamps. + * + * This file contains self-test code that can be executed by running + * g++ -g -Wall -DTAI_TEST -DHAVE_CURL -std=c++11 -lcurl -pthread \ + * ClockTAI.cpp Log.cpp RemoteControl.cpp -lboost_system -o taitest && ./taitest + */ + +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif + +#include "ClockTAI.h" +#include "Log.h" + +#include <ctime> +#include <cstdio> +#include <cerrno> +#if SUPPORT_SETTING_CLOCK_TAI +# include <sys/timex.h> +#endif +#ifdef HAVE_CURL +# include <curl/curl.h> +#endif +#include <array> +#include <string> +#include <iostream> +#include <algorithm> +#include <regex> +#include <unistd.h> +#include <sys/stat.h> +#include <fcntl.h> + +using namespace std; + +#ifdef DOWNLOADED_IN_THE_PAST_TEST +static bool wait_longer = true; +#endif + +constexpr int download_retry_interval_hours = 1; + +// Offset between NTP time and POSIX time: +// timestamp_unix = timestamp_ntp - ntp_unix_offset +const int64_t ntp_unix_offset = 2208988800L; + +// leap seconds insertion bulletin is available from the IETF and in the TZ +// distribution +static array<const char*, 2> default_tai_urls = { + "https://www.ietf.org/timezones/data/leap-seconds.list", + "https://raw.githubusercontent.com/eggert/tz/master/leap-seconds.list", +}; + +// According to the Filesystem Hierarchy Standard, the data in +// /var/tmp "must not be deleted when the system is booted." +static const char *tai_cache_location = "/var/tmp/odr-leap-seconds.cache"; + +// read TAI offset from a valid bulletin in IETF format +static int parse_ietf_bulletin(const std::string& bulletin) +{ + // Example Line: + // 3692217600 37 # 1 Jan 2017 + // + // NTP timestamp<TAB>leap seconds<TAB># some comment + // The NTP timestamp starts at epoch 1.1.1900. + // The difference between NTP timestamps and unix epoch is 70 + // years i.e. 2208988800 seconds + + std::regex regex_bulletin(R"(([0-9]+)\s+([0-9]+)\s+#.*)"); + + time_t now = time(nullptr); + + int tai_utc_offset = 0; + + int tai_utc_offset_valid = false; + + stringstream ss(bulletin); + + /* We cannot just take the last line, because it might + * be in the future, announcing an upcoming leap second. + * + * So we need to look at the current date, and compare it + * with the date of the leap second. + */ + for (string line; getline(ss, line); ) { + + std::smatch bulletin_entry; + + bool is_match = std::regex_search(line, bulletin_entry, regex_bulletin); + if (is_match) { + if (bulletin_entry.size() != 3) { + throw runtime_error( + "Incorrect number of matched TAI IETF bulletin entries"); + } + const string bulletin_ntp_timestamp(bulletin_entry[1]); + const string bulletin_offset(bulletin_entry[2]); + + const int64_t timestamp_unix = + std::atoll(bulletin_ntp_timestamp.c_str()) - ntp_unix_offset; + + const int offset = std::atoi(bulletin_offset.c_str()); + // Ignore entries announcing leap seconds in the future + if (timestamp_unix < now) { + tai_utc_offset = offset; + tai_utc_offset_valid = true; + } +#if TAI_TEST + else { + cerr << "IETF Ignoring offset " << bulletin_offset << + " at TS " << bulletin_ntp_timestamp << + " in the future" << endl; + } +#endif + } + } + + if (not tai_utc_offset_valid) { + throw runtime_error("No data in TAI bulletin"); + } + + return tai_utc_offset; +} + + +struct bulletin_state { + bool valid = false; + int64_t expiry = 0; + int offset = 0; + + bool usable() const { return valid and expiry > 0; } +}; + +static bulletin_state parse_bulletin(const string& bulletin) +{ + // The bulletin contains one line that specifies an expiration date + // in NTP time. If that point in time is in the future, we consider + // the bulletin valid. + // + // The entry looks like this: + //#@ 3707596800 + + bulletin_state ret; + + std::regex regex_expiration(R"(#@\s+([0-9]+))"); + + time_t now = time(nullptr); + + stringstream ss(bulletin); + + for (string line; getline(ss, line); ) { + std::smatch bulletin_entry; + + bool is_match = std::regex_search(line, bulletin_entry, regex_expiration); + if (is_match) { + if (bulletin_entry.size() != 2) { + throw runtime_error( + "Incorrect number of matched TAI IETF bulletin expiration"); + } + const string expiry_data_str(bulletin_entry[1]); + const int64_t expiry_unix = + std::atoll(expiry_data_str.c_str()) - ntp_unix_offset; + +#ifdef TAI_TEST + etiLog.level(info) << "Bulletin expires in " << expiry_unix - now; +#endif + ret.expiry = expiry_unix - now; + try { + ret.offset = parse_ietf_bulletin(bulletin); + ret.valid = true; + } + catch (const runtime_error& e) { + etiLog.level(warn) << "Bulletin expiry ok but parse error: " << e.what(); + } + break; + } + } + return ret; +} + + +// callback that receives data from cURL +static size_t fill_bulletin(char *ptr, size_t size, size_t nmemb, void *ctx) +{ + auto *bulletin = reinterpret_cast<stringstream*>(ctx); + + size_t len = size * nmemb; + for (size_t i = 0; i < len; i++) { + *bulletin << ptr[i]; + } + return len; +} + +static string download_tai_utc_bulletin(const char* url) +{ + stringstream bulletin; + +#ifdef HAVE_CURL + CURL *curl; + CURLcode res; + + curl = curl_easy_init(); + if (curl) { + curl_easy_setopt(curl, CURLOPT_URL, url); + /* Tell libcurl to follow redirection */ + curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L); + curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, fill_bulletin); + curl_easy_setopt(curl, CURLOPT_WRITEDATA, &bulletin); + + res = curl_easy_perform(curl); + /* always cleanup ! */ + curl_easy_cleanup(curl); + + if (res != CURLE_OK) { + throw runtime_error( "TAI-UTC bulletin download failed: " + + string(curl_easy_strerror(res))); + } + } + return bulletin.str(); +#else + throw runtime_error("Cannot download TAI Clock information without cURL"); +#endif // HAVE_CURL +} + +static string load_bulletin_from_file(const char* cache_filename) +{ + int fd = open(cache_filename, O_RDWR); // lockf requires O_RDWR + if (fd == -1) { + etiLog.level(error) << "TAI-UTC bulletin open cache for reading: " << + strerror(errno); + return ""; + } + + lseek(fd, 0, SEEK_SET); + + vector<char> buf(1024); + vector<char> new_bulletin_data; + + ssize_t ret = lockf(fd, F_LOCK, 0); + if (ret == 0) { + // exclusive lock acquired + + do { + ret = read(fd, buf.data(), buf.size()); + + if (ret == -1) { + close(fd); + etiLog.level(error) << "TAI-UTC bulletin read cache: " << + strerror(errno); + return ""; + } + + copy(buf.data(), buf.data() + ret, back_inserter(new_bulletin_data)); + } while (ret > 0); + + close(fd); + + return string{new_bulletin_data.data(), new_bulletin_data.size()}; + } + else { + etiLog.level(error) << + "TAI-UTC bulletin acquire cache lock for reading: " << + strerror(errno); + close(fd); + } + return ""; +} + +ClockTAI::ClockTAI(const std::vector<std::string>& bulletin_urls) : + RemoteControllable("clocktai") +{ + RC_ADD_PARAMETER(expiry, "Number of seconds until TAI Bulletin expires"); + + if (bulletin_urls.empty()) { + etiLog.level(debug) << "Initialising default TAI Bulletin URLs"; + for (const auto url : default_tai_urls) { + m_bulletin_urls.push_back(url); + } + } + else { + etiLog.level(debug) << "Initialising user-configured TAI Bulletin URLs"; + m_bulletin_urls = bulletin_urls; + } + + for (const auto url : m_bulletin_urls) { + etiLog.level(info) << "TAI Bulletin URL: '" << url << "'"; + } +} + +int ClockTAI::get_valid_offset() +{ + int offset = 0; + bool offset_valid = false; + + std::unique_lock<std::mutex> lock(m_data_mutex); + + const auto state = parse_bulletin(m_bulletin); + if (state.usable()) { +#if TAI_TEST + etiLog.level(info) << "Bulletin already valid"; +#endif + offset = state.offset; + offset_valid = true; + } + else { + const auto cache_bulletin = load_bulletin_from_file(tai_cache_location); +#if TAI_TEST + etiLog.level(info) << "Loaded cache bulletin with " << + std::count_if(cache_bulletin.cbegin(), cache_bulletin.cend(), + [](const char c){ return c == '\n'; }) << " lines"; +#endif + const auto cache_state = parse_bulletin(cache_bulletin); + + if (cache_state.usable()) { + m_bulletin = cache_bulletin; + offset = cache_state.offset; + offset_valid = true; +#if TAI_TEST + etiLog.level(info) << "Bulletin from cache valid with offset=" << offset; +#endif + } + else { + for (const auto url : m_bulletin_urls) { + try { +#if TAI_TEST + etiLog.level(info) << "Load bulletin from " << url; +#endif + const auto new_bulletin = download_tai_utc_bulletin(url.c_str()); + const auto new_state = parse_bulletin(new_bulletin); + if (new_state.usable()) { + m_bulletin = new_bulletin; + offset = new_state.offset; + offset_valid = true; + + etiLog.level(debug) << "Loaded valid TAI Bulletin from " << + url << " giving offset=" << offset; + } + else { + etiLog.level(debug) << "Skipping invalid TAI bulletin from " + << url; + } + } + catch (const runtime_error& e) { + etiLog.level(warn) << + "TAI-UTC offset could not be retrieved from " << + url << " : " << e.what(); + } + + if (offset_valid) { + update_cache(tai_cache_location); + break; + } + } + } + } + + if (offset_valid) { + // With the current evolution of the offset, we're probably going + // to reach 500 long after DAB gets replaced by another standard. + if (offset < 0 or offset > 500) { + stringstream ss; + ss << "TAI offset " << offset << " out of range"; + throw range_error(ss.str()); + } + + return offset; + } + else { + // Try again later + throw download_failed(); + } +} + + +int ClockTAI::get_offset() +{ + using namespace std::chrono; + const auto time_now = system_clock::now(); + + std::unique_lock<std::mutex> lock(m_data_mutex); + + if (not m_offset_valid) { +#ifdef DOWNLOADED_IN_THE_PAST_TEST + // Assume we've downloaded it in the past: + + m_offset = 37; // Valid in early 2017 + m_offset_valid = true; + + // Simulate requiring a new download + m_bulletin_download_time = time_now - hours(24 * 40); +#else + // First time we run we must block until we know + // the offset + lock.unlock(); + try { + m_offset = get_valid_offset(); + } + catch (const download_failed&) { + throw runtime_error("Unable to download TAI bulletin"); + } + lock.lock(); + m_offset_valid = true; + m_bulletin_download_time = time_now; +#endif + etiLog.level(info) << + "Initialised TAI-UTC offset to " << m_offset << "s."; + } + + if (time_now - m_bulletin_download_time > hours(24 * 31)) { + // Refresh if it's older than one month. Leap seconds are + // announced several months in advance + etiLog.level(debug) << "Trying to refresh TAI bulletin"; + + if (m_offset_future.valid()) { + auto state = m_offset_future.wait_for(seconds(0)); + switch (state) { + case future_status::ready: + try { + m_offset = m_offset_future.get(); + m_offset_valid = true; + m_bulletin_download_time = time_now; + + etiLog.level(info) << + "Updated TAI-UTC offset to " << m_offset << "s."; + } + catch (const download_failed&) { + etiLog.level(warn) << + "TAI-UTC download failed, will retry in " << + download_retry_interval_hours << " hour(s)"; + + m_bulletin_download_time += hours(download_retry_interval_hours); + } +#ifdef DOWNLOADED_IN_THE_PAST_TEST + wait_longer = false; +#endif + break; + + case future_status::deferred: + case future_status::timeout: + // Not ready yet +#ifdef TAI_TEST + etiLog.level(debug) << " async not ready yet"; +#endif + break; + } + } + else { +#ifdef TAI_TEST + etiLog.level(debug) << " Launch async"; +#endif + m_offset_future = async(launch::async, &ClockTAI::get_valid_offset, this); + } + } + + return m_offset; +} + +#if SUPPORT_SETTING_CLOCK_TAI +int ClockTAI::update_local_tai_clock(int offset) +{ + struct timex timex_request; + timex_request.modes = ADJ_TAI; + timex_request.constant = offset; + + int err = adjtimex(&timex_request); + if (err == -1) { + perror("adjtimex"); + } + + printf("adjtimex: %d, tai %d\n", err, timex_request.tai); + + return err; +} +#endif + +void ClockTAI::update_cache(const char* cache_filename) +{ + int fd = open(cache_filename, O_RDWR | O_CREAT, 00664); + if (fd == -1) { + etiLog.level(error) << + "TAI-UTC bulletin open cache for writing: " << + strerror(errno); + return; + } + + lseek(fd, 0, SEEK_SET); + + ssize_t ret = lockf(fd, F_LOCK, 0); + if (ret == 0) { + // exclusive lock acquired + const char *data = m_bulletin.data(); + size_t remaining = m_bulletin.size(); + + while (remaining > 0) { + ret = write(fd, data, remaining); + if (ret == -1) { + close(fd); + etiLog.level(error) << + "TAI-UTC bulletin write cache: " << + strerror(errno); + return; + } + + remaining -= ret; + data += ret; + } + etiLog.level(debug) << "TAI-UTC bulletin cache updated"; + close(fd); + } + else { + close(fd); + etiLog.level(error) << + "TAI-UTC bulletin acquire cache lock for writing: " << + strerror(errno); + return; + } +} + + +void ClockTAI::set_parameter(const string& parameter, const string& value) +{ + if (parameter == "expiry") { + throw ParameterError("Parameter '" + parameter + + "' is read-only in controllable " + get_rc_name()); + } + else { + throw ParameterError("Parameter '" + parameter + + "' is not exported by controllable " + get_rc_name()); + } +} + +const string ClockTAI::get_parameter(const string& parameter) const +{ + if (parameter == "expiry") { + std::unique_lock<std::mutex> lock(m_data_mutex); + const int64_t expiry = parse_bulletin(m_bulletin).expiry; + if (expiry > 0) { + return to_string(expiry); + } + else { + return "Bulletin expired or invalid!"; + } + } + else { + throw ParameterError("Parameter '" + parameter + + "' is not exported by controllable " + get_rc_name()); + } +} + +#if 0 +// Example testing code +void debug_tai_clk() +{ + struct timespec rt_clk; + + int err = clock_gettime(CLOCK_REALTIME, &rt_clk); + if (err) { + perror("REALTIME clock_gettime failed"); + } + + struct timespec tai_clk; + + err = clock_gettime(CLOCK_TAI, &tai_clk); + if (err) { + perror("TAI clock_gettime failed"); + } + + printf("RT - TAI = %ld\n", rt_clk.tv_sec - tai_clk.tv_sec); + + + struct timex timex_request; + timex_request.modes = 0; // Do not set anything + + err = adjtimex(&timex_request); + if (err == -1) { + perror("adjtimex"); + } + + printf("adjtimex: %d, tai %d\n", err, timex_request.tai); +} +#endif + diff --git a/contrib/ClockTAI.h b/contrib/ClockTAI.h new file mode 100644 index 0000000..50a6323 --- /dev/null +++ b/contrib/ClockTAI.h @@ -0,0 +1,102 @@ +/* + Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, + 2011, 2012 Her Majesty the Queen in Right of Canada (Communications + Research Center Canada) + + Copyright (C) 2019 + Matthias P. Braendli, matthias.braendli@mpb.li + + http://www.opendigitalradio.org + */ +/* + This file is part of the ODR-mmbTools. + + 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/>. + */ + +/* The EDI output needs TAI clock, according to ETSI TS 102 693 Annex F + * "EDI Timestamps". This module can set the local CLOCK_TAI clock by + * setting the TAI-UTC offset using adjtimex. + * + * This functionality requires Linux 3.10 (30 Jun 2013) or newer. + */ + +#pragma once + +#include <cstdint> +#include <cstdlib> +#include <sstream> +#include <chrono> +#include <future> +#include <mutex> +#include <string> +#include <vector> +#include "RemoteControl.h" + +// EDI needs to know UTC-TAI, but doesn't need the CLOCK_TAI to be set. +// We can keep this code, maybe for future use +#define SUPPORT_SETTING_CLOCK_TAI 0 + +/* Loads, parses and represents TAI-UTC offset information from the IETF bulletin */ +class ClockTAI : public RemoteControllable { + public: + ClockTAI(const std::vector<std::string>& bulletin_urls); + + // Fetch the bulletin from the IETF website and return the current + // TAI-UTC offset. + // Throws runtime_error on failure. + int get_offset(void); + +#if SUPPORT_SETTING_CLOCK_TAI + // Update the local TAI clock according to the TAI-UTC offset + // return 0 on success + int update_local_tai_clock(int offset); +#endif + + private: + class download_failed {}; + + // Either retrieve the bulletin from the cache or if necessarly + // download it, and calculate the TAI-UTC offset. + // Returns the offset or throws download_failed or a range_error + // if the offset is out of bounds. + int get_valid_offset(void); + + // Download of new bulletin is done asynchronously + std::future<int> m_offset_future; + + // Protect all data members, as RC functions are in another thread + mutable std::mutex m_data_mutex; + + // The currently used TAI-UTC offset + int m_offset = 0; + int m_offset_valid = false; + + std::vector<std::string> m_bulletin_urls; + + std::string m_bulletin; + std::chrono::system_clock::time_point m_bulletin_download_time; + + // Update the cache file with the current m_bulletin + void update_cache(const char* cache_filename); + + + /* Remote control */ + virtual void set_parameter(const std::string& parameter, + const std::string& value); + + /* Getting a parameter always returns a string. */ + virtual const std::string get_parameter(const std::string& parameter) const; +}; + diff --git a/contrib/Log.cpp b/contrib/Log.cpp new file mode 100644 index 0000000..2417f3a --- /dev/null +++ b/contrib/Log.cpp @@ -0,0 +1,194 @@ +/* + Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 + Her Majesty the Queen in Right of Canada (Communications Research + Center Canada) + + Copyright (C) 2018 + Matthias P. Braendli, matthias.braendli@mpb.li + + http://www.opendigitalradio.org + */ +/* + This file is part of the ODR-mmbTools. + + 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 <list> +#include <cstdarg> +#include <cinttypes> +#include <chrono> + +#include "Log.h" + +using namespace std; + +/* etiLog is a singleton used in all parts of the program to output log messages. + */ +Logger etiLog; + +void Logger::register_backend(std::shared_ptr<LogBackend> backend) +{ + backends.push_back(backend); +} + + +void Logger::log(log_level_t level, const char* fmt, ...) +{ + if (level == discard) { + return; + } + + int size = 100; + std::string str; + va_list ap; + while (1) { + str.resize(size); + va_start(ap, fmt); + int n = vsnprintf((char *)str.c_str(), size, fmt, ap); + va_end(ap); + if (n > -1 && n < size) { + str.resize(n); + break; + } + if (n > -1) + size = n + 1; + else + size *= 2; + } + + logstr(level, move(str)); +} + +void Logger::logstr(log_level_t level, std::string&& message) +{ + if (level == discard) { + return; + } + + log_message_t m(level, move(message)); + m_message_queue.push(move(m)); +} + +void Logger::io_process() +{ + while (1) { + log_message_t m; + try { + m_message_queue.wait_and_pop(m); + } + catch (const ThreadsafeQueueWakeup&) { + break; + } + + auto message = m.message; + + /* Remove a potential trailing newline. + * It doesn't look good in syslog + */ + if (message[message.length()-1] == '\n') { + message.resize(message.length()-1); + } + + for (auto &backend : backends) { + backend->log(m.level, message); + } + + if (m.level != log_level_t::trace) { + std::lock_guard<std::mutex> guard(m_cerr_mutex); + std::cerr << levels_as_str[m.level] << " " << message << std::endl; + } + } +} + + +LogLine Logger::level(log_level_t level) +{ + return LogLine(this, level); +} + +LogToFile::LogToFile(const std::string& filename) : name("FILE") +{ + FILE* fd = fopen(filename.c_str(), "a"); + if (fd == nullptr) { + fprintf(stderr, "Cannot open log file !"); + throw std::runtime_error("Cannot open log file !"); + } + + log_file.reset(fd); +} + +void LogToFile::log(log_level_t level, const std::string& message) +{ + if (not (level == log_level_t::trace or level == log_level_t::discard)) { + const char* log_level_text[] = { + "DEBUG", "INFO", "WARN", "ERROR", "ALERT", "EMERG"}; + + // fprintf is thread-safe + fprintf(log_file.get(), SYSLOG_IDENT ": %s: %s\n", + log_level_text[(size_t)level], message.c_str()); + fflush(log_file.get()); + } +} + +void LogToSyslog::log(log_level_t level, const std::string& message) +{ + if (not (level == log_level_t::trace or level == log_level_t::discard)) { + int syslog_level = LOG_EMERG; + switch (level) { + case debug: syslog_level = LOG_DEBUG; break; + case info: syslog_level = LOG_INFO; break; + /* we don't have the notice level */ + case warn: syslog_level = LOG_WARNING; break; + case error: syslog_level = LOG_ERR; break; + default: syslog_level = LOG_CRIT; break; + case alert: syslog_level = LOG_ALERT; break; + case emerg: syslog_level = LOG_EMERG; break; + } + + syslog(syslog_level, SYSLOG_IDENT " %s", message.c_str()); + } +} + +LogTracer::LogTracer(const string& trace_filename) : name("TRACE") +{ + etiLog.level(info) << "Setting up TRACE to " << trace_filename; + + FILE* fd = fopen(trace_filename.c_str(), "a"); + if (fd == nullptr) { + fprintf(stderr, "Cannot open trace file !"); + throw std::runtime_error("Cannot open trace file !"); + } + m_trace_file.reset(fd); + + using namespace std::chrono; + auto now = steady_clock::now().time_since_epoch(); + m_trace_micros_startup = duration_cast<microseconds>(now).count(); + + fprintf(m_trace_file.get(), + "0,TRACER,startup at %" PRIu64 "\n", m_trace_micros_startup); +} + +void LogTracer::log(log_level_t level, const std::string& message) +{ + if (level == log_level_t::trace) { + using namespace std::chrono; + const auto now = steady_clock::now().time_since_epoch(); + const auto micros = duration_cast<microseconds>(now).count(); + + fprintf(m_trace_file.get(), "%" PRIu64 ",%s\n", + micros - m_trace_micros_startup, + message.c_str()); + } +} diff --git a/contrib/Log.h b/contrib/Log.h new file mode 100644 index 0000000..d5c39e0 --- /dev/null +++ b/contrib/Log.h @@ -0,0 +1,204 @@ +/* + Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 + Her Majesty the Queen in Right of Canada (Communications Research + Center Canada) + + Copyright (C) 2018 + Matthias P. Braendli, matthias.braendli@mpb.li + + http://www.opendigitalradio.org + */ +/* + This file is part of the ODR-mmbTools. + + 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/>. + */ + +#pragma once + +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif + +#include <syslog.h> +#include <cstdarg> +#include <cstdio> +#include <fstream> +#include <sstream> +#include <iostream> +#include <list> +#include <stdexcept> +#include <string> +#include <map> +#include <mutex> +#include <memory> +#include <thread> +#include "ThreadsafeQueue.h" + +#define SYSLOG_IDENT PACKAGE_NAME +#define SYSLOG_FACILITY LOG_LOCAL0 + +enum log_level_t {debug = 0, info, warn, error, alert, emerg, trace, discard}; + +static const std::string levels_as_str[] = + { " ", " ", "WARN ", "ERROR", "ALERT", "EMERG", "TRACE", "-----"} ; + +/** Abstract class all backends must inherit from */ +class LogBackend { + public: + virtual ~LogBackend() {}; + virtual void log(log_level_t level, const std::string& message) = 0; + virtual std::string get_name() const = 0; +}; + +/** A Logging backend for Syslog */ +class LogToSyslog : public LogBackend { + public: + LogToSyslog() : name("SYSLOG") { + openlog(SYSLOG_IDENT, LOG_PID, SYSLOG_FACILITY); + } + + virtual ~LogToSyslog() { + closelog(); + } + + void log(log_level_t level, const std::string& message); + + std::string get_name() const { return name; } + + private: + const std::string name; + + LogToSyslog(const LogToSyslog& other) = delete; + const LogToSyslog& operator=(const LogToSyslog& other) = delete; +}; + +class LogToFile : public LogBackend { + public: + LogToFile(const std::string& filename); + void log(log_level_t level, const std::string& message); + std::string get_name() const { return name; } + + private: + const std::string name; + + struct FILEDeleter{ void operator()(FILE* fd){ if(fd) fclose(fd);}}; + std::unique_ptr<FILE, FILEDeleter> log_file; + + LogToFile(const LogToFile& other) = delete; + const LogToFile& operator=(const LogToFile& other) = delete; +}; + +class LogTracer : public LogBackend { + public: + LogTracer(const std::string& filename); + void log(log_level_t level, const std::string& message); + std::string get_name() const { return name; } + private: + std::string name; + uint64_t m_trace_micros_startup = 0; + + struct FILEDeleter{ void operator()(FILE* fd){ if(fd) fclose(fd);}}; + std::unique_ptr<FILE, FILEDeleter> m_trace_file; + + LogTracer(const LogTracer& other) = delete; + const LogTracer& operator=(const LogTracer& other) = delete; +}; + +class LogLine; + +struct log_message_t { + log_message_t(log_level_t _level, std::string&& _message) : + level(_level), + message(move(_message)) {} + + log_message_t() : + level(debug), + message("") {} + + log_level_t level; + std::string message; +}; + +class Logger { + public: + Logger() { + m_io_thread = std::thread(&Logger::io_process, this); + } + + Logger(const Logger& other) = delete; + const Logger& operator=(const Logger& other) = delete; + ~Logger() { + m_message_queue.trigger_wakeup(); + m_io_thread.join(); + } + + void register_backend(std::shared_ptr<LogBackend> backend); + + /* Log the message to all backends */ + void log(log_level_t level, const char* fmt, ...); + + void logstr(log_level_t level, std::string&& message); + + /* All logging IO is done in another thread */ + void io_process(void); + + /* Return a LogLine for the given level + * so that you can write etiLog.level(info) << "stuff = " << 21 */ + LogLine level(log_level_t level); + + private: + std::list<std::shared_ptr<LogBackend> > backends; + + ThreadsafeQueue<log_message_t> m_message_queue; + std::thread m_io_thread; + std::mutex m_cerr_mutex; +}; + +extern Logger etiLog; + +// Accumulate a line of logs, using same syntax as stringstream +// The line is logged when the LogLine gets destroyed +class LogLine { + public: + LogLine(const LogLine& logline); + const LogLine& operator=(const LogLine& other) = delete; + LogLine(Logger* logger, log_level_t level) : + logger_(logger) + { + level_ = level; + } + + // Push the new element into the stringstream + template <typename T> + LogLine& operator<<(T s) { + if (level_ != discard) { + os << s; + } + return *this; + } + + ~LogLine() + { + if (level_ != discard) { + logger_->logstr(level_, os.str()); + } + } + + private: + std::ostringstream os; + log_level_t level_; + Logger* logger_; +}; + diff --git a/contrib/edi/ReedSolomon.cpp b/contrib/ReedSolomon.cpp index 38d8ea8..1bf0b24 100644 --- a/contrib/edi/ReedSolomon.cpp +++ b/contrib/ReedSolomon.cpp @@ -64,7 +64,9 @@ ReedSolomon::ReedSolomon(int N, int K, bool reverse, int gfpoly, int firstRoot, ReedSolomon::~ReedSolomon() { - free_rs_char(rsData); + if (rsData != nullptr) { + free_rs_char(rsData); + } } diff --git a/contrib/edi/ReedSolomon.h b/contrib/ReedSolomon.h index abcef62..abcef62 100644 --- a/contrib/edi/ReedSolomon.h +++ b/contrib/ReedSolomon.h diff --git a/contrib/RemoteControl.cpp b/contrib/RemoteControl.cpp new file mode 100644 index 0000000..878af59 --- /dev/null +++ b/contrib/RemoteControl.cpp @@ -0,0 +1,581 @@ +/* + Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012 + Her Majesty the Queen in Right of Canada (Communications Research + Center Canada) + + Copyright (C) 2019 + Matthias P. Braendli, matthias.braendli@mpb.li + + http://www.opendigitalradio.org + */ +/* + 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 <https://www.gnu.org/licenses/>. + */ +#include <list> +#include <string> +#include <iostream> +#include <string> +#include <algorithm> + +#include "RemoteControl.h" + +using namespace std; + +RemoteControllers rcs; + +RemoteControllerTelnet::~RemoteControllerTelnet() +{ + m_active = false; + + if (m_restarter_thread.joinable()) { + m_restarter_thread.join(); + } + + if (m_child_thread.joinable()) { + m_child_thread.join(); + } +} + +void RemoteControllerTelnet::restart() +{ + if (m_restarter_thread.joinable()) { + m_restarter_thread.join(); + } + + m_restarter_thread = std::thread( + &RemoteControllerTelnet::restart_thread, + this, 0); +} + +RemoteControllable::~RemoteControllable() { + rcs.remove_controllable(this); +} + +std::list<std::string> RemoteControllable::get_supported_parameters() const { + std::list<std::string> parameterlist; + for (const auto& param : m_parameters) { + parameterlist.push_back(param[0]); + } + return parameterlist; +} + +void RemoteControllers::add_controller(std::shared_ptr<BaseRemoteController> rc) { + m_controllers.push_back(rc); +} + +void RemoteControllers::enrol(RemoteControllable *rc) { + controllables.push_back(rc); +} + +void RemoteControllers::remove_controllable(RemoteControllable *rc) { + controllables.remove(rc); +} + +std::list< std::vector<std::string> > RemoteControllers::get_param_list_values(const std::string& name) { + RemoteControllable* controllable = get_controllable_(name); + + std::list< std::vector<std::string> > allparams; + for (auto ¶m : controllable->get_supported_parameters()) { + std::vector<std::string> item; + item.push_back(param); + try { + item.push_back(controllable->get_parameter(param)); + } + catch (const ParameterError &e) { + item.push_back(std::string("error: ") + e.what()); + } + + allparams.push_back(item); + } + return allparams; +} + +std::string RemoteControllers::get_param(const std::string& name, const std::string& param) { + RemoteControllable* controllable = get_controllable_(name); + return controllable->get_parameter(param); +} + +void RemoteControllers::check_faults() { + for (auto &controller : m_controllers) { + if (controller->fault_detected()) { + etiLog.level(warn) << + "Detected Remote Control fault, restarting it"; + controller->restart(); + } + } +} + +RemoteControllable* RemoteControllers::get_controllable_(const std::string& name) +{ + auto rc = std::find_if(controllables.begin(), controllables.end(), + [&](RemoteControllable* r) { return r->get_rc_name() == name; }); + + if (rc == controllables.end()) { + throw ParameterError("Module name unknown"); + } + else { + return *rc; + } +} + +void RemoteControllers::set_param( + const std::string& name, + const std::string& param, + const std::string& value) +{ + etiLog.level(info) << "RC: Setting " << name << " " << param + << " to " << value; + RemoteControllable* controllable = get_controllable_(name); + try { + return controllable->set_parameter(param, value); + } + catch (const ios_base::failure& e) { + etiLog.level(info) << "RC: Failed to set " << name << " " << param + << " to " << value << ": " << e.what(); + throw ParameterError("Cannot understand value"); + } +} + +// This runs in a separate thread, because +// it would take too long to be done in the main loop +// thread. +void RemoteControllerTelnet::restart_thread(long) +{ + m_active = false; + + if (m_child_thread.joinable()) { + m_child_thread.join(); + } + + m_child_thread = std::thread(&RemoteControllerTelnet::process, this, 0); +} + +void RemoteControllerTelnet::handle_accept(Socket::TCPSocket&& socket) +{ + const std::string welcome = PACKAGE_NAME " Remote Control CLI\n" + "Write 'help' for help.\n" + "**********\n"; + const std::string prompt = "> "; + + std::string in_message; + + try { + etiLog.level(info) << "RC: Accepted"; + + socket.sendall(welcome.data(), welcome.size()); + + while (m_active and in_message != "quit") { + socket.sendall(prompt.data(), prompt.size()); + + stringstream in_message_stream; + + char last_char = '\0'; + try { + while (last_char != '\n') { + try { + auto ret = socket.recv(&last_char, 1, 0, 1000); + if (ret == 1) { + in_message_stream << last_char; + } + else { + break; + } + } + catch (const Socket::TCPSocket::Timeout&) { + if (not m_active) { + break; + } + } + } + } + catch (const Socket::TCPSocket::Interrupted&) { + in_message_stream.clear(); + } + + + if (in_message_stream.str().size() == 0) { + etiLog.level(info) << "RC: Connection terminated"; + break; + } + + std::getline(in_message_stream, in_message); + + while (in_message.length() > 0 && + (in_message[in_message.length()-1] == '\r' || + in_message[in_message.length()-1] == '\n')) { + in_message.erase(in_message.length()-1, 1); + } + + if (in_message.length() == 0) { + continue; + } + + etiLog.level(info) << "RC: Got message '" << in_message << "'"; + + dispatch_command(socket, in_message); + } + etiLog.level(info) << "RC: Closing socket"; + socket.close(); + } + catch (const std::exception& e) { + etiLog.level(error) << "Remote control caught exception: " << e.what(); + } +} + +void RemoteControllerTelnet::process(long) +{ + try { + m_active = true; + + m_socket.listen(m_port, "localhost"); + + etiLog.level(info) << "RC: Waiting for connection on port " << m_port; + while (m_active) { + auto sock = m_socket.accept(1000); + + if (sock.valid()) { + handle_accept(move(sock)); + etiLog.level(info) << "RC: Connection closed. Waiting for connection on port " << m_port; + } + } + } + catch (const runtime_error& e) { + etiLog.level(warn) << "RC: Encountered error: " << e.what(); + } + + etiLog.level(info) << "RC: Leaving"; + m_fault = true; +} + +static std::vector<std::string> tokenise(const std::string& message) { + stringstream ss(message); + std::vector<std::string> all_tokens; + std::string item; + + while (std::getline(ss, item, ' ')) { + all_tokens.push_back(move(item)); + } + return all_tokens; +} + + +void RemoteControllerTelnet::dispatch_command(Socket::TCPSocket& socket, string command) +{ + vector<string> cmd = tokenise(command); + + if (cmd[0] == "help") { + reply(socket, + "The following commands are supported:\n" + " list\n" + " * Lists the modules that are loaded and their parameters\n" + " show MODULE\n" + " * Lists all parameters and their values from module MODULE\n" + " get MODULE PARAMETER\n" + " * Gets the value for the specified PARAMETER from module MODULE\n" + " set MODULE PARAMETER VALUE\n" + " * Sets the value for the PARAMETER ofr module MODULE\n" + " quit\n" + " * Terminate this session\n" + "\n"); + } + else if (cmd[0] == "list") { + stringstream ss; + + if (cmd.size() == 1) { + for (auto &controllable : rcs.controllables) { + ss << controllable->get_rc_name() << endl; + + list< vector<string> > params = controllable->get_parameter_descriptions(); + for (auto ¶m : params) { + ss << "\t" << param[0] << " : " << param[1] << endl; + } + } + } + else { + reply(socket, "Too many arguments for command 'list'"); + } + + reply(socket, ss.str()); + } + else if (cmd[0] == "show") { + if (cmd.size() == 2) { + try { + stringstream ss; + list< vector<string> > r = rcs.get_param_list_values(cmd[1]); + for (auto ¶m_val : r) { + ss << param_val[0] << ": " << param_val[1] << endl; + } + reply(socket, ss.str()); + + } + catch (const ParameterError &e) { + reply(socket, e.what()); + } + } + else { + reply(socket, "Incorrect parameters for command 'show'"); + } + } + else if (cmd[0] == "get") { + if (cmd.size() == 3) { + try { + string r = rcs.get_param(cmd[1], cmd[2]); + reply(socket, r); + } + catch (const ParameterError &e) { + reply(socket, e.what()); + } + } + else { + reply(socket, "Incorrect parameters for command 'get'"); + } + } + else if (cmd[0] == "set") { + if (cmd.size() >= 4) { + try { + stringstream new_param_value; + for (size_t i = 3; i < cmd.size(); i++) { + new_param_value << cmd[i]; + + if (i+1 < cmd.size()) { + new_param_value << " "; + } + } + + rcs.set_param(cmd[1], cmd[2], new_param_value.str()); + reply(socket, "ok"); + } + catch (const ParameterError &e) { + reply(socket, e.what()); + } + catch (const exception &e) { + reply(socket, "Error: Invalid parameter value. "); + } + } + else { + reply(socket, "Incorrect parameters for command 'set'"); + } + } + else if (cmd[0] == "quit") { + reply(socket, "Goodbye"); + } + else { + reply(socket, "Message not understood"); + } +} + +void RemoteControllerTelnet::reply(Socket::TCPSocket& socket, string message) +{ + stringstream ss; + ss << message << "\r\n"; + socket.sendall(message.data(), message.size()); +} + + +#if defined(HAVE_ZEROMQ) + +RemoteControllerZmq::~RemoteControllerZmq() { + m_active = false; + m_fault = false; + + if (m_restarter_thread.joinable()) { + m_restarter_thread.join(); + } + + if (m_child_thread.joinable()) { + m_child_thread.join(); + } +} + +void RemoteControllerZmq::restart() +{ + if (m_restarter_thread.joinable()) { + m_restarter_thread.join(); + } + + m_restarter_thread = std::thread(&RemoteControllerZmq::restart_thread, this); +} + +// This runs in a separate thread, because +// it would take too long to be done in the main loop +// thread. +void RemoteControllerZmq::restart_thread() +{ + m_active = false; + + if (m_child_thread.joinable()) { + m_child_thread.join(); + } + + m_child_thread = std::thread(&RemoteControllerZmq::process, this); +} + +void RemoteControllerZmq::recv_all(zmq::socket_t& pSocket, std::vector<std::string> &message) +{ + bool more = true; + do { + zmq::message_t msg; + pSocket.recv(&msg); + std::string incoming((char*)msg.data(), msg.size()); + message.push_back(incoming); + more = msg.more(); + } while (more); +} + +void RemoteControllerZmq::send_ok_reply(zmq::socket_t &pSocket) +{ + zmq::message_t msg(2); + char repCode[2] = {'o', 'k'}; + memcpy ((void*) msg.data(), repCode, 2); + pSocket.send(msg, 0); +} + +void RemoteControllerZmq::send_fail_reply(zmq::socket_t &pSocket, const std::string &error) +{ + zmq::message_t msg1(4); + char repCode[4] = {'f', 'a', 'i', 'l'}; + memcpy ((void*) msg1.data(), repCode, 4); + pSocket.send(msg1, ZMQ_SNDMORE); + + zmq::message_t msg2(error.length()); + memcpy ((void*) msg2.data(), error.c_str(), error.length()); + pSocket.send(msg2, 0); +} + +void RemoteControllerZmq::process() +{ + m_fault = false; + + // create zmq reply socket for receiving ctrl parameters + try { + zmq::socket_t repSocket(m_zmqContext, ZMQ_REP); + + // connect the socket + int hwm = 100; + int linger = 0; + repSocket.setsockopt(ZMQ_RCVHWM, &hwm, sizeof(hwm)); + repSocket.setsockopt(ZMQ_SNDHWM, &hwm, sizeof(hwm)); + repSocket.setsockopt(ZMQ_LINGER, &linger, sizeof(linger)); + repSocket.bind(m_endpoint.c_str()); + + // create pollitem that polls the ZMQ sockets + zmq::pollitem_t pollItems[] = { {repSocket, 0, ZMQ_POLLIN, 0} }; + while (m_active) { + zmq::poll(pollItems, 1, 100); + std::vector<std::string> msg; + + if (pollItems[0].revents & ZMQ_POLLIN) { + recv_all(repSocket, msg); + + std::string command((char*)msg[0].data(), msg[0].size()); + + if (msg.size() == 1 && command == "ping") { + send_ok_reply(repSocket); + } + else if (msg.size() == 1 && command == "list") { + size_t cohort_size = rcs.controllables.size(); + for (auto &controllable : rcs.controllables) { + std::stringstream ss; + ss << "{ \"name\": \"" << controllable->get_rc_name() << "\"," << + " \"params\": { "; + + list< vector<string> > params = controllable->get_parameter_descriptions(); + size_t i = 0; + for (auto ¶m : params) { + if (i > 0) { + ss << ", "; + } + + ss << "\"" << param[0] << "\": " << + "\"" << param[1] << "\""; + + i++; + } + + ss << " } }"; + + std::string msg_s = ss.str(); + + zmq::message_t zmsg(ss.str().size()); + memcpy ((void*) zmsg.data(), msg_s.data(), msg_s.size()); + + int flag = (--cohort_size > 0) ? ZMQ_SNDMORE : 0; + repSocket.send(zmsg, flag); + } + } + else if (msg.size() == 2 && command == "show") { + std::string module((char*) msg[1].data(), msg[1].size()); + try { + list< vector<string> > r = rcs.get_param_list_values(module); + size_t r_size = r.size(); + for (auto ¶m_val : r) { + std::stringstream ss; + ss << param_val[0] << ": " << param_val[1] << endl; + zmq::message_t zmsg(ss.str().size()); + memcpy(zmsg.data(), ss.str().data(), ss.str().size()); + + int flag = (--r_size > 0) ? ZMQ_SNDMORE : 0; + repSocket.send(zmsg, flag); + } + } + catch (const ParameterError &err) { + send_fail_reply(repSocket, err.what()); + } + } + else if (msg.size() == 3 && command == "get") { + std::string module((char*) msg[1].data(), msg[1].size()); + std::string parameter((char*) msg[2].data(), msg[2].size()); + + try { + std::string value = rcs.get_param(module, parameter); + zmq::message_t zmsg(value.size()); + memcpy ((void*) zmsg.data(), value.data(), value.size()); + repSocket.send(zmsg, 0); + } + catch (const ParameterError &err) { + send_fail_reply(repSocket, err.what()); + } + } + else if (msg.size() == 4 && command == "set") { + std::string module((char*) msg[1].data(), msg[1].size()); + std::string parameter((char*) msg[2].data(), msg[2].size()); + std::string value((char*) msg[3].data(), msg[3].size()); + + try { + rcs.set_param(module, parameter, value); + send_ok_reply(repSocket); + } + catch (const ParameterError &err) { + send_fail_reply(repSocket, err.what()); + } + } + else { + send_fail_reply(repSocket, + "Unsupported command. commands: list, show, get, set"); + } + } + } + repSocket.close(); + } + catch (const zmq::error_t &e) { + etiLog.level(error) << "ZMQ RC error: " << std::string(e.what()); + } + catch (const std::exception& e) { + etiLog.level(error) << "ZMQ RC caught exception: " << e.what(); + m_fault = true; + } +} + +#endif + diff --git a/contrib/RemoteControl.h b/contrib/RemoteControl.h new file mode 100644 index 0000000..bd88f82 --- /dev/null +++ b/contrib/RemoteControl.h @@ -0,0 +1,249 @@ +/* + Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012 + Her Majesty the Queen in Right of Canada (Communications Research + Center Canada) + + Copyright (C) 2019 + Matthias P. Braendli, matthias.braendli@mpb.li + + http://www.opendigitalradio.org + + This module adds remote-control capability to some of the dabmux/dabmod modules. + */ +/* + 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 <https://www.gnu.org/licenses/>. + */ + +#pragma once + +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif + +#if defined(HAVE_ZEROMQ) +# include "zmq.hpp" +#endif + +#include <list> +#include <map> +#include <memory> +#include <string> +#include <atomic> +#include <iostream> +#include <thread> +#include <stdexcept> + +#include "Log.h" +#include "Socket.h" + +#define RC_ADD_PARAMETER(p, desc) { \ + std::vector<std::string> p; \ + p.push_back(#p); \ + p.push_back(desc); \ + m_parameters.push_back(p); \ +} + +class ParameterError : public std::exception +{ + public: + ParameterError(std::string message) : m_message(message) {} + ~ParameterError() throw() {} + const char* what() const throw() { return m_message.c_str(); } + + private: + std::string m_message; +}; + +class RemoteControllable; + +/* Remote controllers (that recieve orders from the user) + * must implement BaseRemoteController + */ +class BaseRemoteController { + public: + /* When this returns one, the remote controller cannot be + * used anymore, and must be restarted + */ + virtual bool fault_detected() = 0; + + /* In case of a fault, the remote controller can be + * restarted. + */ + virtual void restart() = 0; + + virtual ~BaseRemoteController() {} +}; + +/* Objects that support remote control must implement the following class */ +class RemoteControllable { + public: + RemoteControllable(const std::string& name) : + m_rc_name(name) {} + + RemoteControllable(const RemoteControllable& other) = delete; + RemoteControllable& operator=(const RemoteControllable& other) = delete; + + virtual ~RemoteControllable(); + + /* return a short name used to identify the controllable. + * It might be used in the commands the user has to type, so keep + * it short + */ + virtual std::string get_rc_name() const { return m_rc_name; } + + /* Return a list of possible parameters that can be set */ + virtual std::list<std::string> get_supported_parameters() const; + + /* Return a mapping of the descriptions of all parameters */ + virtual std::list< std::vector<std::string> > + get_parameter_descriptions() const + { + return m_parameters; + } + + /* Base function to set parameters. */ + virtual void set_parameter( + const std::string& parameter, + const std::string& value) = 0; + + /* Getting a parameter always returns a string. */ + virtual const std::string get_parameter(const std::string& parameter) const = 0; + + protected: + std::string m_rc_name; + std::list< std::vector<std::string> > m_parameters; +}; + +/* Holds all our remote controllers and controlled object. + */ +class RemoteControllers { + public: + void add_controller(std::shared_ptr<BaseRemoteController> rc); + void enrol(RemoteControllable *rc); + void remove_controllable(RemoteControllable *rc); + void check_faults(); + std::list< std::vector<std::string> > get_param_list_values(const std::string& name); + std::string get_param(const std::string& name, const std::string& param); + + void set_param( + const std::string& name, + const std::string& param, + const std::string& value); + + std::list<RemoteControllable*> controllables; + + private: + RemoteControllable* get_controllable_(const std::string& name); + + std::list<std::shared_ptr<BaseRemoteController> > m_controllers; +}; + +extern RemoteControllers rcs; + +/* Implements a Remote controller based on a simple telnet CLI + * that listens on localhost + */ +class RemoteControllerTelnet : public BaseRemoteController { + public: + RemoteControllerTelnet() + : m_active(false), + m_fault(false), + m_port(0) { } + + RemoteControllerTelnet(int port) + : m_active(port > 0), + m_fault(false), + m_port(port) + { + restart(); + } + + + RemoteControllerTelnet& operator=(const RemoteControllerTelnet& other) = delete; + RemoteControllerTelnet(const RemoteControllerTelnet& other) = delete; + + ~RemoteControllerTelnet(); + + virtual bool fault_detected() { return m_fault; } + + virtual void restart(); + + private: + void restart_thread(long); + + void process(long); + + void dispatch_command(Socket::TCPSocket& socket, std::string command); + void reply(Socket::TCPSocket& socket, std::string message); + void handle_accept(Socket::TCPSocket&& socket); + + std::atomic<bool> m_active; + + /* This is set to true if a fault occurred */ + std::atomic<bool> m_fault; + std::thread m_restarter_thread; + + std::thread m_child_thread; + + Socket::TCPSocket m_socket; + int m_port; +}; + +#if defined(HAVE_ZEROMQ) +/* Implements a Remote controller using ZMQ transportlayer + * that listens on localhost + */ +class RemoteControllerZmq : public BaseRemoteController { + public: + RemoteControllerZmq() + : m_active(false), m_fault(false), + m_zmqContext(1), + m_endpoint("") { } + + RemoteControllerZmq(const std::string& endpoint) + : m_active(not endpoint.empty()), m_fault(false), + m_zmqContext(1), + m_endpoint(endpoint), + m_child_thread(&RemoteControllerZmq::process, this) { } + + RemoteControllerZmq& operator=(const RemoteControllerZmq& other) = delete; + RemoteControllerZmq(const RemoteControllerZmq& other) = delete; + + ~RemoteControllerZmq(); + + virtual bool fault_detected() { return m_fault; } + + virtual void restart(); + + private: + void restart_thread(); + + void recv_all(zmq::socket_t &pSocket, std::vector<std::string> &message); + void send_ok_reply(zmq::socket_t &pSocket); + void send_fail_reply(zmq::socket_t &pSocket, const std::string &error); + void process(); + + std::atomic<bool> m_active; + + /* This is set to true if a fault occurred */ + std::atomic<bool> m_fault; + std::thread m_restarter_thread; + + zmq::context_t m_zmqContext; + + std::string m_endpoint; + std::thread m_child_thread; +}; +#endif + diff --git a/contrib/Socket.cpp b/contrib/Socket.cpp index c87606a..cd70a8e 100644 --- a/contrib/Socket.cpp +++ b/contrib/Socket.cpp @@ -381,7 +381,7 @@ bool TCPSocket::valid() const return m_sock != -1; } -void TCPSocket::connect(const std::string& hostname, int port, bool nonblock) +void TCPSocket::connect(const std::string& hostname, int port) { if (m_sock != INVALID_SOCKET) { throw std::logic_error("You may only connect an invalid TCPSocket"); @@ -415,16 +415,10 @@ void TCPSocket::connect(const std::string& hostname, int port, bool nonblock) if (sfd == -1) continue; - if (nonblock) { - int flags = fcntl(sfd, F_GETFL); - if (fcntl(sfd, F_SETFL, flags | O_NONBLOCK) == -1) { - std::string errstr(strerror(errno)); - throw std::runtime_error("TCP: Could not set O_NONBLOCK: " + errstr); - } - } - int ret = ::connect(sfd, rp->ai_addr, rp->ai_addrlen); if (ret != -1 or (ret == -1 and errno == EINPROGRESS)) { + // As the TCPClient could set the socket to nonblocking, we + // must handle EINPROGRESS here m_sock = sfd; break; } @@ -699,8 +693,13 @@ ssize_t TCPClient::recv(void *buffer, size_t length, int flags, int timeout_ms) void TCPClient::reconnect() { - const bool nonblock = true; - m_sock.connect(m_hostname, m_port, nonblock); + int flags = fcntl(m_sock.m_sock, F_GETFL); + if (fcntl(m_sock.m_sock, F_SETFL, flags | O_NONBLOCK) == -1) { + std::string errstr(strerror(errno)); + throw std::runtime_error("TCP: Could not set O_NONBLOCK: " + errstr); + } + + m_sock.connect(m_hostname, m_port); } TCPConnection::TCPConnection(TCPSocket&& sock) : diff --git a/contrib/Socket.h b/contrib/Socket.h index c3c37e1..8bb7fe1 100644 --- a/contrib/Socket.h +++ b/contrib/Socket.h @@ -162,7 +162,7 @@ class TCPSocket { TCPSocket& operator=(TCPSocket&& other); bool valid(void) const; - void connect(const std::string& hostname, int port, bool nonblock = false); + void connect(const std::string& hostname, int port); void listen(int port, const std::string& name); void close(void); diff --git a/contrib/edi/crc.c b/contrib/crc.c index cc02473..cc02473 100644 --- a/contrib/edi/crc.c +++ b/contrib/crc.c diff --git a/contrib/edi/crc.h b/contrib/crc.h index b1785a1..b1785a1 100644 --- a/contrib/edi/crc.h +++ b/contrib/crc.h diff --git a/contrib/edi/AFPacket.cpp b/contrib/edi/AFPacket.cpp index a58a980..b38c38b 100644 --- a/contrib/edi/AFPacket.cpp +++ b/contrib/edi/AFPacket.cpp @@ -10,21 +10,21 @@ */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ #include "config.h" #include "crc.h" #include "AFPacket.h" @@ -34,7 +34,7 @@ #include <string> #include <iostream> #include <cstdio> -#include <stdint.h> +#include <cstdint> #include <arpa/inet.h> namespace edi { diff --git a/contrib/edi/AFPacket.h b/contrib/edi/AFPacket.h index b4ccef1..f2c4e35 100644 --- a/contrib/edi/AFPacket.h +++ b/contrib/edi/AFPacket.h @@ -10,27 +10,27 @@ */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ #pragma once #include "config.h" #include <vector> -#include <stdint.h> +#include <cstdint> #include "TagItems.h" #include "TagPacket.h" diff --git a/contrib/edi/Config.h b/contrib/edi/Config.h index 0c7dce8..ca76322 100644 --- a/contrib/edi/Config.h +++ b/contrib/edi/Config.h @@ -9,21 +9,21 @@ */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ #pragma once diff --git a/contrib/edi/Interleaver.cpp b/contrib/edi/Interleaver.cpp index 50c5be2..f26a50e 100644 --- a/contrib/edi/Interleaver.cpp +++ b/contrib/edi/Interleaver.cpp @@ -29,7 +29,7 @@ along with ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. */ -#include "edi/Interleaver.h" +#include "Interleaver.h" #include <cassert> namespace edi { diff --git a/contrib/edi/Interleaver.h b/contrib/edi/Interleaver.h index 23aebf8..3029d5d 100644 --- a/contrib/edi/Interleaver.h +++ b/contrib/edi/Interleaver.h @@ -13,21 +13,21 @@ */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ #pragma once @@ -35,8 +35,9 @@ #include <vector> #include <deque> #include <stdexcept> -#include <stdint.h> -#include "edi/PFT.h" +#include <cstdint> +#include "Log.h" +#include "PFT.h" namespace edi { diff --git a/contrib/edi/PFT.cpp b/contrib/edi/PFT.cpp index 0692914..371d36f 100644 --- a/contrib/edi/PFT.cpp +++ b/contrib/edi/PFT.cpp @@ -14,34 +14,34 @@ */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ #include "config.h" #include <vector> #include <list> #include <cstdio> #include <cstring> -#include <stdint.h> +#include <cstdint> #include <arpa/inet.h> #include <stdexcept> #include <sstream> -#include <iostream> -#include "edi/PFT.h" +#include "PFT.h" #include "crc.h" +#include "ReedSolomon.h" namespace edi { @@ -61,13 +61,15 @@ PFT::PFT(const configuration_t &conf) : m_verbose(conf.verbose) { if (m_k > 207) { + etiLog.level(warn) << + "EDI PFT: maximum chunk size is 207."; throw std::out_of_range("EDI PFT Chunk size too large."); } if (m_m > 5) { - clog << + etiLog.level(warn) << "EDI PFT: high number of recoverable fragments" - " may lead to large overhead" << endl; + " may lead to large overhead"; // See TS 102 821, 7.2.1 Known values, list entry for 'm' } } diff --git a/contrib/edi/PFT.h b/contrib/edi/PFT.h index 6d41781..0ff4839 100644 --- a/contrib/edi/PFT.h +++ b/contrib/edi/PFT.h @@ -14,21 +14,21 @@ */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ #pragma once @@ -36,10 +36,11 @@ #include <vector> #include <list> #include <stdexcept> -#include <stdint.h> -#include "edi/AFPacket.h" -#include "edi/ReedSolomon.h" -#include "edi/Config.h" +#include <cstdint> +#include "AFPacket.h" +#include "Log.h" +#include "ReedSolomon.h" +#include "Config.h" namespace edi { diff --git a/contrib/edi/TagItems.cpp b/contrib/edi/TagItems.cpp index 748f246..35a6852 100644 --- a/contrib/edi/TagItems.cpp +++ b/contrib/edi/TagItems.cpp @@ -10,32 +10,40 @@ */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ #include "config.h" -#include "edi/TagItems.h" +#include "TagItems.h" #include <vector> #include <iostream> #include <string> -#include <stdint.h> +#include <cstdint> #include <stdexcept> namespace edi { +TagStarPTR::TagStarPTR(const std::string& protocol) + : m_protocol(protocol) +{ + if (m_protocol.size() != 4) { + throw std::runtime_error("TagStarPTR protocol invalid length"); + } +} + std::vector<uint8_t> TagStarPTR::Assemble() { //std::cerr << "TagItem *ptr" << std::endl; @@ -47,10 +55,7 @@ std::vector<uint8_t> TagStarPTR::Assemble() packet.push_back(0); packet.push_back(0x40); - if (protocol.size() != 4) { - throw std::runtime_error("TagStarPTR protocol invalid length"); - } - packet.insert(packet.end(), protocol.begin(), protocol.end()); + packet.insert(packet.end(), m_protocol.begin(), m_protocol.end()); // Major packet.push_back(0); @@ -62,6 +67,139 @@ std::vector<uint8_t> TagStarPTR::Assemble() return packet; } +std::vector<uint8_t> TagDETI::Assemble() +{ + std::string pack_data("deti"); + std::vector<uint8_t> packet(pack_data.begin(), pack_data.end()); + packet.reserve(256); + + // Placeholder for length + packet.push_back(0); + packet.push_back(0); + packet.push_back(0); + packet.push_back(0); + + uint8_t fct = dlfc % 250; + uint8_t fcth = dlfc / 250; + + + uint16_t detiHeader = fct | (fcth << 8) | (rfudf << 13) | (ficf << 14) | (atstf << 15); + packet.push_back(detiHeader >> 8); + packet.push_back(detiHeader & 0xFF); + + uint32_t etiHeader = mnsc | (rfu << 16) | (rfa << 17) | + (fp << 19) | (mid << 22) | (stat << 24); + packet.push_back((etiHeader >> 24) & 0xFF); + packet.push_back((etiHeader >> 16) & 0xFF); + packet.push_back((etiHeader >> 8) & 0xFF); + packet.push_back(etiHeader & 0xFF); + + if (atstf) { + packet.push_back(utco); + + packet.push_back((seconds >> 24) & 0xFF); + packet.push_back((seconds >> 16) & 0xFF); + packet.push_back((seconds >> 8) & 0xFF); + packet.push_back(seconds & 0xFF); + + packet.push_back((tsta >> 16) & 0xFF); + packet.push_back((tsta >> 8) & 0xFF); + packet.push_back(tsta & 0xFF); + } + + if (ficf) { + for (size_t i = 0; i < fic_length; i++) { + packet.push_back(fic_data[i]); + } + } + + if (rfudf) { + packet.push_back((rfud >> 16) & 0xFF); + packet.push_back((rfud >> 8) & 0xFF); + packet.push_back(rfud & 0xFF); + } + + // calculate and update size + // remove TAG name and TAG length fields and convert to bits + uint32_t taglength = (packet.size() - 8) * 8; + + // write length into packet + packet[4] = (taglength >> 24) & 0xFF; + packet[5] = (taglength >> 16) & 0xFF; + packet[6] = (taglength >> 8) & 0xFF; + packet[7] = taglength & 0xFF; + + dlfc = (dlfc+1) % 5000; + + /* + std::cerr << "TagItem deti, packet.size " << packet.size() << std::endl; + std::cerr << " fic length " << fic_length << std::endl; + std::cerr << " length " << taglength / 8 << std::endl; + */ + return packet; +} + +void TagDETI::set_edi_time(const std::time_t t, int tai_utc_offset) +{ + utco = tai_utc_offset - 32; + + const std::time_t posix_timestamp_1_jan_2000 = 946684800; + + seconds = t - posix_timestamp_1_jan_2000 + utco; +} + +std::vector<uint8_t> TagESTn::Assemble() +{ + std::string pack_data("est"); + std::vector<uint8_t> packet(pack_data.begin(), pack_data.end()); + packet.reserve(mst_length*8 + 16); + + packet.push_back(id); + + // Placeholder for length + packet.push_back(0); + packet.push_back(0); + packet.push_back(0); + packet.push_back(0); + + if (tpl > 0x3F) { + throw std::runtime_error("TagESTn: invalid TPL value"); + } + + if (sad > 0x3FF) { + throw std::runtime_error("TagESTn: invalid SAD value"); + } + + if (scid > 0x3F) { + throw std::runtime_error("TagESTn: invalid SCID value"); + } + + uint32_t sstc = (scid << 18) | (sad << 8) | (tpl << 2) | rfa; + packet.push_back((sstc >> 16) & 0xFF); + packet.push_back((sstc >> 8) & 0xFF); + packet.push_back(sstc & 0xFF); + + for (size_t i = 0; i < mst_length * 8; i++) { + packet.push_back(mst_data[i]); + } + + // calculate and update size + // remove TAG name and TAG length fields and convert to bits + uint32_t taglength = (packet.size() - 8) * 8; + + // write length into packet + packet[4] = (taglength >> 24) & 0xFF; + packet[5] = (taglength >> 16) & 0xFF; + packet[6] = (taglength >> 8) & 0xFF; + packet[7] = taglength & 0xFF; + + /* + std::cerr << "TagItem ESTn, length " << packet.size() << std::endl; + std::cerr << " mst_length " << mst_length << std::endl; + */ + return packet; +} + std::vector<uint8_t> TagDSTI::Assemble() { std::string pack_data("dsti"); @@ -134,6 +272,35 @@ void TagDSTI::set_edi_time(const std::time_t t, int tai_utc_offset) seconds = t - posix_timestamp_1_jan_2000 + utco; } +#if 0 +/* Update the EDI time. t is in UTC, TAI offset is requested from adjtimex */ +void TagDSTI::set_edi_time(const std::time_t t) +{ + if (tai_offset_cache_updated_at == 0 or tai_offset_cache_updated_at + 3600 < t) { + struct timex timex_request; + timex_request.modes = 0; + + int err = adjtimex(&timex_request); + if (err == -1) { + throw std::runtime_error("adjtimex failed"); + } + + if (timex_request.tai == 0) { + throw std::runtime_error("CLOCK_TAI is not properly set up"); + } + tai_offset_cache = timex_request.tai; + tai_offset_cache_updated_at = t; + + fprintf(stderr, "adjtimex: %d, tai %d\n", err, timex_request.tai); + } + + utco = tai_offset_cache - 32; + + const std::time_t posix_timestamp_1_jan_2000 = 946684800; + + seconds = t - posix_timestamp_1_jan_2000 + utco; +} +#endif std::vector<uint8_t> TagSSm::Assemble() { @@ -192,6 +359,7 @@ std::vector<uint8_t> TagSSm::Assemble() return packet; } + std::vector<uint8_t> TagStarDMY::Assemble() { std::string pack_data("*dmy"); diff --git a/contrib/edi/TagItems.h b/contrib/edi/TagItems.h index 73e745a..25daa14 100644 --- a/contrib/edi/TagItems.h +++ b/contrib/edi/TagItems.h @@ -10,21 +10,21 @@ */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ #pragma once @@ -33,7 +33,7 @@ #include <array> #include <chrono> #include <string> -#include <stdint.h> +#include <cstdint> namespace edi { @@ -47,8 +47,94 @@ class TagItem class TagStarPTR : public TagItem { public: - std::string protocol = ""; + TagStarPTR(const std::string& protocol); std::vector<uint8_t> Assemble(); + + private: + std::string m_protocol = ""; +}; + +// ETSI TS 102 693, 5.1.3 DAB ETI(LI) Management (deti) +class TagDETI : public TagItem +{ + public: + std::vector<uint8_t> Assemble(); + + /***** DATA in intermediary format ****/ + // For the ETI Header: must be defined ! + uint8_t stat = 0; + uint8_t mid = 0; + uint8_t fp = 0; + uint8_t rfa = 0; + uint8_t rfu = 0; // MNSC is valid + uint16_t mnsc = 0; + uint16_t dlfc = 0; // modulo 5000 frame counter + + // ATST (optional) + bool atstf = false; // presence of atst data + + /* UTCO: Offset (in seconds) between UTC and the Seconds value. The + * value is expressed as an unsigned 8-bit quantity. As of February + * 2009, the value shall be 2 and shall change as a result of each + * modification of the number of leap seconds, as proscribed by + * International Earth Rotation and Reference Systems Service (IERS). + * + * According to Annex F + * EDI = TAI - 32s (constant) + * EDI = UTC + UTCO + * we derive + * UTCO = TAI-UTC - 32 + * where the TAI-UTC offset is given by the USNO bulletin using + * the ClockTAI module. + */ + uint8_t utco = 0; + + /* Update the EDI time. t is in UTC */ + void set_edi_time(const std::time_t t, int tai_utc_offset); + + /* The number of SI seconds since 2000-01-01 T 00:00:00 UTC as an + * unsigned 32-bit quantity. Contrary to POSIX, this value also + * counts leap seconds. + */ + uint32_t seconds = 0; + + /* TSTA: Shall be the 24 least significant bits of the Time Stamp + * (TIST) field from the STI-D(LI) Frame. The full definition for the + * STI TIST can be found in annex B of EN 300 797 [4]. The most + * significant 8 bits of the TIST field of the incoming STI-D(LI) + * frame, if required, may be carried in the RFAD field. + */ + uint32_t tsta = 0xFFFFFF; + + // the FIC (optional) + bool ficf = false; + const unsigned char* fic_data; + size_t fic_length; + + // rfu + bool rfudf = false; + uint32_t rfud = 0; + + +}; + +// ETSI TS 102 693, 5.1.5 ETI Sub-Channel Stream <n> +class TagESTn : public TagItem +{ + public: + std::vector<uint8_t> Assemble(); + + // SSTCn + uint8_t scid; + uint16_t sad; + uint8_t tpl; + uint8_t rfa; + + // Pointer to MSTn data + uint8_t* mst_data; + size_t mst_length; // STLn * 8 bytes + + uint8_t id; }; // ETSI TS 102 693, 5.1.2 DAB STI-D(LI) Management @@ -101,6 +187,10 @@ class TagDSTI : public TagItem uint32_t tsta = 0xFFFFFF; std::array<uint8_t, 9> rfad; + + private: + int tai_offset_cache = 0; + std::time_t tai_offset_cache_updated_at = 0; }; // ETSI TS 102 693, 5.1.4 STI-D Payload Stream <m> diff --git a/contrib/edi/TagPacket.cpp b/contrib/edi/TagPacket.cpp index 01a1ffe..b0bf9a1 100644 --- a/contrib/edi/TagPacket.cpp +++ b/contrib/edi/TagPacket.cpp @@ -8,27 +8,30 @@ This defines a TAG Packet. */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ #include "config.h" -#include "edi/TagPacket.h" -#include "edi/TagItems.h" +#include "TagPacket.h" +#include "TagItems.h" +#include <vector> #include <iostream> #include <string> +#include <list> +#include <cstdint> #include <cassert> namespace edi { diff --git a/contrib/edi/TagPacket.h b/contrib/edi/TagPacket.h index a932e89..1e40ce7 100644 --- a/contrib/edi/TagPacket.h +++ b/contrib/edi/TagPacket.h @@ -8,26 +8,26 @@ This defines a TAG Packet. */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ #pragma once #include "config.h" -#include "edi/TagItems.h" +#include "TagItems.h" #include <vector> #include <string> #include <list> diff --git a/contrib/edi/Transport.cpp b/contrib/edi/Transport.cpp index c2fb2a7..0d5c237 100644 --- a/contrib/edi/Transport.cpp +++ b/contrib/edi/Transport.cpp @@ -9,25 +9,23 @@ */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ - -#include "edi/Transport.h" + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ +#include "Transport.h" #include <iterator> -#include <iostream> using namespace std; @@ -35,31 +33,31 @@ namespace edi { void configuration_t::print() const { - clog << "EDI" << endl; - clog << " verbose " << verbose << endl; + etiLog.level(info) << "EDI"; + etiLog.level(info) << " verbose " << verbose; for (auto edi_dest : destinations) { if (auto udp_dest = dynamic_pointer_cast<edi::udp_destination_t>(edi_dest)) { - clog << " UDP to " << udp_dest->dest_addr << ":" << dest_port << endl; + etiLog.level(info) << " UDP to " << udp_dest->dest_addr << ":" << dest_port; if (not udp_dest->source_addr.empty()) { - clog << " source " << udp_dest->source_addr << endl; - clog << " ttl " << udp_dest->ttl << endl; + etiLog.level(info) << " source " << udp_dest->source_addr; + etiLog.level(info) << " ttl " << udp_dest->ttl; } - clog << " source port " << udp_dest->source_port << endl; + etiLog.level(info) << " source port " << udp_dest->source_port; } else if (auto tcp_dest = dynamic_pointer_cast<edi::tcp_server_t>(edi_dest)) { - clog << " TCP listening on port " << tcp_dest->listen_port << endl; - clog << " max frames queued " << tcp_dest->max_frames_queued << endl; + etiLog.level(info) << " TCP listening on port " << tcp_dest->listen_port; + etiLog.level(info) << " max frames queued " << tcp_dest->max_frames_queued; } else if (auto tcp_dest = dynamic_pointer_cast<edi::tcp_client_t>(edi_dest)) { - clog << " TCP client connecting to " << tcp_dest->dest_addr << ":" << tcp_dest->dest_port << endl; - clog << " max frames queued " << tcp_dest->max_frames_queued << endl; + etiLog.level(info) << " TCP client connecting to " << tcp_dest->dest_addr << ":" << tcp_dest->dest_port; + etiLog.level(info) << " max frames queued " << tcp_dest->max_frames_queued; } else { throw logic_error("EDI destination not implemented"); } } if (interleaver_enabled()) { - clog << " interleave " << latency_frames * 24 << " ms" << endl; + etiLog.level(info) << " interleave " << latency_frames * 24 << " ms"; } } @@ -69,7 +67,7 @@ Sender::Sender(const configuration_t& conf) : edi_pft(m_conf) { if (m_conf.verbose) { - clog << "Setup EDI" << endl; + etiLog.log(info, "Setup EDI"); } for (const auto& edi_dest : m_conf.destinations) { @@ -107,7 +105,7 @@ Sender::Sender(const configuration_t& conf) : } if (m_conf.verbose) { - clog << "EDI set up" << endl; + etiLog.log(info, "EDI set up"); } } diff --git a/contrib/edi/Transport.h b/contrib/edi/Transport.h index db1adce..325acf8 100644 --- a/contrib/edi/Transport.h +++ b/contrib/edi/Transport.h @@ -9,29 +9,29 @@ */ /* - This file is part of ODR-DabMux. + This file is part of the ODR-mmbTools. - ODR-DabMux is free software: you can redistribute it and/or modify + 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. - ODR-DabMux is distributed in the hope that it will be useful, + 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 ODR-DabMux. If not, see <http://www.gnu.org/licenses/>. - */ + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ #pragma once #include "config.h" -#include "edi/Config.h" -#include "edi/AFPacket.h" -#include "edi/PFT.h" -#include "edi/Interleaver.h" +#include "Config.h" +#include "AFPacket.h" +#include "PFT.h" +#include "Interleaver.h" #include "Socket.h" #include <vector> #include <unordered_map> diff --git a/contrib/lib_crc.c b/contrib/lib_crc.c deleted file mode 100644 index 8f71ffb..0000000 --- a/contrib/lib_crc.c +++ /dev/null @@ -1,459 +0,0 @@ -#include "lib_crc.h"
-
-
-
- /*******************************************************************\
- * *
- * Library : lib_crc *
- * File : lib_crc.c *
- * Author : Lammert Bies 1999-2008 *
- * E-mail : info@lammertbies.nl *
- * Language : ANSI C *
- * *
- * *
- * Description *
- * =========== *
- * *
- * The file lib_crc.c contains the private and public func- *
- * tions used for the calculation of CRC-16, CRC-CCITT and *
- * CRC-32 cyclic redundancy values. *
- * *
- * *
- * Dependencies *
- * ============ *
- * *
- * lib_crc.h CRC definitions and prototypes *
- * *
- * *
- * Modification history *
- * ==================== *
- * *
- * Date Version Comment *
- * *
- * 2008-04-20 1.16 Added CRC-CCITT calculation for Kermit *
- * *
- * 2007-04-01 1.15 Added CRC16 calculation for Modbus *
- * *
- * 2007-03-28 1.14 Added CRC16 routine for Sick devices *
- * *
- * 2005-12-17 1.13 Added CRC-CCITT with initial 0x1D0F *
- * *
- * 2005-05-14 1.12 Added CRC-CCITT with start value 0 *
- * *
- * 2005-02-05 1.11 Fixed bug in CRC-DNP routine *
- * *
- * 2005-02-04 1.10 Added CRC-DNP routines *
- * *
- * 1999-02-21 1.01 Added FALSE and TRUE mnemonics *
- * *
- * 1999-01-22 1.00 Initial source *
- * *
- \*******************************************************************/
-
-
-
- /*******************************************************************\
- * *
- * #define P_xxxx *
- * *
- * The CRC's are computed using polynomials. The coefficients *
- * for the algorithms are defined by the following constants. *
- * *
- \*******************************************************************/
-
-#define P_16 0xA001
-#define P_32 0xEDB88320L
-#define P_CCITT 0x1021
-#define P_DNP 0xA6BC
-#define P_KERMIT 0x8408
-#define P_SICK 0x8005
-
-
-
- /*******************************************************************\
- * *
- * static int crc_tab...init *
- * static unsigned ... crc_tab...[] *
- * *
- * The algorithms use tables with precalculated values. This *
- * speeds up the calculation dramaticaly. The first time the *
- * CRC function is called, the table for that specific calcu- *
- * lation is set up. The ...init variables are used to deter- *
- * mine if the initialization has taken place. The calculated *
- * values are stored in the crc_tab... arrays. *
- * *
- * The variables are declared static. This makes them invisi- *
- * ble for other modules of the program. *
- * *
- \*******************************************************************/
-
-static int crc_tab16_init = FALSE;
-static int crc_tab32_init = FALSE;
-static int crc_tabccitt_init = FALSE;
-static int crc_tabdnp_init = FALSE;
-static int crc_tabkermit_init = FALSE;
-
-static unsigned short crc_tab16[256];
-static unsigned long crc_tab32[256];
-static unsigned short crc_tabccitt[256];
-static unsigned short crc_tabdnp[256];
-static unsigned short crc_tabkermit[256];
-
-
-
- /*******************************************************************\
- * *
- * static void init_crc...tab(); *
- * *
- * Three local functions are used to initialize the tables *
- * with values for the algorithm. *
- * *
- \*******************************************************************/
-
-static void init_crc16_tab( void );
-static void init_crc32_tab( void );
-static void init_crcccitt_tab( void );
-static void init_crcdnp_tab( void );
-static void init_crckermit_tab( void );
-
-
-
- /*******************************************************************\
- * *
- * unsigned short update_crc_ccitt( unsigned long crc, char c ); *
- * *
- * The function update_crc_ccitt calculates a new CRC-CCITT *
- * value based on the previous value of the CRC and the next *
- * byte of the data to be checked. *
- * *
- \*******************************************************************/
-
-unsigned short update_crc_ccitt( unsigned short crc, char c ) {
-
- unsigned short tmp, short_c;
-
- short_c = 0x00ff & (unsigned short) c;
-
- if ( ! crc_tabccitt_init ) init_crcccitt_tab();
-
- tmp = (crc >> 8) ^ short_c;
- crc = (crc << 8) ^ crc_tabccitt[tmp];
-
- return crc;
-
-} /* update_crc_ccitt */
-
-
-
- /*******************************************************************\
- * *
- * unsigned short update_crc_sick( *
- * unsigned long crc, char c, char prev_byte ); *
- * *
- * The function update_crc_sick calculates a new CRC-SICK *
- * value based on the previous value of the CRC and the next *
- * byte of the data to be checked. *
- * *
- \*******************************************************************/
-
-unsigned short update_crc_sick( unsigned short crc, char c, char prev_byte ) {
-
- unsigned short short_c, short_p;
-
- short_c = 0x00ff & (unsigned short) c;
- short_p = ( 0x00ff & (unsigned short) prev_byte ) << 8;
-
- if ( crc & 0x8000 ) crc = ( crc << 1 ) ^ P_SICK;
- else crc = crc << 1;
-
- crc &= 0xffff;
- crc ^= ( short_c | short_p );
-
- return crc;
-
-} /* update_crc_sick */
-
-
-
- /*******************************************************************\
- * *
- * unsigned short update_crc_16( unsigned short crc, char c ); *
- * *
- * The function update_crc_16 calculates a new CRC-16 value *
- * based on the previous value of the CRC and the next byte *
- * of the data to be checked. *
- * *
- \*******************************************************************/
-
-unsigned short update_crc_16( unsigned short crc, char c ) {
-
- unsigned short tmp, short_c;
-
- short_c = 0x00ff & (unsigned short) c;
-
- if ( ! crc_tab16_init ) init_crc16_tab();
-
- tmp = crc ^ short_c;
- crc = (crc >> 8) ^ crc_tab16[ tmp & 0xff ];
-
- return crc;
-
-} /* update_crc_16 */
-
-
-
- /*******************************************************************\
- * *
- * unsigned short update_crc_kermit( unsigned short crc, char c ); *
- * *
- * The function update_crc_kermit calculates a new CRC value *
- * based on the previous value of the CRC and the next byte *
- * of the data to be checked. *
- * *
- \*******************************************************************/
-
-unsigned short update_crc_kermit( unsigned short crc, char c ) {
-
- unsigned short tmp, short_c;
-
- short_c = 0x00ff & (unsigned short) c;
-
- if ( ! crc_tabkermit_init ) init_crckermit_tab();
-
- tmp = crc ^ short_c;
- crc = (crc >> 8) ^ crc_tabkermit[ tmp & 0xff ];
-
- return crc;
-
-} /* update_crc_kermit */
-
-
-
- /*******************************************************************\
- * *
- * unsigned short update_crc_dnp( unsigned short crc, char c ); *
- * *
- * The function update_crc_dnp calculates a new CRC-DNP value *
- * based on the previous value of the CRC and the next byte *
- * of the data to be checked. *
- * *
- \*******************************************************************/
-
-unsigned short update_crc_dnp( unsigned short crc, char c ) {
-
- unsigned short tmp, short_c;
-
- short_c = 0x00ff & (unsigned short) c;
-
- if ( ! crc_tabdnp_init ) init_crcdnp_tab();
-
- tmp = crc ^ short_c;
- crc = (crc >> 8) ^ crc_tabdnp[ tmp & 0xff ];
-
- return crc;
-
-} /* update_crc_dnp */
-
-
-
- /*******************************************************************\
- * *
- * unsigned long update_crc_32( unsigned long crc, char c ); *
- * *
- * The function update_crc_32 calculates a new CRC-32 value *
- * based on the previous value of the CRC and the next byte *
- * of the data to be checked. *
- * *
- \*******************************************************************/
-
-unsigned long update_crc_32( unsigned long crc, char c ) {
-
- unsigned long tmp, long_c;
-
- long_c = 0x000000ffL & (unsigned long) c;
-
- if ( ! crc_tab32_init ) init_crc32_tab();
-
- tmp = crc ^ long_c;
- crc = (crc >> 8) ^ crc_tab32[ tmp & 0xff ];
-
- return crc;
-
-} /* update_crc_32 */
-
-
-
- /*******************************************************************\
- * *
- * static void init_crc16_tab( void ); *
- * *
- * The function init_crc16_tab() is used to fill the array *
- * for calculation of the CRC-16 with values. *
- * *
- \*******************************************************************/
-
-static void init_crc16_tab( void ) {
-
- int i, j;
- unsigned short crc, c;
-
- for (i=0; i<256; i++) {
-
- crc = 0;
- c = (unsigned short) i;
-
- for (j=0; j<8; j++) {
-
- if ( (crc ^ c) & 0x0001 ) crc = ( crc >> 1 ) ^ P_16;
- else crc = crc >> 1;
-
- c = c >> 1;
- }
-
- crc_tab16[i] = crc;
- }
-
- crc_tab16_init = TRUE;
-
-} /* init_crc16_tab */
-
-
-
- /*******************************************************************\
- * *
- * static void init_crckermit_tab( void ); *
- * *
- * The function init_crckermit_tab() is used to fill the array *
- * for calculation of the CRC Kermit with values. *
- * *
- \*******************************************************************/
-
-static void init_crckermit_tab( void ) {
-
- int i, j;
- unsigned short crc, c;
-
- for (i=0; i<256; i++) {
-
- crc = 0;
- c = (unsigned short) i;
-
- for (j=0; j<8; j++) {
-
- if ( (crc ^ c) & 0x0001 ) crc = ( crc >> 1 ) ^ P_KERMIT;
- else crc = crc >> 1;
-
- c = c >> 1;
- }
-
- crc_tabkermit[i] = crc;
- }
-
- crc_tabkermit_init = TRUE;
-
-} /* init_crckermit_tab */
-
-
-
- /*******************************************************************\
- * *
- * static void init_crcdnp_tab( void ); *
- * *
- * The function init_crcdnp_tab() is used to fill the array *
- * for calculation of the CRC-DNP with values. *
- * *
- \*******************************************************************/
-
-static void init_crcdnp_tab( void ) {
-
- int i, j;
- unsigned short crc, c;
-
- for (i=0; i<256; i++) {
-
- crc = 0;
- c = (unsigned short) i;
-
- for (j=0; j<8; j++) {
-
- if ( (crc ^ c) & 0x0001 ) crc = ( crc >> 1 ) ^ P_DNP;
- else crc = crc >> 1;
-
- c = c >> 1;
- }
-
- crc_tabdnp[i] = crc;
- }
-
- crc_tabdnp_init = TRUE;
-
-} /* init_crcdnp_tab */
-
-
-
- /*******************************************************************\
- * *
- * static void init_crc32_tab( void ); *
- * *
- * The function init_crc32_tab() is used to fill the array *
- * for calculation of the CRC-32 with values. *
- * *
- \*******************************************************************/
-
-static void init_crc32_tab( void ) {
-
- int i, j;
- unsigned long crc;
-
- for (i=0; i<256; i++) {
-
- crc = (unsigned long) i;
-
- for (j=0; j<8; j++) {
-
- if ( crc & 0x00000001L ) crc = ( crc >> 1 ) ^ P_32;
- else crc = crc >> 1;
- }
-
- crc_tab32[i] = crc;
- }
-
- crc_tab32_init = TRUE;
-
-} /* init_crc32_tab */
-
-
-
- /*******************************************************************\
- * *
- * static void init_crcccitt_tab( void ); *
- * *
- * The function init_crcccitt_tab() is used to fill the array *
- * for calculation of the CRC-CCITT with values. *
- * *
- \*******************************************************************/
-
-static void init_crcccitt_tab( void ) {
-
- int i, j;
- unsigned short crc, c;
-
- for (i=0; i<256; i++) {
-
- crc = 0;
- c = ((unsigned short) i) << 8;
-
- for (j=0; j<8; j++) {
-
- if ( (crc ^ c) & 0x8000 ) crc = ( crc << 1 ) ^ P_CCITT;
- else crc = crc << 1;
-
- c = c << 1;
- }
-
- crc_tabccitt[i] = crc;
- }
-
- crc_tabccitt_init = TRUE;
-
-} /* init_crcccitt_tab */
diff --git a/contrib/lib_crc.h b/contrib/lib_crc.h deleted file mode 100644 index 0e559e6..0000000 --- a/contrib/lib_crc.h +++ /dev/null @@ -1,66 +0,0 @@ - /*******************************************************************\
- * *
- * Library : lib_crc *
- * File : lib_crc.h *
- * Author : Lammert Bies 1999-2008 *
- * E-mail : info@lammertbies.nl *
- * Language : ANSI C *
- * *
- * *
- * Description *
- * =========== *
- * *
- * The file lib_crc.h contains public definitions and proto- *
- * types for the CRC functions present in lib_crc.c. *
- * *
- * *
- * Dependencies *
- * ============ *
- * *
- * none *
- * *
- * *
- * Modification history *
- * ==================== *
- * *
- * Date Version Comment *
- * *
- * 2008-04-20 1.16 Added CRC-CCITT routine for Kermit *
- * *
- * 2007-04-01 1.15 Added CRC16 calculation for Modbus *
- * *
- * 2007-03-28 1.14 Added CRC16 routine for Sick devices *
- * *
- * 2005-12-17 1.13 Added CRC-CCITT with initial 0x1D0F *
- * *
- * 2005-02-14 1.12 Added CRC-CCITT with initial 0x0000 *
- * *
- * 2005-02-05 1.11 Fixed bug in CRC-DNP routine *
- * *
- * 2005-02-04 1.10 Added CRC-DNP routines *
- * *
- * 2005-01-07 1.02 Changes in tst_crc.c *
- * *
- * 1999-02-21 1.01 Added FALSE and TRUE mnemonics *
- * *
- * 1999-01-22 1.00 Initial source *
- * *
- \*******************************************************************/
-
-
-
-#define CRC_VERSION "1.16"
-
-
-
-#define FALSE 0
-#define TRUE 1
-
-
-
-unsigned short update_crc_16( unsigned short crc, char c );
-unsigned long update_crc_32( unsigned long crc, char c );
-unsigned short update_crc_ccitt( unsigned short crc, char c );
-unsigned short update_crc_dnp( unsigned short crc, char c );
-unsigned short update_crc_kermit( unsigned short crc, char c );
-unsigned short update_crc_sick( unsigned short crc, char c, char prev_byte );
|