"tests/vscode:/vscode.git/clone" did not exist on "020f58abcdea65302225663130d08fd8f4dd755a"
scheduler.rs 37.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

//! Asynchronous Scheduler for LLM Request Management
//!
//! This module implements an asynchronous scheduler that handles three main functions:
//! 1. Receiving new requests and placing them in the waiting queue
//! 2. Scheduling waiting requests against available KV cache resources
//! 3. Simulating the execution of running requests with realistic timing
//!
//! ## Scheduling Process
//! The scheduler uses a watermark-based approach to determine if there's sufficient
//! KV cache space for new requests. It also enforces a batched tokens budget to prevent
//! oversubscription of computational resources. Only requests that can be allocated
//! these resources are moved from waiting to running state.
//!
//! ## Request Simulation
//! The simulation models two key phases:
//! - Prefill phase: Uses a quadratic cost function: (cached_tokens + new_tokens) * new_tokens
//! - Decode phase: Uses a cost function proportional to active KV blocks (linear)
//!
//! ## Resource Management
//! The scheduler communicates with the KvManager through MoveBlock signals at each
//! stage of request processing. When resources become constrained, it employs an
//! LRU-based preemption strategy where the oldest running request is evicted and
//! placed at the back of the waiting queue to be rescheduled later.
//!
//! ## NOTE
//! The current prefill and decoding time simulations are not scientific at all and are WIP

31
use crate::kv_router::protocols::{ForwardPassMetrics, KvCacheEventData, KvStats, WorkerStats};
32
33
use crate::mocker::evictor::LRUEvictor;
use crate::mocker::kv_manager::KvManager;
34
use crate::mocker::protocols::{block_response_to_kv_event, MoveBlock, OutputSignal, PrefillCost};
35
use crate::mocker::protocols::{DirectRequest, MockEngineArgs, MoveBlockResponse};
36
use crate::mocker::sequence::ActiveSequence;
37
use crate::tokens::blocks::UniqueBlock;
38
use crate::tokens::BlockHash;
39
40
41
42
use std::collections::HashMap;
use std::collections::VecDeque;
use std::sync::Arc;
use tokio::sync::{mpsc, Mutex};
43
use tokio::time::Duration;
44
45
46
47
48
49
50
51
52
53
54
55
use tokio_util::sync::CancellationToken;
use uuid::Uuid;

/// Enum representing either a direct request or an active sequence
pub enum Request {
    Direct(DirectRequest),
    Active(ActiveSequence),
}

#[derive(Default)]
struct SchedulerState {
    waiting: VecDeque<Uuid>,
56
57
    prefill: VecDeque<Uuid>,
    decode: LRUEvictor<Uuid>,
58
    requests: HashMap<Uuid, Request>,
59
60
61
62
    prefill_costs: HashMap<Uuid, PrefillCost>,
    max_num_batched_tokens: Option<usize>,
    active_tokens: usize,
    waiting_tokens: usize,
63
64
65
}

impl SchedulerState {
66
67
68
69
70
71
72
    fn new(max_num_batched_tokens: Option<usize>) -> Self {
        SchedulerState {
            max_num_batched_tokens,
            ..Default::default()
        }
    }

73
74
75
76
    fn is_empty(&self) -> bool {
        self.requests.is_empty()
    }

77
78
79
80
81
82
83
84
85
86
87
    /// Create a new UUID for a DirectRequest, add it to requests, and push the UUID to waiting.
    fn receive(&mut self, request: DirectRequest) -> Uuid {
        // Use the provided UUID if available, otherwise generate a new one
        let uuid = request.uuid.unwrap_or_else(Uuid::new_v4);
        self.requests.insert(uuid, Request::Direct(request));
        self.waiting.push_back(uuid);
        uuid
    }

