Files
chrony/test/unit/sources.c
Miroslav Lichvar 9b183fe98f sources: add option to limit selection of unreachable sources
Add maxunreach option to NTP sources and refclocks to specify the
maximum number of polls that the source can stay selected for
synchronization when it is unreachable (i.e. no valid sample was
received in the last 8 polls).

It is an additional requirement to having at least one sample more
recent than the oldest sample of reachable sources.

The default value is 100000. Setting the option to 0 disables selection
of unreachable sources, which matches RFC 5905.
2025-08-07 10:18:31 +02:00

291 lines
10 KiB
C

/*
**********************************************************************
* Copyright (C) Miroslav Lichvar 2016, 2018, 2022
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of version 2 of the GNU General Public License as
* published by the Free Software Foundation.
*
* 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, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
**********************************************************************
*/
#include <sources.c>
#include "test.h"
static SRC_Instance
create_source(SRC_Type type, IPAddr *addr, int authenticated, int sel_options)
{
TST_GetRandomAddress(addr, IPADDR_UNSPEC, -1);
return SRC_CreateNewInstance(UTI_IPToRefid(addr), type, authenticated, sel_options,
type == SRC_NTP ? addr : NULL,
SRC_DEFAULT_MINSAMPLES, SRC_DEFAULT_MAXSAMPLES, 0.0, 1.0,
SRC_DEFAULT_MAXUNREACH);
}
void
test_unit(void)
{
SRC_AuthSelectMode sel_mode;
SRC_Instance srcs[16];
IPAddr addrs[16];
RPT_SourceReport report;
NTP_Sample sample;
int i, j, k, l, n1, n2, n3, n4, samples, sel_options;
char conf[128];
CNF_Initialise(0, 0);
LCL_Initialise();
TST_RegisterDummyDrivers();
SCH_Initialise();
SRC_Initialise();
REF_Initialise();
NSR_Initialise();
REF_SetMode(REF_ModeIgnore);
for (i = 0; i < 1000; i++) {
DEBUG_LOG("iteration %d", i);
for (j = 0; j < sizeof (srcs) / sizeof (srcs[0]); j++) {
TEST_CHECK(n_sources == j);
sel_options = i & random() & (SRC_SELECT_NOSELECT | SRC_SELECT_PREFER |
SRC_SELECT_TRUST | SRC_SELECT_REQUIRE);
DEBUG_LOG("added source %d options %d", j, sel_options);
srcs[j] = create_source(SRC_NTP, &addrs[j], 0, sel_options);
SRC_UpdateReachability(srcs[j], 1);
samples = (i + j) % 5 + 3;
sample.offset = TST_GetRandomDouble(-1.0, 1.0);
for (k = 0; k < samples; k++) {
SCH_GetLastEventTime(&sample.time, NULL, NULL);
UTI_AddDoubleToTimespec(&sample.time, TST_GetRandomDouble(k - samples, k - samples + 1),
&sample.time);
sample.offset += TST_GetRandomDouble(-1.0e-2, 1.0e-2);
sample.peer_delay = TST_GetRandomDouble(1.0e-6, 1.0e-1);
sample.peer_dispersion = TST_GetRandomDouble(1.0e-6, 1.0e-1);
sample.root_delay = sample.peer_delay;
sample.root_dispersion = sample.peer_dispersion;
if (random() % 2)
SRC_UpdateStatus(srcs[j], 1, random() % 4);
DEBUG_LOG("source %d sample %d offset %f delay %f disp %f", j, k,
sample.offset, sample.peer_delay, sample.peer_dispersion);
SRC_AccumulateSample(srcs[j], &sample);
}
for (k = 0; k <= j; k++) {
int passed = 0, trusted = 0, trusted_passed = 0, required = 0, required_passed = 0;
double trusted_lo = DBL_MAX, trusted_hi = DBL_MIN;
double passed_lo = DBL_MAX, passed_hi = DBL_MIN;
SRC_SelectSource(srcs[k]);
DEBUG_LOG("source %d status %c", k, get_status_char(sources[k]->status));
for (l = 0; l <= j; l++) {
TEST_CHECK(sources[l]->status > SRC_OK && sources[l]->status <= SRC_SELECTED);
if (sources[l]->sel_options & SRC_SELECT_NOSELECT) {
TEST_CHECK(sources[l]->status == SRC_UNSELECTABLE);
} else if (sources[l]->leap == LEAP_Unsynchronised) {
TEST_CHECK(sources[l]->status == SRC_UNSYNCHRONISED);
} else if (sources[l]->status != SRC_BAD_DISTANCE) {
if (sources[l]->status >= SRC_NONPREFERRED) {
passed++;
if (passed_lo > sources[l]->sel_info.lo_limit)
passed_lo = sources[l]->sel_info.lo_limit;
if (passed_hi < sources[l]->sel_info.hi_limit)
passed_hi = sources[l]->sel_info.hi_limit;
}
if (sources[l]->sel_options & SRC_SELECT_TRUST) {
trusted++;
if (trusted_lo > sources[l]->sel_info.lo_limit)
trusted_lo = sources[l]->sel_info.lo_limit;
if (trusted_hi < sources[l]->sel_info.hi_limit)
trusted_hi = sources[l]->sel_info.hi_limit;
if (sources[l]->status >= SRC_NONPREFERRED)
trusted_passed++;
}
if (sources[l]->sel_options & SRC_SELECT_REQUIRE) {
required++;
if (sources[l]->status >= SRC_NONPREFERRED)
required_passed++;
}
if (sources[l]->sel_options & SRC_SELECT_PREFER)
TEST_CHECK(sources[l]->status != SRC_NONPREFERRED);
}
}
DEBUG_LOG("sources %d passed %d trusted %d/%d required %d/%d", j + 1, passed,
trusted_passed, trusted, required_passed, required);
TEST_CHECK(!trusted || !passed || (passed_lo >= trusted_lo && passed_hi <= trusted_hi));
TEST_CHECK(!passed || !trusted || trusted_passed >= 1);
TEST_CHECK(!passed || !required || required_passed > 0);
for (l = 0; l <= j; l++) {
TEST_CHECK(sources[l]->leap_vote ==
(sources[l]->status >= SRC_NONPREFERRED &&
(!trusted || sources[l]->sel_options & SRC_SELECT_TRUST)));
}
}
}
for (j = 0; j < sizeof (srcs) / sizeof (srcs[0]); j++) {
SRC_ReportSource(j, &report, &sample.time);
SRC_DestroyInstance(srcs[j]);
}
}
for (i = 0; i < 16; i++) {
DEBUG_LOG("iteration %d", i);
for (j = 0; j < sizeof (srcs) / sizeof (srcs[0]); j++) {
TEST_CHECK(n_sources == j);
srcs[j] = create_source(SRC_NTP, &addrs[j], 0, 0);
SRC_UpdateReachability(srcs[j], 1);
samples = 8;
for (k = 0; k < samples; k++) {
SCH_GetLastEventTime(&sample.time, NULL, NULL);
UTI_AddDoubleToTimespec(&sample.time, k - samples, &sample.time);
if (j != 0)
UTI_AddDoubleToTimespec(&sample.time, -i * (1.0e-3 / LCL_GetMaxClockError()), &sample.time);
sample.offset = (k % 2) * 1e-8;
sample.peer_delay = sample.root_delay = 2.0e-3 * (j + 1);
sample.peer_dispersion = sample.root_dispersion = 4.0e-3;
SRC_AccumulateSample(srcs[j], &sample);
SRC_UpdateStatus(srcs[j], 1, LEAP_Normal);
}
}
SRC_SelectSource(srcs[0]);
for (j = 0; j < sizeof (srcs) / sizeof (srcs[0]); j++) {
DEBUG_LOG("%d %c %f", j, get_status_char(srcs[j]->status),
srcs[j]->sel_info.root_distance);
if (j == 0)
TEST_CHECK(sources[j]->status == SRC_SELECTED);
else if (j < 11 - i)
TEST_CHECK(sources[j]->status == SRC_UNSELECTED);
else
TEST_CHECK(sources[j]->status == SRC_DISTANT);
}
for (j = 0; j < sizeof (srcs) / sizeof (srcs[0]); j++) {
SCH_GetLastEventTime(&sample.time, NULL, NULL);
SRC_ReportSource(j, &report, &sample.time);
SRC_DestroyInstance(srcs[j]);
}
}
TEST_CHECK(CNF_GetAuthSelectMode() == SRC_AUTHSELECT_MIX);
for (i = 0; i < 1000; i++) {
DEBUG_LOG("iteration %d", i);
switch (i % 4) {
case 0:
snprintf(conf, sizeof (conf), "authselectmode require");
sel_mode = SRC_AUTHSELECT_REQUIRE;
break;
case 1:
snprintf(conf, sizeof (conf), "authselectmode prefer");
sel_mode = SRC_AUTHSELECT_PREFER;
break;
case 2:
snprintf(conf, sizeof (conf), "authselectmode mix");
sel_mode = SRC_AUTHSELECT_MIX;
break;
case 3:
snprintf(conf, sizeof (conf), "authselectmode ignore");
sel_mode = SRC_AUTHSELECT_IGNORE;
break;
}
CNF_ParseLine(NULL, 0, conf);
TEST_CHECK(CNF_GetAuthSelectMode() == sel_mode);
sel_options = random() & (SRC_SELECT_PREFER | SRC_SELECT_TRUST | SRC_SELECT_REQUIRE);
n1 = random() % 3;
n2 = random() % 3;
n3 = random() % 3;
n4 = random() % 3;
assert(n1 + n2 + n3 < sizeof (srcs) / sizeof (srcs[0]));
for (j = 0; j < n1; j++)
srcs[j] = create_source(SRC_REFCLOCK, &addrs[j], random() % 2, sel_options);
for (; j < n1 + n2; j++)
srcs[j] = create_source(SRC_NTP, &addrs[j], 1, sel_options);
for (; j < n1 + n2 + n3; j++)
srcs[j] = create_source(SRC_NTP, &addrs[j], 0, sel_options);
for (; j < n1 + n2 + n3 + n4; j++)
srcs[j] = create_source(random() % 2 ? SRC_REFCLOCK : SRC_NTP, &addrs[j],
random() % 2, sel_options | SRC_SELECT_NOSELECT);
switch (sel_mode) {
case SRC_AUTHSELECT_IGNORE:
for (j = 0; j < n1 + n2 + n3; j++)
TEST_CHECK(srcs[j]->sel_options == sel_options);
break;
case SRC_AUTHSELECT_MIX:
for (j = 0; j < n1 + n2; j++)
TEST_CHECK(srcs[j]->sel_options ==
(sel_options | (n2 > 0 && n3 > 0 ? SRC_SELECT_REQUIRE | SRC_SELECT_TRUST : 0)));
for (; j < n1 + n2 + n3; j++)
TEST_CHECK(srcs[j]->sel_options == sel_options);
break;
case SRC_AUTHSELECT_PREFER:
for (j = 0; j < n1 + n2; j++)
TEST_CHECK(srcs[j]->sel_options == sel_options);
for (; j < n1 + n2 + n3; j++)
TEST_CHECK(srcs[j]->sel_options == (sel_options | (n2 > 0 ? SRC_SELECT_NOSELECT : 0)));
break;
case SRC_AUTHSELECT_REQUIRE:
for (j = 0; j < n1 + n2; j++)
TEST_CHECK(srcs[j]->sel_options == sel_options);
for (; j < n1 + n2 + n3; j++)
TEST_CHECK(srcs[j]->sel_options == (sel_options | SRC_SELECT_NOSELECT));
break;
default:
assert(0);
}
for (j = n1 + n2 + n3; j < n1 + n2 + n3 + n4; j++)
TEST_CHECK(srcs[j]->sel_options == (sel_options | SRC_SELECT_NOSELECT));
for (j = n1 + n2 + n3 + n4 - 1; j >= 0; j--) {
if (j < n1 + n2)
TEST_CHECK(srcs[j]->sel_options == sel_options);
SRC_DestroyInstance(srcs[j]);
}
}
NSR_Finalise();
REF_Finalise();
SRC_Finalise();
SCH_Finalise();
LCL_Finalise();
CNF_Finalise();
HSH_Finalise();
}