compiler_interface.py 29.2 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
import contextlib
4
5
import copy
import os
6
from collections.abc import Callable
7
from contextlib import ExitStack
8
from typing import Any, Literal
9
10
11
12
13
14
from unittest.mock import patch

import torch
import torch._inductor.compile_fx
import torch.fx as fx

15
import vllm.envs as envs
16
from vllm.compilation.counter import compilation_counter
17
from vllm.config import VllmConfig
18
from vllm.config.utils import Range
19
from vllm.env_override import _apply_constrain_to_fx_strides_patch
20
from vllm.logger import init_logger
21
from vllm.utils.hashing import safe_hash
22
from vllm.utils.torch_utils import is_torch_equal_or_newer
23

24
25
logger = init_logger(__name__)

26
27
28
29
30

class CompilerInterface:
    """
    The interface for a compiler that can be used by vLLM.
    """
31

32
33
34
35
    # The name of the compiler, e.g. inductor.
    # This is a class-level attribute.
    name: str

36
37
    def initialize_cache(
        self, cache_dir: str, disable_cache: bool = False, prefix: str = ""
38
    ) -> None:
39
40
41
42
        """
        when the vLLM process uses `cache_dir` as the cache directory,
        the compiler should initialize itself with the cache directory,
        e.g. by re-directing its own cache directory to a sub-directory.
43
44
45
46
47
48
49
50

        prefix can be used in combination with cache_dir to figure out the base
        cache directory, e.g. there're multiple parts of model being compiled,
        but we want to share the same cache directory for all of them.

        e.g.
        cache_dir = "/path/to/dir/backbone", prefix = "backbone"
        cache_dir = "/path/to/dir/eagle_head", prefix = "eagle_head"
51
52
53
54
55
        """
        pass

    def compute_hash(self, vllm_config: VllmConfig) -> str:
        """
56
        Gather all the relevant information from the vLLM config,
57
58
        to compute a hash so that we can cache the compiled model.

59
60
        See [`VllmConfig.compute_hash`][vllm.config.VllmConfig.compute_hash]
        to check what information
61
62
63
64
65
66
67
68
        is already considered by default. This function should only
        consider the information that is specific to the compiler.
        """
        return ""

    def compile(
        self,
        graph: fx.GraphModule,
69
70
        example_inputs: list[Any],
        compiler_config: dict[str, Any],
71
        compile_range: Range,
72
        key: str | None = None,
73
    ) -> tuple[Callable[..., Any] | None, Any | None]:
74
75
        """
        Compile the graph with the given example inputs and compiler config,
76
77
78
79
80
        with a range. The `compile_range` specifies the range of the inputs,
        it could be concrete size (if compile_sizes is provided), e.g. [4, 4]
        or a range [5, 8].
        Right now we only support one variable in ranges for all inputs,
         which is the batchsize (number of tokens) during inference.
81
82
83
84
85
86
87
88
89
90
91
92

        Dynamo will make sure `graph(*example_inputs)` is valid.

        The function should return a compiled callable function, as well as
        a handle that can be used to directly load the compiled function.

        The handle should be a plain Python object, preferably a string or a
        file path for readability.

        If the compiler doesn't support caching, it should return None for the
        handle. If the compiler fails to compile the graph, it should return
        None for the compiled function as well.
93
94
95
96

        `key` is required for StandaloneInductorAdapter, it specifies where to
        save the compiled artifact. The compiled artifact gets saved to
        `cache_dir/key`.
97
98
99
        """
        return None, None

100
101
102
103
104
    def load(
        self,
        handle: Any,
        graph: fx.GraphModule,
        example_inputs: list[Any],
105
        graph_index: int,
106
        compile_range: Range,
107
    ) -> Callable[..., Any]:
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
        """
        Load the compiled function from the handle.
        Raises an error if the handle is invalid.

        The handle is the second return value of the `compile` function.
        """
        raise NotImplementedError("caching is not supported")


