##// END OF EJS Templates
rust: fix unsound `OwningDirstateMap`...
rust: fix unsound `OwningDirstateMap` As per the previous patch, `OwningDirstateMap` is unsound. Self-referential structs are difficult to implement correctly in Rust since the compiler is free to move structs around as much as it wants to. They are also very rarely needed in practice, so the state-of-the-art on how they should be done within the Rust rules is still a bit new. The crate `ouroboros` is an attempt at providing a safe way (in the Rust sense) of declaring self-referential structs. It is getting a lot attention and was improved very quickly when soundness issues were found in the past: rather than relying on our own (limited) review circle, we might as well use the de-facto common crate to fix this problem. This will give us a much better chance of finding issues should any new ones be discovered as well as the benefit of fewer `unsafe` APIs of our own. I was starting to think about how I would present a safe API to the old struct but soon realized that the callback-based approach was already done in `ouroboros`, along with a lot more care towards refusing incorrect structs. In short: we don't return a mutable reference to the `DirstateMap` anymore, we expect users of its API to pass a `FnOnce` that takes the map as an argument. This allows our `OwningDirstateMap` to control the input and output lifetimes of the code that modifies it to prevent such issues. Changing to `ouroboros` meant changing every API with it, but it is relatively low churn in the end. It correctly identified the example buggy modification of `copy_map_insert` outlined in the previous patch as violating the borrow rules. Differential Revision: https://phab.mercurial-scm.org/D12429

File last commit:

