embuild 0.33.3

A build support library for embedded Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

//! Filesystem utilities.

use std::fs::{self, File};
use std::io::{self, Read};
use std::path::Path;

use anyhow::Result;

/// Marks the directory as excluded from archives/backups by writing a `CACHEDIR.TAG` file.
///
/// This prevents derived/temporary files from bloating backups. Errors are ignored since
/// this is an optional best-effort feature.
///
/// See the [Cache Directory Tagging Specification](https://bford.info/cachedir/).
///
/// TODO: This only replicates _part_ of what cargo_util::paths::exclude_from_backups_and_indexing does:
/// https://doc.rust-lang.org/beta/nightly-rustc/cargo_util/paths/fn.exclude_from_backups_and_indexing.html
/// we should consider lifting more of the code to prevent backup on MacOS, and indexing on Windows.
pub fn exclude_from_backups(path: &Path) {
    let file = path.join("CACHEDIR.TAG");
    if !file.exists() {
        let _ = std::fs::write(
            file,
            "Signature: 8a477f597d28d172789f06886806bc55
# This file is a cache directory tag created by embuild.
# For information about cache directory tags see https://bford.info/cachedir/
",
        );
        // We ignore errors here as it's an optional feature.
    }
}

/// Copy `src_file` to `dest_file_or_dir` if `src_file` is different or the destination
/// file doesn't exist.
///
/// ### Panics
/// If `src_file` is not a file this function will panic.
pub fn copy_file_if_different(
    src_file: impl AsRef<Path>,
    dest_file_or_dir: impl AsRef<Path>,
) -> Result<()> {
    let src_file: &Path = src_file.as_ref();
    let dest_file_or_dir: &Path = dest_file_or_dir.as_ref();

    assert!(src_file.is_file());

    let src_fd = fs::File::open(src_file)?;

    let (dest_fd, dest_file) = if dest_file_or_dir.exists() {
        if dest_file_or_dir.is_dir() {
            let dest_file = dest_file_or_dir.join(src_file.file_name().unwrap());
            if dest_file.exists() {
                (Some(fs::File::open(&dest_file)?), dest_file)
            } else {
                (None, dest_file)
            }
        } else {
            (
                Some(fs::File::open(dest_file_or_dir)?),
                dest_file_or_dir.to_owned(),
            )
        }
    } else {
        (None, dest_file_or_dir.to_owned())
    };

    if let Some(dest_fd) = dest_fd {
        if !is_file_eq(&src_fd, &dest_fd)? {
            drop(dest_fd);
            drop(src_fd);
            copy_with_metadata(src_file, dest_file)?;
        }
    } else {
        copy_with_metadata(src_file, dest_file)?;
    }
    Ok(())
}

/// Whether the file type and contents of `file` are equal to `other`.
pub fn is_file_eq(file: &File, other: &File) -> Result<bool> {
    let file_meta = file.metadata()?;
    let other_meta = other.metadata()?;

    if file_meta.file_type() == other_meta.file_type()
        && file_meta.len() == other_meta.len()
        && file_meta.modified()? == other_meta.modified()?
    {
        let mut file_bytes = io::BufReader::new(file).bytes();
        let mut other_bytes = io::BufReader::new(other).bytes();

        // TODO: check performance
        loop {
            match (file_bytes.next(), other_bytes.next()) {
                (Some(Ok(b0)), Some(Ok(b1))) => {
                    if b0 != b1 {
                        break Ok(false);
                    }
                }
                (None, None) => break Ok(true),
                (None, Some(_)) | (Some(_), None) => break Ok(false),
                (Some(Err(e)), _) | (_, Some(Err(e))) => return Err(e.into()),
            }
        }
    } else {
        Ok(false)
    }
}

/// Wrap [`fs::copy`] to also copy metadata such as permissions and file times.
///
/// This function is required because Cargo's fingerprinting uses mtime which is not perpetuated by
/// [`fs::copy`]. If Cargo detects a fingerprint mismatch, it will rebuild the crate with the
/// mismatch. This could lead Cargo to keep rebuilding the same crate over and over because the
/// comparison will always yield a new fingerprint since [`fs::copy`] doesn't take mtime into
/// account.
pub fn copy_with_metadata(src_file: impl AsRef<Path>, dest_file: impl AsRef<Path>) -> Result<()> {
    fs::copy(&src_file, &dest_file)?;
    let src_file_meta = fs::File::open(&src_file)?.metadata()?;

    let src_atime = filetime::FileTime::from_last_access_time(&src_file_meta);
    let src_mtime = filetime::FileTime::from_last_modification_time(&src_file_meta);

    fs::set_permissions(dest_file.as_ref(), src_file_meta.permissions())?;
    filetime::set_file_times(dest_file, src_atime, src_mtime)?;

    Ok(())
}