Correct return value type __THROW marker of splice, vmsplice, and tee.
[glibc.git] / time / tzfile.c
blob0d48c8ca0cb318fe4d955d16583fcec937e311f7
1 /* Copyright (C) 1991-1993,1995-2001,2003,2004,2006
2 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18 02111-1307 USA. */
20 #include <assert.h>
21 #include <limits.h>
22 #include <stdio.h>
23 #include <stdio_ext.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <time.h>
27 #include <unistd.h>
28 #include <sys/stat.h>
30 #define NOID
31 #include <timezone/tzfile.h>
33 int __use_tzfile;
34 static dev_t tzfile_dev;
35 static ino64_t tzfile_ino;
36 static time_t tzfile_mtime;
38 struct ttinfo
40 long int offset; /* Seconds east of GMT. */
41 unsigned char isdst; /* Used to set tm_isdst. */
42 unsigned char idx; /* Index into `zone_names'. */
43 unsigned char isstd; /* Transition times are in standard time. */
44 unsigned char isgmt; /* Transition times are in GMT. */
47 struct leap
49 time_t transition; /* Time the transition takes effect. */
50 long int change; /* Seconds of correction to apply. */
53 static struct ttinfo *find_transition (time_t timer) internal_function;
54 static void compute_tzname_max (size_t) internal_function;
56 static size_t num_transitions;
57 libc_freeres_ptr (static time_t *transitions);
58 static unsigned char *type_idxs;
59 static size_t num_types;
60 static struct ttinfo *types;
61 static char *zone_names;
62 static long int rule_stdoff;
63 static long int rule_dstoff;
64 static size_t num_leaps;
65 static struct leap *leaps;
67 #include <endian.h>
68 #include <byteswap.h>
70 /* Decode the four bytes at PTR as a signed integer in network byte order. */
71 static inline int
72 __attribute ((always_inline))
73 decode (const void *ptr)
75 if (BYTE_ORDER == BIG_ENDIAN && sizeof (int) == 4)
76 return *(const int *) ptr;
77 if (sizeof (int) == 4)
78 return bswap_32 (*(const int *) ptr);
80 const unsigned char *p = ptr;
81 int result = *p & (1 << (CHAR_BIT - 1)) ? ~0 : 0;
83 result = (result << 8) | *p++;
84 result = (result << 8) | *p++;
85 result = (result << 8) | *p++;
86 result = (result << 8) | *p++;
88 return result;
92 static inline int64_t
93 __attribute ((always_inline))
94 decode64 (const void *ptr)
96 if ((BYTE_ORDER == BIG_ENDIAN))
97 return *(const int64_t *) ptr;
99 return bswap_64 (*(const int64_t *) ptr);
103 void
104 __tzfile_read (const char *file, size_t extra, char **extrap)
106 static const char default_tzdir[] = TZDIR;
107 size_t num_isstd, num_isgmt;
108 register FILE *f;
109 struct tzhead tzhead;
110 size_t chars;
111 register size_t i;
112 size_t total_size;
113 size_t types_idx;
114 size_t leaps_idx;
115 int was_using_tzfile = __use_tzfile;
116 int trans_width = 4;
118 if (sizeof (time_t) != 4 && sizeof (time_t) != 8)
119 abort ();
121 __use_tzfile = 0;
123 if (file == NULL)
124 /* No user specification; use the site-wide default. */
125 file = TZDEFAULT;
126 else if (*file == '\0')
127 /* User specified the empty string; use UTC with no leap seconds. */
128 goto ret_free_transitions;
129 else
131 /* We must not allow to read an arbitrary file in a setuid
132 program. So we fail for any file which is not in the
133 directory hierachy starting at TZDIR
134 and which is not the system wide default TZDEFAULT. */
135 if (__libc_enable_secure
136 && ((*file == '/'
137 && memcmp (file, TZDEFAULT, sizeof TZDEFAULT)
138 && memcmp (file, default_tzdir, sizeof (default_tzdir) - 1))
139 || strstr (file, "../") != NULL))
140 /* This test is certainly a bit too restrictive but it should
141 catch all critical cases. */
142 goto ret_free_transitions;
145 if (*file != '/')
147 const char *tzdir;
148 unsigned int len, tzdir_len;
149 char *new, *tmp;
151 tzdir = getenv ("TZDIR");
152 if (tzdir == NULL || *tzdir == '\0')
154 tzdir = default_tzdir;
155 tzdir_len = sizeof (default_tzdir) - 1;
157 else
158 tzdir_len = strlen (tzdir);
159 len = strlen (file) + 1;
160 new = (char *) __alloca (tzdir_len + 1 + len);
161 tmp = __mempcpy (new, tzdir, tzdir_len);
162 *tmp++ = '/';
163 memcpy (tmp, file, len);
164 file = new;
167 /* If we were already using tzfile, check whether the file changed. */
168 struct stat64 st;
169 if (was_using_tzfile
170 && stat64 (file, &st) == 0
171 && tzfile_ino == st.st_ino && tzfile_dev == st.st_dev
172 && tzfile_mtime == st.st_mtime)
174 /* Nothing to do. */
175 __use_tzfile = 1;
176 return;
179 /* Note the file is opened with cancellation in the I/O functions
180 disabled. */
181 f = fopen (file, "rc");
182 if (f == NULL)
183 goto ret_free_transitions;
185 /* Get information about the file we are actually using. */
186 if (fstat64 (fileno (f), &st) != 0)
188 fclose (f);
189 goto ret_free_transitions;
192 free ((void *) transitions);
193 transitions = NULL;
195 /* Remember the inode and device number and modification time. */
196 tzfile_dev = st.st_dev;
197 tzfile_ino = st.st_ino;
198 tzfile_mtime = st.st_mtime;
200 /* No threads reading this stream. */
201 __fsetlocking (f, FSETLOCKING_BYCALLER);
203 read_again:
204 if (__builtin_expect (fread_unlocked ((void *) &tzhead, sizeof (tzhead),
205 1, f) != 1, 0)
206 || memcmp (tzhead.tzh_magic, TZ_MAGIC, sizeof (tzhead.tzh_magic)) != 0)
207 goto lose;
209 num_transitions = (size_t) decode (tzhead.tzh_timecnt);
210 num_types = (size_t) decode (tzhead.tzh_typecnt);
211 chars = (size_t) decode (tzhead.tzh_charcnt);
212 num_leaps = (size_t) decode (tzhead.tzh_leapcnt);
213 num_isstd = (size_t) decode (tzhead.tzh_ttisstdcnt);
214 num_isgmt = (size_t) decode (tzhead.tzh_ttisgmtcnt);
216 /* For platforms with 64-bit time_t we use the new format if available. */
217 if (sizeof (time_t) == 8 && trans_width == 4
218 && tzhead.tzh_version[0] != '\0')
220 /* We use the 8-byte format. */
221 trans_width = 8;
223 /* Position the stream before the second header. */
224 size_t to_skip = (num_transitions * (4 + 1)
225 + num_types * 6
226 + chars
227 + num_leaps * 8
228 + num_isstd
229 + num_isgmt);
230 if (fseek (f, to_skip, SEEK_CUR) != 0)
231 goto lose;
233 goto read_again;
236 total_size = num_transitions * (sizeof (time_t) + 1);
237 total_size = ((total_size + __alignof__ (struct ttinfo) - 1)
238 & ~(__alignof__ (struct ttinfo) - 1));
239 types_idx = total_size;
240 total_size += num_types * sizeof (struct ttinfo) + chars;
241 total_size = ((total_size + __alignof__ (struct leap) - 1)
242 & ~(__alignof__ (struct leap) - 1));
243 leaps_idx = total_size;
244 total_size += num_leaps * sizeof (struct leap);
246 /* Allocate enough memory including the extra block requested by the
247 caller. */
248 transitions = (time_t *) malloc (total_size + extra);
249 if (transitions == NULL)
250 goto lose;
252 type_idxs = (unsigned char *) transitions + (num_transitions
253 * sizeof (time_t));
254 types = (struct ttinfo *) ((char *) transitions + types_idx);
255 zone_names = (char *) types + num_types * sizeof (struct ttinfo);
256 leaps = (struct leap *) ((char *) transitions + leaps_idx);
257 if (extra > 0)
258 *extrap = (char *) &leaps[num_leaps];
260 if (sizeof (time_t) == 4 || trans_width == 8)
262 if (__builtin_expect (fread_unlocked (transitions, trans_width + 1,
263 num_transitions, f)
264 != num_transitions, 0))
265 goto lose;
267 else
269 if (__builtin_expect (fread_unlocked (transitions, 4, num_transitions, f)
270 != num_transitions, 0)
271 || __builtin_expect (fread_unlocked (type_idxs, 1, num_transitions,
272 f) != num_transitions, 0))
273 goto lose;
276 /* Check for bogus indices in the data file, so we can hereafter
277 safely use type_idxs[T] as indices into `types' and never crash. */
278 for (i = 0; i < num_transitions; ++i)
279 if (__builtin_expect (type_idxs[i] >= num_types, 0))
280 goto lose;
282 if ((BYTE_ORDER != BIG_ENDIAN && (sizeof (time_t) == 4 || trans_width == 4))
283 || (BYTE_ORDER == BIG_ENDIAN && sizeof (time_t) == 8
284 && trans_width == 4))
286 /* Decode the transition times, stored as 4-byte integers in
287 network (big-endian) byte order. We work from the end of
288 the array so as not to clobber the next element to be
289 processed when sizeof (time_t) > 4. */
290 i = num_transitions;
291 while (i-- > 0)
292 transitions[i] = decode ((char *) transitions + i * 4);
294 else if (BYTE_ORDER != BIG_ENDIAN && sizeof (time_t) == 8)
296 /* Decode the transition times, stored as 8-byte integers in
297 network (big-endian) byte order. */
298 for (i = 0; i < num_transitions; ++i)
299 transitions[i] = decode64 ((char *) transitions + i * 8);
302 for (i = 0; i < num_types; ++i)
304 unsigned char x[4];
305 int c;
306 if (__builtin_expect (fread_unlocked (x, 1, sizeof (x), f) != sizeof (x),
308 goto lose;
309 c = getc_unlocked (f);
310 if (__builtin_expect ((unsigned int) c > 1u, 0))
311 goto lose;
312 types[i].isdst = c;
313 c = getc_unlocked (f);
314 if (__builtin_expect ((size_t) c > chars, 0))
315 /* Bogus index in data file. */
316 goto lose;
317 types[i].idx = c;
318 types[i].offset = (long int) decode (x);
321 if (__builtin_expect (fread_unlocked (zone_names, 1, chars, f) != chars, 0))
322 goto lose;
324 for (i = 0; i < num_leaps; ++i)
326 unsigned char x[8];
327 if (__builtin_expect (fread_unlocked (x, 1, trans_width, f)
328 != trans_width, 0))
329 goto lose;
330 if (sizeof (time_t) == 4 || trans_width == 4)
331 leaps[i].transition = (time_t) decode (x);
332 else
333 leaps[i].transition = (time_t) decode64 (x);
335 if (__builtin_expect (fread_unlocked (x, 1, 4, f) != 4, 0))
336 goto lose;
337 leaps[i].change = (long int) decode (x);
340 for (i = 0; i < num_isstd; ++i)
342 int c = getc_unlocked (f);
343 if (__builtin_expect (c == EOF, 0))
344 goto lose;
345 types[i].isstd = c != 0;
347 while (i < num_types)
348 types[i++].isstd = 0;
350 for (i = 0; i < num_isgmt; ++i)
352 int c = getc_unlocked (f);
353 if (__builtin_expect (c == EOF, 0))
354 goto lose;
355 types[i].isgmt = c != 0;
357 while (i < num_types)
358 types[i++].isgmt = 0;
360 /* XXX When a version 2 file is available it can contain a POSIX TZ-style
361 formatted string which specifies how times past the last one specified
362 are supposed to be handled. We might want to handle this at some
363 point. But it might be overhead since most/all? files have an
364 open-ended last entry. */
366 fclose (f);
368 /* First "register" all timezone names. */
369 for (i = 0; i < num_types; ++i)
370 (void) __tzstring (&zone_names[types[i].idx]);
372 /* Find the standard and daylight time offsets used by the rule file.
373 We choose the offsets in the types of each flavor that are
374 transitioned to earliest in time. */
375 __tzname[0] = NULL;
376 __tzname[1] = NULL;
377 for (i = num_transitions; i > 0; )
379 int type = type_idxs[--i];
380 int dst = types[type].isdst;
382 if (__tzname[dst] == NULL)
384 int idx = types[type].idx;
386 __tzname[dst] = __tzstring (&zone_names[idx]);
388 if (__tzname[1 - dst] != NULL)
389 break;
392 if (__tzname[0] == NULL)
394 /* This should only happen if there are no transition rules.
395 In this case there should be only one single type. */
396 assert (num_types == 1);
397 __tzname[0] = __tzstring (zone_names);
399 if (__tzname[1] == NULL)
400 __tzname[1] = __tzname[0];
402 compute_tzname_max (chars);
404 if (num_transitions == 0)
405 /* Use the first rule (which should also be the only one). */
406 rule_stdoff = rule_dstoff = types[0].offset;
407 else
409 int stdoff_set = 0, dstoff_set = 0;
410 rule_stdoff = rule_dstoff = 0;
411 i = num_transitions - 1;
414 if (!stdoff_set && !types[type_idxs[i]].isdst)
416 stdoff_set = 1;
417 rule_stdoff = types[type_idxs[i]].offset;
419 else if (!dstoff_set && types[type_idxs[i]].isdst)
421 dstoff_set = 1;
422 rule_dstoff = types[type_idxs[i]].offset;
424 if (stdoff_set && dstoff_set)
425 break;
427 while (i-- > 0);
429 if (!dstoff_set)
430 rule_dstoff = rule_stdoff;
433 __daylight = rule_stdoff != rule_dstoff;
434 __timezone = -rule_stdoff;
436 __use_tzfile = 1;
437 return;
439 lose:
440 fclose (f);
441 ret_free_transitions:
442 free ((void *) transitions);
443 transitions = NULL;
446 /* The user specified a hand-made timezone, but not its DST rules.
447 We will use the names and offsets from the user, and the rules
448 from the TZDEFRULES file. */
450 void
451 __tzfile_default (const char *std, const char *dst,
452 long int stdoff, long int dstoff)
454 size_t stdlen = strlen (std) + 1;
455 size_t dstlen = strlen (dst) + 1;
456 size_t i;
457 int isdst;
458 char *cp;
460 __tzfile_read (TZDEFRULES, stdlen + dstlen, &cp);
461 if (!__use_tzfile)
462 return;
464 if (num_types < 2)
466 __use_tzfile = 0;
467 return;
470 /* Ignore the zone names read from the file and use the given ones
471 instead. */
472 __mempcpy (__mempcpy (cp, std, stdlen), dst, dstlen);
473 zone_names = cp;
475 /* Now there are only two zones, regardless of what the file contained. */
476 num_types = 2;
478 /* Now correct the transition times for the user-specified standard and
479 daylight offsets from GMT. */
480 isdst = 0;
481 for (i = 0; i < num_transitions; ++i)
483 struct ttinfo *trans_type = &types[type_idxs[i]];
485 /* We will use only types 0 (standard) and 1 (daylight).
486 Fix up this transition to point to whichever matches
487 the flavor of its original type. */
488 type_idxs[i] = trans_type->isdst;
490 if (trans_type->isgmt)
491 /* The transition time is in GMT. No correction to apply. */ ;
492 else if (isdst && !trans_type->isstd)
493 /* The type says this transition is in "local wall clock time", and
494 wall clock time as of the previous transition was DST. Correct
495 for the difference between the rule's DST offset and the user's
496 DST offset. */
497 transitions[i] += dstoff - rule_dstoff;
498 else
499 /* This transition is in "local wall clock time", and wall clock
500 time as of this iteration is non-DST. Correct for the
501 difference between the rule's standard offset and the user's
502 standard offset. */
503 transitions[i] += stdoff - rule_stdoff;
505 /* The DST state of "local wall clock time" for the next iteration is
506 as specified by this transition. */
507 isdst = trans_type->isdst;
510 /* Now that we adjusted the transitions to the requested offsets,
511 reset the rule_stdoff and rule_dstoff values appropriately. They
512 are used elsewhere. */
513 rule_stdoff = stdoff;
514 rule_dstoff = dstoff;
516 /* Reset types 0 and 1 to describe the user's settings. */
517 types[0].idx = 0;
518 types[0].offset = stdoff;
519 types[0].isdst = 0;
520 types[1].idx = stdlen;
521 types[1].offset = dstoff;
522 types[1].isdst = 1;
524 /* Reset the zone names to point to the user's names. */
525 __tzname[0] = (char *) std;
526 __tzname[1] = (char *) dst;
528 /* Set the timezone. */
529 __timezone = -types[0].offset;
531 compute_tzname_max (stdlen + dstlen);
534 static struct ttinfo *
535 internal_function
536 find_transition (time_t timer)
538 size_t i;
540 if (num_transitions == 0 || timer < transitions[0])
542 /* TIMER is before any transition (or there are no transitions).
543 Choose the first non-DST type
544 (or the first if they're all DST types). */
545 i = 0;
546 while (i < num_types && types[i].isdst)
547 ++i;
548 if (i == num_types)
549 i = 0;
551 else if (timer >= transitions[num_transitions - 1])
552 i = type_idxs[num_transitions - 1];
553 else
555 /* Find the first transition after TIMER, and
556 then pick the type of the transition before it. */
557 size_t lo = 0;
558 size_t hi = num_transitions - 1;
559 /* Assume that DST is changing twice a year and guess initial
560 search spot from it.
561 Half of a gregorian year has on average 365.2425 * 86400 / 2
562 = 15778476 seconds. */
563 i = (transitions[num_transitions - 1] - timer) / 15778476;
564 if (i < num_transitions)
566 i = num_transitions - 1 - i;
567 if (timer < transitions[i])
569 if (i < 10 || timer >= transitions[i - 10])
571 /* Linear search. */
572 while (timer < transitions[i - 1])
573 --i;
574 goto found;
576 hi = i - 10;
578 else
580 if (i + 10 >= num_transitions || timer < transitions[i + 10])
582 /* Linear search. */
583 while (timer >= transitions[i])
584 ++i;
585 goto found;
587 lo = i + 10;
591 /* Binary search. */
592 /* assert (timer >= transitions[lo] && timer < transitions[hi]); */
593 while (lo + 1 < hi)
595 i = (lo + hi) / 2;
596 if (timer < transitions[i])
597 hi = i;
598 else
599 lo = i;
601 i = hi;
603 found:
604 /* assert (timer >= transitions[i - 1] && timer < transitions[i]); */
605 i = type_idxs[i - 1];
608 return &types[i];
611 void
612 __tzfile_compute (time_t timer, int use_localtime,
613 long int *leap_correct, int *leap_hit,
614 struct tm *tp)
616 register size_t i;
618 if (use_localtime)
620 struct ttinfo *info = find_transition (timer);
621 __daylight = rule_stdoff != rule_dstoff;
622 __timezone = -rule_stdoff;
623 __tzname[0] = NULL;
624 __tzname[1] = NULL;
625 for (i = num_transitions; i > 0; )
627 int type = type_idxs[--i];
628 int dst = types[type].isdst;
629 int idx = types[type].idx;
631 if (__tzname[dst] == NULL)
633 __tzname[dst] = __tzstring (&zone_names[idx]);
635 if (__tzname[1 - dst] != NULL)
636 break;
639 if (__tzname[0] == NULL)
641 /* This should only happen if there are no transition rules.
642 In this case there should be only one single type. */
643 assert (num_types == 1);
644 __tzname[0] = __tzstring (zone_names);
646 if (__tzname[1] == NULL)
647 /* There is no daylight saving time. */
648 __tzname[1] = __tzname[0];
649 tp->tm_isdst = info->isdst;
650 tp->tm_zone = __tzstring (&zone_names[info->idx]);
651 tp->tm_gmtoff = info->offset;
654 *leap_correct = 0L;
655 *leap_hit = 0;
657 /* Find the last leap second correction transition time before TIMER. */
658 i = num_leaps;
660 if (i-- == 0)
661 return;
662 while (timer < leaps[i].transition);
664 /* Apply its correction. */
665 *leap_correct = leaps[i].change;
667 if (timer == leaps[i].transition && /* Exactly at the transition time. */
668 ((i == 0 && leaps[i].change > 0) ||
669 leaps[i].change > leaps[i - 1].change))
671 *leap_hit = 1;
672 while (i > 0
673 && leaps[i].transition == leaps[i - 1].transition + 1
674 && leaps[i].change == leaps[i - 1].change + 1)
676 ++*leap_hit;
677 --i;
682 static void
683 internal_function
684 compute_tzname_max (size_t chars)
686 const char *p;
688 p = zone_names;
691 const char *start = p;
692 while (*p != '\0')
693 ++p;
694 if ((size_t) (p - start) > __tzname_cur_max)
695 __tzname_cur_max = p - start;
697 while (++p < &zone_names[chars]);