"vllm/vscode:/vscode.git/clone" did not exist on "0229c386c541a293f18a9ffe1a5cd7735d487158"
scheduler.py 79 KB
Newer Older
1
import enum
2
3
import os
import random
4
import time
5
from collections import deque
6
from dataclasses import dataclass, field
7
8
9
from typing import Callable, Deque, Dict, Iterable, List, Optional
from typing import Sequence as GenericSequence
from typing import Set, Tuple, Union
Woosuk Kwon's avatar
Woosuk Kwon committed
10

11
from vllm.config import CacheConfig, LoRAConfig, SchedulerConfig
12
from vllm.core.interfaces import AllocStatus, BlockSpaceManager
Woosuk Kwon's avatar
Woosuk Kwon committed
13
from vllm.logger import init_logger
14
from vllm.lora.request import LoRARequest
15
from vllm.prompt_adapter.request import PromptAdapterRequest
Woosuk Kwon's avatar
Woosuk Kwon committed
16
from vllm.sequence import (Sequence, SequenceData, SequenceGroup,
17
18
                           SequenceGroupMetadata, SequenceGroupMetadataDelta,
                           SequenceStatus)
19
from vllm.utils import Device, PyObjectCache
Woosuk Kwon's avatar
Woosuk Kwon committed
20

Woosuk Kwon's avatar
Woosuk Kwon committed
21
logger = init_logger(__name__)
22

23
24
25
26
27
28
29
# Test-only. If configured, decode is preempted with
# ARTIFICIAL_PREEMPTION_PROB% probability.
ENABLE_ARTIFICIAL_PREEMPT = bool(
    os.getenv("VLLM_TEST_ENABLE_ARTIFICIAL_PREEMPT", False))  # noqa
ARTIFICIAL_PREEMPTION_PROB = 0.5
ARTIFICIAL_PREEMPTION_MAX_CNT = 500

Woosuk Kwon's avatar
Woosuk Kwon committed
30

31
32
33
34
35
36
37
38
39
40
41
42
43
class PreemptionMode(enum.Enum):
    """Preemption modes.

    1. Swapping: Swap out the blocks of the preempted sequences to CPU memory
    and swap them back in when the sequences are resumed.
    2. Recomputation: Discard the blocks of the preempted sequences and
    recompute them when the sequences are resumed, treating the sequences as
    new prompts.
    """
    SWAP = enum.auto()
    RECOMPUTE = enum.auto()


44
45
@dataclass
class SchedulingBudget:
46
47
48
49
50
51
52
53
54
    """The available slots for scheduling.

    TODO(sang): Right now, the budget is request_id-aware meaning it can ignore
    budget update from the same request_id. It is because in normal scheduling
    path, we update RUNNING num_seqs ahead of time, meaning it could be
    updated more than once when scheduling RUNNING requests. Since this won't
    happen if we only have chunked prefill scheduling, we can remove this
    feature from the API when chunked prefill is enabled by default.
    """
55
56
    token_budget: int
    max_num_seqs: int
57
58
    _request_ids_num_batched_tokens: Set[str] = field(default_factory=set)
    _request_ids_num_curr_seqs: Set[str] = field(default_factory=set)
59
60
61
    # Number of cached tokens in the batch.
    _num_cached_tokens: int = 0
    # Number of actual non-cached tokens in the batch.
62
63
    _num_batched_tokens: int = 0
    _num_curr_seqs: int = 0
64
65

    def can_schedule(self, *, num_new_tokens: int, num_new_seqs: int):
66
67
68
        # We allow num_new_tokens to be 0 when the entire sequence has
        # been cached.
        assert num_new_tokens >= 0
69
        assert num_new_seqs != 0
70
71
72
        return (self.num_batched_tokens + num_new_tokens <= self.token_budget
                and self.num_curr_seqs + num_new_seqs <= self.max_num_seqs)

73
74
75
    def remaining_token_budget(self):
        return self.token_budget - self.num_batched_tokens

76
77
78
79
    def add_num_batched_tokens(self,
                               req_id: str,
                               num_batched_tokens: int,
                               num_cached_tokens: int = 0):
80
        if req_id in self._request_ids_num_batched_tokens:
81
            return
82
83
        assert num_cached_tokens >= 0
        assert num_batched_tokens >= 0
84

85
        self._request_ids_num_batched_tokens.add(req_id)
86
        self._num_batched_tokens += num_batched_tokens
87
        self._num_cached_tokens += num_cached_tokens
88
89
90

    def subtract_num_batched_tokens(self, req_id: str,
                                    num_batched_tokens: int):
91
92
        if req_id in self._request_ids_num_batched_tokens:
            self._request_ids_num_batched_tokens.remove(req_id)
93
94
95
            self._num_batched_tokens -= num_batched_tokens

    def add_num_seqs(self, req_id: str, num_curr_seqs: int):
96
        if req_id in self._request_ids_num_curr_seqs:
97
98
            return

99
        self._request_ids_num_curr_seqs.add(req_id)
100
101
102
        self._num_curr_seqs += num_curr_seqs

    def subtract_num_seqs(self, req_id: str, num_curr_seqs: int):
103
104
        if req_id in self._request_ids_num_curr_seqs:
            self._request_ids_num_curr_seqs.remove(req_id)
105
106
107
108
109
110
111
112
113
114
            self._num_curr_seqs -= num_curr_seqs

    @property
    def num_batched_tokens(self):
        return self._num_batched_tokens

    @property
    def num_curr_seqs(self):
        return self._num_curr_seqs

115
116
117
118
    @property
    def num_cached_tokens(self):
        return self._num_cached_tokens

119

120
121
122
123
124
125
126
127
128
129
@dataclass
class ScheduledSequenceGroup:
    # A sequence group that's scheduled.
    seq_group: SequenceGroup
    # The total chunk size (number of tokens) to process for next iteration.
    # 1 for decoding. Same as prompt tokens for prefill, but if prefill is
    # chunked, it can be smaller than that.
    token_chunk_size: int


130
@dataclass
131
class SchedulerOutputs:
132
    """The scheduling decision made from a scheduler."""
133
    # Scheduled sequence groups.
134
    scheduled_seq_groups: GenericSequence[ScheduledSequenceGroup]
135
136
137
138
    # Number of prefill groups scheduled.
    num_prefill_groups: int
    # Total number of batched tokens.
    num_batched_tokens: int
139
140
141
142
    # Blocks to swap in. List of CPU -> GPU block number.
    blocks_to_swap_in: List[Tuple[int, int]]
    # Blocks to swap out. List of GPU -> CPU block number.
    blocks_to_swap_out: List[Tuple[int, int]]
143
144
    # Blocks to copy. Source to dest block.
    blocks_to_copy: List[Tuple[int, int]]
145
146
147
148
    # Sequence groups that are going to be ignored.
    ignored_seq_groups: List[SequenceGroup]
    # The number of slots for lookahead decoding.
    num_lookahead_slots: int
149
150
    # The number of requests in the running queue
    running_queue_size: int
151
    preempted: int
152
153

    def __post_init__(self):
154
        # Swap in and swap out should never happen at the same time.
155
        assert not (self.blocks_to_swap_in and self.blocks_to_swap_out)
156

157
        self.num_loras: int = len(self.lora_requests)
158
159
160
        if self.num_loras > 0:
            self._sort_by_lora_ids()

161
162
        self.num_prompt_adapters: int = len(self.prompt_adapter_requests)

163
    def is_empty(self) -> bool:
Woosuk Kwon's avatar
Woosuk Kwon committed
164
165
166
        # NOTE: We do not consider the ignored sequence groups.
        return (not self.scheduled_seq_groups and not self.blocks_to_swap_in
                and not self.blocks_to_swap_out and not self.blocks_to_copy)
167

168
    def _sort_by_lora_ids(self):
169
170
171
172
173
174
175
176
177
178
179
180
        assert 0 <= self.num_prefill_groups <= len(self.scheduled_seq_groups)

        def key_fn(group: ScheduledSequenceGroup):
            key = (group.seq_group.lora_int_id, group.seq_group.request_id)
            if 0 < self.num_prefill_groups < len(self.scheduled_seq_groups):
                # Sort sequence groups so that all prefills come before all
                # decodes as required by chunked prefill.
                return (not group.seq_group.is_prefill(), *key)
            return key

        self.scheduled_seq_groups = sorted(self.scheduled_seq_groups,
                                           key=key_fn)
181
182
183

    @property
    def lora_requests(self) -> Set[LoRARequest]:
184
185
186
187
188
        return {
            g.seq_group.lora_request
            for g in self.scheduled_seq_groups
            if g.seq_group.lora_request is not None
        }
189

190
191
192
193
194
195
196
197
    @property
    def prompt_adapter_requests(self) -> Set[PromptAdapterRequest]:
        return {
            g.seq_group.prompt_adapter_request
            for g in self.scheduled_seq_groups
            if g.seq_group.prompt_adapter_request is not None
        }

198

199
@dataclass
200
201
202
203
204
205
206
class SchedulerRunningOutputs:
    """The requests that are scheduled from a running queue.

    Could contain prefill (prefill that's chunked) or decodes. If there's not
    enough memory, it can be preempted (for recompute) or swapped out.
    """
    # Selected sequences that are running and in a decoding phase.
207
    decode_seq_groups: List[ScheduledSequenceGroup]
208
209
    # Selected sequences that are running and in a prefill phase.
    # I.e., it means the prefill has been chunked.
210
    prefill_seq_groups: List[ScheduledSequenceGroup]
211
212
213
214
215
    # The preempted sequences.
    preempted: List[SequenceGroup]
    # Sequences that are swapped out.
    swapped_out: List[SequenceGroup]
    # The blocks to swap out.
216
    blocks_to_swap_out: List[Tuple[int, int]]
217
    # The blocks to copy.
218
    blocks_to_copy: List[Tuple[int, int]]
219
    # The number of slots for lookahead decoding.
220
221
    num_lookahead_slots: int

222
223
224
225
    # Optimization for fast-access to seq_group lists
    decode_seq_groups_list: List[SequenceGroup]
    prefill_seq_groups_list: List[SequenceGroup]

226
    @classmethod
227
228
229
230
    def create_empty(cls) -> "SchedulerRunningOutputs":
        return SchedulerRunningOutputs(
            decode_seq_groups=[],
            prefill_seq_groups=[],
231
232
            preempted=[],
            swapped_out=[],
233
            blocks_to_swap_out=[],
234
            blocks_to_copy=[],
235
            num_lookahead_slots=0,
236
237
            decode_seq_groups_list=[],
            prefill_seq_groups_list=[],
238
239
240
241
242
        )


@dataclass
class SchedulerSwappedInOutputs:
243
244
245
246
247
248
    """The requests that are scheduled from a swap queue.

    Could contain prefill (prefill that's chunked) or decodes.
    """
    # Selected sequences that are going to be swapped in and is in a
    # decoding phase.
249
    decode_seq_groups: List[ScheduledSequenceGroup]
250
251
    # Selected sequences that are going to be swapped in and in a prefill
    # phase. I.e., it means the prefill has been chunked.
252
    prefill_seq_groups: List[ScheduledSequenceGroup]
253
    # The blocks to swap in.
254
    blocks_to_swap_in: List[Tuple[int, int]]
255
    # The blocks to copy.
256
    blocks_to_copy: List[Tuple[int, int]]
257
    # The number of slots for lookahead decoding.
258
    num_lookahead_slots: int
259
260
    # Infeasible sequence groups.
    infeasible_seq_groups: List[SequenceGroup]
261
262
263
264

    @classmethod
    def create_empty(cls) -> "SchedulerSwappedInOutputs":
        return SchedulerSwappedInOutputs(
265
266
            decode_seq_groups=[],
            prefill_seq_groups=[],
267
            blocks_to_swap_in=[],
268
            blocks_to_copy=[],
269
            num_lookahead_slots=0,
270
            infeasible_seq_groups=[],
271
272
273
274
275
        )


@dataclass
class SchedulerPrefillOutputs:
276
277
278
279
280
281
    """The requests that are scheduled from a waiting queue.

    Could contain a fresh prefill requests or preempted requests that need
    to be recomputed from scratch.
    """
    # Selected sequences for prefill.
282
    seq_groups: List[ScheduledSequenceGroup]
283
284
285
286
287
288
289
290
291
292
293
294
295
    # Ignored sequence groups.
    ignored_seq_groups: List[SequenceGroup]
    num_lookahead_slots: int

    @classmethod
    def create_empty(cls) -> "SchedulerPrefillOutputs":
        return SchedulerPrefillOutputs(
            seq_groups=[],
            ignored_seq_groups=[],
            num_lookahead_slots=0,
        )


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
def seq_group_metadata_builder():
    return SequenceGroupMetadata(request_id="",
                                 is_prompt=False,
                                 seq_data={},
                                 sampling_params=None,
                                 block_tables={})


def scheduler_running_outputs_builder():
    return SchedulerRunningOutputs(decode_seq_groups=[],
                                   prefill_seq_groups=[],
                                   preempted=[],
                                   swapped_out=[],
                                   blocks_to_swap_out=[],
                                   blocks_to_copy=[],
                                   num_lookahead_slots=0,
                                   prefill_seq_groups_list=[],
                                   decode_seq_groups_list=[])


def scheduled_seq_group_builder():
317
    return ScheduledSequenceGroup(SequenceGroup.__new__(SequenceGroup),
318
319
                                  token_chunk_size=0)
    # return ScheduledSequenceGroup(seq_group=None, token_chunk_size=0)
320
321


Woosuk Kwon's avatar
Woosuk Kwon committed
322
323
class Scheduler:

Woosuk Kwon's avatar
Woosuk Kwon committed
324
    def __init__(
Woosuk Kwon's avatar
Woosuk Kwon committed
325
        self,
326
327
        scheduler_config: SchedulerConfig,
        cache_config: CacheConfig,
328
        lora_config: Optional[LoRAConfig],
329
        pipeline_parallel_size: int = 1,
330
        output_proc_callback: Optional[Callable] = None,
Woosuk Kwon's avatar
Woosuk Kwon committed
331
    ) -> None:
332
333
        self.scheduler_config = scheduler_config
        self.cache_config = cache_config
334
335
336
337
        # Note for LoRA scheduling: the current policy is extremely
        # simple and NOT fair. It can lead to starvation of some
        # LoRAs. This should be improved in the future.
        self.lora_config = lora_config
Woosuk Kwon's avatar
Woosuk Kwon committed
338

339
        version = "selfattn"
340
        if (self.scheduler_config.runner_type == "pooling"
341
342
                or self.cache_config.is_attention_free):
            version = "placeholder"
343

344
        BlockSpaceManagerImpl = BlockSpaceManager.get_block_space_manager_class(
345
            version)
346

347
348
349
350
351
352
353
354
        num_gpu_blocks = cache_config.num_gpu_blocks
        if num_gpu_blocks:
            num_gpu_blocks //= pipeline_parallel_size

        num_cpu_blocks = cache_config.num_cpu_blocks
        if num_cpu_blocks:
            num_cpu_blocks //= pipeline_parallel_size

Woosuk Kwon's avatar
Woosuk Kwon committed
355
        # Create the block space manager.
356
        self.block_manager = BlockSpaceManagerImpl(
357
            block_size=self.cache_config.block_size,
358
359
            num_gpu_blocks=num_gpu_blocks,
            num_cpu_blocks=num_cpu_blocks,
360
361
            sliding_window=self.cache_config.sliding_window,
            enable_caching=self.cache_config.enable_prefix_caching)
362

363
        # Sequence groups in the WAITING state.
364
        # Contain new prefill or preempted requests.
365
        self.waiting: Deque[SequenceGroup] = deque()
366
        # Sequence groups in the RUNNING state.
367
        # Contain decode requests.
368
        self.running: Deque[SequenceGroup] = deque()
369
        # Sequence groups in the SWAPPED state.
370
        # Contain decode requests that are swapped out.
371
        self.swapped: Deque[SequenceGroup] = deque()
Mor Zusman's avatar
Mor Zusman committed
372
373
374
        # Sequence groups finished requests ids since last step iteration.
        # It lets the model know that any state associated with these requests
        # can and must be released after the current step.
375
        # This is used to evict the finished requests from the Mamba cache.
Mor Zusman's avatar
Mor Zusman committed
376
        self._finished_requests_ids: List[str] = list()
377
378
379
380
381
382
        # Time at previous scheduling step
        self.prev_time = 0.0
        # Did we schedule a prompt at previous step?
        self.prev_prompt = False
        # Latency of the last prompt step
        self.last_prompt_latency = 0.0
383
384
        # preemption mode, RECOMPUTE or SWAP
        self.user_specified_preemption_mode = scheduler_config.preemption_mode
385

386
387
388
389
390
391
        # The following field is test-only. It is used to inject artificial
        # preemption.
        self.enable_artificial_preemption = ENABLE_ARTIFICIAL_PREEMPT
        self.artificial_preempt_cnt = (ARTIFICIAL_PREEMPTION_MAX_CNT
                                       if self.enable_artificial_preemption
                                       else 0)
392
        self.num_cumulative_preemption: int = 0
393

394
        # Used to cache python objects
395
396
397
398
399
400
401
402
        self._seq_group_metadata_cache: List[PyObjectCache] = []
        self._scheduler_running_outputs_cache: List[PyObjectCache] = []
        self._scheduled_seq_group_cache: List[PyObjectCache] = []

        # For async output processing, we need to swap cache buffers between
        # iterations. I.e. since the output processing is lagged one step,
        # we cannot reuse the cached objects immediately when the schedule()
        # is called again, but only when schedule() is called the second time.
403
404
        self.output_proc_callback = output_proc_callback
        self.use_async_output_proc = self.output_proc_callback is not None
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
        self.num_cache_iters = 2 if self.use_async_output_proc else 1

        self.cache_id = 0
        for i in range(self.num_cache_iters):
            self._seq_group_metadata_cache.append(
                PyObjectCache(seq_group_metadata_builder))
            self._scheduler_running_outputs_cache.append(
                PyObjectCache(scheduler_running_outputs_builder))
            self._scheduled_seq_group_cache.append(
                PyObjectCache(scheduled_seq_group_builder))

        # For async postprocessor, the extra decode run cannot be done
        # when the request reaches max_model_len. In this case, the request
        # will be stopped during schedule() call and added to this stop list
        # for processing and deallocation by the free_finished_seq_groups()
        self._async_stopped: List[SequenceGroup] = []

    @property
    def next_cache_id(self):
        return (self.cache_id + 1) % self.num_cache_iters
425

426
427
428
429
    @property
    def lora_enabled(self) -> bool:
        return bool(self.lora_config)

430
431
432
433
434
    @property
    def num_decoding_tokens_per_seq(self) -> int:
        """The number of new tokens."""
        return 1

435
    def add_seq_group(self, seq_group: SequenceGroup) -> None:
436
        # Add sequence groups to the waiting queue.
437
        self.waiting.append(seq_group)
Woosuk Kwon's avatar
Woosuk Kwon committed
438

439
440
441
442
443
444
445
446
447
448
    def _add_seq_group_to_running(self, seq_group: SequenceGroup) -> None:
        # Add sequence groups to the running queue.
        # Only for testing purposes.
        self.running.append(seq_group)

    def _add_seq_group_to_swapped(self, seq_group: SequenceGroup) -> None:
        # Add sequence groups to the swapped queue.
        # Only for testing purposes.
        self.swapped.append(seq_group)

Antoni Baum's avatar
Antoni Baum committed
449
    def abort_seq_group(self, request_id: Union[str, Iterable[str]]) -> None:
450
451
452
453
454
455
456
457
458
459
460
461
        """Aborts a sequence group with the given ID.

        Check if the sequence group with the given ID
            is present in any of the state queue.
        If present, remove the sequence group from the state queue.
            Also, if any of the sequences in the sequence group is not finished,
                free the sequence with status `FINISHED_ABORTED`.
        Otherwise, do nothing.

        Args:
            request_id: The ID(s) of the sequence group to abort.
        """
Antoni Baum's avatar
Antoni Baum committed
462
463
464
        if isinstance(request_id, str):
            request_id = (request_id, )
        request_ids = set(request_id)
465
        for state_queue in [self.waiting, self.running, self.swapped]:
ljss's avatar
ljss committed
466
            aborted_groups: List[SequenceGroup] = []
467
468
469
            for seq_group in state_queue:
                if not request_ids:
                    # Using 'break' here may add two extra iterations,
470
                    # but is acceptable to reduce complexity.
471
                    break
Antoni Baum's avatar
Antoni Baum committed
472
                if seq_group.request_id in request_ids:
473
474
                    # Appending aborted group into pending list.
                    aborted_groups.append(seq_group)
Antoni Baum's avatar
Antoni Baum committed
475
                    request_ids.remove(seq_group.request_id)
476
477
478
            for aborted_group in aborted_groups:
                # Remove the sequence group from the state queue.
                state_queue.remove(aborted_group)
479
                # Remove the aborted request from the Mamba cache.
480
                self._finished_requests_ids.append(aborted_group.request_id)
ljss's avatar
ljss committed
481
                for seq in aborted_group.get_seqs():
482
483
484
485
                    if seq.is_finished():
                        continue
                    seq.status = SequenceStatus.FINISHED_ABORTED
                    self.free_seq(seq)
486

487
488
489
490
491
492
493
494
495
496
497
498
499
                self._free_seq_group_cross_attn_blocks(aborted_group)

    def _free_seq_group_cross_attn_blocks(
        self,
        seq_group: SequenceGroup,
    ) -> None:
        """
        Free a sequence group from a cross-attention block table.
        Has no effect on decoder-only models.
        """
        if seq_group.is_encoder_decoder():
            self.block_manager.free_cross(seq_group)

500
    def has_unfinished_seqs(self) -> bool:
501
502
        return len(self.waiting) != 0 or len(self.running) != 0 or len(
            self.swapped) != 0
503

504
505
506
    def get_prefix_cache_hit_rate(self, device: Device) -> float:
        return self.block_manager.get_prefix_cache_hit_rate(device)

507
508
509
    def get_num_unfinished_seq_groups(self) -> int:
        return len(self.waiting) + len(self.running) + len(self.swapped)

Mor Zusman's avatar
Mor Zusman committed
510
511
512
513
514
515
    def get_and_reset_finished_requests_ids(self) -> List[str]:
        """Flushes the list of request ids of previously finished seq_groups."""
        finished_requests_ids = self._finished_requests_ids
        self._finished_requests_ids = list()
        return finished_requests_ids

516
    def _schedule_running(
517
518
519
        self,
        budget: SchedulingBudget,
        curr_loras: Optional[Set[int]],
520
        enable_chunking: bool = False,
521
    ) -> SchedulerRunningOutputs:
522
        """Schedule sequence groups that are running.
523

524
        Running queue should include decode and chunked prefill requests.
Woosuk Kwon's avatar
Woosuk Kwon committed
525

526
527
528
529
530
        Args:
            budget: The scheduling budget. The argument is in-place updated
                when any decodes are preempted.
            curr_loras: Currently batched lora request ids. The argument is
                in-place updated when any decodes are preempted.
531
532
533
534
535
            enable_chunking: If True, seq group can be chunked and only a
                chunked number of tokens are scheduled  if
                `budget.num_batched_tokens` has not enough capacity to schedule
                all tokens.
    
536
        Returns:
537
            SchedulerRunningOutputs.
538
        """
539
        ret: SchedulerRunningOutputs = \
540
            self._scheduler_running_outputs_cache[self.cache_id].get_object()
541
542
543
544
545
546
547
548
        ret.blocks_to_swap_out.clear()
        ret.blocks_to_copy.clear()
        ret.decode_seq_groups.clear()
        ret.prefill_seq_groups.clear()
        ret.preempted.clear()
        ret.swapped_out.clear()

        ret.num_lookahead_slots = self._get_num_lookahead_slots(
549
            is_prefill=False, enable_chunking=enable_chunking)
550
551
552
553

        ret.decode_seq_groups_list.clear()
        ret.prefill_seq_groups_list.clear()

554
        # Blocks that need to be swapped or copied before model execution.
555
556
        blocks_to_swap_out: List[Tuple[int, int]] = ret.blocks_to_swap_out
        blocks_to_copy: List[Tuple[int, int]] = ret.blocks_to_copy
Woosuk Kwon's avatar
Woosuk Kwon committed
557

558
559
560
561
562
        decode_seq_groups: List[ScheduledSequenceGroup] = ret.decode_seq_groups
        prefill_seq_groups: List[
            ScheduledSequenceGroup] = ret.prefill_seq_groups
        preempted: List[SequenceGroup] = ret.preempted
        swapped_out: List[SequenceGroup] = ret.swapped_out
Woosuk Kwon's avatar
Woosuk Kwon committed
563

564
565
        running_queue = self.running
        assert len(self._async_stopped) == 0
566
567
        while running_queue:
            seq_group = running_queue[0]
568
569
570
571
572
573
574
575
576
577
578
579
580
            # We discard the cached tokens info here because we don't need it
            # for running sequence:
            #   1. If a sequence is running with chunked prefill, the cached
            #      tokens info was already used for the first prefill.
            #   2. If a sequence is running with non-chunked prefill, then
            #      there it's a decoding sequence, and the cached tokens info is
            #      irrelevant.
            num_uncached_new_tokens, _ = (
                self._get_num_new_uncached_and_cached_tokens(
                    seq_group, SequenceStatus.RUNNING, enable_chunking,
                    budget))

            num_running_tokens = num_uncached_new_tokens
581
            if num_running_tokens == 0:
582
                # No budget => Stop
583
                break
584
585

            running_queue.popleft()
586
587
588
589
590
591
592
593
594
595

            # With async postprocessor, an extra decode run is done
            # to process the final tokens. The check below avoids this extra
            # decode run when the model max len is reached, in order to avoid
            # a memory overflow.
            if self.use_async_output_proc and seq_group.seqs[0].get_len(
            ) > self.scheduler_config.max_model_len:
                self._async_stopped.append(seq_group)
                continue

596
597
            # NOTE(woosuk): Preemption happens only when there is no available
            # slot to keep all the sequence groups in the RUNNING state.
598
            while not self._can_append_slots(seq_group, enable_chunking):
599
600
                budget.subtract_num_batched_tokens(seq_group.request_id,
                                                   num_running_tokens)
601
                num_running_seqs = seq_group.get_max_num_running_seqs()
602
603
                budget.subtract_num_seqs(seq_group.request_id,
                                         num_running_seqs)
604
605
606

                if (curr_loras is not None and seq_group.lora_int_id > 0
                        and seq_group.lora_int_id in curr_loras):
607
                    curr_loras.remove(seq_group.lora_int_id)
608

609
610
                # Determine victim sequence
                cont_loop = True
611
                if running_queue:
612
                    # Preempt the lowest-priority sequence group.
613
                    victim_seq_group = running_queue.pop()
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
                else:
                    # No other sequence group can be preempted.
                    # Preempt the current sequence group.
                    # Note: This is also where we stop this loop
                    # (since there is nothing else to preempt)
                    victim_seq_group = seq_group
                    cont_loop = False

                # With async postprocessor, before preempting a sequence
                # we need to ensure it has no pending async postprocessor
                do_preempt = True
                if self.use_async_output_proc:
                    assert self.output_proc_callback is not None
                    self.output_proc_callback(
                        request_id=victim_seq_group.request_id)

                    # It may be that the async pending "victim_seq_group"
                    # becomes finished, in which case we simply free it.
                    if victim_seq_group.is_finished():
                        self._free_finished_seq_group(victim_seq_group)
                        do_preempt = False

                # Do preemption
                if do_preempt:
638
639
640
641
642
643
                    preempted_mode = self._preempt(victim_seq_group,
                                                   blocks_to_swap_out)
                    if preempted_mode == PreemptionMode.RECOMPUTE:
                        preempted.append(victim_seq_group)
                    else:
                        swapped_out.append(victim_seq_group)
644
645

                if not cont_loop:
Woosuk Kwon's avatar
Woosuk Kwon committed
646
647
                    break
            else:
648
                self._append_slots(seq_group, blocks_to_copy, enable_chunking)
649
                is_prefill = seq_group.is_prefill()
650
651

                scheduled_seq_group: ScheduledSequenceGroup = \
652
                    self._scheduled_seq_group_cache[self.cache_id].get_object()
653
                scheduled_seq_group.seq_group = seq_group
654
                if is_prefill:
655
656
657
                    scheduled_seq_group.token_chunk_size = num_running_tokens
                    prefill_seq_groups.append(scheduled_seq_group)
                    ret.prefill_seq_groups_list.append(seq_group)
658
                else:
659
660
661
662
                    scheduled_seq_group.token_chunk_size = 1
                    decode_seq_groups.append(scheduled_seq_group)
                    ret.decode_seq_groups_list.append(seq_group)

663
664
                budget.add_num_batched_tokens(seq_group.request_id,
                                              num_running_tokens)
665
666
667
668
669
670
671
                # OPTIMIZATION:  Note that get_max_num_running_seqs is
                # expensive. For the default scheduling chase where
                # enable_chunking is False, num_seqs are updated before running
                # this method, so we don't have to update it again here.
                if enable_chunking:
                    num_running_seqs = seq_group.get_max_num_running_seqs()
                    budget.add_num_seqs(seq_group.request_id, num_running_seqs)
672
673
674
                if curr_loras is not None and seq_group.lora_int_id > 0:
                    curr_loras.add(seq_group.lora_int_id)

675
676
        self._scheduler_running_outputs_cache[self.next_cache_id].reset()
        self._scheduled_seq_group_cache[self.next_cache_id].reset()
677
678

        return ret
679

680
681
682
683
    def _schedule_swapped(
        self,
        budget: SchedulingBudget,
        curr_loras: Optional[Set[int]],
684
        enable_chunking: bool = False,
685
    ) -> SchedulerSwappedInOutputs:
686
        """Schedule sequence groups that are swapped out.
687

688
689
690
        It schedules swapped requests as long as it fits `budget` and
        curr_loras <= max_lora from the scheduling config. The input arguments
        `budget` and `curr_loras` are updated based on scheduled seq_groups.
691

692
693
694
695
696
        Args:
            budget: The scheduling budget. The argument is in-place updated
                when any requests are swapped in.
            curr_loras: Currently batched lora request ids. The argument is
                in-place updated when any requests are swapped in.
697
698
699
700
701
            enable_chunking: If True, seq group can be chunked and only a
                chunked number of tokens are scheduled  if
                `budget.num_batched_tokens` has not enough capacity to schedule
                all tokens.

702
703
704
705
        Returns:
            SchedulerSwappedInOutputs.
        """
        # Blocks that need to be swapped or copied before model execution.
706
        blocks_to_swap_in: List[Tuple[int, int]] = []
707
        blocks_to_copy: List[Tuple[int, int]] = []
708
709
        decode_seq_groups: List[ScheduledSequenceGroup] = []
        prefill_seq_groups: List[ScheduledSequenceGroup] = []
710
        infeasible_seq_groups: List[SequenceGroup] = []
711

712
713
        swapped_queue = self.swapped

714
        leftover_swapped: Deque[SequenceGroup] = deque()
715
716
717
718
        while swapped_queue:
            seq_group = swapped_queue[0]

            # If the sequence group cannot be swapped in, stop.
719
720
            is_prefill = seq_group.is_prefill()
            alloc_status = self.block_manager.can_swap_in(
721
722
                seq_group,
                self._get_num_lookahead_slots(is_prefill, enable_chunking))
723
            if alloc_status == AllocStatus.LATER:
724
                break
725
726
727
728
729
730
731
732
733
734
            elif alloc_status == AllocStatus.NEVER:
                logger.warning(
                    "Failing the request %s because there's not enough kv "
                    "cache blocks to run the entire sequence.",
                    seq_group.request_id)
                for seq in seq_group.get_seqs():
                    seq.status = SequenceStatus.FINISHED_IGNORED
                infeasible_seq_groups.append(seq_group)
                swapped_queue.popleft()
                continue
735
736
737
738

            lora_int_id = 0
            if self.lora_enabled:
                lora_int_id = seq_group.lora_int_id
739
740
741
                assert curr_loras is not None
                assert self.lora_config is not None
                if (lora_int_id > 0 and (lora_int_id not in curr_loras)
742
743
744
745
746
747
748
749
750
751
                        and len(curr_loras) >= self.lora_config.max_loras):
                    # We don't have a space for another LoRA, so
                    # we ignore this request for now.
                    leftover_swapped.appendleft(seq_group)
                    swapped_queue.popleft()
                    continue

            # The total number of sequences in the RUNNING state should not
            # exceed the maximum number of sequences.
            num_new_seqs = seq_group.get_max_num_running_seqs()
752
753
754
755
756
757
758
759
760
            num_new_tokens_uncached, num_new_tokens_cached = (
                self._get_num_new_uncached_and_cached_tokens(
                    seq_group, SequenceStatus.SWAPPED, enable_chunking,
                    budget))

            if num_new_tokens_uncached == 0 or not budget.can_schedule(
                    num_new_tokens=num_new_tokens_uncached,
                    num_new_seqs=num_new_seqs,
            ):
761
762
763
764
765
766
                break

            if lora_int_id > 0 and curr_loras is not None:
                curr_loras.add(lora_int_id)
            swapped_queue.popleft()
            self._swap_in(seq_group, blocks_to_swap_in)
767
            self._append_slots(seq_group, blocks_to_copy, enable_chunking)
768
769
770
            is_prefill = seq_group.is_prefill()
            if is_prefill:
                prefill_seq_groups.append(
771
772
773
774
775
                    ScheduledSequenceGroup(
                        seq_group,
                        token_chunk_size=num_new_tokens_uncached +
                        num_new_tokens_cached,
                    ))
776
777
778
            else:
                decode_seq_groups.append(
                    ScheduledSequenceGroup(seq_group, token_chunk_size=1))
779
780
781
782
783
            budget.add_num_batched_tokens(
                seq_group.request_id,
                num_batched_tokens=num_new_tokens_uncached,
                num_cached_tokens=num_new_tokens_cached,
            )
784
            budget.add_num_seqs(seq_group.request_id, num_new_seqs)
785
786
787

        swapped_queue.extendleft(leftover_swapped)

788
        return SchedulerSwappedInOutputs(
789
790
            decode_seq_groups=decode_seq_groups,
            prefill_seq_groups=prefill_seq_groups,
791
792
            blocks_to_swap_in=blocks_to_swap_in,
            blocks_to_copy=blocks_to_copy,
793
            num_lookahead_slots=self._get_num_lookahead_slots(
794
                is_prefill=False, enable_chunking=enable_chunking),
795
796
            infeasible_seq_groups=infeasible_seq_groups,
        )
797

798
    def _get_prompt_limit(self, seq_group: SequenceGroup) -> int:
799
800
        if self.scheduler_config.chunked_prefill_enabled and \
                not self.scheduler_config.is_multi_step:
801
802
803
804
805
806
807
808
809
810
811
812
813
            prompt_limit = self.scheduler_config.max_model_len
        else:
            prompt_limit = min(self.scheduler_config.max_model_len,
                               self.scheduler_config.max_num_batched_tokens)

        # Model is fine tuned with long context. Return the fine tuned max_len.
        if (seq_group.lora_request
                and seq_group.lora_request.long_lora_max_len):
            assert prompt_limit <= seq_group.lora_request.long_lora_max_len
            return seq_group.lora_request.long_lora_max_len
        else:
            return prompt_limit

814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
    def _get_priority(self,
                      seq_group: SequenceGroup) -> Tuple[Optional[int], float]:
        """ Get the priority of the sequence group.
        Highest preference to user-defined priority, followed by arrival time.
        Args:
            seq_group: The sequence group input.
        Returns:
            The priority of the sequence group.
        """
        return seq_group.priority, seq_group.arrival_time

    def _schedule_priority_preemption(
        self,
        budget: SchedulingBudget,
    ) -> int:
        """Sorts waiting and running queue. Also, force preempt requests
        from the running queue if their priority is lower.
        Priority-based preemption is used with the priority policy.
        Args:
            budget: The scheduling budget. The argument is in-place updated
                when any requests are scheduled.
        Returns:
            A count of priority-based preemptions.
        """

        waiting_queue = self.waiting

        running_queue = deque(sorted(self.running, key=self._get_priority))

        blocks_to_swap_out: List[Tuple[int, int]] = []
        force_preemption_count = 0

        if waiting_queue:
            seq_group = waiting_queue.popleft()
            num_new_seqs = seq_group.get_max_num_running_seqs()
849
850
851
            num_new_tokens_uncached, _ = (
                self._get_num_new_uncached_and_cached_tokens(
                    seq_group, SequenceStatus.WAITING, False, budget))
852
853
854
855
856
857

            #Only preempt if priority inversion exists
            while running_queue and self._get_priority(
                    running_queue[-1]) > self._get_priority(seq_group):
                #Only preempt if waiting sequence cannot be allocated
                can_allocate = self.block_manager.can_allocate(seq_group)
858
859
860
861
862
863
                if (num_new_tokens_uncached > 0
                        and can_allocate == AllocStatus.OK
                        and budget.can_schedule(
                            num_new_tokens=num_new_tokens_uncached,
                            num_new_seqs=num_new_seqs,
                        )):
864
865
866
867
                    break

                #Adjust budget to remove the victim sequence group
                vseq_group = running_queue.pop()
868
869
870
871
872
                num_running_tokens_uncached, _ = (
                    self._get_num_new_uncached_and_cached_tokens(
                        vseq_group, SequenceStatus.RUNNING, False, budget))
                budget.subtract_num_batched_tokens(
                    vseq_group.request_id, num_running_tokens_uncached)
873
874
875
876
877
                num_running_seqs = vseq_group.get_max_num_running_seqs()
                budget.subtract_num_seqs(vseq_group.request_id,
                                         num_running_seqs)

                #Preempt out the victim sequence group
878
                self._preempt(vseq_group, blocks_to_swap_out)
879
880
881
882
883
884
885
886
887
888
889
                waiting_queue.appendleft(vseq_group)
                force_preemption_count += 1
            #Put the sequence back into the waiting queue
            waiting_queue.appendleft(seq_group)

        waiting_queue = deque(sorted(waiting_queue, key=self._get_priority))

        self.waiting = waiting_queue
        self.running = running_queue
        return force_preemption_count

890
891
892
893
    def _schedule_prefills(
        self,
        budget: SchedulingBudget,
        curr_loras: Optional[Set[int]],
894
        enable_chunking: bool = False,
895
    ) -> SchedulerPrefillOutputs:
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
        """Schedule sequence groups that are in prefill stage.

        Note that the current scheduler treats PREEMPTED_FOR_RECOMPUTE
        as a new prefill (that starts from beginning -> most recently generated
        tokens).

        It schedules waiting requests as long as it fits `budget` and
        curr_loras <= max_lora from the scheduling config. The input arguments
        `budget` and `curr_loras` are updated based on scheduled seq_groups.

        Args:
            budget: The scheduling budget. The argument is in-place updated
                when any requests are scheduled.
            curr_loras: Currently batched lora request ids. The argument is
                in-place updated when any requests are scheduled.
911
912
913
914
            enable_chunking: If True, seq group can be chunked and only a
                chunked number of tokens are scheduled  if
                `budget.num_batched_tokens` has not enough capacity to schedule
                all tokens.
915
916

        Returns:
917
            SchedulerPrefillOutputs.
918
919
        """
        ignored_seq_groups: List[SequenceGroup] = []
920
        seq_groups: List[ScheduledSequenceGroup] = []
921
922

        waiting_queue = self.waiting
923

924
        leftover_waiting_sequences: Deque[SequenceGroup] = deque()
925
926
927
928
929
930
931
        while self._passed_delay(time.time()) and waiting_queue:
            seq_group = waiting_queue[0]

            waiting_seqs = seq_group.get_seqs(status=SequenceStatus.WAITING)
            assert len(waiting_seqs) == 1, (
                "Waiting sequence group should have only one prompt "
                "sequence.")
932
933
934
935
936
937
            num_new_tokens_uncached, num_new_tokens_cached = (
                self._get_num_new_uncached_and_cached_tokens(
                    seq_group, SequenceStatus.WAITING, enable_chunking,
                    budget))
            num_new_tokens = num_new_tokens_uncached + num_new_tokens_cached

938
939
940
941
            if not enable_chunking:
                num_prompt_tokens = waiting_seqs[0].get_len()
                assert num_new_tokens == num_prompt_tokens

942
943
            prompt_limit = self._get_prompt_limit(seq_group)
            if num_new_tokens > prompt_limit:
944
                logger.warning(
945
                    "Input prompt (%d tokens) is too long"
946
                    " and exceeds limit of %d", num_new_tokens, prompt_limit)
947
948
949
950
951
952
                for seq in waiting_seqs:
                    seq.status = SequenceStatus.FINISHED_IGNORED
                ignored_seq_groups.append(seq_group)
                waiting_queue.popleft()
                continue

953
954
955
956
957
            num_lookahead_slots: int = 0
            if self.scheduler_config.is_multi_step and enable_chunking:
                num_lookahead_slots = self._get_num_lookahead_slots(
                    True, enable_chunking)

958
            # If the sequence group cannot be allocated, stop.
959
960
            can_allocate = self.block_manager.can_allocate(
                seq_group, num_lookahead_slots=num_lookahead_slots)
961
962
963
964
            if can_allocate == AllocStatus.LATER:
                break
            elif can_allocate == AllocStatus.NEVER:
                logger.warning(
965
966
967
                    "Input prompt (%d tokens) + lookahead slots (%d) is "
                    "too long and exceeds the capacity of block_manager",
                    num_new_tokens, num_lookahead_slots)
968
969
970
971
972
973
974
975
976
                for seq in waiting_seqs:
                    seq.status = SequenceStatus.FINISHED_IGNORED
                ignored_seq_groups.append(seq_group)
                waiting_queue.popleft()
                continue

            lora_int_id = 0
            if self.lora_enabled:
                lora_int_id = seq_group.lora_int_id
977
978
                assert curr_loras is not None
                assert self.lora_config is not None
979
980
981
982
983
984
985
986
987
                if (self.lora_enabled and lora_int_id > 0
                        and lora_int_id not in curr_loras
                        and len(curr_loras) >= self.lora_config.max_loras):
                    # We don't have a space for another LoRA, so
                    # we ignore this request for now.
                    leftover_waiting_sequences.appendleft(seq_group)
                    waiting_queue.popleft()
                    continue

988
989
990
991
992
993
994
            if (budget.num_batched_tokens >=
                    self.scheduler_config.max_num_batched_tokens):
                # We've reached the budget limit - since there might be
                # continuous prefills in the running queue, we should break
                # to avoid scheduling any new prefills.
                break

995
            num_new_seqs = seq_group.get_max_num_running_seqs()
996
997
998
999
            if num_new_tokens_uncached == 0 or not budget.can_schedule(
                    num_new_tokens=num_new_tokens_uncached,
                    num_new_seqs=num_new_seqs,
            ):
1000
1001
1002
1003
1004
1005
                break

            # Can schedule this request.
            if curr_loras is not None and lora_int_id > 0:
                curr_loras.add(lora_int_id)
            waiting_queue.popleft()
1006
            self._allocate_and_set_running(seq_group)
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024

            if enable_chunking and self.scheduler_config.is_multi_step:
                blocks_to_copy: List[Tuple[int, int]] = []
                # init_multi_step_from_lookahead_slots happens in append_slots
                self._append_slots(seq_group, blocks_to_copy, enable_chunking)
                # This assert will trip when a copy-on-write happens. This is
                # not a concern as the very first sequence-group block
                # allocation happens above. Still, we have the assert to
                # catch any edge-cases.
                assert not blocks_to_copy
            else:
                seq_group.init_multi_step_from_lookahead_slots(
                    num_lookahead_slots,
                    num_scheduler_steps=self.scheduler_config.
                    num_scheduler_steps,
                    is_multi_step=self.scheduler_config.is_multi_step,
                    enable_chunking=enable_chunking)

1025
1026
            seq_groups.append(
                ScheduledSequenceGroup(seq_group=seq_group,
1027
                                       token_chunk_size=num_new_tokens))
1028
1029
1030
1031
1032
            budget.add_num_batched_tokens(
                seq_group.request_id,
                num_batched_tokens=num_new_tokens_uncached,
                num_cached_tokens=num_new_tokens_cached,
            )
1033
            budget.add_num_seqs(seq_group.request_id, num_new_seqs)
1034
1035
1036
1037
1038
1039

        # Queue requests that couldn't be scheduled.
        waiting_queue.extendleft(leftover_waiting_sequences)
        if len(seq_groups) > 0:
            self.prev_prompt = True

1040
        return SchedulerPrefillOutputs(
1041
1042
            seq_groups=seq_groups,
            ignored_seq_groups=ignored_seq_groups,
1043
1044
            num_lookahead_slots=self._get_num_lookahead_slots(
                is_prefill=True, enable_chunking=enable_chunking))
1045

1046
1047
    def _schedule_default(self) -> SchedulerOutputs:
        """Schedule queued requests.
1048
        
1049
        The current policy is designed to optimize the throughput. First,
1050
1051
1052
1053
1054
1055
1056
1057
1058
        it batches as many prefill requests as possible. And it schedules
        decodes. If there's a pressure on GPU memory, decode requests can
        be swapped or preempted.
        """
        # Include running requests to the budget.
        budget = SchedulingBudget(
            token_budget=self.scheduler_config.max_num_batched_tokens,
            max_num_seqs=self.scheduler_config.max_num_seqs,
        )
1059
1060
1061
1062
1063
        # Make sure we include num running seqs before scheduling prefill,
        # so that we don't schedule beyond max_num_seqs for prefill.
        for seq_group in self.running:
            budget.add_num_seqs(seq_group.request_id,
                                seq_group.get_max_num_running_seqs())
1064
        curr_loras = set(
1065
1066
            seq_group.lora_int_id for seq_group in self.running
            if seq_group.lora_int_id > 0) if self.lora_enabled else None
1067

1068
1069
1070
        prefills = SchedulerPrefillOutputs.create_empty()
        running_scheduled = SchedulerRunningOutputs.create_empty()
        swapped_in = SchedulerSwappedInOutputs.create_empty()
1071
1072
1073

        # If any requests are swapped, prioritized swapped requests.
        if not self.swapped:
1074
1075
1076
            prefills = self._schedule_prefills(budget,
                                               curr_loras,
                                               enable_chunking=False)
1077

1078
1079
1080
1081
        if len(prefills.seq_groups
               ) == 0 and self.scheduler_config.policy == "priority":
            self._schedule_priority_preemption(budget)

1082
        # Don't schedule decodes if prefills are scheduled.
1083
1084
        # NOTE: If `_schedule_prefills` doesn't enable chunking, self.running
        # only contains decode requests, not chunked prefills.
1085
        if len(prefills.seq_groups) == 0:
1086
1087
1088
            running_scheduled = self._schedule_running(budget,
                                                       curr_loras,
                                                       enable_chunking=False)
1089

1090
1091
            # If any sequence group is preempted, do not swap in any sequence
            # group. because it means there's no slot for new running requests.
1092
1093
            if len(running_scheduled.preempted) + len(
                    running_scheduled.swapped_out) == 0:
1094
                swapped_in = self._schedule_swapped(budget, curr_loras)
1095
1096
1097
1098
1099
1100

        assert (budget.num_batched_tokens <=
                self.scheduler_config.max_num_batched_tokens)
        assert budget.num_curr_seqs <= self.scheduler_config.max_num_seqs

        # Update waiting requests.
1101
        self.waiting.extendleft(running_scheduled.preempted)
1102
        # Update new running requests.
1103
1104
1105
1106
1107
1108
1109
1110
1111
        if len(prefills.seq_groups) > 0:
            self.running.extend([s.seq_group for s in prefills.seq_groups])

        self.running.extend(running_scheduled.decode_seq_groups_list)

        if len(swapped_in.decode_seq_groups) > 0:
            self.running.extend(
                [s.seq_group for s in swapped_in.decode_seq_groups])

1112
        # Update swapped requests.
1113
        self.swapped.extend(running_scheduled.swapped_out)
1114
1115
        preempted = (len(running_scheduled.preempted) +
                     len(running_scheduled.swapped_out))
1116

1117
1118
1119
1120
        # There should be no prefill from running queue because this policy
        # doesn't allow chunked prefills.
        assert len(running_scheduled.prefill_seq_groups) == 0
        assert len(swapped_in.prefill_seq_groups) == 0
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136

        # Merge lists
        num_prefill_groups = len(prefills.seq_groups)
        if num_prefill_groups > 0:
            scheduled_seq_groups = prefills.seq_groups
            scheduled_seq_groups.extend(running_scheduled.decode_seq_groups)
        else:
            scheduled_seq_groups = running_scheduled.decode_seq_groups
        scheduled_seq_groups.extend(swapped_in.decode_seq_groups)

        blocks_to_copy = running_scheduled.blocks_to_copy
        blocks_to_copy.extend(swapped_in.blocks_to_copy)

        ignored_seq_groups = prefills.ignored_seq_groups
        ignored_seq_groups.extend(swapped_in.infeasible_seq_groups)

1137
        return SchedulerOutputs(
1138
1139
            scheduled_seq_groups=scheduled_seq_groups,
            num_prefill_groups=num_prefill_groups,
1140
1141
            num_batched_tokens=budget.num_batched_tokens +
            budget.num_cached_tokens,
1142
            blocks_to_swap_in=swapped_in.blocks_to_swap_in,
1143
            blocks_to_swap_out=running_scheduled.blocks_to_swap_out,
1144
1145
            blocks_to_copy=blocks_to_copy,
            ignored_seq_groups=ignored_seq_groups,
1146
            num_lookahead_slots=running_scheduled.num_lookahead_slots,
1147
            running_queue_size=len(self.running),
1148
            preempted=preempted,
1149
1150
        )

1151
    def _schedule_chunked_prefill(self) -> SchedulerOutputs:
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
        """Schedule queued requests.
        
        Chunked prefill allows to chunk prefill requests, batch them together
        with decode requests. This policy 1. schedule as many decoding requests
        as possible. 2. schedule chunked prefill requests that are not
        finished. 3. schedule swapped request. 4. schedule new prefill
        requests.

        The policy can sustain the high GPU utilization because it can put
        prefill and decodes requests to the same batch, while it improves
1162
        inter token latency because decodes requests don't need to be blocked
1163
1164
1165
1166
1167
1168
        by prefill requests.
        """
        budget = SchedulingBudget(
            token_budget=self.scheduler_config.max_num_batched_tokens,
            max_num_seqs=self.scheduler_config.max_num_seqs,
        )
1169
        curr_loras: Set[int] = set()
1170

1171
1172
        prefills = SchedulerPrefillOutputs.create_empty()
        swapped_in = SchedulerSwappedInOutputs.create_empty()
1173
1174

        # Decoding should be always scheduled first by fcfs.
1175
1176
1177
        running_scheduled = self._schedule_running(budget,
                                                   curr_loras,
                                                   enable_chunking=True)
1178
1179
1180
1181
1182

        # Schedule swapped out requests.
        # If preemption happens, it means we don't have space for swap-in.
        if len(running_scheduled.preempted) + len(
                running_scheduled.swapped_out) == 0:
1183
            swapped_in = self._schedule_swapped(budget, curr_loras)
1184

1185
1186
1187
        prefills = self._schedule_prefills(budget,
                                           curr_loras,
                                           enable_chunking=True)
1188
1189
1190
1191
1192
1193
1194

        assert (budget.num_batched_tokens <=
                self.scheduler_config.max_num_batched_tokens)
        assert budget.num_curr_seqs <= self.scheduler_config.max_num_seqs

        # Update waiting requests.
        self.waiting.extendleft(running_scheduled.preempted)
1195

1196
        # Update new running requests.
1197
1198
1199
        # By default, vLLM scheduler prioritizes prefills.
        # Once chunked prefill is enabled,
        # the policy is changed to prioritize decode requests.
1200
1201
1202
1203
        self.running.extend(
            [s.seq_group for s in swapped_in.decode_seq_groups])
        self.running.extend(
            [s.seq_group for s in swapped_in.prefill_seq_groups])
1204
1205
1206
1207
1208
1209
        self.running.extend(
            [s.seq_group for s in running_scheduled.decode_seq_groups])
        self.running.extend(
            [s.seq_group for s in running_scheduled.prefill_seq_groups])
        self.running.extend([s.seq_group for s in prefills.seq_groups])

1210
1211
        # Update swapped requests.
        self.swapped.extend(running_scheduled.swapped_out)
1212
        # Put prefills first due to Attention backend ordering assumption.
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
        scheduled_seq_groups = (prefills.seq_groups +
                                running_scheduled.prefill_seq_groups +
                                swapped_in.prefill_seq_groups +
                                running_scheduled.decode_seq_groups +
                                swapped_in.decode_seq_groups)
        num_prefill_groups = (len(prefills.seq_groups) +
                              len(swapped_in.prefill_seq_groups) +
                              len(running_scheduled.prefill_seq_groups))
        # If all prompts, then we set num_lookahead_slots to 0
        # this allows us to go through the `no_spec` path in
        # `spec_decode_worker.py`
        all_prefills = (len(scheduled_seq_groups) == num_prefill_groups)
        num_lookahead_slots = (0 if
                               (all_prefills
                                and not self.scheduler_config.is_multi_step)
                               else running_scheduled.num_lookahead_slots)
1229
        return SchedulerOutputs(
1230
1231
            scheduled_seq_groups=scheduled_seq_groups,
            num_prefill_groups=num_prefill_groups,
1232
1233
            num_batched_tokens=budget.num_batched_tokens +
            budget.num_cached_tokens,
1234
1235
            blocks_to_swap_in=swapped_in.blocks_to_swap_in,
            blocks_to_swap_out=running_scheduled.blocks_to_swap_out,
1236
1237
            blocks_to_copy=running_scheduled.blocks_to_copy +
            swapped_in.blocks_to_copy,
1238
1239
            ignored_seq_groups=prefills.ignored_seq_groups +
            swapped_in.infeasible_seq_groups,
1240
            num_lookahead_slots=num_lookahead_slots,
1241
            running_queue_size=len(self.running),
1242
1243
            preempted=(len(running_scheduled.preempted) +
                       len(running_scheduled.swapped_out)),
1244
        )
Woosuk Kwon's avatar
Woosuk Kwon committed
1245

1246
1247
1248
1249
1250
1251
1252
    def _schedule(self) -> SchedulerOutputs:
        """Schedule queued requests."""
        if self.scheduler_config.chunked_prefill_enabled:
            return self._schedule_chunked_prefill()
        else:
            return self._schedule_default()

1253
1254
    def _can_append_slots(self, seq_group: SequenceGroup,
                          enable_chunking: bool) -> bool:
1255
1256
1257
        """Determine whether or not we have enough space in the KV cache to
        continue generation of the sequence group.
        """
1258
1259
1260
1261
1262
1263
1264
        # It is True only for testing case to trigger artificial preemption.
        if (self.enable_artificial_preemption
                and random.uniform(0, 1) < ARTIFICIAL_PREEMPTION_PROB
                and self.artificial_preempt_cnt > 0):
            self.artificial_preempt_cnt -= 1
            return False

1265
1266
1267
1268
1269
1270
1271
1272
        is_prefill = seq_group.is_prefill()
        num_lookahead_slots = self._get_num_lookahead_slots(
            is_prefill, enable_chunking)

        if is_prefill and num_lookahead_slots > 0:
            # Appending prefill slots only happens multi-step and
            # chunked-prefill are enabled together.
            assert self.scheduler_config.is_multi_step and enable_chunking
1273
1274

        return self.block_manager.can_append_slots(
1275
            seq_group=seq_group, num_lookahead_slots=num_lookahead_slots)
1276

1277
    def _allow_async_output_proc(self, seq_group: SequenceGroup) -> bool:
1278
1279
1280
        # async_output_proc is allowed only when we have a single sequence
        # in the sequence group
        no_single_seq = seq_group.sampling_params is None or (
1281
            seq_group.sampling_params.n == 1)
1282
        return no_single_seq
1283
1284
1285
1286

    def schedule(
            self
    ) -> Tuple[List[SequenceGroupMetadata], SchedulerOutputs, bool]:
1287
1288
1289
        # Schedule sequence groups.
        # This function call changes the internal states of the scheduler
        # such as self.running, self.swapped, and self.waiting.
1290
        scheduler_start_time = time.perf_counter()
1291

1292
        scheduler_outputs: SchedulerOutputs = self._schedule()
1293
        now = time.time()
1294

1295
1296
1297
        if not self.cache_config.enable_prefix_caching:
            common_computed_block_nums = []

1298
        allow_async_output_proc: bool = self.use_async_output_proc
1299

1300
        # Create input data structures.
1301
        seq_group_metadata_list: List[SequenceGroupMetadata] = []
1302
1303
        for i, scheduled_seq_group in enumerate(
                scheduler_outputs.scheduled_seq_groups):
1304
1305
            seq_group = scheduled_seq_group.seq_group
            token_chunk_size = scheduled_seq_group.token_chunk_size
1306
1307
            seq_group.maybe_set_first_scheduled_time(now)

1308
1309
1310
1311
1312
            seq_group_metadata = self._seq_group_metadata_cache[
                self.cache_id].get_object()
            seq_group_metadata.seq_data.clear()
            seq_group_metadata.block_tables.clear()

1313
            # seq_id -> SequenceData
1314
            seq_data: Dict[int, SequenceData] = {}
1315
            # seq_id -> physical block numbers
1316
            block_tables: Dict[int, List[int]] = {}
1317

1318
1319
            if seq_group.is_encoder_decoder():
                # Encoder associated with SequenceGroup
1320
1321
1322
                encoder_seq = seq_group.get_encoder_seq()
                assert encoder_seq is not None
                encoder_seq_data = encoder_seq.data
1323
1324
1325
1326
1327
1328
1329
1330
                # Block table for cross-attention
                # Also managed at SequenceGroup level
                cross_block_table = self.block_manager.get_cross_block_table(
                    seq_group)
            else:
                encoder_seq_data = None
                cross_block_table = None

1331
            for seq in seq_group.get_seqs(status=SequenceStatus.RUNNING):
1332
                seq_id = seq.seq_id
1333
                seq_data[seq_id] = seq.data
1334
                block_tables[seq_id] = self.block_manager.get_block_table(seq)
1335
                self.block_manager.access_all_blocks_in_seq(seq, now)
1336

1337
1338
1339
1340
            if self.cache_config.enable_prefix_caching:
                common_computed_block_nums = (
                    self.block_manager.get_common_computed_block_ids(
                        seq_group.get_seqs(status=SequenceStatus.RUNNING)))
1341

1342
            do_sample = True
1343
1344
1345
1346
1347
            is_prompt = seq_group.is_prefill()
            # We should send the metadata to workers when the first prefill
            # is sent. Subsequent requests could be chunked prefill or decode.
            is_first_prefill = False
            if is_prompt:
1348
1349
1350
                seqs = seq_group.get_seqs()
                # Prefill has only 1 sequence.
                assert len(seqs) == 1
1351
1352
                num_computed_tokens = seqs[0].data.get_num_computed_tokens()
                is_first_prefill = num_computed_tokens == 0
1353
1354
1355
1356
1357
                # In the next iteration, all prompt tokens are not computed.
                # It means the prefill is chunked, and we don't need sampling.
                # NOTE: We use get_len instead of get_prompt_len because when
                # a sequence is preempted, prefill includes previous generated
                # output tokens.
1358
                if (token_chunk_size + num_computed_tokens <
1359
1360
1361
                        seqs[0].data.get_len()):
                    do_sample = False

1362
1363
            # It assumes the scheduled_seq_groups is ordered by
            # prefill < decoding.
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
            if is_first_prefill or not self.scheduler_config.send_delta_data:
                seq_group_metadata = SequenceGroupMetadata(
                    request_id=seq_group.request_id,
                    is_prompt=is_prompt,
                    seq_data=seq_data,
                    sampling_params=seq_group.sampling_params,
                    block_tables=block_tables,
                    do_sample=do_sample,
                    pooling_params=seq_group.pooling_params,
                    token_chunk_size=token_chunk_size,
                    lora_request=seq_group.lora_request,
                    computed_block_nums=common_computed_block_nums,
                    encoder_seq_data=encoder_seq_data,
                    cross_block_table=cross_block_table,
                    state=seq_group.state,
1379
                    token_type_ids=seq_group.token_type_ids,
1380
1381
1382
1383
1384
1385
                    # `multi_modal_data` will only be present for the 1st comm
                    # between engine and worker.
                    # the subsequent comms can still use delta, but
                    # `multi_modal_data` will be None.
                    multi_modal_data=seq_group.multi_modal_data
                    if scheduler_outputs.num_prefill_groups > 0 else None,
1386
1387
                    multi_modal_placeholders=seq_group.multi_modal_placeholders
                    if scheduler_outputs.num_prefill_groups > 0 else None,
1388
                    mm_processor_kwargs=seq_group.mm_processor_kwargs,
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
                    prompt_adapter_request=seq_group.prompt_adapter_request,
                )
            else:
                # When SPMD mode is enabled, we only send delta data except for
                # the first request to reduce serialization cost.
                seq_data_delta = {}
                for id, data in seq_data.items():
                    seq_data_delta[id] = data.get_delta_and_reset()
                seq_group_metadata = SequenceGroupMetadataDelta(
                    seq_data_delta,
                    seq_group.request_id,
                    block_tables,
                    is_prompt,
                    do_sample=do_sample,
                    token_chunk_size=token_chunk_size,
                    computed_block_nums=common_computed_block_nums,
                )
1406
            seq_group_metadata_list.append(seq_group_metadata)
1407

1408
1409
1410
1411
            if allow_async_output_proc:
                allow_async_output_proc = self._allow_async_output_proc(
                    seq_group)

1412
1413
1414
1415
        # Now that the batch has been created, we can assume all blocks in the
        # batch will have been computed before the next scheduling invocation.
        # This is because the engine assumes that a failure in model execution
        # will crash the vLLM instance / will not retry.
1416
1417
        for scheduled_seq_group in scheduler_outputs.scheduled_seq_groups:
            self.block_manager.mark_blocks_as_computed(
1418
1419
                scheduled_seq_group.seq_group,
                scheduled_seq_group.token_chunk_size)
1420

1421
1422
        self._seq_group_metadata_cache[self.next_cache_id].reset()

1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
        scheduler_time = time.perf_counter() - scheduler_start_time
        # Add this to scheduler time to all the sequences that are currently
        # running. This will help estimate if the scheduler is a significant
        # component in the e2e latency.
        for seq_group in self.running:
            if seq_group is not None and seq_group.metrics is not None:
                if seq_group.metrics.scheduler_time is not None:
                    seq_group.metrics.scheduler_time += scheduler_time
                else:
                    seq_group.metrics.scheduler_time = scheduler_time

1434
1435
1436
1437
1438
1439
        # Move to next cache (if exists)
        self.cache_id = self.next_cache_id

        # Return results
        return (seq_group_metadata_list, scheduler_outputs,
                allow_async_output_proc)
1440

1441
1442
    def fork_seq(self, parent_seq: Sequence, child_seq: Sequence) -> None:
        self.block_manager.fork(parent_seq, child_seq)
Woosuk Kwon's avatar
Woosuk Kwon committed
1443

1444
    def free_seq(self, seq: Sequence) -> None:
1445
        """Free a sequence from a block table."""
1446
        self.block_manager.free(seq)
Woosuk Kwon's avatar
Woosuk Kwon committed
1447

1448
1449
1450
1451
1452
1453
    def _free_finished_seqs(self, seq_group: SequenceGroup) -> None:
        """Free finished seqs in a sequence group."""
        for seq in seq_group.get_seqs():
            if seq.is_finished():
                self.free_seq(seq)

1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
    def _free_finished_seq_group(self, seq_group: SequenceGroup) -> None:
        if seq_group.is_finished():
            # Free cross-attention block table, if it exists
            self._free_seq_group_cross_attn_blocks(seq_group)

            # Add the finished requests to the finished requests list.
            # This list will be used to update the Mamba cache in the
            # next step.
            self._finished_requests_ids.append(seq_group.request_id)

        # Free finished seqs
        self._free_finished_seqs(seq_group)

1467
    def free_finished_seq_groups(self) -> None:
1468
1469
        remaining: Deque[SequenceGroup] = deque()
        for seq_group in self.running:
1470
1471
            self._free_finished_seq_group(seq_group)
            if not seq_group.is_finished():
1472
                remaining.append(seq_group)
1473

1474
        self.running = remaining
Woosuk Kwon's avatar
Woosuk Kwon committed
1475

1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
        # Handle async stopped sequence groups
        # (ones that reached max model len)
        if self._async_stopped:
            for seq_group in self._async_stopped:
                self._free_seq_group_cross_attn_blocks(seq_group)
                self._finished_requests_ids.append(seq_group.request_id)

                # Free finished seqs
                self._free_finished_seqs(seq_group)

            self._async_stopped.clear()

1488
    def _allocate_and_set_running(self, seq_group: SequenceGroup) -> None:
1489
        self.block_manager.allocate(seq_group)
1490
        for seq in seq_group.get_seqs(status=SequenceStatus.WAITING):
1491
1492
            seq.status = SequenceStatus.RUNNING

1493
1494
1495
1496
    def _append_slots(self,
                      seq_group: SequenceGroup,
                      blocks_to_copy: List[Tuple[int, int]],
                      enable_chunking: bool = False) -> None:
1497
1498
1499
1500
1501
        """Appends new slots to the sequences in the given sequence group.

        Args:
            seq_group (SequenceGroup): The sequence group containing the
                sequences to append slots to.
1502
1503
1504
1505
1506
            blocks_to_copy (List[Tuple[int, int]]): A list of tuple of two
                ints, the first int is the source block index, and the second
                int is the destination block index. This list is updated with
                the new source and destination block indices for the appended
                slots.
1507
            enable_chunking (bool): True if chunked prefill is enabled.
1508
        """
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
        is_prefill: bool = seq_group.is_prefill()
        num_lookahead_slots: int = self._get_num_lookahead_slots(
            is_prefill, enable_chunking)

        seq_group.init_multi_step_from_lookahead_slots(
            num_lookahead_slots,
            num_scheduler_steps=self.scheduler_config.num_scheduler_steps,
            is_multi_step=self.scheduler_config.is_multi_step,
            enable_chunking=enable_chunking)

        seq_status: Optional[SequenceStatus] = SequenceStatus.RUNNING
        if self.scheduler_config.is_multi_step and enable_chunking:
            # In multi-step chunked-prefill any sequence type can have
            # slots appended.
            seq_status = None

        for seq in seq_group.get_seqs(status=seq_status):
1526
            cows = self.block_manager.append_slots(seq, num_lookahead_slots)
1527
1528
            if len(cows) > 0:
                blocks_to_copy.extend(cows)
1529

1530
1531
    def _preempt(self, seq_group: SequenceGroup,
                 blocks_to_swap_out: List[Tuple[int, int]]) -> PreemptionMode:
1532
1533
1534
        # If preemption mode is not specified, we determine the mode as follows:
        # We use recomputation by default since it incurs lower overhead than
        # swapping. However, when the sequence group has multiple sequences
1535
1536
        # (e.g., beam search), recomputation is not currently supported. In
        # such a case, we use swapping instead.
1537
1538
1539
1540
1541
1542
        # FIXME(woosuk): This makes our scheduling policy a bit bizarre.
        # As swapped sequences are prioritized over waiting sequences,
        # sequence groups with multiple sequences are implicitly prioritized
        # over sequence groups with a single sequence.
        # TODO(woosuk): Support recomputation for sequence groups with multiple
        # sequences. This may require a more sophisticated CUDA kernel.
1543
        if self.user_specified_preemption_mode is None:
1544
            if seq_group.get_max_num_running_seqs() == 1:
1545
1546
1547
                preemption_mode = PreemptionMode.RECOMPUTE
            else:
                preemption_mode = PreemptionMode.SWAP
1548

1549
1550
1551
1552
1553
        elif self.user_specified_preemption_mode == "swap":
            preemption_mode = PreemptionMode.SWAP
        else:
            preemption_mode = PreemptionMode.RECOMPUTE

1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
        if self.num_cumulative_preemption % 50 == 0:
            logger.warning(
                "Sequence group %s is preempted by %s mode because there is "
                "not enough KV cache space. This can affect the end-to-end "
                "performance. Increase gpu_memory_utilization or "
                "tensor_parallel_size to provide more KV cache memory. "
                "total_num_cumulative_preemption=%d", seq_group.request_id,
                preemption_mode, self.num_cumulative_preemption + 1)
        self.num_cumulative_preemption += 1

1564
1565
1566
1567
1568
        if preemption_mode == PreemptionMode.RECOMPUTE:
            self._preempt_by_recompute(seq_group)
        elif preemption_mode == PreemptionMode.SWAP:
            self._preempt_by_swap(seq_group, blocks_to_swap_out)
        else:
1569
            raise AssertionError("Invalid preemption mode.")
1570
        return preemption_mode
1571
1572
1573
1574
1575
1576
1577
1578
1579

    def _preempt_by_recompute(
        self,
        seq_group: SequenceGroup,
    ) -> None:
        seqs = seq_group.get_seqs(status=SequenceStatus.RUNNING)
        assert len(seqs) == 1
        for seq in seqs:
            seq.status = SequenceStatus.WAITING
1580
1581
            self.free_seq(seq)
            seq.reset_state_for_recompute()
