blob: b17ab5ae824ba47e46141191f31172deccfe1354 [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;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 p->tm_year = y - 1900;
555 p->tm_mon--;
556 p->tm_wday = (p->tm_wday + 1) % 7;
557 p->tm_yday--;
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400558#ifdef HAVE_STRUCT_TM_TM_ZONE
559 if (Py_TYPE(args) == &StructTimeType) {
560 PyObject *item;
561 item = PyTuple_GET_ITEM(args, 9);
Victor Stinner6e676952017-04-26 13:51:48 +0200562 p->tm_zone = item == Py_None ? NULL : (char*)PyUnicode_AsUTF8(item);
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400563 item = PyTuple_GET_ITEM(args, 10);
564 p->tm_gmtoff = item == Py_None ? 0 : PyLong_AsLong(item);
565 if (PyErr_Occurred())
566 return 0;
567 }
568#endif /* HAVE_STRUCT_TM_TM_ZONE */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000569 return 1;
Guido van Rossum9e90a671993-06-24 11:10:19 +0000570}
571
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000572/* Check values of the struct tm fields before it is passed to strftime() and
573 * asctime(). Return 1 if all values are valid, otherwise set an exception
574 * and returns 0.
575 */
Victor Stinneref128102010-10-07 01:00:52 +0000576static int
577checktm(struct tm* buf)
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000578{
Victor Stinneref128102010-10-07 01:00:52 +0000579 /* Checks added to make sure strftime() and asctime() does not crash Python by
580 indexing blindly into some array for a textual representation
581 by some bad index (fixes bug #897625 and #6608).
582
583 Also support values of zero from Python code for arguments in which
584 that is out of range by forcing that value to the lowest value that
585 is valid (fixed bug #1520914).
586
587 Valid ranges based on what is allowed in struct tm:
588
589 - tm_year: [0, max(int)] (1)
590 - tm_mon: [0, 11] (2)
591 - tm_mday: [1, 31]
592 - tm_hour: [0, 23]
593 - tm_min: [0, 59]
594 - tm_sec: [0, 60]
595 - tm_wday: [0, 6] (1)
596 - tm_yday: [0, 365] (2)
597 - tm_isdst: [-max(int), max(int)]
598
599 (1) gettmarg() handles bounds-checking.
600 (2) Python's acceptable range is one greater than the range in C,
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000601 thus need to check against automatic decrement by gettmarg().
602 */
603 if (buf->tm_mon == -1)
604 buf->tm_mon = 0;
605 else if (buf->tm_mon < 0 || buf->tm_mon > 11) {
606 PyErr_SetString(PyExc_ValueError, "month out of range");
607 return 0;
608 }
609 if (buf->tm_mday == 0)
610 buf->tm_mday = 1;
611 else if (buf->tm_mday < 0 || buf->tm_mday > 31) {
612 PyErr_SetString(PyExc_ValueError, "day of month out of range");
613 return 0;
614 }
615 if (buf->tm_hour < 0 || buf->tm_hour > 23) {
616 PyErr_SetString(PyExc_ValueError, "hour out of range");
617 return 0;
618 }
619 if (buf->tm_min < 0 || buf->tm_min > 59) {
620 PyErr_SetString(PyExc_ValueError, "minute out of range");
621 return 0;
622 }
623 if (buf->tm_sec < 0 || buf->tm_sec > 61) {
624 PyErr_SetString(PyExc_ValueError, "seconds out of range");
625 return 0;
626 }
627 /* tm_wday does not need checking of its upper-bound since taking
628 ``% 7`` in gettmarg() automatically restricts the range. */
629 if (buf->tm_wday < 0) {
630 PyErr_SetString(PyExc_ValueError, "day of week out of range");
631 return 0;
632 }
633 if (buf->tm_yday == -1)
634 buf->tm_yday = 0;
635 else if (buf->tm_yday < 0 || buf->tm_yday > 365) {
636 PyErr_SetString(PyExc_ValueError, "day of year out of range");
637 return 0;
638 }
639 return 1;
640}
641
Victor Stinnerc1f32ca2011-10-14 02:36:13 +0200642#ifdef MS_WINDOWS
643 /* wcsftime() doesn't format correctly time zones, see issue #10653 */
644# undef HAVE_WCSFTIME
645#endif
Alexander Belopolskycf774542012-10-02 18:39:16 -0400646#define STRFTIME_FORMAT_CODES \
647"Commonly used format codes:\n\
648\n\
649%Y Year with century as a decimal number.\n\
650%m Month as a decimal number [01,12].\n\
651%d Day of the month as a decimal number [01,31].\n\
652%H Hour (24-hour clock) as a decimal number [00,23].\n\
653%M Minute as a decimal number [00,59].\n\
654%S Second as a decimal number [00,61].\n\
655%z Time zone offset from UTC.\n\
656%a Locale's abbreviated weekday name.\n\
657%A Locale's full weekday name.\n\
658%b Locale's abbreviated month name.\n\
659%B Locale's full month name.\n\
660%c Locale's appropriate date and time representation.\n\
661%I Hour (12-hour clock) as a decimal number [01,12].\n\
662%p Locale's equivalent of either AM or PM.\n\
663\n\
664Other codes may be available on your platform. See documentation for\n\
665the C library strftime function.\n"
Victor Stinnerc1f32ca2011-10-14 02:36:13 +0200666
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000667#ifdef HAVE_STRFTIME
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000668#ifdef HAVE_WCSFTIME
669#define time_char wchar_t
670#define format_time wcsftime
671#define time_strlen wcslen
672#else
673#define time_char char
674#define format_time strftime
675#define time_strlen strlen
676#endif
677
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000678static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000679time_strftime(PyObject *self, PyObject *args)
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000680{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 PyObject *tup = NULL;
682 struct tm buf;
683 const time_char *fmt;
Victor Stinnerb2904782010-09-29 10:34:19 +0000684#ifdef HAVE_WCSFTIME
685 wchar_t *format;
686#else
687 PyObject *format;
688#endif
Victor Stinneref128102010-10-07 01:00:52 +0000689 PyObject *format_arg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000690 size_t fmtlen, buflen;
Victor Stinnerb2904782010-09-29 10:34:19 +0000691 time_char *outbuf = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000692 size_t i;
Victor Stinnerb2904782010-09-29 10:34:19 +0000693 PyObject *ret = NULL;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000695 memset((void *) &buf, '\0', sizeof(buf));
Guido van Rossum1f41f841998-04-27 19:04:26 +0000696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 /* Will always expect a unicode string to be passed as format.
698 Given that there's no str type anymore in py3k this seems safe.
699 */
Victor Stinneref128102010-10-07 01:00:52 +0000700 if (!PyArg_ParseTuple(args, "U|O:strftime", &format_arg, &tup))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 return NULL;
Thomas Woutersfe385252001-01-19 23:16:56 +0000702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000703 if (tup == NULL) {
704 time_t tt = time(NULL);
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -0400705 if (_PyTime_localtime(tt, &buf) != 0)
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100706 return NULL;
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000707 }
Oren Milman1d1d3e92017-08-20 18:35:36 +0300708 else if (!gettmarg(tup, &buf,
709 "iiiiiiiii;strftime(): illegal time tuple argument") ||
710 !checktm(&buf))
711 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000712 return NULL;
Oren Milman1d1d3e92017-08-20 18:35:36 +0300713 }
Guido van Rossum10b164a2001-09-25 13:59:01 +0000714
Victor Stinner36b82d82013-06-25 02:33:53 +0200715#if defined(_MSC_VER) || defined(sun) || defined(_AIX)
Victor Stinner73ea29c2011-01-08 01:56:31 +0000716 if (buf.tm_year + 1900 < 1 || 9999 < buf.tm_year + 1900) {
Victor Stinner6f0e4f92011-03-21 02:14:53 +0100717 PyErr_SetString(PyExc_ValueError,
718 "strftime() requires year in [1; 9999]");
Alexander Belopolsky0dd06f42011-01-08 01:23:02 +0000719 return NULL;
Alexander Belopolskyc64708a2011-01-07 19:59:19 +0000720 }
Victor Stinner73ea29c2011-01-08 01:56:31 +0000721#endif
Alexander Belopolskyc64708a2011-01-07 19:59:19 +0000722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 /* Normalize tm_isdst just in case someone foolishly implements %Z
724 based on the assumption that tm_isdst falls within the range of
725 [-1, 1] */
726 if (buf.tm_isdst < -1)
727 buf.tm_isdst = -1;
728 else if (buf.tm_isdst > 1)
729 buf.tm_isdst = 1;
Brett Cannond1080a32004-03-02 04:38:10 +0000730
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000731#ifdef HAVE_WCSFTIME
Victor Stinnerbeb4135b2010-10-07 01:02:42 +0000732 format = PyUnicode_AsWideCharString(format_arg, NULL);
Victor Stinnerb2904782010-09-29 10:34:19 +0000733 if (format == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 return NULL;
Victor Stinnerb2904782010-09-29 10:34:19 +0000735 fmt = format;
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000736#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 /* Convert the unicode string to an ascii one */
Victor Stinner1b579672011-12-17 05:47:23 +0100738 format = PyUnicode_EncodeLocale(format_arg, "surrogateescape");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 if (format == NULL)
740 return NULL;
741 fmt = PyBytes_AS_STRING(format);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000742#endif
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000743
Stefan Krah4aea7d32012-02-27 16:30:26 +0100744#if defined(MS_WINDOWS) && !defined(HAVE_WCSFTIME)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 /* check that the format string contains only valid directives */
Steve Dowere5b58952015-09-06 19:20:51 -0700746 for (outbuf = strchr(fmt, '%');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 outbuf != NULL;
Victor Stinner5a3ff792011-10-16 19:08:23 +0200748 outbuf = strchr(outbuf+2, '%'))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000749 {
Steve Dowere5b58952015-09-06 19:20:51 -0700750 if (outbuf[1] == '#')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 ++outbuf; /* not documented by python, */
Steve Dowere5b58952015-09-06 19:20:51 -0700752 if (outbuf[1] == '\0')
753 break;
754 if ((outbuf[1] == 'y') && buf.tm_year < 0) {
Tim Golden6e51b8f2013-11-12 12:36:54 +0000755 PyErr_SetString(PyExc_ValueError,
756 "format %y requires year >= 1900 on Windows");
757 Py_DECREF(format);
758 return NULL;
759 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 }
Victor Stinner93965f72013-11-23 14:59:33 +0100761#elif (defined(_AIX) || defined(sun)) && defined(HAVE_WCSFTIME)
Steve Dowere5b58952015-09-06 19:20:51 -0700762 for (outbuf = wcschr(fmt, '%');
Victor Stinner55329f82013-11-17 23:39:21 +0100763 outbuf != NULL;
764 outbuf = wcschr(outbuf+2, '%'))
765 {
Steve Dowere5b58952015-09-06 19:20:51 -0700766 if (outbuf[1] == L'\0')
767 break;
Victor Stinner55329f82013-11-17 23:39:21 +0100768 /* Issue #19634: On AIX, wcsftime("y", (1899, 1, 1, 0, 0, 0, 0, 0, 0))
769 returns "0/" instead of "99" */
770 if (outbuf[1] == L'y' && buf.tm_year < 0) {
771 PyErr_SetString(PyExc_ValueError,
772 "format %y requires year >= 1900 on AIX");
Victor Stinner55329f82013-11-17 23:39:21 +0100773 return NULL;
774 }
775 }
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000776#endif
777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 fmtlen = time_strlen(fmt);
Guido van Rossumc222ec21999-02-23 00:00:10 +0000779
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000780 /* I hate these functions that presume you know how big the output
781 * will be ahead of time...
782 */
783 for (i = 1024; ; i += i) {
784 outbuf = (time_char *)PyMem_Malloc(i*sizeof(time_char));
785 if (outbuf == NULL) {
Victor Stinnerb2904782010-09-29 10:34:19 +0000786 PyErr_NoMemory();
787 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000788 }
Steve Dower57ab1cd2015-09-22 14:51:42 -0700789#if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__)
790 errno = 0;
791#endif
Steve Dowerd9ef74e2015-05-22 15:08:34 -0700792 _Py_BEGIN_SUPPRESS_IPH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 buflen = format_time(outbuf, i, fmt, &buf);
Steve Dowerd9ef74e2015-05-22 15:08:34 -0700794 _Py_END_SUPPRESS_IPH
Victor Stinner136ea492011-12-17 22:37:18 +0100795#if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__)
Steve Dower97cded92015-09-08 19:12:51 -0700796 /* VisualStudio .NET 2005 does this properly */
797 if (buflen == 0 && errno == EINVAL) {
798 PyErr_SetString(PyExc_ValueError, "Invalid format string");
799 PyMem_Free(outbuf);
800 break;
801 }
Victor Stinner136ea492011-12-17 22:37:18 +0100802#endif
Steve Dower97cded92015-09-08 19:12:51 -0700803 if (buflen > 0 || i >= 256 * fmtlen) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000804 /* If the buffer is 256 times as long as the format,
805 it's probably not failing for lack of room!
806 More likely, the format yields an empty result,
807 e.g. an empty format, or %Z when the timezone
808 is unknown. */
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000809#ifdef HAVE_WCSFTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000810 ret = PyUnicode_FromWideChar(outbuf, buflen);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000811#else
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100812 ret = PyUnicode_DecodeLocaleAndSize(outbuf, buflen, "surrogateescape");
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000813#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 PyMem_Free(outbuf);
Victor Stinnerb2904782010-09-29 10:34:19 +0000815 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000816 }
817 PyMem_Free(outbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000818 }
Victor Stinnerb2904782010-09-29 10:34:19 +0000819#ifdef HAVE_WCSFTIME
820 PyMem_Free(format);
821#else
822 Py_DECREF(format);
823#endif
824 return ret;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000825}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000826
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000827#undef time_char
828#undef format_time
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000829PyDoc_STRVAR(strftime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000830"strftime(format[, tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000831\n\
832Convert a time tuple to a string according to a format specification.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000833See the library reference manual for formatting codes. When the time tuple\n\
Alexander Belopolskycf774542012-10-02 18:39:16 -0400834is not present, current time as returned by localtime() is used.\n\
835\n" STRFTIME_FORMAT_CODES);
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000836#endif /* HAVE_STRFTIME */
837
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000838static PyObject *
839time_strptime(PyObject *self, PyObject *args)
840{
Victor Stinnerdbe28d22016-12-09 00:38:53 +0100841 PyObject *module, *func, *result;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200842 _Py_IDENTIFIER(_strptime_time);
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000843
Victor Stinnerdbe28d22016-12-09 00:38:53 +0100844 module = PyImport_ImportModuleNoBlock("_strptime");
845 if (!module)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 return NULL;
Victor Stinnerdbe28d22016-12-09 00:38:53 +0100847
848 func = _PyObject_GetAttrId(module, &PyId__strptime_time);
849 Py_DECREF(module);
850 if (!func) {
851 return NULL;
852 }
853
854 result = PyObject_Call(func, args, NULL);
855 Py_DECREF(func);
856 return result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000857}
858
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000859
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000860PyDoc_STRVAR(strptime_doc,
Brett Cannon20def8b2003-07-01 05:16:08 +0000861"strptime(string, format) -> struct_time\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000862\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000863Parse a string to a time tuple according to a format specification.\n\
Alexander Belopolskycf774542012-10-02 18:39:16 -0400864See the library reference manual for formatting codes (same as\n\
865strftime()).\n\
866\n" STRFTIME_FORMAT_CODES);
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000867
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000868static PyObject *
869_asctime(struct tm *timeptr)
870{
871 /* Inspired by Open Group reference implementation available at
872 * http://pubs.opengroup.org/onlinepubs/009695399/functions/asctime.html */
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200873 static const char wday_name[7][4] = {
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000874 "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
875 };
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200876 static const char mon_name[12][4] = {
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000877 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
878 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
879 };
Victor Stinner499dfcf2011-03-21 13:26:24 +0100880 return PyUnicode_FromFormat(
881 "%s %s%3d %.2d:%.2d:%.2d %d",
882 wday_name[timeptr->tm_wday],
883 mon_name[timeptr->tm_mon],
884 timeptr->tm_mday, timeptr->tm_hour,
885 timeptr->tm_min, timeptr->tm_sec,
886 1900 + timeptr->tm_year);
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000887}
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000888
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000889static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000890time_asctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000891{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000892 PyObject *tup = NULL;
893 struct tm buf;
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000894
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 if (!PyArg_UnpackTuple(args, "asctime", 0, 1, &tup))
896 return NULL;
897 if (tup == NULL) {
898 time_t tt = time(NULL);
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -0400899 if (_PyTime_localtime(tt, &buf) != 0)
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100900 return NULL;
Oren Milman1d1d3e92017-08-20 18:35:36 +0300901 }
902 else if (!gettmarg(tup, &buf,
903 "iiiiiiiii;asctime(): illegal time tuple argument") ||
904 !checktm(&buf))
905 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000906 return NULL;
Oren Milman1d1d3e92017-08-20 18:35:36 +0300907 }
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000908 return _asctime(&buf);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000909}
910
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000911PyDoc_STRVAR(asctime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000912"asctime([tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000913\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000914Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'.\n\
915When the time tuple is not present, current time as returned by localtime()\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000916is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000917
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000918static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000919time_ctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000920{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000921 time_t tt;
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100922 struct tm buf;
923 if (!parse_time_t_args(args, "|O:ctime", &tt))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 return NULL;
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -0400925 if (_PyTime_localtime(tt, &buf) != 0)
Alexander Belopolsky5da468f2011-01-04 17:15:52 +0000926 return NULL;
Victor Stinnerc1b5d342012-01-27 00:08:48 +0100927 return _asctime(&buf);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000928}
929
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000930PyDoc_STRVAR(ctime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000931"ctime(seconds) -> string\n\
932\n\
933Convert a time in seconds since the Epoch to a string in local time.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000934This is equivalent to asctime(localtime(seconds)). When the time tuple is\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000935not present, current time as returned by localtime() is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000936
Guido van Rossum60cd8131998-03-06 17:16:21 +0000937#ifdef HAVE_MKTIME
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000938static PyObject *
Victor Stinner4195b5c2012-02-08 23:03:19 +0100939time_mktime(PyObject *self, PyObject *tup)
Guido van Rossum234f9421993-06-17 12:35:49 +0000940{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 struct tm buf;
942 time_t tt;
Oren Milman1d1d3e92017-08-20 18:35:36 +0300943 if (!gettmarg(tup, &buf,
944 "iiiiiiiii;mktime(): illegal time tuple argument"))
945 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 return NULL;
Oren Milman1d1d3e92017-08-20 18:35:36 +0300947 }
Victor Stinner1ac42612014-02-21 09:27:17 +0100948#ifdef _AIX
949 /* year < 1902 or year > 2037 */
950 if (buf.tm_year < 2 || buf.tm_year > 137) {
951 /* Issue #19748: On AIX, mktime() doesn't report overflow error for
952 * timestamp < -2^31 or timestamp > 2**31-1. */
953 PyErr_SetString(PyExc_OverflowError,
954 "mktime argument out of range");
955 return NULL;
956 }
957#else
Alexander Belopolskyb7d40d12011-01-11 01:21:25 +0000958 buf.tm_wday = -1; /* sentinel; original value ignored */
Victor Stinner1ac42612014-02-21 09:27:17 +0100959#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 tt = mktime(&buf);
Alexander Belopolskyb7d40d12011-01-11 01:21:25 +0000961 /* Return value of -1 does not necessarily mean an error, but tm_wday
Ezio Melotti13925002011-03-16 11:05:33 +0200962 * cannot remain set to -1 if mktime succeeded. */
Victor Stinner93037492013-06-25 22:54:35 +0200963 if (tt == (time_t)(-1)
964#ifndef _AIX
965 /* Return value of -1 does not necessarily mean an error, but
966 * tm_wday cannot remain set to -1 if mktime succeeded. */
967 && buf.tm_wday == -1
968#else
969 /* on AIX, tm_wday is always sets, even on error */
970#endif
971 )
972 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000973 PyErr_SetString(PyExc_OverflowError,
974 "mktime argument out of range");
975 return NULL;
976 }
Victor Stinner4195b5c2012-02-08 23:03:19 +0100977 return PyFloat_FromDouble((double)tt);
Guido van Rossum234f9421993-06-17 12:35:49 +0000978}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000979
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000980PyDoc_STRVAR(mktime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000981"mktime(tuple) -> floating point number\n\
982\n\
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400983Convert a time tuple in local time to seconds since the Epoch.\n\
984Note that mktime(gmtime(0)) will not generally return zero for most\n\
985time zones; instead the returned value will either be equal to that\n\
986of the timezone or altzone attributes on the time module.");
Guido van Rossum60cd8131998-03-06 17:16:21 +0000987#endif /* HAVE_MKTIME */
Guido van Rossum234f9421993-06-17 12:35:49 +0000988
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000989#ifdef HAVE_WORKING_TZSET
Martin v. Löwis1a214512008-06-11 05:26:20 +0000990static void PyInit_timezone(PyObject *module);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000991
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000992static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000993time_tzset(PyObject *self, PyObject *unused)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000994{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 PyObject* m;
Fred Drake9bb74322002-04-01 14:49:59 +0000996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000997 m = PyImport_ImportModuleNoBlock("time");
998 if (m == NULL) {
999 return NULL;
1000 }
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 tzset();
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001003
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001004 /* Reset timezone, altzone, daylight and tzname */
1005 PyInit_timezone(m);
1006 Py_DECREF(m);
Victor Stinner2ff51b82013-07-17 21:42:45 +02001007 if (PyErr_Occurred())
1008 return NULL;
Tim Peters1b6f7a92004-06-20 02:50:16 +00001009
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001010 Py_RETURN_NONE;
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001011}
1012
1013PyDoc_STRVAR(tzset_doc,
R. David Murray4d55bf92010-12-14 00:55:46 +00001014"tzset()\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001015\n\
1016Initialize, or reinitialize, the local timezone to the value stored in\n\
1017os.environ['TZ']. The TZ environment variable should be specified in\n\
Neal Norwitzdc8e1942004-07-20 22:34:37 +00001018standard Unix timezone format as documented in the tzset man page\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001019(eg. 'US/Eastern', 'Europe/Amsterdam'). Unknown timezones will silently\n\
1020fall back to UTC. If the TZ environment variable is not set, the local\n\
1021timezone is set to the systems best guess of wallclock time.\n\
1022Changing the TZ environment variable without calling tzset *may* change\n\
1023the local timezone used by methods such as localtime, but this behaviour\n\
1024should not be relied on.");
1025#endif /* HAVE_WORKING_TZSET */
1026
Victor Stinnerae586492014-09-02 23:18:25 +02001027static PyObject *
Victor Stinnerec895392012-04-29 02:41:27 +02001028time_monotonic(PyObject *self, PyObject *unused)
Victor Stinner071eca32012-03-15 01:17:09 +01001029{
Victor Stinnerc29b5852017-11-02 07:28:27 -07001030 _PyTime_t t = _PyTime_GetMonotonicClock();
1031 return _PyFloat_FromPyTime(t);
Victor Stinner071eca32012-03-15 01:17:09 +01001032}
1033
Victor Stinnerec895392012-04-29 02:41:27 +02001034PyDoc_STRVAR(monotonic_doc,
1035"monotonic() -> float\n\
Victor Stinner8b302012012-02-07 23:29:46 +01001036\n\
Victor Stinnerec895392012-04-29 02:41:27 +02001037Monotonic clock, cannot go backward.");
Victor Stinnerec919cc2012-03-15 00:58:32 +01001038
Victor Stinnerec895392012-04-29 02:41:27 +02001039static PyObject *
Victor Stinnerc29b5852017-11-02 07:28:27 -07001040time_monotonic_ns(PyObject *self, PyObject *unused)
1041{
1042 _PyTime_t t = _PyTime_GetMonotonicClock();
1043 return _PyTime_AsNanosecondsObject(t);
1044}
1045
1046PyDoc_STRVAR(monotonic_ns_doc,
1047"monotonic_ns() -> int\n\
1048\n\
1049Monotonic clock, cannot go backward, as nanoseconds.");
1050
1051static PyObject *
Victor Stinnerec895392012-04-29 02:41:27 +02001052time_perf_counter(PyObject *self, PyObject *unused)
1053{
1054 return perf_counter(NULL);
1055}
1056
1057PyDoc_STRVAR(perf_counter_doc,
1058"perf_counter() -> float\n\
1059\n\
1060Performance counter for benchmarking.");
1061
Victor Stinnerc29b5852017-11-02 07:28:27 -07001062static PyObject *
1063time_perf_counter_ns(PyObject *self, PyObject *unused)
1064{
1065 _PyTime_t t = _PyTime_GetPerfCounter();
1066 return _PyTime_AsNanosecondsObject(t);
1067}
1068
1069PyDoc_STRVAR(perf_counter_ns_doc,
1070"perf_counter_ns() -> int\n\
1071\n\
1072Performance counter for benchmarking as nanoseconds.");
1073
1074static int
1075_PyTime_GetProcessTimeWithInfo(_PyTime_t *tp, _Py_clock_info_t *info)
Victor Stinnerec895392012-04-29 02:41:27 +02001076{
1077#if defined(MS_WINDOWS)
1078 HANDLE process;
1079 FILETIME creation_time, exit_time, kernel_time, user_time;
1080 ULARGE_INTEGER large;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001081 _PyTime_t ktime, utime, t;
Victor Stinnerec895392012-04-29 02:41:27 +02001082 BOOL ok;
1083
1084 process = GetCurrentProcess();
Victor Stinnerc29b5852017-11-02 07:28:27 -07001085 ok = GetProcessTimes(process, &creation_time, &exit_time,
1086 &kernel_time, &user_time);
1087 if (!ok) {
1088 PyErr_SetFromWindowsErr(0);
1089 return -1;
1090 }
Victor Stinnerec895392012-04-29 02:41:27 +02001091
Victor Stinnerec895392012-04-29 02:41:27 +02001092 if (info) {
1093 info->implementation = "GetProcessTimes()";
1094 info->resolution = 1e-7;
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001095 info->monotonic = 1;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001096 info->adjustable = 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001097 }
Victor Stinnerc29b5852017-11-02 07:28:27 -07001098
1099 large.u.LowPart = kernel_time.dwLowDateTime;
1100 large.u.HighPart = kernel_time.dwHighDateTime;
1101 ktime = large.QuadPart;
1102
1103 large.u.LowPart = user_time.dwLowDateTime;
1104 large.u.HighPart = user_time.dwHighDateTime;
1105 utime = large.QuadPart;
1106
1107 /* ktime and utime have a resolution of 100 nanoseconds */
1108 t = _PyTime_FromNanoseconds((ktime + utime) * 100);
1109 *tp = t;
1110 return 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001111#else
1112
Victor Stinnerc29b5852017-11-02 07:28:27 -07001113 /* clock_gettime */
Victor Stinnerec895392012-04-29 02:41:27 +02001114#if defined(HAVE_CLOCK_GETTIME) \
1115 && (defined(CLOCK_PROCESS_CPUTIME_ID) || defined(CLOCK_PROF))
Victor Stinnerc29b5852017-11-02 07:28:27 -07001116 struct timespec ts;
Victor Stinnerec895392012-04-29 02:41:27 +02001117#ifdef CLOCK_PROF
1118 const clockid_t clk_id = CLOCK_PROF;
1119 const char *function = "clock_gettime(CLOCK_PROF)";
1120#else
1121 const clockid_t clk_id = CLOCK_PROCESS_CPUTIME_ID;
1122 const char *function = "clock_gettime(CLOCK_PROCESS_CPUTIME_ID)";
1123#endif
1124
Victor Stinnerc29b5852017-11-02 07:28:27 -07001125 if (clock_gettime(clk_id, &ts) == 0) {
Victor Stinnerec895392012-04-29 02:41:27 +02001126 if (info) {
1127 struct timespec res;
1128 info->implementation = function;
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001129 info->monotonic = 1;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001130 info->adjustable = 0;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001131 if (clock_getres(clk_id, &res)) {
1132 PyErr_SetFromErrno(PyExc_OSError);
1133 return -1;
1134 }
1135 info->resolution = res.tv_sec + res.tv_nsec * 1e-9;
Victor Stinnerec895392012-04-29 02:41:27 +02001136 }
Victor Stinnerc29b5852017-11-02 07:28:27 -07001137
1138 if (_PyTime_FromTimespec(tp, &ts) < 0) {
1139 return -1;
1140 }
1141 return 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001142 }
1143#endif
1144
Victor Stinnerc29b5852017-11-02 07:28:27 -07001145 /* getrusage(RUSAGE_SELF) */
Victor Stinnerec895392012-04-29 02:41:27 +02001146#if defined(HAVE_SYS_RESOURCE_H)
Victor Stinnerc29b5852017-11-02 07:28:27 -07001147 struct rusage ru;
1148
Victor Stinnerec895392012-04-29 02:41:27 +02001149 if (getrusage(RUSAGE_SELF, &ru) == 0) {
Victor Stinnerc29b5852017-11-02 07:28:27 -07001150 _PyTime_t utime, stime;
1151
Victor Stinnerec895392012-04-29 02:41:27 +02001152 if (info) {
1153 info->implementation = "getrusage(RUSAGE_SELF)";
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001154 info->monotonic = 1;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001155 info->adjustable = 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001156 info->resolution = 1e-6;
1157 }
Victor Stinnerc29b5852017-11-02 07:28:27 -07001158
1159 if (_PyTime_FromTimeval(&utime, &ru.ru_utime) < 0) {
1160 return -1;
1161 }
1162 if (_PyTime_FromTimeval(&stime, &ru.ru_stime) < 0) {
1163 return -1;
1164 }
1165
1166 _PyTime_t total = utime + utime;
1167 *tp = total;
1168 return 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001169 }
1170#endif
1171
Victor Stinnerc29b5852017-11-02 07:28:27 -07001172 /* times() */
Victor Stinnerec895392012-04-29 02:41:27 +02001173#ifdef HAVE_TIMES
Victor Stinnerc29b5852017-11-02 07:28:27 -07001174 struct tms t;
1175
Victor Stinnerec895392012-04-29 02:41:27 +02001176 if (times(&t) != (clock_t)-1) {
Victor Stinnerc29b5852017-11-02 07:28:27 -07001177 static long ticks_per_second = -1;
Victor Stinnerec895392012-04-29 02:41:27 +02001178
1179 if (ticks_per_second == -1) {
Victor Stinnerc29b5852017-11-02 07:28:27 -07001180 long freq;
Victor Stinnerec895392012-04-29 02:41:27 +02001181#if defined(HAVE_SYSCONF) && defined(_SC_CLK_TCK)
Victor Stinnerc29b5852017-11-02 07:28:27 -07001182 freq = sysconf(_SC_CLK_TCK);
1183 if (freq < 1) {
1184 freq = -1;
1185 }
Victor Stinnerec895392012-04-29 02:41:27 +02001186#elif defined(HZ)
Victor Stinnerc29b5852017-11-02 07:28:27 -07001187 freq = HZ;
Victor Stinnerec895392012-04-29 02:41:27 +02001188#else
Victor Stinnerc29b5852017-11-02 07:28:27 -07001189 freq = 60; /* magic fallback value; may be bogus */
Victor Stinnerec895392012-04-29 02:41:27 +02001190#endif
Victor Stinnerc29b5852017-11-02 07:28:27 -07001191
1192 if (freq != -1) {
1193 /* check that _PyTime_MulDiv(t, SEC_TO_NS, ticks_per_second)
1194 cannot overflow below */
1195 if ((_PyTime_t)freq > _PyTime_MAX / SEC_TO_NS) {
1196 PyErr_SetString(PyExc_OverflowError,
1197 "_SC_CLK_TCK is too large");
1198 return -1;
1199 }
1200
1201 ticks_per_second = freq;
1202 }
Victor Stinnerec895392012-04-29 02:41:27 +02001203 }
1204
1205 if (ticks_per_second != -1) {
Victor Stinnerec895392012-04-29 02:41:27 +02001206 if (info) {
1207 info->implementation = "times()";
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001208 info->monotonic = 1;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001209 info->adjustable = 0;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001210 info->resolution = 1.0 / (double)ticks_per_second;
Victor Stinnerec895392012-04-29 02:41:27 +02001211 }
Victor Stinnerc29b5852017-11-02 07:28:27 -07001212
1213 _PyTime_t total;
1214 total = _PyTime_MulDiv(t.tms_utime, SEC_TO_NS, ticks_per_second);
1215 total += _PyTime_MulDiv(t.tms_stime, SEC_TO_NS, ticks_per_second);
1216 *tp = total;
1217 return 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001218 }
1219 }
1220#endif
1221
Victor Stinnerc29b5852017-11-02 07:28:27 -07001222 /* clock */
Victor Stinner53e22bf2016-07-08 17:55:01 +02001223 /* Currently, Python 3 requires clock() to build: see issue #22624 */
Victor Stinnerc29b5852017-11-02 07:28:27 -07001224 return _PyTime_GetClockWithInfo(tp, info);
Victor Stinnerec895392012-04-29 02:41:27 +02001225#endif
1226}
1227
1228static PyObject *
1229time_process_time(PyObject *self, PyObject *unused)
1230{
Victor Stinnerc29b5852017-11-02 07:28:27 -07001231 _PyTime_t t;
1232 if (_PyTime_GetProcessTimeWithInfo(&t, NULL) < 0) {
1233 return NULL;
1234 }
1235 return _PyFloat_FromPyTime(t);
Victor Stinnerec895392012-04-29 02:41:27 +02001236}
1237
1238PyDoc_STRVAR(process_time_doc,
1239"process_time() -> float\n\
1240\n\
1241Process time for profiling: sum of the kernel and user-space CPU time.");
1242
Victor Stinnerc29b5852017-11-02 07:28:27 -07001243static PyObject *
1244time_process_time_ns(PyObject *self, PyObject *unused)
1245{
1246 _PyTime_t t;
1247 if (_PyTime_GetProcessTimeWithInfo(&t, NULL) < 0) {
1248 return NULL;
1249 }
1250 return _PyTime_AsNanosecondsObject(t);
1251}
1252
1253PyDoc_STRVAR(process_time_ns_doc,
1254"process_time() -> int\n\
1255\n\
1256Process time for profiling as nanoseconds:\n\
1257sum of the kernel and user-space CPU time.");
1258
Victor Stinnerec895392012-04-29 02:41:27 +02001259
Antoine Pitrou4bd41c92017-11-15 22:52:21 +01001260#if defined(MS_WINDOWS)
1261#define HAVE_THREAD_TIME
1262static int
1263_PyTime_GetThreadTimeWithInfo(_PyTime_t *tp, _Py_clock_info_t *info)
1264{
1265 HANDLE thread;
1266 FILETIME creation_time, exit_time, kernel_time, user_time;
1267 ULARGE_INTEGER large;
1268 _PyTime_t ktime, utime, t;
1269 BOOL ok;
1270
1271 thread = GetCurrentThread();
1272 ok = GetThreadTimes(thread, &creation_time, &exit_time,
1273 &kernel_time, &user_time);
1274 if (!ok) {
1275 PyErr_SetFromWindowsErr(0);
1276 return -1;
1277 }
1278
1279 if (info) {
1280 info->implementation = "GetThreadTimes()";
1281 info->resolution = 1e-7;
1282 info->monotonic = 1;
1283 info->adjustable = 0;
1284 }
1285
1286 large.u.LowPart = kernel_time.dwLowDateTime;
1287 large.u.HighPart = kernel_time.dwHighDateTime;
1288 ktime = large.QuadPart;
1289
1290 large.u.LowPart = user_time.dwLowDateTime;
1291 large.u.HighPart = user_time.dwHighDateTime;
1292 utime = large.QuadPart;
1293
1294 /* ktime and utime have a resolution of 100 nanoseconds */
1295 t = _PyTime_FromNanoseconds((ktime + utime) * 100);
1296 *tp = t;
1297 return 0;
1298}
1299
1300#elif defined(HAVE_CLOCK_GETTIME) && defined(CLOCK_PROCESS_CPUTIME_ID)
1301#define HAVE_THREAD_TIME
1302static int
1303_PyTime_GetThreadTimeWithInfo(_PyTime_t *tp, _Py_clock_info_t *info)
1304{
1305 struct timespec ts;
1306 const clockid_t clk_id = CLOCK_THREAD_CPUTIME_ID;
1307 const char *function = "clock_gettime(CLOCK_THREAD_CPUTIME_ID)";
1308
1309 if (clock_gettime(clk_id, &ts)) {
1310 PyErr_SetFromErrno(PyExc_OSError);
1311 return -1;
1312 }
1313 if (info) {
1314 struct timespec res;
1315 info->implementation = function;
1316 info->monotonic = 1;
1317 info->adjustable = 0;
1318 if (clock_getres(clk_id, &res)) {
1319 PyErr_SetFromErrno(PyExc_OSError);
1320 return -1;
1321 }
1322 info->resolution = res.tv_sec + res.tv_nsec * 1e-9;
1323 }
1324
1325 if (_PyTime_FromTimespec(tp, &ts) < 0) {
1326 return -1;
1327 }
1328 return 0;
1329}
1330#endif
1331
1332#ifdef HAVE_THREAD_TIME
1333static PyObject *
1334time_thread_time(PyObject *self, PyObject *unused)
1335{
1336 _PyTime_t t;
1337 if (_PyTime_GetThreadTimeWithInfo(&t, NULL) < 0) {
1338 return NULL;
1339 }
1340 return _PyFloat_FromPyTime(t);
1341}
1342
1343PyDoc_STRVAR(thread_time_doc,
1344"thread_time() -> float\n\
1345\n\
1346Thread time for profiling: sum of the kernel and user-space CPU time.");
1347
1348static PyObject *
1349time_thread_time_ns(PyObject *self, PyObject *unused)
1350{
1351 _PyTime_t t;
1352 if (_PyTime_GetThreadTimeWithInfo(&t, NULL) < 0) {
1353 return NULL;
1354 }
1355 return _PyTime_AsNanosecondsObject(t);
1356}
1357
1358PyDoc_STRVAR(thread_time_ns_doc,
1359"thread_time() -> int\n\
1360\n\
1361Thread time for profiling as nanoseconds:\n\
1362sum of the kernel and user-space CPU time.");
1363#endif
1364
1365
Victor Stinnerec895392012-04-29 02:41:27 +02001366static PyObject *
1367time_get_clock_info(PyObject *self, PyObject *args)
1368{
1369 char *name;
Victor Stinnerec895392012-04-29 02:41:27 +02001370 _Py_clock_info_t info;
Victor Stinnerbda4b882012-06-12 22:11:44 +02001371 PyObject *obj = NULL, *dict, *ns;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001372 _PyTime_t t;
Victor Stinnerec895392012-04-29 02:41:27 +02001373
Victor Stinnerc29b5852017-11-02 07:28:27 -07001374 if (!PyArg_ParseTuple(args, "s:get_clock_info", &name)) {
Victor Stinnerec895392012-04-29 02:41:27 +02001375 return NULL;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001376 }
Victor Stinnerec895392012-04-29 02:41:27 +02001377
1378#ifdef Py_DEBUG
1379 info.implementation = NULL;
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001380 info.monotonic = -1;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001381 info.adjustable = -1;
Victor Stinnerec895392012-04-29 02:41:27 +02001382 info.resolution = -1.0;
1383#else
1384 info.implementation = "";
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001385 info.monotonic = 0;
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001386 info.adjustable = 0;
Victor Stinnerec895392012-04-29 02:41:27 +02001387 info.resolution = 1.0;
1388#endif
1389
Victor Stinnerc29b5852017-11-02 07:28:27 -07001390 if (strcmp(name, "time") == 0) {
1391 if (_PyTime_GetSystemClockWithInfo(&t, &info) < 0) {
1392 return NULL;
1393 }
1394 }
Victor Stinnerec895392012-04-29 02:41:27 +02001395#ifdef PYCLOCK
Victor Stinnerc29b5852017-11-02 07:28:27 -07001396 else if (strcmp(name, "clock") == 0) {
Victor Stinnerec895392012-04-29 02:41:27 +02001397 obj = pyclock(&info);
Victor Stinnerc29b5852017-11-02 07:28:27 -07001398 if (obj == NULL) {
1399 return NULL;
1400 }
1401 Py_DECREF(obj);
1402 }
Victor Stinnerec895392012-04-29 02:41:27 +02001403#endif
Victor Stinnerc29b5852017-11-02 07:28:27 -07001404 else if (strcmp(name, "monotonic") == 0) {
1405 if (_PyTime_GetMonotonicClockWithInfo(&t, &info) < 0) {
1406 return NULL;
1407 }
1408 }
1409 else if (strcmp(name, "perf_counter") == 0) {
1410 if (_PyTime_GetPerfCounterWithInfo(&t, &info) < 0) {
1411 return NULL;
1412 }
1413 }
1414 else if (strcmp(name, "process_time") == 0) {
1415 if (_PyTime_GetProcessTimeWithInfo(&t, &info) < 0) {
1416 return NULL;
1417 }
1418 }
Antoine Pitrou4bd41c92017-11-15 22:52:21 +01001419#ifdef HAVE_THREAD_TIME
1420 else if (strcmp(name, "thread_time") == 0) {
1421 if (_PyTime_GetThreadTimeWithInfo(&t, &info) < 0) {
1422 return NULL;
1423 }
1424 }
1425#endif
Victor Stinnerec895392012-04-29 02:41:27 +02001426 else {
1427 PyErr_SetString(PyExc_ValueError, "unknown clock");
1428 return NULL;
1429 }
Victor Stinnerec895392012-04-29 02:41:27 +02001430
Victor Stinnerbda4b882012-06-12 22:11:44 +02001431 dict = PyDict_New();
Victor Stinnerc29b5852017-11-02 07:28:27 -07001432 if (dict == NULL) {
Victor Stinnerec895392012-04-29 02:41:27 +02001433 return NULL;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001434 }
Victor Stinnerec895392012-04-29 02:41:27 +02001435
1436 assert(info.implementation != NULL);
1437 obj = PyUnicode_FromString(info.implementation);
Victor Stinnerc29b5852017-11-02 07:28:27 -07001438 if (obj == NULL) {
Victor Stinnerec895392012-04-29 02:41:27 +02001439 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001440 }
1441 if (PyDict_SetItemString(dict, "implementation", obj) == -1) {
Victor Stinnerbda4b882012-06-12 22:11:44 +02001442 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001443 }
Victor Stinnerbda4b882012-06-12 22:11:44 +02001444 Py_CLEAR(obj);
Victor Stinnerec895392012-04-29 02:41:27 +02001445
Benjamin Peterson49a69e42012-05-01 09:38:34 -04001446 assert(info.monotonic != -1);
1447 obj = PyBool_FromLong(info.monotonic);
Victor Stinnerc29b5852017-11-02 07:28:27 -07001448 if (obj == NULL) {
Victor Stinnerec895392012-04-29 02:41:27 +02001449 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001450 }
1451 if (PyDict_SetItemString(dict, "monotonic", obj) == -1) {
Victor Stinnerbda4b882012-06-12 22:11:44 +02001452 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001453 }
Victor Stinnerbda4b882012-06-12 22:11:44 +02001454 Py_CLEAR(obj);
Victor Stinnerec895392012-04-29 02:41:27 +02001455
Victor Stinner2b89fdf2012-06-12 22:46:37 +02001456 assert(info.adjustable != -1);
1457 obj = PyBool_FromLong(info.adjustable);
Victor Stinnerc29b5852017-11-02 07:28:27 -07001458 if (obj == NULL) {
Victor Stinnerec895392012-04-29 02:41:27 +02001459 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001460 }
1461 if (PyDict_SetItemString(dict, "adjustable", obj) == -1) {
Victor Stinnerbda4b882012-06-12 22:11:44 +02001462 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001463 }
Victor Stinnerbda4b882012-06-12 22:11:44 +02001464 Py_CLEAR(obj);
Victor Stinnerec895392012-04-29 02:41:27 +02001465
1466 assert(info.resolution > 0.0);
1467 assert(info.resolution <= 1.0);
1468 obj = PyFloat_FromDouble(info.resolution);
Victor Stinnerc29b5852017-11-02 07:28:27 -07001469 if (obj == NULL) {
Victor Stinnerec895392012-04-29 02:41:27 +02001470 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001471 }
1472 if (PyDict_SetItemString(dict, "resolution", obj) == -1) {
Victor Stinnerbda4b882012-06-12 22:11:44 +02001473 goto error;
Victor Stinnerc29b5852017-11-02 07:28:27 -07001474 }
Victor Stinnerbda4b882012-06-12 22:11:44 +02001475 Py_CLEAR(obj);
Victor Stinnerec895392012-04-29 02:41:27 +02001476
Victor Stinnerbda4b882012-06-12 22:11:44 +02001477 ns = _PyNamespace_New(dict);
1478 Py_DECREF(dict);
1479 return ns;
Victor Stinnerec895392012-04-29 02:41:27 +02001480
1481error:
Victor Stinnerbda4b882012-06-12 22:11:44 +02001482 Py_DECREF(dict);
1483 Py_XDECREF(obj);
Victor Stinnerec895392012-04-29 02:41:27 +02001484 return NULL;
1485}
1486
1487PyDoc_STRVAR(get_clock_info_doc,
1488"get_clock_info(name: str) -> dict\n\
1489\n\
1490Get information of the specified clock.");
Victor Stinner8b302012012-02-07 23:29:46 +01001491
Victor Stinner8f5cdfa2017-04-20 13:41:09 +02001492#if !defined(HAVE_TZNAME) || defined(__GLIBC__) || defined(__CYGWIN__)
Martin v. Löwisd218dc12008-04-07 03:17:54 +00001493static void
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -04001494get_zone(char *zone, int n, struct tm *p)
1495{
1496#ifdef HAVE_STRUCT_TM_TM_ZONE
1497 strncpy(zone, p->tm_zone ? p->tm_zone : " ", n);
1498#else
1499 tzset();
1500 strftime(zone, n, "%Z", p);
1501#endif
1502}
1503
1504static int
1505get_gmtoff(time_t t, struct tm *p)
1506{
1507#ifdef HAVE_STRUCT_TM_TM_ZONE
1508 return p->tm_gmtoff;
1509#else
1510 return timegm(p) - t;
1511#endif
1512}
Victor Stinner8f5cdfa2017-04-20 13:41:09 +02001513#endif /* !defined(HAVE_TZNAME) || defined(__GLIBC__) || defined(__CYGWIN__) */
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -04001514
1515static void
Martin v. Löwis1a214512008-06-11 05:26:20 +00001516PyInit_timezone(PyObject *m) {
1517 /* This code moved from PyInit_time wholesale to allow calling it from
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 time_tzset. In the future, some parts of it can be moved back
1519 (for platforms that don't HAVE_WORKING_TZSET, when we know what they
1520 are), and the extraneous calls to tzset(3) should be removed.
1521 I haven't done this yet, as I don't want to change this code as
1522 little as possible when introducing the time.tzset and time.tzsetwall
1523 methods. This should simply be a method of doing the following once,
1524 at the top of this function and removing the call to tzset() from
1525 time_tzset():
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001526
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001527 #ifdef HAVE_TZSET
1528 tzset()
1529 #endif
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001531 And I'm lazy and hate C so nyer.
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001532 */
Guido van Rossum10b164a2001-09-25 13:59:01 +00001533#if defined(HAVE_TZNAME) && !defined(__GLIBC__) && !defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001534 PyObject *otz0, *otz1;
1535 tzset();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001536 PyModule_AddIntConstant(m, "timezone", timezone);
Guido van Rossumb6775db1994-08-01 11:34:53 +00001537#ifdef HAVE_ALTZONE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001538 PyModule_AddIntConstant(m, "altzone", altzone);
Guido van Rossumb6775db1994-08-01 11:34:53 +00001539#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 PyModule_AddIntConstant(m, "altzone", timezone-3600);
Guido van Rossumb6775db1994-08-01 11:34:53 +00001541#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 PyModule_AddIntConstant(m, "daylight", daylight);
Victor Stinner7ed7aea2018-01-15 10:45:49 +01001543 otz0 = PyUnicode_DecodeLocale(tzname[0], "surrogateescape");
1544 otz1 = PyUnicode_DecodeLocale(tzname[1], "surrogateescape");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 PyModule_AddObject(m, "tzname", Py_BuildValue("(NN)", otz0, otz1));
Guido van Rossum10b164a2001-09-25 13:59:01 +00001546#else /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001547 {
Guido van Rossum234f9421993-06-17 12:35:49 +00001548#define YEAR ((time_t)((365 * 24 + 6) * 3600))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 time_t t;
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04001550 struct tm p;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001551 long janzone, julyzone;
1552 char janname[10], julyname[10];
1553 t = (time((time_t *)0) / YEAR) * YEAR;
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04001554 _PyTime_localtime(t, &p);
1555 get_zone(janname, 9, &p);
1556 janzone = -get_gmtoff(t, &p);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001557 janname[9] = '\0';
1558 t += YEAR/2;
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04001559 _PyTime_localtime(t, &p);
1560 get_zone(julyname, 9, &p);
1561 julyzone = -get_gmtoff(t, &p);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 julyname[9] = '\0';
Guido van Rossum10b164a2001-09-25 13:59:01 +00001563
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001564 if( janzone < julyzone ) {
1565 /* DST is reversed in the southern hemisphere */
1566 PyModule_AddIntConstant(m, "timezone", julyzone);
1567 PyModule_AddIntConstant(m, "altzone", janzone);
1568 PyModule_AddIntConstant(m, "daylight",
1569 janzone != julyzone);
1570 PyModule_AddObject(m, "tzname",
1571 Py_BuildValue("(zz)",
1572 julyname, janname));
1573 } else {
1574 PyModule_AddIntConstant(m, "timezone", janzone);
1575 PyModule_AddIntConstant(m, "altzone", julyzone);
1576 PyModule_AddIntConstant(m, "daylight",
1577 janzone != julyzone);
1578 PyModule_AddObject(m, "tzname",
1579 Py_BuildValue("(zz)",
1580 janname, julyname));
1581 }
1582 }
Tim Peters26ae7cd2001-03-20 03:26:49 +00001583#ifdef __CYGWIN__
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 tzset();
1585 PyModule_AddIntConstant(m, "timezone", _timezone);
1586 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
1587 PyModule_AddIntConstant(m, "daylight", _daylight);
1588 PyModule_AddObject(m, "tzname",
1589 Py_BuildValue("(zz)", _tzname[0], _tzname[1]));
Tim Peters26ae7cd2001-03-20 03:26:49 +00001590#endif /* __CYGWIN__ */
Guido van Rossum10b164a2001-09-25 13:59:01 +00001591#endif /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001592}
1593
1594
1595static PyMethodDef time_methods[] = {
Victor Stinner4195b5c2012-02-08 23:03:19 +01001596 {"time", time_time, METH_NOARGS, time_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001597 {"time_ns", time_time_ns, METH_NOARGS, time_ns_doc},
Victor Stinnerec895392012-04-29 02:41:27 +02001598#ifdef PYCLOCK
Victor Stinner4195b5c2012-02-08 23:03:19 +01001599 {"clock", time_clock, METH_NOARGS, clock_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001600#endif
Victor Stinnere0be4232011-10-25 13:06:09 +02001601#ifdef HAVE_CLOCK_GETTIME
Victor Stinner4195b5c2012-02-08 23:03:19 +01001602 {"clock_gettime", time_clock_gettime, METH_VARARGS, clock_gettime_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001603 {"clock_gettime_ns",time_clock_gettime_ns, METH_VARARGS, clock_gettime_ns_doc},
Benjamin Peterson37098cd2016-09-13 22:55:09 -07001604#endif
1605#ifdef HAVE_CLOCK_SETTIME
Victor Stinner30d79472012-04-03 00:45:07 +02001606 {"clock_settime", time_clock_settime, METH_VARARGS, clock_settime_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001607 {"clock_settime_ns",time_clock_settime_ns, METH_VARARGS, clock_settime_ns_doc},
Benjamin Peterson37098cd2016-09-13 22:55:09 -07001608#endif
1609#ifdef HAVE_CLOCK_GETRES
Victor Stinner4195b5c2012-02-08 23:03:19 +01001610 {"clock_getres", time_clock_getres, METH_VARARGS, clock_getres_doc},
Victor Stinnere0be4232011-10-25 13:06:09 +02001611#endif
pdoxe14679c2017-10-05 00:01:56 -07001612#ifdef HAVE_PTHREAD_GETCPUCLOCKID
1613 {"pthread_getcpuclockid", time_pthread_getcpuclockid, METH_VARARGS, pthread_getcpuclockid_doc},
1614#endif
Victor Stinnercb29f012015-03-27 13:31:18 +01001615 {"sleep", time_sleep, METH_O, sleep_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 {"gmtime", time_gmtime, METH_VARARGS, gmtime_doc},
1617 {"localtime", time_localtime, METH_VARARGS, localtime_doc},
1618 {"asctime", time_asctime, METH_VARARGS, asctime_doc},
1619 {"ctime", time_ctime, METH_VARARGS, ctime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001620#ifdef HAVE_MKTIME
Victor Stinner4195b5c2012-02-08 23:03:19 +01001621 {"mktime", time_mktime, METH_O, mktime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001622#endif
1623#ifdef HAVE_STRFTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 {"strftime", time_strftime, METH_VARARGS, strftime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001625#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 {"strptime", time_strptime, METH_VARARGS, strptime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001627#ifdef HAVE_WORKING_TZSET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 {"tzset", time_tzset, METH_NOARGS, tzset_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001629#endif
Victor Stinnerec895392012-04-29 02:41:27 +02001630 {"monotonic", time_monotonic, METH_NOARGS, monotonic_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001631 {"monotonic_ns", time_monotonic_ns, METH_NOARGS, monotonic_ns_doc},
Victor Stinnerec895392012-04-29 02:41:27 +02001632 {"process_time", time_process_time, METH_NOARGS, process_time_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001633 {"process_time_ns", time_process_time_ns, METH_NOARGS, process_time_ns_doc},
Antoine Pitrou4bd41c92017-11-15 22:52:21 +01001634#ifdef HAVE_THREAD_TIME
1635 {"thread_time", time_thread_time, METH_NOARGS, thread_time_doc},
1636 {"thread_time_ns", time_thread_time_ns, METH_NOARGS, thread_time_ns_doc},
1637#endif
Victor Stinnerec895392012-04-29 02:41:27 +02001638 {"perf_counter", time_perf_counter, METH_NOARGS, perf_counter_doc},
Victor Stinnerc29b5852017-11-02 07:28:27 -07001639 {"perf_counter_ns", time_perf_counter_ns, METH_NOARGS, perf_counter_ns_doc},
Victor Stinnerec895392012-04-29 02:41:27 +02001640 {"get_clock_info", time_get_clock_info, METH_VARARGS, get_clock_info_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001641 {NULL, NULL} /* sentinel */
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001642};
1643
1644
1645PyDoc_STRVAR(module_doc,
1646"This module provides various functions to manipulate time values.\n\
1647\n\
1648There are two standard representations of time. One is the number\n\
1649of seconds since the Epoch, in UTC (a.k.a. GMT). It may be an integer\n\
1650or a floating point number (to represent fractions of seconds).\n\
1651The Epoch is system-defined; on Unix, it is generally January 1st, 1970.\n\
1652The actual value can be retrieved by calling gmtime(0).\n\
1653\n\
1654The other representation is a tuple of 9 integers giving local time.\n\
1655The tuple items are:\n\
Alexander Belopolsky03163ac2011-05-02 12:20:52 -04001656 year (including century, e.g. 1998)\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001657 month (1-12)\n\
1658 day (1-31)\n\
1659 hours (0-23)\n\
1660 minutes (0-59)\n\
1661 seconds (0-59)\n\
1662 weekday (0-6, Monday is 0)\n\
1663 Julian day (day in the year, 1-366)\n\
1664 DST (Daylight Savings Time) flag (-1, 0 or 1)\n\
1665If the DST flag is 0, the time is given in the regular time zone;\n\
1666if it is 1, the time is given in the DST time zone;\n\
Cheryl Sabella703ff382017-10-11 09:29:14 -04001667if it is -1, mktime() should guess based on the date and time.\n");
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001668
1669
Martin v. Löwis1a214512008-06-11 05:26:20 +00001670
1671static struct PyModuleDef timemodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 PyModuleDef_HEAD_INIT,
1673 "time",
1674 module_doc,
1675 -1,
1676 time_methods,
1677 NULL,
1678 NULL,
1679 NULL,
1680 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001681};
1682
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001683PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00001684PyInit_time(void)
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001685{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001686 PyObject *m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001687 m = PyModule_Create(&timemodule);
1688 if (m == NULL)
1689 return NULL;
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 /* Set, or reset, module variables like time.timezone */
1692 PyInit_timezone(m);
Guido van Rossumd11b62e2003-03-14 21:51:36 +00001693
Benjamin Peterson37098cd2016-09-13 22:55:09 -07001694#ifdef CLOCK_REALTIME
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -04001695 PyModule_AddIntMacro(m, CLOCK_REALTIME);
Benjamin Peterson37098cd2016-09-13 22:55:09 -07001696#endif
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -04001697#ifdef CLOCK_MONOTONIC
1698 PyModule_AddIntMacro(m, CLOCK_MONOTONIC);
1699#endif
1700#ifdef CLOCK_MONOTONIC_RAW
1701 PyModule_AddIntMacro(m, CLOCK_MONOTONIC_RAW);
1702#endif
1703#ifdef CLOCK_HIGHRES
1704 PyModule_AddIntMacro(m, CLOCK_HIGHRES);
1705#endif
1706#ifdef CLOCK_PROCESS_CPUTIME_ID
1707 PyModule_AddIntMacro(m, CLOCK_PROCESS_CPUTIME_ID);
1708#endif
1709#ifdef CLOCK_THREAD_CPUTIME_ID
1710 PyModule_AddIntMacro(m, CLOCK_THREAD_CPUTIME_ID);
1711#endif
Victor Stinnera64ce972017-11-02 04:19:19 -07001712#ifdef CLOCK_PROF
1713 PyModule_AddIntMacro(m, CLOCK_PROF);
1714#endif
1715#ifdef CLOCK_BOOTTIME
1716 PyModule_AddIntMacro(m, CLOCK_BOOTTIME);
1717#endif
1718#ifdef CLOCK_UPTIME
1719 PyModule_AddIntMacro(m, CLOCK_UPTIME);
1720#endif
Alexander Belopolsky18f3a9b2016-09-11 22:55:16 -04001721
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001722 if (!initialized) {
Victor Stinner1c8f0592013-07-22 22:24:54 +02001723 if (PyStructSequence_InitType2(&StructTimeType,
1724 &struct_time_type_desc) < 0)
1725 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001726 }
1727 Py_INCREF(&StructTimeType);
Alexander Belopolskyc142bba2012-06-13 22:15:26 -04001728 PyModule_AddIntConstant(m, "_STRUCT_TM_ITEMS", 11);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001729 PyModule_AddObject(m, "struct_time", (PyObject*) &StructTimeType);
1730 initialized = 1;
1731 return m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001732}
1733
Victor Stinnercb29f012015-03-27 13:31:18 +01001734/* Implement pysleep() for various platforms.
Guido van Rossumb6775db1994-08-01 11:34:53 +00001735 When interrupted (or when another error occurs), return -1 and
1736 set an exception; else return 0. */
1737
1738static int
Victor Stinnercb29f012015-03-27 13:31:18 +01001739pysleep(_PyTime_t secs)
Guido van Rossum426035c1991-02-19 12:27:35 +00001740{
Victor Stinnercb29f012015-03-27 13:31:18 +01001741 _PyTime_t deadline, monotonic;
Victor Stinner79d68f92015-03-19 21:54:09 +01001742#ifndef MS_WINDOWS
1743 struct timeval timeout;
Victor Stinner79d68f92015-03-19 21:54:09 +01001744 int err = 0;
1745#else
Victor Stinnercb29f012015-03-27 13:31:18 +01001746 _PyTime_t millisecs;
Victor Stinner79d68f92015-03-19 21:54:09 +01001747 unsigned long ul_millis;
1748 DWORD rc;
1749 HANDLE hInterruptEvent;
Victor Stinner0c2fd892015-03-17 10:49:17 +01001750#endif
Victor Stinner79d68f92015-03-19 21:54:09 +01001751
Victor Stinnercb29f012015-03-27 13:31:18 +01001752 deadline = _PyTime_GetMonotonicClock() + secs;
Victor Stinner79d68f92015-03-19 21:54:09 +01001753
1754 do {
1755#ifndef MS_WINDOWS
Victor Stinner869e1772015-03-30 03:49:14 +02001756 if (_PyTime_AsTimeval(secs, &timeout, _PyTime_ROUND_CEILING) < 0)
Victor Stinnercb29f012015-03-27 13:31:18 +01001757 return -1;
Victor Stinner79d68f92015-03-19 21:54:09 +01001758
1759 Py_BEGIN_ALLOW_THREADS
1760 err = select(0, (fd_set *)0, (fd_set *)0, (fd_set *)0, &timeout);
1761 Py_END_ALLOW_THREADS
1762
1763 if (err == 0)
1764 break;
1765
1766 if (errno != EINTR) {
Victor Stinner0c2fd892015-03-17 10:49:17 +01001767 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001768 return -1;
1769 }
Victor Stinner79d68f92015-03-19 21:54:09 +01001770#else
Victor Stinner869e1772015-03-30 03:49:14 +02001771 millisecs = _PyTime_AsMilliseconds(secs, _PyTime_ROUND_CEILING);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001772 if (millisecs > (double)ULONG_MAX) {
1773 PyErr_SetString(PyExc_OverflowError,
1774 "sleep length is too large");
1775 return -1;
1776 }
Victor Stinner79d68f92015-03-19 21:54:09 +01001777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001778 /* Allow sleep(0) to maintain win32 semantics, and as decreed
1779 * by Guido, only the main thread can be interrupted.
1780 */
1781 ul_millis = (unsigned long)millisecs;
Victor Stinner79d68f92015-03-19 21:54:09 +01001782 if (ul_millis == 0 || !_PyOS_IsMainThread()) {
1783 Py_BEGIN_ALLOW_THREADS
Victor Stinner0eac1302015-03-20 03:06:12 +01001784 Sleep(ul_millis);
Victor Stinner79d68f92015-03-19 21:54:09 +01001785 Py_END_ALLOW_THREADS
1786 break;
Victor Stinner945c82e2015-03-12 16:19:01 +01001787 }
Victor Stinner79d68f92015-03-19 21:54:09 +01001788
1789 hInterruptEvent = _PyOS_SigintEvent();
1790 ResetEvent(hInterruptEvent);
1791
1792 Py_BEGIN_ALLOW_THREADS
1793 rc = WaitForSingleObjectEx(hInterruptEvent, ul_millis, FALSE);
Victor Stinner0c2fd892015-03-17 10:49:17 +01001794 Py_END_ALLOW_THREADS
Victor Stinner79d68f92015-03-19 21:54:09 +01001795
1796 if (rc != WAIT_OBJECT_0)
1797 break;
Victor Stinner945c82e2015-03-12 16:19:01 +01001798#endif
Victor Stinner0c2fd892015-03-17 10:49:17 +01001799
Victor Stinner79d68f92015-03-19 21:54:09 +01001800 /* sleep was interrupted by SIGINT */
1801 if (PyErr_CheckSignals())
1802 return -1;
1803
Victor Stinnercb29f012015-03-27 13:31:18 +01001804 monotonic = _PyTime_GetMonotonicClock();
1805 secs = deadline - monotonic;
Victor Stinner6aa446c2015-03-30 21:33:51 +02001806 if (secs < 0)
Victor Stinner79d68f92015-03-19 21:54:09 +01001807 break;
1808 /* retry with the recomputed delay */
1809 } while (1);
1810
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001811 return 0;
Guido van Rossum80c9d881991-04-16 08:47:51 +00001812}