hush: fix a bug in argv restoration after sourcing a file
[oweals/busybox.git] / networking / ntpd.c
index 0233ed82cc62c3bb94492cb7480276096bfd87c2..bfd5705fcd30a8ab2293eec6baa2c7a02ec6c119 100644 (file)
  * purpose. It is provided "as is" without express or implied warranty.
  ***********************************************************************
  */
+//config:config NTPD
+//config:      bool "ntpd"
+//config:      default y
+//config:      select PLATFORM_LINUX
+//config:      help
+//config:        The NTP client/server daemon.
+//config:
+//config:config FEATURE_NTPD_SERVER
+//config:      bool "Make ntpd usable as a NTP server"
+//config:      default y
+//config:      depends on NTPD
+//config:      help
+//config:        Make ntpd usable as a NTP server. If you disable this option
+//config:        ntpd will be usable only as a NTP client.
+//config:
+//config:config FEATURE_NTPD_CONF
+//config:      bool "Make ntpd understand /etc/ntp.conf"
+//config:      default y
+//config:      depends on NTPD
+//config:      help
+//config:        Make ntpd look in /etc/ntp.conf for peers. Only "server address"
+//config:        is supported.
+
+//applet:IF_NTPD(APPLET(ntpd, BB_DIR_USR_SBIN, BB_SUID_DROP))
+
+//kbuild:lib-$(CONFIG_NTPD) += ntpd.o
 
 //usage:#define ntpd_trivial_usage
 //usage:       "[-dnqNw"IF_FEATURE_NTPD_SERVER("l -I IFACE")"] [-S PROG] [-p PEER]..."
  *
  * Made some changes to speed up re-syncing after our clock goes bad
  * (tested with suspending my laptop):
- * - if largish offset (>= STEP_THRESHOLD * 8 == 1 sec) is seen
+ * - if largish offset (>= STEP_THRESHOLD == 1 sec) is seen
  *   from a peer, schedule next query for this peer soon
  *   without drastically lowering poll interval for everybody.
  *   This makes us collect enough data for step much faster:
 #define RETRY_INTERVAL    32    /* on send/recv error, retry in N secs (need to be power of 2) */
 #define NOREPLY_INTERVAL 512    /* sent, but got no reply: cap next query by this many seconds */
 #define RESPONSE_INTERVAL 16    /* wait for reply up to N secs */
+#define HOSTNAME_INTERVAL  5    /* hostname lookup failed. Wait N secs for next try */
 
 /* Step threshold (sec). std ntpd uses 0.128.
+ */
+#define STEP_THRESHOLD     1
+/* Slew threshold (sec): adjtimex() won't accept offsets larger than this.
  * Using exact power of 2 (1/8) results in smaller code
  */
-#define STEP_THRESHOLD  0.125
+#define SLEW_THRESHOLD 0.125
 /* Stepout threshold (sec). std ntpd uses 900 (11 mins (!)) */
-#define WATCH_THRESHOLD 128
+#define WATCH_THRESHOLD  128
 /* NB: set WATCH_THRESHOLD to ~60 when debugging to save time) */
 //UNUSED: #define PANIC_THRESHOLD 1000    /* panic threshold (sec) */
 
  * If we got |offset| > BIGOFF from a peer, cap next query interval
  * for this peer by this many seconds:
  */
-#define BIGOFF          (STEP_THRESHOLD * 8)
+#define BIGOFF          STEP_THRESHOLD
 #define BIGOFF_INTERVAL (1 << 7) /* 128 s */
 
 #define FREQ_TOLERANCE  0.000015 /* frequency tolerance (15 PPM) */
 #define MAXPOLL         12      /* maximum poll interval (12: 1.1h, 17: 36.4h). std ntpd uses 17 */
 /*
  * Actively lower poll when we see such big offsets.
- * With STEP_THRESHOLD = 0.125, it means we try to sync more aggressively
+ * With SLEW_THRESHOLD = 0.125, it means we try to sync more aggressively
  * if offset increases over ~0.04 sec
  */
-//#define POLLDOWN_OFFSET (STEP_THRESHOLD / 3)
+//#define POLLDOWN_OFFSET (SLEW_THRESHOLD / 3)
 #define MINDISP         0.01    /* minimum dispersion (sec) */
 #define MAXDISP         16      /* maximum dispersion (sec) */
 #define MAXSTRAT        16      /* maximum stratum (infinity metric) */
