mirror of
https://github.com/ROCm/ROCm.git
synced 2026-02-21 03:00:39 -05:00
9bf9c20f30
- Note `wheel` as a build-time dependency. - Add tips for getting a faster build. - Add instructions for running tests. - Add flag to build with ccache. (Thanks to @ThomasRaoux for most of these instructions!)
357 lines
13 KiB
Python
357 lines
13 KiB
Python
import os
|
|
import platform
|
|
import re
|
|
import shutil
|
|
import subprocess
|
|
import sys
|
|
import sysconfig
|
|
import tarfile
|
|
import tempfile
|
|
import urllib.request
|
|
from distutils.command.clean import clean
|
|
from pathlib import Path
|
|
from typing import NamedTuple
|
|
|
|
from setuptools import Extension, setup
|
|
from setuptools.command.build_ext import build_ext
|
|
from setuptools.command.build_py import build_py
|
|
|
|
|
|
# Taken from https://github.com/pytorch/pytorch/blob/master/tools/setup_helpers/env.py
|
|
def check_env_flag(name: str, default: str = "") -> bool:
|
|
return os.getenv(name, default).upper() in ["ON", "1", "YES", "TRUE", "Y"]
|
|
|
|
|
|
def get_build_type():
|
|
if check_env_flag("DEBUG"):
|
|
return "Debug"
|
|
elif check_env_flag("REL_WITH_DEB_INFO"):
|
|
return "RelWithDebInfo"
|
|
elif check_env_flag("TRITON_REL_BUILD_WITH_ASSERTS"):
|
|
return "TritonRelBuildWithAsserts"
|
|
else:
|
|
# TODO: change to release when stable enough
|
|
return "TritonRelBuildWithAsserts"
|
|
|
|
|
|
def get_codegen_backends():
|
|
backends = []
|
|
env_prefix = "TRITON_CODEGEN_"
|
|
for name, _ in os.environ.items():
|
|
if name.startswith(env_prefix) and check_env_flag(name):
|
|
assert name.count(env_prefix) <= 1
|
|
backends.append(name.replace(env_prefix, '').lower())
|
|
return backends
|
|
|
|
|
|
# --- third party packages -----
|
|
|
|
|
|
class Package(NamedTuple):
|
|
package: str
|
|
name: str
|
|
url: str
|
|
include_flag: str
|
|
lib_flag: str
|
|
syspath_var_name: str
|
|
|
|
# pybind11
|
|
|
|
|
|
def get_pybind11_package_info():
|
|
name = "pybind11-2.11.1"
|
|
url = "https://github.com/pybind/pybind11/archive/refs/tags/v2.11.1.tar.gz"
|
|
return Package("pybind11", name, url, "PYBIND11_INCLUDE_DIR", "", "PYBIND11_SYSPATH")
|
|
|
|
# llvm
|
|
|
|
|
|
def get_llvm_package_info():
|
|
# added statement for Apple Silicon
|
|
system = platform.system()
|
|
arch = platform.machine()
|
|
if arch == 'aarch64':
|
|
arch = 'arm64'
|
|
if system == "Darwin":
|
|
system_suffix = "apple-darwin"
|
|
arch = platform.machine()
|
|
elif system == "Linux":
|
|
vglibc = tuple(map(int, platform.libc_ver()[1].split('.')))
|
|
vglibc = vglibc[0] * 100 + vglibc[1]
|
|
linux_suffix = 'ubuntu-18.04' if vglibc > 217 else 'centos-7'
|
|
system_suffix = f"linux-gnu-{linux_suffix}"
|
|
else:
|
|
return Package("llvm", "LLVM-C.lib", "", "LLVM_INCLUDE_DIRS", "LLVM_LIBRARY_DIR", "LLVM_SYSPATH")
|
|
use_assert_enabled_llvm = check_env_flag("TRITON_USE_ASSERT_ENABLED_LLVM", "False")
|
|
release_suffix = "assert" if use_assert_enabled_llvm else "release"
|
|
name = f'llvm+mlir-17.0.0-{arch}-{system_suffix}-{release_suffix}'
|
|
version = "llvm-17.0.0-c5dede880d17"
|
|
url = f"https://github.com/ptillet/triton-llvm-releases/releases/download/{version}/{name}.tar.xz"
|
|
# FIXME: remove the following once github.com/ptillet/triton-llvm-releases has arm64 llvm releases
|
|
if arch == 'arm64' and 'linux' in system_suffix:
|
|
url = f"https://github.com/acollins3/triton-llvm-releases/releases/download/{version}/{name}.tar.xz"
|
|
return Package("llvm", name, url, "LLVM_INCLUDE_DIRS", "LLVM_LIBRARY_DIR", "LLVM_SYSPATH")
|
|
|
|
|
|
def get_thirdparty_packages(triton_cache_path):
|
|
packages = [get_pybind11_package_info(), get_llvm_package_info()]
|
|
thirdparty_cmake_args = []
|
|
for p in packages:
|
|
package_root_dir = os.path.join(triton_cache_path, p.package)
|
|
package_dir = os.path.join(package_root_dir, p.name)
|
|
if p.syspath_var_name in os.environ:
|
|
package_dir = os.environ[p.syspath_var_name]
|
|
version_file_path = os.path.join(package_dir, "version.txt")
|
|
if p.syspath_var_name not in os.environ and\
|
|
(not os.path.exists(version_file_path) or Path(version_file_path).read_text() != p.url):
|
|
try:
|
|
shutil.rmtree(package_root_dir)
|
|
except Exception:
|
|
pass
|
|
os.makedirs(package_root_dir, exist_ok=True)
|
|
print(f'downloading and extracting {p.url} ...')
|
|
ftpstream = urllib.request.urlopen(p.url)
|
|
file = tarfile.open(fileobj=ftpstream, mode="r|*")
|
|
file.extractall(path=package_root_dir)
|
|
# write version url to package_dir
|
|
with open(os.path.join(package_dir, "version.txt"), "w") as f:
|
|
f.write(p.url)
|
|
if p.include_flag:
|
|
thirdparty_cmake_args.append(f"-D{p.include_flag}={package_dir}/include")
|
|
if p.lib_flag:
|
|
thirdparty_cmake_args.append(f"-D{p.lib_flag}={package_dir}/lib")
|
|
return thirdparty_cmake_args
|
|
|
|
# ---- package data ---
|
|
|
|
|
|
def download_and_copy(src_path, version, url_func):
|
|
base_dir = os.path.dirname(__file__)
|
|
arch = platform.machine()
|
|
if arch == "x86_64":
|
|
arch = "64"
|
|
url = url_func(arch, version)
|
|
dst_prefix = os.path.join(base_dir, "triton")
|
|
dst_suffix = os.path.join("third_party", "cuda", src_path)
|
|
dst_path = os.path.join(dst_prefix, dst_suffix)
|
|
is_linux = platform.system() == "Linux"
|
|
download = False
|
|
if is_linux:
|
|
download = True
|
|
if os.path.exists(dst_path):
|
|
curr_version = subprocess.check_output([dst_path, "--version"]).decode("utf-8").strip()
|
|
curr_version = re.search(r"V([.|\d]+)", curr_version).group(1)
|
|
download = curr_version != version
|
|
if download:
|
|
print(f'downloading and extracting {url} ...')
|
|
ftpstream = urllib.request.urlopen(url)
|
|
file = tarfile.open(fileobj=ftpstream, mode="r|*")
|
|
with tempfile.TemporaryDirectory() as temp_dir:
|
|
file.extractall(path=temp_dir)
|
|
src_path = os.path.join(temp_dir, src_path)
|
|
os.makedirs(os.path.split(dst_path)[0], exist_ok=True)
|
|
shutil.copy(src_path, dst_path)
|
|
return dst_suffix
|
|
|
|
# ---- cmake extension ----
|
|
|
|
|
|
def get_base_dir():
|
|
return os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir))
|
|
|
|
|
|
def get_cmake_dir():
|
|
plat_name = sysconfig.get_platform()
|
|
python_version = sysconfig.get_python_version()
|
|
dir_name = f"cmake.{plat_name}-{sys.implementation.name}-{python_version}"
|
|
cmake_dir = Path(get_base_dir()) / "python" / "build" / dir_name
|
|
cmake_dir.mkdir(parents=True, exist_ok=True)
|
|
return cmake_dir
|
|
|
|
|
|
class CMakeClean(clean):
|
|
def initialize_options(self):
|
|
clean.initialize_options(self)
|
|
self.build_temp = get_cmake_dir()
|
|
|
|
|
|
class CMakeBuildPy(build_py):
|
|
def run(self) -> None:
|
|
self.run_command('build_ext')
|
|
return super().run()
|
|
|
|
|
|
class CMakeExtension(Extension):
|
|
def __init__(self, name, path, sourcedir=""):
|
|
Extension.__init__(self, name, sources=[])
|
|
self.sourcedir = os.path.abspath(sourcedir)
|
|
self.path = path
|
|
|
|
|
|
class CMakeBuild(build_ext):
|
|
|
|
user_options = build_ext.user_options + \
|
|
[('base-dir=', None, 'base directory of Triton')]
|
|
|
|
def initialize_options(self):
|
|
build_ext.initialize_options(self)
|
|
self.base_dir = get_base_dir()
|
|
|
|
def finalize_options(self):
|
|
build_ext.finalize_options(self)
|
|
|
|
def run(self):
|
|
try:
|
|
out = subprocess.check_output(["cmake", "--version"])
|
|
except OSError:
|
|
raise RuntimeError("CMake must be installed to build the following extensions: " + ", ".join(e.name for e in self.extensions))
|
|
|
|
match = re.search(r"version\s*(?P<major>\d+)\.(?P<minor>\d+)([\d.]+)?", out.decode())
|
|
cmake_major, cmake_minor = int(match.group("major")), int(match.group("minor"))
|
|
if (cmake_major, cmake_minor) < (3, 18):
|
|
raise RuntimeError("CMake >= 3.18.0 is required")
|
|
|
|
for ext in self.extensions:
|
|
self.build_extension(ext)
|
|
|
|
def build_extension(self, ext):
|
|
lit_dir = shutil.which('lit')
|
|
ninja_dir = shutil.which('ninja')
|
|
user_home = os.getenv("HOME") or os.getenv("USERPROFILE") or \
|
|
os.getenv("HOMEPATH") or None
|
|
if not user_home:
|
|
raise RuntimeError("Could not find user home directory")
|
|
triton_cache_path = os.path.join(user_home, ".triton")
|
|
# lit is used by the test suite
|
|
thirdparty_cmake_args = get_thirdparty_packages(triton_cache_path)
|
|
extdir = os.path.abspath(os.path.dirname(self.get_ext_fullpath(ext.path)))
|
|
# create build directories
|
|
if not os.path.exists(self.build_temp):
|
|
os.makedirs(self.build_temp)
|
|
# python directories
|
|
python_include_dir = sysconfig.get_path("platinclude")
|
|
cmake_args = [
|
|
"-G", "Ninja", # Ninja is much faster than make
|
|
"-DCMAKE_MAKE_PROGRAM=" + ninja_dir, # Pass explicit path to ninja otherwise cmake may cache a temporary path
|
|
"-DCMAKE_EXPORT_COMPILE_COMMANDS=ON",
|
|
"-DLLVM_ENABLE_WERROR=ON",
|
|
"-DCMAKE_LIBRARY_OUTPUT_DIRECTORY=" + extdir,
|
|
"-DTRITON_BUILD_TUTORIALS=OFF",
|
|
"-DTRITON_BUILD_PYTHON_MODULE=ON",
|
|
"-DPython3_EXECUTABLE:FILEPATH=" + sys.executable,
|
|
"-DCMAKE_VERBOSE_MAKEFILE:BOOL=ON",
|
|
"-DPYTHON_INCLUDE_DIRS=" + python_include_dir,
|
|
]
|
|
if lit_dir is not None:
|
|
cmake_args.append("-DLLVM_EXTERNAL_LIT=" + lit_dir)
|
|
cmake_args.extend(thirdparty_cmake_args)
|
|
|
|
# configuration
|
|
cfg = get_build_type()
|
|
build_args = ["--config", cfg]
|
|
|
|
codegen_backends = get_codegen_backends()
|
|
if len(codegen_backends) > 0:
|
|
all_codegen_backends = ';'.join(codegen_backends)
|
|
cmake_args += ["-DTRITON_CODEGEN_BACKENDS=" + all_codegen_backends]
|
|
|
|
if platform.system() == "Windows":
|
|
cmake_args += [f"-DCMAKE_RUNTIME_OUTPUT_DIRECTORY_{cfg.upper()}={extdir}"]
|
|
if sys.maxsize > 2**32:
|
|
cmake_args += ["-A", "x64"]
|
|
build_args += ["--", "/m"]
|
|
else:
|
|
cmake_args += ["-DCMAKE_BUILD_TYPE=" + cfg]
|
|
max_jobs = os.getenv("MAX_JOBS", str(2 * os.cpu_count()))
|
|
build_args += ['-j' + max_jobs]
|
|
|
|
if check_env_flag("TRITON_BUILD_WITH_CLANG_LLD"):
|
|
cmake_args += ["-DCMAKE_C_COMPILER=clang",
|
|
"-DCMAKE_CXX_COMPILER=clang++",
|
|
"-DCMAKE_LINKER=lld",
|
|
"-DCMAKE_EXE_LINKER_FLAGS=-fuse-ld=lld",
|
|
"-DCMAKE_MODULE_LINKER_FLAGS=-fuse-ld=lld",
|
|
"-DCMAKE_SHARED_LINKER_FLAGS=-fuse-ld=lld"]
|
|
|
|
if check_env_flag("TRITON_BUILD_WITH_CCACHE"):
|
|
cmake_args += [
|
|
"-DCMAKE_CXX_COMPILER_LAUNCHER=ccache",
|
|
]
|
|
|
|
env = os.environ.copy()
|
|
cmake_dir = get_cmake_dir()
|
|
subprocess.check_call(["cmake", self.base_dir] + cmake_args, cwd=cmake_dir, env=env)
|
|
subprocess.check_call(["cmake", "--build", "."] + build_args, cwd=cmake_dir)
|
|
subprocess.check_call(["cmake", "--build", ".", "--target", "mlir-doc"], cwd=cmake_dir)
|
|
|
|
|
|
download_and_copy(src_path='bin/ptxas', version='12.1.105', url_func=lambda arch, version: f"https://conda.anaconda.org/nvidia/label/cuda-12.1.1/linux-{arch}/cuda-nvcc-{version}-0.tar.bz2")
|
|
download_and_copy(src_path='bin/cuobjdump', version='12.1.111', url_func=lambda arch, version: f"https://conda.anaconda.org/nvidia/label/cuda-12.1.1/linux-{arch}/cuda-cuobjdump-{version}-0.tar.bz2")
|
|
download_and_copy(src_path='bin/nvdisasm', version='12.1.105', url_func=lambda arch, version: f"https://conda.anaconda.org/nvidia/label/cuda-12.1.1/linux-{arch}/cuda-nvdisasm-{version}-0.tar.bz2")
|
|
|
|
setup(
|
|
name="triton",
|
|
version="2.1.0",
|
|
author="Philippe Tillet",
|
|
author_email="phil@openai.com",
|
|
description="A language and compiler for custom Deep Learning operations",
|
|
long_description="",
|
|
packages=[
|
|
"triton",
|
|
"triton/_C",
|
|
"triton/common",
|
|
"triton/compiler",
|
|
"triton/language",
|
|
"triton/language/extra",
|
|
"triton/ops",
|
|
"triton/ops/blocksparse",
|
|
"triton/runtime",
|
|
"triton/runtime/backends",
|
|
"triton/third_party",
|
|
"triton/tools",
|
|
],
|
|
install_requires=[
|
|
"filelock"
|
|
],
|
|
include_package_data=True,
|
|
ext_modules=[CMakeExtension("triton", "triton/_C/")],
|
|
cmdclass={"build_ext": CMakeBuild, "build_py": CMakeBuildPy, "clean": CMakeClean},
|
|
zip_safe=False,
|
|
# for PyPI
|
|
keywords=["Compiler", "Deep Learning"],
|
|
url="https://github.com/openai/triton/",
|
|
classifiers=[
|
|
"Development Status :: 4 - Beta",
|
|
"Intended Audience :: Developers",
|
|
"Topic :: Software Development :: Build Tools",
|
|
"License :: OSI Approved :: MIT License",
|
|
"Programming Language :: Python :: 3.7",
|
|
"Programming Language :: Python :: 3.8",
|
|
"Programming Language :: Python :: 3.9",
|
|
"Programming Language :: Python :: 3.10",
|
|
"Programming Language :: Python :: 3.11",
|
|
],
|
|
test_suite="tests",
|
|
extras_require={
|
|
"build": [
|
|
"cmake>=3.20",
|
|
"lit",
|
|
],
|
|
"tests": [
|
|
"autopep8",
|
|
"flake8",
|
|
"isort",
|
|
"numpy",
|
|
"pytest",
|
|
"scipy>=1.7.1",
|
|
"torch",
|
|
],
|
|
"tutorials": [
|
|
"matplotlib",
|
|
"pandas",
|
|
"tabulate",
|
|
"torch",
|
|
],
|
|
},
|
|
)
|