    /// Get the next UUID from ready or waiting queue and its associated Request.
    fn next(&mut self) -> Option<(Uuid, Request)> {
88
89
90
91
92
        let uuid = self.waiting.pop_front()?;
        let request = self
            .requests
            .remove(&uuid)
            .expect("Request does not exist.");
93
94
95
        Some((uuid, request))
    }

96
97
98
99
100
101
    /// Move a UUID and its Request to the waiting queue (front).
    fn first_in_line(&mut self, uuid: Uuid, request: Request) {
        self.requests.insert(uuid, request);
        self.waiting.push_front(uuid);
    }

102
    /// Move a UUID and its Request to the ready queue.
103
104
    fn move_to_prefill(&mut self, uuid: Uuid, active_seq: ActiveSequence, cost: PrefillCost) {
        self.waiting_tokens += cost.new_tokens;
105
        self.requests.insert(uuid, Request::Active(active_seq));
106
107
        self.prefill.push_back(uuid);
        self.prefill_costs.insert(uuid, cost);
108
109
    }

110
111
112
113
114
    /// Try (chunked) prefill and move to decode queue
    ///
    /// Returns `Some((prefill_compute, creation_signal, is_full_prefill))` where:
    /// - `prefill_compute`: The compute time in milliseconds for this prefill operation
    /// - `creation_signal`: Optional MoveBlock signal for KV cache block creation
115
    /// - `block_hashes`: Block hashes of the sequence beign prefilled
116
    /// - `is_full_prefill`: true if the entire sequence was prefilled, false if chunked
117
    fn try_prefill(&mut self) -> Option<(f64, Option<MoveBlock>, Vec<BlockHash>, bool)> {
118
119
120
        let uuid = self.prefill.pop_front()?;

        // Remove and extract prefill_compute from prefill_costs
121
        let mut prefill_cost = self
122
123
124
            .prefill_costs
            .remove(&uuid)
            .expect("Expects valid prefill cost.");
125

126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
        let new_tokens = prefill_cost.new_tokens;

        let maybe_prefill_tokens = self.max_num_batched_tokens.and_then(|max_tokens| {
            let remaining_tokens = max_tokens - self.active_tokens;
            if prefill_cost.new_tokens > remaining_tokens {
                Some(remaining_tokens)
            } else {
                None
            }
        });

        let (prefill_compute, is_full_prefill) = if let Some(prefill_tokens) = maybe_prefill_tokens
        {
            let prefill_compute = prefill_cost.predict_prefill_compute(Some(prefill_tokens));
            prefill_cost.new_tokens -= prefill_tokens;
            assert!(
                (prefill_cost.new_tokens > 0) && (prefill_compute > 0.0),
                "Encountered negative prefill tokens or prefill compute cost."
            );

            self.prefill.push_front(uuid);
            self.prefill_costs.insert(uuid, prefill_cost);

            self.active_tokens = self.max_num_batched_tokens.unwrap();
            self.waiting_tokens -= prefill_tokens;

            (prefill_compute, false)
        } else {
            // Assume possible to complete prefilling the sequence, transfer to decode
            self.decode.insert(uuid);

            self.active_tokens += new_tokens;
            self.waiting_tokens -= new_tokens;

            (prefill_cost.predict_prefill_compute(None), true)
        };

        // NOTE: the current behavior allocates the KV blocks for the entire sequence,
        // even if only a chunk is prefilled
        let Some(Request::Active(sequence)) = self.requests.get_mut(&uuid) else {
166
            panic!("Request does not exist.");
167
168
        };

169
170
171
        Some((
            prefill_compute,
            sequence.take_creation_signal(),
172
            sequence.block_hashes(),
173
174
175
176
177
178
179
            is_full_prefill,
        ))
    }

    // assume (chunked) prefills are completed, then active tokens would be 1 per decoding sequence
    fn reset_active_tokens(&mut self) {
        self.active_tokens = self.decode.len();
180
181
    }

182
183
184
185
186
187
188
189
    fn run(&mut self, uuid: Uuid) -> Option<&mut ActiveSequence> {
        if !self.decode.contains(&uuid) {
            return None;
        }
        let Some(Request::Active(sequence)) = self.requests.get_mut(&uuid) else {
            panic!("Request does not exist.");
        };
        Some(sequence)
190
191
    }

192
193
    fn num_active_requests(&self) -> usize {
        self.prefill.len() + self.decode.len()
194
195
196
197
    }

    /// Remove a UUID and its associated Request from collections.
    fn complete(&mut self, uuid: &Uuid) {
198
        tracing::trace!("Request {uuid} will complete");
199
        self.decode.remove(uuid);
200
201
        self.requests.remove(uuid);
        self.prefill_costs.remove(uuid);
202
        self.active_tokens -= 1;
203
204
205
206
207
    }

    /// Preempt the oldest running request by evicting it from running, resetting the sequence,
    /// and adding it back to the waiting queue.
    /// Returns the signal from reset_with_signal or None if no requests are running.
208
    fn preempt(&mut self) -> Vec<MoveBlock> {
209
        // Evict the oldest UUID from running
210
211
212
213
214
215
216
217
        let uuid = self
            .decode
            .evict()
            .expect("Nothing to evict for preemption.");
        let request = self
            .requests
            .remove(&uuid)
            .expect("Request does not exist.");
218
        self.prefill_costs.remove(&uuid);
219
220
        self.active_tokens -= 1;
        tracing::warn!("Request {uuid} will be preempted");
221

222
223
        // Reset the sequence and get the new sequence and signal
        // Insert the new sequence back into the requests map and add to waiting queue
224
225
226
227
228
        let Request::Active(mut active_sequence) = request else {
            panic!("Expected ActiveSequence in running queue")
        };
        let signals = active_sequence.reset_with_signal();

229
230
        // Note: For preemption, we don't compute hit rate since we don't have access to new_tokens
        // and the sequence is being reset anyway. Hit rate tracking is primarily for new scheduling attempts.
231

232
233
234
        self.first_in_line(uuid, Request::Active(active_sequence));

        signals
235
236
237
238
239
240
241
242
    }
}

