src/install/acquire/cabextract/mktime.c

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