NFVBENCH-85 Add option to verify L2 loopback at TOR switch
[nfvbench.git] / nfvbench / nfvbench.py
index 8c88248..1cb5a9c 100644 (file)
@@ -30,6 +30,7 @@ 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
@@ -49,6 +50,7 @@ fluent_logger = None
 
 class NFVBench(object):
     """Main class of NFV benchmarking tool."""
+
     STATUS_OK = 'OK'
     STATUS_ERROR = 'ERROR'
 
@@ -68,7 +70,7 @@ class NFVBench(object):
         sys.stdout.flush()
 
     def setup(self):
-        self.specs.set_run_spec(self.config_plugin.get_run_spec(self.specs.openstack))
+        self.specs.set_run_spec(self.config_plugin.get_run_spec(self.config, self.specs.openstack))
         self.chain_runner = ChainRunner(self.config,
                                         self.clients,
                                         self.cred,
@@ -91,7 +93,19 @@ class NFVBench(object):
         try:
             self.update_config(opts)
             self.setup()
-
+            new_frame_sizes = []
+            min_packet_size = "68" if self.config.vlan_tagging else "64"
+            for frame_size in self.config.frame_sizes:
+                try:
+                    if int(frame_size) < int(min_packet_size):
+                        new_frame_sizes.append(min_packet_size)
+                        LOG.info("Adjusting frame size %s Bytes to minimum size %s Bytes due to " +
+                                 "traffic generator restriction", frame_size, min_packet_size)
+                    else:
+                        new_frame_sizes.append(frame_size)
+                except ValueError:
+                    new_frame_sizes.append(frame_size)
+            self.config.actual_frame_sizes = tuple(new_frame_sizes)
             result = {
                 "date": datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
                 "nfvbench_version": __version__,
@@ -129,7 +143,7 @@ class NFVBench(object):
         }
 
     def prepare_summary(self, result):
-        """Prepares summary of the result to print and send it to logger (eg: fluentd)"""
+        """Prepare summary of the result to print and send it to logger (eg: fluentd)."""
         global fluent_logger
         summary = NFVBenchSummarizer(result, fluent_logger)
         LOG.info(str(summary))
@@ -172,6 +186,25 @@ class NFVBench(object):
         self.config.generator_config = \
             generator_factory.get_generator_config(self.config.generator_profile)
 
+        # Check length of mac_addrs_left/right for serivce_chain EXT with no_arp
+        if self.config.service_chain == ChainType.EXT and self.config.no_arp:
+            if not (self.config.generator_config.mac_addrs_left is None and
+                    self.config.generator_config.mac_addrs_right is None):
+                if (self.config.generator_config.mac_addrs_left is None or
+                        self.config.generator_config.mac_addrs_right is None):
+                    raise Exception("mac_addrs_left and mac_addrs_right must either "
+                                    "both be None or have a number of entries matching "
+                                    "service_chain_count")
+                if not (len(self.config.generator_config.mac_addrs_left) ==
+                        self.config.service_chain_count and
+                        len(self.config.generator_config.mac_addrs_right) ==
+                        self.config.service_chain_count):
+                    raise Exception("length of mac_addrs_left ({a}) and/or mac_addrs_right ({b}) "
+                                    "does not match service_chain_count ({c})"
+                                    .format(a=len(self.config.generator_config.mac_addrs_left),
+                                            b=len(self.config.generator_config.mac_addrs_right),
+                                            c=self.config.service_chain_count))
+
         if not any(self.config.generator_config.pcis):
             raise Exception("PCI addresses configuration for selected traffic generator profile "
                             "({tg_profile}) are missing. Please specify them in configuration file."
@@ -192,12 +225,12 @@ class NFVBench(object):
         if self.config.openrc_file:
             self.config.openrc_file = os.path.expanduser(self.config.openrc_file)
 
-        self.config.ndr_run = (not self.config.no_traffic
-                               and 'ndr' in self.config.rate.strip().lower().split('_'))
-        self.config.pdr_run = (not self.config.no_traffic
-                               and 'pdr' in self.config.rate.strip().lower().split('_'))
-        self.config.single_run = (not self.config.no_traffic
-                                  and not (self.config.ndr_run or self.config.pdr_run))
+        self.config.ndr_run = (not self.config.no_traffic and
+                               'ndr' in self.config.rate.strip().lower().split('_'))
+        self.config.pdr_run = (not self.config.no_traffic and
+                               'pdr' in self.config.rate.strip().lower().split('_'))
+        self.config.single_run = (not self.config.no_traffic and
+                                  not (self.config.ndr_run or self.config.pdr_run))
 
         if self.config.vlans and len(self.config.vlans) != 2:
             raise Exception('Number of configured VLAN IDs for VLAN tagging must be exactly 2.')
@@ -221,6 +254,11 @@ class NFVBench(object):
 def parse_opts_from_cli():
     parser = argparse.ArgumentParser()
 
+    parser.add_argument('--status', dest='status',
+                        action='store_true',
+                        default=None,
+                        help='Provide NFVbench status')
+
     parser.add_argument('-c', '--config', dest='config',
                         action='store',
                         help='Override default values with a config file or '
@@ -335,6 +373,16 @@ def parse_opts_from_cli():
                         action='store_true',
                         help='no cleanup after run')
 
+    parser.add_argument('--cleanup', dest='cleanup',
+                        default=None,
+                        action='store_true',
+                        help='Cleanup NFVbench resources (prompt to confirm)')
+
+    parser.add_argument('--force-cleanup', dest='force_cleanup',
+                        default=None,
+                        action='store_true',
+                        help='Cleanup NFVbench resources (do not prompt)')
+
     parser.add_argument('--json', dest='json',
                         action='store',
                         help='store results in json format file',
@@ -386,6 +434,11 @@ def parse_opts_from_cli():
                         action='store',
                         help='Custom label for performance records')
 
+    parser.add_argument('--l2-loopback', '--l2loopback', dest='l2_loopback',
+                        action='store',
+                        metavar='<vlan>',
+                        help='Port to port or port to switch to port L2 loopback with VLAN id')
+
     opts, unknown_opts = parser.parse_known_args()
     return opts, unknown_opts
 
@@ -398,8 +451,7 @@ def load_default_config():
 
 
 def override_custom_traffic(config, frame_sizes, unidir):
-    """Override the traffic profiles with a custom one
-    """
+    """Override the traffic profiles with a custom one."""
     if frame_sizes is not None:
         traffic_profile_name = "custom_traffic_profile"
         config.traffic_profile = [
@@ -426,6 +478,23 @@ def check_physnet(name, netattrs):
         raise Exception("SRIOV requires segmentation_id to be specified for the {n} network"
                         .format(n=name))
 
+def status_cleanup(config, cleanup, force_cleanup):
+    LOG.info('Version: %s', pbr.version.VersionInfo('nfvbench').version_string_with_vcs())
+    # check if another run is pending
+    ret_code = 0
+    try:
+        with utils.RunLock():
+            LOG.info('Status: idle')
+    except Exception:
+        LOG.info('Status: busy (run pending)')
+        ret_code = 1
+    # check nfvbench resources
+    if config.openrc_file and config.service_chain != ChainType.EXT:
+        cleaner = Cleaner(config)
+        count = cleaner.show_resources()
+        if count and (cleanup or force_cleanup):
+            cleaner.clean(not force_cleanup)
+    sys.exit(ret_code)
 
 def main():
     global fluent_logger
@@ -448,14 +517,6 @@ def main():
         opts, unknown_opts = parse_opts_from_cli()
         log.set_level(debug=opts.debug)
 
-        # setup the fluent logger as soon as possible right after the config plugin is called,
-        # if there is any logging or result tag is set then initialize the fluent logger
-        for fluentd in config.fluentd:
-            if fluentd.logging_tag or fluentd.result_tag:
-                fluent_logger = FluentLogHandler(config.fluentd)
-                LOG.addHandler(fluent_logger)
-                break
-
         if opts.version:
             print pbr.version.VersionInfo('nfvbench').version_string_with_vcs()
             sys.exit(0)
@@ -487,6 +548,14 @@ def main():
                 LOG.info('Loading configuration string: %s', opts.config)
                 config = config_loads(opts.config, config, whitelist_keys)
 
+        # setup the fluent logger as soon as possible right after the config plugin is called,
+        # if there is any logging or result tag is set then initialize the fluent logger
+        for fluentd in config.fluentd:
+            if fluentd.logging_tag or fluentd.result_tag:
+                fluent_logger = FluentLogHandler(config.fluentd)
+                LOG.addHandler(fluent_logger)
+                break
+
         # traffic profile override options
         override_custom_traffic(config, opts.frame_sizes, opts.unidir)
 
@@ -500,9 +569,23 @@ def main():
             config.service_chain = opts.service_chain
         if opts.service_chain_count:
             config.service_chain_count = opts.service_chain_count
+        if opts.no_vswitch_access:
+            config.no_vswitch_access = opts.no_vswitch_access
+        if opts.no_int_config:
+            config.no_int_config = opts.no_int_config
+
+        if opts.l2_loopback:
+            if config.service_chain != ChainType.EXT:
+                LOG.info('Changing service chain type to EXT')
+                config.service_chain = ChainType.EXT
+            if not config.no_arp:
+                LOG.info('Disabling ARP')
+                config.no_arp = True
+            config.vlans = [int(opts.l2_loopback), int(opts.l2_loopback)]
+            LOG.info('Running L2 loopback: using EXT chain and no ARP')
 
         if opts.use_sriov_middle_net:
-            if (not config.sriov) or (not config.service_chain == ChainType.PVVP):
+            if (not config.sriov) or (config.service_chain != ChainType.PVVP):
                 raise Exception("--use-sriov-middle-net is only valid for PVVP with SRIOV")
             config.use_sriov_middle_net = True
 
@@ -531,6 +614,9 @@ def main():
         # in a copy of the dict (config plugin still holds the original dict)
         config_plugin.set_config(config)
 
+        if opts.status or opts.cleanup or opts.force_cleanup:
+            status_cleanup(config, opts.cleanup, opts.force_cleanup)
+
         # add file log if requested
         if config.log_file:
             log.add_file_logger(config.log_file)