class AlwaysHitShapeEnv:
    """
    Why do we need this class:

    For normal `torch.compile` usage, every compilation will have
    one Dynamo bytecode compilation and one Inductor compilation.
    The Inductor compilation happens under the context of the
    Dynamo bytecode compilation, and that context is used to
    determine the dynamic shape information, etc.

    For our use case, we only run Dynamo bytecode compilation once,
    and run Inductor compilation multiple times with different shapes
    plus a general shape. The compilation for specific shapes happens
    outside of the context of the Dynamo bytecode compilation. At that
    time, we don't have shape environment to provide to Inductor, and
    it will fail the Inductor code cache lookup.

    By providing a dummy shape environment that always hits, we can
    make the Inductor code cache lookup always hit, and we can
    compile the graph for different shapes as needed.

    The following dummy methods are obtained by trial-and-error
    until it works.
    """

    def __init__(self) -> None:
143
        self.guards: list[Any] = []
144

145
    def evaluate_guards_expression(self, *args: Any, **kwargs: Any) -> Literal[True]:
146
147
        return True

148
    def get_pruned_guards(self, *args: Any, **kwargs: Any) -> list[Any]:
149
150
        return []

151
    def produce_guards_expression(self, *args: Any, **kwargs: Any) -> Literal[""]:
152
153
154
        return ""


155
156
def get_inductor_factors() -> list[Any]:
    factors: list[Any] = []
157
158
    # summarize system state
    from torch._inductor.codecache import CacheBase
159

160
161
162
163
164
    system_factors = CacheBase.get_system()
    factors.append(system_factors)

    # summarize pytorch state
    from torch._inductor.codecache import torch_key
165

166
167
168
169
170
    torch_factors = torch_key()
    factors.append(torch_factors)
    return factors


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
def is_compile_cache_enabled(
    vllm_additional_inductor_config: dict[str, Any],
) -> bool:
    vllm_inductor_config_disable_cache = vllm_additional_inductor_config.get(
        "force_disable_caches", False
    )

    # TODO(gmagogsfm): Replace torch._inductor.config.force_disable_caches
    # with torch.compiler.config.force_disable_caches when minimum PyTorch
    # version reaches 2.10
    return (
        not envs.VLLM_DISABLE_COMPILE_CACHE
        and not torch._inductor.config.force_disable_caches
        and not vllm_inductor_config_disable_cache
    )


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
def _patch_standalone_compile_atomic_save() -> None:
    """Backport of pytorch/pytorch#162432 for torch < 2.10.0.

    Patches CompiledArtifact.save() to use write_atomic for binary format,
    preventing corrupt cache files when multiple processes compile
    concurrently.
    """
    from torch._inductor.codecache import write_atomic
    from torch._inductor.standalone_compile import CompiledArtifact as cls

    if getattr(cls.save, "_vllm_patched", False):
        return

    original_save = cls.save

    def _save(
        self: Any, *, path: str, format: Literal["binary", "unpacked"] = "binary"
    ) -> None:
        if format != "binary":
            return original_save(self, path=path, format=format)
        from torch._dynamo.utils import dynamo_timed
        from torch._inductor.codecache import torch_key
        from torch.utils._appending_byte_serializer import BytesWriter

        with dynamo_timed("CompiledArtifact.save"):
            assert self._artifacts is not None
            artifact_bytes, cache_info = self._artifacts
            assert len(cache_info.aot_autograd_artifacts) == 1, cache_info
            key = cache_info.aot_autograd_artifacts[0]
            assert not os.path.isdir(path)
            writer = BytesWriter()
            writer.write_bytes(torch_key())
            writer.write_str(key)
            writer.write_bytes(artifact_bytes)
            write_atomic(path, writer.to_bytes())

    _save._vllm_patched = True  # type: ignore[attr-defined]
    cls.save = _save  # type: ignore[assignment]
    logger.debug("Patched %s.save for atomic writes (torch < 2.10)", cls.__name__)


229
230
231
232
233
234
235
class InductorStandaloneAdaptor(CompilerInterface):
    """
    The adaptor for the Inductor compiler.
    Requires PyTorch 2.8+.
    This is not on by default yet, but we plan to turn it on by default for
    PyTorch 2.8.

236
    Use VLLM_USE_STANDALONE_COMPILE to toggle this on or off.
237
    """
238

239
240
    name = "inductor_standalone"

241
    def __init__(self, save_format: Literal["binary", "unpacked"]) -> None:
242
243
        if not is_torch_equal_or_newer("2.10.0"):
            _patch_standalone_compile_atomic_save()
244
245
        self.save_format = save_format

