对内核模块添加sysfs属性

1. 添加 sysfs 支持

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

1.注册虚拟的字符设备文件，以这个虚拟设备上的 read/write/ioctl 等接口与用户交互；但 read/write 一般只能做一件事情， ioctl 可以根据 cmd 参数做多个功能，但其缺点是很明显的： ioctl 接口无法直接在 Shell 脚本中使用，为了使用 ioctl 的功能，还必须编写配套的 C语言的虚拟设备操作程序， ioctl 的二进制数据接口也是造成大小端问题 (big endian与little endian)、32位/64位不可移植问题的根源；

2.注册 proc 接口，接受用户的 read/write/ioctl 操作；同样的，一个 proc 项通常使用其 read/write/ioctl 接口，它所存在的问题与上面的虚拟字符设备的的问题相似；

3.注册 sysfs 属性；

最重要的是，添加虚拟字符设备支持和注册 proc 接口支持这两者所需要增加的代码量都并不少，最好的方法还是使用 sysfs 属性支持，一切在用户层是可见的透明，且增加的代码量是最少的，可维护性也最好；方法就是使用 <include/linux/device.h> 头文件提供的这四个宏，分别应用于总线/类别/驱动/设备四种内核数据结构对象上：

#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)

 

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

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

 

2. 案例文件

2.1. 功能分析

1.demo.ko按一定的时间间隔不断的产生各种级别的日志

 

2.我们新增了attr.h和attr.c源文件，并且基本不修改demo.c和demo.h的情况下让demo.ko支持sysfs

所作修改是：在demo的初始化函数中调用demo_attr_install，在demo的退出函数中调用demo_attr_uninstall

 

3.从函数demo_attr_show到各个属性自定义的show函数其实就是面向对象中的多态

 

4.添加sysfs支持后的好处就是可以在用户态下直接跟demo.ko交互，比如

修改打印日志的级别，

echo 101 > /sys/demo/loglevel

修改打印时间间隔，

echo 3000 > /sys/demo/interval

 

5.attr.c / attr.h中的框架可重用

添加一个新的属性，只需要

使用DEMO_ATTR宏定义一个属性

如果该属性支持读，则添加实现ssize_t (*show)(char *buf);

如果该属性支持写，则添加实现ssize_t (*store)(const char *buf, size_t count);

 

其余的代码都不需要改动，都是公共代码。

2.2. attr.h文件

 #ifndef __DEMO_ATTR_H__ #define __DEMO_ATTR_H__ int32_t demo_attr_install (void ); void demo_attr_uninstall ( void ); #endif /*__DEMO_ATTR_H__*/

2.3. demo.h文件

 #ifndef __DEMO_H__ #define __DEMO_H__ #define DEMO_START 0 #define DEMO_STOP 1 #define LOG_LEVEL_WARN 101 #define LOG_LEVEL_INFO 100 typedef struct demo_mod_info { uint32_t status; uint32_t log_level; uint32_t interval; pid_t runner; }demo_mod_info_t; extern demo_mod_info_t demo; #endif /* __DEMO_H__ */

2.4. demo.c文件

 #include <linux/config.h> #include <linux/kernel.h> #include <linux/module.h> #include <linux/init.h> #include <linux/kthread.h> #include <linux/delay.h> #include <linux/kobject.h> #include <linux/sysfs.h> #include "demo.h" #include "attr.h" MODULE_LICENSE("GPL"); demo_mod_info_t demo; uint32_t counter; void log(int level, const char *fmt, ...) { if (level >= demo.log_level) { va_list args; va_start(args, fmt); printk(fmt, args); va_end(args); } } int start_runner(void *dummy) { current->flags |= PF_NOFREEZE; daemonize("runner"); allow_signal(SIGKILL); for (;;) { if (signal_pending(current)) { break; } log(LOG_LEVEL_INFO, "i'm running .../n"); if (0 == counter%5) { log(LOG_LEVEL_WARN, "recv a warn./n"); } msleep(demo.interval); counter++; } demo.status = DEMO_STOP; return 0; } void stop_runner(void) { kill_proc(demo.runner , SIGKILL, 1); } int __init demo_init(void) { counter = 0; demo.status = DEMO_START; demo.log_level = LOG_LEVEL_WARN; demo.interval = 4 * HZ; demo.runner = kernel_thread(start_runner, NULL, CLONE_FS | CLONE_FILES | CLONE_SIGHAND); if (demo.runner < 0) { demo.status = DEMO_STOP; return -1; } demo_attr_install(); return 0; } void __exit demo_exit(void) { stop_runner(); while (DEMO_STOP != demo.status) { msleep(5); } demo_attr_uninstall(); } module_init(demo_init); module_exit(demo_exit);

