resources/libraries/python/QemuManager.py

   1 # Copyright (c) 2020 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """QEMU Manager library."""
  15
  16 from collections import OrderedDict
  17
  18 from resources.libraries.python.Constants import Constants
  19 from resources.libraries.python.CpuUtils import CpuUtils
  20 from resources.libraries.python.QemuUtils import QemuUtils
  21 from resources.libraries.python.topology import NodeType, Topology
  22
  23 __all__ = [u"QemuManager"]
  24
  25
  26 class QemuManager:
  27     """QEMU lifecycle management class"""
  28
  29     # Use one instance of class per tests.
  30     ROBOT_LIBRARY_SCOPE = u"TEST CASE"
  31
  32     def __init__(self, nodes):
  33         """Init QemuManager object."""
  34         self.machines = None
  35         self.machines_affinity = None
  36         self.nodes = nodes
  37
  38     def initialize(self):
  39         """Initialize QemuManager object."""
  40         self.machines = OrderedDict()
  41         self.machines_affinity = OrderedDict()
  42
  43     def construct_vms_on_node(self, **kwargs):
  44         """Construct 1..Mx1..N VMs(s) on node with specified name.
  45
  46         :param kwargs: Named parameters.
  47         :type kwargs: dict
  48         """
  49         node = kwargs[u"node"]
  50         nf_chains = int(kwargs[u"nf_chains"])
  51         nf_nodes = int(kwargs[u"nf_nodes"])
  52         queues = kwargs[u"rxq_count_int"] if kwargs[u"auto_scale"] else 1
  53         vs_dtc = kwargs[u"vs_dtc"]
  54         nf_dtc = kwargs[u"vs_dtc"] if kwargs[u"auto_scale"] \
  55             else kwargs[u"nf_dtc"]
  56         nf_dtcr = kwargs[u"nf_dtcr"] \
  57             if isinstance(kwargs[u"nf_dtcr"], int) else 2
  58
  59         for nf_chain in range(1, nf_chains + 1):
  60             for nf_node in range(1, nf_nodes + 1):
  61                 qemu_id = (nf_chain - 1) * nf_nodes + nf_node
  62                 name = f"{node}_{qemu_id}"
  63                 idx1 = (nf_chain - 1) * nf_nodes * 2 + nf_node * 2 - 1
  64
  65                 vif1_mac = Topology.get_interface_mac(
  66                     self.nodes[node], f"vhost{idx1}"
  67                 ) if kwargs[u"vnf"] == u"testpmd_mac" \
  68                     else kwargs[u"tg_pf1_mac"] if nf_node == 1 \
  69                     else f"52:54:00:00:{(qemu_id - 1):02x}:02"
  70                 idx2 = (nf_chain - 1) * nf_nodes * 2 + nf_node * 2
  71                 vif2_mac = Topology.get_interface_mac(
  72                     self.nodes[node], f"vhost{idx2}"
  73                 ) if kwargs[u"vnf"] == u"testpmd_mac" \
  74                     else kwargs[u"tg_pf2_mac"] if nf_node == nf_nodes \
  75                     else f"52:54:00:00:{(qemu_id + 1):02x}:01"
  76
  77                 self.machines_affinity[name] = CpuUtils.get_affinity_nf(
  78                     nodes=self.nodes, node=node, nf_chains=nf_chains,
  79                     nf_nodes=nf_nodes, nf_chain=nf_chain, nf_node=nf_node,
  80                     vs_dtc=vs_dtc, nf_dtc=nf_dtc, nf_dtcr=nf_dtcr
  81                 )
  82
  83                 try:
  84                     getattr(self, f'_c_{kwargs["vnf"]}')(
  85                         qemu_id=qemu_id, name=name, queues=queues, **kwargs
  86                     )
  87                 except AttributeError:
  88                     self._c_default(
  89                         qemu_id=qemu_id, name=name, queues=queues,
  90                         vif1_mac=vif1_mac, vif2_mac=vif2_mac, **kwargs
  91                     )
  92
  93     def construct_vms_on_all_nodes(self, **kwargs):
  94         """Construct 1..Mx1..N VMs(s) with specified name on all nodes.
  95
  96         :param kwargs: Named parameters.
  97         :type kwargs: dict
  98         """
  99         self.initialize()
 100         for node in self.nodes:
 101             if self.nodes[node][u"type"] == NodeType.DUT:
 102                 self.construct_vms_on_node(node=node, **kwargs)
 103
 104     def start_all_vms(self, pinning=False):
 105         """Start all added VMs in manager.
 106
 107         :param pinning: If True, then do also QEMU process pinning.
 108         :type pinning: bool
 109         """
 110         for machine, machine_affinity in \
 111                 zip(self.machines.values(), self.machines_affinity.values()):
 112             index = list(self.machines.values()).index(machine)
 113             name = list(self.machines.keys())[index]
 114             self.nodes[name] = machine.qemu_start()
 115             if pinning:
 116                 machine.qemu_set_affinity(*machine_affinity)
 117
 118     def kill_all_vms(self, force=False):
 119         """Kill all added VMs in manager.
 120
 121         :param force: Force kill all Qemu instances by pkill qemu if True.
 122         :type force: bool
 123         """
 124         for node in list(self.nodes.values()):
 125             if node["type"] == NodeType.VM:
 126                 try:
 127                     self.nodes.popitem(node)
 128                 except TypeError:
 129                     pass
 130         for machine in self.machines.values():
 131             if force:
 132                 machine.qemu_kill_all()
 133             else:
 134                 machine.qemu_kill()
 135
 136     def _c_default(self, **kwargs):
 137         """Instantiate one VM with default configuration.
 138
 139         :param kwargs: Named parameters.
 140         :type kwargs: dict
 141         """
 142         qemu_id = kwargs[u"qemu_id"]
 143         name = kwargs[u"name"]
 144
 145         self.machines[name] = QemuUtils(
 146             node=self.nodes[kwargs[u"node"]],
 147             qemu_id=qemu_id,
 148             smp=len(self.machines_affinity[name]),
 149             mem=4096,
 150             vnf=kwargs[u"vnf"],
 151             img=Constants.QEMU_VM_KERNEL
 152         )
 153         self.machines[name].add_default_params()
 154         self.machines[name].add_kernelvm_params()
 155         self.machines[name].configure_kernelvm_vnf(
 156             mac1=f"52:54:00:00:{qemu_id:02x}:01",
 157             mac2=f"52:54:00:00:{qemu_id:02x}:02",
 158             vif1_mac=kwargs[u"vif1_mac"],
 159             vif2_mac=kwargs[u"vif2_mac"],
 160             queues=kwargs[u"queues"],
 161             jumbo_frames=kwargs[u"jumbo"]
 162         )
 163         self.machines[name].add_vhost_user_if(
 164             f"/run/vpp/sock-{qemu_id}-1",
 165             jumbo_frames=kwargs[u"jumbo"],
 166             queues=kwargs[u"queues"],
 167             queue_size=kwargs[u"perf_qemu_qsz"],
 168             csum=kwargs[u"enable_csum"],
 169             gso=kwargs[u"enable_gso"]
 170         )
 171         self.machines[name].add_vhost_user_if(
 172             f"/run/vpp/sock-{qemu_id}-2",
 173             jumbo_frames=kwargs[u"jumbo"],
 174             queues=kwargs[u"queues"],
 175             queue_size=kwargs[u"perf_qemu_qsz"],
 176             csum=kwargs[u"enable_csum"],
 177             gso=kwargs[u"enable_gso"]
 178         )