mirror of
https://github.com/pytorch/pytorch.git
synced 2025-10-20 21:14:14 +08:00
ff9d508b88
Summary: Except for the Windows default path, everything it does has been done in FindCUDA.cmake. Search for nvcc in path has been added to FindCUDA.cmake (https://github.com/pytorch/pytorch/issues/29160). The Windows default path part is moved to build_pytorch_libs.py. CUDA_HOME is kept for now because other parts of the build system is still using it. Pull Request resolved: https://github.com/pytorch/pytorch/pull/28617 Differential Revision: D18347814 Pulled By: ezyang fbshipit-source-id: 22bb7eccc17b559ce3efc1ca964e3fbb270b5b0f
349 lines
15 KiB
Python
349 lines
15 KiB
Python
"Manages CMake."
|
|
|
|
from __future__ import print_function
|
|
|
|
import multiprocessing
|
|
import os
|
|
import re
|
|
from subprocess import check_call, check_output
|
|
import sys
|
|
import distutils
|
|
import distutils.sysconfig
|
|
from distutils.version import LooseVersion
|
|
|
|
from . import which
|
|
from .env import (BUILD_DIR, IS_64BIT, IS_DARWIN, IS_WINDOWS, check_negative_env_flag)
|
|
from .numpy_ import USE_NUMPY, NUMPY_INCLUDE_DIR
|
|
|
|
|
|
def _mkdir_p(d):
|
|
try:
|
|
os.makedirs(d)
|
|
except OSError:
|
|
pass
|
|
|
|
|
|
# Ninja
|
|
# Use ninja if it is on the PATH. Previous version of PyTorch required the
|
|
# ninja python package, but we no longer use it, so we do not have to import it
|
|
USE_NINJA = (not check_negative_env_flag('USE_NINJA') and
|
|
which('ninja') is not None)
|
|
|
|
def convert_cmake_value_to_python_value(cmake_value, cmake_type):
|
|
r"""Convert a CMake value in a string form to a Python value.
|
|
|
|
Arguments:
|
|
cmake_value (string): The CMake value in a string form (e.g., "ON", "OFF", "1").
|
|
cmake_type (string): The CMake type of :attr:`cmake_value`.
|
|
|
|
Returns:
|
|
A Python value corresponding to :attr:`cmake_value` with type :attr:`cmake_type`.
|
|
"""
|
|
|
|
cmake_type = cmake_type.upper()
|
|
up_val = cmake_value.upper()
|
|
if cmake_type == 'BOOL':
|
|
# https://gitlab.kitware.com/cmake/community/wikis/doc/cmake/VariablesListsStrings#boolean-values-in-cmake
|
|
return not (up_val in ('FALSE', 'OFF', 'N', 'NO', '0', '', 'NOTFOUND') or up_val.endswith('-NOTFOUND'))
|
|
elif cmake_type == 'FILEPATH':
|
|
if up_val.endswith('-NOTFOUND'):
|
|
return None
|
|
else:
|
|
return cmake_value
|
|
else: # Directly return the cmake_value.
|
|
return cmake_value
|
|
|
|
def get_cmake_cache_variables_from_file(cmake_cache_file):
|
|
r"""Gets values in CMakeCache.txt into a dictionary.
|
|
|
|
Arguments:
|
|
cmake_cache_file: A CMakeCache.txt file object.
|
|
Returns:
|
|
dict: A ``dict`` containing the value of cached CMake variables.
|
|
"""
|
|
|
|
results = dict()
|
|
for i, line in enumerate(cmake_cache_file, 1):
|
|
line = line.strip()
|
|
if not line or line.startswith(('#', '//')):
|
|
# Blank or comment line, skip
|
|
continue
|
|
|
|
# Almost any character can be part of variable name and value. As a practical matter, we assume the type must be
|
|
# valid if it were a C variable name. It should match the following kinds of strings:
|
|
#
|
|
# USE_CUDA:BOOL=ON
|
|
# "USE_CUDA":BOOL=ON
|
|
# USE_CUDA=ON
|
|
# USE_CUDA:=ON
|
|
# Intel(R) MKL-DNN_SOURCE_DIR:STATIC=/path/to/pytorch/third_party/ideep/mkl-dnn
|
|
# "OpenMP_COMPILE_RESULT_CXX_openmp:experimental":INTERNAL=FALSE
|
|
matched = re.match(r'("?)(.+?)\1(?::\s*([a-zA-Z_-][a-zA-Z0-9_-]*)?)?\s*=\s*(.*)', line)
|
|
if matched is None: # Illegal line
|
|
raise ValueError('Unexpected line {} in {}: {}'.format(i, repr(cmake_cache_file), line))
|
|
_, variable, type_, value = matched.groups()
|
|
if type_ is None:
|
|
type_ = ''
|
|
if type_.upper() in ('INTERNAL', 'STATIC'):
|
|
# CMake internal variable, do not touch
|
|
continue
|
|
results[variable] = convert_cmake_value_to_python_value(value, type_)
|
|
|
|
return results
|
|
|
|
class CMake:
|
|
"Manages cmake."
|
|
|
|
def __init__(self, build_dir=BUILD_DIR):
|
|
self._cmake_command = CMake._get_cmake_command()
|
|
self.build_dir = build_dir
|
|
|
|
@property
|
|
def _cmake_cache_file(self):
|
|
r"""Returns the path to CMakeCache.txt.
|
|
|
|
Returns:
|
|
string: The path to CMakeCache.txt.
|
|
"""
|
|
return os.path.join(self.build_dir, 'CMakeCache.txt')
|
|
|
|
@staticmethod
|
|
def _get_cmake_command():
|
|
"Returns cmake command."
|
|
|
|
cmake_command = 'cmake'
|
|
if IS_WINDOWS:
|
|
return cmake_command
|
|
cmake3 = which('cmake3')
|
|
if cmake3 is not None:
|
|
cmake = which('cmake')
|
|
if cmake is not None:
|
|
bare_version = CMake._get_version(cmake)
|
|
if (bare_version < LooseVersion("3.5.0") and
|
|
CMake._get_version(cmake3) > bare_version):
|
|
cmake_command = 'cmake3'
|
|
return cmake_command
|
|
|
|
@staticmethod
|
|
def _get_version(cmd):
|
|
"Returns cmake version."
|
|
|
|
for line in check_output([cmd, '--version']).decode('utf-8').split('\n'):
|
|
if 'version' in line:
|
|
return LooseVersion(line.strip().split(' ')[2])
|
|
raise RuntimeError('no version found')
|
|
|
|
def run(self, args, env):
|
|
"Executes cmake with arguments and an environment."
|
|
|
|
command = [self._cmake_command] + args
|
|
print(' '.join(command))
|
|
check_call(command, cwd=self.build_dir, env=env)
|
|
|
|
@staticmethod
|
|
def defines(args, **kwargs):
|
|
"Adds definitions to a cmake argument list."
|
|
for key, value in sorted(kwargs.items()):
|
|
if value is not None:
|
|
args.append('-D{}={}'.format(key, value))
|
|
|
|
def get_cmake_cache_variables(self):
|
|
r"""Gets values in CMakeCache.txt into a dictionary.
|
|
Returns:
|
|
dict: A ``dict`` containing the value of cached CMake variables.
|
|
"""
|
|
with open(self._cmake_cache_file) as f:
|
|
return get_cmake_cache_variables_from_file(f)
|
|
|
|
def generate(self, version, cmake_python_library, build_python, build_test, my_env, rerun):
|
|
"Runs cmake to generate native build files."
|
|
|
|
if rerun and os.path.isfile(self._cmake_cache_file):
|
|
os.remove(self._cmake_cache_file)
|
|
ninja_build_file = os.path.join(self.build_dir, 'build.ninja')
|
|
if os.path.exists(self._cmake_cache_file) and not (
|
|
USE_NINJA and not os.path.exists(ninja_build_file)):
|
|
# Everything's in place. Do not rerun.
|
|
return
|
|
|
|
args = []
|
|
if USE_NINJA:
|
|
args.append('-GNinja')
|
|
elif IS_WINDOWS:
|
|
generator = os.getenv('CMAKE_GENERATOR', 'Visual Studio 15 2017')
|
|
supported = ['Visual Studio 15 2017', 'Visual Studio 16 2019']
|
|
if generator not in supported:
|
|
print('Unsupported `CMAKE_GENERATOR`: ' + generator)
|
|
print('Please set it to one of the following values: ')
|
|
print('\n'.join(supported))
|
|
sys.exit(1)
|
|
args.append('-G' + generator)
|
|
toolset_dict = {}
|
|
toolset_version = os.getenv('CMAKE_GENERATOR_TOOLSET_VERSION')
|
|
if toolset_version is not None:
|
|
toolset_dict['version'] = toolset_version
|
|
curr_toolset = os.getenv('VCToolsVersion')
|
|
if curr_toolset is None:
|
|
print('When you specify `CMAKE_GENERATOR_TOOLSET_VERSION`, you must also '
|
|
'activate the vs environment of this version. Please read the notes '
|
|
'in the build steps carefully.')
|
|
sys.exit(1)
|
|
if IS_64BIT:
|
|
args.append('-Ax64')
|
|
toolset_dict['host'] = 'x64'
|
|
if toolset_dict:
|
|
toolset_expr = ','.join(["{}={}".format(k, v) for k, v in toolset_dict.items()])
|
|
args.append('-T' + toolset_expr)
|
|
|
|
base_dir = os.path.dirname(os.path.dirname(os.path.dirname(
|
|
os.path.abspath(__file__))))
|
|
install_dir = os.path.join(base_dir, "torch")
|
|
|
|
_mkdir_p(install_dir)
|
|
_mkdir_p(self.build_dir)
|
|
|
|
# Store build options that are directly stored in environment variables
|
|
build_options = {
|
|
# The default value cannot be easily obtained in CMakeLists.txt. We set it here.
|
|
'CMAKE_PREFIX_PATH': distutils.sysconfig.get_python_lib()
|
|
}
|
|
# Build options that do not start with "BUILD_", "USE_", or "CMAKE_" and are directly controlled by env vars.
|
|
# This is a dict that maps environment variables to the corresponding variable name in CMake.
|
|
additional_options = {
|
|
# Key: environment variable name. Value: Corresponding variable name to be passed to CMake. If you are
|
|
# adding a new build option to this block: Consider making these two names identical and adding this option
|
|
# in the block below.
|
|
'_GLIBCXX_USE_CXX11_ABI': 'GLIBCXX_USE_CXX11_ABI',
|
|
'CUDNN_LIB_DIR': 'CUDNN_LIBRARY',
|
|
'USE_CUDA_STATIC_LINK': 'CAFFE2_STATIC_LINK_CUDA',
|
|
'USE_GLOO_IBVERBS': 'USE_IBVERBS' # Backward compatibility. Will be removed in the future.
|
|
}
|
|
additional_options.update({
|
|
# Build options that have the same environment variable name and CMake variable name and that do not start
|
|
# with "BUILD_", "USE_", or "CMAKE_". If you are adding a new build option, also make sure you add it to
|
|
# CMakeLists.txt.
|
|
var: var for var in
|
|
('BLAS',
|
|
'BUILDING_WITH_TORCH_LIBS',
|
|
'CUDA_NVCC_EXECUTABLE',
|
|
'CUDNN_LIBRARY',
|
|
'CUDNN_INCLUDE_DIR',
|
|
'EXPERIMENTAL_SINGLE_THREAD_POOL',
|
|
'INSTALL_TEST',
|
|
'MKL_THREADING',
|
|
'MKLDNN_THREADING',
|
|
'MSVC_Z7_OVERRIDE',
|
|
'ONNX_ML',
|
|
'ONNX_NAMESPACE',
|
|
'ATEN_THREADING',
|
|
'WERROR')
|
|
})
|
|
|
|
if 'USE_GLOO_IBVERBS' in my_env:
|
|
print("WARNING: USE_GLOO_IBVERBS is deprecated. Use USE_IBVERBS instead.")
|
|
|
|
for var, val in my_env.items():
|
|
# We currently pass over all environment variables that start with "BUILD_", "USE_", and "CMAKE_". This is
|
|
# because we currently have no reliable way to get the list of all build options we have specified in
|
|
# CMakeLists.txt. (`cmake -L` won't print dependent options when the dependency condition is not met.) We
|
|
# will possibly change this in the future by parsing CMakeLists.txt ourselves (then additional_options would
|
|
# also not be needed to be specified here).
|
|
true_var = additional_options.get(var)
|
|
if true_var is not None:
|
|
build_options[true_var] = val
|
|
elif var.startswith(('BUILD_', 'USE_', 'CMAKE_')):
|
|
build_options[var] = val
|
|
|
|
# Some options must be post-processed. Ideally, this list will be shrunk to only one or two options in the
|
|
# future, as CMake can detect many of these libraries pretty comfortably. We have them here for now before CMake
|
|
# integration is completed. They appear here not in the CMake.defines call below because they start with either
|
|
# "BUILD_" or "USE_" and must be overwritten here.
|
|
build_options.update({
|
|
# Note: Do not add new build options to this dict if it is directly read from environment variable -- you
|
|
# only need to add one in `CMakeLists.txt`. All build options that start with "BUILD_", "USE_", or "CMAKE_"
|
|
# are automatically passed to CMake; For other options you can add to additional_options above.
|
|
'BUILD_PYTHON': build_python,
|
|
'BUILD_TEST': build_test,
|
|
'USE_NUMPY': USE_NUMPY,
|
|
})
|
|
|
|
# Options starting with CMAKE_
|
|
cmake__options = {
|
|
'CMAKE_INSTALL_PREFIX': install_dir,
|
|
}
|
|
|
|
# We set some CMAKE_* options in our Python build code instead of relying on the user's direct settings. Emit an
|
|
# error if the user also attempts to set these CMAKE options directly.
|
|
specified_cmake__options = set(build_options).intersection(cmake__options)
|
|
if len(specified_cmake__options) > 0:
|
|
print(', '.join(specified_cmake__options) +
|
|
' should not be specified in the environment variable. They are directly set by PyTorch build script.')
|
|
sys.exit(1)
|
|
build_options.update(cmake__options)
|
|
|
|
CMake.defines(args,
|
|
PYTHON_EXECUTABLE=sys.executable,
|
|
PYTHON_LIBRARY=cmake_python_library,
|
|
PYTHON_INCLUDE_DIR=distutils.sysconfig.get_python_inc(),
|
|
TORCH_BUILD_VERSION=version,
|
|
NUMPY_INCLUDE_DIR=NUMPY_INCLUDE_DIR,
|
|
**build_options)
|
|
|
|
expected_wrapper = '/usr/local/opt/ccache/libexec'
|
|
if IS_DARWIN and os.path.exists(expected_wrapper):
|
|
if 'CMAKE_C_COMPILER' not in build_options and 'CC' not in os.environ:
|
|
CMake.defines(args, CMAKE_C_COMPILER="{}/gcc".format(expected_wrapper))
|
|
if 'CMAKE_CXX_COMPILER' not in build_options and 'CXX' not in os.environ:
|
|
CMake.defines(args, CMAKE_CXX_COMPILER="{}/g++".format(expected_wrapper))
|
|
|
|
for env_var_name in my_env:
|
|
if env_var_name.startswith('gh'):
|
|
# github env vars use utf-8, on windows, non-ascii code may
|
|
# cause problem, so encode first
|
|
try:
|
|
my_env[env_var_name] = str(my_env[env_var_name].encode("utf-8"))
|
|
except UnicodeDecodeError as e:
|
|
shex = ':'.join('{:02x}'.format(ord(c)) for c in my_env[env_var_name])
|
|
print('Invalid ENV[{}] = {}'.format(env_var_name, shex), file=sys.stderr)
|
|
print(e, file=sys.stderr)
|
|
# According to the CMake manual, we should pass the arguments first,
|
|
# and put the directory as the last element. Otherwise, these flags
|
|
# may not be passed correctly.
|
|
# Reference:
|
|
# 1. https://cmake.org/cmake/help/latest/manual/cmake.1.html#synopsis
|
|
# 2. https://stackoverflow.com/a/27169347
|
|
args.append(base_dir)
|
|
self.run(args, env=my_env)
|
|
|
|
def build(self, my_env):
|
|
"Runs cmake to build binaries."
|
|
|
|
from .env import build_type
|
|
|
|
max_jobs = os.getenv('MAX_JOBS', str(multiprocessing.cpu_count()))
|
|
build_args = ['--build', '.', '--target', 'install', '--config', build_type.build_type_string]
|
|
# This ``if-else'' clause would be unnecessary when cmake 3.12 becomes
|
|
# minimum, which provides a '-j' option: build_args += ['-j', max_jobs]
|
|
# would be sufficient by then.
|
|
if IS_WINDOWS and not USE_NINJA: # We are likely using msbuild here
|
|
build_args += ['--', '/maxcpucount:{}'.format(max_jobs)]
|
|
else:
|
|
build_args += ['--', '-j', max_jobs]
|
|
self.run(build_args, my_env)
|
|
|
|
# in cmake, .cu compilation involves generating certain intermediates
|
|
# such as .cu.o and .cu.depend, and these intermediates finally get compiled
|
|
# into the final .so.
|
|
# Ninja updates build.ninja's timestamp after all dependent files have been built,
|
|
# and re-kicks cmake on incremental builds if any of the dependent files
|
|
# have a timestamp newer than build.ninja's timestamp.
|
|
# There is a cmake bug with the Ninja backend, where the .cu.depend files
|
|
# are still compiling by the time the build.ninja timestamp is updated,
|
|
# so the .cu.depend file's newer timestamp is screwing with ninja's incremental
|
|
# build detector.
|
|
# This line works around that bug by manually updating the build.ninja timestamp
|
|
# after the entire build is finished.
|
|
ninja_build_file = os.path.join(self.build_dir, 'build.ninja')
|
|
if os.path.exists(ninja_build_file):
|
|
os.utime(ninja_build_file, None)
|