"plugins/vscode:/vscode.git/clone" did not exist on "c7aa1d009146f2592ab56c13293235f2a8403e1b"
lib.rs 42 KB
Newer Older
1
// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
3
// SPDX-License-Identifier: Apache-2.0

4
use dynamo_llm::local_model::LocalModel;
5
use dynamo_runtime::distributed::{DiscoveryBackend, DistributedConfig, RequestPlaneMode};
6
use dynamo_runtime::storage::kv;
7
8
use futures::StreamExt;
use once_cell::sync::OnceCell;
9
use pyo3::IntoPyObjectExt;
10
use pyo3::exceptions::PyStopAsyncIteration;
Richard Huo's avatar
Richard Huo committed
11
use pyo3::types::PyCapsule;
12
use pyo3::types::{PyDict, PyString};
13
14
use pyo3::{exceptions::PyException, prelude::*};
use rs::pipeline::network::Ingress;
Richard Huo's avatar
Richard Huo committed
15
use std::ffi::CString;
16
use std::fs;
17
use std::path::PathBuf;
Richard Huo's avatar
Richard Huo committed
18
19
20
21
use std::{
    fmt::Display,
    sync::{Arc, Weak},
};
22
use tokio::sync::Mutex;
23
use tracing::Instrument;
24

25
use dynamo_runtime::config;
26
use dynamo_runtime::config::environment_names::logging::otlp as env_otlp;
Neelay Shah's avatar
Neelay Shah committed
27
use dynamo_runtime::{
Ryan Olson's avatar
Ryan Olson committed
28
    self as rs, logging,
29
    pipeline::{
30
        AsyncEngineContextProvider, EngineStream, ManyOut, SingleIn, context::Context as RsContext,
31
        network::egress::push_router::RouterMode as RsRouterMode,
32
    },
33
    protocols::annotated::Annotated as RsAnnotated,
34
    traits::DistributedRuntimeProvider,
35
36
};

Neelay Shah's avatar
Neelay Shah committed
37
use dynamo_llm::{self as llm_rs};
38
39
use dynamo_llm::{entrypoint::RouterConfig, kv_router::KvRouterConfig};

40
use crate::llm::local_model::ModelRuntimeConfig;
41
use crate::llm::preprocessor::{MediaDecoder, MediaFetcher};
42

43
44
45
46
47
48
#[pyclass(eq, eq_int)]
#[derive(Clone, Debug, PartialEq)]
pub enum RouterMode {
    RoundRobin,
    Random,
    KV,
49
50
51
    /// Direct routing - reads worker ID from each request's routing hints.
    /// Used when an external orchestrator (e.g., EPP) handles worker selection.
    Direct,
52
53
54
55
56
57
58
59
}

impl From<RouterMode> for RsRouterMode {
    fn from(mode: RouterMode) -> Self {
        match mode {
            RouterMode::RoundRobin => Self::RoundRobin,
            RouterMode::Random => Self::Random,
            RouterMode::KV => Self::KV,
60
            RouterMode::Direct => Self::Direct,
61
62
63
        }
    }
}
64

65
mod context;
66
mod engine;
67
mod http;
68
mod kserve_grpc;
69
mod llm;
70
mod parsers;
71
mod planner;
72
mod prometheus_metrics;
73
74
75
76
77
78
79
80

type JsonServerStreamingIngress =
    Ingress<SingleIn<serde_json::Value>, ManyOut<RsAnnotated<serde_json::Value>>>;

static INIT: OnceCell<()> = OnceCell::new();

const DEFAULT_ANNOTATED_SETTING: Option<bool> = Some(true);

81
82
// Helper to get appropriate span for instrumentation - always emit spans
fn get_span_for_context(context: &context::Context, operation: &str) -> tracing::Span {
83
84
85
86
87
88
    logging::make_client_request_span(
        operation,
        context.inner().id(),
        context.trace_context(),
        None,
    )
89
90
91
92
93
94
95
96
}

