Linux模型01 - Kobject驱动模型（图文结合 + 详细的demo）

最新推荐文章于 2023-08-19 23:44:14 发布

原创最新推荐文章于 2023-08-19 23:44:14 发布 · 728 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#Linux #driver #kobject #ktype #kset

GNU/Linux 专栏收录该内容

12 篇文章

订阅专栏

本文详细解析了Linux内核中kobject的作用与实现机制，包括其与ktype、kset的关系，以及如何在sysfs中创建和管理设备模型。通过具体示例展示了kobject的创建、属性设置和释放过程。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、概述

最初，kobject在内核中，只负责管理对象的引用计数；然而后来历史变迁，kobject的责任逐渐加重。

如今，它还是一种关系纽带，负责将设备模型及对应的sysfs接口关联在一起。

而且，kobject们对自己并不感兴趣；它们通常嵌入到其他结构中 — 代码真正感兴趣的数据资源中（C语言虽然不能直接使用继承，但“结构体嵌入技术”很优秀），监视这些内容。

kobject在内核中实现管理功能有对应的kobject驱动模型，理解它首先需要了解几个相关的数据结构（kobject，ktype和kset）。

二、主要结构和关系

kobject

kobject是struct kobject类型的对象。

实际上，创建kobject的代码不知道何时释放kobject（引入sysfs后，即使是可预测的对象生命周期也将会很复杂；比如：用户空间程序可以在任意一段时间内保持对kobject的引用【通过保持打开其关联的任何sysfs文件】）；如果事先知道何时释放kobject的话，那么最初使用kobject的意义何在？

还有一点很重要，每一个kobject必须对应一个释放它的函数，该函数必须始终保持在恒定的状态等待被调用（如果不是这样的话，代码就会有缺陷）。

kobject的释放函数没有存贮在kobject本身中，而是关联在ktype中（不得不说这个设计也很优秀）。

struct kobject相关代码示例

struct kref {
	atomic_t refcount;
};

struct kobject {
	const char		*name; //名字
	struct list_head	entry; //用于kset容器关联同类kobject
	struct kobject		*parent; //父指针，用于构建kobject们的层级关系
	struct kset		*kset; //指向同类kobject所属的kset容器
	struct kobj_type	*ktype; //表征特定属性
	struct sysfs_dirent	*sd; //用于sysfs虚拟文件系统中的惯用方式
	struct kref		kref; //引用计数
	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;
};

ktype

ktype是与kobject关联的类型。ktype表征kobject在sysfs中的默认属性；在kobject创建和销毁时，由ktype决策如何处理kobject。

而创建kobject的代码并不能直接控制引用计数，所以当kobject的引用消失时，应该异步通知一下，以完成对kobject的释放。该通知，由关联在ktype中的release()接口来完成，其形式一般如下：

void my_object_release(struct kobject *kobj)
{
    /* 
    * 0. 通过container_of()，找到指针kobj指向的，结构体类型为struct my_object的，成员名称为kobj的，所对应的结构体的首地址mine
    */
    struct my_object *mine = container_of(kobj, struct my_object, kobj);

    /* 
    * 1. 执行对该对象的所有清除、释放操作
    */
    //略
    
    /*
    * 2. 接着，释放该对象占有的内存空间
    */
    kfree (mine);
}

struct kobj_type相关代码示例

struct kobj_type {
    void (*release)(struct kobject *); //该类kobject的释放接口函数指针
    struct sysfs_ops	*sysfs_ops;
    struct attribute	**default_attrs;
};

kset

kset是kobject集合的基本容器，用来关联容纳一组嵌入在相同结构类型中的kobject；

虽然kset看起来和ktype有几分相似，但二者有一些功能上的差别的：

ktype关注对应对象的类型
kset 侧重对应对象的聚集

两种不同的理念使同类型的对象可以出现在不同的组中。

kset有以下三种功能：

收容一组同类对象。如：可被内核用来追踪“所有的块设备”或者“所有的PCI设备驱动”
目录级别纽带，把设备模型（和sysfs）关联在一起。每个kset包含一个kobject，可以把它设置为其他kobject的父对象，以这样的方式来建立设备模型的层次结构。
kset支持kobject的“热插拔”，并且对如何向用户上报热插拔有影响。

struct kset相关结构代码示例

struct kset {
	struct list_head list; //属于这个kset的kobject们的链表
	spinlock_t list_lock;
	struct kobject kobj; //嵌入到该kset的kobject（递归，是不是有点意思？)
	const struct kset_uevent_ops *uevent_ops; //处理kobject的请求
};

kset和kobject经典关系图

kset-sm

注意：

在实际中，所有图中的kobject都嵌入在其他的数据类中（甚至可能是其他的kset中）。
Linux内核的特殊性，kobject的父对象不一定是包含这个kobject的kset（虽然当前的图片上是的）。

三、使用

0. kobject中对应的ktype和kset的设置

设置ktype

指向ktype的指针可以在kobject初始化时放在kobject的ktype字段中；
当kobject包含的ktype指针为NULL时，则由kobject的包含kset的字段定义。

设置kset（接口类似kobject）

/**
 * 功能：动态创建一个kset，并添加到sysfs中
 * 参数：
    @name: kset的名称
    @uevent_ops: 属于kset的一个struct kset_uevent_ops
    @parent_kobj: kset的父对象指针（如果存在的话）
 * 返回值：
    创建kset失败，返回NULL
 * 注意：
    1. 使用kset_unregister() 将会在不使用kset后动态释放kset。
 */
