setup.py 29.3 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
9
import os
import re
10
import shutil
11
import subprocess
bnellnm's avatar
bnellnm committed
12
import sys
13
from pathlib import Path
14
from shutil import which
15

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

zhuwenwen's avatar
zhuwenwen committed
22
23
24
25
from typing import Optional, Union
import subprocess
from pathlib import Path

zhuwenwen's avatar
zhuwenwen committed
26
pwd = os.path.dirname(os.path.abspath(__file__))
gaoqiong's avatar
gaoqiong committed
27
add_git_version = False
28
29
if int(os.environ.get('ADD_GIT_VERSION', '0')) == 1:
    add_git_version = True
zhuwenwen's avatar
zhuwenwen committed
30
31
32
33
    
skip_vllm_build = False
if int(os.environ.get('SKIP_VLLM_BUILD', '0')) == 1:
    skip_vllm_build = True
34
35
36
37
38
39
40
41
42

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


43
ROOT_DIR = Path(__file__).parent
44
logger = logging.getLogger(__name__)
45
46
47
48
49
50

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

VLLM_TARGET_DEVICE = envs.VLLM_TARGET_DEVICE
51

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

Huy Do's avatar
Huy Do committed
70
MAIN_CUDA_VERSION = "12.8"
71

bnellnm's avatar
bnellnm committed
72
73

def is_sccache_available() -> bool:
74
75
    return which("sccache") is not None and \
        not bool(int(os.getenv("VLLM_DISABLE_SCCACHE", "0")))
bnellnm's avatar
bnellnm committed
76
77
78
79
80
81
82
83
84
85


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


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


86
87
88
89
90
91
92
93
94
95
96
97
def is_url_available(url: str) -> bool:
    from urllib.request import urlopen

    status = None
    try:
        with urlopen(url) as f:
            status = f.status
    except Exception:
        return False
    return status == 200


bnellnm's avatar
bnellnm committed
98
99
100
class CMakeExtension(Extension):

    def __init__(self, name: str, cmake_lists_dir: str = '.', **kwa) -> None:
101
        super().__init__(name, sources=[], py_limited_api=True, **kwa)
bnellnm's avatar
bnellnm committed
102
103
104
105
106
        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.
107
    did_config: dict[str, bool] = {}
bnellnm's avatar
bnellnm committed
108
109
110
111
112

    #
    # Determine number of compilation jobs and optionally nvcc compile threads.
    #
    def compute_num_jobs(self):
113
114
        # `num_jobs` is either the value of the MAX_JOBS environment variable
        # (if defined) or the number of CPUs available.
115
        num_jobs = envs.MAX_JOBS
116
117
        if num_jobs is not None:
            num_jobs = int(num_jobs)
118
            logger.info("Using MAX_JOBS=%d as the number of jobs.", num_jobs)
119
120
121
122
123
124
125
        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
126

127
        nvcc_threads = None
128
129
130
131
132
        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.
133
            nvcc_threads = envs.NVCC_THREADS
134
135
            if nvcc_threads is not None:
                nvcc_threads = int(nvcc_threads)
136
137
138
                logger.info(
                    "Using NVCC_THREADS=%d as the number of nvcc threads.",
                    nvcc_threads)
