usr.sbin/dntpd/client.h

   1 /*
   2  * Copyright (c) 2005 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/usr.sbin/dntpd/client.h,v 1.2 2005/04/24 05:04:28 dillon Exp $
  35  */
  36
  37 struct server_info {
  38         int fd;
  39         char *target;
  40
  41         /*
  42          * A second linear regression playing hopskip with the first.
  43          */
  44         struct server_info *altinfo;
  45
  46         /*
  47          * Linear regression accumulator
  48          *
  49          * note: the starting base time is where all corrections get applied
  50          * to eventually.  The linear regression makes a relative microseconds
  51          * calculation between the current base time and the starting base
  52          * time to figure out what corrections the system has made to the
  53          * clock.
  54          */
  55         struct timeval lin_tv;  /* starting real time */
  56         struct timeval lin_btv; /* starting base time */
  57         double lin_count;       /* samples      */
  58         double lin_sumx;        /* sum(x)       */
  59         double lin_sumy;        /* sum(y)       */
  60         double lin_sumxy;       /* sum(x*y)     */
  61         double lin_sumx2;       /* sum(x^2)     */
  62         double lin_sumy2;       /* sum(y^2)     */
  63         double lin_sumoffset;   /* sum of uncompensated offsets */
  64
  65         /*
  66          * Cached results
  67          */
  68         double lin_cache_slope;
  69         double lin_cache_yint;
  70         double lin_cache_corr;
  71
  72         double lin_cache_offset; /* last offset correction (s) */
  73         double lin_cache_freq;  /* last frequency correction (s/s) */
  74 };
  75
  76 /*
  77  * We start a second linear regression a LIN_RESTART / 2 and it
  78  * replaces the first one (and we start a third) at LIN_RESTART.
  79  */
  80 #define LIN_RESTART     30
  81
  82 typedef struct server_info *server_info_t;
  83
  84 void client_init(void);
  85 int client_main(struct server_info **info_ary, int count);
  86 void client_poll(server_info_t info);
  87 struct server_info *client_check(struct server_info **check,
  88                                 struct server_info *best);
  89 void lin_regress(server_info_t info,
  90                  struct timeval *ltv, struct timeval *lbtv, double offset);
  91 void lin_reset(server_info_t info);
  92
  93