kernel/time/ntp.c

   1 /*
   2  * NTP state machine interfaces and logic.
   3  *
   4  * This code was mainly moved from kernel/timer.c and kernel/time.c
   5  * Please see those files for relevant copyright info and historical
   6  * changelogs.
   7  */
   8 #include <linux/capability.h>
   9 #include <linux/clocksource.h>
  10 #include <linux/workqueue.h>
  11 #include <linux/hrtimer.h>
  12 #include <linux/jiffies.h>
  13 #include <linux/math64.h>
  14 #include <linux/timex.h>
  15 #include <linux/time.h>
  16 #include <linux/mm.h>
  17
  18 /*
  19  * NTP timekeeping variables:
  20  */
  21
  22 /* USER_HZ period (usecs): */
  23 unsigned long                   tick_usec = TICK_USEC;
  24
  25 /* ACTHZ period (nsecs): */
  26 unsigned long                   tick_nsec;
  27
  28 u64                             tick_length;
  29 static u64                      tick_length_base;
  30
  31 static struct hrtimer           leap_timer;
  32
  33 #define MAX_TICKADJ             500LL           /* usecs */
  34 #define MAX_TICKADJ_SCALED \
  35         (((MAX_TICKADJ * NSEC_PER_USEC) << NTP_SCALE_SHIFT) / NTP_INTERVAL_FREQ)
  36
  37 /*
  38  * phase-lock loop variables
  39  */
  40
  41 /*
  42  * clock synchronization status
  43  *
  44  * (TIME_ERROR prevents overwriting the CMOS clock)
  45  */
  46 static int                      time_state = TIME_OK;
  47
  48 /* clock status bits:                                                   */
  49 int                             time_status = STA_UNSYNC;
  50
  51 /* TAI offset (secs):                                                   */
  52 static long                     time_tai;
  53
  54 /* time adjustment (nsecs):                                             */
  55 static s64                      time_offset;
  56
  57 /* pll time constant:                                                   */
  58 static long                     time_constant = 2;
  59
  60 /* maximum error (usecs):                                               */
  61 long                            time_maxerror = NTP_PHASE_LIMIT;
  62
  63 /* estimated error (usecs):                                             */
  64 long                            time_esterror = NTP_PHASE_LIMIT;
  65
  66 /* frequency offset (scaled nsecs/secs):                                */
  67 static s64                      time_freq;
  68
  69 /* time at last adjustment (secs):                                      */
  70 static long                     time_reftime;
  71
  72 long                            time_adjust;
  73
  74 static long                     ntp_tick_adj;
  75
  76 /*
  77  * NTP methods:
  78  */
  79
  80 static void ntp_update_frequency(void)
  81 {
  82         u64 old_tick_length_base = tick_length_base;
  83         u64 second_length = (u64)(tick_usec * NSEC_PER_USEC * USER_HZ)
  84                                 << NTP_SCALE_SHIFT;
  85         second_length += (s64)ntp_tick_adj << NTP_SCALE_SHIFT;
  86         second_length += time_freq;
  87
  88         tick_length_base = second_length;
  89
  90         tick_nsec = div_u64(second_length, HZ) >> NTP_SCALE_SHIFT;
  91         tick_length_base = div_u64(tick_length_base, NTP_INTERVAL_FREQ);
  92
  93         /*
  94          * Don't wait for the next second_overflow, apply
  95          * the change to the tick length immediately
  96          */
  97         tick_length += tick_length_base - old_tick_length_base;
  98 }
  99
 100 static void ntp_update_offset(long offset)
 101 {
 102         long mtemp;
 103         s64 freq_adj;
 104
 105         if (!(time_status & STA_PLL))
 106                 return;
 107
 108         if (!(time_status & STA_NANO))
 109                 offset *= NSEC_PER_USEC;
 110
 111         /*
 112          * Scale the phase adjustment and
 113          * clamp to the operating range.
 114          */
 115         offset = min(offset, MAXPHASE);
 116         offset = max(offset, -MAXPHASE);
 117
 118         /*
 119          * Select how the frequency is to be controlled
 120          * and in which mode (PLL or FLL).
 121          */
 122         if (time_status & STA_FREQHOLD || time_reftime == 0)
 123                 time_reftime = xtime.tv_sec;
 124         mtemp = xtime.tv_sec - time_reftime;
 125         time_reftime = xtime.tv_sec;
 126
 127         freq_adj = (s64)offset * mtemp;
 128         freq_adj <<= NTP_SCALE_SHIFT - 2 * (SHIFT_PLL + 2 + time_constant);
 129         time_status &= ~STA_MODE;
 130         if (mtemp >= MINSEC && (time_status & STA_FLL || mtemp > MAXSEC)) {
 131                 freq_adj += div_s64((s64)offset << (NTP_SCALE_SHIFT - SHIFT_FLL),
 132                                     mtemp);
 133                 time_status |= STA_MODE;
 134         }
 135         freq_adj += time_freq;
 136         freq_adj = min(freq_adj, MAXFREQ_SCALED);
 137         time_freq = max(freq_adj, -MAXFREQ_SCALED);
 138
 139         time_offset = div_s64((s64)offset << NTP_SCALE_SHIFT, NTP_INTERVAL_FREQ);
 140 }
 141
 142 /**
 143  * ntp_clear - Clears the NTP state variables
 144  *
 145  * Must be called while holding a write on the xtime_lock
 146  */
 147 void ntp_clear(void)
 148 {
 149         time_adjust     = 0;            /* stop active adjtime() */
 150         time_status     |= STA_UNSYNC;
 151         time_maxerror   = NTP_PHASE_LIMIT;
 152         time_esterror   = NTP_PHASE_LIMIT;
 153
 154         ntp_update_frequency();
 155
 156         tick_length     = tick_length_base;
 157         time_offset     = 0;
 158 }
 159
 160 /*
 161  * Leap second processing. If in leap-insert state at the end of the
 162  * day, the system clock is set back one second; if in leap-delete
 163  * state, the system clock is set ahead one second.
 164  */
 165 static enum hrtimer_restart ntp_leap_second(struct hrtimer *timer)
 166 {
 167         enum hrtimer_restart res = HRTIMER_NORESTART;
 168
 169         write_seqlock(&xtime_lock);
 170
 171         switch (time_state) {
 172         case TIME_OK:
 173                 break;
 174         case TIME_INS:
 175                 xtime.tv_sec--;
 176                 wall_to_monotonic.tv_sec++;
 177                 time_state = TIME_OOP;
 178                 printk(KERN_NOTICE
 179                         "Clock: inserting leap second 23:59:60 UTC\n");
 180                 hrtimer_add_expires_ns(&leap_timer, NSEC_PER_SEC);
 181                 res = HRTIMER_RESTART;
 182                 break;
 183         case TIME_DEL:
 184                 xtime.tv_sec++;
 185                 time_tai--;
 186                 wall_to_monotonic.tv_sec--;
 187                 time_state = TIME_WAIT;
 188                 printk(KERN_NOTICE
 189                         "Clock: deleting leap second 23:59:59 UTC\n");
 190                 break;
 191         case TIME_OOP:
 192                 time_tai++;
 193                 time_state = TIME_WAIT;
 194                 /* fall through */
 195         case TIME_WAIT:
 196                 if (!(time_status & (STA_INS | STA_DEL)))
 197                         time_state = TIME_OK;
 198                 break;
 199         }
 200         update_vsyscall(&xtime, clock);
 201
 202         write_sequnlock(&xtime_lock);
 203
 204         return res;
 205 }
 206
 207 /*
 208  * this routine handles the overflow of the microsecond field
 209  *
 210  * The tricky bits of code to handle the accurate clock support
 211  * were provided by Dave Mills (Mills@UDEL.EDU) of NTP fame.
 212  * They were originally developed for SUN and DEC kernels.
 213  * All the kudos should go to Dave for this stuff.
 214  */
 215 void second_overflow(void)
 216 {
 217         s64 time_adj;
 218
 219         /* Bump the maxerror field */
 220         time_maxerror += MAXFREQ / NSEC_PER_USEC;
 221         if (time_maxerror > NTP_PHASE_LIMIT) {
 222                 time_maxerror = NTP_PHASE_LIMIT;
 223                 time_status |= STA_UNSYNC;
 224         }
 225
 226         /*
 227          * Compute the phase adjustment for the next second. The offset is
 228          * reduced by a fixed factor times the time constant.
 229          */
 230         tick_length     = tick_length_base;
 231         time_adj        = shift_right(time_offset, SHIFT_PLL + time_constant);
 232         time_offset     -= time_adj;
 233         tick_length     += time_adj;
 234
 235         if (!time_adjust)
 236                 return;
 237
 238         if (time_adjust > MAX_TICKADJ) {
 239                 time_adjust -= MAX_TICKADJ;
 240                 tick_length += MAX_TICKADJ_SCALED;
 241                 return;
 242         }
 243
 244         if (time_adjust < -MAX_TICKADJ) {
 245                 time_adjust += MAX_TICKADJ;
 246                 tick_length -= MAX_TICKADJ_SCALED;
 247                 return;
 248         }
 249
 250         tick_length += (s64)(time_adjust * NSEC_PER_USEC / NTP_INTERVAL_FREQ)
 251                                                          << NTP_SCALE_SHIFT;
 252         time_adjust = 0;
 253 }
 254
 255 #ifdef CONFIG_GENERIC_CMOS_UPDATE
 256
 257 /* Disable the cmos update - used by virtualization and embedded */
 258 int no_sync_cmos_clock  __read_mostly;
 259
 260 static void sync_cmos_clock(struct work_struct *work);
 261
 262 static DECLARE_DELAYED_WORK(sync_cmos_work, sync_cmos_clock);
 263
 264 static void sync_cmos_clock(struct work_struct *work)
 265 {
 266         struct timespec now, next;
 267         int fail = 1;
 268
 269         /*
 270          * If we have an externally synchronized Linux clock, then update
 271          * CMOS clock accordingly every ~11 minutes. Set_rtc_mmss() has to be
 272          * called as close as possible to 500 ms before the new second starts.
 273          * This code is run on a timer.  If the clock is set, that timer
 274          * may not expire at the correct time.  Thus, we adjust...
 275          */
 276         if (!ntp_synced()) {
 277                 /*
 278                  * Not synced, exit, do not restart a timer (if one is
 279                  * running, let it run out).
 280                  */
 281                 return;
 282         }
 283
 284         getnstimeofday(&now);
 285         if (abs(now.tv_nsec - (NSEC_PER_SEC / 2)) <= tick_nsec / 2)
 286                 fail = update_persistent_clock(now);
 287
 288         next.tv_nsec = (NSEC_PER_SEC / 2) - now.tv_nsec - (TICK_NSEC / 2);
 289         if (next.tv_nsec <= 0)
 290                 next.tv_nsec += NSEC_PER_SEC;
 291
 292         if (!fail)
 293                 next.tv_sec = 659;
 294         else
 295                 next.tv_sec = 0;
 296
 297         if (next.tv_nsec >= NSEC_PER_SEC) {
 298                 next.tv_sec++;
 299                 next.tv_nsec -= NSEC_PER_SEC;
 300         }
 301         schedule_delayed_work(&sync_cmos_work, timespec_to_jiffies(&next));
 302 }
 303
 304 static void notify_cmos_timer(void)
 305 {
 306         if (!no_sync_cmos_clock)
 307                 schedule_delayed_work(&sync_cmos_work, 0);
 308 }
 309
 310 #else
 311 static inline void notify_cmos_timer(void) { }
 312 #endif
 313
 314 /*
 315  * adjtimex mainly allows reading (and writing, if superuser) of
 316  * kernel time-keeping variables. used by xntpd.
 317  */
 318 int do_adjtimex(struct timex *txc)
 319 {
 320         struct timespec ts;
 321         int result;
 322
 323         /* Validate the data before disabling interrupts */
 324         if (txc->modes & ADJ_ADJTIME) {
 325                 /* singleshot must not be used with any other mode bits */
 326                 if (!(txc->modes & ADJ_OFFSET_SINGLESHOT))
 327                         return -EINVAL;
 328                 if (!(txc->modes & ADJ_OFFSET_READONLY) &&
 329                     !capable(CAP_SYS_TIME))
 330                         return -EPERM;
 331         } else {
 332                 /* In order to modify anything, you gotta be super-user! */
 333                  if (txc->modes && !capable(CAP_SYS_TIME))
 334                         return -EPERM;
 335
 336                 /*
 337                  * if the quartz is off by more than 10% then
 338                  * something is VERY wrong!
 339                  */
 340                 if (txc->modes & ADJ_TICK &&
 341                     (txc->tick <  900000/USER_HZ ||
 342                      txc->tick > 1100000/USER_HZ))
 343                                 return -EINVAL;
 344
 345                 if (txc->modes & ADJ_STATUS && time_state != TIME_OK)
 346                         hrtimer_cancel(&leap_timer);
 347         }
 348
 349         getnstimeofday(&ts);
 350
 351         write_seqlock_irq(&xtime_lock);
 352
 353         /* If there are input parameters, then process them */
 354         if (txc->modes & ADJ_ADJTIME) {
 355                 long save_adjust = time_adjust;
 356
 357                 if (!(txc->modes & ADJ_OFFSET_READONLY)) {
 358                         /* adjtime() is independent from ntp_adjtime() */
 359                         time_adjust = txc->offset;
 360                         ntp_update_frequency();
 361                 }
 362                 txc->offset = save_adjust;
 363                 goto adj_done;
 364         }
 365         if (txc->modes) {
 366                 long sec;
 367
 368                 if (txc->modes & ADJ_STATUS) {
 369                         if ((time_status & STA_PLL) &&
 370                             !(txc->status & STA_PLL)) {
 371                                 time_state = TIME_OK;
 372                                 time_status = STA_UNSYNC;
 373                         }
 374                         /* only set allowed bits */
 375                         time_status &= STA_RONLY;
 376                         time_status |= txc->status & ~STA_RONLY;
 377
 378                         switch (time_state) {
 379                         case TIME_OK:
 380                         start_timer:
 381                                 sec = ts.tv_sec;
 382                                 if (time_status & STA_INS) {
 383                                         time_state = TIME_INS;
 384                                         sec += 86400 - sec % 86400;
 385                                         hrtimer_start(&leap_timer, ktime_set(sec, 0), HRTIMER_MODE_ABS);
 386                                 } else if (time_status & STA_DEL) {
 387                                         time_state = TIME_DEL;
 388                                         sec += 86400 - (sec + 1) % 86400;
 389                                         hrtimer_start(&leap_timer, ktime_set(sec, 0), HRTIMER_MODE_ABS);
 390                                 }
 391                                 break;
 392                         case TIME_INS:
 393                         case TIME_DEL:
 394                                 time_state = TIME_OK;
 395                                 goto start_timer;
 396                                 break;
 397                         case TIME_WAIT:
 398                                 if (!(time_status & (STA_INS | STA_DEL)))
 399                                         time_state = TIME_OK;
 400                                 break;
 401                         case TIME_OOP:
 402                                 hrtimer_restart(&leap_timer);
 403                                 break;
 404                         }
 405                 }
 406
 407                 if (txc->modes & ADJ_NANO)
 408                         time_status |= STA_NANO;
 409                 if (txc->modes & ADJ_MICRO)
 410                         time_status &= ~STA_NANO;
 411
 412                 if (txc->modes & ADJ_FREQUENCY) {
 413                         time_freq = (s64)txc->freq * PPM_SCALE;
 414                         time_freq = min(time_freq, MAXFREQ_SCALED);
 415                         time_freq = max(time_freq, -MAXFREQ_SCALED);
 416                 }
 417
 418                 if (txc->modes & ADJ_MAXERROR)
 419                         time_maxerror = txc->maxerror;
 420                 if (txc->modes & ADJ_ESTERROR)
 421                         time_esterror = txc->esterror;
 422
 423                 if (txc->modes & ADJ_TIMECONST) {
 424                         time_constant = txc->constant;
 425                         if (!(time_status & STA_NANO))
 426                                 time_constant += 4;
 427                         time_constant = min(time_constant, (long)MAXTC);
 428                         time_constant = max(time_constant, 0l);
 429                 }
 430
 431                 if (txc->modes & ADJ_TAI && txc->constant > 0)
 432                         time_tai = txc->constant;
 433
 434                 if (txc->modes & ADJ_OFFSET)
 435                         ntp_update_offset(txc->offset);
 436                 if (txc->modes & ADJ_TICK)
 437                         tick_usec = txc->tick;
 438
 439                 if (txc->modes & (ADJ_TICK|ADJ_FREQUENCY|ADJ_OFFSET))
 440                         ntp_update_frequency();
 441         }
 442
 443         txc->offset = shift_right(time_offset * NTP_INTERVAL_FREQ,
 444                                   NTP_SCALE_SHIFT);
 445         if (!(time_status & STA_NANO))
 446                 txc->offset /= NSEC_PER_USEC;
 447
 448 adj_done:
 449         result = time_state;    /* mostly `TIME_OK' */
 450         if (time_status & (STA_UNSYNC|STA_CLOCKERR))
 451                 result = TIME_ERROR;
 452
 453         txc->freq          = shift_right((time_freq >> PPM_SCALE_INV_SHIFT) *
 454                                          (s64)PPM_SCALE_INV, NTP_SCALE_SHIFT);
 455         txc->maxerror      = time_maxerror;
 456         txc->esterror      = time_esterror;
 457         txc->status        = time_status;
 458         txc->constant      = time_constant;
 459         txc->precision     = 1;
 460         txc->tolerance     = MAXFREQ_SCALED / PPM_SCALE;
 461         txc->tick          = tick_usec;
 462         txc->tai           = time_tai;
 463
 464         /* PPS is not implemented, so these are zero */
 465         txc->ppsfreq       = 0;
 466         txc->jitter        = 0;
 467         txc->shift         = 0;
 468         txc->stabil        = 0;
 469         txc->jitcnt        = 0;
 470         txc->calcnt        = 0;
 471         txc->errcnt        = 0;
 472         txc->stbcnt        = 0;
 473         write_sequnlock_irq(&xtime_lock);
 474
 475         txc->time.tv_sec = ts.tv_sec;
 476         txc->time.tv_usec = ts.tv_nsec;
 477         if (!(time_status & STA_NANO))
 478                 txc->time.tv_usec /= NSEC_PER_USEC;
 479
 480         notify_cmos_timer();
 481
 482         return result;
 483 }
 484
 485 static int __init ntp_tick_adj_setup(char *str)
 486 {
 487         ntp_tick_adj = simple_strtol(str, NULL, 0);
 488         return 1;
 489 }
 490
 491 __setup("ntp_tick_adj=", ntp_tick_adj_setup);
 492
 493 void __init ntp_init(void)
 494 {
 495         ntp_clear();
 496         hrtimer_init(&leap_timer, CLOCK_REALTIME, HRTIMER_MODE_ABS);
 497         leap_timer.function = ntp_leap_second;
 498 }