aboutsummaryrefslogtreecommitdiffstats
path: root/yardstick/network_services/vnf_generic/vnf/prox_vnf.py
blob: 839f3096760873234649f8f9403c67f28453d7f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# Copyright (c) 2017 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import errno
import logging
import datetime

from yardstick.common.process import check_if_process_failed
from yardstick.network_services.vnf_generic.vnf.prox_helpers import ProxDpdkVnfSetupEnvHelper
from yardstick.network_services.vnf_generic.vnf.prox_helpers import ProxResourceHelper
from yardstick.network_services.vnf_generic.vnf.sample_vnf import SampleVNF
from yardstick.network_services import constants
from yardstick.benchmark.contexts import base as context_base

LOG = logging.getLogger(__name__)


class ProxApproxVnf(SampleVNF):

    APP_NAME = 'PROX'
    APP_WORD = 'PROX'
    PROX_MODE = "Workload"
    VNF_PROMPT = "PROX started"
    LUA_PARAMETER_NAME = "sut"

    def __init__(self, name, vnfd, task_id, setup_env_helper_type=None,
                 resource_helper_type=None):
        if setup_env_helper_type is None:
            setup_env_helper_type = ProxDpdkVnfSetupEnvHelper

        if resource_helper_type is None:
            resource_helper_type = ProxResourceHelper

        self.prev_packets_in = 0
        self.prev_packets_sent = 0
        self.prev_tsc = 0
        self.tsc_hz = 0
        super(ProxApproxVnf, self).__init__(
            name, vnfd, task_id, setup_env_helper_type, resource_helper_type)

    def _vnf_up_post(self):
        self.resource_helper.up_post()

    def vnf_execute(self, cmd, *args, **kwargs):
        # try to execute with socket commands
        # ignore socket errors, e.g. when using force_quit
        ignore_errors = kwargs.pop("_ignore_errors", False)
        try:
            return self.resource_helper.execute(cmd, *args, **kwargs)
        except OSError as e:
            if e.errno in {errno.EPIPE, errno.ESHUTDOWN, errno.ECONNRESET}:
                if ignore_errors:
                    LOG.debug("ignoring vnf_execute exception %s for command %s", e, cmd)
                else:
                    raise
            else:
                raise

    def collect_kpi(self):
        # we can't get KPIs if the VNF is down
        check_if_process_failed(self._vnf_process, 0.01)

        physical_node = context_base.Context.get_physical_node_from_server(
            self.scenario_helper.nodes[self.name])

        result = {"physical_node": physical_node}

        if self.resource_helper is None:
            result.update({
                "packets_in": 0,
                "packets_dropped": 0,
                "packets_fwd": 0,
                "collect_stats": {"core": {}},
            })
            return result

        if (self.tsc_hz == 0):
            self.tsc_hz = float(self.resource_helper.sut.hz())
            LOG.debug("TSC = %f", self.tsc_hz)
            if (self.tsc_hz == 0):
                raise RuntimeError("Unable to retrieve TSC")

        # use all_ports so we only use ports matched in topology
        port_count = len(self.vnfd_helper.port_pairs.all_ports)
        if port_count not in {1, 2, 4}:
            raise RuntimeError("Failed ..Invalid no of ports .. "
                               "1, 2 or 4 ports only supported at this time")

        all_port_stats = self.vnf_execute('multi_port_stats', range(port_count))
        rx_total = tx_total = tsc = 0
        try:
            for single_port_stats in all_port_stats:
                rx_total = rx_total + single_port_stats[1]
                tx_total = tx_total + single_port_stats[2]
                tsc = tsc + single_port_stats[5]
        except (TypeError, IndexError):
            LOG.error("Invalid data ...")
            return {}

        tsc = tsc / port_count

        result.update({
            "packets_in": rx_total,
            "packets_dropped": max((tx_total - rx_total), 0),
            "packets_fwd": tx_total,
            # we share ProxResourceHelper with TG, but we want to collect
            # collectd KPIs here and not TG KPIs, so use a different method name
            "collect_stats": self.resource_helper.collect_collectd_kpi(),
        })
        try:
            curr_packets_in = int(((rx_total - self.prev_packets_in) * self.tsc_hz)
                                / (tsc - self.prev_tsc))
        except ZeroDivisionError:
            LOG.error("Error.... Divide by Zero")
            curr_packets_in = 0

        try:
            curr_packets_fwd = int(((tx_total - self.prev_packets_sent) * self.tsc_hz)
                                / (tsc - self.prev_tsc))
        except ZeroDivisionError:
            LOG.error("Error.... Divide by Zero")
            curr_packets_fwd = 0

        result["curr_packets_in"] = curr_packets_in
        result["curr_packets_fwd"] = curr_packets_fwd

        self.prev_packets_in = rx_total
        self.prev_packets_sent = tx_total
        self.prev_tsc = tsc

        LOG.debug("%s collect KPIs %s %s", self.APP_NAME, datetime.datetime.now(), result)
        return result

    def _tear_down(self):
        # this should be standardized for all VNFs or removed
        self.setup_helper.tear_down()

    def terminate(self):
        # stop collectd first or we get pika errors?
        self.resource_helper.stop_collect()
        # try to quit with socket commands
        # pkill is not matching, debug with pgrep
        self.ssh_helper.execute("sudo pgrep -lax  %s" % self.setup_helper.APP_NAME)
        self.ssh_helper.execute("sudo ps aux | grep -i %s" % self.setup_helper.APP_NAME)
        if self._vnf_process.is_alive():
            self.vnf_execute("stop_all")
            self.vnf_execute("quit")
            # hopefully quit succeeds and socket closes, so ignore force_quit socket errors
            self.vnf_execute("force_quit", _ignore_errors=True)
        self.setup_helper.kill_vnf()
        self._tear_down()
        if self._vnf_process is not None:
            LOG.debug("joining before terminate %s", self._vnf_process.name)
            self._vnf_process.join(constants.PROCESS_JOIN_TIMEOUT)
            self._vnf_process.terminate()