block-devs 0.1.0

//! Block Devs provides safe wrappers for the ioctl calls for
//! dealing with block devices (USB sticks, SSDs, hard drives etc).
//!
//! It aims to provide a consitent interface across all platforms for things like
//! getting the number of bytes a disk has.
//!
//! So far Linux, macOS and Open BSD are supported
//!
//! It does this by a extention trait ([`BlckExt`]) on the standard [`File`] struct.
//!
//! ```rust,no_run
//!     use block_devs::BlckExt;
//!     use std::fs::File;
//!
//!     let path = "/dev/sda2";
//!     let file = File::open(path).unwrap();
//!     let count = file.get_block_count().unwrap();
//!     let bytes = file.get_block_device_size().unwrap();
//!     let gb = bytes >> 30;
//!
//!     println!("disk is {} blocks totaling {}gb", count, gb);
//! ```
//!
//! [`File`]: std::fs::File
//! [`BlckExt`]: BlckExt

#[cfg(target_os = "linux")]
mod linux;
#[cfg(target_os = "linux")]
pub use self::linux::*;

#[cfg(target_os = "macos")]
mod macos;
#[cfg(target_os = "macos")]
pub use self::macos::*;

#[cfg(target_os = "freebsd")]
mod freebsd;
#[cfg(target_os = "freebsd")]
pub use self::freebsd::*;

use std::cmp::min;
use std::io::{Read, Result, Seek, SeekFrom, Write};

/// Block device specific extensions to [`File`].
///
/// [`File`]: std::fs::File
pub trait BlckExt: Seek + Read + Write {
    /// Test if the file is a block device
    ///
    /// This will return `true` for a block device e.g. `"/dev/sda1"` and `false` for other files
    /// If it returns `false` using the other `BlckExt` methods on this file will almost certainly be an error.
    fn is_block_device(&self) -> bool;

    /// Get the total size of the block device in bytes.
    fn get_block_device_size(&self) -> Result<u64>;

    /// Get the size of one logical block in bytes.
    fn get_size_of_block(&self) -> Result<u64>;

    /// Get the number of blocks on the device.
    fn get_block_count(&self) -> Result<u64>;

    /// Ask the OS to re-read the partition table from the device.
    ///
    /// When writing an image to a block device the partions layout may change
    /// this ask the OS to re-read the partion table
    fn block_reread_paritions(&self) -> Result<()>;

    /// Does this device support zeroing on discard.
    ///
    /// Some device (e.g. SSDs with TRIM support) have the ability to mark blocks as unused in a
    /// way that means they will return zeros on future reads.
    ///
    /// If this returns `true` then all calls to [`block_discard`] will cause following reads to return zeros
    ///
    /// Some device only support zeroing on discard for certain sizes and alignements, in which case this
    /// will return `false` but some calls to [`block_discard`] may still result in zeroing some or all of the discared range.
    ///
    /// Since this is a linux only feature other systems will always return false
    ///
    /// Your best bet for knowing if block discarding zeros is to discard some blocks and test that it worked using [`block_fast_zero_out`].
    ///
    /// [`block_fast_zero_out`]: #tymethod.block_fast_zero_out
    /// [`block_discard`]: #tymethod.block_discard
    fn block_discard_zeros(&self) -> Result<bool>;

    /// Discard a section of the block device.
    ///
    /// Some device e.g. thinly provisioned arrays or SSDs with TRIM support have the ability to mark blocks as unused
    /// to free them up for other use. This may or may not result in future reads to the discarded section to return
    /// zeros, see [`block_discard_zeros`] for more detail.
    ///
    /// `offset` and `length` should be given in bytes.
    ///
    /// [`block_discard_zeros`]: #tymethod.block_discard_zeros
    fn block_discard(&self, offset: u64, len: u64) -> Result<()>;

    /// Zeros out a section of the block device.
    ///
    /// There is no guaranty that there special kernel support for this even [`block_discard_zeros`] returns `true`
    /// so it is unlikely to be much faster that writing zeros the normal way, apart from saving a bunch of syscalls.
    ///
    /// If there is no system call on a platfrom it will be implement by writing zeros in the normal way
    ///
    /// `offset` and `length` should be given in bytes.
    ///
    /// [`block_discard_zeros`]: #tymethod.block_discard_zeros
    fn block_zero_out(&mut self, offset: u64, len: u64) -> Result<()> {
        const BUF_SIZE: usize = 1024;
        let zeros = [0; BUF_SIZE];
        let oldpos = self.seek(SeekFrom::Start(offset))?;
        let mut remaining = len;
        while remaining > BUF_SIZE as u64 {
            self.write_all(&zeros)?;
            remaining -= BUF_SIZE as u64;
        }
        self.write_all(&zeros[0..remaining as usize])?;
        self.seek(SeekFrom::Start(oldpos))?;
        Ok(())
    }

    /// Try to zero out a block using discard and return an error if the data is not zeroed.
    ///
    /// Some devices will (SSDs, thinly provisioned RAID arrays) will return zeros if a sufficiently
    /// large area is discarded. This method writes some data to the start of the range to be zerod, disards the range
    /// then reads the data back. It returns an error if the data was not zerod.
    ///
    /// `offset` and `length` should be given in bytes.
    fn block_fast_zero_out(&mut self, offset: u64, len: u64) -> Result<()> {
        const BUF_SIZE: usize = 1024;
        let test_len = min(BUF_SIZE as u64, len) as usize;
        let ones = [255; BUF_SIZE];
        self.seek(SeekFrom::Start(offset))?;
        self.write_all(&ones[0..test_len])?;
        self.seek(SeekFrom::Start(offset))?;
        self.sync_data()?;
        self.block_discard(offset, len)?;
        self.sync_data()?;

        let mut buffer = [255; BUF_SIZE];
        let read = self.read(&mut buffer)?;
        self.seek(SeekFrom::Start(offset))?;
        if read < test_len {
            return Err(io_error("Fast Zero Block failed"));
        }
        if buffer[0..test_len].iter().any(|x| *x != 0) {
            return Err(io_error("Fast Zero Block failed"));
        }

        Ok(())
    }

    fn sync_data(&self) -> Result<()>;
}

fn io_error(str: &str) -> std::io::Error {
    std::io::Error::new(std::io::ErrorKind::Other, str)
}

fn to_io(err: nix::Error) -> std::io::Error {
    match err {
        nix::Error::Sys(errno) => errno.into(),
        nix::Error::InvalidPath => io_error("InvalidPath"),
        nix::Error::InvalidUtf8 => io_error("InvalidUtf8"),
        nix::Error::UnsupportedOperation => io_error("UnsupportedOperation"),
    }
}