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