blob: 7888cf86de0a5cc3bb87c90d001500f12200f5ed [file] [log] [blame]
Paul Ganssle62972d92020-05-16 04:20:06 -04001#include "Python.h"
Victor Stinner37834132020-10-27 17:12:53 +01002#include "pycore_long.h" // _PyLong_GetOne()
Paul Ganssle62972d92020-05-16 04:20:06 -04003#include "structmember.h"
4
5#include <ctype.h>
6#include <stddef.h>
7#include <stdint.h>
8
9#include "datetime.h"
10
11// Imports
12static PyObject *io_open = NULL;
13static PyObject *_tzpath_find_tzfile = NULL;
14static PyObject *_common_mod = NULL;
15
16typedef struct TransitionRuleType TransitionRuleType;
17typedef struct StrongCacheNode StrongCacheNode;
18
19typedef struct {
20 PyObject *utcoff;
21 PyObject *dstoff;
22 PyObject *tzname;
23 long utcoff_seconds;
24} _ttinfo;
25
26typedef struct {
27 _ttinfo std;
28 _ttinfo dst;
29 int dst_diff;
30 TransitionRuleType *start;
31 TransitionRuleType *end;
32 unsigned char std_only;
33} _tzrule;
34
35typedef struct {
36 PyDateTime_TZInfo base;
37 PyObject *key;
38 PyObject *file_repr;
39 PyObject *weakreflist;
Pablo Galindoe4799b92020-05-27 21:48:12 +010040 size_t num_transitions;
41 size_t num_ttinfos;
Paul Ganssle62972d92020-05-16 04:20:06 -040042 int64_t *trans_list_utc;
43 int64_t *trans_list_wall[2];
44 _ttinfo **trans_ttinfos; // References to the ttinfo for each transition
45 _ttinfo *ttinfo_before;
46 _tzrule tzrule_after;
47 _ttinfo *_ttinfos; // Unique array of ttinfos for ease of deallocation
48 unsigned char fixed_offset;
49 unsigned char source;
50} PyZoneInfo_ZoneInfo;
51
52struct TransitionRuleType {
53 int64_t (*year_to_timestamp)(TransitionRuleType *, int);
54};
55
56typedef struct {
57 TransitionRuleType base;
58 uint8_t month;
59 uint8_t week;
60 uint8_t day;
61 int8_t hour;
62 int8_t minute;
63 int8_t second;
64} CalendarRule;
65
66typedef struct {
67 TransitionRuleType base;
68 uint8_t julian;
69 unsigned int day;
70 int8_t hour;
71 int8_t minute;
72 int8_t second;
73} DayRule;
74
75struct StrongCacheNode {
76 StrongCacheNode *next;
77 StrongCacheNode *prev;
78 PyObject *key;
79 PyObject *zone;
80};
81
82static PyTypeObject PyZoneInfo_ZoneInfoType;
83
84// Globals
85static PyObject *TIMEDELTA_CACHE = NULL;
86static PyObject *ZONEINFO_WEAK_CACHE = NULL;
87static StrongCacheNode *ZONEINFO_STRONG_CACHE = NULL;
88static size_t ZONEINFO_STRONG_CACHE_MAX_SIZE = 8;
89
90static _ttinfo NO_TTINFO = {NULL, NULL, NULL, 0};
91
92// Constants
93static const int EPOCHORDINAL = 719163;
94static int DAYS_IN_MONTH[] = {
95 -1, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31,
96};
97
98static int DAYS_BEFORE_MONTH[] = {
99 -1, 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334,
100};
101
102static const int SOURCE_NOCACHE = 0;
103static const int SOURCE_CACHE = 1;
104static const int SOURCE_FILE = 2;
105
106// Forward declarations
107static int
108load_data(PyZoneInfo_ZoneInfo *self, PyObject *file_obj);
109static void
110utcoff_to_dstoff(size_t *trans_idx, long *utcoffs, long *dstoffs,
111 unsigned char *isdsts, size_t num_transitions,
112 size_t num_ttinfos);
113static int
114ts_to_local(size_t *trans_idx, int64_t *trans_utc, long *utcoff,
115 int64_t *trans_local[2], size_t num_ttinfos,
116 size_t num_transitions);
117
118static int
119parse_tz_str(PyObject *tz_str_obj, _tzrule *out);
120
Pablo Galindoe4799b92020-05-27 21:48:12 +0100121static Py_ssize_t
Paul Ganssle62972d92020-05-16 04:20:06 -0400122parse_abbr(const char *const p, PyObject **abbr);
Pablo Galindoe4799b92020-05-27 21:48:12 +0100123static Py_ssize_t
Paul Ganssle62972d92020-05-16 04:20:06 -0400124parse_tz_delta(const char *const p, long *total_seconds);
Pablo Galindoe4799b92020-05-27 21:48:12 +0100125static Py_ssize_t
Paul Ganssle62972d92020-05-16 04:20:06 -0400126parse_transition_time(const char *const p, int8_t *hour, int8_t *minute,
127 int8_t *second);
Pablo Galindoe4799b92020-05-27 21:48:12 +0100128static Py_ssize_t
Paul Ganssle62972d92020-05-16 04:20:06 -0400129parse_transition_rule(const char *const p, TransitionRuleType **out);
130
131static _ttinfo *
132find_tzrule_ttinfo(_tzrule *rule, int64_t ts, unsigned char fold, int year);
133static _ttinfo *
134find_tzrule_ttinfo_fromutc(_tzrule *rule, int64_t ts, int year,
135 unsigned char *fold);
136
137static int
138build_ttinfo(long utcoffset, long dstoffset, PyObject *tzname, _ttinfo *out);
139static void
140xdecref_ttinfo(_ttinfo *ttinfo);
141static int
142ttinfo_eq(const _ttinfo *const tti0, const _ttinfo *const tti1);
143
144static int
145build_tzrule(PyObject *std_abbr, PyObject *dst_abbr, long std_offset,
146 long dst_offset, TransitionRuleType *start,
147 TransitionRuleType *end, _tzrule *out);
148static void
149free_tzrule(_tzrule *tzrule);
150
151static PyObject *
152load_timedelta(long seconds);
153
154static int
155get_local_timestamp(PyObject *dt, int64_t *local_ts);
156static _ttinfo *
157find_ttinfo(PyZoneInfo_ZoneInfo *self, PyObject *dt);
158
159static int
160ymd_to_ord(int y, int m, int d);
161static int
162is_leap_year(int year);
163
164static size_t
165_bisect(const int64_t value, const int64_t *arr, size_t size);
166
167static void
168eject_from_strong_cache(const PyTypeObject *const type, PyObject *key);
169static void
170clear_strong_cache(const PyTypeObject *const type);
171static void
172update_strong_cache(const PyTypeObject *const type, PyObject *key,
173 PyObject *zone);
174static PyObject *
175zone_from_strong_cache(const PyTypeObject *const type, PyObject *key);
176
177static PyObject *
178zoneinfo_new_instance(PyTypeObject *type, PyObject *key)
179{
180 PyObject *file_obj = NULL;
181 PyObject *file_path = NULL;
182
183 file_path = PyObject_CallFunctionObjArgs(_tzpath_find_tzfile, key, NULL);
184 if (file_path == NULL) {
185 return NULL;
186 }
187 else if (file_path == Py_None) {
188 file_obj = PyObject_CallMethod(_common_mod, "load_tzdata", "O", key);
189 if (file_obj == NULL) {
190 Py_DECREF(file_path);
191 return NULL;
192 }
193 }
194
195 PyObject *self = (PyObject *)(type->tp_alloc(type, 0));
196 if (self == NULL) {
197 goto error;
198 }
199
200 if (file_obj == NULL) {
201 file_obj = PyObject_CallFunction(io_open, "Os", file_path, "rb");
202 if (file_obj == NULL) {
203 goto error;
204 }
205 }
206
207 if (load_data((PyZoneInfo_ZoneInfo *)self, file_obj)) {
208 goto error;
209 }
210
211 PyObject *rv = PyObject_CallMethod(file_obj, "close", NULL);
212 Py_DECREF(file_obj);
213 file_obj = NULL;
214 if (rv == NULL) {
215 goto error;
216 }
217 Py_DECREF(rv);
218
219 ((PyZoneInfo_ZoneInfo *)self)->key = key;
220 Py_INCREF(key);
221
222 goto cleanup;
223error:
224 Py_XDECREF(self);
225 self = NULL;
226cleanup:
227 if (file_obj != NULL) {
Zackery Spytzeca25492020-07-20 06:51:26 -0600228 PyObject *exc, *val, *tb;
229 PyErr_Fetch(&exc, &val, &tb);
Paul Ganssle62972d92020-05-16 04:20:06 -0400230 PyObject *tmp = PyObject_CallMethod(file_obj, "close", NULL);
Zackery Spytzeca25492020-07-20 06:51:26 -0600231 _PyErr_ChainExceptions(exc, val, tb);
232 if (tmp == NULL) {
233 Py_CLEAR(self);
234 }
235 Py_XDECREF(tmp);
Paul Ganssle62972d92020-05-16 04:20:06 -0400236 Py_DECREF(file_obj);
237 }
238 Py_DECREF(file_path);
239 return self;
240}
241
242static PyObject *
243get_weak_cache(PyTypeObject *type)
244{
245 if (type == &PyZoneInfo_ZoneInfoType) {
246 return ZONEINFO_WEAK_CACHE;
247 }
248 else {
249 PyObject *cache =
250 PyObject_GetAttrString((PyObject *)type, "_weak_cache");
251 // We are assuming that the type lives at least as long as the function
252 // that calls get_weak_cache, and that it holds a reference to the
253 // cache, so we'll return a "borrowed reference".
254 Py_XDECREF(cache);
255 return cache;
256 }
257}
258
259static PyObject *
260zoneinfo_new(PyTypeObject *type, PyObject *args, PyObject *kw)
261{
262 PyObject *key = NULL;
263 static char *kwlist[] = {"key", NULL};
264 if (PyArg_ParseTupleAndKeywords(args, kw, "O", kwlist, &key) == 0) {
265 return NULL;
266 }
267
268 PyObject *instance = zone_from_strong_cache(type, key);
269 if (instance != NULL) {
270 return instance;
271 }
272
273 PyObject *weak_cache = get_weak_cache(type);
274 instance = PyObject_CallMethod(weak_cache, "get", "O", key, Py_None);
275 if (instance == NULL) {
276 return NULL;
277 }
278
279 if (instance == Py_None) {
280 Py_DECREF(instance);
281 PyObject *tmp = zoneinfo_new_instance(type, key);
282 if (tmp == NULL) {
283 return NULL;
284 }
285
286 instance =
287 PyObject_CallMethod(weak_cache, "setdefault", "OO", key, tmp);
Paul Ganssle62972d92020-05-16 04:20:06 -0400288 Py_DECREF(tmp);
Paul Ganssle62972d92020-05-16 04:20:06 -0400289 if (instance == NULL) {
290 return NULL;
291 }
Gregory P. Smithd780fa72020-06-22 00:39:28 -0700292 ((PyZoneInfo_ZoneInfo *)instance)->source = SOURCE_CACHE;
Paul Ganssle62972d92020-05-16 04:20:06 -0400293 }
294
295 update_strong_cache(type, key, instance);
296 return instance;
297}
298
299static void
300zoneinfo_dealloc(PyObject *obj_self)
301{
302 PyZoneInfo_ZoneInfo *self = (PyZoneInfo_ZoneInfo *)obj_self;
303
304 if (self->weakreflist != NULL) {
305 PyObject_ClearWeakRefs(obj_self);
306 }
307
308 if (self->trans_list_utc != NULL) {
309 PyMem_Free(self->trans_list_utc);
310 }
311
312 for (size_t i = 0; i < 2; i++) {
313 if (self->trans_list_wall[i] != NULL) {
314 PyMem_Free(self->trans_list_wall[i]);
315 }
316 }
317
318 if (self->_ttinfos != NULL) {
319 for (size_t i = 0; i < self->num_ttinfos; ++i) {
320 xdecref_ttinfo(&(self->_ttinfos[i]));
321 }
322 PyMem_Free(self->_ttinfos);
323 }
324
325 if (self->trans_ttinfos != NULL) {
326 PyMem_Free(self->trans_ttinfos);
327 }
328
329 free_tzrule(&(self->tzrule_after));
330
331 Py_XDECREF(self->key);
332 Py_XDECREF(self->file_repr);
333
334 Py_TYPE(self)->tp_free((PyObject *)self);
335}
336
337static PyObject *
338zoneinfo_from_file(PyTypeObject *type, PyObject *args, PyObject *kwargs)
339{
340 PyObject *file_obj = NULL;
341 PyObject *file_repr = NULL;
342 PyObject *key = Py_None;
343 PyZoneInfo_ZoneInfo *self = NULL;
344
345 static char *kwlist[] = {"", "key", NULL};
346 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|O", kwlist, &file_obj,
347 &key)) {
348 return NULL;
349 }
350
351 PyObject *obj_self = (PyObject *)(type->tp_alloc(type, 0));
352 self = (PyZoneInfo_ZoneInfo *)obj_self;
353 if (self == NULL) {
354 return NULL;
355 }
356
357 file_repr = PyUnicode_FromFormat("%R", file_obj);
358 if (file_repr == NULL) {
359 goto error;
360 }
361
362 if (load_data(self, file_obj)) {
363 goto error;
364 }
365
366 self->source = SOURCE_FILE;
367 self->file_repr = file_repr;
368 self->key = key;
369 Py_INCREF(key);
370
371 return obj_self;
372error:
373 Py_XDECREF(file_repr);
374 Py_XDECREF(self);
375 return NULL;
376}
377
378static PyObject *
379zoneinfo_no_cache(PyTypeObject *cls, PyObject *args, PyObject *kwargs)
380{
381 static char *kwlist[] = {"key", NULL};
382 PyObject *key = NULL;
383 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O", kwlist, &key)) {
384 return NULL;
385 }
386
387 PyObject *out = zoneinfo_new_instance(cls, key);
388 if (out != NULL) {
389 ((PyZoneInfo_ZoneInfo *)out)->source = SOURCE_NOCACHE;
390 }
391
392 return out;
393}
394
395static PyObject *
396zoneinfo_clear_cache(PyObject *cls, PyObject *args, PyObject *kwargs)
397{
398 PyObject *only_keys = NULL;
399 static char *kwlist[] = {"only_keys", NULL};
400
401 if (!(PyArg_ParseTupleAndKeywords(args, kwargs, "|$O", kwlist,
402 &only_keys))) {
403 return NULL;
404 }
405
406 PyTypeObject *type = (PyTypeObject *)cls;
407 PyObject *weak_cache = get_weak_cache(type);
408
409 if (only_keys == NULL || only_keys == Py_None) {
410 PyObject *rv = PyObject_CallMethod(weak_cache, "clear", NULL);
411 if (rv != NULL) {
412 Py_DECREF(rv);
413 }
414
415 clear_strong_cache(type);
Paul Ganssle62972d92020-05-16 04:20:06 -0400416 }
417 else {
418 PyObject *item = NULL;
419 PyObject *pop = PyUnicode_FromString("pop");
420 if (pop == NULL) {
421 return NULL;
422 }
423
424 PyObject *iter = PyObject_GetIter(only_keys);
425 if (iter == NULL) {
426 Py_DECREF(pop);
427 return NULL;
428 }
429
430 while ((item = PyIter_Next(iter))) {
431 // Remove from strong cache
432 eject_from_strong_cache(type, item);
433
434 // Remove from weak cache
435 PyObject *tmp = PyObject_CallMethodObjArgs(weak_cache, pop, item,
436 Py_None, NULL);
437
438 Py_DECREF(item);
439 if (tmp == NULL) {
440 break;
441 }
442 Py_DECREF(tmp);
443 }
444 Py_DECREF(iter);
445 Py_DECREF(pop);
446 }
447
448 if (PyErr_Occurred()) {
449 return NULL;
450 }
451
452 Py_RETURN_NONE;
453}
454
455static PyObject *
456zoneinfo_utcoffset(PyObject *self, PyObject *dt)
457{
458 _ttinfo *tti = find_ttinfo((PyZoneInfo_ZoneInfo *)self, dt);
459 if (tti == NULL) {
460 return NULL;
461 }
462 Py_INCREF(tti->utcoff);
463 return tti->utcoff;
464}
465
466static PyObject *
467zoneinfo_dst(PyObject *self, PyObject *dt)
468{
469 _ttinfo *tti = find_ttinfo((PyZoneInfo_ZoneInfo *)self, dt);
470 if (tti == NULL) {
471 return NULL;
472 }
473 Py_INCREF(tti->dstoff);
474 return tti->dstoff;
475}
476
477static PyObject *
478zoneinfo_tzname(PyObject *self, PyObject *dt)
479{
480 _ttinfo *tti = find_ttinfo((PyZoneInfo_ZoneInfo *)self, dt);
481 if (tti == NULL) {
482 return NULL;
483 }
484 Py_INCREF(tti->tzname);
485 return tti->tzname;
486}
487
Zackery Spytz2e4dd332020-09-23 12:43:45 -0600488#define GET_DT_TZINFO PyDateTime_DATE_GET_TZINFO
Paul Ganssle62972d92020-05-16 04:20:06 -0400489
490static PyObject *
491zoneinfo_fromutc(PyObject *obj_self, PyObject *dt)
492{
493 if (!PyDateTime_Check(dt)) {
494 PyErr_SetString(PyExc_TypeError,
495 "fromutc: argument must be a datetime");
496 return NULL;
497 }
498 if (GET_DT_TZINFO(dt) != obj_self) {
499 PyErr_SetString(PyExc_ValueError,
500 "fromutc: dt.tzinfo "
501 "is not self");
502 return NULL;
503 }
504
505 PyZoneInfo_ZoneInfo *self = (PyZoneInfo_ZoneInfo *)obj_self;
506
507 int64_t timestamp;
508 if (get_local_timestamp(dt, &timestamp)) {
509 return NULL;
510 }
511 size_t num_trans = self->num_transitions;
512
513 _ttinfo *tti = NULL;
514 unsigned char fold = 0;
515
516 if (num_trans >= 1 && timestamp < self->trans_list_utc[0]) {
517 tti = self->ttinfo_before;
518 }
519 else if (num_trans == 0 ||
520 timestamp > self->trans_list_utc[num_trans - 1]) {
521 tti = find_tzrule_ttinfo_fromutc(&(self->tzrule_after), timestamp,
522 PyDateTime_GET_YEAR(dt), &fold);
523
524 // Immediately after the last manual transition, the fold/gap is
525 // between self->trans_ttinfos[num_transitions - 1] and whatever
526 // ttinfo applies immediately after the last transition, not between
527 // the STD and DST rules in the tzrule_after, so we may need to
528 // adjust the fold value.
529 if (num_trans) {
530 _ttinfo *tti_prev = NULL;
531 if (num_trans == 1) {
532 tti_prev = self->ttinfo_before;
533 }
534 else {
535 tti_prev = self->trans_ttinfos[num_trans - 2];
536 }
537 int64_t diff = tti_prev->utcoff_seconds - tti->utcoff_seconds;
538 if (diff > 0 &&
539 timestamp < (self->trans_list_utc[num_trans - 1] + diff)) {
540 fold = 1;
541 }
542 }
543 }
544 else {
545 size_t idx = _bisect(timestamp, self->trans_list_utc, num_trans);
546 _ttinfo *tti_prev = NULL;
547
548 if (idx >= 2) {
549 tti_prev = self->trans_ttinfos[idx - 2];
550 tti = self->trans_ttinfos[idx - 1];
551 }
552 else {
553 tti_prev = self->ttinfo_before;
554 tti = self->trans_ttinfos[0];
555 }
556
557 // Detect fold
558 int64_t shift =
559 (int64_t)(tti_prev->utcoff_seconds - tti->utcoff_seconds);
560 if (shift > (timestamp - self->trans_list_utc[idx - 1])) {
561 fold = 1;
562 }
563 }
564
565 PyObject *tmp = PyNumber_Add(dt, tti->utcoff);
566 if (tmp == NULL) {
567 return NULL;
568 }
569
570 if (fold) {
571 if (PyDateTime_CheckExact(tmp)) {
572 ((PyDateTime_DateTime *)tmp)->fold = 1;
573 dt = tmp;
574 }
575 else {
576 PyObject *replace = PyObject_GetAttrString(tmp, "replace");
577 PyObject *args = PyTuple_New(0);
578 PyObject *kwargs = PyDict_New();
579
580 Py_DECREF(tmp);
581 if (args == NULL || kwargs == NULL || replace == NULL) {
582 Py_XDECREF(args);
583 Py_XDECREF(kwargs);
584 Py_XDECREF(replace);
585 return NULL;
586 }
587
588 dt = NULL;
Victor Stinner37834132020-10-27 17:12:53 +0100589 if (!PyDict_SetItemString(kwargs, "fold", _PyLong_GetOne())) {
Paul Ganssle62972d92020-05-16 04:20:06 -0400590 dt = PyObject_Call(replace, args, kwargs);
591 }
592
593 Py_DECREF(args);
594 Py_DECREF(kwargs);
595 Py_DECREF(replace);
596
597 if (dt == NULL) {
598 return NULL;
599 }
600 }
601 }
602 else {
603 dt = tmp;
604 }
605 return dt;
606}
607
608static PyObject *
609zoneinfo_repr(PyZoneInfo_ZoneInfo *self)
610{
611 PyObject *rv = NULL;
612 const char *type_name = Py_TYPE((PyObject *)self)->tp_name;
613 if (!(self->key == Py_None)) {
614 rv = PyUnicode_FromFormat("%s(key=%R)", type_name, self->key);
615 }
616 else {
617 assert(PyUnicode_Check(self->file_repr));
618 rv = PyUnicode_FromFormat("%s.from_file(%U)", type_name,
619 self->file_repr);
620 }
621
622 return rv;
623}
624
625static PyObject *
626zoneinfo_str(PyZoneInfo_ZoneInfo *self)
627{
628 if (!(self->key == Py_None)) {
629 Py_INCREF(self->key);
630 return self->key;
631 }
632 else {
633 return zoneinfo_repr(self);
634 }
635}
636
637/* Pickles the ZoneInfo object by key and source.
638 *
639 * ZoneInfo objects are pickled by reference to the TZif file that they came
640 * from, which means that the exact transitions may be different or the file
641 * may not un-pickle if the data has changed on disk in the interim.
642 *
643 * It is necessary to include a bit indicating whether or not the object
644 * was constructed from the cache, because from-cache objects will hit the
645 * unpickling process's cache, whereas no-cache objects will bypass it.
646 *
647 * Objects constructed from ZoneInfo.from_file cannot be pickled.
648 */
649static PyObject *
650zoneinfo_reduce(PyObject *obj_self, PyObject *unused)
651{
652 PyZoneInfo_ZoneInfo *self = (PyZoneInfo_ZoneInfo *)obj_self;
653 if (self->source == SOURCE_FILE) {
654 // Objects constructed from files cannot be pickled.
655 PyObject *pickle = PyImport_ImportModule("pickle");
656 if (pickle == NULL) {
657 return NULL;
658 }
659
660 PyObject *pickle_error =
661 PyObject_GetAttrString(pickle, "PicklingError");
662 Py_DECREF(pickle);
663 if (pickle_error == NULL) {
664 return NULL;
665 }
666
667 PyErr_Format(pickle_error,
668 "Cannot pickle a ZoneInfo file from a file stream.");
669 Py_DECREF(pickle_error);
670 return NULL;
671 }
672
673 unsigned char from_cache = self->source == SOURCE_CACHE ? 1 : 0;
674 PyObject *constructor = PyObject_GetAttrString(obj_self, "_unpickle");
675
676 if (constructor == NULL) {
677 return NULL;
678 }
679
680 PyObject *rv = Py_BuildValue("O(OB)", constructor, self->key, from_cache);
681 Py_DECREF(constructor);
682 return rv;
683}
684
685static PyObject *
686zoneinfo__unpickle(PyTypeObject *cls, PyObject *args)
687{
688 PyObject *key;
689 unsigned char from_cache;
690 if (!PyArg_ParseTuple(args, "OB", &key, &from_cache)) {
691 return NULL;
692 }
693
694 if (from_cache) {
695 PyObject *val_args = Py_BuildValue("(O)", key);
696 if (val_args == NULL) {
697 return NULL;
698 }
699
700 PyObject *rv = zoneinfo_new(cls, val_args, NULL);
701
702 Py_DECREF(val_args);
703 return rv;
704 }
705 else {
706 return zoneinfo_new_instance(cls, key);
707 }
708}
709
710/* It is relatively expensive to construct new timedelta objects, and in most
711 * cases we're looking at a relatively small number of timedeltas, such as
712 * integer number of hours, etc. We will keep a cache so that we construct
713 * a minimal number of these.
714 *
715 * Possibly this should be replaced with an LRU cache so that it's not possible
716 * for the memory usage to explode from this, but in order for this to be a
717 * serious problem, one would need to deliberately craft a malicious time zone
718 * file with many distinct offsets. As of tzdb 2019c, loading every single zone
719 * fills the cache with ~450 timedeltas for a total size of ~12kB.
720 *
721 * This returns a new reference to the timedelta.
722 */
723static PyObject *
724load_timedelta(long seconds)
725{
Serhiy Storchakafb5db7e2020-10-26 08:43:39 +0200726 PyObject *rv;
Paul Ganssle62972d92020-05-16 04:20:06 -0400727 PyObject *pyoffset = PyLong_FromLong(seconds);
728 if (pyoffset == NULL) {
729 return NULL;
730 }
Serhiy Storchakafb5db7e2020-10-26 08:43:39 +0200731 rv = PyDict_GetItemWithError(TIMEDELTA_CACHE, pyoffset);
732 if (rv == NULL) {
733 if (PyErr_Occurred()) {
734 goto error;
735 }
Paul Ganssle62972d92020-05-16 04:20:06 -0400736 PyObject *tmp = PyDateTimeAPI->Delta_FromDelta(
737 0, seconds, 0, 1, PyDateTimeAPI->DeltaType);
738
739 if (tmp == NULL) {
740 goto error;
741 }
742
743 rv = PyDict_SetDefault(TIMEDELTA_CACHE, pyoffset, tmp);
744 Py_DECREF(tmp);
745 }
Paul Ganssle62972d92020-05-16 04:20:06 -0400746
Serhiy Storchakafb5db7e2020-10-26 08:43:39 +0200747 Py_XINCREF(rv);
Paul Ganssle62972d92020-05-16 04:20:06 -0400748 Py_DECREF(pyoffset);
Paul Ganssle62972d92020-05-16 04:20:06 -0400749 return rv;
750error:
751 Py_DECREF(pyoffset);
752 return NULL;
753}
754
755/* Constructor for _ttinfo object - this starts by initializing the _ttinfo
756 * to { NULL, NULL, NULL }, so that Py_XDECREF will work on partially
757 * initialized _ttinfo objects.
758 */
759static int
760build_ttinfo(long utcoffset, long dstoffset, PyObject *tzname, _ttinfo *out)
761{
762 out->utcoff = NULL;
763 out->dstoff = NULL;
764 out->tzname = NULL;
765
766 out->utcoff_seconds = utcoffset;
767 out->utcoff = load_timedelta(utcoffset);
768 if (out->utcoff == NULL) {
769 return -1;
770 }
771
772 out->dstoff = load_timedelta(dstoffset);
773 if (out->dstoff == NULL) {
774 return -1;
775 }
776
777 out->tzname = tzname;
778 Py_INCREF(tzname);
779
780 return 0;
781}
782
783/* Decrease reference count on any non-NULL members of a _ttinfo */
784static void
785xdecref_ttinfo(_ttinfo *ttinfo)
786{
787 if (ttinfo != NULL) {
788 Py_XDECREF(ttinfo->utcoff);
789 Py_XDECREF(ttinfo->dstoff);
790 Py_XDECREF(ttinfo->tzname);
791 }
792}
793
794/* Equality function for _ttinfo. */
795static int
796ttinfo_eq(const _ttinfo *const tti0, const _ttinfo *const tti1)
797{
798 int rv;
799 if ((rv = PyObject_RichCompareBool(tti0->utcoff, tti1->utcoff, Py_EQ)) <
800 1) {
801 goto end;
802 }
803
804 if ((rv = PyObject_RichCompareBool(tti0->dstoff, tti1->dstoff, Py_EQ)) <
805 1) {
806 goto end;
807 }
808
809 if ((rv = PyObject_RichCompareBool(tti0->tzname, tti1->tzname, Py_EQ)) <
810 1) {
811 goto end;
812 }
813end:
814 return rv;
815}
816
817/* Given a file-like object, this populates a ZoneInfo object
818 *
819 * The current version calls into a Python function to read the data from
820 * file into Python objects, and this translates those Python objects into
821 * C values and calculates derived values (e.g. dstoff) in C.
822 *
823 * This returns 0 on success and -1 on failure.
824 *
825 * The function will never return while `self` is partially initialized —
826 * the object only needs to be freed / deallocated if this succeeds.
827 */
828static int
829load_data(PyZoneInfo_ZoneInfo *self, PyObject *file_obj)
830{
831 PyObject *data_tuple = NULL;
832
833 long *utcoff = NULL;
834 long *dstoff = NULL;
835 size_t *trans_idx = NULL;
836 unsigned char *isdst = NULL;
837
838 self->trans_list_utc = NULL;
839 self->trans_list_wall[0] = NULL;
840 self->trans_list_wall[1] = NULL;
841 self->trans_ttinfos = NULL;
842 self->_ttinfos = NULL;
843 self->file_repr = NULL;
844
845 size_t ttinfos_allocated = 0;
846
847 data_tuple = PyObject_CallMethod(_common_mod, "load_data", "O", file_obj);
848
849 if (data_tuple == NULL) {
850 goto error;
851 }
852
853 if (!PyTuple_CheckExact(data_tuple)) {
854 PyErr_Format(PyExc_TypeError, "Invalid data result type: %r",
855 data_tuple);
856 goto error;
857 }
858
859 // Unpack the data tuple
860 PyObject *trans_idx_list = PyTuple_GetItem(data_tuple, 0);
861 if (trans_idx_list == NULL) {
862 goto error;
863 }
864
865 PyObject *trans_utc = PyTuple_GetItem(data_tuple, 1);
866 if (trans_utc == NULL) {
867 goto error;
868 }
869
870 PyObject *utcoff_list = PyTuple_GetItem(data_tuple, 2);
871 if (utcoff_list == NULL) {
872 goto error;
873 }
874
875 PyObject *isdst_list = PyTuple_GetItem(data_tuple, 3);
876 if (isdst_list == NULL) {
877 goto error;
878 }
879
880 PyObject *abbr = PyTuple_GetItem(data_tuple, 4);
881 if (abbr == NULL) {
882 goto error;
883 }
884
885 PyObject *tz_str = PyTuple_GetItem(data_tuple, 5);
886 if (tz_str == NULL) {
887 goto error;
888 }
889
890 // Load the relevant sizes
891 Py_ssize_t num_transitions = PyTuple_Size(trans_utc);
Pablo Galindoe4799b92020-05-27 21:48:12 +0100892 if (num_transitions < 0) {
Paul Ganssle62972d92020-05-16 04:20:06 -0400893 goto error;
894 }
895
896 Py_ssize_t num_ttinfos = PyTuple_Size(utcoff_list);
Pablo Galindoe4799b92020-05-27 21:48:12 +0100897 if (num_ttinfos < 0) {
Paul Ganssle62972d92020-05-16 04:20:06 -0400898 goto error;
899 }
900
901 self->num_transitions = (size_t)num_transitions;
902 self->num_ttinfos = (size_t)num_ttinfos;
903
904 // Load the transition indices and list
905 self->trans_list_utc =
906 PyMem_Malloc(self->num_transitions * sizeof(int64_t));
907 trans_idx = PyMem_Malloc(self->num_transitions * sizeof(Py_ssize_t));
908
Pablo Galindoe4799b92020-05-27 21:48:12 +0100909 for (size_t i = 0; i < self->num_transitions; ++i) {
Paul Ganssle62972d92020-05-16 04:20:06 -0400910 PyObject *num = PyTuple_GetItem(trans_utc, i);
911 if (num == NULL) {
912 goto error;
913 }
914 self->trans_list_utc[i] = PyLong_AsLongLong(num);
915 if (self->trans_list_utc[i] == -1 && PyErr_Occurred()) {
916 goto error;
917 }
918
919 num = PyTuple_GetItem(trans_idx_list, i);
920 if (num == NULL) {
921 goto error;
922 }
923
924 Py_ssize_t cur_trans_idx = PyLong_AsSsize_t(num);
925 if (cur_trans_idx == -1) {
926 goto error;
927 }
928
929 trans_idx[i] = (size_t)cur_trans_idx;
930 if (trans_idx[i] > self->num_ttinfos) {
931 PyErr_Format(
932 PyExc_ValueError,
933 "Invalid transition index found while reading TZif: %zd",
934 cur_trans_idx);
935
936 goto error;
937 }
938 }
939
940 // Load UTC offsets and isdst (size num_ttinfos)
941 utcoff = PyMem_Malloc(self->num_ttinfos * sizeof(long));
942 isdst = PyMem_Malloc(self->num_ttinfos * sizeof(unsigned char));
943
944 if (utcoff == NULL || isdst == NULL) {
945 goto error;
946 }
Pablo Galindoe4799b92020-05-27 21:48:12 +0100947 for (size_t i = 0; i < self->num_ttinfos; ++i) {
Paul Ganssle62972d92020-05-16 04:20:06 -0400948 PyObject *num = PyTuple_GetItem(utcoff_list, i);
949 if (num == NULL) {
950 goto error;
951 }
952
953 utcoff[i] = PyLong_AsLong(num);
954 if (utcoff[i] == -1 && PyErr_Occurred()) {
955 goto error;
956 }
957
958 num = PyTuple_GetItem(isdst_list, i);
959 if (num == NULL) {
960 goto error;
961 }
962
963 int isdst_with_error = PyObject_IsTrue(num);
964 if (isdst_with_error == -1) {
965 goto error;
966 }
967 else {
968 isdst[i] = (unsigned char)isdst_with_error;
969 }
970 }
971
972 dstoff = PyMem_Calloc(self->num_ttinfos, sizeof(long));
973 if (dstoff == NULL) {
974 goto error;
975 }
976
977 // Derive dstoff and trans_list_wall from the information we've loaded
978 utcoff_to_dstoff(trans_idx, utcoff, dstoff, isdst, self->num_transitions,
979 self->num_ttinfos);
980
981 if (ts_to_local(trans_idx, self->trans_list_utc, utcoff,
982 self->trans_list_wall, self->num_ttinfos,
983 self->num_transitions)) {
984 goto error;
985 }
986
987 // Build _ttinfo objects from utcoff, dstoff and abbr
988 self->_ttinfos = PyMem_Malloc(self->num_ttinfos * sizeof(_ttinfo));
989 for (size_t i = 0; i < self->num_ttinfos; ++i) {
990 PyObject *tzname = PyTuple_GetItem(abbr, i);
991 if (tzname == NULL) {
992 goto error;
993 }
994
995 ttinfos_allocated++;
996 if (build_ttinfo(utcoff[i], dstoff[i], tzname, &(self->_ttinfos[i]))) {
997 goto error;
998 }
999 }
1000
1001 // Build our mapping from transition to the ttinfo that applies
1002 self->trans_ttinfos =
1003 PyMem_Calloc(self->num_transitions, sizeof(_ttinfo *));
1004 for (size_t i = 0; i < self->num_transitions; ++i) {
1005 size_t ttinfo_idx = trans_idx[i];
1006 assert(ttinfo_idx < self->num_ttinfos);
1007 self->trans_ttinfos[i] = &(self->_ttinfos[ttinfo_idx]);
1008 }
1009
1010 // Set ttinfo_before to the first non-DST transition
1011 for (size_t i = 0; i < self->num_ttinfos; ++i) {
1012 if (!isdst[i]) {
1013 self->ttinfo_before = &(self->_ttinfos[i]);
1014 break;
1015 }
1016 }
1017
1018 // If there are only DST ttinfos, pick the first one, if there are no
1019 // ttinfos at all, set ttinfo_before to NULL
1020 if (self->ttinfo_before == NULL && self->num_ttinfos > 0) {
1021 self->ttinfo_before = &(self->_ttinfos[0]);
1022 }
1023
1024 if (tz_str != Py_None && PyObject_IsTrue(tz_str)) {
1025 if (parse_tz_str(tz_str, &(self->tzrule_after))) {
1026 goto error;
1027 }
1028 }
1029 else {
1030 if (!self->num_ttinfos) {
1031 PyErr_Format(PyExc_ValueError, "No time zone information found.");
1032 goto error;
1033 }
1034
1035 size_t idx;
1036 if (!self->num_transitions) {
1037 idx = self->num_ttinfos - 1;
1038 }
1039 else {
1040 idx = trans_idx[self->num_transitions - 1];
1041 }
1042
1043 _ttinfo *tti = &(self->_ttinfos[idx]);
1044 build_tzrule(tti->tzname, NULL, tti->utcoff_seconds, 0, NULL, NULL,
1045 &(self->tzrule_after));
1046
1047 // We've abused the build_tzrule constructor to construct an STD-only
1048 // rule mimicking whatever ttinfo we've picked up, but it's possible
1049 // that the one we've picked up is a DST zone, so we need to make sure
1050 // that the dstoff is set correctly in that case.
1051 if (PyObject_IsTrue(tti->dstoff)) {
1052 _ttinfo *tti_after = &(self->tzrule_after.std);
1053 Py_DECREF(tti_after->dstoff);
1054 tti_after->dstoff = tti->dstoff;
1055 Py_INCREF(tti_after->dstoff);
1056 }
1057 }
1058
1059 // Determine if this is a "fixed offset" zone, meaning that the output of
1060 // the utcoffset, dst and tzname functions does not depend on the specific
1061 // datetime passed.
1062 //
1063 // We make three simplifying assumptions here:
1064 //
1065 // 1. If tzrule_after is not std_only, it has transitions that might occur
1066 // (it is possible to construct TZ strings that specify STD and DST but
1067 // no transitions ever occur, such as AAA0BBB,0/0,J365/25).
1068 // 2. If self->_ttinfos contains more than one _ttinfo object, the objects
1069 // represent different offsets.
1070 // 3. self->ttinfos contains no unused _ttinfos (in which case an otherwise
1071 // fixed-offset zone with extra _ttinfos defined may appear to *not* be
1072 // a fixed offset zone).
1073 //
1074 // Violations to these assumptions would be fairly exotic, and exotic
1075 // zones should almost certainly not be used with datetime.time (the
1076 // only thing that would be affected by this).
1077 if (self->num_ttinfos > 1 || !self->tzrule_after.std_only) {
1078 self->fixed_offset = 0;
1079 }
1080 else if (self->num_ttinfos == 0) {
1081 self->fixed_offset = 1;
1082 }
1083 else {
1084 int constant_offset =
1085 ttinfo_eq(&(self->_ttinfos[0]), &self->tzrule_after.std);
1086 if (constant_offset < 0) {
1087 goto error;
1088 }
1089 else {
1090 self->fixed_offset = constant_offset;
1091 }
1092 }
1093
1094 int rv = 0;
1095 goto cleanup;
1096error:
1097 // These resources only need to be freed if we have failed, if we succeed
1098 // in initializing a PyZoneInfo_ZoneInfo object, we can rely on its dealloc
1099 // method to free the relevant resources.
1100 if (self->trans_list_utc != NULL) {
1101 PyMem_Free(self->trans_list_utc);
1102 self->trans_list_utc = NULL;
1103 }
1104
1105 for (size_t i = 0; i < 2; ++i) {
1106 if (self->trans_list_wall[i] != NULL) {
1107 PyMem_Free(self->trans_list_wall[i]);
1108 self->trans_list_wall[i] = NULL;
1109 }
1110 }
1111
1112 if (self->_ttinfos != NULL) {
1113 for (size_t i = 0; i < ttinfos_allocated; ++i) {
1114 xdecref_ttinfo(&(self->_ttinfos[i]));
1115 }
1116 PyMem_Free(self->_ttinfos);
1117 self->_ttinfos = NULL;
1118 }
1119
1120 if (self->trans_ttinfos != NULL) {
1121 PyMem_Free(self->trans_ttinfos);
1122 self->trans_ttinfos = NULL;
1123 }
1124
1125 rv = -1;
1126cleanup:
1127 Py_XDECREF(data_tuple);
1128
1129 if (utcoff != NULL) {
1130 PyMem_Free(utcoff);
1131 }
1132
1133 if (dstoff != NULL) {
1134 PyMem_Free(dstoff);
1135 }
1136
1137 if (isdst != NULL) {
1138 PyMem_Free(isdst);
1139 }
1140
1141 if (trans_idx != NULL) {
1142 PyMem_Free(trans_idx);
1143 }
1144
1145 return rv;
1146}
1147
1148/* Function to calculate the local timestamp of a transition from the year. */
1149int64_t
1150calendarrule_year_to_timestamp(TransitionRuleType *base_self, int year)
1151{
1152 CalendarRule *self = (CalendarRule *)base_self;
1153
1154 // We want (year, month, day of month); we have year and month, but we
1155 // need to turn (week, day-of-week) into day-of-month
1156 //
1157 // Week 1 is the first week in which day `day` (where 0 = Sunday) appears.
1158 // Week 5 represents the last occurrence of day `day`, so we need to know
1159 // the first weekday of the month and the number of days in the month.
1160 int8_t first_day = (ymd_to_ord(year, self->month, 1) + 6) % 7;
1161 uint8_t days_in_month = DAYS_IN_MONTH[self->month];
1162 if (self->month == 2 && is_leap_year(year)) {
1163 days_in_month += 1;
1164 }
1165
1166 // This equation seems magical, so I'll break it down:
1167 // 1. calendar says 0 = Monday, POSIX says 0 = Sunday so we need first_day
1168 // + 1 to get 1 = Monday -> 7 = Sunday, which is still equivalent
1169 // because this math is mod 7
1170 // 2. Get first day - desired day mod 7 (adjusting by 7 for negative
1171 // numbers so that -1 % 7 = 6).
1172 // 3. Add 1 because month days are a 1-based index.
1173 int8_t month_day = ((int8_t)(self->day) - (first_day + 1)) % 7;
1174 if (month_day < 0) {
1175 month_day += 7;
1176 }
1177 month_day += 1;
1178
1179 // Now use a 0-based index version of `week` to calculate the w-th
1180 // occurrence of `day`
1181 month_day += ((int8_t)(self->week) - 1) * 7;
1182
1183 // month_day will only be > days_in_month if w was 5, and `w` means "last
1184 // occurrence of `d`", so now we just check if we over-shot the end of the
1185 // month and if so knock off 1 week.
1186 if (month_day > days_in_month) {
1187 month_day -= 7;
1188 }
1189
1190 int64_t ordinal = ymd_to_ord(year, self->month, month_day) - EPOCHORDINAL;
1191 return ((ordinal * 86400) + (int64_t)(self->hour * 3600) +
1192 (int64_t)(self->minute * 60) + (int64_t)(self->second));
1193}
1194
1195/* Constructor for CalendarRule. */
1196int
1197calendarrule_new(uint8_t month, uint8_t week, uint8_t day, int8_t hour,
1198 int8_t minute, int8_t second, CalendarRule *out)
1199{
1200 // These bounds come from the POSIX standard, which describes an Mm.n.d
1201 // rule as:
1202 //
1203 // The d'th day (0 <= d <= 6) of week n of month m of the year (1 <= n <=
1204 // 5, 1 <= m <= 12, where week 5 means "the last d day in month m" which
1205 // may occur in either the fourth or the fifth week). Week 1 is the first
1206 // week in which the d'th day occurs. Day zero is Sunday.
1207 if (month <= 0 || month > 12) {
1208 PyErr_Format(PyExc_ValueError, "Month must be in (0, 12]");
1209 return -1;
1210 }
1211
1212 if (week <= 0 || week > 5) {
1213 PyErr_Format(PyExc_ValueError, "Week must be in (0, 5]");
1214 return -1;
1215 }
1216
1217 // day is an unsigned integer, so day < 0 should always return false, but
1218 // if day's type changes to a signed integer *without* changing this value,
1219 // it may create a bug. Considering that the compiler should be able to
1220 // optimize out the first comparison if day is an unsigned integer anyway,
1221 // we will leave this comparison in place and disable the compiler warning.
1222#pragma GCC diagnostic push
1223#pragma GCC diagnostic ignored "-Wtype-limits"
1224 if (day < 0 || day > 6) {
1225#pragma GCC diagnostic pop
1226 PyErr_Format(PyExc_ValueError, "Day must be in [0, 6]");
1227 return -1;
1228 }
1229
1230 TransitionRuleType base = {&calendarrule_year_to_timestamp};
1231
1232 CalendarRule new_offset = {
1233 .base = base,
1234 .month = month,
1235 .week = week,
1236 .day = day,
1237 .hour = hour,
1238 .minute = minute,
1239 .second = second,
1240 };
1241
1242 *out = new_offset;
1243 return 0;
1244}
1245
1246/* Function to calculate the local timestamp of a transition from the year.
1247 *
1248 * This translates the day of the year into a local timestamp — either a
1249 * 1-based Julian day, not including leap days, or the 0-based year-day,
1250 * including leap days.
1251 * */
1252int64_t
1253dayrule_year_to_timestamp(TransitionRuleType *base_self, int year)
1254{
1255 // The function signature requires a TransitionRuleType pointer, but this
1256 // function is only applicable to DayRule* objects.
1257 DayRule *self = (DayRule *)base_self;
1258
1259 // ymd_to_ord calculates the number of days since 0001-01-01, but we want
1260 // to know the number of days since 1970-01-01, so we must subtract off
1261 // the equivalent of ymd_to_ord(1970, 1, 1).
1262 //
1263 // We subtract off an additional 1 day to account for January 1st (we want
1264 // the number of full days *before* the date of the transition - partial
1265 // days are accounted for in the hour, minute and second portions.
1266 int64_t days_before_year = ymd_to_ord(year, 1, 1) - EPOCHORDINAL - 1;
1267
1268 // The Julian day specification skips over February 29th in leap years,
1269 // from the POSIX standard:
1270 //
1271 // Leap days shall not be counted. That is, in all years-including leap
1272 // years-February 28 is day 59 and March 1 is day 60. It is impossible to
1273 // refer explicitly to the occasional February 29.
1274 //
1275 // This is actually more useful than you'd think — if you want a rule that
1276 // always transitions on a given calendar day (other than February 29th),
1277 // you would use a Julian day, e.g. J91 always refers to April 1st and J365
1278 // always refers to December 31st.
1279 unsigned int day = self->day;
1280 if (self->julian && day >= 59 && is_leap_year(year)) {
1281 day += 1;
1282 }
1283
1284 return ((days_before_year + day) * 86400) + (self->hour * 3600) +
1285 (self->minute * 60) + self->second;
1286}
1287
1288/* Constructor for DayRule. */
1289static int
1290dayrule_new(uint8_t julian, unsigned int day, int8_t hour, int8_t minute,
1291 int8_t second, DayRule *out)
1292{
1293 // The POSIX standard specifies that Julian days must be in the range (1 <=
1294 // n <= 365) and that non-Julian (they call it "0-based Julian") days must
1295 // be in the range (0 <= n <= 365).
1296 if (day < julian || day > 365) {
1297 PyErr_Format(PyExc_ValueError, "day must be in [%u, 365], not: %u",
1298 julian, day);
1299 return -1;
1300 }
1301
1302 TransitionRuleType base = {
1303 &dayrule_year_to_timestamp,
1304 };
1305
1306 DayRule tmp = {
1307 .base = base,
1308 .julian = julian,
1309 .day = day,
1310 .hour = hour,
1311 .minute = minute,
1312 .second = second,
1313 };
1314
1315 *out = tmp;
1316
1317 return 0;
1318}
1319
1320/* Calculate the start and end rules for a _tzrule in the given year. */
1321static void
1322tzrule_transitions(_tzrule *rule, int year, int64_t *start, int64_t *end)
1323{
1324 assert(rule->start != NULL);
1325 assert(rule->end != NULL);
1326 *start = rule->start->year_to_timestamp(rule->start, year);
1327 *end = rule->end->year_to_timestamp(rule->end, year);
1328}
1329
1330/* Calculate the _ttinfo that applies at a given local time from a _tzrule.
1331 *
1332 * This takes a local timestamp and fold for disambiguation purposes; the year
1333 * could technically be calculated from the timestamp, but given that the
1334 * callers of this function already have the year information accessible from
1335 * the datetime struct, it is taken as an additional parameter to reduce
1336 * unncessary calculation.
1337 * */
1338static _ttinfo *
1339find_tzrule_ttinfo(_tzrule *rule, int64_t ts, unsigned char fold, int year)
1340{
1341 if (rule->std_only) {
1342 return &(rule->std);
1343 }
1344
1345 int64_t start, end;
1346 uint8_t isdst;
1347
1348 tzrule_transitions(rule, year, &start, &end);
1349
1350 // With fold = 0, the period (denominated in local time) with the smaller
1351 // offset starts at the end of the gap and ends at the end of the fold;
1352 // with fold = 1, it runs from the start of the gap to the beginning of the
1353 // fold.
1354 //
1355 // So in order to determine the DST boundaries we need to know both the
1356 // fold and whether DST is positive or negative (rare), and it turns out
1357 // that this boils down to fold XOR is_positive.
1358 if (fold == (rule->dst_diff >= 0)) {
1359 end -= rule->dst_diff;
1360 }
1361 else {
1362 start += rule->dst_diff;
1363 }
1364
1365 if (start < end) {
1366 isdst = (ts >= start) && (ts < end);
1367 }
1368 else {
1369 isdst = (ts < end) || (ts >= start);
1370 }
1371
1372 if (isdst) {
1373 return &(rule->dst);
1374 }
1375 else {
1376 return &(rule->std);
1377 }
1378}
1379
1380/* Calculate the ttinfo and fold that applies for a _tzrule at an epoch time.
1381 *
1382 * This function can determine the _ttinfo that applies at a given epoch time,
1383 * (analogous to trans_list_utc), and whether or not the datetime is in a fold.
1384 * This is to be used in the .fromutc() function.
1385 *
1386 * The year is technically a redundant parameter, because it can be calculated
1387 * from the timestamp, but all callers of this function should have the year
1388 * in the datetime struct anyway, so taking it as a parameter saves unnecessary
1389 * calculation.
1390 **/
1391static _ttinfo *
1392find_tzrule_ttinfo_fromutc(_tzrule *rule, int64_t ts, int year,
1393 unsigned char *fold)
1394{
1395 if (rule->std_only) {
1396 *fold = 0;
1397 return &(rule->std);
1398 }
1399
1400 int64_t start, end;
1401 uint8_t isdst;
1402 tzrule_transitions(rule, year, &start, &end);
1403 start -= rule->std.utcoff_seconds;
1404 end -= rule->dst.utcoff_seconds;
1405
1406 if (start < end) {
1407 isdst = (ts >= start) && (ts < end);
1408 }
1409 else {
1410 isdst = (ts < end) || (ts >= start);
1411 }
1412
1413 // For positive DST, the ambiguous period is one dst_diff after the end of
1414 // DST; for negative DST, the ambiguous period is one dst_diff before the
1415 // start of DST.
1416 int64_t ambig_start, ambig_end;
1417 if (rule->dst_diff > 0) {
1418 ambig_start = end;
1419 ambig_end = end + rule->dst_diff;
1420 }
1421 else {
1422 ambig_start = start;
1423 ambig_end = start - rule->dst_diff;
1424 }
1425
1426 *fold = (ts >= ambig_start) && (ts < ambig_end);
1427
1428 if (isdst) {
1429 return &(rule->dst);
1430 }
1431 else {
1432 return &(rule->std);
1433 }
1434}
1435
1436/* Parse a TZ string in the format specified by the POSIX standard:
1437 *
1438 * std offset[dst[offset],start[/time],end[/time]]
1439 *
1440 * std and dst must be 3 or more characters long and must not contain a
1441 * leading colon, embedded digits, commas, nor a plus or minus signs; The
1442 * spaces between "std" and "offset" are only for display and are not actually
1443 * present in the string.
1444 *
1445 * The format of the offset is ``[+|-]hh[:mm[:ss]]``
1446 *
1447 * See the POSIX.1 spec: IEE Std 1003.1-2018 §8.3:
1448 *
1449 * https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html
1450 */
1451static int
1452parse_tz_str(PyObject *tz_str_obj, _tzrule *out)
1453{
1454 PyObject *std_abbr = NULL;
1455 PyObject *dst_abbr = NULL;
1456 TransitionRuleType *start = NULL;
1457 TransitionRuleType *end = NULL;
Dong-hee Naa487a392020-05-22 01:56:03 +09001458 // Initialize offsets to invalid value (> 24 hours)
1459 long std_offset = 1 << 20;
1460 long dst_offset = 1 << 20;
Paul Ganssle62972d92020-05-16 04:20:06 -04001461
1462 char *tz_str = PyBytes_AsString(tz_str_obj);
1463 if (tz_str == NULL) {
1464 return -1;
1465 }
1466 char *p = tz_str;
1467
1468 // Read the `std` abbreviation, which must be at least 3 characters long.
Pablo Galindoe4799b92020-05-27 21:48:12 +01001469 Py_ssize_t num_chars = parse_abbr(p, &std_abbr);
Paul Ganssle62972d92020-05-16 04:20:06 -04001470 if (num_chars < 1) {
1471 PyErr_Format(PyExc_ValueError, "Invalid STD format in %R", tz_str_obj);
1472 goto error;
1473 }
1474
1475 p += num_chars;
1476
1477 // Now read the STD offset, which is required
1478 num_chars = parse_tz_delta(p, &std_offset);
1479 if (num_chars < 0) {
1480 PyErr_Format(PyExc_ValueError, "Invalid STD offset in %R", tz_str_obj);
1481 goto error;
1482 }
1483 p += num_chars;
1484
1485 // If the string ends here, there is no DST, otherwise we must parse the
1486 // DST abbreviation and start and end dates and times.
1487 if (*p == '\0') {
1488 goto complete;
1489 }
1490
1491 num_chars = parse_abbr(p, &dst_abbr);
1492 if (num_chars < 1) {
1493 PyErr_Format(PyExc_ValueError, "Invalid DST format in %R", tz_str_obj);
1494 goto error;
1495 }
1496 p += num_chars;
1497
1498 if (*p == ',') {
1499 // From the POSIX standard:
1500 //
1501 // If no offset follows dst, the alternative time is assumed to be one
1502 // hour ahead of standard time.
1503 dst_offset = std_offset + 3600;
1504 }
1505 else {
1506 num_chars = parse_tz_delta(p, &dst_offset);
1507 if (num_chars < 0) {
1508 PyErr_Format(PyExc_ValueError, "Invalid DST offset in %R",
1509 tz_str_obj);
1510 goto error;
1511 }
1512
1513 p += num_chars;
1514 }
1515
1516 TransitionRuleType **transitions[2] = {&start, &end};
1517 for (size_t i = 0; i < 2; ++i) {
1518 if (*p != ',') {
1519 PyErr_Format(PyExc_ValueError,
1520 "Missing transition rules in TZ string: %R",
1521 tz_str_obj);
1522 goto error;
1523 }
1524 p++;
1525
1526 num_chars = parse_transition_rule(p, transitions[i]);
1527 if (num_chars < 0) {
1528 PyErr_Format(PyExc_ValueError,
1529 "Malformed transition rule in TZ string: %R",
1530 tz_str_obj);
1531 goto error;
1532 }
1533 p += num_chars;
1534 }
1535
1536 if (*p != '\0') {
1537 PyErr_Format(PyExc_ValueError,
1538 "Extraneous characters at end of TZ string: %R",
1539 tz_str_obj);
1540 goto error;
1541 }
1542
1543complete:
1544 build_tzrule(std_abbr, dst_abbr, std_offset, dst_offset, start, end, out);
1545 Py_DECREF(std_abbr);
1546 Py_XDECREF(dst_abbr);
1547
1548 return 0;
1549error:
1550 Py_XDECREF(std_abbr);
1551 if (dst_abbr != NULL && dst_abbr != Py_None) {
1552 Py_DECREF(dst_abbr);
1553 }
1554
1555 if (start != NULL) {
1556 PyMem_Free(start);
1557 }
1558
1559 if (end != NULL) {
1560 PyMem_Free(end);
1561 }
1562
1563 return -1;
1564}
1565
Pablo Galindoe4799b92020-05-27 21:48:12 +01001566static int
1567parse_uint(const char *const p, uint8_t *value)
Paul Ganssle62972d92020-05-16 04:20:06 -04001568{
1569 if (!isdigit(*p)) {
1570 return -1;
1571 }
1572
Pablo Galindoe4799b92020-05-27 21:48:12 +01001573 *value = (*p) - '0';
1574 return 0;
Paul Ganssle62972d92020-05-16 04:20:06 -04001575}
1576
1577/* Parse the STD and DST abbreviations from a TZ string. */
Pablo Galindoe4799b92020-05-27 21:48:12 +01001578static Py_ssize_t
Paul Ganssle62972d92020-05-16 04:20:06 -04001579parse_abbr(const char *const p, PyObject **abbr)
1580{
1581 const char *ptr = p;
1582 char buff = *ptr;
1583 const char *str_start;
1584 const char *str_end;
1585
1586 if (*ptr == '<') {
1587 ptr++;
1588 str_start = ptr;
1589 while ((buff = *ptr) != '>') {
1590 // From the POSIX standard:
1591 //
1592 // In the quoted form, the first character shall be the less-than
1593 // ( '<' ) character and the last character shall be the
1594 // greater-than ( '>' ) character. All characters between these
1595 // quoting characters shall be alphanumeric characters from the
1596 // portable character set in the current locale, the plus-sign (
1597 // '+' ) character, or the minus-sign ( '-' ) character. The std
1598 // and dst fields in this case shall not include the quoting
1599 // characters.
1600 if (!isalpha(buff) && !isdigit(buff) && buff != '+' &&
1601 buff != '-') {
1602 return -1;
1603 }
1604 ptr++;
1605 }
1606 str_end = ptr;
1607 ptr++;
1608 }
1609 else {
1610 str_start = p;
1611 // From the POSIX standard:
1612 //
1613 // In the unquoted form, all characters in these fields shall be
1614 // alphabetic characters from the portable character set in the
1615 // current locale.
1616 while (isalpha(*ptr)) {
1617 ptr++;
1618 }
1619 str_end = ptr;
1620 }
1621
1622 *abbr = PyUnicode_FromStringAndSize(str_start, str_end - str_start);
Gregory P. Smithd780fa72020-06-22 00:39:28 -07001623 if (*abbr == NULL) {
Paul Ganssle62972d92020-05-16 04:20:06 -04001624 return -1;
1625 }
1626
1627 return ptr - p;
1628}
1629
1630/* Parse a UTC offset from a TZ str. */
Pablo Galindoe4799b92020-05-27 21:48:12 +01001631static Py_ssize_t
Paul Ganssle62972d92020-05-16 04:20:06 -04001632parse_tz_delta(const char *const p, long *total_seconds)
1633{
1634 // From the POSIX spec:
1635 //
1636 // Indicates the value added to the local time to arrive at Coordinated
1637 // Universal Time. The offset has the form:
1638 //
1639 // hh[:mm[:ss]]
1640 //
1641 // One or more digits may be used; the value is always interpreted as a
1642 // decimal number.
1643 //
1644 // The POSIX spec says that the values for `hour` must be between 0 and 24
1645 // hours, but RFC 8536 §3.3.1 specifies that the hours part of the
1646 // transition times may be signed and range from -167 to 167.
1647 long sign = -1;
1648 long hours = 0;
1649 long minutes = 0;
1650 long seconds = 0;
1651
1652 const char *ptr = p;
1653 char buff = *ptr;
1654 if (buff == '-' || buff == '+') {
1655 // Negative numbers correspond to *positive* offsets, from the spec:
1656 //
1657 // If preceded by a '-', the timezone shall be east of the Prime
1658 // Meridian; otherwise, it shall be west (which may be indicated by
1659 // an optional preceding '+' ).
1660 if (buff == '-') {
1661 sign = 1;
1662 }
1663
1664 ptr++;
1665 }
1666
1667 // The hour can be 1 or 2 numeric characters
1668 for (size_t i = 0; i < 2; ++i) {
1669 buff = *ptr;
1670 if (!isdigit(buff)) {
1671 if (i == 0) {
1672 return -1;
1673 }
1674 else {
1675 break;
1676 }
1677 }
1678
1679 hours *= 10;
1680 hours += buff - '0';
1681 ptr++;
1682 }
1683
1684 if (hours > 24 || hours < 0) {
1685 return -1;
1686 }
1687
1688 // Minutes and seconds always of the format ":dd"
1689 long *outputs[2] = {&minutes, &seconds};
1690 for (size_t i = 0; i < 2; ++i) {
1691 if (*ptr != ':') {
1692 goto complete;
1693 }
1694 ptr++;
1695
1696 for (size_t j = 0; j < 2; ++j) {
1697 buff = *ptr;
1698 if (!isdigit(buff)) {
1699 return -1;
1700 }
1701 *(outputs[i]) *= 10;
1702 *(outputs[i]) += buff - '0';
1703 ptr++;
1704 }
1705 }
1706
1707complete:
1708 *total_seconds = sign * ((hours * 3600) + (minutes * 60) + seconds);
1709
1710 return ptr - p;
1711}
1712
1713/* Parse the date portion of a transition rule. */
Pablo Galindoe4799b92020-05-27 21:48:12 +01001714static Py_ssize_t
Paul Ganssle62972d92020-05-16 04:20:06 -04001715parse_transition_rule(const char *const p, TransitionRuleType **out)
1716{
1717 // The full transition rule indicates when to change back and forth between
1718 // STD and DST, and has the form:
1719 //
1720 // date[/time],date[/time]
1721 //
1722 // This function parses an individual date[/time] section, and returns
1723 // the number of characters that contributed to the transition rule. This
1724 // does not include the ',' at the end of the first rule.
1725 //
1726 // The POSIX spec states that if *time* is not given, the default is 02:00.
1727 const char *ptr = p;
1728 int8_t hour = 2;
1729 int8_t minute = 0;
1730 int8_t second = 0;
1731
1732 // Rules come in one of three flavors:
1733 //
1734 // 1. Jn: Julian day n, with no leap days.
1735 // 2. n: Day of year (0-based, with leap days)
1736 // 3. Mm.n.d: Specifying by month, week and day-of-week.
1737
1738 if (*ptr == 'M') {
1739 uint8_t month, week, day;
1740 ptr++;
Pablo Galindoe4799b92020-05-27 21:48:12 +01001741 if (parse_uint(ptr, &month)) {
Paul Ganssle62972d92020-05-16 04:20:06 -04001742 return -1;
1743 }
Paul Ganssle62972d92020-05-16 04:20:06 -04001744 ptr++;
1745 if (*ptr != '.') {
Pablo Galindoe4799b92020-05-27 21:48:12 +01001746 uint8_t tmp;
1747 if (parse_uint(ptr, &tmp)) {
Paul Ganssle62972d92020-05-16 04:20:06 -04001748 return -1;
1749 }
1750
1751 month *= 10;
Pablo Galindoe4799b92020-05-27 21:48:12 +01001752 month += tmp;
Paul Ganssle62972d92020-05-16 04:20:06 -04001753 ptr++;
1754 }
1755
1756 uint8_t *values[2] = {&week, &day};
1757 for (size_t i = 0; i < 2; ++i) {
1758 if (*ptr != '.') {
1759 return -1;
1760 }
1761 ptr++;
1762
Pablo Galindoe4799b92020-05-27 21:48:12 +01001763 if (parse_uint(ptr, values[i])) {
Paul Ganssle62972d92020-05-16 04:20:06 -04001764 return -1;
1765 }
1766 ptr++;
Paul Ganssle62972d92020-05-16 04:20:06 -04001767 }
1768
1769 if (*ptr == '/') {
1770 ptr++;
Pablo Galindoe4799b92020-05-27 21:48:12 +01001771 Py_ssize_t num_chars =
Paul Ganssle62972d92020-05-16 04:20:06 -04001772 parse_transition_time(ptr, &hour, &minute, &second);
1773 if (num_chars < 0) {
1774 return -1;
1775 }
1776 ptr += num_chars;
1777 }
1778
1779 CalendarRule *rv = PyMem_Calloc(1, sizeof(CalendarRule));
1780 if (rv == NULL) {
1781 return -1;
1782 }
1783
1784 if (calendarrule_new(month, week, day, hour, minute, second, rv)) {
1785 PyMem_Free(rv);
1786 return -1;
1787 }
1788
1789 *out = (TransitionRuleType *)rv;
1790 }
1791 else {
1792 uint8_t julian = 0;
1793 unsigned int day = 0;
1794 if (*ptr == 'J') {
1795 julian = 1;
1796 ptr++;
1797 }
1798
1799 for (size_t i = 0; i < 3; ++i) {
1800 if (!isdigit(*ptr)) {
1801 if (i == 0) {
1802 return -1;
1803 }
1804 break;
1805 }
1806 day *= 10;
1807 day += (*ptr) - '0';
1808 ptr++;
1809 }
1810
1811 if (*ptr == '/') {
1812 ptr++;
Pablo Galindoe4799b92020-05-27 21:48:12 +01001813 Py_ssize_t num_chars =
Paul Ganssle62972d92020-05-16 04:20:06 -04001814 parse_transition_time(ptr, &hour, &minute, &second);
1815 if (num_chars < 0) {
1816 return -1;
1817 }
1818 ptr += num_chars;
1819 }
1820
1821 DayRule *rv = PyMem_Calloc(1, sizeof(DayRule));
1822 if (rv == NULL) {
1823 return -1;
1824 }
1825
1826 if (dayrule_new(julian, day, hour, minute, second, rv)) {
1827 PyMem_Free(rv);
1828 return -1;
1829 }
1830 *out = (TransitionRuleType *)rv;
1831 }
1832
1833 return ptr - p;
1834}
1835
1836/* Parse the time portion of a transition rule (e.g. following an /) */
Pablo Galindoe4799b92020-05-27 21:48:12 +01001837static Py_ssize_t
Paul Ganssle62972d92020-05-16 04:20:06 -04001838parse_transition_time(const char *const p, int8_t *hour, int8_t *minute,
1839 int8_t *second)
1840{
1841 // From the spec:
1842 //
1843 // The time has the same format as offset except that no leading sign
1844 // ( '-' or '+' ) is allowed.
1845 //
1846 // The format for the offset is:
1847 //
1848 // h[h][:mm[:ss]]
1849 //
1850 // RFC 8536 also allows transition times to be signed and to range from
1851 // -167 to +167, but the current version only supports [0, 99].
1852 //
1853 // TODO: Support the full range of transition hours.
1854 int8_t *components[3] = {hour, minute, second};
1855 const char *ptr = p;
1856 int8_t sign = 1;
1857
1858 if (*ptr == '-' || *ptr == '+') {
1859 if (*ptr == '-') {
1860 sign = -1;
1861 }
1862 ptr++;
1863 }
1864
1865 for (size_t i = 0; i < 3; ++i) {
1866 if (i > 0) {
1867 if (*ptr != ':') {
1868 break;
1869 }
1870 ptr++;
1871 }
1872
1873 uint8_t buff = 0;
1874 for (size_t j = 0; j < 2; j++) {
1875 if (!isdigit(*ptr)) {
1876 if (i == 0 && j > 0) {
1877 break;
1878 }
1879 return -1;
1880 }
1881
1882 buff *= 10;
1883 buff += (*ptr) - '0';
1884 ptr++;
1885 }
1886
1887 *(components[i]) = sign * buff;
1888 }
1889
1890 return ptr - p;
1891}
1892
1893/* Constructor for a _tzrule.
1894 *
1895 * If `dst_abbr` is NULL, this will construct an "STD-only" _tzrule, in which
1896 * case `dst_offset` will be ignored and `start` and `end` are expected to be
1897 * NULL as well.
1898 *
1899 * Returns 0 on success.
1900 */
1901static int
1902build_tzrule(PyObject *std_abbr, PyObject *dst_abbr, long std_offset,
1903 long dst_offset, TransitionRuleType *start,
1904 TransitionRuleType *end, _tzrule *out)
1905{
Dong-hee Naa487a392020-05-22 01:56:03 +09001906 _tzrule rv = {{0}};
Paul Ganssle62972d92020-05-16 04:20:06 -04001907
1908 rv.start = start;
1909 rv.end = end;
1910
1911 if (build_ttinfo(std_offset, 0, std_abbr, &rv.std)) {
1912 goto error;
1913 }
1914
1915 if (dst_abbr != NULL) {
1916 rv.dst_diff = dst_offset - std_offset;
1917 if (build_ttinfo(dst_offset, rv.dst_diff, dst_abbr, &rv.dst)) {
1918 goto error;
1919 }
1920 }
1921 else {
1922 rv.std_only = 1;
1923 }
1924
1925 *out = rv;
1926
1927 return 0;
1928error:
1929 xdecref_ttinfo(&rv.std);
1930 xdecref_ttinfo(&rv.dst);
1931 return -1;
1932}
1933
1934/* Destructor for _tzrule. */
1935static void
1936free_tzrule(_tzrule *tzrule)
1937{
1938 xdecref_ttinfo(&(tzrule->std));
1939 if (!tzrule->std_only) {
1940 xdecref_ttinfo(&(tzrule->dst));
1941 }
1942
1943 if (tzrule->start != NULL) {
1944 PyMem_Free(tzrule->start);
1945 }
1946
1947 if (tzrule->end != NULL) {
1948 PyMem_Free(tzrule->end);
1949 }
1950}
1951
1952/* Calculate DST offsets from transitions and UTC offsets
1953 *
1954 * This is necessary because each C `ttinfo` only contains the UTC offset,
1955 * time zone abbreviation and an isdst boolean - it does not include the
1956 * amount of the DST offset, but we need the amount for the dst() function.
1957 *
1958 * Thus function uses heuristics to infer what the offset should be, so it
1959 * is not guaranteed that this will work for all zones. If we cannot assign
1960 * a value for a given DST offset, we'll assume it's 1H rather than 0H, so
1961 * bool(dt.dst()) will always match ttinfo.isdst.
1962 */
1963static void
1964utcoff_to_dstoff(size_t *trans_idx, long *utcoffs, long *dstoffs,
1965 unsigned char *isdsts, size_t num_transitions,
1966 size_t num_ttinfos)
1967{
1968 size_t dst_count = 0;
1969 size_t dst_found = 0;
1970 for (size_t i = 0; i < num_ttinfos; ++i) {
1971 dst_count++;
1972 }
1973
1974 for (size_t i = 1; i < num_transitions; ++i) {
1975 if (dst_count == dst_found) {
1976 break;
1977 }
1978
1979 size_t idx = trans_idx[i];
1980 size_t comp_idx = trans_idx[i - 1];
1981
1982 // Only look at DST offsets that have nto been assigned already
1983 if (!isdsts[idx] || dstoffs[idx] != 0) {
1984 continue;
1985 }
1986
1987 long dstoff = 0;
1988 long utcoff = utcoffs[idx];
1989
1990 if (!isdsts[comp_idx]) {
1991 dstoff = utcoff - utcoffs[comp_idx];
1992 }
1993
1994 if (!dstoff && idx < (num_ttinfos - 1)) {
1995 comp_idx = trans_idx[i + 1];
1996
1997 // If the following transition is also DST and we couldn't find
1998 // the DST offset by this point, we're going to have to skip it
1999 // and hope this transition gets assigned later
2000 if (isdsts[comp_idx]) {
2001 continue;
2002 }
2003
2004 dstoff = utcoff - utcoffs[comp_idx];
2005 }
2006
2007 if (dstoff) {
2008 dst_found++;
2009 dstoffs[idx] = dstoff;
2010 }
2011 }
2012
2013 if (dst_found < dst_count) {
2014 // If there are time zones we didn't find a value for, we'll end up
2015 // with dstoff = 0 for something where isdst=1. This is obviously
2016 // wrong — one hour will be a much better guess than 0.
2017 for (size_t idx = 0; idx < num_ttinfos; ++idx) {
2018 if (isdsts[idx] && !dstoffs[idx]) {
2019 dstoffs[idx] = 3600;
2020 }
2021 }
2022 }
2023}
2024
2025#define _swap(x, y, buffer) \
2026 buffer = x; \
2027 x = y; \
2028 y = buffer;
2029
2030/* Calculate transitions in local time from UTC time and offsets.
2031 *
2032 * We want to know when each transition occurs, denominated in the number of
2033 * nominal wall-time seconds between 1970-01-01T00:00:00 and the transition in
2034 * *local time* (note: this is *not* equivalent to the output of
2035 * datetime.timestamp, which is the total number of seconds actual elapsed
2036 * since 1970-01-01T00:00:00Z in UTC).
2037 *
2038 * This is an ambiguous question because "local time" can be ambiguous — but it
2039 * is disambiguated by the `fold` parameter, so we allocate two arrays:
2040 *
2041 * trans_local[0]: The wall-time transitions for fold=0
2042 * trans_local[1]: The wall-time transitions for fold=1
2043 *
2044 * This returns 0 on success and a negative number of failure. The trans_local
2045 * arrays must be freed if they are not NULL.
2046 */
2047static int
2048ts_to_local(size_t *trans_idx, int64_t *trans_utc, long *utcoff,
2049 int64_t *trans_local[2], size_t num_ttinfos,
2050 size_t num_transitions)
2051{
2052 if (num_transitions == 0) {
2053 return 0;
2054 }
2055
2056 // Copy the UTC transitions into each array to be modified in place later
2057 for (size_t i = 0; i < 2; ++i) {
2058 trans_local[i] = PyMem_Malloc(num_transitions * sizeof(int64_t));
2059 if (trans_local[i] == NULL) {
2060 return -1;
2061 }
2062
2063 memcpy(trans_local[i], trans_utc, num_transitions * sizeof(int64_t));
2064 }
2065
2066 int64_t offset_0, offset_1, buff;
2067 if (num_ttinfos > 1) {
2068 offset_0 = utcoff[0];
2069 offset_1 = utcoff[trans_idx[0]];
2070
2071 if (offset_1 > offset_0) {
2072 _swap(offset_0, offset_1, buff);
2073 }
2074 }
2075 else {
2076 offset_0 = utcoff[0];
2077 offset_1 = utcoff[0];
2078 }
2079
2080 trans_local[0][0] += offset_0;
2081 trans_local[1][0] += offset_1;
2082
2083 for (size_t i = 1; i < num_transitions; ++i) {
2084 offset_0 = utcoff[trans_idx[i - 1]];
2085 offset_1 = utcoff[trans_idx[i]];
2086
2087 if (offset_1 > offset_0) {
2088 _swap(offset_1, offset_0, buff);
2089 }
2090
2091 trans_local[0][i] += offset_0;
2092 trans_local[1][i] += offset_1;
2093 }
2094
2095 return 0;
2096}
2097
2098/* Simple bisect_right binary search implementation */
2099static size_t
2100_bisect(const int64_t value, const int64_t *arr, size_t size)
2101{
2102 size_t lo = 0;
2103 size_t hi = size;
2104 size_t m;
2105
2106 while (lo < hi) {
2107 m = (lo + hi) / 2;
2108 if (arr[m] > value) {
2109 hi = m;
2110 }
2111 else {
2112 lo = m + 1;
2113 }
2114 }
2115
2116 return hi;
2117}
2118
2119/* Find the ttinfo rules that apply at a given local datetime. */
2120static _ttinfo *
2121find_ttinfo(PyZoneInfo_ZoneInfo *self, PyObject *dt)
2122{
2123 // datetime.time has a .tzinfo attribute that passes None as the dt
2124 // argument; it only really has meaning for fixed-offset zones.
2125 if (dt == Py_None) {
2126 if (self->fixed_offset) {
2127 return &(self->tzrule_after.std);
2128 }
2129 else {
2130 return &NO_TTINFO;
2131 }
2132 }
2133
2134 int64_t ts;
2135 if (get_local_timestamp(dt, &ts)) {
2136 return NULL;
2137 }
2138
2139 unsigned char fold = PyDateTime_DATE_GET_FOLD(dt);
2140 assert(fold < 2);
2141 int64_t *local_transitions = self->trans_list_wall[fold];
2142 size_t num_trans = self->num_transitions;
2143
2144 if (num_trans && ts < local_transitions[0]) {
2145 return self->ttinfo_before;
2146 }
2147 else if (!num_trans || ts > local_transitions[self->num_transitions - 1]) {
2148 return find_tzrule_ttinfo(&(self->tzrule_after), ts, fold,
2149 PyDateTime_GET_YEAR(dt));
2150 }
2151 else {
2152 size_t idx = _bisect(ts, local_transitions, self->num_transitions) - 1;
2153 assert(idx < self->num_transitions);
2154 return self->trans_ttinfos[idx];
2155 }
2156}
2157
2158static int
2159is_leap_year(int year)
2160{
2161 const unsigned int ayear = (unsigned int)year;
2162 return ayear % 4 == 0 && (ayear % 100 != 0 || ayear % 400 == 0);
2163}
2164
2165/* Calculates ordinal datetime from year, month and day. */
2166static int
2167ymd_to_ord(int y, int m, int d)
2168{
2169 y -= 1;
2170 int days_before_year = (y * 365) + (y / 4) - (y / 100) + (y / 400);
2171 int yearday = DAYS_BEFORE_MONTH[m];
2172 if (m > 2 && is_leap_year(y + 1)) {
2173 yearday += 1;
2174 }
2175
2176 return days_before_year + yearday + d;
2177}
2178
2179/* Calculate the number of seconds since 1970-01-01 in local time.
2180 *
2181 * This gets a datetime in the same "units" as self->trans_list_wall so that we
2182 * can easily determine which transitions a datetime falls between. See the
2183 * comment above ts_to_local for more information.
2184 * */
2185static int
2186get_local_timestamp(PyObject *dt, int64_t *local_ts)
2187{
2188 assert(local_ts != NULL);
2189
2190 int hour, minute, second;
2191 int ord;
2192 if (PyDateTime_CheckExact(dt)) {
2193 int y = PyDateTime_GET_YEAR(dt);
2194 int m = PyDateTime_GET_MONTH(dt);
2195 int d = PyDateTime_GET_DAY(dt);
2196 hour = PyDateTime_DATE_GET_HOUR(dt);
2197 minute = PyDateTime_DATE_GET_MINUTE(dt);
2198 second = PyDateTime_DATE_GET_SECOND(dt);
2199
2200 ord = ymd_to_ord(y, m, d);
2201 }
2202 else {
2203 PyObject *num = PyObject_CallMethod(dt, "toordinal", NULL);
2204 if (num == NULL) {
2205 return -1;
2206 }
2207
2208 ord = PyLong_AsLong(num);
2209 Py_DECREF(num);
2210 if (ord == -1 && PyErr_Occurred()) {
2211 return -1;
2212 }
2213
2214 num = PyObject_GetAttrString(dt, "hour");
2215 if (num == NULL) {
2216 return -1;
2217 }
2218 hour = PyLong_AsLong(num);
2219 Py_DECREF(num);
2220 if (hour == -1) {
2221 return -1;
2222 }
2223
2224 num = PyObject_GetAttrString(dt, "minute");
2225 if (num == NULL) {
2226 return -1;
2227 }
2228 minute = PyLong_AsLong(num);
2229 Py_DECREF(num);
2230 if (minute == -1) {
2231 return -1;
2232 }
2233
2234 num = PyObject_GetAttrString(dt, "second");
2235 if (num == NULL) {
2236 return -1;
2237 }
2238 second = PyLong_AsLong(num);
2239 Py_DECREF(num);
2240 if (second == -1) {
2241 return -1;
2242 }
2243 }
2244
2245 *local_ts = (int64_t)(ord - EPOCHORDINAL) * 86400 +
2246 (int64_t)(hour * 3600 + minute * 60 + second);
2247
2248 return 0;
2249}
2250
2251/////
2252// Functions for cache handling
2253
2254/* Constructor for StrongCacheNode */
2255static StrongCacheNode *
2256strong_cache_node_new(PyObject *key, PyObject *zone)
2257{
2258 StrongCacheNode *node = PyMem_Malloc(sizeof(StrongCacheNode));
2259 if (node == NULL) {
2260 return NULL;
2261 }
2262
2263 Py_INCREF(key);
2264 Py_INCREF(zone);
2265
2266 node->next = NULL;
2267 node->prev = NULL;
2268 node->key = key;
2269 node->zone = zone;
2270
2271 return node;
2272}
2273
2274/* Destructor for StrongCacheNode */
2275void
2276strong_cache_node_free(StrongCacheNode *node)
2277{
2278 Py_XDECREF(node->key);
2279 Py_XDECREF(node->zone);
2280
2281 PyMem_Free(node);
2282}
2283
2284/* Frees all nodes at or after a specified root in the strong cache.
2285 *
2286 * This can be used on the root node to free the entire cache or it can be used
2287 * to clear all nodes that have been expired (which, if everything is going
2288 * right, will actually only be 1 node at a time).
2289 */
2290void
2291strong_cache_free(StrongCacheNode *root)
2292{
2293 StrongCacheNode *node = root;
2294 StrongCacheNode *next_node;
2295 while (node != NULL) {
2296 next_node = node->next;
2297 strong_cache_node_free(node);
2298
2299 node = next_node;
2300 }
2301}
2302
2303/* Removes a node from the cache and update its neighbors.
2304 *
2305 * This is used both when ejecting a node from the cache and when moving it to
2306 * the front of the cache.
2307 */
2308static void
2309remove_from_strong_cache(StrongCacheNode *node)
2310{
2311 if (ZONEINFO_STRONG_CACHE == node) {
2312 ZONEINFO_STRONG_CACHE = node->next;
2313 }
2314
2315 if (node->prev != NULL) {
2316 node->prev->next = node->next;
2317 }
2318
2319 if (node->next != NULL) {
2320 node->next->prev = node->prev;
2321 }
2322
2323 node->next = NULL;
2324 node->prev = NULL;
2325}
2326
2327/* Retrieves the node associated with a key, if it exists.
2328 *
2329 * This traverses the strong cache until it finds a matching key and returns a
2330 * pointer to the relevant node if found. Returns NULL if no node is found.
2331 *
2332 * root may be NULL, indicating an empty cache.
2333 */
2334static StrongCacheNode *
2335find_in_strong_cache(const StrongCacheNode *const root, PyObject *const key)
2336{
2337 const StrongCacheNode *node = root;
2338 while (node != NULL) {
2339 if (PyObject_RichCompareBool(key, node->key, Py_EQ)) {
2340 return (StrongCacheNode *)node;
2341 }
2342
2343 node = node->next;
2344 }
2345
2346 return NULL;
2347}
2348
2349/* Ejects a given key from the class's strong cache, if applicable.
2350 *
2351 * This function is used to enable the per-key functionality in clear_cache.
2352 */
2353static void
2354eject_from_strong_cache(const PyTypeObject *const type, PyObject *key)
2355{
2356 if (type != &PyZoneInfo_ZoneInfoType) {
2357 return;
2358 }
2359
2360 StrongCacheNode *node = find_in_strong_cache(ZONEINFO_STRONG_CACHE, key);
2361 if (node != NULL) {
2362 remove_from_strong_cache(node);
2363
2364 strong_cache_node_free(node);
2365 }
2366}
2367
2368/* Moves a node to the front of the LRU cache.
2369 *
2370 * The strong cache is an LRU cache, so whenever a given node is accessed, if
2371 * it is not at the front of the cache, it needs to be moved there.
2372 */
2373static void
2374move_strong_cache_node_to_front(StrongCacheNode **root, StrongCacheNode *node)
2375{
2376 StrongCacheNode *root_p = *root;
2377 if (root_p == node) {
2378 return;
2379 }
2380
2381 remove_from_strong_cache(node);
2382
2383 node->prev = NULL;
2384 node->next = root_p;
2385
2386 if (root_p != NULL) {
2387 root_p->prev = node;
2388 }
2389
2390 *root = node;
2391}
2392
2393/* Retrieves a ZoneInfo from the strong cache if it's present.
2394 *
2395 * This function finds the ZoneInfo by key and if found will move the node to
2396 * the front of the LRU cache and return a new reference to it. It returns NULL
2397 * if the key is not in the cache.
2398 *
2399 * The strong cache is currently only implemented for the base class, so this
2400 * always returns a cache miss for subclasses.
2401 */
2402static PyObject *
2403zone_from_strong_cache(const PyTypeObject *const type, PyObject *const key)
2404{
2405 if (type != &PyZoneInfo_ZoneInfoType) {
2406 return NULL; // Strong cache currently only implemented for base class
2407 }
2408
2409 StrongCacheNode *node = find_in_strong_cache(ZONEINFO_STRONG_CACHE, key);
2410
2411 if (node != NULL) {
2412 move_strong_cache_node_to_front(&ZONEINFO_STRONG_CACHE, node);
2413 Py_INCREF(node->zone);
2414 return node->zone;
2415 }
2416
2417 return NULL; // Cache miss
2418}
2419
2420/* Inserts a new key into the strong LRU cache.
2421 *
2422 * This function is only to be used after a cache miss — it creates a new node
2423 * at the front of the cache and ejects any stale entries (keeping the size of
2424 * the cache to at most ZONEINFO_STRONG_CACHE_MAX_SIZE).
2425 */
2426static void
2427update_strong_cache(const PyTypeObject *const type, PyObject *key,
2428 PyObject *zone)
2429{
2430 if (type != &PyZoneInfo_ZoneInfoType) {
2431 return;
2432 }
2433
2434 StrongCacheNode *new_node = strong_cache_node_new(key, zone);
2435
2436 move_strong_cache_node_to_front(&ZONEINFO_STRONG_CACHE, new_node);
2437
2438 StrongCacheNode *node = new_node->next;
2439 for (size_t i = 1; i < ZONEINFO_STRONG_CACHE_MAX_SIZE; ++i) {
2440 if (node == NULL) {
2441 return;
2442 }
2443 node = node->next;
2444 }
2445
2446 // Everything beyond this point needs to be freed
2447 if (node != NULL) {
2448 if (node->prev != NULL) {
2449 node->prev->next = NULL;
2450 }
2451 strong_cache_free(node);
2452 }
2453}
2454
2455/* Clears all entries into a type's strong cache.
2456 *
2457 * Because the strong cache is not implemented for subclasses, this is a no-op
2458 * for everything except the base class.
2459 */
2460void
2461clear_strong_cache(const PyTypeObject *const type)
2462{
2463 if (type != &PyZoneInfo_ZoneInfoType) {
2464 return;
2465 }
2466
2467 strong_cache_free(ZONEINFO_STRONG_CACHE);
Paul Gansslec3dd7e42020-08-17 18:40:07 -04002468 ZONEINFO_STRONG_CACHE = NULL;
Paul Ganssle62972d92020-05-16 04:20:06 -04002469}
2470
2471static PyObject *
Benjamin Peterson0108b2a2020-07-15 10:02:14 -07002472new_weak_cache(void)
Paul Ganssle62972d92020-05-16 04:20:06 -04002473{
2474 PyObject *weakref_module = PyImport_ImportModule("weakref");
2475 if (weakref_module == NULL) {
2476 return NULL;
2477 }
2478
2479 PyObject *weak_cache =
2480 PyObject_CallMethod(weakref_module, "WeakValueDictionary", "");
2481 Py_DECREF(weakref_module);
2482 return weak_cache;
2483}
2484
2485static int
Benjamin Peterson0108b2a2020-07-15 10:02:14 -07002486initialize_caches(void)
Paul Ganssle62972d92020-05-16 04:20:06 -04002487{
Ammar Askar06a1b892020-05-22 16:10:55 +00002488 // TODO: Move to a PyModule_GetState / PEP 573 based caching system.
Paul Ganssle62972d92020-05-16 04:20:06 -04002489 if (TIMEDELTA_CACHE == NULL) {
2490 TIMEDELTA_CACHE = PyDict_New();
2491 }
2492 else {
2493 Py_INCREF(TIMEDELTA_CACHE);
2494 }
2495
2496 if (TIMEDELTA_CACHE == NULL) {
2497 return -1;
2498 }
2499
2500 if (ZONEINFO_WEAK_CACHE == NULL) {
2501 ZONEINFO_WEAK_CACHE = new_weak_cache();
2502 }
2503 else {
2504 Py_INCREF(ZONEINFO_WEAK_CACHE);
2505 }
2506
2507 if (ZONEINFO_WEAK_CACHE == NULL) {
2508 return -1;
2509 }
2510
2511 return 0;
2512}
2513
2514static PyObject *
2515zoneinfo_init_subclass(PyTypeObject *cls, PyObject *args, PyObject **kwargs)
2516{
2517 PyObject *weak_cache = new_weak_cache();
2518 if (weak_cache == NULL) {
2519 return NULL;
2520 }
2521
2522 PyObject_SetAttrString((PyObject *)cls, "_weak_cache", weak_cache);
Paul Gansslec3dd7e42020-08-17 18:40:07 -04002523 Py_DECREF(weak_cache);
Paul Ganssle62972d92020-05-16 04:20:06 -04002524 Py_RETURN_NONE;
2525}
2526
2527/////
2528// Specify the ZoneInfo type
2529static PyMethodDef zoneinfo_methods[] = {
2530 {"clear_cache", (PyCFunction)(void (*)(void))zoneinfo_clear_cache,
2531 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
2532 PyDoc_STR("Clear the ZoneInfo cache.")},
2533 {"no_cache", (PyCFunction)(void (*)(void))zoneinfo_no_cache,
2534 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
2535 PyDoc_STR("Get a new instance of ZoneInfo, bypassing the cache.")},
2536 {"from_file", (PyCFunction)(void (*)(void))zoneinfo_from_file,
2537 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
2538 PyDoc_STR("Create a ZoneInfo file from a file object.")},
2539 {"utcoffset", (PyCFunction)zoneinfo_utcoffset, METH_O,
2540 PyDoc_STR("Retrieve a timedelta representing the UTC offset in a zone at "
2541 "the given datetime.")},
2542 {"dst", (PyCFunction)zoneinfo_dst, METH_O,
2543 PyDoc_STR("Retrieve a timedelta representing the amount of DST applied "
2544 "in a zone at the given datetime.")},
2545 {"tzname", (PyCFunction)zoneinfo_tzname, METH_O,
2546 PyDoc_STR("Retrieve a string containing the abbreviation for the time "
2547 "zone that applies in a zone at a given datetime.")},
2548 {"fromutc", (PyCFunction)zoneinfo_fromutc, METH_O,
2549 PyDoc_STR("Given a datetime with local time in UTC, retrieve an adjusted "
2550 "datetime in local time.")},
2551 {"__reduce__", (PyCFunction)zoneinfo_reduce, METH_NOARGS,
2552 PyDoc_STR("Function for serialization with the pickle protocol.")},
2553 {"_unpickle", (PyCFunction)zoneinfo__unpickle, METH_VARARGS | METH_CLASS,
2554 PyDoc_STR("Private method used in unpickling.")},
2555 {"__init_subclass__", (PyCFunction)(void (*)(void))zoneinfo_init_subclass,
Paul Ganssle87d82872020-08-13 22:38:30 -04002556 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
Paul Ganssle62972d92020-05-16 04:20:06 -04002557 PyDoc_STR("Function to initialize subclasses.")},
2558 {NULL} /* Sentinel */
2559};
2560
2561static PyMemberDef zoneinfo_members[] = {
2562 {.name = "key",
2563 .offset = offsetof(PyZoneInfo_ZoneInfo, key),
2564 .type = T_OBJECT_EX,
2565 .flags = READONLY,
2566 .doc = NULL},
2567 {NULL}, /* Sentinel */
2568};
2569
2570static PyTypeObject PyZoneInfo_ZoneInfoType = {
2571 PyVarObject_HEAD_INIT(NULL, 0) //
2572 .tp_name = "zoneinfo.ZoneInfo",
2573 .tp_basicsize = sizeof(PyZoneInfo_ZoneInfo),
2574 .tp_weaklistoffset = offsetof(PyZoneInfo_ZoneInfo, weakreflist),
2575 .tp_repr = (reprfunc)zoneinfo_repr,
2576 .tp_str = (reprfunc)zoneinfo_str,
2577 .tp_getattro = PyObject_GenericGetAttr,
2578 .tp_flags = (Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE),
2579 /* .tp_doc = zoneinfo_doc, */
2580 .tp_methods = zoneinfo_methods,
2581 .tp_members = zoneinfo_members,
2582 .tp_new = zoneinfo_new,
2583 .tp_dealloc = zoneinfo_dealloc,
2584};
2585
2586/////
2587// Specify the _zoneinfo module
2588static PyMethodDef module_methods[] = {{NULL, NULL}};
2589static void
2590module_free()
2591{
2592 Py_XDECREF(_tzpath_find_tzfile);
2593 _tzpath_find_tzfile = NULL;
2594
2595 Py_XDECREF(_common_mod);
2596 _common_mod = NULL;
2597
2598 Py_XDECREF(io_open);
2599 io_open = NULL;
2600
2601 xdecref_ttinfo(&NO_TTINFO);
2602
Ammar Askar06a1b892020-05-22 16:10:55 +00002603 if (TIMEDELTA_CACHE != NULL && Py_REFCNT(TIMEDELTA_CACHE) > 1) {
2604 Py_DECREF(TIMEDELTA_CACHE);
2605 } else {
2606 Py_CLEAR(TIMEDELTA_CACHE);
Paul Ganssle62972d92020-05-16 04:20:06 -04002607 }
2608
Ammar Askar06a1b892020-05-22 16:10:55 +00002609 if (ZONEINFO_WEAK_CACHE != NULL && Py_REFCNT(ZONEINFO_WEAK_CACHE) > 1) {
2610 Py_DECREF(ZONEINFO_WEAK_CACHE);
2611 } else {
2612 Py_CLEAR(ZONEINFO_WEAK_CACHE);
Paul Ganssle62972d92020-05-16 04:20:06 -04002613 }
2614
Paul Gansslec3dd7e42020-08-17 18:40:07 -04002615 clear_strong_cache(&PyZoneInfo_ZoneInfoType);
Paul Ganssle62972d92020-05-16 04:20:06 -04002616}
2617
2618static int
2619zoneinfomodule_exec(PyObject *m)
2620{
2621 PyDateTime_IMPORT;
2622 PyZoneInfo_ZoneInfoType.tp_base = PyDateTimeAPI->TZInfoType;
2623 if (PyType_Ready(&PyZoneInfo_ZoneInfoType) < 0) {
2624 goto error;
2625 }
2626
2627 Py_INCREF(&PyZoneInfo_ZoneInfoType);
2628 PyModule_AddObject(m, "ZoneInfo", (PyObject *)&PyZoneInfo_ZoneInfoType);
2629
2630 /* Populate imports */
2631 PyObject *_tzpath_module = PyImport_ImportModule("zoneinfo._tzpath");
2632 if (_tzpath_module == NULL) {
2633 goto error;
2634 }
2635
2636 _tzpath_find_tzfile =
2637 PyObject_GetAttrString(_tzpath_module, "find_tzfile");
2638 Py_DECREF(_tzpath_module);
2639 if (_tzpath_find_tzfile == NULL) {
2640 goto error;
2641 }
2642
2643 PyObject *io_module = PyImport_ImportModule("io");
2644 if (io_module == NULL) {
2645 goto error;
2646 }
2647
2648 io_open = PyObject_GetAttrString(io_module, "open");
2649 Py_DECREF(io_module);
2650 if (io_open == NULL) {
2651 goto error;
2652 }
2653
2654 _common_mod = PyImport_ImportModule("zoneinfo._common");
2655 if (_common_mod == NULL) {
2656 goto error;
2657 }
2658
2659 if (NO_TTINFO.utcoff == NULL) {
2660 NO_TTINFO.utcoff = Py_None;
2661 NO_TTINFO.dstoff = Py_None;
2662 NO_TTINFO.tzname = Py_None;
2663
2664 for (size_t i = 0; i < 3; ++i) {
2665 Py_INCREF(Py_None);
2666 }
2667 }
2668
2669 if (initialize_caches()) {
2670 goto error;
2671 }
2672
2673 return 0;
2674
2675error:
2676 return -1;
2677}
2678
2679static PyModuleDef_Slot zoneinfomodule_slots[] = {
2680 {Py_mod_exec, zoneinfomodule_exec}, {0, NULL}};
2681
2682static struct PyModuleDef zoneinfomodule = {
2683 PyModuleDef_HEAD_INIT,
2684 .m_name = "_zoneinfo",
2685 .m_doc = "C implementation of the zoneinfo module",
2686 .m_size = 0,
2687 .m_methods = module_methods,
2688 .m_slots = zoneinfomodule_slots,
2689 .m_free = (freefunc)module_free};
2690
2691PyMODINIT_FUNC
2692PyInit__zoneinfo(void)
2693{
2694 return PyModuleDef_Init(&zoneinfomodule);
2695}