1 ##############################################################################
2 # Copyright (c) 2015 Huawei Technologies Co.,Ltd.
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
15 from oslo_serialization import jsonutils
17 import yardstick.ssh as ssh
18 from yardstick.benchmark.scenarios import base
20 LOG = logging.getLogger(__name__)
23 class Fio(base.Scenario):
24 """Execute fio benchmark in a host
27 filename - file name for fio workload
30 default: /home/ubuntu/data.raw
31 job_file - fio job configuration file
35 job_file_config - content of job configuration file
39 directory - mount directoey for test volume
43 bs - block size used for the io units
47 iodepth - number of iobuffers to keep in flight
51 rw - type of io pattern [read, write, randwrite, randread, rw, randrw]
55 rwmixwrite - percentage of a mixed workload that should be writes
59 ramp_time - run time before logging any performance
63 direct - whether use non-buffered I/O or not
67 size - total size of I/O for this job.
71 numjobs - number of clones (processes/threads performing the same workload) of this job
76 Read link below for more fio args description:
77 http://www.bluestop.org/fio/HOWTO.txt
79 __scenario_type__ = "Fio"
81 TARGET_SCRIPT = "fio_benchmark.bash"
83 def __init__(self, scenario_cfg, context_cfg):
84 self.scenario_cfg = scenario_cfg
85 self.context_cfg = context_cfg
86 self.options = self.scenario_cfg["options"]
87 self.setup_done = False
91 host = self.context_cfg["host"]
93 self.client = ssh.SSH.from_node(host, defaults={"user": "root"})
94 self.client.wait(timeout=600)
96 self.job_file = self.options.get("job_file", None)
97 config_lines = self.options.get("job_file_config", None)
100 self.job_file_script = pkg_resources.resource_filename(
101 "yardstick.resources", 'files/' + self.job_file)
103 # copy job file to host
104 self.client._put_file_shell(self.job_file_script, '~/job_file.ini')
106 LOG.debug("Job file configuration received, Fio job file will be created.")
107 self.job_file = 'tmp_job_file.ini'
108 self.job_file_script = pkg_resources.resource_filename(
109 "yardstick.resources", 'files/' + self.job_file)
110 with open(self.job_file_script, 'w') as f:
111 f.write('\n'.join(str(line) for line in config_lines))
113 # copy job file to host
114 self.client._put_file_shell(self.job_file_script, '~/job_file.ini')
116 LOG.debug("No job file configuration received, Fio will use parameters.")
117 self.target_script = pkg_resources.resource_filename(
118 "yardstick.benchmark.scenarios.storage", Fio.TARGET_SCRIPT)
120 # copy script to host
121 self.client._put_file_shell(self.target_script, '~/fio.sh')
123 mount_dir = self.options.get("directory", None)
126 LOG.debug("Formating volume...")
127 self.client.execute("sudo mkfs.ext4 /dev/vdb")
128 cmd = "sudo mkdir %s" % mount_dir
129 self.client.execute(cmd)
130 LOG.debug("Mounting volume at: %s", mount_dir)
131 cmd = "sudo mount /dev/vdb %s" % mount_dir
132 self.client.execute(cmd)
134 self.setup_done = True
136 def run(self, result):
137 """execute the benchmark"""
138 default_args = "-ioengine=libaio -group_reporting -time_based -time_based " \
139 "--output-format=json"
142 if not self.setup_done:
146 cmd = "sudo fio job_file.ini --output-format=json"
148 filename = self.options.get("filename", "/home/ubuntu/data.raw")
149 bs = self.options.get("bs", "4k")
150 iodepth = self.options.get("iodepth", "1")
151 rw = self.options.get("rw", "write")
152 ramp_time = self.options.get("ramp_time", 20)
153 size = self.options.get("size", "1g")
154 direct = self.options.get("direct", "1")
155 numjobs = self.options.get("numjobs", "1")
156 rwmixwrite = self.options.get("rwmixwrite", 50)
157 name = "yardstick-fio"
158 # if run by a duration runner
159 duration_time = self.scenario_cfg["runner"].get("duration", None) \
160 if "runner" in self.scenario_cfg else None
161 # if run by an arithmetic runner
162 arithmetic_time = self.options.get("duration", None)
164 runtime = duration_time
165 elif arithmetic_time:
166 runtime = arithmetic_time
169 # Set timeout, so that the cmd execution does not exit incorrectly
170 # when the test run time is last long
171 timeout = int(ramp_time) + int(runtime) + 600
173 cmd_args = "-filename=%s -direct=%s -bs=%s -iodepth=%s -rw=%s -rwmixwrite=%s " \
174 "-size=%s -ramp_time=%s -numjobs=%s -runtime=%s -name=%s %s" \
175 % (filename, direct, bs, iodepth, rw, rwmixwrite, size, ramp_time, numjobs,
176 runtime, name, default_args)
177 cmd = "sudo bash fio.sh %s %s" % (filename, cmd_args)
179 LOG.debug("Executing command: %s", cmd)
180 status, stdout, stderr = self.client.execute(cmd, timeout=timeout)
182 raise RuntimeError(stderr)
184 raw_data = jsonutils.loads(stdout)
187 result["read_bw"] = raw_data["jobs"][0]["read"]["bw"]
188 result["read_iops"] = raw_data["jobs"][0]["read"]["iops"]
189 result["read_lat"] = raw_data["jobs"][0]["read"]["lat"]["mean"]
190 result["write_bw"] = raw_data["jobs"][0]["write"]["bw"]
191 result["write_iops"] = raw_data["jobs"][0]["write"]["iops"]
192 result["write_lat"] = raw_data["jobs"][0]["write"]["lat"]["mean"]
194 # The bandwidth unit is KB/s, and latency unit is us
195 if rw in ["read", "randread", "rw", "randrw"]:
196 result["read_bw"] = raw_data["jobs"][0]["read"]["bw"]
197 result["read_iops"] = raw_data["jobs"][0]["read"]["iops"]
198 result["read_lat"] = raw_data["jobs"][0]["read"]["lat"]["mean"]
199 if rw in ["write", "randwrite", "rw", "randrw"]:
200 result["write_bw"] = raw_data["jobs"][0]["write"]["bw"]
201 result["write_iops"] = raw_data["jobs"][0]["write"]["iops"]
202 result["write_lat"] = raw_data["jobs"][0]["write"]["lat"]["mean"]
204 if "sla" in self.scenario_cfg:
206 for k, v in result.items():
207 if k not in self.scenario_cfg['sla']:
211 # For lattency small value is better
212 max_v = float(self.scenario_cfg['sla'][k])
214 sla_error += "%s %f > sla:%s(%f); " % (k, v, k, max_v)
216 # For bandwidth and iops big value is better
217 min_v = int(self.scenario_cfg['sla'][k])
219 sla_error += "%s %d < " \
220 "sla:%s(%d); " % (k, v, k, min_v)
222 assert sla_error == "", sla_error
226 """internal test function"""
227 key_filename = pkg_resources.resource_filename("yardstick.resources",
228 "files/yardstick_key")
231 "ip": "10.229.47.137",
233 "key_filename": key_filename
237 logger = logging.getLogger("yardstick")
238 logger.setLevel(logging.DEBUG)
241 "filename": "/home/ubuntu/data.raw",
249 args = {"options": options}
256 if __name__ == '__main__':