2.5. attr.c文件

 #include <linux/config.h> #include <linux/module.h> #include <linux/kobject.h> #include <linux/sysfs.h> #include <linux/delay.h> #include "demo.h" #define SYSFS_NAME "demo" typedef struct demo_info { struct kobject kobj; int32_t attr_count; }demo_info_t; typedef struct demo_attribute { struct attribute attr; ssize_t (*show)(char *buf); ssize_t (*store)(const char *buf, size_t count); }demo_attribute_t; #define DEMO_ATTR(_name, _mode, _show, _store) / demo_attribute_t demo_attr_##_name = { / .attr = {.name = __stringify(_name) , .mode = _mode },/ .show = _show, / .store = _store, / }; /* public func declare */ int32_t demo_attr_install(void); void demo_attr_uninstall(void); /* common func declare */ void demo_attr_release(struct kobject *ko); ssize_t demo_attr_show(struct kobject *ko, struct attribute *attr, char *buf); ssize_t demo_attr_store(struct kobject * kobj, struct attribute * attr, const char * buf, size_t count); /* private func declare of specified attr */ ssize_t show_attr_interval(char *buf); ssize_t show_attr_loglevel(char *buf); ssize_t store_attr_interval(const char *buf, size_t count); ssize_t store_attr_loglevel(const char *buf, size_t count); /* grobal vars */ demo_info_t *demo_info; struct sysfs_ops demo_sysfs_ops = { .show = demo_attr_show, .store = demo_attr_store }; static DEMO_ATTR(loglevel, S_IRUGO |S_IWUGO, show_attr_loglevel, store_attr_loglevel); static DEMO_ATTR(interval, S_IRUGO |S_IWUGO, show_attr_interval, store_attr_interval); struct attribute * demo_default_attrs[] = { &demo_attr_loglevel.attr, &demo_attr_interval.attr, NULL }; struct kobj_type demo_ktype = { .release = demo_attr_release, .sysfs_ops = &demo_sysfs_ops, .default_attrs = demo_default_attrs }; /* common func impl */ ssize_t demo_attr_show(struct kobject *ko, struct attribute *attr, char *buf) { ssize_t len = 0; demo_attribute_t *a = container_of(attr, demo_attribute_t, attr); if (a->show) { len = a->show(buf); } return len; } ssize_t demo_attr_store(struct kobject * kobj, struct attribute * attr, const char * buf, size_t count) { ssize_t len = 0; demo_attribute_t *a = container_of(attr, demo_attribute_t, attr); if (a->store) { len = a->store(buf, count); } return len; } void demo_attr_release(struct kobject *ko) { demo_info_t *mi = container_of(ko, demo_info_t, kobj); kfree(mi); demo_info = NULL; } void demo_attr_uninstall(void) { int32_t i; /* remv all files in sysfs arch */ for (i=0; i<demo_info->attr_count; i++) { sysfs_remove_file(&demo_info->kobj, demo_default_attrs[i]); } /* deref the kobject */ kobject_del(&demo_info->kobj); kobject_put(&demo_info->kobj); while (demo_info) { schedule_timeout(HZ/2); } return; } int32_t demo_attr_install(void) { int32_t error; demo_info = kmalloc(sizeof(demo_info_t), GFP_KERNEL); if (!demo_info) { return -ENOMEM; } memset(demo_info, 0, sizeof(demo_info_t)); /* init the kobject */ kobject_init(&demo_info->kobj); demo_info->attr_count = 1; demo_info->kobj.ktype = &demo_ktype; /* generate dir & attr_file */ error = kobject_set_name(&demo_info->kobj, SYSFS_NAME); if (!error) { error = kobject_add(&demo_info->kobj); if (!error) { int32_t i; for (i=0; i<demo_info->attr_count; i++) { sysfs_create_file(&demo_info->kobj, demo_default_attrs[i] ); } } } if (error) { kfree(demo_info); } return error; } ssize_t show_attr_loglevel(char *buf) { sprintf(buf, "#INFO/t%d/n#WARN/t%d/n%d/n", LOG_LEVEL_INFO, LOG_LEVEL_WARN, demo.log_level); return strlen(buf); } ssize_t store_attr_loglevel(const char *buf, size_t count) { int32_t log_level = 0; sscanf(buf, "%d", &log_level); if (log_level > 0) { demo.log_level = log_level; } return strlen(buf); } ssize_t show_attr_interval(char *buf) { sprintf(buf, "%d/n", demo.interval); return strlen(buf); } ssize_t store_attr_interval(const char *buf, size_t count) { int32_t interval = 0; sscanf(buf, "%d", &interval); if (interval > 0) { demo.interval = interval; } return strlen(buf); }

3. 参考资料

/Documentation/kobject.txt

/Documentation/filesystems/sysfs.txt