246
247
    def compute_hash(self, vllm_config: VllmConfig) -> str:
        factors = get_inductor_factors()
248
249
250
        hash_str: str = safe_hash(
            str(factors).encode(), usedforsecurity=False
        ).hexdigest()[:10]
251
252
        return hash_str

253
254
    def initialize_cache(
        self, cache_dir: str, disable_cache: bool = False, prefix: str = ""
255
    ) -> None:
256
257
258
259
260
        self.cache_dir = cache_dir

    def compile(
        self,
        graph: fx.GraphModule,
261
262
        example_inputs: list[Any],
        compiler_config: dict[str, Any],
263
        compile_range: Range,
264
        key: str | None = None,
265
    ) -> tuple[Callable[..., Any] | None, Any | None]:
266
        _apply_constrain_to_fx_strides_patch()
267
        compilation_counter.num_inductor_compiles += 1
268
269
270
        current_config = {}
        if compiler_config is not None:
            current_config.update(compiler_config)
271
        set_inductor_config(current_config, compile_range)
272
        set_functorch_config()
273

274
        if compile_range.is_single_size():
275
276
            dynamic_shapes = "from_example_inputs"
        else:
277
            dynamic_shapes = "from_graph"
278
279

        from torch._inductor import standalone_compile
280

281
        supports_aot = is_torch_equal_or_newer("2.10.0")
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304

        if not supports_aot and envs.VLLM_USE_MEGA_AOT_ARTIFACT:
            logger.error(
                "CRITICAL: VLLM_USE_MEGA_AOT_ARTIFACT "
                "is enabled but PyTorch version does not support 'aot' "
                "parameter in standalone_compile. This requires PyTorch "
                "2.10.0+. Falling back to non-AOT mode."
            )

        compile_kwargs = {
            "dynamic_shapes": dynamic_shapes,
            "options": {
                "config_patches": current_config,
            },
        }

        use_aot: bool = supports_aot and envs.VLLM_USE_MEGA_AOT_ARTIFACT
        # only add 'aot' parameter if both supported and enabled...
        # this will set bundled_autograd_cache
        # https://github.com/pytorch/pytorch/blob/9bbc5b2905c260adf41bc866a732f9c121a2828a/torch/_inductor/standalone_compile.py#L359 # noqa
        if use_aot:
            compile_kwargs["aot"] = True  # type: ignore[assignment]

305
306
307
        # Inductor's pre-grad passes don't do anything for vLLM.
        # The pre-grad passes get run even on cache-hit and negatively impact
        # vllm cold compile times by O(1s)
308
        # Fixed upstream in PyTorch 2.12:
309
        # https://github.com/pytorch/pytorch/issues/174502
310
        if is_torch_equal_or_newer("2.12.0.dev") or envs.VLLM_ENABLE_PREGRAD_PASSES:
311
            pregrad_ctx: Any = contextlib.nullcontext()
312
        else:
313
            pregrad_ctx = patch(
314
315
316
                "torch._inductor.compile_fx._recursive_pre_grad_passes",
                lambda gm, _: gm,
            )
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

        # When inputs are FakeTensors (from create_concrete_args),
        # standalone_compile("from_example_inputs") would normally create
        # a fresh FakeTensorMode, causing a mode mismatch assertion.
        # Patch FakeTensorMode in standalone_compile so it reuses the
        # mode already attached to our FakeTensors. This gives us both
        # ignore_shape_env=True (from "from_example_inputs") and mode
        # consistency (from reusing our mode).
        # Can remove this after the following issue gets fixed:
        # https://github.com/pytorch/pytorch/issues/176562
        from torch._subclasses.fake_tensor import FakeTensor

        input_fake_mode = None
        for x in example_inputs:
            if isinstance(x, FakeTensor):
                input_fake_mode = x.fake_mode
                break

        if input_fake_mode is not None:
336
337
338
339
340
341
342
343
344
            # Use patch.object on the actual module from sys.modules
            # because in Python <=3.10 the string-based patch() resolves
            # torch._inductor.standalone_compile to the wrapper function
            # (defined in __init__.py) instead of the module.
            import sys

            fake_mode_ctx: Any = patch.object(
                sys.modules["torch._inductor.standalone_compile"],
                "FakeTensorMode",
345
346
347
348
349
                lambda *a, **kw: input_fake_mode,
            )
        else:
            fake_mode_ctx = contextlib.nullcontext()