139
140
141
            else:
                nvcc_threads = 1
            num_jobs = max(1, num_jobs // nvcc_threads)
bnellnm's avatar
bnellnm committed
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

        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"
159
        cfg = envs.CMAKE_BUILD_TYPE or default_cfg
bnellnm's avatar
bnellnm committed
160
161
162

        cmake_args = [
            '-DCMAKE_BUILD_TYPE={}'.format(cfg),
163
            '-DVLLM_TARGET_DEVICE={}'.format(VLLM_TARGET_DEVICE),
bnellnm's avatar
bnellnm committed
164
165
        ]

166
        verbose = envs.VERBOSE
bnellnm's avatar
bnellnm committed
167
168
169
170
171
        if verbose:
            cmake_args += ['-DCMAKE_VERBOSE_MAKEFILE=ON']

        if is_sccache_available():
            cmake_args += [
172
                '-DCMAKE_C_COMPILER_LAUNCHER=sccache',
bnellnm's avatar
bnellnm committed
173
174
                '-DCMAKE_CXX_COMPILER_LAUNCHER=sccache',
                '-DCMAKE_CUDA_COMPILER_LAUNCHER=sccache',
175
                '-DCMAKE_HIP_COMPILER_LAUNCHER=sccache',
bnellnm's avatar
bnellnm committed
176
177
178
            ]
        elif is_ccache_available():
            cmake_args += [
179
                '-DCMAKE_C_COMPILER_LAUNCHER=ccache',
bnellnm's avatar
bnellnm committed
180
181
                '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache',
                '-DCMAKE_CUDA_COMPILER_LAUNCHER=ccache',
182
                '-DCMAKE_HIP_COMPILER_LAUNCHER=ccache',
bnellnm's avatar
bnellnm committed
183
184
185
186
187
188
            ]

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

189
190
191
192
        # Pass the python path to cmake so it can reuse the build dependencies
        # on subsequent calls to python.
        cmake_args += ['-DVLLM_PYTHON_PATH={}'.format(":".join(sys.path))]

193
194
195
196
197
198
199
200
        # 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)
        cmake_args += ['-DFETCHCONTENT_BASE_DIR={}'.format(fc_base_dir)]

bnellnm's avatar
bnellnm committed
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
        #
        # Setup parallelism and build tool
        #
        num_jobs, nvcc_threads = self.compute_num_jobs()

        if nvcc_threads:
            cmake_args += ['-DNVCC_THREADS={}'.format(nvcc_threads)]

        if is_ninja_available():
            build_tool = ['-G', 'Ninja']
            cmake_args += [
                '-DCMAKE_JOB_POOL_COMPILE:STRING=compile',
                '-DCMAKE_JOB_POOLS:STRING=compile={}'.format(num_jobs),
            ]
        else:
            # Default build tool to whatever cmake picks.
            build_tool = []
218
219
220
        # Make sure we use the nvcc from CUDA_HOME
        if _is_cuda():
            cmake_args += [f'-DCMAKE_CUDA_COMPILER={CUDA_HOME}/bin/nvcc']
bnellnm's avatar
bnellnm committed
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
        subprocess.check_call(
            ['cmake', ext.cmake_lists_dir, *build_tool, *cmake_args],
            cwd=self.build_temp)

    def build_extensions(self) -> None:
        # Ensure that CMake is present and working
        try:
            subprocess.check_output(['cmake', '--version'])
        except OSError as e:
            raise RuntimeError('Cannot find CMake executable') from e

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

236
        targets = []
237
238
239
240

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

bnellnm's avatar
bnellnm committed
241
242
243
        # Build all the extensions
        for ext in self.extensions:
            self.configure(ext)
244
            targets.append(target_name(ext.name))
bnellnm's avatar
bnellnm committed
245

246
        num_jobs, _ = self.compute_num_jobs()
bnellnm's avatar
bnellnm committed
247

248
249
250
251
252
253
        build_args = [
            "--build",
            ".",
            f"-j={num_jobs}",
            *[f"--target={name}" for name in targets],
        ]
bnellnm's avatar
bnellnm committed
254

255
        subprocess.check_call(["cmake", *build_args], cwd=self.build_temp)
bnellnm's avatar
bnellnm committed
256

257
258
259
260
261
262
263
264
265
266
267
268
        # 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
269
            for _ in range(ext.name.count('.')):
270
271
272
273
274
275
276
277
278
                prefix = prefix.parent

            # prefix here should actually be the same for all components
            install_args = [
                "cmake", "--install", ".", "--prefix", prefix, "--component",
                target_name(ext.name)
            ]
            subprocess.check_call(install_args, cwd=self.build_temp)

279
280
281
282
    def run(self):
        # First, run the standard build_ext command to compile the extensions
        super().run()

283
        # copy vllm/vllm_flash_attn/**/*.py from self.build_lib to current
284
285
        # directory so that they can be included in the editable build
        import glob
286
287
288
        files = glob.glob(os.path.join(self.build_lib, "vllm",
                                       "vllm_flash_attn", "**", "*.py"),
                          recursive=True)
289
290
        for file in files:
            dst_file = os.path.join("vllm/vllm_flash_attn",
291
                                    file.split("vllm/vllm_flash_attn/")[-1])
292
            print(f"Copying {file} to {dst_file}")
293
            os.makedirs(os.path.dirname(dst_file), exist_ok=True)
294
295
            self.copy_file(file, dst_file)

296

297
298
299
300
301
302
303
304
305
306
307
308
309
class precompiled_build_ext(build_ext):
    """Disables extension building when using precompiled binaries."""

    def run(self) -> None:
        assert _is_cuda(
        ), "VLLM_USE_PRECOMPILED is only supported for CUDA builds"

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


class precompiled_wheel_utils:
310
311
    """Extracts libraries and other files from an existing wheel."""

312
313
314
315
316
317
318
319
320
321
322
323
324
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
    @staticmethod
    def extract_precompiled_and_patch_package(wheel_url_or_path: str) -> dict:
        import tempfile
        import zipfile

        temp_dir = None
        try:
            if not os.path.isfile(wheel_url_or_path):
                wheel_filename = wheel_url_or_path.split("/")[-1]
                temp_dir = tempfile.mkdtemp(prefix="vllm-wheels")
                wheel_path = os.path.join(temp_dir, wheel_filename)
                print(f"Downloading wheel from {wheel_url_or_path} "
                      f"to {wheel_path}")
                from urllib.request import urlretrieve
                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",
                    "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(
                    r"vllm/vllm_flash_attn/(?:[^/.][^/]*/)*(?!\.)[^/]*\.py")
                file_members = list(
                    filter(lambda x: x.filename in files_to_copy,
                           wheel.filelist))
                file_members += list(
                    filter(lambda x: compiled_regex.match(x.filename),
                           wheel.filelist))

                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)
                    with wheel.open(file.filename) as src, open(
                            target_path, "wb") as dst:
                        shutil.copyfileobj(src, dst)

                    pkg = os.path.dirname(file.filename).replace("/", ".")
                    package_data_patch.setdefault(pkg, []).append(
                        os.path.basename(file.filename))

            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:
