setup.py 29 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

4
import ctypes
5
import importlib.util
6
import json
7
import logging
8
import os
9
import re
10
import shutil
11
import subprocess
bnellnm's avatar
bnellnm committed
12
import sys
13
import sysconfig
14
from pathlib import Path
15
from shutil import which
16

Woosuk Kwon's avatar
Woosuk Kwon committed
17
import torch
18
from packaging.version import Version, parse
19
from setuptools import Extension, setup
20
from setuptools.command.build_ext import build_ext
21
from setuptools_scm import get_version
22
from torch.utils.cpp_extension import CUDA_HOME, ROCM_HOME
23

24
25
26
27
28
29
30
31
32

def load_module_from_path(module_name, path):
    spec = importlib.util.spec_from_file_location(module_name, path)
    module = importlib.util.module_from_spec(spec)
    sys.modules[module_name] = module
    spec.loader.exec_module(module)
    return module


33
ROOT_DIR = Path(__file__).parent
34
logger = logging.getLogger(__name__)
35
36
37

# cannot import envs directly because it depends on vllm,
#  which is not installed yet
38
envs = load_module_from_path("envs", os.path.join(ROOT_DIR, "vllm", "envs.py"))
39
40

VLLM_TARGET_DEVICE = envs.VLLM_TARGET_DEVICE
41

42
if sys.platform.startswith("darwin") and VLLM_TARGET_DEVICE != "cpu":
43
    logger.warning("VLLM_TARGET_DEVICE automatically set to `cpu` due to macOS")
44
    VLLM_TARGET_DEVICE = "cpu"
45
elif not (sys.platform.startswith("linux") or sys.platform.startswith("darwin")):
46
47
    logger.warning(
        "vLLM only supports Linux platform (including WSL) and MacOS."
48
        "Building on %s, "
49
50
51
        "so vLLM may not be able to run correctly",
        sys.platform,
    )
52
    VLLM_TARGET_DEVICE = "empty"
53
54
55
56
57
58
elif (
    sys.platform.startswith("linux")
    and torch.version.cuda is None
    and os.getenv("VLLM_TARGET_DEVICE") is None
    and torch.version.hip is None
):
59
    # if cuda or hip is not available and VLLM_TARGET_DEVICE is not set,
60
61
    # fallback to cpu
    VLLM_TARGET_DEVICE = "cpu"
62

bnellnm's avatar
bnellnm committed
63
64

def is_sccache_available() -> bool:
65
66
67
    return which("sccache") is not None and not bool(
        int(os.getenv("VLLM_DISABLE_SCCACHE", "0"))
    )
bnellnm's avatar
bnellnm committed
68
69
70
71
72
73
74
75
76
77


def is_ccache_available() -> bool:
    return which("ccache") is not None


def is_ninja_available() -> bool:
    return which("ninja") is not None


78
79
def is_freethreaded():
    return bool(sysconfig.get_config_var("Py_GIL_DISABLED"))
80
81


bnellnm's avatar
bnellnm committed
82
class CMakeExtension(Extension):
83
    def __init__(self, name: str, cmake_lists_dir: str = ".", **kwa) -> None:
84
        super().__init__(name, sources=[], py_limited_api=not is_freethreaded(), **kwa)
bnellnm's avatar
bnellnm committed
85
86
87
88
89
        self.cmake_lists_dir = os.path.abspath(cmake_lists_dir)


class cmake_build_ext(build_ext):
    # A dict of extension directories that have been configured.
90
    did_config: dict[str, bool] = {}
bnellnm's avatar
bnellnm committed
91
92
93
94
95

    #
    # Determine number of compilation jobs and optionally nvcc compile threads.
    #
    def compute_num_jobs(self):
96
97
        # `num_jobs` is either the value of the MAX_JOBS environment variable
        # (if defined) or the number of CPUs available.
98
        num_jobs = envs.MAX_JOBS
99
100
        if num_jobs is not None:
            num_jobs = int(num_jobs)
101
            logger.info("Using MAX_JOBS=%d as the number of jobs.", num_jobs)
102
103
104
105
106
107
108
        else:
            try:
                # os.sched_getaffinity() isn't universally available, so fall
                #  back to os.cpu_count() if we get an error here.
                num_jobs = len(os.sched_getaffinity(0))
            except AttributeError:
                num_jobs = os.cpu_count()
