use std::fs::File; use std::os::unix::io::{AsRawFd, FromRawFd}; use std::path::Path; use std::sync::Arc; use anyhow::{bail, Error}; use nix::dir::Dir; use proxmox_sys::fs::lock_dir_noblock_shared; use pbs_api_types::{BackupNamespace, Operation}; use crate::backup_info::BackupDir; use crate::dynamic_index::DynamicIndexReader; use crate::fixed_index::FixedIndexReader; use crate::index::IndexFile; use crate::manifest::{archive_type, ArchiveType, CLIENT_LOG_BLOB_NAME, MANIFEST_BLOB_NAME}; use crate::DataStore; /// Helper to access the contents of a datastore backup snapshot /// /// This make it easy to iterate over all used chunks and files. pub struct SnapshotReader { snapshot: BackupDir, datastore_name: String, file_list: Vec, locked_dir: Dir, } impl SnapshotReader { /// Lock snapshot, reads the manifest and returns a new instance pub fn new( datastore: Arc, ns: BackupNamespace, snapshot: pbs_api_types::BackupDir, ) -> Result { Self::new_do(datastore.backup_dir(ns, snapshot)?) } pub(crate) fn new_do(snapshot: BackupDir) -> Result { let datastore = snapshot.datastore(); let snapshot_path = snapshot.full_path(); let locked_dir = lock_dir_noblock_shared(&snapshot_path, "snapshot", "locked by another operation")?; let datastore_name = datastore.name().to_string(); let manifest = match snapshot.load_manifest() { Ok((manifest, _)) => manifest, Err(err) => { bail!( "manifest load error on datastore '{}' snapshot '{}' - {}", datastore_name, snapshot, err ); } }; let mut client_log_path = snapshot_path; client_log_path.push(CLIENT_LOG_BLOB_NAME); let mut file_list = Vec::new(); file_list.push(MANIFEST_BLOB_NAME.to_string()); for item in manifest.files() { file_list.push(item.filename.clone()); } if client_log_path.exists() { file_list.push(CLIENT_LOG_BLOB_NAME.to_string()); } Ok(Self { snapshot, datastore_name, file_list, locked_dir, }) } /// Return the snapshot directory pub fn snapshot(&self) -> &BackupDir { &self.snapshot } /// Return the datastore name pub fn datastore_name(&self) -> &str { &self.datastore_name } /// Returns the list of files the snapshot refers to. pub fn file_list(&self) -> &Vec { &self.file_list } /// Opens a file inside the snapshot (using openat) for reading pub fn open_file(&self, filename: &str) -> Result { let raw_fd = nix::fcntl::openat( self.locked_dir.as_raw_fd(), Path::new(filename), nix::fcntl::OFlag::O_RDONLY, nix::sys::stat::Mode::empty(), )?; let file = unsafe { File::from_raw_fd(raw_fd) }; Ok(file) } /// Returns an iterator for all chunks not skipped by `skip_fn`. pub fn chunk_iterator bool>( &self, skip_fn: F, ) -> Result, Error> { SnapshotChunkIterator::new(self, skip_fn) } } /// Iterates over all chunks used by a backup snapshot /// /// Note: The iterator returns a `Result`, and the iterator state is /// undefined after the first error. So it make no sense to continue /// iteration after the first error. pub struct SnapshotChunkIterator<'a, F: Fn(&[u8; 32]) -> bool> { snapshot_reader: &'a SnapshotReader, todo_list: Vec, skip_fn: F, current_index: Option<(Arc>, usize, Vec<(usize, u64)>)>, } impl<'a, F: Fn(&[u8; 32]) -> bool> Iterator for SnapshotChunkIterator<'a, F> { type Item = Result<[u8; 32], Error>; fn next(&mut self) -> Option { proxmox_lang::try_block!({ loop { if self.current_index.is_none() { if let Some(filename) = self.todo_list.pop() { let file = self.snapshot_reader.open_file(&filename)?; let index: Box = match archive_type(&filename)? { ArchiveType::FixedIndex => Box::new(FixedIndexReader::new(file)?), ArchiveType::DynamicIndex => Box::new(DynamicIndexReader::new(file)?), _ => bail!( "SnapshotChunkIterator: got unknown file type - internal error" ), }; let datastore = DataStore::lookup_datastore( self.snapshot_reader.datastore_name(), Some(Operation::Read), )?; let order = datastore.get_chunks_in_order(&index, &self.skip_fn, |_| Ok(()))?; self.current_index = Some((Arc::new(index), 0, order)); } else { return Ok(None); } } let (index, pos, list) = self.current_index.take().unwrap(); if pos < list.len() { let (real_pos, _) = list[pos]; let digest = *index.index_digest(real_pos).unwrap(); self.current_index = Some((index, pos + 1, list)); return Ok(Some(digest)); } else { // pop next index } } }) .transpose() } } impl<'a, F: Fn(&[u8; 32]) -> bool> SnapshotChunkIterator<'a, F> { pub fn new(snapshot_reader: &'a SnapshotReader, skip_fn: F) -> Result { let mut todo_list = Vec::new(); for filename in snapshot_reader.file_list() { match archive_type(filename)? { ArchiveType::FixedIndex | ArchiveType::DynamicIndex => { todo_list.push(filename.to_owned()); } ArchiveType::Blob => { /* no chunks, do nothing */ } } } Ok(Self { snapshot_reader, todo_list, current_index: None, skip_fn, }) } }