// Helper to create span for direct method with instance_id
fn get_span_for_direct_context(
    context: &context::Context,
    operation: &str,
    instance_id: &str,
) -> tracing::Span {
97
98
99
100
101
102
    logging::make_client_request_span(
        operation,
        context.inner().id(),
        context.trace_context(),
        Some(instance_id),
    )
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
// Helper to create request context with proper linking and cancellation handling
fn create_request_context(
    request: serde_json::Value,
    parent_ctx: &Option<context::Context>,
) -> RsContext<serde_json::Value> {
    match parent_ctx {
        // If there is a parent context, link the request as a child context of it
        Some(parent_ctx) => {
            let child_ctx = RsContext::with_id(request, parent_ctx.inner().id().to_string());
            parent_ctx.inner().link_child(child_ctx.context());
            if parent_ctx.inner().is_stopped() || parent_ctx.inner().is_killed() {
                // Let the server handle the cancellation for now since not all backends are
                // properly handling request exceptions
                // TODO: (DIS-830) Return an error if context is cancelled
                child_ctx.context().stop_generating();
            }
            child_ctx
        }
        // Otherwise if there is no parent context, use the request as-is
        _ => request.into(),
    }
}

128
129
130
131
132
/// A Python module implemented in Rust. The name of this function must match
/// the `lib.name` setting in the `Cargo.toml`, else Python will not be able to
/// import the module.
#[pymodule]
fn _core(m: &Bound<'_, PyModule>) -> PyResult<()> {
133
    // Initialize logging early unless OTEL export is enabled (which requires tokio runtime)
134
    if config::env_is_truthy(env_otlp::OTEL_EXPORT_ENABLED) {
135
        eprintln!(
136
            "Warning: OTEL_EXPORT_ENABLED detected. Logging initialization deferred until runtime is available. Early logs may be dropped."
137
138
139
140
141
        );
    } else {
        rs::logging::init();
    }

Yan Ru Pei's avatar
Yan Ru Pei committed
142
    m.add_function(wrap_pyfunction!(llm::kv::compute_block_hash_for_seq_py, m)?)?;
143
    m.add_function(wrap_pyfunction!(lora_name_to_id, m)?)?;
Ryan Olson's avatar
Ryan Olson committed
144
    m.add_function(wrap_pyfunction!(log_message, m)?)?;
145
    m.add_function(wrap_pyfunction!(register_llm, m)?)?;
146
    m.add_function(wrap_pyfunction!(unregister_llm, m)?)?;
147
    m.add_function(wrap_pyfunction!(fetch_llm, m)?)?;
148
149
    m.add_function(wrap_pyfunction!(llm::entrypoint::make_engine, m)?)?;
    m.add_function(wrap_pyfunction!(llm::entrypoint::run_input, m)?)?;
150

151
152
153
154
155
    m.add_class::<DistributedRuntime>()?;
    m.add_class::<CancellationToken>()?;
    m.add_class::<Namespace>()?;
    m.add_class::<Component>()?;
    m.add_class::<Endpoint>()?;
156
    m.add_class::<ModelCardInstanceId>()?;
157
158
    m.add_class::<Client>()?;
    m.add_class::<AsyncResponseStream>()?;
159
160
161
    m.add_class::<llm::entrypoint::EntrypointArgs>()?;
    m.add_class::<llm::entrypoint::EngineConfig>()?;
    m.add_class::<llm::entrypoint::EngineType>()?;
162
163
    m.add_class::<llm::entrypoint::RouterConfig>()?;
    m.add_class::<llm::entrypoint::KvRouterConfig>()?;
164
    m.add_class::<llm::kv::WorkerMetricsPublisher>()?;
165
    m.add_class::<llm::model_card::ModelDeploymentCard>()?;
166
    m.add_class::<llm::local_model::ModelRuntimeConfig>()?;
167
168
    m.add_class::<llm::preprocessor::MediaDecoder>()?;
    m.add_class::<llm::preprocessor::MediaFetcher>()?;
169
    m.add_class::<llm::kv::OverlapScores>()?;
170
    m.add_class::<llm::kv::KvEventPublisher>()?;
Yan Ru Pei's avatar
Yan Ru Pei committed
171
172
    m.add_class::<llm::kv::RadixTree>()?;
    m.add_class::<llm::kv::ZmqKvEventListener>()?;
173
    m.add_class::<llm::lora::LoRADownloader>()?;
174
175
    m.add_class::<http::HttpService>()?;
    m.add_class::<http::HttpAsyncEngine>()?;
176
    m.add_class::<context::Context>()?;
177
    m.add_class::<ModelType>()?;
178
    m.add_class::<ModelInput>()?;
179
    m.add_class::<llm::kv::KvRouter>()?;
180
    m.add_class::<RouterMode>()?;
181
    m.add_class::<kserve_grpc::KserveGrpcService>()?;
182
    m.add("__version__", env!("CARGO_PKG_VERSION"))?;
183
184
185
    m.add_class::<planner::VirtualConnectorCoordinator>()?;
    m.add_class::<planner::VirtualConnectorClient>()?;
    m.add_class::<planner::PlannerDecision>()?;
186
187

    engine::add_to_module(m)?;
188
    parsers::add_to_module(m)?;
189

190
    m.add_class::<prometheus_metrics::RuntimeMetrics>()?;
191
192
193
194
    let prometheus_metrics = PyModule::new(m.py(), "prometheus_metrics")?;
    prometheus_metrics::add_to_module(&prometheus_metrics)?;
    m.add_submodule(&prometheus_metrics)?;

195
196
197
198
199
200
201
202
203
204
    Ok(())
}

pub fn to_pyerr<E>(err: E) -> PyErr
where
    E: Display,
{
    PyException::new_err(format!("{}", err))
}

Ryan Olson's avatar
Ryan Olson committed
205
206
207
208
209
210
211
/// Log a message from Python with file and line info
#[pyfunction]
#[pyo3(text_signature = "(level, message, module, file, line)")]
fn log_message(level: &str, message: &str, module: &str, file: &str, line: u32) {
    logging::log_message(level, message, module, file, line);
}

212
213
214
215
216
217
218
/// Generate a deterministic signed int32 ID from a LoRA name using blake3 hash.
#[pyfunction]
#[pyo3(text_signature = "(lora_name)")]
fn lora_name_to_id(lora_name: &str) -> i32 {
    llm_rs::utils::lora_name_to_id(lora_name)
}

219
220
/// Create an engine and attach it to an endpoint to make it visible to the frontend.
/// This is the main way you create a Dynamo worker / backend.
221
222
223
224
225
226
227
///
/// If `lora_name` is provided, this function will publish a LoRA adapter instead of a base model:
/// - LoRA path: v1/mdc/{namespace}/{component}/{endpoint}/{instance_id}/{lora_slug}
/// - Base model path: v1/mdc/{namespace}/{component}/{endpoint}/{instance_id}
///
/// For LoRA mode, both `lora_name` and `base_model_path` must be provided together.
/// Providing only one of them will result in an error.
228
#[pyfunction]
229
#[pyo3(signature = (model_input, model_type, endpoint, model_path, model_name=None, context_length=None, kv_cache_block_size=None, router_mode=None, runtime_config=None, user_data=None, custom_template_path=None, media_decoder=None, media_fetcher=None, lora_name=None, base_model_path=None))]
230
#[allow(clippy::too_many_arguments)]
231
232
fn register_llm<'p>(
    py: Python<'p>,
233
    model_input: ModelInput,
234
    model_type: ModelType,
235
236
237
    endpoint: Endpoint,
    model_path: &str,
    model_name: Option<&str>,
238
239
    context_length: Option<u32>,
    kv_cache_block_size: Option<u32>,
240
    router_mode: Option<RouterMode>,
241
    runtime_config: Option<ModelRuntimeConfig>,
242
    user_data: Option<&Bound<'p, PyDict>>,
243
    custom_template_path: Option<&str>,
244
245
    media_decoder: Option<MediaDecoder>,
    media_fetcher: Option<MediaFetcher>,
246
247
    lora_name: Option<&str>,
    base_model_path: Option<&str>,
248
) -> PyResult<Bound<'p, PyAny>> {
249
    // Validate Prefill model type requirements
