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 """ vPE (Power Edge router) VNF model definitions based on IETS Spec """
16 from __future__ import absolute_import
17 from __future__ import print_function
25 from six.moves import configparser, zip
27 from yardstick.common.process import check_if_process_failed
28 from yardstick.network_services.helpers.samplevnf_helper import PortPairs
29 from yardstick.network_services.pipeline import PipelineRules
30 from yardstick.network_services.vnf_generic.vnf.sample_vnf import SampleVNF, DpdkVnfSetupEnvHelper
32 LOG = logging.getLogger(__name__)
34 VPE_PIPELINE_COMMAND = "sudo {tool_path} -p {port_mask_hex} -f {cfg_file} -s {script} {hwlb}"
36 VPE_COLLECT_KPI = """\
37 Pkts in:\\s(\\d+)\r\n\
38 \tPkts dropped by AH:\\s(\\d+)\r\n\
39 \tPkts dropped by other:\\s(\\d+)\
43 class ConfigCreate(object):
46 def vpe_tmq(config, index):
47 tm_q = 'TM{0}'.format(index)
48 config.add_section(tm_q)
49 config.set(tm_q, 'burst_read', '24')
50 config.set(tm_q, 'burst_write', '32')
51 config.set(tm_q, 'cfg', '/tmp/full_tm_profile_10G.cfg')
54 def __init__(self, vnfd_helper, socket):
55 super(ConfigCreate, self).__init__()
59 self.vnfd_helper = vnfd_helper
60 self.uplink_ports = self.vnfd_helper.port_pairs.uplink_ports
61 self.downlink_ports = self.vnfd_helper.port_pairs.downlink_ports
62 self.pipeline_per_port = 9
64 self._dpdk_port_to_link_id_map = None
67 def dpdk_port_to_link_id_map(self):
68 # we need interface name -> DPDK port num (PMD ID) -> LINK ID
69 # LINK ID -> PMD ID is governed by the port mask
70 # LINK instances are created implicitly based on the PORT_MASK application startup
71 # argument. LINK0 is the first port enabled in the PORT_MASK, port 1 is the next one,
72 # etc. The LINK ID is different than the DPDK PMD-level NIC port ID, which is the actual
73 # position in the bitmask mentioned above. For example, if bit 5 is the first bit set
74 # in the bitmask, then LINK0 is having the PMD ID of 5. This mechanism creates a
75 # contiguous LINK ID space and isolates the configuration file against changes in the
76 # board PCIe slots where NICs are plugged in.
77 if self._dpdk_port_to_link_id_map is None:
78 self._dpdk_port_to_link_id_map = {}
79 for link_id, port_name in enumerate(sorted(self.vnfd_helper.port_pairs.all_ports,
80 key=self.vnfd_helper.port_num)):
81 self._dpdk_port_to_link_id_map[port_name] = link_id
82 return self._dpdk_port_to_link_id_map
84 def vpe_initialize(self, config):
85 config.add_section('EAL')
86 config.set('EAL', 'log_level', '0')
88 config.add_section('PIPELINE0')
89 config.set('PIPELINE0', 'type', 'MASTER')
90 config.set('PIPELINE0', 'core', 's%sC0' % self.socket)
92 config.add_section('MEMPOOL0')
93 config.set('MEMPOOL0', 'pool_size', '256K')
95 config.add_section('MEMPOOL1')
96 config.set('MEMPOOL1', 'pool_size', '2M')
99 def vpe_rxq(self, config):
100 for port in self.downlink_ports:
101 new_section = 'RXQ{0}.0'.format(self.dpdk_port_to_link_id_map[port])
102 config.add_section(new_section)
103 config.set(new_section, 'mempool', 'MEMPOOL1')
107 def get_sink_swq(self, parser, pipeline, k, index):
109 pktq = parser.get(pipeline, k)
112 sink = " SINK{0}".format(self.sink_q)
114 sink = " TM{0}".format(index)
115 pktq = "SWQ{0}{1}".format(self.sw_q, sink)
118 def vpe_upstream(self, vnf_cfg, index=0): # pragma: no cover
119 # NOTE(ralonsoh): this function must be covered in UTs.
120 parser = configparser.ConfigParser()
121 parser.read(os.path.join(vnf_cfg, 'vpe_upstream'))
123 for pipeline in parser.sections():
124 for k, v in parser.items(pipeline):
127 port = self.dpdk_port_to_link_id_map[self.uplink_ports[index]]
128 value = "RXQ{0}.0".format(port)
130 value = self.get_sink_swq(parser, pipeline, k, index)
132 parser.set(pipeline, k, value)
134 elif k == "pktq_out":
136 port = self.dpdk_port_to_link_id_map[self.downlink_ports[index]]
137 value = "TXQ{0}.0".format(port)
140 value = self.get_sink_swq(parser, pipeline, k, index)
142 parser.set(pipeline, k, value)
144 new_pipeline = 'PIPELINE{0}'.format(self.n_pipeline)
145 if new_pipeline != pipeline:
146 parser._sections[new_pipeline] = parser._sections[pipeline]
147 parser._sections.pop(pipeline)
151 def vpe_downstream(self, vnf_cfg, index): # pragma: no cover
152 # NOTE(ralonsoh): this function must be covered in UTs.
153 parser = configparser.ConfigParser()
154 parser.read(os.path.join(vnf_cfg, 'vpe_downstream'))
155 for pipeline in parser.sections():
156 for k, v in parser.items(pipeline):
159 port = self.dpdk_port_to_link_id_map[self.downlink_ports[index]]
161 value = self.get_sink_swq(parser, pipeline, k, index)
163 value = "RXQ{0}.0 TM{1}".format(port, index)
165 value = "RXQ{0}.0".format(port)
167 parser.set(pipeline, k, value)
170 port = self.dpdk_port_to_link_id_map[self.uplink_ports[index]]
173 value = self.get_sink_swq(parser, pipeline, k, index)
175 value = "TXQ{0}.0 TM{1}".format(port, index)
177 value = "TXQ{0}.0".format(port)
179 parser.set(pipeline, k, value)
181 new_pipeline = 'PIPELINE{0}'.format(self.n_pipeline)
182 if new_pipeline != pipeline:
183 parser._sections[new_pipeline] = parser._sections[pipeline]
184 parser._sections.pop(pipeline)
188 def create_vpe_config(self, vnf_cfg):
189 config = configparser.ConfigParser()
190 vpe_cfg = os.path.join("/tmp/vpe_config")
191 with open(vpe_cfg, 'w') as cfg_file:
192 config = self.vpe_initialize(config)
193 config = self.vpe_rxq(config)
194 config.write(cfg_file)
195 for index, _ in enumerate(self.uplink_ports):
196 config = self.vpe_upstream(vnf_cfg, index)
197 config.write(cfg_file)
198 config = self.vpe_downstream(vnf_cfg, index)
199 config = self.vpe_tmq(config, index)
200 config.write(cfg_file)
202 def generate_vpe_script(self, interfaces):
203 rules = PipelineRules(pipeline_id=1)
204 for uplink_port, downlink_port in zip(self.uplink_ports, self.downlink_ports):
207 next(intf["virtual-interface"] for intf in interfaces
208 if intf["name"] == uplink_port)
210 next(intf["virtual-interface"] for intf in interfaces
211 if intf["name"] == downlink_port)
213 dst_port0_ip = uplink_intf["dst_ip"]
214 dst_port1_ip = downlink_intf["dst_ip"]
215 dst_port0_mac = uplink_intf["dst_mac"]
216 dst_port1_mac = downlink_intf["dst_mac"]
218 rules.add_firewall_script(dst_port0_ip)
219 rules.next_pipeline()
220 rules.add_flow_classification_script()
221 rules.next_pipeline()
222 rules.add_flow_action()
223 rules.next_pipeline()
224 rules.add_flow_action2()
225 rules.next_pipeline()
226 rules.add_route_script(dst_port1_ip, dst_port1_mac)
227 rules.next_pipeline()
228 rules.add_route_script2(dst_port0_ip, dst_port0_mac)
229 rules.next_pipeline(num=4)
231 return rules.get_string()
233 def generate_tm_cfg(self, vnf_cfg):
234 vnf_cfg = os.path.join(vnf_cfg, "full_tm_profile_10G.cfg")
235 if os.path.exists(vnf_cfg):
236 return open(vnf_cfg).read()
239 class VpeApproxSetupEnvHelper(DpdkVnfSetupEnvHelper):
242 CFG_CONFIG = "/tmp/vpe_config"
243 CFG_SCRIPT = "/tmp/vpe_script"
244 TM_CONFIG = "/tmp/full_tm_profile_10G.cfg"
245 CORES = ['0', '1', '2', '3', '4', '5']
246 PIPELINE_COMMAND = VPE_PIPELINE_COMMAND
248 def _build_vnf_ports(self):
249 self._port_pairs = PortPairs(self.vnfd_helper.interfaces)
250 self.uplink_ports = self._port_pairs.uplink_ports
251 self.downlink_ports = self._port_pairs.downlink_ports
252 self.all_ports = self._port_pairs.all_ports
254 def build_config(self):
256 "bin_path": self.ssh_helper.bin_path,
257 "socket": self.socket,
260 self._build_vnf_ports()
261 vpe_conf = ConfigCreate(self.vnfd_helper, self.socket)
262 vpe_conf.create_vpe_config(self.scenario_helper.vnf_cfg)
264 config_basename = posixpath.basename(self.CFG_CONFIG)
265 script_basename = posixpath.basename(self.CFG_SCRIPT)
266 tm_basename = posixpath.basename(self.TM_CONFIG)
267 with open(self.CFG_CONFIG) as handle:
268 vpe_config = handle.read()
270 self.ssh_helper.upload_config_file(config_basename, vpe_config.format(**vpe_vars))
272 vpe_script = vpe_conf.generate_vpe_script(self.vnfd_helper.interfaces)
273 self.ssh_helper.upload_config_file(script_basename, vpe_script.format(**vpe_vars))
275 tm_config = vpe_conf.generate_tm_cfg(self.scenario_helper.vnf_cfg)
276 self.ssh_helper.upload_config_file(tm_basename, tm_config)
278 LOG.info("Provision and start the %s", self.APP_NAME)
279 LOG.info(self.CFG_CONFIG)
280 LOG.info(self.CFG_SCRIPT)
281 self._build_pipeline_kwargs()
282 return self.PIPELINE_COMMAND.format(**self.pipeline_kwargs)
285 class VpeApproxVnf(SampleVNF):
286 """ This class handles vPE VNF model-driver definitions """
290 COLLECT_KPI = VPE_COLLECT_KPI
293 def __init__(self, name, vnfd, setup_env_helper_type=None, resource_helper_type=None):
294 if setup_env_helper_type is None:
295 setup_env_helper_type = VpeApproxSetupEnvHelper
297 super(VpeApproxVnf, self).__init__(name, vnfd, setup_env_helper_type, resource_helper_type)
299 def get_stats(self, *args, **kwargs):
300 raise NotImplementedError
302 def collect_kpi(self):
303 # we can't get KPIs if the VNF is down
304 check_if_process_failed(self._vnf_process)
306 'pkt_in_up_stream': 0,
307 'pkt_drop_up_stream': 0,
308 'pkt_in_down_stream': 0,
309 'pkt_drop_down_stream': 0,
310 'collect_stats': self.resource_helper.collect_kpi(),
314 indexes_drop = [2, 3]
315 command = 'p {0} stats port {1} 0'
316 for index, direction in ((5, 'up'), (9, 'down')):
317 key_in = "pkt_in_{0}_stream".format(direction)
318 key_drop = "pkt_drop_{0}_stream".format(direction)
319 for mode in ('in', 'out'):
320 stats = self.vnf_execute(command.format(index, mode))
321 match = re.search(self.COLLECT_KPI, stats, re.MULTILINE)
324 result[key_in] += sum(int(match.group(x)) for x in indexes_in)
325 result[key_drop] += sum(int(match.group(x)) for x in indexes_drop)
327 LOG.debug("%s collect KPIs %s", self.APP_NAME, result)