Add an experimental Sanitizer Windows builder

[timurrrr]

Summary

Please review.
This builder is mostly based on the LLDB Windows builder that Zach added recently.

Can you please tell if this builder is going to send e-mails on failures? If yes, can you advise how to disable it until the bot is green and stable?
Thanks,
Timur

[gkistanova]

Thanks for working on this!

You may want to move slave_env_glob2list to the Util.py as well.

You do not check out any source code in getSanitizerWindowsBuildFactory. Is this intentional? If it is, could you remove all the unused imports, please?

Please also see my in-line comments.

Thanks

Galina

zorg/buildbot/builders/SanitizerBuilderWindows.py

18

May I suggest using Property instead? Or at least reconcile this with property?
You are effectively loosing the "jobs" setting from your slaves.py.

Unless I'm missing something, we do not have a single use case yet when we really need to define jobs on the build factory level.

41

Could you use NinjaCommand instead of using WarningCountingShellCommand with ninja directly, please? zorg/buildbot/commands/NinjaCommand.py should cover your needs.

zorg/buildbot/builders/Util.py

3

How about getVisualStudioEnvironment name or something similar?

[timurrrr]

re: jobs, NinjaCommand -- my code was mostly copied from getLLDBWindowsCMakeBuildFactory.
I agree with you comments. Zachary should probably take a look at them and address them in the original code once my patch is finished.

re: check-out: oops, looks like I've missed that while copying code -- thanks for catching!

Please take a look at an updated patch.

zorg/buildbot/builders/SanitizerBuilderWindows.py

18

I've removed the jobs parameter, the default number of jobs ninja uses should be fine.

41

Done.

zorg/buildbot/builders/Util.py

3

Done

[gkistanova]

The patch looks good to me, assuming you will fix the getLLDBSource vs. getSource and remove unused python_source_dir.

Please note that you will need a buildslave 0.8.9 for this builder.

zorg/buildbot/builders/SanitizerBuilderWindows.py

35

This param seems unused. Could you remove if you do not need it, please?

53

Is this correct? Or it should be getSource here?

71

Usage of getVisualStudioEnvironment effectively mean you will be running at least buildslave 0.8.9. In this case, it will create temp batch by itself, so, there is no real need in explicit batch-ing. You can just use the command directly.

This is not a show stopper for this patch, though.

[zturner]

Galina: Is 0.8.10 ok? I ran "pip update" and it automatically gave me
0.8.10. I remember somewhere reading there was a compatibility issue with
0.8.10, but I can't find it anywhere now.

[gkistanova]

I did not test 0.8.10 intensively yet. But since you have got it, why not to try? We will learn issues, if any, quite soon.

[timurrrr]

Addressed the latest review comments and committed as r229537.
Can you please restart the master and see how it goes?
I'll update the slave to 0.8.9+ tomorrow and will start babysitting it to make it green.

Thanks a lot for a thorough review!

[timurrrr]

+ fix another unused import in r229544.

buildbot/osuosl/master/config/builders.py

 from zorg.buildbot.builders import SanitizerBuilder
 reload(SanitizerBuilder)
 from zorg.buildbot.builders import SanitizerBuilder
 
 from zorg.buildbot.builders import SanitizerBuilderII
 reload(SanitizerBuilderII)
 from zorg.buildbot.builders import SanitizerBuilderII
 
+from zorg.buildbot.builders import SanitizerBuilderWindows
+reload(SanitizerBuilderWindows)
+from zorg.buildbot.builders import SanitizerBuilderWindows
+
 from zorg.buildbot.builders import Libiomp5Builder
 reload(Libiomp5Builder)
 from zorg.buildbot.builders import Libiomp5Builder
 
 from zorg.buildbot.builders import LibcxxAndAbiBuilder
 reload(LibcxxAndAbiBuilder)
 from zorg.buildbot.builders import LibcxxAndAbiBuilder
 
