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

4
import ast
5
import dataclasses
6
import hashlib
7
import json
8
import operator
9
10
import os
import pprint
11
import time
12
from collections.abc import Callable, Sequence
13
from contextlib import contextmanager
14
from copy import deepcopy
15
from functools import partial
16
from typing import Any
17
18
19

import torch
import torch.fx as fx
20
from torch._dispatch.python import enable_python_dispatcher
21

22
import vllm.envs as envs
23
24
25
from vllm.compilation.inductor_pass import pass_context
from vllm.compilation.partition_rules import (
    inductor_partition_rule_context,
26
    should_split,
27
)
28
from vllm.config import CompilationConfig, CUDAGraphMode, VllmConfig
29
from vllm.config.compilation import DynamicShapesType
30
from vllm.config.utils import Range, hash_factors
31
from vllm.logger import init_logger
32
from vllm.logging_utils import lazy
33
from vllm.platforms import current_platform
34
from vllm.utils.import_utils import resolve_obj_by_qualname
35
from vllm.utils.torch_utils import is_torch_equal_or_newer
36

37
from .caching import VllmSerializableFunction
38
39
40
41
42
from .compiler_interface import (
    CompilerInterface,
    EagerAdaptor,
    InductorAdaptor,
    InductorStandaloneAdaptor,
43
    is_compile_cache_enabled,
44
)
45
from .counter import compilation_counter
46
47
from .inductor_pass import InductorPass
from .pass_manager import PostGradPassManager
48
49
50

logger = init_logger(__name__)

51

52
def make_compiler(compilation_config: CompilationConfig) -> CompilerInterface:
53
    if compilation_config.backend == "inductor":
54
55
        # Use standalone compile only if requested, version is new enough,
        # and the symbol actually exists in this PyTorch build.
56
57
58
59
60
        if (
            envs.VLLM_USE_STANDALONE_COMPILE
            and is_torch_equal_or_newer("2.8.0.dev")
            and hasattr(torch._inductor, "standalone_compile")
        ):
61
            logger.debug("Using InductorStandaloneAdaptor")
62
63
64
            return InductorStandaloneAdaptor(
                compilation_config.compile_cache_save_format
            )
65
        else:
66
            logger.debug("Using InductorAdaptor")
67
            return InductorAdaptor()
68
    elif compilation_config.backend == "eager":
69
        logger.debug("Using EagerAdaptor")
70
        return EagerAdaptor()
71
72
73
74
75
    else:
        logger.debug("Using custom backend: %s", compilation_config.backend)
        compiler = resolve_obj_by_qualname(current_platform.get_compile_backend())()
        assert isinstance(compiler, CompilerInterface)
        return compiler
76
77


78
79
80
81
82
class CompilerManager:
    """
    A manager to manage the compilation process, including
    caching the compiled graph, loading the compiled graph,
    and compiling the graph.
83

84
85
86
    The cache is a dict mapping
    `(runtime_shape, graph_index, backend_name)`
    to `any_data` returned from the compiler.
87

88
89
90
    When serializing the cache, we save it to a Python file
    for readability. We don't use json here because json doesn't
    support int as key.
91
92
    """

93
    def __init__(self, compilation_config: CompilationConfig):
94
        self.cache: dict[tuple[Range, int, str], Any] = dict()
95
        self.is_cache_updated = False
96
97
        self.compilation_config = compilation_config
        self.compiler = make_compiler(compilation_config)
98

99
100
    def compute_hash(self, vllm_config: VllmConfig) -> str:
        return self.compiler.compute_hash(vllm_config)
101

102
    @contextmanager
103
    def compile_context(self, compile_range: Range):
104
105
106
        """Provide compilation context for the duration of compilation to set
        any torch global properties we want to scope to a single Inductor
        compilation (e.g. partition rules, pass context)."""
107
        with pass_context(compile_range):
108
            if self.compilation_config.use_inductor_graph_partition:
109
                with inductor_partition_rule_context(
110
                    self.compilation_config.splitting_ops
111
                ):
112
113
114
115
                    yield
            else:
                yield

116
117
118
    def initialize_cache(
        self, cache_dir: str, disable_cache: bool = False, prefix: str = ""
    ):
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
        """
        Initialize the cache directory for the compiler.

        The organization of the cache directory is as follows:
        cache_dir=/path/to/hash_str/rank_i_j/prefix/
        inside cache_dir, there will be:
        - vllm_compile_cache.py
        - computation_graph.py
        - transformed_code.py

        for multiple prefixes, they can share the same
        base cache dir of /path/to/hash_str/rank_i_j/ ,
        to store some common compilation artifacts.
        """

134
        self.disable_cache = disable_cache
135
        self.cache_dir = cache_dir
136
137
138
139
        self.cache_file_path = os.path.join(cache_dir, "vllm_compile_cache.py")

        if not disable_cache and os.path.exists(self.cache_file_path):
            # load the cache from the file
140
            with open(self.cache_file_path) as f:
141
142
143
                # we use ast.literal_eval to parse the data
                # because it is a safe way to parse Python literals.
                # do not use eval(), it is unsafe.
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
                cache = ast.literal_eval(f.read())

            def check_type(value, ty):
                if not isinstance(value, ty):
                    raise TypeError(f"Expected {ty} but got {type(value)} for {value}")

            def parse_key(key: Any) -> tuple[Range, int, str]:
                range_tuple, graph_index, compiler_name = key
                check_type(graph_index, int)
                check_type(compiler_name, str)
                if isinstance(range_tuple, tuple):
                    start, end = range_tuple
                    check_type(start, int)
                    check_type(end, int)
                    range_tuple = Range(start=start, end=end)
                check_type(range_tuple, Range)
                return range_tuple, graph_index, compiler_name

            self.cache = {parse_key(key): value for key, value in cache.items()}
163

164
165
166
        self.compiler.initialize_cache(
            cache_dir=cache_dir, disable_cache=disable_cache, prefix=prefix
        )
167
168

    def save_to_file(self):
169
        if self.disable_cache or not self.is_cache_updated:
170
            return
171
172
        printer = pprint.PrettyPrinter(indent=4)
        data = printer.pformat(self.cache)
173
        with open(self.cache_file_path, "w") as f:
174
175
            f.write(data)

176
177
178
179
180
    def load(
        self,
        graph: fx.GraphModule,
        example_inputs: list[Any],
        graph_index: int,
181
        compile_range: Range,
182
    ) -> Callable | None:
183
        if (compile_range, graph_index, self.compiler.name) not in self.cache:
184
            return None
185
        handle = self.cache[(compile_range, graph_index, self.compiler.name)]
186
        compiled_graph = self.compiler.load(
187
188
189
190
191
192
193
194
            handle, graph, example_inputs, graph_index, compile_range
        )
        logger.debug(
            "Directly load the %s-th graph for compile range %sfrom %s via handle %s",
            graph_index,
            str(compile_range),
            self.compiler.name,
            handle,
195
        )
196
197
        return compiled_graph

198
199
200
201
202
203
    def compile(
        self,
        graph: fx.GraphModule,
        example_inputs,
        additional_inductor_config,
        compilation_config: CompilationConfig,
204
        compile_range: Range,
205
206
207
        graph_index: int = 0,
        num_graphs: int = 1,
    ) -> Any:
208
        if graph_index == 0:
209
210
211
212
213
214
215
216
217
            # before compiling the first graph, record the start time
            global compilation_start_time
            compilation_start_time = time.time()

        compilation_counter.num_backend_compilations += 1

        compiled_graph = None

        # try to load from the cache
218
        compiled_graph = self.load(graph, example_inputs, graph_index, compile_range)
219
        if compiled_graph is not None:
220
221
222
223
224
            if graph_index == num_graphs - 1:
                # after loading the last graph for this shape, record the time.
                # there can be multiple graphs due to piecewise compilation.
                now = time.time()
                elapsed = now - compilation_start_time
225
                compilation_config.compilation_time += elapsed
226
227
228
229
230
231
                logger.info(
                    "Directly load the compiled graph(s) for compile range %s "
                    "from the cache, took %.3f s",
                    str(compile_range),
                    elapsed,
                )
232
233
234
235
            return compiled_graph

        # no compiler cached the graph, or the cache is disabled,
        # we need to compile it
236
237
238
239
        if isinstance(self.compiler, InductorAdaptor):
            # Let compile_fx generate a key for us
            maybe_key = None
        else:
240
241
242
243
            maybe_key = "artifact_compile_range_"
            maybe_key += f"{compile_range.start}_{compile_range.end}"
            maybe_key += f"_subgraph_{graph_index}"
        with self.compile_context(compile_range):
244
245
246
247
            compiled_graph, handle = self.compiler.compile(
                graph,
                example_inputs,
                additional_inductor_config,
248
                compile_range,
249
250
                maybe_key,
            )
251
252
253
254

        assert compiled_graph is not None, "Failed to compile the graph"

        # store the artifact in the cache
255
        if is_compile_cache_enabled(additional_inductor_config) and handle is not None:
256
            self.cache[(compile_range, graph_index, self.compiler.name)] = handle
257
            compilation_counter.num_cache_entries_updated += 1
258
            self.is_cache_updated = True
259
260
            if graph_index == 0:
                # adds some info logging for the first graph
261
262
263
                logger.info_once(
                    "Cache the graph of compile range %s for later use",
                    str(compile_range),
264
                )
265
266
267
268
269
270
271
            logger.debug(
                "Store the %s-th graph for compile range%s from %s via handle %s",
                graph_index,
                str(compile_range),
                self.compiler.name,
                handle,
            )
272
273
274
275
276
277

        # after compiling the last graph, record the end time
        if graph_index == num_graphs - 1:
            now = time.time()
            elapsed = now - compilation_start_time
            compilation_config.compilation_time += elapsed
278
279
280
281
282
283
            logger.info_once(
                "Compiling a graph for compile range %s takes %.2f s",
                str(compile_range),
                elapsed,
                scope="local",
            )
284

285
        return compiled_graph
286
287


288
289
290
@dataclasses.dataclass
class SplitItem:
    submod_name: str
291
    graph_id: int
292
293
294
295
    is_splitting_graph: bool
    graph: fx.GraphModule


296
def split_graph(
297
    graph: fx.GraphModule, splitting_ops: list[str]
298
) -> tuple[fx.GraphModule, list[SplitItem]]:
299
300
    # split graph by ops
    subgraph_id = 0
301
302
    node_to_subgraph_id: dict[fx.Node, int] = {}
    split_op_graphs: list[int] = []
303
304
305
    for node in graph.graph.nodes:
        if node.op in ("output", "placeholder"):
            continue
306

307
308
309
310
311
312
313
314
315
316
317
318
        # Check if this is a getitem operation on a node from an earlier subgraph.
        # If so, assign it to the same subgraph as its input to avoid passing entire
        # tuple as input to submodules, which is against standalone_compile and
        # AoTAutograd input requirement.
        if node.op == "call_function" and node.target == operator.getitem:
            # Assign this getitem to the same subgraph as its input
            input_node = node.args[0]
            if input_node.op != "placeholder":
                assert input_node in node_to_subgraph_id
                node_to_subgraph_id[node] = node_to_subgraph_id[input_node]
                continue

319
        if should_split(node, splitting_ops):
320
321
322
323
324
325
326
327
328
329
330
331
            subgraph_id += 1
            node_to_subgraph_id[node] = subgraph_id
            split_op_graphs.append(subgraph_id)
            subgraph_id += 1
        else:
            node_to_subgraph_id[node] = subgraph_id

    # `keep_original_order` is important!
    # otherwise pytorch might reorder the nodes and
    # the semantics of the graph will change when we
    # have mutations in the graph
    split_gm = torch.fx.passes.split_module.split_module(
332
333
        graph, None, lambda node: node_to_subgraph_id[node], keep_original_order=True
    )
