3 Copyright (c) 2007-2008 Michael G Schwern
5 This software originally derived from Paul Sheer's pivotal_gmtime_r.c.
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:
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
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
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.
36 S_localtime64_r() is a 64-bit equivalent of localtime_r().
38 S_gmtime64_r() is a 64-bit equivalent of gmtime_r().
44 static const char days_in_month[2][12] = {
45 {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31},
46 {31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31},
49 static const short julian_days_by_month[2][12] = {
50 {0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334},
51 {0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335},
54 static const short length_of_year[2] = { 365, 366 };
56 /* Number of days in a 400 year Gregorian cycle */
57 static const Year years_in_gregorian_cycle = 400;
58 static const int days_in_gregorian_cycle = (365 * 400) + 100 - 4 + 1;
60 /* 28 year calendar cycle between 2010 and 2037 */
61 #define SOLAR_CYCLE_LENGTH 28
62 static const short safe_years[SOLAR_CYCLE_LENGTH] = {
63 2016, 2017, 2018, 2019,
64 2020, 2021, 2022, 2023,
65 2024, 2025, 2026, 2027,
66 2028, 2029, 2030, 2031,
67 2032, 2033, 2034, 2035,
68 2036, 2037, 2010, 2011,
69 2012, 2013, 2014, 2015
72 static const char dow_year_start[SOLAR_CYCLE_LENGTH] = {
73 5, 0, 1, 2, /* 0 2016 - 2019 */
78 2, 4, 5, 6, /* 20 2036, 2037, 2010, 2011 */
79 0, 2, 3, 4 /* 24 2012, 2013, 2014, 2015 */
82 /* Let's assume people are going to be looking for dates in the future.
83 Let's provide some cheats so you can skip ahead.
84 This has a 4x speed boost when near 2008.
86 /* Number of days since epoch on Jan 1st, 2008 GMT */
87 #define CHEAT_DAYS (1199145600 / 24 / 60 / 60)
88 #define CHEAT_YEARS 108
90 #define IS_LEAP(n) ((!(((n) + 1900) % 400) || (!(((n) + 1900) % 4) && (((n) + 1900) % 100))) != 0)
91 #undef WRAP /* some <termios.h> define this */
92 #define WRAP(a,b,m) ((a) = ((a) < 0 ) ? ((b)--, (a) + (m)) : (a))
94 #ifdef USE_SYSTEM_LOCALTIME
95 # define SHOULD_USE_SYSTEM_LOCALTIME(a) ( \
96 (a) <= SYSTEM_LOCALTIME_MAX && \
97 (a) >= SYSTEM_LOCALTIME_MIN \
100 # define SHOULD_USE_SYSTEM_LOCALTIME(a) (0)
103 #ifdef USE_SYSTEM_GMTIME
104 # define SHOULD_USE_SYSTEM_GMTIME(a) ( \
105 (a) <= SYSTEM_GMTIME_MAX && \
106 (a) >= SYSTEM_GMTIME_MIN \
109 # define SHOULD_USE_SYSTEM_GMTIME(a) (0)
112 /* Multi varadic macros are a C99 thing, alas */
114 # define TIME64_TRACE(format) (fprintf(stderr, format))
115 # define TIME64_TRACE1(format, var1) (fprintf(stderr, format, var1))
116 # define TIME64_TRACE2(format, var1, var2) (fprintf(stderr, format, var1, var2))
117 # define TIME64_TRACE3(format, var1, var2, var3) (fprintf(stderr, format, var1, var2, var3))
119 # define TIME64_TRACE(format) ((void)0)
120 # define TIME64_TRACE1(format, var1) ((void)0)
121 # define TIME64_TRACE2(format, var1, var2) ((void)0)
122 # define TIME64_TRACE3(format, var1, var2, var3) ((void)0)
125 static int S_is_exception_century(Year year)
127 int is_exception = ((year % 100 == 0) && !(year % 400 == 0));
128 TIME64_TRACE1("# is_exception_century: %s\n", is_exception ? "yes" : "no");
130 return(is_exception);
134 static Time64_T S_timegm64(struct TM *date) {
136 Time64_T seconds = 0;
139 if( date->tm_year > 70 ) {
141 while( year < date->tm_year ) {
142 days += length_of_year[IS_LEAP(year)];
146 else if ( date->tm_year < 70 ) {
149 days -= length_of_year[IS_LEAP(year)];
151 } while( year >= date->tm_year );
154 days += julian_days_by_month[IS_LEAP(date->tm_year)][date->tm_mon];
155 days += date->tm_mday - 1;
157 /* Avoid overflowing the days integer */
159 seconds = seconds * 60 * 60 * 24;
161 seconds += date->tm_hour * 60 * 60;
162 seconds += date->tm_min * 60;
163 seconds += date->tm_sec;
170 static int S_check_tm(struct TM *tm)
172 /* Don't forget leap seconds */
173 assert(tm->tm_sec >= 0);
174 assert(tm->tm_sec <= 61);
176 assert(tm->tm_min >= 0);
177 assert(tm->tm_min <= 59);
179 assert(tm->tm_hour >= 0);
180 assert(tm->tm_hour <= 23);
182 assert(tm->tm_mday >= 1);
183 assert(tm->tm_mday <= days_in_month[IS_LEAP(tm->tm_year)][tm->tm_mon]);
185 assert(tm->tm_mon >= 0);
186 assert(tm->tm_mon <= 11);
188 assert(tm->tm_wday >= 0);
189 assert(tm->tm_wday <= 6);
191 assert(tm->tm_yday >= 0);
192 assert(tm->tm_yday <= length_of_year[IS_LEAP(tm->tm_year)]);
194 #ifdef HAS_TM_TM_GMTOFF
195 assert(tm->tm_gmtoff >= -24 * 60 * 60);
196 assert(tm->tm_gmtoff <= 24 * 60 * 60);
204 /* The exceptional centuries without leap years cause the cycle to
207 static Year S_cycle_offset(Year year)
209 const Year start_year = 2000;
210 Year year_diff = year - start_year;
213 if( year > start_year )
216 exceptions = year_diff / 100;
217 exceptions -= year_diff / 400;
219 TIME64_TRACE3("# year: %lld, exceptions: %lld, year_diff: %lld\n",
220 year, exceptions, year_diff);
222 return exceptions * 16;
225 /* For a given year after 2038, pick the latest possible matching
226 year in the 28 year calendar cycle.
229 1) Starts on the same day of the week.
230 2) Has the same leap year status.
232 This is so the calendars match up.
234 Also the previous year must match. When doing Jan 1st you might
235 wind up on Dec 31st the previous year when doing a -UTC time zone.
237 Finally, the next year must have the same start day of week. This
238 is for Dec 31st with a +UTC time zone.
239 It doesn't need the same leap year status since we only care about
242 static int S_safe_year(Year year)
245 Year year_cycle = year + S_cycle_offset(year);
247 /* Change non-leap xx00 years to an equivalent */
248 if( S_is_exception_century(year) )
251 /* Also xx01 years, since the previous year will be wrong */
252 if( S_is_exception_century(year - 1) )
255 year_cycle %= SOLAR_CYCLE_LENGTH;
257 year_cycle = SOLAR_CYCLE_LENGTH + year_cycle;
259 assert( year_cycle >= 0 );
260 assert( year_cycle < SOLAR_CYCLE_LENGTH );
261 safe_year = safe_years[year_cycle];
263 assert(safe_year <= 2037 && safe_year >= 2010);
265 TIME64_TRACE3("# year: %lld, year_cycle: %lld, safe_year: %d\n",
266 year, year_cycle, safe_year);
272 static void S_copy_little_tm_to_big_TM(const struct tm *src, struct TM *dest) {
276 dest->tm_sec = src->tm_sec;
277 dest->tm_min = src->tm_min;
278 dest->tm_hour = src->tm_hour;
279 dest->tm_mday = src->tm_mday;
280 dest->tm_mon = src->tm_mon;
281 dest->tm_year = (Year)src->tm_year;
282 dest->tm_wday = src->tm_wday;
283 dest->tm_yday = src->tm_yday;
284 dest->tm_isdst = src->tm_isdst;
286 # ifdef HAS_TM_TM_GMTOFF
287 dest->tm_gmtoff = src->tm_gmtoff;
290 # ifdef HAS_TM_TM_ZONE
291 dest->tm_zone = src->tm_zone;
295 /* They're the same type */
296 memcpy(dest, src, sizeof(*dest));
301 #ifndef HAS_LOCALTIME_R
302 /* Simulate localtime_r() to the best of our ability */
303 static struct tm * S_localtime_r(const time_t *clock, struct tm *result) {
305 dTHX; /* the following is defined as Perl_my_localtime(aTHX_ ...) */
307 const struct tm *static_result = localtime(clock);
309 assert(result != NULL);
311 if( static_result == NULL ) {
312 memset(result, 0, sizeof(*result));
316 memcpy(result, static_result, sizeof(*result));
323 /* Simulate gmtime_r() to the best of our ability */
324 static struct tm * S_gmtime_r(const time_t *clock, struct tm *result) {
326 dTHX; /* the following is defined as Perl_my_localtime(aTHX_ ...) */
328 const struct tm *static_result = gmtime(clock);
330 assert(result != NULL);
332 if( static_result == NULL ) {
333 memset(result, 0, sizeof(*result));
337 memcpy(result, static_result, sizeof(*result));
343 static struct TM *S_gmtime64_r (const Time64_T *in_time, struct TM *p)
345 int v_tm_sec, v_tm_min, v_tm_hour, v_tm_mon, v_tm_wday;
349 Time64_T time = *in_time;
355 /* Use the system gmtime() if time_t is small enough */
356 if( SHOULD_USE_SYSTEM_GMTIME(*in_time) ) {
357 time_t safe_time = (time_t)*in_time;
359 GMTIME_R(&safe_time, &safe_date);
361 S_copy_little_tm_to_big_TM(&safe_date, p);
362 assert(S_check_tm(p));
367 #ifdef HAS_TM_TM_GMTOFF
372 #ifdef HAS_TM_TM_ZONE
373 p->tm_zone = (char *)"UTC";
376 v_tm_sec = (int)Perl_fmod(time, 60.0);
377 time = time >= 0 ? Perl_floor(time / 60.0) : Perl_ceil(time / 60.0);
378 v_tm_min = (int)Perl_fmod(time, 60.0);
379 time = time >= 0 ? Perl_floor(time / 60.0) : Perl_ceil(time / 60.0);
380 v_tm_hour = (int)Perl_fmod(time, 24.0);
381 time = time >= 0 ? Perl_floor(time / 24.0) : Perl_ceil(time / 24.0);
384 WRAP (v_tm_sec, v_tm_min, 60);
385 WRAP (v_tm_min, v_tm_hour, 60);
386 WRAP (v_tm_hour, v_tm_tday, 24);
388 v_tm_wday = (int)Perl_fmod((v_tm_tday + 4.0), 7.0);
393 if (m >= CHEAT_DAYS) {
399 /* Gregorian cycles, this is huge optimization for distant times */
400 cycles = (int)Perl_floor(m / (Time64_T) days_in_gregorian_cycle);
402 m -= (cycles * (Time64_T) days_in_gregorian_cycle);
403 year += (cycles * years_in_gregorian_cycle);
407 leap = IS_LEAP (year);
408 while (m >= (Time64_T) length_of_year[leap]) {
409 m -= (Time64_T) length_of_year[leap];
411 leap = IS_LEAP (year);
416 while (m >= (Time64_T) days_in_month[leap][v_tm_mon]) {
417 m -= (Time64_T) days_in_month[leap][v_tm_mon];
423 /* Gregorian cycles */
424 cycles = (int)Perl_ceil((m / (Time64_T) days_in_gregorian_cycle) + 1);
426 m -= (cycles * (Time64_T) days_in_gregorian_cycle);
427 year += (cycles * years_in_gregorian_cycle);
431 leap = IS_LEAP (year);
432 while (m < (Time64_T) -length_of_year[leap]) {
433 m += (Time64_T) length_of_year[leap];
435 leap = IS_LEAP (year);
440 while (m < (Time64_T) -days_in_month[leap][v_tm_mon]) {
441 m += (Time64_T) days_in_month[leap][v_tm_mon];
444 m += (Time64_T) days_in_month[leap][v_tm_mon];
448 if( p->tm_year != year ) {
455 /* At this point m is less than a year so casting to an int is safe */
456 p->tm_mday = (int) m + 1;
457 p->tm_yday = julian_days_by_month[leap][v_tm_mon] + (int)m;
458 p->tm_sec = v_tm_sec;
459 p->tm_min = v_tm_min;
460 p->tm_hour = v_tm_hour;
461 p->tm_mon = v_tm_mon;
462 p->tm_wday = v_tm_wday;
464 assert(S_check_tm(p));
470 static struct TM *S_localtime64_r (const Time64_T *time, struct TM *local_tm)
478 assert(local_tm != NULL);
480 /* Use the system localtime() if time_t is small enough */
481 if( SHOULD_USE_SYSTEM_LOCALTIME(*time) ) {
482 safe_time = (time_t)*time;
484 TIME64_TRACE1("Using system localtime for %lld\n", *time);
486 LOCALTIME_R(&safe_time, &safe_date);
488 S_copy_little_tm_to_big_TM(&safe_date, local_tm);
489 assert(S_check_tm(local_tm));
494 if( S_gmtime64_r(time, &gm_tm) == NULL ) {
495 TIME64_TRACE1("gmtime64_r returned null for %lld\n", *time);
499 orig_year = gm_tm.tm_year;
501 if (gm_tm.tm_year > (2037 - 1900) ||
502 gm_tm.tm_year < (1970 - 1900)
505 TIME64_TRACE1("Mapping tm_year %lld to safe_year\n", (Year)gm_tm.tm_year);
506 gm_tm.tm_year = S_safe_year((Year)(gm_tm.tm_year + 1900)) - 1900;
509 safe_time = (time_t)S_timegm64(&gm_tm);
510 if( LOCALTIME_R(&safe_time, &safe_date) == NULL ) {
511 TIME64_TRACE1("localtime_r(%d) returned NULL\n", (int)safe_time);
515 S_copy_little_tm_to_big_TM(&safe_date, local_tm);
517 local_tm->tm_year = orig_year;
518 if( local_tm->tm_year != orig_year ) {
519 TIME64_TRACE2("tm_year overflow: tm_year %lld, orig_year %lld\n",
520 (Year)local_tm->tm_year, (Year)orig_year);
529 month_diff = local_tm->tm_mon - gm_tm.tm_mon;
531 /* When localtime is Dec 31st previous year and
532 gmtime is Jan 1st next year.
534 if( month_diff == 11 ) {
538 /* When localtime is Jan 1st, next year and
539 gmtime is Dec 31st, previous year.
541 if( month_diff == -11 ) {
545 /* GMT is Jan 1st, xx01 year, but localtime is still Dec 31st
546 in a non-leap xx00. There is one point in the cycle
547 we can't account for which the safe xx00 year is a leap
548 year. So we need to correct for Dec 31st coming out as
549 the 366th day of the year.
551 if( !IS_LEAP(local_tm->tm_year) && local_tm->tm_yday == 365 )
554 assert(S_check_tm(local_tm));