2010-09-20 22:08:53 +02:00
|
|
|
src/timezone/README
|
2008-03-21 14:23:29 +01:00
|
|
|
|
2016-03-28 21:10:17 +02:00
|
|
|
This is a PostgreSQL adapted version of the IANA timezone library from
|
2008-03-21 14:23:29 +01:00
|
|
|
|
2017-11-25 21:30:11 +01:00
|
|
|
https://www.iana.org/time-zones
|
2004-04-30 06:09:23 +02:00
|
|
|
|
2017-11-25 21:30:11 +01:00
|
|
|
The latest version of the timezone data and library source code is
|
|
|
|
available right from that page. It's best to get the merged file
|
|
|
|
tzdb-NNNNX.tar.lz, since the other archive formats omit tzdata.zi.
|
|
|
|
Historical versions, as well as release announcements, can be found
|
2016-03-28 21:10:17 +02:00
|
|
|
elsewhere on the site.
|
2011-10-28 05:09:05 +02:00
|
|
|
|
2016-03-28 21:10:17 +02:00
|
|
|
Since time zone rules change frequently in some parts of the world,
|
|
|
|
we should endeavor to update the data files before each PostgreSQL
|
|
|
|
release. The code need not be updated as often, but we must track
|
|
|
|
changes that might affect interpretation of the data files.
|
2008-02-16 22:16:04 +01:00
|
|
|
|
2004-10-24 17:01:54 +02:00
|
|
|
|
2016-03-28 21:10:17 +02:00
|
|
|
Time Zone data
|
|
|
|
==============
|
2004-10-24 17:01:54 +02:00
|
|
|
|
2017-11-25 21:30:11 +01:00
|
|
|
We distribute the time zone source data as-is under src/timezone/data/.
|
|
|
|
Currently, we distribute just the abbreviated single-file format
|
|
|
|
"tzdata.zi", to reduce the size of our tarballs as well as churn
|
|
|
|
in our git repo. Feeding that file to zic produces the same compiled
|
|
|
|
output as feeding the bulkier individual data files would do.
|
2006-07-25 05:51:23 +02:00
|
|
|
|
2017-11-25 21:30:11 +01:00
|
|
|
While data/tzdata.zi can just be duplicated when updating, manual effort
|
|
|
|
is needed to update the time zone abbreviation lists under tznames/.
|
2013-03-23 23:47:22 +01:00
|
|
|
These need to be changed whenever new abbreviations are invented or the
|
|
|
|
UTC offset associated with an existing abbreviation changes. To detect
|
|
|
|
if this has happened, after installing new files under data/ do
|
2014-02-12 23:29:19 +01:00
|
|
|
make abbrevs.txt
|
2013-03-23 23:47:22 +01:00
|
|
|
which will produce a file showing all abbreviations that are in current
|
|
|
|
use according to the data/ files. Compare this to known_abbrevs.txt,
|
|
|
|
which is the list that existed last time the tznames/ files were updated.
|
|
|
|
Update tznames/ as seems appropriate, then replace known_abbrevs.txt
|
2016-03-28 21:10:17 +02:00
|
|
|
in the same commit. Usually, if a known abbreviation has changed meaning,
|
|
|
|
the appropriate fix is to make it refer to a long-form zone name instead
|
|
|
|
of a fixed GMT offset.
|
2010-04-15 13:00:45 +02:00
|
|
|
|
2016-09-05 02:02:16 +02:00
|
|
|
The core regression test suite does some simple validation of the zone
|
|
|
|
data and abbreviations data (notably by checking that the pg_timezone_names
|
|
|
|
and pg_timezone_abbrevs views don't throw errors). It's worth running it
|
|
|
|
as a cross-check on proposed updates.
|
|
|
|
|
2010-04-15 13:00:45 +02:00
|
|
|
When there has been a new release of Windows (probably including Service
|
|
|
|
Packs), the list of matching timezones need to be updated. Run the
|
|
|
|
script in src/tools/win32tzlist.pl on a Windows machine running this new
|
|
|
|
release and apply any new timezones that it detects. Never remove any
|
|
|
|
mappings in case they are removed in Windows, since we still need to
|
|
|
|
match properly on the old version.
|
2016-03-28 21:10:17 +02:00
|
|
|
|
|
|
|
|
|
|
|
Time Zone code
|
|
|
|
==============
|
|
|
|
|
2020-06-18 00:29:29 +02:00
|
|
|
The code in this directory is currently synced with tzcode release 2020a.
|
2016-03-28 21:10:17 +02:00
|
|
|
There are many cosmetic (and not so cosmetic) differences from the
|
|
|
|
original tzcode library, but diffs in the upstream version should usually
|
|
|
|
be propagated to our version. Here are some notes about that.
|
|
|
|
|
|
|
|
For the most part we want to use the upstream code as-is, but there are
|
|
|
|
several considerations preventing an exact match:
|
|
|
|
|
|
|
|
* For readability/maintainability we reformat the code to match our own
|
|
|
|
conventions; this includes pgindent'ing it and getting rid of upstream's
|
|
|
|
overuse of "register" declarations. (It used to include conversion of
|
|
|
|
old-style function declarations to C89 style, but thank goodness they
|
|
|
|
fixed that.)
|
|
|
|
|
|
|
|
* We need the code to follow Postgres' portability conventions; this
|
2020-02-21 09:14:03 +01:00
|
|
|
includes relying on configure's results rather than hand-hacked
|
2020-06-18 00:29:29 +02:00
|
|
|
#defines (see private.h in particular).
|
|
|
|
|
|
|
|
* Similarly, avoid relying on <stdint.h> features that may not exist on old
|
|
|
|
systems. In particular this means using Postgres' definitions of the int32
|
|
|
|
and int64 typedefs, not int_fast32_t/int_fast64_t. Likewise we use
|
|
|
|
PG_INT32_MIN/MAX not INT32_MIN/MAX. (Once we desupport all PG versions
|
|
|
|
that don't require C99, it'd be practical to rely on <stdint.h> and remove
|
|
|
|
this set of diffs; but that day is not yet.)
|
2016-03-28 21:10:17 +02:00
|
|
|
|
|
|
|
* Since Postgres is typically built on a system that has its own copy
|
|
|
|
of the <time.h> functions, we must avoid conflicting with those. This
|
|
|
|
mandates renaming typedef time_t to pg_time_t, and similarly for most
|
|
|
|
other exposed names.
|
|
|
|
|
2018-10-31 14:47:53 +01:00
|
|
|
* zic.c's typedef "lineno" is renamed to "lineno_t", because having
|
|
|
|
"lineno" in our typedefs list would cause unfortunate pgindent behavior
|
|
|
|
in some other files where we have variables named that.
|
|
|
|
|
2016-03-28 21:10:17 +02:00
|
|
|
* We have exposed the tzload() and tzparse() internal functions, and
|
|
|
|
slightly modified the API of the former, in part because it now relies
|
|
|
|
on our own pg_open_tzfile() rather than opening files for itself.
|
|
|
|
|
Improve tzparse's handling of TZDEFRULES ("posixrules") zone data.
In the IANA timezone code, tzparse() always tries to load the zone
file named by TZDEFRULES ("posixrules"). Previously, we'd hacked
that logic to skip the load in the "lastditch" code path, which we use
only to initialize the default "GMT" zone during GUC initialization.
That's critical for a couple of reasons: since we do not support leap
seconds, we *must not* allow "GMT" to have leap seconds, and since this
case runs before the GUC subsystem is fully alive, we'd really rather
not take the risk of pg_open_tzfile throwing any errors.
However, that still left the code reading TZDEFRULES on every other
call, something we'd noticed to the extent of having added code to cache
the result so it was only done once per process not a lot of times.
Andres Freund complained about the static data space used up for the
cache; but as long as the logic was like this, there was no point in
trying to get rid of that space.
We can improve matters by looking a bit more closely at what the IANA
code actually needs the TZDEFRULES data for. One thing it does is
that if "posixrules" is a leap-second-aware zone, the leap-second
behavior will be absorbed into every POSIX-style zone specification.
However, that's a behavior we'd really prefer to do without, since
for our purposes the end effect is to render every POSIX-style zone
name unsupported. Otherwise, the TZDEFRULES data is used only if
the POSIX zone name specifies DST but doesn't include a transition
date rule (e.g., "EST5EDT" rather than "EST5EDT,M3.2.0,M11.1.0").
That is a minority case for our purposes --- in particular, it
never happens when tzload() invokes tzparse() to interpret a
transition date rule string found in a tzdata zone file.
Hence, if we legislate that we're going to ignore leap-second data
from "posixrules", we can postpone the TZDEFRULES load into the path
where we actually need to substitute for a missing date rule string.
That means it will never happen at all in common scenarios, making it
reasonable to dynamically allocate the cache space when it does happen.
Even when the data is already loaded, this saves some cycles in the
common code path since we avoid a memcpy of 23KB or so. And, IMO at
least, this is a less ugly hack on the IANA logic than what we had
before, since it's not messing with the lastditch-vs-regular code paths.
Back-patch to all supported branches, not so much because this is a
critical change as that I want to keep all our copies of the IANA
timezone code in sync.
Discussion: https://postgr.es/m/20181015200754.7y7zfuzsoux2c4ya@alap3.anarazel.de
2018-10-17 18:26:48 +02:00
|
|
|
* tzparse() is adjusted to avoid loading the TZDEFRULES zone unless
|
|
|
|
really necessary, and to ignore any leap-second data it may supply.
|
|
|
|
We also cache the result of loading the TZDEFRULES zone, so that
|
|
|
|
that's not repeated more than once per process.
|
Improve performance of timezone loading, especially pg_timezone_names view.
tzparse() would attempt to load the "posixrules" timezone database file on
each call. That might seem like it would only be an issue when selecting a
POSIX-style zone name rather than a zone defined in the timezone database,
but it turns out that each zone definition file contains a POSIX-style zone
string and tzload() will call tzparse() to parse that. Thus, when scanning
the whole timezone file tree as we do in the pg_timezone_names view,
"posixrules" was read repetitively for each zone definition file. Fix
that by caching the file on first use within any given process. (We cache
other zone definitions for the life of the process, so there seems little
reason not to cache this one as well.) This probably won't help much in
processes that never run pg_timezone_names, but even one additional SET
of the timezone GUC would come out ahead.
An even worse problem for pg_timezone_names is that pg_open_tzfile()
has an inefficient way of identifying the canonical case of a zone name:
it basically re-descends the directory tree to the zone file. That's not
awful for an individual "SET timezone" operation, but it's pretty horrid
when we're inspecting every zone in the database. And it's pointless too
because we already know the canonical spelling, having just read it from
the filesystem. Fix by teaching pg_open_tzfile() to avoid the directory
search if it's not asked for the canonical name, and backfilling the
proper result in pg_tzenumerate_next().
In combination these changes seem to make the pg_timezone_names view
about 3x faster to read, for me. Since a scan of pg_timezone_names
has up to now been one of the slowest queries in the regression tests,
this should help some little bit for buildfarm cycle times.
Back-patch to all supported branches, not so much because it's likely
that users will care much about the view's performance as because
tracking changes in the upstream IANA timezone code is really painful
if we don't keep all the branches in sync.
Discussion: https://postgr.es/m/27962.1493671706@sss.pgh.pa.us
2017-05-03 03:50:35 +02:00
|
|
|
|
2016-03-28 21:10:17 +02:00
|
|
|
* There's a fair amount of code we don't need and have removed,
|
|
|
|
including all the nonstandard optional APIs. We have also added
|
|
|
|
a few functions of our own at the bottom of localtime.c.
|
|
|
|
|
|
|
|
* In zic.c, we have added support for a -P (print_abbrevs) switch, which
|
|
|
|
is used to create the "abbrevs.txt" summary of currently-in-use zone
|
|
|
|
abbreviations that was described above.
|
|
|
|
|
|
|
|
|
|
|
|
The most convenient way to compare a new tzcode release to our code is
|
|
|
|
to first run the tzcode source files through a sed filter like this:
|
|
|
|
|
|
|
|
sed -r \
|
|
|
|
-e 's/^([ \t]*)\*\*([ \t])/\1 *\2/' \
|
|
|
|
-e 's/^([ \t]*)\*\*$/\1 */' \
|
|
|
|
-e 's|^\*/| */|' \
|
|
|
|
-e 's/\bregister[ \t]//g' \
|
2019-04-27 01:46:26 +02:00
|
|
|
-e 's/\bATTRIBUTE_PURE[ \t]//g' \
|
2020-06-18 00:29:29 +02:00
|
|
|
-e 's/int_fast32_t/int32/g' \
|
|
|
|
-e 's/int_fast64_t/int64/g' \
|
|
|
|
-e 's/intmax_t/int64/g' \
|
|
|
|
-e 's/INT32_MIN/PG_INT32_MIN/g' \
|
|
|
|
-e 's/INT32_MAX/PG_INT32_MAX/g' \
|
|
|
|
-e 's/INTMAX_MIN/PG_INT64_MIN/g' \
|
|
|
|
-e 's/INTMAX_MAX/PG_INT64_MAX/g' \
|
2016-03-28 21:10:17 +02:00
|
|
|
-e 's/struct[ \t]+tm\b/struct pg_tm/g' \
|
|
|
|
-e 's/\btime_t\b/pg_time_t/g' \
|
2018-10-31 14:47:53 +01:00
|
|
|
-e 's/lineno/lineno_t/g' \
|
2016-03-28 21:10:17 +02:00
|
|
|
|
|
|
|
and then run them through pgindent. (The first three sed patterns deal
|
|
|
|
with conversion of their block comment style to something pgindent
|
|
|
|
won't make a hash of; the remainder address other points noted above.)
|
|
|
|
After that, the files can be diff'd directly against our corresponding
|
2019-07-18 00:26:23 +02:00
|
|
|
files. Also, it's typically helpful to diff against the previous tzcode
|
|
|
|
release (after processing that the same way), and then try to apply the
|
|
|
|
diff to our files. This will take care of most of the changes
|
|
|
|
mechanically.
|