summa-core 2.0.0

Core async search engine library with WASM support
Documentation
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
//! Row visibility publication uses the segment manager's existing transaction.
use super::*;
use crate::query::DocBitset;

impl<D: DirectoryWriter + 'static> SegmentManager<D> {
    pub(crate) async fn commit_with_deletes(
        self: &Arc<Self>,
        new_segments: &[(String, u32)],
        keys: Vec<String>,
        staged_deletions: Vec<(String, Arc<crate::index::staged_row::StagedSegment>)>,
    ) -> Result<()> {
        if keys.is_empty() && staged_deletions.is_empty() {
            return self.commit(new_segments).await;
        }
        let field = self
            .schema
            .primary_field()
            .ok_or_else(|| Error::Schema("row deletion requires a primary key".into()))?;
        for (id, count) in new_segments {
            self.validate_completed_segment(id, *count).await?;
        }
        let mut st = Arc::clone(&self.state).lock_owned().await;
        let manager = Arc::clone(self);
        let new_segments = new_segments.to_vec();
        self.run_lifecycle_transaction(async move {
            let keys: Arc<HashSet<String>> = Arc::new(keys.into_iter().collect());
            let mut next = st.metadata.clone();
            let mut retired = Vec::new();
            let mut outputs = Vec::new();
            // Only committed rows are targets. The same transaction's replacement
            // insertions must survive the deletion of their old primary keys.
            for (segment_id, info) in st
                .metadata
                .segment_metas
                .iter()
                .filter(|_| !keys.is_empty())
            {
                let sid = SegmentId::from_hex(segment_id)
                    .ok_or_else(|| Error::Corruption("invalid deletion source".into()))?;
                let mut fields = crate::segment::reader::loader::load_fast_fields_file(
                    manager.directory.as_ref(),
                    &SegmentFiles::new(sid.0),
                    &manager.schema,
                )
                .await?;
                let ff = fields
                    .remove(&field.0)
                    .ok_or_else(|| Error::Corruption("primary-key column is missing".into()))?;
                // Bounded by the admitted deletion-key set, independent of
                // the source dictionary/row count. Decode global ordinals in
                // batches instead of looking up and hashing each row's text.
                let cancellation = manager.active_operations.cancellation_flag();
                let lookup_cancellation = Arc::clone(&cancellation);
                let keys = Arc::clone(&keys);
                let num_docs = info.num_docs;
                // Publication holds the state lock. Run its bounded serial scan
                // directly on Tokio's blocking executor, never behind bulk BP.
                let (ff, ordinals) = tokio::task::spawn_blocking(move || {
                    let ordinals = crate::segment::deletion::target_ordinals(
                        &ff,
                        num_docs,
                        keys.iter().map(String::as_str),
                        || {
                            if lookup_cancellation.load(Ordering::Acquire) {
                                Err(Error::IndexClosed)
                            } else {
                                Ok(())
                            }
                        },
                    )?;
                    Ok::<_, Error>((ff, ordinals))
                })
                .await
                .map_err(|error| {
                    Error::Internal(format!("deletion key lookup failed: {error}"))
                })??;
                if ordinals.is_empty() {
                    continue;
                }
                let mut alive = match &info.deletions {
                    Some(meta) => {
                        (*meta.load(manager.directory.as_ref(), info.num_docs).await?).clone()
                    }
                    None => DocBitset::all(info.num_docs),
                };
                let (alive, changed) = tokio::task::spawn_blocking(move || {
                    let changed = crate::segment::deletion::clear_target_rows(
                        &ff,
                        &ordinals,
                        &mut alive,
                        || {
                            if cancellation.load(Ordering::Acquire) {
                                Err(Error::IndexClosed)
                            } else {
                                Ok(())
                            }
                        },
                    )?;
                    Ok::<_, Error>((alive, changed))
                })
                .await
                .map_err(|error| Error::Internal(format!("deletion worker failed: {error}")))??;
                if !changed {
                    continue;
                }
                let id = SegmentId::new();
                let claim = manager.protect_new_segment(id.to_hex())?;
                let cleanup = manager.output_cleanup_guard(id);
                // Install the unwind owner before writing the first byte.
                outputs.push((claim, cleanup));
                let deletion = crate::segment::deletion::write(
                    manager.directory.as_ref(),
                    id,
                    info.num_docs,
                    &alive,
                )
                .await?;
                if let Some(old) = &info.deletions {
                    retired.push(old.id.clone());
                }
                next.segment_metas.get_mut(segment_id).unwrap().deletions = Some(deletion);
            }
            for (id, count) in &new_segments {
                if !next.has_segment(id) {
                    next.add_segment(id.clone(), *count);
                }
            }
            for (segment_id, staged) in &staged_deletions {
                if st.metadata.has_segment(segment_id) {
                    return Err(Error::Corruption(
                        "staged visibility must refer to a new segment".into(),
                    ));
                }
                let info = next
                    .segment_metas
                    .get_mut(segment_id)
                    .ok_or_else(|| Error::Corruption("staged segment is missing".into()))?;
                let alive = staged.live_rows(info.num_docs).ok_or_else(|| {
                    Error::Internal("staged visibility has no cancelled rows".into())
                })?;
                let id = SegmentId::new();
                let claim = manager.protect_new_segment(id.to_hex())?;
                let cleanup = manager.output_cleanup_guard(id);
                outputs.push((claim, cleanup));
                info.deletions = Some(
                    crate::segment::deletion::write(
                        manager.directory.as_ref(),
                        id,
                        info.num_docs,
                        &alive,
                    )
                    .await?,
                );
            }
            next.publication_generation = next
                .publication_generation
                .checked_add(1)
                .ok_or_else(|| Error::Corruption("publication generation overflow".into()))?;
            next.save(manager.directory.as_ref()).await?;
            for id in next.owned_ids() {
                manager.tracker.register(&id);
            }
            let previous = manager.published_generation();
            manager
                .published_generation
                .store(Arc::new(PublishedIndexGeneration {
                    publication_id: next.publication_generation,
                    schema: Arc::clone(&previous.schema),
                    trained_vectors: previous.trained_vectors.clone(),
                }));
            retired.retain(|id| !next.owns_id(id));
            st.metadata = next;
            for (_, cleanup) in &mut outputs {
                cleanup.disarm();
            }
            let ready = manager.tracker.mark_for_deletion(&retired);
            drop(st);
            (manager.delete_fn)(ready);
            Ok(())
        })
        .await
    }
}

