Adds a BC file extension for Architecture, a bare-bones MDReport, an ArchitectureAnalysis experiment and "SynthSAWholeProgram" as a project

varats-core/varats/experiment/wllvm.py

@@ -48,6 +48,7 @@ class BCFileExtensions(Enum):
     TBAA = "TBAA"
     FEATURE = 'feature'
     BLAME = "blame"
+    ARCH = "fvara-arch"
 
     def __lt__(self, other: tp.Any) -> bool:
         if isinstance(other, BCFileExtensions):

varats/varats/data/reports/md_report.py

@@ -0,0 +1,11 @@
+"""Metadata report implementation."""
+
+from varats.report.report import BaseReport
+
+
+class MDReport(BaseReport, shorthand="MD", file_type="txt"):
+    """
+    An Metadata report which serves as a base class for the Architecture report.
+    """
+
+    # TODO Implement the MDReport class.

varats/varats/experiments/vara/architecture_report_experiment.py

@@ -0,0 +1,112 @@
+"""Implements an empty experiment that just compiles the project."""
+
+import typing as tp
+
+from benchbuild import Project
+from benchbuild.extensions import compiler, run, time
+from benchbuild.utils import actions
+from benchbuild.utils.cmd import touch
+
+from varats.data.reports.md_report import MDReport
+from varats.experiment.experiment_util import (
+    VersionExperiment,
+    ExperimentHandle,
+    exec_func_with_pe_error_handler,
+    get_default_compile_error_wrapped,
+    create_default_analysis_failure_handler,
+    create_new_success_result_filepath,
+)
+from varats.experiment.wllvm import RunWLLVM
+from varats.project.varats_project import VProject
+from varats.report.report import ReportSpecification
+from varats.utils.config import get_current_config_id
+
+
+class ArchitectureAnalysis(actions.ProjectStep):  # type: ignore
+    """Analyses a project's architecture with VaRA and generates a report."""
+
+    NAME = "ArchitectureAnalysis"
+    DESCRIPTION = "Analyses the bitcode with -vara-arch of VaRA."
+
+    project: VProject
+
+    def __init__(self, project: Project, experiment_handle: ExperimentHandle):
+        super().__init__(project=project)
+        self.__experiment_handle = experiment_handle
+
+    def __call__(self) -> actions.StepResult:
+        return self.analyze()
+
+    def analyze(self) -> actions.StepResult:
+        #
+
+        config_id = get_current_config_id(self.project)
+
+        for binary in self.project.binaries:
+            result_file = create_new_success_result_filepath(
+                self.__experiment_handle,
+                MDReport,
+                self.project, binary,
+                config_id
+            )
+
+            opt_params = [
+                "-O0", "-g0", "-fvara-GB",
+                "-S", "-fvara-arch",
+                f"-vara-report-outfile={result_file}",
+                get_cached_bc_file_path(
+                    self.project, binary, [
+                        BCFileExtensions.NO_OPT,
+                        BCFileExtensions.ARCH
+                    ]
+                )
+            ]
+
+            run_cmd = opt[opt_params]
+
+            exec_func_with_pe_error_handler(
+                run_cmd,
+                create_default_analysis_failure_handler(
+                    self.__experiment_handle, self.project, MDReport
+                )
+            )
+
+        return actions.StepResult.OK
+
+
+# Please take care when changing this file, see docs experiments/just_compile
+class ArchitectureReport(VersionExperiment, shorthand="ARE"):
+    """Generates an Architecture report file."""
+
+    NAME = "GenerateArchitectureReport"
+
+    REPORT_SPEC = ReportSpecification(MDReport)
+
+    def actions_for_project(
+        self, project: Project
+    ) -> tp.MutableSequence[actions.Step]:
+        """Returns the specified steps to run the project(s) specified in the
+        call in a fixed order."""
+
+        # Add the required runtime extensions to the project(s).
+        project.runtime_extension = run.RuntimeExtension(project, self) \
+            << time.RunWithTime()
+
+        # Add the required compiler extensions to the project(s).
+        project.compiler_extension = compiler.RunCompiler(project, self) \
+            << RunWLLVM() \
+            << run.WithTimeout()
+
+        project.compile = get_default_compile_error_wrapped(
+            self.get_handle(), project, self.REPORT_SPEC.main_report
+        )
+
+        analysis_actions = []
+        analysis_actions.append(actions.Compile(project))
+        analysis_actions.append(EmptyAnalysis(project, self.get_handle()))
+        analysis_actions.append(actions.Clean(project))
+
+        return analysis_actions
+
+
+

varats/varats/projects/cpp_projects/featureperfcscollection.py

@@ -0,0 +1,71 @@
+"""Based on the project file for opencv."""
+import typing as tp
+
+import benchbuild as bb
+from benchbuild.utils.cmd import make, cmake
+from benchbuild.utils.settings import get_number_of_jobs
+from plumbum import local
+
+from varats.containers.containers import get_base_image, ImageBase
+from varats.paper.paper_config import PaperConfigSpecificGit
+from varats.project.project_domain import ProjectDomains
+from varats.project.project_util import (
+    ProjectBinaryWrapper,
+    BinaryType,
+    get_local_project_git_path,
+    verify_binaries,
+)
+from varats.project.varats_project import VProject
+from varats.utils.git_util import ShortCommitHash, RevisionBinaryMap
+from varats.utils.settings import bb_cfg
+
+
+class OpenCV(VProject):
+    """Open Source Computer Vision Library."""
+
+    NAME = 'featureperfcscollection'
+    GROUP = 'cpp_projects'
+    DOMAIN = ProjectDomains.CPP_LIBRARY
+
+    SOURCE = [
+        PaperConfigSpecificGit(
+            project_name="featureperfcscollection",
+            remote="[email protected]:se-sic/FeaturePerfCSCollection.git",
+            local="featureperfcscollection",
+            refspec="origin/HEAD",
+            limit=None,
+            shallow=False
+        )
+    ]
+
+    @staticmethod
+    def binaries_for_revision(
+        revision: ShortCommitHash
+    ) -> tp.List[ProjectBinaryWrapper]:
+        binary_map = RevisionBinaryMap(get_local_project_git_path(OpenCV.NAME))
+
+        # TODO: please add correct binary names
+        binary_map.specify_binary("MISSING", BinaryType.EXECUTABLE)
+
+        return binary_map[revision]
+
+    def run_tests(self) -> None:
+        pass
+
+    def compile(self) -> None:
+        """Compile the project."""
+        opencv_source = local.path(self.source_of(self.primary_source))
+
+        c_compiler = bb.compiler.cc(self)
+        cxx_compiler = bb.compiler.cxx(self)
+        build_folder = opencv_source / "build"
+        build_folder.mkdir()
+        with local.cwd(build_folder):
+
+            with local.env(CC=str(c_compiler), CXX=str(cxx_compiler)):
+                bb.watch(cmake)("../projects/SynthSAWholeProgram")
+
+            bb.watch(make)("-j", get_number_of_jobs(bb_cfg()))
+
+        with local.cwd(opencv_source):
+            verify_binaries(self)