def _get_sanitizer_builders():
            'builddir': "sanitizer-ppc64-1",
            'factory': SanitizerBuilder.getSanitizerBuildFactory()},
 
           {'name': "sanitizer-ppc64le-linux",
            'slavenames' :["sanitizer-ppc64le-linux"],
            'builddir': "sanitizer-ppc64le-1",
            'factory': SanitizerBuilder.getSanitizerBuildFactory()},
 
+          {'name': "sanitizer-windows",
+           'slavenames' :["sanitizer-windows"],
+           'builddir': "sanitizer-windows",
+           'factory': SanitizerBuilderWindows.getSanitizerWindowsBuildFactory()},
+
           ## Cortex-A15 check-all full (compiler-rt) with CMake builder; Needs x86 for ASAN tests
           {'name': "clang-cmake-armv7-a15-full",
            'slavenames':["linaro-a15-03"],
            'builddir':"clang-cmake-armv7-a15-full",
            'factory' : ClangBuilder.getClangCMakeBuildFactory(
                         jobs=4,
                         clean=False,
                         env={'PATH':'/usr/lib/ccache:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin'},

buildbot/osuosl/master/config/slaves.py

32},
         create_slave("ericwf-buildslave", properties={'jobs': 4}, max_builds=2),
         # Ubuntu 14.10 x86_64, Intel(R) Xeon(R) CPU E3-1245 V2 @ 3.40GHz
         create_slave('ericwf-buildslave2', properties={'jobs': 4}, max_builds=2),
         # OS X 10.10 x86_64, Intel Core 2 Duo @ 2.40GHz
         create_slave("ericwf-osx-slave", properties={'jobs': 2}, max_builds=1),
 
         # Windows Server 2008 R2, Quad 2.6GHz Intel Xeon(R) 4GB RAM
         create_slave("zturner-win2008", properties={'jobs': 4}, max_builds=1),
+        # Windows Server 2008 R2, Quad 2.6GHz Intel Xeon(R) 8GB RAM
+        create_slave("sanitizer-windows", properties={'jobs': 4}, max_builds=1),
 
         # Ubuntu x86-64, 51GiB System memory Intel(R) Xeon(R) CPU @ 2.60GHz
         create_slave("lldb-build1-ubuntu-1404", properties={'jobs': 16, 'loadaverage':
 32},
             max_builds=1),
 
         # Defunct.
         # Intel(R) Pentium(R) CPU G620 @ 2.60GHz, Ubuntu i686

zorg/buildbot/builders/LLDBBuilder.py

 import os
 
 import buildbot
 import buildbot.process.factory
 from buildbot.steps.source import SVN
 from buildbot.steps.shell import Configure, SetProperty
 from buildbot.steps.shell import ShellCommand, WarningCountingShellCommand
 from buildbot.steps.slave import RemoveDirectory
 from buildbot.process.properties import WithProperties, Property
 import zorg.buildbot.commands.BatchFileDownload as batch_file_download
 from zorg.buildbot.commands.LitTestCommand import LitTestCommand
-
-def slave_env_glob2list(rc, stdout, stderr):
-    '''Extract function for SetPropertyCommand. Loads Slave Environment
-    into a dictionary, and returns slave_env property for ShellCommands.'''
-    if not rc:
-        slave_env_dict = dict(l.strip().split('=',1)
-            for l in stdout.split('\n') if len(l.split('=',1))==2)
-        return {'slave_env': slave_env_dict}
+from zorg.buildbot.builders.Util import getVisualStudioEnvironment
+from zorg.buildbot.builders.Util import extractSlaveEnvironment
 
 # We *must* checkout at least Clang, LLVM, and LLDB.  Once we add a step to run
 # tests (e.g. ninja check-lldb), we will also need to add a step for LLD, since
 # MSVC LD.EXE cannot link executables with DWARF debug info.
 def getLLDBSource(f,llvmTopDir='llvm'):
     f.addStep(SVN(name='svn-llvm',
                   mode='update', baseURL='http://llvm.org/svn/llvm-project/llvm/',
                   defaultBranch='trunk',
                   workdir=llvmTopDir))
     f.addStep(SVN(name='svn-clang',
                   mode='update', baseURL='http://llvm.org/svn/llvm-project/cfe/',
                   defaultBranch='trunk',
                   workdir='%s/tools/clang' % llvmTopDir))
     f.addStep(SVN(name='svn-lldb',
                   mode='update', baseURL='http://llvm.org/svn/llvm-project/lldb/',
                   defaultBranch='trunk',
                   workdir='%s/tools/lldb' % llvmTopDir))
     return f
 
-def generateVisualStudioEnvironment(vs=r"""%VS120COMNTOOLS%""", target_arch=None):
-    arch_arg = {'x86': 'x86', 'x64': 'amd64', 'amd64': 'amd64'}.get(target_arch, '%PROCESSOR_ARCHITECTURE%')
-
-    vcvars_command = "\"" + "\\".join((vs, '..','..','VC', 'vcvarsall.bat')) + "\""
-    vcvars_command = "%s %s && set" % (vcvars_command, arch_arg)
-    return vcvars_command
-
 # CMake Windows builds
 def getLLDBWindowsCMakeBuildFactory(
             clean=False,
             cmake='cmake',
             jobs="%(jobs)s",
 
             # Source directory containing a built python
             python_source_dir=r'C:/src/python',
 
             # Default values for VS devenv and build configuration
             vs=r"""%VS120COMNTOOLS%""",
             config='Release',
             target_arch='x86',
 
             extra_cmake_args=[],
             test=False,
             install=False):
 
     ############# PREPARING
     f = buildbot.process.factory.BuildFactory()
 
-    vcvars_command = generateVisualStudioEnvironment(vs,target_arch)
     # Determine Slave Environment and Set MSVC environment.
     f.addStep(SetProperty(
-        command=vcvars_command,
-        extract_fn=slave_env_glob2list))
+        command=getVisualStudioEnvironment(vs, target_arch),
+        extract_fn=extractSlaveEnvironment))
 
     f = getLLDBSource(f,'llvm')
 
     build_cmd=['ninja']
     install_cmd = ['ninja','install']
     test_cmd = ['ninja','check-lldb']
 
     if jobs:

