libblkid_rs/

probe.rs

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

use std::{
    ffi::{CStr, CString},
    os::unix::io::RawFd,
    path::Path,
    ptr,
};

use crate::{
    consts::{
        BlkidFltr, BlkidFullprobeRet, BlkidProbeRet, BlkidProbreqFlags, BlkidSafeprobeRet,
        BlkidSublksFlags, BlkidUsageFlags,
    },
    devno::BlkidDevno,
    err::BlkidErr,
    partition::BlkidPartlist,
    topology::BlkidTopology,
    Result,
};

/// A structure for probing block devices.
pub struct BlkidProbe(pub(super) libblkid_rs_sys::blkid_probe);

impl BlkidProbe {
    /// Allocate and create a new libblkid probe.
    pub fn new() -> Result<Self> {
        Ok(BlkidProbe(errno_ptr!(unsafe {
            libblkid_rs_sys::blkid_new_probe()
        })?))
    }

    /// Create a new probe from a filename.
    pub fn new_from_filename(filename: &Path) -> Result<Self> {
        let filename_cstring = CString::new(filename.to_str().ok_or(BlkidErr::InvalidConv)?)?;
        Ok(BlkidProbe(errno_ptr!(unsafe {
            libblkid_rs_sys::blkid_new_probe_from_filename(filename_cstring.as_ptr())
        })?))
    }

    /// Reset the probe.
    pub fn reset(&mut self) {
        unsafe { libblkid_rs_sys::blkid_reset_probe(self.0) }
    }

