Support of configurable background load and implementation of LTD.CPU.RFC2544.0PacketLoss and LTD.Memory.RFC2544.0PacketLoss

Every testcase can be configured to run background load
on the DUT. Load is generated by chosen command line tool,
which must be installed according to the installation.md.
Currently 'stress' and 'stress-ng' tools are supported,
but support for new tool can be easily added.
Load can be configured by testcase configuration option 'load'.
Details about supported load generator options can be found
in conf/01_testcases.conf.

JIRA: VSPERF-23
JIRA: VSPERF-24
Change-Id: I3e1aebc0d41357f5a2764015c41ffc7e50fdbf8b
Signed-off-by: Martin Klozik <martinx.klozik@intel.com>
Reviewed-by: Billy O Mahony <billy.o.mahony@intel.com>
Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com>
Reviewed-by: Al Morton <acmorton@att.com>

8 files changed, 276 insertions, 0 deletions

diff --git a/tools/load_gen/__init__.py b/tools/load_gen/__init__.py
new file mode 100644
index 00000000..2eee60bd
--- /dev/null
+++ b/tools/load_gen/__init__.py
@@ -0,0 +1,16 @@
+# Copyright 2015 Intel Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Package with wrappers of load generators
+"""
diff --git a/tools/load_gen/dummy/__init__.py b/tools/load_gen/dummy/__init__.py
new file mode 100644
index 00000000..834e9f63
--- /dev/null
+++ b/tools/load_gen/dummy/__init__.py
@@ -0,0 +1,16 @@
+# Copyright 2015 Intel Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Package with wrapper of dummy load generator
+"""
diff --git a/tools/load_gen/dummy/dummy.py b/tools/load_gen/dummy/dummy.py
new file mode 100644
index 00000000..74fc33b7
--- /dev/null
+++ b/tools/load_gen/dummy/dummy.py
@@ -0,0 +1,31 @@
+# Copyright 2015 Intel Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Class with implementation of wrapper of dummy load generator"""
+
+from tools.load_gen.load_gen import ILoadGenerator
+
+class DummyLoadGen(ILoadGenerator):
+    """Dummy load generator, which doesn't generate any load"""
+    def __init__(self, stress_config):
+        """Initialise process state."""
+        pass
+
+    def start(self):
+        """Start stress load if it was requested"""
+        pass
+
+    def kill(self):
+        """Kill stress load if it is active"""
+        pass
diff --git a/tools/load_gen/load_gen.py b/tools/load_gen/load_gen.py
new file mode 100644
index 00000000..b55a643c
--- /dev/null
+++ b/tools/load_gen/load_gen.py
@@ -0,0 +1,22 @@
+# Copyright 2015 Intel Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Generic interface VSPERF uses for controlling a load generators
+"""
+
+from tools import tasks
+
+class ILoadGenerator(tasks.CustomProcess):
+    """Interface class that is implemented by specific classes of load
+    generators is derived from CustomProcess"""
diff --git a/tools/load_gen/stress/__init__.py b/tools/load_gen/stress/__init__.py
new file mode 100644
index 00000000..6b04c74d
--- /dev/null
+++ b/tools/load_gen/stress/__init__.py
@@ -0,0 +1,16 @@
+# Copyright 2015 Intel Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Package with wrapper of stress tool
+"""
diff --git a/tools/load_gen/stress/stress.py b/tools/load_gen/stress/stress.py
new file mode 100644
index 00000000..4a53f2d2
--- /dev/null
+++ b/tools/load_gen/stress/stress.py
@@ -0,0 +1,124 @@
+# Copyright 2015 Intel Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Module with implementation of wrapper around the stress tool
+"""
+
+import logging
+import subprocess
+import copy
+from tools import tasks
+from tools import systeminfo
+from tools.load_gen.load_gen import ILoadGenerator
+
+class Stress(ILoadGenerator):
+    """Wrapper around stress tool, which generates load based on testcase
+    configuration parameter 'load'
+    """
+    _process_args = {
+        'cmd': ['sudo', 'stress'],
+        'timeout': 5,
+        'logfile': '/tmp/stress.log',
+        'expect': r'stress: info:',
+        'name': 'stress'
+    }
+    _logger = logging.getLogger(__name__)
+
+    def __init__(self, stress_config):
+        self._running = False
+        # copy stress process setings before its modification
+        process_args = copy.deepcopy(self._process_args)
+        # check if load is requested and correctly configured
+        if not (stress_config and 'load' in stress_config and
+                'pattern' in stress_config and stress_config['load'] > 0):
+            self._logger.error('stress test is not enabled')
+            return
+
+        if stress_config['load'] < 0 or stress_config['load'] > 100:
+            self._logger.error('defined load %s is out of range 0-100',
+                               stress_config['load'])
+            return
+
+        # check if load tool binary is available
+        if not ('tool' in stress_config) or subprocess.call("which " + stress_config['tool'], shell=True) > 0:
+            self._logger.error("stress tool binary '%s' is not available", stress_config['tool'])
+            return
+
+        # calculate requested load details and load split among different
+        # types of workers
+        cpus = systeminfo.get_cpu_cores()
+        if 'reserved' in stress_config:
+            cpus = cpus - int(stress_config['reserved'])
+            if cpus < 1:
+                cpus = 1
+
+        workers = round(cpus/100 * int(stress_config['load']))
+        cmd_dict = {}
+        p_types = {}
+        p_total = 0
+        for p_type in ('c', 'i', 'm'):
+            p_count = stress_config['pattern'].lower().count(p_type)
+            if p_count > 0:
+                p_types[p_type] = p_count
+                p_total += p_count
+        if p_total < 1:
+            self._logger.error('stress test pattern does not contain any of ' \
+                               'c, i or m pattern types')
+            return
+        for p_type in p_types:
+            cmd_dict['-'+p_type] = round(workers* p_types[p_type] / p_total)
+
+        # check for memory load in case that memory workers are detected
+        # in case of error or 0%, memory size is not specified and default
+        # amount of memory will be used by stress tool
+        if '-m' in cmd_dict and cmd_dict['-m'] > 0:
+            if 'load_memory' in stress_config and \
+                stress_config['load_memory'] > 0 and \
+                stress_config['load_memory'] <= 100:
+
+                mem = systeminfo.get_memory_bytes()
+                if mem:
+                    cmd_dict['--vm-bytes'] = round(int(mem) / 100 * \
+                        stress_config['load_memory'] / cmd_dict['-m'])
+
+        # append stress arguments to cmd list used by parent class Process
+        for key, value in cmd_dict.items():
+            process_args['cmd'].append(key)
+            process_args['cmd'].append(str(value))
+
+        # append load generator options if specified
+        if 'options' in stress_config:
+            process_args['cmd'].append(stress_config['options'])
+
+        # initialize load generator and remember it
+        super(Stress, self).__init__(**process_args)
+        self._running = True
+
+    def start(self):
+        """Start stress load if it was requested
+        """
+        if self._running:
+            super(Stress, self).start()
+
+    def kill(self):
+        """
+        Kill stress load if it is active
+        """
+        if self._running and self._child and self._child.isalive():
+            tasks.run_task(['sudo', 'pkill', self._proc_name],
+                           self._logger)
+
+        self._logger.info(
+            'Log available at %s', self._logfile)
+        self._running = False
diff --git a/tools/load_gen/stress_ng/__init__.py b/tools/load_gen/stress_ng/__init__.py
new file mode 100644
index 00000000..eb530a4d
--- /dev/null
+++ b/tools/load_gen/stress_ng/__init__.py
@@ -0,0 +1,16 @@
+# Copyright 2015 Intel Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Package with wrapper of stress-ng tool
+"""
diff --git a/tools/load_gen/stress_ng/stress_ng.py b/tools/load_gen/stress_ng/stress_ng.py
new file mode 100644
index 00000000..c2592dd1
--- /dev/null
+++ b/tools/load_gen/stress_ng/stress_ng.py
@@ -0,0 +1,35 @@
+# Copyright 2015 Intel Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Module with implementation of wrapper around the stress-ng tool
+"""
+
+import logging
+from tools.load_gen.stress.stress import Stress
+
+class StressNg(Stress):
+    """Wrapper around stress-ng tool, which generates load based on
+    testcase configuration parameter 'load'
+    """
+    _process_args = {
+        'cmd': ['sudo', 'stress-ng'],
+        'timeout': 5,
+        'logfile': '/tmp/stress-ng.log',
+        'expect': r'stress-ng: info:',
+        'name': 'stress-ng'
+    }
+    _logger = logging.getLogger(__name__)
+
+    def __init__(self, stress_config):
+        super(StressNg, self).__init__(stress_config)