This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add time64 as its own build target.
[perl5.git] / time64.c
1 /*
2
3 Copyright (c) 2007-2008  Michael G Schwern
4
5 This software originally derived from Paul Sheer's pivotal_gmtime_r.c.
6
7 The MIT License:
8
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26
27 */
28
29 /*
30
31 Programmers who have available to them 64-bit time values as a 'long
32 long' type can use localtime64_r() and gmtime64_r() which correctly
33 converts the time even on 32-bit systems. Whether you have 64-bit time
34 values will depend on the operating system.
35
36 Perl_localtime64_r() is a 64-bit equivalent of localtime_r().
37
38 Perl_gmtime64_r() is a 64-bit equivalent of gmtime_r().
39
40 */
41
42 #include "EXTERN.h"
43 #define PERL_IN_TIME64_C
44 #include "perl.h"
45 #include "time64.h"
46
47 static const char days_in_month[2][12] = {
48     {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31},
49     {31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31},
50 };
51
52 static const short julian_days_by_month[2][12] = {
53     {0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334},
54     {0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335},
55 };
56
57 static const short length_of_year[2] = { 365, 366 };
58
59 /* Number of days in a 400 year Gregorian cycle */
60 static const Year years_in_gregorian_cycle = 400;
61 static const int days_in_gregorian_cycle  = (365 * 400) + 100 - 4 + 1;
62
63 /* 28 year calendar cycle between 2010 and 2037 */
64 #define SOLAR_CYCLE_LENGTH 28
65 static const short safe_years[SOLAR_CYCLE_LENGTH] = {
66     2016, 2017, 2018, 2019,
67     2020, 2021, 2022, 2023,
68     2024, 2025, 2026, 2027,
69     2028, 2029, 2030, 2031,
70     2032, 2033, 2034, 2035,
71     2036, 2037, 2010, 2011,
72     2012, 2013, 2014, 2015
73 };
74
75 static const char dow_year_start[SOLAR_CYCLE_LENGTH] = {
76     5, 0, 1, 2,     /* 0       2016 - 2019 */
77     3, 5, 6, 0,     /* 4  */
78     1, 3, 4, 5,     /* 8  */
79     6, 1, 2, 3,     /* 12 */
80     4, 6, 0, 1,     /* 16 */
81     2, 4, 5, 6,     /* 20      2036, 2037, 2010, 2011 */
82     0, 2, 3, 4      /* 24      2012, 2013, 2014, 2015 */
83 };
84
85 /* Let's assume people are going to be looking for dates in the future.
86    Let's provide some cheats so you can skip ahead.
87    This has a 4x speed boost when near 2008.
88 */
89 /* Number of days since epoch on Jan 1st, 2008 GMT */
90 #define CHEAT_DAYS  (1199145600 / 24 / 60 / 60)
91 #define CHEAT_YEARS 108
92
93 #define IS_LEAP(n)      ((!(((n) + 1900) % 400) || (!(((n) + 1900) % 4) && (((n) + 1900) % 100))) != 0)
94 #undef WRAP /* some <termios.h> define this */
95 #define WRAP(a,b,m)     ((a) = ((a) <  0  ) ? ((b)--, (a) + (m)) : (a))
96
97 #ifdef USE_SYSTEM_LOCALTIME
98 #    define SHOULD_USE_SYSTEM_LOCALTIME(a)  (       \
99     (a) <= SYSTEM_LOCALTIME_MAX &&              \
100     (a) >= SYSTEM_LOCALTIME_MIN                 \
101 )
102 #else
103 #    define SHOULD_USE_SYSTEM_LOCALTIME(a)      (0)
104 #endif
105
106 #ifdef USE_SYSTEM_GMTIME
107 #    define SHOULD_USE_SYSTEM_GMTIME(a)     (       \
108     (a) <= SYSTEM_GMTIME_MAX    &&              \
109     (a) >= SYSTEM_GMTIME_MIN                    \
110 )
111 #else
112 #    define SHOULD_USE_SYSTEM_GMTIME(a)         (0)
113 #endif
114
115 /* Multi varadic macros are a C99 thing, alas */
116 #ifdef TIME_64_DEBUG
117 #    define TIME64_TRACE(format) (fprintf(stderr, format))
118 #    define TIME64_TRACE1(format, var1)    (fprintf(stderr, format, var1))
119 #    define TIME64_TRACE2(format, var1, var2)    (fprintf(stderr, format, var1, var2))
120 #    define TIME64_TRACE3(format, var1, var2, var3)    (fprintf(stderr, format, var1, var2, var3))
121 #else
122 #    define TIME64_TRACE(format) ((void)0)
123 #    define TIME64_TRACE1(format, var1) ((void)0)
124 #    define TIME64_TRACE2(format, var1, var2) ((void)0)
125 #    define TIME64_TRACE3(format, var1, var2, var3) ((void)0)
126 #endif
127
128 static int S_is_exception_century(Year year)
129 {
130     int is_exception = ((year % 100 == 0) && !(year % 400 == 0));
131     TIME64_TRACE1("# is_exception_century: %s\n", is_exception ? "yes" : "no");
132
133     return(is_exception);
134 }
135
136
137 static Time64_T S_timegm64(struct TM *date) {
138     int      days    = 0;
139     Time64_T seconds = 0;
140     Year     year;
141
142     if( date->tm_year > 70 ) {
143         year = 70;
144         while( year < date->tm_year ) {
145             days += length_of_year[IS_LEAP(year)];
146             year++;
147         }
148     }
149     else if ( date->tm_year < 70 ) {
150         year = 69;
151         do {
152             days -= length_of_year[IS_LEAP(year)];
153             year--;
154         } while( year >= date->tm_year );
155     }
156
157     days += julian_days_by_month[IS_LEAP(date->tm_year)][date->tm_mon];
158     days += date->tm_mday - 1;
159
160     /* Avoid overflowing the days integer */
161     seconds = days;
162     seconds = seconds * 60 * 60 * 24;
163
164     seconds += date->tm_hour * 60 * 60;
165     seconds += date->tm_min * 60;
166     seconds += date->tm_sec;
167
168     return(seconds);
169 }
170
171
172 #ifdef DEBUGGING
173 static int S_check_tm(struct TM *tm)
174 {
175     /* Don't forget leap seconds */
176     assert(tm->tm_sec >= 0);
177     assert(tm->tm_sec <= 61);
178
179     assert(tm->tm_min >= 0);
180     assert(tm->tm_min <= 59);
181
182     assert(tm->tm_hour >= 0);
183     assert(tm->tm_hour <= 23);
184
185     assert(tm->tm_mday >= 1);
186     assert(tm->tm_mday <= days_in_month[IS_LEAP(tm->tm_year)][tm->tm_mon]);
187
188     assert(tm->tm_mon  >= 0);
189     assert(tm->tm_mon  <= 11);
190
191     assert(tm->tm_wday >= 0);
192     assert(tm->tm_wday <= 6);
193
194     assert(tm->tm_yday >= 0);
195     assert(tm->tm_yday <= length_of_year[IS_LEAP(tm->tm_year)]);
196
197 #ifdef HAS_TM_TM_GMTOFF
198     assert(tm->tm_gmtoff >= -24 * 60 * 60);
199     assert(tm->tm_gmtoff <=  24 * 60 * 60);
200 #endif
201
202     return 1;
203 }
204 #endif
205
206
207 /* The exceptional centuries without leap years cause the cycle to
208    shift by 16
209 */
210 static Year S_cycle_offset(Year year)
211 {
212     const Year start_year = 2000;
213     Year year_diff  = year - start_year;
214     Year exceptions;
215
216     if( year > start_year )
217         year_diff--;
218
219     exceptions  = year_diff / 100;
220     exceptions -= year_diff / 400;
221
222     TIME64_TRACE3("# year: %lld, exceptions: %lld, year_diff: %lld\n",
223           year, exceptions, year_diff);
224
225     return exceptions * 16;
226 }
227
228 /* For a given year after 2038, pick the latest possible matching
229    year in the 28 year calendar cycle.
230
231    A matching year...
232    1) Starts on the same day of the week.
233    2) Has the same leap year status.
234
235    This is so the calendars match up.
236
237    Also the previous year must match.  When doing Jan 1st you might
238    wind up on Dec 31st the previous year when doing a -UTC time zone.
239
240    Finally, the next year must have the same start day of week.  This
241    is for Dec 31st with a +UTC time zone.
242    It doesn't need the same leap year status since we only care about
243    January 1st.
244 */
245 static int S_safe_year(Year year)
246 {
247     int safe_year;
248     Year year_cycle = year + S_cycle_offset(year);
249
250     /* Change non-leap xx00 years to an equivalent */
251     if( S_is_exception_century(year) )
252         year_cycle += 11;
253
254     /* Also xx01 years, since the previous year will be wrong */
255     if( S_is_exception_century(year - 1) )
256         year_cycle += 17;
257
258     year_cycle %= SOLAR_CYCLE_LENGTH;
259     if( year_cycle < 0 )
260         year_cycle = SOLAR_CYCLE_LENGTH + year_cycle;
261
262     assert( year_cycle >= 0 );
263     assert( year_cycle < SOLAR_CYCLE_LENGTH );
264     safe_year = safe_years[year_cycle];
265
266     assert(safe_year <= 2037 && safe_year >= 2010);
267
268     TIME64_TRACE3("# year: %lld, year_cycle: %lld, safe_year: %d\n",
269           year, year_cycle, safe_year);
270
271     return safe_year;
272 }
273
274
275 static void S_copy_little_tm_to_big_TM(const struct tm *src, struct TM *dest) {
276     assert(src);
277     assert(dest);
278 #ifdef USE_TM64
279     dest->tm_sec        = src->tm_sec;
280     dest->tm_min        = src->tm_min;
281     dest->tm_hour       = src->tm_hour;
282     dest->tm_mday       = src->tm_mday;
283     dest->tm_mon        = src->tm_mon;
284     dest->tm_year       = (Year)src->tm_year;
285     dest->tm_wday       = src->tm_wday;
286     dest->tm_yday       = src->tm_yday;
287     dest->tm_isdst      = src->tm_isdst;
288
289 #  ifdef HAS_TM_TM_GMTOFF
290     dest->tm_gmtoff     = src->tm_gmtoff;
291 #  endif
292
293 #  ifdef HAS_TM_TM_ZONE
294     dest->tm_zone       = src->tm_zone;
295 #  endif
296
297 #else
298     /* They're the same type */
299     memcpy(dest, src, sizeof(*dest));
300 #endif
301 }
302
303
304 #ifndef HAS_LOCALTIME_R
305 /* Simulate localtime_r() to the best of our ability */
306 static struct tm * S_localtime_r(const time_t *clock, struct tm *result) {
307 #ifdef __VMS
308     dTHX;    /* the following is defined as Perl_my_localtime(aTHX_ ...) */
309 #endif
310     const struct tm *static_result = localtime(clock);
311
312     assert(result != NULL);
313
314     if( static_result == NULL ) {
315         memset(result, 0, sizeof(*result));
316         return NULL;
317     }
318     else {
319         memcpy(result, static_result, sizeof(*result));
320         return result;
321     }
322 }
323 #endif
324
325 #ifndef HAS_GMTIME_R
326 /* Simulate gmtime_r() to the best of our ability */
327 static struct tm * S_gmtime_r(const time_t *clock, struct tm *result) {
328 #ifdef __VMS
329     dTHX;    /* the following is defined as Perl_my_localtime(aTHX_ ...) */
330 #endif
331     const struct tm *static_result = gmtime(clock);
332
333     assert(result != NULL);
334
335     if( static_result == NULL ) {
336         memset(result, 0, sizeof(*result));
337         return NULL;
338     }
339     else {
340         memcpy(result, static_result, sizeof(*result));
341         return result;
342     }
343 }
344 #endif
345
346 struct TM *Perl_gmtime64_r (const Time64_T *in_time, struct TM *p)
347 {
348     int v_tm_sec, v_tm_min, v_tm_hour, v_tm_mon, v_tm_wday;
349     Time64_T v_tm_tday;
350     int leap;
351     Time64_T m;
352     Time64_T time = *in_time;
353     Year year = 70;
354     int cycles = 0;
355
356     assert(p != NULL);
357
358     /* Use the system gmtime() if time_t is small enough */
359     if( SHOULD_USE_SYSTEM_GMTIME(*in_time) ) {
360         time_t safe_time = (time_t)*in_time;
361         struct tm safe_date;
362         GMTIME_R(&safe_time, &safe_date);
363
364         S_copy_little_tm_to_big_TM(&safe_date, p);
365         assert(S_check_tm(p));
366
367         return p;
368     }
369
370 #ifdef HAS_TM_TM_GMTOFF
371     p->tm_gmtoff = 0;
372 #endif
373     p->tm_isdst  = 0;
374
375 #ifdef HAS_TM_TM_ZONE
376     p->tm_zone   = (char *)"UTC";
377 #endif
378
379     v_tm_sec  = (int)Perl_fmod(time, 60.0);
380     time      = time >= 0 ? Perl_floor(time / 60.0) : Perl_ceil(time / 60.0);
381     v_tm_min  = (int)Perl_fmod(time, 60.0);
382     time      = time >= 0 ? Perl_floor(time / 60.0) : Perl_ceil(time / 60.0);
383     v_tm_hour = (int)Perl_fmod(time, 24.0);
384     time      = time >= 0 ? Perl_floor(time / 24.0) : Perl_ceil(time / 24.0);
385     v_tm_tday = time;
386
387     WRAP (v_tm_sec, v_tm_min, 60);
388     WRAP (v_tm_min, v_tm_hour, 60);
389     WRAP (v_tm_hour, v_tm_tday, 24);
390
391     v_tm_wday = (int)Perl_fmod((v_tm_tday + 4.0), 7.0);
392     if (v_tm_wday < 0)
393         v_tm_wday += 7;
394     m = v_tm_tday;
395
396     if (m >= CHEAT_DAYS) {
397         year = CHEAT_YEARS;
398         m -= CHEAT_DAYS;
399     }
400
401     if (m >= 0) {
402         /* Gregorian cycles, this is huge optimization for distant times */
403         cycles = (int)Perl_floor(m / (Time64_T) days_in_gregorian_cycle);
404         if( cycles ) {
405             m -= (cycles * (Time64_T) days_in_gregorian_cycle);
406             year += (cycles * years_in_gregorian_cycle);
407         }
408
409         /* Years */
410         leap = IS_LEAP (year);
411         while (m >= (Time64_T) length_of_year[leap]) {
412             m -= (Time64_T) length_of_year[leap];
413             year++;
414             leap = IS_LEAP (year);
415         }
416
417         /* Months */
418         v_tm_mon = 0;
419         while (m >= (Time64_T) days_in_month[leap][v_tm_mon]) {
420             m -= (Time64_T) days_in_month[leap][v_tm_mon];
421             v_tm_mon++;
422         }
423     } else {
424         year--;
425
426         /* Gregorian cycles */
427         cycles = (int)Perl_ceil((m / (Time64_T) days_in_gregorian_cycle) + 1);
428         if( cycles ) {
429             m -= (cycles * (Time64_T) days_in_gregorian_cycle);
430             year += (cycles * years_in_gregorian_cycle);
431         }
432
433         /* Years */
434         leap = IS_LEAP (year);
435         while (m < (Time64_T) -length_of_year[leap]) {
436             m += (Time64_T) length_of_year[leap];
437             year--;
438             leap = IS_LEAP (year);
439         }
440
441         /* Months */
442         v_tm_mon = 11;
443         while (m < (Time64_T) -days_in_month[leap][v_tm_mon]) {
444             m += (Time64_T) days_in_month[leap][v_tm_mon];
445             v_tm_mon--;
446         }
447         m += (Time64_T) days_in_month[leap][v_tm_mon];
448     }
449
450     p->tm_year = year;
451     if( p->tm_year != year ) {
452 #ifdef EOVERFLOW
453         errno = EOVERFLOW;
454 #endif
455         return NULL;
456     }
457
458     /* At this point m is less than a year so casting to an int is safe */
459     p->tm_mday = (int) m + 1;
460     p->tm_yday = julian_days_by_month[leap][v_tm_mon] + (int)m;
461     p->tm_sec  = v_tm_sec;
462     p->tm_min  = v_tm_min;
463     p->tm_hour = v_tm_hour;
464     p->tm_mon  = v_tm_mon;
465     p->tm_wday = v_tm_wday;
466
467     assert(S_check_tm(p));
468
469     return p;
470 }
471
472
473 struct TM *Perl_localtime64_r (const Time64_T *time, struct TM *local_tm)
474 {
475     time_t safe_time;
476     struct tm safe_date;
477     struct TM gm_tm;
478     Year orig_year;
479     int month_diff;
480
481     assert(local_tm != NULL);
482
483     /* Use the system localtime() if time_t is small enough */
484     if( SHOULD_USE_SYSTEM_LOCALTIME(*time) ) {
485         safe_time = (time_t)*time;
486
487         TIME64_TRACE1("Using system localtime for %lld\n", *time);
488
489         LOCALTIME_R(&safe_time, &safe_date);
490
491         S_copy_little_tm_to_big_TM(&safe_date, local_tm);
492         assert(S_check_tm(local_tm));
493
494         return local_tm;
495     }
496
497     if( Perl_gmtime64_r(time, &gm_tm) == NULL ) {
498         TIME64_TRACE1("gmtime64_r returned null for %lld\n", *time);
499         return NULL;
500     }
501
502     orig_year = gm_tm.tm_year;
503
504     if (gm_tm.tm_year > (2037 - 1900) ||
505         gm_tm.tm_year < (1970 - 1900)
506        )
507     {
508         TIME64_TRACE1("Mapping tm_year %lld to safe_year\n", (Year)gm_tm.tm_year);
509         gm_tm.tm_year = S_safe_year((Year)(gm_tm.tm_year + 1900)) - 1900;
510     }
511
512     safe_time = (time_t)S_timegm64(&gm_tm);
513     if( LOCALTIME_R(&safe_time, &safe_date) == NULL ) {
514         TIME64_TRACE1("localtime_r(%d) returned NULL\n", (int)safe_time);
515         return NULL;
516     }
517
518     S_copy_little_tm_to_big_TM(&safe_date, local_tm);
519
520     local_tm->tm_year = orig_year;
521     if( local_tm->tm_year != orig_year ) {
522         TIME64_TRACE2("tm_year overflow: tm_year %lld, orig_year %lld\n",
523               (Year)local_tm->tm_year, (Year)orig_year);
524
525 #ifdef EOVERFLOW
526         errno = EOVERFLOW;
527 #endif
528         return NULL;
529     }
530
531
532     month_diff = local_tm->tm_mon - gm_tm.tm_mon;
533
534     /*  When localtime is Dec 31st previous year and
535         gmtime is Jan 1st next year.
536     */
537     if( month_diff == 11 ) {
538         local_tm->tm_year--;
539     }
540
541     /*  When localtime is Jan 1st, next year and
542         gmtime is Dec 31st, previous year.
543     */
544     if( month_diff == -11 ) {
545         local_tm->tm_year++;
546     }
547
548     /* GMT is Jan 1st, xx01 year, but localtime is still Dec 31st
549        in a non-leap xx00.  There is one point in the cycle
550        we can't account for which the safe xx00 year is a leap
551        year.  So we need to correct for Dec 31st coming out as
552        the 366th day of the year.
553     */
554     if( !IS_LEAP(local_tm->tm_year) && local_tm->tm_yday == 365 )
555         local_tm->tm_yday--;
556
557     assert(S_check_tm(local_tm));
558
559     return local_tm;
560 }