Linux设备模型分析之(一):设备模型核心
Linux设备模型分析之(二):设备模型的基石
Linux设备模型分析之(三):sysfs
Linux设备模型分析之(四):class
Linux设备模型分析之(五):uevent
sysfs是一个基于RAM的文件系统,它和kobject一起,可以将kernel的数据结构导出到用户空间,以文件目录结构的形式,提供对这些数据结构(以及数据结构的属性)的访问支持。
sysfs目录
前面提到过,一个kobject,对应sysfs中的一个目录。因此在注册kobject添加到kernel时,会调用sysfs文件系统的创建目录接口,创建与kobject对应的目录:
创建sysfs目录,实际上就是创建kobject对应的sysfs目录项,并与父kobject的sysfs目录项建立关系。
在系统中,有个根kernfs_node,为sysfs_root_kn,对应于"/sys"这个kobject的kernfs_node。在初始化sysfs文件系统创建的:
int __init sysfs_init(void)
{
int err;
sysfs_root = kernfs_create_root(NULL, KERNFS_ROOT_EXTRA_OPEN_PERM_CHECK,
NULL);
......
sysfs_root_kn = sysfs_root->kn; //根kernfs_node
//注册sysfs文件系统
err = register_filesystem(&sysfs_fs_type);
......
return 0;
}
sysfs_create_dir_ns函数定义如下:
int sysfs_create_dir_ns(struct kobject *kobj, cnst void *ns)
{
struct kernfs_node *parent, *kn;
BUG_ON(!kobj);
//如果不存在父kobject,则父kernfs_node设置为根kernfs_node
if (kobj->parent)
parent = kobj->parent->sd;
else
parent = sysfs_root_kn;
if (!parent)
return -ENOENT;
kn = kernfs_create_dir_ns(parent, kobject_name(kobj),
S_IRWXU | S_IRUGO | S_IXUGO, kobj, ns);
......
kobj->sd = kn;
return 0;
}
struct kernfs_node *kernfs_create_dir_ns(struct kernfs_node *parent,
const char *name, umode_t mode,
void *priv, const void *ns)
{
struct kernfs_node *kn;
int rc;
/* 创建kernfs_node,传入KERNFS_DIR标志,表示目录 */
kn = kernfs_new_node(parent, name, mode | S_IFDIR, KERNFS_DIR);
......
kn->priv = priv;
/* 与父kernfs_node建立关联 */
rc = kernfs_add_one(kn);
......
}
sysfs文件
attribute,即属性,对应sysfs中的一个文件。所谓的attibute,就是内核空间和用户空间进行信息交互的一种方法。例如某个driver定义了一个变量,却希望用户空间程序可以修改该变量,以控制driver的运行行为,那么就可以将该变量以attribute的形式开放出来。
属性分为普通属性和二进制属性。普通属性用结构体struct attribute来描述,前面介绍过。
二进制属性用结构体struct bin_attribute来描述,结构体定义如下。
struct bin_attribute {
struct attribute attr;//包含的普通属性
......
//read、write操作二进制属性的函数
ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
char *, loff_t, size_t);
ssize_t (*write)(struct file *, struct kobject *, struct bin_attribute *,
char *, loff_t, size_t);
int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
struct vm_area_struct *vma);
};
使用struct attribute生成的sysfs文件,只能用字符串的形式读写。而struct bin_attribute在struct attribute的基础上,增加了read、write等函数,因此它所生成的sysfs文件可以用任何方式读写。
属性组attribute_group,内核使用这一结构体方便的描述一组属性。
struct attribute_group {
const char *name; //属性组的名字,不为空的话对应一个sysfs的文件夹
//返回组中普通属性的读写权限
umode_t (*is_visible)(struct kobject *,
struct attribute *, int);
//返回组中二进制属性的读写权限
umode_t (*is_bin_visible)(struct kobject *,
struct bin_attribute *, int);
struct attribute **attrs; //属性组里的普通属性列表
struct bin_attribute **bin_attrs; //属性组里的二进制属性列表
};
创建sysfs文件可以调用sysfs_create_file或sysfs_create_bin_file函数,这里以sysfs_create_file函数为例,而创建sysfs文件,实际上就是创建attribute对应的kernfs_node,并与传入的kobject的kernfs_node建立关系。
传入的kobject代表一个目录,即是在给定的目录下创建文件。
对于attribute的kernfs_node,会使用attr成员,而kobject的kernfs_node,则使用dir成员:
struct kernfs_node {
......
union {
struct kernfs_elem_dir dir; //目录
struct kernfs_elem_symlink symlink; //链接
struct kernfs_elem_attr attr; //文件
};
......
};
struct kernfs_elem_attr {
const struct kernfs_ops *ops; /* r/w属性文件会调用到ops里面的回调函数 */
struct kernfs_open_node *open;
loff_t size;
struct kernfs_node *notify_next; /* for kernfs_notify() */
};
sysfs_create_file函数定义如下:
static inline int __must_check sysfs_create_file(struct kobject *kobj,
const struct attribute *attr)
{
return sysfs_create_file_ns(kobj, attr, NULL);
}
int sysfs_create_file_ns(struct kobject *kobj, const struct attribute *attr,
const void *ns)
{
......
return sysfs_add_file_mode_ns(kobj->sd, attr, false, attr->mode, ns);
}
int sysfs_add_file_mode_ns(struct kernfs_node *parent,
const struct attribute *attr, bool is_bin,
umode_t mode, const void *ns)
{
struct lock_class_key *key = NULL;
const struct kernfs_ops *ops;
struct kernfs_node *kn;
loff_t size;
if (!is_bin) {
//对应不是创建bin_attribute的sysfs文件,则走这个分支
struct kobject *kobj = parent->priv;
const struct sysfs_ops *sysfs_ops = kobj->ktype->sysfs_ops;
......
/* 设置attribute的kernfs_ops,至于设置成什么,由kobject->kobj_type->sysfs_ops决定
*/
if (sysfs_ops->show && sysfs_ops->store) {
if (mode & SYSFS_PREALLOC)
ops = &sysfs_prealloc_kfops_rw;
else
ops = &sysfs_file_kfops_rw;
} else if (sysfs_ops->show) {
if (mode & SYSFS_PREALLOC)
ops = &sysfs_prealloc_kfops_ro;
else
ops = &sysfs_file_kfops_ro;
} else if (sysfs_ops->store) {
if (mode & SYSFS_PREALLOC)
ops = &sysfs_prealloc_kfops_wo;
else
ops = &sysfs_file_kfops_wo;
} else
ops = &sysfs_file_kfops_empty;
size = PAGE_SIZE;
} else {
......
}
......
//创建并设置attribute的kernfs_node并与kobject的kernfs_node建立关联
kn = __kernfs_create_file(parent, attr->name, mode & 0777, size, ops,
(void *)attr, ns, key);
......
return 0;
}
讲了那么多还不如来个示例,内核版本4.9.88。
#include <linux/module.h>
#include <linux/fs.h>
#include <linux/pagemap.h>
#include <linux/mount.h>
#include <linux/init.h>
#include <linux/namei.h>
int val;
/* cat /sys/mykobj/myfile 会调用该函数 */
ssize_t my_attr_show(struct kobject *kobj, struct kobj_attribute *attr, char *buf)
{
return sprintf(buf, "%d\n", val);
}
/* echo 6 > /sys/mykobj/myfile 会调用该函数 */
ssize_t my_attr_store(struct kobject *kobj, struct kobj_attribute *attr, const char *buf, size_t count)
{
sscanf(buf, "%d\n", &val);
return count;
}
//定义属性,myfile为属性的name,0664为文件权限
struct kobj_attribute val_attr = __ATTR(myfile, 0664, my_attr_show, my_attr_store);
const struct attribute *test_kobj_attrs[] = {
&val_attr.attr,
NULL,
};
struct kobject *my_obj;
static int kobj_init(void)
{
int retval;
//创建并增添kobject,默认绑定的kobj_type为dynamic_kobj_ktype,会在/sys目录下创建mykobj目录
my_obj = kobject_create_and_add("mykobj", NULL);
retval = sysfs_create_files(my_obj, test_kobj_attrs); // 会在/sys/mykobj目录下创建文件
if(retval < 0)
{
kobject_put(my_obj);
return retval;
}
return 0;
}
static void kobj_exit(void)
{
kobject_del(my_obj);
}
module_init(kobj_init);
module_exit(kobj_exit);
MODULE_LICENSE("GPL");
Makefile:
KERNELBUILD :=/lib/modules/$(shell uname -r)/build
default:
make -C $(KERNELBUILD) M=$(shell pwd) modules
clean:
rm -rf *.o *.ko *.mod.c .*.cmd *.markers *.order *.symvers .tmp_versions *.mod
obj-m += kobj.o
装载驱动成功后:
测试: