Linux 内核/sys 文件系统之sysfs 属性文件

红太狼 2022-04-01 15:14 373阅读 0赞

以上所举的例子仅仅是一些常见的 sysfs 属性用法，实际的系统中还常常有很多其它的从未见过的 sysfs 属性，因此只有举例是不够的，即使维护了一份 sysfs 属性用法参考大全也不够，未来的[内核][Link 1]版本还会出现新的 sysfs 属性，因此还必须了解 Linux [内核][Link 1]代码以找到实现这些属性的代码位置，以学会在没有相应属性文档的情况从[内核][Link 1]源代码来分析其 sysfs 属性功能。

Sysfs 源码分析和编程实践

从源代码中理解 sysfs 属性的用途

更多的 sysfs 属性的功能只能靠阅读源代码来理解。还是以上文提到的 scsi\_host 的 scan 属性来理解，这个功能没有任何文档上有描述，因此只能去读源代码。

在[内核][Link 1]中， sysfs 属性一般是由 \_\_ATTR 系列的宏来声明的，如对设备的使用 DEVICE\_ATTR ，对总线使用 BUS\_ATTR ，对驱动使用 DRIVER\_ATTR ，对类别(class)使用 CLASS\_ATTR, 这四个高级的宏来自于 <include/linux/device.h>, 都是以更低层的来自 <include/linux/sysfs.h> 中的 \_\_ATTR/\_\_ATRR\_RO 宏实现； 因此我们在[内核][Link 1]源码树中相应位置 drivers/scsi/ 找到这几个宏的使用情况，可以得到在 drivers/scsi/scsi\_sysfs.c 中：

<table> 
 <tbody> 
  <tr> 
   <td><span style="font-size:medium;">&nbsp; </span> 
    <table> 
     <tbody> 
      <tr> 
       <td> <pre><span style="font-size:medium;">static ssize_t
store_scan(struct device *dev, struct device_attribute *attr,
           const char *buf, size_t count)
{
        struct Scsi_Host *shost = class_to_shost(dev);
        int res;

res = scsi_scan(shost, buf);
        if (res == 0)
                res = count;
        return res;
};
static DEVICE_ATTR(scan, S_IWUSR, NULL, store_scan);</span></pre> </td> 
      </tr> 
     </tbody> 
    </table><br></td> 
  </tr> 
 </tbody> 
</table>

DEVICE\_ATTR 宏声明有四个参数，分别是名称、权限位、读函数、写函数。这里对应的，名称是 scan, 权限是只有属主可写(S\_IWUSR)、没有读函数、只有写函数。因此读写功能与权限位是对应的，因为 DEVICE\_ATTR 把权限位声明与真正的读写是否实现放在了一起，减少了出现不一致的可能。(上文提到 /proc/scsi/scsi 接口的权限位声明与其功能不对应，这与注册 proc 接口的函数设计中的不一致是有关系的，权限位声明与功能实现不在代码中同一个位置，因此易出错。虽然修复 /proc/scsi/scsi 的权限位错误很容易，但[内核][Link 1]团队中多年来一直没有人发现或未有人去修正这个 BUG，应该是与 /proc/scsi/ 接口的过时有关，过时的功能会在未来某个[内核][Link 1]版本中去除。)

上面的 scan 属性写入功能是在 store\_scan 函数中实现的，这个接口的四个参数中， buf/count 代表用户写入过来的字符串，它把 buf 进一步传给了 scsi\_scan 函数；如果进一步分析 scsi\_scan 函数实现可以知道，它期望从 buf 中接受三个或四个整型值(也接受"-"作为通配符)，分别代表 host, channel, id 三个值，(第四个整数在早期[内核][Link 1]中曾代表 lun 号码，但在较新[内核][Link 1]中第四个数字被忽略，仅作为向后兼容保留接受四个整数)，然后对具体的 (host, channel, id) 进行重新扫描以发现这个 SCSI 控制器上的设备变动。

**添加 sysfs 支持**

如果你正在[开发][Link 2]的设备驱动程序中需要与用户层的接口，一般可选的方法有：

注册虚拟的字符设备文件，以这个虚拟设备上的 read/write/ioctl 等接口与用户交互；但 read/write 一般只能做一件事情， ioctl 可以根据 cmd 参数做多个功能，但其缺点是很明显的： ioctl 接口无法直接在 Shell 脚本中使用，为了使用 ioctl 的功能，还必须编写配套的 C语言的虚拟设备操作程序， ioctl 的二进制数据接口也是造成大小端问题 (big endian与little endian)、32位/64位不可移植问题的根源；  
注册 proc 接口，接受用户的 read/write/ioctl 操作；同样的，一个 proc 项通常使用其 read/write/ioctl 接口，它所存在的问题与上面的虚拟字符设备的的问题相似；  
注册 sysfs 属性；  
最重要的是，添加虚拟字符设备支持和注册 proc 接口支持这两者所需要增加的代码量都并不少，最好的方法还是使用 sysfs 属性支持，一切在用户层是可见的透明，且增加的代码量是最少的，可维护性也最好；方法就是使用 <include/linux/device.h> 头文件提供的这四个宏，分别应用于总线/类别/驱动/设备四种[内核][Link 1]数据结构对象上：

<table> 
 <tbody> 
  <tr> 
   <td><span style="font-size:medium;">&nbsp;</span> <pre><span style="font-size:medium;">#define BUS_ATTR(_name, _mode, _show, _store)   
struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)

#define CLASS_ATTR(_name, _mode, _show, _store)                 
struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)

#define DRIVER_ATTR(_name, _mode, _show, _store)        
struct driver_attribute driver_attr_##_name =           
        __ATTR(_name, _mode, _show, _store)

#define DEVICE_ATTR(_name, _mode, _show, _store) 
struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
</span></pre> </td> 
  </tr> 
 </tbody> 
</table>

总线(BUS)和类别(CLASS)属性一般用于新设计的总线和新设计的类别，这两者一般是不用的；因为你的设备一般是以PCI等成熟的常规方式连接到主机，而不会去新发明一种类型；使用驱动属性和设备属性的区别就在于：看你的 sysfs 属性设计是针对整个驱动有效的还是针对这份驱动所可能支持的每个设备分别有效。

从头文件中还可以找到 show/store 函数的原型，注意到它和虚拟字符设备或 proc 项的 read/write 的作用很类似，但有一点不同是 show/store 函数上的 buf/count 参数是在 sysfs 层已作了用户区/[内核][Link 1]区的内存复制，虚拟字符设备上常见的 \_\_user 属性在这里并不需要，因而也不需要多一次 copy\_from\_user/copy\_to\_user, 在 show/store 函数参数上的 buf/count 参数已经是[内核][Link 1]区的地址，可以直接操作。

上面四种都是 Linux 统一设备模型所添加的高级接口，如果使用 sysfs 所提供的底层接口的话，则还有下面两个，定义来自 <include/linux/sysfs.h> ：(上面的总线/类别/驱动/设备四个接口都是以这里的\_\_ATTR实现的)

<table> 
 <tbody> 
  <tr> 
   <td><span style="font-size:medium;">&nbsp;</span> <pre><span style="font-size:medium;">#define __ATTR(_name,_mode,_show,_store) { 
        .attr = {.name = __stringify(_name), .mode = _mode },   
        .show   = _show,                                        
	.store  = _store,                                       
}

#define __ATTR_RO(_name) { 
        .attr   = { .name = __stringify(_name), .mode = 0444 }, 
        .show   = _name##_show,                                 
}</span></pre> </td> 
  </tr> 
 </tbody> 
</table>

上面这些宏都是在注册总线/类别/驱动/设备时作为缺省属性而使用的，在实际应用中还有一种情况是根据条件动态添加属性，如 PCI 设备上的 resource\{0,1,2,...\} 属性文件，因为一个 PCI 设备上的可映射资源究竟有多少无法预知，也只能以条件判断的方式动态添加上。

<table> 
 <tbody> 
  <tr> 
   <td><span style="font-size:medium;">&nbsp;</span> <pre><span style="font-size:medium;">int __must_check sysfs_create_file(struct kobject *kobj,
                                   const struct attribute *attr);
int __must_check sysfs_create_bin_file(struct kobject *kobj,
                                       struct bin_attribute *attr); </span></pre> </td> 
  </tr> 
 </tbody> 
</table>

这两个函数可以对一个 kobject 动态添加上文本属性或二进制属性，这也是唯一可以添加二进制属性的方法。

**二进制属性与普通文本属性的区别在于：**

二进制属性 struct bin\_attribute 中内嵌一个 struct attribute 结构体对象，因此具有普通属性的所有功能特征；  
二进制属性上多一个 size 用来描述此二进制文件的大小，而普通属性文件的大小总是 4096, 准确地说，应该是一个内存页的大小，因为从当前 sysfs [内核][Link 1]实现来说，它分配一个内存页面来作为 (buf/count) 的缓冲区；  
二进制属性比普通属性多内存映射(mmap)接口的支持；  
**编程示例，对 LDD3 一书中的 lddbus 驱动程序的 sysfs 改进**

