Add pinning support

Add support for CPU pinning of libvirt guests and also
restricting host processes to selected CPUs via isolcpus.

Hugepage support is added using the same mechanism as
isolcpus, along with a perf scenario where all 3 performance
options are enabled.

Deploy options are now parsed in python

JIRA: APEX-127
JIRA: APEX-105
JIRA: APEX-106

Change-Id: I438e80fb88e596cc017595d43bc1efda1001325c
opnfv-tht-pr: 8
Signed-off-by: Michael Chapman <woppin@gmail.com>

3 files changed, 160 insertions, 1 deletions

diff --git a/lib/python/apex-python-utils.py b/lib/python/apex-python-utils.py
index 1d5b4a7c..7e947ea6 100755
--- a/lib/python/apex-python-utils.py
+++ b/lib/python/apex-python-utils.py
@@ -7,7 +7,6 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 ##############################################################################
 
-
 import argparse
 import sys
 import apex
@@ -21,6 +20,10 @@ def parse_net_settings(settings_args):
                                     settings_args.network_isolation)
     settings.dump_bash()
 
+def parse_deploy_settings(settings_args):
+    settings = apex.DeploySettings(settings_args.path)
+    settings.dump_bash()
+
 
 def find_ip(int_args):
     interface = apex.ip_utils.get_interface(int_args.interface,
@@ -73,6 +76,12 @@ nic_template.add_argument('-af', '--address_family', type=int, default=4,
                           help='IP address family')
 nic_template.set_defaults(func=build_nic_template)
 
+deploy_settings = subparsers.add_parser('parse-deploy-settings',
+                                        help='Parse deploy settings file')
+deploy_settings.add_argument('-f', '--path', default='deploy_settings.yaml',
+                             help='path to deploy settings file')
+deploy_settings.set_defaults(func=parse_deploy_settings)
+
 args = parser.parse_args(sys.argv[1:])
 if args.DEBUG:
     logging.basicConfig(level=logging.DEBUG)
diff --git a/lib/python/apex/__init__.py b/lib/python/apex/__init__.py
index 88b066b2..2efc64f4 100644
--- a/lib/python/apex/__init__.py
+++ b/lib/python/apex/__init__.py
@@ -9,3 +9,4 @@
 
 
 from .net_env import NetworkSettings
+from .deploy_env import DeploySettings
diff --git a/lib/python/apex/deploy_env.py b/lib/python/apex/deploy_env.py
new file mode 100644
index 00000000..5c733248
--- /dev/null
+++ b/lib/python/apex/deploy_env.py
@@ -0,0 +1,149 @@
+##############################################################################
+# Copyright (c) 2016 Michael Chapman (michapma@redhat.com) and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+
+import yaml
+import logging
+
+REQ_DEPLOY_SETTINGS = ['sdn_controller',
+                       'sdn_l3',
+                       'tacker',
+                       'congress',
+                       'sfc',
+                       'vpn']
+
+OPT_DEPLOY_SETTINGS = ['performance']
+
+VALID_ROLES = ['Controller', 'Compute', 'ObjectStorage']
+VALID_PERF_OPTS = ['kernel','nova']
+
+class DeploySettings:
+    """
+    This class parses a APEX deploy settings yaml file into an object
+
+    Currently the parsed object is dumped into a bash global definition file
+    for deploy.sh consumption. This object will later be used directly as
+    deployment script move to python.
+    """
+    def __init__(self, filename):
+        with open(filename, 'r') as settings_file:
+            self.deploy_settings = yaml.load(settings_file)
+            self._validate_settings()
+
+    def _validate_settings(self):
+        """
+        Validates the deploy settings file provided
+
+        DeploySettingsException will be raised if validation fails.
+        """
+
+        if 'deploy_options' not in self.deploy_settings:
+            raise DeploySettingsException("No deploy options provided in"
+                                          "deploy settings file")
+        if 'global_params' not in self.deploy_settings:
+            raise DeploySettingsException("No global options provided in"
+                                          "deploy settings file")
+
+        deploy_options = self.deploy_settings['deploy_options']
+        if not isinstance(deploy_options, dict):
+            raise DeploySettingsException("deploy_options should be a list")
+
+        for option in deploy_options:
+            if option not in REQ_DEPLOY_SETTINGS + OPT_DEPLOY_SETTINGS:
+                raise DeploySettingsException("Invalid deploy_option {} "
+                                              "specified".format(option))
+
+        for required_setting in REQ_DEPLOY_SETTINGS:
+            if required_setting not in deploy_options:
+                self.deploy_settings['deploy_options'][required] = False
+
+        if 'performance' in deploy_options:
+            if not isinstance(deploy_options['performance'], dict):
+                raise DeploySettingsException("Performance deploy_option"
+                                              "must be a dictionary.")
+            for role,role_perf_sets in deploy_options['performance'].items():
+                if role not in VALID_ROLES:
+                    raise DeploySettingsException("Performance role {}"
+                                                  "is not valid, choose"
+                                                  "from {}".format(
+                                                  role," ".join(VALID_ROLES)
+                                                  ))
+
+                for key in role_perf_sets:
+                    if key not in VALID_PERF_OPTS:
+                        raise DeploySettingsException("Performance option {}"
+                                                      "is not valid, choose"
+                                                      "from {}".format(
+                                                      key," ".join(
+                                                      VALID_PERF_OPTS)))
+
+
+    def _dump_performance(self):
+        """
+        Creates performance settings string for bash consumption.
+
+        Output will be in the form of a list that can be iterated over in bash,
+        with each string being the direct input to the performance setting script
+        in the form <role> <category> <key> <value> to facilitate modification of the
+        correct image.
+        """
+        bash_str = 'performance_options=(\n'
+        for role,settings in self.deploy_settings['deploy_options']['performance'].items():
+            for category,options in settings.items():
+                for key,value in options.items():
+                    bash_str += "\"{} {} {} {}\"\n".format(role, category, key, value)
+        bash_str += ')\n'
+        bash_str += '\n'
+        bash_str += 'performance_roles=(\n'
+        for role in self.deploy_settings['deploy_options']['performance']:
+            bash_str += role + '\n'
+        bash_str += ')\n'
+        bash_str += '\n'
+
+        return bash_str
+
+    def _dump_deploy_options_array(self):
+        """
+        Creates deploy settings array in bash syntax.
+        """
+        bash_str = ''
+        for key,value in self.deploy_settings['deploy_options'].items():
+            if not isinstance(value, bool):
+                bash_str += "deploy_options_array[{}]=\"{}\"\n".format(key, value)
+            else:
+                bash_str += "deploy_options_array[{}]={}\n".format(key, value)
+        return bash_str
+
+    def dump_bash(self, path=None):
+        """
+        Prints settings for bash consumption.
+
+        If optional path is provided, bash string will be written to the file
+        instead of stdout.
+        """
+        bash_str = ''
+        for key, value in self.deploy_settings['global_params'].items():
+            bash_str += "if [ -z \"$(eval echo \$${})\" ]; then\n{}={}\nfi\n".format(key,key, value)
+        if 'performance' in self.deploy_settings['deploy_options']:
+            bash_str += self._dump_performance()
+        bash_str += self._dump_deploy_options_array()
+
+        if path:
+            with open(path, 'w') as file:
+                file.write(bash_str)
+        else:
+            print(bash_str)
+
+
+class DeploySettingsException(Exception):
+    def __init__(self, value):
+        self.value = value
+
+    def __str__(self):
+        return self.value