372
373
374
        # Force to use the nightly wheel. This is mainly used for CI testing.
        if envs.VLLM_TEST_USE_PRECOMPILED_NIGHTLY_WHEEL:
            return "nightly"
375
376

        try:
377
378
379
380
381
382
383
            # Get the latest commit hash of the upstream main branch.
            resp_json = subprocess.check_output([
                "curl", "-s",
                "https://api.github.com/repos/vllm-project/vllm/commits/main"
            ]).decode("utf-8")
            upstream_main_commit = json.loads(resp_json)["sha"]

384
385
386
387
            # In Docker build context, .git may be immutable or missing.
            if envs.VLLM_DOCKER_BUILD_CONTEXT:
                return upstream_main_commit

388
389
390
391
392
393
394
395
396
397
398
399
400
            # Check if the upstream_main_commit exists in the local repo
            try:
                subprocess.check_output(
                    ["git", "cat-file", "-e", f"{upstream_main_commit}"])
            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.
                subprocess.check_call([
                    "git", "fetch", "https://github.com/vllm-project/vllm",
                    "main"
                ])
401
402
403

            # Then get the commit hash of the current branch that is the same as
            # the upstream main commit.
404
405
406
            current_branch = subprocess.check_output(
                ["git", "branch", "--show-current"]).decode("utf-8").strip()

407
408
409
            base_commit = subprocess.check_output([
                "git", "merge-base", f"{upstream_main_commit}", current_branch
            ]).decode("utf-8").strip()
410
            return base_commit
411
412
        except ValueError as err:
            raise ValueError(err) from None
413
414
415
416
417
418
        except Exception as err:
            logger.warning(
                "Failed to get the base commit in the main branch. "
                "Using the nightly wheel. The libraries in this "
                "wheel may not be compatible with your dev branch: %s", err)
            return "nightly"
419
420


421
422
423
424
def _no_device() -> bool:
    return VLLM_TARGET_DEVICE == "empty"


425
def _is_cuda() -> bool:
426
427
    has_cuda = torch.version.cuda is not None
    return (VLLM_TARGET_DEVICE == "cuda" and has_cuda
428
            and not (_is_neuron() or _is_tpu()))
429
430
431


def _is_hip() -> bool:
432
433
    return (VLLM_TARGET_DEVICE == "cuda"
            or VLLM_TARGET_DEVICE == "rocm") and torch.version.hip is not None
434
435


436
def _is_neuron() -> bool:
437
    return VLLM_TARGET_DEVICE == "neuron"
438
439


440
441
442
443
def _is_tpu() -> bool:
    return VLLM_TARGET_DEVICE == "tpu"


