1 # Copyright (c) 2018 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.
20 from yardstick.common.process import check_if_process_failed
21 from yardstick.network_services.vnf_generic.vnf.prox_helpers import ProxDpdkVnfSetupEnvHelper
22 from yardstick.network_services.vnf_generic.vnf.prox_helpers import ProxResourceHelper
23 from yardstick.network_services.vnf_generic.vnf.sample_vnf import SampleVNF
24 from yardstick.network_services import constants
25 from yardstick.benchmark.contexts import base as context_base
27 LOG = logging.getLogger(__name__)
30 class ProxApproxVnf(SampleVNF):
34 PROX_MODE = "Workload"
35 VNF_PROMPT = "PROX started"
36 LUA_PARAMETER_NAME = "sut"
38 def __init__(self, name, vnfd, task_id, setup_env_helper_type=None,
39 resource_helper_type=None):
40 if setup_env_helper_type is None:
41 setup_env_helper_type = ProxDpdkVnfSetupEnvHelper
43 if resource_helper_type is None:
44 resource_helper_type = ProxResourceHelper
46 self.prev_packets_in = 0
47 self.prev_packets_sent = 0
50 super(ProxApproxVnf, self).__init__(
51 name, vnfd, task_id, setup_env_helper_type, resource_helper_type)
53 def _vnf_up_post(self):
54 self.resource_helper.up_post()
56 def vnf_execute(self, cmd, *args, **kwargs):
57 # try to execute with socket commands
58 # ignore socket errors, e.g. when using force_quit
59 ignore_errors = kwargs.pop("_ignore_errors", False)
61 return self.resource_helper.execute(cmd, *args, **kwargs)
63 if e.errno in {errno.EPIPE, errno.ESHUTDOWN, errno.ECONNRESET}:
65 LOG.debug("ignoring vnf_execute exception %s for command %s", e, cmd)
71 def collect_kpi(self):
72 # we can't get KPIs if the VNF is down
73 check_if_process_failed(self._vnf_process, 0.01)
75 physical_node = context_base.Context.get_physical_node_from_server(
76 self.scenario_helper.nodes[self.name])
78 result = {"physical_node": physical_node}
80 if self.resource_helper is None:
86 "curr_packets_fwd": 0,
87 "collect_stats": {"core": {}},
91 if (self.tsc_hz == 0):
92 self.tsc_hz = float(self.resource_helper.sut.hz())
93 LOG.debug("TSC = %f", self.tsc_hz)
94 if (self.tsc_hz == 0):
95 raise RuntimeError("Unable to retrieve TSC")
97 # use all_ports so we only use ports matched in topology
98 port_count = len(self.vnfd_helper.port_pairs.all_ports)
99 if port_count not in {1, 2, 4}:
100 raise RuntimeError("Failed ..Invalid no of ports .. "
101 "1, 2 or 4 ports only supported at this time")
103 tmpPorts = [self.vnfd_helper.port_num(port_name)
104 for port_name in self.vnfd_helper.port_pairs.all_ports]
106 timeout = time.time() + constants.RETRY_TIMEOUT
108 ok, all_port_stats = self.vnf_execute('multi_port_stats', tmpPorts)
109 if time.time() > timeout:
113 rx_total = tx_total = tsc = 0
115 for single_port_stats in all_port_stats:
116 rx_total = rx_total + single_port_stats[1]
117 tx_total = tx_total + single_port_stats[2]
118 tsc = tsc + single_port_stats[5]
119 except (TypeError, IndexError):
120 LOG.error("Invalid data ...")
125 tsc = tsc / port_count
128 "packets_in": rx_total,
129 "packets_dropped": max((tx_total - rx_total), 0),
130 "packets_fwd": tx_total,
131 # we share ProxResourceHelper with TG, but we want to collect
132 # collectd KPIs here and not TG KPIs, so use a different method name
133 "collect_stats": self.resource_helper.collect_collectd_kpi(),
136 curr_packets_in = int(((rx_total - self.prev_packets_in) * self.tsc_hz)
137 / (tsc - self.prev_tsc))
138 except ZeroDivisionError:
139 LOG.error("Error.... Divide by Zero")
143 curr_packets_fwd = int(((tx_total - self.prev_packets_sent) * self.tsc_hz)
144 / (tsc - self.prev_tsc))
145 except ZeroDivisionError:
146 LOG.error("Error.... Divide by Zero")
149 result["curr_packets_in"] = curr_packets_in
150 result["curr_packets_fwd"] = curr_packets_fwd
152 self.prev_packets_in = rx_total
153 self.prev_packets_sent = tx_total
156 LOG.debug("%s collect KPIs %s %s", self.APP_NAME, datetime.datetime.now(), result)
159 def _tear_down(self):
160 # this should be standardized for all VNFs or removed
161 self.setup_helper.tear_down()
164 # stop collectd first or we get pika errors?
165 self.resource_helper.stop_collect()
166 # try to quit with socket commands
167 # pkill is not matching, debug with pgrep
168 self.ssh_helper.execute("sudo pgrep -lax %s" % self.setup_helper.APP_NAME)
169 self.ssh_helper.execute("sudo ps aux | grep -i %s" % self.setup_helper.APP_NAME)
170 if self._vnf_process.is_alive():
171 self.vnf_execute("stop_all")
172 self.vnf_execute("quit")
173 # hopefully quit succeeds and socket closes, so ignore force_quit socket errors
174 self.vnf_execute("force_quit", _ignore_errors=True)
175 self.setup_helper.kill_vnf()
177 if self._vnf_process is not None:
178 LOG.debug("joining before terminate %s", self._vnf_process.name)
179 self._vnf_process.join(constants.PROCESS_JOIN_TIMEOUT)
180 self._vnf_process.terminate()