350
        with pregrad_ctx, fake_mode_ctx:
351
            compiled_graph = standalone_compile(graph, example_inputs, **compile_kwargs)
352
353
354
355
356
357
358
359
360
361
362

        if use_aot:
            from torch._inductor.standalone_compile import AOTCompiledArtifact

            assert isinstance(compiled_graph, AOTCompiledArtifact)
            assert hasattr(compiled_graph, "serialize")
            # just return the compiled graph and a key
            # since we can serialize the bytes using to_bytes
            # and reload it using the key when reading
            return compiled_graph, None

363
364
365
        # Save the compiled artifact to disk in the specified path
        assert key is not None
        path = os.path.join(self.cache_dir, key)
366

367
368
369
370
371
372
373
        def is_saveable_2_10(compiled_artifact):
            # can just use compiled_artifact.is_saveable in 2.11
            if compiled_artifact._artifacts is None:
                return False
            _, cache_info = compiled_artifact._artifacts
            return len(cache_info.aot_autograd_artifacts) == 1

374
        if is_compile_cache_enabled(compiler_config):
375
376
377
378
379
380
381
382
383
384
385
386
            if not is_saveable_2_10(compiled_graph):
                raise RuntimeError(
                    "The compiled artifact is not serializable. This usually means "
                    "that the model code has something that is not serializable "
                    "by torch.compile in it. You can fix this by either "
                    "figuring out what is not serializable and rewriting it, "
                    "filing a bug report, "
                    "or suppressing this error by "
                    "disabling vLLM's compilation cache via "
                    "VLLM_DISABLE_COMPILE_CACHE=1 "
                    "(this will greatly increase vLLM server warm start times)."
                )
387
            compiled_graph.save(path=path, format=self.save_format)
388
            compilation_counter.num_compiled_artifacts_saved += 1
389
390
        return compiled_graph, (key, path)

391
392
393
394
395
    def load(
        self,
        handle: Any,
        graph: fx.GraphModule,
        example_inputs: list[Any],
396
        graph_index: int,
397
        compile_range: Range,
398
    ) -> Callable[..., Any]:
399
400
401
402
403
        assert isinstance(handle, tuple)
        assert isinstance(handle[0], str)
        assert isinstance(handle[1], str)
        path = handle[1]
        inductor_compiled_graph = torch._inductor.CompiledArtifact.load(
404
            path=path, format=self.save_format
405
        )
406
        compilation_counter.num_compiled_artifacts_loaded += 1
407
        from torch._inductor.compile_fx import graph_returns_tuple
408

409
410
        returns_tuple = graph_returns_tuple(graph)

411
        def compiled_graph_wrapper(*args: Any) -> tuple[Any, ...] | Any:
412
413
414
415
416
417
418
419
420
421
422
423
            graph_output = inductor_compiled_graph(*args)
            # unpack the tuple if needed
            # TODO(rzou): the implication is that we're not
            # reading the python bytecode correctly in vLLM?
            if returns_tuple:
                return graph_output
            else:
                return graph_output[0]

        return compiled_graph_wrapper


424
425
class InductorAdaptor(CompilerInterface):
    """
426
    The adaptor for the Inductor compiler, version 2.5, 2.6, 2.7.
427
    """
428

429
430
431
    name = "inductor"

    def compute_hash(self, vllm_config: VllmConfig) -> str:
432
        factors = get_inductor_factors()
433
434
435
        hash_str: str = safe_hash(
            str(factors).encode(), usedforsecurity=False
        ).hexdigest()[:10]
436
437
        return hash_str

438
439
    def initialize_cache(
        self, cache_dir: str, disable_cache: bool = False, prefix: str = ""
440
    ) -> None:
441
        self.cache_dir = cache_dir
442
        self.prefix = prefix
443
        self.base_cache_dir = cache_dir[: -len(prefix)] if prefix else cache_dir
444
445
        if disable_cache:
            return
446
        # redirect the cache directory to a subdirectory
447
448
449
        # set flags so that Inductor and Triton store their cache
        # in the cache_dir, then users only need to copy the cache_dir
        # to another machine to reuse the cache.
450
        inductor_cache = os.path.join(self.base_cache_dir, "inductor_cache")
451
452
        os.makedirs(inductor_cache, exist_ok=True)
        os.environ["TORCHINDUCTOR_CACHE_DIR"] = inductor_cache
453
        triton_cache = os.path.join(self.base_cache_dir, "triton_cache")
454
455
456
457
458
459
        os.makedirs(triton_cache, exist_ok=True)
        os.environ["TRITON_CACHE_DIR"] = triton_cache

    def compile(
        self,
        graph: fx.GraphModule,
460
461
        example_inputs: list[Any],
        compiler_config: dict[str, Any],
462
        compile_range: Range,
463
        key: str | None = None,
464
    ) -> tuple[Callable[..., Any] | None, Any | None]:
465
        _apply_constrain_to_fx_strides_patch()
466
        compilation_counter.num_inductor_compiles += 1
467
        from torch._inductor.compile_fx import compile_fx
468

469
470
471
        current_config = {}
        if compiler_config is not None:
            current_config.update(compiler_config)
472
473
474
475
476

        # disable remote cache
        current_config["fx_graph_cache"] = True
        current_config["fx_graph_remote_cache"] = False

477
        set_inductor_config(current_config, compile_range)
478
        set_functorch_config()
479
480
481
482
483
484
485
486
487
488
489

        # inductor can inplace modify the graph, so we need to copy it
        # see https://github.com/pytorch/pytorch/issues/138980
        graph = copy.deepcopy(graph)

        # it's the first time we compile this graph
        # the assumption is that we don't have nested Inductor compilation.
        # compiled_fx_graph_hash will only be called once, and we can hook
        # it to get the hash of the compiled graph directly.

        hash_str, file_path = None, None
490
        from torch._inductor.codecache import compiled_fx_graph_hash
491

492
493
494
495
496
        def hijacked_compile_fx_inner(*args: Any, **kwargs: Any) -> Any:
            output = torch._inductor.compile_fx.compile_fx_inner(*args, **kwargs)
            nonlocal hash_str
            inductor_compiled_graph = output
            if inductor_compiled_graph is not None:
497
                nonlocal file_path
498
499
                compiled_fn = inductor_compiled_graph.current_callable
                file_path = compiled_fn.__code__.co_filename  # noqa
500
501
502
503
                if (
                    not file_path.startswith(self.base_cache_dir)
                    and compiled_fn.__closure__ is not None
                ):
504
505
506
507
508
                    # hooked in the align_inputs_from_check_idxs function
                    # in torch/_inductor/utils.py
                    for cell in compiled_fn.__closure__:
                        if not callable(cell.cell_contents):
                            continue
509
510
511
512
513
                        code = cell.cell_contents.__code__
                        if code.co_filename.startswith(self.base_cache_dir):
                            # this is the real file path
                            # compiled from Inductor
                            file_path = code.co_filename
514
                            break
515
516
                hash_str = inductor_compiled_graph._fx_graph_cache_key
            return output
517

518
        def hijack_compiled_fx_graph_hash(*args: Any, **kwargs: Any) -> Any:
519
520
521
522
523
            out = compiled_fx_graph_hash(*args, **kwargs)
            nonlocal hash_str
            hash_str = out[0]
            return out

524
        def _check_can_cache(*args: Any, **kwargs: Any) -> None:
525
526
527
528
529
530
531
532
533
534
535
536
537
538
            # no error means it can be cached.
            # Inductor refuses to cache the graph outside of Dynamo
            # tracing context, and also disables caching for graphs
            # with high-order ops.
            # For vLLM, in either case, we want to cache the graph.
            # see https://github.com/pytorch/pytorch/blob/9f5ebf3fc609105a74eab4ccc24932d6353ff566/torch/_inductor/codecache.py#L1221 # noqa
            return

        def _get_shape_env() -> AlwaysHitShapeEnv:
            return AlwaysHitShapeEnv()

        with ExitStack() as stack:
            # for hijacking the hash of the compiled graph
            stack.enter_context(
539
540
541
542
543
                patch(
                    "torch._inductor.codecache.compiled_fx_graph_hash",
                    hijack_compiled_fx_graph_hash,
                )
            )