444
445
def _is_cpu() -> bool:
    return VLLM_TARGET_DEVICE == "cpu"
446
447


448
449
450
451
def _is_xpu() -> bool:
    return VLLM_TARGET_DEVICE == "xpu"


452
def _build_custom_ops() -> bool:
zhuwenwen's avatar
zhuwenwen committed
453
454
    if not skip_vllm_build:
        return _is_cuda() or _is_hip() or _is_cpu()
455
456


457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
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()
476

477
478
        if (get_rocm_core_version(ctypes.byref(major), ctypes.byref(minor),
                                  ctypes.byref(patch)) == 0):
479
            return f"{major.value}.{minor.value}.{patch.value}"
480
        return None
481
    except Exception:
482
        return None
Woosuk Kwon's avatar
Woosuk Kwon committed
483

484

485
486
487
def get_neuronxcc_version():
    import sysconfig
    site_dir = sysconfig.get_paths()["purelib"]
488
489
    version_file = os.path.join(site_dir, "neuronxcc", "version",
                                "__init__.py")
490
491

    # Check if the command was executed successfully
492
    with open(version_file) as fp:
493
494
495
496
497
498
499
500
        content = fp.read()

    # Extract the version using a regular expression
    match = re.search(r"__version__ = '(\S+)'", content)
    if match:
        # Return the version string
        return match.group(1)
    else:
501
        raise RuntimeError("Could not find Neuron version in the output")
502
503


bnellnm's avatar
bnellnm committed
504
def get_nvcc_cuda_version() -> Version:
505
506
507
508
    """Get the CUDA version from nvcc.

    Adapted from https://github.com/NVIDIA/apex/blob/8b7a1ff183741dd8f9b87e7bafd04cfde99cea28/setup.py
    """
509
    assert CUDA_HOME is not None, "CUDA_HOME is not set"
bnellnm's avatar
bnellnm committed
510
    nvcc_output = subprocess.check_output([CUDA_HOME + "/bin/nvcc", "-V"],
511
512
513
514
515
516
517
                                          universal_newlines=True)
    output = nvcc_output.split()
    release_idx = output.index("release") + 1
    nvcc_cuda_version = parse(output[release_idx].split(",")[0])
    return nvcc_cuda_version


zhuwenwen's avatar
zhuwenwen committed
518
519
520
521
522
523
def get_sha(root: Union[str, Path]) -> str:
    try:
        return subprocess.check_output(['git', 'rev-parse', 'HEAD'], cwd=root).decode('ascii').strip()
    except Exception:
        return 'Unknown'

524

zhuwenwen's avatar
zhuwenwen committed
525
def get_version_add(sha: Optional[str] = None) -> str:
zhuwenwen's avatar
zhuwenwen committed
526
527
    command = "git config --global --add safe.directory "+pwd  
    result = subprocess.run(command, shell=True, capture_output=False, text=True) 
zhuwenwen's avatar
zhuwenwen committed
528
529
    vllm_root = os.path.dirname(os.path.abspath(__file__))
    add_version_path = os.path.join(os.path.join(vllm_root, "vllm"), "version.py")
zhuwenwen's avatar
zhuwenwen committed
530
    major, minor, _ = torch.__version__.split('.')
531
532
533
534
    if add_git_version:
        if sha != 'Unknown':
            if sha is None:
                sha = get_sha(vllm_root)
zhuwenwen's avatar
zhuwenwen committed
535
            if (major, minor) >= ('2', '5'):
zhuwenwen's avatar
zhuwenwen committed
536
                version = 'das.opt1.alpha.' + sha[:7]
537
    else:
zhuwenwen's avatar
zhuwenwen committed
538
        if (major, minor) >= ('2', '5'):
zhuwenwen's avatar
zhuwenwen committed
539
            version = 'das.opt1.alpha'
540

zhuwenwen's avatar
zhuwenwen committed
541
542
543
544
545
546
547

    # dtk version
    if os.getenv("ROCM_PATH"):
        rocm_path = os.getenv('ROCM_PATH', "")
        rocm_version_path = os.path.join(rocm_path, '.info', "rocm_version")
        with open(rocm_version_path, 'r',encoding='utf-8') as file:
            lines = file.readlines()
zhuwenwen's avatar
zhuwenwen committed
548
        rocm_version=lines[0].replace(".", "")
zhuwenwen's avatar
zhuwenwen committed
549
        version += ".dtk" + rocm_version
