Skip to content

P
PPSi
Commit d39aa5ee authored by Jean-Claude BAU's avatar Jean-Claude BAU
Browse files
Options

BMCA: new qualification algorithm 

Introduction of an other way to calculate the best foreign master. It
has been changed to fix bugs found during ISPC20119 (IOL test). Tests
showed unstable behavior in the computation of foreign master
qualification in some specific circumstances (time window of 8s with
announce messages every 5s)
parent 724ce5a3
Hide whitespace changes
Inline Side-by-side
Showing with 103 additions and 79 deletions
include/ppsi/diag-macros.h
View file @ d39aa5ee
......@@ -4,6 +4,7 @@
#define pp_error(...) pp_printf("ERROR: " __VA_ARGS__)
#define pp_info(...) pp_printf("INFO: " __VA_ARGS__)
/*
* The "new" diagnostics is based on flags: there are per-instance d_flags
......
include/ppsi/ieee1588_types.h
View file @ d39aa5ee
......@@ -260,6 +260,8 @@ typedef struct { /* page 68 */
ClockQuality grandmasterClockQuality;
UInteger8 grandmasterPriority1;
UInteger8 grandmasterPriority2;
/* Private data */
Boolean newGrandmaster;
} parentDS_t;
/* Port Data set */
......
include/ppsi/pp-instance.h
View file @ d39aa5ee
......@@ -77,9 +77,6 @@ struct pp_channel {
* it is called foreignMasterDS, see 9.3.2.4
*/
struct pp_frgn_master {
/* how many announce messages from this port where received in the
* interval */
UInteger16 foreignMasterAnnounceMessages[PP_FOREIGN_MASTER_TIME_WINDOW];
/* BMC related information */
UInteger16 sequenceId;
UInteger16 stepsRemoved;
......@@ -93,7 +90,11 @@ struct pp_frgn_master {
UInteger8 grandmasterPriority2;
Enumeration8 timeSource;
Octet flagField[2];
unsigned long ext_specific; /* used by extension */
/* Private data */
Boolean qualified; // TRUE if qualified
unsigned long lastAnnounceMsgMs; // Last time in ms when the announce message was received
/* used by extension */
unsigned long ext_specific;
};
/*
......@@ -259,6 +260,7 @@ struct pp_instance {
* messages */
UInteger16 frgn_rec_num;
Integer16 frgn_rec_best;
UInteger32 frgn_master_time_window_ms;
struct pp_frgn_master frgn_master[PP_NR_FOREIGN_RECORDS];
portDS_t *portDS; /* page 72 */
......
proto-standard/bmc.c
View file @ d39aa5ee
......@@ -137,6 +137,12 @@ void bmc_s1(struct pp_instance *ppi,
/* Current DS */
DSCUR(ppi)->stepsRemoved = frgn_master->stepsRemoved + 1;
/* Check if it is a new foreign master
* In this case the BMCA state machine must be informed
* to transition form SLAVE to UNCALIBRATED state.
*/
parent->newGrandmaster=bmc_pidcmp(&parent->parentPortIdentity,&frgn_master->sourcePortIdentity)!=0;
/* Parent DS */
parent->parentPortIdentity = frgn_master->sourcePortIdentity;
parent->grandmasterIdentity = frgn_master->grandmasterIdentity;
......@@ -297,9 +303,7 @@ static void bmc_setup_local_frgn_master(struct pp_instance *ppi,
if ( !is_externalPortConfigurationEnabled(DSDEF(ppi)) ) {
/* this shall be always qualified */
int i;
for (i = 0; i < PP_FOREIGN_MASTER_TIME_WINDOW; i++)
frgn_master->foreignMasterAnnounceMessages[i] = 1;
frgn_master->qualified=1;
}
memcpy(&frgn_master->receivePortIdentity,
&DSPOR(ppi)->portIdentity, sizeof(PortIdentity));
......@@ -355,19 +359,8 @@ static int is_ebest(struct pp_globals *ppg, struct pp_frgn_master *foreignMaster
return 0;
}
static int is_qualified(struct pp_instance *ppi, struct pp_frgn_master *foreignMaster) {
int i;
int qualified=0;
UInteger16 *annMsgs = foreignMaster->foreignMasterAnnounceMessages;
for (i = 0; i < PP_FOREIGN_MASTER_TIME_WINDOW; i++)
qualified += annMsgs[i];
qualified=qualified >= PP_FOREIGN_MASTER_THRESHOLD;
if ( !qualified )
qualified=is_ebest(GLBS(ppi),foreignMaster);
return qualified;
static __inline__ int is_qualified(struct pp_instance *ppi, struct pp_frgn_master *foreignMaster) {
return foreignMaster->qualified || is_ebest(GLBS(ppi),foreignMaster);
}
static int are_qualified(struct pp_instance *ppi,
......@@ -448,12 +441,13 @@ static int bmc_gm_cmp(struct pp_instance *ppi,
return a->grandmasterPriority2 - b->grandmasterPriority2;
}
pp_diag(ppi, bmc, 3, "GmId A: %02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x,\n"
"GmId B: %02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x\n",
a->grandmasterIdentity.id[0], a->grandmasterIdentity.id[1],
a->grandmasterIdentity.id[2], a->grandmasterIdentity.id[3],
a->grandmasterIdentity.id[4], a->grandmasterIdentity.id[5],
a->grandmasterIdentity.id[6], a->grandmasterIdentity.id[7],
pp_diag(ppi, bmc, 3, "GmId A: %02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x\n",
a->grandmasterIdentity.id[0], a->grandmasterIdentity.id[1],
a->grandmasterIdentity.id[2], a->grandmasterIdentity.id[3],
a->grandmasterIdentity.id[4], a->grandmasterIdentity.id[5],
a->grandmasterIdentity.id[6], a->grandmasterIdentity.id[7]);
pp_diag(ppi, bmc, 3, "GmId B: %02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x\n",
b->grandmasterIdentity.id[0], b->grandmasterIdentity.id[1],
b->grandmasterIdentity.id[2], b->grandmasterIdentity.id[3],
b->grandmasterIdentity.id[4], b->grandmasterIdentity.id[5],
......@@ -558,6 +552,17 @@ static int bmc_dataset_cmp(struct pp_instance *ppi,
{
/* dataset_cmp is called several times, so report only at level 2 */
pp_diag(ppi, bmc, 2, "%s\n", __func__);
pp_diag(ppi, bmc, 3, "portId A: %02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x\n",
a->sourcePortIdentity.clockIdentity.id[0], a->sourcePortIdentity.clockIdentity.id[1],
a->sourcePortIdentity.clockIdentity.id[2], a->sourcePortIdentity.clockIdentity.id[3],
a->sourcePortIdentity.clockIdentity.id[4], a->sourcePortIdentity.clockIdentity.id[5],
a->sourcePortIdentity.clockIdentity.id[6], a->sourcePortIdentity.clockIdentity.id[7]);
pp_diag(ppi, bmc, 3, "portId B: %02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x\n",
b->sourcePortIdentity.clockIdentity.id[0], b->sourcePortIdentity.clockIdentity.id[1],
b->sourcePortIdentity.clockIdentity.id[2], b->sourcePortIdentity.clockIdentity.id[3],
b->sourcePortIdentity.clockIdentity.id[4], b->sourcePortIdentity.clockIdentity.id[5],
b->sourcePortIdentity.clockIdentity.id[6], b->sourcePortIdentity.clockIdentity.id[7]);
if (!bmc_idcmp(&a->grandmasterIdentity, &b->grandmasterIdentity)) {
/* Check topology */
......@@ -821,17 +826,13 @@ slave_s1:
}
}
void bmc_store_frgn_master(struct pp_instance *ppi,
struct pp_frgn_master *frgn_master, void *buf, int len)
{
int i;
MsgHeader *hdr = &ppi->received_ptp_header;
MsgAnnounce ann;
/* clear qualification timeouts */
for (i = 0; i < PP_FOREIGN_MASTER_TIME_WINDOW; i++)
frgn_master->foreignMasterAnnounceMessages[i] = 0;
/*
* header and announce field of each Foreign Master are
* useful to run Best Master Clock Algorithm
......@@ -855,8 +856,11 @@ void bmc_store_frgn_master(struct pp_instance *ppi,
&ann.grandmasterIdentity, sizeof(ClockIdentity));
frgn_master->stepsRemoved = ann.stepsRemoved;
frgn_master->timeSource = ann.timeSource;
frgn_master->qualified=
frgn_master->lastAnnounceMsgMs=0;
}
void bmc_add_frgn_master(struct pp_instance *ppi, struct pp_frgn_master *frgn_master)
{
int sel;
......@@ -895,7 +899,7 @@ void bmc_add_frgn_master(struct pp_instance *ppi, struct pp_frgn_master *frgn_m
} else {
int cmpres;
int i, j, worst;
int i, worst;
struct pp_frgn_master worst_frgn_master;
struct pp_frgn_master temp_frgn_master;
if (get_numberPorts(DSDEF(ppi)) > 1) {
......@@ -948,20 +952,23 @@ void bmc_add_frgn_master(struct pp_instance *ppi, struct pp_frgn_master *frgn_m
{
if (!bmc_pidcmp(pid,
&ppi->frgn_master[i].sourcePortIdentity)) {
// Foreign master found
pp_diag(ppi, bmc, 2, "Foreign Master %i updated\n", i);
/* fill in number of announce received */
for (j = 0; j < PP_FOREIGN_MASTER_TIME_WINDOW; j++) {
frgn_master->foreignMasterAnnounceMessages[j] =
ppi->frgn_master[i].foreignMasterAnnounceMessages[j];
}
frgn_master->qualified=ppi->frgn_master[i].qualified;
frgn_master->lastAnnounceMsgMs=ppi->frgn_master[i].lastAnnounceMsgMs;
/* update the number of announce received if correct
* sequence number 9.3.2.5 b) */
if (hdr->sequenceId
== (ppi->frgn_master[i].sequenceId + 1))
frgn_master->foreignMasterAnnounceMessages[0]++;
if (hdr->sequenceId == (ppi->frgn_master[i].sequenceId + 1)) {
unsigned long now=TOPS(ppi)->calc_timeout(ppi, 0);
frgn_master->qualified=
(UInteger32)(now-frgn_master->lastAnnounceMsgMs)
<= ppi->frgn_master_time_window_ms;
frgn_master->lastAnnounceMsgMs=now;
}
/* already in Foreign master data set, update info */
memcpy(&ppi->frgn_master[i], frgn_master,
sizeof(struct pp_frgn_master));
......@@ -970,8 +977,7 @@ void bmc_add_frgn_master(struct pp_instance *ppi, struct pp_frgn_master *frgn_m
}
/* set qualification timeouts as valid to compare against worst*/
for (i = 0; i < PP_FOREIGN_MASTER_TIME_WINDOW; i++)
frgn_master->foreignMasterAnnounceMessages[i] = 1;
frgn_master->qualified=1;
/* New foreign master */
if ( !CONFIG_HAS_CODEOPT_SINGLE_FMASTER ) {
......@@ -989,10 +995,8 @@ void bmc_add_frgn_master(struct pp_instance *ppi, struct pp_frgn_master *frgn_m
sizeof(struct pp_frgn_master));
memcpy(&worst_frgn_master, &ppi->frgn_master[worst],
sizeof(struct pp_frgn_master));
for (j = 0; j < PP_FOREIGN_MASTER_TIME_WINDOW; j++) {
temp_frgn_master.foreignMasterAnnounceMessages[j] = 1;
worst_frgn_master.foreignMasterAnnounceMessages[j] = 1;
}
temp_frgn_master.qualified=
worst_frgn_master.qualified=1;
if (bmc_dataset_cmp(ppi, &temp_frgn_master,
&worst_frgn_master) > 0)
......@@ -1002,9 +1006,7 @@ void bmc_add_frgn_master(struct pp_instance *ppi, struct pp_frgn_master *frgn_m
/* copy the worst again and qualify it */
memcpy(&worst_frgn_master, &ppi->frgn_master[worst],
sizeof(struct pp_frgn_master));
for (i = 0; i < PP_FOREIGN_MASTER_TIME_WINDOW; i++) {
worst_frgn_master.foreignMasterAnnounceMessages[i] = 1;
}
worst_frgn_master.qualified=1;
/* check if worst is better than the new one, and skip the new
* one if so */
......@@ -1025,11 +1027,10 @@ void bmc_add_frgn_master(struct pp_instance *ppi, struct pp_frgn_master *frgn_m
}
/* clear qualification timeouts */
for (i = 0; i < PP_FOREIGN_MASTER_TIME_WINDOW; i++)
frgn_master->foreignMasterAnnounceMessages[i] = 0;
frgn_master->qualified=0;
/* This is the first one qualified 9.3.2.5 e)*/
frgn_master->foreignMasterAnnounceMessages[0] = 1;
frgn_master->lastAnnounceMsgMs=TOPS(ppi)->calc_timeout(ppi, 0);
}
/* Copy the temporary foreign master entry */
memcpy(&ppi->frgn_master[sel], frgn_master,
......@@ -1046,8 +1047,13 @@ static void bmc_flush_frgn_master(struct pp_instance *ppi)
ppi->frgn_rec_num = 0;
}
static void bmc_remove_foreign_master(struct pp_instance *ppi, int frg_master_idx) {
int i;
if ( ppi->frgn_rec_best == frg_master_idx ) {
ppi->frgn_rec_best=-1;
}
for (i = frg_master_idx; i < PP_NR_FOREIGN_RECORDS; i++) {
if (frg_master_idx < (ppi->frgn_rec_num-1)) {
/* overwrite and shift next foreign
......@@ -1055,6 +1061,8 @@ static void bmc_remove_foreign_master(struct pp_instance *ppi, int frg_master_id
memcpy(&ppi->frgn_master[i],
&ppi->frgn_master[i+1],
sizeof(struct pp_frgn_master));
if ( ppi->frgn_rec_best == (i+1) )
ppi->frgn_rec_best=i; // Re-adjust the erBest
} else {
/* clear the last (and others) since
* shifted */
......@@ -1075,39 +1083,29 @@ void bmc_flush_erbest(struct pp_instance *ppi)
bmc_remove_foreign_master(ppi,ppi->frgn_rec_best);
}
ppi->frgn_rec_best=-1;
}
static void bmc_age_frgn_master(struct pp_instance *ppi)
{
int i, j;
int qualified;
int i=0;
for (i=0;i < ppi->frgn_rec_num; i++)
{
/* get qualification */
if ( !(qualified=is_ebest(GLBS(ppi),&ppi->frgn_master[i])) ) {
for (j = 0; j < PP_FOREIGN_MASTER_TIME_WINDOW; j++)
qualified += ppi->frgn_master[i].foreignMasterAnnounceMessages[j];
}
unsigned long now=TOPS(ppi)->calc_timeout(ppi, 0);
/* shift qualification */
for (j = 1; j < PP_FOREIGN_MASTER_TIME_WINDOW; j++)
ppi->frgn_master[i].foreignMasterAnnounceMessages[
(PP_FOREIGN_MASTER_TIME_WINDOW - j)] =
ppi->frgn_master[i].foreignMasterAnnounceMessages[
(PP_FOREIGN_MASTER_TIME_WINDOW - j - 1)];
/* clear lowest */
ppi->frgn_master[i].foreignMasterAnnounceMessages[0] = 0;
/* remove aged out */
if ( !qualified ) {
pp_diag(ppi, bmc, 1, "Aged out foreign master %i/%i\n",
i, ppi->frgn_rec_num);
bmc_remove_foreign_master(ppi,i);
i--;
while (i < ppi->frgn_rec_num ) {
struct pp_frgn_master *frgn_master=&ppi->frgn_master[i];
/* get qualification */
if ( !is_ebest(GLBS(ppi),frgn_master) ) {
if ( (UInteger32)(now-frgn_master->lastAnnounceMsgMs)> ppi->frgn_master_time_window_ms ) {
// Remove age out
pp_diag(ppi, bmc, 1, "Aged out foreign master %i/%i\n",
i, ppi->frgn_rec_num);
bmc_remove_foreign_master(ppi,i);
continue;
}
}
i++;
}
}
......
proto-standard/state-initializing.c
View file @ d39aa5ee
......@@ -116,6 +116,9 @@ int pp_initializing(struct pp_instance *ppi, void *buf, int len)
pp_timeout_init(ppi);
pp_timeout_setall(ppi);
/* Foreign master time window */
ppi->frgn_master_time_window_ms= pp_timeout_log_to_ms(DSPOR(ppi)->logAnnounceInterval)*PP_FOREIGN_MASTER_TIME_WINDOW;
ppi->pdstate = PP_PDSTATE_NONE; // Default value for PTP. Can be overwritten in specific init
ppi->extState=(ppi->protocol_extension==PPSI_EXT_NONE) ? PP_EXSTATE_DISABLE : PP_EXSTATE_ACTIVE;
......
proto-standard/state-slave.c
View file @ d39aa5ee
......@@ -245,6 +245,7 @@ int pp_slave(struct pp_instance *ppi, void *buf, int len)
int ret = PP_SEND_OK; /* error var, to check errors in msg handling */
Boolean uncalibrated = (ppi->state == PPS_UNCALIBRATED);
MsgHeader *hdr = &ppi->received_ptp_header;
int newState=ppi->is_new_state;
/* upgrade from uncalibrated to slave or back*/
if (uncalibrated) {
......@@ -257,6 +258,23 @@ int pp_slave(struct pp_instance *ppi, void *buf, int len)
}
}
/* Check if the foreign master has changed */
if ( DSPAR(ppi)->newGrandmaster ) {
// New grandmaster detected
DSPAR(ppi)->newGrandmaster=FALSE; // Clear it
if ( !uncalibrated )
// State must transition from SLAVE to UNCALIBRATED
ppi->next_state =PPS_UNCALIBRATED;
else
newState=1;// If already in uncalibrated state, force to see it as a new state
Octet *id=DSPAR(ppi)->parentPortIdentity.clockIdentity.id;
pp_info("New grandmaster detected: %02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x\n",
id[0],id[1],id[2],id[3],id[4],id[5],id[6],id[7]);
}
/* Force to stay on desired state if externalPortConfiguration option is enabled */
if (is_externalPortConfigurationEnabled(DSDEF(ppi)) &&
ppi->next_state == PPS_SLAVE &&
......@@ -264,9 +282,9 @@ int pp_slave(struct pp_instance *ppi, void *buf, int len)
ppi->next_state = PPS_UNCALIBRATED; //Force to stay in uncalibrated state
/* when entering uncalibrated init servo */
if (uncalibrated && (ppi->is_new_state)) {
if (uncalibrated && newState) {
memset(&ppi->t1, 0, sizeof(ppi->t1));
pp_diag(ppi, bmc, 2, "Entered to uncalibrated, reset servo\n");
pp_diag(ppi, bmc, 2, "Entered to uncalibrated, reset servo\n");
pp_servo_init(ppi);
if (is_ext_hook_available(ppi,new_slave))
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment