lib/mktime.c

   1 /* Convert a `struct tm' to a time_t value.
   2    Copyright (C) 1993-1999, 2002 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4    Contributed by Paul Eggert (eggert@twinsun.com).
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    The GNU C Library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with the GNU C Library; if not, write to the Free
  18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19    02111-1307 USA.  */
  20
  21 /* Define this to have a standalone program to test this implementation of
  22    mktime.  */
  23 /* #define DEBUG 1 */
  24
  25 #ifdef HAVE_CONFIG_H
  26 # include <config.h>
  27 #endif
  28
  29 #ifdef _LIBC
  30 # define HAVE_LIMITS_H 1
  31 # define STDC_HEADERS 1
  32 # define STATIC /* empty */
  33 #else
  34 # define STATIC static
  35 #endif
  36
  37 /* Assume that leap seconds are possible, unless told otherwise.
  38    If the host has a `zic' command with a `-L leapsecondfilename' option,
  39    then it supports leap seconds; otherwise it probably doesn't.  */
  40 #ifndef LEAP_SECONDS_POSSIBLE
  41 # define LEAP_SECONDS_POSSIBLE 1
  42 #endif
  43
  44 #include <sys/types.h>          /* Some systems define `time_t' here.  */
  45 #include <time.h>
  46
  47 #if HAVE_LIMITS_H
  48 # include <limits.h>
  49 #endif
  50
  51 #if DEBUG
  52 # include <stdio.h>
  53 # if STDC_HEADERS
  54 #  include <stdlib.h>
  55 # endif
  56 /* Make it work even if the system's libc has its own mktime routine.  */
  57 # define mktime my_mktime
  58 #endif /* DEBUG */
  59
  60 #ifndef __P
  61 # if defined __GNUC__ || (defined __STDC__ && __STDC__)
  62 #  define __P(args) args
  63 # else
  64 #  define __P(args) ()
  65 # endif  /* GCC.  */
  66 #endif  /* Not __P.  */
  67
  68 #ifndef CHAR_BIT
  69 # define CHAR_BIT 8
  70 #endif
  71
  72 /* The extra casts work around common compiler bugs.  */
  73 #define TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
  74 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
  75    It is necessary at least when t == time_t.  */
  76 #define TYPE_MINIMUM(t) ((t) (TYPE_SIGNED (t) \
  77                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
  78 #define TYPE_MAXIMUM(t) ((t) (~ (t) 0 - TYPE_MINIMUM (t)))
  79
  80 #ifndef INT_MIN
  81 # define INT_MIN TYPE_MINIMUM (int)
  82 #endif
  83 #ifndef INT_MAX
  84 # define INT_MAX TYPE_MAXIMUM (int)
  85 #endif
  86
  87 #ifndef TIME_T_MIN
  88 # define TIME_T_MIN TYPE_MINIMUM (time_t)
  89 #endif
  90 #ifndef TIME_T_MAX
  91 # define TIME_T_MAX TYPE_MAXIMUM (time_t)
  92 #endif
  93
  94 #define TM_YEAR_BASE 1900
  95 #define EPOCH_YEAR 1970
  96
  97 #ifndef __isleap
  98 /* Nonzero if YEAR is a leap year (every 4 years,
  99    except every 100th isn't, and every 400th is).  */
 100 # define __isleap(year) \
 101   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
 102 #endif
 103
 104 /* How many days come before each month (0-12).  */
 105 STATIC const unsigned short int __mon_yday[2][13] =
 106   {
 107     /* Normal years.  */
 108     { 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334, 365 },
 109     /* Leap years.  */
 110     { 0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335, 366 }
 111   };
 112
 113
 114 #ifdef _LIBC
 115 # define my_mktime_localtime_r __localtime_r
 116 #else
 117 /* If we're a mktime substitute in a GNU program, then prefer
 118    localtime to localtime_r, since many localtime_r implementations
 119    are buggy.  */
 120 static struct tm *
 121 my_mktime_localtime_r (const time_t *t, struct tm *tp)
 122 {
 123   struct tm *l = localtime (t);
 124   if (! l)
 125     return 0;
 126   *tp = *l;
 127   return tp;
 128 }
 129 #endif /* ! _LIBC */
 130
 131
 132 /* Yield the difference between (YEAR-YDAY HOUR:MIN:SEC) and (*TP),
 133    measured in seconds, ignoring leap seconds.
 134    YEAR uses the same numbering as TM->tm_year.
 135    All values are in range, except possibly YEAR.
 136    If TP is null, return a nonzero value.
 137    If overflow occurs, yield the low order bits of the correct answer.  */
 138 static time_t
 139 ydhms_tm_diff (int year, int yday, int hour, int min, int sec,
 140                const struct tm *tp)
 141 {
 142   if (!tp)
 143     return 1;
 144   else
 145     {
 146       /* Compute intervening leap days correctly even if year is negative.
 147          Take care to avoid int overflow.  time_t overflow is OK, since
 148          only the low order bits of the correct time_t answer are needed.
 149          Don't convert to time_t until after all divisions are done, since
 150          time_t might be unsigned.  */
 151       int a4 = (year >> 2) + (TM_YEAR_BASE >> 2) - ! (year & 3);
 152       int b4 = (tp->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (tp->tm_year & 3);
 153       int a100 = a4 / 25 - (a4 % 25 < 0);
 154       int b100 = b4 / 25 - (b4 % 25 < 0);
 155       int a400 = a100 >> 2;
 156       int b400 = b100 >> 2;
 157       int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
 158       time_t years = year - (time_t) tp->tm_year;
 159       time_t days = (365 * years + intervening_leap_days
 160                      + (yday - tp->tm_yday));
 161       return (60 * (60 * (24 * days + (hour - tp->tm_hour))
 162                     + (min - tp->tm_min))
 163               + (sec - tp->tm_sec));
 164     }
 165 }
 166
 167 /* Use CONVERT to convert *T to a broken down time in *TP.
 168    If *T is out of range for conversion, adjust it so that
 169    it is the nearest in-range value and then convert that.  */
 170 static struct tm *
 171 ranged_convert (struct tm *(*convert) (const time_t *, struct tm *),
 172                 time_t *t, struct tm *tp)
 173 {
 174   struct tm *r;
 175
 176   if (! (r = (*convert) (t, tp)) && *t)
 177     {
 178       time_t bad = *t;
 179       time_t ok = 0;
 180       struct tm tm;
 181
 182       /* BAD is a known unconvertible time_t, and OK is a known good one.
 183          Use binary search to narrow the range between BAD and OK until
 184          they differ by 1.  */
 185       while (bad != ok + (bad < 0 ? -1 : 1))
 186         {
 187           time_t mid = *t = (bad < 0
 188                              ? bad + ((ok - bad) >> 1)
 189                              : ok + ((bad - ok) >> 1));
 190           if ((r = (*convert) (t, tp)))
 191             {
 192               tm = *r;
 193               ok = mid;
 194             }
 195           else
 196             bad = mid;
 197         }
 198
 199       if (!r && ok)
 200         {
 201           /* The last conversion attempt failed;
 202              revert to the most recent successful attempt.  */
 203           *t = ok;
 204           *tp = tm;
 205           r = tp;
 206         }
 207     }
 208
 209   return r;
 210 }
 211
 212
 213 /* Convert *TP to a time_t value, inverting
 214    the monotonic and mostly-unit-linear conversion function CONVERT.
 215    Use *OFFSET to keep track of a guess at the offset of the result,
 216    compared to what the result would be for UTC without leap seconds.
 217    If *OFFSET's guess is correct, only one CONVERT call is needed.  */
 218 STATIC time_t
 219 __mktime_internal (struct tm *tp,
 220                    struct tm *(*convert) (const time_t *, struct tm *),
 221                    time_t *offset)
 222 {
 223   time_t t, dt, t0, t1, t2;
 224   struct tm tm;
 225
 226   /* The maximum number of probes (calls to CONVERT) should be enough
 227      to handle any combinations of time zone rule changes, solar time,
 228      leap seconds, and oscillations around a spring-forward gap.
 229      POSIX.1 prohibits leap seconds, but some hosts have them anyway.  */
 230   int remaining_probes = 6;
 231
 232   /* Time requested.  Copy it in case CONVERT modifies *TP; this can
 233      occur if TP is localtime's returned value and CONVERT is localtime.  */
 234   int sec = tp->tm_sec;
 235   int min = tp->tm_min;
 236   int hour = tp->tm_hour;
 237   int mday = tp->tm_mday;
 238   int mon = tp->tm_mon;
 239   int year_requested = tp->tm_year;
 240   int isdst = tp->tm_isdst;
 241
 242   /* Ensure that mon is in range, and set year accordingly.  */
 243   int mon_remainder = mon % 12;
 244   int negative_mon_remainder = mon_remainder < 0;
 245   int mon_years = mon / 12 - negative_mon_remainder;
 246   int year = year_requested + mon_years;
 247
 248   /* The other values need not be in range:
 249      the remaining code handles minor overflows correctly,
 250      assuming int and time_t arithmetic wraps around.
 251      Major overflows are caught at the end.  */
 252
 253   /* Calculate day of year from year, month, and day of month.
 254      The result need not be in range.  */
 255   int yday = ((__mon_yday[__isleap (year + TM_YEAR_BASE)]
 256                [mon_remainder + 12 * negative_mon_remainder])
 257               + mday - 1);
 258
 259   int sec_requested = sec;
 260 #if LEAP_SECONDS_POSSIBLE
 261   /* Handle out-of-range seconds specially,
 262      since ydhms_tm_diff assumes every minute has 60 seconds.  */
 263   if (sec < 0)
 264     sec = 0;
 265   if (59 < sec)
 266     sec = 59;
 267 #endif
 268
 269   /* Invert CONVERT by probing.  First assume the same offset as last time.
 270      Then repeatedly use the error to improve the guess.  */
 271
 272   tm.tm_year = EPOCH_YEAR - TM_YEAR_BASE;
 273   tm.tm_yday = tm.tm_hour = tm.tm_min = tm.tm_sec = 0;
 274   t0 = ydhms_tm_diff (year, yday, hour, min, sec, &tm);
 275
 276   for (t = t1 = t2 = t0 + *offset;
 277        (dt = ydhms_tm_diff (year, yday, hour, min, sec,
 278                             ranged_convert (convert, &t, &tm)));
 279        t1 = t2, t2 = t, t += dt)
 280     if (t == t1 && t != t2
 281         && (isdst < 0 || tm.tm_isdst < 0
 282             || (isdst != 0) != (tm.tm_isdst != 0)))
 283       /* We can't possibly find a match, as we are oscillating
 284          between two values.  The requested time probably falls
 285          within a spring-forward gap of size DT.  Follow the common
 286          practice in this case, which is to return a time that is DT
 287          away from the requested time, preferring a time whose
 288          tm_isdst differs from the requested value.  In practice,
 289          this is more useful than returning -1.  */
 290       break;
 291     else if (--remaining_probes == 0)
 292       return -1;
 293
 294   /* If we have a match, check whether tm.tm_isdst has the requested
 295      value, if any.  */
 296   if (dt == 0 && isdst != tm.tm_isdst && 0 <= isdst && 0 <= tm.tm_isdst)
 297     {
 298       /* tm.tm_isdst has the wrong value.  Look for a neighboring
 299          time with the right value, and use its UTC offset.
 300          Heuristic: probe the previous three calendar quarters (approximately),
 301          looking for the desired isdst.  This isn't perfect,
 302          but it's good enough in practice.  */
 303       int quarter = 7889238; /* seconds per average 1/4 Gregorian year */
 304       int i;
 305
 306       /* If we're too close to the time_t limit, look in future quarters.  */
 307       if (t < TIME_T_MIN + 3 * quarter)
 308         quarter = -quarter;
 309
 310       for (i = 1; i <= 3; i++)
 311         {
 312           time_t ot = t - i * quarter;
 313           struct tm otm;
 314           ranged_convert (convert, &ot, &otm);
 315           if (otm.tm_isdst == isdst)
 316             {
 317               /* We found the desired tm_isdst.
 318                  Extrapolate back to the desired time.  */
 319               t = ot + ydhms_tm_diff (year, yday, hour, min, sec, &otm);
 320               ranged_convert (convert, &t, &tm);
 321               break;
 322             }
 323         }
 324     }
 325
 326   *offset = t - t0;
 327
 328 #if LEAP_SECONDS_POSSIBLE
 329   if (sec_requested != tm.tm_sec)
 330     {
 331       /* Adjust time to reflect the tm_sec requested, not the normalized value.
 332          Also, repair any damage from a false match due to a leap second.  */
 333       t += sec_requested - sec + (sec == 0 && tm.tm_sec == 60);
 334       if (! (*convert) (&t, &tm))
 335         return -1;
 336     }
 337 #endif
 338
 339   if (TIME_T_MAX / INT_MAX / 366 / 24 / 60 / 60 < 3)
 340     {
 341       /* time_t isn't large enough to rule out overflows in ydhms_tm_diff,
 342          so check for major overflows.  A gross check suffices,
 343          since if t has overflowed, it is off by a multiple of
 344          TIME_T_MAX - TIME_T_MIN + 1.  So ignore any component of
 345          the difference that is bounded by a small value.  */
 346
 347       double dyear = (double) year_requested + mon_years - tm.tm_year;
 348       double dday = 366 * dyear + mday;
 349       double dsec = 60 * (60 * (24 * dday + hour) + min) + sec_requested;
 350
 351       /* On Irix4.0.5 cc, dividing TIME_T_MIN by 3 does not produce
 352          correct results, ie., it erroneously gives a positive value
 353          of 715827882.  Setting a variable first then doing math on it
 354          seems to work.  (ghazi@caip.rutgers.edu) */
 355
 356       const time_t time_t_max = TIME_T_MAX;
 357       const time_t time_t_min = TIME_T_MIN;
 358
 359       if (time_t_max / 3 - time_t_min / 3 < (dsec < 0 ? - dsec : dsec))
 360         return -1;
 361     }
 362
 363   *tp = tm;
 364   return t;
 365 }
 366
 367
 368 static time_t localtime_offset;
 369
 370 /* Convert *TP to a time_t value.  */
 371 time_t
 372 mktime (tp)
 373      struct tm *tp;
 374 {
 375 #ifdef _LIBC
 376   /* POSIX.1 8.1.1 requires that whenever mktime() is called, the
 377      time zone names contained in the external variable `tzname' shall
 378      be set as if the tzset() function had been called.  */
 379   __tzset ();
 380 #endif
 381
 382   return __mktime_internal (tp, my_mktime_localtime_r, &localtime_offset);
 383 }
 384
 385 #ifdef weak_alias
 386 weak_alias (mktime, timelocal)
 387 #endif
 388 \f
 389 #if DEBUG
 390
 391 static int
 392 not_equal_tm (a, b)
 393      struct tm *a;
 394      struct tm *b;
 395 {
 396   return ((a->tm_sec ^ b->tm_sec)
 397           | (a->tm_min ^ b->tm_min)
 398           | (a->tm_hour ^ b->tm_hour)
 399           | (a->tm_mday ^ b->tm_mday)
 400           | (a->tm_mon ^ b->tm_mon)
 401           | (a->tm_year ^ b->tm_year)
 402           | (a->tm_mday ^ b->tm_mday)
 403           | (a->tm_yday ^ b->tm_yday)
 404           | (a->tm_isdst ^ b->tm_isdst));
 405 }
 406
 407 static void
 408 print_tm (tp)
 409      struct tm *tp;
 410 {
 411   if (tp)
 412     printf ("%04d-%02d-%02d %02d:%02d:%02d yday %03d wday %d isdst %d",
 413             tp->tm_year + TM_YEAR_BASE, tp->tm_mon + 1, tp->tm_mday,
 414             tp->tm_hour, tp->tm_min, tp->tm_sec,
 415             tp->tm_yday, tp->tm_wday, tp->tm_isdst);
 416   else
 417     printf ("0");
 418 }
 419
 420 static int
 421 check_result (tk, tmk, tl, lt)
 422      time_t tk;
 423      struct tm tmk;
 424      time_t tl;
 425      struct tm *lt;
 426 {
 427   if (tk != tl || !lt || not_equal_tm (&tmk, lt))
 428     {
 429       printf ("mktime (");
 430       print_tm (&tmk);
 431       printf (")\nyields (");
 432       print_tm (lt);
 433       printf (") == %ld, should be %ld\n", (long) tl, (long) tk);
 434       return 1;
 435     }
 436
 437   return 0;
 438 }
 439
 440 int
 441 main (argc, argv)
 442      int argc;
 443      char **argv;
 444 {
 445   int status = 0;
 446   struct tm tm, tmk, tml;
 447   struct tm *lt;
 448   time_t tk, tl;
 449   char trailer;
 450
 451   if ((argc == 3 || argc == 4)
 452       && (sscanf (argv[1], "%d-%d-%d%c",
 453                   &tm.tm_year, &tm.tm_mon, &tm.tm_mday, &trailer)
 454           == 3)
 455       && (sscanf (argv[2], "%d:%d:%d%c",
 456                   &tm.tm_hour, &tm.tm_min, &tm.tm_sec, &trailer)
 457           == 3))
 458     {
 459       tm.tm_year -= TM_YEAR_BASE;
 460       tm.tm_mon--;
 461       tm.tm_isdst = argc == 3 ? -1 : atoi (argv[3]);
 462       tmk = tm;
 463       tl = mktime (&tmk);
 464       lt = localtime (&tl);
 465       if (lt)
 466         {
 467           tml = *lt;
 468           lt = &tml;
 469         }
 470       printf ("mktime returns %ld == ", (long) tl);
 471       print_tm (&tmk);
 472       printf ("\n");
 473       status = check_result (tl, tmk, tl, lt);
 474     }
 475   else if (argc == 4 || (argc == 5 && strcmp (argv[4], "-") == 0))
 476     {
 477       time_t from = atol (argv[1]);
 478       time_t by = atol (argv[2]);
 479       time_t to = atol (argv[3]);
 480
 481       if (argc == 4)
 482         for (tl = from; tl <= to; tl += by)
 483           {
 484             lt = localtime (&tl);
 485             if (lt)
 486               {
 487                 tmk = tml = *lt;
 488                 tk = mktime (&tmk);
 489                 status |= check_result (tk, tmk, tl, tml);
 490               }
 491             else
 492               {
 493                 printf ("localtime (%ld) yields 0\n", (long) tl);
 494                 status = 1;
 495               }
 496           }
 497       else
 498         for (tl = from; tl <= to; tl += by)
 499           {
 500             /* Null benchmark.  */
 501             lt = localtime (&tl);
 502             if (lt)
 503               {
 504                 tmk = tml = *lt;
 505                 tk = tl;
 506                 status |= check_result (tk, tmk, tl, tml);
 507               }
 508             else
 509               {
 510                 printf ("localtime (%ld) yields 0\n", (long) tl);
 511                 status = 1;
 512               }
 513           }
 514     }
 515   else
 516     printf ("Usage:\
 517 \t%s YYYY-MM-DD HH:MM:SS [ISDST] # Test given time.\n\
 518 \t%s FROM BY TO # Test values FROM, FROM+BY, ..., TO.\n\
 519 \t%s FROM BY TO - # Do not test those values (for benchmark).\n",
 520             argv[0], argv[0], argv[0]);
 521
 522   return status;
 523 }
 524
 525 #endif /* DEBUG */
 526 \f
 527 /*
 528 Local Variables:
 529 compile-command: "gcc -DDEBUG -DHAVE_LIMITS_H -DSTDC_HEADERS -Wall -W -O -g mktime.c -o mktime"
 530 End:
 531 */