1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
##############################################################################
# Copyright (c) 2015 Ericsson AB and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
# iperf3 scenario
# iperf3 homepage at: http://software.es.net/iperf/
from __future__ import absolute_import
from __future__ import print_function
import logging
import pkg_resources
from oslo_serialization import jsonutils
import yardstick.ssh as ssh
from yardstick.common import utils
from yardstick.benchmark.scenarios import base
LOG = logging.getLogger(__name__)
class Iperf(base.Scenario):
"""Execute iperf3 between two hosts
By default TCP is used but UDP can also be configured.
For more info see http://software.es.net/iperf
Parameters
bytes - number of bytes to transmit
only valid with a non duration runner, mutually exclusive with blockcount
type: int
unit: bytes
default: 56
udp - use UDP rather than TCP
type: bool
unit: na
default: false
nodelay - set TCP no delay, disabling Nagle's Algorithm
type: bool
unit: na
default: false
blockcount - number of blocks (packets) to transmit,
only valid with a non duration runner, mutually exclusive with bytes
type: int
unit: bytes
default: -
length - length of buffer to read or write,
(default 128 KB for TCP, 8 KB for UDP)
type: int
unit: k
default: -
window - set window size / socket buffer size
set TCP windows size. for UDP way to test, this will set to accept UDP
packet buffer size, limit the max size of acceptable data packet.
type: int
unit: k
default: -
"""
__scenario_type__ = "Iperf3"
def __init__(self, scenario_cfg, context_cfg):
self.scenario_cfg = scenario_cfg
self.context_cfg = context_cfg
self.setup_done = False
def setup(self):
host = self.context_cfg['host']
target = self.context_cfg['target']
LOG.info("user:%s, target:%s", target['user'], target['ip'])
self.target = ssh.SSH.from_node(target, defaults={"user": "ubuntu"})
self.target.wait(timeout=600)
LOG.info("user:%s, host:%s", host['user'], host['ip'])
self.host = ssh.SSH.from_node(host, defaults={"user": "ubuntu"})
self.host.wait(timeout=600)
cmd = "iperf3 -s -D"
LOG.debug("Starting iperf3 server with command: %s", cmd)
status, _, stderr = self.target.execute(cmd)
if status:
raise RuntimeError(stderr)
self.setup_done = True
def teardown(self):
LOG.debug("teardown")
self.host.close()
status, stdout, stderr = self.target.execute("pkill iperf3")
if status:
LOG.warning(stderr)
self.target.close()
def run(self, result):
"""execute the benchmark"""
if not self.setup_done:
self.setup()
# if run by a duration runner, get the duration time and setup as arg
time = self.scenario_cfg["runner"].get("duration", None) \
if "runner" in self.scenario_cfg else None
options = self.scenario_cfg['options']
cmd = "iperf3 -c %s --json" % (self.context_cfg['target']['ipaddr'])
# If there are no options specified
if not options:
options = {}
use_UDP = False
try:
protocol = options.get("protocol")
bandwidth = options.get('bandwidth')
use_UDP = protocol == 'udp'
if protocol:
cmd += " --" + protocol
if use_UDP and bandwidth:
cmd += " --bandwidth " + bandwidth
# if nodelay in the option, protocal maybe null or 'tcp'
if "nodelay" in options:
cmd += " --nodelay"
except AttributeError:
LOG.warning("Can't parser the options in your config file!!!")
# these options are mutually exclusive in iperf3
if time:
cmd += " %d" % time
elif "bytes" in options:
# number of bytes to transmit (instead of --time)
cmd += " --bytes %d" % options["bytes"]
elif "blockcount" in options:
cmd += " --blockcount %d" % options["blockcount"]
if "length" in options:
cmd += " --length %s" % options["length"]
if "window" in options:
cmd += " --window %s" % options["window"]
LOG.debug("Executing command: %s", cmd)
status, stdout, stderr = self.host.execute(cmd)
if status:
# error cause in json dict on stdout
raise RuntimeError(stdout)
# Note: convert all ints to floats in order to avoid
# schema conflicts in influxdb. We probably should add
# a format func in the future.
iperf_result = jsonutils.loads(stdout, parse_int=float)
result.update(utils.flatten_dict_key(iperf_result))
if "sla" in self.scenario_cfg:
sla_iperf = self.scenario_cfg["sla"]
if not use_UDP:
sla_bytes_per_second = int(sla_iperf["bytes_per_second"])
# convert bits per second to bytes per second
bit_per_second = \
int(iperf_result["end"]["sum_received"]["bits_per_second"])
bytes_per_second = bit_per_second / 8
assert bytes_per_second >= sla_bytes_per_second, \
"bytes_per_second %d < sla:bytes_per_second (%d); " % \
(bytes_per_second, sla_bytes_per_second)
else:
sla_jitter = float(sla_iperf["jitter"])
jitter_ms = float(iperf_result["end"]["sum"]["jitter_ms"])
assert jitter_ms <= sla_jitter, \
"jitter_ms %f > sla:jitter %f; " % \
(jitter_ms, sla_jitter)
def _test():
"""internal test function"""
key_filename = pkg_resources.resource_filename('yardstick.resources',
'files/yardstick_key')
ctx = {
'host': {
'ip': '10.229.47.137',
'user': 'root',
'key_filename': key_filename
},
'target': {
'ip': '10.229.47.137',
'user': 'root',
'key_filename': key_filename,
'ipaddr': '10.229.47.137',
}
}
logger = logging.getLogger('yardstick')
logger.setLevel(logging.DEBUG)
options = {'packetsize': 120}
args = {'options': options}
result = {}
p = Iperf(args, ctx)
p.run(result)
print(result)
if __name__ == '__main__':
_test()
|
