[3.5] bpo-30807: signal.setitimer() may disable the timer by mistake (GH-2493) (#2498)

pitrou · web-flow · commit 5741b70acf88 · 2017-06-30T10:54:32.000+02:00
* bpo-30807: signal.setitimer() may disable the timer by mistake * Add NEWS blurb (cherry picked from commit 729780a)
diff --git a/Lib/test/test_signal.py b/Lib/test/test_signal.py
@@ -764,6 +764,15 @@ def test_itimer_prof(self):
         # and the handler should have been called
         self.assertEqual(self.hndl_called, True)
 
+    def test_setitimer_tiny(self):
+        # bpo-30807: C setitimer() takes a microsecond-resolution interval.
+        # Check that float -> timeval conversion doesn't round
+        # the interval down to zero, which would disable the timer.
+        self.itimer = signal.ITIMER_REAL
+        signal.setitimer(self.itimer, 1e-6)
+        time.sleep(1)
+        self.assertEqual(self.hndl_called, True)
+
 
 class PendingSignalsTests(unittest.TestCase):
     """
diff --git a/Misc/NEWS.d/next/Library/2017-06-29-22-04-44.bpo-30807.sLtjY-.rst b/Misc/NEWS.d/next/Library/2017-06-29-22-04-44.bpo-30807.sLtjY-.rst
@@ -0,0 +1,6 @@
+signal.setitimer() may disable the timer when passed a tiny value.
+
+Tiny values (such as 1e-6) are valid non-zero values for setitimer(), which
+is specified as taking microsecond-resolution intervals. However, on some
+platform, our conversion routine could convert 1e-6 into a zero interval,
+therefore disabling the timer instead of (re-)scheduling it.
diff --git a/Modules/signalmodule.c b/Modules/signalmodule.c
@@ -139,6 +139,10 @@ timeval_from_double(double d, struct timeval *tv)
 {
     tv->tv_sec = floor(d);
     tv->tv_usec = fmod(d, 1.0) * 1000000.0;
+    /* Don't disable the timer if the computation above rounds down to zero. */
+    if (d > 0.0 && tv->tv_sec == 0 && tv->tv_usec == 0) {
+        tv->tv_usec = 1;
+    }
 }
 
 Py_LOCAL_INLINE(double)

Original file line number	Diff line number	Diff line change
`@@ -139,6 +139,10 @@ timeval_from_double(double d, struct timeval *tv)`
`139`	`139`	`{`
`140`	`140`	`tv->tv_sec = floor(d);`
`141`	`141`	`tv->tv_usec = fmod(d, 1.0) * 1000000.0;`
	`142`	`+ /* Don't disable the timer if the computation above rounds down to zero. */`
	`143`	`+ if (d > 0.0 && tv->tv_sec == 0 && tv->tv_usec == 0) {`
	`144`	`+ tv->tv_usec = 1;`
	`145`	`+ }`
`142`	`146`	`}`
`143`	`147`
`144`	`148`	`Py_LOCAL_INLINE(double)`