Add flang out of tree buildbot

[rovka]

Summary

This builder has 2 stages: one for building llvm and mlir, and one for
building flang itself in a different build directory. In order to do an
out of tree build of flang, we need to run cmake with the path to the
flang subproject as source directory.

[maxim-kuvyrkov]

LGTM.

[gkistanova]

Thanks for working on this, Diana!

It does not seem getFlangOutOfTreeBuildFactory belongs to the UnifiedTreeBuilder.

You either need to teach cmake to configure flang from the root of the unified tree; then you likely would not need a custom build factory, as the current UnifiedTreeBuilder would build your configuration just fine.
Or you need to add a custom builder for flang.

I personally prefer the first option, since it would simplify the build of this configuration in general for everyone, not just for CI.

[rovka]

Hi Galina, thanks for having a look!

I think running cmake from the top level directory would defeat the purpose of what this buildbot is trying to test. The whole point is to be able to build flang using only the flang source tree. I have therefore updated the patch to create a new FlangBuilder, but it still imports some things from the UnifiedTreeBuilder. We could also move those common functions from UnifiedTreeBuilder to Util.py if you think that would be cleaner. Please let me know your thoughts.

Cheers!

[rovka]

Ping :)

[gkistanova]

Thanks for changing, Diana!

Almost there. Please see my inline comments.

zorg/buildbot/builders/FlangBuilder.py

17

UnifiedTreeBuilder would do this for you. You can just pass the llvm_extra_configure_args down to getCmakeWithNinjaBuildFactory as is.

45

Just a cosmetic.
How about renaming this to something like flang_obj_dir and flang_src_dir respectively?
Otherwise it might look a bit confusing with f.obj_dir etc.

53

The naming of pathRelativeToBuild method is not great. I refactored it to be pathRelativeTo instead.

Could you rebase the patch, please?
Otherwise it looks confusing, when the comment says we want paths relative to the source and then there are pathRelativeToBuild calls.

[rovka]

Hi Galina, those are all good comments, thanks! I think I fixed them up, does it look ok now?

[gkistanova]

Thanks, Diana!
Looks good now.

[sameeranjoshi]

Does this bot trigger for Flang project as of now?
I might not be very much familiar with phabricator but not sure how do we see if the bot triggers and the build results from the bots.
I was expecting it to trigger for https://reviews.llvm.org/D87774 review.

Also in phabricator when I click on buildbots in home screen of phabricator I get redirected to http://lab.llvm.org:8011/
but the page never opens.

[rovka]

Hi Sameeran,

The bot is currently on the silent master [1], so it doesn't trigger.
It had some strange python exceptions that I hadn't seen on my
buildmaster during testing. I think they might be gone now, but I'll
leave it on silent for a couple more days until it looks stable
enough.

Cheers,
Diana

[1] http://lab.llvm.org:8014/#/builders/114

buildbot/osuosl/master/config/builders.py

 from buildbot.process.properties import WithProperties
 
 from zorg.buildbot.builders import ClangBuilder
+from zorg.buildbot.builders import FlangBuilder
 from zorg.buildbot.builders import PollyBuilder
 from zorg.buildbot.builders import LLDBBuilder
 from zorg.buildbot.builders import SanitizerBuilder
 from zorg.buildbot.builders import OpenMPBuilder
 from zorg.buildbot.builders import LibcxxAndAbiBuilder
 from zorg.buildbot.builders import SphinxDocsBuilder
 from zorg.buildbot.builders import ABITestsuitBuilder
 from zorg.buildbot.builders import ClangLTOBuilder
return [
                             "-DBUILD_SHARED_LIBS=ON",
                             "-DLLVM_ENABLE_ASSERTIONS=ON",
                             "-DFLANG_BUILD_NEW_DRIVER=ON",
                             "-DCMAKE_BUILD_TYPE=Release",
                         ],
          ),
          'category' : 'flang'},
 