struct kset *kset_create_and_add(const char *name,
				 const struct kset_uevent_ops *uevent_ops,
				 struct kobject *parent_kobj);

1. 动态创建kobject并添加到sysfs中

/*
* 功能：动态创建一个struct kobject， 并注册添加到sysfs中；
* 注意：调用kobject_put()后，该kobject将会在不再使用后自动释放。
* 参数：
* @name: kobject的名子
* @parent: kobject的父对象指针(如果存在的话)
*
*/
struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)

2. 在虚拟文件系统中创建文件

/*
* 功能：在sysfs中创建和kobject相关的文件
*/
int sysfs_create_group(struct kobject *kobj, const struct attribute_group *grp)

拓展补充：

kobject静态初始化和添加（无需sysfs_create_group接口）

/**
 * 功能：初始化一个kobject并添加它到一个kobject层次关系中
 * 参数：
 * @kobj: 指向已经存在的kobject的指针
 * @ktype: 指向属于该kobject的ktype的ktype指针
 * @parent: 该kobject的父对象指针
 * @fmt: kobject的格式化输入名称(类似sprintf(fmt, args...))
 *
 * 注意：
    1. 该函数等价于调用 kobject_init() 和 kobject_add(). 
    2. kobject_add()创建sysfs的入口（显示在/sys目录体系下）
    3. 从sysfs中移除对应的kobject， 使用 kobject_del()
 */
int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
			 struct kobject *parent, const char *fmt, ...);

kobject的名称或者和重新设置

//访问kobject名称的正确方法：
const char *kobject_name(const struct kobject * kobj);

//如果你需要修改kobject的名称：
int kobject_rename(struct kobject *kobj, const char *new_name);

kobject的引用计数接口（kset的引用计数接口类似）

kobject的主要职责之一就是对嵌入对象的引用计数，以下是基础的引用计数操作接口：

/* 功能： 增加引用计数。
* 成功：返回 kobject 指针；
* 失败：返回 NULL
*/
struct kobject *kobject_get(struct kobject *kobj);

/* 功能： 减少引用计数。
* 1. 当引用需要被释放的时候，就需要调用 kobject_put() 接口。
* 2. 注意：
*    kobject_init()接口增加引用计数为1；
*    所以最后需要调用 kobject_put() 来使得引用计数变为0, kobject才能得以释放
*/
void kobject_put(struct kobject *kobj);

四、使用示例

见内核代码树（或者参考附录）：

samples/kobject/kobject-example.c
samples/kobject/kset-example.c

kobject-example.c 的简单版，译如下：

该例中无ktype的用法，ktype的用法可参考kset-example.c

/*
 * 简单实现kobject驱动模型
 *
 * Copyright (C) 2004-2007 Greg Kroah-Hartman <greg@kroah.com>
 * Copyright (C) 2007 Novell Inc.
 *
 * 当且仅当发布在GPL2下
 *
 */
#include <linux/kobject.h>
#include <linux/string.h>
#include <linux/sysfs.h>
#include <linux/module.h>
#include <linux/init.h>

/*
 * 该驱动模块展示：
    1. 如何在sysfs中创建一个简单的子目录。
    2. 在/sys/kernel/kobject-example目录中将会创建一个文件：
    "foo". 
    3. 如果向文件写入一些整数，可在写入片刻后可读出。
 */

static int foo;

//文件的"读"接口实现
static ssize_t foo_show(struct kobject *kobj, struct kobj_attribute *attr,
			char *buf)
{
	return sprintf(buf, "%d\n", foo);
}

//文件的"写"接口实现
static ssize_t foo_store(struct kobject *kobj, struct kobj_attribute *attr,
			 const char *buf, size_t count)
{
	sscanf(buf, "%du", &foo);
	return count;
}

//文件的属性：读写权限、读写接口的指定
static struct kobj_attribute foo_attribute =
	__ATTR(foo, 0666, foo_show, foo_store);


/*
 * 创建一组属性，以便一次性操作一组属性
 */
static struct attribute *attrs[] = {
	&foo_attribute.attr,
	NULL,	/* NULL作为结束标志，不可或缺 */
};

/*
 * attribute_group没有指定名称的话，所有的属性会全部直接放在kobject目录中；
 * 指定了名字，就会生成对应的属性子目录，用来容纳相关的属性文件。
 */
static struct attribute_group attr_group = {
	.attrs = attrs,
};

static struct kobject *example_kobj;

static int __init example_init(void)
{
	int retval;

	/*
	 * 在/sys/kernel/目录下创建一个简单的kobject对象（目录），名称为"kobject_example",
	 *
	 * 因为这是个简单的目录，所以没有uevent发送到用户空间。
	 * 这正是这个函数的局限性（该接口不能用于创建不需要名称和编号的动态kobject）
	 */
	example_kobj = kobject_create_and_add("kobject_example", kernel_kobj);
	if (!example_kobj)
		return -ENOMEM;

	/* 创建关联kobject的文件*/
	retval = sysfs_create_group(example_kobj, &attr_group);
	if (retval)
		kobject_put(example_kobj);

	return retval;
}

static void __exit example_exit(void)
{
	kobject_put(example_kobj);
}

module_init(example_init);
module_exit(example_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("Greg Kroah-Hartman <greg@kroah.com>");