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
26 from attrdict import AttrDict
28 from pkg_resources import resource_string
30 from .__init__ import __version__
31 from .chain_runner import ChainRunner
32 from .cleanup import Cleaner
33 from .config import config_load
34 from .config import config_loads
35 from . import credentials
36 from .fluentd import FluentLogHandler
39 from .nfvbenchd import WebServer
40 from .specs import ChainType
41 from .specs import Specs
42 from .summarizer import NFVBenchSummarizer
48 class NFVBench(object):
49 """Main class of NFV benchmarking tool."""
52 STATUS_ERROR = 'ERROR'
54 def __init__(self, config, openstack_spec, config_plugin, factory, notifier=None):
55 # the base config never changes for a given NFVbench instance
56 self.base_config = config
57 # this is the running config, updated at every run()
59 self.config_plugin = config_plugin
60 self.factory = factory
61 self.notifier = notifier
62 self.cred = credentials.Credentials(config.openrc_file, None, False) \
63 if config.openrc_file else None
64 self.chain_runner = None
66 self.specs.set_openstack_spec(openstack_spec)
70 def set_notifier(self, notifier):
71 self.notifier = notifier
73 def run(self, opts, args):
74 """This run() method is called for every NFVbench benchmark request.
76 In CLI mode, this method is called only once per invocation.
77 In REST server mode, this is called once per REST POST request
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()
88 # recalc the running config based on the base config and options for this run
89 self._update_config(opts)
90 if int(self.config.cache_size) < 0:
91 self.config.cache_size = self.config.flow_count
92 # check that an empty openrc file (no OpenStack) is only allowed
94 if not self.config.openrc_file and self.config.service_chain != ChainType.EXT:
95 raise Exception("openrc_file in the configuration is required for PVP/PVVP chains")
97 self.specs.set_run_spec(self.config_plugin.get_run_spec(self.config,
98 self.specs.openstack))
99 self.chain_runner = ChainRunner(self.config,
105 # make sure that the min frame size is 64
107 for frame_size in self.config.frame_sizes:
109 if int(frame_size) < min_packet_size:
110 frame_size = str(min_packet_size)
111 LOG.info("Adjusting frame size %s bytes to minimum size %s bytes",
112 frame_size, min_packet_size)
113 if frame_size not in new_frame_sizes:
114 new_frame_sizes.append(frame_size)
116 new_frame_sizes.append(frame_size.upper())
117 self.config.frame_sizes = new_frame_sizes
119 "date": datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
120 "nfvbench_version": __version__,
121 "config": self.config_plugin.prepare_results_config(copy.deepcopy(self.config)),
124 "service_chain": self.chain_runner.run(),
125 "versions": self.chain_runner.get_version(),
129 if self.specs.openstack:
130 result['openstack_spec'] = {"vswitch": self.specs.openstack.vswitch,
131 "encaps": self.specs.openstack.encaps}
132 result['benchmarks']['network']['versions'].update(self.config_plugin.get_version())
134 status = NFVBench.STATUS_ERROR
135 message = traceback.format_exc()
136 except KeyboardInterrupt:
137 status = NFVBench.STATUS_ERROR
138 message = traceback.format_exc()
140 if self.chain_runner:
141 self.chain_runner.close()
143 if status == NFVBench.STATUS_OK:
144 # result2 = utils.dict_to_json_dict(result)
151 'error_message': message
154 def prepare_summary(self, result):
155 """Prepare summary of the result to print and send it to logger (eg: fluentd)."""
157 summary = NFVBenchSummarizer(result, fluent_logger)
158 LOG.info(str(summary))
160 def save(self, result):
161 """Save results in json format file."""
162 utils.save_json_result(result,
163 self.config.json_file,
164 self.config.std_json_path,
165 self.config.service_chain,
166 self.config.service_chain_count,
167 self.config.flow_count,
168 self.config.frame_sizes)
170 def _update_config(self, opts):
171 """Recalculate the running config based on the base config and opts.
173 Sanity check on the config is done here as well.
175 self.config = AttrDict(dict(self.base_config))
176 self.config.update(opts)
179 config.service_chain = config.service_chain.upper()
180 config.service_chain_count = int(config.service_chain_count)
181 if config.l2_loopback:
182 # force the number of chains to be 1 in case of l2 loopback
183 config.service_chain_count = 1
184 config.service_chain = ChainType.EXT
186 LOG.info('Running L2 loopback: using EXT chain/no ARP')
187 config.flow_count = utils.parse_flow_count(config.flow_count)
188 required_flow_count = config.service_chain_count * 2
189 if config.flow_count < required_flow_count:
190 LOG.info("Flow count %d has been set to minimum value of '%d' "
191 "for current configuration", config.flow_count,
193 config.flow_count = required_flow_count
195 if config.flow_count % 2:
196 config.flow_count += 1
198 config.duration_sec = float(config.duration_sec)
199 config.interval_sec = float(config.interval_sec)
200 config.pause_sec = float(config.pause_sec)
202 if config.traffic is None or not config.traffic:
203 raise Exception("Missing traffic property in configuration")
205 if config.openrc_file:
206 config.openrc_file = os.path.expanduser(config.openrc_file)
207 if config.flavor.vcpus < 2:
208 raise Exception("Flavor vcpus must be >= 2")
211 config.ndr_run = (not config.no_traffic and
212 'ndr' in config.rate.strip().lower().split('_'))
213 config.pdr_run = (not config.no_traffic and
214 'pdr' in config.rate.strip().lower().split('_'))
215 config.single_run = (not config.no_traffic and
216 not (config.ndr_run or config.pdr_run))
218 config.json_file = config.json if config.json else None
220 (path, _filename) = os.path.split(config.json)
221 if not os.path.exists(path):
222 raise Exception('Please provide existing path for storing results in JSON file. '
223 'Path used: {path}'.format(path=path))
225 config.std_json_path = config.std_json if config.std_json else None
226 if config.std_json_path:
227 if not os.path.exists(config.std_json):
228 raise Exception('Please provide existing path for storing results in JSON file. '
229 'Path used: {path}'.format(path=config.std_json_path))
231 # Check that multiqueue is between 1 and 8 (8 is the max allowed by libvirt/qemu)
232 if config.vif_multiqueue_size < 1 or config.vif_multiqueue_size > 8:
233 raise Exception('vif_multiqueue_size (%d) must be in [1..8]' %
234 config.vif_multiqueue_size)
236 # VxLAN sanity checks
238 if config.vlan_tagging:
239 config.vlan_tagging = False
240 LOG.info('VxLAN: vlan_tagging forced to False '
241 '(inner VLAN tagging must be disabled)')
243 self.config_plugin.validate_config(config, self.specs.openstack)
246 def _parse_opts_from_cli():
247 parser = argparse.ArgumentParser()
249 parser.add_argument('--status', dest='status',
252 help='Provide NFVbench status')
254 parser.add_argument('-c', '--config', dest='config',
256 help='Override default values with a config file or '
257 'a yaml/json config string',
258 metavar='<file_name_or_yaml>')
260 parser.add_argument('--server', dest='server',
263 help='Run nfvbench in server mode')
265 parser.add_argument('--host', dest='host',
268 help='Host IP address on which server will be listening (default 0.0.0.0)')
270 parser.add_argument('-p', '--port', dest='port',
273 help='Port on which server will be listening (default 7555)')
275 parser.add_argument('-sc', '--service-chain', dest='service_chain',
276 choices=ChainType.names,
278 help='Service chain to run')
280 parser.add_argument('-scc', '--service-chain-count', dest='service_chain_count',
282 help='Set number of service chains to run',
283 metavar='<service_chain_count>')
285 parser.add_argument('-fc', '--flow-count', dest='flow_count',
287 help='Set number of total flows for all chains and all directions',
288 metavar='<flow_count>')
290 parser.add_argument('--rate', dest='rate',
292 help='Specify rate in pps, bps or %% as total for all directions',
295 parser.add_argument('--duration', dest='duration_sec',
297 help='Set duration to run traffic generator (in seconds)',
298 metavar='<duration_sec>')
300 parser.add_argument('--interval', dest='interval_sec',
302 help='Set interval to record traffic generator stats (in seconds)',
303 metavar='<interval_sec>')
305 parser.add_argument('--inter-node', dest='inter_node',
310 parser.add_argument('--sriov', dest='sriov',
313 help='Use SRIOV (no vswitch - requires SRIOV support in compute nodes)')
315 parser.add_argument('--use-sriov-middle-net', dest='use_sriov_middle_net',
318 help='Use SRIOV to handle the middle network traffic '
319 '(PVVP with SRIOV only)')
321 parser.add_argument('-d', '--debug', dest='debug',
324 help='print debug messages (verbose)')
326 parser.add_argument('-g', '--traffic-gen', dest='generator_profile',
328 help='Traffic generator profile to use')
330 parser.add_argument('-l3', '--l3-router', dest='l3_router',
333 help='Use L3 neutron routers to handle traffic')
335 parser.add_argument('-0', '--no-traffic', dest='no_traffic',
338 help='Check config and connectivity only - do not generate traffic')
340 parser.add_argument('--no-arp', dest='no_arp',
343 help='Do not use ARP to find MAC addresses, '
344 'instead use values in config file')
346 parser.add_argument('--loop-vm-arp', dest='loop_vm_arp',
349 help='Use ARP to find MAC addresses '
350 'instead of using values from TRex ports (VPP forwarder only)')
352 parser.add_argument('--no-vswitch-access', dest='no_vswitch_access',
355 help='Skip vswitch configuration and retrieving of stats')
357 parser.add_argument('--vxlan', dest='vxlan',
360 help='Enable VxLan encapsulation')
362 parser.add_argument('--no-cleanup', dest='no_cleanup',
365 help='no cleanup after run')
367 parser.add_argument('--cleanup', dest='cleanup',
370 help='Cleanup NFVbench resources (prompt to confirm)')
372 parser.add_argument('--force-cleanup', dest='force_cleanup',
375 help='Cleanup NFVbench resources (do not prompt)')
377 parser.add_argument('--restart', dest='restart',
380 help='Restart TRex server')
382 parser.add_argument('--json', dest='json',
384 help='store results in json format file',
385 metavar='<path>/<filename>')
387 parser.add_argument('--std-json', dest='std_json',
389 help='store results in json format file with nfvbench standard filename: '
390 '<service-chain-type>-<service-chain-count>-<flow-count>'
391 '-<packet-sizes>.json',
394 parser.add_argument('--show-default-config', dest='show_default_config',
397 help='print the default config in yaml format (unedited)')
399 parser.add_argument('--show-config', dest='show_config',
402 help='print the running config in json format')
404 parser.add_argument('-ss', '--show-summary', dest='summary',
406 help='Show summary from nfvbench json file',
409 parser.add_argument('-v', '--version', dest='version',
414 parser.add_argument('-fs', '--frame-size', dest='frame_sizes',
416 help='Override traffic profile frame sizes',
417 metavar='<frame_size_bytes or IMIX>')
419 parser.add_argument('--unidir', dest='unidir',
422 help='Override traffic profile direction (requires -fs)')
424 parser.add_argument('--log-file', '--logfile', dest='log_file',
426 help='Filename for saving logs',
427 metavar='<log_file>')
429 parser.add_argument('--user-label', '--userlabel', dest='user_label',
431 help='Custom label for performance records')
433 parser.add_argument('--hypervisor', dest='hypervisor',
435 metavar='<hypervisor name>',
436 help='Where chains must run ("compute", "az:", "az:compute")')
438 parser.add_argument('--l2-loopback', '--l2loopback', dest='l2_loopback',
441 help='Port to port or port to switch to port L2 loopback with VLAN id')
443 parser.add_argument('--cache-size', dest='cache_size',
446 help='Specify the FE cache size (default: 0, flow-count if < 0)')
448 parser.add_argument('--service-mode', dest='service_mode',
451 help='Enable T-Rex service mode for debugging only')
453 parser.add_argument('--no-flow-stats', dest='no_flow_stats',
456 help='Disable extra flow stats (on high load traffic)')
458 parser.add_argument('--no-latency-stats', dest='no_latency_stats',
461 help='Disable flow stats for latency traffic')
463 parser.add_argument('--no-latency-streams', dest='no_latency_streams',
466 help='Disable latency measurements (no streams)')
468 opts, unknown_opts = parser.parse_known_args()
469 return opts, unknown_opts
472 def load_default_config():
473 default_cfg = resource_string(__name__, "cfg.default.yaml")
474 config = config_loads(default_cfg)
475 config.name = '(built-in default config)'
476 return config, default_cfg
479 def override_custom_traffic(config, frame_sizes, unidir):
480 """Override the traffic profiles with a custom one."""
481 if frame_sizes is not None:
482 traffic_profile_name = "custom_traffic_profile"
483 config.traffic_profile = [
485 "l2frame_size": frame_sizes,
486 "name": traffic_profile_name
490 traffic_profile_name = config.traffic["profile"]
492 bidirectional = config.traffic['bidirectional'] if unidir is None else not unidir
494 "bidirectional": bidirectional,
495 "profile": traffic_profile_name
499 def check_physnet(name, netattrs):
500 if not netattrs.physical_network:
501 raise Exception("SRIOV requires physical_network to be specified for the {n} network"
503 if not netattrs.segmentation_id:
504 raise Exception("SRIOV requires segmentation_id to be specified for the {n} network"
507 def status_cleanup(config, cleanup, force_cleanup):
508 LOG.info('Version: %s', pbr.version.VersionInfo('nfvbench').version_string_with_vcs())
509 # check if another run is pending
512 with utils.RunLock():
513 LOG.info('Status: idle')
515 LOG.info('Status: busy (run pending)')
517 # check nfvbench resources
518 if config.openrc_file and config.service_chain != ChainType.EXT:
519 cleaner = Cleaner(config)
520 count = cleaner.show_resources()
521 if count and (cleanup or force_cleanup):
522 cleaner.clean(not force_cleanup)
527 run_summary_required = False
530 # load default config file
531 config, default_cfg = load_default_config()
532 # create factory for platform specific classes
534 factory_module = importlib.import_module(config['factory_module'])
535 factory = getattr(factory_module, config['factory_class'])()
536 except AttributeError:
537 raise Exception("Requested factory module '{m}' or class '{c}' was not found."
538 .format(m=config['factory_module'], c=config['factory_class']))
539 # create config plugin for this platform
540 config_plugin = factory.get_config_plugin_class()(config)
541 config = config_plugin.get_config()
543 opts, unknown_opts = _parse_opts_from_cli()
544 log.set_level(debug=opts.debug)
547 print((pbr.version.VersionInfo('nfvbench').version_string_with_vcs()))
551 with open(opts.summary) as json_data:
552 result = json.load(json_data)
554 result['config']['user_label'] = opts.user_label
555 print((NFVBenchSummarizer(result, fluent_logger)))
558 # show default config in text/yaml format
559 if opts.show_default_config:
560 print((default_cfg.decode("utf-8")))
565 # do not check extra_specs in flavor as it can contain any key/value pairs
566 whitelist_keys = ['extra_specs']
567 # override default config options with start config at path parsed from CLI
568 # check if it is an inline yaml/json config or a file name
569 if os.path.isfile(opts.config):
570 LOG.info('Loading configuration file: %s', opts.config)
571 config = config_load(opts.config, config, whitelist_keys)
572 config.name = os.path.basename(opts.config)
574 LOG.info('Loading configuration string: %s', opts.config)
575 config = config_loads(opts.config, config, whitelist_keys)
577 # setup the fluent logger as soon as possible right after the config plugin is called,
578 # if there is any logging or result tag is set then initialize the fluent logger
579 for fluentd in config.fluentd:
580 if fluentd.logging_tag or fluentd.result_tag:
581 fluent_logger = FluentLogHandler(config.fluentd)
582 LOG.addHandler(fluent_logger)
585 # traffic profile override options
586 override_custom_traffic(config, opts.frame_sizes, opts.unidir)
588 # copy over cli options that are used in config
589 config.generator_profile = opts.generator_profile
593 config.log_file = opts.log_file
594 if opts.service_chain:
595 config.service_chain = opts.service_chain
596 if opts.service_chain_count:
597 config.service_chain_count = opts.service_chain_count
598 if opts.no_vswitch_access:
599 config.no_vswitch_access = opts.no_vswitch_access
601 # can be any of 'comp1', 'nova:', 'nova:comp1'
602 config.compute_nodes = opts.hypervisor
606 config.restart = True
607 if opts.service_mode:
608 config.service_mode = True
609 if opts.no_flow_stats:
610 config.no_flow_stats = True
611 if opts.no_latency_stats:
612 config.no_latency_stats = True
613 if opts.no_latency_streams:
614 config.no_latency_streams = True
615 # port to port loopback (direct or through switch)
617 config.l2_loopback = True
618 if config.service_chain != ChainType.EXT:
619 LOG.info('Changing service chain type to EXT')
620 config.service_chain = ChainType.EXT
621 if not config.no_arp:
622 LOG.info('Disabling ARP')
624 config.vlans = [int(opts.l2_loopback), int(opts.l2_loopback)]
625 LOG.info('Running L2 loopback: using EXT chain/no ARP')
627 if opts.use_sriov_middle_net:
628 if (not config.sriov) or (config.service_chain != ChainType.PVVP):
629 raise Exception("--use-sriov-middle-net is only valid for PVVP with SRIOV")
630 config.use_sriov_middle_net = True
632 if config.sriov and config.service_chain != ChainType.EXT:
633 # if sriov is requested (does not apply to ext chains)
634 # make sure the physnet names are specified
635 check_physnet("left", config.internal_networks.left)
636 check_physnet("right", config.internal_networks.right)
637 if config.service_chain == ChainType.PVVP and config.use_sriov_middle_net:
638 check_physnet("middle", config.internal_networks.middle)
640 # show running config in json format
642 print((json.dumps(config, sort_keys=True, indent=4)))
645 # update the config in the config plugin as it might have changed
646 # in a copy of the dict (config plugin still holds the original dict)
647 config_plugin.set_config(config)
649 if opts.status or opts.cleanup or opts.force_cleanup:
650 status_cleanup(config, opts.cleanup, opts.force_cleanup)
652 # add file log if requested
654 log.add_file_logger(config.log_file)
656 openstack_spec = config_plugin.get_openstack_spec() if config.openrc_file \
659 nfvbench_instance = NFVBench(config, openstack_spec, config_plugin, factory)
662 server = WebServer(nfvbench_instance, fluent_logger)
664 port = int(opts.port)
666 server.run(host=opts.host)
668 server.run(host=opts.host, port=port)
669 # server.run() should never return
671 with utils.RunLock():
672 run_summary_required = True
674 err_msg = 'Unknown options: ' + ' '.join(unknown_opts)
676 raise Exception(err_msg)
678 # remove unfilled values
679 opts = {k: v for k, v in list(vars(opts).items()) if v is not None}
681 params = ' '.join(str(e) for e in sys.argv[1:])
682 result = nfvbench_instance.run(opts, params)
683 if 'error_message' in result:
684 raise Exception(result['error_message'])
686 if 'result' in result and result['status']:
687 nfvbench_instance.save(result['result'])
688 nfvbench_instance.prepare_summary(result['result'])
689 except Exception as exc:
690 run_summary_required = True
692 'status': NFVBench.STATUS_ERROR,
693 'error_message': traceback.format_exc()
698 # only send a summary record if there was an actual nfvbench run or
699 # if an error/exception was logged.
700 fluent_logger.send_run_summary(run_summary_required)
703 if __name__ == '__main__':