@@ -289,6 +319,7 @@ typedef struct {
        datapoint_t      filter_datapoint[NUM_DATAPOINTS];
        /* last sent packet: */
        msg_t            p_xmt_msg;
+       char             p_hostname[1];
 } peer_t;
 
 
@@ -405,8 +436,6 @@ struct globals {
 };
 #define G (*ptr_to_globals)
 
-static const int const_IPTOS_LOWDELAY = IPTOS_LOWDELAY;
-
 
 #define VERB1 if (MAX_VERBOSE && G.verbose)
 #define VERB2 if (MAX_VERBOSE >= 2 && G.verbose >= 2)
@@ -722,11 +751,11 @@ static void
 reset_peer_stats(peer_t *p, double offset)
 {
        int i;
-       bool small_ofs = fabs(offset) < 16 * STEP_THRESHOLD;
+       bool small_ofs = fabs(offset) < STEP_THRESHOLD;
 
        /* Used to set p->filter_datapoint[i].d_dispersion = MAXDISP
         * and clear reachable bits, but this proved to be too agressive:
-        * after step (tested with suspinding laptop for ~30 secs),
+        * after step (tested with suspending laptop for ~30 secs),
         * this caused all previous data to be considered invalid,
         * making us needing to collect full ~8 datapoins per peer
         * after step in order to start trusting them.
@@ -762,18 +791,51 @@ reset_peer_stats(peer_t *p, double offset)
        VERB6 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
 }
 
+static len_and_sockaddr*
+resolve_peer_hostname(peer_t *p)
+{
+       len_and_sockaddr *lsa = host2sockaddr(p->p_hostname, 123);
+       if (lsa) {
+               free(p->p_lsa);
+               free(p->p_dotted);
+               p->p_lsa = lsa;
+               p->p_dotted = xmalloc_sockaddr2dotted_noport(&lsa->u.sa);
+       } else {
+               /* error message is emitted by host2sockaddr() */
+               set_next(p, HOSTNAME_INTERVAL);
+       }
+       return lsa;
+}
+
 static void
 add_peers(const char *s)
 {
+       llist_t *item;
        peer_t *p;
 
-       p = xzalloc(sizeof(*p));
-       p->p_lsa = xhost2sockaddr(s, 123);
-       p->p_dotted = xmalloc_sockaddr2dotted_noport(&p->p_lsa->u.sa);
+       p = xzalloc(sizeof(*p) + strlen(s));
+       strcpy(p->p_hostname, s);
        p->p_fd = -1;
        p->p_xmt_msg.m_status = MODE_CLIENT | (NTP_VERSION << 3);
        p->next_action_time = G.cur_time; /* = set_next(p, 0); */
-       reset_peer_stats(p, 16 * STEP_THRESHOLD);
+       reset_peer_stats(p, STEP_THRESHOLD);
+
+       /* Names like N.<country2chars>.pool.ntp.org are randomly resolved
+        * to a pool of machines. Sometimes different N's resolve to the same IP.
+        * It is not useful to have two peers with same IP. We skip duplicates.
+        */
+       if (resolve_peer_hostname(p)) {
+               for (item = G.ntp_peers; item != NULL; item = item->link) {
+                       peer_t *pp = (peer_t *) item->data;
+                       if (pp->p_dotted && strcmp(p->p_dotted, pp->p_dotted) == 0) {
+                               bb_error_msg("duplicate peer %s (%s)", s, p->p_dotted);
+                               free(p->p_lsa);
+                               free(p->p_dotted);
+                               free(p);
+                               return;
+                       }
+               }
+       }
 
        llist_add_to(&G.ntp_peers, p);
        G.peer_cnt++;
@@ -802,6 +864,11 @@ do_sendto(int fd,
 static void
 send_query_to_peer(peer_t *p)
 {
+       if (!p->p_lsa) {
+               if (!resolve_peer_hostname(p))
+                       return;
+       }
+
        /* Why do we need to bind()?
         * See what happens when we don't bind:
         *
@@ -837,7 +904,7 @@ send_query_to_peer(peer_t *p)
 #if ENABLE_FEATURE_IPV6
                if (family == AF_INET)
 #endif
-                       setsockopt(fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
+                       setsockopt_int(fd, IPPROTO_IP, IP_TOS, IPTOS_LOWDELAY);
                free(local_lsa);
        }
 
@@ -1497,7 +1564,6 @@ update_local_clock(peer_t *p)
 #endif
                abs_offset = offset = 0;
                set_new_values(STATE_SYNC, offset, recv_time);
-
        } else { /* abs_offset <= STEP_THRESHOLD */
 
                /* The ratio is calculated before jitter is updated to make
@@ -1641,14 +1707,7 @@ update_local_clock(peer_t *p)
        tmx.freq = G.discipline_freq_drift * 65536e6;
 #endif
        tmx.modes = ADJ_OFFSET | ADJ_STATUS | ADJ_TIMECONST;// | ADJ_MAXERROR | ADJ_ESTERROR;
-       tmx.offset = (offset * 1000000); /* usec */
-       tmx.status = STA_PLL;
-       if (G.ntp_status & LI_PLUSSEC)
-               tmx.status |= STA_INS;
-       if (G.ntp_status & LI_MINUSSEC)
-               tmx.status |= STA_DEL;
-
-       tmx.constant = (int)G.poll_exp - 4 > 0 ? (int)G.poll_exp - 4 : 0;
+       tmx.constant = (int)G.poll_exp - 4;
        /* EXPERIMENTAL.
         * The below if statement should be unnecessary, but...
         * It looks like Linux kernel's PLL is far too gentle in changing
@@ -1659,8 +1718,27 @@ update_local_clock(peer_t *p)
         * To be on a safe side, let's do it only if offset is significantly
         * larger than jitter.
         */
-       if (tmx.constant > 0 && G.offset_to_jitter_ratio >= TIMECONST_HACK_GATE)
+       if (G.offset_to_jitter_ratio >= TIMECONST_HACK_GATE)
                tmx.constant--;
+       tmx.offset = (long)(offset * 1000000); /* usec */
+       if (SLEW_THRESHOLD < STEP_THRESHOLD) {
+               if (tmx.offset > (long)(SLEW_THRESHOLD * 1000000)) {
+                       tmx.offset = (long)(SLEW_THRESHOLD * 1000000);
+                       tmx.constant--;
+               }
+               if (tmx.offset < -(long)(SLEW_THRESHOLD * 1000000)) {
+                       tmx.offset = -(long)(SLEW_THRESHOLD * 1000000);
+                       tmx.constant--;
+               }
+       }
+       if (tmx.constant < 0)
+               tmx.constant = 0;
+
+       tmx.status = STA_PLL;
+       if (G.ntp_status & LI_PLUSSEC)
+               tmx.status |= STA_INS;
+       if (G.ntp_status & LI_MINUSSEC)
+               tmx.status |= STA_DEL;
 
        //tmx.esterror = (uint32_t)(clock_jitter * 1e6);
        //tmx.maxerror = (uint32_t)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
@@ -1673,8 +1751,14 @@ update_local_clock(peer_t *p)
        VERB4 bb_error_msg("adjtimex:%d freq:%ld offset:%+ld status:0x%x",
                                rc, tmx.freq, tmx.offset, tmx.status);
        G.kernel_freq_drift = tmx.freq / 65536;
-       VERB2 bb_error_msg("update from:%s offset:%+f jitter:%f clock drift:%+.3fppm tc:%d",
-                       p->p_dotted, offset, G.discipline_jitter, (double)tmx.freq / 65536, (int)tmx.constant);
+       VERB2 bb_error_msg("update from:%s offset:%+f delay:%f jitter:%f clock drift:%+.3fppm tc:%d",
+                       p->p_dotted,
+                       offset,
+                       p->lastpkt_delay,
+                       G.discipline_jitter,
+                       (double)tmx.freq / 65536,
+                       (int)tmx.constant
+       );
 
        return 1; /* "ok to increase poll interval" */
 }
@@ -1934,6 +2018,9 @@ recv_and_process_peer_pkt(peer_t *p)
  increase_interval:
                        adjust_poll(MINPOLL);
                } else {
+                       VERB3 if (rc > 0)
+                               bb_error_msg("want smaller interval: offset/jitter = %u",
+                                       G.offset_to_jitter_ratio);
                        adjust_poll(-G.poll_exp * 2);
                }
        }
