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