time/tzfile.c

   1 /* Copyright (C) 1991, 92, 93, 95, 96, 97 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public License as
   6    published by the Free Software Foundation; either version 2 of the
   7    License, or (at your option) any later version.
   8
   9    The GNU C Library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public
  15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17    Boston, MA 02111-1307, USA.  */
  18
  19 #include <stdlib.h>
  20 #include <stdio.h>
  21 #include <time.h>
  22 #include <string.h>
  23 #include <limits.h>
  24
  25 #define NOID
  26 #include <tzfile.h>
  27
  28 int __use_tzfile = 0;
  29
  30 struct ttinfo
  31   {
  32     long int offset;            /* Seconds east of GMT.  */
  33     unsigned char isdst;        /* Used to set tm_isdst.  */
  34     unsigned char idx;          /* Index into `zone_names'.  */
  35     unsigned char isstd;        /* Transition times are in standard time.  */
  36     unsigned char isgmt;        /* Transition times are in GMT.  */
  37   };
  38
  39 struct leap
  40   {
  41     time_t transition;          /* Time the transition takes effect.  */
  42     long int change;            /* Seconds of correction to apply.  */
  43   };
  44
  45 static struct ttinfo *find_transition (time_t timer);
  46 static void compute_tzname_max (size_t);
  47
  48 static size_t num_transitions;
  49 static time_t *transitions = NULL;
  50 static unsigned char *type_idxs = NULL;
  51 static size_t num_types;
  52 static struct ttinfo *types = NULL;
  53 static char *zone_names = NULL;
  54 static size_t num_leaps;
  55 static struct leap *leaps = NULL;
  56
  57 #include <endian.h>
  58
  59 /* Decode the four bytes at PTR as a signed integer in network byte order.  */
  60 static inline int
  61 decode (const void *ptr)
  62 {
  63   if ((BYTE_ORDER == BIG_ENDIAN) && sizeof (int) == 4)
  64     return *(const int *) ptr;
  65   else
  66     {
  67       const unsigned char *p = ptr;
  68       int result = *p & (1 << (CHAR_BIT - 1)) ? ~0 : 0;
  69
  70       result = (result << 8) | *p++;
  71       result = (result << 8) | *p++;
  72       result = (result << 8) | *p++;
  73       result = (result << 8) | *p++;
  74
  75       return result;
  76     }
  77 }
  78
  79 void
  80 __tzfile_read (const char *file)
  81 {
  82   size_t num_isstd, num_isgmt;
  83   register FILE *f;
  84   struct tzhead tzhead;
  85   size_t chars;
  86   register size_t i;
  87   struct ttinfo *info;
  88
  89   __use_tzfile = 0;
  90
  91   if (transitions != NULL)
  92     free ((void *) transitions);
  93   transitions = NULL;
  94   if (type_idxs != NULL)
  95     free ((void *) type_idxs);
  96   type_idxs = NULL;
  97   if (types != NULL)
  98     free ((void *) types);
  99   types = NULL;
 100   if (zone_names != NULL)
 101     free ((void *) zone_names);
 102   zone_names = NULL;
 103   if (leaps != NULL)
 104     free ((void *) leaps);
 105   leaps = NULL;
 106
 107   if (file == NULL)
 108     /* No user specification; use the site-wide default.  */
 109     file = TZDEFAULT;
 110   else if (*file == '\0')
 111     /* User specified the empty string; use UTC explicitly.  */
 112     file = "Universal";
 113
 114   if (*file != '/')
 115     {
 116       static const char default_tzdir[] = TZDIR;
 117       const char *tzdir;
 118       unsigned int len, tzdir_len;
 119       char *new;
 120
 121       tzdir = __secure_getenv ("TZDIR");
 122       if (tzdir == NULL || *tzdir == '\0')
 123         {
 124           tzdir = default_tzdir;
 125           tzdir_len = sizeof (default_tzdir) - 1;
 126         }
 127       else
 128         tzdir_len = strlen (tzdir);
 129       len = strlen (file) + 1;
 130       new = (char *) __alloca (tzdir_len + 1 + len);
 131       memcpy (new, tzdir, tzdir_len);
 132       new[tzdir_len] = '/';
 133       memcpy (&new[tzdir_len + 1], file, len);
 134       file = new;
 135     }
 136
 137   f = fopen (file, "r");
 138   if (f == NULL)
 139     return;
 140
 141   if (fread ((void *) &tzhead, sizeof (tzhead), 1, f) != 1)
 142     goto lose;
 143
 144   num_transitions = (size_t) decode (tzhead.tzh_timecnt);
 145   num_types = (size_t) decode (tzhead.tzh_typecnt);
 146   chars = (size_t) decode (tzhead.tzh_charcnt);
 147   num_leaps = (size_t) decode (tzhead.tzh_leapcnt);
 148   num_isstd = (size_t) decode (tzhead.tzh_ttisstdcnt);
 149   num_isgmt = (size_t) decode (tzhead.tzh_ttisgmtcnt);
 150
 151   if (num_transitions > 0)
 152     {
 153       transitions = (time_t *) malloc (num_transitions * sizeof(time_t));
 154       if (transitions == NULL)
 155         goto lose;
 156       type_idxs = (unsigned char *) malloc (num_transitions);
 157       if (type_idxs == NULL)
 158         goto lose;
 159     }
 160   if (num_types > 0)
 161     {
 162       types = (struct ttinfo *) malloc (num_types * sizeof (struct ttinfo));
 163       if (types == NULL)
 164         goto lose;
 165     }
 166   if (chars > 0)
 167     {
 168       zone_names = (char *) malloc (chars);
 169       if (zone_names == NULL)
 170         goto lose;
 171     }
 172   if (num_leaps > 0)
 173     {
 174       leaps = (struct leap *) malloc (num_leaps * sizeof (struct leap));
 175       if (leaps == NULL)
 176         goto lose;
 177     }
 178
 179   if (sizeof (time_t) < 4)
 180       abort ();
 181
 182   if (fread(transitions, 4, num_transitions, f) != num_transitions ||
 183       fread(type_idxs, 1, num_transitions, f) != num_transitions)
 184     goto lose;
 185
 186   /* Check for bogus indices in the data file, so we can hereafter
 187      safely use type_idxs[T] as indices into `types' and never crash.  */
 188   for (i = 0; i < num_transitions; ++i)
 189     if (type_idxs[i] >= num_types)
 190       goto lose;
 191
 192   if (BYTE_ORDER != BIG_ENDIAN || sizeof (time_t) != 4)
 193     {
 194       /* Decode the transition times, stored as 4-byte integers in
 195          network (big-endian) byte order.  We work from the end of
 196          the array so as not to clobber the next element to be
 197          processed when sizeof (time_t) > 4.  */
 198       i = num_transitions;
 199       while (i-- > 0)
 200         transitions[i] = decode ((char *) transitions + i*4);
 201     }
 202
 203   for (i = 0; i < num_types; ++i)
 204     {
 205       unsigned char x[4];
 206       if (fread (x, 1, 4, f) != 4 ||
 207           fread (&types[i].isdst, 1, 1, f) != 1 ||
 208           fread (&types[i].idx, 1, 1, f) != 1)
 209         goto lose;
 210       if (types[i].idx >= chars) /* Bogus index in data file.  */
 211         goto lose;
 212       types[i].offset = (long int) decode (x);
 213     }
 214
 215   if (fread (zone_names, 1, chars, f) != chars)
 216     goto lose;
 217
 218   for (i = 0; i < num_leaps; ++i)
 219     {
 220       unsigned char x[4];
 221       if (fread (x, 1, sizeof (x), f) != sizeof (x))
 222         goto lose;
 223       leaps[i].transition = (time_t) decode (x);
 224       if (fread (x, 1, sizeof (x), f) != sizeof (x))
 225         goto lose;
 226       leaps[i].change = (long int) decode (x);
 227     }
 228
 229   for (i = 0; i < num_isstd; ++i)
 230     {
 231       char c = getc (f);
 232       if (c == EOF)
 233         goto lose;
 234       types[i].isstd = c != 0;
 235     }
 236   while (i < num_types)
 237     types[i++].isstd = 0;
 238
 239   for (i = 0; i < num_isgmt; ++i)
 240     {
 241       char c = getc (f);
 242       if (c == EOF)
 243         goto lose;
 244       types[i].isgmt = c != 0;
 245     }
 246   while (i < num_types)
 247     types[i++].isgmt = 0;
 248
 249   fclose (f);
 250
 251   info = find_transition (0);
 252   for (i = 0; i < num_types && i < sizeof (__tzname) / sizeof (__tzname[0]);
 253        ++i)
 254     __tzname[types[i].isdst] = &zone_names[types[i].idx];
 255   if (info->isdst < sizeof (__tzname) / sizeof (__tzname[0]))
 256     __tzname[info->isdst] = &zone_names[info->idx];
 257
 258   compute_tzname_max (chars);
 259
 260   __use_tzfile = 1;
 261   return;
 262
 263  lose:;
 264   fclose(f);
 265 }
 266 \f
 267 /* The user specified a hand-made timezone, but not its DST rules.
 268    We will use the names and offsets from the user, and the rules
 269    from the TZDEFRULES file.  */
 270
 271 void
 272 __tzfile_default (char *std, char *dst, long int stdoff, long int dstoff)
 273 {
 274   size_t stdlen, dstlen, i;
 275   long int rule_offset, rule_stdoff, rule_dstoff;
 276   int isdst;
 277
 278   __tzfile_read (TZDEFRULES);
 279   if (!__use_tzfile)
 280     return;
 281
 282   if (num_types < 2)
 283     {
 284       __use_tzfile = 0;
 285       return;
 286     }
 287
 288   /* Ignore the zone names read from the file.  */
 289   free (zone_names);
 290
 291   /* Use the names the user specified.  */
 292   stdlen = strlen (std) + 1;
 293   dstlen = strlen (dst) + 1;
 294   zone_names = malloc (stdlen + dstlen);
 295   if (zone_names == NULL)
 296     {
 297       __use_tzfile = 0;
 298       return;
 299     }
 300   memcpy (zone_names, std, stdlen);
 301   memcpy (&zone_names[stdlen], dst, dstlen);
 302
 303   /* Find the standard and daylight time offsets used by the rule file.
 304      We choose the offsets in the types of each flavor that are
 305      transitioned to earliest in time.  */
 306   rule_stdoff = rule_dstoff = 0;
 307   for (i = 0; i < num_transitions; ++i)
 308     {
 309       if (!rule_stdoff && !types[type_idxs[i]].isdst)
 310         rule_stdoff = types[type_idxs[i]].offset;
 311       if (!rule_dstoff && types[type_idxs[i]].isdst)
 312         rule_dstoff = types[type_idxs[i]].offset;
 313       if (rule_stdoff && rule_dstoff)
 314         break;
 315     }
 316
 317   /* Now correct the transition times for the user-specified standard and
 318      daylight offsets from GMT.  */
 319   isdst = 0;
 320   rule_offset = rule_offset;
 321   for (i = 0; i < num_transitions; ++i)
 322     {
 323       struct ttinfo *trans_type = &types[type_idxs[i]];
 324
 325       /* We will use only types 0 (standard) and 1 (daylight).
 326          Fix up this transition to point to whichever matches
 327          the flavor of its original type.  */
 328       type_idxs[i] = trans_type->isdst;
 329
 330       if (trans_type->isgmt)
 331         /* The transition time is in GMT.  No correction to apply.  */ ;
 332       else if (isdst && !trans_type->isstd)
 333         /* The type says this transition is in "local wall clock time", and
 334            wall clock time as of the previous transition was DST.  Correct
 335            for the difference between the rule's DST offset and the user's
 336            DST offset.  */
 337         transitions[i] += dstoff - rule_dstoff;
 338       else
 339         /* This transition is in "local wall clock time", and wall clock
 340            time as of this iteration is non-DST.  Correct for the
 341            difference between the rule's standard offset and the user's
 342            standard offset.  */
 343         transitions[i] += stdoff - rule_stdoff;
 344
 345       /* The DST state of "local wall clock time" for the next iteration is
 346          as specified by this transition.  */
 347       isdst = trans_type->isdst;
 348     }
 349
 350   /* Reset types 0 and 1 to describe the user's settings.  */
 351   types[0].idx = 0;
 352   types[0].offset = stdoff;
 353   types[0].isdst = 0;
 354   types[1].idx = stdlen;
 355   types[1].offset = dstoff;
 356   types[1].isdst = 1;
 357
 358   /* Reset the zone names to point to the user's names.  */
 359   __tzname[0] = &zone_names[0];
 360   __tzname[1] = &zone_names[stdlen];
 361
 362   compute_tzname_max (stdlen + dstlen);
 363 }
 364 \f
 365 static struct ttinfo *
 366 find_transition (time_t timer)
 367 {
 368   size_t i;
 369
 370   if (num_transitions == 0 || timer < transitions[0])
 371     {
 372       /* TIMER is before any transition (or there are no transitions).
 373          Choose the first non-DST type
 374          (or the first if they're all DST types).  */
 375       i = 0;
 376       while (i < num_types && types[i].isdst)
 377         ++i;
 378       if (i == num_types)
 379         i = 0;
 380     }
 381   else
 382     {
 383       /* Find the first transition after TIMER, and
 384          then pick the type of the transition before it.  */
 385       for (i = 1; i < num_transitions; ++i)
 386         if (timer < transitions[i])
 387           break;
 388       i = type_idxs[i - 1];
 389     }
 390
 391   return &types[i];
 392 }
 393 \f
 394 int
 395 __tzfile_compute (time_t timer, long int *leap_correct, int *leap_hit)
 396 {
 397   struct ttinfo *info;
 398   register size_t i;
 399
 400   info = find_transition (timer);
 401   __daylight = info->isdst;
 402   __timezone = info->offset;
 403   for (i = 0; i < num_types && i < sizeof (__tzname) / sizeof (__tzname[0]);
 404        ++i)
 405     __tzname[types[i].isdst] = &zone_names[types[i].idx];
 406   if (info->isdst < sizeof (__tzname) / sizeof (__tzname[0]))
 407     __tzname[info->isdst] = &zone_names[info->idx];
 408
 409   *leap_correct = 0L;
 410   *leap_hit = 0;
 411
 412   /* Find the last leap second correction transition time before TIMER.  */
 413   i = num_leaps;
 414   do
 415     if (i-- == 0)
 416       return 1;
 417   while (timer < leaps[i].transition);
 418
 419   /* Apply its correction.  */
 420   *leap_correct = leaps[i].change;
 421
 422   if (timer == leaps[i].transition && /* Exactly at the transition time.  */
 423       ((i == 0 && leaps[i].change > 0) ||
 424        leaps[i].change > leaps[i - 1].change))
 425     {
 426       *leap_hit = 1;
 427       while (i > 0 &&
 428              leaps[i].transition == leaps[i - 1].transition + 1 &&
 429              leaps[i].change == leaps[i - 1].change + 1)
 430         {
 431           ++*leap_hit;
 432           --i;
 433         }
 434     }
 435
 436   return 1;
 437 }
 438 \f
 439 void
 440 compute_tzname_max (size_t chars)
 441 {
 442   extern size_t __tzname_cur_max; /* Defined in __tzset.c. */
 443
 444   const char *p;
 445
 446   p = zone_names;
 447   do
 448     {
 449       const char *start = p;
 450       while (*p != '\0')
 451         ++p;
 452       if ((size_t) (p - start) > __tzname_cur_max)
 453         __tzname_cur_max = p - start;
 454     } while (++p < &zone_names[chars]);
 455 }