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         _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 116         return os.path.basename(stdout.strip())
 117
 118     def _is_irqbalance_disabled(self):
 119         """Did we disable irqbalance already in the guest?"""
 120         is_disabled = False
 121         cmd = "grep ENABLED /etc/default/irqbalance"
 122         _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 123         if "0" in stdout:
 124             is_disabled = True
 125
 126         return is_disabled
 127
 128     def _disable_irqbalance(self):
 129         cmd = "sudo sed -i -e 's/ENABLED=\"1\"/ENABLED=\"0\"/g' " \
 130               "/etc/default/irqbalance"
 131         self.server.run(cmd)
 132         self.client.run(cmd)
 133
 134         cmd = "sudo service irqbalance stop"
 135         self.server.run(cmd)
 136         self.client.run(cmd)
 137
 138         cmd = "sudo service irqbalance disable"
 139         self.server.run(cmd)
 140         self.client.run(cmd)
 141
 142     def _setup_irqmapping_ovs(self, queue_number):
 143         cmd = "grep 'virtio0-input.0' /proc/interrupts |" \
 144               "awk '{match($0,/ +[0-9]+/)} " \
 145               "{print substr($1,RSTART,RLENGTH-1)}'"
 146         _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 147
 148         cmd = "echo 1 | sudo tee /proc/irq/%s/smp_affinity" % (int(stdout))
 149         self.server.run(cmd)
 150         self.client.run(cmd)
 151
 152         cmd = "grep 'virtio0-output.0' /proc/interrupts |" \
 153               "awk '{match($0,/ +[0-9]+/)} " \
 154               "{print substr($1,RSTART,RLENGTH-1)}'"
 155         _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 156
 157         cmd = "echo 1 | sudo tee /proc/irq/%s/smp_affinity" % (int(stdout))
 158         self.server.run(cmd)
 159         self.client.run(cmd)
 160
 161         if queue_number == 1:
 162             return
 163
 164         for i in range(1, queue_number):
 165
 166             smp_affinity_mask = format(1 << i, 'x')
 167
 168             cmd = "grep 'virtio0-input.%s' /proc/interrupts |" \
 169                   "awk '{match($0,/ +[0-9]+/)} " \
 170                   "{print substr($1,RSTART,RLENGTH-1)}'" % (i)
 171             _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 172
 173             cmd = "echo %s | sudo tee /proc/irq/%s/smp_affinity" \
 174                 % (smp_affinity_mask, int(stdout))
 175             self.server.run(cmd)
 176             self.client.run(cmd)
 177
 178             cmd = "grep 'virtio0-output.%s' /proc/interrupts |" \
 179                   "awk '{match($0,/ +[0-9]+/)} " \
 180                   "{print substr($1,RSTART,RLENGTH-1)}'" % (i)
 181             _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 182
 183             cmd = "echo %s | sudo tee /proc/irq/%s/smp_affinity" \
 184                 % (smp_affinity_mask, int(stdout))
 185             self.server.run(cmd)
 186             self.client.run(cmd)
 187
 188     def _setup_irqmapping_sriov(self, queue_number):
 189         cmd = "grep '%s-TxRx-0' /proc/interrupts |" \
 190               "awk '{match($0,/ +[0-9]+/)} " \
 191               "{print substr($1,RSTART,RLENGTH-1)}'" % self.vnic_name
 192         _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 193
 194         cmd = "echo 1 | sudo tee /proc/irq/%s/smp_affinity" % (int(stdout))
 195         self.server.run(cmd)
 196         self.client.run(cmd)
 197
 198         if queue_number == 1:
 199             return
 200
 201         for i in range(1, queue_number):
 202             smp_affinity_mask = format(1 << i, 'x')
 203
 204             cmd = "grep '%s-TxRx-%s' /proc/interrupts |" \
 205                   "awk '{match($0,/ +[0-9]+/)} " \
 206                   "{print substr($1,RSTART,RLENGTH-1)}'" % (self.vnic_name, i)
 207             _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 208
 209             cmd = "echo %s | sudo tee /proc/irq/%s/smp_affinity" \
 210                 % (smp_affinity_mask, int(stdout))
 211             self.server.run(cmd)
 212             self.client.run(cmd)
 213
 214     def _get_sriov_queue_number(self):
 215         """Get queue number from server as both VMs are the same"""
 216         cmd = "grep %s-TxRx- /proc/interrupts | wc -l" % self.vnic_name
 217         LOG.debug("Executing command: %s", cmd)
 218         _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 219         return int(stdout)
 220
 221     def _get_available_queue_number(self):
 222         """Get queue number from client as both VMs are the same"""
 223         cmd = "sudo ethtool -l %s | grep Combined | head -1 |" \
 224               "awk '{printf $2}'" % self.vnic_name
 225         LOG.debug("Executing command: %s", cmd)
 226         _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 227         return int(stdout)
 228
 229     def _get_usable_queue_number(self):
 230         """Get queue number from client as both VMs are the same"""
 231         cmd = "sudo ethtool -l %s | grep Combined | tail -1 |" \
 232               "awk '{printf $2}'" % self.vnic_name
 233         LOG.debug("Executing command: %s", cmd)
 234         _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 235         return int(stdout)
 236
 237     def _enable_ovs_multiqueue(self):
 238         available_queue_number = self._get_available_queue_number()
 239         usable_queue_number = self._get_usable_queue_number()
 240         if available_queue_number > 1 and \
 241            available_queue_number != usable_queue_number:
 242             cmd = "sudo ethtool -L %s combined %s" % \
 243                 (self.vnic_name, available_queue_number)
 244             LOG.debug("Executing command: %s", cmd)
 245             self.server.run(cmd)
 246             self.client.run(cmd)
 247         return available_queue_number
 248
 249     def _iptables_setup(self):
 250         """Setup iptables on server to monitor for received packets"""
 251         cmd = "sudo iptables -F; " \
 252               "sudo iptables -A INPUT -p udp --dport 1000:%s -j DROP" \
 253               % (1000 + self.number_of_ports)
 254         LOG.debug("Executing command: %s", cmd)
 255         self.server.run(cmd, timeout=SSH_TIMEOUT)
 256
 257     def _iptables_get_result(self):
 258         """Get packet statistics from server"""
 259         cmd = "sudo iptables -L INPUT -vnx |" \
 260               "awk '/dpts:1000:%s/ {{printf \"%%s\", $1}}'" \
 261               % (1000 + self.number_of_ports)
 262         LOG.debug("Executing command: %s", cmd)
 263         _, stdout, _ = self.server.execute(cmd, raise_on_error=True)
 264         return int(stdout)
 265
 266     def run(self, result):
 267         """execute the benchmark"""
 268
 269         if not self.setup_done:
 270             self.setup()
 271
 272         ipaddr = self.context_cfg["target"].get("ipaddr", '127.0.0.1')
 273
 274         options = self.scenario_cfg['options']
 275         packetsize = options.get("packetsize", 60)
 276         self.number_of_ports = options.get("number_of_ports", 10)
 277         self.vnic_name = options.get("vnic_name", "eth0")
 278         ovs_dpdk = options.get("ovs_dpdk", False)
 279         pps = options.get("pps", 1000000)
 280         multiqueue = options.get("multiqueue", False)
 281
 282         if multiqueue and not self.multiqueue_setup_done:
 283             self.multiqueue_setup()
 284
 285         # if run by a duration runner
 286         duration_time = self.scenario_cfg["runner"].get("duration", None) \
 287             if "runner" in self.scenario_cfg else None
 288         # if run by an arithmetic runner
 289         arithmetic_time = options.get("duration", None)
 290
 291         if duration_time:
 292             duration = duration_time
 293         elif arithmetic_time:
 294             duration = arithmetic_time
 295         else:
 296             duration = 20
 297
 298         self._iptables_setup()
 299
 300         queue_number = self.queue_number
 301
 302         # For native OVS, half of vCPUs are used by vhost kernel threads
 303         # hence set the queue_number to half number of vCPUs
 304         # e.g. set queue_number to 2 if there are 4 vCPUs
 305         if self.vnic_type == "ovs" and not ovs_dpdk and self.queue_number > 1:
 306             queue_number = self.queue_number / 2
 307
 308         cmd = "sudo bash pktgen.sh %s %s %s %s %s %s" \
 309             % (ipaddr, self.number_of_ports, packetsize,
 310                duration, queue_number, pps)
 311
 312         LOG.debug("Executing command: %s", cmd)
 313         _, stdout, _ = self.client.execute(cmd, raise_on_error=True,
 314                                            timeout=SSH_TIMEOUT)
 315
 316         result.update(jsonutils.loads(stdout))
 317
 318         received = result['packets_received'] = self._iptables_get_result()
 319         sent = result['packets_sent']
 320         result['packetsize'] = packetsize
 321         # compatible with python3 /
 322         ppm = math.ceil(1000000.0 * (sent - received) / sent)
 323
 324         result['ppm'] = ppm
 325
 326         if "sla" in self.scenario_cfg:
 327             LOG.debug("Lost packets %d - Lost ppm %d", (sent - received), ppm)
 328             sla_max_ppm = int(self.scenario_cfg["sla"]["max_ppm"])
 329             self.verify_SLA(ppm <= sla_max_ppm,
 330                             "ppm %d > sla_max_ppm %d; " % (ppm, sla_max_ppm))
 331
 332
 333 def _test():  # pragma: no cover
 334     """internal test function"""
 335     key_filename = pkg_resources.resource_filename('yardstick.resources',
 336                                                    'files/yardstick_key')
 337     ctx = {
 338         'host': {
 339             'ip': '10.229.47.137',
 340             'user': 'root',
 341             'key_filename': key_filename
 342         },
 343         'target': {
 344             'ip': '10.229.47.137',
 345             'user': 'root',
 346             'key_filename': key_filename,
 347             'ipaddr': '10.229.47.137',
 348         }
 349     }
 350
 351     logger = logging.getLogger('yardstick')
 352     logger.setLevel(logging.DEBUG)
 353
 354     options = {'packetsize': 120}
 355     args = {'options': options}
 356     result = {}
 357
 358     p = Pktgen(args, ctx)
 359     p.run(result)
 360     print(result)
 361
 362 if __name__ == '__main__':
 363     _test()