1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00
VILLASnode/lib/hooks/jitter_calc.cpp
2021-03-17 14:58:45 +00:00

122 lines
4.1 KiB
C++

/** Calc jitter, mean and variance of GPS vs NTP TS.
*
* @author Umar Farooq <umar.farooq@rwth-aachen.de>
* @copyright 2014-2020, Institute for Automation of Complex Power Systems, EONERC
* @license GNU General Public License (version 3)
*
* VILLASnode
*
* 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
* 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/>.
*********************************************************************************/
/** @addtogroup hooks Hook functions
* @{
*/
#include <vector>
#include <cinttypes>
#include <cstring>
#include <villas/hook.hpp>
#include <villas/timing.h>
#include <villas/sample.h>
#include <villas/utils.hpp>
#define GPS_NTP_DELAY_WIN_SIZE 16
namespace villas {
namespace node {
class JitterCalcHook : public Hook {
protected:
std::vector<int64_t> jitter_val;
std::vector<int64_t> delay_series;
std::vector<int64_t> moving_avg;
std::vector<int64_t> moving_var;
int64_t delay_mov_sum;
int64_t delay_mov_sum_sqrd;
int curr_count;
public:
JitterCalcHook(struct vpath *p, struct vnode *n, int fl, int prio, bool en = true) :
Hook(p, n, fl, prio, en),
jitter_val(GPS_NTP_DELAY_WIN_SIZE),
delay_series(GPS_NTP_DELAY_WIN_SIZE),
moving_avg(GPS_NTP_DELAY_WIN_SIZE),
moving_var(GPS_NTP_DELAY_WIN_SIZE),
delay_mov_sum(0),
delay_mov_sum_sqrd(0),
curr_count(0)
{ }
/**
* Hook to calculate jitter between GTNET-SKT GPS timestamp and Villas node NTP timestamp.
*
* Drawbacks: No protection for out of order packets. Default positive delay assumed,
* so GPS timestamp should be earlier than NTP timestamp. If difference b/w NTP and GPS ts
* is high (i.e. several mins depending on GPS_NTP_DELAY_WIN_SIZE),
* the variance value will overrun the 64bit value.
*/
virtual Hook::Reason process(sample *smp)
{
assert(state == State::STARTED);
timespec now = time_now();
int64_t delay_sec, delay_nsec, curr_delay_us;
delay_sec = now.tv_sec - smp->ts.origin.tv_sec;
delay_nsec = now.tv_nsec - smp->ts.origin.tv_nsec;
/* Calc on microsec instead of nenosec delay as variance formula overflows otherwise.*/
curr_delay_us = delay_sec * 1000000 + delay_nsec / 1000;
delay_mov_sum = delay_mov_sum + curr_delay_us - delay_series[curr_count];
moving_avg[curr_count] = delay_mov_sum / GPS_NTP_DELAY_WIN_SIZE; /* Will be valid after GPS_NTP_DELAY_WIN_SIZE initial values */
delay_mov_sum_sqrd = delay_mov_sum_sqrd + (curr_delay_us * curr_delay_us) - (delay_series[curr_count] * delay_series[curr_count]);
moving_var[curr_count] = (delay_mov_sum_sqrd - (delay_mov_sum * delay_mov_sum) / GPS_NTP_DELAY_WIN_SIZE) / (GPS_NTP_DELAY_WIN_SIZE - 1);
delay_series[curr_count] = curr_delay_us; /* Update the last delay value */
/* Jitter calc formula as used in Wireshark according to RFC3550 (RTP)
D(i,j) = (Rj-Ri)-(Sj-Si) = (Rj-Sj)-(Ri-Si)
J(i) = J(i-1)+(|D(i-1,i)|-J(i-1))/16
*/
jitter_val[(curr_count + 1) % GPS_NTP_DELAY_WIN_SIZE] = jitter_val[curr_count] + (labs(curr_delay_us) - jitter_val[curr_count]) / 16;
logger->info("{}: jitter={} usec, moving average={} usec, moving variance={} usec", __FUNCTION__,
jitter_val[(curr_count + 1) % GPS_NTP_DELAY_WIN_SIZE],
moving_avg[curr_count],
moving_var[curr_count]);
curr_count++;
if (curr_count >= GPS_NTP_DELAY_WIN_SIZE)
curr_count = 0;
return Reason::OK;
}
};
/* Register hook */
static char n[] = "jitter_calc";
static char d[] = "Calc jitter, mean and variance of GPS vs NTP TS";
static HookPlugin<JitterCalcHook, n, d, (int) Hook::Flags::NODE_READ | (int) Hook::Flags::PATH, 0> p;
} /* namespace node */
} /* namespace villas */
/** @} */