r49372:20d0d896 default
r49857:c9f44fc9 stable
Show More
cat.rs
114 lines | 3.2 KiB | application/rls-services+xml | RustLexer
Antoine Cezar
hg-core: add a `CatRev` operation...
r46112 // list_tracked_files.rs
//
// Copyright 2020 Antoine Cezar <antoine.cezar@octobus.net>
//
// This software may be used and distributed according to the terms of the
// GNU General Public License version 2 or any later version.
Simon Sapin
rust: introduce Repo and Vfs types for filesystem abstraction...
r46782 use crate::repo::Repo;
Antoine Cezar
hg-core: add a `CatRev` operation...
r46112 use crate::revlog::revlog::RevlogError;
Simon Sapin
rust: use NodePrefix::from_hex instead of hex::decode directly...
r46647 use crate::revlog::Node;
Simon Sapin
rust: Add a Filelog struct that wraps Revlog...
r48775
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 use crate::utils::hg_path::HgPath;
Antoine Cezar
hg-core: add a `CatRev` operation...
r46112
Simon Sapin
rhg: Propogate manifest parse errors instead of panicking...
r49165 use crate::errors::HgError;
Simon Sapin
rhg: Also parse flags in the manifest parser...
r49166 use crate::manifest::Manifest;
use crate::manifest::ManifestEntry;
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 use itertools::put_back;
use itertools::PutBack;
use std::cmp::Ordering;
Arseniy Alekseyev
rhg: faster hg cat when many files are requested...
r49038
Arseniy Alekseyev
rhg: internally, return a structured representation from hg cat...
r49051 pub struct CatOutput<'a> {
Simon Sapin
rhg: `cat` command: print error messages for missing files...
r47478 /// Whether any file in the manifest matched the paths given as CLI
/// arguments
pub found_any: bool,
/// The contents of matching files, in manifest order
Arseniy Alekseyev
rhg: internally, return a structured representation from hg cat...
r49051 pub results: Vec<(&'a HgPath, Vec<u8>)>,
Simon Sapin
rhg: `cat` command: print error messages for missing files...
r47478 /// Which of the CLI arguments did not match any manifest file
Arseniy Alekseyev
rhg: internally, return a structured representation from hg cat...
r49051 pub missing: Vec<&'a HgPath>,
Simon Sapin
rhg: `cat` command: print error messages for missing files...
r47478 /// The node ID that the given revset was resolved to
pub node: Node,
}
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 // Find an item in an iterator over a sorted collection.
Simon Sapin
rhg: Also parse flags in the manifest parser...
r49166 fn find_item<'a>(
i: &mut PutBack<impl Iterator<Item = Result<ManifestEntry<'a>, HgError>>>,
Simon Sapin
rhg: Propogate manifest parse errors instead of panicking...
r49165 needle: &HgPath,
Simon Sapin
rhg: Also parse flags in the manifest parser...
r49166 ) -> Result<Option<Node>, HgError> {
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 loop {
match i.next() {
Simon Sapin
rhg: Propogate manifest parse errors instead of panicking...
r49165 None => return Ok(None),
Some(result) => {
Simon Sapin
rhg: Also parse flags in the manifest parser...
r49166 let entry = result?;
match needle.as_bytes().cmp(entry.path.as_bytes()) {
Simon Sapin
rhg: Propogate manifest parse errors instead of panicking...
r49165 Ordering::Less => {
Simon Sapin
rhg: Also parse flags in the manifest parser...
r49166 i.put_back(Ok(entry));
Simon Sapin
rhg: Propogate manifest parse errors instead of panicking...
r49165 return Ok(None);
}
Ordering::Greater => continue,
Simon Sapin
rhg: Also parse flags in the manifest parser...
r49166 Ordering::Equal => return Ok(Some(entry.node_id()?)),
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 }
Simon Sapin
rhg: Propogate manifest parse errors instead of panicking...
r49165 }
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 }
}
}
Simon Sapin
rhg: Also parse flags in the manifest parser...
r49166 fn find_files_in_manifest<'query>(
manifest: &Manifest,
query: impl Iterator<Item = &'query HgPath>,
) -> Result<(Vec<(&'query HgPath, Node)>, Vec<&'query HgPath>), HgError> {
let mut manifest = put_back(manifest.iter());
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 let mut res = vec![];
let mut missing = vec![];
Arseniy Alekseyev
rhg: internally, return a structured representation from hg cat...
r49051 for file in query {
Simon Sapin
rhg: Propogate manifest parse errors instead of panicking...
r49165 match find_item(&mut manifest, file)? {
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 None => missing.push(file),
Arseniy Alekseyev
rhg: internally, return a structured representation from hg cat...
r49051 Some(item) => res.push((file, item)),
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 }
}
Simon Sapin
rhg: Propogate manifest parse errors instead of panicking...
r49165 return Ok((res, missing));
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 }
Simon Sapin
rhg: `cat` command: print error messages for missing files...
r47478 /// Output the given revision of files
Simon Sapin
rust: replace most "operation" structs with functions...
r46751 ///
/// * `root`: Repository root
/// * `rev`: The revision to cat the files from.
/// * `files`: The files to output.
Simon Sapin
rhg: `cat` command: print error messages for missing files...
r47478 pub fn cat<'a>(
Simon Sapin
rust: introduce Repo and Vfs types for filesystem abstraction...
r46782 repo: &Repo,
Simon Sapin
rhg: centralize parsing of `--rev` CLI arguments...
r47162 revset: &str,
Arseniy Alekseyev
rhg: internally, return a structured representation from hg cat...
r49051 mut files: Vec<&'a HgPath>,
) -> Result<CatOutput<'a>, RevlogError> {
Simon Sapin
rhg: centralize parsing of `--rev` CLI arguments...
r47162 let rev = crate::revset::resolve_single(revset, repo)?;
Simon Sapin
rhg: Reuse manifest when checking status of multiple ambiguous files...
r48778 let manifest = repo.manifest_for_rev(rev)?;
Simon Sapin
rust: Add Repo::manifest(revision)...
r48774 let node = *repo
.changelog()?
Simon Sapin
rhg: `cat` command: print error messages for missing files...
r47478 .node_from_rev(rev)
Simon Sapin
rust: Add Repo::manifest(revision)...
r48774 .expect("should succeed when repo.manifest did");
Arseniy Alekseyev
rhg: internally, return a structured representation from hg cat...
r49051 let mut results: Vec<(&'a HgPath, Vec<u8>)> = vec![];
Simon Sapin
rhg: `cat` command: print error messages for missing files...
r47478 let mut found_any = false;
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039
Arseniy Alekseyev
rhg: faster hg cat when many files are requested...
r49038 files.sort_unstable();
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 let (found, missing) = find_files_in_manifest(
Simon Sapin
rhg: Also parse flags in the manifest parser...
r49166 &manifest,
Arseniy Alekseyev
rhg: internally, return a structured representation from hg cat...
r49051 files.into_iter().map(|f| f.as_ref()),
Simon Sapin
rhg: Propogate manifest parse errors instead of panicking...
r49165 )?;
Antoine Cezar
hg-core: add a `CatRev` operation...
r46112
Simon Sapin
rhg: Also parse flags in the manifest parser...
r49166 for (file_path, file_node) in found {
Arseniy Alekseyev
rhg: stop manifest traversal when no more files are needed...
r49039 found_any = true;
Arseniy Alekseyev
rhg: internally, return a structured representation from hg cat...
r49051 let file_log = repo.filelog(file_path)?;
results.push((
file_path,
Simon Sapin
rhg: Rename some revlog-related types and methods...
r49372 file_log.data_for_node(file_node)?.into_file_data()?,
Arseniy Alekseyev
rhg: internally, return a structured representation from hg cat...
r49051 ));
Antoine Cezar
hg-core: add a `CatRev` operation...
r46112 }
Simon Sapin
rhg: `cat` command: print error messages for missing files...
r47478 Ok(CatOutput {
found_any,
Arseniy Alekseyev
rhg: internally, return a structured representation from hg cat...
r49051 results,
Simon Sapin
rhg: `cat` command: print error messages for missing files...
r47478 missing,
node,
})
Antoine Cezar
hg-core: add a `CatRev` operation...
r46112 }