@@ -1942,7 +2029,7 @@ recv_and_process_peer_pkt(peer_t *p)
  pick_normal_interval:
        interval = poll_interval(INT_MAX);
        if (fabs(offset) >= BIGOFF && interval > BIGOFF_INTERVAL) {
-               /* If we are synced, offsets are less than STEP_THRESHOLD,
+               /* If we are synced, offsets are less than SLEW_THRESHOLD,
                 * or at the very least not much larger than it.
                 * Now we see a largish one.
                 * Either this peer is feeling bad, or packet got corrupted,
@@ -1988,6 +2075,13 @@ recv_and_process_client_pkt(void /*int fd*/)
                goto bail;
        }
 
+       /* Respond only to client and symmetric active packets */
+       if ((msg.m_status & MODE_MASK) != MODE_CLIENT
+        && (msg.m_status & MODE_MASK) != MODE_SYM_ACT
+       ) {
+               goto bail;
+       }
+
        query_status = msg.m_status;
        query_xmttime = msg.m_xmttime;
 
@@ -2134,15 +2228,15 @@ static NOINLINE void ntp_init(char **argv)
 
        /* Parse options */
        peers = NULL;
-       opt_complementary = "dd:p::wn"         /* -d: counter; -p: list; -w implies -n */
+       opt_complementary = "dd:wn"  /* -d: counter; -p: list; -w implies -n */
                IF_FEATURE_NTPD_SERVER(":Il"); /* -I implies -l */
        opts = getopt32(argv,
                        "nqNx" /* compat */
-                       "wp:S:"IF_FEATURE_NTPD_SERVER("l") /* NOT compat */
+                       "wp:*S:"IF_FEATURE_NTPD_SERVER("l") /* NOT compat */
                        IF_FEATURE_NTPD_SERVER("I:") /* compat */
                        "d" /* compat */
                        "46aAbgL", /* compat, ignored */
-                       &peers,&G.script_name,
+                       &peers, &G.script_name,
 #if ENABLE_FEATURE_NTPD_SERVER
                        &G.if_name,
 #endif
@@ -2150,6 +2244,28 @@ static NOINLINE void ntp_init(char **argv)
 
 //     if (opts & OPT_x) /* disable stepping, only slew is allowed */
 //             G.time_was_stepped = 1;
+
+#if ENABLE_FEATURE_NTPD_SERVER
+       G_listen_fd = -1;
+       if (opts & OPT_l) {
+               G_listen_fd = create_and_bind_dgram_or_die(NULL, 123);
+               if (G.if_name) {
+                       if (setsockopt_bindtodevice(G_listen_fd, G.if_name))
+                               xfunc_die();
+               }
+               socket_want_pktinfo(G_listen_fd);
+               setsockopt_int(G_listen_fd, IPPROTO_IP, IP_TOS, IPTOS_LOWDELAY);
+       }
+#endif
+       /* I hesitate to set -20 prio. -15 should be high enough for timekeeping */
+       if (opts & OPT_N)
+               setpriority(PRIO_PROCESS, 0, -15);
+
+       if (!(opts & OPT_n)) {
+               bb_daemonize_or_rexec(DAEMON_DEVNULL_STDIO, argv);
+               logmode = LOGMODE_NONE;
+       }
+
        if (peers) {
                while (peers)
                        add_peers(llist_pop(&peers));
@@ -2178,26 +2294,6 @@ static NOINLINE void ntp_init(char **argv)
                /* -l but no peers: "stratum 1 server" mode */
                G.stratum = 1;
        }
-#if ENABLE_FEATURE_NTPD_SERVER
-       G_listen_fd = -1;
-       if (opts & OPT_l) {
-               G_listen_fd = create_and_bind_dgram_or_die(NULL, 123);
-               if (opts & OPT_I) {
-                       if (setsockopt_bindtodevice(G_listen_fd, G.if_name))
-                               xfunc_die();
-               }
-               socket_want_pktinfo(G_listen_fd);
-               setsockopt(G_listen_fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
-       }
-#endif
-       if (!(opts & OPT_n)) {
-               bb_daemonize_or_rexec(DAEMON_DEVNULL_STDIO, argv);
-               logmode = LOGMODE_NONE;
-       }
-       /* I hesitate to set -20 prio. -15 should be high enough for timekeeping */
-       if (opts & OPT_N)
-               setpriority(PRIO_PROCESS, 0, -15);
-
        /* If network is up, syncronization occurs in ~10 seconds.
         * We give "ntpd -q" 10 seconds to get first reply,
         * then another 50 seconds to finish syncing.
@@ -2296,6 +2392,11 @@ int ntpd_main(int argc UNUSED_PARAM, char **argv)
                                        timeout = poll_interval(NOREPLY_INTERVAL);
                                        bb_error_msg("timed out waiting for %s, reach 0x%02x, next query in %us",
                                                        p->p_dotted, p->reachable_bits, timeout);
+
+                                       /* What if don't see it because it changed its IP? */
+                                       if (p->reachable_bits == 0)
+                                               resolve_peer_hostname(p);
+
                                        set_next(p, timeout);
                                }
                        }