334

335
    outputs = []
336

337
    names = [name for (name, module) in split_gm.named_modules()]
338

339
340
341
342
    for name in names:
        if "." in name or name == "":
            # recursive child module or the root module
            continue
343

344
        module = getattr(split_gm, name)
345

346
        graph_id = int(name.replace("submod_", ""))
347
        outputs.append(SplitItem(name, graph_id, (graph_id in split_op_graphs), module))
348

349
    # sort by integer graph_id, rather than string name
350
    outputs.sort(key=lambda x: x.graph_id)
351

352
    return split_gm, outputs
353
354


355
356
compilation_start_time = 0.0

357
358
359
360
361
362

class PiecewiseCompileInterpreter(torch.fx.Interpreter):
    """Code adapted from `torch.fx.passes.shape_prop.ShapeProp`.
    It runs the given graph with fake inputs, and compile some
    submodules specified by `compile_submod_names` with the given
    compilation configs.
363
364
365
366
367

    NOTE: the order in `compile_submod_names` matters, because
    it will be used to determine the order of the compiled piecewise
    graphs. The first graph will handle logging, and the last graph
    has some special cudagraph output handling.
368
369
    """

370
371
372
373
374
375
376
    def __init__(
        self,
        module: torch.fx.GraphModule,
        compile_submod_names: list[str],
        vllm_config: VllmConfig,
        vllm_backend: "VllmBackend",
    ):
377
378
        super().__init__(module)
        from torch._guards import detect_fake_mode
379

380
381
        self.fake_mode = detect_fake_mode()
        self.compile_submod_names = compile_submod_names
382
383
        self.compilation_config = vllm_config.compilation_config
        self.vllm_config = vllm_config
384
        self.vllm_backend = vllm_backend
385
386
        # When True, it annoyingly dumps the torch.fx.Graph on errors.
        self.extra_traceback = False
387
388

    def run(self, *args):
389
        # maybe instead just assert inputs are fake?
390
391
392
393
        fake_args = [
            self.fake_mode.from_tensor(t) if isinstance(t, torch.Tensor) else t
            for t in args
        ]
394
        with self.fake_mode, enable_python_dispatcher():
395
            return super().run(*fake_args)
396

397
398
399
400
401
402
    def call_module(
        self,
        target: torch.fx.node.Target,
        args: tuple[torch.fx.node.Argument, ...],
        kwargs: dict[str, Any],
    ) -> Any:
403
        assert isinstance(target, str)
404

405
406
407
        output = super().call_module(target, args, kwargs)

        if target in self.compile_submod_names:
408
            index = self.compile_submod_names.index(target)
409
            submod = self.fetch_attr(target)
410

411
412
413
            sym_shape_indices = [
                i for i, x in enumerate(args) if isinstance(x, torch.SymInt)
            ]
414

415
            # Lazy import here to avoid circular import
416
            from .piecewise_backend import PiecewiseBackend
417

418
            piecewise_backend = PiecewiseBackend(
419
420
421
422
423
424
425
                submod,
                self.vllm_config,
                index,
                len(self.compile_submod_names),
                sym_shape_indices,
                self.vllm_backend,
            )
426

427
428
429
430
            if (
                self.compilation_config.cudagraph_mode.has_piecewise_cudagraphs()
                and not self.compilation_config.use_inductor_graph_partition
            ):
431
432
433
434
                # We're using Dynamo-based piecewise splitting, so we wrap
                # the whole subgraph with a static graph wrapper.
                from .cuda_graph import CUDAGraphOptions

435
436
437
                # resolve the static graph wrapper class (e.g. CUDAGraphWrapper
                # class) as platform dependent.
                static_graph_wrapper_class = resolve_obj_by_qualname(
438
439
                    current_platform.get_static_graph_wrapper_cls()
                )
440
441
442
443
444
445
446
447
448
449
450
451

                # Always assign PIECEWISE runtime mode to the
                # CUDAGraphWrapper for piecewise_backend, to distinguish
                # it from the FULL cudagraph runtime mode, no matter it
                # is wrapped on a full or piecewise fx graph.
                self.module.__dict__[target] = static_graph_wrapper_class(
                    runnable=piecewise_backend,
                    vllm_config=self.vllm_config,
                    runtime_mode=CUDAGraphMode.PIECEWISE,
                    cudagraph_options=CUDAGraphOptions(
                        debug_log_enable=piecewise_backend.is_first_graph,
                        gc_disable=not piecewise_backend.is_first_graph,
452
453
454
                        weak_ref_output=piecewise_backend.is_last_graph,
                    ),
                )
455
456
457
            else:
                self.module.__dict__[target] = piecewise_backend

458
459
460
461
462
            compilation_counter.num_piecewise_capturable_graphs_seen += 1

        return output


463
464
465
# the tag for the part of model being compiled,
# e.g. backbone/eagle_head
model_tag: str = "backbone"
466
model_is_encoder: bool = False
467
468
469


@contextmanager
470
def set_model_tag(tag: str, is_encoder: bool = False):
471
472
    """Context manager to set the model tag."""
    global model_tag
473
    global model_is_encoder
474
    assert tag != model_tag, (
475
        f"Model tag {tag} is the same as the current tag {model_tag}."
476
    )
477
    old_tag = model_tag
478
479
    old_is_encoder = model_is_encoder

480
    model_tag = tag
481
    model_is_encoder = is_encoder
482
483
484
485
    try:
        yield
    finally:
        model_tag = old_tag
486
        model_is_encoder = old_is_encoder
487
488


489
class VllmBackend:
490
    """The compilation backend for `torch.compile` with vLLM.
491
    It is used for compilation mode of `CompilationMode.VLLM_COMPILE`,
492
    where we customize the compilation.
493

494
495
    The major work of this backend is to split the graph into
    piecewise graphs, and pass them to the piecewise backend.
496

497
498
    This backend also adds the PostGradPassManager to Inductor config,
    which handles the post-grad passes.
499
    """
500

501
502
    vllm_config: VllmConfig
    compilation_config: CompilationConfig
503
504
505
506
507
    _called: bool = False
    # the graph we compiled
    graph: fx.GraphModule
    # the stiching graph module for all the piecewise graphs
    split_gm: fx.GraphModule
508
    piecewise_graphs: list[SplitItem]
509
    returned_callable: Callable
510
511
    # Inductor passes to run on the graph pre-defunctionalization
    post_grad_passes: Sequence[Callable]
512
513
    sym_tensor_indices: list[int]
    input_buffers: list[torch.Tensor]
514
    compiler_manager: CompilerManager
515
516
517
    # Copy of CompilationConfig.inductor_compile_config +
    # an entry for PostGradPassManager
    inductor_config: dict[str, Any]
518

519
520
    def __init__(
        self,
521
        vllm_config: VllmConfig,
522
        prefix: str = "",
523
        is_encoder: bool = False,
524
    ):
525
526
        # if the model is initialized with a non-empty prefix,
        # then usually it's enough to use that prefix,
527
        # e.g. language_model, vision_model, etc.
528
529
530
531
532
        # when multiple parts are initialized as independent
        # models, we need to use the model_tag to distinguish
        # them, e.g. backbone (default), eagle_head, etc.
        self.prefix = prefix or model_tag

533
        # Mark compilation for encoder.
534
        self.is_encoder = is_encoder or model_is_encoder
535

536
        # Passes to run on the graph post-grad.
537
538
539
540
        self.pass_manager = resolve_obj_by_qualname(
            current_platform.get_pass_manager_cls()
        )()
        self.pass_key = current_platform.pass_key
541

542
543
544
        self.sym_tensor_indices = []
        self.input_buffers = []

545
546
        self.vllm_config = vllm_config
        self.compilation_config = vllm_config.compilation_config
547

548
        self.compiler_manager: CompilerManager = CompilerManager(
549
550
            self.compilation_config
        )
551

552
553
554
555
556
557
        # Deepcopy the inductor config to detach the post-grad custom pass
        # from CompilationConfig.
        # We want to avoid PostGradPassManager in CompilationConfig because
        # in future we need PostGradPassManager.uuid() to be executed
        # only at compile time.
        self.inductor_config = deepcopy(self.compilation_config.inductor_compile_config)
558
559
560
        # `torch.compile` is JIT compiled, so we don't need to
        # do anything here

561
    def configure_post_pass(self):
562
        self.pass_manager.configure(self.vllm_config)
563

564
565
        # Post-grad custom passes are run using the post_grad_custom_post_pass
        # hook. If a pass for that hook exists, add it to the pass manager.
566
567
568
569
570
        if self.pass_key in self.inductor_config:
            if isinstance(self.inductor_config[self.pass_key], PostGradPassManager):
                raise ValueError(
                    "PostGradPassManager can not be kept in CompilationConfig."
                )
571
            else:
572
                # Config should automatically wrap all inductor passes
573
574
575
576
577
578
579
                assert isinstance(
                    self.compilation_config.inductor_compile_config[self.pass_key],
                    InductorPass,
                )
                self.pass_manager.add(
                    self.compilation_config.inductor_compile_config[self.pass_key]
                )
580
        self.inductor_config[self.pass_key] = self.pass_manager
581

582
583
584
    def __call__(
        self, graph: fx.GraphModule, example_inputs
    ) -> VllmSerializableFunction:
585
        vllm_config = self.vllm_config
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
        # Minimal hashing here with existing utilities, reused below.

        env_factors = envs.compile_factors()
        env_hash = hash_factors(env_factors)
        # Compute config/compiler/code hashes once and reuse
        config_hash = vllm_config.compute_hash()
        compiler_hash = self.compiler_manager.compute_hash(vllm_config)
        forward_code_files = list(sorted(self.compilation_config.traced_files))

        logger.debug(
            "Traced files (to be considered for compilation cache):\n%s",
            lazy(lambda: "\n".join(forward_code_files)),
        )
        hash_content = []
        for filepath in forward_code_files:
            hash_content.append(filepath)
            if filepath == "<string>":
                # This means the function was dynamically generated, with
                # e.g. exec(). We can't actually check these.
                continue
            try:
                with open(filepath) as f:
                    hash_content.append(f.read())
            except Exception:
                logger.warning("Failed to read file %s", filepath)
                continue
        code_hash = hashlib.sha256("\n".join(hash_content).encode()).hexdigest()
        # Clear after consumption
        self.compilation_config.traced_files.clear()
615
616
617
618
619
        if not self.compilation_config.cache_dir:
            # no provided cache dir, generate one based on the known factors
            # that affects the compilation. if none of the factors change,
            # the cache dir will be the same so that we can reuse the compiled
            # graph.
620
621
622
623
            factors = [env_hash, config_hash, code_hash, compiler_hash]
            # Use SHA-256 for cache key hashing to be consistent across
            # compute_hash functions. Truncate for a short cache dir name.
            hash_key = hashlib.sha256(str(factors).encode()).hexdigest()[:10]
624
            cache_dir = os.path.join(
625
                envs.VLLM_CACHE_ROOT, "torch_compile_cache", hash_key
626
627
628
            )
            self.compilation_config.cache_dir = cache_dir

629
        cache_dir = self.compilation_config.cache_dir
630
        os.makedirs(cache_dir, exist_ok=True)
631
        self.compilation_config.cache_dir = cache_dir
632
        rank = vllm_config.parallel_config.rank
633
        dp_rank = vllm_config.parallel_config.data_parallel_index
634
        local_cache_dir = os.path.join(cache_dir, f"rank_{rank}_{dp_rank}", self.prefix)
635
        os.makedirs(local_cache_dir, exist_ok=True)
636
        self.compilation_config.local_cache_dir = local_cache_dir
637

638
        # Honors opt-outs such as CompilationMode.NONE or VLLM_DISABLE_COMPILE_CACHE.
639
        disable_cache = not is_compile_cache_enabled(self.inductor_config)
640
641

        if disable_cache:
642
            logger.info_once("vLLM's torch.compile cache is disabled.", scope="local")
643
        else:
644
645
646
647
            logger.info_once(
                "Using cache directory: %s for vLLM's torch.compile",
                local_cache_dir,
                scope="local",
648
            )
649

650
651
652
        self.compiler_manager.initialize_cache(
            local_cache_dir, disable_cache, self.prefix
        )
653

654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
        # Reuses existing cache key

        logger.debug(
            "torch.compile cache factors: env=%s cfg=%s comp=%s code=%s dir=%s",
            env_hash,
            config_hash,
            compiler_hash,
            code_hash,
            local_cache_dir,
        )

        # Persist and log only hash-relevant factors together.
        try:
            logger.debug(
                "Compile env factors (raw):\n%s\nVllm config hash: %s",
                lazy(partial(pprint.pformat, env_factors, width=120)),
                config_hash,
            )
            meta_path = os.path.join(local_cache_dir, "cache_key_factors.json")
            if not os.path.exists(meta_path):
                with open(meta_path, "w") as f:
                    json.dump(
                        {
                            "env": env_factors,  # raw factors used for env_hash
                            "config_hash": config_hash,
                            "code_hash": code_hash,
                            "compiler_hash": compiler_hash,
                        },
                        f,
                        indent=2,
                        sort_keys=True,
                    )
        except Exception:
            # Best-effort only; metadata write failures are non-fatal.
            logger.warning(
                (
                    "Could not write compile cache metadata at %s; continuing without "
                    "metadata. Compiled cache remains valid; diagnostics may be "
                    "limited."
                ),
                local_cache_dir,
                exc_info=True,
            )

698
699
        # when dynamo calls the backend, it means the bytecode
        # transform and analysis are done
700
        compilation_counter.num_graphs_seen += 1
701
        from .monitor import torch_compile_start_time
702

703
        dynamo_time = time.time() - torch_compile_start_time
704
705
706
        logger.info_once(
            "Dynamo bytecode transform time: %.2f s", dynamo_time, scope="local"
        )
707
        self.compilation_config.compilation_time += dynamo_time
708
709
710
711
712
713

        # we control the compilation process, each instance can only be
        # called once
        assert not self._called, "VllmBackend can only be called once"

        self.graph = graph
714
        self.configure_post_pass()
715

716
717
718
719
720
721
        if self.compilation_config.use_inductor_graph_partition:
            # Let Inductor decide partitioning; avoid FX-level pre-splitting.
            fx_split_ops: list[str] = []
        else:
            fx_split_ops = self.compilation_config.splitting_ops or []

722
        self.split_gm, self.piecewise_graphs = split_graph(graph, fx_split_ops)
723

724
        from torch._dynamo.utils import lazy_format_graph_code
725
726
727
728
729

        # depyf will hook lazy_format_graph_code and dump the graph
        # for debugging, no need to print the graph here
        lazy_format_graph_code("before split", self.graph)
        lazy_format_graph_code("after split", self.split_gm)
730

731
        compilation_counter.num_piecewise_graphs_seen += len(self.piecewise_graphs)
732
        submod_names_to_compile = [
733
734
            item.submod_name
            for item in self.piecewise_graphs
735
736
737
            if not item.is_splitting_graph
        ]

738
739
740
741
742
743
744
745
746
747
        # Extract fake values from the graph to use them when needed.
        all_fake_values = []
        for i in graph.graph.find_nodes(op="placeholder"):
            all_fake_values.append(i.meta["example_value"])

        fake_args = [
            all_fake_values[i] if isinstance(t, torch.Tensor) else t
            for i, t in enumerate(example_inputs)
        ]

748
749
        # propagate the split graph to the piecewise backend,
        # compile submodules with symbolic shapes
750
751
        PiecewiseCompileInterpreter(
            self.split_gm, submod_names_to_compile, self.vllm_config, self
752
        ).run(*fake_args)
753

754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
        from torch._guards import detect_fake_mode

        fake_mode = detect_fake_mode()

        if (
            self.compilation_config.dynamic_shapes_config.evaluate_guards
            and self.compilation_config.dynamic_shapes_config.type
            == DynamicShapesType.BACKED
        ):
            from torch.utils._sympy.value_ranges import ValueRanges

            # Drop counter-0/1 specializations guards; for backed dynamic shapes,
            # torch.compile will specialize for 0/1 inputs or otherwise guards that
            # shape is >= 2. This is because it's really hard not to hit a check
            # against 0/1. When we evaluate shape guards, we exclude checking those
            # guards (We would fail always otherwise).

            # We avoid that by updating the ranges of backed sizes when the min is
            # 2 for any, we assume it's 0.
            for s, r in fake_mode.shape_env.var_to_range.items():
                if r.lower == 2:
                    fake_mode.shape_env.var_to_range[s] = ValueRanges(0, r.upper)

777
778
        graph_path = os.path.join(local_cache_dir, "computation_graph.py")
        if not os.path.exists(graph_path):
779
780
            # code adapted from
            # https://github.com/thuml/depyf/blob/dab831108a752d1facc00acdd6d4243891845c37/depyf/explain/patched_lazy_format_graph_code.py#L30
781
            # use `print_readable` because it can include submodules
782
783
784
785
            src = (
                "from __future__ import annotations\nimport torch\n"
                + self.split_gm.print_readable(print_output=False)
            )
786
787
788
789
            src = src.replace("<lambda>", "GraphModule")
            with open(graph_path, "w") as f:
                f.write(src)

790
791
792
            logger.debug_once(
                "Computation graph saved to %s", graph_path, scope="local"
            )
793

794
795
        self._called = True

796
797
798
799
        if (
            self.compilation_config.cudagraph_mode == CUDAGraphMode.NONE
            or not self.compilation_config.cudagraph_copy_inputs
        ):
800
            return VllmSerializableFunction(
801
                graph, example_inputs, self.prefix, self.split_gm, self.is_encoder
802
            )
803
804

        # index of tensors that have symbolic shapes (batch size)
805
806
807
        # for weights and static buffers, they will have concrete shapes.
        # symbolic shape only happens for input tensors.
        from torch.fx.experimental.symbolic_shapes import is_symbolic
808

809
        self.sym_tensor_indices = [
810
811
812
813
            i
            for i, x in enumerate(fake_args)
            if isinstance(x, torch._subclasses.fake_tensor.FakeTensor)
            and any(is_symbolic(d) for d in x.size())
814
815
816
817
818
819
820
821
822
        ]

        # compiler managed cudagraph input buffers
        # we assume the first run with symbolic shapes
        # has the maximum size among all the tensors
        self.input_buffers = [
            example_inputs[x].clone() for x in self.sym_tensor_indices
        ]

youkaichao's avatar
youkaichao committed
823
824
        # this is the callable we return to Dynamo to run
        def copy_and_call(*args):
825
826
827
828
829
830
831
832
833
834
835
836
837
            list_args = list(args)
            for i, index in enumerate(self.sym_tensor_indices):
                runtime_tensor = list_args[index]
                runtime_shape = runtime_tensor.shape[0]
                static_tensor = self.input_buffers[i][:runtime_shape]

                # copy the tensor to the static buffer
                static_tensor.copy_(runtime_tensor)

                # replace the tensor in the list_args to the static buffer
                list_args[index] = static_tensor
            return self.split_gm(*list_args)

838
        return VllmSerializableFunction(
839
            graph, example_inputs, self.prefix, copy_and_call, self.is_encoder
840
        )