blob: cd287f595b14786f958eed3f78b197139915dfc7 [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* Time module */
2
Barry Warsaw9a2a8a81996-12-06 23:32:14 +00003#include "Python.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +00004
Guido van Rossum87ce7bb1998-06-09 16:30:31 +00005#include <ctype.h>
6
Victor Stinnerec895392012-04-29 02:41:27 +02007#ifdef HAVE_SYS_TIMES_H
8#include <sys/times.h>
9#endif
10
Thomas Wouters0e3f5912006-08-11 14:57:12 +000011#ifdef HAVE_SYS_TYPES_H
Guido van Rossumb6775db1994-08-01 11:34:53 +000012#include <sys/types.h>
Victor Stinnerec895392012-04-29 02:41:27 +020013#endif
14
15#if defined(HAVE_SYS_RESOURCE_H)
16#include <sys/resource.h>
17#endif
Guido van Rossum6d946f91992-08-14 13:49:30 +000018
Guido van Rossumb6775db1994-08-01 11:34:53 +000019#ifdef QUICKWIN
20#include <io.h>
21#endif
22
pdoxe14679c2017-10-05 00:01:56 -070023#if defined(HAVE_PTHREAD_H)
24# include <pthread.h>
25#endif
26
Guido van Rossum7bf22de1997-12-02 20:34:19 +000027#if defined(__WATCOMC__) && !defined(__QNX__)
Guido van Rossumbceeac81996-05-23 22:53:47 +000028#include <i86.h>
29#else
Guido van Rossumcac6c721996-09-06 13:34:02 +000030#ifdef MS_WINDOWS
Mark Hammond975e3922002-07-16 01:29:19 +000031#define WIN32_LEAN_AND_MEAN
Guido van Rossum258ccd42001-03-02 06:53:29 +000032#include <windows.h>
Mark Hammond975e3922002-07-16 01:29:19 +000033#include "pythread.h"
Guido van Rossumcac6c721996-09-06 13:34:02 +000034#endif /* MS_WINDOWS */
Guido van Rossum7bf22de1997-12-02 20:34:19 +000035#endif /* !__WATCOMC__ || __QNX__ */
Guido van Rossum234f9421993-06-17 12:35:49 +000036
Victor Stinnerc29b5852017-11-02 07:28:27 -070037#define SEC_TO_NS (1000 * 1000 * 1000)
38
Guido van Rossum234f9421993-06-17 12:35:49 +000039/* Forward declarations */
Victor Stinnercb29f012015-03-27 13:31:18 +010040static int pysleep(_PyTime_t);
Victor Stinnerec895392012-04-29 02:41:27 +020041
Victor Stinner85fdfa82012-01-27 00:38:48 +010042
Victor Stinnera997c7b2017-10-10 02:51:50 -070043static PyObject*
44_PyFloat_FromPyTime(_PyTime_t t)
45{
46 double d = _PyTime_AsSecondsDouble(t);
47 return PyFloat_FromDouble(d);
48}
49
Victor Stinnerc29b5852017-11-02 07:28:27 -070050
Victor Stinner4195b5c2012-02-08 23:03:19 +010051static PyObject *
Victor Stinnerc29b5852017-11-02 07:28:27 -070052time_time(PyObject *self, PyObject *unused)
Victor Stinner85fdfa82012-01-27 00:38:48 +010053{
Victor Stinnerc29b5852017-11-02 07:28:27 -070054 _PyTime_t t = _PyTime_GetSystemClock();
55 return _PyFloat_FromPyTime(t);
56}
57
58
59PyDoc_STRVAR(time_doc,
60"time() -> floating point number\n\
61\n\
62Return the current time in seconds since the Epoch.\n\
63Fractions of a second may be present if the system clock provides them.");
64
65static PyObject *
66time_time_ns(PyObject *self, PyObject *unused)
67{
68 _PyTime_t t = _PyTime_GetSystemClock();
69 return _PyTime_AsNanosecondsObject(t);
70}
71
72PyDoc_STRVAR(time_ns_doc,
73"time_ns() -> int\n\
74\n\
75Return the current time in nanoseconds since the Epoch.");
76
77#if defined(HAVE_CLOCK)
78
79#ifndef CLOCKS_PER_SEC
80# ifdef CLK_TCK
81# define CLOCKS_PER_SEC CLK_TCK
82# else
83# define CLOCKS_PER_SEC 1000000
84# endif
85#endif
86
87static int
88_PyTime_GetClockWithInfo(_PyTime_t *tp, _Py_clock_info_t *info)
89{
90 static int initialized = 0;
91 clock_t ticks;
92
93 if (!initialized) {
94 initialized = 1;
95
96 /* must sure that _PyTime_MulDiv(ticks, SEC_TO_NS, CLOCKS_PER_SEC)
97 above cannot overflow */
98 if ((_PyTime_t)CLOCKS_PER_SEC > _PyTime_MAX / SEC_TO_NS) {
99 PyErr_SetString(PyExc_OverflowError,
100 "CLOCKS_PER_SEC is too large");
101 return -1;
102 }
Victor Stinner85fdfa82012-01-27 00:38:48 +0100103 }
Victor Stinnerc29b5852017-11-02 07:28:27 -0700104
Victor Stinnerec895392012-04-29 02:41:27 +0200105 if (info) {
106 info->implementation = "clock()";
107 info->resolution = 1.0 / (double)CLOCKS_PER_SEC;
Benjamin Peterson49a69e42012-05-01 09:38:34 -0400108 info->monotonic = 1;
Victor Stinner2b89fdf2012-06-12 22:46:37 +0200109 info->adjustable = 0;
Victor Stinnerec895392012-04-29 02:41:27 +0200110 }
Victor Stinnerc29b5852017-11-02 07:28:27 -0700111
112 ticks = clock();
113 if (ticks == (clock_t)-1) {
114 PyErr_SetString(PyExc_RuntimeError,
115 "the processor time used is not available "
116 "or its value cannot be represented");
117 return -1;
118 }
119 *tp = _PyTime_MulDiv(ticks, SEC_TO_NS, (_PyTime_t)CLOCKS_PER_SEC);
120 return 0;
Victor Stinner85fdfa82012-01-27 00:38:48 +0100121}
122#endif /* HAVE_CLOCK */
123
Victor Stinnercba9a0c2017-10-12 08:51:56 -0700124static PyObject*
125perf_counter(_Py_clock_info_t *info)
126{
Victor Stinnerbdaeb7d2017-10-16 08:44:31 -0700127 _PyTime_t t;
128 if (_PyTime_GetPerfCounterWithInfo(&t, info) < 0) {
Victor Stinnercba9a0c2017-10-12 08:51:56 -0700129 return NULL;
130 }
Victor Stinnerc29b5852017-11-02 07:28:27 -0700131 return _PyFloat_FromPyTime(t);
Victor Stinnercba9a0c2017-10-12 08:51:56 -0700132}
133
Victor Stinnera997c7b2017-10-10 02:51:50 -0700134#if defined(MS_WINDOWS) || defined(HAVE_CLOCK)
Victor Stinnerec895392012-04-29 02:41:27 +0200135#define PYCLOCK
136static PyObject*
137pyclock(_Py_clock_info_t *info)
138{
Victor Stinner884d13a2017-10-17 14:46:45 -0700139 if (PyErr_WarnEx(PyExc_DeprecationWarning,
140 "time.clock has been deprecated in Python 3.3 and will "
141 "be removed from Python 3.8: "
142 "use time.perf_counter or time.process_time "
143 "instead", 1) < 0) {
144 return NULL;
145 }
Victor Stinnerc29b5852017-11-02 07:28:27 -0700146
Victor Stinnera997c7b2017-10-10 02:51:50 -0700147#ifdef MS_WINDOWS
Victor Stinnercba9a0c2017-10-12 08:51:56 -0700148 return perf_counter(info);
Victor Stinner54884492014-08-29 16:51:33 +0200149#else
Victor Stinnerc29b5852017-11-02 07:28:27 -0700150 _PyTime_t t;
151 if (_PyTime_GetClockWithInfo(&t, info) < 0) {
152 return NULL;
153 }
154 return _PyFloat_FromPyTime(t);
Victor Stinner54884492014-08-29 16:51:33 +0200155#endif
Victor Stinnerec895392012-04-29 02:41:27 +0200156}
157
Victor Stinner9122fdd2011-07-04 13:55:40 +0200158static PyObject *
Victor Stinner4195b5c2012-02-08 23:03:19 +0100159time_clock(PyObject *self, PyObject *unused)
Victor Stinner9122fdd2011-07-04 13:55:40 +0200160{
Victor Stinnerec895392012-04-29 02:41:27 +0200161 return pyclock(NULL);
Victor Stinner9122fdd2011-07-04 13:55:40 +0200162}
Victor Stinner9122fdd2011-07-04 13:55:40 +0200163
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000164PyDoc_STRVAR(clock_doc,
Victor Stinner4195b5c2012-02-08 23:03:19 +0100165"clock() -> floating point number\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000166\n\
167Return the CPU time or real time since the start of the process or since\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000168the first call to clock(). This has as much precision as the system\n\
169records.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000170#endif
171
Victor Stinnere0be4232011-10-25 13:06:09 +0200172#ifdef HAVE_CLOCK_GETTIME
173static PyObject *
Victor Stinner4195b5c2012-02-08 23:03:19 +0100174time_clock_gettime(PyObject *self, PyObject *args)
Victor Stinnere0be4232011-10-25 13:06:09 +0200175{
176 int ret;
Victor Stinnerb8d01692012-04-13 23:44:05 +0200177 int clk_id;
Victor Stinnere0be4232011-10-25 13:06:09 +0200178 struct timespec tp;
179
Victor Stinnerc29b5852017-11-02 07:28:27 -0700180 if (!PyArg_ParseTuple(args, "i:clock_gettime", &clk_id)) {
Victor Stinnere0be4232011-10-25 13:06:09 +0200181 return NULL;
Victor Stinnerc29b5852017-11-02 07:28:27 -0700182 }
Victor Stinnere0be4232011-10-25 13:06:09 +0200183
184 ret = clock_gettime((clockid_t)clk_id, &tp);
Antoine Pitrou2c085602012-01-18 01:41:44 +0100185 if (ret != 0) {
Victor Stinnera734af32014-07-31 13:07:17 +0200186 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrou2c085602012-01-18 01:41:44 +0100187 return NULL;
188 }
Victor Stinner4195b5c2012-02-08 23:03:19 +0100189 return PyFloat_FromDouble(tp.tv_sec + tp.tv_nsec * 1e-9);
Victor Stinnere0be4232011-10-25 13:06:09 +0200190}
191
192PyDoc_STRVAR(clock_gettime_doc,
Victor Stinnerc29b5852017-11-02 07:28:27 -0700193"clock_gettime(clk_id) -> float\n\
Victor Stinnere0be4232011-10-25 13:06:09 +0200194\n\
195Return the time of the specified clock clk_id.");
Victor Stinnerc29b5852017-11-02 07:28:27 -0700196
197static PyObject *
198time_clock_gettime_ns(PyObject *self, PyObject *args)
199{
200 int ret;
201 int clk_id;
202 struct timespec ts;
203 _PyTime_t t;
204
205 if (!PyArg_ParseTuple(args, "i:clock_gettime", &clk_id)) {
206 return NULL;
207 }
208
209 ret = clock_gettime((clockid_t)clk_id, &ts);
210 if (ret != 0) {
211 PyErr_SetFromErrno(PyExc_OSError);
212 return NULL;
213 }
214 if (_PyTime_FromTimespec(&t, &ts) < 0) {
215 return NULL;
216 }
217 return _PyTime_AsNanosecondsObject(t);
218}
219
220PyDoc_STRVAR(clock_gettime_ns_doc,
221"clock_gettime_ns(clk_id) -> int\n\
222\n\
223Return the time of the specified clock clk_id as nanoseconds.");
Benjamin Peterson37098cd2016-09-13 22:55:09 -0700224#endif /* HAVE_CLOCK_GETTIME */
Victor Stinner30d79472012-04-03 00:45:07 +0200225
Benjamin Peterson37098cd2016-09-13 22:55:09 -0700226#ifdef HAVE_CLOCK_SETTIME
Victor Stinner30d79472012-04-03 00:45:07 +0200227static PyObject *
228time_clock_settime(PyObject *self, PyObject *args)
229{
Victor Stinnerb8d01692012-04-13 23:44:05 +0200230 int clk_id;
Victor Stinner30d79472012-04-03 00:45:07 +0200231 PyObject *obj;
Victor Stinnerb3b45442015-03-28 04:09:41 +0100232 _PyTime_t t;
Victor Stinner30d79472012-04-03 00:45:07 +0200233 struct timespec tp;
234 int ret;
235
236 if (!PyArg_ParseTuple(args, "iO:clock_settime", &clk_id, &obj))
237 return NULL;
238
Victor Stinner02937aa2015-03-28 05:02:39 +0100239 if (_PyTime_FromSecondsObject(&t, obj, _PyTime_ROUND_FLOOR) < 0)
Victor Stinner30d79472012-04-03 00:45:07 +0200240 return NULL;
Victor Stinnerb3b45442015-03-28 04:09:41 +0100241
242 if (_PyTime_AsTimespec(t, &tp) == -1)
243 return NULL;
Victor Stinner30d79472012-04-03 00:45:07 +0200244
245 ret = clock_settime((clockid_t)clk_id, &tp);
246 if (ret != 0) {
Victor Stinnera734af32014-07-31 13:07:17 +0200247 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinner30d79472012-04-03 00:45:07 +0200248 return NULL;
249 }
250 Py_RETURN_NONE;
251}
252
253PyDoc_STRVAR(clock_settime_doc,
254"clock_settime(clk_id, time)\n\
255\n\
256Set the time of the specified clock clk_id.");
Victor Stinnerc29b5852017-11-02 07:28:27 -0700257
258static PyObject *
259time_clock_settime_ns(PyObject *self, PyObject *args)
260{
261 int clk_id;
262 PyObject *obj;
263 _PyTime_t t;
264 struct timespec ts;
265 int ret;
266
267 if (!PyArg_ParseTuple(args, "iO:clock_settime", &clk_id, &obj)) {
268 return NULL;
269 }
270
271 if (_PyTime_FromNanosecondsObject(&t, obj) < 0) {
272 return NULL;
273 }
274 if (_PyTime_AsTimespec(t, &ts) == -1) {
275 return NULL;
276 }
277
278 ret = clock_settime((clockid_t)clk_id, &ts);
279 if (ret != 0) {
280 PyErr_SetFromErrno(PyExc_OSError);
281 return NULL;
282 }
283 Py_RETURN_NONE;
284}
285
286PyDoc_STRVAR(clock_settime_ns_doc,
287"clock_settime_ns(clk_id, time)\n\
288\n\
289Set the time of the specified clock clk_id with nanoseconds.");
Benjamin Peterson37098cd2016-09-13 22:55:09 -0700290#endif /* HAVE_CLOCK_SETTIME */
Victor Stinnere0be4232011-10-25 13:06:09 +0200291
Benjamin Peterson37098cd2016-09-13 22:55:09 -0700292#ifdef HAVE_CLOCK_GETRES
Victor Stinnere0be4232011-10-25 13:06:09 +0200293static PyObject *
Victor Stinner4195b5c2012-02-08 23:03:19 +0100294time_clock_getres(PyObject *self, PyObject *args)
Victor Stinnere0be4232011-10-25 13:06:09 +0200295{
296 int ret;
Victor Stinnerb8d01692012-04-13 23:44:05 +0200297 int clk_id;
Victor Stinnere0be4232011-10-25 13:06:09 +0200298 struct timespec tp;
299
Victor Stinner4195b5c2012-02-08 23:03:19 +0100300 if (!PyArg_ParseTuple(args, "i:clock_getres", &clk_id))
Victor Stinnere0be4232011-10-25 13:06:09 +0200301 return NULL;
302
303 ret = clock_getres((clockid_t)clk_id, &tp);
Antoine Pitrou2c085602012-01-18 01:41:44 +0100304 if (ret != 0) {
Victor Stinnera734af32014-07-31 13:07:17 +0200305 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrou2c085602012-01-18 01:41:44 +0100306 return NULL;
307 }
Victor Stinner4195b5c2012-02-08 23:03:19 +0100308
309 return PyFloat_FromDouble(tp.tv_sec + tp.tv_nsec * 1e-9);
Victor Stinnere0be4232011-10-25 13:06:09 +0200310}
311
312PyDoc_STRVAR(clock_getres_doc,
Victor Stinner4195b5c2012-02-08 23:03:19 +0100313"clock_getres(clk_id) -> floating point number\n\
Victor Stinnere0be4232011-10-25 13:06:09 +0200314\n\
315Return the resolution (precision) of the specified clock clk_id.");
Benjamin Peterson37098cd2016-09-13 22:55:09 -0700316#endif /* HAVE_CLOCK_GETRES */
Victor Stinnere0be4232011-10-25 13:06:09 +0200317
pdoxe14679c2017-10-05 00:01:56 -0700318#ifdef HAVE_PTHREAD_GETCPUCLOCKID
319static PyObject *
320time_pthread_getcpuclockid(PyObject *self, PyObject *args)
321{
322 unsigned long thread_id;
323 int err;
324 clockid_t clk_id;
325 if (!PyArg_ParseTuple(args, "k:pthread_getcpuclockid", &thread_id)) {
326 return NULL;
327 }
328 err = pthread_getcpuclockid((pthread_t)thread_id, &clk_id);
329 if (err) {
330 errno = err;
331 PyErr_SetFromErrno(PyExc_OSError);
332 return NULL;
333 }
334 return PyLong_FromLong(clk_id);
335}
336
337PyDoc_STRVAR(pthread_getcpuclockid_doc,
338"pthread_getcpuclockid(thread_id) -> int\n\
339\n\
340Return the clk_id of a thread's CPU time clock.");
341#endif /* HAVE_PTHREAD_GETCPUCLOCKID */
342
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000343static PyObject *
Victor Stinnercb29f012015-03-27 13:31:18 +0100344time_sleep(PyObject *self, PyObject *obj)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000345{
Victor Stinnercb29f012015-03-27 13:31:18 +0100346 _PyTime_t secs;
Pablo Galindo59af94f2017-10-18 08:13:09 +0100347 if (_PyTime_FromSecondsObject(&secs, obj, _PyTime_ROUND_TIMEOUT))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000348 return NULL;
Victor Stinner7f53a502011-07-05 22:00:25 +0200349 if (secs < 0) {
350 PyErr_SetString(PyExc_ValueError,
351 "sleep length must be non-negative");
352 return NULL;
353 }
Victor Stinnercb29f012015-03-27 13:31:18 +0100354 if (pysleep(secs) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000355 return NULL;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200356 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000357}
358
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000359PyDoc_STRVAR(sleep_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000360"sleep(seconds)\n\
361\n\
362Delay execution for a given number of seconds. The argument may be\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000363a floating point number for subsecond precision.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000364
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000365static PyStructSequence_Field struct_time_type_fields[] = {
Alexander Belopolsky69f3fd02010-06-05 15:04:51 +0000366 {"tm_year", "year, for example, 1993"},
367 {"tm_mon", "month of year, range [1, 12]"},
368 {"tm_mday", "day of month, range [1, 31]"},
369 {"tm_hour", "hours, range [0, 23]"},
370 {"tm_min", "minutes, range [0, 59]"},
371 {"tm_sec", "seconds, range [0, 61])"},
372 {"tm_wday", "day of week, range [0, 6], Monday is 0"},
373 {"tm_yday", "day of year, range [1, 366]"},
374 {"tm_isdst", "1 if summer time is in effect, 0 if not, and -1 if unknown"},
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400375 {"tm_zone", "abbreviation of timezone name"},
376 {"tm_gmtoff", "offset from UTC in seconds"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000378};
379
380static PyStructSequence_Desc struct_time_type_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000381 "time.struct_time",
Alexander Belopolsky69f3fd02010-06-05 15:04:51 +0000382 "The time value as returned by gmtime(), localtime(), and strptime(), and\n"
383 " accepted by asctime(), mktime() and strftime(). May be considered as a\n"
384 " sequence of 9 integers.\n\n"
385 " Note that several fields' values are not the same as those defined by\n"
386 " the C language standard for struct tm. For example, the value of the\n"
387 " field tm_year is the actual year, not year - 1900. See individual\n"
388 " fields' descriptions for details.",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 struct_time_type_fields,
390 9,
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000391};
Tim Peters9ad4b682002-02-13 05:14:18 +0000392
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000393static int initialized;
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000394static PyTypeObject StructTimeType;
395
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400396
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000397static PyObject *
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -0400398tmtotuple(struct tm *p
399#ifndef HAVE_STRUCT_TM_TM_ZONE
Victor Stinner0d659e52017-04-25 01:22:42 +0200400 , const char *zone, time_t gmtoff
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -0400401#endif
402)
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000403{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 PyObject *v = PyStructSequence_New(&StructTimeType);
405 if (v == NULL)
406 return NULL;
Tim Peters9ad4b682002-02-13 05:14:18 +0000407
Christian Heimes217cfd12007-12-02 14:31:20 +0000408#define SET(i,val) PyStructSequence_SET_ITEM(v, i, PyLong_FromLong((long) val))
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000409
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000410 SET(0, p->tm_year + 1900);
411 SET(1, p->tm_mon + 1); /* Want January == 1 */
412 SET(2, p->tm_mday);
413 SET(3, p->tm_hour);
414 SET(4, p->tm_min);
415 SET(5, p->tm_sec);
416 SET(6, (p->tm_wday + 6) % 7); /* Want Monday == 0 */
417 SET(7, p->tm_yday + 1); /* Want January, 1 == 1 */
418 SET(8, p->tm_isdst);
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400419#ifdef HAVE_STRUCT_TM_TM_ZONE
420 PyStructSequence_SET_ITEM(v, 9,
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100421 PyUnicode_DecodeLocale(p->tm_zone, "surrogateescape"));
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400422 SET(10, p->tm_gmtoff);
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -0400423#else
424 PyStructSequence_SET_ITEM(v, 9,
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100425 PyUnicode_DecodeLocale(zone, "surrogateescape"));
Victor Stinner0d659e52017-04-25 01:22:42 +0200426 PyStructSequence_SET_ITEM(v, 10, _PyLong_FromTime_t(gmtoff));
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400427#endif /* HAVE_STRUCT_TM_TM_ZONE */
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000428#undef SET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 if (PyErr_Occurred()) {
430 Py_XDECREF(v);
431 return NULL;
432 }
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000434 return v;
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000435}
436
Fred Drakef901abd2004-08-03 17:58:55 +0000437/* Parse arg tuple that can contain an optional float-or-None value;
438 format needs to be "|O:name".
439 Returns non-zero on success (parallels PyArg_ParseTuple).
440*/
441static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200442parse_time_t_args(PyObject *args, const char *format, time_t *pwhen)
Fred Drakef901abd2004-08-03 17:58:55 +0000443{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 PyObject *ot = NULL;
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100445 time_t whent;
Fred Drakef901abd2004-08-03 17:58:55 +0000446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000447 if (!PyArg_ParseTuple(args, format, &ot))
448 return 0;
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100449 if (ot == NULL || ot == Py_None) {
450 whent = time(NULL);
451 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000452 else {
Victor Stinner02937aa2015-03-28 05:02:39 +0100453 if (_PyTime_ObjectToTime_t(ot, &whent, _PyTime_ROUND_FLOOR) == -1)
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100454 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000455 }
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100456 *pwhen = whent;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000457 return 1;
Fred Drakef901abd2004-08-03 17:58:55 +0000458}
459
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000460static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000461time_gmtime(PyObject *self, PyObject *args)
Guido van Rossum234f9421993-06-17 12:35:49 +0000462{
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100463 time_t when;
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -0400464 struct tm buf;
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100465
466 if (!parse_time_t_args(args, "|O:gmtime", &when))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000467 return NULL;
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100468
469 errno = 0;
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -0400470 if (_PyTime_gmtime(when, &buf) != 0)
471 return NULL;
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -0400472#ifdef HAVE_STRUCT_TM_TM_ZONE
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100473 return tmtotuple(&buf);
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -0400474#else
475 return tmtotuple(&buf, "UTC", 0);
476#endif
Guido van Rossum234f9421993-06-17 12:35:49 +0000477}
478
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -0400479#ifndef HAVE_TIMEGM
480static time_t
481timegm(struct tm *p)
482{
483 /* XXX: the following implementation will not work for tm_year < 1970.
484 but it is likely that platforms that don't have timegm do not support
485 negative timestamps anyways. */
486 return p->tm_sec + p->tm_min*60 + p->tm_hour*3600 + p->tm_yday*86400 +
487 (p->tm_year-70)*31536000 + ((p->tm_year-69)/4)*86400 -
488 ((p->tm_year-1)/100)*86400 + ((p->tm_year+299)/400)*86400;
489}
490#endif
491
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000492PyDoc_STRVAR(gmtime_doc,
Christian Heimes9a371592007-12-28 14:08:13 +0000493"gmtime([seconds]) -> (tm_year, tm_mon, tm_mday, tm_hour, tm_min,\n\
Fred Drake193a3f62002-03-12 21:38:49 +0000494 tm_sec, tm_wday, tm_yday, tm_isdst)\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000495\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000496Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.\n\
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400497GMT). When 'seconds' is not passed in, convert the current time instead.\n\
498\n\
499If the platform supports the tm_gmtoff and tm_zone, they are available as\n\
500attributes only.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000501
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000502static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000503time_localtime(PyObject *self, PyObject *args)
Guido van Rossum234f9421993-06-17 12:35:49 +0000504{
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100505 time_t when;
506 struct tm buf;
507
508 if (!parse_time_t_args(args, "|O:localtime", &when))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000509 return NULL;
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -0400510 if (_PyTime_localtime(when, &buf) != 0)
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100511 return NULL;
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -0400512#ifdef HAVE_STRUCT_TM_TM_ZONE
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100513 return tmtotuple(&buf);
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -0400514#else
515 {
516 struct tm local = buf;
517 char zone[100];
Victor Stinner0d659e52017-04-25 01:22:42 +0200518 time_t gmtoff;
Steve Dowerc3c6f712016-12-14 11:22:05 -0800519 strftime(zone, sizeof(zone), "%Z", &buf);
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -0400520 gmtoff = timegm(&buf) - when;
521 return tmtotuple(&local, zone, gmtoff);
522 }
523#endif
Guido van Rossum234f9421993-06-17 12:35:49 +0000524}
525
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000526PyDoc_STRVAR(localtime_doc,
Christian Heimes9a371592007-12-28 14:08:13 +0000527"localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,\n\
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 tm_sec,tm_wday,tm_yday,tm_isdst)\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000529\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000530Convert seconds since the Epoch to a time tuple expressing local time.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000531When 'seconds' is not passed in, convert the current time instead.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000532
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000533/* Convert 9-item tuple to tm structure. Return 1 on success, set
534 * an exception and return 0 on error.
535 */
Guido van Rossum9e90a671993-06-24 11:10:19 +0000536static int
Oren Milman1d1d3e92017-08-20 18:35:36 +0300537gettmarg(PyObject *args, struct tm *p, const char *format)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000538{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000539 int y;
Guido van Rossumcfbaecc1998-08-25 14:51:12 +0000540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000541 memset((void *) p, '\0', sizeof(struct tm));
Guido van Rossumb9081262007-08-25 03:14:09 +0000542
Alexander Belopolsky610e5442011-01-06 21:57:06 +0000543 if (!PyTuple_Check(args)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000544 PyErr_SetString(PyExc_TypeError,
545 "Tuple or struct_time argument required");
546 return 0;
547 }
Skip Montanaro41cfce92007-08-24 21:11:00 +0000548
Oren Milman1d1d3e92017-08-20 18:35:36 +0300549 if (!PyArg_ParseTuple(args, format,
Alexander Belopolsky610e5442011-01-06 21:57:06 +0000550 &y, &p->tm_mon, &p->tm_mday,
551 &p->tm_hour, &p->tm_min, &p->tm_sec,
552 &p->tm_wday, &p->tm_yday, &p->tm_isdst))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000553 return 0;
Miss Islington (bot)d5f017b2018-08-25 01:53:00 -0400554
555 if (y < INT_MIN + 1900) {
556 PyErr_SetString(PyExc_OverflowError, "year out of range");
557 return 0;
558 }
559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000560 p->tm_year = y - 1900;
561 p->tm_mon--;
562 p->tm_wday = (p->tm_wday + 1) % 7;
563 p->tm_yday--;
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400564#ifdef HAVE_STRUCT_TM_TM_ZONE
565 if (Py_TYPE(args) == &StructTimeType) {
566 PyObject *item;
567 item = PyTuple_GET_ITEM(args, 9);
Victor Stinner6e676952017-04-26 13:51:48 +0200568 p->tm_zone = item == Py_None ? NULL : (char*)PyUnicode_AsUTF8(item);
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400569 item = PyTuple_GET_ITEM(args, 10);
570 p->tm_gmtoff = item == Py_None ? 0 : PyLong_AsLong(item);
571 if (PyErr_Occurred())
572 return 0;
573 }
574#endif /* HAVE_STRUCT_TM_TM_ZONE */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 return 1;
Guido van Rossum9e90a671993-06-24 11:10:19 +0000576}
577
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000578/* Check values of the struct tm fields before it is passed to strftime() and
579 * asctime(). Return 1 if all values are valid, otherwise set an exception
580 * and returns 0.
581 */
Victor Stinneref128102010-10-07 01:00:52 +0000582static int
583checktm(struct tm* buf)
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000584{
Victor Stinneref128102010-10-07 01:00:52 +0000585 /* Checks added to make sure strftime() and asctime() does not crash Python by
586 indexing blindly into some array for a textual representation
587 by some bad index (fixes bug #897625 and #6608).
588
589 Also support values of zero from Python code for arguments in which
590 that is out of range by forcing that value to the lowest value that
591 is valid (fixed bug #1520914).
592
593 Valid ranges based on what is allowed in struct tm:
594
595 - tm_year: [0, max(int)] (1)
596 - tm_mon: [0, 11] (2)
597 - tm_mday: [1, 31]
598 - tm_hour: [0, 23]
599 - tm_min: [0, 59]
600 - tm_sec: [0, 60]
601 - tm_wday: [0, 6] (1)
602 - tm_yday: [0, 365] (2)
603 - tm_isdst: [-max(int), max(int)]
604
605 (1) gettmarg() handles bounds-checking.
606 (2) Python's acceptable range is one greater than the range in C,
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000607 thus need to check against automatic decrement by gettmarg().
608 */
609 if (buf->tm_mon == -1)
610 buf->tm_mon = 0;
611 else if (buf->tm_mon < 0 || buf->tm_mon > 11) {
612 PyErr_SetString(PyExc_ValueError, "month out of range");
613 return 0;
614 }
615 if (buf->tm_mday == 0)
616 buf->tm_mday = 1;
617 else if (buf->tm_mday < 0 || buf->tm_mday > 31) {
618 PyErr_SetString(PyExc_ValueError, "day of month out of range");
619 return 0;
620 }
621 if (buf->tm_hour < 0 || buf->tm_hour > 23) {
622 PyErr_SetString(PyExc_ValueError, "hour out of range");
623 return 0;
624 }
625 if (buf->tm_min < 0 || buf->tm_min > 59) {
626 PyErr_SetString(PyExc_ValueError, "minute out of range");
627 return 0;
628 }
629 if (buf->tm_sec < 0 || buf->tm_sec > 61) {
630 PyErr_SetString(PyExc_ValueError, "seconds out of range");
631 return 0;
632 }
633 /* tm_wday does not need checking of its upper-bound since taking
634 ``% 7`` in gettmarg() automatically restricts the range. */
635 if (buf->tm_wday < 0) {
636 PyErr_SetString(PyExc_ValueError, "day of week out of range");
637 return 0;
638 }
639 if (buf->tm_yday == -1)
640 buf->tm_yday = 0;
641 else if (buf->tm_yday < 0 || buf->tm_yday > 365) {
642 PyErr_SetString(PyExc_ValueError, "day of year out of range");
643 return 0;
644 }
645 return 1;
646}
647
Victor Stinnerc1f32ca2011-10-14 02:36:13 +0200648#ifdef MS_WINDOWS
649 /* wcsftime() doesn't format correctly time zones, see issue #10653 */
650# undef HAVE_WCSFTIME
651#endif
Alexander Belopolskycf774542012-10-02 18:39:16 -0400652#define STRFTIME_FORMAT_CODES \
653"Commonly used format codes:\n\
654\n\
655%Y Year with century as a decimal number.\n\
656%m Month as a decimal number [01,12].\n\
657%d Day of the month as a decimal number [01,31].\n\
658%H Hour (24-hour clock) as a decimal number [00,23].\n\
659%M Minute as a decimal number [00,59].\n\
660%S Second as a decimal number [00,61].\n\
661%z Time zone offset from UTC.\n\
662%a Locale's abbreviated weekday name.\n\
663%A Locale's full weekday name.\n\
664%b Locale's abbreviated month name.\n\
665%B Locale's full month name.\n\
666%c Locale's appropriate date and time representation.\n\
667%I Hour (12-hour clock) as a decimal number [01,12].\n\
668%p Locale's equivalent of either AM or PM.\n\
669\n\
670Other codes may be available on your platform. See documentation for\n\
671the C library strftime function.\n"
Victor Stinnerc1f32ca2011-10-14 02:36:13 +0200672
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000673#ifdef HAVE_STRFTIME
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000674#ifdef HAVE_WCSFTIME
675#define time_char wchar_t
676#define format_time wcsftime
677#define time_strlen wcslen
678#else
679#define time_char char
680#define format_time strftime
681#define time_strlen strlen
682#endif
683
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000684static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000685time_strftime(PyObject *self, PyObject *args)
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000686{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 PyObject *tup = NULL;
688 struct tm buf;
689 const time_char *fmt;
Victor Stinnerb2904782010-09-29 10:34:19 +0000690#ifdef HAVE_WCSFTIME
691 wchar_t *format;
692#else
693 PyObject *format;
694#endif
Victor Stinneref128102010-10-07 01:00:52 +0000695 PyObject *format_arg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000696 size_t fmtlen, buflen;
Victor Stinnerb2904782010-09-29 10:34:19 +0000697 time_char *outbuf = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000698 size_t i;
Victor Stinnerb2904782010-09-29 10:34:19 +0000699 PyObject *ret = NULL;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 memset((void *) &buf, '\0', sizeof(buf));
Guido van Rossum1f41f841998-04-27 19:04:26 +0000702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000703 /* Will always expect a unicode string to be passed as format.
704 Given that there's no str type anymore in py3k this seems safe.
705 */
Victor Stinneref128102010-10-07 01:00:52 +0000706 if (!PyArg_ParseTuple(args, "U|O:strftime", &format_arg, &tup))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000707 return NULL;
Thomas Woutersfe385252001-01-19 23:16:56 +0000708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 if (tup == NULL) {
710 time_t tt = time(NULL);
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -0400711 if (_PyTime_localtime(tt, &buf) != 0)
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100712 return NULL;
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000713 }
Oren Milman1d1d3e92017-08-20 18:35:36 +0300714 else if (!gettmarg(tup, &buf,
715 "iiiiiiiii;strftime(): illegal time tuple argument") ||
716 !checktm(&buf))
717 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 return NULL;
Oren Milman1d1d3e92017-08-20 18:35:36 +0300719 }
Guido van Rossum10b164a2001-09-25 13:59:01 +0000720
Victor Stinner36b82d82013-06-25 02:33:53 +0200721#if defined(_MSC_VER) || defined(sun) || defined(_AIX)
Victor Stinner73ea29c2011-01-08 01:56:31 +0000722 if (buf.tm_year + 1900 < 1 || 9999 < buf.tm_year + 1900) {
Victor Stinner6f0e4f92011-03-21 02:14:53 +0100723 PyErr_SetString(PyExc_ValueError,
724 "strftime() requires year in [1; 9999]");
Alexander Belopolsky0dd06f42011-01-08 01:23:02 +0000725 return NULL;
Alexander Belopolskyc64708a2011-01-07 19:59:19 +0000726 }
Victor Stinner73ea29c2011-01-08 01:56:31 +0000727#endif
Alexander Belopolskyc64708a2011-01-07 19:59:19 +0000728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 /* Normalize tm_isdst just in case someone foolishly implements %Z
730 based on the assumption that tm_isdst falls within the range of
731 [-1, 1] */
732 if (buf.tm_isdst < -1)
733 buf.tm_isdst = -1;
734 else if (buf.tm_isdst > 1)
735 buf.tm_isdst = 1;
Brett Cannond1080a32004-03-02 04:38:10 +0000736
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000737#ifdef HAVE_WCSFTIME
Victor Stinnerbeb4135b2010-10-07 01:02:42 +0000738 format = PyUnicode_AsWideCharString(format_arg, NULL);
Victor Stinnerb2904782010-09-29 10:34:19 +0000739 if (format == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 return NULL;
Victor Stinnerb2904782010-09-29 10:34:19 +0000741 fmt = format;
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000742#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000743 /* Convert the unicode string to an ascii one */
Victor Stinner1b579672011-12-17 05:47:23 +0100744 format = PyUnicode_EncodeLocale(format_arg, "surrogateescape");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 if (format == NULL)
746 return NULL;
747 fmt = PyBytes_AS_STRING(format);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000748#endif
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000749
Stefan Krah4aea7d32012-02-27 16:30:26 +0100750#if defined(MS_WINDOWS) && !defined(HAVE_WCSFTIME)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 /* check that the format string contains only valid directives */
Steve Dowere5b58952015-09-06 19:20:51 -0700752 for (outbuf = strchr(fmt, '%');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000753 outbuf != NULL;
Victor Stinner5a3ff792011-10-16 19:08:23 +0200754 outbuf = strchr(outbuf+2, '%'))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 {
Steve Dowere5b58952015-09-06 19:20:51 -0700756 if (outbuf[1] == '#')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000757 ++outbuf; /* not documented by python, */
Steve Dowere5b58952015-09-06 19:20:51 -0700758 if (outbuf[1] == '\0')
759 break;
760 if ((outbuf[1] == 'y') && buf.tm_year < 0) {
Tim Golden6e51b8f2013-11-12 12:36:54 +0000761 PyErr_SetString(PyExc_ValueError,
762 "format %y requires year >= 1900 on Windows");
763 Py_DECREF(format);
764 return NULL;
765 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000766 }
Victor Stinner93965f72013-11-23 14:59:33 +0100767#elif (defined(_AIX) || defined(sun)) && defined(HAVE_WCSFTIME)
Steve Dowere5b58952015-09-06 19:20:51 -0700768 for (outbuf = wcschr(fmt, '%');
Victor Stinner55329f82013-11-17 23:39:21 +0100769 outbuf != NULL;
770 outbuf = wcschr(outbuf+2, '%'))
771 {
Steve Dowere5b58952015-09-06 19:20:51 -0700772 if (outbuf[1] == L'\0')
773 break;
Victor Stinner55329f82013-11-17 23:39:21 +0100774 /* Issue #19634: On AIX, wcsftime("y", (1899, 1, 1, 0, 0, 0, 0, 0, 0))
775 returns "0/" instead of "99" */
776 if (outbuf[1] == L'y' && buf.tm_year < 0) {
777 PyErr_SetString(PyExc_ValueError,
778 "format %y requires year >= 1900 on AIX");
Miss Islington (bot)975f3cb2018-09-21 00:41:50 -0700779 PyMem_Free(format);
Victor Stinner55329f82013-11-17 23:39:21 +0100780 return NULL;
781 }
782 }
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000783#endif
784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 fmtlen = time_strlen(fmt);
Guido van Rossumc222ec21999-02-23 00:00:10 +0000786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 /* I hate these functions that presume you know how big the output
788 * will be ahead of time...
789 */
790 for (i = 1024; ; i += i) {
791 outbuf = (time_char *)PyMem_Malloc(i*sizeof(time_char));
792 if (outbuf == NULL) {
Victor Stinnerb2904782010-09-29 10:34:19 +0000793 PyErr_NoMemory();
794 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 }
Steve Dower57ab1cd2015-09-22 14:51:42 -0700796#if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__)
797 errno = 0;
798#endif
Steve Dowerd9ef74e2015-05-22 15:08:34 -0700799 _Py_BEGIN_SUPPRESS_IPH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000800 buflen = format_time(outbuf, i, fmt, &buf);
Steve Dowerd9ef74e2015-05-22 15:08:34 -0700801 _Py_END_SUPPRESS_IPH
Victor Stinner136ea492011-12-17 22:37:18 +0100802#if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__)
Steve Dower97cded92015-09-08 19:12:51 -0700803 /* VisualStudio .NET 2005 does this properly */
804 if (buflen == 0 && errno == EINVAL) {
805 PyErr_SetString(PyExc_ValueError, "Invalid format string");
806 PyMem_Free(outbuf);
807 break;
808 }
Victor Stinner136ea492011-12-17 22:37:18 +0100809#endif
Steve Dower97cded92015-09-08 19:12:51 -0700810 if (buflen > 0 || i >= 256 * fmtlen) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000811 /* If the buffer is 256 times as long as the format,
812 it's probably not failing for lack of room!
813 More likely, the format yields an empty result,
814 e.g. an empty format, or %Z when the timezone
815 is unknown. */
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000816#ifdef HAVE_WCSFTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 ret = PyUnicode_FromWideChar(outbuf, buflen);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000818#else
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100819 ret = PyUnicode_DecodeLocaleAndSize(outbuf, buflen, "surrogateescape");
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000820#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000821 PyMem_Free(outbuf);
Victor Stinnerb2904782010-09-29 10:34:19 +0000822 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 }
824 PyMem_Free(outbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000825 }
Victor Stinnerb2904782010-09-29 10:34:19 +0000826#ifdef HAVE_WCSFTIME
827 PyMem_Free(format);
828#else
829 Py_DECREF(format);
830#endif
831 return ret;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000832}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000833
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000834#undef time_char
835#undef format_time
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000836PyDoc_STRVAR(strftime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000837"strftime(format[, tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000838\n\
839Convert a time tuple to a string according to a format specification.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000840See the library reference manual for formatting codes. When the time tuple\n\
Alexander Belopolskycf774542012-10-02 18:39:16 -0400841is not present, current time as returned by localtime() is used.\n\
842\n" STRFTIME_FORMAT_CODES);
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000843#endif /* HAVE_STRFTIME */
844
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000845static PyObject *
846time_strptime(PyObject *self, PyObject *args)
847{
Victor Stinnerdbe28d22016-12-09 00:38:53 +0100848 PyObject *module, *func, *result;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200849 _Py_IDENTIFIER(_strptime_time);
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000850
Victor Stinnerdbe28d22016-12-09 00:38:53 +0100851 module = PyImport_ImportModuleNoBlock("_strptime");
852 if (!module)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 return NULL;
Victor Stinnerdbe28d22016-12-09 00:38:53 +0100854
855 func = _PyObject_GetAttrId(module, &PyId__strptime_time);
856 Py_DECREF(module);
857 if (!func) {
858 return NULL;
859 }
860
861 result = PyObject_Call(func, args, NULL);
862 Py_DECREF(func);
863 return result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000864}
865
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000866
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000867PyDoc_STRVAR(strptime_doc,
Brett Cannon20def8b2003-07-01 05:16:08 +0000868"strptime(string, format) -> struct_time\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000869\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000870Parse a string to a time tuple according to a format specification.\n\
Alexander Belopolskycf774542012-10-02 18:39:16 -0400871See the library reference manual for formatting codes (same as\n\
872strftime()).\n\
873\n" STRFTIME_FORMAT_CODES);
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000874
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000875static PyObject *
876_asctime(struct tm *timeptr)
877{
878 /* Inspired by Open Group reference implementation available at
879 * http://pubs.opengroup.org/onlinepubs/009695399/functions/asctime.html */
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200880 static const char wday_name[7][4] = {
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000881 "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
882 };
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200883 static const char mon_name[12][4] = {
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000884 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
885 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
886 };
Victor Stinner499dfcf2011-03-21 13:26:24 +0100887 return PyUnicode_FromFormat(
888 "%s %s%3d %.2d:%.2d:%.2d %d",
889 wday_name[timeptr->tm_wday],
890 mon_name[timeptr->tm_mon],
891 timeptr->tm_mday, timeptr->tm_hour,
892 timeptr->tm_min, timeptr->tm_sec,
893 1900 + timeptr->tm_year);
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000894}
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000895
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000896static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000897time_asctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000898{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000899 PyObject *tup = NULL;
900 struct tm buf;
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000901
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000902 if (!PyArg_UnpackTuple(args, "asctime", 0, 1, &tup))
903 return NULL;
904 if (tup == NULL) {
905 time_t tt = time(NULL);
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -0400906 if (_PyTime_localtime(tt, &buf) != 0)
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100907 return NULL;
Oren Milman1d1d3e92017-08-20 18:35:36 +0300908 }
909 else if (!gettmarg(tup, &buf,
910 "iiiiiiiii;asctime(): illegal time tuple argument") ||
911 !checktm(&buf))
912 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 return NULL;
Oren Milman1d1d3e92017-08-20 18:35:36 +0300914 }
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000915 return _asctime(&buf);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000916}
917
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000918PyDoc_STRVAR(asctime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000919"asctime([tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000920\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000921Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'.\n\
922When the time tuple is not present, current time as returned by localtime()\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000923is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000924
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000925static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000926time_ctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000927{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000928 time_t tt;
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100929 struct tm buf;
930 if (!parse_time_t_args(args, "|O:ctime", &tt))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000931 return NULL;
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -0400932 if (_PyTime_localtime(tt, &buf) != 0)
Alexander Belopolsky5da468f2011-01-04 17:15:52 +0000933 return NULL;
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100934 return _asctime(&buf);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000935}
936
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000937PyDoc_STRVAR(ctime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000938"ctime(seconds) -> string\n\
939\n\
940Convert a time in seconds since the Epoch to a string in local time.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000941This is equivalent to asctime(localtime(seconds)). When the time tuple is\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000942not present, current time as returned by localtime() is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000943
Guido van Rossum60cd8131998-03-06 17:16:21 +0000944#ifdef HAVE_MKTIME
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000945static PyObject *
Victor Stinner4195b5c2012-02-08 23:03:19 +0100946time_mktime(PyObject *self, PyObject *tup)
Guido van Rossum234f9421993-06-17 12:35:49 +0000947{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 struct tm buf;
949 time_t tt;
Oren Milman1d1d3e92017-08-20 18:35:36 +0300950 if (!gettmarg(tup, &buf,
951 "iiiiiiiii;mktime(): illegal time tuple argument"))
952 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000953 return NULL;
Oren Milman1d1d3e92017-08-20 18:35:36 +0300954 }
Victor Stinner1ac42612014-02-21 09:27:17 +0100955#ifdef _AIX
956 /* year < 1902 or year > 2037 */
957 if (buf.tm_year < 2 || buf.tm_year > 137) {
958 /* Issue #19748: On AIX, mktime() doesn't report overflow error for
959 * timestamp < -2^31 or timestamp > 2**31-1. */
960 PyErr_SetString(PyExc_OverflowError,
961 "mktime argument out of range");
962 return NULL;
963 }
964#else
Alexander Belopolskyb7d40d12011-01-11 01:21:25 +0000965 buf.tm_wday = -1; /* sentinel; original value ignored */
Victor Stinner1ac42612014-02-21 09:27:17 +0100966#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 tt = mktime(&buf);
Alexander Belopolskyb7d40d12011-01-11 01:21:25 +0000968 /* Return value of -1 does not necessarily mean an error, but tm_wday
Ezio Melotti13925002011-03-16 11:05:33 +0200969 * cannot remain set to -1 if mktime succeeded. */
Victor Stinner93037492013-06-25 22:54:35 +0200970 if (tt == (time_t)(-1)
971#ifndef _AIX
972 /* Return value of -1 does not necessarily mean an error, but
973 * tm_wday cannot remain set to -1 if mktime succeeded. */
974 && buf.tm_wday == -1
975#else
976 /* on AIX, tm_wday is always sets, even on error */
977#endif
978 )
979 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 PyErr_SetString(PyExc_OverflowError,
981 "mktime argument out of range");
982 return NULL;
983 }
Victor Stinner4195b5c2012-02-08 23:03:19 +0100984 return PyFloat_FromDouble((double)tt);
Guido van Rossum234f9421993-06-17 12:35:49 +0000985}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000986
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000987PyDoc_STRVAR(mktime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000988"mktime(tuple) -> floating point number\n\
989\n\
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400990Convert a time tuple in local time to seconds since the Epoch.\n\
991Note that mktime(gmtime(0)) will not generally return zero for most\n\
992time zones; instead the returned value will either be equal to that\n\
993of the timezone or altzone attributes on the time module.");
Guido van Rossum60cd8131998-03-06 17:16:21 +0000994#endif /* HAVE_MKTIME */
Guido van Rossum234f9421993-06-17 12:35:49 +0000995
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000996#ifdef HAVE_WORKING_TZSET
Martin v. Löwis1a214512008-06-11 05:26:20 +0000997static void PyInit_timezone(PyObject *module);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000998
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000999static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001000time_tzset(PyObject *self, PyObject *unused)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001001{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 PyObject* m;
Fred Drake9bb74322002-04-01 14:49:59 +00001003
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001004 m = PyImport_ImportModuleNoBlock("time");
1005 if (m == NULL) {
1006 return NULL;
1007 }
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001008
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 tzset();
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001010
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001011 /* Reset timezone, altzone, daylight and tzname */
1012 PyInit_timezone(m);
1013 Py_DECREF(m);
Victor Stinner2ff51b82013-07-17 21:42:45 +02001014 if (PyErr_Occurred())
1015 return NULL;
Tim Peters1b6f7a92004-06-20 02:50:16 +00001016
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001017 Py_RETURN_NONE;
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001018}
1019
1020PyDoc_STRVAR(tzset_doc,
R. David Murray4d55bf92010-12-14 00:55:46 +00001021"tzset()\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001022\n\
1023Initialize, or reinitialize, the local timezone to the value stored in\n\
1024os.environ['TZ']. The TZ environment variable should be specified in\n\
Neal Norwitzdc8e1942004-07-20 22:34:37 +00001025standard Unix timezone format as documented in the tzset man page\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001026(eg. 'US/Eastern', 'Europe/Amsterdam'). Unknown timezones will silently\n\
1027fall back to UTC. If the TZ environment variable is not set, the local\n\
1028timezone is set to the systems best guess of wallclock time.\n\
1029Changing the TZ environment variable without calling tzset *may* change\n\
1030the local timezone used by methods such as localtime, but this behaviour\n\
1031should not be relied on.");
1032#endif /* HAVE_WORKING_TZSET */
1033
Victor Stinnerae586492014-09-02 23:18:25 +02001034static PyObject *
Victor Stinnerec895392012-04-29 02:41:27 +02001035time_monotonic(PyObject *self, PyObject *unused)
Victor Stinner071eca32012-03-15 01:17:09 +01001036{
Victor Stinnerc29b5852017-11-02 07:28:27 -07001037 _PyTime_t t = _PyTime_GetMonotonicClock();
1038 return _PyFloat_FromPyTime(t);
Victor Stinner071eca32012-03-15 01:17:09 +01001039}
1040
Victor Stinnerec895392012-04-29 02:41:27 +02001041PyDoc_STRVAR(monotonic_doc,
1042"monotonic() -> float\n\
Victor Stinner8b302012012-02-07 23:29:46 +01001043\n\
Victor Stinnerec895392012-04-29 02:41:27 +02001044Monotonic clock, cannot go backward.");
Victor Stinnerec919cc2012-03-15 00:58:32 +01001045
Victor Stinnerec895392012-04-29 02:41:27 +02001046static PyObject *
Victor Stinnerc29b5852017-11-02 07:28:27 -07001047time_monotonic_ns(PyObject *self, PyObject *unused)
1048{
1049 _PyTime_t t = _PyTime_GetMonotonicClock();
1050 return _PyTime_AsNanosecondsObject(t);
1051}
1052
1053PyDoc_STRVAR(monotonic_ns_doc,
1054"monotonic_ns() -> int\n\
1055\n\
1056Monotonic clock, cannot go backward, as nanoseconds.");
1057
1058static PyObject *
Victor Stinnerec895392012-04-29 02:41:27 +02001059time_perf_counter(PyObject *self, PyObject *unused)
1060{
1061 return perf_counter(NULL);
1062}
1063
1064PyDoc_STRVAR(perf_counter_doc,
1065"perf_counter() -> float\n\
1066\n\
1067Performance counter for benchmarking.");
1068
Victor Stinnerc29b5852017-11-02 07:28:27 -07001069static PyObject *
1070time_perf_counter_ns(PyObject *self, PyObject *unused)
1071{
1072 _PyTime_t t = _PyTime_GetPerfCounter();
1073 return _PyTime_AsNanosecondsObject(t);
1074}
1075
1076PyDoc_STRVAR(perf_counter_ns_doc,
1077"perf_counter_ns() -> int\n\
1078\n\
1079Performance counter for benchmarking as nanoseconds.");
1080
1081static int
1082_PyTime_GetProcessTimeWithInfo(_PyTime_t *tp, _Py_clock_info_t *info)
Victor Stinnerec895392012-04-29 02:41:27 +02001083{
1084#if defined(MS_WINDOWS)
1085 HANDLE process;
1086 FILETIME creation_time, exit_time, kernel_time, user_time;
1087 ULARGE_INTEGER large;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001088 _PyTime_t ktime, utime, t;
Victor Stinnerec895392012-04-29 02:41:27 +02001089 BOOL ok;
1090
1091 process = GetCurrentProcess();
Victor Stinnerc29b5852017-11-02 07:28:27 -07001092 ok = GetProcessTimes(process, &creation_time, &exit_time,
1093 &kernel_time, &user_time);
1094 if (!ok) {
1095 PyErr_SetFromWindowsErr(0);
1096 return -1;
1097 }
Victor Stinnerec895392012-04-29 02:41:27 +02001098
Victor Stinnerec895392012-04-29 02:41:27 +02001099 if (info) {
1100 info->implementation = "GetProcessTimes()";
1101 info->resolution = 1e-7;
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001102 info->monotonic = 1;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001103 info->adjustable = 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001104 }
Victor Stinnerc29b5852017-11-02 07:28:27 -07001105
1106 large.u.LowPart = kernel_time.dwLowDateTime;
1107 large.u.HighPart = kernel_time.dwHighDateTime;
1108 ktime = large.QuadPart;
1109
1110 large.u.LowPart = user_time.dwLowDateTime;
1111 large.u.HighPart = user_time.dwHighDateTime;
1112 utime = large.QuadPart;
1113
1114 /* ktime and utime have a resolution of 100 nanoseconds */
1115 t = _PyTime_FromNanoseconds((ktime + utime) * 100);
1116 *tp = t;
1117 return 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001118#else
1119
Victor Stinnerc29b5852017-11-02 07:28:27 -07001120 /* clock_gettime */
Victor Stinnerec895392012-04-29 02:41:27 +02001121#if defined(HAVE_CLOCK_GETTIME) \
1122 && (defined(CLOCK_PROCESS_CPUTIME_ID) || defined(CLOCK_PROF))
Victor Stinnerc29b5852017-11-02 07:28:27 -07001123 struct timespec ts;
Victor Stinnerec895392012-04-29 02:41:27 +02001124#ifdef CLOCK_PROF
1125 const clockid_t clk_id = CLOCK_PROF;
1126 const char *function = "clock_gettime(CLOCK_PROF)";
1127#else
1128 const clockid_t clk_id = CLOCK_PROCESS_CPUTIME_ID;
1129 const char *function = "clock_gettime(CLOCK_PROCESS_CPUTIME_ID)";
1130#endif
1131
Victor Stinnerc29b5852017-11-02 07:28:27 -07001132 if (clock_gettime(clk_id, &ts) == 0) {
Victor Stinnerec895392012-04-29 02:41:27 +02001133 if (info) {
1134 struct timespec res;
1135 info->implementation = function;
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001136 info->monotonic = 1;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001137 info->adjustable = 0;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001138 if (clock_getres(clk_id, &res)) {
1139 PyErr_SetFromErrno(PyExc_OSError);
1140 return -1;
1141 }
1142 info->resolution = res.tv_sec + res.tv_nsec * 1e-9;
Victor Stinnerec895392012-04-29 02:41:27 +02001143 }
Victor Stinnerc29b5852017-11-02 07:28:27 -07001144
1145 if (_PyTime_FromTimespec(tp, &ts) < 0) {
1146 return -1;
1147 }
1148 return 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001149 }
1150#endif
1151
Victor Stinnerc29b5852017-11-02 07:28:27 -07001152 /* getrusage(RUSAGE_SELF) */
Victor Stinnerec895392012-04-29 02:41:27 +02001153#if defined(HAVE_SYS_RESOURCE_H)
Victor Stinnerc29b5852017-11-02 07:28:27 -07001154 struct rusage ru;
1155
Victor Stinnerec895392012-04-29 02:41:27 +02001156 if (getrusage(RUSAGE_SELF, &ru) == 0) {
Victor Stinnerc29b5852017-11-02 07:28:27 -07001157 _PyTime_t utime, stime;
1158
Victor Stinnerec895392012-04-29 02:41:27 +02001159 if (info) {
1160 info->implementation = "getrusage(RUSAGE_SELF)";
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001161 info->monotonic = 1;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001162 info->adjustable = 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001163 info->resolution = 1e-6;
1164 }
Victor Stinnerc29b5852017-11-02 07:28:27 -07001165
1166 if (_PyTime_FromTimeval(&utime, &ru.ru_utime) < 0) {
1167 return -1;
1168 }
1169 if (_PyTime_FromTimeval(&stime, &ru.ru_stime) < 0) {
1170 return -1;
1171 }
1172
1173 _PyTime_t total = utime + utime;
1174 *tp = total;
1175 return 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001176 }
1177#endif
1178
Victor Stinnerc29b5852017-11-02 07:28:27 -07001179 /* times() */
Victor Stinnerec895392012-04-29 02:41:27 +02001180#ifdef HAVE_TIMES
Victor Stinnerc29b5852017-11-02 07:28:27 -07001181 struct tms t;
1182
Victor Stinnerec895392012-04-29 02:41:27 +02001183 if (times(&t) != (clock_t)-1) {
Victor Stinnerc29b5852017-11-02 07:28:27 -07001184 static long ticks_per_second = -1;
Victor Stinnerec895392012-04-29 02:41:27 +02001185
1186 if (ticks_per_second == -1) {
Victor Stinnerc29b5852017-11-02 07:28:27 -07001187 long freq;
Victor Stinnerec895392012-04-29 02:41:27 +02001188#if defined(HAVE_SYSCONF) && defined(_SC_CLK_TCK)
Victor Stinnerc29b5852017-11-02 07:28:27 -07001189 freq = sysconf(_SC_CLK_TCK);
1190 if (freq < 1) {
1191 freq = -1;
1192 }
Victor Stinnerec895392012-04-29 02:41:27 +02001193#elif defined(HZ)
Victor Stinnerc29b5852017-11-02 07:28:27 -07001194 freq = HZ;
Victor Stinnerec895392012-04-29 02:41:27 +02001195#else
Victor Stinnerc29b5852017-11-02 07:28:27 -07001196 freq = 60; /* magic fallback value; may be bogus */
Victor Stinnerec895392012-04-29 02:41:27 +02001197#endif
Victor Stinnerc29b5852017-11-02 07:28:27 -07001198
1199 if (freq != -1) {
1200 /* check that _PyTime_MulDiv(t, SEC_TO_NS, ticks_per_second)
1201 cannot overflow below */
Miss Islington (bot)7df80492018-02-09 07:56:34 -08001202#if LONG_MAX > _PyTime_MAX / SEC_TO_NS
Victor Stinnerc29b5852017-11-02 07:28:27 -07001203 if ((_PyTime_t)freq > _PyTime_MAX / SEC_TO_NS) {
1204 PyErr_SetString(PyExc_OverflowError,
1205 "_SC_CLK_TCK is too large");
1206 return -1;
1207 }
Miss Islington (bot)7df80492018-02-09 07:56:34 -08001208#endif
Victor Stinnerc29b5852017-11-02 07:28:27 -07001209
1210 ticks_per_second = freq;
1211 }
Victor Stinnerec895392012-04-29 02:41:27 +02001212 }
1213
1214 if (ticks_per_second != -1) {
Victor Stinnerec895392012-04-29 02:41:27 +02001215 if (info) {
1216 info->implementation = "times()";
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001217 info->monotonic = 1;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001218 info->adjustable = 0;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001219 info->resolution = 1.0 / (double)ticks_per_second;
Victor Stinnerec895392012-04-29 02:41:27 +02001220 }
Victor Stinnerc29b5852017-11-02 07:28:27 -07001221
1222 _PyTime_t total;
1223 total = _PyTime_MulDiv(t.tms_utime, SEC_TO_NS, ticks_per_second);
1224 total += _PyTime_MulDiv(t.tms_stime, SEC_TO_NS, ticks_per_second);
1225 *tp = total;
1226 return 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001227 }
1228 }
1229#endif
1230
Victor Stinnerc29b5852017-11-02 07:28:27 -07001231 /* clock */
Victor Stinner53e22bf2016-07-08 17:55:01 +02001232 /* Currently, Python 3 requires clock() to build: see issue #22624 */
Victor Stinnerc29b5852017-11-02 07:28:27 -07001233 return _PyTime_GetClockWithInfo(tp, info);
Victor Stinnerec895392012-04-29 02:41:27 +02001234#endif
1235}
1236
1237static PyObject *
1238time_process_time(PyObject *self, PyObject *unused)
1239{
Victor Stinnerc29b5852017-11-02 07:28:27 -07001240 _PyTime_t t;
1241 if (_PyTime_GetProcessTimeWithInfo(&t, NULL) < 0) {
1242 return NULL;
1243 }
1244 return _PyFloat_FromPyTime(t);
Victor Stinnerec895392012-04-29 02:41:27 +02001245}
1246
1247PyDoc_STRVAR(process_time_doc,
1248"process_time() -> float\n\
1249\n\
1250Process time for profiling: sum of the kernel and user-space CPU time.");
1251
Victor Stinnerc29b5852017-11-02 07:28:27 -07001252static PyObject *
1253time_process_time_ns(PyObject *self, PyObject *unused)
1254{
1255 _PyTime_t t;
1256 if (_PyTime_GetProcessTimeWithInfo(&t, NULL) < 0) {
1257 return NULL;
1258 }
1259 return _PyTime_AsNanosecondsObject(t);
1260}
1261
1262PyDoc_STRVAR(process_time_ns_doc,
1263"process_time() -> int\n\
1264\n\
1265Process time for profiling as nanoseconds:\n\
1266sum of the kernel and user-space CPU time.");
1267
Victor Stinnerec895392012-04-29 02:41:27 +02001268
Antoine Pitrou4bd41c92017-11-15 22:52:21 +01001269#if defined(MS_WINDOWS)
1270#define HAVE_THREAD_TIME
1271static int
1272_PyTime_GetThreadTimeWithInfo(_PyTime_t *tp, _Py_clock_info_t *info)
1273{
1274 HANDLE thread;
1275 FILETIME creation_time, exit_time, kernel_time, user_time;
1276 ULARGE_INTEGER large;
1277 _PyTime_t ktime, utime, t;
1278 BOOL ok;
1279
1280 thread = GetCurrentThread();
1281 ok = GetThreadTimes(thread, &creation_time, &exit_time,
1282 &kernel_time, &user_time);
1283 if (!ok) {
1284 PyErr_SetFromWindowsErr(0);
1285 return -1;
1286 }
1287
1288 if (info) {
1289 info->implementation = "GetThreadTimes()";
1290 info->resolution = 1e-7;
1291 info->monotonic = 1;
1292 info->adjustable = 0;
1293 }
1294
1295 large.u.LowPart = kernel_time.dwLowDateTime;
1296 large.u.HighPart = kernel_time.dwHighDateTime;
1297 ktime = large.QuadPart;
1298
1299 large.u.LowPart = user_time.dwLowDateTime;
1300 large.u.HighPart = user_time.dwHighDateTime;
1301 utime = large.QuadPart;
1302
1303 /* ktime and utime have a resolution of 100 nanoseconds */
1304 t = _PyTime_FromNanoseconds((ktime + utime) * 100);
1305 *tp = t;
1306 return 0;
1307}
1308
1309#elif defined(HAVE_CLOCK_GETTIME) && defined(CLOCK_PROCESS_CPUTIME_ID)
1310#define HAVE_THREAD_TIME
1311static int
1312_PyTime_GetThreadTimeWithInfo(_PyTime_t *tp, _Py_clock_info_t *info)
1313{
1314 struct timespec ts;
1315 const clockid_t clk_id = CLOCK_THREAD_CPUTIME_ID;
1316 const char *function = "clock_gettime(CLOCK_THREAD_CPUTIME_ID)";
1317
1318 if (clock_gettime(clk_id, &ts)) {
1319 PyErr_SetFromErrno(PyExc_OSError);
1320 return -1;
1321 }
1322 if (info) {
1323 struct timespec res;
1324 info->implementation = function;
1325 info->monotonic = 1;
1326 info->adjustable = 0;
1327 if (clock_getres(clk_id, &res)) {
1328 PyErr_SetFromErrno(PyExc_OSError);
1329 return -1;
1330 }
1331 info->resolution = res.tv_sec + res.tv_nsec * 1e-9;
1332 }
1333
1334 if (_PyTime_FromTimespec(tp, &ts) < 0) {
1335 return -1;
1336 }
1337 return 0;
1338}
1339#endif
1340
1341#ifdef HAVE_THREAD_TIME
1342static PyObject *
1343time_thread_time(PyObject *self, PyObject *unused)
1344{
1345 _PyTime_t t;
1346 if (_PyTime_GetThreadTimeWithInfo(&t, NULL) < 0) {
1347 return NULL;
1348 }
1349 return _PyFloat_FromPyTime(t);
1350}
1351
1352PyDoc_STRVAR(thread_time_doc,
1353"thread_time() -> float\n\
1354\n\
1355Thread time for profiling: sum of the kernel and user-space CPU time.");
1356
1357static PyObject *
1358time_thread_time_ns(PyObject *self, PyObject *unused)
1359{
1360 _PyTime_t t;
1361 if (_PyTime_GetThreadTimeWithInfo(&t, NULL) < 0) {
1362 return NULL;
1363 }
1364 return _PyTime_AsNanosecondsObject(t);
1365}
1366
1367PyDoc_STRVAR(thread_time_ns_doc,
1368"thread_time() -> int\n\
1369\n\
1370Thread time for profiling as nanoseconds:\n\
1371sum of the kernel and user-space CPU time.");
1372#endif
1373
1374
Victor Stinnerec895392012-04-29 02:41:27 +02001375static PyObject *
1376time_get_clock_info(PyObject *self, PyObject *args)
1377{
1378 char *name;
Victor Stinnerec895392012-04-29 02:41:27 +02001379 _Py_clock_info_t info;
Victor Stinnerbda4b882012-06-12 22:11:44 +02001380 PyObject *obj = NULL, *dict, *ns;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001381 _PyTime_t t;
Victor Stinnerec895392012-04-29 02:41:27 +02001382
Victor Stinnerc29b5852017-11-02 07:28:27 -07001383 if (!PyArg_ParseTuple(args, "s:get_clock_info", &name)) {
Victor Stinnerec895392012-04-29 02:41:27 +02001384 return NULL;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001385 }
Victor Stinnerec895392012-04-29 02:41:27 +02001386
1387#ifdef Py_DEBUG
1388 info.implementation = NULL;
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001389 info.monotonic = -1;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001390 info.adjustable = -1;
Victor Stinnerec895392012-04-29 02:41:27 +02001391 info.resolution = -1.0;
1392#else
1393 info.implementation = "";
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001394 info.monotonic = 0;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001395 info.adjustable = 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001396 info.resolution = 1.0;
1397#endif
1398
Victor Stinnerc29b5852017-11-02 07:28:27 -07001399 if (strcmp(name, "time") == 0) {
1400 if (_PyTime_GetSystemClockWithInfo(&t, &info) < 0) {
1401 return NULL;
1402 }
1403 }
Victor Stinnerec895392012-04-29 02:41:27 +02001404#ifdef PYCLOCK
Victor Stinnerc29b5852017-11-02 07:28:27 -07001405 else if (strcmp(name, "clock") == 0) {
Victor Stinnerec895392012-04-29 02:41:27 +02001406 obj = pyclock(&info);
Victor Stinnerc29b5852017-11-02 07:28:27 -07001407 if (obj == NULL) {
1408 return NULL;
1409 }
1410 Py_DECREF(obj);
1411 }
Victor Stinnerec895392012-04-29 02:41:27 +02001412#endif
Victor Stinnerc29b5852017-11-02 07:28:27 -07001413 else if (strcmp(name, "monotonic") == 0) {
1414 if (_PyTime_GetMonotonicClockWithInfo(&t, &info) < 0) {
1415 return NULL;
1416 }
1417 }
1418 else if (strcmp(name, "perf_counter") == 0) {
1419 if (_PyTime_GetPerfCounterWithInfo(&t, &info) < 0) {
1420 return NULL;
1421 }
1422 }
1423 else if (strcmp(name, "process_time") == 0) {
1424 if (_PyTime_GetProcessTimeWithInfo(&t, &info) < 0) {
1425 return NULL;
1426 }
1427 }
Antoine Pitrou4bd41c92017-11-15 22:52:21 +01001428#ifdef HAVE_THREAD_TIME
1429 else if (strcmp(name, "thread_time") == 0) {
1430 if (_PyTime_GetThreadTimeWithInfo(&t, &info) < 0) {
1431 return NULL;
1432 }
1433 }
1434#endif
Victor Stinnerec895392012-04-29 02:41:27 +02001435 else {
1436 PyErr_SetString(PyExc_ValueError, "unknown clock");
1437 return NULL;
1438 }
Victor Stinnerec895392012-04-29 02:41:27 +02001439
Victor Stinnerbda4b882012-06-12 22:11:44 +02001440 dict = PyDict_New();
Victor Stinnerc29b5852017-11-02 07:28:27 -07001441 if (dict == NULL) {
Victor Stinnerec895392012-04-29 02:41:27 +02001442 return NULL;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001443 }
Victor Stinnerec895392012-04-29 02:41:27 +02001444
1445 assert(info.implementation != NULL);
1446 obj = PyUnicode_FromString(info.implementation);
Victor Stinnerc29b5852017-11-02 07:28:27 -07001447 if (obj == NULL) {
Victor Stinnerec895392012-04-29 02:41:27 +02001448 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001449 }
1450 if (PyDict_SetItemString(dict, "implementation", obj) == -1) {
Victor Stinnerbda4b882012-06-12 22:11:44 +02001451 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001452 }
Victor Stinnerbda4b882012-06-12 22:11:44 +02001453 Py_CLEAR(obj);
Victor Stinnerec895392012-04-29 02:41:27 +02001454
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001455 assert(info.monotonic != -1);
1456 obj = PyBool_FromLong(info.monotonic);
Victor Stinnerc29b5852017-11-02 07:28:27 -07001457 if (obj == NULL) {
Victor Stinnerec895392012-04-29 02:41:27 +02001458 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001459 }
1460 if (PyDict_SetItemString(dict, "monotonic", obj) == -1) {
Victor Stinnerbda4b882012-06-12 22:11:44 +02001461 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001462 }
Victor Stinnerbda4b882012-06-12 22:11:44 +02001463 Py_CLEAR(obj);
Victor Stinnerec895392012-04-29 02:41:27 +02001464
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001465 assert(info.adjustable != -1);
1466 obj = PyBool_FromLong(info.adjustable);
Victor Stinnerc29b5852017-11-02 07:28:27 -07001467 if (obj == NULL) {
Victor Stinnerec895392012-04-29 02:41:27 +02001468 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001469 }
1470 if (PyDict_SetItemString(dict, "adjustable", obj) == -1) {
Victor Stinnerbda4b882012-06-12 22:11:44 +02001471 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001472 }
Victor Stinnerbda4b882012-06-12 22:11:44 +02001473 Py_CLEAR(obj);
Victor Stinnerec895392012-04-29 02:41:27 +02001474
1475 assert(info.resolution > 0.0);
1476 assert(info.resolution <= 1.0);
1477 obj = PyFloat_FromDouble(info.resolution);
Victor Stinnerc29b5852017-11-02 07:28:27 -07001478 if (obj == NULL) {
Victor Stinnerec895392012-04-29 02:41:27 +02001479 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001480 }
1481 if (PyDict_SetItemString(dict, "resolution", obj) == -1) {
Victor Stinnerbda4b882012-06-12 22:11:44 +02001482 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001483 }
Victor Stinnerbda4b882012-06-12 22:11:44 +02001484 Py_CLEAR(obj);
Victor Stinnerec895392012-04-29 02:41:27 +02001485
Victor Stinnerbda4b882012-06-12 22:11:44 +02001486 ns = _PyNamespace_New(dict);
1487 Py_DECREF(dict);
1488 return ns;
Victor Stinnerec895392012-04-29 02:41:27 +02001489
1490error:
Victor Stinnerbda4b882012-06-12 22:11:44 +02001491 Py_DECREF(dict);
1492 Py_XDECREF(obj);
Victor Stinnerec895392012-04-29 02:41:27 +02001493 return NULL;
1494}
1495
1496PyDoc_STRVAR(get_clock_info_doc,
1497"get_clock_info(name: str) -> dict\n\
1498\n\
1499Get information of the specified clock.");
Victor Stinner8b302012012-02-07 23:29:46 +01001500
Victor Stinner8f5cdfa2017-04-20 13:41:09 +02001501#if !defined(HAVE_TZNAME) || defined(__GLIBC__) || defined(__CYGWIN__)
Martin v. Löwisd218dc12008-04-07 03:17:54 +00001502static void
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -04001503get_zone(char *zone, int n, struct tm *p)
1504{
1505#ifdef HAVE_STRUCT_TM_TM_ZONE
1506 strncpy(zone, p->tm_zone ? p->tm_zone : " ", n);
1507#else
1508 tzset();
1509 strftime(zone, n, "%Z", p);
1510#endif
1511}
1512
1513static int
1514get_gmtoff(time_t t, struct tm *p)
1515{
1516#ifdef HAVE_STRUCT_TM_TM_ZONE
1517 return p->tm_gmtoff;
1518#else
1519 return timegm(p) - t;
1520#endif
1521}
Victor Stinner8f5cdfa2017-04-20 13:41:09 +02001522#endif /* !defined(HAVE_TZNAME) || defined(__GLIBC__) || defined(__CYGWIN__) */
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -04001523
1524static void
Martin v. Löwis1a214512008-06-11 05:26:20 +00001525PyInit_timezone(PyObject *m) {
1526 /* This code moved from PyInit_time wholesale to allow calling it from
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001527 time_tzset. In the future, some parts of it can be moved back
1528 (for platforms that don't HAVE_WORKING_TZSET, when we know what they
1529 are), and the extraneous calls to tzset(3) should be removed.
1530 I haven't done this yet, as I don't want to change this code as
1531 little as possible when introducing the time.tzset and time.tzsetwall
1532 methods. This should simply be a method of doing the following once,
1533 at the top of this function and removing the call to tzset() from
1534 time_tzset():
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001535
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001536 #ifdef HAVE_TZSET
1537 tzset()
1538 #endif
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 And I'm lazy and hate C so nyer.
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001541 */
Guido van Rossum10b164a2001-09-25 13:59:01 +00001542#if defined(HAVE_TZNAME) && !defined(__GLIBC__) && !defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 PyObject *otz0, *otz1;
1544 tzset();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 PyModule_AddIntConstant(m, "timezone", timezone);
Guido van Rossumb6775db1994-08-01 11:34:53 +00001546#ifdef HAVE_ALTZONE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001547 PyModule_AddIntConstant(m, "altzone", altzone);
Guido van Rossumb6775db1994-08-01 11:34:53 +00001548#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 PyModule_AddIntConstant(m, "altzone", timezone-3600);
Guido van Rossumb6775db1994-08-01 11:34:53 +00001550#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001551 PyModule_AddIntConstant(m, "daylight", daylight);
Victor Stinner7ed7aea2018-01-15 10:45:49 +01001552 otz0 = PyUnicode_DecodeLocale(tzname[0], "surrogateescape");
1553 otz1 = PyUnicode_DecodeLocale(tzname[1], "surrogateescape");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001554 PyModule_AddObject(m, "tzname", Py_BuildValue("(NN)", otz0, otz1));
Guido van Rossum10b164a2001-09-25 13:59:01 +00001555#else /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001556 {
Guido van Rossum234f9421993-06-17 12:35:49 +00001557#define YEAR ((time_t)((365 * 24 + 6) * 3600))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 time_t t;
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04001559 struct tm p;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001560 long janzone, julyzone;
1561 char janname[10], julyname[10];
1562 t = (time((time_t *)0) / YEAR) * YEAR;
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04001563 _PyTime_localtime(t, &p);
1564 get_zone(janname, 9, &p);
1565 janzone = -get_gmtoff(t, &p);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001566 janname[9] = '\0';
1567 t += YEAR/2;
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04001568 _PyTime_localtime(t, &p);
1569 get_zone(julyname, 9, &p);
1570 julyzone = -get_gmtoff(t, &p);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 julyname[9] = '\0';
Guido van Rossum10b164a2001-09-25 13:59:01 +00001572
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 if( janzone < julyzone ) {
1574 /* DST is reversed in the southern hemisphere */
1575 PyModule_AddIntConstant(m, "timezone", julyzone);
1576 PyModule_AddIntConstant(m, "altzone", janzone);
1577 PyModule_AddIntConstant(m, "daylight",
1578 janzone != julyzone);
1579 PyModule_AddObject(m, "tzname",
1580 Py_BuildValue("(zz)",
1581 julyname, janname));
1582 } else {
1583 PyModule_AddIntConstant(m, "timezone", janzone);
1584 PyModule_AddIntConstant(m, "altzone", julyzone);
1585 PyModule_AddIntConstant(m, "daylight",
1586 janzone != julyzone);
1587 PyModule_AddObject(m, "tzname",
1588 Py_BuildValue("(zz)",
1589 janname, julyname));
1590 }
1591 }
Tim Peters26ae7cd2001-03-20 03:26:49 +00001592#ifdef __CYGWIN__
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 tzset();
1594 PyModule_AddIntConstant(m, "timezone", _timezone);
1595 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
1596 PyModule_AddIntConstant(m, "daylight", _daylight);
1597 PyModule_AddObject(m, "tzname",
1598 Py_BuildValue("(zz)", _tzname[0], _tzname[1]));
Tim Peters26ae7cd2001-03-20 03:26:49 +00001599#endif /* __CYGWIN__ */
Guido van Rossum10b164a2001-09-25 13:59:01 +00001600#endif /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001601}
1602
1603
1604static PyMethodDef time_methods[] = {
Victor Stinner4195b5c2012-02-08 23:03:19 +01001605 {"time", time_time, METH_NOARGS, time_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001606 {"time_ns", time_time_ns, METH_NOARGS, time_ns_doc},
Victor Stinnerec895392012-04-29 02:41:27 +02001607#ifdef PYCLOCK
Victor Stinner4195b5c2012-02-08 23:03:19 +01001608 {"clock", time_clock, METH_NOARGS, clock_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001609#endif
Victor Stinnere0be4232011-10-25 13:06:09 +02001610#ifdef HAVE_CLOCK_GETTIME
Victor Stinner4195b5c2012-02-08 23:03:19 +01001611 {"clock_gettime", time_clock_gettime, METH_VARARGS, clock_gettime_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001612 {"clock_gettime_ns",time_clock_gettime_ns, METH_VARARGS, clock_gettime_ns_doc},
Benjamin Peterson37098cd2016-09-13 22:55:09 -07001613#endif
1614#ifdef HAVE_CLOCK_SETTIME
Victor Stinner30d79472012-04-03 00:45:07 +02001615 {"clock_settime", time_clock_settime, METH_VARARGS, clock_settime_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001616 {"clock_settime_ns",time_clock_settime_ns, METH_VARARGS, clock_settime_ns_doc},
Benjamin Peterson37098cd2016-09-13 22:55:09 -07001617#endif
1618#ifdef HAVE_CLOCK_GETRES
Victor Stinner4195b5c2012-02-08 23:03:19 +01001619 {"clock_getres", time_clock_getres, METH_VARARGS, clock_getres_doc},
Victor Stinnere0be4232011-10-25 13:06:09 +02001620#endif
pdoxe14679c2017-10-05 00:01:56 -07001621#ifdef HAVE_PTHREAD_GETCPUCLOCKID
1622 {"pthread_getcpuclockid", time_pthread_getcpuclockid, METH_VARARGS, pthread_getcpuclockid_doc},
1623#endif
Victor Stinnercb29f012015-03-27 13:31:18 +01001624 {"sleep", time_sleep, METH_O, sleep_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001625 {"gmtime", time_gmtime, METH_VARARGS, gmtime_doc},
1626 {"localtime", time_localtime, METH_VARARGS, localtime_doc},
1627 {"asctime", time_asctime, METH_VARARGS, asctime_doc},
1628 {"ctime", time_ctime, METH_VARARGS, ctime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001629#ifdef HAVE_MKTIME
Victor Stinner4195b5c2012-02-08 23:03:19 +01001630 {"mktime", time_mktime, METH_O, mktime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001631#endif
1632#ifdef HAVE_STRFTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 {"strftime", time_strftime, METH_VARARGS, strftime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001634#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 {"strptime", time_strptime, METH_VARARGS, strptime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001636#ifdef HAVE_WORKING_TZSET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 {"tzset", time_tzset, METH_NOARGS, tzset_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001638#endif
Victor Stinnerec895392012-04-29 02:41:27 +02001639 {"monotonic", time_monotonic, METH_NOARGS, monotonic_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001640 {"monotonic_ns", time_monotonic_ns, METH_NOARGS, monotonic_ns_doc},
Victor Stinnerec895392012-04-29 02:41:27 +02001641 {"process_time", time_process_time, METH_NOARGS, process_time_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001642 {"process_time_ns", time_process_time_ns, METH_NOARGS, process_time_ns_doc},
Antoine Pitrou4bd41c92017-11-15 22:52:21 +01001643#ifdef HAVE_THREAD_TIME
1644 {"thread_time", time_thread_time, METH_NOARGS, thread_time_doc},
1645 {"thread_time_ns", time_thread_time_ns, METH_NOARGS, thread_time_ns_doc},
1646#endif
Victor Stinnerec895392012-04-29 02:41:27 +02001647 {"perf_counter", time_perf_counter, METH_NOARGS, perf_counter_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001648 {"perf_counter_ns", time_perf_counter_ns, METH_NOARGS, perf_counter_ns_doc},
Victor Stinnerec895392012-04-29 02:41:27 +02001649 {"get_clock_info", time_get_clock_info, METH_VARARGS, get_clock_info_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 {NULL, NULL} /* sentinel */
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001651};
1652
1653
1654PyDoc_STRVAR(module_doc,
1655"This module provides various functions to manipulate time values.\n\
1656\n\
1657There are two standard representations of time. One is the number\n\
1658of seconds since the Epoch, in UTC (a.k.a. GMT). It may be an integer\n\
1659or a floating point number (to represent fractions of seconds).\n\
1660The Epoch is system-defined; on Unix, it is generally January 1st, 1970.\n\
1661The actual value can be retrieved by calling gmtime(0).\n\
1662\n\
1663The other representation is a tuple of 9 integers giving local time.\n\
1664The tuple items are:\n\
Alexander Belopolsky03163ac2011-05-02 12:20:52 -04001665 year (including century, e.g. 1998)\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001666 month (1-12)\n\
1667 day (1-31)\n\
1668 hours (0-23)\n\
1669 minutes (0-59)\n\
1670 seconds (0-59)\n\
1671 weekday (0-6, Monday is 0)\n\
1672 Julian day (day in the year, 1-366)\n\
1673 DST (Daylight Savings Time) flag (-1, 0 or 1)\n\
1674If the DST flag is 0, the time is given in the regular time zone;\n\
1675if it is 1, the time is given in the DST time zone;\n\
Cheryl Sabella703ff382017-10-11 09:29:14 -04001676if it is -1, mktime() should guess based on the date and time.\n");
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001677
1678
Martin v. Löwis1a214512008-06-11 05:26:20 +00001679
1680static struct PyModuleDef timemodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001681 PyModuleDef_HEAD_INIT,
1682 "time",
1683 module_doc,
1684 -1,
1685 time_methods,
1686 NULL,
1687 NULL,
1688 NULL,
1689 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001690};
1691
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001692PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00001693PyInit_time(void)
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001694{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 PyObject *m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001696 m = PyModule_Create(&timemodule);
1697 if (m == NULL)
1698 return NULL;
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001699
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001700 /* Set, or reset, module variables like time.timezone */
1701 PyInit_timezone(m);
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001702
Miss Islington (bot)002aef32018-10-20 17:41:38 -07001703#if defined(HAVE_CLOCK_GETTIME) || defined(HAVE_CLOCK_SETTIME) || defined(HAVE_CLOCK_GETRES)
1704
Benjamin Peterson37098cd2016-09-13 22:55:09 -07001705#ifdef CLOCK_REALTIME
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -04001706 PyModule_AddIntMacro(m, CLOCK_REALTIME);
Benjamin Peterson37098cd2016-09-13 22:55:09 -07001707#endif
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -04001708#ifdef CLOCK_MONOTONIC
1709 PyModule_AddIntMacro(m, CLOCK_MONOTONIC);
1710#endif
1711#ifdef CLOCK_MONOTONIC_RAW
1712 PyModule_AddIntMacro(m, CLOCK_MONOTONIC_RAW);
1713#endif
1714#ifdef CLOCK_HIGHRES
1715 PyModule_AddIntMacro(m, CLOCK_HIGHRES);
1716#endif
1717#ifdef CLOCK_PROCESS_CPUTIME_ID
1718 PyModule_AddIntMacro(m, CLOCK_PROCESS_CPUTIME_ID);
1719#endif
1720#ifdef CLOCK_THREAD_CPUTIME_ID
1721 PyModule_AddIntMacro(m, CLOCK_THREAD_CPUTIME_ID);
1722#endif
Victor Stinnera64ce972017-11-02 04:19:19 -07001723#ifdef CLOCK_PROF
1724 PyModule_AddIntMacro(m, CLOCK_PROF);
1725#endif
1726#ifdef CLOCK_BOOTTIME
1727 PyModule_AddIntMacro(m, CLOCK_BOOTTIME);
1728#endif
1729#ifdef CLOCK_UPTIME
1730 PyModule_AddIntMacro(m, CLOCK_UPTIME);
1731#endif
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -04001732
Miss Islington (bot)002aef32018-10-20 17:41:38 -07001733#endif /* defined(HAVE_CLOCK_GETTIME) || defined(HAVE_CLOCK_SETTIME) || defined(HAVE_CLOCK_GETRES) */
1734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001735 if (!initialized) {
Victor Stinner1c8f0592013-07-22 22:24:54 +02001736 if (PyStructSequence_InitType2(&StructTimeType,
1737 &struct_time_type_desc) < 0)
1738 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 }
1740 Py_INCREF(&StructTimeType);
Alexander Belopolskyc142bba2012-06-13 22:15:26 -04001741 PyModule_AddIntConstant(m, "_STRUCT_TM_ITEMS", 11);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001742 PyModule_AddObject(m, "struct_time", (PyObject*) &StructTimeType);
1743 initialized = 1;
1744 return m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001745}
1746
Victor Stinnercb29f012015-03-27 13:31:18 +01001747/* Implement pysleep() for various platforms.
Guido van Rossumb6775db1994-08-01 11:34:53 +00001748 When interrupted (or when another error occurs), return -1 and
1749 set an exception; else return 0. */
1750
1751static int
Victor Stinnercb29f012015-03-27 13:31:18 +01001752pysleep(_PyTime_t secs)
Guido van Rossum426035c1991-02-19 12:27:35 +00001753{
Victor Stinnercb29f012015-03-27 13:31:18 +01001754 _PyTime_t deadline, monotonic;
Victor Stinner79d68f92015-03-19 21:54:09 +01001755#ifndef MS_WINDOWS
1756 struct timeval timeout;
Victor Stinner79d68f92015-03-19 21:54:09 +01001757 int err = 0;
1758#else
Victor Stinnercb29f012015-03-27 13:31:18 +01001759 _PyTime_t millisecs;
Victor Stinner79d68f92015-03-19 21:54:09 +01001760 unsigned long ul_millis;
1761 DWORD rc;
1762 HANDLE hInterruptEvent;
Victor Stinner0c2fd892015-03-17 10:49:17 +01001763#endif
Victor Stinner79d68f92015-03-19 21:54:09 +01001764
Victor Stinnercb29f012015-03-27 13:31:18 +01001765 deadline = _PyTime_GetMonotonicClock() + secs;
Victor Stinner79d68f92015-03-19 21:54:09 +01001766
1767 do {
1768#ifndef MS_WINDOWS
Victor Stinner869e1772015-03-30 03:49:14 +02001769 if (_PyTime_AsTimeval(secs, &timeout, _PyTime_ROUND_CEILING) < 0)
Victor Stinnercb29f012015-03-27 13:31:18 +01001770 return -1;
Victor Stinner79d68f92015-03-19 21:54:09 +01001771
1772 Py_BEGIN_ALLOW_THREADS
1773 err = select(0, (fd_set *)0, (fd_set *)0, (fd_set *)0, &timeout);
1774 Py_END_ALLOW_THREADS
1775
1776 if (err == 0)
1777 break;
1778
1779 if (errno != EINTR) {
Victor Stinner0c2fd892015-03-17 10:49:17 +01001780 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001781 return -1;
1782 }
Victor Stinner79d68f92015-03-19 21:54:09 +01001783#else
Victor Stinner869e1772015-03-30 03:49:14 +02001784 millisecs = _PyTime_AsMilliseconds(secs, _PyTime_ROUND_CEILING);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 if (millisecs > (double)ULONG_MAX) {
1786 PyErr_SetString(PyExc_OverflowError,
1787 "sleep length is too large");
1788 return -1;
1789 }
Victor Stinner79d68f92015-03-19 21:54:09 +01001790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001791 /* Allow sleep(0) to maintain win32 semantics, and as decreed
1792 * by Guido, only the main thread can be interrupted.
1793 */
1794 ul_millis = (unsigned long)millisecs;
Victor Stinner79d68f92015-03-19 21:54:09 +01001795 if (ul_millis == 0 || !_PyOS_IsMainThread()) {
1796 Py_BEGIN_ALLOW_THREADS
Victor Stinner0eac1302015-03-20 03:06:12 +01001797 Sleep(ul_millis);
Victor Stinner79d68f92015-03-19 21:54:09 +01001798 Py_END_ALLOW_THREADS
1799 break;
Victor Stinner945c82e2015-03-12 16:19:01 +01001800 }
Victor Stinner79d68f92015-03-19 21:54:09 +01001801
1802 hInterruptEvent = _PyOS_SigintEvent();
1803 ResetEvent(hInterruptEvent);
1804
1805 Py_BEGIN_ALLOW_THREADS
1806 rc = WaitForSingleObjectEx(hInterruptEvent, ul_millis, FALSE);
Victor Stinner0c2fd892015-03-17 10:49:17 +01001807 Py_END_ALLOW_THREADS
Victor Stinner79d68f92015-03-19 21:54:09 +01001808
1809 if (rc != WAIT_OBJECT_0)
1810 break;
Victor Stinner945c82e2015-03-12 16:19:01 +01001811#endif
Victor Stinner0c2fd892015-03-17 10:49:17 +01001812
Victor Stinner79d68f92015-03-19 21:54:09 +01001813 /* sleep was interrupted by SIGINT */
1814 if (PyErr_CheckSignals())
1815 return -1;
1816
Victor Stinnercb29f012015-03-27 13:31:18 +01001817 monotonic = _PyTime_GetMonotonicClock();
1818 secs = deadline - monotonic;
Victor Stinner6aa446c2015-03-30 21:33:51 +02001819 if (secs < 0)
Victor Stinner79d68f92015-03-19 21:54:09 +01001820 break;
1821 /* retry with the recomputed delay */
1822 } while (1);
1823
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 return 0;
Guido van Rossum80c9d881991-04-16 08:47:51 +00001825}