client/site_tests/hardware_StorageFio/hardware_StorageFio.py - mirrors/cros/chromiumos/third_party/autotest - Git at Google

 # Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.

 import logging, os, re, time
 from fio_parser import fio_job_output

 from autotest_lib.client.bin import test, utils
 from autotest_lib.client.common_lib import error


 class hardware_StorageFio(test.test):
     """
     Runs several fio jobs and reports results.

     fio (flexible I/O tester) is an I/O tool for benchmark and stress/hardware
     verification.

     """

     version = 7
     DEFAULT_FILE_SIZE = 1024 * 1024 * 1024
     VERIFY_OPTION = 'v'

     # Initialize fail counter used to determine test pass/fail.
     _fail_count = 0

     def __find_free_root_partition(self):
         """Locate the spare root partition that we didn't boot off"""

         spare_root_map = {
             '3': '5',
             '5': '3',
         }
         rootdev = utils.system_output('rootdev -s')
         spare_root = rootdev[:-1] + spare_root_map[rootdev[-1]]
         self.__filename = spare_root


     def __get_file_size(self):
         """Return the size in bytes of the device pointed to by __filename"""

         device = os.path.basename(self.__filename)
         for line in file('/proc/partitions'):
             try:
                 major, minor, blocks, name = re.split(r' +', line.strip())
             except ValueError:
                 continue
             if name == device:
                 blocks = int(blocks)
                 self.__filesize = 1024 * blocks
                 break
         else:
             if device.startswith(utils.system_output('rootdev -s -d')):
                 raise error.TestError(
                     'Unable to determine free partitions size')
             else:
                 raise error.TestNAError(
                     'Unable to find the partition %s, please plug in a USB '
                     'flash drive and a SD card for testing external storage' %
                     self.__filename)


     def __get_device_description(self):
         """Get the device vendor and model name as its description"""

         # Find the block device in sysfs. For example, a card read device may
         # be in /sys/devices/pci0000:00/0000:00:1d.7/usb1/1-5/1-5:1.0/host4/
         # target4:0:0/4:0:0:0/block/sdb.
         # Then read the vendor and model name in its grand-parent directory.

         # Obtain the device name by stripping the partition number.
         # For example, on x86: sda3 => sda; on ARM: mmcblk1p3 => mmcblk1.
         device = os.path.basename(
             re.sub('(sd[a-z]|mmcblk[0-9]+)p?[0-9]+', '\\1', self.__filename))
         findsys = utils.run('find /sys/devices -name %s' % device)
         device_path = findsys.stdout.rstrip()

         vendor_file = device_path.replace('block/%s' % device, 'vendor')
         model_file = device_path.replace('block/%s' % device, 'model')
         if os.path.exists(vendor_file) and os.path.exists(model_file):
             vendor = utils.read_one_line(vendor_file).strip()
             model = utils.read_one_line(model_file).strip()
             self.__description = vendor + ' ' + model
         else:
             self.__description = ''


     def __parse_fio(self, lines):
         """Parse the terse fio output

         This collects all metrics given by fio and labels them according to unit
         of measurement and test case name.

         """
         # fio version 2.0.8+ outputs all needed information with --minimal
         # Using that instead of the human-readable version, since it's easier
         # to parse.
         # Following is a partial example of the semicolon-delimited output.
         # 3;fio-2.1;quick_write;0;0;0;0;0;0;0;0;0.000000;0.000000;0;0;0.000000;
         # 0.000000;1.000000%=0;5.000000%=0;10.000000%=0;20.000000%=0;
         # ...
         # Refer to the HOWTO file of the fio package for more information.

         results = {}

         # Extract the values from the test.
         for line in lines.splitlines():
             # Put the values from the output into an array.
             values = line.split(';')
             # This check makes sure that we are parsing the actual values
             # instead of the job description or possible blank lines.
             if len(values) <= 128:
                 continue
             results.update(fio_job_output(values))

         return results


     def __RunFio(self, job):
         """
         Runs fio.

         @param job: fio config file to use

         @return fio results.

         """
         env_vars = ' '.join(
             ['FILENAME=' + self.__filename,
              'FILESIZE=' + str(self.__filesize),
              'VERIFY_ONLY=' + str(int(self.__verify_only))
              ])

         # running fio with ionice -c 3 so it doesn't lock out other
         # processes from the disk while it is running.
         # If you want to run the fio test for performance purposes,
         # take out the ionice and disable hung process detection:
         # "echo 0 > /proc/sys/kernel/hung_task_timeout_secs"
         # -c 3 = Idle
         # Tried lowest priority for "best effort" but still failed
         ionice = 'ionice -c 3'

         # Using the --minimal flag for easier results parsing
         # Newest fio doesn't omit any information in --minimal
         # Need to set terse-version to 4 for trim related output
         options = ['--minimal', '--terse-version=4']
         fio_cmd_line = ' '.join([env_vars, ionice, 'fio',
                                  ' '.join(options),
                                  '"' + os.path.join(self.bindir, job + '"')])
         fio = utils.run(fio_cmd_line)

         logging.debug(fio.stdout)
         output = self.__parse_fio(fio.stdout)
         for k, v in output.iteritems():
             if k.endswith('_error'):
                 self._fail_count += int(v)
         return output

     def initialize(self, dev='', filesize=DEFAULT_FILE_SIZE):
         """
         Set up local variables.

         @param dev: block device / file to test.
                 Spare partition on root device by default
         @param filesize: size of the file. 0 means whole partition.
                 by default, 1GB.
         """
         if dev != '' and (os.path.isfile(dev) or not os.path.exists(dev)):
             if filesize == 0:
                 raise error.TestError(
                     'Nonzero file size is required to test file systems')
             self.__filename = dev
             self.__filesize = filesize
             self.__description = ''
             return

         if dev in ['', utils.system_output('rootdev -s -d')]:
             if filesize == 0:
                 raise error.TestError(
                     'Using the root device as a whole is not allowed')
             self.__find_free_root_partition()
         elif filesize != 0:
             # Use the first partition of the external drive
             if dev[5:7] == 'sd':
                 self.__filename = dev + '1'
             else:
                 self.__filename = dev + 'p1'
         else:
             self.__filename = dev
         self.__get_file_size()
         self.__get_device_description()

         # Restrict test to use a given file size, default 1GiB
         if filesize != 0:
             self.__filesize = min(self.__filesize, filesize)

         self.__verify_only = False

     def run_once(self, dev='', quicktest=False, requirements=None,
                  integrity=False, wait=60 * 60 * 72):
         """
         Runs several fio jobs and reports results.

         @param dev: block device to test
         @param quicktest: short test
         @param requirements: list of jobs for fio to run
         @param integrity: test to check data integrity
         @param wait: seconds to wait between a write and subsequent verify

         """

         if requirements is not None:
             pass
         elif quicktest:
             requirements = [
                 ('1m_write', []),
                 ('16k_read', [])
             ]
         elif integrity:
             requirements = [
                 ('8k_async_randwrite', []),
                 ('8k_async_randwrite', [self.VERIFY_OPTION])
             ]
         elif dev in ['', utils.system_output('rootdev -s -d')]:
             requirements = [
                 ('surfing', []),
                 ('boot', []),
                 ('login', []),
                 ('seq_read', []),
                 ('seq_write', []),
                 ('16k_read', []),
                 ('16k_write', []),
                 ('1m_stress', []),
             ]
         else:
             # TODO(waihong@): Add more test cases for external storage
             requirements = [
                 ('seq_read', []),
                 ('seq_write', []),
                 ('16k_read', []),
                 ('16k_write', []),
                 ('1m_stress', []),
             ]

         results = {}
         for job, options in requirements:
             # Keys are labeled according to the test case name, which is
             # unique per run, so they cannot clash
             if self.VERIFY_OPTION in options:
                 time.sleep(wait)
                 self.__verify_only = True
             else:
                 self.__verify_only = False
             results.update(self.__RunFio(job))

         # Output keys relevant to the performance, larger filesize will run
         # slower, and sda5 should be slightly slower than sda3 on a rotational
         # disk
         self.write_test_keyval({'filesize': self.__filesize,
                                 'filename': self.__filename,
                                 'device': self.__description})
         logging.info('Device Description: %s', self.__description)
         self.write_perf_keyval(results)
         if self._fail_count > 0:
             raise error.TestFail('%s failed verifications' %
                                  str(self._fail_count))
	# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
	# Use of this source code is governed by a BSD-style license that can be
	# found in the LICENSE file.

	import logging, os, re, time
	from fio_parser import fio_job_output

	from autotest_lib.client.bin import test, utils
	from autotest_lib.client.common_lib import error


	class hardware_StorageFio(test.test):
	"""
	Runs several fio jobs and reports results.

	fio (flexible I/O tester) is an I/O tool for benchmark and stress/hardware
	verification.

	"""

	version = 7
	DEFAULT_FILE_SIZE = 1024 * 1024 * 1024
	VERIFY_OPTION = 'v'

	# Initialize fail counter used to determine test pass/fail.
	_fail_count = 0

	def __find_free_root_partition(self):
	"""Locate the spare root partition that we didn't boot off"""

	spare_root_map = {
	'3': '5',
	'5': '3',
	}
	rootdev = utils.system_output('rootdev -s')
	spare_root = rootdev[:-1] + spare_root_map[rootdev[-1]]
	self.__filename = spare_root


	def __get_file_size(self):
	"""Return the size in bytes of the device pointed to by __filename"""

	device = os.path.basename(self.__filename)
	for line in file('/proc/partitions'):
	try:
	major, minor, blocks, name = re.split(r' +', line.strip())
	except ValueError:
	continue
	if name == device:
	blocks = int(blocks)
	self.__filesize = 1024 * blocks
	break
	else:
	if device.startswith(utils.system_output('rootdev -s -d')):
	raise error.TestError(
	'Unable to determine free partitions size')
	else:
	raise error.TestNAError(
	'Unable to find the partition %s, please plug in a USB '
	'flash drive and a SD card for testing external storage' %
	self.__filename)


	def __get_device_description(self):
	"""Get the device vendor and model name as its description"""

	# Find the block device in sysfs. For example, a card read device may
	# be in /sys/devices/pci0000:00/0000:00:1d.7/usb1/1-5/1-5:1.0/host4/
	# target4:0:0/4:0:0:0/block/sdb.
	# Then read the vendor and model name in its grand-parent directory.

	# Obtain the device name by stripping the partition number.
	# For example, on x86: sda3 => sda; on ARM: mmcblk1p3 => mmcblk1.
	device = os.path.basename(
	re.sub('(sd[a-z]\|mmcblk[0-9]+)p?[0-9]+', '\\1', self.__filename))
	findsys = utils.run('find /sys/devices -name %s' % device)
	device_path = findsys.stdout.rstrip()

	vendor_file = device_path.replace('block/%s' % device, 'vendor')
	model_file = device_path.replace('block/%s' % device, 'model')
	if os.path.exists(vendor_file) and os.path.exists(model_file):
	vendor = utils.read_one_line(vendor_file).strip()
	model = utils.read_one_line(model_file).strip()
	self.__description = vendor + ' ' + model
	else:
	self.__description = ''


	def __parse_fio(self, lines):
	"""Parse the terse fio output

	This collects all metrics given by fio and labels them according to unit
	of measurement and test case name.

	"""
	# fio version 2.0.8+ outputs all needed information with --minimal
	# Using that instead of the human-readable version, since it's easier
	# to parse.
	# Following is a partial example of the semicolon-delimited output.
	# 3;fio-2.1;quick_write;0;0;0;0;0;0;0;0;0.000000;0.000000;0;0;0.000000;
	# 0.000000;1.000000%=0;5.000000%=0;10.000000%=0;20.000000%=0;
	# ...
	# Refer to the HOWTO file of the fio package for more information.

	results = {}

	# Extract the values from the test.
	for line in lines.splitlines():
	# Put the values from the output into an array.
	values = line.split(';')
	# This check makes sure that we are parsing the actual values
	# instead of the job description or possible blank lines.
	if len(values) <= 128:
	continue
	results.update(fio_job_output(values))

	return results


	def __RunFio(self, job):
	"""
	Runs fio.

	@param job: fio config file to use

	@return fio results.

	"""
	env_vars = ' '.join(
	['FILENAME=' + self.__filename,
	'FILESIZE=' + str(self.__filesize),
	'VERIFY_ONLY=' + str(int(self.__verify_only))
	])

	# running fio with ionice -c 3 so it doesn't lock out other
	# processes from the disk while it is running.
	# If you want to run the fio test for performance purposes,
	# take out the ionice and disable hung process detection:
	# "echo 0 > /proc/sys/kernel/hung_task_timeout_secs"
	# -c 3 = Idle
	# Tried lowest priority for "best effort" but still failed
	ionice = 'ionice -c 3'

	# Using the --minimal flag for easier results parsing
	# Newest fio doesn't omit any information in --minimal
	# Need to set terse-version to 4 for trim related output
	options = ['--minimal', '--terse-version=4']
	fio_cmd_line = ' '.join([env_vars, ionice, 'fio',
	' '.join(options),
	'"' + os.path.join(self.bindir, job + '"')])
	fio = utils.run(fio_cmd_line)

	logging.debug(fio.stdout)
	output = self.__parse_fio(fio.stdout)
	for k, v in output.iteritems():
	if k.endswith('_error'):
	self._fail_count += int(v)
	return output

	def initialize(self, dev='', filesize=DEFAULT_FILE_SIZE):
	"""
	Set up local variables.

	@param dev: block device / file to test.
	Spare partition on root device by default
	@param filesize: size of the file. 0 means whole partition.
	by default, 1GB.
	"""
	if dev != '' and (os.path.isfile(dev) or not os.path.exists(dev)):
	if filesize == 0:
	raise error.TestError(
	'Nonzero file size is required to test file systems')
	self.__filename = dev
	self.__filesize = filesize
	self.__description = ''
	return

	if dev in ['', utils.system_output('rootdev -s -d')]:
	if filesize == 0:
	raise error.TestError(
	'Using the root device as a whole is not allowed')
	self.__find_free_root_partition()
	elif filesize != 0:
	# Use the first partition of the external drive
	if dev[5:7] == 'sd':
	self.__filename = dev + '1'
	else:
	self.__filename = dev + 'p1'
	else:
	self.__filename = dev
	self.__get_file_size()
	self.__get_device_description()

	# Restrict test to use a given file size, default 1GiB
	if filesize != 0:
	self.__filesize = min(self.__filesize, filesize)

	self.__verify_only = False

	def run_once(self, dev='', quicktest=False, requirements=None,
	integrity=False, wait=60 * 60 * 72):
	"""
	Runs several fio jobs and reports results.

	@param dev: block device to test
	@param quicktest: short test
	@param requirements: list of jobs for fio to run
	@param integrity: test to check data integrity
	@param wait: seconds to wait between a write and subsequent verify

	"""

	if requirements is not None:
	pass
	elif quicktest:
	requirements = [
	('1m_write', []),
	('16k_read', [])
	]
	elif integrity:
	requirements = [
	('8k_async_randwrite', []),
	('8k_async_randwrite', [self.VERIFY_OPTION])
	]
	elif dev in ['', utils.system_output('rootdev -s -d')]:
	requirements = [
	('surfing', []),
	('boot', []),
	('login', []),
	('seq_read', []),
	('seq_write', []),
	('16k_read', []),
	('16k_write', []),
	('1m_stress', []),
	]
	else:
	# TODO(waihong@): Add more test cases for external storage
	requirements = [
	('seq_read', []),
	('seq_write', []),
	('16k_read', []),
	('16k_write', []),
	('1m_stress', []),
	]

	results = {}
	for job, options in requirements:
	# Keys are labeled according to the test case name, which is
	# unique per run, so they cannot clash
	if self.VERIFY_OPTION in options:
	time.sleep(wait)
	self.__verify_only = True
	else:
	self.__verify_only = False
	results.update(self.__RunFio(job))

	# Output keys relevant to the performance, larger filesize will run
	# slower, and sda5 should be slightly slower than sda3 on a rotational
	# disk
	self.write_test_keyval({'filesize': self.__filesize,
	'filename': self.__filename,
	'device': self.__description})
	logging.info('Device Description: %s', self.__description)
	self.write_perf_keyval(results)
	if self._fail_count > 0:
	raise error.TestFail('%s failed verifications' %
	str(self._fail_count))