Merge pull request #2786 from FarooqAbdulla02/perf_mem

Adding "perf mem" tests

perf/perf_mem.py

@@ -0,0 +1,109 @@
+#!/usr/bin/env python
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# See LICENSE for more details.
+#
+# Copyright: 2024 IBM
+# Author: Shaik Abdulla <[email protected]>
+
+import os
+from avocado import Test
+from avocado.utils import distro, process, dmesg
+from avocado.utils.software_manager.manager import SoftwareManager
+
+
+class perf_mem(Test):
+
+    """
+    Tests perf mem and it's options namely
+    record, report with all possible flags with
+    the help of yaml file
+    :avocado: tags=perf,mem
+    """
+
+    def setUp(self):
+        '''
+        Install the basic packages to support perf
+        '''
+
+        # Check for basic utilities
+        smm = SoftwareManager()
+        detected_distro = distro.detect()
+        self.distro_name = detected_distro.name
+
+        deps = ['gcc', 'make']
+        if self.distro_name in ['rhel', 'SuSE', 'fedora', 'centos']:
+            deps.extend(['perf'])
+        else:
+            self.cancel("Install the package for perf supported \
+                         by %s" % detected_distro.name)
+        for package in deps:
+            if not smm.check_installed(package) and not smm.install(package):
+                self.cancel('%s is needed for the test to be run' % package)
+
+        # Check for mem is available in the system.
+        output = process.run('perf mem record -e list').stderr.decode("utf-8")
+        if 'ldlat-stores' in output or 'ldlat-loads' in output:
+            self.log.info("perf mem is available")
+        else:
+            self.cancel('perf mem is not available')
+
+        # Getting the parameters from yaml file
+        self.record = self.params.get('record_method', default='')
+        self.report = self.params.get('report_method', default='')
+
+        # Clear the dmesg, by that we can capture the delta at the end of the
+        # test.
+        dmesg.clear_dmesg()
+
+    def run_cmd(self, cmd):
+        try:
+            process.run(cmd, ignore_status=False, sudo=True)
+        except process.CmdError as details:
+            self.fail("Command %s failed: %s" % (cmd, details))
+
+    def test_mem(self):
+        # When input is used for report, then need to pass the file argument
+        # to the same file, record should log the data. So altering record,
+        # report options to have the proper arguments.
+
+        output_file = "perf.data"
+        # file arguments for report command
+        if self.report == "-i":
+            self.report = "-i %s" % output_file
+        elif self.report == "--input":
+            self.report = "--input=%s" % output_file
+
+        # Record command
+        record_cmd = "perf mem record -o %s %s sleep 1" % (
+            output_file, self.record)
+        self.run_cmd(record_cmd)
+
+        # Report command
+        report_cmd = "perf mem report %s" % self.report
+
+        # Validate the output of perf mem
+        if os.path.exists(output_file):
+            if not os.stat(output_file).st_size:
+                self.fail("%s sample not captured" % output_file)
+            else:
+                self.run_cmd(report_cmd)
+
+        # Verify dmesg
+        dmesg.collect_errors_dmesg(['WARNING: CPU:', 'Oops', 'Segfault',
+                                    'soft lockup', 'Unable to handle'])
+
+    def tearDown(self):
+        # Delete the temporary file
+        if os.path.isfile("perf.data"):
+            process.run('rm -f perf.data')
+        if os.path.isfile("perf.data.old"):
+            process.run('rm -f perf.data.old')

perf/perf_mem.py.data/record_report.yaml

@@ -0,0 +1,69 @@
+record: !mux
+        event_load:
+                record_method: -e ldlat-loads
+        event__load_full:
+                record_method: --event ldlat-loads
+        event_store:
+                record_method: -e ldlat-stores
+        event__store_full:
+                record_method: --event ldlat-stores
+        all_kernel:
+                record_method: -K -v
+        all_kernel_full:
+                record_method: --all-kernel --event ldlat-stores
+        all_user:
+                record_method: -U -e ldlat-loads
+        all_user_full:
+                record_method: --all-user
+        force:
+                record_method: -f --event ldlat-stores
+        force_full:
+                record_method: --force -t load
+        type_load:
+                record_method: -t load -e ldlat-stores
+        type_store:
+                record_method: -t store --event ldlat-loads
+        type_load_full:
+                record_method: --type=load -C 0 -e ldlat-loads
+        type_store_full:
+                record_method: --type=store
+        cpu_verbose:
+                record_method: -C 0 --verbose
+        cpu_full:
+                record_method: --cpu=0
+        Physical_address:
+                record_method: -p
+        Physical_address_full:
+                record_method: --phys-data
+        data_page_size:
+                record_method: --data-page-size
+        event_store_load:
+                record_method: -e ldlat-stores -t load -f -v -C 0
+
+report: !mux
+        input_data:
+                report_method: -i
+        input_data_full:
+                report_method: --input
+        force_ownership_validation:
+                report_method: -f
+        force_ownership_validation_full:
+                report_method: --force
+        dump_raw_sample:
+                report_method: -D
+        dump_raw_sample_full:
+                report_method: --dump-raw-samples
+        dump_raw_sample_seperator:
+                report_method: -D -x ','
+        dump_raw_sample_sep_full:
+                report_method: --dump-raw-samples --field-separator=?
+        hide_unresolved:
+                report_method: -U
+        hide_unresolved_full:
+                report_method: --hide-unresolved
+        physical_address:
+                report_method: -p
+        physical_address_full:
+                report_method: --phys-data
+        physical_address_data_size:
+                report_method: --data-page-size