block-utils 0.11.1

Utilities to work with block devices. Formatting, getting device info, identifying type of device, etc.
Documentation 
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use crate::{BlockResult, BlockUtilsError};
use serde::{Deserialize, Serialize};
use std::path::Path;
use std::process::Command;

#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct NvmeDevice {
    pub name_space: u64,
    pub device_path: String,
    pub index: Option<u64>,
    pub model_number: String,
    pub product_name: Option<String>,
    pub firmware: Option<String>,
    pub serial_number: String,
    pub used_bytes: u64,
    #[serde(rename = "MaximumLBA")]
    pub maximum_lba: u64,
    pub physical_size: u64,
    pub sector_size: u32,
}

#[derive(Deserialize)]
#[serde(rename_all = "PascalCase")]
struct NvmeDeviceContainer {
    devices: Vec<NvmeDevice>,
}

/// Retrieve the error logs from the nvme device
pub fn get_error_log(dev: &Path) -> BlockResult<serde_json::Value> {
    let out = Command::new("nvme")
        .args(&["error-log", &dev.to_string_lossy(), "-o", "json"])
        .output()?;
    if !out.status.success() {
        return Err(BlockUtilsError::new(
            String::from_utf8_lossy(&out.stderr).into_owned(),
        ));
    }
    let stdout = String::from_utf8_lossy(&out.stdout);
    let deserialized: serde_json::Value = serde_json::from_str(&stdout)?;
    Ok(deserialized)
}

/// Retrieve the firmware logs from the nvme device
pub fn get_firmware_log(dev: &Path) -> BlockResult<serde_json::Value> {
    let out = Command::new("nvme")
        .args(&["fw-log", &dev.to_string_lossy(), "-o", "json"])
        .output()?;
    if !out.status.success() {
        return Err(BlockUtilsError::new(
            String::from_utf8_lossy(&out.stderr).into_owned(),
        ));
    }
    let stdout = String::from_utf8_lossy(&out.stdout);
    let deserialized: serde_json::Value = serde_json::from_str(&stdout)?;
    Ok(deserialized)
}

/// Retrieve the smart logs from the nvme device
pub fn get_smart_log(dev: &Path) -> BlockResult<serde_json::Value> {
    let out = Command::new("nvme")
        .args(&["smart-log", &dev.to_string_lossy(), "-o", "json"])
        .output()?;
    if !out.status.success() {
        return Err(BlockUtilsError::new(
            String::from_utf8_lossy(&out.stderr).into_owned(),
        ));
    }
    let stdout = String::from_utf8_lossy(&out.stdout);
    let deserialized: serde_json::Value = serde_json::from_str(&stdout)?;
    Ok(deserialized)
}

/// Retrieve a log page from the nvme device
pub fn get_log(dev: &Path, id: u8, len: u16) -> BlockResult<Vec<u8>> {
    let out = Command::new("nvme")
        .args(&[
            "get-log",
            &dev.to_string_lossy(),
            "-i",
            id.to_string().as_str(),
            "-l",
            len.to_string().as_str(),
            "-b",
        ])
        .output()?;
    if !out.status.success() {
        return Err(BlockUtilsError::new(
            String::from_utf8_lossy(&out.stderr).into_owned(),
        ));
    }
    let stdout: Vec<u8> = out.stdout;
    Ok(stdout)
}

// Format an nvme block device
pub fn format(dev: &Path) -> BlockResult<()> {
    let out = Command::new("nvme")
        .args(&["format", &dev.to_string_lossy()])
        .output()?;
    if !out.status.success() {
        return Err(BlockUtilsError::new(
            String::from_utf8_lossy(&out.stderr).into_owned(),
        ));
    }
    Ok(())
}

pub fn list_nvme_namespaces(dev: &Path) -> BlockResult<Vec<String>> {
    let out = Command::new("nvme")
        .args(&["list-ns", &dev.to_string_lossy(), "-o", "json"])
        .output()?;
    if !out.status.success() {
        return Err(BlockUtilsError::new(
            String::from_utf8_lossy(&out.stderr).into_owned(),
        ));
    }
    let stdout = String::from_utf8_lossy(&out.stdout);
    let deserialized: Vec<String> = serde_json::from_str(&stdout)?;
    Ok(deserialized)
}

/// List the nvme controllers on the host
pub fn list_nvme_controllers() -> BlockResult<Vec<String>> {
    let out = Command::new("nvme-list").args(&["-o", "json"]).output()?;
    if !out.status.success() {
        return Err(BlockUtilsError::new(
            String::from_utf8_lossy(&out.stderr).into_owned(),
        ));
    }
    let stdout = String::from_utf8_lossy(&out.stdout);
    let deserialized: Vec<String> = serde_json::from_str(&stdout)?;
    Ok(deserialized)
}

/// List the nvme devices on the host
pub fn list_nvme_devices() -> BlockResult<Vec<NvmeDevice>> {
    let out = Command::new("nvme")
        .args(&["list", "-o", "json"])
        .output()?;
    if !out.status.success() {
        return Err(BlockUtilsError::new(
            String::from_utf8_lossy(&out.stderr).into_owned(),
        ));
    }
    let stdout = String::from_utf8_lossy(&out.stdout);
    let deserialized: NvmeDeviceContainer = serde_json::from_str(&stdout)?;
    Ok(deserialized.devices)
}