819 lines · 28.1 KB · Rust
RawDownload
// Copyright 2023 The Jujutsu Authors//// Licensed 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//// https://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. #![expect(missing_docs)] use std::iter;use std::marker::PhantomData;use std::sync::Arc; use futures::TryStreamExt as _;use once_cell::sync::OnceCell;use pollster::FutureExt as _;use thiserror::Error; use crate::backend::ChangeId;use crate::backend::CommitId;use crate::hex_util;use crate::index::IndexResult;use crate::index::ResolvedChangeTargets;use crate::object_id::HexPrefix;use crate::object_id::ObjectId;use crate::object_id::PrefixResolution;use crate::repo::Repo;use crate::revset::RevsetEvaluationError;use crate::revset::RevsetExtensions;use crate::revset::RevsetResolutionError;use crate::revset::SymbolResolver;use crate::revset::SymbolResolverExtension;use crate::revset::UserRevsetExpression;use crate::view::View; #[derive(Debug, Error)]pub enum IdPrefixIndexLoadError {    #[error("Failed to resolve short-prefixes disambiguation revset")]    Resolution(#[from] RevsetResolutionError),    #[error("Failed to evaluate short-prefixes disambiguation revset")]    Evaluation(#[from] RevsetEvaluationError),} struct DisambiguationData {    expression: Arc<UserRevsetExpression>,    indexes: OnceCell<Indexes>,} struct Indexes {    commit_change_ids: Vec<(CommitId, ChangeId)>,    commit_index: IdIndex<CommitId, u32, 4>,    change_index: IdIndex<ChangeId, u32, 4>,} impl DisambiguationData {    fn indexes(        &self,        repo: &dyn Repo,        extensions: &[Box<dyn SymbolResolverExtension>],    ) -> Result<&Indexes, IdPrefixIndexLoadError> {        self.indexes.get_or_try_init(|| {            let symbol_resolver = SymbolResolver::new(repo, extensions);            let revset = self                .expression                .resolve_user_expression(repo, &symbol_resolver)?                .evaluate(repo)?;             let commit_change_ids: Vec<_> = revset.commit_change_ids().try_collect().block_on()?;            let mut commit_index = IdIndex::with_capacity(commit_change_ids.len());            let mut change_index = IdIndex::with_capacity(commit_change_ids.len());            for (i, (commit_id, change_id)) in commit_change_ids.iter().enumerate() {                let i: u32 = i.try_into().unwrap();                commit_index.insert(commit_id, i);                change_index.insert(change_id, i);            }            Ok(Indexes {                commit_change_ids,                commit_index: commit_index.build(),                change_index: change_index.build(),            })        })    }} impl<'a> IdIndexSource<u32> for &'a [(CommitId, ChangeId)] {    type Entry = &'a (CommitId, ChangeId);     fn entry_at(&self, pointer: &u32) -> Self::Entry {        &self[*pointer as usize]    }} impl IdIndexSourceEntry<CommitId> for &'_ (CommitId, ChangeId) {    fn to_key(&self) -> CommitId {        let (commit_id, _) = self;        commit_id.clone()    }} impl IdIndexSourceEntry<ChangeId> for &'_ (CommitId, ChangeId) {    fn to_key(&self) -> ChangeId {        let (_, change_id) = self;        change_id.clone()    }} /// Manages configuration and cache of commit/change ID disambiguation index.#[derive(Default)]pub struct IdPrefixContext {    disambiguation: Option<DisambiguationData>,    extensions: Arc<RevsetExtensions>,} impl IdPrefixContext {    pub fn new(extensions: Arc<RevsetExtensions>) -> Self {        Self {            disambiguation: None,            extensions,        }    }     pub fn disambiguate_within(mut self, expression: Arc<UserRevsetExpression>) -> Self {        self.disambiguation = Some(DisambiguationData {            expression,            indexes: OnceCell::new(),        });        self    }     /// Loads disambiguation index once, returns a borrowed index to    /// disambiguate commit/change IDs.    pub fn populate(&self, repo: &dyn Repo) -> Result<IdPrefixIndex<'_>, IdPrefixIndexLoadError> {        let indexes = if let Some(disambiguation) = &self.disambiguation {            Some(disambiguation.indexes(repo, self.extensions.symbol_resolvers())?)        } else {            None        };        Ok(IdPrefixIndex { indexes })    }} /// Loaded index to disambiguate commit/change IDs.pub struct IdPrefixIndex<'a> {    indexes: Option<&'a Indexes>,} impl IdPrefixIndex<'_> {    /// Returns an empty index that just falls back to a provided `repo`.    pub const fn empty() -> IdPrefixIndex<'static> {        IdPrefixIndex { indexes: None }    }     /// Resolve an unambiguous commit ID prefix.    pub fn resolve_commit_prefix(        &self,        repo: &dyn Repo,        prefix: &HexPrefix,    ) -> IndexResult<PrefixResolution<CommitId>> {        if let Some(indexes) = self.indexes {            let resolution = indexes                .commit_index                .resolve_prefix_to_key(&*indexes.commit_change_ids, prefix);            match resolution {                PrefixResolution::NoMatch => {                    // Fall back to resolving in entire repo                }                PrefixResolution::SingleMatch(id) => {                    // The disambiguation set may be loaded from a different repo,                    // and contain a commit that doesn't exist in the current repo.                    if repo.index().has_id(&id)? {                        return Ok(PrefixResolution::SingleMatch(id));                    } else {                        return Ok(PrefixResolution::NoMatch);                    }                }                PrefixResolution::AmbiguousMatch => {                    return Ok(PrefixResolution::AmbiguousMatch);                }            }        }        repo.index().resolve_commit_id_prefix(prefix)    }     /// Returns the shortest length of a prefix of `commit_id` that can still be    /// resolved by `resolve_commit_prefix()` and [`SymbolResolver`].    pub fn shortest_commit_prefix_len(        &self,        repo: &dyn Repo,        commit_id: &CommitId,    ) -> IndexResult<usize> {        let len = self.shortest_commit_prefix_len_exact(repo, commit_id)?;        Ok(disambiguate_prefix_with_refs(            repo.view(),            &commit_id.to_string(),            len,        ))    }     pub fn shortest_commit_prefix_len_exact(        &self,        repo: &dyn Repo,        commit_id: &CommitId,    ) -> IndexResult<usize> {        if let Some(indexes) = self.indexes            && let Some(lookup) = indexes                .commit_index                .lookup_exact(&*indexes.commit_change_ids, commit_id)        {            return Ok(lookup.shortest_unique_prefix_len());        }        repo.index().shortest_unique_commit_id_prefix_len(commit_id)    }     /// Resolve an unambiguous change ID prefix to the commit IDs in the revset.    pub fn resolve_change_prefix(        &self,        repo: &dyn Repo,        prefix: &HexPrefix,    ) -> IndexResult<PrefixResolution<ResolvedChangeTargets>> {        if let Some(indexes) = self.indexes {            let resolution = indexes                .change_index                .resolve_prefix_to_key(&*indexes.commit_change_ids, prefix);            match resolution {                PrefixResolution::NoMatch => {                    // Fall back to resolving in entire repo                }                PrefixResolution::SingleMatch(change_id) => {                    return match repo.resolve_change_id(&change_id)? {                        // There may be more commits with this change id outside the narrower sets.                        Some(commit_ids) => Ok(PrefixResolution::SingleMatch(commit_ids)),                        // The disambiguation set may contain hidden commits.                        None => Ok(PrefixResolution::NoMatch),                    };                }                PrefixResolution::AmbiguousMatch => {                    return Ok(PrefixResolution::AmbiguousMatch);                }            }        }        repo.resolve_change_id_prefix(prefix)    }     /// Returns the shortest length of a prefix of `change_id` that can still be    /// resolved by `resolve_change_prefix()` and [`SymbolResolver`].    pub fn shortest_change_prefix_len(        &self,        repo: &dyn Repo,        change_id: &ChangeId,    ) -> IndexResult<usize> {        let len = self.shortest_change_prefix_len_exact(repo, change_id)?;        Ok(disambiguate_prefix_with_refs(            repo.view(),            &change_id.to_string(),            len,        ))    }     fn shortest_change_prefix_len_exact(        &self,        repo: &dyn Repo,        change_id: &ChangeId,    ) -> IndexResult<usize> {        if let Some(indexes) = self.indexes            && let Some(lookup) = indexes                .change_index                .lookup_exact(&*indexes.commit_change_ids, change_id)        {            return Ok(lookup.shortest_unique_prefix_len());        }        repo.shortest_unique_change_id_prefix_len(change_id)    }} fn disambiguate_prefix_with_refs(view: &View, id_sym: &str, min_len: usize) -> usize {    debug_assert!(id_sym.is_ascii());    (min_len..id_sym.len())        .find(|&n| {            // Tags and bookmarks have higher priority. Extension symbols have            // lower priority.            let prefix = &id_sym[..n];            view.get_local_tag(prefix.as_ref()).is_absent()                && view.get_local_bookmark(prefix.as_ref()).is_absent()        })        // No need to test conflicts with the full ID. We have to return some        // valid length anyway.        .unwrap_or(id_sym.len())} /// In-memory immutable index to do prefix lookup of key `K` through `P`.////// In a nutshell, this is a mapping of `K` -> `P` -> `S::Entry` where `S:/// IdIndexSource<P>`. The source table `S` isn't owned by this index.////// This index stores first `N` bytes of each key `K` associated with the/// pointer `P`. `K` may be a heap-allocated object. `P` is supposed to be/// a cheap value type like `u32` or `usize`. As the index entry of type/// `([u8; N], P)` is small and has no indirect reference, constructing/// the index should be faster than sorting the source `(K, _)` pairs.////// A key `K` must be at least `N` bytes long.#[derive(Clone, Debug)]pub struct IdIndex<K, P, const N: usize> {    // Maybe better to build separate (keys, values) vectors, but there's no std function    // to co-sort them.    index: Vec<([u8; N], P)>,    // Let's pretend [u8; N] above were of type K. It helps type inference, and ensures that    // IdIndexSource has the same key type.    phantom_key: PhantomData<K>,} /// Source table for `IdIndex` to map pointer of type `P` to entry.pub trait IdIndexSource<P> {    type Entry;     fn entry_at(&self, pointer: &P) -> Self::Entry;} /// Source table entry of `IdIndex`, which is conceptually a `(key, value)`/// pair.pub trait IdIndexSourceEntry<K> {    fn to_key(&self) -> K;} #[derive(Clone, Debug)]pub struct IdIndexBuilder<K, P, const N: usize> {    unsorted_index: Vec<([u8; N], P)>,    phantom_key: PhantomData<K>,} impl<K, P, const N: usize> IdIndexBuilder<K, P, N>where    K: ObjectId + Ord,{    /// Inserts new entry. Multiple values can be associated with a single key.    pub fn insert(&mut self, key: &K, pointer: P) {        let short_key = unwrap_as_short_key(key.as_bytes());        self.unsorted_index.push((*short_key, pointer));    }     pub fn build(self) -> IdIndex<K, P, N> {        let mut index = self.unsorted_index;        index.sort_unstable_by_key(|(s, _)| *s);        let phantom_key = self.phantom_key;        IdIndex { index, phantom_key }    }} impl<K, P, const N: usize> IdIndex<K, P, N>where    K: ObjectId + Ord,{    pub fn builder() -> IdIndexBuilder<K, P, N> {        IdIndexBuilder {            unsorted_index: Vec::new(),            phantom_key: PhantomData,        }    }     pub fn with_capacity(capacity: usize) -> IdIndexBuilder<K, P, N> {        IdIndexBuilder {            unsorted_index: Vec::with_capacity(capacity),            phantom_key: PhantomData,        }    }     /// Looks up entries with the given prefix, and collects values if matched    /// entries have unambiguous keys.    pub fn resolve_prefix_with<B, S, U>(        &self,        source: S,        prefix: &HexPrefix,        entry_mapper: impl FnMut(S::Entry) -> U,    ) -> PrefixResolution<(K, B)>    where        B: FromIterator<U>,        S: IdIndexSource<P>,        S::Entry: IdIndexSourceEntry<K>,    {        fn collect<B, K, E, U>(            mut range: impl Iterator<Item = (K, E)>,            mut entry_mapper: impl FnMut(E) -> U,        ) -> PrefixResolution<(K, B)>        where            B: FromIterator<U>,            K: Eq,        {            if let Some((first_key, first_entry)) = range.next() {                let maybe_values: Option<B> = iter::once(Some(entry_mapper(first_entry)))                    .chain(range.map(|(k, e)| (k == first_key).then(|| entry_mapper(e))))                    .collect();                if let Some(values) = maybe_values {                    PrefixResolution::SingleMatch((first_key, values))                } else {                    PrefixResolution::AmbiguousMatch                }            } else {                PrefixResolution::NoMatch            }        }         let min_bytes = prefix.min_prefix_bytes();        if min_bytes.is_empty() {            // We consider an empty prefix ambiguous even if the index has a single entry.            return PrefixResolution::AmbiguousMatch;        }         let to_key_entry_pair = |(_, pointer): &(_, P)| -> (K, S::Entry) {            let entry = source.entry_at(pointer);            (entry.to_key(), entry)        };        if min_bytes.len() > N {            // If the min prefix (including odd byte) is longer than the stored short keys,            // we are sure that min_bytes[..N] does not include the odd byte. Use it to            // take contiguous range, then filter by (longer) prefix.matches().            let short_bytes = unwrap_as_short_key(min_bytes);            let pos = self.index.partition_point(|(s, _)| s < short_bytes);            let range = self.index[pos..]                .iter()                .take_while(|(s, _)| s == short_bytes)                .map(to_key_entry_pair)                .filter(|(k, _)| prefix.matches(k));            collect(range, entry_mapper)        } else {            // Otherwise, use prefix.matches() to deal with odd byte. Since the prefix is            // covered by short key width, we're sure that the matching prefixes are sorted.            let pos = self.index.partition_point(|(s, _)| &s[..] < min_bytes);            let range = self.index[pos..]                .iter()                .map(to_key_entry_pair)                .take_while(|(k, _)| prefix.matches(k));            collect(range, entry_mapper)        }    }     /// Looks up unambiguous key with the given prefix.    pub fn resolve_prefix_to_key<S>(&self, source: S, prefix: &HexPrefix) -> PrefixResolution<K>    where        S: IdIndexSource<P>,        S::Entry: IdIndexSourceEntry<K>,    {        self.resolve_prefix_with(source, prefix, |_| ())            .map(|(key, ())| key)    }     /// Looks up entry for the key. Returns accessor to neighbors.    pub fn lookup_exact<'i, 'q, S>(        &'i self,        source: S,        key: &'q K,    ) -> Option<IdIndexLookup<'i, 'q, K, P, S, N>>    where        S: IdIndexSource<P>,        S::Entry: IdIndexSourceEntry<K>,    {        let lookup = self.lookup_some(source, key);        lookup.has_key().then_some(lookup)    }     fn lookup_some<'i, 'q, S>(&'i self, source: S, key: &'q K) -> IdIndexLookup<'i, 'q, K, P, S, N>    where        S: IdIndexSource<P>,    {        let short_key = unwrap_as_short_key(key.as_bytes());        let index = &self.index;        let pos = index.partition_point(|(s, _)| s < short_key);        IdIndexLookup {            index,            source,            key,            pos,        }    }     /// This function returns the shortest length of a prefix of `key` that    /// disambiguates it from every other key in the index.    ///    /// The length to be returned is a number of hexadecimal digits.    ///    /// This has some properties that we do not currently make much use of:    ///    /// - The algorithm works even if `key` itself is not in the index.    ///    /// - In the special case when there are keys in the trie for which our    ///   `key` is an exact prefix, returns `key.len() + 1`. Conceptually, in    ///   order to disambiguate, you need every letter of the key *and* the    ///   additional fact that it's the entire key). This case is extremely    ///   unlikely for hashes with 12+ hexadecimal characters.    pub fn shortest_unique_prefix_len<S>(&self, source: S, key: &K) -> usize    where        S: IdIndexSource<P>,        S::Entry: IdIndexSourceEntry<K>,    {

Lines 1–500 of 819.