scheduler.py 57.2 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
from typing import Deque, Dict, Iterable, List, Optional, Set, Tuple, Union
Woosuk Kwon's avatar
Woosuk Kwon committed
8

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

Woosuk Kwon's avatar
Woosuk Kwon committed
19
logger = init_logger(__name__)
20

21
22
23
24
25
26
27
# 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
28

29
30
31
32
33
34
35
36
37
38
39
40
41
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()


42
43
@dataclass
class SchedulingBudget:
44
45
46
47
48
49
50
51
52
    """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.
    """
53
54
    token_budget: int
    max_num_seqs: int
55
56
    _request_ids_num_batched_tokens: Set[str] = field(default_factory=set)
    _request_ids_num_curr_seqs: Set[str] = field(default_factory=set)
57
58
    _num_batched_tokens: int = 0
    _num_curr_seqs: int = 0
59
60

    def can_schedule(self, *, num_new_tokens: int, num_new_seqs: int):
61
62
        assert num_new_tokens != 0
        assert num_new_seqs != 0
63
64
65
        return (self.num_batched_tokens + num_new_tokens <= self.token_budget
                and self.num_curr_seqs + num_new_seqs <= self.max_num_seqs)

66
67
68
69
    def remaining_token_budget(self):
        return self.token_budget - self.num_batched_tokens

    def add_num_batched_tokens(self, req_id: str, num_batched_tokens: int):
70
        if req_id in self._request_ids_num_batched_tokens:
71
72
            return

73
        self._request_ids_num_batched_tokens.add(req_id)
74
75
76
77
        self._num_batched_tokens += num_batched_tokens

    def subtract_num_batched_tokens(self, req_id: str,
                                    num_batched_tokens: int):
78
79
        if req_id in self._request_ids_num_batched_tokens:
            self._request_ids_num_batched_tokens.remove(req_id)
80
81
82
            self._num_batched_tokens -= num_batched_tokens

    def add_num_seqs(self, req_id: str, num_curr_seqs: int):
83
        if req_id in self._request_ids_num_curr_seqs:
84
85
            return

86
        self._request_ids_num_curr_seqs.add(req_id)
87
88
89
        self._num_curr_seqs += num_curr_seqs

    def subtract_num_seqs(self, req_id: str, num_curr_seqs: int):
90
91
        if req_id in self._request_ids_num_curr_seqs:
            self._request_ids_num_curr_seqs.remove(req_id)
92
93
94
95
96
97
98
99
100
101
            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

102

103
104
105
106
107
108
109
110
111
112
@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


113
@dataclass
114
class SchedulerOutputs:
115
    """The scheduling decision made from a scheduler."""
116
117
118
119
120
121
    # Scheduled sequence groups.
    scheduled_seq_groups: Iterable[ScheduledSequenceGroup]
    # Number of prefill groups scheduled.
    num_prefill_groups: int
    # Total number of batched tokens.
    num_batched_tokens: int
122
123
124
125
    # 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]]
126
127
    # Blocks to copy. Source to dest block.
    blocks_to_copy: List[Tuple[int, int]]
128
129
130
131
    # Sequence groups that are going to be ignored.
    ignored_seq_groups: List[SequenceGroup]
    # The number of slots for lookahead decoding.
    num_lookahead_slots: int
132
133
    # The number of requests in the running queue
    running_queue_size: int
134
    preempted: int
135
136

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

140
        self.num_loras: int = len(self.lora_requests)
141
142
143
        if self.num_loras > 0:
            self._sort_by_lora_ids()

144
145
        self.num_prompt_adapters: int = len(self.prompt_adapter_requests)

146
    def is_empty(self) -> bool:
Woosuk Kwon's avatar
Woosuk Kwon committed
147
148
149
        # 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)
150

151
    def _sort_by_lora_ids(self):
152
153
154
        self.scheduled_seq_groups = sorted(
            self.scheduled_seq_groups,
            key=lambda g: (g.seq_group.lora_int_id, g.seq_group.request_id))
155
156
157

    @property
    def lora_requests(self) -> Set[LoRARequest]:
158
159
160
161
162
        return {
            g.seq_group.lora_request
            for g in self.scheduled_seq_groups
            if g.seq_group.lora_request is not None
        }
163

164
165
166
167
168
169
170
171
    @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
        }

172

173
@dataclass
174
175
176
177
178
179
180
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.
181
    decode_seq_groups: List[ScheduledSequenceGroup]
182
183
    # Selected sequences that are running and in a prefill phase.
    # I.e., it means the prefill has been chunked.
184
    prefill_seq_groups: List[ScheduledSequenceGroup]
185
186
187
188
189
    # The preempted sequences.
    preempted: List[SequenceGroup]
    # Sequences that are swapped out.
    swapped_out: List[SequenceGroup]
    # The blocks to swap out.
190
    blocks_to_swap_out: List[Tuple[int, int]]
191
    # The blocks to copy.
192
    blocks_to_copy: List[Tuple[int, int]]
193
    # The number of slots for lookahead decoding.
194
195
    num_lookahead_slots: int

196
197
198
199
    # Optimization for fast-access to seq_group lists
    decode_seq_groups_list: List[SequenceGroup]
    prefill_seq_groups_list: List[SequenceGroup]

200
    @classmethod
201
202
203
204
    def create_empty(cls) -> "SchedulerRunningOutputs":
        return SchedulerRunningOutputs(
            decode_seq_groups=[],
            prefill_seq_groups=[],
205
206
            preempted=[],
            swapped_out=[],
207
            blocks_to_swap_out=[],
208
            blocks_to_copy=[],
209
            num_lookahead_slots=0,
210
211
            decode_seq_groups_list=[],
            prefill_seq_groups_list=[],
212
213
214
215
216
        )


@dataclass
class SchedulerSwappedInOutputs:
217
218
219
220
221
222
223
224
225
226
    """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.
    decode_seq_groups: List[SequenceGroup]
    # Selected sequences that are going to be swapped in and in a prefill
    # phase. I.e., it means the prefill has been chunked.
    prefill_seq_groups: List[SequenceGroup]
227
    # The blocks to swap in.
228
    blocks_to_swap_in: List[Tuple[int, int]]
229
    # The blocks to copy.
230
    blocks_to_copy: List[Tuple[int, int]]
231
    # The number of slots for lookahead decoding.
232
    num_lookahead_slots: int
233
234
    # Infeasible sequence groups.
    infeasible_seq_groups: List[SequenceGroup]
235
236
237
238

    @classmethod
    def create_empty(cls) -> "SchedulerSwappedInOutputs":
        return SchedulerSwappedInOutputs(
239
240
            decode_seq_groups=[],
            prefill_seq_groups=[],
241
            blocks_to_swap_in=[],
242
            blocks_to_copy=[],
243
            num_lookahead_slots=0,
244
            infeasible_seq_groups=[],
245
246
247
248
249
        )


@dataclass
class SchedulerPrefillOutputs:
250
251
252
253
254
255
    """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.
256
257
258
259
260
261
262
263
264
265
266
267
268
269
    seq_groups: List[SequenceGroup]
    # 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,
        )


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
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():
    return ScheduledSequenceGroup(seq_group=None, token_chunk_size=0)


Woosuk Kwon's avatar
Woosuk Kwon committed
294
295
class Scheduler:

Woosuk Kwon's avatar
Woosuk Kwon committed
296
    def __init__(
Woosuk Kwon's avatar
Woosuk Kwon committed
297
        self,
298
299
        scheduler_config: SchedulerConfig,
        cache_config: CacheConfig,
300
        lora_config: Optional[LoRAConfig],
301
        pipeline_parallel_size: int = 1,
Woosuk Kwon's avatar
Woosuk Kwon committed
302
    ) -> None:
303
304
        self.scheduler_config = scheduler_config
        self.cache_config = cache_config
305
306
307
308
        # 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
309

310
311
312
313
314
315
        version = "v1"
        if self.scheduler_config.use_v2_block_manager:
            version = "v2"
        if self.scheduler_config.embedding_mode:
            version = "embedding"

316
        BlockSpaceManagerImpl = BlockSpaceManager.get_block_space_manager_class(
317
            version)
318

319
320
321
322
323
324
325
326
        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
327
        # Create the block space manager.
328
        self.block_manager = BlockSpaceManagerImpl(
329
            block_size=self.cache_config.block_size,
330
331
            num_gpu_blocks=num_gpu_blocks,
            num_cpu_blocks=num_cpu_blocks,
332
333
            sliding_window=self.cache_config.sliding_window,
            enable_caching=self.cache_config.enable_prefix_caching)
334

335
        # Sequence groups in the WAITING state.
336
        # Contain new prefill or preempted requests.
337
        self.waiting: Deque[SequenceGroup] = deque()
338
        # Sequence groups in the RUNNING state.
339
        # Contain decode requests.
340
        self.running: Deque[SequenceGroup] = deque()
341
        # Sequence groups in the SWAPPED state.
342
        # Contain decode requests that are swapped out.
343
        self.swapped: Deque[SequenceGroup] = deque()
Mor Zusman's avatar
Mor Zusman committed
344
345
346
        # 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.
347
        # This is used to evict the finished requests from the Mamba cache.
Mor Zusman's avatar
Mor Zusman committed
348
        self._finished_requests_ids: List[str] = list()