zhuwenwen's avatar
zhuwenwen committed
550
    
551
    new_version_content = f"""
552
try:
553
554
    __version__ = "0.10.2.rc1"
    __version_tuple__ = (0, 10, 2, rc1)
zhuwenwen's avatar
zhuwenwen committed
555
    __hcu_version__ = f'0.10.1.1+{version}' 
zhuwenwen's avatar
zhuwenwen committed
556
    
zhuwenwen's avatar
zhuwenwen committed
557
    from vllm.version import __version__, __version_tuple__, __hcu_version__
558
except Exception as e:
zhuwenwen's avatar
zhuwenwen committed
559
560
    import warnings

zhuwenwen's avatar
zhuwenwen committed
561
    warnings.warn(f"Failed to read commit hash:\\n + str(e)",
562
563
                  RuntimeWarning,
                  stacklevel=2)
564
565
    __version__ = "dev"
    __version_tuple__ = (0, 0, __version__)
zhuwenwen's avatar
zhuwenwen committed
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
    
    
def _prev_minor_version_was(version_str):
    '''Check whether a given version matches the previous minor version.

    Return True if version_str matches the previous minor version.

    For example - return True if the current version if 0.7.4 and the
    supplied version_str is '0.6'.

    Used for --show-hidden-metrics-for-version.
    '''
    # Match anything if this is a dev tree
    if __version_tuple__[0:2] == (0, 0):
        return True

    # Note - this won't do the right thing when we release 1.0!
583
    # assert __version_tuple__[0] == 0
zhuwenwen's avatar
zhuwenwen committed
584
585
586
587
588
589
590
591
592
    assert isinstance(__version_tuple__[1], int)
    return version_str == f"{{__version_tuple__[0]}}.{{__version_tuple__[1] - 1}}"


def _prev_minor_version():
    '''For the purpose of testing, return a previous minor version number.'''
    # In dev tree, this will return "0.-1", but that will work fine"
    assert isinstance(__version_tuple__[1], int)
    return f"{{__version_tuple__[0]}}.{{__version_tuple__[1] - 1}}"
593
"""
zhuwenwen's avatar
zhuwenwen committed
594
    
zhuwenwen's avatar
zhuwenwen committed
595
    with open(add_version_path, encoding="utf-8",mode="w") as file:
zhuwenwen's avatar
zhuwenwen committed
596
        file.write(new_version_content)
zhuwenwen's avatar
zhuwenwen committed
597
598
599
600
601
602
603
604
    file.close()
    
    
def get_version():
    get_version_add()
    version_file = 'vllm/version.py'
    with open(version_file, encoding='utf-8') as f:
        exec(compile(f.read(), version_file, 'exec'))
zhuwenwen's avatar
zhuwenwen committed
605
    return locals()['__hcu_version__']
zhuwenwen's avatar
zhuwenwen committed
606
607


608
609
610
611
612
613
614
615
def get_gaudi_sw_version():
    """
    Returns the driver version.
    """
    # Enable console printing for `hl-smi` check
    output = subprocess.run("hl-smi",
                            shell=True,
                            text=True,
616
                            capture_output=True,
617
618
619
620
621
622
623
                            env={"ENABLE_CONSOLE": "true"})
    if output.returncode == 0 and output.stdout:
        return output.stdout.split("\n")[2].replace(
            " ", "").split(":")[1][:-1].split("-")[0]
    return "0.0.0"  # when hl-smi is not available


624
def get_vllm_version() -> str:
625
626
627
    # from setuptools_scm import get_version
    # version = get_version(write_to="vllm/_version.py")
    # sep = "+" if "+" not in version else "."  # dev versions might contain +
628

629
    if _no_device():
630
        if envs.VLLM_TARGET_DEVICE == "empty":
631
            version += f"{sep}empty"
632
    elif _is_cuda():
633
        if envs.VLLM_USE_PRECOMPILED:
634
            version += f"{sep}precompiled"
635
636
637
638
639
640
641
        else:
            cuda_version = str(get_nvcc_cuda_version())
            if cuda_version != MAIN_CUDA_VERSION:
                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}"
642
    elif _is_hip():
643
        # Get the Rocm Version
