Add HyTeG Project

varats-core/varats/project/project_domain.py

@@ -18,6 +18,7 @@ class ProjectDomains(Enum):
     EDITOR = "Editor"
     FILE_FORMAT = "File format"
     HW_EMULATOR = "Hardware emulator"
+    HPC = "High Performance Applications"
     PARSER = "Parser"
     PLANNING = "Planning"
     PROG_LANG = "Programming language"

varats/varats/projects/cpp_projects/hyteg.py

@@ -0,0 +1,110 @@
+"""Adds the HyTeg framework as a project to VaRA-TS."""
+import typing as tp
+
+import benchbuild as bb
+from benchbuild.command import WorkloadSet, SourceRoot
+from benchbuild.utils.cmd import make, cmake, mkdir
+from benchbuild.utils.revision_ranges import SingleRevision
+from benchbuild.utils.settings import get_number_of_jobs
+from plumbum import local
+
+from varats.experiment.workload_util import WorkloadCategory, RSBinary
+from varats.paper.paper_config import PaperConfigSpecificGit
+from varats.project.project_domain import ProjectDomains
+from varats.project.project_util import (
+    get_local_project_git_path,
+    BinaryType,
+    ProjectBinaryWrapper,
+)
+from varats.project.sources import FeatureSource
+from varats.project.varats_command import VCommand
+from varats.project.varats_project import VProject
+from varats.utils.git_util import ShortCommitHash, RevisionBinaryMap
+from varats.utils.settings import bb_cfg
+
+
+class HyTeg(VProject):
+    """
+    C++ framework for large scale high performance finite element simulations
+    based on (but not limited to) matrix-free geometric multigrid.
+
+    Note:
+        Currently HyTeg CANNOT be compiled with the Phasar passes activated
+        in vara.
+        Trying to do so will crash the compiler
+
+        If you use Dune with an experiment that uses the vara compiler,
+        add `-mllvm --vara-disable-phasar` to the projects `cflags` to
+        disable phasar passes.
+        This will still allow to analyse compile-time variability.
+    """
+    NAME = 'HyTeg'
+    GROUP = 'cpp_projects'
+    DOMAIN = ProjectDomains.HPC
+
+    SOURCE = [
+        PaperConfigSpecificGit(
+            project_name="HyTeg",
+            remote="https://github.com/se-sic/hyteg-VaRA.git",
+            local="HyTeg",
+            refspec="origin/HEAD",
+            limit=None,
+            shallow=False
+        ),
+        FeatureSource()
+    ]
+
+    WORKLOADS = {
+        WorkloadSet(WorkloadCategory.EXAMPLE): [
+            VCommand(
+                SourceRoot("HyTeg") / "build" / "apps" / "profiling" /
+                RSBinary('ProfilingApp'),
+                label='ProfilingApp'
+            )
+        ]
+    }
+
+    @staticmethod
+    def binaries_for_revision(
+        revision: ShortCommitHash
+    ) -> tp.List['ProjectBinaryWrapper']:
+        binaries = RevisionBinaryMap(get_local_project_git_path(HyTeg.NAME))
+
+        binaries.specify_binary(
+            "ProfilingApp",
+            BinaryType.EXECUTABLE,
+            only_valid_in=SingleRevision(
+                "f4711dadc3f61386e6ccdc704baa783253332db2"
+            )
+        )
+
+        return binaries[revision]
+
+    def compile(self) -> None:
+        """Compile HyTeg with irrelevant settings disabled."""
+        hyteg_source = local.path(self.source_of(self.primary_source))
+
+        mkdir("-p", hyteg_source / "build")
+
+        cc_compiler = bb.compiler.cc(self)
+        cxx_compiler = bb.compiler.cxx(self)
+
+        with local.cwd(hyteg_source / "build"):
+            with local.env(CC=str(cc_compiler), CXX=str(cxx_compiler)):
+                bb.watch(cmake)(
+                    "..", "-DWALBERLA_BUILD_WITH_MPI=OFF",
+                    "-DHYTEG_BUILD_DOC=OFF"
+                )
+
+                with local.cwd(hyteg_source / "build" / "apps" / "profiling"):
+                    bb.watch(make)("-j", get_number_of_jobs(bb_cfg()))
+
+    def recompile(self) -> None:
+        """Recompiles HyTeg e.g. after a patch has been applied."""
+        hyteg_source = local.path(self.source_of(self.primary_source))
+
+        with local.cwd(hyteg_source / "build" / "apps" / "profiling"):
+            bb.watch(make)("-j", get_number_of_jobs(bb_cfg()))
+
+    def run_tests(self) -> None:
+        pass

varats/varats/tools/bb_config.py

@@ -75,6 +75,7 @@ def update_projects(
         'varats.projects.cpp_projects.z3',
         'varats.projects.cpp_projects.ect',
         'varats.projects.cpp_projects.lepton',
+        'varats.projects.cpp_projects.hyteg',
         'varats.projects.cpp_projects.dune'
     ]
     projects_conf.value[:] += [