zorg/buildbot/builders/SanitizerBuilderWindows.py

+import os
+
+import buildbot
+import buildbot.process.factory
+from buildbot.steps.shell import SetProperty
+from buildbot.steps.shell import ShellCommand
+from buildbot.steps.slave import RemoveDirectory
+from buildbot.steps.source import SVN
+from buildbot.process.properties import Property
+import zorg.buildbot.commands.BatchFileDownload as batch_file_download
+from zorg.buildbot.builders.Util import getVisualStudioEnvironment
+from zorg.buildbot.builders.Util import extractSlaveEnvironment
+
+def getSource(f,llvmTopDir='llvm'):
+    f.addStep(SVN(name='svn-llvm',
+                  mode='update', baseURL='http://llvm.org/svn/llvm-project/llvm/',
+                  defaultBranch='trunk',
+                  workdir=llvmTopDir))
+    f.addStep(SVN(name='svn-clang',
+                  mode='update', baseURL='http://llvm.org/svn/llvm-project/cfe/',
+                  defaultBranch='trunk',
+                  workdir='%s/tools/clang' % llvmTopDir))
+    f.addStep(SVN(name='svn-compiler-rt',
+                  mode='update',
+                  baseURL='http://llvm.org/svn/llvm-project/compiler-rt/',
+                  defaultBranch='trunk',
+                  workdir='%s/tools/compiler-rt' % llvmTopDir))
+    return f
+
+def getSanitizerWindowsBuildFactory(
+            clean=False,
+            cmake='cmake',
+
+            # Source directory containing a built python
+            python_source_dir=r'C:/src/python',
+
+            # Default values for VS devenv and build configuration
+            vs=r"""%VS120COMNTOOLS%""",
+            config='Release',
+            target_arch='x86',
+
+            extra_cmake_args=[],
+            test=False):
+
+    ############# PREPARING
+    f = buildbot.process.factory.BuildFactory()
+
+    # Determine Slave Environment and Set MSVC environment.
+    f.addStep(SetProperty(
+        command=getVisualStudioEnvironment(vs, target_arch),
+        extract_fn=extractSlaveEnvironment))
+
+    f = getLLDBSource(f,'llvm')
+
+
+    # Global configurations
+    build_dir='build'
+
+    ############# CLEANING
+    cleanBuildRequested = lambda step: step.build.getProperty("clean") or clean
+    f.addStep(RemoveDirectory(name='clean '+build_dir,
+                dir=build_dir,
+                haltOnFailure=False,
+                flunkOnFailure=False,
+                doStepIf=cleanBuildRequested
+                ))
+
+    # Use batch files instead of ShellCommand directly, Windows quoting is
+    # borked. FIXME: See buildbot ticket #595 and buildbot ticket #377.
+    f.addStep(batch_file_download.BatchFileDownload(name='cmakegen',
+                                command=[cmake, "-G", "Ninja", "../llvm",
+                                         "-DCMAKE_BUILD_TYPE="+config,
+                                         "-DLLVM_ENABLE_ASSERTIONS=ON"]
+                                         + extra_cmake_args,
+                                workdir=build_dir))
+
+    f.addStep(ShellCommand(name='cmake',
+                           command=['cmakegen.bat'],
+                           haltOnFailure=True,
+                           description='cmake gen',
+                           workdir=build_dir,
+
+    # Build compiler-rt first to speed up detection of Windows-specific
+    # compiler-time errors in the sanitizers runtime.
+    f.addStep(NinjaCommand(name='build compiler-rt',
+                           targets=['compiler-rt'],
+                           haltOnFailure=True,
+                           description='ninja compiler-rt',
+                           workdir=build_dir,
+                           env=Property('slave_env')))
+
+    f.addStep(NinjaCommand(name='build',
+                           haltOnFailure=True,
+                           description='ninja build',
+                           workdir=build_dir,
+                           env=Property('slave_env')))
+
+    test_targets = ['check-asan','check-asan-dynamic','check-sanitizer']
+    ignoreTestFail = bool(test != 'ignoreFail')
+    f.addStep(NinjaCommand(name='run tests',
+                           targets=test_cmd,
+                           flunkOnFailure=ignoreTestFail,
+                           description='ninja test',
+                           workdir=build_dir,
+                           doStepIf=bool(test),
+                           env=Property('slave_env')))
+    
+    return f

zorg/buildbot/builders/Util.py

-
 import buildbot.status.results
 
+def getVisualStudioEnvironment(vs=r"""%VS120COMNTOOLS%""", target_arch=None):
+    arch_arg = {'x86': 'x86', 'x64': 'amd64', 'amd64': 'amd64'}.get(target_arch, '%PROCESSOR_ARCHITECTURE%')
+    vcvars_command = "\"" + "\\".join((vs, '..','..','VC', 'vcvarsall.bat')) + "\""
+    vcvars_command = "%s %s && set" % (vcvars_command, arch_arg)
+    return vcvars_command
+
+def extractSlaveEnvironment(exit_status, stdout, stderr):
+    '''Helper function for SetPropertyCommand. Loads Slave Environment
+    into a dictionary, and returns slave_env property for ShellCommands.'''
+    if exit_status:
+        return {}
+    slave_env_dict = dict(l.strip().split('=',1)
+        for l in stdout.split('\n') if len(l.split('=', 1)) == 2)
+    return {'slave_env': slave_env_dict}
+
 def getConfigArgs(origname):
   name = origname
   args = []
   if name.startswith('Release'):
     name = name[len('Release'):]
     args.append('--enable-optimized')
   elif name.startswith('Debug'):
     name = name[len('Debug'):]