背 景

• Read the fucking source code! --By 魯迅
• A picture is worth a thousand words. --By 高爾基

說(shuō)明：

1. Kernel版本：4.14
2. ARM64處理器，Contex-A53，雙核
3. 使用工具：Source Insight 3.5， Visio

1. 概述

今天來(lái)聊一下Linux設(shè)備模型的基石：kset/kobject/ktype。

• sysfs文件系統(tǒng)提供了一種用戶與內(nèi)核數(shù)據(jù)結(jié)構(gòu)進(jìn)行交互的方式，可以通過(guò)mount -t sysfs sysfs /sys來(lái)進(jìn)行掛載；
• Linux設(shè)備模型中，設(shè)備、驅(qū)動(dòng)、總線組織成拓?fù)浣Y(jié)構(gòu)，通過(guò)sysfs文件系統(tǒng)以目錄結(jié)構(gòu)進(jìn)行展示與管理；
• Linux設(shè)備模型中，總線負(fù)責(zé)設(shè)備和驅(qū)動(dòng)的匹配，設(shè)備與驅(qū)動(dòng)都掛在某一個(gè)總線上，當(dāng)它們進(jìn)行注冊(cè)時(shí)由總線負(fù)責(zé)去完成匹配，進(jìn)而回調(diào)驅(qū)動(dòng)的probe函數(shù)；
• SoC系統(tǒng)中有spi, i2c, pci等實(shí)體總線用于外設(shè)的連接，而針對(duì)集成在SoC中的外設(shè)控制器，Linux內(nèi)核提供一種虛擬總線platform用于這些外設(shè)控制器的連接，此外platform總線也可用于沒(méi)有實(shí)體總線的外設(shè)；
• 在/sys目錄下，bus用于存放各類總線，其中總線中會(huì)存放掛載在該總線上的驅(qū)動(dòng)和設(shè)備，比如serial8250，devices存放了系統(tǒng)中的設(shè)備信息，class是針對(duì)不同的設(shè)備進(jìn)行分類；

上邊這些功能的實(shí)現(xiàn)，離不開(kāi)kobject/kset/ktype機(jī)制的支撐，開(kāi)始旅程吧。

2. 數(shù)據(jù)結(jié)構(gòu)

2.1 kobject

• kobject代表內(nèi)核對(duì)象，結(jié)構(gòu)體本身不單獨(dú)使用，而是嵌套在其他高層結(jié)構(gòu)中，用于組織成拓?fù)潢P(guān)系；
• sysfs文件系統(tǒng)中一個(gè)目錄對(duì)應(yīng)一個(gè)kobject；

看看結(jié)構(gòu)體吧：

struct kobject {
	const char		*name;                  /* 名字，對(duì)應(yīng)sysfs下的一個(gè)目錄 */
	struct list_head	entry;               /* kobject中插入的 list_head結(jié)構(gòu)，用于構(gòu)造雙向鏈表 */
	struct kobject		*parent;            /* 指向當(dāng)前kobject父對(duì)象的指針，體現(xiàn)在sys中就是包含當(dāng)前kobject對(duì)象的目錄對(duì)象 */
	struct kset		*kset;                    /* 當(dāng)前kobject對(duì)象所屬的集合 */
	struct kobj_type	*ktype;            /* 當(dāng)前kobject對(duì)象的類型 */
	struct kernfs_node	*sd;              /* VFS文件系統(tǒng)的目錄項(xiàng)，是設(shè)備和文件之間的橋梁，sysfs中的符號(hào)鏈接是通過(guò)kernfs_node內(nèi)的聯(lián)合體實(shí)現(xiàn)的 */
	struct kref		kref;                     /* kobject的引用計(jì)數(shù)，當(dāng)計(jì)數(shù)為0時(shí)，回調(diào)之前注冊(cè)的release方法釋放該對(duì)象 */
#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
	struct delayed_work	release;
#endif
	unsigned int state_initialized:1;                /* 初始化標(biāo)志位，初始化時(shí)被置位 */
	unsigned int state_in_sysfs:1;                  /* kobject在sysfs中的狀態(tài)，在目錄中創(chuàng)建則為1，否則為0 */
	unsigned int state_add_uevent_sent:1;      /* 添加設(shè)備的uevent事件是否發(fā)送標(biāo)志，添加設(shè)備時(shí)向用戶空間發(fā)送uevent事件，請(qǐng)求新增設(shè)備 */
	unsigned int state_remove_uevent_sent:1;  /* 刪除設(shè)備的uevent事件是否發(fā)送標(biāo)志，刪除設(shè)備時(shí)向用戶空間發(fā)送uevent事件，請(qǐng)求卸載設(shè)備 */
	unsigned int uevent_suppress:1;              /* 是否忽略上報(bào)（不上報(bào)uevent） */
};

