networking/ntpd.c

   1 /*
   2  * NTP client/server, based on OpenNTPD 3.9p1
   3  *
   4  * Author: Adam Tkac <vonsch@gmail.com>
   5  *
   6  * Licensed under GPLv2, see file LICENSE in this tarball for details.
   7  *
   8  * Parts of OpenNTPD clock syncronization code is replaced by
   9  * code which is based on ntp-4.2.6, whuch carries the following
  10  * copyright notice:
  11  *
  12  ***********************************************************************
  13  *                                                                     *
  14  * Copyright (c) University of Delaware 1992-2009                      *
  15  *                                                                     *
  16  * Permission to use, copy, modify, and distribute this software and   *
  17  * its documentation for any purpose with or without fee is hereby     *
  18  * granted, provided that the above copyright notice appears in all    *
  19  * copies and that both the copyright notice and this permission       *
  20  * notice appear in supporting documentation, and that the name        *
  21  * University of Delaware not be used in advertising or publicity      *
  22  * pertaining to distribution of the software without specific,        *
  23  * written prior permission. The University of Delaware makes no       *
  24  * representations about the suitability this software for any         *
  25  * purpose. It is provided "as is" without express or implied          *
  26  * warranty.                                                           *
  27  *                                                                     *
  28  ***********************************************************************
  29  */
  30 #include "libbb.h"
  31 #include <math.h>
  32 #include <netinet/ip.h> /* For IPTOS_LOWDELAY definition */
  33 #include <sys/timex.h>
  34 #ifndef IPTOS_LOWDELAY
  35 # define IPTOS_LOWDELAY 0x10
  36 #endif
  37 #ifndef IP_PKTINFO
  38 # error "Sorry, your kernel has to support IP_PKTINFO"
  39 #endif
  40
  41
  42 /* Verbosity control (max level of -dddd options accepted).
  43  * max 5 is very talkative (and bloated). 2 is non-bloated,
  44  * production level setting.
  45  */
  46 #define MAX_VERBOSE     2
  47
  48
  49 /* High-level description of the algorithm:
  50  *
  51  * We start running with very small poll_exp, BURSTPOLL,
  52  * in order to quickly accumulate INITIAL_SAMLPES datapoints
  53  * for each peer. Then, time is stepped if the offset is larger
  54  * than STEP_THRESHOLD, otherwise it isn't; anyway, we enlarge
  55  * poll_exp to MINPOLL and enter frequency measurement step:
  56  * we collect new datapoints but ignore them for WATCH_THRESHOLD
  57  * seconds. After WATCH_THRESHOLD seconds we look at accumulated
  58  * offset and estimate frequency drift.
  59  *
  60  * (frequency measurement step seems to not be strictly needed,
  61  * it is conditionally disabled with USING_INITIAL_FREQ_ESTIMATION
  62  * define set to 0)
  63  *
  64  * After this, we enter "steady state": we collect a datapoint,
  65  * we select the best peer, if this datapoint is not a new one
  66  * (IOW: if this datapoint isn't for selected peer), sleep
  67  * and collect another one; otherwise, use its offset to update
  68  * frequency drift, if offset is somewhat large, reduce poll_exp,
  69  * otherwise increase poll_exp.
  70  *
  71  * If offset is larger than STEP_THRESHOLD, which shouldn't normally
  72  * happen, we assume that something "bad" happened (computer
  73  * was hibernated, someone set totally wrong date, etc),
  74  * then the time is stepped, all datapoints are discarded,
  75  * and we go back to steady state.
  76  */
  77
  78 #define RETRY_INTERVAL  5       /* on error, retry in N secs */
  79 #define RESPONSE_INTERVAL 15    /* wait for reply up to N secs */
  80 #define INITIAL_SAMLPES 4       /* how many samples do we want for init */
  81
  82 /* Clock discipline parameters and constants */
  83
  84 /* Step threshold (sec). std ntpd uses 0.128.
  85  * Using exact power of 2 (1/8) results in smaller code */
  86 #define STEP_THRESHOLD  0.125
  87 #define WATCH_THRESHOLD 128     /* stepout threshold (sec). std ntpd uses 900 (11 mins (!)) */
  88 /* NB: set WATCH_THRESHOLD to ~60 when debugging to save time) */
  89 //UNUSED: #define PANIC_THRESHOLD 1000    /* panic threshold (sec) */
  90
  91 #define FREQ_TOLERANCE  0.000015 /* frequency tolerance (15 PPM) */
  92 #define BURSTPOLL       0       /* initial poll */
  93 #define MINPOLL         5       /* minimum poll interval. std ntpd uses 6 (6: 64 sec) */
  94 #define BIGPOLL         10      /* drop to lower poll at any trouble (10: 17 min) */
  95 #define MAXPOLL         12      /* maximum poll interval (12: 1.1h, 17: 36.4h). std ntpd uses 17 */
  96 /* Actively lower poll when we see such big offsets.
  97  * With STEP_THRESHOLD = 0.125, it means we try to sync more aggressively
  98  * if offset increases over 0.03 sec */
  99 #define POLLDOWN_OFFSET (STEP_THRESHOLD / 4)
 100 #define MINDISP         0.01    /* minimum dispersion (sec) */
 101 #define MAXDISP         16      /* maximum dispersion (sec) */
 102 #define MAXSTRAT        16      /* maximum stratum (infinity metric) */
 103 #define MAXDIST         1       /* distance threshold (sec) */
 104 #define MIN_SELECTED    1       /* minimum intersection survivors */
 105 #define MIN_CLUSTERED   3       /* minimum cluster survivors */
 106
 107 #define MAXDRIFT        0.000500 /* frequency drift we can correct (500 PPM) */
 108
 109 /* Poll-adjust threshold.
 110  * When we see that offset is small enough compared to discipline jitter,
 111  * we grow a counter: += MINPOLL. When it goes over POLLADJ_LIMIT,
 112  * we poll_exp++. If offset isn't small, counter -= poll_exp*2,
 113  * and when it goes below -POLLADJ_LIMIT, we poll_exp--
 114  * (bumped from 30 to 36 since otherwise I often see poll_exp going *2* steps down)
 115  */
 116 #define POLLADJ_LIMIT   36
 117 /* If offset < POLLADJ_GATE * discipline_jitter, then we can increase
 118  * poll interval (we think we can't improve timekeeping
 119  * by staying at smaller poll).
 120  */
 121 #define POLLADJ_GATE    4
 122 /* Compromise Allan intercept (sec). doc uses 1500, std ntpd uses 512 */
 123 #define ALLAN           512
 124 /* PLL loop gain */
 125 #define PLL             65536
 126 /* FLL loop gain [why it depends on MAXPOLL??] */
 127 #define FLL             (MAXPOLL + 1)
 128 /* Parameter averaging constant */
 129 #define AVG             4
 130
 131
 132 enum {
 133         NTP_VERSION     = 4,
 134         NTP_MAXSTRATUM  = 15,
 135
 136         NTP_DIGESTSIZE     = 16,
 137         NTP_MSGSIZE_NOAUTH = 48,
 138         NTP_MSGSIZE        = (NTP_MSGSIZE_NOAUTH + 4 + NTP_DIGESTSIZE),
 139
 140         /* Status Masks */
 141         MODE_MASK       = (7 << 0),
 142         VERSION_MASK    = (7 << 3),
 143         VERSION_SHIFT   = 3,
 144         LI_MASK         = (3 << 6),
 145
 146         /* Leap Second Codes (high order two bits of m_status) */
 147         LI_NOWARNING    = (0 << 6),    /* no warning */
 148         LI_PLUSSEC      = (1 << 6),    /* add a second (61 seconds) */
 149         LI_MINUSSEC     = (2 << 6),    /* minus a second (59 seconds) */
 150         LI_ALARM        = (3 << 6),    /* alarm condition */
 151
 152         /* Mode values */
 153         MODE_RES0       = 0,    /* reserved */
 154         MODE_SYM_ACT    = 1,    /* symmetric active */
 155         MODE_SYM_PAS    = 2,    /* symmetric passive */
 156         MODE_CLIENT     = 3,    /* client */
 157         MODE_SERVER     = 4,    /* server */
 158         MODE_BROADCAST  = 5,    /* broadcast */
 159         MODE_RES1       = 6,    /* reserved for NTP control message */
 160         MODE_RES2       = 7,    /* reserved for private use */
 161 };
 162
 163 //TODO: better base selection
 164 #define OFFSET_1900_1970 2208988800UL  /* 1970 - 1900 in seconds */
 165
 166 #define NUM_DATAPOINTS  8
 167
 168 typedef struct {
 169         uint32_t int_partl;
 170         uint32_t fractionl;
 171 } l_fixedpt_t;
 172
 173 typedef struct {
 174         uint16_t int_parts;
 175         uint16_t fractions;
 176 } s_fixedpt_t;
 177
 178 typedef struct {
 179         uint8_t     m_status;     /* status of local clock and leap info */
 180         uint8_t     m_stratum;
 181         uint8_t     m_ppoll;      /* poll value */
 182         int8_t      m_precision_exp;
 183         s_fixedpt_t m_rootdelay;
 184         s_fixedpt_t m_rootdisp;
 185         uint32_t    m_refid;
 186         l_fixedpt_t m_reftime;
 187         l_fixedpt_t m_orgtime;
 188         l_fixedpt_t m_rectime;
 189         l_fixedpt_t m_xmttime;
 190         uint32_t    m_keyid;
 191         uint8_t     m_digest[NTP_DIGESTSIZE];
 192 } msg_t;
 193
 194 typedef struct {
 195         double d_recv_time;
 196         double d_offset;
 197         double d_dispersion;
 198 } datapoint_t;
 199
 200 typedef struct {
 201         len_and_sockaddr *p_lsa;
 202         char             *p_dotted;
 203         /* when to send new query (if p_fd == -1)
 204          * or when receive times out (if p_fd >= 0): */
 205         int              p_fd;
 206         int              datapoint_idx;
 207         uint32_t         lastpkt_refid;
 208         uint8_t          lastpkt_status;
 209         uint8_t          lastpkt_stratum;
 210         uint8_t          reachable_bits;
 211         double           next_action_time;
 212         double           p_xmttime;
 213         double           lastpkt_recv_time;
 214         double           lastpkt_delay;
 215         double           lastpkt_rootdelay;
 216         double           lastpkt_rootdisp;
 217         /* produced by filter algorithm: */
 218         double           filter_offset;
 219         double           filter_dispersion;
 220         double           filter_jitter;
 221         datapoint_t      filter_datapoint[NUM_DATAPOINTS];
 222         /* last sent packet: */
 223         msg_t            p_xmt_msg;
 224 } peer_t;
 225
 226
 227 #define USING_KERNEL_PLL_LOOP          1
 228 #define USING_INITIAL_FREQ_ESTIMATION  0
 229
 230 enum {
 231         OPT_n = (1 << 0),
 232         OPT_q = (1 << 1),
 233         OPT_N = (1 << 2),
 234         OPT_x = (1 << 3),
 235         /* Insert new options above this line. */
 236         /* Non-compat options: */
 237         OPT_w = (1 << 4),
 238         OPT_p = (1 << 5),
 239         OPT_S = (1 << 6),
 240         OPT_l = (1 << 7) * ENABLE_FEATURE_NTPD_SERVER,
 241 };
 242
 243 struct globals {
 244         double   cur_time;
 245         /* total round trip delay to currently selected reference clock */
 246         double   rootdelay;
 247         /* reference timestamp: time when the system clock was last set or corrected */
 248         double   reftime;
 249         /* total dispersion to currently selected reference clock */
 250         double   rootdisp;
 251
 252         double   last_script_run;
 253         char     *script_name;
 254         llist_t  *ntp_peers;
 255 #if ENABLE_FEATURE_NTPD_SERVER
 256         int      listen_fd;
 257 #endif
 258         unsigned verbose;
 259         unsigned peer_cnt;
 260         /* refid: 32-bit code identifying the particular server or reference clock
 261          *  in stratum 0 packets this is a four-character ASCII string,
 262          *  called the kiss code, used for debugging and monitoring
 263          *  in stratum 1 packets this is a four-character ASCII string
 264          *  assigned to the reference clock by IANA. Example: "GPS "
 265          *  in stratum 2+ packets, it's IPv4 address or 4 first bytes of MD5 hash of IPv6
 266          */
 267         uint32_t refid;
 268         uint8_t  ntp_status;
 269         /* precision is defined as the larger of the resolution and time to
 270          * read the clock, in log2 units.  For instance, the precision of a
 271          * mains-frequency clock incrementing at 60 Hz is 16 ms, even when the
 272          * system clock hardware representation is to the nanosecond.
 273          *
 274          * Delays, jitters of various kinds are clamper down to precision.
 275          *
 276          * If precision_sec is too large, discipline_jitter gets clamped to it
 277          * and if offset is much smaller than discipline_jitter, poll interval
 278          * grows even though we really can benefit from staying at smaller one,
 279          * collecting non-lagged datapoits and correcting the offset.
 280          * (Lagged datapoits exist when poll_exp is large but we still have
 281          * systematic offset error - the time distance between datapoints
 282          * is significat and older datapoints have smaller offsets.
 283          * This makes our offset estimation a bit smaller than reality)
 284          * Due to this effect, setting G_precision_sec close to
 285          * STEP_THRESHOLD isn't such a good idea - offsets may grow
 286          * too big and we will step. I observed it with -6.
 287          *
 288          * OTOH, setting precision too small would result in futile attempts
 289          * to syncronize to the unachievable precision.
 290          *
 291          * -6 is 1/64 sec, -7 is 1/128 sec and so on.
 292          */
 293 #define G_precision_exp  -8
 294 #define G_precision_sec  (1.0 / (1 << (- G_precision_exp)))
 295         uint8_t  stratum;
 296         /* Bool. After set to 1, never goes back to 0: */
 297         smallint initial_poll_complete;
 298
 299 #define STATE_NSET      0       /* initial state, "nothing is set" */
 300 //#define STATE_FSET    1       /* frequency set from file */
 301 #define STATE_SPIK      2       /* spike detected */
 302 //#define STATE_FREQ    3       /* initial frequency */
 303 #define STATE_SYNC      4       /* clock synchronized (normal operation) */
 304         uint8_t  discipline_state;      // doc calls it c.state
 305         uint8_t  poll_exp;              // s.poll
 306         int      polladj_count;         // c.count
 307         long     kernel_freq_drift;
 308         peer_t   *last_update_peer;
 309         double   last_update_offset;    // c.last
 310         double   last_update_recv_time; // s.t
 311         double   discipline_jitter;     // c.jitter
 312         //double   cluster_offset;        // s.offset
 313         //double   cluster_jitter;        // s.jitter
 314 #if !USING_KERNEL_PLL_LOOP
 315         double   discipline_freq_drift; // c.freq
 316         /* Maybe conditionally calculate wander? it's used only for logging */
 317         double   discipline_wander;     // c.wander
 318 #endif
 319 };
 320 #define G (*ptr_to_globals)
 321
 322 static const int const_IPTOS_LOWDELAY = IPTOS_LOWDELAY;
 323
 324
 325 #define VERB1 if (MAX_VERBOSE && G.verbose)
 326 #define VERB2 if (MAX_VERBOSE >= 2 && G.verbose >= 2)
 327 #define VERB3 if (MAX_VERBOSE >= 3 && G.verbose >= 3)
 328 #define VERB4 if (MAX_VERBOSE >= 4 && G.verbose >= 4)
 329 #define VERB5 if (MAX_VERBOSE >= 5 && G.verbose >= 5)
 330
 331
 332 static double LOG2D(int a)
 333 {
 334         if (a < 0)
 335                 return 1.0 / (1UL << -a);
 336         return 1UL << a;
 337 }
 338 static ALWAYS_INLINE double SQUARE(double x)
 339 {
 340         return x * x;
 341 }
 342 static ALWAYS_INLINE double MAXD(double a, double b)
 343 {
 344         if (a > b)
 345                 return a;
 346         return b;
 347 }
 348 static ALWAYS_INLINE double MIND(double a, double b)
 349 {
 350         if (a < b)
 351                 return a;
 352         return b;
 353 }
 354 static NOINLINE double my_SQRT(double X)
 355 {
 356         union {
 357                 float   f;
 358                 int32_t i;
 359         } v;
 360         double invsqrt;
 361         double Xhalf = X * 0.5;
 362
 363         /* Fast and good approximation to 1/sqrt(X), black magic */
 364         v.f = X;
 365         /*v.i = 0x5f3759df - (v.i >> 1);*/
 366         v.i = 0x5f375a86 - (v.i >> 1); /* - this constant is slightly better */
 367         invsqrt = v.f; /* better than 0.2% accuracy */
 368
 369         /* Refining it using Newton's method: x1 = x0 - f(x0)/f'(x0)
 370          * f(x) = 1/(x*x) - X  (f==0 when x = 1/sqrt(X))
 371          * f'(x) = -2/(x*x*x)
 372          * f(x)/f'(x) = (X - 1/(x*x)) / (2/(x*x*x)) = X*x*x*x/2 - x/2
 373          * x1 = x0 - (X*x0*x0*x0/2 - x0/2) = 1.5*x0 - X*x0*x0*x0/2 = x0*(1.5 - (X/2)*x0*x0)
 374          */
 375         invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); /* ~0.05% accuracy */
 376         /* invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); 2nd iter: ~0.0001% accuracy */
 377         /* With 4 iterations, more than half results will be exact,
 378          * at 6th iterations result stabilizes with about 72% results exact.
 379          * We are well satisfied with 0.05% accuracy.
 380          */
 381
 382         return X * invsqrt; /* X * 1/sqrt(X) ~= sqrt(X) */
 383 }
 384 static ALWAYS_INLINE double SQRT(double X)
 385 {
 386         /* If this arch doesn't use IEEE 754 floats, fall back to using libm */
 387         if (sizeof(float) != 4)
 388                 return sqrt(X);
 389
 390         /* This avoids needing libm, saves about 0.5k on x86-32 */
 391         return my_SQRT(X);
 392 }
 393
 394 static double
 395 gettime1900d(void)
 396 {
 397         struct timeval tv;
 398         gettimeofday(&tv, NULL); /* never fails */
 399         G.cur_time = tv.tv_sec + (1.0e-6 * tv.tv_usec) + OFFSET_1900_1970;
 400         return G.cur_time;
 401 }
 402
 403 static void
 404 d_to_tv(double d, struct timeval *tv)
 405 {
 406         tv->tv_sec = (long)d;
 407         tv->tv_usec = (d - tv->tv_sec) * 1000000;
 408 }
 409
 410 static double
 411 lfp_to_d(l_fixedpt_t lfp)
 412 {
 413         double ret;
 414         lfp.int_partl = ntohl(lfp.int_partl);
 415         lfp.fractionl = ntohl(lfp.fractionl);
 416         ret = (double)lfp.int_partl + ((double)lfp.fractionl / UINT_MAX);
 417         return ret;
 418 }
 419 static double
 420 sfp_to_d(s_fixedpt_t sfp)
 421 {
 422         double ret;
 423         sfp.int_parts = ntohs(sfp.int_parts);
 424         sfp.fractions = ntohs(sfp.fractions);
 425         ret = (double)sfp.int_parts + ((double)sfp.fractions / USHRT_MAX);
 426         return ret;
 427 }
 428 #if ENABLE_FEATURE_NTPD_SERVER
 429 static l_fixedpt_t
 430 d_to_lfp(double d)
 431 {
 432         l_fixedpt_t lfp;
 433         lfp.int_partl = (uint32_t)d;
 434         lfp.fractionl = (uint32_t)((d - lfp.int_partl) * UINT_MAX);
 435         lfp.int_partl = htonl(lfp.int_partl);
 436         lfp.fractionl = htonl(lfp.fractionl);
 437         return lfp;
 438 }
 439 static s_fixedpt_t
 440 d_to_sfp(double d)
 441 {
 442         s_fixedpt_t sfp;
 443         sfp.int_parts = (uint16_t)d;
 444         sfp.fractions = (uint16_t)((d - sfp.int_parts) * USHRT_MAX);
 445         sfp.int_parts = htons(sfp.int_parts);
 446         sfp.fractions = htons(sfp.fractions);
 447         return sfp;
 448 }
 449 #endif
 450
 451 static double
 452 dispersion(const datapoint_t *dp)
 453 {
 454         return dp->d_dispersion + FREQ_TOLERANCE * (G.cur_time - dp->d_recv_time);
 455 }
 456
 457 static double
 458 root_distance(peer_t *p)
 459 {
 460         /* The root synchronization distance is the maximum error due to
 461          * all causes of the local clock relative to the primary server.
 462          * It is defined as half the total delay plus total dispersion
 463          * plus peer jitter.
 464          */
 465         return MAXD(MINDISP, p->lastpkt_rootdelay + p->lastpkt_delay) / 2
 466                 + p->lastpkt_rootdisp
 467                 + p->filter_dispersion
 468                 + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time)
 469                 + p->filter_jitter;
 470 }
 471
 472 static void
 473 set_next(peer_t *p, unsigned t)
 474 {
 475         p->next_action_time = G.cur_time + t;
 476 }
 477
 478 /*
 479  * Peer clock filter and its helpers
 480  */
 481 static void
 482 filter_datapoints(peer_t *p)
 483 {
 484         int i, idx;
 485         int got_newest;
 486         double minoff, maxoff, wavg, sum, w;
 487         double x = x; /* for compiler */
 488         double oldest_off = oldest_off;
 489         double oldest_age = oldest_age;
 490         double newest_off = newest_off;
 491         double newest_age = newest_age;
 492
 493         minoff = maxoff = p->filter_datapoint[0].d_offset;
 494         for (i = 1; i < NUM_DATAPOINTS; i++) {
 495                 if (minoff > p->filter_datapoint[i].d_offset)
 496                         minoff = p->filter_datapoint[i].d_offset;
 497                 if (maxoff < p->filter_datapoint[i].d_offset)
 498                         maxoff = p->filter_datapoint[i].d_offset;
 499         }
 500
 501         idx = p->datapoint_idx; /* most recent datapoint */
 502         /* Average offset:
 503          * Drop two outliers and take weighted average of the rest:
 504          * most_recent/2 + older1/4 + older2/8 ... + older5/32 + older6/32
 505          * we use older6/32, not older6/64 since sum of weights should be 1:
 506          * 1/2 + 1/4 + 1/8 + 1/16 + 1/32 + 1/32 = 1
 507          */
 508         wavg = 0;
 509         w = 0.5;
 510         /*                     n-1
 511          *                     ---    dispersion(i)
 512          * filter_dispersion =  \     -------------
 513          *                      /       (i+1)
 514          *                     ---     2
 515          *                     i=0
 516          */
 517         got_newest = 0;
 518         sum = 0;
 519         for (i = 0; i < NUM_DATAPOINTS; i++) {
 520                 VERB4 {
 521                         bb_error_msg("datapoint[%d]: off:%f disp:%f(%f) age:%f%s",
 522                                 i,
 523                                 p->filter_datapoint[idx].d_offset,
 524                                 p->filter_datapoint[idx].d_dispersion, dispersion(&p->filter_datapoint[idx]),
 525                                 G.cur_time - p->filter_datapoint[idx].d_recv_time,
 526                                 (minoff == p->filter_datapoint[idx].d_offset || maxoff == p->filter_datapoint[idx].d_offset)
 527                                         ? " (outlier by offset)" : ""
 528                         );
 529                 }
 530
 531                 sum += dispersion(&p->filter_datapoint[idx]) / (2 << i);
 532
 533                 if (minoff == p->filter_datapoint[idx].d_offset) {
 534                         minoff -= 1; /* so that we don't match it ever again */
 535                 } else
 536                 if (maxoff == p->filter_datapoint[idx].d_offset) {
 537                         maxoff += 1;
 538                 } else {
 539                         oldest_off = p->filter_datapoint[idx].d_offset;
 540                         oldest_age = G.cur_time - p->filter_datapoint[idx].d_recv_time;
 541                         if (!got_newest) {
 542                                 got_newest = 1;
 543                                 newest_off = oldest_off;
 544                                 newest_age = oldest_age;
 545                         }
 546                         x = oldest_off * w;
 547                         wavg += x;
 548                         w /= 2;
 549                 }
 550
 551                 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
 552         }
 553         p->filter_dispersion = sum;
 554         wavg += x; /* add another older6/64 to form older6/32 */
 555         /* Fix systematic underestimation with large poll intervals.
 556          * Imagine that we still have a bit of uncorrected drift,
 557          * and poll interval is big (say, 100 sec). Offsets form a progression:
 558          * 0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 - 0.7 is most recent.
 559          * The algorithm above drops 0.0 and 0.7 as outliers,
 560          * and then we have this estimation, ~25% off from 0.7:
 561          * 0.1/32 + 0.2/32 + 0.3/16 + 0.4/8 + 0.5/4 + 0.6/2 = 0.503125
 562          */
 563         x = oldest_age - newest_age;
 564         if (x != 0) {
 565                 x = newest_age / x; /* in above example, 100 / (600 - 100) */
 566                 if (x < 1) { /* paranoia check */
 567                         x = (newest_off - oldest_off) * x; /* 0.5 * 100/500 = 0.1 */
 568                         wavg += x;
 569                 }
 570         }
 571         p->filter_offset = wavg;
 572
 573         /*                  +-----                 -----+ ^ 1/2
 574          *                  |       n-1                 |
 575          *                  |       ---                 |
 576          *                  |  1    \                2  |
 577          * filter_jitter =  | --- * /  (avg-offset_j)   |
 578          *                  |  n    ---                 |
 579          *                  |       j=0                 |
 580          *                  +-----                 -----+
 581          * where n is the number of valid datapoints in the filter (n > 1);
 582          * if filter_jitter < precision then filter_jitter = precision
 583          */
 584         sum = 0;
 585         for (i = 0; i < NUM_DATAPOINTS; i++) {
 586                 sum += SQUARE(wavg - p->filter_datapoint[i].d_offset);
 587         }
 588         sum = SQRT(sum / NUM_DATAPOINTS);
 589         p->filter_jitter = sum > G_precision_sec ? sum : G_precision_sec;
 590
 591         VERB3 bb_error_msg("filter offset:%f(corr:%e) disp:%f jitter:%f",
 592                         p->filter_offset, x,
 593                         p->filter_dispersion,
 594                         p->filter_jitter);
 595
 596 }
 597
 598 static void
 599 reset_peer_stats(peer_t *p, double offset)
 600 {
 601         int i;
 602         bool small_ofs = fabs(offset) < 16 * STEP_THRESHOLD;
 603
 604         for (i = 0; i < NUM_DATAPOINTS; i++) {
 605                 if (small_ofs) {
 606                         p->filter_datapoint[i].d_recv_time -= offset;
 607                         if (p->filter_datapoint[i].d_offset != 0) {
 608                                 p->filter_datapoint[i].d_offset -= offset;
 609                         }
 610                 } else {
 611                         p->filter_datapoint[i].d_recv_time  = G.cur_time;
 612                         p->filter_datapoint[i].d_offset     = 0;
 613                         p->filter_datapoint[i].d_dispersion = MAXDISP;
 614                 }
 615         }
 616         if (small_ofs) {
 617                 p->lastpkt_recv_time -= offset;
 618         } else {
 619                 p->reachable_bits = 0;
 620                 p->lastpkt_recv_time = G.cur_time;
 621         }
 622         filter_datapoints(p); /* recalc p->filter_xxx */
 623         p->next_action_time -= offset;
 624         VERB5 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
 625 }
 626
 627 static void
 628 add_peers(char *s)
 629 {
 630         peer_t *p;
 631
 632         p = xzalloc(sizeof(*p));
 633         p->p_lsa = xhost2sockaddr(s, 123);
 634         p->p_dotted = xmalloc_sockaddr2dotted_noport(&p->p_lsa->u.sa);
 635         p->p_fd = -1;
 636         p->p_xmt_msg.m_status = MODE_CLIENT | (NTP_VERSION << 3);
 637         p->next_action_time = G.cur_time; /* = set_next(p, 0); */
 638         reset_peer_stats(p, 16 * STEP_THRESHOLD);
 639
 640         llist_add_to(&G.ntp_peers, p);
 641         G.peer_cnt++;
 642 }
 643
 644 static int
 645 do_sendto(int fd,
 646                 const struct sockaddr *from, const struct sockaddr *to, socklen_t addrlen,
 647                 msg_t *msg, ssize_t len)
 648 {
 649         ssize_t ret;
 650
 651         errno = 0;
 652         if (!from) {
 653                 ret = sendto(fd, msg, len, MSG_DONTWAIT, to, addrlen);
 654         } else {
 655                 ret = send_to_from(fd, msg, len, MSG_DONTWAIT, to, from, addrlen);
 656         }
 657         if (ret != len) {
 658                 bb_perror_msg("send failed");
 659                 return -1;
 660         }
 661         return 0;
 662 }
 663
 664 static void
 665 send_query_to_peer(peer_t *p)
 666 {
 667         /* Why do we need to bind()?
 668          * See what happens when we don't bind:
 669          *
 670          * socket(PF_INET, SOCK_DGRAM, IPPROTO_IP) = 3
 671          * setsockopt(3, SOL_IP, IP_TOS, [16], 4) = 0
 672          * gettimeofday({1259071266, 327885}, NULL) = 0
 673          * sendto(3, "xxx", 48, MSG_DONTWAIT, {sa_family=AF_INET, sin_port=htons(123), sin_addr=inet_addr("10.34.32.125")}, 16) = 48
 674          * ^^^ we sent it from some source port picked by kernel.
 675          * time(NULL)              = 1259071266
 676          * write(2, "ntpd: entering poll 15 secs\n", 28) = 28
 677          * poll([{fd=3, events=POLLIN}], 1, 15000) = 1 ([{fd=3, revents=POLLIN}])
 678          * recv(3, "yyy", 68, MSG_DONTWAIT) = 48
 679          * ^^^ this recv will receive packets to any local port!
 680          *
 681          * Uncomment this and use strace to see it in action:
 682          */
 683 #define PROBE_LOCAL_ADDR /* { len_and_sockaddr lsa; lsa.len = LSA_SIZEOF_SA; getsockname(p->query.fd, &lsa.u.sa, &lsa.len); } */
 684
 685         if (p->p_fd == -1) {
 686                 int fd, family;
 687                 len_and_sockaddr *local_lsa;
 688
 689                 family = p->p_lsa->u.sa.sa_family;
 690                 p->p_fd = fd = xsocket_type(&local_lsa, family, SOCK_DGRAM);
 691                 /* local_lsa has "null" address and port 0 now.
 692                  * bind() ensures we have a *particular port* selected by kernel
 693                  * and remembered in p->p_fd, thus later recv(p->p_fd)
 694                  * receives only packets sent to this port.
 695                  */
 696                 PROBE_LOCAL_ADDR
 697                 xbind(fd, &local_lsa->u.sa, local_lsa->len);
 698                 PROBE_LOCAL_ADDR
 699 #if ENABLE_FEATURE_IPV6
 700                 if (family == AF_INET)
 701 #endif
 702                         setsockopt(fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
 703                 free(local_lsa);
 704         }
 705
 706         /*
 707          * Send out a random 64-bit number as our transmit time.  The NTP
 708          * server will copy said number into the originate field on the
 709          * response that it sends us.  This is totally legal per the SNTP spec.
 710          *
 711          * The impact of this is two fold: we no longer send out the current
 712          * system time for the world to see (which may aid an attacker), and
 713          * it gives us a (not very secure) way of knowing that we're not
 714          * getting spoofed by an attacker that can't capture our traffic
 715          * but can spoof packets from the NTP server we're communicating with.
 716          *
 717          * Save the real transmit timestamp locally.
 718          */
 719         p->p_xmt_msg.m_xmttime.int_partl = random();
 720         p->p_xmt_msg.m_xmttime.fractionl = random();
 721         p->p_xmttime = gettime1900d();
 722
 723         if (do_sendto(p->p_fd, /*from:*/ NULL, /*to:*/ &p->p_lsa->u.sa, /*addrlen:*/ p->p_lsa->len,
 724                         &p->p_xmt_msg, NTP_MSGSIZE_NOAUTH) == -1
 725         ) {
 726                 close(p->p_fd);
 727                 p->p_fd = -1;
 728                 set_next(p, RETRY_INTERVAL);
 729                 return;
 730         }
 731
 732         p->reachable_bits <<= 1;
 733         VERB1 bb_error_msg("sent query to %s", p->p_dotted);
 734         set_next(p, RESPONSE_INTERVAL);
 735 }
 736
 737
 738 static void run_script(const char *action, double offset)
 739 {
 740         char *argv[3];
 741         char *env1, *env2, *env3, *env4;
 742
 743         if (!G.script_name)
 744                 return;
 745
 746         argv[0] = (char*) G.script_name;
 747         argv[1] = (char*) action;
 748         argv[2] = NULL;
 749
 750         VERB1 bb_error_msg("executing '%s %s'", G.script_name, action);
 751
 752         env1 = xasprintf("%s=%u", "stratum", G.stratum);
 753         putenv(env1);
 754         env2 = xasprintf("%s=%ld", "freq_drift_ppm", G.kernel_freq_drift);
 755         putenv(env2);
 756         env3 = xasprintf("%s=%u", "poll_interval", 1 << G.poll_exp);
 757         putenv(env3);
 758         env4 = xasprintf("%s=%f", "offset", offset);
 759         putenv(env4);
 760         /* Other items of potential interest: selected peer,
 761          * rootdelay, reftime, rootdisp, refid, ntp_status,
 762          * last_update_offset, last_update_recv_time, discipline_jitter,
 763          * how many peers have reachable_bits = 0?
 764          */
 765
 766         /* Don't want to wait: it may run hwclock --systohc, and that
 767          * may take some time (seconds): */
 768         /*wait4pid(spawn(argv));*/
 769         spawn(argv);
 770
 771         unsetenv("stratum");
 772         unsetenv("freq_drift_ppm");
 773         unsetenv("poll_interval");
 774         unsetenv("offset");
 775         free(env1);
 776         free(env2);
 777         free(env3);
 778         free(env4);
 779
 780         G.last_script_run = G.cur_time;
 781 }
 782
 783 static NOINLINE void
 784 step_time(double offset)
 785 {
 786         llist_t *item;
 787         double dtime;
 788         struct timeval tv;
 789         char buf[80];
 790         time_t tval;
 791
 792         gettimeofday(&tv, NULL); /* never fails */
 793         dtime = offset + tv.tv_sec;
 794         dtime += 1.0e-6 * tv.tv_usec;
 795         d_to_tv(dtime, &tv);
 796
 797         if (settimeofday(&tv, NULL) == -1)
 798                 bb_perror_msg_and_die("settimeofday");
 799
 800         tval = tv.tv_sec;
 801         strftime(buf, sizeof(buf), "%a %b %e %H:%M:%S %Z %Y", localtime(&tval));
 802
 803         bb_error_msg("setting clock to %s (offset %fs)", buf, offset);
 804
 805         /* Correct various fields which contain time-relative values: */
 806
 807         /* p->lastpkt_recv_time, p->next_action_time and such: */
 808         for (item = G.ntp_peers; item != NULL; item = item->link) {
 809                 peer_t *pp = (peer_t *) item->data;
 810                 reset_peer_stats(pp, offset);
 811         }
 812         /* Globals: */
 813         G.cur_time -= offset;
 814         G.last_update_recv_time -= offset;
 815         G.last_script_run -= offset;
 816 }
 817
 818
 819 /*
 820  * Selection and clustering, and their helpers
 821  */
 822 typedef struct {
 823         peer_t *p;
 824         int    type;
 825         double edge;
 826         double opt_rd; /* optimization */
 827 } point_t;
 828 static int
 829 compare_point_edge(const void *aa, const void *bb)
 830 {
 831         const point_t *a = aa;
 832         const point_t *b = bb;
 833         if (a->edge < b->edge) {
 834                 return -1;
 835         }
 836         return (a->edge > b->edge);
 837 }
 838 typedef struct {
 839         peer_t *p;
 840         double metric;
 841 } survivor_t;
 842 static int
 843 compare_survivor_metric(const void *aa, const void *bb)
 844 {
 845         const survivor_t *a = aa;
 846         const survivor_t *b = bb;
 847         if (a->metric < b->metric) {
 848                 return -1;
 849         }
 850         return (a->metric > b->metric);
 851 }
 852 static int
 853 fit(peer_t *p, double rd)
 854 {
 855         if ((p->reachable_bits & (p->reachable_bits-1)) == 0) {
 856                 /* One or zero bits in reachable_bits */
 857                 VERB3 bb_error_msg("peer %s unfit for selection: unreachable", p->p_dotted);
 858                 return 0;
 859         }
 860 #if 0   /* we filter out such packets earlier */
 861         if ((p->lastpkt_status & LI_ALARM) == LI_ALARM
 862          || p->lastpkt_stratum >= MAXSTRAT
 863         ) {
 864                 VERB3 bb_error_msg("peer %s unfit for selection: bad status/stratum", p->p_dotted);
 865                 return 0;
 866         }
 867 #endif
 868         /* rd is root_distance(p) */
 869         if (rd > MAXDIST + FREQ_TOLERANCE * (1 << G.poll_exp)) {
 870                 VERB3 bb_error_msg("peer %s unfit for selection: root distance too high", p->p_dotted);
 871                 return 0;
 872         }
 873 //TODO
 874 //      /* Do we have a loop? */
 875 //      if (p->refid == p->dstaddr || p->refid == s.refid)
 876 //              return 0;
 877         return 1;
 878 }
 879 static peer_t*
 880 select_and_cluster(void)
 881 {
 882         peer_t     *p;
 883         llist_t    *item;
 884         int        i, j;
 885         int        size = 3 * G.peer_cnt;
 886         /* for selection algorithm */
 887         point_t    point[size];
 888         unsigned   num_points, num_candidates;
 889         double     low, high;
 890         unsigned   num_falsetickers;
 891         /* for cluster algorithm */
 892         survivor_t survivor[size];
 893         unsigned   num_survivors;
 894
 895         /* Selection */
 896
 897         num_points = 0;
 898         item = G.ntp_peers;
 899         if (G.initial_poll_complete) while (item != NULL) {
 900                 double rd, offset;
 901
 902                 p = (peer_t *) item->data;
 903                 rd = root_distance(p);
 904                 offset = p->filter_offset;
 905                 if (!fit(p, rd)) {
 906                         item = item->link;
 907                         continue;
 908                 }
 909
 910                 VERB4 bb_error_msg("interval: [%f %f %f] %s",
 911                                 offset - rd,
 912                                 offset,
 913                                 offset + rd,
 914                                 p->p_dotted
 915                 );
 916                 point[num_points].p = p;
 917                 point[num_points].type = -1;
 918                 point[num_points].edge = offset - rd;
 919                 point[num_points].opt_rd = rd;
 920                 num_points++;
 921                 point[num_points].p = p;
 922                 point[num_points].type = 0;
 923                 point[num_points].edge = offset;
 924                 point[num_points].opt_rd = rd;
 925                 num_points++;
 926                 point[num_points].p = p;
 927                 point[num_points].type = 1;
 928                 point[num_points].edge = offset + rd;
 929                 point[num_points].opt_rd = rd;
 930                 num_points++;
 931                 item = item->link;
 932         }
 933         num_candidates = num_points / 3;
 934         if (num_candidates == 0) {
 935                 VERB3 bb_error_msg("no valid datapoints, no peer selected");
 936                 return NULL;
 937         }
 938 //TODO: sorting does not seem to be done in reference code
 939         qsort(point, num_points, sizeof(point[0]), compare_point_edge);
 940
 941         /* Start with the assumption that there are no falsetickers.
 942          * Attempt to find a nonempty intersection interval containing
 943          * the midpoints of all truechimers.
 944          * If a nonempty interval cannot be found, increase the number
 945          * of assumed falsetickers by one and try again.
 946          * If a nonempty interval is found and the number of falsetickers
 947          * is less than the number of truechimers, a majority has been found
 948          * and the midpoint of each truechimer represents
 949          * the candidates available to the cluster algorithm.
 950          */
 951         num_falsetickers = 0;
 952         while (1) {
 953                 int c;
 954                 unsigned num_midpoints = 0;
 955
 956                 low = 1 << 9;
 957                 high = - (1 << 9);
 958                 c = 0;
 959                 for (i = 0; i < num_points; i++) {
 960                         /* We want to do:
 961                          * if (point[i].type == -1) c++;
 962                          * if (point[i].type == 1) c--;
 963                          * and it's simpler to do it this way:
 964                          */
 965                         c -= point[i].type;
 966                         if (c >= num_candidates - num_falsetickers) {
 967                                 /* If it was c++ and it got big enough... */
 968                                 low = point[i].edge;
 969                                 break;
 970                         }
 971                         if (point[i].type == 0)
 972                                 num_midpoints++;
 973                 }
 974                 c = 0;
 975                 for (i = num_points-1; i >= 0; i--) {
 976                         c += point[i].type;
 977                         if (c >= num_candidates - num_falsetickers) {
 978                                 high = point[i].edge;
 979                                 break;
 980                         }
 981                         if (point[i].type == 0)
 982                                 num_midpoints++;
 983                 }
 984                 /* If the number of midpoints is greater than the number
 985                  * of allowed falsetickers, the intersection contains at
 986                  * least one truechimer with no midpoint - bad.
 987                  * Also, interval should be nonempty.
 988                  */
 989                 if (num_midpoints <= num_falsetickers && low < high)
 990                         break;
 991                 num_falsetickers++;
 992                 if (num_falsetickers * 2 >= num_candidates) {
 993                         VERB3 bb_error_msg("too many falsetickers:%d (candidates:%d), no peer selected",
 994                                         num_falsetickers, num_candidates);
 995                         return NULL;
 996                 }
 997         }
 998         VERB3 bb_error_msg("selected interval: [%f, %f]; candidates:%d falsetickers:%d",
 999                         low, high, num_candidates, num_falsetickers);
1000
1001         /* Clustering */
1002
1003         /* Construct a list of survivors (p, metric)
1004          * from the chime list, where metric is dominated
1005          * first by stratum and then by root distance.
1006          * All other things being equal, this is the order of preference.
1007          */
1008         num_survivors = 0;
1009         for (i = 0; i < num_points; i++) {
1010                 if (point[i].edge < low || point[i].edge > high)
1011                         continue;
1012                 p = point[i].p;
1013                 survivor[num_survivors].p = p;
1014                 /* x.opt_rd == root_distance(p); */
1015                 survivor[num_survivors].metric = MAXDIST * p->lastpkt_stratum + point[i].opt_rd;
1016                 VERB4 bb_error_msg("survivor[%d] metric:%f peer:%s",
1017                         num_survivors, survivor[num_survivors].metric, p->p_dotted);
1018                 num_survivors++;
1019         }
1020         /* There must be at least MIN_SELECTED survivors to satisfy the
1021          * correctness assertions. Ordinarily, the Byzantine criteria
1022          * require four survivors, but for the demonstration here, one
1023          * is acceptable.
1024          */
1025         if (num_survivors < MIN_SELECTED) {
1026                 VERB3 bb_error_msg("num_survivors %d < %d, no peer selected",
1027                                 num_survivors, MIN_SELECTED);
1028                 return NULL;
1029         }
1030
1031 //looks like this is ONLY used by the fact that later we pick survivor[0].
1032 //we can avoid sorting then, just find the minimum once!
1033         qsort(survivor, num_survivors, sizeof(survivor[0]), compare_survivor_metric);
1034
1035         /* For each association p in turn, calculate the selection
1036          * jitter p->sjitter as the square root of the sum of squares
1037          * (p->offset - q->offset) over all q associations. The idea is
1038          * to repeatedly discard the survivor with maximum selection
1039          * jitter until a termination condition is met.
1040          */
1041         while (1) {
1042                 unsigned max_idx = max_idx;
1043                 double max_selection_jitter = max_selection_jitter;
1044                 double min_jitter = min_jitter;
1045
1046                 if (num_survivors <= MIN_CLUSTERED) {
1047                         VERB3 bb_error_msg("num_survivors %d <= %d, not discarding more",
1048                                         num_survivors, MIN_CLUSTERED);
1049                         break;
1050                 }
1051
1052                 /* To make sure a few survivors are left
1053                  * for the clustering algorithm to chew on,
1054                  * we stop if the number of survivors
1055                  * is less than or equal to MIN_CLUSTERED (3).
1056                  */
1057                 for (i = 0; i < num_survivors; i++) {
1058                         double selection_jitter_sq;
1059
1060                         p = survivor[i].p;
1061                         if (i == 0 || p->filter_jitter < min_jitter)
1062                                 min_jitter = p->filter_jitter;
1063
1064                         selection_jitter_sq = 0;
1065                         for (j = 0; j < num_survivors; j++) {
1066                                 peer_t *q = survivor[j].p;
1067                                 selection_jitter_sq += SQUARE(p->filter_offset - q->filter_offset);
1068                         }
1069                         if (i == 0 || selection_jitter_sq > max_selection_jitter) {
1070                                 max_selection_jitter = selection_jitter_sq;
1071                                 max_idx = i;
1072                         }
1073                         VERB5 bb_error_msg("survivor %d selection_jitter^2:%f",
1074                                         i, selection_jitter_sq);
1075                 }
1076                 max_selection_jitter = SQRT(max_selection_jitter / num_survivors);
1077                 VERB4 bb_error_msg("max_selection_jitter (at %d):%f min_jitter:%f",
1078                                 max_idx, max_selection_jitter, min_jitter);
1079
1080                 /* If the maximum selection jitter is less than the
1081                  * minimum peer jitter, then tossing out more survivors
1082                  * will not lower the minimum peer jitter, so we might
1083                  * as well stop.
1084                  */
1085                 if (max_selection_jitter < min_jitter) {
1086                         VERB3 bb_error_msg("max_selection_jitter:%f < min_jitter:%f, num_survivors:%d, not discarding more",
1087                                         max_selection_jitter, min_jitter, num_survivors);
1088                         break;
1089                 }
1090
1091                 /* Delete survivor[max_idx] from the list
1092                  * and go around again.
1093                  */
1094                 VERB5 bb_error_msg("dropping survivor %d", max_idx);
1095                 num_survivors--;
1096                 while (max_idx < num_survivors) {
1097                         survivor[max_idx] = survivor[max_idx + 1];
1098                         max_idx++;
1099                 }
1100         }
1101
1102         if (0) {
1103                 /* Combine the offsets of the clustering algorithm survivors
1104                  * using a weighted average with weight determined by the root
1105                  * distance. Compute the selection jitter as the weighted RMS
1106                  * difference between the first survivor and the remaining
1107                  * survivors. In some cases the inherent clock jitter can be
1108                  * reduced by not using this algorithm, especially when frequent
1109                  * clockhopping is involved. bbox: thus we don't do it.
1110                  */
1111                 double x, y, z, w;
1112                 y = z = w = 0;
1113                 for (i = 0; i < num_survivors; i++) {
1114                         p = survivor[i].p;
1115                         x = root_distance(p);
1116                         y += 1 / x;
1117                         z += p->filter_offset / x;
1118                         w += SQUARE(p->filter_offset - survivor[0].p->filter_offset) / x;
1119                 }
1120                 //G.cluster_offset = z / y;
1121                 //G.cluster_jitter = SQRT(w / y);
1122         }
1123
1124         /* Pick the best clock. If the old system peer is on the list
1125          * and at the same stratum as the first survivor on the list,
1126          * then don't do a clock hop. Otherwise, select the first
1127          * survivor on the list as the new system peer.
1128          */
1129         p = survivor[0].p;
1130         if (G.last_update_peer
1131          && G.last_update_peer->lastpkt_stratum <= p->lastpkt_stratum
1132         ) {
1133                 /* Starting from 1 is ok here */
1134                 for (i = 1; i < num_survivors; i++) {
1135                         if (G.last_update_peer == survivor[i].p) {
1136                                 VERB4 bb_error_msg("keeping old synced peer");
1137                                 p = G.last_update_peer;
1138                                 goto keep_old;
1139                         }
1140                 }
1141         }
1142         G.last_update_peer = p;
1143  keep_old:
1144         VERB3 bb_error_msg("selected peer %s filter_offset:%f age:%f",
1145                         p->p_dotted,
1146                         p->filter_offset,
1147                         G.cur_time - p->lastpkt_recv_time
1148         );
1149         return p;
1150 }
1151
1152
1153 /*
1154  * Local clock discipline and its helpers
1155  */
1156 static void
1157 set_new_values(int disc_state, double offset, double recv_time)
1158 {
1159         /* Enter new state and set state variables. Note we use the time
1160          * of the last clock filter sample, which must be earlier than
1161          * the current time.
1162          */
1163         VERB3 bb_error_msg("disc_state=%d last update offset=%f recv_time=%f",
1164                         disc_state, offset, recv_time);
1165         G.discipline_state = disc_state;
1166         G.last_update_offset = offset;
1167         G.last_update_recv_time = recv_time;
1168 }
1169 /* Return: -1: decrease poll interval, 0: leave as is, 1: increase */
1170 static NOINLINE int
1171 update_local_clock(peer_t *p)
1172 {
1173         int rc;
1174         struct timex tmx;
1175         /* Note: can use G.cluster_offset instead: */
1176         double offset = p->filter_offset;
1177         double recv_time = p->lastpkt_recv_time;
1178         double abs_offset;
1179 #if !USING_KERNEL_PLL_LOOP
1180         double freq_drift;
1181 #endif
1182         double since_last_update;
1183         double etemp, dtemp;
1184
1185         abs_offset = fabs(offset);
1186
1187 #if 0
1188         /* If needed, -S script can detect this by looking at $offset
1189          * env var and kill parent */
1190         /* If the offset is too large, give up and go home */
1191         if (abs_offset > PANIC_THRESHOLD) {
1192                 bb_error_msg_and_die("offset %f far too big, exiting", offset);
1193         }
1194 #endif
1195
1196         /* If this is an old update, for instance as the result
1197          * of a system peer change, avoid it. We never use
1198          * an old sample or the same sample twice.
1199          */
1200         if (recv_time <= G.last_update_recv_time) {
1201                 VERB3 bb_error_msg("same or older datapoint: %f >= %f, not using it",
1202                                 G.last_update_recv_time, recv_time);
1203                 return 0; /* "leave poll interval as is" */
1204         }
1205
1206         /* Clock state machine transition function. This is where the
1207          * action is and defines how the system reacts to large time
1208          * and frequency errors.
1209          */
1210         since_last_update = recv_time - G.reftime;
1211 #if !USING_KERNEL_PLL_LOOP
1212         freq_drift = 0;
1213 #endif
1214 #if USING_INITIAL_FREQ_ESTIMATION
1215         if (G.discipline_state == STATE_FREQ) {
1216                 /* Ignore updates until the stepout threshold */
1217                 if (since_last_update < WATCH_THRESHOLD) {
1218                         VERB3 bb_error_msg("measuring drift, datapoint ignored, %f sec remains",
1219                                         WATCH_THRESHOLD - since_last_update);
1220                         return 0; /* "leave poll interval as is" */
1221                 }
1222 # if !USING_KERNEL_PLL_LOOP
1223                 freq_drift = (offset - G.last_update_offset) / since_last_update;
1224 # endif
1225         }
1226 #endif
1227
1228         /* There are two main regimes: when the
1229          * offset exceeds the step threshold and when it does not.
1230          */
1231         if (abs_offset > STEP_THRESHOLD) {
1232                 switch (G.discipline_state) {
1233                 case STATE_SYNC:
1234                         /* The first outlyer: ignore it, switch to SPIK state */
1235                         VERB3 bb_error_msg("offset:%f - spike detected", offset);
1236                         G.discipline_state = STATE_SPIK;
1237                         return -1; /* "decrease poll interval" */
1238
1239                 case STATE_SPIK:
1240                         /* Ignore succeeding outlyers until either an inlyer
1241                          * is found or the stepout threshold is exceeded.
1242                          */
1243                         if (since_last_update < WATCH_THRESHOLD) {
1244                                 VERB3 bb_error_msg("spike detected, datapoint ignored, %f sec remains",
1245                                                 WATCH_THRESHOLD - since_last_update);
1246                                 return -1; /* "decrease poll interval" */
1247                         }
1248                         /* fall through: we need to step */
1249                 } /* switch */
1250
1251                 /* Step the time and clamp down the poll interval.
1252                  *
1253                  * In NSET state an initial frequency correction is
1254                  * not available, usually because the frequency file has
1255                  * not yet been written. Since the time is outside the
1256                  * capture range, the clock is stepped. The frequency
1257                  * will be set directly following the stepout interval.
1258                  *
1259                  * In FSET state the initial frequency has been set
1260                  * from the frequency file. Since the time is outside
1261                  * the capture range, the clock is stepped immediately,
1262                  * rather than after the stepout interval. Guys get
1263                  * nervous if it takes 17 minutes to set the clock for
1264                  * the first time.
1265                  *
1266                  * In SPIK state the stepout threshold has expired and
1267                  * the phase is still above the step threshold. Note
1268                  * that a single spike greater than the step threshold
1269                  * is always suppressed, even at the longer poll
1270                  * intervals.
1271                  */
1272                 VERB3 bb_error_msg("stepping time by %f; poll_exp=MINPOLL", offset);
1273                 step_time(offset);
1274                 if (option_mask32 & OPT_q) {
1275                         /* We were only asked to set time once. Done. */
1276                         exit(0);
1277                 }
1278
1279                 G.polladj_count = 0;
1280                 G.poll_exp = MINPOLL;
1281                 G.stratum = MAXSTRAT;
1282
1283                 run_script("step", offset);
1284
1285 #if USING_INITIAL_FREQ_ESTIMATION
1286                 if (G.discipline_state == STATE_NSET) {
1287                         set_new_values(STATE_FREQ, /*offset:*/ 0, recv_time);
1288                         return 1; /* "ok to increase poll interval" */
1289                 }
1290 #endif
1291                 set_new_values(STATE_SYNC, /*offset:*/ 0, recv_time);
1292
1293         } else { /* abs_offset <= STEP_THRESHOLD */
1294
1295                 if (G.poll_exp < MINPOLL && G.initial_poll_complete) {
1296                         VERB3 bb_error_msg("small offset:%f, disabling burst mode", offset);
1297                         G.polladj_count = 0;
1298                         G.poll_exp = MINPOLL;
1299                 }
1300
1301                 /* Compute the clock jitter as the RMS of exponentially
1302                  * weighted offset differences. Used by the poll adjust code.
1303                  */
1304                 etemp = SQUARE(G.discipline_jitter);
1305                 dtemp = SQUARE(MAXD(fabs(offset - G.last_update_offset), G_precision_sec));
1306                 G.discipline_jitter = SQRT(etemp + (dtemp - etemp) / AVG);
1307                 VERB3 bb_error_msg("discipline jitter=%f", G.discipline_jitter);
1308
1309                 switch (G.discipline_state) {
1310                 case STATE_NSET:
1311                         if (option_mask32 & OPT_q) {
1312                                 /* We were only asked to set time once.
1313                                  * The clock is precise enough, no need to step.
1314                                  */
1315                                 exit(0);
1316                         }
1317 #if USING_INITIAL_FREQ_ESTIMATION
1318                         /* This is the first update received and the frequency
1319                          * has not been initialized. The first thing to do
1320                          * is directly measure the oscillator frequency.
1321                          */
1322                         set_new_values(STATE_FREQ, offset, recv_time);
1323 #else
1324                         set_new_values(STATE_SYNC, offset, recv_time);
1325 #endif
1326                         VERB3 bb_error_msg("transitioning to FREQ, datapoint ignored");
1327                         return 0; /* "leave poll interval as is" */
1328
1329 #if 0 /* this is dead code for now */
1330                 case STATE_FSET:
1331                         /* This is the first update and the frequency
1332                          * has been initialized. Adjust the phase, but
1333                          * don't adjust the frequency until the next update.
1334                          */
1335                         set_new_values(STATE_SYNC, offset, recv_time);
1336                         /* freq_drift remains 0 */
1337                         break;
1338 #endif
1339
1340 #if USING_INITIAL_FREQ_ESTIMATION
1341                 case STATE_FREQ:
1342                         /* since_last_update >= WATCH_THRESHOLD, we waited enough.
1343                          * Correct the phase and frequency and switch to SYNC state.
1344                          * freq_drift was already estimated (see code above)
1345                          */
1346                         set_new_values(STATE_SYNC, offset, recv_time);
1347                         break;
1348 #endif
1349
1350                 default:
1351 #if !USING_KERNEL_PLL_LOOP
1352                         /* Compute freq_drift due to PLL and FLL contributions.
1353                          *
1354                          * The FLL and PLL frequency gain constants
1355                          * depend on the poll interval and Allan
1356                          * intercept. The FLL is not used below one-half
1357                          * the Allan intercept. Above that the loop gain
1358                          * increases in steps to 1 / AVG.
1359                          */
1360                         if ((1 << G.poll_exp) > ALLAN / 2) {
1361                                 etemp = FLL - G.poll_exp;
1362                                 if (etemp < AVG)
1363                                         etemp = AVG;
1364                                 freq_drift += (offset - G.last_update_offset) / (MAXD(since_last_update, ALLAN) * etemp);
1365                         }
1366                         /* For the PLL the integration interval
1367                          * (numerator) is the minimum of the update
1368                          * interval and poll interval. This allows
1369                          * oversampling, but not undersampling.
1370                          */
1371                         etemp = MIND(since_last_update, (1 << G.poll_exp));
1372                         dtemp = (4 * PLL) << G.poll_exp;
1373                         freq_drift += offset * etemp / SQUARE(dtemp);
1374 #endif
1375                         set_new_values(STATE_SYNC, offset, recv_time);
1376                         break;
1377                 }
1378                 if (G.stratum != p->lastpkt_stratum + 1) {
1379                         G.stratum = p->lastpkt_stratum + 1;
1380                         run_script("stratum", offset);
1381                 }
1382         }
1383
1384         G.reftime = G.cur_time;
1385         G.ntp_status = p->lastpkt_status;
1386         G.refid = p->lastpkt_refid;
1387         G.rootdelay = p->lastpkt_rootdelay + p->lastpkt_delay;
1388         dtemp = p->filter_jitter; // SQRT(SQUARE(p->filter_jitter) + SQUARE(G.cluster_jitter));
1389         dtemp += MAXD(p->filter_dispersion + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time) + abs_offset, MINDISP);
1390         G.rootdisp = p->lastpkt_rootdisp + dtemp;
1391         VERB3 bb_error_msg("updating leap/refid/reftime/rootdisp from peer %s", p->p_dotted);
1392
1393         /* We are in STATE_SYNC now, but did not do adjtimex yet.
1394          * (Any other state does not reach this, they all return earlier)
1395          * By this time, freq_drift and G.last_update_offset are set
1396          * to values suitable for adjtimex.
1397          */
1398 #if !USING_KERNEL_PLL_LOOP
1399         /* Calculate the new frequency drift and frequency stability (wander).
1400          * Compute the clock wander as the RMS of exponentially weighted
1401          * frequency differences. This is not used directly, but can,
1402          * along with the jitter, be a highly useful monitoring and
1403          * debugging tool.
1404          */
1405         dtemp = G.discipline_freq_drift + freq_drift;
1406         G.discipline_freq_drift = MAXD(MIND(MAXDRIFT, dtemp), -MAXDRIFT);
1407         etemp = SQUARE(G.discipline_wander);
1408         dtemp = SQUARE(dtemp);
1409         G.discipline_wander = SQRT(etemp + (dtemp - etemp) / AVG);
1410
1411         VERB3 bb_error_msg("discipline freq_drift=%.9f(int:%ld corr:%e) wander=%f",
1412                         G.discipline_freq_drift,
1413                         (long)(G.discipline_freq_drift * 65536e6),
1414                         freq_drift,
1415                         G.discipline_wander);
1416 #endif
1417         VERB3 {
1418                 memset(&tmx, 0, sizeof(tmx));
1419                 if (adjtimex(&tmx) < 0)
1420                         bb_perror_msg_and_die("adjtimex");
1421                 VERB3 bb_error_msg("p adjtimex freq:%ld offset:%ld constant:%ld status:0x%x",
1422                                 tmx.freq, tmx.offset, tmx.constant, tmx.status);
1423         }
1424
1425         memset(&tmx, 0, sizeof(tmx));
1426 #if 0
1427 //doesn't work, offset remains 0 (!) in kernel:
1428 //ntpd:  set adjtimex freq:1786097 tmx.offset:77487
1429 //ntpd: prev adjtimex freq:1786097 tmx.offset:0
1430 //ntpd:  cur adjtimex freq:1786097 tmx.offset:0
1431         tmx.modes = ADJ_FREQUENCY | ADJ_OFFSET;
1432         /* 65536 is one ppm */
1433         tmx.freq = G.discipline_freq_drift * 65536e6;
1434         tmx.offset = G.last_update_offset * 1000000; /* usec */
1435 #endif
1436         tmx.modes = ADJ_OFFSET | ADJ_STATUS | ADJ_TIMECONST;// | ADJ_MAXERROR | ADJ_ESTERROR;
1437         tmx.offset = (G.last_update_offset * 1000000); /* usec */
1438                         /* + (G.last_update_offset < 0 ? -0.5 : 0.5) - too small to bother */
1439         tmx.status = STA_PLL;
1440         if (G.ntp_status & LI_PLUSSEC)
1441                 tmx.status |= STA_INS;
1442         if (G.ntp_status & LI_MINUSSEC)
1443                 tmx.status |= STA_DEL;
1444         tmx.constant = G.poll_exp - 4;
1445         //tmx.esterror = (u_int32)(clock_jitter * 1e6);
1446         //tmx.maxerror = (u_int32)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
1447         rc = adjtimex(&tmx);
1448         if (rc < 0)
1449                 bb_perror_msg_and_die("adjtimex");
1450         /* NB: here kernel returns constant == G.poll_exp, not == G.poll_exp - 4.
1451          * Not sure why. Perhaps it is normal.
1452          */
1453         VERB3 bb_error_msg("adjtimex:%d freq:%ld offset:%ld constant:%ld status:0x%x",
1454                                 rc, tmx.freq, tmx.offset, tmx.constant, tmx.status);
1455 #if 0
1456         VERB3 {
1457                 /* always gives the same output as above msg */
1458                 memset(&tmx, 0, sizeof(tmx));
1459                 if (adjtimex(&tmx) < 0)
1460                         bb_perror_msg_and_die("adjtimex");
1461                 VERB3 bb_error_msg("c adjtimex freq:%ld offset:%ld constant:%ld status:0x%x",
1462                                 tmx.freq, tmx.offset, tmx.constant, tmx.status);
1463         }
1464 #endif
1465         G.kernel_freq_drift = tmx.freq / 65536;
1466         VERB2 bb_error_msg("update peer:%s, offset:%f, clock drift:%ld ppm",
1467                         p->p_dotted, G.last_update_offset, G.kernel_freq_drift);
1468
1469         return 1; /* "ok to increase poll interval" */
1470 }
1471
1472
1473 /*
1474  * We've got a new reply packet from a peer, process it
1475  * (helpers first)
1476  */
1477 static unsigned
1478 retry_interval(void)
1479 {
1480         /* Local problem, want to retry soon */
1481         unsigned interval, r;
1482         interval = RETRY_INTERVAL;
1483         r = random();
1484         interval += r % (unsigned)(RETRY_INTERVAL / 4);
1485         VERB3 bb_error_msg("chose retry interval:%u", interval);
1486         return interval;
1487 }
1488 static unsigned
1489 poll_interval(int exponent)
1490 {
1491         unsigned interval, r;
1492         exponent = G.poll_exp + exponent;
1493         if (exponent < 0)
1494                 exponent = 0;
1495         interval = 1 << exponent;
1496         r = random();
1497         interval += ((r & (interval-1)) >> 4) + ((r >> 8) & 1); /* + 1/16 of interval, max */
1498         VERB3 bb_error_msg("chose poll interval:%u (poll_exp:%d exp:%d)", interval, G.poll_exp, exponent);
1499         return interval;
1500 }
1501 static NOINLINE void
1502 recv_and_process_peer_pkt(peer_t *p)
1503 {
1504         int         rc;
1505         ssize_t     size;
1506         msg_t       msg;
1507         double      T1, T2, T3, T4;
1508         unsigned    interval;
1509         datapoint_t *datapoint;
1510         peer_t      *q;
1511
1512         /* We can recvfrom here and check from.IP, but some multihomed
1513          * ntp servers reply from their *other IP*.
1514          * TODO: maybe we should check at least what we can: from.port == 123?
1515          */
1516         size = recv(p->p_fd, &msg, sizeof(msg), MSG_DONTWAIT);
1517         if (size == -1) {
1518                 bb_perror_msg("recv(%s) error", p->p_dotted);
1519                 if (errno == EHOSTUNREACH || errno == EHOSTDOWN
1520                  || errno == ENETUNREACH || errno == ENETDOWN
1521                  || errno == ECONNREFUSED || errno == EADDRNOTAVAIL
1522                  || errno == EAGAIN
1523                 ) {
1524 //TODO: always do this?
1525                         interval = retry_interval();
1526                         goto set_next_and_close_sock;
1527                 }
1528                 xfunc_die();
1529         }
1530
1531         if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1532                 bb_error_msg("malformed packet received from %s", p->p_dotted);
1533                 goto bail;
1534         }
1535
1536         if (msg.m_orgtime.int_partl != p->p_xmt_msg.m_xmttime.int_partl
1537          || msg.m_orgtime.fractionl != p->p_xmt_msg.m_xmttime.fractionl
1538         ) {
1539                 goto bail;
1540         }
1541
1542         if ((msg.m_status & LI_ALARM) == LI_ALARM
1543          || msg.m_stratum == 0
1544          || msg.m_stratum > NTP_MAXSTRATUM
1545         ) {
1546 // TODO: stratum 0 responses may have commands in 32-bit m_refid field:
1547 // "DENY", "RSTR" - peer does not like us at all
1548 // "RATE" - peer is overloaded, reduce polling freq
1549                 interval = poll_interval(0);
1550                 bb_error_msg("reply from %s: not synced, next query in %us", p->p_dotted, interval);
1551                 goto set_next_and_close_sock;
1552         }
1553
1554 //      /* Verify valid root distance */
1555 //      if (msg.m_rootdelay / 2 + msg.m_rootdisp >= MAXDISP || p->lastpkt_reftime > msg.m_xmt)
1556 //              return;                 /* invalid header values */
1557
1558         p->lastpkt_status = msg.m_status;
1559         p->lastpkt_stratum = msg.m_stratum;
1560         p->lastpkt_rootdelay = sfp_to_d(msg.m_rootdelay);
1561         p->lastpkt_rootdisp = sfp_to_d(msg.m_rootdisp);
1562         p->lastpkt_refid = msg.m_refid;
1563
1564         /*
1565          * From RFC 2030 (with a correction to the delay math):
1566          *
1567          * Timestamp Name          ID   When Generated
1568          * ------------------------------------------------------------
1569          * Originate Timestamp     T1   time request sent by client
1570          * Receive Timestamp       T2   time request received by server
1571          * Transmit Timestamp      T3   time reply sent by server
1572          * Destination Timestamp   T4   time reply received by client
1573          *
1574          * The roundtrip delay and local clock offset are defined as
1575          *
1576          * delay = (T4 - T1) - (T3 - T2); offset = ((T2 - T1) + (T3 - T4)) / 2
1577          */
1578         T1 = p->p_xmttime;
1579         T2 = lfp_to_d(msg.m_rectime);
1580         T3 = lfp_to_d(msg.m_xmttime);
1581         T4 = G.cur_time;
1582
1583         p->lastpkt_recv_time = T4;
1584
1585         VERB5 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
1586         p->datapoint_idx = p->reachable_bits ? (p->datapoint_idx + 1) % NUM_DATAPOINTS : 0;
1587         datapoint = &p->filter_datapoint[p->datapoint_idx];
1588         datapoint->d_recv_time = T4;
1589         datapoint->d_offset    = ((T2 - T1) + (T3 - T4)) / 2;
1590         /* The delay calculation is a special case. In cases where the
1591          * server and client clocks are running at different rates and
1592          * with very fast networks, the delay can appear negative. In
1593          * order to avoid violating the Principle of Least Astonishment,
1594          * the delay is clamped not less than the system precision.
1595          */
1596         p->lastpkt_delay = (T4 - T1) - (T3 - T2);
1597         if (p->lastpkt_delay < G_precision_sec)
1598                 p->lastpkt_delay = G_precision_sec;
1599         datapoint->d_dispersion = LOG2D(msg.m_precision_exp) + G_precision_sec;
1600         if (!p->reachable_bits) {
1601                 /* 1st datapoint ever - replicate offset in every element */
1602                 int i;
1603                 for (i = 1; i < NUM_DATAPOINTS; i++) {
1604                         p->filter_datapoint[i].d_offset = datapoint->d_offset;
1605                 }
1606         }
1607
1608         p->reachable_bits |= 1;
1609         if ((MAX_VERBOSE && G.verbose) || (option_mask32 & OPT_w)) {
1610                 bb_error_msg("reply from %s: reach 0x%02x offset %f delay %f status 0x%02x strat %d refid 0x%08x rootdelay %f",
1611                         p->p_dotted,
1612                         p->reachable_bits,
1613                         datapoint->d_offset,
1614                         p->lastpkt_delay,
1615                         p->lastpkt_status,
1616                         p->lastpkt_stratum,
1617                         p->lastpkt_refid,
1618                         p->lastpkt_rootdelay
1619                         /* not shown: m_ppoll, m_precision_exp, m_rootdisp,
1620                          * m_reftime, m_orgtime, m_rectime, m_xmttime
1621                          */
1622                 );
1623         }
1624
1625         /* Muck with statictics and update the clock */
1626         filter_datapoints(p);
1627         q = select_and_cluster();
1628         rc = -1;
1629         if (q) {
1630                 rc = 0;
1631                 if (!(option_mask32 & OPT_w)) {
1632                         rc = update_local_clock(q);
1633                         /* If drift is dangerously large, immediately
1634                          * drop poll interval one step down.
1635                          */
1636                         if (fabs(q->filter_offset) >= POLLDOWN_OFFSET) {
1637                                 VERB3 bb_error_msg("offset:%f > POLLDOWN_OFFSET", q->filter_offset);
1638                                 goto poll_down;
1639                         }
1640                 }
1641         }
1642         /* else: no peer selected, rc = -1: we want to poll more often */
1643
1644         if (rc != 0) {
1645                 /* Adjust the poll interval by comparing the current offset
1646                  * with the clock jitter. If the offset is less than
1647                  * the clock jitter times a constant, then the averaging interval
1648                  * is increased, otherwise it is decreased. A bit of hysteresis
1649                  * helps calm the dance. Works best using burst mode.
1650                  */
1651                 VERB4 if (rc > 0) {
1652                         bb_error_msg("offset:%f POLLADJ_GATE*discipline_jitter:%f poll:%s",
1653                                 q->filter_offset, POLLADJ_GATE * G.discipline_jitter,
1654                                 fabs(q->filter_offset) < POLLADJ_GATE * G.discipline_jitter
1655                                         ? "grows" : "falls"
1656                         );
1657                 }
1658                 if (rc > 0 && fabs(q->filter_offset) < POLLADJ_GATE * G.discipline_jitter) {
1659                         /* was += G.poll_exp but it is a bit
1660                          * too optimistic for my taste at high poll_exp's */
1661                         G.polladj_count += MINPOLL;
1662                         if (G.polladj_count > POLLADJ_LIMIT) {
1663                                 G.polladj_count = 0;
1664                                 if (G.poll_exp < MAXPOLL) {
1665                                         G.poll_exp++;
1666                                         VERB3 bb_error_msg("polladj: discipline_jitter:%f ++poll_exp=%d",
1667                                                         G.discipline_jitter, G.poll_exp);
1668                                 }
1669                         } else {
1670                                 VERB3 bb_error_msg("polladj: incr:%d", G.polladj_count);
1671                         }
1672                 } else {
1673                         G.polladj_count -= G.poll_exp * 2;
1674                         if (G.polladj_count < -POLLADJ_LIMIT || G.poll_exp >= BIGPOLL) {
1675  poll_down:
1676                                 G.polladj_count = 0;
1677                                 if (G.poll_exp > MINPOLL) {
1678                                         llist_t *item;
1679
1680                                         G.poll_exp--;
1681                                         /* Correct p->next_action_time in each peer
1682                                          * which waits for sending, so that they send earlier.
1683                                          * Old pp->next_action_time are on the order
1684                                          * of t + (1 << old_poll_exp) + small_random,
1685                                          * we simply need to subtract ~half of that.
1686                                          */
1687                                         for (item = G.ntp_peers; item != NULL; item = item->link) {
1688                                                 peer_t *pp = (peer_t *) item->data;
1689                                                 if (pp->p_fd < 0)
1690                                                         pp->next_action_time -= (1 << G.poll_exp);
1691                                         }
1692                                         VERB3 bb_error_msg("polladj: discipline_jitter:%f --poll_exp=%d",
1693                                                         G.discipline_jitter, G.poll_exp);
1694                                 }
1695                         } else {
1696                                 VERB3 bb_error_msg("polladj: decr:%d", G.polladj_count);
1697                         }
1698                 }
1699         }
1700
1701         /* Decide when to send new query for this peer */
1702         interval = poll_interval(0);
1703
1704  set_next_and_close_sock:
1705         set_next(p, interval);
1706         /* We do not expect any more packets from this peer for now.
1707          * Closing the socket informs kernel about it.
1708          * We open a new socket when we send a new query.
1709          */
1710         close(p->p_fd);
1711         p->p_fd = -1;
1712  bail:
1713         return;
1714 }
1715
1716 #if ENABLE_FEATURE_NTPD_SERVER
1717 static NOINLINE void
1718 recv_and_process_client_pkt(void /*int fd*/)
1719 {
1720         ssize_t          size;
1721         uint8_t          version;
1722         len_and_sockaddr *to;
1723         struct sockaddr  *from;
1724         msg_t            msg;
1725         uint8_t          query_status;
1726         l_fixedpt_t      query_xmttime;
1727
1728         to = get_sock_lsa(G.listen_fd);
1729         from = xzalloc(to->len);
1730
1731         size = recv_from_to(G.listen_fd, &msg, sizeof(msg), MSG_DONTWAIT, from, &to->u.sa, to->len);
1732         if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1733                 char *addr;
1734                 if (size < 0) {
1735                         if (errno == EAGAIN)
1736                                 goto bail;
1737                         bb_perror_msg_and_die("recv");
1738                 }
1739                 addr = xmalloc_sockaddr2dotted_noport(from);
1740                 bb_error_msg("malformed packet received from %s: size %u", addr, (int)size);
1741                 free(addr);
1742                 goto bail;
1743         }
1744
1745         query_status = msg.m_status;
1746         query_xmttime = msg.m_xmttime;
1747
1748         /* Build a reply packet */
1749         memset(&msg, 0, sizeof(msg));
1750         msg.m_status = G.stratum < MAXSTRAT ? G.ntp_status : LI_ALARM;
1751         msg.m_status |= (query_status & VERSION_MASK);
1752         msg.m_status |= ((query_status & MODE_MASK) == MODE_CLIENT) ?
1753                          MODE_SERVER : MODE_SYM_PAS;
1754         msg.m_stratum = G.stratum;
1755         msg.m_ppoll = G.poll_exp;
1756         msg.m_precision_exp = G_precision_exp;
1757         /* this time was obtained between poll() and recv() */
1758         msg.m_rectime = d_to_lfp(G.cur_time);
1759         msg.m_xmttime = d_to_lfp(gettime1900d()); /* this instant */
1760         msg.m_reftime = d_to_lfp(G.reftime);
1761         msg.m_orgtime = query_xmttime;
1762         msg.m_rootdelay = d_to_sfp(G.rootdelay);
1763 //simple code does not do this, fix simple code!
1764         msg.m_rootdisp = d_to_sfp(G.rootdisp);
1765         version = (query_status & VERSION_MASK); /* ... >> VERSION_SHIFT - done below instead */
1766         msg.m_refid = G.refid; // (version > (3 << VERSION_SHIFT)) ? G.refid : G.refid3;
1767
1768         /* We reply from the local address packet was sent to,
1769          * this makes to/from look swapped here: */
1770         do_sendto(G.listen_fd,
1771                 /*from:*/ &to->u.sa, /*to:*/ from, /*addrlen:*/ to->len,
1772                 &msg, size);
1773
1774  bail:
1775         free(to);
1776         free(from);
1777 }
1778 #endif
1779
1780 /* Upstream ntpd's options:
1781  *
1782  * -4   Force DNS resolution of host names to the IPv4 namespace.
1783  * -6   Force DNS resolution of host names to the IPv6 namespace.
1784  * -a   Require cryptographic authentication for broadcast client,
1785  *      multicast client and symmetric passive associations.
1786  *      This is the default.
1787  * -A   Do not require cryptographic authentication for broadcast client,
1788  *      multicast client and symmetric passive associations.
1789  *      This is almost never a good idea.
1790  * -b   Enable the client to synchronize to broadcast servers.
1791  * -c conffile
1792  *      Specify the name and path of the configuration file,
1793  *      default /etc/ntp.conf
1794  * -d   Specify debugging mode. This option may occur more than once,
1795  *      with each occurrence indicating greater detail of display.
1796  * -D level
1797  *      Specify debugging level directly.
1798  * -f driftfile
1799  *      Specify the name and path of the frequency file.
1800  *      This is the same operation as the "driftfile FILE"
1801  *      configuration command.
1802  * -g   Normally, ntpd exits with a message to the system log
1803  *      if the offset exceeds the panic threshold, which is 1000 s
1804  *      by default. This option allows the time to be set to any value
1805  *      without restriction; however, this can happen only once.
1806  *      If the threshold is exceeded after that, ntpd will exit
1807  *      with a message to the system log. This option can be used
1808  *      with the -q and -x options. See the tinker command for other options.
1809  * -i jaildir
1810  *      Chroot the server to the directory jaildir. This option also implies
1811  *      that the server attempts to drop root privileges at startup
1812  *      (otherwise, chroot gives very little additional security).
1813  *      You may need to also specify a -u option.
1814  * -k keyfile
1815  *      Specify the name and path of the symmetric key file,
1816  *      default /etc/ntp/keys. This is the same operation
1817  *      as the "keys FILE" configuration command.
1818  * -l logfile
1819  *      Specify the name and path of the log file. The default
1820  *      is the system log file. This is the same operation as
1821  *      the "logfile FILE" configuration command.
1822  * -L   Do not listen to virtual IPs. The default is to listen.
1823  * -n   Don't fork.
1824  * -N   To the extent permitted by the operating system,
1825  *      run the ntpd at the highest priority.
1826  * -p pidfile
1827  *      Specify the name and path of the file used to record the ntpd
1828  *      process ID. This is the same operation as the "pidfile FILE"
1829  *      configuration command.
1830  * -P priority
1831  *      To the extent permitted by the operating system,
1832  *      run the ntpd at the specified priority.
1833  * -q   Exit the ntpd just after the first time the clock is set.
1834  *      This behavior mimics that of the ntpdate program, which is
1835  *      to be retired. The -g and -x options can be used with this option.
1836  *      Note: The kernel time discipline is disabled with this option.
1837  * -r broadcastdelay
1838  *      Specify the default propagation delay from the broadcast/multicast
1839  *      server to this client. This is necessary only if the delay
1840  *      cannot be computed automatically by the protocol.
1841  * -s statsdir
1842  *      Specify the directory path for files created by the statistics
1843  *      facility. This is the same operation as the "statsdir DIR"
1844  *      configuration command.
1845  * -t key
1846  *      Add a key number to the trusted key list. This option can occur
1847  *      more than once.
1848  * -u user[:group]
1849  *      Specify a user, and optionally a group, to switch to.
1850  * -v variable
1851  * -V variable
1852  *      Add a system variable listed by default.
1853  * -x   Normally, the time is slewed if the offset is less than the step
1854  *      threshold, which is 128 ms by default, and stepped if above
1855  *      the threshold. This option sets the threshold to 600 s, which is
1856  *      well within the accuracy window to set the clock manually.
1857  *      Note: since the slew rate of typical Unix kernels is limited
1858  *      to 0.5 ms/s, each second of adjustment requires an amortization
1859  *      interval of 2000 s. Thus, an adjustment as much as 600 s
1860  *      will take almost 14 days to complete. This option can be used
1861  *      with the -g and -q options. See the tinker command for other options.
1862  *      Note: The kernel time discipline is disabled with this option.
1863  */
1864
1865 /* By doing init in a separate function we decrease stack usage
1866  * in main loop.
1867  */
1868 static NOINLINE void ntp_init(char **argv)
1869 {
1870         unsigned opts;
1871         llist_t *peers;
1872
1873         srandom(getpid());
1874
1875         if (getuid())
1876                 bb_error_msg_and_die(bb_msg_you_must_be_root);
1877
1878         /* Set some globals */
1879         G.stratum = MAXSTRAT;
1880         if (BURSTPOLL != 0)
1881                 G.poll_exp = BURSTPOLL; /* speeds up initial sync */
1882         G.last_script_run = G.reftime = G.last_update_recv_time = gettime1900d(); /* sets G.cur_time too */
1883
1884         /* Parse options */
1885         peers = NULL;
1886         opt_complementary = "dd:p::wn"; /* d: counter; p: list; -w implies -n */
1887         opts = getopt32(argv,
1888                         "nqNx" /* compat */
1889                         "wp:S:"IF_FEATURE_NTPD_SERVER("l") /* NOT compat */
1890                         "d" /* compat */
1891                         "46aAbgL", /* compat, ignored */
1892                         &peers, &G.script_name, &G.verbose);
1893         if (!(opts & (OPT_p|OPT_l)))
1894                 bb_show_usage();
1895 //      if (opts & OPT_x) /* disable stepping, only slew is allowed */
1896 //              G.time_was_stepped = 1;
1897         while (peers)
1898                 add_peers(llist_pop(&peers));
1899         if (!(opts & OPT_n)) {
1900                 bb_daemonize_or_rexec(DAEMON_DEVNULL_STDIO, argv);
1901                 logmode = LOGMODE_NONE;
1902         }
1903 #if ENABLE_FEATURE_NTPD_SERVER
1904         G.listen_fd = -1;
1905         if (opts & OPT_l) {
1906                 G.listen_fd = create_and_bind_dgram_or_die(NULL, 123);
1907                 socket_want_pktinfo(G.listen_fd);
1908                 setsockopt(G.listen_fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
1909         }
1910 #endif
1911         /* I hesitate to set -20 prio. -15 should be high enough for timekeeping */
1912         if (opts & OPT_N)
1913                 setpriority(PRIO_PROCESS, 0, -15);
1914
1915         bb_signals((1 << SIGTERM) | (1 << SIGINT), record_signo);
1916         /* Removed SIGHUP here: */
1917         bb_signals((1 << SIGPIPE) | (1 << SIGCHLD), SIG_IGN);
1918 }
1919
1920 int ntpd_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
1921 int ntpd_main(int argc UNUSED_PARAM, char **argv)
1922 {
1923 #undef G
1924         struct globals G;
1925         struct pollfd *pfd;
1926         peer_t **idx2peer;
1927         unsigned cnt;
1928
1929         memset(&G, 0, sizeof(G));
1930         SET_PTR_TO_GLOBALS(&G);
1931
1932         ntp_init(argv);
1933
1934         /* If ENABLE_FEATURE_NTPD_SERVER, + 1 for listen_fd: */
1935         cnt = G.peer_cnt + ENABLE_FEATURE_NTPD_SERVER;
1936         idx2peer = xzalloc(sizeof(idx2peer[0]) * cnt);
1937         pfd = xzalloc(sizeof(pfd[0]) * cnt);
1938
1939         /* Countdown: we never sync before we sent INITIAL_SAMLPES+1
1940          * packets to each peer.
1941          * NB: if some peer is not responding, we may end up sending
1942          * fewer packets to it and more to other peers.
1943          * NB2: sync usually happens using INITIAL_SAMLPES packets,
1944          * since last reply does not come back instantaneously.
1945          */
1946         cnt = G.peer_cnt * (INITIAL_SAMLPES + 1);
1947
1948         while (!bb_got_signal) {
1949                 llist_t *item;
1950                 unsigned i, j;
1951                 int nfds, timeout;
1952                 double nextaction;
1953
1954                 /* Nothing between here and poll() blocks for any significant time */
1955
1956                 nextaction = G.cur_time + 3600;
1957
1958                 i = 0;
1959 #if ENABLE_FEATURE_NTPD_SERVER
1960                 if (G.listen_fd != -1) {
1961                         pfd[0].fd = G.listen_fd;
1962                         pfd[0].events = POLLIN;
1963                         i++;
1964                 }
1965 #endif
1966                 /* Pass over peer list, send requests, time out on receives */
1967                 for (item = G.ntp_peers; item != NULL; item = item->link) {
1968                         peer_t *p = (peer_t *) item->data;
1969
1970                         if (p->next_action_time <= G.cur_time) {
1971                                 if (p->p_fd == -1) {
1972                                         /* Time to send new req */
1973                                         if (--cnt == 0) {
1974                                                 G.initial_poll_complete = 1;
1975                                         }
1976                                         send_query_to_peer(p);
1977                                 } else {
1978                                         /* Timed out waiting for reply */
1979                                         close(p->p_fd);
1980                                         p->p_fd = -1;
1981                                         timeout = poll_interval(-2); /* -2: try a bit sooner */
1982                                         bb_error_msg("timed out waiting for %s, reach 0x%02x, next query in %us",
1983                                                         p->p_dotted, p->reachable_bits, timeout);
1984                                         set_next(p, timeout);
1985                                 }
1986                         }
1987
1988                         if (p->next_action_time < nextaction)
1989                                 nextaction = p->next_action_time;
1990
1991                         if (p->p_fd >= 0) {
1992                                 /* Wait for reply from this peer */
1993                                 pfd[i].fd = p->p_fd;
1994                                 pfd[i].events = POLLIN;
1995                                 idx2peer[i] = p;
1996                                 i++;
1997                         }
1998                 }
1999
2000                 timeout = nextaction - G.cur_time;
2001                 if (timeout < 0)
2002                         timeout = 0;
2003                 timeout++; /* (nextaction - G.cur_time) rounds down, compensating */
2004
2005                 /* Here we may block */
2006                 VERB2 bb_error_msg("poll %us, sockets:%u, poll interval:%us", timeout, i, 1 << G.poll_exp);
2007                 nfds = poll(pfd, i, timeout * 1000);
2008                 gettime1900d(); /* sets G.cur_time */
2009                 if (nfds <= 0) {
2010                         if (G.cur_time - G.last_script_run > 11*60) {
2011                                 /* Useful for updating battery-backed RTC and such */
2012                                 run_script("periodic", G.last_update_offset);
2013                                 gettime1900d(); /* sets G.cur_time */
2014                         }
2015                         continue;
2016                 }
2017
2018                 /* Process any received packets */
2019                 j = 0;
2020 #if ENABLE_FEATURE_NTPD_SERVER
2021                 if (G.listen_fd != -1) {
2022                         if (pfd[0].revents /* & (POLLIN|POLLERR)*/) {
2023                                 nfds--;
2024                                 recv_and_process_client_pkt(/*G.listen_fd*/);
2025                                 gettime1900d(); /* sets G.cur_time */
2026                         }
2027                         j = 1;
2028                 }
2029 #endif
2030                 for (; nfds != 0 && j < i; j++) {
2031                         if (pfd[j].revents /* & (POLLIN|POLLERR)*/) {
2032                                 nfds--;
2033                                 recv_and_process_peer_pkt(idx2peer[j]);
2034                                 gettime1900d(); /* sets G.cur_time */
2035                         }
2036                 }
2037         } /* while (!bb_got_signal) */
2038
2039         kill_myself_with_sig(bb_got_signal);
2040 }
2041
2042
2043
2044
2045
2046
2047 /*** openntpd-4.6 uses only adjtime, not adjtimex ***/
2048
2049 /*** ntp-4.2.6/ntpd/ntp_loopfilter.c - adjtimex usage ***/
2050
2051 #if 0
2052 static double
2053 direct_freq(double fp_offset)
2054 {
2055
2056 #ifdef KERNEL_PLL
2057         /*
2058          * If the kernel is enabled, we need the residual offset to
2059          * calculate the frequency correction.
2060          */
2061         if (pll_control && kern_enable) {
2062                 memset(&ntv, 0, sizeof(ntv));
2063                 ntp_adjtime(&ntv);
2064 #ifdef STA_NANO
2065                 clock_offset = ntv.offset / 1e9;
2066 #else /* STA_NANO */
2067                 clock_offset = ntv.offset / 1e6;
2068 #endif /* STA_NANO */
2069                 drift_comp = FREQTOD(ntv.freq);
2070         }
2071 #endif /* KERNEL_PLL */
2072         set_freq((fp_offset - clock_offset) / (current_time - clock_epoch) + drift_comp);
2073         wander_resid = 0;
2074         return drift_comp;
2075 }
2076
2077 static void
2078 set_freq(double freq) /* frequency update */
2079 {
2080         char tbuf[80];
2081
2082         drift_comp = freq;
2083
2084 #ifdef KERNEL_PLL
2085         /*
2086          * If the kernel is enabled, update the kernel frequency.
2087          */
2088         if (pll_control && kern_enable) {
2089                 memset(&ntv, 0, sizeof(ntv));
2090                 ntv.modes = MOD_FREQUENCY;
2091                 ntv.freq = DTOFREQ(drift_comp);
2092                 ntp_adjtime(&ntv);
2093                 snprintf(tbuf, sizeof(tbuf), "kernel %.3f PPM", drift_comp * 1e6);
2094                 report_event(EVNT_FSET, NULL, tbuf);
2095         } else {
2096                 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2097                 report_event(EVNT_FSET, NULL, tbuf);
2098         }
2099 #else /* KERNEL_PLL */
2100         snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2101         report_event(EVNT_FSET, NULL, tbuf);
2102 #endif /* KERNEL_PLL */
2103 }
2104
2105 ...
2106 ...
2107 ...
2108
2109 #ifdef KERNEL_PLL
2110         /*
2111          * This code segment works when clock adjustments are made using
2112          * precision time kernel support and the ntp_adjtime() system
2113          * call. This support is available in Solaris 2.6 and later,
2114          * Digital Unix 4.0 and later, FreeBSD, Linux and specially
2115          * modified kernels for HP-UX 9 and Ultrix 4. In the case of the
2116          * DECstation 5000/240 and Alpha AXP, additional kernel
2117          * modifications provide a true microsecond clock and nanosecond
2118          * clock, respectively.
2119          *
2120          * Important note: The kernel discipline is used only if the
2121          * step threshold is less than 0.5 s, as anything higher can
2122          * lead to overflow problems. This might occur if some misguided
2123          * lad set the step threshold to something ridiculous.
2124          */
2125         if (pll_control && kern_enable) {
2126
2127 #define MOD_BITS (MOD_OFFSET | MOD_MAXERROR | MOD_ESTERROR | MOD_STATUS | MOD_TIMECONST)
2128
2129                 /*
2130                  * We initialize the structure for the ntp_adjtime()
2131                  * system call. We have to convert everything to
2132                  * microseconds or nanoseconds first. Do not update the
2133                  * system variables if the ext_enable flag is set. In
2134                  * this case, the external clock driver will update the
2135                  * variables, which will be read later by the local
2136                  * clock driver. Afterwards, remember the time and
2137                  * frequency offsets for jitter and stability values and
2138                  * to update the frequency file.
2139                  */
2140                 memset(&ntv,  0, sizeof(ntv));
2141                 if (ext_enable) {
2142                         ntv.modes = MOD_STATUS;
2143                 } else {
2144 #ifdef STA_NANO
2145                         ntv.modes = MOD_BITS | MOD_NANO;
2146 #else /* STA_NANO */
2147                         ntv.modes = MOD_BITS;
2148 #endif /* STA_NANO */
2149                         if (clock_offset < 0)
2150                                 dtemp = -.5;
2151                         else
2152                                 dtemp = .5;
2153 #ifdef STA_NANO
2154                         ntv.offset = (int32)(clock_offset * 1e9 + dtemp);
2155                         ntv.constant = sys_poll;
2156 #else /* STA_NANO */
2157                         ntv.offset = (int32)(clock_offset * 1e6 + dtemp);
2158                         ntv.constant = sys_poll - 4;
2159 #endif /* STA_NANO */
2160                         ntv.esterror = (u_int32)(clock_jitter * 1e6);
2161                         ntv.maxerror = (u_int32)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
2162                         ntv.status = STA_PLL;
2163
2164                         /*
2165                          * Enable/disable the PPS if requested.
2166                          */
2167                         if (pps_enable) {
2168                                 if (!(pll_status & STA_PPSTIME))
2169                                         report_event(EVNT_KERN,
2170                                             NULL, "PPS enabled");
2171                                 ntv.status |= STA_PPSTIME | STA_PPSFREQ;
2172                         } else {
2173                                 if (pll_status & STA_PPSTIME)
2174                                         report_event(EVNT_KERN,
2175                                             NULL, "PPS disabled");
2176                                 ntv.status &= ~(STA_PPSTIME |
2177                                     STA_PPSFREQ);
2178                         }
2179                         if (sys_leap == LEAP_ADDSECOND)
2180                                 ntv.status |= STA_INS;
2181                         else if (sys_leap == LEAP_DELSECOND)
2182                                 ntv.status |= STA_DEL;
2183                 }
2184
2185                 /*
2186                  * Pass the stuff to the kernel. If it squeals, turn off
2187                  * the pps. In any case, fetch the kernel offset,
2188                  * frequency and jitter.
2189                  */
2190                 if (ntp_adjtime(&ntv) == TIME_ERROR) {
2191                         if (!(ntv.status & STA_PPSSIGNAL))
2192                                 report_event(EVNT_KERN, NULL,
2193                                     "PPS no signal");
2194                 }
2195                 pll_status = ntv.status;
2196 #ifdef STA_NANO
2197                 clock_offset = ntv.offset / 1e9;
2198 #else /* STA_NANO */
2199                 clock_offset = ntv.offset / 1e6;
2200 #endif /* STA_NANO */
2201                 clock_frequency = FREQTOD(ntv.freq);
2202
2203                 /*
2204                  * If the kernel PPS is lit, monitor its performance.
2205                  */
2206                 if (ntv.status & STA_PPSTIME) {
2207 #ifdef STA_NANO
2208                         clock_jitter = ntv.jitter / 1e9;
2209 #else /* STA_NANO */
2210                         clock_jitter = ntv.jitter / 1e6;
2211 #endif /* STA_NANO */
2212                 }
2213
2214 #if defined(STA_NANO) && NTP_API == 4
2215                 /*
2216                  * If the TAI changes, update the kernel TAI.
2217                  */
2218                 if (loop_tai != sys_tai) {
2219                         loop_tai = sys_tai;
2220                         ntv.modes = MOD_TAI;
2221                         ntv.constant = sys_tai;
2222                         ntp_adjtime(&ntv);
2223                 }
2224 #endif /* STA_NANO */
2225         }
2226 #endif /* KERNEL_PLL */
2227 #endif