FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-41710: Add _PyTime_AsTimespec_clamp() (GH-28629) · python/cpython@09796f2 · GitHub

/ cpython Public

Commit 09796f2

Browse files
vstinner
authored
bpo-41710: Add _PyTime_AsTimespec_clamp() (GH-28629)
Add the _PyTime_AsTimespec_clamp() function: similar to _PyTime_AsTimespec(), but clamp to _PyTime_t min/max and don't raise an exception. PyThread_acquire_lock_timed() now uses _PyTime_AsTimespec_clamp() to remove the Py_UNREACHABLE() code path. * Add _PyTime_AsTime_t() function. * Add PY_TIME_T_MIN and PY_TIME_T_MAX constants. * Replace _PyTime_AsTimeval_noraise() with _PyTime_AsTimeval_clamp(). * Add pytime_divide_round_up() function. * Fix integer overflow in pytime_divide(). * Add pytime_divmod() function.
1 parent 8d3e7ef commit 09796f2

8 files changed

Lines changed: 269 additions & 91 deletions

File tree

‎Include/cpython/pytime.h‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ extern "C" {
1616
typedef int64_t _PyTime_t;
1717
#define _PyTime_MIN INT64_MIN
1818
#define _PyTime_MAX INT64_MAX
19+
#define _SIZEOF_PYTIME_T 8
1920

2021
typedef enum {
2122
/* Round towards minus infinity (-inf).
@@ -136,8 +137,9 @@ PyAPI_FUNC(int) _PyTime_AsTimeval(_PyTime_t t,
136137
struct timeval *tv,
137138
_PyTime_round_t round);
138139

139-
/* Similar to _PyTime_AsTimeval(), but don't raise an exception on error. */
140-
PyAPI_FUNC(int) _PyTime_AsTimeval_noraise(_PyTime_t t,
140+
/* Similar to _PyTime_AsTimeval() but don't raise an exception on overflow.
141+
On overflow, clamp tv_sec to _PyTime_t min/max. */
142+
PyAPI_FUNC(void) _PyTime_AsTimeval_clamp(_PyTime_t t,
141143
struct timeval *tv,
142144
_PyTime_round_t round);
143145

@@ -162,6 +164,10 @@ PyAPI_FUNC(int) _PyTime_FromTimespec(_PyTime_t *tp, struct timespec *ts);
162164
tv_nsec is always positive.
163165
Raise an exception and return -1 on error, return 0 on success. */
164166
PyAPI_FUNC(int) _PyTime_AsTimespec(_PyTime_t t, struct timespec *ts);
167+
168+
/* Similar to _PyTime_AsTimespec() but don't raise an exception on overflow.
169+
On overflow, clamp tv_sec to _PyTime_t min/max. */
170+
PyAPI_FUNC(void) _PyTime_AsTimespec_clamp(_PyTime_t t, struct timespec *ts);
165171
#endif
166172

167173
/* Compute ticks * mul / div.
@@ -181,7 +187,7 @@ typedef struct {
181187
/* Get the current time from the system clock.
182188
183189
If the internal clock fails, silently ignore the error and return 0.
184-
On integer overflow, silently ignore the overflow and truncated the clock to
190+
On integer overflow, silently ignore the overflow and clamp the clock to
185191
_PyTime_MIN or _PyTime_MAX.
186192
187193
Use _PyTime_GetSystemClockWithInfo() to check for failure. */
@@ -201,7 +207,7 @@ PyAPI_FUNC(int) _PyTime_GetSystemClockWithInfo(
201207
results of consecutive calls is valid.
202208
203209
If the internal clock fails, silently ignore the error and return 0.
204-
On integer overflow, silently ignore the overflow and truncated the clock to
210+
On integer overflow, silently ignore the overflow and clamp the clock to
205211
_PyTime_MIN or _PyTime_MAX.
206212
207213
Use _PyTime_GetMonotonicClockWithInfo() to check for failure. */
@@ -232,7 +238,7 @@ PyAPI_FUNC(int) _PyTime_gmtime(time_t t, struct tm *tm);
232238
measure a short duration.
233239
234240
If the internal clock fails, silently ignore the error and return 0.
235-
On integer overflow, silently ignore the overflow and truncated the clock to
241+
On integer overflow, silently ignore the overflow and clamp the clock to
236242
_PyTime_MIN or _PyTime_MAX.
237243
238244
Use _PyTime_GetPerfCounterWithInfo() to check for failure. */

‎Lib/test/test_time.py‎

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ class _PyTime(enum.IntEnum):
3838
# Round away from zero
3939
ROUND_UP = 3
4040

41+
# _PyTime_t is int64_t
42+
_PyTime_MIN = -2 ** 63
43+
_PyTime_MAX = 2 ** 63 - 1
44+
4145
# Rounding modes supported by PyTime
4246
ROUNDING_MODES = (
4347
# (PyTime rounding method, decimal rounding method)
@@ -960,6 +964,49 @@ def timespec_converter(ns):
960964
NS_TO_SEC,
961965
value_filter=self.time_t_filter)
962966

967+
@unittest.skipUnless(hasattr(_testcapi, 'PyTime_AsTimeval_clamp'),
968+
'need _testcapi.PyTime_AsTimeval_clamp')
969+
def test_AsTimeval_clamp(self):
970+
from _testcapi import PyTime_AsTimeval_clamp
971+
972+
if sys.platform == 'win32':
973+
from _testcapi import LONG_MIN, LONG_MAX
974+
tv_sec_max = LONG_MAX
975+
tv_sec_min = LONG_MIN
976+
else:
977+
tv_sec_max = self.time_t_max
978+
tv_sec_min = self.time_t_min
979+
980+
for t in (_PyTime_MIN, _PyTime_MAX):
981+
ts = PyTime_AsTimeval_clamp(t, _PyTime.ROUND_CEILING)
982+
with decimal.localcontext() as context:
983+
context.rounding = decimal.ROUND_CEILING
984+
us = self.decimal_round(decimal.Decimal(t) / US_TO_NS)
985+
tv_sec, tv_usec = divmod(us, SEC_TO_US)
986+
if tv_sec_max < tv_sec:
987+
tv_sec = tv_sec_max
988+
tv_usec = 0
989+
elif tv_sec < tv_sec_min:
990+
tv_sec = tv_sec_min
991+
tv_usec = 0
992+
self.assertEqual(ts, (tv_sec, tv_usec))
993+
994+
@unittest.skipUnless(hasattr(_testcapi, 'PyTime_AsTimespec_clamp'),
995+
'need _testcapi.PyTime_AsTimespec_clamp')
996+
def test_AsTimespec_clamp(self):
997+
from _testcapi import PyTime_AsTimespec_clamp
998+
999+
for t in (_PyTime_MIN, _PyTime_MAX):
1000+
ts = PyTime_AsTimespec_clamp(t)
1001+
tv_sec, tv_nsec = divmod(t, NS_TO_SEC)
1002+
if self.time_t_max < tv_sec:
1003+
tv_sec = self.time_t_max
1004+
tv_nsec = 0
1005+
elif tv_sec < self.time_t_min:
1006+
tv_sec = self.time_t_min
1007+
tv_nsec = 0
1008+
self.assertEqual(ts, (tv_sec, tv_nsec))
1009+
9631010
def test_AsMilliseconds(self):
9641011
from _testcapi import PyTime_AsMilliseconds
9651012

@@ -1062,7 +1109,7 @@ def test_clock_functions(self):
10621109
clock_names = [
10631110
"CLOCK_MONOTONIC", "clock_gettime", "clock_gettime_ns", "clock_settime",
10641111
"clock_settime_ns", "clock_getres"]
1065-
1112+
10661113
if mac_ver >= (10, 12):
10671114
for name in clock_names:
10681115
self.assertTrue(hasattr(time, name), f"time.{name} is not available")

‎Modules/_ssl.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2264,7 +2264,7 @@ PySSL_select(PySocketSockObject *s, int writing, _PyTime_t timeout)
22642264
if (!_PyIsSelectable_fd(s->sock_fd))
22652265
return SOCKET_TOO_LARGE_FOR_SELECT;
22662266

2267-
_PyTime_AsTimeval_noraise(timeout, &tv, _PyTime_ROUND_CEILING);
2267+
_PyTime_AsTimeval_clamp(timeout, &tv, _PyTime_ROUND_CEILING);
22682268

22692269
FD_ZERO(&fds);
22702270
FD_SET(s->sock_fd, &fds);

‎Modules/_testcapimodule.c‎

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4687,7 +4687,32 @@ test_PyTime_AsTimeval(PyObject *self, PyObject *args)
46874687
if (seconds == NULL) {
46884688
return NULL;
46894689
}
4690-
return Py_BuildValue("Nl", seconds, tv.tv_usec);
4690+
return Py_BuildValue("Nl", seconds, (long)tv.tv_usec);
4691+
}
4692+
4693+
static PyObject *
4694+
test_PyTime_AsTimeval_clamp(PyObject *self, PyObject *args)
4695+
{
4696+
PyObject *obj;
4697+
int round;
4698+
if (!PyArg_ParseTuple(args, "Oi", &obj, &round)) {
4699+
return NULL;
4700+
}
4701+
if (check_time_rounding(round) < 0) {
4702+
return NULL;
4703+
}
4704+
_PyTime_t t;
4705+
if (_PyTime_FromNanosecondsObject(&t, obj) < 0) {
4706+
return NULL;
4707+
}
4708+
struct timeval tv;
4709+
_PyTime_AsTimeval_clamp(t, &tv, round);
4710+
4711+
PyObject *seconds = PyLong_FromLongLong(tv.tv_sec);
4712+
if (seconds == NULL) {
4713+
return NULL;
4714+
}
4715+
return Py_BuildValue("Nl", seconds, (long)tv.tv_usec);
46914716
}
46924717

46934718
#ifdef HAVE_CLOCK_GETTIME
@@ -4708,6 +4733,22 @@ test_PyTime_AsTimespec(PyObject *self, PyObject *args)
47084733
}
47094734
return Py_BuildValue("Nl", _PyLong_FromTime_t(ts.tv_sec), ts.tv_nsec);
47104735
}
4736+
4737+
static PyObject *
4738+
test_PyTime_AsTimespec_clamp(PyObject *self, PyObject *args)
4739+
{
4740+
PyObject *obj;
4741+
if (!PyArg_ParseTuple(args, "O", &obj)) {
4742+
return NULL;
4743+
}
4744+
_PyTime_t t;
4745+
if (_PyTime_FromNanosecondsObject(&t, obj) < 0) {
4746+
return NULL;
4747+
}
4748+
struct timespec ts;
4749+
_PyTime_AsTimespec_clamp(t, &ts);
4750+
return Py_BuildValue("Nl", _PyLong_FromTime_t(ts.tv_sec), ts.tv_nsec);
4751+
}
47114752
#endif
47124753

47134754
static PyObject *
@@ -5872,8 +5913,10 @@ static PyMethodDef TestMethods[] = {
58725913
{"PyTime_FromSecondsObject", test_pytime_fromsecondsobject, METH_VARARGS},
58735914
{"PyTime_AsSecondsDouble", test_pytime_assecondsdouble, METH_VARARGS},
58745915
{"PyTime_AsTimeval", test_PyTime_AsTimeval, METH_VARARGS},
5916+
{"PyTime_AsTimeval_clamp", test_PyTime_AsTimeval_clamp, METH_VARARGS},
58755917
#ifdef HAVE_CLOCK_GETTIME
58765918
{"PyTime_AsTimespec", test_PyTime_AsTimespec, METH_VARARGS},
5919+
{"PyTime_AsTimespec_clamp", test_PyTime_AsTimespec_clamp, METH_VARARGS},
58775920
#endif
58785921
{"PyTime_AsMilliseconds", test_PyTime_AsMilliseconds, METH_VARARGS},
58795922
{"PyTime_AsMicroseconds", test_PyTime_AsMicroseconds, METH_VARARGS},

‎Modules/selectmodule.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ select_select_impl(PyObject *module, PyObject *rlist, PyObject *wlist,
344344
n = 0;
345345
break;
346346
}
347-
_PyTime_AsTimeval_noraise(timeout, &tv, _PyTime_ROUND_CEILING);
347+
_PyTime_AsTimeval_clamp(timeout, &tv, _PyTime_ROUND_CEILING);
348348
/* retry select() with the recomputed timeout */
349349
}
350350
} while (1);

‎Modules/socketmodule.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -758,7 +758,7 @@ internal_select(PySocketSockObject *s, int writing, _PyTime_t interval,
758758
Py_END_ALLOW_THREADS;
759759
#else
760760
if (interval >= 0) {
761-
_PyTime_AsTimeval_noraise(interval, &tv, _PyTime_ROUND_CEILING);
761+
_PyTime_AsTimeval_clamp(interval, &tv, _PyTime_ROUND_CEILING);
762762
tvp = &tv;
763763
}
764764
else

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL