yardstick/benchmark/scenarios/networking/pktgen.py

   1 ##############################################################################
   2 # Copyright (c) 2015 Ericsson AB and others.
   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 os
  13 import logging
  14 import math
  15
  16 import pkg_resources
  17 from oslo_serialization import jsonutils
  18
  19 import yardstick.ssh as ssh
  20 from yardstick.benchmark.scenarios import base
  21
  22 LOG = logging.getLogger(__name__)
  23
  24 SSH_TIMEOUT = 60
  25 VNIC_TYPE_LIST = ["ovs", "sriov"]
  26 SRIOV_DRIVER_LIST = ["ixgbevf", "i40evf"]
  27
  28
  29 class Pktgen(base.Scenario):
  30     """Execute pktgen between two hosts
  31
  32   Parameters
  33     packetsize - packet size in bytes without the CRC
  34         type:    int
  35         unit:    bytes
  36         default: 60
  37     number_of_ports - number of UDP ports to test
  38         type:    int
  39         unit:    na
  40         default: 10
  41     duration - duration of the test
  42         type:    int
  43         unit:    seconds
  44         default: 20
  45     """
  46     __scenario_type__ = "Pktgen"
  47
  48     TARGET_SCRIPT = 'pktgen_benchmark.bash'
  49
  50     def __init__(self, scenario_cfg, context_cfg):
  51         self.scenario_cfg = scenario_cfg
  52         self.context_cfg = context_cfg
  53         self.vnic_name = "eth0"
  54         self.vnic_type = "ovs"
  55         self.queue_number = 1
  56         self.setup_done = False
  57         self.multiqueue_setup_done = False
  58
  59     def setup(self):
  60         """scenario setup"""
  61         self.target_script = pkg_resources.resource_filename(
  62             'yardstick.benchmark.scenarios.networking',
  63             Pktgen.TARGET_SCRIPT)
  64         host = self.context_cfg['host']
  65         target = self.context_cfg['target']
  66
  67         LOG.info("user:%s, target:%s", target['user'], target['ip'])
  68         self.server = ssh.SSH.from_node(target, defaults={"user": "ubuntu"})
  69         self.server.wait(timeout=600)
  70
  71         LOG.info("user:%s, host:%s", host['user'], host['ip'])
  72         self.client = ssh.SSH.from_node(host, defaults={"user": "ubuntu"})
  73         self.client.wait(timeout=600)
  74
  75         # copy script to host
  76         self.client._put_file_shell(self.target_script, '~/pktgen.sh')
  77
  78         self.setup_done = True
  79
  80     def multiqueue_setup(self):
  81         # one time setup stuff
  82         cmd = "sudo sysctl -w net.core.netdev_budget=3000"
  83         self.server.send_command(cmd)
  84         self.client.send_command(cmd)
  85
  86         cmd = "sudo sysctl -w net.core.netdev_max_backlog=100000"
  87         self.server.send_command(cmd)
  88         self.client.send_command(cmd)
  89
  90         """multiqueue setup"""
  91         if not self._is_irqbalance_disabled():
  92             self._disable_irqbalance()
  93
  94         vnic_driver_name = self._get_vnic_driver_name()
  95         if vnic_driver_name in SRIOV_DRIVER_LIST:
  96             self.vnic_type = "sriov"
  97
  98             # one time setup stuff
  99             cmd = "sudo ethtool -G %s rx 4096 tx 4096" % self.vnic_name
 100             self.server.send_command(cmd)
 101             self.client.send_command(cmd)
 102
 103             self.queue_number = self._get_sriov_queue_number()
 104             self._setup_irqmapping_sriov(self.queue_number)
 105         else:
 106             self.vnic_type = "ovs"
 107             self.queue_number = self._enable_ovs_multiqueue()
 108             self._setup_irqmapping_ovs(self.queue_number)
 109
 110         self.multiqueue_setup_done = True
 111
 112     def _get_vnic_driver_name(self):
 113         cmd = "readlink /sys/class/net/%s/device/driver" % self.vnic_name
 114         LOG.debug("Executing command: %s", cmd)
 115         status, stdout, stderr = self.server.execute(cmd)
 116         if status:
 117             raise RuntimeError(stderr)
 118         return os.path.basename(stdout.strip())
 119
 120     def _is_irqbalance_disabled(self):
 121         """Did we disable irqbalance already in the guest?"""
 122         is_disabled = False
 123         cmd = "grep ENABLED /etc/default/irqbalance"
 124         status, stdout, stderr = self.server.execute(cmd)
 125         if status:
 126             raise RuntimeError(stderr)
 127         if "0" in stdout:
 128             is_disabled = True
 129
 130         return is_disabled
 131
 132     def _disable_irqbalance(self):
 133         cmd = "sudo sed -i -e 's/ENABLED=\"1\"/ENABLED=\"0\"/g' " \
 134               "/etc/default/irqbalance"
 135         status, stdout, stderr = self.server.execute(cmd)
 136         status, stdout, stderr = self.client.execute(cmd)
 137         if status:
 138             raise RuntimeError(stderr)
 139
 140         cmd = "sudo service irqbalance stop"
 141         status, stdout, stderr = self.server.execute(cmd)
 142         status, stdout, stderr = self.client.execute(cmd)
 143         if status:
 144             raise RuntimeError(stderr)
 145
 146         cmd = "sudo service irqbalance disable"
 147         status, stdout, stderr = self.server.execute(cmd)
 148         status, stdout, stderr = self.client.execute(cmd)
 149         if status:
 150             raise RuntimeError(stderr)
 151
 152     def _setup_irqmapping_ovs(self, queue_number):
 153         cmd = "grep 'virtio0-input.0' /proc/interrupts |" \
 154               "awk '{match($0,/ +[0-9]+/)} " \
 155               "{print substr($1,RSTART,RLENGTH-1)}'"
 156         status, stdout, stderr = self.server.execute(cmd)
 157         if status:
 158             raise RuntimeError(stderr)
 159
 160         cmd = "echo 1 | sudo tee /proc/irq/%s/smp_affinity" % (int(stdout))
 161         status, stdout, stderr = self.server.execute(cmd)
 162         status, stdout, stderr = self.client.execute(cmd)
 163         if status:
 164             raise RuntimeError(stderr)
 165
 166         cmd = "grep 'virtio0-output.0' /proc/interrupts |" \
 167               "awk '{match($0,/ +[0-9]+/)} " \
 168               "{print substr($1,RSTART,RLENGTH-1)}'"
 169         status, stdout, stderr = self.server.execute(cmd)
 170         if status:
 171             raise RuntimeError(stderr)
 172
 173         cmd = "echo 1 | sudo tee /proc/irq/%s/smp_affinity" % (int(stdout))
 174         status, stdout, stderr = self.server.execute(cmd)
 175         status, stdout, stderr = self.client.execute(cmd)
 176         if status:
 177             raise RuntimeError(stderr)
 178
 179         if queue_number == 1:
 180             return
 181
 182         for i in range(1, queue_number):
 183             cmd = "grep 'virtio0-input.%s' /proc/interrupts |" \
 184                   "awk '{match($0,/ +[0-9]+/)} " \
 185                   "{print substr($1,RSTART,RLENGTH-1)}'" % (i)
 186             status, stdout, stderr = self.server.execute(cmd)
 187             if status:
 188                 raise RuntimeError(stderr)
 189
 190             cmd = "echo %s | sudo tee /proc/irq/%s/smp_affinity" \
 191                 % (1 << i, int(stdout))
 192             status, stdout, stderr = self.server.execute(cmd)
 193             status, stdout, stderr = self.client.execute(cmd)
 194             if status:
 195                 raise RuntimeError(stderr)
 196
 197             cmd = "grep 'virtio0-output.%s' /proc/interrupts |" \
 198                   "awk '{match($0,/ +[0-9]+/)} " \
 199                   "{print substr($1,RSTART,RLENGTH-1)}'" % (i)
 200             status, stdout, stderr = self.server.execute(cmd)
 201             if status:
 202                 raise RuntimeError(stderr)
 203
 204             cmd = "echo %s | sudo tee /proc/irq/%s/smp_affinity" \
 205                 % (1 << i, int(stdout))
 206             status, stdout, stderr = self.server.execute(cmd)
 207             status, stdout, stderr = self.client.execute(cmd)
 208             if status:
 209                 raise RuntimeError(stderr)
 210
 211     def _setup_irqmapping_sriov(self, queue_number):
 212         cmd = "grep '%s-TxRx-0' /proc/interrupts |" \
 213               "awk '{match($0,/ +[0-9]+/)} " \
 214               "{print substr($1,RSTART,RLENGTH-1)}'" % self.vnic_name
 215         status, stdout, stderr = self.server.execute(cmd)
 216         if status:
 217             raise RuntimeError(stderr)
 218
 219         cmd = "echo 1 | sudo tee /proc/irq/%s/smp_affinity" % (int(stdout))
 220         status, stdout, stderr = self.server.execute(cmd)
 221         status, stdout, stderr = self.client.execute(cmd)
 222         if status:
 223             raise RuntimeError(stderr)
 224
 225         if queue_number == 1:
 226             return
 227
 228         for i in range(1, queue_number):
 229             cmd = "grep '%s-TxRx-%s' /proc/interrupts |" \
 230                   "awk '{match($0,/ +[0-9]+/)} " \
 231                   "{print substr($1,RSTART,RLENGTH-1)}'" % (self.vnic_name, i)
 232             status, stdout, stderr = self.server.execute(cmd)
 233             if status:
 234                 raise RuntimeError(stderr)
 235
 236             cmd = "echo %s | sudo tee /proc/irq/%s/smp_affinity" \
 237                 % (1 << i, int(stdout))
 238             status, stdout, stderr = self.server.execute(cmd)
 239             status, stdout, stderr = self.client.execute(cmd)
 240             if status:
 241                 raise RuntimeError(stderr)
 242
 243     def _get_sriov_queue_number(self):
 244         """Get queue number from server as both VMs are the same"""
 245         cmd = "grep %s-TxRx- /proc/interrupts | wc -l" % self.vnic_name
 246         LOG.debug("Executing command: %s", cmd)
 247         status, stdout, stderr = self.server.execute(cmd)
 248         if status:
 249             raise RuntimeError(stderr)
 250         return int(stdout)
 251
 252     def _get_available_queue_number(self):
 253         """Get queue number from client as both VMs are the same"""
 254         cmd = "sudo ethtool -l %s | grep Combined | head -1 |" \
 255               "awk '{printf $2}'" % self.vnic_name
 256         LOG.debug("Executing command: %s", cmd)
 257         status, stdout, stderr = self.server.execute(cmd)
 258         if status:
 259             raise RuntimeError(stderr)
 260         return int(stdout)
 261
 262     def _get_usable_queue_number(self):
 263         """Get queue number from client as both VMs are the same"""
 264         cmd = "sudo ethtool -l %s | grep Combined | tail -1 |" \
 265               "awk '{printf $2}'" % self.vnic_name
 266         LOG.debug("Executing command: %s", cmd)
 267         status, stdout, stderr = self.server.execute(cmd)
 268         if status:
 269             raise RuntimeError(stderr)
 270         return int(stdout)
 271
 272     def _enable_ovs_multiqueue(self):
 273         available_queue_number = self._get_available_queue_number()
 274         usable_queue_number = self._get_usable_queue_number()
 275         if available_queue_number > 1 and \
 276            available_queue_number != usable_queue_number:
 277             cmd = "sudo ethtool -L %s combined %s" % \
 278                 (self.vnic_name, available_queue_number)
 279             LOG.debug("Executing command: %s", cmd)
 280             status, stdout, stderr = self.server.execute(cmd)
 281             status, stdout, stderr = self.client.execute(cmd)
 282             if status:
 283                 raise RuntimeError(stderr)
 284         return available_queue_number
 285
 286     def _iptables_setup(self):
 287         """Setup iptables on server to monitor for received packets"""
 288         cmd = "sudo iptables -F; " \
 289               "sudo iptables -A INPUT -p udp --dport 1000:%s -j DROP" \
 290               % (1000 + self.number_of_ports)
 291         LOG.debug("Executing command: %s", cmd)
 292         status, _, stderr = self.server.execute(cmd, timeout=SSH_TIMEOUT)
 293         if status:
 294             raise RuntimeError(stderr)
 295
 296     def _iptables_get_result(self):
 297         """Get packet statistics from server"""
 298         cmd = "sudo iptables -L INPUT -vnx |" \
 299               "awk '/dpts:1000:%s/ {{printf \"%%s\", $1}}'" \
 300               % (1000 + self.number_of_ports)
 301         LOG.debug("Executing command: %s", cmd)
 302         status, stdout, stderr = self.server.execute(cmd)
 303         if status:
 304             raise RuntimeError(stderr)
 305         return int(stdout)
 306
 307     def run(self, result):
 308         """execute the benchmark"""
 309
 310         if not self.setup_done:
 311             self.setup()
 312
 313         ipaddr = self.context_cfg["target"].get("ipaddr", '127.0.0.1')
 314
 315         options = self.scenario_cfg['options']
 316         packetsize = options.get("packetsize", 60)
 317         self.number_of_ports = options.get("number_of_ports", 10)
 318         self.vnic_name = options.get("vnic_name", "eth0")
 319         ovs_dpdk = options.get("ovs_dpdk", False)
 320         pps = options.get("pps", 1000000)
 321         multiqueue = options.get("multiqueue", False)
 322
 323         if multiqueue and not self.multiqueue_setup_done:
 324             self.multiqueue_setup()
 325
 326         # if run by a duration runner
 327         duration_time = self.scenario_cfg["runner"].get("duration", None) \
 328             if "runner" in self.scenario_cfg else None
 329         # if run by an arithmetic runner
 330         arithmetic_time = options.get("duration", None)
 331
 332         if duration_time:
 333             duration = duration_time
 334         elif arithmetic_time:
 335             duration = arithmetic_time
 336         else:
 337             duration = 20
 338
 339         self._iptables_setup()
 340
 341         queue_number = self.queue_number
 342
 343         # For native OVS, half of vCPUs are used by vhost kernel threads
 344         # hence set the queue_number to half number of vCPUs
 345         # e.g. set queue_number to 2 if there are 4 vCPUs
 346         if self.vnic_type == "ovs" and not ovs_dpdk and self.queue_number > 1:
 347             queue_number = self.queue_number / 2
 348
 349         cmd = "sudo bash pktgen.sh %s %s %s %s %s %s" \
 350             % (ipaddr, self.number_of_ports, packetsize,
 351                duration, queue_number, pps)
 352
 353         LOG.debug("Executing command: %s", cmd)
 354         status, stdout, stderr = self.client.execute(cmd, timeout=SSH_TIMEOUT)
 355
 356         if status:
 357             raise RuntimeError(stderr)
 358
 359         result.update(jsonutils.loads(stdout))
 360
 361         received = result['packets_received'] = self._iptables_get_result()
 362         sent = result['packets_sent']
 363         result['packetsize'] = packetsize
 364         # compatible with python3 /
 365         ppm = math.ceil(1000000.0 * (sent - received) / sent)
 366
 367         result['ppm'] = ppm
 368
 369         if "sla" in self.scenario_cfg:
 370             LOG.debug("Lost packets %d - Lost ppm %d", (sent - received), ppm)
 371             sla_max_ppm = int(self.scenario_cfg["sla"]["max_ppm"])
 372             assert ppm <= sla_max_ppm, "ppm %d > sla_max_ppm %d; " \
 373                 % (ppm, sla_max_ppm)
 374
 375
 376 def _test():  # pragma: no cover
 377     """internal test function"""
 378     key_filename = pkg_resources.resource_filename('yardstick.resources',
 379                                                    'files/yardstick_key')
 380     ctx = {
 381         'host': {
 382             'ip': '10.229.47.137',
 383             'user': 'root',
 384             'key_filename': key_filename
 385         },
 386         'target': {
 387             'ip': '10.229.47.137',
 388             'user': 'root',
 389             'key_filename': key_filename,
 390             'ipaddr': '10.229.47.137',
 391         }
 392     }
 393
 394     logger = logging.getLogger('yardstick')
 395     logger.setLevel(logging.DEBUG)
 396
 397     options = {'packetsize': 120}
 398     args = {'options': options}
 399     result = {}
 400
 401     p = Pktgen(args, ctx)
 402     p.run(result)
 403     print(result)
 404
 405 if __name__ == '__main__':
 406     _test()