lib/mktime.c

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