dynamo-llm 1.5.1

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
// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

use std::{
    collections::{HashMap, HashSet},
    sync::{
        Arc, OnceLock, Weak,
        atomic::{AtomicBool, Ordering},
    },
};

use dashmap::DashMap;
use dynamo_kv_router::protocols::WorkerId;
use dynamo_runtime::{
    component::Endpoint, pipeline::MultimodalCacheIndex, traits::DistributedRuntimeProvider,
    transports::event_plane::EventSubscriber,
};
use tokio::sync::Mutex;

use crate::kv_router::{
    MULTIMODAL_EMBEDDING_CACHE_SUBJECT, publisher::MultimodalEmbeddingCacheEvent,
};
use crate::protocols::common::{llm_backend::PreprocessedRequest, preprocessor::MultimodalData};

fn multimodal_cache_key_from_url(url: &str) -> String {
    blake3::hash(url.as_bytes()).to_hex().to_string()
}

pub fn preprocessed_multimodal_cache_keys(request: &PreprocessedRequest) -> Vec<String> {
    let Some(items) = request
        .multi_modal_data
        .as_ref()
        .and_then(|media| media.get("image_url"))
    else {
        return Vec::new();
    };

    let mut keys = Vec::with_capacity(items.len());
    for item in items {
        match item {
            MultimodalData::Url(url) => keys.push(multimodal_cache_key_from_url(url.as_str())),
            MultimodalData::RawUrl(url) => keys.push(multimodal_cache_key_from_url(url)),
            MultimodalData::Decoded(descriptor) => {
                if let Some(key) = descriptor.content_hash_key() {
                    keys.push(key.to_string());
                }
            }
            MultimodalData::UuidOnly(_) => {}
        }
    }
    keys.sort();
    keys.dedup();
    keys
}

#[derive(Clone, Default)]
pub struct EmbeddingCacheIndexer {
    key_workers: Arc<DashMap<String, HashSet<WorkerId>>>,
    worker_cache_keys: Arc<DashMap<WorkerId, HashSet<String>>>,
    started: Arc<AtomicBool>,
}

type SharedIndexerKey = (u64, String);
type SharedIndexerMap = HashMap<SharedIndexerKey, Weak<dyn MultimodalCacheIndex>>;

static SHARED_INDEXERS: OnceLock<Mutex<SharedIndexerMap>> = OnceLock::new();

fn shared_indexer(
    indexers: &mut SharedIndexerMap,
    indexer_key: &SharedIndexerKey,
) -> Option<Arc<dyn MultimodalCacheIndex>> {
    indexers.retain(|_, indexer| indexer.strong_count() > 0);
    indexers.get(indexer_key).and_then(Weak::upgrade)
}

pub async fn try_build_cache_indexer(endpoint: &Endpoint) -> Option<Arc<dyn MultimodalCacheIndex>> {
    let indexer_key = (endpoint.drt().connection_id(), endpoint.id().to_string());
    let mut indexers = SHARED_INDEXERS
        .get_or_init(|| Mutex::new(HashMap::new()))
        .lock()
        .await;

    if let Some(indexer) = shared_indexer(&mut indexers, &indexer_key) {
        return Some(indexer);
    }

    match EmbeddingCacheIndexer::for_endpoint(endpoint).await {
        Ok(indexer) => {
            let indexer: Arc<dyn MultimodalCacheIndex> = indexer;
            indexers.insert(indexer_key, Arc::downgrade(&indexer));
            Some(indexer)
        }
        Err(error) => {
            tracing::warn!(
                error = %error,
                "embedding cache indexer subscriber not available; skipping cache-state sync"
            );
            None
        }
    }
}

impl EmbeddingCacheIndexer {
    pub async fn for_endpoint(endpoint: &Endpoint) -> anyhow::Result<Arc<Self>> {
        let indexer = Arc::new(Self::default());
        indexer.start_subscriber(endpoint).await?;
        Ok(indexer)
    }

    pub fn workers_with_cached_keys<'a, I>(&self, cache_keys: I) -> Vec<WorkerId>
    where
        I: IntoIterator<Item = &'a str>,
    {
        self.worker_cache_key_hits(cache_keys)
            .into_iter()
            .map(|(worker_id, _hits)| worker_id)
            .collect()
    }

