Skip to main content

rigspark_runtime/
ollama_installed.rs

1use serde::{Deserialize, Serialize};
2use serde_json::Value;
3use sha2::{Digest, Sha256};
4use std::{
5    collections::BTreeMap,
6    path::{Path, PathBuf},
7};
8use tokio_util::sync::CancellationToken;
9
10#[derive(Debug, thiserror::Error)]
11pub enum OllamaError {
12    #[error("invalid Ollama input or response: {0}")]
13    Invalid(&'static str),
14    #[error("installed model integrity verification failed: {0}")]
15    Integrity(&'static str),
16    #[error("Ollama request failed: {0}")]
17    Request(String),
18}
19#[derive(Debug, Clone, PartialEq, Serialize)]
20#[serde(rename_all = "camelCase")]
21pub struct InstalledModel {
22    pub id: String,
23    pub digest: String,
24    pub size_bytes: u64,
25    pub quant: Option<String>,
26    pub context_length: Option<u32>,
27    pub kv_bytes_per_token: Option<u64>,
28    pub capabilities: Vec<String>,
29}
30pub fn size_installed(
31    model: &InstalledModel,
32    hardware: &rigspark_core::sizing::Hardware,
33    context: Option<u32>,
34) -> Result<Value, OllamaError> {
35    crate::hardware::validate_hardware(hardware).map_err(|_| OllamaError::Invalid("hardware"))?;
36    if context.is_some_and(|value| !(1..=10000000).contains(&value)) {
37        return Err(OllamaError::Invalid("context"));
38    }
39    let (kind, capacity) = rigspark_core::sizing::memory_capacity(hardware);
40    let usable = capacity * 0.85;
41    let weights_fit = model.size_bytes as f64 <= usable;
42    let required = context
43        .zip(model.kv_bytes_per_token)
44        .map(|(context, kv)| model.size_bytes as f64 + kv as f64 * f64::from(context));
45    let over_cap = context
46        .zip(model.context_length)
47        .is_some_and(|(context, cap)| context > cap);
48    let fit = if over_cap || !weights_fit || required.is_some_and(|required| required > usable) {
49        "no"
50    } else if required.is_none() {
51        "unknown"
52    } else {
53        "yes"
54    };
55    let mut value =
56        serde_json::to_value(model).map_err(|_| OllamaError::Invalid("installed model"))?;
57    for (key, entry) in [
58        ("context", serde_json::json!(context)),
59        ("fit", serde_json::json!(fit)),
60        ("weightsFit", serde_json::json!(weights_fit)),
61        ("requiredBytes", serde_json::json!(required)),
62        ("usableBytes", serde_json::json!(usable)),
63        ("memoryKind", serde_json::json!(kind)),
64        ("evidence", serde_json::json!("local-runtime-metadata")),
65        ("throughput", serde_json::json!("unknown")),
66    ] {
67        value[key] = entry;
68    }
69    Ok(value)
70}
71fn digest(value: &str) -> bool {
72    value.len() == 64
73        && value
74            .bytes()
75            .all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte))
76}
77pub(crate) fn model_path(root: &Path, id: &str) -> Result<PathBuf, OllamaError> {
78    let mut segments: Vec<_> = id.split('/').collect();
79    if segments.len() > 3 {
80        return Err(OllamaError::Invalid("installed model path"));
81    }
82    let last = segments.pop().ok_or(OllamaError::Invalid("model id"))?;
83    let parts: Vec<_> = last.split(':').collect();
84    if parts.len() > 2 {
85        return Err(OllamaError::Invalid("model tag"));
86    }
87    let name = parts[0];
88    let tag = parts.get(1).copied().unwrap_or("latest");
89    let namespace = segments.pop().unwrap_or("library");
90    let registry = segments.pop().unwrap_or("registry.ollama.ai");
91    let safe = |value: &str| {
92        !value.is_empty()
93            && value.as_bytes()[0].is_ascii_alphanumeric()
94            && value.bytes().all(|byte| {
95                byte.is_ascii_lowercase() || byte.is_ascii_digit() || b"._-".contains(&byte)
96            })
97    };
98    if ![registry, namespace, name, tag].into_iter().all(safe) {
99        return Err(OllamaError::Invalid("installed model path"));
100    }
101    Ok(root
102        .join("manifests")
103        .join(registry)
104        .join(namespace)
105        .join(name)
106        .join(tag))
107}
108pub fn parse_inventory(value: Value) -> Result<Vec<InstalledModel>, OllamaError> {
109    #[derive(Deserialize)]
110    struct Details {
111        quantization_level: Option<String>,
112    }
113    #[derive(Deserialize)]
114    struct Entry {
115        name: String,
116        digest: String,
117        size: u64,
118        remote_host: Option<String>,
119        remote_model: Option<String>,
120        details: Option<Details>,
121    }
122    #[derive(Deserialize)]
123    struct Inventory {
124        models: Vec<Entry>,
125    }
126    let inventory: Inventory =
127        serde_json::from_value(value).map_err(|_| OllamaError::Invalid("inventory"))?;
128    if inventory.models.len() > 10000 {
129        return Err(OllamaError::Invalid("inventory exceeds model limit"));
130    }
131    let mut result = Vec::new();
132    for entry in inventory.models {
133        if entry.name.is_empty()
134            || entry.name.len() > 256
135            || !digest(&entry.digest)
136            || entry.size == 0
137            || entry.size > 9007199254740991
138            || entry
139                .details
140                .as_ref()
141                .and_then(|details| details.quantization_level.as_ref())
142                .is_some_and(|value| value.len() > 100)
143        {
144            return Err(OllamaError::Invalid("inventory entry"));
145        }
146        if entry
147            .remote_host
148            .as_ref()
149            .is_some_and(|value| !value.is_empty())
150            || entry
151                .remote_model
152                .as_ref()
153                .is_some_and(|value| !value.is_empty())
154        {
155            continue;
156        }
157        model_path(Path::new(""), &entry.name)?;
158        result.push(InstalledModel {
159            id: entry.name,
160            digest: entry.digest,
161            size_bytes: entry.size,
162            quant: entry.details.and_then(|details| details.quantization_level),
163            context_length: None,
164            kv_bytes_per_token: None,
165            capabilities: Vec::new(),
166        });
167    }
168    Ok(result)
169}
170#[derive(Deserialize)]
171pub struct Metadata {
172    #[serde(default)]
173    pub model_info: BTreeMap<String, Value>,
174    #[serde(default)]
175    pub capabilities: Vec<String>,
176    pub parameters: Option<String>,
177    pub remote_host: Option<String>,
178}
179pub fn parse_metadata(value: Value) -> Result<Metadata, OllamaError> {
180    let metadata: Metadata =
181        serde_json::from_value(value).map_err(|_| OllamaError::Invalid("model metadata"))?;
182    if metadata
183        .remote_host
184        .as_ref()
185        .is_some_and(|value| !value.is_empty())
186        || metadata.capabilities.len() > 100
187        || metadata.capabilities.iter().any(|value| value.len() > 100)
188        || metadata
189            .parameters
190            .as_ref()
191            .is_some_and(|value| value.len() > 100000)
192    {
193        return Err(OllamaError::Invalid("local model metadata"));
194    }
195    Ok(metadata)
196}
197pub fn inspect_metadata(
198    mut model: InstalledModel,
199    value: Value,
200) -> Result<InstalledModel, OllamaError> {
201    let metadata = parse_metadata(value)?;
202    let family = metadata
203        .model_info
204        .get("general.architecture")
205        .and_then(Value::as_str)
206        .unwrap_or("");
207    let number = |key: &str, maximum: u64| {
208        metadata
209            .model_info
210            .get(&format!("{family}.{key}"))
211            .and_then(Value::as_u64)
212            .filter(|value| *value > 0 && *value <= maximum)
213    };
214    model.context_length = number("context_length", 10000000).map(|value| value as u32);
215    if ["llama", "qwen2"].contains(&family) {
216        model.kv_bytes_per_token = (|| {
217            let layers = number("block_count", 100000)?;
218            let heads = number("attention.head_count_kv", 100000)?;
219            let key = number("attention.key_length", 100000)?;
220            let value = number("attention.value_length", 100000)?;
221            layers
222                .checked_mul(heads)?
223                .checked_mul(key + value)?
224                .checked_mul(2)
225        })();
226    }
227    model.capabilities = metadata.capabilities;
228    Ok(model)
229}
230#[derive(Deserialize)]
231#[serde(rename_all = "camelCase")]
232struct Layer {
233    digest: String,
234    size: u64,
235    media_type: String,
236}
237#[derive(Deserialize)]
238#[serde(rename_all = "camelCase")]
239struct Manifest {
240    schema_version: u8,
241    config: Layer,
242    layers: Vec<Layer>,
243}
244fn contained(root: &Path, path: &Path) -> Result<(), OllamaError> {
245    let canonical = path
246        .canonicalize()
247        .map_err(|_| OllamaError::Integrity("missing local content"))?;
248    if !canonical.starts_with(root) {
249        return Err(OllamaError::Integrity("local path escaped model root"));
250    }
251    Ok(())
252}
253pub async fn verify_manifest(
254    root: &Path,
255    id: &str,
256    expected_manifest: &str,
257    expected_weight: Option<&str>,
258    expected_bytes: Option<u64>,
259    cancel: &CancellationToken,
260) -> Result<(), OllamaError> {
261    verify_catalog_manifest(
262        root,
263        id,
264        expected_manifest,
265        expected_weight,
266        expected_bytes,
267        &[],
268        cancel,
269    )
270    .await
271}
272
273pub async fn verify_catalog_manifest(
274    root: &Path,
275    id: &str,
276    expected_manifest: &str,
277    expected_weight: Option<&str>,
278    expected_bytes: Option<u64>,
279    projectors: &[rigspark_core::sizing::ProjectorArtifact],
280    cancel: &CancellationToken,
281) -> Result<(), OllamaError> {
282    if !digest(expected_manifest)
283        || expected_weight.is_some_and(|value| !digest(value))
284        || expected_bytes.is_some_and(|value| value == 0 || value > 9007199254740991)
285    {
286        return Err(OllamaError::Invalid("expected integrity"));
287    }
288    if cancel.is_cancelled() {
289        return Err(OllamaError::Request("cancelled".into()));
290    }
291    let root = root
292        .canonicalize()
293        .map_err(|_| OllamaError::Integrity("model root unavailable"))?;
294    let path = model_path(&root, id)?;
295    contained(&root, &path)?;
296    let raw = crate::state::secure_read(&path, 4 * 1024 * 1024, false)
297        .map_err(|_| OllamaError::Integrity("manifest unavailable"))?;
298    if format!("{:x}", Sha256::digest(raw.as_bytes())) != expected_manifest {
299        return Err(OllamaError::Integrity("manifest digest mismatch"));
300    }
301    let manifest: Manifest =
302        serde_json::from_str(&raw).map_err(|_| OllamaError::Invalid("manifest"))?;
303    if manifest.schema_version != 2 || manifest.layers.is_empty() || manifest.layers.len() > 10000 {
304        return Err(OllamaError::Invalid("manifest layers"));
305    }
306    let weights: Vec<_> = manifest
307        .layers
308        .iter()
309        .filter(|layer| layer.media_type == "application/vnd.ollama.image.model")
310        .collect();
311    if !projectors.is_empty() {
312        let actual: Vec<_> = manifest
313            .layers
314            .iter()
315            .filter(|layer| layer.media_type == "application/vnd.ollama.image.projector")
316            .collect();
317        let mut digests = std::collections::HashSet::new();
318        if projectors.len() > 16
319            || actual.len() != projectors.len()
320            || projectors.iter().any(|expected| {
321                !digest(&expected.sha256)
322                    || expected.bytes == 0
323                    || !digests.insert(&expected.sha256)
324                    || !actual.iter().any(|layer| {
325                        layer.digest == format!("sha256:{}", expected.sha256)
326                            && layer.size == expected.bytes
327                    })
328            })
329        {
330            return Err(OllamaError::Integrity("catalog projector mismatch"));
331        }
332    }
333    if weights.is_empty() {
334        return Err(OllamaError::Integrity("manifest has no model weights"));
335    }
336    if expected_weight.is_some_and(|expected| {
337        !weights
338            .iter()
339            .any(|layer| layer.digest == format!("sha256:{expected}"))
340    }) {
341        return Err(OllamaError::Integrity("catalog digest mismatch"));
342    }
343    let total = manifest
344        .layers
345        .iter()
346        .filter(|layer| {
347            layer.media_type == "application/vnd.ollama.image.model"
348                || layer.media_type == "application/vnd.ollama.image.projector"
349        })
350        .try_fold(0u64, |total, layer| total.checked_add(layer.size))
351        .ok_or(OllamaError::Invalid("weight size overflow"))?;
352    if expected_bytes.is_some_and(|expected| total < expected.div_ceil(2)) {
353        return Err(OllamaError::Integrity("catalog size floor"));
354    }
355    for layer in std::iter::once(&manifest.config).chain(&manifest.layers) {
356        let sha = layer
357            .digest
358            .strip_prefix("sha256:")
359            .filter(|value| digest(value))
360            .ok_or(OllamaError::Invalid("blob digest"))?;
361        if layer.size > 9007199254740991 {
362            return Err(OllamaError::Invalid("blob size"));
363        }
364        let blob = root.join("blobs").join(format!("sha256-{sha}"));
365        contained(&root, &blob)?;
366        let (actual, bytes) = crate::acquire::hash_file(&blob, cancel)
367            .await
368            .map_err(|_| OllamaError::Integrity("blob unavailable or cancelled"))?;
369        if actual != sha || bytes != layer.size {
370            return Err(OllamaError::Integrity("blob digest or size mismatch"));
371        }
372    }
373    if crate::state::secure_read(&path, 4 * 1024 * 1024, false)
374        .map_err(|_| OllamaError::Integrity("manifest unavailable"))?
375        != raw
376    {
377        return Err(OllamaError::Integrity(
378            "manifest changed during verification",
379        ));
380    }
381    Ok(())
382}
383
384#[async_trait::async_trait]
385pub trait InstalledVerifier: Send + Sync {
386    async fn verify(
387        &self,
388        id: &str,
389        digest: &str,
390        cancel: &CancellationToken,
391    ) -> Result<(), OllamaError>;
392}
393pub struct LocalVerifier {
394    pub root: PathBuf,
395}
396#[async_trait::async_trait]
397impl InstalledVerifier for LocalVerifier {
398    async fn verify(
399        &self,
400        id: &str,
401        digest: &str,
402        cancel: &CancellationToken,
403    ) -> Result<(), OllamaError> {
404        verify_manifest(&self.root, id, digest, None, None, cancel).await
405    }
406}
407pub struct InstalledModels<'runtime> {
408    transport: &'runtime dyn crate::http::Transport,
409    verifier: &'runtime dyn InstalledVerifier,
410}
411impl<'runtime> InstalledModels<'runtime> {
412    pub fn new(
413        transport: &'runtime dyn crate::http::Transport,
414        verifier: &'runtime dyn InstalledVerifier,
415    ) -> Self {
416        Self {
417            transport,
418            verifier,
419        }
420    }
421    async fn request(
422        &self,
423        endpoint: &str,
424        path: &str,
425        body: Option<Value>,
426        cancel: &CancellationToken,
427    ) -> Result<Value, OllamaError> {
428        let request = crate::http::Request::new(endpoint, path, body, None)
429            .map_err(|error| OllamaError::Request(error.to_string()))?;
430        crate::http::read_json(self.transport, request, cancel, 4 * 1024 * 1024)
431            .await
432            .map_err(|error| OllamaError::Request(error.to_string()))
433    }
434    pub async fn list(
435        &self,
436        endpoint: &str,
437        cancel: &CancellationToken,
438    ) -> Result<Vec<InstalledModel>, OllamaError> {
439        parse_inventory(self.request(endpoint, "/api/tags", None, cancel).await?)
440    }
441    pub async fn inspect(
442        &self,
443        endpoint: &str,
444        id: &str,
445        cancel: &CancellationToken,
446    ) -> Result<InstalledModel, OllamaError> {
447        model_path(Path::new(""), id)?;
448        let selected = exact(self.list(endpoint, cancel).await?, id)?;
449        inspect_metadata(
450            selected,
451            self.request(
452                endpoint,
453                "/api/show",
454                Some(serde_json::json!({"model":id})),
455                cancel,
456            )
457            .await?,
458        )
459    }
460    pub async fn activate(
461        &self,
462        endpoint: &str,
463        model: &InstalledModel,
464        context: Option<u32>,
465        cancel: &CancellationToken,
466    ) -> Result<String, OllamaError> {
467        self.activate_with_id(
468            endpoint,
469            model,
470            context,
471            &uuid::Uuid::new_v4().to_string(),
472            cancel,
473        )
474        .await
475    }
476    pub async fn activate_with_id(
477        &self,
478        endpoint: &str,
479        model: &InstalledModel,
480        context: Option<u32>,
481        unique: &str,
482        cancel: &CancellationToken,
483    ) -> Result<String, OllamaError> {
484        crate::state::loopback(endpoint).map_err(|_| OllamaError::Invalid("endpoint"))?;
485        model_path(Path::new(""), &model.id)?;
486        if !digest(&model.digest)
487            || context.is_some_and(|context| !(1..=10000000).contains(&context))
488        {
489            return Err(OllamaError::Invalid("activation metadata"));
490        }
491        let variant = context.map(|context| format!("llmup-context-{unique}:{context}"));
492        if let Some(variant) = &variant {
493            model_path(Path::new(""), variant)?;
494            if variant.len() > 256 {
495                return Err(OllamaError::Invalid("variant name"));
496            }
497        }
498        self.verifier
499            .verify(&model.id, &model.digest, cancel)
500            .await?;
501        if exact(self.list(endpoint, cancel).await?, &model.id)?.digest != model.digest {
502            return Err(OllamaError::Integrity("source manifest changed; retry"));
503        }
504        let Some(context) = context else {
505            return Ok(model.id.clone());
506        };
507        let variant = variant.ok_or(OllamaError::Invalid("variant name"))?;
508        let created=self.request(endpoint,"/api/create",Some(serde_json::json!({"model":variant,"from":model.id,"parameters":{"num_ctx":context},"stream":false})),cancel).await?;
509        if created.get("status").and_then(Value::as_str) != Some("success") {
510            return Err(OllamaError::Request(
511                "context variant creation failed".into(),
512            ));
513        }
514        let metadata = parse_metadata(
515            self.request(
516                endpoint,
517                "/api/show",
518                Some(serde_json::json!({"model":variant})),
519                cancel,
520            )
521            .await?,
522        )?;
523        if !metadata.parameters.as_ref().is_some_and(|parameters| {
524            parameters.lines().any(|line| {
525                let mut parts = line.split_whitespace();
526                parts.next() == Some("num_ctx")
527                    && parts.next().and_then(|value| value.parse::<u32>().ok()) == Some(context)
528            })
529        }) {
530            return Err(OllamaError::Integrity(
531                "runtime did not retain requested context",
532            ));
533        }
534        let installed = exact(self.list(endpoint, cancel).await?, &variant)?;
535        self.verifier
536            .verify(&installed.id, &installed.digest, cancel)
537            .await?;
538        if exact(self.list(endpoint, cancel).await?, &model.id)?.digest != model.digest {
539            return Err(OllamaError::Integrity(
540                "source changed during context activation",
541            ));
542        }
543        Ok(variant)
544    }
545}
546fn exact(models: Vec<InstalledModel>, id: &str) -> Result<InstalledModel, OllamaError> {
547    let mut matching = models.into_iter().filter(|model| model.id == id);
548    let selected = matching
549        .next()
550        .ok_or(OllamaError::Invalid("model not installed locally"))?;
551    if matching.next().is_some() {
552        return Err(OllamaError::Invalid("ambiguous installed model"));
553    }
554    Ok(selected)
555}