背 景

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

說明：

Kernel版本：4.14

ARM64處理器，Contex-A53，雙核

使用工具：Source Insight 3.5， Visio

1. 概述

今天來聊一下Linux設備模型的基石：kset/kobject/ktype。

• sysfs文件系統提供了一種用戶與內核數據結構進行交互的方式，可以通過mount -t sysfs sysfs /sys來進行掛載；
• Linux設備模型中，設備、驅動、總線組織成拓撲結構，通過sysfs文件系統以目錄結構進行展示與管理；
• Linux設備模型中，總線負責設備和驅動的匹配，設備與驅動都掛在某一個總線上，當它們進行注冊時由總線負責去完成匹配，進而回調驅動的probe函數；
• SoC系統中有spi, i2c, pci等實體總線用于外設的連接，而針對集成在SoC中的外設控制器，Linux內核提供一種虛擬總線platform用于這些外設控制器的連接，此外platform總線也可用于沒有實體總線的外設；
• 在/sys目錄下，bus用于存放各類總線，其中總線中會存放掛載在該總線上的驅動和設備，比如serial8250，devices存放了系統中的設備信息，class是針對不同的設備進行分類；

上邊這些功能的實現，離不開kobject/kset/ktype機制的支撐，開始旅程吧。

2. 數據結構

2.1 kobject

• kobject代表內核對象，結構體本身不單獨使用，而是嵌套在其他高層結構中，用于組織成拓撲關系；
• sysfs文件系統中一個目錄對應一個kobject；

看看結構體吧：

struct kobject { const char *name; /* 名字，對應sysfs下的一個目錄 */ struct list_head entry; /* kobject中插入的 list_head結構，用于構造雙向鏈表 */ struct kobject *parent; /* 指向當前kobject父對象的指針，體現在sys中就是包含當前kobject對象的目錄對象 */ struct kset *kset; /* 當前kobject對象所屬的集合 */ struct kobj_type *ktype; /* 當前kobject對象的類型 */ struct kernfs_node *sd; /* VFS文件系統的目錄項，是設備和文件之間的橋梁，sysfs中的符號鏈接是通過kernfs_node內的聯合體實現的 */ struct kref kref; /* kobject的引用計數，當計數為0時，回調之前注冊的release方法釋放該對象 */#ifdef CONFIG_DEBUG_KOBJECT_RELEASE struct delayed_work release;#endif unsigned int state_initialized:1; /* 初始化標志位，初始化時被置位 */ unsigned int state_in_sysfs:1; /* kobject在sysfs中的狀態，在目錄中創建則為1，否則為0 */ unsigned int state_add_uevent_sent:1; /* 添加設備的uevent事件是否發送標志，添加設備時向用戶空間發送uevent事件，請求新增設備 */ unsigned int state_remove_uevent_sent:1; /* 刪除設備的uevent事件是否發送標志，刪除設備時向用戶空間發送uevent事件，請求卸載設備 */ unsigned int uevent_suppress:1; /* 是否忽略上報(不上報uevent) */};

2.2 kset

• kset是包含多個kobject的集合；
• 如果需要在sysfs的目錄中包含多個子目錄，那需要將它定義成一個kset；
• kset結構體中包含struct kobject字段，可以使用該字段鏈接到更上一層的結構，用于構建更復雜的拓撲結構；
• sysfs中的設備組織結構很大程度上根據kset組織的，/sys/bus目錄就是一個kset對象，在Linux設備模型中，注冊設備或驅動時就將kobject添加到對應的kset中；

struct kset { struct list_head list; /* 包含在kset內的所有kobject構成一個雙向鏈表 */ spinlock_t list_lock; struct kobject kobj; /* 歸屬于該kset的所有的kobject的共有parent */ const struct kset_uevent_ops *uevent_ops; /* kset的uevent操作函數集，當kset中的kobject有狀態變化時，會回調這個函數集，以便kset添加新的環境變量或過濾某些uevent，如果一個kobject不屬于任何kset時，是不允許發送uevent的 */} __randomize_layout;

2.3 ktype

• kobj_type用于表征kobject的類型，指定了刪除kobject時要調用的函數，kobject結構體中有struct kref字段用于對kobject進行引用計數，當計數值為0時，就會調用kobj_type中的release函數對kobject進行釋放，這個就有點類似于C++中的智能指針了；
• kobj_type指定了通過sysfs顯示或修改有關kobject的信息時要處理的操作，實際是調用show/store函數；

struct kobj_type { void (*release)(struct kobject *kobj); /* 釋放kobject對象的接口，有點類似面向對象中的析構 */ 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操作函數集 */ ssize_t (*show)(struct kobject *, struct attribute *, char *); ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);};/* 所謂的attribute就是內核空間和用戶空間進行信息交互的一種方法，例如某個driver定義了一個變量，卻希望用戶空間程序可以修改該變量，以控制driver的行為，那么可以將該變量以sysfs attribute的形式開放出來 */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創建的時候，與ktype的關系，這樣理解起來更順：

