Update gdb performance testsuite to be compatible with Python 3.8

Running "make check-perf" on a system with Python 3.8 (e.g., Ubuntu
20.04) runs into this Python problem:

  Traceback (most recent call last):
    File "<string>", line 1, in <module>
    File "/home/pedro/rocm/gdb/src/gdb/testsuite/gdb.perf/lib/perftest/perftest.py", line 65, in run
      self.execute_test()
    File "<string>", line 35, in execute_test
    File "/home/pedro/rocm/gdb/src/gdb/testsuite/gdb.perf/lib/perftest/measure.py", line 45, in measure
      m.start(id)
    File "/home/pedro/rocm/gdb/src/gdb/testsuite/gdb.perf/lib/perftest/measure.py", line 102, in start
      self.start_time = time.clock()
  AttributeError: module 'time' has no attribute 'clock'
  Error while executing Python code.
  (gdb) FAIL: gdb.perf/single-step.exp: python SingleStep(1000).run()

... many times over.

The problem is that the testsuite is using time.clock(), deprecated in
Python 3.3 and finaly removed in Python 3.8.  The guidelines say to
use time.perf_counter() or time.process_time() instead depending on
requirements.  Looking at the current description of those functions,
at:

   https://docs.python.org/3.10/library/time.html

we have:

   time.perf_counter() -> float

       Return the value (in fractional seconds) of a performance
       counter, i.e. a clock with the highest available resolution to
       measure a short duration. It does include time elapsed during
       sleep and is system-wide. (...)

   time.process_time() -> float

       Return the value (in fractional seconds) of the sum of the
       system and user CPU time of the current process. It does not
       include time elapsed during sleep. It is process-wide by
       definition. (...)

I'm thinking that it's just best to record both instead of picking
one.  So this patch replaces the MeasurementCpuTime measurement class
with two new classes -- MeasurementPerfCounter and
MeasurementProcessTime.  Correspondingly, this changes the reports in
testsuite/perftest.log -- we have two new "perf_counter" and
"process_time" measurements and the "cpu_time" measurement is gone.  I
don't suppose breaking backward compatibility here is a big problem.
I suspect no one is really tracking long term performance using the
perf testsuite today.  And if they are, it shouldn't be hard to adjust.

For backward compatility, with Python < 3.3, both perf_counter and
process_time use the old time.clock.

gdb/testsuite/ChangeLog:
yyyy-mm-dd  Qingchuan Shi  <qingchuan.shi@amd.com>
	    Pedro Alves  <pedro@palves.net>

	* gdb.perf/lib/perftest/perftest.py: Import sys.
	(time.perf_counter, time.process_time): Map to time.clock on
	Python < 3.3.
	(MeasurementCpuTime): Delete, replaced by...
	(MeasurementPerfCounter, MeasurementProcessTime): .. these two new
	classes.
	* gdb.perf/lib/perftest/perftest.py: Import MeasurementPerfCounter
	and MeasurementProcessTime instead of MeasurementCpuTime.
	(TestCaseWithBasicMeasurements): Use MeasurementPerfCounter and
	MeasurementProcessTime instead of MeasurementCpuTime.

Co-authored-by: Qingchuan Shi <qingchuan.shi@amd.com>

Change-Id: Ia850c05d5ce57d2dada70ba5b0061f566444aa2b
This commit is contained in:
Pedro Alves 2021-06-03 09:59:54 -04:00
parent e3e837844a
commit 46f2c22eab
2 changed files with 40 additions and 16 deletions

View File

@ -16,6 +16,13 @@
import time
import os
import gc
import sys
# time.perf_counter() and time.process_time() were added in Python
# 3.3, time.clock() was removed in Python 3.8.
if sys.version_info < (3, 3, 0):
time.perf_counter = time.clock
time.process_time = time.clock
class Measure(object):
@ -85,28 +92,43 @@ class Measurement(object):
self.result.report(reporter, name + " " + self.name)
class MeasurementCpuTime(Measurement):
"""Measurement on CPU time."""
class MeasurementPerfCounter(Measurement):
"""Measurement on performance counter."""
# On UNIX, time.clock() measures the amount of CPU time that has
# been used by the current process. On Windows it will measure
# wall-clock seconds elapsed since the first call to the function.
# Something other than time.clock() should be used to measure CPU
# time on Windows.
# Measures time in fractional seconds, using a performance
# counter, i.e. a clock with the highest available resolution to
# measure a short duration. It includes time elapsed during sleep
# and is system-wide.
def __init__(self, result):
super(MeasurementCpuTime, self).__init__("cpu_time", result)
super(MeasurementPerfCounter, self).__init__("perf_counter", result)
self.start_time = 0
def start(self, id):
self.start_time = time.clock()
self.start_time = time.perf_counter()
def stop(self, id):
if os.name == "nt":
cpu_time = 0
else:
cpu_time = time.clock() - self.start_time
self.result.record(id, cpu_time)
perf_counter = time.perf_counter() - self.start_time
self.result.record(id, perf_counter)
class MeasurementProcessTime(Measurement):
"""Measurement on process time."""
# Measures the sum of the system and user CPU time of the current
# process. Does not include time elapsed during sleep. It is
# process-wide by definition.
def __init__(self, result):
super(MeasurementProcessTime, self).__init__("process_time", result)
self.start_time = 0
def start(self, id):
self.start_time = time.process_time()
def stop(self, id):
process_time = time.process_time() - self.start_time
self.result.record(id, process_time)
class MeasurementWallTime(Measurement):

View File

@ -18,7 +18,8 @@ from __future__ import absolute_import
import perftest.testresult as testresult
import perftest.reporter as reporter
from perftest.measure import Measure
from perftest.measure import MeasurementCpuTime
from perftest.measure import MeasurementPerfCounter
from perftest.measure import MeasurementProcessTime
from perftest.measure import MeasurementWallTime
from perftest.measure import MeasurementVmSize
@ -72,7 +73,8 @@ class TestCaseWithBasicMeasurements(TestCase):
def __init__(self, name):
result_factory = testresult.SingleStatisticResultFactory()
measurements = [
MeasurementCpuTime(result_factory.create_result()),
MeasurementPerfCounter(result_factory.create_result()),
MeasurementProcessTime(result_factory.create_result()),
MeasurementWallTime(result_factory.create_result()),
MeasurementVmSize(result_factory.create_result()),
]