    /// Reset and free all buffers used in the probe.
    pub fn reset_buffers(&mut self) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_reset_buffers(self.0) })
    }

    /// Hide a memory range in the probe from the next `do_probe` call.
    pub fn hide_range(&mut self, offset: u64, len: u64) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_hide_range(self.0, offset, len) })
    }

    /// Assign the device to the probe control structure.
    pub fn set_device(
        &mut self,
        fd: RawFd,
        offset: libblkid_rs_sys::blkid_loff_t,
        size: libblkid_rs_sys::blkid_loff_t,
    ) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_set_device(self.0, fd, offset, size) })
    }

    /// Get the device number associated with the probe device.
    pub fn get_devno(&self) -> BlkidDevno {
        BlkidDevno::new(unsafe { libblkid_rs_sys::blkid_probe_get_devno(self.0) })
    }

    /// Get the device number of the whole disk
    pub fn get_wholedisk_devno(&self) -> BlkidDevno {
        BlkidDevno::new(unsafe { libblkid_rs_sys::blkid_probe_get_wholedisk_devno(self.0) })
    }

    /// Check if the given device is an entire disk (instead of a partition or
    /// something similar)
    pub fn is_wholedisk(&self) -> bool {
        (unsafe { libblkid_rs_sys::blkid_probe_is_wholedisk(self.0) }) > 0
    }

    /// Get the size of of a device.
    pub fn get_size(&self) -> libblkid_rs_sys::blkid_loff_t {
        unsafe { libblkid_rs_sys::blkid_probe_get_size(self.0) }
    }

    /// Get the offset of a probing area of a device.
    pub fn get_offset(&self) -> libblkid_rs_sys::blkid_loff_t {
        unsafe { libblkid_rs_sys::blkid_probe_get_offset(self.0) }
    }

    /// Get the sector size of the attached device.
    pub fn get_sector_size(&self) -> libc::c_uint {
        unsafe { libblkid_rs_sys::blkid_probe_get_sectorsize(self.0) }
    }

    /// Get a file descriptor associated with the given device.
    pub fn get_fd(&self) -> Result<RawFd> {
        errno_with_ret!(unsafe { libblkid_rs_sys::blkid_probe_get_fd(self.0) })
    }

    /// Enable superblock probing.
    pub fn enable_superblocks(&mut self, enable: bool) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_enable_superblocks(self.0, enable.into()) })
    }

    /// Set the superblock probing flags.
    pub fn set_superblock_flags(&mut self, flags: BlkidSublksFlags) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_set_superblocks_flags(self.0, flags.into()) })
    }

    /// Reset the superblock probing filter.
    pub fn reset_superblock_filter(&mut self) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_reset_superblocks_filter(self.0) })
    }

    /// Invert the superblock probing filter.
    pub fn invert_superblock_filter(&mut self) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_invert_superblocks_filter(self.0) })
    }

    /// Filter superblock types based on the provided flags and name.
    pub fn filter_superblock_type(&mut self, flag: BlkidFltr, names: &[&str]) -> Result<()> {
        let cstring_vec: Vec<_> = names.iter().map(|name| CString::new(*name)).collect();
        if cstring_vec
            .iter()
            .any(|cstring_result| cstring_result.is_err())
        {
            return Err(BlkidErr::InvalidConv);
        }
        let checked_cstring_vec: Vec<_> =
            cstring_vec.into_iter().filter_map(|cs| cs.ok()).collect();
        let mut ptr_vec: Vec<_> = checked_cstring_vec
            .iter()
            .map(|cstring| cstring.as_ptr() as *mut _)
            .collect();
        ptr_vec.push(ptr::null_mut());

        errno!(unsafe {
            libblkid_rs_sys::blkid_probe_filter_superblocks_type(
                self.0,
                flag.into(),
                ptr_vec.as_mut_ptr(),
            )
        })
    }

    /// Filter devices based on the usages specified in the `usage` parameter.
    pub fn filter_superblock_usage(
        &mut self,
        flag: BlkidFltr,
        usage: BlkidUsageFlags,
    ) -> Result<()> {
        errno!(unsafe {
            libblkid_rs_sys::blkid_probe_filter_superblocks_usage(self.0, flag.into(), usage.into())
        })
    }

    /// Enable topology probing.
    pub fn enable_topology(&mut self, enable: bool) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_enable_topology(self.0, enable.into()) })
    }

    /// Get the blkid topology of devices.
    ///
    /// The topology will be overwritten with each call to this method per the
    /// libblkid documentation. To use multiple topologies simultaneously,
    /// you must use multiple `BlkidProbe` structs.
    pub fn get_topology(&mut self) -> Result<BlkidTopology> {
        Ok(BlkidTopology::new(errno_ptr!(unsafe {
            libblkid_rs_sys::blkid_probe_get_topology(self.0)
        })?))
    }

    /// Enable partition probing.
    pub fn enable_partitions(&mut self, enable: bool) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_enable_partitions(self.0, enable.into()) })
    }

    /// Reset the partition filter.
    pub fn reset_partition_filter(&mut self) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_reset_partitions_filter(self.0) })
    }

    /// Invert the partition filter.
    pub fn invert_partition_filter(&mut self) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_invert_partitions_filter(self.0) })
    }

    /// Probe for partitions using the specified partition types.
    ///
    /// This method can either probe for partitions with partition types specified
    /// in `names` or only for partition types not found in `names`.
    pub fn filter_partition_types(&mut self, flag: BlkidFltr, names: &[&str]) -> Result<()> {
        let cstring_vec: Vec<_> = names.iter().map(|name| CString::new(*name)).collect();
        if cstring_vec
            .iter()
            .any(|cstring_result| cstring_result.is_err())
        {
            return Err(BlkidErr::InvalidConv);
        }
        let checked_cstring_vec: Vec<_> =
            cstring_vec.into_iter().filter_map(|cs| cs.ok()).collect();
        let mut ptr_vec: Vec<_> = checked_cstring_vec
            .iter()
            .map(|cstring| cstring.as_ptr() as *mut _)
            .collect();
        ptr_vec.push(ptr::null_mut());

        errno!(unsafe {
            libblkid_rs_sys::blkid_probe_filter_partitions_type(
                self.0,
                flag.into(),
                ptr_vec.as_mut_ptr(),
            )
        })
    }

    /// Get list of probed partitions.
    pub fn get_partitions(&mut self) -> Result<BlkidPartlist<'_>> {
        Ok(BlkidPartlist::new(errno_ptr!(unsafe {
            libblkid_rs_sys::blkid_probe_get_partitions(self.0)
        })?))
    }

    /// Probe for signatures at the tag level (`TAG=VALUE`). Superblocks will
    /// be probed by default. This method calls only one function call at a time
    /// and should be called in a loop to get results from all probing chains.
    pub fn do_probe(&mut self) -> Result<BlkidProbeRet> {
        errno_with_ret!(unsafe { libblkid_rs_sys::blkid_do_probe(self.0) })
            .and_then(BlkidProbeRet::try_from)
    }

    /// Probes all enabled chains and checks for ambiguous results.
    pub fn do_safeprobe(&mut self) -> Result<BlkidSafeprobeRet> {
        let ret = unsafe { libblkid_rs_sys::blkid_do_safeprobe(self.0) };
        if ret == -1 {
            Err(BlkidErr::LibErr(-1))
        } else {
            Ok(BlkidSafeprobeRet::try_from(ret)?)
        }
    }

    /// Same as `do_safeprobe` but does not check for collisions.
    pub fn do_fullprobe(&mut self) -> Result<BlkidFullprobeRet> {
        errno_with_ret!(unsafe { libblkid_rs_sys::blkid_do_fullprobe(self.0) })
            .and_then(BlkidFullprobeRet::try_from)
    }

    /// Number of values in probe
    pub fn numof_values(&self) -> Result<usize> {
        errno_with_ret!(unsafe { libblkid_rs_sys::blkid_probe_numof_values(self.0) })
            .map(|v| v as usize)
    }

    /// Get the tag and value of an entry by the index in the range
    /// `0..(self.numof_values())`.
    pub fn get_value(&self, num: libc::c_uint) -> Result<(String, String)> {
        let num_values = self.numof_values()?;
        if num as usize >= num_values {
            return Err(BlkidErr::Other(format!(
                "num must be between 0 and {}",
                num_values - 1
            )));
        }

        let mut name: *const libc::c_char = ptr::null();
        let mut data: *const libc::c_char = ptr::null();
        let mut size: usize = 0;
        errno!(unsafe {
            libblkid_rs_sys::blkid_probe_get_value(
                self.0,
                num as libc::c_int,
                &mut name as *mut _,
                &mut data as *mut _,
                &mut size as *mut _,
            )
        })?;
        let name = str_ptr_to_owned!(name);
        let data = str_ptr_with_size_to_owned!(data, size);
        Ok((name, data))
    }

    /// Get the value for a tag with the given name.
    pub fn lookup_value(&self, name: &str) -> Result<String> {
        let name_cstring = CString::new(name)?;

        let mut data: *const libc::c_char = ptr::null();
        let mut size: usize = 0;
        errno!(unsafe {
            libblkid_rs_sys::blkid_probe_lookup_value(
                self.0,
                name_cstring.as_ptr(),
                &mut data as *mut _,
                &mut size as *mut _,
            )
        })?;
        let data = str_ptr_with_size_to_owned!(data, size);
        Ok(data)
    }

    /// Check whether the given name exists in a probe.
    pub fn has_value(&self, name: &str) -> Result<bool> {
        let name_cstring = CString::new(name)?;
        Ok((unsafe { libblkid_rs_sys::blkid_probe_has_value(self.0, name_cstring.as_ptr()) }) != 0)
    }

    /// Wipe the current probed block signature.
    pub fn do_wipe(&mut self, dry_run: bool) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_do_wipe(self.0, dry_run.into()) })
    }

    /// Set the probing on step back on the probing chain.
    pub fn step_back(&mut self) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_step_back(self.0) })
    }

    /// Set request flags.
    pub fn set_request(&mut self, flags: BlkidProbreqFlags) -> Result<()> {
        errno!(unsafe { libblkid_rs_sys::blkid_probe_set_request(self.0, flags.into()) })
    }
}