250
251
252
253
254
255
    if model_type.inner == llm_rs::model_type::ModelType::Prefill
        && !matches!(model_input, ModelInput::Tokens)
    {
        return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
            "ModelType::Prefill requires model_input to be ModelInput::Tokens",
        ));
256
257
    }

258
259
260
    let model_input = match model_input {
        ModelInput::Text => llm_rs::model_type::ModelInput::Text,
        ModelInput::Tokens => llm_rs::model_type::ModelInput::Tokens,
261
        ModelInput::Tensor => llm_rs::model_type::ModelInput::Tensor,
262
263
    };

264
    let is_tensor_based = model_type.inner.supports_tensor();
265
    let is_images = model_type.inner.supports_images();
266
    let is_videos = model_type.inner.supports_videos();
267

268
269
    let model_type_obj = model_type.inner;

270
    let inner_path = model_path.to_string();
271
    let model_name = model_name.map(|n| n.to_string());
272
273
274
    let router_mode = router_mode.unwrap_or(RouterMode::RoundRobin);
    let router_config = RouterConfig::new(router_mode.into(), KvRouterConfig::default());

275
276
277
278
279
280
281
282
283
284
285
286
287
    // Early validation of custom template path
    let custom_template_path_owned = custom_template_path
        .map(|s| {
            let path = PathBuf::from(s);
            if !path.exists() {
                return Err(PyErr::new::<pyo3::exceptions::PyFileNotFoundError, _>(
                    format!("Custom template file does not exist: {}", path.display()),
                ));
            }
            Ok(path)
        })
        .transpose()?;

288
289
290
291
292
293
294
    let user_data_json = user_data
        .map(|dict| pythonize::depythonize(dict))
        .transpose()
        .map_err(|err| {
            PyErr::new::<PyException, _>(format!("Failed to convert user_data: {}", err))
        })?;

295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
    // Validate LoRA parameters: both or neither must be provided
    if lora_name.is_some() ^ base_model_path.is_some() {
        return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
            "lora_name and base_model_path must both be provided together, or neither",
        ));
    }

    // Determine source_path and lora_identifier based on registration mode
    let (source_path, lora_identifier) = match (lora_name, base_model_path) {
        (Some(lora), Some(base)) => (base.to_string(), Some(lora.to_string())),
        _ => (inner_path, None),
    };

    // Model name: use lora name if present, otherwise provided name or default to source path
    let model_name = lora_identifier
        .clone()
        .or(model_name)
        .or_else(|| Some(source_path.clone()));

314
    pyo3_async_runtimes::tokio::future_into_py(py, async move {
315
316
317
        // For TensorBased, Images, and Videos models, skip HuggingFace downloads and register directly
        // These model types handle model loading internally, no tokenizer extraction needed
        if is_tensor_based || is_images || is_videos {
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
            let model_name = model_name.unwrap_or_else(|| source_path.clone());
            let mut card = llm_rs::model_card::ModelDeploymentCard::with_name_only(&model_name);
            card.model_type = model_type_obj;
            card.model_input = model_input;
            card.user_data = user_data_json;

            if let Some(cfg) = runtime_config {
                card.runtime_config = cfg.inner;
            }

            // Register the Model Deployment Card via discovery interface
            let discovery = endpoint.inner.drt().discovery();
            let spec = rs::discovery::DiscoverySpec::from_model(
                endpoint.inner.component().namespace().name().to_string(),
                endpoint.inner.component().name().to_string(),
                endpoint.inner.name().to_string(),
                &card,
            )
            .map_err(to_pyerr)?;
            discovery.register(spec).await.map_err(to_pyerr)?;

            return Ok(());
        }

        // For non-TensorBased models, resolve the model path (local or fetch from HuggingFace)
343
344
        let model_path = if fs::exists(&source_path)? {
            PathBuf::from(&source_path)
345
        } else {
346
            LocalModel::fetch(&source_path, false)
347
348
349
350
                .await
                .map_err(to_pyerr)?
        };

351
352
        let mut builder = dynamo_llm::local_model::LocalModelBuilder::default();
        builder
353
            // model path is the physical path on disk of the downloaded model
354
            .model_path(model_path)
355
356
357
358
            // source path is what the user gave as `--model-path`, either a real path (in which
            // case it matches model_path above), or an HF repo.
            .source_path(source_path.clone().into())
            // --served_model_name
359
            .model_name(model_name.clone())
360
            .context_length(context_length)
361
            .kv_cache_block_size(kv_cache_block_size)
362
            .router_config(Some(router_config))
363
            .runtime_config(runtime_config.unwrap_or_default().inner)
364
            .user_data(user_data_json)
365
366
367
            .custom_template_path(custom_template_path_owned)
            .media_decoder(media_decoder.map(|m| m.inner))
            .media_fetcher(media_fetcher.map(|m| m.inner));
368

369
        let mut local_model = builder.build().await.map_err(to_pyerr)?;
370
371
372
373
374
375
376
377
378

        // Convert lora_identifier (Option<String>) to Option<LoraInfo>
        let lora_info = lora_identifier
            .as_ref()
            .map(|name| llm_rs::model_card::LoraInfo {
                name: name.clone(),
                max_gpu_lora_count: None,
            });

379
        local_model
380
            .attach(&endpoint.inner, model_type_obj, model_input, lora_info)
381
382
383
            .await
            .map_err(to_pyerr)?;

384
385
386
        if let Some(lora_name) = lora_identifier {
            tracing::info!("Registered LoRA '{}' MDC", lora_name);
        } else {
387
388
389
390
            tracing::info!(
                "Registered base model '{}' MDC",
                model_name.unwrap_or(source_path)
            );
391
392
        }

393
394
395
396
        Ok(())
    })
}

