Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the visual studio version checking logic #12586

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions tools/cpp/windows_cc_configure.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -254,14 +254,17 @@ def find_vc_path(repository_ctx):
auto_configure_warning_maybe(repository_ctx, "Visual C++ build tools found at %s" % vc_dir)
return vc_dir

def _is_vs_2017_or_2019(vc_path):
"""Check if the installed VS version is Visual Studio 2017."""
def _is_vs_2017_or_2019(repository_ctx, vc_path):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

This check looks much better, according to https://devblogs.microsoft.com/cppblog/compiler-tools-layout-in-visual-studio-15/#where-the-compiler-toolset-moved-to-in-vs-2017, those three directory should always exist for 2017 and later version of Visual C++ Build Tools.

However, since file path is case-insensitive, can you convert all strings to lower case and then do the comparison? Just in case somehow the directory was created with different cases somehow.

"""Check if the installed VS version is Visual Studio 2017 or 2019."""

# In VS 2017 and 2019, the location of VC is like:
# C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\VC\
# In VS 2015 or older version, it is like:
# C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\
return vc_path.find("2017") != -1 or vc_path.find("2019") != -1
# The layout of VC folder in VS 2017 and 2019 is different from that in VS 2015 and older versions.
# In VS 2017 and 2019, it contains only three directories:
# "Auxiliary", "Redist", "Tools"

vc_2017_or_2019_contents = ["auxiliary", "redist", "tools"]
vc_path_contents = [d.basename.lower() for d in repository_ctx.path(vc_path).readdir()]
vc_path_contents = sorted(vc_path_contents)
return vc_path_contents == vc_2017_or_2019_contents

def _is_msbuildtools(vc_path):
"""Check if the installed VC version is from MSBuildTools."""
Expand All @@ -272,7 +275,7 @@ def _is_msbuildtools(vc_path):

def _find_vcvars_bat_script(repository_ctx, vc_path):
"""Find batch script to set up environment variables for VC. Doesn't %-escape the result."""
if _is_vs_2017_or_2019(vc_path):
if _is_vs_2017_or_2019(repository_ctx, vc_path):
vcvars_script = vc_path + "\\Auxiliary\\Build\\VCVARSALL.BAT"
else:
vcvars_script = vc_path + "\\VCVARSALL.BAT"
Expand All @@ -290,7 +293,7 @@ def _is_support_vcvars_ver(vc_full_version):

def _is_support_winsdk_selection(repository_ctx, vc_path):
"""Windows SDK selection is supported with VC 2017 / 2019 or with full VS 2015 installation."""
if _is_vs_2017_or_2019(vc_path):
if _is_vs_2017_or_2019(repository_ctx, vc_path):
return True

# By checking the source code of VCVARSALL.BAT in VC 2015, we know that
Expand All @@ -316,7 +319,7 @@ def _get_vc_env_vars(repository_ctx, vc_path, msvc_vars_x64, target_arch):
dictionary of envvars
"""
env = {}
if _is_vs_2017_or_2019(vc_path):
if _is_vs_2017_or_2019(repository_ctx, vc_path):
lib = msvc_vars_x64["%{msvc_env_lib_x64}"]
full_version = _get_vc_full_version(repository_ctx, vc_path)
tools_path = "%s\\Tools\\MSVC\\%s\\bin\\HostX64\\%s" % (vc_path, full_version, target_arch)
Expand Down Expand Up @@ -360,7 +363,7 @@ def setup_vc_env_vars(repository_ctx, vc_path, envvars = [], allow_empty = False

# Get VC version set by user. Only supports VC 2017 & 2019.
vcvars_ver = ""
if _is_vs_2017_or_2019(vc_path):
if _is_vs_2017_or_2019(repository_ctx, vc_path):
full_version = _get_vc_full_version(repository_ctx, vc_path)

# Because VCVARSALL.BAT is from the latest VC installed, so we check if the latest
Expand Down Expand Up @@ -441,7 +444,7 @@ def _find_msvc_tools(repository_ctx, vc_path, target_arch = "x64"):
def find_msvc_tool(repository_ctx, vc_path, tool, target_arch = "x64"):
"""Find the exact path of a specific build tool in MSVC. Doesn't %-escape the result."""
tool_path = None
if _is_vs_2017_or_2019(vc_path) or _is_msbuildtools(vc_path):
if _is_vs_2017_or_2019(repository_ctx, vc_path) or _is_msbuildtools(vc_path):
full_version = _get_vc_full_version(repository_ctx, vc_path)
if full_version:
tool_path = "%s\\Tools\\MSVC\\%s\\bin\\HostX64\\%s\\%s" % (vc_path, full_version, target_arch, tool)
Expand Down