Index: build/toolchain/win/setup_toolchain.py |
diff --git a/build/toolchain/win/setup_toolchain.py b/build/toolchain/win/setup_toolchain.py |
index bc9bd1e7b43bf6fe65f5c34f36ac37aa71442c25..8150d3a4e4ac36873710cca4d8e36a6fc1c93855 100644 |
--- a/build/toolchain/win/setup_toolchain.py |
+++ b/build/toolchain/win/setup_toolchain.py |
@@ -11,11 +11,16 @@ |
# and the files will be written to the current directory. |
import errno |
+import json |
import os |
import re |
import subprocess |
import sys |
+sys.path.append(os.path.join(os.path.dirname(__file__), os.pardir, os.pardir)) |
+import gn_helpers |
+ |
+SCRIPT_DIR = os.path.dirname(__file__) |
def _ExtractImportantEnvironment(output_of_set): |
"""Extracts environment variables required for the toolchain to run from |
@@ -32,42 +37,113 @@ def _ExtractImportantEnvironment(output_of_set): |
'tmp', |
) |
env = {} |
+ # This occasionally happens and leads to misleading SYSTEMROOT error messages |
+ # if not caught here. |
+ if output_of_set.count('=') == 0: |
+ raise Exception('Invalid output_of_set. Value is:\n%s' % output_of_set) |
for line in output_of_set.splitlines(): |
for envvar in envvars_to_save: |
if re.match(envvar + '=', line.lower()): |
var, setting = line.split('=', 1) |
if envvar == 'path': |
- # Our own rules (for running gyp-win-tool) and other actions in |
- # Chromium rely on python being in the path. Add the path to this |
- # python here so that if it's not in the path when ninja is run |
- # later, python will still be found. |
+ # Our own rules and actions in Chromium rely on python being in the |
+ # path. Add the path to this python here so that if it's not in the |
+ # path when ninja is run later, python will still be found. |
setting = os.path.dirname(sys.executable) + os.pathsep + setting |
- env[var.upper()] = setting |
+ env[var.upper()] = setting.lower() |
break |
- for required in ('SYSTEMROOT', 'TEMP', 'TMP'): |
- if required not in env: |
- raise Exception('Environment variable "%s" ' |
- 'required to be set to valid path' % required) |
+ if sys.platform in ('win32', 'cygwin'): |
+ for required in ('SYSTEMROOT', 'TEMP', 'TMP'): |
+ if required not in env: |
+ raise Exception('Environment variable "%s" ' |
+ 'required to be set to valid path' % required) |
return env |
-def _SetupScript(target_cpu, sdk_dir): |
- """Returns a command (with arguments) to be used to set up the |
- environment.""" |
+def _DetectVisualStudioPath(): |
+ """Return path to the GYP_MSVS_VERSION of Visual Studio. |
+ """ |
+ |
+ # Use the code in build/vs_toolchain.py to avoid duplicating code. |
+ chromium_dir = os.path.abspath(os.path.join(SCRIPT_DIR, '..', '..', '..')) |
+ sys.path.append(os.path.join(chromium_dir, 'build')) |
+ import vs_toolchain |
+ return vs_toolchain.DetectVisualStudioPath() |
+ |
+ |
+def _LoadEnvFromBat(args): |
+ """Given a bat command, runs it and returns env vars set by it.""" |
+ args = args[:] |
+ args.extend(('&&', 'set')) |
+ popen = subprocess.Popen( |
+ args, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) |
+ variables, _ = popen.communicate() |
+ if popen.returncode != 0: |
+ raise Exception('"%s" failed with error %d' % (args, popen.returncode)) |
+ return variables |
+ |
+ |
+def _LoadToolchainEnv(cpu, sdk_dir): |
+ """Returns a dictionary with environment variables that must be set while |
+ running binaries from the toolchain (e.g. INCLUDE and PATH for cl.exe).""" |
# Check if we are running in the SDK command line environment and use |
- # the setup script from the SDK if so. |target_cpu| should be either |
+ # the setup script from the SDK if so. |cpu| should be either |
# 'x86' or 'x64'. |
- assert target_cpu in ('x86', 'x64') |
+ assert cpu in ('x86', 'x64') |
if bool(int(os.environ.get('DEPOT_TOOLS_WIN_TOOLCHAIN', 1))) and sdk_dir: |
- return [os.path.normpath(os.path.join(sdk_dir, 'Bin/SetEnv.Cmd')), |
- '/' + target_cpu] |
+ # Load environment from json file. |
+ env = os.path.normpath(os.path.join(sdk_dir, 'bin/SetEnv.%s.json' % cpu)) |
+ env = json.load(open(env))['env'] |
+ for k in env: |
+ entries = [os.path.join(*([os.path.join(sdk_dir, 'bin')] + e)) |
+ for e in env[k]] |
+ # clang-cl wants INCLUDE to be ;-separated even on non-Windows, |
+ # lld-link wants LIB to be ;-separated even on non-Windows. Path gets :. |
+ # The separator for INCLUDE here must match the one used in main() below. |
+ sep = os.pathsep if k == 'PATH' else ';' |
+ env[k] = sep.join(entries) |
+ # PATH is a bit of a special case, it's in addition to the current PATH. |
+ env['PATH'] = env['PATH'] + os.pathsep + os.environ['PATH'] |
+ # Augment with the current env to pick up TEMP and friends. |
+ for k in os.environ: |
+ if k not in env: |
+ env[k] = os.environ[k] |
+ |
+ varlines = [] |
+ for k in sorted(env.keys()): |
+ varlines.append('%s=%s' % (str(k), str(env[k]))) |
+ variables = '\n'.join(varlines) |
+ |
+ # Check that the json file contained the same environment as the .cmd file. |
+ if sys.platform in ('win32', 'cygwin'): |
+ script = os.path.normpath(os.path.join(sdk_dir, 'Bin/SetEnv.cmd')) |
+ assert _ExtractImportantEnvironment(variables) == \ |
+ _ExtractImportantEnvironment(_LoadEnvFromBat([script, '/' + cpu])) |
else: |
+ if 'GYP_MSVS_OVERRIDE_PATH' not in os.environ: |
+ os.environ['GYP_MSVS_OVERRIDE_PATH'] = _DetectVisualStudioPath() |
# We only support x64-hosted tools. |
- # TODO(scottmg|dpranke): Non-depot_tools toolchain: need to get Visual |
- # Studio install location from registry. |
- return [os.path.normpath(os.path.join(os.environ['GYP_MSVS_OVERRIDE_PATH'], |
- 'VC/vcvarsall.bat')), |
- 'amd64_x86' if target_cpu == 'x86' else 'amd64'] |
+ script_path = os.path.normpath(os.path.join( |
+ os.environ['GYP_MSVS_OVERRIDE_PATH'], |
+ 'VC/vcvarsall.bat')) |
+ if not os.path.exists(script_path): |
+ # vcvarsall.bat for VS 2017 fails if run after running vcvarsall.bat from |
+ # VS 2013 or VS 2015. Fix this by clearing the vsinstalldir environment |
+ # variable. |
+ if 'VSINSTALLDIR' in os.environ: |
+ del os.environ['VSINSTALLDIR'] |
+ other_path = os.path.normpath(os.path.join( |
+ os.environ['GYP_MSVS_OVERRIDE_PATH'], |
+ 'VC/Auxiliary/Build/vcvarsall.bat')) |
+ if not os.path.exists(other_path): |
+ raise Exception('%s is missing - make sure VC++ tools are installed.' % |
+ script_path) |
+ script_path = other_path |
+ # Chromium requires the 10.0.14393.0 SDK or higher - previous versions don't |
+ # have all of the required declarations. |
+ args = [script_path, 'amd64_x86' if cpu == 'x86' else 'amd64'] |
+ variables = _LoadEnvFromBat(args) |
+ return _ExtractImportantEnvironment(variables) |
def _FormatAsEnvironmentBlock(envvar_dict): |
@@ -82,73 +158,59 @@ def _FormatAsEnvironmentBlock(envvar_dict): |
return block |
-def _CopyTool(source_path): |
- """Copies the given tool to the current directory, including a warning not |
- to edit it.""" |
- with open(source_path) as source_file: |
- tool_source = source_file.readlines() |
- |
- # Add header and write it out to the current directory (which should be the |
- # root build dir). |
- with open("gyp-win-tool", 'w') as tool_file: |
- tool_file.write(''.join([tool_source[0], |
- '# Generated by setup_toolchain.py do not edit.\n'] |
- + tool_source[1:])) |
- |
- |
def main(): |
- if len(sys.argv) != 6: |
+ if len(sys.argv) != 5: |
print('Usage setup_toolchain.py ' |
- '<visual studio path> <win tool path> <win sdk path> ' |
- '<runtime dirs> <target_cpu>') |
+ '<visual studio path> <win sdk path> ' |
+ '<runtime dirs> <target_cpu> <include prefix>') |
sys.exit(2) |
- tool_source = sys.argv[2] |
- win_sdk_path = sys.argv[3] |
- runtime_dirs = sys.argv[4] |
- target_cpu = sys.argv[5] |
- |
- _CopyTool(tool_source) |
+ win_sdk_path = sys.argv[2] |
+ runtime_dirs = sys.argv[3] |
+ target_cpu = sys.argv[4] |
cpus = ('x86', 'x64') |
assert target_cpu in cpus |
vc_bin_dir = '' |
+ include = '' |
# TODO(scottmg|goma): Do we need an equivalent of |
# ninja_use_custom_environment_files? |
for cpu in cpus: |
# Extract environment variables for subprocesses. |
- args = _SetupScript(cpu, win_sdk_path) |
- args.extend(('&&', 'set')) |
- popen = subprocess.Popen( |
- args, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) |
- variables, _ = popen.communicate() |
- env = _ExtractImportantEnvironment(variables) |
- env['PATH'] = runtime_dirs + ';' + env['PATH'] |
+ env = _LoadToolchainEnv(cpu, win_sdk_path) |
+ env['PATH'] = runtime_dirs + os.pathsep + env['PATH'] |
if cpu == target_cpu: |
for path in env['PATH'].split(os.pathsep): |
if os.path.exists(os.path.join(path, 'cl.exe')): |
vc_bin_dir = os.path.realpath(path) |
break |
+ # The separator for INCLUDE here must match the one used in |
+ # _LoadToolchainEnv() above. |
+ include = [p.replace('"', r'\"') for p in env['INCLUDE'].split(';') if p] |
+ include_I = ' '.join(['"/I' + i + '"' for i in include]) |
+ include_imsvc = ' '.join(['"-imsvc' + i + '"' for i in include]) |
- # The Windows SDK include directories must be first. They both have a sal.h, |
- # and the SDK one is newer and the SDK uses some newer features from it not |
- # present in the Visual Studio one. |
- |
- if win_sdk_path: |
- additional_includes = ('{sdk_dir}\\Include\\shared;' + |
- '{sdk_dir}\\Include\\um;' + |
- '{sdk_dir}\\Include\\winrt;').format( |
- sdk_dir=win_sdk_path) |
- env['INCLUDE'] = additional_includes + env['INCLUDE'] |
env_block = _FormatAsEnvironmentBlock(env) |
with open('environment.' + cpu, 'wb') as f: |
f.write(env_block) |
- assert vc_bin_dir |
- print 'vc_bin_dir = "%s"' % vc_bin_dir |
+ # Create a store app version of the environment. |
+ if 'LIB' in env: |
+ env['LIB'] = env['LIB'] .replace(r'\VC\LIB', r'\VC\LIB\STORE') |
+ if 'LIBPATH' in env: |
+ env['LIBPATH'] = env['LIBPATH'].replace(r'\VC\LIB', r'\VC\LIB\STORE') |
+ env_block = _FormatAsEnvironmentBlock(env) |
+ with open('environment.winrt_' + cpu, 'wb') as f: |
+ f.write(env_block) |
+ assert vc_bin_dir |
+ print 'vc_bin_dir = ' + gn_helpers.ToGNString(vc_bin_dir) |
+ assert include_I |
+ print 'include_flags_I = ' + gn_helpers.ToGNString(include_I) |
+ assert include_imsvc |
+ print 'include_flags_imsvc = ' + gn_helpers.ToGNString(include_imsvc) |
if __name__ == '__main__': |
main() |