    pub fn worker_cache_key_hits<'a, I>(&self, cache_keys: I) -> Vec<(WorkerId, usize)>
    where
        I: IntoIterator<Item = &'a str>,
    {
        let requested = cache_keys.into_iter().collect::<HashSet<_>>();
        if requested.is_empty() {
            return Vec::new();
        }

        // Partial cache hits are useful: for a request with multiple images,
        // a worker that already has some embeddings can still avoid work.
        // Count per-worker hits across the de-duplicated requested keys, then
        // prefer workers with more hits.
        let mut worker_hits = HashMap::<WorkerId, usize>::with_capacity(requested.len());
        for key in requested {
            if let Some(workers) = self.key_workers.get(key) {
                for worker_id in workers.iter() {
                    *worker_hits.entry(*worker_id).or_default() += 1;
                }
            }
        }

        let mut worker_hits = worker_hits.into_iter().collect::<Vec<_>>();
        worker_hits.sort_by(|(left_id, left_hits), (right_id, right_hits)| {
            right_hits
                .cmp(left_hits)
                .then_with(|| left_id.cmp(right_id))
        });
        worker_hits
    }

    pub fn apply_event(&self, event: &MultimodalEmbeddingCacheEvent) {
        self.apply_delta(
            event.worker_id,
            event.update.added_keys.iter().cloned().collect(),
            event.update.removed_keys.iter().cloned().collect(),
        );
    }

    pub fn remove_worker(&self, worker_id: WorkerId) {
        let Some((_, keys)) = self.worker_cache_keys.remove(&worker_id) else {
            return;
        };

        for key in keys {
            self.remove_worker_from_key(&key, worker_id);
        }
    }

    pub async fn start_subscriber(self: &Arc<Self>, endpoint: &Endpoint) -> anyhow::Result<()> {
        if self.started.swap(true, Ordering::AcqRel) {
            tracing::debug!("Embedding cache indexer subscriber already started, skipping");
            return Ok(());
        }

        let cancellation_token = endpoint.drt().child_token();
        let endpoint = endpoint.clone();
        let subscriber = match EventSubscriber::for_endpoint(
            &endpoint,
            MULTIMODAL_EMBEDDING_CACHE_SUBJECT,
        )
        .await
        {
            Ok(subscriber) => subscriber.typed::<MultimodalEmbeddingCacheEvent>(),
            Err(error) => {
                self.started.store(false, Ordering::Release);
                return Err(error);
            }
        };

        let indexer = Arc::clone(self);
        tokio::spawn(async move {
            let mut subscriber = subscriber;
            const RECONNECT_BACKOFF: std::time::Duration = std::time::Duration::from_secs(5);

            'reconnect: loop {
                loop {
                    tokio::select! {
                        _ = cancellation_token.cancelled() => {
                            tracing::debug!("Embedding cache indexer subscriber cancelled");
                            break 'reconnect;
                        }
                        maybe_event = subscriber.next() => {
                            let Some(result) = maybe_event else {
                                tracing::warn!(
                                    "Embedding cache indexer stream ended; reconnecting"
                                );
                                break;
                            };

                            match result {
                                Ok((_envelope, event)) => indexer.apply_event(&event),
                                Err(error) => {
                                    tracing::warn!(
                                        "Error receiving multimodal embedding cache event: {error:?}; reconnecting"
                                    );
                                    break;
                                }
                            }
                        }
                    }
                }

                subscriber = loop {
                    tokio::select! {
                        _ = tokio::time::sleep(RECONNECT_BACKOFF) => {}
                        _ = cancellation_token.cancelled() => {
                            tracing::debug!("Embedding cache indexer subscriber cancelled");
                            break 'reconnect;
                        }
                    }

                    match EventSubscriber::for_endpoint(
                        &endpoint,
                        MULTIMODAL_EMBEDDING_CACHE_SUBJECT,
                    )
                    .await
                    {
                        Ok(subscriber) => {
                            break subscriber.typed::<MultimodalEmbeddingCacheEvent>();
                        }
                        Err(error) => {
                            tracing::warn!(
                                "Failed to reconnect embedding cache indexer subscriber (will retry): {error}"
                            );
                        }
                    }
                };
            }

            indexer.started.store(false, Ordering::Release);
        });

        Ok(())
    }

    fn apply_delta(
        &self,
        worker_id: WorkerId,
        added_keys: HashSet<String>,
        removed_keys: HashSet<String>,
    ) {
        let should_remove_worker_entry;

        {
            let mut worker_keys = self.worker_cache_keys.entry(worker_id).or_default();

            for key in removed_keys {
                if worker_keys.remove(&key) {
                    self.remove_worker_from_key(&key, worker_id);
                }
            }
            for key in added_keys {
                if worker_keys.insert(key.clone()) {
                    self.add_worker_to_key(key, worker_id);
                }
            }

            should_remove_worker_entry = worker_keys.is_empty();
        }

        if should_remove_worker_entry {
            self.worker_cache_keys
                .remove_if(&worker_id, |_, keys| keys.is_empty());
        }
    }

    fn add_worker_to_key(&self, key: String, worker_id: WorkerId) {
        self.key_workers.entry(key).or_default().insert(worker_id);
    }

    fn remove_worker_from_key(&self, key: &str, worker_id: WorkerId) {
        if let Some(mut workers) = self.key_workers.get_mut(key) {
            workers.remove(&worker_id);
        }
        self.key_workers
            .remove_if(key, |_, workers| workers.is_empty());
    }
}

