Linux设备模型分析之（二）：设备模型的基石

Linux设备模型分析之（一）：设备模型核心
Linux设备模型分析之（二）：设备模型的基石
Linux设备模型分析之（三）：sysfs
Linux设备模型分析之（四）：class
Linux设备模型分析之（五）：uevent

Linux设备模型通过sysfs文件系统将设备、驱动、总线组织成拓扑结构以目录结构进行展示与管理以及与用户空间通信，如下图：

这些功能的实现离不开设备模型的基石：kobject。kobject是组成设备模型的基本结构，device、bus、device_driver等数据结构体里面都直接或间接包含有kobject成员。

//设备
struct device {
	......
	struct kobject kobj;
	......
};

//驱动
struct device_driver {
	......
	struct driver_private *p;
};
struct driver_private {
	struct kobject kobj;
	......
};

//总线
struct bus_type {
	......
	struct subsys_private *p;
	......
};

//类
struct class {
	......
	struct subsys_private *p;
}

struct subsys_private {
	struct kset subsys;   //里面包含有kobject 
	......
};

通过kobject实现：

（1）对象生命周期的管理
kobject结构体内有一成员kref，为引用计数，用于跟踪对象的生命周期。

（2）热插拔事件
当系统中的硬件被热插拔时，在kobject子系统控制下，将产生事件以通知用户空间。

（3）sysfs表述
kobject结构体内有一成员sd，指向kobject在sysfs中的目录项，用于描述sysfs中的树状关系。

（4）与用户空间通信
通过sysfs、uevent机制，实现与用户空间的通信。

kobject定义如下：

struct kobject {
	const char		*name;         //该kobject的名称，同时也是对应sysfs中的目录名称
	struct list_head	entry;     //用于将kobject加入到kset中的节点
	struct kobject		*parent;   //指向parent kobject，以此形成层次结构
	struct kset		*kset;         //该kobject所属的kset
	struct kobj_type	*ktype;    //kobject的属性操作集合，每个kobject必须有一个ktype
	struct kernfs_node	*sd;       //指向该kobject在sysfs中的目录项
	struct kref		kref;          //为一个可用于原子操作的引用计数
	......
	unsigned int state_initialized:1;//指示该kobject是否已经初始化
	unsigned int state_in_sysfs:1;   //指示该kobject是否已在sysfs中呈现
	unsigned int state_add_uevent_sent:1;
	unsigned int state_remove_uevent_sent:1;
	unsigned int uevent_suppress:1; //如果该字段为1，则表示忽略所有上报的uevent事件
};

kobj_type代表kobject的属性操作集合，定义如下：

struct kobj_type {

	//通过该回调函数，释放该种类型kobject和其占用资源
	void (*release)(struct kobject *kobj); 

	//该种类型的kobject的sysfs文件系统接口
	const struct sysfs_ops *sysfs_ops;   

	//属性列表  
	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);
};

kobject在sysfs中以目录的形式出现，那么文件呢？答案是：attribute。 attribute在sysfs中以文件的的形式出现。

struct attribute {
	const char		*name;  	//属性的名字，对应sysfs中的一个文件的名称
	umode_t			mode;      //属性文件的权限
	.......
};

kset，也可以说是特殊的kobject，用来集合与管理多个同类型的kobject，定义如下：

struct kset {
	struct list_head list;  //该kset下的kobject都会挂入该链表
	spinlock_t list_lock;
	struct kobject kobj;    //该kset的kobject
	......
};

kset与kobject结构体的关系，如下：

kobject大多数情况下不会单独使用，而是嵌到其它数据结构中使用，如device、device_driver。注册device、device_driver等就会调用到一些函数用于初始化与注册内嵌的kobject。

这些函数有：

//初始化kobject
void kobject_init(struct kobject *kobj, struct kobj_type *ktype);

//将初始化完成的kobject添加到kernel中
int kobject_add(struct kobject *kobj, struct kobject *parent,
		const char *fmt, ...);

//是上面两个接口的组合
int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
			 struct kobject *parent, const char *fmt, ...);


//单独使用kobject，可以调用该函数创建一个kobject
struct kobject *kobject_create(void);

//创建并注册kobject
struct kobject *kobject_create_and_add(const char *name, struct kobject *parent);

初始化一个kobject：

//需要传入一个kobj_type 
void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
{

	......

	kobject_init_internal(kobj);
	kobj->ktype = ktype;  //设置kobject的ktype
	
	......
}

static void kobject_init_internal(struct kobject *kobj)
{
	if (!kobj)
		return;
	//初始化引用计数、链表等
	kref_init(&kobj->kref);
	INIT_LIST_HEAD(&kobj->entry);
	kobj->state_in_sysfs = 0;
	kobj->state_add_uevent_sent = 0;
	kobj->state_remove_uevent_sent = 0;
	kobj->state_initialized = 1; //表示已初始化
}

初始化之后，就可以调用kobject_add函数把kobject添加到kernel中：

//parent指向父kobject， kobject的name以可变参的形式传入
int kobject_add(struct kobject *kobj, struct kobject *parent,
		const char *fmt, ...)
{
	va_list args;
	int retval;

	......

	//如果kobject都未初始化，则返回错误
	if (!kobj->state_initialized) {
		......
		return -EINVAL;
	}
	va_start(args, fmt);

	//增添kobject
	retval = kobject_add_varg(kobj, parent, fmt, args);
	va_end(args);

	return retval;
}

static __printf(3, 0) int kobject_add_varg(struct kobject *kobj,
					   struct kobject *parent,
					   const char *fmt, va_list vargs)
{
	int retval;

	//设置kobject的name
	retval = kobject_set_name_vargs(kobj, fmt, vargs);
	......
	kobj->parent = parent;
	return kobject_add_internal(kobj);
}


static int kobject_add_internal(struct kobject *kobj)
{
	int error = 0;
	struct kobject *parent;

	......

	parent = kobject_get(kobj->parent);

	/* 如果kobject->parent未设置，则把该kobject所属kset（存在的话）的kobject当作父kobject */
	if (kobj->kset) {
		if (!parent)
			parent = kobject_get(&kobj->kset->kobj);
		kobj_kset_join(kobj); //把kobject加入到所属kset的链表里
		kobj->parent = parent;
	}

	......

	error = create_dir(kobj); //在sysfs下创建目录、文件
	......

	return error;
}

通过kobject_create_and_add函数，内核创建与初始化一个kobject，其kobj_type为dynamic_kobj_ktype：

struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
{
	struct kobject *kobj;
	int retval;

	kobj = kobject_create(); //创建与初始化kobject 
	if (!kobj)
		return NULL;

	retval = kobject_add(kobj, parent, "%s", name); //前面已分析
	......
}

struct kobject *kobject_create(void)
{
	struct kobject *kobj;

	kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
	if (!kobj)
		return NULL;

	kobject_init(kobj, &dynamic_kobj_ktype); //kobj_type初始化为dynamic_kobj_ktype
	return kobj;
}

同样的，对于kset的操作，也有类似的函数。

//初始化kset
void kset_init(struct kset *k);

//添加kset
int kset_register(struct kset *k);


//创建并添加kset
struct kset *kset_create_and_add(const char *name,
				 const struct kset_uevent_ops *uevent_ops,
				 struct kobject *parent_kobj);