397
398
399
400
401
402
403
404
405
406
407
408
409
/// Unregister a Model Deployment Card (MDC) from the service registry
///
/// This removes an LLM deployment from the discovery system.
///
/// # Arguments
///
/// * `endpoint` - The endpoint where the model is registered
/// * `lora_name` - Optional LoRA adapter name (if unregistering a LoRA deployment)
///
/// # MDC Path Format
///
/// - Base model: `v1/mdc/{namespace}/{component}/{endpoint}/{instance_id}`
/// - LoRA model: `v1/mdc/{namespace}/{component}/{endpoint}/{instance_id}/{lora_slug}`
410
#[pyfunction]
411
412
413
414
415
416
417
418
#[pyo3(signature = (endpoint, lora_name=None))]
fn unregister_llm<'p>(
    py: Python<'p>,
    endpoint: Endpoint,
    lora_name: Option<&str>,
) -> PyResult<Bound<'p, PyAny>> {
    let lora_name_owned = lora_name.map(|s| s.to_string());

419
    pyo3_async_runtimes::tokio::future_into_py(py, async move {
420
421
        // Unified detach method handles both base models and LoRA adapters
        LocalModel::detach_from_endpoint(&endpoint.inner, lora_name_owned.as_deref())
422
423
424
425
426
427
            .await
            .map_err(to_pyerr)?;
        Ok(())
    })
}

428
429
430
/// Download a model from Hugging Face, returning it's local path
/// Example: `model_path = await fetch_llm("Qwen/Qwen3-0.6B")`
#[pyfunction]
431
432
433
434
435
436
#[pyo3(signature = (remote_name, ignore_weights=false))]
fn fetch_llm<'p>(
    py: Python<'p>,
    remote_name: &str,
    ignore_weights: bool,
) -> PyResult<Bound<'p, PyAny>> {
437
438
    let repo = remote_name.to_string();
    pyo3_async_runtimes::tokio::future_into_py(py, async move {
439
440
441
        LocalModel::fetch(&repo, ignore_weights)
            .await
            .map_err(to_pyerr)
442
443
444
    })
}

445
446
#[pyclass]
#[derive(Clone)]
Ryan Olson's avatar
Ryan Olson committed
447
pub struct DistributedRuntime {
448
449
450
451
    inner: rs::DistributedRuntime,
    event_loop: PyObject,
}

Ryan Olson's avatar
Ryan Olson committed
452
453
impl DistributedRuntime {
    #[allow(dead_code)]
454
    pub(crate) fn inner(&self) -> &rs::DistributedRuntime {
Ryan Olson's avatar
Ryan Olson committed
455
456
457
458
        &self.inner
    }
}

459
#[pyclass]
460
#[derive(Clone)]
461
462
463
464
465
struct CancellationToken {
    inner: rs::CancellationToken,
}

#[pyclass]
466
#[derive(Clone)]
467
468
469
470
471
472
struct Namespace {
    inner: rs::component::Namespace,
    event_loop: PyObject,
}

#[pyclass]
473
#[derive(Clone)]
474
475
476
477
478
479
struct Component {
    inner: rs::component::Component,
    event_loop: PyObject,
}

#[pyclass]
480
#[derive(Clone)]
481
482
483
484
485
struct Endpoint {
    inner: rs::component::Endpoint,
    event_loop: PyObject,
}

486
487
488
489
490
491
#[pyclass]
#[derive(Clone)]
struct ModelCardInstanceId {
    inner: rs::discovery::ModelCardInstanceId,
}

492
#[pyclass]
493
#[derive(Clone)]
494
struct Client {
495
    router: rs::pipeline::PushRouter<serde_json::Value, RsAnnotated<serde_json::Value>>,
496
497
}

498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
#[pyclass]
#[derive(Clone, PartialEq)]
struct ModelType {
    inner: llm_rs::model_type::ModelType,
}

#[pymethods]
#[allow(non_upper_case_globals)]
impl ModelType {
    #[classattr]
    const Chat: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Chat,
    };
    #[classattr]
    const Completions: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Completions,
    };
    #[classattr]
    const Embedding: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Embedding,
    };
519
520
521
522
    #[classattr]
    const TensorBased: Self = ModelType {
        inner: llm_rs::model_type::ModelType::TensorBased,
    };
523
524
525
526
    #[classattr]
    const Prefill: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Prefill,
    };
527
528
529
530
    #[classattr]
    const Images: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Images,
    };
531
532
533
534
    #[classattr]
    const Videos: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Videos,
    };
535

536
537
538
539
    fn supports_chat(&self) -> bool {
        self.inner.supports_chat()
    }

540
541
542
543
544
545
546
547
548
549
550
    fn __or__(&self, other: &Self) -> Self {
        ModelType {
            inner: self.inner | other.inner,
        }
    }

    fn __str__(&self) -> String {
        self.inner.to_string()
    }
}

551
552
#[pyclass(eq, eq_int)]
#[derive(Clone, PartialEq)]
553
554
555
enum ModelInput {
    Text = 1,
    Tokens = 2,
556
    Tensor = 3,
557
558
}

