scheduler.rs 33.3 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

Yan Ru Pei's avatar
Yan Ru Pei committed
31
use crate::kv_router::protocols::{ForwardPassMetrics, KvStats, WorkerStats};
32
33
use crate::mocker::evictor::LRUEvictor;
use crate::mocker::kv_manager::KvManager;
34
use crate::mocker::perf_model::PerfModel;
Yan Ru Pei's avatar
Yan Ru Pei committed
35
36
37
38
use crate::mocker::protocols::{
    DirectRequest, MockEngineArgs, MoveBlock, OutputSignal, PrefillCost, WorkerType,
};
use crate::mocker::running_mean::RunningMean;
39
use crate::mocker::sequence::ActiveSequence;
40
use crate::tokens::blocks::UniqueBlock;
Yan Ru Pei's avatar
Yan Ru Pei committed
41
use std::collections::{HashMap, VecDeque};
42
use tokio::sync::mpsc;
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
115
    /// 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
    /// - `is_full_prefill`: true if the entire sequence was prefilled, false if chunked
116
    fn try_prefill(&mut self, perf_model: &PerfModel) -> Option<(f64, Option<MoveBlock>, bool)> {
117
118
119
        let uuid = self.prefill.pop_front()?;

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

125
126
127
128
129
130
131
132
133
134
135
136
137
        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
        {
138
139
            let prefill_compute =
                prefill_cost.predict_prefill_compute(Some(prefill_tokens), perf_model);
140
141
            prefill_cost.new_tokens -= prefill_tokens;
            assert!(
142
143
                prefill_cost.new_tokens > 0,
                "Encountered negative prefill tokens."
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
            );

            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;

160
            (prefill_cost.predict_prefill_compute(None, perf_model), true)
161
162
163
164
165
        };

        // 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
172
173
174
175
176
177
178
        Some((
            prefill_compute,
            sequence.take_creation_signal(),
            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();
179
180
    }

181
182
183
184
185
186
187
188
    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)
189
190
    }

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

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

    /// 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.
207
    fn preempt(&mut self) -> Vec<MoveBlock> {
208
        // Evict the oldest UUID from running
209
210
211
212
213
214
215
216
        let uuid = self
            .decode
            .evict()
            .expect("Nothing to evict for preemption.");
        let request = self
            .requests
            .remove(&uuid)
            .expect("Request does not exist.");
217
        self.prefill_costs.remove(&uuid);
218
219
        self.active_tokens -= 1;
        tracing::warn!("Request {uuid} will be preempted");
220

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

228
229
        // 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.
230

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

        signals
234
235
236
237
238
239
    }
}

/// Manages scheduling of requests using KvManager resources
#[derive(Clone)]
pub struct Scheduler {
240
    request_tx: mpsc::UnboundedSender<DirectRequest>,
241
    metrics_rx: tokio::sync::watch::Receiver<ForwardPassMetrics>,
242
243
244
245
246
}