2.2 kset

• kset是包含多個(gè)kobject的集合；
• 如果需要在sysfs的目錄中包含多個(gè)子目錄，那需要將它定義成一個(gè)kset；
• kset結(jié)構(gòu)體中包含struct kobject字段，可以使用該字段鏈接到更上一層的結(jié)構(gòu)，用于構(gòu)建更復(fù)雜的拓?fù)浣Y(jié)構(gòu)；
• sysfs中的設(shè)備組織結(jié)構(gòu)很大程度上根據(jù)kset組織的，/sys/bus目錄就是一個(gè)kset對(duì)象，在Linux設(shè)備模型中，注冊(cè)設(shè)備或驅(qū)動(dòng)時(shí)就將kobject添加到對(duì)應(yīng)的kset中；

struct kset {
	struct list_head list;        /* 包含在kset內(nèi)的所有kobject構(gòu)成一個(gè)雙向鏈表 */
	spinlock_t list_lock;
	struct kobject kobj;       /* 歸屬于該kset的所有的kobject的共有parent */
	const struct kset_uevent_ops *uevent_ops;    /* kset的uevent操作函數(shù)集，當(dāng)kset中的kobject有狀態(tài)變化時(shí)，會(huì)回調(diào)這個(gè)函數(shù)集，以便kset添加新的環(huán)境變量或過(guò)濾某些uevent，如果一個(gè)kobject不屬于任何kset時(shí)，是不允許發(fā)送uevent的 */
} __randomize_layout;

2.3 ktype

• kobj_type用于表征kobject的類型，指定了刪除kobject時(shí)要調(diào)用的函數(shù)，kobject結(jié)構(gòu)體中有struct kref字段用于對(duì)kobject進(jìn)行引用計(jì)數(shù)，當(dāng)計(jì)數(shù)值為0時(shí)，就會(huì)調(diào)用kobj_type中的release函數(shù)對(duì)kobject進(jìn)行釋放，這個(gè)就有點(diǎn)類似于C++中的智能指針了；
• kobj_type指定了通過(guò)sysfs顯示或修改有關(guān)kobject的信息時(shí)要處理的操作，實(shí)際是調(diào)用show/store函數(shù)；

struct kobj_type {
	void (*release)(struct kobject *kobj);     /* 釋放kobject對(duì)象的接口，有點(diǎn)類似面向?qū)ο笾械奈鰳?gòu) */
	const struct sysfs_ops *sysfs_ops;        /* 操作kobject的方法集 */
	struct attribute **default_attrs;
	const struct kobj_ns_type_operations *(*child_ns_type)(struct kobject *kobj);
	const void *(*namespace)(struct kobject *kobj);
};

struct sysfs_ops {      /* kobject操作函數(shù)集 */
	ssize_t	(*show)(struct kobject *, struct attribute *, char *);
	ssize_t	(*store)(struct kobject *, struct attribute *, const char *, size_t);
};

/* 所謂的attribute就是內(nèi)核空間和用戶空間進(jìn)行信息交互的一種方法，例如某個(gè)driver定義了一個(gè)變量，卻希望用戶空間程序可以修改該變量，以控制driver的行為，那么可以將該變量以sysfs attribute的形式開(kāi)放出來(lái) */
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
};

可以看一下kobject創(chuàng)建的時(shí)候，與ktype的關(guān)系，這樣理解起來(lái)更順：

• kobject在創(chuàng)建的時(shí)候，默認(rèn)設(shè)置kobj_type的值為dynamic_kobj_ktype，通常kobject會(huì)嵌入在其他結(jié)構(gòu)中來(lái)使用，因此它的初始化跟特定的結(jié)構(gòu)相關(guān)，典型的比如struct device和struct device_driver；
• 在/sys文件系統(tǒng)中，通過(guò)echo/cat的操作，最終會(huì)調(diào)用到show/store函數(shù)，而這兩個(gè)函數(shù)的具體實(shí)現(xiàn)可以放置到驅(qū)動(dòng)程序中；

2.4 結(jié)構(gòu)關(guān)系

為了更形象的說(shuō)明這幾個(gè)結(jié)構(gòu)體的關(guān)系，再來(lái)一張圖：

• kset既是kobject的集合，本身又是一個(gè)kobject，進(jìn)而可以添加到其他的集合中，從而就可以構(gòu)建成復(fù)雜的拓?fù)浣Y(jié)構(gòu)，滿足/sys文件夾下的文件組織需求；

如果只看kset/kobject的數(shù)據(jù)結(jié)構(gòu)組織，可能還是會(huì)迷惑，它怎么跟Linux的設(shè)備模型相關(guān)？這時(shí)就不得不提到Linux內(nèi)核中一個(gè)很精妙的存在container_of，它可以通過(guò)成員變量的地址來(lái)獲取所在結(jié)構(gòu)的地址信息。前文提到過(guò)kobject/kset結(jié)構(gòu)本身不會(huì)單獨(dú)使用，通常都是會(huì)嵌套在其他結(jié)構(gòu)中，既然kobjcet/kset能組織成拓?fù)浣Y(jié)構(gòu)，那么包含它們的結(jié)構(gòu)同樣可以構(gòu)建這個(gè)關(guān)系，因?yàn)榭梢酝ㄟ^(guò)container_of就可以找到結(jié)構(gòu)體的首地址。

• 結(jié)構(gòu)體A、B、C、D、E同樣可以構(gòu)建拓?fù)浣Y(jié)構(gòu)關(guān)系；
• struct device和struct device_driver結(jié)構(gòu)體中都包含了struct kobject，而struct bus_type結(jié)構(gòu)體中包含了struct kset結(jié)構(gòu)，這個(gè)也就對(duì)應(yīng)到前文提到的設(shè)備和驅(qū)動(dòng)都添加到總線上，由總線來(lái)負(fù)責(zé)匹配；

3. 流程分析

kobject/kset的相關(guān)代碼比較簡(jiǎn)單，畢竟它只是作為一個(gè)結(jié)構(gòu)體嵌入其他high-level的結(jié)構(gòu)中，充當(dāng)紐帶的作用。不過(guò)，我還是簡(jiǎn)單的上一張圖吧：

• 完成的工作基本就是分配結(jié)構(gòu)體，初始化各個(gè)結(jié)構(gòu)體字段，構(gòu)建拓?fù)潢P(guān)系（主要是添加到kset的list中，parent的指向等）等，看懂了結(jié)構(gòu)體的組織，這部分的代碼理解起來(lái)就很輕松了；

4. 示例

先上一個(gè)原理圖：

4.1 代碼

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/kobject.h>

//自定義一個(gè)結(jié)構(gòu)，包含了struct kobject子結(jié)構(gòu)
struct test_kobj {
    int value;
    struct kobject kobj;
};

//自定義個(gè)屬性結(jié)構(gòu)體，包含了struct attribute結(jié)構(gòu)
struct test_kobj_attribute {
    struct attribute attr;
    ssize_t (*show)(struct test_kobj *obj, struct test_kobj_attribute *attr, char *buf);
    ssize_t (*store)(struct test_kobj *obj, struct test_kobj_attribute *attr, const char *buf, size_t count);
};

//聲明一個(gè)全局結(jié)構(gòu)用于測(cè)試
struct test_kobj *obj;

//用于初始化sysfs_ops中的函數(shù)指針
static ssize_t test_kobj_attr_show(struct kobject *kobj, struct attribute *attr, char *buf)
{
    struct test_kobj_attribute *test_kobj_attr;
    ssize_t ret = -EIO;

    test_kobj_attr = container_of(attr, struct test_kobj_attribute, attr);
    
    //回調(diào)到具體的實(shí)現(xiàn)函數(shù)
    if (test_kobj_attr->show)
        ret = test_kobj_attr->show(container_of(kobj, struct test_kobj, kobj), test_kobj_attr, buf);
    
    return ret;
}

//用于初始化sysfs_ops中的函數(shù)指針
static ssize_t test_kobj_attr_store(struct kobject *kobj, struct attribute *attr, const char *buf, size_t count)
{
    struct test_kobj_attribute *test_kobj_attr;
    ssize_t ret = -EIO;

    test_kobj_attr = container_of(attr, struct test_kobj_attribute, attr);
    
    //回調(diào)到具體的實(shí)現(xiàn)函數(shù)
    if (test_kobj_attr->store)
        ret = test_kobj_attr->store(container_of(kobj, struct test_kobj, kobj), test_kobj_attr, buf, count);
    
    return ret;
}

