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 localtime64_r() is a 64-bit equivalent of localtime_r().
  37
  38 gmtime64_r() is a 64-bit equivalent of gmtime_r().
  39
  40 */
  41
  42 #include "time64.h"
  43
  44 static const int 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},
  47 };
  48
  49 static const int 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},
  52 };
  53
  54 static const int length_of_year[2] = { 365, 366 };
  55
  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;
  59
  60 /* 28 year calendar cycle between 2010 and 2037 */
  61 #define SOLAR_CYCLE_LENGTH 28
  62 static const int 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
  70 };
  71
  72 static const int dow_year_start[SOLAR_CYCLE_LENGTH] = {
  73     5, 0, 1, 2,     /* 0       2016 - 2019 */
  74     3, 5, 6, 0,     /* 4  */
  75     1, 3, 4, 5,     /* 8  */
  76     6, 1, 2, 3,     /* 12 */
  77     4, 6, 0, 1,     /* 16 */
  78     2, 4, 5, 6,     /* 20      2036, 2037, 2010, 2011 */
  79     0, 2, 3, 4      /* 24      2012, 2013, 2014, 2015 */
  80 };
  81
  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.
  85 */
  86 /* Number of days since epoch on Jan 1st, 2008 GMT */
  87 #define CHEAT_DAYS  (1199145600 / 24 / 60 / 60)
  88 #define CHEAT_YEARS 108
  89
  90 #define IS_LEAP(n)      ((!(((n) + 1900) % 400) || (!(((n) + 1900) % 4) && (((n) + 1900) % 100))) != 0)
  91 #define WRAP(a,b,m)     ((a) = ((a) <  0  ) ? ((b)--, (a) + (m)) : (a))
  92
  93 #ifdef USE_SYSTEM_LOCALTIME
  94 #    define SHOULD_USE_SYSTEM_LOCALTIME(a)  (       \
  95     (a) <= SYSTEM_LOCALTIME_MAX &&              \
  96     (a) >= SYSTEM_LOCALTIME_MIN                 \
  97 )
  98 #else
  99 #    define SHOULD_USE_SYSTEM_LOCALTIME(a)      (0)
 100 #endif
 101
 102 #ifdef USE_SYSTEM_GMTIME
 103 #    define SHOULD_USE_SYSTEM_GMTIME(a)     (       \
 104     (a) <= SYSTEM_GMTIME_MAX    &&              \
 105     (a) >= SYSTEM_GMTIME_MIN                    \
 106 )
 107 #else
 108 #    define SHOULD_USE_SYSTEM_GMTIME(a)         (0)
 109 #endif
 110
 111 /* Multi varadic macros are a C99 thing, alas */
 112 #ifdef TIME_64_DEBUG
 113 #    define TRACE(format) (fprintf(stderr, format))
 114 #    define TRACE1(format, var1)    (fprintf(stderr, format, var1))
 115 #    define TRACE2(format, var1, var2)    (fprintf(stderr, format, var1, var2))
 116 #    define TRACE3(format, var1, var2, var3)    (fprintf(stderr, format, var1, var2, var3))
 117 #else
 118 #    define TRACE(format) ((void)0)
 119 #    define TRACE1(format, var1) ((void)0)
 120 #    define TRACE2(format, var1, var2) ((void)0)
 121 #    define TRACE3(format, var1, var2, var3) ((void)0)
 122 #endif
 123
 124 static int is_exception_century(Year year)
 125 {
 126     int is_exception = ((year % 100 == 0) && !(year % 400 == 0));
 127     TRACE1("# is_exception_century: %s\n", is_exception ? "yes" : "no");
 128
 129     return(is_exception);
 130 }
 131
 132
 133 Time64_T timegm64(struct TM *date) {
 134     int      days    = 0;
 135     Time64_T seconds = 0;
 136     Year     year;
 137
 138     if( date->tm_year > 70 ) {
 139         year = 70;
 140         while( year < date->tm_year ) {
 141             days += length_of_year[IS_LEAP(year)];
 142             year++;
 143         }
 144     }
 145     else if ( date->tm_year < 70 ) {
 146         year = 69;
 147         do {
 148             days -= length_of_year[IS_LEAP(year)];
 149             year--;
 150         } while( year >= date->tm_year );
 151     }
 152
 153     days += julian_days_by_month[IS_LEAP(date->tm_year)][date->tm_mon];
 154     days += date->tm_mday - 1;
 155
 156     /* Avoid overflowing the days integer */
 157     seconds = days;
 158     seconds = seconds * 60 * 60 * 24;
 159
 160     seconds += date->tm_hour * 60 * 60;
 161     seconds += date->tm_min * 60;
 162     seconds += date->tm_sec;
 163
 164     return(seconds);
 165 }
 166
 167
 168 static int check_tm(struct TM *tm)
 169 {
 170     /* Don't forget leap seconds */
 171     assert(tm->tm_sec >= 0);
 172     assert(tm->tm_sec <= 61);
 173
 174     assert(tm->tm_min >= 0);
 175     assert(tm->tm_min <= 59);
 176
 177     assert(tm->tm_hour >= 0);
 178     assert(tm->tm_hour <= 23);
 179
 180     assert(tm->tm_mday >= 1);
 181     assert(tm->tm_mday <= days_in_month[IS_LEAP(tm->tm_year)][tm->tm_mon]);
 182
 183     assert(tm->tm_mon  >= 0);
 184     assert(tm->tm_mon  <= 11);
 185
 186     assert(tm->tm_wday >= 0);
 187     assert(tm->tm_wday <= 6);
 188
 189     assert(tm->tm_yday >= 0);
 190     assert(tm->tm_yday <= length_of_year[IS_LEAP(tm->tm_year)]);
 191
 192 #ifdef HAS_TM_TM_GMTOFF
 193     assert(tm->tm_gmtoff >= -24 * 60 * 60);
 194     assert(tm->tm_gmtoff <=  24 * 60 * 60);
 195 #endif
 196
 197     return 1;
 198 }
 199
 200
 201 /* The exceptional centuries without leap years cause the cycle to
 202    shift by 16
 203 */
 204 static Year cycle_offset(Year year)
 205 {
 206     const Year start_year = 2000;
 207     Year year_diff  = year - start_year;
 208     Year exceptions;
 209
 210     if( year > start_year )
 211         year_diff--;
 212
 213     exceptions  = year_diff / 100;
 214     exceptions -= year_diff / 400;
 215
 216     TRACE3("# year: %lld, exceptions: %lld, year_diff: %lld\n",
 217           year, exceptions, year_diff);
 218
 219     return exceptions * 16;
 220 }
 221
 222 /* For a given year after 2038, pick the latest possible matching
 223    year in the 28 year calendar cycle.
 224
 225    A matching year...
 226    1) Starts on the same day of the week.
 227    2) Has the same leap year status.
 228
 229    This is so the calendars match up.
 230
 231    Also the previous year must match.  When doing Jan 1st you might
 232    wind up on Dec 31st the previous year when doing a -UTC time zone.
 233
 234    Finally, the next year must have the same start day of week.  This
 235    is for Dec 31st with a +UTC time zone.
 236    It doesn't need the same leap year status since we only care about
 237    January 1st.
 238 */
 239 static int safe_year(Year year)
 240 {
 241     int safe_year;
 242     Year year_cycle = year + cycle_offset(year);
 243
 244     /* Change non-leap xx00 years to an equivalent */
 245     if( is_exception_century(year) )
 246         year_cycle += 11;
 247
 248     /* Also xx01 years, since the previous year will be wrong */
 249     if( is_exception_century(year - 1) )
 250         year_cycle += 17;
 251
 252     year_cycle %= SOLAR_CYCLE_LENGTH;
 253     if( year_cycle < 0 )
 254         year_cycle = SOLAR_CYCLE_LENGTH + year_cycle;
 255
 256     assert( year_cycle >= 0 );
 257     assert( year_cycle < SOLAR_CYCLE_LENGTH );
 258     safe_year = safe_years[year_cycle];
 259
 260     assert(safe_year <= 2037 && safe_year >= 2010);
 261
 262     TRACE3("# year: %lld, year_cycle: %lld, safe_year: %d\n",
 263           year, year_cycle, safe_year);
 264
 265     return safe_year;
 266 }
 267
 268
 269 void copy_little_tm_to_big_TM(const struct tm *src, struct TM *dest) {
 270     if( src == NULL ) {
 271         memset(dest, 0, sizeof(*dest));
 272     }
 273     else {
 274 #       ifdef USE_TM64
 275             dest->tm_sec        = src->tm_sec;
 276             dest->tm_min        = src->tm_min;
 277             dest->tm_hour       = src->tm_hour;
 278             dest->tm_mday       = src->tm_mday;
 279             dest->tm_mon        = src->tm_mon;
 280             dest->tm_year       = (Year)src->tm_year;
 281             dest->tm_wday       = src->tm_wday;
 282             dest->tm_yday       = src->tm_yday;
 283             dest->tm_isdst      = src->tm_isdst;
 284
 285 #           ifdef HAS_TM_TM_GMTOFF
 286                 dest->tm_gmtoff  = src->tm_gmtoff;
 287 #           endif
 288
 289 #           ifdef HAS_TM_TM_ZONE
 290                 dest->tm_zone  = src->tm_zone;
 291 #           endif
 292
 293 #       else
 294             /* They're the same type */
 295             memcpy(dest, src, sizeof(*dest));
 296 #       endif
 297     }
 298 }
 299
 300
 301 void copy_big_TM_to_little_tm(const struct TM *src, struct tm *dest) {
 302     if( src == NULL ) {
 303         memset(dest, 0, sizeof(*dest));
 304     }
 305     else {
 306 #       ifdef USE_TM64
 307             dest->tm_sec        = src->tm_sec;
 308             dest->tm_min        = src->tm_min;
 309             dest->tm_hour       = src->tm_hour;
 310             dest->tm_mday       = src->tm_mday;
 311             dest->tm_mon        = src->tm_mon;
 312             dest->tm_year       = (int)src->tm_year;
 313             dest->tm_wday       = src->tm_wday;
 314             dest->tm_yday       = src->tm_yday;
 315             dest->tm_isdst      = src->tm_isdst;
 316
 317 #           ifdef HAS_TM_TM_GMTOFF
 318                 dest->tm_gmtoff  = src->tm_gmtoff;
 319 #           endif
 320
 321 #           ifdef HAS_TM_TM_ZONE
 322                 dest->tm_zone  = src->tm_zone;
 323 #           endif
 324
 325 #       else
 326             /* They're the same type */
 327             memcpy(dest, src, sizeof(*dest));
 328 #       endif
 329     }
 330 }
 331
 332
 333 /* Simulate localtime_r() to the best of our ability */
 334 struct tm * fake_localtime_r(const time_t *clock, struct tm *result) {
 335     const struct tm *static_result = localtime(clock);
 336
 337     assert(result != NULL);
 338
 339     if( static_result == NULL ) {
 340         memset(result, 0, sizeof(*result));
 341         return NULL;
 342     }
 343     else {
 344         memcpy(result, static_result, sizeof(*result));
 345         return result;
 346     }
 347 }
 348
 349
 350 /* Simulate gmtime_r() to the best of our ability */
 351 struct tm * fake_gmtime_r(const time_t *clock, struct tm *result) {
 352     const struct tm *static_result = gmtime(clock);
 353
 354     assert(result != NULL);
 355
 356     if( static_result == NULL ) {
 357         memset(result, 0, sizeof(*result));
 358         return NULL;
 359     }
 360     else {
 361         memcpy(result, static_result, sizeof(*result));
 362         return result;
 363     }
 364 }
 365
 366
 367 struct TM *gmtime64_r (const Time64_T *in_time, struct TM *p)
 368 {
 369     int v_tm_sec, v_tm_min, v_tm_hour, v_tm_mon, v_tm_wday;
 370     Time64_T v_tm_tday;
 371     int leap;
 372     Time64_T m;
 373     Time64_T time = *in_time;
 374     Year year = 70;
 375     int cycles = 0;
 376
 377     assert(p != NULL);
 378
 379     /* Use the system gmtime() if time_t is small enough */
 380     if( SHOULD_USE_SYSTEM_GMTIME(*in_time) ) {
 381         time_t safe_time = *in_time;
 382         struct tm safe_date;
 383         GMTIME_R(&safe_time, &safe_date);
 384
 385         copy_little_tm_to_big_TM(&safe_date, p);
 386         assert(check_tm(p));
 387
 388         return p;
 389     }
 390
 391 #ifdef HAS_TM_TM_GMTOFF
 392     p->tm_gmtoff = 0;
 393 #endif
 394     p->tm_isdst  = 0;
 395
 396 #ifdef HAS_TM_TM_ZONE
 397     p->tm_zone   = "UTC";
 398 #endif
 399
 400     v_tm_sec =  (int)(time % 60);
 401     time /= 60;
 402     v_tm_min =  (int)(time % 60);
 403     time /= 60;
 404     v_tm_hour = (int)(time % 24);
 405     time /= 24;
 406     v_tm_tday = time;
 407
 408     WRAP (v_tm_sec, v_tm_min, 60);
 409     WRAP (v_tm_min, v_tm_hour, 60);
 410     WRAP (v_tm_hour, v_tm_tday, 24);
 411
 412     v_tm_wday = (int)((v_tm_tday + 4) % 7);
 413     if (v_tm_wday < 0)
 414         v_tm_wday += 7;
 415     m = v_tm_tday;
 416
 417     if (m >= CHEAT_DAYS) {
 418         year = CHEAT_YEARS;
 419         m -= CHEAT_DAYS;
 420     }
 421
 422     if (m >= 0) {
 423         /* Gregorian cycles, this is huge optimization for distant times */
 424         cycles = (int)(m / (Time64_T) days_in_gregorian_cycle);
 425         if( cycles ) {
 426             m -= (cycles * (Time64_T) days_in_gregorian_cycle);
 427             year += (cycles * years_in_gregorian_cycle);
 428         }
 429
 430         /* Years */
 431         leap = IS_LEAP (year);
 432         while (m >= (Time64_T) length_of_year[leap]) {
 433             m -= (Time64_T) length_of_year[leap];
 434             year++;
 435             leap = IS_LEAP (year);
 436         }
 437
 438         /* Months */
 439         v_tm_mon = 0;
 440         while (m >= (Time64_T) days_in_month[leap][v_tm_mon]) {
 441             m -= (Time64_T) days_in_month[leap][v_tm_mon];
 442             v_tm_mon++;
 443         }
 444     } else {
 445         year--;
 446
 447         /* Gregorian cycles */
 448         cycles = (int)((m / (Time64_T) days_in_gregorian_cycle) + 1);
 449         if( cycles ) {
 450             m -= (cycles * (Time64_T) days_in_gregorian_cycle);
 451             year += (cycles * years_in_gregorian_cycle);
 452         }
 453
 454         /* Years */
 455         leap = IS_LEAP (year);
 456         while (m < (Time64_T) -length_of_year[leap]) {
 457             m += (Time64_T) length_of_year[leap];
 458             year--;
 459             leap = IS_LEAP (year);
 460         }
 461
 462         /* Months */
 463         v_tm_mon = 11;
 464         while (m < (Time64_T) -days_in_month[leap][v_tm_mon]) {
 465             m += (Time64_T) days_in_month[leap][v_tm_mon];
 466             v_tm_mon--;
 467         }
 468         m += (Time64_T) days_in_month[leap][v_tm_mon];
 469     }
 470
 471     p->tm_year = year;
 472     if( p->tm_year != year ) {
 473 #ifdef EOVERFLOW
 474         errno = EOVERFLOW;
 475 #endif
 476         return NULL;
 477     }
 478
 479     /* At this point m is less than a year so casting to an int is safe */
 480     p->tm_mday = (int) m + 1;
 481     p->tm_yday = julian_days_by_month[leap][v_tm_mon] + (int)m;
 482     p->tm_sec  = v_tm_sec;
 483     p->tm_min  = v_tm_min;
 484     p->tm_hour = v_tm_hour;
 485     p->tm_mon  = v_tm_mon;
 486     p->tm_wday = v_tm_wday;
 487
 488     assert(check_tm(p));
 489
 490     return p;
 491 }
 492
 493
 494 struct TM *localtime64_r (const Time64_T *time, struct TM *local_tm)
 495 {
 496     time_t safe_time;
 497     struct tm safe_date;
 498     struct TM gm_tm;
 499     Year orig_year;
 500     int month_diff;
 501
 502     assert(local_tm != NULL);
 503
 504     /* Use the system localtime() if time_t is small enough */
 505     if( SHOULD_USE_SYSTEM_LOCALTIME(*time) ) {
 506         safe_time = *time;
 507
 508         TRACE1("Using system localtime for %lld\n", *time);
 509
 510         LOCALTIME_R(&safe_time, &safe_date);
 511
 512         copy_little_tm_to_big_TM(&safe_date, local_tm);
 513         assert(check_tm(local_tm));
 514
 515         return local_tm;
 516     }
 517
 518     if( gmtime64_r(time, &gm_tm) == NULL ) {
 519         TRACE1("gmtime64_r returned null for %lld\n", *time);
 520         return NULL;
 521     }
 522
 523     orig_year = gm_tm.tm_year;
 524
 525     if (gm_tm.tm_year > (2037 - 1900) ||
 526         gm_tm.tm_year < (1970 - 1900)
 527        )
 528     {
 529         TRACE1("Mapping tm_year %lld to safe_year\n", (Year)gm_tm.tm_year);
 530         gm_tm.tm_year = safe_year((Year)(gm_tm.tm_year + 1900)) - 1900;
 531     }
 532
 533     safe_time = timegm64(&gm_tm);
 534     if( LOCALTIME_R(&safe_time, &safe_date) == NULL ) {
 535         TRACE1("localtime_r(%d) returned NULL\n", (int)safe_time);
 536         return NULL;
 537     }
 538
 539     copy_little_tm_to_big_TM(&safe_date, local_tm);
 540
 541     local_tm->tm_year = orig_year;
 542     if( local_tm->tm_year != orig_year ) {
 543         TRACE2("tm_year overflow: tm_year %lld, orig_year %lld\n",
 544               (Year)local_tm->tm_year, (Year)orig_year);
 545
 546 #ifdef EOVERFLOW
 547         errno = EOVERFLOW;
 548 #endif
 549         return NULL;
 550     }
 551
 552
 553     month_diff = local_tm->tm_mon - gm_tm.tm_mon;
 554
 555     /*  When localtime is Dec 31st previous year and
 556         gmtime is Jan 1st next year.
 557     */
 558     if( month_diff == 11 ) {
 559         local_tm->tm_year--;
 560     }
 561
 562     /*  When localtime is Jan 1st, next year and
 563         gmtime is Dec 31st, previous year.
 564     */
 565     if( month_diff == -11 ) {
 566         local_tm->tm_year++;
 567     }
 568
 569     /* GMT is Jan 1st, xx01 year, but localtime is still Dec 31st
 570        in a non-leap xx00.  There is one point in the cycle
 571        we can't account for which the safe xx00 year is a leap
 572        year.  So we need to correct for Dec 31st comming out as
 573        the 366th day of the year.
 574     */
 575     if( !IS_LEAP(local_tm->tm_year) && local_tm->tm_yday == 365 )
 576         local_tm->tm_yday--;
 577
 578     assert(check_tm(local_tm));
 579
 580     return local_tm;
 581 }