impl Scheduler {
    /// Create a new Scheduler with the given parameters
    pub fn new(
247
        args: MockEngineArgs,
Yan Ru Pei's avatar
Yan Ru Pei committed
248
        dp_rank: u32,
249
        output_tx: Option<mpsc::UnboundedSender<OutputSignal>>,
Yan Ru Pei's avatar
Yan Ru Pei committed
250
        component: Option<dynamo_runtime::component::Component>,
251
252
        cancellation_token: Option<CancellationToken>,
    ) -> Self {
253
254
255
256
257
258
        // Assert speedup_ratio is greater than 0
        assert!(
            args.speedup_ratio > 0.0,
            "speedup_ratio must be greater than 0, got: {}",
            args.speedup_ratio
        );
259

260
261
        // Create channel for request handling
        let (request_tx, mut request_rx) = mpsc::unbounded_channel::<DirectRequest>();
262
        let mut initial_metrics = ForwardPassMetrics::default();
Yan Ru Pei's avatar
Yan Ru Pei committed
263
        initial_metrics.worker_stats.data_parallel_rank = Some(dp_rank);
264
265
        let (metrics_tx, metrics_rx) =
            tokio::sync::watch::channel::<ForwardPassMetrics>(initial_metrics);
266

267
        let cancel_token_clone = cancellation_token.unwrap_or_default().clone();
268
269
270

        // Spawn main background task with cancellation token
        tokio::spawn(async move {
271
272
            // Create state and kv_manager as local variables owned by this task
            let mut state = SchedulerState::new(args.max_num_batched_tokens);
Yan Ru Pei's avatar
Yan Ru Pei committed
273
274
275
276
277
278
279
            let mut kv_manager = KvManager::new_with_publisher(
                args.num_gpu_blocks,
                args.block_size,
                component,
                dp_rank,
            );
            let mut hit_rates = RunningMean::new(1000);
280
281

            loop {
Yan Ru Pei's avatar
Yan Ru Pei committed
282
283
284
285
286
287
288
289
290
                // 1. Receive requests
                if state.is_empty() {
                    // Fully idle - block until new request arrives
                    tokio::select! {
                        biased;
                        Some(request) = request_rx.recv() => {
                            state.receive(request);
                        }
                        _ = cancel_token_clone.cancelled() => {
291
                            break;
Yan Ru Pei's avatar
Yan Ru Pei committed
292
                        }
293
                    }
Yan Ru Pei's avatar
Yan Ru Pei committed
294
295
296
                } else {
                    // Has active/waiting work - collect any pending requests without blocking
                    while let Ok(request) = request_rx.try_recv() {
297
298
299
300
                        state.receive(request);
                    }

                    // Check for cancellation
Yan Ru Pei's avatar
Yan Ru Pei committed
301
                    if cancel_token_clone.is_cancelled() {
302
303
                        break;
                    }
304
                }
305

Yan Ru Pei's avatar
Yan Ru Pei committed
306
307
308
309
310
311
312
313
                // Start timing for this forward pass (schedule + simulate)
                let iteration_start = std::time::Instant::now();

                // 2. Schedule waiting requests (once per iteration)
                try_schedule(&mut state, &kv_manager, &mut hit_rates, &args);

                // 3. Simulate prefill + decode
                let mut total_time = Duration::ZERO;
314
315

                // Process prefilling
Yan Ru Pei's avatar
Yan Ru Pei committed
316
                while let Some((prefill_compute, maybe_creation_signal, is_full_prefill)) =
317
                    state.try_prefill(&args.perf_model)
318
319
320
                {
                    // 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.
Yan Ru Pei's avatar
Yan Ru Pei committed
321
322
323
324
                    // For decode workers, skip adding prefill compute time
                    if args.worker_type != WorkerType::Decode {
                        total_time += Duration::from_secs_f64(prefill_compute / 1000.0);
                    }
325

Yan Ru Pei's avatar
Yan Ru Pei committed
326
327
328
329
330
                    if let Some(creation_signal) = maybe_creation_signal
                        && !process_signals(&mut kv_manager, std::slice::from_ref(&creation_signal))
                    {
                        panic!("Block allocation for prefilling cannot fail.");
                    }
331

332
333
334
335
336
                    // Impossible to schedule more prefills if we encounter one incomplete (chunked) prefill
                    if !is_full_prefill {
                        break;
                    }
                }
337

338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
                // Compute decode timing
                let active_kv_tokens = kv_manager.num_active_blocks() * args.block_size;
                // Compute average context length across all active decode requests
                let (total_length, count) = state
                    .decode
                    .keys()
                    .filter_map(|uuid| state.requests.get(uuid))
                    .fold((0usize, 0usize), |(sum, cnt), req| {
                        if let Request::Active(seq) = req {
                            (sum + seq.len(), cnt + 1)
                        } else {
                            (sum, cnt)
                        }
                    });
                let context_length = if count > 0 { total_length / count } else { 0 };
                let decoding_time = args
                    .perf_model
                    .predict_decode_time(active_kv_tokens, context_length);
Yan Ru Pei's avatar
Yan Ru Pei committed
356
357
                total_time += Duration::from_secs_f64(decoding_time / 1000.0);

358
                state.reset_active_tokens();
359

360
                // Process decoding
361
                let uuids: Vec<Uuid> = state.decode.keys().cloned().collect();
362
                for uuid in uuids {
363
                    let Some(sequence) = state.run(uuid) else {
364
365
366
367
368
369
                        continue;
                    };
                    let signals = sequence.generate();

                    // Process all signals with the KvManager
                    // Handling of preemption on failure
370
                    if !process_signals(&mut kv_manager, &signals) {
371
                        sequence.pop(); // revert the failed generation op
372
373
                        for signal in state.preempt() {
                            kv_manager.process(&signal);
374
375
376
                        }
                        continue;
                    }
377

378
379
380
381
382
383
384
                    // 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 {
385
                        send_failed = output_tx.as_ref().is_some_and(|tx| {
386
387
388
389
390
391
392
                            tx.send(OutputSignal {
                                uuid,
                                completed: is_complete,
                            })
                            .is_err()
                        });
                    }
393

394
395
                    if send_failed {
                        for signal in &sequence.free_signal() {
396
                            kv_manager.process(signal);
397
                        }
398
                    }
399

400
                    if send_failed || is_complete {
401
                        state.complete(&uuid);
402
                        continue;
403
404
                    }
                }
405

406
407
408
409
410
411
                // Send metrics once per forward pass (after all prefill and decode processing)
                {
                    let metrics = get_fwd_pass_metrics(&state, &kv_manager, &hit_rates, dp_rank);
                    let _ = metrics_tx.send(metrics);
                }

Yan Ru Pei's avatar
Yan Ru Pei committed
412
413
                // 4. Sleep to maintain target iteration timing
                let target_duration =
414
                    Duration::from_secs_f64(total_time.as_secs_f64() / args.speedup_ratio);
Yan Ru Pei's avatar
Yan Ru Pei committed
415
416
417
418
                let elapsed = iteration_start.elapsed();

                if elapsed < target_duration {
                    tokio::time::sleep(target_duration - elapsed).await;
419
                }
420
421
422
423
424
            }
        });