349
350
351
352
353
354
        # 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
355
356
        # preemption mode, RECOMPUTE or SWAP
        self.user_specified_preemption_mode = scheduler_config.preemption_mode
357

358
359
360
361
362
363
        # 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)
364
        self.num_cumulative_preemption: int = 0
365

366
367
368
369
370
371
        # Used to cache python objects
        self._scheduler_running_outputs_cache: PyObjectCache = PyObjectCache(
            scheduler_running_outputs_builder)
        self._scheduled_seq_group_cache: PyObjectCache = PyObjectCache(
            scheduled_seq_group_builder)

372
373
374
375
    @property
    def lora_enabled(self) -> bool:
        return bool(self.lora_config)

376
377
378
379
380
    @property
    def num_decoding_tokens_per_seq(self) -> int:
        """The number of new tokens."""
        return 1

381
    def add_seq_group(self, seq_group: SequenceGroup) -> None:
382
        # Add sequence groups to the waiting queue.
383
        self.waiting.append(seq_group)
Woosuk Kwon's avatar
Woosuk Kwon committed
384

385
386
387
388
389
390
391
392
393
394
    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
395
    def abort_seq_group(self, request_id: Union[str, Iterable[str]]) -> None:
396
397
398
399
400
401
402
403
404
405
406
407
        """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
408
409
410
        if isinstance(request_id, str):
            request_id = (request_id, )
        request_ids = set(request_id)
411
        for state_queue in [self.waiting, self.running, self.swapped]:
ljss's avatar
ljss committed
412
            aborted_groups: List[SequenceGroup] = []
413
414
415
            for seq_group in state_queue:
                if not request_ids:
                    # Using 'break' here may add two extra iterations,
416
                    # but is acceptable to reduce complexity.
417
                    break
Antoni Baum's avatar
Antoni Baum committed
418
                if seq_group.request_id in request_ids:
419
420
                    # Appending aborted group into pending list.
                    aborted_groups.append(seq_group)
Antoni Baum's avatar
Antoni Baum committed
421
                    request_ids.remove(seq_group.request_id)
422
423
424
            for aborted_group in aborted_groups:
                # Remove the sequence group from the state queue.
                state_queue.remove(aborted_group)
425
                # Remove the aborted request from the Mamba cache.
426
                self._finished_requests_ids.append(aborted_group.request_id)
ljss's avatar
ljss committed
427
                for seq in aborted_group.get_seqs():
428
429
430
431
                    if seq.is_finished():
                        continue
                    seq.status = SequenceStatus.FINISHED_ABORTED
                    self.free_seq(seq)
432

433
434
435
436
437
438
439
440
441
442
443
444
445
                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)

446
    def has_unfinished_seqs(self) -> bool:
447
448
        return len(self.waiting) != 0 or len(self.running) != 0 or len(
            self.swapped) != 0
449

450
451
452
    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
453
454
455
456
457
458
    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

459
    def _schedule_running(
460
461
462
        self,
        budget: SchedulingBudget,
        curr_loras: Optional[Set[int]],
463
        enable_chunking: bool = False,
464
    ) -> SchedulerRunningOutputs:
465
        """Schedule sequence groups that are running.
466

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

469
470
471
472
473
        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.
474
475
476
477
478
            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.
    
479
        Returns:
480
            SchedulerRunningOutputs.
481
        """
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
        ret: SchedulerRunningOutputs = \
            self._scheduler_running_outputs_cache.get_object()
        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(
            is_prefill=False)

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

497
        # Blocks that need to be swapped or copied before model execution.
498
499
        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
500

501
502
503
504
505
        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
506
507
508

        # NOTE(woosuk): Preemption happens only when there is no available slot
        # to keep all the sequence groups in the RUNNING state.
509
510
511

        running_queue = self.running

512
513
        while running_queue:
            seq_group = running_queue[0]
514
515
516
            num_running_tokens = self._get_num_new_tokens(
                seq_group, SequenceStatus.RUNNING, enable_chunking, budget)

517
518
            if num_running_tokens == 0:
                break
519
520

            running_queue.popleft()
521
            while not self._can_append_slots(seq_group):
522
523
                budget.subtract_num_batched_tokens(seq_group.request_id,
                                                   num_running_tokens)
524
                num_running_seqs = seq_group.get_max_num_running_seqs()
525
526
                budget.subtract_num_seqs(seq_group.request_id,
                                         num_running_seqs)
527
528
529

                if (curr_loras is not None and seq_group.lora_int_id > 0
                        and seq_group.lora_int_id in curr_loras):
530
                    curr_loras.remove(seq_group.lora_int_id)
531
532

                if running_queue:
533
                    # Preempt the lowest-priority sequence groups.
534
535
536
537
538
539
540
                    victim_seq_group = running_queue.pop()
                    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)
541
542
543
                else:
                    # No other sequence groups can be preempted.
                    # Preempt the current sequence group.
544
545
546
547
548
549
                    preempted_mode = self._preempt(seq_group,
                                                   blocks_to_swap_out)
                    if preempted_mode == PreemptionMode.RECOMPUTE:
                        preempted.append(seq_group)
                    else:
                        swapped_out.append(seq_group)
Woosuk Kwon's avatar
Woosuk Kwon committed
550
551
                    break
            else:
552
                self._append_slots(seq_group, blocks_to_copy)
553
                is_prefill = seq_group.is_prefill()
554
555
556
557

                scheduled_seq_group: ScheduledSequenceGroup = \
                    self._scheduled_seq_group_cache.get_object()
                scheduled_seq_group.seq_group = seq_group
558
                if is_prefill:
559
560
561
                    scheduled_seq_group.token_chunk_size = num_running_tokens
                    prefill_seq_groups.append(scheduled_seq_group)
                    ret.prefill_seq_groups_list.append(seq_group)
562
                else:
563
564
565
566
                    scheduled_seq_group.token_chunk_size = 1
                    decode_seq_groups.append(scheduled_seq_group)
                    ret.decode_seq_groups_list.append(seq_group)

567
568
                budget.add_num_batched_tokens(seq_group.request_id,
                                              num_running_tokens)
569
570
571
572
573
574
575
                # 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)
576
577
578
                if curr_loras is not None and seq_group.lora_int_id > 0:
                    curr_loras.add(seq_group.lora_int_id)

579
580
581
582
        self._scheduler_running_outputs_cache.reset()
        self._scheduled_seq_group_cache.reset()

        return ret
583

584
585
586
587
    def _schedule_swapped(
        self,
        budget: SchedulingBudget,
        curr_loras: Optional[Set[int]],
588
        enable_chunking: bool = False,
589
    ) -> SchedulerSwappedInOutputs:
590
        """Schedule sequence groups that are swapped out.
591

592
593
594
        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.
595

596
597
598
599
600
        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.
601
602
603
604
605
            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.

606
607
608
609
        Returns:
            SchedulerSwappedInOutputs.
        """
        # Blocks that need to be swapped or copied before model execution.
610
        blocks_to_swap_in: List[Tuple[int, int]] = []
611
        blocks_to_copy: List[Tuple[int, int]] = []
612
613
        decode_seq_groups: List[ScheduledSequenceGroup] = []
        prefill_seq_groups: List[ScheduledSequenceGroup] = []
614
        infeasible_seq_groups: List[SequenceGroup] = []
615

616
617
        swapped_queue = self.swapped

618
        leftover_swapped: Deque[SequenceGroup] = deque()
619
620
621
622
        while swapped_queue:
            seq_group = swapped_queue[0]

            # If the sequence group cannot be swapped in, stop.
623
624
625
            is_prefill = seq_group.is_prefill()
            alloc_status = self.block_manager.can_swap_in(
                seq_group, self._get_num_lookahead_slots(is_prefill))
626
            if alloc_status == AllocStatus.LATER:
627
                break
628
629
630
631
632
633
634
635
636
637
            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
638
639
640
641

            lora_int_id = 0
            if self.lora_enabled:
                lora_int_id = seq_group.lora_int_id
642
643
644
                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)
645
646
647
648
649
650
651
652
653
654
                        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()
655
656
657
            num_new_tokens = self._get_num_new_tokens(seq_group,
                                                      SequenceStatus.SWAPPED,
                                                      enable_chunking, budget)
658

659
660
661
            if (num_new_tokens == 0
                    or not budget.can_schedule(num_new_tokens=num_new_tokens,
                                               num_new_seqs=num_new_seqs)):
662
663
664
665
666
667
668
                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)
            self._append_slots(seq_group, blocks_to_copy)
669
670
671
672
673
674
675
676
677
678
            is_prefill = seq_group.is_prefill()
            if is_prefill:
                prefill_seq_groups.append(
                    ScheduledSequenceGroup(seq_group,
                                           token_chunk_size=num_new_tokens))
            else:
                decode_seq_groups.append(
                    ScheduledSequenceGroup(seq_group, token_chunk_size=1))
            budget.add_num_batched_tokens(seq_group.request_id, num_new_tokens)
            budget.add_num_seqs(seq_group.request_id, num_new_seqs)
679
680
681

        swapped_queue.extendleft(leftover_swapped)

682
        return SchedulerSwappedInOutputs(
683
684
            decode_seq_groups=decode_seq_groups,
            prefill_seq_groups=prefill_seq_groups,
685
686
            blocks_to_swap_in=blocks_to_swap_in,
            blocks_to_copy=blocks_to_copy,
687
            num_lookahead_slots=self._get_num_lookahead_slots(
688
689
690
                is_prefill=False),
            infeasible_seq_groups=infeasible_seq_groups,
        )
691

692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
    def _get_prompt_limit(self, seq_group: SequenceGroup) -> int:
        if self.scheduler_config.chunked_prefill_enabled:
            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

707
708
709
710
    def _schedule_prefills(
        self,
        budget: SchedulingBudget,
        curr_loras: Optional[Set[int]],
711
        enable_chunking: bool = False,
712
    ) -> SchedulerPrefillOutputs:
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
        """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.
728
729
730
731
            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.
732
733

        Returns:
734
            SchedulerPrefillOutputs.
735
736
737
        """
        ignored_seq_groups: List[SequenceGroup] = []
        seq_groups: List[SequenceGroup] = []
738
739

        waiting_queue = self.waiting
740

741
        leftover_waiting_sequences: Deque[SequenceGroup] = deque()
742
743
744
745
746
747
748
        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.")
749
750
751
752
753
754
755
            num_new_tokens = self._get_num_new_tokens(seq_group,
                                                      SequenceStatus.WAITING,
                                                      enable_chunking, budget)
            if not enable_chunking:
                num_prompt_tokens = waiting_seqs[0].get_len()
                assert num_new_tokens == num_prompt_tokens

756
757
            prompt_limit = self._get_prompt_limit(seq_group)
            if num_new_tokens > prompt_limit:
758
                logger.warning(
759
                    "Input prompt (%d tokens) is too long"
760
                    " and exceeds limit of %d", num_new_tokens, prompt_limit)
761
762
763
764
765
766
767
768
769
770
771
772
                for seq in waiting_seqs:
                    seq.status = SequenceStatus.FINISHED_IGNORED
                ignored_seq_groups.append(seq_group)
                waiting_queue.popleft()
                continue

            # If the sequence group cannot be allocated, stop.
            can_allocate = self.block_manager.can_allocate(seq_group)
            if can_allocate == AllocStatus.LATER:
                break
            elif can_allocate == AllocStatus.NEVER:
                logger.warning(
773
774
775
                    "Input prompt (%d tokens) is too long"
                    " and exceeds the capacity of block_manager",
                    num_new_tokens)
776
777
778
779
780
781
782
783
784
                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
785
786
                assert curr_loras is not None
                assert self.lora_config is not None
787
788
789
790
791
792
793
794
795
796
                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

            num_new_seqs = seq_group.get_max_num_running_seqs()
797
798
799
            if (num_new_tokens == 0
                    or not budget.can_schedule(num_new_tokens=num_new_tokens,
                                               num_new_seqs=num_new_seqs)):
800
801
802
803
804
805
                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()
806
            self._allocate_and_set_running(seq_group)
807
808
809
            seq_group.init_multi_step(
                num_scheduler_steps=self._get_num_lookahead_slots(
                    is_prefill=True) + 1)
810
811
            seq_groups.append(
                ScheduledSequenceGroup(seq_group=seq_group,
812
813
814
                                       token_chunk_size=num_new_tokens))
            budget.add_num_batched_tokens(seq_group.request_id, num_new_tokens)
            budget.add_num_seqs(seq_group.request_id, num_new_seqs)
815
816
817
818
819
820

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

821
        return SchedulerPrefillOutputs(
822
823
824
825
            seq_groups=seq_groups,
            ignored_seq_groups=ignored_seq_groups,
            num_lookahead_slots=self._get_num_lookahead_slots(is_prefill=True))

826
827
    def _schedule_default(self) -> SchedulerOutputs:
        """Schedule queued requests.
828
        
829
        The current policy is designed to optimize the throughput. First,
830
831
832
833
834
835
836
837
838
        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,
        )
839
840
841
842
843
        # 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())
844
        curr_loras = set(
845
846
            seq_group.lora_int_id for seq_group in self.running
            if seq_group.lora_int_id > 0) if self.lora_enabled else None
847

848
849
850
        prefills = SchedulerPrefillOutputs.create_empty()
        running_scheduled = SchedulerRunningOutputs.create_empty()
        swapped_in = SchedulerSwappedInOutputs.create_empty()
851
852
853

        # If any requests are swapped, prioritized swapped requests.
        if not self.swapped:
854
855
856
            prefills = self._schedule_prefills(budget,
                                               curr_loras,
                                               enable_chunking=False)
857
858

        # Don't schedule decodes if prefills are scheduled.
859
860
        # NOTE: If `_schedule_prefills` doesn't enable chunking, self.running
        # only contains decode requests, not chunked prefills.
861
        if len(prefills.seq_groups) == 0:
862
863
864
            running_scheduled = self._schedule_running(budget,
                                                       curr_loras,
                                                       enable_chunking=False)
865

866
867
            # If any sequence group is preempted, do not swap in any sequence
            # group. because it means there's no slot for new running requests.
868
869
            if len(running_scheduled.preempted) + len(
                    running_scheduled.swapped_out) == 0:
870
                swapped_in = self._schedule_swapped(budget, curr_loras)
871
872
873
874
875
876

        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.
877
        self.waiting.extendleft(running_scheduled.preempted)
878
        # Update new running requests.
879
880
881
882
883
884
885
886
887
        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])

888
        # Update swapped requests.
889
        self.swapped.extend(running_scheduled.swapped_out)
890
891
        preempted = (len(running_scheduled.preempted) +
                     len(running_scheduled.swapped_out))
892

893
894
895
896
        # 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
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912

        # 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)

913
        return SchedulerOutputs(
914
915
            scheduled_seq_groups=scheduled_seq_groups,
            num_prefill_groups=num_prefill_groups,
916
917
            num_batched_tokens=budget.num_batched_tokens,
            blocks_to_swap_in=swapped_in.blocks_to_swap_in,
918
            blocks_to_swap_out=running_scheduled.blocks_to_swap_out,
919
920
            blocks_to_copy=blocks_to_copy,
            ignored_seq_groups=ignored_seq_groups,
921
            num_lookahead_slots=running_scheduled.num_lookahead_slots,
922
            running_queue_size=len(self.running),
923
            preempted=preempted,
924
925
        )

926
    def _schedule_chunked_prefill(self) -> SchedulerOutputs:
927
928
929
930
931
932
933
934
935
936
        """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
937
        inter token latency because decodes requests don't need to be blocked
938
939
940
941
942
943
        by prefill requests.
        """
        budget = SchedulingBudget(
            token_budget=self.scheduler_config.max_num_batched_tokens,
            max_num_seqs=self.scheduler_config.max_num_seqs,
        )
944
        curr_loras: Set[int] = set()
945

946
947
        prefills = SchedulerPrefillOutputs.create_empty()
        swapped_in = SchedulerSwappedInOutputs.create_empty()
948
949

        # Decoding should be always scheduled first by fcfs.
950
951
952
        running_scheduled = self._schedule_running(budget,
                                                   curr_loras,
                                                   enable_chunking=True)
953
954
955
956
957

        # 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:
958
            swapped_in = self._schedule_swapped(budget, curr_loras)
959
960

        # Schedule new prefills.
961
962
963
        prefills = self._schedule_prefills(budget,
                                           curr_loras,
                                           enable_chunking=True)
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985

        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)
        # Update new running requests.
        self.running.extend([s.seq_group for s in prefills.seq_groups])
        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 swapped_in.decode_seq_groups])
        self.running.extend(
            [s.seq_group for s in swapped_in.prefill_seq_groups])
        # Update swapped requests.
        self.swapped.extend(running_scheduled.swapped_out)
        return SchedulerOutputs(
            scheduled_seq_groups=(prefills.seq_groups +
                                  running_scheduled.prefill_seq_groups +
986
987
988
                                  swapped_in.prefill_seq_groups +
                                  running_scheduled.decode_seq_groups +
                                  swapped_in.decode_seq_groups),
989
990
991
992
993
994
            num_prefill_groups=(len(prefills.seq_groups) +
                                len(swapped_in.prefill_seq_groups) +
                                len(running_scheduled.prefill_seq_groups)),
            num_batched_tokens=budget.num_batched_tokens,
            blocks_to_swap_in=swapped_in.blocks_to_swap_in,
            blocks_to_swap_out=running_scheduled.blocks_to_swap_out,
995
996
            blocks_to_copy=running_scheduled.blocks_to_copy +
            swapped_in.blocks_to_copy,
997
998
            ignored_seq_groups=prefills.ignored_seq_groups +
            swapped_in.infeasible_seq_groups,
999
            num_lookahead_slots=running_scheduled.num_lookahead_slots,
1000
            running_queue_size=len(self.running),
1001
1002
            preempted=(len(running_scheduled.preempted) +
                       len(running_scheduled.swapped_out)),
1003
        )
Woosuk Kwon's avatar
Woosuk Kwon committed
1004

1005
1006
1007
1008
1009
1010
1011
    def _schedule(self) -> SchedulerOutputs:
        """Schedule queued requests."""
        if self.scheduler_config.chunked_prefill_enabled:
            return self._schedule_chunked_prefill()
        else:
            return self._schedule_default()

