rlucene 0.1.0-alpha.3

A Rust port of Apache Lucene, a full-text search engine library
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
use crate::core::index::frozen_buffered_updates::FrozenBufferedUpdates;
use crate::core::index::index_writer::IndexWriter;
use crate::core::index::readers_and_updates;
use crate::core::index::readers_and_updates::ReadersAndUpdates;
use crate::core::index::segment_commit_info::SegmentCommitInfo;
use crate::core::index::segment_reader::DefaultLeafReader;
use crate::core::store::IO_CONTEXT_DEFAULT;

use crate::core::store::directory::Directory;
use crate::core::util::IOUtils;
use crate::core::util::accountable::Accountable;
use crate::core::util::error::lucene_error::{LuceneError, Result};
use crate::core::util::info_stream::{InfoStream, InfoStreamMT};
use parking_lot::Mutex;
use std::collections::{HashMap, HashSet};
use std::fmt::Display;
use std::sync::Arc;
use std::sync::atomic::{AtomicI64, Ordering};

/// Tracks the stream of [`FrozenBufferedUpdates`]. When [`DocumentsWriterPerThread`](crate::core::index::documents_writer_per_thread::DocumentsWriterPerThread) flushes, its
/// buffered deletes and updates are appended to this stream and immediately resolved (to actual
/// doc IDs, per segment) using the indexing thread that triggered the flush for concurrency. When a
/// merge kicks off, we synchronize to ensure all resolving packets complete. We also apply updates
/// to all segments when an NRT reader is pulled, on commit/close, or when too many deletes or
/// updates are buffered and must be flushed (by RAM usage or by count).
///
/// Each packet is assigned a generation, and each flushed or merged segment is also assigned a
/// generation, so we can track which buffered-deletes packets to apply to any given segment.
pub(crate) struct BufferedUpdatesStream {
  inner: Mutex<BufferedUpdatesStreamInner>,
  bytes_used: AtomicI64,
  finished_segments: FinishedSegments,
}
pub(crate) struct BufferedUpdatesStreamInner {
  // The owning Arc keeps the packet address live until the entry is removed.
  updates: HashMap<usize, Arc<FrozenBufferedUpdates>>,
  // Starts at 1 so that SegmentInfos that have never had
  // deletes applied (whose bufferedDelGen defaults to 0)
  // will be correct:
  next_gen: i64,
}
impl BufferedUpdatesStream {
  pub(crate) fn new(info_stream: InfoStreamMT) -> Self {
    Self {
      inner: Mutex::new(BufferedUpdatesStreamInner {
        updates: HashMap::new(),
        next_gen: 1,
      }),
      bytes_used: AtomicI64::new(0),
      finished_segments: FinishedSegments::new(info_stream),
    }
  }
  // Appends a new packet of buffered deletes to the stream,
  // setting its generation:
  pub(crate) fn push(
    &self,
    mut packet: FrozenBufferedUpdates,
  ) -> Result<(i64, Arc<FrozenBufferedUpdates>)> {
    // The insert operation must be atomic. If we let threads increment the gen
    // and push the packet afterwards we risk that packets are out of order.
    // With DWPT this is possible if two or more flushes are racing for pushing
    // updates. If the pushed packets get our of order would loose documents
    // since deletes are applied to the wrong segments.
    let mut inner = self.inner.lock();
    packet.set_del_gen(inner.next_gen);
    inner.next_gen += 1;
    debug_assert!(packet.any());
    debug_assert!(self.check_delete_stats(&inner));

    let bytes_used = packet.bytes_used;
    let del_gen = packet.del_gen();
    let v = Arc::new(packet);
    inner.updates.insert(Arc::as_ptr(&v).addr(), Arc::clone(&v));
    self
      .bytes_used
      .fetch_add(bytes_used as i64, Ordering::SeqCst);
    {
      if self.finished_segments.info_stream.is_enabled("BD") {
        let count = inner.updates.len();
        let used_mb = self.bytes_used.load(Ordering::SeqCst) as f64 / 1024.0 / 1024.0;
        self.finished_segments.info_stream.message(
          "BD",
          &format!("push new packet ({v}), packetCount={count}, bytesUsed={used_mb:.3} MB"),
        )?;
      }
    }
    debug_assert!(self.check_delete_stats(&inner));
    Ok((del_gen, v))
  }
  pub(crate) fn get_pending_updates_count(&self) -> usize {
    let inner = self.inner.lock();
    inner.updates.len()
  }
  /// Only used by IW.rollback
  #[allow(dead_code)]
  pub(crate) fn clear(&self) {
    let mut inner = self.inner.lock();
    inner.updates.clear();
    inner.next_gen = 1;
    self.finished_segments.clear();
    self.bytes_used.store(0, Ordering::SeqCst);
  }
  pub(crate) fn any(&self) -> bool {
    self.bytes_used.load(Ordering::SeqCst) != 0
  }
  /// Waits for all in-flight packets, which are being resolved concurrently by indexing threads, to finish.
  ///
  /// Returns `true` if there were any new deletes or updates.
  ///
  /// This is called during refresh and commit.
  pub(crate) fn wait_apply_all<D>(&self, writer: &IndexWriter<D>) -> Result<()>
  where
    D: Directory + 'static,
  {
    let wait_for = {
      let inner = self.inner.lock();
      inner.updates.values().cloned().collect()
    };
    self.wait_apply(wait_for, writer)
  }
  /// Returns true if this delGen is still running.
  pub(crate) fn still_running(&self, del_gen: i64) -> bool {
    self.finished_segments.still_running(del_gen)
  }

  pub(crate) fn finished_segment(&self, del_gen: i64) -> Result<()> {
    self.finished_segments.finished_segment(del_gen)
  }
  /// Called by indexing threads once they are fully done resolving all deletes for the provided `del_gen`.
  /// We track completed deletion generations and record the maximum `del_gen` for which all prior generations,
  /// inclusive, are completed, so that it’s safe for doc values updates to apply and write.
  pub(crate) fn finished(&self, packet: &FrozenBufferedUpdates) -> Result<()> {
    debug_assert!(!packet.applied.load(Ordering::SeqCst), "packet={packet}");
    packet.applied.store(true, Ordering::SeqCst);

    let mut inner = self.inner.lock();
    inner.updates.remove(&std::ptr::from_ref(packet).addr());

    let bytes = packet.bytes_used as i64;
    self.bytes_used.fetch_sub(bytes, Ordering::SeqCst);

    self.finished_segment(packet.del_gen())?;
    Ok(())
  }
  /// All frozen packets up to and including this del gen are guaranteed to be finished.
  pub fn get_completed_del_gen(&self) -> i64 {
    self.finished_segments.get_completed_del_gen()
  }
  /// Waits only for those in-flight packets that apply to these merge segments.
  /// This is called when a merge needs to finish and must ensure all deletes to the merging segments are resolved.
  pub(crate) fn wait_apply_for_merge<D>(
    &self,
    merge_infos_id: &[Arc<str>],
    writer: &IndexWriter<D>,
  ) -> Result<()>
  where
    D: Directory + 'static,
  {
    let mut max_del_gen = i64::MIN;
    {
      let writer_inner = writer.inner.lock();
      for info in merge_infos_id {
        let info = writer_inner
          .segment_infos
          .index_of(info.as_ref())
          .ok_or_else(|| {
            LuceneError::illegal_argument(
              "could not find merge's segment from IndexWriter's segment_infos",
            )
          })?;
        max_del_gen = max_del_gen.max(info.get_buffered_deletes_gen());
      }
    }

    let wait_for = {
      let inner = self.inner.lock();
      let mut packets = smallvec::SmallVec::new();

      for packet in inner.updates.values() {
        if packet.del_gen() <= max_del_gen {
          // We must wait for this packet before finishing the merge because its
          // deletes apply to a subset of the segments being merged.
          packets.push(packet.clone());
        }
      }

      packets
    };

    if self.finished_segments.info_stream.is_enabled("BD") {
      self.finished_segments.info_stream.message(
        "BD",
        &format!(
          "waitApplyForMerge: {} packets, {} merging segments",
          wait_for.len(),
          merge_infos_id.len()
        ),
      )?;
    }

    self.wait_apply(wait_for, writer)
  }

