contrib/tar/lib/mktime.c

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