X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=nfvbench%2Fnfvbench.py;h=a178d248cdbe4ddc3fe9c4eaa8649ae38ca72f19;hb=bd0cf4ce9c30c8aae9b7a96cf9c8ea073cd9a548;hp=f06c593dc78e1ba185fcae13596cc550a8a42d83;hpb=8b1b3e5c7fb91f450b2abe4a8201bcfec14b2bb9;p=nfvbench.git diff --git a/nfvbench/nfvbench.py b/nfvbench/nfvbench.py index f06c593..a178d24 100644 --- a/nfvbench/nfvbench.py +++ b/nfvbench/nfvbench.py @@ -24,23 +24,24 @@ import sys import traceback from attrdict import AttrDict +from logging import FileHandler import pbr.version from pkg_resources import resource_string -from __init__ import __version__ -from chain_runner import ChainRunner -from cleanup import Cleaner -from config import config_load -from config import config_loads -import credentials as credentials -from fluentd import FluentLogHandler -import log -from log import LOG -from nfvbenchd import WebSocketIoServer -from specs import ChainType -from specs import Specs -from summarizer import NFVBenchSummarizer -import utils +from .__init__ import __version__ +from .chain_runner import ChainRunner +from .cleanup import Cleaner +from .config import config_load +from .config import config_loads +from . import credentials +from .fluentd import FluentLogHandler +from . import log +from .log import LOG +from .nfvbenchd import WebServer +from .specs import ChainType +from .specs import Specs +from .summarizer import NFVBenchSummarizer +from . import utils fluent_logger = None @@ -66,21 +67,16 @@ class NFVBench(object): self.specs.set_openstack_spec(openstack_spec) self.vni_ports = [] sys.stdout.flush() - self.check_options() - - def check_options(self): - if self.base_config.vxlan: - if self.base_config.vlan_tagging: - raise Exception( - 'Inner VLAN tagging is not currently supported for VXLAN') - vtep_vlan = self.base_config.traffic_generator.get('vtep_vlan') - if vtep_vlan is None: - LOG.warning('Warning: VXLAN mode enabled, but VTEP vlan is not defined') def set_notifier(self, notifier): self.notifier = notifier def run(self, opts, args): + """This run() method is called for every NFVbench benchmark request. + + In CLI mode, this method is called only once per invocation. + In REST server mode, this is called once per REST POST request + """ status = NFVBench.STATUS_OK result = None message = '' @@ -92,6 +88,12 @@ class NFVBench(object): try: # recalc the running config based on the base config and options for this run self._update_config(opts) + + # check that an empty openrc file (no OpenStack) is only allowed + # with EXT chain + if not self.config.openrc_file and self.config.service_chain != ChainType.EXT: + raise Exception("openrc_file in the configuration is required for PVP/PVVP chains") + self.specs.set_run_spec(self.config_plugin.get_run_spec(self.config, self.specs.openstack)) self.chain_runner = ChainRunner(self.config, @@ -163,7 +165,9 @@ class NFVBench(object): self.config.service_chain, self.config.service_chain_count, self.config.flow_count, - self.config.frame_sizes) + self.config.frame_sizes, + self.config.user_id, + self.config.group_id) def _update_config(self, opts): """Recalculate the running config based on the base config and opts. @@ -171,6 +175,24 @@ class NFVBench(object): Sanity check on the config is done here as well. """ self.config = AttrDict(dict(self.base_config)) + # Update log file handler if needed after a config update (REST mode) + if 'log_file' in opts: + if opts['log_file']: + (path, _filename) = os.path.split(opts['log_file']) + if not os.path.exists(path): + LOG.warning( + 'Path %s does not exist. Please verify root path is shared with host. Path ' + 'will be created.', path) + os.makedirs(path) + LOG.info('%s is created.', path) + for h in log.getLogger().handlers: + if isinstance(h, FileHandler) and h.baseFilename != opts['log_file']: + # clean log file handler + log.getLogger().removeHandler(h) + # add handler if not existing to avoid duplicates handlers + if len(log.getLogger().handlers) == 1: + log.add_file_logger(opts['log_file']) + self.config.update(opts) config = self.config @@ -182,6 +204,15 @@ class NFVBench(object): config.service_chain = ChainType.EXT config.no_arp = True LOG.info('Running L2 loopback: using EXT chain/no ARP') + + # traffic profile override options + if 'frame_sizes' in opts: + unidir = False + if 'unidir' in opts: + unidir = opts['unidir'] + override_custom_traffic(config, opts['frame_sizes'], unidir) + LOG.info("Frame size has been set to %s for current configuration", opts['frame_sizes']) + config.flow_count = utils.parse_flow_count(config.flow_count) required_flow_count = config.service_chain_count * 2 if config.flow_count < required_flow_count: @@ -193,6 +224,14 @@ class NFVBench(object): if config.flow_count % 2: config.flow_count += 1 + # Possibly adjust the cache size + if config.cache_size < 0: + config.cache_size = config.flow_count + + # The size must be capped to 10000 (where does this limit come from?) + if config.cache_size > 10000: + config.cache_size = 10000 + config.duration_sec = float(config.duration_sec) config.interval_sec = float(config.interval_sec) config.pause_sec = float(config.pause_sec) @@ -202,6 +241,8 @@ class NFVBench(object): if config.openrc_file: config.openrc_file = os.path.expanduser(config.openrc_file) + if config.flavor.vcpus < 2: + raise Exception("Flavor vcpus must be >= 2") config.ndr_run = (not config.no_traffic and 'ndr' in config.rate.strip().lower().split('_')) @@ -223,9 +264,41 @@ class NFVBench(object): raise Exception('Please provide existing path for storing results in JSON file. ' 'Path used: {path}'.format(path=config.std_json_path)) + # Check that multiqueue is between 1 and 8 (8 is the max allowed by libvirt/qemu) + if config.vif_multiqueue_size < 1 or config.vif_multiqueue_size > 8: + raise Exception('vif_multiqueue_size (%d) must be in [1..8]' % + config.vif_multiqueue_size) + + # VxLAN and MPLS sanity checks + if config.vxlan or config.mpls: + if config.vlan_tagging: + config.vlan_tagging = False + config.no_latency_streams = True + config.no_latency_stats = True + config.no_flow_stats = True + LOG.info('VxLAN or MPLS: vlan_tagging forced to False ' + '(inner VLAN tagging must be disabled)') + self.config_plugin.validate_config(config, self.specs.openstack) +def bool_arg(x): + """Argument type to be used in parser.add_argument() + When a boolean like value is expected to be given + """ + return (str(x).lower() != 'false') \ + and (str(x).lower() != 'no') \ + and (str(x).lower() != '0') + + +def int_arg(x): + """Argument type to be used in parser.add_argument() + When an integer type value is expected to be given + (returns 0 if argument is invalid, hexa accepted) + """ + return int(x, 0) + + def _parse_opts_from_cli(): parser = argparse.ArgumentParser() @@ -242,10 +315,8 @@ def _parse_opts_from_cli(): parser.add_argument('--server', dest='server', default=None, - action='store', - metavar='', - help='Run nfvbench in server mode and pass' - ' the HTTP root folder full pathname') + action='store_true', + help='Run nfvbench in server mode') parser.add_argument('--host', dest='host', action='store', @@ -312,6 +383,11 @@ def _parse_opts_from_cli(): action='store', help='Traffic generator profile to use') + parser.add_argument('-l3', '--l3-router', dest='l3_router', + default=None, + action='store_true', + help='Use L3 neutron routers to handle traffic') + parser.add_argument('-0', '--no-traffic', dest='no_traffic', default=None, action='store_true', @@ -323,6 +399,12 @@ def _parse_opts_from_cli(): help='Do not use ARP to find MAC addresses, ' 'instead use values in config file') + parser.add_argument('--loop-vm-arp', dest='loop_vm_arp', + default=None, + action='store_true', + help='Use ARP to find MAC addresses ' + 'instead of using values from TRex ports (VPP forwarder only)') + parser.add_argument('--no-vswitch-access', dest='no_vswitch_access', default=None, action='store_true', @@ -333,6 +415,11 @@ def _parse_opts_from_cli(): action='store_true', help='Enable VxLan encapsulation') + parser.add_argument('--mpls', dest='mpls', + default=None, + action='store_true', + help='Enable MPLS encapsulation') + parser.add_argument('--no-cleanup', dest='no_cleanup', default=None, action='store_true', @@ -348,6 +435,11 @@ def _parse_opts_from_cli(): action='store_true', help='Cleanup NFVbench resources (do not prompt)') + parser.add_argument('--restart', dest='restart', + default=None, + action='store_true', + help='Restart TRex server') + parser.add_argument('--json', dest='json', action='store', help='store results in json format file', @@ -409,6 +501,98 @@ def _parse_opts_from_cli(): metavar='', help='Port to port or port to switch to port L2 loopback with VLAN id') + parser.add_argument('--user-info', dest='user_info', + action='store', + metavar='', + help='Custom data to be included as is ' + 'in the json report config branch - ' + ' example, pay attention! no space: ' + '--user-info=\'{"status":"explore","description":' + '{"target":"lab","ok":true,"version":2020}}\' - ' + 'this option may be repeated; given data will be merged.') + + parser.add_argument('--vlan-tagging', dest='vlan_tagging', + type=bool_arg, + metavar='', + action='store', + default=None, + help='Override the NFVbench \'vlan_tagging\' parameter') + + parser.add_argument('--intf-speed', dest='intf_speed', + metavar='', + action='store', + default=None, + help='Override the NFVbench \'intf_speed\' ' + 'parameter (e.g. 10Gbps, auto, 16.72Gbps)') + + parser.add_argument('--cores', dest='cores', + type=int_arg, + metavar='', + action='store', + default=None, + help='Override the T-Rex \'cores\' parameter') + + parser.add_argument('--cache-size', dest='cache_size', + type=int_arg, + metavar='', + action='store', + default='0', + help='Specify the FE cache size (default: 0, flow-count if < 0)') + + parser.add_argument('--service-mode', dest='service_mode', + action='store_true', + default=False, + help='Enable T-Rex service mode (for debugging purpose)') + + parser.add_argument('--no-e2e-check', dest='no_e2e_check', + action='store_true', + default=False, + help='Skip "end to end" connectivity check (on test purpose)') + + parser.add_argument('--no-flow-stats', dest='no_flow_stats', + action='store_true', + default=False, + help='Disable additional flow stats (on high load traffic)') + + parser.add_argument('--no-latency-stats', dest='no_latency_stats', + action='store_true', + default=False, + help='Disable flow stats for latency traffic') + + parser.add_argument('--no-latency-streams', dest='no_latency_streams', + action='store_true', + default=False, + help='Disable latency measurements (no streams)') + + parser.add_argument('--user-id', dest='user_id', + type=int_arg, + metavar='', + action='store', + default=None, + help='Change json/log files ownership with this user (int)') + + parser.add_argument('--group-id', dest='group_id', + type=int_arg, + metavar='', + action='store', + default=None, + help='Change json/log files ownership with this group (int)') + + parser.add_argument('--show-trex-log', dest='show_trex_log', + default=None, + action='store_true', + help='Show the current TRex local server log file contents' + ' => diagnostic/help in case of configuration problems') + + parser.add_argument('--debug-mask', dest='debug_mask', + type=int_arg, + metavar='', + action='store', + default=None, + help='General purpose register (debugging flags), ' + 'the hexadecimal notation (0x...) is accepted.' + 'Designed for development needs (default: 0).') + opts, unknown_opts = parser.parse_known_args() return opts, unknown_opts @@ -473,13 +657,20 @@ def main(): log.setup() # load default config file config, default_cfg = load_default_config() + # possibly override the default user_id & group_id values + if 'USER_ID' in os.environ: + config.user_id = int(os.environ['USER_ID']) + if 'GROUP_ID' in os.environ: + config.group_id = int(os.environ['GROUP_ID']) + # create factory for platform specific classes try: factory_module = importlib.import_module(config['factory_module']) factory = getattr(factory_module, config['factory_class'])() except AttributeError: raise Exception("Requested factory module '{m}' or class '{c}' was not found." - .format(m=config['factory_module'], c=config['factory_class'])) + .format(m=config['factory_module'], + c=config['factory_class'])) from AttributeError # create config plugin for this platform config_plugin = factory.get_config_plugin_class()(config) config = config_plugin.get_config() @@ -488,7 +679,7 @@ def main(): log.set_level(debug=opts.debug) if opts.version: - print pbr.version.VersionInfo('nfvbench').version_string_with_vcs() + print((pbr.version.VersionInfo('nfvbench').version_string_with_vcs())) sys.exit(0) if opts.summary: @@ -496,18 +687,27 @@ def main(): result = json.load(json_data) if opts.user_label: result['config']['user_label'] = opts.user_label - print NFVBenchSummarizer(result, fluent_logger) + print((NFVBenchSummarizer(result, fluent_logger))) sys.exit(0) # show default config in text/yaml format if opts.show_default_config: - print default_cfg + print((default_cfg.decode("utf-8"))) + sys.exit(0) + + # dump the contents of the trex log file + if opts.show_trex_log: + try: + print(open('/tmp/trex.log').read(), end="") + except FileNotFoundError: + print("No TRex log file found!") sys.exit(0) config.name = '' if opts.config: # do not check extra_specs in flavor as it can contain any key/value pairs - whitelist_keys = ['extra_specs'] + # the same principle applies also to the optional user_info open property + whitelist_keys = ['extra_specs', 'user_info'] # override default config options with start config at path parsed from CLI # check if it is an inline yaml/json config or a file name if os.path.isfile(opts.config): @@ -526,6 +726,17 @@ def main(): LOG.addHandler(fluent_logger) break + # convert 'user_info' opt from json string to dictionnary + # and merge the result with the current config dictionnary + if opts.user_info: + opts.user_info = json.loads(opts.user_info) + if config.user_info: + config.user_info = config.user_info + opts.user_info + else: + config.user_info = opts.user_info + # hide the option to further _update_config() + opts.user_info = None + # traffic profile override options override_custom_traffic(config, opts.frame_sizes, opts.unidir) @@ -544,7 +755,20 @@ def main(): if opts.hypervisor: # can be any of 'comp1', 'nova:', 'nova:comp1' config.compute_nodes = opts.hypervisor - + if opts.vxlan: + config.vxlan = True + if opts.mpls: + config.mpls = True + if opts.restart: + config.restart = True + if opts.service_mode: + config.service_mode = True + if opts.no_flow_stats: + config.no_flow_stats = True + if opts.no_latency_stats: + config.no_latency_stats = True + if opts.no_latency_streams: + config.no_latency_streams = True # port to port loopback (direct or through switch) if opts.l2_loopback: config.l2_loopback = True @@ -572,17 +796,9 @@ def main(): # show running config in json format if opts.show_config: - print json.dumps(config, sort_keys=True, indent=4) + print((json.dumps(config, sort_keys=True, indent=4))) sys.exit(0) - # check that an empty openrc file (no OpenStack) is only allowed - # with EXT chain - if not config.openrc_file: - if config.service_chain == ChainType.EXT: - LOG.info('EXT chain with OpenStack mode disabled') - else: - raise Exception("openrc_file is empty in the configuration and is required") - # update the config in the config plugin as it might have changed # in a copy of the dict (config plugin still holds the original dict) config_plugin.set_config(config) @@ -593,6 +809,13 @@ def main(): # add file log if requested if config.log_file: log.add_file_logger(config.log_file) + # possibly change file ownership + uid = config.user_id + gid = config.group_id + if gid is None: + gid = uid + if uid is not None: + os.chown(config.log_file, uid, gid) openstack_spec = config_plugin.get_openstack_spec() if config.openrc_file \ else None @@ -600,18 +823,14 @@ def main(): nfvbench_instance = NFVBench(config, openstack_spec, config_plugin, factory) if opts.server: - if os.path.isdir(opts.server): - server = WebSocketIoServer(opts.server, nfvbench_instance, fluent_logger) - nfvbench_instance.set_notifier(server) - try: - port = int(opts.port) - except ValueError: - server.run(host=opts.host) - else: - server.run(host=opts.host, port=port) + server = WebServer(nfvbench_instance, fluent_logger) + try: + port = int(opts.port) + except ValueError: + server.run(host=opts.host) else: - print 'Invalid HTTP root directory: ' + opts.server - sys.exit(1) + server.run(host=opts.host, port=port) + # server.run() should never return else: with utils.RunLock(): run_summary_required = True @@ -621,7 +840,7 @@ def main(): raise Exception(err_msg) # remove unfilled values - opts = {k: v for k, v in vars(opts).iteritems() if v is not None} + opts = {k: v for k, v in list(vars(opts).items()) if v is not None} # get CLI args params = ' '.join(str(e) for e in sys.argv[1:]) result = nfvbench_instance.run(opts, params) @@ -637,7 +856,7 @@ def main(): 'status': NFVBench.STATUS_ERROR, 'error_message': traceback.format_exc() }) - print str(exc) + print((str(exc))) finally: if fluent_logger: # only send a summary record if there was an actual nfvbench run or