559
560
561
#[pymethods]
impl DistributedRuntime {
    #[new]
562
    #[pyo3(signature = (event_loop, discovery_backend, request_plane, enable_nats=None))]
563
564
    fn new(
        event_loop: PyObject,
565
        discovery_backend: String,
566
567
568
        request_plane: String,
        enable_nats: Option<bool>,
    ) -> PyResult<Self> {
569
570
571
572
573
574
575
        let discovery_backend_config = match discovery_backend.as_str() {
            "kubernetes" => DiscoveryBackend::Kubernetes,
            other => {
                let selector: kv::Selector = other.parse().map_err(to_pyerr)?;
                DiscoveryBackend::KvStore(selector)
            }
        };
576
        let request_plane: RequestPlaneMode = request_plane.parse().map_err(to_pyerr)?;
577

578
579
580
        // Try to get existing runtime first, create new Worker only if needed
        // This allows multiple DistributedRuntime instances to share the same tokio runtime
        let runtime = rs::Worker::runtime_from_existing()
581
            .or_else(|_| -> anyhow::Result<rs::Runtime> {
582
583
584
585
                // No existing Worker, create new one
                let worker = rs::Worker::from_settings()?;

                // Initialize pyo3 bridge (only happens once per process)
586
                INIT.get_or_try_init(|| -> anyhow::Result<()> {
587
588
                    let primary = worker.tokio_runtime()?;
                    pyo3_async_runtimes::tokio::init_with_runtime(primary).map_err(|e| {
589
                        anyhow::anyhow!("failed to initialize pyo3 static runtime: {:?}", e)
590
                    })?;
591
                    Ok(())
592
593
                })?;

594
                Ok(worker.runtime().clone())
595
596
            })
            .map_err(to_pyerr)?;
597

598
599
        // Initialize logging in context where tokio runtime is available
        // otel exporter requires it
600
        if config::env_is_truthy(env_otlp::OTEL_EXPORT_ENABLED) {
601
602
603
604
            runtime.secondary().block_on(async {
                rs::logging::init();
            });
        }
605

606
607
608
609
610
611
612
613
614
615
        // NATS is used for more than just the NATS request-plane:
        // - KV router events (JetStream or NATS core + local indexer)
        // - inter-router replica sync (NATS core)
        //
        // NATS initialization logic:
        // 1. If request_plane is NATS, always enable NATS
        // 2. Otherwise, use enable_nats parameter (defaults to true for backward compat)
        //    Pass false to disable NATS (e.g., for approximate KV routing mode)
        let enable_nats = enable_nats.unwrap_or(true); // Default to true

616
        let runtime_config = DistributedConfig {
617
            discovery_backend: discovery_backend_config,
618
            nats_config: if request_plane.is_nats() || enable_nats {
619
620
621
622
                Some(dynamo_runtime::transports::nats::ClientOptions::default())
            } else {
                None
            },
623
            request_plane,
624
625
626
627
628
        };
        let inner = runtime
            .secondary()
            .block_on(rs::DistributedRuntime::new(runtime, runtime_config))
            .map_err(to_pyerr)?;
629
630
631
632

        Ok(DistributedRuntime { inner, event_loop })
    }

Ryan Olson's avatar
Ryan Olson committed
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
    #[staticmethod]
    fn detached(py: Python) -> PyResult<Self> {
        let rt = rs::Worker::runtime_from_existing().map_err(to_pyerr)?;
        let handle = rt.primary();

        let inner = handle
            .block_on(rs::DistributedRuntime::from_settings(rt))
            .map_err(to_pyerr)?;

        Ok(DistributedRuntime {
            inner,
            event_loop: py.None(),
        })
    }

648
649
650
651
652
653
654
655
    fn namespace(&self, name: String) -> PyResult<Namespace> {
        Ok(Namespace {
            inner: self.inner.namespace(name).map_err(to_pyerr)?,
            event_loop: self.event_loop.clone(),
        })
    }

    fn shutdown(&self) {
656
        self.inner.shutdown();
657
658
659
660
661
    }

    fn event_loop(&self) -> PyObject {
        self.event_loop.clone()
    }
662
663
664
665
666