//用于初始化kobj_ktype
const struct sysfs_ops test_kobj_sysfs_ops = {
    .show = test_kobj_attr_show,
    .store = test_kobj_attr_store,
};

//用于初始化kobj_ktype，最終用于釋放kobject
void obj_release(struct kobject *kobj)
{
    struct test_kobj *obj = container_of(kobj, struct test_kobj, kobj);

    printk(KERN_INFO "test kobject release %s\n", kobject_name(&obj->kobj));
    
    kfree(obj);
}

//定義kobj_ktype，用于指定kobject的類型，初始化的時(shí)候使用
static struct kobj_type test_kobj_ktype = {
    .release = obj_release,
    .sysfs_ops = &test_kobj_sysfs_ops,
};

//show函數(shù)的具體實(shí)現(xiàn)
ssize_t name_show(struct test_kobj *obj, struct test_kobj_attribute *attr, char *buffer)
{
    return sprintf(buffer, "%s\n", kobject_name(&obj->kobj));
}

//show函數(shù)的具體實(shí)現(xiàn)
ssize_t value_show(struct test_kobj *obj, struct test_kobj_attribute *attr, char *buffer)
{
    return sprintf(buffer, "%d\n", obj->value);
}

//store函數(shù)的具體實(shí)現(xiàn)
ssize_t value_store(struct test_kobj *obj, struct test_kobj_attribute *attr, const char *buffer, size_t size)
{
    sscanf(buffer, "%d", &obj->value);

    return size;
}

//定義屬性，最終注冊(cè)進(jìn)sysfs系統(tǒng)
struct test_kobj_attribute name_attribute = __ATTR(name, 0664, name_show, NULL);
struct test_kobj_attribute value_attribute = __ATTR(value, 0664, value_show, value_store);
struct attribute *test_kobj_attrs[] = {
    &name_attribute.attr,
    &value_attribute.attr,
    NULL,
};

//定義組
struct attribute_group test_kobj_group = {
    .name = "test_kobj_group",
    .attrs = test_kobj_attrs,
};

//模塊初始化函數(shù)
static int __init test_kobj_init(void)
{
    int retval;
    printk(KERN_INFO "test_kobj_init\n");
    obj = kmalloc(sizeof(struct test_kobj), GFP_KERNEL);
    if (!obj) {
        return -ENOMEM;
    }
    
    obj->value = 1;
    memset(&obj->kobj, 0, sizeof(struct kobject));
    //添加進(jìn)sysfs系統(tǒng)
    kobject_init_and_add(&obj->kobj, &test_kobj_ktype, NULL, "test_kobj");

    //在sys文件夾下創(chuàng)建文件
    retval = sysfs_create_files(&obj->kobj, (const struct attribute **)test_kobj_attrs);
    if (retval) {
        kobject_put(&obj->kobj);
        return retval;
    }
    
    //在sys文件夾下創(chuàng)建group
    retval = sysfs_create_group(&obj->kobj, &test_kobj_group);
    if (retval) {
        kobject_put(&obj->kobj);
        return retval;
    }
    
    return 0;
}

//模塊清理函數(shù)
static void __exit test_kobj_exit(void)
{
    printk(KERN_INFO "test_kobj_exit\n");

    kobject_del(&obj->kobj);
    kobject_put(&obj->kobj);
    
    return;
}

module_init(test_kobj_init);
module_exit(test_kobj_exit);

MODULE_AUTHOR("LoyenWang");
MODULE_LICENSE("GPL");

4.2 Makefile

ifneq  ($(KERNELRELEASE),)
obj-m:=test_kobject.o
else
KERDIR := /lib/modules/$(shell uname -r)/build
PWD:=$(shell pwd)
all:
	make -C $(KERDIR) M=$(PWD) modules
clean:
	rm -f *.ko *.o *.symvers *.cmd *.cmd.o modules.* *.mod.c
endif

• Makefile沒(méi)有太多好說(shuō)的，注意Tab的使用，否則容易出錯(cuò)；

4.3 測(cè)試結(jié)果

• 在/sys目錄下創(chuàng)建了test_kobj文件夾，在該文件夾下除了name和value外，還有一個(gè)test_kobj_group的子文件夾；
• 可以通過(guò)cat/echo的操作，來(lái)操作name和value，分別會(huì)調(diào)用到底層的xxx_show和xxx_store函數(shù)；
• 對(duì)著代碼看這個(gè)圖，一目了然；

草草收?qǐng)?，洗洗睡了?/p>

參考

https:///Articles/263200/