1 //! *pxar* format encoder.
3 //! This module contain the code to generate *pxar* archive files.
6 use endian_trait
::Endian
;
7 use std
::collections
::{HashSet, HashMap}
;
10 use super::format_definition
::*;
11 use super::binary_search_tree
::*;
13 use super::match_pattern
::*;
15 use crate::tools
::acl
;
16 use crate::tools
::xattr
;
19 use std
::os
::unix
::io
::AsRawFd
;
20 use std
::os
::unix
::ffi
::OsStrExt
;
21 use std
::os
::unix
::io
::RawFd
;
22 use std
::path
::{Path, PathBuf}
;
27 use nix
::fcntl
::OFlag
;
28 use nix
::sys
::stat
::Mode
;
29 use nix
::errno
::Errno
;
30 use nix
::sys
::stat
::FileStat
;
32 use proxmox
::tools
::vec
;
34 /// The format requires to build sorted directory lookup tables in
35 /// memory, so we restrict the number of allowed entries to limit
36 /// maximum memory usage.
37 pub const MAX_DIRECTORY_ENTRIES
: usize = 256*1024;
39 #[derive(Eq, PartialEq, Hash)]
45 pub struct Encoder
<'a
, W
: Write
> {
47 relative_path
: PathBuf
,
51 file_copy_buffer
: Vec
<u8>,
52 device_set
: Option
<HashSet
<u64>>,
54 // Flags set by the user
56 // Flags signaling features supported by the filesystem
57 fs_feature_flags
: u64,
58 hardlinks
: HashMap
<HardLinkInfo
, (PathBuf
, u64)>,
61 impl <'a
, W
: Write
> Encoder
<'a
, W
> {
63 // used for error reporting
64 fn full_path(&self) -> PathBuf
{
65 self.base_path
.join(&self.relative_path
)
68 /// Create archive, write result data to ``writer``.
70 /// The ``device_set`` can be use used to limit included mount points.
72 /// - ``None``: include all mount points
73 /// - ``Some(set)``: only include devices listed in this set (the
74 /// root path device is automathically added to this list, so
75 /// you can pass an empty set if you want to archive a single
79 dir
: &mut nix
::dir
::Dir
,
81 device_set
: Option
<HashSet
<u64>>,
83 skip_lost_and_found
: bool
, // fixme: should be a feature flag ??
85 ) -> Result
<(), Error
> {
87 const FILE_COPY_BUFFER_SIZE
: usize = 1024*1024;
89 let mut file_copy_buffer
= Vec
::with_capacity(FILE_COPY_BUFFER_SIZE
);
90 unsafe { file_copy_buffer.set_len(FILE_COPY_BUFFER_SIZE); }
93 // todo: use scandirat??
95 let dir_fd
= dir
.as_raw_fd();
96 let stat
= nix
::sys
::stat
::fstat(dir_fd
)
97 .map_err(|err
| format_err
!("fstat {:?} failed - {}", path
, err
))?
;
99 if !is_directory(&stat
) {
100 bail
!("got unexpected file type {:?} (not a directory)", path
);
103 let mut device_set
= device_set
.clone();
104 if let Some(ref mut set
) = device_set
{
105 set
.insert(stat
.st_dev
);
108 let magic
= detect_fs_type(dir_fd
)?
;
110 if is_virtual_file_system(magic
) {
111 bail
!("backup virtual file systems is disabled!");
114 let fs_feature_flags
= flags
::feature_flags_from_magic(magic
);
118 relative_path
: PathBuf
::new(),
127 hardlinks
: HashMap
::new(),
130 if verbose { println!("{:?}
", me.full_path()); }
132 let mut excludes = Vec::new();
133 if skip_lost_and_found {
134 excludes.push(MatchPattern::from_line(b"**/lost
+found
").unwrap().unwrap());
136 me.encode_dir(dir, &stat, magic, excludes)?;
141 fn write(&mut self, buf: &[u8]) -> Result<(), Error> {
142 self.writer.write_all(buf)?;
143 self.writer_pos += buf.len();
147 fn write_item<T: Endian>(&mut self, item: T) -> Result<(), Error> {
149 let data = item.to_le();
151 let buffer = unsafe { std::slice::from_raw_parts(
152 &data as *const T as *const u8,
153 std::mem::size_of::<T>()
161 fn flush_copy_buffer(&mut self, size: usize) -> Result<(), Error> {
162 self.writer.write_all(&self.file_copy_buffer[..size])?;
163 self.writer_pos += size;
167 fn write_header(&mut self, htype: u64, size: u64) -> Result<(), Error> {
169 let size = size + (std::mem::size_of::<PxarHeader>() as u64);
170 self.write_item(PxarHeader { size, htype })?;
175 fn write_filename(&mut self, name: &CStr) -> Result<(), Error> {
177 let buffer = name.to_bytes_with_nul();
178 self.write_header(PXAR_FILENAME, buffer.len() as u64)?;
184 fn create_entry(&self, stat: &FileStat) -> Result<PxarEntry, Error> {
186 let mode = if is_symlink(&stat) {
187 (libc::S_IFLNK | 0o777) as u64
189 (stat.st_mode & (libc::S_IFMT | 0o7777)) as u64
192 let mtime = stat.st_mtime * 1_000_000_000 + stat.st_mtime_nsec;
194 bail!("got strange
mtime ({}
) from fstat
for {:?}
.", mtime, self.full_path());
198 let entry = PxarEntry {
209 fn read_chattr(&self, fd: RawFd, entry: &mut PxarEntry) -> Result<(), Error> {
211 let mut attr: usize = 0;
213 let res = unsafe { fs::read_attr_fd(fd, &mut attr)};
214 if let Err(err) = res {
215 if let nix::Error::Sys(errno) = err {
216 if errno_is_unsupported(errno) { return Ok(()) };
218 bail!("read_attr_fd failed
for {:?}
- {}
", self.full_path(), err);
221 let flags = flags::feature_flags_from_chattr(attr as u32);
222 entry.flags = entry.flags | flags;
227 fn read_fat_attr(&self, fd: RawFd, magic: i64, entry: &mut PxarEntry) -> Result<(), Error> {
228 use proxmox::sys::linux::magic::*;
230 if magic != MSDOS_SUPER_MAGIC && magic != FUSE_SUPER_MAGIC {
234 let mut attr: u32 = 0;
236 let res = unsafe { fs::read_fat_attr_fd(fd, &mut attr)};
237 if let Err(err) = res {
238 if let nix::Error::Sys(errno) = err {
239 if errno_is_unsupported(errno) { return Ok(()) };
241 bail!("read_fat_attr_fd failed
for {:?}
- {}
", self.full_path(), err);
244 let flags = flags::feature_flags_from_fat_attr(attr);
245 entry.flags = entry.flags | flags;
250 /// True if all of the given feature flags are set in the Encoder, false otherwise
251 fn has_features(&self, feature_flags: u64) -> bool {
252 (self.feature_flags & self.fs_feature_flags & feature_flags) == feature_flags
255 /// True if at least one of the given feature flags is set in the Encoder, false otherwise
256 fn has_some_features(&self, feature_flags: u64) -> bool {
257 (self.feature_flags & self.fs_feature_flags & feature_flags) != 0
260 fn read_xattrs(&self, fd: RawFd, stat: &FileStat) -> Result<(Vec<PxarXAttr>, Option<PxarFCaps>), Error> {
261 let mut xattrs = Vec::new();
262 let mut fcaps = None;
264 let flags = flags::WITH_XATTRS | flags::WITH_FCAPS;
265 if !self.has_some_features(flags) {
266 return Ok((xattrs, fcaps));
268 // Should never be called on symlinks, just in case check anyway
269 if is_symlink(&stat) {
270 return Ok((xattrs, fcaps));
273 let xattr_names = match xattr::flistxattr(fd) {
275 // Do not bail if the underlying endpoint does not supports xattrs
276 Err(Errno::EOPNOTSUPP) => return Ok((xattrs, fcaps)),
277 // Do not bail if the endpoint cannot carry xattrs (such as symlinks)
278 Err(Errno::EBADF) => return Ok((xattrs, fcaps)),
279 Err(err) => bail!("read_xattrs failed
for {:?}
- {}
", self.full_path(), err),
282 for name in xattr_names.split(|c| *c == b'\0') {
283 // Only extract the relevant extended attributes
284 if !xattr::is_valid_xattr_name(&name) {
288 let value = match xattr::fgetxattr(fd, name) {
290 // Vanished between flistattr and getxattr, this is ok, silently ignore
291 Err(Errno::ENODATA) => continue,
292 Err(err) => bail!("read_xattrs failed
for {:?}
- {}
", self.full_path(), err),
295 if xattr::is_security_capability(&name) {
296 if self.has_features(flags::WITH_FCAPS) {
297 // fcaps are stored in own format within the archive
298 fcaps = Some(PxarFCaps {
302 } else if self.has_features(flags::WITH_XATTRS) {
303 xattrs.push(PxarXAttr {
314 fn read_acl(&self, fd: RawFd, stat: &FileStat, acl_type: acl::ACLType) -> Result<PxarACL, Error> {
322 if !self.has_features(flags::WITH_ACL) {
325 if is_symlink(&stat) {
328 if acl_type == acl::ACL_TYPE_DEFAULT && !is_directory(&stat) {
329 bail!("ACL_TYPE_DEFAULT only defined
for directories
.");
332 // In order to be able to get ACLs with type ACL_TYPE_DEFAULT, we have
333 // to create a path for acl_get_file(). acl_get_fd() only allows to get
334 // ACL_TYPE_ACCESS attributes.
335 let proc_path = Path::new("/proc
/self/fd
/").join(fd.to_string());
336 let acl = match acl::ACL::get_file(&proc_path, acl_type) {
338 // Don't bail if underlying endpoint does not support acls
339 Err(Errno::EOPNOTSUPP) => return Ok(ret),
340 // Don't bail if the endpoint cannot carry acls
341 Err(Errno::EBADF) => return Ok(ret),
342 // Don't bail if there is no data
343 Err(Errno::ENODATA) => return Ok(ret),
344 Err(err) => bail!("error
while reading ACL
- {}
", err),
347 self.process_acl(acl, acl_type)
350 fn process_acl(&self, acl: acl::ACL, acl_type: acl::ACLType) -> Result<PxarACL, Error> {
351 let mut acl_user = Vec::new();
352 let mut acl_group = Vec::new();
353 let mut acl_group_obj = None;
354 let mut acl_default = None;
355 let mut user_obj_permissions = None;
356 let mut group_obj_permissions = None;
357 let mut other_permissions = None;
358 let mut mask_permissions = None;
360 for entry in &mut acl.entries() {
361 let tag = entry.get_tag_type()?;
362 let permissions = entry.get_permissions()?;
364 acl::ACL_USER_OBJ => user_obj_permissions = Some(permissions),
365 acl::ACL_GROUP_OBJ => group_obj_permissions = Some(permissions),
366 acl::ACL_OTHER => other_permissions = Some(permissions),
367 acl::ACL_MASK => mask_permissions = Some(permissions),
369 acl_user.push(PxarACLUser {
370 uid: entry.get_qualifier()?,
371 permissions: permissions,
375 acl_group.push(PxarACLGroup {
376 gid: entry.get_qualifier()?,
377 permissions: permissions,
380 _ => bail!("Unexpected ACL tag encountered
!"),
388 acl::ACL_TYPE_ACCESS => {
389 // The mask permissions are mapped to the stat group permissions
390 // in case that the ACL group permissions were set.
391 // Only in that case we need to store the group permissions,
392 // in the other cases they are identical to the stat group permissions.
393 if let (Some(gop), Some(_)) = (group_obj_permissions, mask_permissions) {
394 acl_group_obj = Some(PxarACLGroupObj {
399 acl::ACL_TYPE_DEFAULT => {
400 if user_obj_permissions != None ||
401 group_obj_permissions != None ||
402 other_permissions != None ||
403 mask_permissions != None
405 acl_default = Some(PxarACLDefault {
406 // The value is set to UINT64_MAX as placeholder if one
407 // of the permissions is not set
408 user_obj_permissions: user_obj_permissions.unwrap_or(std::u64::MAX),
409 group_obj_permissions: group_obj_permissions.unwrap_or(std::u64::MAX),
410 other_permissions: other_permissions.unwrap_or(std::u64::MAX),
411 mask_permissions: mask_permissions.unwrap_or(std::u64::MAX),
415 _ => bail!("Unexpected ACL
type encountered
"),
421 group_obj: acl_group_obj,
422 default: acl_default,
426 /// Read the quota project id for an inode, supported on ext4/XFS/FUSE/ZFS filesystems
427 fn read_quota_project_id(&self, fd: RawFd, magic: i64, stat: &FileStat) -> Result<Option<PxarQuotaProjID>, Error> {
428 if !(is_directory(&stat) || is_reg_file(&stat)) {
431 if !self.has_features(flags::WITH_QUOTA_PROJID) {
435 use proxmox::sys::linux::magic::*;
442 let mut fsxattr = fs::FSXAttr::default();
444 fs::fs_ioc_fsgetxattr(fd, &mut fsxattr)
447 // On some FUSE filesystems it can happen that ioctl is not supported.
448 // For these cases projid is set to 0 while the error is ignored.
449 if let Err(err) = res {
450 let errno = err.as_errno().ok_or_else(|| {
451 format_err!("error
while reading quota project id
for {:#?}
", self.full_path())
453 if errno_is_unsupported(errno) {
456 bail!("error
while reading quota project id
for {:#?}
- {}
", self.full_path(), errno);
460 let projid = fsxattr.fsx_projid as u64;
464 return Ok(Some(PxarQuotaProjID { projid }));
467 _ => return Ok(None),
471 fn write_entry(&mut self, entry: PxarEntry) -> Result<(), Error> {
473 self.write_header(PXAR_ENTRY, std::mem::size_of::<PxarEntry>() as u64)?;
474 self.write_item(entry)?;
479 fn write_xattr(&mut self, xattr: PxarXAttr) -> Result<(), Error> {
480 let size = xattr.name.len() + xattr.value.len() + 1; // +1 for '\0' separating name and value
481 self.write_header(PXAR_XATTR, size as u64)?;
482 self.write(xattr.name.as_slice())?;
484 self.write(xattr.value.as_slice())?;
489 fn write_fcaps(&mut self, fcaps: Option<PxarFCaps>) -> Result<(), Error> {
490 if let Some(fcaps) = fcaps {
491 let size = fcaps.data.len();
492 self.write_header(PXAR_FCAPS, size as u64)?;
493 self.write(fcaps.data.as_slice())?;
499 fn write_acl_user(&mut self, acl_user: PxarACLUser) -> Result<(), Error> {
500 self.write_header(PXAR_ACL_USER, std::mem::size_of::<PxarACLUser>() as u64)?;
501 self.write_item(acl_user)?;
506 fn write_acl_group(&mut self, acl_group: PxarACLGroup) -> Result<(), Error> {
507 self.write_header(PXAR_ACL_GROUP, std::mem::size_of::<PxarACLGroup>() as u64)?;
508 self.write_item(acl_group)?;
513 fn write_acl_group_obj(&mut self, acl_group_obj: PxarACLGroupObj) -> Result<(), Error> {
514 self.write_header(PXAR_ACL_GROUP_OBJ, std::mem::size_of::<PxarACLGroupObj>() as u64)?;
515 self.write_item(acl_group_obj)?;
520 fn write_acl_default(&mut self, acl_default: PxarACLDefault) -> Result<(), Error> {
521 self.write_header(PXAR_ACL_DEFAULT, std::mem::size_of::<PxarACLDefault>() as u64)?;
522 self.write_item(acl_default)?;
527 fn write_acl_default_user(&mut self, acl_default_user: PxarACLUser) -> Result<(), Error> {
528 self.write_header(PXAR_ACL_DEFAULT_USER, std::mem::size_of::<PxarACLUser>() as u64)?;
529 self.write_item(acl_default_user)?;
534 fn write_acl_default_group(&mut self, acl_default_group: PxarACLGroup) -> Result<(), Error> {
535 self.write_header(PXAR_ACL_DEFAULT_GROUP, std::mem::size_of::<PxarACLGroup>() as u64)?;
536 self.write_item(acl_default_group)?;
541 fn write_quota_project_id(&mut self, projid: PxarQuotaProjID) -> Result<(), Error> {
542 self.write_header(PXAR_QUOTA_PROJID, std::mem::size_of::<PxarQuotaProjID>() as u64)?;
543 self.write_item(projid)?;
548 fn write_goodbye_table(&mut self, goodbye_offset: usize, goodbye_items: &mut [PxarGoodbyeItem]) -> Result<(), Error> {
550 goodbye_items.sort_unstable_by(|a, b| a.hash.cmp(&b.hash));
552 let item_count = goodbye_items.len();
554 let goodbye_table_size = (item_count + 1)*std::mem::size_of::<PxarGoodbyeItem>();
556 self.write_header(PXAR_GOODBYE, goodbye_table_size as u64)?;
558 if self.file_copy_buffer.len() < goodbye_table_size {
559 let need = goodbye_table_size - self.file_copy_buffer.len();
560 self.file_copy_buffer.reserve(need);
561 unsafe { self.file_copy_buffer.set_len(self.file_copy_buffer.capacity()); }
564 let buffer = &mut self.file_copy_buffer;
566 copy_binary_search_tree(item_count, |s, d| {
567 let item = &goodbye_items[s];
568 let offset = d*std::mem::size_of::<PxarGoodbyeItem>();
569 let dest = crate::tools::map_struct_mut::<PxarGoodbyeItem>(&mut buffer[offset..]).unwrap();
570 dest.offset = u64::to_le(item.offset);
571 dest.size = u64::to_le(item.size);
572 dest.hash = u64::to_le(item.hash);
575 // append PxarGoodbyeTail as last item
576 let offset = item_count*std::mem::size_of::<PxarGoodbyeItem>();
577 let dest = crate::tools::map_struct_mut::<PxarGoodbyeItem>(&mut buffer[offset..]).unwrap();
578 dest.offset = u64::to_le(goodbye_offset as u64);
579 dest.size = u64::to_le((goodbye_table_size + std::mem::size_of::<PxarHeader>()) as u64);
580 dest.hash = u64::to_le(PXAR_GOODBYE_TAIL_MARKER);
582 self.flush_copy_buffer(goodbye_table_size)?;
589 dir: &mut nix::dir::Dir,
592 match_pattern: Vec<MatchPattern>,
593 ) -> Result<(), Error> {
595 //println!("encode_dir
: {:?} start {}
", self.full_path(), self.writer_pos);
597 let mut name_list = vec![];
599 let rawfd = dir.as_raw_fd();
601 let dir_start_pos = self.writer_pos;
603 let mut dir_entry = self.create_entry(&dir_stat)?;
605 self.read_chattr(rawfd, &mut dir_entry)?;
606 self.read_fat_attr(rawfd, magic, &mut dir_entry)?;
608 // for each node in the directory tree, the filesystem features are
609 // checked based on the fs magic number.
610 self.fs_feature_flags = flags::feature_flags_from_magic(magic);
612 let (xattrs, fcaps) = self.read_xattrs(rawfd, &dir_stat)?;
613 let acl_access = self.read_acl(rawfd, &dir_stat, acl::ACL_TYPE_ACCESS)?;
614 let acl_default = self.read_acl(rawfd, &dir_stat, acl::ACL_TYPE_DEFAULT)?;
615 let projid = self.read_quota_project_id(rawfd, magic, &dir_stat)?;
617 self.write_entry(dir_entry)?;
618 for xattr in xattrs {
619 self.write_xattr(xattr)?;
621 self.write_fcaps(fcaps)?;
623 for user in acl_access.users {
624 self.write_acl_user(user)?;
626 for group in acl_access.groups {
627 self.write_acl_group(group)?;
629 if let Some(group_obj) = acl_access.group_obj {
630 self.write_acl_group_obj(group_obj)?;
633 for default_user in acl_default.users {
634 self.write_acl_default_user(default_user)?;
636 for default_group in acl_default.groups {
637 self.write_acl_default_group(default_group)?;
639 if let Some(default) = acl_default.default {
640 self.write_acl_default(default)?;
642 if let Some(projid) = projid {
643 self.write_quota_project_id(projid)?;
646 let include_children;
647 if is_virtual_file_system(magic) {
648 include_children = false;
650 if let Some(set) = &self.device_set {
651 include_children = set.contains(&dir_stat.st_dev);
653 include_children = true;
657 // Expand the exclude match pattern inherited from the parent by local entries, if present
658 let mut local_match_pattern = match_pattern.clone();
659 let pxar_exclude = match MatchPattern::from_file(rawfd, ".pxarexclude
") {
660 Ok(Some((mut excludes, buffer, stat))) => {
661 local_match_pattern.append(&mut excludes);
665 Err(err) => bail!("error
while reading exclude file
- {}
", err),
668 if include_children {
669 for entry in dir.iter() {
670 let entry = entry.map_err(|err| {
671 format_err!("readir {:?} failed
- {}
", self.full_path(), err)
673 let filename = entry.file_name().to_owned();
675 let name = filename.to_bytes_with_nul();
676 if name == b".\0" || name == b"..\0" {
680 let stat = match nix::sys::stat::fstatat(rawfd, filename.as_ref(), nix::fcntl::AtFlags::AT_SYMLINK_NOFOLLOW) {
682 Err(nix::Error::Sys(Errno::ENOENT)) => {
683 let filename_osstr = std::ffi::OsStr::from_bytes(filename.to_bytes());
684 self.report_vanished_file(&self.full_path().join(filename_osstr))?;
687 Err(err) => bail!("fstat {:?} failed
- {}
", self.full_path(), err),
690 match match_filename(&filename, &stat, &local_match_pattern)? {
691 (MatchType::Positive, _) => {
692 let filename_osstr = std::ffi::OsStr::from_bytes(filename.to_bytes());
693 eprintln!("matched by
.pxarexclude entry
- skipping
: {:?}
", self.full_path().join(filename_osstr));
695 (_, child_pattern) => name_list.push((filename, stat, child_pattern)),
698 if name_list.len() > MAX_DIRECTORY_ENTRIES {
699 bail!("too many directory items
in {:?}
(> {}
)", self.full_path(), MAX_DIRECTORY_ENTRIES);
703 eprintln!("skip mount point
: {:?}
", self.full_path());
706 name_list.sort_unstable_by(|a, b| a.0.cmp(&b.0));
708 let mut goodbye_items = vec![];
710 for (filename, stat, exclude_list) in name_list {
711 let start_pos = self.writer_pos;
713 if filename.as_bytes() == b".pxarexclude
" {
714 if let Some((ref content, ref stat)) = pxar_exclude {
715 let filefd = match nix::fcntl::openat(rawfd, filename.as_ref(), OFlag::O_NOFOLLOW, Mode::empty()) {
716 Ok(filefd) => filefd,
717 Err(nix::Error::Sys(Errno::ENOENT)) => {
718 self.report_vanished_file(&self.full_path())?;
722 let filename_osstr = std::ffi::OsStr::from_bytes(filename.to_bytes());
723 bail!("open file {:?} failed
- {}
", self.full_path().join(filename_osstr), err);
727 let child_magic = if dir_stat.st_dev != stat.st_dev {
728 detect_fs_type(filefd)?
733 self.write_filename(&filename)?;
734 self.encode_pxar_exclude(filefd, stat, child_magic, content)?;
739 self.relative_path.push(std::ffi::OsStr::from_bytes(filename.as_bytes()));
741 if self.verbose { println!("{:?}", self.full_path()); }
743 if is_directory(&stat
) {
745 let mut dir
= match nix
::dir
::Dir
::openat(rawfd
, filename
.as_ref(), OFlag
::O_DIRECTORY
|OFlag
::O_NOFOLLOW
, Mode
::empty()) {
747 Err(nix
::Error
::Sys(Errno
::ENOENT
)) => {
748 self.report_vanished_file(&self.full_path())?
;
751 Err(err
) => bail
!("open dir {:?} failed - {}", self.full_path(), err
),
754 let child_magic
= if dir_stat
.st_dev
!= stat
.st_dev
{
755 detect_fs_type(dir
.as_raw_fd())?
760 self.write_filename(&filename
)?
;
761 self.encode_dir(&mut dir
, &stat
, child_magic
, exclude_list
)?
;
763 } else if is_reg_file(&stat
) {
765 let mut hardlink_target
= None
;
767 if stat
.st_nlink
> 1 {
768 let link_info
= HardLinkInfo { st_dev: stat.st_dev, st_ino: stat.st_ino }
;
769 hardlink_target
= self.hardlinks
.get(&link_info
).map(|(v
, offset
)| {
770 let mut target
= v
.clone().into_os_string();
771 target
.push("\0"); // add Nul byte
772 (target
, (start_pos
as u64) - offset
)
774 if hardlink_target
== None
{
775 self.hardlinks
.insert(link_info
, (self.relative_path
.clone(), start_pos
as u64));
779 if let Some((target
, offset
)) = hardlink_target
{
781 self.write_filename(&filename
)?
;
782 self.encode_hardlink(target
.as_bytes(), offset
)?
;
786 let filefd
= match nix
::fcntl
::openat(rawfd
, filename
.as_ref(), OFlag
::O_NOFOLLOW
, Mode
::empty()) {
787 Ok(filefd
) => filefd
,
788 Err(nix
::Error
::Sys(Errno
::ENOENT
)) => {
789 self.report_vanished_file(&self.full_path())?
;
792 Err(err
) => bail
!("open file {:?} failed - {}", self.full_path(), err
),
795 let child_magic
= if dir_stat
.st_dev
!= stat
.st_dev
{
796 detect_fs_type(filefd
)?
801 self.write_filename(&filename
)?
;
802 let res
= self.encode_file(filefd
, &stat
, child_magic
);
803 let _
= nix
::unistd
::close(filefd
); // ignore close errors
807 } else if is_symlink(&stat
) {
808 let mut buffer
= vec
::undefined(libc
::PATH_MAX
as usize);
810 let res
= filename
.with_nix_path(|cstr
| {
811 unsafe { libc::readlinkat(rawfd, cstr.as_ptr(), buffer.as_mut_ptr() as *mut libc::c_char, buffer.len()-1) }
814 match Errno
::result(res
) {
816 buffer
[len
as usize] = 0u8; // add Nul byte
817 self.write_filename(&filename
)?
;
818 self.encode_symlink(&buffer
[..((len
+1) as usize)], &stat
)?
820 Err(nix
::Error
::Sys(Errno
::ENOENT
)) => {
821 self.report_vanished_file(&self.full_path())?
;
824 Err(err
) => bail
!("readlink {:?} failed - {}", self.full_path(), err
),
826 } else if is_block_dev(&stat
) || is_char_dev(&stat
) {
827 if self.has_features(flags
::WITH_DEVICE_NODES
) {
828 self.write_filename(&filename
)?
;
829 self.encode_device(&stat
)?
;
831 eprintln
!("skip device node: {:?}", self.full_path());
833 } else if is_fifo(&stat
) {
834 if self.has_features(flags
::WITH_FIFOS
) {
835 self.write_filename(&filename
)?
;
836 self.encode_special(&stat
)?
;
838 eprintln
!("skip fifo: {:?}", self.full_path());
840 } else if is_socket(&stat
) {
841 if self.has_features(flags
::WITH_SOCKETS
) {
842 self.write_filename(&filename
)?
;
843 self.encode_special(&stat
)?
;
845 eprintln
!("skip socket: {:?}", self.full_path());
848 bail
!("unsupported file type (mode {:o} {:?})", stat
.st_mode
, self.full_path());
851 let end_pos
= self.writer_pos
;
853 goodbye_items
.push(PxarGoodbyeItem
{
854 offset
: start_pos
as u64,
855 size
: (end_pos
- start_pos
) as u64,
856 hash
: compute_goodbye_hash(filename
.to_bytes()),
859 self.relative_path
.pop();
862 //println!("encode_dir: {:?} end {}", self.full_path(), self.writer_pos);
864 // fixup goodby item offsets
865 let goodbye_start
= self.writer_pos
as u64;
866 for item
in &mut goodbye_items
{
867 item
.offset
= goodbye_start
- item
.offset
;
870 let goodbye_offset
= self.writer_pos
- dir_start_pos
;
872 self.write_goodbye_table(goodbye_offset
, &mut goodbye_items
)?
;
874 //println!("encode_dir: {:?} end1 {}", self.full_path(), self.writer_pos);
878 fn encode_file(&mut self, filefd
: RawFd
, stat
: &FileStat
, magic
: i64) -> Result
<(), Error
> {
880 //println!("encode_file: {:?}", self.full_path());
882 let mut entry
= self.create_entry(&stat
)?
;
884 self.read_chattr(filefd
, &mut entry
)?
;
885 self.read_fat_attr(filefd
, magic
, &mut entry
)?
;
886 let (xattrs
, fcaps
) = self.read_xattrs(filefd
, &stat
)?
;
887 let acl_access
= self.read_acl(filefd
, &stat
, acl
::ACL_TYPE_ACCESS
)?
;
888 let projid
= self.read_quota_project_id(filefd
, magic
, &stat
)?
;
890 self.write_entry(entry
)?
;
891 for xattr
in xattrs
{
892 self.write_xattr(xattr
)?
;
894 self.write_fcaps(fcaps
)?
;
895 for user
in acl_access
.users
{
896 self.write_acl_user(user
)?
;
898 for group
in acl_access
.groups
{
899 self.write_acl_group(group
)?
;
901 if let Some(group_obj
) = acl_access
.group_obj
{
902 self.write_acl_group_obj(group_obj
)?
;
904 if let Some(projid
) = projid
{
905 self.write_quota_project_id(projid
)?
;
909 if is_virtual_file_system(magic
) {
910 include_payload
= false;
912 if let Some(ref set
) = &self.device_set
{
913 include_payload
= set
.contains(&stat
.st_dev
);
915 include_payload
= true;
919 if !include_payload
{
920 eprintln
!("skip content: {:?}", self.full_path());
921 self.write_header(PXAR_PAYLOAD
, 0)?
;
925 let size
= stat
.st_size
as u64;
927 self.write_header(PXAR_PAYLOAD
, size
)?
;
929 let mut pos
: u64 = 0;
931 let n
= match nix
::unistd
::read(filefd
, &mut self.file_copy_buffer
) {
933 Err(nix
::Error
::Sys(Errno
::EINTR
)) => continue /* try again */,
934 Err(err
) => bail
!("read {:?} failed - {}", self.full_path(), err
),
938 // Note:: casync format cannot handle that
939 bail
!("detected shrinked file {:?} ({} < {})", self.full_path(), pos
, size
);
944 let mut next
= pos
+ (n
as u64);
946 if next
> size { next = size; }
948 let count
= (next
- pos
) as usize;
950 self.flush_copy_buffer(count
)?
;
954 if pos
>= size { break; }
960 fn encode_device(&mut self, stat
: &FileStat
) -> Result
<(), Error
> {
962 let entry
= self.create_entry(&stat
)?
;
964 self.write_entry(entry
)?
;
966 let major
= unsafe { libc::major(stat.st_rdev) }
as u64;
967 let minor
= unsafe { libc::minor(stat.st_rdev) }
as u64;
969 //println!("encode_device: {:?} {} {} {}", self.full_path(), stat.st_rdev, major, minor);
971 self.write_header(PXAR_DEVICE
, std
::mem
::size_of
::<PxarDevice
>() as u64)?
;
972 self.write_item(PxarDevice { major, minor }
)?
;
978 fn encode_special(&mut self, stat
: &FileStat
) -> Result
<(), Error
> {
980 let entry
= self.create_entry(&stat
)?
;
982 self.write_entry(entry
)?
;
987 fn encode_symlink(&mut self, target
: &[u8], stat
: &FileStat
) -> Result
<(), Error
> {
989 //println!("encode_symlink: {:?} -> {:?}", self.full_path(), target);
991 let entry
= self.create_entry(&stat
)?
;
992 self.write_entry(entry
)?
;
994 self.write_header(PXAR_SYMLINK
, target
.len() as u64)?
;
1000 fn encode_hardlink(&mut self, target
: &[u8], offset
: u64) -> Result
<(), Error
> {
1002 //println!("encode_hardlink: {:?} -> {:?}", self.full_path(), target);
1004 // Note: HARDLINK replaces an ENTRY.
1005 self.write_header(PXAR_FORMAT_HARDLINK
, (target
.len() as u64) + 8)?
;
1006 self.write_item(offset
)?
;
1007 self.write(target
)?
;
1012 fn encode_pxar_exclude(&mut self, filefd
: RawFd
, stat
: &FileStat
, magic
: i64, content
: &[u8]) -> Result
<(), Error
> {
1013 let mut entry
= self.create_entry(&stat
)?
;
1015 self.read_chattr(filefd
, &mut entry
)?
;
1016 self.read_fat_attr(filefd
, magic
, &mut entry
)?
;
1017 let (xattrs
, fcaps
) = self.read_xattrs(filefd
, &stat
)?
;
1018 let acl_access
= self.read_acl(filefd
, &stat
, acl
::ACL_TYPE_ACCESS
)?
;
1019 let projid
= self.read_quota_project_id(filefd
, magic
, &stat
)?
;
1021 self.write_entry(entry
)?
;
1022 for xattr
in xattrs
{
1023 self.write_xattr(xattr
)?
;
1025 self.write_fcaps(fcaps
)?
;
1026 for user
in acl_access
.users
{
1027 self.write_acl_user(user
)?
;
1029 for group
in acl_access
.groups
{
1030 self.write_acl_group(group
)?
;
1032 if let Some(group_obj
) = acl_access
.group_obj
{
1033 self.write_acl_group_obj(group_obj
)?
;
1035 if let Some(projid
) = projid
{
1036 self.write_quota_project_id(projid
)?
;
1039 let include_payload
;
1040 if is_virtual_file_system(magic
) {
1041 include_payload
= false;
1043 if let Some(set
) = &self.device_set
{
1044 include_payload
= set
.contains(&stat
.st_dev
);
1046 include_payload
= true;
1050 if !include_payload
{
1051 eprintln
!("skip content: {:?}", self.full_path());
1052 self.write_header(PXAR_PAYLOAD
, 0)?
;
1056 let size
= content
.len();
1057 self.write_header(PXAR_PAYLOAD
, size
as u64)?
;
1058 self.writer
.write_all(content
)?
;
1059 self.writer_pos
+= size
;
1064 // the report_XXX method may raise and error - depending on encoder configuration
1066 fn report_vanished_file(&self, path
: &Path
) -> Result
<(), Error
> {
1068 eprintln
!("WARNING: detected vanished file {:?}", path
);
1074 // If there is a match, an updated MatchPattern list to pass to the matched child is returned.
1078 match_pattern
: &Vec
<MatchPattern
>
1079 ) -> Result
<(MatchType
, Vec
<MatchPattern
>), Error
> {
1080 let mut child_pattern
= Vec
::new();
1081 let mut match_state
= MatchType
::None
;
1083 for pattern
in match_pattern
{
1084 match pattern
.matches_filename(filename
, is_directory(&stat
))?
{
1085 MatchType
::None
=> {}
,
1086 MatchType
::Positive
=> match_state
= MatchType
::Positive
,
1087 MatchType
::Negative
=> match_state
= MatchType
::Negative
,
1089 if match_state
!= MatchType
::Positive
&& match_state
!= MatchType
::Negative
{
1090 match_state
= match_type
;
1092 child_pattern
.push(pattern
.get_rest_pattern());
1097 Ok((match_state
, child_pattern
))
1100 fn errno_is_unsupported(errno
: Errno
) -> bool
{
1103 Errno
::ENOTTY
| Errno
::ENOSYS
| Errno
::EBADF
| Errno
::EOPNOTSUPP
| Errno
::EINVAL
=> {
1110 fn detect_fs_type(fd
: RawFd
) -> Result
<i64, Error
> {
1111 let mut fs_stat
: libc
::statfs
= unsafe { std::mem::uninitialized() }
;
1112 let res
= unsafe { libc::fstatfs(fd, &mut fs_stat) }
;
1113 Errno
::result(res
)?
;
1119 pub fn is_temporary_file_system(magic
: i64) -> bool
{
1120 use proxmox
::sys
::linux
::magic
::*;
1121 magic
== RAMFS_MAGIC
|| magic
== TMPFS_MAGIC
1124 pub fn is_virtual_file_system(magic
: i64) -> bool
{
1125 use proxmox
::sys
::linux
::magic
::*;
1129 CGROUP2_SUPER_MAGIC
|
1130 CGROUP_SUPER_MAGIC
|
1133 DEVPTS_SUPER_MAGIC
|
1135 FUSE_CTL_SUPER_MAGIC
|
1145 SYSFS_MAGIC
=> true,