use std::io::Write; use git_features::hash; use git_hash::ObjectId; use crate::{data, data::output, find}; /// pub mod iter_from_counts; pub use iter_from_counts::iter_from_counts; /// An entry to be written to a file. /// /// Some of these will be in-flight and in memory while waiting to be written. Memory requirements depend on the amount of compressed /// data they hold. #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)] #[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))] pub struct Entry { /// The hash of the object to write pub id: ObjectId, /// The kind of entry represented by `data`. It's used alongside with it to complete the pack entry /// at rest or in transit. pub kind: Kind, /// The size in bytes needed once `data` gets decompressed pub decompressed_size: usize, /// The compressed data right behind the header pub compressed_data: Vec, } /// The kind of pack entry to be written #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)] #[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))] pub enum Kind { /// A complete base object, including its kind Base(git_object::Kind), /// A delta against the object with the given index. It's always an index that was already encountered to refer only /// to object we have written already. DeltaRef { /// The absolute index to the object to serve as base. It's up to the writer to maintain enough state to allow producing /// a packed delta object from it. object_index: usize, }, /// A delta against the given object as identified by its `ObjectId`. /// This is the case for thin packs only, i.e. those that are sent over the wire. /// Note that there is the option of the `ObjectId` being used to refer to an object within /// the same pack, but it's a discontinued practice which won't be encountered here. DeltaOid { /// The object serving as base for this delta id: ObjectId, }, } /// The error returned by [`output::Entry::from_data()`]. #[allow(missing_docs)] #[derive(Debug, thiserror::Error)] pub enum Error { #[error("{0}")] ZlibDeflate(#[from] std::io::Error), #[error("Entry expected to have hash {expected}, but it had {actual}")] PackToPackCopyCrc32Mismatch { actual: u32, expected: u32 }, } impl output::Entry { /// An object which can be identified as invalid easily which happens if objects didn't exist even if they were referred to. pub fn invalid() -> Entry { Entry { id: ObjectId::null_sha1(), kind: Kind::Base(git_object::Kind::Blob), decompressed_size: 0, compressed_data: vec![], } } /// Returns true if this object doesn't really exist but still has to be handled responsibly pub fn is_invalid(&self) -> bool { self.id.is_null() } /// Create an Entry from a previously counted object which is located in a pack. It's `entry` is provided here. /// The `version` specifies what kind of target `Entry` version the caller desires. pub fn from_pack_entry( entry: find::Entry<'_>, count: &output::Count, potential_bases: &[output::Count], bases_index_offset: usize, pack_offset_to_oid: Option Option>, target_version: crate::data::Version, ) -> Option> { if entry.version != target_version { return None; }; let pack_offset_must_be_zero = 0; let pack_entry = crate::data::Entry::from_bytes(entry.data, pack_offset_must_be_zero); if let Some(expected) = entry.crc32 { let actual = hash::crc32(entry.data); if actual != expected { return Some(Err(Error::PackToPackCopyCrc32Mismatch { actual, expected })); } } use crate::data::entry::Header::*; match pack_entry.header { Commit => Some(output::entry::Kind::Base(git_object::Kind::Commit)), Tree => Some(output::entry::Kind::Base(git_object::Kind::Tree)), Blob => Some(output::entry::Kind::Base(git_object::Kind::Blob)), Tag => Some(output::entry::Kind::Base(git_object::Kind::Tag)), OfsDelta { base_distance } => { let pack_location = count.entry_pack_location.as_ref().expect("packed"); let base_offset = pack_location .pack_offset .checked_sub(base_distance) .expect("pack-offset - distance is firmly within the pack"); potential_bases .binary_search_by(|e| { e.entry_pack_location .as_ref() .expect("packed") .pack_offset .cmp(&base_offset) }) .ok() .map(|idx| output::entry::Kind::DeltaRef { object_index: idx + bases_index_offset, }) .or_else(|| { pack_offset_to_oid .and_then(|mut f| f(pack_location.pack_id, base_offset)) .map(|id| output::entry::Kind::DeltaOid { id }) }) } RefDelta { base_id: _ } => None, // ref deltas are for thin packs or legacy, repack them as base objects } .map(|kind| { Ok(output::Entry { id: count.id.to_owned(), kind, decompressed_size: pack_entry.decompressed_size as usize, compressed_data: entry.data[pack_entry.data_offset as usize..].to_owned(), }) }) } /// Create a new instance from the given `oid` and its corresponding git `obj`ect data. pub fn from_data(count: &output::Count, obj: &data::Object<'_>) -> Result { Ok(output::Entry { id: count.id.to_owned(), kind: Kind::Base(obj.kind), decompressed_size: obj.data.len(), compressed_data: { let mut out = git_features::zlib::stream::deflate::Write::new(Vec::new()); if let Err(err) = std::io::copy(&mut &*obj.data, &mut out) { match err.kind() { std::io::ErrorKind::Other => return Err(Error::ZlibDeflate(err)), err => unreachable!("Should never see other errors than zlib, but got {:?}", err,), } }; out.flush()?; out.into_inner() }, }) } /// Transform ourselves into pack entry header of `version` which can be written into a pack. /// /// `index_to_pack(object_index) -> pack_offset` is a function to convert the base object's index into /// the input object array (if each object is numbered) to an offset into the pack. /// This information is known to the one calling the method. pub fn to_entry_header( &self, version: crate::data::Version, index_to_base_distance: impl FnOnce(usize) -> u64, ) -> crate::data::entry::Header { assert!( matches!(version, data::Version::V2), "we can only write V2 pack entries for now" ); use Kind::*; match self.kind { Base(kind) => { use git_object::Kind::*; match kind { Tree => data::entry::Header::Tree, Blob => data::entry::Header::Blob, Commit => data::entry::Header::Commit, Tag => data::entry::Header::Tag, } } DeltaOid { id } => data::entry::Header::RefDelta { base_id: id.to_owned() }, DeltaRef { object_index } => data::entry::Header::OfsDelta { base_distance: index_to_base_distance(object_index), }, } } }