(__tzfile_read): Fix comment.
[kopensolaris-gnu/glibc.git] / time / tzfile.c
1 /* Copyright (C) 1991, 92, 93, 95, 96, 97, 98 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 <assert.h>
20 #include <limits.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <time.h>
25 #include <unistd.h>
26
27 #define NOID
28 #include <timezone/tzfile.h>
29
30 int __use_tzfile = 0;
31
32 struct ttinfo
33   {
34     long int offset;            /* Seconds east of GMT.  */
35     unsigned char isdst;        /* Used to set tm_isdst.  */
36     unsigned char idx;          /* Index into `zone_names'.  */
37     unsigned char isstd;        /* Transition times are in standard time.  */
38     unsigned char isgmt;        /* Transition times are in GMT.  */
39   };
40
41 struct leap
42   {
43     time_t transition;          /* Time the transition takes effect.  */
44     long int change;            /* Seconds of correction to apply.  */
45   };
46
47 extern char * __tzstring (const char *); /* Defined in tzset.c.  */
48
49 static struct ttinfo *find_transition (time_t timer) internal_function;
50 static void compute_tzname_max (size_t) internal_function;
51
52 static size_t num_transitions;
53 static time_t *transitions = NULL;
54 static unsigned char *type_idxs = NULL;
55 static size_t num_types;
56 static struct ttinfo *types = NULL;
57 static char *zone_names = NULL;
58 static long int rule_stdoff;
59 static long int rule_dstoff;
60 static size_t num_leaps;
61 static struct leap *leaps = NULL;
62
63 #include <endian.h>
64 #include <byteswap.h>
65
66 /* Decode the four bytes at PTR as a signed integer in network byte order.  */
67 static inline int
68 decode (const void *ptr)
69 {
70   if ((BYTE_ORDER == BIG_ENDIAN) && sizeof (int) == 4)
71     return *(const int *) ptr;
72   else if (BYTE_ORDER == LITTLE_ENDIAN && sizeof (int) == 4)
73     return bswap_32 (*(const int *) ptr);
74   else
75     {
76       const unsigned char *p = ptr;
77       int result = *p & (1 << (CHAR_BIT - 1)) ? ~0 : 0;
78
79       result = (result << 8) | *p++;
80       result = (result << 8) | *p++;
81       result = (result << 8) | *p++;
82       result = (result << 8) | *p++;
83
84       return result;
85     }
86 }
87
88 void
89 __tzfile_read (const char *file)
90 {
91   static const char default_tzdir[] = TZDIR;
92   size_t num_isstd, num_isgmt;
93   register FILE *f;
94   struct tzhead tzhead;
95   size_t chars;
96   register size_t i;
97
98   __use_tzfile = 0;
99
100   if (transitions != NULL)
101     free ((void *) transitions);
102   transitions = NULL;
103   if (type_idxs != NULL)
104     free ((void *) type_idxs);
105   type_idxs = NULL;
106   if (types != NULL)
107     free ((void *) types);
108   types = NULL;
109   if (zone_names != NULL)
110     free ((void *) zone_names);
111   zone_names = NULL;
112   if (leaps != NULL)
113     free ((void *) leaps);
114   leaps = NULL;
115
116   if (file == NULL)
117     /* No user specification; use the site-wide default.  */
118     file = TZDEFAULT;
119   else if (*file == '\0')
120     /* User specified the empty string; use UTC with no leap seconds.  */
121     return;
122   else
123     {
124       /* We must not allow to read an arbitrary file in a setuid
125          program.  So we fail for any file which is not in the
126          directory hierachy starting at TZDIR
127          and which is not the system wide default TZDEFAULT.  */
128       if (__libc_enable_secure
129           && ((*file == '/'
130                && memcmp (file, TZDEFAULT, sizeof TZDEFAULT)
131                && memcmp (file, default_tzdir, sizeof (default_tzdir) - 1))
132               || strstr (file, "../") != NULL))
133         /* This test is certainly a bit too restrictive but it should
134            catch all critical cases.  */
135         return;
136     }
137
138   if (*file != '/')
139     {
140       const char *tzdir;
141       unsigned int len, tzdir_len;
142       char *new, *tmp;
143
144       tzdir = __secure_getenv ("TZDIR");
145       if (tzdir == NULL || *tzdir == '\0')
146         {
147           tzdir = default_tzdir;
148           tzdir_len = sizeof (default_tzdir) - 1;
149         }
150       else
151         tzdir_len = strlen (tzdir);
152       len = strlen (file) + 1;
153       new = (char *) __alloca (tzdir_len + 1 + len);
154       tmp = __mempcpy (new, tzdir, tzdir_len);
155       *tmp++ = '/';
156       __mempcpy (tmp, file, len);
157       file = new;
158     }
159
160   f = fopen (file, "r");
161   if (f == NULL)
162     return;
163
164   if (fread_unlocked ((void *) &tzhead, sizeof (tzhead), 1, f) != 1)
165     goto lose;
166
167   num_transitions = (size_t) decode (tzhead.tzh_timecnt);
168   num_types = (size_t) decode (tzhead.tzh_typecnt);
169   chars = (size_t) decode (tzhead.tzh_charcnt);
170   num_leaps = (size_t) decode (tzhead.tzh_leapcnt);
171   num_isstd = (size_t) decode (tzhead.tzh_ttisstdcnt);
172   num_isgmt = (size_t) decode (tzhead.tzh_ttisgmtcnt);
173
174   if (num_transitions > 0)
175     {
176       transitions = (time_t *) malloc (num_transitions * sizeof (time_t));
177       if (transitions == NULL)
178         goto lose;
179       type_idxs = (unsigned char *) malloc (num_transitions);
180       if (type_idxs == NULL)
181         goto lose;
182     }
183   if (num_types > 0)
184     {
185       types = (struct ttinfo *) malloc (num_types * sizeof (struct ttinfo));
186       if (types == NULL)
187         goto lose;
188     }
189   if (chars > 0)
190     {
191       zone_names = (char *) malloc (chars);
192       if (zone_names == NULL)
193         goto lose;
194     }
195   if (num_leaps > 0)
196     {
197       leaps = (struct leap *) malloc (num_leaps * sizeof (struct leap));
198       if (leaps == NULL)
199         goto lose;
200     }
201
202   if (sizeof (time_t) < 4)
203       abort ();
204
205   if (fread_unlocked (transitions, 4, num_transitions, f) != num_transitions
206       || fread_unlocked (type_idxs, 1, num_transitions, f) != num_transitions)
207     goto lose;
208
209   /* Check for bogus indices in the data file, so we can hereafter
210      safely use type_idxs[T] as indices into `types' and never crash.  */
211   for (i = 0; i < num_transitions; ++i)
212     if (type_idxs[i] >= num_types)
213       goto lose;
214
215   if (BYTE_ORDER != BIG_ENDIAN || sizeof (time_t) != 4)
216     {
217       /* Decode the transition times, stored as 4-byte integers in
218          network (big-endian) byte order.  We work from the end of
219          the array so as not to clobber the next element to be
220          processed when sizeof (time_t) > 4.  */
221       i = num_transitions;
222       while (i-- > 0)
223         transitions[i] = decode ((char *) transitions + i * 4);
224     }
225
226   for (i = 0; i < num_types; ++i)
227     {
228       unsigned char x[4];
229       if (fread_unlocked (x, 1, 4, f) != 4
230           || fread_unlocked (&types[i].isdst, 1, 1, f) != 1
231           || fread_unlocked (&types[i].idx, 1, 1, f) != 1)
232         goto lose;
233       if (types[i].isdst > 1)
234         goto lose;
235       if (types[i].idx >= chars) /* Bogus index in data file.  */
236         goto lose;
237       types[i].offset = (long int) decode (x);
238     }
239
240   if (fread_unlocked (zone_names, 1, chars, f) != chars)
241     goto lose;
242
243   for (i = 0; i < num_leaps; ++i)
244     {
245       unsigned char x[4];
246       if (fread_unlocked (x, 1, sizeof (x), f) != sizeof (x))
247         goto lose;
248       leaps[i].transition = (time_t) decode (x);
249       if (fread_unlocked (x, 1, sizeof (x), f) != sizeof (x))
250         goto lose;
251       leaps[i].change = (long int) decode (x);
252     }
253
254   for (i = 0; i < num_isstd; ++i)
255     {
256       int c = getc_unlocked (f);
257       if (c == EOF)
258         goto lose;
259       types[i].isstd = c != 0;
260     }
261   while (i < num_types)
262     types[i++].isstd = 0;
263
264   for (i = 0; i < num_isgmt; ++i)
265     {
266       int c = getc_unlocked (f);
267       if (c == EOF)
268         goto lose;
269       types[i].isgmt = c != 0;
270     }
271   while (i < num_types)
272     types[i++].isgmt = 0;
273
274   fclose (f);
275
276   /* First "register" all timezone names.  */
277   for (i = 0; i < num_types; ++i)
278     (void) __tzstring (&zone_names[types[i].idx]);
279
280   /* Find the standard and daylight time offsets used by the rule file.
281      We choose the offsets in the types of each flavor that are
282      transitioned to earliest in time.  */
283   __tzname[0] = NULL;
284   __tzname[1] = NULL;
285   for (i = num_transitions; i > 0; )
286     {
287       int type = type_idxs[--i];
288       int dst = types[type].isdst;
289       int idx = types[type].idx;
290
291       if (__tzname[dst] == NULL)
292         {
293           __tzname[dst] = __tzstring (&zone_names[idx]);
294
295           if (__tzname[1 - dst] != NULL)
296             break;
297         }
298     }
299   if (__tzname[0] == NULL)
300     {
301       /* This should only happen if there are no transition rules.
302          In this case there should be only one single type.  */
303       assert (num_types == 1);
304       __tzname[0] = __tzstring (zone_names);
305     }
306   if (__tzname[1] == NULL)
307     __tzname[1] = __tzname[0];
308
309   compute_tzname_max (chars);
310
311   if (num_transitions == 0)
312     /* Use the first rule (which should also be the only one).  */
313     rule_stdoff = rule_dstoff = types[0].offset;
314   else
315     {
316       rule_stdoff = rule_dstoff = 0;
317       for (i = 0; i < num_transitions; ++i)
318         {
319           if (!rule_stdoff && !types[type_idxs[i]].isdst)
320             rule_stdoff = types[type_idxs[i]].offset;
321           if (!rule_dstoff && types[type_idxs[i]].isdst)
322             rule_dstoff = types[type_idxs[i]].offset;
323           if (rule_stdoff && rule_dstoff)
324             break;
325         }
326     }
327
328   __daylight = rule_stdoff != rule_dstoff;
329   __timezone = -rule_stdoff;
330
331   __use_tzfile = 1;
332   return;
333
334  lose:
335   fclose (f);
336 }
337 \f
338 /* The user specified a hand-made timezone, but not its DST rules.
339    We will use the names and offsets from the user, and the rules
340    from the TZDEFRULES file.  */
341
342 void
343 __tzfile_default (const char *std, const char *dst,
344                   long int stdoff, long int dstoff)
345 {
346   size_t stdlen, dstlen, i;
347   int isdst;
348
349   __tzfile_read (TZDEFRULES);
350   if (!__use_tzfile)
351     return;
352
353   if (num_types < 2)
354     {
355       __use_tzfile = 0;
356       return;
357     }
358
359   /* Ignore the zone names read from the file.  */
360   free (zone_names);
361
362   /* Use the names the user specified.  */
363   stdlen = strlen (std) + 1;
364   dstlen = strlen (dst) + 1;
365   zone_names = malloc (stdlen + dstlen);
366   if (zone_names == NULL)
367     {
368       __use_tzfile = 0;
369       return;
370     }
371   __mempcpy (__mempcpy (zone_names, std, stdlen), dst, dstlen);
372
373   /* Now there are only two zones, regardless of what the file contained.  */
374   num_types = 2;
375
376   /* Now correct the transition times for the user-specified standard and
377      daylight offsets from GMT.  */
378   isdst = 0;
379   for (i = 0; i < num_transitions; ++i)
380     {
381       struct ttinfo *trans_type = &types[type_idxs[i]];
382
383       /* We will use only types 0 (standard) and 1 (daylight).
384          Fix up this transition to point to whichever matches
385          the flavor of its original type.  */
386       type_idxs[i] = trans_type->isdst;
387
388       if (trans_type->isgmt)
389         /* The transition time is in GMT.  No correction to apply.  */ ;
390       else if (isdst && !trans_type->isstd)
391         /* The type says this transition is in "local wall clock time", and
392            wall clock time as of the previous transition was DST.  Correct
393            for the difference between the rule's DST offset and the user's
394            DST offset.  */
395         transitions[i] += dstoff - rule_dstoff;
396       else
397         /* This transition is in "local wall clock time", and wall clock
398            time as of this iteration is non-DST.  Correct for the
399            difference between the rule's standard offset and the user's
400            standard offset.  */
401         transitions[i] += stdoff - rule_stdoff;
402
403       /* The DST state of "local wall clock time" for the next iteration is
404          as specified by this transition.  */
405       isdst = trans_type->isdst;
406     }
407
408   /* Reset types 0 and 1 to describe the user's settings.  */
409   types[0].idx = 0;
410   types[0].offset = stdoff;
411   types[0].isdst = 0;
412   types[1].idx = stdlen;
413   types[1].offset = dstoff;
414   types[1].isdst = 1;
415
416   /* Reset the zone names to point to the user's names.  */
417   __tzname[0] = (char *) std;
418   __tzname[1] = (char *) dst;
419
420   /* Set the timezone.  */
421   __timezone = -types[0].offset;
422
423   compute_tzname_max (stdlen + dstlen);
424 }
425 \f
426 static struct ttinfo *
427 internal_function
428 find_transition (time_t timer)
429 {
430   size_t i;
431
432   if (num_transitions == 0 || timer < transitions[0])
433     {
434       /* TIMER is before any transition (or there are no transitions).
435          Choose the first non-DST type
436          (or the first if they're all DST types).  */
437       i = 0;
438       while (i < num_types && types[i].isdst)
439         ++i;
440       if (i == num_types)
441         i = 0;
442     }
443   else
444     {
445       /* Find the first transition after TIMER, and
446          then pick the type of the transition before it.  */
447       for (i = 1; i < num_transitions; ++i)
448         if (timer < transitions[i])
449           break;
450       i = type_idxs[i - 1];
451     }
452
453   return &types[i];
454 }
455 \f
456 int
457 __tzfile_compute (time_t timer, int use_localtime,
458                   long int *leap_correct, int *leap_hit,
459                   struct tm *tp)
460 {
461   register size_t i;
462
463   if (use_localtime)
464     {
465       struct ttinfo *info = find_transition (timer);
466       __daylight = rule_stdoff != rule_dstoff;
467       __timezone = -rule_stdoff;
468       __tzname[0] = NULL;
469       __tzname[1] = NULL;
470       for (i = num_transitions; i > 0; )
471         {
472           int type = type_idxs[--i];
473           int dst = types[type].isdst;
474           int idx = types[type].idx;
475
476           if (__tzname[dst] == NULL)
477             {
478               __tzname[dst] = __tzstring (&zone_names[idx]);
479
480               if (__tzname[1 - dst] != NULL)
481                 break;
482             }
483         }
484       if (__tzname[0] == NULL)
485         {
486           /* This should only happen if there are no transition rules.
487              In this case there should be only one single type.  */
488           assert (num_types == 1);
489           __tzname[0] = __tzstring (zone_names);
490         }
491       if (__tzname[1] == NULL)
492         /* There is no daylight saving time.  */
493         __tzname[1] = __tzname[0];
494       tp->tm_isdst = info->isdst;
495       tp->tm_zone = &zone_names[info->idx];
496       tp->tm_gmtoff = info->offset;
497     }
498
499   *leap_correct = 0L;
500   *leap_hit = 0;
501
502   /* Find the last leap second correction transition time before TIMER.  */
503   i = num_leaps;
504   do
505     if (i-- == 0)
506       return 1;
507   while (timer < leaps[i].transition);
508
509   /* Apply its correction.  */
510   *leap_correct = leaps[i].change;
511
512   if (timer == leaps[i].transition && /* Exactly at the transition time.  */
513       ((i == 0 && leaps[i].change > 0) ||
514        leaps[i].change > leaps[i - 1].change))
515     {
516       *leap_hit = 1;
517       while (i > 0
518              && leaps[i].transition == leaps[i - 1].transition + 1
519              && leaps[i].change == leaps[i - 1].change + 1)
520         {
521           ++*leap_hit;
522           --i;
523         }
524     }
525
526   return 1;
527 }
528 \f
529 static void
530 internal_function
531 compute_tzname_max (size_t chars)
532 {
533   extern size_t __tzname_cur_max; /* Defined in tzset.c. */
534
535   const char *p;
536
537   p = zone_names;
538   do
539     {
540       const char *start = p;
541       while (*p != '\0')
542         ++p;
543       if ((size_t) (p - start) > __tzname_cur_max)
544         __tzname_cur_max = p - start;
545     }
546   while (++p < &zone_names[chars]);
547 }