/*
Copyright (C) 2009 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
A TCP Socket server that serves state information and statistics for
monitoring purposes, and also serves the internal configuration
property tree.
*/
/*
This file is part of ODR-DabMux.
ODR-DabMux 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,
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 .
*/
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include "ManagementServer.h"
#include "Log.h"
static constexpr
auto stats_keep_duration = std::chrono::seconds(INPUT_NODATA_TIMEOUT);
ManagementServer& get_mgmt_server()
{
static ManagementServer mgmt_server;
return mgmt_server;
/* Warning, do not use the mgmt_server in the destructor
* of another global object: you don't know which one
* gets destroyed first
*/
}
void ManagementServer::registerInput(InputStat* is)
{
boost::mutex::scoped_lock lock(m_statsmutex);
std::string id(is->get_name());
if (m_inputStats.count(id) == 1) {
etiLog.level(error) <<
"Double registration in MGMT Server with id '" <<
id << "'";
return;
}
m_inputStats[id] = is;
}
void ManagementServer::unregisterInput(std::string id)
{
boost::mutex::scoped_lock lock(m_statsmutex);
if (m_inputStats.count(id) == 1) {
m_inputStats.erase(id);
}
}
bool ManagementServer::isInputRegistered(std::string& id)
{
boost::mutex::scoped_lock lock(m_statsmutex);
if (m_inputStats.count(id) == 0) {
etiLog.level(error) <<
"Management Server: id '" <<
id << "' does was not registered";
return false;
}
return true;
}
std::string ManagementServer::getStatConfigJSON()
{
boost::mutex::scoped_lock lock(m_statsmutex);
std::ostringstream ss;
ss << "{ \"config\" : [\n";
std::map::iterator iter;
int i = 0;
for(iter = m_inputStats.begin(); iter != m_inputStats.end();
++iter, i++)
{
std::string id = iter->first;
if (i > 0) {
ss << ", ";
}
ss << " \"" << id << "\" ";
}
ss << "] }\n";
return ss.str();
}
std::string ManagementServer::getValuesJSON()
{
boost::mutex::scoped_lock lock(m_statsmutex);
std::ostringstream ss;
ss << "{ \"values\" : {\n";
std::map::iterator iter;
int i = 0;
for(iter = m_inputStats.begin(); iter != m_inputStats.end();
++iter, i++)
{
const std::string& id = iter->first;
InputStat* stats = iter->second;
if (i > 0) {
ss << " ,\n";
}
ss << " \"" << id << "\" : ";
ss << stats->encodeValuesJSON();
}
ss << "}\n}\n";
return ss.str();
}
void ManagementServer::restart()
{
m_restarter_thread = boost::thread(&ManagementServer::restart_thread,
this, 0);
}
// This runs in a separate thread, because
// it would take too long to be done in the main loop
// thread.
void ManagementServer::restart_thread(long)
{
m_running = false;
if (m_listenport) {
m_thread.interrupt();
m_thread.join();
}
m_thread = boost::thread(&ManagementServer::serverThread, this);
}
void ManagementServer::serverThread()
{
m_running = true;
m_fault = false;
std::stringstream bind_addr;
bind_addr << "tcp://127.0.0.1:" << m_listenport;
m_zmq_sock.bind(bind_addr.str().c_str());
while (m_running) {
zmq::message_t zmq_message;
if (m_zmq_sock.recv(&zmq_message, ZMQ_DONTWAIT)) {
handle_message(zmq_message);
}
else {
usleep(10000);
}
}
m_fault = true;
}
void ManagementServer::handle_message(zmq::message_t& zmq_message)
{
std::stringstream answer;
std::string data((char*)zmq_message.data(), zmq_message.size());
etiLog.level(debug) << "ManagementServer: '" << data << "' request";
try {
if (data == "info") {
answer <<
"{ \"service\": \"" <<
PACKAGE_NAME << " " <<
#if defined(GITVERSION)
GITVERSION <<
#else
PACKAGE_VERSION <<
#endif
" MGMT Server\" }\n";
}
else if (data == "config") {
answer << getStatConfigJSON();
}
else if (data == "values") {
answer << getValuesJSON();
}
else if (data == "getptree") {
boost::unique_lock lock(m_configmutex);
boost::property_tree::json_parser::write_json(answer, m_pt);
}
else {
etiLog.level(warn) << "ManagementServer: Invalid request '" << data << "'";
answer << "Invalid command";
}
std::string answerstr(answer.str());
m_zmq_sock.send(answerstr.c_str(), answerstr.size());
}
catch (std::exception& e) {
etiLog.level(error) <<
"MGMT server caught exception: " <<
e.what();
}
}
void ManagementServer::update_ptree(const boost::property_tree::ptree& pt)
{
if (m_running) {
boost::unique_lock lock(m_configmutex);
m_pt = pt;
}
}
/************************************************/
InputStat::InputStat(const std::string& name)
: m_name(name)
{
/* Statistics */
num_underruns = 0;
num_overruns = 0;
/* State handling */
time_t now = time(NULL);
m_time_last_event = now;
m_glitch_counter = 0;
m_silence_counter = 0;
buffer_fill_stats.clear();
peaks_left.clear();
peaks_right.clear();
}
InputStat::~InputStat()
{
get_mgmt_server().unregisterInput(m_name);
}
void InputStat::registerAtServer()
{
get_mgmt_server().registerInput(this);
}
void InputStat::notifyBuffer(long bufsize)
{
boost::mutex::scoped_lock lock(m_mutex);
buffer_fill_stats.push_back(bufsize);
using namespace std::chrono;
const auto time_now = steady_clock::now();
if (buffer_fill_stats.size() > 1) {
auto insertion_interval = time_now - time_last_buffer_notify;
auto total_length = insertion_interval * buffer_fill_stats.size();
if (total_length > stats_keep_duration) {
buffer_fill_stats.pop_front();
}
}
time_last_buffer_notify = time_now;
}
void InputStat::notifyPeakLevels(int peak_left, int peak_right)
{
boost::mutex::scoped_lock lock(m_mutex);
peaks_left.push_back(peak_left);
peaks_right.push_back(peak_right);
using namespace std::chrono;
const auto time_now = steady_clock::now();
if (peaks_left.size() > 1) {
auto insertion_interval = time_now - time_last_peak_notify;
auto peaks_total_length = insertion_interval * peaks_left.size();
if (peaks_total_length > stats_keep_duration) {
peaks_left.pop_front();
peaks_right.pop_front();
}
}
time_last_peak_notify = time_now;
if (peaks_left.empty() or peaks_right.empty()) {
throw std::logic_error("Peak statistics empty!");
}
const auto max_left = *max_element(peaks_left.begin(), peaks_left.end());
const auto max_right = *max_element(peaks_right.begin(), peaks_right.end());
// State
// using the lower of the two channels allows us to detect if only one
// channel is silent.
const int lower_peak = max_left < max_right ? max_left : max_right;
const int16_t int16_max = std::numeric_limits::max();
int peak_dB = lower_peak ?
round(20*log10((double)lower_peak / int16_max)) :
-90;
if (peak_dB < INPUT_AUDIO_LEVEL_THRESHOLD) {
if (m_silence_counter < INPUT_AUDIO_LEVEL_COUNT_SATURATION) {
m_silence_counter++;
}
}
else {
if (m_silence_counter > 0) {
m_silence_counter--;
}
}
}
void InputStat::notifyUnderrun(void)
{
boost::mutex::scoped_lock lock(m_mutex);
// Statistics
num_underruns++;
// State
m_time_last_event = time(NULL);
if (m_glitch_counter < INPUT_UNSTABLE_THRESHOLD) {
m_glitch_counter++;
}
}
void InputStat::notifyOverrun(void)
{
boost::mutex::scoped_lock lock(m_mutex);
// Statistics
num_overruns++;
// State
m_time_last_event = time(NULL);
if (m_glitch_counter < INPUT_UNSTABLE_THRESHOLD) {
m_glitch_counter++;
}
}
std::string InputStat::encodeValuesJSON()
{
std::ostringstream ss;
const int16_t int16_max = std::numeric_limits::max();
boost::mutex::scoped_lock lock(m_mutex);
int peak_left = 0;
int peak_right = 0;
if (not peaks_left.empty() and not peaks_right.empty()) {
peak_left = *max_element(peaks_left.begin(), peaks_left.end());
peak_right = *max_element(peaks_right.begin(), peaks_right.end());
}
/* convert to dB */
int dB_l = peak_left ? round(20*log10((double)peak_left / int16_max)) : -90;
int dB_r = peak_right ? round(20*log10((double)peak_right / int16_max)) : -90;
long min_fill_buffer = MIN_FILL_BUFFER_UNDEF;
long max_fill_buffer = 0;
if (not buffer_fill_stats.empty()) {
auto buffer_min_max_fill = minmax_element(buffer_fill_stats.begin(),
buffer_fill_stats.end());
min_fill_buffer = *buffer_min_max_fill.first;
max_fill_buffer = *buffer_min_max_fill.second;
}
ss <<
"{ \"inputstat\" : {"
"\"min_fill\": " << min_fill_buffer << ", "
"\"max_fill\": " << max_fill_buffer << ", "
"\"peak_left\": " << dB_l << ", "
"\"peak_right\": " << dB_r << ", "
"\"num_underruns\": " << num_underruns << ", "
"\"num_overruns\": " << num_overruns << ", ";
ss << "\"state\": ";
switch (determineState()) {
case NoData:
ss << "\"NoData (1)\"";
break;
case Unstable:
ss << "\"Unstable (2)\"";
break;
case Silence:
ss << "\"Silent (3)\"";
break;
case Streaming:
ss << "\"Streaming (4)\"";
break;
default:
ss << "\"Unknown (0)\"";
}
ss << " } }";
return ss.str();
}
input_state_t InputStat::determineState()
{
time_t now = time(nullptr);
input_state_t state;
/* if the last event was more that INPUT_COUNTER_RESET_TIME
* minutes ago, the timeout has expired. We can reset our
* glitch counter.
*/
if (now - m_time_last_event > 60*INPUT_COUNTER_RESET_TIME) {
m_glitch_counter = 0;
}
// STATE CALCULATION
/* If the buffer has been empty for more than
* INPUT_NODATA_TIMEOUT, we go to the NoData state.
*
* Consider an empty deque to be NoData too.
*/
if (std::all_of(
buffer_fill_stats.begin(), buffer_fill_stats.end(),
[](long fill) { return fill == 0; }) ) {
state = NoData;
}
/* Otherwise, the state depends on the glitch counter */
else if (m_glitch_counter >= INPUT_UNSTABLE_THRESHOLD) {
state = Unstable;
}
else {
/* The input is streaming, check if the audio level is too low */
if (m_silence_counter > INPUT_AUDIO_LEVEL_SILENCE_COUNT) {
state = Silence;
}
else {
state = Streaming;
}
}
return state;
}