1012
1013
1014
1015
    def _can_append_slots(self, seq_group: SequenceGroup) -> bool:
        """Determine whether or not we have enough space in the KV cache to
        continue generation of the sequence group.
        """
1016
1017
1018
1019
1020
1021
1022
        # 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

1023
1024
1025
1026
1027
1028
1029
1030
        # Appending slots only occurs in decoding.
        is_prefill = False

        return self.block_manager.can_append_slots(
            seq_group=seq_group,
            num_lookahead_slots=self._get_num_lookahead_slots(is_prefill),
        )

Woosuk Kwon's avatar
Woosuk Kwon committed
1031
    def schedule(self) -> Tuple[List[SequenceGroupMetadata], SchedulerOutputs]:
1032
1033
1034
        # Schedule sequence groups.
        # This function call changes the internal states of the scheduler
        # such as self.running, self.swapped, and self.waiting.
1035
        scheduler_start_time = time.perf_counter()
Woosuk Kwon's avatar
Woosuk Kwon committed
1036
        scheduler_outputs = self._schedule()
1037
        now = time.time()
1038

1039
1040
1041
        if not self.cache_config.enable_prefix_caching:
            common_computed_block_nums = []

1042
        # Create input data structures.
1043
        seq_group_metadata_list: List[SequenceGroupMetadata] = []
1044
1045
        for i, scheduled_seq_group in enumerate(
                scheduler_outputs.scheduled_seq_groups):
1046
1047
            seq_group = scheduled_seq_group.seq_group
            token_chunk_size = scheduled_seq_group.token_chunk_size
1048
1049
            seq_group.maybe_set_first_scheduled_time(now)

1050
            # seq_id -> SequenceData
1051
            seq_data: Dict[int, SequenceData] = {}
1052
            # seq_id -> physical block numbers
1053
            block_tables: Dict[int, List[int]] = {}
1054

1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
            if seq_group.is_encoder_decoder():
                # Encoder associated with SequenceGroup
                encoder_seq_data = seq_group.get_encoder_seq().data
                # 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

1066
            for seq in seq_group.get_seqs(status=SequenceStatus.RUNNING):
1067
                seq_id = seq.seq_id
1068
                seq_data[seq_id] = seq.data
1069
                block_tables[seq_id] = self.block_manager.get_block_table(seq)
1070
                self.block_manager.access_all_blocks_in_seq(seq, now)
1071

1072
1073
1074
1075
            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)))
1076

1077
            do_sample = True
1078
1079
1080
1081
1082
            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:
1083
1084
1085
                seqs = seq_group.get_seqs()
                # Prefill has only 1 sequence.
                assert len(seqs) == 1
1086
1087
                num_computed_tokens = seqs[0].data.get_num_computed_tokens()
                is_first_prefill = num_computed_tokens == 0
1088
1089
1090
1091
1092
                # 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.
1093
                if (token_chunk_size + num_computed_tokens <
1094
1095
1096
                        seqs[0].data.get_len()):
                    do_sample = False

1097
1098
            # It assumes the scheduled_seq_groups is ordered by
            # prefill < decoding.
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
            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,
                    # `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,
                    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,
                )
1137
            seq_group_metadata_list.append(seq_group_metadata)
1138
1139
1140
1141
1142

        # 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.
1143
1144
1145
        for scheduled_seq_group in scheduler_outputs.scheduled_seq_groups:
            self.block_manager.mark_blocks_as_computed(
                scheduled_seq_group.seq_group)
1146

1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
        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

Woosuk Kwon's avatar
Woosuk Kwon committed
1158
        return seq_group_metadata_list, scheduler_outputs
1159

1160
1161
    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
1162

1163
    def free_seq(self, seq: Sequence) -> None:
1164
        """Free a sequence from a block table."""
1165
        self.block_manager.free(seq)
Woosuk Kwon's avatar
Woosuk Kwon committed
1166

1167
    def free_finished_seq_groups(self) -> None:
1168
1169
1170
        remaining: Deque[SequenceGroup] = deque()
        for seq_group in self.running:
            if seq_group.is_finished():
1171
1172
                # Free cross-attention block table, if it exists
                self._free_seq_group_cross_attn_blocks(seq_group)
1173
1174
1175
1176
1177
1178
1179
                # 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)
            else:
                remaining.append(seq_group)
        self.running = remaining
Woosuk Kwon's avatar
Woosuk Kwon committed
1180

1181
    def _allocate_and_set_running(self, seq_group: SequenceGroup) -> None:
1182
        self.block_manager.allocate(seq_group)
1183
        for seq in seq_group.get_seqs(status=SequenceStatus.WAITING):