1582
1583
1584
1585

    def _preempt_by_swap(
        self,
        seq_group: SequenceGroup,
1586
        blocks_to_swap_out: List[Tuple[int, int]],
1587
1588
1589
1590
1591
1592
    ) -> None:
        self._swap_out(seq_group, blocks_to_swap_out)

    def _swap_in(
        self,
        seq_group: SequenceGroup,
1593
        blocks_to_swap_in: List[Tuple[int, int]],
1594
1595
    ) -> None:
        mapping = self.block_manager.swap_in(seq_group)
1596
        blocks_to_swap_in.extend(mapping)
1597
1598
1599
1600
1601
1602
        for seq in seq_group.get_seqs(status=SequenceStatus.SWAPPED):
            seq.status = SequenceStatus.RUNNING

    def _swap_out(
        self,
        seq_group: SequenceGroup,
1603
        blocks_to_swap_out: List[Tuple[int, int]],
1604
    ) -> None:
1605
1606
1607
1608
1609
1610
        if not self.block_manager.can_swap_out(seq_group):
            # FIXME(woosuk): Abort the sequence group instead of aborting the
            # entire engine.
            raise RuntimeError(
                "Aborted due to the lack of CPU swap space. Please increase "
                "the swap space to avoid this error.")
1611
        mapping = self.block_manager.swap_out(seq_group)
1612
        blocks_to_swap_out.extend(mapping)
1613
1614
        for seq in seq_group.get_seqs(status=SequenceStatus.RUNNING):
            seq.status = SequenceStatus.SWAPPED
1615

1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
    def _passed_delay(self, now: float) -> bool:
        if self.prev_prompt:
            self.last_prompt_latency = now - self.prev_time
        self.prev_time, self.prev_prompt = now, False
        # Delay scheduling prompts to let waiting queue fill up
        if self.scheduler_config.delay_factor > 0 and self.waiting:
            earliest_arrival_time = min(
                [e.metrics.arrival_time for e in self.waiting])
            passed_delay = (
                (now - earliest_arrival_time) >
                (self.scheduler_config.delay_factor * self.last_prompt_latency)
                or not self.running)
        else:
            passed_delay = True
        return passed_delay
1631

1632
1633
    def _get_num_lookahead_slots(self, is_prefill: bool,
                                 enable_chunking: bool) -> int:
1634
1635
1636
1637
1638
1639
        """The number of slots to allocate per sequence per step, beyond known
        token ids. Speculative decoding uses these slots to store KV activations
        of tokens which may or may not be accepted.

        Speculative decoding does not yet support prefill, so we do not perform
        lookahead allocation for prefill.
1640
1641
1642
1643

        When chunking is enabled with multi-step, we allocate lookahead slots
        for the prefills for when the prefills turn into decodes in the first
        step.
1644
1645
        """
        if is_prefill:
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
            if self.scheduler_config.is_multi_step and enable_chunking:
                # num_lookahead_slots was introduced in the context of decodes,
                # in Speculative Decoding.
                # When the num_scheduler_steps is 8, say, then the
                # num_lookahead_slots is 7. Meaning, we are doing a 1-step of
                # decode anyways and we wish to do 7 more.
                #
                # "lookaheads" for prefills, is introduced in support for
                # Chunked-Prefill in Multi-Step.
                return self.scheduler_config.num_lookahead_slots + 1
            else:
                return 0
1658
1659

        return self.scheduler_config.num_lookahead_slots
1660

1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
    def _get_num_new_uncached_and_cached_tokens(
        self,
        seq_group: SequenceGroup,
        status: SequenceStatus,
        enable_chunking: bool,
        budget: SchedulingBudget,
    ) -> Tuple[int, int]:
        """
        Returns the number of new uncached and cached tokens to schedule for a
        given sequence group that's in a given `status`.
1671
1672
1673
1674
1675

        The API could chunk the number of tokens to compute based on `budget`
        if `enable_chunking` is True. If a sequence group has multiple
        sequences (e.g., running beam search), it means it is in decoding
        phase, so chunking doesn't happen.
1676

1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
        Returns (0, 0) if the new token cannot be computed due to token budget.

        The cached tokens's blocks are already computed, and the attention
        backend will reuse the cached blocks rather than recomputing them. So
        the scheduler could schedule these cached tokens "for free".

        Args:
            seq_group: The sequence group to get the number of new tokens to
                schedule.
            status: The status of the sequences to get the number of new tokens
                to schedule.
            enable_chunking: Whether to chunk the number of tokens to compute.
            budget: The budget to chunk the number of tokens to compute.


        Returns:
            A tuple of two ints. The first int is the number of new uncached
            tokens to schedule. The second int is the number of cached tokens.
            If no more new tokens can be scheduled, returns (0, 0).
1696
        """
1697
1698
1699
        num_cached_new_tokens = 0
        num_uncached_new_tokens = 0

1700
        seqs = seq_group.get_seqs(status=status)
1701
1702
        # Compute the number of new uncached and cached tokens for
        # each sequence.
1703
        for seq in seqs:
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
            if not seq.is_prefill():
                # Decode sequences should always just have 1 uncached token
                # TODO(rickyx): Actually is this still correct for multi-step?
                num_uncached_new_tokens += 1
                continue

            num_computed_tokens_seq = seq.get_num_computed_tokens()
            all_num_new_tokens_seq = seq.get_len() - num_computed_tokens_seq
            if not self.cache_config.enable_prefix_caching:
                # If prefix caching is not enabled, all new tokens are uncached.
                num_uncached_new_tokens += all_num_new_tokens_seq
                continue

            # NOTE: the cache token might be currently in a block that's in an
            # evictor meaning that it's not yet allocated. However, we don't
            # exclude such tokens in the cache count because it will be
            # guaranteed to be allocated later if the sequence can be allocated.
            num_cached_tokens_seq = self.block_manager.get_num_cached_tokens(
                seq)

            # Sanity check.
            if num_cached_tokens_seq < num_computed_tokens_seq:
                # This should only happen with chunked prefill, and
                # the seq is still in prefill. The `num_cached_tokens_seq`
                # is the value we calculated on scheduling the first prefill.
                # For subsequent continuous prefill steps, we cached the
                # number of cache tokens for the sequence so the cached token
                # count could be less than the number of computed tokens.
                # See comments on `ComputedBlocksTracker` for more details.
                assert (
                    seq.is_prefill() and seq.status == SequenceStatus.RUNNING
                    and self.scheduler_config.chunked_prefill_enabled
                ), ("Number of cached tokens should not be less than the "
                    "number of computed tokens for a sequence that's still "
                    f"in prefill. But there are {num_cached_tokens_seq} cached "
                    f"tokens and {num_computed_tokens_seq} computed tokens "
                    f"for sequence {seq.seq_id}.")

            num_cached_new_tokens_seq = max(
                0, num_cached_tokens_seq - num_computed_tokens_seq)
            num_uncached_new_tokens_seq = (all_num_new_tokens_seq -
                                           num_cached_new_tokens_seq)

            num_uncached_new_tokens += num_uncached_new_tokens_seq
            num_cached_new_tokens += num_cached_new_tokens_seq

        if num_uncached_new_tokens == 0 and num_cached_new_tokens > 0:
            # For a fully cached hit sequence, we actually need to recompute the
            # last token. So we need at least 1 uncached token to schedule.
            # See ModelRunner._compute_for_prefix_cache_hit for more details.
            num_uncached_new_tokens = 1
            num_cached_new_tokens -= 1

1757
        if enable_chunking and len(seqs) == 1:
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
            # Chunk if a running request cannot fit in the given budget.
            # If number of seq > 1, it means it is doing beam search
            # in a decode phase. Do not chunk.
            num_uncached_new_tokens = self._chunk_new_tokens_to_schedule(
                self.scheduler_config,
                self.cache_config,
                budget,
                self._get_prompt_limit(seq_group),
                num_uncached_new_tokens,
            )

        return num_uncached_new_tokens, num_cached_new_tokens

    @staticmethod
    def _chunk_new_tokens_to_schedule(
        scheduler_config: SchedulerConfig,
        cache_config: CacheConfig,
        budget: SchedulingBudget,
        prompt_limit: int,
        num_new_tokens: int,
    ) -> int:
        """
        Chunks the number of new tokens to schedule based on the budget when
        chunked prefill is enabled.

        Args:
            scheduler_config: The scheduler config.
            cache_config: The cache config.
            budget: The budget to chunk the number of tokens to compute.
            prompt_limit: The maximum number of tokens allowed in a prompt.
            num_new_tokens: The number of new tokens to schedule.

        Returns:
            The number of new tokens to schedule after chunking.
        """
        remaining_token_budget = budget.remaining_token_budget()
        if scheduler_config.is_multi_step:
            # The current multi-step + chunked prefill capability does
            # not actually support chunking prompts.
            #
            # Therefore, `num_new_tokens` is computed in the same fashion
            # for both multi-step+chunked-prefill &
            # multi-step+chunked-prefill+APC
            #
            # Prompts with more tokens than the current remaining budget
            # are postponed to future scheduler steps
            if num_new_tokens > prompt_limit:
                # If the seq_group is in prompt-stage, pass the
                # num_new_tokens as-is so the caller can ignore
                # the sequence.
                return num_new_tokens

            return (0 if num_new_tokens > remaining_token_budget else
                    num_new_tokens)

        if cache_config.enable_prefix_caching:
            # Adjust the remaining token budget to be divisible by the block
            # size when prefix caching is enabled.

            # When prefix caching is enabled, we always allocate
            # the number of new tokens that is dividable by the block
            # size to avoid partial block matching.
            block_size = cache_config.block_size
            remainder = budget.token_budget % block_size
            if remainder != 0:
                raise ValueError("When enabling chunked prefill and "
                                 "prefix caching, max_num_batched_tokens "
                                 "(chunk size) must be dividable by "
                                 "block size, but got chunk_size "
                                 f"({budget.token_budget}) % block_size "
                                 f"({block_size}) = {remainder}")
            # Round down to block size.
            remaining_token_budget = (remaining_token_budget // block_size *
                                      block_size)

        num_new_tokens = min(num_new_tokens, remaining_token_budget)

1835
        return num_new_tokens