    fn child_token(&self) -> CancellationToken {
        let inner = self.inner.runtime().child_token();
        CancellationToken { inner }
    }
Richard Huo's avatar
Richard Huo committed
667

668
669
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
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
    /// Register an async Python callback for /engine/{route_name}
    ///
    /// Args:
    ///     route_name: Route path (e.g., "start_profile" → /engine/start_profile)
    ///     callback: Async function with signature: async def(body: dict) -> dict
    ///
    /// Example:
    /// ```python
    /// async def start_profile(body: dict) -> dict:
    ///     await engine.start_profile(**body)
    ///     return {"status": "ok"}
    ///
    /// runtime.register_engine_route("start_profile", start_profile)
    /// ```
    #[pyo3(signature = (route_name, callback))]
    fn register_engine_route(
        &self,
        py: Python<'_>,
        route_name: String,
        callback: PyObject,
    ) -> PyResult<()> {
        // Capture TaskLocals at registration time when Python's event loop is running.
        // This is needed because later, when the callback is invoked from an HTTP request,
        // we'll be on a Rust thread without a running Python event loop.
        let locals =
            Arc::new(pyo3_async_runtimes::tokio::get_current_locals(py).map_err(to_pyerr)?);
        let callback = Arc::new(callback);

        // Wrap Python async callback in Rust async closure
        let rust_callback: rs::engine_routes::EngineRouteCallback =
            Arc::new(move |body: serde_json::Value| {
                let callback = callback.clone();
                let locals = locals.clone();

                // Return a boxed future
                Box::pin(async move {
                    // Acquire GIL to call Python callback and convert coroutine to future
                    let py_future = Python::with_gil(|py| {
                        // Convert body to Python dict
                        let py_body = pythonize::pythonize(py, &body).map_err(|e| {
                            anyhow::anyhow!("Failed to convert request body to Python: {}", e)
                        })?;

                        // Call Python async function to get a coroutine
                        let coroutine = callback.call1(py, (py_body,)).map_err(|e| {
                            anyhow::anyhow!("Failed to call Python callback: {}", e)
                        })?;

                        // Use the TaskLocals captured at registration time
                        pyo3_async_runtimes::into_future_with_locals(
                            &locals,
                            coroutine.into_bound(py),
                        )
                        .map_err(|e| {
                            anyhow::anyhow!("Failed to convert coroutine to future: {}", e)
                        })
                    })?;

                    // Await the Python coroutine (GIL is released during await)
                    let py_result = py_future
                        .await
                        .map_err(|e| anyhow::anyhow!("Python callback failed: {}", e))?;

                    // Convert result back to serde_json::Value
                    Python::with_gil(|py| {
                        pythonize::depythonize::<serde_json::Value>(py_result.bind(py))
                            .map_err(|e| anyhow::anyhow!("Failed to serialize response: {}", e))
                    })
                })
            });

        self.inner
            .engine_routes()
            .register(&route_name, rust_callback);
        tracing::debug!("Registered engine route: /engine/{}", route_name);
        Ok(())
    }

Richard Huo's avatar
Richard Huo committed
746
747
748
749
750
751
752
753
754
755
756
757
758
759
    // This is used to pass the DistributedRuntime from the dynamo-runtime bindings
    // to the KVBM bindings, since KVBM cannot directly use the struct from this cdylib.
    // TODO: Create a separate crate "dynamo-python" so that all binding crates can import
    // from it and share the same crate path. This will allow PyO3 to automatically
    // recognize that both bindings use the same PyClass.
    #[pyo3(name = "to_capsule")]
    fn to_capsule<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyCapsule>> {
        let arc: Arc<rs::DistributedRuntime> = Arc::new(self.inner.clone());
        let weak: Weak<rs::DistributedRuntime> = Arc::downgrade(&arc);

        let name = CString::new("dynamo.runtime.weak").expect("valid capsule name");

        PyCapsule::new(py, weak, Some(name))
    }
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
}

#[pymethods]
impl CancellationToken {
    fn cancel(&self) {
        self.inner.cancel();
    }

    fn cancelled<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
        let token = self.inner.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            token.cancelled().await;
            Ok(())
        })
    }
}

#[pymethods]
impl Component {
    fn endpoint(&self, name: String) -> PyResult<Endpoint> {
        let inner = self.inner.endpoint(name);
        Ok(Endpoint {
            inner,
            event_loop: self.event_loop.clone(),
        })
    }
}

#[pymethods]
impl Endpoint {
790
    #[pyo3(signature = (generator, graceful_shutdown = true, metrics_labels = None, health_check_payload = None))]
791
792
793
794
    fn serve_endpoint<'p>(
        &self,
        py: Python<'p>,
        generator: PyObject,
795
        graceful_shutdown: Option<bool>,
796
        metrics_labels: Option<Vec<(String, String)>>,
797
        health_check_payload: Option<&Bound<'p, PyDict>>,
798
799
800
801
802
    ) -> PyResult<Bound<'p, PyAny>> {
        let engine = Arc::new(engine::PythonAsyncEngine::new(
            generator,
            self.event_loop.clone(),
        )?);
803
        let ingress = JsonServerStreamingIngress::for_engine(engine.clone()).map_err(to_pyerr)?;
804
805
806
807
808
809
810
811
812
813
814
815
816

        // Convert Python dict to serde_json::Value if provided and validate it's an object
        let health_payload_json = health_check_payload
            .map(|dict| pythonize::depythonize::<serde_json::Value>(dict))
            .transpose()
            .map_err(|err| {
                pyo3::exceptions::PyTypeError::new_err(format!(
                    "Failed to convert health_check_payload: {}",
                    err
                ))
            })?;

        // Require an object/dict
817
818
819
820
821
822
        if let Some(ref payload) = health_payload_json
            && !payload.is_object()
        {
            return Err(pyo3::exceptions::PyTypeError::new_err(
                "health_check_payload must be a JSON object (dict)",
            ));
823
824
825
        }

        let mut builder = self
826
827
828
829
            .inner
            .endpoint_builder()
            .metrics_labels(metrics_labels)
            .handler(ingress);
830
831
832
833
834

        if let Some(payload) = health_payload_json {
            builder = builder.health_check_payload(payload);
        }

835
836
837
        // Register the engine in the local endpoint registry for in-process calls
        builder = builder.register_local_engine(engine).map_err(to_pyerr)?;

838
        let graceful_shutdown = graceful_shutdown.unwrap_or(true);
839
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
840
841
842
843
844
            builder
                .graceful_shutdown(graceful_shutdown)
                .start()
                .await
                .map_err(to_pyerr)?;
845
846
847
848
            Ok(())
        })
    }

849
850
851
852
853
854
855
    #[pyo3(signature = (router_mode = None))]
    fn client<'p>(
        &self,
        py: Python<'p>,
        router_mode: Option<RouterMode>,
    ) -> PyResult<Bound<'p, PyAny>> {
        let router_mode = router_mode.unwrap_or(RouterMode::RoundRobin);
856
857
        let inner = self.inner.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
858
            let client = inner.client().await.map_err(to_pyerr)?;
859
860
861
            let push_router = rs::pipeline::PushRouter::<
                serde_json::Value,
                RsAnnotated<serde_json::Value>,
862
            >::from_client(client, router_mode.into())
863
864
            .await
            .map_err(to_pyerr)?;