• kobject在創建的時候，默認設置kobj_type的值為dynamic_kobj_ktype，通常kobject會嵌入在其他結構中來使用，因此它的初始化跟特定的結構相關，典型的比如struct device和struct device_driver；
• 在/sys文件系統中，通過echo/cat的操作，最終會調用到show/store函數，而這兩個函數的具體實現可以放置到驅動程序中；

2.4 結構關系

為了更形象的說明這幾個結構體的關系，再來一張圖：

• kset既是kobject的集合，本身又是一個kobject，進而可以添加到其他的集合中，從而就可以構建成復雜的拓撲結構，滿足/sys文件夾下的文件組織需求；

如果只看kset/kobject的數據結構組織，可能還是會迷惑，它怎么跟Linux的設備模型相關？這時就不得不提到Linux內核中一個很精妙的存在container_of，它可以通過成員變量的地址來獲取所在結構的地址信息。前文提到過kobject/kset結構本身不會單獨使用，通常都是會嵌套在其他結構中，既然kobjcet/kset能組織成拓撲結構，那么包含它們的結構同樣可以構建這個關系，因為可以通過container_of就可以找到結構體的首地址。

• 結構體A、B、C、D、E同樣可以構建拓撲結構關系；
• struct device和struct device_driver結構體中都包含了struct kobject，而struct bus_type結構體中包含了struct kset結構，這個也就對應到前文提到的設備和驅動都添加到總線上，由總線來負責匹配；

3. 流程分析

kobject/kset的相關代碼比較簡單，畢竟它只是作為一個結構體嵌入其他high-level的結構中，充當紐帶的作用。不過，我還是簡單的上一張圖吧：

• 完成的工作基本就是分配結構體，初始化各個結構體字段，構建拓撲關系(主要是添加到kset的list中，parent的指向等)等，看懂了結構體的組織，這部分的代碼理解起來就很輕松了；

4. 示例

先上一個原理圖：

4.1 代碼

#include #include #include #include //自定義一個結構，包含了struct kobject子結構struct test_kobj { int value; struct kobject kobj;};//自定義個屬性結構體，包含了struct attribute結構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);};//聲明一個全局結構用于測試struct test_kobj *obj;//用于初始化sysfs_ops中的函數指針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); //回調到具體的實現函數 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中的函數指針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); //回調到具體的實現函數 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_ktypeconst struct sysfs_ops test_kobj_sysfs_ops = { .show = test_kobj_attr_show, .store = test_kobj_attr_store,};//用于初始化kobj_ktype，最終用于釋放kobjectvoid 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的類型，初始化的時候使用static struct kobj_type test_kobj_ktype = { .release = obj_release, .sysfs_ops = &test_kobj_sysfs_ops,};//show函數的具體實現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函數的具體實現ssize_t value_show(struct test_kobj *obj, struct test_kobj_attribute *attr, char *buffer){ return sprintf(buffer, "%d\n", obj->value);}//store函數的具體實現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;}//定義屬性，最終注冊進sysfs系統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,};//模塊初始化函數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)); //添加進sysfs系統 kobject_init_and_add(&obj->kobj, &test_kobj_ktype, NULL, "test_kobj"); //在sys文件夾下創建文件 retval = sysfs_create_files(&obj->kobj, (const struct attribute **)test_kobj_attrs); if (retval) { kobject_put(&obj->kobj); return retval; } //在sys文件夾下創建group retval = sysfs_create_group(&obj->kobj, &test_kobj_group); if (retval) { kobject_put(&obj->kobj); return retval; } return 0;}//模塊清理函數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.oelseKERDIR := /lib/modules/$(shell uname -r)/buildPWD:=$(shell pwd)all: make -C $(KERDIR) M=$(PWD) modulesclean: rm -f *.ko *.o *.symvers *.cmd *.cmd.o modules.* *.mod.cendif

• Makefile沒有太多好說的，注意Tab的使用，否則容易出錯；

4.3 測試結果

• 在/sys目錄下創建了test_kobj文件夾，在該文件夾下除了name和value外，還有一個test_kobj_group的子文件夾；
• 可以通過cat/echo的操作，來操作name和value，分別會調用到底層的xxx_show和xxx_store函數；
• 對著代碼看這個圖，一目了然；

草草收場，洗洗睡了。

如果覺得對你有幫助，那就點個在看吧。

參考

https://lwn.net/Articles/263200/

總結

以上是生活随笔為你收集整理的获取另一个驱动的设备结构体_Linux 驱动开发 / 设备模型快速入门的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。