rlx_runtime/
registry.rs

1// RLX — versatile ML compiler + runtime.
2// Copyright (C) 2026 Eugene Hauptmann, Nataliya Kosmyna.
3//
4// This program is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, version 3.
7//
8// This program is distributed in the hope that it will be useful,
9// but WITHOUT ANY WARRANTY; without even the implied warranty of
10// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11// GNU General Public License for more details.
12//
13// You should have received a copy of the GNU General Public License
14// along with this program. If not, see <https://www.gnu.org/licenses/>.
15
16//! Backend registry — a single registration point for all backends.
17//!
18//! Adding a new backend (CUDA, ROCm, wgpu, WASM, TPU) is now a self-contained
19//! change in its own crate:
20//!
21//! ```ignore
22//! // in rlx-cuda/src/lib.rs
23//! #[cfg(feature = "cuda")]
24//! pub fn register() {
25//!     rlx_runtime::register_backend(Device::Cuda,
26//!         || Box::new(CudaBackend) as Box<dyn Backend>);
27//! }
28//! ```
29//!
30//! `Session::compile` consults the registry instead of a hardcoded `match`,
31//! so the runtime crate has no compile-time knowledge of which backends are
32//! available — each enables itself via its Cargo feature.
33
34use crate::backend::Backend;
35use rlx_driver::Device;
36use std::collections::HashMap;
37use std::sync::{OnceLock, RwLock};
38
39/// Factory closure that constructs a fresh backend instance.
40///
41/// Called once per `Session::compile`. Implementations are typically
42/// stateless (e.g. unit struct `CpuBackend`); the per-graph state lives
43/// inside the returned `Box<dyn Backend>`.
44pub type BackendFactory = fn() -> Box<dyn Backend>;
45
46struct Registry {
47    factories: RwLock<HashMap<Device, BackendFactory>>,
48}
49
50fn registry() -> &'static Registry {
51    static REGISTRY: OnceLock<Registry> = OnceLock::new();
52    REGISTRY.get_or_init(|| {
53        let r = Registry {
54            factories: RwLock::new(HashMap::new()),
55        };
56        register_builtin(&r);
57        r
58    })
59}
60
61/// Register builtin backends compiled into `rlx-runtime`. External
62/// backends (in their own crates) call `register_backend` from their
63/// own init path.
64#[allow(unused_mut, unused_variables)]
65fn register_builtin(r: &Registry) {
66    let mut map = r.factories.write().expect("registry poisoned");
67
68    #[cfg(feature = "cpu")]
69    map.insert(Device::Cpu, || {
70        Box::new(crate::backend::cpu_backend::CpuBackend) as Box<dyn Backend>
71    });
72
73    #[cfg(all(feature = "metal", target_vendor = "apple", not(target_os = "watchos")))]
74    map.insert(Device::Metal, || {
75        Box::new(crate::backend::metal_backend::MetalBackend) as Box<dyn Backend>
76    });
77
78    #[cfg(all(feature = "mlx", rlx_mlx_host))]
79    map.insert(Device::Mlx, || {
80        Box::new(crate::backend::mlx_backend::MlxBackend) as Box<dyn Backend>
81    });
82
83    #[cfg(all(
84        feature = "coreml",
85        target_vendor = "apple",
86        not(target_os = "watchos")
87    ))]
88    map.insert(Device::Ane, || {
89        Box::new(crate::backend::coreml_backend::CoremlBackend) as Box<dyn Backend>
90    });
91
92    #[cfg(feature = "gpu")]
93    map.insert(Device::Gpu, || {
94        Box::new(crate::backend::wgpu_backend::WgpuBackend) as Box<dyn Backend>
95    });
96
97    #[cfg(feature = "vulkan")]
98    map.insert(Device::Vulkan, || {
99        Box::new(crate::backend::vulkan_backend::VulkanBackend) as Box<dyn Backend>
100    });
101
102    #[cfg(feature = "cuda")]
103    map.insert(Device::Cuda, || {
104        Box::new(crate::backend::cuda_backend::CudaBackend) as Box<dyn Backend>
105    });
106
107    #[cfg(feature = "rocm")]
108    map.insert(Device::Rocm, || {
109        Box::new(crate::backend::rocm_backend::RocmBackend) as Box<dyn Backend>
110    });
111
112    #[cfg(feature = "oneapi")]
113    map.insert(Device::OneApi, || {
114        Box::new(crate::backend::oneapi_backend::OneApiBackend) as Box<dyn Backend>
115    });
116
117    #[cfg(feature = "tpu")]
118    map.insert(Device::Tpu, || {
119        Box::new(crate::backend::tpu_backend::TpuBackend) as Box<dyn Backend>
120    });
121
122    #[cfg(feature = "qnn")]
123    map.insert(Device::Hexagon, || {
124        Box::new(crate::backend::qnn_backend::QnnBackend) as Box<dyn Backend>
125    });
126}
127
128/// Register a backend factory for `device`. External backend crates
129/// (rlx-cuda, rlx-rocm, rlx-wgpu, rlx-wasm, …) call this once at startup
130/// (typically from a `pub fn register()` in their lib.rs that the user
131/// invokes — or via a constructor attribute if they use `ctor`/`inventory`).
132///
133/// Re-registering a device replaces the prior factory, so a custom backend
134/// can override a builtin (useful for swap-in alternatives like a tuned
135/// CPU backend).
136pub fn register_backend(device: Device, factory: BackendFactory) {
137    let r = registry();
138    let mut map = r.factories.write().expect("registry poisoned");
139    map.insert(device, factory);
140}
141
142/// Look up a backend factory and instantiate. Returns `None` if no backend
143/// is registered for `device`.
144pub fn backend_for(device: Device) -> Option<Box<dyn Backend>> {
145    let r = registry();
146    let map = r.factories.read().expect("registry poisoned");
147    map.get(&device).map(|f| f())
148}
149
150/// All currently registered devices (deterministic snapshot).
151pub fn registered_devices() -> Vec<Device> {
152    let r = registry();
153    let map = r.factories.read().expect("registry poisoned");
154    let mut out: Vec<Device> = map.keys().copied().collect();
155    out.sort_by_key(|d| format!("{d:?}"));
156    out
157}
rlx_runtime/registry.rs

rlx_runtime/
registry.rs
