1 /* Time zone functions such as tzalloc and localtime_rz
3 Copyright 2015-2020 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program 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
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, see <https://www.gnu.org/licenses/>. */
18 /* Written by Paul Eggert. */
20 /* Although this module is not thread-safe, any races should be fairly
21 rare and reasonably benign. For complete thread-safety, use a C
22 library with a working timezone_t type, so that this module is not
35 #include "flexmember.h"
37 #include "time-internal.h"
39 /* The approximate size to use for small allocation requests. This is
40 the largest "small" request for the GNU C library malloc. */
41 enum { DEFAULT_MXFAST
= 64 * sizeof (size_t) / 4 };
43 /* Minimum size of the ABBRS member of struct tm_zone. ABBRS is larger
44 only in the unlikely case where an abbreviation longer than this is
46 enum { ABBR_SIZE_MIN
= DEFAULT_MXFAST
- offsetof (struct tm_zone
, abbrs
) };
48 /* Magic cookie timezone_t value, for local time. It differs from
49 NULL and from all other timezone_t values. Only the address
50 matters; the pointer is never dereferenced. */
51 static timezone_t
const local_tz
= (timezone_t
) 1;
53 /* Copy to ABBRS the abbreviation at ABBR with size ABBR_SIZE (this
54 includes its trailing null byte). Append an extra null byte to
55 mark the end of ABBRS. */
57 extend_abbrs (char *abbrs
, char const *abbr
, size_t abbr_size
)
59 memcpy (abbrs
, abbr
, abbr_size
);
60 abbrs
[abbr_size
] = '\0';
63 /* Return a newly allocated time zone for NAME, or NULL on failure.
64 A null NAME stands for wall clock time (which is like unset TZ). */
66 tzalloc (char const *name
)
68 size_t name_size
= name
? strlen (name
) + 1 : 0;
69 size_t abbr_size
= name_size
< ABBR_SIZE_MIN
? ABBR_SIZE_MIN
: name_size
+ 1;
70 timezone_t tz
= malloc (FLEXSIZEOF (struct tm_zone
, abbrs
, abbr_size
));
74 #if HAVE_TZNAME && !HAVE_TM_ZONE
75 tz
->tzname_copy
[0] = tz
->tzname_copy
[1] = NULL
;
77 tz
->tz_is_set
= !!name
;
80 extend_abbrs (tz
->abbrs
, name
, name_size
);
85 /* Save into TZ any nontrivial time zone abbreviation used by TM, and
86 update *TM (if HAVE_TM_ZONE) or *TZ (if !HAVE_TM_ZONE &&
87 HAVE_TZNAME) if they use the abbreviation. Return true if
88 successful, false (setting errno) otherwise. */
90 save_abbr (timezone_t tz
, struct tm
*tm
)
92 #if HAVE_TM_ZONE || HAVE_TZNAME
93 char const *zone
= NULL
;
94 char *zone_copy
= (char *) "";
97 int tzname_index
= -1;
105 if (! (zone
&& *zone
) && 0 <= tm
->tm_isdst
)
107 tzname_index
= tm
->tm_isdst
!= 0;
108 zone
= tzname
[tzname_index
];
112 /* No need to replace null zones, or zones within the struct tm. */
113 if (!zone
|| ((char *) tm
<= zone
&& zone
< (char *) (tm
+ 1)))
118 zone_copy
= tz
->abbrs
;
120 while (strcmp (zone_copy
, zone
) != 0)
122 if (! (*zone_copy
|| (zone_copy
== tz
->abbrs
&& tz
->tz_is_set
)))
124 idx_t zone_size
= strlen (zone
) + 1;
125 if (zone_size
< tz
->abbrs
+ ABBR_SIZE_MIN
- zone_copy
)
126 extend_abbrs (zone_copy
, zone
, zone_size
);
129 tz
= tz
->next
= tzalloc (zone
);
133 zone_copy
= tz
->abbrs
;
138 zone_copy
+= strlen (zone_copy
) + 1;
139 if (!*zone_copy
&& tz
->next
)
142 zone_copy
= tz
->abbrs
;
147 /* Replace the zone name so that its lifetime matches that of TZ. */
149 tm
->tm_zone
= zone_copy
;
151 if (0 <= tzname_index
)
152 tz
->tzname_copy
[tzname_index
] = zone_copy
;
159 /* Free a time zone. */
161 tzfree (timezone_t tz
)
166 timezone_t next
= tz
->next
;
172 /* Get and set the TZ environment variable. These functions can be
173 overridden by programs like Emacs that manage their own environment. */
179 return getenv ("TZ");
185 setenv_TZ (char const *tz
)
187 return tz
? setenv ("TZ", tz
, 1) : unsetenv ("TZ");
191 /* Change the environment to match the specified timezone_t value.
192 Return true if successful, false (setting errno) otherwise. */
194 change_env (timezone_t tz
)
196 if (setenv_TZ (tz
->tz_is_set
? tz
->abbrs
: NULL
) != 0)
202 /* Temporarily set the time zone to TZ, which must not be null.
203 Return LOCAL_TZ if the time zone setting is already correct.
204 Otherwise return a newly allocated time zone representing the old
205 setting, or NULL (setting errno) on failure. */
207 set_tz (timezone_t tz
)
209 char *env_tz
= getenv_TZ ();
211 ? tz
->tz_is_set
&& strcmp (tz
->abbrs
, env_tz
) == 0
216 timezone_t old_tz
= tzalloc (env_tz
);
219 if (! change_env (tz
))
221 int saved_errno
= errno
;
230 /* Restore an old setting returned by set_tz. It must not be null.
231 Return true (preserving errno) if successful, false (setting errno)
234 revert_tz (timezone_t tz
)
240 int saved_errno
= errno
;
241 bool ok
= change_env (tz
);
250 /* Use time zone TZ to compute localtime_r (T, TM). */
252 localtime_rz (timezone_t tz
, time_t const *t
, struct tm
*tm
)
254 #ifdef HAVE_LOCALTIME_INFLOOP_BUG
255 /* The -67768038400665599 comes from:
256 https://lists.gnu.org/r/bug-gnulib/2017-07/msg00142.html
257 On affected platforms the greatest POSIX-compatible time_t value
258 that could return nonnull is 67768036191766798 (when
259 TZ="XXX24:59:59" it resolves to the year 2**31 - 1 + 1900, on
260 12-31 at 23:59:59), so test for that too while we're in the
262 if (! (-67768038400665599 <= *t
&& *t
<= 67768036191766798))
270 return gmtime_r (t
, tm
);
273 timezone_t old_tz
= set_tz (tz
);
276 bool abbr_saved
= localtime_r (t
, tm
) && save_abbr (tz
, tm
);
277 if (revert_tz (old_tz
) && abbr_saved
)
284 /* Use time zone TZ to compute mktime (TM). */
286 mktime_z (timezone_t tz
, struct tm
*tm
)
292 timezone_t old_tz
= set_tz (tz
);
296 tm_1
.tm_sec
= tm
->tm_sec
;
297 tm_1
.tm_min
= tm
->tm_min
;
298 tm_1
.tm_hour
= tm
->tm_hour
;
299 tm_1
.tm_mday
= tm
->tm_mday
;
300 tm_1
.tm_mon
= tm
->tm_mon
;
301 tm_1
.tm_year
= tm
->tm_year
;
303 tm_1
.tm_isdst
= tm
->tm_isdst
;
304 time_t t
= mktime (&tm_1
);
305 bool ok
= 0 <= tm_1
.tm_yday
;
306 #if HAVE_TM_ZONE || HAVE_TZNAME
307 ok
= ok
&& save_abbr (tz
, &tm_1
);
309 if (revert_tz (old_tz
) && ok
)