Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1 | /* Time module */ |
| 2 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 3 | #include "Python.h" |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 4 | |
Guido van Rossum | 87ce7bb | 1998-06-09 16:30:31 +0000 | [diff] [blame] | 5 | #include <ctype.h> |
| 6 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 7 | #ifdef HAVE_SYS_TIMES_H |
| 8 | #include <sys/times.h> |
| 9 | #endif |
| 10 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 11 | #ifdef HAVE_SYS_TYPES_H |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 12 | #include <sys/types.h> |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 13 | #endif |
| 14 | |
| 15 | #if defined(HAVE_SYS_RESOURCE_H) |
| 16 | #include <sys/resource.h> |
| 17 | #endif |
Guido van Rossum | 6d946f9 | 1992-08-14 13:49:30 +0000 | [diff] [blame] | 18 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 19 | #ifdef QUICKWIN |
| 20 | #include <io.h> |
| 21 | #endif |
| 22 | |
pdox | e14679c | 2017-10-05 00:01:56 -0700 | [diff] [blame] | 23 | #if defined(HAVE_PTHREAD_H) |
| 24 | # include <pthread.h> |
| 25 | #endif |
| 26 | |
Guido van Rossum | 7bf22de | 1997-12-02 20:34:19 +0000 | [diff] [blame] | 27 | #if defined(__WATCOMC__) && !defined(__QNX__) |
Guido van Rossum | bceeac8 | 1996-05-23 22:53:47 +0000 | [diff] [blame] | 28 | #include <i86.h> |
| 29 | #else |
Guido van Rossum | cac6c72 | 1996-09-06 13:34:02 +0000 | [diff] [blame] | 30 | #ifdef MS_WINDOWS |
Mark Hammond | 975e392 | 2002-07-16 01:29:19 +0000 | [diff] [blame] | 31 | #define WIN32_LEAN_AND_MEAN |
Guido van Rossum | 258ccd4 | 2001-03-02 06:53:29 +0000 | [diff] [blame] | 32 | #include <windows.h> |
Mark Hammond | 975e392 | 2002-07-16 01:29:19 +0000 | [diff] [blame] | 33 | #include "pythread.h" |
Guido van Rossum | cac6c72 | 1996-09-06 13:34:02 +0000 | [diff] [blame] | 34 | #endif /* MS_WINDOWS */ |
Guido van Rossum | 7bf22de | 1997-12-02 20:34:19 +0000 | [diff] [blame] | 35 | #endif /* !__WATCOMC__ || __QNX__ */ |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 36 | |
Gregory P. Smith | b474e67 | 2018-12-30 17:05:36 -0800 | [diff] [blame] | 37 | #ifdef _Py_MEMORY_SANITIZER |
| 38 | # include <sanitizer/msan_interface.h> |
| 39 | #endif |
| 40 | |
Zackery Spytz | 6673dec | 2019-02-25 16:56:44 -0700 | [diff] [blame] | 41 | #ifdef _MSC_VER |
| 42 | #define _Py_timezone _timezone |
| 43 | #define _Py_daylight _daylight |
| 44 | #define _Py_tzname _tzname |
| 45 | #else |
| 46 | #define _Py_timezone timezone |
| 47 | #define _Py_daylight daylight |
| 48 | #define _Py_tzname tzname |
| 49 | #endif |
| 50 | |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 51 | #define SEC_TO_NS (1000 * 1000 * 1000) |
| 52 | |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 53 | /* Forward declarations */ |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 54 | static int pysleep(_PyTime_t); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 55 | |
Victor Stinner | 85fdfa8 | 2012-01-27 00:38:48 +0100 | [diff] [blame] | 56 | |
Victor Stinner | a997c7b | 2017-10-10 02:51:50 -0700 | [diff] [blame] | 57 | static PyObject* |
| 58 | _PyFloat_FromPyTime(_PyTime_t t) |
| 59 | { |
| 60 | double d = _PyTime_AsSecondsDouble(t); |
| 61 | return PyFloat_FromDouble(d); |
| 62 | } |
| 63 | |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 64 | |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 65 | static PyObject * |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 66 | time_time(PyObject *self, PyObject *unused) |
Victor Stinner | 85fdfa8 | 2012-01-27 00:38:48 +0100 | [diff] [blame] | 67 | { |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 68 | _PyTime_t t = _PyTime_GetSystemClock(); |
| 69 | return _PyFloat_FromPyTime(t); |
| 70 | } |
| 71 | |
| 72 | |
| 73 | PyDoc_STRVAR(time_doc, |
| 74 | "time() -> floating point number\n\ |
| 75 | \n\ |
| 76 | Return the current time in seconds since the Epoch.\n\ |
| 77 | Fractions of a second may be present if the system clock provides them."); |
| 78 | |
| 79 | static PyObject * |
| 80 | time_time_ns(PyObject *self, PyObject *unused) |
| 81 | { |
| 82 | _PyTime_t t = _PyTime_GetSystemClock(); |
| 83 | return _PyTime_AsNanosecondsObject(t); |
| 84 | } |
| 85 | |
| 86 | PyDoc_STRVAR(time_ns_doc, |
| 87 | "time_ns() -> int\n\ |
| 88 | \n\ |
| 89 | Return the current time in nanoseconds since the Epoch."); |
| 90 | |
| 91 | #if defined(HAVE_CLOCK) |
| 92 | |
| 93 | #ifndef CLOCKS_PER_SEC |
| 94 | # ifdef CLK_TCK |
| 95 | # define CLOCKS_PER_SEC CLK_TCK |
| 96 | # else |
| 97 | # define CLOCKS_PER_SEC 1000000 |
| 98 | # endif |
| 99 | #endif |
| 100 | |
| 101 | static int |
| 102 | _PyTime_GetClockWithInfo(_PyTime_t *tp, _Py_clock_info_t *info) |
| 103 | { |
| 104 | static int initialized = 0; |
| 105 | clock_t ticks; |
| 106 | |
| 107 | if (!initialized) { |
| 108 | initialized = 1; |
| 109 | |
| 110 | /* must sure that _PyTime_MulDiv(ticks, SEC_TO_NS, CLOCKS_PER_SEC) |
| 111 | above cannot overflow */ |
| 112 | if ((_PyTime_t)CLOCKS_PER_SEC > _PyTime_MAX / SEC_TO_NS) { |
| 113 | PyErr_SetString(PyExc_OverflowError, |
| 114 | "CLOCKS_PER_SEC is too large"); |
| 115 | return -1; |
| 116 | } |
Victor Stinner | 85fdfa8 | 2012-01-27 00:38:48 +0100 | [diff] [blame] | 117 | } |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 118 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 119 | if (info) { |
| 120 | info->implementation = "clock()"; |
| 121 | info->resolution = 1.0 / (double)CLOCKS_PER_SEC; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 122 | info->monotonic = 1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 123 | info->adjustable = 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 124 | } |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 125 | |
| 126 | ticks = clock(); |
| 127 | if (ticks == (clock_t)-1) { |
| 128 | PyErr_SetString(PyExc_RuntimeError, |
| 129 | "the processor time used is not available " |
| 130 | "or its value cannot be represented"); |
| 131 | return -1; |
| 132 | } |
| 133 | *tp = _PyTime_MulDiv(ticks, SEC_TO_NS, (_PyTime_t)CLOCKS_PER_SEC); |
| 134 | return 0; |
Victor Stinner | 85fdfa8 | 2012-01-27 00:38:48 +0100 | [diff] [blame] | 135 | } |
| 136 | #endif /* HAVE_CLOCK */ |
| 137 | |
Victor Stinner | cba9a0c | 2017-10-12 08:51:56 -0700 | [diff] [blame] | 138 | static PyObject* |
| 139 | perf_counter(_Py_clock_info_t *info) |
| 140 | { |
Victor Stinner | bdaeb7d | 2017-10-16 08:44:31 -0700 | [diff] [blame] | 141 | _PyTime_t t; |
| 142 | if (_PyTime_GetPerfCounterWithInfo(&t, info) < 0) { |
Victor Stinner | cba9a0c | 2017-10-12 08:51:56 -0700 | [diff] [blame] | 143 | return NULL; |
| 144 | } |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 145 | return _PyFloat_FromPyTime(t); |
Victor Stinner | cba9a0c | 2017-10-12 08:51:56 -0700 | [diff] [blame] | 146 | } |
| 147 | |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 148 | #ifdef HAVE_CLOCK_GETTIME |
| 149 | static PyObject * |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 150 | time_clock_gettime(PyObject *self, PyObject *args) |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 151 | { |
| 152 | int ret; |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 153 | struct timespec tp; |
| 154 | |
Michael Felt | e2926b7 | 2018-12-28 14:57:37 +0100 | [diff] [blame] | 155 | #if defined(_AIX) && (SIZEOF_LONG == 8) |
| 156 | long clk_id; |
| 157 | if (!PyArg_ParseTuple(args, "l:clock_gettime", &clk_id)) { |
| 158 | #else |
| 159 | int clk_id; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 160 | if (!PyArg_ParseTuple(args, "i:clock_gettime", &clk_id)) { |
Michael Felt | e2926b7 | 2018-12-28 14:57:37 +0100 | [diff] [blame] | 161 | #endif |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 162 | return NULL; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 163 | } |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 164 | |
| 165 | ret = clock_gettime((clockid_t)clk_id, &tp); |
Antoine Pitrou | 2c08560 | 2012-01-18 01:41:44 +0100 | [diff] [blame] | 166 | if (ret != 0) { |
Victor Stinner | a734af3 | 2014-07-31 13:07:17 +0200 | [diff] [blame] | 167 | PyErr_SetFromErrno(PyExc_OSError); |
Antoine Pitrou | 2c08560 | 2012-01-18 01:41:44 +0100 | [diff] [blame] | 168 | return NULL; |
| 169 | } |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 170 | return PyFloat_FromDouble(tp.tv_sec + tp.tv_nsec * 1e-9); |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | PyDoc_STRVAR(clock_gettime_doc, |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 174 | "clock_gettime(clk_id) -> float\n\ |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 175 | \n\ |
| 176 | Return the time of the specified clock clk_id."); |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 177 | |
| 178 | static PyObject * |
| 179 | time_clock_gettime_ns(PyObject *self, PyObject *args) |
| 180 | { |
| 181 | int ret; |
| 182 | int clk_id; |
| 183 | struct timespec ts; |
| 184 | _PyTime_t t; |
| 185 | |
| 186 | if (!PyArg_ParseTuple(args, "i:clock_gettime", &clk_id)) { |
| 187 | return NULL; |
| 188 | } |
| 189 | |
| 190 | ret = clock_gettime((clockid_t)clk_id, &ts); |
| 191 | if (ret != 0) { |
| 192 | PyErr_SetFromErrno(PyExc_OSError); |
| 193 | return NULL; |
| 194 | } |
| 195 | if (_PyTime_FromTimespec(&t, &ts) < 0) { |
| 196 | return NULL; |
| 197 | } |
| 198 | return _PyTime_AsNanosecondsObject(t); |
| 199 | } |
| 200 | |
| 201 | PyDoc_STRVAR(clock_gettime_ns_doc, |
| 202 | "clock_gettime_ns(clk_id) -> int\n\ |
| 203 | \n\ |
| 204 | Return the time of the specified clock clk_id as nanoseconds."); |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 205 | #endif /* HAVE_CLOCK_GETTIME */ |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 206 | |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 207 | #ifdef HAVE_CLOCK_SETTIME |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 208 | static PyObject * |
| 209 | time_clock_settime(PyObject *self, PyObject *args) |
| 210 | { |
Victor Stinner | b8d0169 | 2012-04-13 23:44:05 +0200 | [diff] [blame] | 211 | int clk_id; |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 212 | PyObject *obj; |
Victor Stinner | b3b4544 | 2015-03-28 04:09:41 +0100 | [diff] [blame] | 213 | _PyTime_t t; |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 214 | struct timespec tp; |
| 215 | int ret; |
| 216 | |
| 217 | if (!PyArg_ParseTuple(args, "iO:clock_settime", &clk_id, &obj)) |
| 218 | return NULL; |
| 219 | |
Victor Stinner | 02937aa | 2015-03-28 05:02:39 +0100 | [diff] [blame] | 220 | if (_PyTime_FromSecondsObject(&t, obj, _PyTime_ROUND_FLOOR) < 0) |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 221 | return NULL; |
Victor Stinner | b3b4544 | 2015-03-28 04:09:41 +0100 | [diff] [blame] | 222 | |
| 223 | if (_PyTime_AsTimespec(t, &tp) == -1) |
| 224 | return NULL; |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 225 | |
| 226 | ret = clock_settime((clockid_t)clk_id, &tp); |
| 227 | if (ret != 0) { |
Victor Stinner | a734af3 | 2014-07-31 13:07:17 +0200 | [diff] [blame] | 228 | PyErr_SetFromErrno(PyExc_OSError); |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 229 | return NULL; |
| 230 | } |
| 231 | Py_RETURN_NONE; |
| 232 | } |
| 233 | |
| 234 | PyDoc_STRVAR(clock_settime_doc, |
| 235 | "clock_settime(clk_id, time)\n\ |
| 236 | \n\ |
| 237 | Set the time of the specified clock clk_id."); |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 238 | |
| 239 | static PyObject * |
| 240 | time_clock_settime_ns(PyObject *self, PyObject *args) |
| 241 | { |
| 242 | int clk_id; |
| 243 | PyObject *obj; |
| 244 | _PyTime_t t; |
| 245 | struct timespec ts; |
| 246 | int ret; |
| 247 | |
| 248 | if (!PyArg_ParseTuple(args, "iO:clock_settime", &clk_id, &obj)) { |
| 249 | return NULL; |
| 250 | } |
| 251 | |
| 252 | if (_PyTime_FromNanosecondsObject(&t, obj) < 0) { |
| 253 | return NULL; |
| 254 | } |
| 255 | if (_PyTime_AsTimespec(t, &ts) == -1) { |
| 256 | return NULL; |
| 257 | } |
| 258 | |
| 259 | ret = clock_settime((clockid_t)clk_id, &ts); |
| 260 | if (ret != 0) { |
| 261 | PyErr_SetFromErrno(PyExc_OSError); |
| 262 | return NULL; |
| 263 | } |
| 264 | Py_RETURN_NONE; |
| 265 | } |
| 266 | |
| 267 | PyDoc_STRVAR(clock_settime_ns_doc, |
| 268 | "clock_settime_ns(clk_id, time)\n\ |
| 269 | \n\ |
| 270 | Set the time of the specified clock clk_id with nanoseconds."); |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 271 | #endif /* HAVE_CLOCK_SETTIME */ |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 272 | |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 273 | #ifdef HAVE_CLOCK_GETRES |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 274 | static PyObject * |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 275 | time_clock_getres(PyObject *self, PyObject *args) |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 276 | { |
| 277 | int ret; |
Victor Stinner | b8d0169 | 2012-04-13 23:44:05 +0200 | [diff] [blame] | 278 | int clk_id; |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 279 | struct timespec tp; |
| 280 | |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 281 | if (!PyArg_ParseTuple(args, "i:clock_getres", &clk_id)) |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 282 | return NULL; |
| 283 | |
| 284 | ret = clock_getres((clockid_t)clk_id, &tp); |
Antoine Pitrou | 2c08560 | 2012-01-18 01:41:44 +0100 | [diff] [blame] | 285 | if (ret != 0) { |
Victor Stinner | a734af3 | 2014-07-31 13:07:17 +0200 | [diff] [blame] | 286 | PyErr_SetFromErrno(PyExc_OSError); |
Antoine Pitrou | 2c08560 | 2012-01-18 01:41:44 +0100 | [diff] [blame] | 287 | return NULL; |
| 288 | } |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 289 | |
| 290 | return PyFloat_FromDouble(tp.tv_sec + tp.tv_nsec * 1e-9); |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 291 | } |
| 292 | |
| 293 | PyDoc_STRVAR(clock_getres_doc, |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 294 | "clock_getres(clk_id) -> floating point number\n\ |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 295 | \n\ |
| 296 | Return the resolution (precision) of the specified clock clk_id."); |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 297 | #endif /* HAVE_CLOCK_GETRES */ |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 298 | |
pdox | e14679c | 2017-10-05 00:01:56 -0700 | [diff] [blame] | 299 | #ifdef HAVE_PTHREAD_GETCPUCLOCKID |
| 300 | static PyObject * |
| 301 | time_pthread_getcpuclockid(PyObject *self, PyObject *args) |
| 302 | { |
| 303 | unsigned long thread_id; |
| 304 | int err; |
| 305 | clockid_t clk_id; |
| 306 | if (!PyArg_ParseTuple(args, "k:pthread_getcpuclockid", &thread_id)) { |
| 307 | return NULL; |
| 308 | } |
| 309 | err = pthread_getcpuclockid((pthread_t)thread_id, &clk_id); |
| 310 | if (err) { |
| 311 | errno = err; |
| 312 | PyErr_SetFromErrno(PyExc_OSError); |
| 313 | return NULL; |
| 314 | } |
Gregory P. Smith | b474e67 | 2018-12-30 17:05:36 -0800 | [diff] [blame] | 315 | #ifdef _Py_MEMORY_SANITIZER |
| 316 | __msan_unpoison(&clk_id, sizeof(clk_id)); |
| 317 | #endif |
pdox | e14679c | 2017-10-05 00:01:56 -0700 | [diff] [blame] | 318 | return PyLong_FromLong(clk_id); |
| 319 | } |
| 320 | |
| 321 | PyDoc_STRVAR(pthread_getcpuclockid_doc, |
| 322 | "pthread_getcpuclockid(thread_id) -> int\n\ |
| 323 | \n\ |
| 324 | Return the clk_id of a thread's CPU time clock."); |
| 325 | #endif /* HAVE_PTHREAD_GETCPUCLOCKID */ |
| 326 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 327 | static PyObject * |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 328 | time_sleep(PyObject *self, PyObject *obj) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 329 | { |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 330 | _PyTime_t secs; |
Pablo Galindo | 59af94f | 2017-10-18 08:13:09 +0100 | [diff] [blame] | 331 | if (_PyTime_FromSecondsObject(&secs, obj, _PyTime_ROUND_TIMEOUT)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 332 | return NULL; |
Victor Stinner | 7f53a50 | 2011-07-05 22:00:25 +0200 | [diff] [blame] | 333 | if (secs < 0) { |
| 334 | PyErr_SetString(PyExc_ValueError, |
| 335 | "sleep length must be non-negative"); |
| 336 | return NULL; |
| 337 | } |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 338 | if (pysleep(secs) != 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 339 | return NULL; |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 340 | Py_RETURN_NONE; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 341 | } |
| 342 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 343 | PyDoc_STRVAR(sleep_doc, |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 344 | "sleep(seconds)\n\ |
| 345 | \n\ |
| 346 | Delay execution for a given number of seconds. The argument may be\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 347 | a floating point number for subsecond precision."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 348 | |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 349 | static PyStructSequence_Field struct_time_type_fields[] = { |
Alexander Belopolsky | 69f3fd0 | 2010-06-05 15:04:51 +0000 | [diff] [blame] | 350 | {"tm_year", "year, for example, 1993"}, |
| 351 | {"tm_mon", "month of year, range [1, 12]"}, |
| 352 | {"tm_mday", "day of month, range [1, 31]"}, |
| 353 | {"tm_hour", "hours, range [0, 23]"}, |
| 354 | {"tm_min", "minutes, range [0, 59]"}, |
| 355 | {"tm_sec", "seconds, range [0, 61])"}, |
| 356 | {"tm_wday", "day of week, range [0, 6], Monday is 0"}, |
| 357 | {"tm_yday", "day of year, range [1, 366]"}, |
| 358 | {"tm_isdst", "1 if summer time is in effect, 0 if not, and -1 if unknown"}, |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 359 | {"tm_zone", "abbreviation of timezone name"}, |
| 360 | {"tm_gmtoff", "offset from UTC in seconds"}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 361 | {0} |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 362 | }; |
| 363 | |
| 364 | static PyStructSequence_Desc struct_time_type_desc = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 365 | "time.struct_time", |
Alexander Belopolsky | 69f3fd0 | 2010-06-05 15:04:51 +0000 | [diff] [blame] | 366 | "The time value as returned by gmtime(), localtime(), and strptime(), and\n" |
| 367 | " accepted by asctime(), mktime() and strftime(). May be considered as a\n" |
| 368 | " sequence of 9 integers.\n\n" |
| 369 | " Note that several fields' values are not the same as those defined by\n" |
| 370 | " the C language standard for struct tm. For example, the value of the\n" |
| 371 | " field tm_year is the actual year, not year - 1900. See individual\n" |
| 372 | " fields' descriptions for details.", |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 373 | struct_time_type_fields, |
| 374 | 9, |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 375 | }; |
Tim Peters | 9ad4b68 | 2002-02-13 05:14:18 +0000 | [diff] [blame] | 376 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 377 | static int initialized; |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 378 | static PyTypeObject StructTimeType; |
| 379 | |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 380 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 381 | static PyObject * |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 382 | tmtotuple(struct tm *p |
| 383 | #ifndef HAVE_STRUCT_TM_TM_ZONE |
Victor Stinner | 0d659e5 | 2017-04-25 01:22:42 +0200 | [diff] [blame] | 384 | , const char *zone, time_t gmtoff |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 385 | #endif |
| 386 | ) |
Guido van Rossum | 87ce7bb | 1998-06-09 16:30:31 +0000 | [diff] [blame] | 387 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 388 | PyObject *v = PyStructSequence_New(&StructTimeType); |
| 389 | if (v == NULL) |
| 390 | return NULL; |
Tim Peters | 9ad4b68 | 2002-02-13 05:14:18 +0000 | [diff] [blame] | 391 | |
Christian Heimes | 217cfd1 | 2007-12-02 14:31:20 +0000 | [diff] [blame] | 392 | #define SET(i,val) PyStructSequence_SET_ITEM(v, i, PyLong_FromLong((long) val)) |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 393 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 394 | SET(0, p->tm_year + 1900); |
| 395 | SET(1, p->tm_mon + 1); /* Want January == 1 */ |
| 396 | SET(2, p->tm_mday); |
| 397 | SET(3, p->tm_hour); |
| 398 | SET(4, p->tm_min); |
| 399 | SET(5, p->tm_sec); |
| 400 | SET(6, (p->tm_wday + 6) % 7); /* Want Monday == 0 */ |
| 401 | SET(7, p->tm_yday + 1); /* Want January, 1 == 1 */ |
| 402 | SET(8, p->tm_isdst); |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 403 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
| 404 | PyStructSequence_SET_ITEM(v, 9, |
Victor Stinner | 7ed7aea | 2018-01-15 10:45:49 +0100 | [diff] [blame] | 405 | PyUnicode_DecodeLocale(p->tm_zone, "surrogateescape")); |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 406 | SET(10, p->tm_gmtoff); |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 407 | #else |
| 408 | PyStructSequence_SET_ITEM(v, 9, |
Victor Stinner | 7ed7aea | 2018-01-15 10:45:49 +0100 | [diff] [blame] | 409 | PyUnicode_DecodeLocale(zone, "surrogateescape")); |
Victor Stinner | 0d659e5 | 2017-04-25 01:22:42 +0200 | [diff] [blame] | 410 | PyStructSequence_SET_ITEM(v, 10, _PyLong_FromTime_t(gmtoff)); |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 411 | #endif /* HAVE_STRUCT_TM_TM_ZONE */ |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 412 | #undef SET |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 413 | if (PyErr_Occurred()) { |
| 414 | Py_XDECREF(v); |
| 415 | return NULL; |
| 416 | } |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 417 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 418 | return v; |
Guido van Rossum | 87ce7bb | 1998-06-09 16:30:31 +0000 | [diff] [blame] | 419 | } |
| 420 | |
Fred Drake | f901abd | 2004-08-03 17:58:55 +0000 | [diff] [blame] | 421 | /* Parse arg tuple that can contain an optional float-or-None value; |
| 422 | format needs to be "|O:name". |
| 423 | Returns non-zero on success (parallels PyArg_ParseTuple). |
| 424 | */ |
| 425 | static int |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 426 | parse_time_t_args(PyObject *args, const char *format, time_t *pwhen) |
Fred Drake | f901abd | 2004-08-03 17:58:55 +0000 | [diff] [blame] | 427 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 428 | PyObject *ot = NULL; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 429 | time_t whent; |
Fred Drake | f901abd | 2004-08-03 17:58:55 +0000 | [diff] [blame] | 430 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 431 | if (!PyArg_ParseTuple(args, format, &ot)) |
| 432 | return 0; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 433 | if (ot == NULL || ot == Py_None) { |
| 434 | whent = time(NULL); |
| 435 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 436 | else { |
Victor Stinner | 02937aa | 2015-03-28 05:02:39 +0100 | [diff] [blame] | 437 | if (_PyTime_ObjectToTime_t(ot, &whent, _PyTime_ROUND_FLOOR) == -1) |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 438 | return 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 439 | } |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 440 | *pwhen = whent; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 441 | return 1; |
Fred Drake | f901abd | 2004-08-03 17:58:55 +0000 | [diff] [blame] | 442 | } |
| 443 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 444 | static PyObject * |
Peter Schneider-Kamp | 416d413 | 2000-07-10 12:15:54 +0000 | [diff] [blame] | 445 | time_gmtime(PyObject *self, PyObject *args) |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 446 | { |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 447 | time_t when; |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 448 | struct tm buf; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 449 | |
| 450 | if (!parse_time_t_args(args, "|O:gmtime", &when)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 451 | return NULL; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 452 | |
| 453 | errno = 0; |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 454 | if (_PyTime_gmtime(when, &buf) != 0) |
| 455 | return NULL; |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 456 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 457 | return tmtotuple(&buf); |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 458 | #else |
| 459 | return tmtotuple(&buf, "UTC", 0); |
| 460 | #endif |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 461 | } |
| 462 | |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 463 | #ifndef HAVE_TIMEGM |
| 464 | static time_t |
| 465 | timegm(struct tm *p) |
| 466 | { |
| 467 | /* XXX: the following implementation will not work for tm_year < 1970. |
| 468 | but it is likely that platforms that don't have timegm do not support |
| 469 | negative timestamps anyways. */ |
| 470 | return p->tm_sec + p->tm_min*60 + p->tm_hour*3600 + p->tm_yday*86400 + |
| 471 | (p->tm_year-70)*31536000 + ((p->tm_year-69)/4)*86400 - |
| 472 | ((p->tm_year-1)/100)*86400 + ((p->tm_year+299)/400)*86400; |
| 473 | } |
| 474 | #endif |
| 475 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 476 | PyDoc_STRVAR(gmtime_doc, |
Christian Heimes | 9a37159 | 2007-12-28 14:08:13 +0000 | [diff] [blame] | 477 | "gmtime([seconds]) -> (tm_year, tm_mon, tm_mday, tm_hour, tm_min,\n\ |
Fred Drake | 193a3f6 | 2002-03-12 21:38:49 +0000 | [diff] [blame] | 478 | tm_sec, tm_wday, tm_yday, tm_isdst)\n\ |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 479 | \n\ |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 480 | Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.\n\ |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 481 | GMT). When 'seconds' is not passed in, convert the current time instead.\n\ |
| 482 | \n\ |
| 483 | If the platform supports the tm_gmtoff and tm_zone, they are available as\n\ |
| 484 | attributes only."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 485 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 486 | static PyObject * |
Peter Schneider-Kamp | 416d413 | 2000-07-10 12:15:54 +0000 | [diff] [blame] | 487 | time_localtime(PyObject *self, PyObject *args) |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 488 | { |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 489 | time_t when; |
| 490 | struct tm buf; |
| 491 | |
| 492 | if (!parse_time_t_args(args, "|O:localtime", &when)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 493 | return NULL; |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 494 | if (_PyTime_localtime(when, &buf) != 0) |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 495 | return NULL; |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 496 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 497 | return tmtotuple(&buf); |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 498 | #else |
| 499 | { |
| 500 | struct tm local = buf; |
| 501 | char zone[100]; |
Victor Stinner | 0d659e5 | 2017-04-25 01:22:42 +0200 | [diff] [blame] | 502 | time_t gmtoff; |
Steve Dower | c3c6f71 | 2016-12-14 11:22:05 -0800 | [diff] [blame] | 503 | strftime(zone, sizeof(zone), "%Z", &buf); |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 504 | gmtoff = timegm(&buf) - when; |
| 505 | return tmtotuple(&local, zone, gmtoff); |
| 506 | } |
| 507 | #endif |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 508 | } |
| 509 | |
Benjamin Peterson | 5633c4f | 2018-09-14 09:09:04 -0700 | [diff] [blame] | 510 | #if defined(__linux__) && !defined(__GLIBC__) |
| 511 | static const char *utc_string = NULL; |
| 512 | #endif |
| 513 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 514 | PyDoc_STRVAR(localtime_doc, |
Christian Heimes | 9a37159 | 2007-12-28 14:08:13 +0000 | [diff] [blame] | 515 | "localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,\n\ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 516 | tm_sec,tm_wday,tm_yday,tm_isdst)\n\ |
Martin v. Löwis | b3cfc1d | 2001-12-02 12:27:43 +0000 | [diff] [blame] | 517 | \n\ |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 518 | Convert seconds since the Epoch to a time tuple expressing local time.\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 519 | When 'seconds' is not passed in, convert the current time instead."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 520 | |
Alexander Belopolsky | 38e2996 | 2010-10-01 14:18:49 +0000 | [diff] [blame] | 521 | /* Convert 9-item tuple to tm structure. Return 1 on success, set |
| 522 | * an exception and return 0 on error. |
| 523 | */ |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 524 | static int |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 525 | gettmarg(PyObject *args, struct tm *p, const char *format) |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 526 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 527 | int y; |
Guido van Rossum | cfbaecc | 1998-08-25 14:51:12 +0000 | [diff] [blame] | 528 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 529 | memset((void *) p, '\0', sizeof(struct tm)); |
Guido van Rossum | b908126 | 2007-08-25 03:14:09 +0000 | [diff] [blame] | 530 | |
Alexander Belopolsky | 610e544 | 2011-01-06 21:57:06 +0000 | [diff] [blame] | 531 | if (!PyTuple_Check(args)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 532 | PyErr_SetString(PyExc_TypeError, |
| 533 | "Tuple or struct_time argument required"); |
| 534 | return 0; |
| 535 | } |
Skip Montanaro | 41cfce9 | 2007-08-24 21:11:00 +0000 | [diff] [blame] | 536 | |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 537 | if (!PyArg_ParseTuple(args, format, |
Alexander Belopolsky | 610e544 | 2011-01-06 21:57:06 +0000 | [diff] [blame] | 538 | &y, &p->tm_mon, &p->tm_mday, |
| 539 | &p->tm_hour, &p->tm_min, &p->tm_sec, |
| 540 | &p->tm_wday, &p->tm_yday, &p->tm_isdst)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 541 | return 0; |
Gregory P. Smith | 76be0ff | 2018-08-24 18:08:50 -0700 | [diff] [blame] | 542 | |
| 543 | if (y < INT_MIN + 1900) { |
| 544 | PyErr_SetString(PyExc_OverflowError, "year out of range"); |
| 545 | return 0; |
| 546 | } |
| 547 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 548 | p->tm_year = y - 1900; |
| 549 | p->tm_mon--; |
| 550 | p->tm_wday = (p->tm_wday + 1) % 7; |
| 551 | p->tm_yday--; |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 552 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
| 553 | if (Py_TYPE(args) == &StructTimeType) { |
| 554 | PyObject *item; |
Victor Stinner | 1cdfcfc | 2018-11-28 15:19:51 +0100 | [diff] [blame] | 555 | item = PyStructSequence_GET_ITEM(args, 9); |
Benjamin Peterson | 5633c4f | 2018-09-14 09:09:04 -0700 | [diff] [blame] | 556 | if (item != Py_None) { |
Xiang Zhang | 163eca3 | 2018-10-28 23:58:42 +0800 | [diff] [blame] | 557 | p->tm_zone = (char *)PyUnicode_AsUTF8(item); |
Benjamin Peterson | 5633c4f | 2018-09-14 09:09:04 -0700 | [diff] [blame] | 558 | if (p->tm_zone == NULL) { |
| 559 | return 0; |
| 560 | } |
| 561 | #if defined(__linux__) && !defined(__GLIBC__) |
| 562 | // Make an attempt to return the C library's own timezone strings to |
| 563 | // it. musl refuses to process a tm_zone field unless it produced |
| 564 | // it. See issue #34672. |
| 565 | if (utc_string && strcmp(p->tm_zone, utc_string) == 0) { |
| 566 | p->tm_zone = utc_string; |
| 567 | } |
| 568 | else if (tzname[0] && strcmp(p->tm_zone, tzname[0]) == 0) { |
| 569 | p->tm_zone = tzname[0]; |
| 570 | } |
| 571 | else if (tzname[1] && strcmp(p->tm_zone, tzname[1]) == 0) { |
| 572 | p->tm_zone = tzname[1]; |
| 573 | } |
| 574 | #endif |
| 575 | } |
Victor Stinner | 1cdfcfc | 2018-11-28 15:19:51 +0100 | [diff] [blame] | 576 | item = PyStructSequence_GET_ITEM(args, 10); |
Benjamin Peterson | 5633c4f | 2018-09-14 09:09:04 -0700 | [diff] [blame] | 577 | if (item != Py_None) { |
| 578 | p->tm_gmtoff = PyLong_AsLong(item); |
| 579 | if (PyErr_Occurred()) |
| 580 | return 0; |
| 581 | } |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 582 | } |
| 583 | #endif /* HAVE_STRUCT_TM_TM_ZONE */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 584 | return 1; |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 585 | } |
| 586 | |
Alexander Belopolsky | 38e2996 | 2010-10-01 14:18:49 +0000 | [diff] [blame] | 587 | /* Check values of the struct tm fields before it is passed to strftime() and |
| 588 | * asctime(). Return 1 if all values are valid, otherwise set an exception |
| 589 | * and returns 0. |
| 590 | */ |
Victor Stinner | ef12810 | 2010-10-07 01:00:52 +0000 | [diff] [blame] | 591 | static int |
| 592 | checktm(struct tm* buf) |
Alexander Belopolsky | 38e2996 | 2010-10-01 14:18:49 +0000 | [diff] [blame] | 593 | { |
Victor Stinner | ef12810 | 2010-10-07 01:00:52 +0000 | [diff] [blame] | 594 | /* Checks added to make sure strftime() and asctime() does not crash Python by |
| 595 | indexing blindly into some array for a textual representation |
| 596 | by some bad index (fixes bug #897625 and #6608). |
| 597 | |
| 598 | Also support values of zero from Python code for arguments in which |
| 599 | that is out of range by forcing that value to the lowest value that |
| 600 | is valid (fixed bug #1520914). |
| 601 | |
| 602 | Valid ranges based on what is allowed in struct tm: |
| 603 | |
| 604 | - tm_year: [0, max(int)] (1) |
| 605 | - tm_mon: [0, 11] (2) |
| 606 | - tm_mday: [1, 31] |
| 607 | - tm_hour: [0, 23] |
| 608 | - tm_min: [0, 59] |
| 609 | - tm_sec: [0, 60] |
| 610 | - tm_wday: [0, 6] (1) |
| 611 | - tm_yday: [0, 365] (2) |
| 612 | - tm_isdst: [-max(int), max(int)] |
| 613 | |
| 614 | (1) gettmarg() handles bounds-checking. |
| 615 | (2) Python's acceptable range is one greater than the range in C, |
Alexander Belopolsky | 38e2996 | 2010-10-01 14:18:49 +0000 | [diff] [blame] | 616 | thus need to check against automatic decrement by gettmarg(). |
| 617 | */ |
| 618 | if (buf->tm_mon == -1) |
| 619 | buf->tm_mon = 0; |
| 620 | else if (buf->tm_mon < 0 || buf->tm_mon > 11) { |
| 621 | PyErr_SetString(PyExc_ValueError, "month out of range"); |
| 622 | return 0; |
| 623 | } |
| 624 | if (buf->tm_mday == 0) |
| 625 | buf->tm_mday = 1; |
| 626 | else if (buf->tm_mday < 0 || buf->tm_mday > 31) { |
| 627 | PyErr_SetString(PyExc_ValueError, "day of month out of range"); |
| 628 | return 0; |
| 629 | } |
| 630 | if (buf->tm_hour < 0 || buf->tm_hour > 23) { |
| 631 | PyErr_SetString(PyExc_ValueError, "hour out of range"); |
| 632 | return 0; |
| 633 | } |
| 634 | if (buf->tm_min < 0 || buf->tm_min > 59) { |
| 635 | PyErr_SetString(PyExc_ValueError, "minute out of range"); |
| 636 | return 0; |
| 637 | } |
| 638 | if (buf->tm_sec < 0 || buf->tm_sec > 61) { |
| 639 | PyErr_SetString(PyExc_ValueError, "seconds out of range"); |
| 640 | return 0; |
| 641 | } |
| 642 | /* tm_wday does not need checking of its upper-bound since taking |
| 643 | ``% 7`` in gettmarg() automatically restricts the range. */ |
| 644 | if (buf->tm_wday < 0) { |
| 645 | PyErr_SetString(PyExc_ValueError, "day of week out of range"); |
| 646 | return 0; |
| 647 | } |
| 648 | if (buf->tm_yday == -1) |
| 649 | buf->tm_yday = 0; |
| 650 | else if (buf->tm_yday < 0 || buf->tm_yday > 365) { |
| 651 | PyErr_SetString(PyExc_ValueError, "day of year out of range"); |
| 652 | return 0; |
| 653 | } |
| 654 | return 1; |
| 655 | } |
| 656 | |
Victor Stinner | c1f32ca | 2011-10-14 02:36:13 +0200 | [diff] [blame] | 657 | #ifdef MS_WINDOWS |
| 658 | /* wcsftime() doesn't format correctly time zones, see issue #10653 */ |
| 659 | # undef HAVE_WCSFTIME |
| 660 | #endif |
Alexander Belopolsky | cf77454 | 2012-10-02 18:39:16 -0400 | [diff] [blame] | 661 | #define STRFTIME_FORMAT_CODES \ |
| 662 | "Commonly used format codes:\n\ |
| 663 | \n\ |
| 664 | %Y Year with century as a decimal number.\n\ |
| 665 | %m Month as a decimal number [01,12].\n\ |
| 666 | %d Day of the month as a decimal number [01,31].\n\ |
| 667 | %H Hour (24-hour clock) as a decimal number [00,23].\n\ |
| 668 | %M Minute as a decimal number [00,59].\n\ |
| 669 | %S Second as a decimal number [00,61].\n\ |
| 670 | %z Time zone offset from UTC.\n\ |
| 671 | %a Locale's abbreviated weekday name.\n\ |
| 672 | %A Locale's full weekday name.\n\ |
| 673 | %b Locale's abbreviated month name.\n\ |
| 674 | %B Locale's full month name.\n\ |
| 675 | %c Locale's appropriate date and time representation.\n\ |
| 676 | %I Hour (12-hour clock) as a decimal number [01,12].\n\ |
| 677 | %p Locale's equivalent of either AM or PM.\n\ |
| 678 | \n\ |
| 679 | Other codes may be available on your platform. See documentation for\n\ |
| 680 | the C library strftime function.\n" |
Victor Stinner | c1f32ca | 2011-10-14 02:36:13 +0200 | [diff] [blame] | 681 | |
Guido van Rossum | 8d8c1ee | 1995-09-13 17:38:35 +0000 | [diff] [blame] | 682 | #ifdef HAVE_STRFTIME |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 683 | #ifdef HAVE_WCSFTIME |
| 684 | #define time_char wchar_t |
| 685 | #define format_time wcsftime |
| 686 | #define time_strlen wcslen |
| 687 | #else |
| 688 | #define time_char char |
| 689 | #define format_time strftime |
| 690 | #define time_strlen strlen |
| 691 | #endif |
| 692 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 693 | static PyObject * |
Peter Schneider-Kamp | 416d413 | 2000-07-10 12:15:54 +0000 | [diff] [blame] | 694 | time_strftime(PyObject *self, PyObject *args) |
Guido van Rossum | 8d8c1ee | 1995-09-13 17:38:35 +0000 | [diff] [blame] | 695 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 696 | PyObject *tup = NULL; |
| 697 | struct tm buf; |
| 698 | const time_char *fmt; |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 699 | #ifdef HAVE_WCSFTIME |
| 700 | wchar_t *format; |
| 701 | #else |
| 702 | PyObject *format; |
| 703 | #endif |
Victor Stinner | ef12810 | 2010-10-07 01:00:52 +0000 | [diff] [blame] | 704 | PyObject *format_arg; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 705 | size_t fmtlen, buflen; |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 706 | time_char *outbuf = NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 707 | size_t i; |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 708 | PyObject *ret = NULL; |
Guido van Rossum | 8d8c1ee | 1995-09-13 17:38:35 +0000 | [diff] [blame] | 709 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 710 | memset((void *) &buf, '\0', sizeof(buf)); |
Guido van Rossum | 1f41f84 | 1998-04-27 19:04:26 +0000 | [diff] [blame] | 711 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 712 | /* Will always expect a unicode string to be passed as format. |
| 713 | Given that there's no str type anymore in py3k this seems safe. |
| 714 | */ |
Victor Stinner | ef12810 | 2010-10-07 01:00:52 +0000 | [diff] [blame] | 715 | if (!PyArg_ParseTuple(args, "U|O:strftime", &format_arg, &tup)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 716 | return NULL; |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 717 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 718 | if (tup == NULL) { |
| 719 | time_t tt = time(NULL); |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 720 | if (_PyTime_localtime(tt, &buf) != 0) |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 721 | return NULL; |
Alexander Belopolsky | 38e2996 | 2010-10-01 14:18:49 +0000 | [diff] [blame] | 722 | } |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 723 | else if (!gettmarg(tup, &buf, |
| 724 | "iiiiiiiii;strftime(): illegal time tuple argument") || |
| 725 | !checktm(&buf)) |
| 726 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 727 | return NULL; |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 728 | } |
Guido van Rossum | 10b164a | 2001-09-25 13:59:01 +0000 | [diff] [blame] | 729 | |
pxinwr | f1464f4 | 2019-04-15 17:06:21 +0800 | [diff] [blame] | 730 | #if defined(_MSC_VER) || (defined(__sun) && defined(__SVR4)) || defined(_AIX) || defined(__VXWORKS__) |
Victor Stinner | 73ea29c | 2011-01-08 01:56:31 +0000 | [diff] [blame] | 731 | if (buf.tm_year + 1900 < 1 || 9999 < buf.tm_year + 1900) { |
Victor Stinner | 6f0e4f9 | 2011-03-21 02:14:53 +0100 | [diff] [blame] | 732 | PyErr_SetString(PyExc_ValueError, |
| 733 | "strftime() requires year in [1; 9999]"); |
Alexander Belopolsky | 0dd06f4 | 2011-01-08 01:23:02 +0000 | [diff] [blame] | 734 | return NULL; |
Alexander Belopolsky | c64708a | 2011-01-07 19:59:19 +0000 | [diff] [blame] | 735 | } |
Victor Stinner | 73ea29c | 2011-01-08 01:56:31 +0000 | [diff] [blame] | 736 | #endif |
Alexander Belopolsky | c64708a | 2011-01-07 19:59:19 +0000 | [diff] [blame] | 737 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 738 | /* Normalize tm_isdst just in case someone foolishly implements %Z |
| 739 | based on the assumption that tm_isdst falls within the range of |
| 740 | [-1, 1] */ |
| 741 | if (buf.tm_isdst < -1) |
| 742 | buf.tm_isdst = -1; |
| 743 | else if (buf.tm_isdst > 1) |
| 744 | buf.tm_isdst = 1; |
Brett Cannon | d1080a3 | 2004-03-02 04:38:10 +0000 | [diff] [blame] | 745 | |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 746 | #ifdef HAVE_WCSFTIME |
Victor Stinner | beb4135b | 2010-10-07 01:02:42 +0000 | [diff] [blame] | 747 | format = PyUnicode_AsWideCharString(format_arg, NULL); |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 748 | if (format == NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 749 | return NULL; |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 750 | fmt = format; |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 751 | #else |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 752 | /* Convert the unicode string to an ascii one */ |
Victor Stinner | 1b57967 | 2011-12-17 05:47:23 +0100 | [diff] [blame] | 753 | format = PyUnicode_EncodeLocale(format_arg, "surrogateescape"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 754 | if (format == NULL) |
| 755 | return NULL; |
| 756 | fmt = PyBytes_AS_STRING(format); |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 757 | #endif |
Amaury Forgeot d'Arc | b5be6d4 | 2009-03-02 23:52:57 +0000 | [diff] [blame] | 758 | |
Stefan Krah | 4aea7d3 | 2012-02-27 16:30:26 +0100 | [diff] [blame] | 759 | #if defined(MS_WINDOWS) && !defined(HAVE_WCSFTIME) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 760 | /* check that the format string contains only valid directives */ |
Steve Dower | e5b5895 | 2015-09-06 19:20:51 -0700 | [diff] [blame] | 761 | for (outbuf = strchr(fmt, '%'); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 762 | outbuf != NULL; |
Victor Stinner | 5a3ff79 | 2011-10-16 19:08:23 +0200 | [diff] [blame] | 763 | outbuf = strchr(outbuf+2, '%')) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 764 | { |
Steve Dower | e5b5895 | 2015-09-06 19:20:51 -0700 | [diff] [blame] | 765 | if (outbuf[1] == '#') |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 766 | ++outbuf; /* not documented by python, */ |
Steve Dower | e5b5895 | 2015-09-06 19:20:51 -0700 | [diff] [blame] | 767 | if (outbuf[1] == '\0') |
| 768 | break; |
| 769 | if ((outbuf[1] == 'y') && buf.tm_year < 0) { |
Tim Golden | 6e51b8f | 2013-11-12 12:36:54 +0000 | [diff] [blame] | 770 | PyErr_SetString(PyExc_ValueError, |
| 771 | "format %y requires year >= 1900 on Windows"); |
| 772 | Py_DECREF(format); |
| 773 | return NULL; |
| 774 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 775 | } |
Jakub KulÃk | 6f9bc72 | 2018-12-31 03:16:40 +0100 | [diff] [blame] | 776 | #elif (defined(_AIX) || (defined(__sun) && defined(__SVR4))) && defined(HAVE_WCSFTIME) |
Steve Dower | e5b5895 | 2015-09-06 19:20:51 -0700 | [diff] [blame] | 777 | for (outbuf = wcschr(fmt, '%'); |
Victor Stinner | 55329f8 | 2013-11-17 23:39:21 +0100 | [diff] [blame] | 778 | outbuf != NULL; |
| 779 | outbuf = wcschr(outbuf+2, '%')) |
| 780 | { |
Steve Dower | e5b5895 | 2015-09-06 19:20:51 -0700 | [diff] [blame] | 781 | if (outbuf[1] == L'\0') |
| 782 | break; |
Victor Stinner | 55329f8 | 2013-11-17 23:39:21 +0100 | [diff] [blame] | 783 | /* Issue #19634: On AIX, wcsftime("y", (1899, 1, 1, 0, 0, 0, 0, 0, 0)) |
| 784 | returns "0/" instead of "99" */ |
| 785 | if (outbuf[1] == L'y' && buf.tm_year < 0) { |
| 786 | PyErr_SetString(PyExc_ValueError, |
| 787 | "format %y requires year >= 1900 on AIX"); |
Zackery Spytz | 91e6c87 | 2018-09-21 00:09:48 -0600 | [diff] [blame] | 788 | PyMem_Free(format); |
Victor Stinner | 55329f8 | 2013-11-17 23:39:21 +0100 | [diff] [blame] | 789 | return NULL; |
| 790 | } |
| 791 | } |
Amaury Forgeot d'Arc | b5be6d4 | 2009-03-02 23:52:57 +0000 | [diff] [blame] | 792 | #endif |
| 793 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 794 | fmtlen = time_strlen(fmt); |
Guido van Rossum | c222ec2 | 1999-02-23 00:00:10 +0000 | [diff] [blame] | 795 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 796 | /* I hate these functions that presume you know how big the output |
| 797 | * will be ahead of time... |
| 798 | */ |
| 799 | for (i = 1024; ; i += i) { |
| 800 | outbuf = (time_char *)PyMem_Malloc(i*sizeof(time_char)); |
| 801 | if (outbuf == NULL) { |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 802 | PyErr_NoMemory(); |
| 803 | break; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 804 | } |
Steve Dower | 57ab1cd | 2015-09-22 14:51:42 -0700 | [diff] [blame] | 805 | #if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__) |
| 806 | errno = 0; |
| 807 | #endif |
Steve Dower | d9ef74e | 2015-05-22 15:08:34 -0700 | [diff] [blame] | 808 | _Py_BEGIN_SUPPRESS_IPH |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 809 | buflen = format_time(outbuf, i, fmt, &buf); |
Steve Dower | d9ef74e | 2015-05-22 15:08:34 -0700 | [diff] [blame] | 810 | _Py_END_SUPPRESS_IPH |
Victor Stinner | 136ea49 | 2011-12-17 22:37:18 +0100 | [diff] [blame] | 811 | #if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__) |
Steve Dower | 97cded9 | 2015-09-08 19:12:51 -0700 | [diff] [blame] | 812 | /* VisualStudio .NET 2005 does this properly */ |
| 813 | if (buflen == 0 && errno == EINVAL) { |
| 814 | PyErr_SetString(PyExc_ValueError, "Invalid format string"); |
| 815 | PyMem_Free(outbuf); |
| 816 | break; |
| 817 | } |
Victor Stinner | 136ea49 | 2011-12-17 22:37:18 +0100 | [diff] [blame] | 818 | #endif |
Steve Dower | 97cded9 | 2015-09-08 19:12:51 -0700 | [diff] [blame] | 819 | if (buflen > 0 || i >= 256 * fmtlen) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 820 | /* If the buffer is 256 times as long as the format, |
| 821 | it's probably not failing for lack of room! |
| 822 | More likely, the format yields an empty result, |
| 823 | e.g. an empty format, or %Z when the timezone |
| 824 | is unknown. */ |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 825 | #ifdef HAVE_WCSFTIME |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 826 | ret = PyUnicode_FromWideChar(outbuf, buflen); |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 827 | #else |
Victor Stinner | 7ed7aea | 2018-01-15 10:45:49 +0100 | [diff] [blame] | 828 | ret = PyUnicode_DecodeLocaleAndSize(outbuf, buflen, "surrogateescape"); |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 829 | #endif |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 830 | PyMem_Free(outbuf); |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 831 | break; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 832 | } |
| 833 | PyMem_Free(outbuf); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 834 | } |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 835 | #ifdef HAVE_WCSFTIME |
| 836 | PyMem_Free(format); |
| 837 | #else |
| 838 | Py_DECREF(format); |
| 839 | #endif |
| 840 | return ret; |
Guido van Rossum | 8d8c1ee | 1995-09-13 17:38:35 +0000 | [diff] [blame] | 841 | } |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 842 | |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 843 | #undef time_char |
| 844 | #undef format_time |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 845 | PyDoc_STRVAR(strftime_doc, |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 846 | "strftime(format[, tuple]) -> string\n\ |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 847 | \n\ |
| 848 | Convert a time tuple to a string according to a format specification.\n\ |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 849 | See the library reference manual for formatting codes. When the time tuple\n\ |
Alexander Belopolsky | cf77454 | 2012-10-02 18:39:16 -0400 | [diff] [blame] | 850 | is not present, current time as returned by localtime() is used.\n\ |
| 851 | \n" STRFTIME_FORMAT_CODES); |
Guido van Rossum | 8d8c1ee | 1995-09-13 17:38:35 +0000 | [diff] [blame] | 852 | #endif /* HAVE_STRFTIME */ |
| 853 | |
Guido van Rossum | d3c46d5 | 2002-07-19 17:06:47 +0000 | [diff] [blame] | 854 | static PyObject * |
| 855 | time_strptime(PyObject *self, PyObject *args) |
| 856 | { |
Victor Stinner | dbe28d2 | 2016-12-09 00:38:53 +0100 | [diff] [blame] | 857 | PyObject *module, *func, *result; |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 858 | _Py_IDENTIFIER(_strptime_time); |
Guido van Rossum | d3c46d5 | 2002-07-19 17:06:47 +0000 | [diff] [blame] | 859 | |
Victor Stinner | dbe28d2 | 2016-12-09 00:38:53 +0100 | [diff] [blame] | 860 | module = PyImport_ImportModuleNoBlock("_strptime"); |
| 861 | if (!module) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 862 | return NULL; |
Victor Stinner | dbe28d2 | 2016-12-09 00:38:53 +0100 | [diff] [blame] | 863 | |
| 864 | func = _PyObject_GetAttrId(module, &PyId__strptime_time); |
| 865 | Py_DECREF(module); |
| 866 | if (!func) { |
| 867 | return NULL; |
| 868 | } |
| 869 | |
| 870 | result = PyObject_Call(func, args, NULL); |
| 871 | Py_DECREF(func); |
| 872 | return result; |
Guido van Rossum | d3c46d5 | 2002-07-19 17:06:47 +0000 | [diff] [blame] | 873 | } |
| 874 | |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 875 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 876 | PyDoc_STRVAR(strptime_doc, |
Brett Cannon | 20def8b | 2003-07-01 05:16:08 +0000 | [diff] [blame] | 877 | "strptime(string, format) -> struct_time\n\ |
Martin v. Löwis | b3cfc1d | 2001-12-02 12:27:43 +0000 | [diff] [blame] | 878 | \n\ |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 879 | Parse a string to a time tuple according to a format specification.\n\ |
Alexander Belopolsky | cf77454 | 2012-10-02 18:39:16 -0400 | [diff] [blame] | 880 | See the library reference manual for formatting codes (same as\n\ |
| 881 | strftime()).\n\ |
| 882 | \n" STRFTIME_FORMAT_CODES); |
Guido van Rossum | d3c46d5 | 2002-07-19 17:06:47 +0000 | [diff] [blame] | 883 | |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 884 | static PyObject * |
| 885 | _asctime(struct tm *timeptr) |
| 886 | { |
| 887 | /* Inspired by Open Group reference implementation available at |
| 888 | * http://pubs.opengroup.org/onlinepubs/009695399/functions/asctime.html */ |
Serhiy Storchaka | 2d06e84 | 2015-12-25 19:53:18 +0200 | [diff] [blame] | 889 | static const char wday_name[7][4] = { |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 890 | "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" |
| 891 | }; |
Serhiy Storchaka | 2d06e84 | 2015-12-25 19:53:18 +0200 | [diff] [blame] | 892 | static const char mon_name[12][4] = { |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 893 | "Jan", "Feb", "Mar", "Apr", "May", "Jun", |
| 894 | "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" |
| 895 | }; |
Victor Stinner | 499dfcf | 2011-03-21 13:26:24 +0100 | [diff] [blame] | 896 | return PyUnicode_FromFormat( |
| 897 | "%s %s%3d %.2d:%.2d:%.2d %d", |
| 898 | wday_name[timeptr->tm_wday], |
| 899 | mon_name[timeptr->tm_mon], |
| 900 | timeptr->tm_mday, timeptr->tm_hour, |
| 901 | timeptr->tm_min, timeptr->tm_sec, |
| 902 | 1900 + timeptr->tm_year); |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 903 | } |
Guido van Rossum | 87ce7bb | 1998-06-09 16:30:31 +0000 | [diff] [blame] | 904 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 905 | static PyObject * |
Peter Schneider-Kamp | 416d413 | 2000-07-10 12:15:54 +0000 | [diff] [blame] | 906 | time_asctime(PyObject *self, PyObject *args) |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 907 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 908 | PyObject *tup = NULL; |
| 909 | struct tm buf; |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 910 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 911 | if (!PyArg_UnpackTuple(args, "asctime", 0, 1, &tup)) |
| 912 | return NULL; |
| 913 | if (tup == NULL) { |
| 914 | time_t tt = time(NULL); |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 915 | if (_PyTime_localtime(tt, &buf) != 0) |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 916 | return NULL; |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 917 | } |
| 918 | else if (!gettmarg(tup, &buf, |
| 919 | "iiiiiiiii;asctime(): illegal time tuple argument") || |
| 920 | !checktm(&buf)) |
| 921 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 922 | return NULL; |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 923 | } |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 924 | return _asctime(&buf); |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 925 | } |
| 926 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 927 | PyDoc_STRVAR(asctime_doc, |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 928 | "asctime([tuple]) -> string\n\ |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 929 | \n\ |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 930 | Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'.\n\ |
| 931 | When the time tuple is not present, current time as returned by localtime()\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 932 | is used."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 933 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 934 | static PyObject * |
Peter Schneider-Kamp | 416d413 | 2000-07-10 12:15:54 +0000 | [diff] [blame] | 935 | time_ctime(PyObject *self, PyObject *args) |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 936 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 937 | time_t tt; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 938 | struct tm buf; |
| 939 | if (!parse_time_t_args(args, "|O:ctime", &tt)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 940 | return NULL; |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 941 | if (_PyTime_localtime(tt, &buf) != 0) |
Alexander Belopolsky | 5da468f | 2011-01-04 17:15:52 +0000 | [diff] [blame] | 942 | return NULL; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 943 | return _asctime(&buf); |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 944 | } |
| 945 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 946 | PyDoc_STRVAR(ctime_doc, |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 947 | "ctime(seconds) -> string\n\ |
| 948 | \n\ |
| 949 | Convert a time in seconds since the Epoch to a string in local time.\n\ |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 950 | This is equivalent to asctime(localtime(seconds)). When the time tuple is\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 951 | not present, current time as returned by localtime() is used."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 952 | |
Guido van Rossum | 60cd813 | 1998-03-06 17:16:21 +0000 | [diff] [blame] | 953 | #ifdef HAVE_MKTIME |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 954 | static PyObject * |
Victor Stinner | 8709490 | 2019-04-09 19:12:26 +0200 | [diff] [blame] | 955 | time_mktime(PyObject *self, PyObject *tm_tuple) |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 956 | { |
Victor Stinner | 8709490 | 2019-04-09 19:12:26 +0200 | [diff] [blame] | 957 | struct tm tm; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 958 | time_t tt; |
Michael Felt | e2926b7 | 2018-12-28 14:57:37 +0100 | [diff] [blame] | 959 | |
Victor Stinner | 8709490 | 2019-04-09 19:12:26 +0200 | [diff] [blame] | 960 | if (!gettmarg(tm_tuple, &tm, |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 961 | "iiiiiiiii;mktime(): illegal time tuple argument")) |
| 962 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 963 | return NULL; |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 964 | } |
Victor Stinner | 8709490 | 2019-04-09 19:12:26 +0200 | [diff] [blame] | 965 | |
pxinwr | f1464f4 | 2019-04-15 17:06:21 +0800 | [diff] [blame] | 966 | #if defined(_AIX) || (defined(__VXWORKS__) && !defined(_WRS_CONFIG_LP64)) |
Victor Stinner | 8709490 | 2019-04-09 19:12:26 +0200 | [diff] [blame] | 967 | /* bpo-19748: AIX mktime() valid range is 00:00:00 UTC, January 1, 1970 |
| 968 | to 03:14:07 UTC, January 19, 2038. Thanks to the workaround below, |
| 969 | it is possible to support years in range [1902; 2037] */ |
| 970 | if (tm.tm_year < 2 || tm.tm_year > 137) { |
| 971 | /* bpo-19748: On AIX, mktime() does not report overflow error |
pxinwr | f1464f4 | 2019-04-15 17:06:21 +0800 | [diff] [blame] | 972 | for timestamp < -2^31 or timestamp > 2**31-1. VxWorks has the |
| 973 | same issue when working in 32 bit mode. */ |
Victor Stinner | 1ac4261 | 2014-02-21 09:27:17 +0100 | [diff] [blame] | 974 | PyErr_SetString(PyExc_OverflowError, |
| 975 | "mktime argument out of range"); |
| 976 | return NULL; |
| 977 | } |
pxinwr | f1464f4 | 2019-04-15 17:06:21 +0800 | [diff] [blame] | 978 | #endif |
Victor Stinner | 8709490 | 2019-04-09 19:12:26 +0200 | [diff] [blame] | 979 | |
pxinwr | f1464f4 | 2019-04-15 17:06:21 +0800 | [diff] [blame] | 980 | #ifdef _AIX |
Victor Stinner | 8709490 | 2019-04-09 19:12:26 +0200 | [diff] [blame] | 981 | /* bpo-34373: AIX mktime() has an integer overflow for years in range |
| 982 | [1902; 1969]. Workaround the issue by using a year greater or equal than |
| 983 | 1970 (tm_year >= 70): mktime() behaves correctly in that case |
| 984 | (ex: properly report errors). tm_year and tm_wday are adjusted after |
| 985 | mktime() call. */ |
| 986 | int orig_tm_year = tm.tm_year; |
| 987 | int delta_days = 0; |
| 988 | while (tm.tm_year < 70) { |
| 989 | /* Use 4 years to account properly leap years */ |
| 990 | tm.tm_year += 4; |
Michael Felt | e2926b7 | 2018-12-28 14:57:37 +0100 | [diff] [blame] | 991 | delta_days -= (366 + (365 * 3)); |
| 992 | } |
Victor Stinner | 1ac4261 | 2014-02-21 09:27:17 +0100 | [diff] [blame] | 993 | #endif |
Victor Stinner | 8709490 | 2019-04-09 19:12:26 +0200 | [diff] [blame] | 994 | |
| 995 | tm.tm_wday = -1; /* sentinel; original value ignored */ |
| 996 | tt = mktime(&tm); |
| 997 | |
Alexander Belopolsky | b7d40d1 | 2011-01-11 01:21:25 +0000 | [diff] [blame] | 998 | /* Return value of -1 does not necessarily mean an error, but tm_wday |
Ezio Melotti | 1392500 | 2011-03-16 11:05:33 +0200 | [diff] [blame] | 999 | * cannot remain set to -1 if mktime succeeded. */ |
Victor Stinner | 9303749 | 2013-06-25 22:54:35 +0200 | [diff] [blame] | 1000 | if (tt == (time_t)(-1) |
Victor Stinner | 9303749 | 2013-06-25 22:54:35 +0200 | [diff] [blame] | 1001 | /* Return value of -1 does not necessarily mean an error, but |
| 1002 | * tm_wday cannot remain set to -1 if mktime succeeded. */ |
Victor Stinner | 8709490 | 2019-04-09 19:12:26 +0200 | [diff] [blame] | 1003 | && tm.tm_wday == -1) |
Victor Stinner | 9303749 | 2013-06-25 22:54:35 +0200 | [diff] [blame] | 1004 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1005 | PyErr_SetString(PyExc_OverflowError, |
| 1006 | "mktime argument out of range"); |
| 1007 | return NULL; |
| 1008 | } |
Victor Stinner | 8709490 | 2019-04-09 19:12:26 +0200 | [diff] [blame] | 1009 | |
| 1010 | #ifdef _AIX |
| 1011 | if (delta_days != 0) { |
| 1012 | tm.tm_year = orig_tm_year; |
| 1013 | if (tm.tm_wday != -1) { |
| 1014 | tm.tm_wday = (tm.tm_wday + delta_days) % 7; |
| 1015 | } |
| 1016 | tt += delta_days * (24 * 3600); |
| 1017 | } |
| 1018 | #endif |
| 1019 | |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1020 | return PyFloat_FromDouble((double)tt); |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 1021 | } |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 1022 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1023 | PyDoc_STRVAR(mktime_doc, |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 1024 | "mktime(tuple) -> floating point number\n\ |
| 1025 | \n\ |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 1026 | Convert a time tuple in local time to seconds since the Epoch.\n\ |
| 1027 | Note that mktime(gmtime(0)) will not generally return zero for most\n\ |
| 1028 | time zones; instead the returned value will either be equal to that\n\ |
| 1029 | of the timezone or altzone attributes on the time module."); |
Guido van Rossum | 60cd813 | 1998-03-06 17:16:21 +0000 | [diff] [blame] | 1030 | #endif /* HAVE_MKTIME */ |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 1031 | |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1032 | #ifdef HAVE_WORKING_TZSET |
Victor Stinner | 3bb150d | 2018-12-03 13:45:38 +0100 | [diff] [blame] | 1033 | static int init_timezone(PyObject *module); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1034 | |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1035 | static PyObject * |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 1036 | time_tzset(PyObject *self, PyObject *unused) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1037 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1038 | PyObject* m; |
Fred Drake | 9bb7432 | 2002-04-01 14:49:59 +0000 | [diff] [blame] | 1039 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1040 | m = PyImport_ImportModuleNoBlock("time"); |
| 1041 | if (m == NULL) { |
| 1042 | return NULL; |
| 1043 | } |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1044 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1045 | tzset(); |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1046 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1047 | /* Reset timezone, altzone, daylight and tzname */ |
Victor Stinner | 3bb150d | 2018-12-03 13:45:38 +0100 | [diff] [blame] | 1048 | if (init_timezone(m) < 0) { |
Victor Stinner | 503ce5c | 2018-12-01 00:39:36 +0100 | [diff] [blame] | 1049 | return NULL; |
| 1050 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1051 | Py_DECREF(m); |
Victor Stinner | 2ff51b8 | 2013-07-17 21:42:45 +0200 | [diff] [blame] | 1052 | if (PyErr_Occurred()) |
| 1053 | return NULL; |
Tim Peters | 1b6f7a9 | 2004-06-20 02:50:16 +0000 | [diff] [blame] | 1054 | |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 1055 | Py_RETURN_NONE; |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1056 | } |
| 1057 | |
| 1058 | PyDoc_STRVAR(tzset_doc, |
R. David Murray | 4d55bf9 | 2010-12-14 00:55:46 +0000 | [diff] [blame] | 1059 | "tzset()\n\ |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1060 | \n\ |
| 1061 | Initialize, or reinitialize, the local timezone to the value stored in\n\ |
| 1062 | os.environ['TZ']. The TZ environment variable should be specified in\n\ |
Neal Norwitz | dc8e194 | 2004-07-20 22:34:37 +0000 | [diff] [blame] | 1063 | standard Unix timezone format as documented in the tzset man page\n\ |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1064 | (eg. 'US/Eastern', 'Europe/Amsterdam'). Unknown timezones will silently\n\ |
| 1065 | fall back to UTC. If the TZ environment variable is not set, the local\n\ |
| 1066 | timezone is set to the systems best guess of wallclock time.\n\ |
| 1067 | Changing the TZ environment variable without calling tzset *may* change\n\ |
| 1068 | the local timezone used by methods such as localtime, but this behaviour\n\ |
| 1069 | should not be relied on."); |
| 1070 | #endif /* HAVE_WORKING_TZSET */ |
| 1071 | |
Victor Stinner | ae58649 | 2014-09-02 23:18:25 +0200 | [diff] [blame] | 1072 | static PyObject * |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1073 | time_monotonic(PyObject *self, PyObject *unused) |
Victor Stinner | 071eca3 | 2012-03-15 01:17:09 +0100 | [diff] [blame] | 1074 | { |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1075 | _PyTime_t t = _PyTime_GetMonotonicClock(); |
| 1076 | return _PyFloat_FromPyTime(t); |
Victor Stinner | 071eca3 | 2012-03-15 01:17:09 +0100 | [diff] [blame] | 1077 | } |
| 1078 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1079 | PyDoc_STRVAR(monotonic_doc, |
| 1080 | "monotonic() -> float\n\ |
Victor Stinner | 8b30201 | 2012-02-07 23:29:46 +0100 | [diff] [blame] | 1081 | \n\ |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1082 | Monotonic clock, cannot go backward."); |
Victor Stinner | ec919cc | 2012-03-15 00:58:32 +0100 | [diff] [blame] | 1083 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1084 | static PyObject * |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1085 | time_monotonic_ns(PyObject *self, PyObject *unused) |
| 1086 | { |
| 1087 | _PyTime_t t = _PyTime_GetMonotonicClock(); |
| 1088 | return _PyTime_AsNanosecondsObject(t); |
| 1089 | } |
| 1090 | |
| 1091 | PyDoc_STRVAR(monotonic_ns_doc, |
| 1092 | "monotonic_ns() -> int\n\ |
| 1093 | \n\ |
| 1094 | Monotonic clock, cannot go backward, as nanoseconds."); |
| 1095 | |
| 1096 | static PyObject * |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1097 | time_perf_counter(PyObject *self, PyObject *unused) |
| 1098 | { |
| 1099 | return perf_counter(NULL); |
| 1100 | } |
| 1101 | |
| 1102 | PyDoc_STRVAR(perf_counter_doc, |
| 1103 | "perf_counter() -> float\n\ |
| 1104 | \n\ |
| 1105 | Performance counter for benchmarking."); |
| 1106 | |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1107 | static PyObject * |
| 1108 | time_perf_counter_ns(PyObject *self, PyObject *unused) |
| 1109 | { |
| 1110 | _PyTime_t t = _PyTime_GetPerfCounter(); |
| 1111 | return _PyTime_AsNanosecondsObject(t); |
| 1112 | } |
| 1113 | |
| 1114 | PyDoc_STRVAR(perf_counter_ns_doc, |
| 1115 | "perf_counter_ns() -> int\n\ |
| 1116 | \n\ |
| 1117 | Performance counter for benchmarking as nanoseconds."); |
| 1118 | |
| 1119 | static int |
| 1120 | _PyTime_GetProcessTimeWithInfo(_PyTime_t *tp, _Py_clock_info_t *info) |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1121 | { |
| 1122 | #if defined(MS_WINDOWS) |
| 1123 | HANDLE process; |
| 1124 | FILETIME creation_time, exit_time, kernel_time, user_time; |
| 1125 | ULARGE_INTEGER large; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1126 | _PyTime_t ktime, utime, t; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1127 | BOOL ok; |
| 1128 | |
| 1129 | process = GetCurrentProcess(); |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1130 | ok = GetProcessTimes(process, &creation_time, &exit_time, |
| 1131 | &kernel_time, &user_time); |
| 1132 | if (!ok) { |
| 1133 | PyErr_SetFromWindowsErr(0); |
| 1134 | return -1; |
| 1135 | } |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1136 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1137 | if (info) { |
| 1138 | info->implementation = "GetProcessTimes()"; |
| 1139 | info->resolution = 1e-7; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1140 | info->monotonic = 1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1141 | info->adjustable = 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1142 | } |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1143 | |
| 1144 | large.u.LowPart = kernel_time.dwLowDateTime; |
| 1145 | large.u.HighPart = kernel_time.dwHighDateTime; |
| 1146 | ktime = large.QuadPart; |
| 1147 | |
| 1148 | large.u.LowPart = user_time.dwLowDateTime; |
| 1149 | large.u.HighPart = user_time.dwHighDateTime; |
| 1150 | utime = large.QuadPart; |
| 1151 | |
| 1152 | /* ktime and utime have a resolution of 100 nanoseconds */ |
| 1153 | t = _PyTime_FromNanoseconds((ktime + utime) * 100); |
| 1154 | *tp = t; |
| 1155 | return 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1156 | #else |
| 1157 | |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1158 | /* clock_gettime */ |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1159 | #if defined(HAVE_CLOCK_GETTIME) \ |
| 1160 | && (defined(CLOCK_PROCESS_CPUTIME_ID) || defined(CLOCK_PROF)) |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1161 | struct timespec ts; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1162 | #ifdef CLOCK_PROF |
| 1163 | const clockid_t clk_id = CLOCK_PROF; |
| 1164 | const char *function = "clock_gettime(CLOCK_PROF)"; |
| 1165 | #else |
| 1166 | const clockid_t clk_id = CLOCK_PROCESS_CPUTIME_ID; |
| 1167 | const char *function = "clock_gettime(CLOCK_PROCESS_CPUTIME_ID)"; |
| 1168 | #endif |
| 1169 | |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1170 | if (clock_gettime(clk_id, &ts) == 0) { |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1171 | if (info) { |
| 1172 | struct timespec res; |
| 1173 | info->implementation = function; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1174 | info->monotonic = 1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1175 | info->adjustable = 0; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1176 | if (clock_getres(clk_id, &res)) { |
| 1177 | PyErr_SetFromErrno(PyExc_OSError); |
| 1178 | return -1; |
| 1179 | } |
| 1180 | info->resolution = res.tv_sec + res.tv_nsec * 1e-9; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1181 | } |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1182 | |
| 1183 | if (_PyTime_FromTimespec(tp, &ts) < 0) { |
| 1184 | return -1; |
| 1185 | } |
| 1186 | return 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1187 | } |
| 1188 | #endif |
| 1189 | |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1190 | /* getrusage(RUSAGE_SELF) */ |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1191 | #if defined(HAVE_SYS_RESOURCE_H) |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1192 | struct rusage ru; |
| 1193 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1194 | if (getrusage(RUSAGE_SELF, &ru) == 0) { |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1195 | _PyTime_t utime, stime; |
| 1196 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1197 | if (info) { |
| 1198 | info->implementation = "getrusage(RUSAGE_SELF)"; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1199 | info->monotonic = 1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1200 | info->adjustable = 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1201 | info->resolution = 1e-6; |
| 1202 | } |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1203 | |
| 1204 | if (_PyTime_FromTimeval(&utime, &ru.ru_utime) < 0) { |
| 1205 | return -1; |
| 1206 | } |
| 1207 | if (_PyTime_FromTimeval(&stime, &ru.ru_stime) < 0) { |
| 1208 | return -1; |
| 1209 | } |
| 1210 | |
| 1211 | _PyTime_t total = utime + utime; |
| 1212 | *tp = total; |
| 1213 | return 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1214 | } |
| 1215 | #endif |
| 1216 | |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1217 | /* times() */ |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1218 | #ifdef HAVE_TIMES |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1219 | struct tms t; |
| 1220 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1221 | if (times(&t) != (clock_t)-1) { |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1222 | static long ticks_per_second = -1; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1223 | |
| 1224 | if (ticks_per_second == -1) { |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1225 | long freq; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1226 | #if defined(HAVE_SYSCONF) && defined(_SC_CLK_TCK) |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1227 | freq = sysconf(_SC_CLK_TCK); |
| 1228 | if (freq < 1) { |
| 1229 | freq = -1; |
| 1230 | } |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1231 | #elif defined(HZ) |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1232 | freq = HZ; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1233 | #else |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1234 | freq = 60; /* magic fallback value; may be bogus */ |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1235 | #endif |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1236 | |
| 1237 | if (freq != -1) { |
| 1238 | /* check that _PyTime_MulDiv(t, SEC_TO_NS, ticks_per_second) |
| 1239 | cannot overflow below */ |
Serhiy Storchaka | bfe4fd5 | 2018-02-09 17:31:26 +0200 | [diff] [blame] | 1240 | #if LONG_MAX > _PyTime_MAX / SEC_TO_NS |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1241 | if ((_PyTime_t)freq > _PyTime_MAX / SEC_TO_NS) { |
| 1242 | PyErr_SetString(PyExc_OverflowError, |
| 1243 | "_SC_CLK_TCK is too large"); |
| 1244 | return -1; |
| 1245 | } |
Serhiy Storchaka | bfe4fd5 | 2018-02-09 17:31:26 +0200 | [diff] [blame] | 1246 | #endif |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1247 | |
| 1248 | ticks_per_second = freq; |
| 1249 | } |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1250 | } |
| 1251 | |
| 1252 | if (ticks_per_second != -1) { |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1253 | if (info) { |
| 1254 | info->implementation = "times()"; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1255 | info->monotonic = 1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1256 | info->adjustable = 0; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1257 | info->resolution = 1.0 / (double)ticks_per_second; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1258 | } |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1259 | |
| 1260 | _PyTime_t total; |
| 1261 | total = _PyTime_MulDiv(t.tms_utime, SEC_TO_NS, ticks_per_second); |
| 1262 | total += _PyTime_MulDiv(t.tms_stime, SEC_TO_NS, ticks_per_second); |
| 1263 | *tp = total; |
| 1264 | return 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1265 | } |
| 1266 | } |
| 1267 | #endif |
| 1268 | |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1269 | /* clock */ |
Victor Stinner | 53e22bf | 2016-07-08 17:55:01 +0200 | [diff] [blame] | 1270 | /* Currently, Python 3 requires clock() to build: see issue #22624 */ |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1271 | return _PyTime_GetClockWithInfo(tp, info); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1272 | #endif |
| 1273 | } |
| 1274 | |
| 1275 | static PyObject * |
| 1276 | time_process_time(PyObject *self, PyObject *unused) |
| 1277 | { |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1278 | _PyTime_t t; |
| 1279 | if (_PyTime_GetProcessTimeWithInfo(&t, NULL) < 0) { |
| 1280 | return NULL; |
| 1281 | } |
| 1282 | return _PyFloat_FromPyTime(t); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1283 | } |
| 1284 | |
| 1285 | PyDoc_STRVAR(process_time_doc, |
| 1286 | "process_time() -> float\n\ |
| 1287 | \n\ |
| 1288 | Process time for profiling: sum of the kernel and user-space CPU time."); |
| 1289 | |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1290 | static PyObject * |
| 1291 | time_process_time_ns(PyObject *self, PyObject *unused) |
| 1292 | { |
| 1293 | _PyTime_t t; |
| 1294 | if (_PyTime_GetProcessTimeWithInfo(&t, NULL) < 0) { |
| 1295 | return NULL; |
| 1296 | } |
| 1297 | return _PyTime_AsNanosecondsObject(t); |
| 1298 | } |
| 1299 | |
| 1300 | PyDoc_STRVAR(process_time_ns_doc, |
| 1301 | "process_time() -> int\n\ |
| 1302 | \n\ |
| 1303 | Process time for profiling as nanoseconds:\n\ |
| 1304 | sum of the kernel and user-space CPU time."); |
| 1305 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1306 | |
Antoine Pitrou | 4bd41c9 | 2017-11-15 22:52:21 +0100 | [diff] [blame] | 1307 | #if defined(MS_WINDOWS) |
| 1308 | #define HAVE_THREAD_TIME |
| 1309 | static int |
| 1310 | _PyTime_GetThreadTimeWithInfo(_PyTime_t *tp, _Py_clock_info_t *info) |
| 1311 | { |
| 1312 | HANDLE thread; |
| 1313 | FILETIME creation_time, exit_time, kernel_time, user_time; |
| 1314 | ULARGE_INTEGER large; |
| 1315 | _PyTime_t ktime, utime, t; |
| 1316 | BOOL ok; |
| 1317 | |
| 1318 | thread = GetCurrentThread(); |
| 1319 | ok = GetThreadTimes(thread, &creation_time, &exit_time, |
| 1320 | &kernel_time, &user_time); |
| 1321 | if (!ok) { |
| 1322 | PyErr_SetFromWindowsErr(0); |
| 1323 | return -1; |
| 1324 | } |
| 1325 | |
| 1326 | if (info) { |
| 1327 | info->implementation = "GetThreadTimes()"; |
| 1328 | info->resolution = 1e-7; |
| 1329 | info->monotonic = 1; |
| 1330 | info->adjustable = 0; |
| 1331 | } |
| 1332 | |
| 1333 | large.u.LowPart = kernel_time.dwLowDateTime; |
| 1334 | large.u.HighPart = kernel_time.dwHighDateTime; |
| 1335 | ktime = large.QuadPart; |
| 1336 | |
| 1337 | large.u.LowPart = user_time.dwLowDateTime; |
| 1338 | large.u.HighPart = user_time.dwHighDateTime; |
| 1339 | utime = large.QuadPart; |
| 1340 | |
| 1341 | /* ktime and utime have a resolution of 100 nanoseconds */ |
| 1342 | t = _PyTime_FromNanoseconds((ktime + utime) * 100); |
| 1343 | *tp = t; |
| 1344 | return 0; |
| 1345 | } |
| 1346 | |
| 1347 | #elif defined(HAVE_CLOCK_GETTIME) && defined(CLOCK_PROCESS_CPUTIME_ID) |
| 1348 | #define HAVE_THREAD_TIME |
| 1349 | static int |
| 1350 | _PyTime_GetThreadTimeWithInfo(_PyTime_t *tp, _Py_clock_info_t *info) |
| 1351 | { |
| 1352 | struct timespec ts; |
| 1353 | const clockid_t clk_id = CLOCK_THREAD_CPUTIME_ID; |
| 1354 | const char *function = "clock_gettime(CLOCK_THREAD_CPUTIME_ID)"; |
| 1355 | |
| 1356 | if (clock_gettime(clk_id, &ts)) { |
| 1357 | PyErr_SetFromErrno(PyExc_OSError); |
| 1358 | return -1; |
| 1359 | } |
| 1360 | if (info) { |
| 1361 | struct timespec res; |
| 1362 | info->implementation = function; |
| 1363 | info->monotonic = 1; |
| 1364 | info->adjustable = 0; |
| 1365 | if (clock_getres(clk_id, &res)) { |
| 1366 | PyErr_SetFromErrno(PyExc_OSError); |
| 1367 | return -1; |
| 1368 | } |
| 1369 | info->resolution = res.tv_sec + res.tv_nsec * 1e-9; |
| 1370 | } |
| 1371 | |
| 1372 | if (_PyTime_FromTimespec(tp, &ts) < 0) { |
| 1373 | return -1; |
| 1374 | } |
| 1375 | return 0; |
| 1376 | } |
| 1377 | #endif |
| 1378 | |
| 1379 | #ifdef HAVE_THREAD_TIME |
| 1380 | static PyObject * |
| 1381 | time_thread_time(PyObject *self, PyObject *unused) |
| 1382 | { |
| 1383 | _PyTime_t t; |
| 1384 | if (_PyTime_GetThreadTimeWithInfo(&t, NULL) < 0) { |
| 1385 | return NULL; |
| 1386 | } |
| 1387 | return _PyFloat_FromPyTime(t); |
| 1388 | } |
| 1389 | |
| 1390 | PyDoc_STRVAR(thread_time_doc, |
| 1391 | "thread_time() -> float\n\ |
| 1392 | \n\ |
| 1393 | Thread time for profiling: sum of the kernel and user-space CPU time."); |
| 1394 | |
| 1395 | static PyObject * |
| 1396 | time_thread_time_ns(PyObject *self, PyObject *unused) |
| 1397 | { |
| 1398 | _PyTime_t t; |
| 1399 | if (_PyTime_GetThreadTimeWithInfo(&t, NULL) < 0) { |
| 1400 | return NULL; |
| 1401 | } |
| 1402 | return _PyTime_AsNanosecondsObject(t); |
| 1403 | } |
| 1404 | |
| 1405 | PyDoc_STRVAR(thread_time_ns_doc, |
| 1406 | "thread_time() -> int\n\ |
| 1407 | \n\ |
| 1408 | Thread time for profiling as nanoseconds:\n\ |
| 1409 | sum of the kernel and user-space CPU time."); |
| 1410 | #endif |
| 1411 | |
| 1412 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1413 | static PyObject * |
| 1414 | time_get_clock_info(PyObject *self, PyObject *args) |
| 1415 | { |
| 1416 | char *name; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1417 | _Py_clock_info_t info; |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1418 | PyObject *obj = NULL, *dict, *ns; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1419 | _PyTime_t t; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1420 | |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1421 | if (!PyArg_ParseTuple(args, "s:get_clock_info", &name)) { |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1422 | return NULL; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1423 | } |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1424 | |
| 1425 | #ifdef Py_DEBUG |
| 1426 | info.implementation = NULL; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1427 | info.monotonic = -1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1428 | info.adjustable = -1; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1429 | info.resolution = -1.0; |
| 1430 | #else |
| 1431 | info.implementation = ""; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1432 | info.monotonic = 0; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1433 | info.adjustable = 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1434 | info.resolution = 1.0; |
| 1435 | #endif |
| 1436 | |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1437 | if (strcmp(name, "time") == 0) { |
| 1438 | if (_PyTime_GetSystemClockWithInfo(&t, &info) < 0) { |
| 1439 | return NULL; |
| 1440 | } |
| 1441 | } |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1442 | else if (strcmp(name, "monotonic") == 0) { |
| 1443 | if (_PyTime_GetMonotonicClockWithInfo(&t, &info) < 0) { |
| 1444 | return NULL; |
| 1445 | } |
| 1446 | } |
| 1447 | else if (strcmp(name, "perf_counter") == 0) { |
| 1448 | if (_PyTime_GetPerfCounterWithInfo(&t, &info) < 0) { |
| 1449 | return NULL; |
| 1450 | } |
| 1451 | } |
| 1452 | else if (strcmp(name, "process_time") == 0) { |
| 1453 | if (_PyTime_GetProcessTimeWithInfo(&t, &info) < 0) { |
| 1454 | return NULL; |
| 1455 | } |
| 1456 | } |
Antoine Pitrou | 4bd41c9 | 2017-11-15 22:52:21 +0100 | [diff] [blame] | 1457 | #ifdef HAVE_THREAD_TIME |
| 1458 | else if (strcmp(name, "thread_time") == 0) { |
| 1459 | if (_PyTime_GetThreadTimeWithInfo(&t, &info) < 0) { |
| 1460 | return NULL; |
| 1461 | } |
| 1462 | } |
| 1463 | #endif |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1464 | else { |
| 1465 | PyErr_SetString(PyExc_ValueError, "unknown clock"); |
| 1466 | return NULL; |
| 1467 | } |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1468 | |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1469 | dict = PyDict_New(); |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1470 | if (dict == NULL) { |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1471 | return NULL; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1472 | } |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1473 | |
| 1474 | assert(info.implementation != NULL); |
| 1475 | obj = PyUnicode_FromString(info.implementation); |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1476 | if (obj == NULL) { |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1477 | goto error; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1478 | } |
| 1479 | if (PyDict_SetItemString(dict, "implementation", obj) == -1) { |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1480 | goto error; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1481 | } |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1482 | Py_CLEAR(obj); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1483 | |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1484 | assert(info.monotonic != -1); |
| 1485 | obj = PyBool_FromLong(info.monotonic); |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1486 | if (obj == NULL) { |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1487 | goto error; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1488 | } |
| 1489 | if (PyDict_SetItemString(dict, "monotonic", obj) == -1) { |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1490 | goto error; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1491 | } |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1492 | Py_CLEAR(obj); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1493 | |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1494 | assert(info.adjustable != -1); |
| 1495 | obj = PyBool_FromLong(info.adjustable); |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1496 | if (obj == NULL) { |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1497 | goto error; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1498 | } |
| 1499 | if (PyDict_SetItemString(dict, "adjustable", obj) == -1) { |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1500 | goto error; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1501 | } |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1502 | Py_CLEAR(obj); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1503 | |
| 1504 | assert(info.resolution > 0.0); |
| 1505 | assert(info.resolution <= 1.0); |
| 1506 | obj = PyFloat_FromDouble(info.resolution); |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1507 | if (obj == NULL) { |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1508 | goto error; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1509 | } |
| 1510 | if (PyDict_SetItemString(dict, "resolution", obj) == -1) { |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1511 | goto error; |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1512 | } |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1513 | Py_CLEAR(obj); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1514 | |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1515 | ns = _PyNamespace_New(dict); |
| 1516 | Py_DECREF(dict); |
| 1517 | return ns; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1518 | |
| 1519 | error: |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1520 | Py_DECREF(dict); |
| 1521 | Py_XDECREF(obj); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1522 | return NULL; |
| 1523 | } |
| 1524 | |
| 1525 | PyDoc_STRVAR(get_clock_info_doc, |
| 1526 | "get_clock_info(name: str) -> dict\n\ |
| 1527 | \n\ |
| 1528 | Get information of the specified clock."); |
Victor Stinner | 8b30201 | 2012-02-07 23:29:46 +0100 | [diff] [blame] | 1529 | |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1530 | #ifndef HAVE_DECL_TZNAME |
Victor Stinner | 1fb399b | 2018-09-17 13:56:17 -0700 | [diff] [blame] | 1531 | static void |
| 1532 | get_zone(char *zone, int n, struct tm *p) |
| 1533 | { |
| 1534 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
| 1535 | strncpy(zone, p->tm_zone ? p->tm_zone : " ", n); |
| 1536 | #else |
| 1537 | tzset(); |
| 1538 | strftime(zone, n, "%Z", p); |
| 1539 | #endif |
| 1540 | } |
| 1541 | |
Victor Stinner | 503ce5c | 2018-12-01 00:39:36 +0100 | [diff] [blame] | 1542 | static time_t |
Victor Stinner | 1fb399b | 2018-09-17 13:56:17 -0700 | [diff] [blame] | 1543 | get_gmtoff(time_t t, struct tm *p) |
| 1544 | { |
| 1545 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
| 1546 | return p->tm_gmtoff; |
| 1547 | #else |
| 1548 | return timegm(p) - t; |
| 1549 | #endif |
| 1550 | } |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1551 | #endif // !HAVE_DECL_TZNAME |
Victor Stinner | 1fb399b | 2018-09-17 13:56:17 -0700 | [diff] [blame] | 1552 | |
Victor Stinner | 503ce5c | 2018-12-01 00:39:36 +0100 | [diff] [blame] | 1553 | static int |
Victor Stinner | 3bb150d | 2018-12-03 13:45:38 +0100 | [diff] [blame] | 1554 | init_timezone(PyObject *m) |
Victor Stinner | 503ce5c | 2018-12-01 00:39:36 +0100 | [diff] [blame] | 1555 | { |
| 1556 | assert(!PyErr_Occurred()); |
| 1557 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1558 | /* This code moved from PyInit_time wholesale to allow calling it from |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1559 | time_tzset. In the future, some parts of it can be moved back |
| 1560 | (for platforms that don't HAVE_WORKING_TZSET, when we know what they |
| 1561 | are), and the extraneous calls to tzset(3) should be removed. |
| 1562 | I haven't done this yet, as I don't want to change this code as |
| 1563 | little as possible when introducing the time.tzset and time.tzsetwall |
| 1564 | methods. This should simply be a method of doing the following once, |
| 1565 | at the top of this function and removing the call to tzset() from |
| 1566 | time_tzset(): |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1567 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1568 | #ifdef HAVE_TZSET |
| 1569 | tzset() |
| 1570 | #endif |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1571 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1572 | And I'm lazy and hate C so nyer. |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1573 | */ |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1574 | #ifdef HAVE_DECL_TZNAME |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1575 | PyObject *otz0, *otz1; |
| 1576 | tzset(); |
Zackery Spytz | 6673dec | 2019-02-25 16:56:44 -0700 | [diff] [blame] | 1577 | PyModule_AddIntConstant(m, "timezone", _Py_timezone); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1578 | #ifdef HAVE_ALTZONE |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1579 | PyModule_AddIntConstant(m, "altzone", altzone); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1580 | #else |
Zackery Spytz | 6673dec | 2019-02-25 16:56:44 -0700 | [diff] [blame] | 1581 | PyModule_AddIntConstant(m, "altzone", _Py_timezone-3600); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1582 | #endif |
Zackery Spytz | 6673dec | 2019-02-25 16:56:44 -0700 | [diff] [blame] | 1583 | PyModule_AddIntConstant(m, "daylight", _Py_daylight); |
| 1584 | otz0 = PyUnicode_DecodeLocale(_Py_tzname[0], "surrogateescape"); |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1585 | if (otz0 == NULL) { |
Victor Stinner | ab66149 | 2018-12-03 12:02:43 +0100 | [diff] [blame] | 1586 | return -1; |
Victor Stinner | 1fb399b | 2018-09-17 13:56:17 -0700 | [diff] [blame] | 1587 | } |
Zackery Spytz | 6673dec | 2019-02-25 16:56:44 -0700 | [diff] [blame] | 1588 | otz1 = PyUnicode_DecodeLocale(_Py_tzname[1], "surrogateescape"); |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1589 | if (otz1 == NULL) { |
| 1590 | Py_DECREF(otz0); |
Victor Stinner | ab66149 | 2018-12-03 12:02:43 +0100 | [diff] [blame] | 1591 | return -1; |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1592 | } |
| 1593 | PyObject *tzname_obj = Py_BuildValue("(NN)", otz0, otz1); |
Victor Stinner | ab66149 | 2018-12-03 12:02:43 +0100 | [diff] [blame] | 1594 | if (tzname_obj == NULL) { |
| 1595 | return -1; |
| 1596 | } |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1597 | PyModule_AddObject(m, "tzname", tzname_obj); |
| 1598 | #else // !HAVE_DECL_TZNAME |
| 1599 | static const time_t YEAR = (365 * 24 + 6) * 3600; |
| 1600 | time_t t; |
| 1601 | struct tm p; |
Victor Stinner | 503ce5c | 2018-12-01 00:39:36 +0100 | [diff] [blame] | 1602 | time_t janzone_t, julyzone_t; |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1603 | char janname[10], julyname[10]; |
| 1604 | t = (time((time_t *)0) / YEAR) * YEAR; |
| 1605 | _PyTime_localtime(t, &p); |
| 1606 | get_zone(janname, 9, &p); |
Victor Stinner | 503ce5c | 2018-12-01 00:39:36 +0100 | [diff] [blame] | 1607 | janzone_t = -get_gmtoff(t, &p); |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1608 | janname[9] = '\0'; |
| 1609 | t += YEAR/2; |
| 1610 | _PyTime_localtime(t, &p); |
| 1611 | get_zone(julyname, 9, &p); |
Victor Stinner | 503ce5c | 2018-12-01 00:39:36 +0100 | [diff] [blame] | 1612 | julyzone_t = -get_gmtoff(t, &p); |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1613 | julyname[9] = '\0'; |
| 1614 | |
Victor Stinner | 503ce5c | 2018-12-01 00:39:36 +0100 | [diff] [blame] | 1615 | /* Sanity check, don't check for the validity of timezones. |
| 1616 | In practice, it should be more in range -12 hours .. +14 hours. */ |
| 1617 | #define MAX_TIMEZONE (48 * 3600) |
| 1618 | if (janzone_t < -MAX_TIMEZONE || janzone_t > MAX_TIMEZONE |
| 1619 | || julyzone_t < -MAX_TIMEZONE || julyzone_t > MAX_TIMEZONE) |
| 1620 | { |
| 1621 | PyErr_SetString(PyExc_RuntimeError, "invalid GMT offset"); |
| 1622 | return -1; |
| 1623 | } |
| 1624 | int janzone = (int)janzone_t; |
| 1625 | int julyzone = (int)julyzone_t; |
| 1626 | |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1627 | PyObject *tzname_obj; |
| 1628 | if (janzone < julyzone) { |
| 1629 | /* DST is reversed in the southern hemisphere */ |
| 1630 | PyModule_AddIntConstant(m, "timezone", julyzone); |
| 1631 | PyModule_AddIntConstant(m, "altzone", janzone); |
| 1632 | PyModule_AddIntConstant(m, "daylight", janzone != julyzone); |
| 1633 | tzname_obj = Py_BuildValue("(zz)", julyname, janname); |
| 1634 | } else { |
| 1635 | PyModule_AddIntConstant(m, "timezone", janzone); |
| 1636 | PyModule_AddIntConstant(m, "altzone", julyzone); |
| 1637 | PyModule_AddIntConstant(m, "daylight", janzone != julyzone); |
| 1638 | tzname_obj = Py_BuildValue("(zz)", janname, julyname); |
| 1639 | } |
Victor Stinner | 503ce5c | 2018-12-01 00:39:36 +0100 | [diff] [blame] | 1640 | if (tzname_obj == NULL) { |
| 1641 | return -1; |
| 1642 | } |
Benjamin Peterson | c510c6b | 2018-09-20 19:52:18 -0700 | [diff] [blame] | 1643 | PyModule_AddObject(m, "tzname", tzname_obj); |
| 1644 | #endif // !HAVE_DECL_TZNAME |
Victor Stinner | 503ce5c | 2018-12-01 00:39:36 +0100 | [diff] [blame] | 1645 | |
| 1646 | if (PyErr_Occurred()) { |
| 1647 | return -1; |
| 1648 | } |
| 1649 | return 0; |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1650 | } |
| 1651 | |
| 1652 | |
| 1653 | static PyMethodDef time_methods[] = { |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1654 | {"time", time_time, METH_NOARGS, time_doc}, |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1655 | {"time_ns", time_time_ns, METH_NOARGS, time_ns_doc}, |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 1656 | #ifdef HAVE_CLOCK_GETTIME |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1657 | {"clock_gettime", time_clock_gettime, METH_VARARGS, clock_gettime_doc}, |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1658 | {"clock_gettime_ns",time_clock_gettime_ns, METH_VARARGS, clock_gettime_ns_doc}, |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 1659 | #endif |
| 1660 | #ifdef HAVE_CLOCK_SETTIME |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 1661 | {"clock_settime", time_clock_settime, METH_VARARGS, clock_settime_doc}, |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1662 | {"clock_settime_ns",time_clock_settime_ns, METH_VARARGS, clock_settime_ns_doc}, |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 1663 | #endif |
| 1664 | #ifdef HAVE_CLOCK_GETRES |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1665 | {"clock_getres", time_clock_getres, METH_VARARGS, clock_getres_doc}, |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 1666 | #endif |
pdox | e14679c | 2017-10-05 00:01:56 -0700 | [diff] [blame] | 1667 | #ifdef HAVE_PTHREAD_GETCPUCLOCKID |
| 1668 | {"pthread_getcpuclockid", time_pthread_getcpuclockid, METH_VARARGS, pthread_getcpuclockid_doc}, |
| 1669 | #endif |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1670 | {"sleep", time_sleep, METH_O, sleep_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1671 | {"gmtime", time_gmtime, METH_VARARGS, gmtime_doc}, |
| 1672 | {"localtime", time_localtime, METH_VARARGS, localtime_doc}, |
| 1673 | {"asctime", time_asctime, METH_VARARGS, asctime_doc}, |
| 1674 | {"ctime", time_ctime, METH_VARARGS, ctime_doc}, |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1675 | #ifdef HAVE_MKTIME |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1676 | {"mktime", time_mktime, METH_O, mktime_doc}, |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1677 | #endif |
| 1678 | #ifdef HAVE_STRFTIME |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1679 | {"strftime", time_strftime, METH_VARARGS, strftime_doc}, |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1680 | #endif |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1681 | {"strptime", time_strptime, METH_VARARGS, strptime_doc}, |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1682 | #ifdef HAVE_WORKING_TZSET |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1683 | {"tzset", time_tzset, METH_NOARGS, tzset_doc}, |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1684 | #endif |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1685 | {"monotonic", time_monotonic, METH_NOARGS, monotonic_doc}, |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1686 | {"monotonic_ns", time_monotonic_ns, METH_NOARGS, monotonic_ns_doc}, |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1687 | {"process_time", time_process_time, METH_NOARGS, process_time_doc}, |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1688 | {"process_time_ns", time_process_time_ns, METH_NOARGS, process_time_ns_doc}, |
Antoine Pitrou | 4bd41c9 | 2017-11-15 22:52:21 +0100 | [diff] [blame] | 1689 | #ifdef HAVE_THREAD_TIME |
| 1690 | {"thread_time", time_thread_time, METH_NOARGS, thread_time_doc}, |
| 1691 | {"thread_time_ns", time_thread_time_ns, METH_NOARGS, thread_time_ns_doc}, |
| 1692 | #endif |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1693 | {"perf_counter", time_perf_counter, METH_NOARGS, perf_counter_doc}, |
Victor Stinner | c29b585 | 2017-11-02 07:28:27 -0700 | [diff] [blame] | 1694 | {"perf_counter_ns", time_perf_counter_ns, METH_NOARGS, perf_counter_ns_doc}, |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1695 | {"get_clock_info", time_get_clock_info, METH_VARARGS, get_clock_info_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1696 | {NULL, NULL} /* sentinel */ |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1697 | }; |
| 1698 | |
| 1699 | |
| 1700 | PyDoc_STRVAR(module_doc, |
| 1701 | "This module provides various functions to manipulate time values.\n\ |
| 1702 | \n\ |
| 1703 | There are two standard representations of time. One is the number\n\ |
| 1704 | of seconds since the Epoch, in UTC (a.k.a. GMT). It may be an integer\n\ |
| 1705 | or a floating point number (to represent fractions of seconds).\n\ |
| 1706 | The Epoch is system-defined; on Unix, it is generally January 1st, 1970.\n\ |
| 1707 | The actual value can be retrieved by calling gmtime(0).\n\ |
| 1708 | \n\ |
| 1709 | The other representation is a tuple of 9 integers giving local time.\n\ |
| 1710 | The tuple items are:\n\ |
Alexander Belopolsky | 03163ac | 2011-05-02 12:20:52 -0400 | [diff] [blame] | 1711 | year (including century, e.g. 1998)\n\ |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1712 | month (1-12)\n\ |
| 1713 | day (1-31)\n\ |
| 1714 | hours (0-23)\n\ |
| 1715 | minutes (0-59)\n\ |
| 1716 | seconds (0-59)\n\ |
| 1717 | weekday (0-6, Monday is 0)\n\ |
| 1718 | Julian day (day in the year, 1-366)\n\ |
| 1719 | DST (Daylight Savings Time) flag (-1, 0 or 1)\n\ |
| 1720 | If the DST flag is 0, the time is given in the regular time zone;\n\ |
| 1721 | if it is 1, the time is given in the DST time zone;\n\ |
Cheryl Sabella | 703ff38 | 2017-10-11 09:29:14 -0400 | [diff] [blame] | 1722 | if it is -1, mktime() should guess based on the date and time.\n"); |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1723 | |
| 1724 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1725 | |
| 1726 | static struct PyModuleDef timemodule = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1727 | PyModuleDef_HEAD_INIT, |
| 1728 | "time", |
| 1729 | module_doc, |
| 1730 | -1, |
| 1731 | time_methods, |
| 1732 | NULL, |
| 1733 | NULL, |
| 1734 | NULL, |
| 1735 | NULL |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1736 | }; |
| 1737 | |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1738 | PyMODINIT_FUNC |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1739 | PyInit_time(void) |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1740 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1741 | PyObject *m; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1742 | m = PyModule_Create(&timemodule); |
| 1743 | if (m == NULL) |
| 1744 | return NULL; |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1745 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1746 | /* Set, or reset, module variables like time.timezone */ |
Victor Stinner | 3bb150d | 2018-12-03 13:45:38 +0100 | [diff] [blame] | 1747 | if (init_timezone(m) < 0) { |
Victor Stinner | 503ce5c | 2018-12-01 00:39:36 +0100 | [diff] [blame] | 1748 | return NULL; |
| 1749 | } |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1750 | |
Max Bélanger | 9445118 | 2018-10-20 17:07:54 -0700 | [diff] [blame] | 1751 | #if defined(HAVE_CLOCK_GETTIME) || defined(HAVE_CLOCK_SETTIME) || defined(HAVE_CLOCK_GETRES) |
| 1752 | |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 1753 | #ifdef CLOCK_REALTIME |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 1754 | PyModule_AddIntMacro(m, CLOCK_REALTIME); |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 1755 | #endif |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 1756 | #ifdef CLOCK_MONOTONIC |
| 1757 | PyModule_AddIntMacro(m, CLOCK_MONOTONIC); |
| 1758 | #endif |
| 1759 | #ifdef CLOCK_MONOTONIC_RAW |
| 1760 | PyModule_AddIntMacro(m, CLOCK_MONOTONIC_RAW); |
| 1761 | #endif |
| 1762 | #ifdef CLOCK_HIGHRES |
| 1763 | PyModule_AddIntMacro(m, CLOCK_HIGHRES); |
| 1764 | #endif |
| 1765 | #ifdef CLOCK_PROCESS_CPUTIME_ID |
| 1766 | PyModule_AddIntMacro(m, CLOCK_PROCESS_CPUTIME_ID); |
| 1767 | #endif |
| 1768 | #ifdef CLOCK_THREAD_CPUTIME_ID |
| 1769 | PyModule_AddIntMacro(m, CLOCK_THREAD_CPUTIME_ID); |
| 1770 | #endif |
Victor Stinner | a64ce97 | 2017-11-02 04:19:19 -0700 | [diff] [blame] | 1771 | #ifdef CLOCK_PROF |
| 1772 | PyModule_AddIntMacro(m, CLOCK_PROF); |
| 1773 | #endif |
| 1774 | #ifdef CLOCK_BOOTTIME |
| 1775 | PyModule_AddIntMacro(m, CLOCK_BOOTTIME); |
| 1776 | #endif |
| 1777 | #ifdef CLOCK_UPTIME |
| 1778 | PyModule_AddIntMacro(m, CLOCK_UPTIME); |
| 1779 | #endif |
Joannah Nanjekye | 572168a | 2019-01-10 19:56:38 +0300 | [diff] [blame] | 1780 | #ifdef CLOCK_UPTIME_RAW |
| 1781 | PyModule_AddIntMacro(m, CLOCK_UPTIME_RAW); |
| 1782 | #endif |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 1783 | |
Max Bélanger | 9445118 | 2018-10-20 17:07:54 -0700 | [diff] [blame] | 1784 | #endif /* defined(HAVE_CLOCK_GETTIME) || defined(HAVE_CLOCK_SETTIME) || defined(HAVE_CLOCK_GETRES) */ |
| 1785 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1786 | if (!initialized) { |
Victor Stinner | 1c8f059 | 2013-07-22 22:24:54 +0200 | [diff] [blame] | 1787 | if (PyStructSequence_InitType2(&StructTimeType, |
| 1788 | &struct_time_type_desc) < 0) |
| 1789 | return NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1790 | } |
| 1791 | Py_INCREF(&StructTimeType); |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 1792 | PyModule_AddIntConstant(m, "_STRUCT_TM_ITEMS", 11); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1793 | PyModule_AddObject(m, "struct_time", (PyObject*) &StructTimeType); |
| 1794 | initialized = 1; |
Benjamin Peterson | 5633c4f | 2018-09-14 09:09:04 -0700 | [diff] [blame] | 1795 | |
| 1796 | #if defined(__linux__) && !defined(__GLIBC__) |
| 1797 | struct tm tm; |
Benjamin Peterson | b93062b | 2018-09-14 10:39:13 -0700 | [diff] [blame] | 1798 | const time_t zero = 0; |
| 1799 | if (gmtime_r(&zero, &tm) != NULL) |
Benjamin Peterson | 5633c4f | 2018-09-14 09:09:04 -0700 | [diff] [blame] | 1800 | utc_string = tm.tm_zone; |
| 1801 | #endif |
| 1802 | |
Victor Stinner | 3bb150d | 2018-12-03 13:45:38 +0100 | [diff] [blame] | 1803 | if (PyErr_Occurred()) { |
| 1804 | return NULL; |
| 1805 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1806 | return m; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1807 | } |
| 1808 | |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1809 | /* Implement pysleep() for various platforms. |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1810 | When interrupted (or when another error occurs), return -1 and |
| 1811 | set an exception; else return 0. */ |
| 1812 | |
| 1813 | static int |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1814 | pysleep(_PyTime_t secs) |
Guido van Rossum | 426035c | 1991-02-19 12:27:35 +0000 | [diff] [blame] | 1815 | { |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1816 | _PyTime_t deadline, monotonic; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1817 | #ifndef MS_WINDOWS |
| 1818 | struct timeval timeout; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1819 | int err = 0; |
| 1820 | #else |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1821 | _PyTime_t millisecs; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1822 | unsigned long ul_millis; |
| 1823 | DWORD rc; |
| 1824 | HANDLE hInterruptEvent; |
Victor Stinner | 0c2fd89 | 2015-03-17 10:49:17 +0100 | [diff] [blame] | 1825 | #endif |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1826 | |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1827 | deadline = _PyTime_GetMonotonicClock() + secs; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1828 | |
| 1829 | do { |
| 1830 | #ifndef MS_WINDOWS |
Victor Stinner | 869e177 | 2015-03-30 03:49:14 +0200 | [diff] [blame] | 1831 | if (_PyTime_AsTimeval(secs, &timeout, _PyTime_ROUND_CEILING) < 0) |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1832 | return -1; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1833 | |
| 1834 | Py_BEGIN_ALLOW_THREADS |
| 1835 | err = select(0, (fd_set *)0, (fd_set *)0, (fd_set *)0, &timeout); |
| 1836 | Py_END_ALLOW_THREADS |
| 1837 | |
| 1838 | if (err == 0) |
| 1839 | break; |
| 1840 | |
| 1841 | if (errno != EINTR) { |
Victor Stinner | 0c2fd89 | 2015-03-17 10:49:17 +0100 | [diff] [blame] | 1842 | PyErr_SetFromErrno(PyExc_OSError); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1843 | return -1; |
| 1844 | } |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1845 | #else |
Victor Stinner | 869e177 | 2015-03-30 03:49:14 +0200 | [diff] [blame] | 1846 | millisecs = _PyTime_AsMilliseconds(secs, _PyTime_ROUND_CEILING); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1847 | if (millisecs > (double)ULONG_MAX) { |
| 1848 | PyErr_SetString(PyExc_OverflowError, |
| 1849 | "sleep length is too large"); |
| 1850 | return -1; |
| 1851 | } |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1852 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1853 | /* Allow sleep(0) to maintain win32 semantics, and as decreed |
| 1854 | * by Guido, only the main thread can be interrupted. |
| 1855 | */ |
| 1856 | ul_millis = (unsigned long)millisecs; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1857 | if (ul_millis == 0 || !_PyOS_IsMainThread()) { |
| 1858 | Py_BEGIN_ALLOW_THREADS |
Victor Stinner | 0eac130 | 2015-03-20 03:06:12 +0100 | [diff] [blame] | 1859 | Sleep(ul_millis); |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1860 | Py_END_ALLOW_THREADS |
| 1861 | break; |
Victor Stinner | 945c82e | 2015-03-12 16:19:01 +0100 | [diff] [blame] | 1862 | } |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1863 | |
| 1864 | hInterruptEvent = _PyOS_SigintEvent(); |
| 1865 | ResetEvent(hInterruptEvent); |
| 1866 | |
| 1867 | Py_BEGIN_ALLOW_THREADS |
| 1868 | rc = WaitForSingleObjectEx(hInterruptEvent, ul_millis, FALSE); |
Victor Stinner | 0c2fd89 | 2015-03-17 10:49:17 +0100 | [diff] [blame] | 1869 | Py_END_ALLOW_THREADS |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1870 | |
| 1871 | if (rc != WAIT_OBJECT_0) |
| 1872 | break; |
Victor Stinner | 945c82e | 2015-03-12 16:19:01 +0100 | [diff] [blame] | 1873 | #endif |
Victor Stinner | 0c2fd89 | 2015-03-17 10:49:17 +0100 | [diff] [blame] | 1874 | |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1875 | /* sleep was interrupted by SIGINT */ |
| 1876 | if (PyErr_CheckSignals()) |
| 1877 | return -1; |
| 1878 | |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1879 | monotonic = _PyTime_GetMonotonicClock(); |
| 1880 | secs = deadline - monotonic; |
Victor Stinner | 6aa446c | 2015-03-30 21:33:51 +0200 | [diff] [blame] | 1881 | if (secs < 0) |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1882 | break; |
| 1883 | /* retry with the recomputed delay */ |
| 1884 | } while (1); |
| 1885 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1886 | return 0; |
Guido van Rossum | 80c9d88 | 1991-04-16 08:47:51 +0000 | [diff] [blame] | 1887 | } |