impl MultimodalCacheIndex for EmbeddingCacheIndexer {
    fn workers_with_cache_key_hits(&self, cache_keys: &[String]) -> Vec<(WorkerId, usize)> {
        self.worker_cache_key_hits(cache_keys.iter().map(|key| key.as_str()))
    }

    fn remove_worker(&self, worker_id: WorkerId) {
        EmbeddingCacheIndexer::remove_worker(self, worker_id);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::kv_router::publisher::{
        MultimodalEmbeddingCacheEvent, MultimodalEmbeddingCacheUpdate,
    };

    #[test]
    fn shared_indexer_cache_prunes_dropped_entries() {
        let live_key = (1, "live".to_string());
        let stale_key = (2, "stale".to_string());
        let live: Arc<dyn MultimodalCacheIndex> = Arc::new(EmbeddingCacheIndexer::default());
        let stale: Arc<dyn MultimodalCacheIndex> = Arc::new(EmbeddingCacheIndexer::default());
        let mut indexers = HashMap::from([
            (live_key.clone(), Arc::downgrade(&live)),
            (stale_key.clone(), Arc::downgrade(&stale)),
        ]);
        drop(stale);

        assert!(shared_indexer(&mut indexers, &live_key).is_some());
        assert!(!indexers.contains_key(&stale_key));

        drop(live);
        assert!(shared_indexer(&mut indexers, &live_key).is_none());
        assert!(indexers.is_empty());
    }

    #[test]
    fn delta_removes_stale_worker_keys() {
        let indexer = EmbeddingCacheIndexer::default();

        indexer.apply_event(&MultimodalEmbeddingCacheEvent {
            worker_id: 7,
            update: MultimodalEmbeddingCacheUpdate {
                added_keys: vec!["b".to_string(), "a".to_string()],
                removed_keys: vec![],
            },
        });
        indexer.apply_event(&MultimodalEmbeddingCacheEvent {
            worker_id: 7,
            update: MultimodalEmbeddingCacheUpdate {
                added_keys: vec!["c".to_string()],
                removed_keys: vec!["a".to_string(), "b".to_string()],
            },
        });

        let worker_keys = indexer.worker_cache_keys.get(&7).unwrap();
        assert_eq!(worker_keys.len(), 1);
        assert!(worker_keys.contains("c"));
    }

    #[test]
    fn workers_with_cached_keys_returns_partial_matches_first() {
        let indexer = EmbeddingCacheIndexer::default();

        indexer.apply_event(&MultimodalEmbeddingCacheEvent {
            worker_id: 1,
            update: MultimodalEmbeddingCacheUpdate {
                added_keys: vec!["a".to_string(), "b".to_string()],
                removed_keys: vec![],
            },
        });
        indexer.apply_event(&MultimodalEmbeddingCacheEvent {
            worker_id: 2,
            update: MultimodalEmbeddingCacheUpdate {
                added_keys: vec!["a".to_string()],
                removed_keys: vec![],
            },
        });

        assert_eq!(indexer.workers_with_cached_keys(["a", "b"]), vec![1, 2]);
        assert_eq!(
            indexer.worker_cache_key_hits(["a", "b"]),
            vec![(1, 2), (2, 1)]
        );
    }

    #[test]
    fn delta_updates_reverse_index() {
        let indexer = EmbeddingCacheIndexer::default();

        indexer.apply_event(&MultimodalEmbeddingCacheEvent {
            worker_id: 3,
            update: MultimodalEmbeddingCacheUpdate {
                added_keys: vec!["a".to_string(), "b".to_string()],
                removed_keys: vec![],
            },
        });
        indexer.apply_event(&MultimodalEmbeddingCacheEvent {
            worker_id: 4,
            update: MultimodalEmbeddingCacheUpdate {
                added_keys: vec!["a".to_string()],
                removed_keys: vec![],
            },
        });
        indexer.apply_event(&MultimodalEmbeddingCacheEvent {
            worker_id: 3,
            update: MultimodalEmbeddingCacheUpdate {
                added_keys: vec![],
                removed_keys: vec!["b".to_string()],
            },
        });

        assert_eq!(indexer.workers_with_cached_keys(["a"]), vec![3, 4]);
        assert_eq!(indexer.workers_with_cached_keys(["a", "b"]), vec![3, 4]);
    }
}