impl<D: DirectoryWriter + 'static> SegmentManager<D> {
    /// Rewrite one segment with a dense live-row space, including single-segment
    /// indexes. Returns false if it has no tombstones or is no longer current.
    pub async fn compact_segment(
        self: &Arc<Self>,
        segment_id: &str,
        memory_budget: usize,
    ) -> Result<bool> {
        self.compact_segment_admitted(segment_id, memory_budget, None)
            .await
    }

    /// Metadata-only candidates for the existing periodic optimizer. Zero
    /// threshold disables automatic work; invalid ratios fail before I/O.
    pub async fn compaction_candidates(&self, threshold: f64) -> Result<Vec<(String, u32, u32)>> {
        validate_threshold(threshold)?;
        if threshold == 0.0 || self.force_merge_active.load(Ordering::Acquire) > 0 {
            return Ok(Vec::new());
        }
        let active = self.active_operations.snapshot();
        let paused = self.paused_reorder_segments();
        let quarantined = self.quarantined_segments.lock().clone();
        let st = self.state.lock().await;
        let mut candidates: Vec<_> = st
            .metadata
            .segment_metas
            .iter()
            .filter(|(id, meta)| {
                meta.num_deleted_docs() > 0
                    && meta.deleted_ratio() >= threshold
                    && !active.contains(*id)
                    && !paused.contains(*id)
                    && !quarantined.contains(*id)
            })
            .map(|(id, meta)| (id.clone(), meta.num_docs, meta.num_deleted_docs()))
            .collect();
        candidates.sort_unstable_by(|a, b| {
            (f64::from(b.2) / f64::from(b.1))
                .total_cmp(&(f64::from(a.2) / f64::from(a.1)))
                .then_with(|| a.1.cmp(&b.1))
                .then_with(|| a.0.cmp(&b.0))
        });
        Ok(candidates)
    }

    /// Nonblocking maintenance admission, using the same ownership, pool,
    /// capacity and bounded retry state as existing optimizer work.
    pub async fn compact_segment_if_eligible(
        self: &Arc<Self>,
        segment_id: &str,
        threshold: f64,
        memory_budget: usize,
    ) -> Result<bool> {
        validate_threshold(threshold)?;
        if threshold == 0.0 {
            return Ok(false);
        }
        let result = self
            .compact_segment_admitted(segment_id, memory_budget, Some(threshold))
            .await;
        match &result {
            Ok(true) => self.clear_reorder_retry(segment_id),
            Err(error) if !matches!(error, Error::IndexClosed) => {
                self.pause_reorder_retries(segment_id, error).await
            }
            _ => {}
        }
        result
    }

    async fn compact_segment_admitted(
        self: &Arc<Self>,
        segment_id: &str,
        memory_budget: usize,
        threshold: Option<f64>,
    ) -> Result<bool> {
        if memory_budget < 1024 * 1024 {
            return Err(Error::Schema(
                "compaction memory budget must be at least 1 MiB".into(),
            ));
        }
        let sid = SegmentId::from_hex(segment_id)
            .ok_or_else(|| Error::Document("invalid compaction segment ID".into()))?;
        if !self.active_operations.is_accepting() {
            return Err(Error::IndexClosed);
        }
        if self.quarantined_segments.lock().contains(segment_id) {
            return Err(Error::Corruption("compaction source is quarantined".into()));
        }
        if threshold.is_some()
            && (self.force_merge_active.load(Ordering::Acquire) > 0
                || self.paused_reorder_segments().contains(segment_id))
        {
            return Ok(false);
        }
        let (global_permit, permit, reorder_permit) = if threshold.is_some() {
            let Ok(global) = Arc::clone(&self.global_merge_permits).try_acquire_owned() else {
                return Ok(false);
            };
            let Ok(local) = Arc::clone(&self.merge_permits).try_acquire_owned() else {
                return Ok(false);
            };
            let Ok(reorder) = self.reorder_permits.try_acquire_optimizer() else {
                return Ok(false);
            };
            (global, local, reorder)
        } else {
            let (global, local) = self.acquire_maintenance_capacity().await?;
            let reorder = tokio::select! {
                biased;
                () = self.active_operations.wait_for_shutdown() => return Err(Error::IndexClosed),
                permit = self.reorder_permits.acquire(ReorderPriority::Optimizer) => permit.map_err(|_| Error::IndexClosed)?,
            };
            (global, local, reorder)
        };
        let manager = Arc::clone(self);
        let source_id = segment_id.to_owned();
        self.run_lifecycle_transaction(async move {
            let _permit = permit;
            let _global_permit = global_permit;
            let _reorder_permit = reorder_permit;
            let start = std::time::Instant::now();
            let output = SegmentId::new();
            let (claim, snapshot, visibility, schema) = {
                let st = manager.state.lock().await;
                let Some(info) = st.metadata.segment_metas.get(&source_id) else {
                    return Ok(false);
                };
                if let Some(threshold) = threshold
                    && (manager.force_merge_active.load(Ordering::Acquire) > 0 || info.deleted_ratio() < threshold) {
                    return Ok(false);
                }
                let Some(visibility) = info.deletions.clone() else {
                    return Ok(false);
                };
                let Some(claim) = manager.active_operations.try_register(vec![source_id.clone(), output.to_hex()]) else {
                    return if threshold.is_some() { Ok(false) } else {
                        Err(Error::Internal("compaction source is busy; retry after maintenance finishes".into()))
                    };
                };
                let acquired = manager
                    .tracker
                    .acquire(&[source_id.clone(), visibility.id.clone()]);
                let snapshot = SegmentSnapshot::with_delete_fn(
                    Arc::clone(&manager.tracker),
                    acquired,
                    Arc::clone(&manager.delete_fn),
                );
                (
                    claim,
                    snapshot,
                    visibility,
                    manager.published_generation().schema.clone(),
                )
            };
            let _claim = claim;
            let _snapshot = snapshot;
            let mut cleanup = manager.output_cleanup_guard(output);
            let mut reader = SegmentReader::open_with_term_cache_budget(
                manager.directory.as_ref(),
                sid,
                schema.clone(),
                manager.term_cache_blocks,
                manager.term_cache_budget_bytes,
            )
            .await?;
            reader
                .load_deletions(manager.directory.as_ref(), visibility.clone())
                .await?;
            let physical = reader.num_docs();
            let meta = manager
                .build_compacted(reader, output, memory_budget)
                .await?;
            let removed = visibility.num_deleted;
            if meta.num_docs.checked_add(removed) != Some(physical) {
                return Err(Error::Corruption("compaction row count mismatch".into()));
            }
            let expected = HashMap::from([(source_id.clone(), Some(visibility))]);
            manager
                .replace_segments(
                    std::slice::from_ref(&source_id),
                    output.to_hex(),
                    meta.num_docs,
                    ReplacementLayout::Compacted,
                    Some(&expected),
                )
                .await?;
            cleanup.disarm();
            log::info!("[compaction] index={} source={} physical_rows={} removed_rows={} removed_ratio={:.6} live_rows={} elapsed_secs={:.3}",
                manager.schema.index_label(), source_id, physical, removed,
                f64::from(removed) / f64::from(physical), meta.num_docs, start.elapsed().as_secs_f64());
            Ok(true)
        })
        .await
    }

    pub(super) async fn build_compacted(
        &self,
        reader: SegmentReader,
        output: SegmentId,
        memory_budget: usize,
    ) -> Result<crate::segment::SegmentMeta> {
        let directory = Arc::clone(&self.directory);
        let merger = crate::segment::SegmentMerger::new(self.published_generation().schema.clone())
            .with_posting_config(self.optimization, self.posting_codec)
            .with_term_dict_block_size(self.term_dict_block_size)
            .with_cancellation(self.active_operations.cancellation_flag())
            .with_background_pool(Some(self.background_cpu_pool()));
        let runtime = tokio::runtime::Handle::current();
        let (meta, _) = tokio::task::spawn_blocking(move || {
            runtime.block_on(merger.compact(directory.as_ref(), &reader, output, memory_budget))
        })
        .await
        .map_err(|error| Error::Internal(format!("compaction worker failed: {error}")))??;
        Ok(meta)
    }
}

fn validate_threshold(threshold: f64) -> Result<()> {
    if !threshold.is_finite() || !(0.0..=1.0).contains(&threshold) {
        return Err(Error::Schema("compaction deleted ratio must be finite and in 0..=1 (0 disables automatic compaction)".into()));
    }
    Ok(())
}