        Self {
            request_tx,
425
            metrics_rx,
426
427
428
429
430
        }
    }

    /// Add a new request to the waiting queue
    pub async fn receive(&self, request: DirectRequest) {
431
432
433
434
435
        let _ = self.request_tx.send(request);
    }

    pub fn request_sender(&self) -> mpsc::UnboundedSender<DirectRequest> {
        self.request_tx.clone()
436
437
    }

438
439
440
441
442
    /// Get a watch receiver for forward pass metrics
    pub fn metrics_receiver(&self) -> tokio::sync::watch::Receiver<ForwardPassMetrics> {
        self.metrics_rx.clone()
    }
}
443

444
445
446
447
/// Calculate forward pass metrics from current state
fn get_fwd_pass_metrics(
    state: &SchedulerState,
    kv_manager: &KvManager,
Yan Ru Pei's avatar
Yan Ru Pei committed
448
    hit_rates: &RunningMean<f32>,
Yan Ru Pei's avatar
Yan Ru Pei committed
449
    dp_rank: u32,
450
451
452
453
454
455
) -> 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
Yan Ru Pei's avatar
Yan Ru Pei committed
456
    let active_blocks_count = kv_manager.num_active_blocks() as u64;
457
458
459
460
461
462
    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
    };
463

Yan Ru Pei's avatar
Yan Ru Pei committed
464
465
    // Get hit rate metrics - O(1) access
    let gpu_prefix_cache_hit_rate = hit_rates.mean();
466

467
    let worker_stats = WorkerStats {
Yan Ru Pei's avatar
Yan Ru Pei committed
468
        data_parallel_rank: Some(dp_rank),
469
470
471
472
        request_active_slots,
        request_total_slots: 1024, // vllm max_num_seqs for gpu >= 70 vram, otherwise 256, fallback is 128
        num_requests_waiting,
    };
473

474
475
476
477
478
479
    let kv_stats = KvStats {
        kv_active_blocks: active_blocks_count,
        kv_total_blocks: total_capacity,
        gpu_cache_usage_perc,
        gpu_prefix_cache_hit_rate,
    };
480

481
    let spec_decode_stats = None;
482

