kobject的理解

每一个kobject结构体对应着/sys目录下的一个目录。

在linux的驱动表示中，主要有三个基本的结构kobject、kset和ktype，它们都在linux/kobject.h文件中定义。kset可以看成是一个特殊的kobject，ktype表示某kobject目录下的属性文件。

struct kobject {
	const char		*name;
	struct list_head	entry;
	struct kobject		*parent;
	struct 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;
};

变量	含义
name	kobject对应的目录的名字，例如/sys/bus目录的kobject的name就是"bus"。
parent	指向kobject目录的上一级目录。
kset	是同类型kobject对象的集合，即一个容器。当parent为null时，kobject的上一级目录会是kset->kobject。
ktype	kobject目录下的属性文件。
state_initialized	防止重复初始化。

struct kobj_type {
	void (*release)(struct kobject *kobj);
	const struct sysfs_ops *sysfs_ops;
	struct attribute **default_attrs;
	const struct kobj_ns_type_operations *(*child_ns_type)(struct kobject *kobj);
	const void *(*namespace)(struct kobject *kobj);
};

struct attribute对应具体的属性文件，defaul_attrs指向这些文件，一个kobject目录下可能有多个属性文件。

struct kset {
	struct list_head list;
	spinlock_t list_lock;
	struct kobject kobj;
	const struct kset_uevent_ops *uevent_ops;
};

1 kobject的初始化、注册和删除

kobject常用的API有kobject_init()、kobject_add()、kobject_init_and_add()、keobject_del()和keobject_put()。使用这些函数时需要包含linux/kobject.h头文件。

1 kobject_init()

/* kobject_init的部分实现代码 */
void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
{
    if (kobj->state_initialized) {
		/* do not error out as sometimes we can recover */
		printk(KERN_ERR "kobject (%p): tried to init an initialized "
		       "object, something is seriously wrong.\n", kobj);
		dump_stack();
	}
    
    kobject_init_internal(kobj);
	kobj->ktype = 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;
}

static inline void kref_init(struct kref *kref)
{
	atomic_set(&kref->refcount, 1);
}

首先kobject_init()会先判断传入的kobj是否已经初始化过，如果没有则会调用kobject_init_internal()函数对kobj初始化，接着让kobj->ktype指向传入的ktype。kobject_init_internal()函数会把kobj->kref的值设置为1，然后初始化kobj->entry链表头，既让entry的next、prev指针都指向自身。

2 kobject_add()

/* kobject_add的部分实现代码 */
int kobject_add(struct kobject *kobj, struct kobject *parent,
		const char *fmt, ...)
{
	va_list args;
	int retval;
    
    /* 
	 * va_start()获取可变参数列表的首地址，
	 * va_end()清空可变参数列表。
	 */
	va_start(args, fmt);
	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;
    
    /* 设置kobj的名字，即kobj->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;
    
	/* 
	 * 获取kobj->parent的值 
	 * 如果kobj设置了parent，则把parent中的kref加1
	 * 否则返回NULL
	 */
	parent = kobject_get(kobj->parent);

	/* join kset if set, use it as parent if we do not already have one */
	if (kobj->kset) {
        /*
         * 如果kobj->parent == NULL，
         * 则使用kobj->kset->kobj作为kobj的parent 
         */
		if (!parent)
			parent = kobject_get(&kobj->kset->kobj);
        
        /* 把kobj->entry加入到kobj->kset->list中 */
		kobj_kset_join(kobj);
		kobj->parent = parent;
	}

    /* 
     * 创建目录 
     * 暂时看不懂
     */
	error = create_dir(kobj);
	if (error) {
		kobj_kset_leave(kobj);
        /* parent->kref 减一 */
		kobject_put(parent);
		kobj->parent = NULL;
	} else
		kobj->state_in_sysfs = 1;

	return error;
}

3 kobject_init_and_add()

就是把kobject_init()和kobject_add()放在一起了

int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
			 struct kobject *parent, const char *fmt, ...)
{
	va_list args;
	int retval;

	kobject_init(kobj, ktype);

	va_start(args, fmt);
	retval = kobject_add_varg(kobj, parent, fmt, args);
	va_end(args);

	return retval;
}

4 kobject_del()

void kobject_del(struct kobject *kobj)
{
	struct kernfs_node *sd;

	if (!kobj)
		return;

	sd = kobj->sd;
	sysfs_remove_dir(kobj);
	sysfs_put(sd);

	kobj->state_in_sysfs = 0;
	kobj_kset_leave(kobj);
	kobject_put(kobj->parent);
	kobj->parent = NULL;
}

5 kobject_put()

void kobject_put(struct kobject *kobj)
{
	if (kobj) {
		if (!kobj->state_initialized)
			WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
			       "initialized, yet kobject_put() is being "
			       "called.\n", kobject_name(kobj), kobj);
		kref_put(&kobj->kref, kobject_release);
	}
}