yardstick/benchmark/scenarios/storage/fio.py

   1 ##############################################################################
   2 # Copyright (c) 2015 Huawei Technologies Co.,Ltd.
   3 #
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 ##############################################################################
   9 from __future__ import absolute_import
  10 from __future__ import print_function
  11
  12 import logging
  13
  14 import pkg_resources
  15 from oslo_serialization import jsonutils
  16
  17 import yardstick.ssh as ssh
  18 from yardstick.benchmark.scenarios import base
  19
  20 LOG = logging.getLogger(__name__)
  21
  22
  23 class Fio(base.Scenario):
  24     """Execute fio benchmark in a host
  25
  26   Parameters
  27     filename - file name for fio workload
  28         type:    string
  29         unit:    na
  30         default: /home/ubuntu/data.raw
  31     bs - block size used for the io units
  32         type:    int
  33         unit:    bytes
  34         default: 4k
  35     iodepth - number of iobuffers to keep in flight
  36         type:    int
  37         unit:    na
  38         default: 1
  39     rw - type of io pattern [read, write, randwrite, randread, rw, randrw]
  40         type:    string
  41         unit:    na
  42         default: write
  43     ramp_time - run time before logging any performance
  44         type:    int
  45         unit:    seconds
  46         default: 20
  47
  48     Read link below for more fio args description:
  49         http://www.bluestop.org/fio/HOWTO.txt
  50     """
  51     __scenario_type__ = "Fio"
  52
  53     TARGET_SCRIPT = "fio_benchmark.bash"
  54
  55     def __init__(self, scenario_cfg, context_cfg):
  56         self.scenario_cfg = scenario_cfg
  57         self.context_cfg = context_cfg
  58         self.setup_done = False
  59
  60     def setup(self):
  61         """scenario setup"""
  62         self.target_script = pkg_resources.resource_filename(
  63             "yardstick.benchmark.scenarios.storage",
  64             Fio.TARGET_SCRIPT)
  65         host = self.context_cfg["host"]
  66
  67         self.client = ssh.SSH.from_node(host, defaults={"user": "root"})
  68         self.client.wait(timeout=600)
  69
  70         # copy script to host
  71         self.client._put_file_shell(self.target_script, '~/fio.sh')
  72
  73         self.setup_done = True
  74
  75     def run(self, result):
  76         """execute the benchmark"""
  77         default_args = "-ioengine=libaio -direct=1 -group_reporting " \
  78             "-numjobs=1 -time_based --output-format=json"
  79
  80         if not self.setup_done:
  81             self.setup()
  82
  83         options = self.scenario_cfg["options"]
  84         filename = options.get("filename", "/home/ubuntu/data.raw")
  85         bs = options.get("bs", "4k")
  86         iodepth = options.get("iodepth", "1")
  87         rw = options.get("rw", "write")
  88         ramp_time = options.get("ramp_time", 20)
  89         name = "yardstick-fio"
  90         # if run by a duration runner
  91         duration_time = self.scenario_cfg["runner"].get("duration", None) \
  92             if "runner" in self.scenario_cfg else None
  93         # if run by an arithmetic runner
  94         arithmetic_time = options.get("duration", None)
  95         if duration_time:
  96             runtime = duration_time
  97         elif arithmetic_time:
  98             runtime = arithmetic_time
  99         else:
 100             runtime = 30
 101
 102         cmd_args = "-filename=%s -bs=%s -iodepth=%s -rw=%s -ramp_time=%s " \
 103                    "-runtime=%s -name=%s %s" \
 104                    % (filename, bs, iodepth, rw, ramp_time, runtime, name,
 105                       default_args)
 106         cmd = "sudo bash fio.sh %s %s" % (filename, cmd_args)
 107         LOG.debug("Executing command: %s", cmd)
 108         # Set timeout, so that the cmd execution does not exit incorrectly
 109         # when the test run time is last long
 110         timeout = int(ramp_time) + int(runtime) + 600
 111         status, stdout, stderr = self.client.execute(cmd, timeout=timeout)
 112         if status:
 113             raise RuntimeError(stderr)
 114
 115         raw_data = jsonutils.loads(stdout)
 116
 117         # The bandwidth unit is KB/s, and latency unit is us
 118         if rw in ["read", "randread", "rw", "randrw"]:
 119             result["read_bw"] = raw_data["jobs"][0]["read"]["bw"]
 120             result["read_iops"] = raw_data["jobs"][0]["read"]["iops"]
 121             result["read_lat"] = raw_data["jobs"][0]["read"]["lat"]["mean"]
 122         if rw in ["write", "randwrite", "rw", "randrw"]:
 123             result["write_bw"] = raw_data["jobs"][0]["write"]["bw"]
 124             result["write_iops"] = raw_data["jobs"][0]["write"]["iops"]
 125             result["write_lat"] = raw_data["jobs"][0]["write"]["lat"]["mean"]
 126
 127         if "sla" in self.scenario_cfg:
 128             sla_error = ""
 129             for k, v in result.items():
 130                 if k not in self.scenario_cfg['sla']:
 131                     continue
 132
 133                 if "lat" in k:
 134                     # For lattency small value is better
 135                     max_v = float(self.scenario_cfg['sla'][k])
 136                     if v > max_v:
 137                         sla_error += "%s %f > sla:%s(%f); " % (k, v, k, max_v)
 138                 else:
 139                     # For bandwidth and iops big value is better
 140                     min_v = int(self.scenario_cfg['sla'][k])
 141                     if v < min_v:
 142                         sla_error += "%s %d < " \
 143                             "sla:%s(%d); " % (k, v, k, min_v)
 144
 145             assert sla_error == "", sla_error
 146
 147
 148 def _test():
 149     """internal test function"""
 150     key_filename = pkg_resources.resource_filename("yardstick.resources",
 151                                                    "files/yardstick_key")
 152     ctx = {
 153         "host": {
 154             "ip": "10.229.47.137",
 155             "user": "root",
 156             "key_filename": key_filename
 157         }
 158     }
 159
 160     logger = logging.getLogger("yardstick")
 161     logger.setLevel(logging.DEBUG)
 162
 163     options = {
 164         "filename": "/home/ubuntu/data.raw",
 165         "bs": "4k",
 166         "iodepth": "1",
 167         "rw": "rw",
 168         "ramp_time": 1,
 169         "duration": 10
 170     }
 171     result = {}
 172     args = {"options": options}
 173
 174     fio = Fio(args, ctx)
 175     fio.run(result)
 176     print(result)
 177
 178
 179 if __name__ == '__main__':
 180     _test()