lib/mktime.c

   1 /* Convert a `struct tm' to a time_t value.
   2    Copyright (C) 1993-1999, 2002, 2003 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4    Contributed by Paul Eggert (eggert@twinsun.com).
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2, or (at your option)
   9    any later version.
  10
  11    This program 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
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License along
  17    with this program; if not, write to the Free Software Foundation,
  18    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  19
  20 /* Define this to have a standalone program to test this implementation of
  21    mktime.  */
  22 /* #define DEBUG 1 */
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include <config.h>
  26 #endif
  27
  28 #ifdef _LIBC
  29 # define HAVE_LIMITS_H 1
  30 # define STDC_HEADERS 1
  31 #endif
  32
  33 /* Assume that leap seconds are possible, unless told otherwise.
  34    If the host has a `zic' command with a `-L leapsecondfilename' option,
  35    then it supports leap seconds; otherwise it probably doesn't.  */
  36 #ifndef LEAP_SECONDS_POSSIBLE
  37 # define LEAP_SECONDS_POSSIBLE 1
  38 #endif
  39
  40 #include <sys/types.h>          /* Some systems define `time_t' here.  */
  41 #include <time.h>
  42
  43 #if HAVE_LIMITS_H
  44 # include <limits.h>
  45 #endif
  46
  47 #if DEBUG
  48 # include <stdio.h>
  49 # if STDC_HEADERS
  50 #  include <stdlib.h>
  51 #  include <string.h>
  52 # endif
  53 /* Make it work even if the system's libc has its own mktime routine.  */
  54 # define mktime my_mktime
  55 #endif /* DEBUG */
  56
  57 #ifndef __P
  58 # if defined __GNUC__ || (defined __STDC__ && __STDC__)
  59 #  define __P(args) args
  60 # else
  61 #  define __P(args) ()
  62 # endif  /* GCC.  */
  63 #endif  /* Not __P.  */
  64
  65 #ifndef CHAR_BIT
  66 # define CHAR_BIT 8
  67 #endif
  68
  69 /* The extra casts work around common compiler bugs.  */
  70 #define TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
  71 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
  72    It is necessary at least when t == time_t.  */
  73 #define TYPE_MINIMUM(t) ((t) (TYPE_SIGNED (t) \
  74                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
  75 #define TYPE_MAXIMUM(t) ((t) (~ (t) 0 - TYPE_MINIMUM (t)))
  76
  77 #ifndef INT_MIN
  78 # define INT_MIN TYPE_MINIMUM (int)
  79 #endif
  80 #ifndef INT_MAX
  81 # define INT_MAX TYPE_MAXIMUM (int)
  82 #endif
  83
  84 #ifndef TIME_T_MIN
  85 # define TIME_T_MIN TYPE_MINIMUM (time_t)
  86 #endif
  87 #ifndef TIME_T_MAX
  88 # define TIME_T_MAX TYPE_MAXIMUM (time_t)
  89 #endif
  90
  91 #define TM_YEAR_BASE 1900
  92 #define EPOCH_YEAR 1970
  93
  94 #ifndef __isleap
  95 /* Nonzero if YEAR is a leap year (every 4 years,
  96    except every 100th isn't, and every 400th is).  */
  97 # define __isleap(year) \
  98   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
  99 #endif
 100
 101 /* How many days come before each month (0-12).  */
 102 #ifndef _LIBC
 103 static
 104 #endif
 105 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 #ifndef _LIBC
 219 static
 220 #endif
 221 time_t
 222 __mktime_internal (struct tm *tp,
 223                    struct tm *(*convert) (const time_t *, struct tm *),
 224                    time_t *offset)
 225 {
 226   time_t t, dt, t0, t1, t2;
 227   struct tm tm;
 228
 229   /* The maximum number of probes (calls to CONVERT) should be enough
 230      to handle any combinations of time zone rule changes, solar time,
 231      leap seconds, and oscillations around a spring-forward gap.
 232      POSIX.1 prohibits leap seconds, but some hosts have them anyway.  */
 233   int remaining_probes = 6;
 234
 235   /* Time requested.  Copy it in case CONVERT modifies *TP; this can
 236      occur if TP is localtime's returned value and CONVERT is localtime.  */
 237   int sec = tp->tm_sec;
 238   int min = tp->tm_min;
 239   int hour = tp->tm_hour;
 240   int mday = tp->tm_mday;
 241   int mon = tp->tm_mon;
 242   int year_requested = tp->tm_year;
 243   int isdst = tp->tm_isdst;
 244
 245   /* 1 if the previous probe was DST.  */
 246   int dst2;
 247
 248   /* Ensure that mon is in range, and set year accordingly.  */
 249   int mon_remainder = mon % 12;
 250   int negative_mon_remainder = mon_remainder < 0;
 251   int mon_years = mon / 12 - negative_mon_remainder;
 252   int year = year_requested + mon_years;
 253
 254   /* The other values need not be in range:
 255      the remaining code handles minor overflows correctly,
 256      assuming int and time_t arithmetic wraps around.
 257      Major overflows are caught at the end.  */
 258
 259   /* Calculate day of year from year, month, and day of month.
 260      The result need not be in range.  */
 261   int yday = ((__mon_yday[__isleap (year + TM_YEAR_BASE)]
 262                [mon_remainder + 12 * negative_mon_remainder])
 263               + mday - 1);
 264
 265   int sec_requested = sec;
 266
 267 #if LEAP_SECONDS_POSSIBLE
 268   /* Handle out-of-range seconds specially,
 269      since ydhms_tm_diff assumes every minute has 60 seconds.  */
 270   if (sec < 0)
 271     sec = 0;
 272   if (59 < sec)
 273     sec = 59;
 274 #endif
 275
 276   /* Invert CONVERT by probing.  First assume the same offset as last time.
 277      Then repeatedly use the error to improve the guess.  */
 278
 279   tm.tm_year = EPOCH_YEAR - TM_YEAR_BASE;
 280   tm.tm_yday = tm.tm_hour = tm.tm_min = tm.tm_sec = 0;
 281   t0 = ydhms_tm_diff (year, yday, hour, min, sec, &tm);
 282
 283   for (t = t1 = t2 = t0 + *offset, dst2 = 0;
 284        (dt = ydhms_tm_diff (year, yday, hour, min, sec,
 285                             ranged_convert (convert, &t, &tm)));
 286        t1 = t2, t2 = t, t += dt, dst2 = tm.tm_isdst != 0)
 287     if (t == t1 && t != t2
 288         && (tm.tm_isdst < 0
 289             || (isdst < 0
 290                 ? dst2 <= (tm.tm_isdst != 0)
 291                 : (isdst != 0) != (tm.tm_isdst != 0))))
 292       /* We can't possibly find a match, as we are oscillating
 293          between two values.  The requested time probably falls
 294          within a spring-forward gap of size DT.  Follow the common
 295          practice in this case, which is to return a time that is DT
 296          away from the requested time, preferring a time whose
 297          tm_isdst differs from the requested value.  (If no tm_isdst
 298          was requested and only one of the two values has a nonzero
 299          tm_isdst, prefer that value.)  In practice, this is more
 300          useful than returning -1.  */
 301       break;
 302     else if (--remaining_probes == 0)
 303       return -1;
 304
 305   /* If we have a match, check whether tm.tm_isdst has the requested
 306      value, if any.  */
 307   if (dt == 0 && isdst != tm.tm_isdst && 0 <= isdst && 0 <= tm.tm_isdst)
 308     {
 309       /* tm.tm_isdst has the wrong value.  Look for a neighboring
 310          time with the right value, and use its UTC offset.
 311          Heuristic: probe the previous three calendar quarters (approximately),
 312          looking for the desired isdst.  This isn't perfect,
 313          but it's good enough in practice.  */
 314       int quarter = 7889238; /* seconds per average 1/4 Gregorian year */
 315       int i;
 316
 317       /* If we're too close to the time_t limit, look in future quarters.  */
 318       if (t < TIME_T_MIN + 3 * quarter)
 319         quarter = -quarter;
 320
 321       for (i = 1; i <= 3; i++)
 322         {
 323           time_t ot = t - i * quarter;
 324           struct tm otm;
 325           ranged_convert (convert, &ot, &otm);
 326           if (otm.tm_isdst == isdst)
 327             {
 328               /* We found the desired tm_isdst.
 329                  Extrapolate back to the desired time.  */
 330               t = ot + ydhms_tm_diff (year, yday, hour, min, sec, &otm);
 331               ranged_convert (convert, &t, &tm);
 332               break;
 333             }
 334         }
 335     }
 336
 337   *offset = t - t0;
 338
 339 #if LEAP_SECONDS_POSSIBLE
 340   if (sec_requested != tm.tm_sec)
 341     {
 342       /* Adjust time to reflect the tm_sec requested, not the normalized value.
 343          Also, repair any damage from a false match due to a leap second.  */
 344       t += sec_requested - sec + (sec == 0 && tm.tm_sec == 60);
 345       if (! (*convert) (&t, &tm))
 346         return -1;
 347     }
 348 #endif
 349
 350   if (TIME_T_MAX / INT_MAX / 366 / 24 / 60 / 60 < 3)
 351     {
 352       /* time_t isn't large enough to rule out overflows in ydhms_tm_diff,
 353          so check for major overflows.  A gross check suffices,
 354          since if t has overflowed, it is off by a multiple of
 355          TIME_T_MAX - TIME_T_MIN + 1.  So ignore any component of
 356          the difference that is bounded by a small value.  */
 357
 358       double dyear = (double) year_requested + mon_years - tm.tm_year;
 359       double dday = 366 * dyear + mday;
 360       double dsec = 60 * (60 * (24 * dday + hour) + min) + sec_requested;
 361
 362       /* On Irix4.0.5 cc, dividing TIME_T_MIN by 3 does not produce
 363          correct results, ie., it erroneously gives a positive value
 364          of 715827882.  Setting a variable first then doing math on it
 365          seems to work.  (ghazi@caip.rutgers.edu) */
 366
 367       const time_t time_t_max = TIME_T_MAX;
 368       const time_t time_t_min = TIME_T_MIN;
 369
 370       if (time_t_max / 3 - time_t_min / 3 < (dsec < 0 ? - dsec : dsec))
 371         return -1;
 372     }
 373
 374   *tp = tm;
 375   return t;
 376 }
 377
 378
 379 static time_t localtime_offset;
 380
 381 /* Convert *TP to a time_t value.  */
 382 time_t
 383 mktime (tp)
 384      struct tm *tp;
 385 {
 386 #ifdef _LIBC
 387   /* POSIX.1 8.1.1 requires that whenever mktime() is called, the
 388      time zone names contained in the external variable `tzname' shall
 389      be set as if the tzset() function had been called.  */
 390   __tzset ();
 391 #endif
 392
 393   return __mktime_internal (tp, my_mktime_localtime_r, &localtime_offset);
 394 }
 395
 396 #ifdef weak_alias
 397 weak_alias (mktime, timelocal)
 398 #endif
 399
 400 #ifdef _LIBC
 401 libc_hidden_def (mktime)
 402 libc_hidden_weak (timelocal)
 403 #endif
 404 \f
 405 #if DEBUG
 406
 407 static int
 408 not_equal_tm (a, b)
 409      struct tm *a;
 410      struct tm *b;
 411 {
 412   return ((a->tm_sec ^ b->tm_sec)
 413           | (a->tm_min ^ b->tm_min)
 414           | (a->tm_hour ^ b->tm_hour)
 415           | (a->tm_mday ^ b->tm_mday)
 416           | (a->tm_mon ^ b->tm_mon)
 417           | (a->tm_year ^ b->tm_year)
 418           | (a->tm_mday ^ b->tm_mday)
 419           | (a->tm_yday ^ b->tm_yday)
 420           | (a->tm_isdst ^ b->tm_isdst));
 421 }
 422
 423 static void
 424 print_tm (tp)
 425      struct tm *tp;
 426 {
 427   if (tp)
 428     printf ("%04d-%02d-%02d %02d:%02d:%02d yday %03d wday %d isdst %d",
 429             tp->tm_year + TM_YEAR_BASE, tp->tm_mon + 1, tp->tm_mday,
 430             tp->tm_hour, tp->tm_min, tp->tm_sec,
 431             tp->tm_yday, tp->tm_wday, tp->tm_isdst);
 432   else
 433     printf ("0");
 434 }
 435
 436 static int
 437 check_result (tk, tmk, tl, lt)
 438      time_t tk;
 439      struct tm tmk;
 440      time_t tl;
 441      struct tm *lt;
 442 {
 443   if (tk != tl || !lt || not_equal_tm (&tmk, lt))
 444     {
 445       printf ("mktime (");
 446       print_tm (&tmk);
 447       printf (")\nyields (");
 448       print_tm (lt);
 449       printf (") == %ld, should be %ld\n", (long) tl, (long) tk);
 450       return 1;
 451     }
 452
 453   return 0;
 454 }
 455
 456 int
 457 main (argc, argv)
 458      int argc;
 459      char **argv;
 460 {
 461   int status = 0;
 462   struct tm tm, tmk, tml;
 463   struct tm *lt;
 464   time_t tk, tl;
 465   char trailer;
 466
 467   if ((argc == 3 || argc == 4)
 468       && (sscanf (argv[1], "%d-%d-%d%c",
 469                   &tm.tm_year, &tm.tm_mon, &tm.tm_mday, &trailer)
 470           == 3)
 471       && (sscanf (argv[2], "%d:%d:%d%c",
 472                   &tm.tm_hour, &tm.tm_min, &tm.tm_sec, &trailer)
 473           == 3))
 474     {
 475       tm.tm_year -= TM_YEAR_BASE;
 476       tm.tm_mon--;
 477       tm.tm_isdst = argc == 3 ? -1 : atoi (argv[3]);
 478       tmk = tm;
 479       tl = mktime (&tmk);
 480       lt = localtime (&tl);
 481       if (lt)
 482         {
 483           tml = *lt;
 484           lt = &tml;
 485         }
 486       printf ("mktime returns %ld == ", (long) tl);
 487       print_tm (&tmk);
 488       printf ("\n");
 489       status = check_result (tl, tmk, tl, lt);
 490     }
 491   else if (argc == 4 || (argc == 5 && strcmp (argv[4], "-") == 0))
 492     {
 493       time_t from = atol (argv[1]);
 494       time_t by = atol (argv[2]);
 495       time_t to = atol (argv[3]);
 496
 497       if (argc == 4)
 498         for (tl = from; tl <= to; tl += by)
 499           {
 500             lt = localtime (&tl);
 501             if (lt)
 502               {
 503                 tmk = tml = *lt;
 504                 tk = mktime (&tmk);
 505                 status |= check_result (tk, tmk, tl, tml);
 506               }
 507             else
 508               {
 509                 printf ("localtime (%ld) yields 0\n", (long) tl);
 510                 status = 1;
 511               }
 512           }
 513       else
 514         for (tl = from; tl <= to; tl += by)
 515           {
 516             /* Null benchmark.  */
 517             lt = localtime (&tl);
 518             if (lt)
 519               {
 520                 tmk = tml = *lt;
 521                 tk = tl;
 522                 status |= check_result (tk, tmk, tl, tml);
 523               }
 524             else
 525               {
 526                 printf ("localtime (%ld) yields 0\n", (long) tl);
 527                 status = 1;
 528               }
 529           }
 530     }
 531   else
 532     printf ("Usage:\
 533 \t%s YYYY-MM-DD HH:MM:SS [ISDST] # Test given time.\n\
 534 \t%s FROM BY TO # Test values FROM, FROM+BY, ..., TO.\n\
 535 \t%s FROM BY TO - # Do not test those values (for benchmark).\n",
 536             argv[0], argv[0], argv[0]);
 537
 538   return status;
 539 }
 540
 541 #endif /* DEBUG */
 542 \f
 543 /*
 544 Local Variables:
 545 compile-command: "gcc -DDEBUG -DHAVE_LIMITS_H -DSTDC_HEADERS -Wall -W -O -g mktime.c -o mktime"
 546 End:
 547 */