2 # Copyright 2016 Cisco Systems, Inc. All rights reserved.
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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
17 from __init__ import __version__
19 from attrdict import AttrDict
20 from chain_runner import ChainRunner
21 from collections import defaultdict
22 from config import config_load
23 from config import config_loads
27 from factory import BasicFactory
28 from fluentd import FluentLogHandler
33 from nfvbenchd import WebSocketIoServer
36 from pkg_resources import resource_string
37 from specs import ChainType
38 from specs import Specs
39 from summarizer import NFVBenchSummarizer
42 from traffic_client import TrafficGeneratorFactory
47 class NFVBench(object):
48 """Main class of NFV benchmarking tool."""
50 STATUS_ERROR = 'ERROR'
52 def __init__(self, config, openstack_spec, config_plugin, factory, notifier=None):
53 self.base_config = config
55 self.config_plugin = config_plugin
56 self.factory = factory
57 self.notifier = notifier
58 self.cred = credentials.Credentials(config.openrc_file, None, False)
59 self.chain_runner = None
61 self.specs.set_openstack_spec(openstack_spec)
62 self.clients = defaultdict(lambda: None)
67 self.specs.set_run_spec(self.config_plugin.get_run_spec(self.specs.openstack))
68 self.chain_runner = ChainRunner(self.config,
75 def set_notifier(self, notifier):
76 self.notifier = notifier
79 status = NFVBench.STATUS_OK
83 # take a snapshot of the current time for this new run
84 # so that all subsequent logs can relate to this run
85 fluent_logger.start_new_run()
87 self.update_config(opts)
91 "date": datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
92 "nfvbench_version": __version__,
94 "vswitch": self.specs.openstack.vswitch,
95 "encaps": self.specs.openstack.encaps
97 "config": self.config_plugin.prepare_results_config(copy.deepcopy(self.config)),
100 "service_chain": self.chain_runner.run(),
101 "versions": self.chain_runner.get_version(),
105 result['benchmarks']['network']['versions'].update(self.config_plugin.get_version())
107 status = NFVBench.STATUS_ERROR
108 message = traceback.format_exc()
109 except KeyboardInterrupt:
110 status = NFVBench.STATUS_ERROR
111 message = traceback.format_exc()
113 if self.chain_runner:
114 self.chain_runner.close()
116 if status == NFVBench.STATUS_OK:
117 result = utils.dict_to_json_dict(result)
125 'error_message': message
128 def print_summary(self, result):
129 """Print summary of the result"""
130 summary = NFVBenchSummarizer(result)
131 LOG.info(str(summary))
133 def save(self, result):
134 """Save results in json format file."""
135 utils.save_json_result(result,
136 self.config.json_file,
137 self.config.std_json_path,
138 self.config.service_chain,
139 self.config.service_chain_count,
140 self.config.flow_count,
141 self.config.frame_sizes)
143 def update_config(self, opts):
144 self.config = AttrDict(dict(self.base_config))
145 self.config.update(opts)
147 self.config.service_chain = self.config.service_chain.upper()
148 self.config.service_chain_count = int(self.config.service_chain_count)
149 self.config.flow_count = utils.parse_flow_count(self.config.flow_count)
150 required_flow_count = self.config.service_chain_count * 2
151 if self.config.flow_count < required_flow_count:
152 LOG.info("Flow count '{}' has been set to minimum value of '{}' "
153 "for current configuration".format(self.config.flow_count,
154 required_flow_count))
155 self.config.flow_count = required_flow_count
157 if self.config.flow_count % 2 != 0:
158 self.config.flow_count += 1
160 self.config.duration_sec = float(self.config.duration_sec)
161 self.config.interval_sec = float(self.config.interval_sec)
163 # Get traffic generator profile config
164 if not self.config.generator_profile:
165 self.config.generator_profile = self.config.traffic_generator.default_profile
167 generator_factory = TrafficGeneratorFactory(self.config)
168 self.config.generator_config = \
169 generator_factory.get_generator_config(self.config.generator_profile)
171 if not any(self.config.generator_config.pcis):
172 raise Exception("PCI addresses configuration for selected traffic generator profile "
173 "({tg_profile}) are missing. Please specify them in configuration file."
174 .format(tg_profile=self.config.generator_profile))
176 if self.config.traffic is None or len(self.config.traffic) == 0:
177 raise Exception("No traffic profile found in traffic configuration, "
178 "please fill 'traffic' section in configuration file.")
180 if isinstance(self.config.traffic, tuple):
181 self.config.traffic = self.config.traffic[0]
183 self.config.frame_sizes = generator_factory.get_frame_sizes(self.config.traffic.profile)
185 self.config.ipv6_mode = False
186 self.config.no_dhcp = True
187 self.config.same_network_only = True
188 if self.config.openrc_file:
189 self.config.openrc_file = os.path.expanduser(self.config.openrc_file)
191 self.config.ndr_run = (not self.config.no_traffic
192 and 'ndr' in self.config.rate.strip().lower().split('_'))
193 self.config.pdr_run = (not self.config.no_traffic
194 and 'pdr' in self.config.rate.strip().lower().split('_'))
195 self.config.single_run = (not self.config.no_traffic
196 and not (self.config.ndr_run or self.config.pdr_run))
198 if self.config.vlans and len(self.config.vlans) != 2:
199 raise Exception('Number of configured VLAN IDs for VLAN tagging must be exactly 2.')
201 self.config.json_file = self.config.json if self.config.json else None
202 if self.config.json_file:
203 (path, filename) = os.path.split(self.config.json)
204 if not os.path.exists(path):
205 raise Exception('Please provide existing path for storing results in JSON file. '
206 'Path used: {path}'.format(path=path))
208 self.config.std_json_path = self.config.std_json if self.config.std_json else None
209 if self.config.std_json_path:
210 if not os.path.exists(self.config.std_json):
211 raise Exception('Please provide existing path for storing results in JSON file. '
212 'Path used: {path}'.format(path=self.config.std_json_path))
214 self.config_plugin.validate_config(self.config, self.specs.openstack)
217 def parse_opts_from_cli():
218 parser = argparse.ArgumentParser()
220 parser.add_argument('-c', '--config', dest='config',
222 help='Override default values with a config file or '
223 'a yaml/json config string',
224 metavar='<file_name_or_yaml>')
226 parser.add_argument('--server', dest='server',
229 metavar='<http_root_pathname>',
230 help='Run nfvbench in server mode and pass'
231 ' the HTTP root folder full pathname')
233 parser.add_argument('--host', dest='host',
236 help='Host IP address on which server will be listening (default 0.0.0.0)')
238 parser.add_argument('-p', '--port', dest='port',
241 help='Port on which server will be listening (default 7555)')
243 parser.add_argument('-sc', '--service-chain', dest='service_chain',
244 choices=BasicFactory.chain_classes,
246 help='Service chain to run')
248 parser.add_argument('-scc', '--service-chain-count', dest='service_chain_count',
250 help='Set number of service chains to run',
251 metavar='<service_chain_count>')
253 parser.add_argument('-fc', '--flow-count', dest='flow_count',
255 help='Set number of total flows for all chains and all directions',
256 metavar='<flow_count>')
258 parser.add_argument('--rate', dest='rate',
260 help='Specify rate in pps, bps or %% as total for all directions',
263 parser.add_argument('--duration', dest='duration_sec',
265 help='Set duration to run traffic generator (in seconds)',
266 metavar='<duration_sec>')
268 parser.add_argument('--interval', dest='interval_sec',
270 help='Set interval to record traffic generator stats (in seconds)',
271 metavar='<interval_sec>')
273 parser.add_argument('--inter-node', dest='inter_node',
276 help='run VMs in different compute nodes (PVVP only)')
278 parser.add_argument('--sriov', dest='sriov',
281 help='Use SRIOV (no vswitch - requires SRIOV support in compute nodes)')
283 parser.add_argument('-d', '--debug', dest='debug',
286 help='print debug messages (verbose)')
288 parser.add_argument('-g', '--traffic-gen', dest='generator_profile',
290 help='Traffic generator profile to use')
292 parser.add_argument('-i', '--image', dest='image_name',
294 help='VM image name to use')
296 parser.add_argument('-0', '--no-traffic', dest='no_traffic',
299 help='Check config and connectivity only - do not generate traffic')
301 parser.add_argument('--no-arp', dest='no_arp',
304 help='Do not use ARP to find MAC addresses, '
305 'instead use values in config file')
307 parser.add_argument('--no-reset', dest='no_reset',
310 help='Do not reset counters prior to running')
312 parser.add_argument('--no-int-config', dest='no_int_config',
315 help='Skip interfaces config on EXT service chain')
317 parser.add_argument('--no-tor-access', dest='no_tor_access',
320 help='Skip TOR switch configuration and retrieving of stats')
322 parser.add_argument('--no-vswitch-access', dest='no_vswitch_access',
325 help='Skip vswitch configuration and retrieving of stats')
327 parser.add_argument('--no-cleanup', dest='no_cleanup',
330 help='no cleanup after run')
332 parser.add_argument('--json', dest='json',
334 help='store results in json format file',
335 metavar='<path>/<filename>')
337 parser.add_argument('--std-json', dest='std_json',
339 help='store results in json format file with nfvbench standard filename: '
340 '<service-chain-type>-<service-chain-count>-<flow-count>'
341 '-<packet-sizes>.json',
344 parser.add_argument('--show-default-config', dest='show_default_config',
347 help='print the default config in yaml format (unedited)')
349 parser.add_argument('--show-config', dest='show_config',
352 help='print the running config in json format')
354 parser.add_argument('-ss', '--show-summary', dest='summary',
356 help='Show summary from nfvbench json file',
359 parser.add_argument('-v', '--version', dest='version',
364 parser.add_argument('-fs', '--frame-size', dest='frame_sizes',
366 help='Override traffic profile frame sizes',
367 metavar='<frame_size_bytes or IMIX>')
369 parser.add_argument('--unidir', dest='unidir',
372 help='Override traffic profile direction (requires -fs)')
374 parser.add_argument('--log-file', '--logfile', dest='log_file',
376 help='Filename for saving logs',
377 metavar='<log_file>')
379 opts, unknown_opts = parser.parse_known_args()
380 return opts, unknown_opts
383 def load_default_config():
384 default_cfg = resource_string(__name__, "cfg.default.yaml")
385 config = config_loads(default_cfg)
386 config.name = '(built-in default config)'
387 return config, default_cfg
390 def override_custom_traffic(config, frame_sizes, unidir):
391 """Override the traffic profiles with a custom one
393 if frame_sizes is not None:
394 traffic_profile_name = "custom_traffic_profile"
395 config.traffic_profile = [
397 "l2frame_size": frame_sizes,
398 "name": traffic_profile_name
402 traffic_profile_name = config.traffic["profile"]
404 bidirectional = config.traffic['bidirectional'] if unidir is None else not unidir
406 "bidirectional": bidirectional,
407 "profile": traffic_profile_name
410 def check_physnet(name, netattrs):
411 if not netattrs.physical_network:
412 raise Exception("SRIOV requires physical_network to be specified for the {n} network"
414 if not netattrs.segmentation_id:
415 raise Exception("SRIOV requires segmentation_id to be specified for the {n} network"
422 # load default config file
423 config, default_cfg = load_default_config()
424 # create factory for platform specific classes
426 factory_module = importlib.import_module(config['factory_module'])
427 factory = getattr(factory_module, config['factory_class'])()
428 except AttributeError:
429 raise Exception("Requested factory module '{m}' or class '{c}' was not found."
430 .format(m=config['factory_module'], c=config['factory_class']))
431 # create config plugin for this platform
432 config_plugin = factory.get_config_plugin_class()(config)
433 config = config_plugin.get_config()
434 openstack_spec = config_plugin.get_openstack_spec()
436 # setup the fluent logger as soon as possible right after the config plugin is called
437 if config.fluentd.logging_tag:
438 fluent_logger = FluentLogHandler(config.fluentd.logging_tag,
439 fluentd_ip=config.fluentd.ip,
440 fluentd_port=config.fluentd.port)
441 LOG.addHandler(fluent_logger)
445 opts, unknown_opts = parse_opts_from_cli()
446 log.set_level(debug=opts.debug)
449 print pbr.version.VersionInfo('nfvbench').version_string_with_vcs()
453 with open(opts.summary) as json_data:
454 print NFVBenchSummarizer(json.load(json_data))
457 # show default config in text/yaml format
458 if opts.show_default_config:
464 # do not check extra_specs in flavor as it can contain any key/value pairs
465 whitelist_keys = ['extra_specs']
466 # override default config options with start config at path parsed from CLI
467 # check if it is an inline yaml/json config or a file name
468 if os.path.isfile(opts.config):
469 LOG.info('Loading configuration file: ' + opts.config)
470 config = config_load(opts.config, config, whitelist_keys)
471 config.name = os.path.basename(opts.config)
473 LOG.info('Loading configuration string: ' + opts.config)
474 config = config_loads(opts.config, config, whitelist_keys)
476 # traffic profile override options
477 override_custom_traffic(config, opts.frame_sizes, opts.unidir)
479 # copy over cli options that are used in config
480 config.generator_profile = opts.generator_profile
484 config.log_file = opts.log_file
486 # show running config in json format
488 print json.dumps(config, sort_keys=True, indent=4)
491 if config.sriov and config.service_chain != ChainType.EXT:
492 # if sriov is requested (does not apply to ext chains)
493 # make sure the physnet names are specified
494 check_physnet("left", config.internal_networks.left)
495 check_physnet("right", config.internal_networks.right)
496 if config.service_chain == ChainType.PVVP:
497 check_physnet("middle", config.internal_networks.middle)
499 # update the config in the config plugin as it might have changed
500 # in a copy of the dict (config plugin still holds the original dict)
501 config_plugin.set_config(config)
503 # add file log if requested
505 log.add_file_logger(config.log_file)
507 nfvbench = NFVBench(config, openstack_spec, config_plugin, factory)
510 if os.path.isdir(opts.server):
511 server = WebSocketIoServer(opts.server, nfvbench)
512 nfvbench.set_notifier(server)
514 port = int(opts.port)
516 server.run(host=opts.host)
518 server.run(host=opts.host, port=port)
520 print 'Invalid HTTP root directory: ' + opts.server
523 with utils.RunLock():
525 err_msg = 'Unknown options: ' + ' '.join(unknown_opts)
527 raise Exception(err_msg)
529 # remove unfilled values
530 opts = {k: v for k, v in vars(opts).iteritems() if v is not None}
531 result = nfvbench.run(opts)
532 if 'error_message' in result:
533 raise Exception(result['error_message'])
535 if 'result' in result and result['status']:
536 nfvbench.save(result['result'])
537 nfvbench.print_summary(result['result'])
538 except Exception as exc:
540 'status': NFVBench.STATUS_ERROR,
541 'error_message': traceback.format_exc()
546 if __name__ == '__main__':