zhuwenwen's avatar
zhuwenwen committed
644
645
646
        # rocm_version = get_rocm_version() or torch.version.hip
        # if rocm_version and rocm_version != MAIN_CUDA_VERSION:
        #     version += f"{sep}rocm{rocm_version.replace('.', '')[:3]}"
zhuwenwen's avatar
zhuwenwen committed
647
        version = get_version()
648
649
    elif _is_neuron():
        # Get the Neuron version
bnellnm's avatar
bnellnm committed
650
        neuron_version = str(get_neuronxcc_version())
651
652
        if neuron_version != MAIN_CUDA_VERSION:
            neuron_version_str = neuron_version.replace(".", "")[:3]
653
            version += f"{sep}neuron{neuron_version_str}"
654
    elif _is_tpu():
655
        version += f"{sep}tpu"
656
    elif _is_cpu():
657
658
        if envs.VLLM_TARGET_DEVICE == "cpu":
            version += f"{sep}cpu"
659
    elif _is_xpu():
660
        version += f"{sep}xpu"
661
    else:
662
        raise RuntimeError("Unknown runtime environment")
663

664
665
666
    return version


667
def get_requirements() -> list[str]:
668
    """Get Python package dependencies from requirements.txt."""
669
    requirements_dir = ROOT_DIR / "requirements"
670

671
    def _read_requirements(filename: str) -> list[str]:
672
        with open(requirements_dir / filename) as f:
673
            requirements = f.read().strip().split("\n")
674
675
676
677
        resolved_requirements = []
        for line in requirements:
            if line.startswith("-r "):
                resolved_requirements += _read_requirements(line.split()[1])
678
679
            elif not line.startswith("--") and not line.startswith(
                    "#") and line.strip() != "":
680
681
682
                resolved_requirements.append(line)
        return resolved_requirements

683
    if _no_device():
684
        requirements = _read_requirements("common.txt")
685
    elif _is_cuda():
686
        requirements = _read_requirements("cuda.txt")
687
        cuda_major, cuda_minor = torch.version.cuda.split(".")
688
689
        modified_requirements = []
        for req in requirements:
690
691
            if ("vllm-flash-attn" in req and cuda_major != "12"):
                # vllm-flash-attn is built only for CUDA 12.x.
692
693
694
                # Skip for other versions.
                continue
            modified_requirements.append(req)
695
        requirements = modified_requirements
696
    elif _is_hip():
697
        requirements = _read_requirements("rocm.txt")
698
    elif _is_neuron():
699
        requirements = _read_requirements("neuron.txt")
700
    elif _is_tpu():
701
        requirements = _read_requirements("tpu.txt")
702
    elif _is_cpu():
703
        requirements = _read_requirements("cpu.txt")
704
    elif _is_xpu():
705
        requirements = _read_requirements("xpu.txt")
706
    else:
707
        raise ValueError(
708
            "Unsupported platform, please use CUDA, ROCm, Neuron, or CPU.")
709
710
711
    return requirements


bnellnm's avatar
bnellnm committed
712
713
ext_modules = []

zhuwenwen's avatar
zhuwenwen committed
714
715
716
if not skip_vllm_build:
    if _is_cuda() or _is_hip():
        ext_modules.append(CMakeExtension(name="vllm._moe_C"))
bnellnm's avatar
bnellnm committed
717

718
719
# if _is_hip():
#     ext_modules.append(CMakeExtension(name="vllm._rocm_C"))
720

721
if _is_cuda():
722
    ext_modules.append(CMakeExtension(name="vllm.vllm_flash_attn._vllm_fa2_C"))
723
724
    if envs.VLLM_USE_PRECOMPILED or get_nvcc_cuda_version() >= Version("12.3"):
        # FA3 requires CUDA 12.3 or later
725
726
        ext_modules.append(
            CMakeExtension(name="vllm.vllm_flash_attn._vllm_fa3_C"))
727
728
729
730
        # Optional since this doesn't get built (produce an .so file) when
        # not targeting a hopper system
        ext_modules.append(
            CMakeExtension(name="vllm._flashmla_C", optional=True))
731
    ext_modules.append(CMakeExtension(name="vllm.cumem_allocator"))
732

733
if _build_custom_ops():
bnellnm's avatar
bnellnm committed
734
735
    ext_modules.append(CMakeExtension(name="vllm._C"))