+        {'name': "flang-aarch64-ubuntu-out-of-tree",
+         'slavenames':["linaro-aarch64-flang-oot"],
+         'builddir':"flang-aarch64-out-of-tree",
+         'factory': FlangBuilder.getFlangOutOfTreeBuildFactory(
+             llvm_extra_configure_args=[
+                 "-DLLVM_TARGETS_TO_BUILD=AArch64",
+                 "-DCMAKE_CXX_STANDARD=17",
+                 "-DLLVM_ENABLE_WERROR=OFF",
+                 "-DLLVM_ENABLE_ASSERTIONS=ON",
+                 "-DCMAKE_BUILD_TYPE=Release",
+             ],
+             flang_extra_configure_args=[
+                 "-DFLANG_ENABLE_WERROR=ON",
+                 "-DCMAKE_BUILD_TYPE=Release",
+            ],
+        ),
+        'category' : 'flang'},
+
         {'name': "flang-x86_64-linux",
          'slavenames':["nersc-flang"],
          'builddir':"flang-x86_64-linux",
          'factory': UnifiedTreeBuilder.getCmakeWithNinjaBuildFactory(
                         depends_on_projects=['llvm','mlir','clang','flang'],
                         extra_configure_args=[
                             "-DLLVM_TARGETS_TO_BUILD=X86",
                             "-DLLVM_INSTALL_UTILS=ON",

buildbot/osuosl/master/config/slaves.py

return [
         create_slave("linaro-armv8-libcxx", properties={'jobs' : 1}, max_builds=1),
         create_slave("linaro-arm-lldb", properties={'jobs' : 16}, max_builds=1),
 
         # AArch64 Linaro slaves
         create_slave("linaro-aarch64-quick", properties={'jobs' : 32}, max_builds=1),
         create_slave("linaro-aarch64-full", properties={'jobs' : 32}, max_builds=1),
         create_slave("linaro-aarch64-global-isel", properties={'jobs' : 32}, max_builds=1),
         create_slave("linaro-aarch64-lld", properties={'jobs' : 32}, max_builds=1),
+        create_slave("linaro-aarch64-flang-oot", properties={'jobs' : 32}, max_builds=1),
         # Libcxx testsuite has tests with timing assumptions.  Run single-threaded to make
         # sure we have plenty CPU cycle to satisfy timing assumptions.
         create_slave("linaro-aarch64-libcxx", properties={'jobs' : 1}, max_builds=1),
         create_slave("linaro-aarch64-lldb", properties={'jobs': 16}, max_builds=1),
 
         # AArch64
         create_slave("linaro-armv8-windows-msvc-01", properties={'jobs' : 8}, max_builds=1),
         create_slave("linaro-armv8-windows-msvc-02", properties={'jobs' : 8}, max_builds=1),

zorg/buildbot/builders/FlangBuilder.py

+from zorg.buildbot.commands.CmakeCommand import CmakeCommand
+
+from zorg.buildbot.process.factory import LLVMBuildFactory
+
+from zorg.buildbot.builders.UnifiedTreeBuilder import addNinjaSteps, getCmakeWithNinjaBuildFactory
+
+def getFlangOutOfTreeBuildFactory(
+           checks = None,
+           clean = False,
+           llvm_extra_configure_args = None,
+           flang_extra_configure_args = None,
+           env = None,
+           **kwargs):
+
+    f = getCmakeWithNinjaBuildFactory(
+            depends_on_projects=['llvm','mlir'],
+            obj_dir="build_llvm",
+            checks=[],
+            clean=clean,
+            extra_configure_args=llvm_extra_configure_args,
+            env=env,
+            **kwargs)
+
+    if checks is None:
+        checks = ['check-all']
+
+    # Make a local copy of the flang configure args, as we are going to modify that.
+    if flang_extra_configure_args:
+        flang_cmake_args = flang_extra_configure_args[:]
+    else:
+        flang_cmake_args = list()
+
+    # Some options are required for this build no matter what.
+    CmakeCommand.applyRequiredOptions(flang_cmake_args, [
+        ('-G', 'Ninja'),
+        ])
+
+    flang_obj_dir = "build_flang"
+    flang_src_dir = "%s/flang" % f.monorepo_dir
+
+    # Add LLVM_DIR and MLIR_DIR to the CMake invocation.
+    llvm_dir = "%s/lib/cmake/llvm" % f.obj_dir
+    mlir_dir = "%s/lib/cmake/mlir" % f.obj_dir
+    CmakeCommand.applyRequiredOptions(flang_cmake_args, [
+        # We actually need the paths to be relative to the source directory,
+        # otherwise find_package can't locate the config files.
+        ('-DLLVM_DIR:PATH=',
+            LLVMBuildFactory.pathRelativeTo(llvm_dir, flang_src_dir)),
+        ('-DMLIR_DIR:PATH=',
+            LLVMBuildFactory.pathRelativeTo(mlir_dir, flang_src_dir)),
+        ])
+
+    # We can't use addCmakeSteps as that would use the path in f.llvm_srcdir.
+    f.addStep(CmakeCommand(name="cmake-configure-flang",
+                           haltOnFailure=True,
+                           description=["CMake", "configure", "flang"],
+                           options=flang_cmake_args,
+                           path=LLVMBuildFactory.pathRelativeTo(flang_src_dir,
+                                                                flang_obj_dir),
+                           env=env,
+                           workdir=flang_obj_dir,
+                           **kwargs))
+
+    addNinjaSteps(
+       f,
+       obj_dir=flang_obj_dir,
+       checks=checks,
+       env=env,
+       stage_name="flang",
+       **kwargs)
+
+    return f