Struct SmartLog 

pub struct SmartLog { /* private fields */ }

Decoded SMART / Health Information log page (LID 02h).

Counters that the spec defines as 128-bit are exposed as u128. Times are reported in minutes (per the NVMe spec).

Implementations

impl SmartLog

pub fn critical_warning(&self) -> u8

Critical warning bitfield: spare, temperature, degraded reliability, media read-only, volatile memory backup failure, persistent memory read-only. See NVME_SMART_CRIT_* constants in libnvme-sys.

Examples found in repository

examples/smart_log.rs (line 44)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn temperature_kelvin(&self) -> u16

Composite temperature in Kelvin.

Examples found in repository

examples/smart_log.rs (line 27)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn temperature_celsius(&self) -> i16

Composite temperature in Celsius.

Examples found in repository

examples/smart_log.rs (line 28)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn available_spare(&self) -> u8

Available spare capacity as a percentage of normalized spare.

Examples found in repository

examples/smart_log.rs (line 32)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn available_spare_threshold(&self) -> u8

Threshold below which critical_warning flags the spare condition.

Examples found in repository

examples/smart_log.rs (line 33)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn percentage_used(&self) -> u8

Vendor-specific estimate of life used, as a percentage. May exceed 100.

Examples found in repository

examples/smart_log.rs (line 35)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn endurance_group_critical_warning(&self) -> u8

Endurance group critical warning summary.

pub fn data_units_read(&self) -> u128

Number of 512-byte data units the host has read from the controller, in thousands. Multiply by 1000 and by 512 for total bytes read.

Examples found in repository

examples/smart_log.rs (line 36)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn data_units_written(&self) -> u128

Number of 512-byte data units the host has written to the controller, in thousands. See data_units_read.

Examples found in repository

examples/smart_log.rs (line 37)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn host_read_commands(&self) -> u128

Number of read commands completed by the controller.

Examples found in repository

examples/smart_log.rs (line 38)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn host_write_commands(&self) -> u128

Number of write commands completed by the controller.

Examples found in repository

examples/smart_log.rs (line 39)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn controller_busy_time_minutes(&self) -> u128

Time the controller has been busy with I/O commands, in minutes.

pub fn power_cycles(&self) -> u128

Number of power-on/off cycles experienced by the controller.

Examples found in repository

examples/smart_log.rs (line 40)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn power_on_hours(&self) -> u128

Cumulative power-on time in hours.

Examples found in repository

examples/smart_log.rs (line 41)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn unsafe_shutdowns(&self) -> u128

Number of unsafe shutdowns (loss of power without a normal shutdown).

Examples found in repository

examples/smart_log.rs (line 42)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn media_errors(&self) -> u128

Number of media or data integrity errors detected.

Examples found in repository

examples/smart_log.rs (line 43)

fn print_smart(ctrl: &libnvme::Controller<'_>) -> Result<(), Box<dyn std::error::Error>> {
    println!("=== {} ===", ctrl.name()?);
    let log = ctrl.smart_log()?;
    println!(
        "  temperature        : {} K ({} C)",
        log.temperature_kelvin(),
        log.temperature_celsius()
    );
    println!(
        "  available spare    : {}% (threshold {}%)",
        log.available_spare(),
        log.available_spare_threshold()
    );
    println!("  percentage used    : {}%", log.percentage_used());
    println!("  data units read    : {}", log.data_units_read());
    println!("  data units written : {}", log.data_units_written());
    println!("  host read cmds     : {}", log.host_read_commands());
    println!("  host write cmds    : {}", log.host_write_commands());
    println!("  power cycles       : {}", log.power_cycles());
    println!("  power on hours     : {}", log.power_on_hours());
    println!("  unsafe shutdowns   : {}", log.unsafe_shutdowns());
    println!("  media errors       : {}", log.media_errors());
    println!("  critical warning   : 0x{:02x}", log.critical_warning());
    println!();
    Ok(())
}

pub fn num_error_log_entries(&self) -> u128

Number of entries in the Error Information Log.

pub fn warning_temp_time_minutes(&self) -> u32

Time the composite temperature has exceeded the warning threshold, in minutes.

pub fn critical_temp_time_minutes(&self) -> u32

Time the composite temperature has exceeded the critical threshold, in minutes.

pub fn temperature_sensor_kelvin(&self, index: u8) -> Option<u16>

Temperature sensor reading in Kelvin (index is 1..=8). Returns None for out-of-range indices or unreported sensors (0).

Trait Implementations

impl Debug for SmartLog

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.