dynamo-llm 1.5.0

Dynamo LLM Library
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

use super::*;
use crate::kv_router::{FindBestMatchAdmission, routing_host::kv_selection::SelectionOutcome};

impl<Sel> RoutingHost<Sel>
where
    Sel: WorkerSelector<ModelRuntimeConfig> + Send + 'static,
{
    #[allow(clippy::too_many_arguments)]
    async fn select_request_outcome(
        &self,
        request: &SingleIn<PreprocessedRequest>,
        phase: RequestPhase,
        is_query_only: bool,
        affinity_target: Option<AffinityTarget>,
        planned_worker: Option<WorkerWithDpRank>,
        admission: FindBestMatchAdmission,
        budget: &CleanupBudget,
    ) -> Result<SelectionOutcome, Error> {
        let context_id = request.context().id().to_string();
        let staged_kv = StagedKv::for_request(request.content());
        let policy_class = request.metadata().get("policy-class").cloned();
        let session_context = request
            .agent_context
            .as_ref()
            .map(to_worker_selection_session_context);
        let routing_parts = RoutingRequestParts::new(request);
        let request_context = request.context().clone();
        let selection_future = self
            .select_worker_outcome(
                &context_id,
                request,
                routing_parts,
                phase,
                is_query_only,
                SelectionOptions {
                    pinned_target: match self.session_affinity_mode {
                        SessionAffinityMode::Hard => affinity_target,
                        SessionAffinityMode::Soft => None,
                    },
                    affinity_target: match self.session_affinity_mode {
                        SessionAffinityMode::Hard => None,
                        SessionAffinityMode::Soft => affinity_target,
                    },
                    planned_worker,
                    policy_class,
                    session_context,
                    admission,
                },
            )
            .instrument(tracing::info_span!("kv_router.select_worker"));

        await_with_cleanup_policy(
            request_context.as_ref(),
            phase,
            staged_kv,
            "kv.select_worker",
            budget,
            selection_future,
        )
        .await?
    }

    async fn select_request(
        &self,
        request: &SingleIn<PreprocessedRequest>,
        phase: RequestPhase,
        is_query_only: bool,
        affinity_target: Option<AffinityTarget>,
        budget: &CleanupBudget,
    ) -> Result<WorkerSelection, Error> {
        self.select_request_outcome(
            request,
            phase,
            is_query_only,
            affinity_target,
            None,
            FindBestMatchAdmission::WithAdmission {
                track_lifecycle: true,
            },
            budget,
        )
        .await?
        .into_result()
    }

    pub(super) async fn select_with_affinity(
        &self,
        request: &SingleIn<PreprocessedRequest>,
        phase: RequestPhase,
        is_query_only: bool,
        budget: &CleanupBudget,
    ) -> Result<(WorkerSelection, Option<AffinityAcquire>), Error> {
        self.validate_explicit_worker(request.content(), phase)?;
        self.select_with_session_affinity(request, phase, is_query_only, budget, |target| {
            self.select_request(request, phase, is_query_only, target, budget)
        })
        .await
    }

    fn route_signals(&self, selection: &WorkerSelection) -> RoutePlanSignals {
        let total_kv_blocks = match selection.selected_worker_load {
            Some(load) => load
                .total_kv_blocks
                .and_then(|blocks| blocks.try_into().ok()),
            None => self
                .kv_router()
                .workers_with_configs
                .borrow()
                .get(&selection.worker.worker_id)
                .and_then(WorkerConfigLike::total_kv_blocks),
        };
        RoutePlanSignals {
            worker: selection.worker,
            overlap_blocks: selection.overlap_amount,
            cached_tokens: selection.cached_tokens,
            potential_decode_blocks: selection.potential_decode_blocks,
            total_kv_blocks,
        }
    }

    pub(crate) async fn preview_kv_route(
        &self,
        request: &SingleIn<PreprocessedRequest>,
        phase: RequestPhase,
    ) -> Result<RoutePreview, Error> {
        // The conditional route's first stage. The budget travels with the
        // preview into the plan and on into dispatch, so the whole route shares
        // one deadline.
        let budget = CleanupBudget::default();
        if self.kv_router_if_enabled().is_none() {
            return Err(anyhow::anyhow!("KV route previews require KV routing"));
        }
        self.validate_explicit_worker(request.content(), phase)?;

        let phase_label = phase.to_string();
        let route_guard = StageGuard::new(STAGE_ROUTE, &phase_label);
        let (outcome, _) = self
            .select_with_session_affinity(request, phase, true, &budget, |target| {
                self.select_request_outcome(
                    request,
                    phase,
                    true,
                    target,
                    None,
                    FindBestMatchAdmission::WithoutAdmission,
                    &budget,
                )
            })
            .await?;
        let selection = outcome.into_result()?;
        let signals = self.route_signals(&selection);
        drop(route_guard);
        Ok(RoutePreview {
            request_id: request.context().id().to_string(),
            phase,
            signals,
            budget,
        })
    }

    pub(crate) async fn plan_kv_route_from_preview(
        &self,
        request: &SingleIn<PreprocessedRequest>,
        preview: RoutePreview,
    ) -> Result<RoutePlan<Sel>, Error> {
        // Inherited, not restarted: this stage continues the route the preview
        // opened.
        let budget = preview.budget;
        if self.kv_router_if_enabled().is_none() {
            return Err(anyhow::anyhow!("KV route plans require KV routing"));
        }
        if request.context().id() != preview.request_id {
            return Err(anyhow::anyhow!(
                "KV route preview belongs to request {}, not {}",
                preview.request_id,
                request.context().id(),
            ));
        }

        let phase = preview.phase;
        let phase_label = phase.to_string();
        let route_guard = StageGuard::new(STAGE_ROUTE, &phase_label);
        let planned_worker = preview.signals.worker;
        let (selection, affinity) = self
            .select_with_session_affinity(request, phase, false, &budget, |target| {
                let budget = &budget;
                async move {
                    self.select_request_outcome(
                        request,
                        phase,
                        false,
                        target,
                        Some(planned_worker),
                        FindBestMatchAdmission::WithAdmission {
                            track_lifecycle: true,
                        },
                        budget,
                    )
                    .await?
                    .into_result()
                }
            })
            .await?;
        let signals = self.route_signals(&selection);
        drop(route_guard);
        Ok(RoutePlan {
            signals,
            cleanup: KvRequestCleanup::new(
                Arc::clone(self.kv_router()),
                request.context().id().to_string(),
                selection.worker,
                selection.attempt,
            ),
            selection,
            affinity,
            budget,
        })
    }

    pub(crate) async fn dispatch_kv_plan(
        &self,
        request: SingleIn<PreprocessedRequest>,
        plan: RoutePlan<Sel>,
    ) -> Result<ManyOut<Annotated<LLMEngineOutput>>, Error> {
        let RoutePlan {
            mut selection,
            cleanup,
            mut affinity,
            budget,
            ..
        } = plan;
        let selected_target = route_target(selection.worker);
        let guard = match self
            .track_planned_selection(&request, &mut selection, cleanup, &budget)
            .await
        {
            Ok(guard) => guard,
            Err(error) => return Err(error),
        };
        let stream = match self
            .dispatch_selection(request, selection, guard, &budget)
            .await
        {
            Ok(stream) => stream,
            Err(error) => {
                if self.session_affinity_mode == SessionAffinityMode::Hard
                    && !self.affinity_target_is_valid(selected_target)
                    && let Some(operation) = affinity.take()
                {
                    operation.invalidate();
                }
                return Err(error);
            }
        };
        match affinity {
            Some(affinity) => {
                affinity.into_stream(selected_target, stream, self.session_affinity_mode)
            }
            None => Ok(stream),
        }
    }

    pub(crate) async fn prefill_worker_busy(
        &self,
        request: &SingleIn<PreprocessedRequest>,
        threshold: f64,
    ) -> Result<bool, Error> {
        // A local budget is sound here and only here: the probe is pinned to
        // `RequestPhase::Prefill`, which never selects `DispatchWhenStopped`, so
        // nothing it runs can arm or spend a budget.
        let budget = CleanupBudget::default();
        if self.kv_router_if_enabled().is_none() {
            return Err(anyhow::anyhow!("prefill load probe requires KV routing"));
        }

        let (outcome, _) = self
            .select_with_session_affinity(request, RequestPhase::Prefill, true, &budget, |target| {
                self.select_request_outcome(
                    request,
                    RequestPhase::Prefill,
                    true,
                    target,
                    None,
                    FindBestMatchAdmission::WithoutAdmission,
                    &budget,
                )
            })
            .await?;
        match outcome {
            SelectionOutcome::Routed(selection) => selection
                .selected_worker_load
                .map(|load| load.prefill_load_exceeds(threshold))
                .ok_or_else(|| anyhow::anyhow!("advisory prefill selection returned no load")),
            SelectionOutcome::QueueRejected(_) => Ok(true),
        }
    }

    pub(super) async fn track_selection(
        &self,
        request: &SingleIn<PreprocessedRequest>,
        selection: &mut WorkerSelection,
        phase: RequestPhase,
        is_query_only: bool,
        budget: &CleanupBudget,
    ) -> Result<RequestGuard<Sel>, Error> {
        self.track_selection_with_cleanup(request, selection, phase, is_query_only, None, budget)
            .await
    }

    async fn track_planned_selection(
        &self,
        request: &SingleIn<PreprocessedRequest>,
        selection: &mut WorkerSelection,
        cleanup: KvRequestCleanup<Sel>,
        budget: &CleanupBudget,
    ) -> Result<RequestGuard<Sel>, Error> {
        let phase = request
            .tracker
            .as_ref()
            .map(|tracker| tracker.phase())
            .unwrap_or(RequestPhase::Aggregated);
        self.track_selection_with_cleanup(request, selection, phase, false, Some(cleanup), budget)
            .await
    }

    async fn track_selection_with_cleanup(
        &self,
        request: &SingleIn<PreprocessedRequest>,
        selection: &mut WorkerSelection,
        phase: RequestPhase,
        is_query_only: bool,
        cleanup: Option<KvRequestCleanup<Sel>>,
        budget: &CleanupBudget,
    ) -> Result<RequestGuard<Sel>, Error> {
        let context_id = request.context().id().to_string();
        let staged_kv = StagedKv::for_request(request.content());
        let request_context = request.context().clone();
        let routing_parts = RoutingRequestParts::new(request);
        let chooser = self.kv_router();
        let block_size = chooser.block_size() as usize;
        let selected_worker = selection.worker;
        let mut guard = match cleanup {
            Some(cleanup) => {
                RequestGuard::new_kv_with_cleanup(self.request_metrics.clone(), cleanup, request)
            }
            None => RequestGuard::new_kv(
                Arc::clone(chooser),
                self.request_metrics.clone(),
                context_id.clone(),
                selected_worker,
                selection.attempt,
                request,
            ),
        };

        let record_result: Result<(), Error> = async {
            if !is_query_only && chooser.indexer().records_routing_decisions() {
                let worker = selected_worker;
                let hashes = if let Some(hashes) = selection.routing_hashes.take() {
                    hashes
                } else {
                    let routing = request.routing.as_ref();
                    let mut tokens_with_hashes = TokensWithHashes::new(
                        routing_parts.token_ids.to_vec(),
                        chooser.block_size(),
                    )
                    .with_is_eagle(chooser.is_eagle());
                    if let Some(infos) = routing_parts.block_mm_infos {
                        tokens_with_hashes = tokens_with_hashes.with_mm_infos(infos.to_vec());
                    }
                    if let Some(lora_name) = routing.and_then(|r| r.lora_name.clone()) {
                        tokens_with_hashes = tokens_with_hashes.with_lora_name(lora_name);
                    }
                    if let Some(cache_namespace) = routing.and_then(|r| r.cache_namespace.clone()) {
                        tokens_with_hashes =
                            tokens_with_hashes.with_cache_namespace(cache_namespace);
                    }
                    let local_hashes = tokens_with_hashes.get_or_compute_block_hashes().to_vec();
                    let sequence_hashes = tokens_with_hashes.get_or_compute_seq_hashes().to_vec();
                    dynamo_kv_router::indexer::RoutingDecisionHashes {
                        local_hashes,
                        sequence_hashes,
                    }
                };
                let record_result = if guard.has_approximate_lru() {
                    await_with_cleanup_policy(
                        request_context.as_ref(),
                        phase,
                        staged_kv,
                        "kv.record_routing_decision",
                        budget,
                        guard.acquire_approximate_lru(hashes),
                    )
                    .await?
                } else {
                    await_with_cleanup_policy(
                        request_context.as_ref(),
                        phase,
                        staged_kv,
                        "kv.record_routing_decision",
                        budget,
                        chooser.record_routing_decision_hashes(hashes, worker),
                    )
                    .await?
                };
                if let Err(error) = record_result {
                    tracing::warn!(
                        request_id = %context_id,
                        worker_id = selection.worker.worker_id,
                        dp_rank = selection.worker.dp_rank,
                        error = %error,
                        "Failed to record routing decision"
                    );
                }
            }

            if let Some(ref tracker) = request.tracker {
                let isl_blocks = routing_parts.token_ids.len().div_ceil(block_size);
                tracker.record_kv_hit(selection.effective_overlap_blocks, isl_blocks);
                tracker.record_isl(routing_parts.token_ids.len(), Some(selection.cached_tokens));
                tracker.record_worker(
                    selection.worker.worker_id,
                    Some(selection.worker.dp_rank),
                    chooser.worker_type(),
                );
                tracker.record_router_queue_depth(chooser.pending_count());
                if let Some(hit_rate) = tracker.kv_hit_rate() {
                    guard.request_metrics().kv_hit_rate.observe(hit_rate);
                }
            }
            guard
                .request_metrics()
                .input_sequence_tokens
                .observe(request.token_ids.len() as f64);
            Ok(())
        }
        .await;

        if let Err(error) = record_result {
            guard.abort().await;
            return Err(error);
        }
        Ok(guard)
    }

    pub(super) async fn dispatch_selection(
        &self,
        request: SingleIn<PreprocessedRequest>,
        selection: WorkerSelection,
        mut guard: RequestGuard<Sel>,
        budget: &CleanupBudget,
    ) -> Result<ManyOut<Annotated<LLMEngineOutput>>, Error> {
        let context_id = request.context().id().to_string();
        let request_context = request.context().clone();
        let route_trace_context = get_route_trace_context(&request);
        let phase = request
            .tracker
            .as_ref()
            .map(|tracker| tracker.phase())
            .unwrap_or(RequestPhase::Aggregated);
        let staged_kv = StagedKv::for_request(request.content());
        let phase_label = phase.to_string();
        guard.start_dispatch(&phase_label);
        self.warn_if_output_replay_annotation_ignored(&request, &selection);

        let (mut backend_input, context) = request.into_parts();
        backend_input.routing_mut().dp_rank = Some(selection.worker.dp_rank);
        let _ = backend_input
            .extra_args
            .as_mut()
            .and_then(serde_json::Value::as_object_mut)
            .and_then(|args| args.get_mut("kv_transfer_params"))
            .and_then(serde_json::Value::as_object_mut)
            .and_then(|params| params.remove("router_hint"));
        if let Some(router_hint) = selection.router_hint.as_ref()
            && let Err(error) = backend_input.attach_router_hint(router_hint)
        {
            tracing::warn!(
                request_id = %context_id,
                worker_id = selection.worker.worker_id,
                error = %error,
                "Failed to attach router_hint to backend request"
            );
        }
        let updated_request = context.map(|_| backend_input);
        guard.record_prefill_start();

        let dispatch = self
            .inner
            .dispatch_kv_admitted(updated_request, selection.worker.worker_id);
        let route_span = tracing::info_span!(
            target: "request_span",
            "kv_router.route_request",
            otel.kind = "client",
            request_id = %context_id,
            worker_id = tracing::field::Empty,
            dp_rank = selection.worker.dp_rank,
            overlap_blocks = selection.overlap_amount,
            phase = ?phase,
            "request.attempt" = tracing::field::Empty,
            "request.outcome" = tracing::field::Empty,
            "migration.is_retry" = tracing::field::Empty,
            "migration.reason" = tracing::field::Empty,
            "migration.from_worker_id" = tracing::field::Empty,
            "migration.tokens_completed" = tracing::field::Empty,
            "cancellation.signal" = tracing::field::Empty,
            "error.type" = tracing::field::Empty,
            otel.status_code = tracing::field::Empty,
            otel.status_description = tracing::field::Empty,
        );
        record_route_span_start(
            &route_span,
            route_trace_context.as_deref(),
            selection.worker.worker_id,
        );
        let dispatch_result = await_with_cleanup_policy(
            request_context.as_ref(),
            phase,
            staged_kv,
            "kv.dispatch",
            budget,
            dispatch.instrument(route_span.clone()),
        )
        .await
        .and_then(|result| result);
        let response_stream = match dispatch_result {
            Ok(stream) => stream,
            Err(error) => {
                record_route_error(&route_span, error.as_ref());
                let typed_error = error
                    .chain()
                    .find_map(|cause| cause.downcast_ref::<DynamoError>().cloned());
                guard.record_migration_failure(typed_error);
                guard.abort().await;
                return Err(error);
            }
        };

        guard.mark_dispatched();
        Ok(wrap_route_span(
            into_monitored_response(response_stream, guard),
            route_span,
        ))
    }

    fn warn_if_output_replay_annotation_ignored(
        &self,
        request: &SingleIn<PreprocessedRequest>,
        selection: &WorkerSelection,
    ) {
        let Some(replay_key) = request.get_annotation_value(OUTPUT_REPLAY_ID_ANNOTATION_KEY) else {
            return;
        };
        let consumes_replay = self
            .kv_router()
            .workers_with_configs
            .borrow()
            .get(&selection.worker.worker_id)
            .and_then(|config| {
                config
                    .get_engine_specific::<bool>(OUTPUT_REPLAY_CONSUMER_RUNTIME_KEY)
                    .ok()
                    .flatten()
            })
            .unwrap_or(false);
        if consumes_replay {
            return;
        }

        tracing::warn!(
            replay_key,
            worker_id = selection.worker.worker_id,
            dp_rank = selection.worker.dp_rank,
            "request has output token replay annotation but selected worker has not declared replay-token consumption"
        );
    }

    pub(super) async fn select_and_dispatch_kv_prefill<M, F>(
        &self,
        mut request: SingleIn<PreprocessedRequest>,
        prepare: F,
    ) -> Result<(M, ManyOut<Annotated<LLMEngineOutput>>), Error>
    where
        F: FnOnce(&mut PreprocessedRequest, AffinityTarget) -> Result<M, Error>,
    {
        let budget = CleanupBudget::default();
        let phase = RequestPhase::Prefill;
        let phase_label = phase.to_string();
        let route_guard = StageGuard::new(STAGE_ROUTE, &phase_label);
        let is_query_only = request.get_annotation_value("query_instance_id").is_some();
        let (mut selection, mut operation) = self
            .select_with_affinity(&request, phase, is_query_only, &budget)
            .await?;
        let mut guard = match self
            .track_selection(&request, &mut selection, phase, is_query_only, &budget)
            .await
        {
            Ok(guard) => guard,
            Err(error) => return Err(error),
        };
        let selected_target = route_target(selection.worker);
        let metadata = match prepare(&mut request, selected_target) {
            Ok(metadata) => metadata,
            Err(error) => {
                guard.abort().await;
                return Err(error);
            }
        };
        drop(route_guard);
        let stream = match self
            .dispatch_selection(request, selection, guard, &budget)
            .await
        {
            Ok(stream) => stream,
            Err(error) => {
                if self.session_affinity_mode == SessionAffinityMode::Hard
                    && !self.affinity_target_is_valid(selected_target)
                    && let Some(operation) = operation.take()
                {
                    operation.invalidate();
                }
                return Err(error);
            }
        };
        let Some(operation) = operation else {
            return Ok((metadata, stream));
        };
        Ok((
            metadata,
            operation.into_stream(selected_target, stream, self.session_affinity_mode)?,
        ))
    }
}