865
866
867
            Ok(Client {
                router: push_router,
            })
868
869
        })
    }
870

871
872
873
    // Opaque unique ID for this worker. May change over worker lifetime.
    fn connection_id(&self) -> u64 {
        self.inner.drt().connection_id()
874
    }
875
876
877

    /// Get a RuntimeMetrics helper for creating Prometheus metrics
    #[getter]
878
879
    fn metrics(&self) -> prometheus_metrics::RuntimeMetrics {
        prometheus_metrics::RuntimeMetrics::from_endpoint(self.inner.clone())
880
    }
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909

    /// Unregister this endpoint instance from discovery.
    ///
    /// This removes the endpoint from the instances bucket, preventing the router
    /// from sending requests to this worker. Use this when a worker is sleeping
    /// and should not receive any requests.
    fn unregister_endpoint_instance<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
        let inner = self.inner.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            inner
                .unregister_endpoint_instance()
                .await
                .map_err(to_pyerr)?;
            Ok(())
        })
    }

    /// Re-register this endpoint instance to discovery.
    ///
    /// This adds the endpoint back to the instances bucket, allowing the router
    /// to send requests to this worker again. Use this when a worker wakes up
    /// and should start receiving requests.
    fn register_endpoint_instance<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
        let inner = self.inner.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            inner.register_endpoint_instance().await.map_err(to_pyerr)?;
            Ok(())
        })
    }
910
911
912
913
914
915
916
917
918
919
920
921
922
}

#[pymethods]
impl Namespace {
    fn component(&self, name: String) -> PyResult<Component> {
        let inner = self.inner.component(name).map_err(to_pyerr)?;
        Ok(Component {
            inner,
            event_loop: self.event_loop.clone(),
        })
    }
}

923
924
925
926
927
928
929
930
931
932
933
934
935
#[pymethods]
impl ModelCardInstanceId {
    // (namespace, component, endpoint)
    // TODO: Can these be borrowed as &str?
    fn triple(&self) -> (String, String, String) {
        (
            self.inner.namespace.clone(),
            self.inner.component.clone(),
            self.inner.endpoint.clone(),
        )
    }
}

936
937
#[pymethods]
impl Client {
938
939
    /// Get list of current instances.
    /// Replaces endpoint_ids.
940
    fn instance_ids(&self) -> Vec<u64> {
941
        self.router.client.instance_ids()
942
943
    }

944
945
946
    /// Wait for an instance to be available for work.
    /// Replaces wait_for_endpoints.
    fn wait_for_instances<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
947
        let inner = self.router.client.clone();
948
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
949
            inner
950
                .wait_for_instances()
951
                .await
952
                .map(|v| v.into_iter().map(|cei| cei.id()).collect::<Vec<u64>>())
953
                .map_err(to_pyerr)
954
955
956
957
        })
    }

    /// Issue a request to the endpoint using the default routing strategy.
958
    #[pyo3(signature = (request, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
959
960
961
962
963
    fn generate<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
        annotated: Option<bool>,
964
        context: Option<context::Context>,
965
    ) -> PyResult<Bound<'p, PyAny>> {
966
        self.random(py, request, annotated, context)
967
968
969
    }

    /// Send a request to the next endpoint in a round-robin fashion.
970
    #[pyo3(signature = (request, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
971
972
973
974
975
    fn round_robin<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
        annotated: Option<bool>,
976
        context: Option<context::Context>,
977
978
    ) -> PyResult<Bound<'p, PyAny>> {
        let request: serde_json::Value = pythonize::depythonize(&request.into_bound(py))?;
979
        let request_ctx = create_request_context(request, &context);
980
981
982
        let annotated = annotated.unwrap_or(false);

        let (tx, rx) = tokio::sync::mpsc::channel(32);
983
        let client = self.router.clone();
984
985

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
986
987
            let stream = match context {
                Some(context) => {
988
989
                    // Always instrument with appropriate span (none if no trace context)
                    let span = get_span_for_context(&context, "round_robin");
990
991
992
993
994
                    client
                        .round_robin(request_ctx)
                        .instrument(span)
                        .await
                        .map_err(to_pyerr)?
995
                }
996
                _ => client.round_robin(request_ctx).await.map_err(to_pyerr)?,
997
            };
998
            tokio::spawn(process_stream(stream, tx));
999
            Ok(AsyncResponseStream::new(rx, annotated))
1000
1001
1002
1003
        })
    }

    /// Send a request to a random endpoint.
1004
    #[pyo3(signature = (request, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
1005
1006
1007
1008
1009
    fn random<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
        annotated: Option<bool>,
1010
        context: Option<context::Context>,
1011
1012
    ) -> PyResult<Bound<'p, PyAny>> {
        let request: serde_json::Value = pythonize::depythonize(&request.into_bound(py))?;
1013
        let request_ctx = create_request_context(request, &context);
1014
1015
1016
        let annotated = annotated.unwrap_or(false);

        let (tx, rx) = tokio::sync::mpsc::channel(32);
1017
        let client = self.router.clone();
1018
1019

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
1020
1021
            let stream = match context {
                Some(context) => {
1022
                    // Always instrument with appropriate span (none if no trace context)
1023
                    let span = get_span_for_context(&context, "random");
1024
1025
1026
1027
1028
                    client
                        .random(request_ctx)
                        .instrument(span)
                        .await
                        .map_err(to_pyerr)?
1029
                }
1030
                _ => client.random(request_ctx).await.map_err(to_pyerr)?,
1031
            };
1032
            tokio::spawn(process_stream(stream, tx));
1033
            Ok(AsyncResponseStream::new(rx, annotated))
1034
1035
1036
1037
        })
    }

    /// Directly send a request to a specific endpoint.
1038
    #[pyo3(signature = (request, instance_id, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