483
484
485
486
    ForwardPassMetrics {
        worker_stats,
        kv_stats,
        spec_decode_stats,
487
488
489
    }
}

Yan Ru Pei's avatar
Yan Ru Pei committed
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
/// Attempts to schedule waiting requests from the state queue.
/// Returns the number of requests successfully scheduled.
fn try_schedule(
    state: &mut SchedulerState,
    kv_manager: &KvManager,
    hit_rates: &mut RunningMean<f32>,
    args: &MockEngineArgs,
) -> usize {
    let mut scheduled_count = 0;
    let mut current_blocks = kv_manager.num_active_blocks();
    let mut current_tokens = state.active_tokens + state.waiting_tokens;
    let mut current_seqs = state.num_active_requests();

    while let Some((uuid, request)) = state.next() {
        // Convert Request to ActiveSequence
        let active_sequence = match request {
            Request::Active(active_seq) => active_seq,
            Request::Direct(direct_request) => ActiveSequence::new(
                direct_request.tokens,
                direct_request.max_output_tokens,
                Some(args.block_size),
                args.enable_prefix_caching,
            ),
        };
514

Yan Ru Pei's avatar
Yan Ru Pei committed
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
        // Update predictive budgets
        let prefill_cost = kv_manager.get_prefill_cost(&active_sequence);
        let total_tokens = active_sequence.len();
        // 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;
        let new_tokens = prefill_cost.new_tokens;

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

        // Check various budgets to see if possible to schedule
        let under_block_budget =
            current_blocks as f64 <= (1. - args.watermark) * kv_manager.max_capacity() as f64;
        // 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);
        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.first_in_line(uuid, Request::Active(active_sequence));
            break;
        }

        // 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
        };
        hit_rates.push(hit_rate);

        state.move_to_prefill(uuid, active_sequence, prefill_cost);
        scheduled_count += 1;
    }
557

Yan Ru Pei's avatar
Yan Ru Pei committed
558
    scheduled_count
559
560
561
562
563
564
565
566
567
}

/// 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.
568
fn process_signals(kv_manager: &mut KvManager, signals: &[MoveBlock]) -> bool {
569
    for signal in signals {
570
        if kv_manager.process(signal) {
571
572
573
574
            continue;
        }

        // Check we have a Use signal with blocks
Yan Ru Pei's avatar
Yan Ru Pei committed
575
        let MoveBlock::Use(blocks, _hashes) = signal else {
576
577
578
            panic!(
                "Failed signal is Invalid. Has to fail on generation signal, but failed on {signal:?}"
            );
579
580
581
        };

        // Verify the signal contains exactly one block
582
        let num_blocks = blocks.len();
583
        let num_active_blocks = kv_manager.num_active_blocks();
584
585
586
587
        if num_blocks != 1 {
            panic!(
                "Failed signal is Invalid. Tried to create (prefill) {num_blocks} blocks on top of {num_active_blocks} active blocks."
            );
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
        }

        // 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;
606
    use tokio::time::interval;
607

608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
    /// Helper function to verify that the scheduler is idle (no active or waiting requests/resources)
    fn assert_scheduler_idle(metrics: &ForwardPassMetrics) {
        assert_eq!(
            metrics.worker_stats.request_active_slots, 0,
            "Expected 0 active slots, got {}",
            metrics.worker_stats.request_active_slots
        );
        assert_eq!(
            metrics.worker_stats.num_requests_waiting, 0,
            "Expected 0 waiting requests, got {}",
            metrics.worker_stats.num_requests_waiting
        );
        assert_eq!(
            metrics.kv_stats.kv_active_blocks, 0,
            "Expected 0 active blocks, got {}",
            metrics.kv_stats.kv_active_blocks
        );
        assert_eq!(
            metrics.kv_stats.gpu_cache_usage_perc, 0.0,
            "Expected 0% GPU cache usage, got {}",
            metrics.kv_stats.gpu_cache_usage_perc
        );
    }

632
    #[rstest]
633
634
635
636
637
638
639
640
    #[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)]
641
    #[tokio::test]
642
643
644
    async fn test_scheduler_token_generation_patterns(
        #[case] use_shared_tokens: bool,
        #[case] enable_prefix_caching: bool,
645
        #[case] enable_chunked_prefill: bool,
646
    ) {
647
        unsafe { std::env::set_var("RUST_LOG", "debug") };
648
649

        let kv_capacity: usize = 500;
650
        let block_size: usize = 64;
651
        let num_requests: usize = 200;
652
653
654
655
        let input_len: usize = 1000;
        let max_output_tokens: usize = 100;

        // Create channel for token output
656
657
658
659
660
661
662
663
        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)
664
            .enable_chunked_prefill(enable_chunked_prefill)
665
666
667
668
            .build()
            .unwrap();

        // Create scheduler with new args struct
Yan Ru Pei's avatar
Yan Ru Pei committed
669
        let scheduler = Scheduler::new(args, 0, Some(output_tx), None, None);
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699

        // 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,
Yan Ru Pei's avatar
Yan Ru Pei committed
700
                dp_rank: 0,
701
702
703
704
705
706
707
708
709
710
711
712
713
714
            };
            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);