zhuwenwen's avatar
zhuwenwen committed
736
737
738
739
740
741
742
743
744
if skip_vllm_build:
    package_data = {
        "vllm": [
            "py.typed",
            "model_executor/layers/fused_moe/configs/*.json",
            "model_executor/layers/quantization/utils/configs/*.json",
            "perf/*.py",
            "attention/backends/configs/*.json",
            "model_executor/layers/quantization/configs/awq/*.json",
zhuwenwen's avatar
zhuwenwen committed
745
746
            "_C.abi3.so",
            "_moe_C.abi3.so",
zhuwenwen's avatar
zhuwenwen committed
747
748
749
750
751
752
753
754
755
756
757
758
759
760
        ]
    }
else:
    package_data = {
        "vllm": [
            "py.typed",
            "model_executor/layers/fused_moe/configs/*.json",
            "model_executor/layers/quantization/utils/configs/*.json",
            "perf/*.py",
            "attention/backends/configs/*.json",
            "model_executor/layers/quantization/configs/awq/*.json",
        ]
    }

761
762
763
764
765
766
767
# If using precompiled, extract and patch package_data (in advance of setup)
if envs.VLLM_USE_PRECOMPILED:
    assert _is_cuda(), "VLLM_USE_PRECOMPILED is only supported for CUDA builds"
    wheel_location = os.getenv("VLLM_PRECOMPILED_WHEEL_LOCATION", None)
    if wheel_location is not None:
        wheel_url = wheel_location
    else:
768
769
770
771
772
773
774
775
        import platform
        arch = platform.machine()
        if arch == "x86_64":
            wheel_tag = "manylinux1_x86_64"
        elif arch == "aarch64":
            wheel_tag = "manylinux2014_aarch64"
        else:
            raise ValueError(f"Unsupported architecture: {arch}")
776
        base_commit = precompiled_wheel_utils.get_base_commit_in_main_branch()
777
778
        wheel_url = f"https://wheels.vllm.ai/{base_commit}/vllm-1.0.0.dev-cp38-abi3-{wheel_tag}.whl"
        nightly_wheel_url = f"https://wheels.vllm.ai/nightly/vllm-1.0.0.dev-cp38-abi3-{wheel_tag}.whl"
779
780
781
782
        from urllib.request import urlopen
        try:
            with urlopen(wheel_url) as resp:
                if resp.status != 200:
783
                    wheel_url = nightly_wheel_url
784
785
        except Exception as e:
            print(f"[warn] Falling back to nightly wheel: {e}")
786
            wheel_url = nightly_wheel_url
787
788
789
790
791
792

    patch = precompiled_wheel_utils.extract_precompiled_and_patch_package(
        wheel_url)
    for pkg, files in patch.items():
        package_data.setdefault(pkg, []).extend(files)

zhuwenwen's avatar
zhuwenwen committed
793
if _no_device() or skip_vllm_build:
794
795
    ext_modules = []

796
797
798
799
800
if not ext_modules:
    cmdclass = {}
else:
    cmdclass = {
        "build_ext":
801
        precompiled_build_ext if envs.VLLM_USE_PRECOMPILED else cmake_build_ext
802
803
    }

bnellnm's avatar
bnellnm committed
804
setup(
805
    # static metadata should rather go in pyproject.toml
806
    version=get_vllm_version(),
Woosuk Kwon's avatar
Woosuk Kwon committed
807
    ext_modules=ext_modules,
808
    install_requires=get_requirements(),
809
    extras_require={
810
        "bench": ["pandas", "datasets"],
811
        "tensorizer": ["tensorizer==2.10.1"],
812
        "fastsafetensors": ["fastsafetensors >= 0.1.10"],
813
814
        "runai":
        ["runai-model-streamer >= 0.13.3", "runai-model-streamer-s3", "boto3"],
Patrick von Platen's avatar
Patrick von Platen committed
815
816
        "audio": ["librosa", "soundfile",
                  "mistral_common[audio]"],  # Required for audio processing
817
818
        "video": [],  # Kept for backwards compatibility
        # FlashInfer should be updated together with the Dockerfile
819
        "flashinfer": ["flashinfer-python==0.2.14.post1"],
820
821
        # Optional deps for AMD FP4 quantization support
        "petit-kernel": ["petit-kernel"],
822
    },
823
    cmdclass=cmdclass,
Simon Mo's avatar
Simon Mo committed
824
    package_data=package_data,
Woosuk Kwon's avatar
Woosuk Kwon committed
825
)