NFVBENCH-40 Add pylint to tox
[nfvbench.git] / nfvbench / chain_managers.py
1 #!/usr/bin/env python
2 # Copyright 2016 Cisco Systems, Inc.  All rights reserved.
3 #
4 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
5 #    not use this file except in compliance with the License. You may obtain
6 #    a copy of the License at
7 #
8 #         http://www.apache.org/licenses/LICENSE-2.0
9 #
10 #    Unless required by applicable law or agreed to in writing, software
11 #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 #    License for the specific language governing permissions and limitations
14 #    under the License.
15 #
16 import time
17
18
19 from log import LOG
20 from network import Network
21 from packet_analyzer import PacketAnalyzer
22 from specs import ChainType
23 from stats_collector import IntervalCollector
24
25
26 class StageManager(object):
27
28     def __init__(self, config, cred, factory):
29         self.config = config
30         self.client = None
31         # conditions due to EXT chain special cases
32         if (config.vlan_tagging and not config.vlans) or not config.no_int_config:
33             VM_CLASS = factory.get_stage_class(config.service_chain)
34             self.client = VM_CLASS(config, cred)
35             self.client.setup()
36
37     def get_vlans(self):
38         return self.client.get_vlans() if self.client else []
39
40     def get_host_ips(self):
41         return self.client.get_host_ips()
42
43     def get_networks_uuids(self):
44         return self.client.get_networks_uuids()
45
46     def disable_port_security(self):
47         self.client.disable_port_security()
48
49     def get_vms(self):
50         return self.client.vms
51
52     def get_nets(self):
53         return self.client.nets
54
55     def get_ports(self):
56         return self.client.ports
57
58     def get_compute_nodes(self):
59         return self.client.compute_nodes
60
61     def set_vm_macs(self):
62         if self.client and self.config.service_chain != ChainType.EXT:
63             self.config.generator_config.set_vm_mac_list(self.client.get_end_port_macs())
64
65     def close(self):
66         if not self.config.no_cleanup and self.client:
67             self.client.dispose()
68
69
70 class StatsManager(object):
71
72     def __init__(self, config, clients, specs, factory, vlans, notifier=None):
73         self.config = config
74         self.clients = clients
75         self.specs = specs
76         self.notifier = notifier
77         self.interval_collector = None
78         self.vlans = vlans
79         self.factory = factory
80         self._setup()
81
82     def set_vlan_tag(self, device, vlan):
83         self.worker.set_vlan_tag(device, vlan)
84
85     def _setup(self):
86         WORKER_CLASS = self.factory.get_chain_worker(self.specs.openstack.encaps,
87                                                      self.config.service_chain)
88         self.worker = WORKER_CLASS(self.config, self.clients, self.specs)
89         try:
90             self.worker.set_vlans(self.vlans)
91             self._config_interfaces()
92         except Exception as exc:
93             # since the wrorker is up and running, we need to close it
94             # in case of exception
95             self.close()
96             raise exc
97
98     def _get_data(self):
99         return self.worker.get_data()
100
101     def _get_network(self, traffic_port, index=None, reverse=False):
102         interfaces = [self.clients['traffic'].get_interface(traffic_port)]
103         interfaces.extend(self.worker.get_network_interfaces(index))
104         return Network(interfaces, reverse)
105
106     def _config_interfaces(self):
107         if self.config.service_chain != ChainType.EXT:
108             self.clients['vm'].disable_port_security()
109
110         self.worker.config_interfaces()
111
112     def _generate_traffic(self):
113         if self.config.no_traffic:
114             return
115
116         self.interval_collector = IntervalCollector(time.time())
117         self.interval_collector.attach_notifier(self.notifier)
118         LOG.info('Starting to generate traffic...')
119         stats = {}
120         for stats in self.clients['traffic'].run_traffic():
121             self.interval_collector.add(stats)
122
123         LOG.info('...traffic generating ended.')
124         return stats
125
126     def get_stats(self):
127         return self.interval_collector.get() if self.interval_collector else []
128
129     def get_version(self):
130         return self.worker.get_version()
131
132     def run(self):
133         """
134         Run analysis in both direction and return the analysis
135         """
136         self.worker.run()
137
138         stats = self._generate_traffic()
139         result = {
140             'raw_data': self._get_data(),
141             'packet_analysis': {},
142             'stats': stats
143         }
144
145         LOG.info('Requesting packet analysis on the forward direction...')
146         result['packet_analysis']['direction-forward'] = \
147             self.get_analysis([self._get_network(0, 0),
148                                self._get_network(0, 1, reverse=True)])
149         LOG.info('Packet analysis on the forward direction completed')
150
151         LOG.info('Requesting packet analysis on the reverse direction...')
152         result['packet_analysis']['direction-reverse'] = \
153             self.get_analysis([self._get_network(1, 1),
154                                self._get_network(1, 0, reverse=True)])
155
156         LOG.info('Packet analysis on the reverse direction completed')
157         return result
158
159     def get_compute_nodes_bios(self):
160         return self.worker.get_compute_nodes_bios()
161
162     @staticmethod
163     def get_analysis(nets):
164         LOG.info('Starting traffic analysis...')
165
166         packet_analyzer = PacketAnalyzer()
167         # Traffic types are assumed to always alternate in every chain. Add a no stats interface in
168         # between if that is not the case.
169         tx = True
170         for network in nets:
171             for interface in network.get_interfaces():
172                 packet_analyzer.record(interface, 'tx' if tx else 'rx')
173                 tx = not tx
174
175         LOG.info('...traffic analysis completed')
176         return packet_analyzer.get_analysis()
177
178     def close(self):
179         self.worker.close()
180
181
182 class PVPStatsManager(StatsManager):
183
184     def __init__(self, config, clients, specs, factory, vlans, notifier=None):
185         StatsManager.__init__(self, config, clients, specs, factory, vlans, notifier)
186
187
188 class PVVPStatsManager(StatsManager):
189
190     def __init__(self, config, clients, specs, factory, vlans, notifier=None):
191         StatsManager.__init__(self, config, clients, specs, factory, vlans, notifier)
192
193     def run(self):
194         """
195         Run analysis in both direction and return the analysis
196         """
197         fwd_v2v_net, rev_v2v_net = self.worker.run()
198
199         stats = self._generate_traffic()
200         result = {
201             'raw_data': self._get_data(),
202             'packet_analysis': {},
203             'stats': stats
204         }
205
206         fwd_nets = [self._get_network(0, 0)]
207         if fwd_v2v_net:
208             fwd_nets.append(fwd_v2v_net)
209         fwd_nets.append(self._get_network(0, 1, reverse=True))
210
211         rev_nets = [self._get_network(1, 1)]
212         if rev_v2v_net:
213             rev_nets.append(rev_v2v_net)
214         rev_nets.append(self._get_network(1, 0, reverse=True))
215
216         LOG.info('Requesting packet analysis on the forward direction...')
217         result['packet_analysis']['direction-forward'] = self.get_analysis(fwd_nets)
218         LOG.info('Packet analysis on the forward direction completed')
219
220         LOG.info('Requesting packet analysis on the reverse direction...')
221         result['packet_analysis']['direction-reverse'] = self.get_analysis(rev_nets)
222
223         LOG.info('Packet analysis on the reverse direction completed')
224         return result
225
226
227 class EXTStatsManager(StatsManager):
228     def __init__(self, config, clients, specs, factory, vlans, notifier=None):
229         StatsManager.__init__(self, config, clients, specs, factory, vlans, notifier)
230
231     def _setup(self):
232         WORKER_CLASS = self.factory.get_chain_worker(self.specs.openstack.encaps,
233                                                      self.config.service_chain)
234         self.worker = WORKER_CLASS(self.config, self.clients, self.specs)
235         self.worker.set_vlans(self.vlans)
236
237         if not self.config.no_int_config:
238             self._config_interfaces()