VS 2017 clang integration

[dtarditi]

Summary

Add support for integrating clang as a platform toolset for Visual Studio 2017.

In prior versions of Visual Studio, MSBuild was installed separately in its own known directory location and the platform toolset information was placed within that direcotry. In VS2017, MSBuild is installed in the VS 2017 directory and the platform toolset information is placed in a different directory within the VS 2017 directory. Use the vswhere program (https://github.com/Microsoft/vswhere) to locate the installation of VS 2017. vswhere is guaranteed to be placed in a known location on a machine, and can then be used to locate VS 2017 installs. With that information we can install the .props and .targets files for MSBuild. These are slightly modified versions of the (misnamed) VS 2014 files.

Visual Studio allows side-by-side installations, including installations of different products (Community, Professional, and Enterprise) with the same version and the same product with the same version. For now, just use the latest version of VS 2017 in the install and uninstall scripts, so we get predictable behavior. We leave it as future work for someone else to deal with side-by-side installs.

Testing: this change is being backported from https://github.com/Microsoft/checkedc-llvm. Other people have tried out the change there and it has worked for them. I locally built a clean version of the Windows LLVM installer with the backported change and tried it out. It worked fine.

[zturner]

I'm not a big fan of the .bat file installation method. For one it's going to require updating again with vs2019, which history shows nobody will ever do, and secondly it's just very hacky and not really the way things shoudl be done. I wrote a patch several months ago which makes a vsix that you can just install from the marketplace.

https://reviews.llvm.org/D42762

Can you try that out and let me know your thoughts?

[dtarditi]

It's great to see your work on Visual Studio extension integration via VSIX. I'm happy to try out your change. I have a few questions:

1. How am I supposed to try this out? Given that actually building a VSIX installer isn't part of this change, what should I do?
2. Have you looked into scripting the VSIX creation? (Yes, I work at Microsoft, but I too am doing compiler development, not working on installers etc.)

[dtarditi]

This is not needed after https://reviews.llvm.org/D42762 was committed. The approach there of using a VSIX package is better than the script-based approach here.

tools/msbuild/CMakeLists.txt

 if (MSVC)
   # CPack will install a registry key in this format that we wish to reference.
   set(REG_KEY "${CPACK_PACKAGE_INSTALL_REGISTRY_KEY}")
   set(LIB_PATH_VERSION "${LLVM_VERSION_MAJOR}.${LLVM_VERSION_MINOR}")
 
   foreach (platform "Win32" "x64")
     set(prop_file_in "Microsoft.Cpp.Win32.llvm.props.in")
     set(prop_file_v100 "Microsoft.Cpp.${platform}.LLVM-vs2010.props")
     set(prop_file_v110 "Microsoft.Cpp.${platform}.LLVM-vs2012.props")
     set(prop_file_v110_xp "Microsoft.Cpp.${platform}.LLVM-vs2012_xp.props")
     set(prop_file_v120 "toolset-vs2013.props")
     set(prop_file_v120_xp "toolset-vs2013_xp.props")
     set(prop_file_v140 "toolset-vs2014.props")
     set(prop_file_v140_xp "toolset-vs2014_xp.props")
+    set(prop_file_v141 "toolset-vs2017.props")
+    set(prop_file_v141_xp "toolset-vs2017_xp.props")
 
     if (platform STREQUAL "Win32")
       set(mflag "m32")
     else()
       set(mflag "m64")
     endif()
     set(VS_VERSION "v100")
     set(MSC_VERSION "1600")
     configure_file(${prop_file_in} ${platform}/${prop_file_v100})
     set(VS_VERSION "v110")
     set(MSC_VERSION "1700")
     configure_file(${prop_file_in} ${platform}/${prop_file_v110})
     set(VS_VERSION "v110_xp")
     configure_file(${prop_file_in} ${platform}/${prop_file_v110_xp})
     set(VS_VERSION "v120")
     set(MSC_VERSION "1800")
     configure_file(${prop_file_in} ${platform}/${prop_file_v120})
     set(VS_VERSION "v120_xp")
     configure_file(${prop_file_in} ${platform}/${prop_file_v120_xp})
     set(VS_VERSION "v140")
     set(MSC_VERSION "1900")
     configure_file(${prop_file_in} ${platform}/${prop_file_v140})
     set(VS_VERSION "v140_xp")
     configure_file(${prop_file_in} ${platform}/${prop_file_v140_xp})
+    set(VS_VERSION "v141")
+    set(MSC_VERSION "1911")
+    configure_file(${prop_file_in} ${platform}/${prop_file_v141})
+    set(VS_VERSION "v141_xp")
+    configure_file(${prop_file_in} ${platform}/${prop_file_v141_xp})
     set(VS_VERSION)
     set(MSC_VERSION)
     set(mflag)
 
     install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${platform}/${prop_file_v100}" DESTINATION tools/msbuild/${platform})
     install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${platform}/${prop_file_v110}" DESTINATION tools/msbuild/${platform})
     install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${platform}/${prop_file_v110_xp}" DESTINATION tools/msbuild/${platform})
     install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${platform}/${prop_file_v120}" DESTINATION tools/msbuild/${platform})
     install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${platform}/${prop_file_v120_xp}" DESTINATION tools/msbuild/${platform})
     install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${platform}/${prop_file_v140}" DESTINATION tools/msbuild/${platform})
     install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${platform}/${prop_file_v140_xp}" DESTINATION tools/msbuild/${platform})
+    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${platform}/${prop_file_v141}" DESTINATION tools/msbuild/${platform})
+    install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${platform}/${prop_file_v141_xp}" DESTINATION tools/msbuild/${platform})
 
     install(FILES "Microsoft.Cpp.Win32.LLVM-vs2010.targets" DESTINATION "tools/msbuild/${platform}" RENAME "Microsoft.Cpp.${platform}.LLVM-vs2010.targets")
     install(FILES "Microsoft.Cpp.Win32.LLVM-vs2012.targets" DESTINATION "tools/msbuild/${platform}" RENAME "Microsoft.Cpp.${platform}.LLVM-vs2012.targets")
     install(FILES "Microsoft.Cpp.Win32.LLVM-vs2012_xp.targets" DESTINATION "tools/msbuild/${platform}" RENAME "Microsoft.Cpp.${platform}.LLVM-vs2012_xp.targets")
     install(FILES "toolset-vs2013.targets" DESTINATION "tools/msbuild/${platform}")
     install(FILES "toolset-vs2013_xp.targets" DESTINATION "tools/msbuild/${platform}")
     install(FILES "toolset-vs2014.targets" DESTINATION "tools/msbuild/${platform}")
     install(FILES "toolset-vs2014_xp.targets" DESTINATION "tools/msbuild/${platform}")
+    install(FILES "toolset-vs2017.targets" DESTINATION "tools/msbuild/${platform}")
+    install(FILES "toolset-vs2017_xp.targets" DESTINATION "tools/msbuild/${platform}")
   endforeach()
 
   set(LIB_PATH_VERSION)
   set(REG_KEY)
 
   install(DIRECTORY .
     DESTINATION tools/msbuild
     FILES_MATCHING
     PATTERN "*.bat"
     PATTERN ".svn" EXCLUDE
     )
 endif()

tools/msbuild/install.bat

 :TRY_V140
 SET D="%ProgramFiles%\MSBuild\Microsoft.Cpp\v4.0\V140\Platforms\%PLATFORM%\PlatformToolsets"
 IF EXIST %D% GOTO FOUND_V140
 SET D="%ProgramFiles(x86)%\MSBuild\Microsoft.Cpp\v4.0\V140\Platforms\%PLATFORM%\PlatformToolsets"
 IF EXIST %D% GOTO FOUND_V140
 
 :TRY_V150
 
+REM MSBuild is now under the Visual Studio installation.  VSWhere is a new executable placed in a known
+REM location that can be used to find the VS installation, starting with VS 2017 SP1
+IF EXIST "%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe" (
+  FOR /f "usebackq delims=" %%i IN (`"%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe" -prerelease -latest -version 15 -property installationPath`) DO (
+    SET D="%%i\Common7\IDE\VC\VCTargets\Platforms\%PLATFORM%\PlatformToolsets"
+  )
+)
+REM On 32-bit Windows OSes before Windows 10, vswhere will be installed under %ProgramFiles%
+IF EXIST "%ProgramFiles%\Microsoft Visual Studio\Installer\vswhere.exe" (
+  FOR /f "usebackq delims=" %%i IN (`"%ProgramFiles%\Microsoft Visual Studio\Installer\vswhere.exe" -prerelease -latest -version 15 -property installationPath`) DO (
+    SET D="%%i\Common7\IDE\VC\VCTargets\Platforms\%PLATFORM%\PlatformToolsets"
+  )
+)
+if EXIST %D% GOTO FOUND_V150
+
 GOTO PLATFORMLOOPHEAD
 
 :PLATFORMLOOPEND
 IF %SUCCESS% == 1 goto DONE
 echo Failed to find MSBuild toolsets directory.
 goto FAILED
 
 

 IF NOT %ERRORLEVEL% == 0 GOTO FAILED
 copy %PLATFORM%\toolset-vs2014_xp.props %D%\LLVM-vs2014_xp\toolset.props
 IF NOT %ERRORLEVEL% == 0 GOTO FAILED
 copy %PLATFORM%\toolset-vs2014_xp.targets %D%\LLVM-vs2014_xp\toolset.targets
 IF NOT %ERRORLEVEL% == 0 GOTO FAILED
 set SUCCESS=1
 GOTO TRY_V150
 
+:FOUND_V150
+REM Routine for installing v150 toolchain.
+IF NOT EXIST %D%\LLVM-vs2017 mkdir %D%\LLVM-vs2017
+IF NOT %ERRORLEVEL% == 0 GOTO FAILED
+copy %PLATFORM%\toolset-vs2017.props %D%\LLVM-vs2017\toolset.props
+IF NOT %ERRORLEVEL% == 0 GOTO FAILED
+copy %PLATFORM%\toolset-vs2017.targets %D%\LLVM-vs2017\toolset.targets
+IF NOT %ERRORLEVEL% == 0 GOTO FAILED
+IF NOT EXIST %D%\LLVM-vs2017_xp mkdir %D%\LLVM-vs2017_xp
+IF NOT %ERRORLEVEL% == 0 GOTO FAILED
+copy %PLATFORM%\toolset-vs2017_xp.props %D%\LLVM-vs2017_xp\toolset.props
+IF NOT %ERRORLEVEL% == 0 GOTO FAILED
+copy %PLATFORM%\toolset-vs2017_xp.targets %D%\LLVM-vs2017_xp\toolset.targets
+IF NOT %ERRORLEVEL% == 0 GOTO FAILED
+set SUCCESS=1
 
 :DONE
 echo Done!
 goto END
 
 :FAILED
 echo MSVC integration install failed.
 pause
 goto END
 
 :END

tools/msbuild/toolset-vs2017.targets

+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <Import Project="$(VCTargetsPath)\Microsoft.CppCommon.targets" />
+</Project>

tools/msbuild/toolset-vs2017_xp.targets

+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <!-- Force TargetFrameworkVersion to v4.0 to support XP-->
+  <PropertyGroup>
+    <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
+    <BeforeClCompileTargets>NoSupportCodeAnalysisXP;$(BeforeClCompileTargets)</BeforeClCompileTargets>
+  </PropertyGroup>
+
+  <Import Project="$(VCTargetsPath)\Microsoft.CppCommon.targets" />
+
+  <Target Name="NoSupportCodeAnalysisXP" Condition="'$(ErrorNoSupportCodeAnalysisXP)' != 'false'">
+    <VCMessage Condition="'$(DesignTimeBuild)' != 'true' and '@(ClCompile->AnyHaveMetadataValue('EnablePREfast', 'true'))'=='true'" Code="MSB8026" Type="Error"/>
+  </Target>
+
+  <PropertyGroup>
+    <PrepareForBuildDependsOn>CheckWindowsSDK71A;$(PrepareForBuildDependsOn)</PrepareForBuildDependsOn>
+  </PropertyGroup>
+
+  <Target Name="CheckWindowsSDK71A">
+    <VCMessage Code="MSB8003" Type="Warning" Arguments="WindowsSdkDir_71A" Condition="'$(WindowsSdkDir_71A)'=='' and '$(UseEnv)' != 'true'" />
+  </Target>
+</Project>

tools/msbuild/uninstall.bat

 SET D="%ProgramFiles(x86)%\MSBuild\Microsoft.Cpp\v4.0\V140\Platforms\%PLATFORM%\PlatformToolsets"
 IF EXIST %D%\LLVM-vs2014 del %D%\LLVM-vs2014\toolset.props
 IF EXIST %D%\LLVM-vs2014 del %D%\LLVM-vs2014\toolset.targets
 IF EXIST %D%\LLVM-vs2014 rmdir %D%\LLVM-vs2014
 IF EXIST %D%\LLVM-vs2014_xp del %D%\LLVM-vs2014_xp\toolset.props
 IF EXIST %D%\LLVM-vs2014_xp del %D%\LLVM-vs2014_xp\toolset.targets
 IF EXIST %D%\LLVM-vs2014_xp rmdir %D%\LLVM-vs2014_xp
 
+REM MSBuild is now under the Visual Studio installation.  VSWhere is a new executable placed in a known
+REM location that can be used to find the VS installation, starting with VS 2017 SP1
+IF EXIST "%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe" (
+  FOR /f "usebackq delims=" %%i IN (`"%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe" -latest -prerelease -version 15 -property installationPath`) DO (
+    SET D="%%i\Common7\IDE\VC\VCTargets\Platforms\%PLATFORM%\PlatformToolsets"
+  )
+)
+
+REM On 32-bit Windows OSes before Windows 10, vswhere will be installed under %ProgramFiles%
+IF EXIST "%ProgramFiles%\Microsoft Visual Studio\Installer\vswhere.exe" (
+  FOR /f "usebackq delims=" %%i IN (`"%ProgramFiles%\Microsoft Visual Studio\Installer\vswhere.exe" -latest -prerelease -version 15 -property installationPath`) DO (
+    SET D="%%i\Common7\IDE\VC\VCTargets\Platforms\%PLATFORM%\PlatformToolsets"
+  )
+)
+IF EXIST %D%\LLVM-vs2017 del %D%\LLVM-vs2017\toolset.props
+IF EXIST %D%\LLVM-vs2017 del %D%\LLVM-vs2017\toolset.targets
+IF EXIST %D%\LLVM-vs2017 rmdir %D%\LLVM-vs2017
+IF EXIST %D%\LLVM-vs2017_xp del %D%\LLVM-vs2017_xp\toolset.props
+IF EXIST %D%\LLVM-vs2017_xp del %D%\LLVM-vs2017_xp\toolset.targets
+IF EXIST %D%\LLVM-vs2017_xp rmdir %D%\LLVM-vs2017_xp
 
 GOTO LOOPHEAD
 
 :LOOPEND
 echo Done!

utils/lit/lit/TestingConfig.py

def fromdefaults(litConfig):
             # ('') for OS's such as OpenBSD.
             if val:
                 environment[var] = val
 
         if sys.platform == 'win32':
             environment.update({
                     'INCLUDE' : os.environ.get('INCLUDE',''),
                     'PATHEXT' : os.environ.get('PATHEXT',''),
+                    'PROGRAMDATA' : os.environ.get('PROGRAMDATA',''),
                     'PYTHONUNBUFFERED' : '1',
                     'TEMP' : os.environ.get('TEMP',''),
                     'TMP' : os.environ.get('TMP',''),
                     })
 
         # Set the default available features based on the LitConfig.
         available_features = []
         if litConfig.useValgrind: