sysfs

概述

参考：
Manual(手册)，sysfs(5)
在 Man 中最后的 See Also 中提到了下面几个文档
https://github.com/torvalds/linux/blob/master/Documentation/filesystems/sysfs.rst
Documentation/ABI
Documentation/*/sysfs.txt
基于此，可以通过在 Linux 仓库的 go to file 搜索框中，输入 Documentation/sysfs 这种关键字，找到很多与 sysfs 相关的文件。TODO: 如何利用 path 关键字使用统配或正则在 github 全局搜索文件？
Kernel 文档，管理员指南 - 关于如何访问 sysfs 中信息的规则
Kernel 文档，管理员指南 - Linux ABI 描述
Wiki，Sysfs

用于导出 kernel objects(内核对象，简称 kobject) 的文件系统。对于在系统中注册的每个 kobject，都会在 sysfs 中为其创建一个目录。该目录被创建为 kobject 父目录的子目录，向用户空间表达内部对象层次结构。 sysfs 中的顶级目录代表对象层次结构的共同祖先；即对象所属的子系统。

Sys File System(sys 文件系统，简称 sysfs) 是一个 pseudo-filesystem(伪文件系统)，提供内核数据结构的接口(更准确地说，sysfs 中的文件和目录提供了内核内部定义的 kobject 结构的视图)。sysfs 下的文件提供关于设备、内核模块、文件系统和其他内核组件的信息。sysfs 一般挂载到 /sys 目录。通常情况下，系统会自动挂载它，但也可以使用 mount -t sysfs sysfs /sys 命令手动挂载

sysfs 文件系统中的许多文件都是只读的，但是某些文件是可写的，从而允许更改内核变量。为了避免冗余，符号链接被大量用于连接整个文件系统树中的条目。

在 sysfs 中，不管是 pci、usb、bus、etc. 硬件都抽象为 devices(设备)

[!Attention] 重要 sysfs 中的 /sys/devices/ 目录是非常重要且关键的目录，/sys/ 下的其他目录中的内容，有很多都是指向 /sys/devices/ 目录中的软链接。

sysfs 背景

Sysfs 文件系统是一个类似于 proc 的特殊文件系统，用于将系统中的设备组织成层次结构，并向用户模式程序提供详细的内核数据结构信息。

在 2.5 开发周期中，引入了 Linux 驱动程序模型来修复版本 2.4 的以下缺陷：

不存在表示驱动程序与设备关系的统一方法。
没有通用的热插拔机制。
procfs 充斥着非过程信息。

Sysfs 的设计目的是导出设备树中存在的信息，从而不再使过程变得混乱。它是由 Patrick Mochel 撰写的。Maneesh Soni 后来编写了 sysfs 后备存储修补程序，以减少大型系统上的内存使用量。

在 2.5 开发的第二年，驱动程序模型和 driverfs（以前称为 ddfs）的基础结构功能开始被证明对其他子系统有用。开发了 kobjects 以提供中央对象管理机制，并且将 driverfs 重命名为 sysfs 以表示其子系统不可知论。

参考：https://unix.stackexchange.com/questions/4884/what-is-the-difference-between-procfs-and-sysfs

从一开始（在 Unix 时代开始），程序就了解系统上正在运行的进程的方法是直接从内核内存中读取进程结构（打开 /dev/mem，并直接解释原始数据）。这就是最初的 ps 命令的工作方式。随着时间的流逝，一些信息可以通过系统调用获得。

但是，通过 /dev/mem 将系统数据直接公开给用户空间是一种不好的形式，并且每次您要导出一些新的过程数据时都不断地创建新的系统调用是令人讨厌的，因此创建了一种新的方法访问用户空间应用程序的结构化数据以查找有关流程属性的信息。这是 /proc 文件系统。使用 /proc，即使内核中的基础数据结构发生了变化，接口和结构（目录和文件）也可以保持不变。与以前的系统相比，它不那么脆弱，并且扩展性更好。

/proc 文件系统最初旨在发布过程信息和一些关键系统属性，这些属性是“ ps”，“ top”，“ free”和其他一些系统实用程序所必需的。但是，由于易于使用（从内核和用户空间两个方面来看），它成为了整个系统信息的垃圾场。而且，它开始获取读/写文件，用于调整设置并控制内核或其各个子系统的操作。但是，实现控制接口的方法是临时的，并且 /proc 很快陷入混乱。

sysfs（或 /sys 文件系统）旨在为这种混乱增加结构，并提供一种统一的方式来从内核向用户空间公开系统信息和控制点（可设置的系统和驱动程序属性）。现在，注册驱动程序时，内核中的驱动程序框架会根据驱动程序类型及其数据结构中的值自动在 /sys 下创建目录。这意味着特定类型的驱动程序都将具有通过 sysfs 公开的相同元素。

/proc 中仍然可以访问许多旧版系统信息和控制点，但是所有新的 Bus 和驱动程序都应通过 sysfs 公开其信息和控制点。

访问 sysfs 信息的规则

目前有 3 个地方可以对设备进行分类

/sys/block/
/sys/class/
/sys/bus/

上面三个目录的分类目录下的目录实际上都是指向 /sys/devices/ 目录的 Symbolic link(符号链接)。

~]# ls /sys/block/ -l
total 0
lrwxrwxrwx 1 root root 0  6月 14 16:55 sda -> ../devices/pci0000:00/0000:00:1c.4/0000:0a:00.0/host0/target0:2:0/0:2:0:0/block/sda
lrwxrwxrwx 1 root root 0  6月 14 16:55 sdb -> ../devices/pci0000:00/0000:00:1c.4/0000:0a:00.0/host0/target0:2:1/0:2:1:0/block/sdb

~]# ls /sys/class/net/ -l
total 0
lrwxrwxrwx 1 root root 0  6月 14 16:55 br0 -> ../../devices/virtual/net/br0
lrwxrwxrwx 1 root root 0  6月 14 16:55 eno3 -> ../../devices/pci0000:00/0000:00:1c.3/0000:01:00.0/net/eno3
lrwxrwxrwx 1 root root 0  6月 14 16:55 eno4 -> ../../devices/pci0000:00/0000:00:1c.3/0000:01:00.1/net/eno4
lrwxrwxrwx 1 root root 0  6月 14 16:55 lo -> ../../devices/virtual/net/lo
lrwxrwxrwx 1 root root 0  6月 14 16:55 virbr0 -> ../../devices/virtual/net/virbr0
lrwxrwxrwx 1 root root 0  6月 14 16:55 virbr0-nic -> ../../devices/virtual/net/virbr0-nic

~]# ls /sys/bus/memory/devices/ -l
total 0
lrwxrwxrwx 1 root root 0  6月 14 16:55 memory0 -> ../../../devices/system/memory/memory0
lrwxrwxrwx 1 root root 0  6月 14 16:55 memory10 -> ../../../devices/system/memory/memory10
lrwxrwxrwx 1 root root 0  6月 14 16:55 memory100 -> ../../../devices/system/memory/memory100
......略

/sys/block/

参考：
Kernel 文档，管理员指南 - ABI stable 符号链接 - /sys/block 下的符号链接
Kernel 文档，Block

该目录下的所有子目录代表着系统中当前被发现的所有块设备。

按照功能来说放置在 /sys/class/ 下会更合适，但由于历史遗留因素而一直存在于 /sys/block，但从 linux2.6.22 内核开始这部分就已经标记为过去时，只有打开了 CONFIG_SYSFS_DEPRECATED 配置编译才会有这个目录存在，并且其中的内容在从 linux2.6.26 版本开始已经正式移到了 /sys/class/block/，旧的接口 /sys/block/ 为了向后兼容而保留存在，但其中的内容已经变为了指向它们在 /sys/devices/ 中真实设备的符号链接文件。

~]# ll /sys/block/
total 0
drwxr-xr-x  2 root root 0 Apr  1 14:36 ./
dr-xr-xr-x 13 root root 0 Apr  1 14:36 ../
lrwxrwxrwx  1 root root 0 Apr  1 14:36 dm-0 -> ../devices/virtual/block/dm-0/
lrwxrwxrwx  1 root root 0 Apr  1 14:36 dm-1 -> ../devices/virtual/block/dm-1/
lrwxrwxrwx  1 root root 0 Apr  1 14:36 loop0 -> ../devices/virtual/block/loop0/
lrwxrwxrwx  1 root root 0 Apr  1 14:36 loop1 -> ../devices/virtual/block/loop1/
lrwxrwxrwx  1 root root 0 Apr  1 14:36 loop2 -> ../devices/virtual/block/loop2/
lrwxrwxrwx  1 root root 0 Apr  1 14:36 loop3 -> ../devices/virtual/block/loop3/
lrwxrwxrwx  1 root root 0 Apr  1 14:36 loop4 -> ../devices/virtual/block/loop4/
lrwxrwxrwx  1 root root 0 Apr  1 14:36 loop5 -> ../devices/virtual/block/loop5/
lrwxrwxrwx  1 root root 0 Apr  1 14:36 loop6 -> ../devices/virtual/block/loop6/
lrwxrwxrwx  1 root root 0 Apr  1 14:36 loop7 -> ../devices/virtual/block/loop7/
lrwxrwxrwx  1 root root 0 Apr  1 14:36 sr0 -> ../devices/pci0000:00/0000:00:01.1/ata1/host0/target0:0:0/0:0:0:0/block/sr0/
lrwxrwxrwx  1 root root 0 Apr  1 14:36 vda -> ../devices/pci0000:00/0000:00:07.0/virtio2/block/vda/

/sys/block/<BLOCK>/queue/

./rotational # 块设备旋转的类型，旋转就是 HHD，不旋转就是 SSD，非常形象生动得比喻磁盘使用的情况~哈哈。0 表示 SSD，1 表示 HDD
- 注意：如果磁盘已经被做了 Raid，那么这个值将会一直都是 1。这个说法忘记了出处，找到后补充。

/sys/bus/

该目录包含内核按照 Bus 类型分类的子目录。/sys/bus/${BUS_TYPE}/，pci、usb、virtio、etc. 都属于一种 BUS_TYPE。

一般来说每个 BUS_TYPE 子目录至少包含两个子目录

./devices/ # 在此种总线上发现的设备，该目录下的子目录都是指向 /sys/devices/ 的符号链接
./drivers/ # 加载到此种总线上的设备的 Driver(驱动程序)，每个 driver/ 子目录下是一些可以观察和修改的 driver 参数。

./
├── ac97/
│   ├── devices/
│   ├── drivers/
│   ├── drivers_autoprobe
│   ├── drivers_probe
│   └── uevent
├── acpi/
│   ├── devices/
│   │   ├── device:00 -> ../../../devices/LNXSYSTM:00/LNXSYBUS:00/PNP0A08:00/device:00/
│   │   ├── device:01 -> ../../../devices/LNXSYSTM:00/LNXSYBUS:00/PNP0A08:00/device:01/
......略
├── cpu/
│   ├── devices/
│   │   ├── cpu0 -> ../../../devices/system/cpu/cpu0/
│   │   ├── cpu1 -> ../../../devices/system/cpu/cpu1/
│   │   ├── cpu2 -> ../../../devices/system/cpu/cpu2/
│   │   └── cpu3 -> ../../../devices/system/cpu/cpu3/
│   ├── drivers/
│   │   └── processor/
│   ├── drivers_autoprobe
│   ├── drivers_probe
│   └── uevent
......略
├── pci/
│   ├── devices/
│   │   ├── 0000:00:00.0 -> ../../../devices/pci0000:00/0000:00:00.0/
│   │   ├── 0000:00:00.3 -> ../../../devices/pci0000:00/0000:00:00.3/
│   │   └── 0000:02:00.0 -> ../../../devices/pci0000:00/0000:00:13.1/0000:02:00.0/
│   ├── drivers/
│   │   ├── 8250_mid/
│   │   ├── agpgart-intel/
......略
├── virtio/
│   ├── devices/
│   ├── drivers/
│   │   ├── virtio_balloon/
│   │   ├── virtio_console/
│   │   ├── virtio_iommu/
│   │   └── virtio_rproc_serial/
│   ├── drivers_autoprobe
│   ├── drivers_probe
│   └── uevent
......略

应用 1：msp700 中计算电池电压

PipeADC5 = popen(“cat /sys/bus/iio/devices/iio\:device0/in_voltage5_raw”, “r”);

应用 2：改变提醒等级

echo 6 > /proc/sys/kernel/printk；

应用 3：msp700 中设置背光

echo 20 > /sys/class/backlight/pwm-backlight/brightness;

等价于：

echo 20 > /sys/bus/platform/devices/pwm-backlight/backlight/pwm-backlight/brightness;

/sys/class/

该目录下包含已在系统种注册的每个设备，子目录按照设备功能分类，目录结构如下

/sys/class/${DEVICE_TYPE}/${DEVICE}/

terminal(终端)、network(网络)、block(磁盘)、graphic(图形)、sound(声音)、etc. 都属于一种 DEVICE_TYPE。不同机器可能并不一定包含所有类型，这个取决于系统启动时加载了哪些类型的设备。

/sys/class/${DEVICE_TYPE}/${DEVICE}/ 目录下的文件是指向 /sys/devices/ Symbolic link(符号链接)。这些文件通常都是以人类可读的名字命名。

Tip: 设备类型和设备并没有一一对应的关系，一个物理设备可能具备多种设备类型；一个设备类型只表达具有一种功能的设备，e.g. 系统所有输入设备都会出现在 /sys/class/input/ 目录中，而不论它们是以何种总线连接到系统的。

~]# ls /sys/class/
ata_device     dma             i2c-dev   pci_epc       rfkill        tpmrm
ata_link       dmi             input     phy           rtc           tty
ata_port       drm             iommu     powercap      scsi_device   vc
backlight      drm_dp_aux_dev  leds      power_supply  scsi_disk     vfio
bdi            extcon          mdio_bus  ppp           scsi_generic  virtio-ports
block          firmware        mem       pps           scsi_host     vtconsole
bsg            gpio            misc      ptp           sound         wakeup
dax            graphics        mmc_host  pwm           spi_master    watchdog
devcoredump    hidraw          nd        rapidio_port  spi_slave
devfreq        hwmon           net       regulator     thermal
devfreq-event  i2c-adapter     pci_bus   remoteproc    tpm

# 从 /sys/class/net 可以看到所有网络设备，通过软链接进入目录，可以看到包括网络设备的各种状态(传输的总字节数、etc.)、网络设备的信息(品牌、型号、etc.)、etc.。
~]# ls -l /sys/class/net
总用量 0
drwxr-xr-x  2 root root 0 9月   1 10:35 ./
drwxr-xr-x 73 root root 0 9月   1 10:35 ../
lrwxrwxrwx  1 root root 0 9月   1 10:35 ens3 -> ../../devices/pci0000:00/0000:00:03.0/virtio0/net/ens3/
lrwxrwxrwx  1 root root 0 9月   1 10:35 lo -> ../../devices/virtual/net/lo/
lrwxrwxrwx  1 root root 0 9月   1 10:50 wg0 -> ../../devices/virtual/net/wg0/

/sys/class/block/DEVICE/ # 块设备信息，DEVICE 是块设备的名称，用来顶替 /sys/block/ 目录，软链接到 /sys/device/ 中的某个目录。

/sys/class/net/DEVICE/ # 网络设备信息，DEVICE 是网络设备的名称。绝大部分文件都软链接到 /sys/devices/XXX/TO/XXX/net/ 目录下与网络设备同名的目录。XXX 一般以 pci 开头或 virtual 为名。

TODO: etc.

/sys/dev/

该目录下存放主次设备号文件，其中分成字符设备、块设备的主次设备号码(major:minor)组成的文件名，该文件是链接文件并且链接到其真实的设备(/sys/devices)。

/sys/devices/

这是一个包含内核设备树的文件系统表示的目录，内核设备树是内核内设备结构的层次结构。

该目录下是全局设备结构体系，包含所有被发现的注册在各种总线上的各种物理设备。/sys/ 目录中，只要有关于设备信息的目录，都会是指向 /sys/devices/ 目录下某个目录的软链接。由于 /sys/devices/ 目录结构对设备的分类是按照总线拓扑结构分的，那么对于设备类型来说，就缺乏分类了，所以至今还保留了 /sys/block/、/sys/class/、etc. 之类的目录，将设备以类型进行区分。这些区分设备类型的目录下存放的，实际上是指向 /sys/devices/ 目录的 Symbolic link(符号链接)。

一般来说，所有的物理设备都按其在总线上的拓扑结构来显示，但有两个例外即 platform devices 和 system devices。

platform devices 一般是挂在芯片内部的高速或者低速总线上的各种控制器和外设，它们能被 CPU 直接寻址；
system devices 不是外设，而是芯片内部的核心结构，比如 CPU，timer 等，它们一般没有相关的驱动，但是会有一些体系结构相关的代码来配置它们。

/sys/devices/ 是内核对系统中所有设备的分层次表达模型，也是 sysfs 管理设备的最重要的目录结构。

~]# ls /sys/devices/
breakpoint  kprobe       msr         platform  software  tracepoint  virtual
isa         LNXSYSTM:00  pci0000:00  pnp0      system    uprobe

~]# ls /sys/devices/platform/
 eisa.0              intel_rapl_msr.0   power        uevent
'Fixed MDIO bus.0'   kgdboc             reg-dummy    vesa-framebuffer.0
 i8042               pcspkr             serial8250

~]# ls /sys/devices/system/
clockevents  clocksource  container  cpu  edac  machinecheck  memory  node

/sys/firmware/

这里是系统加载固件机制的对用户空间的接口，关于固件有专用于固件加载的一套 API，在附录 LDD3 一书中有关于内核支持固件加载机制的更详细的介绍；

/sys/fs/

此目录包含某些文件系统的子目录。仅当文件系统选择显式创建子目录时，才会在此处具有子目录。

/sys/kernel/

这个目录下存放的是中所有可调整的参数。

/sys/module/

该目录下有系统中所有的模块信息，不论这些模块是以内联(inlined)方式编译到内核映像文件中还是编译为外模块(.ko 文件)，都可能出现在/sys/module 中。即 module 目录下包含了所有的被载入 kernel 的模块。

/sys/power/

该目录是系统中的电源选项，对正在使用的 power 子系统的描述。这个目录下有几个属性文件可以用于控制整个机器的电源状态，如可以向其中写入控制命令让机器关机/重启等等。

~]# ls /sys/power/
pm_async      pm_test       state         wakeup_count

反馈

此页是否对你有帮助？

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

最后修改 August 28, 2024: pci, driver, bus (57bf1c0b)