544
545
546

            # for providing a dummy shape environment
            stack.enter_context(
547
548
549
550
551
                patch(
                    "torch._inductor.codecache.FxGraphCache._get_shape_env",
                    _get_shape_env,
                )
            )
552

553
            from torch._functorch._aot_autograd.autograd_cache import AOTAutogradCache
554
555
556
557
558
559

            # torch 2.8+ on main uses _get_shape_env in AOTAutogradCache
            if hasattr(AOTAutogradCache, "_get_shape_env"):
                stack.enter_context(
                    patch(
                        "torch._functorch._aot_autograd.autograd_cache.AOTAutogradCache._get_shape_env",
560
561
562
                        _get_shape_env,
                    )
                )
563

564
565
566
567
            # for forcing the graph to be cached
            stack.enter_context(
                patch(
                    "torch._inductor.codecache.FxGraphCache._check_can_cache",
568
569
570
                    _check_can_cache,
                )
            )
571

572
573
574
            # Dynamo metrics context, see method for more details.
            stack.enter_context(self.metrics_context())

575
576
577
578
579
580
            # Disable remote caching. When these are on, on remote cache-hit,
            # the monkey-patched functions never actually get called.
            # vLLM today assumes and requires the monkey-patched functions to
            # get hit.
            # TODO(zou3519): we're going to replace this all with
            # standalone_compile sometime.
581
582
583
584
585
586
587
588
589
590
591
592
593
            stack.enter_context(
                torch._inductor.config.patch(fx_graph_remote_cache=False)
            )
            # InductorAdaptor (unfortunately) requires AOTAutogradCache
            # to be turned off to run. It will fail to acquire the hash_str
            # and error if not.
            # StandaloneInductorAdaptor (PyTorch 2.8+) fixes this problem.
            stack.enter_context(
                torch._functorch.config.patch(enable_autograd_cache=False)
            )
            stack.enter_context(
                torch._functorch.config.patch(enable_remote_autograd_cache=False)
            )
594

595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
            # Clear the tracing context before calling compile_fx.
            # vLLM calls compile_fx from within a PiecewiseCompileInterpreter
            # that runs under Dynamo's tracing context. The tracing context
            # has a FakeTensorMode from Dynamo, but the example inputs for
            # this subgraph have fake tensors from a different FakeTensorMode.
            # compile_fx's _compile_fx_main calls detect_fake_mode() which
            # asserts all FakeTensorModes match, causing a crash.
            # Clearing the tracing context lets compile_fx create its own.
            saved_tracing_context = torch._guards.TracingContext.try_get()
            if saved_tracing_context is not None:
                torch._guards._TLS.tracing_context = None

                def _restore_tracing_context():
                    torch._guards._TLS.tracing_context = saved_tracing_context

                stack.callback(_restore_tracing_context)

612
613
614
615
616
617
            compiled_graph = compile_fx(
                graph,
                example_inputs,
                inner_compile=hijacked_compile_fx_inner,
                config_patches=current_config,
            )
618

619
620
        # Turn off the checks if we disable the compilation cache.
        if is_compile_cache_enabled(compiler_config):
621
622
623
624
625
626
627
            if hash_str is None:
                raise RuntimeError(
                    "vLLM failed to compile the model. The most "
                    "likely reason for this is that a previous compilation "
                    "failed, leading to a corrupted compilation artifact. "
                    "We recommend trying to "
                    "remove ~/.cache/vllm/torch_compile_cache and try again "
628
629
                    "to see the real issue. "
                )
630
            assert file_path is not None, (
631
632
                "failed to get the file path of the compiled graph"
            )
633
634
        return compiled_graph, (hash_str, file_path)

635
636
637
638
639
    def load(
        self,
        handle: Any,
        graph: fx.GraphModule,
        example_inputs: list[Any],
640
        graph_index: int,
641
        compile_range: Range,
642
    ) -> Callable[..., Any]:
643
644
645
646
647
        assert isinstance(handle, tuple)
        assert isinstance(handle[0], str)
        assert isinstance(handle[1], str)
        hash_str = handle[0]

648
        from torch._functorch._aot_autograd.autograd_cache import AOTAutogradCache
649
        from torch._inductor.codecache import FxGraphCache
650