1039
1040
1041
1042
    fn direct<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
1043
        instance_id: u64,
1044
        annotated: Option<bool>,
1045
        context: Option<context::Context>,
1046
1047
    ) -> PyResult<Bound<'p, PyAny>> {
        let request: serde_json::Value = pythonize::depythonize(&request.into_bound(py))?;
1048
        let request_ctx = create_request_context(request, &context);
1049
1050
1051
        let annotated = annotated.unwrap_or(false);

        let (tx, rx) = tokio::sync::mpsc::channel(32);
1052
        let client = self.router.clone();
1053
1054

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
1055
1056
            let stream = match context {
                Some(context) => {
1057
                    // Always instrument with appropriate span (none if no trace context)
1058
1059
                    let span =
                        get_span_for_direct_context(&context, "direct", &instance_id.to_string());
1060
1061
1062
1063
1064
                    client
                        .direct(request_ctx, instance_id)
                        .instrument(span)
                        .await
                        .map_err(to_pyerr)?
1065
1066
                }
                _ => client
1067
                    .direct(request_ctx, instance_id)
1068
1069
1070
                    .await
                    .map_err(to_pyerr)?,
            };
1071
1072
1073

            tokio::spawn(process_stream(stream, tx));

1074
            Ok(AsyncResponseStream::new(rx, annotated))
1075
1076
1077
1078
1079
        })
    }
}

async fn process_stream(
1080
    stream: EngineStream<RsAnnotated<serde_json::Value>>,
1081
1082
1083
1084
1085
    tx: tokio::sync::mpsc::Sender<RsAnnotated<PyObject>>,
) {
    let mut stream = stream;
    while let Some(response) = stream.next().await {
        // Convert the response to a PyObject using Python's GIL
1086
        let annotated: RsAnnotated<serde_json::Value> = response;
1087
        let annotated: RsAnnotated<PyObject> = annotated.map_data(|data| {
1088
            Python::with_gil(|py| match pythonize::pythonize(py, &data) {
1089
1090
                Ok(pyobj) => Ok(pyobj.into()),
                Err(e) => Err(e.to_string()),
1091
            })
1092
1093
1094
1095
1096
1097
        });

        let is_error = annotated.is_error();

        // Send the PyObject through the channel or log an error
        if let Err(e) = tx.send(annotated).await {
1098
            tracing::error!("Failed to send response: {:?}", e);
1099
            break;
1100
1101
1102
1103
1104
1105
1106
1107
1108
        }

        if is_error {
            break;
        }
    }
}

#[pyclass]
1109
pub(crate) struct AsyncResponseStream {
1110
1111
1112
    rx: Arc<Mutex<tokio::sync::mpsc::Receiver<RsAnnotated<PyObject>>>>,
    annotated: bool,
}
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124

impl AsyncResponseStream {
    pub(crate) fn new(
        rx: tokio::sync::mpsc::Receiver<RsAnnotated<PyObject>>,
        annotated: bool,
    ) -> Self {
        Self {
            rx: Arc::new(Mutex::new(rx)),
            annotated,
        }
    }
}
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221

#[pymethods]
impl AsyncResponseStream {
    /// This method is required to implement the `AsyncIterator` protocol.
    #[pyo3(name = "__aiter__")]
    fn aiter(slf: PyRef<Self>, py: Python) -> PyResult<Py<PyAny>> {
        slf.into_py_any(py)
    }
    /// This method is required to implement the `AsyncIterator` protocol.
    #[pyo3(name = "__anext__")]
    fn next<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
        let rx = self.rx.clone();
        let annotated = self.annotated;

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            loop {
                let value = rx.lock().await.recv().await;
                match value {
                    Some(pyobj) => {
                        let pyobj = match pyobj.ok() {
                            Ok(pyobj) => pyobj,
                            Err(e) => {
                                return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(e));
                            }
                        };

                        if annotated {
                            let object = Annotated { inner: pyobj };
                            #[allow(deprecated)]
                            let object = Python::with_gil(|py| object.into_py(py));
                            return Ok(object);
                        } else {
                            match pyobj.data {
                                Some(data) => return Ok(data),
                                None => continue,
                            }
                        }
                    }
                    None => return Err(PyStopAsyncIteration::new_err("Stream exhausted")),
                }
            }
        })
    }
}

#[pyclass]
struct Annotated {
    inner: RsAnnotated<PyObject>,
}

#[pymethods]
impl Annotated {
    #[new]
    fn new(data: PyObject) -> Self {
        Annotated {
            inner: RsAnnotated::from_data(data),
        }
    }

    fn is_error(&self) -> bool {
        self.inner.is_error()
    }

    fn data(&self) -> Option<PyObject> {
        self.inner.data.clone()
    }

    fn event(&self) -> Option<String> {
        self.inner.event.clone()
    }

    fn comments(&self) -> Option<Vec<String>> {
        self.inner.comment.clone()
    }

    fn id(&self) -> Option<String> {
        self.inner.id.clone()
    }

    #[pyo3(name = "__repr__")]
    fn _repr(&self, py: Python) -> String {
        let data = self.inner.data.clone().map(|obj| {
            obj.call_method0(py, "__repr__")
                .and_then(|repr_obj| repr_obj.extract::<Py<PyString>>(py))
                .map(|py_str| py_str.to_string_lossy(py).into_owned())
                .unwrap_or_else(|_| "<failed_repr>".to_string())
        });

        format!(
            "Annotated(data={}, event={}, comment={:?}, id={})",
            data.unwrap_or_else(|| "<no_data>".to_string()),
            self.inner.event.as_deref().unwrap_or("None"),
            self.inner.comment.as_deref().unwrap_or(&[]),
            self.inner.id.as_deref().unwrap_or("None")
        )
    }
}