首先，这个程序本身是针对当时作者写书的年代的[内核][Link 1](2.6.11)而编写的，在当前的 Fedora10 系统 (2.6.27.5-117.fc10.i686) 上甚至无法编译编译通过；因此首先需要将它移植过来至少达到可运行状态；

附件的压缩包中含有修改过的 lddbus, sculld 的源代码和修改过程的四个patch:

第一个 0001-ldd3-examples-build-on-fedora-10-2.6.27.5-117.fc10.i.patch 是将 lddbus 和 sculld 移植到 Fedora10 [内核][Link 1]上可运行，这其中主要是一此[内核][Link 1] API 的变化；  
第二个 0002-port-dmem-proc-entry-to-use-sysfs-entry.patch 演示了怎样将原有的 proc 接口改进成为 sysfs 属性接口的，从这个 patch 中可以看到删除的代码多而新增加的代码少，这说明对于相同的功能，使用 sysfs 编程接口的代码量更少，而且 sysfs 代码看起来也比 proc 更为整洁：打印每个设备的调试信息可以做成每个设备上分别有自己的接口，而不是统一的一个 proc 接口；设备属性文件最终出现的位置如 "/sys/devices/ldd0/sculld0/dmem"；

<table> 
 <tbody> 
  <tr> 
   <td><span style="font-size:medium;">&nbsp;</span> <pre><span style="font-size:medium;">static ssize_t sculld_show_dmem(struct device *ddev,
		struct device_attribute *attr, char *buf)
{
	/* 其中打印每个设备调试信息的代码复制自原proc接口 */
}
static DEVICE_ATTR(dmem, S_IRUGO, sculld_show_dmem, NULL);
static int __init sculld_register_dev(struct sculld_dev *dev, int index)
{
	/* 创建此device属性文件 */
	ret |= device_create_file(&amp;dev-&gt;ldev.dev, &amp;dev_attr_dmem);
}</span></pre> </td> 
  </tr> 
 </tbody> 
</table>

第三个 0003-add-.gitignore.patch 是增加了 .gitignore 文件，屏蔽一些编译生成的临时文件；  
第四个 0004-port-qset-get-set-ioctl-to-use-sysfs-entry.patch 演示了怎样把基于 ioctl 的操作接口改进成为基于 sysfs 接口，由于原来的 ioctl 接口设置和获取 qset 信息是表示整个驱动模块级的变量，它用来控制整个驱动程序而非驱动所支持的单个的设备，因此这个 qset 属性使用 DRIVER\_ATTR 来添加更为合适；

<table> 
 <tbody> 
  <tr> 
   <td><span style="font-size:medium;">&nbsp;</span> <pre><span style="font-size:medium;">ssize_t sculld_show_qset(struct device_driver *driver, char *buf)
{
	return snprintf(buf, PAGE_SIZE, "%dn", sculld_qset);
}
ssize_t sculld_store_qset(struct device_driver *driver, const char *buf,
		size_t count)
{
	sculld_qset = simple_strtol(buf, NULL, 0);
	return count;
}
	/* 声明一个权限为0644的可同时读写的driver属性 */
static DRIVER_ATTR(qset, S_IRUGO | S_IWUSR, sculld_show_qset, sculld_store_qset);
	/* 创建此driver属性文件 */
	result = driver_create_file(&amp;sculld_driver.driver, &amp;driver_attr_qset);
</span></pre> </td> 
  </tr> 
 </tbody> 
</table>

驱动属性最终出现如 "/sys/bus/ldd/drivers/sculld/qset" ，这里声明的是同时可读写的，权限位 0644 与其保持一致。

6446 0 -rw-r--r-- 1 root root 4096 12月 14 07:44 /sys/bus/ldd/drivers/sculld/qset

**小结**

sysfs 给应用程序提供了统一访问设备的接口，但可以看到， sysfs 仅仅是提供了一个可以统一访问设备的框架，但究竟是否支持 sysfs 还需要各设备驱动程序的编程支持；在 2.6 [内核][Link 1]诞生 5年以来的发展中，很多子系统、设备驱动程序逐渐转向了 sysfs 作为与用户空间友好的接口，但仍然也存在大量的代码还在使用旧的 proc 或虚拟字符设备的 ioctl 方式；如果仅从最终用户的角度来说， sysfs 与 proc 都是在提供相同或类似的功能，对于旧的 proc 代码，没有绝对的必要去做 proc 至 sysfs 的升级；因此在可预见的将来， sysfs 会与 proc, debugfs, configfs 等共存很长一段时间。

[Link 1]: http://www.xxlinux.com/linux/article/development/kernel/
[Link 2]: http://www.xxlinux.com/linux/article/development/