651
652
        with ExitStack() as exit_stack:
            exit_stack.enter_context(
653
654
655
656
657
                patch(
                    "torch._inductor.codecache.FxGraphCache._get_shape_env",
                    lambda *args, **kwargs: AlwaysHitShapeEnv(),
                )
            )
658
659
660
661
662
            # torch 2.8+ on main uses _get_shape_env in AOTAutogradCache
            if hasattr(AOTAutogradCache, "_get_shape_env"):
                exit_stack.enter_context(
                    patch(
                        "torch._functorch._aot_autograd.autograd_cache.AOTAutogradCache._get_shape_env",
663
664
665
                        lambda *args, **kwargs: AlwaysHitShapeEnv(),
                    )
                )
666
667
668
669

            # Dynamo metrics context, see method for more details.
            exit_stack.enter_context(self.metrics_context())

670
            from torch._inductor.output_code import CompiledFxGraphConstantsWithGm
671

672
673
674
675
676
677
678
679
            constants = CompiledFxGraphConstantsWithGm(graph)
            inductor_compiled_graph, _ = FxGraphCache._lookup_graph(
                hash_str, example_inputs, True, None, constants
            )
            assert inductor_compiled_graph is not None, (
                "Inductor cache lookup failed. Please remove "
                f"the cache directory and try again."  # noqa
            )
680
681
682
683
684
685
686
687

        # Inductor calling convention (function signature):
        # f(list) -> tuple
        # Dynamo calling convention (function signature):
        # f(*args) -> Any

        # need to know if the graph returns a tuple
        from torch._inductor.compile_fx import graph_returns_tuple
688

689
690
691
        returns_tuple = graph_returns_tuple(graph)

        # this is the callable we return to Dynamo to run
692
        def compiled_graph(*args: Any) -> tuple[Any, ...] | Any:
693
694
695
696
697
698
699
700
701
702
703
            # convert args to list
            list_args = list(args)
            graph_output = inductor_compiled_graph(list_args)
            # unpack the tuple if needed
            if returns_tuple:
                return graph_output
            else:
                return graph_output[0]

        return compiled_graph

704
    def metrics_context(self) -> contextlib.AbstractContextManager[Any]:
705
706
707
708
709
710
711
712
713
        """
        This method returns the Dynamo metrics context (if it exists,
        otherwise a null context). It is used by various compile components.
        Present in torch>=2.6, it's used inside FxGraphCache in
        torch==2.6 (but not after). It might also be used in various other
        torch.compile internal functions.

        Because it is re-entrant, we always set it (even if entering via Dynamo
        and the context was already entered). We might want to revisit if it
714
        should be set at a different mode of compilation.
715
716
717
718
719

        This is likely a bug in PyTorch: public APIs should not rely on
        manually setting up internal contexts. But we also rely on non-public
        APIs which might not provide these guarantees.
        """
720
        if is_torch_equal_or_newer("2.6"):
721
            import torch._dynamo.utils
722

723
            return torch._dynamo.utils.get_metrics_context()  # type: ignore[no-any-return]
724
725
726
        else:
            return contextlib.nullcontext()

727

728
def set_inductor_config(config: dict[str, Any], compile_range: Range) -> None:
729
730
    if compile_range.is_single_size():
        # for a specific batch size, tuning triton kernel parameters
731
        # can be beneficial
732
733
        config["max_autotune"] = envs.VLLM_ENABLE_INDUCTOR_MAX_AUTOTUNE
        config["coordinate_descent_tuning"] = (
734
735
            envs.VLLM_ENABLE_INDUCTOR_COORDINATE_DESCENT_TUNING
        )
736
737


738
def set_functorch_config() -> None:
739
740
    if not envs.VLLM_USE_MEGA_AOT_ARTIFACT:
        torch._functorch.config.bundled_autograd_cache = False
741
742


743
744
745
746
747
748
class EagerAdaptor(CompilerInterface):
    name = "eager"

    def compile(
        self,
        graph: fx.GraphModule,
749
750
        example_inputs: list[Any],
        compiler_config: dict[str, Any],
751
        compile_range: Range,
752
        key: str | None = None,
753
    ) -> tuple[Callable[..., Any] | None, Any | None]:
754
        compilation_counter.num_eager_compiles += 1
755
756
757
        # we don't need to compile the graph, just return the graph itself.
        # It does not support caching, return None for the handle.
        return graph, None