/// Manages scheduling of requests using KvManager resources
#[derive(Clone)]
pub struct Scheduler {
    state: Arc<Mutex<SchedulerState>>,
    kv_manager: Arc<Mutex<KvManager>>,
243
    request_tx: mpsc::UnboundedSender<DirectRequest>,
244
    metrics_rx: tokio::sync::watch::Receiver<ForwardPassMetrics>,
245
246
247
248
249
}

impl Scheduler {
    /// Create a new Scheduler with the given parameters
    pub fn new(
250
251
252
253
        args: MockEngineArgs,
        dp_rank: Option<u32>,
        output_tx: Option<mpsc::UnboundedSender<OutputSignal>>,
        kv_events_tx: Option<mpsc::UnboundedSender<KvCacheEventData>>,
254
255
        cancellation_token: Option<CancellationToken>,
    ) -> Self {
256
        let state = Arc::new(Mutex::new(SchedulerState::new(args.max_num_batched_tokens)));
257

258
259
260
261
262
263
264
        // Create internal channel for KV events only if needed
        let (block_resp_tx, mut block_resp_rx) = if kv_events_tx.is_some() {
            let (tx, rx) = mpsc::unbounded_channel::<MoveBlockResponse>();
            (Some(tx), Some(rx))
        } else {
            (None, None)
        };
265

266
267
268
269
270
271
272
273
274
275
276
277
278
        let kv_manager = Arc::new(Mutex::new(KvManager::new_with_sender(
            args.num_gpu_blocks,
            args.block_size,
            block_resp_tx,
        )));
        let hit_rates = Arc::new(Mutex::new(VecDeque::with_capacity(1000)));

        // Assert speedup_ratio is greater than 0
        assert!(
            args.speedup_ratio > 0.0,
            "speedup_ratio must be greater than 0, got: {}",
            args.speedup_ratio
        );
279

280
281
        // Create channel for request handling
        let (request_tx, mut request_rx) = mpsc::unbounded_channel::<DirectRequest>();
282
283
284
285
        let mut initial_metrics = ForwardPassMetrics::default();
        initial_metrics.worker_stats.data_parallel_rank = dp_rank;
        let (metrics_tx, metrics_rx) =
            tokio::sync::watch::channel::<ForwardPassMetrics>(initial_metrics);
286
287
288
289
290

        // Create a clone for the background task
        let state_clone = state.clone();
        let kv_manager_clone = kv_manager.clone();
        let output_tx_clone = output_tx.clone();
291
        let cancel_token_clone = cancellation_token.unwrap_or_default().clone();
292
293
294

        // Spawn main background task with cancellation token
        tokio::spawn(async move {
295
            let mut should_schedule = true;
296
297

            loop {
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
                {
                    let state_guard = state_clone.lock().await;

                    // Enqueue new request, blocks until at least one is received, so no redundant work is done
                    // TODO: clean this up? double lock acquisition is ugly, but needed to not hold the lock forever
                    if state_guard.is_empty() {
                        drop(state_guard);
                        let Some(request) = request_rx.recv().await else {
                            tracing::warn!("request sender is dropped");
                            break;
                        };
                        let mut state_guard = state_clone.lock().await;
                        state_guard.receive(request);
                    }
                }

314
315
316
317
318
319
320
321
322
                tokio::select! {
                    biased;

                    // Enqueue new request
                    Some(request) = request_rx.recv() => {
                        let mut state = state_clone.lock().await;
                        state.receive(request);
                    }

323
                    // Try Scheduling Requests - runs on normal interval or after simulation
324
                    _ = tokio::task::yield_now() => {
325
326
327
328
329
                        // Skip if we just ran scheduling after simulation to prevent consecutive runs
                        if !should_schedule {
                            continue;
                        }

330
                        let mut state_guard = state_clone.lock().await;
331
                        let kv_manager_guard = kv_manager_clone.lock().await;
332
333
334

                        // Process DirectRequests, converting them to ActiveSequence and scheduling them until we can't
                        // schedule anymore.
335
                        let mut current_blocks = kv_manager_guard.num_active_blocks();
336
                        let mut current_tokens = state_guard.active_tokens + state_guard.waiting_tokens;
337
338
                        let mut current_seqs = state_guard.num_active_requests();

339
                        while let Some((uuid, request)) = state_guard.next() {
340
                            let active_sequence = get_active_sequence(request, args.block_size, args.enable_prefix_caching);
341

342
343
344
                            // Update predictive budgets
                            let prefill_cost = kv_manager_guard.get_prefill_cost(&active_sequence);
                            let total_tokens = active_sequence.len();
345
346
                            // this is conservative, assumes no cache hit so never over-schedules
                            let new_blocks = (total_tokens as u32).div_ceil(args.block_size as u32) as usize;
347
348
349
350
351
                            let new_tokens = prefill_cost.new_tokens;

                            current_blocks += new_blocks;
                            current_tokens += new_tokens;
                            current_seqs += 1;
352

353
                            // Check various budgets to see if possible to schedule
354
                            let under_block_budget = current_blocks as f64 <= (1. - args.watermark) * kv_manager_guard.max_capacity() as f64;
355
356
357
                            // If chunked prefill is enabled, we can be under token budget when scheduling
                            let comparison_tokens = if args.enable_chunked_prefill {current_tokens - new_tokens} else {current_tokens};
                            let under_token_budget = args.max_num_batched_tokens.is_none_or(|limit| comparison_tokens <= limit);
358
359
360
361
362
                            let under_seq_budget = args.max_num_seqs.is_none_or(|limit| current_seqs <= limit);

                            // Cannot schedule, put first in line instead
                            if !(under_block_budget && under_token_budget && under_seq_budget) {
                                state_guard.first_in_line(uuid, Request::Active(active_sequence));
363
                                break;
364
365
366
367
368
                            }

                            // Compute and store hit rate
                            let hit_rate = if !active_sequence.is_empty() { 1.0 - (new_tokens as f32 / active_sequence.len() as f32) } else { 0.0 };
                            {
369
                                let mut hit_rates_guard = hit_rates.lock().await;
370
371
372
373
374
                                hit_rates_guard.push_back(hit_rate);
                                if hit_rates_guard.len() > 1000 {
                                    hit_rates_guard.pop_front();
                                }
                            }
375

376
                            state_guard.move_to_prefill(uuid, active_sequence, prefill_cost);
377
                            should_schedule = false;
378
379
380
381
                        }
                    }

                    // Check for cancellation
382
                    _ = cancel_token_clone.cancelled() => {
383
384
                        break;
                    }
385
                }
386

387
388
389
390
391
392
393
394
395
396
                // Simulates prefill + decode
                let mut state_guard = state_clone.lock().await;
                let mut kv_manager_guard = kv_manager_clone.lock().await;

                // Base time needed for decoding using active percentage and quadratic formula
                let active_perc = kv_manager_guard.get_active_perc();
                let decoding_time = -5.47 * active_perc.powi(2) + 43.88 * active_perc + 19.44;
                let mut total_time = Duration::from_secs_f64(decoding_time / 1000.0);

                // Process prefilling
397
398
399
400
401
402
                while let Some((
                    prefill_compute,
                    maybe_creation_signal,
                    block_hashes,
                    is_full_prefill,
                )) = state_guard.try_prefill()
403
404
405
406
407
408
409
410
411
412
413
                {
                    // NOTE: Prefill cost/time is always incremented for new blocks, even if they
                    // could be cached by other requests in the same batch. This matches vLLM behavior.
                    total_time += Duration::from_secs_f64(prefill_compute / 1000.0);

                    if let Some(creation_signal) = maybe_creation_signal {
                        if !process_signals(
                            &mut kv_manager_guard,
                            std::slice::from_ref(&creation_signal),
                        ) {
                            panic!("Block allocation for prefilling cannot fail.");
414
                        }
415

416
417
418
419
420
                        // Drain KV events and forward to relay after prefill signal processing
                        if let (Some(ref relay_tx), Some(ref mut rx)) =
                            (&kv_events_tx, &mut block_resp_rx)
                        {
                            while let Ok(event) = rx.try_recv() {
421
422
                                let _ =
                                    relay_tx.send(block_response_to_kv_event(event, &block_hashes));
423
                            }
424
425
                        }
                    };
426

427
428
429
430
431
                    // Impossible to schedule more prefills if we encounter one incomplete (chunked) prefill
                    if !is_full_prefill {
                        break;
                    }
                }
432

433
434
                state_guard.reset_active_tokens();

435
436
437
438
439
440
441
442
443
444
445
                {
                    let hit_rates_guard = hit_rates.lock().await;
                    let metrics = get_fwd_pass_metrics(
                        &state_guard,
                        &kv_manager_guard,
                        &hit_rates_guard,
                        dp_rank,
                    );
                    let _ = metrics_tx.send(metrics);
                }

446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
                // Process decoding
                let uuids: Vec<Uuid> = state_guard.decode.keys().cloned().collect();
                if !uuids.is_empty() {
                    should_schedule = true
                };
                for uuid in uuids {
                    let Some(sequence) = state_guard.run(uuid) else {
                        continue;
                    };
                    let signals = sequence.generate();

                    // Process all signals with the KvManager
                    // Handling of preemption on failure
                    if !process_signals(&mut kv_manager_guard, &signals) {
                        sequence.pop(); // revert the failed generation op
                        for signal in state_guard.preempt() {
                            kv_manager_guard.process(&signal);
                        }
                        continue;
                    }
466

467
468
469
470
471
                    // Drain KV events and forward to relay after decode signal processing
                    if let (Some(ref relay_tx), Some(ref mut rx)) =
                        (&kv_events_tx, &mut block_resp_rx)
                    {
                        while let Ok(event) = rx.try_recv() {
472
473
                            let _ = relay_tx
                                .send(block_response_to_kv_event(event, &sequence.block_hashes()));
474
475
                        }
                    }
476

477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
                    // Check completion and send notification
                    let is_complete = sequence.generated_tokens() >= sequence.max_output_tokens();
                    let should_output =
                        sequence.generated_tokens() > sequence.already_generated_tokens();

                    let mut send_failed = false;
                    if should_output {
                        send_failed = output_tx_clone.as_ref().is_some_and(|tx| {
                            tx.send(OutputSignal {
                                uuid,
                                completed: is_complete,
                            })
                            .is_err()
                        });
                    }
492

493
494
495
                    if send_failed {
                        for signal in &sequence.free_signal() {
                            kv_manager_guard.process(signal);
496
                        }
497
                    }
498

499
500
501
502
503
504
505
506
507
508
509
                    {
                        let hit_rates_guard = hit_rates.lock().await;
                        let metrics = get_fwd_pass_metrics(
                            &state_guard,
                            &kv_manager_guard,
                            &hit_rates_guard,
                            dp_rank,
                        );
                        let _ = metrics_tx.send(metrics);
                    }

510
511
512
                    if send_failed || is_complete {
                        state_guard.complete(&uuid);
                        continue;
513
514
                    }
                }
515
516
517
518
519
520
521
522
523

                // Sleep once for the adjusted duration
                drop(kv_manager_guard);
                drop(state_guard);
                let adjusted_time =
                    Duration::from_secs_f64(total_time.as_secs_f64() / args.speedup_ratio);
                if adjusted_time.as_millis() > 0 {
                    tokio::time::sleep(adjusted_time).await;
                }
524
525
526
527
528
529
530
            }
        });

        Self {
            state,
            kv_manager,
            request_tx,
531
            metrics_rx,
532
533
534
535
536
        }
    }

    /// Add a new request to the waiting queue
    pub async fn receive(&self, request: DirectRequest) {
537
538
539
540
541
        let _ = self.request_tx.send(request);
    }

    pub fn request_sender(&self) -> mpsc::UnboundedSender<DirectRequest> {
        self.request_tx.clone()
542
543
544
545
546
547
548
549
550
    }

    pub async fn waiting_count(&self) -> usize {
        let state = self.state.lock().await;
        state.waiting.len()
    }

    pub async fn running_count(&self) -> usize {
        let state = self.state.lock().await;
551
        state.decode.len()
552
553
    }

554
555
556
557
558
559
560
561
562
563
    pub async fn waiting_tokens(&self) -> usize {
        let state = self.state.lock().await;
        state.waiting_tokens
    }

    pub async fn active_tokens(&self) -> usize {
        let state = self.state.lock().await;
        state.active_tokens
    }

564
565
566
567
568
    pub async fn kv_usage_perc(&self) -> f64 {
        let kv_manager = self.kv_manager.lock().await;
        kv_manager.current_capacity_perc()
    }

569
570
571
572
573
    /// Get a watch receiver for forward pass metrics
    pub fn metrics_receiver(&self) -> tokio::sync::watch::Receiver<ForwardPassMetrics> {
        self.metrics_rx.clone()
    }
}
574

575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
/// Calculate forward pass metrics from current state
fn get_fwd_pass_metrics(
    state: &SchedulerState,
    kv_manager: &KvManager,
    hit_rates: &VecDeque<f32>,
    dp_rank: Option<u32>,
) -> ForwardPassMetrics {
    // Get state metrics
    let request_active_slots = state.decode.len() as u64;
    let num_requests_waiting = state.waiting.len() as u64;

    // Get KV manager metrics
    let active_blocks_count = kv_manager.active_blocks().len() as u64;
    let total_capacity = kv_manager.max_capacity() as u64;
    let gpu_cache_usage_perc = if total_capacity > 0 {
        active_blocks_count as f32 / total_capacity as f32
    } else {
        0.0
    };
594

595
596
597
598
599
600
601
    // Get hit rate metrics
    let gpu_prefix_cache_hit_rate = if hit_rates.is_empty() {
        0.0
    } else {
        let sum: f32 = hit_rates.iter().sum();
        sum / hit_rates.len() as f32
    };
602

603
604
605
606
607
608
    let worker_stats = WorkerStats {
        data_parallel_rank: dp_rank,
        request_active_slots,
        request_total_slots: 1024, // vllm max_num_seqs for gpu >= 70 vram, otherwise 256, fallback is 128
        num_requests_waiting,
    };
609

610
611
612
613
614
615
    let kv_stats = KvStats {
        kv_active_blocks: active_blocks_count,
        kv_total_blocks: total_capacity,
        gpu_cache_usage_perc,
        gpu_prefix_cache_hit_rate,
    };
616

617
    let spec_decode_stats = None;
618

619
620
621
622
    ForwardPassMetrics {
        worker_stats,
        kv_stats,
        spec_decode_stats,
623
624
625
626
    }
}

/// Convert a Request to an ActiveSequence
627
628
629
630
631
fn get_active_sequence(
    request: Request,
    block_size: usize,
    enable_prefix_caching: bool,
) -> ActiveSequence {
632
633
634
635
636
637
638
639
640
641
642
643
    if let Request::Active(active_seq) = request {
        return active_seq;
    }

    let Request::Direct(direct_request) = request else {
        unreachable!("Request must be either Direct or Active");
    };

    ActiveSequence::new(
        direct_request.tokens,
        direct_request.max_output_tokens,
        Some(block_size),
644
        enable_prefix_caching,
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
    )
}

/// Processes MoveBlock signals with the KvManager.
///
/// When a signal fails, this function verifies that the failure is for an expected case:
/// specifically a single signal attempting to create a single partial (generation) block.
/// This validation is important because in normal operation, the only legitimate failure
/// case should be when trying to acquire a new generation block - any other failures would
/// indicate an unexpected state in the system.
fn process_signals(
    kv_manager_guard: &mut tokio::sync::MutexGuard<'_, KvManager>,
    signals: &[MoveBlock],
) -> bool {
    for signal in signals {
        if kv_manager_guard.process(signal) {
            continue;
        }

        // Check we have a Use signal with blocks
665
        let MoveBlock::Use(blocks) = signal else {
666
            panic!("Failed signal is Invalid. Has to fail on generation signal, but failed on {signal:?}");
667
668
669
        };

        // Verify the signal contains exactly one block
670
671
672
673
674
675
        let num_blocks = blocks.len();
        let num_active_blocks = kv_manager_guard.num_active_blocks();
        if num_blocks != 1 {
            panic!(
                "Failed signal is Invalid. Tried to create (prefill) {num_blocks} blocks on top of {num_active_blocks} active blocks."
            );
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
        }

        // Verify the block is a PartialBlock (generation block)
        if !matches!(blocks[0], UniqueBlock::PartialBlock(_)) {
            panic!("Failed signal is Invalid. Generation block has to be partial.");
        }

        return false;
    }

    true
}

#[cfg(test)]
mod tests {
    use super::*;
    use rstest::rstest;
    use std::time::Duration;
694
    use tokio::time::interval;
695
696

