pci-info 0.3.3

A crate to enumerate PCI devices on desktop operating systems and/or parse PCI configuration headers
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

use std::path::PathBuf;

use crate::{PciInfo, PciInfoError};

#[cfg(target_os = "linux")]
mod proc_fs;

/// A PCI Enumerator for Linux that uses in the
/// virtual `/proc` file system to extract PCI data
#[derive(Copy, Clone, Eq, PartialEq, Debug)]
pub enum LinuxProcFsPciEnumerator {
    /// Enumerates the PCI devices in the fastest way possible,
    /// returning only PCI locations, vendor and device ids and
    /// some OS related data. Data is read from the `/proc/bus/pci/devices`
    /// file.
    Fastest,
    /// Enumerates the PCI devices using only the PCI configuration
    /// contained in `/proc/bus/pci` subdirectories. Does not parse
    /// the `/proc/bus/pci/devices` file.
    HeadersOnly,
    /// Enumerates the PCI devices using the PCI configuration
    /// contained in `/proc/bus/pci` subdirectories and the
    /// `/proc/bus/pci/devices` file. Data from specific PCI headers
    /// is not parsed and some fields might be missing (most notably,
    /// the subsystem ids).
    SkipNoncommonHeaders,
    /// Enumerates the PCI devices using the PCI configuration
    /// contained in `/proc/bus/pci` subdirectories and the
    /// `/proc/bus/pci/devices` file. This option provides the most
    /// extensive data about PCI devices.
    Exhaustive,
}

impl crate::PciEnumerator for LinuxProcFsPciEnumerator {
    fn enumerate_pci(self) -> Result<PciInfo, PciInfoError> {
        let (read_headers, read_extended_headers, read_device_file) = self.into_arguments();
        let path = PathBuf::from("/proc/bus");

        #[cfg(target_os = "linux")]
        proc_fs::enumerate_pci(path, read_headers, read_extended_headers, read_device_file)
    }
}

impl LinuxProcFsPciEnumerator {
    /// Creates an enumerator that enumerates PCI devices reading from a copy of the
    /// `/proc/bus/pci` subdirectory. `path` should point to a directory that contains
    /// a `pci/` subdirectory in it.
    pub fn with_custom_path<P>(self, path: P) -> CustomPathLinuxProcFsPciEnumerator
    where
        P: AsRef<std::path::Path>,
    {
        let path = path.as_ref().to_owned();
        let (read_headers, read_extended_headers, read_device_file) = self.into_arguments();

        CustomPathLinuxProcFsPciEnumerator {
            path,
            read_device_file,
            read_extended_headers,
            read_headers,
        }
    }

    fn into_arguments(self) -> (bool, bool, bool) {
        match self {
            Self::Fastest => (false, false, true),
            Self::HeadersOnly => (true, true, false),
            Self::SkipNoncommonHeaders => (true, false, true),
            Self::Exhaustive => (true, true, true),
        }
    }
}

/// An enumerator that enumerates PCI devices reading from a copy of
/// the /proc/bus/pci directory. See `LinuxProcFsPciEnumerator::with_custom_path`
/// to build an enumerator of this type.
pub struct CustomPathLinuxProcFsPciEnumerator {
    path: std::path::PathBuf,
    read_headers: bool,
    read_extended_headers: bool,
    read_device_file: bool,
}

impl crate::PciEnumerator for CustomPathLinuxProcFsPciEnumerator {
    fn enumerate_pci(self) -> Result<PciInfo, PciInfoError> {
        #[cfg(target_os = "linux")]
        proc_fs::enumerate_pci(
            self.path,
            self.read_headers,
            self.read_extended_headers,
            self.read_device_file,
        )
    }
}

test_enumerator!(
    LinuxProcFsPciEnumeratorFastest,
    LinuxProcFsPciEnumerator::Fastest
);
test_enumerator!(
    LinuxProcFsPciEnumeratorExhaustive,
    LinuxProcFsPciEnumerator::Exhaustive
);
test_enumerator!(
    LinuxProcFsPciEnumeratorHeadersOnly,
    LinuxProcFsPciEnumerator::HeadersOnly
);
test_enumerator!(
    LinuxProcFsPciEnumeratorSkipNoncommonHeaders,
    LinuxProcFsPciEnumerator::SkipNoncommonHeaders
);
test_enumerator!(
    LinuxProcFsPciEnumeratorExhaustiveAmd64,
    LinuxProcFsPciEnumerator::Exhaustive.with_custom_path("test-data/linux/amd64")
);
test_enumerator!(
    LinuxProcFsPciEnumeratorExhaustiveAarch64,
    LinuxProcFsPciEnumerator::Exhaustive.with_custom_path("test-data/linux/aarch64")
);