1184
1185
            seq.status = SequenceStatus.RUNNING

1186
    def _append_slots(
1187
1188
        self,
        seq_group: SequenceGroup,
1189
        blocks_to_copy: List[Tuple[int, int]],
1190
    ) -> None:
1191
1192
1193
1194
1195
        """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.
1196
1197
1198
1199
1200
            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.
1201
1202
        """
        num_lookahead_slots = self._get_num_lookahead_slots(is_prefill=False)
1203
        seq_group.init_multi_step(num_scheduler_steps=num_lookahead_slots + 1)
1204

1205
        for seq in seq_group.get_seqs(status=SequenceStatus.RUNNING):
1206
            cows = self.block_manager.append_slots(seq, num_lookahead_slots)
1207
1208
            if len(cows) > 0:
                blocks_to_copy.extend(cows)
1209
1210
1211
1212

    def _preempt(
        self,
        seq_group: SequenceGroup,
1213
        blocks_to_swap_out: List[Tuple[int, int]],
1214
        preemption_mode: Optional[PreemptionMode] = None,
1215
    ) -> PreemptionMode:
1216
1217
1218
        # 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
1219
1220
        # (e.g., beam search), recomputation is not currently supported. In
        # such a case, we use swapping instead.
1221
1222
1223
1224
1225
1226
        # 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.
1227
        if self.user_specified_preemption_mode is None:
1228
            if seq_group.get_max_num_running_seqs() == 1:
1229
1230
1231
                preemption_mode = PreemptionMode.RECOMPUTE
            else:
                preemption_mode = PreemptionMode.SWAP
1232

1233
1234
1235
1236
1237
        elif self.user_specified_preemption_mode == "swap":
            preemption_mode = PreemptionMode.SWAP
        else:
            preemption_mode = PreemptionMode.RECOMPUTE

1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
        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

1248
1249
1250
1251
1252
        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:
1253
            raise AssertionError("Invalid preemption mode.")
1254
        return preemption_mode
1255
1256
1257
1258
1259
1260
1261
1262
1263

    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
1264
1265
            self.free_seq(seq)
            seq.reset_state_for_recompute()
1266
1267
1268
1269

    def _preempt_by_swap(
        self,
        seq_group: SequenceGroup,
1270
        blocks_to_swap_out: List[Tuple[int, int]],
1271
1272
1273
1274
1275
1276
    ) -> None:
        self._swap_out(seq_group, blocks_to_swap_out)

    def _swap_in(
        self,
        seq_group: SequenceGroup,
1277
        blocks_to_swap_in: List[Tuple[int, int]],
1278
1279
    ) -> None:
        mapping = self.block_manager.swap_in(seq_group)
1280
        blocks_to_swap_in.extend(mapping)
1281
1282
1283
1284
1285
1286
        for seq in seq_group.get_seqs(status=SequenceStatus.SWAPPED):
            seq.status = SequenceStatus.RUNNING

    def _swap_out(
        self,
        seq_group: SequenceGroup,
1287
        blocks_to_swap_out: List[Tuple[int, int]],
1288
    ) -> None:
1289
1290
1291
1292
1293
1294
        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.")
1295
        mapping = self.block_manager.swap_out(seq_group)
1296
        blocks_to_swap_out.extend(mapping)
1297
1298
        for seq in seq_group.get_seqs(status=SequenceStatus.RUNNING):
            seq.status = SequenceStatus.SWAPPED
1299

1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
    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
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327

    def _get_num_lookahead_slots(self, is_prefill: bool) -> int:
        """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.
        """
        if is_prefill:
            return 0

        return self.scheduler_config.num_lookahead_slots
1328
1329
1330

    def _get_num_new_tokens(self, seq_group: SequenceGroup,
                            status: SequenceStatus, enable_chunking: bool,
1331
                            budget: SchedulingBudget) -> int:
1332
1333
1334
1335
1336
1337
1338
        """Get the next new tokens to compute for a given sequence group
            that's in a given `status`.

        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.
1339
1340

        Returns 0 if the new token cannot be computed due to token budget.
1341
1342
1343
1344
1345
        """
        num_new_tokens = 0
        seqs = seq_group.get_seqs(status=status)
        for seq in seqs:
            num_new_tokens += seq.get_num_new_tokens()
1346
        assert num_new_tokens > 0
1347
1348
1349
1350
1351
1352
1353
        # Chunk if a running request cannot fit in.
        # If number of seq > 1, it means it is doing beam search in a
        # decode phase. Do not chunk in that case.
        if enable_chunking and len(seqs) == 1:
            num_new_tokens = min(num_new_tokens,
                                 budget.remaining_token_budget())
        return num_new_tokens