src/timesync/timesyncd-manager.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include <sys/timex.h>
   5
   6 #include "sd-bus.h"
   7 #include "sd-event.h"
   8 #include "sd-network.h"
   9 #include "sd-resolve.h"
  10
  11 #include "list.h"
  12 #include "ratelimit.h"
  13 #include "time-util.h"
  14 #include "timesyncd-ntp-message.h"
  15
  16 typedef struct Manager Manager;
  17
  18 #include "timesyncd-server.h"
  19
  20 /*
  21  * "A client MUST NOT under any conditions use a poll interval less
  22  * than 15 seconds."
  23  */
  24 #define NTP_POLL_INTERVAL_MIN_USEC      (32 * USEC_PER_SEC)
  25 #define NTP_POLL_INTERVAL_MAX_USEC      (2048 * USEC_PER_SEC)
  26
  27 #define NTP_RETRY_INTERVAL_MIN_USEC     (15 * USEC_PER_SEC)
  28 #define NTP_RETRY_INTERVAL_MAX_USEC     (6 * 60 * USEC_PER_SEC) /* 6 minutes */
  29
  30 #define DEFAULT_CONNECTION_RETRY_USEC   (30 * USEC_PER_SEC)
  31
  32 #define DEFAULT_SAVE_TIME_INTERVAL_USEC (60 * USEC_PER_SEC)
  33
  34 #define STATE_DIR   "/var/lib/systemd/timesync"
  35 #define CLOCK_FILE  STATE_DIR "/clock"
  36
  37 struct Manager {
  38         sd_bus *bus;
  39         sd_event *event;
  40         sd_resolve *resolve;
  41
  42         LIST_HEAD(ServerName, system_servers);
  43         LIST_HEAD(ServerName, link_servers);
  44         LIST_HEAD(ServerName, fallback_servers);
  45
  46         bool have_fallbacks:1;
  47
  48         RateLimit ratelimit;
  49         bool exhausted_servers;
  50
  51         /* network */
  52         sd_event_source *network_event_source;
  53         sd_network_monitor *network_monitor;
  54
  55         /* peer */
  56         sd_resolve_query *resolve_query;
  57         sd_event_source *event_receive;
  58         ServerName *current_server_name;
  59         ServerAddress *current_server_address;
  60         int server_socket;
  61         int missed_replies;
  62         uint64_t packet_count;
  63         sd_event_source *event_timeout;
  64         bool talking;
  65
  66         /* last sent packet */
  67         struct timespec trans_time_mon;
  68         struct timespec trans_time;
  69         usec_t retry_interval;
  70         usec_t connection_retry_usec;
  71         bool pending;
  72
  73         /* poll timer */
  74         sd_event_source *event_timer;
  75         usec_t poll_interval_usec;
  76         usec_t poll_interval_min_usec;
  77         usec_t poll_interval_max_usec;
  78         bool poll_resync;
  79
  80         /* history data */
  81         struct {
  82                 double offset;
  83                 double delay;
  84         } samples[8];
  85         unsigned samples_idx;
  86         double samples_jitter;
  87         usec_t root_distance_max_usec;
  88
  89         /* last change */
  90         bool jumped;
  91         int64_t drift_freq;
  92
  93         /* watch for time changes */
  94         sd_event_source *event_clock_watch;
  95
  96         /* Retry connections */
  97         sd_event_source *event_retry;
  98
  99         /* RTC runs in local time, leave it alone */
 100         bool rtc_local_time;
 101
 102         /* NTP response */
 103         struct ntp_msg ntpmsg;
 104         struct timespec origin_time, dest_time;
 105         bool spike;
 106
 107         /* Indicates whether we ever managed to set the local clock from NTP */
 108         bool synchronized;
 109
 110         /* save time event */
 111         sd_event_source *event_save_time;
 112         usec_t save_time_interval_usec;
 113         bool save_on_exit;
 114 };
 115
 116 int manager_new(Manager **ret);
 117 Manager* manager_free(Manager *m);
 118
 119 DEFINE_TRIVIAL_CLEANUP_FUNC(Manager*, manager_free);
 120
 121 void manager_set_server_name(Manager *m, ServerName *n);
 122 void manager_set_server_address(Manager *m, ServerAddress *a);
 123 void manager_flush_server_names(Manager *m, ServerType t);
 124
 125 int manager_connect(Manager *m);
 126 void manager_disconnect(Manager *m);
 127
 128 int manager_setup_save_time_event(Manager *m);