715
716
717
        // Get metrics receiver
        let metrics_rx = scheduler.metrics_receiver();

718
719
720
721
722
723
724
725
726
        // 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() => {
727
                    let _metrics = metrics_rx.borrow().clone();
728
                    tracing::debug!("Forward Pass Metrics: {_metrics:#?}");
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
                }

                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!(
747
            "Test completed in: {elapsed:?} for {} case with prefix_caching={enable_prefix_caching} and chunked_prefill={enable_chunked_prefill}",
748
749
750
751
            if use_shared_tokens {
                "caching"
            } else {
                "random"
752
            }
753
754
755
756
        );

        // Assert that we received the expected number of tokens
        assert!(
757
758
759
            received_tokens == expected_tokens,
            "Received {received_tokens} tokens but expected exactly {expected_tokens}"
        );
760

761
762
        // Wait a bit for final metrics update to propagate
        tokio::time::sleep(Duration::from_millis(100)).await;
763

764
765
        let metrics = scheduler.metrics_receiver().borrow().clone();
        assert_scheduler_idle(&metrics);
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
    }

    #[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
Yan Ru Pei's avatar
Yan Ru Pei committed
788
        let scheduler = Scheduler::new(args, 0, Some(output_tx), None, None);
789
790
791
792
793
794
795
796
797
798

        // 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,
Yan Ru Pei's avatar
Yan Ru Pei committed
799
                dp_rank: 0,
800
801
802
803
804
805
806
807
808
809
810
811
812
            };
            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);

813
814
815
        // Get metrics receiver
        let metrics_rx = scheduler.metrics_receiver();

816
817
818
819
820
821
822
823
824
        // 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() => {
825
                    let _metrics = metrics_rx.borrow().clone();
826
                    tracing::debug!("Forward Pass Metrics: {_metrics:#?}");
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
                }

                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;
                }
            }
        }

842
843
844
        // Wait a bit for final metrics update
        tokio::time::sleep(Duration::from_millis(100)).await;

845
        // Verify forward pass metrics
846
        let metrics = metrics_rx.borrow().clone();
847

848
        assert_scheduler_idle(&metrics);
849
        assert!(
850
            metrics.kv_stats.gpu_prefix_cache_hit_rate > 0.8,
851
            "Expected cache hit rate > 0.8, got {}",
852
            metrics.kv_stats.gpu_prefix_cache_hit_rate
853
854
855
856
        );

        println!(
            "Test passed! Cache hit rate: {:.3}",
857
            metrics.kv_stats.gpu_prefix_cache_hit_rate
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
        );
        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
Yan Ru Pei's avatar
Yan Ru Pei committed
880
        let scheduler = Scheduler::new(args, 0, Some(output_tx), None, None);
881
882
883
884
885
886
887

        // 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,
Yan Ru Pei's avatar
Yan Ru Pei committed
888
            dp_rank: 0,
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
        };

        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
910
911
        let metrics_rx = scheduler.metrics_receiver();
        let metrics = metrics_rx.borrow().clone();
912

913
        assert_scheduler_idle(&metrics);
914
915
    }
}