    #[rstest]
697
698
699
700
701
702
703
704
    #[case::case_1(false, false, false)]
    #[case::case_2(false, true, false)]
    #[case::case_3(true, false, false)]
    #[case::case_4(true, true, false)]
    #[case::case_5(false, false, true)]
    #[case::case_6(false, true, true)]
    #[case::case_7(true, false, true)]
    #[case::case_8(true, true, true)]
705
    #[tokio::test]
706
707
708
    async fn test_scheduler_token_generation_patterns(
        #[case] use_shared_tokens: bool,
        #[case] enable_prefix_caching: bool,
709
        #[case] enable_chunked_prefill: bool,
710
    ) {
711
712
713
        std::env::set_var("RUST_LOG", "debug");

        let kv_capacity: usize = 500;
714
        let block_size: usize = 64;
715
        let num_requests: usize = 200;
716
717
718
719
        let input_len: usize = 1000;
        let max_output_tokens: usize = 100;

        // Create channel for token output
720
721
722
723
724
725
726
727
        let (output_tx, mut output_rx) = mpsc::unbounded_channel::<OutputSignal>();

        // Create scheduler args using builder - now including enable_prefix_caching
        let args = MockEngineArgs::builder()
            .num_gpu_blocks(kv_capacity)
            .block_size(block_size)
            .speedup_ratio(10.0)
            .enable_prefix_caching(enable_prefix_caching)
728
            .enable_chunked_prefill(enable_chunked_prefill)
729
730
731
732
733
            .build()
            .unwrap();

        // Create scheduler with new args struct
        let scheduler = Scheduler::new(args, None, Some(output_tx), None, None);
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763

        // Create shared tokens for caching case
        let shared_tokens = if use_shared_tokens {
            Some(
                (0..input_len / 2)
                    .map(|_| rand::random::<u32>() % 50000)
                    .collect::<Vec<_>>(),
            )
        } else {
            None
        };

        // Create test requests
        for _ in 0..num_requests {
            let input_tokens = if let Some(ref shared) = shared_tokens {
                // For caching case: use shared tokens for first half, random for second half
                let mut tokens = shared.clone();
                tokens.extend((0..input_len / 2).map(|_| rand::random::<u32>() % 50000));
                tokens
            } else {
                // For random case: create unique random token vector for each request
                (0..input_len)
                    .map(|_| rand::random::<u32>() % 50000)
                    .collect::<Vec<_>>()
            };

            let request = DirectRequest {
                tokens: input_tokens,
                max_output_tokens,
                uuid: None,
764
                dp_rank: None,
765
766
767
768
769
770
771
772
773
774
775
776
777
778
            };
            scheduler.receive(request).await;
        }

        let start_time = std::time::Instant::now();

        // Collect all generated tokens (should be num_requests * max_output_tokens)
        let expected_tokens = num_requests * max_output_tokens;
        let mut received_tokens = 0;

        // Set up a timeout that causes the test to panic if no tokens are received for 2 seconds
        let timeout = tokio::time::sleep(Duration::from_secs(2));
        tokio::pin!(timeout);

779
780
781
        // Get metrics receiver
        let metrics_rx = scheduler.metrics_receiver();

782
783
784
785
786
787
788
789
790
        // Set up debug ticker interval
        let mut debug_interval = interval(Duration::from_millis(500));

        loop {
            tokio::select! {
                biased;

                // Manual debug ticker that prints forward pass metrics
                _ = debug_interval.tick() => {
791
                    let _metrics = metrics_rx.borrow().clone();
792
                    println!("Forward Pass Metrics: {_metrics:#?}");
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
                }

                Some(_) = output_rx.recv() => {
                    received_tokens += 1;
                    // Reset timeout whenever we receive a token
                    timeout.set(tokio::time::sleep(Duration::from_secs(2)));
                }

                _ = &mut timeout => {
                    // Break instead of panicking when timeout occurs
                    break;
                }
            }
        }

        // Calculate and print elapsed time
        let elapsed = start_time.elapsed();
        println!(
811
            "Test completed in: {elapsed:?} for {} case with prefix_caching={enable_prefix_caching} and chunked_prefill={enable_chunked_prefill}",
812
813
814
815
            if use_shared_tokens {
                "caching"
            } else {
                "random"
816
            }
817
818
819
820
        );

        // Assert that we received the expected number of tokens
        assert!(
821
822
823
            received_tokens == expected_tokens,
            "Received {received_tokens} tokens but expected exactly {expected_tokens}"
        );
824
825
826
827
828
829
830
831
832
833
834
835

        let active_tokens = scheduler.active_tokens().await;
        assert!(
            active_tokens == 0,
            "Scheduler still have {active_tokens} active tokens but expected 0"
        );

        let waiting_tokens = scheduler.waiting_tokens().await;
        assert!(
            waiting_tokens == 0,
            "Scheduler still have {waiting_tokens} waiting tokens but expected 0"
        );
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
    }