bnellnm's avatar
bnellnm committed
109

110
        nvcc_threads = None
111
112
113
114
115
        if _is_cuda() and get_nvcc_cuda_version() >= Version("11.2"):
            # `nvcc_threads` is either the value of the NVCC_THREADS
            # environment variable (if defined) or 1.
            # when it is set, we reduce `num_jobs` to avoid
            # overloading the system.
116
            nvcc_threads = envs.NVCC_THREADS
117
118
            if nvcc_threads is not None:
                nvcc_threads = int(nvcc_threads)
119
                logger.info(
120
121
                    "Using NVCC_THREADS=%d as the number of nvcc threads.", nvcc_threads
                )
122
123
124
            else:
                nvcc_threads = 1
            num_jobs = max(1, num_jobs // nvcc_threads)
bnellnm's avatar
bnellnm committed
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

        return num_jobs, nvcc_threads

    #
    # Perform cmake configuration for a single extension.
    #
    def configure(self, ext: CMakeExtension) -> None:
        # If we've already configured using the CMakeLists.txt for
        # this extension, exit early.
        if ext.cmake_lists_dir in cmake_build_ext.did_config:
            return

        cmake_build_ext.did_config[ext.cmake_lists_dir] = True

        # Select the build type.
        # Note: optimization level + debug info are set by the build type
        default_cfg = "Debug" if self.debug else "RelWithDebInfo"
142
        cfg = envs.CMAKE_BUILD_TYPE or default_cfg
bnellnm's avatar
bnellnm committed
143
144

        cmake_args = [
145
146
            "-DCMAKE_BUILD_TYPE={}".format(cfg),
            "-DVLLM_TARGET_DEVICE={}".format(VLLM_TARGET_DEVICE),
bnellnm's avatar
bnellnm committed
147
148
        ]

149
        verbose = envs.VERBOSE
bnellnm's avatar
bnellnm committed
150
        if verbose:
151
            cmake_args += ["-DCMAKE_VERBOSE_MAKEFILE=ON"]
bnellnm's avatar
bnellnm committed
152
153
154

        if is_sccache_available():
            cmake_args += [
155
156
157
158
                "-DCMAKE_C_COMPILER_LAUNCHER=sccache",
                "-DCMAKE_CXX_COMPILER_LAUNCHER=sccache",
                "-DCMAKE_CUDA_COMPILER_LAUNCHER=sccache",
                "-DCMAKE_HIP_COMPILER_LAUNCHER=sccache",
bnellnm's avatar
bnellnm committed
159
160
161
            ]
        elif is_ccache_available():
            cmake_args += [
162
163
164
165
                "-DCMAKE_C_COMPILER_LAUNCHER=ccache",
                "-DCMAKE_CXX_COMPILER_LAUNCHER=ccache",
                "-DCMAKE_CUDA_COMPILER_LAUNCHER=ccache",
                "-DCMAKE_HIP_COMPILER_LAUNCHER=ccache",
bnellnm's avatar
bnellnm committed
166
167
168
169
            ]

        # Pass the python executable to cmake so it can find an exact
        # match.
170
        cmake_args += ["-DVLLM_PYTHON_EXECUTABLE={}".format(sys.executable)]
bnellnm's avatar
bnellnm committed
171

172
173
        # Pass the python path to cmake so it can reuse the build dependencies
        # on subsequent calls to python.
174
        cmake_args += ["-DVLLM_PYTHON_PATH={}".format(":".join(sys.path))]
175

176
177
178
179
180
181
        # Override the base directory for FetchContent downloads to $ROOT/.deps
        # This allows sharing dependencies between profiles,
        # and plays more nicely with sccache.
        # To override this, set the FETCHCONTENT_BASE_DIR environment variable.
        fc_base_dir = os.path.join(ROOT_DIR, ".deps")
        fc_base_dir = os.environ.get("FETCHCONTENT_BASE_DIR", fc_base_dir)
182
        cmake_args += ["-DFETCHCONTENT_BASE_DIR={}".format(fc_base_dir)]
183

bnellnm's avatar
bnellnm committed
184
185
186
187
188
189
        #
        # Setup parallelism and build tool
        #
        num_jobs, nvcc_threads = self.compute_num_jobs()

        if nvcc_threads:
190
            cmake_args += ["-DNVCC_THREADS={}".format(nvcc_threads)]
bnellnm's avatar
bnellnm committed
191
192

        if is_ninja_available():
193
            build_tool = ["-G", "Ninja"]
bnellnm's avatar
bnellnm committed
194
            cmake_args += [
195
196
                "-DCMAKE_JOB_POOL_COMPILE:STRING=compile",
                "-DCMAKE_JOB_POOLS:STRING=compile={}".format(num_jobs),
bnellnm's avatar
bnellnm committed
197
198
199
200
            ]
        else:
            # Default build tool to whatever cmake picks.
            build_tool = []
201
202
        # Make sure we use the nvcc from CUDA_HOME
        if _is_cuda():
203
            cmake_args += [f"-DCMAKE_CUDA_COMPILER={CUDA_HOME}/bin/nvcc"]
204
205
        elif _is_hip():
            cmake_args += [f"-DROCM_PATH={ROCM_HOME}"]
206
207
208
209
210

        other_cmake_args = os.environ.get("CMAKE_ARGS")
        if other_cmake_args:
            cmake_args += other_cmake_args.split()

bnellnm's avatar
bnellnm committed
211
        subprocess.check_call(
212
213
214
            ["cmake", ext.cmake_lists_dir, *build_tool, *cmake_args],
            cwd=self.build_temp,
        )
bnellnm's avatar
bnellnm committed
215
216
217
218

    def build_extensions(self) -> None:
        # Ensure that CMake is present and working
        try:
219
            subprocess.check_output(["cmake", "--version"])
bnellnm's avatar
bnellnm committed
220
        except OSError as e:
221
            raise RuntimeError("Cannot find CMake executable") from e
bnellnm's avatar
bnellnm committed
222
223
224
225
226

        # Create build directory if it does not exist.
        if not os.path.exists(self.build_temp):
            os.makedirs(self.build_temp)

227
        targets = []
228
229
230
231

        def target_name(s: str) -> str:
            return s.removeprefix("vllm.").removeprefix("vllm_flash_attn.")

bnellnm's avatar
bnellnm committed
232
233
234
        # Build all the extensions
        for ext in self.extensions:
            self.configure(ext)
235
            targets.append(target_name(ext.name))
bnellnm's avatar
bnellnm committed
236

237
        num_jobs, _ = self.compute_num_jobs()
bnellnm's avatar
bnellnm committed
238

239
240
241
242
243
244
        build_args = [
            "--build",
            ".",
            f"-j={num_jobs}",
            *[f"--target={name}" for name in targets],
        ]
bnellnm's avatar
bnellnm committed
245

246
        subprocess.check_call(["cmake", *build_args], cwd=self.build_temp)
247

248
249
250
251
252
253
254
255
256
257
258
259
        # Install the libraries
        for ext in self.extensions:
            # Install the extension into the proper location
            outdir = Path(self.get_ext_fullpath(ext.name)).parent.absolute()

            # Skip if the install directory is the same as the build directory
            if outdir == self.build_temp:
                continue

            # CMake appends the extension prefix to the install path,
            # and outdir already contains that prefix, so we need to remove it.
            prefix = outdir
260
            for _ in range(ext.name.count(".")):
261
262
263
264
                prefix = prefix.parent

            # prefix here should actually be the same for all components
            install_args = [
265
266
267
268
269
270
271
                "cmake",
                "--install",
                ".",
                "--prefix",
                prefix,
                "--component",
                target_name(ext.name),
272
273
274
            ]
            subprocess.check_call(install_args, cwd=self.build_temp)

275
276
277
278
    def run(self):
        # First, run the standard build_ext command to compile the extensions
        super().run()

279
        # copy vllm/vllm_flash_attn/**/*.py from self.build_lib to current
280
281
        # directory so that they can be included in the editable build
        import glob
282
283
284
285
286

        files = glob.glob(
            os.path.join(self.build_lib, "vllm", "vllm_flash_attn", "**", "*.py"),
            recursive=True,
        )
287
        for file in files:
288
289
290
            dst_file = os.path.join(
                "vllm/vllm_flash_attn", file.split("vllm/vllm_flash_attn/")[-1]
            )
291
            print(f"Copying {file} to {dst_file}")
292
            os.makedirs(os.path.dirname(dst_file), exist_ok=True)
293
294
            self.copy_file(file, dst_file)

295
296
297
298
299
300
301
302
303
304
305
306
307
308
        if _is_cuda() or _is_hip():
            # copy vllm/third_party/triton_kernels/**/*.py from self.build_lib
            # to current directory so that they can be included in the editable
            # build
            print(
                f"Copying {self.build_lib}/vllm/third_party/triton_kernels "
                "to vllm/third_party/triton_kernels"
            )
            shutil.copytree(
                f"{self.build_lib}/vllm/third_party/triton_kernels",
                "vllm/third_party/triton_kernels",
                dirs_exist_ok=True,
            )

309

310
311
312
313
class precompiled_build_ext(build_ext):
    """Disables extension building when using precompiled binaries."""

    def run(self) -> None:
314
        return
315
316
317
318
319
320
321

    def build_extensions(self) -> None:
        print("Skipping build_ext: using precompiled extensions.")
        return


class precompiled_wheel_utils:
322
323
    """Extracts libraries and other files from an existing wheel."""

324
    @staticmethod
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
    def fetch_metadata_for_variant(
        commit: str, variant: str | None
    ) -> tuple[list[dict], str]:
        """
        Fetches metadata for a specific variant of the precompiled wheel.
        """
        variant_dir = f"{variant}/" if variant is not None else ""
        repo_url = f"https://wheels.vllm.ai/{commit}/{variant_dir}vllm/"
        meta_url = repo_url + "metadata.json"
        print(f"Trying to fetch nightly build metadata from {meta_url}")
        from urllib.request import urlopen

        with urlopen(meta_url) as resp:
            # urlopen raises HTTPError on unexpected status code
            wheels = json.loads(resp.read().decode("utf-8"))
        return wheels, repo_url

    @staticmethod
    def determine_wheel_url() -> tuple[str, str | None]:
        """
        Try to determine the precompiled wheel URL or path to use.
        The order of preference is:
        1. user-specified wheel location (can be either local or remote, via
           VLLM_PRECOMPILED_WHEEL_LOCATION)
        2. user-specified variant from nightly repo (current main commit via
           VLLM_PRECOMPILED_WHEEL_VARIANT)
        3. the variant corresponding to VLLM_MAIN_CUDA_VERSION from nightly repo
        4. the default variant from nightly repo (current main commit)
        """
        wheel_location = os.getenv("VLLM_PRECOMPILED_WHEEL_LOCATION", None)
        if wheel_location is not None:
            print(f"Using user-specified precompiled wheel location: {wheel_location}")
            return wheel_location, None
        else:
            import platform

            arch = platform.machine()
            # try to fetch the wheel metadata from the nightly wheel repo
            main_variant = "cu" + envs.VLLM_MAIN_CUDA_VERSION.replace(".", "")
            variant = os.getenv("VLLM_PRECOMPILED_WHEEL_VARIANT", main_variant)
            commit = os.getenv(
                "VLLM_PRECOMPILED_WHEEL_COMMIT",
                precompiled_wheel_utils.get_base_commit_in_main_branch(),
            )
            print(f"Using precompiled wheel commit {commit} with variant {variant}")
            try_default = False
            wheels, repo_url, download_filename = None, None, None
            try:
                wheels, repo_url = precompiled_wheel_utils.fetch_metadata_for_variant(
                    commit, variant
                )
            except Exception as e:
                logger.warning(
                    "Failed to fetch precompiled wheel metadata for variant %s: %s",
                    variant,
                    e,
                )
                try_default = True  # try outside handler to keep the stacktrace simple
            if try_default:
                print("Trying the default variant from remote")
                wheels, repo_url = precompiled_wheel_utils.fetch_metadata_for_variant(
                    commit, None
                )
                # if this also fails, then we have nothing more to try / cache
            assert wheels is not None and repo_url is not None, (
                "Failed to fetch precompiled wheel metadata"
            )
            # The metadata.json has the following format:
            # see .buildkite/scripts/generate-nightly-index.py for details
            """[{
    "package_name": "vllm",
    "version": "0.11.2.dev278+gdbc3d9991",
    "build_tag": null,
    "python_tag": "cp38",
    "abi_tag": "abi3",
    "platform_tag": "manylinux1_x86_64",
    "variant": null,
    "filename": "vllm-0.11.2.dev278+gdbc3d9991-cp38-abi3-manylinux1_x86_64.whl",
    "path": "../vllm-0.11.2.dev278%2Bgdbc3d9991-cp38-abi3-manylinux1_x86_64.whl"
    },
    ...]"""
            from urllib.parse import urljoin

            for wheel in wheels:
                # TODO: maybe check more compatibility later? (python_tag, abi_tag, etc)
                if wheel.get("package_name") == "vllm" and arch in wheel.get(
                    "platform_tag", ""
                ):
                    print(f"Found precompiled wheel metadata: {wheel}")
                    if "path" not in wheel:
                        raise ValueError(f"Wheel metadata missing path: {wheel}")
                    wheel_url = urljoin(repo_url, wheel["path"])
                    download_filename = wheel.get("filename")
                    print(f"Using precompiled wheel URL: {wheel_url}")
                    break
            else:
                raise ValueError(
                    f"No precompiled vllm wheel found for architecture {arch} "
                    f"from repo {repo_url}. All available wheels: {wheels}"
                )

        return wheel_url, download_filename

    @staticmethod
    def extract_precompiled_and_patch_package(
        wheel_url_or_path: str, download_filename: str | None
    ) -> dict:
432
433
434
435
436
437
        import tempfile
        import zipfile

        temp_dir = None
        try:
            if not os.path.isfile(wheel_url_or_path):
438
439
                # use provided filename first, then derive from URL
                wheel_filename = download_filename or wheel_url_or_path.split("/")[-1]
440
441
                temp_dir = tempfile.mkdtemp(prefix="vllm-wheels")
                wheel_path = os.path.join(temp_dir, wheel_filename)
442
                print(f"Downloading wheel from {wheel_url_or_path} to {wheel_path}")
443
                from urllib.request import urlretrieve
444

445
446
447
448
449
450
451
452
453
454
455
456
                urlretrieve(wheel_url_or_path, filename=wheel_path)
            else:
                wheel_path = wheel_url_or_path
                print(f"Using existing wheel at {wheel_path}")

            package_data_patch = {}

            with zipfile.ZipFile(wheel_path) as wheel:
                files_to_copy = [
                    "vllm/_C.abi3.so",
                    "vllm/_moe_C.abi3.so",
                    "vllm/_flashmla_C.abi3.so",
457
458
                    "vllm/_flashmla_extension_C.abi3.so",
                    "vllm/_sparse_flashmla_C.abi3.so",
459
460
461
462
463
464
                    "vllm/vllm_flash_attn/_vllm_fa2_C.abi3.so",
                    "vllm/vllm_flash_attn/_vllm_fa3_C.abi3.so",
                    "vllm/cumem_allocator.abi3.so",
                ]

                compiled_regex = re.compile(
465
466
                    r"vllm/vllm_flash_attn/(?:[^/.][^/]*/)*(?!\.)[^/]*\.py"
                )
467
                file_members = list(
468
469
                    filter(lambda x: x.filename in files_to_copy, wheel.filelist)
                )
470
                file_members += list(
471
472
                    filter(lambda x: compiled_regex.match(x.filename), wheel.filelist)
                )
473
474
475
476
477

                for file in file_members:
                    print(f"[extract] {file.filename}")
                    target_path = os.path.join(".", file.filename)
                    os.makedirs(os.path.dirname(target_path), exist_ok=True)
478
479
480
481
                    with (
                        wheel.open(file.filename) as src,
                        open(target_path, "wb") as dst,
                    ):
482
483
484
485
                        shutil.copyfileobj(src, dst)

                    pkg = os.path.dirname(file.filename).replace("/", ".")
                    package_data_patch.setdefault(pkg, []).append(
486
487
                        os.path.basename(file.filename)
                    )
488
489
490
491
492
493
494
495
496

            return package_data_patch
        finally:
            if temp_dir is not None:
                print(f"Removing temporary directory {temp_dir}")
                shutil.rmtree(temp_dir)

    @staticmethod
    def get_base_commit_in_main_branch() -> str:
497
498
499
        # Force to use the nightly wheel. This is mainly used for CI testing.
        if envs.VLLM_TEST_USE_PRECOMPILED_NIGHTLY_WHEEL:
            return "nightly"
500
501

        try:
502
            # Get the latest commit hash of the upstream main branch.
503
504
505
506
507
508
509
            resp_json = subprocess.check_output(
                [
                    "curl",
                    "-s",
                    "https://api.github.com/repos/vllm-project/vllm/commits/main",
                ]
            ).decode("utf-8")
510
511
            upstream_main_commit = json.loads(resp_json)["sha"]

512
513
514
515
            # In Docker build context, .git may be immutable or missing.
            if envs.VLLM_DOCKER_BUILD_CONTEXT:
                return upstream_main_commit

516
517
518
            # Check if the upstream_main_commit exists in the local repo
            try:
                subprocess.check_output(
519
520
                    ["git", "cat-file", "-e", f"{upstream_main_commit}"]
                )
521
522
523
524
525
            except subprocess.CalledProcessError:
                # If not present, fetch it from the remote repository.
                # Note that this does not update any local branches,
                # but ensures that this commit ref and its history are
                # available in our local repo.
526
527
528
                subprocess.check_call(
                    ["git", "fetch", "https://github.com/vllm-project/vllm", "main"]
                )
529
530
531

            # Then get the commit hash of the current branch that is the same as
            # the upstream main commit.
532
533
534
535
536
            current_branch = (
                subprocess.check_output(["git", "branch", "--show-current"])
                .decode("utf-8")
                .strip()
            )
537

538
539
540
541
542
543
544
            base_commit = (
                subprocess.check_output(
                    ["git", "merge-base", f"{upstream_main_commit}", current_branch]
                )
                .decode("utf-8")
                .strip()
            )
545
            return base_commit
546
547
        except ValueError as err:
            raise ValueError(err) from None
548
549
550
551
        except Exception as err:
            logger.warning(
                "Failed to get the base commit in the main branch. "
                "Using the nightly wheel. The libraries in this "
552
553
554
                "wheel may not be compatible with your dev branch: %s",
                err,
            )
555
            return "nightly"
556
557


558
559
560
561
def _no_device() -> bool:
    return VLLM_TARGET_DEVICE == "empty"


562
def _is_cuda() -> bool:
563
    has_cuda = torch.version.cuda is not None
564
    return VLLM_TARGET_DEVICE == "cuda" and has_cuda and not _is_tpu()
565
566


567
def _is_hip() -> bool:
568
569
570
    return (
        VLLM_TARGET_DEVICE == "cuda" or VLLM_TARGET_DEVICE == "rocm"
    ) and torch.version.hip is not None
571
572


573
574
575
576
def _is_tpu() -> bool:
    return VLLM_TARGET_DEVICE == "tpu"


577
578
579
580
def _is_cpu() -> bool:
    return VLLM_TARGET_DEVICE == "cpu"


581
582
583
584
def _is_xpu() -> bool:
    return VLLM_TARGET_DEVICE == "xpu"


585
586
587
588
def _build_custom_ops() -> bool:
    return _is_cuda() or _is_hip() or _is_cpu()


589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
def get_rocm_version():
    # Get the Rocm version from the ROCM_HOME/bin/librocm-core.so
    # see https://github.com/ROCm/rocm-core/blob/d11f5c20d500f729c393680a01fa902ebf92094b/rocm_version.cpp#L21
    try:
        librocm_core_file = Path(ROCM_HOME) / "lib" / "librocm-core.so"
        if not librocm_core_file.is_file():
            return None
        librocm_core = ctypes.CDLL(librocm_core_file)
        VerErrors = ctypes.c_uint32
        get_rocm_core_version = librocm_core.getROCmVersion
        get_rocm_core_version.restype = VerErrors
        get_rocm_core_version.argtypes = [
            ctypes.POINTER(ctypes.c_uint32),
            ctypes.POINTER(ctypes.c_uint32),
            ctypes.POINTER(ctypes.c_uint32),
        ]
        major = ctypes.c_uint32()
        minor = ctypes.c_uint32()
        patch = ctypes.c_uint32()
608

609
610
611
612
613
614
        if (
            get_rocm_core_version(
                ctypes.byref(major), ctypes.byref(minor), ctypes.byref(patch)
            )
            == 0
        ):
615
            return f"{major.value}.{minor.value}.{patch.value}"
616
        return None
617
    except Exception:
618
        return None
Woosuk Kwon's avatar
Woosuk Kwon committed
619

620

bnellnm's avatar
bnellnm committed
621
def get_nvcc_cuda_version() -> Version:
622
623
624
625
    """Get the CUDA version from nvcc.

    Adapted from https://github.com/NVIDIA/apex/blob/8b7a1ff183741dd8f9b87e7bafd04cfde99cea28/setup.py
    """
626
    assert CUDA_HOME is not None, "CUDA_HOME is not set"
627
628
629
    nvcc_output = subprocess.check_output(
        [CUDA_HOME + "/bin/nvcc", "-V"], universal_newlines=True
    )
630
631
632
633
634
635
    output = nvcc_output.split()
    release_idx = output.index("release") + 1
    nvcc_cuda_version = parse(output[release_idx].split(",")[0])
    return nvcc_cuda_version


636
def get_vllm_version() -> str:
637
638
639
    # Allow overriding the version. This is useful to build platform-specific
    # wheels (e.g. CPU, TPU) without modifying the source.
    if env_version := os.getenv("VLLM_VERSION_OVERRIDE"):
640
641
642
        print(f"Overriding VLLM version with {env_version} from VLLM_VERSION_OVERRIDE")
        os.environ["SETUPTOOLS_SCM_PRETEND_VERSION"] = env_version
        return get_version(write_to="vllm/_version.py")
643

644
    version = get_version(write_to="vllm/_version.py")
645
    sep = "+" if "+" not in version else "."  # dev versions might contain +
646

647
    if _no_device():
648
        if envs.VLLM_TARGET_DEVICE == "empty":
649
            version += f"{sep}empty"
650
    elif _is_cuda():
651
        if envs.VLLM_USE_PRECOMPILED:
652
            version += f"{sep}precompiled"
653
654
        else:
            cuda_version = str(get_nvcc_cuda_version())
655
            if cuda_version != envs.VLLM_MAIN_CUDA_VERSION:
656
657
658
659
                cuda_version_str = cuda_version.replace(".", "")[:3]
                # skip this for source tarball, required for pypi
                if "sdist" not in sys.argv:
                    version += f"{sep}cu{cuda_version_str}"
660
    elif _is_hip():
661
662
        # Get the Rocm Version
        rocm_version = get_rocm_version() or torch.version.hip
663
        if rocm_version and rocm_version != envs.VLLM_MAIN_CUDA_VERSION:
664
            version += f"{sep}rocm{rocm_version.replace('.', '')[:3]}"
665
    elif _is_tpu():
666
        version += f"{sep}tpu"
667
    elif _is_cpu():
668
669
        if envs.VLLM_TARGET_DEVICE == "cpu":
            version += f"{sep}cpu"
670
    elif _is_xpu():
671
        version += f"{sep}xpu"
672
    else:
673
        raise RuntimeError("Unknown runtime environment")
674

675
676
677
    return version


678
def get_requirements() -> list[str]:
679
    """Get Python package dependencies from requirements.txt."""
680
    requirements_dir = ROOT_DIR / "requirements"
681

682
    def _read_requirements(filename: str) -> list[str]:
683
        with open(requirements_dir / filename) as f:
684
            requirements = f.read().strip().split("\n")
685
686
687
688
        resolved_requirements = []
        for line in requirements:
            if line.startswith("-r "):
                resolved_requirements += _read_requirements(line.split()[1])
689
690
691
692
693
            elif (
                not line.startswith("--")
                and not line.startswith("#")
                and line.strip() != ""
            ):
694
695
696
                resolved_requirements.append(line)
        return resolved_requirements

697
    if _no_device():
698
        requirements = _read_requirements("common.txt")
699
    elif _is_cuda():
700
        requirements = _read_requirements("cuda.txt")
701
        cuda_major, cuda_minor = torch.version.cuda.split(".")
702
703
        modified_requirements = []
        for req in requirements:
704
            if "vllm-flash-attn" in req and cuda_major != "12":
705
                # vllm-flash-attn is built only for CUDA 12.x.
706
707
708
                # Skip for other versions.
                continue
            modified_requirements.append(req)
709
        requirements = modified_requirements
710
    elif _is_hip():
711
        requirements = _read_requirements("rocm.txt")
712
    elif _is_tpu():
713
        requirements = _read_requirements("tpu.txt")
714
    elif _is_cpu():
715
        requirements = _read_requirements("cpu.txt")
716
    elif _is_xpu():
717
        requirements = _read_requirements("xpu.txt")
718
    else:
719
        raise ValueError("Unsupported platform, please use CUDA, ROCm, or CPU.")
720
721
722
    return requirements


bnellnm's avatar
bnellnm committed
723
724
ext_modules = []

725
if _is_cuda() or _is_hip():
bnellnm's avatar
bnellnm committed
726
    ext_modules.append(CMakeExtension(name="vllm._moe_C"))
727
    ext_modules.append(CMakeExtension(name="vllm.cumem_allocator"))
728
729
730
    # Optional since this doesn't get built (produce an .so file). This is just
    # copying the relevant .py files from the source repository.
    ext_modules.append(CMakeExtension(name="vllm.triton_kernels", optional=True))
bnellnm's avatar
bnellnm committed
731

732
733
# if _is_hip():
#     ext_modules.append(CMakeExtension(name="vllm._rocm_C"))
734

735
if _is_cuda():
736
    ext_modules.append(CMakeExtension(name="vllm.vllm_flash_attn._vllm_fa2_C"))
737
738
    if envs.VLLM_USE_PRECOMPILED or get_nvcc_cuda_version() >= Version("12.3"):
        # FA3 requires CUDA 12.3 or later
739
        ext_modules.append(CMakeExtension(name="vllm.vllm_flash_attn._vllm_fa3_C"))
740
741
        # Optional since this doesn't get built (produce an .so file) when
        # not targeting a hopper system
742
        ext_modules.append(CMakeExtension(name="vllm._flashmla_C", optional=True))
743
        ext_modules.append(
744
745
            CMakeExtension(name="vllm._flashmla_extension_C", optional=True)
        )
746

747
if _build_custom_ops():
bnellnm's avatar
bnellnm committed
748
749
    ext_modules.append(CMakeExtension(name="vllm._C"))

750
package_data = {
751
752
753
754
755
    "vllm": [
        "py.typed",
        "model_executor/layers/fused_moe/configs/*.json",
        "model_executor/layers/quantization/utils/configs/*.json",
    ]
756
}
Simon Mo's avatar
Simon Mo committed
757

758

759
760
# If using precompiled, extract and patch package_data (in advance of setup)
if envs.VLLM_USE_PRECOMPILED:
761
762
763
764
    wheel_url, download_filename = precompiled_wheel_utils.determine_wheel_url()
    patch = precompiled_wheel_utils.extract_precompiled_and_patch_package(
        wheel_url, download_filename
    )
765
766
767
    for pkg, files in patch.items():
        package_data.setdefault(pkg, []).extend(files)

768
769
770
if _no_device():
    ext_modules = []

771
772
773
774
if not ext_modules:
    cmdclass = {}
else:
    cmdclass = {
775
776
777
        "build_ext": precompiled_build_ext
        if envs.VLLM_USE_PRECOMPILED
        else cmake_build_ext
778
779
    }

bnellnm's avatar
bnellnm committed
780
setup(
781
    # static metadata should rather go in pyproject.toml
782
    version=get_vllm_version(),
Woosuk Kwon's avatar
Woosuk Kwon committed
783
    ext_modules=ext_modules,
784
    install_requires=get_requirements(),
785
    extras_require={
786
        "bench": ["pandas", "matplotlib", "seaborn", "datasets"],
787
        "tensorizer": ["tensorizer==2.10.1"],
788
        "fastsafetensors": ["fastsafetensors >= 0.1.10"],
789
        "runai": ["runai-model-streamer[s3,gcs] >= 0.15.0"],
790
791
792
793
794
        "audio": [
            "librosa",
            "soundfile",
            "mistral_common[audio]",
        ],  # Required for audio processing
795
        "video": [],  # Kept for backwards compatibility
796
        "flashinfer": [],  # Kept for backwards compatibility
797
798
        # Optional deps for AMD FP4 quantization support
        "petit-kernel": ["petit-kernel"],
799
    },
800
    cmdclass=cmdclass,
Simon Mo's avatar
Simon Mo committed
801
    package_data=package_data,
Woosuk Kwon's avatar
Woosuk Kwon committed
802
)