Linux 内核学习(8)---- Linux sysfs 文件
sysfs 简介
sysfs 是一个基于 RAM 的文件系统,从Linux 2.6 内核开始引入,用于导出内核对象(kernel object)的数据,属性到用户空间,以文件目录的形式为用户空间提供对这些数据,属性访问的支持
从驱动开发的角度看,sysfs 为用户提供了除了 devfs 和 procfs 之外的另外一种访问内核数据的方式,使用sysfs,编译内核的时候要定义 CONFIG_SYSFS,并且通过 mount -t sysfs sysfs /sys 的方式将其挂载到 /sys 目录
sysfs 是一个特殊的文件系统,并没有一个实际存放文件的介质,sysfs 的来源是 kobject 的层级结构,读取一个 sysfs 的文件,就是动态从 kobject 中提取信息,生成文件
sysfs 为我们提供了一个 kobject 为对象层次结构的视图,帮助用户能以一个简单的文件系统的方式来观察系统中各种设备的拓扑结构,借助属性,kobject 可以用导出文件的方式,将内核变量提供给用户修改或者读取
sysfs 中的关键结构
kobject
内核中使用 struct kobject 表示,通过这个数据结构使得所有设备在底层有统一的接口,kobject 提供基本的对象管理,是构成 Linux 设备模型的核心结构,每个在内核中注册的 kobject 对象都对应于sysfs 文件系统中的一个目录
kobject 类型于C++ 中的基类,它一般用于嵌入更大的对象中,用于描述设备模型的组件,比如 bus,device,driver 等,这些容器通过 kobject 连接起来了,形成了一个树状的结构,这个树状结构和 /sys 对应
struct kobject {
const char *name; //指向此object 的名称
struct list_head entry; // 挂接到 kset 中的单元
struct kobject *parent; //指向父对象的指针
struct kset *kset; //所属 kset 的指针
struct kobj_type *ktype; // 指向其对象描述符的指针
struct kernfs_node *sd; /* sysfs directory entry */
struct kref kref; //对象的引用计数
#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
struct delayed_work release;
#endif
unsigned int state_initialized:1;
unsigned int state_in_sysfs:1;
unsigned int state_add_uevent_sent:1;
unsigned int state_remove_uevent_sent:1;
unsigned int uevent_suppress:1;
};
- kref表示该对象的引用计数,内核通过 kref 实现引用计数的管理,内核提供 kobject_get() 和 kobject_put() 分别用于增加和减少引用计数,当引用计数为0时,所有该对象指向的资源释放
- struct kobj_type *ktype 表示该对象的类型
- sd 指针是指向 kernfs_node 的结构体指针,这个结构体就是表示 kobject 的一个 inode 结构体
- parent 指向kobject 的父对象,这样一来,kobject 就会在内核中构建一个对象的层级结构,并且可以将多个对象之间的关系表现出来,这就是 sysfs 的真正目的:一个用户空间的文件系统,用来表示内核中 kobject 的层级结构
kobject 通常是嵌入其他的结构中的,这个结构便有了 kobject 的标准功能,更重要的一点是,嵌入的 kobject 结构可以成为对象层次架构中的一部分,比如 cdev 结构体就可以通过指向其父指针的 cdev->kobj.parent 和链表 cdev->kobj.entry 插入到对象层次结构中
kobject type
struct kobj_type {
void (*release)(struct kobject *kobj);
const struct sysfs_ops *sysfs_ops;
struct attribute **default_attrs; /* use default_groups instead */
const struct attribute_group **default_groups;
const struct kobj_ns_type_operations *(*child_ns_type)(struct kobject *kobj);
const void *(*namespace)(struct kobject *kobj);
void (*get_ownership)(struct kobject *kobj, kuid_t *uid, kgid_t *gid);
};
ktype 的存在是为了描述一族 kobject 具有的普遍特性,这样一来,不再需要为每个 kobject 都分别定义自己的特性,而是将这些普遍特性在 ktype 结构中一次定义,然后同类的 kobject 都能共享一样的特性
-
release 函数指针是 kobject 引用计数减到0时要调用的析构函数,该函数用于释放所有 kobject 使用的内存和其他的清理工作
-
sysfs_ops指针指向sysfs操作函数表,struct attribute **default_attrs 文件属性缺省属性列表
struct sysfs_ops {
ssize_t (*show)(struct kobject *, struct attribute *, char *);
ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
};
当用户态读取属性时,show 函数被调用,该函数编码指定属性值存入buffer中返回给用户态
store 函数用于存储用户态传入的属性值
struct attribute **default_attrs 指向了一个 struct attribute 的数组,该结构体数组定义了 kobject 相关的默认属性
属性描述了给定对象的特征,如果该 kobject 导出到 sysfs 中,这些属性会作为文件导出,数组的最后一项必须为NULL
struct attribute {
const char *name;
umode_t mode;
#ifdef CONFIG_DEBUG_LOCK_ALLOC
bool ignore_lockdep:1;
struct lock_class_key *key;
struct lock_class_key skey;
#endif
};
上面 的 attribute 属性,它以文件形式输出到 sysfs 的目录中,在kobject 对应的目录中,文件名就是 name,文件的读写方法对应于sysfs_ops
kset
kset 的作用是建立上层(sub-system)和下层 kobject 的关联,kobject也会利用它了分辨自已是属于的类型,然后在/sys 下建立正确的目录位置,但是 kset 的优先级比 kobject 更高,kobject 通过 kset 组织成层次化的结构
kset 是具有相同类型的 kobject 的集合,在内核中用 kset 数据结构表示,定位为:
struct kset {
struct list_head list; //用于连接该kset中所有kobject的链表头
spinlock_t list_lock; //保护链表中元素的自旋锁
struct kobject kobj; //嵌入的kobject
const struct kset_uevent_ops *uevent_ops; //指向热插拔操作表的指针
} __randomize_layout;
包含在 kset 中的所有kobject被组织成一个双向循环链表,list域正是该链表的头,
kset 还包含一个 kobject 对象,所有属于这个 kset 的 kobject对象的 parent 域都指向这个内嵌的对象,此外 kset 还依赖于 kobj 维护引用计数
kset 是 kobject 对象的集合体,可以把它看成是一种容器,可以将所有相关的 kobject 对象,比如所有的块设备 置于同一个位置,kset 和 kobject 的重要区别在于,具有相同 ktype 的 kobject 可以被分组到不同的 kset,也就是说在linux 内核中,只有少数的 kobject,但是有多个 kset
kset 中的 uevent_ops 指向一个结构体,用于处理集合中 kobject 的热插拔操作,uevent 就是 user event 的含义,提供了与用户空间热插拔信息进行通信的机制
kobject,ktype,kset之间关系
kobj_kset_subsystem.jpg总结一下:
kobject 为我们提供了引用计数,父子关系,对象名称等基本对象道具,并且是以一种统一的方式提供这些功能,单独使用 kobj 本身意义并不大,通常情况下需要嵌入到其他的数据结构中,让那些包含它的结构具有kobj 的特性
sysfs
sysfs 的诀窍是将 kobject 对象和目录项结合起来,这点是通过 kobject 中的 struct kernfs_node *sd 实现的,用户空间想要访问内核空间,中间要经过一层 VFS 的接口,kobject 通过关键 VFS 中的 struct kernfs_node 对象,方便的将kobject 映射到对应的目录上,从此把kobject 导出称为文件系统变得如同在内存中构建目录项一样简单,kobject 实际上形成一个树的结构
- kobject 对应于用户空间的访问 sysfs 的一个目录
- 对象的属性对应于用户空间的访问 sysfs 的一个文件,文件名就是 name 属性
sysfs 重要目录说明如下:
sysfs_dir.jpg
其中最重要的就是 /sys/devices,该目录将设备模型导出到用户空间,目录结构就是系统中实际设备的拓扑,其他目录的很多文件实际就是指向 /sys/devices 中的符号链接
"sys/class/","sys/bus/","sys/devices"是设备开发中最重要的几个目录。他们之间的关系可以用下图表示
sys_devices.jpg
DRM 驱动框架下的 sysfs
根据 display 设备在 DeviceTree 里面的配置,display 设备会抽象为一个 platform device,因此 device 的主要目录位于:
sysfs 目录:/sys/devices/platform/0.soc/30600000.display
drm_sysfs_root.jpg
在drm 目录中,包含了drm_sysfs 中导出的相关 attribute:
image.png
其中 card0-DSI-1 和 card0-Writeback-1 关联到 drm 框架中创建的两个 connector
-
card0-DSI-1 和 card0-Writeback-1 下的每一级子目录都会显示对应的 device 和 subsystem 的软链接
drm 驱动的配置的模板参数宏,也会在 /sys/module 下展示出来
image.png