    #[tokio::test]
    async fn test_cache_hit_rate_with_identical_requests() {
        let block_size: usize = 64;
        let max_output_tokens: usize = 10;
        let speedup_ratio = 10.0;
        let num_requests = 10;
        let token_length = 65;

        // Create channel for token output
        let (output_tx, mut output_rx) = mpsc::unbounded_channel::<OutputSignal>();

        // Create scheduler args
        let args = MockEngineArgs::builder()
            .num_gpu_blocks(100) // Large enough to not be a constraint
            .block_size(block_size)
            .speedup_ratio(speedup_ratio)
            .build()
            .unwrap();

        // Create scheduler
        let scheduler = Scheduler::new(args, None, Some(output_tx), None, None);

        // Create identical tokens for all requests
        let identical_tokens: Vec<u32> = (0..token_length).map(|i| i as u32).collect();

        // Send all requests with identical tokens
        for _ in 0..num_requests {
            let request = DirectRequest {
                tokens: identical_tokens.clone(),
                max_output_tokens,
                uuid: None,
                dp_rank: None,
            };
            scheduler.receive(request).await;
            // Sleep for 0.1 second after each request
            tokio::time::sleep(Duration::from_millis(100)).await;
        }

        // Collect all generated tokens
        let mut received_tokens = 0;

        // Set up a timeout that resets to 0.5 seconds on each received token
        let timeout = tokio::time::sleep(Duration::from_millis(500));
        tokio::pin!(timeout);

883
884
885
        // Get metrics receiver
        let metrics_rx = scheduler.metrics_receiver();

886
887
888
889
890
891
892
893
894
        // Set up debug ticker interval
        let mut debug_interval = interval(Duration::from_millis(500));

        loop {
            tokio::select! {
                biased;

                // Manual debug ticker that prints forward pass metrics
                _ = debug_interval.tick() => {
895
                    let _metrics = metrics_rx.borrow().clone();
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
                    println!("Forward Pass Metrics: {_metrics:#?}");
                }

                Some(_signal) = output_rx.recv() => {
                    received_tokens += 1;
                    // Reset timeout whenever we receive a token
                    timeout.set(tokio::time::sleep(Duration::from_millis(500)));
                }

                _ = &mut timeout => {
                    // Break when timeout occurs (no more tokens for 0.5 seconds)
                    break;
                }
            }
        }

912
913
914
        // Wait a bit for final metrics update
        tokio::time::sleep(Duration::from_millis(100)).await;

915
        // Verify forward pass metrics
916
        let metrics = metrics_rx.borrow().clone();
917
918

        assert_eq!(
919
            metrics.worker_stats.num_requests_waiting, 0,
920
            "Expected no waiting requests, got {}",
921
            metrics.worker_stats.num_requests_waiting
922
923
924
        );

        assert!(
925
            metrics.kv_stats.gpu_prefix_cache_hit_rate > 0.8,
926
            "Expected cache hit rate > 0.8, got {}",
927
            metrics.kv_stats.gpu_prefix_cache_hit_rate
928
929
930
931
        );

        println!(
            "Test passed! Cache hit rate: {:.3}",
932
            metrics.kv_stats.gpu_prefix_cache_hit_rate
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
        );
        println!("Received {received_tokens} tokens");
    }

    #[tokio::test]
    async fn test_receiver_drop_cleans_up_resources() {
        let block_size: usize = 64;
        let input_tokens = 256;
        let max_output_tokens = 200; // More than we'll receive

        // Create channel for token output
        let (output_tx, mut output_rx) = mpsc::unbounded_channel::<OutputSignal>();

        // Create scheduler args
        let args = MockEngineArgs::builder()
            .num_gpu_blocks(10) // Enough for 256 tokens (4 blocks)
            .block_size(block_size)
            .speedup_ratio(100.0) // Fast simulation
            .build()
            .unwrap();

        // Create scheduler
        let scheduler = Scheduler::new(args, None, Some(output_tx), None, None);

        // Create request with 256 tokens
        let tokens: Vec<u32> = (0..input_tokens).map(|i| i as u32).collect();
        let request = DirectRequest {
            tokens,
            max_output_tokens,
            uuid: None,
            dp_rank: None,
        };

        scheduler.receive(request).await;

        // Receive exactly 129 tokens
        let mut received_count = 0;
        while received_count < 129 {
            if let Some(_signal) = output_rx.recv().await {
                received_count += 1;
            } else {
                panic!("Channel closed before receiving 129 tokens");
            }
        }

        // Drop the receiver immediately
        drop(output_rx);

        // Wait for 1 second to allow cleanup
        tokio::time::sleep(Duration::from_secs(1)).await;

        // Check forward pass metrics
985
986
        let metrics_rx = scheduler.metrics_receiver();
        let metrics = metrics_rx.borrow().clone();
987
988

        assert_eq!(
989
            metrics.kv_stats.gpu_cache_usage_perc,
990
991
            0.0,
            "Expected GPU cache usage to be 0%, got {}%",
992
            metrics.kv_stats.gpu_cache_usage_perc * 100.0
993
994
995
        );

        assert_eq!(
996
            metrics.kv_stats.kv_active_blocks, 0,
997
            "Expected 0 active blocks, got {}",
998
            metrics.kv_stats.kv_active_blocks
999
1000
1001
        );
    }
}