  fn wait_apply<D>(
    &self,
    mut wait_for: smallvec::SmallVec<[Arc<FrozenBufferedUpdates>; 4]>,
    writer: &IndexWriter<D>,
  ) -> Result<()>
  where
    D: Directory + 'static,
  {
    let start_ns = std::time::Instant::now();
    let packet_count = wait_for.len();

    if wait_for.is_empty() {
      if self.finished_segments.info_stream.is_enabled("BD") {
        self
          .finished_segments
          .info_stream
          .message("BD", "waitApply: no deletes to apply")?;
      }
      return Ok(());
    }

    if self.finished_segments.info_stream.is_enabled("BD") {
      self.finished_segments.info_stream.message(
        "BD",
        &format!("waitApply: {packet_count:?} packets: {wait_for:?}"),
      )?;
    }

    let mut pending_count = 0;
    let mut total_del_count: i64 = 0;
    for index in 0..wait_for.len() {
      let packet = &wait_for[index];
      // Frozen packets are now resolved, concurrently, by the indexing threads that
      // create them, by adding a DocumentsWriter.ResolveUpdatesEvent to the events queue,
      // but if we get here and the packet is not yet resolved, we resolve it now ourselves:
      let applied = writer.try_apply(packet)?;
      total_del_count += packet.total_del_count.load(Ordering::SeqCst);
      if !applied {
        // A preceding completed packet can fill the current slot.
        wait_for.swap(pending_count, index);
        pending_count += 1;
      }
    }
    for packet in &wait_for[..pending_count] {
      // now block on all the packets that were concurrently applied to ensure they are due before
      // we continue.
      writer.force_apply(packet)?;
    }

    if self.finished_segments.info_stream.is_enabled("BD") {
      let elapsed = start_ns.elapsed().as_secs_f64() * 1000.0;
      let bytes = self.bytes_used.load(Ordering::SeqCst);
      self.finished_segments.info_stream.message(
                    "BD",
                    &format!(
                        "waitApply: done {packet_count} packets; totalDelCount={total_del_count}; totBytesUsed={bytes}; took {elapsed:.2} msec"
                    ),
                )?;
    }
    Ok(())
  }

  pub(crate) fn get_next_gen(&self) -> i64 {
    let mut inner = self.inner.lock();
    let gen_ = inner.next_gen;
    inner.next_gen += 1;
    gen_
  }
  // only for assert
  fn check_delete_stats(&self, inner: &BufferedUpdatesStreamInner) -> bool {
    let mut bytes_used2 = 0i64;
    for packet in inner.updates.values() {
      bytes_used2 += packet.bytes_used as i64;
    }
    let actual = self.bytes_used.load(Ordering::SeqCst);
    debug_assert_eq!(
      bytes_used2, actual,
      "bytes_used2={bytes_used2} vs bytes_used={actual}"
    );
    true
  }
}
impl Accountable for BufferedUpdatesStream {
  fn ram_bytes_used(&self) -> Result<i64> {
    Ok(self.bytes_used.load(Ordering::SeqCst))
  }
}

