代码改变世界

Linux设备模型 (3)

2010-12-21 19:51  wwang  阅读(13873)  评论(6编辑  收藏  举报

在上文中,我们介绍到如何使用default attribute。Default attribute使用很方便,但不够灵活。比如上篇文章在Kobject一节中提到的那个例子,name和val这两个attribute使用同一个show/store函数来访问,如果attribute非常多,show/store函数里的分支就会很凌乱。

为了解决这个问题,我们可以参考内核提供的kobj_attribute。在内核里,kobj_attibute是这样定义的:

struct kobj_attribute {
	struct attribute attr;
	ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
			char *buf);
	ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
			 const char *buf, size_t count);
};

每一个attribute会对应自己的show/store函数,这样就极大的提高了灵活性。可是,在上一篇文章中我们的认知是,sysfs是通过kobject里的kobj_type->sysfs_ops来读写attribute的,那如果要利用kobj_attribute中的show/store来读写attribute的话,就必须在kobj_type->sysfs_ops里指定。Linux内核提供了一个默认的kobj_type类型dynamic_kobj_ktype来实现上述的操作。

/* default kobject attribute operations */
static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
			      char *buf)
{
	struct kobj_attribute *kattr;
	ssize_t ret = -EIO;

	kattr = container_of(attr, struct kobj_attribute, attr);
	if (kattr->show)
		ret = kattr->show(kobj, kattr, buf);
	return ret;
}

static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
			       const char *buf, size_t count)
{
	struct kobj_attribute *kattr;
	ssize_t ret = -EIO;

	kattr = container_of(attr, struct kobj_attribute, attr);
	if (kattr->store)
		ret = kattr->store(kobj, kattr, buf, count);
	return ret;
}

const struct sysfs_ops kobj_sysfs_ops = {
	.show	= kobj_attr_show,
	.store	= kobj_attr_store,
};

static void dynamic_kobj_release(struct kobject *kobj)
{
	pr_debug("kobject: (%p): %s\n", kobj, __func__);
	kfree(kobj);
}

static struct kobj_type dynamic_kobj_ktype = {
	.release	= dynamic_kobj_release,
	.sysfs_ops	= &kobj_sysfs_ops,
};

kobj_attribute是内核提供给我们的一种更加灵活的处理attribute的方式,但是它还不够。只有当我们使用kobject_create来创建kobject时,使用kobj_attribute才比较方便,但大部分情况下,我们是把kobject内嵌到自己的结构里,此时就无法直接使用内核提供的dynamic_kobj_ktype,因此,我们需要创建自己的kobj_attribute。

 

本文接下来将围绕一个实作来看看如何创建自己的kobj_attribute,sample code可以从这里下载。这个sample code是基于上篇文章kobject中的例子修改而来的,看过那个例子的读者应该会比较轻松。

 

首先,我们需要定义自己的attribute:

struct my_attribute {
        struct attribute attr;
        ssize_t (*show)(struct my_kobj *obj, struct my_attribute *attr, 
                        char *buf);
        ssize_t (*store)(struct my_kobj *obj, struct my_attribute *attr, 
                        const char *buf, size_t count);
};

在my_attribute里,我们的show/store直接操作my_kobj,这样更加方便。

参考Linux内核,kobj_type里的sysfs_ops这样定义:

static ssize_t my_attr_show(struct kobject *kobj, struct attribute *attr,
			      char *buf)
{
	struct my_attribute *my_attr;
	ssize_t ret = -EIO;

	my_attr = container_of(attr, struct my_attribute, attr);
	if (my_attr->show)
		ret = my_attr->show(container_of(kobj, struct my_kobj, kobj), 
				my_attr, buf);
	return ret;
}

static ssize_t my_attr_store(struct kobject *kobj, struct attribute *attr,
			       const char *buf, size_t count)
{
	struct my_attribute *my_attr;
	ssize_t ret = -EIO;

	my_attr = container_of(attr, struct my_attribute, attr);
	if (my_attr->store)
		ret = my_attr->store(container_of(kobj, struct my_kobj, kobj), 
				my_attr, buf, count);
	return ret;
}

下面就可以分别对name和val两个attribute定义自己的show/store。name这个attribute是只读的,只要为它定义show即可。

ssize_t name_show(struct my_kobj *obj, struct my_attribute *attr, char *buffer)
{
	return sprintf(buffer, "%s\n", kobject_name(&obj->kobj));
}

ssize_t val_show(struct my_kobj *obj, struct my_attribute *attr, char *buffer)
{
	return sprintf(buffer, "%d\n", obj->val);
}

ssize_t val_store(struct my_kobj *obj, struct my_attribute *attr, 
		const char *buffer, size_t size)
{
	sscanf(buffer, "%d", &obj->val);

	return size;
}

接下来,利用内核提供的宏__ATTR来初始化my_attribute,并建立attribute数组。

struct my_attribute name_attribute = __ATTR(name, 0444, name_show, NULL);
struct my_attribute val_attribute = __ATTR(val, 0666, val_show, val_store);

struct attribute *my_attrs[] = {
	&name_attribute.attr, 
	&val_attribute.attr,
	NULL,
};

其中,宏__ATTR的定义如下:

#define __ATTR(_name,_mode,_show,_store) { \
	.attr = {.name = __stringify(_name), .mode = _mode },	\
	.show	= _show,					\
	.store	= _store,					\
}

在module_init里,我们调用sysfs_create_files来把attribute增加到sysfs中。

retval = sysfs_create_files(&obj->kobj, 
			(const struct attribute **)my_attrs);
if (retval) {
	// ...
}

在kobject对应的目录里,还可以创建子目录,Linux内核里是用attribute_group来实现。在本例中,我们可以这么做:

struct attribute_group my_group = {
	.name     = "mygroup",
	.attrs    = my_attrs,
};

然后在module_init里调用sysfs_create_group来添加。

retval = sysfs_create_group(&obj->kobj, &my_group);
if (retval) {
	// ...
}

本例创建的attribute_group中包含的attribute也是my_attrs,所以在子目录mygroup下的文件和mykobj目录下的文件完全一致。

最后我们得到的目录结构是这样的。

mykobj/
|-- mygroup
|   |-- name
|   `-- val
|-- name
`-- val

完成这个实作之后,你可以用命令echo 2 > /sys/mykobj/val来修改mykobj下的val文件,可以观察到/sys/mykobj/mygroup/val的内容也会变成2,反之亦然。