package timesource import ( "bytes" "context" "errors" "sort" "sync" "time" "github.com/beevik/ntp" "go.uber.org/zap" "github.com/status-im/status-go/common" "github.com/status-im/status-go/logutils" ) const ( // DefaultMaxAllowedFailures defines how many failures will be tolerated. DefaultMaxAllowedFailures = 4 // FastNTPSyncPeriod period between ntp synchronizations before the first // successful connection. FastNTPSyncPeriod = 2 * time.Minute // SlowNTPSyncPeriod period between ntp synchronizations after the first // successful connection. SlowNTPSyncPeriod = 1 * time.Hour // DefaultRPCTimeout defines write deadline for single ntp server request. DefaultRPCTimeout = 2 * time.Second ) // defaultServers will be resolved to the closest available, // and with high probability resolved to the different IPs var defaultServers = []string{ "time.apple.com", "pool.ntp.org", "time.cloudflare.com", "time.windows.com", "ntp.neu.edu.cn", "ntp.nict.jp", "amazon.pool.ntp.org", "android.pool.ntp.org", } var errUpdateOffset = errors.New("failed to compute offset") type ntpQuery func(string, ntp.QueryOptions) (*ntp.Response, error) type queryResponse struct { Offset time.Duration Error error } type multiRPCError []error func (e multiRPCError) Error() string { var b bytes.Buffer b.WriteString("RPC failed: ") more := false for _, err := range e { if more { b.WriteString("; ") } b.WriteString(err.Error()) more = true } b.WriteString(".") return b.String() } func computeOffset(timeQuery ntpQuery, servers []string, allowedFailures int) (time.Duration, error) { if len(servers) == 0 { return 0, nil } responses := make(chan queryResponse, len(servers)) for _, server := range servers { go func(server string) { defer common.LogOnPanic() response, err := timeQuery(server, ntp.QueryOptions{ Timeout: DefaultRPCTimeout, }) if err == nil { err = response.Validate() } if err != nil { responses <- queryResponse{Error: err} return } responses <- queryResponse{Offset: response.ClockOffset} }(server) } var ( rpcErrors multiRPCError offsets []time.Duration collected int ) for response := range responses { if response.Error != nil { rpcErrors = append(rpcErrors, response.Error) } else { offsets = append(offsets, response.Offset) } collected++ if collected == len(servers) { break } } if lth := len(rpcErrors); lth > allowedFailures { return 0, rpcErrors } else if lth == len(servers) { return 0, rpcErrors } sort.SliceStable(offsets, func(i, j int) bool { return offsets[i] > offsets[j] }) mid := len(offsets) / 2 if len(offsets)%2 == 0 { return (offsets[mid-1] + offsets[mid]) / 2, nil } return offsets[mid], nil } var defaultTimeSource = &NTPTimeSource{ servers: defaultServers, allowedFailures: DefaultMaxAllowedFailures, fastNTPSyncPeriod: FastNTPSyncPeriod, slowNTPSyncPeriod: SlowNTPSyncPeriod, timeQuery: ntp.QueryWithOptions, now: time.Now, } // Default initializes time source with default config values. func Default() *NTPTimeSource { return defaultTimeSource } // NTPTimeSource provides source of time that tries to be resistant to time skews. // It does so by periodically querying time offset from ntp servers. type NTPTimeSource struct { servers []string allowedFailures int fastNTPSyncPeriod time.Duration slowNTPSyncPeriod time.Duration timeQuery ntpQuery // for ease of testing now func() time.Time started bool cancel context.CancelFunc mu sync.RWMutex latestOffset time.Duration } // Now returns time adjusted by latest known offset func (s *NTPTimeSource) Now() time.Time { s.mu.RLock() defer s.mu.RUnlock() n := s.now() return n.Add(s.latestOffset) } func (s *NTPTimeSource) updateOffset() error { offset, err := computeOffset(s.timeQuery, s.servers, s.allowedFailures) if err != nil { logutils.ZapLogger().Error("failed to compute offset", zap.Error(err)) return errUpdateOffset } logutils.ZapLogger().Info("Difference with ntp servers", zap.Duration("offset", offset)) s.mu.Lock() defer s.mu.Unlock() s.latestOffset = offset return nil } // runPeriodically runs periodically the given function based on NTPTimeSource // synchronization limits (fastNTPSyncPeriod / slowNTPSyncPeriod) func (s *NTPTimeSource) runPeriodically(ctx context.Context, fn func() error, starWithSlowSyncPeriod bool) { if s.started { return } period := s.fastNTPSyncPeriod if starWithSlowSyncPeriod { period = s.slowNTPSyncPeriod } go func() { defer common.LogOnPanic() for { select { case <-time.After(period): if err := fn(); err == nil { period = s.slowNTPSyncPeriod } else if period != s.slowNTPSyncPeriod { period = s.fastNTPSyncPeriod } case <-ctx.Done(): return } } }() } // Start initializes the local offset and starts a goroutine that periodically updates the local offset. func (s *NTPTimeSource) Start(ctx context.Context) error { if s.started { return nil } ctx, cancel := context.WithCancel(ctx) // Attempt to update the offset synchronously so that user can have reliable messages right away err := s.updateOffset() if err != nil { // Failure to update can occur if the node is offline. // Instead of returning an error, continue with the process as the update will be retried periodically. logutils.ZapLogger().Error("failed to update offset", zap.Error(err)) } s.runPeriodically(ctx, s.updateOffset, err == nil) s.started = true s.cancel = cancel return nil } // Stop goroutine that updates time source. func (s *NTPTimeSource) Stop() { if s.cancel == nil { return } s.cancel() s.started = false } func (s *NTPTimeSource) GetCurrentTime() time.Time { err := s.Start(context.Background()) if err != nil { panic("could not obtain timesource") } return s.Now() } func (s *NTPTimeSource) GetCurrentTimeInMillis() uint64 { return convertToMillis(s.GetCurrentTime()) } func GetCurrentTime() time.Time { ts := Default() err := ts.Start(context.Background()) if err != nil { panic("could not obtain timesource") } return ts.Now() } func GetCurrentTimeInMillis() uint64 { return convertToMillis(GetCurrentTime()) } func convertToMillis(t time.Time) uint64 { return uint64(t.UnixNano() / int64(time.Millisecond)) }