impl Drop for BlkidProbe {
    fn drop(&mut self) {
        unsafe { libblkid_rs_sys::blkid_free_probe(self.0) }
    }
}

/// Check if the given string containing a filesystem name is a known filesystem
/// type.
pub fn is_known_fs_type(fstype: &str) -> Result<bool> {
    let fstype_cstring = CString::new(fstype)?;
    Ok(unsafe { libblkid_rs_sys::blkid_known_fstype(fstype_cstring.as_ptr()) } > 0)
}

/// Get the name and flags of a superblock at the given index in the libblkid
/// internal state.
///
/// This method in libblkid exposes implementation details of the library. There
/// is no way to map indices to types without duplicating logic inside and outside
/// of the library.
pub fn get_superblock_name(
    index: usize,
    get_name: bool,
    get_flags: bool,
) -> Result<(Option<&'static str>, Option<BlkidUsageFlags>)> {
    let mut name_ptr: *const libc::c_char = ptr::null();
    let mut flags: libc::c_int = 0;
    errno!(unsafe {
        libblkid_rs_sys::blkid_superblocks_get_name(
            index,
            if get_name {
                &mut name_ptr as *mut _
            } else {
                ptr::null_mut()
            },
            if get_flags {
                &mut flags as *mut _
            } else {
                ptr::null_mut()
            },
        )
    })?;
    let name_option = Some(unsafe { CStr::from_ptr(name_ptr) }.to_str()?);
    let flags_option = Some(BlkidUsageFlags::try_from(flags)?);
    Ok((name_option, flags_option))
}

/// Checks whether the name provided is a known partition type.
pub fn is_known_partition_type(type_: &str) -> bool {
    let type_cstring = match CString::new(type_) {
        Ok(s) => s,
        Err(_) => return false,
    };
    (unsafe { libblkid_rs_sys::blkid_known_pttype(type_cstring.as_ptr()) }) != 0
}

/// Get the name of a partition type at the given index in the libblkid
/// internal state.
///
/// This method in libblkid exposes implementation details of the library. There
/// is no way to map indices to types without duplicating logic inside and outside
/// of the library.
pub fn get_partition_name(index: usize) -> Result<&'static str> {
    let mut name_ptr: *const libc::c_char = ptr::null();
    errno!(unsafe { libblkid_rs_sys::blkid_partitions_get_name(index, &mut name_ptr as *mut _) })?;
    let name = unsafe { CStr::from_ptr(name_ptr) }.to_str()?;
    Ok(name)
}