1 # Copyright (c) 2016-2017 Intel Corporation
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14 """ Base class implementation for generic vnf implementation """
16 from __future__ import absolute_import
19 from yardstick.network_services.helpers.samplevnf_helper import PortPairs
21 LOG = logging.getLogger(__name__)
24 class QueueFileWrapper(object):
25 """ Class providing file-like API for talking with SSH connection """
27 def __init__(self, q_in, q_out, prompt):
36 """ read chunk from input queue """
37 if self.q_in.qsize() > 0 and size:
38 in_data = self.q_in.get()
41 def write(self, chunk):
42 """ write chunk to output queue """
43 self.buf.append(chunk)
44 # flush on prompt or if we exceed bufsize
46 size = sum(len(c) for c in self.buf)
47 if self.prompt in chunk or size > self.bufsize:
48 out = ''.join(self.buf)
53 """ close multiprocessing queue """
58 while self.q_out.qsize() > 0:
62 class VnfdHelper(dict):
64 def __init__(self, *args, **kwargs):
65 super(VnfdHelper, self).__init__(*args, **kwargs)
66 self.port_pairs = PortPairs(self['vdu'][0]['external-interface'])
67 # port num is not present until binding so we have to memoize
68 self._port_num_map = {}
71 def mgmt_interface(self):
72 return self["mgmt-interface"]
84 return self.vdu0['external-interface']
88 return self['benchmark']['kpi']
90 def find_virtual_interface(self, **kwargs):
91 key, value = next(iter(kwargs.items()))
92 for interface in self.interfaces:
93 virtual_intf = interface["virtual-interface"]
94 if virtual_intf[key] == value:
98 def find_interface(self, **kwargs):
99 key, value = next(iter(kwargs.items()))
100 for interface in self.interfaces:
101 if interface[key] == value:
105 # hide dpdk_port_num key so we can abstract
106 def find_interface_by_port(self, port):
107 for interface in self.interfaces:
108 virtual_intf = interface["virtual-interface"]
109 # we have to convert to int to compare
110 if int(virtual_intf['dpdk_port_num']) == port:
114 def port_num(self, port):
115 # we need interface name -> DPDK port num (PMD ID) -> LINK ID
116 # LINK ID -> PMD ID is governed by the port mask
122 if isinstance(port, dict):
125 intf = self.find_interface(name=port)
126 return self._port_num_map.setdefault(intf["name"],
127 int(intf["virtual-interface"]["dpdk_port_num"]))
129 def port_nums(self, intfs):
130 return [self.port_num(i) for i in intfs]
132 def ports_iter(self):
133 for port_name in self.port_pairs.all_ports:
134 port_num = self.port_num(port_name)
135 yield port_name, port_num
138 class VNFObject(object):
140 # centralize network naming convention
141 UPLINK = PortPairs.UPLINK
142 DOWNLINK = PortPairs.DOWNLINK
144 def __init__(self, name, vnfd):
145 super(VNFObject, self).__init__()
147 self.vnfd_helper = VnfdHelper(vnfd) # fixme: parse this into a structure
150 class GenericVNF(VNFObject):
152 """ Class providing file-like API for generic VNF implementation """
153 def __init__(self, name, vnfd):
154 super(GenericVNF, self).__init__(name, vnfd)
155 # List of statistics we can obtain from this VNF
156 # - ETSI MANO 6.3.1.1 monitoring_parameter
157 self.kpi = self._get_kpi_definition()
158 # Standard dictionary containing params like thread no, buffer size etc
160 self.runs_traffic = False
162 def _get_kpi_definition(self):
163 """ Get list of KPIs defined in VNFD
166 :return: list of KPIs, e.g. ['throughput', 'latency']
168 return self.vnfd_helper.kpi
170 def instantiate(self, scenario_cfg, context_cfg):
171 """ Prepare VNF for operation and start the VNF process/VM
177 raise NotImplementedError()
179 def wait_for_instantiate(self):
180 """ Wait for VNF to start
184 raise NotImplementedError()
187 """ Kill all VNF processes
191 raise NotImplementedError()
193 def scale(self, flavor=""):
199 raise NotImplementedError()
201 def collect_kpi(self):
202 """This method should return a dictionary containing the
203 selected KPI at a given point of time.
205 :return: {"kpi": value, "kpi2": value}
207 raise NotImplementedError()
210 class GenericTrafficGen(GenericVNF):
211 """ Class providing file-like API for generic traffic generator """
213 def __init__(self, name, vnfd):
214 super(GenericTrafficGen, self).__init__(name, vnfd)
215 self.runs_traffic = True
216 self.traffic_finished = False
218 def run_traffic(self, traffic_profile):
219 """ Generate traffic on the wire according to the given params.
220 Method is non-blocking, returns immediately when traffic process
221 is running. Mandatory.
223 :param traffic_profile:
226 raise NotImplementedError()
228 def listen_traffic(self, traffic_profile):
229 """ Listen to traffic with the given parameters.
230 Method is non-blocking, returns immediately when traffic process
231 is running. Optional.
233 :param traffic_profile:
238 def verify_traffic(self, traffic_profile):
239 """ Verify captured traffic after it has ended. Optional.
241 :param traffic_profile:
247 """ After this method finishes, all traffic processes should stop. Mandatory.
251 raise NotImplementedError()