pub(crate) struct SegmentState<D>
where
  D: Directory,
{
  pub(crate) del_gen: i64,
  pub(crate) rld: Arc<ReadersAndUpdates<D>>,
  pub(crate) reader: DefaultLeafReader<D>,
  pub(crate) start_del_count: i32,
}
impl<D> SegmentState<D>
where
  D: Directory,
{
  pub(crate) fn new(rld: Arc<ReadersAndUpdates<D>>, info: &SegmentCommitInfo<D>) -> Result<Self> {
    let reader = {
      let mut inner = rld.inner.lock();
      readers_and_updates::get_reader(
        IO_CONTEXT_DEFAULT.as_ref().map_err(Clone::clone)?,
        info,
        &mut inner,
        rld.index_created_version_major,
      )?
    };
    Ok(SegmentState {
      del_gen: info.get_buffered_deletes_gen(),
      rld,
      reader,
      start_del_count: info.get_del_count(),
    })
  }
  pub(crate) fn close(
    &self,
    writer: &IndexWriter<D>,
    inner: &mut crate::core::index::index_writer::Inner<D>,
  ) -> Result<()> {
    IOUtils::close_with(0..2, |operation| match operation {
      0 => self.rld.release(self.reader.as_ref(), None),
      _ => writer.release(self.rld.as_ref(), inner),
    })
  }
}
impl<D> Display for SegmentState<D>
where
  D: Directory,
{
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    write!(f, "SegmentState({})", self.rld.info_id)
  }
}

/// Tracks the contiguous range of packets that have finished resolving.
///
/// Packets are resolved concurrently, and only contiguous completed packets can be written to disk.
pub(crate) struct FinishedSegments {
  info_stream: InfoStreamMT,
  inner: Mutex<Inner>,
}
pub(crate) struct Inner {
  /// Largest del gen, inclusive, for which all prior packets have finished applying.
  completed_del_gen: i64,
  /// This lets us track the "holes" in the current frontier of applying del gens;
  /// once the holes are filled in we can advance completedDelGen.
  finished_del_gens: HashSet<i64>,
}
impl FinishedSegments {
  pub(crate) fn new(info_stream: InfoStreamMT) -> Self {
    FinishedSegments {
      info_stream,
      inner: Mutex::new(Inner {
        completed_del_gen: 0,
        finished_del_gens: HashSet::new(),
      }),
    }
  }

  #[allow(dead_code)]
  pub(crate) fn clear(&self) {
    let mut inner = self.inner.lock();
    inner.finished_del_gens.clear();
    inner.completed_del_gen = 0;
  }

  pub(crate) fn still_running(&self, del_gen: i64) -> bool {
    let inner = self.inner.lock();
    del_gen > inner.completed_del_gen && !inner.finished_del_gens.contains(&del_gen)
  }
  pub fn get_completed_del_gen(&self) -> i64 {
    let inner = self.inner.lock();
    inner.completed_del_gen
  }

  pub(crate) fn finished_segment(&self, del_gen: i64) -> Result<()> {
    let mut inner = self.inner.lock();
    inner.finished_del_gens.insert(del_gen);
    while inner
      .finished_del_gens
      .contains(&(inner.completed_del_gen + 1))
    {
      let v = inner.completed_del_gen + 1;
      inner.finished_del_gens.remove(&v);
      inner.completed_del_gen += 1;
    }
    {
      if self.info_stream.is_enabled("BD") {
        self.info_stream.message(
          "BD",
          &format!(
            "finished packet delGen={} now completedDelGen={}",
            del_gen, inner.completed_del_gen
          ),
        )?;
      }
    }
    Ok(())
  }
}
/// Result of applying deletes.
///
/// - `any_new_deletes`: true if any actual deletes took place
/// - `all_deleted`: if `Some`, contains segments_id that are 100% deleted
pub(crate) struct ApplyDeletesResult {
  pub(crate) any_deletes: bool,
  pub(crate) all_deleted: Option<smallvec::SmallVec<[Arc<str>; 1]>>,
}
impl ApplyDeletesResult {
  pub(crate) fn any_deletes(&self) -> bool {
    self.any_deletes
  }
  pub(crate) fn all_deleted(&self) -> Option<&[Arc<str>]> {
    self.all_deleted.as_deref()
  }
}